framework/bootstrap/class_FrameworkBootstrap.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Bootstrap;
   4
   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;
  21 use Org\Mxchange\CoreFramework\Utils\String\StringUtils;
  22
  23 // Import SPL stuff
  24 use \BadMethodCallException;
  25 use \InvalidArgumentException;
  26 use \SplFileInfo;
  27
  28 /**
  29  * A framework-bootstrap class which helps the frameworks to bootstrap ... ;-)
  30  *
  31  * @author              Roland Haeder <webmaster@ship-simu.org>
  32  * @version             0.0.0
  33  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2020 Core Developer Team
  34  * @license             GNU GPL 3.0 or any newer version
  35  * @link                http://www.ship-simu.org
  36  *
  37  * This program is free software: you can redistribute it and/or modify
  38  * it under the terms of the GNU General Public License as published by
  39  * the Free Software Foundation, either version 3 of the License, or
  40  * (at your option) any later version.
  41  *
  42  * This program is distributed in the hope that it will be useful,
  43  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  44  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  45  * GNU General Public License for more details.
  46  *
  47  * You should have received a copy of the GNU General Public License
  48  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  49  */
  50 final class FrameworkBootstrap {
  51
  52         /**
  53          * Detected server address
  54          */
  55         private static $serverAddress = NULL;
  56
  57         /**
  58          * Instance of a Requestable class
  59          */
  60         private static $requestInstance = NULL;
  61
  62         /**
  63          * Instance of a Responseable class
  64          */
  65         private static $responseInstance = NULL;
  66
  67         /**
  68          * Instance of a FrameworkConfiguration class
  69          */
  70         private static $configurationInstance = NULL;
  71
  72         /**
  73          * Database instance
  74          */
  75         private static $databaseInstance = NULL;
  76
  77         /*
  78          * Includes applications may have. They will be tried in the given order,
  79          * some will become soon deprecated.
  80          */
  81         private static $configAppIncludes = array(
  82                 // The ApplicationHelper class (required)
  83                 'class_ApplicationHelper' => 'required',
  84                 // Some debugging stuff (optional but can be committed)
  85                 'debug'                   => 'optional',
  86                 // Application's exception handler (optional but can be committed)
  87                 'exceptions'              => 'optional',
  88                 // Application's configuration file (committed, non-local specific)
  89                 'config'                  => 'required',
  90                 // Local configuration file (optional, not committed, listed in .gitignore)
  91                 'config-local'            => 'optional',
  92                 // Application data (deprecated)
  93                 'data'                    => 'deprecated',
  94                 // Application loader (deprecated)
  95                 'loader'                  => 'deprecated',
  96                 // Application initializer (deprecated)
  97                 'init'                    => 'deprecated',
  98                 // Application starter (deprecated)
  99                 'starter'                 => 'deprecated',
 100         );
 101
 102         /**
 103          * Private constructor, no instance is needed from this class as only
 104          * static methods exist.
 105          */
 106         private function __construct () {
 107                 // Prevent making instances from this "utilities" class
 108         }
 109
 110         /**
 111          * Some "getter" for a configuration instance, making sure, it is unique
 112          *
 113          * @return      $configurationInstance  An instance of a FrameworkConfiguration class
 114          */
 115         public static function getConfigurationInstance () {
 116                 // Is the instance there?
 117                 if (is_null(self::$configurationInstance)) {
 118                         // Init new instance
 119                         self::$configurationInstance = new FrameworkConfiguration();
 120                 } // END - if
 121
 122                 // Return it
 123                 return self::$configurationInstance;
 124         }
 125
 126         /**
 127          * "Getter" to get response/request type from analysis of the system.
 128          *
 129          * @return      $requestType    Analyzed request type
 130          */
 131         public static function getRequestTypeFromSystem () {
 132                 // Default is console
 133                 $requestType = 'console';
 134
 135                 // Is 'HTTP_HOST' set?
 136                 if (isset($_SERVER['HTTP_HOST'])) {
 137                         // Then it is a HTML response/request.
 138                         $requestType = 'html';
 139                 } // END - if
 140
 141                 // Return it
 142                 return $requestType;
 143         }
 144
 145         /**
 146          * Checks whether the given file/path is in open_basedir(). This does not
 147          * gurantee that the file is actually readable and/or writeable. If you need
 148          * such gurantee then please use isReadableFile() instead.
 149          *
 150          * @param       $fileInstance   An instance of a SplFileInfo class
 151          * @return      $isReachable    Whether it is within open_basedir()
 152          */
 153         public static function isReachableFilePath (SplFileInfo $fileInstance) {
 154                 // Is not reachable by default
 155                 $isReachable = false;
 156
 157                 // Get open_basedir parameter
 158                 $openBaseDir = trim(ini_get('open_basedir'));
 159
 160                 // Is it set?
 161                 if (!empty($openBaseDir)) {
 162                         // Check all entries
 163                         foreach (explode(PATH_SEPARATOR, $openBaseDir) as $dir) {
 164                                 // Check on existence
 165                                 if (substr($fileInstance->getPathname(), 0, strlen($dir)) == $dir) {
 166                                         // Is reachable
 167                                         $isReachable = true;
 168
 169                                         // Abort lookup as it has been found in open_basedir
 170                                         break;
 171                                 } // END - if
 172                         } // END - foreach
 173                 } else {
 174                         // If open_basedir is not set, all is allowed
 175                         $isReachable = true;
 176                 }
 177
 178                 // Return status
 179                 return $isReachable;
 180         }
 181
 182         /**
 183          * Checks whether the give file is within open_basedir() (done by
 184          * isReachableFilePath()), is actually a file and is readable.
 185          *
 186          * @param       $fileInstance   An instance of a SplFileInfo class
 187          * @return      $isReadable             Whether the file is readable (and therefor exists)
 188          */
 189         public static function isReadableFile (SplFileInfo $fileInstance) {
 190                 // Default is not readable
 191                 $isReadable = false;
 192
 193                 // Check if it is a file and readable
 194                 $isReadable = (
 195                         (
 196                                 self::isReachableFilePath($fileInstance)
 197                         ) && (
 198                                 $fileInstance->isFile()
 199                         ) && (
 200                                 $fileInstance->isReadable()
 201                         )
 202                 );
 203
 204                 // Return status
 205                 return $isReadable;
 206         }
 207
 208         /**
 209          * Loads given include file
 210          *
 211          * @param       $fileInstance   An instance of a SplFileInfo class
 212          * @return      void
 213          * @throws      InvalidArgumentException        If file was not found or not readable or deprecated
 214          */
 215         public static function loadInclude (SplFileInfo $fileInstance) {
 216                 // Trace message
 217                 //* NOISY-DEBUG: */ printf('[%s:%d]: fileInstance=%s - CALLED!' . PHP_EOL, __METHOD__, __LINE__, $fileInstance);
 218
 219                 // Should be there ...
 220                 if (!self::isReadableFile($fileInstance)) {
 221                         // Abort here
 222                         throw new InvalidArgumentException(sprintf('Cannot find fileInstance.pathname=%s.', $fileInstance->getPathname()));
 223                 } // END - if
 224
 225                 // Load it
 226                 require_once $fileInstance->getPathname();
 227
 228                 // Trace message
 229                 //* NOISY-DEBUG: */ printf('[%s:%d]: EXIT!' . PHP_EOL, __METHOD__, __LINE__);
 230         }
 231
 232         /**
 233          * Does the actual bootstrap
 234          *
 235          * @return      void
 236          */
 237         public static function doBootstrap () {
 238                 // Load basic include files to continue bootstrapping
 239                 self::loadInclude(new SplFileInfo(sprintf('%smain%sinterfaces%sclass_FrameworkInterface.php', ApplicationEntryPoint::detectFrameworkPath(), DIRECTORY_SEPARATOR, DIRECTORY_SEPARATOR)));
 240                 self::loadInclude(new SplFileInfo(sprintf('%smain%sclasses%sclass_BaseFrameworkSystem.php', ApplicationEntryPoint::detectFrameworkPath(), DIRECTORY_SEPARATOR, DIRECTORY_SEPARATOR)));
 241                 self::loadInclude(new SplFileInfo(sprintf('%smain%sclasses%sutils%sstring%sclass_StringUtils.php', ApplicationEntryPoint::detectFrameworkPath(), DIRECTORY_SEPARATOR, DIRECTORY_SEPARATOR, DIRECTORY_SEPARATOR, DIRECTORY_SEPARATOR)));
 242                 self::loadInclude(new SplFileInfo(sprintf('%smain%sinterfaces%sregistry%sclass_Registerable.php', ApplicationEntryPoint::detectFrameworkPath(), DIRECTORY_SEPARATOR, DIRECTORY_SEPARATOR, DIRECTORY_SEPARATOR)));
 243                 self::loadInclude(new SplFileInfo(sprintf('%sconfig%sclass_FrameworkConfiguration.php', ApplicationEntryPoint::detectFrameworkPath(), DIRECTORY_SEPARATOR)));
 244
 245                 // Load global configuration
 246                 self::loadInclude(new SplFileInfo(sprintf('%s%s', ApplicationEntryPoint::detectFrameworkPath(), 'config-global.php')));
 247         }
 248
 249         /**
 250          * Initializes the framework by scanning for all framework-relevant
 251          * classes, interfaces and exception. Then determine the request type and
 252          * initialize a Requestable instance which will then contain all request
 253          * parameter, also from CLI. Next step is to validate the application
 254          * (very basic).
 255          *
 256          * @return      void
 257          */
 258         public static function initFramework () {
 259                 /**
 260                  * 1) Load class loader and scan framework classes, interfaces and
 261                  *    exceptions.
 262                  */
 263                 self::scanFrameworkClasses();
 264
 265                 /*
 266                  * 2) Determine the request type, console or web and store request and
 267                  *    response here. This also initializes the request instance will
 268                  *    all given parameters (see doc-tag for possible sources of
 269                  *    parameters).
 270                  */
 271                 self::determineRequestType();
 272
 273                 /*
 274                  * 3) Now, that there are all request parameters being available, check
 275                  *    if 'application' is supplied. If it is not found, abort execution, if
 276                  *    found, continue below with next step.
 277                  */
 278                 self::validateApplicationParameter();
 279         }
 280
 281         /**
 282          * Initializes the detected application. This may fail if required files
 283          * are not found in the application's base path (not to be confused with
 284          * 'application_base_path' which only points to /some/foo/application/.
 285          *
 286          * @return      void
 287          */
 288         public static function prepareApplication () {
 289                 // Configuration entry 'detected_app_name' must be set, get it here, including full path
 290                 $application = self::getConfigurationInstance()->getConfigEntry('detected_app_name');
 291                 $fullPath    = self::getConfigurationInstance()->getConfigEntry('detected_full_app_path');
 292
 293                 /*
 294                  * Now check and load all files, found deprecated files will throw a
 295                  * warning at the user.
 296                  */
 297                 foreach (self::$configAppIncludes as $fileName => $status) {
 298                         // Construct file instance
 299                         $fileInstance = new SplFileInfo(sprintf('%s%s.php', $fullPath, $fileName));
 300
 301                         // Determine if this file is wanted/readable/deprecated
 302                         if (($status == 'required') && (!self::isReadableFile($fileInstance))) {
 303                                 // Nope, required file cannot be found/read from
 304                                 ApplicationEntryPoint::exitApplication(sprintf('Application "%s" does not have required file "%s.php". Please add it.', $application, $fileInstance->getBasename()));
 305                         } elseif (($fileInstance->isFile()) && (!$fileInstance->isReadable())) {
 306                                 // Found, not readable file
 307                                 ApplicationEntryPoint::exitApplication(sprintf('File "%s.php" from application "%s" cannot be read. Please fix CHMOD.', $fileInstance->getBasename(), $application));
 308                         } elseif (($status != 'required') && (!self::isReadableFile($fileInstance))) {
 309                                 // Not found but optional/deprecated file, skip it
 310                                 continue;
 311                         }
 312
 313                         // Is the file deprecated?
 314                         if ($status == 'deprecated') {
 315                                 // Issue warning
 316                                 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);
 317
 318                                 // Skip loading deprecated file
 319                                 continue;
 320                         } // END - if
 321
 322                         // Load it
 323                         self::loadInclude($fileInstance);
 324                 } // END - foreach
 325
 326                 // Scan for application's classes, exceptions and interfaces
 327                 ClassLoader::scanApplicationClasses();
 328         }
 329
 330         /**
 331          * Starts a fully initialized application, the class ApplicationHelper must
 332          * be loaded at this point.
 333          *
 334          * @return      void
 335          */
 336         public static function startApplication () {
 337                 // Configuration entry 'detected_app_name' must be set, get it here
 338                 $application = self::getConfigurationInstance()->getConfigEntry('detected_app_name');
 339
 340                 // Is there an application helper instance?
 341                 $applicationInstance = call_user_func_array(
 342                         array(
 343                                 'Org\Mxchange\CoreFramework\Helper\Application\ApplicationHelper', 'getSelfInstance'
 344                         ), array()
 345                 );
 346
 347                 // Some sanity checks
 348                 if ((empty($applicationInstance)) || (is_null($applicationInstance))) {
 349                         // Something went wrong!
 350                         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.',
 351                                 $application,
 352                                 'Org\Mxchange\CoreFramework\Helper\Application\ApplicationHelper'
 353                         ));
 354                 } elseif (!is_object($applicationInstance)) {
 355                         // No object!
 356                         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).',
 357                                 $application,
 358                                 gettype($applicationInstance)
 359                         ));
 360                 } elseif (!($applicationInstance instanceof ManageableApplication)) {
 361                         // Missing interface
 362                         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.',
 363                                 $application
 364                         ));
 365                 }
 366
 367                 // Now call all methods in one go
 368                 foreach (array('setupApplicationData', 'initApplication', 'launchApplication') as $methodName) {
 369                         // Debug message
 370                         //*NOISY-DEBUG: */ printf('[%s:%d]: Calling methodName=%s ...' . PHP_EOL, __METHOD__, __LINE__, $methodName);
 371
 372                         // Call method
 373                         call_user_func(array($applicationInstance, $methodName));
 374                 } // END - foreach
 375         }
 376
 377         /**
 378          * Initializes database instance, no need to double-call this method
 379          *
 380          * @return      void
 381          */
 382         public static function initDatabaseInstance () {
 383                 // Get application instance
 384                 $applicationInstance = ApplicationHelper::getSelfInstance();
 385
 386                 // Is the database instance already set?
 387                 if (self::getDatabaseInstance() instanceof DatabaseConnector) {
 388                         // Yes, then abort here
 389                         throw new BadMethodCallException('Method called twice.');
 390                 } // END - if
 391
 392                 // Initialize database layer
 393                 $databaseInstance = ObjectFactory::createObjectByConfiguredName(self::getConfigurationInstance()->getConfigEntry('database_type') . '_class');
 394
 395                 // Prepare database instance
 396                 $connectionInstance = DatabaseConnection::createDatabaseConnection(DebugMiddleware::getSelfInstance(), $databaseInstance);
 397
 398                 // Set it in application helper
 399                 self::setDatabaseInstance($connectionInstance);
 400         }
 401
 402         /**
 403          * Detects the server address (SERVER_ADDR) and set it in configuration
 404          *
 405          * @return      $serverAddress  The detected server address
 406          * @throws      UnknownHostnameException        If SERVER_NAME cannot be resolved to an IP address
 407          * @todo        Have to check some more entries from $_SERVER here
 408          */
 409         public static function detectServerAddress () {
 410                 // Is the entry set?
 411                 if (!isset(self::$serverAddress)) {
 412                         // Is it set in $_SERVER?
 413                         if (!empty($_SERVER['SERVER_ADDR'])) {
 414                                 // Set it from $_SERVER
 415                                 self::$serverAddress = $_SERVER['SERVER_ADDR'];
 416                         } elseif (isset($_SERVER['SERVER_NAME'])) {
 417                                 // Resolve IP address
 418                                 $serverIp = ConsoleTools::resolveIpAddress($_SERVER['SERVER_NAME']);
 419
 420                                 // Is it valid?
 421                                 if ($serverIp === false) {
 422                                         /*
 423                                          * Why is gethostbyname() returning the host name and not
 424                                          * false as many other PHP functions are doing? ;-(
 425                                          */
 426                                         throw new UnknownHostnameException(sprintf('Cannot resolve "%s" to an IP address. Please fix your setup.', $_SERVER['SERVER_NAME']));
 427                                 } // END - if
 428
 429                                 // Al fine, set it
 430                                 self::$serverAddress = $serverIp;
 431                         } else {
 432                                 // Run auto-detecting through console tools lib
 433                                 self::$serverAddress = ConsoleTools::acquireSelfIpAddress();
 434                         }
 435                 } // END - if
 436
 437                 // Return it
 438                 return self::$serverAddress;
 439         }
 440
 441         /**
 442          * Setter for default time zone (must be correct!)
 443          *
 444          * @param       $timezone       The timezone string (e.g. Europe/Berlin)
 445          * @return      $success        If timezone was accepted
 446          * @throws      NullPointerException    If $timezone is NULL
 447          * @throws      InvalidArgumentException        If $timezone is empty
 448          */
 449         public static function setDefaultTimezone ($timezone) {
 450                 // Is it null?
 451                 if (is_null($timezone)) {
 452                         // Throw NPE
 453                         throw new NullPointerException(NULL, BaseFrameworkSystem::EXCEPTION_IS_NULL_POINTER);
 454                 } elseif (!is_string($timezone)) {
 455                         // Is not a string
 456                         throw new InvalidArgumentException(sprintf('timezone[]=%s is not a string', gettype($timezone)));
 457                 } elseif ((is_string($timezone)) && (empty($timezone))) {
 458                         // Entry is empty
 459                         throw new InvalidArgumentException('timezone is empty');
 460                 }
 461
 462                 // Default success
 463                 $success = FALSE;
 464
 465                 /*
 466                  * Set desired time zone to prevent date() and related functions to
 467                  * issue an E_WARNING.
 468                  */
 469                 $success = date_default_timezone_set($timezone);
 470
 471                 // Return status
 472                 return $success;
 473         }
 474
 475         /**
 476          * Checks whether HTTPS is set in $_SERVER
 477          *
 478          * @return      $isset  Whether HTTPS is set
 479          * @todo        Test more fields
 480          */
 481         public static function isHttpSecured () {
 482                 return (
 483                         (
 484                                 (
 485                                         isset($_SERVER['HTTPS'])
 486                                 ) && (
 487                                         strtolower($_SERVER['HTTPS']) == 'on'
 488                                 )
 489                         ) || (
 490                                 (
 491                                         isset($_SERVER['HTTP_X_FORWARDED_PROTO'])
 492                                 ) && (
 493                                         strtolower($_SERVER['HTTP_X_FORWARDED_PROTO']) == 'https'
 494                                 )
 495                         )
 496                 );
 497         }
 498
 499         /**
 500          * Dectect and return the base URL for all URLs and forms
 501          *
 502          * @return      $baseUrl        Detected base URL
 503          */
 504         public static function detectBaseUrl () {
 505                 // Initialize the URL
 506                 $protocol = 'http';
 507
 508                 // Do we have HTTPS?
 509                 if (self::isHttpSecured()) {
 510                         // Add the >s< for HTTPS
 511                         $protocol = 'https';
 512                 } // END - if
 513
 514                 // Construct the full URL and secure it against CSRF attacks
 515                 $baseUrl = sprintf('%s://%s%s', $protocol, self::detectDomain(), self::detectScriptPath());
 516
 517                 // Return the URL
 518                 return $baseUrl;
 519         }
 520
 521         /**
 522          * Detect safely and return the full domain where this script is installed
 523          *
 524          * @return      $fullDomain             The detected full domain
 525          */
 526         public static function detectDomain () {
 527                 // Full domain is localnet.invalid by default
 528                 $fullDomain = 'localnet.invalid';
 529
 530                 // Is the server name there?
 531                 if (isset($_SERVER['SERVER_NAME'])) {
 532                         // Detect the full domain
 533                         $fullDomain = htmlentities(strip_tags($_SERVER['SERVER_NAME']), ENT_QUOTES);
 534                 } // END - if
 535
 536                 // Return it
 537                 return $fullDomain;
 538         }
 539
 540         /**
 541          * Detect safely the script path without trailing slash which is the glue
 542          * between "http://your-domain.invalid/" and "script-name.php"
 543          *
 544          * @return      $scriptPath             The script path extracted from $_SERVER['SCRIPT_NAME']
 545          */
 546         public static function detectScriptPath () {
 547                 // Default is empty
 548                 $scriptPath = '';
 549
 550                 // Is the scriptname set?
 551                 if (isset($_SERVER['SCRIPT_NAME'])) {
 552                         // Get dirname from it and replace back-slashes with slashes for lame OSes...
 553                         $scriptPath = str_replace("\\", '/', dirname($_SERVER['SCRIPT_NAME']));
 554                 } // END - if
 555
 556                 // Return it
 557                 return $scriptPath;
 558         }
 559
 560         /**
 561          * 1) Loads class scanner and scans all framework's classes and interfaces.
 562          * This method also registers the class loader's method autoLoad() for the
 563          * SPL auto-load feature. Remember that you can register additional methods
 564          * (not functions, please) for other libraries.
 565          *
 566          * Yes, I know about Composer, but I like to keep my class loader around.
 567          * You can always use mine as long as your classes have a namespace
 568          * according naming-convention: Vendor\Project\Group[\SubGroup]
 569          *
 570          * @return      void
 571          */
 572         private static function scanFrameworkClasses () {
 573                 // Include the class loader function
 574                 require self::getConfigurationInstance()->getConfigEntry('framework_base_path') . 'loader/class_ClassLoader.php';
 575
 576                 // Register auto-load function with the SPL
 577                 spl_autoload_register('Org\Mxchange\CoreFramework\Loader\ClassLoader::autoLoad');
 578
 579                 // Scan for all framework classes, exceptions and interfaces
 580                 ClassLoader::scanFrameworkClasses();
 581         }
 582
 583         /**
 584          * 2) Determines request/response type and stores the created
 585          * request/response instances in this object for later usage.
 586          *
 587          * @return      void
 588          */
 589         private static function determineRequestType () {
 590                 // Determine request type
 591                 $request = self::getRequestTypeFromSystem();
 592                 $requestType = self::getRequestTypeFromSystem();
 593
 594                 // Create a new request object
 595                 $requestInstance = ObjectFactory::createObjectByName(sprintf('Org\Mxchange\CoreFramework\Request\%sRequest', StringUtils::convertToClassName($request)));
 596
 597                 // Remember request instance here
 598                 self::setRequestInstance($requestInstance);
 599
 600                 // Do we have another response?
 601                 if ($requestInstance->isRequestElementSet('request')) {
 602                         // Then use it
 603                         $request = strtolower($requestInstance->getRequestElement('request'));
 604                         $requestType = $request;
 605                 } // END - if
 606
 607                 // ... and a new response object
 608                 $responseClass = sprintf('Org\Mxchange\CoreFramework\Response\%sResponse', StringUtils::convertToClassName($request));
 609                 $responseInstance = ObjectFactory::createObjectByName($responseClass);
 610
 611                 // Remember response instance here
 612                 self::setResponseInstance($responseInstance);
 613         }
 614
 615         /**
 616          * 3) Validate parameter 'application' if it is set and the application is there.
 617          *
 618          * @return      void
 619          */
 620         private static function validateApplicationParameter () {
 621                 // Is the parameter set?
 622                 if (!self::getRequestInstance()->isRequestElementSet('app')) {
 623                         /*
 624                          * Don't continue here, the application 'selector' is no longer
 625                          * supported and only existed as an idea to select the proper
 626                          * application (by user).
 627                          */
 628                         ApplicationEntryPoint::exitApplication('No application specified. Please provide a parameter "app" and retry.');
 629                 } // END - if
 630
 631                 // Get it for local usage
 632                 $application = self::getRequestInstance()->getRequestElement('app');
 633
 634                 // Secure it, by keeping out tags
 635                 $application = htmlentities(strip_tags($application), ENT_QUOTES);
 636
 637                 // Secure it a little more with a reg.exp.
 638                 $application = preg_replace('/([^a-z0-9_-])+/i', '', $application);
 639
 640                 // Construct FQPN (Full-Qualified Path Name) for ApplicationHelper class
 641                 $applicationPath = sprintf(
 642                         '%s%s%s',
 643                         self::getConfigurationInstance()->getConfigEntry('application_base_path'),
 644                         $application,
 645                         DIRECTORY_SEPARATOR
 646                 );
 647
 648                 // Full path for application
 649                 // Is the path there? This secures a bit the parameter (from untrusted source).
 650                 if ((!is_dir($applicationPath)) || (!is_readable($applicationPath))) {
 651                         // Not found or not readable
 652                         ApplicationEntryPoint::exitApplication(sprintf('Application "%s" not found.', $application));
 653                 } // END - if
 654
 655                 // Set the detected application's name and full path for later usage
 656                 self::getConfigurationInstance()->setConfigEntry('detected_full_app_path', $applicationPath);
 657                 self::getConfigurationInstance()->setConfigEntry('detected_app_name'     , $application);
 658         }
 659
 660         /**
 661          * Getter for request instance
 662          *
 663          * @return      $requestInstance        An instance of a Requestable class
 664          */
 665         public static function getRequestInstance () {
 666                 return self::$requestInstance;
 667         }
 668
 669         /**
 670          * Getter for response instance
 671          *
 672          * @return      $responseInstance       An instance of a Responseable class
 673          */
 674         public static function getResponseInstance () {
 675                 return self::$responseInstance;
 676         }
 677
 678         /**
 679          * Setter for request instance
 680          *
 681          * @param       $requestInstance        An instance of a Requestable class
 682          * @return      void
 683          */
 684         private static function setRequestInstance (Requestable $requestInstance) {
 685                 self::$requestInstance = $requestInstance;
 686         }
 687
 688         /**
 689          * Setter for response instance
 690          *
 691          * @param       $responseInstance       An instance of a Responseable class
 692          * @return      void
 693          */
 694         private static function setResponseInstance (Responseable $responseInstance) {
 695                 self::$responseInstance = $responseInstance;
 696         }
 697
 698         /**
 699          * Setter for database instance
 700          *
 701          * @param       $databaseInstance       An instance of a DatabaseConnection class
 702          * @return      void
 703          */
 704         public static function setDatabaseInstance (DatabaseConnection $databaseInstance) {
 705                 self::$databaseInstance = $databaseInstance;
 706         }
 707
 708         /**
 709          * Getter for database instance
 710          *
 711          * @return      $databaseInstance       An instance of a DatabaseConnection class
 712          */
 713         public static function getDatabaseInstance () {
 714                 // Return instance
 715                 return self::$databaseInstance;
 716         }
 717
 718 }