MDL-36415 usability: Use new up/down and ordering icons
[moodle.git] / cache / classes / loaders.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Cache loaders
19  *
20  * This file is part of Moodle's cache API, affectionately called MUC.
21  * It contains the components that are required in order to use caching.
22  *
23  * @package    core
24  * @category   cache
25  * @copyright  2012 Sam Hemelryk
26  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
27  */
29 defined('MOODLE_INTERNAL') || die();
31 /**
32  * The main cache class.
33  *
34  * This class if the first class that any end developer will interact with.
35  * In order to create an instance of a cache that they can work with they must call one of the static make methods belonging
36  * to this class.
37  *
38  * @package    core
39  * @category   cache
40  * @copyright  2012 Sam Hemelryk
41  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
42  */
43 class cache implements cache_loader {
45     /**
46      * We need a timestamp to use within the cache API.
47      * This stamp needs to be used for all ttl and time based operations to ensure that we don't end up with
48      * timing issues.
49      * @var int
50      */
51     protected static $now;
53     /**
54      * The definition used when loading this cache if there was one.
55      * @var cache_definition
56      */
57     private $definition = false;
59     /**
60      * The cache store that this loader will make use of.
61      * @var cache_store
62      */
63     private $store;
65     /**
66      * The next cache loader in the chain if there is one.
67      * If a cache request misses for the store belonging to this loader then the loader
68      * stored here will be checked next.
69      * If there is a loader here then $datasource must be false.
70      * @var cache_loader|false
71      */
72     private $loader = false;
74     /**
75      * The data source to use if we need to load data (because if doesn't exist in the cache store).
76      * If there is a data source here then $loader above must be false.
77      * @var cache_data_source|false
78      */
79     private $datasource = false;
81     /**
82      * Used to quickly check if the store supports key awareness.
83      * This is set when the cache is initialised and is used to speed up processing.
84      * @var bool
85      */
86     private $supportskeyawareness = null;
88     /**
89      * Used to quickly check if the store supports ttl natively.
90      * This is set when the cache is initialised and is used to speed up processing.
91      * @var bool
92      */
93     private $supportsnativettl = null;
95     /**
96      * Gets set to true if the cache is going to be using the build in static "persist" cache.
97      * The persist cache statically caches items used during the lifetime of the request. This greatly speeds up interaction
98      * with the cache in areas where it will be repetitively hit for the same information such as with strings.
99      * There are several other variables to control how this persist cache works.
100      * @var bool
101      */
102     private $persist = false;
104     /**
105      * The persist cache itself.
106      * Items will be stored in this cache as they were provided. This ensure there is no unnecessary processing taking place.
107      * @var array
108      */
109     private $persistcache = array();
111     /**
112      * The number of items in the persist cache. Avoids count calls like you wouldn't believe.
113      * @var int
114      */
115     private $persistcount = 0;
117     /**
118      * An array containing just the keys being used in the persist cache.
119      * This seems redundant perhaps but is used when managing the size of the persist cache.
120      * @var array
121      */
122     private $persistkeys = array();
124     /**
125      * The maximum size of the persist cache. If set to false there is no max size.
126      * Caches that make use of the persist cache should seriously consider setting this to something reasonably small, but
127      * still large enough to offset repetitive calls.
128      * @var int|false
129      */
130     private $persistmaxsize = false;
132     /**
133      * Gets set to true during initialisation if the definition is making use of a ttl.
134      * Used to speed up processing.
135      * @var bool
136      */
137     private $hasattl = false;
139     /**
140      * Gets set to the class name of the store during initialisation. This is used several times in the cache class internally
141      * and having it here helps speed up processing.
142      * @var strubg
143      */
144     private $storetype = 'unknown';
146     /**
147      * Gets set to true if we want to collect performance information about the cache API.
148      * @var bool
149      */
150     protected $perfdebug = false;
152     /**
153      * Determines if this loader is a sub loader, not the top of the chain.
154      * @var bool
155      */
156     protected $subloader = false;
158     /**
159      * Creates a new cache instance for a pre-defined definition.
160      *
161      * @param string $component The component for the definition
162      * @param string $area The area for the definition
163      * @param array $identifiers Any additional identifiers that should be provided to the definition.
164      * @param string $aggregate Super advanced feature. More docs later.
165      * @return cache_application|cache_session|cache_store
166      */
167     public static function make($component, $area, array $identifiers = array(), $aggregate = null) {
168         $factory = cache_factory::instance();
169         return $factory->create_cache_from_definition($component, $area, $identifiers, $aggregate);
170     }
172     /**
173      * Creates a new cache instance based upon the given params.
174      *
175      * @param int $mode One of cache_store::MODE_*
176      * @param string $component The component this cache relates to.
177      * @param string $area The area this cache relates to.
178      * @param array $identifiers Any additional identifiers that should be provided to the definition.
179      * @param bool $persistent If set to true the cache will persist construction requests.
180      * @return cache_application|cache_session|cache_store
181      */
182     public static function make_from_params($mode, $component, $area, array $identifiers = array(), $persistent = false) {
183         $factory = cache_factory::instance();
184         return $factory->create_cache_from_params($mode, $component, $area, $identifiers, $persistent);
185     }
187     /**
188      * Constructs a new cache instance.
189      *
190      * You should not call this method from your code, instead you should use the cache::make methods.
191      *
192      * This method is public so that the cache_factory is able to instantiate cache instances.
193      * Ideally we would make this method protected and expose its construction to the factory method internally somehow.
194      * The factory class is responsible for this in order to centralise the storage of instances once created. This way if needed
195      * we can force a reset of the cache API (used during unit testing).
196      *
197      * @param cache_definition $definition The definition for the cache instance.
198      * @param cache_store $store The store that cache should use.
199      * @param cache_loader|cache_data_source $loader The next loader in the chain or the data source if there is one and there
200      *      are no other cache_loaders in the chain.
201      */
202     public function __construct(cache_definition $definition, cache_store $store, $loader = null) {
203         global $CFG;
204         $this->definition = $definition;
205         $this->store = $store;
206         $this->storetype = get_class($store);
207         $this->perfdebug = !empty($CFG->perfdebug);
208         if ($loader instanceof cache_loader) {
209             $this->loader = $loader;
210             // Mark the loader as a sub (chained) loader.
211             $this->loader->set_is_sub_loader(true);
212         } else if ($loader instanceof cache_data_source) {
213             $this->datasource = $loader;
214         }
215         $this->definition->generate_definition_hash();
216         $this->persist = $this->definition->should_be_persistent();
217         if ($this->persist) {
218             $this->persistmaxsize = $this->definition->get_persistent_max_size();
219         }
220         $this->hasattl = ($this->definition->get_ttl() > 0);
221     }
223     /**
224      * Used to inform the loader of its state as a sub loader, or as the top of the chain.
225      *
226      * This is important as it ensures that we do not have more than one loader keeping persistent data.
227      * Subloaders need to be "pure" loaders in the sense that they are used to store and retrieve information from stores or the
228      * next loader/data source in the chain.
229      * Nothing fancy, nothing flash.
230      *
231      * @param bool $setting
232      */
233     protected function set_is_sub_loader($setting = true) {
234         if ($setting) {
235             $this->subloader = true;
236             // Subloaders should not keep persistent data.
237             $this->persist = false;
238             $this->persistmaxsize = false;
239         } else {
240             $this->subloader = true;
241             $this->persist = $this->definition->should_be_persistent();
242             if ($this->persist) {
243                 $this->persistmaxsize = $this->definition->get_persistent_max_size();
244             }
245         }
246     }
248     /**
249      * Alters the identifiers that have been provided to the definition.
250      *
251      * This is an advanced method and should not be used unless really needed.
252      * It allows the developer to slightly alter the definition without having to re-establish the cache.
253      * It will cause more processing as the definition will need to clear and reprepare some of its properties.
254      *
255      * @param array $identifiers
256      */
257     public function set_identifiers(array $identifiers) {
258         $this->definition->set_identifiers($identifiers);
259     }
261     /**
262      * Retrieves the value for the given key from the cache.
263      *
264      * @param string|int $key The key for the data being requested.
265      *      It can be any structure although using a scalar string or int is recommended in the interests of performance.
266      *      In advanced cases an array may be useful such as in situations requiring the multi-key functionality.
267      * @param int $strictness One of IGNORE_MISSING | MUST_EXIST
268      * @return mixed|false The data from the cache or false if the key did not exist within the cache.
269      * @throws moodle_exception
270      */
271     public function get($key, $strictness = IGNORE_MISSING) {
272         // 1. Parse the key.
273         $parsedkey = $this->parse_key($key);
274         // 2. Get it from the persist cache if we can (only when persist is enabled and it has already been requested/set).
275         $result = $this->get_from_persist_cache($parsedkey);
276         if ($result !== false) {
277             if ($this->perfdebug) {
278                 cache_helper::record_cache_hit('** static persist **', $this->definition->get_id());
279             }
280             if (!is_scalar($result)) {
281                 // If data is an object it will be a reference.
282                 // If data is an array if may contain references.
283                 // We want to break references so that the cache cannot be modified outside of itself.
284                 // Call the function to unreference it (in the best way possible).
285                 $result = $this->unref($result);
286             }
287             return $result;
288         } else if ($this->perfdebug) {
289             cache_helper::record_cache_miss('** static persist **', $this->definition->get_id());
290         }
291         // 3. Get it from the store. Obviously wasn't in the persist cache.
292         $result = $this->store->get($parsedkey);
293         if ($result !== false) {
294             if ($result instanceof cache_ttl_wrapper) {
295                 if ($result->has_expired()) {
296                     $this->store->delete($parsedkey);
297                     $result = false;
298                 } else {
299                     $result = $result->data;
300                 }
301             }
302             if ($result instanceof cache_cached_object) {
303                 $result = $result->restore_object();
304             }
305             if ($this->is_using_persist_cache()) {
306                 $this->set_in_persist_cache($parsedkey, $result);
307             }
308         }
309         // 4. Load if from the loader/datasource if we don't already have it.
310         $setaftervalidation = false;
311         if ($result === false) {
312             if ($this->perfdebug) {
313                 cache_helper::record_cache_miss($this->storetype, $this->definition->get_id());
314             }
315             if ($this->loader !== false) {
316                 $result = $this->loader->get($parsedkey);
317             } else if ($this->datasource !== false) {
318                 $result = $this->datasource->load_for_cache($key);
319             }
320             $setaftervalidation = ($result !== false);
321         } else if ($this->perfdebug) {
322             cache_helper::record_cache_hit($this->storetype, $this->definition->get_id());
323         }
324         // 5. Validate strictness.
325         if ($strictness === MUST_EXIST && $result === false) {
326             throw new moodle_exception('Requested key did not exist in any cache stores and could not be loaded.');
327         }
328         // 6. Set it to the store if we got it from the loader/datasource.
329         if ($setaftervalidation) {
330             $this->set($key, $result);
331         }
332         // 7. Make sure we don't pass back anything that could be a reference.
333         //    We don't want people modifying the data in the cache.
334         if (!is_scalar($result)) {
335             // If data is an object it will be a reference.
336             // If data is an array if may contain references.
337             // We want to break references so that the cache cannot be modified outside of itself.
338             // Call the function to unreference it (in the best way possible).
339             $result = $this->unref($result);
340         }
341         return $result;
342     }
344     /**
345      * Retrieves an array of values for an array of keys.
346      *
347      * Using this function comes with potential performance implications.
348      * Not all cache stores will support get_many/set_many operations and in order to replicate this functionality will call
349      * the equivalent singular method for each item provided.
350      * This should not deter you from using this function as there is a performance benefit in situations where the cache store
351      * does support it, but you should be aware of this fact.
352      *
353      * @param array $keys The keys of the data being requested.
354      *      Each key can be any structure although using a scalar string or int is recommended in the interests of performance.
355      *      In advanced cases an array may be useful such as in situations requiring the multi-key functionality.
356      * @param int $strictness One of IGNORE_MISSING or MUST_EXIST.
357      * @return array An array of key value pairs for the items that could be retrieved from the cache.
358      *      If MUST_EXIST was used and not all keys existed within the cache then an exception will be thrown.
359      *      Otherwise any key that did not exist will have a data value of false within the results.
360      * @throws moodle_exception
361      */
362     public function get_many(array $keys, $strictness = IGNORE_MISSING) {
364         $parsedkeys = array();
365         $resultpersist = array();
366         $resultstore = array();
367         $keystofind = array();
369         // First up check the persist cache for each key.
370         $isusingpersist = $this->is_using_persist_cache();
371         foreach ($keys as $key) {
372             $pkey = $this->parse_key($key);
373             $parsedkeys[$pkey] = $key;
374             $keystofind[$pkey] = $key;
375             if ($isusingpersist) {
376                 $value = $this->get_from_persist_cache($pkey);
377                 if ($value !== false) {
378                     $resultpersist[$pkey] = $value;
379                     unset($keystofind[$pkey]);
380                 }
381             }
382         }
384         // Next assuming we didn't find all of the keys in the persist cache try loading them from the store.
385         if (count($keystofind)) {
386             $resultstore = $this->store->get_many(array_keys($keystofind));
387             // Process each item in the result to "unwrap" it.
388             foreach ($resultstore as $key => $value) {
389                 if ($value instanceof cache_ttl_wrapper) {
390                     if ($value->has_expired()) {
391                         $value = false;
392                     } else {
393                         $value = $value->data;
394                     }
395                 }
396                 if ($value instanceof cache_cached_object) {
397                     $value = $value->restore_object();
398                 }
399                 $resultstore[$key] = $value;
400             }
401         }
403         // Merge the result from the persis cache with the results from the store load.
404         $result = $resultpersist + $resultstore;
405         unset($resultpersist);
406         unset($resultstore);
408         // Next we need to find any missing values and load them from the loader/datasource next in the chain.
409         $usingloader = ($this->loader !== false);
410         $usingsource = (!$usingloader && ($this->datasource !== false));
411         if ($usingloader || $usingsource) {
412             $missingkeys = array();
413             foreach ($result as $key => $value) {
414                 if ($value === false) {
415                     $missingkeys[] = ($usingloader) ? $key : $parsedkeys[$key];
416                 }
417             }
418             if (!empty($missingkeys)) {
419                 if ($usingloader) {
420                     $resultmissing = $this->loader->get_many($missingkeys);
421                 } else {
422                     $resultmissing = $this->datasource->load_many_for_cache($missingkeys);
423                 }
424                 foreach ($resultmissing as $key => $value) {
425                     $result[$key] = $value;
426                     if ($value !== false) {
427                         $this->set($parsedkeys[$key], $value);
428                     }
429                 }
430                 unset($resultmissing);
431             }
432             unset($missingkeys);
433         }
435         // Create an array with the original keys and the found values. This will be what we return.
436         $fullresult = array();
437         foreach ($result as $key => $value) {
438             $fullresult[$parsedkeys[$key]] = $value;
439         }
440         unset($result);
442         // Final step is to check strictness.
443         if ($strictness === MUST_EXIST) {
444             foreach ($keys as $key) {
445                 if (!array_key_exists($key, $fullresult)) {
446                     throw new moodle_exception('Not all the requested keys existed within the cache stores.');
447                 }
448             }
449         }
451         // Return the result. Phew!
452         return $fullresult;
453     }
455     /**
456      * Sends a key => value pair to the cache.
457      *
458      * <code>
459      * // This code will add four entries to the cache, one for each url.
460      * $cache->set('main', 'http://moodle.org');
461      * $cache->set('docs', 'http://docs.moodle.org');
462      * $cache->set('tracker', 'http://tracker.moodle.org');
463      * $cache->set('qa', 'http://qa.moodle.net');
464      * </code>
465      *
466      * @param string|int $key The key for the data being requested.
467      *      It can be any structure although using a scalar string or int is recommended in the interests of performance.
468      *      In advanced cases an array may be useful such as in situations requiring the multi-key functionality.
469      * @param mixed $data The data to set against the key.
470      * @return bool True on success, false otherwise.
471      */
472     public function set($key, $data) {
473         if ($this->perfdebug) {
474             cache_helper::record_cache_set($this->storetype, $this->definition->get_id());
475         }
476         if (is_object($data) && $data instanceof cacheable_object) {
477             $data = new cache_cached_object($data);
478         } else if (!is_scalar($data)) {
479             // If data is an object it will be a reference.
480             // If data is an array if may contain references.
481             // We want to break references so that the cache cannot be modified outside of itself.
482             // Call the function to unreference it (in the best way possible).
483             $data = $this->unref($data);
484         }
485         if ($this->has_a_ttl() && !$this->store_supports_native_ttl()) {
486             $data = new cache_ttl_wrapper($data, $this->definition->get_ttl());
487         }
488         $parsedkey = $this->parse_key($key);
489         if ($this->is_using_persist_cache()) {
490             $this->set_in_persist_cache($parsedkey, $data);
491         }
492         return $this->store->set($parsedkey, $data);
493     }
495     /**
496      * Removes references where required.
497      *
498      * @param stdClass|array $data
499      */
500     protected function unref($data) {
501         if ($this->definition->uses_simple_data()) {
502             return $data;
503         }
504         // Check if it requires serialisation in order to produce a reference free copy.
505         if ($this->requires_serialisation($data)) {
506             // Damn, its going to have to be serialise.
507             $data = serialize($data);
508             // We unserialise immediately so that we don't have to do it every time on get.
509             $data = unserialize($data);
510         } else if (!is_scalar($data)) {
511             // Its safe to clone, lets do it, its going to beat the pants of serialisation.
512             $data = $this->deep_clone($data);
513         }
514         return $data;
515     }
517     /**
518      * Checks to see if a var requires serialisation.
519      *
520      * @param mixed $value The value to check.
521      * @param int $depth Used to ensure we don't enter an endless loop (think recursion).
522      * @return bool Returns true if the value is going to require serialisation in order to ensure a reference free copy
523      *      or false if its safe to clone.
524      */
525     protected function requires_serialisation($value, $depth = 1) {
526         if (is_scalar($value)) {
527             return false;
528         } else if (is_array($value) || $value instanceof stdClass || $value instanceof Traversable) {
529             if ($depth > 5) {
530                 // Skrew it, mega-deep object, developer you suck, we're just going to serialise.
531                 return true;
532             }
533             foreach ($value as $key => $subvalue) {
534                 if ($this->requires_serialisation($subvalue, $depth++)) {
535                     return true;
536                 }
537             }
538         }
539         // Its not scalar, array, or stdClass so we'll need to serialise.
540         return true;
541     }
543     /**
544      * Creates a reference free clone of the given value.
545      *
546      * @param mixed $value
547      * @return mixed
548      */
549     protected function deep_clone($value) {
550         if (is_object($value)) {
551             // Objects must be cloned to begin with.
552             $value = clone $value;
553         }
554         if (is_array($value) || is_object($value)) {
555             foreach ($value as $key => $subvalue) {
556                 $value[$key] = $this->deep_clone($subvalue);
557             }
558         }
559         return $value;
560     }
562     /**
563      * Sends several key => value pairs to the cache.
564      *
565      * Using this function comes with potential performance implications.
566      * Not all cache stores will support get_many/set_many operations and in order to replicate this functionality will call
567      * the equivalent singular method for each item provided.
568      * This should not deter you from using this function as there is a performance benefit in situations where the cache store
569      * does support it, but you should be aware of this fact.
570      *
571      * <code>
572      * // This code will add four entries to the cache, one for each url.
573      * $cache->set_many(array(
574      *     'main' => 'http://moodle.org',
575      *     'docs' => 'http://docs.moodle.org',
576      *     'tracker' => 'http://tracker.moodle.org',
577      *     'qa' => ''http://qa.moodle.net'
578      * ));
579      * </code>
580      *
581      * @param array $keyvaluearray An array of key => value pairs to send to the cache.
582      * @return int The number of items successfully set. It is up to the developer to check this matches the number of items.
583      *      ... if they care that is.
584      */
585     public function set_many(array $keyvaluearray) {
586         $data = array();
587         $simulatettl = $this->has_a_ttl() && !$this->store_supports_native_ttl();
588         $usepersistcache = $this->is_using_persist_cache();
589         foreach ($keyvaluearray as $key => $value) {
590             if (is_object($value) && $value instanceof cacheable_object) {
591                 $value = new cache_cached_object($value);
592             } else if (!is_scalar($value)) {
593                 // If data is an object it will be a reference.
594                 // If data is an array if may contain references.
595                 // We want to break references so that the cache cannot be modified outside of itself.
596                 // Call the function to unreference it (in the best way possible).
597                 $value = $this->unref($value);
598             }
599             if ($simulatettl) {
600                 $value = new cache_ttl_wrapper($value, $this->definition->get_ttl());
601             }
602             $data[$key] = array(
603                 'key' => $this->parse_key($key),
604                 'value' => $value
605             );
606             if ($usepersistcache) {
607                 $this->set_in_persist_cache($data[$key]['key'], $value);
608             }
609         }
610         if ($this->perfdebug) {
611             cache_helper::record_cache_set($this->storetype, $this->definition->get_id());
612         }
613         return $this->store->set_many($data);
614     }
616     /**
617      * Test is a cache has a key.
618      *
619      * The use of the has methods is strongly discouraged. In a high load environment the cache may well change between the
620      * test and any subsequent action (get, set, delete etc).
621      * Instead it is recommended to write your code in such a way they it performs the following steps:
622      * <ol>
623      * <li>Attempt to retrieve the information.</li>
624      * <li>Generate the information.</li>
625      * <li>Attempt to set the information</li>
626      * </ol>
627      *
628      * Its also worth mentioning that not all stores support key tests.
629      * For stores that don't support key tests this functionality is mimicked by using the equivalent get method.
630      * Just one more reason you should not use these methods unless you have a very good reason to do so.
631      *
632      * @param string|int $key
633      * @param bool $tryloadifpossible If set to true, the cache doesn't contain the key, and there is another cache loader or
634      *      data source then the code will try load the key value from the next item in the chain.
635      * @return bool True if the cache has the requested key, false otherwise.
636      */
637     public function has($key, $tryloadifpossible = false) {
638         $parsedkey = $this->parse_key($key);
639         if ($this->is_in_persist_cache($parsedkey)) {
640             return true;
641         }
642         if (($this->has_a_ttl() && !$this->store_supports_native_ttl()) || !$this->store_supports_key_awareness()) {
643             if ($this->store_supports_key_awareness() && !$this->store->has($parsedkey)) {
644                 return false;
645             }
646             $data = $this->store->get($parsedkey);
647             if (!$this->store_supports_native_ttl()) {
648                 $has = ($data instanceof cache_ttl_wrapper && !$data->has_expired());
649             } else {
650                 $has = ($data !== false);
651             }
652         } else {
653             $has = $this->store->has($parsedkey);
654         }
655         if (!$has && $tryloadifpossible) {
656             if ($this->loader !== false) {
657                 $result = $this->loader->get($parsedkey);
658             } else if ($this->datasource !== null) {
659                 $result = $this->datasource->load_for_cache($key);
660             }
661             $has = ($result !== null);
662             if ($has) {
663                 $this->set($key, $result);
664             }
665         }
666         return $has;
667     }
669     /**
670      * Test is a cache has all of the given keys.
671      *
672      * It is strongly recommended to avoid the use of this function if not absolutely required.
673      * In a high load environment the cache may well change between the test and any subsequent action (get, set, delete etc).
674      *
675      * Its also worth mentioning that not all stores support key tests.
676      * For stores that don't support key tests this functionality is mimicked by using the equivalent get method.
677      * Just one more reason you should not use these methods unless you have a very good reason to do so.
678      *
679      * @param array $keys
680      * @return bool True if the cache has all of the given keys, false otherwise.
681      */
682     public function has_all(array $keys) {
683         if (($this->has_a_ttl() && !$this->store_supports_native_ttl()) || !$this->store_supports_key_awareness()) {
684             foreach ($keys as $key) {
685                 if (!$this->has($key)) {
686                     return false;
687                 }
688             }
689             return true;
690         }
691         $parsedkeys = array_map(array($this, 'parse_key'), $keys);
692         return $this->store->has_all($parsedkeys);
693     }
695     /**
696      * Test if a cache has at least one of the given keys.
697      *
698      * It is strongly recommended to avoid the use of this function if not absolutely required.
699      * In a high load environment the cache may well change between the test and any subsequent action (get, set, delete etc).
700      *
701      * Its also worth mentioning that not all stores support key tests.
702      * For stores that don't support key tests this functionality is mimicked by using the equivalent get method.
703      * Just one more reason you should not use these methods unless you have a very good reason to do so.
704      *
705      * @param array $keys
706      * @return bool True if the cache has at least one of the given keys
707      */
708     public function has_any(array $keys) {
709         if (($this->has_a_ttl() && !$this->store_supports_native_ttl()) || !$this->store_supports_key_awareness()) {
710             foreach ($keys as $key) {
711                 if ($this->has($key)) {
712                     return true;
713                 }
714             }
715             return false;
716         }
718         if ($this->is_using_persist_cache()) {
719             $parsedkeys = array();
720             foreach ($keys as $id => $key) {
721                 $parsedkey = $this->parse_key($key);
722                 if ($this->is_in_persist_cache($parsedkey)) {
723                     return true;
724                 }
725                 $parsedkeys[] = $parsedkey;
726             }
727         } else {
728             $parsedkeys = array_map(array($this, 'parse_key'), $keys);
729         }
730         return $this->store->has_any($parsedkeys);
731     }
733     /**
734      * Delete the given key from the cache.
735      *
736      * @param string|int $key The key to delete.
737      * @param bool $recurse When set to true the key will also be deleted from all stacked cache loaders and their stores.
738      *     This happens by default and ensure that all the caches are consistent. It is NOT recommended to change this.
739      * @return bool True of success, false otherwise.
740      */
741     public function delete($key, $recurse = true) {
742         $parsedkey = $this->parse_key($key);
743         $this->delete_from_persist_cache($parsedkey);
744         if ($recurse && !empty($this->loader)) {
745             // Delete from the bottom of the stack first.
746             $this->loader->delete($key, $recurse);
747         }
748         return $this->store->delete($parsedkey);
749     }
751     /**
752      * Delete all of the given keys from the cache.
753      *
754      * @param array $keys The key to delete.
755      * @param bool $recurse When set to true the key will also be deleted from all stacked cache loaders and their stores.
756      *     This happens by default and ensure that all the caches are consistent. It is NOT recommended to change this.
757      * @return int The number of items successfully deleted.
758      */
759     public function delete_many(array $keys, $recurse = true) {
760         $parsedkeys = array_map(array($this, 'parse_key'), $keys);
761         if ($this->is_using_persist_cache()) {
762             foreach ($parsedkeys as $parsedkey) {
763                 $this->delete_from_persist_cache($parsedkey);
764             }
765         }
766         if ($recurse && !empty($this->loader)) {
767             // Delete from the bottom of the stack first.
768             $this->loader->delete_many($keys, $recurse);
769         }
770         return $this->store->delete_many($parsedkeys);
771     }
773     /**
774      * Purges the cache store, and loader if there is one.
775      *
776      * @return bool True on success, false otherwise
777      */
778     public function purge() {
779         // 1. Purge the persist cache.
780         $this->persistcache = array();
781         // 2. Purge the store.
782         $this->store->purge();
783         // 3. Optionally pruge any stacked loaders.
784         if ($this->loader) {
785             $this->loader->purge();
786         }
787         return true;
788     }
790     /**
791      * Parses the key turning it into a string (or array is required) suitable to be passed to the cache store.
792      *
793      * @param string|int $key As passed to get|set|delete etc.
794      * @return string|array String unless the store supports multi-identifiers in which case an array if returned.
795      */
796     protected function parse_key($key) {
797         // First up if the store supports multiple keys we'll go with that.
798         if ($this->store->supports_multiple_identifiers()) {
799             $result = $this->definition->generate_multi_key_parts();
800             $result['key'] = $key;
801             return $result;
802         }
803         // If not we need to generate a hash and to for that we use the cache_helper.
804         return cache_helper::hash_key($key, $this->definition);
805     }
807     /**
808      * Returns true if the cache is making use of a ttl.
809      * @return bool
810      */
811     protected function has_a_ttl() {
812         return $this->hasattl;
813     }
815     /**
816      * Returns true if the cache store supports native ttl.
817      * @return bool
818      */
819     protected function store_supports_native_ttl() {
820         if ($this->supportsnativettl === null) {
821             $this->supportsnativettl = ($this->store->supports_native_ttl());
822         }
823         return $this->supportsnativettl;
824     }
826     /**
827      * Returns the cache definition.
828      *
829      * @return cache_definition
830      */
831     protected function get_definition() {
832         return $this->definition;
833     }
835     /**
836      * Returns the cache store
837      *
838      * @return cache_store
839      */
840     protected function get_store() {
841         return $this->store;
842     }
844     /**
845      * Returns true if the store supports key awareness.
846      *
847      * @return bool
848      */
849     protected function store_supports_key_awareness() {
850         if ($this->supportskeyawareness === null) {
851             $this->supportskeyawareness = ($this->store instanceof cache_is_key_aware);
852         }
853         return $this->supportskeyawareness;
854     }
856     /**
857      * Returns true if the store natively supports locking.
858      *
859      * @return bool
860      */
861     protected function store_supports_native_locking() {
862         if ($this->nativelocking === null) {
863             $this->nativelocking = ($this->store instanceof cache_is_lockable);
864         }
865         return $this->nativelocking;
866     }
868     /**
869      * Returns true if this cache is making use of the persist cache.
870      *
871      * @return bool
872      */
873     protected function is_using_persist_cache() {
874         return $this->persist;
875     }
877     /**
878      * Returns true if the requested key exists within the persist cache.
879      *
880      * @param string $key The parsed key
881      * @return bool
882      */
883     protected function is_in_persist_cache($key) {
884         if (is_array($key)) {
885             $key = $key['key'];
886         }
887         // This could be written as a single line, however it has been split because the ttl check is faster than the instanceof
888         // and has_expired calls.
889         if (!$this->persist || !array_key_exists($key, $this->persistcache)) {
890             return false;
891         }
892         if ($this->has_a_ttl() && $this->store_supports_native_ttl()) {
893              return !($this->persistcache[$key] instanceof cache_ttl_wrapper && $this->persistcache[$key]->has_expired());
894         }
895         return true;
896     }
898     /**
899      * Returns the item from the persist cache if it exists there.
900      *
901      * @param string $key The parsed key
902      * @return mixed|false The data from the persist cache or false if it wasn't there.
903      */
904     protected function get_from_persist_cache($key) {
905         if (is_array($key)) {
906             $key = $key['key'];
907         }
908         if (!$this->persist || !array_key_exists($key, $this->persistcache)) {
909             return false;
910         }
911         $data = $this->persistcache[$key];
912         if (!$this->has_a_ttl() || !$data instanceof cache_ttl_wrapper) {
913             if ($data instanceof cache_cached_object) {
914                 $data = $data->restore_object();
915             }
916             return $data;
917         }
918         if ($data->has_expired()) {
919             $this->delete_from_persist_cache($key);
920             return false;
921         } else {
922             if ($data instanceof cache_cached_object) {
923                 $data = $data->restore_object();
924             }
925             return $data->data;
926         }
927     }
929     /**
930      * Sets a key value pair into the persist cache.
931      *
932      * @param string $key The parsed key
933      * @param mixed $data
934      * @return bool
935      */
936     protected function set_in_persist_cache($key, $data) {
937         if (is_array($key)) {
938             $key = $key['key'];
939         }
940         $this->persistcache[$key] = $data;
941         if ($this->persistmaxsize !== false) {
942             $this->persistcount++;
943             if ($this->persistcount > $this->persistmaxsize) {
944                 $dropkey = array_shift($this->persistkeys);
945                 unset($this->persistcache[$dropkey]);
946                 $this->persistcount--;
947             }
948         }
949         return true;
950     }
952     /**
953      * Deletes an item from the persist cache.
954      *
955      * @param string|int $key As given to get|set|delete
956      * @return bool True on success, false otherwise.
957      */
958     protected function delete_from_persist_cache($key) {
959         unset($this->persistcache[$key]);
960         if ($this->persistmaxsize !== false) {
961             $dropkey = array_search($key, $this->persistkeys);
962             if ($dropkey) {
963                 unset($this->persistkeys[$dropkey]);
964                 $this->persistcount--;
965             }
966         }
967         return true;
968     }
970     /**
971      * Returns the timestamp from the first request for the time from the cache API.
972      *
973      * This stamp needs to be used for all ttl and time based operations to ensure that we don't end up with
974      * timing issues.
975      *
976      * @return int
977      */
978     public static function now() {
979         if (self::$now === null) {
980             self::$now = time();
981         }
982         return self::$now;
983     }
986 /**
987  * An application cache.
988  *
989  * This class is used for application caches returned by the cache::make methods.
990  * On top of the standard functionality it also allows locking to be required and or manually operated.
991  *
992  * This cache class should never be interacted with directly. Instead you should always use the cache::make methods.
993  * It is technically possible to call those methods through this class however there is no guarantee that you will get an
994  * instance of this class back again.
995  *
996  * @internal don't use me directly.
997  *
998  * @package    core
999  * @category   cache
1000  * @copyright  2012 Sam Hemelryk
1001  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1002  */
1003 class cache_application extends cache implements cache_loader_with_locking {
1005     /**
1006      * Lock identifier.
1007      * This is used to ensure the lock belongs to the cache instance + definition + user.
1008      * @var string
1009      */
1010     protected $lockidentifier;
1012     /**
1013      * Gets set to true if the cache's primary store natively supports locking.
1014      * If it does then we use that, otherwise we need to instantiate a second store to use for locking.
1015      * @var cache_store
1016      */
1017     protected $nativelocking = null;
1019     /**
1020      * Gets set to true if the cache is going to be using locking.
1021      * This isn't a requirement, it doesn't need to use locking (most won't) and this bool is used to quickly check things.
1022      * If required then locking will be forced for the get|set|delete operation.
1023      * @var bool
1024      */
1025     protected $requirelocking = false;
1027     /**
1028      * Gets set to true if the cache must use read locking (get|has).
1029      * @var bool
1030      */
1031     protected $requirelockingread = false;
1033     /**
1034      * Gets set to true if the cache must use write locking (set|delete)
1035      * @var bool
1036      */
1037     protected $requirelockingwrite = false;
1039     /**
1040      * Gets set to a cache_store to use for locking if the caches primary store doesn't support locking natively.
1041      * @var cache_lock_interface
1042      */
1043     protected $cachelockinstance;
1045     /**
1046      * Overrides the cache construct method.
1047      *
1048      * You should not call this method from your code, instead you should use the cache::make methods.
1049      *
1050      * @param cache_definition $definition
1051      * @param cache_store $store
1052      * @param cache_loader|cache_data_source $loader
1053      */
1054     public function __construct(cache_definition $definition, cache_store $store, $loader = null) {
1055         parent::__construct($definition, $store, $loader);
1056         $this->nativelocking = $this->store_supports_native_locking();
1057         if ($definition->require_locking()) {
1058             $this->requirelocking = true;
1059             $this->requirelockingread = $definition->require_locking_read();
1060             $this->requirelockingwrite = $definition->require_locking_write();
1061         }
1063         if ($definition->has_invalidation_events()) {
1064             $lastinvalidation = $this->get('lastinvalidation');
1065             if ($lastinvalidation === false) {
1066                 // This is a new session, there won't be anything to invalidate. Set the time of the last invalidation and
1067                 // move on.
1068                 $this->set('lastinvalidation', cache::now());
1069                 return;
1070             } else if ($lastinvalidation == cache::now()) {
1071                 // We've already invalidated during this request.
1072                 return;
1073             }
1075             // Get the event invalidation cache.
1076             $cache = cache::make('core', 'eventinvalidation');
1077             $events = $cache->get_many($definition->get_invalidation_events());
1078             $todelete = array();
1079             // Iterate the returned data for the events.
1080             foreach ($events as $event => $keys) {
1081                 // Look at each key and check the timestamp.
1082                 foreach ($keys as $key => $timestamp) {
1083                     // If the timestamp of the event is more than or equal to the last invalidation (happened between the last
1084                     // invalidation and now)then we need to invaliate the key.
1085                     if ($timestamp >= $lastinvalidation) {
1086                         $todelete[] = $key;
1087                     }
1088                 }
1089             }
1090             if (!empty($todelete)) {
1091                 $todelete = array_unique($todelete);
1092                 $this->delete_many($todelete);
1093             }
1094             // Set the time of the last invalidation.
1095             $this->set('lastinvalidation', cache::now());
1096         }
1097     }
1099     /**
1100      * Returns the identifier to use
1101      *
1102      * @staticvar int $instances Counts the number of instances. Used as part of the lock identifier.
1103      * @return string
1104      */
1105     public function get_identifier() {
1106         static $instances = 0;
1107         if ($this->lockidentifier === null) {
1108             $this->lockidentifier = md5(
1109                 $this->get_definition()->generate_definition_hash() .
1110                 sesskey() .
1111                 $instances++ .
1112                 'cache_application'
1113             );
1114         }
1115         return $this->lockidentifier;
1116     }
1118     /**
1119      * Fixes the instance up after a clone.
1120      */
1121     public function __clone() {
1122         // Force a new idenfitier.
1123         $this->lockidentifier = null;
1124     }
1126     /**
1127      * Acquires a lock on the given key.
1128      *
1129      * This is done automatically if the definition requires it.
1130      * It is recommended to use a definition if you want to have locking although it is possible to do locking without having
1131      * it required by the definition.
1132      * The problem with such an approach is that you cannot ensure that code will consistently use locking. You will need to
1133      * rely on the integrators review skills.
1134      *
1135      * @param string|int $key The key as given to get|set|delete
1136      * @return bool Returns true if the lock could be acquired, false otherwise.
1137      */
1138     public function acquire_lock($key) {
1139         $key = $this->parse_key($key);
1140         if ($this->nativelocking) {
1141             return $this->get_store()->acquire_lock($key, $this->get_identifier());
1142         } else {
1143             $this->ensure_cachelock_available();
1144             return $this->cachelockinstance->lock($key, $this->get_identifier());
1145         }
1146     }
1148     /**
1149      * Checks if this cache has a lock on the given key.
1150      *
1151      * @param string|int $key The key as given to get|set|delete
1152      * @return bool|null Returns true if there is a lock and this cache has it, null if no one has a lock on that key, false if
1153      *      someone else has the lock.
1154      */
1155     public function check_lock_state($key) {
1156         $key = $this->parse_key($key);
1157         if ($this->nativelocking) {
1158             return $this->get_store()->check_lock_state($key, $this->get_identifier());
1159         } else {
1160             $this->ensure_cachelock_available();
1161             return $this->cachelockinstance->check_state($key, $this->get_identifier());
1162         }
1163     }
1165     /**
1166      * Releases the lock this cache has on the given key
1167      *
1168      * @param string|int $key
1169      * @return bool True if the operation succeeded, false otherwise.
1170      */
1171     public function release_lock($key) {
1172         $key = $this->parse_key($key);
1173         if ($this->nativelocking) {
1174             return $this->get_store()->release_lock($key, $this->get_identifier());
1175         } else {
1176             $this->ensure_cachelock_available();
1177             return $this->cachelockinstance->unlock($key, $this->get_identifier());
1178         }
1179     }
1181     /**
1182      * Ensure that the dedicated lock store is ready to go.
1183      *
1184      * This should only happen if the cache store doesn't natively support it.
1185      */
1186     protected function ensure_cachelock_available() {
1187         if ($this->cachelockinstance === null) {
1188             $this->cachelockinstance = cache_helper::get_cachelock_for_store($this->get_store());
1189         }
1190     }
1192     /**
1193      * Sends a key => value pair to the cache.
1194      *
1195      * <code>
1196      * // This code will add four entries to the cache, one for each url.
1197      * $cache->set('main', 'http://moodle.org');
1198      * $cache->set('docs', 'http://docs.moodle.org');
1199      * $cache->set('tracker', 'http://tracker.moodle.org');
1200      * $cache->set('qa', 'http://qa.moodle.net');
1201      * </code>
1202      *
1203      * @param string|int $key The key for the data being requested.
1204      * @param mixed $data The data to set against the key.
1205      * @return bool True on success, false otherwise.
1206      */
1207     public function set($key, $data) {
1208         if ($this->requirelockingwrite && !$this->acquire_lock($key)) {
1209             return false;
1210         }
1211         $result = parent::set($key, $data);
1212         if ($this->requirelockingwrite && !$this->release_lock($key)) {
1213             debugging('Failed to release cache lock on set operation... this should not happen.', DEBUG_DEVELOPER);
1214         }
1215         return $result;
1216     }
1218     /**
1219      * Sends several key => value pairs to the cache.
1220      *
1221      * Using this function comes with potential performance implications.
1222      * Not all cache stores will support get_many/set_many operations and in order to replicate this functionality will call
1223      * the equivalent singular method for each item provided.
1224      * This should not deter you from using this function as there is a performance benefit in situations where the cache store
1225      * does support it, but you should be aware of this fact.
1226      *
1227      * <code>
1228      * // This code will add four entries to the cache, one for each url.
1229      * $cache->set_many(array(
1230      *     'main' => 'http://moodle.org',
1231      *     'docs' => 'http://docs.moodle.org',
1232      *     'tracker' => 'http://tracker.moodle.org',
1233      *     'qa' => ''http://qa.moodle.net'
1234      * ));
1235      * </code>
1236      *
1237      * @param array $keyvaluearray An array of key => value pairs to send to the cache.
1238      * @return int The number of items successfully set. It is up to the developer to check this matches the number of items.
1239      *      ... if they care that is.
1240      */
1241     public function set_many(array $keyvaluearray) {
1242         if ($this->requirelockingwrite) {
1243             $locks = array();
1244             foreach ($keyvaluearray as $id => $pair) {
1245                 $key = $pair['key'];
1246                 if ($this->acquire_lock($key)) {
1247                     $locks[] = $key;
1248                 } else {
1249                     unset($keyvaluearray[$id]);
1250                 }
1251             }
1252         }
1253         $result = parent::set_many($keyvaluearray);
1254         if ($this->requirelockingwrite) {
1255             foreach ($locks as $key) {
1256                 if ($this->release_lock($key)) {
1257                     debugging('Failed to release cache lock on set_many operation... this should not happen.', DEBUG_DEVELOPER);
1258                 }
1259             }
1260         }
1261         return $result;
1262     }
1264     /**
1265      * Retrieves the value for the given key from the cache.
1266      *
1267      * @param string|int $key The key for the data being requested.
1268      * @param int $strictness One of IGNORE_MISSING | MUST_EXIST
1269      * @return mixed|false The data from the cache or false if the key did not exist within the cache.
1270      * @throws moodle_exception
1271      */
1272     public function get($key, $strictness = IGNORE_MISSING) {
1273         if ($this->requirelockingread && $this->check_lock_state($key) === false) {
1274             // Read locking required and someone else has the read lock.
1275             return false;
1276         }
1277         return parent::get($key, $strictness);
1278     }
1280     /**
1281      * Retrieves an array of values for an array of keys.
1282      *
1283      * Using this function comes with potential performance implications.
1284      * Not all cache stores will support get_many/set_many operations and in order to replicate this functionality will call
1285      * the equivalent singular method for each item provided.
1286      * This should not deter you from using this function as there is a performance benefit in situations where the cache store
1287      * does support it, but you should be aware of this fact.
1288      *
1289      * @param array $keys The keys of the data being requested.
1290      * @param int $strictness One of IGNORE_MISSING or MUST_EXIST.
1291      * @return array An array of key value pairs for the items that could be retrieved from the cache.
1292      *      If MUST_EXIST was used and not all keys existed within the cache then an exception will be thrown.
1293      *      Otherwise any key that did not exist will have a data value of false within the results.
1294      * @throws moodle_exception
1295      */
1296     public function get_many(array $keys, $strictness = IGNORE_MISSING) {
1297         if ($this->requirelockingread) {
1298             foreach ($keys as $id => $key) {
1299                 $lock =$this->acquire_lock($key);
1300                 if (!$lock) {
1301                     if ($strictness === MUST_EXIST) {
1302                         throw new coding_exception('Could not acquire read locks for all of the items being requested.');
1303                     } else {
1304                         // Can't return this as we couldn't get a read lock.
1305                         unset($keys[$id]);
1306                     }
1307                 }
1309             }
1310         }
1311         return parent::get_many($keys, $strictness);
1312     }
1314     /**
1315      * Delete the given key from the cache.
1316      *
1317      * @param string|int $key The key to delete.
1318      * @param bool $recurse When set to true the key will also be deleted from all stacked cache loaders and their stores.
1319      *     This happens by default and ensure that all the caches are consistent. It is NOT recommended to change this.
1320      * @return bool True of success, false otherwise.
1321      */
1322     public function delete($key, $recurse = true) {
1323         if ($this->requirelockingwrite && !$this->acquire_lock($key)) {
1324             return false;
1325         }
1326         $result = parent::delete($key, $recurse);
1327         if ($this->requirelockingwrite && !$this->release_lock($key)) {
1328             debugging('Failed to release cache lock on delete operation... this should not happen.', DEBUG_DEVELOPER);
1329         }
1330         return $result;
1331     }
1333     /**
1334      * Delete all of the given keys from the cache.
1335      *
1336      * @param array $keys The key to delete.
1337      * @param bool $recurse When set to true the key will also be deleted from all stacked cache loaders and their stores.
1338      *     This happens by default and ensure that all the caches are consistent. It is NOT recommended to change this.
1339      * @return int The number of items successfully deleted.
1340      */
1341     public function delete_many(array $keys, $recurse = true) {
1342         if ($this->requirelockingwrite) {
1343             $locks = array();
1344             foreach ($keys as $id => $key) {
1345                 if ($this->acquire_lock($key)) {
1346                     $locks[] = $key;
1347                 } else {
1348                     unset($keys[$id]);
1349                 }
1350             }
1351         }
1352         $result = parent::delete_many($keys, $recurse);
1353         if ($this->requirelockingwrite) {
1354             foreach ($locks as $key) {
1355                 if ($this->release_lock($key)) {
1356                     debugging('Failed to release cache lock on delete_many operation... this should not happen.', DEBUG_DEVELOPER);
1357                 }
1358             }
1359         }
1360         return $result;
1361     }
1364 /**
1365  * A session cache.
1366  *
1367  * This class is used for session caches returned by the cache::make methods.
1368  *
1369  * This cache class should never be interacted with directly. Instead you should always use the cache::make methods.
1370  * It is technically possible to call those methods through this class however there is no guarantee that you will get an
1371  * instance of this class back again.
1372  *
1373  * @todo we should support locking in the session as well. Should be pretty simple to set up.
1374  *
1375  * @internal don't use me directly.
1376  *
1377  * @package    core
1378  * @category   cache
1379  * @copyright  2012 Sam Hemelryk
1380  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1381  */
1382 class cache_session extends cache {
1383     /**
1384      * Override the cache::construct method.
1385      *
1386      * This function gets overriden so that we can process any invalidation events if need be.
1387      * If the definition doesn't have any invalidation events then this occurs exactly as it would for the cache class.
1388      * Otherwise we look at the last invalidation time and then check the invalidation data for events that have occured
1389      * between then now.
1390      *
1391      * You should not call this method from your code, instead you should use the cache::make methods.
1392      *
1393      * @param cache_definition $definition
1394      * @param cache_store $store
1395      * @param cache_loader|cache_data_source $loader
1396      * @return void
1397      */
1398     public function __construct(cache_definition $definition, cache_store $store, $loader = null) {
1399         parent::__construct($definition, $store, $loader);
1400         if ($definition->has_invalidation_events()) {
1401             $lastinvalidation = $this->get('lastsessioninvalidation');
1402             if ($lastinvalidation === false) {
1403                 // This is a new session, there won't be anything to invalidate. Set the time of the last invalidation and
1404                 // move on.
1405                 $this->set('lastsessioninvalidation', cache::now());
1406                 return;
1407             } else if ($lastinvalidation == cache::now()) {
1408                 // We've already invalidated during this request.
1409                 return;
1410             }
1412             // Get the event invalidation cache.
1413             $cache = cache::make('core', 'eventinvalidation');
1414             $events = $cache->get_many($definition->get_invalidation_events());
1415             $todelete = array();
1416             // Iterate the returned data for the events.
1417             foreach ($events as $event => $keys) {
1418                 if ($keys === false) {
1419                     // No data to be invalidated yet.
1420                     continue;
1421                 }
1422                 // Look at each key and check the timestamp.
1423                 foreach ($keys as $key => $timestamp) {
1424                     // If the timestamp of the event is more than or equal to the last invalidation (happened between the last
1425                     // invalidation and now)then we need to invaliate the key.
1426                     if ($timestamp >= $lastinvalidation) {
1427                         $todelete[] = $key;
1428                     }
1429                 }
1430             }
1431             if (!empty($todelete)) {
1432                 $todelete = array_unique($todelete);
1433                 $this->delete_many($todelete);
1434             }
1435             // Set the time of the last invalidation.
1436             $this->set('lastsessioninvalidation', cache::now());
1437         }
1438     }
1441 /**
1442  * An request cache.
1443  *
1444  * This class is used for request caches returned by the cache::make methods.
1445  *
1446  * This cache class should never be interacted with directly. Instead you should always use the cache::make methods.
1447  * It is technically possible to call those methods through this class however there is no guarantee that you will get an
1448  * instance of this class back again.
1449  *
1450  * @internal don't use me directly.
1451  *
1452  * @package    core
1453  * @category   cache
1454  * @copyright  2012 Sam Hemelryk
1455  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1456  */
1457 class cache_request extends cache {
1458     // This comment appeases code pre-checker ;) !