ILIAS  release_5-2 Revision v5.2.25-18-g3f80b828510
HTMLPurifier_DefinitionCache_Serializer Class Reference
+ Inheritance diagram for HTMLPurifier_DefinitionCache_Serializer:
+ Collaboration diagram for HTMLPurifier_DefinitionCache_Serializer:

Public Member Functions

 add ($def, $config)
 
 set ($def, $config)
 
 replace ($def, $config)
 
 get ($config)
 
 remove ($config)
 
 flush ($config)
 
 cleanup ($config)
 
 generateFilePath ($config)
 Generates the file path to the serial file corresponding to the configuration and definition name. More...
 
 generateDirectoryPath ($config)
 Generates the path to the directory contain this cache's serial files. More...
 
 generateBaseDirectoryPath ($config)
 Generates path to base directory that contains all definition type serials. More...
 
- Public Member Functions inherited from HTMLPurifier_DefinitionCache
 __construct ($type)
 
 generateKey ($config)
 Generates a unique identifier for a particular configuration. More...
 
 isOld ($key, $config)
 Tests whether or not a key is old with respect to the configuration's version and revision number. More...
 
 checkDefType ($def)
 Checks if a definition's type jives with the cache's type. More...
 
 add ($def, $config)
 Adds a definition object to the cache. More...
 
 set ($def, $config)
 Unconditionally saves a definition object to the cache. More...
 
 replace ($def, $config)
 Replace an object in the cache. More...
 
 get ($config)
 Retrieves a definition object from the cache. More...
 
 remove ($config)
 Removes a definition object to the cache. More...
 
 flush ($config)
 Clears all objects from cache. More...
 
 cleanup ($config)
 Clears all expired (older version or revision) objects from cache. More...
 

Private Member Functions

 _write ($file, $data, $config)
 Convenience wrapper function for file_put_contents. More...
 
 _prepareDir ($config)
 Prepares the directory that this type stores the serials in. More...
 
 _testPermissions ($dir, $chmod)
 Tests permissions on a directory and throws out friendly error messages and attempts to chmod it itself if possible. More...
 

Additional Inherited Members

- Data Fields inherited from HTMLPurifier_DefinitionCache
 $type
 @type string More...
 

Detailed Description

Definition at line 3 of file Serializer.php.

Member Function Documentation

◆ _prepareDir()

HTMLPurifier_DefinitionCache_Serializer::_prepareDir (   $config)
private

Prepares the directory that this type stores the serials in.

Parameters
HTMLPurifier_Config$config
Returns
bool True if successful

Definition at line 216 of file Serializer.php.

217 {
218 $directory = $this->generateDirectoryPath($config);
219 $chmod = $config->get('Cache.SerializerPermissions');
220 if (!is_dir($directory)) {
221 $base = $this->generateBaseDirectoryPath($config);
222 if (!is_dir($base)) {
223 trigger_error(
224 'Base directory ' . $base . ' does not exist,
225 please create or change using %Cache.SerializerPath',
226 E_USER_WARNING
227 );
228 return false;
229 } elseif (!$this->_testPermissions($base, $chmod)) {
230 return false;
231 }
232 if ($chmod === null) {
233 trigger_error(
234 'Base directory ' . $base . ' does not exist,
235 please create or change using %Cache.SerializerPath',
236 E_USER_WARNING
237 );
238 return false;
239 }
240 if ($chmod !== null) {
241 mkdir($directory, $chmod);
242 } else {
243 mkdir($directory);
244 }
245 if (!$this->_testPermissions($directory, $chmod)) {
246 trigger_error(
247 'Base directory ' . $base . ' does not exist,
248 please create or change using %Cache.SerializerPath',
249 E_USER_WARNING
250 );
251 return false;
252 }
253 } elseif (!$this->_testPermissions($directory, $chmod)) {
254 return false;
255 }
256 return true;
257 }
generateDirectoryPath($config)
Generates the path to the directory contain this cache's serial files.
Definition: Serializer.php:168
_testPermissions($dir, $chmod)
Tests permissions on a directory and throws out friendly error messages and attempts to chmod it itse...
Definition: Serializer.php:266
generateBaseDirectoryPath($config)
Generates path to base directory that contains all definition type serials.
Definition: Serializer.php:181

References $config, _testPermissions(), generateBaseDirectoryPath(), and generateDirectoryPath().

Referenced by add(), cleanup(), flush(), replace(), and set().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ _testPermissions()

HTMLPurifier_DefinitionCache_Serializer::_testPermissions (   $dir,
  $chmod 
)
private

Tests permissions on a directory and throws out friendly error messages and attempts to chmod it itself if possible.

Parameters
string$dirDirectory path
int$chmodPermissions
Returns
bool True if directory is writable

Definition at line 266 of file Serializer.php.

