123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594 |
- <?php
- /**
- * @file
- * Integrate Wysiwyg editors into Drupal.
- */
- /**
- * Form builder for Wysiwyg profile form.
- */
- function wysiwyg_profile_form($form, &$form_state, $profile) {
- // Merge in defaults.
- $profile = (array) $profile;
- $profile += array(
- 'format' => '',
- '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();
- $editor = wysiwyg_get_editor($profile->editor);
- drupal_set_title(t('%editor profile for %format', array('%editor' => $editor['title'], '%format' => $formats[$profile->format]->name)), PASS_THROUGH);
- $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('Interface language'),
- '#default_value' => $profile->settings['language'],
- );
- // @see _locale_prepare_predefined_list()
- require_once DRUPAL_ROOT . '/includes/iso.inc';
- $predefined = _locale_get_predefined_list();
- foreach ($predefined as $key => $value) {
- // Include native name in output, if possible
- if (count($value) > 1) {
- $tname = t($value[0]);
- $predefined[$key] = ($tname == $value[1]) ? $tname : "$tname ($value[1])";
- }
- else {
- $predefined[$key] = t($value[0]);
- }
- }
- asort($predefined);
- $form['basic']['language']['#options'] = $predefined;
- $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 = (!empty($icon) ? $icon . ' ' . check_plain($title) : check_plain($title));
- $form['buttons'][$name][$button] = array(
- '#type' => 'checkbox',
- '#title' => $title,
- '#default_value' => !empty($profile->settings['buttons'][$name][$button]) ? $profile->settings['buttons'][$name][$button] : FALSE,
- '#description' => isset($meta['url']) ? l($meta['url'], $meta['url']) : NULL,
- );
- }
- }
- elseif (isset($meta['extensions']) && is_array($meta['extensions'])) {
- foreach ($meta['extensions'] as $extension => $title) {
- $form['buttons'][$name][$extension] = array(
- '#type' => 'checkbox',
- '#title' => check_plain($title),
- '#default_value' => !empty($profile->settings['buttons'][$name][$extension]) ? $profile->settings['buttons'][$name][$extension] : FALSE,
- '#description' => isset($meta['url']) ? l($meta['url'], $meta['url']) : NULL,
- );
- }
- }
- }
- $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><HEAD></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 <font> 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'),
- '#weight' => 100,
- );
- $form['cancel'] = array(
- '#value' => l(t('Cancel'), 'admin/config/content/wysiwyg'),
- '#weight' => 110,
- );
- // Supply contextual information for other callbacks and handlers.
- // @todo Modernize this form for D7+ and declare these earlier.
- // $profile is the primary object of this form, and as an entity, usually
- // expected to live in $form_state[$entity_type].
- $form_state['wysiwyg_profile'] = $profile;
- $form_state['wysiwyg']['editor'] = $editor;
- $form_state['wysiwyg']['plugins'] = $plugins;
- // Allow editor library specific changes to be made to the form.
- if (isset($editor['settings form callback'])) {
- $editor['settings form callback']($form, $form_state);
- }
- return $form;
- }
- /**
- * Submit callback for Wysiwyg profile form.
- *
- * @see wysiwyg_profile_form()
- */
- function wysiwyg_profile_form_submit($form, &$form_state) {
- $values = $form_state['values'];
- if (isset($values['buttons'])) {
- // Store only enabled buttons for each plugin.
- foreach ($values['buttons'] as $plugin => $buttons) {
- $values['buttons'][$plugin] = array_filter($values['buttons'][$plugin]);
- }
- // Store only enabled plugins.
- $values['buttons'] = array_filter($values['buttons']);
- }
- // Remove any white-space from 'block_formats' setting, since editor
- // implementations rely on a comma-separated list to explode().
- $values['block_formats'] = preg_replace('@\s+@', '', $values['block_formats']);
- // Remove input format name.
- $format = $values['format'];
- $input_format = $values['input_format'];
- $editor = $values['editor'];
- unset($values['format'], $values['input_format'], $values['editor']);
- // Remove FAPI values.
- // @see system_settings_form_submit()
- unset($values['submit'], $values['form_id'], $values['op'], $values['form_token'], $values['form_build_id']);
- // Insert new profile data.
- db_merge('wysiwyg')
- ->key(array('format' => $format))
- ->fields(array(
- 'editor' => $editor,
- 'settings' => serialize($values),
- ))
- ->execute();
- wysiwyg_profile_cache_clear();
- drupal_set_message(t('Wysiwyg profile for %format has been saved.', array('%format' => $input_format)));
- $form_state['redirect'] = 'admin/config/content/wysiwyg';
- }
- /**
- * Layout for the buttons in the Wysiwyg Editor profile form.
- */
- function theme_wysiwyg_admin_button_table($variables) {
- $form = $variables['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 += 3) {
- $row = array();
- $row_buttons = array_slice($buttons, $i, 3) + array_fill(0, 3, array());
- foreach ($row_buttons as $row_button) {
- $row[] = array('data' => $row_button);
- }
- $rows[] = $row;
- }
- $output = theme('table', array('rows' => $rows, 'attributes' => array('width' => '100%')));
- return $output;
- }
- /**
- * Display overview of setup Wysiwyg Editor profiles; menu callback.
- */
- function wysiwyg_profile_overview($form, &$form_state) {
- include_once './includes/install.inc';
- // Check which wysiwyg editors are installed.
- $editors = wysiwyg_get_all_editors();
- $count = count($editors);
- $status = array();
- $options = array('' => t('No editor'));
- // D7's seven theme displays links in table headers as block elements.
- drupal_add_css('table.system-status-report th a {display: inline;}', 'inline');
- 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'] : ''),
- );
- if ($editor['installed']) {
- $options[$name] = $editor['title'] . (isset($editor['installed version']) ? ' ' . $editor['installed version'] : '');
- }
- 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>';
- // Add any install notes.
- if (!empty($editor['install note callback']) && function_exists($editor['install note callback'])) {
- $instructions .= '<div class="editor-install-note">' . $editor['install note callback']() . '</div>';
- }
- $status[$name]['description'] .= $instructions;
- $count--;
- }
- // In case there is an error, always show installation instructions.
- if (isset($editor['error'])) {
- $show_instructions = TRUE;
- }
- }
- if (!$count) {
- $show_instructions = TRUE;
- }
- $form['status'] = array(
- '#type' => 'fieldset',
- '#title' => t('Installation instructions'),
- '#collapsible' => TRUE,
- '#collapsed' => !isset($show_instructions),
- '#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('#markup' => theme('status_report', array('requirements' => $status)));
- if (!$count) {
- return $form;
- }
- $formats = filter_formats();
- $profiles = wysiwyg_profile_load_all();
- $form['formats'] = array(
- '#type' => 'item',
- '#description' => t('To assign a different editor to a text format, click "delete" to remove the existing first.'),
- '#tree' => TRUE,
- );
- $enable_save = FALSE;
- foreach ($formats as $id => $format) {
- $form['formats'][$id]['name'] = array(
- '#markup' => check_plain($format->name),
- );
- // Only display editor selection for associated input formats to avoid
- // confusion about disabled selection.
- if (isset($profiles[$id]) && !empty($profiles[$id]->editor)) {
- $editor_name = $profiles[$id]->editor;
- $installed = !empty($editors[$editor_name]['installed']);
- $form['formats'][$id]['editor'] = array(
- '#wysiwyg-editor-name' => $editor_name,
- );
- if ($installed) {
- $form['formats'][$id]['editor']['#markup'] = $options[$editor_name];
- }
- else {
- drupal_set_message(t('Missing %editor library for %format format. Re-install the %editor library or delete the editor profile.', array(
- '%editor' => $editors[$editor_name]['title'],
- '%format' => $format->name,
- )), 'warning');
- }
- }
- else {
- $form['formats'][$id]['editor'] = array(
- '#type' => 'select',
- '#default_value' => '',
- '#options' => $options,
- );
- $enable_save = TRUE;
- }
- if (isset($profiles[$id]) && !empty($profiles[$id]->editor)) {
- $form['formats'][$id]['edit'] = array(
- '#markup' => l(t('Edit'), "admin/config/content/wysiwyg/profile/$id/edit"),
- );
- $form['formats'][$id]['delete'] = array(
- '#markup' => l(t('Delete'), "admin/config/content/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'));
- }
- return $form;
- }
- /**
- * Return HTML for the Wysiwyg profile overview form.
- */
- function theme_wysiwyg_profile_overview($variables) {
- $form = $variables['form'];
- if (!isset($form['formats'])) {
- return;
- }
- $editors = wysiwyg_get_all_editors();
- $output = '';
- $header = array(t('Text format'), t('Editor'), array('data' => t('Operations'), 'colspan' => 2));
- $rows = array();
- foreach (element_children($form['formats']) as $item) {
- $format = &$form['formats'][$item];
- $row = array(
- 'data' => array(
- drupal_render($format['name']),
- drupal_render($format['editor']),
- isset($format['edit']) ? drupal_render($format['edit']) : '',
- isset($format['delete']) ? drupal_render($format['delete']) : '',
- ),
- );
- if (empty($row['data'][1])) {
- $row['data'][1] = array(
- 'data' => t('Missing library: @library', array('@library' => $editors[$format['editor']['#wysiwyg-editor-name']]['title'])),
- 'class' => 'error',
- );
- $row['class'] = array('error');
- }
- $rows[] = $row;
- }
- $form['formats']['table']['#markup'] = theme('table', array('header' => $header, 'rows' => $rows));
- $output .= drupal_render_children($form);
- return $output;
- }
- /**
- * Submit callback for Wysiwyg profile overview form.
- */
- function wysiwyg_profile_overview_submit($form, &$form_state) {
- foreach ($form_state['values']['formats'] as $format => $values) {
- db_merge('wysiwyg')
- ->key(array('format' => $format))
- ->fields(array(
- 'editor' => $values['editor'],
- ))
- ->execute();
- }
- wysiwyg_profile_cache_clear();
- }
- /**
- * Delete editor profile confirmation form.
- */
- function wysiwyg_profile_delete_confirm($form, &$form_state, $profile) {
- $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/config/content/wysiwyg',
- 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);
- wysiwyg_profile_cache_clear();
- drupal_set_message(t('Wysiwyg profile for %name has been deleted.', array('%name' => $format->name)));
- $form_state['redirect'] = 'admin/config/content/wysiwyg';
- }
|