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

Dries Buytaert's avatar
   
Dries Buytaert 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
define('FILTER_HTML_STRIP', 1);
define('FILTER_HTML_ESCAPE', 2);

17
18
19
20
/**
 * Implementation of hook_help().
 */
function filter_help($section) {
21
  switch ($section) {
22
    case 'admin/help#filter':
23
24
      $output = '<p>'. t('The filter module allows administrators to configure  text input formats for the site. For example, an administrator may want a filter to strip out malicious HTML from user\'s comments. Administrators may also want to make URLs linkable even if they are only entered in an unlinked format.') .'</p>';
      $output .= '<p>'. t('Users can choose between the available input formats when creating or editing content. Administrators can configure which input formats are available to which user roles, as well as choose a default input format. Administrators can also create new input formats. Each input format can be configured to use a selection of filters.') .'</p>';
25
26
27
28
29
      $output .= t('<p>You can</p>
<ul>
<li>administer input format permissions and settings  at <a href="%admin-filters">administer &gt;&gt; input formats</a>.</li>
<li>configure the filters for each input format at <a href="%admin-filters">administer &gt;&gt; input formats &gt;&gt; configure</a>.</li>
</ul>
30
', array('%admin-filters' => url('admin/settings/filters')));
31
      $output .= '<p>'. t('For more information please read the configuration and customization handbook <a href="%filter">Filter page</a>.', array('%filter' => 'http://drupal.org/handbook/modules/filter/')) .'</p>';
32
      return $output;
33
    case 'admin/settings/modules#description':
34
      return t('Handles the filtering of content in preparation for display.');
35

36
    case 'admin/settings/filters':
37
      return t('
Dries Buytaert's avatar
   
Dries Buytaert committed
38
<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>
39
<p>Users can choose between the available input formats when submitting content.</p>
40
41
<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>
<p>Note that (1) the default format is always available to all roles, and (2) all filter formats can always be used by roles with the "administer filters" permission even if they are not explicitly listed in the Roles column of this table.</p>');
42

43
    case 'admin/settings/filters/'. arg(3):
44
      return t('
Dries Buytaert's avatar
   
Dries Buytaert committed
45
<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>
46
<p>If you notice some filters are causing conflicts in the output, you can <a href="%rearrange">rearrange them</a>.</p>', array('%rearrange' => url('admin/settings/filters/'. arg(3) .'/order')));
47

48
    case 'admin/settings/filters/'. arg(3) .'/configure':
49
      return t('
50
<p>If you cannot find the settings for a certain filter, make sure you\'ve enabled it on the <a href="%url">view tab</a> first.</p>', array('%url' => url('admin/settings/filters/'. arg(3))));
51

52
    case 'admin/settings/filters/'. arg(3) .'/order':
53
      return t('
Dries Buytaert's avatar
   
Dries Buytaert committed
54
<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>
55
56
57
58
<p>Filters are executed from top-to-bottom. You can use the weight column to rearrange them: heavier filters \'sink\' to the bottom.</p>');
  }
}

59
60
61
62
63
64
65
/**
 * Implementation of hook_menu().
 */
function filter_menu($may_cache) {
  $items = array();

  if ($may_cache) {
66
    $items[] = array('path' => 'admin/settings/filters',
67
      'title' => t('input formats'),
68
      'description' => t('Configure how content input by users is filtering, including allowed HTML tags, PHP code tags. Also allows enabling of module-provided filters.'),
69
70
71
      'callback' => 'filter_admin_overview',
      'access' => user_access('administer filters'),
    );
72
    $items[] = array('path' => 'admin/settings/filters/list',
73
74
75
76
77
      'title' => t('list'),
      'callback' => 'filter_admin_overview',
      'type' => MENU_DEFAULT_LOCAL_TASK,
      'access' => user_access('administer filters'),
    );
78
    $items[] = array('path' => 'admin/settings/filters/add',
79
80
81
82
83
84
      'title' => t('add input format'),
      'callback' => 'filter_admin_format_form',
      'type' => MENU_LOCAL_TASK,
      'weight' => 1,
      'access' => user_access('administer filters'),
    );
85
    $items[] = array('path' => 'admin/settings/filters/delete',
86
87
88
89
90
91
92
93
94
95
96
97
98
      'title' => t('delete input format'),
      'callback' => 'filter_admin_delete',
      'type' => MENU_CALLBACK,
      'access' => user_access('administer filters'),
    );
    $items[] = array('path' => 'filter/tips',
      'title' => t('compose tips'),
      'callback' => 'filter_tips_long',
      'access' => TRUE,
      'type' => MENU_SUGGESTED_ITEM,
    );
  }
  else {
99
    if (arg(0) == 'admin' && arg(1) == 'settings' && arg(2) == 'filters' && is_numeric(arg(3))) {
100
101
      $formats = filter_formats();

102
103
104
      if (isset($formats[arg(3)])) {
        $items[] = array('path' => 'admin/settings/filters/'. arg(3),
          'title' => t("'%format' input format", array('%format' => $formats[arg(3)]->name)),
105
          'callback' => 'filter_admin_format_form',
106
          'callback arguments' => array('format' => $formats[arg(3)]),
107
108
109
          'type' => MENU_CALLBACK,
          'access' => user_access('administer filters'),
        );
110
        $items[] = array('path' => 'admin/settings/filters/'. arg(3) .'/list',
111
112
          'title' => t('view'),
          'callback' => 'filter_admin_format_form',
113
          'callback arguments' => array('format' => $formats[arg(3)]),
114
115
116
117
          'type' => MENU_DEFAULT_LOCAL_TASK,
          'weight' => 0,
          'access' => user_access('administer filters'),
        );
118
        $items[] = array('path' => 'admin/settings/filters/'. arg(3) .'/configure',
119
120
121
122
123
124
          'title' => t('configure'),
          'callback' => 'filter_admin_configure',
          'type' => MENU_LOCAL_TASK,
          'weight' => 1,
          'access' => user_access('administer filters'),
        );
125
        $items[] = array('path' => 'admin/settings/filters/'. arg(3) .'/order',
126
127
          'title' => t('rearrange'),
          'callback' => 'filter_admin_order',
128
          'callback arguments' => array('format' => $formats[arg(3)]),
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
          'type' => MENU_LOCAL_TASK,
          'weight' => 2,
          'access' => user_access('administer filters'),
        );
      }
    }
  }

  return $items;
}

/**
 * Implementation of hook_perm().
 */
function filter_perm() {
  return array('administer filters');
}

147
/**
148
 * Implementation of hook_filter_tips().
149
 */
150
function filter_filter_tips($delta, $format, $long = FALSE) {
151
  global $base_url;
152
153
  switch ($delta) {
    case 0:
154
155
156
157
158
159
160
161
162
163
      if (variable_get("filter_html_$format", FILTER_HTML_STRIP) ==  FILTER_HTML_STRIP) {
        if ($allowed_html = variable_get("allowed_html_$format", '<a> <em> <strong> <cite> <code> <ul> <ol> <li> <dl> <dt> <dd>')) {
          switch ($long) {
            case 0:
              return t('Allowed HTML tags') .': '. check_plain($allowed_html);
            case 1:
              $output = '<p>'. t('Allowed HTML tags') .': '. check_plain($allowed_html) .'</p>';
              if (!variable_get("filter_html_help_$format", 1)) {
                return $output;
              }
164

165
              $output .= t('
166
<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>
167
<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>');
168
169
170
171
172
173
174
175
176
177
178
179
180
181
              $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>'),
182
183
                'abbr' => array( t('Abbreviation'), t('<abbr title="Abbreviation">Abbrev.</abbr>')),
                'acronym' => array( t('Acronym'), t('<acronym title="Three-Letter Acronym">TLA</acronym>')),
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
                '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]) {
210
                    $rows[] = array(
211
212
213
                      array('data' => $tips[$tag][0], 'class' => 'description'),
                      array('data' => '<code>'. check_plain($tips[$tag][1]) .'</code>', 'class' => 'type'),
                      array('data' => $tips[$tag][1], 'class' => 'get')
214
215
216
                    );
                  }
                }
217
218
219
220
221
222
223
                else {
                  $rows[] = array(
                    array('data' => t('No help provided for tag %tag.', array('%tag' => check_plain($tag))), 'class' => 'description', 'colspan' => 3),
                  );
                }
              }
              $output .= theme('table', $header, $rows);
224

225
              $output .= t('
226
<p>Most unusual characters can be directly entered without any problems.</p>
227
<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>');
228
229
230
231
232
233
234
235
236
237
238
239
240
              $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'),
                  array('data' => '<code>'. check_plain($entity[1]) .'</code>', 'class' => 'type'),
                  array('data' => $entity[1], 'class' => 'get')
241
                );
242
243
244
              }
              $output .= theme('table', $header, $rows);
              return $output;
Dries Buytaert's avatar
   
Dries Buytaert committed
245
          }
246
247
        }
        else {
248
          return t('No HTML tags allowed');
249
        }
Dries Buytaert's avatar
   
Dries Buytaert committed
250
251
      }
      break;
252
253

    case 1:
Dries Buytaert's avatar
   
Dries Buytaert committed
254
      switch ($long) {
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
        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>');
      }

281
    case 2:
282
283
284
285
286
287
      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.');
      }
288
289
290
  }
}

