update.php 20.2 KB
Newer Older
1
<?php
Dries's avatar
 
Dries committed
2 3 4 5 6

/**
 * @file
 * Administrative page for handling updates from one Drupal version to another.
 *
7
 * Point your browser to "http://www.example.com/core/update.php" and follow the
Dries's avatar
 
Dries committed
8 9
 * instructions.
 *
10 11 12 13 14
 * If you are not logged in using either the site maintenance account or an
 * account with the "Administer software updates" permission, you will need to
 * modify the access check statement inside your settings.php file. After
 * finishing the upgrade, be sure to open settings.php again, and change it
 * back to its original state!
Dries's avatar
 
Dries committed
15
 */
Dries's avatar
 
Dries committed
16

17 18 19
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;

20 21 22 23 24 25 26 27
// Change the directory to the Drupal root.
chdir('..');

/**
 * Root directory of Drupal installation.
 */
define('DRUPAL_ROOT', getcwd());

28 29 30 31
// Exit early if running an incompatible PHP version to avoid fatal errors.
// The minimum version is specified explicitly, as DRUPAL_MINIMUM_PHP is not
// yet available. It is defined in bootstrap.inc, but it is not possible to
// load that file yet as it would cause a fatal error on older versions of PHP.
32 33
if (version_compare(PHP_VERSION, '5.3.3') < 0) {
  print 'Your PHP installation is too old. Drupal requires at least PHP 5.3.3. See the <a href="http://drupal.org/requirements">system requirements</a> page for more information.';
34 35 36
  exit;
}

37
/**
38 39 40 41
 * Global flag indicating that update.php is being run.
 *
 * When this flag is set, various operations do not take place, such as invoking
 * hook_init() and hook_exit(), css/js preprocessing, and translation.
42 43 44 45
 *
 * This constant is defined using define() instead of const so that PHP
 * versions older than 5.3 can display the proper PHP requirements instead of
 * causing a fatal error.
46
 */
47
define('MAINTENANCE_MODE', 'update');
48

49
function update_selection_page() {
50
  drupal_set_title('Drupal database update');
51 52
  $elements = drupal_get_form('update_script_selection_form');
  $output = drupal_render($elements);
53

54 55
  update_task_list('select');

56 57 58
  return $output;
}

59
function update_script_selection_form($form, &$form_state) {
60
  $count = 0;
61
  $incompatible_count = 0;
62
  $form['start'] = array(
63 64 65
    '#tree' => TRUE,
    '#type' => 'fieldset',
    '#collapsed' => TRUE,
66
    '#collapsible' => TRUE,
67
  );
68

69
  // Ensure system.module's updates appear first.
70 71
  $form['start']['system'] = array();

72
  $updates = update_get_update_list();
73 74
  $starting_updates = array();
  $incompatible_updates_exist = FALSE;
75 76 77
  foreach ($updates as $module => $update) {
    if (!isset($update['start'])) {
      $form['start'][$module] = array(
78 79 80 81
        '#type' => 'item',
        '#title' => $module . ' module',
        '#markup'  => $update['warning'],
        '#prefix' => '<div class="messages warning">',
82 83
        '#suffix' => '</div>',
      );
84
      $incompatible_updates_exist = TRUE;
85 86 87
      continue;
    }
    if (!empty($update['pending'])) {
88
      $starting_updates[$module] = $update['start'];
89 90 91 92 93
      $form['start'][$module] = array(
        '#type' => 'hidden',
        '#value' => $update['start'],
      );
      $form['start'][$module . '_updates'] = array(
94 95 96
        '#theme' => 'item_list',
        '#items' => $update['pending'],
        '#title' => $module . ' module',
97 98 99 100
      );
    }
    if (isset($update['pending'])) {
      $count = $count + count($update['pending']);
101 102 103
    }
  }

104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
  // Find and label any incompatible updates.
  foreach (update_resolve_dependencies($starting_updates) as $function => $data) {
    if (!$data['allowed']) {
      $incompatible_updates_exist = TRUE;
      $incompatible_count++;
      $module_update_key = $data['module'] . '_updates';
      if (isset($form['start'][$module_update_key]['#items'][$data['number']])) {
        $text = $data['missing_dependencies'] ? 'This update will been skipped due to the following missing dependencies: <em>' . implode(', ', $data['missing_dependencies']) . '</em>' : "This update will be skipped due to an error in the module's code.";
        $form['start'][$module_update_key]['#items'][$data['number']] .= '<div class="warning">' . $text . '</div>';
      }
      // Move the module containing this update to the top of the list.
      $form['start'] = array($module_update_key => $form['start'][$module_update_key]) + $form['start'];
    }
  }

  // Warn the user if any updates were incompatible.
  if ($incompatible_updates_exist) {
    drupal_set_message('Some of the pending updates cannot be applied because their dependencies were not met.', 'warning');
  }

124
  if (empty($count)) {
125 126 127
    drupal_set_message(t('No pending updates.'));
    unset($form);
    $form['links'] = array(
128
      '#markup' => theme('item_list', array('items' => update_helpful_links())),
129
    );
130 131 132

    // No updates to run, so caches won't get flushed later.  Clear them now.
    drupal_flush_all_caches();
133 134 135 136 137 138
  }
  else {
    $form['help'] = array(
      '#markup' => '<p>The version of Drupal you are updating from has been automatically detected.</p>',
      '#weight' => -5,
    );
139 140 141 142 143 144 145 146 147 148 149
    if ($incompatible_count) {
      $form['start']['#title'] = format_plural(
        $count,
        '1 pending update (@number_applied to be applied, @number_incompatible skipped)',
        '@count pending updates (@number_applied to be applied, @number_incompatible skipped)',
        array('@number_applied' => $count - $incompatible_count, '@number_incompatible' => $incompatible_count)
      );
    }
    else {
      $form['start']['#title'] = format_plural($count, '1 pending update', '@count pending updates');
    }
150 151 152 153
    $form['has_js'] = array(
      '#type' => 'hidden',
      '#default_value' => FALSE,
    );
154 155
    $form['actions'] = array('#type' => 'actions');
    $form['actions']['submit'] = array(
156
      '#type' => 'submit',
157
      '#value' => 'Apply pending updates',
158 159
    );
  }
160
  return $form;
161 162
}

