3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2019
33 class CRM_Utils_Cache_APCcache
implements CRM_Utils_Cache_Interface
{
35 use CRM_Utils_Cache_NaiveMultipleTrait
; // TODO Consider native implementation.
36 use CRM_Utils_Cache_NaiveHasTrait
; // TODO Native implementation
38 const DEFAULT_TIMEOUT
= 3600;
39 const DEFAULT_PREFIX
= '';
42 * The default timeout to use.
46 protected $_timeout = self
::DEFAULT_TIMEOUT
;
49 * The prefix prepended to cache keys.
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.
57 protected $_prefix = self
::DEFAULT_PREFIX
;
62 * @param array $config
63 * An array of configuration params.
65 * @return \CRM_Utils_Cache_APCcache
67 public function __construct(&$config) {
68 if (isset($config['timeout'])) {
69 $this->_timeout
= intval($config['timeout']);
71 if (isset($config['prefix'])) {
72 $this->_prefix
= $config['prefix'];
79 * @param null|int|\DateInterval $ttl
83 public function set($key, $value, $ttl = NULL) {
84 CRM_Utils_Cache
::assertValidKey($key);
85 if (is_int($ttl) && $ttl <= 0) {
86 return $this->delete($key);
89 $ttl = CRM_Utils_Date
::convertCacheTtl($ttl, $this->_timeout
);
90 $expires = time() +
$ttl;
91 if (!apc_store($this->_prefix
. $key, ['e' => $expires, 'v' => $value], $ttl)) {
99 * @param mixed $default
103 public function get($key, $default = NULL) {
104 CRM_Utils_Cache
::assertValidKey($key);
105 $result = apc_fetch($this->_prefix
. $key, $success);
106 if ($success && isset($result['e']) && $result['e'] > time()) {
107 return $this->reobjectify($result['v']);
115 * @return bool|string[]
117 public function delete($key) {
118 CRM_Utils_Cache
::assertValidKey($key);
119 apc_delete($this->_prefix
. $key);
123 public function flush() {
124 $allinfo = apc_cache_info('user');
125 $keys = $allinfo['cache_list'];
126 $prefix = $this->_prefix
; // Our keys follows this pattern: ([A-Za-z0-9_]+)?CRM_[A-Za-z0-9_]+
127 $lp = strlen($prefix); // Get prefix length
129 foreach ($keys as $key) {
130 $name = $key['info'];
131 if ($prefix == substr($name, 0, $lp)) {
139 public function clear() {
140 return $this->flush();
143 private function reobjectify($value) {
144 return is_object($value) ?
unserialize(serialize($value)) : $value;