Newer
Older
<?php
Jennifer Hodgdon
committed
* Framework for handling the filtering of content.
Angie Byron
committed
use Drupal\Core\Cache\CacheBackendInterface;
use Drupal\Core\Language\Language;
use Drupal\Core\Template\Attribute;
Angie Byron
committed
use Drupal\filter\Plugin\Core\Entity\FilterFormat;
Angie Byron
committed
/**
* Non-HTML markup language filters that generate HTML.
*
* @todo Move into \Drupal\filter\Plugin\Filter\FilterInterface
Angie Byron
committed
*/
const FILTER_TYPE_MARKUP_LANGUAGE = 0;
/**
* HTML tag and attribute restricting filters.
*
* @todo Move into \Drupal\filter\Plugin\Filter\FilterInterface
Angie Byron
committed
*/
const FILTER_TYPE_HTML_RESTRICTOR = 1;
/**
* Reversible transformation filters.
*
* @todo Move into \Drupal\filter\Plugin\Filter\FilterInterface
Angie Byron
committed
*/
const FILTER_TYPE_TRANSFORM_REVERSIBLE = 2;
/**
* Irreversible transformation filters.
*
* @todo Move into \Drupal\filter\Plugin\Filter\FilterInterface
Angie Byron
committed
*/
const FILTER_TYPE_TRANSFORM_IRREVERSIBLE = 3;
Dries Buytaert
committed
* Implements hook_help().
Gábor Hojtsy
committed
function filter_help($path, $arg) {
switch ($path) {
Dries Buytaert
committed
case 'admin/help#filter':
Angie Byron
committed
$output = '';
$output .= '<h3>' . t('About') . '</h3>';
$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>';
Angie Byron
committed
$output .= '<h3>' . t('Uses') . '</h3>';
$output .= '<dl>';
Angie Byron
committed
$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>';
Angie Byron
committed
$output .= '<dt>' . t('Applying filters to text') . '</dt>';
Angie Byron
committed
$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>';
Angie Byron
committed
$output .= '<dt>' . t('Defining text formats') . '</dt>';
Angie Byron
committed
$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>';
Angie Byron
committed
$output .= '<dt>' . t('Choosing a text format') . '</dt>';
$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>';
Angie Byron
committed
$output .= '</dl>';
Dries Buytaert
committed
return $output;
Dries Buytaert
committed
case 'admin/config/content/formats':
Angie Byron
committed
$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>';
Dries Buytaert
committed
$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>';
return $output;
Dries Buytaert
committed
case 'admin/config/content/formats/manage/%':
Dries Buytaert
committed
$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>';
return $output;
Steven Wittens
committed
}
}
Dries Buytaert
committed
/**
Dries Buytaert
committed
* Implements hook_theme().
Dries Buytaert
committed
*/
function filter_theme() {
return array(
'filter_tips' => array(
'variables' => array('tips' => NULL, 'long' => FALSE),
'file' => 'filter.pages.inc',
Dries Buytaert
committed
),
'text_format_wrapper' => array(
'render element' => 'element',
),
Angie Byron
committed
'filter_guidelines' => array(
'variables' => array('format' => NULL),
Angie Byron
committed
'filter_html_image_secure_image' => array(
'variables' => array('image' => NULL),
),
'filter_caption' => array(
'variables' => array(
'node' => NULL,
'tag' => NULL,
'caption' => NULL,
'align' => NULL,
),
'template' => 'filter-caption',
)
Dries Buytaert
committed
);
}
/**
* Implements hook_element_info().
*
* @see filter_process_format()
Jennifer Hodgdon
committed
* @see text_format_wrapper()
*/
function filter_element_info() {
$type['text_format'] = array(
'#process' => array('filter_process_format'),
'#base_type' => 'textarea',
'#theme_wrappers' => array('text_format_wrapper'),
);
return $type;
}
Dries Buytaert
committed
* Implements hook_menu().
Dries Buytaert
committed
function filter_menu() {
Dries Buytaert
committed
$items['filter/tips'] = array(
'title' => 'Compose tips',
'type' => MENU_SUGGESTED_ITEM,
Alex Pott
committed
'route_name' => 'filter_tips_all',
Dries Buytaert
committed
);
$items['filter/tips/%filter_format'] = array(
'title' => 'Compose tips',
Alex Pott
committed
'route_name' => 'filter_tips',
);
$items['admin/config/content/formats'] = array(
Dries Buytaert
committed
'title' => 'Text formats',
'description' => 'Configure how content input by users is filtered, including allowed HTML tags. Also allows enabling of module-provided filters.',
'route_name' => 'filter_admin_overview',
Dries Buytaert
committed
);
$items['admin/config/content/formats/list'] = array(
'title' => 'List',
Dries Buytaert
committed
'type' => MENU_DEFAULT_LOCAL_TASK,
);
$items['admin/config/content/formats/add'] = array(
'route_name' => 'filter_format_add',
'type' => MENU_SIBLING_LOCAL_TASK,
Dries Buytaert
committed
);
$items['admin/config/content/formats/manage/%'] = array(
'title callback' => 'entity_page_label',
'title arguments' => array(5),
'route_name' => 'filter_format_edit',
Dries Buytaert
committed
);
$items['admin/config/content/formats/manage/%/disable'] = array(
Dries Buytaert
committed
'title' => 'Disable text format',
'route_name' => 'filter_admin_disable',
Dries Buytaert
committed
);
return $items;
}
Dries Buytaert
committed
/**
Jennifer Hodgdon
committed
* Loads a text format object from the database.
Dries Buytaert
committed
*
* @param $format_id
Dries Buytaert
committed
* The format ID.
*
* @return
Angie Byron
committed
* 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
Dries Buytaert
committed
* has been marked as disabled, NULL is returned.
Angie Byron
committed
*
* @see filter_format_exists()
*
* @todo Use entity_load().
Dries Buytaert
committed
*/
function filter_format_load($format_id) {
$formats = filter_formats();
Dries Buytaert
committed
return isset($formats[$format_id]) ? $formats[$format_id] : NULL;
Angie Byron
committed
/**
* 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) {
Angie Byron
committed
return entity_load('filter_format', $format_id);
Angie Byron
committed
}
Dries Buytaert
committed
* Implements hook_permission().
function filter_permission() {
$perms['administer filters'] = array(
Dries Buytaert
committed
'title' => t('Administer text formats and filters'),
Angie Byron
committed
'description' => t('Define how text is handled by combining filters into <a href="@url">text formats</a>.', array(
'@url' => url('admin/config/content/formats'),
)),
Dries Buytaert
committed
'restrict access' => TRUE,
);
// 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.
$format_name_replacement = user_access('administer filters') ? l($format->name, 'admin/config/content/formats/manage/' . $format->format) : drupal_placeholder($format->name);
$perms[$permission] = array(
'title' => t("Use the !text_format text format", array('!text_format' => $format_name_replacement,)),
Dries Buytaert
committed
'description' => drupal_placeholder(t('Warning: This permission may have security implications depending on how the text format is configured.')),
);
}
}
return $perms;
}
/**
* Returns the machine-readable permission name for a provided text format.
*
* @param $format
* An object representing a text format.
Jennifer Hodgdon
committed
*
* @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;
Jennifer Hodgdon
committed
* Retrieves a list of text formats, ordered by weight.
Dries Buytaert
committed
*
* @param $account
* (optional) If provided, only those formats that are allowed for this user
Jennifer Hodgdon
committed
* account will be returned. All formats will be returned otherwise. Defaults
* to NULL.
Jennifer Hodgdon
committed
*
Dries Buytaert
committed
* @return
* An array of text format objects, keyed by the format ID and ordered by
* weight.
*
* @see filter_formats_reset()
function filter_formats($account = NULL) {
$language_interface = language(Language::TYPE_INTERFACE);
Dries Buytaert
committed
$formats = &drupal_static(__FUNCTION__, array());
Steven Wittens
committed
// All available formats are cached for performance.
if (!isset($formats['all'])) {
if ($cache = cache()->get("filter_formats:{$language_interface->id}")) {
$formats['all'] = $cache->data;
}
else {
Angie Byron
committed
$filter_formats = entity_load_multiple('filter_format');
$formats['all'] = array();
foreach ($filter_formats as $format_name => $filter_format) {
if ($filter_format->status()) {
Angie Byron
committed
$formats['all'][$format_name] = $filter_format;
}
}
uasort($formats['all'], 'Drupal\Core\Config\Entity\ConfigEntityBase::sort');
cache()->set("filter_formats:{$language_interface->id}", $formats['all'], CacheBackendInterface::CACHE_PERMANENT, array('filter_formats' => TRUE));
Dries Buytaert
committed
}
Steven Wittens
committed
// 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;
Steven Wittens
committed
}
}
}
return isset($account) ? $formats['user'][$account->uid] : $formats['all'];
}
Steven Wittens
committed
/**
Jennifer Hodgdon
committed
* Resets the text format caches.
*
* @see filter_formats()
*/
function filter_formats_reset() {
cache()->deleteTags(array('filter_formats' => TRUE));
cache()->delete('filter_list_format');
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.
Jennifer Hodgdon
committed
*
* @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()) {
return user_role_names();
Steven Wittens
committed
}
// Do not list any roles if the permission does not exist.
$permission = filter_permission_name($format);
return !empty($permission) ? user_role_names(FALSE, $permission) : array();
}
/**
* Retrieves a list of text formats that are allowed for a given role.
*
* @param $rid
* The user role ID to retrieve text formats for.
Jennifer Hodgdon
committed
*
* @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;
}
Dries Buytaert
committed
}
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
Jennifer Hodgdon
committed
* user. Defaults to NULL.
Jennifer Hodgdon
committed
*
* @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.
$formats = filter_formats($account);
$format = reset($formats);
return $format->format;
}
Angie Byron
committed
/**
* 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) {
if ($filter->status) {
$filter_types[] = $filter->getType();
Angie Byron
committed
}
}
return array_unique($filter_types);
}
Dries Buytaert
committed
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
/**
* Retrieve all HTML restrictions (tags and attributes) for a given text format.
*
* Note that restrictions applied to the "*" tag (the wildcard tag, i.e. all
* tags) are treated just like any other HTML tag. That means that any
* restrictions applied to it are not automatically applied to all other tags.
* It is up to the caller to handle this in whatever way it sees fit; this way
* no information granularity is lost.
*
* @param string $format_id
* A text format ID.
*
* @return array|FALSE
* An structured array as returned by FilterInterface::getHTMLRestrictions(),
* but with the intersection of all filters in this text format.
* Will either indicate blacklisting of tags or whitelisting of tags. In the
* latter case, it's possible that restrictions on attributes are also stored.
* FALSE means there are no HTML restrictions.
*/
function filter_get_html_restrictions_by_format($format_id) {
$format = filter_format_load($format_id);
// Ignore filters that are disabled or don't have HTML restrictions.
$filters = array_filter($format->filters()->getAll(), function($filter) {
if (!$filter->status) {
return FALSE;
}
if ($filter->getType() === FILTER_TYPE_HTML_RESTRICTOR && $filter->getHTMLRestrictions() !== FALSE) {
return TRUE;
}
return FALSE;
});
if (empty($filters)) {
return FALSE;
}
else {
// From the set of remaining filters (they were filtered by array_filter()
// above), collect the list of tags and attributes that are allowed by all
// filters, i.e. the intersection of all allowed tags and attributes.
$restrictions = array_reduce($filters, function($restrictions, $filter) {
$new_restrictions = $filter->getHTMLRestrictions();
// The first filter with HTML restrictions provides the initial set.
if (!isset($restrictions)) {
return $new_restrictions;
}
// Subsequent filters with an "allowed html" setting must be intersected
// with the existing set, to ensure we only end up with the tags that are
// allowed by *all* filters with an "allowed html" setting.
else {
// Track the union of forbidden (blacklisted) tags.
if (isset($new_restrictions['forbidden_tags'])) {
if (!isset($restrictions['forbidden_tags'])) {
$restrictions['forbidden_tags'] = $new_restrictions['forbidden_tags'];
}
else {
$restrictions['forbidden_tags'] = array_unique(array_merge($restrictions['forbidden_tags'], $new_restrictions['forbidden_tags']));
}
}
// Track the intersection of allowed (whitelisted) tags.
if (isset($restrictions['allowed'])) {
$intersection = $restrictions['allowed'];
foreach ($intersection as $tag => $attributes) {
// If the current tag is not whitelisted by the new filter, then
// it's outside of the intersection.
if (!array_key_exists($tag, $new_restrictions['allowed'])) {
// The exception is the asterisk (which applies to all tags): it
// does not need to be whitelisted by every filter in order to be
// used; not every filter needs attribute restrictions on all tags.
if ($tag === '*') {
continue;
}
unset($intersection[$tag]);
}
// The tag is in the intersection, but now we must calculate the
// intersection of the allowed attributes.
else {
$current_attributes = $intersection[$tag];
$new_attributes = $new_restrictions['allowed'][$tag];
// The current intersection does not allow any attributes, never
// allow.
if (!is_array($current_attributes) && $current_attributes == FALSE) {
continue;
}
// The new filter allows less attributes (all -> list or none).
else if (!is_array($current_attributes) && $current_attributes == TRUE && ($new_attributes == FALSE || is_array($new_attributes))) {
$intersection[$tag] = $new_attributes;
}
// The new filter allows less attributes (list -> none).
else if (is_array($current_attributes) && $new_attributes == FALSE) {
$intersection[$tag] = $new_attributes;
}
// The new filter allows more attributes; retain current.
else if (is_array($current_attributes) && $new_attributes == TRUE) {
continue;
}
// The new filter allows the same attributes; retain current.
else if ($current_attributes == $new_attributes) {
continue;
}
// Both list an array of attribute values; do an intersection,
// where we take into account that a value of:
// - TRUE means the attribute value is allowed;
// - FALSE means the attribute value is forbidden;
// hence we keep the ANDed result.
else {
$intersection[$tag] = array_intersect_key($intersection[$tag], $new_attributes);
foreach (array_keys($intersection[$tag]) as $attribute_value) {
$intersection[$tag][$attribute_value] = $intersection[$tag][$attribute_value] && $new_attributes[$attribute_value];
}
}
}
}
$restrictions['allowed'] = $intersection;
}
return $restrictions;
}
}, NULL);
// Simplification: if we have both a (intersected) whitelist and a (unioned)
// blacklist, then remove any tags from the whitelist that also exist in the
// blacklist. Now the whitelist alone expresses all tag-level restrictions,
// and we can delete the blacklist.
if (isset($restrictions['allowed']) && isset($restrictions['forbidden_tags'])) {
foreach ($restrictions['forbidden_tags'] as $tag) {
if (isset($restrictions['allowed'][$tag])) {
unset($restrictions['allowed'][$tag]);
}
}
unset($restrictions['forbidden_tags']);
}
// Simplification: if the only remaining allowed tag is the asterisk (which
// contains attribute restrictions that apply to all tags), and only
// whitelisting filters were used, then effectively nothing is allowed.
if (isset($restrictions['allowed'])) {
if (count($restrictions['allowed']) === 1 && array_key_exists('*', $restrictions['allowed']) && !isset($restrictions['forbidden_tags'])) {
$restrictions['allowed'] = array();
}
}
return $restrictions;
}
}
/**
* Returns the ID of the fallback text format that all users have access to.
*
* 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
Dries Buytaert
committed
* disabled. It needs to exist because any user who has permission to create
* 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.
*
Jennifer Hodgdon
committed
* 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.
*
Jennifer Hodgdon
committed
* Any modules implementing a format deletion functionality must not delete this
* format.
Dries Buytaert
committed
*
Jennifer Hodgdon
committed
* @return
* The ID of the fallback text format.
*
Dries Buytaert
committed
* @see hook_filter_format_disable()
* @see filter_default_format()
*/
function filter_fallback_format() {
// This variable is automatically set in the database for all installations
Dries Buytaert
committed
// of Drupal. In the event that it gets disabled or deleted somehow, there
Angie Byron
committed
// is no safe default to return, since we do not want to risk making an
Dries Buytaert
committed
// existing (and potentially unsafe) text format on the site automatically
// available to all users. Returning NULL at least guarantees that this
// cannot happen.
catch
committed
return config('filter.settings')->get('fallback_format');
}
Jennifer Hodgdon
committed
* Checks if the text in a certain text format is allowed to be cached.
Dries Buytaert
committed
*
* 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.
Jennifer Hodgdon
committed
*
Dries Buytaert
committed
* @return
* TRUE if the given text format allows caching, FALSE otherwise.
function filter_format_allowcache($format_id) {
Dries Buytaert
committed
$format = filter_format_load($format_id);
return !empty($format->cache);
}
Steven Wittens
committed
/**
Jennifer Hodgdon
committed
* Retrieves a list of filters for a given text format.
Dries Buytaert
committed
*
Dries Buytaert
committed
* 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.
*
* @param $format_id
Dries Buytaert
committed
* The format ID to retrieve filters for.
Dries Buytaert
committed
* @return
Dries Buytaert
committed
* An array of filter objects associated to the given text format, keyed by
* filter name.
*
* @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().
Steven Wittens
committed
*/
function filter_list_format($format_id) {
Dries Buytaert
committed
$filters = &drupal_static(__FUNCTION__, array());
Steven Wittens
committed
Dries Buytaert
committed
if (!isset($filters['all'])) {
Dries Buytaert
committed
if ($cache = cache()->get('filter_list_format')) {
$filters['all'] = $cache->data;
}
else {
$filters['all'] = array();
Angie Byron
committed
$filter_formats = filter_formats();
foreach ($filter_formats as $filter_format) {
// 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();
Dries Buytaert
committed
cache()->set('filter_list_format', $filters['all']);
Dries Buytaert
committed
}
}
if (!isset($filters[$format_id]) && isset($filters['all'][$format_id])) {
$filters[$format_id] = $filters['all'][$format_id];
return isset($filters[$format_id]) ? $filters[$format_id] : array();
}
Steven Wittens
committed
/**
Jennifer Hodgdon
committed
* Runs all the enabled filters on a piece of text.
*
* Note: Because filters can inject JavaScript or execute PHP code, security is
* 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
Jennifer Hodgdon
committed
* validation stage of the Form API. You should for example never make a
* preview of content in a disallowed format.
*
* @param $text
* @param $format_id
Jennifer Hodgdon
committed
* (optional) The format ID of the text to be filtered. If no format is
* assigned, the fallback format will be used. Defaults to NULL.
Dries Buytaert
committed
* @param $langcode
Jennifer Hodgdon
committed
* (optional) The language code of the text to be filtered, e.g. 'en' for
* English. This allows filters to be language aware so language specific
Jennifer Hodgdon
committed
* text replacement can be implemented. Defaults to an empty string.
Dries Buytaert
committed
* @param $cache
Jennifer Hodgdon
committed
* (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.
Angie Byron
committed
* @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.
Dries Buytaert
committed
*
Jennifer Hodgdon
committed
* @return
* The filtered text.
*
Dries Buytaert
committed
* @ingroup sanitization
Angie Byron
committed
function check_markup($text, $format_id = NULL, $langcode = '', $cache = FALSE, $filter_types_to_skip = array()) {
if (!isset($format_id)) {
$format_id = filter_fallback_format();
}
Dries Buytaert
committed
// If the requested text format does not exist, the text cannot be filtered.
if (!$format = filter_format_load($format_id)) {
Angie Byron
committed
watchdog('filter', 'Missing text format: %format.', array('%format' => $format_id), WATCHDOG_ALERT);
Dries Buytaert
committed
return '';
}
Steven Wittens
committed
Angie Byron
committed
// 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;
}
Angie Byron
committed
// Check for a cached version of this piece of text.
Dries Buytaert
committed
$cache = $cache && !empty($format->cache);
Angie Byron
committed
if ($cache) {
Dries Buytaert
committed
$cache_id = $format->format . ':' . $langcode . ':' . hash('sha256', $text);
Dries Buytaert
committed
if ($cached = cache('filter')->get($cache_id)) {
Angie Byron
committed
return $cached->data;
}
Angie Byron
committed
}
Dries Buytaert
committed
Angie Byron
committed
// 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);
Angie Byron
committed
// Get a complete list of filters, ordered properly.
$filters = filter_list_format($format->format);
Angie Byron
committed
// Give filters the chance to escape HTML-like data such as code or formulas.
foreach ($filters as $filter) {
Angie Byron
committed
// If necessary, skip filters of a certain type.
if (in_array($filter->getType(), $filter_types_to_skip)) {
Angie Byron
committed
continue;
}
if ($filter->status) {
$text = $filter->prepare($text, $langcode, $cache, $cache_id);
}
Angie Byron
committed
}
Angie Byron
committed
// Perform filtering.
foreach ($filters as $filter) {
Angie Byron
committed
// If necessary, skip filters of a certain type.
if (in_array($filter->getType(), $filter_types_to_skip)) {
Angie Byron
committed
continue;
}
if ($filter->status) {
$text = $filter->process($text, $langcode, $cache, $cache_id);
Angie Byron
committed
Dries Buytaert
committed
// 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.
// @see \Drupal\filter\Plugin\Core\Entity\FilterFormat::save()
Angie Byron
committed
if ($cache) {
cache('filter')->set($cache_id, $text, CacheBackendInterface::CACHE_PERMANENT, array('filter_format' => $format->format));
* Expands an element into a base element with text format selector attached.
*
* The form element will be expanded into two separate form elements, one
Jennifer Hodgdon
committed
* 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.
* - format: Holds the text format details and the text format selection,
Jennifer Hodgdon
committed
* 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:
* @code
Dries Buytaert
committed
* $form_state['values']['body']['value'] = 'foo';
* $form_state['values']['body']['format'] = 'foo';
* @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.
Jennifer Hodgdon
committed
* - #format: (optional) The text format ID to preselect. If NULL or not set,
Angie Byron
committed
* the default format for the current user will be used.
Dries Buytaert
committed
*
* The expanded element.
function filter_process_format($element) {
global $user;
// 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',
);
// Move this element into sub-element 'value'.
unset($element['value']);
foreach (element_properties($element) as $key) {
if (!in_array($key, $blacklist)) {
$element['value'][$key] = $element[$key];
}
}
$element['value']['#type'] = $element['#base_type'];
$element['value'] += element_info($element['#base_type']);
// Turn original element into a text format wrapper.
$element['#attached']['library'][] = array('filter', 'drupal.filter');
// Setup child container for the text format widget.
$element['format'] = array(
'#type' => 'container',
'#attributes' => array('class' => array('filter-wrapper')),
Angie Byron
committed
);
Angie Byron
committed
// 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]);
}
}
// Prepare text format guidelines.
$element['format']['guidelines'] = array(
'#type' => 'container',
'#attributes' => array('class' => array('filter-guidelines')),
'#weight' => 20,
);
foreach ($formats as $format) {
$options[$format->format] = $format->name;
$element['format']['guidelines'][$format->format] = array(
'#theme' => 'filter_guidelines',
'#format' => $format,
Angie Byron
committed
);
$element['format']['format'] = array(
'#type' => 'select',
'#title' => t('Text format'),
'#options' => $options,
'#default_value' => $element['#format'],
'#access' => count($formats) > 1,
'#weight' => 10,
'#attributes' => array('class' => array('filter-list')),
'#parents' => array_merge($element['#parents'], array('format')),
$element['format']['help'] = array(
'#type' => 'container',
'#attributes' => array('class' => array('filter-help')),
catch
committed
'#markup' => l(t('More information about text formats'), 'filter/tips', array('attributes' => array('target' => '_blank'))),
'#weight' => 0,
Dries Buytaert
committed
$all_formats = filter_formats();
Angie Byron
committed
$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) {
Dries Buytaert
committed
$element['format']['format']['#required'] = TRUE;
Angie Byron
committed
$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) {
Dries Buytaert
committed
// 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.
Angie Byron
committed
$element['value'] += array('#pre_render' => array());
Dries Buytaert
committed
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;
catch
committed
$element['value']['#resizable'] = 'none';
Dries Buytaert
committed
// 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;
}
}
}
return $element;
}
Dries Buytaert
committed
/**
Jennifer Hodgdon
committed
* Render API callback: Hides the field value of 'text_format' elements.
Dries Buytaert
committed
*
Jennifer Hodgdon
committed
* 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'.
Dries Buytaert
committed
* 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;
}
/**
* Returns HTML for a text format-enabled form element.
*
Jennifer Hodgdon
committed
* @param array $variables
* An associative array containing:
* - element: A render element containing #children and #description.
*
* @ingroup themeable
*/
function theme_text_format_wrapper($variables) {
$element = $variables['element'];
$output = '<div class="text-format-wrapper form-item">';
$output .= $element['#children'];
if (!empty($element['#description'])) {
$output .= '<div class="description">' . $element['#description'] . '</div>';
}
$output .= "</div>\n";
return $output;
* Checks if a user has access to a particular text format.
Dries Buytaert
committed
*
* @param $format
* An object representing the text format.
Dries Buytaert
committed
* @param $account
* (optional) The user account to check access for; if omitted, the currently
Jennifer Hodgdon
committed
* logged-in user is used. Defaults to NULL.
Dries Buytaert
committed
*
* @return
* Boolean TRUE if the user is allowed to access the given format.
Dries Buytaert
committed
function filter_access($format, $account = NULL) {
global $user;
if (!isset($account)) {
$account = $user;
// Handle special cases up front. All users have access to the fallback
Dries Buytaert
committed
// format.
if ($format->format == filter_fallback_format()) {
return TRUE;
// 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 Buytaert
committed
Jennifer Hodgdon
committed
* 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.