wysiwyg.admin.inc in Wysiwyg 5

Integrate Wysiwyg editors into Drupal.

File

wysiwyg.admin.inc

<?php

/**
 * @file
 * Integrate Wysiwyg editors into Drupal.
 */

/**
 * Callback handler for admin pages; menu callback.
 *
 * @todo Move into hook_menu(), resp. FAPI functions.
 */
function _wysiwyg_admin($arg = '', $format = '') {
  switch ($arg) {
    case 'edit':
      if ($profile = wysiwyg_load_profile($format)) {
        $breadcrumb = array();
        $breadcrumb[] = array(
          'path' => 'admin',
          'title' => t('administer'),
        );
        $breadcrumb[] = array(
          'path' => 'admin/settings',
          'title' => t('Site configuration'),
        );
        $breadcrumb[] = array(
          'path' => 'admin/settings/wysiwyg/profile',
          'title' => t('Wysiwyg profiles'),
        );
        $breadcrumb[] = array(
          'path' => 'admin/settings/wysiwyg/profile/edit',
        );
        menu_set_location($breadcrumb);
        return drupal_get_form('wysiwyg_profile_form', $profile);
      }
      break;
    case 'delete':
      return drupal_get_form('wysiwyg_profile_delete_confirm', $format);
    case '':
      return drupal_get_form('wysiwyg_profile_overview');
  }
  drupal_goto('admin/settings/wysiwyg/profile');
}

/**
 * Return an HTML form for profile configuration.
 */
