update.inc 30.3 KB
Newer Older
1 2 3 4 5 6 7 8 9 10
<?php

/**
 * @file
 * Drupal database update API.
 *
 * This file contains functions to perform database updates for a Drupal
 * installation. It is included and used extensively by update.php.
 */

11
use Drupal\Component\Graph\Graph;
12
use Drupal\Component\Utility\Html;
13
use Drupal\Core\Utility\Error;
14

15
/**
16
 * Disables any extensions that are incompatible with the current core version.
17 18
 */
function update_fix_compatibility() {
19
  $extension_config = \Drupal::configFactory()->getEditable('core.extension');
20
  $save = FALSE;
21
  foreach (array('module', 'theme') as $type) {
22
    foreach ($extension_config->get($type) as $name => $weight) {
23
      if (update_check_incompatibility($name, $type)) {
24
        $extension_config->clear("$type.$name");
25 26 27
        $save = TRUE;
      }
    }
28 29 30 31
  }
  if ($save) {
    $extension_config->set('module', module_config_sort($extension_config->get('module')));
    $extension_config->save();
32 33 34 35
  }
}

/**
36
 * Tests the compatibility of a module or theme.
37 38 39 40 41 42
 */
function update_check_incompatibility($name, $type = 'module') {
  static $themes, $modules;

  // Store values of expensive functions for future use.
  if (empty($themes) || empty($modules)) {
43 44 45
    // We need to do a full rebuild here to make sure the database reflects any
    // code changes that were made in the filesystem before the update script
    // was initiated.
46
    $themes = \Drupal::service('theme_handler')->rebuildThemeData();
47
    $modules = system_rebuild_module_data();
48 49 50 51 52 53 54 55 56 57
  }

  if ($type == 'module' && isset($modules[$name])) {
    $file = $modules[$name];
  }
  elseif ($type == 'theme' && isset($themes[$name])) {
    $file = $themes[$name];
  }
  if (!isset($file)
      || !isset($file->info['core'])
58
      || $file->info['core'] != \Drupal::CORE_COMPATIBILITY
59
      || version_compare(phpversion(), $file->info['php']) < 0) {
60 61 62 63 64
    return TRUE;
  }
  return FALSE;
}

65
/**
66 67 68 69
 * Returns whether the minimum schema requirement has been satisfied.
 *
 * @return array
 *  A requirements info array.
70
 */
71 72
function update_system_schema_requirements() {
  $requirements = array();
73

74
  $system_schema = drupal_get_installed_schema_version('system');
75

76 77 78 79 80 81 82 83 84 85 86
  $requirements['minimum schema']['title'] = 'Minimum schema version';
  if ($system_schema >= \Drupal::CORE_MINIMUM_SCHEMA_VERSION) {
    $requirements['minimum schema'] += array(
      'value' => 'The installed schema version meets the minimum.',
      'description' => 'Schema version: ' . $system_schema,
    );
  }
  else {
    $requirements['minimum schema'] += array(
      'value' => 'The installed schema version does not meet the minimum.',
      'severity' => REQUIREMENT_ERROR,
87
      'description' => 'Your system schema version is ' . $system_schema . '. Updating directly from a schema version prior to 8000 is not supported. You must <a href="https://www.drupal.org/node/2179269">migrate your site to Drupal 8</a> first.',
88
    );
89
  }
90 91

  return $requirements;
92 93
}

94
/**
95
 * Checks update requirements and reports errors and (optionally) warnings.
96
 */
97
function update_check_requirements() {
98 99 100
  // Check requirements of all loaded modules.
  $requirements = \Drupal::moduleHandler()->invokeAll('requirements', array('update'));
  $requirements += update_system_schema_requirements();
101
  return $requirements;
102
}
103 104

/**
105
 * Forces a module to a given schema version.
106
 *
107
 * This function is rarely necessary.
108
 *
109 110 111 112
 * @param string $module
 *   Name of the module.
 * @param string $schema_version
 *   The schema version the module should be set to.
113
 */
114
function update_set_schema($module, $schema_version) {
115
  \Drupal::keyValue('system.schema')->set($module, $schema_version);
116 117 118 119
  // system_list_reset() is in module.inc but that would only be available
  // once the variable bootstrap is done.
  require_once __DIR__ . '/module.inc';
  system_list_reset();
120
}
121

