3 class HTMLPurifier_DefinitionCache_Serializer extends HTMLPurifier_DefinitionCache
7 * @param HTMLPurifier_Definition $def
8 * @param HTMLPurifier_Config $config
11 public function add($def, $config)
13 if (!$this->checkDefType($def)) {
16 $file = $this->generateFilePath($config);
17 if (file_exists($file)) {
20 if (!$this->_prepareDir($config)) {
23 return $this->_write($file, serialize($def), $config);
27 * @param HTMLPurifier_Definition $def
28 * @param HTMLPurifier_Config $config
31 public function set($def, $config)
33 if (!$this->checkDefType($def)) {
36 $file = $this->generateFilePath($config);
37 if (!$this->_prepareDir($config)) {
40 return $this->_write($file, serialize($def), $config);
44 * @param HTMLPurifier_Definition $def
45 * @param HTMLPurifier_Config $config
48 public function replace($def, $config)
50 if (!$this->checkDefType($def)) {
53 $file = $this->generateFilePath($config);
54 if (!file_exists($file)) {
57 if (!$this->_prepareDir($config)) {
60 return $this->_write($file, serialize($def), $config);
64 * @param HTMLPurifier_Config $config
65 * @return bool|HTMLPurifier_Config
67 public function get($config)
69 $file = $this->generateFilePath($config);
70 if (!file_exists($file)) {
73 return unserialize(file_get_contents($file));
77 * @param HTMLPurifier_Config $config
80 public function remove($config)
82 $file = $this->generateFilePath($config);
83 if (!file_exists($file)) {
90 * @param HTMLPurifier_Config $config
93 public function flush($config)
95 if (!$this->_prepareDir($config)) {
98 $dir = $this->generateDirectoryPath($config);
100 // Apparently, on some versions of PHP, readdir will return
101 // an empty string if you pass an invalid argument to readdir.
102 // So you need this test. See #49.
106 while (false !== ($filename = readdir($dh))) {
107 if (empty($filename)) {
110 if ($filename[0] === '.') {
113 unlink($dir . '/' . $filename);
120 * @param HTMLPurifier_Config $config
123 public function cleanup($config)
125 if (!$this->_prepareDir($config)) {
128 $dir = $this->generateDirectoryPath($config);
130 // See #49 (and above).
134 while (false !== ($filename = readdir($dh))) {
135 if (empty($filename)) {
138 if ($filename[0] === '.') {
141 $key = substr($filename, 0, strlen($filename) - 4);
142 if ($this->isOld($key, $config)) {
143 unlink($dir . '/' . $filename);
151 * Generates the file path to the serial file corresponding to
152 * the configuration and definition name
153 * @param HTMLPurifier_Config $config
155 * @todo Make protected
157 public function generateFilePath($config)
159 $key = $this->generateKey($config);
160 return $this->generateDirectoryPath($config) . '/' . $key . '.ser';
164 * Generates the path to the directory contain this cache's serial files
165 * @param HTMLPurifier_Config $config
167 * @note No trailing slash
168 * @todo Make protected
170 public function generateDirectoryPath($config)
172 $base = $this->generateBaseDirectoryPath($config);
173 return $base . '/' . $this->type;
177 * Generates path to base directory that contains all definition type
179 * @param HTMLPurifier_Config $config
180 * @return mixed|string
181 * @todo Make protected
183 public function generateBaseDirectoryPath($config)
185 $base = $config->get('Cache.SerializerPath');
186 $base = is_null($base) ? HTMLPURIFIER_PREFIX . '/HTMLPurifier/DefinitionCache/Serializer' : $base;
191 * Convenience wrapper function for file_put_contents
192 * @param string $file File name to write to
193 * @param string $data Data to write into file
194 * @param HTMLPurifier_Config $config
195 * @return int|bool Number of bytes written if success, or false if failure.
197 private function _write($file, $data, $config)
199 $result = file_put_contents($file, $data);
200 if ($result !== false) {
201 // set permissions of the new file (no execute)
202 $chmod = $config->get('Cache.SerializerPermissions');
203 if ($chmod !== null) {
204 chmod($file, $chmod & 0666);
211 * Prepares the directory that this type stores the serials in
212 * @param HTMLPurifier_Config $config
213 * @return bool True if successful
215 private function _prepareDir($config)
217 $directory = $this->generateDirectoryPath($config);
218 $chmod = $config->get('Cache.SerializerPermissions');
219 if ($chmod === null) {
221 if (is_dir($directory)) return true;
222 return mkdir($directory);
224 if (!is_dir($directory)) {
225 $base = $this->generateBaseDirectoryPath($config);
226 if (!is_dir($base)) {
228 'Base directory ' . $base . ' does not exist,
229 please create or change using %Cache.SerializerPath',
233 } elseif (!$this->_testPermissions($base, $chmod)) {
236 if (!mkdir($directory, $chmod)) {
238 'Could not create directory ' . $directory . '',
243 if (!$this->_testPermissions($directory, $chmod)) {
246 } elseif (!$this->_testPermissions($directory, $chmod)) {
253 * Tests permissions on a directory and throws out friendly
254 * error messages and attempts to chmod it itself if possible
255 * @param string $dir Directory path
256 * @param int $chmod Permissions
257 * @return bool True if directory is writable
259 private function _testPermissions($dir, $chmod)
261 // early abort, if it is writable, everything is hunky-dory
262 if (is_writable($dir)) {
266 // generally, you'll want to handle this beforehand
267 // so a more specific error message can be given
269 'Directory ' . $dir . ' does not exist',
274 if (function_exists('posix_getuid') && $chmod !== null) {
275 // POSIX system, we can give more specific advice
276 if (fileowner($dir) === posix_getuid()) {
277 // we can chmod it ourselves
278 $chmod = $chmod | 0700;
279 if (chmod($dir, $chmod)) {
282 } elseif (filegroup($dir) === posix_getgid()) {
283 $chmod = $chmod | 0070;
285 // PHP's probably running as nobody, so we'll
286 // need to give global permissions
287 $chmod = $chmod | 0777;
290 'Directory ' . $dir . ' not writable, ' .
291 'please chmod to ' . decoct($chmod),
295 // generic error message
297 'Directory ' . $dir . ' not writable, ' .
298 'please alter file permissions',
306 // vim: et sw=4 sts=4