267 {
268 // early abort, if it is writable, everything is hunky-dory
269 if (is_writable($dir)) {
270 return true;
271 }
272 if (!is_dir($dir)) {
273 // generally, you'll want to handle this beforehand
274 // so a more specific error message can be given
275 trigger_error(
276 'Directory ' . $dir . ' does not exist',
277 E_USER_WARNING
278 );
279 return false;
280 }
281 if (function_exists('posix_getuid') && $chmod !== null) {
282 // POSIX system, we can give more specific advice
283 if (fileowner($dir) === posix_getuid()) {
284 // we can chmod it ourselves
285 $chmod = $chmod | 0700;
286 if (chmod($dir, $chmod)) {
287 return true;
288 }
289 } elseif (filegroup($dir) === posix_getgid()) {
290 $chmod = $chmod | 0070;
291 } else {
292 // PHP's probably running as nobody, so we'll
293 // need to give global permissions
294 $chmod = $chmod | 0777;
295 }
296 trigger_error(
297 'Directory ' . $dir . ' not writable, ' .
298 'please chmod to ' . decoct($chmod),
299 E_USER_WARNING
300 );
301 } else {
302 // generic error message
303 trigger_error(
304 'Directory ' . $dir . ' not writable, ' .
305 'please alter file permissions',
306 E_USER_WARNING
307 );
308 }
309 return false;
310 }

Referenced by _prepareDir().

+ Here is the caller graph for this function:

◆ _write()

HTMLPurifier_DefinitionCache_Serializer::_write (   $file,
  $data,
  $config 
)
private

Convenience wrapper function for file_put_contents.

Parameters
string$fileFile name to write to
string$dataData to write into file
HTMLPurifier_Config$config
Returns
int|bool Number of bytes written if success, or false if failure.

Definition at line 195 of file Serializer.php.

196 {
197 $result = file_put_contents($file, $data);
198 if ($result !== false) {
199 // set permissions of the new file (no execute)
200 $chmod = $config->get('Cache.SerializerPermissions');
201 if ($chmod === null) {
202 // don't do anything
203 } else {
204 $chmod = $chmod & 0666;
205 chmod($file, $chmod);
206 }
207 }
208 return $result;
209 }
$result
if(!file_exists("$old.txt")) if( $old===$new) if(file_exists("$new.txt")) $file

References $config, $data, $file, and $result.

Referenced by add(), replace(), and set().

+ Here is the caller graph for this function:

◆ add()

HTMLPurifier_DefinitionCache_Serializer::add (   $def,
  $config 
)
Parameters
HTMLPurifier_Definition$def
HTMLPurifier_Config$config
Returns
int|bool

Reimplemented from HTMLPurifier_DefinitionCache.

Definition at line 11 of file Serializer.php.

12 {
13 if (!$this->checkDefType($def)) {
14 return;
15 }
17 if (file_exists($file)) {
18 return false;
19 }
20 if (!$this->_prepareDir($config)) {
21 return false;
22 }
23 return $this->_write($file, serialize($def), $config);
24 }
_prepareDir($config)
Prepares the directory that this type stores the serials in.
Definition: Serializer.php:216
generateFilePath($config)
Generates the file path to the serial file corresponding to the configuration and definition name.
Definition: Serializer.php:155
_write($file, $data, $config)
Convenience wrapper function for file_put_contents.
Definition: Serializer.php:195
checkDefType($def)
Checks if a definition's type jives with the cache's type.

References $config, $file, _prepareDir(), _write(), HTMLPurifier_DefinitionCache\checkDefType(), and generateFilePath().

+ Here is the call graph for this function:

◆ cleanup()

HTMLPurifier_DefinitionCache_Serializer::cleanup (   $config)
Parameters
HTMLPurifier_Config$config
Returns
bool

Reimplemented from HTMLPurifier_DefinitionCache.

Definition at line 122 of file Serializer.php.

123 {
124 if (!$this->_prepareDir($config)) {
125 return false;
126 }
127 $dir = $this->generateDirectoryPath($config);
128 $dh = opendir($dir);
129 // See #49 (and above).
130 if (false === $dh) {
131 return false;
132 }
133 while (false !== ($filename = readdir($dh))) {
134 if (empty($filename)) {
135 continue;
136 }
137 if ($filename[0] === '.') {
138 continue;
139 }
140 $key = substr($filename, 0, strlen($filename) - 4);
141 if ($this->isOld($key, $config)) {
142 unlink($dir . '/' . $filename);
143 }
144 }
145 return true;
146 }
isOld($key, $config)
Tests whether or not a key is old with respect to the configuration's version and revision number.

References $config, $filename, _prepareDir(), generateDirectoryPath(), and HTMLPurifier_DefinitionCache\isOld().

+ Here is the call graph for this function:

◆ flush()

HTMLPurifier_DefinitionCache_Serializer::flush (   $config)
Parameters
HTMLPurifier_Config$config
Returns
bool

Reimplemented from HTMLPurifier_DefinitionCache.

Definition at line 93 of file Serializer.php.