291
/**
292
 * Displays a list of all input formats and which one is the default
293
294
 */
function filter_admin_overview() {
295

296
  // Overview of all formats.
297
  $formats = filter_formats();
298
  $error = FALSE;
299
300
301

  $rows = array();
  foreach ($formats as $id => $format) {
302
303
    $roles = array();
    foreach (user_roles() as $rid => $name) {
304
      // Prepare a roles array with roles that may access the filter
305
      if (strstr($format->roles, ",$rid,")) {
306
307
308
        $roles[] = $name;
      }
    }
309
310
    $row = array();
    $default = ($id == variable_get('filter_default_format', 1));
311
    $options[$id] = '';
312
313
    $form[$format->name]['id'] = array('#value' => $id);
    $form[$format->name]['roles'] = array('#value' => $default ? t('All roles may use default format') : ($roles ? implode(', ',$roles) : t('No roles may use this format')));
314
315
    $form[$format->name]['configure'] = array('#value' => l(t('configure'), 'admin/settings/filters/'. $id));
    $form[$format->name]['delete'] = array('#value' => $default ? '' : l(t('delete'), 'admin/settings/filters/delete/'. $id));
316
  }
317
318
  $form['default'] = array('#type' => 'radios', '#options' => $options, '#default_value' => variable_get('filter_default_format', 1));
  $form['submit'] = array('#type' => 'submit', '#value' => t('Set default format'));
319
320
  return drupal_get_form('filter_admin_overview', $form);
}
321

