filter.install 14.3 KB
Newer Older
1 2 3
<?php
// $Id$

4 5 6 7 8
/**
 * @file
 * Install, update and uninstall functions for the filter module.
 */

9
/**
10
 * Implements hook_schema().
11 12
 */
function filter_schema() {
13
  $schema['filter'] = array(
14
    'description' => 'Table that maps filters (HTML corrector) to text formats (Filtered HTML).',
15
    'fields' => array(
16 17 18 19
      'format' => array(
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
20
        'description' => 'Foreign key: The {filter_format}.format to which this filter is assigned.',
21 22 23 24 25 26
      ),
      'module' => array(
        'type' => 'varchar',
        'length' => 64,
        'not null' => TRUE,
        'default' => '',
27
        'description' => 'The origin module of the filter.',
28
      ),
29 30 31
      'name' => array(
        'type' => 'varchar',
        'length' => 32,
32
        'not null' => TRUE,
33 34
        'default' => '',
        'description' => 'Name of the filter being referenced.',
35 36 37 38 39
      ),
      'weight' => array(
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
40
        'description' => 'Weight of filter within format.',
41 42 43 44 45 46 47 48
      ),
      'status' => array(
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
        'description' => 'Filter enabled status. (1 = enabled, 0 = disabled)',
      ),
      'settings' => array(
49
        'type' => 'blob',
50 51 52 53 54
        'not null' => FALSE,
        'size' => 'big',
        'serialize' => TRUE,
        'description' => 'A serialized array of name value pairs that store the filter settings for the specific format.',
      ),
55
    ),
56
    'primary key' => array('format', 'name'),
57
    'indexes' => array(
58
      'list' => array('weight', 'module', 'name'),
59
    ),
60
  );
61
  $schema['filter_format'] = array(
62
    'description' => 'Stores text formats: custom groupings of filters, such as Filtered HTML.',
63
    'fields' => array(
64 65 66
      'format' => array(
        'type' => 'serial',
        'not null' => TRUE,
67
        'description' => 'Primary Key: Unique ID for format.',
68 69 70 71 72 73
      ),
      'name' => array(
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => '',
74
        'description' => 'Name of the text format (Filtered HTML).',
75
        'translatable' => TRUE,
76 77 78 79 80 81
      ),
      'cache' => array(
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
        'size' => 'tiny',
82
        'description' => 'Flag to indicate whether format is cacheable. (1 = cacheable, 0 = not cacheable)',
83
      ),
84 85 86 87
      'weight' => array(
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
88
        'description' => 'Weight of text format to use when listing.',
89
      )
90 91
    ),
    'primary key' => array('format'),
92 93 94
    'unique keys' => array(
      'name' => array('name'),
    ),
95 96 97
    'indexes' => array(
      'weight' => array('weight'),
    ),
98 99 100
  );

  $schema['cache_filter'] = drupal_get_schema_unprocessed('system', 'cache');
101
  $schema['cache_filter']['description'] = 'Cache table for the Filter module to store already filtered pieces of text, identified by text format and hash of the text.';
102 103 104 105

  return $schema;
}

106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
/**
 * Implements hook_install().
 */
function filter_install() {
  // All sites require at least one text format (the fallback format) that all
  // users have access to, so add it here. We initialize it as a simple, safe
  // plain text format with very basic formatting, but it can be modified by
  // installation profiles to have other properties.
  $plain_text_format = array(
    'name' => 'Plain text',
    'weight' => 10,
    'filters' => array(
      // Escape all HTML.
      'filter_html_escape' => array(
        'weight' => 0,
        'status' => 1,
      ),
      // URL filter.
      'filter_url' => array(
        'weight' => 1,
        'status' => 1,
      ),
      // Line break filter.
      'filter_autop' => array(
        'weight' => 2,
        'status' => 1,
      ),
    ),
  );
  $plain_text_format = (object) $plain_text_format;
  filter_format_save($plain_text_format);

  // Set the fallback format to plain text.
  variable_set('filter_fallback_format', $plain_text_format->format);
}

142 143 144 145 146 147 148
/**
 * Implements hook_update_dependencies().
 */
function filter_update_dependencies() {
  // Filter update 7005 migrates block data and therefore needs to run after
  // the {block_custom} table is properly set up.
  $dependencies['filter'][7005] = array(
149
    'taxonomy' => 7002,
150
  );
151

152 153 154
  return $dependencies;
}

155 156 157 158 159
/**
 * @defgroup updates-6.x-to-7.x Filter updates from 6.x to 7.x
 * @{
 */

160
/**
161
 * Increase the size of {filters}.weight and add {filter_formats}.weight.
162 163
 */
