1<?php 2 3/** 4 * webtrees: online genealogy 5 * Copyright (C) 2019 webtrees development team 6 * This program is free software: you can redistribute it and/or modify 7 * it under the terms of the GNU General Public License as published by 8 * the Free Software Foundation, either version 3 of the License, or 9 * (at your option) any later version. 10 * This program is distributed in the hope that it will be useful, 11 * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 * GNU General Public License for more details. 14 * You should have received a copy of the GNU General Public License 15 * along with this program. If not, see <http://www.gnu.org/licenses/>. 16 */ 17 18declare(strict_types=1); 19 20namespace Fisharebest\Webtrees; 21 22use Closure; 23use ErrorException; 24use Fisharebest\Webtrees\Http\Middleware\BootModules; 25use Fisharebest\Webtrees\Http\Middleware\CheckCsrf; 26use Fisharebest\Webtrees\Http\Middleware\CheckForMaintenanceMode; 27use Fisharebest\Webtrees\Http\Middleware\ClientIp; 28use Fisharebest\Webtrees\Http\Middleware\DoHousekeeping; 29use Fisharebest\Webtrees\Http\Middleware\EmitResponse; 30use Fisharebest\Webtrees\Http\Middleware\HandleExceptions; 31use Fisharebest\Webtrees\Http\Middleware\LoadRoutes; 32use Fisharebest\Webtrees\Http\Middleware\NoRouteFound; 33use Fisharebest\Webtrees\Http\Middleware\PhpEnvironment; 34use Fisharebest\Webtrees\Http\Middleware\ReadConfigIni; 35use Fisharebest\Webtrees\Http\Middleware\Router; 36use Fisharebest\Webtrees\Http\Middleware\UpdateDatabaseSchema; 37use Fisharebest\Webtrees\Http\Middleware\UseCache; 38use Fisharebest\Webtrees\Http\Middleware\UseDatabase; 39use Fisharebest\Webtrees\Http\Middleware\UseDebugbar; 40use Fisharebest\Webtrees\Http\Middleware\UseFilesystem; 41use Fisharebest\Webtrees\Http\Middleware\UseLanguage; 42use Fisharebest\Webtrees\Http\Middleware\UseSession; 43use Fisharebest\Webtrees\Http\Middleware\UseTheme; 44use Fisharebest\Webtrees\Http\Middleware\UseTransaction; 45use Fisharebest\Webtrees\Http\Middleware\BaseUrl; 46use Nyholm\Psr7\Factory\Psr17Factory; 47use Psr\Http\Message\ResponseFactoryInterface; 48use Psr\Http\Message\ServerRequestFactoryInterface; 49use Psr\Http\Message\StreamFactoryInterface; 50use Psr\Http\Message\UploadedFileFactoryInterface; 51use Psr\Http\Message\UriFactoryInterface; 52 53use function app; 54use function error_reporting; 55use function set_error_handler; 56 57/** 58 * Definitions for the webtrees application. 59 */ 60class Webtrees 61{ 62 // The root folder of this installation 63 public const ROOT_DIR = __DIR__ . '/../'; 64 65 // Some code needs a local filesystem, e.g. for caching. 66 public const DATA_DIR = self::ROOT_DIR . 'data/'; 67 68 // Location of the file containing the database connection details. 69 public const CONFIG_FILE = self::ROOT_DIR . 'data/config.ini.php'; 70 71 // Location of the file that triggers maintenance mode. 72 public const OFFLINE_FILE = self::ROOT_DIR . 'data/offline.txt'; 73 74 // Location of our modules. 75 public const MODULES_PATH = 'modules_v4/'; 76 public const MODULES_DIR = self::ROOT_DIR . self::MODULES_PATH; 77 78 // Enable debugging on development builds. 79 public const DEBUG = self::STABILITY !== ''; 80 81 // We want to know about all PHP errors during development, and fewer in production. 82 public const ERROR_REPORTING = self::DEBUG ? E_ALL | E_STRICT | E_NOTICE | E_DEPRECATED : E_ALL; 83 84 // The name of the application. 85 public const NAME = 'webtrees'; 86 87 // Required version of database tables/columns/indexes/etc. 88 public const SCHEMA_VERSION = 43; 89 90 // e.g. "dev", "alpha", "beta", etc. 91 public const STABILITY = 'beta.5'; 92 93 // Version number 94 public const VERSION = '2.0.0' . (self::STABILITY === '' ? '' : '-') . self::STABILITY; 95 96 // Project website. 97 public const URL = 'https://www.webtrees.net/'; 98 99 private const MIDDLEWARE = [ 100 PhpEnvironment::class, 101 EmitResponse::class, 102 ReadConfigIni::class, 103 BaseUrl::class, 104 HandleExceptions::class, 105 ClientIp::class, 106 UseDatabase::class, 107 UseDebugbar::class, 108 UpdateDatabaseSchema::class, 109 UseCache::class, 110 UseFilesystem::class, 111 UseSession::class, 112 UseLanguage::class, 113 CheckForMaintenanceMode::class, 114 UseTheme::class, 115 DoHousekeeping::class, 116 CheckCsrf::class, 117 UseTransaction::class, 118 LoadRoutes::class, 119 BootModules::class, 120 Router::class, 121 NoRouteFound::class, 122 ]; 123 124 /** 125 * Initialise the application. 126 * 127 * @return void 128 */ 129 public function bootstrap(): void 130 { 131 // Show all errors and warnings in development, fewer in production. 132 error_reporting(self::ERROR_REPORTING); 133 134 set_error_handler($this->phpErrorHandler()); 135 } 136 137 /** 138 * An error handler that can be passed to set_error_handler(). 139 * 140 * @return Closure 141 */ 142 private function phpErrorHandler(): Closure 143 { 144 return static function (int $errno, string $errstr, string $errfile, int $errline): bool { 145 // Ignore errors that are silenced with '@' 146 if (error_reporting() & $errno) { 147 throw new ErrorException($errstr, 0, $errno, $errfile, $errline); 148 } 149 150 return true; 151 }; 152 } 153 154 /** 155 * We can use any PSR-7 / PSR-17 compatible message factory. 156 * 157 * @return void 158 */ 159 public function selectMessageFactory(): void 160 { 161 app()->bind(ResponseFactoryInterface::class, Psr17Factory::class); 162 app()->bind(ServerRequestFactoryInterface::class, Psr17Factory::class); 163 app()->bind(StreamFactoryInterface::class, Psr17Factory::class); 164 app()->bind(UploadedFileFactoryInterface::class, Psr17Factory::class); 165 app()->bind(UriFactoryInterface::class, Psr17Factory::class); 166 } 167 168 /** 169 * The webtrees application is built from middleware. 170 * 171 * @return string[] 172 */ 173 public function middleware(): array 174 { 175 return self::MIDDLEWARE; 176 } 177} 178