MDL-27827 - Missing messageprovider:message language string
[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(dirname(__FILE__) . '/../config.php');
27 require_once($CFG->libdir . '/adminlib.php');
29 $contextid = required_param('contextid',PARAM_INT);
30 $forfilter = optional_param('filter', '', PARAM_SAFEPATH);
32 list($context, $course, $cm) = get_context_info_array($contextid);
34 /// Check login and permissions.
35 require_login($course, false, $cm);
36 require_capability('moodle/filter:manage', $context);
38 $args = array('contextid'=>$contextid);
39 $baseurl = new moodle_url('/filter/manage.php', $args);
40 if (!empty($forfilter)) {
41     $args['filter'] = $forfilter;
42 }
43 $PAGE->set_url($baseurl, $args);
45 // This is a policy decision, rather than something that would be impossible to implement.
46 if (!in_array($context->contextlevel, array(CONTEXT_COURSECAT, CONTEXT_COURSE, CONTEXT_MODULE))) {
47     print_error('cannotcustomisefiltersblockuser', 'error');
48 }
50 $isfrontpage = ($context->contextlevel == CONTEXT_COURSE && $context->instanceid == SITEID);
52 $contextname = print_context_name($context);
54 if ($context->contextlevel == CONTEXT_COURSECAT) {
55     $heading = "$SITE->fullname: ".get_string("categories");
56 } else if ($context->contextlevel == CONTEXT_COURSE) {
57     $heading = $course->fullname;
58 } else if ($context->contextlevel == CONTEXT_MODULE) {
59     // Must be module context.
60     $heading = $PAGE->activityrecord->name;
61 } else {
62     $heading = '';
63 }
65 /// Check login and permissions.
66 require_login($course, false, $cm);
67 require_capability('moodle/filter:manage', $context);
69 $PAGE->set_context($context);
70 $PAGE->set_heading($heading);
72 /// Get the list of available filters.
73 $availablefilters = filter_get_available_in_context($context);
74 if (!$isfrontpage && empty($availablefilters)) {
75     print_error('nofiltersenabled', 'error');
76 }
78 // If we are handling local settings for a particular filter, start processing.
79 if ($forfilter) {
80     if (!filter_has_local_settings($forfilter)) {
81         print_error('filterdoesnothavelocalconfig', 'error', $forfilter);
82     }
83     require_once($CFG->dirroot . '/filter/local_settings_form.php');
84     require_once($CFG->dirroot . '/' . $forfilter . '/filterlocalsettings.php');
85     $formname = basename($forfilter) . '_filter_local_settings_form';
86     $settingsform = new $formname($CFG->wwwroot . '/filter/manage.php', $forfilter, $context);
87     if ($settingsform->is_cancelled()) {
88         redirect($baseurl);
89     } else if ($data = $settingsform->get_data()) {
90         $settingsform->save_changes($data);
91         redirect($baseurl);
92     }
93 }
95 /// Process any form submission.
96 if ($forfilter == '' && optional_param('savechanges', false, PARAM_BOOL) && confirm_sesskey()) {
97     foreach ($availablefilters as $filter => $filterinfo) {
98         $newstate = optional_param(str_replace('/', '_', $filter), false, PARAM_INT);
99         if ($newstate !== false && $newstate != $filterinfo->localstate) {
100             filter_set_local_state($filter, $context->id, $newstate);
101         }
102     }
103     redirect($CFG->wwwroot . '/filter/manage.php?contextid=' . $context->id, get_string('changessaved'), 1);
106 /// Work out an appropriate page title.
107 if ($forfilter) {
108     $a = new stdClass;
109     $a->filter = filter_get_name($forfilter);
110     $a->context = $contextname;
111     $title = get_string('filtersettingsforin', 'filters', $a);
112 } else {
113     $title = get_string('filtersettingsin', 'filters', $contextname);
115 $straction = get_string('filters', 'admin'); // Used by tabs.php
117 /// Print the header and tabs
118 if ($isfrontpage) {
119     admin_externalpage_setup('frontpagefilters');
120     echo $OUTPUT->header();
121 } else {
122     $PAGE->set_cacheable(false);
123     $PAGE->set_title($title);
124     $PAGE->set_pagelayout('admin');
125     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(), 'method'=>'post'));
157     echo html_writer::start_tag('div');
158     echo html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'sesskey', 'value'=>sesskey()));
160     $table = new html_table();
161     $table->head  = array(get_string('filter'), get_string('isactive', 'filters'));
162     $table->align = array('left', 'left');
163     if ($settingscol) {
164         $table->head[] = $strsettings;
165         $table->align[] = 'left';
166     }
167     $table->width = ' ';
168     $table->data = array();
170     // iterate through filters adding to display table
171     foreach ($availablefilters as $filter => $filterinfo) {
172         $row = array();
174         // Filter name.
175         $row[] = filter_get_name($filter);
177         // Default/on/off choice.
178         if ($filterinfo->inheritedstate == TEXTFILTER_ON) {
179             $activechoices[TEXTFILTER_INHERIT] = $strdefaulton;
180         } else {
181             $activechoices[TEXTFILTER_INHERIT] = $strdefaultoff;
182         }
183         $row[] = html_writer::select($activechoices, str_replace('/', '_', $filter), $filterinfo->localstate, false);
185         // Settings link, if required
186         if ($settingscol) {
187             $settings = '';
188             if ($filterinfo->hassettings) {
189                 $settings = '<a href="' . $baseurl->out(true, array('filter'=>$filter)). '">' . $strsettings . '</a>';
190             }
191             $row[] = $settings;
192         }
194         $table->data[] = $row;
195     }
197     echo html_writer::table($table);
198     echo html_writer::start_tag('div', array('class'=>'buttons'));
199     echo html_writer::empty_tag('input', array('type'=>'submit', 'name'=>'savechanges', 'value'=>get_string('savechanges')));
200     echo html_writer::end_tag('div');
201     echo html_writer::end_tag('div');
202     echo html_writer::end_tag('form');
205 /// Appropriate back link.
206 if (!$isfrontpage) {
207     echo html_writer::start_tag('div', array('class'=>'backlink'));
208     echo html_writer::tag('a', get_string('backto', '', $contextname), array('href'=>get_context_url($context)));
209     echo html_writer::end_tag('div');
212 echo $OUTPUT->footer();