* @version 0.0.0
* @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2020 Core Developer Team
* @license GNU GPL 3.0 or any newer version
* @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
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see .
*/
final class ApplicationEntryPoint {
/**
* Framework path
*/
private static $frameworkPath = '';
/**
* The application's emergency exit
*
* @param $message The optional message we shall output on exit
* @param $code Error code from exception
* @param $extraData Extra information from exceptions
* @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 final function exitApplication ($message = '', $code = false, $extraData = '', $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;
// Is a message set?
if (empty($message)) {
// No message provided
$message = 'No message provided.';
} // END - if
// Get config instance
$configInstance = FrameworkBootstrap::getConfigurationInstance();
// Do we have debug installation?
if (($configInstance->getConfigEntry('product_install_mode') == 'productive') || ($silentMode === true)) {
// Abort here
exit();
} // END - if
// Get some instances
$tpl = $configInstance->getConfigEntry('html_template_class');
$languageInstance = LanguageSystem::getSelfInstance();
// Initialize template instance here to avoid warnings in IDE
$templateInstance = NULL;
// Get response instance
$responseInstance = FrameworkBootstrap::getResponseInstance();
// Is the template engine loaded?
if ((class_exists($tpl)) && (is_object($languageInstance))) {
// Use the template engine for putting out (nicer look) the message
try {
// Get the template instance from our object factory
$templateInstance = ObjectFactory::createObjectByName($tpl);
} catch (FrameworkException $e) {
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) {
// 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)
' . 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('Org\Mxchange\CoreFramework\Helper\Application\ApplicationHelper')) {
// Get application instance
$applicationInstance = ApplicationHelper::getSelfInstance();
// Assign application data
$templateInstance->assignApplicationData();
} // END - if
// 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');
// Compile the template
$templateInstance->compileTemplate();
// Compile all variables
$templateInstance->compileVariables();
// Transfer data to response
$templateInstance->transferToResponse($responseInstance);
// Flush the response
$responseInstance->flushBuffer();
} catch (FileNotFoundException $e) {
// Even the template 'emergency_exit' wasn't found so output both message
exit($message . ', exception: ' . $e->getMessage());
}
// Good bye...
exit();
} else {
// Output message and die
exit(sprintf('[Main:] Emergency exit reached: %s',
$message
));
}
}
/**
* 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 $frameworkPath Path for framework
*/
public static final function detectFrameworkPath () {
// Is it not set?
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);
// Debug message
//* NOISY-DEBUG: */ printf('[%s:%d]: realPath[%s]=%s' . PHP_EOL, __METHOD__, __LINE__, gettype($realPath), $realPath);
// Is it false?
if ($realPath === false) {
// Then, not found.
continue;
} // END - if
// 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';
// Debug message
//* NOISY-DEBUG: */ printf('[%s:%d]: configFile=%s' . PHP_EOL, __METHOD__, __LINE__, $configFile);
// Is it readable?
if (is_readable($configFile)) {
// Found one
self::$frameworkPath = $frameworkPath;
// Abort here
break;
} // END - if
} // END - foreach
// Able to find?
if (!is_dir(self::$frameworkPath)) {
// Is no directory
throw new Exception('Cannot find framework.');
} // END - if
} // END - if
// Return it
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 framework's main entry point. This class isolates some local
* variables which shall not become visible to outside because of security
* concerns. This is done here to "emulate" the well-known entry point in
* Java.
*
* @return void
*/
public static final function main () {
// Load bootstrap file
require sprintf('%sbootstrap%sbootstrap.inc.php', self::detectFrameworkPath(), DIRECTORY_SEPARATOR);
/*
* Initial bootstrap is done, continue with initialization of
* framework.
*/
FrameworkBootstrap::initFramework();
// Next initialize the detected application
FrameworkBootstrap::prepareApplication();
/*
* Last step is to start the application, this will also initialize and
* register the application instance in registry.
*/
FrameworkBootstrap::startApplication();
}
}
// Developer mode active? Comment out if no dev!
define('DEVELOPER', true);
// Log all exceptions (only debug! This option can create large error logs)
//define('LOG_EXCEPTIONS', true);
//xdebug_start_trace();
// Call above main() method
ApplicationEntryPoint::main();