xref: /webtrees/app/Http/Middleware/DoHousekeeping.php (revision 81de533683c82a9e5c2bf2de336b47c4103fda6d) 
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\Http\Middleware;
21
22use Fig\Http\Message\RequestMethodInterface;
23use Fisharebest\Webtrees\Services\HousekeepingService;
24use League\Flysystem\FilesystemInterface;
25use Psr\Http\Message\ResponseInterface;
26use Psr\Http\Message\ServerRequestInterface;
27use Psr\Http\Server\MiddlewareInterface;
28use Psr\Http\Server\RequestHandlerInterface;
29
30use function assert;
31
32/**
33 * Run the housekeeping service at irregular intervals.
34 */
35class DoHousekeeping implements MiddlewareInterface
36{
37    // Delete cache files after 1 hour.
38    private const MAX_CACHE_AGE = 60 * 60;
39
40    // Delete thumnnails after 90 days.
41    private const MAX_THUMBNAIL_AGE = 60 * 60 * 24 * 90;
42
43    // Delete files in /data/tmp after 1 hour.
44    private const TMP_DIR          = 'data/tmp';
45    private const MAX_TMP_FILE_AGE = 60 * 60;
46
47    // Delete error logs after 90 days.
48    private const MAX_LOG_AGE = 60 * 60 * 24 * 90;
49
50    // Delete inactive sessions after 1 day.
51    private const MAX_SESSION_AGE = 60 * 60 * 24;
52
53    // Run the cleanup every 100 requests.
54    private const PROBABILITY = 100;
55
56    /** @var HousekeepingService */
57    private $housekeeping_service;
58
59    /**
60     * Housekeeping constructor.
61     *
62     * @param HousekeepingService $housekeeping_service
63     */
64    public function __construct(HousekeepingService $housekeeping_service)
65    {
66        $this->housekeeping_service = $housekeeping_service;
67    }
68
69    /**
70     * @param ServerRequestInterface  $request
71     * @param RequestHandlerInterface $handler
72     *
73     * @return ResponseInterface
74     */
75    public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
76    {
77        $data_filesystem = $request->getAttribute('filesystem.data');
78        assert($data_filesystem instanceof FilesystemInterface);
79
80        $root_filesystem = $request->getAttribute('filesystem.root');
81        assert($root_filesystem instanceof FilesystemInterface);
82
83        $response = $handler->handle($request);
84
85        // Run the cleanup after random page requests.
86        if ($request->getMethod() === RequestMethodInterface::METHOD_GET && random_int(1, self::PROBABILITY) === 1) {
87            $this->runHousekeeping($data_filesystem, $root_filesystem);
88        }
89
90        return $response;
91    }
92
93    /**
94     * Run the various housekeeping services.
95     *
96     * @param FilesystemInterface $data_filesystem
97     * @param FilesystemInterface $root_filesystem
98     *
99     * @return void
100     */
101    private function runHousekeeping(FilesystemInterface $data_filesystem, FilesystemInterface $root_filesystem): void
102    {
103        // Clear files in the (user-specified) data folder - which might not be local files
104        $this->housekeeping_service->deleteOldFiles($data_filesystem, 'cache', self::MAX_CACHE_AGE);
105
106        $this->housekeeping_service->deleteOldFiles($data_filesystem, 'thumbnail-cache', self::MAX_THUMBNAIL_AGE);
107
108        // Clear files in /data - which need to be local files
109        $this->housekeeping_service->deleteOldFiles($root_filesystem, self::TMP_DIR, self::MAX_TMP_FILE_AGE);
110
111        // Clear entries in database tables
112        $this->housekeeping_service->deleteOldLogs(self::MAX_LOG_AGE);
113
114        $this->housekeeping_service->deleteOldSessions(self::MAX_SESSION_AGE);
115    }
116}
117