CRM/Utils/Cache/APCcache.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 class CRM_Utils_Cache_APCcache implements CRM_Utils_Cache_Interface {
  34
  35   use CRM_Utils_Cache_NaiveMultipleTrait; // TODO Consider native implementation.
  36   use CRM_Utils_Cache_NaiveHasTrait; // TODO Native implementation
  37
  38   const DEFAULT_TIMEOUT = 3600;
  39   const DEFAULT_PREFIX = '';
  40
  41   /**
  42    * The default timeout to use.
  43    *
  44    * @var int
  45    */
  46   protected $_timeout = self::DEFAULT_TIMEOUT;
  47
  48   /**
  49    * The prefix prepended to cache keys.
  50    *
  51    * If we are using the same memcache instance for multiple CiviCRM
  52    * installs, we must have a unique prefix for each install to prevent
  53    * the keys from clobbering each other.
  54    *
  55    * @var string
  56    */
  57   protected $_prefix = self::DEFAULT_PREFIX;
  58
  59   /**
  60    * Constructor.
  61    *
  62    * @param array $config
  63    *   An array of configuration params.
  64    *
  65    * @return \CRM_Utils_Cache_APCcache
  66    */
  67   public function __construct(&$config) {
  68     if (isset($config['timeout'])) {
  69       $this->_timeout = intval($config['timeout']);
  70     }
  71     if (isset($config['prefix'])) {
  72       $this->_prefix = $config['prefix'];
  73     }
  74   }
  75
  76   /**
  77    * @param $key
  78    * @param $value
  79    * @param null|int|\DateInterval $ttl
  80    *
  81    * @return bool
  82    */
  83   public function set($key, $value, $ttl = NULL) {
  84     if ($ttl !== NULL) {
  85       throw new \RuntimeException("FIXME: " . __CLASS__ . "::set() should support non-NULL TTL");
  86     }
  87     if (!apc_store($this->_prefix . $key, $value, $this->_timeout)) {
  88       return FALSE;
  89     }
  90     return TRUE;
  91   }
  92
  93   /**
  94    * @param $key
  95    * @param mixed $default
  96    *
  97    * @return mixed
  98    */
  99   public function get($key, $default = NULL) {
 100     if ($default !== NULL) {
 101       throw new \RuntimeException("FIXME: " . __CLASS__ . "::get() only supports NULL default");
 102     }
 103     return apc_fetch($this->_prefix . $key);
 104   }
 105
 106   /**
 107    * @param $key
 108    *
 109    * @return bool|string[]
 110    */
 111   public function delete($key) {
 112     return apc_delete($this->_prefix . $key);
 113   }
 114
 115   public function flush() {
 116     $allinfo = apc_cache_info('user');
 117     $keys = $allinfo['cache_list'];
 118     $prefix = $this->_prefix . "CRM_";  // Our keys follows this pattern: ([A-Za-z0-9_]+)?CRM_[A-Za-z0-9_]+
 119     $lp = strlen($prefix);              // Get prefix length
 120
 121     foreach ($keys as $key) {
 122       $name = $key['info'];
 123       if ($prefix == substr($name, 0, $lp)) {
 124         // Ours?
 125         apc_delete($this->_prefix . $name);
 126       }
 127     }
 128     return TRUE;
 129   }
 130
 131   public function clear() {
 132     return $this->flush();
 133   }
 134
 135 }