ModuleHandler.php 38.7 KB
Newer Older
1 2 3 4 5 6 7 8 9 10
<?php

/**
 * @file
 * Contains Drupal\Core\Extension\ModuleHandler.
 */

namespace Drupal\Core\Extension;

use Drupal\Component\Graph\Graph;
11
use Drupal\Component\Serialization\Yaml;
12
use Drupal\Component\Utility\NestedArray;
13
use Drupal\Component\Utility\String;
14
use Drupal\Core\Cache\CacheBackendInterface;
15
use Symfony\Component\DependencyInjection\ContainerInterface;
16 17

/**
18
 * Class that manages modules in a Drupal installation.
19 20 21 22 23 24 25 26 27 28 29 30 31
 */
class ModuleHandler implements ModuleHandlerInterface {

  /**
   * List of loaded files.
   *
   * @var array
   *   An associative array whose keys are file paths of loaded files, relative
   *   to the application's root directory.
   */
  protected $loadedFiles;

  /**
32
   * List of installed modules.
33
   *
34
   * @var \Drupal\Core\Extension\Extension[]
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51
   */
  protected $moduleList;

  /**
   * Boolean indicating whether modules have been loaded.
   *
   * @var bool
   */
  protected $loaded = FALSE;

  /**
   * List of hook implementations keyed by hook name.
   *
   * @var array
   */
  protected $implementations;

52 53 54 55 56 57 58 59
  /**
   * List of hooks where the implementations have been "verified".
   *
   * @var true[]
   *   Associative array where keys are hook names.
   */
  protected $verified;

60 61 62 63 64 65 66
  /**
   * Information returned by hook_hook_info() implementations.
   *
   * @var array
   */
  protected $hookInfo;

67 68 69 70 71 72 73 74 75 76 77 78 79 80
  /**
   * Cache backend for storing module hook implementation information.
   *
   * @var \Drupal\Core\Cache\CacheBackendInterface
   */
  protected $cacheBackend;

  /**
   * Whether the cache needs to be written.
   *
   * @var bool
   */
  protected $cacheNeedsWriting = FALSE;

81 82 83 84 85 86 87 88 89 90 91
  /**
   * List of alter hook implementations keyed by hook name(s).
   *
   * @var array
   */
  protected $alterFunctions;

  /**
   * Constructs a ModuleHandler object.
   *
   * @param array $module_list
92
   *   An associative array whose keys are the names of installed modules and
93
   *   whose values are Extension class parameters. This is normally the
94
   *   %container.modules% parameter being set up by DrupalKernel.
95 96
   * @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
   *   Cache backend for storing module hook implementation information.
97 98
   *
   * @see \Drupal\Core\DrupalKernel
99
   * @see \Drupal\Core\CoreServiceProvider
100
   */
101
  public function __construct(array $module_list = array(), CacheBackendInterface $cache_backend) {
102 103 104 105
    $this->moduleList = array();
    foreach ($module_list as $name => $module) {
      $this->moduleList[$name] = new Extension($module['type'], $module['pathname'], $module['filename']);
    }
106
    $this->cacheBackend = $cache_backend;
107 108 109
  }

  /**
110
   * {@inheritdoc}
111 112 113 114 115 116 117
   */
  public function load($name) {
    if (isset($this->loadedFiles[$name])) {
      return TRUE;
    }

    if (isset($this->moduleList[$name])) {
118
      $this->moduleList[$name]->load();
119 120 121 122 123 124 125
      $this->loadedFiles[$name] = TRUE;
      return TRUE;
    }
    return FALSE;
  }

  /**
126
   * {@inheritdoc}
127 128 129
   */
  public function loadAll() {
    if (!$this->loaded) {
130 131
      foreach ($this->moduleList as $name => $module) {
        $this->load($name);
132 133 134 135 136 137
      }
      $this->loaded = TRUE;
    }
  }

  /**
138
   * {@inheritdoc}
139 140 141 142 143 144 145
   */
  public function reload() {
    $this->loaded = FALSE;
    $this->loadAll();
  }

  /**
146
   * {@inheritdoc}
147 148 149 150 151 152
   */
  public function isLoaded() {
    return $this->loaded;
  }

  /**
153
   * {@inheritdoc}
154 155 156 157 158
   */
  public function getModuleList() {
    return $this->moduleList;
  }

159 160 161 162 163 164 165 166 167 168
  /**
   * {@inheritdoc}
   */
  public function getModule($name) {
    if (isset($this->moduleList[$name])) {
      return $this->moduleList[$name];
    }
    throw new \InvalidArgumentException(sprintf('The module %s does not exist.', $name));
  }

169
  /**
170
   * {@inheritdoc}
171 172 173
   */
  public function setModuleList(array $module_list = array()) {
    $this->moduleList = $module_list;
174 175 176
    // Reset the implementations, so a new call triggers a reloading of the
    // available hooks.
    $this->resetImplementations();
177 178
  }

179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
  /**
   * {@inheritdoc}
   */
  public function addModule($name, $path) {
    $this->add('module', $name, $path);
  }

