--- /dev/null
+<?php
+/**
+ * @file
+ * Update.php for provisioned sites.
+ * This file is a derivative of the standard drupal update.php,
+ * which has been modified to allow being run from the command
+ * line.
+ */
+
+use Drush\Log\LogLevel;
+
+/**
+ * Global flag to identify update.php run, and so avoid various unwanted
+ * operations, such as hook_init() and hook_exit() invokes, css/js preprocessing
+ * and translation, and solve some theming issues. This flag is checked on several
+ * places in Drupal code (not just update.php).
+ */
+define('MAINTENANCE_MODE', 'update');
+
+/**
+ * Drupal's update.inc has functions that are in previous update_X.inc files
+ * for example, update_check_incompatibility() which can prove useful when
+ * enabling modules.
+ */
+require_once DRUSH_DRUPAL_CORE . '/includes/update.inc';
+/**
+ * Returns (and optionally stores) extra requirements that only apply during
+ * particular parts of the update.php process.
+ */
+function update_extra_requirements($requirements = NULL) {
+ static $extra_requirements = array();
+ if (isset($requirements)) {
+ $extra_requirements += $requirements;
+ }
+ return $extra_requirements;
+}
+
+/**
+ * Perform one update and store the results which will later be displayed on
+ * the finished page.
+ *
+ * An update function can force the current and all later updates for this
+ * module to abort by returning a $ret array with an element like:
+ * $ret['#abort'] = array('success' => FALSE, 'query' => 'What went wrong');
+ * The schema version will not be updated in this case, and all the
+ * aborted updates will continue to appear on update.php as updates that
+ * have not yet been run.
+ *
+ * @param $module
+ * The module whose update will be run.
+ * @param $number
+ * The update number to run.
+ * @param $context
+ * The batch context array
+ */
+function drush_update_do_one($module, $number, $dependency_map, &$context) {
+ $function = $module . '_update_' . $number;
+
+ // If this update was aborted in a previous step, or has a dependency that
+ // was aborted in a previous step, go no further.
+ if (!empty($context['results']['#abort']) && array_intersect($context['results']['#abort'], array_merge($dependency_map, array($function)))) {
+ return;
+ }
+
+ $context['log'] = FALSE;
+
+ $ret = array();
+ if (function_exists($function)) {
+ try {
+ if ($context['log']) {
+ Database::startLog($function);
+ }
+
+ drush_log("Executing " . $function);
+ $ret['results']['query'] = $function($context['sandbox']);
+
+ // If the update hook returned a status message (common in batch updates),
+ // show it to the user.
+ if ($ret['results']['query']) {
+ drush_log($ret['results']['query'], LogLevel::OK);
+ }
+
+ $ret['results']['success'] = TRUE;
+ }
+ // @TODO We may want to do different error handling for different exception
+ // types, but for now we'll just print the message.
+ catch (Exception $e) {
+ $ret['#abort'] = array('success' => FALSE, 'query' => $e->getMessage());
+ drush_set_error('DRUPAL_EXCEPTION', $e->getMessage());
+ }
+
+ if ($context['log']) {
+ $ret['queries'] = Database::getLog($function);
+ }
+ }
+
+ if (isset($context['sandbox']['#finished'])) {
+ $context['finished'] = $context['sandbox']['#finished'];
+ unset($context['sandbox']['#finished']);
+ }
+
+ if (!isset($context['results'][$module])) {
+ $context['results'][$module] = array();
+ }
+ if (!isset($context['results'][$module][$number])) {
+ $context['results'][$module][$number] = array();
+ }
+ $context['results'][$module][$number] = array_merge($context['results'][$module][$number], $ret);
+
+ if (!empty($ret['#abort'])) {
+ // Record this function in the list of updates that were aborted.
+ $context['results']['#abort'][] = $function;
+ }
+
+ // Record the schema update if it was completed successfully.
+ if ($context['finished'] == 1 && empty($ret['#abort'])) {
+ drupal_set_installed_schema_version($module, $number);
+ }
+
+ $context['message'] = 'Performed update: ' . $function;
+}
+
+/**
+ * Check update requirements and report any errors.
+ */
+function update_check_requirements() {
+ $warnings = FALSE;
+
+ // Check the system module and update.php requirements only.
+ $requirements = system_requirements('update');
+ $requirements += update_extra_requirements();
+
+ // If there are issues, report them.
+ foreach ($requirements as $requirement) {
+ if (isset($requirement['severity']) && $requirement['severity'] > REQUIREMENT_OK) {
+ $message = isset($requirement['description']) ? $requirement['description'] : '';
+ if (isset($requirement['value']) && $requirement['value']) {
+ $message .= ' (Currently using ' . $requirement['title'] . ' ' . $requirement['value'] . ')';
+ }
+ $warnings = TRUE;
+ drupal_set_message($message, LogLevel::WARNING);
+ }
+ }
+ return $warnings;
+}
+
+
+function update_main_prepare() {
+ // Some unavoidable errors happen because the database is not yet up-to-date.
+ // Our custom error handler is not yet installed, so we just suppress them.
+ drush_errors_off();
+
+ // We prepare a minimal bootstrap for the update requirements check to avoid
+ // reaching the PHP memory limit.
+ $core = DRUSH_DRUPAL_CORE;
+ require_once $core . '/includes/bootstrap.inc';
+ require_once $core . '/includes/common.inc';
+ require_once $core . '/includes/file.inc';
+ require_once $core . '/includes/entity.inc';
+ include_once $core . '/includes/unicode.inc';
+
+ update_prepare_d7_bootstrap();
+ drupal_bootstrap(DRUPAL_BOOTSTRAP_SESSION);
+
+ require_once $core . '/includes/install.inc';
+ require_once $core . '/modules/system/system.install';
+
+ // Load module basics.
+ include_once $core . '/includes/module.inc';
+ $module_list['system']['filename'] = 'modules/system/system.module';
+ module_list(TRUE, FALSE, FALSE, $module_list);
+ drupal_load('module', 'system');
+
+ // Reset the module_implements() cache so that any new hook implementations
+ // in updated code are picked up.
+ module_implements('', FALSE, TRUE);
+
+ // Set up $language, since the installer components require it.
+ drupal_language_initialize();
+
+ // Set up theme system for the maintenance page.
+ drupal_maintenance_theme();
+
+ // Check the update requirements for Drupal.
+ update_check_requirements();
+
+ // update_fix_d7_requirements() needs to run before bootstrapping beyond path.
+ // So bootstrap to DRUPAL_BOOTSTRAP_LANGUAGE then include unicode.inc.
+ drupal_bootstrap(DRUPAL_BOOTSTRAP_LANGUAGE);
+
+ update_fix_d7_requirements();
+
+ // Clear the module_implements() cache before the full bootstrap. The calls
+ // above to drupal_maintenance_theme() and update_check_requirements() have
+ // invoked hooks before all modules have actually been loaded by the full
+ // bootstrap. This means that the module_implements() results for any hooks
+ // that have been invoked, including hook_module_implements_alter(), is a
+ // smaller set of modules than should be returned normally.
+ // @see https://github.com/drush-ops/drush/pull/399
+ module_implements('', FALSE, TRUE);
+
+ // Now proceed with a full bootstrap.
+
+ drush_bootstrap(DRUSH_BOOTSTRAP_DRUPAL_FULL);
+ drupal_maintenance_theme();
+
+ drush_errors_on();
+
+ include_once DRUPAL_ROOT . '/includes/batch.inc';
+ drupal_load_updates();
+
+ update_fix_compatibility();
+
+ // Change query-strings on css/js files to enforce reload for all users.
+ _drupal_flush_css_js();
+ // Flush the cache of all data for the update status module.
+ if (db_table_exists('cache_update')) {
+ cache_clear_all('*', 'cache_update', TRUE);
+ }
+
+ module_list(TRUE, FALSE, TRUE);
+}
+
+function update_main() {
+ update_main_prepare();
+
+ list($pending, $start) = updatedb_status();
+ if ($pending) {
+ // @todo get table header working.
+ // $headers = array(dt('Module'), dt('ID'), dt('Description'));
+ drush_print_table($pending);
+ if (!drush_confirm(dt('Do you wish to run all pending updates?'))) {
+ return drush_user_abort();
+ }
+ drush_update_batch($start);
+ }
+ else {
+ drush_log(dt("No database updates required"), LogLevel::SUCCESS);
+ }
+
+ return count($pending);
+}
+
+function _update_batch_command($id) {
+ update_main_prepare();
+ drush_batch_command($id);
+}
+
+/**
+ * Start the database update batch process.
+ *
+ * @param $start
+ * An array of all the modules and which update to start at.
+ * @param $redirect
+ * Path to redirect to when the batch has finished processing.
+ * @param $url
+ * URL of the batch processing page (should only be used for separate
+ * scripts like update.php).
+ * @param $batch
+ * Optional parameters to pass into the batch API.
+ * @param $redirect_callback
+ * (optional) Specify a function to be called to redirect to the progressive
+ * processing page.
+ */
+function drush_update_batch($start) {
+ // Resolve any update dependencies to determine the actual updates that will
+ // be run and the order they will be run in.
+ $updates = update_resolve_dependencies($start);
+
+ // Store the dependencies for each update function in an array which the
+ // batch API can pass in to the batch operation each time it is called. (We
+ // do not store the entire update dependency array here because it is
+ // potentially very large.)
+ $dependency_map = array();
+ foreach ($updates as $function => $update) {
+ $dependency_map[$function] = !empty($update['reverse_paths']) ? array_keys($update['reverse_paths']) : array();
+ }
+
+ $operations = array();
+ foreach ($updates as $update) {
+ if ($update['allowed']) {
+ // Set the installed version of each module so updates will start at the
+ // correct place. (The updates are already sorted, so we can simply base
+ // this on the first one we come across in the above foreach loop.)
+ if (isset($start[$update['module']])) {
+ drupal_set_installed_schema_version($update['module'], $update['number'] - 1);
+ unset($start[$update['module']]);
+ }
+ // Add this update function to the batch.
+ $function = $update['module'] . '_update_' . $update['number'];
+ $operations[] = array('drush_update_do_one', array($update['module'], $update['number'], $dependency_map[$function]));
+ }
+ }
+
+ $batch['operations'] = $operations;
+ $batch += array(
+ 'title' => 'Updating',
+ 'init_message' => 'Starting updates',
+ 'error_message' => 'An unrecoverable error has occurred. You can find the error message below. It is advised to copy it to the clipboard for reference.',
+ 'finished' => 'drush_update_finished',
+ 'file' => 'includes/update.inc',
+ );
+ batch_set($batch);
+ drush_backend_batch_process('updatedb-batch-process');
+}
+
+
+
+function drush_update_finished($success, $results, $operations) {
+ // Nothing to do here. All caches already cleared. Kept as documentation of 'finished' callback.
+}
+
+/**
+ * Return a 2 item array with
+ * - an array where each item is a 3 item associative array describing a pending update.
+ * - an array listing the first update to run, keyed by module.
+ */
+function updatedb_status() {
+ $pending = update_get_update_list();
+
+ $return = array();
+ // Ensure system module's updates run first.
+ $start['system'] = array();
+
+ // Print a list of pending updates for this module and get confirmation.
+ foreach ($pending as $module => $updates) {
+ if (isset($updates['start'])) {
+ foreach ($updates['pending'] as $update_id => $description) {
+ // Strip cruft from front.
+ $description = str_replace($update_id . ' - ', '', $description);
+ $return[] = array('module' => ucfirst($module), 'update_id' => $update_id, 'description' => $description);
+ }
+ if (isset($updates['start'])) {
+ $start[$module] = $updates['start'];
+ }
+ }
+ }
+ return array($return, $start);
+}