873dbbe62791181373d0d7bf286b414f999d630e
[moodle.git] / cache / classes / helper.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 helper class
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 cache helper class.
33  *
34  * The cache helper class provides common functionality to the cache API and is useful to developers within to interact with
35  * the cache API in a general way.
36  *
37  * @package    core
38  * @category   cache
39  * @copyright  2012 Sam Hemelryk
40  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
41  */
42 class cache_helper {
44     /**
45      * Statistics gathered by the cache API during its operation will be used here.
46      * @static
47      * @var array
48      */
49     protected static $stats = array();
51     /**
52      * The instance of the cache helper.
53      * @var cache_helper
54      */
55     protected static $instance;
57     /**
58      * The site identifier used by the cache.
59      * Set the first time get_site_identifier is called.
60      * @var string
61      */
62     protected static $siteidentifier = null;
64     /**
65      * Returns true if the cache API can be initialised before Moodle has finished initialising itself.
66      *
67      * This check is essential when trying to cache the likes of configuration information. It checks to make sure that the cache
68      * configuration file has been created which allows use to set up caching when ever is required.
69      *
70      * @return bool
71      */
72     public static function ready_for_early_init() {
73         return cache_config::config_file_exists();
74     }
76     /**
77      * Returns an instance of the cache_helper.
78      *
79      * This is designed for internal use only and acts as a static store.
80      * @staticvar null $instance
81      * @return cache_helper
82      */
83     protected static function instance() {
84         if (is_null(self::$instance)) {
85             self::$instance = new cache_helper();
86         }
87         return self::$instance;
88     }
90     /**
91      * Constructs an instance of the cache_helper class. Again for internal use only.
92      */
93     protected function __construct() {
94         // Nothing to do here, just making sure you can't get an instance of this.
95     }
97     /**
98      * Used as a data store for initialised definitions.
99      * @var array
100      */
101     protected $definitions = array();
103     /**
104      * Used as a data store for initialised cache stores
105      * We use this because we want to avoid establishing multiple instances of a single store.
106      * @var array
107      */
108     protected $stores = array();
110     /**
111      * Returns the class for use as a cache loader for the given mode.
112      *
113      * @param int $mode One of cache_store::MODE_
114      * @return string
115      * @throws coding_exception
116      */
117     public static function get_class_for_mode($mode) {
118         switch ($mode) {
119             case cache_store::MODE_APPLICATION :
120                 return 'cache_application';
121             case cache_store::MODE_REQUEST :
122                 return 'cache_request';
123             case cache_store::MODE_SESSION :
124                 return 'cache_session';
125         }
126         throw new coding_exception('Unknown cache mode passed. Must be one of cache_store::MODE_*');
127     }
129     /**
130      * Returns the cache stores to be used with the given definition.
131      * @param cache_definition $definition
132      * @return array
133      */
134     public static function get_cache_stores(cache_definition $definition) {
135         $instance = cache_config::instance();
136         $stores = $instance->get_stores_for_definition($definition);
137         $stores = self::initialise_cachestore_instances($stores, $definition);
138         return $stores;
139     }
141     /**
142      * Internal function for initialising an array of stores against a given cache definition.
143      *
144      * @param array $stores
145      * @param cache_definition $definition
146      * @return array
147      */
148     protected static function initialise_cachestore_instances(array $stores, cache_definition $definition) {
149         $return = array();
150         $factory = cache_factory::instance();
151         foreach ($stores as $name => $details) {
152             $store = $factory->create_store_from_config($name, $details, $definition);
153             if ($store !== false) {
154                 $return[] = $store;
155             }
156         }
157         return $return;
158     }
160     /**
161      * Returns a cache_lock instance suitable for use with the store.
162      *
163      * @param cache_store $store
164      * @return cache_lock_interface
165      */
166     public static function get_cachelock_for_store(cache_store $store) {
167         $instance = cache_config::instance();
168         $lockconf = $instance->get_lock_for_store($store->my_name());
169         $factory = cache_factory::instance();
170         return $factory->create_lock_instance($lockconf);
171     }
173     /**
174      * Returns an array of plugins without using core methods.
175      *
176      * This function explicitly does NOT use core functions as it will in some circumstances be called before Moodle has
177      * finished initialising. This happens when loading configuration for instance.
178      *
179      * @return string
180      */
181     public static function early_get_cache_plugins() {
182         global $CFG;
183         $result = array();
184         $ignored = array('CVS', '_vti_cnf', 'simpletest', 'db', 'yui', 'tests');
185         $fulldir = $CFG->dirroot.'/cache/stores';
186         $items = new DirectoryIterator($fulldir);
187         foreach ($items as $item) {
188             if ($item->isDot() or !$item->isDir()) {
189                 continue;
190             }
191             $pluginname = $item->getFilename();
192             if (in_array($pluginname, $ignored)) {
193                 continue;
194             }
195             if (!is_valid_plugin_name($pluginname)) {
196                 // Better ignore plugins with problematic names here.
197                 continue;
198             }
199             $result[$pluginname] = $fulldir.'/'.$pluginname;
200             unset($item);
201         }
202         unset($items);
203         return $result;
204     }
206     /**
207      * Invalidates a given set of keys from a given definition.
208      *
209      * @todo Invalidating by definition should also add to the event cache so that sessions can be invalidated (when required).
210      *
211      * @param string $component
212      * @param string $area
213      * @param array $identifiers
214      * @param array $keys
215      * @return boolean
216      */
217     public static function invalidate_by_definition($component, $area, array $identifiers = array(), $keys = array()) {
218         $cache = cache::make($component, $area, $identifiers);
219         if (is_array($keys)) {
220             $cache->delete_many($keys);
221         } else if (is_scalar($keys)) {
222             $cache->delete($keys);
223         } else {
224             throw new coding_exception('cache_helper::invalidate_by_definition only accepts $keys as array, or scalar.');
225         }
226         return true;
227     }
229     /**
230      * Invalidates a given set of keys by means of an event.
231      *
232      * @todo add support for identifiers to be supplied and utilised.
233      *
234      * @param string $event
235      * @param array $keys
236      */
237     public static function invalidate_by_event($event, array $keys) {
238         $instance = cache_config::instance();
239         $invalidationeventset = false;
240         $factory = cache_factory::instance();
241         foreach ($instance->get_definitions() as $name => $definitionarr) {
242             $definition = cache_definition::load($name, $definitionarr);
243             if ($definition->invalidates_on_event($event)) {
244                 // OK at this point we know that the definition has information to invalidate on the event.
245                 // There are two routes, either its an application cache in which case we can invalidate it now.
246                 // or it is a persistent cache that also needs to be invalidated now.
247                 if ($definition->get_mode() === cache_store::MODE_APPLICATION || $definition->should_be_persistent()) {
248                     $cache = $factory->create_cache_from_definition($definition->get_component(), $definition->get_area());
249                     $cache->delete_many($keys);
250                 }
252                 // We need to flag the event in the "Event invalidation" cache if it hasn't already happened.
253                 if ($invalidationeventset === false) {
254                     // Get the event invalidation cache.
255                     $cache = cache::make('core', 'eventinvalidation');
256                     // Get any existing invalidated keys for this cache.
257                     $data = $cache->get($event);
258                     if ($data === false) {
259                         // There are none.
260                         $data = array();
261                     }
262                     // Add our keys to them with the current cache timestamp.
263                     foreach ($keys as $key) {
264                         $data[$key] = cache::now();
265                     }
266                     // Set that data back to the cache.
267                     $cache->set($event, $data);
268                     // This only needs to occur once.
269                     $invalidationeventset = true;
270                 }
271             }
272         }
273     }
275     /**
276      * Purges the cache for a specific definition.
277      *
278      * If you need to purge a definition that requires identifiers or an aggregate and you don't
279      * know the details of those please use cache_helper::purge_stores_used_by_definition instead.
280      * It is a more aggressive purge and will purge all data within the store, not just the data
281      * belonging to the given definition.
282      *
283      * @todo MDL-36660: Change the signature: $aggregate must be added.
284      *
285      * @param string $component
286      * @param string $area
287      * @param array $identifiers
288      * @return bool
289      */
290     public static function purge_by_definition($component, $area, array $identifiers = array()) {
291         // Create the cache.
292         $cache = cache::make($component, $area, $identifiers);
293         // Initialise, in case of a store.
294         if ($cache instanceof cache_store) {
295             $factory = cache_factory::instance();
296             // TODO MDL-36660: Providing $aggregate is required for purging purposes: $definition->get_id()
297             $definition = $factory->create_definition($component, $area, null);
298             $definition->set_identifiers($identifiers);
299             $cache->initialise($definition);
300         }
301         // Purge baby, purge.
302         $cache->purge();
303         return true;
304     }
306     /**
307      * Purges a cache of all information on a given event.
308      *
309      * @param string $event
310      */
311     public static function purge_by_event($event) {
312         $instance = cache_config::instance();
313         $invalidationeventset = false;
314         $factory = cache_factory::instance();
315         foreach ($instance->get_definitions() as $name => $definitionarr) {
316             $definition = cache_definition::load($name, $definitionarr);
317             if ($definition->invalidates_on_event($event)) {
318                 // Check if this definition would result in a persistent loader being in use.
319                 if ($definition->should_be_persistent()) {
320                     // There may be a persistent cache loader. Lets purge that first so that any persistent data is removed.
321                     $cache = $factory->create_cache_from_definition($definition->get_component(), $definition->get_area());
322                     $cache->purge();
323                 }
324                 // Get all of the store instances that are in use for this store.
325                 $stores = $factory->get_store_instances_in_use($definition);
326                 foreach ($stores as $store) {
327                     // Purge each store individually.
328                     $store->purge();
329                 }
330                 // We need to flag the event in the "Event invalidation" cache if it hasn't already happened.
331                 if ($invalidationeventset === false) {
332                     // Get the event invalidation cache.
333                     $cache = cache::make('core', 'eventinvalidation');
334                     // Create a key to invalidate all.
335                     $data = array(
336                         'purged' => cache::now()
337                     );
338                     // Set that data back to the cache.
339                     $cache->set($event, $data);
340                     // This only needs to occur once.
341                     $invalidationeventset = true;
342                 }
343             }
344         }
345     }
347     /**
348      * Ensure that the stats array is ready to collect information for the given store and definition.
349      * @param string $store
350      * @param string $definition
351      */
352     protected static function ensure_ready_for_stats($store, $definition) {
353         if (!array_key_exists($definition, self::$stats)) {
354             self::$stats[$definition] = array(
355                 $store => array(
356                     'hits' => 0,
357                     'misses' => 0,
358                     'sets' => 0,
359                 )
360             );
361         } else if (!array_key_exists($store, self::$stats[$definition])) {
362             self::$stats[$definition][$store] = array(
363                 'hits' => 0,
364                 'misses' => 0,
365                 'sets' => 0,
366             );
367         }
368     }
370     /**
371      * Record a cache hit in the stats for the given store and definition.
372      *
373      * @param string $store
374      * @param string $definition
375      */
376     public static function record_cache_hit($store, $definition) {
377         self::ensure_ready_for_stats($store, $definition);
378         self::$stats[$definition][$store]['hits']++;
379     }
381     /**
382      * Record a cache miss in the stats for the given store and definition.
383      *
384      * @param string $store
385      * @param string $definition
386      */
387     public static function record_cache_miss($store, $definition) {
388         self::ensure_ready_for_stats($store, $definition);
389         self::$stats[$definition][$store]['misses']++;
390     }
392     /**
393      * Record a cache set in the stats for the given store and definition.
394      *
395      * @param string $store
396      * @param string $definition
397      */
398     public static function record_cache_set($store, $definition) {
399         self::ensure_ready_for_stats($store, $definition);
400         self::$stats[$definition][$store]['sets']++;
401     }
403     /**
404      * Return the stats collected so far.
405      * @return array
406      */
407     public static function get_stats() {
408         return self::$stats;
409     }
411     /**
412      * Purge all of the cache stores of all of their data.
413      *
414      * Think twice before calling this method. It will purge **ALL** caches regardless of whether they have been used recently or
415      * anything. This will involve full setup of the cache + the purge operation. On a site using caching heavily this WILL be
416      * painful.
417      *
418      * @param bool $usewriter If set to true the cache_config_writer class is used. This class is special as it avoids
419      *      it is still usable when caches have been disabled.
420      *      Please use this option only if you really must. It's purpose is to allow the cache to be purged when it would be
421      *      otherwise impossible.
422      */
423     public static function purge_all($usewriter = false) {
424         $factory = cache_factory::instance();
425         $config = $factory->create_config_instance($usewriter);
426         foreach ($config->get_all_stores() as $store) {
427             self::purge_store($store['name'], $config);
428         }
429     }
431     /**
432      * Purges a store given its name.
433      *
434      * @param string $storename
435      * @param cache_config $config
436      * @return bool
437      */
438     public static function purge_store($storename, cache_config $config = null) {
439         if ($config === null) {
440             $config = cache_config::instance();
441         }
443         $stores = $config->get_all_stores();
444         if (!array_key_exists($storename, $stores)) {
445             // The store does not exist.
446             return false;
447         }
449         $store = $stores[$storename];
450         $class = $store['class'];
452         // Found the store: is it ready?
453         $instance = new $class($store['name'], $store['configuration']);
454         if (!$instance->is_ready()) {
455             unset($instance);
456             return false;
457         }
459         foreach ($config->get_definitions_by_store($storename) as $id => $definition) {
460             $definition = cache_definition::load($id, $definition);
461             $definitioninstance = clone($instance);
462             $definitioninstance->initialise($definition);
463             $definitioninstance->purge();
464             unset($definitioninstance);
465         }
467         return true;
468     }
470     /**
471      * Purges all of the stores used by a definition.
472      *
473      * Unlike cache_helper::purge_by_definition this purges all of the data from the stores not
474      * just the data relating to the definition.
475      * This function is useful when you must purge a definition that requires setup but you don't
476      * want to set it up.
477      *
478      * @param string $component
479      * @param string $area
480      */
481     public static function purge_stores_used_by_definition($component, $area) {
482         $factory = cache_factory::instance();
483         $config = $factory->create_config_instance();
484         $definition = $factory->create_definition($component, $area);
485         $stores = $config->get_stores_for_definition($definition);
486         foreach ($stores as $store) {
487             self::purge_store($store['name']);
488         }
489     }
491     /**
492      * Returns the translated name of the definition.
493      *
494      * @param cache_definition $definition
495      * @return lang_string
496      */
497     public static function get_definition_name($definition) {
498         if ($definition instanceof cache_definition) {
499             return $definition->get_name();
500         }
501         $identifier = 'cachedef_'.clean_param($definition['area'], PARAM_STRINGID);
502         $component = $definition['component'];
503         if ($component === 'core') {
504             $component = 'cache';
505         }
506         return new lang_string($identifier, $component);
507     }
509     /**
510      * Hashes a descriptive key to make it shorter and still unique.
511      * @param string|int $key
512      * @param cache_definition $definition
513      * @return string
514      */
515     public static function hash_key($key, cache_definition $definition) {
516         if ($definition->uses_simple_keys()) {
517             if (debugging() && preg_match('#[^a-zA-Z0-9_]#', $key)) {
518                 throw new coding_exception('Cache definition '.$definition->get_id().' requires simple keys. Invalid key provided.', $key);
519             }
520             // We put the key first so that we can be sure the start of the key changes.
521             return (string)$key . '-' . $definition->generate_single_key_prefix();
522         }
523         $key = $definition->generate_single_key_prefix() . '-' . $key;
524         return sha1($key);
525     }
527     /**
528      * Finds all definitions and updates them within the cache config file.
529      *
530      * @param bool $coreonly If set to true only core definitions will be updated.
531      */
532     public static function update_definitions($coreonly = false) {
533         global $CFG;
534         // Include locallib.
535         require_once($CFG->dirroot.'/cache/locallib.php');
536         // First update definitions
537         cache_config_writer::update_definitions($coreonly);
538         // Second reset anything we have already initialised to ensure we're all up to date.
539         cache_factory::reset();
540     }
542     /**
543      * Update the site identifier stored by the cache API.
544      *
545      * @param string $siteidentifier
546      * @return string The new site identifier.
547      */
548     public static function update_site_identifier($siteidentifier) {
549         global $CFG;
550         // Include locallib.
551         require_once($CFG->dirroot.'/cache/locallib.php');
552         $factory = cache_factory::instance();
553         $factory->updating_started();
554         $config = $factory->create_config_instance(true);
555         $siteidentifier = $config->update_site_identifier($siteidentifier);
556         $factory->updating_finished();
557         cache_factory::reset();
558         return $siteidentifier;
559     }
561     /**
562      * Returns the site identifier.
563      *
564      * @return string
565      */
566     public static function get_site_identifier() {
567         global $CFG;
568         if (!is_null(self::$siteidentifier)) {
569             return self::$siteidentifier;
570         }
571         // If site identifier hasn't been collected yet attempt to get it from the cache config.
572         $factory = cache_factory::instance();
573         // If the factory is initialising then we don't want to try to get it from the config or we risk
574         // causing the cache to enter an infinite initialisation loop.
575         if (!$factory->is_initialising()) {
576             $config = $factory->create_config_instance();
577             self::$siteidentifier = $config->get_site_identifier();
578         }
579         if (is_null(self::$siteidentifier)) {
580             // If the site identifier is still null then config isn't aware of it yet.
581             // We'll see if the CFG is loaded, and if not we will just use unknown.
582             // It's very important here that we don't use get_config. We don't want an endless cache loop!
583             if (!empty($CFG->siteidentifier)) {
584                 self::$siteidentifier = self::update_site_identifier($CFG->siteidentifier);
585             } else {
586                 // It's not being recorded in MUC's config and the config data hasn't been loaded yet.
587                 // Likely we are initialising.
588                 return 'unknown';
589             }
590         }
591         return self::$siteidentifier;
592     }
594     /**
595      * Returns the site version.
596      *
597      * @return string
598      */
599     public static function get_site_version() {
600         global $CFG;
601         return (string)$CFG->version;
602     }
604     /**
605      * Runs cron routines for MUC.
606      */
607     public static function cron() {
608         self::clean_old_session_data(true);
609     }
611     /**
612      * Cleans old session data from cache stores used for session based definitions.
613      *
614      * @param bool $output If set to true output will be given.
615      */
616     public static function clean_old_session_data($output = false) {
617         global $CFG;
618         if ($output) {
619             mtrace('Cleaning up stale session data from cache stores.');
620         }
621         $factory = cache_factory::instance();
622         $config = $factory->create_config_instance();
623         $definitions = $config->get_definitions();
624         $purgetime = time() - $CFG->sessiontimeout;
625         foreach ($definitions as $definitionarray) {
626             // We are only interested in session caches.
627             if (!($definitionarray['mode'] & cache_store::MODE_SESSION)) {
628                 continue;
629             }
630             $definition = $factory->create_definition($definitionarray['component'], $definitionarray['area']);
631             $stores = $config->get_stores_for_definition($definition);
632             // Turn them into store instances.
633             $stores = self::initialise_cachestore_instances($stores, $definition);
634             // Initialise all of the stores used for that definition.
635             foreach ($stores as $store) {
636                 // If the store doesn't support searching we can skip it.
637                 if (!($store instanceof cache_is_searchable)) {
638                     debugging('Cache stores used for session definitions should ideally be searchable.', DEBUG_DEVELOPER);
639                     continue;
640                 }
641                 // Get all of the keys.
642                 $keys = $store->find_by_prefix(cache_session::KEY_PREFIX);
643                 $todelete = array();
644                 foreach ($store->get_many($keys) as $key => $value) {
645                     if (strpos($key, cache_session::KEY_PREFIX) !== 0 || !is_array($value) || !isset($value['lastaccess'])) {
646                         continue;
647                     }
648                     if ((int)$value['lastaccess'] < $purgetime || true) {
649                         $todelete[] = $key;
650                     }
651                 }
652                 if (count($todelete)) {
653                     $outcome = (int)$store->delete_many($todelete);
654                     if ($output) {
655                         $strdef = s($definition->get_id());
656                         $strstore = s($store->my_name());
657                         mtrace("- Removed {$outcome} old {$strdef} sessions from the '{$strstore}' cache store.");
658                     }
659                 }
660             }
661         }
662     }