theme.maintenance.inc 7.39 KB
Newer Older
1 2 3 4 5 6 7 8
<?php

/**
 * @file
 * Theming for maintenance pages.
 */

/**
9
 * Sets up the theming system for maintenance page.
10
 *
11 12
 * Used for site installs, updates and when the site is in maintenance mode.
 * It also applies when the database is unavailable or bootstrap was not
13 14 15
 * complete. Seven is always used for the initial install and update
 * operations. In other cases, Bartik is used, but this can be overridden by
 * setting a "maintenance_theme" key in the $conf variable in settings.php.
16 17
 */
function _drupal_maintenance_theme() {
18
  global $theme, $theme_key, $conf;
19 20 21 22 23 24

  // If $theme is already set, assume the others are set too, and do nothing.
  if (isset($theme)) {
    return;
  }

25
  require_once DRUPAL_ROOT . '/' . settings()->get('path_inc', 'core/includes/path.inc');
26 27 28 29 30
  require_once DRUPAL_ROOT . '/core/includes/theme.inc';
  require_once DRUPAL_ROOT . '/core/includes/common.inc';
  require_once DRUPAL_ROOT . '/core/includes/unicode.inc';
  require_once DRUPAL_ROOT . '/core/includes/file.inc';
  require_once DRUPAL_ROOT . '/core/includes/module.inc';
31 32 33 34
  unicode_check();

  // Install and update pages are treated differently to prevent theming overrides.
  if (defined('MAINTENANCE_MODE') && (MAINTENANCE_MODE == 'install' || MAINTENANCE_MODE == 'update')) {
35
    $custom_theme = (isset($conf['maintenance_theme']) ? $conf['maintenance_theme'] : 'seven');
36 37
  }
  else {
38 39 40
    // The bootstrap was not complete. So we are operating in a crippled
    // environment, we need to bootstrap just enough to allow hook invocations
    // to work. See _drupal_log_error().
41
    if (!class_exists('Drupal\Core\Database\Database', FALSE)) {
42
      require_once DRUPAL_ROOT . '/core/includes/database.inc';
43 44
    }

45
    // We use the default theme as the maintenance theme. If a default theme
46
    // isn't specified in the database or in settings.php, we use Bartik.
47 48 49 50 51 52
    // @todo Should use the actual default theme configured, but that depends on
    //   configuration being available while possibly not having a working
    //   database connection (yet). And only if that fails, should fall back to
    //   Stark otherwise. Since there is no low-level access to configuration
    //   currently, we only consult settings.php and fall back to Bartik
    //   otherwise, as it looks generic enough and way more user-friendly.
53
    $custom_theme = variable_get('maintenance_theme', config('system.theme')->get('default')) ?: 'bartik';
54 55
  }

56 57
  // Ensure that system.module is loaded.
  if (!function_exists('_system_rebuild_theme_data')) {
58 59 60 61
    $module_list['system'] = 'core/modules/system/system.module';
    $module_handler = drupal_container()->get('module_handler');
    $module_handler->setModuleList($module_list);
    $module_handler->load('system');
62 63
  }

64 65
  $themes = list_themes();

66 67 68 69 70
  // list_themes() triggers a drupal_alter() in maintenance mode, but we can't
  // let themes alter the .info data until we know a theme's base themes. So
  // don't set global $theme until after list_themes() builds its cache.
  $theme = $custom_theme;

71 72 73 74 75 76 77 78 79 80
  // 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;
  }
81
  _drupal_theme_initialize($themes[$theme], array_reverse($base_theme), '_theme_load_offline_registry');
82 83 84

  // These are usually added from system_init() -except maintenance.css.
  // When the database is inactive it's not called so we add it here.
85 86 87 88 89
  $path = drupal_get_path('module', 'system');
  drupal_add_css($path . '/system.base.css');
  drupal_add_css($path . '/system.admin.css');
  drupal_add_css($path . '/system.theme.css');
  drupal_add_css($path . '/system.maintenance.css');
90 91 92
}

/**
93
 * Builds the registry when the site needs to bypass any database calls.
94 95
 */
