xref: /webtrees/index.php (revision 2b788798d83daa55cca8ccaf55ccc093b03de5af) 
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\Application;
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        $controller = new SetupController();
81        $response   = $controller->setup($request);
82        $response->prepare($request)->send();
83
84        return;
85    }
86
87    $database_config = parse_ini_file(Webtrees::CONFIG_FILE);
88
89    if ($database_config === false) {
90        throw new Exception('Invalid config file: ' . Webtrees::CONFIG_FILE);
91    }
92
93    // Read the connection settings and create the database
94    Database::createInstance($database_config);
95
96    // Update the database schema, if necessary.
97    Database::updateSchema('\Fisharebest\Webtrees\Schema', 'WT_SCHEMA_VERSION', Webtrees::SCHEMA_VERSION);
98} catch (PDOException $exception) {
99    define('WT_DATA_DIR', 'data/');
100    I18N::init();
101    if ($exception->getCode() === 1045) {
102        // Error during connection?
103        $content = view('errors/database-connection', ['error' => $exception->getMessage()]);
104    } else {
105        // Error in a migration script?
106        $content = view('errors/database-error', ['error' => $exception->getMessage()]);
107    }
108    $html     = view('layouts/error', ['content' => $content]);
109    $response = new Response($html, Response::HTTP_SERVICE_UNAVAILABLE);
110    $response->prepare($request)->send();
111
112    return;
113} catch (Throwable $exception) {
114    define('WT_DATA_DIR', 'data/');
115    I18N::init();
116    $content  = view('errors/database-connection', ['error' => $exception->getMessage()]);
117    $html     = view('layouts/error', ['content' => $content]);
118    $response = new Response($html, Response::HTTP_SERVICE_UNAVAILABLE);
119    $response->prepare($request)->send();
120
121    return;
122}
123
124DebugBar::stopMeasure('init database');
125
126// The config.ini.php file must always be in a fixed location.
127// Other user files can be stored elsewhere...
128define('WT_DATA_DIR', realpath(Site::getPreference('INDEX_DIRECTORY', 'data/')) . DIRECTORY_SEPARATOR);
129
130// Some broken servers block access to their own temp folder using open_basedir...
131$data_dir = new Filesystem(new Local(WT_DATA_DIR));
132$data_dir->createDir('tmp');
133putenv('TMPDIR=' . WT_DATA_DIR . 'tmp');
134
135// Request more resources - if we can/want to
136$memory_limit = Site::getPreference('MEMORY_LIMIT');
137if ($memory_limit !== '' && strpos(ini_get('disable_functions'), 'ini_set') === false) {
138    ini_set('memory_limit', $memory_limit);
139}
140$max_execution_time = Site::getPreference('MAX_EXECUTION_TIME');
141if ($max_execution_time !== '' && strpos(ini_get('disable_functions'), 'set_time_limit') === false) {
142    set_time_limit((int) $max_execution_time);
143}
144
145// Sessions
146Session::start();
147
148// Note that the database/webservers may not be synchronised, so use DB time throughout.
149define('WT_TIMESTAMP', DB::select('SELECT UNIX_TIMESTAMP() AS unix_timestamp')[0]->unix_timestamp);
150
151// Users get their own time-zone. Visitors get the site time-zone.
152try {
153    if (Auth::check()) {
154        date_default_timezone_set(Auth::user()->getPreference('TIMEZONE'));
155    } else {
156        date_default_timezone_set(Site::getPreference('TIMEZONE'));
157    }
158} catch (ErrorException $exception) {
159    // Server upgrades and migrations can leave us with invalid timezone settings.
160    date_default_timezone_set('UTC');
161}
162
163define('WT_TIMESTAMP_OFFSET', (new DateTime('now'))->getOffset());
164
165define('WT_CLIENT_JD', 2440588 + intdiv(WT_TIMESTAMP + WT_TIMESTAMP_OFFSET, 86400));
166
167// Update the last-login time no more than once a minute
168if (WT_TIMESTAMP - Session::get('activity_time') >= 60) {
169    if (Session::get('masquerade') === null) {
170        Auth::user()->setPreference('sessiontime', (string) WT_TIMESTAMP);
171    }
172    Session::put('activity_time', WT_TIMESTAMP);
173}
174
175DebugBar::startMeasure('routing');
176
177try {
178    // Most requests will need the current tree and user.
179    $tree = Tree::findByName($request->get('ged')) ?? null;
180
181    // No tree specified/available?  Choose one.
182    if ($tree === null && $request->getMethod() === Request::METHOD_GET) {
183        $tree = Tree::findByName(Site::getPreference('DEFAULT_GEDCOM')) ?? array_values(Tree::getAll())[0] ?? null;
184    }
185
186    // Select a locale
187    define('WT_LOCALE', I18N::init('', $tree));
188    Session::put('locale', WT_LOCALE);
189
190    // Most layouts will require a tree for the page header/footer
191    View::share('tree', $tree);
192
193    // Load the route and routing table.
194    $route  = $request->get('route');
195    $routes = require 'routes/web.php';
196
197    // Find the controller and action for the selected route
198    $controller_action = $routes[$request->getMethod() . ':' . $route] ?? 'ErrorController@noRouteFound';
199    [$controller_name, $action] = explode('@', $controller_action);
200    $controller_class = '\\Fisharebest\\Webtrees\\Http\\Controllers\\' . $controller_name;
201
202    // Set up dependency injection for the controllers.
203    $app = new Application();
204    $app->instance(Application::class, $app);
205    $app->instance(Request::class, $request);
206    $app->instance(Tree::class, $tree);
207    $app->instance(User::class, Auth::user());
208    $app->instance(LocaleInterface::class, WebtreesLocale::create(WT_LOCALE));
209    $app->instance(TimeoutService::class, new TimeoutService(microtime(true)));
210    $app->instance(Filesystem::class, new Filesystem(new Local(WT_DATA_DIR)));
211
212    $controller = $app->make($controller_class);
213
214    DebugBar::stopMeasure('routing');
215
216    DebugBar::startMeasure('init theme');
217
218    // Last theme used?
219    $theme_id = Session::get('theme_id');
220    // Default for tree
221    if (!array_key_exists($theme_id, Theme::themeNames()) && $tree) {
222        $theme_id = $tree->getPreference('THEME_DIR');
223    }
224    // Default for site
225    if (!array_key_exists($theme_id, Theme::themeNames())) {
226        $theme_id = Site::getPreference('THEME_DIR');
227    }
228    // Default
229    if (!array_key_exists($theme_id, Theme::themeNames())) {
230        $theme_id = 'webtrees';
231    }
232    foreach (Theme::installedThemes() as $theme) {
233        if ($theme->themeId() === $theme_id) {
234            Theme::theme($theme)->init($request, $tree);
235            // Remember this setting
236            if (Site::getPreference('ALLOW_USER_THEMES') === '1') {
237                Session::put('theme_id', $theme_id);
238            }
239            break;
240        }
241    }
242
243    DebugBar::stopMeasure('init theme');
244
245    // Note that we can't stop this timer, as running the action will
246    // generate the response - which includes (and stops) the timer
247    DebugBar::startMeasure('controller_action');
248
249    $middleware_stack = [
250        CheckForMaintenanceMode::class,
251    ];
252
253    if (class_exists(DebugBar::class)) {
254        $middleware_stack[] = DebugBarData::class;
255    }
256
257    if ($request->getMethod() === Request::METHOD_GET) {
258        $middleware_stack[] = PageHitCounter::class;
259        $middleware_stack[] = Housekeeping::class;
260    }
261
262    if ($request->getMethod() === Request::METHOD_POST) {
263        $middleware_stack[] = UseTransaction::class;
264        $middleware_stack[] = CheckCsrf::class;
265    }
266
267    // Apply the middleware using the "onion" pattern.
268    $pipeline = array_reduce($middleware_stack, function (Closure $next, string $middleware) use ($app): Closure {
269        // Create a closure to apply the middleware.
270        return function (Request $request) use ($middleware, $next, $app): Response {
271            return $app->make($middleware)->handle($request, $next);
272        };
273    }, function (Request $request) use ($controller, $action, $app): Response {
274        return $app->dispatch($controller, $action);
275    });
276
277    $response = call_user_func($pipeline, $request);
278} catch (Exception $exception) {
279    $response = (new Handler())->render($request, $exception);
280}
281
282// Send response
283$response->prepare($request)->send();
284