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
|
<?php
/**
* webtrees: online genealogy
* Copyright (C) 2025 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\Http\Middleware;
use Fig\Http\Message\RequestMethodInterface;
use Fisharebest\Webtrees\Registry;
use Fisharebest\Webtrees\Services\HousekeepingService;
use League\Flysystem\FilesystemOperator;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\MiddlewareInterface;
use Psr\Http\Server\RequestHandlerInterface;
/**
* Run the housekeeping service at irregular intervals.
*/
class DoHousekeeping implements MiddlewareInterface
{
// Delete old thumbnails after 90 days.
private const string THUMBNAIL_DIR = 'thumbnail-cache';
private const int MAX_THUMBNAIL_AGE = 60 * 60 * 24 * 90;
// Delete files in /data/tmp after 1 hour.
private const string TMP_DIR = 'data/tmp';
private const int MAX_TMP_FILE_AGE = 60 * 60;
// Delete error logs after 90 days.
private const int MAX_LOG_AGE = 60 * 60 * 24 * 90;
// Delete inactive sessions after 1 day.
private const int MAX_SESSION_AGE = 60 * 60 * 24;
// Run the cleanup every N requests.
private const int PROBABILITY = 250;
private HousekeepingService $housekeeping_service;
/**
* @param HousekeepingService $housekeeping_service
*/
public function __construct(HousekeepingService $housekeeping_service)
{
$this->housekeeping_service = $housekeeping_service;
}
/**
* @param ServerRequestInterface $request
* @param RequestHandlerInterface $handler
*
* @return ResponseInterface
*/
public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
{
$response = $handler->handle($request);
// Run the cleanup after random page requests.
if ($request->getMethod() === RequestMethodInterface::METHOD_GET && random_int(1, self::PROBABILITY) === 1) {
$this->runHousekeeping(Registry::filesystem()->data(), Registry::filesystem()->root());
}
return $response;
}
/**
* Run the various housekeeping services.
*
* @param FilesystemOperator $data_filesystem
* @param FilesystemOperator $root_filesystem
*
* @return void
*/
private function runHousekeeping(FilesystemOperator $data_filesystem, FilesystemOperator $root_filesystem): void
{
// Clear old thumbnails
$this->housekeeping_service->deleteOldFiles($data_filesystem, self::THUMBNAIL_DIR, self::MAX_THUMBNAIL_AGE);
// Clear temporary files
$this->housekeeping_service->deleteOldFiles($root_filesystem, self::TMP_DIR, self::MAX_TMP_FILE_AGE);
// Clear entries in database tables
$this->housekeeping_service->deleteOldLogs(self::MAX_LOG_AGE);
$this->housekeeping_service->deleteOldSessions(self::MAX_SESSION_AGE);
}
}
|
