Passed
Push — analysis-q1rPgw ( 7aeaf2 )
by Greg
09:22 queued 14s
created

index.php (7 issues)

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
 */
16
declare(strict_types=1);
17
18
use Fisharebest\Localization\Locale as WebtreesLocale;
19
use Fisharebest\Localization\Locale\LocaleInterface;
20
use Fisharebest\Webtrees\Auth;
0 ignored issues
show
This use statement conflicts with another class in this namespace, Auth. Consider defining an alias.

Let?s assume that you have a directory layout like this:

.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php

and let?s assume the following content of Bar.php:

// Bar.php
namespace OtherDir;

use SomeDir\Foo; // This now conflicts the class OtherDir\Foo

If both files OtherDir/Foo.php and SomeDir/Foo.php are loaded in the same runtime, you will see a PHP error such as the following:

PHP Fatal error:  Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php

However, as OtherDir/Foo.php does not necessarily have to be loaded and the error is only triggered if it is loaded before OtherDir/Bar.php, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias:

// Bar.php
namespace OtherDir;

use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore.
Loading history...
21
use Fisharebest\Webtrees\Contracts\UserInterface;
22
use Fisharebest\Webtrees\Database;
23
use Fisharebest\Webtrees\DebugBar;
24
use Fisharebest\Webtrees\Exceptions\Handler;
25
use Fisharebest\Webtrees\Http\Controllers\SetupController;
26
use Fisharebest\Webtrees\Http\Middleware\CheckCsrf;
27
use Fisharebest\Webtrees\Http\Middleware\CheckForMaintenanceMode;
28
use Fisharebest\Webtrees\Http\Middleware\DebugBarData;
29
use Fisharebest\Webtrees\Http\Middleware\Housekeeping;
30
use Fisharebest\Webtrees\Http\Middleware\UseTransaction;
31
use Fisharebest\Webtrees\I18N;
32
use Fisharebest\Webtrees\Module\ModuleThemeInterface;
33
use Fisharebest\Webtrees\Module\WebtreesTheme;
34
use Fisharebest\Webtrees\Services\MigrationService;
35
use Fisharebest\Webtrees\Services\ModuleService;
36
use Fisharebest\Webtrees\Services\TimeoutService;
37
use Fisharebest\Webtrees\Session;
0 ignored issues
show
This use statement conflicts with another class in this namespace, Session. Consider defining an alias.

Let?s assume that you have a directory layout like this:

.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php

and let?s assume the following content of Bar.php:

// Bar.php
namespace OtherDir;

use SomeDir\Foo; // This now conflicts the class OtherDir\Foo

If both files OtherDir/Foo.php and SomeDir/Foo.php are loaded in the same runtime, you will see a PHP error such as the following:

PHP Fatal error:  Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php

However, as OtherDir/Foo.php does not necessarily have to be loaded and the error is only triggered if it is loaded before OtherDir/Bar.php, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias:

// Bar.php
namespace OtherDir;

use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore.
Loading history...
38
use Fisharebest\Webtrees\Site;
39
use Fisharebest\Webtrees\Tree;
40
use Fisharebest\Webtrees\View;
0 ignored issues
show
This use statement conflicts with another class in this namespace, View. Consider defining an alias.

Let?s assume that you have a directory layout like this:

.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php

and let?s assume the following content of Bar.php:

// Bar.php
namespace OtherDir;

use SomeDir\Foo; // This now conflicts the class OtherDir\Foo

If both files OtherDir/Foo.php and SomeDir/Foo.php are loaded in the same runtime, you will see a PHP error such as the following:

PHP Fatal error:  Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php

However, as OtherDir/Foo.php does not necessarily have to be loaded and the error is only triggered if it is loaded before OtherDir/Bar.php, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias:

// Bar.php
namespace OtherDir;

use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore.
Loading history...
41
use Fisharebest\Webtrees\Webtrees;
42
use Illuminate\Cache\ArrayStore;
43
use Illuminate\Cache\Repository;
44
use Illuminate\Database\Capsule\Manager as DB;
0 ignored issues
show
This use statement conflicts with another class in this namespace, DB. Consider defining an alias.

Let?s assume that you have a directory layout like this:

.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php

and let?s assume the following content of Bar.php:

