Repository navigation
Expand file tree
/
Copy pathFileCache.php
More file actions
executable file
·358 lines (308 loc) · 7.83 KB
/
Copy pathFileCache.php
File metadata and controls
executable file
·358 lines (308 loc) · 7.83 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
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
<?php
/*
* This file is heavily inspired and use code from Composer(getcomposer.org),
* in particular Composer/Cache and Composer/Util/FileSystem from 1.0.0-alpha7
*
* The original code and this file are both released under MIT license.
*
* The copyright holders of the original code are:
* (c) Nils Adermann <naderman@naderman.de>
* Jordi Boggiano <j.boggiano@seld.be>
*/
namespace Terminus;
use Symfony\Component\Finder\Finder;
/**
* Reads/writes to a filesystem cache
*/
class FileCache {
/**
* @var string cache path
*/
protected $root;
/**
* @var bool
*/
protected $enabled = true;
/**
* @var int files time to live
*/
protected $ttl = 36000;
/**
* @var int max total size
*/
protected $maxSize;
/**
* @var string key allowed chars (regex class)
*/
protected $whitelist;
/**
* @param string $cacheDir location of the cache
* @param int $ttl cache files default time to live (expiration)
* @param int $maxSize max total cache size
* @param string $whitelist List of characters that are allowed in path names (used in a regex character class)
*/
public function __construct( $cacheDir, $ttl, $maxSize, $whitelist = 'a-z0-9._-' ) {
$this->root = rtrim( $cacheDir, '/\\' ) . '/';
$this->ttl = (int) $ttl;
$this->maxSize = (int) $maxSize;
$this->whitelist = $whitelist;
if ( !$this->ensure_dir_exists( $this->root ) ) {
$this->enabled = false;
}
}
/**
* Cache is enabled
*
* @return bool
*/
public function is_enabled() {
return $this->enabled;
}
/**
* Cache root
*
* @return string
*/
public function get_root() {
return $this->root;
}
/**
* Check if a file is in cache and return its filename
*
* @param string $key cache key
* @param int $ttl time to live
* @return bool|string filename or false
*/
public function has( $key, $ttl = null ) {
if ( !$this->enabled ) {
return false;
}
$filename = $this->filename( $key );
if ( !file_exists( $filename ) ) {
return false;
}
// use ttl param or global ttl
if ( $ttl === null ) {
$ttl = $this->ttl;
} elseif ( $this->ttl > 0 ) {
$ttl = min( (int) $ttl, $this->ttl );
} else {
$ttl = (int) $ttl;
}
//
if ( $ttl > 0 && filemtime( $filename ) + $ttl < time() ) {
if ( $this->ttl > 0 && $ttl >= $this->ttl ) {
unlink( $filename );
}
return false;
}
return $filename;
}
/**
* Write to cache file
*
* @param string $key cache key
* @param string $contents file contents
* @return bool
*/
public function write( $key, $contents ) {
$filename = $this->prepare_write( $key );
if ( $filename ) {
return file_put_contents( $filename, $contents ) && touch( $filename );
} else {
return false;
}
}
public function put_data( $key, $array ) {
$json = json_encode( $array );
$result = $this->write( $key, $json );
return $result;
}
/**
* Read from cache file
*
* @param string $key cache key
* @param int $ttl time to live
* @return bool|string file contents or false
*/
public function read( $key, $ttl = null ) {
$filename = $this->has( $key, $ttl );
if ( $filename ) {
return file_get_contents( $filename );
} else {
return false;
}
}
public function get_data( $key, $ttl = null ) {
$contents = $this->read( $key, $ttl );
if ( $contents ) {
return json_decode( $contents );
}
else {
return false;
}
}
/**
* Copy a file into the cache
*
* @param string $key cache key
* @param string $source source filename
* @return bool
*/
public function import( $key, $source ) {
$filename = $this->prepare_write( $key );
if ( $filename ) {
return copy( $source, $filename ) && touch( $filename );
} else {
return false;
}
}
/**
* Copy a file out of the cache
*
* @param string $key cache key
* @param string $target target filename
* @param int $ttl time to live
* @return bool
*/
public function export( $key, $target, $ttl = null ) {
$filename = $this->has( $key, $ttl );
if ( $filename ) {
return copy( $filename, $target );
} else {
return false;
}
}
/**
* Remove file from cache
*
* @param string $key cache key
* @return bool
*/
public function remove( $key ) {
if ( !$this->enabled ) {
return false;
}
$filename = $this->filename( $key );
if ( file_exists( $filename ) ) {
return unlink( $filename );
} else {
return false;
}
}
/**
* Clean cache based on time to live and max size
*
* @return bool
*/
public function clean() {
if ( !$this->enabled ) {
return false;
}
$ttl = $this->ttl;
$maxSize = $this->maxSize;
// unlink expired files
if ( $ttl > 0 ) {
$expire = new \DateTime();
$expire->modify( '-' . $ttl . ' seconds' );
$finder = $this->get_finder()->date( 'until ' . $expire->format( 'Y-m-d H:i:s' ) );
foreach ( $finder as $file ) {
unlink( $file->getRealPath() );
}
}
// unlink older files if max cache size is exceeded
if ( $maxSize > 0 ) {
$files = array_reverse( iterator_to_array( $this->get_finder()->sortByAccessedTime()->getIterator() ) );
$total = 0;
foreach ( $files as $file ) {
if ( $total + $file->getSize() <= $maxSize ) {
$total += $file->getSize();
} else {
unlink( $file->getRealPath() );
}
}
}
return true;
}
/**
* Ensure directory exists
*
* @param string $dir directory
* @return bool
*/
protected function ensure_dir_exists( $dir ) {
if ( !is_dir( $dir ) ) {
if ( file_exists( $dir ) ) {
// exists and not a dir
return false;
}
if ( !@mkdir( $dir, 0777, true ) ) {
return false;
}
}
return true;
}
/**
* Prepare cache write
*
* @param string $key cache key
* @return bool|string filename or false
*/
protected function prepare_write( $key ) {
if ( !$this->enabled ) {
return false;
}
$filename = $this->filename( $key );
if ( !$this->ensure_dir_exists( dirname( $filename ) ) ) {
return false;
}
return $filename;
}
/**
* Validate cache key
*
* @param string $key cache key
* @return string relative filename
*/
protected function validate_key( $key ) {
$url_parts = parse_url( $key );
if ( ! empty($url_parts['scheme']) ) { // is url
$parts = array('misc');
$parts[] = $url_parts['scheme'] . '-' . @$url_parts['host'] .
( empty( $url_parts['port'] ) ? '' : '-' . $url_parts['port'] );
$parts[] = substr($url_parts['path'], 1) .
( empty( $url_parts['query'] ) ? '' : '-' . $url_parts['query'] );
} else {
$key = str_replace( '\\', '/', $key );
$parts = explode( '/', ltrim( $key ) );
}
$parts = preg_replace( "#[^{$this->whitelist}]#i", '-', $parts );
return implode( '/', $parts );
}
/**
* Filename from key
*
* @param string $key
* @return string filename
*/
protected function filename( $key ){
return $this->root . $this->validate_key( $key );
}
/**
* Get a Finder that iterates in cache root only the files
*
* @return Finder
*/
public function get_finder() {
return Finder::create()->in( $this->root )->files();
}
public function flush($cache=null,$exclude=null) {
$finder = $this->get_finder();
foreach( $finder as $file ) {
// if a cache to clear was specified skip those that don't match
if ($cache AND $cache != $file->getFilename() ) continue;
if ($exclude AND $exclude == $file->getFilename()) continue;
unlink($file->getRealPath());
}
}
}