2018-03-24 18:39:13 +00:00
|
|
|
<?php
|
|
|
|
|
|
|
|
namespace Friendica\Core\Cache;
|
|
|
|
|
|
|
|
use Friendica\Core\Cache;
|
|
|
|
|
2018-07-10 22:55:01 +00:00
|
|
|
use Exception;
|
|
|
|
use Memcached;
|
|
|
|
|
2018-03-24 18:39:13 +00:00
|
|
|
/**
|
|
|
|
* Memcached Cache Driver
|
|
|
|
*
|
2018-09-15 23:28:38 +00:00
|
|
|
* @author Hypolite Petovan <hypolite@mrpetovan.com>
|
2018-03-24 18:39:13 +00:00
|
|
|
*/
|
2018-07-05 19:54:20 +00:00
|
|
|
class MemcachedCacheDriver extends AbstractCacheDriver implements IMemoryCacheDriver
|
2018-03-24 18:39:13 +00:00
|
|
|
{
|
2018-07-04 21:37:22 +00:00
|
|
|
use TraitCompareSet;
|
|
|
|
use TraitCompareDelete;
|
|
|
|
|
2018-03-24 18:39:13 +00:00
|
|
|
/**
|
2018-07-05 18:57:31 +00:00
|
|
|
* @var \Memcached
|
2018-03-24 18:39:13 +00:00
|
|
|
*/
|
|
|
|
private $memcached;
|
|
|
|
|
2018-07-08 05:46:46 +00:00
|
|
|
/**
|
|
|
|
* Due to limitations of the INI format, the expected configuration for Memcached servers is the following:
|
|
|
|
* array {
|
|
|
|
* 0 => "hostname, port(, weight)",
|
|
|
|
* 1 => ...
|
|
|
|
* }
|
|
|
|
*
|
|
|
|
* @param array $memcached_hosts
|
|
|
|
* @throws \Exception
|
|
|
|
*/
|
2018-03-24 18:39:13 +00:00
|
|
|
public function __construct(array $memcached_hosts)
|
|
|
|
{
|
|
|
|
if (!class_exists('Memcached', false)) {
|
2018-07-10 22:55:01 +00:00
|
|
|
throw new Exception('Memcached class isn\'t available');
|
2018-03-24 18:39:13 +00:00
|
|
|
}
|
|
|
|
|
2018-07-10 22:55:01 +00:00
|
|
|
$this->memcached = new Memcached();
|
2018-03-24 18:39:13 +00:00
|
|
|
|
2018-07-08 05:46:46 +00:00
|
|
|
array_walk($memcached_hosts, function (&$value) {
|
2018-07-17 06:05:06 +00:00
|
|
|
if (is_string($value)) {
|
|
|
|
$value = array_map('trim', explode(',', $value));
|
|
|
|
}
|
2018-07-08 05:46:46 +00:00
|
|
|
});
|
|
|
|
|
2018-03-24 18:39:13 +00:00
|
|
|
$this->memcached->addServers($memcached_hosts);
|
|
|
|
|
|
|
|
if (count($this->memcached->getServerList()) == 0) {
|
2018-07-10 22:55:01 +00:00
|
|
|
throw new Exception('Expected Memcached servers aren\'t available, config:' . var_export($memcached_hosts, true));
|
2018-03-24 18:39:13 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
public function get($key)
|
|
|
|
{
|
|
|
|
$return = null;
|
2018-07-05 19:47:52 +00:00
|
|
|
$cachekey = $this->getCacheKey($key);
|
2018-03-24 18:39:13 +00:00
|
|
|
|
|
|
|
// We fetch with the hostname as key to avoid problems with other applications
|
2018-07-05 19:47:52 +00:00
|
|
|
$value = $this->memcached->get($cachekey);
|
2018-03-24 18:39:13 +00:00
|
|
|
|
2018-07-10 22:55:01 +00:00
|
|
|
if ($this->memcached->getResultCode() === Memcached::RES_SUCCESS) {
|
2018-03-24 18:39:13 +00:00
|
|
|
$return = $value;
|
|
|
|
}
|
|
|
|
|
|
|
|
return $return;
|
|
|
|
}
|
|
|
|
|
2018-07-04 21:37:22 +00:00
|
|
|
public function set($key, $value, $ttl = Cache::FIVE_MINUTES)
|
2018-03-24 18:39:13 +00:00
|
|
|
{
|
2018-07-05 19:47:52 +00:00
|
|
|
$cachekey = $this->getCacheKey($key);
|
|
|
|
|
2018-03-24 18:39:13 +00:00
|
|
|
// We store with the hostname as key to avoid problems with other applications
|
2018-07-04 21:37:22 +00:00
|
|
|
if ($ttl > 0) {
|
|
|
|
return $this->memcached->set(
|
2018-07-05 19:47:52 +00:00
|
|
|
$cachekey,
|
2018-07-04 21:37:22 +00:00
|
|
|
$value,
|
2018-07-07 17:46:16 +00:00
|
|
|
$ttl
|
2018-07-04 21:37:22 +00:00
|
|
|
);
|
|
|
|
} else {
|
|
|
|
return $this->memcached->set(
|
2018-07-05 19:47:52 +00:00
|
|
|
$cachekey,
|
2018-07-04 21:37:22 +00:00
|
|
|
$value
|
|
|
|
);
|
|
|
|
}
|
|
|
|
|
2018-03-24 18:39:13 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
public function delete($key)
|
|
|
|
{
|
2018-07-05 19:47:52 +00:00
|
|
|
$cachekey = $this->getCacheKey($key);
|
|
|
|
return $this->memcached->delete($cachekey);
|
2018-03-24 18:39:13 +00:00
|
|
|
}
|
|
|
|
|
2018-07-07 17:46:16 +00:00
|
|
|
public function clear($outdated = true)
|
2018-03-24 18:39:13 +00:00
|
|
|
{
|
2018-07-07 17:46:16 +00:00
|
|
|
if ($outdated) {
|
|
|
|
return true;
|
|
|
|
} else {
|
|
|
|
return $this->memcached->flush();
|
|
|
|
}
|
2018-03-24 18:39:13 +00:00
|
|
|
}
|
2018-07-04 21:37:22 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Sets a value if it's not already stored
|
|
|
|
*
|
|
|
|
* @param string $key The cache key
|
|
|
|
* @param mixed $value The old value we know from the cache
|
|
|
|
* @param int $ttl The cache lifespan, must be one of the Cache constants
|
|
|
|
* @return bool
|
|
|
|
*/
|
|
|
|
public function add($key, $value, $ttl = Cache::FIVE_MINUTES)
|
|
|
|
{
|
2018-07-05 19:47:52 +00:00
|
|
|
$cachekey = $this->getCacheKey($key);
|
|
|
|
return $this->memcached->add($cachekey, $value, $ttl);
|
2018-07-04 21:37:22 +00:00
|
|
|
}
|
2018-03-24 18:39:13 +00:00
|
|
|
}
|