index.php

   1 <?php
   2 // Developer mode active? Comment out if no dev!
   3 define('DEVELOPER', true);
   4 //xdebug_start_trace();
   5 /**
   6  * The main class with the entry point to the whole application. This class
   7  * "emulates" Java's entry point call. Additionally it covers local
   8  * variables from outside access to prevent possible attacks on uninitialized
   9  * local variables.
  10  *
  11  * But good little boys and girls would always initialize their variables... ;-)
  12  *
  13  * @author              Roland Haeder <webmaster@ship-simu.org>
  14  * @version             0.0.0
  15  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, this is free software
  16  * @license             GNU GPL 3.0 or any newer version
  17  * @link                http://www.ship-simu.org
  18  *
  19  * This program is free software: you can redistribute it and/or modify
  20  * it under the terms of the GNU General Public License as published by
  21  * the Free Software Foundation, either version 3 of the License, or
  22  * (at your option) any later version.
  23  *
  24  * This program is distributed in the hope that it will be useful,
  25  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  26  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  27  * GNU General Public License for more details.
  28  *
  29  * You should have received a copy of the GNU General Public License
  30  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  31  */
  32 class ApplicationEntryPoint {
  33         /**
  34          * The instances we want to remove after all is done
  35          *
  36          * @return      void
  37          */
  38         private static $instances = array (
  39                 'cfg',    // The configuration system
  40                 'loader', // The class loader system
  41                 'debug',  // Debug output
  42                 'db',     // Database layer
  43                 'io',     // Base I/O system (local file [or network])
  44                 'engine', // Template engine ( for ApplicationEntryPoint::app_die() )
  45                 'lang',   // Language sub-system
  46                 'app',    // The ApplicationHelper instance
  47         );
  48
  49         /**
  50          * The application's emergency exit
  51          *
  52          * @param       $message                The optional message we shall output on exit
  53          * @param       $code                   Error code from exception
  54          * @param       $extraData              Extra information from exceptions
  55          * @param       $silentMode             Wether not silent mode is turned on
  56          * @return      void
  57          */
  58         public static function app_die ($message = "", $code = false, $extraData = "", $silentMode = false) {
  59                 // Is this method already called?
  60                 if (defined('EMERGENCY_EXIT_CALLED')) {
  61                         // Then output the text directly
  62                         die($message);
  63                 } // END - if
  64
  65                 // This method shall not be called twice
  66                 define('EMERGENCY_EXIT_CALLED', true);
  67
  68                 // Is a message set?
  69                 if (empty($message)) {
  70                         // No message provided
  71                         $message = "No message provided!";
  72                 } // END - if
  73
  74                 // Get config instance
  75                 $configInstance = FrameworkConfiguration::getInstance();
  76
  77                 // Do we have debug installation?
  78                 if (($configInstance->readConfig('product_install_mode') == "productive") || ($silentMode === true)) {
  79                         // Abort here
  80                         die();
  81                 } // END - if
  82
  83                 // Get some instances
  84                 $tpl = FrameworkConfiguration::getInstance()->readConfig('template_class');
  85                 $lang = LanguageSystem::getInstance();
  86
  87                 // Get response instance
  88                 $responseInstance = ApplicationHelper::getInstance()->getResponseInstance();
  89
  90                 // Is the template engine loaded?
  91                 if ((class_exists($tpl)) && (is_object($lang))) {
  92                         // Use the template engine for putting out (nicer look) the message
  93                         try {
  94                                 // Get the template instance from our object factory
  95                                 $templateInstance = ObjectFactory::createObjectByName($tpl, array(ApplicationHelper::getInstance()));
  96                         } catch (FrameworkException $e) {
  97                                 die(sprintf("[Main:] Could not initialize template engine for reason: <span class=\"exception_reason\">%s</span>",
  98                                         $e->getMessage()
  99                                 ));
 100                         }
 101
 102                         // Get and prepare backtrace for output
 103                         $backtraceArray = debug_backtrace();
 104                         $backtrace = "";
 105                         foreach ($backtraceArray as $key => $trace) {
 106                                 if (!isset($trace['file'])) $trace['file'] = __FILE__;
 107                                 if (!isset($trace['line'])) $trace['line'] = __LINE__;
 108                                 if (!isset($trace['args'])) $trace['args'] = array();
 109                                 $backtrace .= "<span class=\"backtrace_file\">".basename($trace['file'])."</span>:".$trace['line'].", <span class=\"backtrace_function\">".$trace['function']."(".count($trace['args']).")</span><br />";
 110                         } // END - foreach
 111
 112                         // Init application instance
 113                         $appInstance = null;
 114
 115                         // Is the class there?
 116                         if (class_exists('ApplicationHelper')) {
 117                                 // Get application instance
 118                                 $appInstance = ApplicationHelper::getInstance();
 119
 120                                 // Assign application data
 121                                 $templateInstance->assignApplicationData($appInstance);
 122                         } // END - if
 123
 124                         // Assign variables
 125                         $templateInstance->assignVariable('message', $message);
 126                         $templateInstance->assignVariable('code', $code);
 127                         $templateInstance->assignVariable('extra', $extraData);
 128                         $templateInstance->assignVariable('backtrace', $backtrace);
 129                         $templateInstance->assignVariable('total_includes', ClassLoader::getInstance()->getTotal());
 130                         $templateInstance->assignVariable('total_objects', ObjectFactory::getTotal());
 131                         $templateInstance->assignVariable('title', $lang->getMessage('emergency_exit_title'));
 132
 133                         // Load the template
 134                         $templateInstance->loadCodeTemplate('emergency_exit');
 135
 136                         // Compile the template
 137                         $templateInstance->compileTemplate();
 138
 139                         // Compile all variables
 140                         $templateInstance->compileVariables();
 141
 142                         // Transfer data to response
 143                         $templateInstance->transferToResponse($responseInstance);
 144
 145                         // Flush the response
 146                         $responseInstance->flushBuffer();
 147
 148                         // Good bye...
 149                         exit();
 150                 } else {
 151                         // Output message and die
 152                         die(sprintf("[Main:] Emergency exit reached: <span class=\"emergency_span\">%s</span>",
 153                                 $message
 154                         ));
 155                 }
 156         }
 157
 158         /**
 159          * The application's main entry point. This class isolates some local
 160          * variables which shall not become visible to outside because of security
 161          * concerns. We are doing this here to "emulate" the well-known entry
 162          * point in Java.
 163          *
 164          * @return      void
 165          */
 166         public static function main () {
 167                 // Load config file
 168                 require(dirname(__FILE__) . '/inc/config.php');
 169
 170                 // Load all include files
 171                 require($cfg->readConfig('base_path') . 'inc/includes.php');
 172
 173                 // Load all framework classes
 174                 require($cfg->readConfig('base_path') . 'inc/classes.php');
 175
 176                 // Include the application selector
 177                 require($cfg->readConfig('base_path') . 'inc/selector.php');
 178         } // END - main()
 179
 180 } // END - class
 181
 182 // Do not remove the following line:
 183 ApplicationEntryPoint::main();
 184
 185 // [EOF]
 186 ?>