MDL-43033 cache: added a warning icon for mappings
[moodle.git] / cache / locallib.php
CommitLineData
8139ad13
SH
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/>.
16
17/**
18 * The supplementary cache API.
19 *
20 * This file is part of Moodle's cache API, affectionately called MUC.
21 * It contains elements of the API that are not required in order to use caching.
22 * Things in here are more in line with administration and management of the cache setup and configuration.
23 *
24 * @package core
25 * @category cache
26 * @copyright 2012 Sam Hemelryk
27 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
28 */
29
30defined('MOODLE_INTERNAL') || die();
31
32/**
33 * Cache configuration writer.
34 *
35 * This class should only be used when you need to write to the config, all read operations exist within the cache_config.
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 */
42class cache_config_writer extends cache_config {
43
7383a7e2
SH
44 /**
45 * Switch that gets set to true when ever a cache_config_writer instance is saving the cache configuration file.
46 * If this is set to true when save is next called we must avoid the trying to save and instead return the
47 * generated config so that is may be used instead of the file.
48 * @var bool
49 */
50 protected static $creatingconfig = false;
51
8139ad13
SH
52 /**
53 * Returns an instance of the configuration writer.
54 *
55 * @return cache_config_writer
56 */
57 public static function instance() {
58 $factory = cache_factory::instance();
59 return $factory->create_config_instance(true);
60 }
61
62 /**
63 * Saves the current configuration.
7383a7e2
SH
64 *
65 * Exceptions within this function are tolerated but must be of type cache_exception.
66 * They are caught during initialisation and written to the error log. This is required in order to avoid
67 * infinite loop situations caused by the cache throwing exceptions during its initialisation.
8139ad13
SH
68 */
69 protected function config_save() {
70 global $CFG;
71 $cachefile = self::get_config_file_path();
72 $directory = dirname($cachefile);
73 if ($directory !== $CFG->dataroot && !file_exists($directory)) {
74 $result = make_writable_directory($directory, false);
75 if (!$result) {
7383a7e2 76 throw new cache_exception('ex_configcannotsave', 'cache', '', null, 'Cannot create config directory. Check the permissions on your moodledata directory.');
8139ad13
SH
77 }
78 }
79 if (!file_exists($directory) || !is_writable($directory)) {
7383a7e2 80 throw new cache_exception('ex_configcannotsave', 'cache', '', null, 'Config directory is not writable. Check the permissions on the moodledata/muc directory.');
8139ad13
SH
81 }
82
83 // Prepare a configuration array to store.
7383a7e2 84 $configuration = $this->generate_configuration_array();
8139ad13
SH
85
86 // Prepare the file content.
87 $content = "<?php defined('MOODLE_INTERNAL') || die();\n \$configuration = ".var_export($configuration, true).";";
88
34c84c72
SH
89 // We need to create a temporary cache lock instance for use here. Remember we are generating the config file
90 // it doesn't exist and thus we can't use the normal API for this (it'll just try to use config).
573a6c8e
SH
91 $lockconf = reset($this->configlocks);
92 if ($lockconf === false) {
93 debugging('Your cache configuration file is out of date and needs to be refreshed.', DEBUG_DEVELOPER);
94 // Use the default
95 $lockconf = array(
96 'name' => 'cachelock_file_default',
97 'type' => 'cachelock_file',
98 'dir' => 'filelocks',
99 'default' => true
100 );
101 }
34c84c72 102 $factory = cache_factory::instance();
573a6c8e 103 $locking = $factory->create_lock_instance($lockconf);
34c84c72
SH
104 if ($locking->lock('configwrite', 'config', true)) {
105 // Its safe to use w mode here because we have already acquired the lock.
8139ad13
SH
106 $handle = fopen($cachefile, 'w');
107 fwrite($handle, $content);
108 fflush($handle);
109 fclose($handle);
34c84c72 110 $locking->unlock('configwrite', 'config');
eb459f71 111 @chmod($cachefile, $CFG->filepermissions);
c05a5099
PS
112 // Tell PHP to recompile the script.
113 core_component::invalidate_opcode_php_cache($cachefile);
8139ad13
SH
114 } else {
115 throw new cache_exception('ex_configcannotsave', 'cache', '', null, 'Unable to open the cache config file.');
116 }
117 }
118
7383a7e2
SH
119 /**
120 * Generates a configuration array suitable to be written to the config file.
121 * @return array
122 */
123 protected function generate_configuration_array() {
124 $configuration = array();
7866b094 125 $configuration['siteidentifier'] = $this->siteidentifier;
7383a7e2
SH
126 $configuration['stores'] = $this->configstores;
127 $configuration['modemappings'] = $this->configmodemappings;
128 $configuration['definitions'] = $this->configdefinitions;
129 $configuration['definitionmappings'] = $this->configdefinitionmappings;
130 $configuration['locks'] = $this->configlocks;
131 return $configuration;
132 }
133
8139ad13
SH
134 /**
135 * Adds a plugin instance.
136 *
137 * This function also calls save so you should redirect immediately, or at least very shortly after
138 * calling this method.
139 *
140 * @param string $name The name for the instance (must be unique)
141 * @param string $plugin The name of the plugin.
142 * @param array $configuration The configuration data for the plugin instance.
143 * @return bool
144 * @throws cache_exception
145 */
26ce56fd 146 public function add_store_instance($name, $plugin, array $configuration = array()) {
8139ad13
SH
147 if (array_key_exists($name, $this->configstores)) {
148 throw new cache_exception('Duplicate name specificed for cache plugin instance. You must provide a unique name.');
149 }
6fec1820 150 $class = 'cachestore_'.$plugin;
8139ad13 151 if (!class_exists($class)) {
d0cac8b5 152 $plugins = core_component::get_plugin_list_with_file('cachestore', 'lib.php');
8139ad13 153 if (!array_key_exists($plugin, $plugins)) {
170f821b 154 throw new cache_exception('Invalid plugin name specified. The plugin does not exist or is not valid.');
8139ad13
SH
155 }
156 $file = $plugins[$plugin];
157 if (file_exists($file)) {
158 require_once($file);
159 }
160 if (!class_exists($class)) {
161 throw new cache_exception('Invalid cache plugin specified. The plugin does not contain the required class.');
162 }
163 }
d4797177 164 $reflection = new ReflectionClass($class);
75cde6b9 165 if (!$reflection->isSubclassOf('cache_store')) {
8139ad13
SH
166 throw new cache_exception('Invalid cache plugin specified. The plugin does not extend the required class.');
167 }
168 if (!$class::are_requirements_met()) {
169 throw new cache_exception('Unable to add new cache plugin instance. The requested plugin type is not supported.');
170 }
171 $this->configstores[$name] = array(
172 'name' => $name,
173 'plugin' => $plugin,
174 'configuration' => $configuration,
175 'features' => $class::get_supported_features($configuration),
176 'modes' => $class::get_supported_modes($configuration),
42f2c59e
SH
177 'mappingsonly' => !empty($configuration['mappingsonly']),
178 'class' => $class,
179 'default' => false
8139ad13 180 );
167ad91e
SH
181 if (array_key_exists('lock', $configuration)) {
182 $this->configstores[$name]['lock'] = $configuration['lock'];
183 unset($this->configstores[$name]['configuration']['lock']);
184 }
730cf5ac
MS
185 // Call instance_created()
186 $store = new $class($name, $this->configstores[$name]['configuration']);
187 $store->instance_created();
188
8139ad13
SH
189 $this->config_save();
190 return true;
191 }
192
acf49f4b
SH
193 /**
194 * Adds a new lock instance to the config file.
195 *
196 * @param string $name The name the user gave the instance. PARAM_ALHPANUMEXT
197 * @param string $plugin The plugin we are creating an instance of.
198 * @param string $configuration Configuration data from the config instance.
199 * @throws cache_exception
200 */
201 public function add_lock_instance($name, $plugin, $configuration = array()) {
202 if (array_key_exists($name, $this->configlocks)) {
203 throw new cache_exception('Duplicate name specificed for cache lock instance. You must provide a unique name.');
204 }
205 $class = 'cachelock_'.$plugin;
206 if (!class_exists($class)) {
d0cac8b5 207 $plugins = core_component::get_plugin_list_with_file('cachelock', 'lib.php');
acf49f4b
SH
208 if (!array_key_exists($plugin, $plugins)) {
209 throw new cache_exception('Invalid lock name specified. The plugin does not exist or is not valid.');
210 }
211 $file = $plugins[$plugin];
212 if (file_exists($file)) {
213 require_once($file);
214 }
215 if (!class_exists($class)) {
216 throw new cache_exception('Invalid lock plugin specified. The plugin does not contain the required class.');
217 }
218 }
219 $reflection = new ReflectionClass($class);
220 if (!$reflection->implementsInterface('cache_lock_interface')) {
221 throw new cache_exception('Invalid lock plugin specified. The plugin does not implement the required interface.');
222 }
223 $this->configlocks[$name] = array_merge($configuration, array(
224 'name' => $name,
225 'type' => 'cachelock_'.$plugin,
226 'default' => false
227 ));
228 $this->config_save();
229 }
230
231 /**
232 * Deletes a lock instance given its name.
233 *
234 * @param string $name The name of the plugin, PARAM_ALPHANUMEXT.
235 * @return bool
236 * @throws cache_exception
237 */
238 public function delete_lock_instance($name) {
239 if (!array_key_exists($name, $this->configlocks)) {
240 throw new cache_exception('The requested store does not exist.');
241 }
242 if ($this->configlocks[$name]['default']) {
243 throw new cache_exception('You can not delete the default lock.');
244 }
245 foreach ($this->configstores as $store) {
246 if (isset($store['lock']) && $store['lock'] === $name) {
247 throw new cache_exception('You cannot delete a cache lock that is being used by a store.');
248 }
249 }
250 unset($this->configlocks[$name]);
251 $this->config_save();
252 return true;
253 }
254
8139ad13
SH
255 /**
256 * Sets the mode mappings.
257 *
258 * These determine the default caches for the different modes.
259 * This function also calls save so you should redirect immediately, or at least very shortly after
260 * calling this method.
261 *
262 * @param array $modemappings
263 * @return bool
264 * @throws cache_exception
265 */
266 public function set_mode_mappings(array $modemappings) {
267 $mappings = array(
268 cache_store::MODE_APPLICATION => array(),
269 cache_store::MODE_SESSION => array(),
270 cache_store::MODE_REQUEST => array(),
271 );
272 foreach ($modemappings as $mode => $stores) {
273 if (!array_key_exists($mode, $mappings)) {
274 throw new cache_exception('The cache mode for the new mapping does not exist');
275 }
276 $sort = 0;
277 foreach ($stores as $store) {
278 if (!array_key_exists($store, $this->configstores)) {
279 throw new cache_exception('The instance name for the new mapping does not exist');
280 }
281 if (array_key_exists($store, $mappings[$mode])) {
282 throw new cache_exception('This cache mapping already exists');
283 }
284 $mappings[$mode][] = array(
285 'store' => $store,
286 'mode' => $mode,
287 'sort' => $sort++
288 );
289 }
290 }
291 $this->configmodemappings = array_merge(
292 $mappings[cache_store::MODE_APPLICATION],
293 $mappings[cache_store::MODE_SESSION],
294 $mappings[cache_store::MODE_REQUEST]
295 );
296
297 $this->config_save();
298 return true;
299 }
300
301 /**
302 * Edits a give plugin instance.
303 *
42f2c59e 304 * The plugin instance is determined by its name, hence you cannot rename plugins.
8139ad13
SH
305 * This function also calls save so you should redirect immediately, or at least very shortly after
306 * calling this method.
307 *
308 * @param string $name
309 * @param string $plugin
310 * @param array $configuration
311 * @return bool
312 * @throws cache_exception
313 */
26ce56fd 314 public function edit_store_instance($name, $plugin, $configuration) {
8139ad13
SH
315 if (!array_key_exists($name, $this->configstores)) {
316 throw new cache_exception('The requested instance does not exist.');
317 }
d0cac8b5 318 $plugins = core_component::get_plugin_list_with_file('cachestore', 'lib.php');
8139ad13
SH
319 if (!array_key_exists($plugin, $plugins)) {
320 throw new cache_exception('Invalid plugin name specified. The plugin either does not exist or is not valid.');
321 }
42f2c59e 322 $class = 'cachestore_'.$plugin;
8139ad13
SH
323 $file = $plugins[$plugin];
324 if (!class_exists($class)) {
325 if (file_exists($file)) {
326 require_once($file);
327 }
328 if (!class_exists($class)) {
42f2c59e 329 throw new cache_exception('Invalid cache plugin specified. The plugin does not contain the required class.'.$class);
8139ad13
SH
330 }
331 }
332 $this->configstores[$name] = array(
333 'name' => $name,
334 'plugin' => $plugin,
335 'configuration' => $configuration,
336 'features' => $class::get_supported_features($configuration),
337 'modes' => $class::get_supported_modes($configuration),
42f2c59e
SH
338 'mappingsonly' => !empty($configuration['mappingsonly']),
339 'class' => $class,
340 'default' => $this->configstores[$name]['default'] // Can't change the default.
8139ad13 341 );
167ad91e
SH
342 if (array_key_exists('lock', $configuration)) {
343 $this->configstores[$name]['lock'] = $configuration['lock'];
344 unset($this->configstores[$name]['configuration']['lock']);
345 }
8139ad13
SH
346 $this->config_save();
347 return true;
348 }
349
350 /**
351 * Deletes a store instance.
352 *
353 * This function also calls save so you should redirect immediately, or at least very shortly after
354 * calling this method.
355 *
356 * @param string $name The name of the instance to delete.
357 * @return bool
358 * @throws cache_exception
359 */
26ce56fd 360 public function delete_store_instance($name) {
8139ad13
SH
361 if (!array_key_exists($name, $this->configstores)) {
362 throw new cache_exception('The requested store does not exist.');
363 }
364 if ($this->configstores[$name]['default']) {
365 throw new cache_exception('The can not delete the default stores.');
366 }
367 foreach ($this->configmodemappings as $mapping) {
368 if ($mapping['store'] === $name) {
369 throw new cache_exception('You cannot delete a cache store that has mode mappings.');
370 }
371 }
372 foreach ($this->configdefinitionmappings as $mapping) {
373 if ($mapping['store'] === $name) {
374 throw new cache_exception('You cannot delete a cache store that has definition mappings.');
375 }
376 }
a037c943 377
730cf5ac
MS
378 // Call instance_deleted()
379 $class = 'cachestore_'.$this->configstores[$name]['plugin'];
380 $store = new $class($name, $this->configstores[$name]['configuration']);
381 $store->instance_deleted();
382
8139ad13
SH
383 unset($this->configstores[$name]);
384 $this->config_save();
385 return true;
386 }
387
388 /**
389 * Creates the default configuration and saves it.
390 *
391 * This function calls config_save, however it is safe to continue using it afterwards as this function should only ever
392 * be called when there is no configuration file already.
7383a7e2 393 *
b0dd08dd 394 * @param bool $forcesave If set to true then we will forcefully save the default configuration file.
7383a7e2
SH
395 * @return true|array Returns true if the default configuration was successfully created.
396 * Returns a configuration array if it could not be saved. This is a bad situation. Check your error logs.
8139ad13 397 */
b0dd08dd 398 public static function create_default_configuration($forcesave = false) {
8139ad13
SH
399 // HACK ALERT.
400 // We probably need to come up with a better way to create the default stores, or at least ensure 100% that the
401 // default store plugins are protected from deletion.
8139ad13 402 $writer = new self;
fbf76dcd 403 $writer->configstores = self::get_default_stores();
8139ad13
SH
404 $writer->configdefinitions = self::locate_definitions();
405 $writer->configmodemappings = array(
406 array(
407 'mode' => cache_store::MODE_APPLICATION,
408 'store' => 'default_application',
409 'sort' => -1
410 ),
411 array(
412 'mode' => cache_store::MODE_SESSION,
413 'store' => 'default_session',
414 'sort' => -1
415 ),
416 array(
417 'mode' => cache_store::MODE_REQUEST,
418 'store' => 'default_request',
419 'sort' => -1
420 )
421 );
34c84c72
SH
422 $writer->configlocks = array(
423 'default_file_lock' => array(
167ad91e 424 'name' => 'cachelock_file_default',
34c84c72 425 'type' => 'cachelock_file',
167ad91e
SH
426 'dir' => 'filelocks',
427 'default' => true
34c84c72
SH
428 )
429 );
7383a7e2
SH
430
431 $factory = cache_factory::instance();
432 // We expect the cache to be initialising presently. If its not then something has gone wrong and likely
433 // we are now in a loop.
b0dd08dd 434 if (!$forcesave && $factory->get_state() !== cache_factory::STATE_INITIALISING) {
7383a7e2
SH
435 return $writer->generate_configuration_array();
436 }
437 $factory->set_state(cache_factory::STATE_SAVING);
8139ad13 438 $writer->config_save();
7383a7e2 439 return true;
8139ad13
SH
440 }
441
fbf76dcd
SH
442 /**
443 * Returns an array of default stores for use.
444 *
445 * @return array
446 */
447 protected static function get_default_stores() {
969eaa3e
DW
448 global $CFG;
449
450 require_once($CFG->dirroot.'/cache/stores/file/lib.php');
451 require_once($CFG->dirroot.'/cache/stores/session/lib.php');
452 require_once($CFG->dirroot.'/cache/stores/static/lib.php');
453
fbf76dcd
SH
454 return array(
455 'default_application' => array(
456 'name' => 'default_application',
457 'plugin' => 'file',
458 'configuration' => array(),
459 'features' => cachestore_file::get_supported_features(),
460 'modes' => cachestore_file::get_supported_modes(),
461 'default' => true,
462 ),
463 'default_session' => array(
464 'name' => 'default_session',
465 'plugin' => 'session',
466 'configuration' => array(),
467 'features' => cachestore_session::get_supported_features(),
468 'modes' => cachestore_session::get_supported_modes(),
469 'default' => true,
470 ),
471 'default_request' => array(
472 'name' => 'default_request',
473 'plugin' => 'static',
474 'configuration' => array(),
475 'features' => cachestore_static::get_supported_features(),
476 'modes' => cachestore_static::get_supported_modes(),
477 'default' => true,
478 )
479 );
480 }
481
482 /**
483 * Updates the default stores within the MUC config file.
484 */
485 public static function update_default_config_stores() {
486 $factory = cache_factory::instance();
487 $factory->updating_started();
488 $config = $factory->create_config_instance(true);
489 $config->configstores = array_merge($config->configstores, self::get_default_stores());
490 $config->config_save();
491 $factory->updating_finished();
492 }
493
8139ad13
SH
494 /**
495 * Updates the definition in the configuration from those found in the cache files.
496 *
497 * Calls config_save further down, you should redirect immediately or asap after calling this method.
75af47ee
SH
498 *
499 * @param bool $coreonly If set to true only core definitions will be updated.
8139ad13 500 */
75af47ee 501 public static function update_definitions($coreonly = false) {
9890ecfc
SH
502 $factory = cache_factory::instance();
503 $factory->updating_started();
504 $config = $factory->create_config_instance(true);
75af47ee 505 $config->write_definitions_to_cache(self::locate_definitions($coreonly));
9890ecfc 506 $factory->updating_finished();
8139ad13
SH
507 }
508
509 /**
510 * Locates all of the definition files.
511 *
75af47ee 512 * @param bool $coreonly If set to true only core definitions will be updated.
8139ad13
SH
513 * @return array
514 */
75af47ee 515 protected static function locate_definitions($coreonly = false) {
8139ad13
SH
516 global $CFG;
517
518 $files = array();
519 if (file_exists($CFG->dirroot.'/lib/db/caches.php')) {
520 $files['core'] = $CFG->dirroot.'/lib/db/caches.php';
521 }
522
75af47ee 523 if (!$coreonly) {
46f6f7f2 524 $plugintypes = core_component::get_plugin_types();
75af47ee 525 foreach ($plugintypes as $type => $location) {
d0cac8b5 526 $plugins = core_component::get_plugin_list_with_file($type, 'db/caches.php');
75af47ee
SH
527 foreach ($plugins as $plugin => $filepath) {
528 $component = clean_param($type.'_'.$plugin, PARAM_COMPONENT); // Standardised plugin name.
529 $files[$component] = $filepath;
530 }
8139ad13
SH
531 }
532 }
533
534 $definitions = array();
535 foreach ($files as $component => $file) {
536 $filedefs = self::load_caches_file($file);
537 foreach ($filedefs as $area => $definition) {
538 $area = clean_param($area, PARAM_AREA);
539 $id = $component.'/'.$area;
540 $definition['component'] = $component;
541 $definition['area'] = $area;
542 if (array_key_exists($id, $definitions)) {
d4797177 543 debugging('Error: duplicate cache definition found with id: '.$id, DEBUG_DEVELOPER);
8139ad13
SH
544 continue;
545 }
546 $definitions[$id] = $definition;
547 }
548 }
549
550 return $definitions;
551 }
552
553 /**
554 * Writes the updated definitions for the config file.
555 * @param array $definitions
556 */
557 private function write_definitions_to_cache(array $definitions) {
46e17f04
SH
558
559 // Preserve the selected sharing option when updating the definitions.
560 // This is set by the user and should never come from caches.php.
561 foreach ($definitions as $key => $definition) {
562 unset($definitions[$key]['selectedsharingoption']);
563 unset($definitions[$key]['userinputsharingkey']);
564 if (isset($this->configdefinitions[$key]) && isset($this->configdefinitions[$key]['selectedsharingoption'])) {
565 $definitions[$key]['selectedsharingoption'] = $this->configdefinitions[$key]['selectedsharingoption'];
566 }
567 if (isset($this->configdefinitions[$key]) && isset($this->configdefinitions[$key]['userinputsharingkey'])) {
568 $definitions[$key]['userinputsharingkey'] = $this->configdefinitions[$key]['userinputsharingkey'];
569 }
570 }
571
8139ad13
SH
572 $this->configdefinitions = $definitions;
573 foreach ($this->configdefinitionmappings as $key => $mapping) {
574 if (!array_key_exists($mapping['definition'], $definitions)) {
575 unset($this->configdefinitionmappings[$key]);
576 }
577 }
578 $this->config_save();
579 }
580
581 /**
582 * Loads the caches file if it exists.
583 * @param string $file Absolute path to the file.
584 * @return array
585 */
586 private static function load_caches_file($file) {
587 if (!file_exists($file)) {
588 return array();
589 }
590 $definitions = array();
170f821b 591 include($file);
8139ad13
SH
592 return $definitions;
593 }
594
595 /**
596 * Sets the mappings for a given definition.
597 *
598 * @param string $definition
599 * @param array $mappings
600 * @throws coding_exception
601 */
602 public function set_definition_mappings($definition, $mappings) {
603 if (!array_key_exists($definition, $this->configdefinitions)) {
604 throw new coding_exception('Invalid definition name passed when updating mappings.');
605 }
606 foreach ($mappings as $store) {
607 if (!array_key_exists($store, $this->configstores)) {
608 throw new coding_exception('Invalid store name passed when updating definition mappings.');
609 }
610 }
611 foreach ($this->configdefinitionmappings as $key => $mapping) {
612 if ($mapping['definition'] == $definition) {
613 unset($this->configdefinitionmappings[$key]);
614 }
615 }
616 $sort = count($mappings);
617 foreach ($mappings as $store) {
618 $this->configdefinitionmappings[] = array(
619 'store' => $store,
620 'definition' => $definition,
621 'sort' => $sort
622 );
623 $sort--;
624 }
625
626 $this->config_save();
627 }
628
e0d9b7c0
SH
629 /**
630 * Update the site identifier stored by the cache API.
631 *
632 * @param string $siteidentifier
fe86ebfa 633 * @return string The new site identifier.
e0d9b7c0
SH
634 */
635 public function update_site_identifier($siteidentifier) {
636 $this->siteidentifier = md5((string)$siteidentifier);
637 $this->config_save();
fe86ebfa 638 return $this->siteidentifier;
e0d9b7c0 639 }
46e17f04
SH
640
641 /**
642 * Sets the selected sharing options and key for a definition.
643 *
644 * @param string $definition The name of the definition to set for.
645 * @param int $sharingoption The sharing option to set.
646 * @param string|null $userinputsharingkey The user input key or null.
647 * @throws coding_exception
648 */
649 public function set_definition_sharing($definition, $sharingoption, $userinputsharingkey = null) {
650 if (!array_key_exists($definition, $this->configdefinitions)) {
651 throw new coding_exception('Invalid definition name passed when updating sharing options.');
652 }
653 if (!($this->configdefinitions[$definition]['sharingoptions'] & $sharingoption)) {
654 throw new coding_exception('Invalid sharing option passed when updating definition.');
655 }
656 $this->configdefinitions[$definition]['selectedsharingoption'] = (int)$sharingoption;
657 if (!empty($userinputsharingkey)) {
658 $this->configdefinitions[$definition]['userinputsharingkey'] = (string)$userinputsharingkey;
659 }
660 $this->config_save();
661 }
662
8139ad13
SH
663}
664
665/**
666 * A cache helper for administration tasks
667 *
668 * @package core
669 * @category cache
670 * @copyright 2012 Sam Hemelryk
671 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
672 */
673abstract class cache_administration_helper extends cache_helper {
674
675 /**
676 * Returns an array containing all of the information about stores a renderer needs.
677 * @return array
678 */
26ce56fd 679 public static function get_store_instance_summaries() {
8139ad13
SH
680 $return = array();
681 $default = array();
682 $instance = cache_config::instance();
683 $stores = $instance->get_all_stores();
acf49f4b 684 $locks = $instance->get_locks();
8139ad13
SH
685 foreach ($stores as $name => $details) {
686 $class = $details['class'];
687 $store = new $class($details['name'], $details['configuration']);
acf49f4b 688 $lock = (isset($details['lock'])) ? $locks[$details['lock']] : $instance->get_default_lock();
8139ad13
SH
689 $record = array(
690 'name' => $name,
691 'plugin' => $details['plugin'],
692 'default' => $details['default'],
693 'isready' => $store->is_ready(),
694 'requirementsmet' => $store->are_requirements_met(),
695 'mappings' => 0,
acf49f4b 696 'lock' => $lock,
8139ad13
SH
697 'modes' => array(
698 cache_store::MODE_APPLICATION =>
699 ($store->get_supported_modes($return) & cache_store::MODE_APPLICATION) == cache_store::MODE_APPLICATION,
700 cache_store::MODE_SESSION =>
701 ($store->get_supported_modes($return) & cache_store::MODE_SESSION) == cache_store::MODE_SESSION,
702 cache_store::MODE_REQUEST =>
703 ($store->get_supported_modes($return) & cache_store::MODE_REQUEST) == cache_store::MODE_REQUEST,
704 ),
705 'supports' => array(
758dbdf8 706 'multipleidentifiers' => $store->supports_multiple_identifiers(),
8139ad13
SH
707 'dataguarantee' => $store->supports_data_guarantee(),
708 'nativettl' => $store->supports_native_ttl(),
709 'nativelocking' => ($store instanceof cache_is_lockable),
710 'keyawareness' => ($store instanceof cache_is_key_aware),
dbd2ea4e 711 'searchable' => ($store instanceof cache_is_searchable)
8139ad13
SH
712 )
713 );
714 if (empty($details['default'])) {
715 $return[$name] = $record;
716 } else {
717 $default[$name] = $record;
718 }
719 }
720
721 ksort($return);
722 ksort($default);
723 $return = $return + $default;
724
8139ad13
SH
725 foreach ($instance->get_definition_mappings() as $mapping) {
726 if (!array_key_exists($mapping['store'], $return)) {
727 continue;
728 }
729 $return[$mapping['store']]['mappings']++;
730 }
731
732 return $return;
733 }
734
735 /**
736 * Returns an array of information about plugins, everything a renderer needs.
737 * @return array
738 */
26ce56fd 739 public static function get_store_plugin_summaries() {
8139ad13 740 $return = array();
d0cac8b5 741 $plugins = core_component::get_plugin_list_with_file('cachestore', 'lib.php', true);
8139ad13 742 foreach ($plugins as $plugin => $path) {
6fec1820 743 $class = 'cachestore_'.$plugin;
8139ad13 744 $return[$plugin] = array(
6fec1820 745 'name' => get_string('pluginname', 'cachestore_'.$plugin),
8139ad13
SH
746 'requirementsmet' => $class::are_requirements_met(),
747 'instances' => 0,
748 'modes' => array(
749 cache_store::MODE_APPLICATION => ($class::get_supported_modes() & cache_store::MODE_APPLICATION),
750 cache_store::MODE_SESSION => ($class::get_supported_modes() & cache_store::MODE_SESSION),
751 cache_store::MODE_REQUEST => ($class::get_supported_modes() & cache_store::MODE_REQUEST),
752 ),
753 'supports' => array(
754 'multipleidentifiers' => ($class::get_supported_features() & cache_store::SUPPORTS_MULTIPLE_IDENTIFIERS),
755 'dataguarantee' => ($class::get_supported_features() & cache_store::SUPPORTS_DATA_GUARANTEE),
756 'nativettl' => ($class::get_supported_features() & cache_store::SUPPORTS_NATIVE_TTL),
757 'nativelocking' => (in_array('cache_is_lockable', class_implements($class))),
758 'keyawareness' => (array_key_exists('cache_is_key_aware', class_implements($class))),
759 ),
7e7e108f 760 'canaddinstance' => ($class::can_add_instance() && $class::are_requirements_met())
8139ad13
SH
761 );
762 }
763
764 $instance = cache_config::instance();
765 $stores = $instance->get_all_stores();
766 foreach ($stores as $store) {
767 $plugin = $store['plugin'];
768 if (array_key_exists($plugin, $return)) {
769 $return[$plugin]['instances']++;
770 }
771 }
772
773 return $return;
774 }
775
776 /**
777 * Returns an array about the definitions. All the information a renderer needs.
778 * @return array
779 */
780 public static function get_definition_summaries() {
781 $instance = cache_config::instance();
782 $definitions = $instance->get_definitions();
783
784 $storenames = array();
785 foreach ($instance->get_all_stores() as $key => $store) {
786 if (!empty($store['default'])) {
787 $storenames[$key] = new lang_string('store_'.$key, 'cache');
788 }
789 }
790
791 $modemappings = array();
792 foreach ($instance->get_mode_mappings() as $mapping) {
793 $mode = $mapping['mode'];
794 if (!array_key_exists($mode, $modemappings)) {
795 $modemappings[$mode] = array();
796 }
797 if (array_key_exists($mapping['store'], $storenames)) {
798 $modemappings[$mode][] = $storenames[$mapping['store']];
799 } else {
800 $modemappings[$mode][] = $mapping['store'];
801 }
802 }
803
804 $definitionmappings = array();
805 foreach ($instance->get_definition_mappings() as $mapping) {
806 $definition = $mapping['definition'];
807 if (!array_key_exists($definition, $definitionmappings)) {
808 $definitionmappings[$definition] = array();
809 }
810 if (array_key_exists($mapping['store'], $storenames)) {
811 $definitionmappings[$definition][] = $storenames[$mapping['store']];
812 } else {
813 $definitionmappings[$definition][] = $mapping['store'];
814 }
815 }
816
817 $return = array();
818
819 foreach ($definitions as $id => $definition) {
820
821 $mappings = array();
822 if (array_key_exists($id, $definitionmappings)) {
823 $mappings = $definitionmappings[$id];
824 } else if (empty($definition['mappingsonly'])) {
825 $mappings = $modemappings[$definition['mode']];
826 }
827
828 $return[$id] = array(
829 'id' => $id,
830 'name' => cache_helper::get_definition_name($definition),
831 'mode' => $definition['mode'],
832 'component' => $definition['component'],
833 'area' => $definition['area'],
46e17f04
SH
834 'mappings' => $mappings,
835 'sharingoptions' => self::get_definition_sharing_options($definition['sharingoptions'], false),
836 'selectedsharingoption' => self::get_definition_sharing_options($definition['selectedsharingoption'], true),
837 'userinputsharingkey' => $definition['userinputsharingkey']
8139ad13
SH
838 );
839 }
840 return $return;
841 }
842
46e17f04
SH
843 /**
844 * Given a sharing option hash this function returns an array of strings that can be used to describe it.
845 *
846 * @param int $sharingoption The sharing option hash to get strings for.
847 * @param bool $isselectedoptions Set to true if the strings will be used to view the selected options.
848 * @return array An array of lang_string's.
849 */
850 public static function get_definition_sharing_options($sharingoption, $isselectedoptions = true) {
851 $options = array();
852 $prefix = ($isselectedoptions) ? 'sharingselected' : 'sharing';
853 if ($sharingoption & cache_definition::SHARING_ALL) {
854 $options[cache_definition::SHARING_ALL] = new lang_string($prefix.'_all', 'cache');
855 }
856 if ($sharingoption & cache_definition::SHARING_SITEID) {
857 $options[cache_definition::SHARING_SITEID] = new lang_string($prefix.'_siteid', 'cache');
858 }
859 if ($sharingoption & cache_definition::SHARING_VERSION) {
860 $options[cache_definition::SHARING_VERSION] = new lang_string($prefix.'_version', 'cache');
861 }
862 if ($sharingoption & cache_definition::SHARING_INPUT) {
863 $options[cache_definition::SHARING_INPUT] = new lang_string($prefix.'_input', 'cache');
864 }
865 return $options;
866 }
867
8139ad13
SH
868 /**
869 * Returns all of the actions that can be performed on a definition.
870 * @param context $context
871 * @return array
872 */
54519330 873 public static function get_definition_actions(context $context, array $definition) {
8139ad13 874 if (has_capability('moodle/site:config', $context)) {
54519330
SH
875 $actions = array();
876 // Edit mappings.
877 $actions[] = array(
878 'text' => get_string('editmappings', 'cache'),
879 'url' => new moodle_url('/cache/admin.php', array('action' => 'editdefinitionmapping', 'sesskey' => sesskey()))
880 );
881 // Edit sharing.
882 if (count($definition['sharingoptions']) > 1) {
883 $actions[] = array(
46e17f04
SH
884 'text' => get_string('editsharing', 'cache'),
885 'url' => new moodle_url('/cache/admin.php', array('action' => 'editdefinitionsharing', 'sesskey' => sesskey()))
54519330
SH
886 );
887 }
888 // Purge.
889 $actions[] = array(
890 'text' => get_string('purge', 'cache'),
891 'url' => new moodle_url('/cache/admin.php', array('action' => 'purgedefinition', 'sesskey' => sesskey()))
8139ad13 892 );
54519330 893 return $actions;
8139ad13
SH
894 }
895 return array();
896 }
897
898 /**
899 * Returns all of the actions that can be performed on a store.
900 *
901 * @param string $name The name of the store
902 * @param array $storedetails
903 * @return array
904 */
26ce56fd 905 public static function get_store_instance_actions($name, array $storedetails) {
8139ad13 906 $actions = array();
0601e0ee 907 if (has_capability('moodle/site:config', context_system::instance())) {
8139ad13
SH
908 $baseurl = new moodle_url('/cache/admin.php', array('store' => $name, 'sesskey' => sesskey()));
909 if (empty($storedetails['default'])) {
910 $actions[] = array(
911 'text' => get_string('editstore', 'cache'),
912 'url' => new moodle_url($baseurl, array('action' => 'editstore', 'plugin' => $storedetails['plugin']))
913 );
914 $actions[] = array(
915 'text' => get_string('deletestore', 'cache'),
916 'url' => new moodle_url($baseurl, array('action' => 'deletestore'))
917 );
918 }
919 $actions[] = array(
920 'text' => get_string('purge', 'cache'),
50523565 921 'url' => new moodle_url($baseurl, array('action' => 'purgestore'))
8139ad13
SH
922 );
923 }
924 return $actions;
925 }
926
927
928 /**
929 * Returns all of the actions that can be performed on a plugin.
930 *
931 * @param string $name The name of the plugin
932 * @param array $plugindetails
933 * @return array
934 */
26ce56fd 935 public static function get_store_plugin_actions($name, array $plugindetails) {
8139ad13 936 $actions = array();
7e7e108f 937 if (has_capability('moodle/site:config', context_system::instance())) {
8139ad13
SH
938 if (!empty($plugindetails['canaddinstance'])) {
939 $url = new moodle_url('/cache/admin.php', array('action' => 'addstore', 'plugin' => $name, 'sesskey' => sesskey()));
940 $actions[] = array(
941 'text' => get_string('addinstance', 'cache'),
942 'url' => $url
943 );
944 }
945 }
946 return $actions;
947 }
948
949 /**
950 * Returns a form that can be used to add a store instance.
951 *
952 * @param string $plugin The plugin to add an instance of
6fec1820 953 * @return cachestore_addinstance_form
8139ad13
SH
954 * @throws coding_exception
955 */
956 public static function get_add_store_form($plugin) {
170f821b 957 global $CFG; // Needed for includes.
bd3b3bba 958 $plugins = core_component::get_plugin_list('cachestore');
42f2c59e
SH
959 if (!array_key_exists($plugin, $plugins)) {
960 throw new coding_exception('Invalid cache plugin used when trying to create an edit form.');
961 }
962 $plugindir = $plugins[$plugin];
6fec1820 963 $class = 'cachestore_addinstance_form';
8139ad13
SH
964 if (file_exists($plugindir.'/addinstanceform.php')) {
965 require_once($plugindir.'/addinstanceform.php');
6fec1820
SH
966 if (class_exists('cachestore_'.$plugin.'_addinstance_form')) {
967 $class = 'cachestore_'.$plugin.'_addinstance_form';
968 if (!array_key_exists('cachestore_addinstance_form', class_parents($class))) {
969 throw new coding_exception('Cache plugin add instance forms must extend cachestore_addinstance_form');
8139ad13
SH
970 }
971 }
972 }
973
26ce56fd 974 $locks = self::get_possible_locks_for_stores($plugindir, $plugin);
167ad91e 975
8139ad13 976 $url = new moodle_url('/cache/admin.php', array('action' => 'addstore'));
167ad91e 977 return new $class($url, array('plugin' => $plugin, 'store' => null, 'locks' => $locks));
8139ad13
SH
978 }
979
980 /**
981 * Returns a form that can be used to edit a store instance.
982 *
983 * @param string $plugin
984 * @param string $store
6fec1820 985 * @return cachestore_addinstance_form
8139ad13
SH
986 * @throws coding_exception
987 */
988 public static function get_edit_store_form($plugin, $store) {
170f821b 989 global $CFG; // Needed for includes.
bd3b3bba 990 $plugins = core_component::get_plugin_list('cachestore');
42f2c59e
SH
991 if (!array_key_exists($plugin, $plugins)) {
992 throw new coding_exception('Invalid cache plugin used when trying to create an edit form.');
993 }
994 $factory = cache_factory::instance();
995 $config = $factory->create_config_instance();
996 $stores = $config->get_all_stores();
997 if (!array_key_exists($store, $stores)) {
998 throw new coding_exception('Invalid store name given when trying to create an edit form.');
999 }
1000 $plugindir = $plugins[$plugin];
6fec1820 1001 $class = 'cachestore_addinstance_form';
8139ad13
SH
1002 if (file_exists($plugindir.'/addinstanceform.php')) {
1003 require_once($plugindir.'/addinstanceform.php');
6fec1820
SH
1004 if (class_exists('cachestore_'.$plugin.'_addinstance_form')) {
1005 $class = 'cachestore_'.$plugin.'_addinstance_form';
1006 if (!array_key_exists('cachestore_addinstance_form', class_parents($class))) {
1007 throw new coding_exception('Cache plugin add instance forms must extend cachestore_addinstance_form');
8139ad13
SH
1008 }
1009 }
1010 }
1011
26ce56fd 1012 $locks = self::get_possible_locks_for_stores($plugindir, $plugin);
42f2c59e 1013
81ede547
SH
1014 $url = new moodle_url('/cache/admin.php', array('action' => 'editstore', 'plugin' => $plugin, 'store' => $store));
1015 $editform = new $class($url, array('plugin' => $plugin, 'store' => $store, 'locks' => $locks));
acf49f4b 1016 if (isset($stores[$store]['lock'])) {
25927c42 1017 $editform->set_data(array('lock' => $stores[$store]['lock']));
acf49f4b 1018 }
81ede547
SH
1019 // See if the cachestore is going to want to load data for the form.
1020 // If it has a customised add instance form then it is going to want to.
1021 $storeclass = 'cachestore_'.$plugin;
1022 $storedata = $stores[$store];
2b274ad0 1023 if (array_key_exists('configuration', $storedata) && array_key_exists('cache_is_configurable', class_implements($storeclass))) {
81ede547
SH
1024 $storeclass::config_set_edit_form_data($editform, $storedata['configuration']);
1025 }
1026 return $editform;
42f2c59e
SH
1027 }
1028
1029 /**
1030 * Returns an array of suitable lock instances for use with this plugin, or false if the plugin handles locking itself.
1031 *
1032 * @param string $plugindir
1033 * @param string $plugin
1034 * @return array|false
1035 */
26ce56fd 1036 protected static function get_possible_locks_for_stores($plugindir, $plugin) {
42f2c59e
SH
1037 global $CFG; // Needed for includes.
1038 $supportsnativelocking = false;
1039 if (file_exists($plugindir.'/lib.php')) {
1040 require_once($plugindir.'/lib.php');
1041 $pluginclass = 'cachestore_'.$plugin;
1042 if (class_exists($pluginclass)) {
1043 $supportsnativelocking = array_key_exists('cache_is_lockable', class_implements($pluginclass));
1044 }
1045 }
1046
1047 if (!$supportsnativelocking) {
1048 $config = cache_config::instance();
1049 $locks = array();
1050 foreach ($config->get_locks() as $lock => $conf) {
1051 if (!empty($conf['default'])) {
1052 $name = get_string($lock, 'cache');
1053 } else {
1054 $name = $lock;
1055 }
1056 $locks[$lock] = $name;
1057 }
1058 } else {
1059 $locks = false;
1060 }
1061
1062 return $locks;
8139ad13
SH
1063 }
1064
1065 /**
1066 * Processes the results of the add/edit instance form data for a plugin returning an array of config information suitable to
1067 * store in configuration.
1068 *
1069 * @param stdClass $data The mform data.
1070 * @return array
1071 * @throws coding_exception
1072 */
1073 public static function get_store_configuration_from_data(stdClass $data) {
1074 global $CFG;
1075 $file = $CFG->dirroot.'/cache/stores/'.$data->plugin.'/lib.php';
1076 if (!file_exists($file)) {
1077 throw new coding_exception('Invalid cache plugin provided. '.$file);
1078 }
1079 require_once($file);
6fec1820 1080 $class = 'cachestore_'.$data->plugin;
8139ad13
SH
1081 if (!class_exists($class)) {
1082 throw new coding_exception('Invalid cache plugin provided.');
1083 }
2b274ad0
SH
1084 if (array_key_exists('cache_is_configurable', class_implements($class))) {
1085 return $class::config_get_configuration_array($data);
8139ad13
SH
1086 }
1087 return array();
1088 }
1089
1090 /**
1091 * Get an array of stores that are suitable to be used for a given definition.
1092 *
1093 * @param string $component
1094 * @param string $area
1095 * @return array Array containing 3 elements
1096 * 1. An array of currently used stores
1097 * 2. An array of suitable stores
1098 * 3. An array of default stores
1099 */
1100 public static function get_definition_store_options($component, $area) {
1101 $factory = cache_factory::instance();
1102 $definition = $factory->create_definition($component, $area);
1103 $config = cache_config::instance();
1104 $currentstores = $config->get_stores_for_definition($definition);
1105 $possiblestores = $config->get_stores($definition->get_mode(), $definition->get_requirements_bin());
1106
1107 $defaults = array();
1108 foreach ($currentstores as $key => $store) {
1109 if (!empty($store['default'])) {
1110 $defaults[] = $key;
1111 unset($currentstores[$key]);
1112 }
1113 }
1114 foreach ($possiblestores as $key => $store) {
167ad91e 1115 if ($store['default']) {
8139ad13
SH
1116 unset($possiblestores[$key]);
1117 $possiblestores[$key] = $store;
1118 }
1119 }
1120 return array($currentstores, $possiblestores, $defaults);
1121 }
1122
1123 /**
1124 * Get the default stores for all modes.
1125 *
1126 * @return array An array containing sub-arrays, one for each mode.
1127 */
1128 public static function get_default_mode_stores() {
d31fd615 1129 global $OUTPUT;
8139ad13 1130 $instance = cache_config::instance();
d31fd615
SH
1131 $adequatestores = cache_helper::get_stores_suitable_for_mode_default();
1132 $icon = new pix_icon('i/warning', new lang_string('inadequatestoreformapping', 'cache'));
8139ad13
SH
1133 $storenames = array();
1134 foreach ($instance->get_all_stores() as $key => $store) {
1135 if (!empty($store['default'])) {
1136 $storenames[$key] = new lang_string('store_'.$key, 'cache');
1137 }
1138 }
1139 $modemappings = array(
1140 cache_store::MODE_APPLICATION => array(),
1141 cache_store::MODE_SESSION => array(),
1142 cache_store::MODE_REQUEST => array(),
1143 );
1144 foreach ($instance->get_mode_mappings() as $mapping) {
1145 $mode = $mapping['mode'];
1146 if (!array_key_exists($mode, $modemappings)) {
1147 debugging('Unknown mode in cache store mode mappings', DEBUG_DEVELOPER);
1148 continue;
1149 }
1150 if (array_key_exists($mapping['store'], $storenames)) {
1151 $modemappings[$mode][$mapping['store']] = $storenames[$mapping['store']];
1152 } else {
1153 $modemappings[$mode][$mapping['store']] = $mapping['store'];
1154 }
d31fd615
SH
1155 if (!array_key_exists($mapping['store'], $adequatestores)) {
1156 $modemappings[$mode][$mapping['store']] = $modemappings[$mode][$mapping['store']].' '.$OUTPUT->render($icon);
1157 }
8139ad13
SH
1158 }
1159 return $modemappings;
1160 }
167ad91e
SH
1161
1162 /**
1163 * Returns an array summarising the locks available in the system
1164 */
1165 public static function get_lock_summaries() {
1166 $locks = array();
1167 $instance = cache_config::instance();
1168 $stores = $instance->get_all_stores();
1169 foreach ($instance->get_locks() as $lock) {
1170 $default = !empty($lock['default']);
1171 if ($default) {
1172 $name = new lang_string($lock['name'], 'cache');
1173 } else {
1174 $name = $lock['name'];
1175 }
1176 $uses = 0;
1177 foreach ($stores as $store) {
1178 if (!empty($store['lock']) && $store['lock'] === $lock['name']) {
1179 $uses++;
1180 }
1181 }
1182 $lockdata = array(
1183 'name' => $name,
1184 'default' => $default,
acf49f4b
SH
1185 'uses' => $uses,
1186 'type' => get_string('pluginname', $lock['type'])
167ad91e 1187 );
acf49f4b 1188 $locks[$lock['name']] = $lockdata;
167ad91e
SH
1189 }
1190 return $locks;
1191 }
acf49f4b
SH
1192
1193 /**
1194 * Returns an array of lock plugins for which we can add an instance.
1195 *
1196 * Suitable for use within an mform select element.
1197 *
1198 * @return array
1199 */
1200 public static function get_addable_lock_options() {
059e08ed 1201 $plugins = core_component::get_plugin_list_with_class('cachelock', '', 'lib.php');
acf49f4b
SH
1202 $options = array();
1203 $len = strlen('cachelock_');
1204 foreach ($plugins as $plugin => $class) {
1205 $method = "$class::can_add_instance";
1206 if (is_callable($method) && !call_user_func($method)) {
1207 // Can't add an instance of this plugin.
1208 continue;
1209 }
1210 $options[substr($plugin, $len)] = get_string('pluginname', $plugin);
1211 }
1212 return $options;
1213 }
1214
1215 /**
1216 * Gets the form to use when adding a lock instance.
1217 *
1218 * @param string $plugin
1219 * @param array $lockplugin
1220 * @return cache_lock_form
1221 * @throws coding_exception
1222 */
1223 public static function get_add_lock_form($plugin, array $lockplugin = null) {
1224 global $CFG; // Needed for includes.
bd3b3bba 1225 $plugins = core_component::get_plugin_list('cachelock');
acf49f4b
SH
1226 if (!array_key_exists($plugin, $plugins)) {
1227 throw new coding_exception('Invalid cache lock plugin requested when trying to create a form.');
1228 }
1229 $plugindir = $plugins[$plugin];
1230 $class = 'cache_lock_form';
1231 if (file_exists($plugindir.'/addinstanceform.php') && in_array('cache_is_configurable', class_implements($class))) {
1232 require_once($plugindir.'/addinstanceform.php');
1233 if (class_exists('cachelock_'.$plugin.'_addinstance_form')) {
1234 $class = 'cachelock_'.$plugin.'_addinstance_form';
1235 if (!array_key_exists('cache_lock_form', class_parents($class))) {
1236 throw new coding_exception('Cache lock plugin add instance forms must extend cache_lock_form');
1237 }
1238 }
1239 }
1240 return new $class(null, array('lock' => $plugin));
1241 }
1242
1243 /**
1244 * Gets configuration data from a new lock instance form.
1245 *
1246 * @param string $plugin
1247 * @param stdClass $data
1248 * @return array
1249 * @throws coding_exception
1250 */
1251 public static function get_lock_configuration_from_data($plugin, $data) {
1252 global $CFG;
1253 $file = $CFG->dirroot.'/cache/locks/'.$plugin.'/lib.php';
1254 if (!file_exists($file)) {
1255 throw new coding_exception('Invalid cache plugin provided. '.$file);
1256 }
1257 require_once($file);
1258 $class = 'cachelock_'.$plugin;
1259 if (!class_exists($class)) {
1260 throw new coding_exception('Invalid cache plugin provided.');
1261 }
1262 if (array_key_exists('cache_is_configurable', class_implements($class))) {
1263 return $class::config_get_configuration_array($data);
1264 }
1265 return array();
1266 }
7866b094 1267}