update.inc 64.2 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\Settings;
13
use Drupal\Component\Utility\String;
14
use Drupal\Core\Config\FileStorage;
15
use Drupal\Core\Config\ConfigException;
16
use Drupal\Core\DrupalKernel;
17
use Drupal\Core\Utility\Error;
18
use Drupal\Component\Uuid\Uuid;
19
use Drupal\Component\Utility\NestedArray;
20
use Symfony\Component\HttpFoundation\Request;
21

22
/**
23
 * Minimum schema version of Drupal 7 required for upgrade to Drupal 8.
24
 *
25
 * Upgrades from Drupal 7 to Drupal 8 require that Drupal 7 be running
26
 * the most recent version, or the upgrade could fail. We can't easily
27
 * check the Drupal 7 version once the update process has begun, so instead
28
 * we check the schema version of system.module.
29
 */
30
const REQUIRED_D7_SCHEMA_VERSION = '7069';
31

32
/**
33
 * Disables any extensions that are incompatible with the current core version.
34
35
 */
function update_fix_compatibility() {
36
  foreach (array('module', 'theme') as $type) {
37
    $config = \Drupal::config("system.$type");
38
39
40
41
42
43
44
45
46
47
48
49
    $save = FALSE;
    foreach ($config->get('enabled') as $name => $weight) {
      if (update_check_incompatibility($name, $type)) {
        $config->clear("enabled.$name");
        $save = TRUE;
      }
    }
    if ($save) {
      if ($type == 'module') {
        $config->set('enabled', module_config_sort($config->get('enabled')));
      }
      $config->save();
50
51
52
53
54
    }
  }
}

/**
55
 * Tests the compatibility of a module or theme.
56
57
58
59
60
61
 */
function update_check_incompatibility($name, $type = 'module') {
  static $themes, $modules;

  // Store values of expensive functions for future use.
  if (empty($themes) || empty($modules)) {
62
63
64
65
    // 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.
    $themes = system_rebuild_theme_data();
66
    $modules = system_rebuild_module_data();
67
68
69
70
71
72
73
74
75
76
  }

  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'])
77
      || $file->info['core'] != \Drupal::CORE_COMPATIBILITY
78
      || version_compare(phpversion(), $file->info['php']) < 0) {
79
80
81
82
83
84
    return TRUE;
  }
  return FALSE;
}

/**
85
 * Performs extra steps required to bootstrap when using a Drupal 7 database.
86
 *
87
88
 * Users who still have a Drupal 7 database (and are in the process of
 * updating to Drupal 8) need extra help before a full bootstrap can be
89
90
91
92
 * achieved. This function does the necessary preliminary work that allows
 * the bootstrap to be successful.
 *
 * No access check has been performed when this function is called, so no
93
 * irreversible changes to the database are made here.
94
 */