322
323
324
325
326
327
328
329
function filter_admin_overview_submit($form_id, $form_values) {
  // Process form submission to set the default format
  if (is_numeric($form_values['default'])) {
    drupal_set_message(t('Default format updated.'));
    variable_set('filter_default_format', $form_values['default']);
  }
}

330
331
332
333
function theme_filter_admin_overview($form) {
  foreach ($form as $name => $element) {
    if (isset($element['roles']) && is_array($element['roles'])) {
      $rows[] = array(
334
        form_render($form['default'][$element['id']['#value']]),
335
        check_plain($name),
336
337
338
339
340
341
342
343
344
345
        form_render($element['roles']),
        form_render($element['configure']),
        form_render($element['delete'])
      );
      unset($form[$name]);
    }
  }
  $header = array(t('Default'), t('Name'), t('Roles'), array('data' => t('Operations'), 'colspan' => 2));
  $output = theme('table', $header, $rows);
  $output .= form_render($form);
346

Dries Buytaert's avatar
   
Dries Buytaert committed
347
  return $output;
348
349
350
}

/**
351
 * Menu callback; confirm deletion of a format.
352
353
 */
function filter_admin_delete() {
354
  $format = arg(4);
355
356
  $format = db_fetch_object(db_query('SELECT * FROM {filter_formats} WHERE format = %d', $format));

357
358
359
360
  if ($format) {
    if ($format->format != variable_get('filter_default_format', 1)) {
      $form['format'] = array('#type' => 'hidden', '#value' => $format->format);
      $form['name'] = array('#type' => 'hidden', '#value' => $format->name);
361

362
      return confirm_form('filter_admin_delete', $form, t('Are you sure you want to delete the input format %format?', array('%format' => theme('placeholder', $format->name))), 'admin/settings/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'));
363
364
    }
    else {
365
      drupal_set_message(t('The default format cannot be deleted.'));
366
      drupal_goto('admin/settings/filters');
367
368
369
370
371
    }
  }
  else {
    drupal_not_found();
  }
