Method extensionVersionMatches() is now cached in
[mailer.git] / inc / classes / cachesystem.class.php
index 69ce20fef1eecdde14c9a5d0180cdf00a2808831..ae127dc27eb69e79faca27b1fd481cb94310c23b 100644 (file)
@@ -1,7 +1,7 @@
 <?php
 /************************************************************************
- * MXChange v0.2.1                                    Start: 10/22/2009 *
- * ===============                              Last change: 10/22/2009 *
+ * Mailer v0.2.1-FINAL                                Start: 10/22/2009 *
+ * ===================                          Last change: 10/22/2009 *
  *                                                                      *
  * -------------------------------------------------------------------- *
  * File              : cachesystem.class.php                            *
@@ -18,6 +18,7 @@
  * svn:keywords Date Revision" (autoprobset!) at least!!!!!!            *
  * -------------------------------------------------------------------- *
  * Copyright (c) 2003 - 2009 by Roland Haeder                           *
+ * Copyright (c) 2009, 2010 by Mailer Developer Team                    *
  * For more information visit: http://www.mxchange.org                  *
  *                                                                      *
  * This program is free software; you can redistribute it and/or modify *
@@ -65,26 +66,14 @@ class CacheSystem {
 
                // Check if path exists
                if (isDirectory(getConfig('CACHE_PATH'))) {
-                       // Make FQFN for dummy file
-                       $FQFN = getConfig('CACHE_PATH') . 'dummy.tmp';
-
-                       // Check if we can create a file inside the path
-                       touch($FQFN, 'w');
-
-                       // Is the file there?
-                       if (isFileReadable($FQFN)) {
-                               // Yes, we can do. So let's remove it
-                               removeFile($FQFN);
-
-                               // Is there a .htaccess file?
-                               if (isFileReadable(getConfig('CACHE_PATH') . '.htaccess')) {
-                                       // All done!
-                                       $this->ret = $this->statusDone;
-                               } else {
-                                       // Stop! Set a .htaccess file first
-                                       $this->ret = 'htaccess';
-                               }
-                       } // END - if
+                       // Is there a .htaccess file?
+                       if (isFileReadable(getConfig('CACHE_PATH') . '.htaccess')) {
+                               // All done!
+                               $this->ret = $this->statusDone;
+                       } else {
+                               // Stop! Set a .htaccess file first
+                               $this->ret = 'htaccess';
+                       }
                } // END - if
        }
 
@@ -125,7 +114,7 @@ class CacheSystem {
                        fwrite($this->pointer, "<?php\n");
                } else {
                        // Cannot create file
-                       addFatalMessage(__METHOD__, __LINE__, "(<font color=\"#0000aa\">".__LINE__."</font>): ".getMessage('CACHE_PROBLEMS_DETECTED'));
+                       addFatalMessage(__METHOD__, __LINE__, '(<font color="#0000aa">' . __LINE__ . '</font>): ' . getMessage('CACHE_PROBLEMS_DETECTED'));
                }
        }
 
@@ -149,19 +138,65 @@ class CacheSystem {
                                                $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 ($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']['counter'][$data['filter_name']][$data['filter_function']] = $data['filter_counter'];
+                                       $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 {
+                                               $GLOBALS['cache_array']['admin'][$k][$data['login']] = $v;
+                                       }
+                               } elseif ($this->name == 'refdepths') {
+                                       // Referal levels
+                                       $GLOBALS['cache_array']['refdepths'][$k][$data['id']] = $v;
+                               } elseif ($this->name == 'refsystem') {
+                                       // Referal system
+                                       $GLOBALS['cache_array']['refsystem'][$k][$data['id']] = $v;
+                               } elseif ($this->name == 'revision') {
+                                       // Revision data
+                                       $GLOBALS['cache_array']['revision'][$k][0] = $v;
+                               } elseif ($this->name == 'themes') {
+                                       // Themes
+                                       if ($k == 'theme_path') {
+                                               $GLOBALS['cache_array']['themes'][$k][$data['id']] = $v;
+                                       } 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 (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);
+
+                                       // Unsupported cache found!
+                                       debug_report_bug('Unsupported cache ' . $this->name . ' detected.');
                                }
 
                                // Write cache line to file
                                fwrite($this->pointer, $this->rewriteEntry($k, $v));
-                       }
+                       } // END - foreach
                } else {
                        // Cannot create file
-                       addFatalMessage(__METHOD__, __LINE__, "(<font color=\"#0000aa\">".__LINE__."</font>): ".getMessage('CACHE_PROBLEMS_DETECTED'));
+                       addFatalMessage(__METHOD__, __LINE__, '(<font color="#0000aa">' . __LINE__ . '</font>): ' . getMessage('CACHE_PROBLEMS_DETECTED'));
                }
        }
 
@@ -186,7 +221,7 @@ class CacheSystem {
                        // Remove pointer and status
                        unset($this->status[$this->name]);
                        $this->pointer = false;
-                       //* DEBUG: */ outputHtml(__METHOD__."(<font color=\"#0000aa\">".__LINE__."</font>): {$this->name} - FINALIZED!<br />");
+                       //* DEBUG: */ outputHtml(__METHOD__ . '(<font color="#0000aa">' . __LINE__."</font>): {$this->name} - FINALIZED!<br />");
                } // END - if
        }
 
@@ -200,7 +235,7 @@ class CacheSystem {
                // 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])) {
@@ -226,7 +261,7 @@ class CacheSystem {
                } 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));