95
function update_prepare_d8_bootstrap() {
96
97
  include_once __DIR__ . '/install.inc';
  include_once __DIR__ . '/schema.inc';
98
  // Bootstrap to configuration.
99
  drupal_bootstrap(DRUPAL_BOOTSTRAP_CONFIGURATION);
100

101
102
103
  // During the bootstrap to DRUPAL_BOOTSTRAP_PAGE_CACHE, code will try to read
  // the cache but the cache tables are not compatible yet. Use the Null backend
  // by default to avoid exceptions.
104
105
106
  $settings = settings()->getAll();
  $settings['cache']['default'] = 'cache.backend.memory';
  new Settings($settings);
107

108
109
110
  // Enable UpdateServiceProvider service overrides.
  // @see update_flush_all_caches()
  $GLOBALS['conf']['container_service_providers']['UpdateServiceProvider'] = 'Drupal\Core\DependencyInjection\UpdateServiceProvider';
111

112
113
114
115
116
117
118
  // Check whether settings.php needs to be rewritten.
  $settings_exist = !empty($GLOBALS['config_directories']);

  if (!$settings_exist || !is_dir(config_get_config_directory('active')) || !is_dir(config_get_config_directory('staging'))) {
    drupal_install_config_directories();
  }

119
120
  // Bootstrap the kernel.
  // Do not attempt to dump and write it.
121
  $kernel = new DrupalKernel('update', drupal_classloader(), FALSE);
122
123
  $kernel->boot();

124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
  // If any of the required settings needs to be written, then settings.php
  // needs to be writable.
  if (!$settings_exist) {
    $settings_file = conf_path() . '/settings.php';
    $writable = drupal_verify_install_file($settings_file, FILE_EXIST | FILE_READABLE | FILE_WRITABLE);
    $requirements['settings file']['title'] = 'Settings file';
    if ($writable) {
      $requirements['settings file'] += array(
        'value' => 'settings.php is writable.',
      );
    }
    else {
      $requirements['settings file'] += array(
        'value' => 'settings.php is not writable.',
        'severity' => REQUIREMENT_ERROR,
        'description' => 'Drupal requires write permissions to <em>' . $settings_file . '</em> during the update process. If you are unsure how to grant file permissions, consult the <a href="http://drupal.org/server-permissions">online handbook</a>.',
      );
    }
    update_extra_requirements($requirements);
  }

145
  // Bootstrap the database.
146
  require_once __DIR__ . '/database.inc';
147

148
149
150
151
  // module.inc is not yet loaded but there are calls to module_config_sort()
  // below.
  require_once __DIR__ . '/module.inc';

152
153
  // If the site has not updated to Drupal 8 yet, check to make sure that it is
  // running an up-to-date version of Drupal 7 before proceeding. Note this has
154
155
  // to happen AFTER the database bootstraps because of
  // drupal_get_installed_schema_version().
156
157
158
159
160
161
  try {
    $system_schema = drupal_get_installed_schema_version('system');
  }
  catch (\Exception $e) {
    $system_schema = db_query('SELECT schema_version FROM {system} WHERE name = :system', array(':system' => 'system'))->fetchField();
  }
162
  if ($system_schema < 8000) {
163
    $has_required_schema = $system_schema >= REQUIRED_D7_SCHEMA_VERSION;
164
    $requirements = array(
165
166
167
      'drupal 7 version' => array(
        'title' => 'Drupal 7 version',
        'value' => $has_required_schema ? 'You are running a current version of Drupal 7.' : 'You are not running a current version of Drupal 7',
168
        'severity' => $has_required_schema ? NULL : REQUIREMENT_ERROR,
169
        'description' => $has_required_schema ? '' : 'Please update your Drupal 7 installation to the most recent version before attempting to upgrade to Drupal 8',
170
171
      ),
    );
172
173
    update_extra_requirements($requirements);

174
175
176
177
    // @todo update.php stages seem to be completely screwed up; the initial
    //   requirements check is not supposed to change the system. All of the
    //   following code seems to have been mistakenly/unknowingly added here and
    //   does not belong into update_prepare_d8_bootstrap().
178
    if ($has_required_schema) {
179
180
      if (!db_table_exists('key_value')) {
        $specs = array(
181
          'description' => 'Generic key-value storage table. See the state system for an example.',
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
          'fields' => array(
            'collection' => array(
              'description' => 'A named collection of key and value pairs.',
              'type' => 'varchar',
              'length' => 128,
              'not null' => TRUE,
              'default' => '',
            ),
            'name' => array(
              'description' => 'The key of the key-value pair. As KEY is a SQL reserved keyword, name was chosen instead.',
              'type' => 'varchar',
              'length' => 128,
              'not null' => TRUE,
              'default' => '',
            ),
            'value' => array(
              'description' => 'The value.',
              'type' => 'blob',
              'not null' => TRUE,
              'size' => 'big',
              'translatable' => TRUE,
            ),
          ),
          'primary key' => array('collection', 'name'),
        );
        db_create_table('key_value', $specs);
      }
209
210
211
212
213
214
215
216
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
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
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
      if (!db_table_exists('cache_tags')) {
        $table = array(
          'description' => 'Cache table for tracking cache tags related to the cache bin.',
          'fields' => array(
            'tag' => array(
              'description' => 'Namespace-prefixed tag string.',
              'type' => 'varchar',
              'length' => 255,
              'not null' => TRUE,
              'default' => '',
            ),
            'invalidations' => array(
              'description' => 'Number incremented when the tag is invalidated.',
              'type' => 'int',
              'not null' => TRUE,
              'default' => 0,
            ),
            'deletions' => array(
              'description' => 'Number incremented when the tag is deleted.',
              'type' => 'int',
              'not null' => TRUE,
              'default' => 0,
            ),
          ),
          'primary key' => array('tag'),
        );
        db_create_table('cache_tags', $table);
      }
      if (!db_table_exists('cache_config')) {
        $spec = array(
          'description' =>  'Cache table for configuration data.',
          'fields' => array(
            'cid' => array(
              'description' => 'Primary Key: Unique cache ID.',
              'type' => 'varchar',
              'length' => 255,
              'not null' => TRUE,
              'default' => '',
            ),
            'data' => array(
              'description' => 'A collection of data to cache.',
              'type' => 'blob',
              'not null' => FALSE,
              'size' => 'big',
            ),
            'expire' => array(
              'description' => 'A Unix timestamp indicating when the cache entry should expire, or 0 for never.',
              'type' => 'int',
              'not null' => TRUE,
              'default' => 0,
            ),
            'created' => array(
              'description' => 'A Unix timestamp indicating when the cache entry was created.',
              'type' => 'int',
              'not null' => TRUE,
              'default' => 0,
            ),
            'serialized' => array(
              'description' => 'A flag to indicate whether content is serialized (1) or not (0).',
              'type' => 'int',
              'size' => 'small',
              'not null' => TRUE,
              'default' => 0,
            ),
            'tags' => array(
              'description' => 'Space-separated list of cache tags for this entry.',
              'type' => 'text',
              'size' => 'big',
              'not null' => FALSE,
            ),
            'checksum_invalidations' => array(
              'description' => 'The tag invalidation sum when this entry was saved.',
              'type' => 'int',
              'not null' => TRUE,
              'default' => 0,
            ),
            'checksum_deletions' => array(
              'description' => 'The tag deletion sum when this entry was saved.',
              'type' => 'int',
              'not null' => TRUE,
              'default' => 0,
            ),
          ),
          'indexes' => array(
            'expire' => array('expire'),
          ),
          'primary key' => array('cid'),
        );
        db_create_table('cache_config', $spec);
      }

      require_once DRUPAL_ROOT . '/core/modules/system/system.install';
      $tables = array(
        'cache',
        'cache_bootstrap',
        'cache_block',
        'cache_field',
        'cache_filter',
        'cache_form',
        'cache_image',
        'cache_menu',
        'cache_page',
        'cache_path',
        'cache_update',
      );

      foreach ($tables as $table) {
        update_add_cache_columns($table);
      }

319
320
321
      // Bootstrap variables so we can update theme while preparing the update
      // process.
      drupal_bootstrap(DRUPAL_BOOTSTRAP_VARIABLES);
322

323
324
325
326
      // Update the 'language_default' system variable, if configured.
      // Required to run before drupal_install_config_directories(), since that
      // triggers a call into system_stream_wrappers(), which calls t(), which
      // calls into language_default().
327
      $language_default = update_variable_get('language_default');
328
329
330
      if (!empty($language_default) && (isset($language_default->id) || isset($language_default->language))) {
        if (!isset($language_default->id)) {
          $language_default->id = $language_default->language;
331
332
333
334
335
        }
        unset($language_default->language);
        // In D8, the 'language_default' is not anymore an object, but an array,
        // so make sure that the new value that is saved into this variable is an
        // array.
336
        update_variable_set('language_default', (array) $language_default);
337
338
      }

339
340
341
342
      $module_config = \Drupal::config('system.module');
      $theme_config = \Drupal::config('system.theme');
      $disabled_themes = \Drupal::config('system.theme.disabled');
      $schema_store = \Drupal::keyValue('system.schema');
343
344
345
346
347
348

      // Load system.module, because update_prepare_d8_bootstrap() is called in
      // the initial minimal update.php bootstrap that performs the core
      // requirements check.
      require_once DRUPAL_ROOT . '/core/modules/system/system.module';

349
350
      // Make sure that the bootstrap cache is cleared as that might contain
      // incompatible data structures.
351
      cache('bootstrap')->deleteAll();
352

353
354
355
356
357
358
359
      // Retrieve all installed extensions from the {system} table.
      // Uninstalled extensions are ignored and not converted.
      $result = db_query('SELECT name, status, weight, schema_version, type FROM {system} WHERE type = :theme OR (type = :module AND schema_version <> :schema_uninstalled)', array(
        ':theme' => 'theme',
        ':module' => 'module',
        ':schema_uninstalled' => SCHEMA_UNINSTALLED,
      ));
360

361
362
363
364
365
      $module_data = _system_rebuild_module_data();

      // Migrate each extension into configuration, varying by the extension's
      // status, and record its schema version.
      foreach ($result as $record) {
366
367
368
369
370
371
372
373
374
375
376
377
        // Before migrating any extension into configuration, make sure the
        // extensions name length is not higher than the limit.
        if (drupal_strlen($record->name) > 50) {
          $requirements['module name too long ' . $record->name] = array(
            'title' => 'Module name too long',
            'value' => format_string('@name is @count characters long.', array('@name' => $record->name, '@count' => drupal_strlen($record->name))),
            'description' => 'Module names longer than 50 characters are <a href="https://drupal.org/node/2014073">no longer supported</a>.',
            'severity' => REQUIREMENT_ERROR,
          );
          update_extra_requirements($requirements);
        }

378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
        if ($record->type == 'module') {
          if ($record->status && isset($module_data[$record->name])) {
            $module_config->set('enabled.' . $record->name, $record->weight);
          }
        }
        elseif ($record->type == 'theme') {
          if ($record->status) {
            $theme_config->set('enabled.' . $record->name, 0);
          }
          else {
            $disabled_themes->set($record->name, 0);
          }
        }
        $schema_store->set($record->name, $record->schema_version);
      }
393
394
395
396
397
398
      $sorted_modules = module_config_sort($module_config->get('enabled'));
      $module_config->set('enabled', $sorted_modules)->save();
      $sorted_with_filenames = array();
      foreach (array_keys($sorted_modules) as $m) {
        $sorted_with_filenames[$m] = drupal_get_filename('module', $m);
      }
399
      \Drupal::moduleHandler()->setModuleList($sorted_with_filenames);
400
401
402
      $theme_config->save();
      $disabled_themes->save();

403
404
405
406
407
408
      // Migrate the private key to state. This is used to create the token for
      // the upgrade batch so needs to be be done before the upgrade has begun.
      update_variables_to_state(array(
        'drupal_private_key' => 'system.private_key',
      ));

409
410
411
412
413
      // Update the dynamic include paths that might be used before running the
      // proper update functions.
      update_prepare_stored_includes();
      // Update the environment for the language bootstrap if needed.
      update_prepare_d8_language();
414
415
      // Rebuild kernel after new language fields are added in the database
      // because the translation service depends on them being there.
416
      \Drupal::service('kernel')->updateModules($sorted_with_filenames, $sorted_with_filenames);
417

418
419
420
421
422
423
424
425
426
      // Change language column to langcode in url_alias.
      if (db_table_exists('url_alias') && db_field_exists('url_alias', 'language')) {
        db_drop_index('url_alias', 'alias_language_pid');
        db_drop_index('url_alias', 'source_language_pid');
        $langcode_spec = array(
          'description' => "The language code this alias is for; if 'und', the alias will be used for unknown languages. Each Drupal path can have an alias for each supported language.",
          'type' => 'varchar',
          'length' => 12,
          'not null' => TRUE,
427
          'default' => '',
428
429
430
431
432
433
434
435
436
        );
        $langcode_indexes = array('indexes' =>
          array(
            'alias_langcode_pid' => array('alias', 'langcode', 'pid'),
            'source_langcode_pid' => array('source', 'langcode', 'pid'),
          ),
        );
        db_change_field('url_alias', 'language', 'langcode', $langcode_spec, $langcode_indexes);
      }
437
438
    }
  }
439
440
441
442
443
  // Moves install_profile from variable to settings. You can't do that in
  // system.install because _system_rebuild_module_data() needs the profile
  // directly. Check that it has not been set already. This is the case for
  // Simpletest upgrade path tests.
  if (!settings()->get('install_profile')) {
444
    $old_variable = unserialize(\Drupal::database()->query('SELECT value FROM {variable} WHERE name = :name', array(':name' => 'install_profile'))->fetchField());
445
446
447
448
449
450
451
452
453
454
455
    $settings = array(
      'settings' => array(
        'install_profile' => (object) array(
            'value' => $old_variable,
            'required' => TRUE,
        ),
      )
    );
    drupal_rewrite_settings($settings);
  }

456
  // Now remove the cache override.
457
458
459
  $settings = settings()->getAll();
  unset($settings['cache']['default']);
  new Settings($settings);
460
  $kernel = new DrupalKernel('update', drupal_classloader(), FALSE);
461
  $kernel->boot();
462
463
464
465

  // Clear the D7 caches, to ensure that for example the theme_registry does not
  // take part in the upgrade process.
  Drupal::cache('cache')->deleteAll();
466
467
}