163
function update_helpful_links() {
164
  // NOTE: we can't use l() here because the URL would point to
165
  // 'core/update.php?q=admin'.
166
  $links[] = '<a href="' . base_path() . '">Front page</a>';
167 168 169
  if (user_access('access administration pages')) {
    $links[] = '<a href="' . base_path() . '?q=admin">Administration pages</a>';
  }
170 171 172 173 174 175
  return $links;
}

function update_results_page() {
  drupal_set_title('Drupal database update');
  $links = update_helpful_links();
176

177
  update_task_list();
178
  // Report end result.
179
  if (module_exists('dblog') && user_access('access site reports')) {
180
    $log_message = ' All errors have been <a href="' . base_path() . '?q=admin/reports/dblog">logged</a>.';
181 182 183 184 185
  }
  else {
    $log_message = ' All errors have been logged.';
  }

186
  if ($_SESSION['update_success']) {
187
    $output = '<p>Updates were attempted. If you see no failures below, you may proceed happily back to your <a href="' . base_path() . '">site</a>. Otherwise, you may need to update your database manually.' . $log_message . '</p>';
188 189
  }
  else {
190
    list($module, $version) = array_pop(reset($_SESSION['updates_remaining']));
191
    $output = '<p class="error">The update process was aborted prematurely while running <strong>update #' . $version . ' in ' . $module . '.module</strong>.' . $log_message;
192 193 194 195
    if (module_exists('dblog')) {
      $output .= ' You may need to check the <code>watchdog</code> database table manually.';
    }
    $output .= '</p>';
196 197
  }

198 199
  if (!empty($GLOBALS['update_free_access'])) {
    $output .= "<p><strong>Reminder: don't forget to set the <code>\$update_free_access</code> value in your <code>settings.php</code> file back to <code>FALSE</code>.</strong></p>";
200
  }
201

202
  $output .= theme('item_list', array('items' => $links));
203

204
  // Output a list of queries executed.
205
  if (!empty($_SESSION['update_results'])) {
206
    $all_messages = '';
207
    foreach ($_SESSION['update_results'] as $module => $updates) {
208
      if ($module != '#abort') {
209 210
        $module_has_message = FALSE;
        $query_messages = '';
211
        foreach ($updates as $number => $queries) {
212
          $messages = array();
213
          foreach ($queries as $query) {
214 215 216 217
            // If there is no message for this update, don't show anything.
            if (empty($query['query'])) {
              continue;
            }
218

219
            if ($query['success']) {
220
              $messages[] = '<li class="success">' . $query['query'] . '</li>';
221 222
            }
            else {
223
              $messages[] = '<li class="failure"><strong>Failed:</strong> ' . $query['query'] . '</li>';
224
            }
225
          }
226 227

          if ($messages) {
228 229 230
            $module_has_message = TRUE;
            $query_messages .= '<h4>Update #' . $number . "</h4>\n";
            $query_messages .= '<ul>' . implode("\n", $messages) . "</ul>\n";
231 232
          }
        }
233 234 235 236 237 238

        // If there were any messages in the queries then prefix them with the
        // module name and add it to the global message list.
        if ($module_has_message) {
          $all_messages .= '<h3>' . $module . " module</h3>\n" . $query_messages;
        }
239 240
      }
    }
241 242 243 244 245
    if ($all_messages) {
      $output .= '<div id="update-results"><h2>The following updates returned messages</h2>';
      $output .= $all_messages;
      $output .= '</div>';
    }
246
  }
247 248
  unset($_SESSION['update_results']);
  unset($_SESSION['update_success']);
249

250
  return $output;
251 252
}

