theme.maintenance.inc 7.31 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 13
 * 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
 * complete. Seven is always used for the initial install and update operations.
14
 * In other cases, Bartik is used, but this can be overridden by setting a
15
 * "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 26 27 28 29 30
  require_once DRUPAL_ROOT . '/' . variable_get('path_inc', 'core/includes/path.inc');
  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', variable_get('theme_default', 'bartik'));
54 55
  }

56 57
  // Ensure that system.module is loaded.
  if (!function_exists('_system_rebuild_theme_data')) {
58
    $module_list['system']['filename'] = 'core/modules/system/system.module';
59
    module_list(NULL, $module_list);
60 61 62
    drupal_load('module', 'system');
  }

63 64
  $themes = list_themes();

65 66 67 68 69
  // 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;

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

  // These are usually added from system_init() -except maintenance.css.
  // When the database is inactive it's not called so we add it here.
84 85 86 87 88
  $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');
89 90 91 92 93 94
}

/**
 * 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) {
95
  return _theme_build_registry($theme, $base_theme, $theme_engine);
96 97 98
}

/**
99 100 101 102 103 104
 * 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.
105
 *
106
 * @ingroup themeable
107
 */
108 109 110 111
function theme_task_list($variables) {
  $items = $variables['items'];
  $active = $variables['active'];

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

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

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

/**
151
 * Returns HTML for the update page.
152 153 154
 *
 * Note: this function is not themeable.
 *
155 156 157 158 159
 * @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.
160
 */
161
function theme_update_page($variables) {
162
  drupal_add_http_header('Content-Type', 'text/html; charset=utf-8');
163
  return theme('maintenance_page', $variables);
164
}
165 166

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

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