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

4
5
define('FILTER_FORMAT_DEFAULT', 0);

6
7
8
9
10
11
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
12
13
14
15
/**
 * Implementation of hook_help().
 */
function filter_help($section) {
16
17
18
  // Get rid of variable numbers in the URL
  $section = preg_replace('/[0-9]+/', '#', $section);

19
  switch ($section) {
Dries's avatar
   
Dries committed
20
    case 'admin/modules#description':
Dries's avatar
Dries committed
21
      return t('Framework for handling filtering of content.');
22

Dries's avatar
   
Dries committed
23
    case 'admin/filters':
24
      return t('
Dries's avatar
   
Dries committed
25
<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>
26
27
28
29
30
<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>');

    case 'admin/filters/#':
      return t('
Dries's avatar
   
Dries committed
31
<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>
32
33
34
35
36
37
38
39
<p>If you notice some filters are causing conflicts in the output, you can <a href="%order">rearrange them</a>.', array('%configure' => url('admin/filters/'. arg(2) .'/configure'), '%order' => url('admin/filters/'. arg(2) .'/order')));

    case 'admin/filters/#/configure':
      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')));

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

/**
46
 * Implementation of hook_filter_tips().
47
 */
48
function filter_filter_tips($delta, $format, $long = false) {
49
50
51
52
53
54
  switch ($delta) {
    case 0:
      switch (variable_get("filter_html_$format", FILTER_HTML_STRIP)) {

        case FILTER_HTML_STRIP:
          if ($allowed_html = variable_get("allowed_html_$format", '<a> <b> <dd> <dl> <dt> <i> <li> <ol> <u> <ul>')) {
Dries's avatar
Dries committed
55
            return t('Allowed HTML tags') .': '. htmlspecialchars($allowed_html);
56
57
          }
          else {
Dries's avatar
Dries committed
58
            return t('No HTML tags allowed');
Dries's avatar
   
Dries committed
59
          }
60
61

        case FILTER_STYLE_STRIP:
Dries's avatar
Dries committed
62
          return t('No HTML tags allowed');
Dries's avatar
   
Dries committed
63
64
      }
      break;
65
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

    case 1:
      switch ($type) {
        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>');
      }

94
    case 2:
95
96
      return t('Lines and paragraphs break automatically.');
      break;
97
98
99
  }
}

100

Dries's avatar
   
Dries committed
101
/**
Dries's avatar
   
Dries committed
102
 * Implementation of hook_menu().
Dries's avatar
   
Dries committed
103
 */
Dries's avatar
   
Dries committed
104
105
function filter_menu() {
  $items = array();
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

  $items[] = array('path' => 'admin/filters', 'title' => t('input formats'),
    'callback' => 'filter_admin_overview',
    'access' => user_access('administer filters'));

  $items[] = array('path' => 'admin/filters/delete', 'title' => t('delete input format'),
    'callback' => 'filter_admin_delete',
    'type' => MENU_CALLBACK,
    'access' => user_access('administer filters'));

  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'));

      $items[] = array('path' => 'admin/filters/'. arg(2) .'/list', 'title' => t('list filters'),
      'callback' => 'filter_admin_filters',
      'type' => MENU_DEFAULT_LOCAL_TASK,
      'weight' => 0,
      'access' => user_access('administer filters'));

      $items[] = array('path' => 'admin/filters/'. arg(2) .'/configure', 'title' => t('configure filters'),
      'callback' => 'filter_admin_configure',
      'type' => MENU_LOCAL_TASK,
      'weight' => 1,
      'access' => user_access('administer filters'));

      $items[] = array('path' => 'admin/filters/'. arg(2) .'/order', 'title' => t('rearrange filters'),
      'callback' => 'filter_admin_order',
      'type' => MENU_LOCAL_TASK,
      'weight' => 2,
      'access' => user_access('administer filters'));
    }
  }

Dries's avatar
   
Dries committed
145
146
147
148
  $items[] = array('path' => 'filter/tips', 'title' => t('compose tips'),
    'callback' => 'filter_tips_long', 'access' => TRUE,
    'type' => MENU_SUGGESTED_ITEM);
  return $items;
149
150
}

Dries's avatar
Dries committed
151
/**
152
 * Implementation of hook_perm().
Dries's avatar
Dries committed
153
 */
154
155
156
157
158
function filter_perm() {
  return array('administer filters');
}

/**
159
 * Menu callback; allows administrators to set up input formats.
160
161
162
163
164
165
166
167
168
169
170
171
 */
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;
  }

172
  // Overview of all formats.
173
174
175
176
177
178
179
180
181
182
183
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
210
211
  $formats = filter_formats();
  $roles = user_roles();
  $error = false;

  $header = array(t('name'), t('default'));
  foreach ($roles as $name) {
    $header[] = $name;
  }
  $header[] = array('data' => t('operations'), 'colspan' => 2);

  $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,");

      if ($default && !$checked && !$error) {
        form_set_error("roles][$id][$rid", t('The default input format must be accessible to every role.'));
        $error = true;
      }

      $row[] = form_checkbox('', "roles][$id][$rid", 1, $checked);
    }

    $row[] = l('configure', 'admin/filters/'. $id);
    $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);