  /**
   * {@inheritdoc}
   */
  public function addProfile($name, $path) {
    $this->add('profile', $name, $path);
  }

  /**
   * Adds a module or profile to the list of currently active modules.
   *
   * @param string $type
   *   The extension type; either 'module' or 'profile'.
   * @param string $name
   *   The module name; e.g., 'node'.
   * @param string $path
   *   The module path; e.g., 'core/modules/node'.
   */
  protected function add($type, $name, $path) {
    $pathname = "$path/$name.info.yml";
205
    $filename = file_exists(DRUPAL_ROOT . "/$path/$name.$type") ? "$name.$type" : NULL;
206 207 208 209
    $this->moduleList[$name] = new Extension($type, $pathname, $filename);
    $this->resetImplementations();
  }

210
  /**
211
   * {@inheritdoc}
212 213
   */
  public function buildModuleDependencies(array $modules) {
214
    foreach ($modules as $module) {
215
      $graph[$module->getName()]['edges'] = array();
216 217
      if (isset($module->info['dependencies']) && is_array($module->info['dependencies'])) {
        foreach ($module->info['dependencies'] as $dependency) {
218
          $dependency_data = static::parseDependency($dependency);
219
          $graph[$module->getName()]['edges'][$dependency_data['name']] = $dependency_data;
220 221 222 223 224 225 226 227 228 229 230 231 232 233
        }
      }
    }
    $graph_object = new Graph($graph);
    $graph = $graph_object->searchAndSort();
    foreach ($graph as $module_name => $data) {
      $modules[$module_name]->required_by = isset($data['reverse_paths']) ? $data['reverse_paths'] : array();
      $modules[$module_name]->requires = isset($data['paths']) ? $data['paths'] : array();
      $modules[$module_name]->sort = $data['weight'];
    }
    return $modules;
  }

  /**
234
   * {@inheritdoc}
235 236 237 238 239 240
   */
  public function moduleExists($module) {
    return isset($this->moduleList[$module]);
  }

  /**
241
   * {@inheritdoc}
242 243 244 245 246 247 248 249
   */
  public function loadAllIncludes($type, $name = NULL) {
    foreach ($this->moduleList as $module => $filename) {
      $this->loadInclude($module, $type, $name);
    }
  }

  /**
250
   * {@inheritdoc}
251 252 253 254 255 256 257 258
   */
  public function loadInclude($module, $type, $name = NULL) {
    if ($type == 'install') {
      // Make sure the installation API is available
      include_once DRUPAL_ROOT . '/core/includes/install.inc';
    }

    $name = $name ?: $module;
259
    if (isset($this->moduleList[$module])) {
260
      $file = DRUPAL_ROOT . '/' . $this->moduleList[$module]->getPath() . "/$name.$type";
261 262 263 264
      if (is_file($file)) {
        require_once $file;
        return $file;
      }
265 266 267 268 269
    }

    return FALSE;
  }

270
  /**
271
   * {@inheritdoc}
272 273
   */
  public function getHookInfo() {
274 275 276 277 278 279 280 281
    if (!isset($this->hookInfo)) {
      if ($cache = $this->cacheBackend->get('hook_info')) {
        $this->hookInfo = $cache->data;
      }
      else {
        $this->buildHookInfo();
        $this->cacheBackend->set('hook_info', $this->hookInfo);
      }
282
    }
283 284 285 286 287 288 289 290 291
    return $this->hookInfo;
  }

  /**
   * Builds hook_hook_info() information.
   *
   * @see \Drupal\Core\Extension\ModuleHandler::getHookInfo()
   */
  protected function buildHookInfo() {
292
    $this->hookInfo = array();
293 294
    // Make sure that the modules are loaded before checking.
    $this->reload();
295
    // $this->invokeAll() would cause an infinite recursion.
296 297 298 299 300 301 302 303 304 305 306
    foreach ($this->moduleList as $module => $filename) {
      $function = $module . '_hook_info';
      if (function_exists($function)) {
        $result = $function();
        if (isset($result) && is_array($result)) {
          $this->hookInfo = NestedArray::mergeDeep($this->hookInfo, $result);
        }
      }
    }
  }

307
  /**
308
   * {@inheritdoc}
309 310 311 312 313 314 315
   */
  public function getImplementations($hook) {
    $implementations = $this->getImplementationInfo($hook);
    return array_keys($implementations);
  }

  /**
316 317 318 319 320 321 322 323 324 325 326
   * {@inheritdoc}
   */
  public function writeCache() {
    if ($this->cacheNeedsWriting) {
      $this->cacheBackend->set('module_implements', $this->implementations);
      $this->cacheNeedsWriting = FALSE;
    }
  }