function filter_update_7000() {
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
  // The list index will be recreated by filter_update_7003().
  db_drop_index('filters', 'list');

  // Change the weight column of the filter table to normal (ie. non tiny) int.
  db_change_field('filters', 'weight', 'weight', array(
    'type' => 'int',
    'not null' => TRUE,
    'default' => 0,
    'description' => 'Weight of filter within format.',
  ));

  // Add a new filter_format.weight column.
  db_add_field('filter_formats', 'weight', array(
    'type' => 'int',
    'not null' => TRUE,
    'default' => 0,
    'description' => 'Weight of text format to use when listing.',
  ), array(
    'indexes' => array(
      'weight' => array('weight'),
    ),
  ));
186
}
187 188 189 190 191

/**
 * Break out "escape HTML filter" option to its own filter.
 */
function filter_update_7001() {
192
  $result = db_query("SELECT format FROM {filter_formats}")->fetchCol();
193 194
  $insert = db_insert('filters')->fields(array('format', 'module', 'delta', 'weight'));

195
  foreach ($result as $format_id) {
196
    // Deprecated constants FILTER_HTML_STRIP = 1 and FILTER_HTML_ESCAPE = 2.
197 198 199 200 201 202 203
    if (variable_get('filter_html_' . $format_id, 1) == 2) {
      $insert->values(array(
        'format' => $format_id,
        'filter' => 'filter',
        'delta' => 4,
        'weight' => 0,
      ));
204
    }
205
    variable_del('filter_html_' . $format_id);
206
  }
207 208

  $insert->execute();
209
}
210 211 212 213 214

/**
 * Rename {filters} table to {filter} and {filter_formats} table to {filter_format}.
 */
function filter_update_7002() {
215 216
  db_rename_table('filters', 'filter');
  db_rename_table('filter_formats', 'filter_format');
217
}
218 219 220 221 222

/**
 * Remove hardcoded numeric deltas from all filters in core.
 */
function filter_update_7003() {
223 224 225 226 227 228 229
  // Duplicates the filter table since core cannot take care of the potential
  // contributed module filters.
  db_rename_table('filter', 'd6_upgrade_filter');
  // Creates the Drupal 7 filter table.
  $schema = filter_schema();
  db_create_table('filter', $schema['filter']);

230 231 232 233 234 235 236 237 238 239
  // Get an array of the renamed filter deltas, organized by module.
  $renamed_deltas = array(
    'filter' => array(
      '0' => 'filter_html',
      '1' => 'filter_autop',
      '2' => 'filter_url',
      '3' => 'filter_htmlcorrector',
      '4' => 'filter_html_escape',
    ),
    'php' => array(
240 241
      '0' => 'php_code',
    ),
242
  );
243

244 245
  // Loop through each filter and make changes to the core filter table by
  // each record from the old to the new table.
246
  foreach ($renamed_deltas as $module => $deltas) {
247 248 249 250 251
    foreach ($deltas as $old_delta => $new_name) {
      $query = db_select('d6_upgrade_filter');
      $query->fields('d6_upgrade_filter', array('format', 'weight'));
      $query->condition('module', $module);
      $query->condition('delta', $old_delta);
252
      $query->distinct();
253 254 255 256 257 258 259 260 261 262 263 264
      $result = $query->execute();
      foreach ($result as $record) {
        db_insert('filter')
          ->fields(array(
            'format' => $record->format,
            'module' => $module,
            'name' => $new_name,
            'weight' => $record->weight,
          ))
          ->execute();
      }
      db_delete('d6_upgrade_filter')
265
        ->condition('module', $module)
266
        ->condition('delta', $old_delta)
267
        ->execute();
268 269 270 271
    }
  }
}

272 273 274 275 276
/**
 * Move filter settings storage into {filter} table.
 */
function filter_update_7004() {
  // Enable all existing filters ({filter} contained only enabled previously).
277
  db_update('filter')
278
    ->fields(array('status' => '1'))
279
    ->execute();
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305

  // Move filter settings from system variables into {filter}.settings.
  $filters = db_query("SELECT * FROM {filter} WHERE module = :name", array(':name' => 'filter'));
  foreach ($filters as $filter) {
    $settings = array();
    if ($filter->name == 'filter_html') {
      if ($setting = variable_get("allowed_html_{$filter->format}", NULL)) {
        $settings['allowed_html'] = $setting;
        variable_del("allowed_html_{$filter->format}");
      }
      if ($setting = variable_get("filter_html_help_{$filter->format}", NULL)) {
        $settings['filter_html_help'] = $setting;
        variable_del("filter_html_help_{$filter->format}");
      }
      if ($setting = variable_get("filter_html_nofollow_{$filter->format}", NULL)) {
        $settings['filter_html_nofollow'] = $setting;
        variable_del("filter_html_nofollow_{$filter->format}");
      }
    }
    elseif ($filter->name == 'filter_url') {
      if ($setting = variable_get("filter_url_length_{$filter->format}", NULL)) {
        $settings['filter_url_length'] = $setting;
        variable_del("filter_url_length_{$filter->format}");
      }
    }
    if (!empty($settings)) {
306 307 308 309 310
      db_update('filter')
        ->fields(array('settings' => serialize($settings)))
        ->condition('format', $filter->format)
        ->condition('name', $filter->name)
        ->execute();
311 312 313 314
    }
  }
}

