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

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

namespace Drupal\Core\Extension;

use Drupal\Component\Graph\Graph;
use Drupal\Component\Utility\NestedArray;
12
use Drupal\Component\Utility\String;
13
use Drupal\Core\Cache\Cache;
14 15 16
use Drupal\Core\Cache\CacheBackendInterface;

/**
17
 * Class that manages modules in a Drupal installation.
18 19 20 21 22 23 24 25 26 27 28 29 30
 */
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;

  /**
31
   * List of installed modules.
32
   *
33
   * @var \Drupal\Core\Extension\Extension[]
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50
   */
  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;

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

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

66 67 68 69 70 71 72 73 74 75 76 77 78 79
  /**
   * 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;

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

87 88 89 90 91 92 93
  /**
   * The app root.
   *
   * @var string
   */
  protected $root;

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

  /**
119
   * {@inheritdoc}
120 121 122 123 124 125 126
   */
  public function load($name) {
    if (isset($this->loadedFiles[$name])) {
      return TRUE;
    }

    if (isset($this->moduleList[$name])) {
127
      $this->moduleList[$name]->load();
128 129 130 131 132 133 134
      $this->loadedFiles[$name] = TRUE;
      return TRUE;
    }
    return FALSE;
  }

  /**
135
   * {@inheritdoc}
136 137 138
   */
  public function loadAll() {
    if (!$this->loaded) {
139 140
      foreach ($this->moduleList as $name => $module) {
        $this->load($name);
141 142 143 144 145 146
      }
      $this->loaded = TRUE;
    }
  }

  /**
147
   * {@inheritdoc}
148 149 150 151 152 153 154
   */
  public function reload() {
    $this->loaded = FALSE;
    $this->loadAll();
  }

  /**
155
   * {@inheritdoc}
156 157 158 159 160 161
   */
  public function isLoaded() {
    return $this->loaded;
  }

  /**
162
   * {@inheritdoc}
163 164 165 166 167
   */
  public function getModuleList() {
    return $this->moduleList;
  }

168 169 170 171 172 173 174 175 176 177
  /**
   * {@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));
  }

178
  /**
179
   * {@inheritdoc}
180 181 182
   */
  public function setModuleList(array $module_list = array()) {
    $this->moduleList = $module_list;
183 184 185
    // Reset the implementations, so a new call triggers a reloading of the
    // available hooks.
    $this->resetImplementations();
186 187
  }

188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
  /**
   * {@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";
214 215
    $filename = file_exists($this->root . "/$path/$name.$type") ? "$name.$type" : NULL;
    $this->moduleList[$name] = new Extension($this->root, $type, $pathname, $filename);
216 217 218
    $this->resetImplementations();
  }

219
  /**
220
   * {@inheritdoc}
221 222
   */
  public function buildModuleDependencies(array $modules) {
223
    foreach ($modules as $module) {
224
      $graph[$module->getName()]['edges'] = array();
225 226
      if (isset($module->info['dependencies']) && is_array($module->info['dependencies'])) {
        foreach ($module->info['dependencies'] as $dependency) {
227
          $dependency_data = static::parseDependency($dependency);
228
          $graph[$module->getName()]['edges'][$dependency_data['name']] = $dependency_data;
229 230 231 232 233 234 235 236 237 238 239 240 241 242
        }
      }
    }
    $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;
  }

  /**
243
   * {@inheritdoc}
244 245 246 247 248 249
   */
  public function moduleExists($module) {
    return isset($this->moduleList[$module]);
  }

  /**
250
   * {@inheritdoc}
251 252 253 254 255 256 257 258
   */
  public function loadAllIncludes($type, $name = NULL) {
    foreach ($this->moduleList as $module => $filename) {
      $this->loadInclude($module, $type, $name);
    }
  }

  /**
259
   * {@inheritdoc}
260 261 262 263
   */
  public function loadInclude($module, $type, $name = NULL) {
    if ($type == 'install') {
      // Make sure the installation API is available
264
      include_once $this->root . '/core/includes/install.inc';
265 266 267
    }

    $name = $name ?: $module;
268
    if (isset($this->moduleList[$module])) {
269
      $file = $this->root . '/' . $this->moduleList[$module]->getPath() . "/$name.$type";
270 271 272 273
      if (is_file($file)) {
        require_once $file;
        return $file;
      }
274 275 276 277 278
    }

    return FALSE;
  }

279
  /**
280
   * {@inheritdoc}
281 282
   */
  public function getHookInfo() {
283 284 285 286 287 288 289 290
    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);
      }
291
    }
292 293 294 295 296 297 298 299 300
    return $this->hookInfo;
  }

  /**
   * Builds hook_hook_info() information.
   *
   * @see \Drupal\Core\Extension\ModuleHandler::getHookInfo()
   */
  protected function buildHookInfo() {
301
    $this->hookInfo = array();
302 303
    // Make sure that the modules are loaded before checking.
    $this->reload();
304
    // $this->invokeAll() would cause an infinite recursion.
305 306 307 308 309 310 311 312 313 314 315
    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);
        }
      }
    }
  }

