CRM/Utils/Cache/SerializeCache.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2018                                |
   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  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2018
  32  */
  33
  34 /**
  35  * Class CRM_Utils_Cache_SerializeCache
  36  */
  37 class CRM_Utils_Cache_SerializeCache implements CRM_Utils_Cache_Interface {
  38
  39   /**
  40    * The cache storage container, an array by default, stored in a file under templates
  41    */
  42   private $_cache;
  43
  44   /**
  45    * Constructor.
  46    *
  47    * @param array $config
  48    *   An array of configuration params.
  49    *
  50    * @return \CRM_Utils_Cache_SerializeCache
  51    */
  52   public function __construct($config) {
  53     $this->_cache = array();
  54   }
  55
  56   /**
  57    * @param $key
  58    *
  59    * @return string
  60    */
  61   public function fileName($key) {
  62     if (strlen($key) > 50) {
  63       return CIVICRM_TEMPLATE_COMPILEDIR . "CRM_" . md5($key) . ".php";
  64     }
  65     return CIVICRM_TEMPLATE_COMPILEDIR . $key . ".php";
  66   }
  67
  68   /**
  69    * @param string $key
  70    *
  71    * @return mixed
  72    */
  73   public function get($key) {
  74     if (array_key_exists($key, $this->_cache)) {
  75       return $this->_cache[$key];
  76     }
  77
  78     if (!file_exists($this->fileName($key))) {
  79       return;
  80     }
  81     $this->_cache[$key] = unserialize(substr(file_get_contents($this->fileName($key)), 8));
  82     return $this->_cache[$key];
  83   }
  84
  85   /**
  86    * @param string $key
  87    * @param mixed $value
  88    */
  89   public function set($key, &$value) {
  90     if (file_exists($this->fileName($key))) {
  91       return;
  92     }
  93     $this->_cache[$key] = $value;
  94     file_put_contents($this->fileName($key), "<?php //" . serialize($value));
  95   }
  96
  97   /**
  98    * @param string $key
  99    */
 100   public function delete($key) {
 101     if (file_exists($this->fileName($key))) {
 102       unlink($this->fileName($key));
 103     }
 104     unset($this->_cache[$key]);
 105   }
 106
 107   /**
 108    * @param null $key
 109    */
 110   public function flush($key = NULL) {
 111     $prefix = "CRM_";
 112     if (!$handle = opendir(CIVICRM_TEMPLATE_COMPILEDIR)) {
 113       return; // die? Error?
 114     }
 115     while (FALSE !== ($entry = readdir($handle))) {
 116       if (substr($entry, 0, 4) == $prefix) {
 117         unlink(CIVICRM_TEMPLATE_COMPILEDIR . $entry);
 118       }
 119     }
 120     closedir($handle);
 121     unset($this->_cache);
 122     $this->_cache = array();
 123   }
 124
 125 }