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