122
/**
123 124
 * Implements callback_batch_operation().
 *
125
 * Performs one update and stores the results for display on the results page.
126
 *
127 128 129 130 131 132 133 134 135 136
 * If an update function completes successfully, it should return a message
 * as a string indicating success, for example:
 * @code
 * return t('New index added successfully.');
 * @endcode
 *
 * Alternatively, it may return nothing. In that case, no message
 * will be displayed at all.
 *
 * If it fails for whatever reason, it should throw an instance of
137 138
 * Drupal\Core\Utility\UpdateException with an appropriate error message, for
 * example:
139
 * @code
140 141
 * use Drupal\Core\Utility\UpdateException;
 * throw new UpdateException(t('Description of what went wrong'));
142 143
 * @endcode
 *
144 145 146 147
 * If an exception is thrown, the current update and all updates that depend on
 * it will be aborted. 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.
148
 *
149 150 151 152 153
 * If an update function needs to be re-run as part of a batch process, it
 * should accept the $sandbox array by reference as its first parameter
 * and set the #finished property to the percentage completed that it is, as a
 * fraction of 1.
 *
154 155 156 157
 * @param $module
 *   The module whose update will be run.
 * @param $number
 *   The update number to run.
158 159 160 161
 * @param $dependency_map
 *   An array whose keys are the names of all update functions that will be
 *   performed during this batch process, and whose values are arrays of other
 *   update functions that each one depends on.
162
 * @param $context
163 164 165
 *   The batch context array.
 *
 * @see update_resolve_dependencies()
166
 */
167 168 169 170 171
function 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.
172
  if (!empty($context['results']['#abort']) && array_intersect($context['results']['#abort'], array_merge($dependency_map, array($function)))) {
173 174 175
    return;
  }

176
  $ret = array();
177
  if (function_exists($function)) {
178 179 180 181
    try {
      $ret['results']['query'] = $function($context['sandbox']);
      $ret['results']['success'] = TRUE;
    }
182 183 184
    // @TODO We may want to do different error handling for different
    // exception types, but for now we'll just log the exception and
    // return the message for printing.
185
    // @see https://www.drupal.org/node/2564311
186
    catch (Exception $e) {
187 188
      watchdog_exception('update', $e);

189
      $variables = Error::decodeException($e);
190
      unset($variables['backtrace']);
191
      $ret['#abort'] = array('success' => FALSE, 'query' => t('%type: @message in %function (line %line of %file).', $variables));
192
    }
193 194
  }

195 196 197 198 199
  if (isset($context['sandbox']['#finished'])) {
    $context['finished'] = $context['sandbox']['#finished'];
    unset($context['sandbox']['#finished']);
  }

200 201 202 203 204 205 206 207 208
  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'])) {
209 210
    // Record this function in the list of updates that were aborted.
    $context['results']['#abort'][] = $function;
211
  }
212

213
  // Record the schema update if it was completed successfully.
214
  if ($context['finished'] == 1 && empty($ret['#abort'])) {
215 216 217
    drupal_set_installed_schema_version($module, $number);
  }

218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277
  $context['message'] = t('Updating @module', ['@module' => $module]);
}

/**
 * Executes a single hook_post_update_NAME().
 *
 * @param string $function
 *   The function name, that should be executed.
 * @param array $context
 *   The batch context array.
 */
function update_invoke_post_update($function, &$context) {
  $ret = [];

  // 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'])) {
    return;
  }

  list($module, $name) = explode('_post_update_', $function, 2);
  module_load_include('php', $module, $module . '.post_update');
  if (function_exists($function)) {
    try {
      $ret['results']['query'] = $function($context['sandbox']);
      $ret['results']['success'] = TRUE;

      \Drupal::service('update.post_update_registry')->registerInvokedUpdates([$function]);
    }
    // @TODO We may want to do different error handling for different exception
    // types, but for now we'll just log the exception and return the message
    // for printing.
    // @see https://www.drupal.org/node/2564311
    catch (Exception $e) {
      watchdog_exception('update', $e);

      $variables = Error::decodeException($e);
      unset($variables['backtrace']);
      $ret['#abort'] = [
        'success' => FALSE,
        'query' => t('%type: @message in %function (line %line of %file).', $variables),
      ];
    }
  }

  if (isset($context['sandbox']['#finished'])) {
    $context['finished'] = $context['sandbox']['#finished'];
    unset($context['sandbox']['#finished']);
  }
  if (!isset($context['results'][$module][$name])) {
    $context['results'][$module][$name] = array();
  }
  $context['results'][$module][$name] = array_merge($context['results'][$module][$name], $ret);

  if (!empty($ret['#abort'])) {
    // Record this function in the list of updates that were aborted.
    $context['results']['#abort'][] = $function;
  }

  $context['message'] = t('Post updating @module', ['@module' => $module]);