468
/**
469
 * Fixes stored include paths to match the "/core" migration.
470
471
 */
function update_prepare_stored_includes() {
472
473
474
475
476
  // Retrieve the currently stored language types. Default to the hardcoded D7
  // values.
  $default_language_types = array('language' => TRUE, 'language_content' => FALSE, 'language_url' => FALSE);
  $language_types = array_keys(update_variable_get('language_types', $default_language_types));

477
  // Update language negotiation settings.
478
479
  foreach ($language_types as $language_type) {
    $negotiation = update_variable_get("language_negotiation_$language_type", array());
480
    foreach ($negotiation as &$method) {
481
      unset($method['file']);
482
    }
483
    update_variable_set("language_negotiation_$language_type", $negotiation);
484
485
486
  }
}

487
/**
488
 * Prepares Drupal 8 language changes for the bootstrap if needed.
489
490
491
 */
function update_prepare_d8_language() {
  if (db_table_exists('languages')) {
492
    \Drupal::moduleHandler()->install(array('language'));
493

494
495
496
497
498
499
500
501
502
    $languages = db_select('languages', 'l')
      ->fields('l')
      ->execute();
    $plurals = array();
    $javascript = array();
    $prefixes = array();
    $domains = array();
    foreach ($languages as $language) {
      $plurals[$language->language] = array(
503
504
        'plurals' => $language->plurals,
        'formula' => $language->formula,
505
506
507
508
509
      );
      $javascript[$language->language] = $language->javascript;
      $prefixes[$language->language] = $language->prefix;
      $domains[$language->language] = $language->domain;
    }
510
511
512
    \Drupal::state()->set('locale.translation.plurals', $plurals);
    \Drupal::state()->set('locale.translation.javascript', $javascript);
    \Drupal::config('language.negotiation')
513
514
515
      ->set('url.prefixes', $prefixes)
      ->set('url.domains', $domains)
      ->save();
516
517
518
519
520
521
522
523

    // Drop now unneeded columns.
    db_drop_field('languages', 'plurals');
    db_drop_field('languages', 'formula');
    db_drop_field('languages', 'javascript');
    db_drop_field('languages', 'prefix');
    db_drop_field('languages', 'domain');
    db_drop_field('languages', 'native');
524
525
    db_drop_field('languages', 'enabled');

526
527
528
    // Rename the languages table to language.
    db_rename_table('languages', 'language');

529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
    // Rename language column to langcode and set it again as the primary key.
    if (db_field_exists('language', 'language')) {
      db_drop_primary_key('language');
      $langcode_spec = array(
        'type' => 'varchar',
        'length' => 12,
        'not null' => TRUE,
        'default' => '',
        'description' => "Language code, e.g. 'de' or 'en-US'.",
      );
      db_change_field('language', 'language', 'langcode', $langcode_spec, array('primary key' => array('langcode')));
    }

    // Adds the locked column and saves the special languages.
    if (!db_field_exists('language', 'locked')) {
      $locked_spec = array(
        'type' => 'int',
        'size' => 'tiny',
        'not null' => TRUE,
        'default' => 0,
        'description' => 'A boolean indicating whether the administrator can edit or delete the language.',
      );
      db_add_field('language', 'locked', $locked_spec);

553
      $max_language_weight = db_query('SELECT MAX(weight) FROM {language}')->fetchField();
554
      $languages = \Drupal::languageManager()->getDefaultLockedLanguages($max_language_weight);
555
556
557
      foreach ($languages as $language) {
        db_insert('language')
          ->fields(array(
558
            'langcode' => $language->id,
559
560
561
562
563
564
565
566
            'name' => $language->name,
            'weight' => $language->weight,
            // These languages are locked, default to enabled.
            'locked' => 1,
          ))
          ->execute();
      }
    }
567
568

    // Update the 'language_default' system variable with the langcode change.
569
    $language_default = update_variable_get('language_default');
570
571
    if (!empty($language_default)) {
      if (isset($language_default->language)) {
572
        $language_default->id = $language_default->language;
573
574
575
        unset($language_default->language);
      }
      unset($language_default->enabled);
576
577
578
      // In D8, the 'language_default' is not anymore an object, but an array,
      // so make sure that the new value that is saved into this variable is an
      // array.
579
580
      $language_default = (array) $language_default;
      $language_default['langcode'] = 'en';
581
      update_variable_set('language_default', $language_default);
582
583
584
585
    }

    // Convert languages to config entities.
    $result = db_query('SELECT * FROM {language}');
586
    $uuid = \Drupal::service('uuid');
587
    foreach ($result as $language) {
588
      \Drupal::config('language.entity.' . $language->langcode)
589
590
591
592
593
594
595
596
        ->set('id', $language->langcode)
        ->set('uuid', $uuid->generate())
        ->set('label', $language->name)
        ->set('direction', $language->direction)
        ->set('weight', $language->weight)
        ->set('locked', $language->locked)
        ->set('langcode', 'en')
        ->save();
597
    }
598
599
600
601
602
603
604
605
606
607
608
609
610

    // Add column to track customized string status to locales_target.
    // When updating in a non-English language, the locale translation system is
    // triggered, which attempts to query string translations already.
    if (db_table_exists('locales_target') && !db_field_exists('locales_target', 'customized')) {
      $spec = array(
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0, // LOCALE_NOT_CUSTOMIZED
        'description' => 'Boolean indicating whether the translation is custom to this site.',
      );
      db_add_field('locales_target', 'customized', $spec);
    }
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
    // Add locales_location table to track string locations.
    // When updating in a non-English language, this table is used for
    // refreshing JavaScript translations.
    if (db_table_exists('locales_source') && !db_table_exists('locales_location')) {
      $table = array(
        'description' => 'Location information for source strings.',
        'fields' => array(
          'lid' => array(
            'type' => 'serial',
            'not null' => TRUE,
            'description' => 'Unique identifier of this location.',
          ),
          'sid' => array(
            'type' => 'int',
            'not null' => TRUE,
            'description' => 'Unique identifier of this string.',
          ),
          'type' => array(
            'type' => 'varchar',
            'length' => 50,
            'not null' => TRUE,
            'default' => '',
            'description' => 'The location type (file, config, path, etc).',
          ),
          'name' => array(
            'type' => 'varchar',
            'length' => 255,
            'not null' => TRUE,
            'default' => '',
            'description' => 'Type dependent location information (file name, path, etc).',
          ),
          'version' => array(
            'type' => 'varchar',
            'length' => 20,
            'not null' => TRUE,
            'default' => 'none',
            'description' => 'Version of Drupal where the location was found.',
          ),
        ),
        'primary key' => array('lid'),
        'foreign keys' => array(
          'locales_source' => array(
            'table' => 'locales_source',
            'columns' => array('sid' => 'lid'),
          ),
        ),
        'indexes' => array(
          'string_id' => array('sid'),
          'string_type' => array('sid', 'type'),
        ),
      );

      db_create_table('locales_location', $table);
    }
665
666
667
  }
}