// Bar.php
namespace OtherDir;

use SomeDir\Foo; // This now conflicts the class OtherDir\Foo

If both files OtherDir/Foo.php and SomeDir/Foo.php are loaded in the same runtime, you will see a PHP error such as the following:

PHP Fatal error:  Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php

However, as OtherDir/Foo.php does not necessarily have to be loaded and the error is only triggered if it is loaded before OtherDir/Bar.php, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias:

// Bar.php
namespace OtherDir;

use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore.
Loading history...
45
use Illuminate\Support\Collection;
46
use League\Flysystem\Adapter\Local;
47
use League\Flysystem\Cached\CachedAdapter;
48
use League\Flysystem\Cached\Storage\Memory;
49
use League\Flysystem\Filesystem;
50
use Symfony\Component\HttpFoundation\Request;
0 ignored issues
show
This use statement conflicts with another class in this namespace, Request. Consider defining an alias.

Let?s assume that you have a directory layout like this:

.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php

and let?s assume the following content of Bar.php:

// Bar.php
namespace OtherDir;

use SomeDir\Foo; // This now conflicts the class OtherDir\Foo

If both files OtherDir/Foo.php and SomeDir/Foo.php are loaded in the same runtime, you will see a PHP error such as the following:

PHP Fatal error:  Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php

However, as OtherDir/Foo.php does not necessarily have to be loaded and the error is only triggered if it is loaded before OtherDir/Bar.php, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias:

// Bar.php
namespace OtherDir;

use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore.
Loading history...
51
use Symfony\Component\HttpFoundation\Response;
0 ignored issues
show
This use statement conflicts with another class in this namespace, Response. Consider defining an alias.

Let?s assume that you have a directory layout like this:

.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php

and let?s assume the following content of Bar.php:

// Bar.php
namespace OtherDir;

use SomeDir\Foo; // This now conflicts the class OtherDir\Foo

If both files OtherDir/Foo.php and SomeDir/Foo.php are loaded in the same runtime, you will see a PHP error such as the following:

PHP Fatal error:  Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php

However, as OtherDir/Foo.php does not necessarily have to be loaded and the error is only triggered if it is loaded before OtherDir/Bar.php, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias:

// Bar.php
namespace OtherDir;