372
373
374
}

/**
375
 * Process filter delete form submission.
376
 */
377
378
379
function filter_admin_delete_submit($form_id, $form_values) {
  db_query("DELETE FROM {filter_formats} WHERE format = %d", $form_values['format']);
  db_query("DELETE FROM {filters} WHERE format = %d", $form_values['format']);
380

381
382
383
384
385
  $default = variable_get('filter_default_format', 1);
  // Replace existing instances of the deleted format with the default format.
  db_query("UPDATE {node_revisions} SET format = %d WHERE format = %d", $default, $form_values['format']);
  db_query("UPDATE {comments} SET format = %d WHERE format = %d", $default, $form_values['format']);
  db_query("UPDATE {boxes} SET format = %d WHERE format = %d", $default, $form_values['format']);
386

387
  cache_clear_all('filter:'. $form_values['format'], TRUE);
388
  drupal_set_message(t('Deleted input format %format.', array('%format' => theme('placeholder', $form_values['name']))));
389

390
  return 'admin/settings/filters';
391
392
}

393
/**
394
 * Generate a filter format form.
395
 */
396
function filter_admin_format_form($format = NULL) {
397
  $default = ($format->format == variable_get('filter_default_format', 1));
398
399
  if ($default) {
    $help = t('All roles for the default format must be enabled and cannot be changed.');
400
    $form['default_format'] = array('#type' => 'hidden', '#value' => 1);
401
  }
402

403
404
405
406
407
408
409
410
411
412
413
414
415
  $form['name'] = array('#type' => 'textfield',
    '#title' => 'Name',
    '#default_value' => $format->name,
    '#description' => t('Specify a unique name for this filter format.'),
    '#required' => TRUE,
  );

  // Add a row of checkboxes for form group.
  $form['roles'] = array('#type' => 'fieldset',
    '#title' => t('Roles'),
    '#description' => $default ? $help : t('Choose which roles may use this filter format. Note that roles with the "administer filters" permission can always use all the filter formats.'),
    '#tree' => TRUE,
  );
416
417
418

  foreach (user_roles() as $rid => $name) {
    $checked = strstr($format->roles, ",$rid,");
419
420
421
422
    $form['roles'][$rid] = array('#type' => 'checkbox',
      '#title' => $name,
      '#default_value' => ($default || $checked),
    );
423
    if ($default) {
424
      $form['roles'][$rid]['#attributes'] = array('disabled' => 'disabled');
425
    }
426
427
428
429
430
  }
  // Table with filters
  $all = filter_list_all();
  $enabled = filter_list_format($format->format);

431
432
433
434
435
  $form['filters'] = array('#type' => 'fieldset',
    '#title' => t('Filters'),
    '#description' => t('Choose the filters that will be used in this filter format.'),
    '#tree' => TRUE,
  );
436
  foreach ($all as $id => $filter) {
437
438
439
440
441
    $form['filters'][$id] = array('#type' => 'checkbox',
      '#title' => $filter->name,
      '#default_value' => isset($enabled[$id]),
      '#description' => module_invoke($filter->module, 'filter', 'description', $filter->delta),
    );
442
  }
443
  $form['submit'] = array('#type' => 'submit', '#value' => t('Save configuration'));
444

445
446
447
448
  if (isset($format)) {
    $form['format'] = array('#type' => 'hidden', '#value' => $format->format);

    // Composition tips (guidelines)
449
    $tips = _filter_tips($format->format, FALSE);
450
    $extra = l(t('More information about formatting options'), 'filter/tips');
451
    $tiplist = theme('filter_tips', $tips, FALSE, $extra);
452
453
454
455
456
457
458
459
460
461
    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;
  }
  $output = drupal_get_form('filter_admin_format_form', $form) . $output;

  return $output;
462
463
}

464
/**
465
 * Validate filter format form submissions.
466
 */
467
468
469
470
471
472
473
function filter_admin_format_form_validate($form_id, $form_values) {
  if (!isset($form_values['format'])) {
    $name = trim($form_values['name']);
    $result = db_fetch_object(db_query("SELECT format FROM {filter_formats} WHERE name='%s'", $name));
    if ($result) {
      form_set_error('name', t('Filter format names need to be unique. A format named %name already exists.', array('%name' => theme('placeholder', $name))));
    }
474
  }
475
}
476