  /**
   * {@inheritdoc}
327 328 329 330 331
   */
  public function resetImplementations() {
    $this->implementations = NULL;
    $this->hookInfo = NULL;
    $this->alterFunctions = NULL;
332 333 334 335 336 337 338 339 340 341 342 343 344
    // We maintain a persistent cache of hook implementations in addition to the
    // static cache to avoid looping through every module and every hook on each
    // request. Benchmarks show that the benefit of this caching outweighs the
    // additional database hit even when using the default database caching
    // backend and only a small number of modules are enabled. The cost of the
    // $this->cacheBackend->get() is more or less constant and reduced further
    // when non-database caching backends are used, so there will be more
    // significant gains when a large number of modules are installed or hooks
    // invoked, since this can quickly lead to
    // \Drupal::moduleHandler()->implementsHook() being called several thousand
    // times per request.
    $this->cacheBackend->set('module_implements', array());
    $this->cacheBackend->delete('hook_info');
345 346 347
  }

  /**
348
   * {@inheritdoc}
349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366
   */
  public function implementsHook($module, $hook) {
    $function = $module . '_' . $hook;
    if (function_exists($function)) {
      return TRUE;
    }
    // If the hook implementation does not exist, check whether it lives in an
    // optional include file registered via hook_hook_info().
    $hook_info = $this->getHookInfo();
    if (isset($hook_info[$hook]['group'])) {
      $this->loadInclude($module, 'inc', $module . '.' . $hook_info[$hook]['group']);
      if (function_exists($function)) {
        return TRUE;
      }
    }
    return FALSE;
  }

367
  /**
368
   * {@inheritdoc}
369
   */
370
  public function invoke($module, $hook, array $args = array()) {
371 372 373 374 375 376 377
    if (!$this->implementsHook($module, $hook)) {
      return;
    }
    $function = $module . '_' . $hook;
    return call_user_func_array($function, $args);
  }

378
  /**
379
   * {@inheritdoc}
380
   */
381
  public function invokeAll($hook, array $args = array()) {
382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400
    $return = array();
    $implementations = $this->getImplementations($hook);
    foreach ($implementations as $module) {
      $function = $module . '_' . $hook;
      if (function_exists($function)) {
        $result = call_user_func_array($function, $args);
        if (isset($result) && is_array($result)) {
          $return = NestedArray::mergeDeep($return, $result);
        }
        elseif (isset($result)) {
          $return[] = $result;
        }
      }
    }

    return $return;
  }

  /**
401
   * {@inheritdoc}
402 403 404 405 406 407 408 409 410 411 412
   */
  public function alter($type, &$data, &$context1 = NULL, &$context2 = NULL) {
    // Most of the time, $type is passed as a string, so for performance,
    // normalize it to that. When passed as an array, usually the first item in
    // the array is a generic type, and additional items in the array are more
    // specific variants of it, as in the case of array('form', 'form_FORM_ID').
    if (is_array($type)) {
      $cid = implode(',', $type);
      $extra_types = $type;
      $type = array_shift($extra_types);
      // Allow if statements in this function to use the faster isset() rather
413 414
      // than !empty() both when $type is passed as a string, or as an array
      // with one item.
415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431
      if (empty($extra_types)) {
        unset($extra_types);
      }
    }
    else {
      $cid = $type;
    }

    // Some alter hooks are invoked many times per page request, so store the
    // list of functions to call, and on subsequent calls, iterate through them
    // quickly.
    if (!isset($this->alterFunctions[$cid])) {
      $this->alterFunctions[$cid] = array();
      $hook = $type . '_alter';
      $modules = $this->getImplementations($hook);
      if (!isset($extra_types)) {
        // For the more common case of a single hook, we do not need to call
432 433
        // function_exists(), since $this->getImplementations() returns only
        // modules with implementations.
434 435 436 437 438 439 440 441 442 443 444 445 446
        foreach ($modules as $module) {
          $this->alterFunctions[$cid][] = $module . '_' . $hook;
        }
      }
      else {
        // For multiple hooks, we need $modules to contain every module that
        // implements at least one of them.
        $extra_modules = array();
        foreach ($extra_types as $extra_type) {
          $extra_modules = array_merge($extra_modules, $this->getImplementations($extra_type . '_alter'));
        }
        // If any modules implement one of the extra hooks that do not implement
        // the primary hook, we need to add them to the $modules array in their
447 448 449 450 451
        // appropriate order. $this->getImplementations() can only return
        // ordered implementations of a single hook. To get the ordered
        // implementations of multiple hooks, we mimic the
        // $this->getImplementations() logic of first ordering by
        // $this->getModuleList(), and then calling
452 453 454 455
        // $this->alter('module_implements').
        if (array_diff($extra_modules, $modules)) {
          // Merge the arrays and order by getModuleList().
          $modules = array_intersect(array_keys($this->moduleList), array_merge($modules, $extra_modules));
456 457 458
          // Since $this->getImplementations() already took care of loading the
          // necessary include files, we can safely pass FALSE for the array
          // values.
459 460 461
          $implementations = array_fill_keys($modules, FALSE);
          // Let modules adjust the order solely based on the primary hook. This
          // ensures the same module order regardless of whether this if block
462 463 464
          // runs. Calling $this->alter() recursively in this way does not
          // result in an infinite loop, because this call is for a single
          // $type, so we won't end up in this code block again.
465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496
          $this->alter('module_implements', $implementations, $hook);
          $modules = array_keys($implementations);
        }
        foreach ($modules as $module) {
          // Since $modules is a merged array, for any given module, we do not
          // know whether it has any particular implementation, so we need a
          // function_exists().
          $function = $module . '_' . $hook;
          if (function_exists($function)) {
            $this->alterFunctions[$cid][] = $function;
          }
          foreach ($extra_types as $extra_type) {
            $function = $module . '_' . $extra_type . '_alter';
            if (function_exists($function)) {
              $this->alterFunctions[$cid][] = $function;
            }
          }
        }
      }
    }

    foreach ($this->alterFunctions[$cid] as $function) {
      $function($data, $context1, $context2);
    }
  }

