<?php
+// Own namespace (watch out: core)
+namespace Org\Mxchange\CoreFramework\EntryPoint;
+
+// Import framework stuff
+use Org\Mxchange\CoreFramework\Bootstrap\FrameworkBootstrap;
+use Org\Mxchange\CoreFramework\Factory\Object\ObjectFactory;
+use Org\Mxchange\CoreFramework\Filesystem\FileNotFoundException;
+use Org\Mxchange\CoreFramework\Helper\Application\ApplicationHelper;
+use Org\Mxchange\CoreFramework\Localization\LanguageSystem;
+use Org\Mxchange\CoreFramework\Localization\ManageableLanguage;
+use Org\Mxchange\CoreFramework\Loader\ClassLoader;
+use Org\Mxchange\CoreFramework\Generic\FrameworkException;
+
+// Import SPL stuff
+use \Exception;
+
/**
* The main class with the entry point to the whole application. This class
* "emulates" Java's entry point call. Additionally it covers local
*
* @author Roland Haeder <webmaster@shipsimu.org>
* @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
*
*/
final class ApplicationEntryPoint {
/**
- * Core path
+ * Framework path
*/
- private static $corePath = '';
+ private static $frameworkPath = '';
/**
* The application's emergency exit
* @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?
+ //* NOISY-DEBUG: */ printf('[%s:%d]: message=%s,code=%d,extraData=%s,silentMode=%d - CALLED!' . PHP_EOL, __METHOD__, __LINE__, $message, $code, $extraData, intval($silentMode));
if (isset($GLOBALS['app_die_called'])) {
// Then output the text directly
- exit($message);
- } // END - if
+ print $message . PHP_EOL;
+ exit(255);
+ }
// 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
+ //* NOISY-DEBUG: */ printf('[%s:%d]: product_install_mode=%d,silentMode=%d - EXIT!' . PHP_EOL, __METHOD__, __LINE__, $configInstance->getConfigEntry('product_install_mode'), intval($silentMode));
+ exit(255);
+ }
// 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: <span class=\"exception_reason\">%s</span>",
+ exit(sprintf('[Main:] Could not initialize template engine for reason: <span class="exception_reason">%s</span>',
$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("<span class=\"backtrace_file\">%s</span>:%d, <span class=\"backtrace_function\">%s(%d)</span><br />\n",
+ $backtrace .= sprintf('<span class="backtrace_file">%s</span>:%d, <span class="backtrace_function">%s(%d)</span><br />' . 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');
$responseInstance->flushBuffer();
} catch (FileNotFoundException $e) {
// Even the template 'emergency_exit' wasn't found so output both message
- exit($message . ', exception: ' . $e->getMessage());
+ print ($message . ', exception: ' . $e->getMessage() . PHP_EOL);
+ exit($e->getCode());
}
// Good bye...
- exit();
+ exit(255);
} else {
// Output message and die
- exit(sprintf('[Main:] Emergency exit reached: <span class="emergency_span">%s</span>',
- $message
- ));
+ printf('[Main:] Emergency exit reached: <span class="emergency_span">%s</span>', $message);
+ exit(255);
}
+
+ // Trace message
+ //* NOISY-DEBUG: */ printf('[%s:%d]: EXIT!' . PHP_EOL, __METHOD__, __LINE__);
}
/**
- * 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
+ //* NOISY-DEBUG: */ printf('[%s:%d]: self::frameworkPath=%s - CALLED!' . PHP_EOL, __METHOD__, __LINE__, self::$frameworkPath);
+ if (empty(self::$frameworkPath)) {
+ // Auto-detect core path (first application-common)
+ foreach (['core', self::getRootPath(), '/usr/local/share/php/core', '/usr/share/php/core'] as $possiblePath) {
+ // Create full path for testing
+ //* NOISY-DEBUG: */ printf('[%s:%d]: possiblePath=%s' . PHP_EOL, __METHOD__, __LINE__, $possiblePath);
+ $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.
+ //* NOISY-DEBUG: */ printf('[%s:%d]: possiblePath=%s was not found. - SKIPPED!' . PHP_EOL, __METHOD__, __LINE__, $possiblePath);
+ 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
+ //* NOISY-DEBUG: */ printf('[%s:%d]: frameworkPath=%s' . PHP_EOL, __METHOD__, __LINE__, $frameworkPath);
+ $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
+ //* NOISY-DEBUG: */ printf('[%s:%d]: Setting self::frameworkPath=%s - BREAK!' . PHP_EOL, __METHOD__, __LINE__, $frameworkPath);
+ break;
+ }
+ }
+
+ // Able to find?
+ //* NOISY-DEBUG: */ printf('[%s:%d]: self::frameworkPath=%s - Checking ...' . PHP_EOL, __METHOD__, __LINE__, self::$frameworkPath);
+ if (!is_dir(self::$frameworkPath)) {
+ // Is no directory
+ throw new Exception('Cannot find framework.');
+ }
+ }
// Return it
- return self::$corePath;
+ //* NOISY-DEBUG: */ printf('[%s:%d]: self::frameworkPath=%s - EXIT!' . PHP_EOL, __METHOD__, __LINE__, self::$frameworkPath);
+ 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 final function main () {
- // Load config file
- require(self::detectCorePath() . '/inc/config.php');
+ // Load bootstrap file
+ //* NOISY-DEBUG: */ printf('[%s:%d]: CALLED!' . PHP_EOL, __METHOD__, __LINE__);
+ 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);
+ // Trace message
+ //* NOISY-DEBUG: */ printf('[%s:%d]: EXIT!' . PHP_EOL, __METHOD__, __LINE__);
+ }
+}
-//xdebug_start_trace();
+// Log all exceptions (only debug! This option can create large error logs)
+//define('LOG_EXCEPTIONS', true);
-// Do not remove the following line:
+// Call above main() method
ApplicationEntryPoint::main();
-
-// [EOF]
-?>
projects / core.git / blobdiff