954267ea660f337248baa2a178f39e6c248ae13c
[moodle.git] / cache / classes / factory.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  * This file contains the cache factory 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 factory class.
33  *
34  * This factory class is important because it stores instances of objects used by the cache API and returns them upon requests.
35  * This allows us to both reuse objects saving on overhead, and gives us an easy place to "reset" the cache API in situations that
36  * we need such as unit testing.
37  *
38  * @copyright  2012 Sam Hemelryk
39  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
40  */
41 class cache_factory {
43     /** The cache has not been initialised yet. */
44     const STATE_UNINITIALISED = 0;
45     /** The cache is in the process of initialising itself. */
46     const STATE_INITIALISING = 1;
47     /** The cache is in the process of saving its configuration file. */
48     const STATE_SAVING = 2;
49     /** The cache is ready to use. */
50     const STATE_READY = 3;
51     /** The cache is currently updating itself */
52     const STATE_UPDATING = 4;
53     /** The cache encountered an error while initialising. */
54     const STATE_ERROR_INITIALISING = 9;
55     /** The cache has been disabled. */
56     const STATE_DISABLED = 10;
57     /** The cache stores have been disabled */
58     const STATE_STORES_DISABLED = 11;
60     /**
61      * An instance of the cache_factory class created upon the first request.
62      * @var cache_factory
63      */
64     protected static $instance;
66     /**
67      * An array containing caches created for definitions
68      * @var array
69      */
70     protected $cachesfromdefinitions = array();
72     /**
73      * Array of caches created by parameters, ad-hoc definitions will have been used.
74      * @var array
75      */
76     protected $cachesfromparams = array();
78     /**
79      * An array of stores organised by definitions.
80      * @var array
81      */
82     protected $definitionstores = array();
84     /**
85      * An array of instantiated stores.
86      * @var array
87      */
88     protected $stores = array();
90     /**
91      * An array of configuration instances
92      * @var array
93      */
94     protected $configs = array();
96     /**
97      * An array of initialised definitions
98      * @var array
99      */
100     protected $definitions = array();
102     /**
103      * An array of lock plugins.
104      * @var array
105      */
106     protected $lockplugins = array();
108     /**
109      * The current state of the cache API.
110      * @var int
111      */
112     protected $state = 0;
114     /**
115      * Returns an instance of the cache_factor method.
116      *
117      * @param bool $forcereload If set to true a new cache_factory instance will be created and used.
118      * @return cache_factory
119      */
120     public static function instance($forcereload = false) {
121         global $CFG;
122         if ($forcereload || self::$instance === null) {
123             // Initialise a new factory to facilitate our needs.
124             if (defined('CACHE_DISABLE_ALL') && CACHE_DISABLE_ALL !== false) {
125                 // The cache has been disabled. Load disabledlib and start using the factory designed to handle this
126                 // situation. It will use disabled alternatives where available.
127                 require_once($CFG->dirroot.'/cache/disabledlib.php');
128                 self::$instance = new cache_factory_disabled();
129             } else {
130                 // We're using the regular factory.
131                 self::$instance = new cache_factory();
132                 if (defined('CACHE_DISABLE_STORES') && CACHE_DISABLE_STORES !== false) {
133                     // The cache stores have been disabled.
134                     self::$instance->set_state(self::STATE_STORES_DISABLED);
135                 }
136             }
137         }
138         return self::$instance;
139     }
141     /**
142      * Protected constructor, please use the static instance method.
143      */
144     protected function __construct() {
145         // Nothing to do here.
146     }
148     /**
149      * Resets the arrays containing instantiated caches, stores, and config instances.
150      */
151     public static function reset() {
152         $factory = self::instance();
153         $factory->reset_cache_instances();
154         $factory->configs = array();
155         $factory->definitions = array();
156         $factory->lockplugins = array(); // MUST be null in order to force its regeneration.
157         // Reset the state to uninitialised.
158         $factory->state = self::STATE_UNINITIALISED;
159     }
161     /**
162      * Resets the stores, clearing the array of created stores.
163      *
164      * Cache objects still held onto by the code that initialised them will remain as is
165      * however all future requests for a cache/store will lead to a new instance being re-initialised.
166      */
167     public function reset_cache_instances() {
168         $this->cachesfromdefinitions = array();
169         $this->cachesfromparams = array();
170         $this->stores = array();
171     }
173     /**
174      * Creates a cache object given the parameters for a definition.
175      *
176      * If a cache has already been created for the given definition then that cache instance will be returned.
177      *
178      * @param string $component
179      * @param string $area
180      * @param array $identifiers
181      * @param string $aggregate
182      * @return cache_application|cache_session|cache_request
183      */
184     public function create_cache_from_definition($component, $area, array $identifiers = array(), $aggregate = null) {
185         $definitionname = $component.'/'.$area;
186         if (isset($this->cachesfromdefinitions[$definitionname])) {
187             $cache = $this->cachesfromdefinitions[$definitionname];
188             $cache->set_identifiers($identifiers);
189             return $cache;
190         }
191         $definition = $this->create_definition($component, $area, $aggregate);
192         $definition->set_identifiers($identifiers);
193         $cache = $this->create_cache($definition, $identifiers);
194         // Loaders are always held onto to speed up subsequent requests.
195         $this->cachesfromdefinitions[$definitionname] = $cache;
196         return $cache;
197     }
199     /**
200      * Creates an ad-hoc cache from the given param.
201      *
202      * If a cache has already been created using the same params then that cache instance will be returned.
203      *
204      * @param int $mode
205      * @param string $component
206      * @param string $area
207      * @param array $identifiers
208      * @param array $options An array of options, available options are:
209      *   - simplekeys : Set to true if the keys you will use are a-zA-Z0-9_
210      *   - simpledata : Set to true if the type of the data you are going to store is scalar, or an array of scalar vars
211      *   - staticacceleration : If set to true the cache will hold onto data passing through it.
212      *   - staticaccelerationsize : The maximum number of items to hold onto for acceleration purposes.
213      * @return cache_application|cache_session|cache_request
214      */
215     public function create_cache_from_params($mode, $component, $area, array $identifiers = array(), array $options = array()) {
216         $key = "{$mode}_{$component}_{$area}";
217         if (array_key_exists($key, $this->cachesfromparams)) {
218             return $this->cachesfromparams[$key];
219         }
220         $definition = cache_definition::load_adhoc($mode, $component, $area, $options);
221         $definition->set_identifiers($identifiers);
222         $cache = $this->create_cache($definition, $identifiers);
223         $this->cachesfromparams[$key] = $cache;
224         return $cache;
225     }
227     /**
228      * Common public method to create a cache instance given a definition.
229      *
230      * This is used by the static make methods.
231      *
232      * @param cache_definition $definition
233      * @return cache_application|cache_session|cache_store
234      * @throws coding_exception
235      */
236     public function create_cache(cache_definition $definition) {
237         $class = $definition->get_cache_class();
238         $stores = cache_helper::get_stores_suitable_for_definition($definition);
239         foreach ($stores as $key => $store) {
240             if (!$store::are_requirements_met()) {
241                 unset($stores[$key]);
242             }
243         }
244         if (count($stores) === 0) {
245             // Hmm still no stores, better provide a dummy store to mimic functionality. The dev will be none the wiser.
246             $stores[] = $this->create_dummy_store($definition);
247         }
248         $loader = null;
249         if ($definition->has_data_source()) {
250             $loader = $definition->get_data_source();
251         }
252         while (($store = array_pop($stores)) !== null) {
253             $loader = new $class($definition, $store, $loader);
254         }
255         return $loader;
256     }
258     /**
259      * Creates a store instance given its name and configuration.
260      *
261      * If the store has already been instantiated then the original object will be returned. (reused)
262      *
263      * @param string $name The name of the store (must be unique remember)
264      * @param array $details
265      * @param cache_definition $definition The definition to instantiate it for.
266      * @return boolean|cache_store
267      */
268     public function create_store_from_config($name, array $details, cache_definition $definition) {
269         if (!array_key_exists($name, $this->stores)) {
270             // Properties: name, plugin, configuration, class.
271             $class = $details['class'];
272             $store = new $class($details['name'], $details['configuration']);
273             $this->stores[$name] = $store;
274         }
275         /* @var cache_store $store */
276         $store = $this->stores[$name];
277         if (!$store::are_requirements_met() || !$store->is_ready() || !$store->is_supported_mode($definition->get_mode())) {
278             return false;
279         }
280         // We always create a clone of the original store.
281         // If we were to clone a store that had already been initialised with a definition then
282         // we'd run into a myriad of issues.
283         // We use a method of the store to create a clone rather than just creating it ourselves
284         // so that if any store out there doesn't handle cloning they can override this method in
285         // order to address the issues.
286         $store = $this->stores[$name]->create_clone($details);
287         $store->initialise($definition);
288         $definitionid = $definition->get_id();
289         if (!isset($this->definitionstores[$definitionid])) {
290             $this->definitionstores[$definitionid] = array();
291         }
292         $this->definitionstores[$definitionid][] = $store;
293         return $store;
294     }
296     /**
297      * Returns an array of cache stores that have been initialised for use in definitions.
298      * @param cache_definition $definition
299      * @return array
300      */
301     public function get_store_instances_in_use(cache_definition $definition) {
302         $id = $definition->get_id();
303         if (!isset($this->definitionstores[$id])) {
304             return array();
305         }
306         return $this->definitionstores[$id];
307     }
309     /**
310      * Returns the cache instances that have been used within this request.
311      * @since 2.6
312      * @return array
313      */
314     public function get_caches_in_use() {
315         return $this->cachesfromdefinitions;
316     }
318     /**
319      * Creates a cache config instance with the ability to write if required.
320      *
321      * @param bool $writer If set to true an instance that can update the configuration will be returned.
322      * @return cache_config|cache_config_writer
323      */
324     public function create_config_instance($writer = false) {
325         global $CFG;
327         // Check if we need to create a config file with defaults.
328         $needtocreate = !cache_config::config_file_exists();
330         // The class to use.
331         $class = 'cache_config';
332         if ($writer || $needtocreate) {
333             require_once($CFG->dirroot.'/cache/locallib.php');
334             $class .= '_writer';
335         }
337         // Check if this is a PHPUnit test and redirect to the phpunit config classes if it is.
338         if (defined('PHPUNIT_TEST') && PHPUNIT_TEST) {
339             require_once($CFG->dirroot.'/cache/locallib.php');
340             require_once($CFG->dirroot.'/cache/tests/fixtures/lib.php');
341             // We have just a single class for PHP unit tests. We don't care enough about its
342             // performance to do otherwise and having a single method allows us to inject things into it
343             // while testing.
344             $class = 'cache_config_phpunittest';
345         }
347         $error = false;
348         if ($needtocreate) {
349             // Create the default configuration.
350             // Update the state, we are now initialising the cache.
351             self::set_state(self::STATE_INITIALISING);
352             $configuration = $class::create_default_configuration();
353             if ($configuration !== true) {
354                 // Failed to create the default configuration. Disable the cache stores and update the state.
355                 self::set_state(self::STATE_ERROR_INITIALISING);
356                 $this->configs[$class] = new $class;
357                 $this->configs[$class]->load($configuration);
358                 $error = true;
359             }
360         }
362         if (!array_key_exists($class, $this->configs)) {
363             // Create a new instance and call it to load it.
364             $this->configs[$class] = new $class;
365             $this->configs[$class]->load();
366         }
368         if (!$error) {
369             // The cache is now ready to use. Update the state.
370             self::set_state(self::STATE_READY);
371         }
373         // Return the instance.
374         return $this->configs[$class];
375     }
377     /**
378      * Creates a definition instance or returns the existing one if it has already been created.
379      * @param string $component
380      * @param string $area
381      * @param string $aggregate
382      * @return cache_definition
383      */
384     public function create_definition($component, $area, $aggregate = null) {
385         $id = $component.'/'.$area;
386         if ($aggregate) {
387             $id .= '::'.$aggregate;
388         }
389         if (!isset($this->definitions[$id])) {
390             // This is the first time this definition has been requested.
391             if ($this->is_initialising()) {
392                 // We're initialising the cache right now. Don't try to create another config instance.
393                 // We'll just use an ad-hoc cache for the time being.
394                 $definition = cache_definition::load_adhoc(cache_store::MODE_REQUEST, $component, $area);
395             } else {
396                 // Load all the known definitions and find the desired one.
397                 $instance = $this->create_config_instance();
398                 $definition = $instance->get_definition_by_id($id);
399                 if (!$definition) {
400                     // Oh-oh the definition doesn't exist.
401                     // There are several things that could be going on here.
402                     // We may be installing/upgrading a site and have hit a definition that hasn't been used before.
403                     // Of the developer may be trying to use a newly created definition.
404                     if ($this->is_updating()) {
405                         // The cache is presently initialising and the requested cache definition has not been found.
406                         // This means that the cache initialisation has requested something from a cache (I had recursive nightmares about this).
407                         // To serve this purpose and avoid errors we are going to make use of an ad-hoc cache rather than
408                         // search for the definition which would possibly cause an infitite loop trying to initialise the cache.
409                         $definition = cache_definition::load_adhoc(cache_store::MODE_REQUEST, $component, $area);
410                         if ($aggregate !== null) {
411                             // If you get here you deserve a warning. We have to use an ad-hoc cache here, so we can't find the definition and therefor
412                             // can't find any information about the datasource or any of its aggregated.
413                             // Best of luck.
414                             debugging('An unknown cache was requested during development with an aggregate that could not be loaded. Ad-hoc cache used instead.', DEBUG_DEVELOPER);
415                             $aggregate = null;
416                         }
417                     } else {
418                         // Either a typo of the developer has just created the definition and is using it for the first time.
419                         $this->reset();
420                         $instance = $this->create_config_instance(true);
421                         $instance->update_definitions();
422                         $definition = $instance->get_definition_by_id($id);
423                         if (!$definition) {
424                             throw new coding_exception('The requested cache definition does not exist.'. $id, $id);
425                         } else if (!$this->is_disabled()) {
426                             debugging('Cache definitions reparsed causing cache reset in order to locate definition.
427                                 You should bump the version number to ensure definitions are reprocessed.', DEBUG_DEVELOPER);
428                         }
429                         $definition = cache_definition::load($id, $definition, $aggregate);
430                     }
431                 } else {
432                     $definition = cache_definition::load($id, $definition, $aggregate);
433                 }
434             }
435             $this->definitions[$id] = $definition;
436         }
437         return $this->definitions[$id];
438     }
440     /**
441      * Creates a dummy store object for use when a loader has no potential stores to use.
442      *
443      * @param cache_definition $definition
444      * @return cachestore_dummy
445      */
446     protected function create_dummy_store(cache_definition $definition) {
447         global $CFG;
448         require_once($CFG->dirroot.'/cache/classes/dummystore.php');
449         $store = new cachestore_dummy();
450         $store->initialise($definition);
451         return $store;
452     }
454     /**
455      * Returns a lock instance ready for use.
456      *
457      * @param array $config
458      * @return cache_lock_interface
459      */
460     public function create_lock_instance(array $config) {
461         global $CFG;
462         if (!array_key_exists('name', $config) || !array_key_exists('type', $config)) {
463             throw new coding_exception('Invalid cache lock instance provided');
464         }
465         $name = $config['name'];
466         $type = $config['type'];
467         unset($config['name']);
468         unset($config['type']);
470         if (!isset($this->lockplugins[$type])) {
471             $pluginname = substr($type, 10);
472             $file = $CFG->dirroot."/cache/locks/{$pluginname}/lib.php";
473             if (file_exists($file) && is_readable($file)) {
474                 require_once($file);
475             }
476             if (!class_exists($type)) {
477                 throw new coding_exception('Invalid lock plugin requested.');
478             }
479             $this->lockplugins[$type] = $type;
480         }
481         if (!array_key_exists($type, $this->lockplugins)) {
482             throw new coding_exception('Invalid cache lock type.');
483         }
484         $class = $this->lockplugins[$type];
485         return new $class($name, $config);
486     }
488     /**
489      * Returns the current state of the cache API.
490      *
491      * @return int
492      */
493     public function get_state() {
494         return $this->state;
495     }
497     /**
498      * Updates the state fo the cache API.
499      *
500      * @param int $state
501      * @return bool
502      */
503     public function set_state($state) {
504         if ($state <= $this->state) {
505             return false;
506         }
507         $this->state = $state;
508         return true;
509     }
511     /**
512      * Informs the factory that the cache is currently updating itself.
513      *
514      * This forces the state to upgrading and can only be called once the cache is ready to use.
515      * Calling it ensure we don't try to reinstantite things when requesting cache definitions that don't exist yet.
516      */
517     public function updating_started() {
518         if ($this->state !== self::STATE_READY) {
519             return false;
520         }
521         $this->state = self::STATE_UPDATING;
522         return true;
523     }
525     /**
526      * Informs the factory that the upgrading has finished.
527      *
528      * This forces the state back to ready.
529      */
530     public function updating_finished() {
531         $this->state = self::STATE_READY;
532     }
534     /**
535      * Returns true if the cache API has been disabled.
536      *
537      * @return bool
538      */
539     public function is_disabled() {
540         return $this->state === self::STATE_DISABLED;
541     }
543     /**
544      * Returns true if the cache is currently initialising itself.
545      *
546      * This includes both initialisation and saving the cache config file as part of that initialisation.
547      *
548      * @return bool
549      */
550     public function is_initialising() {
551         return $this->state === self::STATE_INITIALISING || $this->state === self::STATE_SAVING;
552     }
554     /**
555      * Returns true if the cache is currently updating itself.
556      *
557      * @return bool
558      */
559     public function is_updating() {
560         return $this->state === self::STATE_UPDATING;
561     }
563     /**
564      * Disables as much of the cache API as possible.
565      *
566      * All of the magic associated with the disabled cache is wrapped into this function.
567      * In switching out the factory for the disabled factory it gains full control over the initialisation of objects
568      * and can use all of the disabled alternatives.
569      * Simple!
570      *
571      * This function has been marked as protected so that it cannot be abused through the public API presently.
572      * Perhaps in the future we will allow this, however as per the build up to the first release containing
573      * MUC it was decided that this was just to risky and abusable.
574      */
575     protected static function disable() {
576         global $CFG;
577         require_once($CFG->dirroot.'/cache/disabledlib.php');
578         self::$instance = new cache_factory_disabled();
579     }
581     /**
582      * Returns true if the cache stores have been disabled.
583      *
584      * @return bool
585      */
586     public function stores_disabled() {
587         return $this->state === self::STATE_STORES_DISABLED || $this->is_disabled();
588     }
590     /**
591      * Disables cache stores.
592      *
593      * The cache API will continue to function however none of the actual stores will be used.
594      * Instead the dummy store will be provided for all cache requests.
595      * This is useful in situations where you cannot be sure any stores are working.
596      *
597      * In order to re-enable the cache you must call the cache factories static reset method:
598      * <code>
599      * // Disable the cache factory.
600      * cache_factory::disable_stores();
601      * // Re-enable the cache factory by resetting it.
602      * cache_factory::reset();
603      * </code>
604      */
605     public static function disable_stores() {
606         // First reset to clear any static acceleration array.
607         $factory = self::instance();
608         $factory->reset_cache_instances();
609         $factory->set_state(self::STATE_STORES_DISABLED);
610     }