477
478
479
480
481
482
483
484
485
486
487
488
/**
 * Process filter format form submissions.
 */
function filter_admin_format_form_submit($form_id, $form_values) {
  $format = isset($form_values['format']) ? $form_values['format'] : NULL;
  $current = filter_list_format($format);
  $name = trim($form_values['name']);
  $cache = TRUE;

  // Add a new filter format.
  if (!$format) {
    $new = TRUE;
489
490
491
    db_query("INSERT INTO {filter_formats} (name) VALUES ('%s')", $name);
    $result = db_fetch_object(db_query("SELECT MAX(format) AS format FROM {filter_formats}"));
    $format = $result->format;
492
    drupal_set_message(t('Added input format %format.', array('%format' => theme('placeholder', $name))));
493
494
495
496
497
  }
  else {
    drupal_set_message(t('The input format settings have been updated.'));
  }

498
  db_query("DELETE FROM {filters} WHERE format = %d", $format);
499
  foreach ($form_values['filters'] as $id => $checked) {
500
501
    if ($checked) {
      list($module, $delta) = explode('/', $id);
502
      // Add new filters to the bottom.
503
504
505
      $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);

506
      // Check if there are any 'no cache' filters.
507
508
509
510
      $cache &= !module_invoke($module, 'filter', 'no cache', $delta);
    }
  }

511
  // We store the roles as a string for ease of use.
512
  // We should always set all roles to TRUE when saving a default role.
513
  // We use leading and trailing comma's to allow easy substring matching.
514
515
516
517
518
519
520
521
522
  $roles = array();
  if (isset($form_values['roles'])) {
    foreach ($form_values['roles'] as $id => $checked) {
      if ($checked) {
        $roles[] = $id;
      }
    }
  }
  $roles = ','. implode(',', ($form_values['default_format'] ? user_roles() : $roles)) .',';
523
524

  db_query("UPDATE {filter_formats} SET cache = %d, name='%s', roles = '%s' WHERE format = %d", $cache, $name, $roles, $format);
525

526
  cache_clear_all('filter:'. $format, TRUE);
527

528
  // If a new filter was added, return to the main list of filters. Otherwise, stay on edit filter page to show new changes.
529
  if ($new) {
530
    return 'admin/settings/filters/';
531
532
  }
  else {
533
    return 'admin/settings/filters/'. $format;
534
  }
535
536
537
}

/**
538
 * Menu callback; display form for ordering filters for a format.
539
 */
540
function filter_admin_order($format = NULL) {
Dries Buytaert's avatar
   
Dries Buytaert committed
541
  // Get list (with forced refresh)
542
  $filters = filter_list_format($format->format);
Dries Buytaert's avatar
   
Dries Buytaert committed
543

544
  $form['weights'] = array('#tree' => TRUE);
545
  foreach ($filters as $id => $filter) {
546
547
    $form['names'][$id] = array('#value' => $filter->name);
    $form['weights'][$id] = array('#type' => 'weight', '#default_value' => $filter->weight);
Dries Buytaert's avatar
   
Dries Buytaert committed
548
  }
549
  $form['format'] = array('#type' => 'hidden', '#value' => $format->format);
550
  $form['submit'] = array('#type' => 'submit', '#value' => t('Save configuration'));
Dries Buytaert's avatar
   
Dries Buytaert committed
551

552
553
  return drupal_get_form('filter_admin_order', $form);
}
Dries Buytaert's avatar
   
Dries Buytaert committed
554

555
556
557
/**
 * Theme filter order configuration form.
 */
558
559
560
function theme_filter_admin_order($form) {
  $header = array(t('Name'), t('Weight'));
  $rows = array();
561
  foreach (element_children($form['names']) as $id) {
562
    // Don't take form control structures
563
564
    if (is_array($form['names'][$id])) {
      $rows[] = array(form_render($form['names'][$id]), form_render($form['weights'][$id]));
565
566
567
568
569
    }
  }

  $output = theme('table', $header, $rows);
  $output .= form_render($form);
570

Dries Buytaert's avatar
   
Dries Buytaert committed
571
  return $output;
Dries Buytaert's avatar
   
Dries Buytaert committed
572
573
}

574
/**
575
 * Process filter order configuration form submission.
576
 */
