X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=index.php;h=94177e3062c449faaa117332f0d0fac89dad4038;hb=eced67894499e4d839906e94676eee83ffe2325c;hp=f2e1c4c49508273bec169275150700d1292e9d98;hpb=1fe479264429e6b921f81dd00964c5233b64459f;p=shipsimu.git diff --git a/index.php b/index.php index f2e1c4c..94177e3 100644 --- a/index.php +++ b/index.php @@ -1,7 +1,20 @@ + * @author Roland Haeder * @version 0.0.0 - * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team + * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2021 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 @@ -31,25 +44,9 @@ define('DEVELOPER', true); */ final class ApplicationEntryPoint { /** - * Core path - */ - private static $corePath = ''; - - /** - * The instances we want to remove after all is done - * - * @return void + * Framework path */ - 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 - ); + private static $frameworkPath = ''; /** * The application's emergency exit @@ -57,152 +54,233 @@ final class ApplicationEntryPoint { * @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 exitApplication (string $message = '', int $code = -1, string $extraData = '', bool $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 + print $message . PHP_EOL; + exit(255); + } // 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!'; - } // END - if + $message = 'No message provided.'; + } // Get config instance - $configInstance = FrameworkConfiguration::getInstance(); + $configInstance = FrameworkBootstrap::getConfigurationInstance(); // Do we have debug installation? if (($configInstance->getConfigEntry('product_install_mode') == 'productive') || ($silentMode === true)) { // Abort here - die(); - } // END - if + exit(255); + } // Get some instances - $tpl = FrameworkConfiguration::getInstance()->getConfigEntry('web_template_class'); - $languageInstance = LanguageSystem::getInstance(); + $templateClassName = $configInstance->getConfigEntry('html_template_class'); + $languageInstance = LanguageSystem::getSelfInstance(); + + // Initialize template instance here to avoid warnings in IDE + $templateInstance = NULL; // Get response instance - $responseInstance = ApplicationHelper::getInstance()->getResponseInstance(); + $responseInstance = FrameworkBootstrap::getResponseInstance(); // Is the template engine loaded? - if ((class_exists($tpl)) && (is_object($languageInstance))) { + if ((class_exists($templateClassName)) && ($languageInstance instanceof ManageableLanguage)) { // 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($templateClassName); } catch (FrameworkException $e) { - die(sprintf("[Main:] Could not initialize template engine for reason: %s", + exit(sprintf('[Main:] Could not initialize template engine for reason: %s', $e->getMessage() )); } // Get and prepare backtrace for output - $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 .= "".basename($trace['file']).":".$trace['line'].", ".$trace['function']."(".count($trace['args']).")
"; - } // END - foreach + foreach (debug_backtrace() as $key => $trace) { + // Set missing array elements + if (!isset($trace['file'])) { + $trace['file'] = __FILE__; + } + if (!isset($trace['line'])) { + $trace['line'] = __LINE__; + } + if (!isset($trace['args'])) { + $trace['args'] = array(); + } + + // Add the traceback path to the final output + $backtrace .= sprintf('%s:%d, %s(%d)
' . PHP_EOL, + basename($trace['file']), + $trace['line'], + $trace['function'], + count($trace['args']) + ); + } // Init application instance - $appInstance = null; + $applicationInstance = NULL; - // Is the class there? - if (class_exists('ApplicationHelper')) { + /* + * The following class may NOT be loaded at all times. For example, + * it might be the (rare) case that an error has happened BEFORE + * that class had been loaded and cannot be loaded or else an + * infinte loop in invoking this method will take place resulting in + * a stack-overflow error. + */ + if (class_exists('Org\Mxchange\CoreFramework\Helper\Application\ApplicationHelper')) { // Get application instance - $appInstance = ApplicationHelper::getInstance(); + $applicationInstance = ApplicationHelper::getSelfInstance(); // Assign application data - $templateInstance->assignApplicationData($appInstance); - } // END - if + $templateInstance->assignApplicationData(); + } - // 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')); + // 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'); + // Load the template + $templateInstance->loadCodeTemplate('emergency_exit'); - // Compile the template - $templateInstance->compileTemplate(); + // Compile the template + $templateInstance->compileTemplate(); - // Compile all variables - $templateInstance->compileVariables(); + // Compile all variables + $templateInstance->compileVariables(); - // Transfer data to response - $templateInstance->transferToResponse($responseInstance); + // Transfer data to response + $templateInstance->transferToResponse($responseInstance); - // Flush the response - $responseInstance->flushBuffer(); + // Flush the response + $responseInstance->flushBuffer(); + } catch (FileNotFoundException $e) { + // Even the template 'emergency_exit' wasn't found so output both message + print ($message . ', exception: ' . $e->getMessage() . PHP_EOL); + exit($e->getCode()); + } // Good bye... - exit(); + exit(255); } else { // Output message and die - die(sprintf("[Main:] Emergency exit reached: %s", - $message - )); + printf('[Main:] Emergency exit reached: %s', $message); + exit(255); } } /** - * Determines the correct absolute path for all includes only once per run. - * Other calls of this method are being "cached". + * Determines the correct absolute path for the framework. A set of common + * paths is being tested (first most common for applications, second when + * core tests are being executed and third/forth if the framework has been + * cloned there). * - * @return $basePath Base path (core) for all includes + * @return $frameworkPath Path for framework */ - protected static function detectCorePath () { + public static final function detectFrameworkPath () { // Is it not set? - if (empty(self::$corePath)) { - // Auto-detect our core path - self::$corePath = str_replace("\\", '/', dirname(__FILE__)); - } // END - if + if (empty(self::$frameworkPath)) { + // Auto-detect core path (first application-common) + foreach (array('core', __DIR__, '/usr/local/share/php/core', '/usr/share/php/core') as $possiblePath) { + // Create full path for testing + $realPath = realpath($possiblePath); + + // Is it false? + //* NOISY-DEBUG: */ printf('[%s:%d]: realPath[%s]=%s' . PHP_EOL, __METHOD__, __LINE__, gettype($realPath), $realPath); + if ($realPath === false) { + // Then, not found. + continue; + } + + // Append framework path + $frameworkPath = sprintf('%s%sframework%s', $realPath, DIRECTORY_SEPARATOR, DIRECTORY_SEPARATOR); + + // First create full-qualified file name (FQFN) to framework/config-global.php + $configFile = $frameworkPath . 'config-global.php'; + + // Is it readable? + //* NOISY-DEBUG: */ printf('[%s:%d]: configFile=%s' . PHP_EOL, __METHOD__, __LINE__, $configFile); + if (is_readable($configFile)) { + // Found one + self::$frameworkPath = $frameworkPath; + + // Abort here + break; + } + } + + // Able to find? + if (!is_dir(self::$frameworkPath)) { + // Is no directory + throw new Exception('Cannot find framework.'); + } + } // Return it - return self::$corePath; + return self::$frameworkPath; } /** - * The application's main entry point. This class isolates some local + * Getter for root path + * + * @return $rootPath Root path + */ + public static function getRootPath () { + // Get __DIR__, really simple and no detection + return __DIR__; + } + + /** + * The framework's main entry point. This class isolates some local * variables which shall not become visible to outside because of security - * concerns. We are doing this here to "emulate" the well-known entry - * point in Java. + * concerns. This is done here to "emulate" the well-known entry point in + * Java. * * @return void */ - public static function main () { - // Load config file - require(self::detectCorePath() . '/inc/config.php'); + public static final function main () { + // Load bootstrap file + require sprintf('%sbootstrap%sbootstrap.inc.php', self::detectFrameworkPath(), DIRECTORY_SEPARATOR); - // Load all include files - require($cfg->getConfigEntry('base_path') . 'inc/includes.php'); + /* + * Initial bootstrap is done, continue with initialization of + * framework. + */ + FrameworkBootstrap::initFramework(); - // Load all framework classes - require($cfg->getConfigEntry('base_path') . 'inc/classes.php'); + // Next initialize the detected application + FrameworkBootstrap::prepareApplication(); - // Include the application selector - require($cfg->getConfigEntry('base_path') . 'inc/selector.php'); - } // END - main() + /* + * Last step is to start the application, this will also initialize and + * register the application instance in registry. + */ + FrameworkBootstrap::startApplication(); + } +} -} // END - class +// Log all exceptions (only debug! This option can create large error logs) +//define('LOG_EXCEPTIONS', true); -// Do not remove the following line: -ApplicationEntryPoint::main(); +//xdebug_start_trace(); -// [EOF] -?> +// Call above main() method +ApplicationEntryPoint::main();