X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=inc%2Flibs%2Fcache_functions.php;h=d4eccba5a347e35f02fbb52876a8091cc72bc23b;hb=46f2e389417a40f1029612b58cb285416ccae7a5;hp=bb24447efda1ab67f3b79ec8dd00bbce66048dec;hpb=8fcf84db9fb67ecc531962b23811330d5cd07a91;p=mailer.git
diff --git a/inc/libs/cache_functions.php b/inc/libs/cache_functions.php
index bb24447efd..d4eccba5a3 100644
--- a/inc/libs/cache_functions.php
+++ b/inc/libs/cache_functions.php
@@ -10,7 +10,12 @@
* -------------------------------------------------------------------- *
* Kurzbeschreibung : Funktionen fuer die admins-Erweiterung *
* -------------------------------------------------------------------- *
- * *
+ * $Revision:: $ *
+ * $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 - 2008 by Roland Haeder *
* For more information visit: http://www.mxchange.org *
@@ -43,10 +48,12 @@ class CacheSystem {
var $ret = "init";
var $path = "";
var $inc = "";
+ var $fqfn = "";
var $pointer = false;
- var $data = "";
- var $version = "";
+ var $data = array();
+ var $version = array();
var $name = "";
+ var $rebuilt = array();
// Constructor
function CacheSystem ($interval, $path, $tested) {
@@ -57,7 +64,7 @@ class CacheSystem {
$this->path = $path;
// Check if path exists
- if ((is_dir($path)) && (!$tested)) {
+ if ((isDirectory($path)) && (!$tested)) {
// Check if we can create a file inside the path
touch($path."dummy.tmp", 'w');
if (FILE_READABLE($path."dummy.tmp")) {
@@ -83,26 +90,30 @@ class CacheSystem {
}
// Checks validity of cache file and if content is given
- function loadCacheFile ($file, $forceContent = false) {
+ function loadCacheFile ($cacheName, $forceContent = false) {
// Remember cache file
- $this->name = $file;
+ $this->name = $cacheName;
+
+ // Construct include filename for LOAD_INC_ONCE() call
+ $this->inc = $this->path . $cacheName . ".cache";
// Construct FQFN (full qualified file name)
- $this->inc = $this->path.$file.".cache";
+ $this->fqfn = constant('PATH') . $this->inc;
// Check if file exists and if version matches
- $status = (FILE_READABLE($this->inc) && (is_writeable($this->inc)) && ($this->extensionVersionMatches("cache")));
+ $status = ($this->isCacheReadable() && (is_writeable($this->fqfn)) && ($this->extensionVersionMatches("cache")));
// Return status
return $status;
}
+ // Initializes the cache file
function init () {
// This will destory an existing cache file!
if ($this->ret == "done") {
// Create file
- if (FILE_READABLE($this->inc)) chmod($this->inc, 0666);
- $this->pointer = fopen($this->inc, 'w') or mxchange_die("Cannot write to cache ".$this->inc." !");
+ if ($this->isCacheReadable()) chmod($this->fqfn, 0666);
+ $this->pointer = fopen($this->fqfn, 'w') or mxchange_die("Cannot write to cache ".$this->fqfn." !");
// Add open PHP tag
fwrite($this->pointer, "storeExtensionVersion("cache");
} else {
// Cannot create file
- ADD_FATAL(__FILE__."(".__LINE__."): ".CACHE_PROBLEMS_DETECTED);
+ addFatalMessage(__METHOD__, __LINE__, "(".__LINE__."): ".getMessage('CACHE_PROBLEMS_DETECTED'));
}
}
function addRow ($data) {
- global $cacheArray;
-
+ // Is the pointe rvalid?
if (is_resource($this->pointer)) {
// Write every array element to cache file
foreach ($data as $k => $v) {
// Write global cache array for immediate access
if ((substr($k, 0, 4) == "ext_") && (isset($data['ext_name'])) && (isset($data['ext_id']))) {
if ($k != "ext_name") {
- $cacheArray['extensions'][$k][$data['ext_name']] = $v;
+ $GLOBALS['cache_array']['extensions'][$k][$data['ext_name']] = $v;
} else {
- $cacheArray['extensions'][$k][$data['ext_id']] = $v;
+ $GLOBALS['cache_array']['extensions'][$k][$data['ext_id']] = $v;
}
if (($k == "ext_keep") && ($v == "Y")) {
- $cacheArray['active_extensions'][$data['ext_name']] = $v;
+ $GLOBALS['cache_array']['active_extensions'][$data['ext_name']] = $v;
} // END - if
} elseif (is_array($v)) {
// Serialize and BASE64-encode the array
@@ -141,7 +151,7 @@ class CacheSystem {
}
} else {
// Cannot create file
- ADD_FATAL(__FILE__."(".__LINE__."): ".CACHE_PROBLEMS_DETECTED);
+ addFatalMessage(__METHOD__, __LINE__, "(".__LINE__."): ".getMessage('CACHE_PROBLEMS_DETECTED'));
}
}
@@ -155,10 +165,11 @@ class CacheSystem {
fclose($this->pointer);
// Set rights
- if (FILE_READABLE($this->inc)) chmod($this->inc, 0666);
+ if ($this->isCacheReadable()) chmod($this->fqfn, 0666);
// Remove pointer
$this->pointer = false;
+ //* DEBUG: */ print __METHOD__."(".__LINE__."): {$this->name} - FINALIZED!
\n";
} // END - if
}
@@ -170,13 +181,13 @@ class CacheSystem {
} // END - if
// Is the cache file there?
- if (FILE_READABLE($this->inc)) {
+ if ($this->isCacheReadable()) {
// Prepare temporary array
$data = array();
$cache_version = null;
// Load cache file
- require_once($this->inc);
+ require($this->inc);
// Is there an array?
if (is_array($data)) {
@@ -203,37 +214,38 @@ class CacheSystem {
}
} else {
// Cache file not found or not readable
- ADD_FATAL(__FILE__."(".__LINE__."): ".CACHE_CANNOT_LOAD_1.$this->inc.CACHE_CANNOT_LOAD_2);
+ addFatalMessage(__METHOD__, __LINE__, "(".__LINE__."): ".CACHE_CANNOT_LOAD_1.$this->fqfn.CACHE_CANNOT_LOAD_2);
}
}
// Destroy an existing cache file
function destroyCacheFile () {
// Is the cache file there?
- if (FILE_READABLE($this->inc)) {
+ if ((!isset($this->rebuilt[$this->name])) && ($this->isCacheReadable())) {
// Close cache
$this->finalize();
// Remove cache file from system
- unlink($this->inc);
+ //* DEBUG: */ print __METHOD__."(".__LINE__."): {$this->name} - DESTROYED!
\n";
+ unlink($this->fqfn);
+ // @TODO remove from $GLOBALS['cache_array']!!!
// Is the file there?
- if (!FILE_READABLE($this->inc)) {
+ if (!$this->isCacheReadable()) {
// 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;
} else {
// Not removed!
- ADD_FATAL(__FILE__."(".__LINE__."): ".CACHE_CANNOT_UNLINK_1.$this->inc.CACHE_CANNOT_UNLINK_2);
+ addFatalMessage(__METHOD__, __LINE__, "(".__LINE__."): ".CACHE_CANNOT_UNLINK_1.$this->fqfn.CACHE_CANNOT_UNLINK_2);
}
- } else {
- // Does not exist!
- ADD_FATAL(__FILE__."(".__LINE__."): ".CACHE_PROBLEMS_DETECTED);
- }
+ } // END - if
}
// Unused method:
function removeEntry ($search, $data, $array) {
- if ((FILE_READABLE($this->inc)) && (is_writeable($this->inc))) {
+ if (($this->isCacheReadable()) && (is_writeable($this->fqfn))) {
// Load cache into dummy array
$dummy = $this->getArrayFromCache();
@@ -244,7 +256,7 @@ class CacheSystem {
foreach ($array as $a) {
// So we can remove all elements as requested
unset($dummy[$a][$key]);
- }
+ } // END - foreach
// Flush array to cache file
$this->init();
@@ -257,7 +269,7 @@ class CacheSystem {
}
} else {
// Cannot write to cache!
- ADD_FATAL(__FILE__."(".__LINE__."): ".CACHE_PROBLEMS_DETECTED);
+ addFatalMessage(__METHOD__, __LINE__, "(".__LINE__."): ".getMessage('CACHE_PROBLEMS_DETECTED'));
}
}
@@ -281,13 +293,13 @@ class CacheSystem {
} // END - foreach
} else {
// Cannot write array!
- ADD_FATAL(__FILE__."(".__LINE__."): ".CACHE_PROBLEMS_DETECTED);
+ addFatalMessage(__METHOD__, __LINE__, "(".__LINE__."): ".getMessage('CACHE_PROBLEMS_DETECTED'));
}
}
// Unused method
function replaceEntry ($search, $replace, $search_key, $array) {
- if ((FILE_READABLE($this->inc)) && (is_writeable($this->inc))) {
+ if (($this->isCacheReadable()) && (is_writeable($this->fqfn))) {
// Load cache into dummy array
$dummy = $this->getArrayFromCache();
@@ -303,8 +315,8 @@ class CacheSystem {
if ($a == $search) {
// Update now...
$dummy[$a][$search_key] = $replace;
- }
- }
+ } // END - if
+ } // END - foreach
// Flush array to cache file
$this->init();
@@ -314,14 +326,15 @@ class CacheSystem {
// Close cache file
$this->finalize();
- }
- }
+ } // END - if
+ } // END - if
} else {
// Cannot write to cache!
- ADD_FATAL(__FILE__."(".__LINE__."): ".CACHE_PROBLEMS_DETECTED);
+ addFatalMessage(__METHOD__, __LINE__, "(".__LINE__."): ".getMessage('CACHE_PROBLEMS_DETECTED'));
}
}
+ // Writes the version of given extension to the cache file
function storeExtensionVersion ($ext_name) {
// Valid cache pointer?
if (is_resource($this->pointer)) {
@@ -330,12 +343,17 @@ class CacheSystem {
// Write cache line to file
fwrite($this->pointer, "\$cache_version['".$ext_name."'] = \"".$ext_ver."\";\n");
+
+ // Add the extension version to object (DO NOT REMOVE IT! Endless loop...)
+ $this->version[$this->name][$ext_name] = $ext_ver;
+ //* DEBUG: */ print __METHOD__."(".__LINE__."): {$this->name} - {$ext_name}={$ext_ver}
\n";
} else {
// Cannot create file
- ADD_FATAL(__FILE__."(".__LINE__."): ".CACHE_PROBLEMS_DETECTED);
+ addFatalMessage(__METHOD__, __LINE__, "(".__LINE__."): ".getMessage('CACHE_PROBLEMS_DETECTED'));
}
}
+ // Checks wether versions from cache and extension matches
function extensionVersionMatches ($ext_name) {
// Load cache (dummy)
$this->getArrayFromCache();
@@ -343,10 +361,20 @@ class CacheSystem {
// Get extension version
$ext_ver = GET_EXT_VERSION($ext_name);
+ // Debug messages
+ if (isset($this->version[$this->name][$ext_name])) {
+ //* DEBUG: */ print __METHOD__."(".__LINE__."): cache={$this->name},ext_name={$ext_name} - {$ext_ver}/{$this->version[$this->name][$ext_name]}
\n";
+ } else {
+ // No cache version found!
+ DEBUG_LOG(__METHOD__, __LINE__, "Cache {$this->name} has missing version entry for extension {$ext_name}!");
+ }
+
// Compare both
return ((isset($this->version[$this->name][$ext_name])) && ($this->version[$this->name][$ext_name] == $ext_ver));
}
+ // 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) {
// Init line
$line = "";
@@ -361,8 +389,10 @@ class CacheSystem {
} elseif (is_bool($value)) {
// Boolean value
if ($value === true) {
+ // True
$line = "\$data['".$key."'][] = true;\n";
} else {
+ // False
$line = "\$data['".$key."'][] = false;\n";
}
} else {
@@ -374,9 +404,54 @@ class CacheSystem {
return $line;
}
+ // Getter for cache status
function getStatus () {
return $this->ret;
}
+
+ // Checks wether the current cache file is readable
+ function isCacheReadable () {
+ return INCLUDE_READABLE($this->inc);
+ }
+
+} // END - class
+
+// Destroy the cache on extension changes
+function FILTER_CACHE_DESTROY_ON_EXT_CHANGE ($data) {
+ // Remove cache
+ if ($GLOBALS['cache_instance']->loadCacheFile("config")) $GLOBALS['cache_instance']->destroyCacheFile();
+ if ($GLOBALS['cache_instance']->loadCacheFile("extensions")) $GLOBALS['cache_instance']->destroyCacheFile();
+ if ($GLOBALS['cache_instance']->loadCacheFile("modreg")) $GLOBALS['cache_instance']->destroyCacheFile();
+
+ // Return it
+ return $data;
}
+
+// Destroy the cache on changing admin
+function FILTER_CACHE_DESTROY_ON_ADMIN_CHANGE () {
+ // Remove cache
+ if ($GLOBALS['cache_instance']->loadCacheFile("admins")) $GLOBALS['cache_instance']->destroyCacheFile();
+}
+
+// Destroy all cache files
+function FILTER_CACHE_DESTROY_ALL () {
+ // Remove cache files
+ if ($GLOBALS['cache_instance']->loadCacheFile("admins")) $GLOBALS['cache_instance']->destroyCacheFile();
+ if ($GLOBALS['cache_instance']->loadCacheFile("admins_acls")) $GLOBALS['cache_instance']->destroyCacheFile();
+ if ($GLOBALS['cache_instance']->loadCacheFile("config")) $GLOBALS['cache_instance']->destroyCacheFile();
+ if ($GLOBALS['cache_instance']->loadCacheFile("extensions")) $GLOBALS['cache_instance']->destroyCacheFile();
+ if ($GLOBALS['cache_instance']->loadCacheFile("modreg")) $GLOBALS['cache_instance']->destroyCacheFile();
+ if ($GLOBALS['cache_instance']->loadCacheFile("refdepths")) $GLOBALS['cache_instance']->destroyCacheFile();
+ if ($GLOBALS['cache_instance']->loadCacheFile("refsystem")) $GLOBALS['cache_instance']->destroyCacheFile();
+ if ($GLOBALS['cache_instance']->loadCacheFile("themes")) $GLOBALS['cache_instance']->destroyCacheFile();
+ if ($GLOBALS['cache_instance']->loadCacheFile("revision")) $GLOBALS['cache_instance']->destroyCacheFile();
+}
+
+// Filter for purging entire admin menu cache
+function FILTER_CACHE_PURGE_ADMIN_MENU () {
+ // Just call the function
+ CACHE_PURGE_ADMIN_MENU();
+}
+
//
?>