ConfigInstaller.php 25.7 KB
Newer Older
1 2 3 4
<?php

namespace Drupal\Core\Config;

5
use Drupal\Component\Utility\Crypt;
6
use Drupal\Component\Utility\Unicode;
7
use Drupal\Core\Config\Entity\ConfigDependencyManager;
8
use Drupal\Core\Config\Entity\ConfigEntityDependency;
9
use Drupal\Core\Site\Settings;
10 11 12 13 14 15 16
use Symfony\Component\EventDispatcher\EventDispatcherInterface;

class ConfigInstaller implements ConfigInstallerInterface {

  /**
   * The configuration factory.
   *
17
   * @var \Drupal\Core\Config\ConfigFactoryInterface
18 19 20 21
   */
  protected $configFactory;

  /**
22
   * The active configuration storages, keyed by collection.
23
   *
24
   * @var \Drupal\Core\Config\StorageInterface[]
25
   */
26
  protected $activeStorages;
27 28 29 30 31 32 33 34 35

  /**
   * The typed configuration manager.
   *
   * @var \Drupal\Core\Config\TypedConfigManagerInterface
   */
  protected $typedConfig;

  /**
36
   * The configuration manager.
37
   *
38
   * @var \Drupal\Core\Config\ConfigManagerInterface
39
   */
40
  protected $configManager;
41 42 43 44 45 46 47 48

  /**
   * The event dispatcher.
   *
   * @var \Symfony\Component\EventDispatcher\EventDispatcherInterface
   */
  protected $eventDispatcher;

49 50 51 52 53 54 55 56 57 58 59 60 61 62
  /**
   * The configuration storage that provides the default configuration.
   *
   * @var \Drupal\Core\Config\StorageInterface
   */
  protected $sourceStorage;

  /**
   * Is configuration being created as part of a configuration sync.
   *
   * @var bool
   */
  protected $isSyncing = FALSE;

63 64 65
  /**
   * Constructs the configuration installer.
   *
66
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
67 68 69 70 71
   *   The configuration factory.
   * @param \Drupal\Core\Config\StorageInterface $active_storage
   *   The active configuration storage.
   * @param \Drupal\Core\Config\TypedConfigManagerInterface $typed_config
   *   The typed configuration manager.
72 73
   * @param \Drupal\Core\Config\ConfigManagerInterface $config_manager
   *   The configuration manager.
74 75 76
   * @param \Symfony\Component\EventDispatcher\EventDispatcherInterface $event_dispatcher
   *   The event dispatcher.
   */
77
  public function __construct(ConfigFactoryInterface $config_factory, StorageInterface $active_storage, TypedConfigManagerInterface $typed_config, ConfigManagerInterface $config_manager, EventDispatcherInterface $event_dispatcher) {
78
    $this->configFactory = $config_factory;
79
    $this->activeStorages[$active_storage->getCollectionName()] = $active_storage;
80
    $this->typedConfig = $typed_config;
81
    $this->configManager = $config_manager;
82 83 84 85 86 87 88
    $this->eventDispatcher = $event_dispatcher;
  }

