ModuleHandler.php 32.3 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 Symfony\Component\Yaml\Parser;
12 13 14
use Drupal\Component\Utility\NestedArray;
use Drupal\Core\Cache\CacheBackendInterface;
use Drupal\Core\KeyValueStore\KeyValueStoreInterface;
15
use Symfony\Component\DependencyInjection\ContainerInterface;
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76

/**
 * Class that manages enabled modules in a Drupal installation.
 */
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;

  /**
   * List of enabled modules.
   *
   * @var array
   *   An associative array whose keys are the names of the modules and whose
   *   values are the module filenames.
   */
  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;

  /**
   * Information returned by hook_hook_info() implementations.
   *
   * @var array
   */
  protected $hookInfo;

  /**
   * List of alter hook implementations keyed by hook name(s).
   *
   * @var array
   */
  protected $alterFunctions;

  /**
   * Constructs a ModuleHandler object.
   *
   * @param array $module_list
   *   An associative array whose keys are the names of enabled modules and
   *   whose values are the module filenames. This is normally the
   *   %container.modules% parameter being set up by DrupalKernel.
   *
   * @see \Drupal\Core\DrupalKernel
77
   * @see \Drupal\Core\CoreServiceProvider
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
   */
  public function __construct(array $module_list = array()) {
    $this->moduleList = $module_list;
  }

  /**
   * Implements \Drupal\Core\Extension\ModuleHandlerInterface::load().
   */
  public function load($name) {
    if (isset($this->loadedFiles[$name])) {
      return TRUE;
    }

    if (isset($this->moduleList[$name])) {
      $filename = $this->moduleList[$name];
      include_once DRUPAL_ROOT . '/' . $filename;
      $this->loadedFiles[$name] = TRUE;
      return TRUE;
    }
    return FALSE;
  }

  /**
   * Implements \Drupal\Core\Extension\ModuleHandlerInterface::loadAll().
   */
  public function loadAll() {
    if (!$this->loaded) {
      foreach ($this->moduleList as $module => $filename) {
        $this->load($module);
      }
      $this->loaded = TRUE;
    }
  }

  /**
   * Implements \Drupal\Core\Extension\ModuleHandlerInterface::reload().
   */
  public function reload() {
    $this->loaded = FALSE;
    $this->loadAll();
  }

  /**
   * Implements \Drupal\Core\Extension\ModuleHandlerInterface::isLoaded().
   */
  public function isLoaded() {
    return $this->loaded;
  }

  /**
   * Implements \Drupal\Core\Extension\ModuleHandlerInterface::getModuleList().
   */
  public function getModuleList() {
    return $this->moduleList;
  }

  /**
   * Implements \Drupal\Core\Extension\ModuleHandlerInterface::setModuleList().
   */
  public function setModuleList(array $module_list = array()) {
    $this->moduleList = $module_list;
139 140 141
    // Reset the implementations, so a new call triggers a reloading of the
    // available hooks.
    $this->resetImplementations();
142 143 144 145 146 147
  }

  /**
   * Implements \Drupal\Core\Extension\ModuleHandlerInterface::buildModuleDependencies().
   */
  public function buildModuleDependencies(array $modules) {
148
    foreach ($modules as $module) {
149 150 151
      $graph[$module->name]['edges'] = array();
      if (isset($module->info['dependencies']) && is_array($module->info['dependencies'])) {
        foreach ($module->info['dependencies'] as $dependency) {
152
          $dependency_data = static::parseDependency($dependency);
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
          $graph[$module->name]['edges'][$dependency_data['name']] = $dependency_data;
        }
      }
    }
    $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;
  }

  /**
   * Implements \Drupal\Core\Extension\ModuleHandlerInterface::moduleExists().
   */
  public function moduleExists($module) {
    return isset($this->moduleList[$module]);
  }

  /**
   * Implements \Drupal\Core\Extension\ModuleHandlerInterface::loadAllIncludes().
   */
  public function loadAllIncludes($type, $name = NULL) {
    foreach ($this->moduleList as $module => $filename) {
      $this->loadInclude($module, $type, $name);
    }
  }

  /**
   * Implements \Drupal\Core\Extension\ModuleHandlerInterface::loadInclude().
   */
  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;
