/
FileStorage.php
411 lines (329 loc) · 9.71 KB
/
FileStorage.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
<?php
/**
* Nette Framework
*
* Copyright (c) 2004, 2009 David Grudl (http://davidgrudl.com)
*
* This source file is subject to the "Nette license" that is bundled
* with this package in the file license.txt.
*
* For more information please see http://nettephp.com
*
* @copyright Copyright (c) 2004, 2009 David Grudl
* @license http://nettephp.com/license Nette license
* @link http://nettephp.com
* @category Nette
* @package Nette\Caching
*/
/*namespace Nette\Caching;*/
require_once dirname(__FILE__) . '/../Object.php';
require_once dirname(__FILE__) . '/../Caching/ICacheStorage.php';
/**
* Cache file storage.
*
* @author David Grudl
* @copyright Copyright (c) 2004, 2009 David Grudl
* @package Nette\Caching
*/
class FileStorage extends /*Nette\*/Object implements ICacheStorage
{
/**
* Atomic thread safe logic:
*
* 1) reading: open(r+b), lock(SH), read
* - delete?: delete*, close
* 2) deleting: open(r+b), delete*, close
* 3) writing: open(r+b || wb), lock(EX), truncate*, write data, write meta, close
*
* delete* = lock(EX), try unlink, if fails (on NTFS) { truncate, close, unlink } else close (on ext3)
*/
/**#@+ internal cache file structure */
const META_HEADER_LEN = 28; // 22b signature + 6b meta-struct size + serialized meta-struct + data
// meta structure: array of
const META_TIME = 'time'; // timestamp
const META_SERIALIZED = 'serialized'; // is content serialized?
const META_PRIORITY = 'priority'; // priority
const META_EXPIRE = 'expire'; // expiration timestamp
const META_DELTA = 'delta'; // relative (sliding) expiration
const META_ITEMS = 'di'; // array of dependent items (file => timestamp)
const META_TAGS = 'tags'; // array of tags (tag => [foo])
const META_CALLBACKS = 'callbacks'; // array of callbacks (function, args)
/**#@-*/
/**#@+ additional cache structure */
const FILE = 'file';
const HANDLE = 'handle';
/**#@-*/
/** @var float probability that the clean() routine is started */
public static $gcProbability = 0.001;
/** @var bool */
public static $useDirectories;
/** @var string */
private $dir;
/** @var bool */
private $useDirs;
public function __construct($dir)
{
if (self::$useDirectories === NULL) {
self::$useDirectories = !ini_get('safe_mode');
// checks whether directory is writable
$uniq = uniqid();
umask(0000);
if (!@mkdir("$dir/$uniq", 0777)) { // intentionally @
throw new /*\*/InvalidStateException("Unable to write to directory '$dir'. Make this directory writable.");
}
// tests subdirectory mode
if (!self::$useDirectories && @file_put_contents("$dir/$uniq/_", '') !== FALSE) { // intentionally @
self::$useDirectories = TRUE;
unlink("$dir/$uniq/_");
}
rmdir("$dir/$uniq");
}
$this->dir = $dir;
$this->useDirs = (bool) self::$useDirectories;
if (mt_rand() / mt_getrandmax() < self::$gcProbability) {
$this->clean(array());
}
}
/**
* Read from cache.
* @param string key
* @return mixed|NULL
*/
public function read($key)
{
$meta = $this->readMeta($this->getCacheFile($key), LOCK_SH);
if ($meta && $this->verify($meta)) {
return $this->readData($meta); // calls fclose()
} else {
return NULL;
}
}
/**
* Verifies dependencies.
* @param array
* @return bool
*/
private function verify($meta)
{
do {
if (!empty($meta[self::META_DELTA])) {
// meta[file] was added by readMeta()
if (filemtime($meta[self::FILE]) + $meta[self::META_DELTA] < time()) break;
touch($meta[self::FILE]);
} elseif (!empty($meta[self::META_EXPIRE]) && $meta[self::META_EXPIRE] < time()) {
break;
}
if (!empty($meta[self::META_CALLBACKS]) && !Cache::checkCallbacks($meta[self::META_CALLBACKS])) {
break;
}
if (!empty($meta[self::META_ITEMS])) {
foreach ($meta[self::META_ITEMS] as $depFile => $time) {
$m = $this->readMeta($depFile, LOCK_SH);
if ($m[self::META_TIME] !== $time) break 2;
if ($m && !$this->verify($m)) break 2;
}
}
return TRUE;
} while (FALSE);
$this->delete($meta[self::HANDLE], $meta[self::FILE]); // meta[handle] & meta[file] was added by readMeta()
return FALSE;
}
/**
* Writes item into the cache.
* @param string key
* @param mixed data
* @param array dependencies
* @return bool TRUE if no problem
*/
public function write($key, $data, array $dp)
{
$meta = array(
self::META_TIME => microtime(),
);
if (!is_string($data)) {
$data = serialize($data);
$meta[self::META_SERIALIZED] = TRUE;
}
if (isset($dp[Cache::PRIORITY])) {
$meta[self::META_PRIORITY] = (int) $dp[Cache::PRIORITY];
}
if (!empty($dp[Cache::EXPIRE])) {
if (empty($dp[Cache::SLIDING])) {
$meta[self::META_EXPIRE] = $dp[Cache::EXPIRE] + time(); // absolute time
} else {
$meta[self::META_DELTA] = (int) $dp[Cache::EXPIRE]; // sliding time
}
}
if (!empty($dp[Cache::TAGS])) {
$meta[self::META_TAGS] = array_flip(array_values((array) $dp[Cache::TAGS]));
}
if (!empty($dp[Cache::ITEMS])) {
foreach ((array) $dp[Cache::ITEMS] as $item) {
$depFile = $this->getCacheFile($item);
$m = $this->readMeta($depFile, LOCK_SH);
$meta[self::META_ITEMS][$depFile] = $m[self::META_TIME];
unset($m);
}
}
if (!empty($dp[Cache::CALLBACKS])) {
$meta[self::META_CALLBACKS] = $dp[Cache::CALLBACKS];
}
$cacheFile = $this->getCacheFile($key);
if ($this->useDirs && !is_dir($dir = dirname($cacheFile))) {
umask(0000);
if (!mkdir($dir, 0777, TRUE)) {
return FALSE;
}
}
$handle = @fopen($cacheFile, 'r+b'); // intentionally @
if (!$handle) {
$handle = fopen($cacheFile, 'wb'); // intentionally @
if (!$handle) {
return FALSE;
}
}
flock($handle, LOCK_EX);
ftruncate($handle, 0);
$head = serialize($meta) . '?>';
$head = '<?php //netteCache[01]' . str_pad((string) strlen($head), 6, '0', STR_PAD_LEFT) . $head;
$headLen = strlen($head);
$dataLen = strlen($data);
if (fwrite($handle, str_repeat("\x00", $headLen), $headLen) === $headLen) {
if (fwrite($handle, $data, $dataLen) === $dataLen) {
fseek($handle, 0);
if (fwrite($handle, $head, $headLen) === $headLen) {
fclose($handle);
return TRUE;
}
}
}
$this->delete($handle, $cacheFile);
return TRUE;
}
/**
* Removes item from the cache.
* @param string key
* @return bool TRUE if no problem
*/
public function remove($key)
{
$cacheFile = $this->getCacheFile($key);
$meta = $this->readMeta($cacheFile, LOCK_EX);
if ($meta) {
$this->delete($meta[self::HANDLE], $cacheFile);
}
return TRUE;
}
/**
* Removes items from the cache by conditions & garbage collector.
* @param array conditions
* @return bool TRUE if no problem
*/
public function clean(array $conds)
{
$tags = isset($conds[Cache::TAGS]) ? array_flip((array) $conds[Cache::TAGS]) : array();
$priority = isset($conds[Cache::PRIORITY]) ? $conds[Cache::PRIORITY] : -1;
$all = !empty($conds[Cache::ALL]);
$now = time();
$base = $this->dir . DIRECTORY_SEPARATOR . 'c';
$iterator = new /*\*/RecursiveIteratorIterator(new /*\*/RecursiveDirectoryIterator($this->dir), /*\*/RecursiveIteratorIterator::CHILD_FIRST);
foreach ($iterator as $entry) {
if (strncmp($entry, $base, strlen($base))) {
continue;
}
if ($entry->isDir()) {
@rmdir((string) $entry); // intentionally @
continue;
}
do {
$meta = $this->readMeta((string) $entry, LOCK_SH);
if (!$meta || $all) continue 2;
if (!empty($meta[self::META_EXPIRE]) && $meta[self::META_EXPIRE] < $now) {
break;
}
if (!empty($meta[self::META_PRIORITY]) && $meta[self::META_PRIORITY] <= $priority) {
break;
}
if (!empty($meta[self::META_TAGS]) && array_intersect_key($tags, $meta[self::META_TAGS])) {
break;
}
fclose($meta[self::HANDLE]);
continue 2;
} while (FALSE);
$this->delete($meta[self::HANDLE], (string) $entry);
}
return TRUE;
}
/**
* Reads cache data from disk.
* @param string file path
* @param int lock mode
* @return array|NULL
*/
protected function readMeta($file, $lock)
{
$handle = @fopen($file, 'r+b'); // intentionally @
if (!$handle) return NULL;
flock($handle, $lock);
$head = stream_get_contents($handle, self::META_HEADER_LEN);
if ($head && strlen($head) === self::META_HEADER_LEN) {
$size = (int) substr($head, -6);
$meta = stream_get_contents($handle, $size, self::META_HEADER_LEN);
$meta = @unserialize($meta); // intentionally @
if (is_array($meta)) {
fseek($handle, $size + self::META_HEADER_LEN); // needed by PHP < 5.2.6
$meta[self::FILE] = $file;
$meta[self::HANDLE] = $handle;
return $meta;
}
}
fclose($handle);
return NULL;
}
/**
* Reads cache data from disk and closes cache file handle.
* @param array
* @return mixed
*/
protected function readData($meta)
{
$data = stream_get_contents($meta[self::HANDLE]);
fclose($meta[self::HANDLE]);
if (empty($meta[self::META_SERIALIZED])) {
return $data;
} else {
return @unserialize($data); // intentionally @
}
}
/**
* Returns file name.
* @param string
* @return string
*/
protected function getCacheFile($key)
{
if ($this->useDirs) {
$key = explode(Cache::NAMESPACE_SEPARATOR, $key, 2);
return $this->dir . '/c' . (isset($key[1]) ? '-' . urlencode($key[0]) . '/_' . urlencode($key[1]) : '_' . urlencode($key[0]));
} else {
return $this->dir . '/c_' . urlencode($key);
}
}
/**
* Deletes and closes file.
* @param resource
* @param string
* @return void
*/
private static function delete($handle, $file)
{
if (@unlink($file)) { // intentionally @
fclose($handle);
} else {
flock($handle, LOCK_EX);
ftruncate($handle, 0);
fclose($handle);
@unlink($file); // intentionally @; not atomic
}
}
}