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