668
/**
669
 * Performs Drupal 7.x to 8.x required update.php updates.
670
 *
671
 * This function runs when update.php is run the first time for 8.x,
672
673
674
675
 * even before updates are selected or performed. It is important
 * that if updates are not ultimately performed that no changes are
 * made which make it impossible to continue using the prior version.
 */
676
function update_fix_d8_requirements() {
677
  if (drupal_get_installed_schema_version('system') < 8000 && !update_variable_get('update_d8_requirements', FALSE)) {
678
679
680

    // Make sure that file.module is enabled as it is required for the user
    // picture upgrade path.
681
    \Drupal::moduleHandler()->install(array('file'));
682

683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
    $schema = array(
      'description' => 'Generic key/value storage table with an expiration.',
      'fields' => array(
        'collection' => array(
          'description' => 'A named collection of key and value pairs.',
          'type' => 'varchar',
          'length' => 128,
          'not null' => TRUE,
          'default' => '',
        ),
        'name' => array(
          // KEY is an SQL reserved word, so use 'name' as the key's field name.
          'description' => 'The key of the key/value pair.',
          'type' => 'varchar',
          'length' => 128,
          'not null' => TRUE,
          'default' => '',
        ),
        'value' => array(
          'description' => 'The value of the key/value pair.',
          'type' => 'blob',
          'not null' => TRUE,
          'size' => 'big',
        ),
        'expire' => array(
          'description' => 'The time since Unix epoch in seconds when this item expires. Defaults to the maximum possible time.',
          'type' => 'int',
          'not null' => TRUE,
          'default' => 2147483647,
        ),
      ),
      'primary key' => array('collection', 'name'),
      'indexes' => array(
        'all' => array('name', 'collection', 'expire'),
      ),
    );
    db_create_table('key_value_expire', $schema);

721
722
723
724
    // Views module is required to convert all previously existing listings into
    // views configurations.
    // Like any other module APIs and services, Views' services are not available
    // in update.php. Existing listings are migrated into configuration, using
725
    // the limited standard tools of raw database queries and \Drupal::config().
726
    \Drupal::moduleHandler()->install(array('views'));
727

728
    update_variable_set('update_d8_requirements', TRUE);
729
  }
730
}
731
732

