Newer
Older
<?php
// $Id$
/**
* @file
* Integrate client-side editors with Drupal.
*/
/**
* Implementation of hook_menu().
*/
function wysiwyg_menu($may_cache) {
$items = array();
if ($may_cache) {
$items[] = array(
'path' => 'admin/settings/wysiwyg/profile',
'title' => t('Wysiwyg'),
'callback' => 'wysiwyg_admin',
'description' => t('Configure client-side editor profiles.'),
Daniel Kudwien
committed
'access' => user_access('administer filters'),
Daniel Kudwien
committed
$items[] = array(
'path' => 'wysiwyg',
'callback' => 'wysiwyg_dialog',
'access' => user_access('access content'),
'type' => MENU_CALLBACK,
);
}
return $items;
}
/**
* Implementation of hook_help().
*/
function wysiwyg_help($section) {
switch ($section) {
case 'admin/settings/wysiwyg/profile':
if (!arg(4)) {
$output = '<p>'. t('A Wysiwyg profile can be associated to an input format. A Wysiwyg profile defines which client-side editor is loaded, what buttons or themes are enabled for the editor, how the editor is displayed, and a few other editor-specific functions.') .'</p>';
return $output;
}
break;
}
}
Daniel Kudwien
committed
/**
* Callback handler for dialog page; menu callback.
*/
function wysiwyg_dialog($plugin, $instance) {
require_once drupal_get_path('module', 'wysiwyg') .'/wysiwyg.dialog.inc';
return _wysiwyg_dialog($plugin, $instance);
}
/**
* Callback handler for admin pages; menu callback.
*/
function wysiwyg_admin($arg = '', $name = '') {
require_once drupal_get_path('module', 'wysiwyg') .'/wysiwyg.admin.inc';
return _wysiwyg_admin($arg, $name);
}
/**
* Implementation of hook_form_alter().
*
* Before Drupal 7, there is no way to easily identify form fields that are
* input format enabled. As a workaround, we assign a form #after_build
* processing callback that is executed on all forms after they have been
* completely built, so form elements are in their effective order
* and position already.
*
* @see wysiwyg_process_form()
*/
function wysiwyg_form_alter($form_id, &$form) {
$form['#after_build'][] = 'wysiwyg_process_form';
// Blog module in Drupal 5 uses a wrong/unusual form element key for the input
// format selector.
Daniel Kudwien
committed
if ($form_id == 'blog_node_form' && module_exists('blog')) {
$form['body_filter']['format'] = $form['body_filter']['filter'];
unset($form['body_filter']['filter']);
}
}
/**
* Process a textarea for Wysiwyg Editor.
*
* This way, we can recurse into the form and search for certain, hard-coded
* elements that have been added by filter_form(). If an input format selector
* or input format guidelines element is found, we assume that the preceding
* element is the corresponding textarea and use it's #id for attaching
* client-side editors.
*
* @see wysiwyg_elements(), filter_form()
*/
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
function wysiwyg_process_form(&$form) {
// Iterate over element children; resetting array keys to access last index.
if ($children = array_values(element_children($form))) {
foreach ($children as $index => $item) {
$element = &$form[$item];
// filter_form() always uses the key 'format'. We need a type-agnostic
// match to prevent false positives. Also, there must have been at least
// one element on this level.
if ($item === 'format' && $index > 0) {
// Make sure we either match a input format selector or input format
// guidelines (displayed if user has access to one input format only).
if ((isset($element['#type']) && $element['#type'] == 'fieldset') || isset($element['format']['guidelines'])) {
// The element before this element is the target form field.
$field = &$form[$children[$index - 1]];
// Disable #resizable to avoid resizable behavior to hi-jack the UI,
// but load the behavior, so the 'none' editor can attach/detach it.
$extra_class = '';
if (!isset($field['#resizable']) || !empty($field['#resizable'])) {
// Due to our CSS class parsing, we can add arbitrary parameters
// for each input format.
$extra_class = ' wysiwyg-resizable-1';
$field['#resizable'] = FALSE;
drupal_add_js('misc/textarea.js');
}
// Determine the available input formats. The last child element is a
// link to "More information about formatting options". When only one
// input format is displayed, we also have to remove formatting
// guidelines, stored in the child 'format'.
$formats = element_children($element);
array_pop($formats);
if (($key = array_search('format', $formats)) !== FALSE) {
unset($formats[$key]);
}
foreach ($formats as $format) {
// Default to 'none' editor (Drupal's default behaviors).
$editor = 'none';
Daniel Kudwien
committed
$status = 1;
$toggle = 1;
// Fetch the profile associated to this input format.
$profile = wysiwyg_get_profile($format);
if ($profile) {
Daniel Kudwien
committed
$editor = $profile->editor;
$status = (int) wysiwyg_user_get_status($profile);
$toggle = (int) $profile->settings['show_toggle'];
// Check editor theme (and reset it if not/no longer available).
Daniel Kudwien
committed
$theme = wysiwyg_get_editor_themes($profile, (isset($profile->settings['theme']) ? $profile->settings['theme'] : ''));
// Add plugin settings (first) for this input format.
wysiwyg_add_plugin_settings($profile);
// Add profile settings for this input format.
wysiwyg_add_editor_settings($profile, $theme);
}
// Use a prefix/suffix for a single input format, or attach to input
// format selector radio buttons.
if (isset($element['format']['guidelines'])) {
$element['format']['guidelines']['#prefix'] = '<div class="wysiwyg wysiwyg-format-' . $format . ' wysiwyg-editor-' . $editor . ' wysiwyg-field-' . $field['#id'] . ' wysiwyg-status-' . $status . ' wysiwyg-toggle-' . $toggle . $extra_class . '">';
$element['format']['guidelines']['#suffix'] = '</div>';
// Edge-case: Default format contains no input filters.
if (empty($element['format']['guidelines']['#value'])) {
$element['format']['guidelines']['#value'] = ' ';
}
}
else {
$element[$format]['#attributes']['class'] = (isset($element[$format]['#attributes']['class']) ? $element[$format]['#attributes']['class'] . ' ' : '');
$element[$format]['#attributes']['class'] .= 'wysiwyg wysiwyg-format-' . $format . ' wysiwyg-editor-' . $editor . ' wysiwyg-field-' . $field['#id'] . ' wysiwyg-status-' . $status . ' wysiwyg-toggle-' . $toggle . $extra_class;
}
}
}
// If this element is 'format', do not recurse further.
continue;
}
// Recurse into children.
wysiwyg_process_form($element);
}
}
return $form;
}
/**
* Determine the profile to use for a given input format id.
*
* This function also performs sanity checks for the configured editor in a
* profile to ensure that we do not load a malformed editor.
*
* @param $format
* The internal id of an input format.
*
* @return
* A wysiwyg profile.
*
* @see wysiwyg_load_editor(), wysiwyg_get_editor()
*/
function wysiwyg_get_profile($format) {
Daniel Kudwien
committed
if ($profile = wysiwyg_load_profile($format)) {
if (wysiwyg_load_editor($profile)) {
return $profile;
}
}
return FALSE;
}
/**
* Load an editor library and initialize basic Wysiwyg settings.
*
* @param $profile
* A wysiwyg editor profile.
*
* @return
* TRUE if the editor has been loaded, FALSE if not.
*
* @see wysiwyg_get_profile()
*/
function wysiwyg_load_editor($profile) {
static $settings_added;
static $loaded = array();
Daniel Kudwien
committed
$name = $profile->editor;
// Library files must be loaded only once.
if (!isset($loaded[$name])) {
// Load editor.
$editor = wysiwyg_get_editor($name);
if ($editor) {
// Determine library files to load.
// @todo Allow to configure the library/execMode to use.
if (isset($profile->settings['library']) && isset($editor['libraries'][$profile->settings['library']])) {
$library = $profile->settings['library'];
$files = $editor['libraries'][$library]['files'];
}
else {
// Fallback to the first defined library by default (external libraries can change).
$library = key($editor['libraries']);
$files = array_shift($editor['libraries']);
$files = $files['files'];
}
Daniel Kudwien
committed
foreach ($files as $file => $options) {
if (is_array($options)) {
$options += array('type' => 'module', 'scope' => 'header', 'defer' => FALSE, 'cache' => TRUE, 'preprocess' => TRUE);
drupal_add_js($editor['library path'] . '/' . $file, $options['type'], $options['scope'], $options['defer'], $options['cache'], $options['preprocess']);
}
else {
drupal_add_js($editor['library path'] . '/' . $options);
}
// If editor defines an additional load callback, invoke it.
// @todo Isn't the settings callback sufficient?
if (isset($editor['load callback']) && function_exists($editor['load callback'])) {
$editor['load callback']($editor, $library);
}
// Load JavaScript integration files for this editor.
$files = array();
if (isset($editor['js files'])) {
$files = $editor['js files'];
}
foreach ($files as $file) {
Daniel Kudwien
committed
drupal_add_js($editor['js path'] . '/' . $file);
// Load CSS stylesheets for this editor.
$files = array();
if (isset($editor['css files'])) {
$files = $editor['css files'];
}
foreach ($files as $file) {
drupal_add_css($editor['css path'] . '/' . $file);
drupal_add_js(array('wysiwyg' => array(
'configs' => array($editor['name'] => array()),
Daniel Kudwien
committed
'showToggle' => isset($profile->settings['show_toggle']) ? $profile->settings['show_toggle'] : TRUE,
// @todo Move into (global) editor settings.
// If JS compression is enabled, at least TinyMCE is unable to determine
// its own base path and exec mode since it can't find the script name.
'editorBasePath' => base_path() . $editor['library path'],
'execMode' => $library,
)), 'setting');
$loaded[$name] = TRUE;
}
else {
$loaded[$name] = FALSE;
}
}
// Add basic Wysiwyg settings if any editor has been added.
if (!isset($settings_added) && $loaded[$name]) {
drupal_add_js(array('wysiwyg' => array(
'configs' => array(),
'disable' => t('Disable rich-text'),
'enable' => t('Enable rich-text'),
)), 'setting');
$path = drupal_get_path('module', 'wysiwyg');
// Initialize our namespaces in the *header* to do not force editor
// integration scripts to check and define Drupal.wysiwyg on its own.
drupal_add_js($path . '/wysiwyg.init.js', 'core');
// The 'none' editor is a special editor implementation, allowing us to
// attach and detach regular Drupal behaviors just like any other editor.
drupal_add_js($path . '/editors/js/none.js');
// Add wysiwyg.js to the footer to ensure it's executed after the
// Drupal.settings array has been rendered and populated. Also, since editor
// library initialization functions must be loaded first by the browser,
// and Drupal.wysiwygInit() must be executed AFTER editors registered
// their callbacks and BEFORE Drupal.behaviors are applied, this must come
// last.
drupal_add_js($path . '/wysiwyg.js', 'module', 'footer');
$settings_added = TRUE;
}
return $loaded[$name];
}
/**
Daniel Kudwien
committed
* Add editor settings for a given input format.
*/
function wysiwyg_add_editor_settings($profile, $theme) {
Daniel Kudwien
committed
static $formats = array();
Daniel Kudwien
committed
if (!isset($formats[$profile->format])) {
$config = wysiwyg_get_editor_config($profile, $theme);
Daniel Kudwien
committed
// drupal_to_js() does not properly convert numeric array keys, so we need
// to use a string instead of the format id.
drupal_add_js(array('wysiwyg' => array('configs' => array($profile->editor => array('format'. $profile->format => $config)))), 'setting');
$formats[$profile->format] = TRUE;
}
}
/**
* Add settings for external plugins.
Daniel Kudwien
committed
*
* Plugins can be used in multiple profiles, but not necessarily in all. Because
* of that, we need to process plugins for each profile, even if most of their
* settings are not stored per profile.
*
* Implementations of hook_wysiwyg_plugin() may execute different code for each
* editor. Therefore, we have to invoke those implementations for each editor,
* but process the resulting plugins separately for each profile.
*
* Drupal plugins differ to native plugins in that they have plugin-specific
* definitions and settings, which need to be processed only once. But they are
* also passed to the editor to prepare settings specific to the editor.
* Therefore, we load and process the Drupal plugins only once, and hand off the
* effective definitions for each profile to the editor.
*
* @param $profile
* A wysiwyg editor profile.
Daniel Kudwien
committed
*
* @todo Rewrite wysiwyg_process_form() to build a registry of effective
* profiles in use, so we can process plugins in multiple profiles in one shot
* and simplify this entire function.
*/
function wysiwyg_add_plugin_settings($profile) {
static $plugins = array();
static $processed_plugins = array();
static $processed_formats = array();
// Each input format must only processed once.
// @todo ...as long as we do not have multiple profiles per format.
if (isset($processed_formats[$profile->format])) {
return;
}
$processed_formats[$profile->format] = TRUE;
$editor = wysiwyg_get_editor($profile->editor);
// Collect native plugins for this editor provided via hook_wysiwyg_plugin()
// and Drupal plugins provided via hook_wysiwyg_include_directory().
if (!array_key_exists($editor['name'], $plugins)) {
$plugins[$editor['name']] = wysiwyg_get_plugins($editor['name']);
}
// Nothing to do, if there are no plugins.
if (empty($plugins[$editor['name']])) {
Daniel Kudwien
committed
return;
}
// Determine name of proxy plugin for Drupal plugins.
$proxy = (isset($editor['proxy plugin']) ? key($editor['proxy plugin']) : '');
// Process native editor plugins.
if (isset($editor['plugin settings callback'])) {
// @todo Require PHP 5.1 in 3.x and use array_intersect_key().
$profile_plugins_native = array();
foreach ($plugins[$editor['name']] as $plugin => $meta) {
// Skip Drupal plugins (handled below).
if ($plugin === $proxy) {
continue;
Daniel Kudwien
committed
}
// Only keep native plugins that are enabled in this profile.
if (isset($profile->settings['buttons'][$plugin])) {
$profile_plugins_native[$plugin] = $meta;
Daniel Kudwien
committed
}
}
// Invoke the editor's plugin settings callback, so it can populate the
// settings for native external plugins with required values.
$settings_native = call_user_func($editor['plugin settings callback'], $editor, $profile, $profile_plugins_native);
drupal_add_js(array('wysiwyg' => array('plugins' => array('format' . $profile->format => array('native' => $settings_native)))), 'setting');
Daniel Kudwien
committed
}
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
// Process Drupal plugins.
if ($proxy && isset($editor['proxy plugin settings callback'])) {
$profile_plugins_drupal = array();
foreach (wysiwyg_get_all_plugins() as $plugin => $meta) {
if (isset($profile->settings['buttons'][$proxy][$plugin])) {
// JavaScript and plugin-specific settings for Drupal plugins must be
// loaded and processed only once. Plugin information is cached
// statically to pass it to the editor's proxy plugin settings callback.
if (!isset($processed_plugins[$proxy][$plugin])) {
$profile_plugins_drupal[$plugin] = $processed_plugins[$proxy][$plugin] = $meta;
// Load the Drupal plugin's JavaScript.
drupal_add_js($meta['js path'] .'/'. $meta['js file']);
// Add plugin-specific settings.
if (isset($meta['settings'])) {
drupal_add_js(array('wysiwyg' => array('plugins' => array('drupal' => array($plugin => $meta['settings'])))), 'setting');
}
}
else {
$profile_plugins_drupal[$plugin] = $processed_plugins[$proxy][$plugin];
}
}
}
// Invoke the editor's proxy plugin settings callback, so it can populate
// the settings for Drupal plugins with custom, required values.
$settings_drupal = call_user_func($editor['proxy plugin settings callback'], $editor, $profile, $profile_plugins_drupal);
drupal_add_js(array('wysiwyg' => array('plugins' => array('format' . $profile->format => array('drupal' => $settings_drupal)))), 'setting');
}
}
/**
Daniel Kudwien
committed
* Retrieve available themes for an editor.
*
Daniel Kudwien
committed
* Editor themes control the visual presentation of an editor.
*
* @param $profile
* A wysiwyg editor profile; passed/altered by reference.
* @param $selected_theme
* An optional theme name that ought to be used.
*
* @return
* An array of theme names, or a single, checked theme name if $selected_theme
* was given.
*/
function wysiwyg_get_editor_themes(&$profile, $selected_theme = NULL) {
static $themes = array();
Daniel Kudwien
committed
if (!isset($themes[$profile->editor])) {
$editor = wysiwyg_get_editor($profile->editor);
if (isset($editor['themes callback']) && function_exists($editor['themes callback'])) {
$themes[$editor['name']] = $editor['themes callback']($editor, $profile);
}
// Fallback to 'default' otherwise.
else {
$themes[$editor['name']] = array('default');
}
}
// Check optional $selected_theme argument, if given.
if (isset($selected_theme)) {
// If the passed theme name does not exist, use the first available.
Daniel Kudwien
committed
if (!isset($themes[$profile->editor][$selected_theme])) {
$selected_theme = $profile->settings['theme'] = $themes[$profile->editor][0];
}
Daniel Kudwien
committed
return isset($selected_theme) ? $selected_theme : $themes[$profile->editor];
}
/**
* Return plugin metadata from the plugin registry.
*
* @param $editor_name
* The internal name of an editor to return plugins for.
*
* @return
* An array for each plugin.
*/
function wysiwyg_get_plugins($editor_name) {
$plugins = array();
if (!empty($editor_name)) {
$editor = wysiwyg_get_editor($editor_name);
// Add internal editor plugins.
if (isset($editor['plugin callback']) && function_exists($editor['plugin callback'])) {
$plugins = $editor['plugin callback']($editor);
}
// Add editor plugins provided via hook_wysiwyg_plugin().
$plugins = array_merge($plugins, module_invoke_all('wysiwyg_plugin', $editor['name'], $editor['installed version']));
Daniel Kudwien
committed
// Add API plugins provided by Drupal modules.
// @todo We need to pass the filepath to the plugin icon for Drupal plugins.
if (isset($editor['proxy plugin'])) {
$plugins += $editor['proxy plugin'];
$proxy = key($editor['proxy plugin']);
foreach (wysiwyg_get_all_plugins() as $plugin_name => $info) {
$plugins[$proxy]['buttons'][$plugin_name] = $info['title'];
}
}
}
return $plugins;
}
/**
Daniel Kudwien
committed
* Return an array of initial editor settings for a Wysiwyg profile.
*/
function wysiwyg_get_editor_config($profile, $theme) {
Daniel Kudwien
committed
$editor = wysiwyg_get_editor($profile->editor);
$settings = array();
if (!empty($editor['settings callback']) && function_exists($editor['settings callback'])) {
$settings = $editor['settings callback']($editor, $profile->settings, $theme);
}
return $settings;
}
/**
* Retrieve stylesheets for HTML/IFRAME-based editors.
*
* This assumes that the content editing area only needs stylesheets defined
* for the scope 'theme'.
*
* @return
* An array containing CSS files, including proper base path.
*/
function wysiwyg_get_css() {
static $files;
if (isset($files)) {
return $files;
}
// In node form previews, the theme has not been initialized yet.
init_theme();
$files = array();
foreach (drupal_add_css() as $media => $css) {
if ($media != 'print') {
foreach ($css['theme'] as $filepath => $preprocess) {
$files[] = base_path() . $filepath;
}
}
}
return $files;
}
/**
* Load all profiles. Just load one profile if $name is passed in.
*/
Daniel Kudwien
committed
function wysiwyg_load_profile($format = '') {
static $profiles;
if (!isset($profiles)) {
$profiles = array();
Daniel Kudwien
committed
$result = db_query('SELECT * FROM {wysiwyg}');
while ($profile = db_fetch_object($result)) {
$profile->settings = unserialize($profile->settings);
Daniel Kudwien
committed
$profiles[$profile->format] = $profile;
}
}
Daniel Kudwien
committed
return ($format && isset($profiles[$format]) ? $profiles[$format] : ($format ? FALSE : $profiles));
}
/**
* Implementation of hook_user().
*/
function wysiwyg_user($type, &$edit, &$user, $category = NULL) {
Daniel Kudwien
committed
if ($type == 'form' && $category == 'account') {
// @todo http://drupal.org/node/322433
$profile = new stdClass;
if (isset($profile->settings['user_choose']) && $profile->settings['user_choose']) {
$form['wysiwyg'] = array(
'#type' => 'fieldset',
'#title' => t('Wysiwyg Editor settings'),
'#weight' => 10,
'#collapsible' => TRUE,
'#collapsed' => TRUE,
);
$form['wysiwyg']['wysiwyg_status'] = array(
'#type' => 'checkbox',
'#title' => t('Enable editor by default'),
'#default_value' => isset($user->wysiwyg_status) ? $user->wysiwyg_status : (isset($profile->settings['default']) ? $profile->settings['default'] : FALSE),
'#return_value' => 1,
'#description' => t('If enabled, rich-text editing is enabled by default in textarea fields.'),
);
return array('wysiwyg' => $form);
}
}
Daniel Kudwien
committed
elseif ($type == 'validate' && isset($edit['wysiwyg_status'])) {
return array('wysiwyg_status' => $edit['wysiwyg_status']);
}
}
function wysiwyg_user_get_status($profile) {
global $user;
if (!empty($profile->settings['user_choose']) && isset($user->wysiwyg_status)) {
$status = $user->wysiwyg_status;
}
else {
Daniel Kudwien
committed
$status = isset($profile->settings['default']) ? $profile->settings['default'] : TRUE;
}
return $status;
}
/**
* @defgroup wysiwyg_api Wysiwyg API
* @{
*
* @todo Forked from Panels; abstract into a separate API module that allows
* contrib modules to define supported include/plugin types.
*/
/**
* Return library information for a given editor.
*
* @param $name
* The internal name of an editor.
*
* @return
* The library information for the editor, or FALSE if $name is unknown or not
* installed properly.
*/
function wysiwyg_get_editor($name) {
$editors = wysiwyg_get_all_editors();
return isset($editors[$name]) && $editors[$name]['installed'] ? $editors[$name] : FALSE;
}
/**
* Compile a list holding all supported editors including installed editor version information.
*/
function wysiwyg_get_all_editors() {
static $editors;
if (isset($editors)) {
return $editors;
}
$editors = wysiwyg_load_includes('editors', 'editor');
foreach ($editors as $editor => $properties) {
// Fill in required properties.
$editors[$editor] += array(
'title' => '',
'vendor url' => '',
'download url' => '',
'editor path' => wysiwyg_get_path($editors[$editor]['name']),
'library path' => wysiwyg_get_path($editors[$editor]['name']),
'libraries' => array(),
'version callback' => NULL,
'themes callback' => NULL,
'settings callback' => NULL,
'plugin callback' => NULL,
'plugin settings callback' => NULL,
'versions' => array(),
'js path' => $editors[$editor]['path'] . '/js',
'css path' => $editors[$editor]['path'] . '/css',
);
// Check whether library is present.
if (!($editors[$editor]['installed'] = file_exists($editors[$editor]['library path']))) {
continue;
}
// Detect library version.
if (function_exists($editors[$editor]['version callback'])) {
$editors[$editor]['installed version'] = $editors[$editor]['version callback']($editors[$editor]);
}
if (empty($editors[$editor]['installed version'])) {
$editors[$editor]['error'] = t('The version of %editor could not be detected.', array('%editor' => $properties['title']));
$editors[$editor]['installed'] = FALSE;
continue;
}
// Determine to which supported version the installed version maps.
ksort($editors[$editor]['versions']);
$version = 0;
foreach ($editors[$editor]['versions'] as $supported_version => $version_properties) {
if (version_compare($editors[$editor]['installed version'], $supported_version, '>=')) {
$version = $supported_version;
}
}
if (!$version) {
$editors[$editor]['error'] = t('The installed version %version of %editor is not supported.', array('%version' => $editors[$editor]['installed version'], '%editor' => $editors[$editor]['title']));
$editors[$editor]['installed'] = FALSE;
continue;
}
// Apply library version specific definitions and overrides.
$editors[$editor] = array_merge($editors[$editor], $editors[$editor]['versions'][$version]);
unset($editors[$editor]['versions']);
}
return $editors;
}
Daniel Kudwien
committed
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
/**
* Invoke hook_wysiwyg_plugin() in all modules.
*/
function wysiwyg_get_all_plugins() {
static $plugins;
if (isset($plugins)) {
return $plugins;
}
$plugins = wysiwyg_load_includes('plugins', 'plugin');
foreach ($plugins as $name => $properties) {
$plugin = &$plugins[$name];
// Fill in required/default properties.
$plugin += array(
'title' => $plugin['name'],
'vendor url' => '',
'js path' => $plugin['path'] . '/' . $plugin['name'],
'js file' => $plugin['name'] . '.js',
'css path' => $plugin['path'] . '/' . $plugin['name'],
'css file' => $plugin['name'] . '.css',
'icon path' => $plugin['path'] . '/' . $plugin['name'] . '/images',
'icon file' => $plugin['name'] . '.png',
'dialog path' => $plugin['name'],
'dialog settings' => array(),
'settings callback' => NULL,
'settings form callback' => NULL,
);
// Fill in default settings.
$plugin['settings'] += array(
'path' => base_path() . $plugin['path'] . '/' . $plugin['name'],
);
// Check whether library is present.
if (!($plugin['installed'] = file_exists($plugin['js path'] . '/' . $plugin['js file']))) {
continue;
}
}
return $plugins;
}
/**
* Load include files for wysiwyg implemented by all modules.
*
* @param $type
* The type of includes to search for, can be 'editors'.
* @param $hook
* The hook name to invoke.
* @param $file
* An optional include file name without .inc extension to limit the search to.
*
* @see wysiwyg_get_directories(), _wysiwyg_process_include()
*/
function wysiwyg_load_includes($type = 'editors', $hook = 'editor', $file = NULL) {
// Determine implementations.
$directories = wysiwyg_get_directories($type);
$directories['wysiwyg_'] = drupal_get_path('module', 'wysiwyg') . '/' . $type;
$file_list = array();
foreach ($directories as $module => $path) {
$file_list[$module] = drupal_system_listing("$file" . '.inc$', $path, 'name', 0);
}
// Load implementations.
$info = array();
foreach (array_filter($file_list) as $module => $files) {
foreach ($files as $file) {
include_once './' . $file->filename;
$result = _wysiwyg_process_include('wysiwyg', $module . $file->name, dirname($file->filename), $hook);
if (is_array($result)) {
$info = array_merge($info, $result);
}
}
return $info;
}
/**
* Helper function to build paths to libraries.
* @param $library
* The external library name to return the path for.
* @param $base_path
* Whether to prefix the resulting path with base_path().
*
* @return
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
* The path to the specified library.
*
* @ingroup libraries
*/
function wysiwyg_get_path($library, $base_path = FALSE) {
static $libraries;
if (!isset($libraries)) {
$libraries = wysiwyg_get_libraries();
}
if (!isset($libraries[$library])) {
// Most often, external libraries can be shared across multiple sites.
return 'sites/all/libraries/' . $library;
}
$path = ($base_path ? base_path() : '');
$path .= $libraries[$library];
return $path;
}
/**
* Return an array of library directories.
*
* Returns an array of library directories from the all-sites directory
* (i.e. sites/all/libraries/), the profiles directory, and site-specific
* directory (i.e. sites/somesite/libraries/). The returned array will be keyed
* by the library name. Site-specific libraries are prioritized over libraries
* in the default directories. That is, if a library with the same name appears
* in both the site-wide directory and site-specific directory, only the
* site-specific version will be listed.
*
* @return
* A list of library directories.
*
* @ingroup libraries
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
function wysiwyg_get_libraries() {
global $profile;
// When this function is called during Drupal's initial installation process,
// the name of the profile that is about to be installed is stored in the
// global $profile variable. At all other times, the regular system variable
// contains the name of the current profile, and we can call variable_get()
// to determine the profile.
if (!isset($profile)) {
$profile = variable_get('install_profile', 'default');
}
$directory = 'libraries';
$searchdir = array();
$config = conf_path();
// The 'profiles' directory contains pristine collections of modules and
// themes as organized by a distribution. It is pristine in the same way
// that /modules is pristine for core; users should avoid changing anything
// there in favor of sites/all or sites/<domain> directories.
if (file_exists("profiles/$profile/$directory")) {
$searchdir[] = "profiles/$profile/$directory";
}
// Always search sites/all/*.
$searchdir[] = 'sites/all/'. $directory;
// Also search sites/<domain>/*.
if (file_exists("$config/$directory")) {
$searchdir[] = "$config/$directory";
}
// Retrieve list of directories.
// @todo Core: Allow to scan for directories.
$directories = array();
$nomask = array('CVS');
foreach ($searchdir as $dir) {
if (is_dir($dir) && $handle = opendir($dir)) {
while (FALSE !== ($file = readdir($handle))) {
if (!in_array($file, $nomask) && $file[0] != '.') {
if (is_dir("$dir/$file")) {
$directories[$file] = "$dir/$file";
}
}
}
closedir($handle);
}
}
return $directories;
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
}
/**
* Return a list of directories by modules implementing wysiwyg_include_directory().
*
* @param $plugintype
* The type of a plugin; can be 'editors'.
*
* @return
* An array containing module names suffixed with '_' and their defined
* directory.
*
* @see wysiwyg_load_includes(), _wysiwyg_process_include()
*/
function wysiwyg_get_directories($plugintype) {
$directories = array();
foreach (module_implements('wysiwyg_include_directory') as $module) {
$result = module_invoke($module, 'wysiwyg_include_directory', $plugintype);
if (isset($result) && is_string($result)) {
$directories[$module .'_'] = drupal_get_path('module', $module) .'/'. $result;
}
}
return $directories;
}
/**
* Process a single hook implementation of a wysiwyg editor.
*
* @param $module
* The module that owns the hook.
* @param $identifier
* Either the module or 'wysiwyg_' . $file->name
* @param $hook
* The name of the hook being invoked.
*/
function _wysiwyg_process_include($module, $identifier, $path, $hook) {
$function = $identifier . '_' . $hook;
if (!function_exists($function)) {
return NULL;
}
$result = $function();
if (!isset($result) || !is_array($result)) {
return NULL;
}
// Fill in defaults.
foreach ($result as $editor => $properties) {
$result[$editor]['module'] = $module;
$result[$editor]['name'] = $editor;
$result[$editor]['path'] = $path;
}
return $result;
}
/**
* @} End of "defgroup wysiwyg_api".
*/