3 namespace Org\Mxchange\CoreFramework\Bootstrap;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Configuration\FrameworkConfiguration;
7 use Org\Mxchange\CoreFramework\Connection\Database\DatabaseConnection;
8 use Org\Mxchange\CoreFramework\Connector\Database\DatabaseConnector;
9 use Org\Mxchange\CoreFramework\Console\Tools\ConsoleTools;
10 use Org\Mxchange\CoreFramework\EntryPoint\ApplicationEntryPoint;
11 use Org\Mxchange\CoreFramework\Factory\ObjectFactory;
12 use Org\Mxchange\CoreFramework\Generic\NullPointerException;
13 use Org\Mxchange\CoreFramework\Helper\Application\ApplicationHelper;
14 use Org\Mxchange\CoreFramework\Loader\ClassLoader;
15 use Org\Mxchange\CoreFramework\Manager\ManageableApplication;
16 use Org\Mxchange\CoreFramework\Middleware\Debug\DebugMiddleware;
17 use Org\Mxchange\CoreFramework\Object\BaseFrameworkSystem;
18 use Org\Mxchange\CoreFramework\Registry\GenericRegistry;
19 use Org\Mxchange\CoreFramework\Request\Requestable;
20 use Org\Mxchange\CoreFramework\Response\Responseable;
23 use \BadMethodCallException;
24 use \InvalidArgumentException;
28 * A framework-bootstrap class which helps the frameworks to bootstrap ... ;-)
30 * @author Roland Haeder <webmaster@ship-simu.org>
32 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
33 * @license GNU GPL 3.0 or any newer version
34 * @link http://www.ship-simu.org
36 * This program is free software: you can redistribute it and/or modify
37 * it under the terms of the GNU General Public License as published by
38 * the Free Software Foundation, either version 3 of the License, or
39 * (at your option) any later version.
41 * This program is distributed in the hope that it will be useful,
42 * but WITHOUT ANY WARRANTY; without even the implied warranty of
43 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
44 * GNU General Public License for more details.
46 * You should have received a copy of the GNU General Public License
47 * along with this program. If not, see <http://www.gnu.org/licenses/>.
49 final class FrameworkBootstrap {
52 * Detected server address
54 private static $serverAddress = NULL;
57 * Instance of a Requestable class
59 private static $requestInstance = NULL;
62 * Instance of a Responseable class
64 private static $responseInstance = NULL;
67 * Instance of a FrameworkConfiguration class
69 private static $configurationInstance = NULL;
74 private static $databaseInstance = NULL;
77 * Includes applications may have. They will be tried in the given order,
78 * some will become soon deprecated.
80 private static $configAppIncludes = array(
81 // The ApplicationHelper class (required)
82 'class_ApplicationHelper' => 'required',
83 // Some debugging stuff (optional but can be committed)
84 'debug' => 'optional',
85 // Application's exception handler (optional but can be committed)
86 'exceptions' => 'optional',
87 // Application's configuration file (committed, non-local specific)
88 'config' => 'required',
89 // Local configuration file (optional, not committed, listed in .gitignore)
90 'config-local' => 'optional',
91 // Application data (deprecated)
92 'data' => 'deprecated',
93 // Application loader (deprecated)
94 'loader' => 'deprecated',
95 // Application initializer (deprecated)
96 'init' => 'deprecated',
97 // Application starter (deprecated)
98 'starter' => 'deprecated',
102 * Private constructor, no instance is needed from this class as only
103 * static methods exist.
105 private function __construct () {
106 // Prevent making instances from this "utilities" class
110 * Some "getter" for a configuration instance, making sure, it is unique
112 * @return $configurationInstance An instance of a FrameworkConfiguration class
114 public static function getConfigurationInstance () {
115 // Is the instance there?
116 if (is_null(self::$configurationInstance)) {
118 self::$configurationInstance = new FrameworkConfiguration();
122 return self::$configurationInstance;
126 * "Getter" to get response/request type from analysis of the system.
128 * @return $requestType Analyzed request type
130 public static function getRequestTypeFromSystem () {
131 // Default is console
132 $requestType = 'console';
134 // Is 'HTTP_HOST' set?
135 if (isset($_SERVER['HTTP_HOST'])) {
136 // Then it is a HTML response/request.
137 $requestType = 'html';
145 * Checks whether the given file/path is in open_basedir(). This does not
146 * gurantee that the file is actually readable and/or writeable. If you need
147 * such gurantee then please use isReadableFile() instead.
149 * @param $fileInstance An instance of a SplFileInfo class
150 * @return $isReachable Whether it is within open_basedir()
152 public static function isReachableFilePath (SplFileInfo $fileInstance) {
153 // Is not reachable by default
154 $isReachable = false;
156 // Get open_basedir parameter
157 $openBaseDir = trim(ini_get('open_basedir'));
160 if (!empty($openBaseDir)) {
162 foreach (explode(PATH_SEPARATOR, $openBaseDir) as $dir) {
163 // Check on existence
164 if (substr($fileInstance->getPathname(), 0, strlen($dir)) == $dir) {
168 // Abort lookup as it has been found in open_basedir
173 // If open_basedir is not set, all is allowed
182 * Checks whether the give file is within open_basedir() (done by
183 * isReachableFilePath()), is actually a file and is readable.
185 * @param $fileInstance An instance of a SplFileInfo class
186 * @return $isReadable Whether the file is readable (and therefor exists)
188 public static function isReadableFile (SplFileInfo $fileInstance) {
189 // Default is not readable
192 // Check if it is a file and readable
195 self::isReachableFilePath($fileInstance)
197 $fileInstance->isFile()
199 $fileInstance->isReadable()
208 * Loads given include file
210 * @param $fileInstance An instance of a SplFileInfo class
212 * @throws InvalidArgumentException If file was not found or not readable or deprecated
214 public static function loadInclude (SplFileInfo $fileInstance) {
216 //* NOISY-DEBUG: */ printf('[%s:%d]: fileInstance=%s - CALLED!' . PHP_EOL, __METHOD__, __LINE__, $fileInstance);
218 // Should be there ...
219 if (!self::isReadableFile($fileInstance)) {
221 throw new InvalidArgumentException(sprintf('Cannot find fileInstance.pathname=%s.', $fileInstance->getPathname()));
225 require_once $fileInstance->getPathname();
228 //* NOISY-DEBUG: */ printf('[%s:%d]: EXIT!' . PHP_EOL, __METHOD__, __LINE__);
232 * Does the actual bootstrap
236 public static function doBootstrap () {
237 // Load basic include files to continue bootstrapping
238 self::loadInclude(new SplFileInfo(sprintf('%smain%sinterfaces%sclass_FrameworkInterface.php', ApplicationEntryPoint::detectFrameworkPath(), DIRECTORY_SEPARATOR, DIRECTORY_SEPARATOR)));
239 self::loadInclude(new SplFileInfo(sprintf('%smain%sclasses%sclass_BaseFrameworkSystem.php', ApplicationEntryPoint::detectFrameworkPath(), DIRECTORY_SEPARATOR, DIRECTORY_SEPARATOR)));
240 self::loadInclude(new SplFileInfo(sprintf('%smain%sinterfaces%sregistry%sclass_Registerable.php', ApplicationEntryPoint::detectFrameworkPath(), DIRECTORY_SEPARATOR, DIRECTORY_SEPARATOR, DIRECTORY_SEPARATOR)));
241 self::loadInclude(new SplFileInfo(sprintf('%sconfig%sclass_FrameworkConfiguration.php', ApplicationEntryPoint::detectFrameworkPath(), DIRECTORY_SEPARATOR)));
243 // Load global configuration
244 self::loadInclude(new SplFileInfo(sprintf('%s%s', ApplicationEntryPoint::detectFrameworkPath(), 'config-global.php')));
248 * Initializes the framework by scanning for all framework-relevant
249 * classes, interfaces and exception. Then determine the request type and
250 * initialize a Requestable instance which will then contain all request
251 * parameter, also from CLI. Next step is to validate the application
256 public static function initFramework () {
258 * 1) Load class loader and scan framework classes, interfaces and
261 self::scanFrameworkClasses();
264 * 2) Determine the request type, console or web and store request and
265 * response here. This also initializes the request instance will
266 * all given parameters (see doc-tag for possible sources of
269 self::determineRequestType();
272 * 3) Now, that there are all request parameters being available, check
273 * if 'application' is supplied. If it is not found, abort execution, if
274 * found, continue below with next step.
276 self::validateApplicationParameter();
280 * Initializes the detected application. This may fail if required files
281 * are not found in the application's base path (not to be confused with
282 * 'application_base_path' which only points to /some/foo/application/.
286 public static function prepareApplication () {
287 // Configuration entry 'detected_app_name' must be set, get it here, including full path
288 $application = self::getConfigurationInstance()->getConfigEntry('detected_app_name');
289 $fullPath = self::getConfigurationInstance()->getConfigEntry('detected_full_app_path');
292 * Now check and load all files, found deprecated files will throw a
293 * warning at the user.
295 foreach (self::$configAppIncludes as $fileName => $status) {
296 // Construct file instance
297 $fileInstance = new SplFileInfo(sprintf('%s%s.php', $fullPath, $fileName));
299 // Determine if this file is wanted/readable/deprecated
300 if (($status == 'required') && (!self::isReadableFile($fileInstance))) {
301 // Nope, required file cannot be found/read from
302 ApplicationEntryPoint::exitApplication(sprintf('Application "%s" does not have required file "%s.php". Please add it.', $application, $fileInstance->getBasename()));
303 } elseif (($fileInstance->isFile()) && (!$fileInstance->isReadable())) {
304 // Found, not readable file
305 ApplicationEntryPoint::exitApplication(sprintf('File "%s.php" from application "%s" cannot be read. Please fix CHMOD.', $fileInstance->getBasename(), $application));
306 } elseif (($status != 'required') && (!self::isReadableFile($fileInstance))) {
307 // Not found but optional/deprecated file, skip it
311 // Is the file deprecated?
312 if ($status == 'deprecated') {
314 trigger_error(sprintf('Deprecated file "%s.php" found, will not load it to avoid problems. Please remove it from your application "%s" to avoid this warning.', $fileName, $application), E_USER_WARNING);
316 // Skip loading deprecated file
321 self::loadInclude($fileInstance);
324 // Scan for application's classes, exceptions and interfaces
325 ClassLoader::scanApplicationClasses();
329 * Starts a fully initialized application, the class ApplicationHelper must
330 * be loaded at this point.
334 public static function startApplication () {
335 // Configuration entry 'detected_app_name' must be set, get it here
336 $application = self::getConfigurationInstance()->getConfigEntry('detected_app_name');
338 // Is there an application helper instance?
339 $applicationInstance = call_user_func_array(
341 'Org\Mxchange\CoreFramework\Helper\Application\ApplicationHelper', 'getSelfInstance'
345 // Some sanity checks
346 if ((empty($applicationInstance)) || (is_null($applicationInstance))) {
347 // Something went wrong!
348 ApplicationEntryPoint::exitApplication(sprintf('[Main:] The application <span class="app_name">%s</span> could not be launched because the helper class <span class="class_name">%s</span> is not loaded.',
350 'Org\Mxchange\CoreFramework\Helper\Application\ApplicationHelper'
352 } elseif (!is_object($applicationInstance)) {
354 ApplicationEntryPoint::exitApplication(sprintf('[Main:] The application <span class="app_name">%s</span> could not be launched because 'app' is not an object (%s).',
356 gettype($applicationInstance)
358 } elseif (!($applicationInstance instanceof ManageableApplication)) {
360 ApplicationEntryPoint::exitApplication(sprintf('[Main:] The application <span class="app_name">%s</span> could not be launched because 'app' is lacking required interface ManageableApplication.',
365 // Now call all methods in one go
366 foreach (array('setupApplicationData', 'initApplication', 'launchApplication') as $methodName) {
368 //*NOISY-DEBUG: */ printf('[%s:%d]: Calling methodName=%s ...' . PHP_EOL, __METHOD__, __LINE__, $methodName);
371 call_user_func(array($applicationInstance, $methodName));
376 * Initializes database instance, no need to double-call this method
380 public static function initDatabaseInstance () {
381 // Get application instance
382 $applicationInstance = ApplicationHelper::getSelfInstance();
384 // Is the database instance already set?
385 if (self::getDatabaseInstance() instanceof DatabaseConnector) {
386 // Yes, then abort here
387 throw new BadMethodCallException('Method called twice.');
390 // Initialize database layer
391 $databaseInstance = ObjectFactory::createObjectByConfiguredName(self::getConfigurationInstance()->getConfigEntry('database_type') . '_class');
393 // Prepare database instance
394 $connectionInstance = DatabaseConnection::createDatabaseConnection(DebugMiddleware::getSelfInstance(), $databaseInstance);
396 // Set it in application helper
397 self::setDatabaseInstance($connectionInstance);
401 * Detects the server address (SERVER_ADDR) and set it in configuration
403 * @return $serverAddress The detected server address
404 * @throws UnknownHostnameException If SERVER_NAME cannot be resolved to an IP address
405 * @todo Have to check some more entries from $_SERVER here
407 public static function detectServerAddress () {
409 if (!isset(self::$serverAddress)) {
410 // Is it set in $_SERVER?
411 if (!empty($_SERVER['SERVER_ADDR'])) {
412 // Set it from $_SERVER
413 self::$serverAddress = $_SERVER['SERVER_ADDR'];
414 } elseif (isset($_SERVER['SERVER_NAME'])) {
415 // Resolve IP address
416 $serverIp = ConsoleTools::resolveIpAddress($_SERVER['SERVER_NAME']);
419 if ($serverIp === false) {
421 * Why is gethostbyname() returning the host name and not
422 * false as many other PHP functions are doing? ;-(
424 throw new UnknownHostnameException(sprintf('Cannot resolve "%s" to an IP address. Please fix your setup.', $_SERVER['SERVER_NAME']));
428 self::$serverAddress = $serverIp;
430 // Run auto-detecting through console tools lib
431 self::$serverAddress = ConsoleTools::acquireSelfIpAddress();
436 return self::$serverAddress;
440 * Setter for default time zone (must be correct!)
442 * @param $timezone The timezone string (e.g. Europe/Berlin)
443 * @return $success If timezone was accepted
444 * @throws NullPointerException If $timezone is NULL
445 * @throws InvalidArgumentException If $timezone is empty
447 public static function setDefaultTimezone ($timezone) {
449 if (is_null($timezone)) {
451 throw new NullPointerException(NULL, BaseFrameworkSystem::EXCEPTION_IS_NULL_POINTER);
452 } elseif (!is_string($timezone)) {
454 throw new InvalidArgumentException(sprintf('timezone[]=%s is not a string', gettype($timezone)));
455 } elseif ((is_string($timezone)) && (empty($timezone))) {
457 throw new InvalidArgumentException('timezone is empty');
464 * Set desired time zone to prevent date() and related functions to
465 * issue an E_WARNING.
467 $success = date_default_timezone_set($timezone);
474 * Checks whether HTTPS is set in $_SERVER
476 * @return $isset Whether HTTPS is set
477 * @todo Test more fields
479 public static function isHttpSecured () {
480 return (isset($_SERVER['HTTPS']));
484 * Dectect and return the base URL for all URLs and forms
486 * @return $baseUrl Detected base URL
488 public static function detectBaseUrl () {
489 // Initialize the URL
493 if (self::isHttpSecured()) {
494 // Add the >s< for HTTPS
498 // Construct the full URL and secure it against CSRF attacks
499 $baseUrl = sprintf('%s://%s%s', $protocol, self::detectDomain(), self::detectScriptPath());
506 * Detect safely and return the full domain where this script is installed
508 * @return $fullDomain The detected full domain
510 public static function detectDomain () {
511 // Full domain is localnet.invalid by default
512 $fullDomain = 'localnet.invalid';
514 // Is the server name there?
515 if (isset($_SERVER['SERVER_NAME'])) {
516 // Detect the full domain
517 $fullDomain = htmlentities(strip_tags($_SERVER['SERVER_NAME']), ENT_QUOTES);
525 * Detect safely the script path without trailing slash which is the glue
526 * between "http://your-domain.invalid/" and "script-name.php"
528 * @return $scriptPath The script path extracted from $_SERVER['SCRIPT_NAME']
530 public static function detectScriptPath () {
534 // Is the scriptname set?
535 if (isset($_SERVER['SCRIPT_NAME'])) {
536 // Get dirname from it and replace back-slashes with slashes for lame OSes...
537 $scriptPath = str_replace("\\", '/', dirname($_SERVER['SCRIPT_NAME']));
545 * 1) Loads class scanner and scans all framework's classes and interfaces.
546 * This method also registers the class loader's method autoLoad() for the
547 * SPL auto-load feature. Remember that you can register additional methods
548 * (not functions, please) for other libraries.
550 * Yes, I know about Composer, but I like to keep my class loader around.
551 * You can always use mine as long as your classes have a namespace
552 * according naming-convention: Vendor\Project\Group[\SubGroup]
556 private static function scanFrameworkClasses () {
557 // Include the class loader function
558 require self::getConfigurationInstance()->getConfigEntry('framework_base_path') . 'loader/class_ClassLoader.php';
560 // Register auto-load function with the SPL
561 spl_autoload_register('Org\Mxchange\CoreFramework\Loader\ClassLoader::autoLoad');
563 // Scan for all framework classes, exceptions and interfaces
564 ClassLoader::scanFrameworkClasses();
568 * 2) Determines request/response type and stores the created
569 * request/response instances in this object for later usage.
573 private static function determineRequestType () {
574 // Determine request type
575 $request = self::getRequestTypeFromSystem();
576 $requestType = self::getRequestTypeFromSystem();
578 // Create a new request object
579 $requestInstance = ObjectFactory::createObjectByName(sprintf('Org\Mxchange\CoreFramework\Request\%sRequest', BaseFrameworkSystem::convertToClassName($request)));
581 // Remember request instance here
582 self::setRequestInstance($requestInstance);
584 // Do we have another response?
585 if ($requestInstance->isRequestElementSet('request')) {
587 $request = strtolower($requestInstance->getRequestElement('request'));
588 $requestType = $request;
591 // ... and a new response object
592 $responseClass = sprintf('Org\Mxchange\CoreFramework\Response\%sResponse', BaseFrameworkSystem::convertToClassName($request));
593 $responseInstance = ObjectFactory::createObjectByName($responseClass);
595 // Remember response instance here
596 self::setResponseInstance($responseInstance);
600 * 3) Validate parameter 'application' if it is set and the application is there.
604 private static function validateApplicationParameter () {
605 // Is the parameter set?
606 if (!self::getRequestInstance()->isRequestElementSet('app')) {
608 * Don't continue here, the application 'selector' is no longer
609 * supported and only existed as an idea to select the proper
610 * application (by user).
612 ApplicationEntryPoint::exitApplication('No application specified. Please provide a parameter "app" and retry.');
615 // Get it for local usage
616 $application = self::getRequestInstance()->getRequestElement('app');
618 // Secure it, by keeping out tags
619 $application = htmlentities(strip_tags($application), ENT_QUOTES);
621 // Secure it a little more with a reg.exp.
622 $application = preg_replace('/([^a-z0-9_-])+/i', '', $application);
624 // Construct FQPN (Full-Qualified Path Name) for ApplicationHelper class
625 $applicationPath = sprintf(
627 self::getConfigurationInstance()->getConfigEntry('application_base_path'),
632 // Full path for application
633 // Is the path there? This secures a bit the parameter (from untrusted source).
634 if ((!is_dir($applicationPath)) || (!is_readable($applicationPath))) {
635 // Not found or not readable
636 ApplicationEntryPoint::exitApplication(sprintf('Application "%s" not found.', $application));
639 // Set the detected application's name and full path for later usage
640 self::getConfigurationInstance()->setConfigEntry('detected_full_app_path', $applicationPath);
641 self::getConfigurationInstance()->setConfigEntry('detected_app_name' , $application);
645 * Getter for request instance
647 * @return $requestInstance An instance of a Requestable class
649 public static function getRequestInstance () {
650 return self::$requestInstance;
654 * Getter for response instance
656 * @return $responseInstance An instance of a Responseable class
658 public static function getResponseInstance () {
659 return self::$responseInstance;
663 * Setter for request instance
665 * @param $requestInstance An instance of a Requestable class
668 private static function setRequestInstance (Requestable $requestInstance) {
669 self::$requestInstance = $requestInstance;
673 * Setter for response instance
675 * @param $responseInstance An instance of a Responseable class
678 private static function setResponseInstance (Responseable $responseInstance) {
679 self::$responseInstance = $responseInstance;
683 * Setter for database instance
685 * @param $databaseInstance An instance of a DatabaseConnection class
688 public static function setDatabaseInstance (DatabaseConnection $databaseInstance) {
689 self::$databaseInstance = $databaseInstance;
693 * Getter for database instance
695 * @return $databaseInstance An instance of a DatabaseConnection class
697 public static function getDatabaseInstance () {
699 return self::$databaseInstance;