Merge pull request #85 from exodus4d/develop

v1.0.0RC1

.gitignore

@@ -49,3 +49,4 @@ Temporary Items
 .idea
 .sass-cache
 .usage
+*.gz

.htaccess

@@ -1,7 +1,10 @@
-# Enable rewrite engine and route requests to framework
+# HTTPS over SSL version
+# Information: https://github.com/exodus4d/pathfinder/wiki/Apache
+
+# Enable rewrite engine and route requests to framework ===========================================
 RewriteEngine On
 
-# HTTP to HTTPS ----------------------------------------------------------------
+# HTTP to HTTPS ===================================================================================
 RewriteCond %{HTTPS} off
 RewriteCond %{HTTP_HOST} !^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$
 RewriteCond %{HTTP_HOST} !=localhost
@@ -11,41 +14,45 @@ RewriteCond %{HTTP_HOST} !=localhost
 # the subsequent rule will catch it.
 RewriteRule .* https://%{HTTP_HOST}%{REQUEST_URI} [L,R=301]
 
-# Now, rewrite any request to the wrong domain to use www.
+# Rewrite NONE www. to force www. =================================================================
 RewriteCond %{HTTP_HOST} !^www\.
+# skip "localhost" (dev environment)...
 RewriteCond %{HTTP_HOST} !=localhost
+# skip IP calls (dev environment)
 RewriteCond %{HTTP_HOST} !^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$
+# rewrite everything else to "https://" and "www."
 RewriteRule .* https://www.%{HTTP_HOST}%{REQUEST_URI} [L,R=301]
 
-
 # Some servers require you to specify the `RewriteBase` directive
 # In such cases, it should be the path (relative to the document root)
-# containing this .htaccess file
-#
-#RewriteBase /app/
+# containing this .htaccess file:
+# RewriteBase /app/
 
+# Protect system files ============================================================================
 RewriteCond %{ENV:REDIRECT_STATUS} ^$
 RewriteRule ^(lib|tmp)\/|\.(ini|php)$ - [R=404]
 
+# Rewrite "everything" to index.php (dispatcher) ==================================================
 RewriteCond %{REQUEST_FILENAME} !-l
 RewriteCond %{REQUEST_FILENAME} !-f
 RewriteCond %{REQUEST_FILENAME} !-d
 RewriteRule .* index.php [L,QSA]
 RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization},L]
 
 
-# PHP global Vars
+# PHP global Vars (can be set in php.ini as well,...) =============================================
 php_value max_input_vars 5000
 php_value suhosin.get.max_vars 5000
 php_value suhosin.post.max_vars 5000
 php_value suhosin.request.max_vars 5000
 
-
-# PHP error logs
+# Activate PHP error log ==========================================================================
 php_flag log_errors on
-# php_value error_log "/www/htdocs/w0128162/www.pathfinder.exodus4d.de/logs/php_errors.log"
+# php_value error_log "/www/htdocs/www.pathfinder-w.space/logs/php_errors.log"
 
-# caching
+# Cache Header ====================================================================================
+# You should not change anything in here!
+# New versioned files come with a unique path (e.g. ../js/v1.0.0/..) to force client cache busting.
 <ifmodule mod_expires.c>
     # fonts
     <Filesmatch "\.(eot|woff2|woff|ttf|ttf|svg)$">
@@ -83,6 +90,4 @@ php_flag log_errors on
         ExpiresActive on
         ExpiresDefault "access plus 1 week"
     </Filesmatch>
-</ifmodule>
-
-
+</ifmodule>

.htaccess_HTTP

