299 lines
12 KiB
PHP
299 lines
12 KiB
PHP
<?php
|
|
// $Id$
|
|
|
|
/**
|
|
* @file
|
|
* Theming for maintenance pages.
|
|
*/
|
|
|
|
/**
|
|
* Sets up the theming system for site installs, updates and when the site is
|
|
* in maintenance 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 DRUPAL_ROOT . '/includes/path.inc';
|
|
require_once DRUPAL_ROOT . '/includes/theme.inc';
|
|
require_once DRUPAL_ROOT . '/includes/common.inc';
|
|
require_once DRUPAL_ROOT . '/includes/unicode.inc';
|
|
require_once DRUPAL_ROOT . '/includes/file.inc';
|
|
require_once DRUPAL_ROOT . '/includes/module.inc';
|
|
require_once DRUPAL_ROOT . '/includes/database/database.inc';
|
|
unicode_check();
|
|
|
|
// Install and update pages are treated differently to prevent theming overrides.
|
|
if (defined('MAINTENANCE_MODE') && (MAINTENANCE_MODE == 'install' || MAINTENANCE_MODE == 'update')) {
|
|
$theme = 'minnelli';
|
|
}
|
|
else {
|
|
// 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, $module_list);
|
|
drupal_load('module', 'system');
|
|
drupal_load('module', 'filter');
|
|
|
|
$theme = variable_get('maintenance_theme', 'minnelli');
|
|
}
|
|
|
|
$themes = list_themes();
|
|
|
|
// 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');
|
|
drupal_add_css(drupal_get_path('module', 'system') . '/system.css');
|
|
drupal_add_css(drupal_get_path('module', 'system') . '/system-menus.css');
|
|
drupal_add_css(drupal_get_path('module', 'system') . '/maintenance.css');
|
|
drupal_add_css(drupal_get_path('module', 'system') . '/admin.css');
|
|
}
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @ingroup themeable
|
|
*/
|
|
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;
|
|
// Variable processors invoked manually since this function and theme_update_page()
|
|
// are exceptions in how it works within the theme system.
|
|
template_preprocess($variables, 'install_page');
|
|
template_preprocess_maintenance_page($variables);
|
|
template_process($variables, 'install_page');
|
|
|
|
// 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 warning messages
|
|
if (isset($messages['warning'])) {
|
|
$title = count($messages['warning']) > 1 ? st('The following installation warnings should be carefully reviewed') : st('The following installation warning should be carefully reviewed');
|
|
$variables['messages'] .= '<h4>' . $title . ':</h4>';
|
|
$variables['messages'] .= theme('status_messages', 'warning');
|
|
}
|
|
|
|
// Special handling of status messages
|
|
if (isset($messages['status'])) {
|
|
$title = 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');
|
|
}
|
|
|
|
// This was called as a theme hook (not template), so we need to
|
|
// fix path_to_theme() for the template, to point at the actual
|
|
// theme rather than system module as owner of the hook.
|
|
global $theme_path;
|
|
$theme_path = 'themes/garland';
|
|
|
|
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;
|
|
// Variable processors invoked manually since this function and theme_install_page()
|
|
// are exceptions in how it works within the theme system.
|
|
template_preprocess($variables, 'update_page');
|
|
template_preprocess_maintenance_page($variables);
|
|
template_process($variables, 'update_page');
|
|
|
|
// Special handling of warning messages.
|
|
$messages = drupal_set_message();
|
|
if (isset($messages['warning'])) {
|
|
$title = count($messages['warning']) > 1 ? 'The following update warnings should be carefully reviewed before continuing' : 'The following update warning should be carefully reviewed before continuing';
|
|
$variables['messages'] .= '<h4>' . $title . ':</h4>';
|
|
$variables['messages'] .= theme('status_messages', 'warning');
|
|
}
|
|
|
|
// This was called as a theme hook (not template), so we need to
|
|
// fix path_to_theme() for the template, to point at the actual
|
|
// theme rather than system module as owner of the hook.
|
|
global $theme_path;
|
|
$theme_path = 'themes/garland';
|
|
|
|
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')) {
|
|
$favicon = theme_get_setting('favicon');
|
|
$type = file_get_mimetype($favicon);
|
|
// Use the genereic MIME type for favicons if no other was found.
|
|
if ($type == 'application/octet-stream') {
|
|
$type = 'image/x-icon';
|
|
}
|
|
drupal_add_html_head('<link rel="shortcut icon" href="' . check_url($favicon) . '" type="' . check_plain($type) . '" />');
|
|
}
|
|
|
|
global $theme;
|
|
// Retrieve the theme data to list all available regions.
|
|
$theme_data = _system_get_theme_data();
|
|
$regions = $theme_data[$theme]->info['regions'];
|
|
|
|
// Get all region content set with drupal_add_region_content().
|
|
foreach (array_keys($regions) as $region) {
|
|
// Assign region to a region variable.
|
|
$region_content = drupal_get_region_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['front_page'] = url();
|
|
$variables['breadcrumb'] = '';
|
|
$variables['feed_icons'] = '';
|
|
$variables['head'] = drupal_get_html_head();
|
|
$variables['help'] = '';
|
|
$variables['language'] = $GLOBALS['language'];
|
|
$variables['language']->dir = $GLOBALS['language']->direction ? 'rtl' : 'ltr';
|
|
$variables['logo'] = theme_get_setting('logo');
|
|
$variables['messages'] = $variables['show_messages'] ? theme('status_messages') : '';
|
|
$variables['main_menu'] = array();
|
|
$variables['secondary_menu'] = 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.
|
|
$variables['classes_array'][] = 'in-maintenance';
|
|
if (isset($variables['db_is_active']) && !$variables['db_is_active']) {
|
|
$variables['classes_array'][] = 'db-offline';
|
|
}
|
|
if ($variables['layout'] == 'both') {
|
|
$variables['classes_array'][] = 'two-sidebars';
|
|
}
|
|
elseif ($variables['layout'] == 'none') {
|
|
$variables['classes_array'][] = 'no-sidebars';
|
|
}
|
|
else {
|
|
$variables['classes_array'][] = 'one-sidebar sidebar-' . $variables['layout'];
|
|
}
|
|
|
|
// 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';
|
|
}
|
|
}
|