]> git.mxchange.org Git - core.git/blobdiff - framework/bootstrap/class_FrameworkBootstrap.php
Continued:
[core.git] / framework / bootstrap / class_FrameworkBootstrap.php
index 2af601e0d5971c06195dc2cc9107dbc296153cf5..fb7d036546afdf63443efd202aa74f3fb5244cc3 100644 (file)
@@ -1,27 +1,28 @@
 <?php
 // Own namespace
-namespace CoreFramework\Bootstrap;
+namespace Org\Mxchange\CoreFramework\Bootstrap;
 
 // Import framework stuff
-use CoreFramework\Configuration\FrameworkConfiguration;
-use CoreFramework\Connection\Database\DatabaseConnection;
-use CoreFramework\Connector\Database\DatabaseConnector;
-use CoreFramework\Console\Tools\ConsoleTools;
-use CoreFramework\EntryPoint\ApplicationEntryPoint;
-use CoreFramework\Factory\ObjectFactory;
-use CoreFramework\Generic\NullPointerException;
-use CoreFramework\Helper\Application\ApplicationHelper;
-use CoreFramework\Loader\ClassLoader;
-use CoreFramework\Manager\ManageableApplication;
-use CoreFramework\Middleware\Debug\DebugMiddleware;
-use CoreFramework\Object\BaseFrameworkSystem;
-use CoreFramework\Registry\Registry;
-use CoreFramework\Request\Requestable;
-use CoreFramework\Response\Responseable;
+use Org\Mxchange\CoreFramework\Configuration\FrameworkConfiguration;
+use Org\Mxchange\CoreFramework\Connection\Database\DatabaseConnection;
+use Org\Mxchange\CoreFramework\Connector\Database\DatabaseConnector;
+use Org\Mxchange\CoreFramework\Console\Tools\ConsoleTools;
+use Org\Mxchange\CoreFramework\EntryPoint\ApplicationEntryPoint;
+use Org\Mxchange\CoreFramework\Factory\ObjectFactory;
+use Org\Mxchange\CoreFramework\Generic\NullPointerException;
+use Org\Mxchange\CoreFramework\Helper\Application\ApplicationHelper;
+use Org\Mxchange\CoreFramework\Loader\ClassLoader;
+use Org\Mxchange\CoreFramework\Manager\ManageableApplication;
+use Org\Mxchange\CoreFramework\Middleware\Debug\DebugMiddleware;
+use Org\Mxchange\CoreFramework\Object\BaseFrameworkSystem;
+use Org\Mxchange\CoreFramework\Registry\Registry;
+use Org\Mxchange\CoreFramework\Request\Requestable;
+use Org\Mxchange\CoreFramework\Response\Responseable;
 
 // Import SPL stuff
 use \BadMethodCallException;
 use \InvalidArgumentException;
+use \SplFileInfo;
 
 /**
  * A framework-bootstrap class which helps the frameworks to bootstrap ... ;-)
@@ -62,6 +63,11 @@ final class FrameworkBootstrap {
         */
        private static $responseInstance = NULL;
 
+       /**
+        * Instance of a FrameworkConfiguration class
+        */
+       private static $configurationInstance = NULL;
+
        /*
         * Includes applications may have. They will be tried in the given order,
         * some will become soon deprecated.
@@ -95,6 +101,22 @@ final class FrameworkBootstrap {
                // Prevent making instances from this "utilities" class
        }
 
+       /**
+        * Some "getter" for a configuration instance, making sure, it is unique
+        *
+        * @return      $configurationInstance  An instance of a FrameworkConfiguration class
+        */
+       public static function getConfigurationInstance () {
+               // Is the instance there?
+               if (is_null(self::$configurationInstance)) {
+                       // Init new instance
+                       self::$configurationInstance = new FrameworkConfiguration();
+               } // END - if
+
+               // Return it
+               return self::$configurationInstance;
+       }
+
        /**
         * Getter for request instance
         *
@@ -137,24 +159,27 @@ final class FrameworkBootstrap {
         * gurantee that the file is actually readable and/or writeable. If you need
         * such gurantee then please use isReadableFile() instead.
         *
-        * @param       $filePathName   Name of the file/path to be checked
+        * @param       $fileInstance   An instance of a SplFileInfo class
         * @return      $isReachable    Whether it is within open_basedir()
         */
