Renamed more from 'web' to 'html'.
[shipsimu.git] / index.php
index cf898bf..2870332 100644 (file)
--- a/index.php
+++ b/index.php
@@ -1,7 +1,4 @@
 <?php
-// Developer mode active? Comment out if no dev!
-define('DEVELOPER', true);
-//xdebug_start_trace();
 /**
  * The main class with the entry point to the whole application. This class
  * "emulates" Java's entry point call. Additionally it covers local
@@ -10,11 +7,11 @@ define('DEVELOPER', true);
  *
  * But good little boys and girls would always initialize their variables... ;-)
  *
- * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @author             Roland Haeder <webmaster@shipsimu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, this is free software
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
- * @link               http://www.ship-simu.org
+ * @link               http://www.shipsimu.org
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -36,70 +33,58 @@ final class ApplicationEntryPoint {
        private static $corePath = '';
 
        /**
-        * The instances we want to remove after all is done
-        *
-        * @return      void
-        */
-       private static $instances = array (
-               'cfg',    // The configuration system
-               'loader', // The class loader system
-               'debug',  // Debug output
-               'db',     // Database layer
-               'io',     // Base I/O system (local file [or network])
-               'engine', // Template engine ( for ApplicationEntryPoint::app_die() )
-               'lang',   // Language sub-system
-               'app',    // The ApplicationHelper instance
-       );
-
-       /**
         * The application's emergency exit
         *
         * @param       $message                The optional message we shall output on exit
         * @param       $code                   Error code from exception
         * @param       $extraData              Extra information from exceptions
-        * @param       $silentMode             Wether not silent mode is turned on
+        * @param       $silentMode             Whether silent mode is turned on
         * @return      void
+        * @todo        This method is old code and needs heavy rewrite and should be moved to ApplicationHelper
         */
