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   use CRM_Utils_Cache_NaiveMultipleTrait;
  40   use CRM_Utils_Cache_NaiveHasTrait; // TODO Native implementation
  41
  42   /**
  43    * The cache storage container, an array by default, stored in a file under templates
  44    */
  45   private $_cache;
  46
  47   /**
  48    * Constructor.
  49    *
  50    * @param array $config
  51    *   An array of configuration params.
  52    *
  53    * @return \CRM_Utils_Cache_SerializeCache
  54    */
  55   public function __construct($config) {
  56     $this->_cache = array();
  57   }
  58
  59   /**
  60    * @param $key
  61    *
  62    * @return string
  63    */
  64   public function fileName($key) {
  65     if (strlen($key) > 50) {
  66       return CIVICRM_TEMPLATE_COMPILEDIR . "CRM_" . md5($key) . ".php";
  67     }
  68     return CIVICRM_TEMPLATE_COMPILEDIR . $key . ".php";
  69   }
  70
  71   /**
  72    * @param string $key
  73    * @param mixed $default
  74    *
  75    * @return mixed
  76    */
  77   public function get($key, $default = NULL) {
  78     if ($default !== NULL) {
  79       throw new \RuntimeException("FIXME: " . __CLASS__ . "::get() only supports NULL default");
  80     }
  81
  82     if (array_key_exists($key, $this->_cache)) {
  83       return $this->_cache[$key];
  84     }
  85
  86     if (!file_exists($this->fileName($key))) {
  87       return;
  88     }
  89     $this->_cache[$key] = unserialize(substr(file_get_contents($this->fileName($key)), 8));
  90     return $this->_cache[$key];
  91   }
  92
  93   /**
  94    * @param string $key
  95    * @param mixed $value
  96    * @param null|int|\DateInterval $ttl
  97    * @return bool
  98    */
  99   public function set($key, $value, $ttl = NULL) {
 100     if ($ttl !== NULL) {
 101       throw new \RuntimeException("FIXME: " . __CLASS__ . "::set() should support non-NULL TTL");
 102     }
 103     if (file_exists($this->fileName($key))) {
 104       return FALSE; // WTF, write-once cache?!
 105     }
 106     $this->_cache[$key] = $value;
 107     $bytes = file_put_contents($this->fileName($key), "<?php //" . serialize($value));
 108     return ($bytes !== FALSE);
 109   }
 110
 111   /**
 112    * @param string $key
 113    * @return bool
 114    */
 115   public function delete($key) {
 116     if (file_exists($this->fileName($key))) {
 117       unlink($this->fileName($key));
 118     }
 119     unset($this->_cache[$key]);
 120     return TRUE;
 121   }
 122
 123   /**
 124    * @param null $key
 125    * @return bool
 126    */
 127   public function flush($key = NULL) {
 128     $prefix = "CRM_";
 129     if (!$handle = opendir(CIVICRM_TEMPLATE_COMPILEDIR)) {
 130       return FALSE; // die? Error?
 131     }
 132     while (FALSE !== ($entry = readdir($handle))) {
 133       if (substr($entry, 0, 4) == $prefix) {
 134         unlink(CIVICRM_TEMPLATE_COMPILEDIR . $entry);
 135       }
 136     }
 137     closedir($handle);
 138     unset($this->_cache);
 139     $this->_cache = array();
 140     return TRUE;
 141   }
 142
 143   public function clear() {
 144     return $this->flush();
 145   }
 146
 147 }