This repository has been archived by the owner on Jan 8, 2020. It is now read-only.
/
WinCache.php
511 lines (447 loc) · 15 KB
/
WinCache.php
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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
<?php
/**
* Zend Framework (http://framework.zend.com/)
*
* @link http://github.com/zendframework/zf2 for the canonical source repository
* @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
* @package Zend_Cache
*/
namespace Zend\Cache\Storage\Adapter;
use stdClass;
use Traversable;
use Zend\Cache\Exception;
use Zend\Cache\Storage\AvailableSpaceCapableInterface;
use Zend\Cache\Storage\Capabilities;
use Zend\Cache\Storage\FlushableInterface;
use Zend\Cache\Storage\TotalSpaceCapableInterface;
/**
* @package Zend_Cache
* @subpackage Zend_Cache_Storage
* @subpackage Storage
*/
class WinCache extends AbstractAdapter implements
AvailableSpaceCapableInterface,
FlushableInterface,
TotalSpaceCapableInterface
{
/**
* Constructor
*
* @param array|Traversable|WinCacheOptions $options
* @throws Exception\ExceptionInterface
*/
public function __construct($options = null)
{
if (!extension_loaded('wincache')) {
throw new Exception\ExtensionNotLoadedException("WinCache extension is not loaded");
}
$enabled = ini_get('wincache.ucenabled');
if (PHP_SAPI == 'cli') {
$enabled = $enabled && (bool) ini_get('wincache.enablecli');
}
if (!$enabled) {
throw new Exception\ExtensionNotLoadedException(
"WinCache is disabled - see 'wincache.ucenabled' and 'wincache.enablecli'"
);
}
parent::__construct($options);
}
/* options */
/**
* Set options.
*
* @param array|Traversable|WinCacheOptions $options
* @return WinCache
* @see getOptions()
*/
public function setOptions($options)
{
if (!$options instanceof WinCacheOptions) {
$options = new WinCacheOptions($options);
}
return parent::setOptions($options);
}
/**
* Get options.
*
* @return WinCacheOptions
* @see setOptions()
*/
public function getOptions()
{
if (!$this->options) {
$this->setOptions(new WinCacheOptions());
}
return $this->options;
}
/* TotalSpaceCapableInterface */
/**
* Get total space in bytes
*
* @return int|float
*/
public function getTotalSpace()
{
$mem = wincache_ucache_meminfo();
return $mem['memory_total'];
}
/* AvailableSpaceCapableInterface */
/**
* Get available space in bytes
*
* @return int|float
*/
public function getAvailableSpace()
{
$mem = wincache_ucache_meminfo();
return $mem['memory_free'];
}
/* FlushableInterface */
/**
* Flush the whole storage
*
* @return boolean
*/
public function flush()
{
return wincache_ucache_clear();
}
/* reading */
/**
* Internal method to get an item.
*
* @param string $normalizedKey
* @param boolean $success
* @param mixed $casToken
* @return mixed Data on success, null on failure
* @throws Exception\ExceptionInterface
*/
protected function internalGetItem(& $normalizedKey, & $success = null, & $casToken = null)
{
$options = $this->getOptions();
$prefix = $options->getNamespace() . $options->getNamespaceSeparator();
$internalKey = $prefix . $normalizedKey;
$result = wincache_ucache_get($internalKey, $success);
if ($success) {
$casToken = $result;
}
return $result;
}
/**
* Internal method to get multiple items.
*
* @param array $normalizedKeys
* @return array Associative array of keys and values
* @throws Exception\ExceptionInterface
*/
protected function internalGetItems(array & $normalizedKeys)
{
$options = $this->getOptions();
$prefix = $options->getNamespace() . $options->getNamespaceSeparator();
$internalKeys = array();
foreach ($normalizedKeys as $normalizedKey) {
$internalKeys[] = $prefix . $normalizedKey;
}
$fetch = wincache_ucache_get($internalKeys);
// remove namespace prefix
$prefixL = strlen($prefix);
$result = array();
foreach ($fetch as $internalKey => & $value) {
$result[ substr($internalKey, $prefixL) ] = & $value;
}
return $result;
}
/**
* Internal method to test if an item exists.
*
* @param string $normalizedKey
* @return boolean
* @throws Exception\ExceptionInterface
*/
protected function internalHasItem(& $normalizedKey)
{
$options = $this->getOptions();
$prefix = $options->getNamespace() . $options->getNamespaceSeparator();
return wincache_ucache_exists($prefix . $normalizedKey);
}
/**
* Get metadata of an item.
*
* @param string $normalizedKey
* @return array|boolean Metadata on success, false on failure
* @throws Exception\ExceptionInterface
*/
protected function internalGetMetadata(& $normalizedKey)
{
$options = $this->getOptions();
$prefix = $options->getNamespace() . $options->getNamespaceSeparator();
$internalKey = $prefix . $normalizedKey;
$info = wincache_ucache_info(true, $internalKey);
if (isset($info['ucache_entries'][1])) {
$metadata = $info['ucache_entries'][1];
$this->normalizeMetadata($metadata);
return $metadata;
} else {
return false;
}
}
/* writing */
/**
* Internal method to store an item.
*
* @param string $normalizedKey
* @param mixed $value
* @return boolean
* @throws Exception\ExceptionInterface
*/
protected function internalSetItem(& $normalizedKey, & $value)
{
$options = $this->getOptions();
$prefix = $options->getNamespace() . $options->getNamespaceSeparator();
$internalKey = $prefix . $normalizedKey;
$ttl = $options->getTtl();
if (!wincache_ucache_set($internalKey, $value, $ttl)) {
$type = is_object($value) ? get_class($value) : gettype($value);
throw new Exception\RuntimeException(
"wincache_ucache_set('{$internalKey}', <{$type}>, {$ttl}) failed"
);
}
return true;
}
/**
* Internal method to store multiple items.
*
* @param array $normalizedKeyValuePairs
* @return array Array of not stored keys
* @throws Exception\ExceptionInterface
*/
protected function internalSetItems(array & $normalizedKeyValuePairs)
{
$options = $this->getOptions();
$prefix = $options->getNamespace() . $options->getNamespaceSeparator();
$prefixL = strlen($prefix);
$internalKeyValuePairs = array();
foreach ($normalizedKeyValuePairs as $normalizedKey => $value) {
$internalKey = $prefix . $normalizedKey;
$internalKeyValuePairs[$internalKey] = $value;
}
$result = wincache_ucache_set($internalKeyValuePairs, null, $options->getTtl());
// remove key prefic
foreach ($result as & $key) {
$key = substr($key, $prefixL);
}
return $result;
}
/**
* Add an item.
*
* @param string $normalizedKey
* @param mixed $value
* @return boolean
* @throws Exception\ExceptionInterface
*/
protected function internalAddItem(& $normalizedKey, & $value)
{
$options = $this->getOptions();
$prefix = $options->getNamespace() . $options->getNamespaceSeparator();
$internalKey = $prefix . $normalizedKey;
$ttl = $options->getTtl();
if (!wincache_ucache_add($internalKey, $value, $ttl)) {
$type = is_object($value) ? get_class($value) : gettype($value);
throw new Exception\RuntimeException(
"wincache_ucache_add('{$internalKey}', <{$type}>, {$ttl}) failed"
);
}
return true;
}
/**
* Internal method to add multiple items.
*
* @param array $normalizedKeyValuePairs
* @return array Array of not stored keys
* @throws Exception\ExceptionInterface
*/
protected function internalAddItems(array & $normalizedKeyValuePairs)
{
$options = $this->getOptions();
$prefix = $options->getNamespace() . $options->getNamespaceSeparator();
$prefixL = strlen($prefix);
$internalKeyValuePairs = array();
foreach ($normalizedKeyValuePairs as $normalizedKey => $value) {
$internalKey = $prefix . $normalizedKey;
$internalKeyValuePairs[$internalKey] = $value;
}
$result = wincache_ucache_add($internalKeyValuePairs, null, $options->getTtl());
// remove key prefic
foreach ($result as & $key) {
$key = substr($key, $prefixL);
}
return $result;
}
/**
* Internal method to replace an existing item.
*
* @param string $normalizedKey
* @param mixed $value
* @return boolean
* @throws Exception\ExceptionInterface
*/
protected function internalReplaceItem(& $normalizedKey, & $value)
{
$options = $this->getOptions();
$prefix = $options->getNamespace() . $options->getNamespaceSeparator();
$internalKey = $prefix . $normalizedKey;
if (!wincache_ucache_exists($internalKey)) {
return false;
}
$ttl = $options->getTtl();
if (!wincache_ucache_set($internalKey, $value, $ttl)) {
$type = is_object($value) ? get_class($value) : gettype($value);
throw new Exception\RuntimeException(
"wincache_ucache_set('{$internalKey}', <{$type}>, {$ttl}) failed"
);
}
return true;
}
/**
* Internal method to remove an item.
*
* @param string $normalizedKey
* @return boolean
* @throws Exception\ExceptionInterface
*/
protected function internalRemoveItem(& $normalizedKey)
{
$options = $this->getOptions();
$prefix = $options->getNamespace() . $options->getNamespaceSeparator();
$internalKey = $prefix . $normalizedKey;
return wincache_ucache_delete($internalKey);
}
/**
* Internal method to remove multiple items.
*
* @param array $normalizedKeys
* @return array Array of not removed keys
* @throws Exception\ExceptionInterface
*/
protected function internalRemoveItems(array & $normalizedKeys)
{
$options = $this->getOptions();
$prefix = $options->getNamespace() . $options->getNamespaceSeparator();
$internalKeys = array();
foreach ($normalizedKeys as $normalizedKey) {
$internalKeys[] = $prefix . $normalizedKey;
}
$result = wincache_ucache_delete($internalKeys);
if ($result === false) {
return $normalizedKeys;
} elseif ($result) {
// remove key prefix
$prefixL = strlen($prefix);
foreach ($result as & $key) {
$key = substr($key, $prefixL);
}
}
return $result;
}
/**
* Internal method to increment an item.
*
* @param string $normalizedKey
* @param int $value
* @return int|boolean The new value on success, false on failure
* @throws Exception\ExceptionInterface
*/
protected function internalIncrementItem(& $normalizedKey, & $value)
{
$options = $this->getOptions();
$prefix = $options->getNamespace() . $options->getNamespaceSeparator();
$internalKey = $prefix . $normalizedKey;
return wincache_ucache_inc($internalKey, (int)$value);
}
/**
* Internal method to decrement an item.
*
* @param string $normalizedKey
* @param int $value
* @return int|boolean The new value on success, false on failure
* @throws Exception\ExceptionInterface
*/
protected function internalDecrementItem(& $normalizedKey, & $value)
{
$options = $this->getOptions();
$prefix = $options->getNamespace() . $options->getNamespaceSeparator();
$internalKey = $prefix . $normalizedKey;
return wincache_ucache_dec($internalKey, (int)$value);
}
/* status */
/**
* Internal method to get capabilities of this adapter
*
* @return Capabilities
*/
protected function internalGetCapabilities()
{
if ($this->capabilities === null) {
$marker = new stdClass();
$capabilities = new Capabilities(
$this,
$marker,
array(
'supportedDatatypes' => array(
'NULL' => true,
'boolean' => true,
'integer' => true,
'double' => true,
'string' => true,
'array' => true,
'object' => 'object',
'resource' => false,
),
'supportedMetadata' => array(
'internal_key', 'ttl', 'hits', 'size'
),
'minTtl' => 1,
'maxTtl' => 0,
'staticTtl' => true,
'ttlPrecision' => 1,
'useRequestTime' => false,
'expiredRead' => false,
'namespaceIsPrefix' => true,
'namespaceSeparator' => $this->getOptions()->getNamespaceSeparator(),
)
);
// update namespace separator on change option
$this->getEventManager()->attach('option', function ($event) use ($capabilities, $marker) {
$params = $event->getParams();
if (isset($params['namespace_separator'])) {
$capabilities->setNamespaceSeparator($marker, $params['namespace_separator']);
}
});
$this->capabilities = $capabilities;
$this->capabilityMarker = $marker;
}
return $this->capabilities;
}
/* internal */
/**
* Normalize metadata to work with WinCache
*
* @param array $metadata
* @return void
*/
protected function normalizeMetadata(array & $metadata)
{
$metadata['internal_key'] = $metadata['key_name'];
$metadata['hits'] = $metadata['hitcount'];
$metadata['ttl'] = $metadata['ttl_seconds'];
$metadata['size'] = $metadata['value_size'];
unset(
$metadata['key_name'],
$metadata['hitcount'],
$metadata['ttl_seconds'],
$metadata['value_size']
);
}
}