Newer
Older
<?php
// $Id$
/**
* @file
* Integrate Wysiwyg editors into Drupal.
*/
/**
* Form builder for Wysiwyg profile form.
function wysiwyg_profile_form($form_state, $profile) {
Daniel Kudwien
committed
$profile = (array) $profile;
Daniel Kudwien
committed
$profile += array(
Daniel Kudwien
committed
'format' => 0,
'editor' => '',
Daniel Kudwien
committed
if (empty($profile['settings'])) {
$profile['settings'] = array();
}
Daniel Kudwien
committed
$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,
);
Daniel Kudwien
committed
$profile = (object) $profile;
Daniel Kudwien
committed
Daniel Kudwien
committed
$formats = filter_formats();
$editor = wysiwyg_get_editor($profile->editor);
drupal_set_title(t('%editor profile for %format', array('%editor' => $editor['title'], '%format' => $formats[$profile->format]->name)));
Daniel Kudwien
committed
$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(
Daniel Kudwien
committed
'#type' => 'checkbox',
'#title' => t('Enabled by default'),
Daniel Kudwien
committed
'#default_value' => $profile->settings['default'],
Daniel Kudwien
committed
'#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(
Daniel Kudwien
committed
'#type' => 'checkbox',
'#title' => t('Allow users to choose default'),
Daniel Kudwien
committed
'#default_value' => $profile->settings['user_choose'],
Daniel Kudwien
committed
'#return_value' => 1,
Daniel Kudwien
committed
'#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(
Daniel Kudwien
committed
'#type' => 'checkbox',
Daniel Kudwien
committed
'#title' => t('Show <em>enable/disable rich text</em> toggle link'),
Daniel Kudwien
committed
'#default_value' => $profile->settings['show_toggle'],
Daniel Kudwien
committed
'#return_value' => 1,
Daniel Kudwien
committed
'#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',
Daniel Kudwien
committed
'#value' => $profile->settings['theme'],
);
$form['basic']['language'] = array(
'#type' => 'select',
'#title' => t('Language'),
Daniel Kudwien
committed
'#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', 'tr', 'uk', 'zh_cn', 'zh_tw', 'zh_tw_utf8')),
Daniel Kudwien
committed
'#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',
);
Daniel Kudwien
committed
$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) {
Daniel Kudwien
committed
$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";
Daniel Kudwien
committed
// Handle plugins that have more than one button.
if (!file_exists($img_src)) {
$img_src = $meta['path'] . "/images/$button.gif";
Daniel Kudwien
committed
}
$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,
Daniel Kudwien
committed
'#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,
Daniel Kudwien
committed
'#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'),
Daniel Kudwien
committed
'#default_value' => $profile->settings['toolbar_loc'],
'#options' => array('bottom' => t('Bottom'), 'top' => t('Top')),
Daniel Kudwien
committed
'#description' => t('This option controls whether the editor toolbar is displayed above or below the editing area.'),
);
$form['appearance']['toolbar_align'] = array(
'#type' => 'select',
Daniel Kudwien
committed
'#title' => t('Button alignment'),
Daniel Kudwien
committed
'#default_value' => $profile->settings['toolbar_align'],
'#options' => array('center' => t('Center'), 'left' => t('Left'), 'right' => t('Right')),
Daniel Kudwien
committed
'#description' => t('This option controls the alignment of icons in the editor toolbar.'),
);
$form['appearance']['path_loc'] = array(
'#type' => 'select',
'#title' => t('Path location'),
Daniel Kudwien
committed
'#default_value' => $profile->settings['path_loc'],
Daniel Kudwien
committed
'#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(
Daniel Kudwien
committed
'#type' => 'checkbox',
'#title' => t('Enable resizing button'),
Daniel Kudwien
committed
'#default_value' => $profile->settings['resizing'],
Daniel Kudwien
committed
'#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(
Daniel Kudwien
committed
'#type' => 'checkbox',
'#title' => t('Verify HTML'),
Daniel Kudwien
committed
'#default_value' => $profile->settings['verify_html'],
Daniel Kudwien
committed
'#return_value' => 1,
'#description' => t('If enabled, potentially malicious code like <code><HEAD></code> tags will be removed from HTML contents.'),
);
$form['output']['preformatted'] = array(
Daniel Kudwien
committed
'#type' => 'checkbox',
'#title' => t('Preformatted'),
Daniel Kudwien
committed
'#default_value' => $profile->settings['preformatted'],
Daniel Kudwien
committed
'#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(
Daniel Kudwien
committed
'#type' => 'checkbox',
'#title' => t('Convert <font> tags to styles'),
Daniel Kudwien
committed
'#default_value' => $profile->settings['convert_fonts_to_spans'],
Daniel Kudwien
committed
'#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(
Daniel Kudwien
committed
'#type' => 'checkbox',
'#title' => t('Remove linebreaks'),
Daniel Kudwien
committed
'#default_value' => $profile->settings['remove_linebreaks'],
Daniel Kudwien
committed
'#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(
Daniel Kudwien
committed
'#type' => 'checkbox',
'#title' => t('Apply source formatting'),
Daniel Kudwien
committed
'#default_value' => $profile->settings['apply_source_formatting'],
Daniel Kudwien
committed
'#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(
Daniel Kudwien
committed
'#type' => 'checkbox',
'#title' => t('Force cleanup on standard paste'),
Daniel Kudwien
committed
'#default_value' => $profile->settings['paste_auto_cleanup_on_paste'],
Daniel Kudwien
committed
'#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,
);
Daniel Kudwien
committed
$form['css']['block_formats'] = array(
'#type' => 'textfield',
'#title' => t('Block formats'),
Daniel Kudwien
committed
'#default_value' => $profile->settings['block_formats'],
Daniel Kudwien
committed
'#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')),
Daniel Kudwien
committed
);
$form['css']['css_setting'] = array(
'#type' => 'select',
'#title' => t('Editor CSS'),
Daniel Kudwien
committed
'#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'),
Daniel Kudwien
committed
'#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(
Daniel Kudwien
committed
'#type' => 'textarea',
'#title' => t('CSS classes'),
Daniel Kudwien
committed
'#default_value' => $profile->settings['css_classes'],
Daniel Kudwien
committed
'#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',
Daniel Kudwien
committed
'#value' => t('Save'),
);
return $form;
}
Daniel Kudwien
committed
/**
* Submit callback for Wysiwyg profile form.
Daniel Kudwien
committed
*
* @see wysiwyg_profile_form()
Daniel Kudwien
committed
*/
function wysiwyg_profile_form_submit($form, &$form_state) {
$values = $form_state['values'];
if (isset($values['buttons'])) {
Daniel Kudwien
committed
// Store only enabled buttons for each plugin.
foreach ($values['buttons'] as $plugin => $buttons) {
$values['buttons'][$plugin] = array_filter($values['buttons'][$plugin]);
Daniel Kudwien
committed
}
// Store only enabled plugins.
$values['buttons'] = array_filter($values['buttons']);
Daniel Kudwien
committed
// Remove input format name.
$format = $values['format'];
$input_format = $values['input_format'];
$editor = $values['editor'];
unset($values['format'], $values['input_format'], $values['editor']);
Daniel Kudwien
committed
// Remove FAPI values.
// @see system_settings_form_submit()
unset($values['submit'], $values['form_id'], $values['op'], $values['form_token'], $values['form_build_id']);
Daniel Kudwien
committed
// Insert new profile data.
db_query("UPDATE {wysiwyg} SET settings = '%s' WHERE format = %d", serialize($values), $format);
Daniel Kudwien
committed
drupal_set_message(t('Wysiwyg profile for %format has been saved.', array('%format' => $input_format)));
Daniel Kudwien
committed
$form_state['redirect'] = 'admin/settings/wysiwyg';
Daniel Kudwien
committed
}
* Layout for the buttons in the Wysiwyg Editor profile form.
function theme_wysiwyg_admin_button_table($form) {
$buttons = 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]);
Daniel Kudwien
committed
if (isset($buttons[++$i])) {
Daniel Kudwien
committed
}
if (isset($buttons[++$i])) {
Daniel Kudwien
committed
}
$rows[] = $row;
}
$output = theme('table', array(), $rows, array('width' => '100%'));
return $output;
}
/**
Daniel Kudwien
committed
* Display overview of setup Wysiwyg Editor profiles; menu callback.
function wysiwyg_profile_overview() {
Daniel Kudwien
committed
include_once './includes/install.inc';
Daniel Kudwien
committed
$form = array();
Daniel Kudwien
committed
// Check which wysiwyg editors are installed.
$editors = wysiwyg_get_all_editors();
$count = count($editors);
Daniel Kudwien
committed
$status = array();
$options = array('' => t('No editor'));
foreach ($editors as $name => $editor) {
$status[$name] = array(
'severity' => (isset($editor['error']) ? REQUIREMENT_ERROR : ($editor['installed'] ? REQUIREMENT_OK : REQUIREMENT_INFO)),
'title' => t('<a href="!vendor-url">@editor</a> (<a href="!download-url">Download</a>)', array('!vendor-url' => $editor['vendor url'], '@editor' => $editor['title'], '!download-url' => $editor['download url'])),
'value' => (isset($editor['installed version']) ? $editor['installed version'] : t('Not installed.')),
'description' => (isset($editor['error']) ? $editor['error'] : ''),
Daniel Kudwien
committed
);
if ($editor['installed']) {
$options[$name] = $editor['title'] . (isset($editor['installed version']) ? ' ' . $editor['installed version'] : '');
Daniel Kudwien
committed
}
Daniel Kudwien
committed
else {
// Build on-site installation instructions.
// @todo Setup $library in wysiwyg_load_editor() already.
$library = (isset($editor['library']) ? $editor['library'] : key($editor['libraries']));
$targs = array(
'@editor-path' => $editor['editor path'],
'@library-filepath' => $editor['library path'] . '/' . (isset($editor['libraries'][$library]['files'][0]) ? $editor['libraries'][$library]['files'][0] : key($editor['libraries'][$library]['files'])),
);
$instructions = '<p>' . t('Extract the archive and copy its contents into a new folder in the following location:<br /><code>@editor-path</code>', $targs) . '</p>';
$instructions .= '<p>' . t('So the actual library can be found at:<br /><code>@library-filepath</code>', $targs) . '</p>';
$status[$name]['description'] .= $instructions;
Daniel Kudwien
committed
$count--;
Daniel Kudwien
committed
}
// In case there is an error, always show installation instructions.
if (isset($editor['error'])) {
$show_instructions = TRUE;
}
}
if (!$count) {
$show_instructions = TRUE;
Daniel Kudwien
committed
}
Daniel Kudwien
committed
$form['status'] = array(
'#type' => 'fieldset',
'#title' => t('Installation instructions'),
'#collapsible' => TRUE,
'#collapsed' => !isset($show_instructions),
Daniel Kudwien
committed
'#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));
Daniel Kudwien
committed
Daniel Kudwien
committed
if (!$count) {
Daniel Kudwien
committed
return $form;
Daniel Kudwien
committed
$formats = filter_formats();
$profiles = wysiwyg_profile_load_all();
Daniel Kudwien
committed
$form['formats'] = array(
'#type' => 'fieldset',
'#title' => t('Wysiwyg profiles'),
'#description' => t('Once an editor has been associated with an input format, the editor association cannot be changed without first deleting the profile and then creating a new one. Delete a profile by clicking on the "delete" link and afterwards, set up a new profile as usual.'),
'#tree' => TRUE,
);
$enable_save = FALSE;
Daniel Kudwien
committed
foreach ($formats as $id => $format) {
$form['formats'][$id]['name'] = array(
'#value' => check_plain($format->name),
);
Daniel Kudwien
committed
// Only display editor selection for associated input formats to avoid
// confusion about disabled selection.
if (isset($profiles[$id]) && !empty($profiles[$id]->editor)) {
$form['formats'][$id]['editor'] = array(
'#type' => 'markup',
'#value' => $options[$profiles[$id]->editor],
'#id' => "edit-editor-$id",
);
}
else {
$form['formats'][$id]['editor'] = array(
'#type' => 'select',
'#default_value' => '',
'#options' => $options,
'#id' => "edit-editor-$id",
);
$enable_save = TRUE;
Daniel Kudwien
committed
}
Daniel Kudwien
committed
if (isset($profiles[$id]) && !empty($profiles[$id]->editor)) {
$form['formats'][$id]['edit'] = array(
'#value' => l(t('Edit'), "admin/settings/wysiwyg/profile/$id/edit"),
Daniel Kudwien
committed
);
Daniel Kudwien
committed
$form['formats'][$id]['delete'] = array(
'#value' => l(t('Delete'), "admin/settings/wysiwyg/profile/$id/delete"),
);
}
}
// Submitting the form when no editors can be selected causes errors.
if ($enable_save) {
$form['submit'] = array('#type' => 'submit', '#value' => t('Save'));
}
Daniel Kudwien
committed
return $form;
}
/**
* Return HTML for the Wysiwyg profile overview form.
*/
function theme_wysiwyg_profile_overview($form) {
Daniel Kudwien
committed
if (!isset($form['formats'])) {
return;
}
Daniel Kudwien
committed
$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']) : '',
Daniel Kudwien
committed
isset($format['delete']) ? drupal_render($format['delete']) : '',
Daniel Kudwien
committed
);
}
Daniel Kudwien
committed
$form['formats']['#children'] = theme('table', $header, $rows);
Daniel Kudwien
committed
$output .= drupal_render($form);
return $output;
}
Daniel Kudwien
committed
/**
* Submit callback for Wysiwyg profile overview form.
*/
function wysiwyg_profile_overview_submit($form, &$form_state) {
foreach ($form_state['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(&$form_state, $profile) {
Daniel Kudwien
committed
$formats = filter_formats();
$format = $formats[$profile->format];
$form['format'] = array('#type' => 'value', '#value' => $format);
return confirm_form(
$form,
t('Are you sure you want to remove the profile for %name?', array('%name' => $format->name)),
'admin/settings/wysiwyg',
Daniel Kudwien
committed
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, &$form_state) {
$format = $form_state['values']['format'];
wysiwyg_profile_delete($format->format);
drupal_set_message(t('Wysiwyg profile for %name has been deleted.', array('%name' => $format->name)));
$form_state['redirect'] = 'admin/settings/wysiwyg';
}
/**
* Remove a profile from the database.
*/
Daniel Kudwien
committed
function wysiwyg_profile_delete($format) {
db_query("DELETE FROM {wysiwyg} WHERE format = %d", $format);