annotate includes/theme.maintenance.inc @ 13:134d4b2e75f6

updated quicktabs and google analytics modules
author danieleb <danielebarchiesi@me.com>
date Tue, 29 Oct 2013 13:48:59 +0000
parents ff03f76ab3fe
children
rev   line source
danielebarchiesi@0 1 <?php
danielebarchiesi@0 2
danielebarchiesi@0 3 /**
danielebarchiesi@0 4 * @file
danielebarchiesi@0 5 * Theming for maintenance pages.
danielebarchiesi@0 6 */
danielebarchiesi@0 7
danielebarchiesi@0 8 /**
danielebarchiesi@0 9 * Sets up the theming system for maintenance page.
danielebarchiesi@0 10 *
danielebarchiesi@0 11 * Used for site installs, updates and when the site is in maintenance mode.
danielebarchiesi@0 12 * It also applies when the database is unavailable or bootstrap was not
danielebarchiesi@0 13 * complete. Seven is always used for the initial install and update
danielebarchiesi@0 14 * operations. In other cases, Bartik is used, but this can be overridden by
danielebarchiesi@0 15 * setting a "maintenance_theme" key in the $conf variable in settings.php.
danielebarchiesi@0 16 */
danielebarchiesi@0 17 function _drupal_maintenance_theme() {
danielebarchiesi@0 18 global $theme, $theme_key, $conf;
danielebarchiesi@0 19
danielebarchiesi@0 20 // If $theme is already set, assume the others are set too, and do nothing.
danielebarchiesi@0 21 if (isset($theme)) {
danielebarchiesi@0 22 return;
danielebarchiesi@0 23 }
danielebarchiesi@0 24
danielebarchiesi@0 25 require_once DRUPAL_ROOT . '/' . variable_get('path_inc', 'includes/path.inc');
danielebarchiesi@0 26 require_once DRUPAL_ROOT . '/includes/theme.inc';
danielebarchiesi@0 27 require_once DRUPAL_ROOT . '/includes/common.inc';
danielebarchiesi@0 28 require_once DRUPAL_ROOT . '/includes/unicode.inc';
danielebarchiesi@0 29 require_once DRUPAL_ROOT . '/includes/file.inc';
danielebarchiesi@0 30 require_once DRUPAL_ROOT . '/includes/module.inc';
danielebarchiesi@0 31 unicode_check();
danielebarchiesi@0 32
danielebarchiesi@0 33 // Install and update pages are treated differently to prevent theming overrides.
danielebarchiesi@0 34 if (defined('MAINTENANCE_MODE') && (MAINTENANCE_MODE == 'install' || MAINTENANCE_MODE == 'update')) {
danielebarchiesi@0 35 $custom_theme = (isset($conf['maintenance_theme']) ? $conf['maintenance_theme'] : 'seven');
danielebarchiesi@0 36 }
danielebarchiesi@0 37 else {
danielebarchiesi@0 38 // The bootstrap was not complete. So we are operating in a crippled
danielebarchiesi@0 39 // environment, we need to bootstrap just enough to allow hook invocations
danielebarchiesi@0 40 // to work. See _drupal_log_error().
danielebarchiesi@0 41 if (!class_exists('Database', FALSE)) {
danielebarchiesi@0 42 require_once DRUPAL_ROOT . '/includes/database/database.inc';
danielebarchiesi@0 43 }
danielebarchiesi@0 44
danielebarchiesi@0 45 // We use the default theme as the maintenance theme. If a default theme
danielebarchiesi@0 46 // isn't specified in the database or in settings.php, we use Bartik.
danielebarchiesi@0 47 $custom_theme = variable_get('maintenance_theme', variable_get('theme_default', 'bartik'));
danielebarchiesi@0 48 }
danielebarchiesi@0 49
danielebarchiesi@0 50 // Ensure that system.module is loaded.
danielebarchiesi@0 51 if (!function_exists('_system_rebuild_theme_data')) {
danielebarchiesi@0 52 $module_list['system']['filename'] = 'modules/system/system.module';
danielebarchiesi@0 53 module_list(TRUE, FALSE, FALSE, $module_list);
danielebarchiesi@0 54 drupal_load('module', 'system');
danielebarchiesi@0 55 }
danielebarchiesi@0 56
danielebarchiesi@0 57 $themes = list_themes();
danielebarchiesi@0 58
danielebarchiesi@0 59 // list_themes() triggers a drupal_alter() in maintenance mode, but we can't
danielebarchiesi@0 60 // let themes alter the .info data until we know a theme's base themes. So
danielebarchiesi@0 61 // don't set global $theme until after list_themes() builds its cache.
danielebarchiesi@0 62 $theme = $custom_theme;
danielebarchiesi@0 63
danielebarchiesi@0 64 // Store the identifier for retrieving theme settings with.
danielebarchiesi@0 65 $theme_key = $theme;
danielebarchiesi@0 66
danielebarchiesi@0 67 // Find all our ancestor themes and put them in an array.
danielebarchiesi@0 68 $base_theme = array();
danielebarchiesi@0 69 $ancestor = $theme;
danielebarchiesi@0 70 while ($ancestor && isset($themes[$ancestor]->base_theme)) {
danielebarchiesi@0 71 $base_theme[] = $new_base_theme = $themes[$themes[$ancestor]->base_theme];
danielebarchiesi@0 72 $ancestor = $themes[$ancestor]->base_theme;
danielebarchiesi@0 73 }
danielebarchiesi@0 74 _drupal_theme_initialize($themes[$theme], array_reverse($base_theme), '_theme_load_offline_registry');
danielebarchiesi@0 75
danielebarchiesi@0 76 // These are usually added from system_init() -except maintenance.css.
danielebarchiesi@0 77 // When the database is inactive it's not called so we add it here.
danielebarchiesi@0 78 $path = drupal_get_path('module', 'system');
danielebarchiesi@0 79 drupal_add_css($path . '/system.base.css');
danielebarchiesi@0 80 drupal_add_css($path . '/system.admin.css');
danielebarchiesi@0 81 drupal_add_css($path . '/system.menus.css');
danielebarchiesi@0 82 drupal_add_css($path . '/system.messages.css');
danielebarchiesi@0 83 drupal_add_css($path . '/system.theme.css');
danielebarchiesi@0 84 drupal_add_css($path . '/system.maintenance.css');
danielebarchiesi@0 85 }
danielebarchiesi@0 86
danielebarchiesi@0 87 /**
danielebarchiesi@0 88 * Builds the registry when the site needs to bypass any database calls.
danielebarchiesi@0 89 */
danielebarchiesi@0 90 function _theme_load_offline_registry($theme, $base_theme = NULL, $theme_engine = NULL) {
danielebarchiesi@0 91 return _theme_build_registry($theme, $base_theme, $theme_engine);
danielebarchiesi@0 92 }
danielebarchiesi@0 93
danielebarchiesi@0 94 /**
danielebarchiesi@0 95 * Returns HTML for a list of maintenance tasks to perform.
danielebarchiesi@0 96 *
danielebarchiesi@0 97 * @param $variables
danielebarchiesi@0 98 * An associative array containing:
danielebarchiesi@0 99 * - items: An associative array of maintenance tasks.
danielebarchiesi@0 100 * - active: The key for the currently active maintenance task.
danielebarchiesi@0 101 *
danielebarchiesi@0 102 * @ingroup themeable
danielebarchiesi@0 103 */
danielebarchiesi@0 104 function theme_task_list($variables) {
danielebarchiesi@0 105 $items = $variables['items'];
danielebarchiesi@0 106 $active = $variables['active'];
danielebarchiesi@0 107
danielebarchiesi@0 108 $done = isset($items[$active]) || $active == NULL;
danielebarchiesi@0 109 $output = '<h2 class="element-invisible">Installation tasks</h2>';
danielebarchiesi@0 110 $output .= '<ol class="task-list">';
danielebarchiesi@0 111
danielebarchiesi@0 112 foreach ($items as $k => $item) {
danielebarchiesi@0 113 if ($active == $k) {
danielebarchiesi@0 114 $class = 'active';
danielebarchiesi@0 115 $status = '(' . t('active') . ')';
danielebarchiesi@0 116 $done = FALSE;
danielebarchiesi@0 117 }
danielebarchiesi@0 118 else {
danielebarchiesi@0 119 $class = $done ? 'done' : '';
danielebarchiesi@0 120 $status = $done ? '(' . t('done') . ')' : '';
danielebarchiesi@0 121 }
danielebarchiesi@0 122 $output .= '<li';
danielebarchiesi@0 123 $output .= ($class ? ' class="' . $class . '"' : '') . '>';
danielebarchiesi@0 124 $output .= $item;
danielebarchiesi@0 125 $output .= ($status ? '<span class="element-invisible">' . $status . '</span>' : '');
danielebarchiesi@0 126 $output .= '</li>';
danielebarchiesi@0 127 }
danielebarchiesi@0 128 $output .= '</ol>';
danielebarchiesi@0 129 return $output;
danielebarchiesi@0 130 }
danielebarchiesi@0 131
danielebarchiesi@0 132 /**
danielebarchiesi@0 133 * Returns HTML for the installation page.
danielebarchiesi@0 134 *
danielebarchiesi@0 135 * Note: this function is not themeable.
danielebarchiesi@0 136 *
danielebarchiesi@0 137 * @param $variables
danielebarchiesi@0 138 * An associative array containing:
danielebarchiesi@0 139 * - content: The page content to show.
danielebarchiesi@0 140 */
danielebarchiesi@0 141 function theme_install_page($variables) {
danielebarchiesi@0 142 drupal_add_http_header('Content-Type', 'text/html; charset=utf-8');
danielebarchiesi@0 143 return theme('maintenance_page', $variables);
danielebarchiesi@0 144 }
danielebarchiesi@0 145
danielebarchiesi@0 146 /**
danielebarchiesi@0 147 * Returns HTML for the update page.
danielebarchiesi@0 148 *
danielebarchiesi@0 149 * Note: this function is not themeable.
danielebarchiesi@0 150 *
danielebarchiesi@0 151 * @param $variables
danielebarchiesi@0 152 * An associative array containing:
danielebarchiesi@0 153 * - content: The page content to show.
danielebarchiesi@0 154 * - show_messages: Whether to output status and error messages.
danielebarchiesi@0 155 * FALSE can be useful to postpone the messages to a subsequent page.
danielebarchiesi@0 156 */
danielebarchiesi@0 157 function theme_update_page($variables) {
danielebarchiesi@0 158 drupal_add_http_header('Content-Type', 'text/html; charset=utf-8');
danielebarchiesi@0 159 return theme('maintenance_page', $variables);
danielebarchiesi@0 160 }
danielebarchiesi@0 161
danielebarchiesi@0 162 /**
danielebarchiesi@0 163 * Returns HTML for a results report of an operation run by authorize.php.
danielebarchiesi@0 164 *
danielebarchiesi@0 165 * @param $variables
danielebarchiesi@0 166 * An associative array containing:
danielebarchiesi@0 167 * - messages: An array of result messages.
danielebarchiesi@0 168 *
danielebarchiesi@0 169 * @ingroup themeable
danielebarchiesi@0 170 */
danielebarchiesi@0 171 function theme_authorize_report($variables) {
danielebarchiesi@0 172 $messages = $variables['messages'];
danielebarchiesi@0 173 $output = '';
danielebarchiesi@0 174 if (!empty($messages)) {
danielebarchiesi@0 175 $output .= '<div id="authorize-results">';
danielebarchiesi@0 176 foreach ($messages as $heading => $logs) {
danielebarchiesi@0 177 $items = array();
danielebarchiesi@0 178 foreach ($logs as $number => $log_message) {
danielebarchiesi@0 179 if ($number === '#abort') {
danielebarchiesi@0 180 continue;
danielebarchiesi@0 181 }
danielebarchiesi@0 182 $items[] = theme('authorize_message', array('message' => $log_message['message'], 'success' => $log_message['success']));
danielebarchiesi@0 183 }
danielebarchiesi@0 184 $output .= theme('item_list', array('items' => $items, 'title' => $heading));
danielebarchiesi@0 185 }
danielebarchiesi@0 186 $output .= '</div>';
danielebarchiesi@0 187 }
danielebarchiesi@0 188 return $output;
danielebarchiesi@0 189 }
danielebarchiesi@0 190
danielebarchiesi@0 191 /**
danielebarchiesi@0 192 * Returns HTML for a single log message from the authorize.php batch operation.
danielebarchiesi@0 193 *
danielebarchiesi@0 194 * @param $variables
danielebarchiesi@0 195 * An associative array containing:
danielebarchiesi@0 196 * - message: The log message.
danielebarchiesi@0 197 * - success: A boolean indicating failure or success.
danielebarchiesi@0 198 *
danielebarchiesi@0 199 * @ingroup themeable
danielebarchiesi@0 200 */
danielebarchiesi@0 201 function theme_authorize_message($variables) {
danielebarchiesi@0 202 $message = $variables['message'];
danielebarchiesi@0 203 $success = $variables['success'];
danielebarchiesi@0 204 if ($success) {
danielebarchiesi@0 205 $item = array('data' => $message, 'class' => array('success'));
danielebarchiesi@0 206 }
danielebarchiesi@0 207 else {
danielebarchiesi@0 208 $item = array('data' => '<strong>' . $message . '</strong>', 'class' => array('failure'));
danielebarchiesi@0 209 }
danielebarchiesi@0 210 return $item;
danielebarchiesi@0 211 }