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