* $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 *
- * For more information visit: http://www.mxchange.org *
+ * Copyright (c) 2009 - 2013 by Mailer Developer Team *
+ * For more information visit: http://mxchange.org *
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
// Caching class
class CacheSystem {
- // Define variables
- var $ret = 'init';
+ // Status code
+ var $statusCode = 'init';
+
+ // Full-qualified filename
var $fqfn = '';
- var $pointer = false;
+
+ // 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();
- var $extension = '.cache';
- var $statusDone = 'done';
+
+ // File extension
+ var $extension = '';
var $status = array();
var $readable = array();
+ var $fullPath = '';
// Constructor
function CacheSystem () {
- // Failed is the default
- $this->ret = 'failed';
+ // Set extension
+ $this->extension = getCacheExtension();
+
+ // Construct full path
+ $this->fullPath = getPath() . getCachePath();
- // Remeber path
+ // Failed is the default
+ $this->setStatusCode('failed');
// Check if path exists
- if (isDirectory(getConfig('CACHE_PATH'))) {
+ if (isDirectory($this->fullPath)) {
// Is there a .htaccess file?
- if (isFileReadable(getConfig('CACHE_PATH') . '.htaccess')) {
+ if (isFileReadable($this->fullPath . '.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
}
$this->name = $cacheName;
// Construct FQFN (full qualified file name)
- $this->fqfn = getConfig('CACHE_PATH') . $cacheName . $this->extension;
+ $this->fqfn = $this->fullPath . $cacheName . $this->extension;
// Check if file exists and if version matches
if (!isset($this->status[$cacheName])) {
// Pre-fetch cache here if found
if ($this->isCacheReadable()) $this->getArrayFromCache();
- //* DEBUG: */ print($cacheName.'='.intval($this->isCacheReadable()).'/'.intval(is_writeable($this->fqfn)).'/'.intval($this->extensionVersionMatches('cache')).'<br />');
+ //* DEBUG: */ debugOutput('cacheName='.$cacheName.',isCacheReadable='.intval($this->isCacheReadable()).',is_writeable='.intval(is_writeable($this->fqfn)).',extensionMatches='.intval($this->extensionVersionMatches('cache')));
$this->status[$cacheName] = ($this->isCacheReadable() && (is_writeable($this->fqfn)) && ($this->extensionVersionMatches('cache')));
} // END - if
- //* DEBUG: */ print($cacheName.'='.intval($this->status[$cacheName]).'<br />');
+ //* DEBUG: */ debugOutput('cacheName='.$cacheName.',status='.intval($this->status[$cacheName]));
// Return status
return $this->status[$cacheName];
// 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();
// Create file
if ($this->isCacheReadable()) changeMode($this->fqfn, 0666);
- $this->pointer = fopen($this->fqfn, 'w') or app_die(__METHOD__, __LINE__, "Cannot write to cache ".$this->fqfn." !");
+ $this->pointer = fopen($this->fqfn, 'w') or reportBug(__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>): ".getMessage('CACHE_PROBLEMS_DETECTED'));
+ reportBug(__METHOD__, __LINE__, 'Problems with cache directory detected, getStatusCode()=' . $this->getStatusCode());
+ }
+ }
+
+ /**
+ * 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 . PHP_EOL);
+ } else {
+ // Something bad happened
+ reportBug(__METHOD__, __LINE__, 'Pointer type is ' . gettype($this->pointer) . ', expected is resource.');
}
}
unset($this->status[$this->name]);
}
+ // Adds a data row (array) to cache file and global cache array
function addRow ($data) {
// Is the pointe rvalid?
if (is_resource($this->pointer)) {
$GLOBALS['cache_array']['extension'][$k][$data['ext_name']] = $v;
}
if (($k == 'ext_keep') && ($v == 'Y')) {
- $GLOBALS['cache_array']['active_extensions'][$data['ext_name']] = $v;
+ $GLOBALS['cache_array']['always_active'][$data['ext_name']] = $v;
} // END - if
- } elseif (is_array($v)) {
- // Serialize and BASE64-encode the array
- $v = base64_encode(serialize($v));
} elseif ($this->name == 'config') {
// Configuration
$GLOBALS['cache_array']['config'][$data['config']][$k] = $v;
} elseif ($this->name == 'filter') {
// Filter
- $GLOBALS['cache_array']['filter']['chains'][$data['filter_name']][$data['filter_function']] = $data['filter_active'];
+ $GLOBALS['cache_array']['filter']['chains'][$data['filter_name']][$data['filter_function']] = $data['filter_active'];
$GLOBALS['cache_array']['filter']['counter'][$data['filter_name']][$data['filter_function']] = $data['filter_counter'];
- $GLOBALS['cache_array']['filter']['loaded'][$data['filter_name']][$data['filter_function']] = true;
+ $GLOBALS['cache_array']['filter']['loaded'][$data['filter_name']][$data['filter_function']] = TRUE;
} elseif ($this->name == 'modules') {
// Modules
$GLOBALS['cache_array']['modules'][$k][$data['module']] = $v;
} elseif ($this->name == 'admin') {
- // Modules
- if ($k == 'login') {
- $GLOBALS['cache_array']['admin'][$k][$data['admin_id']] = $v;
- } else {
+ // Admin logins
+ if ($k == 'admin_id') {
$GLOBALS['cache_array']['admin'][$k][$data['login']] = $v;
+ } else {
+ $GLOBALS['cache_array']['admin'][$k][$data['admin_id']] = $v;
}
+ } elseif ($this->name == 'admin_acls') {
+ // Access control lines
+ array_push($GLOBALS['cache_array']['admin_acls'][$k][$data['admin_id']], $v);
} elseif ($this->name == 'refdepths') {
- // Referal levels
+ // Referral levels
$GLOBALS['cache_array']['refdepths'][$k][$data['id']] = $v;
} elseif ($this->name == 'refsystem') {
- // Referal system
+ // Referral system
$GLOBALS['cache_array']['refsystem'][$k][$data['id']] = $v;
} elseif ($this->name == 'revision') {
// Revision data
- $GLOBALS['cache_array']['revision'][$k] = $v;
+ $GLOBALS['cache_array']['revision'][$k][0] = $v;
} elseif ($this->name == 'themes') {
// Themes
if ($k == 'theme_path') {
} else {
$GLOBALS['cache_array']['themes'][$k][$data['theme_path']] = $v;
}
+ } elseif ($this->name == 'imprint') {
+ // Imprint
+ $GLOBALS['cache_array']['imprint'][$k][$data['imprint_id']] = $v;
+ } elseif ($this->name == 'points_data') {
+ // Table 'points_data'
+ $GLOBALS['cache_array']['points_data'][$k][$data['id']] = $v;
+ } elseif ($this->name == 'earning') {
+ // Table 'earning'
+ $GLOBALS['cache_array']['earning'][$k][$data['earning_id']] = $v;
+ } elseif ($this->name == 'payments') {
+ // Table 'payments'
+ $GLOBALS['cache_array']['payments'][$k][$data['id']] = $v;
+ } elseif (is_array($v)) {
+ // Serialize and BASE64-encode the array
+ $v = base64_encode(serialize($v));
} else {
// Finialize the cache and close it
$this->finalize();
// Remove cache
- $this->removeCacheFile(true);
+ $this->removeCacheFile(TRUE);
- // Unsupported cache found!
- debug_report_bug('Unsupported cache ' . $this->name . ' detected.');
+ // Unsupported/unhandled cache detected
+ reportBug(__METHOD__, __LINE__, 'Unsupported cache ' . $this->name . ' detected, data=' . print_r($data, TRUE) . ',k=' . $k . ',v=' . $v);
}
// Write cache line to file
- fwrite($this->pointer, $this->rewriteEntry($k, $v));
+ $this->writeLine($this->rewriteEntry($k, $v));
} // END - foreach
} else {
// Cannot create file
- addFatalMessage(__METHOD__, __LINE__, "(<font color=\"#0000aa\">".__LINE__."</font>): ".getMessage('CACHE_PROBLEMS_DETECTED'));
+ reportBug(__METHOD__, __LINE__, 'Problem with cache detected, no resource! pointer[]=' . gettype($this->pointer));
}
}
+ // Closes cache file with closing PHP tag
function finalize () {
// Quit function when no pointer is set
if (is_resource($this->pointer)) {
$this->storeExtensionVersion('cache');
// Write footer
- fwrite($this->pointer, "?>\n");
+ $this->writeLine('?>');
// Close file add destroy handler
fclose($this->pointer);
// Remove pointer and status
unset($this->status[$this->name]);
- $this->pointer = false;
- //* DEBUG: */ outputHtml(__METHOD__."(<font color=\"#0000aa\">".__LINE__."</font>): {$this->name} - FINALIZED!<br />");
+ $this->pointer = FALSE;
+ //* DEBUG: */ logDebugMessage(__METHOD__, __LINE__, 'name=' . $this->name . ' - FINALIZED!');
} // END - if
}
+ // Loads cache file and returns an array of the cached data
function getArrayFromCache () {
// Is the cache already loaded?
if (isset($this->data[$this->name])) {
// Is the cache file there?
if ($this->isCacheReadable()) {
// Load cache file
- require($this->fqfn);
+ include($this->fqfn);
// Is there an array?
if (isset($this->data[$this->name])) {
} // END - if
} else {
// Cache file not found or not readable
- debug_report_bug($this->name);
- addFatalMessage(__METHOD__, __LINE__, "(<font color=\"#0000aa\">".__LINE__."</font>): ".sprintf(getMessage('CACHE_CANNOT_LOAD'), $this->fqfn));
+ reportBug(__METHOD__, __LINE__, '{%message,CACHE_CANNOT_LOAD=' . $this->name . '%}');
// Try to remove it
$this->removeCacheFile();
}
// Destroy an existing cache file
- function removeCacheFile ($force = false) {
+ function removeCacheFile ($force = FALSE) {
// Reset read status
$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 ((getOutputMode() != 0) && ($force === false)) {
+ if ((!isHtmlOutputMode()) && ($force === FALSE)) {
// Debug message if allowed
if (isDebugModeEnabled()) {
// Debug message
- logDebugMessage(__METHOD__, __LINE__, 'Not removing cache ' . $this->name . ' in output_mode=' . getOutputMode());
+ logDebugMessage(__METHOD__, __LINE__, 'Not removing cache ' . $this->name . ' in output_mode=' . getScriptOutputMode());
} // END - if
// Abort here
} // END - if
// Remove cache file from system
+ //* DEBUG: */ reportBug(__METHOD__, __LINE__, 'About to remove ' . basename($this->fqfn) . '!');
removeFile($this->fqfn);
// Reset read status
// The cache does no longer exist so kill the content
unset($this->data[$this->name]);
unset($this->version[$this->name]);
- $this->rebuilt[$this->name] = true;
+ $this->rebuilt[$this->name] = TRUE;
} else {
// Not removed!
- addFatalMessage(__METHOD__, __LINE__, "(<font color=\"#0000aa\">".__LINE__."</font>): ".sprintf(getMessage('CACHE_CANNOT_UNLINK'), $this->fqfn));
+ reportBug(__METHOD__, __LINE__, '{%message,CACHE_CANNOT_UNLINK=' . $this->name . '%}');
}
} // END - if
}
// 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();
// Close cache file
$this->finalize();
- }
+ } // END - if
} else {
// Cannot write to cache!
- addFatalMessage(__METHOD__, __LINE__, "(<font color=\"#0000aa\">".__LINE__."</font>): ".getMessage('CACHE_PROBLEMS_DETECTED'));
+ reportBug(__METHOD__, __LINE__, 'Problem with cache detected: Unexpected status ' . $this->status[$this->name]);
}
}
if (is_array($v)) {
// Multi line(s) found
$LINE = '';
- foreach($v as $k2 => $v2) {
+ 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!
- addFatalMessage(__METHOD__, __LINE__, "(<font color=\"#0000aa\">".__LINE__."</font>): ".getMessage('CACHE_PROBLEMS_DETECTED'));
+ reportBug(__METHOD__, __LINE__, 'Problem with cache detected: pointer is not resource! pointer[]=' . gettype($this->pointer));
}
}
// 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();
if ((is_array($dummy)) && (isset($dummy[$search])) && (is_array($dummy[$search]))) {
// Search for key in array
$key_found = array_key_exists($search_key, $dummy[$search]);
- if ($key_found == true) {
+ if ($key_found == TRUE) {
$key = $search_key;
// Key (hopefully) found?
foreach ($dummy as $a => $v) {
} // END - if
} else {
// Cannot write to cache!
- addFatalMessage(__METHOD__, __LINE__, "(<font color=\"#0000aa\">".__LINE__."</font>): ".getMessage('CACHE_PROBLEMS_DETECTED'));
+ reportBug(__METHOD__, __LINE__, 'Problem with cache detected: Unexpected status ' . $this->status[$this->name]);
}
}
// Get extension version
$ext_ver = getExtensionVersion($ext_name);
- // Write cache line to file
- fwrite($this->pointer, $this->rewriteEntry($ext_name, $ext_ver, 'version', true));
-
// Add the extension version to object (DO NOT REMOVE IT! Endless loop...)
$this->version[$this->name][$ext_name] = $ext_ver;
+
+ // Write cache line to file
+ $this->writeLine($this->rewriteEntry($ext_name, $ext_ver, 'version', TRUE));
} // END - if
- //* DEBUG: */ outputHtml(__METHOD__."(<font color=\"#0000aa\">".__LINE__."</font>): {$this->name} - {$ext_name}={$ext_ver}<br />");
+ //* DEBUG: */ logDebugMessage(__METHOD__, __LINE__, 'name=' . $this->name . ',ext_name=' . $ext_name . ',ext_ver=' . $ext_ver);
} else {
// Cannot create file
- addFatalMessage(__METHOD__, __LINE__, "(<font color=\"#0000aa\">".__LINE__."</font>): ".getMessage('CACHE_PROBLEMS_DETECTED'));
+ reportBug(__METHOD__, __LINE__, 'Problem with cache detected: pointer is not resource! pointer[]=' . gettype($this->pointer));
}
}
- // Checks wether versions from cache and extension matches
+ // Checks whether versions from cache and extension matches
function extensionVersionMatches ($ext_name) {
- // Default is not matching
- $matches = false;
-
- // Compare only if installed
- if (isExtensionInstalled($ext_name)) {
- // Get extension version
- $ext_ver = getExtensionVersion($ext_name);
-
- // Debug messages
- if (isset($this->version[$this->name][$ext_name])) {
- // Does it match?
- $matches = ((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...");
-
- // Remove the cache file
- $this->removeCacheFile(true);
+ // Check cache
+ if (!isset($GLOBALS[__METHOD__][$ext_name])) {
+ // Does never match by default
+ $GLOBALS[__METHOD__][$ext_name] = FALSE;
+
+ // Compare only if installed
+ if (isExtensionInstalled($ext_name)) {
+ // Get extension version
+ $ext_ver = getExtensionVersion($ext_name);
+
+ // Debug messages
+ if (isset($this->version[$this->name][$ext_name])) {
+ // Does it match?
+ $GLOBALS[__METHOD__][$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-' . $ext_name . '! Purging cache...');
+
+ // Remove the cache file
+ $this->removeCacheFile(TRUE);
+ }
+ } else {
+ // Not installed, does always match
+ $GLOBALS[__METHOD__][$ext_name] = TRUE;
}
} else {
- // Not installed, does always match
- $matches = true;
+ // Cache entry found, log debug message
+ //* DEBUG: */ logDebugMessage(__METHOD__, __LINE__, 'ext_name=' . $ext_name . ', matches=' . intval($GLOBALS[__METHOD__][$ext_name]));
}
// Compare both
- return $matches;
+ return $GLOBALS[__METHOD__][$ext_name];
}
// Rewrit the entry so it can be stored in cache file
// @TODO Add support for more types which break in last else-block
- function rewriteEntry ($key, $value, $prefix = 'data', $single = false) {
+ function rewriteEntry ($key, $value, $prefix = 'data', $single = FALSE) {
// Default is not single entry
$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) {
+ 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
+ reportBug(__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;
}
- // Checks wether the current cache file is readable
+ // Setter for cache status code
+ function setStatusCode ($status) {
+ $this->statusCode = $status;
+ }
+
+ // Checks whether the current cache file is readable
function isCacheReadable () {
// Array entry found?
if (!isset($this->readable[$this->name])) {
return $this->readable[$this->name];
}
+ // Cloning not allowed
+ function __clone () {
+ // Please do not clone this class
+ reportBug(__METHOD__, __LINE__, 'Cloning of this class is not allowed.');
+ }
} // END - class
// [EOF]
projects / mailer.git / blobdiff