278 279
}

280
/**
281
 * Returns a list of all the pending database updates.
282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
 *
 * @return
 *   An associative array keyed by module name which contains all information
 *   about database updates that need to be run, and any updates that are not
 *   going to proceed due to missing requirements. The system module will
 *   always be listed first.
 *
 *   The subarray for each module can contain the following keys:
 *   - start: The starting update that is to be processed. If this does not
 *       exist then do not process any updates for this module as there are
 *       other requirements that need to be resolved.
 *   - warning: Any warnings about why this module can not be updated.
 *   - pending: An array of all the pending updates for the module including
 *       the update number and the description from source code comment for
 *       each update function. This array is keyed by the update number.
 */
function update_get_update_list() {
  // Make sure that the system module is first in the list of updates.
  $ret = array('system' => array());
301

302 303
  $modules = drupal_get_installed_schema_version(NULL, FALSE, TRUE);
  foreach ($modules as $module => $schema_version) {
304 305 306 307
    // Skip uninstalled and incompatible modules.
    if ($schema_version == SCHEMA_UNINSTALLED || update_check_incompatibility($module)) {
      continue;
    }
308 309 310
    // Display a requirements error if the user somehow has a schema version
    // from the previous Drupal major version.
    if ($schema_version < \Drupal::CORE_MINIMUM_SCHEMA_VERSION) {
311
      $ret[$module]['warning'] = '<em>' . $module . '</em> module cannot be updated. Its schema version is ' . $schema_version . ', which is from an earlier major release of Drupal. You will need to <a href="https://www.drupal.org/node/2127611">migrate the data for this module</a> instead.';
312 313
      continue;
    }
314
    // Otherwise, get the list of updates defined by this module.
315
    $updates = drupal_get_schema_versions($module);
316
    if ($updates !== FALSE) {
317
      // \Drupal::moduleHandler()->invoke() returns NULL for non-existing hooks,
318 319
      // so if no updates are removed, it will == 0.
      $last_removed = \Drupal::moduleHandler()->invoke($module, 'update_last_removed');
320
      if ($schema_version < $last_removed) {
321
        $ret[$module]['warning'] = '<em>' . $module . '</em> module cannot be updated. Its schema version is ' . $schema_version . '. Updates up to and including ' . $last_removed . ' have been removed in this release. In order to update <em>' . $module . '</em> module, you will first <a href="https://www.drupal.org/upgrade">need to upgrade</a> to the last version in which these updates were available.';
322 323
        continue;
      }
324

325
      $updates = array_combine($updates, $updates);
326
      foreach (array_keys($updates) as $update) {
327 328 329 330
        if ($update == \Drupal::CORE_MINIMUM_SCHEMA_VERSION) {
          $ret[$module]['warning'] = '<em>' . $module . '</em> module cannot be updated. It contains an update numbered as ' . \Drupal::CORE_MINIMUM_SCHEMA_VERSION . ' which is reserved for the earliest installation of a module in Drupal ' .  \Drupal::CORE_COMPATIBILITY . ', before any updates. In order to update <em>' . $module . '</em> module, you will need to install a version of the module with valid updates.';
          continue 2;
        }
331
        if ($update > $schema_version) {
332
          // The description for an update comes from its Doxygen.
333
          $func = new ReflectionFunction($module . '_update_' . $update);
334 335 336 337
          $description = str_replace(array("\n", '*', '/'), '', $func->getDocComment());
          $ret[$module]['pending'][$update] = "$update - $description";
          if (!isset($ret[$module]['start'])) {
            $ret[$module]['start'] = $update;
338 339 340 341 342 343 344 345
          }
        }
      }
      if (!isset($ret[$module]['start']) && isset($ret[$module]['pending'])) {
        $ret[$module]['start'] = $schema_version;
      }
    }
  }
346

347 348 349 350 351 352
  if (empty($ret['system'])) {
    unset($ret['system']);
  }
  return $ret;
}