577
578
function filter_admin_order_submit($form_id, $form_values) {
  foreach ($form_values['weights'] as $id => $weight) {
579
    list($module, $delta) = explode('/', $id);
580
    db_query("UPDATE {filters} SET weight = %d WHERE format = %d AND module = '%s' AND delta = %d", $weight, $form_values['format'], $module, $delta);
581
  }
582
  drupal_set_message(t('The filter ordering has been saved.'));
583

584
  cache_clear_all('filter:'. $form_values['format'], TRUE);
585
586
587
}

/**
588
 * Menu callback; display settings defined by filters.
589
 */
590
function filter_admin_configure() {
591
  $format = arg(3);
592
593

  $list = filter_list_format($format);
594
  $form = array();
595
  foreach ($list as $filter) {
596
    $form_module = module_invoke($filter->module, 'filter', 'settings', $filter->delta, $format);
597
    if (isset($form_module) && is_array($form_module)) {
598
599
      $form = array_merge($form, $form_module);
    }
600
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
601

602
603
  if (!empty($form)) {
    $output = system_settings_form('filter_admin_configure', $form);
604
605
606
607
  }
  else {
    $output = t('No settings are available.');
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
608

Dries Buytaert's avatar
   
Dries Buytaert committed
609
  return $output;
610
611
}

612
/**
613
 * Retrieve a list of input formats.
614
 */
615
616
617
618
619
620
621
622
623
624
function filter_formats() {
  global $user;
  static $formats;

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

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

625
    $query = 'SELECT * FROM {filter_formats}';
626

627
    // Build query for selecting the format(s) based on the user's roles.
628
    $args = array();
629
630
631
632
    if (!$all) {
      $where = array();
      foreach ($user->roles as $rid => $role) {
        $where[] = "roles LIKE '%%,%d,%%'";
633
        $args[] = $rid;
634
      }
635
636
      $query .= ' WHERE '. implode(' OR ', $where) . ' OR format = %d';
      $args[] = variable_get('filter_default_format', 1);
637
638
    }

639
    $result = db_query($query, $args);
640
641
642
643
644
645
    while ($format = db_fetch_object($result)) {
      $formats[$format->format] = $format;
    }
  }
  return $formats;
}
646

647
648
649
650
651
652
653
654
/**
 * Build a list of all filters.
 */
function filter_list_all() {
  $filters = array();

  foreach (module_list() as $module) {
    $list = module_invoke($module, 'filter', 'list');
655
    if (isset($list) && is_array($list)) {
656
657
658
      foreach ($list as $delta => $name) {
        $filters[$module .'/'. $delta] = (object)array('module' => $module, 'delta' => $delta, 'name' => $name);
      }
Dries Buytaert's avatar
   
Dries Buytaert committed
659
660
661
    }
  }

662
663
664
665
666
667
668
669
670
671
  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 Buytaert's avatar
   
Dries Buytaert committed
672
673
}

674
675
676
677
678
679
/**
 * Resolve a format id, including the default format.
 */
function filter_resolve_format($format) {
  return $format == FILTER_FORMAT_DEFAULT ? variable_get('filter_default_format', 1) : $format;
}
680
/**
681
 * Check if text in a certain input format is allowed to be cached.
682
 */
683
684
function filter_format_allowcache($format) {
  static $cache = array();
685
  $format = filter_resolve_format($format);
686
687
688
689
690
691
692
693
694
695
696
697
  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();

698
  if (!isset($filters[$format])) {
699
700
701
702
    $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');
703
      if (isset($list) && is_array($list) && isset($list[$filter->delta])) {
704
705
        $filter->name = $list[$filter->delta];
        $filters[$format][$filter->module .'/'. $filter->delta] = $filter;
Dries Buytaert's avatar
   
Dries Buytaert committed
706
707
708
709
      }
    }
  }

710
  return $filters[$format];
711
712
}

713
714
/**
 * @name Filtering functions
Dries Buytaert's avatar
   
Dries Buytaert committed
715
 * @{
716
717
 * Modules which need to have content filtered can use these functions to
 * interact with the filter system.
718
719
720
721
722
723
724
725
 *
 * For more info, see the hook_filter() documentation.
 *
 * Note: because filters can inject JavaScript or execute PHP code, security is
 * vital here. When a user supplies a $format, you should validate it with
 * filter_access($format) before accepting/using it. This is normally done in
 * the validation stage of the node system. You should for example never make a
 * preview of content in a disallowed format.
726
727
 */

