-
-
Notifications
You must be signed in to change notification settings - Fork 15
/
FilesystemOptions.php
455 lines (386 loc) · 11 KB
/
FilesystemOptions.php
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
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
<?php
declare(strict_types=1);
namespace Laminas\Cache\Storage\Adapter;
use Laminas\Cache\Exception;
use Traversable;
use function assert;
use function is_dir;
use function is_readable;
use function is_string;
use function is_writable;
use function octdec;
use function realpath;
use function rtrim;
use function stripos;
use function strlen;
use function sys_get_temp_dir;
use const DIRECTORY_SEPARATOR;
use const PHP_OS;
final class FilesystemOptions extends AdapterOptions
{
public const KEY_PATTERN = '/^[a-z0-9_\+\-]*$/Di';
/**
* Directory to store cache files
*
* @var string|null The cache directory
*/
private ?string $cacheDir = null;
/**
* Call clearstatcache enabled?
*/
private bool $clearStatCache = true;
/**
* How much sub-directaries should be created?
*/
private int $dirLevel = 1;
/**
* Permission creating new directories
*
* @var false|int
*/
private $dirPermission = 0700;
/**
* Lock files on writing
*/
private bool $fileLocking = true;
/**
* Permission creating new files
*
* @var false|int
*/
private $filePermission = 0600;
/**
* Overwrite default key pattern
*
* @var string
*/
protected $keyPattern = self::KEY_PATTERN;
/**
* Namespace separator
*/
private string $namespaceSeparator = '-';
/**
* Don't get 'fileatime' as 'atime' on metadata
*/
private bool $noAtime = true;
/**
* Don't get 'filectime' as 'ctime' on metadata
*/
private bool $noCtime = true;
/**
* Umask to create files and directories
*
* @var false|int
*/
private $umask = false;
/**
* Suffix for cache files
*/
private string $suffix = 'dat';
/**
* Suffix for tag files
*/
private string $tagSuffix = 'tag';
/**
* @param array|Traversable|null $options
*/
public function __construct($options = null)
{
// disable file/directory permissions by default on windows systems
if (stripos(PHP_OS, 'WIN') === 0) {
$this->filePermission = false;
$this->dirPermission = false;
}
$this->setCacheDir(null);
parent::__construct($options);
}
/**
* @throws Exception\InvalidArgumentException
*/
public function setCacheDir(?string $cacheDir): self
{
$cacheDir ??= sys_get_temp_dir();
$cacheDir = $this->normalizeCacheDirectory($cacheDir);
if ($this->cacheDir === $cacheDir) {
return $this;
}
$this->triggerOptionEvent('cache_dir', $cacheDir);
$this->cacheDir = $cacheDir;
return $this;
}
public function getCacheDir(): string
{
assert(is_string($this->cacheDir));
return $this->cacheDir;
}
public function setClearStatCache(bool $clearStatCache): self
{
if ($this->clearStatCache === $clearStatCache) {
return $this;
}
$this->triggerOptionEvent('clear_stat_cache', $clearStatCache);
$this->clearStatCache = $clearStatCache;
return $this;
}
public function getClearStatCache(): bool
{
return $this->clearStatCache;
}
/**
* @throws Exception\InvalidArgumentException
*/
public function setDirLevel(int $dirLevel): self
{
if ($dirLevel < 0 || $dirLevel > 16) {
throw new Exception\InvalidArgumentException(
"Directory level '{$dirLevel}' must be between 0 and 16"
);
}
if ($this->dirLevel === $dirLevel) {
return $this;
}
$this->triggerOptionEvent('dir_level', $dirLevel);
$this->dirLevel = $dirLevel;
return $this;
}
public function getDirLevel(): int
{
return $this->dirLevel;
}
/**
* Set permission to create directories on unix systems
*
* @link http://php.net/manual/function.chmod.php
* @see FilesystemOptions::setUmask
* @see FilesystemOptions::setFilePermission
*
* @param false|string|int $dirPermission FALSE to disable explicit permission or an octal number
*/
public function setDirPermission($dirPermission): self
{
if ($dirPermission !== false) {
if (is_string($dirPermission)) {
$dirPermission = octdec($dirPermission);
} else {
$dirPermission = (int) $dirPermission;
}
// validate
if (($dirPermission & 0700) !== 0700) {
throw new Exception\InvalidArgumentException(
'Invalid directory permission: need permission to execute, read and write by owner'
);
}
}
if ($this->dirPermission === $dirPermission) {
return $this;
}
$this->triggerOptionEvent('dir_permission', $dirPermission);
$this->dirPermission = $dirPermission;
return $this;
}
/**
* Get permission to create directories on unix systems
*
* @return false|int
*/
public function getDirPermission()
{
return $this->dirPermission;
}
public function setFileLocking(bool $fileLocking): self
{
$this->triggerOptionEvent('file_locking', $fileLocking);
$this->fileLocking = $fileLocking;
return $this;
}
public function getFileLocking(): bool
{
return $this->fileLocking;
}
/**
* Set permission to create files on unix systems
*
* @link http://php.net/manual/function.chmod.php
* @see FilesystemOptions::setUmask
* @see FilesystemOptions::setDirPermission
*
* @param false|string|int $filePermission FALSE to disable explicit permission or an octal number
*/
public function setFilePermission($filePermission): self
{
if ($filePermission !== false) {
if (is_string($filePermission)) {
$filePermission = octdec($filePermission);
} else {
$filePermission = (int) $filePermission;
}
// validate
if (($filePermission & 0600) !== 0600) {
throw new Exception\InvalidArgumentException(
'Invalid file permission: need permission to read and write by owner'
);
} elseif ($filePermission & 0111) {
throw new Exception\InvalidArgumentException(
"Invalid file permission: Cache files shouldn't be executable"
);
}
}
if ($this->filePermission === $filePermission) {
return $this;
}
$this->triggerOptionEvent('file_permission', $filePermission);
$this->filePermission = $filePermission;
return $this;
}
/**
* Get permission to create files on unix systems
*
* @return false|int
*/
public function getFilePermission()
{
return $this->filePermission;
}
/**
* @param string $namespace
*/
public function setNamespace($namespace): self
{
if (strlen($namespace) >= 250) {
throw new Exception\InvalidArgumentException('Provided namespace is too long.');
}
parent::setNamespace($namespace);
return $this;
}
public function setNamespaceSeparator(string $namespaceSeparator): self
{
$this->triggerOptionEvent('namespace_separator', $namespaceSeparator);
$this->namespaceSeparator = $namespaceSeparator;
return $this;
}
public function getNamespaceSeparator(): string
{
return $this->namespaceSeparator;
}
public function setNoAtime(bool $noAtime): self
{
if ($this->noAtime === $noAtime) {
return $this;
}
$this->triggerOptionEvent('no_atime', $noAtime);
$this->noAtime = $noAtime;
return $this;
}
public function getNoAtime(): bool
{
return $this->noAtime;
}
public function setNoCtime(bool $noCtime): self
{
if ($this->noCtime === $noCtime) {
return $this;
}
$this->triggerOptionEvent('no_ctime', $noCtime);
$this->noCtime = $noCtime;
return $this;
}
public function getNoCtime(): bool
{
return $this->noCtime;
}
/**
* Set the umask to create files and directories on unix systems
*
* Note: On multithreaded webservers it's better to explicit set file and dir permission.
*
* @link http://php.net/manual/function.umask.php
* @link http://en.wikipedia.org/wiki/Umask
* @see FilesystemOptions::setFilePermission
* @see FilesystemOptions::setDirPermission
*
* @param false|string|int $umask false to disable umask or an octal number
*/
public function setUmask($umask): self
{
if ($umask !== false) {
if (is_string($umask)) {
$umask = octdec($umask);
} else {
$umask = (int) $umask;
}
// validate
if ($umask & 0700) {
throw new Exception\InvalidArgumentException(
'Invalid umask: need permission to execute, read and write by owner'
);
}
// normalize
$umask &= ~0002;
}
if ($this->umask === $umask) {
return $this;
}
$this->triggerOptionEvent('umask', $umask);
$this->umask = $umask;
return $this;
}
/**
* Get the umask to create files and directories on unix systems
*
* @return false|int
*/
public function getUmask()
{
return $this->umask;
}
/**
* Get the suffix for cache files
*/
public function getSuffix(): string
{
return $this->suffix;
}
/**
* Set the suffix for cache files
*/
public function setSuffix(string $suffix): self
{
$this->suffix = $suffix;
return $this;
}
/**
* Get the suffix for tag files
*/
public function getTagSuffix(): string
{
return $this->tagSuffix;
}
/**
* Set the suffix for cache files
*/
public function setTagSuffix(string $tagSuffix): self
{
$this->tagSuffix = $tagSuffix;
return $this;
}
/**
* @throws Exception\InvalidArgumentException
*/
private function normalizeCacheDirectory(string $cacheDir): string
{
if (! is_dir($cacheDir)) {
throw new Exception\InvalidArgumentException(
"Cache directory '{$cacheDir}' not found or not a directory"
);
} elseif (! is_writable($cacheDir)) {
throw new Exception\InvalidArgumentException(
"Cache directory '{$cacheDir}' not writable"
);
} elseif (! is_readable($cacheDir)) {
throw new Exception\InvalidArgumentException(
"Cache directory '{$cacheDir}' not readable"
);
}
return rtrim(realpath($cacheDir), DIRECTORY_SEPARATOR);
}
}