253
function update_info_page() {
254 255
  // Change query-strings on css/js files to enforce reload for all users.
  _drupal_flush_css_js();
256 257
  // Flush the cache of all data for the update status module.
  if (db_table_exists('cache_update')) {
258
    cache('update')->flush();
259
  }
260

261
  update_task_list('info');
Steven Wittens's avatar
Steven Wittens committed
262
  drupal_set_title('Drupal database update');
263
  $token = drupal_get_token('update');
264
  $output = '<p>Use this utility to update your database whenever a new release of Drupal or a module is installed.</p><p>For more detailed information, see the <a href="http://drupal.org/upgrade">upgrading handbook</a>. If you are unsure what these terms mean you should probably contact your hosting provider.</p>';
265 266 267
  $output .= "<ol>\n";
  $output .= "<li><strong>Back up your database</strong>. This process will change your database values and in case of emergency you may need to revert to a backup.</li>\n";
  $output .= "<li><strong>Back up your code</strong>. Hint: when backing up module code, do not leave that backup in the 'modules' or 'sites/*/modules' directories as this may confuse Drupal's auto-discovery mechanism.</li>\n";
268
  $output .= '<li>Put your site into <a href="' . base_path() . '?q=admin/config/development/maintenance">maintenance mode</a>.</li>' . "\n";
269 270 271
  $output .= "<li>Install your new files in the appropriate location, as described in the handbook.</li>\n";
  $output .= "</ol>\n";
  $output .= "<p>When you have performed the steps above, you may proceed.</p>\n";
272 273
  $form_action = check_url(drupal_current_script_url(array('op' => 'selection', 'token' => $token)));
  $output .= '<form method="post" action="' . $form_action . '"><p><input type="submit" value="Continue" class="form-submit" /></p></form>';
274
  $output .= "\n";
275 276 277 278
  return $output;
}

function update_access_denied_page() {
279
  drupal_add_http_header('Status', '403 Forbidden');
280
  watchdog('access denied', 'update.php', NULL, WATCHDOG_WARNING);
281
  drupal_set_title('Access denied');
282
  return '<p>Access denied. You are not authorized to access this page. Log in using either an account with the <em>administer software updates</em> permission or the site maintenance account (the account you created during installation). If you cannot log in, you will have to edit <code>settings.php</code> to bypass this access check. To do this:</p>
283
<ol>
284 285 286
 <li>With a text editor find the settings.php file on your system. From the main Drupal directory that you installed all the files into, go to <code>sites/your_site_name</code> if such directory exists, or else to <code>sites/default</code> which applies otherwise.</li>
 <li>There is a line inside your settings.php file that says <code>$update_free_access = FALSE;</code>. Change it to <code>$update_free_access = TRUE;</code>.</li>
 <li>As soon as the update.php script is done, you must change the settings.php file back to its original form with <code>$update_free_access = FALSE;</code>.</li>
287
 <li>To avoid having this problem in the future, remember to log in to your website using either an account with the <em>administer software updates</em> permission or the site maintenance account (the account you created during installation) before you backup your database at the beginning of the update process.</li>
288
</ol>';
289
}
290

291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
/**
 * Determines if the current user is allowed to run update.php.
 *
 * @return
 *   TRUE if the current user should be granted access, or FALSE otherwise.
 */
