Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
450f494d | 2 | /* |
3 | +--------------------------------------------------------------------+ | |
fee14197 | 4 | | CiviCRM version 5 | |
50bfb460 | 5 | +--------------------------------------------------------------------+ |
6b83d5bd | 6 | | Copyright CiviCRM LLC (c) 2004-2019 | |
50bfb460 SB |
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 | |
6b83d5bd | 31 | * @copyright CiviCRM LLC (c) 2004-2019 |
e70a7fc0 | 32 | */ |
6a488035 | 33 | |
5bc392e6 EM |
34 | /** |
35 | * Class CRM_Utils_Cache_SerializeCache | |
36 | */ | |
6a488035 TO |
37 | class CRM_Utils_Cache_SerializeCache implements CRM_Utils_Cache_Interface { |
38 | ||
0d64c8fa | 39 | use CRM_Utils_Cache_NaiveMultipleTrait; |
6714d8d2 SL |
40 | // TODO Native implementation |
41 | use CRM_Utils_Cache_NaiveHasTrait; | |
0d64c8fa | 42 | |
6a488035 TO |
43 | /** |
44 | * The cache storage container, an array by default, stored in a file under templates | |
6714d8d2 | 45 | * @var array |
6a488035 TO |
46 | */ |
47 | private $_cache; | |
48 | ||
49 | /** | |
fe482240 | 50 | * Constructor. |
6a488035 | 51 | * |
77855840 TO |
52 | * @param array $config |
53 | * An array of configuration params. | |
6a488035 | 54 | * |
77b97be7 | 55 | * @return \CRM_Utils_Cache_SerializeCache |
6a488035 | 56 | */ |
00be9182 | 57 | public function __construct($config) { |
be2fb01f | 58 | $this->_cache = []; |
6a488035 TO |
59 | } |
60 | ||
5bc392e6 EM |
61 | /** |
62 | * @param $key | |
63 | * | |
64 | * @return string | |
65 | */ | |
353ffa53 | 66 | public function fileName($key) { |
e7292422 | 67 | if (strlen($key) > 50) { |
86bfa4f6 | 68 | return CIVICRM_TEMPLATE_COMPILEDIR . "CRM_" . md5($key) . ".php"; |
e7292422 | 69 | } |
86bfa4f6 | 70 | return CIVICRM_TEMPLATE_COMPILEDIR . $key . ".php"; |
6a488035 TO |
71 | } |
72 | ||
5bc392e6 EM |
73 | /** |
74 | * @param string $key | |
2da67cc5 | 75 | * @param mixed $default |
5bc392e6 EM |
76 | * |
77 | * @return mixed | |
78 | */ | |
2da67cc5 TO |
79 | public function get($key, $default = NULL) { |
80 | if ($default !== NULL) { | |
81 | throw new \RuntimeException("FIXME: " . __CLASS__ . "::get() only supports NULL default"); | |
82 | } | |
83 | ||
e7292422 | 84 | if (array_key_exists($key, $this->_cache)) { |
6a488035 | 85 | return $this->_cache[$key]; |
e7292422 | 86 | } |
6a488035 | 87 | |
e7292422 | 88 | if (!file_exists($this->fileName($key))) { |
6a488035 TO |
89 | return; |
90 | } | |
e7292422 | 91 | $this->_cache[$key] = unserialize(substr(file_get_contents($this->fileName($key)), 8)); |
6a488035 TO |
92 | return $this->_cache[$key]; |
93 | } | |
94 | ||
5bc392e6 EM |
95 | /** |
96 | * @param string $key | |
97 | * @param mixed $value | |
858451a9 TO |
98 | * @param null|int|\DateInterval $ttl |
99 | * @return bool | |
5bc392e6 | 100 | */ |
858451a9 TO |
101 | public function set($key, $value, $ttl = NULL) { |
102 | if ($ttl !== NULL) { | |
103 | throw new \RuntimeException("FIXME: " . __CLASS__ . "::set() should support non-NULL TTL"); | |
104 | } | |
e7292422 | 105 | if (file_exists($this->fileName($key))) { |
6714d8d2 SL |
106 | // WTF, write-once cache?! |
107 | return FALSE; | |
6a488035 TO |
108 | } |
109 | $this->_cache[$key] = $value; | |
858451a9 TO |
110 | $bytes = file_put_contents($this->fileName($key), "<?php //" . serialize($value)); |
111 | return ($bytes !== FALSE); | |
6a488035 TO |
112 | } |
113 | ||
5bc392e6 EM |
114 | /** |
115 | * @param string $key | |
eec321a4 | 116 | * @return bool |
5bc392e6 | 117 | */ |
00be9182 | 118 | public function delete($key) { |
e7292422 TO |
119 | if (file_exists($this->fileName($key))) { |
120 | unlink($this->fileName($key)); | |
6a488035 TO |
121 | } |
122 | unset($this->_cache[$key]); | |
eec321a4 | 123 | return TRUE; |
6a488035 TO |
124 | } |
125 | ||
5bc392e6 EM |
126 | /** |
127 | * @param null $key | |
124e5288 | 128 | * @return bool |
5bc392e6 | 129 | */ |
e7292422 | 130 | public function flush($key = NULL) { |
6a488035 TO |
131 | $prefix = "CRM_"; |
132 | if (!$handle = opendir(CIVICRM_TEMPLATE_COMPILEDIR)) { | |
6714d8d2 SL |
133 | // die? Error? |
134 | return FALSE; | |
6a488035 | 135 | } |
e7292422 TO |
136 | while (FALSE !== ($entry = readdir($handle))) { |
137 | if (substr($entry, 0, 4) == $prefix) { | |
92fcb95f | 138 | unlink(CIVICRM_TEMPLATE_COMPILEDIR . $entry); |
6a488035 TO |
139 | } |
140 | } | |
141 | closedir($handle); | |
142 | unset($this->_cache); | |
be2fb01f | 143 | $this->_cache = []; |
124e5288 | 144 | return TRUE; |
6a488035 | 145 | } |
96025800 | 146 | |
c31de879 TO |
147 | public function clear() { |
148 | return $this->flush(); | |
149 | } | |
150 | ||
6a488035 | 151 | } |