-       public static function app_die ($message = '', $code = false, $extraData = '', $silentMode = false) {
+       public static final function app_exit ($message = '', $code = FALSE, $extraData = '', $silentMode = FALSE) {
                // Is this method already called?
-               if (defined('EMERGENCY_EXIT_CALLED')) {
+               if (isset($GLOBALS['app_die_called'])) {
                        // Then output the text directly
-                       die($message);
+                       exit($message);
                } // END - if
 
                // This method shall not be called twice
-               define('EMERGENCY_EXIT_CALLED', true);
+               $GLOBALS['app_die_called'] = TRUE;
 
                // Is a message set?
                if (empty($message)) {
                        // No message provided
-                       $message = 'No message provided!';
+                       $message = 'No message provided.';
                } // END - if
 
                // Get config instance
-               $configInstance = FrameworkConfiguration::getInstance();
+               $configInstance = FrameworkConfiguration::getSelfInstance();
 
                // Do we have debug installation?
-               if (($configInstance->getConfigEntry('product_install_mode') == 'productive') || ($silentMode === true)) {
+               if (($configInstance->getConfigEntry('product_install_mode') == 'productive') || ($silentMode === TRUE)) {
                        // Abort here
-                       die();
+                       exit();
                } // END - if
 
                // Get some instances
-               $tpl = FrameworkConfiguration::getInstance()->getConfigEntry('template_class');
-               $lang = LanguageSystem::getInstance();
+               $tpl = FrameworkConfiguration::getSelfInstance()->getConfigEntry('web_template_class');
+               $languageInstance = LanguageSystem::getSelfInstance();
+
+               // Initialize template instance here to avoid warnings in IDE
+               $templateInstance = NULL;
 
                // Get response instance
-               $responseInstance = ApplicationHelper::getInstance()->getResponseInstance();
+               $responseInstance = ApplicationHelper::getSelfInstance()->getResponseInstance();
 
                // Is the template engine loaded?
-               if ((class_exists($tpl)) && (is_object($lang))) {
+               if ((class_exists($tpl)) && (is_object($languageInstance))) {
                        // Use the template engine for putting out (nicer look) the message
                        try {
                                // Get the template instance from our object factory
-                               $templateInstance = ObjectFactory::createObjectByName($tpl, array(ApplicationHelper::getInstance()));
+                               $templateInstance = ObjectFactory::createObjectByName($tpl);
                        } catch (FrameworkException $e) {
-                               die(sprintf("[Main:] Could not initialize template engine for reason: <span class=\"exception_reason\">%s</span>",
+                               exit(sprintf("[Main:] Could not initialize template engine for reason: <span class=\"exception_reason\">%s</span>",
                                        $e->getMessage()
                                ));
                        }
@@ -108,53 +93,73 @@ final class ApplicationEntryPoint {
                        $backtraceArray = debug_backtrace();
                        $backtrace = '';
                        foreach ($backtraceArray as $key => $trace) {
-                               if (!isset($trace['file'])) $trace['file'] = __FILE__;
-                               if (!isset($trace['line'])) $trace['line'] = __LINE__;
-                               if (!isset($trace['args'])) $trace['args'] = array();
-                               $backtrace .= "<span class=\"backtrace_file\">".basename($trace['file'])."</span>:".$trace['line'].", <span class=\"backtrace_function\">".$trace['function']."(".count($trace['args']).")</span><br />";
+                               // Set missing array elements
+                               if (!isset($trace['file'])) {
+                                       $trace['file'] = __FILE__;
+                               } // END - if
+                               if (!isset($trace['line'])) {
+                                       $trace['line'] = __LINE__;
+                               } // END - if
+                               if (!isset($trace['args'])) {
+                                       $trace['args'] = array();
+                               } // END - if
+
+                               // Add the traceback path to the final output
+                               $backtrace .= sprintf("<span class=\"backtrace_file\">%s</span>:%d, <span class=\"backtrace_function\">%s(%d)</span><br />\n",
+                                       basename($trace['file']),
+                                       $trace['line'],
+                                       $trace['function'],
+                                       count($trace['args'])
+                               );
                        } // END - foreach
 
                        // Init application instance
-                       $appInstance = null;
+                       $applicationInstance = NULL;
 
                        // Is the class there?
                        if (class_exists('ApplicationHelper')) {
                                // Get application instance
-                               $appInstance = ApplicationHelper::getInstance();
+                               $applicationInstance = ApplicationHelper::getSelfInstance();
 
                                // Assign application data
-                               $templateInstance->assignApplicationData($appInstance);
+                               $templateInstance->assignApplicationData($applicationInstance);
                        } // END - if
 
-                       // Assign variables
-                       $templateInstance->assignVariable('message', $message);
-                       $templateInstance->assignVariable('code', $code);
-                       $templateInstance->assignVariable('extra', $extraData);
-                       $templateInstance->assignVariable('backtrace', $backtrace);
-                       $templateInstance->assignVariable('total_includes', ClassLoader::getInstance()->getTotal());
-                       $templateInstance->assignVariable('total_objects', ObjectFactory::getTotal());
-                       $templateInstance->assignVariable('title', $lang->getMessage('emergency_exit_title'));
-
-                       // Load the template
-                       $templateInstance->loadCodeTemplate('emergency_exit');
-
-                       // Compile the template
-                       $templateInstance->compileTemplate();
-
-                       // Compile all variables
-                       $templateInstance->compileVariables();
-
-                       // Transfer data to response
-                       $templateInstance->transferToResponse($responseInstance);
-
-                       // Flush the response
-                       $responseInstance->flushBuffer();
+                       // We only try this
+                       try {
+                               // Assign variables
+                               $templateInstance->assignVariable('message', $message);
+                               $templateInstance->assignVariable('code', $code);
+                               $templateInstance->assignVariable('extra', $extraData);
+                               $templateInstance->assignVariable('backtrace', $backtrace);
+                               $templateInstance->assignVariable('total_includes', ClassLoader::getSelfInstance()->getTotal());
+                               $templateInstance->assignVariable('total_objects', ObjectFactory::getTotal());
+                               $templateInstance->assignVariable('title', $languageInstance->getMessage('emergency_exit_title'));
+
+                               // Load the template
+                               $templateInstance->loadCodeTemplate('emergency_exit');
+
+                               // Compile the template
+                               $templateInstance->compileTemplate();
+
+                               // Compile all variables
+                               $templateInstance->compileVariables();
+
+                               // Transfer data to response
+                               $templateInstance->transferToResponse($responseInstance);
+
+                               // Flush the response
+                               $responseInstance->flushBuffer();
+                       } catch (FileIoException $e) {
+                               // Even the template 'emergency_exit' wasn't found so output both message
+                               exit($message . ', exception: ' . $e->getMessage());
+                       }
 
                        // Good bye...
                        exit();
                } else {
                        // Output message and die
-                       die(sprintf("[Main:] Emergency exit reached: <span class=\"emergency_span\">%s</span>",
+                       exit(sprintf('[Main:] Emergency exit reached: <span class="emergency_span">%s</span>',
                                $message
                        ));
                }
@@ -164,9 +169,9 @@ final class ApplicationEntryPoint {
         * Determines the correct absolute path for all includes only once per run.
         * Other calls of this method are being "cached".
         *
-        * @return      $basePath       Base path (core) for all includes
+        * @return      $corePath       Base path (core) for all includes
         */
-       protected static function detectCorePath () {
+       protected static final function detectCorePath () {
                // Is it not set?
                if (empty(self::$corePath)) {
                        // Auto-detect our core path
@@ -185,7 +190,7 @@ final class ApplicationEntryPoint {
         *
         * @return      void
         */
-       public static function main () {
+       public static final function main () {
                // Load config file
                require(self::detectCorePath() . '/inc/config.php');
 
@@ -198,9 +203,16 @@ final class ApplicationEntryPoint {
                // Include the application selector
                require($cfg->getConfigEntry('base_path') . 'inc/selector.php');
        } // END - main()
-
 } // END - class
 
+// Developer mode active? Comment out if no dev!
+define('DEVELOPER', TRUE);
+
+// Log all exceptions (only debug! This option can create large error logs)
+//define('LOG_EXCEPTIONS', TRUE);
+
+//xdebug_start_trace();
+
 // Do not remove the following line:
 ApplicationEntryPoint::main();