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
|
<?php
/**
* ElggFileCache
* Store cached data in a file store.
*
* @package Elgg.Core
* @subpackage Caches
*/
class ElggFileCache extends ElggCache {
/**
* Set the Elgg cache.
*
* @param string $cache_path The cache path.
* @param int $max_age Maximum age in seconds, 0 if no limit.
* @param int $max_size Maximum size of cache in seconds, 0 if no limit.
*/
function __construct($cache_path, $max_age = 0, $max_size = 0) {
$this->setVariable("cache_path", $cache_path);
$this->setVariable("max_age", $max_age);
$this->setVariable("max_size", $max_size);
if ($cache_path == "") {
throw new ConfigurationException(elgg_echo('ConfigurationException:NoCachePath'));
}
}
/**
* Create and return a handle to a file.
*
* @deprecated 1.8 Use ElggFileCache::createFile()
*
* @param string $filename Filename to save as
* @param string $rw Write mode
*
* @return mixed
*/
protected function create_file($filename, $rw = "rb") {
elgg_deprecated_notice('ElggFileCache::create_file() is deprecated by ::createFile()', 1.8);
return $this->createFile($filename, $rw);
}
/**
* Create and return a handle to a file.
*
* @param string $filename Filename to save as
* @param string $rw Write mode
*
* @return mixed
*/
protected function createFile($filename, $rw = "rb") {
// Create a filename matrix
$matrix = "";
$depth = strlen($filename);
if ($depth > 5) {
$depth = 5;
}
// Create full path
$path = $this->getVariable("cache_path") . $matrix;
if (!is_dir($path)) {
mkdir($path, 0700, true);
}
// Open the file
if ((!file_exists($path . $filename)) && ($rw == "rb")) {
return false;
}
return fopen($path . $filename, $rw);
}
/**
* Create a sanitised filename for the file.
*
* @deprecated 1.8 Use ElggFileCache::sanitizeFilename()
*
* @param string $filename The filename
*
* @return string
*/
protected function sanitise_filename($filename) {
// @todo : Writeme
return $filename;
}
/**
* Create a sanitised filename for the file.
*
* @param string $filename The filename
*
* @return string
*/
protected function sanitizeFilename($filename) {
// @todo : Writeme
return $filename;
}
/**
* Save a key
*
* @param string $key Name
* @param string $data Value
*
* @return boolean
*/
public function save($key, $data) {
$f = $this->createFile($this->sanitizeFilename($key), "wb");
if ($f) {
$result = fwrite($f, $data);
fclose($f);
return $result;
}
return false;
}
/**
* Load a key
*
* @param string $key Name
* @param int $offset Offset
* @param int $limit Limit
*
* @return string
*/
public function load($key, $offset = 0, $limit = null) {
$f = $this->createFile($this->sanitizeFilename($key));
if ($f) {
if (!$limit) {
$limit = -1;
}
$data = stream_get_contents($f, $limit, $offset);
fclose($f);
return $data;
}
return false;
}
/**
* Invalidate a given key.
*
* @param string $key Name
*
* @return bool
*/
public function delete($key) {
$dir = $this->getVariable("cache_path");
if (file_exists($dir . $key)) {
return unlink($dir . $key);
}
return TRUE;
}
/**
* This was probably meant to delete everything?
*
* @return void
*/
public function clear() {
// @todo writeme
}
/**
* Preform cleanup and invalidates cache upon object destruction
*
* @throws IOException
*/
public function __destruct() {
// @todo Check size and age, clean up accordingly
$size = 0;
$dir = $this->getVariable("cache_path");
// Short circuit if both size and age are unlimited
if (($this->getVariable("max_age") == 0) && ($this->getVariable("max_size") == 0)) {
return;
}
$exclude = array(".","..");
$files = scandir($dir);
if (!$files) {
throw new IOException(sprintf(elgg_echo('IOException:NotDirectory'), $dir));
}
// Perform cleanup
foreach ($files as $f) {
if (!in_array($f, $exclude)) {
$stat = stat($dir . $f);
// Add size
$size .= $stat['size'];
// Is this older than my maximum date?
if (($this->getVariable("max_age") > 0) && (time() - $stat['mtime'] > $this->getVariable("max_age"))) {
unlink($dir . $f);
}
// @todo Size
}
}
}
}
|