353 354 355 356 357 358 359 360 361 362 363 364
/**
 * Resolves dependencies in a set of module updates, and orders them correctly.
 *
 * This function receives a list of requested module updates and determines an
 * appropriate order to run them in such that all update dependencies are met.
 * Any updates whose dependencies cannot be met are included in the returned
 * array but have the key 'allowed' set to FALSE; the calling function should
 * take responsibility for ensuring that these updates are ultimately not
 * performed.
 *
 * In addition, the returned array also includes detailed information about the
 * dependency chain for each update, as provided by the depth-first search
365
 * algorithm in Drupal\Component\Graph\Graph::searchAndSort().
366 367 368 369 370 371 372 373 374 375 376 377
 *
 * @param $starting_updates
 *   An array whose keys contain the names of modules with updates to be run
 *   and whose values contain the number of the first requested update for that
 *   module.
 *
 * @return
 *   An array whose keys are the names of all update functions within the
 *   provided modules that would need to be run in order to fulfill the
 *   request, arranged in the order in which the update functions should be
 *   run. (This includes the provided starting update for each module and all
 *   subsequent updates that are available.) The values are themselves arrays
378 379 380
 *   containing all the keys provided by the
 *   Drupal\Component\Graph\Graph::searchAndSort() algorithm, which encode
 *   detailed information about the dependency chain for this update function
381 382
 *   (for example: 'paths', 'reverse_paths', 'weight', and 'component'), as
 *   well as the following additional keys:
383 384 385 386 387 388 389 390 391
 *   - 'allowed': A boolean which is TRUE when the update function's
 *     dependencies are met, and FALSE otherwise. Calling functions should
 *     inspect this value before running the update.
 *   - 'missing_dependencies': An array containing the names of any other
 *     update functions that are required by this one but that are unavailable
 *     to be run. This array will be empty when 'allowed' is TRUE.
 *   - 'module': The name of the module that this update function belongs to.
 *   - 'number': The number of this update function within that module.
 *
392
 * @see \Drupal\Component\Graph\Graph::searchAndSort()
393 394 395 396 397 398
 */
function update_resolve_dependencies($starting_updates) {
  // Obtain a dependency graph for the requested update functions.
  $update_functions = update_get_update_function_list($starting_updates);
  $graph = update_build_dependency_graph($update_functions);

399 400 401
  // Perform the depth-first search and sort on the results.
  $graph_object = new Graph($graph);
  $graph = $graph_object->searchAndSort();
402
  uasort($graph, array('Drupal\Component\Utility\SortArray', 'sortByWeightElement'));
403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453

  foreach ($graph as $function => &$data) {
    $module = $data['module'];
    $number = $data['number'];
    // If the update function is missing and has not yet been performed, mark
    // it and everything that ultimately depends on it as disallowed.
    if (update_is_missing($module, $number, $update_functions) && !update_already_performed($module, $number)) {
      $data['allowed'] = FALSE;
      foreach (array_keys($data['paths']) as $dependent) {
        $graph[$dependent]['allowed'] = FALSE;
        $graph[$dependent]['missing_dependencies'][] = $function;
      }
    }
    elseif (!isset($data['allowed'])) {
      $data['allowed'] = TRUE;
      $data['missing_dependencies'] = array();
    }
    // Now that we have finished processing this function, remove it from the
    // graph if it was not part of the original list. This ensures that we
    // never try to run any updates that were not specifically requested.
    if (!isset($update_functions[$module][$number])) {
      unset($graph[$function]);
    }
  }

  return $graph;
}