  /**
   * {@inheritdoc}
   */
  public function installDefaultConfig($type, $name) {
89
    $extension_path = $this->drupalGetPath($type, $name);
90 91 92
    // Refresh the schema cache if the extension provides configuration schema
    // or is a theme.
    if (is_dir($extension_path . '/' . InstallStorage::CONFIG_SCHEMA_DIRECTORY) || $type == 'theme') {
93 94 95
      $this->typedConfig->clearCachedDefinitions();
    }

96 97 98 99 100 101 102 103 104 105 106 107 108 109
    $default_install_path = $this->getDefaultConfigDirectory($type, $name);
    if (is_dir($default_install_path)) {
      if (!$this->isSyncing()) {
        $storage = new FileStorage($default_install_path, StorageInterface::DEFAULT_COLLECTION);
        $prefix = '';
      }
      else {
        // The configuration importer sets the source storage on the config
        // installer. The configuration importer handles all of the
        // configuration entity imports. We only need to ensure that simple
        // configuration is created when the extension is installed.
        $storage = $this->getSourceStorage();
        $prefix = $name . '.';
      }
110

111 112
      // Gets profile storages to search for overrides if necessary.
      $profile_storages = $this->getProfileStorages($name);
113 114 115 116

      // Gather information about all the supported collections.
      $collection_info = $this->configManager->getConfigCollectionInfo();
      foreach ($collection_info->getCollectionNames() as $collection) {
117
        $config_to_create = $this->getConfigToCreate($storage, $collection, $prefix, $profile_storages);
118 119 120 121 122 123 124 125 126
        // If we're installing a profile ensure configuration that is overriding
        // is excluded.
        if ($name == $this->drupalGetProfile()) {
          $existing_configuration = $this->getActiveStorages($collection)->listAll();
          $config_to_create = array_diff_key($config_to_create, array_flip($existing_configuration));
        }
        if (!empty($config_to_create)) {
          $this->createConfiguration($collection, $config_to_create);
        }
127 128 129
      }
    }

130 131 132 133 134 135 136 137 138 139
    // During a drupal installation optional configuration is installed at the
    // end of the installation process.
    // @see install_install_profile()
    if (!$this->isSyncing() && !$this->drupalInstallationAttempted()) {
      $optional_install_path = $extension_path . '/' . InstallStorage::CONFIG_OPTIONAL_DIRECTORY;
      if (is_dir($optional_install_path)) {
        // Install any optional config the module provides.
        $storage = new FileStorage($optional_install_path, StorageInterface::DEFAULT_COLLECTION);
        $this->installOptionalConfig($storage, '');
      }
140 141
      // Install any optional configuration entities whose dependencies can now
      // be met. This searches all the installed modules config/optional
142
      // directories.
143 144
      $storage = new ExtensionInstallStorage($this->getActiveStorages(StorageInterface::DEFAULT_COLLECTION), InstallStorage::CONFIG_OPTIONAL_DIRECTORY, StorageInterface::DEFAULT_COLLECTION, FALSE);
      $this->installOptionalConfig($storage, [$type => $name]);
145
    }
146

147 148 149 150 151
    // Reset all the static caches and list caches.
    $this->configFactory->reset();
  }

  /**
152 153
   * {@inheritdoc}
   */
154
  public function installOptionalConfig(StorageInterface $storage = NULL, $dependency = []) {
155
    $profile = $this->drupalGetProfile();
156
    $optional_profile_config = [];
157 158 159 160 161 162
    if (!$storage) {
      // Search the install profile's optional configuration too.
      $storage = new ExtensionInstallStorage($this->getActiveStorages(StorageInterface::DEFAULT_COLLECTION), InstallStorage::CONFIG_OPTIONAL_DIRECTORY, StorageInterface::DEFAULT_COLLECTION, TRUE);
      // The extension install storage ensures that overrides are used.
      $profile_storage = NULL;
    }
163
    elseif (isset($profile)) {
164
      // Creates a profile storage to search for overrides.
165
      $profile_install_path = $this->drupalGetPath('module', $profile) . '/' . InstallStorage::CONFIG_OPTIONAL_DIRECTORY;
166
      $profile_storage = new FileStorage($profile_install_path, StorageInterface::DEFAULT_COLLECTION);
167
      $optional_profile_config = $profile_storage->listAll();
168
    }
169 170 171 172 173
    else {
      // Profile has not been set yet. For example during the first steps of the
      // installer or during unit tests.
      $profile_storage = NULL;
    }
174 175

    $enabled_extensions = $this->getEnabledExtensions();
176
    $existing_config = $this->getActiveStorages()->listAll();
177

178 179
    $list = array_unique(array_merge($storage->listAll(), $optional_profile_config));
    $list = array_filter($list, function($config_name) use ($existing_config) {
180 181 182 183 184 185
      // Only list configuration that:
      // - does not already exist
      // - is a configuration entity (this also excludes config that has an
      //   implicit dependency on modules that are not yet installed)
      return !in_array($config_name, $existing_config) && $this->configManager->getEntityTypeIdByName($config_name);
    });
186

187
    $all_config = array_merge($existing_config, $list);
188
    $all_config = array_combine($all_config, $all_config);
189
    $config_to_create = $storage->readMultiple($list);
190 191
    // Check to see if the corresponding override storage has any overrides or
    // new configuration that can be installed.
192 193 194
    if ($profile_storage) {
      $config_to_create = $profile_storage->readMultiple($list) + $config_to_create;
    }
195 196 197 198 199
    // Sort $config_to_create in the order of the least dependent first.
    $dependency_manager = new ConfigDependencyManager();
    $dependency_manager->setData($config_to_create);
    $config_to_create = array_merge(array_flip($dependency_manager->sortAll()), $config_to_create);

200
    foreach ($config_to_create as $config_name => $data) {
201 202 203 204 205
      // Remove configuration where its dependencies cannot be met.
      $remove = !$this->validateDependencies($config_name, $data, $enabled_extensions, $all_config);
      // If $dependency is defined, remove configuration that does not have a
      // matching dependency.
      if (!$remove && !empty($dependency)) {
206 207
        // Create a light weight dependency object to check dependencies.
        $config_entity = new ConfigEntityDependency($config_name, $data);
208 209 210 211 212 213 214 215 216
        $remove = !$config_entity->hasDependency(key($dependency), reset($dependency));
      }

      if ($remove) {
        // Remove from the list of configuration to create.
        unset($config_to_create[$config_name]);
        // Remove from the list of all configuration. This ensures that any
        // configuration that depends on this configuration is also removed.
        unset($all_config[$config_name]);
217 218
      }
    }
219 220 221
    if (!empty($config_to_create)) {
      $this->createConfiguration(StorageInterface::DEFAULT_COLLECTION, $config_to_create, TRUE);
    }
222 223 224 225
  }