212
  // Form to add a new format.
213
214
215
216
217
218
219
220
221
222
  $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;

  print theme('page', $output);
}

/**
223
 * Save input formats on the overview page.
224
225
 */
function filter_admin_save() {
Dries's avatar
Dries committed
226
  $edit = $_POST['edit'];
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249

  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
250
    }
251
252
253
254
255
256
257
258
    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');
}

/**
259
 * Add a new input format.
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 */
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);
  }

Dries's avatar
   
Dries committed
274
  drupal_set_message(t('Added input format %format.', array('%format' => '<em>'. $edit['name'] .'</em>')));
275
276
277
278
  drupal_goto('admin/filters');
}

/**
279
 * Menu callback; confirm deletion of a format.
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 */
function filter_admin_delete() {
  $edit = $_POST['edit'];
  if ($_POST['op'] == t('Confirm deletion')) {
    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);

Dries's avatar
   
Dries committed
295
      drupal_set_message(t('Deleted input format %format.', array('%format' => '<em>'. $edit['name'] .'</em>')));
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
    }
    drupal_goto('admin/filters');
  }

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

  $form .= form_hidden('format', $format->format);
  $form .= form_hidden('name', $format->name);
  $form .= '<p>'. t("Are you sure you want to delete the input format '%format'? If you have any content left in this input format, it will be switched to the default input format.", array('%format' => $format->name)) .'</p>';
  $form .= form_submit(t('Confirm deletion'));
  print theme('page', form($form));
}

/**
311
 * Ask for confirmation before deleting a format.
312
313
314
315
316
317
318
319
320
 */
function filter_admin_confirm() {
  $edit = $_POST['edit']['format'];


  return form($form);
}

/**
321
 * Menu callback; configure the filters for a format.
322
323
324
325
 */
function filter_admin_filters() {
  $format = arg(2);

326
  // Handle saving of weights.
327
328
329
330
331
332
333
  if ($_POST['op']) {
    filter_admin_filters_save($format, $_POST['edit']);
  }

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

334
  // Table with filters
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
  $header = array('enabled', 'name', 'description');
  $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);

352
  // Composition tips (guidelines)
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
  $tips = _filter_tips($format, false);
  $extra = l(t('More information about formatting options'), 'filter/tips');
  $tiplist = theme('filter_tips', $tips, $extra);
  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;

  print theme('page', $output);
}

/**
 * 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');
}

/**
397
 * Menu callback; display form for ordering filters for a format.
398
399
400
401
402
 */