/**
 * Returns an organized list of update functions for a set of modules.
 *
 * @param $starting_updates
 *   An array whose keys contain the names of modules and whose values contain
 *   the number of the first requested update for that module.
 *
 * @return
 *   An array containing all the update functions that should be run for each
 *   module, including the provided starting update and all subsequent updates
 *   that are available. The keys of the array contain the module names, and
 *   each value is an ordered array of update functions, keyed by the update
 *   number.
 *
 * @see update_resolve_dependencies()
 */
function update_get_update_function_list($starting_updates) {
  // Go through each module and find all updates that we need (including the
  // first update that was requested and any updates that run after it).
  $update_functions = array();
  foreach ($starting_updates as $module => $version) {
    $update_functions[$module] = array();
    $updates = drupal_get_schema_versions($module);
454 455 456 457 458 459 460
    if ($updates !== FALSE) {
      $max_version = max($updates);
      if ($version <= $max_version) {
        foreach ($updates as $update) {
          if ($update >= $version) {
            $update_functions[$module][$update] = $module . '_update_' . $update;
          }
461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478
        }
      }
    }
  }
  return $update_functions;
}

/**
 * Constructs a graph which encodes the dependencies between module updates.
 *
 * This function returns an associative array which contains a "directed graph"
 * representation of the dependencies between a provided list of update
 * functions, as well as any outside update functions that they directly depend
 * on but that were not in the provided list. The vertices of the graph
 * represent the update functions themselves, and each edge represents a
 * requirement that the first update function needs to run before the second.
 * For example, consider this graph:
 *
479
 * system_update_8001 ---> system_update_8002 ---> system_update_8003
480
 *
481 482
 * Visually, this indicates that system_update_8001() must run before
 * system_update_8002(), which in turn must run before system_update_8003().
483 484 485 486 487 488 489 490 491 492 493 494 495
 *
 * The function takes into account standard dependencies within each module, as
 * shown above (i.e., the fact that each module's updates must run in numerical
 * order), but also finds any cross-module dependencies that are defined by
 * modules which implement hook_update_dependencies(), and builds them into the
 * graph as well.
 *
 * @param $update_functions
 *   An organized array of update functions, in the format returned by
 *   update_get_update_function_list().
 *
 * @return
 *   A multidimensional array representing the dependency graph, suitable for
496 497 498 499 500 501
 *   passing in to Drupal\Component\Graph\Graph::searchAndSort(), but with extra
 *   information about each update function also included. Each array key
 *   contains the name of an update function, including all update functions
 *   from the provided list as well as any outside update functions which they
 *   directly depend on. Each value is an associative array containing the
 *   following keys:
502
 *   - 'edges': A representation of any other update functions that immediately
503 504
 *     depend on this one. See Drupal\Component\Graph\Graph::searchAndSort() for
 *     more details on the format.
505 506 507
 *   - 'module': The name of the module that this update function belongs to.
 *   - 'number': The number of this update function within that module.
 *
508
 * @see \Drupal\Component\Graph\Graph::searchAndSort()
509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534
 * @see update_resolve_dependencies()
 */
function update_build_dependency_graph($update_functions) {
  // Initialize an array that will define a directed graph representing the
  // dependencies between update functions.
  $graph = array();

  // Go through each update function and build an initial list of dependencies.
  foreach ($update_functions as $module => $functions) {
    $previous_function = NULL;
    foreach ($functions as $number => $function) {
      // Add an edge to the directed graph representing the fact that each
      // update function in a given module must run after the update that
      // numerically precedes it.
      if ($previous_function) {
        $graph[$previous_function]['edges'][$function] = TRUE;
      }
      $previous_function = $function;

      // Define the module and update number associated with this function.
      $graph[$function]['module'] = $module;
      $graph[$function]['number'] = $number;
    }
  }

  // Now add any explicit update dependencies declared by modules.
535
  $update_dependencies = update_retrieve_dependencies();
536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586
  foreach ($graph as $function => $data) {
    if (!empty($update_dependencies[$data['module']][$data['number']])) {
      foreach ($update_dependencies[$data['module']][$data['number']] as $module => $number) {
        $dependency = $module . '_update_' . $number;
        $graph[$dependency]['edges'][$function] = TRUE;
        $graph[$dependency]['module'] = $module;
        $graph[$dependency]['number'] = $number;
      }
    }
  }

  return $graph;
}