  /**
   * Provides information about modules' implementations of a hook.
   *
   * @param string $hook
   *   The name of the hook (e.g. "help" or "menu").
   *
497
   * @return mixed[]
498
   *   An array whose keys are the names of the modules which are implementing
499 500 501
   *   this hook and whose values are either a string identifying a file in
   *   which the implementation is to be found, or FALSE, if the implementation
   *   is in the module file.
502 503
   */
  protected function getImplementationInfo($hook) {
504 505
    if (!isset($this->implementations)) {
      $this->implementations = array();
506
      $this->verified = array();
507 508 509 510 511 512 513 514
      if ($cache = $this->cacheBackend->get('module_implements')) {
        $this->implementations = $cache->data;
      }
    }
    if (!isset($this->implementations[$hook])) {
      // The hook is not cached, so ensure that whether or not it has
      // implementations, the cache is updated at the end of the request.
      $this->cacheNeedsWriting = TRUE;
515
      // Discover implementations.
516
      $this->implementations[$hook] = $this->buildImplementationInfo($hook);
517 518
      // Implementations are always "verified" as part of the discovery.
      $this->verified[$hook] = TRUE;
519
    }
520 521 522 523 524
    elseif (!isset($this->verified[$hook])) {
      if (!$this->verifyImplementations($this->implementations[$hook], $hook)) {
        // One or more of the implementations did not exist and need to be
        // removed in the cache.
        $this->cacheNeedsWriting = TRUE;
525
      }
526
      $this->verified[$hook] = TRUE;
527 528 529 530 531 532 533 534 535 536
    }
    return $this->implementations[$hook];
  }

  /**
   * Builds hook implementation information for a given hook name.
   *
   * @param string $hook
   *   The name of the hook (e.g. "help" or "menu").
   *
537
   * @return mixed[]
538
   *   An array whose keys are the names of the modules which are implementing
539 540 541 542 543 544 545
   *   this hook and whose values are either a string identifying a file in
   *   which the implementation is to be found, or FALSE, if the implementation
   *   is in the module file.
   *
   * @throws \RuntimeException
   *   Exception thrown when an invalid implementation is added by
   *   hook_module_implements_alter().
546 547 548 549
   *
   * @see \Drupal\Core\Extension\ModuleHandler::getImplementationInfo()
   */
  protected function buildImplementationInfo($hook) {
550
    $implementations = array();
551
    $hook_info = $this->getHookInfo();
552
    foreach ($this->moduleList as $module => $extension) {
553
      $include_file = isset($hook_info[$hook]['group']) && $this->loadInclude($module, 'inc', $module . '.' . $hook_info[$hook]['group']);
554
      // Since $this->implementsHook() may needlessly try to load the include
555 556
      // file again, function_exists() is used directly here.
      if (function_exists($module . '_' . $hook)) {
557
        $implementations[$module] = $include_file ? $hook_info[$hook]['group'] : FALSE;
558 559
      }
    }
560
    // Allow modules to change the weight of specific implementations, but avoid
561 562
    // an infinite loop.
    if ($hook != 'module_implements_alter') {
563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579
      // Remember the original implementations, before they are modified with
      // hook_module_implements_alter().
      $implementations_before = $implementations;
      // Verify implementations that were added or modified.
      $this->alter('module_implements', $implementations, $hook);
      // Verify new or modified implementations.
      foreach (array_diff_assoc($implementations, $implementations_before) as $module => $group) {
        // If drupal_alter('module_implements') changed or added a $group, the
        // respective file needs to be included.
        if ($group) {
          $this->loadInclude($module, 'inc', "$module.$group");
        }
        // If a new implementation was added, verify that the function exists.
        if (!function_exists($module . '_' . $hook)) {
          throw new \RuntimeException(String::format('An invalid implementation @function was added by hook_module_implements_alter()', array('@function' => $module . '_' . $hook)));
        }
      }
580
    }
581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620
    return $implementations;
  }