function wysiwyg_profile_form($profile) {

  // Merge in defaults.
  $profile = (array) $profile;
  $profile += array(
    'format' => 0,
    'editor' => '',
  );
  if (empty($profile['settings'])) {
    $profile['settings'] = array();
  }
  $profile['settings'] += array(
    'default' => TRUE,
    'user_choose' => FALSE,
    'show_toggle' => TRUE,
    'theme' => 'advanced',
    'language' => 'en',
    'access' => 1,
    'access_pages' => "node/*\nuser/*\ncomment/*",
    'buttons' => array(),
    'toolbar_loc' => 'top',
    'toolbar_align' => 'left',
    'path_loc' => 'bottom',
    'resizing' => TRUE,
    // Also available, but buggy in TinyMCE 2.x: blockquote,code,dt,dd,samp.
    'block_formats' => 'p,address,pre,h2,h3,h4,h5,h6,div',
    'verify_html' => TRUE,
    'preformatted' => FALSE,
    'convert_fonts_to_spans' => TRUE,
    'remove_linebreaks' => TRUE,
    'apply_source_formatting' => FALSE,
    'paste_auto_cleanup_on_paste' => FALSE,
    'css_setting' => 'theme',
    'css_path' => NULL,
    'css_classes' => NULL,
  );
  $profile = (object) $profile;
  $formats = filter_formats();
  drupal_set_title(t('%format Wysiwyg profile', array(
    '%format' => $formats[$profile->format]->name,
  )));
  $form = array();
  $form['format'] = array(
    '#type' => 'value',
    '#value' => $profile->format,
  );
  $form['input_format'] = array(
    '#type' => 'value',
    '#value' => $formats[$profile->format]->name,
  );
  $form['editor'] = array(
    '#type' => 'value',
    '#value' => $profile->editor,
  );
  $form['basic'] = array(
    '#type' => 'fieldset',
    '#title' => t('Basic setup'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
  );
  $form['basic']['default'] = array(
    '#type' => 'checkbox',
    '#title' => t('Enabled by default'),
    '#default_value' => $profile->settings['default'],
    '#return_value' => 1,
    '#description' => t('The default editor state for users having access to this profile. Users are able to override this state if the next option is enabled.'),
  );
  $form['basic']['user_choose'] = array(
    '#type' => 'checkbox',
    '#title' => t('Allow users to choose default'),
    '#default_value' => $profile->settings['user_choose'],
    '#return_value' => 1,
    '#description' => t('If allowed, users will be able to choose their own editor default state in their user account settings.'),
  );
  $form['basic']['show_toggle'] = array(
    '#type' => 'checkbox',
    '#title' => t('Show <em>enable/disable rich text</em> toggle link'),
    '#default_value' => $profile->settings['show_toggle'],
    '#return_value' => 1,
    '#description' => t('Whether or not to show the <em>enable/disable rich text</em> toggle link below a textarea. If disabled, the user setting or global default is used (see above).'),
  );
  $form['basic']['theme'] = array(
    '#type' => 'hidden',
    '#value' => $profile->settings['theme'],
  );
  $form['basic']['language'] = array(
    '#type' => 'select',
    '#title' => t('Language'),
    '#default_value' => $profile->settings['language'],
    '#options' => drupal_map_assoc(array(
      'ar',
      'ca',
      'cs',
      'cy',
      'da',
      'de',
      'el',
      'en',
      'es',
      'fa',
      'fi',
      'fr',
      'fr_ca',
      'he',
      'hu',
      'is',
      'it',
      'ja',
      'ko',
      'nb',
      'nl',
      'nn',
      'pl',
      'pt',
      'pt_br',
      'ru',
      'ru_KOI8-R',
      'ru_UTF-8',
      'si',
      'sk',
      'sv',
      'th',
      'zh_cn',
      'zh_tw',
      'zh_tw_utf8',
    )),
    '#description' => t('The language to use for the editor interface. Language codes are based on the <a href="http://www.loc.gov/standards/iso639-2/englangn.html">ISO-639-2</a> format.'),
  );
  $form['buttons'] = array(
    '#type' => 'fieldset',
    '#title' => t('Buttons and plugins'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
    '#tree' => TRUE,
    '#theme' => 'wysiwyg_admin_button_table',
  );
  $plugins = wysiwyg_get_plugins($profile->editor);

  // Generate the button list.
  foreach ($plugins as $name => $meta) {
    if (isset($meta['buttons']) && is_array($meta['buttons'])) {
      foreach ($meta['buttons'] as $button => $title) {
        $icon = '';
        if (!empty($meta['path'])) {

          // @todo Button icon locations are different in editors, editor versions,
          //   and contrib/custom plugins (like Image Assist, f.e.).
          $img_src = $meta['path'] . "/images/{$name}.gif";

          // Handle plugins that have more than one button.
          if (!file_exists($img_src)) {
            $img_src = $meta['path'] . "/images/{$button}.gif";
          }
          $icon = file_exists($img_src) ? '<img src="' . base_path() . $img_src . '" title="' . $button . '" style="border: 1px solid grey; vertical-align: middle;" />' : '';
        }
        $title = isset($meta['url']) ? l($title, $meta['url'], array(
          'target' => '_blank',
        )) : $title;
        $title = !empty($icon) ? $icon . ' ' . $title : $title;
        $form['buttons'][$name][$button] = array(
          '#type' => 'checkbox',
          '#title' => $title,
          '#default_value' => !empty($profile->settings['buttons'][$name][$button]) ? $profile->settings['buttons'][$name][$button] : FALSE,
        );
      }
    }
    else {
      if (isset($meta['extensions']) && is_array($meta['extensions'])) {
        foreach ($meta['extensions'] as $extension => $title) {
          $form['buttons'][$name][$extension] = array(
            '#type' => 'checkbox',
            '#title' => isset($meta['url']) ? l($title, $meta['url'], array(
              'target' => '_blank',
            )) : $title,
            '#default_value' => !empty($profile->settings['buttons'][$name][$extension]) ? $profile->settings['buttons'][$name][$extension] : FALSE,
          );
        }
      }
    }
  }
  $form['appearance'] = array(
    '#type' => 'fieldset',
    '#title' => t('Editor appearance'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
  );
  $form['appearance']['toolbar_loc'] = array(
    '#type' => 'select',
    '#title' => t('Toolbar location'),
    '#default_value' => $profile->settings['toolbar_loc'],
    '#options' => array(
      'bottom' => t('Bottom'),
      'top' => t('Top'),
    ),
    '#description' => t('This option controls whether the editor toolbar is displayed above or below the editing area.'),
  );
  $form['appearance']['toolbar_align'] = array(
    '#type' => 'select',
    '#title' => t('Button alignment'),
    '#default_value' => $profile->settings['toolbar_align'],
    '#options' => array(
      'center' => t('Center'),
      'left' => t('Left'),
      'right' => t('Right'),
    ),
    '#description' => t('This option controls the alignment of icons in the editor toolbar.'),
  );
  $form['appearance']['path_loc'] = array(
    '#type' => 'select',
    '#title' => t('Path location'),
    '#default_value' => $profile->settings['path_loc'],
    '#options' => array(
      'none' => t('Hide'),
      'top' => t('Top'),
      'bottom' => t('Bottom'),
    ),
    '#description' => t('Where to display the path to HTML elements (i.e. <code>body > table > tr > td</code>).'),
  );
  $form['appearance']['resizing'] = array(
    '#type' => 'checkbox',
    '#title' => t('Enable resizing button'),
    '#default_value' => $profile->settings['resizing'],
    '#return_value' => 1,
    '#description' => t('This option gives you the ability to enable/disable the resizing button. If enabled, the Path location toolbar must be set to "Top" or "Bottom" in order to display the resize icon.'),
  );
  $form['output'] = array(
    '#type' => 'fieldset',
    '#title' => t('Cleanup and output'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
  );
  $form['output']['verify_html'] = array(
    '#type' => 'checkbox',
    '#title' => t('Verify HTML'),
    '#default_value' => $profile->settings['verify_html'],
    '#return_value' => 1,
    '#description' => t('If enabled, potentially malicious code like <code>&lt;HEAD&gt;</code> tags will be removed from HTML contents.'),
  );
  $form['output']['preformatted'] = array(
    '#type' => 'checkbox',
    '#title' => t('Preformatted'),
    '#default_value' => $profile->settings['preformatted'],
    '#return_value' => 1,
    '#description' => t('If enabled, the editor will insert TAB characters on tab and preserve other whitespace characters just like a PRE element in HTML does.'),
  );
  $form['output']['convert_fonts_to_spans'] = array(
    '#type' => 'checkbox',
    '#title' => t('Convert &lt;font&gt; tags to styles'),
    '#default_value' => $profile->settings['convert_fonts_to_spans'],
    '#return_value' => 1,
    '#description' => t('If enabled, HTML tags declaring the font size, font family, font color and font background color will be replaced by inline CSS styles.'),
  );
  $form['output']['remove_linebreaks'] = array(
    '#type' => 'checkbox',
    '#title' => t('Remove linebreaks'),
    '#default_value' => $profile->settings['remove_linebreaks'],
    '#return_value' => 1,
    '#description' => t('If enabled, the editor will remove most linebreaks from contents. Disabling this option could avoid conflicts with other input filters.'),
  );
  $form['output']['apply_source_formatting'] = array(
    '#type' => 'checkbox',
    '#title' => t('Apply source formatting'),
    '#default_value' => $profile->settings['apply_source_formatting'],
    '#return_value' => 1,
    '#description' => t('If enabled, the editor will re-format the HTML source code. Disabling this option could avoid conflicts with other input filters.'),
  );
  $form['output']['paste_auto_cleanup_on_paste'] = array(
    '#type' => 'checkbox',
    '#title' => t('Force cleanup on standard paste'),
    '#default_value' => $profile->settings['paste_auto_cleanup_on_paste'],
    '#return_value' => 1,
    '#description' => t('If enabled, the default paste function (CTRL-V or SHIFT-INS) behaves like the "paste from word" plugin function.'),
  );
  $form['css'] = array(
    '#type' => 'fieldset',
    '#title' => t('CSS'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
  );
  $form['css']['block_formats'] = array(
    '#type' => 'textfield',
    '#title' => t('Block formats'),
    '#default_value' => $profile->settings['block_formats'],
    '#size' => 40,
    '#maxlength' => 250,
    '#description' => t('Comma separated list of HTML block formats. Possible values: <code>@format-list</code>.', array(
      '@format-list' => 'p,h1,h2,h3,h4,h5,h6,div,blockquote,address,pre,code,dt,dd',
    )),
  );
  $form['css']['css_setting'] = array(
    '#type' => 'select',
    '#title' => t('Editor CSS'),
    '#default_value' => $profile->settings['css_setting'],
    '#options' => array(
      'theme' => t('Use theme CSS'),
      'self' => t('Define CSS'),
      'none' => t('Editor default CSS'),
    ),
    '#description' => t('Defines the CSS to be used in the editor area.<br />Use theme CSS - loads stylesheets from current site theme.<br/>Define CSS - enter path for stylesheet files below.<br />Editor default CSS - uses default stylesheets from editor.'),
  );
  $form['css']['css_path'] = array(
    '#type' => 'textfield',
    '#title' => t('CSS path'),
    '#default_value' => $profile->settings['css_path'],
    '#size' => 40,
    '#maxlength' => 255,
    '#description' => t('If "Define CSS" was selected above, enter path to a CSS file or a list of CSS files separated by a comma.') . '<br />' . t('Available tokens: <code>%b</code> (base path, eg: <code>/</code>), <code>%t</code> (path to theme, eg: <code>themes/garland</code>)') . '<br />' . t('Example:') . ' css/editor.css,/themes/garland/style.css,%b%t/style.css,http://example.com/external.css',
  );
  $form['css']['css_classes'] = array(
    '#type' => 'textarea',
    '#title' => t('CSS classes'),
    '#default_value' => $profile->settings['css_classes'],
    '#description' => t('Optionally define CSS classes for the "Font style" dropdown list.<br />Enter one class on each line in the format: !format. Example: !example<br />If left blank, CSS classes are automatically imported from all loaded stylesheet(s).', array(
      '!format' => '<code>[title]=[class]</code>',
      '!example' => 'My heading=header1',
    )),
  );
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Save'),
  );
  return $form;
}

/**
 * Submit callback for Wysiwyg profile form.
 *
 * @see wysiwyg_profile_form()
 */
function wysiwyg_profile_form_submit($form_id, &$form_values) {
  if (isset($form_values['buttons'])) {

    // Store only enabled buttons for each plugin.
    foreach ($form_values['buttons'] as $plugin => $buttons) {
      $form_values['buttons'][$plugin] = array_filter($form_values['buttons'][$plugin]);
    }

    // Store only enabled plugins.
    $form_values['buttons'] = array_filter($form_values['buttons']);
  }

  // Remove input format name.
  $format = $form_values['format'];
  $input_format = $form_values['input_format'];
  $editor = $form_values['editor'];
  unset($form_values['format'], $form_values['input_format'], $form_values['editor']);

  // Remove FAPI values.
  // @see system_settings_form_submit()
  unset($form_values['submit'], $form_values['form_id'], $form_values['op'], $form_values['form_token']);

  // Insert new profile data.
  db_query("UPDATE {wysiwyg} SET settings = '%s' WHERE format = %d", serialize($form_values), $format);
  drupal_set_message(t('Wysiwyg profile for %format has been saved.', array(
    '%format' => $input_format,
  )));
  drupal_goto('admin/settings/wysiwyg/profile');
}

/**
 * Layout for the buttons in the Wysiwyg Editor profile form.
 */
function theme_wysiwyg_admin_button_table(&$form) {
  $buttons = array();

  // Flatten forms array.
  foreach (element_children($form) as $name) {
    foreach (element_children($form[$name]) as $button) {
      $buttons[] = drupal_render($form[$name][$button]);
    }
  }

  // Split checkboxes into rows with 3 columns.
  $total = count($buttons);
  $rows = array();
  for ($i = 0; $i < $total; $i++) {
    $row = array();
    $row[] = array(
      'data' => $buttons[$i],
    );
    if (isset($buttons[++$i])) {
      $row[] = array(
        'data' => $buttons[$i],
      );
    }
    if (isset($buttons[++$i])) {
      $row[] = array(
        'data' => $buttons[$i],
      );
    }
    $rows[] = $row;
  }
  $output = theme('table', array(), $rows, array(
    'width' => '100%',
  ));
  return $output;
}

/**
 * Display overview of setup Wysiwyg Editor profiles; menu callback.
 */
function wysiwyg_profile_overview() {
  include_once './includes/install.inc';
  $form = array();

  // Check which wysiwyg editors are installed.
  $editors = wysiwyg_get_all_editors();
  $count = count($editors);
  $status = array();
  $options = array(
    '' => t('No editor'),
  );
  foreach ($editors as $editor => $properties) {
    $status[$editor] = array(
      'severity' => isset($properties['error']) ? REQUIREMENT_ERROR : ($properties['installed'] ? REQUIREMENT_OK : REQUIREMENT_INFO),
      'title' => t('<a href="!vendor-url">@editor</a> (<a href="!download-url">Download</a>)', array(
        '!vendor-url' => $properties['vendor url'],
        '@editor' => $properties['title'],
        '!download-url' => $properties['download url'],
      )),
      'value' => isset($properties['installed version']) ? $properties['installed version'] : t('Not installed.'),
      'description' => isset($properties['error']) ? $properties['error'] : ($properties['installed'] ? '' : t('Extract the archive and copy its contents into a new folder in the following location:<br /><code>@editor-path</code>', array(
        '@editor-path' => $properties['editor path'],
      ))),
    );
    if ($properties['installed']) {
      $options[$editor] = $properties['title'] . (isset($properties['installed version']) ? ' ' . $properties['installed version'] : '');
    }
    else {
      $count--;
    }
  }
  $form['status'] = array(
    '#type' => 'fieldset',
    '#title' => t('Installation instructions'),
    '#collapsible' => TRUE,
    '#collapsed' => $count,
    '#description' => !$count ? t('There are no editor libraries installed currently. The following list contains a list of currently supported editors:') : '',
    '#weight' => 10,
  );
  $form['status']['report'] = array(
    '#type' => 'markup',
    '#value' => theme('status_report', $status),
  );
  if (!$count) {
    return $form;
  }
  $formats = filter_formats();
  $profiles = wysiwyg_load_profile();
  $form['formats']['#tree'] = TRUE;
  foreach ($formats as $id => $format) {
    $form['formats'][$id]['name'] = array(
      '#value' => check_plain($format->name),
    );
    $form['formats'][$id]['editor'] = array(
      '#type' => 'select',
      '#default_value' => isset($profiles[$id]) ? $profiles[$id]->editor : '',
      '#options' => $options,
      '#id' => "edit-editor-{$id}",
      '#disabled' => isset($profiles[$id]) ? (bool) $profiles[$id]->editor : FALSE,
    );
    if (isset($profiles[$id]) && !empty($profiles[$id]->editor)) {
      $form['formats'][$id]['edit'] = array(
        '#value' => l(t('Edit'), 'admin/settings/wysiwyg/profile/edit/' . $profiles[$id]->format),
      );
      $form['formats'][$id]['remove'] = array(
        '#value' => l(t('Remove'), 'admin/settings/wysiwyg/profile/delete/' . $profiles[$id]->format),
      );
    }
  }
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Save'),
  );
  return $form;
}

/**
 * Return HTML for the Wysiwyg profile overview form.
 */
function theme_wysiwyg_profile_overview(&$form) {
  if (!isset($form['formats'])) {
    return;
  }
  $output = '';
  $header = array(
    t('Input format'),
    t('Editor'),
    array(
      'data' => t('Operations'),
      'colspan' => 2,
    ),
  );
  $rows = array();
  foreach (element_children($form['formats']) as $item) {
    $format =& $form['formats'][$item];
    $rows[] = array(
      drupal_render($format['name']),
      drupal_render($format['editor']),
      isset($format['edit']) ? drupal_render($format['edit']) : '',
      isset($format['remove']) ? drupal_render($format['remove']) : '',
    );
  }
  $output .= theme('table', $header, $rows);
  $output .= drupal_render($form);
  return $output;
}

/**
 * Submit callback for Wysiwyg profile overview form.
 */
function wysiwyg_profile_overview_submit($form_id, &$form_values) {
  foreach ($form_values['formats'] as $format => $values) {
    db_query("UPDATE {wysiwyg} SET editor = '%s' WHERE format = %d", $values['editor'], $format);
    if (!db_affected_rows()) {
      db_query("INSERT INTO {wysiwyg} (format, editor) VALUES (%d, '%s')", $format, $values['editor']);
    }
  }
}

/**
 * Delete editor profile confirmation form.
 */
function wysiwyg_profile_delete_confirm($format) {
  $form = array();
  $form['format'] = array(
    '#type' => 'value',
    '#value' => $format,
  );
  $formats = filter_formats();
  $form['name'] = array(
    '#type' => 'value',
    '#value' => $formats[$format]->name,
  );
  return confirm_form($form, t('Are you sure you want to remove the profile for %name?', array(
    '%name' => $formats[$format]->name,
  )), 'admin/settings/wysiwyg/profile', t('This action cannot be undone.'), t('Remove'), t('Cancel'));
}

/**
 * Submit callback for Wysiwyg profile delete form.
 *
 * @see wysiwyg_profile_delete_confirm()
 */
function wysiwyg_profile_delete_confirm_submit($form_id, &$form_values) {
  wysiwyg_profile_delete($form_values['format']);
  drupal_set_message(t('Wysiwyg profile for %name has been deleted.', array(
    '%name' => $form_values['name'],
  )));
  return 'admin/settings/wysiwyg/profile';
}

/**
 * Remove a profile from the database.
 */
function wysiwyg_profile_delete($format) {
  db_query("DELETE FROM {wysiwyg} WHERE format = %d", $format);
}

Functions

Name	Description
theme_wysiwyg_admin_button_table	Layout for the buttons in the Wysiwyg Editor profile form.
theme_wysiwyg_profile_overview	Return HTML for the Wysiwyg profile overview form.
wysiwyg_profile_delete	Remove a profile from the database.
wysiwyg_profile_delete_confirm	Delete editor profile confirmation form.
wysiwyg_profile_delete_confirm_submit	Submit callback for Wysiwyg profile delete form.
wysiwyg_profile_form	Return an HTML form for profile configuration.
wysiwyg_profile_form_submit	Submit callback for Wysiwyg profile form.
wysiwyg_profile_overview	Display overview of setup Wysiwyg Editor profiles; menu callback.
wysiwyg_profile_overview_submit	Submit callback for Wysiwyg profile overview form.
_wysiwyg_admin	Callback handler for admin pages; menu callback.