38bf40b16112b3382fbedfa9993c7a838d245ae8
[moodle.git] / backup / util / settings / base_setting.class.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * @package    moodlecore
20  * @subpackage backup-settings
21  * @copyright  2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 /**
26  * This abstract class defines one basic setting
27  *
28  * Each setting will be able to control its name, value (from a list), ui
29  * representation (check box, drop down, text field...), visibility, status
30  * (editable/locked...) and its hierarchy with other settings (using one
31  * like-observer pattern.
32  *
33  * TODO: Finish phpdocs
34  */
35 abstract class base_setting {
37     // Some constants defining different ui representations for the setting
38     const UI_NONE             = 0;
39     const UI_HTML_CHECKBOX    = 10;
40     const UI_HTML_RADIOBUTTON = 20;
41     const UI_HTML_DROPDOWN    = 30;
42     const UI_HTML_TEXTFIELD   = 40;
44     // Type of validation to perform against the value (relaying in PARAM_XXX validations)
45     const IS_BOOLEAN = 'bool';
46     const IS_INTEGER = 'int';
47     const IS_FILENAME= 'file';
48     const IS_PATH    = 'path';
50     // Visible/hidden
51     const VISIBLE = 1;
52     const HIDDEN  = 0;
54     // Editable/locked (by different causes)
55     const NOT_LOCKED           = 3;
56     const LOCKED_BY_CONFIG     = 5;
57     const LOCKED_BY_HIERARCHY  = 7;
58     const LOCKED_BY_PERMISSION = 9;
60     // Type of change to inform dependencies
61     const CHANGED_VALUE      = 1;
62     const CHANGED_VISIBILITY = 2;
63     const CHANGED_STATUS     = 3;
65     protected $name;  // name of the setting
66     protected $value; // value of the setting
67     protected $vtype; // type of value (setting_base::IS_BOOLEAN/setting_base::IS_INTEGER...)
69     protected $visibility; // visibility of the setting (setting_base::VISIBLE/setting_base::HIDDEN)
70     protected $status; // setting_base::NOT_LOCKED/setting_base::LOCKED_BY_PERMISSION...
72     protected $dependencies = array(); // array of dependent (observer) objects (usually setting_base ones)
73     protected $dependenton = array();
75     /**
76      * The user interface for this setting
77      * @var backup_setting_ui|backup_setting_ui_checkbox|backup_setting_ui_radio|backup_setting_ui_select|backup_setting_ui_text
78      */
79     protected $uisetting;
81     /**
82      * An array that contains the identifier and component of a help string if one
83      * has been set
84      * @var array
85      */
86     protected $help = array();
88     public function __construct($name, $vtype, $value = null, $visibility = self::VISIBLE, $status = self::NOT_LOCKED) {
89         // Check vtype
90         if ($vtype !== self::IS_BOOLEAN && $vtype !== self::IS_INTEGER &&
91             $vtype !== self::IS_FILENAME && $vtype !== self::IS_PATH) {
92             throw new base_setting_exception('setting_invalid_type');
93         }
95         // Validate value
96         $value = $this->validate_value($vtype, $value);
98         // Check visibility
99         $visibility = $this->validate_visibility($visibility);
101         // Check status
102         $status = $this->validate_status($status);
104         $this->name        = $name;
105         $this->vtype       = $vtype;
106         $this->value       = $value;
107         $this->visibility  = $visibility;
108         $this->status      = $status;
110         // Generate a default ui
111         $this->uisetting = new base_setting_ui($this);
112     }
114     public function get_name() {
115         return $this->name;
116     }
118     public function get_value() {
119         return $this->value;
120     }
122     public function get_visibility() {
123         return $this->visibility;
124     }
126     public function get_status() {
127         return $this->status;
128     }
130     public function set_value($value) {
131         // Validate value
132         $value = $this->validate_value($this->vtype, $value);
133         // Only can change value if setting is not locked
134         if ($this->status != self::NOT_LOCKED) {
135             switch ($this->status) {
136                 case self::LOCKED_BY_PERMISSION:
137                     throw new base_setting_exception('setting_locked_by_permission');
138                 case self::LOCKED_BY_CONFIG:
139                     throw new base_setting_exception('setting_locked_by_config');
140             }
141         }
142         $oldvalue = $this->value;
143         $this->value = $value;
144         if ($value !== $oldvalue) { // Value has changed, let's inform dependencies
145             $this->inform_dependencies(self::CHANGED_VALUE, $oldvalue);
146         }
147     }
149     public function set_visibility($visibility) {
150         $visibility = $this->validate_visibility($visibility);
152         // If this setting is dependent on other settings first check that all
153         // of those settings are visible
154         if (count($this->dependenton) > 0 && $visibility == base_setting::VISIBLE) {
155             foreach ($this->dependenton as $dependency) {
156                 if ($dependency->get_setting()->get_visibility() != base_setting::VISIBLE) {
157                     $visibility = base_setting::HIDDEN;
158                     break;
159                 }
160             }
161         }
163         $oldvisibility = $this->visibility;
164         $this->visibility = $visibility;
165         if ($visibility !== $oldvisibility) { // Visibility has changed, let's inform dependencies
166             $this->inform_dependencies(self::CHANGED_VISIBILITY, $oldvisibility);
167         }
168     }
170     public function set_status($status) {
171         $status = $this->validate_status($status);
173         // If this setting is dependent on other settings first check that all
174         // of those settings are not locked
175         if (count($this->dependenton) > 0 && $status == base_setting::NOT_LOCKED) {
176             foreach ($this->dependenton as $dependency) {
177                 if ($dependency->get_setting()->get_status() != base_setting::NOT_LOCKED) {
178                     $status = base_setting::LOCKED_BY_HIERARCHY;
179                     break;
180                 }
181             }
182         }
184         $oldstatus = $this->status;
185         $this->status = $status;
186         if ($status !== $oldstatus) { // Status has changed, let's inform dependencies
187             $this->inform_dependencies(self::CHANGED_STATUS, $oldstatus);
188         }
189     }
191     /**
192      * Gets an array of properties for all of the dependencies that will affect
193      * this setting.
194      *
195      * This method returns and array rather than the dependencies in order to
196      * minimise the memory footprint of for the potentially huge recursive
197      * dependency structure that we may be dealing with.
198      *
199      * This method also ensures that all dependencies are transmuted to affect
200      * the setting in question and that we don't provide any duplicates.
201      *
202      * @param string|null $settingname
203      * @return array
204      */
205     public function get_my_dependency_properties($settingname=null) {
206         if ($settingname ==  null) {
207             $settingname = $this->get_ui_name();
208         }
209         $dependencies = array();
210         foreach ($this->dependenton as $dependenton) {
211             $properties = $dependenton->get_moodleform_properties();
212             $properties['setting'] = $settingname;
213             $dependencies[$properties['setting'].'-'.$properties['dependenton']] = $properties;
214             $dependencies = array_merge($dependencies, $dependenton->get_setting()->get_my_dependency_properties($settingname));
215         }
216         return $dependencies;
217     }
219     /**
220      * Checks if there are other settings that are dependent on this setting
221      *
222      * @return bool True if there are other settings that are dependent on this setting
223      */
224     public function has_dependent_settings() {
225         return (count($this->dependencies)>0);
226     }
228     /**
229      * Checks if this setting is dependent on any other settings
230      *
231      * @return bool True if this setting is dependent on any other settings
232      */
233     public function has_dependencies_on_settings() {
234         return (count($this->dependenton)>0);
235     }
237     /**
238      * Sets the user interface for this setting
239      *
240      * @param base_setting_ui $ui
241      */
242     public function set_ui(backup_setting_ui $ui) {
243         $this->uisetting = $ui;
244     }
246     /**
247      * Gets the user interface for this setting
248      *
249      * @return base_setting_ui
250      */
251     public function get_ui() {
252         return $this->uisetting;
253     }
255     /**
256      * Adds a dependency where another setting depends on this setting.
257      * @param setting_dependency $dependency
258      */
259     public function register_dependency(setting_dependency $dependency) {
260         if ($this->is_circular_reference($dependency->get_dependent_setting())) {
261             $a = new stdclass();
262             $a->alreadydependent = $this->name;
263             $a->main = $dependentsetting->get_name();
264             throw new base_setting_exception('setting_circular_reference', $a);
265         }
266         $this->dependencies[$dependency->get_dependent_setting()->get_name()] = $dependency;
267         $dependency->get_dependent_setting()->register_dependent_dependency($dependency);
268     }
269     /**
270      * Adds a dependency where this setting is dependent on another.
271      *
272      * This should only be called internally once we are sure it is not cicrular.
273      *
274      * @param setting_dependency $dependency
275      */
276     protected function register_dependent_dependency(setting_dependency $dependency) {
277         $this->dependenton[$dependency->get_setting()->get_name()] = $dependency;
278     }
280     /**
281      * Quick method to add a dependency to this setting.
282      *
283      * The dependency created is done so by inspecting this setting and the
284      * setting that is passed in as the dependent setting.
285      *
286      * @param base_setting $dependentsetting
287      * @param int $type One of setting_dependency::*
288      * @param array $options
289      */
290     public function add_dependency(base_setting $dependentsetting, $type=null, $options=array()) {
291         if ($this->is_circular_reference($dependentsetting)) {
292             $a = new stdclass();
293             $a->alreadydependent = $this->name;
294             $a->main = $dependentsetting->get_name();
295             throw new base_setting_exception('setting_circular_reference', $a);
296         }
297         // Check the settings hasn't been already added
298         if (array_key_exists($dependentsetting->get_name(), $this->dependencies)) {
299             throw new base_setting_exception('setting_already_added');
300         }
302         $options = (array)$options;
304         if (!array_key_exists('defaultvalue', $options)) {
305             $options['defaultvalue'] = false;
306         }
308         if ($type == null) {
309             switch ($this->vtype) {
310                 case self::IS_BOOLEAN :
311                     if ($this->get_ui_type() == self::UI_HTML_CHECKBOX) {
312                         if ($this->value) {
313                             $type = setting_dependency::DISABLED_NOT_CHECKED;
314                         } else {
315                             $type = setting_dependency::DISABLED_CHECKED;
316                         }
317                     } else {
318                         if ($this->value) {
319                             $type = setting_dependency::DISABLED_FALSE;
320                         } else {
321                             $type = setting_dependency::DISABLED_TRUE;
322                         }
323                     }
324                     break;
325                 case self::IS_FILENAME :
326                 case self::IS_PATH :
327                 case self::IS_INTEGER :
328                 default :
329                     $type = setting_dependency::DISABLED_VALUE;
330                     break;
331             }
332         }
334         switch ($type) {
335             case setting_dependency::DISABLED_VALUE :
336                 if (!array_key_exists('value', $options)) {
337                     throw new base_setting_exception('dependency_needs_value');
338                 }
339                 $dependency = new setting_dependency_disabledif_equals($this, $dependentsetting, $options['value'], $options['defaultvalue']);
340                 break;
341             case setting_dependency::DISABLED_TRUE :
342                 $dependency = new setting_dependency_disabledif_equals($this, $dependentsetting, true, $options['defaultvalue']);
343                 break;
344             case setting_dependency::DISABLED_FALSE :
345                 $dependency = new setting_dependency_disabledif_equals($this, $dependentsetting, false, $options['defaultvalue']);
346                 break;
347             case setting_dependency::DISABLED_CHECKED :
348                 $dependency = new setting_dependency_disabledif_checked($this, $dependentsetting, $options['defaultvalue']);
349                 break;
350             case setting_dependency::DISABLED_NOT_CHECKED :
351                 $dependency = new setting_dependency_disabledif_not_checked($this, $dependentsetting, $options['defaultvalue']);
352                 break;
353             case setting_dependency::DISABLED_EMPTY :
354                 $dependency = new setting_dependency_disabledif_empty($this, $dependentsetting, $options['defaultvalue']);
355                 break;
356             case setting_dependency::DISABLED_NOT_EMPTY :
357                 $dependency = new setting_dependency_disabledif_not_empty($this, $dependentsetting, $options['defaultvalue']);
358                 break;
359         }
360         $this->dependencies[$dependentsetting->get_name()] = $dependency;
361         $dependency->get_dependent_setting()->register_dependent_dependency($dependency);
362     }
364 // Protected API starts here
366     protected function validate_value($vtype, $value) {
367         if (is_null($value)) { // Nulls aren't validated
368             return null;
369         }
370         $oldvalue = $value;
371         switch ($vtype) {
372             case self::IS_BOOLEAN:
373                 $value = clean_param($oldvalue, PARAM_BOOL); // Just clean
374                 break;
375             case self::IS_INTEGER:
376                 $value = clean_param($oldvalue, PARAM_INT);
377                 if ($value != $oldvalue) {
378                     throw new base_setting_exception('setting_invalid_integer', $oldvalue);
379                 }
380                 break;
381             case self::IS_FILENAME:
382                 $value = clean_param($oldvalue, PARAM_FILE);
383                 if ($value != $oldvalue) {
384                     throw new base_setting_exception('setting_invalid_filename', $oldvalue);
385                 }
386                 break;
387             case self::IS_PATH:
388                 $value = clean_param($oldvalue, PARAM_PATH);
389                 if ($value != $oldvalue) {
390                     throw new base_setting_exception('setting_invalid_path', $oldvalue);
391                 }
392                 break;
393         }
394         return $value;
395     }
397     protected function validate_visibility($visibility) {
398         if (is_null($visibility)) {
399             $visibility = self::VISIBLE;
400         }
401         if ($visibility !== self::VISIBLE && $visibility !== self::HIDDEN) {
402             throw new base_setting_exception('setting_invalid_visibility');
403         }
404         return $visibility;
405     }
407     protected function validate_status($status) {
408         if (is_null($status)) {
409             $status = self::NOT_LOCKED;
410         }
411         if ($status !== self::NOT_LOCKED && $status !== self::LOCKED_BY_CONFIG &&
412             $status !== self::LOCKED_BY_PERMISSION && $status !== self::LOCKED_BY_HIERARCHY) {
413             throw new base_setting_exception('setting_invalid_status', $status);
414         }
415         return $status;
416     }
418     protected function validate_ui_type($type) {
419         if ($type !== self::UI_HTML_CHECKBOX && $type !== self::UI_HTML_RADIOBUTTON &&
420             $type !== self::UI_HTML_DROPDOWN && $type !== self::UI_HTML_TEXTFIELD) {
421             throw new base_setting_exception('setting_invalid_ui_type');
422         }
423         return $type;
424     }
426     protected function validate_ui_label($label) {
427         if (empty($label) || $label !== clean_param($label, PARAM_ALPHAEXT)) {
428             throw new base_setting_exception('setting_invalid_ui_label');
429         }
430         return $label;
431     }
433     protected function inform_dependencies($ctype, $oldv) {
434         foreach ($this->dependencies as $dependency) {
435             $dependency->process_change($ctype, $oldv);
436         }
437     }
439     protected function is_circular_reference($obj) {
440         // Get object dependencies recursively and check (by name) if $this is already there
441         $dependencies = $obj->get_dependencies();
442         if (array_key_exists($this->name, $dependencies) || $obj == $this) {
443             return true;
444         }
445         // Recurse the dependent settings one by one
446         foreach ($dependencies as $dependency) {
447             if ($dependency->get_dependent_setting()->is_circular_reference($obj)) {
448                 return true;
449             }
450         }
451         return false;
452     }
454     public function get_dependencies() {
455         return $this->dependencies;
456     }
458     public function get_ui_name() {
459         return $this->uisetting->get_name();
460     }
462     public function get_ui_type() {
463         return $this->uisetting->get_type();
464     }
466     /**
467      * Sets a help string for this setting
468      *
469      * @param string $identifier
470      * @param string $component
471      */
472     public function set_help($identifier, $component='moodle') {
473         $this->help = array($identifier, $component);
474     }
476     /**
477      * Gets the help string params for this setting if it has been set
478      * @return array|false An array (identifier, component) or false if not set
479      */
480     public function get_help() {
481         if ($this->has_help()) {
482             return $this->help;
483         }
484         return false;
485     }
487     /**
488      * Returns true if help has been set for this setting
489      * @return cool
490      */
491     public function has_help() {
492         return (!empty($this->help));
493     }
496 /*
497  * Exception class used by all the @setting_base stuff
498  */
499 class base_setting_exception extends backup_exception {
501     public function __construct($errorcode, $a=NULL, $debuginfo=null) {
502         parent::__construct($errorcode, $a, $debuginfo);
503     }