X-Git-Url: https://git.mxchange.org/?p=mailer.git;a=blobdiff_plain;f=inc%2Flibs%2Fcache_functions.php;h=611073a72ae89cba3603f1129bd3f217afc0c64b;hp=a3b1d0a15e77831db0bf6c1d430869a2d2f426d6;hb=6586600d8020147192e5f28ca2a3a0153f774d3c;hpb=357b2ca133fc1f89db74097955c366cb4bee6996 diff --git a/inc/libs/cache_functions.php b/inc/libs/cache_functions.php index a3b1d0a15e..611073a72a 100644 --- a/inc/libs/cache_functions.php +++ b/inc/libs/cache_functions.php @@ -38,36 +38,31 @@ if (!defined('__SECURITY')) { } // Caching class -class mxchange_cache -{ +class CacheSystem { // Define variables - var $update_interval = 0; var $ret = "init"; - var $cache_path = ""; - var $cache_inc = ""; - var $cache_ctime = 0; - var $cache_pointer = false; - var $cache_data = ""; - var $cache_version = ""; + var $path = ""; + var $inc = ""; + var $pointer = false; + var $data = ""; + var $version = ""; + var $name = ""; // Constructor - function mxchange_cache($interval, $path, $tested) { + function CacheSystem ($interval, $path, $tested) { // Failed is the default $this->ret = "failed"; - // Remember interval in class - $this->update_interval = $interval; - // Remeber path - $this->cache_path = $path; + $this->path = $path; // Check if path exists if ((is_dir($path)) && (!$tested)) { // Check if we can create a file inside the path - @touch($path."dummy.tmp", 'w'); + touch($path."dummy.tmp", 'w'); if (FILE_READABLE($path."dummy.tmp")) { // Yes, we can do. So let's remove it - @unlink($path."dummy.tmp"); + unlink($path."dummy.tmp"); // Is there a .htaccess file? if (FILE_READABLE($path.".htaccess")) { @@ -87,59 +82,43 @@ class mxchange_cache } } - function cache_file($file, $ignore_ctime=false) { - global $INC; - // Construct FQFN (full qualified file name) - $inc = $this->cache_path.$file.".cache"; - - // Rember it + filename in class - $this->cache_inc = $inc; + // Checks validity of cache file and if content is given + function loadCacheFile ($file, $forceContent = false) { + // Remember cache file + $this->name = $file; - // Check if file exists - $status = (FILE_READABLE($inc) && (is_writeable($inc))); - if ($status) { - // Yes, it does. So let's get it's last changed date/time - $ctime = filectime($inc); - } else { - // No, it doesn't. Zero date/time - $ctime = 0; - } - - // Remember change date/time in class - $this->cache_ctime = $ctime; + // Construct FQFN (full qualified file name) + $this->inc = $this->path.$file.".cache"; - // Is the cache file outdated? - if (((time() - $ctime) >= $this->update_interval) && (!$ignore_ctime)) { - // Ok, we need an update! - $status = false; - } + // Check if file exists and if version matches + $status = (FILE_READABLE($this->inc) && (is_writeable($this->inc)) && ($this->extensionVersionMatches("cache"))); // Return status return $status; } - function cache_init($array) { + function init () { // This will destory an existing cache file! if ($this->ret == "done") { // Create file - if (FILE_READABLE($this->cache_inc)) @chmod($this->cache_inc, 0666); - $fp = @fopen($this->cache_inc, 'w') or mxchange_die("Cannot write to cache ".$this->cache_inc." !"); + if (FILE_READABLE($this->inc)) chmod($this->inc, 0666); + $this->pointer = fopen($this->inc, 'w') or mxchange_die("Cannot write to cache ".$this->inc." !"); - // Begin of cache file - fwrite($fp, "\$ARRAY = \"".$array."\";\n\n"); + // Add open PHP tag + fwrite($this->pointer, "cache_pointer = $fp; + // Add default depency + $this->storeExtensionVersion("cache"); } else { // Cannot create file ADD_FATAL(__FILE__."(".__LINE__."): ".CACHE_PROBLEMS_DETECTED); } } - function add_row ($data) { + function addRow ($data) { global $cacheArray; - if (is_resource($this->cache_pointer)) { + if (is_resource($this->pointer)) { // Write every array element to cache file foreach ($data as $k => $v) { // Write global cache array for immediate access @@ -158,7 +137,7 @@ class mxchange_cache } // Write cache line to file - @fwrite($this->cache_pointer, $this->add_raw_row($k, $v)); + fwrite($this->pointer, $this->rewriteEntry($k, $v)); } } else { // Cannot create file @@ -166,88 +145,100 @@ class mxchange_cache } } - function cache_close() - { + function finalize () { // Quit function when no pointer is set - if (empty($this->cache_pointer)) return; - if ($this->cache_pointer) - { + if (is_resource($this->pointer)) { + // Write footer + fwrite($this->pointer, "?>\n"); + // Close file add destroy handler - @fclose($this->cache_pointer); + fclose($this->pointer); // Set rights - if (FILE_READABLE($this->cache_inc)) @chmod($this->cache_inc, 0666); + if (FILE_READABLE($this->inc)) chmod($this->inc, 0666); // Remove pointer - unset($this->cache_pointer); - } - else - { + $this->pointer = false; + } else { // Cannot create file ADD_FATAL(__FILE__."(".__LINE__."): ".CACHE_PROBLEMS_DETECTED); } } - function cache_load() { + function getArrayFromCache () { + // Is the cache already loaded? + if (isset($this->data[$this->name])) { + // Return it's content! + return $this->data[$this->name]; + } // END - if + // Is the cache file there? - if (FILE_READABLE($this->cache_inc)) { + if (FILE_READABLE($this->inc)) { // Prepare temporary array $data = array(); $cache_version = null; // Load cache file - $this->cache_data = implode("", file($this->cache_inc)); - - // Execute cache file - eval($this->cache_data); + require_once($this->inc); + // Is there an array? if (is_array($data)) { // Cache data - $this->cache_data = $data; + $this->data[$this->name] = $data; // Cache version found? - if ((isset($cache_version)) && (is_array($cache_version))) { + if ((is_array($cache_version)) && (count($cache_version) > 0)) { // Remember it as well... - $this->cache_version = $cache_version; - } // END - if + $this->version[$this->name] = $cache_version; + } else { + // Invalid cache so destroy it + $this->destroyCacheFile(); + + // Clear cached data + $this->data[$this->name] = array(); + } // Return cache - return $this->cache_data; + return $this->data[$this->name]; } else { // Cache problem detected! - $this->cache_destroy(); + $this->destroyCacheFile(); } } else { // Cache file not found or not readable - ADD_FATAL(__FILE__."(".__LINE__."): ".CACHE_CANNOT_LOAD_1.$this->cache_inc.CACHE_CANNOT_LOAD_2); + ADD_FATAL(__FILE__."(".__LINE__."): ".CACHE_CANNOT_LOAD_1.$this->inc.CACHE_CANNOT_LOAD_2); } } // Destroy an existing cache file - function cache_destroy() { + function destroyCacheFile () { // Is the cache file there? - if (FILE_READABLE($this->cache_inc)) { + if (FILE_READABLE($this->inc)) { + // Close cache + $this->finalize(); + // Remove cache file from system - @unlink($this->cache_inc); - if (!FILE_READABLE($this->cache_inc)) { - // Close cache automatically (we don't need it anymore!) - $this->cache_close(); + unlink($this->inc); + + // Is the file there? + if (!FILE_READABLE($this->inc)) { + // The cache does no longer exist so kill the content + unset($this->data[$this->name]); } else { // Not removed! - ADD_FATAL(__FILE__."(".__LINE__."): ".CACHE_CANNOT_UNLINK_1.$this->cache_inc.CACHE_CANNOT_UNLINK_2); + ADD_FATAL(__FILE__."(".__LINE__."): ".CACHE_CANNOT_UNLINK_1.$this->inc.CACHE_CANNOT_UNLINK_2); } } else { // Does not exist! - ADD_FATAL(__FILE__."(".__LINE__."): ".CACHE_CANNOT_UNLINK_1.$this->cache_inc.CACHE_CANNOT_UNLINK_2); + ADD_FATAL(__FILE__."(".__LINE__."): ".CACHE_PROBLEMS_DETECTED); } } - function cache_remove($search, $data, $array) - { - global $ARRAY; - if ((FILE_READABLE($this->cache_inc)) && (is_writeable($this->cache_inc))) { + // Unused method: + function removeEntry ($search, $data, $array) { + if ((FILE_READABLE($this->inc)) && (is_writeable($this->inc))) { // Load cache into dummy array - $dummy = $this->cache_load(); + $dummy = $this->getArrayFromCache(); // Search for key in array $key = array_search($data, $dummy[$search]); @@ -259,27 +250,13 @@ class mxchange_cache } // Flush array to cache file - $fp = fopen($this->cache_inc, 'w'); - fwrite($fp, "\$ARRAY = \"".$ARRAY."\";\n"); - foreach ($dummy as $k => $v) { - if (is_array($v)) { - // Multi line(s) found - $LINE = ""; - foreach($v as $k2 => $v2) { - // Put every array element in a row... - $LINE .= $this->add_raw_row($k, $v2); - } - } else { - // Single line found - $LINE = $this->add_raw_row($k, $v); - } + $this->init(); - // Write line(s) - fwrite($fp, $LINE); - } + // Write array out + $this->writeArray($dummy); // Close cache file - fclose($fp); + $this->finalize(); } } else { // Cannot write to cache! @@ -287,13 +264,35 @@ class mxchange_cache } } - function cache_replace($search, $replace, $search_key, $array) - { - global $ARRAY; - if ((FILE_READABLE($this->cache_inc)) && (is_writeable($this->cache_inc))) - { + function writeArray ($array) { + if (is_resource($this->pointer)) { + foreach ($array as $k => $v) { + if (is_array($v)) { + // Multi line(s) found + $LINE = ""; + foreach($v as $k2 => $v2) { + // Put every array element in a row... + $LINE .= $this->rewriteEntry($k, $v2); + } + } else { + // Single line found + $LINE = $this->rewriteEntry($k, $v); + } + + // Write line(s) + fwrite($this->pointer, $LINE); + } // END - foreach + } else { + // Cannot write array! + ADD_FATAL(__FILE__."(".__LINE__."): ".CACHE_PROBLEMS_DETECTED); + } + } + + // Unused method + function replaceEntry ($search, $replace, $search_key, $array) { + if ((FILE_READABLE($this->inc)) && (is_writeable($this->inc))) { // Load cache into dummy array - $dummy = $this->cache_load(); + $dummy = $this->getArrayFromCache(); // Check if $dummy is valid (prevents some errors) if ((is_array($dummy)) && (isset($dummy[$search])) && (is_array($dummy[$search]))) { @@ -311,27 +310,13 @@ class mxchange_cache } // Flush array to cache file - $fp = fopen($this->cache_inc, 'w'); - fwrite($fp, "\$dummy = \"".$ARRAY."\";\n"); - foreach ($dummy as $k => $v) { - if (is_array($v)) { - // Multi line(s) found - $LINE = ""; - foreach($v as $k2 => $v2) { - // Put every array element in a row... - $LINE .= $this->add_raw_row($k, $v2); - } - } else { - // Single line found - $LINE = $this->add_raw_row($k, $v); - } + $this->init(); - // Write line(s) - fwrite($fp, $LINE); - } + // Write array out + $this->writeArray($dummy); // Close cache file - fclose($fp); + $this->finalize(); } } } else { @@ -340,40 +325,49 @@ class mxchange_cache } } - function store_extension_version ($ext_name) { + function storeExtensionVersion ($ext_name) { // Valid cache pointer? - if (is_resource($this->cache_pointer)) { + if (is_resource($this->pointer)) { // Get extension version $ext_ver = GET_EXT_VERSION($ext_name); // Write cache line to file - @fwrite($this->cache_pointer, "\$cache_version['".$ext_name."'] = \"".$ext_ver."\";\n"); + fwrite($this->pointer, "\$cache_version['".$ext_name."'] = \"".$ext_ver."\";\n"); } else { // Cannot create file ADD_FATAL(__FILE__."(".__LINE__."): ".CACHE_PROBLEMS_DETECTED); } } - function ext_version_matches ($ext_name) { + function extensionVersionMatches ($ext_name) { // Load cache (dummy) - $this->cache_load(); + $this->getArrayFromCache(); // Get extension version $ext_ver = GET_EXT_VERSION($ext_name); - //* DEBUG: */ echo __METHOD__.": ext_name={$ext_name},ext_ver={$ext_ver},cache_version={$this->cache_version}
\n"; // Compare both - return ((isset($this->cache_version[$ext_name])) && ($this->cache_version[$ext_name] == $ext_ver)); + return ((isset($this->version[$this->name][$ext_name])) && ($this->version[$this->name][$ext_name] == $ext_ver)); } - function add_raw_row ($key, $value) { + function rewriteEntry ($key, $value) { // Init line $line = ""; // String or non-string? ;-) - if ((is_string($value)) || (is_null($value))) { + if (is_string($value)) { // String... $line = "\$data['".$key."'][] = \"".$value."\";\n"; + } elseif (is_null($value)) { + // Null + $line = "\$data['".$key."'][] = null;\n"; + } elseif (is_bool($value)) { + // Boolean value + if ($value === true) { + $line = "\$data['".$key."'][] = true;\n"; + } else { + $line = "\$data['".$key."'][] = false;\n"; + } } else { // Non-string $line = "\$data['".$key."'][] = ".$value.";\n";