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