danielebarchiesi@0: <?php
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * @file
danielebarchiesi@0:  * Wysiwyg dialog page handling functions.
danielebarchiesi@0:  */
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Page callback; Outputs a dialog page for a wysiwyg plugin.
danielebarchiesi@0:  *
danielebarchiesi@0:  * A Wysiwyg dialog is a bare minimum, simple HTML page; presented in a
danielebarchiesi@0:  * modal/popup window, triggered via JavaScript.
danielebarchiesi@0:  *
danielebarchiesi@0:  * However, Drupal core does not support such a concept, at all.
danielebarchiesi@0:  * Insanity happens on two separate layers:
danielebarchiesi@0:  * - All HTML pages go through the default delivery callback of
danielebarchiesi@0:  *   drupal_deliver_html_page(), which calls into drupal_render_page(), which
danielebarchiesi@0:  *   in turn *unconditionally* invokes hook_page_build() implementations. Thus,
danielebarchiesi@0:  *   block_page_build() and similar implementations add the entirety of their
danielebarchiesi@0:  *   page regions and blocks to our simple dialog page.
danielebarchiesi@0:  *   Obviously, we don't want that.
danielebarchiesi@0:  * - There is a nice default 'page' theme template implementation, which
danielebarchiesi@0:  *   performs all the heavy-lifting that is required for outputting a sane HTML
danielebarchiesi@0:  *   page through preprocess and process functions. The theme system does not
danielebarchiesi@0:  *   support to "inherit" preprocess and process hooks to alternative
danielebarchiesi@0:  *   implementations. Even a very basic HTML page requires almost all of that.
danielebarchiesi@0:  *   However, the default page template (normally overridden by a theme)
danielebarchiesi@0:  *   contains too many regions and usually also huge a header and footer.
danielebarchiesi@0:  *   Obviously, we don't want that.
danielebarchiesi@0:  *
danielebarchiesi@0:  * The poor workaround would be to follow the Overlay module's implementation in
danielebarchiesi@0:  * core: override the theme, build everything, and after doing all of that,
danielebarchiesi@0:  * strip away what isn't needed. Obviously, we don't want that.
danielebarchiesi@0:  *
danielebarchiesi@0:  * Instead, we bend Drupal to sane rules:
danielebarchiesi@0:  * - This page callback returns the actual main content.
danielebarchiesi@0:  * - wysiwyg_menu() defines a custom delivery callback that replaces
danielebarchiesi@0:  *   drupal_deliver_html_page(), just because we need to replace
danielebarchiesi@0:  *   drupal_render_page().
danielebarchiesi@0:  * - Our replacement for drupal_render_page() builds a $page that does not use
danielebarchiesi@0:  *   #type 'page' but #type 'wysiwyg_dialog_page' instead.
danielebarchiesi@0:  * - #type 'wysiwyg_dialog_page' is defined like #type 'page' in
danielebarchiesi@0:  *   system_element_info(), but is required, because there's no way to inherit
danielebarchiesi@0:  *   a theme definition but override the page template file to be used.
danielebarchiesi@0:  * - As a consequence, #type 'wysiwyg_dialog_page' uses
danielebarchiesi@0:  *   #theme 'wysiwyg_dialog_page', for which we have to implement stub
danielebarchiesi@0:  *   preprocess and process callbacks in order to call into the ones for
danielebarchiesi@0:  *   #theme 'page'.
danielebarchiesi@0:  *
danielebarchiesi@0:  * As a result we get:
danielebarchiesi@0:  * - A HTML response.
danielebarchiesi@0:  * - A HTML page wrapped into html.tpl.php.
danielebarchiesi@0:  * - A page title, title prefix/suffix, messages, help, etc.pp.
danielebarchiesi@0:  * - A simple page without regions and blocks (neither built nor rendered).
danielebarchiesi@0:  *
danielebarchiesi@0:  * @see wysiwyg_menu()
danielebarchiesi@0:  * @see wysiwyg_deliver_dialog_page
danielebarchiesi@0:  * @see wysiwyg_render_dialog_page()
danielebarchiesi@0:  * @see wysiwyg_element_info()
danielebarchiesi@0:  * @see wysiwyg_theme()
danielebarchiesi@0:  * @see template_preprocess_wysiwyg_dialog_page()
danielebarchiesi@0:  * @see template_process_wysiwyg_dialog_page()
danielebarchiesi@0:  *
danielebarchiesi@0:  * @see drupal_deliver_page()
danielebarchiesi@0:  * @see drupal_deliver_html_page()
danielebarchiesi@0:  * @see drupal_render_page()
danielebarchiesi@0:  * @see system_element_info()
danielebarchiesi@0:  * @see drupal_common_theme()
danielebarchiesi@0:  * @see template_preprocess_page()
danielebarchiesi@0:  * @see template_process_page()
danielebarchiesi@0:  */
danielebarchiesi@0: function wysiwyg_dialog($plugin, $instance) {
danielebarchiesi@0:   $plugins = wysiwyg_get_all_plugins();
danielebarchiesi@0:   if (!isset($plugins[$plugin])) {
danielebarchiesi@0:     return drupal_access_denied();
danielebarchiesi@0:   }
danielebarchiesi@0:   $callback = $plugin . '_wysiwyg_dialog';
danielebarchiesi@0:   if (!function_exists($callback)) {
danielebarchiesi@0:     return drupal_not_found();
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Suppress admin menu.
danielebarchiesi@0:   module_invoke('admin_menu', 'suppress');
danielebarchiesi@0:   // Add editor instance id to Drupal.settings.
danielebarchiesi@0:   $settings = array(
danielebarchiesi@0:     'plugin' => $plugin,
danielebarchiesi@0:     'instance' => $instance,
danielebarchiesi@0:   );
danielebarchiesi@0:   drupal_add_js(array('wysiwyg' => $settings), 'setting');
danielebarchiesi@0: 
danielebarchiesi@0:   $build = $callback($instance);
danielebarchiesi@0:   if (!is_array($build)) {
danielebarchiesi@0:     $build = array('#markup' => $build);
danielebarchiesi@0:   }
danielebarchiesi@0:   $build += array(
danielebarchiesi@0:     '#instance' => $instance,
danielebarchiesi@0:     '#plugin' => $plugin,
danielebarchiesi@0:   );
danielebarchiesi@0:   return $build;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * @see drupal_deliver_html_page()
danielebarchiesi@0:  */
danielebarchiesi@0: function wysiwyg_deliver_dialog_page($page_callback_result) {
danielebarchiesi@0:   // Menu status constants are integers; page content is a string or array.
danielebarchiesi@0:   if (is_int($page_callback_result)) {
danielebarchiesi@0:     return drupal_deliver_html_page($page_callback_result);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Emit the correct charset HTTP header, but not if the page callback
danielebarchiesi@0:   // result is NULL, since that likely indicates that it printed something
danielebarchiesi@0:   // in which case, no further headers may be sent, and not if code running
danielebarchiesi@0:   // for this page request has already set the content type header.
danielebarchiesi@0:   if (isset($page_callback_result) && is_null(drupal_get_http_header('Content-Type'))) {
danielebarchiesi@0:     drupal_add_http_header('Content-Type', 'text/html; charset=utf-8');
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Send appropriate HTTP-Header for browsers and search engines.
danielebarchiesi@0:   global $language;
danielebarchiesi@0:   drupal_add_http_header('Content-Language', $language->language);
danielebarchiesi@0: 
danielebarchiesi@0:   if (isset($page_callback_result)) {
danielebarchiesi@0:     // Print anything besides a menu constant, assuming it's not NULL or
danielebarchiesi@0:     // undefined.
danielebarchiesi@0:     print wysiwyg_render_dialog_page($page_callback_result);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Perform end-of-request tasks.
danielebarchiesi@0:   drupal_page_footer();
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * @see drupal_render_page()
danielebarchiesi@0:  */
danielebarchiesi@0: function wysiwyg_render_dialog_page($page) {
danielebarchiesi@0:   $main_content_display = &drupal_static('system_main_content_added', FALSE);
danielebarchiesi@0: 
danielebarchiesi@0:   // Allow menu callbacks to return strings or arbitrary arrays to render.
danielebarchiesi@0:   // If the array returned is not of #type page directly, we need to fill
danielebarchiesi@0:   // in the page with defaults.
danielebarchiesi@0:   if (is_string($page) || (is_array($page) && (!isset($page['#type']) || ($page['#type'] != 'page')))) {
danielebarchiesi@0:     drupal_set_page_content($page);
danielebarchiesi@0:     $page = element_info('wysiwyg_dialog_page');
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Modules alter the $page as needed. Blocks are populated into regions like
danielebarchiesi@0:   // 'sidebar_first', 'footer', etc.
danielebarchiesi@0:   drupal_alter(array('wysiwyg_dialog_page', 'page'), $page);
danielebarchiesi@0: 
danielebarchiesi@0:   // If no module has taken care of the main content, add it to the page now.
danielebarchiesi@0:   // This allows the site to still be usable even if no modules that
danielebarchiesi@0:   // control page regions (for example, the Block module) are enabled.
danielebarchiesi@0:   if (!$main_content_display) {
danielebarchiesi@0:     $page['content']['system_main'] = drupal_set_page_content();
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return drupal_render($page);
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Template preprocess function for theme_wysiwyg_dialog_page().
danielebarchiesi@0:  *
danielebarchiesi@0:  * @see wysiwyg_dialog()
danielebarchiesi@0:  * @see wysiwyg-dialog-page.tpl.php
danielebarchiesi@0:  * @see template_preprocess_page()
danielebarchiesi@0:  */
danielebarchiesi@0: function template_preprocess_wysiwyg_dialog_page(&$variables) {
danielebarchiesi@0:   template_preprocess_page($variables);
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Template process function for theme_wysiwyg_dialog_page().
danielebarchiesi@0:  *
danielebarchiesi@0:  * @see wysiwyg_dialog()
danielebarchiesi@0:  * @see wysiwyg-dialog-page.tpl.php
danielebarchiesi@0:  * @see template_process_page()
danielebarchiesi@0:  */
danielebarchiesi@0: function template_process_wysiwyg_dialog_page(&$variables) {
danielebarchiesi@0:   template_process_page($variables);
danielebarchiesi@0: }
danielebarchiesi@0: