Last commit: Tue Feb 14 00:21:26 2023 +0100	Jan Dankert	Show fatal error messages in the UI notice window.


      <?php
      // OpenRat Content Management System
      // Copyright (C) 2002-2009 Jan Dankert, cms@jandankert.de
      //
      // This program is free software; you can redistribute it and/or
      // modify it under the terms of the GNU General Public License
      // as published by the Free Software Foundation; version 2.
      //
      // This program is distributed in the hope that it will be useful,
     // but WITHOUT ANY WARRANTY; without even the implied warranty of
     // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     // GNU General Public License for more details.
     //
     // You should have received a copy of the GNU General Public License
     // along with this program; if not, write to the Free Software
     // Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
     
     namespace cms\base;
     
     use ErrorException;
     use logger\Logger;
     use util\exception\ValidationException;
     use util\Request;
     use util\Session;
     
     class Startup {
     
         private static $START_TIME;
     
     	const MIN_VERSION = '5.6'; // minimum required PHP version.
     	const API_LEVEL   = '2';   // public API version.
     	const CHARSET     = 'UTF-8'; // Everything is UTF-8.
     
     	const IMG_EXT      = '.gif';
     	const IMG_ICON_EXT = '.png';
     	const FILE_SEP     = '/';
     
     	const HTML_MODULES_DIR = './modules/';
     	const THEMES_DIR       = './modules/cms/ui/themes/';
     	const CSS_PREFIX       = 'or-';
     	const DEFAULT_CONFIG_FILE = __DIR__ . '/../../../config/config.yml';
     	const APP_DIR             = __DIR__ . '/../../../';
     	const MODULE_DIR          = self::APP_DIR .'modules/';
     
     	/**
     	 * This is the application name.
     	 * It can be overwritten in the configuration.
     	 */
     	const TITLE   = 'OpenRat CMS';
     
     	/**
     	 * Version number.
     	 */
     	const VERSION = Version::VERSION;
     
     	/**
     	 * Build date.
     	 */
     	const DATE    = Version::DATE;
     
     	/**
     	 * Initialize.
     	 *
     	 * @throws ErrorException if something happens
     	 */
     	public static function initialize()
     	{
     		self::checkPHPVersion();
     		self::securityCheck();
     		self::setErrorHandler();
     		self::setStartTime();
     		self::checkDatabaseDriver();
     		self::checkMultibyteSupport();
     		self::setCookiePath();
     
     		// in some situations we want to know, if the CMS is really started up.
     		define('APP_STARTED','1');
     	}
     
     
     	/**
     	 * Setting the cookie path.
     	 */
     	protected static function setCookiePath() {
     
     		$scriptPath = dirname($_SERVER['SCRIPT_NAME']);
     
     		if   ( substr($scriptPath,-1 ) != '/' )
     			$scriptPath = $scriptPath.'/'; // Add trailing slash
     
     		// Cookie path
     		define('COOKIE_PATH',$scriptPath);
     	}
     
     
     	/**
     	 * Checking the minimum PHP version.
     	 *
     	 * @throws ErrorException
    	 */
    	protected static function checkPHPVersion()
    	{
    		if (version_compare(phpversion(), self::MIN_VERSION, "<"))
    			throw new ErrorException('This version of PHP ' . phpversion() . ' is not supported any more. Minimum required: ' . self::MIN_VERSION);
    	}
    
    
    	protected static function checkDatabaseDriver() {
    		if (!defined('PDO::ATTR_DRIVER_NAME')) {
    			throw new ErrorException('PDO is not available');
    		}
    	}
    
    
    	protected static function checkMultibyteSupport() {
    
    		if   ( function_exists('mb_substr'          ) &&
    			   function_exists('mb_convert_encoding')    )
    			; // ok, Multibyte is available
    		else
    			throw new ErrorException('Multibyte functions are not available');
    	}
    
    	public static function getStartTime() {
    		return self::$START_TIME;
    	}
    
    
    	protected static function setStartTime() {
    
    		self::$START_TIME = time();
    	}
    
    
    	protected static function setErrorHandler() {
    
    		/**
    		 * Wandelt jeden Fehler in eine ErrorException um.
    		 */
    		$exceptionErrorHandler = function ($severity, $message, $file, $line) {
    			if	( !(error_reporting() & $severity) )
    			{
    				// Dieser Fehlercode ist nicht in error_reporting enthalten
    				return;
    			}
    			throw new ErrorException($message, 0, $severity, $file, $line);
    		};
    
    		set_error_handler($exceptionErrorHandler);
    
    
    		/**
    		 * Ermöglicht das Loggen von Fatal-Errors.
    		 */
    		$fatalHandler = function() {
    
    			$error = error_get_last();
    
    			if( $error )
    			{
    				$errno   = @$error["type"];
    				$errfile = @$error["file"];
    				$errline = @$error["line"];
    				$errstr  = @$error["message"];
    
    				$message = 'Error '.$errno .' '. $errstr.' in '. $errfile.':'. $errline;
    				if(class_exists('logger\Logger'))
    					Logger::error( $message);
    
    				error_log($message);
    
    				// It is not possibile to throw an exception out of a shutdown function!
    				// PHP will exit the request directly after executing this method, so a
    				// Exception would never reach a caller.
    
    				header('HTTP/1.0 503 Internal CMS fatal error');
    				header('Content-Type: text/html; charset=utf-8');
    				echo "<h1>Fatal error</h1><pre id=\"cms-error-log\">$errstr\non line $errline\nin file $errfile</pre><hr />".Startup::TITLE;
    			}
    
    		};
    
    		register_shutdown_function( $fatalHandler );
    
    	}
    
    
    	/**
    	 * Check for some stupid security impacts.
    	 */
    	protected static function securityCheck()
    	{
    		// REGISTER_GLOBALS
    		// This feature has been DEPRECATED as of PHP 5.3.0 and REMOVED as of PHP 5.4.0.
    
    		// MAGIC_QUOTES
    		// This feature has been DEPRECATED as of PHP 5.3.0 and REMOVED as of PHP 5.4.0.
    	}
    
    
    
    	/**
    	 * Stellt fest, ob das System in einem schreibgeschuetzten Zustand ist.
    	 *
    	 * @return boolean true, falls schreibgeschuetzt, sonst false
    	 */
    	public static function readonly() {
    
    		// Gesamtes CMS ist readonly.
    		if (Configuration::subset( ['security'] )->is('readonly',false))
    			return true;
    
    		// Aktuelle Datenbankverbindung ist readonly.
    		//$db = DB::get();
    		$db = Request::getDatabase();
    
    		if ($db && isset($db->conf['readonly']) && $db->conf['readonly'])
    			return true;
    
    		return false;
    	}
    
    
    	/**
    	 * Ermittelt die aktuelle Systemzeit als Unix-Timestamp.<br>
    	 * Unix-Timestamp ist immer bezogen auf GMT.
    	 * -
    	 * @return Unix-Timestamp der aktuellen Zeit
    	 */
    	public static function now()
    	{
    		return time();
    	}
    
    
    }


