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

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

8 9
use Drupal\Component\Utility\Unicode;

10
/**
11
 * Sets up the theming system for maintenance page.
12
 *
13 14
 * 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
15 16 17
 * 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.
18 19
 */
function _drupal_maintenance_theme() {
20
  global $theme, $theme_key, $conf;
21 22 23 24 25 26

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

27
  require_once DRUPAL_ROOT . '/' . settings()->get('path_inc', 'core/includes/path.inc');
28 29 30 31 32
  require_once __DIR__ . '/theme.inc';
  require_once __DIR__ . '/common.inc';
  require_once __DIR__ . '/unicode.inc';
  require_once __DIR__ . '/file.inc';
  require_once __DIR__ . '/module.inc';
33
  Unicode::check();
34 35 36

  // Install and update pages are treated differently to prevent theming overrides.
  if (defined('MAINTENANCE_MODE') && (MAINTENANCE_MODE == 'install' || MAINTENANCE_MODE == 'update')) {
37
    $custom_theme = (isset($conf['maintenance_theme']) ? $conf['maintenance_theme'] : 'seven');
38 39
  }
  else {
40 41 42
    // 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().
43
    if (!class_exists('Drupal\Core\Database\Database', FALSE)) {
44
      require_once __DIR__ . '/database.inc';
45 46
    }

47
    // We use the default theme as the maintenance theme. If a default theme
48
    // isn't specified in the database or in settings.php, we use Bartik.
49 50 51 52 53 54
    // @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.
55 56 57 58 59 60 61 62 63 64 65
    $custom_theme = variable_get('maintenance_theme');
    if (!$custom_theme)  {
      $config = Drupal::config('system.theme');
      // A broken install might not return an object.
      if (is_object($config)) {
        $custom_theme = $config->get('default');
      }
    }
    if (!$custom_theme)  {
      $custom_theme = 'bartik';
    }
66 67
  }

68 69
  // Ensure that system.module is loaded.
  if (!function_exists('_system_rebuild_theme_data')) {
70
    $module_list['system'] = 'core/modules/system/system.module';
71
    $module_handler = Drupal::moduleHandler();
72 73
    $module_handler->setModuleList($module_list);
    $module_handler->load('system');
74 75
  }

76 77
  $themes = list_themes();

78
  // list_themes() triggers a drupal_alter() in maintenance mode, but we can't
79
  // let themes alter the .info.yml data until we know a theme's base themes. So
80 81 82
  // don't set global $theme until after list_themes() builds its cache.
  $theme = $custom_theme;

83 84 85 86 87 88 89 90 91 92
  // 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;
  }
93
  _drupal_theme_initialize($themes[$theme], array_reverse($base_theme), '_theme_load_offline_registry');
94 95 96

  // These are usually added from system_init() -except maintenance.css.
  // When the database is inactive it's not called so we add it here.
97
  $path = drupal_get_path('module', 'system');
98 99 100 101
  drupal_add_css($path . '/css/system.module.css');
  drupal_add_css($path . '/css/system.theme.css');
  drupal_add_css($path . '/css/system.admin.css');
  drupal_add_css($path . '/css/system.maintenance.css');
102 103 104
}

/**
105
 * Builds the registry when the site needs to bypass any database calls.
106 107
 */
function _theme_load_offline_registry($theme, $base_theme = NULL, $theme_engine = NULL) {
108
  return _theme_build_registry($theme, $base_theme, $theme_engine);
109 110 111
}

/**
112 113 114 115 116 117
 * 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.
118
 *
119
 * @ingroup themeable
120
 */
121
function theme_task_list($variables) {
122
  $t = get_t();
123 124 125
  $items = $variables['items'];
  $active = $variables['active'];

126
  $done = isset($items[$active]) || $active == NULL;
127 128 129
  $output = '<h2 class="element-invisible">Installation tasks</h2>';
  $output .= '<ol class="task-list">';

130 131 132
  foreach ($items as $k => $item) {
    if ($active == $k) {
      $class = 'active';
133
      $status = '(' . $t('active') . ')';
134
      $done = FALSE;
135 136 137
    }
    else {
      $class = $done ? 'done' : '';
138
      $status = $done ? '(' . $t('done') . ')' : '';
139
    }
140 141 142 143 144
    $output .= '<li';
    $output .= ($class ? ' class="' . $class . '"' : '') . '>';
    $output .= $item;
    $output .= ($status ? '<span class="element-invisible">' . $status . '</span>' : '');
    $output .= '</li>';
145 146 147 148 149 150
  }
  $output .= '</ol>';
  return $output;
}

/**
151
 * Returns HTML for the installation page.
152 153 154
 *
 * Note: this function is not themeable.
 *
155 156 157
 * @param $variables
 *   An associative array containing:
 *   - content: The page content to show.
158
 */
159
function theme_install_page($variables) {
160
  drupal_add_http_header('Content-Type', 'text/html; charset=utf-8');
161
  return theme('maintenance_page', $variables);
162 163
}

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

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