728
729
/**
 * Run all the enabled filters on a piece of text.
730
731
732
733
734
735
736
737
738
 *
 * @param $text
 *    The text to be filtered.
 * @param $format
 *    The format of the text to be filtered. Specify FILTER_FORMAT_DEFAULT for
 *    the default format.
 * @param $check
 *    Whether to check the $format with filter_access() first. Defaults to TRUE.
 *    Note that this will check the permissions of the current user, so you
739
 *    should specify $check = FALSE when viewing other people's content. When
740
741
 *    showing content that is not (yet) stored in the database (eg. upon preview),
 *    set to TRUE so the user's permissions are checked.
742
 */
743
function check_markup($text, $format = FILTER_FORMAT_DEFAULT, $check = TRUE) {
744
  // When $check = TRUE, do an access check on $format.
745
  if (isset($text) && (!$check || filter_access($format))) {
746
    $format = filter_resolve_format($format);
747

748
    // Check for a cached version of this piece of text.
749
750
751
752
753
    $id = 'filter:'. $format .':'. md5($text);
    if ($cached = cache_get($id)) {
      return $cached->data;
    }

754
    // See if caching is allowed for this format.
755
    $cache = filter_format_allowcache($format);
756
757

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

761
    // Get a complete list of filters, ordered properly.
762
    $filters = filter_list_format($format);
Dries Buytaert's avatar
   
Dries Buytaert committed
763

764
    // Give filters the chance to escape HTML-like data such as code or formulas.
765
766
    foreach ($filters as $filter) {
      $text = module_invoke($filter->module, 'filter', 'prepare', $filter->delta, $format, $text);
Dries Buytaert's avatar
   
Dries Buytaert committed
767
    }
768

769
    // Perform filtering.
770
771
    foreach ($filters as $filter) {
      $text = module_invoke($filter->module, 'filter', 'process', $filter->delta, $format, $text);
772
773
    }

774
    // Store in cache with a minimum expiration time of 1 day.
Dries Buytaert's avatar
Dries Buytaert committed
775
776
777
778
779
    if ($cache) {
      cache_set($id, $text, time() + (60 * 60 * 24));
    }
  }
  else {
780
    $text = t('n/a');
Dries Buytaert's avatar
Dries Buytaert committed
781
782
783
784
785
786
787
788
789
790
  }

  return $text;
}

/**
 * Generate a selector for choosing a format in a form.
 *
 * @param $value
 *   The ID of the format that is currently selected.
791
792
793
794
 * @param $weight
 *   The weight of the input format.
 * @param $parents
 *   Required when defining multiple input formats on a single node or having a different parent than 'format'.
Dries Buytaert's avatar
Dries Buytaert committed
795
796
797
 * @return
 *   HTML for the form element.
 */
798
function filter_form($value = FILTER_FORMAT_DEFAULT, $weight = NULL, $parents = array('format')) {
Steven Wittens's avatar
Oopsie    
Steven Wittens committed
799
  $value = filter_resolve_format($value);
Dries Buytaert's avatar
Dries Buytaert committed
800
801
802
803
804
  $formats = filter_formats();

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

  if (count($formats) > 1) {
805
    $form = array(
806
807
808
809
810
      '#type' => 'fieldset',
      '#title' => t('Input format'),
      '#collapsible' => TRUE,
      '#collapsed' => TRUE,
      '#weight' => $weight,
811
      '#validate' => array('filter_form_validate' => array()),
812
    );
Dries Buytaert's avatar
Dries Buytaert committed
813
814
    // Multiple formats available: display radio buttons with tips.
    foreach ($formats as $format) {
815
      $form[$format->format] = array(
816
        '#type' => 'radio',
817
818
819
        '#title' => $format->name,
        '#default_value' => $value,
        '#return_value' => $format->format,
820
        '#parents' => $parents,
821
        '#description' => theme('filter_tips', _filter_tips($format->format, FALSE)),
822
      );
Dries Buytaert's avatar
Dries Buytaert committed
823
824
825
826
827
    }
  }
  else {
    // Only one format available: use a hidden form item and only show tips.
    $format = array_shift($formats);
828
    $form[$format->format] = array('#type' => 'value', '#value' => $format->format, '#parents' => $parents);
829
    $tips = _filter_tips(variable_get('filter_default_format', 1), FALSE);
830
    $form['format']['guidelines'] = array(
831
      '#title' => t('Formatting guidelines'),
832
      '#value' => theme('filter_tips', $tips, FALSE, $extra),
833
    );
Dries Buytaert's avatar
Dries Buytaert committed
834
  }
835
836
837
838
  $form[] = array(
    '#type' => 'markup',
    '#value' => $extra,
  );
839
  return $form;
Dries Buytaert's avatar
Dries Buytaert committed
840
841
}

