filter.module 38 KB
Newer Older
1 2 3
<?php
// $Id$

Dries's avatar
 
Dries committed
4 5 6 7 8
/**
 * @file
 * Framework for handling filtering of content.
 */

9 10 11
// This is a special format ID which means "use the default format". This value
// can be passed to the filter APIs as a format ID: this is equivalent to not
// passing an explicit format at all.
12 13
define('FILTER_FORMAT_DEFAULT', 0);

14 15 16 17 18 19
define('FILTER_HTML_STRIP', 1);
define('FILTER_HTML_ESCAPE', 2);

define('FILTER_STYLE_ALLOW', 0);
define('FILTER_STYLE_STRIP', 1);

Dries's avatar
Dries committed
20 21 22 23
/**
 * Implementation of hook_help().
 */
function filter_help($section) {
24
  switch ($section) {
Dries's avatar
 
Dries committed
25
    case 'admin/modules#description':
26
      return t('Handles the filtering of content in preparation for display.');
27

Dries's avatar
 
Dries committed
28
    case 'admin/filters':
29
      return t('
Dries's avatar
 
Dries committed
30
<p><em>Input formats</em> define a way of processing user-supplied text in Drupal. Every input format has its own settings of which <em>filters</em> to apply. Possible filters include stripping out malicious HTML and making URLs clickable.</p>
31 32 33
<p>Users can choose between the available input formats when submitting content.</p>
<p>Below you can configure which input formats are available to which roles, as well as choose a default input format (used for imported content, for example).</p>');

34
    case 'admin/filters/'. arg(2):
35
      return t('
Dries's avatar
 
Dries committed
36
<p>Every <em>filter</em> performs one particular change on the user input, for example stripping out malicious HTML or making URLs clickable. Choose which filters you want to apply to text in this input format.</p>
37
<p>If you notice some filters are causing conflicts in the output, you can <a href="%order">rearrange them</a>.</p>', array('%configure' => url('admin/filters/'. arg(2) .'/configure'), '%order' => url('admin/filters/'. arg(2) .'/order')));
38

39
    case 'admin/filters/'. arg(2) .'/configure':
40 41 42
      return t('
<p>If you cannot find the settings for a certain filter, make sure you\'ve enabled it on the <a href="%url">list filters</a> tab first.</p>', array('%url' => url('admin/filters/'. arg(2) .'/list')));

43
    case 'admin/filters/'. arg(2) .'/order':
44
      return t('
Dries's avatar
 
Dries committed
45
<p>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.</p>
46 47 48 49 50
<p>Filters are executed from top-to-bottom. You can use the weight column to rearrange them: heavier filters \'sink\' to the bottom.</p>');
  }
}

/**
51
 * Implementation of hook_filter_tips().
52
 */
53
function filter_filter_tips($delta, $format, $long = false) {
54
  global $base_url;
55 56 57 58 59
  switch ($delta) {
    case 0:
      switch (variable_get("filter_html_$format", FILTER_HTML_STRIP)) {

        case FILTER_HTML_STRIP:
Dries's avatar
 
Dries committed
60
          if ($allowed_html = variable_get("allowed_html_$format", '<a> <em> <strong> <cite> <code> <ul> <ol> <li> <dl> <dt> <dd>')) {
61 62
            switch ($long) {
              case 0:
63
                return t('Allowed HTML tags') .': '. check_plain($allowed_html);
64
              case 1:
65
                $output = '<p>'. t('Allowed HTML tags') .': '. check_plain($allowed_html) .'</p>';
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
                if (!variable_get("filter_html_help_$format", 1)) {
                  return $output;
                }

                $output .= t('<p>This site allows HTML content. While learning all of HTML may feel intimidating, learning how to use a very small number of the most basic HTML "tags" is very easy. This table provides examples for each tag that is enabled on this site.</p>
<p>For more information see W3C\'s <a href="http://www.w3.org/TR/html/">HTML Specifications</a> or use your favorite search engine to find other sites that explain HTML.</p>');
                $tips = array(
                  'a' => array( t('Anchors are used to make links to other pages.'), '<a href="'. $base_url .'">'. variable_get('site_name', 'drupal') .'</a>'),
                  'br' => array( t('By default line break tags are automatically added, so use this tag to add additional ones. Use of this tag is different because it is not used with an open/close pair like all the others. Use the extra " /" inside the tag to maintain XHTML 1.0 compatibility'), t('Text with <br />line break')),
                  'p' => array( t('By default paragraph tags are automatically added, so use this tag to add additional ones.'), '<p>'. t('Paragraph one.') .'</p> <p>'. t('Paragraph two.') .'</p>'),
                  'strong' => array( t('Strong'), '<strong>'. t('Strong'). '</strong>'),
                  'em' => array( t('Emphasized'), '<em>'. t('Emphasized') .'</em>'),
                  'cite' => array( t('Cited'), '<cite>'. t('Cited') .'</cite>'),
                  'code' => array( t('Coded text used to show programming source code'), '<code>'. t('Coded') .'</code>'),
                  'b' => array( t('Bolded'), '<b>'. t('Bolded') .'</b>'),
                  'u' => array( t('Underlined'), '<u>'. t('Underlined') .'</u>'),
                  'i' => array( t('Italicized'), '<i>'. t('Italicized') .'</i>'),
                  'sup' => array( t('Superscripted'), t('<sup>Super</sup>scripted')),
                  'sub' => array( t('Subscripted'), t('<sub>Sub</sub>scripted')),
                  'pre' => array( t('Preformatted'), '<pre>'. t('Preformatted') .'</pre>'),
                  'blockquote' => array( t('Block quoted'), '<blockquote>'. t('Block quoted') .'</blockquote>'),
                  'q' => array( t('Quoted inline'), '<q>'. t('Quoted inline') .'</q>'),
                  // Assumes and describes tr, td, th.
                  'table' => array( t('Table'), '<table> <tr><th>'. t('Table header') .'</th></tr> <tr><td>'. t('Table cell') .'</td></tr> </table>'),
                  'tr' => NULL, 'td' => NULL, 'th' => NULL,
                  'del' => array( t('Deleted'), '<del>'. t('Deleted') .'</del>'),
                  'ins' => array( t('Inserted'), '<ins>'. t('Inserted') .'</ins>'),
                   // Assumes and describes li.
                  'ol' => array( t('Ordered list - use the &lt;li&gt; to begin each list item'), '<ol> <li>'. t('First item') .'</li> <li>'. t('Second item') .'</li> </ol>'),
                  'ul' => array( t('Unordered list - use the &lt;li&gt; to begin each list item'), '<ul> <li>'. t('First item') .'</li> <li>'. t('Second item') .'</li> </ul>'),
                  'li' => NULL,
                  // Assumes and describes dt and dd.
                  'dl' => array( t('Definition lists are similar to other HTML lists. &lt;dl&gt; begins the definition list, &lt;dt&gt; begins the definition term and &lt;dd&gt; begins the definition description.'), '<dl> <dt>'. t('First term') .'</dt> <dd>'. t('First definition') .'</dd> <dt>'. t('Second term') .'</dt> <dd>'. t('Second definition') .'</dd> </dl>'),
                  'dt' => NULL, 'dd' => NULL,
                  'h1' => array( t('Header'), '<h1>'. t('Title') .'</h1>'),
                  'h2' => array( t('Header'), '<h2>'. t('Subtitle') .'</h2>'),
                  'h3' => array( t('Header'), '<h3>'. t('Subtitle three') .'</h3>'),
                  'h4' => array( t('Header'), '<h4>'. t('Subtitle four') .'</h4>'),
                  'h5' => array( t('Header'), '<h5>'. t('Subtitle five') .'</h5>'),
                  'h6' => array( t('Header'), '<h6>'. t('Subtitle six') .'</h6>')
                );
                $header = array(t('Tag Description'), t('You Type'), t('You Get'));
                preg_match_all('/<([a-z0-9]+)[^a-z0-9]/i', $allowed_html, $out);
                foreach ($out[1] as $tag) {
                  if (array_key_exists($tag, $tips)) {
                    if ($tips[$tag]) {
                      $rows[] = array(
                        array('data' => $tips[$tag][0], 'class' => 'description'),
114
                        array('data' => '<code>'. check_plain($tips[$tag][1]) .'</code>', 'class' => 'type'),
115 116 117 118 119 120
                        array('data' => $tips[$tag][1], 'class' => 'get')
                      );
                    }
                  }
                  else {
                    $rows[] = array(
121
                      array('data' => t('No help provided for tag %tag.', array('%tag' => check_plain($tag))), 'class' => 'description', 'colspan' => 3),
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
                    );
                  }
                }
                $output .= theme('table', $header, $rows);

                $output .= t('<p>Most unusual characters can be directly entered without any problems.</p>
<p>If you do encounter problems, try using HTML character entities. A common example looks like &amp;amp; for an ampersand &amp; character. For a full list of entities see HTML\'s <a href="http://www.w3.org/TR/html4/sgml/entities.html">entities</a> page. Some of the available characters include:</p>');
                $entities = array(
                  array( t('Ampersand'), '&amp;'),
                  array( t('Greater than'), '&gt;'),
                  array( t('Less than'), '&lt;'),
                  array( t('Quotation mark'), '&quot;'),
                );
                $header = array(t('Character Description'), t('You Type'), t('You Get'));
                unset($rows);
                foreach ($entities as $entity) {
                  $rows[] = array(
                    array('data' => $entity[0], 'class' => 'description'),
140
                    array('data' => '<code>'. check_plain($entity[1]) .'</code>', 'class' => 'type'),
141 142 143 144 145 146
                    array('data' => $entity[1], 'class' => 'get')
                  );
                }
                $output .= theme('table', $header, $rows);
                return $output;
            }
147 148
          }
          else {
Dries's avatar
Dries committed
149
            return t('No HTML tags allowed');
Dries's avatar
 
Dries committed
150
          }
151 152

        case FILTER_STYLE_STRIP:
Dries's avatar
Dries committed
153
          return t('No HTML tags allowed');
Dries's avatar
 
Dries committed
154 155
      }
      break;
156 157

    case 1:
Dries's avatar
 
Dries committed
158
      switch ($long) {
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
        case 0:
          return t('You may post PHP code. You should include &lt;?php ?&gt; tags.');
        case 1:
          return t('
<h4>Using custom PHP code</h4>
<p>If you know how to script in PHP, Drupal gives you the power to embed any script you like. It will be executed when the page is viewed and dynamically embedded into the page. This gives you amazing flexibility and power, but of course with that comes danger and insecurity if you don\'t write good code. If you are not familiar with PHP, SQL or with the site engine, avoid experimenting with PHP because you can corrupt your database or render your site insecure or even unusable! If you don\'t plan to do fancy stuff with your content then you\'re probably better off with straight HTML.</p>
<p>Remember that the code within each PHP item must be valid PHP code - including things like correctly terminating statements with a semicolon. It is highly recommended that you develop your code separately using a simple test script on top of a test database before migrating to your production environment.</p>
<p>Notes:</p><ul><li>You can use global variables, such as configuration parameters, within the scope of your PHP code but remember that global variables which have been given values in your code will retain these values in the engine afterwards.</li><li>register_globals is now set to <strong>off</strong> by default. If you need form information you need to get it from the "superglobals" $_POST, $_GET, etc.</li><li>You can either use the <code>print</code> or <code>return</code> statement to output the actual content for your item.</li></ul>
<p>A basic example:</p>
<blockquote><p>You want to have a box with the title "Welcome" that you use to greet your visitors. The content for this box could be created by going:</p>
<pre>
  print t("Welcome visitor, ... welcome message goes here ...");
</pre>
<p>If we are however dealing with a registered user, we can customize the message by using:</p>
<pre>
  global $user;
  if ($user->uid) {
    print t("Welcome $user->name, ... welcome message goes here ...");
  }
  else {
    print t("Welcome visitor, ... welcome message goes here ...");
  }
</pre></blockquote>
<p>For more in-depth examples, we recommend that you check the existing Drupal code and use it as a starting point, especially for sidebar boxes.</p>');
      }

185
    case 2:
186 187 188 189 190
      switch ($long) {
        case 0:
          return t('Lines and paragraphs break automatically.');
        case 1:
          return t('Lines and paragraphs are automatically recognized. The &lt;br /&gt; line break, &lt;p&gt; paragraph and &lt;/p&gt; close paragraph tags are inserted automatically. If paragraphs are not recognized simply add a couple blank lines.');
191
      break;
192
      }
193 194 195
  }
}

196

Dries's avatar
 
Dries committed
197
/**
Dries's avatar
 
Dries committed
198
 * Implementation of hook_menu().
Dries's avatar
 
Dries committed
199
 */
Dries's avatar
 
Dries committed
200
function filter_menu($may_cache) {
Dries's avatar
 
Dries committed
201
  $items = array();
202

Dries's avatar
 
Dries committed
203 204 205
  if ($may_cache) {
    $items[] = array('path' => 'admin/filters', 'title' => t('input formats'),
      'callback' => 'filter_admin_overview',
206 207
      'access' => user_access('administer filters'));

Dries's avatar
 
Dries committed
208 209 210
    $items[] = array('path' => 'admin/filters/delete', 'title' => t('delete input format'),
      'callback' => 'filter_admin_delete',
      'type' => MENU_CALLBACK,
211 212
      'access' => user_access('administer filters'));

Dries's avatar
 
Dries committed
213 214 215 216 217 218 219 220 221 222 223 224 225 226
    $items[] = array('path' => 'filter/tips', 'title' => t('compose tips'),
      'callback' => 'filter_tips_long', 'access' => TRUE,
      'type' => MENU_SUGGESTED_ITEM);
  }
  else {
    if (arg(0) == 'admin' && arg(1) == 'filters' && is_numeric(arg(2))) {
      $formats = filter_formats();

      if (isset($formats[arg(2)])) {
        $items[] = array('path' => 'admin/filters/'. arg(2), 'title' => t("'%format' input format", array('%format' => $formats[arg(2)]->name)),
        'callback' => 'filter_admin_filters',
        'type' => MENU_CALLBACK,
        'access' => user_access('administer filters'));

Dries's avatar
 
Dries committed
227
        $items[] = array('path' => 'admin/filters/'. arg(2) .'/list', 'title' => t('list'),
Dries's avatar
 
Dries committed
228 229 230 231 232
        'callback' => 'filter_admin_filters',
        'type' => MENU_DEFAULT_LOCAL_TASK,
        'weight' => 0,
        'access' => user_access('administer filters'));

Dries's avatar
 
Dries committed
233
        $items[] = array('path' => 'admin/filters/'. arg(2) .'/configure', 'title' => t('configure'),
Dries's avatar
 
Dries committed
234 235 236 237 238
        'callback' => 'filter_admin_configure',
        'type' => MENU_LOCAL_TASK,
        'weight' => 1,
        'access' => user_access('administer filters'));

Dries's avatar
 
Dries committed
239
        $items[] = array('path' => 'admin/filters/'. arg(2) .'/order', 'title' => t('rearrange'),
Dries's avatar
 
Dries committed
240 241 242 243 244
        'callback' => 'filter_admin_order',
        'type' => MENU_LOCAL_TASK,
        'weight' => 2,
        'access' => user_access('administer filters'));
      }
245 246 247
    }
  }

Dries's avatar
 
Dries committed
248
  return $items;
249 250
}

Dries's avatar
Dries committed
251
/**
252
 * Implementation of hook_perm().
Dries's avatar
Dries committed
253
 */
254 255 256 257 258
function filter_perm() {
  return array('administer filters');
}

/**
259
 * Menu callback; allows administrators to set up input formats.
260 261 262 263 264 265 266 267 268 269 270 271
 */
function filter_admin_overview() {
  // Process form submission
  switch ($_POST['op']) {
    case t('Save input formats'):
      filter_admin_save();
      break;
    case t('Add input format'):
      filter_admin_add();
      break;
  }

272
  // Overview of all formats.
273 274 275 276
  $formats = filter_formats();
  $roles = user_roles();
  $error = false;

Dries's avatar
 
Dries committed
277
  $header = array(t('Name'), t('Default'));
278 279 280
  foreach ($roles as $name) {
    $header[] = $name;
  }
Dries's avatar
 
Dries committed
281
  $header[] = array('data' => t('Operations'), 'colspan' => 2);
282 283 284 285 286 287 288 289 290 291 292

  $rows = array();
  foreach ($formats as $id => $format) {
    $row = array();
    $default = ($id == variable_get('filter_default_format', 1));

    $row[] = form_textfield('', "name][$id", $format->name, 16, 255);
    $row[] = form_radio('', 'default', $id, $default);

    foreach ($roles as $rid => $name) {
      $checked = strstr($format->roles, ",$rid,");
293
      $row[] = form_checkbox('', "roles][$id][$rid", 1, $default || $checked, NULL, $default ? array('disabled' => 'disabled') : NULL);
294 295
    }

296
    $row[] = l(t('configure'), 'admin/filters/'. $id);
297 298 299 300 301 302 303 304 305
    $row[] = $default ? '' : l('delete', 'admin/filters/delete/'. $id);

    $rows[] = $row;
  }

  $group = theme('table', $header, $rows);
  $group .= form_submit(t('Save input formats'));
  $output = '<h2>'. t('Permissions and settings') . '</h2>' . form($group);

306
  // Form to add a new format.
307 308 309 310 311 312
  $group = t("<p>To add a new input format, type its name here. After it has been added, you can configure its options.</p>");
  $form = form_textfield(t('Name'), 'name', '', 40, 255);
  $form .= form_submit(t('Add input format'));
  $group .= form($form);
  $output .= '<h2>'. t('Add new input format') .'</h2>'. $group;

Dries's avatar
 
Dries committed
313
  return $output;
314 315 316
}

/**
317
 * Save input formats on the overview page.
318 319
 */
function filter_admin_save() {
Dries's avatar
Dries committed
320
  $edit = $_POST['edit'];
321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343

  variable_set('filter_default_format', $edit['default']);

  foreach ($edit['name'] as $id => $name) {
    $name = trim($name);

    if (strlen($name) == 0) {
      drupal_set_message(t('You must enter a name for this input format.'));
      drupal_goto('admin/filters');
    }
    else {
      db_query("UPDATE {filter_formats} SET name='%s' WHERE format = %d", $name, $id);
    }
  }

  // We store the roles as a string for ease of use.
  // We use leading and trailing comma's to allow easy substring matching.
  foreach ($edit['roles'] as $id => $format) {
    $roles = ',';
    foreach ($format as $rid => $value) {
      if ($value) {
        $roles .= $rid .',';
      }
Dries's avatar
 
Dries committed
344
    }
345 346 347 348 349 350 351 352
    db_query("UPDATE {filter_formats} SET roles = '%s' WHERE format = %d", $roles, $id);
  }

  drupal_set_message(t('The input format settings have been updated.'));
  drupal_goto('admin/filters');
}

/**
353
 * Add a new input format.
354 355 356 357 358 359 360 361 362 363 364 365 366 367
 */
function filter_admin_add() {
  $edit = $_POST['edit'];

  $name = trim($edit['name']);

  if (strlen($name) == 0) {
    drupal_set_message(t('You must enter a name for this input format.'));
    drupal_goto('admin/filters');
  }
  else {
    db_query("INSERT INTO {filter_formats} (name) VALUES ('%s')", $name);
  }

368
  drupal_set_message(t('Added input format %format.', array('%format' => theme('placeholder', $edit['name']))));
369 370 371 372
  drupal_goto('admin/filters');
}

/**
373
 * Menu callback; confirm deletion of a format.
374 375 376
 */
function filter_admin_delete() {
  $edit = $_POST['edit'];
377
  if ($edit['confirm']) {
378 379 380 381 382 383 384 385 386 387 388
    if ($edit['format'] != variable_get('filter_default_format', 1)) {
      db_query("DELETE FROM {filter_formats} WHERE format = %d", $edit['format']);
      db_query("DELETE FROM {filters} WHERE format = %d", $edit['format']);

      $default = variable_get('filter_default_format', 1);
      db_query("UPDATE {node} SET format = %d WHERE format = %d", $default, $edit['format']);
      db_query("UPDATE {comments} SET format = %d WHERE format = %d", $default, $edit['format']);
      db_query("UPDATE {boxes} SET format = %d WHERE format = %d", $default, $edit['format']);

      cache_clear_all('filter:'. $edit['format'], true);

389
      drupal_set_message(t('Deleted input format %format.', array('%format' => theme('placeholder', $edit['name']))));
390 391 392 393 394 395 396
    }
    drupal_goto('admin/filters');
  }

  $format = arg(3);
  $format = db_fetch_object(db_query('SELECT * FROM {filter_formats} WHERE format = %d', $format));

397 398 399
  $extra  = form_hidden('format', $format->format);
  $extra .= form_hidden('name', $format->name);
  $output = theme('confirm',
400
                  t('Are you sure you want to delete the input format %format?', array('%format' => theme('placeholder', $format->name))),
401 402 403 404 405
                  'admin/filters',
                  t('If you have any content left in this input format, it will be switched to the default input format. This action cannot be undone.'),
                  t('Delete'),
                  t('Cancel'),
                  $extra);
Dries's avatar
 
Dries committed
406
  return $output;
407 408 409
}

/**
410
 * Menu callback; configure the filters for a format.
411 412 413 414
 */
function filter_admin_filters() {
  $format = arg(2);

415
  // Handle saving of weights.
416 417 418 419 420 421 422
  if ($_POST['op']) {
    filter_admin_filters_save($format, $_POST['edit']);
  }

  $all = filter_list_all();
  $enabled = filter_list_format($format);

423
  // Table with filters
Dries's avatar
 
Dries committed
424
  $header = array(t('Enabled'), t('Name'), t('Description'));
425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
  $rows = array();
  foreach ($all as $id => $filter) {
    $row = array();
    $row[] = form_checkbox('', $id, 1, isset($enabled[$id]));
    $row[] = $filter->name;
    $row[] = module_invoke($filter->module, 'filter', 'description', $filter->delta);

    $rows[] = $row;
  }
  $form = theme('table', $header, $rows);
  if (!$empty) {
    $form .= form_submit(t('Save configuration'));
  }

  $output .= '<h2>'. t('Filters') .'</h2>'. form($form);

441
  // Composition tips (guidelines)
442 443
  $tips = _filter_tips($format, false);
  $extra = l(t('More information about formatting options'), 'filter/tips');
Dries's avatar
 
Dries committed
444
  $tiplist = theme('filter_tips', $tips, false, $extra);
445 446 447 448 449 450 451
  if (!$tiplist) {
    $tiplist = t('<p>No guidelines available.</p>');
  }
  $group = t('<p>These are the guidelines that users will see for posting in this input format. They are automatically generated from the filter settings.</p>');
  $group .= $tiplist;
  $output .= '<h2>'. t('Formatting guidelines') .'</h2>'. $group;

Dries's avatar
 
Dries committed
452
  return $output;
453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485
}

/**
 * Save enabled/disabled status for filters in a format.
 */
function filter_admin_filters_save($format, $toggles) {
  $current = filter_list_format($format);

  $cache = true;

  db_query("DELETE FROM {filters} WHERE format = %d", $format);
  foreach ($toggles as $id => $checked) {
    if ($checked) {
      list($module, $delta) = explode('/', $id);
      // Add new filters to the bottom
      $weight = isset($current[$id]->weight) ? $current[$id]->weight : 10;
      db_query("INSERT INTO {filters} (format, module, delta, weight) VALUES (%d, '%s', %d, %d)", $format, $module, $delta, $weight);

      // Check if there are any 'no cache' filters
      $cache &= !module_invoke($module, 'filter', 'no cache', $delta);
    }
  }

  // Update the format's 'no cache' flag.
  db_query('UPDATE {filter_formats} SET cache = %d WHERE format = %d', (int)$cache, $format);

  cache_clear_all('filter:'. $format, true);

  drupal_set_message(t('The input format has been updated.'));
  drupal_goto('admin/filters/'. arg(2) .'/list');
}

/**
486
 * Menu callback; display form for ordering filters for a format.
487 488 489 490 491
 */
function filter_admin_order() {
  $format = arg(2);
  if ($_POST['op']) {
    filter_admin_order_save($format, $_POST['edit']);
Dries's avatar
 
Dries committed
492 493 494
  }

  // Get list (with forced refresh)
495
  $filters = filter_list_format($format);
Dries's avatar
 
Dries committed
496

Dries's avatar
 
Dries committed
497
  $header = array(t('Name'), t('Weight'));
Dries's avatar
 
Dries committed
498 499
  $rows = array();

500 501
  foreach ($filters as $id => $filter) {
    $rows[] = array($filter->name, form_weight('', $id, $filter->weight));
Dries's avatar
 
Dries committed
502 503
  }

Dries's avatar
Dries committed
504 505
  $form  = theme('table', $header, $rows);
  $form .= form_submit(t('Save configuration'));
Dries's avatar
 
Dries committed
506 507
  $output = form($form);

Dries's avatar
 
Dries committed
508
  return $output;
Dries's avatar
 
Dries committed
509 510
}

Dries's avatar
Dries committed
511
/**
512 513 514 515 516
 * Save the weights of filters in a format.
 */
function filter_admin_order_save($format, $weights) {
  foreach ($weights as $id => $weight) {
    list($module, $delta) = explode('/', $id);
Dries's avatar
 
Dries committed
517
    db_query("UPDATE {filters} SET weight = %d WHERE format = %d AND module = '%s' AND delta = %d", $weight, $format, $module, $delta);
518 519 520 521 522 523 524 525 526
  }
  drupal_set_message(t('The filter weights have been saved.'));

  cache_clear_all('filter:'. $format, true);

  drupal_goto('admin/filters/'. arg(2) .'/order');
}

/**
527
 * Menu callback; display settings defined by filters.
Dries's avatar
Dries committed
528
 */
529 530 531
function filter_admin_configure() {
  $format = arg(2);

Dries's avatar
 
Dries committed
532 533
  system_settings_save();

534 535 536 537 538
  $list = filter_list_format($format);
  $form = "";
  foreach ($list as $filter) {
    $form .= module_invoke($filter->module, 'filter', 'settings', $filter->delta, $format);
  }
Dries's avatar
 
Dries committed
539

540 541 542 543 544 545
  if (trim($form) != '') {
    $output = system_settings_form($form);
  }
  else {
    $output = t('No settings are available.');
  }
Dries's avatar
 
Dries committed
546

Dries's avatar
 
Dries committed
547
  return $output;
548 549
}

Dries's avatar
Dries committed
550
/**
551
 * Retrieve a list of input formats.
Dries's avatar
Dries committed
552
 */
553 554 555 556 557 558 559 560 561 562
function filter_formats() {
  global $user;
  static $formats;

  // Administrators can always use all input formats.
  $all = user_access('administer filters');

  if (!isset($formats)) {
    $formats = array();

563
    $query = 'SELECT * FROM {filter_formats}';
564

565
    // Build query for selecting the format(s) based on the user's roles.
566 567 568 569
    if (!$all) {
      $where = array();
      foreach ($user->roles as $rid => $role) {
        $where[] = "roles LIKE '%%,%d,%%'";
570
        $args[] = $rid;
571
      }
572 573
      $query .= ' WHERE '. implode(' OR ', $where) . ' OR format = %d';
      $args[] = variable_get('filter_default_format', 1);
574 575
    }

576
    $result = db_query($query, $args);
577 578 579 580 581 582
    while ($format = db_fetch_object($result)) {
      $formats[$format->format] = $format;
    }
  }
  return $formats;
}
583

584 585 586 587 588 589 590 591 592 593 594 595
/**
 * Build a list of all filters.
 */
function filter_list_all() {
  $filters = array();

  foreach (module_list() as $module) {
    $list = module_invoke($module, 'filter', 'list');
    if (is_array($list)) {
      foreach ($list as $delta => $name) {
        $filters[$module .'/'. $delta] = (object)array('module' => $module, 'delta' => $delta, 'name' => $name);
      }
Dries's avatar
 
Dries committed
596 597 598
    }
  }

599 600 601 602 603 604 605 606 607 608
  uasort($filters, '_filter_list_cmp');

  return $filters;
}

/**
 * Helper function for sorting the filter list by filter name.
 */
function _filter_list_cmp($a, $b) {
  return strcmp($a->name, $b->name);
Dries's avatar
 
Dries committed
609 610
}

Dries's avatar
Dries committed
611
/**
612
 * Check if text in a certain input format is allowed to be cached.
Dries's avatar
Dries committed
613
 */
614 615
function filter_format_allowcache($format) {
  static $cache = array();
Dries's avatar
 
Dries committed
616

617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636
  if (!isset($cache[$format])) {
    $cache[$format] = db_result(db_query('SELECT cache FROM {filter_formats} WHERE format = %d', $format));
  }
  return $cache[$format];
}

/**
 * Retrieve a list of filters for a certain format.
 */
function filter_list_format($format) {
  static $filters = array();

  if (!is_array($filters[$format])) {
    $filters[$format] = array();
    $result = db_query("SELECT * FROM {filters} WHERE format = %d ORDER BY weight ASC", $format);
    while ($filter = db_fetch_object($result)) {
      $list = module_invoke($filter->module, 'filter', 'list');
      if (is_array($list) && isset($list[$filter->delta])) {
        $filter->name = $list[$filter->delta];
        $filters[$format][$filter->module .'/'. $filter->delta] = $filter;
Dries's avatar
 
Dries committed
637 638 639 640
      }
    }
  }

641
  return $filters[$format];
642 643
}

644 645
/**
 * @name Filtering functions
Dries's avatar
 
Dries committed
646
 * @{
647 648 649 650
 * Modules which need to have content filtered can use these functions to
 * interact with the filter system.
 */

Dries's avatar
Dries committed
651 652 653
/**
 * Run all the enabled filters on a piece of text.
 */
654
function check_output($text, $format = FILTER_FORMAT_DEFAULT) {
655
  if (isset($text)) {
656 657 658 659
    if ($format == FILTER_FORMAT_DEFAULT) {
      $format = variable_get('filter_default_format', 1);
    }

660
    // Check for a cached version of this piece of text.
661 662 663 664 665
    $id = 'filter:'. $format .':'. md5($text);
    if ($cached = cache_get($id)) {
      return $cached->data;
    }

666
    // See if caching is allowed for this format.
667
    $cache = filter_format_allowcache($format);
668 669

    // Convert all Windows and Mac newlines to a single newline,
670
    // so filters only need to deal with one possibility.
671 672
    $text = str_replace(array("\r\n", "\r"), "\n", $text);

673
    // Get a complete list of filters, ordered properly.
674
    $filters = filter_list_format($format);
Dries's avatar
 
Dries committed
675

Dries's avatar
Dries committed
676
    // Give filters the chance to escape HTML-like data such as code or formulas.
677 678
    foreach ($filters as $filter) {
      $text = module_invoke($filter->module, 'filter', 'prepare', $filter->delta, $format, $text);
Dries's avatar
 
Dries committed
679
    }
680

681
    // Perform filtering.
682 683
    foreach ($filters as $filter) {
      $text = module_invoke($filter->module, 'filter', 'process', $filter->delta, $format, $text);
684 685
    }

686
    // Store in cache with a minimum expiration time of 1 day.
687
    if ($cache) {
688
      cache_set($id, $text, time() + (60 * 60 * 24));
689 690 691 692 693 694 695 696 697
    }
  }
  else {
    $text = message_na();
  }

  return $text;
}

Dries's avatar
Dries committed
698
/**
699
 * Generate a selector for choosing a format in a form.
700 701
 *
 * @param $name
702
 *   The internal name used to refer to the form element.
703
 * @param $value
704
 *   The ID of the format that is currently selected.
705
 * @return
706
 *   HTML for the form element.
Dries's avatar
Dries committed
707
 */
708
function filter_form($name = 'format', $value = FILTER_FORMAT_DEFAULT) {
709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726
  if ($value == FILTER_FORMAT_DEFAULT) {
    $value = variable_get('filter_default_format', 1);
  }
  $formats = filter_formats();

  $extra = l(t('More information about formatting options'), 'filter/tips');

  if (count($formats) > 1) {
    // Multiple formats available: display radio buttons with tips.
    $output = '';
    foreach ($formats as $format) {
      $tips = _filter_tips($format->format, false);

      // TODO: get support for block-level radios so the <br /> is not output?
      $output .= '<div>';
      $output .= '<label class="option"><input type="radio" class="form-radio" name="edit['. $name .']" value="'. $format->format .'"'. ($format->format == $value ? ' checked="checked"' : '') .' /> '. $format->name .'</label>';
      $output .= theme('filter_tips', $tips);
      $output .= '</div>';
727
    }
Dries's avatar
 
Dries committed
728
    return theme('form_element', t('Input format'), $output, $extra, NULL, _form_get_error($name));
Dries's avatar
 
Dries committed
729
  }
730 731 732 733
  else {
    // Only one format available: use a hidden form item and only show tips.
    $format = array_shift($formats);
    $output = form_hidden($name, $format->format);
Dries's avatar
 
Dries committed
734
    $tips = _filter_tips(variable_get('filter_default_format', 1), false);
Dries's avatar
 
Dries committed
735
    $output .= form_item(t('Formatting guidelines'), theme('filter_tips', $tips, false, $extra), $extra);
736 737 738
    return $output;
  }
}
739

740 741 742 743
/**
 * Returns true if the user is allowed to access this format.
 */
function filter_access($format) {
744
  if (user_access('administer filters') || ($format == FILTER_FORMAT_DEFAULT) || ($format == variable_get('filter_default_format', 1))) {
745
    return true;
746
  }
747 748 749 750 751
  else {
    $formats = filter_formats();
    return isset($formats[$format]);
  }
}
Dries's avatar
 
Dries committed
752 753 754
/**
 * @} End of "Filtering functions".
 */
755

756
/**
757
 * Menu callback; show a page with long filter tips.
758 759 760 761
 */
function filter_tips_long() {
  $format = arg(2);
  if ($format) {
Dries's avatar
 
Dries committed
762
    $output = theme('filter_tips', _filter_tips($format, true), true);
763 764
  }
  else {
Dries's avatar
 
Dries committed
765
    $output = theme('filter_tips', _filter_tips(-1, true), true);
766
  }
Dries's avatar
 
Dries committed
767
  return $output;
768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794
}

/**
 * Helper function for fetching filter tips.
 */
function _filter_tips($format, $long = false) {
  if ($format == -1) {
    $formats = filter_formats();
  }
  else {
    $formats = array(db_fetch_object(db_query("SELECT * FROM {filter_formats} WHERE format = %d", $format)));
  }

  $tips = array();

  foreach ($formats as $format) {
    $filters = filter_list_format($format->format);

    $tips[$format->name] = array();
    foreach ($filters as $id => $filter) {
      if ($tip = module_invoke($filter->module, 'filter_tips', $filter->delta, $format->format, $long)) {
        $tips[$format->name][] = array('tip' => $tip, 'id' => $id);
      }
    }
  }

  return $tips;
795 796
}

Dries's avatar
Dries committed
797
/**
Dries's avatar
 
Dries committed
798
 * Format a set of filter tips.
799
 *
Dries's avatar
 
Dries committed
800
 * @ingroup themeable
801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819
 */
function theme_filter_tips($tips, $long = false, $extra = '') {
  $output = '';

  $multiple = count($tips) > 1;
  if ($multiple) {
    $output = t('Input formats') .':';
  }

  if (count($tips)) {
    if ($multiple) {
      $output .= '<ul>';
    }
    foreach ($tips as $name => $tiplist) {
      if ($multiple) {
        $output .= '<li>';
        $output .= '<strong>'. $name .'</strong>:<br />';
      }

Dries's avatar
 
Dries committed
820
      $tips = '';
821
      foreach ($tiplist as $tip) {
Dries's avatar
 
Dries committed
822
        $tips .= '<li'. ($long ? ' id="filter-'. str_replace("/", "-", $tip['id']) .'">' : '>') . $tip['tip'] . '</li>';
823 824
      }

Dries's avatar
 
Dries committed
825
      if ($tips) {
826
        $output .= "<ul class=\"tips\">$tips</ul>";
Dries's avatar
 
Dries committed
827
      }
Dries's avatar
 
Dries committed
828

829 830 831 832 833 834 835 836
      if ($multiple) {
        $output .= '</li>';
      }
    }
    if ($multiple) {
      $output .= '</ul>';
    }
  }
Dries's avatar
 
Dries committed
837 838 839 840

  return $output;
}

Dries's avatar
Dries committed
841
/**
842 843
 * @name Standard filters
 * @{
Dries's avatar
 
Dries committed
844
 * Filters implemented by the filter.module.
Dries's avatar
Dries committed
845
 */
846 847

/**
848 849 850 851 852 853 854
 * Implementation of hook_filter(). Contains a basic set of essential filters.
 * - HTML filter:
 *     Validates user-supplied HTML, transforming it as necessary.
 * - PHP evaluator:
 *     Executes PHP code.
 * - Line break converter:
 *     Converts newlines into paragraph and break tags.
855 856
 */
function filter_filter($op, $delta = 0, $format = -1, $text = '') {
Dries's avatar
 
Dries committed
857
  switch ($op) {
858
    case 'list':
859
      return array(0 => t('HTML filter'), 1 => t('PHP evaluator'), 2 => t('Line break converter'));
860 861

    case 'no cache':
862
      return $delta == 1; // No caching for the PHP evaluator.
863 864 865 866 867 868 869

    case 'description':
      switch ($delta) {
        case 0:
          return t('Allows you to restrict if users can post HTML and which tags to filter out.');
        case 1:
          return t('Runs a piece of PHP code. The usage of this filter should be restricted to administrators only!');
870
        case 2:
871 872 873 874 875
          return t('Converts line breaks into HTML (i.e. &lt;br&gt; and &lt;p&gt; tags).');
        default:
          return;
      }

Dries's avatar
Dries committed
876
    case 'process':
877 878 879 880 881
      switch ($delta) {
        case 0:
          return _filter_html($text, $format);
        case 1:
          return drupal_eval($text);
882
        case 2:
883
          return _filter_autop($text);
884 885
        default:
          return $text;
Dries's avatar
 
Dries committed
886
      }
887

Dries's avatar
Dries committed
888
    case 'settings':
889 890 891 892 893 894 895
      switch ($delta) {
        case 0:
          return _filter_html_settings($format);
        default:
          return;
      }

Dries's avatar
 
Dries committed
896 897 898 899 900
    default:
      return $text;
  }
}

901
/**
902
 * Settings for the HTML filter.
903 904 905
 */
function _filter_html_settings($format) {
  $group = form_radios(t('Filter HTML tags'), "filter_html_$format", variable_get("filter_html_$format", FILTER_HTML_STRIP), array(FILTER_HTML_STRIP => t('Strip tags'), FILTER_HTML_ESCAPE => t('Escape tags')), t('How to deal with HTML 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.'));
Dries's avatar
 
Dries committed
906
  $group .= form_textfield(t('Allowed HTML tags'), "allowed_html_$format", variable_get("allowed_html_$format", '<a> <em> <strong> <cite> <code> <ul> <ol> <li> <dl> <dt> <dd>'), 64, 255, t('If "Strip tags" is selected, optionally specify tags which should not be stripped. Javascript event attributes are always stripped.'));
907
  $group .= form_checkbox(t('Display HTML help'), "filter_html_help_$format", 1, variable_get("filter_html_help_$format", 1), t('If enabled, Drupal will display some basic HTML help in the long filter tips.'));
908
  $group .= form_radios(t('HTML style attributes'), "filter_style_$format", variable_get("filter_style_$format", FILTER_STYLE_STRIP), array(FILTER_STYLE_ALLOW => t('Allowed'), FILTER_STYLE_STRIP => t('Removed')), t('If "Strip tags" is selected, you can choose whether "STYLE" attributes are allowed or removed from input.'));
909
  $group .= form_checkbox(t('Spam link deterrent'), "filter_html_nofollow_$format", 1, variable_get("filter_html_nofollow_$format", FALSE), t('If enabled, Drupal will add rel="nofollow" to all links, as a measure to reduce the effectiveness of spam links. Note: this will also prevent valid links from being followed by search engines, therefore it is likely most effective when enabled for anonymous users.'));
910 911 912 913 914 915
  $output .= form_group(t('HTML filter'), $group);

  return $output;
}

/**
916
 * HTML filter. Provides filtering of input into accepted HTML.
917 918 919 920
 */
function _filter_html($text, $format) {
  if (variable_get("filter_html_$format", FILTER_HTML_STRIP) == FILTER_HTML_STRIP) {
    // Allow users to enter HTML, but filter it
Dries's avatar
 
Dries committed
921
    $text = strip_tags($text, variable_get("allowed_html_$format", '<a> <em> <strong> <cite> <code> <ul> <ol> <li> <dl> <dt> <dd>'));
922 923 924 925 926 927 928 929
    if (variable_get("filter_style_$format", FILTER_STYLE_STRIP)) {
      $text = preg_replace('/\Wstyle\s*=[^>]+?>/i', '>', $text);
    }
    $text = preg_replace('/\Won[a-z]+\s*=[^>]+?>/i', '>', $text);
  }

  if (variable_get("filter_html_$format", FILTER_HTML_STRIP) == FILTER_HTML_ESCAPE) {
    // Escape HTML
930
    $text = check_plain($text);
931 932
  }

933 934
  if (variable_get("filter_html_nofollow_$format", FALSE)) {
    $text = preg_replace('/<a([^>]+)>/i', '<a\\1 rel="nofollow">', $text);
Dries's avatar
 
Dries committed
935 936
  }

937 938 939
  return trim($text);
}

Dries's avatar
Dries committed
940
/**
941
 * Convert line breaks into <p> and <br> in an intelligent fashion.
942
 * Based on: http://photomatt.net/scripts/autop
Dries's avatar
Dries committed
943
 */
944
function _filter_autop($text) {
945 946 947 948 949
  // Split at <pre>, <script> and </pre>, </script> tags.
  // We don't apply any processing to the contents of these tags to avoid messing
  // up code. We look for matched pairs and allow basic nesting. For example:
  // "processed <pre> ignored <script> ignored </script> ignored </pre> processed"
  $chunks = preg_split('@(</?(?:pre|script)[^>]*>)@', $text, -1, PREG_SPLIT_DELIM_CAPTURE);
950 951
  // Note: PHP ensures the array consists of alternating delimiters and literals
  // and begins and ends with a literal (inserting NULL as required).
952 953
  $ignore = false;
  $ignoretag = '';
954 955 956
  $output = '';
  foreach ($chunks as $i => $chunk) {
    if ($i % 2) {
957 958
      // Opening or closing tag?
      $open = ($chunk{1} != '/');
959
      list($tag) = split('[ >]', substr($chunk, 2 - $open), 2);
960 961 962 963 964 965 966 967 968 969 970
      if (!$ignore) {
        if ($open) {
          $ignore = true;
          $ignoretag = $tag;
        }
      }
      // Only allow a matching tag to close it.
      else if (!$open && $ignoretag == $tag) {
        $ignore = false;
        $ignoretag = '';
      }
971
    }
972
    else if (!$ignore) {
973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992
      $chunk = preg_replace('|\n*$|', '', $chunk) ."\n\n"; // just to make things a little easier, pad the end
      $chunk = preg_replace('|<br />\s*<br />|', "\n\n", $chunk);
      $chunk = preg_replace('!(<(?:table|ul|ol|li|pre|form|blockquote|h[1-6])[^>]*>)!', "\n$1", $chunk); // Space things out a little
      $chunk = preg_replace('!(</(?:table|ul|ol|li|pre|form|blockquote|h[1-6])>)!', "$1\n", $chunk); // Space things out a little
      $chunk = preg_replace("/\n\n+/", "\n\n", $chunk); // take care of duplicates
      $chunk = preg_replace('/\n?(.+?)(?:\n\s*\n|\z)/s', "<p>$1</p>\n", $chunk); // make paragraphs, including one at the end
      $chunk = preg_replace('|<p>\s*?</p>|', '', $chunk); // under certain strange conditions it could create a P of entirely whitespace
      $chunk = preg_replace("|<p>(<li.+?)</p>|", "$1", $chunk); // problem with nested lists
      $chunk = preg_replace('|<p><blockquote([^>]*)>|i', "<blockquote$1><p>", $chunk);
      $chunk = str_replace('</blockquote></p>', '</p></blockquote>', $chunk);
      $chunk = preg_replace('!<p>\s*(</?(?:table|tr|td|th|div|ul|ol|li|pre|select|form|blockquote|p|h[1-6])[^>]*>)!', "$1", $chunk);
      $chunk = preg_replace('!(</?(?:table|tr|td|th|div|ul|ol|li|pre|select|form|blockquote|p|h[1-6])[^>]*>)\s*</p>!', "$1", $chunk);
      $chunk = preg_replace('|(?<!<br />)\s*\n|', "<br />\n", $chunk); // make line breaks
      $chunk = preg_replace('!(</?(?:table|tr|td|th|div|dl|dd|dt|ul|ol|li|pre|select|form|blockquote|p|h[1-6])[^>]*>)\s*<br />!', "$1", $chunk);
      $chunk = preg_replace('!<br />(\s*</?(?:p|li|div|th|pre|td|ul|ol)>)!', '$1', $chunk);
      $chunk = preg_replace('/&([^#])(?![a-z]{1,8};)/', '&#038;$1', $chunk);
    }
    $output .= $chunk;
  }
  return $output;
Dries's avatar
 
Dries committed
993 994
}

Dries's avatar
 
Dries committed
995 996 997
/**
 * @} End of "Standard filters".
 */
998

999
?>