'); 64 | 65 | // Submit. 66 | $mform->addElement('submit', 'admin_presets_submit', get_string('savechanges')); 67 | } 68 | } 69 | -------------------------------------------------------------------------------- /forms/admin_presets_import_form.php: -------------------------------------------------------------------------------- 1 | . 16 | 17 | /** 18 | * Admin presets block main controller 19 | * 20 | * @package blocks/admin_presets 21 | * @copyright 2019 Pimenko
' . implode('
', $actions) . '
');
132 | }
133 |
134 | $this->outputs .= html_writer::table($table);
135 |
136 | // If there aren't presets notify it.
137 | } else {
138 |
139 | $exportlink = '' .
141 | strtolower(get_string("actionexport", "block_admin_presets")) . '';
142 | $importlink = '' .
144 | strtolower(get_string("actionimport", "block_admin_presets")) . '';
145 |
146 | $this->outputs = $OUTPUT->box_start('generalbox', 'id_nopresets');
147 | $this->outputs .= '- ' . get_string('nopresets', 'block_admin_presets');
148 | $this->outputs .= '
- ' . get_string('toexportclick', 149 | 'block_admin_presets', $exportlink) . ' '; 150 | $this->outputs .= '
- ' . get_string('toimportclick', 151 | 'block_admin_presets', $importlink) . ' '; 152 | $this->outputs .= '
' . $child->visiblename . '
';
527 | $nodes['categories'][$categorynode] = array("category",
528 | $categorynode, (String) $nodehtml, "", $jsparentnode);
529 |
530 | // Not all admin_categories have admin_settingpages.
531 | $this->_get_settings_elements($allsettings, $child->children, $categorynode, $nodes);
532 | }
533 |
534 | // Settings page.
535 | } else if (is_a($child, 'admin_settingpage')) {
536 | // Only if there are settings.
537 | if ($child->settings) {
538 |
539 | // The name of that page tree node.
540 | $pagenode = $child->name . 'Node';
541 |
542 | foreach ($child->settings as $values) {
543 | $settingname = $values->name;
544 |
545 | // IF no plugin was specified mark as 'none'.
546 | if (!$plugin = $values->plugin) {
547 | $plugin = 'none';
548 | }
549 |
550 | if (empty($allsettings[$plugin][$settingname])) {
551 | continue;
552 | }
553 |
554 | // Getting setting data.
555 | $setting = $allsettings[$plugin][$settingname];
556 | $settingid = $setting->get_id();
557 |
558 | // String to add the setting to js tree.
559 | $pagesettings[$settingid] = array($settingid, $settingid,
560 | $setting->get_text(), $setting->get_description(), $pagenode);
561 | }
562 |
563 | // The page node only should be added if it have children.
564 | if ($pagesettings) {
565 | $nodehtml = '' . $child->visiblename . '
';
566 | $nodes['pages'][$pagenode] = array("page", $pagenode, (String) $nodehtml, "", $jsparentnode);
567 | $nodes['settings'] = array_merge($nodes['settings'], $pagesettings);
568 | }
569 | }
570 | }
571 | }
572 |
573 | return $nodes;
574 | }
575 |
576 | /**
577 | * Gets the standarized settings array from DB records
578 | *
579 | * @param array $dbsettings Array of objects
580 | * @return array Standarized array,
581 | * format $array['plugin']['name'] = obj('name'=>'settingname', 'value'=>'settingvalue')
582 | */
583 | protected function _get_settings_from_db($dbsettings) {
584 |
585 | if (!$dbsettings) {
586 | return false;
587 | }
588 |
589 | $settings = array();
590 | foreach ($dbsettings as $dbsetting) {
591 | $settings[$dbsetting->plugin][$dbsetting->name] = new StdClass();
592 | $settings[$dbsetting->plugin][$dbsetting->name]->itemid = $dbsetting->id;
593 | $settings[$dbsetting->plugin][$dbsetting->name]->name = $dbsetting->name;
594 | $settings[$dbsetting->plugin][$dbsetting->name]->value = $dbsetting->value;
595 | }
596 |
597 | return $settings;
598 | }
599 |
600 | protected function _output_applied_changes($appliedchanges) {
601 |
602 | $appliedtable = new html_table();
603 | $appliedtable->attributes['class'] = 'generaltable boxaligncenter admin_presets_applied';
604 | $appliedtable->head = array(get_string('plugin'),
605 | get_string('settingname', 'block_admin_presets'),
606 | get_string('oldvalue', 'block_admin_presets'),
607 | get_string('newvalue', 'block_admin_presets'));
608 |
609 | $appliedtable->align = array('center', 'center');
610 |
611 | foreach ($appliedchanges as $setting) {
612 | $appliedtable->data[] = array($setting->plugin,
613 | $setting->visiblename,
614 | $setting->oldvisiblevalue,
615 | $setting->visiblevalue);
616 | }
617 |
618 | $this->outputs .= html_writer::table($appliedtable);
619 | }
620 |
621 | /**
622 | * Returns a table with the preset data
623 | *
624 | * @param object $preset
625 | * @return string|string
626 | * @throws coding_exception
627 | */
628 | protected function _html_writer_preset_info_table($preset) {
629 |
630 | if (!$preset) {
631 | return '';
632 | }
633 |
634 | if ($preset->timeimported) {
635 | $timeimportedstring = userdate($preset->timeimported);
636 | } else {
637 | $timeimportedstring = '';
638 | }
639 | $infotable = $this->_create_preset_data_table(false);
640 | $infotable->data[] = array(format_text($preset->name, FORMAT_PLAIN),
641 | format_text($preset->comments, FORMAT_HTML),
642 | format_text($preset->moodlerelease, FORMAT_PLAIN),
643 | format_text($preset->author, FORMAT_PLAIN),
644 | format_text(clean_text($preset->site, PARAM_URL), FORMAT_PLAIN),
645 | userdate($preset->timecreated),
646 | $timeimportedstring);
647 |
648 | return html_writer::table($infotable);
649 | }
650 | }
651 |
--------------------------------------------------------------------------------
/lib/admin_presets_delete.class.php:
--------------------------------------------------------------------------------
1 | .
16 |
17 | /**
18 | * Admin presets block main controller
19 | *
20 | * @package blocks/admin_presets
21 | * @copyright 2019 Pimenko ' . 53 | get_string("deletepreviouslyapplied", "block_admin_presets") . ''; 54 | } 55 | 56 | $this->outputs = $OUTPUT->confirm($deletetext, $confirmurl, $cancelurl); 57 | } 58 | 59 | /** 60 | * Delete the DB preset 61 | */ 62 | public function execute() { 63 | 64 | global $DB, $CFG; 65 | 66 | confirm_sesskey(); 67 | 68 | if (!$DB->delete_records('block_admin_presets', array('id' => $this->id))) { 69 | print_error('errordeleting', 'block_admin_presets'); 70 | } 71 | 72 | // Getting items ids before deleting to delete item attributes. 73 | $items = $DB->get_records('block_admin_presets_it', array('adminpresetid' => $this->id), 'id'); 74 | foreach ($items as $item) { 75 | $DB->delete_records('block_admin_presets_it_a', array('itemid' => $item->id)); 76 | } 77 | 78 | if (!$DB->delete_records('block_admin_presets_it', array('adminpresetid' => $this->id))) { 79 | print_error('errordeleting', 'block_admin_presets'); 80 | } 81 | 82 | // Deleting the preset applications. 83 | if ($previouslyapplied = $DB->get_records('block_admin_presets_app', 84 | array('adminpresetid' => $this->id), 'id')) { 85 | 86 | foreach ($previouslyapplied as $application) { 87 | 88 | // Deleting items. 89 | if (!$DB->delete_records('block_admin_presets_app_it', 90 | array('adminpresetapplyid' => $application->id))) { 91 | 92 | print_error('errordeleting', 'block_admin_presets'); 93 | } 94 | 95 | // Deleting attributes. 96 | if (!$DB->delete_records('block_admin_presets_app_it_a', 97 | array('adminpresetapplyid' => $application->id))) { 98 | 99 | print_error('errordeleting', 'block_admin_presets'); 100 | } 101 | } 102 | 103 | if (!$DB->delete_records('block_admin_presets_app', 104 | array('adminpresetid' => $this->id))) { 105 | 106 | print_error('errordeleting', 'block_admin_presets'); 107 | } 108 | } 109 | 110 | // Trigger the as it is usually triggered after execute finishes. 111 | $this->log(); 112 | 113 | redirect($CFG->wwwroot . '/blocks/admin_presets/index.php'); 114 | } 115 | 116 | } 117 | -------------------------------------------------------------------------------- /lib/admin_presets_export.class.php: -------------------------------------------------------------------------------- 1 | . 16 | 17 | /** 18 | * Admin presets block main controller 19 | * 20 | * @package blocks/admin_presets 21 | * @copyright 2019 Pimenko
' . $OUTPUT->heading(get_string('settingsapplied', 162 | 'block_admin_presets'), 3, 'admin_presets_success'); 163 | $this->_output_applied_changes($appliedchanges); 164 | } else { 165 | $this->outputs .= '
' . $OUTPUT->heading(get_string('nothingloaded', 166 | 'block_admin_presets'), 3, 'admin_presets_error'); 167 | } 168 | 169 | // Show skipped changes. 170 | if (!empty($unnecessarychanges)) { 171 | 172 | $skippedtable = new html_table(); 173 | $skippedtable->attributes['class'] = 'generaltable boxaligncenter admin_presets_skipped'; 174 | $skippedtable->head = array(get_string('plugin'), 175 | get_string('settingname', 'block_admin_presets'), 176 | get_string('actualvalue', 'block_admin_presets') 177 | ); 178 | 179 | $skippedtable->align = array('center', 'center'); 180 | 181 | $this->outputs .= '
' . $OUTPUT->heading(get_string('settingsnotapplied', 182 | 'block_admin_presets'), 3); 183 | 184 | foreach ($unnecessarychanges as $setting) { 185 | $skippedtable->data[] = array($setting->get_settingdata()->plugin, 186 | $setting->get_settingdata()->visiblename, 187 | $setting->get_visiblevalue() 188 | ); 189 | } 190 | 191 | $this->outputs .= html_writer::table($skippedtable); 192 | } 193 | 194 | // Don't display the load form. 195 | $this->moodleform = false; 196 | } 197 | 198 | /** 199 | * Lists the preset available settings 200 | */ 201 | public function preview() { 202 | $this->show(1); 203 | } 204 | 205 | /** 206 | * Displays the select preset settings to select what to import 207 | * 208 | * Loads the preset data and displays a settings tree 209 | * 210 | * It checks the Moodle version, it only allows users 211 | * to import the preset available settings 212 | * 213 | * @param boolean $preview If it's a preview it only lists the preset applicable settings 214 | * @throws coding_exception 215 | * @throws dml_exception 216 | * @throws moodle_exception 217 | */ 218 | public function show($preview = false) { 219 | 220 | global $CFG, $DB, $OUTPUT; 221 | 222 | $data = new StdClass(); 223 | $data->id = $this->id; 224 | 225 | // Preset data. 226 | if (!$preset = $DB->get_record('block_admin_presets', array('id' => $data->id))) { 227 | print_error('errornopreset', 'block_admin_presets'); 228 | } 229 | 230 | if (!$items = $DB->get_records('block_admin_presets_it', array('adminpresetid' => $data->id))) { 231 | print_error('errornopreset', 'block_admin_presets'); 232 | } 233 | 234 | // Standarized format $array['pluginname']['settingname']. 235 | // object('name' => 'settingname', 'value' => 'settingvalue'). 236 | $presetdbsettings = $this->_get_settings_from_db($items); 237 | 238 | // Load site avaible settings to ensure that the settings exists on this release. 239 | $siteavailablesettings = $this->_get_site_settings(); 240 | 241 | $notapplicable = array(); 242 | if ($presetdbsettings) { 243 | foreach ($presetdbsettings as $plugin => $elements) { 244 | foreach ($elements as $settingname => $element) { 245 | 246 | // If the setting doesn't exists in that release skip it. 247 | if (empty($siteavailablesettings[$plugin][$settingname])) { 248 | 249 | // Adding setting plugin. 250 | $presetdbsettings[$plugin][$settingname]->plugin = $plugin; 251 | 252 | $notapplicable[] = $presetdbsettings[$plugin][$settingname]; 253 | } 254 | } 255 | } 256 | } 257 | // Standarized format $array['plugin']['settingname'] = child class. 258 | $presetsettings = $this->_get_settings($presetdbsettings, false, $presetsettings = array()); 259 | 260 | $this->_get_settings_branches($presetsettings); 261 | 262 | // Print preset basic data. 263 | $this->outputs .= $this->_html_writer_preset_info_table($preset); 264 | 265 | // Display not applicable settings. 266 | if (!empty($notapplicable)) { 267 | 268 | $this->outputs .= '
' . $OUTPUT->heading(get_string('settingsnotapplicable', 269 | 'block_admin_presets'), 3, 'admin_presets_error'); 270 | 271 | $table = new html_table(); 272 | $table->attributes['class'] = 'generaltable boxaligncenter'; 273 | $table->head = array(get_string('plugin'), 274 | get_string('settingname', 'block_admin_presets'), 275 | get_string('value', 'block_admin_presets')); 276 | 277 | $table->align = array('center', 'center'); 278 | 279 | foreach ($notapplicable as $setting) { 280 | $table->data[] = array($setting->plugin, $setting->name, $setting->value); 281 | } 282 | 283 | $this->outputs .= html_writer::table($table); 284 | 285 | } 286 | 287 | $url = $CFG->wwwroot . '/blocks/admin_presets/index.php?action=load&mode=execute'; 288 | $this->moodleform = new admin_presets_load_form($url, $preview); 289 | $this->moodleform->set_data($data); 290 | 291 | } 292 | } 293 | -------------------------------------------------------------------------------- /lib/admin_presets_rollback.class.php: -------------------------------------------------------------------------------- 1 | . 16 | 17 | /** 18 | * Admin presets block main controller 19 | * 20 | * @package blocks/admin_presets 21 | * @copyright 2019 Pimenko
' . $action . '
'
70 | );
71 | }
72 |
73 | $this->outputs .= '' . $OUTPUT->heading(get_string("presetname", 74 | "block_admin_presets") . ': ' . $preset->name, 3); 75 | $this->outputs .= html_writer::table($table); 76 | } 77 | 78 | /** 79 | * Executes the application rollback 80 | * 81 | * Each setting value is checked against the config_log->value 82 | */ 83 | public function execute() { 84 | 85 | global $DB, $OUTPUT; 86 | 87 | confirm_sesskey(); 88 | 89 | // Actual settings. 90 | $sitesettings = $this->_get_site_settings(); 91 | 92 | // To store rollback results. 93 | $rollback = array(); 94 | $failures = array(); 95 | 96 | if (!$DB->get_record('block_admin_presets_app', array('id' => $this->id))) { 97 | print_error('wrongid', 'block_admin_presets'); 98 | } 99 | 100 | // Items. 101 | $itemsql = "SELECT cl.id, cl.plugin, cl.name, cl.value, cl.oldvalue, ap.adminpresetapplyid 102 | FROM {block_admin_presets_app_it} ap 103 | JOIN {config_log} cl ON cl.id = ap.configlogid 104 | WHERE ap.adminpresetapplyid = {$this->id}"; 105 | $itemchanges = $DB->get_records_sql($itemsql); 106 | if ($itemchanges) { 107 | 108 | foreach ($itemchanges as $change) { 109 | 110 | if ($change->plugin == '') { 111 | $change->plugin = 'none'; 112 | } 113 | 114 | // Admin setting. 115 | if (!empty($sitesettings[$change->plugin][$change->name])) { 116 | 117 | $actualsetting = $sitesettings[$change->plugin][$change->name]; 118 | $oldsetting = $this->_get_setting($actualsetting->get_settingdata(), $change->oldvalue); 119 | $oldsetting->set_text(); 120 | $varname = $change->plugin . '_' . $change->name; 121 | 122 | // Check if the actual value is the same set by the preset. 123 | if ($change->value == $actualsetting->get_value()) { 124 | 125 | $oldsetting->save_value(); 126 | 127 | // Output table. 128 | $rollback[$varname] = new stdClass(); 129 | $rollback[$varname]->plugin = $oldsetting->get_settingdata()->plugin; 130 | $rollback[$varname]->visiblename = $oldsetting->get_settingdata()->visiblename; 131 | $rollback[$varname]->oldvisiblevalue = $actualsetting->get_visiblevalue(); 132 | $rollback[$varname]->visiblevalue = $oldsetting->get_visiblevalue(); 133 | 134 | // Deleting the admin_preset_apply_item instance. 135 | $deletewhere = array('adminpresetapplyid' => $change->adminpresetapplyid, 136 | 'configlogid' => $change->id); 137 | $DB->delete_records('block_admin_presets_app_it', $deletewhere); 138 | 139 | } else { 140 | 141 | $failures[$varname] = new stdClass(); 142 | $failures[$varname]->plugin = $oldsetting->get_settingdata()->plugin; 143 | $failures[$varname]->visiblename = $oldsetting->get_settingdata()->visiblename; 144 | $failures[$varname]->oldvisiblevalue = $actualsetting->get_visiblevalue(); 145 | $failures[$varname]->visiblevalue = $oldsetting->get_visiblevalue(); 146 | } 147 | } 148 | } 149 | } 150 | 151 | // Attributes. 152 | $attrsql = "SELECT cl.id, cl.plugin, cl.name, cl.value, cl.oldvalue, ap.itemname, ap.adminpresetapplyid 153 | FROM {block_admin_presets_app_it_a} ap 154 | JOIN {config_log} cl ON cl.id = ap.configlogid 155 | WHERE ap.adminpresetapplyid = {$this->id}"; 156 | $attrchanges = $DB->get_records_sql($attrsql); 157 | if ($attrchanges) { 158 | 159 | foreach ($attrchanges as $change) { 160 | 161 | if ($change->plugin == '') { 162 | $change->plugin = 'none'; 163 | } 164 | 165 | // Admin setting of the attribute item. 166 | if (!empty($sitesettings[$change->plugin][$change->itemname])) { 167 | 168 | // Getting the attribute item. 169 | $actualsetting = $sitesettings[$change->plugin][$change->itemname]; 170 | 171 | $oldsetting = $this->_get_setting($actualsetting->get_settingdata(), $actualsetting->get_value()); 172 | $oldsetting->set_attribute_value($change->name, $change->oldvalue); 173 | $oldsetting->set_text(); 174 | 175 | $varname = $change->plugin . '_' . $change->name; 176 | 177 | // Check if the actual value is the same set by the preset. 178 | $actualattributes = $actualsetting->get_attributes_values(); 179 | if ($change->value == $actualattributes[$change->name]) { 180 | 181 | $oldsetting->save_attributes_values(); 182 | 183 | // Output table. 184 | $rollback[$varname] = new stdClass(); 185 | $rollback[$varname]->plugin = $oldsetting->get_settingdata()->plugin; 186 | $rollback[$varname]->visiblename = $oldsetting->get_settingdata()->visiblename; 187 | $rollback[$varname]->oldvisiblevalue = $actualsetting->get_visiblevalue(); 188 | $rollback[$varname]->visiblevalue = $oldsetting->get_visiblevalue(); 189 | 190 | // Deleting the admin_preset_apply_item_attr instance. 191 | $deletewhere = array('adminpresetapplyid' => $change->adminpresetapplyid, 192 | 'configlogid' => $change->id); 193 | $DB->delete_records('block_admin_presets_app_it_a', $deletewhere); 194 | 195 | } else { 196 | 197 | $failures[$varname] = new stdClass(); 198 | $failures[$varname]->plugin = $oldsetting->get_settingdata()->plugin; 199 | $failures[$varname]->visiblename = $oldsetting->get_settingdata()->visiblename; 200 | $failures[$varname]->oldvisiblevalue = $actualsetting->get_visiblevalue(); 201 | $failures[$varname]->visiblevalue = $oldsetting->get_visiblevalue(); 202 | } 203 | } 204 | } 205 | } 206 | 207 | // Delete application if no items nor attributes of the application remains. 208 | if (!$DB->get_record('block_admin_presets_app_it', array('adminpresetapplyid' => $this->id)) && 209 | !$DB->get_records('block_admin_presets_app_it_a', array('adminpresetapplyid' => $this->id))) { 210 | 211 | $DB->delete_records('block_admin_presets_app', array('id' => $this->id)); 212 | } 213 | 214 | // Display the rollback changes. 215 | if (!empty($rollback)) { 216 | $this->outputs .= '
' . $OUTPUT->heading(get_string('rollbackresults', 217 | "block_admin_presets"), 3, 'admin_presets_success'); 218 | $this->outputs .= '
'; 219 | $this->_output_applied_changes($rollback); 220 | } 221 | 222 | // Display the rollback failures. 223 | if (!empty($failures)) { 224 | $this->outputs .= '
' . $OUTPUT->heading(get_string('rollbackfailures', 225 | 'block_admin_presets'), 3, 'admin_presets_error'); 226 | $this->outputs .= '
'; 227 | $this->_output_applied_changes($failures); 228 | } 229 | } 230 | } 231 | -------------------------------------------------------------------------------- /lib/admin_presets_settings_types.php: -------------------------------------------------------------------------------- 1 | . 16 | 17 | /** 18 | * Admin presets block main controller 19 | * 20 | * @package blocks/admin_presets 21 | * @copyright 2019 Pimenko
' . $this->settingdata->visiblename . '
';
194 | $valuediv = '' . $this->visiblevalue . '
';
195 |
196 | $this->text = $namediv . $valuediv . ''; 197 | } 198 | 199 | public function get_attributes() { 200 | return $this->attributes; 201 | } 202 | 203 | public function get_attributes_values() { 204 | return $this->attributesvalues; 205 | } 206 | 207 | public function get_settingdata() { 208 | return $this->settingdata; 209 | } 210 | 211 | public function set_attribute_value($name, $value) { 212 | $this->attributesvalues[$name] = $value; 213 | } 214 | 215 | /** 216 | * Saves the setting attributes values 217 | * 218 | * @return array Array of inserted ids (in config_log) 219 | */ 220 | public function save_attributes_values() { 221 | 222 | // Plugin name or null. 223 | $plugin = $this->settingdata->plugin; 224 | if ($plugin == 'none' || $plugin == '') { 225 | $plugin = null; 226 | } 227 | 228 | if (!$this->attributesvalues) { 229 | return false; 230 | } 231 | 232 | // To store inserted ids. 233 | $ids = array(); 234 | foreach ($this->attributesvalues as $name => $value) { 235 | 236 | // Getting actual setting. 237 | $actualsetting = get_config($plugin, $name); 238 | 239 | // If it's the actual setting get off. 240 | if ($value == $actualsetting) { 241 | return false; 242 | } 243 | 244 | if ($id = $this->save_value($name, $value)) { 245 | $ids[] = $id; 246 | } 247 | } 248 | 249 | return $ids; 250 | } 251 | 252 | /** 253 | * Stores the setting into database, logs the change and returns the config_log inserted id 254 | * 255 | * @param bool $name 256 | * @param mixed $value 257 | * @return integer config_log inserted id 258 | * @throws dml_exception 259 | * @throws moodle_exception 260 | */ 261 | public function save_value($name = false, $value = null) { 262 | 263 | // Object values if no arguments. 264 | if ($value === null) { 265 | $value = $this->value; 266 | } 267 | if (!$name) { 268 | $name = $this->settingdata->name; 269 | } 270 | 271 | // Plugin name or null. 272 | $plugin = $this->settingdata->plugin; 273 | if ($plugin == 'none' || $plugin == '') { 274 | $plugin = null; 275 | } 276 | 277 | // Getting the actual value. 278 | $actualvalue = get_config($plugin, $name); 279 | 280 | // If it's the same it's not necessary. 281 | if ($actualvalue == $value) { 282 | return false; 283 | } 284 | 285 | set_config($name, $value, $plugin); 286 | 287 | return $this->to_log($plugin, $name, $value, $actualvalue); 288 | } 289 | 290 | /** 291 | * Copy of config_write method of the admin_setting class 292 | * 293 | * @param string $plugin 294 | * @param string $name 295 | * @param mixed $value 296 | * @param mixed $actualvalue 297 | * @return integer The stored config_log id 298 | */ 299 | protected function to_log($plugin, $name, $value, $actualvalue) { 300 | 301 | global $DB, $USER; 302 | 303 | // Log the change (pasted from admin_setting class). 304 | $log = new stdClass(); 305 | $log->userid = during_initial_install() ? 0 : $USER->id; // 0 as user id during install. 306 | $log->timemodified = time(); 307 | $log->plugin = $plugin; 308 | $log->name = $name; 309 | $log->value = $value; 310 | $log->oldvalue = $actualvalue; 311 | 312 | // Getting the inserted config_log id. 313 | if (!$id = $DB->insert_record('config_log', $log)) { 314 | print_error('errorinserting', 'block_admin_presets'); 315 | } 316 | 317 | return $id; 318 | } 319 | } 320 | 321 | /** 322 | * Cross-class methods 323 | */ 324 | class admin_presets_delegation { 325 | 326 | /** 327 | * Adds a piece of string to the $type setting 328 | * 329 | * @param boolean $value 330 | * @param string $type Indicates the "extra" setting 331 | * @return string 332 | */ 333 | public function extra_set_visiblevalue($value, $type) { 334 | 335 | // Adding the advanced value to the text string if present. 336 | if ($value) { 337 | $string = get_string('markedas' . $type, 'block_admin_presets'); 338 | } else { 339 | $string = get_string('markedasnon' . $type, 'block_admin_presets'); 340 | } 341 | 342 | // Adding the advanced state. 343 | return ', ' . $string; 344 | } 345 | 346 | public function extra_loadchoices(admin_setting &$adminsetting) { 347 | $adminsetting->load_choices(); 348 | } 349 | } 350 | 351 | /** TEXT **/ 352 | 353 | /** 354 | * Basic text setting, cleans the param using the admin_setting paramtext attribute 355 | */ 356 | class admin_preset_auth_ldap_admin_setting_special_contexts_configtext extends admin_preset_setting { 357 | 358 | /** 359 | * Validates the value using paramtype attribute 360 | * 361 | * @param string $value 362 | * @return boolean Cleaned or not, but always true 363 | */ 364 | protected function set_value($value) { 365 | 366 | $this->value = $value; 367 | 368 | if (empty($this->settingdata->paramtype)) { 369 | 370 | // For configfile, configpasswordunmask... 371 | $this->settingdata->paramtype = 'RAW'; 372 | } 373 | 374 | $paramtype = 'PARAM_' . strtoupper($this->settingdata->paramtype); 375 | 376 | // Regexp. 377 | if (!defined($paramtype)) { 378 | $this->value = preg_replace($this->settingdata->paramtype, '', $this->value); 379 | 380 | // Standard moodle param type. 381 | } else { 382 | $this->value = clean_param($this->value, constant($paramtype)); 383 | } 384 | 385 | return true; 386 | } 387 | } 388 | 389 | /** 390 | * Basic text setting, cleans the param using the admin_setting paramtext attribute 391 | */ 392 | class admin_preset_admin_setting_configtext extends admin_preset_setting { 393 | 394 | /** 395 | * Validates the value using paramtype attribute 396 | * 397 | * @param string $value 398 | * @return boolean Cleaned or not, but always true 399 | */ 400 | protected function set_value($value) { 401 | 402 | $this->value = $value; 403 | 404 | if (empty($this->settingdata->paramtype)) { 405 | 406 | // For configfile, configpasswordunmask... 407 | $this->settingdata->paramtype = 'RAW'; 408 | } 409 | 410 | $paramtype = 'PARAM_' . strtoupper($this->settingdata->paramtype); 411 | 412 | // Regexp. 413 | if (!defined($paramtype)) { 414 | $this->value = preg_replace($this->settingdata->paramtype, '', $this->value); 415 | 416 | // Standard moodle param type. 417 | } else { 418 | $this->value = clean_param($this->value, constant($paramtype)); 419 | } 420 | 421 | return true; 422 | } 423 | } 424 | 425 | /** 426 | * Adds the advanced attribute 427 | */ 428 | class admin_preset_admin_setting_configtext_with_advanced extends admin_preset_admin_setting_configtext { 429 | 430 | public function __construct(admin_setting $settingdata, $dbsettingvalue) { 431 | 432 | // To look for other values. 433 | $this->attributes = array('fix' => $settingdata->name . '_adv'); 434 | parent::__construct($settingdata, $dbsettingvalue); 435 | } 436 | 437 | /** 438 | * Sets the visible name for the setting selected value 439 | * 440 | * @return void 441 | */ 442 | public function set_visiblevalue(): void { 443 | parent::set_visiblevalue(); 444 | $this->visiblevalue .= $this->delegation->extra_set_visiblevalue( 445 | $this->attributesvalues[$this->attributes['fix']], 'advanced'); 446 | } 447 | } 448 | 449 | class admin_preset_admin_setting_configiplist extends admin_preset_admin_setting_configtext { 450 | 451 | protected function set_value($value) { 452 | 453 | // Just in wrong format case. 454 | $this->value = ''; 455 | 456 | // Check ip format. 457 | if ($this->settingdata->validate($value) !== true) { 458 | $this->value = false; 459 | return false; 460 | } 461 | 462 | $this->value = $value; 463 | return true; 464 | } 465 | } 466 | 467 | /** 468 | * Reimplementation to allow human friendly view of the selected regexps 469 | */ 470 | class admin_preset_admin_setting_devicedetectregex extends admin_preset_admin_setting_configtext { 471 | 472 | /** 473 | * Sets the visible name for the setting selected value 474 | * 475 | * In most cases the child classes will overwrite 476 | * 477 | * @return void 478 | */ 479 | public function set_visiblevalue(): void { 480 | 481 | $values = json_decode($this->get_value()); 482 | 483 | if (!$values) { 484 | parent::set_visiblevalue(); 485 | } 486 | 487 | $this->visiblevalue = ''; 488 | foreach ($values as $key => $value) { 489 | $this->visiblevalue .= $key . ' = ' . $value . ', '; 490 | } 491 | $this->visiblevalue = rtrim($this->visiblevalue, ', '); 492 | } 493 | } 494 | 495 | /** 496 | * Reimplemented to store values in course table, not in config or config_plugins 497 | */ 498 | class admin_preset_admin_setting_sitesettext extends admin_preset_admin_setting_configtext { 499 | 500 | /** 501 | * Overwritten to store the value in the course table 502 | * 503 | * @param bool $name 504 | * @param mixed $value 505 | * @return integer 506 | */ 507 | public function save_value($name = false, $value = false) { 508 | 509 | global $DB; 510 | 511 | // Object values if no arguments. 512 | if ($value === null) { 513 | $value = $this->value; 514 | } 515 | if (!$name) { 516 | $name = $this->settingdata->name; 517 | } 518 | 519 | $sitecourse = $DB->get_record('course', array('id' => 1)); 520 | $actualvalue = $sitecourse->{$name}; 521 | 522 | // If it's the same value skip. 523 | if ($actualvalue == $this->value) { 524 | return false; 525 | } 526 | 527 | // Plugin name or ''. 528 | $plugin = $this->settingdata->plugin; 529 | if ($plugin == 'none' || $plugin == '') { 530 | $plugin = null; 531 | } 532 | 533 | // Updating mdl_course. 534 | $sitecourse->{$name} = $this->value; 535 | $DB->update_record('course', $sitecourse); 536 | 537 | return $this->to_log($plugin, $name, $this->value, $actualvalue); 538 | } 539 | } 540 | 541 | class admin_preset_admin_setting_configselect extends admin_preset_setting { 542 | 543 | /** 544 | * $value must be one of the setting choices 545 | * 546 | * @return boolean true if the value one of the setting choices 547 | */ 548 | protected function set_value($value) { 549 | 550 | // When we intantiate the class we need the choices. 551 | if (empty($this->settindata->choices) && method_exists($this->settingdata, 'load_choices')) { 552 | $this->settingdata->load_choices(); 553 | } 554 | 555 | foreach ($this->settingdata->choices as $key => $choice) { 556 | 557 | if ($key == $value) { 558 | $this->value = $value; 559 | return true; 560 | } 561 | } 562 | 563 | $this->value = false; 564 | return false; 565 | } 566 | 567 | /** 568 | * Sets the visible name for the setting selected value 569 | * 570 | * In most cases the child classes will overwrite 571 | * 572 | * @return void 573 | */ 574 | public function set_visiblevalue(): void { 575 | 576 | // Just to avoid heritage problems. 577 | if (empty($this->settingdata->choices[$this->value])) { 578 | $this->visiblevalue = ''; 579 | } else { 580 | $this->visiblevalue = $this->settingdata->choices[$this->value]; 581 | } 582 | 583 | } 584 | } 585 | 586 | class admin_preset_admin_setting_bloglevel extends admin_preset_admin_setting_configselect { 587 | 588 | /** 589 | * Extended to change the block visibility 590 | */ 591 | public function save_value($name = false, $value = false) { 592 | 593 | global $DB; 594 | 595 | if (!$id = parent::save_value($name, $value)) { 596 | return false; 597 | } 598 | 599 | // Pasted from admin_setting_bloglevel (can't use write_config). 600 | if ($value == 0) { 601 | $DB->set_field('block', 'visible', 0, array('name' => 'blog_menu')); 602 | } else { 603 | $DB->set_field('block', 'visible', 1, array('name' => 'blog_menu')); 604 | } 605 | 606 | return $id; 607 | } 608 | } 609 | 610 | /** 611 | * Adds support for the "advanced" attribute 612 | */ 613 | class admin_preset_admin_setting_configselect_with_advanced extends admin_preset_admin_setting_configselect { 614 | 615 | protected $advancedkey; 616 | 617 | public function __construct(admin_setting $settingdata, $dbsettingvalue) { 618 | 619 | // Getting the advanced defaultsetting attribute name. 620 | if (is_array($settingdata->defaultsetting)) { 621 | foreach ($settingdata->defaultsetting as $key => $defaultvalue) { 622 | if ($key != 'value') { 623 | $this->advancedkey = $key; 624 | } 625 | } 626 | } 627 | 628 | // To look for other values. 629 | $this->attributes = array($this->advancedkey => $settingdata->name . '_adv'); 630 | parent::__construct($settingdata, $dbsettingvalue); 631 | } 632 | 633 | /** 634 | * Sets the visible name for the setting selected value 635 | * 636 | * In most cases the child classes will overwrite 637 | * 638 | * @return void 639 | */ 640 | public function set_visiblevalue(): void { 641 | parent::set_visiblevalue(); 642 | $this->visiblevalue .= $this->delegation->extra_set_visiblevalue( 643 | $this->attributesvalues[$this->attributes[$this->advancedkey]], 'advanced'); 644 | } 645 | } 646 | 647 | class admin_preset_mod_quiz_admin_setting_browsersecurity extends admin_preset_admin_setting_configselect_with_advanced { 648 | 649 | public function set_behaviors() { 650 | $this->behaviors['loadchoices'] = &$this->settingdata; 651 | } 652 | } 653 | 654 | class admin_preset_mod_quiz_admin_setting_grademethod extends admin_preset_admin_setting_configselect_with_advanced { 655 | 656 | public function set_behaviors() { 657 | $this->behaviors['loadchoices'] = &$this->settingdata; 658 | } 659 | } 660 | 661 | class admin_preset_mod_quiz_admin_setting_overduehandling extends admin_preset_admin_setting_configselect_with_advanced { 662 | 663 | public function set_behaviors() { 664 | $this->behaviors['loadchoices'] = &$this->settingdata; 665 | } 666 | } 667 | 668 | class admin_preset_mod_quiz_admin_setting_user_image extends admin_preset_admin_setting_configselect_with_advanced { 669 | 670 | public function set_behaviors() { 671 | $this->behaviors['loadchoices'] = &$this->settingdata; 672 | } 673 | } 674 | 675 | /** 676 | * A select with force and advanced options 677 | */ 678 | class admin_preset_admin_setting_gradecat_combo extends admin_preset_admin_setting_configselect { 679 | 680 | /** 681 | * One db value for two setting attributes 682 | * 683 | * @param admin_setting $settingdata 684 | * @param unknown_type $dbsettingvalue 685 | */ 686 | public function __construct(admin_setting $settingdata, $dbsettingvalue) { 687 | 688 | // set_attribute_value() will mod the VARNAME_flag value. 689 | $this->attributes = array('forced' => $settingdata->name . '_flag', 690 | 'adv' => $settingdata->name . '_flag'); 691 | parent::__construct($settingdata, $dbsettingvalue); 692 | } 693 | 694 | /** 695 | * Sets the visible name for the setting selected value 696 | * 697 | * In most cases the child classes will overwrite 698 | * 699 | * @return void 700 | */ 701 | public function set_visiblevalue(): void { 702 | parent::set_visiblevalue(); 703 | 704 | $flagvalue = $this->attributesvalues[$this->settingdata->name . '_flag']; 705 | 706 | if (isset($flagvalue)) { 707 | 708 | if (($flagvalue % 2) == 1) { 709 | $forcedvalue = '1'; 710 | } else { 711 | $forcedvalue = '0'; 712 | } 713 | 714 | if ($flagvalue >= 2) { 715 | $advancedvalue = '1'; 716 | } else { 717 | $advancedvalue = '0'; 718 | } 719 | $this->visiblevalue .= $this->delegation->extra_set_visiblevalue($forcedvalue, 'forced'); 720 | $this->visiblevalue .= $this->delegation->extra_set_visiblevalue($advancedvalue, 'advanced'); 721 | } 722 | } 723 | } 724 | 725 | /** 726 | * Extends the base class and lists the selected values separated by comma 727 | */ 728 | class admin_preset_admin_setting_configmultiselect extends admin_preset_setting { 729 | 730 | /** 731 | * Ensure that the $value values are setting choices 732 | */ 733 | protected function set_value($value) { 734 | 735 | if ($value) { 736 | $options = explode(',', $value); 737 | foreach ($options as $key => $option) { 738 | 739 | foreach ($this->settingdata->choices as $key => $choice) { 740 | 741 | if ($key == $value) { 742 | $this->value = $value; 743 | return true; 744 | } 745 | } 746 | } 747 | 748 | $value = implode(',', $options); 749 | } 750 | 751 | $this->value = $value; 752 | } 753 | 754 | /** 755 | * Sets the visible name for the setting selected value 756 | * 757 | * In most cases the child classes will overwrite 758 | * 759 | * @return void 760 | */ 761 | public function set_visiblevalue(): void { 762 | 763 | $values = explode(',', $this->value); 764 | $visiblevalues = array(); 765 | 766 | foreach ($values as $value) { 767 | 768 | if (!empty($this->settingdata->choices[$value])) { 769 | $visiblevalues[] = $this->settingdata->choices[$value]; 770 | } 771 | } 772 | 773 | if (empty($visiblevalues)) { 774 | $this->visiblevalue = ''; 775 | } 776 | 777 | $this->visiblevalue = implode(', ', $visiblevalues); 778 | } 779 | } 780 | 781 | /** 782 | * Extends configselect to reuse set_valuevisible 783 | */ 784 | class admin_preset_admin_setting_users_with_capability extends admin_preset_admin_setting_configmultiselect { 785 | 786 | protected function set_behaviors() { 787 | $this->behaviors['loadchoices'] = &$this->settingdata; 788 | } 789 | 790 | protected function set_value($value) { 791 | 792 | // Dirty hack (the value stored in the DB is ''). 793 | $this->settingdata->choices[''] = $this->settingdata->choices['$@NONE@$']; 794 | 795 | return parent::set_value($value); 796 | } 797 | } 798 | 799 | /** 800 | * Generalizes a configmultipleselect with load_choices() 801 | * 802 | * @abstract 803 | */ 804 | abstract class admin_preset_admin_setting_configmultiselect_with_loader extends admin_preset_admin_setting_configmultiselect { 805 | 806 | public function set_behaviors() { 807 | $this->behaviors['loadchoices'] = &$this->settingdata; 808 | } 809 | } 810 | 811 | class admin_preset_admin_setting_configtime extends admin_preset_setting { 812 | 813 | /** 814 | * To check that the value is one of the options 815 | * 816 | * @param string $name 817 | * @param mixed $value 818 | */ 819 | public function set_attribute_value($name, $value) { 820 | 821 | for ($i = 0; $i < 60; $i = $i + 5) { 822 | $minutes[$i] = $i; 823 | } 824 | 825 | if (!empty($minutes[$value])) { 826 | $this->attributesvalues[$name] = $value; 827 | } else { 828 | $this->attributesvalues[$name] = $this->settingdata->defaultsetting['m']; 829 | } 830 | } 831 | 832 | protected function set_value($value) { 833 | 834 | $this->attributes = array('m' => $this->settingdata->name2); 835 | 836 | for ($i = 0; $i < 24; $i++) { 837 | $hours[$i] = $i; 838 | } 839 | 840 | if (empty($hours[$value])) { 841 | $this->value = false; 842 | } 843 | 844 | $this->value = $value; 845 | } 846 | 847 | public function set_visiblevalue(): void { 848 | $this->visiblevalue = $this->value . ':' . $this->attributesvalues[$this->settingdata->name2]; 849 | } 850 | } 851 | 852 | /** CHECKBOXES **/ 853 | class admin_preset_admin_setting_configcheckbox extends admin_preset_setting { 854 | 855 | protected function set_value($value) { 856 | $this->value = clean_param($value, PARAM_BOOL); 857 | return true; 858 | } 859 | 860 | public function set_visiblevalue(): void { 861 | 862 | if ($this->value) { 863 | $str = get_string('yes'); 864 | } else { 865 | $str = get_string('no'); 866 | } 867 | 868 | $this->visiblevalue = $str; 869 | } 870 | } 871 | 872 | class admin_preset_admin_setting_configcheckbox_with_advanced extends admin_preset_admin_setting_configcheckbox { 873 | 874 | public function __construct(admin_setting $settingdata, $dbsettingvalue) { 875 | 876 | // To look for other values. 877 | $this->attributes = array('adv' => $settingdata->name . '_adv'); 878 | parent::__construct($settingdata, $dbsettingvalue); 879 | } 880 | 881 | /** 882 | * Uses delegation 883 | */ 884 | public function set_visiblevalue(): void { 885 | parent::set_visiblevalue(); 886 | $this->visiblevalue .= $this->delegation->extra_set_visiblevalue( 887 | $this->attributesvalues[$this->attributes['adv']], 'advanced'); 888 | } 889 | } 890 | 891 | class admin_preset_admin_setting_configcheckbox_with_lock extends admin_preset_admin_setting_configcheckbox { 892 | 893 | public function __construct(admin_setting $settingdata, $dbsettingvalue) { 894 | 895 | // To look for other values. 896 | $this->attributes = array('locked' => $settingdata->name . '_locked'); 897 | parent::__construct($settingdata, $dbsettingvalue); 898 | } 899 | 900 | /** 901 | * Uses delegation 902 | */ 903 | public function set_visiblevalue(): void { 904 | parent::set_visiblevalue(); 905 | $this->visiblevalue .= $this->delegation->extra_set_visiblevalue( 906 | $this->attributesvalues[$this->attributes['locked']], 'locked'); 907 | } 908 | } 909 | 910 | /** 911 | * Abstract class to be extended by multicheckbox settings 912 | * 913 | * Now it's a useless class, child classes could extend admin_preset_admin_setting_configmultiselect 914 | * 915 | * @abstract 916 | */ 917 | class admin_preset_admin_setting_configmulticheckbox extends admin_preset_admin_setting_configmultiselect { 918 | 919 | public function set_behaviors() { 920 | $this->behaviors['loadchoices'] = &$this->settingdata; 921 | } 922 | } 923 | 924 | /** 925 | * It doesn't specify loadchoices behavior because is set_visiblevalue who needs it 926 | */ 927 | class admin_preset_admin_setting_special_backupdays extends admin_preset_setting { 928 | 929 | protected function set_value($value) { 930 | $this->value = clean_param($value, PARAM_SEQUENCE); 931 | } 932 | 933 | public function set_visiblevalue(): void { 934 | 935 | // TODO Try to use $this->behaviors. 936 | $this->settingdata->load_choices(); 937 | 938 | $days = array('sunday', 'monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday'); 939 | 940 | $selecteddays = array(); 941 | 942 | $week = str_split($this->value); 943 | foreach ($week as $key => $day) { 944 | if ($day) { 945 | $index = $days[$key]; 946 | $selecteddays[] = $this->settingdata->choices[$index]; 947 | } 948 | } 949 | 950 | $this->visiblevalue = implode(', ', $selecteddays); 951 | } 952 | } 953 | 954 | /** OTHERS **/ 955 | class admin_preset_admin_setting_special_calendar_weekend extends admin_preset_setting { 956 | 957 | public function set_visiblevalue(): void { 958 | 959 | if (!$this->value) { 960 | parent::set_visiblevalue(); 961 | return; 962 | } 963 | 964 | $days = array('sunday', 'monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday'); 965 | for ($i = 0; $i < 7; $i++) { 966 | if ($this->value & (1 << $i)) { 967 | $settings[] = get_string($days[$i], 'calendar'); 968 | } 969 | } 970 | 971 | $this->visiblevalue = implode(', ', $settings); 972 | } 973 | } 974 | 975 | /** 976 | * Backward compatibility for Moodle 2.0 977 | */ 978 | class admin_preset_admin_setting_quiz_reviewoptions extends admin_preset_setting { 979 | 980 | // Caution VENOM! admin_setting_quiz_reviewoptions vars can't be accessed. 981 | private static $times = array( 982 | QUIZ_REVIEW_IMMEDIATELY => 'reviewimmediately', 983 | QUIZ_REVIEW_OPEN => 'reviewopen', 984 | QUIZ_REVIEW_CLOSED => 'reviewclosed'); 985 | 986 | private static $things = array( 987 | QUIZ_REVIEW_RESPONSES => 'responses', 988 | QUIZ_REVIEW_ANSWERS => 'answers', 989 | QUIZ_REVIEW_FEEDBACK => 'feedback', 990 | QUIZ_REVIEW_GENERALFEEDBACK => 'generalfeedback', 991 | QUIZ_REVIEW_SCORES => 'scores', 992 | QUIZ_REVIEW_OVERALLFEEDBACK => 'overallfeedback'); 993 | 994 | /** 995 | * Stores the setting data and the selected value 996 | * 997 | * @param admin_setting $settingdata admin_setting subclass 998 | * @param mixed $dbsettingvalue Actual value 999 | */ 1000 | public function __construct(admin_setting $settingdata, $dbsettingvalue) { 1001 | $this->attributes = array('fix' => $settingdata->name . '_adv'); 1002 | parent::__construct($settingdata, $dbsettingvalue); 1003 | } 1004 | 1005 | /** 1006 | * Delegates 1007 | */ 1008 | public function set_visiblevalue(): void { 1009 | 1010 | $marked = array(); 1011 | 1012 | foreach (self::$times as $timemask => $time) { 1013 | foreach (self::$things as $typemask => $type) { 1014 | if ($this->value & $timemask & $typemask) { 1015 | $marked[$time][] = get_string($type, "quiz"); 1016 | } 1017 | } 1018 | } 1019 | 1020 | foreach ($marked as $time => $types) { 1021 | $visiblevalues[] = '' . get_string($time, "quiz") . 1022 | ': ' . implode(', ', $types); 1023 | } 1024 | $this->visiblevalue = implode('
', $visiblevalues); 1025 | 1026 | if ($this->attributesvalues[$this->attributes['fix']]) { 1027 | $string = get_string("markedasnonadvanced", "block_admin_presets"); 1028 | } else { 1029 | $string = get_string("markedasadvanced", "block_admin_presets"); 1030 | } 1031 | 1032 | $this->visiblevalue .= '
' . ucfirst($string); 1033 | } 1034 | } 1035 | 1036 | /** 1037 | * Compatible with moodle 2.1 onwards (20120314) 1038 | */ 1039 | class admin_preset_mod_quiz_admin_review_setting extends admin_preset_setting { 1040 | 1041 | /** 1042 | * Overwrite to add the reviewoptions text 1043 | */ 1044 | public function set_text() { 1045 | 1046 | $this->set_visiblevalue(); 1047 | 1048 | $name = get_string('reviewoptionsheading', 'quiz') . 1049 | ': ' . $this->settingdata->visiblename; 1050 | $namediv = '
' . $name . '
';
1051 | $valuediv = '' . $this->visiblevalue . '
';
1052 |
1053 | $this->text = $namediv . $valuediv . ''; 1054 | } 1055 | 1056 | /** 1057 | * The setting value is a sum of 'mod_quiz_admin_review_setting::times' 1058 | */ 1059 | public function set_visiblevalue(): void { 1060 | // Getting the masks descriptions (mod_quiz_admin_review_setting protected method). 1061 | $reflectiontimes = new ReflectionMethod('mod_quiz_admin_review_setting', 'times'); 1062 | $reflectiontimes->setAccessible(true); 1063 | $times = $reflectiontimes->invoke(null); 1064 | 1065 | $visiblevalue = ''; 1066 | foreach ($times as $timemask => $namestring) { 1067 | 1068 | // If the value is checked. 1069 | if ($this->value & $timemask) { 1070 | $visiblevalue .= $namestring . ', '; 1071 | } 1072 | } 1073 | $visiblevalue = rtrim($visiblevalue, ', '); 1074 | 1075 | $this->visiblevalue = $visiblevalue; 1076 | } 1077 | } 1078 | 1079 | /* We need to extend all those class */ 1080 | 1081 | class admin_preset_admin_setting_configtextarea extends admin_preset_admin_setting_configtext { 1082 | } 1083 | 1084 | class admin_preset_admin_setting_configfile extends admin_preset_admin_setting_configtext { 1085 | } 1086 | 1087 | class admin_preset_admin_setting_configexecutable extends admin_preset_admin_setting_configfile { 1088 | } 1089 | 1090 | class admin_preset_admin_setting_configdirectory extends admin_preset_admin_setting_configfile { 1091 | } 1092 | 1093 | class admin_preset_admin_setting_special_backup_auto_destination extends admin_preset_admin_setting_configdirectory { 1094 | } 1095 | 1096 | class admin_preset_admin_setting_configpasswordunmask extends admin_preset_admin_setting_configtext { 1097 | } 1098 | 1099 | class admin_preset_admin_setting_langlist extends admin_preset_admin_setting_configtext { 1100 | } 1101 | 1102 | class admin_preset_admin_setting_configcolourpicker extends admin_preset_admin_setting_configtext { 1103 | } 1104 | 1105 | class admin_preset_admin_setting_emoticons extends admin_preset_setting { 1106 | } 1107 | 1108 | class admin_preset_admin_setting_confightmleditor extends admin_preset_admin_setting_configtext { 1109 | } 1110 | 1111 | class admin_preset_admin_setting_configtext_trim_lower extends admin_preset_admin_setting_configtext { 1112 | } 1113 | 1114 | class admin_preset_admin_setting_special_gradepointmax extends admin_preset_admin_setting_configtext { 1115 | } 1116 | 1117 | class admin_preset_admin_setting_special_gradepointdefault extends admin_preset_admin_setting_configtext { 1118 | } 1119 | 1120 | class admin_preset_admin_setting_configempty extends admin_preset_admin_setting_configtext { 1121 | } 1122 | 1123 | class admin_preset_admin_setting_configtext_with_maxlength extends admin_preset_admin_setting_configtext { 1124 | } 1125 | 1126 | class admin_preset_editor_tinymce_json_setting_textarea extends admin_preset_admin_setting_configtext { 1127 | } 1128 | 1129 | /** 1130 | * I'm not overwriting set_visiblevalue() as there is a lot of logic to duplicate. 1131 | */ 1132 | class admin_preset_admin_setting_configduration extends admin_preset_admin_setting_configtext { 1133 | } 1134 | 1135 | class admin_preset_enrol_flatfile_role_setting extends admin_preset_admin_setting_configtext { 1136 | } 1137 | 1138 | /** 1139 | * I'm not overwriting set_visiblevalue() as there is a lot of logic to duplicate. 1140 | * 1141 | * @see admin_preset_admin_setting_configduration 1142 | */ 1143 | class admin_preset_admin_setting_configduration_with_advanced extends admin_preset_admin_setting_configtext_with_advanced { 1144 | } 1145 | 1146 | class admin_preset_admin_setting_special_frontpagedesc extends admin_preset_admin_setting_sitesettext { 1147 | } 1148 | 1149 | class admin_preset_admin_setting_special_selectsetup extends admin_preset_admin_setting_configselect { 1150 | } 1151 | 1152 | class admin_preset_admin_setting_sitesetselect extends admin_preset_admin_setting_configselect { 1153 | } 1154 | 1155 | class admin_preset_admin_setting_special_grademinmaxtouse extends admin_preset_admin_setting_configselect { 1156 | } 1157 | 1158 | class admin_preset_admin_setting_my_grades_report extends admin_preset_admin_setting_configselect { 1159 | } 1160 | 1161 | class admin_preset_admin_setting_servertimezone extends admin_preset_admin_setting_configselect { 1162 | } 1163 | 1164 | class admin_preset_admin_setting_forcetimezone extends admin_preset_admin_setting_configselect { 1165 | } 1166 | 1167 | class admin_preset_enrol_database_admin_setting_category extends admin_preset_admin_setting_configselect { 1168 | } 1169 | 1170 | class admin_preset_enrol_ldap_admin_setting_category extends admin_preset_admin_setting_configselect { 1171 | } 1172 | 1173 | class admin_preset_format_singleactivity_admin_setting_activitytype extends admin_preset_admin_setting_configselect { 1174 | } 1175 | 1176 | class admin_preset_admin_setting_courselist_frontpage extends admin_preset_admin_setting_configmultiselect_with_loader { 1177 | } 1178 | 1179 | class admin_preset_admin_setting_configmultiselect_modules extends admin_preset_admin_setting_configmultiselect_with_loader { 1180 | } 1181 | 1182 | class admin_preset_admin_settings_country_select extends admin_preset_admin_setting_configmultiselect_with_loader { 1183 | } 1184 | 1185 | class admin_preset_admin_setting_special_registerauth extends admin_preset_admin_setting_configmultiselect_with_loader { 1186 | } 1187 | 1188 | class admin_preset_admin_setting_special_debug extends admin_preset_admin_setting_configmultiselect_with_loader { 1189 | } 1190 | 1191 | class admin_preset_admin_settings_coursecat_select extends admin_preset_admin_setting_configmultiselect_with_loader { 1192 | } 1193 | 1194 | class admin_preset_admin_setting_grade_profilereport extends admin_preset_admin_setting_configmultiselect_with_loader { 1195 | } 1196 | 1197 | class admin_preset_admin_settings_num_course_sections extends admin_preset_admin_setting_configmultiselect_with_loader { 1198 | } 1199 | 1200 | class admin_preset_admin_setting_question_behaviour extends admin_preset_admin_setting_configmultiselect_with_loader { 1201 | } 1202 | 1203 | class admin_preset_admin_setting_sitesetcheckbox extends admin_preset_admin_setting_configcheckbox { 1204 | } 1205 | 1206 | class admin_preset_admin_setting_special_adminseesall extends admin_preset_admin_setting_configcheckbox { 1207 | } 1208 | 1209 | class admin_preset_admin_setting_regradingcheckbox extends admin_preset_admin_setting_configcheckbox { 1210 | } 1211 | 1212 | class admin_preset_admin_setting_special_gradelimiting extends admin_preset_admin_setting_configcheckbox { 1213 | } 1214 | 1215 | class admin_preset_admin_setting_enablemobileservice extends admin_preset_admin_setting_configcheckbox { 1216 | } 1217 | 1218 | class admin_preset_admin_setting_pickroles extends admin_preset_admin_setting_configmulticheckbox { 1219 | } 1220 | 1221 | class admin_preset_admin_setting_special_coursemanager extends admin_preset_admin_setting_configmulticheckbox { 1222 | } 1223 | 1224 | class admin_preset_admin_setting_special_coursecontact extends admin_preset_admin_setting_configmulticheckbox { 1225 | } 1226 | 1227 | class admin_preset_admin_setting_special_gradebookroles extends admin_preset_admin_setting_configmulticheckbox { 1228 | } 1229 | 1230 | class admin_preset_admin_setting_special_gradeexport extends admin_preset_admin_setting_configmulticheckbox { 1231 | } -------------------------------------------------------------------------------- /module.js: -------------------------------------------------------------------------------- 1 | M.block_admin_presets = { 2 | 3 | tree: null, 4 | nodes: null, 5 | 6 | 7 | /** 8 | * Initializes the TreeView object and adds the submit listener 9 | */ 10 | init: function (Y) { 11 | 12 | Y.use('yui2-treeview', function (Y) { 13 | 14 | var context = M.block_admin_presets; 15 | 16 | context.tree = new Y.YUI2.widget.TreeView("settings_tree_div"); 17 | 18 | context.nodes = []; 19 | context.nodes.root = context.tree.getRoot(); 20 | }); 21 | }, 22 | 23 | /** 24 | * Creates a tree branch 25 | */ 26 | addNodes: function (Y, ids, nodeids, labels, descriptions, parents) { 27 | 28 | var context = M.block_admin_presets; 29 | 30 | var nelements = ids.length; 31 | for (var i = 0; i < nelements; i++) { 32 | 33 | var settingId = ids[i]; 34 | var nodeId = nodeids[i]; 35 | var label = decodeURIComponent(labels[i]); 36 | var description = decodeURIComponent(descriptions[i]); 37 | var parent = parents[i]; 38 | 39 | var newNode = new Y.YUI2.widget.HTMLNode(label, context.nodes[parent]); 40 | 41 | newNode.settingId = settingId; 42 | newNode.setNodesProperty('title', description); 43 | newNode.highlightState = 1; 44 | 45 | context.nodes[nodeId] = newNode; 46 | } 47 | }, 48 | 49 | render: function (Y) { 50 | 51 | var context = M.block_admin_presets; 52 | var categories = context.tree.getNodesByProperty('settingId', 'category'); 53 | // Cleaning categories without children. 54 | if (categories) { 55 | for (var i = 0; i < categories.length; i++) { 56 | if (!categories[i].hasChildren()) { 57 | context.tree.popNode(categories[i]); 58 | } 59 | } 60 | } 61 | categories = context.tree.getRoot().children; 62 | if (categories) { 63 | for (var j = 0; j < categories.length; j++) { 64 | if (!categories[j].hasChildren()) { 65 | context.tree.popNode(categories[j]); 66 | } 67 | } 68 | } 69 | 70 | // Context.tree.expandAll();. 71 | context.tree.setNodesProperty('propagateHighlightUp', true); 72 | context.tree.setNodesProperty('propagateHighlightDown', true); 73 | context.tree.subscribe('clickEvent', context.tree.onEventToggleHighlight); 74 | context.tree.render(); 75 | 76 | // Listener to create one node for each selected setting. 77 | Y.YUI2.util.Event.on('id_admin_presets_submit', 'click', function () { 78 | 79 | // We need the moodle form to add the checked settings. 80 | var settingsPresetsForm = document.getElementById('id_admin_presets_submit').parentNode; 81 | 82 | var hiLit = context.tree.getNodesByProperty('highlightState', 1); 83 | if (Y.YUI2.lang.isNull(hiLit)) { 84 | Y.YUI2.log("Nothing selected"); 85 | 86 | } else { 87 | 88 | // Only for debugging. 89 | var labels = []; 90 | 91 | for (var i = 0; i < hiLit.length; i++) { 92 | 93 | var treeNode = hiLit[i]; 94 | 95 | // Only settings not setting categories nor settings pages. 96 | if (treeNode.settingId !== 'category' && treeNode.settingId !== 'page') { 97 | labels.push(treeNode.settingId); 98 | 99 | // If the node does not exists we add it. 100 | if (!document.getElementById(treeNode.settingId)) { 101 | 102 | var settingInput = document.createElement('input'); 103 | settingInput.setAttribute('type', 'hidden'); 104 | settingInput.setAttribute('name', treeNode.settingId); 105 | settingInput.setAttribute('value', '1'); 106 | settingsPresetsForm.appendChild(settingInput); 107 | } 108 | } 109 | } 110 | 111 | Y.YUI2.log("Checked settings:\n" + labels.join("\n"), "info"); 112 | } 113 | }); 114 | } 115 | }; 116 | -------------------------------------------------------------------------------- /pix/check0.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DigiDago/moodle-block_admin_presets/59e883469523a89f1eca2b364555e1ce61df33fa/pix/check0.gif -------------------------------------------------------------------------------- /pix/check1.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DigiDago/moodle-block_admin_presets/59e883469523a89f1eca2b364555e1ce61df33fa/pix/check1.gif -------------------------------------------------------------------------------- /pix/check2.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DigiDago/moodle-block_admin_presets/59e883469523a89f1eca2b364555e1ce61df33fa/pix/check2.gif -------------------------------------------------------------------------------- /settings.php: -------------------------------------------------------------------------------- 1 | . 16 | 17 | /** 18 | * Admin presets block main controller 19 | * 20 | * @package blocks/admin_presets 21 | * @copyright 2019 Pimenko