1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
|
<?php
/**
* Copyright (C) 2007 - Marcus Lunzenauer <mlunzena@uos.de>
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation; either version 2 of
* the License, or (at your option) any later version.
*/
/**
* Cache implementation using memcached.
*
* @package studip
* @subpackage cache
*
* @author mlunzena
* @copyright (c) Authors
* @since 5.0
*/
class StudipMemcachedCache implements StudipCache
{
use StudipCacheKeyTrait;
private $memcache;
/**
* @return string A translateable display name for this cache class.
*/
public static function getDisplayName(): string
{
return _('Memcached');
}
public function __construct($servers)
{
if (!extension_loaded('memcached')) {
throw new Exception('Memcache extension missing.');
}
$prefix = Config::get()->STUDIP_INSTALLATION_ID;
$this->memcache = new Memcached(md5(json_encode($servers)));
if (count($this->memcache->getServerList()) === 0) {
// Set options (see https://www.php.net/manual/en/memcached.addservers.php#118940)
$this->memcache->setOption(Memcached::OPT_DISTRIBUTION, Memcached::DISTRIBUTION_CONSISTENT);
$this->memcache->setOption(Memcached::OPT_SERVER_FAILURE_LIMIT, 2);
$this->memcache->setOption(Memcached::OPT_REMOVE_FAILED_SERVERS, true);
$this->memcache->setOption(Memcached::OPT_RETRY_TIMEOUT, 1);
$this->memcache->setOption(Memcached::OPT_PREFIX_KEY, $prefix);
$status = $this->memcache->addServers(
array_map(
function ($server) {
return [$server['hostname'], (int) $server['port']];
},
$servers
)
);
if (!$status) {
throw new \Exception('Could not add memcached servers');
}
}
}
/**
* Expire item from the cache.
*
* Example:
*
* # expires foo
* $cache->expire('foo');
*
* @param string $arg a single key.
* @returns void
*/
public function expire($arg)
{
$key = $this->getCacheKey($arg);
$this->memcache->delete($key);
}
/**
* Expire all items from the cache.
*/
public function flush()
{
$this->memcache->flush();
}
/**
* Retrieve item from the server.
*
* Example:
*
* # reads foo
* $foo = $cache->reads('foo');
*
* @param string $arg a single key
* @returns mixed the previously stored data if an item with such a key
* exists on the server or FALSE on failure.
*/
public function read($arg)
{
$key = $this->getCacheKey($arg);
return $this->memcache->get($key);
}
/**
* Store data at the server.
*
* @param string $arg the item's key.
* @param string $content the item's content.
* @param int $expire the item's expiry time in seconds. Defaults to 12h.
*
* @returns mixed returns TRUE on success or FALSE on failure.
*
*/
public function write($arg, $content, $expire = self::DEFAULT_EXPIRATION)
{
$key = $this->getCacheKey($arg);
return $this->memcache->set($key, $content, $expire);
}
/**
* Return statistics.
*
* @StudipCache::getStats()
*
* @return array|array[]
*/
public function getStats(): array
{
$stats = $this->memcache->getStats();
return $stats;
}
/**
* Return the Vue component name and props that handle configuration.
*
* @see StudipCache::getConfig()
*
* @return array
*/
public static function getConfig(): array
{
$currentCache = Config::get()->SYSTEMCACHE;
// Set default config for this cache
$currentConfig = [
'servers' => []
];
// If this cache is set as system cache, use config from global settings.
if ($currentCache['type'] == __CLASS__) {
$currentConfig = $currentCache['config'];
}
return [
'component' => 'MemcachedCacheConfig',
'props' => $currentConfig
];
}
}
|
