Unverified Commit 6dd26ccd authored by eileen's avatar eileen 🎱 Committed by GitHub

Merge pull request #12381 from totten/master-psr16-apc

(#174) APCcache - Updates to comply with PSR-16
parents ce5dabf4 9e1a686f
......@@ -81,10 +81,14 @@ class CRM_Utils_Cache_APCcache implements CRM_Utils_Cache_Interface {
* @return bool
*/
public function set($key, $value, $ttl = NULL) {
if ($ttl !== NULL) {
throw new \RuntimeException("FIXME: " . __CLASS__ . "::set() should support non-NULL TTL");
CRM_Utils_Cache::assertValidKey($key);
if (is_int($ttl) && $ttl <= 0) {
return $this->delete($key);
}
if (!apc_store($this->_prefix . $key, $value, $this->_timeout)) {
$ttl = CRM_Utils_Date::convertCacheTtl($ttl, $this->_timeout);
$expires = time() + $ttl;
if (!apc_store($this->_prefix . $key, ['e' => $expires, 'v' => $value], $ttl)) {
return FALSE;
}
return TRUE;
......@@ -97,10 +101,12 @@ class CRM_Utils_Cache_APCcache implements CRM_Utils_Cache_Interface {
* @return mixed
*/
public function get($key, $default = NULL) {
if ($default !== NULL) {
throw new \RuntimeException("FIXME: " . __CLASS__ . "::get() only supports NULL default");
CRM_Utils_Cache::assertValidKey($key);
$result = apc_fetch($this->_prefix . $key, $success);
if ($success && isset($result['e']) && $result['e'] > time()) {
return $this->reobjectify($result['v']);
}
return apc_fetch($this->_prefix . $key);
return $default;
}
/**
......@@ -109,20 +115,22 @@ class CRM_Utils_Cache_APCcache implements CRM_Utils_Cache_Interface {
* @return bool|string[]
*/
public function delete($key) {
return apc_delete($this->_prefix . $key);
CRM_Utils_Cache::assertValidKey($key);
apc_delete($this->_prefix . $key);
return TRUE;
}
public function flush() {
$allinfo = apc_cache_info('user');
$keys = $allinfo['cache_list'];
$prefix = $this->_prefix . "CRM_"; // Our keys follows this pattern: ([A-Za-z0-9_]+)?CRM_[A-Za-z0-9_]+
$prefix = $this->_prefix; // Our keys follows this pattern: ([A-Za-z0-9_]+)?CRM_[A-Za-z0-9_]+
$lp = strlen($prefix); // Get prefix length
foreach ($keys as $key) {
$name = $key['info'];
if ($prefix == substr($name, 0, $lp)) {
// Ours?
apc_delete($this->_prefix . $name);
apc_delete($name);
}
}
return TRUE;
......@@ -132,4 +140,8 @@ class CRM_Utils_Cache_APCcache implements CRM_Utils_Cache_Interface {
return $this->flush();
}
private function reobjectify($value) {
return is_object($value) ? unserialize(serialize($value)) : $value;
}
}
<?php
/*
+--------------------------------------------------------------------+
| CiviCRM version 5 |
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC (c) 2004-2018 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
| CiviCRM is free software; you can copy, modify, and distribute it |
| under the terms of the GNU Affero General Public License |
| Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
| |
| CiviCRM is distributed in the hope that it will be useful, but |
| WITHOUT ANY WARRANTY; without even the implied warranty of |
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
| See the GNU Affero General Public License for more details. |
| |
| You should have received a copy of the GNU Affero General Public |
| License along with this program; if not, contact CiviCRM LLC |
| at info[AT]civicrm[DOT]org. If you have questions about the |
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
*/
/**
* Verify that CRM_Utils_Cache_APCcache complies with PSR-16.
*
* @group e2e
*/
class E2E_Cache_APCcacheTest extends E2E_Cache_CacheTestCase {
public function createSimpleCache() {
if (!function_exists('apc_store')) {
$this->markTestSkipped('This environment does not have the APC extension.');
}
if (PHP_SAPI === 'cli') {
$c = (string) ini_get('apc.enable_cli');
if ($c != 1 && strtolower($c) !== 'on') {
$this->markTestSkipped('This environment is not configured to use APC cache service. Set apc.enable_cli=on');
}
}
$config = [
'prefix' => 'foozball/',
];
$c = new CRM_Utils_Cache_APCcache($config);
return $c;
}
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment