HTMLPurifier_DefinitionCache_Drupal.php

   1 <?php
   2
   3 require_once 'HTMLPurifier/DefinitionCache.php';
   4
   5 /**
   6  * Cache handler that stores all data in drupals builtin cache
   7  */
   8 class HTMLPurifier_DefinitionCache_Drupal extends HTMLPurifier_DefinitionCache
   9 {
  10   /**
  11    * Add an object to the cache without overwriting
  12    */
  13   function add($def, $config) {
  14     if (!$this->checkDefType($def)) return;
  15     $key = $this->generateKey($config);
  16
  17     if ($this->fetchFromDrupalCache($key)) {
  18       // already cached
  19       return false;
  20     }
  21     $this->storeInDrupalCache($def, $key);
  22     return true;
  23   }
  24
  25   /**
  26    * Unconditionally add an object to the cache, overwrites any existing object.
  27    */
  28   function set($def, $config) {
  29     if (!$this->checkDefType($def)) return;
  30     $key = $this->generateKey($config);
  31
  32     $this->storeInDrupalCache($def, $key);
  33     return true;
  34   }
  35
  36   /**
  37    * Replace an object that already exists in the cache.
  38    */
  39   function replace($def, $config) {
  40     if (!$this->checkDefType($def)) return;
  41     $key = $this->generateKey($config);
  42
  43     if (!$this->fetchFromDrupalCache($key)) {
  44       // object does not exist in cache
  45       return false;
  46     }
  47
  48     $this->storeInDrupalCache($def, $key);
  49     return true;
  50   }
  51
  52   /**
  53    * Retrieve an object from the cache
  54    */
  55   function get($config) {
  56     $key = $this->generateKey($config);
  57     return $this->fetchFromDrupalCache($key);
  58   }
  59
  60   /**
  61    * Delete an object from the cache
  62    */
  63   function remove($config) {
  64     $key = $this->generateKey($config);
  65     cache_clear_all("htmlpurifier:$key", 'cache');
  66     return true;
  67   }
  68
  69   function flush($config) {
  70     cache_clear_all("htmlpurifier:*", 'cache', true);
  71     return true;
  72   }
  73
  74   function cleanup($config) {
  75     $res = db_query("SELECT cid FROM {cache} WHERE cid LIKE '%s%%'", 'htmlpurifier:');
  76     while ($row = db_fetch_object($res)) {
  77       $key = substr($row->cid, 13); // 13 == strlen('htmlpurifier:')
  78       if ($this->isOld($key, $config)) {
  79         cache_clear_all($row->cid, 'cache');
  80       }
  81     }
  82   }
  83
  84   function fetchFromDrupalCache($key) {
  85     $cached = cache_get("htmlpurifier:$key");
  86     if ($cached) return unserialize($cached->data);
  87     return false;
  88   }
  89
  90   function storeInDrupalCache($def, $key) {
  91     cache_set("htmlpurifier:$key", serialize($def), 'cache', CACHE_PERMANENT);
  92   }
  93
  94 }
  95