function update_access_allowed() {
  global $update_free_access, $user;

  // Allow the global variable in settings.php to override the access check.
  if (!empty($update_free_access)) {
    return TRUE;
  }
  // Calls to user_access() might fail during the Drupal 6 to 7 update process,
  // so we fall back on requiring that the user be logged in as user #1.
  try {
307
    require_once DRUPAL_ROOT . '/' . drupal_get_path('module', 'user') . '/user.module';
308 309 310 311 312 313 314
    return user_access('administer software updates');
  }
  catch (Exception $e) {
    return ($user->uid == 1);
  }
}

315 316 317 318 319 320
/**
 * Add the update task list to the current page.
 */
function update_task_list($active = NULL) {
  // Default list of tasks.
  $tasks = array(
321
    'requirements' => 'Verify requirements',
322
    'info' => 'Overview',
323
    'select' => 'Review updates',
324 325 326 327
    'run' => 'Run updates',
    'finished' => 'Review log',
  );

328
  drupal_add_region_content('sidebar_first', theme('task_list', array('items' => $tasks, 'active' => $active)));
329 330
}

331
/**
332 333
 * Returns (and optionally stores) extra requirements that only apply during
 * particular parts of the update.php process.
334
 */
335 336 337 338
function update_extra_requirements($requirements = NULL) {
  static $extra_requirements = array();
  if (isset($requirements)) {
    $extra_requirements += $requirements;
339
  }
340
  return $extra_requirements;
341 342 343
}

/**
344 345 346 347 348 349
 * Check update requirements and report any errors or (optionally) warnings.
 *
 * @param $skip_warnings
 *   (optional) If set to TRUE, requirement warnings will be ignored, and a
 *   report will only be issued if there are requirement errors. Defaults to
 *   FALSE.
350
 */
351
function update_check_requirements($skip_warnings = FALSE) {
352 353
  // Check requirements of all loaded modules.
  $requirements = module_invoke_all('requirements', 'update');
354 355 356
  $requirements += update_extra_requirements();
  $severity = drupal_requirements_severity($requirements);

357 358 359
  // If there are errors, always display them. If there are only warnings, skip
  // them if the caller has indicated they should be skipped.
  if ($severity == REQUIREMENT_ERROR || ($severity == REQUIREMENT_WARNING && !$skip_warnings)) {
360 361
    update_task_list('requirements');
    drupal_set_title('Requirements problem');
362
    $status_report = theme('status_report', array('requirements' => $requirements));
363
    $status_report .= 'Check the messages and <a href="' . check_url(drupal_requirements_url($severity)) . '">try again</a>.';
364
    print theme('update_page', array('content' => $status_report));
365
    exit();
366
  }
367 368
}

369
// Some unavoidable errors happen because the database is not yet up-to-date.
370
// Our custom error handler is not yet installed, so we just suppress them.
371 372
ini_set('display_errors', FALSE);

373 374
// We prepare a minimal bootstrap for the update requirements check to avoid
// reaching the PHP memory limit.
375 376 377 378 379
require_once DRUPAL_ROOT . '/core/includes/bootstrap.inc';
require_once DRUPAL_ROOT . '/core/includes/update.inc';
require_once DRUPAL_ROOT . '/core/includes/common.inc';
require_once DRUPAL_ROOT . '/core/includes/file.inc';
require_once DRUPAL_ROOT . '/core/includes/unicode.inc';
380
require_once DRUPAL_ROOT . '/core/includes/schema.inc';
381
update_prepare_d8_bootstrap();
382

383 384
// Determine if the current user has access to run update.php.
drupal_bootstrap(DRUPAL_BOOTSTRAP_SESSION);
385

386

387 388 389 390 391 392
// Ensure the default language is properly registered within the Dependency
// Injection container during the upgrade process.
$default = language_default();
drupal_container()->register(LANGUAGE_TYPE_INTERFACE, 'Drupal\\Core\\Language\\Language')
  ->addMethodCall('extend', array($default));

393 394 395 396 397 398 399 400 401 402 403 404 405 406
// A request object from the HTTPFoundation to tell us about the request.
// @todo These two lines were copied from index.php which has its own todo about
// a change required here. Revisit this when that change has been made.
$request = Request::createFromGlobals();
request($request);

// There can be conflicting 'op' parameters because both update and batch use
// this parameter name. We need the 'op' coming from a POST request to trump
// that coming from a GET request.
$op = $request->request->get('op');
if (is_null($op)) {
  $op = $request->query->get('op');
}

