* $Date:: $ *
* $Tag:: 0.2.1-FINAL $ *
* $Author:: $ *
- * Needs to be in all Files and every File needs "svn propset *
- * svn:keywords Date Revision" (autoprobset!) at least!!!!!! *
* -------------------------------------------------------------------- *
* Copyright (c) 2003 - 2009 by Roland Haeder *
* Copyright (c) 2009, 2010 by Mailer Developer Team *
// Caching class
class CacheSystem {
- // Define variables
- var $ret = 'init';
+ // Status code
+ var $statusCode = 'init';
+
+ // Full-qualified filename
var $fqfn = '';
+
+ // Resource to cache file
var $pointer = false;
+
+ // Data array from cache
var $data = array();
+
+ // Version data from cache
var $version = array();
+
+ // Cache name
var $name = '';
var $rebuilt = array();
+
+ // File extension
var $extension = '.cache';
- var $statusDone = 'done';
var $status = array();
var $readable = array();
// Constructor
function CacheSystem () {
// Failed is the default
- $this->ret = 'failed';
+ $this->setStatusCode('failed');
// Remeber path
// Is there a .htaccess file?
if (isFileReadable(getCachePath() . '.htaccess')) {
// All done!
- $this->ret = $this->statusDone;
+ $this->setStatusCode('done');
} else {
// Stop! Set a .htaccess file first
- $this->ret = 'htaccess';
+ $this->setStatusCode('htaccess');
}
} // END - if
}
// Initializes the cache file
function init () {
// This will destory an existing cache file!
- if ($this->ret == $this->statusDone) {
+ if ($this->getStatusCode() == 'done') {
// Reset read status
$this->resetCacheReadStatus();
$this->pointer = fopen($this->fqfn, 'w') or debug_report_bug(__METHOD__, __LINE__, 'Cannot write to cache ' . $this->fqfn . ' !');
// Add open PHP tag
- fwrite($this->pointer, "<?php\n");
+ $this->writeLine('<?php');
} else {
// Cannot create file
addFatalMessage(__METHOD__, __LINE__, '(<font color="#0000aa">' . __LINE__ . '</font>): {--CACHE_PROBLEMS_DETECTED');
}
}
+ /**
+ * Writes a line to the pointer and adds a \n (new-line) to the end
+ *
+ * @access private
+ */
+ function writeLine ($line) {
+ // Is the pointer a valid resource?
+ if (is_resource($this->pointer)) {
+ // Write the line
+ fwrite($this->pointer, $line . "\n");
+ } else {
+ // Something bad happened
+ debug_report_bug(__METHOD__, __LINE__, 'Pointer type is ' . gettype($this->pointer) . ', expected is resource.');
+ }
+ }
+
// Reset the read status
function resetCacheReadStatus () {
unset($this->readable[$this->name]);
}
// Write cache line to file
- fwrite($this->pointer, $this->rewriteEntry($k, $v));
+ $this->writeLine($this->rewriteEntry($k, $v));
} // END - foreach
} else {
// Cannot create file
$this->storeExtensionVersion('cache');
// Write footer
- fwrite($this->pointer, "?>\n");
+ $this->writeLine('?>');
// Close file add destroy handler
fclose($this->pointer);
$this->resetCacheReadStatus();
// Debug message
- /* DEBUG: */ logDebugMessage(__METHOD__, __LINE__, sprintf("%s should be removed.", $this->name));
+ //* DEBUG: */ logDebugMessage(__METHOD__, __LINE__, sprintf("%s should be removed.", $this->name));
// Is the cache file not yet rebuilt?
if ((!isset($this->rebuilt[$this->name])) && ($this->isCacheReadable())) {
// Only run in regular output mode
- if ((getScriptOutputMode() != 0) && ($force === false)) {
+ if ((!isHtmlOutputMode()) && ($force === false)) {
// Debug message if allowed
if (isDebugModeEnabled()) {
// Debug message
// Unused method:
function removeEntry ($search, $data, $array) {
- if ($this->status[$this->name] == $this->statusDone) {
+ if ($this->status[$this->name] == 'done') {
// Load cache into dummy array
$dummy = $this->getArrayFromCache();
foreach($v as $k2 => $v2) {
// Put every array element in a row...
$LINE .= $this->rewriteEntry($k, $v2);
- }
+ } // END - foreach
} else {
// Single line found
$LINE = $this->rewriteEntry($k, $v);
}
// Write line(s)
- fwrite($this->pointer, $LINE);
+ $this->writeLine($LINE);
} // END - foreach
} else {
// Cannot write array!
// Unused method
function replaceEntry ($search, $replace, $search_key, $array) {
- if ($this->status[$this->name] == $this->statusDone) {
+ if ($this->status[$this->name] == 'done') {
// Load cache into dummy array
$dummy = $this->getArrayFromCache();
$this->version[$this->name][$ext_name] = $ext_ver;
// Write cache line to file
- fwrite($this->pointer, $this->rewriteEntry($ext_name, $ext_ver, 'version', true));
+ $this->writeLine($this->rewriteEntry($ext_name, $ext_ver, 'version', true));
} // END - if
//* DEBUG: */ debugOutput(__METHOD__ . '(<font color="#0000aa">' . __LINE__ . '</font>): '.$this->name.' - '.$ext_name.'='.$ext_ver);
} else {
$GLOBALS[__METHOD__][$ext_name] = ((isset($this->version[$this->name][$ext_name])) && ($this->version[$this->name][$ext_name] == $ext_ver));
} elseif ($this->isCacheReadable()) {
// No cache version found!
- logDebugMessage(__METHOD__, __LINE__, "Cache {$this->name} has missing version entry for extension {$ext_name}! Purging cache...");
+ logDebugMessage(__METHOD__, __LINE__, 'Cache ' . $this->name . ' has missing version entry for extension ' . $ext_name . '! Purging cache...');
// Remove the cache file
$this->removeCacheFile(true);
$extender = '[]';
// Add only for single array entry?
- if ($single === true) $extender = '';
+ if ($single === true) {
+ $extender = '';
+ } // END - if
// Init line
$line = '';
// String or non-string? ;-)
if (is_string($value)) {
// String...
- $line = '$this->' . $prefix . "['" . $this->name . "']['" . $key . "']" . $extender . " = '" . escapeQuotes($value) . "';\n";
+ $line = '$this->' . $prefix . "['" . $this->name . "']['" . $key . "']" . $extender . " = '" . escapeQuotes($value) . "';";
} elseif (is_null($value)) {
// Null
- $line = '$this->' . $prefix . "['" . $this->name . "']['" . $key . "']" . $extender . " = null;\n";
+ $line = '$this->' . $prefix . "['" . $this->name . "']['" . $key . "']" . $extender . ' = null;';
} elseif (is_bool($value)) {
// Boolean value
if ($value === true) {
// True
- $line = '$this->' . $prefix . "['" . $this->name . "']['" . $key . "']" . $extender . " = true;\n";
+ $line = '$this->' . $prefix . "['" . $this->name . "']['" . $key . "']" . $extender . ' = true;';
} else {
// False
- $line = '$this->' . $prefix . "['" . $this->name . "']['" . $key . "']" . $extender . " = false;\n";
+ $line = '$this->' . $prefix . "['" . $this->name . "']['" . $key . "']" . $extender . ' = false;';
}
} elseif (isset($value[0])) {
// These lines needs fixing
debug_report_bug(__METHOD__, __LINE__, 'Invalid entry with [0] found. key=' . $key);
} else {
// Non-string
- $line = '$this->' . $prefix . "['" . $this->name . "']['" . $key . "']" . $extender . ' = ' . $value . ";\n";
+ $line = '$this->' . $prefix . "['" . $this->name . "']['" . $key . "']" . $extender . ' = ' . $value . ';';
}
// Return line
return $line;
}
- // Getter for cache status
- function getStatus () {
- return $this->ret;
+ // Getter for cache status code
+ function getStatusCode () {
+ return $this->statusCode;
+ }
+
+ // Setter for cache status code
+ function setStatusCode ($status) {
+ $this->statusCode = $status;
}
// Checks wether the current cache file is readable
return $this->readable[$this->name];
}
+ // Cloning not allowed
+ function __clone () {
+ // Please do not clone this class
+ debug_report_bug(__METHOD__, __LINE__, 'Cloning of this class is not allowed.');
+ }
} // END - class
// [EOF]
projects / mailer.git / blobdiff