#141727 by merlinofchaos, dvessel, sun: restore themeability support for maintenance pages (regression)

1 files changed, 258 insertions, 0 deletions

diff --git a/includes/theme.maintenance.inc b/includes/theme.maintenance.inc
new file mode 100644
index 000000000..cfc34e09b
--- /dev/null
+++ b/includes/theme.maintenance.inc
@@ -0,0 +1,258 @@
+<?php
+// $Id$
+
+/**
+ * @file
+ * Theming for maintenance pages.
+ */
+
+/**
+ * Sets up the theming system for site installs, updates and when the site is
+ * in off-line mode. It also applies when the database is unavailable.
+ *
+ * Minnelli is always used for the initial install and update operations. In
+ * other cases, "settings.php" must have a "maintenance_theme" key set for the
+ * $conf variable in order to change the maintenance theme.
+ */
+function _drupal_maintenance_theme() {
+  global $theme, $theme_key;
+
+  // If $theme is already set, assume the others are set too, and do nothing.
+  if (isset($theme)) {
+    return;
+  }
+
+  require_once './includes/path.inc';
+  require_once './includes/theme.inc';
+  require_once './includes/common.inc';
+  require_once './includes/unicode.inc';
+  require_once './includes/file.inc';
+  require_once './includes/module.inc';
+  require_once './includes/database.inc';
+  unicode_check();
+
+  // Load module basics (needed for hook invokes).
+  $module_list['system']['filename'] = 'modules/system/system.module';
+  $module_list['filter']['filename'] = 'modules/filter/filter.module';
+  module_list(TRUE, FALSE, FALSE, $module_list);
+  drupal_load('module', 'system');
+  drupal_load('module', 'filter');
+
+  $themes = list_themes();
+
+  // Install and update pages are treated differently to prevent theming overrides.
+  if (defined('MAINTENANCE_MODE') && (MAINTENANCE_MODE == 'install' || MAINTENANCE_MODE == 'update')) {
+    $theme = 'minnelli';
+  }
+  else {
+    $theme = variable_get('maintenance_theme', 'minnelli');
+  }
+
+  // Store the identifier for retrieving theme settings with.
+  $theme_key = $theme;
+
+  // Find all our ancestor themes and put them in an array.
+  $base_theme = array();
+  $ancestor = $theme;
+  while ($ancestor && isset($themes[$ancestor]->base_theme)) {
+    $base_theme[] = $new_base_theme = $themes[$themes[$ancestor]->base_theme];
+    $ancestor = $themes[$ancestor]->base_theme;
+  }
+  _init_theme($themes[$theme], array_reverse($base_theme), '_theme_load_offline_registry');
+
+  // These are usually added from system_init() -except maintenance.css.
+  // When the database is inactive it's not called so we add it here.
+  drupal_add_css(drupal_get_path('module', 'system') .'/defaults.css', 'module');
+  drupal_add_css(drupal_get_path('module', 'system') .'/system.css', 'module');
+  drupal_add_css(drupal_get_path('module', 'system') .'/system-menus.css', 'module');
+  drupal_add_css(drupal_get_path('module', 'system') .'/maintenance.css', 'module');
+}
+
+/**
+ * This builds the registry when the site needs to bypass any database calls.
+ */
+function _theme_load_offline_registry($theme, $base_theme = NULL, $theme_engine = NULL) {
+  $registry = _theme_build_registry($theme, $base_theme, $theme_engine);
+  _theme_set_registry($registry);
+}
+
+/**
+ * Return a themed list of maintenance tasks to perform.
+ */
+function theme_task_list($items, $active = NULL) {
+  $done = isset($items[$active]) || $active == NULL;
+  $output = '<ol class="task-list">';
+  foreach ($items as $k => $item) {
+    if ($active == $k) {
+      $class = 'active';
+      $done = false;
+    }
+    else {
+      $class = $done ? 'done' : '';
+    }
+    $output .= '<li class="'. $class .'">'. $item .'</li>';
+  }
+  $output .= '</ol>';
+  return $output;
+}
+
+/**
+ * Generate a themed installation page.
+ *
+ * Note: this function is not themeable.
+ *
+ * @param $content
+ *   The page content to show.
+ */
+function theme_install_page($content) {
+  drupal_set_header('Content-Type: text/html; charset=utf-8');
+
+  // Assign content.
+  $variables['content'] = $content;
+  // Delay setting the message variable so it can be processed below.
+  $variables['show_messages'] = FALSE;
+  // The maintenance preprocess function is recycled here.
+  template_preprocess_maintenance_page($variables);
+
+  // Special handling of error messages
+  $messages = drupal_set_message();
+  if (isset($messages['error'])) {
+    $title = count($messages['error']) > 1 ? st('The following errors must be resolved before you can continue the installation process') : st('The following error must be resolved before you can continue the installation process');
+    $variables['messages'] .= '<h3>'. $title .':</h3>';
+    $variables['messages'] .= theme('status_messages', 'error');
+    $variables['content'] .= '<p>'. st('Please check the error messages and <a href="!url">try again</a>.', array('!url' => request_uri())) .'</p>';
+  }
+
+  // Special handling of status messages
+  if (isset($messages['status'])) {
+    $warnings = count($messages['status']) > 1 ? st('The following installation warnings should be carefully reviewed, but in most cases may be safely ignored') : st('The following installation warning should be carefully reviewed, but in most cases may be safely ignored');
+    $variables['messages'] .= '<h4>'. $title .':</h4>';
+    $variables['messages'] .= theme('status_messages', 'status');
+  }
+
+  return theme_render_template('themes/garland/maintenance-page.tpl.php', $variables);
+}
+
+/**
+ * Generate a themed update page.
+ *
+ * Note: this function is not themeable.
+ *
+ * @param $content
+ *   The page content to show.
+ * @param $show_messages
+ *   Whether to output status and error messages.
+ *   FALSE can be useful to postpone the messages to a subsequent page.
+ */
+function theme_update_page($content, $show_messages = TRUE) {
+  // Set required headers.
+  drupal_set_header('Content-Type: text/html; charset=utf-8');
+
+  // Assign content and show message flag.
+  $variables['content'] = $content;
+  $variables['show_messages'] = $show_messages;
+  // The maintenance preprocess function is recycled here.
+  template_preprocess_maintenance_page($variables);
+
+  return theme_render_template('themes/garland/maintenance-page.tpl.php', $variables);
+}
+
+/**
+ * The variables generated here is a mirror of template_preprocess_page().
+ * This preprocessor will run it's course when theme_maintenance_page() is
+ * invoked. It is also used in theme_install_page() and theme_update_page() to
+ * keep all the variables consistent.
+ *
+ * An alternate template file of "maintenance-page-offline.tpl.php" can be
+ * used when the database is offline to hide errors and completely replace the
+ * content.
+ *
+ * The $variables array contains the following arguments:
+ * - $content
+ * - $show_blocks
+ *
+ * @see maintenance-page.tpl.php
+ */
+function template_preprocess_maintenance_page(&$variables) {
+  // Add favicon
+  if (theme_get_setting('toggle_favicon')) {
+    drupal_set_html_head('<link rel="shortcut icon" href="'. check_url(theme_get_setting('favicon')) .'" type="image/x-icon" />');
+  }
+
+  global $theme;
+  // Retrieve the theme data to list all available regions.
+  $theme_data = _system_theme_data();
+  $regions = $theme_data[$theme]->info['regions'];
+
+  // Get all region content set with drupal_set_content().
+  foreach (array_keys($regions) as $region) {
+    // Assign region to a region variable.
+    $region_content = drupal_get_content($region);
+    isset($variables[$region]) ? $variables[$region] .= $region_content : $variables[$region] = $region_content;
+  }
+
+  // Setup layout variable.
+  $variables['layout'] = 'none';
+  if (!empty($variables['left'])) {
+    $variables['layout'] = 'left';
+  }
+  if (!empty($variables['right'])) {
+    $variables['layout'] = ($variables['layout'] == 'left') ? 'both' : 'right';
+  }
+
+  // Construct page title
+  if (drupal_get_title()) {
+    $head_title = array(strip_tags(drupal_get_title()), variable_get('site_name', 'Drupal'));
+  }
+  else {
+    $head_title = array(variable_get('site_name', 'Drupal'));
+    if (variable_get('site_slogan', '')) {
+      $head_title[] = variable_get('site_slogan', '');
+    }
+  }
+  $variables['head_title']        = implode(' | ', $head_title);
+  $variables['base_path']         = base_path();
+  $variables['breadcrumb']        = '';
+  $variables['feed_icons']        = '';
+  $variables['footer_message']    = filter_xss_admin(variable_get('site_footer', FALSE));
+  $variables['head']              = drupal_get_html_head();
+  $variables['help']              = '';
+  $variables['language']          = $GLOBALS['language'];
+  $variables['logo']              = theme_get_setting('logo');
+  $variables['messages']          = $variables['show_messages'] ? theme('status_messages') : '';
+  $variables['mission']           = '';
+  $variables['primary_links']     = array();
+  $variables['secondary_links']   = array();
+  $variables['search_box']        = '';
+  $variables['site_name']         = (theme_get_setting('toggle_name') ? variable_get('site_name', 'Drupal') : '');
+  $variables['site_slogan']       = (theme_get_setting('toggle_slogan') ? variable_get('site_slogan', '') : '');
+  $variables['css']               = drupal_add_css();
+  $variables['styles']            = drupal_get_css();
+  $variables['scripts']           = drupal_get_js();
+  $variables['tabs']              = '';
+  $variables['title']             = drupal_get_title();
+  $variables['closure']           = '';
+
+  // Compile a list of classes that are going to be applied to the body element.
+  $body_classes = array();
+  $body_classes[] = 'in-maintenance';
+  if (isset($variables['db_is_active']) && !$variables['db_is_active']) {
+    $body_classes[] = 'db-offline';
+  }
+  if ($variables['layout'] == 'both') {
+    $body_classes[] = 'two-sidebars';
+  }
+  elseif ($variables['layout'] == 'none') {
+    $body_classes[] = 'no-sidebars';
+  }
+  else {
+    $body_classes[] = 'one-sidebar sidebar-'. $variables['layout'];
+  }
+  $variables['body_classes'] = implode(' ', $body_classes);
+
+  // Dead databases will show error messages so supplying this template will
+  // allow themers to override the page and the content completely.
+  if (isset($variables['db_is_active']) && !$variables['db_is_active']) {
+    $variables['template_file'] = 'maintenance-page-offline';
+  }
+}