-
-
Notifications
You must be signed in to change notification settings - Fork 424
Expand file tree
/
Copy pathMemcachedStorage.php
More file actions
159 lines (140 loc) · 4.95 KB
/
MemcachedStorage.php
File metadata and controls
159 lines (140 loc) · 4.95 KB
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
<?php
declare(strict_types=1);
/*
* This file is part of the DebugBar package.
*
* (c) 2013 Maxime Bouroumeau-Fuseau
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace DebugBar\Storage;
use Memcached;
use ReflectionMethod;
/**
* Stores collected data into Memcache using the Memcached extension
*/
class MemcachedStorage extends AbstractStorage
{
protected Memcached $memcached;
protected string $keyNamespace;
protected int $expiration;
protected ?bool $newGetMultiSignature = null;
/**
* @param string $keyNamespace Namespace for Memcached key names (to avoid conflict with other Memcached users).
* @param int $expiration Expiration for Memcached entries (see Expiration Times in Memcached documentation).
*/
public function __construct(Memcached $memcached, string $keyNamespace = 'phpdebugbar', int $expiration = 0)
{
$this->memcached = $memcached;
$this->keyNamespace = $keyNamespace;
$this->expiration = $expiration;
}
/**
* {@inheritdoc}
*/
public function save(string $id, array $data): void
{
$key = $this->createKey($id);
$this->memcached->set($key, $data, $this->expiration);
if (!$this->memcached->append($this->keyNamespace, "|$key")) {
$this->memcached->set($this->keyNamespace, $key, $this->expiration);
} elseif ($this->expiration) {
// append doesn't support updating expiration, so do it here:
$this->memcached->touch($this->keyNamespace, $this->expiration);
}
}
/**
* {@inheritdoc}
*/
public function get(string $id): array
{
return $this->memcached->get($this->createKey($id)) ?: [];
}
/**
* {@inheritdoc}
*/
public function find(array $filters = [], int $max = 20, int $offset = 0): array
{
if (!($keys = $this->memcached->get($this->keyNamespace))) {
return [];
}
$results = [];
$keys = array_reverse(explode('|', $keys)); // Reverse so newest comes first
$keyPosition = 0; // Index in $keys to try to get next items from
$remainingItems = $max + $offset; // Try to obtain this many remaining items
// Loop until we've found $remainingItems matching items or no more items may exist.
while ($remainingItems > 0 && $keyPosition < count($keys)) {
// Consume some keys from $keys:
$itemsToGet = array_slice($keys, $keyPosition, $remainingItems);
$keyPosition += $remainingItems;
// Try to get them, and filter them:
$newItems = $this->memcachedGetMulti($itemsToGet, Memcached::GET_PRESERVE_ORDER);
if ($newItems) {
foreach ($newItems as $data) {
$meta = $data['__meta'];
if ($this->filter($meta, $filters)) {
$remainingItems--;
// Keep the result only if we've discarded $offset items first
if ($offset <= 0) {
$results[] = $meta;
} else {
$offset--;
}
}
}
}
}
return $results;
}
/**
* Filter the metadata for matches.
*
*
*/
protected function filter(array $meta, array $filters): bool
{
foreach ($filters as $key => $value) {
if (!isset($meta[$key]) || fnmatch($value, $meta[$key]) === false) {
return false;
}
}
return true;
}
/**
* {@inheritdoc}
*/
public function clear(): void
{
if (!($keys = $this->memcached->get($this->keyNamespace))) {
return;
}
$this->memcached->delete($this->keyNamespace);
$this->memcached->deleteMulti(explode('|', $keys));
}
protected function createKey(string $id): string
{
return md5("{$this->keyNamespace}.$id");
}
public function prune(int $hours = 24): void
{
// Memcached has built-in expiration, so GC is not needed
// Items automatically expire based on the expiration time set during save()
// This method is here to satisfy the interface requirement
}
/**
* The memcached getMulti function changed in version 3.0.0 to only have two parameters.
*
*/
protected function memcachedGetMulti(array $keys, int $flags): mixed
{
if ($this->newGetMultiSignature === null) {
$this->newGetMultiSignature = (new ReflectionMethod('Memcached', 'getMulti'))->getNumberOfParameters() === 2;
}
if ($this->newGetMultiSignature) {
return $this->memcached->getMulti($keys, $flags);
}
/** @phpstan-ignore arguments.count, argument.type */
return $this->memcached->getMulti($keys, null, $flags);
}
}