316
  /**
317
   * {@inheritdoc}
318 319 320 321 322 323 324
   */
  public function getImplementations($hook) {
    $implementations = $this->getImplementationInfo($hook);
    return array_keys($implementations);
  }

  /**
325 326 327 328 329 330 331 332 333 334 335
   * {@inheritdoc}
   */
  public function writeCache() {
    if ($this->cacheNeedsWriting) {
      $this->cacheBackend->set('module_implements', $this->implementations);
      $this->cacheNeedsWriting = FALSE;
    }
  }

  /**
   * {@inheritdoc}
336 337 338 339 340
   */
  public function resetImplementations() {
    $this->implementations = NULL;
    $this->hookInfo = NULL;
    $this->alterFunctions = NULL;
341 342 343 344 345 346 347 348 349 350 351 352 353
    // 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');
354 355 356
  }

  /**
357
   * {@inheritdoc}
358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375
   */
  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;
  }

376
  /**
377
   * {@inheritdoc}
378
   */
379
  public function invoke($module, $hook, array $args = array()) {
380 381 382 383 384 385 386
    if (!$this->implementsHook($module, $hook)) {
      return;
    }
    $function = $module . '_' . $hook;
    return call_user_func_array($function, $args);
  }

387
  /**
388
   * {@inheritdoc}
389
   */
390
  public function invokeAll($hook, array $args = array()) {
391 392 393 394
    $return = array();
    $implementations = $this->getImplementations($hook);
    foreach ($implementations as $module) {
      $function = $module . '_' . $hook;
395 396 397 398 399 400
      $result = call_user_func_array($function, $args);
      if (isset($result) && is_array($result)) {
        $return = NestedArray::mergeDeep($return, $result);
      }
      elseif (isset($result)) {
        $return[] = $result;
401 402 403 404 405 406 407
      }
    }

    return $return;
  }

  /**
408
   * {@inheritdoc}
409 410 411 412 413 414 415 416 417 418 419
   */
  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
420 421
      // than !empty() both when $type is passed as a string, or as an array
      // with one item.
422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438
      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
439 440
        // function_exists(), since $this->getImplementations() returns only
        // modules with implementations.
441 442 443 444 445 446 447 448 449 450 451 452 453
        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
454 455 456 457 458
        // 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
459 460 461 462
        // $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));
463 464 465
          // Since $this->getImplementations() already took care of loading the
          // necessary include files, we can safely pass FALSE for the array
          // values.
466 467 468
          $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
469 470 471
          // 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.
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 501 502 503
          $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").
   *
504
   * @return mixed[]
505
   *   An array whose keys are the names of the modules which are implementing
506 507 508
   *   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.
509 510
   */
  protected function getImplementationInfo($hook) {
511 512
    if (!isset($this->implementations)) {
      $this->implementations = array();
513
      $this->verified = array();
514 515 516 517 518 519 520 521
      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;
522
      // Discover implementations.
523
      $this->implementations[$hook] = $this->buildImplementationInfo($hook);
524 525
      // Implementations are always "verified" as part of the discovery.
      $this->verified[$hook] = TRUE;
526
    }
527 528 529 530 531
    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;
532
      }
533
      $this->verified[$hook] = TRUE;
534 535 536 537 538 539 540 541 542 543
    }
    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").
   *
544
   * @return mixed[]
545
   *   An array whose keys are the names of the modules which are implementing
546 547 548 549 550 551 552
   *   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().
553 554 555 556
   *
   * @see \Drupal\Core\Extension\ModuleHandler::getImplementationInfo()
   */
  protected function buildImplementationInfo($hook) {
557
    $implementations = array();
558
    $hook_info = $this->getHookInfo();
559
    foreach ($this->moduleList as $module => $extension) {
560
      $include_file = isset($hook_info[$hook]['group']) && $this->loadInclude($module, 'inc', $module . '.' . $hook_info[$hook]['group']);
561
      // Since $this->implementsHook() may needlessly try to load the include
562 563
      // file again, function_exists() is used directly here.
      if (function_exists($module . '_' . $hook)) {
564
        $implementations[$module] = $include_file ? $hook_info[$hook]['group'] : FALSE;
565 566
      }
    }
567
    // Allow modules to change the weight of specific implementations, but avoid
568 569
    // an infinite loop.
    if ($hook != 'module_implements_alter') {
570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586
      // 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)));
        }
      }
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
    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;
628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647
  }

  /**
   * 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()
   */
648
  public static function parseDependency($dependency) {
649 650
    // We use named subpatterns and support every op that version_compare
    // supports. Also, op is optional and defaults to equals.
651
    $p_op = '(?<operation>!=|==|=|<|<=|>|>=|<>)?';
652
    // Core version is always optional: 8.x-2.x and 2.x is treated the same.
653
    $p_core = '(?:' . preg_quote(\Drupal::CORE_COMPATIBILITY) . '-)?';
654
    $p_major = '(?<major>\d+)';
655
    // By setting the minor version to x, branches can be matched.
656
    $p_minor = '(?<minor>(?:\d+|x)(?:-[A-Za-z]+\d+)?)';
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
    $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;
  }
687

688 689 690 691 692
  /**
   * {@inheritdoc}
   */
  public function getModuleDirectories() {
    $dirs = array();
693
    foreach ($this->getModuleList() as $name => $module) {
694
      $dirs[$name] = $this->root . '/' . $module->getPath();
695 696 697
    }
    return $dirs;
  }
698

699 700 701 702 703 704 705
  /**
   * {@inheritdoc}
   */
  public function getName($module) {
    $module_data = system_rebuild_module_data();
    return $module_data[$module]->info['name'];
  }
706

707
}