|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
declare(strict_types=1); |
|
4
|
|
|
|
|
5
|
|
|
namespace Doctrine\Common\Cache; |
|
6
|
|
|
|
|
7
|
|
|
use Couchbase\Bucket; |
|
8
|
|
|
use Couchbase\Document; |
|
9
|
|
|
use Couchbase\Exception; |
|
10
|
|
|
use function phpversion; |
|
11
|
|
|
use function serialize; |
|
12
|
|
|
use function sprintf; |
|
13
|
|
|
use function substr; |
|
14
|
|
|
use function time; |
|
15
|
|
|
use function unserialize; |
|
16
|
|
|
use function version_compare; |
|
17
|
|
|
|
|
18
|
|
|
/** |
|
19
|
|
|
* Couchbase ^2.3.0 cache provider. |
|
20
|
|
|
*/ |
|
21
|
|
|
final class CouchbaseBucketCache extends CacheProvider |
|
22
|
|
|
{ |
|
23
|
|
|
private const MINIMUM_VERSION = '2.3.0'; |
|
24
|
|
|
|
|
25
|
|
|
private const KEY_NOT_FOUND = 13; |
|
26
|
|
|
|
|
27
|
|
|
private const MAX_KEY_LENGTH = 250; |
|
28
|
|
|
|
|
29
|
|
|
private const THIRTY_DAYS_IN_SECONDS = 2592000; |
|
30
|
|
|
|
|
31
|
|
|
/** @var Bucket */ |
|
32
|
|
|
private $bucket; |
|
33
|
|
|
|
|
34
|
|
|
public function __construct(Bucket $bucket) |
|
35
|
|
|
{ |
|
36
|
|
|
if (version_compare(phpversion('couchbase'), self::MINIMUM_VERSION) < 0) { |
|
37
|
|
|
// Manager is required to flush cache and pull stats. |
|
38
|
|
|
throw new \RuntimeException(sprintf('ext-couchbase:^%s is required.', self::MINIMUM_VERSION)); |
|
39
|
|
|
} |
|
40
|
|
|
|
|
41
|
|
|
$this->bucket = $bucket; |
|
42
|
|
|
} |
|
43
|
|
|
|
|
44
|
|
|
/** |
|
45
|
|
|
* {@inheritdoc} |
|
46
|
|
|
*/ |
|
47
|
|
|
protected function doFetch($id) |
|
48
|
|
|
{ |
|
49
|
|
|
$id = $this->normalizeKey($id); |
|
50
|
78 |
|
|
|
51
|
|
|
try { |
|
52
|
78 |
|
$document = $this->bucket->get($id); |
|
53
|
|
|
} catch (Exception $e) { |
|
54
|
|
|
return false; |
|
55
|
|
|
} |
|
56
|
|
|
|
|
57
|
78 |
|
if ($document instanceof Document && $document->value !== false) { |
|
58
|
78 |
|
return unserialize($document->value); |
|
59
|
|
|
} |
|
60
|
|
|
|
|
61
|
|
|
return false; |
|
62
|
|
|
} |
|
63
|
76 |
|
|
|
64
|
|
|
/** |
|
65
|
76 |
|
* {@inheritdoc} |
|
66
|
|
|
*/ |
|
67
|
|
|
protected function doContains($id) |
|
68
|
76 |
|
{ |
|
69
|
66 |
|
$id = $this->normalizeKey($id); |
|
70
|
66 |
|
|
|
71
|
|
|
try { |
|
72
|
|
|
$document = $this->bucket->get($id); |
|
73
|
73 |
|
} catch (Exception $e) { |
|
74
|
73 |
|
return false; |
|
75
|
|
|
} |
|
76
|
|
|
|
|
77
|
|
|
if ($document instanceof Document) { |
|
78
|
|
|
return ! $document->error; |
|
79
|
|
|
} |
|
80
|
|
|
|
|
81
|
|
|
return false; |
|
82
|
|
|
} |
|
83
|
73 |
|
|
|
84
|
|
|
/** |
|
85
|
73 |
|
* {@inheritdoc} |
|
86
|
|
|
*/ |
|
87
|
|
|
protected function doSave($id, $data, $lifeTime = 0) |
|
88
|
73 |
|
{ |
|
89
|
53 |
|
$id = $this->normalizeKey($id); |
|
90
|
53 |
|
|
|
91
|
|
|
$lifeTime = $this->normalizeExpiry($lifeTime); |
|
92
|
|
|
|
|
93
|
69 |
|
try { |
|
94
|
69 |
|
$encoded = serialize($data); |
|
95
|
|
|
|
|
96
|
|
|
$document = $this->bucket->upsert($id, $encoded, [ |
|
97
|
|
|
'expiry' => (int) $lifeTime, |
|
98
|
|
|
]); |
|
99
|
|
|
} catch (Exception $e) { |
|
100
|
|
|
return false; |
|
101
|
|
|
} |
|
102
|
|
|
|
|
103
|
74 |
|
if ($document instanceof Document) { |
|
104
|
|
|
return ! $document->error; |
|
105
|
74 |
|
} |
|
106
|
|
|
|
|
107
|
74 |
|
return false; |
|
108
|
|
|
} |
|
109
|
|
|
|
|
110
|
74 |
|
/** |
|
111
|
|
|
* {@inheritdoc} |
|
112
|
74 |
|
*/ |
|
113
|
74 |
|
protected function doDelete($id) |
|
114
|
|
|
{ |
|
115
|
|
|
$id = $this->normalizeKey($id); |
|
116
|
|
|
|
|
117
|
|
|
try { |
|
118
|
|
|
$document = $this->bucket->remove($id); |
|
119
|
74 |
|
} catch (Exception $e) { |
|
120
|
74 |
|
return $e->getCode() === self::KEY_NOT_FOUND; |
|
121
|
|
|
} |
|
122
|
|
|
|
|
123
|
|
|
if ($document instanceof Document) { |
|
124
|
|
|
return ! $document->error; |
|
125
|
|
|
} |
|
126
|
|
|
|
|
127
|
|
|
return false; |
|
128
|
|
|
} |
|
129
|
45 |
|
|
|
130
|
|
|
/** |
|
131
|
45 |
|
* {@inheritdoc} |
|
132
|
|
|
*/ |
|
133
|
|
|
protected function doFlush() |
|
134
|
45 |
|
{ |
|
135
|
3 |
|
$manager = $this->bucket->manager(); |
|
136
|
3 |
|
|
|
137
|
|
|
// Flush does not return with success or failure, and must be enabled per bucket on the server. |
|
138
|
|
|
// Store a marker item so that we will know if it was successful. |
|
139
|
43 |
|
$this->doSave(__METHOD__, true, 60); |
|
140
|
43 |
|
|
|
141
|
|
|
$manager->flush(); |
|
142
|
|
|
|
|
143
|
|
|
if ($this->doContains(__METHOD__)) { |
|
144
|
|
|
$this->doDelete(__METHOD__); |
|
145
|
|
|
|
|
146
|
|
|
return false; |
|
147
|
|
|
} |
|
148
|
|
|
|
|
149
|
2 |
|
return true; |
|
150
|
|
|
} |
|
151
|
2 |
|
|
|
152
|
|
|
/** |
|
153
|
|
|
* {@inheritdoc} |
|
154
|
|
|
*/ |
|
155
|
2 |
|
protected function doGetStats() |
|
156
|
|
|
{ |
|
157
|
2 |
|
$manager = $this->bucket->manager(); |
|
158
|
|
|
$stats = $manager->info(); |
|
159
|
2 |
|
$nodes = $stats['nodes']; |
|
160
|
|
|
$node = $nodes[0]; |
|
161
|
|
|
$interestingStats = $node['interestingStats']; |
|
162
|
|
|
|
|
163
|
|
|
return [ |
|
164
|
|
|
Cache::STATS_HITS => $interestingStats['get_hits'], |
|
165
|
2 |
|
Cache::STATS_MISSES => $interestingStats['cmd_get'] - $interestingStats['get_hits'], |
|
166
|
|
|
Cache::STATS_UPTIME => $node['uptime'], |
|
167
|
|
|
Cache::STATS_MEMORY_USAGE => $interestingStats['mem_used'], |
|
168
|
|
|
Cache::STATS_MEMORY_AVAILABLE => $node['memoryFree'], |
|
169
|
|
|
]; |
|
170
|
|
|
} |
|
171
|
1 |
|
|
|
172
|
|
|
private function normalizeKey(string $id) : string |
|
173
|
1 |
|
{ |
|
174
|
1 |
|
$normalized = substr($id, 0, self::MAX_KEY_LENGTH); |
|
175
|
1 |
|
|
|
176
|
1 |
|
if ($normalized === false) { |
|
177
|
1 |
|
return $id; |
|
178
|
|
|
} |
|
179
|
|
|
|
|
180
|
1 |
|
return $normalized; |
|
181
|
1 |
|
} |
|
182
|
1 |
|
|
|
183
|
1 |
|
/** |
|
184
|
1 |
|
* Expiry treated as a unix timestamp instead of an offset if expiry is greater than 30 days. |
|
185
|
|
|
* @src https://developer.couchbase.com/documentation/server/4.1/developer-guide/expiry.html |
|
186
|
|
|
*/ |
|
187
|
|
|
private function normalizeExpiry(int $expiry) : int |
|
188
|
|
|
{ |
|
189
|
|
|
if ($expiry > self::THIRTY_DAYS_IN_SECONDS) { |
|
190
|
|
|
return time() + $expiry; |
|
191
|
|
|
} |
|
192
|
76 |
|
|
|
193
|
|
|
return $expiry; |
|
194
|
76 |
|
} |
|
195
|
|
|
} |
|
196
|
|
|
|
doctrine /
cache