  /**
   * Verifies an array of implementations loaded from the cache, by including
   * the lazy-loaded $module.$group.inc, and checking function_exists().
   *
   * @param string[] $implementations
   *   Implementation "group" by module name.
   * @param string $hook
   *   The hook name.
   *
   * @return bool
   *   TRUE, if all implementations exist.
   *   FALSE, if one or more implementations don't exist and need to be removed
   *     from the cache.
   */
  protected function verifyImplementations(&$implementations, $hook) {
    $all_valid = TRUE;
    foreach ($implementations as $module => $group) {
      // If this hook implementation is stored in a lazy-loaded file, include
      // that file first.
      if ($group) {
        $this->loadInclude($module, 'inc', "$module.$group");
      }
      // It is possible that a module removed a hook implementation without
      // the implementations cache being rebuilt yet, so we check whether the
      // function exists on each request to avoid undefined function errors.
      // Since ModuleHandler::implementsHook() may needlessly try to
      // load the include file again, function_exists() is used directly here.
      if (!function_exists($module . '_' . $hook)) {
        // Clear out the stale implementation from the cache and force a cache
        // refresh to forget about no longer existing hook implementations.
        unset($implementations[$module]);
        // One of the implementations did not exist and needs to be removed in
        // the cache.
        $all_valid = FALSE;
      }
    }
    return $all_valid;
621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640
  }

  /**
   * Parses a dependency for comparison by drupal_check_incompatibility().
   *
   * @param $dependency
   *   A dependency string, for example 'foo (>=8.x-4.5-beta5, 3.x)'.
   *
   * @return
   *   An associative array with three keys:
   *   - 'name' includes the name of the thing to depend on (e.g. 'foo').
   *   - 'original_version' contains the original version string (which can be
   *     used in the UI for reporting incompatibilities).
   *   - 'versions' is a list of associative arrays, each containing the keys
   *     'op' and 'version'. 'op' can be one of: '=', '==', '!=', '<>', '<',
   *     '<=', '>', or '>='. 'version' is one piece like '4.5-beta3'.
   *   Callers should pass this structure to drupal_check_incompatibility().
   *
   * @see drupal_check_incompatibility()
   */
641
  public static function parseDependency($dependency) {
642 643
    // We use named subpatterns and support every op that version_compare
    // supports. Also, op is optional and defaults to equals.
644
    $p_op = '(?<operation>!=|==|=|<|<=|>|>=|<>)?';
645
    // Core version is always optional: 8.x-2.x and 2.x is treated the same.
646
    $p_core = '(?:' . preg_quote(\Drupal::CORE_COMPATIBILITY) . '-)?';
647
    $p_major = '(?<major>\d+)';
648
    // By setting the minor version to x, branches can be matched.
649
    $p_minor = '(?<minor>(?:\d+|x)(?:-[A-Za-z]+\d+)?)';
650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679
    $value = array();
    $parts = explode('(', $dependency, 2);
    $value['name'] = trim($parts[0]);
    if (isset($parts[1])) {
      $value['original_version'] = ' (' . $parts[1];
      foreach (explode(',', $parts[1]) as $version) {
        if (preg_match("/^\s*$p_op\s*$p_core$p_major\.$p_minor/", $version, $matches)) {
          $op = !empty($matches['operation']) ? $matches['operation'] : '=';
          if ($matches['minor'] == 'x') {
            // Drupal considers "2.x" to mean any version that begins with
            // "2" (e.g. 2.0, 2.9 are all "2.x"). PHP's version_compare(),
            // on the other hand, treats "x" as a string; so to
            // version_compare(), "2.x" is considered less than 2.0. This
            // means that >=2.x and <2.x are handled by version_compare()
            // as we need, but > and <= are not.
            if ($op == '>' || $op == '<=') {
              $matches['major']++;
            }
            // Equivalence can be checked by adding two restrictions.
            if ($op == '=' || $op == '==') {
              $value['versions'][] = array('op' => '<', 'version' => ($matches['major'] + 1) . '.x');
              $op = '>=';
            }
          }
          $value['versions'][] = array('op' => $op, 'version' => $matches['major'] . '.' . $matches['minor']);
        }
      }
    }
    return $value;
  }
680 681 682 683