@@ -0,0 +1,82 @@
+# HTTP version
+# Information: https://github.com/exodus4d/pathfinder/wiki/Apache
+
+# Enable rewrite engine and route requests to framework ===========================================
+RewriteEngine On
+
+# Rewrite NONE www. to force www. =================================================================
+RewriteCond %{HTTP_HOST} !^www\.
+# skip "localhost" (dev environment)...
+RewriteCond %{HTTP_HOST} !=localhost
+# skip IP calls (dev environment) e.g. 127.0.0.1
+RewriteCond %{HTTP_HOST} !^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$
+# rewrite everything else to "http://" and "www."
+RewriteRule .* http://www.%{HTTP_HOST}%{REQUEST_URI} [L,R=301]
+
+# Some servers require you to specify the `RewriteBase` directive
+# In such cases, it should be the path (relative to the document root)
+# containing this .htaccess file:
+# RewriteBase /app/
+
+# Protect system files ============================================================================
+RewriteCond %{ENV:REDIRECT_STATUS} ^$
+RewriteRule ^(lib|tmp)\/|\.(ini|php)$ - [R=404]
+
+# Rewrite "everything" to index.php (dispatcher) ==================================================
+RewriteCond %{REQUEST_FILENAME} !-l
+RewriteCond %{REQUEST_FILENAME} !-f
+RewriteCond %{REQUEST_FILENAME} !-d
+RewriteRule .* index.php [L,QSA]
+RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization},L]
+
+# PHP global Vars (can be set in php.ini as well,...) =============================================
+php_value max_input_vars 5000
+php_value suhosin.get.max_vars 5000
+php_value suhosin.post.max_vars 5000
+php_value suhosin.request.max_vars 5000
+
+# Activate PHP error log ==========================================================================
+php_flag log_errors on
+php_value error_log "/www/htdocs/w0128162/www.pathfinder-dev.exodus4d.de/logs/php_errors.log"
+
+# Cache Header ====================================================================================
+# You should not change anything in here!
+# New versioned files come with a unique path (e.g. ../js/v1.0.0/..) to force client cache busting.
+<ifmodule mod_expires.c>
+    # fonts
+    <Filesmatch "\.(eot|woff2|woff|ttf|ttf|svg)$">
+        ExpiresActive on
+        ExpiresDefault "access plus 1 month"
+        Header append Cache-Control "public"
+    </Filesmatch>
+
+    # images/vector graphics
+    <Filesmatch "\.(jpg|jpeg|png|gif|swf|ico|svg)$">
+        ExpiresActive on
+        ExpiresDefault "access plus 1 year"
+        Header append Cache-Control "public"
+        FileETag None
+        Header unset ETag
+    </Filesmatch>
+
+    # css
+    <Filesmatch "\.(css)$">
+        ExpiresActive on
+        ExpiresDefault "access plus 1 month"
+    </Filesmatch>
+
+    ## js/source maps
+    <Filesmatch "\.(js|map)$">
+        ExpiresActive on
+        ExpiresDefault "access plus 1 year"
+        Header append Cache-Control "public"
+        FileETag None
+        Header unset ETag
+    </Filesmatch>
+
+    # html templates
+    <Filesmatch "\.(htm|html)$">
+        ExpiresActive on
+        ExpiresDefault "access plus 1 week"
+    </Filesmatch>
+</ifmodule>

README.md