/**
733
 * Forces a module to a given schema version.
734
 *
735
 * This function is rarely necessary.
736
 *
737
738
739
740
 * @param string $module
 *   Name of the module.
 * @param string $schema_version
 *   The schema version the module should be set to.
741
 */
742
function update_set_schema($module, $schema_version) {
743
  \Drupal::keyValue('system.schema')->set($module, $schema_version);
744
745
746
747
  // 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();
748
}
749

750
/**
751
 * Performs one update and stores the results for display on the results page.
752
 *
753
754
755
756
757
758
759
760
761
762
 * 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
763
764
 * Drupal\Core\Utility\UpdateException with an appropriate error message, for
 * example:
765
 * @code
766
767
 * use Drupal\Core\Utility\UpdateException;
 * throw new UpdateException(t('Description of what went wrong'));
768
769
 * @endcode
 *
770
771
772
773
 * 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.
774
 *
775
776
777
778
779
 * 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.
 *
780
781
782
783
 * @param $module
 *   The module whose update will be run.
 * @param $number
 *   The update number to run.
784
785
786
787
 * @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.
788
 * @param $context
789
790
791
 *   The batch context array.
 *
 * @see update_resolve_dependencies()
792
 */
793
794
795
796
797
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.
798
  if (!empty($context['results']['#abort']) && array_intersect($context['results']['#abort'], array_merge($dependency_map, array($function)))) {
799
800
801
    return;
  }