-       public static function isReachableFilePath ($filePathName) {
+       public static function isReachableFilePath (SplFileInfo $fileInstance) {
                // Is not reachable by default
                $isReachable = false;
 
                // Get open_basedir parameter
-               $openBaseDir = ini_get('open_basedir');
+               $openBaseDir = trim(ini_get('open_basedir'));
 
                // Is it set?
                if (!empty($openBaseDir)) {
                        // Check all entries
                        foreach (explode(PATH_SEPARATOR, $openBaseDir) as $dir) {
                                // Check on existence
-                               if (substr($filePathName, 0, strlen($dir)) == $dir) {
+                               if (substr($fileInstance->getPathname(), 0, strlen($dir)) == $dir) {
                                        // Is reachable
                                        $isReachable = true;
+
+                                       // Abort lookup as it has been found in open_basedir
+                                       break;
                                } // END - if
                        } // END - foreach
                } else {
@@ -170,23 +195,21 @@ final class FrameworkBootstrap {
         * Checks whether the give file is within open_basedir() (done by
         * isReachableFilePath()), is actually a file and is readable.
         *
-        * @param       $fileName               Name of the file to be checked
+        * @param       $fileInstance   An instance of a SplFileInfo class
         * @return      $isReadable             Whether the file is readable (and therefor exists)
         */
-       public static function isReadableFile ($fileName) {
+       public static function isReadableFile (SplFileInfo $fileInstance) {
                // Default is not readable
                $isReadable = false;
 
-               // Is within parameters, so check if it is a file and readable
+               // Check if it is a file and readable
                $isReadable = (
                        (
-                               self::isReachableFilePath($fileName)
-                       ) && (
-                               file_exists($fileName)
+                               self::isReachableFilePath($fileInstance)
                        ) && (
-                               is_file($fileName)
+                               $fileInstance->isFile()
                        ) && (
-                               is_readable($fileName)
+                               $fileInstance->isReadable()
                        )
                );
 
@@ -197,22 +220,22 @@ final class FrameworkBootstrap {
        /**
         * Loads given include file
         *
-        * @param       $fqfn   Include's FQFN
+        * @param       $fileInstance   An instance of a SplFileInfo class
         * @return      void
-        * @throws      InvalidArgumentException        If $fqfn was not found or not readable or deprecated
+        * @throws      InvalidArgumentException        If file was not found or not readable or deprecated
         */
-       public static function loadInclude ($fqfn) {
+       public static function loadInclude (SplFileInfo $fileInstance) {
                // Trace message
-               //* NOISY-DEBUG: */ printf('[%s:%d]: fqfn=%s - CALLED!' . PHP_EOL, __METHOD__, __LINE__, $fqfn);
+               //* NOISY-DEBUG: */ printf('[%s:%d]: fileInstance=%s - CALLED!' . PHP_EOL, __METHOD__, __LINE__, $fileInstance);
 
                // Should be there ...
-               if (!self::isReadableFile($fqfn)) {
+               if (!self::isReadableFile($fileInstance)) {
                        // Abort here
-                       throw new InvalidArgumentException(sprintf('Cannot find fqfn=%s.', $fqfn));
+                       throw new InvalidArgumentException(sprintf('Cannot find fileInstance.pathname=%s.', $fileInstance->getPathname()));
                } // END - if
 
                // Load it
-               require $fqfn;
+               require $fileInstance->getPathname();
 
                // Trace message
                //* NOISY-DEBUG: */ printf('[%s:%d]: EXIT!' . PHP_EOL, __METHOD__, __LINE__);
@@ -225,12 +248,13 @@ final class FrameworkBootstrap {
         */
        public static function doBootstrap () {
                // Load basic include files to continue bootstrapping
-               self::loadInclude(sprintf('%smain%sinterfaces%sclass_FrameworkInterface.php', ApplicationEntryPoint::detectFrameworkPath(), DIRECTORY_SEPARATOR, DIRECTORY_SEPARATOR));
-               self::loadInclude(sprintf('%smain%sinterfaces%sregistry%sclass_Registerable.php', ApplicationEntryPoint::detectFrameworkPath(), DIRECTORY_SEPARATOR, DIRECTORY_SEPARATOR, DIRECTORY_SEPARATOR));
-               self::loadInclude(sprintf('%sconfig%sclass_FrameworkConfiguration.php', ApplicationEntryPoint::detectFrameworkPath(), DIRECTORY_SEPARATOR));
+               self::loadInclude(new SplFileInfo(sprintf('%smain%sinterfaces%sclass_FrameworkInterface.php', ApplicationEntryPoint::detectFrameworkPath(), DIRECTORY_SEPARATOR, DIRECTORY_SEPARATOR)));
+               self::loadInclude(new SplFileInfo(sprintf('%smain%sclasses%sclass_BaseFrameworkSystem.php', ApplicationEntryPoint::detectFrameworkPath(), DIRECTORY_SEPARATOR, DIRECTORY_SEPARATOR)));
+               self::loadInclude(new SplFileInfo(sprintf('%smain%sinterfaces%sregistry%sclass_Registerable.php', ApplicationEntryPoint::detectFrameworkPath(), DIRECTORY_SEPARATOR, DIRECTORY_SEPARATOR, DIRECTORY_SEPARATOR)));
+               self::loadInclude(new SplFileInfo(sprintf('%sconfig%sclass_FrameworkConfiguration.php', ApplicationEntryPoint::detectFrameworkPath(), DIRECTORY_SEPARATOR)));
 
                // Load global configuration
-               self::loadInclude(sprintf('%s%s', ApplicationEntryPoint::detectFrameworkPath(), 'config-global.php'));
+               self::loadInclude(new SplFileInfo(sprintf('%s%s', ApplicationEntryPoint::detectFrameworkPath(), 'config-global.php')));
        }
 
        /**
@@ -274,25 +298,25 @@ final class FrameworkBootstrap {
         */
        public static function prepareApplication () {
                // Configuration entry 'detected_app_name' must be set, get it here, including full path
-               $application = FrameworkConfiguration::getSelfInstance()->getConfigEntry('detected_app_name');
-               $fullPath    = FrameworkConfiguration::getSelfInstance()->getConfigEntry('detected_full_app_path');
+               $application = self::getConfigurationInstance()->getConfigEntry('detected_app_name');
+               $fullPath    = self::getConfigurationInstance()->getConfigEntry('detected_full_app_path');
 
                /*
                 * Now check and load all files, found deprecated files will throw a
                 * warning at the user.
                 */
                foreach (self::$configAppIncludes as $fileName => $status) {
-                       // Construct FQFN
-                       $fqfn = sprintf('%s%s.php', $fullPath, $fileName);
+                       // Construct file instance
+                       $fileInstance = new SplFileInfo(sprintf('%s%s.php', $fullPath, $fileName));
 
                        // Determine if this file is wanted/readable/deprecated
-                       if (($status == 'required') && (!self::isReadableFile($fqfn))) {
+                       if (($status == 'required') && (!self::isReadableFile($fileInstance))) {
                                // Nope, required file cannot be found/read from
-                               ApplicationEntryPoint::exitApplication(sprintf('Application "%s" does not have required file "%s.php". Please add it.', $application, $fileName));
-                       } elseif ((file_exists($fqfn)) && (!is_readable($fqfn))) {
+                               ApplicationEntryPoint::exitApplication(sprintf('Application "%s" does not have required file "%s.php". Please add it.', $application, $fileInstance->getBasename()));
+                       } elseif (($fileInstance->isFile()) && (!$fileInstance->isReadable())) {
                                // Found, not readable file
-                               ApplicationEntryPoint::exitApplication(sprintf('File "%s.php" from application "%s" cannot be read. Please fix CHMOD.', $fileName, $application));
-                       } elseif (($status != 'required') && (!self::isReadableFile($fqfn))) {
+                               ApplicationEntryPoint::exitApplication(sprintf('File "%s.php" from application "%s" cannot be read. Please fix CHMOD.', $fileInstance->getBasename(), $application));
+                       } elseif (($status != 'required') && (!self::isReadableFile($fileInstance))) {
                                // Not found but optional/deprecated file, skip it
                                continue;
                        }
@@ -307,7 +331,7 @@ final class FrameworkBootstrap {
                        } // END - if
 
                        // Load it
-                       self::loadInclude($fqfn);
+                       self::loadInclude($fileInstance);
                } // END - foreach
 
                // Scan for application's classes, exceptions and interfaces
@@ -322,31 +346,31 @@ final class FrameworkBootstrap {
         */
        public static function startApplication () {
                // Configuration entry 'detected_app_name' must be set, get it here
-               $application = FrameworkConfiguration::getSelfInstance()->getConfigEntry('detected_app_name');
+               $application = self::getConfigurationInstance()->getConfigEntry('detected_app_name');
 
                // Is there an application helper instance?
                $applicationInstance = call_user_func_array(
                        array(
-                               'CoreFramework\Helper\Application\ApplicationHelper', 'getSelfInstance'
+                               'Org\Mxchange\CoreFramework\Helper\Application\ApplicationHelper', 'getSelfInstance'
                        ), array()
                );
 
                // Some sanity checks
                if ((empty($applicationInstance)) || (is_null($applicationInstance))) {
                        // Something went wrong!
-                       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.",
+                       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.',
                                $application,
-                               'CoreFramework\Helper\Application\ApplicationHelper'
+                               'Org\Mxchange\CoreFramework\Helper\Application\ApplicationHelper'
                        ));
                } elseif (!is_object($applicationInstance)) {
                        // No object!
-                       ApplicationEntryPoint::exitApplication(sprintf("[Main:] The application <span class=\"app_name\">%s</span> could not be launched because &#39;app&#39; is not an object (%s).",
+                       ApplicationEntryPoint::exitApplication(sprintf('[Main:] The application <span class="app_name">%s</span> could not be launched because &#39;app&#39; is not an object (%s).',
                                $application,
                                gettype($applicationInstance)
                        ));
                } elseif (!($applicationInstance instanceof ManageableApplication)) {
                        // Missing interface
-                       ApplicationEntryPoint::exitApplication(sprintf("[Main:] The application <span class=\"app_name\">%s</span> could not be launched because &#39;app&#39; is lacking required interface ManageableApplication.",
+                       ApplicationEntryPoint::exitApplication(sprintf('[Main:] The application <span class="app_name">%s</span> could not be launched because &#39;app&#39; is lacking required interface ManageableApplication.',
                                $application
                        ));
                }
@@ -361,7 +385,7 @@ final class FrameworkBootstrap {
 
                        // Call method
                        call_user_func(array($applicationInstance, $methodName));
-               } // END - if
+               } // END - foreach
        }
 
        /**
@@ -380,7 +404,7 @@ final class FrameworkBootstrap {
                } // END - if
 
                // Initialize database layer
-               $databaseInstance = ObjectFactory::createObjectByConfiguredName(FrameworkConfiguration::getSelfInstance()->getConfigEntry('database_type') . '_class');
+               $databaseInstance = ObjectFactory::createObjectByConfiguredName(self::getConfigurationInstance()->getConfigEntry('database_type') . '_class');
 
                // Prepare database instance
                $connectionInstance = DatabaseConnection::createDatabaseConnection(DebugMiddleware::getSelfInstance(), $databaseInstance);
@@ -462,25 +486,6 @@ final class FrameworkBootstrap {
                return $success;
        }
 
-       /**
-        * Detects the HTTPS flag
-        *
-        * @return      $https  The detected HTTPS flag or null if failed
-        */
-       public static function detectHttpSecured () {
-               // Default is null
-               $https = NULL;
-
-               // Is HTTPS set?
-               if (self::isHttpSecured()) {
-                       // Then use it
-                       $https = $_SERVER['HTTPS'];
-               } // END - if
-
-               // Return it
-               return $https;
-       }
-
        /**
         * Checks whether HTTPS is set in $_SERVER
         *
@@ -507,7 +512,7 @@ final class FrameworkBootstrap {
                } // END - if
 
                // Construct the full URL and secure it against CSRF attacks
-               $baseUrl = $protocol . '://' . self::detectDomain() . self::detectScriptPath();
+               $baseUrl = sprintf('%s://%s%s', $protocol, self::detectDomain(), self::detectScriptPath());
 
                // Return the URL
                return $baseUrl;
@@ -566,10 +571,10 @@ final class FrameworkBootstrap {
         */
        private static function scanFrameworkClasses () {
                // Include the class loader function
-               require FrameworkConfiguration::getSelfInstance()->getConfigEntry('framework_base_path') . 'loader/class_ClassLoader.php';
+               require self::getConfigurationInstance()->getConfigEntry('framework_base_path') . 'loader/class_ClassLoader.php';
 
                // Register auto-load function with the SPL
-               spl_autoload_register('CoreFramework\Loader\ClassLoader::autoLoad');
+               spl_autoload_register('Org\Mxchange\CoreFramework\Loader\ClassLoader::autoLoad');
 
                // Scan for all framework classes, exceptions and interfaces
                ClassLoader::scanFrameworkClasses();
@@ -587,7 +592,7 @@ final class FrameworkBootstrap {
                $requestType = self::getRequestTypeFromSystem();
 
                // Create a new request object
-               $requestInstance = ObjectFactory::createObjectByName(sprintf('CoreFramework\Request\%sRequest', BaseFrameworkSystem::convertToClassName($request)));
+               $requestInstance = ObjectFactory::createObjectByName(sprintf('Org\Mxchange\CoreFramework\Request\%sRequest', BaseFrameworkSystem::convertToClassName($request)));
 
                // Remember request instance here
                self::setRequestInstance($requestInstance);
@@ -600,7 +605,7 @@ final class FrameworkBootstrap {
                } // END - if
 
                // ... and a new response object
-               $responseClass = sprintf('CoreFramework\Response\%sResponse', BaseFrameworkSystem::convertToClassName($request));
+               $responseClass = sprintf('Org\Mxchange\CoreFramework\Response\%sResponse', BaseFrameworkSystem::convertToClassName($request));
                $responseInstance = ObjectFactory::createObjectByName($responseClass);
 
                // Remember response instance here
@@ -635,7 +640,7 @@ final class FrameworkBootstrap {
                // Construct FQPN (Full-Qualified Path Name) for ApplicationHelper class
                $applicationPath = sprintf(
                        '%s%s%s',
-                       FrameworkConfiguration::getSelfInstance()->getConfigEntry('application_base_path'),
+                       self::getConfigurationInstance()->getConfigEntry('application_base_path'),
                        $application,
                        DIRECTORY_SEPARATOR
                );
@@ -648,8 +653,8 @@ final class FrameworkBootstrap {
                } // END - if
 
                // Set the detected application's name and full path for later usage
-               FrameworkConfiguration::getSelfInstance()->setConfigEntry('detected_full_app_path', $applicationPath);
-               FrameworkConfiguration::getSelfInstance()->setConfigEntry('detected_app_name'     , $application);
+               self::getConfigurationInstance()->setConfigEntry('detected_full_app_path', $applicationPath);
+               self::getConfigurationInstance()->setConfigEntry('detected_app_name'     , $application);
        }
        /**
         * Setter for request instance