CRM/Utils/Cache/SerializeCache.php

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