193 194 195 196 197 198
    if (isset($this->moduleList[$module])) {
      $file = DRUPAL_ROOT . '/' . dirname($this->moduleList[$module]) . "/$name.$type";
      if (is_file($file)) {
        require_once $file;
        return $file;
      }
199 200 201 202 203
    }

    return FALSE;
  }

204 205 206 207 208 209 210 211 212 213
  /**
   * Implements \Drupal\Core\Extension\ModuleHandlerInterface::getHookInfo().
   */
  public function getHookInfo() {
    if (isset($this->hookInfo)) {
      return $this->hookInfo;
    }
    $this->hookInfo = array();
    // We can't use $this->invokeAll() here or it would cause an infinite
    // loop.
214 215
    // Make sure that the modules are loaded before checking.
    $this->reload();
216 217 218 219 220 221 222 223 224 225 226 227
    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);
        }
      }
    }
    return $this->hookInfo;
  }

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
  /**
   * Implements \Drupal\Core\Extension\ModuleHandlerInterface::getImplementations().
   */
  public function getImplementations($hook) {
    $implementations = $this->getImplementationInfo($hook);
    return array_keys($implementations);
  }

  /**
   * Implements \Drupal\Core\Extension\ModuleHandlerInterface::resetImplementations().
   */
  public function resetImplementations() {
    $this->implementations = NULL;
    $this->hookInfo = NULL;
    $this->alterFunctions = NULL;
  }

  /**
   * Implements \Drupal\Core\Extension\ModuleHandlerInterface::implementsHook().
   */
  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;
  }

