Repository navigation
Expand file tree
/
Copy pathhelper.php
More file actions
331 lines (283 loc) · 8.97 KB
/
Copy pathhelper.php
File metadata and controls
331 lines (283 loc) · 8.97 KB
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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
<?php
use dokuwiki\Extension\Plugin;
/**
* DokuWiki Plugin cleanup (Helper Component)
*
* @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html
* @author Andreas Gohr <gohr@cosmocode.de>
*/
class helper_plugin_cleanup extends Plugin
{
/** @var int log file pointer */
private $log = 0;
/** @var bool do no actually delete */
private $dryrun = true;
/** @var array list of files */
public $list = [];
/** @var int sum of deleted files */
public $size = 0;
/** @var int minimum seconds between two completed scheduled runs */
protected const INTERVAL = 86400;
/** @var int seconds a started scheduled run blocks other scheduled runs */
protected const RUNTIME = 3600;
/**
* Runs the cleanup if no completed run happened in the last INTERVAL seconds
*
* A started run blocks other scheduled runs for RUNTIME seconds. A run that does not complete
* does not count as completed, so it is done again once RUNTIME has passed.
*
* @return bool true if the cleanup was run
*/
public function runScheduled()
{
global $conf;
$finished = $conf['cachedir'] . '/cleanup.run';
$running = $conf['cachedir'] . '/cleanup.running';
$ranat = @filemtime($finished);
if ($ranat && (time() - $ranat) < self::INTERVAL) return false;
$startedat = @filemtime($running);
if ($startedat && (time() - $startedat) < self::RUNTIME) return false;
io_saveFile($running, '');
$this->run(true);
io_saveFile($finished, '');
@unlink($running);
return true;
}
/**
* Runs all the checks
*
* A check is skipped when its maximum age is set to 0.
*
* @param bool $run true to delete the files, false to only list them
*/
public function run($run = false)
{
global $conf;
$data = [];
$this->dryrun = !$run;
@set_time_limit(0);
if ($this->getConf('cacheage')) {
search(
$data,
$conf['cachedir'],
[$this, 'cbCheckCache'],
[
'maxage' => $this->getConf('cacheage'),
'useatime' => $this->supportsatime()
]
);
}
if ($this->getConf('atticage')) {
search(
$data,
$conf['olddir'],
[$this, 'cbCheckAttic'],
[
'maxage' => $this->getConf('atticage'),
'nonexonly' => $this->getConf('atticnoexonly')
]
);
}
if ($this->getConf('mediaatticage')) {
search(
$data,
$conf['mediaolddir'],
[$this, 'cbCheckMediaattic'],
[
'maxage' => $this->getConf('mediaatticage'),
'nonexonly' => $this->getConf('mediaatticnoexonly')
]
);
}
if ($this->getConf('metaage')) {
search(
$data,
$conf['metadir'],
[$this, 'cbCheckMeta'],
[
'maxage' => $this->getConf('metaage'),
]
);
}
if ($this->getConf('mediametaage')) {
search(
$data,
$conf['mediametadir'],
[$this, 'cbCheckMediameta'],
[
'maxage' => $this->getConf('mediametaage'),
]
);
}
if ($this->getConf('lockage')) {
search(
$data,
$conf['lockdir'],
[$this, 'cbCheckLocks'],
[
'maxage' => $this->getConf('lockage'),
]
);
}
}
/**
* Deletes the given file if $this->dryrun isn't set
*
* @param string $file file to delete
* @param string $type type of file to delete
*/
public function delete($file, $type)
{
global $conf;
$size = filesize($file);
$time = time();
// delete the file
if (!$this->dryrun) {
if (@unlink($file)) {
// log to file
if (!$this->log) $this->log = fopen($conf['cachedir'] . '/cleanup.log', 'a');
if ($this->log) {
fwrite($this->log, "$time\t$size\t$type\t$file\n");
}
$this->size += $size;
$this->list[] = $file;
}
} else {
$this->size += $size;
$this->list[] = $file;
}
}
/**
* Checks if the filesystem supports atimes
*
* @return bool
*/
protected function supportsatime()
{
global $conf;
$testfile = $conf['cachedir'] . '/atime';
io_saveFile($testfile, 'x');
$mtime = filemtime($testfile);
sleep(1);
io_readFile($testfile);
clearstatcache(false, $testfile);
$atime = @fileatime($testfile);
@unlink($testfile);
return ($mtime != $atime);
}
/**
* Callback for checking the cache directories
*/
public function cbCheckCache(&$data, $base, $file, $type, $lvl, $opts)
{
if ($type == 'd') {
// we only recurse into our known cache key directories
if ($lvl == 1 && !preg_match('/^\/[a-f0-9]$/', $file)) return false;
return true;
}
if ($lvl == 1) return false; // ignore all files in top directory
$time = $opts['useatime'] ? fileatime($base . $file) : filemtime($base . $file);
if (time() - $time > $opts['maxage']) {
$this->delete($base . $file, 'cache');
}
return true;
}
/**
* Callback for checking the page attic directories
*/
public function cbCheckAttic(&$data, $base, $file, $type, $lvl, $opts)
{
if ($type == 'd') {
return true;
}
$time = filemtime($base . $file);
if (time() - $time > $opts['maxage']) {
// skip existing?
if ($opts['nonexonly']) {
$path = preg_replace('/\.\d+\.txt(\.gz|\.bz2)?$/', '', $file);
$id = pathID($path, true);
if (page_exists($id)) return false;
}
$this->delete($base . $file, 'attic');
}
return true;
}
/**
* Callback for checking the media attic directories
*/
public function cbCheckMediaattic(&$data, $base, $file, $type, $lvl, $opts)
{
if ($type == 'd') {
return true;
}
$time = filemtime($base . $file);
if (time() - $time > $opts['maxage']) {
// skip existing?
if ($opts['nonexonly']) {
[$ext] = mimetype($file);
$ext = preg_quote($ext, '/');
$path = preg_replace('/\.\d+\.' . $ext . '?$/', ".$ext", $file);
$id = pathID($path, true);
if (file_exists(mediaFN($id))) return false;
}
$this->delete($base . $file, 'mediattic');
}
return true;
}
/**
* Callback for checking the page meta directories
*/
public function cbCheckMeta(&$data, $base, $file, $type, $lvl, $opts)
{
if ($type == 'd') {
return true;
}
// only handle known extensions
if (!preg_match('/\.(meta|changes|indexed)$/', $file, $m)) return false;
$type = $m[1];
$time = filemtime($base . $file);
if (time() - $time > $opts['maxage']) {
$path = substr($file, 0, -1 * (strlen($type) + 1));
$id = pathID($path);
if (page_exists($id)) return false;
$this->delete($base . $file, 'meta');
}
return true;
}
/**
* Callback for checking the media meta directories
*/
public function cbCheckMediameta(&$data, $base, $file, $type, $lvl, $opts)
{
if ($type == 'd') {
return true;
}
// only handle known extensions
if (!preg_match('/\.(changes)$/', $file, $m)) return false;
$type = $m[1];
$time = filemtime($base . $file);
if (time() - $time > $opts['maxage']) {
$path = substr($file, 0, -1 * (strlen($type) + 1));
$id = pathID($path);
if (file_exists(mediaFN($id))) return false;
$this->delete($base . $file, 'mediameta');
}
return true;
}
/**
* Callback for checking the locks directories
*/
public function cbCheckLocks(&$data, $base, $file, $type, $lvl, $opts)
{
if ($type == 'd') {
return true;
}
// only handle known extensions
if (!preg_match('/\.(lock)$/', $file, $m)) return false;
$time = filemtime($base . $file);
if (time() - $time > $opts['maxage']) {
$this->delete($base . $file, 'lock');
}
return true;
}
}