Fixes/rewrites for 'dublicate entry' bug

[mailer.git] / inc / libs / cache_functions.php

diff --git a/inc/libs/cache_functions.php b/inc/libs/cache_functions.php
index 81a695e9cd5a20314562c20f069becaa9d2745e7..bc24b68aaec6f30ac425e79bd8679c6ee701de95 100644 (file)
--- a/inc/libs/cache_functions.php
+++ b/inc/libs/cache_functions.php
@@ -43,6 +43,7 @@ class CacheSystem {
        var $ret = "init";
        var $path = "";
        var $inc = "";
+       var $fqfn = "";
        var $pointer = false;
        var $data = array();
        var $version = array();
@@ -88,22 +89,26 @@ class CacheSystem {
                // Remember cache file
                $this->name = $cacheName;
 
-               // Construct FQFN (full qualified file name)
+               // COnstruct include filename for LOAD_INC_ONCE() call
                $this->inc = $this->path . $cacheName . ".cache";
 
+               // Construct FQFN (full qualified file name)
+               $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, "<?php\n");
@@ -112,7 +117,7 @@ class CacheSystem {
                        $this->storeExtensionVersion("cache");
                } else {
                        // Cannot create file
-                       addFatalMessage(__METHOD__, __LINE__, "(<font color=\"#0000aa\">".__LINE__."</font>): ".CACHE_PROBLEMS_DETECTED);
+                       addFatalMessage(__METHOD__, __LINE__, "(<font color=\"#0000aa\">".__LINE__."</font>): ".getMessage('CACHE_PROBLEMS_DETECTED'));
                }
        }
 
@@ -141,7 +146,7 @@ class CacheSystem {
                        }
                } else {
                        // Cannot create file
-                       addFatalMessage(__METHOD__, __LINE__, "(<font color=\"#0000aa\">".__LINE__."</font>): ".CACHE_PROBLEMS_DETECTED);
+                       addFatalMessage(__METHOD__, __LINE__, "(<font color=\"#0000aa\">".__LINE__."</font>): ".getMessage('CACHE_PROBLEMS_DETECTED'));
                }
        }
 
@@ -155,7 +160,7 @@ 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;
@@ -171,13 +176,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
-                       LOAD_INC_ONCE($this->inc);
+                       require($this->inc);
 
                        // Is there an array?
                        if (is_array($data)) {
@@ -204,37 +209,37 @@ class CacheSystem {
                        }
                } else {
                        // Cache file not found or not readable
-                       addFatalMessage(__METHOD__, __LINE__, "(<font color=\"#0000aa\">".__LINE__."</font>): ".CACHE_CANNOT_LOAD_1.$this->inc.CACHE_CANNOT_LOAD_2);
+                       addFatalMessage(__METHOD__, __LINE__, "(<font color=\"#0000aa\">".__LINE__."</font>): ".CACHE_CANNOT_LOAD_1.$this->fqfn.CACHE_CANNOT_LOAD_2);
                }
        }
 
        // Destroy an existing cache file
        function destroyCacheFile () {
                // Is the cache file there?
-               if ((!isset($this->rebuilt[$this->name])) && (FILE_READABLE($this->inc))) {
+               if ((!isset($this->rebuilt[$this->name])) && ($this->isCacheReadable())) {
                        // Close cache
                        $this->finalize();
 
                        // Remove cache file from system
                        //* DEBUG: */ print __METHOD__."(<font color=\"#0000aa\">".__LINE__."</font>): {$this->name} - DESTROYED!<br />\n";
-                       unlink($this->inc);
+                       unlink($this->fqfn);
 
                        // 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!
-                               addFatalMessage(__METHOD__, __LINE__, "(<font color=\"#0000aa\">".__LINE__."</font>): ".CACHE_CANNOT_UNLINK_1.$this->inc.CACHE_CANNOT_UNLINK_2);
+                               addFatalMessage(__METHOD__, __LINE__, "(<font color=\"#0000aa\">".__LINE__."</font>): ".CACHE_CANNOT_UNLINK_1.$this->fqfn.CACHE_CANNOT_UNLINK_2);
                        }
                } // 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();
 
@@ -258,7 +263,7 @@ class CacheSystem {
                        }
                } else {
                        // Cannot write to cache!
-                       addFatalMessage(__METHOD__, __LINE__, "(<font color=\"#0000aa\">".__LINE__."</font>): ".CACHE_PROBLEMS_DETECTED);
+                       addFatalMessage(__METHOD__, __LINE__, "(<font color=\"#0000aa\">".__LINE__."</font>): ".getMessage('CACHE_PROBLEMS_DETECTED'));
                }
        }
 
@@ -282,13 +287,13 @@ class CacheSystem {
                        } // END - foreach
                } else {
                        // Cannot write array!
-                       addFatalMessage(__METHOD__, __LINE__, "(<font color=\"#0000aa\">".__LINE__."</font>): ".CACHE_PROBLEMS_DETECTED);
+                       addFatalMessage(__METHOD__, __LINE__, "(<font color=\"#0000aa\">".__LINE__."</font>): ".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();
 
@@ -319,10 +324,11 @@ class CacheSystem {
                        } // END - if
                } else {
                        // Cannot write to cache!
-                       addFatalMessage(__METHOD__, __LINE__, "(<font color=\"#0000aa\">".__LINE__."</font>): ".CACHE_PROBLEMS_DETECTED);
+                       addFatalMessage(__METHOD__, __LINE__, "(<font color=\"#0000aa\">".__LINE__."</font>): ".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)) {
@@ -337,10 +343,11 @@ class CacheSystem {
                        //* DEBUG: */ print __METHOD__."(<font color=\"#0000aa\">".__LINE__."</font>): {$this->name} - {$ext_name}={$ext_ver}<br />\n";
                } else {
                        // Cannot create file
-                       addFatalMessage(__METHOD__, __LINE__, "(<font color=\"#0000aa\">".__LINE__."</font>): ".CACHE_PROBLEMS_DETECTED);
+                       addFatalMessage(__METHOD__, __LINE__, "(<font color=\"#0000aa\">".__LINE__."</font>): ".getMessage('CACHE_PROBLEMS_DETECTED'));
                }
        }
 
+       // Checks wether versions from cache and extension matches
        function extensionVersionMatches ($ext_name) {
                // Load cache (dummy)
                $this->getArrayFromCache();
@@ -353,13 +360,15 @@ class CacheSystem {
                        //* DEBUG: */ print __METHOD__."(<font color=\"#0000aa\">".__LINE__."</font>): cache={$this->name},ext_name={$ext_name} - {$ext_ver}/{$this->version[$this->name][$ext_name]}<br />\n";
                } else {
                        // No cache version found!
-                       DEBUG_LOG(__METHOD__, __LINE__, "Cache {$this->name} has missing entry for extension {$ext_name}!");
+                       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 = "";
@@ -374,8 +383,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 {
@@ -387,10 +398,16 @@ 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) {