Filter settings
+ +This page lets you turn filters on or off in a particular part of the site. +This page only gives you access to those filters that the Administrator has +enabled.
+ +Some filters may also let you set local settings, in which case there will be +a 'Settings' link next to their name.
\ No newline at end of file diff --git a/lang/en_utf8/role.php b/lang/en_utf8/role.php index 71e8e6c..83ec50a 100644 --- a/lang/en_utf8/role.php +++ b/lang/en_utf8/role.php @@ -103,6 +103,7 @@ $string['explainpermissionsinfo'] = 'To use this table:
- First look
$string['explainpermissionsdoanything'] = 'Note that this user has the moodle/site:doanything capability, so even though the table above shows that has_capability will return false, this user will actually be deemed to have the capability $a in most circumstances.';
$string['extusers'] = 'Existing users';
$string['extusersmatching'] = 'Existing users matching \'$a\'';
+$string['filter:manage'] = 'Manage local filter settings';
$string['globalrole'] = 'System role';
$string['globalroleswarning'] = 'WARNING! Any roles you assign from this page will apply to the assigned users throughout the entire system, including the front page and all the courses.';
$string['gotoassignroles'] = 'Go to Assign roles for this $a->contextlevel';
diff --git a/lib/adminlib.php b/lib/adminlib.php
index f771db5..d3d90e8 100644
--- a/lib/adminlib.php
+++ b/lib/adminlib.php
@@ -3711,7 +3711,8 @@ class admin_setting_managefilters extends admin_setting {
}
public function write_setting($data) {
- // do not write any setting
+ // do not write any settings. Instead all our UI submits to admin/filters.php
+ // which makes and changes, then redirects back.
return '';
}
@@ -3734,121 +3735,131 @@ class admin_setting_managefilters extends admin_setting {
return false;
}
- public function output_html($data, $query='') {
+ protected function action_url($filterpath, $action) {
global $CFG;
+ return $CFG->wwwroot . '/' . $CFG->admin . '/filters.php?sesskey=' . sesskey() .
+ '&filterpath=' . urlencode($filterpath) . '&action=' . $action;
+ }
- $strname = get_string('name');
- $strhide = get_string('disable');
- $strshow = get_string('enable');
- $strhideshow = "$strhide/$strshow";
- $strsettings = get_string('settings');
- $strup = get_string('up');
- $strdown = get_string('down');
- $strupdown = "$strup/$strdown";
-
- // get a list of possible filters (and translate name if possible)
- // note filters can be in the dedicated filters area OR in their
- // associated modules
- $installedfilters = filter_get_all_installed();
- $filtersettings_new = array();
- foreach ($installedfilters as $path => $strfiltername) {
- $settingspath_new = $CFG->dirroot . '/' . $path . '/filtersettings.php';
- if (is_readable($settingspath_new)) {
- $filtersettings_new[] = $path;
+ protected function action_icon($url, $icon, $straction) {
+ global $CFG;
+ return '' .
+ '
';
+ }
+
+ protected function get_table_row($filterinfo, $isfirstrow, $islastactive, $applytostrings) {
+ global $CFG;
+ $row = array();
+ $filter = $filterinfo->filter;
+
+ // Filter name
+ $row[] = $this->filternames[$filter];
+
+ // Disable/off/on
+ $row[] = popup_form($this->action_url($filter, 'setstate') . '&newstate=', $this->activechoices,
+ 'active' . basename($filter), $filterinfo->active, '', '', '', true, 'self', '', NULL, get_string('save'));
+
+ // Re-order
+ $updown = '';
+ $spacer = '
';
+ if ($filterinfo->active != TEXTFILTER_DISABLED) {
+ if (!$isfirstrow) {
+ $updown .= $this->action_icon($this->action_url($filter, 'up'), 'up', $this->strup);
+ } else {
+ $updown .= $spacer;
+ }
+ if (!$islastactive) {
+ $updown .= $this->action_icon($this->action_url($filter, 'down'), 'down', $this->strdown);
+ } else {
+ $updown .= $spacer;
}
}
+ $row[] = $updown;
- // get all the currently selected filters
- if (!empty($CFG->textfilters)) {
- $oldactivefilters = explode(',', $CFG->textfilters);
- $oldactivefilters = array_unique($oldactivefilters);
- } else {
- $oldactivefilters = array();
- }
+ // Apply to strings.
+ $row[] = popup_form($this->action_url($filter, 'setapplyto') . '&stringstoo=', $this->applytochoices,
+ 'applyto' . basename($filter), $applytostrings, '', '', '', true, 'self', '', NULL, get_string('save'),
+ $filterinfo->active == TEXTFILTER_DISABLED);
- // take this opportunity to clean up filters
- $activefilters = array();
- foreach ($oldactivefilters as $oldactivefilter) {
- if (!empty($oldactivefilter) and array_key_exists($oldactivefilter, $installedfilters)) {
- $activefilters[] = $oldactivefilter;
- }
+ // Settings link, if required
+ $settings = '';
+ if (filter_has_global_settings($filter)) {
+ $settings = '' . $this->strsettings . '';
}
+ $row[] = $settings;
- // Get the list of all filters, and pull the active filters
- // to the top.
- $displayfilters = array();
- foreach ($activefilters as $activefilter) {
- $name = $installedfilters[$activefilter];
- $displayfilters[$activefilter] = $name;
- }
- foreach ($installedfilters as $key => $filter) {
- if (!array_key_exists($key, $displayfilters)) {
- $displayfilters[$key] = $filter;
- }
+ return $row;
+ }
+
+ public function output_html($data, $query='') {
+ global $CFG;
+
+ $this->activechoices = array(
+ TEXTFILTER_DISABLED => get_string('disabled', 'filters'),
+ TEXTFILTER_OFF => get_string('offbutavailable', 'filters'),
+ TEXTFILTER_ON => get_string('on', 'filters'),
+ );
+ $this->applytochoices = array(
+ 0 => get_string('content', 'filters'),
+ 1 => get_string('contentandheadings', 'filters'),
+ );
+ $this->strup = get_string('up');
+ $this->strdown = get_string('down');
+ $this->strsettings = get_string('settings');
+
+ $filters = filter_get_global_states();
+
+ // In case any new filters have been installed, but not put in the table yet.
+ $this->filternames = filter_get_all_installed();
+ $newfilters = $this->filternames;
+ foreach ($filters as $filter => $notused) {
+ unset($newfilters[$filter]);
}
+ $stringfilters = filter_get_string_filters();
$return = print_heading(get_string('actfilterhdr', 'filters'), '', 3, 'main', true);
$return .= print_box_start('generalbox filtersui', '', true);
$table = new object();
- $table->head = array($strname, $strhideshow, $strupdown, $strsettings);
- $table->align = array('left', 'center', 'center', 'center');
- $table->width = '90%';
+ $table->head = array(get_string('filter'), get_string('isactive', 'filters'),
+ get_string('order'), get_string('applyto', 'filters'), $this->strsettings);
+ $table->align = array('left', 'left', 'center', 'left', 'left');
+ $table->width = '100%';
$table->data = array();
- $filtersurl = "$CFG->wwwroot/$CFG->admin/filters.php?sesskey=".sesskey();
- $imgurl = "$CFG->pixpath/t";
-
- // iterate through filters adding to display table
- $updowncount = 1;
- $activefilterscount = count($activefilters);
- foreach ($displayfilters as $path => $name) {
- $upath = urlencode($path);
- // get hide/show link
- if (in_array($path, $activefilters)) {
- $hideshow = "";
- $hideshow .= "pixpath}/i/hide.gif\" class=\"icon\" alt=\"$strhide\" />"; - $hidden = false; - $displayname = "$name"; - } - else { - $hideshow = ""; - $hideshow .= "
![\"$strup\"](\"$imgurl/up.gif\")
";
- }
- else {
- $updown .= "pixpath/spacer.gif\" class=\"icon\" alt=\"\" /> "; - } - if ($updowncount<$activefilterscount) { - $updown .= ""; - $updown .= "
![\"$strdown\"](\"$imgurl/down.gif\")
";
- }
- else {
- $updown .= "' . get_string('tablenosave', 'filters') . '
'; + $return .= '' . get_string('filterallwarning', 'filters') . '
'; $return .= print_box_end(true); return highlight($query, $return); } diff --git a/lib/db/access.php b/lib/db/access.php index 341c499..292e34c 100644 --- a/lib/db/access.php +++ b/lib/db/access.php @@ -300,6 +300,17 @@ $moodle_capabilities = array( ) ), + // Permission to manage filter setting overrides in subcontexts. + 'moodle/filter:manage' => array( + + 'captype' => 'write', + 'contextlevel' => CONTEXT_COURSE, + 'legacy' => array( + 'editingteacher' => CAP_ALLOW, + 'coursecreator' => CAP_ALLOW, + 'admin' => CAP_ALLOW, + ) + ), 'moodle/user:create' => array( diff --git a/lib/db/install.php b/lib/db/install.php index d703cad..691bf0f 100644 --- a/lib/db/install.php +++ b/lib/db/install.php @@ -41,24 +41,25 @@ function xmldb_main_install() { /// create default course category $cat = get_course_category(); - - $defaults = array('rolesactive' => '0', // marks fully set up system - 'auth' => 'email', - 'auth_pop3mailbox' => 'INBOX', - 'enrol' => 'manual', - 'enrol_plugins_enabled' => 'manual', - 'style' => 'default', - 'template' => 'default', - 'theme' => 'standardwhite', - 'filter_multilang_converted' => 1, - 'siteidentifier' => random_string(32).$_SERVER['HTTP_HOST'], - 'backup_version' => 2008111700, - 'backup_release' => '2.0 dev', - 'blocks_version' => 2007081300, // might be removed soon - 'mnet_dispatcher_mode' => 'off', - 'sessiontimeout' => 7200, // must be present during roles installation - - ); + $defaults = array( + 'rolesactive' => '0', // marks fully set up system + 'auth' => 'email', + 'auth_pop3mailbox' => 'INBOX', + 'enrol' => 'manual', + 'enrol_plugins_enabled' => 'manual', + 'style' => 'default', + 'template' => 'default', + 'theme' => 'standardwhite', + 'filter_multilang_converted' => 1, + 'siteidentifier' => random_string(32).$_SERVER['HTTP_HOST'], + 'backup_version' => 2008111700, + 'backup_release' => '2.0 dev', + 'blocks_version' => 2007081300, // might be removed soon + 'mnet_dispatcher_mode' => 'off', + 'sessiontimeout' => 7200, // must be present during roles installation + 'stringfilters' => '', // These two are managed in a strange way by the filters + 'filterall' => 0, // setting page, so have to be initialised here. + ); foreach($defaults as $key => $value) { set_config($key, $value); } diff --git a/lib/db/install.xml b/lib/db/install.xml index 4f65217..afe17d3 100644 --- a/lib/db/install.xml +++ b/lib/db/install.xml @@ -1,5 +1,5 @@ -@@ -270,7 +270,7 @@ - +
-@@ -284,7 +284,39 @@ +
+
++ ++ + + + + + ++ + + ++ +
++ ++ + + + + + ++ + + ++ diff --git a/lib/db/upgrade.php b/lib/db/upgrade.php index 4944439..a9bd56d 100644 --- a/lib/db/upgrade.php +++ b/lib/db/upgrade.php @@ -1524,6 +1524,7 @@ WHERE gradeitemid IS NOT NULL AND grademax IS NOT NULL"); /// Main savepoint reached upgrade_main_savepoint($result, 2009032000); } + if ($result && $oldversion < 2009032001) { /// Copy from role_allow_assign into the new table. $DB->execute('INSERT INTO {role_allow_switch} SELECT * FROM {role_allow_assign}'); @@ -1542,6 +1543,103 @@ WHERE gradeitemid IS NOT NULL AND grademax IS NOT NULL"); upgrade_main_savepoint($result, 2009033100); } + if ($result && $oldversion < 2009040300) { + + /// Define table filter_active to be created + $table = new xmldb_table('filter_active'); + + /// Adding fields to table filter_active + $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null, null, null); + $table->add_field('filter', XMLDB_TYPE_CHAR, '32', null, XMLDB_NOTNULL, null, null, null, null); + $table->add_field('contextid', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, null, null, null); + $table->add_field('active', XMLDB_TYPE_INTEGER, '4', null, XMLDB_NOTNULL, null, null, null, null); + $table->add_field('sortorder', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, null, null, '0'); + + /// Adding keys to table filter_active + $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id')); + $table->add_key('contextid', XMLDB_KEY_FOREIGN, array('contextid'), 'context', array('id')); + + /// Adding indexes to table filter_active + $table->add_index('contextid-filter', XMLDB_INDEX_UNIQUE, array('contextid', 'filter')); + + /// Conditionally launch create table for filter_active + if (!$dbman->table_exists($table)) { + $dbman->create_table($table); + } + + /// Main savepoint reached + upgrade_main_savepoint($result, 2009040300); + } + + if ($result && $oldversion < 2009040301) { + + /// Define table filter_config to be created + $table = new xmldb_table('filter_config'); + + /// Adding fields to table filter_config + $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null, null, null); + $table->add_field('filter', XMLDB_TYPE_CHAR, '32', null, XMLDB_NOTNULL, null, null, null, null); + $table->add_field('contextid', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, null, null, null); + $table->add_field('name', XMLDB_TYPE_CHAR, '255', null, XMLDB_NOTNULL, null, null, null, null); + $table->add_field('value', XMLDB_TYPE_TEXT, 'small', null, null, null, null, null, null); + + /// Adding keys to table filter_config + $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id')); + $table->add_key('contextid', XMLDB_KEY_FOREIGN, array('contextid'), 'context', array('id')); + + /// Adding indexes to table filter_config + $table->add_index('contextid-filter-name', XMLDB_INDEX_UNIQUE, array('contextid', 'filter', 'name')); + + /// Conditionally launch create table for filter_config + if (!$dbman->table_exists($table)) { + $dbman->create_table($table); + } + + /// Main savepoint reached + upgrade_main_savepoint($result, 2009040301); + } + + if ($result && $oldversion < 2009040302) { + /// Transfer current settings from $CFG->textfilters + $disabledfilters = filter_get_all_installed(); + if (empty($CFG->textfilters)) { + $activefilters = array(); + } else { + $activefilters = explode(',', $CFG->textfilters); + } + $syscontext = get_context_instance(CONTEXT_SYSTEM); + $sortorder = 1; + foreach ($activefilters as $filter) { + filter_set_global_state($filter, TEXTFILTER_ON, $sortorder); + $sortorder += 1; + unset($disabledfilters[$filter]); + } + foreach ($disabledfilters as $filter => $notused) { + filter_set_global_state($filter, TEXTFILTER_DISABLED, $sortorder); + $sortorder += 1; + } + + /// Main savepoint reached + upgrade_main_savepoint($result, 2009040302); + } + + if ($result && $oldversion < 2009040600) { + /// Ensure that $CFG->stringfilters is set. + if (empty($CFG->stringfilters)) { + if (!empty($CFG->filterall)) { + set_config('stringfilters', $CFG->textfilters); + } else { + set_config('stringfilters', ''); + } + } + + set_config('filterall', !empty($CFG->stringfilters)); + unset_config('textfilters'); + + /// Main savepoint reached + upgrade_main_savepoint($result, 2009040600); + } + return $result; } diff --git a/lib/filelib.php b/lib/filelib.php index 4050407..0d83c78 100644 --- a/lib/filelib.php +++ b/lib/filelib.php @@ -1529,12 +1529,10 @@ function file_modify_html_header($text) { $stylesheetshtml .= ''."\n"; } - $filters = explode(",", $CFG->textfilters); - if (in_array('filter/mediaplugin', $filters)) { + $ufo = ''; + if (filter_is_enabled('filter/mediaplugin')) { // this script is needed by most media filter plugins. $ufo = get_require_js_code(array($CFG->wwwroot . '/lib/ufo.js')); - } else { - $ufo = ''; } preg_match('/\ tags removed for XHTML compatibility + $text = str_replace(array(' ', ' '), '', $text); + return $text; + } + + public function filter_string($string, $context, $courseid) { + return $this->apply_filter_chain($string, $this->get_string_filters($context, $courseid)); + } + + public function text_filtering_hash($context, $courseid) { + $filters = $this->get_text_filters($context, $courseid); + $hashes = array(); + foreach ($filters as $filter) { + $hashes[] = $filter->hash(); + } + return implode('-', $hashes); + } +} + +/** + * Filter manager subclass that does nothing. Having this simplifies the logic + * of format_text, etc. + */ +class null_filter_manager { + public function filter_text($text, $context, $courseid) { + return $text; + } + + public function filter_string($string, $context, $courseid) { return $text; } + public function text_filtering_hash() { + return ''; + } +} + +/** + * Filter manager subclass that tacks how much work it does. + */ +class performance_measuring_filter_manager extends filter_manager { + protected $filterscreated = 0; + protected $textsfiltered = 0; + protected $stringsfiltered = 0; + + protected function make_filter_object($filtername, $context, $courseid, $localconfig) { + $this->filterscreated++; + return parent::make_filter_object($filtername, $context, $courseid, $localconfig); + } + + public function filter_text($text, $context, $courseid) { + $this->textsfiltered++; + return parent::filter_text($text, $context, $courseid); + } + + public function filter_string($string, $context, $courseid) { + $this->stringsfiltered++; + return parent::filter_string($string, $context, $courseid); + } + + public function get_performance_summary() { + return array(array( + 'contextswithfilters' => count($this->textfilters), + 'filterscreated' => $this->filterscreated, + 'textsfiltered' => $this->textsfiltered, + 'stringsfiltered' => $this->stringsfiltered, + ), array( + 'contextswithfilters' => 'Contexts for which filters were loaded', + 'filterscreated' => 'Filters created', + 'textsfiltered' => 'Pieces of content filtered', + 'stringsfiltered' => 'Strings filtered', + )); + } +} + +/** + * Base class for text filters. You just need to override this class and + * implement the filter method. + */ +abstract class moodle_text_filter { + /** The course we are in. */ + protected $courseid; + /** The context we are in. */ + protected $context; + /** Any local configuration for this filter in this context. */ + protected $localconfig; + + /** + * Set any context-specific configuration for this filter. + * @param object $context The current course id. + * @param object $context The current context. + * @param array $config Any context-specific configuration for this filter. + */ + public function __construct($courseid, $context, array $localconfig) { + $this->courseid = $courseid; + $this->context = $context; + $this->localconfig = $localconfig; + } + public function hash() { return __CLASS__; } - // filter plugin must overwrite this function to filter - abstract function filter($text); + /** + * Override this funciton to actually implement the filtering. + * @param $text some HTML content. + * @return the HTML content after the filtering has been applied. + */ + public abstract function filter($text); +} + +/** + * moodle_text_filter implementation that encapsulates an old-style filter that + * only defines a function, not a class. + */ +class legacy_filter extends moodle_text_filter { + protected $filterfunction; + + /** + * Set any context-specific configuration for this filter. + * @param string $filterfunction + * @param object $context The current course id. + * @param object $context The current context. + * @param array $config Any context-specific configuration for this filter. + */ + public function __construct($filterfunction, $courseid, $context, array $localconfig) { + parent::__construct($courseid, $context, $localconfig); + $this->filterfunction = $filterfunction; + } + + public function filter($text) { + return call_user_func($this->filterfunction, $this->courseid, $text); + } } /// Define one exclusive separator that we'll use in the temp saved tags @@ -106,8 +337,9 @@ class filterobject { * @param string $filter the folder name where the filter lives. * @return string the human-readable name for this filter. */ -function filter_get_name($filterlocation, $filter) { - switch ($filterlocation) { +function filter_get_name($filter) { + list($type, $filter) = explode('/', $filter); + switch ($type) { case 'filter': $strfiltername = get_string('filtername', 'filter_' . $filter); if (substr($strfiltername, 0, 2) != '[[') { @@ -119,12 +351,12 @@ function filter_get_name($filterlocation, $filter) { case 'mod': $strfiltername = get_string('filtername', $filter); if (substr($strfiltername, 0, 2) == '[[') { - $strfiltername .= ' (' . $filterlocation . '/' . $filter . ')'; + $strfiltername .= ' (' . $type . '/' . $filter . ')'; } return $strfiltername; default: - throw new coding_exception('Unknown filter location ' . $filterlocation); + throw new coding_exception('Unknown filter type ' . $type); } } @@ -143,7 +375,7 @@ function filter_get_all_installed() { foreach ($filters as $filter) { $path = $filterlocation . '/' . $filter; if (is_readable($CFG->dirroot . '/' . $path . '/filter.php')) { - $strfiltername = filter_get_name($filterlocation, $filter); + $strfiltername = filter_get_name($path); $filternames[$path] = $strfiltername; } } @@ -153,6 +385,411 @@ function filter_get_all_installed() { } /** + * Set the global activated state for a text filter. + * @param string $filter The filter name, for example 'filter/tex' or 'mod/glossary'. + * @param integer $state One of the values TEXTFILTER_ON, TEXTFILTER_OFF or TEXTFILTER_DISABLED. + * @param integer $sortorder (optional) a position in the sortorder to place this filter. + * If not given defaults to: + * No change in order if we are updating an exsiting record, and not changing to or from TEXTFILTER_DISABLED. + * Just after the last currently active filter when adding an unknown filter + * in state TEXTFILTER_ON or TEXTFILTER_OFF, or enabling/diabling an exsisting filter. + * Just after the very last filter when adding an unknown filter in state TEXTFILTER_DISABLED + */ +function filter_set_global_state($filter, $state, $sortorder = false) { + global $DB; + + // Check requested state is valid. + if (!in_array($state, array(TEXTFILTER_ON, TEXTFILTER_OFF, TEXTFILTER_DISABLED))) { + throw new coding_exception("Illegal option '$state' passed to filter_set_global_state. " . + "Must be one of TEXTFILTER_ON, TEXTFILTER_OFF or TEXTFILTER_DISABLED."); + } + + // Check sortorder is valid. + if ($sortorder !== false) { + if ($sortorder < 1 || $sortorder > $DB->get_field('filter_active', 'MAX(sortorder)', array()) + 1) { + throw new coding_exception("Invalid sort order passed to filter_set_global_state."); + } + } + + // See if there is an existing record. + $syscontext = get_context_instance(CONTEXT_SYSTEM); + $rec = $DB->get_record('filter_active', array('filter' => $filter, 'contextid' => $syscontext->id)); + if (empty($rec)) { + $insert = true; + $rec = new stdClass; + $rec->filter = $filter; + $rec->contextid = $syscontext->id; + } else { + $insert = false; + if ($sortorder === false && !($rec->active == TEXTFILTER_DISABLED xor $state == TEXTFILTER_DISABLED)) { + $sortorder = $rec->sortorder; + } + } + + // Automatic sort order. + if ($sortorder === false) { + if ($state == TEXTFILTER_DISABLED && $insert) { + $prevmaxsortorder = $DB->get_field('filter_active', 'MAX(sortorder)', array()); + } else { + $prevmaxsortorder = $DB->get_field_select('filter_active', 'MAX(sortorder)', 'active <> ?', array(TEXTFILTER_DISABLED)); + } + if (empty($prevmaxsortorder)) { + $sortorder = 1; + } else { + $sortorder = $prevmaxsortorder + 1; + if (!$insert && $state == TEXTFILTER_DISABLED) { + $sortorder = $prevmaxsortorder; + } + } + } + + // Move any existing records out of the way of the sortorder. + if ($insert) { + $DB->execute('UPDATE {filter_active} SET sortorder = sortorder + 1 WHERE sortorder >= ?', array($sortorder)); + } else if ($sortorder != $rec->sortorder) { + $sparesortorder = $DB->get_field('filter_active', 'MIN(sortorder)', array()) - 1; + $DB->set_field('filter_active', 'sortorder', $sparesortorder, array('filter' => $filter, 'contextid' => $syscontext->id)); + if ($sortorder < $rec->sortorder) { + $DB->execute('UPDATE {filter_active} SET sortorder = sortorder + 1 WHERE sortorder >= ? AND sortorder < ?', + array($sortorder, $rec->sortorder)); + } else if ($sortorder > $rec->sortorder) { + $DB->execute('UPDATE {filter_active} SET sortorder = sortorder - 1 WHERE sortorder <= ? AND sortorder > ?', + array($sortorder, $rec->sortorder)); + } + } + + // Insert/update the new record. + $rec->active = $state; + $rec->sortorder = $sortorder; + if ($insert) { + $DB->insert_record('filter_active', $rec); + } else { + $DB->update_record('filter_active', $rec); + } +} + +/** + * @param string $filter The filter name, for example 'filter/tex' or 'mod/glossary'. + * @return boolean is this filter allowed to be used on this site. That is, the + * admin has set the global 'active' setting to On, or Off, but available. + */ +function filter_is_enabled($filter) { + return array_key_exists($filter, filter_get_globally_enabled()); +} + +/** + * Return a list of all the filters that may be in use somewhere. + * @return array where the keys and values are both the filter name, like 'filter/tex'. + */ +function filter_get_globally_enabled() { + static $enabledfilters = null; + if (is_null($enabledfilters)) { + $filters = filter_get_global_states(); + $enabledfilters = array(); + foreach ($filters as $filter => $filerinfo) { + if ($filerinfo->active != TEXTFILTER_DISABLED) { + $enabledfilters[$filter] = $filter; + } + } + } + return $enabledfilters; +} + +/** + * Return the names of the filters that should also be applied to strings + * (when they are enabled). + * @return array where the keys and values are both the filter name, like 'filter/tex'. + */ +function filter_get_string_filters() { + global $CFG; + $stringfilters = array(); + if (!empty($CFG->filterall) && !empty($CFG->stringfilters)) { + $stringfilters = explode(',', $CFG->stringfilters); + $stringfilters = array_combine($stringfilters, $stringfilters); + } + return $stringfilters; +} + +/** + * Sets whether a particular active filter should be applied to all strings by + * format_string, or just used by format_text. + * @param string $filter The filter name, for example 'filter/tex' or 'mod/glossary'. + * @param boolean $applytostrings if true, this filter will apply to format_string + * and format_text, when it is enabled. + */ +function filter_set_applies_to_strings($filter, $applytostrings) { + $stringfilters = filter_get_string_filters(); + $numstringfilters = count($stringfilters); + if ($applytostrings) { + $stringfilters[$filter] = $filter; + } else { + unset($stringfilters[$filter]); + } + if (count($stringfilters) != $numstringfilters) { + set_config('stringfilters', implode(',', $stringfilters)); + set_config('filterall', !empty($stringfilters)); + } +} + +/** + * Set the local activated state for a text filter. + * @param string $filter The filter name, for example 'filter/tex' or 'mod/glossary'. + * @param integer $contextid The id of the context to get the local config for. + * @param integer $state One of the values TEXTFILTER_ON, TEXTFILTER_OFF or TEXTFILTER_INHERIT. + */ +function filter_set_local_state($filter, $contextid, $state) { + global $DB; + + // Check requested state is valid. + if (!in_array($state, array(TEXTFILTER_ON, TEXTFILTER_OFF, TEXTFILTER_INHERIT))) { + throw new coding_exception("Illegal option '$state' passed to filter_set_local_state. " . + "Must be one of TEXTFILTER_ON, TEXTFILTER_OFF or TEXTFILTER_INHERIT."); + } + + if ($contextid == get_context_instance(CONTEXT_SYSTEM)->id) { + throw new coding_exception('You cannot use filter_set_local_state ' . + 'with $contextid equal to the system context id.'); + } + + if ($state == TEXTFILTER_INHERIT) { + $DB->delete_records('filter_active', array('filter' => $filter, 'contextid' => $contextid)); + return; + } + + $rec = $DB->get_record('filter_active', array('filter' => $filter, 'contextid' => $contextid)); + $insert = false; + if (empty($rec)) { + $insert = true; + $rec = new stdClass; + $rec->filter = $filter; + $rec->contextid = $contextid; + } + + $rec->active = $state; + + if ($insert) { + $DB->insert_record('filter_active', $rec); + } else { + $DB->update_record('filter_active', $rec); + } +} + +/** + * Set a particular local config variable for a filter in a context. + * @param string $filter The filter name, for example 'filter/tex' or 'mod/glossary'. + * @param integer $contextid The id of the context to get the local config for. + * @param string $name the setting name. + * @param string $value the corresponding value. + */ +function filter_set_local_config($filter, $contextid, $name, $value) { + global $DB; + $rec = $DB->get_record('filter_config', array('filter' => $filter, 'contextid' => $contextid, 'name' => $name)); + $insert = false; + if (empty($rec)) { + $insert = true; + $rec = new stdClass; + $rec->filter = $filter; + $rec->contextid = $contextid; + $rec->name = $name; + } + + $rec->value = $value; + + if ($insert) { + $DB->insert_record('filter_config', $rec); + } else { + $DB->update_record('filter_config', $rec); + } +} + +/** + * Remove a particular local config variable for a filter in a context. + * @param string $filter The filter name, for example 'filter/tex' or 'mod/glossary'. + * @param integer $contextid The id of the context to get the local config for. + * @param string $name the setting name. + */ +function filter_unset_local_config($filter, $contextid, $name) { + global $DB; + $DB->delete_records('filter_config', array('filter' => $filter, 'contextid' => $contextid, 'name' => $name)); +} + +/** + * Get local config variables for a filter in a context. Normally (when your + * filter is running) you don't need to call this, becuase the config is fetched + * for you automatically. You only need this, for example, when you are getting + * the config so you can show the user an editing from. + * @param string $filter The filter name, for example 'filter/tex' or 'mod/glossary'. + * @param integer $contextid The ID of the context to get the local config for. + * @return array of name => value pairs. + */ +function filter_get_local_config($filter, $contextid) { + global $DB; + return $DB->get_records_menu('filter_config', array('filter' => $filter, 'contextid' => $contextid), '', 'name,value'); +} + +/** + * This function is for use by backup. Gets all the filter information specific + * to one context. + * @return array with two elements. The first element is an array of objects with + * fields filter and active. These come from the filter_active table. The + * second element is an array of objects with fields filter, name and value + * from the filter_config table. + */ +function filter_get_all_local_settings($contextid) { + global $DB; + $context = get_context_instance(CONTEXT_SYSTEM); + return array( + $DB->get_records('filter_active', array('contextid' => $contextid), 'filter', 'filter,active'), + $DB->get_records('filter_config', array('contextid' => $contextid), 'filter,name', 'filter,name,value'), + ); +} + +/** + * Get the list of active filters, in the order that they should be used + * for a particular context, along with any local configuration variables. + * + * @param object $context a context + * + * @return array an array where the keys are the filter names, for example + * 'filter/tex' or 'mod/glossary' and the values are any local + * configuration for that filter, as an array of name => value pairs + * from the filter_config table. In a lot of cases, this will be an + * empty array. So, an example return value for this function might be + * array('filter/tex' => array(), 'mod/glossary' => array('glossaryid', 123)) + */ +function filter_get_active_in_context($context) { + global $DB; + $contextids = str_replace('/', ',', trim($context->path, '/')); + + // The following SQL is tricky. It is explained on + // http://docs.moodle.org/en/Development:Filter_enable/disable_by_context + $rs = $DB->get_recordset_sql( + "SELECT active.filter, fc.name, fc.value + FROM (SELECT f.filter + FROM {filter_active} f + JOIN {context} ctx ON f.contextid = ctx.id + WHERE ctx.id IN ($contextids) + GROUP BY filter + HAVING MAX(f.active * ctx.depth) > -MIN(f.active * ctx.depth) + ORDER BY MAX(f.sortorder)) active + LEFT JOIN {filter_config} fc ON fc.filter = active.filter AND fc.contextid = $context->id"); + + // Masssage the data into the specified format to return. + $filters = array(); + foreach ($rs as $row) { + if (!isset($filters[$row->filter])) { + $filters[$row->filter] = array(); + } + if (!is_null($row->name)) { + $filters[$row->filter][$row->name] = $row->value; + } + } + + $rs->close(); + + return $filters; +} + +/** + * List all of the filters that are available in this context, and what the + * local and interited states of that filter are. + * @param object $context a context that is not the system context. + * @return array an array with filter names, for example 'filter/tex' or + * 'mod/glossary' as keys. and and the values are objects with fields: + * ->filter filter name, same as the key. + * ->localstate TEXTFILTER_ON/OFF/INHERIT + * ->inheritedstate TEXTFILTER_ON/OFF - the state that will be used if localstate is set to TEXTFILTER_INHERIT. + */ +function filter_get_available_in_context($context) { + global $DB; + + // The complex logic is working out the active state in the parent context, + // so strip the current context from the list. + $contextids = explode('/', trim($context->path, '/')); + array_pop($contextids); + $contextids = implode(',', $contextids); + if (empty($contextids)) { + throw new coding_exception('filter_get_available_in_context cannot be called with the system context.'); + } + + // The following SQL is tricky, in the same way at the SQL in filter_get_active_in_context. + return $DB->get_records_sql( + "SELECT parent_states.filter, + CASE WHEN fa.active IS NULL THEN " . TEXTFILTER_INHERIT . " + ELSE fa.active END AS localstate, + parent_states.inheritedstate + FROM (SELECT f.filter, + CASE WHEN MAX(f.active * ctx.depth) > -MIN(f.active * ctx.depth) THEN " . TEXTFILTER_ON . " + ELSE " . TEXTFILTER_OFF . " END AS inheritedstate + FROM {filter_active} f + JOIN {context} ctx ON f.contextid = ctx.id + WHERE ctx.id IN ($contextids) + GROUP BY filter + HAVING MIN(f.active) > " . TEXTFILTER_DISABLED . " + ORDER BY MAX(f.sortorder)) parent_states + LEFT JOIN {filter_active} fa ON fa.filter = parent_states.filter AND fa.contextid = $context->id"); +} + +/** + * This function is for use by the filter administration page. + * @return array 'filtername' => object with fields 'filter' (=filtername), 'active' and 'sortorder' + */ +function filter_get_global_states() { + global $DB; + $context = get_context_instance(CONTEXT_SYSTEM); + return $DB->get_records('filter_active', array('contextid' => $context->id), 'sortorder', 'filter,active,sortorder'); +} + +/** + * Delete all the data in the database relating to a filter, prior to deleting it. + * @param string $filter The filter name, for example 'filter/tex' or 'mod/glossary'. + */ +function filter_delete_all_data($filter) { + global $DB; + if (substr($filter, 0, 7) == 'filter/') { + unset_all_config_for_plugin('filter_' . basename($filter)); + } + $DB->delete_records('filter_active', array('filter' => $filter)); + $DB->delete_records('filter_config', array('filter' => $filter)); +} + +/** + * Does this filter have a global settings page in the admin tree? + * (The settings page for a filter must be called, for example, + * filtersettingfiltertex or filtersettingmodglossay.) + * + * @param string $filter The filter name, for example 'filter/tex' or 'mod/glossary'. + * @return boolean Whether there should be a 'Settings' link on the config page. + */ +function filter_has_global_settings($filter) { + global $CFG; + $settingspath = $CFG->dirroot . '/' . $filter . '/filtersettings.php'; + return is_readable($settingspath); +} + +/** + * Does this filter have local (per-context) settings? + * + * @param string $filter The filter name, for example 'filter/tex' or 'mod/glossary'. + * @return boolean Whether there should be a 'Settings' link on the manage filters in context page. + */ +function filter_has_local_settings($filter) { + global $CFG; + $settingspath = $CFG->dirroot . '/' . $filter . '/filterlocalsettings.php'; + return is_readable($settingspath); +} + +/** + * Certain types of context (block and user) may not have local filter settings. + * the function checks a context to see whether it may have local config. + * @param object $context a context. + * @return boolean whether this context may have local filter settings. + */ +function filter_context_may_have_filter_settings($context) { + return $context->contextlevel != CONTEXT_BLOCK && $context->contextlevel != CONTEXT_USER; +} + +/** * Process phrases intelligently found within a HTML text (such as adding links) * * param text the text that we are filtering diff --git a/lib/moodlelib.php b/lib/moodlelib.php index bd3cb80..e46cda2 100644 --- a/lib/moodlelib.php +++ b/lib/moodlelib.php @@ -7967,6 +7967,16 @@ function get_performance_info() { $info['html'] .= 'Included '.$info['includecount'].' files '; $info['txt'] .= 'includecount: '.$info['includecount'].' '; + $filtermanager = filter_manager::instance(); + if (method_exists($filtermanager, 'get_performance_summary')) { + list($filterinfo, $nicenames) = $filtermanager->get_performance_summary(); + $info = array_merge($filterinfo, $info); + foreach ($filterinfo as $key => $value) { + $info['html'] .= "$nicenames[$key]: $value "; + $info['txt'] .= "$key: $value "; + } + } + if (!empty($PERF->logwrites)) { $info['logwrites'] = $PERF->logwrites; $info['html'] .= 'Log DB writes '.$info['logwrites'].' '; @@ -8362,7 +8372,7 @@ function get_plugin_name($plugin, $type='mod') { } break; case 'filter': - $plugin_name = filter_get_name('filter', $plugin); + $plugin_name = filter_get_name('filter/' . $plugin); break; default: $plugin_name = $plugin; diff --git a/lib/simpletest/filtersettingsperformancetester.php b/lib/simpletest/filtersettingsperformancetester.php new file mode 100644 index 0000000..6ccad54 --- /dev/null +++ b/lib/simpletest/filtersettingsperformancetester.php @@ -0,0 +1,237 @@ +libdir . '/ddllib.php'); + +require_login(); +$syscontext = get_context_instance(CONTEXT_SYSTEM); +require_capability('moodle/site:config', $syscontext); + +$baseurl = $CFG->wwwroot . '/lib/simpletest/filtersettingsperformancetester.php'; + +$title = 'filter_get_active_in_context performance test'; +print_header($title, $title, build_navigation($title)); + +// Complain if we get this far and $CFG->unittestprefix is not set. +if (empty($CFG->unittestprefix)) { + throw new coding_exception('This page requires $CFG->unittestprefix to be set in config.php.'); +} + +$requiredtables = array('context', 'filter_active', 'filter_config'); +$realdb = $DB; +$testdb = moodle_database::get_driver_instance($CFG->dbtype, $CFG->dblibrary); +$testdb->connect($CFG->dbhost, $CFG->dbuser, $CFG->dbpass, $CFG->dbname, $CFG->unittestprefix); +$DB = $testdb; +$dbman = $testdb->get_manager(); +$issetup = 0; +foreach ($requiredtables as $table) { + if ($dbman->table_exists(new xmldb_table($table))) { + $issetup++; + } +} + +switch (optional_param('action', '', PARAM_ACTION)) { + case 'setup': + if ($issetup == 0) { + foreach ($requiredtables as $table) { + $dbman->install_one_table_from_xmldb_file($CFG->dirroot . '/lib/db/install.xml', $table); + $issetup++; + } + flush(); + populate_test_database($syscontext, 10, 100, 1000, 5000, 5000); + notify('Test tables created.', 'notifysuccess'); + } else if ($issetup == count($requiredtables)) { + notify('Test tables are already set up.', 'notifysuccess'); + } else { + notify('Something is wrong, please delete the test tables and try again.'); + } + break; + + case 'teardown': + foreach ($requiredtables as $tablename) { + $table = new xmldb_table($tablename); + if ($dbman->table_exists($table)) { + $dbman->drop_table($table); + } + } + $issetup = 0; + notify('Test tables dropped.', 'notifysuccess'); + break; + + case 'test': + if ($issetup != count($requiredtables)) { + notify('Something is wrong, please delete the test tables and try again.'); + } else { + $contexts = $DB->get_records('context'); + $numcalls = 1000; + $basetime = run_tests('noop', $contexts, $numcalls, 0); + run_tests('simple_get_record_by_id', $contexts, $numcalls, $basetime); + run_tests('filter_get_active_in_context', $contexts, $numcalls, $basetime); + } + break; +} + +if ($issetup == count($requiredtables)) { + echo 'Total of ' . $DB->count_records('context') . ' contexts, ' . + $DB->count_records('filter_active') . ' filter_active and ' . + $DB->count_records('filter_config') . ' filter_config rows in the database.
'; +} + +$DB = $realdb; + +echo ''; +print_single_button($baseurl, array('action' => 'setup'), 'Set up test tables', 'get', '', false, '', $issetup > 0); +print_single_button($baseurl, array('action' => 'teardown'), 'Drop test tables', 'get', '', false, '', $issetup == 0); +print_single_button($baseurl, array('action' => 'test'), 'Run tests', 'get', '', false, '', $issetup != count($requiredtables)); +echo ''; + +print_footer(); + +function noop($context) { +} + +function simple_get_record_by_id($context) { + global $DB; + $DB->get_record('context', array('id' => $context->id)); +} + +function run_tests($function, $contexts, $numcalls, $basetime) { + set_time_limit(120); + $startime = microtime(true); + for ($j = 0; $j < $numcalls; $j++) { + $function($contexts[array_rand($contexts)]); + } + $duration = microtime(true) - $startime; + print_result_line($duration, $basetime, $numcalls, 'calls to ' . $function); + return $duration; +} + +function print_result_line($duration, $basetime, $numcalls, $action1, $action2 = 'calls per second') { + echo 'Time for ' . format_float($numcalls, 0) . ' ' . $action1 . ': ' . + format_float($duration - $basetime, 3) . 's (' . format_float($duration, 3) . ' - ' . + format_float($basetime, 3) . 's) which is ' . + format_float(($numcalls / ($duration - $basetime)), 0) . ' ' . $action2 . ".
\n"; + flush(); +} + +function populate_test_database($syscontext, $numcategories, $numcourses, $nummodules, $numoverrides, $numconfigs) { + global $DB; + set_time_limit(600); + $syscontext->id = $DB->insert_record('context', $syscontext); + + // Category contexts. + $categoryparents = array($syscontext); + $categories = array(); + for ($i = 0; $i < $numcategories; $i++) { + $context = insert_context(CONTEXT_COURSECAT, $i, $categoryparents[array_rand($categoryparents)]); + $categoryparents[] = $context; + $categories[$context->id] = $context; + } + notify('Created ' . $numcategories . ' course category contexts.', 'notifysuccess'); flush(); + + // Course contexts. + $courses = array(); + for ($i = 0; $i < $numcourses; $i++) { + $context = insert_context(CONTEXT_COURSE, $i, $categories[array_rand($categories)]); + $courses[$context->id] = $context; + } + notify('Created ' . $numcourses . ' course contexts.', 'notifysuccess'); flush(); + + // Activities contexts. + $mods = array(); + $prog = new progress_bar('modbar', 500, true); + $DB->begin_sql(); + for ($i = 0; $i < $nummodules; $i++) { + $context = insert_context(CONTEXT_MODULE, $i, $courses[array_rand($courses)]); + $mods[$context->id] = $context; + if ($i % 50) { + $prog->update($i, $nummodules, ''); + } + } + $DB->commit_sql(); + notify('Created ' . $nummodules . ' module contexts.', 'notifysuccess'); flush(); + + $contexts = $categories + $courses + $mods; + + // Global settings. + $installedfilters = filter_get_all_installed(); + $counts = array(TEXTFILTER_DISABLED => 0, TEXTFILTER_OFF => 0, TEXTFILTER_ON => 0); + foreach ($installedfilters as $filter => $notused) { + $state = array_rand($counts); + filter_set_global_state($filter, $state); + $counts[$state]++; + } + notify('Set global setting: ' . $counts[TEXTFILTER_DISABLED] . ' disabled, ' . + $counts[TEXTFILTER_OFF] . ' off and ' . $counts[TEXTFILTER_ON] . ' on.', 'notifysuccess'); flush(); + + // Local overrides. + $localstates = array(TEXTFILTER_OFF => 0, TEXTFILTER_ON => 0); + $prog = new progress_bar('locbar', 500, true); + $DB->begin_sql(); + for ($i = 0; $i < $numoverrides; $i++) { + filter_set_local_state(array_rand($installedfilters), array_rand($contexts), array_rand($localstates)); + if ($i % 50) { + $prog->update($i, $numoverrides, ''); + } + } + $DB->commit_sql(); + notify('Set ' . $numoverrides . ' local overrides.', 'notifysuccess'); flush(); + + // Local config. + $variablenames = array('frog' => 0, 'toad' => 0, 'elver' => 0, 'eft' => 0, 'tadpole' => 0); + $prog = new progress_bar('confbar', 500, true); + $DB->begin_sql(); + for ($i = 0; $i < $numconfigs; $i++) { + filter_set_local_config(array_rand($installedfilters), array_rand($contexts), + array_rand($variablenames), random_string(rand(20, 40))); + if ($i % 50) { + $prog->update($i, $numconfigs, ''); + } + } + $DB->commit_sql(); + notify('Set ' . $numconfigs . ' local configs.', 'notifysuccess'); flush(); +} + +function insert_context($contextlevel, $instanceid, $parent) { + global $DB; + $context = new stdClass; + $context->contextlevel = $contextlevel; + $context->instanceid = $instanceid; + $context->depth = $parent->depth + 1; + $context->id = $DB->insert_record('context', $context); + $context->path = $parent->path . '/' . $context->id; + $DB->set_field('context', 'path', $context->path, array('id' => $context->id)); + return $context; +} + diff --git a/lib/simpletest/testfilterconfig.php b/lib/simpletest/testfilterconfig.php new file mode 100644 index 0000000..7f14440 --- /dev/null +++ b/lib/simpletest/testfilterconfig.php @@ -0,0 +1,642 @@ +libdir . '/filterlib.php'); + +/** + * Test functions that affect filter_active table with contextid = $syscontextid. + */ +class filter_active_global_test extends UnitTestCaseUsingDatabase { + private $syscontextid; + + public function setUp() { + parent::setUp(); + + // Make sure accesslib has cached a sensible system context object + // before we switch to the test DB. + $this->syscontextid = get_context_instance(CONTEXT_SYSTEM)->id; + + // Create the table we need and switch to test DB. + $this->create_test_table('filter_active', 'lib'); + $this->switch_to_test_db(); + } + + private function assert_only_one_filter_globally($filter, $state) { + $recs = $this->testdb->get_records('filter_active'); + $this->assertEqual(1, count($recs), 'More than one record returned %s.'); + $rec = reset($recs); + $expectedrec = new stdClass; + $expectedrec->filter = $filter; + $expectedrec->contextid = $this->syscontextid; + $expectedrec->active = $state; + $expectedrec->sortorder = 1; + $this->assert(new CheckSpecifiedFieldsExpectation($expectedrec), $rec); + } + + private function assert_global_sort_order($filters) { + $sortedfilters = $this->testdb->get_records_menu('filter_active', + array('contextid' => $this->syscontextid), 'sortorder', 'sortorder,filter'); + $testarray = array(); + $index = 1; + foreach($filters as $filter) { + $testarray[$index++] = $filter; + } + $this->assertEqual($testarray, $sortedfilters); + } + + public function test_set_filter_globally_on() { + // Setup fixture. + // Exercise SUT. + filter_set_global_state('filter/name', TEXTFILTER_ON, 1); + // Validate. + $this->assert_only_one_filter_globally('filter/name', TEXTFILTER_ON); + } + + public function test_set_filter_globally_off() { + // Setup fixture. + // Exercise SUT. + filter_set_global_state('filter/name', TEXTFILTER_OFF, 1); + // Validate. + $this->assert_only_one_filter_globally('filter/name', TEXTFILTER_OFF); + } + + public function test_set_filter_globally_disabled() { + // Setup fixture. + // Exercise SUT. + filter_set_global_state('filter/name', TEXTFILTER_DISABLED, 1); + // Validate. + $this->assert_only_one_filter_globally('filter/name', TEXTFILTER_DISABLED); + } + + public function test_global_config_exception_on_invalid_state() { + // Setup fixture. + // Set expectation. + $this->expectException(); + // Exercise SUT. + filter_set_global_state('filter/name', 0, 1); + } + + public function test_set_no_sortorder_clash() { + // Setup fixture. + // Exercise SUT. + filter_set_global_state('filter/one', TEXTFILTER_DISABLED, 1); + filter_set_global_state('filter/two', TEXTFILTER_DISABLED, 1); + // Validate - should have pushed other filters down. + $this->assert_global_sort_order(array('filter/two', 'filter/one')); + } + + public function test_auto_sort_order_disabled() { + // Setup fixture. + // Exercise SUT. + filter_set_global_state('filter/one', TEXTFILTER_DISABLED); + filter_set_global_state('filter/two', TEXTFILTER_DISABLED); + // Validate. + $this->assert_global_sort_order(array('filter/one', 'filter/two')); + } + + public function test_auto_sort_order_enabled() { + // Setup fixture. + // Exercise SUT. + filter_set_global_state('filter/one', TEXTFILTER_ON); + filter_set_global_state('filter/two', TEXTFILTER_OFF); + // Validate. + $this->assert_global_sort_order(array('filter/one', 'filter/two')); + } + + public function test_auto_sort_order_mixed() { + // Setup fixture. + // Exercise SUT. + filter_set_global_state('filter/0', TEXTFILTER_DISABLED); + filter_set_global_state('filter/1', TEXTFILTER_ON); + filter_set_global_state('filter/2', TEXTFILTER_DISABLED); + filter_set_global_state('filter/3', TEXTFILTER_OFF); + // Validate. + $this->assert_global_sort_order(array('filter/1', 'filter/3', 'filter/0', 'filter/2')); + } + + public function test_update_existing_dont_duplicate() { + // Setup fixture. + // Exercise SUT. + filter_set_global_state('filter/name', TEXTFILTER_ON); + filter_set_global_state('filter/name', TEXTFILTER_OFF); + // Validate. + $this->assert_only_one_filter_globally('filter/name', TEXTFILTER_OFF); + } + + public function test_sort_order_not_too_low() { + // Setup fixture. + filter_set_global_state('filter/1', TEXTFILTER_ON); + // Set expectation. + $this->expectException(); + // Exercise SUT. + filter_set_global_state('filter/2', TEXTFILTER_ON, 0); + } + + public function test_sort_order_not_too_high() { + // Setup fixture. + filter_set_global_state('filter/1', TEXTFILTER_ON); + // Set expectation. + $this->expectException(); + // Exercise SUT. + filter_set_global_state('filter/2', TEXTFILTER_ON, 3); + } + + public function test_update_reorder_down() { + // Setup fixture. + filter_set_global_state('filter/1', TEXTFILTER_ON); + filter_set_global_state('filter/2', TEXTFILTER_ON); + filter_set_global_state('filter/3', TEXTFILTER_ON); + // Exercise SUT. + filter_set_global_state('filter/2', TEXTFILTER_ON, 1); + // Validate. + $this->assert_global_sort_order(array('filter/2', 'filter/1', 'filter/3')); + } + + public function test_update_reorder_up() { + // Setup fixture. + filter_set_global_state('filter/1', TEXTFILTER_ON); + filter_set_global_state('filter/2', TEXTFILTER_ON); + filter_set_global_state('filter/3', TEXTFILTER_ON); + filter_set_global_state('filter/4', TEXTFILTER_ON); + // Exercise SUT. + filter_set_global_state('filter/2', TEXTFILTER_ON, 3); + // Validate. + $this->assert_global_sort_order(array('filter/1', 'filter/3', 'filter/2', 'filter/4')); + } + + public function test_auto_sort_order_change_to_enabled() { + // Setup fixture. + filter_set_global_state('filter/1', TEXTFILTER_ON); + filter_set_global_state('filter/2', TEXTFILTER_DISABLED); + filter_set_global_state('filter/3', TEXTFILTER_DISABLED); + // Exercise SUT. + filter_set_global_state('filter/3', TEXTFILTER_ON); + // Validate. + $this->assert_global_sort_order(array('filter/1', 'filter/3', 'filter/2')); + } + + public function test_auto_sort_order_change_to_disabled() { + // Setup fixture. + filter_set_global_state('filter/1', TEXTFILTER_ON); + filter_set_global_state('filter/2', TEXTFILTER_ON); + filter_set_global_state('filter/3', TEXTFILTER_DISABLED); + // Exercise SUT. + filter_set_global_state('filter/1', TEXTFILTER_DISABLED); + // Validate. + $this->assert_global_sort_order(array('filter/2', 'filter/1', 'filter/3')); + } + + public function test_filter_get_global_states() { + // Setup fixture. + filter_set_global_state('filter/1', TEXTFILTER_ON); + filter_set_global_state('filter/2', TEXTFILTER_OFF); + filter_set_global_state('filter/3', TEXTFILTER_DISABLED); + // Exercise SUT. + $filters = filter_get_global_states(); + // Validate. + $this->assertEqual(array( + 'filter/1' => (object) array('filter' => 'filter/1', 'active' => TEXTFILTER_ON, 'sortorder' => 1), + 'filter/2' => (object) array('filter' => 'filter/2', 'active' => TEXTFILTER_OFF, 'sortorder' => 2), + 'filter/3' => (object) array('filter' => 'filter/3', 'active' => TEXTFILTER_DISABLED, 'sortorder' => 3) + ), $filters); + } +} + +/** + * Test functions that affect filter_active table with contextid = $syscontextid. + */ +class filter_active_local_test extends UnitTestCaseUsingDatabase { + public function setUp() { + parent::setUp(); + + // Create the table we need and switch to test DB. + $this->create_test_table('filter_active', 'lib'); + $this->switch_to_test_db(); + } + + private function assert_only_one_local_setting($filter, $contextid, $state) { + $recs = $this->testdb->get_records('filter_active'); + $this->assertEqual(1, count($recs), 'More than one record returned %s.'); + $rec = reset($recs); + $expectedrec = new stdClass; + $expectedrec->filter = $filter; + $expectedrec->contextid = $contextid; + $expectedrec->active = $state; + $this->assert(new CheckSpecifiedFieldsExpectation($expectedrec), $rec); + } + + private function assert_no_local_setting() { + $this->assertEqual(0, $this->testdb->count_records('filter_active')); + } + + public function test_local_on() { + // Exercise SUT. + filter_set_local_state('filter/name', 123, TEXTFILTER_ON); + // Validate. + $this->assert_only_one_local_setting('filter/name', 123, TEXTFILTER_ON); + } + + public function test_local_off() { + // Exercise SUT. + filter_set_local_state('filter/name', 123, TEXTFILTER_OFF); + // Validate. + $this->assert_only_one_local_setting('filter/name', 123, TEXTFILTER_OFF); + } + + public function test_local_inherit() { + global $DB; + // Exercise SUT. + filter_set_local_state('filter/name', 123, TEXTFILTER_INHERIT); + // Validate. + $this->assert_no_local_setting(); + } + + public function test_local_invalid_state_throws_exception() { + // Set expectation. + $this->expectException(); + // Exercise SUT. + filter_set_local_state('filter/name', 123, -9999); + } + + public function test_throws_exception_when_setting_global() { + // Set expectation. + $this->expectException(); + // Exercise SUT. + filter_set_local_state('filter/name', get_context_instance(CONTEXT_SYSTEM)->id, TEXTFILTER_INHERIT); + } + + public function test_local_inherit_deletes_existing() { + global $DB; + // Setup fixture. + filter_set_local_state('filter/name', 123, TEXTFILTER_INHERIT); + // Exercise SUT. + filter_set_local_state('filter/name', 123, TEXTFILTER_INHERIT); + // Validate. + $this->assert_no_local_setting(); + } +} + +/** + * Test functions that use just the filter_config table. + */ +class filter_config_test extends UnitTestCaseUsingDatabase { + public function setUp() { + parent::setUp(); + + // Create the table we need and switch to test DB. + $this->create_test_table('filter_config', 'lib'); + $this->switch_to_test_db(); + } + + private function assert_only_one_config($filter, $context, $name, $value) { + $recs = $this->testdb->get_records('filter_config'); + $this->assertEqual(1, count($recs), 'More than one record returned %s.'); + $rec = reset($recs); + $expectedrec = new stdClass; + $expectedrec->filter = $filter; + $expectedrec->contextid = $context; + $expectedrec->name = $name; + $expectedrec->value = $value; + $this->assert(new CheckSpecifiedFieldsExpectation($expectedrec), $rec); + } + + public function test_set_new_config() { + // Exercise SUT. + filter_set_local_config('filter/name', 123, 'settingname', 'An arbitrary value'); + // Validate. + $this->assert_only_one_config('filter/name', 123, 'settingname', 'An arbitrary value'); + } + + public function test_update_existing_config() { + // Setup fixture. + filter_set_local_config('filter/name', 123, 'settingname', 'An arbitrary value'); + // Exercise SUT. + filter_set_local_config('filter/name', 123, 'settingname', 'A changed value'); + // Validate. + $this->assert_only_one_config('filter/name', 123, 'settingname', 'A changed value'); + } + + public function test_filter_get_local_config() { + // Setup fixture. + filter_set_local_config('filter/name', 123, 'setting1', 'An arbitrary value'); + filter_set_local_config('filter/name', 123, 'setting2', 'Another arbitrary value'); + filter_set_local_config('filter/name', 122, 'settingname', 'Value from another context'); + filter_set_local_config('filter/other', 123, 'settingname', 'Someone else\'s value'); + // Exercise SUT. + $config = filter_get_local_config('filter/name', 123); + // Validate. + $this->assertEqual(array('setting1' => 'An arbitrary value', 'setting2' => 'Another arbitrary value'), $config); + } +} + +class filter_get_active_available_in_context_test extends UnitTestCaseUsingDatabase { + private $syscontext; + private $childcontext; + private $childcontext2; + + public function setUp() { + parent::setUp(); + + // Make sure accesslib has cached a sensible system context object + // before we switch to the test DB. + $this->syscontext = get_context_instance(CONTEXT_SYSTEM); + + // Create the table we need and switch to test DB. + $this->create_test_tables(array('filter_active', 'filter_config', 'context'), 'lib'); + $this->switch_to_test_db(); + + // Set up systcontext in the test database. + $this->testdb->insert_record('context', $this->syscontext); + $this->syscontext->id = 1; + + // Set up a child context. + $this->childcontext = new stdClass; + $this->childcontext->contextlevel = CONTEXT_COURSECAT; + $this->childcontext->instanceid = 1; + $this->childcontext->depth = 2; + $this->childcontext->path = '/1/2'; + $this->testdb->insert_record('context', $this->childcontext); + $this->childcontext->id = 2; + + // Set up a grandchild context. + $this->childcontext2 = new stdClass; + $this->childcontext2->contextlevel = CONTEXT_COURSE; + $this->childcontext2->instanceid = 2; + $this->childcontext2->depth = 3; + $this->childcontext2->path = '/1/2/3'; + $this->testdb->insert_record('context', $this->childcontext2); + $this->childcontext2->id = 3; + } + + private function assert_filter_list($expectedfilters, $filters) { + $this->assert(new ArraysHaveSameValuesExpectation($expectedfilters), array_keys($filters)); + } + + public function test_globally_on_is_returned() { + // Setup fixture. + filter_set_global_state('filter/name', TEXTFILTER_ON); + // Exercise SUT. + $filters = filter_get_active_in_context($this->syscontext); + // Validate. + $this->assert_filter_list(array('filter/name'), $filters); + // Check no config returned correctly. + $this->assertEqual(array(), $filters['filter/name']); + } + + public function test_globally_off_not_returned() { + // Setup fixture. + filter_set_global_state('filter/name', TEXTFILTER_OFF); + // Exercise SUT. + $filters = filter_get_active_in_context($this->childcontext2); + // Validate. + $this->assert_filter_list(array(), $filters); + } + + public function test_globally_off_overridden() { + // Setup fixture. + filter_set_global_state('filter/name', TEXTFILTER_OFF); + filter_set_local_state('filter/name', $this->childcontext->id, TEXTFILTER_ON); + // Exercise SUT. + $filters = filter_get_active_in_context($this->childcontext2); + // Validate. + $this->assert_filter_list(array('filter/name'), $filters); + } + + public function test_globally_on_overridden() { + // Setup fixture. + filter_set_global_state('filter/name', TEXTFILTER_ON); + filter_set_local_state('filter/name', $this->childcontext->id, TEXTFILTER_OFF); + // Exercise SUT. + $filters = filter_get_active_in_context($this->childcontext2); + // Validate. + $this->assert_filter_list(array(), $filters); + } + + public function test_globally_disabled_not_overridden() { + // Setup fixture. + filter_set_global_state('filter/name', TEXTFILTER_DISABLED); + filter_set_local_state('filter/name', $this->childcontext->id, TEXTFILTER_ON); + // Exercise SUT. + $filters = filter_get_active_in_context($this->syscontext); + // Validate. + $this->assert_filter_list(array(), $filters); + } + + public function test_single_config_returned() { + // Setup fixture. + filter_set_global_state('filter/name', TEXTFILTER_ON); + filter_set_local_config('filter/name', $this->childcontext->id, 'settingname', 'A value'); + // Exercise SUT. + $filters = filter_get_active_in_context($this->childcontext); + // Validate. + $this->assertEqual(array('settingname' => 'A value'), $filters['filter/name']); + } + + public function test_multi_config_returned() { + // Setup fixture. + filter_set_global_state('filter/name', TEXTFILTER_ON); + filter_set_local_config('filter/name', $this->childcontext->id, 'settingname', 'A value'); + filter_set_local_config('filter/name', $this->childcontext->id, 'anothersettingname', 'Another value'); + // Exercise SUT. + $filters = filter_get_active_in_context($this->childcontext); + // Validate. + $this->assertEqual(array('settingname' => 'A value', 'anothersettingname' => 'Another value'), $filters['filter/name']); + } + + public function test_config_from_other_context_not_returned() { + // Setup fixture. + filter_set_global_state('filter/name', TEXTFILTER_ON); + filter_set_local_config('filter/name', $this->childcontext->id, 'settingname', 'A value'); + filter_set_local_config('filter/name', $this->childcontext2->id, 'anothersettingname', 'Another value'); + // Exercise SUT. + $filters = filter_get_active_in_context($this->childcontext2); + // Validate. + $this->assertEqual(array('anothersettingname' => 'Another value'), $filters['filter/name']); + } + + public function test_config_from_other_filter_not_returned() { + // Setup fixture. + filter_set_global_state('filter/name', TEXTFILTER_ON); + filter_set_local_config('filter/name', $this->childcontext->id, 'settingname', 'A value'); + filter_set_local_config('filter/other', $this->childcontext->id, 'anothersettingname', 'Another value'); + // Exercise SUT. + $filters = filter_get_active_in_context($this->childcontext); + // Validate. + $this->assertEqual(array('settingname' => 'A value'), $filters['filter/name']); + } + + protected function assert_one_available_filter($filter, $localstate, $inheritedstate, $filters) { + $this->assertEqual(1, count($filters), 'More than one record returned %s.'); + $rec = $filters[$filter]; + $expectedrec = new stdClass; + $expectedrec->filter = $filter; + $expectedrec->localstate = $localstate; + $expectedrec->inheritedstate = $inheritedstate; + $this->assert(new CheckSpecifiedFieldsExpectation($expectedrec), $rec); + } + + public function test_available_in_context_localoverride() { + // Setup fixture. + filter_set_global_state('filter/name', TEXTFILTER_ON); + filter_set_local_state('filter/name', $this->childcontext->id, TEXTFILTER_OFF); + // Exercise SUT. + $filters = filter_get_available_in_context($this->childcontext); + // Validate. + $this->assert_one_available_filter('filter/name', TEXTFILTER_OFF, TEXTFILTER_ON, $filters); + } + + public function test_available_in_context_nolocaloverride() { + // Setup fixture. + filter_set_global_state('filter/name', TEXTFILTER_ON); + filter_set_local_state('filter/name', $this->childcontext->id, TEXTFILTER_OFF); + // Exercise SUT. + $filters = filter_get_available_in_context($this->childcontext2); + // Validate. + $this->assert_one_available_filter('filter/name', TEXTFILTER_INHERIT, TEXTFILTER_OFF, $filters); + } + + public function test_available_in_context_disabled_not_returned() { + // Setup fixture. + filter_set_global_state('filter/name', TEXTFILTER_DISABLED); + filter_set_local_state('filter/name', $this->childcontext->id, TEXTFILTER_ON); + // Exercise SUT. + $filters = filter_get_available_in_context($this->childcontext); + // Validate. + $this->assertEqual(array(), $filters); + } + + public function test_available_in_context_exception_with_syscontext() { + // Set expectation. + $this->expectException(); + // Exercise SUT. + filter_get_available_in_context($this->syscontext); + } +} + +class filter_delete_all_data_test extends UnitTestCaseUsingDatabase { + public function setUp() { + parent::setUp(); + + // Create the table we need and switch to test DB. + $this->create_test_tables(array('filter_active', 'filter_config', 'config', 'config_plugins'), 'lib'); + $this->switch_to_test_db(); + } + + public function test_filter_delete_all_data_filter() { + // Setup fixture. + $syscontext = get_context_instance(CONTEXT_SYSTEM); + filter_set_global_state('filter/name', TEXTFILTER_ON); + filter_set_global_state('filter/other', TEXTFILTER_ON); + filter_set_local_config('filter/name', $syscontext->id, 'settingname', 'A value'); + filter_set_local_config('filter/other', $syscontext->id, 'settingname', 'Other value'); + set_config('configname', 'A config value', 'filter_name'); + set_config('configname', 'Other config value', 'filter_other'); + // Exercise SUT. + filter_delete_all_data('filter/name'); + // Validate. + $this->assertEqual(1, $this->testdb->count_records('filter_active')); + $this->assertTrue($this->testdb->record_exists('filter_active', array('filter' => 'filter/other'))); + $this->assertEqual(1, $this->testdb->count_records('filter_config')); + $this->assertTrue($this->testdb->record_exists('filter_config', array('filter' => 'filter/other'))); + $expectedconfig = new stdClass; + $expectedconfig->configname = 'Other config value'; + $this->assertEqual($expectedconfig, get_config('filter_other')); + $this->assertFalse(get_config('filter_name')); + } +} + +class filter_filter_set_applies_to_strings extends UnitTestCaseUsingDatabase { + protected $origcfgstringfilters; + protected $origcfgfilterall; + + public function setUp() { + global $CFG; + parent::setUp(); + + // Create the table we need and switch to test DB. + $this->create_test_table('config', 'lib'); + $this->switch_to_test_db(); + + // Store original $CFG; + $this->origcfgstringfilters = $CFG->stringfilters; + $this->origcfgfilterall = $CFG->filterall; + } + + public function tearDown() { + $CFG->stringfilters = $this->origcfgstringfilters; + $CFG->filterall = $this->origcfgfilterall; + + parent::tearDown(); + } + + public function test_set() { + global $CFG; + // Setup fixture. + $CFG->filterall = 0; + $CFG->stringfilters = ''; + // Exercise SUT. + filter_set_applies_to_strings('filter/name', true); + // Validate. + $this->assertEqual('filter/name', $CFG->stringfilters); + $this->assertTrue($CFG->filterall); + } + + public function test_unset_to_empty() { + global $CFG; + // Setup fixture. + $CFG->filterall = 1; + $CFG->stringfilters = 'filter/name'; + // Exercise SUT. + filter_set_applies_to_strings('filter/name', false); + // Validate. + $this->assertEqual('', $CFG->stringfilters); + $this->assertFalse($CFG->filterall); + } + + public function test_unset_multi() { + global $CFG; + // Setup fixture. + $CFG->filterall = 1; + $CFG->stringfilters = 'filter/name,filter/other'; + // Exercise SUT. + filter_set_applies_to_strings('filter/name', false); + // Validate. + $this->assertEqual('filter/other', $CFG->stringfilters); + $this->assertTrue($CFG->filterall); + } +} +?> diff --git a/lib/simpletest/testfiltermanager.php b/lib/simpletest/testfiltermanager.php new file mode 100644 index 0000000..f032ce9 --- /dev/null +++ b/lib/simpletest/testfiltermanager.php @@ -0,0 +1,129 @@ +libdir . '/filterlib.php'); + +class testable_filter_manager extends filter_manager { + public function __construct() { + parent::__construct(); + } + public function make_filter_object($filtername, $context, $courseid, $localconfig) { + return parent::make_filter_object($filtername, $context, $courseid, $localconfig); + } + public function apply_filter_chain($text, $filterchain) { + return parent::apply_filter_chain($text, $filterchain); + } +} + +/** + * Test functions that affect filter_active table with contextid = $syscontextid. + */ +class filter_manager_test extends UnitTestCase { + protected $filtermanager; + protected $olddirroot; + + public function setUp() { + global $CFG; + $this->filtermanager = new testable_filter_manager(); + $this->olddirroot = $CFG->dirroot; + $CFG->dirroot = $CFG->dataroot . '/temp'; + } + + public function tearDown() { + global $CFG; + $CFG->dirroot = $this->olddirroot; + } + + /** Basically does file_put_contents, but ensures the directory exists first. */ + protected function write_file($path, $content) { + global $CFG; + make_upload_directory(str_replace($CFG->dataroot . '/', '', dirname($path))); + file_put_contents($path, $content); + } + + public function test_make_filter_object_newstyle() { + global $CFG; + $this->write_file($CFG->dirroot . '/filter/makenewstyletest/filter.php', <<filtermanager->make_filter_object('filter/makenewstyletest', null, 1, array()); + $this->assertIsA($filter, 'moodle_text_filter'); + $this->assertNotA($filter, 'legacy_filter'); + } + + public function test_make_filter_object_legacy() { + global $CFG; + $this->write_file($CFG->dirroot . '/filter/makelegacytest/filter.php', << filtermanager->make_filter_object('filter/makelegacytest', null, 1, array()); + $this->assertIsA($filter, 'legacy_filter'); + } + + public function test_make_filter_object_missing() { + $this->assertNull($this->filtermanager->make_filter_object('filter/nonexistant', null, 1, array())); + } + + public function test_apply_filter_chain() { + $filterchain = array(new doubleup_test_filter(null, 1, array()), new killfrogs_test_filter(null, 1, array())); + $this->assertEqual('pawn pawn', $this->filtermanager->apply_filter_chain('frogspawn', $filterchain)); + } +} + +class doubleup_test_filter extends moodle_text_filter { + public function filter($text) { + return $text . ' ' . $text; + } +} + +class killfrogs_test_filter extends moodle_text_filter { + public function filter($text) { + return str_replace('frogs', '', $text); + } +} + +?> diff --git a/lib/weblib.php b/lib/weblib.php index aa704f6..d94903f 100644 --- a/lib/weblib.php +++ b/lib/weblib.php @@ -1253,27 +1253,17 @@ function format_text($text, $format=FORMAT_MOODLE, $options=NULL, $courseid=NULL $courseid = $COURSE->id; } - // if filter plugin is OOP format, add it to filter list and append hash - // value to $hashstr - if (!empty($CFG->textfilters)) { - require_once($CFG->libdir.'/filterlib.php'); - $textfilters = explode(',', $CFG->textfilters); - foreach ($textfilters as $textfilter) { - if (is_readable($CFG->dirroot .'/'. $textfilter .'/filter.php')) { - include_once($CFG->dirroot .'/'. $textfilter .'/filter.php'); - $text_filter = basename($textfilter).'_filter'; - if (class_exists($text_filter)) { - $obj = new $text_filter($courseid, $format, $options); - filter_base::addfilter($text_filter, $obj); - $hashstr .= $obj->hash(); - } - } - } + if ($options->filter) { + $filtermanager = filter_manager::instance(); + } else { + $filtermanager = new null_filter_manager(); } + $context = get_context_instance(CONTEXT_SYSTEM); // TODO change, once we have $PAGE->context. + if (!empty($CFG->cachetext) and empty($options->nocache)) { - $hashstr .= $text.'-'.(int)$courseid.'-'.current_language().'-'.(int)$format.(int)$options->trusttext.(int)$options->noclean.(int)$options->smiley.(int)$options->filter.(int)$options->para.(int)$options->newlines; - // for debug filtering system - // $hashstr .= time(); + $hashstr .= $text.'-'.$filtermanager->text_filtering_hash($context, $courseid).'-'.(int)$courseid.'-'.current_language().'-'. + (int)$format.(int)$options->trusttext.(int)$options->noclean.(int)$options->smiley. + (int)$options->filter.(int)$options->para.(int)$options->newlines; $time = time() - $CFG->cachetext; $md5key = md5($hashstr); @@ -1316,8 +1306,6 @@ function format_text($text, $format=FORMAT_MOODLE, $options=NULL, $courseid=NULL $text = trusttext_strip($text); } - $CFG->currenttextiscacheable = true; // Default status - can be changed by any filter - switch ($format) { case FORMAT_HTML: if ($options->smiley) { @@ -1326,9 +1314,7 @@ function format_text($text, $format=FORMAT_MOODLE, $options=NULL, $courseid=NULL if (!$options->noclean) { $text = clean_text($text, FORMAT_HTML); } - if ($options->filter) { - $text = filter_base::do_filter($text, $courseid); - } + $text = $filtermanager->filter_text($text, $context, $courseid); break; case FORMAT_PLAIN: @@ -1354,10 +1340,7 @@ function format_text($text, $format=FORMAT_MOODLE, $options=NULL, $courseid=NULL if (!$options->noclean) { $text = clean_text($text, FORMAT_HTML); } - - if ($options->filter) { - $text = filter_base::do_filter($text, $courseid); - } + $text = $filtermanager->filter_text($text, $context, $courseid); break; default: // FORMAT_MOODLE or anything else @@ -1365,14 +1348,20 @@ function format_text($text, $format=FORMAT_MOODLE, $options=NULL, $courseid=NULL if (!$options->noclean) { $text = clean_text($text, FORMAT_HTML); } - - if ($options->filter) { - $text = filter_base::do_filter($text, $courseid); - } + $text = $filtermanager->filter_text($text, $context, $courseid); break; } - if (empty($options->nocache) and !empty($CFG->cachetext) and $CFG->currenttextiscacheable) { + // Warn people that we have removed this old mechanism, just in case they + // were stupid enough to rely on it. + if (isset($CFG->currenttextiscacheable)) { + debugging('Once upon a time, Moodle had a truly evil use of global variables ' . + 'called $CFG->currenttextiscacheable. The good news is that this no ' . + 'longer exists. The bad news is that you seem to be using a filter that '. + 'relies on it. Please seek out and destroy that filter code.', DEBUG_DEVELOPER); + } + + if (empty($options->nocache) and !empty($CFG->cachetext)) { if (CLI_SCRIPT) { // special static cron cache - no need to store it in db if its not already there if (count($croncache) > 150) { @@ -1457,7 +1446,7 @@ function reset_text_filters_cache() { * @param int $courseid Current course as filters can, potentially, use it * @return string */ -function format_string ($string, $striplinks=true, $courseid=NULL ) { +function format_string($string, $striplinks=true, $courseid=NULL ) { global $CFG, $COURSE; @@ -1485,7 +1474,8 @@ function format_string ($string, $striplinks=true, $courseid=NULL ) { $string = preg_replace("/\&(?![a-zA-Z0-9#]{1,8};)/", "&", $string); if (!empty($CFG->filterall)) { - $string = filter_string($string, $courseid); + $context = get_context_instance(CONTEXT_SYSTEM); // TODO change, once we have $PAGE->context. + $string = filter_manager::instance()->filter_string($string, $context, $courseid); } // If the site requires it, strip ALL tags from this string @@ -1551,16 +1541,11 @@ function format_text_email($text, $format) { /** * Given some text in HTML format, this function will pass it - * through any filters that have been defined in $CFG->textfilterx - * The variable defines a filepath to a file containing the - * filter function. The file must contain a variable called - * $textfilter_function which contains the name of the function - * with $courseid and $text parameters + * through any filters that have been configured for this context. * * @param string $text The text to be passed through format filters - * @param int $courseid ? - * @return string - * @todo Finish documenting this function + * @param int $courseid The current course. + * @return string the filtered string. */ function filter_text($text, $courseid=NULL) { global $CFG, $COURSE; @@ -1569,85 +1554,9 @@ function filter_text($text, $courseid=NULL) { $courseid = $COURSE->id; // (copied from format_text) } - if (!empty($CFG->textfilters)) { - require_once($CFG->libdir.'/filterlib.php'); - $textfilters = explode(',', $CFG->textfilters); - foreach ($textfilters as $textfilter) { - if (is_readable($CFG->dirroot .'/'. $textfilter .'/filter.php')) { - include_once($CFG->dirroot .'/'. $textfilter .'/filter.php'); - $functionname = basename($textfilter).'_filter'; - if (function_exists($functionname)) { - $text = $functionname($courseid, $text); - } - } - } - } - - /// tags removed for XHTML compatibility - $text = str_replace(' ', '', $text); - $text = str_replace(' ', '', $text); - - return $text; -} - - -/** - * Given a string (short text) in HTML format, this function will pass it - * through any filters that have been defined in $CFG->stringfilters - * The variable defines a filepath to a file containing the - * filter function. The file must contain a variable called - * $textfilter_function which contains the name of the function - * with $courseid and $text parameters - * - * @param string $string The text to be passed through format filters - * @param int $courseid The id of a course - * @return string - */ -function filter_string($string, $courseid=NULL) { - global $CFG, $COURSE; - - if (empty($CFG->textfilters)) { // All filters are disabled anyway so quit - return $string; - } - - if (empty($courseid)) { - $courseid = $COURSE->id; - } - - require_once($CFG->libdir.'/filterlib.php'); - - if (isset($CFG->stringfilters)) { // We have a predefined list to use, great! - if (empty($CFG->stringfilters)) { // but it's blank, so finish now - return $string; - } - $stringfilters = explode(',', $CFG->stringfilters); // ..use the list we have - - } else { // Otherwise try to derive a list from textfilters - if (strpos($CFG->textfilters, 'filter/multilang') !== false) { // Multilang is here - $stringfilters = array('filter/multilang'); // Let's use just that - $CFG->stringfilters = 'filter/multilang'; // Save it for next time through - } else { - $CFG->stringfilters = ''; // Save the result and return - return $string; - } - } - + $context = get_context_instance(CONTEXT_SYSTEM); // TODO change, once we have $PAGE->context. - foreach ($stringfilters as $stringfilter) { - if (is_readable($CFG->dirroot .'/'. $stringfilter .'/filter.php')) { - include_once($CFG->dirroot .'/'. $stringfilter .'/filter.php'); - $functionname = basename($stringfilter).'_filter'; - if (function_exists($functionname)) { - $string = $functionname($courseid, $string); - } - } - } - - ///tags removed for XHTML compatibility - $string = str_replace(' ', '', $string); - $string = str_replace(' ', '', $string); - - return $string; + return filter_manager::instance()->filter_text($text, $context, $courseid); } /** @@ -1698,6 +1607,7 @@ function trusttext_mark($text) { return $text; } } + function trusttext_after_edit(&$text, $context) { if (has_capability('moodle/site:trustcontent', $context)) { $text = trusttext_strip($text); diff --git a/theme/standard/styles_layout.css b/theme/standard/styles_layout.css index b9f930e..2305627 100644 --- a/theme/standard/styles_layout.css +++ b/theme/standard/styles_layout.css @@ -1115,6 +1115,7 @@ body#admin-modules table.generaltable td.c0 #admin-qtypes #qtypes img.spacer { width: 16px; } +#filter-manage .buttons, #admin-roles-allow .buttons, #admin-roles-manage .buttons, #admin-roles-define .buttons, @@ -1183,6 +1184,7 @@ body#admin-modules table.generaltable td.c0 #admin-roles-define .mform { width: 100%; } +#filter-manage .backlink, #admin-roles-manage .backlink, #admin-roles-define .backlink, #admin-roles-explain .backlink, diff --git a/version.php b/version.php index 1995fe6..18608bc 100644 --- a/version.php +++ b/version.php @@ -6,7 +6,7 @@ // This is compared against the values stored in the database to determine // whether upgrades should be performed (see lib/db/*.php) - $version = 2009040100; // YYYYMMDD = date of the last version bump + $version = 2009040600; // YYYYMMDD = date of the last version bump // XX = daily increments $release = '2.0 dev (Build: 20090409)'; // Human-friendly version name