28b36aef53b641472c889279b0a39298e9e94fbb
[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 requried 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, cache_is_key_aware {
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             return $result;
281         } else if ($this->perfdebug) {
282             cache_helper::record_cache_miss('** static persist **', $this->definition->get_id());
283         }
284         // 3. Get it from the store. Obviously wasn't in the persist cache.
285         $result = $this->store->get($parsedkey);
286         if ($result !== false) {
287             if ($result instanceof cache_ttl_wrapper) {
288                 if ($result->has_expired()) {
289                     $this->store->delete($parsedkey);
290                     $result = false;
291                 } else {
292                     $result = $result->data;
293                 }
294             }
295             if ($result instanceof cache_cached_object) {
296                 $result = $result->restore_object();
297             }
298             if ($this->is_using_persist_cache()) {
299                 $this->set_in_persist_cache($parsedkey, $result);
300             }
301         }
302         // 4. Load if from the loader/datasource if we don't already have it.
303         $setaftervalidation = false;
304         if ($result === false) {
305             if ($this->perfdebug) {
306                 cache_helper::record_cache_miss($this->storetype, $this->definition->get_id());
307             }
308             if ($this->loader !== false) {
309                 $result = $this->loader->get($parsedkey);
310             } else if ($this->datasource !== false) {
311                 $result = $this->datasource->load_for_cache($key);
312             }
313             $setaftervalidation = ($result !== false);
314         } else if ($this->perfdebug) {
315             cache_helper::record_cache_hit($this->storetype, $this->definition->get_id());
316         }
317         // 5. Validate strictness.
318         if ($strictness === MUST_EXIST && $result === false) {
319             throw new moodle_exception('Requested key did not exist in any cache stores and could not be loaded.');
320         }
321         // 6. Set it to the store if we got it from the loader/datasource.
322         if ($setaftervalidation) {
323             $this->set($key, $result);
324         }
325         return $result;
326     }
328     /**
329      * Retrieves an array of values for an array of keys.
330      *
331      * Using this function comes with potential performance implications.
332      * Not all cache stores will support get_many/set_many operations and in order to replicate this functionality will call
333      * the equivalent singular method for each item provided.
334      * This should not deter you from using this function as there is a performance benefit in situations where the cache store
335      * does support it, but you should be aware of this fact.
336      *
337      * @param array $keys The keys of the data being requested.
338      *      Each key can be any structure although using a scalar string or int is recommended in the interests of performance.
339      *      In advanced cases an array may be useful such as in situations requiring the multi-key functionality.
340      * @param int $strictness One of IGNORE_MISSING or MUST_EXIST.
341      * @return array An array of key value pairs for the items that could be retrieved from the cache.
342      *      If MUST_EXIST was used and not all keys existed within the cache then an exception will be thrown.
343      *      Otherwise any key that did not exist will have a data value of false within the results.
344      * @throws moodle_exception
345      */
346     public function get_many(array $keys, $strictness = IGNORE_MISSING) {
348         $parsedkeys = array();
349         $resultpersist = array();
350         $resultstore = array();
351         $keystofind = array();
353         // First up check the persist cache for each key.
354         $isusingpersist = $this->is_using_persist_cache();
355         foreach ($keys as $key) {
356             $pkey = $this->parse_key($key);
357             $parsedkeys[$pkey] = $key;
358             $keystofind[$pkey] = $key;
359             if ($isusingpersist) {
360                 $value = $this->get_from_persist_cache($pkey);
361                 if ($value !== false) {
362                     $resultpersist[$pkey] = $value;
363                     unset($keystofind[$pkey]);
364                 }
365             }
366         }
368         // Next assuming we didn't find all of the keys in the persist cache try loading them from the store.
369         if (count($keystofind)) {
370             $resultstore = $this->store->get_many(array_keys($keystofind));
371             // Process each item in the result to "unwrap" it.
372             foreach ($resultstore as $key => $value) {
373                 if ($value instanceof cache_ttl_wrapper) {
374                     if ($value->has_expired()) {
375                         $value = false;
376                     } else {
377                         $value = $value->data;
378                     }
379                 }
380                 if ($value instanceof cache_cached_object) {
381                     $value = $value->restore_object();
382                 }
383                 $resultstore[$key] = $value;
384             }
385         }
387         // Merge the result from the persis cache with the results from the store load.
388         $result = $resultpersist + $resultstore;
389         unset($resultpersist);
390         unset($resultstore);
392         // Next we need to find any missing values and load them from the loader/datasource next in the chain.
393         $usingloader = ($this->loader !== false);
394         $usingsource = (!$usingloader && ($this->datasource !== false));
395         if ($usingloader || $usingsource) {
396             $missingkeys = array();
397             foreach ($result as $key => $value) {
398                 if ($value === false) {
399                     $missingkeys[] = ($usingloader) ? $key : $parsedkeys[$key];
400                 }
401             }
402             if (!empty($missingkeys)) {
403                 if ($usingloader) {
404                     $resultmissing = $this->loader->get_many($missingkeys);
405                 } else {
406                     $resultmissing = $this->datasource->load_many_for_cache($missingkeys);
407                 }
408                 foreach ($resultmissing as $key => $value) {
409                     $result[$key] = $value;
410                     if ($value !== false) {
411                         $this->set($parsedkeys[$key], $value);
412                     }
413                 }
414                 unset($resultmissing);
415             }
416             unset($missingkeys);
417         }
419         // Create an array with the original keys and the found values. This will be what we return.
420         $fullresult = array();
421         foreach ($result as $key => $value) {
422             $fullresult[$parsedkeys[$key]] = $value;
423         }
424         unset($result);
426         // Final step is to check strictness.
427         if ($strictness === MUST_EXIST) {
428             foreach ($keys as $key) {
429                 if (!array_key_exists($key, $fullresult)) {
430                     throw new moodle_exception('Not all the requested keys existed within the cache stores.');
431                 }
432             }
433         }
435         // Return the result. Phew!
436         return $fullresult;
437     }
439     /**
440      * Sends a key => value pair to the cache.
441      *
442      * <code>
443      * // This code will add four entries to the cache, one for each url.
444      * $cache->set('main', 'http://moodle.org');
445      * $cache->set('docs', 'http://docs.moodle.org');
446      * $cache->set('tracker', 'http://tracker.moodle.org');
447      * $cache->set('qa', 'http://qa.moodle.net');
448      * </code>
449      *
450      * @param string|int $key The key for the data being requested.
451      *      It can be any structure although using a scalar string or int is recommended in the interests of performance.
452      *      In advanced cases an array may be useful such as in situations requiring the multi-key functionality.
453      * @param mixed $data The data to set against the key.
454      * @return bool True on success, false otherwise.
455      */
456     public function set($key, $data) {
457         if ($this->perfdebug) {
458             cache_helper::record_cache_set($this->storetype, $this->definition->get_id());
459         }
460         if (is_object($data) && $data instanceof cacheable_object) {
461             $data = new cache_cached_object($data);
462         }
463         if ($this->has_a_ttl() && !$this->store_supports_native_ttl()) {
464             $data = new cache_ttl_wrapper($data, $this->definition->get_ttl());
465         }
466         $parsedkey = $this->parse_key($key);
467         if ($this->is_using_persist_cache()) {
468             $this->set_in_persist_cache($parsedkey, $data);
469         }
470         return $this->store->set($parsedkey, $data);
471     }
473     /**
474      * Sends several key => value pairs to the cache.
475      *
476      * Using this function comes with potential performance implications.
477      * Not all cache stores will support get_many/set_many operations and in order to replicate this functionality will call
478      * the equivalent singular method for each item provided.
479      * This should not deter you from using this function as there is a performance benefit in situations where the cache store
480      * does support it, but you should be aware of this fact.
481      *
482      * <code>
483      * // This code will add four entries to the cache, one for each url.
484      * $cache->set_many(array(
485      *     'main' => 'http://moodle.org',
486      *     'docs' => 'http://docs.moodle.org',
487      *     'tracker' => 'http://tracker.moodle.org',
488      *     'qa' => ''http://qa.moodle.net'
489      * ));
490      * </code>
491      *
492      * @param array $keyvaluearray An array of key => value pairs to send to the cache.
493      * @return int The number of items successfully set. It is up to the developer to check this matches the number of items.
494      *      ... if they care that is.
495      */
496     public function set_many(array $keyvaluearray) {
497         $data = array();
498         $simulatettl = $this->has_a_ttl() && !$this->store_supports_native_ttl();
499         $usepersistcache = $this->is_using_persist_cache();
500         foreach ($keyvaluearray as $key => $value) {
501             if (is_object($value) && $value instanceof cacheable_object) {
502                 $value = new cache_cached_object($value);
503             }
504             if ($simulatettl) {
505                 $value = new cache_ttl_wrapper($value, $this->definition->get_ttl());
506             }
507             $data[$key] = array(
508                 'key' => $this->parse_key($key),
509                 'value' => $value
510             );
511             if ($usepersistcache) {
512                 $this->set_in_persist_cache($data[$key]['key'], $value);
513             }
514         }
515         if ($this->perfdebug) {
516             cache_helper::record_cache_set($this->storetype, $this->definition->get_id());
517         }
518         return $this->store->set_many($data);
519     }
521     /**
522      * Test is a cache has a key.
523      *
524      * The use of the has methods is strongly discouraged. In a high load environment the cache may well change between the
525      * test and any subsequent action (get, set, delete etc).
526      * Instead it is recommended to write your code in such a way they it performs the following steps:
527      * <ol>
528      * <li>Attempt to retrieve the information.</li>
529      * <li>Generate the information.</li>
530      * <li>Attempt to set the information</li>
531      * </ol>
532      *
533      * Its also worth mentioning that not all stores support key tests.
534      * For stores that don't support key tests this functionality is mimicked by using the equivalent get method.
535      * Just one more reason you should not use these methods unless you have a very good reason to do so.
536      *
537      * @param string|int $key
538      * @param bool $tryloadifpossible If set to true, the cache doesn't contain the key, and there is another cache loader or
539      *      data source then the code will try load the key value from the next item in the chain.
540      * @return bool True if the cache has the requested key, false otherwise.
541      */
542     public function has($key, $tryloadifpossible = false) {
543         $parsedkey = $this->parse_key($key);
544         if ($this->is_in_persist_cache($parsedkey)) {
545             return true;
546         }
547         if (($this->has_a_ttl() && !$this->store_supports_native_ttl()) || !$this->store_supports_key_awareness()) {
548             if ($this->store_supports_key_awareness() && !$this->store->has($parsedkey)) {
549                 return false;
550             }
551             $data = $this->store->get($parsedkey);
552             if (!$this->store_supports_native_ttl()) {
553                 $has = ($data instanceof cache_ttl_wrapper && !$data->has_expired());
554             } else {
555                 $has = ($data !== false);
556             }
557         } else {
558             $has = $this->store->has($parsedkey);
559         }
560         if (!$has && $tryloadifpossible) {
561             if ($this->loader !== false) {
562                 $result = $this->loader->get($parsedkey);
563             } else if ($this->datasource !== null) {
564                 $result = $this->datasource->load_for_cache($key);
565             }
566             $has = ($result !== null);
567             if ($has) {
568                 $this->set($key, $result);
569             }
570         }
571         return $has;
572     }
574     /**
575      * Test is a cache has all of the given keys.
576      *
577      * It is strongly recommended to avoid the use of this function if not absolutely required.
578      * In a high load environment the cache may well change between the test and any subsequent action (get, set, delete etc).
579      *
580      * Its also worth mentioning that not all stores support key tests.
581      * For stores that don't support key tests this functionality is mimicked by using the equivalent get method.
582      * Just one more reason you should not use these methods unless you have a very good reason to do so.
583      *
584      * @param array $keys
585      * @return bool True if the cache has all of the given keys, false otherwise.
586      */
587     public function has_all(array $keys) {
588         if (($this->has_a_ttl() && !$this->store_supports_native_ttl()) || !$this->store_supports_key_awareness()) {
589             foreach ($keys as $key) {
590                 if (!$this->has($key)) {
591                     return false;
592                 }
593             }
594             return true;
595         }
596         $parsedkeys = array_map(array($this, 'parse_key'), $keys);
597         return $this->store->has_all($parsedkeys);
598     }
600     /**
601      * Test if a cache has at least one of the given keys.
602      *
603      * It is strongly recommended to avoid the use of this function if not absolutely required.
604      * In a high load environment the cache may well change between the test and any subsequent action (get, set, delete etc).
605      *
606      * Its also worth mentioning that not all stores support key tests.
607      * For stores that don't support key tests this functionality is mimicked by using the equivalent get method.
608      * Just one more reason you should not use these methods unless you have a very good reason to do so.
609      *
610      * @param array $keys
611      * @return bool True if the cache has at least one of the given keys
612      */
613     public function has_any(array $keys) {
614         if (($this->has_a_ttl() && !$this->store_supports_native_ttl()) || !$this->store_supports_key_awareness()) {
615             foreach ($keys as $key) {
616                 if ($this->has($key)) {
617                     return true;
618                 }
619             }
620             return false;
621         }
623         if ($this->is_using_persist_cache()) {
624             $parsedkeys = array();
625             foreach ($keys as $id => $key) {
626                 $parsedkey = $this->parse_key($key);
627                 if ($this->is_in_persist_cache($parsedkey)) {
628                     return true;
629                 }
630                 $parsedkeys[] = $parsedkey;
631             }
632         } else {
633             $parsedkeys = array_map(array($this, 'parse_key'), $keys);
634         }
635         return $this->store->has_any($parsedkeys);
636     }
638     /**
639      * Delete the given key from the cache.
640      *
641      * @param string|int $key The key to delete.
642      * @param bool $recurse When set to true the key will also be deleted from all stacked cache loaders and their stores.
643      *     This happens by default and ensure that all the caches are consistent. It is NOT recommended to change this.
644      * @return bool True of success, false otherwise.
645      */
646     public function delete($key, $recurse = true) {
647         $parsedkey = $this->parse_key($key);
648         $this->delete_from_persist_cache($parsedkey);
649         if ($recurse && !empty($this->loader)) {
650             // Delete from the bottom of the stack first.
651             $this->loader->delete($key, $recurse);
652         }
653         return $this->store->delete($parsedkey);
654     }
656     /**
657      * Delete all of the given keys from the cache.
658      *
659      * @param array $keys The key to delete.
660      * @param bool $recurse When set to true the key will also be deleted from all stacked cache loaders and their stores.
661      *     This happens by default and ensure that all the caches are consistent. It is NOT recommended to change this.
662      * @return int The number of items successfully deleted.
663      */
664     public function delete_many(array $keys, $recurse = true) {
665         $parsedkeys = array_map(array($this, 'parse_key'), $keys);
666         if ($this->is_using_persist_cache()) {
667             foreach ($parsedkeys as $parsedkey) {
668                 $this->delete_from_persist_cache($parsedkey);
669             }
670         }
671         if ($recurse && !empty($this->loader)) {
672             // Delete from the bottom of the stack first.
673             $this->loader->delete_many($keys, $recurse);
674         }
675         return $this->store->delete_many($parsedkeys);
676     }
678     /**
679      * Purges the cache store, and loader if there is one.
680      *
681      * @return bool True on success, false otherwise
682      */
683     public function purge() {
684         // 1. Purge the persist cache.
685         $this->persistcache = array();
686         // 2. Purge the store.
687         $this->store->purge();
688         // 3. Optionally pruge any stacked loaders.
689         if ($this->loader) {
690             $this->loader->purge();
691         }
692         return true;
693     }
695     /**
696      * Parses the key turning it into a string (or array is required) suitable to be passed to the cache store.
697      *
698      * @param string|int $key As passed to get|set|delete etc.
699      * @return string|array String unless the store supports multi-identifiers in which case an array if returned.
700      */
701     protected function parse_key($key) {
702         if ($this->store->supports_multiple_indentifiers()) {
703             $result = $this->definition->generate_multi_key_parts();
704             $result['key'] = $key;
705             return $result;
706         }
707         return cache_helper::hash_key($this->definition->generate_single_key_prefix().'-'.$key);
708     }
710     /**
711      * Returns true if the cache is making use of a ttl.
712      * @return bool
713      */
714     protected function has_a_ttl() {
715         return $this->hasattl;
716     }
718     /**
719      * Returns true if the cache store supports native ttl.
720      * @return bool
721      */
722     protected function store_supports_native_ttl() {
723         if ($this->supportsnativettl === null) {
724             $this->supportsnativettl = ($this->store->supports_native_ttl());
725         }
726         return $this->supportsnativettl;
727     }
729     /**
730      * Returns the cache definition.
731      *
732      * @return cache_definition
733      */
734     protected function get_definition() {
735         return $this->definition;
736     }
738     /**
739      * Returns the cache store
740      *
741      * @return cache_store
742      */
743     protected function get_store() {
744         return $this->store;
745     }
747     /**
748      * Returns true if the store supports key awareness.
749      *
750      * @return bool
751      */
752     protected function store_supports_key_awareness() {
753         if ($this->supportskeyawareness === null) {
754             $this->supportskeyawareness = ($this->store instanceof cache_is_key_aware);
755         }
756         return $this->supportskeyawareness;
757     }
759     /**
760      * Returns true if the store natively supports locking.
761      *
762      * @return bool
763      */
764     protected function store_supports_native_locking() {
765         if ($this->nativelocking === null) {
766             $this->nativelocking = ($this->store instanceof cache_is_lockable);
767         }
768         return $this->nativelocking;
769     }
771     /**
772      * Returns true if this cache is making use of the persist cache.
773      *
774      * @return bool
775      */
776     protected function is_using_persist_cache() {
777         return $this->persist;
778     }
780     /**
781      * Returns true if the requested key exists within the persist cache.
782      *
783      * @param string $key The parsed key
784      * @return bool
785      */
786     protected function is_in_persist_cache($key) {
787         if (is_array($key)) {
788             $key = $key['key'];
789         }
790         // This could be written as a single line, however it has been split because the ttl check is faster than the instanceof
791         // and has_expired calls.
792         if (!$this->persist || !array_key_exists($key, $this->persistcache)) {
793             return false;
794         }
795         if ($this->has_a_ttl() && $this->store_supports_native_ttl()) {
796              return !($this->persistcache[$key] instanceof cache_ttl_wrapper && $this->persistcache[$key]->has_expired());
797         }
798         return true;
799     }
801     /**
802      * Returns the item from the persist cache if it exists there.
803      *
804      * @param string $key The parsed key
805      * @return mixed|false The data from the persist cache or false if it wasn't there.
806      */
807     protected function get_from_persist_cache($key) {
808         if (is_array($key)) {
809             $key = $key['key'];
810         }
811         if (!$this->persist || !array_key_exists($key, $this->persistcache)) {
812             return false;
813         }
814         $data = $this->persistcache[$key];
815         if (!$this->has_a_ttl() || !$data instanceof cache_ttl_wrapper) {
816             if ($data instanceof cache_cached_object) {
817                 $data = $data->restore_object();
818             }
819             return $data;
820         }
821         if ($data->has_expired()) {
822             $this->delete_from_persist_cache($key);
823             return false;
824         } else {
825             if ($data instanceof cache_cached_object) {
826                 $data = $data->restore_object();
827             }
828             return $data->data;
829         }
830     }
832     /**
833      * Sets a key value pair into the persist cache.
834      *
835      * @param string $key The parsed key
836      * @param mixed $data
837      * @return bool
838      */
839     protected function set_in_persist_cache($key, $data) {
840         if (is_array($key)) {
841             $key = $key['key'];
842         }
843         $this->persistcache[$key] = $data;
844         if ($this->persistmaxsize !== false) {
845             $this->persistcount++;
846             if ($this->persistcount > $this->persistmaxsize) {
847                 $dropkey = array_shift($this->persistkeys);
848                 unset($this->persistcache[$dropkey]);
849                 $this->persistcount--;
850             }
851         }
852         return true;
853     }
855     /**
856      * Deletes an item from the persist cache.
857      *
858      * @param string|int $key As given to get|set|delete
859      * @return bool True on success, false otherwise.
860      */
861     protected function delete_from_persist_cache($key) {
862         unset($this->persistcache[$key]);
863         if ($this->persistmaxsize !== false) {
864             $dropkey = array_search($key, $this->persistkeys);
865             if ($dropkey) {
866                 unset($this->persistkeys[$dropkey]);
867                 $this->persistcount--;
868             }
869         }
870         return true;
871     }
873     /**
874      * Returns the timestamp from the first request for the time from the cache API.
875      *
876      * This stamp needs to be used for all ttl and time based operations to ensure that we don't end up with
877      * timing issues.
878      *
879      * @return int
880      */
881     public static function now() {
882         if (self::$now === null) {
883             self::$now = time();
884         }
885         return self::$now;
886     }
889 /**
890  * An application cache.
891  *
892  * This class is used for application caches returned by the cache::make methods.
893  * On top of the standard functionality it also allows locking to be required and or manually operated.
894  *
895  * This cache class should never be interacted with directly. Instead you should always use the cache::make methods.
896  * It is technically possible to call those methods through this class however there is no guarantee that you will get an
897  * instance of this class back again.
898  *
899  * @internal don't use me directly.
900  *
901  * @package    core
902  * @category   cache
903  * @copyright  2012 Sam Hemelryk
904  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
905  */
906 class cache_application extends cache implements cache_loader_with_locking {
908     /**
909      * Lock identifier.
910      * This is used to ensure the lock belongs to the cache instance + definition + user.
911      * @var string
912      */
913     protected $lockidentifier;
915     /**
916      * Gets set to true if the cache's primary store natively supports locking.
917      * If it does then we use that, otherwise we need to instantiate a second store to use for locking.
918      * @var cache_store
919      */
920     protected $nativelocking = null;
922     /**
923      * Gets set to true if the cache is going to be using locking.
924      * This isn't a requirement, it doesn't need to use locking (most won't) and this bool is used to quickly check things.
925      * If required then locking will be forced for the get|set|delete operation.
926      * @var bool
927      */
928     protected $requirelocking = false;
930     /**
931      * Gets set to true if the cache must use read locking (get|has).
932      * @var bool
933      */
934     protected $requirelockingread = false;
936     /**
937      * Gets set to true if the cache must use write locking (set|delete)
938      * @var bool
939      */
940     protected $requirelockingwrite = false;
942     /**
943      * Gets set to a cache_store to use for locking if the caches primary store doesn't support locking natively.
944      * @var cache_lock_interface
945      */
946     protected $cachelockinstance;
948     /**
949      * Overrides the cache construct method.
950      *
951      * You should not call this method from your code, instead you should use the cache::make methods.
952      *
953      * @param cache_definition $definition
954      * @param cache_store $store
955      * @param cache_loader|cache_data_source $loader
956      */
957     public function __construct(cache_definition $definition, cache_store $store, $loader = null) {
958         parent::__construct($definition, $store, $loader);
959         $this->nativelocking = $this->store_supports_native_locking();
960         if ($definition->require_locking()) {
961             $this->requirelocking = true;
962             $this->requirelockingread = $definition->require_locking_read();
963             $this->requirelockingwrite = $definition->require_locking_write();
964         }
966         if ($definition->has_invalidation_events()) {
967             $lastinvalidation = $this->get('lastinvalidation');
968             if ($lastinvalidation === false) {
969                 // This is a new session, there won't be anything to invalidate. Set the time of the last invalidation and
970                 // move on.
971                 $this->set('lastinvalidation', cache::now());
972                 return;
973             } else if ($lastinvalidation == cache::now()) {
974                 // We've already invalidated during this request.
975                 return;
976             }
978             // Get the event invalidation cache.
979             $cache = cache::make('core', 'eventinvalidation');
980             $events = $cache->get_many($definition->get_invalidation_events());
981             $todelete = array();
982             // Iterate the returned data for the events.
983             foreach ($events as $event => $keys) {
984                 // Look at each key and check the timestamp.
985                 foreach ($keys as $key => $timestamp) {
986                     // If the timestamp of the event is more than or equal to the last invalidation (happened between the last
987                     // invalidation and now)then we need to invaliate the key.
988                     if ($timestamp >= $lastinvalidation) {
989                         $todelete[] = $key;
990                     }
991                 }
992             }
993             if (!empty($todelete)) {
994                 $todelete = array_unique($todelete);
995                 $this->delete_many($todelete);
996             }
997             // Set the time of the last invalidation.
998             $this->set('lastinvalidation', cache::now());
999         }
1000     }
1002     /**
1003      * Returns the identifier to use
1004      *
1005      * @staticvar int $instances Counts the number of instances. Used as part of the lock identifier.
1006      * @return string
1007      */
1008     public function get_identifier() {
1009         static $instances = 0;
1010         if ($this->lockidentifier === null) {
1011             $this->lockidentifier = md5(
1012                 $this->get_definition()->generate_definition_hash() .
1013                 sesskey() .
1014                 $instances++ .
1015                 'cache_application'
1016             );
1017         }
1018         return $this->lockidentifier;
1019     }
1021     /**
1022      * Fixes the instance up after a clone.
1023      */
1024     public function __clone() {
1025         // Force a new idenfitier.
1026         $this->lockidentifier = null;
1027     }
1029     /**
1030      * Acquires a lock on the given key.
1031      *
1032      * This is done automatically if the definition requires it.
1033      * It is recommended to use a definition if you want to have locking although it is possible to do locking without having
1034      * it required by the definition.
1035      * The problem with such an approach is that you cannot ensure that code will consistently use locking. You will need to
1036      * rely on the integrators review skills.
1037      *
1038      * @param string|int $key The key as given to get|set|delete
1039      * @return bool Returns true if the lock could be acquired, false otherwise.
1040      */
1041     public function acquire_lock($key) {
1042         $key = $this->parse_key($key);
1043         if ($this->nativelocking) {
1044             return $this->get_store()->acquire_lock($key, $this->get_identifier());
1045         } else {
1046             $this->ensure_cachelock_available();
1047             return $this->cachelockinstance->lock($key, $this->get_identifier());
1048         }
1049     }
1051     /**
1052      * Checks if this cache has a lock on the given key.
1053      *
1054      * @param string|int $key The key as given to get|set|delete
1055      * @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
1056      *      someone else has the lock.
1057      */
1058     public function check_lock_state($key) {
1059         $key = $this->parse_key($key);
1060         if ($this->nativelocking) {
1061             return $this->get_store()->check_lock_state($key, $this->get_identifier());
1062         } else {
1063             $this->ensure_cachelock_available();
1064             return $this->cachelockinstance->check_state($key, $this->get_identifier());
1065         }
1066     }
1068     /**
1069      * Releases the lock this cache has on the given key
1070      *
1071      * @param string|int $key
1072      * @return bool True if the operation succeeded, false otherwise.
1073      */
1074     public function release_lock($key) {
1075         $key = $this->parse_key($key);
1076         if ($this->nativelocking) {
1077             return $this->get_store()->release_lock($key, $this->get_identifier());
1078         } else {
1079             $this->ensure_cachelock_available();
1080             return $this->cachelockinstance->unlock($key, $this->get_identifier());
1081         }
1082     }
1084     /**
1085      * Ensure that the dedicated lock store is ready to go.
1086      *
1087      * This should only happen if the cache store doesn't natively support it.
1088      */
1089     protected function ensure_cachelock_available() {
1090         if ($this->cachelockinstance === null) {
1091             $this->cachelockinstance = cache_helper::get_cachelock_for_store($this->get_store());
1092         }
1093     }
1095     /**
1096      * Sends a key => value pair to the cache.
1097      *
1098      * <code>
1099      * // This code will add four entries to the cache, one for each url.
1100      * $cache->set('main', 'http://moodle.org');
1101      * $cache->set('docs', 'http://docs.moodle.org');
1102      * $cache->set('tracker', 'http://tracker.moodle.org');
1103      * $cache->set('qa', 'http://qa.moodle.net');
1104      * </code>
1105      *
1106      * @param string|int $key The key for the data being requested.
1107      * @param mixed $data The data to set against the key.
1108      * @return bool True on success, false otherwise.
1109      */
1110     public function set($key, $data) {
1111         if ($this->requirelockingwrite && !$this->acquire_lock($key)) {
1112             return false;
1113         }
1114         $result = parent::set($key, $data);
1115         if ($this->requirelockingwrite && !$this->release_lock($key)) {
1116             debugging('Failed to release cache lock on set operation... this should not happen.', DEBUG_DEVELOPER);
1117         }
1118         return $result;
1119     }
1121     /**
1122      * Sends several key => value pairs to the cache.
1123      *
1124      * Using this function comes with potential performance implications.
1125      * Not all cache stores will support get_many/set_many operations and in order to replicate this functionality will call
1126      * the equivalent singular method for each item provided.
1127      * This should not deter you from using this function as there is a performance benefit in situations where the cache store
1128      * does support it, but you should be aware of this fact.
1129      *
1130      * <code>
1131      * // This code will add four entries to the cache, one for each url.
1132      * $cache->set_many(array(
1133      *     'main' => 'http://moodle.org',
1134      *     'docs' => 'http://docs.moodle.org',
1135      *     'tracker' => 'http://tracker.moodle.org',
1136      *     'qa' => ''http://qa.moodle.net'
1137      * ));
1138      * </code>
1139      *
1140      * @param array $keyvaluearray An array of key => value pairs to send to the cache.
1141      * @return int The number of items successfully set. It is up to the developer to check this matches the number of items.
1142      *      ... if they care that is.
1143      */
1144     public function set_many(array $keyvaluearray) {
1145         if ($this->requirelockingwrite) {
1146             $locks = array();
1147             foreach ($keyvaluearray as $id => $pair) {
1148                 $key = $pair['key'];
1149                 if ($this->acquire_lock($key)) {
1150                     $locks[] = $key;
1151                 } else {
1152                     unset($keyvaluearray[$id]);
1153                 }
1154             }
1155         }
1156         $result = parent::set_many($keyvaluearray);
1157         if ($this->requirelockingwrite) {
1158             foreach ($locks as $key) {
1159                 if ($this->release_lock($key)) {
1160                     debugging('Failed to release cache lock on set_many operation... this should not happen.', DEBUG_DEVELOPER);
1161                 }
1162             }
1163         }
1164         return $result;
1165     }
1167     /**
1168      * Retrieves the value for the given key from the cache.
1169      *
1170      * @param string|int $key The key for the data being requested.
1171      * @param int $strictness One of IGNORE_MISSING | MUST_EXIST
1172      * @return mixed|false The data from the cache or false if the key did not exist within the cache.
1173      * @throws moodle_exception
1174      */
1175     public function get($key, $strictness = IGNORE_MISSING) {
1176         if ($this->requirelockingread && $this->check_lock_state($key) === false) {
1177             // Read locking required and someone else has the read lock.
1178             return false;
1179         }
1180         return parent::get($key, $strictness);
1181     }
1183     /**
1184      * Retrieves an array of values for an array of keys.
1185      *
1186      * Using this function comes with potential performance implications.
1187      * Not all cache stores will support get_many/set_many operations and in order to replicate this functionality will call
1188      * the equivalent singular method for each item provided.
1189      * This should not deter you from using this function as there is a performance benefit in situations where the cache store
1190      * does support it, but you should be aware of this fact.
1191      *
1192      * @param array $keys The keys of the data being requested.
1193      * @param int $strictness One of IGNORE_MISSING or MUST_EXIST.
1194      * @return array An array of key value pairs for the items that could be retrieved from the cache.
1195      *      If MUST_EXIST was used and not all keys existed within the cache then an exception will be thrown.
1196      *      Otherwise any key that did not exist will have a data value of false within the results.
1197      * @throws moodle_exception
1198      */
1199     public function get_many(array $keys, $strictness = IGNORE_MISSING) {
1200         if ($this->requirelockingread) {
1201             foreach ($keys as $id => $key) {
1202                 $lock =$this->acquire_lock($key);
1203                 if (!$lock) {
1204                     if ($strictness === MUST_EXIST) {
1205                         throw new coding_exception('Could not acquire read locks for all of the items being requested.');
1206                     } else {
1207                         // Can't return this as we couldn't get a read lock.
1208                         unset($keys[$id]);
1209                     }
1210                 }
1212             }
1213         }
1214         return parent::get_many($keys, $strictness);
1215     }
1217     /**
1218      * Delete the given key from the cache.
1219      *
1220      * @param string|int $key The key to delete.
1221      * @param bool $recurse When set to true the key will also be deleted from all stacked cache loaders and their stores.
1222      *     This happens by default and ensure that all the caches are consistent. It is NOT recommended to change this.
1223      * @return bool True of success, false otherwise.
1224      */
1225     public function delete($key, $recurse = true) {
1226         if ($this->requirelockingwrite && !$this->acquire_lock($key)) {
1227             return false;
1228         }
1229         $result = parent::delete($key, $recurse);
1230         if ($this->requirelockingwrite && !$this->release_lock($key)) {
1231             debugging('Failed to release cache lock on delete operation... this should not happen.', DEBUG_DEVELOPER);
1232         }
1233         return $result;
1234     }
1236     /**
1237      * Delete all of the given keys from the cache.
1238      *
1239      * @param array $keys The key to delete.
1240      * @param bool $recurse When set to true the key will also be deleted from all stacked cache loaders and their stores.
1241      *     This happens by default and ensure that all the caches are consistent. It is NOT recommended to change this.
1242      * @return int The number of items successfully deleted.
1243      */
1244     public function delete_many(array $keys, $recurse = true) {
1245         if ($this->requirelockingwrite) {
1246             $locks = array();
1247             foreach ($keys as $id => $key) {
1248                 if ($this->acquire_lock($key)) {
1249                     $locks[] = $key;
1250                 } else {
1251                     unset($keys[$id]);
1252                 }
1253             }
1254         }
1255         $result = parent::delete_many($keys, $recurse);
1256         if ($this->requirelockingwrite) {
1257             foreach ($locks as $key) {
1258                 if ($this->release_lock($key)) {
1259                     debugging('Failed to release cache lock on delete_many operation... this should not happen.', DEBUG_DEVELOPER);
1260                 }
1261             }
1262         }
1263         return $result;
1264     }
1267 /**
1268  * A session cache.
1269  *
1270  * This class is used for session caches returned by the cache::make methods.
1271  *
1272  * This cache class should never be interacted with directly. Instead you should always use the cache::make methods.
1273  * It is technically possible to call those methods through this class however there is no guarantee that you will get an
1274  * instance of this class back again.
1275  *
1276  * @todo we should support locking in the session as well. Should be pretty simple to set up.
1277  *
1278  * @internal don't use me directly.
1279  *
1280  * @package    core
1281  * @category   cache
1282  * @copyright  2012 Sam Hemelryk
1283  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1284  */
1285 class cache_session extends cache {
1286     /**
1287      * Override the cache::construct method.
1288      *
1289      * This function gets overriden so that we can process any invalidation events if need be.
1290      * If the definition doesn't have any invalidation events then this occurs exactly as it would for the cache class.
1291      * Otherwise we look at the last invalidation time and then check the invalidation data for events that have occured
1292      * between then now.
1293      *
1294      * You should not call this method from your code, instead you should use the cache::make methods.
1295      *
1296      * @param cache_definition $definition
1297      * @param cache_store $store
1298      * @param cache_loader|cache_data_source $loader
1299      * @return void
1300      */
1301     public function __construct(cache_definition $definition, cache_store $store, $loader = null) {
1302         parent::__construct($definition, $store, $loader);
1303         if ($definition->has_invalidation_events()) {
1304             $lastinvalidation = $this->get('lastsessioninvalidation');
1305             if ($lastinvalidation === false) {
1306                 // This is a new session, there won't be anything to invalidate. Set the time of the last invalidation and
1307                 // move on.
1308                 $this->set('lastsessioninvalidation', cache::now());
1309                 return;
1310             } else if ($lastinvalidation == cache::now()) {
1311                 // We've already invalidated during this request.
1312                 return;
1313             }
1315             // Get the event invalidation cache.
1316             $cache = cache::make('core', 'eventinvalidation');
1317             $events = $cache->get_many($definition->get_invalidation_events());
1318             $todelete = array();
1319             // Iterate the returned data for the events.
1320             foreach ($events as $event => $keys) {
1321                 if ($keys === false) {
1322                     // No data to be invalidated yet.
1323                     continue;
1324                 }
1325                 // Look at each key and check the timestamp.
1326                 foreach ($keys as $key => $timestamp) {
1327                     // If the timestamp of the event is more than or equal to the last invalidation (happened between the last
1328                     // invalidation and now)then we need to invaliate the key.
1329                     if ($timestamp >= $lastinvalidation) {
1330                         $todelete[] = $key;
1331                     }
1332                 }
1333             }
1334             if (!empty($todelete)) {
1335                 $todelete = array_unique($todelete);
1336                 $this->delete_many($todelete);
1337             }
1338             // Set the time of the last invalidation.
1339             $this->set('lastsessioninvalidation', cache::now());
1340         }
1341     }
1344 /**
1345  * An request cache.
1346  *
1347  * This class is used for request caches returned by the cache::make methods.
1348  *
1349  * This cache class should never be interacted with directly. Instead you should always use the cache::make methods.
1350  * It is technically possible to call those methods through this class however there is no guarantee that you will get an
1351  * instance of this class back again.
1352  *
1353  * @internal don't use me directly.
1354  *
1355  * @package    core
1356  * @category   cache
1357  * @copyright  2012 Sam Hemelryk
1358  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1359  */
1360 class cache_request extends cache {
1361     // This comment appeases code pre-checker ;) !