315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341
/**
 * Integrate text formats with the user permissions system.
 *
 * This function converts text format role assignments to use the new text
 * format permissions introduced in Drupal 7, creates a fallback (plain text)
 * format that is available to all users, and explicitly sets the text format
 * in cases that used to rely on a single site-wide default.
 */
function filter_update_7005() {

  // Move role data from the filter system to the user permission system.
  $all_roles = array_keys(user_roles());
  $default_format = variable_get('filter_default_format', 1);
  $result = db_query("SELECT * FROM {filter_format}");
  foreach ($result as $format) {
    // We need to assign the default format to all roles (regardless of what
    // was stored in the database) to preserve the behavior of the site at the
    // moment of the upgrade.
    $format_roles = ($format->format == $default_format ? $all_roles : explode(',', $format->roles));
    foreach ($format_roles as $format_role) {
      if (in_array($format_role, $all_roles)) {
        user_role_grant_permissions($format_role, array(filter_permission_name($format)));
      }
    }
  }

  // Drop the roles field from the {filter_format} table.
342
  db_drop_field('filter_format', 'roles');
343 344 345 346 347 348 349

  // Add a fallback text format which outputs plain text and appears last on
  // the list for all users. Generate a unique name for it, starting with
  // "Plain text".
  $start_name = 'Plain text';
  $format_name = $start_name;
  while ($format = db_query('SELECT format FROM {filter_format} WHERE name = :name', array(':name' => $format_name))->fetchField()) {
350
    $id = empty($id) ? 2 : $id + 1;
351 352 353 354 355 356
    $format_name = $start_name . ' ' . $id;
  }
  $fallback_format = new stdClass();
  $fallback_format->name = $format_name;
  $fallback_format->weight = 1;
  // This format should output plain text, so we escape all HTML and apply the
357
  // line break and URL filters only.
358
  $fallback_format->filters = array(
359 360 361 362 363 364 365 366 367 368 369 370
    'filter_html_escape' => array(
      'weight' => 0,
      'status' => 1,
    ),
    'filter_url' => array(
      'weight' => 1,
      'status' => 1,
    ),
    'filter_autop' => array(
      'weight' => 2,
      'status' => 1,
    ),
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387
  );
  filter_format_save($fallback_format);
  variable_set('filter_fallback_format', $fallback_format->format);
  drupal_set_message('A new <em>Plain text</em> format has been created which will be available to all users. You can configure this text format on the <a href="' . url('admin/config/content/formats/' . $fallback_format->format) . '">text format configuration page</a>.');

  // Move the former site-wide default text format to the top of the list, so
  // that it continues to be the default text format for all users.
  db_update('filter_format')
    ->fields(array('weight' => -1))
    ->condition('format', $default_format)
    ->execute();

  // It was previously possible for a value of "0" to be stored in database
  // tables to indicate that a particular piece of text should be filtered
  // using the default text format. Therefore, we have to convert all such
  // instances (in Drupal core) to explicitly use the appropriate format.
  // Note that the update of the node body field is handled separately, in
388 389
  // node_update_7006(), as is the update of the comment body field, in
  // comment_update_7013().
390
  foreach (array('block_custom' => 'format', 'users' => 'signature_format') as $table => $column) {
391 392
    if (db_table_exists($table)) {
      db_update($table)
393 394
        ->fields(array($column => $default_format))
        ->condition($column, 0)
395 396 397 398 399 400 401 402 403
        ->execute();
    }
  }

  // We do not delete the 'filter_default_format' variable, since other modules
  // may need it in their update functions.
  // @todo This variable can be deleted in Drupal 8.
}

404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424
/**
 * Grant usage of all text formats to user roles having the 'administer filters' permission.
 */
function filter_update_7008() {
  // Build the list of permissions to grant.
  $permissions = array();
  foreach (filter_formats() as $format_id => $format) {
    if ($permission = filter_permission_name($format)) {
      $permissions[] = $permission;
    }
  }
  // Grant text format permissions to all roles that can 'administer filters'.
  // Albeit anonymous users *should not* have the permission, we cannot presume
  // that they do not or must not.
  if ($roles = user_roles(FALSE, 'administer filters')) {
    foreach ($roles as $rid => $name) {
      user_role_grant_permissions($rid, $permissions);
    }
  }
}

425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
/**
 * Converts fields that store serialized variables from text to blob.
 */
function filter_update_7009() {
  $spec = array(
    'type' => 'blob',
    'not null' => FALSE,
    'size' => 'big',
    'serialize' => TRUE,
    'description' => 'A serialized array of name value pairs that store the filter settings for the specific format.',
  );
  db_change_field('filter', 'settings', 'settings', $spec);

  $schema = system_schema_cache_7054();
  db_drop_table('cache_filter');
  db_create_table('cache_filter', $schema);
}

443 444 445 446
/**
 * @} End of "defgroup updates-6.x-to-7.x"
 * The next series of updates should start at 8000.
 */