802
  $ret = array();
803
  if (function_exists($function)) {
804
805
806
807
    try {
      $ret['results']['query'] = $function($context['sandbox']);
      $ret['results']['success'] = TRUE;
    }
808
809
810
    // @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.
811
    catch (Exception $e) {
812
813
      watchdog_exception('update', $e);

814
      $variables = Error::decodeException($e);
815
      unset($variables['backtrace']);
816
817
      // The exception message is run through
      // \Drupal\Component\Utility\String::checkPlain() by
818
      // \Drupal\Core\Utility\Error::decodeException().
819
      $ret['#abort'] = array('success' => FALSE, 'query' => t('%type: !message in %function (line %line of %file).', $variables));
820
    }
821
822
  }

823
824
825
826
827
  if (isset($context['sandbox']['#finished'])) {
    $context['finished'] = $context['sandbox']['#finished'];
    unset($context['sandbox']['#finished']);
  }

828
829
830
831
832
833
834
835
836
  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'])) {
837
838
    // Record this function in the list of updates that were aborted.
    $context['results']['#abort'][] = $function;
839
  }
840

841
  // Record the schema update if it was completed successfully.
842
  if ($context['finished'] == 1 && empty($ret['#abort'])) {
843
844
845
    drupal_set_installed_schema_version($module, $number);
  }

846
  $context['message'] = 'Updating ' . String::checkPlain($module) . ' module';
847
848
}

849
/**
850
 * Starts the database update batch process.
851
852
 *
 * @param $start
853
854
855
856
857
 *   An array whose keys contain the names of modules to be updated during the
 *   current batch process, and whose values contain the number of the first
 *   requested update for that module. The actual updates that are run (and the
 *   order they are run in) will depend on the results of passing this data
 *   through the update dependency system.
858
859
860
861
862
863
864
 * @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.
865
866
867
 * @param $redirect_callback
 *   (optional) Specify a function to be called to redirect to the progressive
 *   processing page.
868
869
 *
 * @see update_resolve_dependencies()
870
 */
