3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2020 |
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-2020
33 class CRM_Utils_Cache_APCcache
implements CRM_Utils_Cache_Interface
{
35 // TODO Consider native implementation.
36 use CRM_Utils_Cache_NaiveMultipleTrait
;
37 // TODO Native implementation
38 use CRM_Utils_Cache_NaiveHasTrait
;
40 const DEFAULT_TIMEOUT
= 3600;
41 const DEFAULT_PREFIX
= '';
44 * The default timeout to use.
48 protected $_timeout = self
::DEFAULT_TIMEOUT
;
51 * The prefix prepended to cache keys.
53 * If we are using the same memcache instance for multiple CiviCRM
54 * installs, we must have a unique prefix for each install to prevent
55 * the keys from clobbering each other.
59 protected $_prefix = self
::DEFAULT_PREFIX
;
64 * @param array $config
65 * An array of configuration params.
67 * @return \CRM_Utils_Cache_APCcache
69 public function __construct(&$config) {
70 if (isset($config['timeout'])) {
71 $this->_timeout
= intval($config['timeout']);
73 if (isset($config['prefix'])) {
74 $this->_prefix
= $config['prefix'];
81 * @param null|int|\DateInterval $ttl
85 public function set($key, $value, $ttl = NULL) {
86 CRM_Utils_Cache
::assertValidKey($key);
87 if (is_int($ttl) && $ttl <= 0) {
88 return $this->delete($key);
91 $ttl = CRM_Utils_Date
::convertCacheTtl($ttl, $this->_timeout
);
92 $expires = time() +
$ttl;
93 if (!apc_store($this->_prefix
. $key, ['e' => $expires, 'v' => $value], $ttl)) {
101 * @param mixed $default
105 public function get($key, $default = NULL) {
106 CRM_Utils_Cache
::assertValidKey($key);
107 $result = apc_fetch($this->_prefix
. $key, $success);
108 if ($success && isset($result['e']) && $result['e'] > time()) {
109 return $this->reobjectify($result['v']);
117 * @return bool|string[]
119 public function delete($key) {
120 CRM_Utils_Cache
::assertValidKey($key);
121 apc_delete($this->_prefix
. $key);
125 public function flush() {
126 $allinfo = apc_cache_info('user');
127 $keys = $allinfo['cache_list'];
128 // Our keys follows this pattern: ([A-Za-z0-9_]+)?CRM_[A-Za-z0-9_]+
129 $prefix = $this->_prefix
;
131 $lp = strlen($prefix);
133 foreach ($keys as $key) {
134 $name = $key['info'];
135 if ($prefix == substr($name, 0, $lp)) {
143 public function clear() {
144 return $this->flush();
147 private function reobjectify($value) {
148 return is_object($value) ?
unserialize(serialize($value)) : $value;