update.inc 30.6 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\Core\Utility\Error;
13

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

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

  // Store values of expensive functions for future use.
  if (empty($themes) || empty($modules)) {
42
43
44
    // 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.
45
    $themes = \Drupal::service('theme_handler')->rebuildThemeData();
46
    $modules = system_rebuild_module_data();
47
48
49
50
51
52
53
54
55
56
  }

  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'])
57
      || $file->info['core'] != \Drupal::CORE_COMPATIBILITY
58
      || version_compare(phpversion(), $file->info['php']) < 0) {
59
60
61
62
63
    return TRUE;
  }
  return FALSE;
}

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

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

75
76
77
78
79
80
81
82
83
84
85
  $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,
86
      '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.',
87
    );
88
  }
89
90

  return $requirements;
91
92
}

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

/**
104
 * Forces a module to a given schema version.
105
 *
106
 * This function is rarely necessary.
107
 *
108
109
110
111
 * @param string $module
 *   Name of the module.
 * @param string $schema_version
 *   The schema version the module should be set to.
112
 */
113
function update_set_schema($module, $schema_version) {
114
  \Drupal::keyValue('system.schema')->set($module, $schema_version);
115
116
117
118
  // 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();
119
}
120

121
/**
122
123
 * Implements callback_batch_operation().
 *
124
 * Performs one update and stores the results for display on the results page.
125
 *
126
127
128
129
130
131
132
133
134
135
 * 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
136
137
 * Drupal\Core\Utility\UpdateException with an appropriate error message, for
 * example:
138
 * @code
139
140
 * use Drupal\Core\Utility\UpdateException;
 * throw new UpdateException(t('Description of what went wrong'));
141
142
 * @endcode
 *
143
144
145
146
 * 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.
147
 *
148
149
150
151
152
 * 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.
 *
153
154
155
156
 * @param $module
 *   The module whose update will be run.
 * @param $number
 *   The update number to run.
157
158
159
160
 * @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.
161
 * @param $context
162
163
164
 *   The batch context array.
 *
 * @see update_resolve_dependencies()
165
 */
166
167
168
169
170
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.
171
  if (!empty($context['results']['#abort']) && array_intersect($context['results']['#abort'], array_merge($dependency_map, array($function)))) {
172
173
174
    return;
  }

175
  $ret = array();
176
  if (function_exists($function)) {
177
178
179
180
    try {
      $ret['results']['query'] = $function($context['sandbox']);
      $ret['results']['success'] = TRUE;
    }
181
182
183
    // @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.
184
    // @see https://www.drupal.org/node/2564311
185
    catch (Exception $e) {
186
187
      watchdog_exception('update', $e);

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

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

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

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

217
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
  $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;

244
245
246
      if (!isset($context['sandbox']['#finished']) || (isset($context['sandbox']['#finished']) && $context['sandbox']['#finished'] >= 1)) {
        \Drupal::service('update.post_update_registry')->registerInvokedUpdates([$function]);
      }
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
278
    }
    // @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]);
279
280
}

281
/**
282
 * Returns a list of all the pending database updates.
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 *
 * @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());
302

303
304
  $modules = drupal_get_installed_schema_version(NULL, FALSE, TRUE);
  foreach ($modules as $module => $schema_version) {
305
306
307
308
    // Skip uninstalled and incompatible modules.
    if ($schema_version == SCHEMA_UNINSTALLED || update_check_incompatibility($module)) {
      continue;
    }
309
310
311
    // 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) {
312
      $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.';
313
314
      continue;
    }
315
    // Otherwise, get the list of updates defined by this module.
316
    $updates = drupal_get_schema_versions($module);
317
    if ($updates !== FALSE) {
318
      // \Drupal::moduleHandler()->invoke() returns NULL for non-existing hooks,
319
320
      // so if no updates are removed, it will == 0.
      $last_removed = \Drupal::moduleHandler()->invoke($module, 'update_last_removed');
321
      if ($schema_version < $last_removed) {
322
        $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.';
323
324
        continue;
      }
325

326
      $updates = array_combine($updates, $updates);
327
      foreach (array_keys($updates) as $update) {
328
        if ($update == \Drupal::CORE_MINIMUM_SCHEMA_VERSION) {
329
          $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.';
330
331
          continue 2;
        }
332
        if ($update > $schema_version) {
333
          // The description for an update comes from its Doxygen.
334
          $func = new ReflectionFunction($module . '_update_' . $update);
335
336
337
338
          $description = str_replace(array("\n", '*', '/'), '', $func->getDocComment());
          $ret[$module]['pending'][$update] = "$update - $description";
          if (!isset($ret[$module]['start'])) {
            $ret[$module]['start'] = $update;
339
340
341
342
343
344
345
346
          }
        }
      }
      if (!isset($ret[$module]['start']) && isset($ret[$module]['pending'])) {
        $ret[$module]['start'] = $schema_version;
      }
    }
  }
347

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

354
355
356
357
358
359
360
361
362
363
364
365
/**
 * 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
366
 * algorithm in Drupal\Component\Graph\Graph::searchAndSort().
367
368
369
370
371
372
373
374
375
376
377
378
 *
 * @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
379
380
381
 *   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
382
383
 *   (for example: 'paths', 'reverse_paths', 'weight', and 'component'), as
 *   well as the following additional keys:
384
385
386
387
388
389
390
391
392
 *   - '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.
 *
393
 * @see \Drupal\Component\Graph\Graph::searchAndSort()
394
395
396
397
398
399
 */
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);