842
843
844
845
846
847
848
function filter_form_validate($form) {
  foreach (element_children($form) as $key) {
    if ($form[$key]['#value'] == $form[$key]['#return_value']) {
      return;
    }
  }
  form_error($form, t('An illegal choice has been detected. Please contact the site administrator.'));
849
  watchdog('form', t('Illegal choice %choice in %name element.', array('%choice' => theme('placeholder', check_plain($v)), '%name' => theme('placeholder', empty($form['#title']) ? $form['#parents'][0] : $form['#title']))), WATCHDOG_ERROR);
850
851
}

Dries Buytaert's avatar
Dries Buytaert committed
852
/**
853
 * Returns TRUE if the user is allowed to access this format.
Dries Buytaert's avatar
Dries Buytaert committed
854
855
 */
function filter_access($format) {
856
857
  $format = filter_resolve_format($format);
  if (user_access('administer filters') || ($format == variable_get('filter_default_format', 1))) {
858
    return TRUE;
Dries Buytaert's avatar
Dries Buytaert committed
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
  }
  else {
    $formats = filter_formats();
    return isset($formats[$format]);
  }
}
/**
 * @} End of "Filtering functions".
 */

/**
 * Menu callback; show a page with long filter tips.
 */
function filter_tips_long() {
  $format = arg(2);
  if ($format) {
875
    $output = theme('filter_tips', _filter_tips($format, TRUE), TRUE);
Dries Buytaert's avatar
Dries Buytaert committed
876
877
  }
  else {
878
    $output = theme('filter_tips', _filter_tips(-1, TRUE), TRUE);
Dries Buytaert's avatar
Dries Buytaert committed
879
880
881
882
883
884
885
  }
  return $output;
}

/**
 * Helper function for fetching filter tips.
 */
886
function _filter_tips($format, $long = FALSE) {
Dries Buytaert's avatar
Dries Buytaert committed
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
  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;
}

/**
 * Format a set of filter tips.
 *
 * @ingroup themeable
 */
915
function theme_filter_tips($tips, $long = FALSE, $extra = '') {
Dries Buytaert's avatar
Dries Buytaert committed
916
917
918
919
  $output = '';

  $multiple = count($tips) > 1;
  if ($multiple) {
920
    $output = t('input formats') .':';
Dries Buytaert's avatar
Dries Buytaert committed
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
  }

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

      $tips = '';
      foreach ($tiplist as $tip) {
        $tips .= '<li'. ($long ? ' id="filter-'. str_replace("/", "-", $tip['id']) .'">' : '>') . $tip['tip'] . '</li>';
      }

      if ($tips) {
        $output .= "<ul class=\"tips\">$tips</ul>";
      }

      if ($multiple) {
        $output .= '</li>';
      }
    }
    if ($multiple) {
      $output .= '</ul>';
    }
  }

  return $output;
}

/**
 * @name Standard filters
 * @{
 * Filters implemented by the filter.module.
 */

/**
 * 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.
 */
function filter_filter($op, $delta = 0, $format = -1, $text = '') {
  switch ($op) {
    case 'list':
      return array(0 => t('HTML filter'), 1 => t('PHP evaluator'), 2 => t('Line break converter'));

    case 'no cache':
      return $delta == 1; // No caching for the PHP evaluator.

    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!');
        case 2:
          return t('Converts line breaks into HTML (i.e. &lt;br&gt; and &lt;p&gt; tags).');
        default:
          return;
      }

    case 'process':
      switch ($delta) {
        case 0:
          return _filter_html($text, $format);
        case 1:
          return drupal_eval($text);
        case 2:
          return _filter_autop($text);
        default:
          return $text;
      }

For faster browsing, not all history is shown. View entire blame