function _theme_load_offline_registry($theme, $base_theme = NULL, $theme_engine = NULL) {
96
  return _theme_build_registry($theme, $base_theme, $theme_engine);
97 98 99
}

/**
100 101 102 103 104 105
 * Returns HTML for a list of maintenance tasks to perform.
 *
 * @param $variables
 *   An associative array containing:
 *   - items: An associative array of maintenance tasks.
 *   - active: The key for the currently active maintenance task.
106
 *
107
 * @ingroup themeable
108
 */
109
function theme_task_list($variables) {
110
  $t = get_t();
111 112 113
  $items = $variables['items'];
  $active = $variables['active'];

114
  $done = isset($items[$active]) || $active == NULL;
115 116 117
  $output = '<h2 class="element-invisible">Installation tasks</h2>';
  $output .= '<ol class="task-list">';

118 119 120
  foreach ($items as $k => $item) {
    if ($active == $k) {
      $class = 'active';
121
      $status = '(' . $t('active') . ')';
122
      $done = FALSE;
123 124 125
    }
    else {
      $class = $done ? 'done' : '';
126
      $status = $done ? '(' . $t('done') . ')' : '';
127
    }
128 129 130 131 132
    $output .= '<li';
    $output .= ($class ? ' class="' . $class . '"' : '') . '>';
    $output .= $item;
    $output .= ($status ? '<span class="element-invisible">' . $status . '</span>' : '');
    $output .= '</li>';
133 134 135 136 137 138
  }
  $output .= '</ol>';
  return $output;
}

/**
139
 * Returns HTML for the installation page.
140 141 142
 *
 * Note: this function is not themeable.
 *
143 144 145
 * @param $variables
 *   An associative array containing:
 *   - content: The page content to show.
146
 */
147
function theme_install_page($variables) {
148
  drupal_add_http_header('Content-Type', 'text/html; charset=utf-8');
149
  return theme('maintenance_page', $variables);
150 151 152
}

/**
153
 * Returns HTML for the update page.
154 155 156
 *
 * Note: this function is not themeable.
 *
157 158 159 160 161
 * @param $variables
 *   An associative array containing:
 *   - content: The page content to show.
 *   - show_messages: Whether to output status and error messages.
 *     FALSE can be useful to postpone the messages to a subsequent page.
162
 */
163
function theme_update_page($variables) {
164
  drupal_add_http_header('Content-Type', 'text/html; charset=utf-8');
165
  return theme('maintenance_page', $variables);
166
}
167 168

/**
169
 * Returns HTML for a results report of an operation run by authorize.php.
170
 *
171 172
 * @param $variables
 *   An associative array containing:
173
 *   - messages: An array of result messages.
174 175
 *
 * @ingroup themeable
176 177 178 179 180 181 182
 */
function theme_authorize_report($variables) {
  $messages = $variables['messages'];
  $output = '';
  if (!empty($messages)) {
    $output .= '<div id="authorize-results">';
    foreach ($messages as $heading => $logs) {
183
      $items = array();
184 185 186 187
      foreach ($logs as $number => $log_message) {
        if ($number === '#abort') {
          continue;
        }
188
        $items[] = theme('authorize_message', array('message' => $log_message['message'], 'success' => $log_message['success']));
189
      }
190
      $output .= theme('item_list',  array('items' => $items, 'title' => $heading));
191 192 193 194 195 196 197
    }
    $output .= '</div>';
  }
  return $output;
}

/**
198
 * Returns HTML for a single log message from the authorize.php batch operation.
199 200
 *
 * @param $variables
201
 *   An associative array containing:
202 203
 *   - message: The log message.
 *   - success: A boolean indicating failure or success.
204 205
 *
 * @ingroup themeable
206 207 208 209 210
 */
function theme_authorize_message($variables) {
  $message = $variables['message'];
  $success = $variables['success'];
  if ($success) {
211
    $item = array('data' => $message, 'class' => array('success'));
212 213
  }
  else {
214
    $item = array('data' => '<strong>' . $message . '</strong>', 'class' => array('failure'));
215
  }
216
  return $item;
217
}