  /**
   * Gets configuration data from the provided storage to create.
226
   *
227 228
   * @param StorageInterface $storage
   *   The configuration storage to read configuration from.
229
   * @param string $collection
230
   *   The configuration collection to use.
231 232
   * @param string $prefix
   *   (optional) Limit to configuration starting with the provided string.
233 234 235
   * @param \Drupal\Core\Config\StorageInterface[] $profile_storages
   *   An array of storage interfaces containing profile configuration to check
   *   for overrides.
236 237
   *
   * @return array
238 239
   *   An array of configuration data read from the source storage keyed by the
   *   configuration object name.
240
   */
241
  protected function getConfigToCreate(StorageInterface $storage, $collection, $prefix = '', array $profile_storages = []) {
242 243
    if ($storage->getCollectionName() != $collection) {
      $storage = $storage->createCollection($collection);
244
    }
245
    $data = $storage->readMultiple($storage->listAll($prefix));
246

247
    // Check to see if the corresponding override storage has any overrides.
248
    foreach ($profile_storages as $profile_storage) {
249 250 251 252 253 254
      if ($profile_storage->getCollectionName() != $collection) {
        $profile_storage = $profile_storage->createCollection($collection);
      }
      $data = $profile_storage->readMultiple(array_keys($data)) + $data;
    }
    return $data;
255 256 257 258 259 260 261
  }