871
function update_batch($start, $redirect = NULL, $url = NULL, $batch = array(), $redirect_callback = NULL) {
872
873
  // During the update, bring the site offline so that schema changes do not
  // affect visiting users.
874
  $maintenance_mode = \Drupal::config('system.maintenance')->get('enabled');
875
876
877
878
  if (isset($maintenance_mode)) {
    $_SESSION['maintenance_mode'] = $maintenance_mode;
  }
  if (empty($_SESSION['maintenance_mode'])) {
879
    if (db_table_exists('state')) {
880
      \Drupal::state()->set('system.maintenance_mode', TRUE);
881
    }
882
883
  }

884
885
886
887
888
889
890
891
892
893
894
895
896
  // 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();
  }

897
  $operations = array();
898
899
900
901
902
903
904
905
  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']]);
906
      }
907
      // Add this update function to the batch.
908
909
      $function = $update['module'] . '_update_' . $update['number'];
      $operations[] = array('update_do_one', array($update['module'], $update['number'], $dependency_map[$function]));
910
911
912
913
914
915
916
917
    }
  }
  $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' => 'update_finished',
918
    'file' => 'core/includes/update.inc',
919
920
  );
  batch_set($batch);
921
  return batch_process($redirect, $url, $redirect_callback);
922
923
924
}

/**
925
 * Finishes the update process and stores the results for eventual display.
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
 *
 * After the updates run, all caches are flushed. The update results are
 * stored into the session (for example, to be displayed on the update results
 * page in update.php). Additionally, if the site was off-line, now that the
 * update process is completed, the site is set back online.
 *
 * @param $success
 *   Indicate that the batch API tasks were all completed successfully.
 * @param $results
 *   An array of all the results that were updated in update_do_one().
 * @param $operations
 *   A list of all the operations that had not been completed by the batch API.
 *
 * @see update_batch()
 */
function update_finished($success, $results, $operations) {
  // Clear the caches in case the data has been updated.
943
  update_flush_all_caches();
944
945
946
947
948
949

  $_SESSION['update_results'] = $results;
  $_SESSION['update_success'] = $success;
  $_SESSION['updates_remaining'] = $operations;

  // Now that the update is done, we can put the site back online if it was
950
  // previously in maintenance mode.
951
  if (isset($_SESSION['maintenance_mode'])) {
952
    \Drupal::state()->set('system.maintenance_mode', FALSE);
953
    unset($_SESSION['maintenance_mode']);
954
955
956
  }
}

957
/**
958
 * Returns a list of all the pending database updates.
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
 *
 * @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());
978

979
980
  $modules = drupal_get_installed_schema_version(NULL, FALSE, TRUE);
  foreach ($modules as $module => $schema_version) {
981
982
983
984
985
    // Skip uninstalled and incompatible modules.
    if ($schema_version == SCHEMA_UNINSTALLED || update_check_incompatibility($module)) {
      continue;
    }
    // Otherwise, get the list of updates defined by this module.
986
    $updates = drupal_get_schema_versions($module);
987
    if ($updates !== FALSE) {
988
989
990
991
992
993
994
      // module_invoke returns NULL for nonexisting hooks, so if no updates
      // are removed, it will == 0.
      $last_removed = module_invoke($module, 'update_last_removed');
      if ($schema_version < $last_removed) {
        $ret[$module]['warning'] = '<em>' . $module . '</em> module can not 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="http://drupal.org/upgrade">need to upgrade</a> to the last version in which these updates were available.';
        continue;
      }
995

996
997
998
      $updates = drupal_map_assoc($updates);
      foreach (array_keys($updates) as $update) {
        if ($update > $schema_version) {
999
          // The description for an update comes from its Doxygen.
1000
          $func = new ReflectionFunction($module . '_update_' . $update);
1001
1002
1003
1004
          $description = str_replace(array("\n", '*', '/'), '', $func->getDocComment());
          $ret[$module]['pending'][$update] = "$update - $description";
          if (!isset($ret[$module]['start'])) {
            $ret[$module]['start'] = $update;
1005
1006
1007
1008
1009
1010
1011
1012
          }
        }
      }
      if (!isset($ret[$module]['start']) && isset($ret[$module]['pending'])) {
        $ret[$module]['start'] = $schema_version;
      }
    }
  }
1013

1014
1015
1016
1017
1018
1019
  if (empty($ret['system'])) {
    unset($ret['system']);
  }
  return $ret;
}

1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
/**
 * 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
1032
 * algorithm in Drupal\Component\Graph\Graph::searchAndSort().
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
 *
 * @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
1045
1046
1047
 *   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
1048
1049
 *   (for example: 'paths', 'reverse_paths', 'weight', and 'component'), as
 *   well as the following additional keys:
1050
1051
1052
1053
1054
1055
1056
1057
1058
 *   - '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.
 *
1059
 * @see \Drupal\Component\Graph\Graph::searchAndSort()
1060
1061
1062
1063
1064
1065
 */
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);

