wysiwyg.install in Wysiwyg 5.2

File

wysiwyg.install

<?php

/**
 * Implementation of hook_install().
 */
function wysiwyg_install() {
  switch ($GLOBALS['db_type']) {
    case 'mysql':
    case 'mysqli':
      db_query("CREATE TABLE {wysiwyg} (\n        format int NOT NULL default '0',\n        editor varchar(128) NOT NULL default '',\n        settings text,\n        PRIMARY KEY (format)\n      ) /*!40100 DEFAULT CHARACTER SET utf8 */");
      break;
    case 'pgsql':
      db_query("CREATE TABLE {wysiwyg} (\n        format int NOT NULL default '0',\n        editor varchar(128) NOT NULL default '',\n        settings text,\n        PRIMARY KEY (format)\n      )");
      break;
  }
}

/**
 * Implementation of hook_uninstall()
 */
function wysiwyg_uninstall() {
  db_query('DROP TABLE {wysiwyg}');
}

/**
 * Implementation of hook_enable().
 */
function wysiwyg_enable() {

  // Disable conflicting, obsolete editor integration modules whenever this
  // module is enabled. This is crude, but the only way to ensure no conflicts.
  module_disable(array(
    'ckeditor',
    'editarea',
    'editonpro',
    'editor',
    'fckeditor',
    'freerte',
    'htmlarea',
    'htmlbox',
    'jwysiwyg',
    'markitup',
    'nicedit',
    'openwysiwyg',
    'pegoeditor',
    'quicktext',
    'tinymce',
    'tinymce_autoconf',
    'tinytinymce',
    'whizzywig',
    'widgeditor',
    'wymeditor',
    'xstandard',
    'yui_editor',
  ));
}

/**
 * Retrieve a list of input formats to associate profiles to.
 */
function _wysiwyg_install_get_formats() {
  $formats = array();
  $result = db_query("SELECT format, name FROM {filter_formats}");
  while ($format = db_fetch_object($result)) {

    // Build a list of all formats.
    $formats[$format->format] = $format->name;

    // Fetch filters.
    $result2 = db_query("SELECT module, delta FROM {filters} WHERE format = %d", $format->format);
    while ($filter = db_fetch_object($result2)) {

      // If PHP filter is enabled, remove this format.
      if ($filter->module == 'filter' && $filter->delta == 1) {
        unset($formats[$format->format]);
        break;
      }
    }
  }
  return $formats;
}

/**
 * Associate Wysiwyg profiles with input formats.
 *
 * Since there was no association yet, we can only assume that there is one
 * profile only, and that profile must be duplicated and assigned to all input
 * formats (except PHP code format).  Also, input formats already have
 * titles/names, so Wysiwyg profiles do not need an own.
 *
 * Because input formats are already granted to certain user roles only, we can
 * remove our custom Wysiwyg profile permissions.  A 1:1 relationship between
 * input formats and permissions makes plugin_count obsolete, too.
 *
 * Since the resulting table is completely different, a new schema is installed.
 */
function wysiwyg_update_5001() {
  $ret = array();
  if (db_table_exists('wysiwyg')) {
    return $ret;
  }

  // Install new schema.
  switch ($GLOBALS['db_type']) {
    case 'mysql':
    case 'mysqli':
      $ret[] = update_sql("CREATE TABLE {wysiwyg} (\n        format int NOT NULL default '0',\n        editor varchar(128) NOT NULL default '',\n        settings text,\n        PRIMARY KEY (format)\n      ) /*!40100 DEFAULT CHARACTER SET utf8 */");
      break;
    case 'pgsql':
      $ret[] = update_sql("CREATE TABLE {wysiwyg} (\n        format int NOT NULL default '0',\n        editor varchar(128) NOT NULL default '',\n        settings text,\n        PRIMARY KEY (format)\n      )");
      break;
  }

  // Fetch all input formats.
  $formats = _wysiwyg_install_get_formats();

  // Fetch all profiles.
  $result = db_query("SELECT name, settings FROM {wysiwyg_profile}");
  while ($profile = db_fetch_object($result)) {
    $profile->settings = unserialize($profile->settings);

    // Extract editor name from profile settings.
    $profile->editor = $profile->settings['editor'];

    // Clean-up.
    unset($profile->settings['editor']);
    unset($profile->settings['old_name']);
    unset($profile->settings['name']);
    unset($profile->settings['rids']);

    // Sorry.  There Can Be Only One. ;)
    break;
  }
  if ($profile) {

    // Rebuild profiles and associate with input formats.
    foreach ($formats as $format => $name) {

      // Insert profiles.
      // We can't use update_sql() here because of curly braces in serialized
      // array.
      db_query("INSERT INTO {wysiwyg} (format, editor, settings) VALUES (%d, '%s', '%s')", $format, $profile->editor, serialize($profile->settings));
      $ret[] = array(
        'success' => TRUE,
        'query' => strtr('Wysiwyg profile %profile converted and associated with input format %format.', array(
          '%profile' => check_plain($profile->name),
          '%format' => check_plain($name),
        )),
      );
    }
  }

  // Drop obsolete tables {wysiwyg_profile} and {wysiwyg_role}.
  $ret[] = update_sql("DROP TABLE {wysiwyg_profile}");
  $ret[] = update_sql("DROP TABLE {wysiwyg_role}");
  return $ret;
}

/**
 * Clear JS/CSS caches to ensure that clients load fresh copies.
 */
function wysiwyg_update_5200() {
  $ret = array();
  drupal_clear_css_cache();

  // Rebuild the menu to remove old admin/settings/wysiwyg/profile item.
  menu_rebuild();

  // Flush content caches.
  cache_clear_all();
  $ret[] = array(
    'success' => TRUE,
    'query' => 'Caches have been flushed.',
  );
  return $ret;
}

/**
 * Update enabled font plugin buttons to default plugin in TinyMCE profiles.
 */
function wysiwyg_update_5201() {
  $ret = array();
  $results = db_query("SELECT format, settings FROM {wysiwyg} WHERE editor = 'tinymce'");
  while ($profile = db_fetch_object($results)) {
    $settings = unserialize($profile->settings);

    // Move enabled 'font' buttons into 'default' plugin buttons.
    $changed = FALSE;
    foreach (array(
      'formatselect',
      'fontselect',
      'fontsizeselect',
      'styleselect',
    ) as $button) {
      if (isset($settings['buttons']['font'][$button])) {
        $settings['buttons']['default'][$button] = $settings['buttons']['font'][$button];
        unset($settings['buttons']['font'][$button]);
        $changed = TRUE;
      }
    }
    if ($changed) {

      // We can't use update_sql() here because of curly braces in serialized
      // array.
      db_query("UPDATE {wysiwyg} SET settings='%s' WHERE format = '%s'", array(
        serialize($settings),
        $profile->format,
      ));
    }
  }
  $ret[] = array(
    'success' => TRUE,
    'query' => 'TinyMCE profiles have been updated.',
  );
  return $ret;
}

Functions

Name	Description
wysiwyg_enable	Implementation of hook_enable().
wysiwyg_install	Implementation of hook_install().
wysiwyg_uninstall	Implementation of hook_uninstall()
wysiwyg_update_5001	Associate Wysiwyg profiles with input formats.
wysiwyg_update_5200	Clear JS/CSS caches to ensure that clients load fresh copies.
wysiwyg_update_5201	Update enabled font plugin buttons to default plugin in TinyMCE profiles.
_wysiwyg_install_get_formats	Retrieve a list of input formats to associate profiles to.