forked from stunti/Stunti_Cache_Backend_Mongo
-
Notifications
You must be signed in to change notification settings - Fork 5
/
Mongo.php
568 lines (525 loc) · 19.5 KB
/
Mongo.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
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
<?php
/**
* @see Zend_Cache_Backend
*/
require_once 'Zend/Cache/Backend.php';
/**
* @see Zend_Cache_Backend_ExtendedInterface
*/
require_once 'Zend/Cache/Backend/ExtendedInterface.php';
/**
* @author Olivier Bregeras (Stunti) (olivier.bregeras@gmail.com)
* @author Anton Stöckl (anton@stoeckl.de)
* @package Zend_Cache
* @subpackage Zend_Cache_Backend_Mongo
* @copyright Copyright (c) 2009 Stunti. (http://www.stunti.org)
* @copyright Copyright (c) 2011 Anton Stöckl (http://www.stoeckl.de)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
class Zend_Cache_Backend_Mongo extends Zend_Cache_Backend implements Zend_Cache_Backend_ExtendedInterface
{
const DEFAULT_HOST = '127.0.0.1';
const DEFAULT_PORT = 27017;
const DEFAULT_DBNAME = 'Db_Cache';
const DEFAULT_COLLECTION = 'C_Cache';
/**
* The MongoCollection to which cache entries will be written.
*
* @var \MongoCollection
*/
protected $_collection;
/**
* If true, indexes have already been ensured for the above collection.
*
* @var bool
*/
private $_indexesEnsured = false;
/**
* Available options:
* 'incrementHitCounter' => (bool): if true, hit counter is incremented
* on each read (increases load on the master).
*
* Also:
* 1. If 'collection' property is present and holds an instance
* of MongoConnection, it is used to hold the cached data.
* 2. Otherwise, the following options are available:
* 'host' => (string): the name of the MongoDB server
* 'port' => (int): the port of the MongoDB server
* 'user' => (string): username to connect as
* 'password' => (string): password to connect with
* 'dbname' => (string): name of the database to use
* 'collection' => (string): name of the collection to use
*
* @var array
*/
protected $_options = array(
'host' => self::DEFAULT_HOST,
'port' => self::DEFAULT_PORT,
'dbname' => self::DEFAULT_DBNAME,
'collection' => self::DEFAULT_COLLECTION,
);
/**
* Note that we use TTL Collections to have the Mongo deamon automatically clean
* expired entries.
*
* @link http://docs.mongodb.org/manual/tutorial/expire-data/
* @param array $options
*/
public function __construct(array $options = array())
{
if (!extension_loaded('mongo')) {
Zend_Cache::throwException('The MongoDB extension must be loaded for using this backend !');
}
parent::__construct($options);
// Merge the options passed in; overriding any default options
$this->_options = array_merge($this->_options, $options);
// We check by is_object(), not by "instanceof \MongoCollection", because
// there could be a wrapper passed, which defines __get() and __call()
// methods to intercept and pass calls to a real wrapped MongoConnection
// (e.g. for lazy connections, for reconnect support etc.).
if (isset($this->_options['collection']) && is_object($this->_options['collection'])) {
$this->_collection = $this->_options['collection'];
$this->_options['collection'] = $this->_collection->getName();
} else {
$conn = new \MongoClient($this->_getServerConnectionUrl());
$db = $conn->selectDB($this->_options['dbname']);
$this->_collection = $db->selectCollection($this->_options['collection']);
}
}
/**
* Assembles the URL that can be used to connect to the MongoDB server.
*
* Note that:
* - FALSE, NULL or empty string values should be used to discard options
* in an environment-specific configuration. For example when a 'development'
* environment overrides a 'production' environment, it might be required
* to discard the username and/or password, when this is not required
* during development
*
* @link http://www.php.net/manual/en/mongoclient.construct.php
* @return string
*/
private function _getServerConnectionUrl()
{
$parts = array('mongodb://');
if (isset($this->_options['username']) && strlen($this->_options['username']) > 0 && isset($this->_options['password']) && strlen($this->_options['password']) > 0) {
$parts[] = $this->_options['username'];
$parts[] = ':';
$parts[] = $this->_options['password'];
$parts[] = '@';
}
$parts[] = isset($this->_options['host']) && strlen($this->_options['host']) > 0 ? $this->_options['host'] : self::DEFAULT_HOST;
$parts[] = ':';
$parts[] = isset($this->_options['port']) && is_numeric($this->_options['port']) ? $this->_options['port'] : self::DEFAULT_PORT;
$parts[] = '/';
$parts[] = isset($this->_options['dbname']) && strlen($this->_options['dbname']) > 0 ? $this->_options['dbname'] : self::DEFAULT_DBNAME;
return implode('', $parts);
}
/**
* Expires a record (mostly used for testing purposes).
*
* @param string $id
* @return void
*/
public function ___expire($id)
{
if ($tmp = $this->_get($id)) {
$tmp['expires_at'] = new \MongoDate(3600 * 24 * 7); // near 1970th, deep past
$this->_collection->save($tmp);
}
}
/**
* Tests if a cache is available for the given id and (if yes) return it (false else).
*
* @param string $id Cache id.
* @param bool $doNotTestCacheValidity If set to true, the cache validity won't be tested.
* @return string Cached data or false if not found.
*/
public function load($id, $doNotTestCacheValidity = false)
{
try {
if ($tmp = $this->_get($id, !empty($this->_options['incrementHitCounter']))) {
if ($doNotTestCacheValidity || $tmp['expires_at'] === null || $tmp['expires_at']->sec >= time()) {
return $tmp['d'];
}
return false;
}
} catch (Exception $e) {
$this->_log(__METHOD__ . ': ' . $e->getMessage());
return false;
}
return false;
}
/**
* Tests if a cache is available or not (for the given id).
*
* @param string $id Cache id.
* @return mixed Returns false (a cache is not available) or "last modified" timestamp (int) of the available cache record.
*/
public function test($id)
{
try {
if ($tmp = $this->_get($id)) {
return $tmp['created_at'];
}
} catch (Exception $e) {
$this->_log(__METHOD__ . ': ' . $e->getMessage());
return false;
}
return false;
}
/**
* Saves some string data into a cache record.
*
* Note: $data is always "string" (serialization is done by the
* core, not by the backend).
*
* @param string $data Data to cache.
* @param string $id Cache id.
* @param array $tags Array of strings, the cache record will be tagged by each string entry.
* @param int|bool $specificLifetime If != false, set a specific lifetime for this cache record (null => infinite lifetime).
* @return boolean True if no problems appeared.
*/
public function save($data, $id, $tags = array(), $specificLifetime = false)
{
try {
$lifetime = $this->getLifetime($specificLifetime);
$result = $this->_set($id, $data, $lifetime, $tags);
} catch (Exception $e) {
$this->_log(__METHOD__ . ': ' . $e->getMessage());
$result = false;
}
return (bool)$result;
}
/**
* Removes a cache record.
*
* @param string $id Cache id.
* @return boolean True if no problems appeared.
*/
public function remove($id)
{
try {
$this->_ensureIndexes();
$result = $this->_collection->remove(array('_id' => $id));
} catch (Exception $e) {
$this->_log(__METHOD__ . ': ' . $e->getMessage());
return false;
}
return $result;
}
/**
* Cleans some cache records (protected method used for recursive stuff).
*
* Available modes are:
* Zend_Cache::CLEANING_MODE_ALL (default) => remove all cache entries ($tags is not used)
* Zend_Cache::CLEANING_MODE_OLD => remove too old cache entries ($tags is not used)
* Zend_Cache::CLEANING_MODE_MATCHING_TAG => remove cache entries matching all given tags
* ($tags can be an array of strings or a single string)
* Zend_Cache::CLEANING_MODE_NOT_MATCHING_TAG => remove cache entries not {matching one of the given tags}
* ($tags can be an array of strings or a single string)
* Zend_Cache::CLEANING_MODE_MATCHING_ANY_TAG => remove cache entries matching any given tags
* ($tags can be an array of strings or a single string)
* @param string $mode Clean mode.
* @param array $tags Array of tags.
* @return boolean True if no problems appeared.
* @throws Zend_Cache_Exception
*/
public function clean($mode = Zend_Cache::CLEANING_MODE_ALL, $tags = array())
{
$this->_ensureIndexes();
switch ($mode) {
case Zend_Cache::CLEANING_MODE_ALL:
return $this->_collection->remove(array());
case Zend_Cache::CLEANING_MODE_OLD:
return $this->_collection->remove(array('expires_at' => array('$lt' => new \MongoDate())));
case Zend_Cache::CLEANING_MODE_MATCHING_TAG:
return $this->_collection->remove(array('t' => array('$all' => $tags)));
case Zend_Cache::CLEANING_MODE_NOT_MATCHING_TAG:
return $this->_collection->remove(array('t' => array('$nin' => $tags)));
case Zend_Cache::CLEANING_MODE_MATCHING_ANY_TAG:
return $this->_collection->remove(array('t' => array('$in' => $tags)));
default:
Zend_Cache::throwException('Invalid mode for clean() method');
return false;
}
}
/**
* Returns true if the automatic cleaning is available for the backend.
*
* @return bool
*/
public function isAutomaticCleaningAvailable()
{
return false;
}
/**
* Sets the frontend directives.
*
* @param array $directives Assoc of directives
* @return void
*/
public function setDirectives($directives)
{
parent::setDirectives($directives);
$lifetime = $this->getLifetime(false);
if ($lifetime === null) {
// #ZF-4614 : we tranform null to zero to get the maximal lifetime
parent::setDirectives(array('lifetime' => 0));
}
}
/**
* Returns an array of stored cache ids.
*
* @return array array of stored cache ids (string)
*/
public function getIds()
{
$cursor = $this->_collection->find();
$ret = array();
while ($tmp = $cursor->getNext()) {
$ret[] = $tmp['_id'];
}
return $ret;
}
/**
* Returns an array of stored tags.
*
* @return array array of stored tags (string)
*/
public function getTags()
{
$db = $this->_collection->db;
$cmd['mapreduce'] = $this->_options['collection'];
$cmd['map'] = 'function(){
this.t.forEach(
function(z){
emit( z , { count : 1 } );
}
);
};';
$cmd['reduce'] = 'function( key , values ){
var total = 0;
for ( var i=0; i<values.length; i++ )
total += values[i].count;
return { count : total };
};';
$cmd['out'] = array('replace' => 'getTagsCollection');
$res2 = $db->command($cmd);
$res3 = $db->selectCollection('getTagsCollection')->find();
$res = array();
foreach ($res3 as $key => $val) {
$res[] = $key;
}
$db->dropCollection($res2['result']);
return $res;
}
/**
* Aux method to drop the whole collection.
*
* @return array
*/
public function drop()
{
return $this->_collection->drop();
}
/**
* Returns an array of stored cache ids which match given tags.
* In case of multiple tags, a logical AND is made between tags.
*
* @param array $tags Array of tags.
* @return array Array of matching cache ids (string).
*/
public function getIdsMatchingTags($tags = array())
{
$cursor = $this->_collection->find(
array('t' => array('$all' => $tags))
);
$ret = array();
while ($tmp = $cursor->getNext()) {
$ret[] = $tmp['_id'];
}
return $ret;
}
/**
* Returns an array of stored cache ids which don't match given tags.
* In case of multiple tags, a logical OR is made between tags.
*
* @param array $tags Array of tags.
* @return array Array of not matching cache ids (string).
*/
public function getIdsNotMatchingTags($tags = array())
{
$cursor = $this->_collection->find(
array('t' => array('$nin' => $tags))
);
$ret = array();
while ($tmp = $cursor->getNext()) {
$ret[] = $tmp['_id'];
}
return $ret;
}
/**
* Returns an array of stored cache ids which match any given tags.
* In case of multiple tags, a logical AND is made between tags.
*
* @param array $tags array of tags
* @return array array of any matching cache ids (string)
*/
public function getIdsMatchingAnyTags($tags = array())
{
$cursor = $this->_collection->find(
array('t' => array('$in' => $tags))
);
$ret = array();
while ($tmp = $cursor->getNext()) {
$ret[] = $tmp['_id'];
}
return $ret;
}
/**
* No way to find the remaining space right now. So return 1.
*
* @throws Zend_Cache_Exception
* @return int integer between 0 and 100
*/
public function getFillingPercentage()
{
return 1;
}
/**
* Returns an array of metadatas for the given cache id.
*
* The array must include these keys:
* - expire: the expire timestamp
* - tags: a string array of tags
* - mtime: timestamp of last modification time
*
* @param string $id cache id
* @return array array of metadatas (false if the cache id is not found)
*/
public function getMetadatas($id)
{
if ($tmp = $this->_get($id)) {
$expiresAt = $tmp['expires_at'];
$createdAt = $tmp['created_at'];
return array(
'expire' => $expiresAt instanceof \MongoDate ? $expiresAt->sec : null,
'tags' => $tmp['t'],
'mtime' => $createdAt->sec
);
}
return false;
}
/**
* Gives (if possible) an extra lifetime to the given cache id.
* TODO: consider using findOneAndModify to reduce amount of requests to MongoDB.
*
* @param string $id Cache id.
* @param integer $extraLifetime
* @return boolean True if OK.
*/
public function touch($id, $extraLifetime)
{
$result = false;
if ($tmp = $this->_get($id)) {
// Check whether an expiration time has been set that has not expired yet.
if ($tmp['expires_at'] instanceof \MongoDate && $tmp['expires_at']->sec > time()) {
$newLifetime = $tmp['expires_at']->sec + $extraLifetime;
$result = $this->_set($id, $tmp['d'], $newLifetime, $tmp['t']);
}
}
return $result;
}
/**
* Returns an associative array of capabilities (booleans) of the backend.
*
* The array must include these keys:
* - automatic_cleaning (is automating cleaning necessary)
* - tags (are tags supported)
* - expired_read (is it possible to read expired cache records
* (for doNotTestCacheValidity option for example))
* - priority does the backend deal with priority when saving
* - infinite_lifetime (is infinite lifetime can work with this backend)
* - get_list (is it possible to get the list of cache ids and the complete list of tags)
*
* @return array associative of with capabilities
*/
public function getCapabilities()
{
return array(
'automatic_cleaning' => true,
'tags' => true,
'expired_read' => true,
'priority' => false,
'infinite_lifetime' => true,
'get_list' => true
);
}
/**
* Saves data to a the MongoDB collection.
*
* @param integer $id
* @param array $data
* @param integer $lifetime
* @param mixed $tags
* @return boolean
*/
private function _set($id, $data, $lifetime, $tags)
{
list ($nowMicroseconds, $nowSeconds) = explode(' ', microtime());
$nowMicroseconds = intval($nowMicroseconds * 1000000); // convert from 'expressed in seconds' to complete microseconds
$this->_ensureIndexes();
return $this->_collection->save(
array(
'_id' => $id,
'd' => $data,
'created_at' => new \MongoDate($nowSeconds, $nowMicroseconds),
'expires_at' => is_numeric($lifetime) && intval($lifetime) !== 0 ? new \MongoDate($nowSeconds + $lifetime, $nowMicroseconds) : null,
't' => $tags,
'hits' => 0
)
);
}
/**
* Lookups a specific cache entry.
*
* Optionally, increment the hit counter when loading the cache entry
* (this increases load on the master, so by default it is turned off).
*
* @param integer $id
* @param boolean $incrementHitCounter = false
* @return array|bool
*/
private function _get($id, $incrementHitCounter = false)
{
if ($incrementHitCounter === true){
return $this->_collection->findAndModify(
array('_id' => $id),
array('$inc' => array('hits' => 1))
);
} else {
return $this->_collection->findOne(array('_id' => $id));
}
}
/**
* Calls ensureIndex() on the collection if they were not called yet.
* Typically executed before cache writes only to avoid disturbing
* the master database on much more frequent cache reads.
*
* @return void
*/
private function _ensureIndexes()
{
if (!$this->_indexesEnsured) {
$this->_indexesEnsured = true;
$this->_collection->ensureIndex(array('t' => 1), array('background' => true));
$this->_collection->ensureIndex(
array('expires_at' => 1),
array('background' => true,
'expireAfterSeconds' => 0 // Have entries expire directly (0 seconds) after reaching expiration time
)
);
}
}
}