1066
1067
1068
  // Perform the depth-first search and sort on the results.
  $graph_object = new Graph($graph);
  $graph = $graph_object->searchAndSort();
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
  uasort($graph, 'drupal_sort_weight');

  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);
1121
1122
1123
1124
1125
1126
1127
    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;
          }
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
        }
      }
    }
  }
  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:
 *
1146
 * system_update_8000 ---> system_update_8001 ---> system_update_8002
1147
 *
1148
1149
 * Visually, this indicates that system_update_8000() must run before
 * system_update_8001(), which in turn must run before system_update_8002().
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
 *
 * 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
1163
1164
1165
1166
1167
1168
 *   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:
1169
 *   - 'edges': A representation of any other update functions that immediately
1170
1171
 *     depend on this one. See Drupal\Component\Graph\Graph::searchAndSort() for
 *     more details on the format.
1172
1173
1174
 *   - 'module': The name of the module that this update function belongs to.
 *   - 'number': The number of this update function within that module.
 *
1175
 * @see \Drupal\Component\Graph\Graph::searchAndSort()
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
 * @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.
1202
  $update_dependencies = update_retrieve_dependencies();
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
  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);
}

/**
1254
 * Invokes hook_update_dependencies() in all installed modules.
1255
 *
1256
1257
1258
1259
 * 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.
1260
1261
 *
 * @return
1262
1263
 *   An array of return values obtained by merging the results of the
 *   hook_update_dependencies() implementations in all installed modules.
1264
 *
1265
 * @see \Drupal::moduleHandler()->invokeAll()
1266
 * @see hook_update_dependencies()
1267
 */
1268
function update_retrieve_dependencies() {
1269
  $return = array();
1270
  // Get a list of installed modules, arranged so that we invoke their hooks in
1271
  // the same order that \Drupal::moduleHandler()->invokeAll() does.
1272
  foreach (\Drupal::keyValue('system.schema')->getAll() as $module => $schema) {
1273
1274
1275
1276
    if ($schema == SCHEMA_UNINSTALLED) {
      // Nothing to upgrade.
      continue;
    }
1277
    $function = $module . '_update_dependencies';
1278
1279
    // Ensure install file is loaded.
    module_load_install($module);
1280
    if (function_exists($function)) {
1281
1282
1283
1284
1285
1286
1287
1288
1289
      $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.
1290
      if (isset($result) && is_array($result)) {
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
        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:
              //
1302
              // system_update_8001 ---> user_update_8000
1303
1304
1305
1306
              //
              // but another module's implementation of the hook required this
              // one:
              //
1307
              // system_update_8002 ---> user_update_8000
1308
              //
1309
1310
              // we record the second one, since system_update_8001() is always
              // guaranteed to run before system_update_8002() anyway (within
1311
1312
1313
1314
1315
1316
1317
1318
              // 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;
              }
            }
          }
        }
1319
1320
1321
1322
1323
1324
1325
      }
    }
  }

  return $return;
}

1326
/**
1327
 * Gets the value of a variable from the database during 7.x-8.x upgrades.
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
 *
 * Use this during the 7.x-8.x upgrade path instead of variable_get().
 *
 * @param string $name
 *   The name of the variable.
 * @param mixed $default
 *   The default value of the variable.
 *
 * @return mixed
 *   The value of the variable in the database unserialized, or NULL if not set.
 *
 * @see update_variable_set()
 * @see update_variable_del()
 * @ingroup config_upgrade
 */
function update_variable_get($name, $default = NULL) {
  $result = db_query('SELECT value FROM {variable} WHERE name = :name', array(':name' => $name))->fetchField();
  if ($result !== FALSE) {
    return unserialize($result);
  }
  return $default;
}

/**
 * Sets a persistent variable during the 7.x-8.x upgrade path.
 *
 * Use this during the 7.x-8.x upgrade path instead of variable_set().
 *
 * @param string $name
 *   The name of the variable to set.
 * @param mixed $value
 *   The value to set. This can be any PHP data type; these functions take care
 *   of serialization as necessary.
 *
 * @see update_variable_get()
 * @see update_variable_del()
 * @ingroup config_upgrade
 */
function update_variable_set($name, $value) {
  db_merge('variable')
    ->key(array(
      'name' => $name,
    ))
    ->fields(array(
      'value' => serialize($value),
    ))
    ->execute();
}

/**
 * Delete a variable from the database during the 7.x-8.x upgrade path.
 *
 * Use this during the 7.x-8.x upgrade path instead of variable_del().
 *
 * @param string $name
 *   The name of the variable to delete.
 *
 * @see update_variable_get()
 * @see update_variable_set()
 * @ingroup config_upgrade
 */
function update_variable_del($name) {
  db_delete('variable')
    ->condition('name', $name)
    ->execute();
}

1395
/**
1396
 * Updates config with values set on Drupal 7.x.
1397
 *