2 /************************************************************************
3 * MXChange v0.2.1 Start: 10/22/2009 *
4 * =============== Last change: 10/22/2009 *
6 * -------------------------------------------------------------------- *
7 * File : cachesystem.class.php *
8 * -------------------------------------------------------------------- *
9 * Short description : CacheSystem class *
10 * -------------------------------------------------------------------- *
11 * Kurzbeschreibung : CacheSystem-Klasse *
12 * -------------------------------------------------------------------- *
15 * $Tag:: 0.2.1-FINAL $ *
17 * Needs to be in all Files and every File needs "svn propset *
18 * svn:keywords Date Revision" (autoprobset!) at least!!!!!! *
19 * -------------------------------------------------------------------- *
20 * Copyright (c) 2003 - 2009 by Roland Haeder *
21 * For more information visit: http://www.mxchange.org *
23 * This program is free software; you can redistribute it and/or modify *
24 * it under the terms of the GNU General Public License as published by *
25 * the Free Software Foundation; either version 2 of the License, or *
26 * (at your option) any later version. *
28 * This program is distributed in the hope that it will be useful, *
29 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
30 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
31 * GNU General Public License for more details. *
33 * You should have received a copy of the GNU General Public License *
34 * along with this program; if not, write to the Free Software *
35 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, *
37 ************************************************************************/
39 // Some security stuff...
40 if (!defined('__SECURITY')) {
51 var $version = array();
53 var $rebuilt = array();
54 var $extension = '.cache';
55 var $statusDone = 'done';
56 var $status = array();
57 var $readable = array();
60 function CacheSystem () {
61 // Failed is the default
62 $this->ret = 'failed';
66 // Check if path exists
67 if (isDirectory(getConfig('CACHE_PATH'))) {
68 // Make FQFN for dummy file
69 $FQFN = getConfig('CACHE_PATH') . 'dummy.tmp';
71 // Check if we can create a file inside the path
75 if (isFileReadable($FQFN)) {
76 // Yes, we can do. So let's remove it
79 // Is there a .htaccess file?
80 if (isFileReadable(getConfig('CACHE_PATH') . '.htaccess')) {
82 $this->ret = $this->statusDone;
84 // Stop! Set a .htaccess file first
85 $this->ret = 'htaccess';
91 // Checks validity of cache file and if content is given
92 function loadCacheFile ($cacheName) {
93 // Remember cache file
94 $this->name = $cacheName;
96 // Construct FQFN (full qualified file name)
97 $this->fqfn = getConfig('CACHE_PATH') . $cacheName . $this->extension;
99 // Check if file exists and if version matches
100 if (!isset($this->status[$cacheName])) {
101 // Pre-fetch cache here if found
102 if ($this->isCacheReadable()) $this->getArrayFromCache();
104 //* DEBUG: */ print($cacheName.'='.intval($this->isCacheReadable()).'/'.(is_writeable($this->fqfn)).'/'.($this->extensionVersionMatches('cache')).'<br />');
105 $this->status[$cacheName] = ($this->isCacheReadable() && (is_writeable($this->fqfn)) && ($this->extensionVersionMatches('cache')));
107 //* DEBUG: */ print($cacheName.'='.intval($this->status[$cacheName]).'<br />');
110 return $this->status[$cacheName];
113 // Initializes the cache file
115 // This will destory an existing cache file!
116 if ($this->ret == $this->statusDone) {
117 // Mark it as no longer readable
118 unset($this->readable[$this->name]);
119 unset($GLOBALS['file_readable'][$this->fqfn]);
122 if ($this->isCacheReadable()) changeMode($this->fqfn, 0666);
123 $this->pointer = fopen($this->fqfn, 'w') or app_die(__METHOD__, __LINE__, "Cannot write to cache ".$this->fqfn." !");
126 fwrite($this->pointer, "<?php\n");
128 // Cannot create file
129 addFatalMessage(__METHOD__, __LINE__, "(<font color=\"#0000aa\">".__LINE__."</font>): ".getMessage('CACHE_PROBLEMS_DETECTED'));
133 function addRow ($data) {
134 // Is the pointe rvalid?
135 if (is_resource($this->pointer)) {
136 // Write every array element to cache file
137 foreach ($data as $k => $v) {
138 // Write global cache array for immediate access
139 if ((substr($k, 0, 4) == 'ext_') && (isset($data['ext_name'])) && (isset($data['ext_id']))) {
140 if ($k == 'ext_name') {
141 $GLOBALS['cache_array']['extension'][$k][$data['ext_id']] = $v;
143 $GLOBALS['cache_array']['extension'][$k][$data['ext_name']] = $v;
145 if (($k == 'ext_keep') && ($v == 'Y')) {
146 $GLOBALS['cache_array']['active_extensions'][$data['ext_name']] = $v;
148 } elseif (is_array($v)) {
149 // Serialize and BASE64-encode the array
150 $v = base64_encode(serialize($v));
153 // Write cache line to file
154 fwrite($this->pointer, $this->rewriteEntry($k, $v));
157 // Cannot create file
158 addFatalMessage(__METHOD__, __LINE__, "(<font color=\"#0000aa\">".__LINE__."</font>): ".getMessage('CACHE_PROBLEMS_DETECTED'));
162 function finalize () {
163 // Quit function when no pointer is set
164 if (is_resource($this->pointer)) {
165 // Add default depency
166 $this->storeExtensionVersion('cache');
169 fwrite($this->pointer, "?>\n");
171 // Close file add destroy handler
172 fclose($this->pointer);
175 if ($this->isCacheReadable()) changeMode($this->fqfn, 0666);
177 // Remove pointer and status
178 unset($this->status[$this->name]);
179 $this->pointer = false;
180 //* DEBUG: */ outputHtml(__METHOD__."(<font color=\"#0000aa\">".__LINE__."</font>): {$this->name} - FINALIZED!<br />");
184 function getArrayFromCache () {
185 // Is the cache already loaded?
186 if (isset($this->data[$this->name])) {
187 // Return it's content!
188 return $this->data[$this->name];
191 // Is the cache file there?
192 if ($this->isCacheReadable()) {
194 require($this->fqfn);
196 // Is there an array?
197 if (isset($this->data[$this->name])) {
198 // Cache version found?
199 if (isset($this->version[$this->name])) {
200 // Check it here if cache matches ext-cache version
201 if (!$this->extensionVersionMatches('cache')) {
203 logDebugMessage(__METHOD__, __LINE__, 'Invalid cache data ' . $this->name . ' detected.');
204 $this->removeCacheFile();
208 // Return cache if detected
209 if (isset($this->data[$this->name])) {
210 return $this->data[$this->name];
213 logDebugMessage(__METHOD__, __LINE__, 'Possible damaged cache ' . $this->name . ' detected.');
214 $this->removeCacheFile();
218 // Cache file not found or not readable
219 addFatalMessage(__METHOD__, __LINE__, "(<font color=\"#0000aa\">".__LINE__."</font>): ".sprintf(getMessage('CACHE_CANNOT_LOAD'), $this->fqfn));
223 // Destroy an existing cache file
224 function removeCacheFile ($removeArray = false, $force = false) {
226 /* DEBUG: */ logDebugMessage(__METHOD__, __LINE__, sprintf("%s should be removed.", $this->name));
228 // Is the cache file not yet rebuilt?
229 if ((!isset($this->rebuilt[$this->name])) && ($this->isCacheReadable())) {
230 // Only run in regular output mode
231 if ((getOutputMode() != 0) && ($force === false)) {
232 // Debug message if allowed
233 if (isDebugModeEnabled()) {
235 debug_report_bug('Not removing cache ' . $this->name . ' in output_mode=' . getOutputMode());
245 // Debug-mode enabled?
246 if (isDebugModeEnabled()) {
247 // Log removal of cache
248 logDebugMessage(__METHOD__, __LINE__, 'removing cache: ' . $this->name);
251 // Remove cache file from system
252 removeFile($this->fqfn);
254 // No longer readable!
255 unset($this->readable[$this->name]);
257 // Shall we remove the array from memory?
258 if ($removeArray === true) {
259 // Debug message if allowed
260 if (isDebugModeEnabled()) {
262 logDebugMessage(__METHOD__, __LINE__, 'removing array!');
265 // Remove it from memory
266 unset($GLOBALS['cache_array'][$this->name]);
269 // Is the file there?
270 if (!$this->isCacheReadable()) {
271 // The cache does no longer exist so kill the content
272 unset($this->data[$this->name]);
273 unset($this->version[$this->name]);
274 $this->rebuilt[$this->name] = true;
277 addFatalMessage(__METHOD__, __LINE__, "(<font color=\"#0000aa\">".__LINE__."</font>): ".sprintf(getMessage('CACHE_CANNOT_UNLINK'), $this->fqfn));
283 function removeEntry ($search, $data, $array) {
284 if ($this->status[$this->name] == $this->statusDone) {
285 // Load cache into dummy array
286 $dummy = $this->getArrayFromCache();
288 // Search for key in array
289 $key = array_search($data, $dummy[$search]);
291 // Key (hopefully) found?
292 foreach ($array as $a) {
293 // So we can remove all elements as requested
294 unset($dummy[$a][$key]);
297 // Flush array to cache file
301 $this->writeArray($dummy);
307 // Cannot write to cache!
308 addFatalMessage(__METHOD__, __LINE__, "(<font color=\"#0000aa\">".__LINE__."</font>): ".getMessage('CACHE_PROBLEMS_DETECTED'));
312 function writeArray ($array) {
313 if (is_resource($this->pointer)) {
314 foreach ($array as $k => $v) {
316 // Multi line(s) found
318 foreach($v as $k2 => $v2) {
319 // Put every array element in a row...
320 $LINE .= $this->rewriteEntry($k, $v2);
324 $LINE = $this->rewriteEntry($k, $v);
328 fwrite($this->pointer, $LINE);
331 // Cannot write array!
332 addFatalMessage(__METHOD__, __LINE__, "(<font color=\"#0000aa\">".__LINE__."</font>): ".getMessage('CACHE_PROBLEMS_DETECTED'));
337 function replaceEntry ($search, $replace, $search_key, $array) {
338 if ($this->status[$this->name] == $this->statusDone) {
339 // Load cache into dummy array
340 $dummy = $this->getArrayFromCache();
342 // Check if $dummy is valid (prevents some errors)
343 if ((is_array($dummy)) && (isset($dummy[$search])) && (is_array($dummy[$search]))) {
344 // Search for key in array
345 $key_found = array_key_exists($search_key, $dummy[$search]);
346 if ($key_found == true) {
348 // Key (hopefully) found?
349 foreach ($dummy as $a => $v) {
350 // So we can update all entries
353 $dummy[$a][$search_key] = $replace;
357 // Flush array to cache file
361 $this->writeArray($dummy);
368 // Cannot write to cache!
369 addFatalMessage(__METHOD__, __LINE__, "(<font color=\"#0000aa\">".__LINE__."</font>): ".getMessage('CACHE_PROBLEMS_DETECTED'));
373 // Writes the version of given extension to the cache file
374 function storeExtensionVersion ($ext_name) {
375 // Valid cache pointer?
376 if (is_resource($this->pointer)) {
377 // Write only if extension is installed
378 if (isExtensionInstalled($ext_name)) {
379 // Get extension version
380 $ext_ver = getExtensionVersion($ext_name);
382 // Write cache line to file
383 fwrite($this->pointer, $this->rewriteEntry($ext_name, $ext_ver, 'version', true));
385 // Add the extension version to object (DO NOT REMOVE IT! Endless loop...)
386 $this->version[$this->name][$ext_name] = $ext_ver;
388 //* DEBUG: */ outputHtml(__METHOD__."(<font color=\"#0000aa\">".__LINE__."</font>): {$this->name} - {$ext_name}={$ext_ver}<br />");
390 // Cannot create file
391 addFatalMessage(__METHOD__, __LINE__, "(<font color=\"#0000aa\">".__LINE__."</font>): ".getMessage('CACHE_PROBLEMS_DETECTED'));
395 // Checks wether versions from cache and extension matches
396 function extensionVersionMatches ($ext_name) {
397 // Default is not matching
400 // Compare only if installed
401 if (isExtensionInstalled($ext_name)) {
402 // Get extension version
403 $ext_ver = getExtensionVersion($ext_name);
406 if (isset($this->version[$this->name][$ext_name])) {
408 $matches = ((isset($this->version[$this->name][$ext_name])) && ($this->version[$this->name][$ext_name] == $ext_ver));
409 } elseif ($this->isCacheReadable()) {
410 // No cache version found!
411 logDebugMessage(__METHOD__, __LINE__, "Cache {$this->name} has missing version entry for extension {$ext_name}! Purging cache...");
413 // Remove the cache file
414 $this->removeCacheFile(false, true);
417 // Not installed, does always match
425 // Rewrit the entry so it can be stored in cache file
426 // @TODO Add support for more types which break in last else-block
427 function rewriteEntry ($key, $value, $prefix = 'data', $single = false) {
428 // Default is not single entry
431 // Add only for single array entry?
432 if ($single === true) $extender = '';
437 // String or non-string? ;-)
438 if (is_string($value)) {
440 $line = '$this->' . $prefix . "['".$this->name."']['" . $key . "']" . $extender . " = '" . smartAddSlashes($value) . "';\n";
441 } elseif (is_null($value)) {
443 $line = '$this->' . $prefix . "['".$this->name."']['" . $key . "']" . $extender . " = null;\n";
444 } elseif (is_bool($value)) {
446 if ($value === true) {
448 $line = '$this->' . $prefix . "['".$this->name."']['" . $key . "']" . $extender . " = true;\n";
451 $line = '$this->' . $prefix . "['".$this->name."']['" . $key . "']" . $extender . " = false;\n";
455 $line = '$this->' . $prefix . "['".$this->name."']['" . $key . "']" . $extender . " = " . $value . ";\n";
462 // Getter for cache status
463 function getStatus () {
467 // Checks wether the current cache file is readable
468 function isCacheReadable () {
469 // Array entry found?
470 if (!isset($this->readable[$this->name])) {
471 // Not found, so create it
472 $this->readable[$this->name] = isFileReadable($this->fqfn);
476 return $this->readable[$this->name];