From d6cbd0cfbc6357bcc6b7163842cd00a020003263 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Roland=20H=C3=A4der?= Date: Thu, 16 Feb 2023 18:33:56 +0100 Subject: [PATCH] Continued: - updated index.php which is the entrance to any application, including daemons and tools on console - updated 'core' framework --- Doxyfile => contrib/Doxyfile | 0 core | 2 +- inc | 1 - index.php | 194 +++++++++++++++++++++++------------ 4 files changed, 132 insertions(+), 65 deletions(-) rename Doxyfile => contrib/Doxyfile (100%) delete mode 120000 inc diff --git a/Doxyfile b/contrib/Doxyfile similarity index 100% rename from Doxyfile rename to contrib/Doxyfile diff --git a/core b/core index 1893995..ad17ce1 160000 --- a/core +++ b/core @@ -1 +1 @@ -Subproject commit 1893995b39b02c07012c5f3795654fb9251b5ebd +Subproject commit ad17ce1c5fe13f2290e74bec676f23e65c2e9100 diff --git a/inc b/inc deleted file mode 120000 index 1f8dea2..0000000 --- a/inc +++ /dev/null @@ -1 +0,0 @@ -core/inc \ No newline at end of file diff --git a/index.php b/index.php index 51eb50e..51a9f47 100644 --- a/index.php +++ b/index.php @@ -1,4 +1,20 @@ * @version 0.0.0 - * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 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.shipsimu.org * @@ -28,9 +44,9 @@ */ final class ApplicationEntryPoint { /** - * Core path + * Framework path */ - private static $corePath = ''; + private static $frameworkPath = ''; /** * The application's emergency exit @@ -42,99 +58,104 @@ final class ApplicationEntryPoint { * @return void * @todo This method is old code and needs heavy rewrite and should be moved to ApplicationHelper */ - public static final function app_exit ($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 (isset($GLOBALS['app_die_called'])) { // Then output the text directly exit($message); - } // END - if + } // This method shall not be called twice - $GLOBALS['app_die_called'] = TRUE; + $GLOBALS['app_die_called'] = true; // Is a message set? if (empty($message)) { // No message provided $message = 'No message provided.'; - } // END - if + } // Get config instance - $configInstance = FrameworkConfiguration::getSelfInstance(); + $configInstance = FrameworkBootstrap::getConfigurationInstance(); // Do we have debug installation? - if (($configInstance->getConfigEntry('product_install_mode') == 'productive') || ($silentMode === TRUE)) { + if (($configInstance->getConfigEntry('product_install_mode') == 'productive') || ($silentMode === true)) { // Abort here - exit(); - } // END - if + exit; + } // Get some instances - $tpl = FrameworkConfiguration::getSelfInstance()->getConfigEntry('html_template_class'); + $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::getSelfInstance()->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); + $templateInstance = ObjectFactory::createObjectByName($templateClassName); } catch (FrameworkException $e) { - exit(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) { + foreach (debug_backtrace() as $key => $trace) { // Set missing array elements if (!isset($trace['file'])) { $trace['file'] = __FILE__; - } // END - if + } if (!isset($trace['line'])) { $trace['line'] = __LINE__; - } // END - if + } if (!isset($trace['args'])) { $trace['args'] = array(); - } // END - if + } // Add the traceback path to the final output - $backtrace .= sprintf("%s:%d, %s(%d)
\n", + $backtrace .= sprintf('%s:%d, %s(%d)
' . PHP_EOL, basename($trace['file']), $trace['line'], $trace['function'], count($trace['args']) ); - } // END - foreach + } // Init application instance $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 $applicationInstance = ApplicationHelper::getSelfInstance(); // Assign application data - $templateInstance->assignApplicationData($applicationInstance); - } // END - if + $templateInstance->assignApplicationData(); + } // 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('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')); + $templateInstance->assignVariable('total_objects' , ObjectFactory::getTotal()); + $templateInstance->assignVariable('title' , $languageInstance->getMessage('emergency_exit_title')); // Load the template $templateInstance->loadCodeTemplate('emergency_exit'); @@ -150,68 +171,115 @@ final class ApplicationEntryPoint { // Flush the response $responseInstance->flushBuffer(); - } catch (FileIoException $e) { + } catch (FileNotFoundException $e) { // Even the template 'emergency_exit' wasn't found so output both message exit($message . ', exception: ' . $e->getMessage()); } // Good bye... - exit(); + exit; } else { // Output message and die - exit(sprintf('[Main:] Emergency exit reached: %s', + die(sprintf('[Main:] Emergency exit reached: %s', $message )); } } /** - * 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 $corePath Base path (core) for all includes + * @return $frameworkPath Path for framework */ - protected static final 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; + } + + /** + * Getter for root path + * + * @return $rootPath Root path + */ + public static function getRootPath () { + // Get __DIR__, really simple and no detection + return __DIR__; } /** - * The application's main entry point. This class isolates some local + * 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 final function main () { - // Load config file - require(self::detectCorePath() . '/inc/config.php'); + // 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(); - // Include the application selector - require($cfg->getConfigEntry('base_path') . 'inc/selector.php'); - } // END - main() -} // END - class + // Next initialize the detected application + FrameworkBootstrap::prepareApplication(); -// Developer mode active? Comment out if no dev! -define('DEVELOPER', TRUE); + /* + * Last step is to start the application, this will also initialize and + * register the application instance in registry. + */ + FrameworkBootstrap::startApplication(); + } +} // Log all exceptions (only debug! This option can create large error logs) -//define('LOG_EXCEPTIONS', TRUE); +//define('LOG_EXCEPTIONS', true); //xdebug_start_trace(); -// Do not remove the following line: +// Call above main() method ApplicationEntryPoint::main(); - -// [EOF] -?> -- 2.39.5