/**
 * Determines if a module update is missing or unavailable.
 *
 * @param $module
 *   The name of the module.
 * @param $number
 *   The number of the update within that module.
 * @param $update_functions
 *   An organized array of update functions, in the format returned by
 *   update_get_update_function_list(). This should represent all module
 *   updates that are requested to run at the time this function is called.
 *
 * @return
 *   TRUE if the provided module update is not installed or is not in the
 *   provided list of updates to run; FALSE otherwise.
 */
function update_is_missing($module, $number, $update_functions) {
  return !isset($update_functions[$module][$number]) || !function_exists($update_functions[$module][$number]);
}

/**
 * Determines if a module update has already been performed.
 *
 * @param $module
 *   The name of the module.
 * @param $number
 *   The number of the update within that module.
 *
 * @return
 *   TRUE if the database schema indicates that the update has already been
 *   performed; FALSE otherwise.
 */
function update_already_performed($module, $number) {
  return $number <= drupal_get_installed_schema_version($module);
}

/**
587
 * Invokes hook_update_dependencies() in all installed modules.
588
 *
589 590 591 592
 * This function is similar to \Drupal::moduleHandler()->invokeAll(), with the
 * main difference that it does not require that a module be enabled to invoke
 * its hook, only that it be installed. This allows the update system to
 * properly perform updates even on modules that are currently disabled.
593 594
 *
 * @return
595 596
 *   An array of return values obtained by merging the results of the
 *   hook_update_dependencies() implementations in all installed modules.
597
 *
598
 * @see \Drupal::moduleHandler()->invokeAll()
599
 * @see hook_update_dependencies()
600
 */
601
function update_retrieve_dependencies() {
602
  $return = array();
603
  // Get a list of installed modules, arranged so that we invoke their hooks in
604
  // the same order that \Drupal::moduleHandler()->invokeAll() does.
605
  foreach (\Drupal::keyValue('system.schema')->getAll() as $module => $schema) {
606 607 608 609
    if ($schema == SCHEMA_UNINSTALLED) {
      // Nothing to upgrade.
      continue;
    }
610
    $function = $module . '_update_dependencies';
611 612
    // Ensure install file is loaded.
    module_load_install($module);
613
    if (function_exists($function)) {
614 615 616 617 618 619 620 621 622
      $result = $function();
      // Each implementation of hook_update_dependencies() returns a
      // multidimensional, associative array containing some keys that
      // represent module names (which are strings) and other keys that
      // represent update function numbers (which are integers). We cannot use
      // array_merge_recursive() to properly merge these results, since it
      // treats strings and integers differently. Therefore, we have to
      // explicitly loop through the expected array structure here and perform
      // the merge manually.
623
      if (isset($result) && is_array($result)) {
624 625 626 627 628 629 630 631 632 633 634
        foreach ($result as $module => $module_data) {
          foreach ($module_data as $update => $update_data) {
            foreach ($update_data as $module_dependency => $update_dependency) {
              // If there are redundant dependencies declared for the same
              // update function (so that it is declared to depend on more than
              // one update from a particular module), record the dependency on
              // the highest numbered update here, since that automatically
              // implies the previous ones. For example, if one module's
              // implementation of hook_update_dependencies() required this
              // ordering:
              //
635
              // system_update_8002 ---> user_update_8001
636 637 638 639
              //
              // but another module's implementation of the hook required this
              // one:
              //
640
              // system_update_8003 ---> user_update_8001
641
              //
642 643
              // we record the second one, since system_update_8002() is always
              // guaranteed to run before system_update_8003() anyway (within
644 645 646 647 648 649 650 651
              // an individual module, updates are always run in numerical
              // order).
              if (!isset($return[$module][$update][$module_dependency]) || $update_dependency > $return[$module][$update][$module_dependency]) {
                $return[$module][$update][$module_dependency] = $update_dependency;
              }
            }
          }
        }
652 653 654 655 656 657 658
      }
    }
  }

  return $return;
}

659 660 661 662 663 664 665 666 667 668 669 670 671 672
/**
 * Replace permissions during update.
 *
 * This function can replace one permission to several or even delete an old
 * one.
 *
 * @param array $replace
 *   An associative array. The keys are the old permissions the values are lists
 *   of new permissions. If the list is an empty array, the old permission is
 *   removed.
 */