400
401
402
  // Perform the depth-first search and sort on the results.
  $graph_object = new Graph($graph);
  $graph = $graph_object->searchAndSort();
403
  uasort($graph, array('Drupal\Component\Utility\SortArray', 'sortByWeightElement'));
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
454

  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);
455
456
457
458
459
460
461
    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;
          }
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
        }
      }
    }
  }
  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:
 *
480
 * system_update_8001 ---> system_update_8002 ---> system_update_8003
481
 *
482
483
 * Visually, this indicates that system_update_8001() must run before
 * system_update_8002(), which in turn must run before system_update_8003().
484
485
486
487
488
489
490
491
492
493
494
495
496
 *
 * 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
497
498
499
500
501
502
 *   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:
503
 *   - 'edges': A representation of any other update functions that immediately
504
505
 *     depend on this one. See Drupal\Component\Graph\Graph::searchAndSort() for
 *     more details on the format.
506
507
508
 *   - 'module': The name of the module that this update function belongs to.
 *   - 'number': The number of this update function within that module.
 *
509
 * @see \Drupal\Component\Graph\Graph::searchAndSort()
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
535
 * @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.
536
  $update_dependencies = update_retrieve_dependencies();
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
587
  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);
}

/**
588
 * Invokes hook_update_dependencies() in all installed modules.
589
 *
590
591
592
593
 * 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.
594
595
 *
 * @return
596
597
 *   An array of return values obtained by merging the results of the
 *   hook_update_dependencies() implementations in all installed modules.
598
 *
599
 * @see \Drupal\Core\Extension\ModuleHandlerInterface::invokeAll()
600
 * @see hook_update_dependencies()
601
 */
602
function update_retrieve_dependencies() {
603
  $return = array();
604
  // Get a list of installed modules, arranged so that we invoke their hooks in
605
  // the same order that \Drupal::moduleHandler()->invokeAll() does.
606
  foreach (\Drupal::keyValue('system.schema')->getAll() as $module => $schema) {
607
608
609
610
    if ($schema == SCHEMA_UNINSTALLED) {
      // Nothing to upgrade.
      continue;
    }
611
    $function = $module . '_update_dependencies';
612
613
    // Ensure install file is loaded.
    module_load_install($module);
614
    if (function_exists($function)) {
615
      $updated_dependencies = $function();
616
617
618
619
620
621
622
623
      // 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.
624
625
626
      if (isset($updated_dependencies) && is_array($updated_dependencies)) {
        foreach ($updated_dependencies as $module_name => $module_data) {
          foreach ($module_data as $update_version => $update_data) {
627
628
629
630
631
632
633
634
635
            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:
              //
636
              // system_update_8002 ---> user_update_8001
637
638
639
640
              //
              // but another module's implementation of the hook required this
              // one:
              //
641
              // system_update_8003 ---> user_update_8001
642
              //
643
644
              // we record the second one, since system_update_8002() is always
              // guaranteed to run before system_update_8003() anyway (within
645
646
              // an individual module, updates are always run in numerical
              // order).
647
648
              if (!isset($return[$module_name][$update_version][$module_dependency]) || $update_dependency > $return[$module_name][$update_version][$module_dependency]) {
                $return[$module_name][$update_version][$module_dependency] = $update_dependency;
649
650
651
652
              }
            }
          }
        }
653
654
655
656
657
658
659
      }
    }
  }

  return $return;
}

660
661
662
663
664
665
666
667
668
669
670
671
672
673
/**
 * 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);
674
  $role_names = \Drupal::service('config.storage')->listAll($prefix);
675
676
  foreach ($role_names as $role_name) {
    $rid = substr($role_name, $cut);
677
    $config = \Drupal::config("user.role.$rid");
678
679
680
681
682
683
684
685
686
687
688
689
    $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();
  }
}
690
691
692
693
694
695

/**
 * 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.
696
 *   It can be: LanguageInterface::STATE_CONFIGURABLE,
697
 *   LanguageInterface::STATE_LOCKED, or LanguageInterface::STATE_ALL.
698
 *
699
 * @return \Drupal\Core\Language\LanguageInterface[]
700
701
702
 *   An associative array of languages, keyed by the language code, ordered by
 *   weight ascending and name ascending.
 */
703
function update_language_list($flags = LanguageInterface::STATE_CONFIGURABLE) {
704
705
706
707
708
709

  $languages = &drupal_static(__FUNCTION__);

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

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

      // 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.'));
723
        $info = \Drupal::config($langcode_config_name)->get();
724
        $languages[$langcode] = new Language(array(
725
          'default' => ($info['id'] == $default->getId()),
726
727
728
729
730
731
732
733
734
735
736
          '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.
737
      $languages = array($default->getId() => $default);
738
      // Add the special languages, they will be filtered later if needed.
739
      $languages += \Drupal::languageManager()->getDefaultLockedLanguages($default->getWeight());
740
741
742
743
744
745
746
747
748
    }
  }

  // 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.
749
  if ($flags & LanguageInterface::STATE_SITE_DEFAULT) {
750
    $default = \Drupal::languageManager()->getDefaultLanguage();
751
    // Rename the default language.
752
    $default->setName(t("Site's default language (@lang_name)", array('@lang_name' => $default->getName())));
753
    $filtered_languages[LanguageInterface::LANGCODE_SITE_DEFAULT] = $default;
754
755
756
  }

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

  return $filtered_languages;
}