Filters fit between the raw text in a node and the HTML output. They allow you to replace text selectively. Uses include automatic conversion of emoticons into graphics and filtering HTML content from users' submissions.
+If you notice some filters are causing conflicts in the output, you can rearrange them.
", array("%url" => url("admin/system/filters/order"))); + case 'admin/system/filters/order': + return t(" +Because of the flexible filtering system, you might encounter a situation where one filter prevents another from doing its job. For example: a word in an URL gets converted into a glossary term, before the URL can be converted in a clickable link. When this happens, you will need to rearrange the order in which filters get executed.
+Filters are executed from top-to-bottom. You can use the weight column to rearrange them: heavier filters 'sink' to the bottom. Standard HTML filtering is always run first.
"); case 'filter#long-tip': case 'filter#short-tip': switch (variable_get("filter_html", 1)) { @@ -32,17 +38,65 @@ if ($type == "system") { if (user_access("administer site configuration")) { menu("admin/system/filters", t("filters"), "filter_admin", 5); + menu("admin/system/filters/order", t("ordering"), "filter_admin", 5); } menu("filter/tips", t("Compose tips"), "filter_tips_long", 0, MENU_HIDE); } } +function filter_admin_order() { + $edit = $_POST["edit"]; + $op = $_POST["op"]; + if ($op == t("Save configuration")) { + foreach ($edit as $module => $filter) { + db_query("UPDATE {filters} SET weight = '%d' WHERE module = '%s'", $filter["weight"], $module); + } + } + + // Get list (with forced refresh) + filter_refresh(); + $filters = filter_list(); + + $header = array("name", "weight"); + $rows = array(); + + // Standard HTML filters are always run first, we add a dummy row to indicate this + $rows[] = array(t("HTML filtering"), array("data" => t("locked"))); + + foreach ($filters as $module => $filter) { + $name = module_invoke($module, "filter", "name"); + $rows[] = array($name, array("data" => form_weight(NULL, $module ."][weight", $filter["weight"]))); + } + + $form = theme("table", $header, $rows); + $form .= form_submit(t("Save configuration")); + $output = form($form); + + return $output; +} + +function filter_admin_settings() { + system_settings_save(); + + filter_refresh(); + + $form = filter_default_config(); + $form .= implode("\n", module_invoke_all("filter", "config")); + $output = system_settings_form($form); + + return $output; +} + function filter_admin() { if (user_access("administer site configuration")) { - system_settings_save(); - - $form = implode("\n", module_invoke_all("conf_filters")); - $output = system_settings_form($form); + switch (arg(3)) { + case "order": + $output = filter_admin_order(); + break; + default: + $output = filter_admin_settings(); + break; + } print theme("page", $output); } else { @@ -50,30 +104,56 @@ } } -function filter_conf_filters() { - $group1 .= form_radios(t("Filter HTML tags"), "filter_html", variable_get("filter_html", 0), array(0 => t("Do not filter"), 1 => t("Strip tags"), 2 => t("Escape tags")), t("How to deal with HTML and PHP tags in user-contributed content. If set to \"Strip tags\", dangerous tags are removed (see below). If set to \"Escape tags\", all HTML is escaped and presented as it was typed.")); - $group1 .= form_textfield(t("Allowed HTML tags"), "allowed_html", variable_get("allowed_html", "mod_rewrite is available on your system, use the rewrite rules in Drupal's .htaccess file instead as these will also correct external referrers."));
- $output .= form_group(t("Legacy filtering"), $group2);
+ db_query("INSERT INTO {filters} (module, weight) VALUES ('%s','%d')", $module, $weight);
+ }
+ }
- return $output;
+ filter_list(1);
+}
+
+function filter_list($force = 0) {
+ static $filters;
+
+ if (!is_array($filters) || $force) {
+ $filters = array();
+ $result = db_query("SELECT * FROM {filters} ORDER BY weight ASC");
+ while ($filter = db_fetch_array($result)) {
+ // Fail-safe in case a module was deleted/changed without disabling it
+ if (module_hook($filter["module"], "filter")) {
+ $filters[$filter["module"]] = $filter;
+ }
+ }
+ }
+
+ return $filters;
}
function check_output($text) {
if (isset($text)) {
- // filter content on output:
- $modules = module_list();
+ // Filter content on output:
+ $filters = filter_list();
- // Default filters are run first: they determine how to handle HTML
+ // Give filters the chance to escape HTML-like data before being passed to the HTML stripper
+ foreach ($filters as $module => $filter) {
+ $text = module_invoke($module, "filter", "prepare", $text);
+ }
+
+ // HTML handling is done before all regular filtering activities
$text = filter_default($text);
- foreach ($modules as $name) {
- if (module_hook($name, "filter")) {
- $text = module_invoke($name, "filter", $text);
- }
+ // Regular filtering
+ foreach ($filters as $module => $filter) {
+ $text = module_invoke($module, "filter", "process", $text);
}
/*
@@ -101,10 +181,6 @@
$text = preg_replace("/\Won[a-z]+\s*=[^>]+?>/i", ">", $text);
}
- if (variable_get("rewrite_old_urls", 0)) {
- $text = filter_old_urls($text);
- }
-
if (variable_get("filter_html", 0) == 2) {
// Escape HTML
$text = htmlspecialchars($text);
@@ -113,6 +189,33 @@
return trim($text);
}
+function filter_default_config() {
+ $group = form_radios(t("Filter HTML tags"), "filter_html", variable_get("filter_html", 0), array(0 => t("Do not filter"), 1 => t("Strip tags"), 2 => t("Escape tags")), t("How to deal with HTML and PHP tags in user-contributed content. If set to \"Strip tags\", dangerous tags are removed (see below). If set to \"Escape tags\", all HTML is escaped and presented as it was typed."));
+ $group .= form_textfield(t("Allowed HTML tags"), "allowed_html", variable_get("allowed_html", " mod_rewrite is available on your system, use the rewrite rules in Drupal's .htaccess file instead as these will also correct external referrers."));
+ $output .= form_group(t("Legacy filtering"), $group);
+ return $output;
+ default:
+ return $text;
+ }
+}
+
function filter_old_urls($text) {
global $base_url;
Index: modules/title.module
===================================================================
RCS file: /cvs/drupal/drupal/modules/title.module,v
retrieving revision 1.25
diff -u -r1.25 title.module
--- modules/title.module 1 Feb 2004 17:55:11 -0000 1.25
+++ modules/title.module 3 Feb 2004 22:57:00 -0000
@@ -64,15 +64,28 @@
}
}
+function title_filter($op, $text = "") {
+ switch ($op) {
+ case "name":
+ return t("Title filter");
+ case "process":
+ return _title_filter_process($text);
+ case "config":
+ return _title_filter_config($text);
+ default:
+ return $text;
+ }
+}
+
// filter [node title|description] links. '|description' is optional.
-function title_filter($text) {
+function _title_filter_process($text) {
$pattern = '\[([^\|\]]+)(?>\|?)(.*?)\]'; // $1 == title: matches at least 1 char up to the first '|' or ']'
// $2 == text: matches all after a following '|' (if there is) up to the next ']'. may include '|'s.
$replacement = 'l("$2" ? "$2" : "$1", "title/". urlencode("$1"))';
return preg_replace("/$pattern/e", $replacement, $text);
}
-function title_conf_filters() {
+function _title_filter_config() {
return form_group(t("Title filter"), t("Wiki-like [node title|text] links are enabled. These shortcuts generate a link labeled 'text' to the node with the title 'node title'. If you omit '|text', the label becomes 'node title'. You may use a substring of a node title if desired. When multiple matching titles are found, a list of matching nodes will be displayed. If no matching titles are found, a full-text search is returned."));
}