Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
fee14197 | 4 | | CiviCRM version 5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
f299f7db | 6 | | Copyright CiviCRM LLC (c) 2004-2020 | |
6a488035 TO |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * | |
30 | * @package CRM | |
f299f7db | 31 | * @copyright CiviCRM LLC (c) 2004-2020 |
6a488035 | 32 | */ |
9f49773e | 33 | class CRM_Utils_Cache_APCcache implements CRM_Utils_Cache_Interface { |
0d64c8fa | 34 | |
6714d8d2 SL |
35 | // TODO Consider native implementation. |
36 | use CRM_Utils_Cache_NaiveMultipleTrait; | |
37 | // TODO Native implementation | |
38 | use CRM_Utils_Cache_NaiveHasTrait; | |
0d64c8fa | 39 | |
6a488035 | 40 | const DEFAULT_TIMEOUT = 3600; |
353ffa53 | 41 | const DEFAULT_PREFIX = ''; |
6a488035 TO |
42 | |
43 | /** | |
fe482240 | 44 | * The default timeout to use. |
6a488035 TO |
45 | * |
46 | * @var int | |
47 | */ | |
48 | protected $_timeout = self::DEFAULT_TIMEOUT; | |
49 | ||
50 | /** | |
51 | * The prefix prepended to cache keys. | |
52 | * | |
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. | |
56 | * | |
57 | * @var string | |
58 | */ | |
59 | protected $_prefix = self::DEFAULT_PREFIX; | |
60 | ||
61 | /** | |
fe482240 | 62 | * Constructor. |
6a488035 | 63 | * |
77855840 TO |
64 | * @param array $config |
65 | * An array of configuration params. | |
6a488035 | 66 | * |
77b97be7 | 67 | * @return \CRM_Utils_Cache_APCcache |
6a488035 | 68 | */ |
00be9182 | 69 | public function __construct(&$config) { |
6a488035 TO |
70 | if (isset($config['timeout'])) { |
71 | $this->_timeout = intval($config['timeout']); | |
72 | } | |
73 | if (isset($config['prefix'])) { | |
74 | $this->_prefix = $config['prefix']; | |
75 | } | |
76 | } | |
77 | ||
5bc392e6 EM |
78 | /** |
79 | * @param $key | |
80 | * @param $value | |
858451a9 | 81 | * @param null|int|\DateInterval $ttl |
5bc392e6 EM |
82 | * |
83 | * @return bool | |
84 | */ | |
858451a9 | 85 | public function set($key, $value, $ttl = NULL) { |
9e1a686f TO |
86 | CRM_Utils_Cache::assertValidKey($key); |
87 | if (is_int($ttl) && $ttl <= 0) { | |
88 | return $this->delete($key); | |
858451a9 | 89 | } |
9e1a686f TO |
90 | |
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)) { | |
6a488035 TO |
94 | return FALSE; |
95 | } | |
96 | return TRUE; | |
97 | } | |
98 | ||
5bc392e6 EM |
99 | /** |
100 | * @param $key | |
2da67cc5 | 101 | * @param mixed $default |
5bc392e6 EM |
102 | * |
103 | * @return mixed | |
104 | */ | |
2da67cc5 | 105 | public function get($key, $default = NULL) { |
9e1a686f TO |
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']); | |
2da67cc5 | 110 | } |
9e1a686f | 111 | return $default; |
6a488035 TO |
112 | } |
113 | ||
5bc392e6 EM |
114 | /** |
115 | * @param $key | |
116 | * | |
117 | * @return bool|string[] | |
118 | */ | |
00be9182 | 119 | public function delete($key) { |
9e1a686f TO |
120 | CRM_Utils_Cache::assertValidKey($key); |
121 | apc_delete($this->_prefix . $key); | |
122 | return TRUE; | |
6a488035 TO |
123 | } |
124 | ||
00be9182 | 125 | public function flush() { |
6a488035 TO |
126 | $allinfo = apc_cache_info('user'); |
127 | $keys = $allinfo['cache_list']; | |
6714d8d2 SL |
128 | // Our keys follows this pattern: ([A-Za-z0-9_]+)?CRM_[A-Za-z0-9_]+ |
129 | $prefix = $this->_prefix; | |
130 | // Get prefix length | |
131 | $lp = strlen($prefix); | |
6a488035 TO |
132 | |
133 | foreach ($keys as $key) { | |
134 | $name = $key['info']; | |
6c552737 | 135 | if ($prefix == substr($name, 0, $lp)) { |
a1a2a83d | 136 | // Ours? |
9e1a686f | 137 | apc_delete($name); |
6a488035 TO |
138 | } |
139 | } | |
124e5288 | 140 | return TRUE; |
6a488035 | 141 | } |
96025800 | 142 | |
c31de879 TO |
143 | public function clear() { |
144 | return $this->flush(); | |
145 | } | |
146 | ||
9e1a686f TO |
147 | private function reobjectify($value) { |
148 | return is_object($value) ? unserialize(serialize($value)) : $value; | |
149 | } | |
150 | ||
6a488035 | 151 | } |