function filter_admin_order() {
  $format = arg(2);
  if ($_POST['op']) {
    filter_admin_order_save($format, $_POST['edit']);
Dries's avatar
   
Dries committed
403
404
405
  }

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

408
  $header = array(t('name'), t('weight'));
Dries's avatar
   
Dries committed
409
410
  $rows = array();

411
412
  foreach ($filters as $id => $filter) {
    $rows[] = array($filter->name, form_weight('', $id, $filter->weight));
Dries's avatar
   
Dries committed
413
414
  }

Dries's avatar
Dries committed
415
416
  $form  = theme('table', $header, $rows);
  $form .= form_submit(t('Save configuration'));
Dries's avatar
   
Dries committed
417
418
  $output = form($form);

Dries's avatar
Dries committed
419
  print theme('page', $output);
Dries's avatar
   
Dries committed
420
421
}

Dries's avatar
Dries committed
422
/**
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
 * 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);
    db_query("UPDATE filters SET weight = %d WHERE format = %d AND module = '%s' AND delta = %d", $weight, $format, $module, $delta);
  }
  drupal_set_message(t('The filter weights have been saved.'));

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

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

/**
438
 * Menu callback; display settings defined by filters.
Dries's avatar
Dries committed
439
 */
440
441
442
function filter_admin_configure() {
  $format = arg(2);

Dries's avatar
   
Dries committed
443
444
  system_settings_save();

445
446
447
448
449
  $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
450

451
452
453
454
455
456
  if (trim($form) != '') {
    $output = system_settings_form($form);
  }
  else {
    $output = t('No settings are available.');
  }
Dries's avatar
   
Dries committed
457

Dries's avatar
Dries committed
458
  print theme('page', $output);
459
460
}

Dries's avatar
Dries committed
461
/**
462
 * Retrieve a list of input formats.
Dries's avatar
Dries committed
463
 */
464
465
466
467
468
469
470
471
472
473
474
function filter_formats() {
  global $user;
  static $formats;

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

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

    $query = array('SELECT * FROM {filter_formats}');
475

476
    // Build query for selecting the format(s) based on the user's roles.
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
    if (!$all) {
      $where = array();
      foreach ($user->roles as $rid => $role) {
        $where[] = "roles LIKE '%%,%d,%%'";
        $query[] = $rid;
      }
      $query[0] .= ' WHERE '. implode(' OR ', $where);
    }

    $result = call_user_func_array('db_query', $query);
    while ($format = db_fetch_object($result)) {
      $formats[$format->format] = $format;
    }
  }
  return $formats;
}
493

494
495
496
497
498
499
500
501
502
503
504
505
/**
 * 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
506
507
508
    }
  }

509
510
511
512
513
514
515
516
517
518
  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
519
520
}

Dries's avatar
Dries committed
521
/**
522
 * Check if text in a certain input format is allowed to be cached.
Dries's avatar
Dries committed
523
 */
524
525
function filter_format_allowcache($format) {
  static $cache = array();
Dries's avatar
   
Dries committed
526

527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
  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
547
548
549
550
      }
    }
  }

551
  return $filters[$format];
552
553
}

554
555
556
557
558
559
560
561
562
/**
 * @name Filtering functions
 *
 * Modules which need to have content filtered can use these functions to
 * interact with the filter system.
 *
 * @{
 */

Dries's avatar
Dries committed
563
564
565
/**
 * Run all the enabled filters on a piece of text.
 */
566
function check_output($text, $format = FILTER_FORMAT_DEFAULT) {
567
  if (isset($text)) {
568
569
570
571
    if ($format == FILTER_FORMAT_DEFAULT) {
      $format = variable_get('filter_default_format', 1);
    }

572
    // Check for a cached version of this piece of text.
573
574
575
576
577
    $id = 'filter:'. $format .':'. md5($text);
    if ($cached = cache_get($id)) {
      return $cached->data;
    }

578
    // See if caching is allowed for this format.
579
    $cache = filter_format_allowcache($format);
580
581

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

585
    // Get a complete list of filters, ordered properly.
586
    $filters = filter_list_format($format);
Dries's avatar
   
Dries committed
587

Dries's avatar
Dries committed
588
    // Give filters the chance to escape HTML-like data such as code or formulas.
589
590
    foreach ($filters as $filter) {
      $text = module_invoke($filter->module, 'filter', 'prepare', $filter->delta, $format, $text);
Dries's avatar
   
Dries committed
591
    }
592

593
    // Perform filtering.
594
595
    foreach ($filters as $filter) {
      $text = module_invoke($filter->module, 'filter', 'process', $filter->delta, $format, $text);
596
597
    }

598
    // Store in cache.
599
600
    if ($cache) {
      cache_set($id, $text, 1);
601
602
603
604
605
606
607
608
609
    }
  }
  else {
    $text = message_na();
  }

  return $text;
}