  /**
   * Creates configuration in a collection based on the provided list.
   *
   * @param string $collection
   *   The configuration collection.
262 263
   * @param array $config_to_create
   *   An array of configuration data to create, keyed by name.
264
   */
265
  protected function createConfiguration($collection, array $config_to_create) {
266
    // Order the configuration to install in the order of dependencies.
267
    if ($collection == StorageInterface::DEFAULT_COLLECTION) {
268
      $dependency_manager = new ConfigDependencyManager();
269 270
      $config_names = $dependency_manager
        ->setData($config_to_create)
271
        ->sortAll();
272
    }
273 274 275
    else {
      $config_names = array_keys($config_to_create);
    }
276

277
    foreach ($config_names as $name) {
278 279 280 281 282 283 284
      // Allow config factory overriders to use a custom configuration object if
      // they are responsible for the collection.
      $overrider = $this->configManager->getConfigCollectionInfo()->getOverrideService($collection);
      if ($overrider) {
        $new_config = $overrider->createConfigObject($name, $collection);
      }
      else {
285
        $new_config = new Config($name, $this->getActiveStorages($collection), $this->eventDispatcher, $this->typedConfig);
286
      }
287 288
      if ($config_to_create[$name] !== FALSE) {
        $new_config->setData($config_to_create[$name]);
289 290 291 292 293 294
        // Add a hash to configuration created through the installer so it is
        // possible to know if the configuration was created by installing an
        // extension and to track which version of the default config was used.
        if (!$this->isSyncing() && $collection == StorageInterface::DEFAULT_COLLECTION) {
          $new_config->set('_core.default_config_hash', Crypt::hashBase64(serialize($config_to_create[$name])));
        }
295
      }
296
      if ($collection == StorageInterface::DEFAULT_COLLECTION && $entity_type = $this->configManager->getEntityTypeIdByName($name)) {
297 298 299 300 301 302
        // If we are syncing do not create configuration entities. Pluggable
        // configuration entities can have dependencies on modules that are
        // not yet enabled. This approach means that any code that expects
        // default configuration entities to exist will be unstable after the
        // module has been enabled and before the config entity has been
        // imported.
303
        if ($this->isSyncing()) {
304
          continue;
305
        }
306
        /** @var \Drupal\Core\Config\Entity\ConfigEntityStorageInterface $entity_storage */
307 308 309 310 311
        $entity_storage = $this->configManager
          ->getEntityManager()
          ->getStorage($entity_type);
        // It is possible that secondary writes can occur during configuration
        // creation. Updates of such configuration are allowed.
312
        if ($this->getActiveStorages($collection)->exists($name)) {
313 314
          $id = $entity_storage->getIDFromConfigName($name, $entity_storage->getEntityType()->getConfigPrefix());
          $entity = $entity_storage->load($id);
315
          $entity = $entity_storage->updateFromStorageRecord($entity, $new_config->get());
316 317
        }
        else {
318
          $entity = $entity_storage->createFromStorageRecord($new_config->get());
319
        }
320
        if ($entity->isInstallable()) {
321
          $entity->trustData()->save();
322
        }
323
      }
324
      else {
325
        $new_config->save(TRUE);
326 327 328 329 330 331 332 333
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function installCollectionDefaultConfig($collection) {
334 335 336 337
    $storage = new ExtensionInstallStorage($this->getActiveStorages(StorageInterface::DEFAULT_COLLECTION), InstallStorage::CONFIG_INSTALL_DIRECTORY, $collection, $this->drupalInstallationAttempted());
    // Only install configuration for enabled extensions.
    $enabled_extensions = $this->getEnabledExtensions();
    $config_to_install = array_filter($storage->listAll(), function ($config_name) use ($enabled_extensions) {
338 339 340 341
      $provider = Unicode::substr($config_name, 0, strpos($config_name, '.'));
      return in_array($provider, $enabled_extensions);
    });
    if (!empty($config_to_install)) {
342
      $this->createConfiguration($collection, $storage->readMultiple($config_to_install));
343 344
      // Reset all the static caches and list caches.
      $this->configFactory->reset();
345 346 347
    }
  }

348 349 350 351 352 353 354 355 356 357 358
  /**
   * {@inheritdoc}
   */
  public function setSourceStorage(StorageInterface $storage) {
    $this->sourceStorage = $storage;
    return $this;
  }

  /**
   * Gets the configuration storage that provides the default configuration.
   *
359
   * @return \Drupal\Core\Config\StorageInterface|null
360
   *   The configuration storage that provides the default configuration.
361
   *   Returns null if the source storage has not been set.
362
   */
363
  public function getSourceStorage() {
364 365 366
    return $this->sourceStorage;
  }

367 368 369 370 371 372 373 374 375 376
  /**
   * Gets the configuration storage that provides the active configuration.
   *
   * @param string $collection
   *   (optional) The configuration collection. Defaults to the default
   *   collection.
   *
   * @return \Drupal\Core\Config\StorageInterface
   *   The configuration storage that provides the default configuration.
   */
377 378 379
  protected function getActiveStorages($collection = StorageInterface::DEFAULT_COLLECTION) {
    if (!isset($this->activeStorages[$collection])) {
      $this->activeStorages[$collection] = reset($this->activeStorages)->createCollection($collection);
380
    }
381
    return $this->activeStorages[$collection];
382 383
  }

384 385 386 387
  /**
   * {@inheritdoc}
   */
  public function setSyncing($status) {
388 389 390
    if (!$status) {
      $this->sourceStorage = NULL;
    }
391 392 393 394 395 396 397 398 399 400
    $this->isSyncing = $status;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function isSyncing() {
    return $this->isSyncing;
  }
401 402

  /**
403 404 405 406 407 408 409 410 411 412 413 414 415 416
   * Finds pre-existing configuration objects for the provided extension.
   *
   * Extensions can not be installed if configuration objects exist in the
   * active storage with the same names. This can happen in a number of ways,
   * commonly:
   * - if a user has created configuration with the same name as that provided
   *   by the extension.
   * - if the extension provides default configuration that does not depend on
   *   it and the extension has been uninstalled and is about to the
   *   reinstalled.
   *
   * @return array
   *   Array of configuration object names that already exist keyed by
   *   collection.
417
   */
418
  protected function findPreExistingConfiguration(StorageInterface $storage) {
419 420 421 422
    $existing_configuration = array();
    // Gather information about all the supported collections.
    $collection_info = $this->configManager->getConfigCollectionInfo();

423 424
    foreach ($collection_info->getCollectionNames() as $collection) {
      $config_to_create = array_keys($this->getConfigToCreate($storage, $collection));
425
      $active_storage = $this->getActiveStorages($collection);
426
      foreach ($config_to_create as $config_name) {
427 428 429 430 431 432 433
        if ($active_storage->exists($config_name)) {
          $existing_configuration[$collection][] = $config_name;
        }
      }
    }
    return $existing_configuration;
  }
434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453

  /**
   * {@inheritdoc}
   */
  public function checkConfigurationToInstall($type, $name) {
    if ($this->isSyncing()) {
      // Configuration is assumed to already be checked by the config importer
      // validation events.
      return;
    }
    $config_install_path = $this->getDefaultConfigDirectory($type, $name);
    if (!is_dir($config_install_path)) {
      return;
    }

    $storage = new FileStorage($config_install_path, StorageInterface::DEFAULT_COLLECTION);

    $enabled_extensions = $this->getEnabledExtensions();
    // Add the extension that will be enabled to the list of enabled extensions.
    $enabled_extensions[] = $name;
454 455
    // Gets profile storages to search for overrides if necessary.
    $profile_storages = $this->getProfileStorages($name);
456 457

    // Check the dependencies of configuration provided by the module.
458
    $invalid_default_config = $this->findDefaultConfigWithUnmetDependencies($storage, $enabled_extensions, $profile_storages);
459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478
    if (!empty($invalid_default_config)) {
      throw UnmetDependenciesException::create($name, $invalid_default_config);
    }

    // Install profiles can not have config clashes. Configuration that
    // has the same name as a module's configuration will be used instead.
    if ($name != $this->drupalGetProfile()) {
      // Throw an exception if the module being installed contains configuration
      // that already exists. Additionally, can not continue installing more
      // modules because those may depend on the current module being installed.
      $existing_configuration = $this->findPreExistingConfiguration($storage);
      if (!empty($existing_configuration)) {
        throw PreExistingConfigException::create($name, $existing_configuration);
      }
    }
  }

  /**
   * Finds default configuration with unmet dependencies.
   *
479 480
   * @param \Drupal\Core\Config\StorageInterface $storage
   *   The storage containing the default configuration.
481 482
   * @param array $enabled_extensions
   *   A list of all the currently enabled modules and themes.
483 484 485
   * @param \Drupal\Core\Config\StorageInterface[] $profile_storages
   *   An array of storage interfaces containing profile configuration to check
   *   for overrides.
486 487 488 489
   *
   * @return array
   *   List of configuration that has unmet dependencies
   */
490 491
  protected function findDefaultConfigWithUnmetDependencies(StorageInterface $storage, array $enabled_extensions, array $profile_storages = []) {
    $config_to_create = $this->getConfigToCreate($storage, StorageInterface::DEFAULT_COLLECTION, '', $profile_storages);
492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513
    $all_config = array_merge($this->configFactory->listAll(), array_keys($config_to_create));
    return array_filter(array_keys($config_to_create), function($config_name) use ($enabled_extensions, $all_config, $config_to_create) {
      return !$this->validateDependencies($config_name, $config_to_create[$config_name], $enabled_extensions, $all_config);
    });
  }

  /**
   * Validates an array of config data that contains dependency information.
   *
   * @param string $config_name
   *   The name of the configuration object that is being validated.
   * @param array $data
   *   Configuration data.
   * @param array $enabled_extensions
   *   A list of all the currently enabled modules and themes.
   * @param array $all_config
   *   A list of all the active configuration names.
   *
   * @return bool
   *   TRUE if the dependencies are met, FALSE if not.
   */
  protected function validateDependencies($config_name, array $data, array $enabled_extensions, array $all_config) {
514
    list($provider) = explode('.', $config_name, 2);
515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550
    if (isset($data['dependencies'])) {
      $all_dependencies = $data['dependencies'];

      // Ensure enforced dependencies are included.
      if (isset($all_dependencies['enforced'])) {
        $all_dependencies = array_merge($all_dependencies, $data['dependencies']['enforced']);
        unset($all_dependencies['enforced']);
      }
      // Ensure the configuration entity type provider is in the list of
      // dependencies.
      if (!isset($all_dependencies['module'])) {
        $all_dependencies['module'][] = $provider;
      }
      elseif (!in_array($provider, $all_dependencies['module'])) {
        $all_dependencies['module'][] = $provider;
      }

      foreach ($all_dependencies as $type => $dependencies) {
        $list_to_check = [];
        switch ($type) {
          case 'module':
          case 'theme':
            $list_to_check = $enabled_extensions;
            break;
          case 'config':
            $list_to_check = $all_config;
            break;
        }
        if (!empty($list_to_check)) {
          $missing = array_diff($dependencies, $list_to_check);
          if (!empty($missing)) {
            return FALSE;
          }
        }
      }
    }
551 552 553 554
    else {
      // Simple config or a config entity without dependencies.
      return in_array($provider, $enabled_extensions, TRUE);
    }
555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577
    return TRUE;
  }

  /**
   * Gets the list of enabled extensions including both modules and themes.
   *
   * @return array
   *   A list of enabled extensions which includes both modules and themes.
   */
  protected function getEnabledExtensions() {
    // Read enabled extensions directly from configuration to avoid circular
    // dependencies on ModuleHandler and ThemeHandler.
    $extension_config = $this->configFactory->get('core.extension');
    $enabled_extensions = (array) $extension_config->get('module');
    $enabled_extensions += (array) $extension_config->get('theme');
    // Core can provide configuration.
    $enabled_extensions['core'] = 'core';
    return array_keys($enabled_extensions);
  }

  /**
   * Gets the profile storage to use to check for profile overrides.
   *
578 579 580 581 582
   * The install profile can override module configuration during a module
   * install. Both the install and optional directories are checked for matching
   * configuration. This allows profiles to override default configuration for
   * modules they do not depend on.
   *
583 584 585
   * @param string $installing_name
   *   (optional) The name of the extension currently being installed.
   *
586 587 588 589
   * @return \Drupal\Core\Config\StorageInterface[]|null
   *   Storages to access configuration from the installation profile. If we're
   *   installing the profile itself, then it will return an empty array as the
   *   profile storage should not be used.
590
   */
591
  protected function getProfileStorages($installing_name = '') {
592
    $profile = $this->drupalGetProfile();
593 594 595 596 597 598 599 600
    $profile_storages = [];
    if ($profile && $profile != $installing_name) {
      $profile_path = $this->drupalGetPath('module', $profile);
      foreach ([InstallStorage::CONFIG_INSTALL_DIRECTORY, InstallStorage::CONFIG_OPTIONAL_DIRECTORY] as $directory) {
        if (is_dir($profile_path . '/' . $directory)) {
          $profile_storages[] = new FileStorage($profile_path . '/' . $directory, StorageInterface::DEFAULT_COLLECTION);
        }
      }
601
    }
602
    return $profile_storages;
603 604 605 606 607 608 609 610 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
  }

  /**
   * Gets an extension's default configuration directory.
   *
   * @param string $type
   *   Type of extension to install.
   * @param string $name
   *   Name of extension to install.
   *
   * @return string
   *   The extension's default configuration directory.
   */
  protected function getDefaultConfigDirectory($type, $name) {
    return $this->drupalGetPath($type, $name) . '/' . InstallStorage::CONFIG_INSTALL_DIRECTORY;
  }

  /**
   * Wrapper for drupal_get_path().
   *
   * @param $type
   *   The type of the item; one of 'core', 'profile', 'module', 'theme', or
   *   'theme_engine'.
   * @param $name
   *   The name of the item for which the path is requested. Ignored for
   *   $type 'core'.
   *
   * @return string
   *   The path to the requested item or an empty string if the item is not
   *   found.
   */
  protected function drupalGetPath($type, $name) {
    return drupal_get_path($type, $name);
  }

  /**
   * Gets the install profile from settings.
   *
   * @return string|null $profile
   *   The name of the installation profile or NULL if no installation profile
   *   is currently active. This is the case for example during the first steps
   *   of the installer or during unit tests.
   */
  protected function drupalGetProfile() {
    // Settings is safe to use because settings.php is written before any module
    // is installed.
    return Settings::get('install_profile');
  }

  /**
   * Wrapper for drupal_installation_attempted().
   *
   * @return bool
   *   TRUE if a Drupal installation is currently being attempted.
   */
  protected function drupalInstallationAttempted() {
    return drupal_installation_attempted();
  }

662
}