[1.7.0] Implement Cleanup decorator

- Create generic DecoratorHarness
- Name decorators, so that they can be overridden or removed
- Add setup function to definition cache factory

git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@1118 48356398-32a2-884e-a903-53898d9a118a

library/HTMLPurifier/DefinitionCache/Decorator.php

@@ -3,6 +3,7 @@
 require_once 'HTMLPurifier/DefinitionCache.php';
 
 require_once 'HTMLPurifier/DefinitionCache/Decorator/Memory.php';
+require_once 'HTMLPurifier/DefinitionCache/Decorator/Cleanup.php';
 
 class HTMLPurifier_DefinitionCache_Decorator extends HTMLPurifier_DefinitionCache
 {

library/HTMLPurifier/DefinitionCache/Decorator/Cleanup.php

@@ -0,0 +1,45 @@
+<?php
+
+require_once 'HTMLPurifier/DefinitionCache/Decorator.php';
+
+/**
+ * Definition cache decorator class that cleans up the cache
+ * whenever there is a cache miss.
+ */
+class HTMLPurifier_DefinitionCache_Decorator_Cleanup extends
+      HTMLPurifier_DefinitionCache_Decorator
+{
+    
+    var $name = 'Cleanup';
+    
+    function copy() {
+        return new HTMLPurifier_DefinitionCache_Decorator_Cleanup();
+    }
+    
+    function add($def, $config) {
+        $status = parent::add($def, $config);
+        if (!$status) parent::cleanup($config);
+        return $status;
+    }
+    
+    function set($def, $config) {
+        $status = parent::set($def, $config);
+        if (!$status) parent::cleanup($config);
+        return $status;
+    }
+    
+    function replace($def, $config) {
+        $status = parent::replace($def, $config);
+        if (!$status) parent::cleanup($config);
+        return $status;
+    }
+    
+    function get($config) {
+        $ret = parent::get($config);
+        if (!$ret) parent::cleanup($config);
+        return $ret;
+    }
+    
+}
+
+?>

library/HTMLPurifier/DefinitionCache/Decorator/Memory.php

@@ -12,6 +12,7 @@ class HTMLPurifier_DefinitionCache_Decorator_Memory extends
 {
     
     var $definitions;
+    var $name = 'Memory';
     
     function copy() {
         return new HTMLPurifier_DefinitionCache_Decorator_Memory();

library/HTMLPurifier/DefinitionCache/Decorator/Template.php.in

@@ -9,9 +9,10 @@ class HTMLPurifier_DefinitionCache_Decorator_Template extends
       HTMLPurifier_DefinitionCache_Decorator
 {
     
-    // must be defined!!!
+    var $name = 'Template'; // replace this
     
     function copy() {
+        // replace class name with yours
         return new HTMLPurifier_DefinitionCache_Decorator_Template();
     }
     

library/HTMLPurifier/DefinitionCacheFactory.php

@@ -24,6 +24,13 @@ class HTMLPurifier_DefinitionCacheFactory
     var $caches = array('Serializer' => array());
     var $decorators = array();
     
+    /**
+     * Initialize default decorators
+     */
+    function setup() {
+        $this->addDecorator('Cleanup');
+    }
+    
     /**
      * Retrieves an instance of global definition cache factory.
      * @static
@@ -34,6 +41,7 @@ class HTMLPurifier_DefinitionCacheFactory
             $instance = $prototype;
         } elseif ($instance === null || $prototype === true) {
             $instance = new HTMLPurifier_DefinitionCacheFactory();
+            $instance->setup();
         }
         return $instance;
     }
@@ -74,7 +82,7 @@ class HTMLPurifier_DefinitionCacheFactory
             $class = "HTMLPurifier_DefinitionCache_Decorator_$decorator";
             $decorator = new $class;
         }
-        $this->decorators[] = $decorator;
+        $this->decorators[$decorator->name] = $decorator;
     }
     
 }