  /**
   * {@inheritdoc}
   */
684
  public function install(array $module_list, $enable_dependencies = TRUE) {
685
    $extension_config = \Drupal::config('core.extension');
686 687 688
    if ($enable_dependencies) {
      // Get all module data so we can find dependencies and sort.
      $module_data = system_rebuild_module_data();
689 690 691 692 693
      $module_list = $module_list ? array_combine($module_list, $module_list) : array();
      if (array_diff_key($module_list, $module_data)) {
        // One or more of the given modules doesn't exist.
        return FALSE;
      }
694

695
      // Only process currently uninstalled modules.
696
      $installed_modules = $extension_config->get('module') ?: array();
697 698 699 700
      if (!$module_list = array_diff_key($module_list, $installed_modules)) {
        // Nothing to do. All modules already installed.
        return TRUE;
      }
701

702 703 704 705 706 707 708 709
      // Add dependencies to the list. The new modules will be processed as
      // the while loop continues.
      while (list($module) = each($module_list)) {
        foreach (array_keys($module_data[$module]->requires) as $dependency) {
          if (!isset($module_data[$dependency])) {
            // The dependency does not exist.
            return FALSE;
          }
710

711 712 713
          // Skip already installed modules.
          if (!isset($module_list[$dependency]) && !isset($installed_modules[$dependency])) {
            $module_list[$dependency] = $dependency;
714 715 716 717
          }
        }
      }

718 719 720 721
      // Set the actual module weights.
      $module_list = array_map(function ($module) use ($module_data) {
        return $module_data[$module]->sort;
      }, $module_list);
722

723
      // Sort the module list by their weights (reverse).
724 725 726 727 728 729 730
      arsort($module_list);
      $module_list = array_keys($module_list);
    }

    // Required for module installation checks.
    include_once DRUPAL_ROOT . '/core/includes/install.inc';

731 732 733 734 735 736
    /** @var \Drupal\Core\Config\ConfigInstaller $config_installer */
    $config_installer = \Drupal::service('config.installer');
    $sync_status = $config_installer->isSyncing();
    if ($sync_status) {
      $source_storage = $config_installer->getSourceStorage();
    }
737 738
    $modules_installed = array();
    foreach ($module_list as $module) {
739
      $enabled = $extension_config->get("module.$module") !== NULL;
740
      if (!$enabled) {
741 742 743 744 745 746
        // Throw an exception if the module name is too long.
        if (strlen($module) > DRUPAL_EXTENSION_NAME_MAX_LENGTH) {
          throw new ExtensionNameLengthException(format_string('Module name %name is over the maximum allowed length of @max characters.', array(
            '%name' => $module,
            '@max' => DRUPAL_EXTENSION_NAME_MAX_LENGTH,
          )));
747
        }
748

749 750 751
        $extension_config
          ->set("module.$module", 0)
          ->set('module', module_config_sort($extension_config->get('module')))
752 753 754
          ->save();

        // Prepare the new module list, sorted by weight, including filenames.
755 756 757 758 759 760 761 762 763
        // This list is used for both the ModuleHandler and DrupalKernel. It
        // needs to be kept in sync between both. A DrupalKernel reboot or
        // rebuild will automatically re-instantiate a new ModuleHandler that
        // uses the new module list of the kernel. However, DrupalKernel does
        // not cause any modules to be loaded.
        // Furthermore, the currently active (fixed) module list can be
        // different from the configured list of enabled modules. For all active
        // modules not contained in the configured enabled modules, we assume a
        // weight of 0.
764 765
        $current_module_filenames = $this->getModuleList();
        $current_modules = array_fill_keys(array_keys($current_module_filenames), 0);
766
        $current_modules = module_config_sort(array_merge($current_modules, $extension_config->get('module')));
767 768 769
        $module_filenames = array();
        foreach ($current_modules as $name => $weight) {
          if (isset($current_module_filenames[$name])) {
770
            $module_filenames[$name] = $current_module_filenames[$name];
771 772
          }
          else {
773 774 775 776
            $module_path = drupal_get_path('module', $name);
            $pathname = "$module_path/$name.info.yml";
            $filename = file_exists($module_path . "/$name.module") ? "$name.module" : NULL;
            $module_filenames[$name] = new Extension('module', $pathname, $filename);
777 778 779 780
          }
        }

        // Update the module handler in order to load the module's code.
781 782 783 784
        // This allows the module to participate in hooks and its existence to
        // be discovered by other modules.
        // The current ModuleHandler instance is obsolete with the kernel
        // rebuild below.
785 786 787 788
        $this->setModuleList($module_filenames);
        $this->load($module);
        module_load_install($module);

789 790 791 792
        // Clear the static cache of system_rebuild_module_data() to pick up the
        // new module, since it merges the installation status of modules into
        // its statically cached list.
        drupal_static_reset('system_rebuild_module_data');
793 794 795 796

        // Update the kernel to include it.
        // This reboots the kernel to register the module's bundle and its
        // services in the service container. The $module_filenames argument is
797 798
        // taken over as %container.modules% parameter, which is passed to a
        // fresh ModuleHandler instance upon first retrieval.
799
        // @todo install_begin_request() creates a container without a kernel.
800
        if ($kernel = \Drupal::service('kernel', ContainerInterface::NULL_ON_INVALID_REFERENCE)) {
801 802 803 804 805 806 807
          $kernel->updateModules($module_filenames, $module_filenames);
        }

        // Refresh the schema to include it.
        drupal_get_schema(NULL, TRUE);

        // Allow modules to react prior to the installation of a module.
808
        $this->invokeAll('module_preinstall', array($module));
809

810 811
        // Now install the module's schema if necessary.
        drupal_install_schema($module);
812

813 814 815
        // Clear plugin manager caches.
        \Drupal::getContainer()->get('plugin.cache_clearer')->clearCachedDefinitions();

816 817 818
        // Set the schema version to the number of the last update provided by
        // the module, or the minimum core schema version.
        $version = \Drupal::CORE_MINIMUM_SCHEMA_VERSION;
819
        $versions = drupal_get_schema_versions($module);
820 821 822
        if ($versions) {
          $version = max(max($versions), $version);
        }
823

824 825 826 827 828 829 830 831 832 833 834
        // Notify the entity manager that this module's entity types are new,
        // so that it can notify all interested handlers. For example, a
        // SQL-based storage handler can use this as an opportunity to create
        // the necessary database tables.
        $entity_manager = \Drupal::entityManager();
        foreach ($entity_manager->getDefinitions() as $entity_type) {
          if ($entity_type->getProvider() == $module) {
            $entity_manager->onEntityTypeCreate($entity_type);
          }
        }

835
        // Install default configuration of the module.
836 837 838 839 840 841 842 843 844 845 846 847
        $config_installer = \Drupal::service('config.installer');
        if ($sync_status) {
          $config_installer
            ->setSyncing(TRUE)
            ->setSourceStorage($source_storage);
        }
        else {
          // If we're not in a config synchronisation reset the source storage
          // so that the extension install storage will pick up the new
          // configuration.
          $config_installer->resetSourceStorage();
        }
848
        \Drupal::service('config.installer')->installDefaultConfig('module', $module);
849

850 851 852 853 854
        // If the module has no current updates, but has some that were
        // previously removed, set the version to the value of
        // hook_update_last_removed().
        if ($last_removed = $this->invoke($module, 'update_last_removed')) {
          $version = max($version, $last_removed);
855
        }
856
        drupal_set_installed_schema_version($module, $version);
857

858 859
        // Record the fact that it was installed.
        $modules_installed[] = $module;
860

861 862 863 864 865 866 867 868 869
        // Update the theme registry to include it.
        drupal_theme_rebuild();

        // Modules can alter theme info, so refresh theme data.
        // @todo ThemeHandler cannot be injected into ModuleHandler, since that
        //   causes a circular service dependency.
        // @see https://drupal.org/node/2208429
        \Drupal::service('theme_handler')->refreshInfo();

870 871
        // Allow the module to perform install tasks.
        $this->invoke($module, 'install');
872

873
        // Record the fact that it was installed.
874
        \Drupal::logger('system')->info('%module module installed.', array('%module' => $module));
875 876 877 878 879 880 881 882 883 884 885 886 887 888
      }
    }

    // If any modules were newly installed, invoke hook_modules_installed().
    if (!empty($modules_installed)) {
      $this->invokeAll('modules_installed', array($modules_installed));
    }

    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
889 890 891 892 893 894 895 896
  public function uninstall(array $module_list, $uninstall_dependents = TRUE) {
    // Get all module data so we can find dependencies and sort.
    $module_data = system_rebuild_module_data();
    $module_list = $module_list ? array_combine($module_list, $module_list) : array();
    if (array_diff_key($module_list, $module_data)) {
      // One or more of the given modules doesn't exist.
      return FALSE;
    }
897

898
    // Only process currently installed modules.
899 900
    $extension_config = \Drupal::config('core.extension');
    $installed_modules = $extension_config->get('module') ?: array();
901 902 903 904 905 906 907 908
    if (!$module_list = array_intersect_key($module_list, $installed_modules)) {
      // Nothing to do. All modules already uninstalled.
      return TRUE;
    }

    if ($uninstall_dependents) {
      // Add dependent modules to the list. The new modules will be processed as
      // the while loop continues.
909 910
      $profile = drupal_get_profile();
      while (list($module) = each($module_list)) {
911 912 913 914 915
        foreach (array_keys($module_data[$module]->required_by) as $dependent) {
          if (!isset($module_data[$dependent])) {
            // The dependent module does not exist.
            return FALSE;
          }
916

917 918
          // Skip already uninstalled modules.
          if (isset($installed_modules[$dependent]) && !isset($module_list[$dependent]) && $dependent != $profile) {
919
            $module_list[$dependent] = $dependent;
920 921 922 923 924
          }
        }
      }
    }

925 926 927 928
    // Set the actual module weights.
    $module_list = array_map(function ($module) use ($module_data) {
      return $module_data[$module]->sort;
    }, $module_list);
929

930 931 932 933 934 935 936 937 938
    // Sort the module list by their weights.
    asort($module_list);
    $module_list = array_keys($module_list);

    // Only process modules that are enabled. A module is only enabled if it is
    // configured as enabled. Custom or overridden module handlers might contain
    // the module already, which means that it might be loaded, but not
    // necessarily installed.
    $schema_store = \Drupal::keyValue('system.schema');
939
    $entity_manager = \Drupal::entityManager();
940
    foreach ($module_list as $module) {
941 942 943 944 945 946

      // Clean up all entity bundles (including field instances) of every entity
      // type provided by the module that is being uninstalled.
      foreach ($entity_manager->getDefinitions() as $entity_type_id => $entity_type) {
        if ($entity_type->getProvider() == $module) {
          foreach (array_keys($entity_manager->getBundleInfo($entity_type_id)) as $bundle) {
947
            $entity_manager->onBundleDelete($entity_type_id, $bundle);
948 949 950 951
          }
        }
      }

952 953
      // Allow modules to react prior to the uninstallation of a module.
      $this->invokeAll('module_preuninstall', array($module));
954

955 956 957
      // Uninstall the module.
      module_load_install($module);
      $this->invoke($module, 'uninstall');
958 959 960 961

      // Remove all configuration belonging to the module.
      \Drupal::service('config.manager')->uninstall('module', $module);

962 963 964 965
      // Notify the entity manager that this module's entity types are being
      // deleted, so that it can notify all interested handlers. For example,
      // a SQL-based storage handler can use this as an opportunity to drop
      // the corresponding database tables.
966 967
      foreach ($entity_manager->getDefinitions() as $entity_type) {
        if ($entity_type->getProvider() == $module) {
968
          $entity_manager->onEntityTypeDelete($entity_type);
969 970 971
        }
      }

972
      // Remove the schema.
973
      drupal_uninstall_schema($module);
974

975
      // Remove the module's entry from the config.
976
      $extension_config->clear("module.$module")->save();
977

978 979 980 981 982 983
      // Update the module handler to remove the module.
      // The current ModuleHandler instance is obsolete with the kernel rebuild
      // below.
      $module_filenames = $this->getModuleList();
      unset($module_filenames[$module]);
      $this->setModuleList($module_filenames);
984

985 986 987
      // Remove any potential cache bins provided by the module.
      $this->removeCacheBins($module);

988 989 990 991
      // Clear the static cache of system_rebuild_module_data() to pick up the
      // new module, since it merges the installation status of modules into
      // its statically cached list.
      drupal_static_reset('system_rebuild_module_data');
992

993
      \Drupal::getContainer()->get('plugin.cache_clearer')->clearCachedDefinitions();
994

995 996
      // Update the kernel to exclude the uninstalled modules.
      \Drupal::service('kernel')->updateModules($module_filenames, $module_filenames);
997

998
      // Update the theme registry to remove the newly uninstalled module.
999 1000
      drupal_theme_rebuild();

1001 1002 1003 1004 1005 1006
      // Modules can alter theme info, so refresh theme data.
      // @todo ThemeHandler cannot be injected into ModuleHandler, since that
      //   causes a circular service dependency.
      // @see https://drupal.org/node/2208429
      \Drupal::service('theme_handler')->refreshInfo();

1007
      \Drupal::logger('system')->info('%module module uninstalled.', array('%module' => $module));
1008

1009
      $schema_store->delete($module);
1010
    }
1011
    drupal_get_installed_schema_version(NULL, TRUE);
1012

1013 1014
    // Let other modules react.
    $this->invokeAll('modules_uninstalled', array($module_list));
1015

1016 1017 1018 1019
    drupal_flush_all_caches();

    return TRUE;
  }
1020

1021 1022 1023 1024 1025 1026 1027 1028 1029 1030
  /**
   * Helper method for removing all cache bins registered by a given module.
   *
   * @param string $module
   *   The name of the module for which to remove all registered cache bins.
   */
  protected function removeCacheBins($module) {
    // Remove any cache bins defined by a module.
    $service_yaml_file = drupal_get_path('module', $module) . "/$module.services.yml";
    if (file_exists($service_yaml_file)) {
1031
      $definitions = Yaml::decode(file_get_contents($service_yaml_file));
1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045
      if (isset($definitions['services'])) {
        foreach ($definitions['services'] as $id => $definition) {
          if (isset($definition['tags'])) {
            foreach ($definition['tags'] as $tag) {
              // This works for the default cache registration and even in some
              // cases when a non-default "super" factory is used. That should
              // be extremely rare.
              if ($tag['name'] == 'cache.bin' && isset($definition['factory_service']) && isset($definition['factory_method']) && !empty($definition['arguments'])) {
                try {
                  $factory = \Drupal::service($definition['factory_service']);
                  if (method_exists($factory, $definition['factory_method'])) {
                    $backend = call_user_func_array(array($factory, $definition['factory_method']), $definition['arguments']);
                    if ($backend instanceof CacheBackendInterface) {
                      $backend->removeBin();
1046 1047
                    }
                  }
1048 1049 1050
                }
                catch (\Exception $e) {
                  watchdog_exception('system', $e, 'Failed to remove cache bin defined by the service %id.', array('%id' => $id));
1051 1052 1053 1054 1055 1056 1057 1058 1059
                }
              }
            }
          }
        }
      }
    }
  }

1060 1061 1062 1063 1064
  /**
   * {@inheritdoc}
   */
  public function getModuleDirectories() {
    $dirs = array();
1065 1066
    foreach ($this->getModuleList() as $name => $module) {
      $dirs[$name] = DRUPAL_ROOT . '/' . $module->getPath();
1067 1068 1069
    }
    return $dirs;
  }
1070

1071 1072 1073 1074 1075 1076 1077
  /**
   * {@inheritdoc}
   */
  public function getName($module) {
    $module_data = system_rebuild_module_data();
    return $module_data[$module]->info['name'];
  }
1078
}