xref: /webtrees/app/Webtrees.php (revision 7ff867dcdca30dc068e32b6a2ce421b753e8df89) 
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\UseLocale;
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;
52use Throwable;
53
54use function app;
55use function dirname;
56use function error_reporting;
57use function ob_end_clean;
58use function ob_get_level;
59use function set_error_handler;
60use function set_exception_handler;
61use function str_replace;
62
63use const PHP_EOL;
64
65/**
66 * Definitions for the webtrees application.
67 */
68class Webtrees
69{
70    // The root folder of this installation
71    public const ROOT_DIR = __DIR__ . '/../';
72
73    // Some code needs a local filesystem, e.g. for caching.
74    public const DATA_DIR = self::ROOT_DIR . 'data/';
75
76    // Location of the file containing the database connection details.
77    public const CONFIG_FILE = self::ROOT_DIR . 'data/config.ini.php';
78
79    // Location of the file that triggers maintenance mode.
80    public const OFFLINE_FILE = self::ROOT_DIR . 'data/offline.txt';
81
82    // Location of our modules.
83    public const MODULES_PATH = 'modules_v4/';
84    public const MODULES_DIR  = self::ROOT_DIR . self::MODULES_PATH;
85
86    // Enable debugging on development builds.
87    public const DEBUG = self::STABILITY !== '';
88
89    // We want to know about all PHP errors during development, and fewer in production.
90    public const ERROR_REPORTING = self::DEBUG ? E_ALL | E_STRICT | E_NOTICE | E_DEPRECATED : E_ALL;
91
92    // The name of the application.
93    public const NAME = 'webtrees';
94
95    // Required version of database tables/columns/indexes/etc.
96    public const SCHEMA_VERSION = 43;
97
98    // e.g. "dev", "alpha", "beta", etc.
99    public const STABILITY = 'beta.4';
100
101    // Version number
102    public const VERSION = '2.0.0' . (self::STABILITY === '' ? '' : '-') . self::STABILITY;
103
104    // Project website.
105    public const URL = 'https://www.webtrees.net/';
106
107    private const MIDDLEWARE = [
108        PhpEnvironment::class,
109        EmitResponse::class,
110        HandleExceptions::class,
111        ReadConfigIni::class,
112        BaseUrl::class,
113        ClientIp::class,
114        UseDatabase::class,
115        UseDebugbar::class,
116        UpdateDatabaseSchema::class,
117        UseCache::class,
118        UseFilesystem::class,
119        UseSession::class,
120        UseLocale::class,
121        CheckForMaintenanceMode::class,
122        UseTheme::class,
123        DoHousekeeping::class,
124        CheckCsrf::class,
125        UseTransaction::class,
126        LoadRoutes::class,
127        BootModules::class,
128        Router::class,
129        NoRouteFound::class,
130    ];
131
132    /**
133     * Initialise the application.
134     *
135     * @return void
136     */
137    public function bootstrap(): void
138    {
139        // Show all errors and warnings in development, fewer in production.
140        error_reporting(self::ERROR_REPORTING);
141
142        set_error_handler($this->phpErrorHandler());
143        set_exception_handler($this->phpExceptionHandler());
144    }
145
146    /**
147     * An error handler that can be passed to set_error_handler().
148     *
149     * @return Closure
150     */
151    private function phpErrorHandler(): Closure
152    {
153        return static function (int $errno, string $errstr, string $errfile, int $errline): bool {
154            // Ignore errors that are silenced with '@'
155            if (error_reporting() & $errno) {
156                throw new ErrorException($errstr, 0, $errno, $errfile, $errline);
157            }
158
159            return true;
160        };
161    }
162
163    /**
164     * An exception handler that can be passed to set_exception_handler().
165     * Display any exception that are not caught by the middleware exception handler.
166     *
167     * @return Closure
168     */
169    private function phpExceptionHandler(): Closure
170    {
171        return static function (Throwable $ex): void {
172            $base_path = dirname(__DIR__);
173            $trace     = $ex->getMessage() . ' ' . $ex->getFile() . ':' . $ex->getLine() . PHP_EOL . $ex->getTraceAsString();
174            $trace     = str_replace($base_path, '…', $trace);
175
176            while (ob_get_level() > 0) {
177                ob_end_clean();
178            }
179
180            echo '<html lang="en"><head><title>Error</title><meta charset="UTF-8"></head><body><pre>' . $trace . '</pre></body></html>';
181        };
182    }
183
184    /**
185     * We can use any PSR-7 / PSR-17 compatible message factory.
186     *
187     * @return void
188     */
189    public function selectMessageFactory(): void
190    {
191        app()->bind(ResponseFactoryInterface::class, Psr17Factory::class);
192        app()->bind(ServerRequestFactoryInterface::class, Psr17Factory::class);
193        app()->bind(StreamFactoryInterface::class, Psr17Factory::class);
194        app()->bind(UploadedFileFactoryInterface::class, Psr17Factory::class);
195        app()->bind(UriFactoryInterface::class, Psr17Factory::class);
196    }
197
198    /**
199     * The webtrees application is built from middleware.
200     *
201     * @return string[]
202     */
203    public function middleware(): array
204    {
205        return self::MIDDLEWARE;
206    }
207}
208