-
Notifications
You must be signed in to change notification settings - Fork 289
/
Webtrees.php
329 lines (289 loc) · 11.9 KB
/
Webtrees.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
<?php
/**
* webtrees: online genealogy
* Copyright (C) 2022 webtrees development team
* 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, either version 3 of the License, or
* (at your option) any later version.
* 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, see <https://www.gnu.org/licenses/>.
*/
declare(strict_types=1);
namespace Fisharebest\Webtrees;
use Closure;
use ErrorException;
use Fisharebest\Webtrees\Factories\CacheFactory;
use Fisharebest\Webtrees\Factories\CalendarDateFactory;
use Fisharebest\Webtrees\Factories\ElementFactory;
use Fisharebest\Webtrees\Factories\EncodingFactory;
use Fisharebest\Webtrees\Factories\FamilyFactory;
use Fisharebest\Webtrees\Factories\FilesystemFactory;
use Fisharebest\Webtrees\Factories\GedcomRecordFactory;
use Fisharebest\Webtrees\Factories\HeaderFactory;
use Fisharebest\Webtrees\Factories\IdFactory;
use Fisharebest\Webtrees\Factories\ImageFactory;
use Fisharebest\Webtrees\Factories\IndividualFactory;
use Fisharebest\Webtrees\Factories\LocationFactory;
use Fisharebest\Webtrees\Factories\MarkdownFactory;
use Fisharebest\Webtrees\Factories\MediaFactory;
use Fisharebest\Webtrees\Factories\NoteFactory;
use Fisharebest\Webtrees\Factories\RepositoryFactory;
use Fisharebest\Webtrees\Factories\ResponseFactory;
use Fisharebest\Webtrees\Factories\RouteFactory;
use Fisharebest\Webtrees\Factories\SharedNoteFactory;
use Fisharebest\Webtrees\Factories\SlugFactory;
use Fisharebest\Webtrees\Factories\SourceFactory;
use Fisharebest\Webtrees\Factories\SubmissionFactory;
use Fisharebest\Webtrees\Factories\SubmitterFactory;
use Fisharebest\Webtrees\Factories\SurnameTraditionFactory;
use Fisharebest\Webtrees\Factories\TimeFactory;
use Fisharebest\Webtrees\Factories\TimestampFactory;
use Fisharebest\Webtrees\Factories\XrefFactory;
use Fisharebest\Webtrees\GedcomFilters\GedcomEncodingFilter;
use Fisharebest\Webtrees\Http\Middleware\BadBotBlocker;
use Fisharebest\Webtrees\Http\Middleware\BaseUrl;
use Fisharebest\Webtrees\Http\Middleware\BootModules;
use Fisharebest\Webtrees\Http\Middleware\CheckForMaintenanceMode;
use Fisharebest\Webtrees\Http\Middleware\CheckForNewVersion;
use Fisharebest\Webtrees\Http\Middleware\ClientIp;
use Fisharebest\Webtrees\Http\Middleware\CompressResponse;
use Fisharebest\Webtrees\Http\Middleware\ContentLength;
use Fisharebest\Webtrees\Http\Middleware\DoHousekeeping;
use Fisharebest\Webtrees\Http\Middleware\EmitResponse;
use Fisharebest\Webtrees\Http\Middleware\HandleExceptions;
use Fisharebest\Webtrees\Http\Middleware\LoadRoutes;
use Fisharebest\Webtrees\Http\Middleware\NoRouteFound;
use Fisharebest\Webtrees\Http\Middleware\ReadConfigIni;
use Fisharebest\Webtrees\Http\Middleware\RegisterGedcomTags;
use Fisharebest\Webtrees\Http\Middleware\Router;
use Fisharebest\Webtrees\Http\Middleware\SecurityHeaders;
use Fisharebest\Webtrees\Http\Middleware\UpdateDatabaseSchema;
use Fisharebest\Webtrees\Http\Middleware\UseDatabase;
use Fisharebest\Webtrees\Http\Middleware\UseLanguage;
use Fisharebest\Webtrees\Http\Middleware\UseSession;
use Fisharebest\Webtrees\Http\Middleware\UseTheme;
use Fisharebest\Webtrees\Http\Middleware\UseTransaction;
use Illuminate\Container\Container;
use Middleland\Dispatcher;
use Nyholm\Psr7\Factory\Psr17Factory;
use Nyholm\Psr7Server\ServerRequestCreator;
use Psr\Container\ContainerInterface;
use Psr\Http\Message\ResponseFactoryInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestFactoryInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Message\StreamFactoryInterface;
use Psr\Http\Message\UploadedFileFactoryInterface;
use Psr\Http\Message\UriFactoryInterface;
use Psr\Http\Server\MiddlewareInterface;
use function date_default_timezone_set;
use function error_reporting;
use function is_string;
use function mb_internal_encoding;
use function set_error_handler;
use function stream_filter_register;
use const E_ALL;
use const E_DEPRECATED;
use const E_USER_DEPRECATED;
/**
* Definitions for the webtrees application.
*/
class Webtrees
{
// The root folder of this installation
public const ROOT_DIR = __DIR__ . '/../';
// This is the location of system data, such as temporary and cache files.
// The system files are always in this location.
// It is also the default location of user data, such as media and GEDCOM files.
// The user files could be anywhere supported by Flysystem.
public const DATA_DIR = self::ROOT_DIR . 'data/';
// Location of the file containing the database connection details.
public const CONFIG_FILE = self::DATA_DIR . 'config.ini.php';
// Location of the file that triggers maintenance mode.
public const OFFLINE_FILE = self::DATA_DIR . 'offline.txt';
// Location of our modules.
public const MODULES_PATH = 'modules_v4/';
public const MODULES_DIR = self::ROOT_DIR . self::MODULES_PATH;
// Enable debugging on development builds.
public const DEBUG = self::STABILITY !== '';
// We want to know about all PHP errors during development, and fewer in production.
public const ERROR_REPORTING = self::DEBUG ? E_ALL : E_ALL & ~E_DEPRECATED & ~E_USER_DEPRECATED;
// Page layouts for various page types.
public const LAYOUT_ADMINISTRATION = 'layouts/administration';
public const LAYOUT_AJAX = 'layouts/ajax';
public const LAYOUT_DEFAULT = 'layouts/default';
public const LAYOUT_ERROR = 'layouts/error';
// The name of the application.
public const NAME = 'webtrees';
// Required version of database tables/columns/indexes/etc.
public const SCHEMA_VERSION = 45;
// e.g. "-dev", "-alpha", "-beta", etc.
public const STABILITY = '';
// Version number.
public const VERSION = '2.1.15' . self::STABILITY;
// Project website.
public const URL = 'https://webtrees.net/';
// FAQ links.
public const URL_FAQ_EMAIL = 'https://webtrees.net/faq/email';
// GEDCOM specification.
public const GEDCOM_PDF = 'https://webtrees.net/downloads/gedcom-5-5-1.pdf';
private const MIDDLEWARE = [
EmitResponse::class,
SecurityHeaders::class,
ReadConfigIni::class,
BaseUrl::class,
HandleExceptions::class,
ClientIp::class,
ContentLength::class,
CompressResponse::class,
BadBotBlocker::class,
UseDatabase::class,
UpdateDatabaseSchema::class,
UseSession::class,
UseLanguage::class,
CheckForMaintenanceMode::class,
UseTheme::class,
DoHousekeeping::class,
UseTransaction::class,
CheckForNewVersion::class,
LoadRoutes::class,
RegisterGedcomTags::class,
BootModules::class,
Router::class,
NoRouteFound::class,
];
/**
* Initialise the application.
*
* @return void
*/
public function bootstrap(): void
{
// Show all errors and warnings in development, fewer in production.
error_reporting(self::ERROR_REPORTING);
set_error_handler($this->phpErrorHandler());
// All modern software uses UTF-8 encoding.
mb_internal_encoding('UTF-8');
// Use UTC internally and convert to local time when displaying datetimes.
date_default_timezone_set('UTC');
// Factory objects
Registry::cache(new CacheFactory());
Registry::calendarDateFactory(new CalendarDateFactory());
Registry::elementFactory(new ElementFactory());
Registry::encodingFactory(new EncodingFactory());
Registry::familyFactory(new FamilyFactory());
Registry::filesystem(new FilesystemFactory());
Registry::gedcomRecordFactory(new GedcomRecordFactory());
Registry::headerFactory(new HeaderFactory());
Registry::idFactory(new IdFactory());
Registry::imageFactory(new ImageFactory());
Registry::individualFactory(new IndividualFactory());
Registry::locationFactory(new LocationFactory());
Registry::markdownFactory(new MarkdownFactory());
Registry::mediaFactory(new MediaFactory());
Registry::noteFactory(new NoteFactory());
Registry::repositoryFactory(new RepositoryFactory());
Registry::responseFactory(new ResponseFactory(new Psr17Factory(), new Psr17Factory()));
Registry::routeFactory(new RouteFactory());
Registry::sharedNoteFactory(new SharedNoteFactory());
Registry::slugFactory(new SlugFactory());
Registry::sourceFactory(new SourceFactory());
Registry::submissionFactory(new SubmissionFactory());
Registry::submitterFactory(new SubmitterFactory());
Registry::surnameTraditionFactory(new SurnameTraditionFactory());
Registry::timeFactory(new TimeFactory());
Registry::timestampFactory(new TimestampFactory());
Registry::xrefFactory(new XrefFactory());
stream_filter_register(GedcomEncodingFilter::class, GedcomEncodingFilter::class);
}
/**
* Respond to a CLI request.
*
* @return void
*/
public function cliRequest(): void
{
// CLI handler will go here.
}
/**
* Respond to an HTTP request.
*
* @return ResponseInterface
*/
public function httpRequest(): ResponseInterface
{
$psr17factory = new Psr17Factory();
// PSR7 messages and PSR17 message-factories
self::set(ResponseFactoryInterface::class, $psr17factory);
self::set(ServerRequestFactoryInterface::class, $psr17factory);
self::set(StreamFactoryInterface::class, $psr17factory);
self::set(UploadedFileFactoryInterface::class, $psr17factory);
self::set(UriFactoryInterface::class, $psr17factory);
$server_request_creator = new ServerRequestCreator($psr17factory, $psr17factory, $psr17factory, $psr17factory);
$request = $server_request_creator->fromGlobals();
return self::dispatch($request, self::MIDDLEWARE);
}
/**
* @param ServerRequestInterface $request
* @param array<string|MiddlewareInterface> $middleware
*
* @return ResponseInterface
*/
public static function dispatch(ServerRequestInterface $request, array $middleware): ResponseInterface
{
$dispatcher = new Dispatcher($middleware, self::container());
return $dispatcher->dispatch($request);
}
/**
* An error handler that can be passed to set_error_handler().
*
* @return Closure
*/
private function phpErrorHandler(): Closure
{
return static function (int $errno, string $errstr, string $errfile, int $errline): bool {
// Ignore errors that are silenced with '@'
if (error_reporting() & $errno) {
throw new ErrorException($errstr, 0, $errno, $errfile, $errline);
}
return true;
};
}
/**
* @return ContainerInterface
*/
public static function container(): ContainerInterface
{
return Container::getInstance();
}
/**
* Make an object, using dependency injection.
*
* @param string $class
*
* @return mixed
*/
public static function make(string $class)
{
return Container::getInstance()->make($class);
}
/**
* Write a value into the container.
*
* @param string $abstract
* @param string|object $concrete
*/
public static function set(string $abstract, $concrete): void
{
if (is_string($concrete)) {
Container::getInstance()->bind($abstract, $concrete);
} else {
Container::getInstance()->instance($abstract, $concrete);
}
}
}