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 an array of configuration params
  42    *
  43    * @return \CRM_Utils_Cache_SerializeCache
  44    */
  45   public function __construct($config) {
  46     $this->_cache = array();
  47   }
  48
  49   /**
  50    * @param $key
  51    *
  52    * @return string
  53    */
  54   public function fileName ($key) {
  55     if (strlen($key) > 50)
  56       return CIVICRM_TEMPLATE_COMPILEDIR ."CRM_".md5($key).".php";
  57     return CIVICRM_TEMPLATE_COMPILEDIR .$key.".php";
  58   }
  59
  60   /**
  61    * @param string $key
  62    *
  63    * @return mixed
  64    */
  65   public function get ($key) {
  66     if (array_key_exists($key,$this->_cache))
  67       return $this->_cache[$key];
  68
  69     if (!file_exists($this->fileName ($key))) {
  70       return;
  71     }
  72     $this->_cache[$key] = unserialize (substr (file_get_contents ($this->fileName ($key)),8));
  73     return $this->_cache[$key];
  74   }
  75
  76   /**
  77    * @param string $key
  78    * @param mixed $value
  79    */
  80   public function set($key, &$value) {
  81     if (file_exists($this->fileName ($key))) {
  82       return;
  83     }
  84     $this->_cache[$key] = $value;
  85     file_put_contents ($this->fileName ($key),"<?php //".serialize ($value));
  86   }
  87
  88   /**
  89    * @param string $key
  90    */
  91   public function delete($key) {
  92     if (file_exists($this->fileName ($key))) {
  93       unlink ($this->fileName ($key));
  94     }
  95     unset($this->_cache[$key]);
  96   }
  97
  98   /**
  99    * @param null $key
 100    */
 101   public function flush($key =null) {
 102     $prefix = "CRM_";
 103     if (!$handle = opendir(CIVICRM_TEMPLATE_COMPILEDIR)) {
 104       return; // die? Error?
 105     }
 106     while (false !== ($entry = readdir($handle))) {
 107       if (substr ($entry,0,4) == $prefix) {
 108         unlink (CIVICRM_TEMPLATE_COMPILEDIR.$entry);
 109       }
 110     }
 111     closedir($handle);
 112     unset($this->_cache);
 113     $this->_cache = array();
 114   }
 115 }