filter.module 53.9 KB
Newer Older
1 2
<?php

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

8
use Drupal\Core\Cache\CacheBackendInterface;
9
use Drupal\Core\Language\Language;
10
use Drupal\Core\Template\Attribute;
11
use Drupal\filter\Plugin\Core\Entity\FilterFormat;
Dries's avatar
 
Dries committed
12

13 14
/**
 * Non-HTML markup language filters that generate HTML.
15 16
 *
 * @todo Move into \Drupal\filter\Plugin\Filter\FilterInterface
17 18 19 20 21
 */
const FILTER_TYPE_MARKUP_LANGUAGE = 0;

/**
 * HTML tag and attribute restricting filters.
22 23
 *
 * @todo Move into \Drupal\filter\Plugin\Filter\FilterInterface
24 25 26 27 28
 */
const FILTER_TYPE_HTML_RESTRICTOR = 1;

/**
 * Reversible transformation filters.
29 30
 *
 * @todo Move into \Drupal\filter\Plugin\Filter\FilterInterface
31 32 33 34 35
 */
const FILTER_TYPE_TRANSFORM_REVERSIBLE = 2;

/**
 * Irreversible transformation filters.
36 37
 *
 * @todo Move into \Drupal\filter\Plugin\Filter\FilterInterface
38 39 40
 */
const FILTER_TYPE_TRANSFORM_IRREVERSIBLE = 3;

Dries's avatar
Dries committed
41
/**
42
 * Implements hook_help().
Dries's avatar
Dries committed
43
 */
44 45
function filter_help($path, $arg) {
  switch ($path) {
46
    case 'admin/help#filter':
47 48
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
49
      $output .= '<p>' . t('The Filter module allows administrators to configure text formats. A text format defines the HTML tags, codes, and other input allowed in content and comments, and is a key feature in guarding against potentially damaging input from malicious users. For more information, see the online handbook entry for <a href="@filter">Filter module</a>.', array('@filter' => 'http://drupal.org/documentation/modules/filter/')) . '</p>';
50 51
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
52 53
      $output .= '<dt>' . t('Configuring text formats') . '</dt>';
      $output .= '<dd>' . t('Configure text formats on the <a href="@formats">Text formats page</a>. <strong>Improper text format configuration is a security risk</strong>. To ensure security, untrusted users should only have access to text formats that restrict them to either plain text or a safe set of HTML tags, since certain HTML tags can allow embedding malicious links or scripts in text. More trusted registered users may be granted permission to use less restrictive text formats in order to create rich content.', array('@formats' => url('admin/config/content/formats'))) . '</dd>';
54
      $output .= '<dt>' . t('Applying filters to text') . '</dt>';
55
      $output .= '<dd>' . t('Each text format uses filters to manipulate text, and most formats apply several different filters to text in a specific order. Each filter is designed for a specific purpose, and generally either adds, removes, or transforms elements within user-entered text before it is displayed. A filter does not change the actual content, but instead, modifies it temporarily before it is displayed. One filter may remove unapproved HTML tags, while another automatically adds HTML to make URLs display as clickable links.') . '</dd>';
56
      $output .= '<dt>' . t('Defining text formats') . '</dt>';
57
      $output .= '<dd>' . t('One format is included by default: <em>Plain text</em> (which removes all HTML tags). Additional formats may be created by your installation profile when you install Drupal, and more can be created by an administrator on the <a href="@text-formats">Text formats page</a>.', array('@text-formats' => url('admin/config/content/formats'))) . '</dd>';
58
      $output .= '<dt>' . t('Choosing a text format') . '</dt>';
59
      $output .= '<dd>' . t('Users with access to more than one text format can use the <em>Text format</em> widget to choose between available text formats when creating or editing multi-line content. Administrators can define the text formats available to each user role, and control the order of formats listed in the <em>Text format</em> widget on the <a href="@text-formats">Text formats page</a>.', array('@text-formats' => url('admin/config/content/formats'))) . '</dd>';
60
      $output .= '</dl>';
61
      return $output;
62

63
    case 'admin/config/content/formats':
64
      $output = '<p>' . t('Text formats define the HTML tags, code, and other formatting that can be used when entering text. <strong>Improper text format configuration is a security risk</strong>. Learn more on the <a href="@filterhelp">Filter module help page</a>.', array('@filterhelp' => url('admin/help/filter'))) . '</p>';
65
      $output .= '<p>' . t('Text formats are presented on content editing pages in the order defined on this page. The first format available to a user will be selected by default.') . '</p>';
66
      return $output;
67

68
    case 'admin/config/content/formats/%':
69
      $output = '<p>' . t('A text format contains filters that change the user input, for example stripping out malicious HTML or making URLs clickable. Filters are executed from top to bottom and the order is important, since one filter may prevent another filter from doing its job. For example, when URLs are converted into links before disallowed HTML tags are removed, all links may be removed. When this happens, the order of filters may need to be re-arranged.') . '</p>';
70
      return $output;
71 72 73
  }
}

