CRM/Utils/Cache/APCcache.php

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