Dries's avatar
Dries committed
610
/**
611
 * Generate a selector for choosing a format in a form.
612
613
 *
 * @param $name
614
 *   The internal name used to refer to the form element.
615
 * @param $value
616
 *   The ID of the format that is currently selected.
617
 * @return
618
 *   HTML for the form element.
Dries's avatar
Dries committed
619
 */
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
function filter_form($name, $value = FILTER_FORMAT_DEFAULT) {
  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>';
639
    }
640
    return theme('form_element', t('Input format'), $output, $extra, $name, _form_get_error($name));
Dries's avatar
   
Dries committed
641
  }
642
643
644
645
646
647
648
649
650
  else {
    // Only one format available: use a hidden form item and only show tips.
    $format = array_shift($formats);
    $output = form_hidden($name, $format->format);
    $tips = _filter_tips(variable_get('filter_default_format', 0), false);
    $output .= form_item(t('Formatting guidelines'), theme('filter_tips', $tips, $extra), $extra);
    return $output;
  }
}
651

652
653
654
655
656
657
/**
 * Returns true if the user is allowed to access this format.
 */
function filter_access($format) {
  if (user_access('administer filters')) {
    return true;
658
  }
659
660
661
662
663
664
  else {
    $formats = filter_formats();
    return isset($formats[$format]);
  }
}
/* @} */
665

666
/**
667
 * Menu callback; show a page with long filter tips.
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
 */
function filter_tips_long() {
  $format = arg(2);
  if ($format) {
    $output = theme('filter_tips', _filter_tips($format, true));
  }
  else {
    $output = theme('filter_tips', _filter_tips(-1, true));
  }
  print theme('page', $output, t('Compose Tips'));
}

/**
 * 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;
705
706
}

Dries's avatar
Dries committed
707
/**
708
709
 * @addtogroup themeable
 * @{
Dries's avatar
Dries committed
710
 */
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751

/**
 * Format filter tips
 *
 * @param $tips
 * @param $long
 * @param $extra
 */
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 />';
      }

      $output .= '<ul class="tips">';

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

      $output .= '</ul>';
      if ($multiple) {
        $output .= '</li>';
      }
    }
    if ($multiple) {
      $output .= '</ul>';
    }
  }
Dries's avatar
   
Dries committed
752
753
754
755

  return $output;
}

756
757
/** @} End of addtogroup themeable */

Dries's avatar
Dries committed
758
/**
759
760
761
762
 * @name Standard filters
 *
 * Filters implemented by the filter.module.
 * @{
Dries's avatar
Dries committed
763
 */
764
765

/**
766
767
768
769
770
771
772
 * 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.
773
774
 */
function filter_filter($op, $delta = 0, $format = -1, $text = '') {
Dries's avatar
   
Dries committed
775
  switch ($op) {
776
    case 'list':
777
      return array(0 => t('HTML filter'), 1 => t('PHP evaluator'), 2 => t('Line break converter'));
778
779

    case 'no cache':
780
      return $delta == 1; // No caching for the PHP evaluator.
781
782
783
784
785
786
787

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

Dries's avatar
Dries committed
794
    case 'process':
795
796
797
798
799
      switch ($delta) {
        case 0:
          return _filter_html($text, $format);
        case 1:
          return drupal_eval($text);
800
        case 2:
801
          return _filter_autop($text);
802
803
        default:
          return $text;
Dries's avatar
   
Dries committed
804
      }
805

Dries's avatar
Dries committed
806
    case 'settings':
807
808
809
810
811
812
813
      switch ($delta) {
        case 0:
          return _filter_html_settings($format);
        default:
          return;
      }

Dries's avatar
   
Dries committed
814
815
816
817
818
    default:
      return $text;
  }
}