74
/**
75
 * Implements hook_theme().
76 77 78 79
 */
function filter_theme() {
  return array(
    'filter_tips' => array(
80
      'variables' => array('tips' => NULL, 'long' => FALSE),
81
      'file' => 'filter.pages.inc',
82
    ),
83 84 85
    'text_format_wrapper' => array(
      'render element' => 'element',
    ),
86
    'filter_guidelines' => array(
87
      'variables' => array('format' => NULL),
88
    ),
89 90 91
    'filter_html_image_secure_image' => array(
      'variables' => array('image' => NULL),
    ),
92 93 94
  );
}

95 96 97 98
/**
 * Implements hook_element_info().
 *
 * @see filter_process_format()
99
 * @see text_format_wrapper()
100 101 102 103 104 105 106 107 108 109
 */
function filter_element_info() {
  $type['text_format'] = array(
    '#process' => array('filter_process_format'),
    '#base_type' => 'textarea',
    '#theme_wrappers' => array('text_format_wrapper'),
  );
  return $type;
}

110
/**
111
 * Implements hook_menu().
112
 */
113
function filter_menu() {
114 115 116
  $items['filter/tips'] = array(
    'title' => 'Compose tips',
    'type' => MENU_SUGGESTED_ITEM,
117
    'route_name' => 'filter_tips_all',
118
  );
119 120
  $items['filter/tips/%filter_format'] = array(
    'title' => 'Compose tips',
121
    'route_name' => 'filter_tips',
122
  );
123
  $items['admin/config/content/formats'] = array(
124
    'title' => 'Text formats',
125
    'description' => 'Configure how content input by users is filtered, including allowed HTML tags. Also allows enabling of module-provided filters.',
126 127 128
    'page callback' => 'drupal_get_form',
    'page arguments' => array('filter_admin_overview'),
    'access arguments' => array('administer filters'),
129
    'file' => 'filter.admin.inc',
130
  );
131
  $items['admin/config/content/formats/list'] = array(
132
    'title' => 'List',
133 134
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
135
  $items['admin/config/content/formats/add'] = array(
136
    'title' => 'Add text format',
137
    'page callback' => 'filter_admin_format_page',
138
    'access arguments' => array('administer filters'),
139
    'type' => MENU_LOCAL_ACTION,
140
    'file' => 'filter.admin.inc',
141
  );
142
  $items['admin/config/content/formats/%filter_format'] = array(
143
    'title callback' => 'filter_admin_format_title',
144
    'title arguments' => array(4),
145
    'page callback' => 'filter_admin_format_page',
146
    'page arguments' => array(4),
147
    'access arguments' => array('administer filters'),
148
    'file' => 'filter.admin.inc',
149
  );
150 151
  $items['admin/config/content/formats/%filter_format/disable'] = array(
    'title' => 'Disable text format',
152
    'route_name' => 'filter_admin_disable',
153
  );
154 155 156
  return $items;
}

157
/**
158
 * Loads a text format object from the database.
159
 *
160
 * @param $format_id
161 162 163
 *   The format ID.
 *
 * @return
164 165 166 167 168
 *   A fully-populated text format object, if the requested format exists and
 *   is enabled. If the format does not exist, or exists in the database but
 *   has been marked as disabled, FALSE is returned.
 *
 * @see filter_format_exists()
169 170
 *
 * @todo Use entity_load().
171
 */
172
function filter_format_load($format_id) {
173
  $formats = filter_formats();
174
  return isset($formats[$format_id]) ? $formats[$format_id] : FALSE;
175 176
}

177 178 179 180 181 182 183 184 185 186 187 188 189 190
/**
 * Determines if a text format exists.
 *
 * @param $format_id
 *   The ID of the text format to check.
 *
 * @return
 *   TRUE if the text format exists, FALSE otherwise. Note that for disabled
 *   formats filter_format_exists() will return TRUE while filter_format_load()
 *   will return FALSE.
 *
 * @see filter_format_load()
 */
function filter_format_exists($format_id) {
191
  return entity_load('filter_format', $format_id);
192 193
}

194
/**
195 196
 * Displays a text format form title.
 *
197 198 199 200 201 202
 * @param object $format_id
 *   A format object.
 *
 * @return string
 *   The name of the format.
 *
203
 * @see filter_menu()
204 205 206 207 208
 */
function filter_admin_format_title($format) {
  return $format->name;
}

209
/**
210
 * Implements hook_permission().
211
 */
212
function filter_permission() {
213
  $perms['administer filters'] = array(
214
    'title' => t('Administer text formats and filters'),
215 216 217
    'description' => t('Define how text is handled by combining filters into <a href="@url">text formats</a>.', array(
      '@url' => url('admin/config/content/formats'),
    )),
218
    'restrict access' => TRUE,
219
  );
220 221 222 223 224 225 226 227

  // Generate permissions for each text format. Warn the administrator that any
  // of them are potentially unsafe.
  foreach (filter_formats() as $format) {
    $permission = filter_permission_name($format);
    if (!empty($permission)) {
      // Only link to the text format configuration page if the user who is
      // viewing this will have access to that page.
228
      $format_name_replacement = user_access('administer filters') ? l($format->name, 'admin/config/content/formats/' . $format->format) : drupal_placeholder($format->name);
229
      $perms[$permission] = array(
230
        'title' => t("Use the !text_format text format", array('!text_format' => $format_name_replacement,)),
231
        'description' => drupal_placeholder(t('Warning: This permission may have security implications depending on how the text format is configured.')),
232 233 234 235 236 237 238 239 240 241 242
      );
    }
  }
  return $perms;
}

/**
 * Returns the machine-readable permission name for a provided text format.
 *
 * @param $format
 *   An object representing a text format.
243
 *
244 245 246 247 248 249 250 251 252
 * @return
 *   The machine-readable permission name, or FALSE if the provided text format
 *   is malformed or is the fallback format (which is available to all users).
 */
function filter_permission_name($format) {
  if (isset($format->format) && $format->format != filter_fallback_format()) {
    return 'use text format ' . $format->format;
  }
  return FALSE;
253 254
}

Dries's avatar
Dries committed
255
/**
256
 * Retrieves a list of text formats, ordered by weight.
257 258
 *
 * @param $account
259
 *   (optional) If provided, only those formats that are allowed for this user
260 261
 *   account will be returned. All formats will be returned otherwise. Defaults
 *   to NULL.
262
 *
263
 * @return
264 265 266 267
 *   An array of text format objects, keyed by the format ID and ordered by
 *   weight.
 *
 * @see filter_formats_reset()
Dries's avatar
Dries committed
268
 */
269
function filter_formats($account = NULL) {
270
  $language_interface = language(Language::TYPE_INTERFACE);
271
  $formats = &drupal_static(__FUNCTION__, array());
272

273
  // All available formats are cached for performance.
274
  if (!isset($formats['all'])) {
275
    if ($cache = cache()->get("filter_formats:{$language_interface->langcode}")) {
276 277 278
      $formats['all'] = $cache->data;
    }
    else {
279 280 281
      $filter_formats = entity_load_multiple('filter_format');
      $formats['all'] = array();
      foreach ($filter_formats as $format_name => $filter_format) {
282
        if ($filter_format->status()) {
283 284 285 286
          $formats['all'][$format_name] = $filter_format;
        }
      }
      uasort($formats['all'], 'Drupal\Core\Config\Entity\ConfigEntityBase::sort');
287

288
      cache()->set("filter_formats:{$language_interface->langcode}", $formats['all'], CacheBackendInterface::CACHE_PERMANENT, array('filter_formats' => TRUE));
289
    }
290
  }
291

292 293 294 295 296 297
  // Build a list of user-specific formats.
  if (isset($account) && !isset($formats['user'][$account->uid])) {
    $formats['user'][$account->uid] = array();
    foreach ($formats['all'] as $format) {
      if (filter_access($format, $account)) {
        $formats['user'][$account->uid][$format->format] = $format;
298 299
      }
    }
300 301 302 303
  }

  return isset($account) ? $formats['user'][$account->uid] : $formats['all'];
}
304

305
/**
306
 * Resets the text format caches.
307 308 309 310
 *
 * @see filter_formats()
 */
function filter_formats_reset() {
311
  cache()->deleteTags(array('filter_formats' => TRUE));
312
  cache()->delete('filter_list_format');
313 314 315 316 317 318 319 320 321
  drupal_static_reset('filter_list_format');
  drupal_static_reset('filter_formats');
}

/**
 * Retrieves a list of roles that are allowed to use a given text format.
 *
 * @param $format
 *   An object representing the text format.
322
 *
323 324 325 326 327 328
 * @return
 *   An array of role names, keyed by role ID.
 */
function filter_get_roles_by_format($format) {
  // Handle the fallback format upfront (all roles have access to this format).
  if ($format->format == filter_fallback_format()) {
329
    return user_role_names();
330
  }
331 332
  // Do not list any roles if the permission does not exist.
  $permission = filter_permission_name($format);
333
  return !empty($permission) ? user_role_names(FALSE, $permission) : array();
334 335 336 337 338 339 340
}

/**
 * Retrieves a list of text formats that are allowed for a given role.
 *
 * @param $rid
 *   The user role ID to retrieve text formats for.
341
 *
342 343 344 345 346 347 348 349 350 351 352
 * @return
 *   An array of text format objects that are allowed for the role, keyed by
 *   the text format ID and ordered by weight.
 */
function filter_get_formats_by_role($rid) {
  $formats = array();
  foreach (filter_formats() as $format) {
    $roles = filter_get_roles_by_format($format);
    if (isset($roles[$rid])) {
      $formats[$format->format] = $format;
    }
353
  }
354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374
  return $formats;
}

/**
 * Returns the ID of the default text format for a particular user.
 *
 * The default text format is the first available format that the user is
 * allowed to access, when the formats are ordered by weight. It should
 * generally be used as a default choice when presenting the user with a list
 * of possible text formats (for example, in a node creation form).
 *
 * Conversely, when existing content that does not have an assigned text format
 * needs to be filtered for display, the default text format is the wrong
 * choice, because it is not guaranteed to be consistent from user to user, and
 * some trusted users may have an unsafe text format set by default, which
 * should not be used on text of unknown origin. Instead, the fallback format
 * returned by filter_fallback_format() should be used, since that is intended
 * to be a safe, consistent format that is always available to all users.
 *
 * @param $account
 *   (optional) The user account to check. Defaults to the currently logged-in
375
 *   user. Defaults to NULL.
376
 *
377 378 379 380 381 382 383 384 385 386 387 388
 * @return
 *   The ID of the user's default text format.
 *
 * @see filter_fallback_format()
 */
function filter_default_format($account = NULL) {
  global $user;
  if (!isset($account)) {
    $account = $user;
  }
  // Get a list of formats for this user, ordered by weight. The first one
  // available is the user's default format.
389 390
  $formats = filter_formats($account);
  $format = reset($formats);
391 392 393
  return $format->format;
}

394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409
/**
 * Retrieves all filter types that are used in a given text format.
 *
 * @param string $format_id
 *   A text format ID.
 *
 * @return array
 *   All filter types used by filters of a given text format.
 *
 * @throws Exception
 */
function filter_get_filter_types_by_format($format_id) {
  $filter_types = array();

  $filters = filter_list_format($format_id);
  foreach ($filters as $filter) {
410 411
    if ($filter->status) {
      $filter_types[] = $filter->getType();
412 413 414 415 416 417
    }
  }

  return array_unique($filter_types);
}

418 419
/**
 * Returns the ID of the fallback text format that all users have access to.
420 421 422
 *
 * The fallback text format is a regular text format in every respect, except
 * it does not participate in the filter permission system and cannot be
423
 * disabled. It needs to exist because any user who has permission to create
424 425 426 427 428 429 430
 * formatted content must always have at least one text format they can use.
 *
 * Because the fallback format is available to all users, it should always be
 * configured securely. For example, when the Filter module is installed, this
 * format is initialized to output plain text. Installation profiles and site
 * administrators have the freedom to configure it further.
 *
431 432 433 434 435 436
 * Note that the fallback format is completely distinct from the default format,
 * which differs per user and is simply the first format which that user has
 * access to. The default and fallback formats are only guaranteed to be the
 * same for users who do not have access to any other format; otherwise, the
 * fallback format's weight determines its placement with respect to the user's
 * other formats.
437
 *
438 439
 * Any modules implementing a format deletion functionality must not delete this
 * format.
440
 *
441 442 443
 * @return
 *   The ID of the fallback text format.
 *
444
 * @see hook_filter_format_disable()
445
 * @see filter_default_format()
446 447 448
 */
function filter_fallback_format() {
  // This variable is automatically set in the database for all installations
449
  // of Drupal. In the event that it gets disabled or deleted somehow, there
450
  // is no safe default to return, since we do not want to risk making an
451 452 453
  // existing (and potentially unsafe) text format on the site automatically
  // available to all users. Returning NULL at least guarantees that this
  // cannot happen.
454
  return config('filter.settings')->get('fallback_format');
455 456 457 458
}

/**
 * Returns the title of the fallback text format.
459 460 461
 *
 * @return string
 *   The title of the fallback text format.
462 463 464 465
 */
function filter_fallback_format_title() {
  $fallback_format = filter_format_load(filter_fallback_format());
  return filter_admin_format_title($fallback_format);
466
}
467

Dries's avatar
Dries committed
468
/**
469
 * Checks if the text in a certain text format is allowed to be cached.
470 471 472 473 474 475 476
 *
 * This function can be used to check whether the result of the filtering
 * process can be cached. A text format may allow caching depending on the
 * filters enabled.
 *
 * @param $format_id
 *   The text format ID to check.
477
 *
478 479
 * @return
 *   TRUE if the given text format allows caching, FALSE otherwise.
Dries's avatar
Dries committed
480
 */
481
function filter_format_allowcache($format_id) {
482 483 484 485
  $format = filter_format_load($format_id);
  return !empty($format->cache);
}

486
/**
487
 * Retrieves a list of filters for a given text format.
488
 *
489 490 491 492 493
 * Note that this function returns all associated filters regardless of whether
 * they are enabled or disabled. All functions working with the filter
 * information outside of filter administration should test for $filter->status
 * before performing actions with the filter.
 *
494
 * @param $format_id
495
 *   The format ID to retrieve filters for.
496
 *
497
 * @return
498 499
 *   An array of filter objects associated to the given text format, keyed by
 *   filter name.
500 501 502 503
 *
 * @todo Change this function to only return enabled filters. Code that needs to
 *   access disabled filters is not regular runtime code and thus can work with
 *   the FilterFormat::filters().
504
 */
505
function filter_list_format($format_id) {
506
  $filters = &drupal_static(__FUNCTION__, array());
507

508
  if (!isset($filters['all'])) {
509
    if ($cache = cache()->get('filter_list_format')) {
510 511 512
      $filters['all'] = $cache->data;
    }
    else {
513
      $filters['all'] = array();
514 515
      $filter_formats = filter_formats();
      foreach ($filter_formats as $filter_format) {
516 517 518 519
        // This loop must not instantiate the actual filter plugins, since the
        // filter bag would be duplicated for each filter plugin instance upon
        // unserialization of the cache item.
        $filters['all'][$filter_format->id()] = $filter_format->filters();
520
      }
521
      cache()->set('filter_list_format', $filters['all']);
522 523 524
    }
  }

525 526
  if (!isset($filters[$format_id]) && isset($filters['all'][$format_id])) {
    $filters[$format_id] = $filters['all'][$format_id];
Dries's avatar
 
Dries committed
527 528
  }

529
  return isset($filters[$format_id]) ? $filters[$format_id] : array();
530 531
}

532
/**
533
 * Runs all the enabled filters on a piece of text.
534
 *
535
 * Note: Because filters can inject JavaScript or execute PHP code, security is
536 537
 * vital here. When a user supplies a text format, you should validate it using
 * filter_access() before accepting/using it. This is normally done in the
538 539
 * validation stage of the Form API. You should for example never make a
 * preview of content in a disallowed format.
540 541
 *
 * @param $text
542
 *   The text to be filtered.
543
 * @param $format_id
544 545
 *   (optional) The format ID of the text to be filtered. If no format is
 *   assigned, the fallback format will be used. Defaults to NULL.
546
 * @param $langcode
547
 *   (optional) The language code of the text to be filtered, e.g. 'en' for
548
 *   English. This allows filters to be language aware so language specific
549
 *   text replacement can be implemented. Defaults to an empty string.
550
 * @param $cache
551 552 553 554
 *   (optional) A Boolean indicating whether to cache the filtered output in the
 *   {cache_filter} table. The caller may set this to FALSE when the output is
 *   already cached elsewhere to avoid duplicate cache lookups and storage.
 *   Defaults to FALSE.
555 556 557 558 559
 * @param array $filter_types_to_skip
 *   (optional) An array of filter types to skip, or an empty array (default)
 *   to skip no filter types. All of the format's filters will be applied,
 *   except for filters of the types that are marked to be skipped.
 *   FILTER_TYPE_HTML_RESTRICTOR is the only type that cannot be skipped.
560
 *
561 562 563
 * @return
 *   The filtered text.
 *
564
 * @ingroup sanitization
Dries's avatar
Dries committed
565
 */
566
function check_markup($text, $format_id = NULL, $langcode = '', $cache = FALSE, $filter_types_to_skip = array()) {
567
  if (!isset($format_id)) {
568
    $format_id = filter_fallback_format();
569
  }
570 571
  // If the requested text format does not exist, the text cannot be filtered.
  if (!$format = filter_format_load($format_id)) {
572
    watchdog('filter', 'Missing text format: %format.', array('%format' => $format_id), WATCHDOG_ALERT);
573 574
    return '';
  }
575

576 577 578 579 580 581 582 583 584 585
  // Prevent FILTER_TYPE_HTML_RESTRICTOR from being skipped.
  if (in_array(FILTER_TYPE_HTML_RESTRICTOR, $filter_types_to_skip)) {
    $filter_types_to_skip = array_diff($filter_types_to_skip, array(FILTER_TYPE_HTML_RESTRICTOR));
  }

  // When certain filters should be skipped, don't perform caching.
  if ($filter_types_to_skip) {
    $cache = FALSE;
  }

586
  // Check for a cached version of this piece of text.
587
  $cache = $cache && !empty($format->cache);
588
  $cache_id = '';
589
  if ($cache) {
590
    $cache_id = $format->format . ':' . $langcode . ':' . hash('sha256', $text);
591
    if ($cached = cache('filter')->get($cache_id)) {
592 593
      return $cached->data;
    }
594
  }
595

596 597 598
  // Convert all Windows and Mac newlines to a single newline, so filters only
  // need to deal with one possibility.
  $text = str_replace(array("\r\n", "\r"), "\n", $text);
Dries's avatar
 
Dries committed
599

600
  // Get a complete list of filters, ordered properly.
601
  $filters = filter_list_format($format->format);
602

603
  // Give filters the chance to escape HTML-like data such as code or formulas.
604
  foreach ($filters as $filter) {
605
    // If necessary, skip filters of a certain type.
606
    if (in_array($filter->getType(), $filter_types_to_skip)) {
607 608
      continue;
    }
609 610
    if ($filter->status) {
      $text = $filter->prepare($text, $langcode, $cache, $cache_id);
611
    }
612
  }
613

614
  // Perform filtering.
615
  foreach ($filters as $filter) {
616
    // If necessary, skip filters of a certain type.
617
    if (in_array($filter->getType(), $filter_types_to_skip)) {
618 619
      continue;
    }
620 621
    if ($filter->status) {
      $text = $filter->process($text, $langcode, $cache, $cache_id);
Dries's avatar
Dries committed
622 623
    }
  }
624

625 626 627
  // Cache the filtered text. This cache is infinitely valid. It becomes
  // obsolete when $text changes (which leads to a new $cache_id). It is
  // automatically flushed when the text format is updated.
628
  // @see \Drupal\filter\Plugin\Core\Entity\FilterFormat::save()
629
  if ($cache) {
630
    cache('filter')->set($cache_id, $text, CacheBackendInterface::CACHE_PERMANENT, array('filter_format' => $format->format));
Dries's avatar
Dries committed
631 632 633 634 635 636
  }

  return $text;
}

/**
637 638 639
 * Expands an element into a base element with text format selector attached.
 *
 * The form element will be expanded into two separate form elements, one
640 641 642 643
 * holding the original element, and the other holding the text format
 * selector:
 * - value: Holds the original element, having its #type changed to the value
 *   of #base_type or 'textarea' by default.
644
 * - format: Holds the text format details and the text format selection,
645 646 647 648 649
 *   using the text format ID specified in #format or the user's default format
 *   by default, if NULL.
 *
 * The resulting value for the element will be an array holding the value and
 * the format. For example, the value for the body element will be:
650
 * @code
651 652
 *   $form_state['values']['body']['value'] = 'foo';
 *   $form_state['values']['body']['format'] = 'foo';
653 654 655 656 657 658
 * @endcode
 *
 * @param $element
 *   The form element to process. Properties used:
 *   - #base_type: The form element #type to use for the 'value' element.
 *     'textarea' by default.
659
 *   - #format: (optional) The text format ID to preselect. If NULL or not set,
660
 *     the default format for the current user will be used.
661
 *
Dries's avatar
Dries committed
662
 * @return
663
 *   The expanded element.
Dries's avatar
Dries committed
664
 */
665
function filter_process_format($element) {
666 667
  global $user;

668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688
  // Ensure that children appear as subkeys of this element.
  $element['#tree'] = TRUE;
  $blacklist = array(
    // Make form_builder() regenerate child properties.
    '#parents',
    '#id',
    '#name',
    // Do not copy this #process function to prevent form_builder() from
    // recursing infinitely.
    '#process',
    // Description is handled by theme_text_format_wrapper().
    '#description',
    // Ensure proper ordering of children.
    '#weight',
    // Properties already processed for the parent element.
    '#prefix',
    '#suffix',
    '#attached',
    '#processed',
    '#theme_wrappers',
  );
689
  // Move this element into sub-element 'value'.
690
  unset($element['value']);
691 692 693
  foreach (element_properties($element) as $key) {
    if (!in_array($key, $blacklist)) {
      $element['value'][$key] = $element[$key];
694
    }
695 696
  }

697 698 699 700
  $element['value']['#type'] = $element['#base_type'];
  $element['value'] += element_info($element['#base_type']);

  // Turn original element into a text format wrapper.
701
  $element['#attached']['library'][] = array('filter', 'drupal.filter');
702

703 704
  // Setup child container for the text format widget.
  $element['format'] = array(
705
    '#type' => 'container',
706
    '#attributes' => array('class' => array('filter-wrapper')),
707
  );
708

709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726
  // Get a list of formats that the current user has access to.
  $formats = filter_formats($user);

  // Use the default format for this user if none was selected.
  if (!isset($element['#format'])) {
    $element['#format'] = filter_default_format($user);
  }

  // If multiple text formats are available, remove the fallback. The
  // "always_show_fallback_choice" is a hidden variable that has no UI. It
  // defaults to false.
  if (!config('filter.settings')->get('always_show_fallback_choice')) {
    $fallback_format = filter_fallback_format();
    if ($element['#format'] !== $fallback_format && count($formats) > 1) {
      unset($formats[$fallback_format]);
    }
  }

727 728 729 730 731
  // Prepare text format guidelines.
  $element['format']['guidelines'] = array(
    '#type' => 'container',
    '#attributes' => array('class' => array('filter-guidelines')),
    '#weight' => 20,
732 733 734
  );
  foreach ($formats as $format) {
    $options[$format->format] = $format->name;
735 736 737
    $element['format']['guidelines'][$format->format] = array(
      '#theme' => 'filter_guidelines',
      '#format' => $format,
738
    );
Dries's avatar
Dries committed
739
  }
740 741

  $element['format']['format'] = array(
742 743 744
    '#type' => 'select',
    '#title' => t('Text format'),
    '#options' => $options,
745
    '#default_value' => $element['#format'],
746
    '#access' => count($formats) > 1,
747
    '#weight' => 10,
748
    '#attributes' => array('class' => array('filter-list')),
749
    '#parents' => array_merge($element['#parents'], array('format')),
750
  );
751 752 753 754

  $element['format']['help'] = array(
    '#type' => 'container',
    '#attributes' => array('class' => array('filter-help')),
755
    '#markup' => l(t('More information about text formats'), 'filter/tips', array('attributes' => array('target' => '_blank'))),
756
    '#weight' => 0,
757 758
  );

759
  $all_formats = filter_formats();
760 761 762 763 764 765 766
  $format_exists = isset($all_formats[$element['#format']]);
  $user_has_access = isset($formats[$element['#format']]);
  $user_is_admin = user_access('administer filters');

  // If the stored format does not exist, administrators have to assign a new
  // format.
  if (!$format_exists && $user_is_admin) {
767
    $element['format']['format']['#required'] = TRUE;
768 769 770 771 772 773 774 775 776
    $element['format']['format']['#default_value'] = NULL;
    // Force access to the format selector (it may have been denied above if
    // the user only has access to a single format).
    $element['format']['format']['#access'] = TRUE;
  }
  // Disable this widget, if the user is not allowed to use the stored format,
  // or if the stored format does not exist. The 'administer filters' permission
  // only grants access to the filter administration, not to all formats.
  elseif (!$user_has_access || !$format_exists) {
777 778 779 780 781 782
    // Overload default values into #value to make them unalterable.
    $element['value']['#value'] = $element['value']['#default_value'];
    $element['format']['format']['#value'] = $element['format']['format']['#default_value'];

    // Prepend #pre_render callback to replace field value with user notice
    // prior to rendering.
783
    $element['value'] += array('#pre_render' => array());
784 785 786 787 788 789 790
    array_unshift($element['value']['#pre_render'], 'filter_form_access_denied');

    // Cosmetic adjustments.
    if (isset($element['value']['#rows'])) {
      $element['value']['#rows'] = 3;
    }
    $element['value']['#disabled'] = TRUE;
791
    $element['value']['#resizable'] = 'none';
792 793 794 795 796 797 798 799 800 801

    // Hide the text format selector and any other child element (such as text
    // field's summary).
    foreach (element_children($element) as $key) {
      if ($key != 'value') {
        $element[$key]['#access'] = FALSE;
      }
    }
  }

802 803 804
  return $element;
}

805
/**
806
 * Render API callback: Hides the field value of 'text_format' elements.
807
 *
808 809 810
 * To not break form processing and previews if a user does not have access to
 * a stored text format, the expanded form elements in filter_process_format()
 * are forced to take over the stored #default_values for 'value' and 'format'.
811 812 813 814 815 816 817 818 819 820
 * However, to prevent the unfiltered, original #value from being displayed to
 * the user, we replace it with a friendly notice here.
 *
 * @see filter_process_format()
 */
function filter_form_access_denied($element) {
  $element['#value'] = t('This field has been disabled because you do not have sufficient permissions to edit it.');
  return $element;
}

821
/**
822
 * Returns HTML for a text format-enabled form element.
823
 *
824
 * @param array $variables
825
 *   An associative array containing:
826
 *   - element: A render element containing #children and #description.
827 828 829 830 831
 *
 * @ingroup themeable
 */
function theme_text_format_wrapper($variables) {
  $element = $variables['element'];
832
  $output = '<div class="text-format-wrapper form-item">';
833 834 835 836 837 838 839
  $output .= $element['#children'];
  if (!empty($element['#description'])) {
    $output .= '<div class="description">' . $element['#description'] . '</div>';
  }
  $output .= "</div>\n";

  return $output;
Dries's avatar
Dries committed
840 841 842
}

/**
843
 * Checks if a user has access to a particular text format.
844 845
 *
 * @param $format
846
 *   An object representing the text format.
847 848
 * @param $account
 *   (optional) The user account to check access for; if omitted, the currently
849
 *   logged-in user is used. Defaults to NULL.
850 851 852
 *
 * @return
 *   Boolean TRUE if the user is allowed to access the given format.
Dries's avatar
Dries committed
853
 */
854
function filter_access($format, $account = NULL) {
855 856 857
  global $user;
  if (!isset($account)) {
    $account = $user;
Dries's avatar
Dries committed
858
  }
859
  // Handle special cases up front. All users have access to the fallback
860 861
  // format.
  if ($format->format == filter_fallback_format()) {
862
    return TRUE;
Dries's avatar
Dries committed
863
  }
864 865 866 867
  // Check the permission if one exists; otherwise, we have a non-existent
  // format so we return FALSE.
  $permission = filter_permission_name($format);
  return !empty($permission) && user_access($permission, $account);
Dries's avatar
Dries committed
868
}
869

Dries's avatar
Dries committed
870
/**
871 872 873 874 875 876 877 878 879 880 881 882 883 884
 * Retrieves the filter tips.
 *
 * @param $format_id
 *   The ID of the text format for which to retrieve tips, or -1 to return tips
 *   for all formats accessible to the current user.
 * @param $long
 *   (optional) Boolean indicating whether the long form of tips should be
 *   returned. Defaults to FALSE.
 *
 * @return
 *   An associative array of filtering tips, keyed by filter name. Each
 *   filtering tip is an associative array with elements:
 *   - tip: Tip text.
 *   - id: Filter ID.
Dries's avatar
Dries committed
885
 */
886
function _filter_tips($format_id, $long = FALSE) {
887 888 889
  global $user;

  $formats = filter_formats($user);
Dries's avatar
Dries committed
890 891 892

  $tips = array();

893
  // If only listing one format, extract it from the $formats array.
894 895
  if ($format_id != -1) {
    $formats = array($formats[$format_id]);
896 897
  }

Dries's avatar
Dries committed
898 899
  foreach ($formats as $format) {
    $filters = filter_list_format($format->format);
900
    foreach ($filters as $name => $filter) {
901 902
      if ($filter->status) {
        $tip = $filter->tips($long);
903 904 905
        if (isset($tip)) {
          $tips[$format->name][$name] = array('tip' => $tip, 'id' => $name);
        }
Dries's avatar
Dries committed
906 907 908 909 910 911 912
      }
    }
  }

  return $tips;
}

913 914 915
/**
 * Parses an HTML snippet and returns it as a DOM object.
 *
916 917 918 919
 * This function loads the body part of a partial (X)HTML document and returns
 * a full DOMDocument object that represents this document. You can use
 * filter_dom_serialize() to serialize this DOMDocument back to a XHTML
 * snippet.
920
 *
921
 * @param $text
922 923 924
 *   The partial (X)HTML snippet to load. Invalid markup will be corrected on
 *   import.<