CRM/Utils/Cache/SerializeCache.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4 | CiviCRM version 4.6                                                |
   5 +--------------------------------------------------------------------+
   6 | Copyright CiviCRM LLC (c) 2004-2014                                |
   7 +--------------------------------------------------------------------+
   8 | This file is a part of CiviCRM.                                    |
   9 |                                                                    |
  10 | CiviCRM is free software; you can copy, modify, and distribute it  |
  11 | under the terms of the GNU Affero General Public License           |
  12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13 |                                                                    |
  14 | CiviCRM is distributed in the hope that it will be useful, but     |
  15 | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17 | See the GNU Affero General Public License for more details.        |
  18 |                                                                    |
  19 | You should have received a copy of the GNU Affero General Public   |
  20 | License and the CiviCRM Licensing Exception along                  |
  21 | with this program; if not, contact CiviCRM LLC                     |
  22 | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23 | GNU Affero General Public License or the licensing of CiviCRM,     |
  24 | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25 +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  * Class CRM_Utils_Cache_SerializeCache
  30  */
  31 class CRM_Utils_Cache_SerializeCache implements CRM_Utils_Cache_Interface {
  32
  33   /**
  34    * The cache storage container, an array by default, stored in a file under templates
  35    */
  36   private $_cache;
  37
  38   /**
  39    * Constructor.
  40    *
  41    * @param array $config
  42    *   An array of configuration params.
  43    *
  44    * @return \CRM_Utils_Cache_SerializeCache
  45    */
  46   public function __construct($config) {
  47     $this->_cache = array();
  48   }
  49
  50   /**
  51    * @param $key
  52    *
  53    * @return string
  54    */
  55   public function fileName($key) {
  56     if (strlen($key) > 50) {
  57       return CIVICRM_TEMPLATE_COMPILEDIR . "CRM_" . md5($key) . ".php";
  58     }
  59     return CIVICRM_TEMPLATE_COMPILEDIR . $key . ".php";
  60   }
  61
  62   /**
  63    * @param string $key
  64    *
  65    * @return mixed
  66    */
  67   public function get($key) {
  68     if (array_key_exists($key, $this->_cache)) {
  69       return $this->_cache[$key];
  70     }
  71
  72     if (!file_exists($this->fileName($key))) {
  73       return;
  74     }
  75     $this->_cache[$key] = unserialize(substr(file_get_contents($this->fileName($key)), 8));
  76     return $this->_cache[$key];
  77   }
  78
  79   /**
  80    * @param string $key
  81    * @param mixed $value
  82    */
  83   public function set($key, &$value) {
  84     if (file_exists($this->fileName($key))) {
  85       return;
  86     }
  87     $this->_cache[$key] = $value;
  88     file_put_contents($this->fileName($key), "<?php //" . serialize($value));
  89   }
  90
  91   /**
  92    * @param string $key
  93    */
  94   public function delete($key) {
  95     if (file_exists($this->fileName($key))) {
  96       unlink($this->fileName($key));
  97     }
  98     unset($this->_cache[$key]);
  99   }
 100
 101   /**
 102    * @param null $key
 103    */
 104   public function flush($key = NULL) {
 105     $prefix = "CRM_";
 106     if (!$handle = opendir(CIVICRM_TEMPLATE_COMPILEDIR)) {
 107       return; // die? Error?
 108     }
 109     while (FALSE !== ($entry = readdir($handle))) {
 110       if (substr($entry, 0, 4) == $prefix) {
 111         unlink(CIVICRM_TEMPLATE_COMPILEDIR . $entry);
 112       }
 113     }
 114     closedir($handle);
 115     unset($this->_cache);
 116     $this->_cache = array();
 117   }
 118
 119 }