+                       addFatalMessage(__METHOD__, __LINE__, '(<font color="#0000aa">' . __LINE__ . '</font>): ' . getMaskedMessage('CACHE_CANNOT_LOAD', $this->fqfn));
 
                        // Try to remove it
                        $this->removeCacheFile();
@@ -237,7 +272,7 @@ class CacheSystem {
        }
 
        // Destroy an existing cache file
-       function removeCacheFile ($removeArray = false, $force = false) {
+       function removeCacheFile ($force = false) {
                // Reset read status
                $this->resetCacheReadStatus();
 
@@ -251,7 +286,7 @@ class CacheSystem {
                                // Debug message if allowed
                                if (isDebugModeEnabled()) {
                                        // Debug message
-                                       debug_report_bug('Not removing cache ' . $this->name . ' in output_mode=' . getOutputMode());
+                                       logDebugMessage(__METHOD__, __LINE__, 'Not removing cache ' . $this->name . ' in output_mode=' . getOutputMode());
                                } // END - if
 
                                // Abort here
@@ -273,18 +308,6 @@ class CacheSystem {
                        // Reset read status
                        $this->resetCacheReadStatus();
 
-                       // Shall we remove the array from memory?
-                       if ($removeArray === true) {
-                               // Debug message if allowed
-                               if (isDebugModeEnabled()) {
-                                       // Debug message
-                                       logDebugMessage(__METHOD__, __LINE__, 'removing array!');
-                               } // END - if
-
-                               // Remove it from memory
-                               unset($GLOBALS['cache_array'][$this->name]);
-                       } // END - if
-
                        // Is the file there?
                        if (!$this->isCacheReadable()) {
                                // The cache does no longer exist so kill the content
@@ -293,7 +316,7 @@ class CacheSystem {
                                $this->rebuilt[$this->name] = true;
                        } else {
                                // Not removed!
-                               addFatalMessage(__METHOD__, __LINE__, "(<font color=\"#0000aa\">".__LINE__."</font>): ".sprintf(getMessage('CACHE_CANNOT_UNLINK'), $this->fqfn));
+                               addFatalMessage(__METHOD__, __LINE__, '(<font color="#0000aa">' . __LINE__ . '</font>): ' . getMaskedMessage('CACHE_CANNOT_UNLINK', $this->fqfn));
                        }
                } // END - if
        }
@@ -324,7 +347,7 @@ class CacheSystem {
                        }
                } else {
                        // Cannot write to cache!
-                       addFatalMessage(__METHOD__, __LINE__, "(<font color=\"#0000aa\">".__LINE__."</font>): ".getMessage('CACHE_PROBLEMS_DETECTED'));
+                       addFatalMessage(__METHOD__, __LINE__, '(<font color="#0000aa">' . __LINE__ . '</font>): ' . getMessage('CACHE_PROBLEMS_DETECTED'));
                }
        }
 
@@ -348,7 +371,7 @@ class CacheSystem {
                        } // END - foreach
                } else {
                        // Cannot write array!
-                       addFatalMessage(__METHOD__, __LINE__, "(<font color=\"#0000aa\">".__LINE__."</font>): ".getMessage('CACHE_PROBLEMS_DETECTED'));
+                       addFatalMessage(__METHOD__, __LINE__, '(<font color="#0000aa">' . __LINE__ . '</font>): ' . getMessage('CACHE_PROBLEMS_DETECTED'));
                }
        }
 
@@ -385,7 +408,7 @@ class CacheSystem {
                        } // END - if
                } else {
                        // Cannot write to cache!
-                       addFatalMessage(__METHOD__, __LINE__, "(<font color=\"#0000aa\">".__LINE__."</font>): ".getMessage('CACHE_PROBLEMS_DETECTED'));
+                       addFatalMessage(__METHOD__, __LINE__, '(<font color="#0000aa">' . __LINE__ . '</font>): ' . getMessage('CACHE_PROBLEMS_DETECTED'));
                }
        }
 
@@ -398,47 +421,50 @@ class CacheSystem {
                                // 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
+                               fwrite($this->pointer, $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: */ outputHtml(__METHOD__ . '(<font color="#0000aa">' . __LINE__."</font>): {$this->name} - {$ext_name}={$ext_ver}<br />");
                } else {
                        // Cannot create file
-                       addFatalMessage(__METHOD__, __LINE__, "(<font color=\"#0000aa\">".__LINE__."</font>): ".getMessage('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) {
-               // 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(false, true);
+               // Check cache
+               if (!isset($GLOBALS[__METHOD__][$ext_name])) {
+                       // 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] = ((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);
+                               }
+                       } 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
@@ -456,7 +482,7 @@ class CacheSystem {
                // String or non-string? ;-)
                if (is_string($value)) {
                        // String...
-                       $line = '$this->' . $prefix . "['".$this->name."']['" . $key . "']" . $extender . " = '" . smartAddSlashes($value) . "';\n";
+                       $line = '$this->' . $prefix . "['".$this->name."']['" . $key . "']" . $extender . " = '" . escapeQuotes($value) . "';\n";
                } elseif (is_null($value)) {
                        // Null
                        $line = '$this->' . $prefix . "['".$this->name."']['" . $key . "']" . $extender . " = null;\n";
@@ -469,6 +495,9 @@ class CacheSystem {
                                // False
                                $line = '$this->' . $prefix . "['".$this->name."']['" . $key . "']" . $extender . " = false;\n";
                        }
+               } elseif (isset($value[0])) {
+                       // These lines needs fixing
+                       debug_report_bug('Invalid entry with [0] found. key=' . $key);
                } else {
                        // Non-string
                        $line = '$this->' . $prefix . "['".$this->name."']['" . $key . "']" . $extender . " = " . $value . ";\n";