334dc719fbf3db84bebb40893781d3874c52e0fa
[moodle.git] / admin / filters.php
1 <?php
3 ///////////////////////////////////////////////////////////////////////////
4 //                                                                       //
5 // NOTICE OF COPYRIGHT                                                   //
6 //                                                                       //
7 // Moodle - Modular Object-Oriented Dynamic Learning Environment         //
8 //          http://moodle.org                                            //
9 //                                                                       //
10 // Copyright (C) 1999 onwards Martin Dougiamas  http://dougiamas.com     //
11 //                                                                       //
12 // This program is free software; you can redistribute it and/or modify  //
13 // it under the terms of the GNU General Public License as published by  //
14 // the Free Software Foundation; either version 2 of the License, or     //
15 // (at your option) any later version.                                   //
16 //                                                                       //
17 // This program is distributed in the hope that it will be useful,       //
18 // but WITHOUT ANY WARRANTY; without even the implied warranty of        //
19 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         //
20 // GNU General Public License for more details:                          //
21 //                                                                       //
22 //          http://www.gnu.org/copyleft/gpl.html                         //
23 //                                                                       //
24 ///////////////////////////////////////////////////////////////////////////
26 /**
27  * Processes actions from the admin_setting_managefilters object (defined in
28  * adminlib.php).
29  *
30  * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
31  * @package administration
32  *//** */
34     require_once(dirname(__FILE__) . '/../config.php');
35     require_once($CFG->libdir . '/adminlib.php');
36     require_once($CFG->libdir . '/pluginlib.php');
38     $action = optional_param('action', '', PARAM_ALPHANUMEXT);
39     $filterpath = optional_param('filterpath', '', PARAM_SAFEDIR);
41     require_login();
42     $systemcontext = context_system::instance();
43     require_capability('moodle/site:config', $systemcontext);
45     $returnurl = "$CFG->wwwroot/$CFG->admin/filters.php";
46     admin_externalpage_setup('managefilters');
48     $filters = filter_get_global_states();
50     // In case any new filters have been installed, but not put in the table yet.
51     $fitlernames = filter_get_all_installed();
52     $newfilters = $fitlernames;
53     foreach ($filters as $filter => $notused) {
54         unset($newfilters[$filter]);
55     }
57 /// Process actions ============================================================
59     if ($action) {
60         if ($action !== 'delete' and !isset($filters[$filterpath]) and !isset($newfilters[$filterpath])) {
61             throw new moodle_exception('filternotinstalled', 'error', $returnurl, $filterpath);
62         }
64         if (!confirm_sesskey()) {
65             redirect($returnurl);
66         }
67     }
69     switch ($action) {
71     case 'setstate':
72         if ($newstate = optional_param('newstate', '', PARAM_INT)) {
73             filter_set_global_state($filterpath, $newstate);
74             if ($newstate == TEXTFILTER_DISABLED) {
75                 filter_set_applies_to_strings($filterpath, false);
76             }
77             unset($newfilters[$filterpath]);
78         }
79         break;
81     case 'setapplyto':
82         $applytostrings = optional_param('stringstoo', false, PARAM_BOOL);
83         filter_set_applies_to_strings($filterpath, $applytostrings);
84         break;
86     case 'down':
87         if (isset($filters[$filterpath])) {
88             filter_set_global_state($filterpath, $filters[$filterpath]->active, 1);
89         }
90         break;
92     case 'up':
93         if (isset($filters[$filterpath])) {
94             $oldpos = $filters[$filterpath]->sortorder;
95             filter_set_global_state($filterpath, $filters[$filterpath]->active, -1);
96         }
97         break;
99     case 'delete':
100         // If not yet confirmed, display a confirmation message.
101         if (!optional_param('confirm', '', PARAM_BOOL)) {
102             $filtername = filter_get_name($filterpath);
104             $title = get_string('deletefilterareyousure', 'admin', $filtername);
105             echo $OUTPUT->header();
106             echo $OUTPUT->heading($title);
108             $linkcontinue = new moodle_url($returnurl, array('action' => 'delete', 'filterpath' => $filterpath, 'confirm' => 1));
109             $formcancel = new single_button(new moodle_url($returnurl), get_string('no'), 'get');
110             echo $OUTPUT->confirm(get_string('deletefilterareyousuremessage', 'admin', $filtername), $linkcontinue, $formcancel);
111             echo $OUTPUT->footer();
112             exit;
113         }
115         // Do the deletion.
116         $title = get_string('deletingfilter', 'admin', $filterpath);
117         echo $OUTPUT->header();
118         echo $OUTPUT->heading($title);
120         // Delete all data for this plugin.
121         filter_delete_all_for_filter($filterpath);
123         $a = new stdClass;
124         $a->filter = $filterpath;
125         $a->directory = "$CFG->dirroot/filter/$filterpath";
126         echo $OUTPUT->box(get_string('deletefilterfiles', 'admin', $a), 'generalbox', 'notice');
127         echo $OUTPUT->continue_button($returnurl);
128         echo $OUTPUT->footer();
129         exit;
130     }
132     // Add any missing filters to the DB table.
133     foreach ($newfilters as $filter => $notused) {
134         filter_set_global_state($filter, TEXTFILTER_DISABLED);
135     }
137     // Reset caches and return
138     if ($action) {
139         plugin_manager::reset_caches();
140         reset_text_filters_cache();
141         redirect($returnurl);
142     }
144 /// End of process actions =====================================================
146 /// Print the page heading.
147     echo $OUTPUT->header();
148     echo $OUTPUT->heading(get_string('filtersettings', 'admin'));
150     $activechoices = array(
151         TEXTFILTER_DISABLED => get_string('disabled', 'filters'),
152         TEXTFILTER_OFF => get_string('offbutavailable', 'filters'),
153         TEXTFILTER_ON => get_string('on', 'filters'),
154     );
155     $applytochoices = array(
156         0 => get_string('content', 'filters'),
157         1 => get_string('contentandheadings', 'filters'),
158     );
160     $filters = filter_get_global_states();
162     // In case any new filters have been installed, but not put in the table yet.
163     $filternames = filter_get_all_installed();
164     $newfilters = $filternames;
165     foreach ($filters as $filter => $notused) {
166         unset($newfilters[$filter]);
167     }
168     $stringfilters = filter_get_string_filters();
170     $table = new html_table();
171     $table->head  = array(get_string('filter'), get_string('isactive', 'filters'),
172             get_string('order'), get_string('applyto', 'filters'), get_string('settings'), get_string('delete'));
173     $table->colclasses = array ('leftalign', 'leftalign', 'centeralign', 'leftalign', 'leftalign', 'leftalign');
174     $table->attributes['class'] = 'admintable generaltable';
175     $table->id = 'filterssetting';
176     $table->data  = array();
178     $lastactive = null;
179     foreach ($filters as $filter => $filterinfo) {
180         if ($filterinfo->active != TEXTFILTER_DISABLED) {
181             $lastactive = $filter;
182         }
183     }
185     // iterate through filters adding to display table
186     $firstrow = true;
187     foreach ($filters as $filter => $filterinfo) {
188         $applytostrings = isset($stringfilters[$filter]) && $filterinfo->active != TEXTFILTER_DISABLED;
189         $row = get_table_row($filterinfo, $firstrow, $filter == $lastactive, $applytostrings);
190         $table->data[] = $row;
191         if ($filterinfo->active == TEXTFILTER_DISABLED) {
192             $table->rowclasses[] = 'dimmed_text';
193         } else {
194             $table->rowclasses[] = '';
195         }
196         $firstrow = false;
197     }
198     foreach ($newfilters as $filter => $filtername) {
199         $filterinfo = new stdClass;
200         $filterinfo->filter = $filter;
201         $filterinfo->active = TEXTFILTER_DISABLED;
202         $row = get_table_row($filterinfo, false, false, false);
203         $table->data[] = $row;
204         $table->rowclasses[] = 'dimmed_text';
205     }
207     echo html_writer::table($table);
208     echo '<p class="filtersettingnote">' . get_string('filterallwarning', 'filters') . '</p>';
209     echo $OUTPUT->footer();
211 /// Display helper functions ===================================================
213 function filters_action_url($filterpath, $action) {
214     return new moodle_url('/admin/filters.php', array('sesskey'=>sesskey(), 'filterpath'=>$filterpath, 'action'=>$action));
217 function get_table_row($filterinfo, $isfirstrow, $islastactive, $applytostrings) {
218     global $CFG, $OUTPUT, $activechoices, $applytochoices, $filternames; //TODO: this is sloppy coding style!!
219     $row = array();
220     $filter = $filterinfo->filter;
222     // Filter name
223     if (!empty($filternames[$filter])) {
224         $row[] = $filternames[$filter];
225     } else {
226         $row[] = '<span class="error">' . get_string('filemissing', '', $filter) . '</span>';
227     }
229     // Disable/off/on
230     $select = new single_select(filters_action_url($filter, 'setstate'), 'newstate', $activechoices, $filterinfo->active, null, 'active' . $filter);
231     $select->set_label(get_string('isactive', 'filters'), array('class' => 'accesshide'));
232     $row[] = $OUTPUT->render($select);
234     // Re-order
235     $updown = '';
236     $spacer = '<img src="' . $OUTPUT->pix_url('spacer') . '" class="iconsmall" alt="" />';
237     if ($filterinfo->active != TEXTFILTER_DISABLED) {
238         if (!$isfirstrow) {
239             $updown .= $OUTPUT->action_icon(filters_action_url($filter, 'up'), new pix_icon('t/up', get_string('up'), '', array('class' => 'iconsmall')));
240         } else {
241             $updown .= $spacer;
242         }
243         if (!$islastactive) {
244             $updown .= $OUTPUT->action_icon(filters_action_url($filter, 'down'), new pix_icon('t/down', get_string('down'), '', array('class' => 'iconsmall')));
245         } else {
246             $updown .= $spacer;
247         }
248     }
249     $row[] = $updown;
251     // Apply to strings.
252     $select = new single_select(filters_action_url($filter, 'setapplyto'), 'stringstoo', $applytochoices, $applytostrings, null, 'applyto' . $filter);
253     $select->set_label(get_string('applyto', 'filters'), array('class' => 'accesshide'));
254     $select->disabled = $filterinfo->active == TEXTFILTER_DISABLED;
255     $row[] = $OUTPUT->render($select);
257     // Settings link, if required
258     if (filter_has_global_settings($filter)) {
259         $row[] = '<a href="' . $CFG->wwwroot . '/' . $CFG->admin . '/settings.php?section=filtersetting' . $filter . '">' . get_string('settings') . '</a>';
260     } else {
261         $row[] = '';
262     }
264     // Delete
265     $row[] = '<a href="' . filters_action_url($filter, 'delete') . '">' . get_string('delete') . '</a>';
267     return $row;