xref: /webtrees/index.php (revision c88a5019dff7bc89d58039dfe7af14f8446e6384) 
1<?php
2/**
3 * webtrees: online genealogy
4 * Copyright (C) 2019 webtrees development team
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16declare(strict_types=1);
17
18use Fisharebest\Localization\Locale as WebtreesLocale;
19use Fisharebest\Localization\Locale\LocaleInterface;
20use Fisharebest\Webtrees\Auth;
21use Fisharebest\Webtrees\Database;
22use Fisharebest\Webtrees\DebugBar;
23use Fisharebest\Webtrees\Exceptions\Handler;
24use Fisharebest\Webtrees\Http\Controllers\SetupController;
25use Fisharebest\Webtrees\Http\Middleware\CheckCsrf;
26use Fisharebest\Webtrees\Http\Middleware\CheckForMaintenanceMode;
27use Fisharebest\Webtrees\Http\Middleware\DebugBarData;
28use Fisharebest\Webtrees\Http\Middleware\Housekeeping;
29use Fisharebest\Webtrees\Http\Middleware\PageHitCounter;
30use Fisharebest\Webtrees\Http\Middleware\UseTransaction;
31use Fisharebest\Webtrees\I18N;
32use Fisharebest\Webtrees\Resolver;
33use Fisharebest\Webtrees\Services\TimeoutService;
34use Fisharebest\Webtrees\Session;
35use Fisharebest\Webtrees\Site;
36use Fisharebest\Webtrees\Theme;
37use Fisharebest\Webtrees\Tree;
38use Fisharebest\Webtrees\User;
39use Fisharebest\Webtrees\View;
40use Fisharebest\Webtrees\Webtrees;
41use Illuminate\Database\Capsule\Manager as DB;
42use League\Flysystem\Adapter\Local;
43use League\Flysystem\Filesystem;
44use Symfony\Component\HttpFoundation\Request;
45use Symfony\Component\HttpFoundation\Response;
46
47require __DIR__ . '/vendor/autoload.php';
48
49// Regular expressions for validating user input, etc.
50const WT_MINIMUM_PASSWORD_LENGTH = 6;
51const WT_REGEX_PASSWORD          = '.{' . WT_MINIMUM_PASSWORD_LENGTH . ',}';
52
53const WT_ROOT = __DIR__ . DIRECTORY_SEPARATOR;
54
55Webtrees::init();
56
57// Initialise the DebugBar for development.
58// Use `composer install --dev` on a development build to enable.
59// Note that you may need to increase the size of the fcgi buffers on nginx.
60// e.g. add these lines to your fastcgi_params file:
61// fastcgi_buffers 16 16m;
62// fastcgi_buffer_size 32m;
63DebugBar::init(Webtrees::DEBUG && class_exists('\\DebugBar\\StandardDebugBar'));
64
65// Calculate the base URL, so we can generate absolute URLs.
66$request     = Request::createFromGlobals();
67$request_uri = $request->getSchemeAndHttpHost() . $request->getRequestUri();
68
69// Remove any PHP script name and parameters.
70$base_uri = preg_replace('/[^\/]+\.php(\?.*)?$/', '', $request_uri);
71define('WT_BASE_URL', $base_uri);
72
73DebugBar::startMeasure('init database');
74
75// Connect to the database
76try {
77    // No config file? Run the setup wizard
78    if (!file_exists(Webtrees::CONFIG_FILE)) {
79        define('WT_DATA_DIR', 'data/');
80        $request    = Request::createFromGlobals();
81        $controller = new SetupController();
82        $response   = $controller->setup($request);
83        $response->prepare($request)->send();
84
85        return;
86    }
87
88    $database_config = parse_ini_file(Webtrees::CONFIG_FILE);
89
90    if ($database_config === false) {
91        throw new Exception('Invalid config file: ' . Webtrees::CONFIG_FILE);
92    }
93
94    // Read the connection settings and create the database
95    Database::createInstance($database_config);
96
97    // Update the database schema, if necessary.
98    Database::updateSchema('\Fisharebest\Webtrees\Schema', 'WT_SCHEMA_VERSION', Webtrees::SCHEMA_VERSION);
99} catch (PDOException $exception) {
100    define('WT_DATA_DIR', 'data/');
101    I18N::init();
102    if ($exception->getCode() === 1045) {
103        // Error during connection?
104        $content = view('errors/database-connection', ['error' => $exception->getMessage()]);
105    } else {
106        // Error in a migration script?
107        $content = view('errors/database-error', ['error' => $exception->getMessage()]);
108    }
109    $html     = view('layouts/error', ['content' => $content]);
110    $response = new Response($html, Response::HTTP_SERVICE_UNAVAILABLE);
111    $response->prepare($request)->send();
112
113    return;
114} catch (Throwable $exception) {
115    define('WT_DATA_DIR', 'data/');
116    I18N::init();
117    $content  = view('errors/database-connection', ['error' => $exception->getMessage()]);
118    $html     = view('layouts/error', ['content' => $content]);
119    $response = new Response($html, Response::HTTP_SERVICE_UNAVAILABLE);
120    $response->prepare($request)->send();
121
122    return;
123}
124
125DebugBar::stopMeasure('init database');
126
127// The config.ini.php file must always be in a fixed location.
128// Other user files can be stored elsewhere...
129define('WT_DATA_DIR', realpath(Site::getPreference('INDEX_DIRECTORY', 'data/')) . DIRECTORY_SEPARATOR);
130
131// Some broken servers block access to their own temp folder using open_basedir...
132$data_dir = new Filesystem(new Local(WT_DATA_DIR));
133$data_dir->createDir('tmp');
134putenv('TMPDIR=' . WT_DATA_DIR . 'tmp');
135
136// Request more resources - if we can/want to
137$memory_limit = Site::getPreference('MEMORY_LIMIT');
138if ($memory_limit !== '' && strpos(ini_get('disable_functions'), 'ini_set') === false) {
139    ini_set('memory_limit', $memory_limit);
140}
141$max_execution_time = Site::getPreference('MAX_EXECUTION_TIME');
142if ($max_execution_time !== '' && strpos(ini_get('disable_functions'), 'set_time_limit') === false) {
143    set_time_limit((int) $max_execution_time);
144}
145
146// Sessions
147Session::start();
148
149// Note that the database/webservers may not be synchronised, so use DB time throughout.
150define('WT_TIMESTAMP', DB::select('SELECT UNIX_TIMESTAMP() AS unix_timestamp')[0]->unix_timestamp);
151
152// Users get their own time-zone. Visitors get the site time-zone.
153try {
154    if (Auth::check()) {
155        date_default_timezone_set(Auth::user()->getPreference('TIMEZONE'));
156    } else {
157        date_default_timezone_set(Site::getPreference('TIMEZONE'));
158    }
159} catch (ErrorException $exception) {
160    // Server upgrades and migrations can leave us with invalid timezone settings.
161    date_default_timezone_set('UTC');
162}
163
164define('WT_TIMESTAMP_OFFSET', (new DateTime('now'))->getOffset());
165
166define('WT_CLIENT_JD', 2440588 + intdiv(WT_TIMESTAMP + WT_TIMESTAMP_OFFSET, 86400));
167
168// Update the last-login time no more than once a minute
169if (WT_TIMESTAMP - Session::get('activity_time') >= 60) {
170    if (Session::get('masquerade') === null) {
171        Auth::user()->setPreference('sessiontime', (string) WT_TIMESTAMP);
172    }
173    Session::put('activity_time', WT_TIMESTAMP);
174}
175
176DebugBar::startMeasure('routing');
177
178// The HTTP request.
179$request = Request::createFromGlobals();
180$route   = $request->get('route');
181
182try {
183    // Most requests will need the current tree and user.
184    $all_trees = Tree::getAll();
185
186    $tree = $all_trees[$request->get('ged')] ?? null;
187
188    // No tree specified/available?  Choose one.
189    if ($tree === null && $request->getMethod() === Request::METHOD_GET) {
190        $tree = $all_trees[Site::getPreference('DEFAULT_GEDCOM')] ?? array_values($all_trees)[0] ?? null;
191    }
192
193    // Select a locale
194    define('WT_LOCALE', I18N::init('', $tree));
195    Session::put('locale', WT_LOCALE);
196
197    // Most layouts will require a tree for the page header/footer
198    View::share('tree', $tree);
199
200    // Load the routing table.
201    $routes = require 'routes/web.php';
202
203    // Find the controller and action for the selected route
204    $controller_action = $routes[$request->getMethod() . ':' . $route] ?? 'ErrorController@noRouteFound';
205    [$controller_name, $action] = explode('@', $controller_action);
206    $controller_class = '\\Fisharebest\\Webtrees\\Http\\Controllers\\' . $controller_name;
207
208    // Set up dependency injection for the controllers.
209    $resolver = new Resolver();
210    $resolver->bind(Resolver::class, $resolver);
211    $resolver->bind(Tree::class, $tree);
212    $resolver->bind(User::class, Auth::user());
213    $resolver->bind(LocaleInterface::class, WebtreesLocale::create(WT_LOCALE));
214    $resolver->bind(TimeoutService::class, new TimeoutService(microtime(true)));
215    $resolver->bind(Filesystem::class, new Filesystem(new Local(WT_DATA_DIR)));
216
217    $controller = $resolver->resolve($controller_class);
218
219    DebugBar::stopMeasure('routing');
220
221    DebugBar::startMeasure('init theme');
222
223    // Last theme used?
224    $theme_id = Session::get('theme_id');
225    // Default for tree
226    if (!array_key_exists($theme_id, Theme::themeNames()) && $tree) {
227        $theme_id = $tree->getPreference('THEME_DIR');
228    }
229    // Default for site
230    if (!array_key_exists($theme_id, Theme::themeNames())) {
231        $theme_id = Site::getPreference('THEME_DIR');
232    }
233    // Default
234    if (!array_key_exists($theme_id, Theme::themeNames())) {
235        $theme_id = 'webtrees';
236    }
237    foreach (Theme::installedThemes() as $theme) {
238        if ($theme->themeId() === $theme_id) {
239            Theme::theme($theme)->init($request, $tree);
240            // Remember this setting
241            if (Site::getPreference('ALLOW_USER_THEMES') === '1') {
242                Session::put('theme_id', $theme_id);
243            }
244            break;
245        }
246    }
247
248    DebugBar::stopMeasure('init theme');
249
250    // Note that we can't stop this timer, as running the action will
251    // generate the response - which includes (and stops) the timer
252    DebugBar::startMeasure('controller_action');
253
254    $middleware_stack = [
255        CheckForMaintenanceMode::class,
256    ];
257
258    if (class_exists(DebugBar::class)) {
259        $middleware_stack[] = DebugBarData::class;
260    }
261
262    if ($request->getMethod() === Request::METHOD_GET) {
263        $middleware_stack[] = PageHitCounter::class;
264        $middleware_stack[] = Housekeeping::class;
265    }
266
267    if ($request->getMethod() === Request::METHOD_POST) {
268        $middleware_stack[] = UseTransaction::class;
269        $middleware_stack[] = CheckCsrf::class;
270    }
271
272    // Apply the middleware using the "onion" pattern.
273    $pipeline = array_reduce($middleware_stack, function (Closure $next, string $middleware) use ($resolver): Closure {
274        // Create a closure to apply the middleware.
275        return function (Request $request) use ($middleware, $next, $resolver): Response {
276            return $resolver->resolve($middleware)->handle($request, $next);
277        };
278    }, function (Request $request) use ($controller, $action, $resolver): Response {
279        $resolver->bind(Request::class, $request);
280
281        return $resolver->dispatch($controller, $action);
282    });
283
284    $response = call_user_func($pipeline, $request);
285} catch (Exception $exception) {
286    $response = (new Handler())->render($request, $exception);
287}
288
289// Send response
290$response->prepare($request)->send();
291