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()).'/'.intval(is_writeable($this->fqfn)).'/'.intval($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) {
118 $this->resetCacheReadStatus();
121 if ($this->isCacheReadable()) changeMode($this->fqfn, 0666);
122 $this->pointer = fopen($this->fqfn, 'w') or app_die(__METHOD__, __LINE__, "Cannot write to cache ".$this->fqfn." !");
125 fwrite($this->pointer, "<?php\n");
127 // Cannot create file
128 addFatalMessage(__METHOD__, __LINE__, "(<font color=\"#0000aa\">".__LINE__."</font>): ".getMessage('CACHE_PROBLEMS_DETECTED'));
132 // Reset the read status
133 function resetCacheReadStatus () {
134 unset($this->readable[$this->name]);
135 unset($GLOBALS['file_readable'][$this->fqfn]);
136 unset($this->status[$this->name]);
139 function addRow ($data) {
140 // Is the pointe rvalid?
141 if (is_resource($this->pointer)) {
142 // Write every array element to cache file
143 foreach ($data as $k => $v) {
144 // Write global cache array for immediate access
145 if ((substr($k, 0, 4) == 'ext_') && (isset($data['ext_name'])) && (isset($data['ext_id']))) {
146 if ($k == 'ext_name') {
147 $GLOBALS['cache_array']['extension'][$k][$data['ext_id']] = $v;
149 $GLOBALS['cache_array']['extension'][$k][$data['ext_name']] = $v;
151 if (($k == 'ext_keep') && ($v == 'Y')) {
152 $GLOBALS['cache_array']['active_extensions'][$data['ext_name']] = $v;
154 } elseif (is_array($v)) {
155 // Serialize and BASE64-encode the array
156 $v = base64_encode(serialize($v));
159 // Write cache line to file
160 fwrite($this->pointer, $this->rewriteEntry($k, $v));
163 // Cannot create file
164 addFatalMessage(__METHOD__, __LINE__, "(<font color=\"#0000aa\">".__LINE__."</font>): ".getMessage('CACHE_PROBLEMS_DETECTED'));
168 function finalize () {
169 // Quit function when no pointer is set
170 if (is_resource($this->pointer)) {
171 // Add default depency
172 $this->storeExtensionVersion('cache');
175 fwrite($this->pointer, "?>\n");
177 // Close file add destroy handler
178 fclose($this->pointer);
180 // Reset readable status
181 $this->resetCacheReadStatus();
184 if ($this->isCacheReadable()) changeMode($this->fqfn, 0666);
186 // Remove pointer and status
187 unset($this->status[$this->name]);
188 $this->pointer = false;
189 //* DEBUG: */ outputHtml(__METHOD__."(<font color=\"#0000aa\">".__LINE__."</font>): {$this->name} - FINALIZED!<br />");
193 function getArrayFromCache () {
194 // Is the cache already loaded?
195 if (isset($this->data[$this->name])) {
196 // Return it's content!
197 return $this->data[$this->name];
200 // Is the cache file there?
201 if ($this->isCacheReadable()) {
203 require($this->fqfn);
205 // Is there an array?
206 if (isset($this->data[$this->name])) {
207 // Cache version found?
208 if (isset($this->version[$this->name])) {
209 // Check it here if cache matches ext-cache version
210 if (!$this->extensionVersionMatches('cache')) {
212 logDebugMessage(__METHOD__, __LINE__, 'Invalid cache data ' . $this->name . ' detected.');
213 $this->removeCacheFile();
217 // Return cache if detected
218 if (isset($this->data[$this->name])) {
219 return $this->data[$this->name];
222 logDebugMessage(__METHOD__, __LINE__, 'Possible damaged cache ' . $this->name . ' detected.');
223 $this->removeCacheFile();
227 // Cache file not found or not readable
228 debug_report_bug($this->name);
229 addFatalMessage(__METHOD__, __LINE__, "(<font color=\"#0000aa\">".__LINE__."</font>): ".sprintf(getMessage('CACHE_CANNOT_LOAD'), $this->fqfn));
232 $this->removeCacheFile();
236 // Destroy an existing cache file
237 function removeCacheFile ($removeArray = false, $force = false) {
239 $this->resetCacheReadStatus();
242 /* DEBUG: */ logDebugMessage(__METHOD__, __LINE__, sprintf("%s should be removed.", $this->name));
244 // Is the cache file not yet rebuilt?
245 if ((!isset($this->rebuilt[$this->name])) && ($this->isCacheReadable())) {
246 // Only run in regular output mode
247 if ((getOutputMode() != 0) && ($force === false)) {
248 // Debug message if allowed
249 if (isDebugModeEnabled()) {
251 debug_report_bug('Not removing cache ' . $this->name . ' in output_mode=' . getOutputMode());
261 // Debug-mode enabled?
262 if (isDebugModeEnabled()) {
263 // Log removal of cache
264 logDebugMessage(__METHOD__, __LINE__, 'removing cache: ' . $this->name);
267 // Remove cache file from system
268 removeFile($this->fqfn);
271 $this->resetCacheReadStatus();
273 // Shall we remove the array from memory?
274 if ($removeArray === true) {
275 // Debug message if allowed
276 if (isDebugModeEnabled()) {
278 logDebugMessage(__METHOD__, __LINE__, 'removing array!');
281 // Remove it from memory
282 unset($GLOBALS['cache_array'][$this->name]);
285 // Is the file there?
286 if (!$this->isCacheReadable()) {
287 // The cache does no longer exist so kill the content
288 unset($this->data[$this->name]);
289 unset($this->version[$this->name]);
290 $this->rebuilt[$this->name] = true;
293 addFatalMessage(__METHOD__, __LINE__, "(<font color=\"#0000aa\">".__LINE__."</font>): ".sprintf(getMessage('CACHE_CANNOT_UNLINK'), $this->fqfn));
299 function removeEntry ($search, $data, $array) {
300 if ($this->status[$this->name] == $this->statusDone) {
301 // Load cache into dummy array
302 $dummy = $this->getArrayFromCache();
304 // Search for key in array
305 $key = array_search($data, $dummy[$search]);
307 // Key (hopefully) found?
308 foreach ($array as $a) {
309 // So we can remove all elements as requested
310 unset($dummy[$a][$key]);
313 // Flush array to cache file
317 $this->writeArray($dummy);
323 // Cannot write to cache!
324 addFatalMessage(__METHOD__, __LINE__, "(<font color=\"#0000aa\">".__LINE__."</font>): ".getMessage('CACHE_PROBLEMS_DETECTED'));
328 function writeArray ($array) {
329 if (is_resource($this->pointer)) {
330 foreach ($array as $k => $v) {
332 // Multi line(s) found
334 foreach($v as $k2 => $v2) {
335 // Put every array element in a row...
336 $LINE .= $this->rewriteEntry($k, $v2);
340 $LINE = $this->rewriteEntry($k, $v);
344 fwrite($this->pointer, $LINE);
347 // Cannot write array!
348 addFatalMessage(__METHOD__, __LINE__, "(<font color=\"#0000aa\">".__LINE__."</font>): ".getMessage('CACHE_PROBLEMS_DETECTED'));
353 function replaceEntry ($search, $replace, $search_key, $array) {
354 if ($this->status[$this->name] == $this->statusDone) {
355 // Load cache into dummy array
356 $dummy = $this->getArrayFromCache();
358 // Check if $dummy is valid (prevents some errors)
359 if ((is_array($dummy)) && (isset($dummy[$search])) && (is_array($dummy[$search]))) {
360 // Search for key in array
361 $key_found = array_key_exists($search_key, $dummy[$search]);
362 if ($key_found == true) {
364 // Key (hopefully) found?
365 foreach ($dummy as $a => $v) {
366 // So we can update all entries
369 $dummy[$a][$search_key] = $replace;
373 // Flush array to cache file
377 $this->writeArray($dummy);
384 // Cannot write to cache!
385 addFatalMessage(__METHOD__, __LINE__, "(<font color=\"#0000aa\">".__LINE__."</font>): ".getMessage('CACHE_PROBLEMS_DETECTED'));
389 // Writes the version of given extension to the cache file
390 function storeExtensionVersion ($ext_name) {
391 // Valid cache pointer?
392 if (is_resource($this->pointer)) {
393 // Write only if extension is installed
394 if (isExtensionInstalled($ext_name)) {
395 // Get extension version
396 $ext_ver = getExtensionVersion($ext_name);
398 // Write cache line to file
399 fwrite($this->pointer, $this->rewriteEntry($ext_name, $ext_ver, 'version', true));
401 // Add the extension version to object (DO NOT REMOVE IT! Endless loop...)
402 $this->version[$this->name][$ext_name] = $ext_ver;
404 //* DEBUG: */ outputHtml(__METHOD__."(<font color=\"#0000aa\">".__LINE__."</font>): {$this->name} - {$ext_name}={$ext_ver}<br />");
406 // Cannot create file
407 addFatalMessage(__METHOD__, __LINE__, "(<font color=\"#0000aa\">".__LINE__."</font>): ".getMessage('CACHE_PROBLEMS_DETECTED'));
411 // Checks wether versions from cache and extension matches
412 function extensionVersionMatches ($ext_name) {
413 // Default is not matching
416 // Compare only if installed
417 if (isExtensionInstalled($ext_name)) {
418 // Get extension version
419 $ext_ver = getExtensionVersion($ext_name);
422 if (isset($this->version[$this->name][$ext_name])) {
424 $matches = ((isset($this->version[$this->name][$ext_name])) && ($this->version[$this->name][$ext_name] == $ext_ver));
425 } elseif ($this->isCacheReadable()) {
426 // No cache version found!
427 logDebugMessage(__METHOD__, __LINE__, "Cache {$this->name} has missing version entry for extension {$ext_name}! Purging cache...");
429 // Remove the cache file
430 $this->removeCacheFile(false, true);
433 // Not installed, does always match
441 // Rewrit the entry so it can be stored in cache file
442 // @TODO Add support for more types which break in last else-block
443 function rewriteEntry ($key, $value, $prefix = 'data', $single = false) {
444 // Default is not single entry
447 // Add only for single array entry?
448 if ($single === true) $extender = '';
453 // String or non-string? ;-)
454 if (is_string($value)) {
456 $line = '$this->' . $prefix . "['".$this->name."']['" . $key . "']" . $extender . " = '" . smartAddSlashes($value) . "';\n";
457 } elseif (is_null($value)) {
459 $line = '$this->' . $prefix . "['".$this->name."']['" . $key . "']" . $extender . " = null;\n";
460 } elseif (is_bool($value)) {
462 if ($value === true) {
464 $line = '$this->' . $prefix . "['".$this->name."']['" . $key . "']" . $extender . " = true;\n";
467 $line = '$this->' . $prefix . "['".$this->name."']['" . $key . "']" . $extender . " = false;\n";
471 $line = '$this->' . $prefix . "['".$this->name."']['" . $key . "']" . $extender . " = " . $value . ";\n";
478 // Getter for cache status
479 function getStatus () {
483 // Checks wether the current cache file is readable
484 function isCacheReadable () {
485 // Array entry found?
486 if (!isset($this->readable[$this->name])) {
487 // Not found, so create it
488 $this->readable[$this->name] = isFileReadable($this->fqfn);
492 return $this->readable[$this->name];