Download modules/cms/base/Startup.class.php

History
Tue, 14 Feb 2023 00:21:26 +0100	Jan Dankert	Show fatal error messages in the UI notice window.
Fri, 15 Apr 2022 14:51:22 +0200	dankert	Refactoring: User,Config and Database info is now stored in the Request, because so there is no session required for clients which are using Basic Authorization.
Thu, 10 Mar 2022 13:09:06 +0100	dankert	New: Remember some user inputs in the browser local storage.
Mon, 7 Feb 2022 21:44:42 +0100	dankert	New: Authenticate API users with the HTTP authorization header.
Wed, 2 Feb 2022 01:12:42 +0100	dankert	Better support for API requests.
Sun, 30 Jan 2022 23:38:42 +0100	dankert	Refactoring: Only 1 http-endpoint for both the UI and the API. Path "/api" is not available any more, all API data is served under "/".
Tue, 16 Nov 2021 22:34:56 +0100	Jan Dankert	Now required: PHP 5.6 because of concatenating strings with constants while defining a constant.
Thu, 7 Oct 2021 23:54:09 +0200	Jan Dankert	New: Location of config file is able to be overwritten by environment.
Wed, 11 Nov 2020 20:52:26 +0100	Jan Dankert	Fix: Advanced view for folder was broken.
Sun, 1 Nov 2020 00:36:50 +0100	Jan Dankert	Refactoring: Only using the configuration object.
Mon, 26 Oct 2020 16:55:36 +0100	Jan Dankert	Always write fatal error to the standard error log.
Mon, 26 Oct 2020 09:48:01 +0100	Jan Dankert	No trace-output in the API in production mode.
Sat, 24 Oct 2020 17:12:58 +0200	Jan Dankert	Documentation
Fri, 23 Oct 2020 07:47:22 +0200	Jan Dankert	New: Check for necessary modules at startup.
Wed, 21 Oct 2020 23:32:28 +0200	Jan Dankert	Fix: Magic quotes was removed a long time ago.
Wed, 21 Oct 2020 23:13:01 +0200	Jan Dankert	Externalize constants.
Sat, 10 Oct 2020 01:29:41 +0200	Jan Dankert	Refactoring: Only using CSS classes with the 'or-'-prefix.
Mon, 5 Oct 2020 23:32:06 +0200	Jan Dankert	UI: Nicer buttons
Tue, 29 Sep 2020 01:14:17 +0200	Jan Dankert	Fix: now() must be a static function (because it is called static).
Sat, 26 Sep 2020 13:11:23 +0200	Jan Dankert	Refactoring: No global variables any more. All constants are capsulated by classes.
Sat, 26 Sep 2020 12:20:43 +0200	Jan Dankert	Refactoring: No global variables like $SESS  any more. All constants are capsulated by classes.
Sat, 26 Sep 2020 04:26:55 +0200	Jan Dankert	Refactoring: read configuration values with a class.
Sat, 26 Sep 2020 04:03:53 +0200	Jan Dankert	Refactoring: read language keys with a class.
Sat, 26 Sep 2020 03:03:47 +0200	Jan Dankert	Refactoring: less global functions.
Sat, 26 Sep 2020 01:41:20 +0200	Jan Dankert	Refactoring: Removing old require.php files. With class autoloading, they are not necessary any more.