265 266 267 268 269 270 271 272 273 274 275
  /**
   * Implements \Drupal\Core\Extension\ModuleHandlerInterface::invoke().
   */
  public function invoke($module, $hook, $args = array()) {
    if (!$this->implementsHook($module, $hook)) {
      return;
    }
    $function = $module . '_' . $hook;
    return call_user_func_array($function, $args);
  }

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 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461
  /**
   * Implements \Drupal\Core\Extension\ModuleHandlerInterface::invokeAll().
   */
  public function invokeAll($hook, $args = array()) {
    $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;
  }

  /**
   * Implements \Drupal\Core\Extension\ModuleHandlerInterface::alter().
   */
  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
      // than !empty() both when $type is passed as a string, or as an array with
      // one item.
      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
        // function_exists(), since $this->getImplementations() returns only modules with
        // implementations.
        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
        // 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
        // $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));
          // Since $this->getImplementations() already took care of loading the necessary
          // include files, we can safely pass FALSE for the array values.
          $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
          // 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.
          $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;
            }
          }
        }
      }
      // Allow the theme to alter variables after the theme system has been
      // initialized.
      global $theme, $base_theme_info;
      if (isset($theme)) {
        $theme_keys = array();
        foreach ($base_theme_info as $base) {
          $theme_keys[] = $base->name;
        }
        $theme_keys[] = $theme;
        foreach ($theme_keys as $theme_key) {
          $function = $theme_key . '_' . $hook;
          if (function_exists($function)) {
            $this->alterFunctions[$cid][] = $function;
          }
          if (isset($extra_types)) {
            foreach ($extra_types as $extra_type) {
              $function = $theme_key . '_' . $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").
   *
   * @return array
   *   An array whose keys are the names of the modules which are implementing
   *   this hook and whose values are either an array of information from
   *   hook_hook_info() or FALSE if the implementation is in the module file.
   */
  protected function getImplementationInfo($hook) {
    if (isset($this->implementations[$hook])) {
      return $this->implementations[$hook];
    }
    $this->implementations[$hook] = array();
    $hook_info = $this->getHookInfo();
    foreach ($this->moduleList as $module => $filename) {
      $include_file = isset($hook_info[$hook]['group']) && $this->loadInclude($module, 'inc', $module . '.' . $hook_info[$hook]['group']);
      // Since $this->hookImplements() may needlessly try to load the include
      // file again, function_exists() is used directly here.
      if (function_exists($module . '_' . $hook)) {
        $this->implementations[$hook][$module] = $include_file ? $hook_info[$hook]['group'] : FALSE;
      }
    }
    // Allow modules to change the weight of specific implementations but avoid
    // an infinite loop.
    if ($hook != 'module_implements_alter') {
      $this->alter('module_implements', $this->implementations[$hook], $hook);
    }
    return $this->implementations[$hook];
  }

  /**
   * 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()
   */
462
  public static function parseDependency($dependency) {
463 464
    // We use named subpatterns and support every op that version_compare
    // supports. Also, op is optional and defaults to equals.
465
    $p_op = '(?<operation>!=|==|=|<|<=|>|>=|<>)?';
466
    // Core version is always optional: 8.x-2.x and 2.x is treated the same.
467
    $p_core = '(?:' . preg_quote(\Drupal::CORE_COMPATIBILITY) . '-)?';
468
    $p_major = '(?<major>\d+)';
469
    // By setting the minor version to x, branches can be matched.
470
    $p_minor = '(?<minor>(?:\d+|x)(?:-[A-Za-z]+\d+)?)';
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 497 498 499 500
    $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;
  }
501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542

  /**
   * {@inheritdoc}
   */
  public function enable($module_list, $enable_dependencies = TRUE) {
    if ($enable_dependencies) {
      // Get all module data so we can find dependencies and sort.
      $module_data = system_rebuild_module_data();
      // Create an associative array with weights as values.
      $module_list = array_flip(array_values($module_list));

      while (list($module) = each($module_list)) {
        if (!isset($module_data[$module])) {
          // This module is not found in the filesystem, abort.
          return FALSE;
        }
        if ($module_data[$module]->status) {
          // Skip already enabled modules.
          unset($module_list[$module]);
          continue;
        }
        $module_list[$module] = $module_data[$module]->sort;

        // Add dependencies to the list, with a placeholder weight.
        // The new modules will be processed as the while loop continues.
        foreach (array_keys($module_data[$module]->requires) as $dependency) {
          if (!isset($module_list[$dependency])) {
            $module_list[$dependency] = 0;
          }
        }
      }

      if (!$module_list) {
        // Nothing to do. All modules already enabled.
        return TRUE;
      }

      // Sort the module list by pre-calculated weights.
      arsort($module_list);
      $module_list = array_keys($module_list);
    }

543 544 545 546 547 548 549 550 551 552
    foreach ($module_list as $module) {
      // 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,
        )));
      }
    }

553 554 555 556 557
    // Required for module installation checks.
    include_once DRUPAL_ROOT . '/core/includes/install.inc';

    $modules_installed = array();
    $modules_enabled = array();
558 559
    $module_config = \Drupal::config('system.module');
    $disabled_config = \Drupal::config('system.module.disabled');
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 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 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 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 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 721 722
    foreach ($module_list as $module) {
      // Only process modules that are not already 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 or enabled.
      $enabled = $module_config->get("enabled.$module") !== NULL;
      if (!$enabled) {
        $weight = $disabled_config->get($module);
        if ($weight === NULL) {
          $weight = 0;
        }
        $module_config
          ->set("enabled.$module", $weight)
          ->set('enabled', module_config_sort($module_config->get('enabled')))
          ->save();
        $disabled_config
          ->clear($module)
          ->save();

        // Prepare the new module list, sorted by weight, including filenames.
        // 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.
        $current_module_filenames = $this->getModuleList();
        $current_modules = array_fill_keys(array_keys($current_module_filenames), 0);
        $current_modules = module_config_sort(array_merge($current_modules, $module_config->get('enabled')));
        $module_filenames = array();
        foreach ($current_modules as $name => $weight) {
          if (isset($current_module_filenames[$name])) {
            $filename = $current_module_filenames[$name];
          }
          else {
            $filename = drupal_get_filename('module', $name);
          }
          $module_filenames[$name] = $filename;
        }

        // Update the module handler in order to load the module's code.
        // 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.
        $this->setModuleList($module_filenames);
        $this->load($module);
        module_load_install($module);

        // Flush theme info caches, since (testing) modules can implement
        // hook_system_theme_info() to register additional themes.
        system_list_reset();

        // 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
        // taken over as %container.modules% parameter, which is passed to a fresh
        // ModuleHandler instance upon first retrieval.
        // @todo install_begin_request() creates a container without a kernel.
        if ($kernel = drupal_container()->get('kernel', ContainerInterface::NULL_ON_INVALID_REFERENCE)) {
          $kernel->updateModules($module_filenames, $module_filenames);
        }

        // Refresh the schema to include it.
        drupal_get_schema(NULL, TRUE);
        // Update the theme registry to include it.
        drupal_theme_rebuild();

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

        // Clear the entity info cache before importing new configuration.
        entity_info_cache_clear();

        // Now install the module if necessary.
        if (drupal_get_installed_schema_version($module, TRUE) == SCHEMA_UNINSTALLED) {
          drupal_install_schema($module);

          // Set the schema version to the number of the last update provided
          // by the module.
          $versions = drupal_get_schema_versions($module);
          $version = $versions ? max($versions) : SCHEMA_INSTALLED;

          // Install default configuration of the module.
          config_install_default_config('module', $module);

          // 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);
          }
          drupal_set_installed_schema_version($module, $version);
          // Allow the module to perform install tasks.
          $this->invoke($module, 'install');
          // Record the fact that it was installed.
          $modules_installed[] = $module;
          watchdog('system', '%module module installed.', array('%module' => $module), WATCHDOG_INFO);
        }

        // Allow modules to react prior to the enabling of a module.
        entity_info_cache_clear();
        $this->invokeAll('modules_preenable', array(array($module)));

        // Enable the module.
        $this->invoke($module, 'enable');

        // Record the fact that it was enabled.
        $modules_enabled[] = $module;
        watchdog('system', '%module module enabled.', array('%module' => $module), WATCHDOG_INFO);
      }
    }

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

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

    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  function disable($module_list, $disable_dependents = TRUE) {
    if ($disable_dependents) {
      // Get all module data so we can find dependents and sort.
      $module_data = system_rebuild_module_data();
      // Create an associative array with weights as values.
      $module_list = array_flip(array_values($module_list));

      $profile = drupal_get_profile();
      while (list($module) = each($module_list)) {
        if (!isset($module_data[$module]) || !$module_data[$module]->status) {
          // This module doesn't exist or is already disabled, skip it.
          unset($module_list[$module]);
          continue;
        }
        $module_list[$module] = $module_data[$module]->sort;

        // Add dependent modules to the list, with a placeholder weight.
        // The new modules will be processed as the while loop continues.
        foreach ($module_data[$module]->required_by as $dependent => $dependent_data) {
          if (!isset($module_list[$dependent]) && $dependent != $profile) {
            $module_list[$dependent] = 0;
          }
        }
      }

      // Sort the module list by pre-calculated weights.
      asort($module_list);
      $module_list = array_keys($module_list);
    }

    $invoke_modules = array();

723 724
    $module_config = \Drupal::config('system.module');
    $disabled_config = \Drupal::config('system.module.disabled');
725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813
    foreach ($module_list as $module) {
      // 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 or enabled.
      $enabled = $module_config->get("enabled.$module") !== NULL;
      if ($enabled) {
        module_load_install($module);
        module_invoke($module, 'disable');

        $disabled_config
          ->set($module, $module_config->get($module))
          ->save();
        $module_config
          ->clear("enabled.$module")
          ->save();

        // 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);

        // Record the fact that it was disabled.
        $invoke_modules[] = $module;
        watchdog('system', '%module module disabled.', array('%module' => $module), WATCHDOG_INFO);
      }
    }

    if (!empty($invoke_modules)) {
      // @todo Most of the following should happen in above loop already.

      // Refresh the system list to exclude the disabled modules.
      // @todo Only needed to rebuild theme info.
      // @see system_list_reset()
      system_list_reset();

      entity_info_cache_clear();

      // Invoke hook_modules_disabled before disabling modules,
      // so we can still call module hooks to get information.
      $this->invokeAll('modules_disabled', array($invoke_modules));

      // Update the kernel to exclude the disabled modules.
      $enabled = $this->getModuleList();
      drupal_container()->get('kernel')->updateModules($enabled, $enabled);

      // Update the theme registry to remove the newly-disabled module.
      drupal_theme_rebuild();
    }
  }

  /**
   * {@inheritdoc}
   */
  public function uninstall($module_list = array(), $uninstall_dependents = TRUE) {
    if ($uninstall_dependents) {
      // Get all module data so we can find dependents and sort.
      $module_data = system_rebuild_module_data();
      // Create an associative array with weights as values.
      $module_list = array_flip(array_values($module_list));

      $profile = drupal_get_profile();
      while (list($module) = each($module_list)) {
        if (!isset($module_data[$module]) || drupal_get_installed_schema_version($module) == SCHEMA_UNINSTALLED) {
          // This module doesn't exist or is already uninstalled. Skip it.
          unset($module_list[$module]);
          continue;
        }
        $module_list[$module] = $module_data[$module]->sort;

        // If the module has any dependents which are not already uninstalled and
        // not included in the passed-in list, abort. It is not safe to uninstall
        // them automatically because uninstalling a module is a destructive
        // operation.
        foreach (array_keys($module_data[$module]->required_by) as $dependent) {
          if (!isset($module_list[$dependent]) && drupal_get_installed_schema_version($dependent) != SCHEMA_UNINSTALLED && $dependent != $profile) {
            return FALSE;
          }
        }
      }

      // Sort the module list by pre-calculated weights.
      asort($module_list);
      $module_list = array_keys($module_list);
    }

    $schema_store = \Drupal::keyValue('system.schema');
814
    $disabled_config = \Drupal::config('system.module.disabled');
815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870
    foreach ($module_list as $module) {
      // Uninstall the module.
      module_load_install($module);
      $this->invoke($module, 'uninstall');
      drupal_uninstall_schema($module);

      // Remove all configuration belonging to the module.
      config_uninstall_default_config('module', $module);

      // Remove any cache bins defined by the module.
      $service_yaml_file = drupal_get_path('module', $module) . "/$module.services.yml";
      if (file_exists($service_yaml_file)) {
        $parser = new Parser;
        $definitions = $parser->parse(file_get_contents($service_yaml_file));
        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();
                      }
                    }
                  }
                  catch (\Exception $e) {
                    watchdog_exception('system', $e, 'Failed to remove cache bin defined by the service %id.', array('%id' => $id));
                  }
                }
              }
            }
          }
        }
      }

      watchdog('system', '%module module uninstalled.', array('%module' => $module), WATCHDOG_INFO);
      $schema_store->delete($module);
      $disabled_config->clear($module);
    }
    $disabled_config->save();
    drupal_get_installed_schema_version(NULL, TRUE);

    if (!empty($module_list)) {
      // Let other modules react.
      $this->invokeAll('modules_uninstalled', array($module_list));
    }

    return TRUE;
  }

871 872 873 874 875 876 877 878 879 880
  /**
   * {@inheritdoc}
   */
  public function getModuleDirectories() {
    $dirs = array();
    foreach ($this->getModuleList() as $module => $filename) {
      $dirs[$module] = DRUPAL_ROOT . '/' . dirname($filename);
    }
    return $dirs;
  }
881
}