819
/**
820
 * Settings for the HTML filter.
821
822
823
824
825
826
827
828
829
830
831
 */
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.'));
  $group .= form_textfield(t('Allowed HTML tags'), "allowed_html_$format", variable_get("allowed_html_$format", '<a> <b> <dd> <dl> <dt> <i> <li> <ol> <u> <ul>'), 64, 255, t('If "Strip tags" is selected, optionally specify tags which should not be stripped. Javascript event attributes are always stripped.'));
  $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.'));
  $output .= form_group(t('HTML filter'), $group);

  return $output;
}

/**
832
 * HTML filter. Provides filtering of input into accepted HTML.
833
834
835
836
 */
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
837
    $text = strip_tags($text, variable_get("allowed_html_$format", '<a> <b> <dd> <dl> <dt> <i> <li> <ol> <u> <ul>'));
838
839
840
841
842
843
844
845
846
847
848
849
850
851
    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
    $text = htmlspecialchars($text);
  }

  return trim($text);
}

Dries's avatar
Dries committed
852
/**
853
854
 * Convert line breaks into <p> and <br> in an intelligent fashion.
 * From: http://photomatt.net/scripts/autop
Dries's avatar
Dries committed
855
 */
856
function _filter_autop($text) {
857
858
859
860
861
  $text = preg_replace('|\n*$|', '', $text) ."\n\n"; // just to make things a little easier, pad the end
  $text = preg_replace('|<br />\s*<br />|', "\n\n", $text);
  $text = preg_replace('!(<(?:table|ul|ol|li|pre|form|blockquote|h[1-6])[^>]*>)!', "\n$1", $text); // Space things out a little
  $text = preg_replace('!(</(?:table|ul|ol|li|pre|form|blockquote|h[1-6])>)!', "$1\n", $text); // Space things out a little
  $text = preg_replace("/\n\n+/", "\n\n", $text); // take care of duplicates
862
  $text = preg_replace('/\n?(.+?)(?:\n\s*\n|\z)/s', "<p>$1</p>\n", $text); // make paragraphs, including one at the end
863
864
865
866
867
868
  $text = preg_replace('|<p>\s*?</p>|', '', $text); // under certain strange conditions it could create a P of entirely whitespace
  $text = preg_replace("|<p>(<li.+?)</p>|", "$1", $text); // problem with nested lists
  $text = preg_replace('|<p><blockquote([^>]*)>|i', "<blockquote$1><p>", $text);
  $text = str_replace('</blockquote></p>', '</p></blockquote>', $text);
  $text = preg_replace('!<p>\s*(</?(?:table|tr|td|th|div|ul|ol|li|pre|select|form|blockquote|p|h[1-6])[^>]*>)!', "$1", $text);
  $text = preg_replace('!(</?(?:table|tr|td|th|div|ul|ol|li|pre|select|form|blockquote|p|h[1-6])[^>]*>)\s*</p>!', "$1", $text);
869
  $text = preg_replace('|(?<!<br />)\s*\n|', "<br />\n", $text); // make line breaks
870
871
872
  $text = preg_replace('!(</?(?:table|tr|td|th|div|dl|dd|dt|ul|ol|li|pre|select|form|blockquote|p|h[1-6])[^>]*>)\s*<br />!', "$1", $text);
  $text = preg_replace('!<br />(\s*</?(?:p|li|div|th|pre|td|ul|ol)>)!', '$1', $text);
  $text = preg_replace('/&([^#])(?![a-z]{1,8};)/', '&#038;$1', $text);
Dries's avatar
   
Dries committed
873

874
  return $text;
Dries's avatar
   
Dries committed
875
876
}

877
878
/* @} */

Dries's avatar
   
Dries committed
879
?>