' . t("The filter module allows administrators to configure text formats for use on your site. A text format defines the HTML tags, codes, and other input allowed in both content and comments, and is a key feature in guarding against potentially damaging input from malicious users. Two formats included by default are Filtered HTML (which allows only an administrator-approved subset of HTML tags) and Full HTML (which allows the full set of HTML tags). Additional formats may be created by an administrator.") . '
'; $output .= '' . 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 of a post, but instead, modifies it temporarily before it is displayed. A filter may remove unapproved HTML tags, for instance, while another automatically adds HTML to make links referenced in text clickable.') . '
'; - $output .= '' . t('Users with access to more than one text format can use the Text format fieldset to choose between available text formats when creating or editing multi-line content. Administrators determine the text formats available to each user role, select a default text format, and control the order of formats listed in the Text format fieldset.') . '
'; + $output .= '' . t('Users with access to more than one text format can use the Text format fieldset to choose between available text formats when creating or editing multi-line content. Administrators determine the text formats available to each user role and control the order of formats listed in the Text format fieldset.') . '
'; $output .= '' . t('For more information, see the online handbook entry for Filter module.', array('@filter' => 'http://drupal.org/handbook/modules/filter/')) . '
'; return $output; case 'admin/settings/formats': - $output = '' . t('Use the list below to review the text formats available to each user role, to select a default text format, and to control the order of formats listed in the Text format fieldset. (The Text format fieldset is displayed below textareas when users with access to more than one text format create multi-line content.) The text format selected as Default is available to all users and, unless another format is selected, is applied to all content. All text formats are available to users in roles with the "administer filters" permission.') . '
'; - $output .= '' . t('Since text formats, if available, are presented in the same order as the list below, it may be helpful to arrange the formats in descending order of your preference for their use. Remember that your changes will not be saved until you click the Save changes button at the bottom of the page.') . '
'; + $output = '' . t('Use the list below to review the text formats available to each user role and to control the order of formats listed in the Text format fieldset. (The Text format fieldset is displayed below textareas when users with access to more than one text format create multi-line content.) All text formats are available to users in roles with the "administer filters" permission, and the special %fallback format is available to all users. You can configure access to other text formats on the permissions page.', array('%fallback' => filter_fallback_format_title(), '@url' => url('admin/config/people/permissions', array('fragment' => 'module-filter')))) . '
'; + $output .= '' . t('Since text formats, if available, are presented in the same order as the list below, and the default format for each user is the first one on the list for which that user has access, it may be helpful to arrange the formats in descending order of your preference for their use. Remember that your changes will not be saved until you click the Save changes button at the bottom of the page.') . '
'; return $output; case 'admin/settings/formats/%': return '' . t('Every filter 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 format. If you notice some filters are causing conflicts in the output, you can rearrange them.', array('@rearrange' => url('admin/settings/formats/' . $arg[3] . '/order'))) . '
'; @@ -140,8 +132,12 @@ function filter_menu() { return $items; } -function filter_format_load($arg) { - return filter_formats($arg); +/** + * Return the text format object corresponding to the provided format ID. + */ +function filter_format_load($id) { + $formats = filter_formats(); + return isset($formats[$id]) ? $formats[$id] : FALSE; } /** @@ -151,17 +147,6 @@ function filter_format_load($arg) { * A format object. */ function filter_format_save($format) { - // We store the roles as a string for ease of use. - // We should always set all roles to TRUE when saving the default format. - // We use leading and trailing comma's to allow easy substring matching. - $roles = array_filter($format->roles); - if ($format->format == variable_get('filter_default_format', 1)) { - $roles = ',' . implode(',', array_keys(user_roles())) . ','; - } - else { - $roles = ',' . implode(',',array_keys($roles)) . ','; - } - $format->roles = $roles; $format->name = trim($format->name); // Add a new text format. @@ -200,6 +185,7 @@ function filter_format_save($format) { module_invoke_all('filter_format_update', $format); } + filter_format_reset_cache(); cache_clear_all($format->format . ':', 'cache_filter', TRUE); return $status; @@ -220,9 +206,10 @@ function filter_format_delete($format) { ->execute(); // Allow modules to react on text format deletion. - $default = filter_format_load(variable_get('filter_default_format', 1)); - module_invoke_all('filter_format_delete', $format, $default); + $fallback = filter_format_load(filter_fallback_format()); + module_invoke_all('filter_format_delete', $format, $fallback); + filter_format_reset_cache(); cache_clear_all($format->format . ':', 'cache_filter', TRUE); } @@ -237,12 +224,44 @@ function filter_admin_format_title($form * Implement hook_permission(). */ function filter_permission() { - return array( - 'administer filters' => array( - 'title' => t('Administer filters'), - 'description' => t('Manage text formats and filters, and select which roles may use them. %warning', array('%warning' => t('Warning: Give to trusted roles only; this permission has security implications.'))), - ), - ); + $perms = array(); + $perms['administer filters'] = array( + 'title' => t('Administer filters'), + 'description' => t('Manage text formats and filters, and use any of them, without restriction, when entering or editing content. %warning', array('%warning' => t('Warning: Give to trusted roles only; this permission has security implications.'))), + ); + + // 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/settings/formats/' . $format->format) : theme('placeholder', $format->name); + $perms[$permission] = array( + 'title' => t("Use the '@text_format' text format", array('@text_format' => $format->name)), + 'description' => t('Use !text_format in forms when entering or editing content. %warning', array('!text_format' => $format_name_replacement, '%warning' => 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 the provided text format. + * + * @param $format + * An object representing the text format. + * @return + * The machine-readable permission name, or FALSE if the provided text format + * is either (a) malformed, or (b) the fallback format available to all users + * (and therefore not controlled by the permission system). + */ +function filter_permission_name($format) { + if (isset($format->format) && $format->format != filter_fallback_format()) { + return 'use text format ' . $format->format; + } + return FALSE; } /** @@ -375,45 +394,152 @@ function _filter_html_escape_tips() { /** * @} End of "Tips callback for filters". */ + /** - * Retrieve a list of text formats. + * Retrieve a list of text formats, ordered by weight. + * + * @param $account + * Optional. If provided, only those formats that are allowed for this user + * account will be returned. All formats will be returned otherwise. + * @param $reset + * This parameter is for internal use only; when set to TRUE, the function + * resets the internal cache of all text formats and returns immediately + * without retrieving any new formats. + * @return + * An array of text format objects, keyed by the format ID and ordered by + * weight. + * + * @see filter_format_reset_cache() */ -function filter_formats($index = NULL) { - global $user; - static $formats; - - // Administrators can always use all text formats. - $all = user_access('administer filters'); - - if (!isset($formats)) { +function filter_formats($account = NULL, $reset = FALSE) { + $formats = &drupal_static(__FUNCTION__, array()); + if ($reset) { $formats = array(); + return; + } + + // Check if we've already loaded format data before doing a query. + if (!isset($formats['all'])) { + $formats['all'] = db_query('SELECT * FROM {filter_format} ORDER BY weight')->fetchAllAssoc('format'); + } - $query = db_select('filter_format', 'f'); - $query->addField('f', 'format', 'format'); - $query->addField('f', 'name', 'name'); - $query->addField('f', 'roles', 'roles'); - $query->addField('f', 'cache', 'cache'); - $query->addField('f', 'weight', 'weight'); - $query->orderBy('weight'); - - // Build query for selecting the format(s) based on the user's roles. - if (!$all) { - $or = db_or()->condition('format', variable_get('filter_default_format', 1)); - foreach ($user->roles as $rid => $role) { - $or->condition('roles', '%' . (int)$rid . '%', 'LIKE'); + // Build a list of user-specific formats if not already set. + 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; } - $query->condition($or); } + } - $formats = $query->execute()->fetchAllAssoc('format'); + return isset($account) ? $formats['user'][$account->uid] : $formats['all']; +} + +/** + * Resets the static cache of all text formats. + */ +function filter_format_reset_cache() { + filter_formats(NULL, TRUE); +} + +/** + * Retrieves a list of roles that are allowed to use a particular text format. + * + * @param $format + * Either the format ID or format object that will be checked for access. + * @return + * An array of role names, keyed by role ID. + */ +function filter_format_roles($format) { + // Handle the fallback format up front (all roles have access to this + // format). + $format_id = isset($format->format) ? $format->format : $format; + if ($format_id == filter_fallback_format()) { + return user_roles(); } - if (isset($index)) { - return isset($formats[$index]) ? $formats[$index] : FALSE; + // Otherwise, retrieve the full format object if one was not provided. + if (!isset($format->format)) { + $format = filter_format_load($format); + } + // Don't list any roles if the permission doesn't exist. + $permission = filter_permission_name($format); + return !empty($permission) ? user_roles(FALSE, $permission) : array(); +} + +/** + * Retrieves a list of text formats that are allowed for a particular role. + * + * @param $rid + * The ID of the role to check. + * @return + * An array of text format objects that are allowed for the role, keyed by + * the format ID and ordered by weight. + */ +function filter_role_formats($rid) { + $formats = array(); + foreach (filter_formats() as $format) { + $roles = filter_format_roles($format); + if (isset($roles[$rid])) { + $formats[$format->format] = $format; + } } 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 usually 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 as their + * 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 current logged-in + * user. + * @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); + $first_format = array_shift($formats); + return $first_format->format; +} + +/** + * Returns the ID of the fallback text format that all users have access to. + */ +function filter_fallback_format() { + return variable_get('filter_fallback_format'); +} + +/** + * Returns the title of the fallback text format. + */ +function filter_fallback_format_title() { + $fallback_format = filter_format_load(filter_fallback_format()); + return filter_admin_format_title($fallback_format); +} + +/** * Return a list of all filters provided by modules. */ function filter_get_filters() { @@ -443,17 +569,10 @@ function _filter_list_cmp($a, $b) { } /** - * Resolve a format id, including the default format. - */ -function filter_resolve_format($format) { - return $format == FILTER_FORMAT_DEFAULT ? variable_get('filter_default_format', 1) : $format; -} -/** * Check if text in a certain text format is allowed to be cached. */ function filter_format_allowcache($format) { static $cache = array(); - $format = filter_resolve_format($format); if (!isset($cache[$format])) { $cache[$format] = db_query('SELECT cache FROM {filter_format} WHERE format = :format', array(':format' => $format))->fetchField(); } @@ -502,8 +621,8 @@ function filter_list_format($format) { * @param $text * The text to be filtered. * @param $format - * The format of the text to be filtered. Specify FILTER_FORMAT_DEFAULT for - * the default format. + * The format of the text to be filtered. If no format is assigned, the + * fallback format will be used. * @param $langcode * 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 @@ -513,8 +632,10 @@ function filter_list_format($format) { * The caller may set this to FALSE when the output is already cached * elsewhere to avoid duplicate cache lookups and storage. */ -function check_markup($text, $format = FILTER_FORMAT_DEFAULT, $langcode = '', $cache = TRUE) { - $format = filter_resolve_format($format); +function check_markup($text, $format = NULL, $langcode = '', $cache = TRUE) { + if (empty($format)) { + $format = filter_fallback_format(); + } // Check for a cached version of this piece of text. $cache_id = $format . ':' . $langcode . ':' . md5($text); @@ -565,9 +686,16 @@ function check_markup($text, $format = F * @return * HTML for the form element. */ -function filter_form($value = FILTER_FORMAT_DEFAULT, $weight = NULL, $parents = array('format')) { - $value = filter_resolve_format($value); - $formats = filter_formats(); +function filter_form($value = NULL, $weight = NULL, $parents = array('format')) { + global $user; + + // Use the default format for this user if none was selected. + if (empty($value)) { + $value = filter_default_format($user); + } + + // Get a list of formats that the current user has access to. + $formats = filter_formats($user); drupal_add_js('misc/form.js'); drupal_add_css(drupal_get_path('module', 'filter') . '/filter.css'); @@ -610,17 +738,35 @@ function filter_form($value = FILTER_FOR } /** - * Returns TRUE if the user is allowed to access this format. + * Checks if a user has access to a particular text format. + * + * @param $format + * Either the format ID or format object that will be checked for access. + * @param $account + * The user object that access will be checked against. Defaults to the + * current logged-in user. + * @return + * Boolean TRUE if the user has access to the requested format. */ -function filter_access($format) { - $format = filter_resolve_format($format); - if (user_access('administer filters') || ($format == variable_get('filter_default_format', 1))) { - return TRUE; +function filter_access($format, $account = NULL) { + global $user; + if (!isset($account)) { + $account = $user; } - else { - $formats = filter_formats(); - return isset($formats[$format]); + // Handle special cases up front. All users have access to the fallback + // format, and administrators have access to all formats. + $format_id = isset($format->format) ? $format->format : $format; + if (user_access('administer filters', $account) || $format_id == filter_fallback_format()) { + return TRUE; } + // Otherwise, retrieve the full format object if a format ID was provided. + if (!isset($format->format)) { + $format = filter_format_load($format); + } + // Check the permission if one exists; otherwise, we have a nonexistent + // format so we return FALSE. + $permission = filter_permission_name($format); + return !empty($permission) && user_access($permission, $account); } /** @@ -632,7 +778,9 @@ function filter_access($format) { * Helper function for fetching filter tips. */ function _filter_tips($format, $long = FALSE) { - $formats = filter_formats(); + global $user; + + $formats = filter_formats($user); $filter_info = filter_get_filters(); $tips = array(); Index: modules/node/node.install =================================================================== RCS file: /cvs/drupal/drupal/modules/node/node.install,v retrieving revision 1.28 diff -u -p -r1.28 node.install --- modules/node/node.install 22 Aug 2009 00:58:54 -0000 1.28 +++ modules/node/node.install 27 Aug 2009 04:12:12 -0000 @@ -519,7 +519,11 @@ function node_update_7006(&$context) { $revision->body = substr($revision->body, strlen($break)); } $node->body[FIELD_LANGUAGE_NONE][0]['value'] = $revision->body; - $node->body[FIELD_LANGUAGE_NONE][0]['format'] = $revision->format; + // Explicitly store the current default text format if the revision + // did not have its own text format. Similar conversions for other + // core modules are performed in filter_update_7004(), but we do this + // one here since we are already migrating the data. + $node->body[FIELD_LANGUAGE_NONE][0]['format'] = !empty($revision->format) ? $revision->format : variable_get('filter_default_format', 1); // This is a core update and no contrib modules are enabled yet, so // we can assume default field storage for a faster update. field_sql_storage_field_storage_write('node', $node, FIELD_STORAGE_INSERT, array()); Index: modules/php/php.install =================================================================== RCS file: /cvs/drupal/drupal/modules/php/php.install,v retrieving revision 1.10 diff -u -p -r1.10 php.install --- modules/php/php.install 21 Aug 2009 17:28:26 -0000 1.10 +++ modules/php/php.install 27 Aug 2009 04:12:12 -0000 @@ -19,7 +19,6 @@ function php_install() { $format = db_insert('filter_format') ->fields(array( 'name' => 'PHP code', - 'roles' => '', 'cache' => 0, )) ->execute(); Index: modules/profile/profile.module =================================================================== RCS file: /cvs/drupal/drupal/modules/profile/profile.module,v retrieving revision 1.271 diff -u -p -r1.271 profile.module --- modules/profile/profile.module 24 Aug 2009 00:14:21 -0000 1.271 +++ modules/profile/profile.module 27 Aug 2009 04:12:12 -0000 @@ -292,7 +292,7 @@ function profile_view_field($account, $f if (isset($account->{$field->name}) && $value = $account->{$field->name}) { switch ($field->type) { case 'textarea': - return check_markup($value); + return check_markup($value, filter_default_format($user)); case 'textfield': case 'selection': return $browse ? l($value, 'profile/' . $field->name . '/' . $value) : check_plain($value); Index: modules/simpletest/drupal_web_test_case.php =================================================================== RCS file: /cvs/drupal/drupal/modules/simpletest/drupal_web_test_case.php,v retrieving revision 1.144 diff -u -p -r1.144 drupal_web_test_case.php --- modules/simpletest/drupal_web_test_case.php 24 Aug 2009 00:14:21 -0000 1.144 +++ modules/simpletest/drupal_web_test_case.php 27 Aug 2009 04:12:12 -0000 @@ -728,7 +728,7 @@ class DrupalWebTestCase extends DrupalTe // Merge body field value and format separately. $body = array( 'value' => $this->randomName(32), - 'format' => FILTER_FORMAT_DEFAULT + 'format' => filter_default_format(), ); $settings['body'][FIELD_LANGUAGE_NONE][0] += $body; Index: modules/system/system.install =================================================================== RCS file: /cvs/drupal/drupal/modules/system/system.install,v retrieving revision 1.379 diff -u -p -r1.379 system.install --- modules/system/system.install 24 Aug 2009 00:14:22 -0000 1.379 +++ modules/system/system.install 27 Aug 2009 04:12:12 -0000 @@ -387,13 +387,27 @@ function system_install() { $query = db_insert('role_permission')->fields(array('rid', 'permission')); // Anonymous role permissions. - $query->values(array( - 'rid' => DRUPAL_ANONYMOUS_RID, - 'permission' => 'access content', - )); + $anonymous_permissions = array( + 'access content', + 'use text format 1', // Filtered HTML + ); + foreach ($anonymous_permissions as $permission) { + $query->values(array( + 'rid' => DRUPAL_ANONYMOUS_RID, + 'permission' => $permission, + )); + } // Authenticated role permissions. - foreach (array('access comments', 'access content', 'post comments', 'post comments without approval', 'view own unpublished content') as $permission) { + $authenticated_permissions = array( + 'access comments', + 'access content', + 'post comments', + 'post comments without approval', + 'view own unpublished content', + 'use text format 1', // Filtered HTML + ); + foreach ($authenticated_permissions as $permission) { $query->values(array( 'rid' => DRUPAL_AUTHENTICATED_RID, 'permission' => $permission, @@ -424,15 +438,22 @@ function system_install() { $filtered_html_format = db_insert('filter_format') ->fields(array( 'name' => 'Filtered HTML', - 'roles' => ',' . DRUPAL_ANONYMOUS_RID . ',' . DRUPAL_AUTHENTICATED_RID . ',', 'cache' => 1, + 'weight' => 0, )) ->execute(); $full_html_format = db_insert('filter_format') ->fields(array( 'name' => 'Full HTML', - 'roles' => '', 'cache' => 1, + 'weight' => 0, + )) + ->execute(); + $plain_text_format = db_insert('filter_format') + ->fields(array( + 'name' => 'Plain text', + 'cache' => 1, + 'weight' => 1, )) ->execute(); @@ -491,10 +512,25 @@ function system_install() { 'name' => 'filter_htmlcorrector', 'weight' => 10, )) + // Plain text: + // Escape all HTML. + ->values(array( + 'format' => $plain_text_format, + 'module' => 'filter', + 'name' => 'filter_html_escape', + 'weight' => 0, + )) + // Line break filter. + ->values(array( + 'format' => $plain_text_format, + 'module' => 'filter', + 'name' => 'filter_autop', + 'weight' => 1, + )) ->execute(); - // Set the default input format to Filtered HTML. - variable_set('filter_default_format', $filtered_html_format); + // Set the fallback format to plain text. + variable_set('filter_fallback_format', $plain_text_format); $cron_key = md5(mt_rand()); @@ -2047,8 +2083,9 @@ function system_update_7021() { $ret[] = update_sql("UPDATE {block} SET region = 'sidebar_second' WHERE region = 'right'"); // Migrate contact form information. + $default_format = variable_get('filter_default_format', 1); if ($contact_help = variable_get('contact_form_information', '')) { - $bid = db_insert('box')->fields(array('body' => $contact_help, 'info' => 'Contact page help', 'format' => FILTER_FORMAT_DEFAULT))->execute(); + $bid = db_insert('box')->fields(array('body' => $contact_help, 'info' => 'Contact page help', 'format' => $default_format))->execute(); foreach ($themes_with_blocks as $theme) { // Add contact help block for themes, which had blocks. $ret[] = update_sql("INSERT INTO {block} (module, delta, theme, status, weight, region, visibility, pages, cache) VALUES ('block', '" . $bid . "', '" . $theme . "', 1, 5, 'help', 1, 'contact', -1)"); @@ -2058,7 +2095,7 @@ function system_update_7021() { // Migrate user help setting. if ($user_help = variable_get('user_registration_help', '')) { - $bid = db_insert('box')->fields(array('body' => $user_help, 'info' => 'User registration guidelines', 'format' => FILTER_FORMAT_DEFAULT))->execute(); + $bid = db_insert('box')->fields(array('body' => $user_help, 'info' => 'User registration guidelines', 'format' => $default_format))->execute(); foreach ($themes_with_blocks as $theme) { // Add user registration help block for themes, which had blocks. $ret[] = update_sql("INSERT INTO {block} (module, delta, theme, status, weight, region, visibility, pages, cache) VALUES ('block', '" . $bid . "', '" . $theme . "', 1, 5, 'help', 1, 'user/register', -1)"); @@ -2068,7 +2105,7 @@ function system_update_7021() { // Migrate site mission setting. if ($mission = variable_get('site_mission')) { - $bid = db_insert('box')->fields(array('body' => $mission, 'info' => 'Site mission', 'format' => FILTER_FORMAT_DEFAULT))->execute(); + $bid = db_insert('box')->fields(array('body' => $mission, 'info' => 'Site mission', 'format' => $default_format))->execute(); foreach ($themes_with_blocks as $theme) { // Add mission block for themes, which had blocks. $ret[] = update_sql("INSERT INTO {block} (module, delta, theme, status, weight, region, visibility, pages, cache) VALUES ('block', '" . $bid . "', '" . $theme . "', 1, 0, 'highlight', 1, '