MDL-69240 tool_moodlenet: Clean MoodleNet profile field
[moodle.git] / filter / manage.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  * Lets users configure which filters are active in a sub-context.
20  *
21  * @license    http://www.gnu.org/copyleft/gpl.html GNU Public License
22  * @package    core
23  * @subpackage filter
24  */
26 require_once(__DIR__ . '/../config.php');
27 require_once($CFG->libdir . '/adminlib.php');
29 $contextid = required_param('contextid',PARAM_INT);
30 $forfilter = optional_param('filter', '', PARAM_SAFEDIR);
31 $returnto  = optional_param('return', null, PARAM_ALPHANUMEXT);
33 list($context, $course, $cm) = get_context_info_array($contextid);
35 /// Check login and permissions.
36 require_login($course, false, $cm);
37 require_capability('moodle/filter:manage', $context);
38 $PAGE->set_context($context);
40 $args = array('contextid'=>$contextid);
41 $baseurl = new moodle_url('/filter/manage.php', $args);
42 if (!empty($forfilter)) {
43     $args['filter'] = $forfilter;
44 }
45 $PAGE->set_url($baseurl, $args);
46 if ($returnto !== null) {
47     $baseurl->param('return', $returnto);
48 }
50 // This is a policy decision, rather than something that would be impossible to implement.
51 if (!in_array($context->contextlevel, array(CONTEXT_COURSECAT, CONTEXT_COURSE, CONTEXT_MODULE))) {
52     print_error('cannotcustomisefiltersblockuser', 'error');
53 }
55 $isfrontpage = ($context->contextlevel == CONTEXT_COURSE && $context->instanceid == SITEID);
57 $contextname = $context->get_context_name();
59 if ($context->contextlevel == CONTEXT_COURSECAT) {
60     $heading = $SITE->fullname;
61 } else if ($context->contextlevel == CONTEXT_COURSE) {
62     $heading = $course->fullname;
63 } else if ($context->contextlevel == CONTEXT_MODULE) {
64     // Must be module context.
65     $heading = $PAGE->activityrecord->name;
66 } else {
67     $heading = '';
68 }
70 /// Check login and permissions.
71 require_login($course, false, $cm);
72 require_capability('moodle/filter:manage', $context);
74 $PAGE->set_context($context);
75 $PAGE->set_heading($heading);
77 /// Get the list of available filters.
78 $availablefilters = filter_get_available_in_context($context);
79 if (!$isfrontpage && empty($availablefilters)) {
80     print_error('nofiltersenabled', 'error');
81 }
83 // If we are handling local settings for a particular filter, start processing.
84 if ($forfilter) {
85     if (!filter_has_local_settings($forfilter)) {
86         print_error('filterdoesnothavelocalconfig', 'error', $forfilter);
87     }
88     require_once($CFG->dirroot . '/filter/local_settings_form.php');
89     require_once($CFG->dirroot . '/filter/' . $forfilter . '/filterlocalsettings.php');
90     $formname = $forfilter . '_filter_local_settings_form';
91     $settingsform = new $formname($CFG->wwwroot . '/filter/manage.php', $forfilter, $context);
92     if ($settingsform->is_cancelled()) {
93         redirect($baseurl);
94     } else if ($data = $settingsform->get_data()) {
95         $settingsform->save_changes($data);
96         redirect($baseurl);
97     }
98 }
100 /// Process any form submission.
101 if ($forfilter == '' && optional_param('savechanges', false, PARAM_BOOL) && confirm_sesskey()) {
102     foreach ($availablefilters as $filter => $filterinfo) {
103         $newstate = optional_param($filter, false, PARAM_INT);
104         if ($newstate !== false && $newstate != $filterinfo->localstate) {
105             filter_set_local_state($filter, $context->id, $newstate);
106         }
107     }
108     redirect($baseurl, get_string('changessaved'), 1);
111 /// Work out an appropriate page title.
112 if ($forfilter) {
113     $a = new stdClass;
114     $a->filter = filter_get_name($forfilter);
115     $a->context = $contextname;
116     $title = get_string('filtersettingsforin', 'filters', $a);
117 } else {
118     $title = get_string('filtersettingsin', 'filters', $contextname);
120 $straction = get_string('filters', 'admin'); // Used by tabs.php
122 // Print the header and tabs.
123 $PAGE->set_cacheable(false);
124 $PAGE->set_title($title);
125 $PAGE->set_pagelayout('admin');
126 echo $OUTPUT->header();
128 /// Print heading.
129 echo $OUTPUT->heading_with_help($title, 'filtersettings', 'filters');
131 if (empty($availablefilters)) {
132     echo '<p class="centerpara">' . get_string('nofiltersenabled', 'filters') . "</p>\n";
133 } else if ($forfilter) {
134     $current = filter_get_local_config($forfilter, $contextid);
135     $settingsform->set_data((object) $current);
136     $settingsform->display();
137 } else {
138     $settingscol = false;
139     foreach ($availablefilters as $filter => $notused) {
140         $hassettings = filter_has_local_settings($filter);
141         $availablefilters[$filter]->hassettings = $hassettings;
142         $settingscol = $settingscol || $hassettings;
143     }
145     $strsettings = get_string('settings');
146     $stroff = get_string('off', 'filters');
147     $stron = get_string('on', 'filters');
148     $strdefaultoff = get_string('defaultx', 'filters', $stroff);
149     $strdefaulton = get_string('defaultx', 'filters', $stron);
150     $activechoices = array(
151         TEXTFILTER_INHERIT => '',
152         TEXTFILTER_OFF => $stroff,
153         TEXTFILTER_ON => $stron,
154     );
156     echo html_writer::start_tag('form', array('action'=>$baseurl->out_omit_querystring(), 'method'=>'post'));
157     echo html_writer::start_tag('div');
158     echo html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'sesskey', 'value'=>sesskey()));
159     foreach ($baseurl->params() as $key => $value) {
160         echo html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>$key, 'value'=>$value));
161     }
163     $table = new html_table();
164     $table->head  = array(get_string('filter'), get_string('isactive', 'filters'));
165     $table->colclasses = array('leftalign', 'leftalign');
166     if ($settingscol) {
167         $table->head[] = $strsettings;
168         $table->colclasses[] = 'leftalign';
169     }
170     $table->id = 'frontpagefiltersettings';
171     $table->attributes['class'] = 'admintable generaltable';
172     $table->data = array();
174     // iterate through filters adding to display table
175     foreach ($availablefilters as $filter => $filterinfo) {
176         $row = array();
178         // Filter name.
179         $row[] = filter_get_name($filter);
181         // Default/on/off choice.
182         if ($filterinfo->inheritedstate == TEXTFILTER_ON) {
183             $activechoices[TEXTFILTER_INHERIT] = $strdefaulton;
184         } else {
185             $activechoices[TEXTFILTER_INHERIT] = $strdefaultoff;
186         }
187         $select = html_writer::label($filterinfo->localstate, 'menu'. $filter, false, array('class' => 'accesshide'));
188         $select .= html_writer::select($activechoices, $filter, $filterinfo->localstate, false);
189         $row[] = $select;
191         // Settings link, if required
192         if ($settingscol) {
193             $settings = '';
194             if ($filterinfo->hassettings) {
195                 $settings = '<a href="' . $baseurl->out(true, array('filter'=>$filter)). '">' . $strsettings . '</a>';
196             }
197             $row[] = $settings;
198         }
200         $table->data[] = $row;
201     }
203     echo html_writer::table($table);
204     echo html_writer::start_tag('div', array('class'=>'buttons'));
205     $submitattr = ['type' => 'submit', 'name' => 'savechanges', 'value' => get_string('savechanges'), 'class' => 'btn btn-primary'];
206     echo html_writer::empty_tag('input', $submitattr);
207     echo html_writer::end_tag('div');
208     echo html_writer::end_tag('div');
209     echo html_writer::end_tag('form');
212 /// Appropriate back link.
213 if (!$isfrontpage) {
215     if ($context->contextlevel === CONTEXT_COURSECAT && $returnto === 'management') {
216         $url = new moodle_url('/course/management.php', array('categoryid' => $context->instanceid));
217     } else {
218         $url = $context->get_url();
219     }
221     echo html_writer::start_tag('div', array('class'=>'backlink'));
222     echo html_writer::tag('a', get_string('backto', '', $contextname), array('href' => $url));
223     echo html_writer::end_tag('div');
226 echo $OUTPUT->footer();