function update_replace_permissions($replace) {
  $prefix = 'user.role.';
  $cut = strlen($prefix);
673
  $role_names = \Drupal::service('config.storage')->listAll($prefix);
674 675
  foreach ($role_names as $role_name) {
    $rid = substr($role_name, $cut);
676
    $config = \Drupal::config("user.role.$rid");
677 678 679 680 681 682 683 684 685 686 687 688
    $permissions = $config->get('permissions') ?: array();
    foreach ($replace as $old_permission => $new_permissions) {
      if (($index = array_search($old_permission, $permissions)) !== FALSE) {
        unset($permissions[$index]);
        $permissions = array_unique(array_merge($permissions, $new_permissions));
      }
    }
    $config
      ->set('permissions', $permissions)
      ->save();
  }
}
689 690 691 692 693 694

/**
 * Returns a list of languages set up on the site during upgrades.
 *
 * @param $flags
 *   (optional) Specifies the state of the languages that have to be returned.
695
 *   It can be: LanguageInterface::STATE_CONFIGURABLE,
696
 *   LanguageInterface::STATE_LOCKED, or LanguageInterface::STATE_ALL.
697
 *
698
 * @return \Drupal\Core\Language\LanguageInterface[]
699 700 701
 *   An associative array of languages, keyed by the language code, ordered by
 *   weight ascending and name ascending.
 */
702
function update_language_list($flags = LanguageInterface::STATE_CONFIGURABLE) {
703 704 705 706 707 708 709 710 711

  $languages = &drupal_static(__FUNCTION__);

  // Initialize master language list.
  if (!isset($languages)) {
    // Initialize local language list cache.
   $languages = array();

    // Fill in master language list based on current configuration.
712
    $default = \Drupal::languageManager()->getDefaultLanguage();
713
    if (\Drupal::languageManager()->isMultilingual() || \Drupal::moduleHandler()->moduleExists('language')) {
714 715
      // Use language module configuration if available. We can not use
      // entity_load_multiple() because this breaks during updates.
716
      $language_entities = \Drupal::configFactory()->listAll('language.entity.');
717 718 719 720 721

      // Initialize default property so callers have an easy reference and can
      // save the same object without data loss.
      foreach ($language_entities as $langcode_config_name) {
        $langcode = substr($langcode_config_name, strlen('language.entity.'));
722
        $info = \Drupal::config($langcode_config_name)->get();
723
        $languages[$langcode] = new Language(array(
724
          'default' => ($info['id'] == $default->getId()),
725 726 727 728 729 730 731 732 733 734 735
          'name' => $info['label'],
          'id' => $info['id'],
          'direction' => $info['direction'],
          'locked' => $info['locked'],
          'weight' => $info['weight'],
        ));
      }
      Language::sort($languages);
    }
    else {
      // No language module, so use the default language only.
736
      $languages = array($default->getId() => $default);
737
      // Add the special languages, they will be filtered later if needed.
738
      $languages += \Drupal::languageManager()->getDefaultLockedLanguages($default->getWeight());
739 740 741 742 743 744 745 746 747
    }
  }

  // Filter the full list of languages based on the value of the $all flag. By
  // default we remove the locked languages, but the caller may request for
  // those languages to be added as well.
  $filtered_languages = array();

  // Add the site's default language if flagged as allowed value.
748
  if ($flags & LanguageInterface::STATE_SITE_DEFAULT) {
749
    $default = \Drupal::languageManager()->getDefaultLanguage();
750
    // Rename the default language.
751
    $default->setName(t("Site's default language (@lang_name)", array('@lang_name' => $default->getName())));
752
    $filtered_languages[LanguageInterface::LANGCODE_SITE_DEFAULT] = $default;
753 754 755
  }

  foreach ($languages as $langcode => $language) {
756
    if (($language->isLocked() && !($flags & LanguageInterface::STATE_LOCKED)) || (!$language->isLocked() && !($flags & LanguageInterface::STATE_CONFIGURABLE))) {
757
      continue;
758
    }
759 760 761 762 763
    $filtered_languages[$langcode] = $language;
  }

  return $filtered_languages;
}