407 408 409
// Only allow the requirements check to proceed if the current user has access
// to run updates (since it may expose sensitive information about the site's
// configuration).
410
if (is_null($op) && update_access_allowed()) {
411 412
  require_once DRUPAL_ROOT . '/core/includes/install.inc';
  require_once DRUPAL_ROOT . '/core/modules/system/system.install';
413 414

  // Load module basics.
415 416
  include_once DRUPAL_ROOT . '/core/includes/module.inc';
  $module_list['system']['filename'] = 'core/modules/system/system.module';
417
  module_list(TRUE, FALSE, FALSE, $module_list);
418 419
  drupal_load('module', 'system');

420 421
  // Reset the module_implements() cache so that any new hook implementations
  // in updated code are picked up.
422
  module_implements_reset();
423

424
  // Set up $language, since the installer components require it.
425
  drupal_language_initialize();
426 427 428 429

  // Set up theme system for the maintenance page.
  drupal_maintenance_theme();

430 431 432
  // Check the update requirements for Drupal. Only report on errors at this
  // stage, since the real requirements check happens further down.
  update_check_requirements(TRUE);
433

434
  // Redirect to the update information page if all requirements were met.
435
  install_goto('core/update.php?op=info');
436
}
437

438 439 440
// Allow update_fix_d8_requirements() to run before code that can break on a
// Drupal 7 database.
drupal_bootstrap(DRUPAL_BOOTSTRAP_CODE);
441
update_fix_d8_requirements();
442
drupal_bootstrap(DRUPAL_BOOTSTRAP_FULL);
Steven Wittens's avatar
Steven Wittens committed
443
drupal_maintenance_theme();
444

445 446 447 448
// Turn error reporting back on. From now on, only fatal errors (which are
// not passed through the error handler) will cause a message to be printed.
ini_set('display_errors', TRUE);

449

450
// Only proceed with updates if the user is allowed to run them.
451
if (update_access_allowed()) {
452

453 454
  include_once DRUPAL_ROOT . '/core/includes/install.inc';
  include_once DRUPAL_ROOT . '/core/includes/batch.inc';
455
  drupal_load_updates();
Dries's avatar
 
Dries committed
456

457
  update_fix_compatibility();
458

459 460 461 462
  // Check the update requirements for all modules. If there are warnings, but
  // no errors, skip reporting them if the user has provided a URL parameter
  // acknowledging the warnings and indicating a desire to continue anyway. See
  // drupal_requirements_url().
463 464
  $continue = $request->query->get('continue');
  $skip_warnings = !empty($continue);
465
  update_check_requirements($skip_warnings);
466

467
  switch ($op) {
468
    // update.php ops.
469

470
    case 'selection':
471
      $token = $request->query->get('token');
472
      if (isset($token) && drupal_valid_token($token, 'update')) {
473 474 475
        $output = update_selection_page();
        break;
      }
476

477
    case 'Apply pending updates':
478
      $token = $request->query->get('token');
479
      if (isset($token) && drupal_valid_token($token, 'update')) {
480 481 482 483 484
        // Generate absolute URLs for the batch processing (using $base_root),
        // since the batch API will pass them to url() which does not handle
        // update.php correctly by default.
        $batch_url = $base_root . drupal_current_script_url();
        $redirect_url = $base_root . drupal_current_script_url(array('op' => 'results'));
485
        update_batch($request->request->get('start'), $redirect_url, $batch_url);
486 487 488 489 490
        break;
      }

    case 'info':
      $output = update_info_page();
491 492
      break;

493 494
    case 'results':
      $output = update_results_page();
495 496
      break;

497
    // Regular batch ops : defer to batch processing API.
498
    default:
499 500
      update_task_list('run');
      $output = _batch_page();
501
      break;
Kjartan's avatar
Kjartan committed
502 503 504
  }
}
else {
505
  $output = update_access_denied_page();
506
}
507
if (isset($output) && $output) {
508
  // Explicitly start a session so that the update.php token will be accepted.
509
  drupal_session_start();
510 511
  // We defer the display of messages until all updates are done.
  $progress_page = ($batch = batch_get()) && isset($batch['running']);
512 513 514 515 516 517 518
  if ($output instanceof Response) {
    $output->send();
  }
  else {
    print theme('update_page', array('content' => $output, 'show_messages' => !$progress_page));
  }

519
}