94 {
95 if (!$this->_prepareDir($config)) {
96 return false;
97 }
98 $dir = $this->generateDirectoryPath($config);
99 $dh = opendir($dir);
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.
103 if (false === $dh) {
104 return false;
105 }
106 while (false !== ($filename = readdir($dh))) {
107 if (empty($filename)) {
108 continue;
109 }
110 if ($filename[0] === '.') {
111 continue;
112 }
113 unlink($dir . '/' . $filename);
114 }
115 return true;
116 }

References $config, $filename, _prepareDir(), and generateDirectoryPath().

+ Here is the call graph for this function:

◆ generateBaseDirectoryPath()

HTMLPurifier_DefinitionCache_Serializer::generateBaseDirectoryPath (   $config)

Generates path to base directory that contains all definition type serials.

Parameters
HTMLPurifier_Config$config
Returns
mixed|string
Todo:
Make protected

Definition at line 181 of file Serializer.php.

182 {
183 $base = $config->get('Cache.SerializerPath');
184 $base = is_null($base) ? HTMLPURIFIER_PREFIX . '/HTMLPurifier/DefinitionCache/Serializer' : $base;
185 return $base;
186 }

References $config.

Referenced by _prepareDir(), and generateDirectoryPath().

+ Here is the caller graph for this function:

◆ generateDirectoryPath()

HTMLPurifier_DefinitionCache_Serializer::generateDirectoryPath (   $config)

Generates the path to the directory contain this cache's serial files.

Parameters
HTMLPurifier_Config$config
Returns
string
Note
No trailing slash
Todo:
Make protected

Definition at line 168 of file Serializer.php.

169 {
170 $base = $this->generateBaseDirectoryPath($config);
171 return $base . '/' . $this->type;
172 }

References $config, HTMLPurifier_DefinitionCache\$type, and generateBaseDirectoryPath().

Referenced by _prepareDir(), cleanup(), flush(), and generateFilePath().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ generateFilePath()

HTMLPurifier_DefinitionCache_Serializer::generateFilePath (   $config)

Generates the file path to the serial file corresponding to the configuration and definition name.

Parameters
HTMLPurifier_Config$config
Returns
string
Todo:
Make protected

Definition at line 155 of file Serializer.php.

156 {
157 $key = $this->generateKey($config);
158 return $this->generateDirectoryPath($config) . '/' . $key . '.ser';
159 }
generateKey($config)
Generates a unique identifier for a particular configuration.

References $config, generateDirectoryPath(), and HTMLPurifier_DefinitionCache\generateKey().

Referenced by add(), get(), remove(), replace(), and set().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ get()

HTMLPurifier_DefinitionCache_Serializer::get (   $config)
Parameters
HTMLPurifier_Config$config
Returns
bool|HTMLPurifier_Config

Reimplemented from HTMLPurifier_DefinitionCache.

Definition at line 67 of file Serializer.php.

68 {
70 if (!file_exists($file)) {
71 return false;
72 }
73 return unserialize(file_get_contents($file));
74 }

References $config, $file, and generateFilePath().

+ Here is the call graph for this function:

◆ remove()

HTMLPurifier_DefinitionCache_Serializer::remove (   $config)
Parameters
HTMLPurifier_Config$config
Returns
bool

Reimplemented from HTMLPurifier_DefinitionCache.

Definition at line 80 of file Serializer.php.

81 {
83 if (!file_exists($file)) {
84 return false;
85 }
86 return unlink($file);
87 }

References $config, $file, and generateFilePath().

+ Here is the call graph for this function:

◆ replace()

HTMLPurifier_DefinitionCache_Serializer::replace (   $def,
  $config 
)
Parameters
HTMLPurifier_Definition$def
HTMLPurifier_Config$config
Returns
int|bool

Reimplemented from HTMLPurifier_DefinitionCache.

Definition at line 48 of file Serializer.php.

49 {
50 if (!$this->checkDefType($def)) {
51 return;
52 }
54 if (!file_exists($file)) {
55 return false;
56 }
57 if (!$this->_prepareDir($config)) {
58 return false;
59 }
60 return $this->_write($file, serialize($def), $config);
61 }

References $config, $file, _prepareDir(), _write(), HTMLPurifier_DefinitionCache\checkDefType(), and generateFilePath().

+ Here is the call graph for this function:

◆ set()

HTMLPurifier_DefinitionCache_Serializer::set (   $def,
  $config 
)
Parameters
HTMLPurifier_Definition$def
HTMLPurifier_Config$config
Returns
int|bool

Reimplemented from HTMLPurifier_DefinitionCache.

Definition at line 31 of file Serializer.php.

32 {
33 if (!$this->checkDefType($def)) {
34 return;
35 }
37 if (!$this->_prepareDir($config)) {
38 return false;
39 }
40 return $this->_write($file, serialize($def), $config);
41 }

References $config, $file, _prepareDir(), _write(), HTMLPurifier_DefinitionCache\checkDefType(), and generateFilePath().

+ Here is the call graph for this function:

The documentation for this class was generated from the following file: