2 // Developer mode active? Comment out if no dev!
3 define('DEVELOPER', true);
4 //xdebug_start_trace();
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
11 * But good little boys and girls would always initialize their variables... ;-)
13 * @author Roland Haeder <webmaster@ship-simu.org>
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
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.
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.
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/>.
32 class ApplicationEntryPoint {
34 * The instances we want to remove after all is done
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
50 * The application's emergency exit
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
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
65 // This method shall not be called twice
66 define('EMERGENCY_EXIT_CALLED', true);
69 if (empty($message)) {
70 // No message provided
71 $message = "No message provided!";
74 // Get config instance
75 $configInstance = FrameworkConfiguration::getInstance();
77 // Do we have debug installation?
78 if (($configInstance->readConfig('product_install_mode') == "productive") || ($silentMode === true)) {
84 $tpl = FrameworkConfiguration::getInstance()->readConfig('template_class');
85 $lang = LanguageSystem::getInstance();
86 $io = FileIoHandler::getInstance();
88 // Get response instance
89 $responseInstance = ApplicationHelper::getInstance()->getResponseInstance();
91 // Is the template engine loaded?
92 if ((class_exists($tpl)) && (is_object($lang)) && (is_object($io))) {
93 // Use the template engine for putting out (nicer look) the message
95 // Get the template instance from our object factory
96 $templateInstance = ObjectFactory::createObjectByName($tpl, array(FrameworkConfiguration::getInstance()->readConfig('tpl_base_path'), $lang, $io));
97 } catch (FrameworkException $e) {
98 die(sprintf("[Main:] Could not initialize template engine for reason: <span class=\"exception_reason\">%s</span>",
103 // Get and prepare backtrace for output
104 // @TODO Rewrite this to something "generic"
105 $backtraceArray = debug_backtrace();
107 foreach ($backtraceArray as $key => $trace) {
108 if (!isset($trace['file'])) $trace['file'] = __FILE__;
109 if (!isset($trace['line'])) $trace['line'] = __LINE__;
110 if (!isset($trace['args'])) $trace['args'] = array();
111 $backtrace .= "<span class=\"backtrace_file\">".basename($trace['file'])."</span>:".$trace['line'].", <span class=\"backtrace_function\">".$trace['function']."(".count($trace['args']).")</span><br />";
114 // Init application instance
117 // Is the class there?
118 if (class_exists('ApplicationHelper')) {
119 // Get application instance
120 $appInstance = ApplicationHelper::getInstance();
122 // Assign application data
123 $templateInstance->assignApplicationData($appInstance);
127 $templateInstance->assignVariable('message' , $message);
128 $templateInstance->assignVariable('code' , $code);
129 $templateInstance->assignVariable('extra' , $extraData);
130 $templateInstance->assignVariable('backtrace' , $backtrace);
131 $templateInstance->assignVariable('total_includes', ClassLoader::getInstance()->getTotal());
132 $templateInstance->assignVariable('total_objects' , ObjectFactory::getTotal());
133 $templateInstance->assignVariable('title' , $lang->getMessage('emergency_exit_title'));
136 $templateInstance->loadCodeTemplate('emergency_exit');
138 // Compile the template
139 $templateInstance->compileTemplate();
141 // Compile all variables
142 $templateInstance->compileVariables();
144 // Transfer data to response
145 $templateInstance->transferToResponse($responseInstance);
147 // Flush the response
148 $responseInstance->flushBuffer();
153 // Output message and die
154 die(sprintf("[Main:] Emergency exit reached: <span class=\"emergency_span\">%s</span>",
161 * The application's main entry point. This class isolates some local
162 * variables which shall not become visible to outside because of security
163 * concerns. We are doing this here to "emulate" the well-known entry
168 public static function main () {
169 // Some non-global common arrays we need...
173 require(dirname(__FILE__) . '/inc/config.php');
175 // Load all include files
176 require($cfg->readConfig('base_path') . 'inc/includes.php');
178 // Load all framework classes
179 require($cfg->readConfig('base_path') . 'inc/classes.php');
181 // Include the application selector
182 require($cfg->readConfig('base_path') . 'inc/selector.php');
187 // Do not remove the following line:
188 ApplicationEntryPoint::main();