CRM/Utils/Cache/SerializeCache.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4 | CiviCRM version 4.3                                                |
   5 +--------------------------------------------------------------------+
   6 | Copyright CiviCRM LLC (c) 2004-2013                                |
   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 class CRM_Utils_Cache_SerializeCache implements CRM_Utils_Cache_Interface {
  29
  30   /**
  31    * The cache storage container, an array by default, stored in a file under templates
  32    */
  33   private $_cache;
  34
  35   /**
  36    * Constructor
  37    *
  38    * @param array   $config  an array of configuration params
  39    *
  40    * @return void
  41    */
  42   function __construct($config) {
  43     $this->_cache = array();
  44   }
  45
  46   function fileName ($key) {
  47     if (strlen($key) > 50)
  48       return CIVICRM_TEMPLATE_COMPILEDIR ."CRM_".md5($key).".php";
  49     return CIVICRM_TEMPLATE_COMPILEDIR .$key.".php";
  50   }
  51
  52   function get ($key) {
  53     if (array_key_exists($key,$this->_cache))
  54       return $this->_cache[$key];
  55
  56     if (!file_exists($this->fileName ($key))) {
  57       return;
  58     }
  59     $this->_cache[$key] = unserialize (substr (file_get_contents ($this->fileName ($key)),8));
  60     return $this->_cache[$key];
  61   }
  62
  63   function set($key, &$value) {
  64     if (file_exists($this->fileName ($key))) {
  65       return;
  66     }
  67     $this->_cache[$key] = $value;
  68     file_put_contents ($this->fileName ($key),"<?php //".serialize ($value));
  69   }
  70
  71   function delete($key) {
  72     if (file_exists($this->fileName ($key))) {
  73       unlink ($this->fileName ($key));
  74     }
  75     unset($this->_cache[$key]);
  76   }
  77
  78   function flush($key =null) {
  79     $prefix = "CRM_";
  80     if (!$handle = opendir(CIVICRM_TEMPLATE_COMPILEDIR)) {
  81       return; // die? Error?
  82     }
  83     while (false !== ($entry = readdir($handle))) {
  84       if (substr ($entry,0,4) == $prefix) {
  85         unlink (CIVICRM_TEMPLATE_COMPILEDIR.$entry);
  86       }
  87     }
  88     closedir($handle);
  89     unset($this->_cache);
  90     $this->_cache = array();
  91   }
  92 }
  93