SVN properties globally set
[mailer.git] / index.php
index 64aa05f8954136ed77b6e657a824934a3e5901e0..3b7f082544b72dcaebefe3db00e4752fdb4aa922 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,10 +7,10 @@ define('DEVELOPER', true);
  *
  * But good little boys and girls would always initialize their variables... ;-)
  *
- * @author     Roland Haeder <webmaster@ship-simu.org>
- * @version    0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, this is free software
- * @license    GNU GPL 3.0 or any newer version
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0.0
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Core Developer Team
+ * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.ship-simu.org
  *
  * This program is free software: you can redistribute it and/or modify
@@ -29,7 +26,12 @@ define('DEVELOPER', true);
  * You should have received a copy of the GNU General Public License
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
-class ApplicationEntryPoint {
+final class ApplicationEntryPoint {
+       /**
+        * Core path
+        */
+       private static $corePath = '';
+
        /**
         * The instances we want to remove after all is done
         *
@@ -54,46 +56,49 @@ class ApplicationEntryPoint {
         * @param       $extraData              Extra information from exceptions
         * @param       $silentMode             Wether not silent mode is turned on
         * @return      void
+        * @todo        This method is old code and needs heavy rewrite
         */
-       public static function app_die ($message = "", $code = false, $extraData = "", $silentMode = false) {
+       public static function app_die ($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);
                } // 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();
 
                // Do we have debug installation?
-               if (($configInstance->readConfig('product_install_mode') == "productive") || ($silentMode === true)) {
+               if (($configInstance->getConfigEntry('product_install_mode') == 'productive') || ($silentMode === true)) {
                        // Abort here
                        die();
                } // END - if
 
                // Get some instances
-               $tpl = FrameworkConfiguration::getInstance()->readConfig('template_class');
-               $lang = LanguageSystem::getInstance();
-               $io = FileIoHandler::getInstance();
+               $tpl = FrameworkConfiguration::getInstance()->getConfigEntry('web_template_class');
+               $languageInstance = LanguageSystem::getInstance();
+
+               // Initialize template instance here to avoid warnings in IDE
+               $templateInstance = null;
 
                // Get response instance
                $responseInstance = ApplicationHelper::getInstance()->getResponseInstance();
 
                // Is the template engine loaded?
-               if ((class_exists($tpl)) && (is_object($lang)) && (is_object($io))) {
+               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(FrameworkConfiguration::getInstance()->readConfig('tpl_base_path'), $lang, $io));
+                               $templateInstance = ObjectFactory::createObjectByName($tpl, array(ApplicationHelper::getInstance()));
                        } catch (FrameworkException $e) {
                                die(sprintf("[Main:] Could not initialize template engine for reason: <span class=\"exception_reason\">%s</span>",
                                        $e->getMessage()
@@ -101,14 +106,18 @@ class ApplicationEntryPoint {
                        }
 
                        // Get and prepare backtrace for output
-                       // @TODO Rewrite this to something "generic"
                        $backtraceArray = debug_backtrace();
-                       $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 />";
+                               $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
@@ -123,29 +132,35 @@ class ApplicationEntryPoint {
                                $templateInstance->assignApplicationData($appInstance);
                        } // 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::getInstance()->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
+                               die($message . ', exception: ' . $e->getMessage());
+                       }
 
                        // Good bye...
                        exit();
@@ -157,6 +172,23 @@ 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
+        */
+       protected static function detectCorePath () {
+               // Is it not set?
+               if (empty(self::$corePath)) {
+                       // Auto-detect our core path
+                       self::$corePath = str_replace("\\", '/', dirname(__FILE__));
+               } // END - if
+
+               // Return it
+               return self::$corePath;
+       }
+
        /**
         * The application's main entry point. This class isolates some local
         * variables which shall not become visible to outside because of security
@@ -166,24 +198,28 @@ class ApplicationEntryPoint {
         * @return      void
         */
        public static function main () {
-               // Some non-global common arrays we need...
-               global $_SERVER;
-
                // Load config file
-               require(dirname(__FILE__) . '/inc/config.php');
+               require(self::detectCorePath() . '/inc/config.php');
 
                // Load all include files
-               require($cfg->readConfig('base_path') . 'inc/includes.php');
+               require($cfg->getConfigEntry('base_path') . 'inc/includes.php');
 
                // Load all framework classes
-               require($cfg->readConfig('base_path') . 'inc/classes.php');
+               require($cfg->getConfigEntry('base_path') . 'inc/classes.php');
 
                // Include the application selector
-               require($cfg->readConfig('base_path') . 'inc/selector.php');
+               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();