@@ -1,29 +1,38 @@
 ## *PATHFINDER*
 Mapping tool for [*EVE ONLINE*](https://www.eveonline.com)
 
-- Project [https://www.pathfinder.exodus4d.de](https://www.pathfinder.exodus4d.de)
+- Project [https://www.pathfinder-w.space](https://www.pathfinder-w.space)
 - Official Forum post [https://forums.eveonline.com](https://forums.eveonline.com/default.aspx?g=posts&m=6021776#post6021776)
 - Screenshots [imgur.com](http://imgur.com/a/k2aVa)
 - Video [youtube.com](https://www.youtube.com/channel/UC7HU7XEoMbqRwqxDTbMjSPg)
 - Community [google +](https://plus.google.com/u/0/b/110257318165279088853/110257318165279088853)
 - Licence [MIT](http://opensource.org/licenses/MIT)
 
-##### IMPORTANT Information
-**This project is still in beta phase and is not officially released! Feel free to check the code for bugs and security issues. Issues should be reported in the [Issue](https://github.com/exodus4d/pathfinder/issues) section.**
+##### IMPORTANT Information:
+**The setup and installation process in ``1.0.0RC1`` and is not backwards compatible with previous beta releases (check wiki)!**
 
-If you are looking for installation help, please check the [wiki](https://github.com/exodus4d/pathfinder/wiki) (DRAFT). More information will be added once the beta is over and the first stable build is released.
+**Feel free to check the code for bugs and security issues.
+Issues should be reported in the [Issue](https://github.com/exodus4d/pathfinder/issues) section.**
+
+If you are looking for installation help, please check the [wiki](https://github.com/exodus4d/pathfinder/wiki).
+More information will be added once the beta is over and the first stable build is released.
 
 ## Project structure
 
 ```
-  |-- (0755) app              --> backend [*.php]
+  |-- (0755) app            --> backend [*.php]
       |-- app               --> "Fat Free Framework" extensions
       |-- lib               --> "Fat Free Framework"
       |-- main              --> "PATHFINDER" root
       |-- config.ini        --> config "f3" framework
-      |-- cron.ini          --> config cronjobs
-      |-- pathfinder.ini    --> config pathfinder
-      |-- routes.ini        --> config routes
+      |-- cron.ini          --> config - cronjobs
+      |-- environment.ini   --> config - system environment
+      |-- pathfinder.ini    --> config - pathfinder
+      |-- requirements.ini  --> config - system requirements
+      |-- routes.ini        --> config - routes
+  |-- (0755) export         --> DB export data
+      |-- sql               --> static DB data for import (pathfinder.sql)
+  |-- (0755) favicon        --> Favicons
   |-- (0755) js             --> JS source files (raw)
       |-- app               --> "PASTHFINDER" core files (not used for production )
       |-- lib               --> 3rd partie extension/library (not used for production )
@@ -42,7 +51,7 @@ If you are looking for installation help, please check the [wiki](https://github
       |-- ...
   |-- (0777) tmp            --> cache folder
       |-- ...
-  |-- (0755) .htaccess      --> reroute/caching rules
+  |-- (0755) .htaccess      --> reroute/caching rules ("Apache" only!)
   |-- (0755) index.php
 
   --------------------------

app/config.ini

@@ -1,36 +1,47 @@
+; Global Framework Config
+
 [globals]
 ; Default Verbosity level of the stack trace.
-; Assign values between 0 to 3 for increasing verbosity levels. Check "PATHFINDER" config for overwriting
-DEBUG = 0
+; Assign values between 0 to 3 for increasing verbosity levels. Check (environment.ini) config for overwriting
+DEBUG                       =   0
 
-; If TRUE, the framework, after having logged stack trace and errors, stops execution (die without any status) when a non-fatal error is detected.
-HALT = FALSE
+; If TRUE, the framework, after having logged stack trace and errors, stops execution
+; -> (die without any status) when a non-fatal error is detected.
+HALT                        =   FALSE
 
 ; Timezone to use. Sync program with eve server time
-TZ = "UTC"
+TZ                          =   UTC
 
 ; Cache backend. Can handle Memcache module, APC, WinCache, XCache and a filesystem-based cache.
-CACHE = TRUE
+CACHE                       =   TRUE
 
-; Callback functions ===================================================================================
-ONERROR = "Controller\Controller->showError"
+; Callback functions ==============================================================================
+ONERROR                     =   Controller\Controller->showError
 
-UNLOAD = "Controller\Controller->unload"
+UNLOAD                      =   Controller\Controller->unload
 
-; Path configurations ==================================================================================
+; Path configurations =============================================================================
 ; relative to "BASE" dir
 
 ; Temporary folder for cache, filesystem locks, compiled F3 templates, etc.
-TEMP = tmp/
+TEMP                        =   tmp/
 
 ; Log file folder
-LOGS = logs/
+LOGS                        =   logs/
 
 ; Search path for user interface files used by the View and Template classes' render() method.
-UI = public/
+UI                          =   public/
 
 ; Search path(s) for user-defined PHP classes that the framework will attempt to autoload at runtime
-AUTOLOAD = app/main/
-
-
-
+AUTOLOAD                    =   app/main/
+
+; path to favicons folder
+FAVICON                     =   /favicon
+
+; load additional config files
+[configs]
+app/routes.ini              =   true
+app/environment.ini         =   true
+app/pathfinder.ini          =   true
+app/requirements.ini        =   true
+app/cron.ini                =   true

app/cron.ini

@@ -21,4 +21,4 @@ deactivateMapData = Cron\MapUpdate->deactivateMapData, @hourly
 deleteMapData = Cron\MapUpdate->deleteMapData, @downtime
 
 ; delete character log data
-deleteLogData = Cron\CharacterUpdate->deleteLogData, @instant
+deleteLogData = Cron\CharacterUpdate->deleteLogData, @hourly

app/environment.ini

@@ -0,0 +1,64 @@
+; Environment Config
+
+[ENVIRONMENT]
+; project environment (DEVELOP, PRODUCTION).
+; This effects: DB connection, Mail-Server connection
+; configuration below
+SERVER                      =   DEVELOP
+
+[ENVIRONMENT.DEVELOP]
+; base dir (Default: "auto-detect"
+BASE                        =
+; deployment URL e.g. http://localhost
+URL                         =   http://pathfinder.local
+; Verbosity level of the stack trace
+DEBUG                       =   3
+; main db
+DB_DNS                      =   mysql:host=localhost;port=3306;dbname=
+DB_NAME                     =   pathfinder
+DB_USER                     =   root
+DB_PASS                     =
+
+; EVE-Online CCP Database export
+DB_CCP_DNS                  =   mysql:host=localhost;port=3306;dbname=
+DB_CCP_NAME                 =   eve_parallax_min
+DB_CCP_USER                 =   root
+DB_CCP_PASS                 =
+
+; SMTP settings
+SMTP_HOST                   =   localhost
+SMTP_PORT                   =   25
+SMTP_SCHEME                 =   ""
+SMTP_USER                   =   pathfinder
+SMTP_PASS                   =   root
+
+SMTP_FROM                   =   [email protected]
+SMTP_ERROR                  =   [email protected]
+
+[ENVIRONMENT.PRODUCTION]
+BASE                        =   /www/htdocs/www.pathfinder-w.space
+; deployment URL
+URL                         =   https://www.pathfinder-w.space
+; Verbosity level of the stack trace
+DEBUG                       =   0
+; main db
+DB_DNS                      =   mysql:host=localhost;port=3306;dbname=
+DB_NAME                     =
+DB_USER                     =
+DB_PASS                     =
+
+; EVE-Online CCP Database export
+DB_CCP_DNS                  =   mysql:host=localhost;port=3306;dbname=
+DB_CCP_NAME                 =
+DB_CCP_USER                 =
+DB_CCP_PASS                 =
+
+; SMTP settings
+SMTP_HOST                   =   localhost
+SMTP_PORT                   =   25
+SMTP_SCHEME                 =   TLS
+SMTP_USER                   =
+SMTP_PASS                   =
+
+SMTP_FROM                   =   [email protected]
+SMTP_ERROR                  =   [email protected]