use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore.
Loading history...
52
53
require __DIR__ . '/vendor/autoload.php';
54
55
const WT_ROOT = __DIR__ . DIRECTORY_SEPARATOR;
56
57
Webtrees::init();
58
59
// Initialise the DebugBar for development.
60
// Use `composer install --dev` on a development build to enable.
61
// Note that you may need to increase the size of the fcgi buffers on nginx.
62
// e.g. add these lines to your fastcgi_params file:
63
// fastcgi_buffers 16 16m;
64
// fastcgi_buffer_size 32m;
65
DebugBar::init(class_exists('\\DebugBar\\StandardDebugBar'));
66
67
// Use an array cache for database calls, etc.
68
app()->instance('cache.array', new Repository(new ArrayStore()));
69
70
// Extract the request parameters.
71
$request = Request::createFromGlobals();
72
app()->instance(Request::class, $request);
73
74
// Dummy value, until we have created our first tree.
75
app()->bind(Tree::class, function () {
76
    return null;
77
});
78
79
// Calculate the base URL, so we can generate absolute URLs.
80
$request_uri = $request->getSchemeAndHttpHost() . $request->getRequestUri();
81
82
// Remove any PHP script name and parameters.
83
$base_uri = preg_replace('/[^\/]+\.php(\?.*)?$/', '', $request_uri);
84
define('WT_BASE_URL', $base_uri);
85
86
DebugBar::startMeasure('init database');
87
88
// Connect to the database
89
try {
90
    // No config file? Run the setup wizard
91
    if (!file_exists(Webtrees::CONFIG_FILE)) {
92
        define('WT_DATA_DIR', 'data/');
93
        /** @var SetupController $controller */
94
        $controller = app()->make(SetupController::class);
95
        $response   = $controller->setup($request);
96
        $response->prepare($request)->send();
97
98
        return;
99
    }
100
101
    $database_config = parse_ini_file(Webtrees::CONFIG_FILE);
102
103
    if ($database_config === false) {
104
        throw new Exception('Invalid config file: ' . Webtrees::CONFIG_FILE);
105
    }
106
107
    // Read the connection settings and create the database
108
    Database::createInstance($database_config);
109
110
    // Update the database schema, if necessary.
111
    app()->make(MigrationService::class)
112
        ->updateSchema('\Fisharebest\Webtrees\Schema', 'WT_SCHEMA_VERSION', Webtrees::SCHEMA_VERSION);
113
} catch (PDOException $exception) {
114
    I18N::init();
115
    if ($exception->getCode() === 1045) {
116
        // Error during connection?
117
        $content = view('errors/database-connection', ['error' => $exception->getMessage()]);
118
    } else {
119
        // Error in a migration script?
120
        $content = view('errors/database-error', ['error' => $exception->getMessage()]);
121
    }
122
    $html     = view('layouts/error', ['content' => $content]);
123
    $response = new Response($html, Response::HTTP_SERVICE_UNAVAILABLE);
124
    $response->prepare($request)->send();
125
126
    return;
127
} catch (Throwable $exception) {
128
    I18N::init();
129
    $content  = view('errors/database-connection', ['error' => $exception->getMessage()]);
130
    $html     = view('layouts/error', ['content' => $content]);
131
    $response = new Response($html, Response::HTTP_SERVICE_UNAVAILABLE);
132
    $response->prepare($request)->send();
133
134
    return;
135
}
136
137
DebugBar::stopMeasure('init database');
138
139
// The config.ini.php file must always be in a fixed location.
140
// Other user files can be stored elsewhere...
141
define('WT_DATA_DIR', realpath(Site::getPreference('INDEX_DIRECTORY', 'data/')) . DIRECTORY_SEPARATOR);
142
143
$filesystem = new Filesystem(new CachedAdapter(new Local(WT_DATA_DIR), new Memory()));
144
145
// Some broken servers block access to their own temp folder using open_basedir...
146
$filesystem->createDir('tmp');
147
putenv('TMPDIR=' . WT_DATA_DIR . 'tmp');
148
Swift_Preferences::getInstance()->setTempDir(WT_DATA_DIR . 'tmp');
149
150
// Request more resources - if we can/want to
151
$memory_limit = Site::getPreference('MEMORY_LIMIT');
152
if ($memory_limit !== '' && strpos(ini_get('disable_functions'), 'ini_set') === false) {
153
    ini_set('memory_limit', $memory_limit);
154
}
155
$max_execution_time = Site::getPreference('MAX_EXECUTION_TIME');
156
if ($max_execution_time !== '' && strpos(ini_get('disable_functions'), 'set_time_limit') === false) {
157
    set_time_limit((int) $max_execution_time);
158
}
159
160
// Sessions
161
Session::start();
162
163
// Note that the database/webservers may not be synchronised, so use DB time throughout.
164
define('WT_TIMESTAMP', DB::select('SELECT UNIX_TIMESTAMP() AS unix_timestamp')[0]->unix_timestamp);
165
166
// Users get their own time-zone. Visitors get the site time-zone.
167
try {
168
    if (Auth::check()) {
169
        date_default_timezone_set(Auth::user()->getPreference('TIMEZONE'));
170
    } else {
171
        date_default_timezone_set(Site::getPreference('TIMEZONE'));
172
    }
173
} catch (ErrorException $exception) {
174
    // Server upgrades and migrations can leave us with invalid timezone settings.
175
    date_default_timezone_set('UTC');
176
}
177
178
define('WT_TIMESTAMP_OFFSET', (new DateTime('now'))->getOffset());
179
180
define('WT_CLIENT_JD', 2440588 + intdiv(WT_TIMESTAMP + WT_TIMESTAMP_OFFSET, 86400));
181
182
// Update the last-login time no more than once a minute
183
if (WT_TIMESTAMP - Session::get('activity_time') >= 60) {
184
    if (Session::get('masquerade') === null) {
185
        Auth::user()->setPreference('sessiontime', (string) WT_TIMESTAMP);
186
    }
187
    Session::put('activity_time', WT_TIMESTAMP);
188
}
189
190
DebugBar::startMeasure('routing');
191
192
try {
193
    // Most requests will need the current tree and user.
194
    $tree = Tree::findByName($request->get('ged')) ?? null;
195
196
    // No tree specified/available?  Choose one.
197
    if ($tree === null && $request->getMethod() === Request::METHOD_GET) {
198
        $tree = Tree::findByName(Site::getPreference('DEFAULT_GEDCOM')) ?? array_values(Tree::getAll())[0] ?? null;
199
    }
200
201
    // Select a locale
202
    define('WT_LOCALE', I18N::init('', $tree));
203
    Session::put('locale', WT_LOCALE);
204
205
    // Most layouts will require a tree for the page header/footer
206
    View::share('tree', $tree);
207
208
    // Load the route and routing table.
209
    $route  = $request->get('route');
210
    $routes = require 'routes/web.php';
211
212
    // Find the controller and action for the selected route
213
    $controller_action = $routes[$request->getMethod() . ':' . $route] ?? 'ErrorController@noRouteFound';
214
    [$controller_name, $action] = explode('@', $controller_action);
215
    $controller_class = '\\Fisharebest\\Webtrees\\Http\\Controllers\\' . $controller_name;
216
217
    app()->instance(Tree::class, $tree);
218
    app()->instance(UserInterface::class, Auth::user());
219
    app()->instance(LocaleInterface::class, WebtreesLocale::create(WT_LOCALE));
220
    app()->instance(TimeoutService::class, new TimeoutService(microtime(true)));
221
    app()->instance(Filesystem::class, $filesystem);
222
223
    $controller = app()->make($controller_class);
224
225
    DebugBar::stopMeasure('routing');
226
227
    DebugBar::startMeasure('init theme');
228
229
    /** @var Collection|ModuleThemeInterface[] $themes */
230
    $themes = app()->make(ModuleService::class)->findByInterface(ModuleThemeInterface::class);
231
232
    // Last theme used?
233
    $theme = $themes->get(Session::get('theme_id', ''));
234
235
    // Default for tree?
236
    if ($theme === null && $tree instanceof Tree) {
237
        $theme = $themes->get($tree->getPreference('THEME_DIR'));
238
    }
239
240
    // Default for site?
241
    if ($theme === null) {
242
        $theme = $themes->get(Site::getPreference('THEME_DIR'));
243
    }
244
245
    // Default
246
    if ($theme === null) {
247
        $theme = app()->make(WebtreesTheme::class);
248
    }
249
250
    // Bind this theme into the container
251
    app()->instance(ModuleThemeInterface::class, $theme);
252
253
    // Remember this setting
254
    Session::put('theme_id', $theme->name());
255
256
    DebugBar::stopMeasure('init theme');
257
258
    // Note that we can't stop this timer, as running the action will
259
    // generate the response - which includes (and stops) the timer
260
    DebugBar::startMeasure('controller_action');
261
262
    $middleware_stack = [
263
        CheckForMaintenanceMode::class,
264
    ];
265
266
    if (class_exists(DebugBar::class)) {
267
        $middleware_stack[] = DebugBarData::class;
268
    }
269
270
    if ($request->getMethod() === Request::METHOD_GET) {
271
        $middleware_stack[] = Housekeeping::class;
272
    }
273
274
    if ($request->getMethod() === Request::METHOD_POST) {
275
        $middleware_stack[] = UseTransaction::class;
276
        $middleware_stack[] = CheckCsrf::class;
277
    }
278
279
    // Apply the middleware using the "onion" pattern.
280
    $pipeline = array_reduce($middleware_stack, function (Closure $next, string $middleware): Closure {
281
        // Create a closure to apply the middleware.
282
        return function (Request $request) use ($middleware, $next): Response {
283
            return app()->make($middleware)->handle($request, $next);
284
        };
285
    }, function (Request $request) use ($controller, $action): Response {
0 ignored issues
show
The parameter $request is not used and could be removed. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-unused  annotation

285
    }, function (/** @scrutinizer ignore-unused */ Request $request) use ($controller, $action): Response {

This check looks for parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
286
        return app()->dispatch($controller, $action);
287
    });
288
289
    $response = call_user_func($pipeline, $request);
290
} catch (Exception $exception) {
291
    $response = (new Handler())->render($request, $exception);
292
}
293
294
// Send response
295
$response->prepare($request)->send();
296