module.inc 35.3 KB
Newer Older
1 2 3
<?php
// $Id$

4 5 6 7 8
/**
 * @file
 * API for loading and interacting with Drupal modules.
 */

9
/**
10
 * Load all the modules that have been enabled in the system table.
11
 *
12 13 14
 * @param $bootstrap
 *   Whether to load only the reduced set of modules loaded in "bootstrap mode"
 *   for cached pages. See bootstrap.inc.
15
 *
16 17 18
 * @return
 *   If $bootstrap is NULL, return a boolean indicating whether all modules
 *   have been loaded.
19
 */
20
function module_load_all($bootstrap = FALSE) {
21 22 23 24 25 26 27 28
  static $has_run = FALSE;

  if (isset($bootstrap)) {
    foreach (module_list(TRUE, $bootstrap) as $module) {
      drupal_load('module', $module);
    }
    // $has_run will be TRUE if $bootstrap is FALSE.
    $has_run = !$bootstrap;
29
  }
30
  return $has_run;
31 32
}

33

34
/**
35 36 37 38 39 40 41 42
 * Returns a list of currently active modules.
 *
 * Usually, this returns a list of all enabled modules. When called early on in
 * the bootstrap, it will return a list of vital modules only (those needed to
 * generate cached pages).
 *
 * All parameters to this function are optional and should generally not be
 * changed from their defaults.
43 44
 *
 * @param $refresh
45 46 47 48 49 50 51 52
 *   (optional) Whether to force the module list to be regenerated (such as
 *   after the administrator has changed the system settings). Defaults to
 *   FALSE.
 * @param $bootstrap_refresh
 *   (optional) When $refresh is TRUE, setting $bootstrap_refresh to TRUE forces
 *   the module list to be regenerated using the reduced set of modules loaded
 *   in "bootstrap mode" for cached pages. Otherwise, setting $refresh to TRUE
 *   generates the complete list of enabled modules.
53
 * @param $sort
54 55
 *   (optional) By default, modules are ordered by weight and module name. Set
 *   this option to TRUE to return a module list ordered only by module name.
56
 * @param $fixed_list
57 58 59 60 61
 *   (optional) If an array of module names is provided, this will override the
 *   module list with the given set of modules. This will persist until the next
 *   call with $refresh set to TRUE or with a new $fixed_list passed in. This
 *   parameter is primarily intended for internal use (e.g., in install.php and
 *   update.php).
62
 *
63
 * @return
64 65
 *   An associative array whose keys and values are the names of the modules in
 *   the list.
66
 */
67
function module_list($refresh = FALSE, $bootstrap_refresh = FALSE, $sort = FALSE, $fixed_list = NULL) {
68
  static $list = array(), $sorted_list;
69

70
  if (empty($list) || $refresh || $fixed_list) {
Dries's avatar
Dries committed
71
    $list = array();
72
    $sorted_list = NULL;
73 74 75 76 77
    if ($fixed_list) {
      foreach ($fixed_list as $name => $module) {
        drupal_get_filename('module', $name, $module['filename']);
        $list[$name] = $name;
      }
78 79
    }
    else {
80 81 82 83 84
      if ($refresh) {
        // For the $refresh case, make sure that system_list() returns fresh
        // data.
        drupal_static_reset('system_list');
      }
85
      if ($bootstrap_refresh) {
86
        $list = system_list('bootstrap');
87 88
      }
      else {
89 90 91
        // Not using drupal_map_assoc() here as that requires common.inc.
        $list = array_keys(system_list('module_enabled'));
        $list = (!empty($list) ? array_combine($list, $list) : array());
92
      }
93 94
    }
  }
95 96 97 98 99 100 101
  if ($sort) {
    if (!isset($sorted_list)) {
      $sorted_list = $list;
      ksort($sorted_list);
    }
    return $sorted_list;
  }
102 103 104
  return $list;
}

105 106 107 108
/**
 * Build a list of bootstrap modules and enabled modules and themes.
 *
 * @param $type
109 110 111 112
 *   The type of list to return:
 *   - module_enabled: All enabled modules.
 *   - bootstrap: All enabled modules required for bootstrap.
 *   - theme: All themes.
113 114
 *
 * @return
115 116 117 118
 *   An associative array of modules or themes, keyed by name. For $type
 *   'bootstrap', the array values equal the keys. For $type 'module_enabled'
 *   or 'theme', the array values are objects representing the respective
 *   database row, with the 'info' property already unserialized.
119 120 121 122 123 124 125
 *
 * @see module_list()
 * @see list_themes()
 */
function system_list($type) {
  $lists = &drupal_static(__FUNCTION__);

126 127 128 129
  // For bootstrap modules, attempt to fetch the list from cache if possible.
  // if not fetch only the required information to fire bootstrap hooks
  // in case we are going to serve the page from cache.
  if ($type == 'bootstrap') {
130 131 132
    if (isset($lists['bootstrap'])) {
      return $lists['bootstrap'];
    }
133 134 135 136 137
    if ($cached = cache_get('bootstrap_modules', 'cache_bootstrap')) {
      $bootstrap_list = $cached->data;
    }
    else {
      $bootstrap_list = db_query("SELECT name, filename FROM {system} WHERE status = 1 AND bootstrap = 1 AND type = 'module' ORDER BY weight ASC, name ASC")->fetchAllAssoc('name');
138
      cache_set('bootstrap_modules', $bootstrap_list, 'cache_bootstrap');
139
    }
140
    // To avoid a separate database lookup for the filepath, prime the
141 142
    // drupal_get_filename() static cache for bootstrap modules only.
    // The rest is stored separately to keep the bootstrap module cache small.
143 144 145 146 147 148 149 150
    foreach ($bootstrap_list as $module) {
      drupal_get_filename('module', $module->name, $module->filename);
    }
    // We only return the module names here since module_list() doesn't need
    // the filename itself.
    $lists['bootstrap'] = array_keys($bootstrap_list);
  }
  // Otherwise build the list for enabled modules and themes.
151
  elseif (!isset($lists['module_enabled'])) {
152 153 154 155 156 157 158 159 160 161 162 163 164 165
    if ($cached = cache_get('system_list', 'cache_bootstrap')) {
      $lists = $cached->data;
    }
    else {
      $lists = array(
        'module_enabled' => array(),
        'theme' => array(),
        'filepaths' => array(),
      );
      // The module name (rather than the filename) is used as the fallback
      // weighting in order to guarantee consistent behavior across different
      // Drupal installations, which might have modules installed in different
      // locations in the file system. The ordering here must also be
      // consistent with the one used in module_implements().
166
      $result = db_query("SELECT * FROM {system} WHERE type = 'theme' OR (type = 'module' AND status = 1) ORDER BY weight ASC, name ASC");
167
      foreach ($result as $record) {
168 169 170 171
        $record->info = unserialize($record->info);
        // Build a list of all enabled modules.
        if ($record->type == 'module') {
          $lists['module_enabled'][$record->name] = $record;
172 173 174 175 176 177 178 179 180
        }
        // Build a list of themes.
        if ($record->type == 'theme') {
          $lists['theme'][$record->name] = $record;
        }
        // Build a list of filenames so drupal_get_filename can use it.
        if ($record->status) {
          $lists['filepaths'][] = array('type' => $record->type, 'name' => $record->name, 'filepath' => $record->filename);
        }
181
      }
182 183
      cache_set('system_list', $lists, 'cache_bootstrap');
    }
184
    // To avoid a separate database lookup for the filepath, prime the
185 186 187
    // drupal_get_filename() static cache with all enabled modules and themes.
    foreach ($lists['filepaths'] as $item) {
      drupal_get_filename($item['type'], $item['name'], $item['filepath']);
188 189 190 191 192 193
    }
  }

  return $lists[$type];
}

194 195 196 197 198
/**
 * Reset all system_list() caches.
 */
function system_list_reset() {
  drupal_static_reset('system_list');
199
  drupal_static_reset('system_rebuild_module_data');
200
  drupal_static_reset('list_themes');
201
  cache_clear_all('bootstrap_modules', 'cache_bootstrap');
202
  cache_clear_all('system_list', 'cache_bootstrap');
203 204
}

205
/**
206
 * Find dependencies any level deep and fill in required by information too.
207 208 209
 *
 * @param $files
 *   The array of filesystem objects used to rebuild the cache.
210
 *
211
 * @return
212 213 214 215 216
 *   The same array with the new keys for each module:
 *   - requires: An array with the keys being the modules that this module
 *     requires.
 *   - required_by: An array with the keys being the modules that will not work
 *     without this module.
217
 */
218
function _module_build_dependencies($files) {
219
  require_once DRUPAL_ROOT . '/includes/graph.inc';
220 221 222
  foreach ($files as $filename => $file) {
    $graph[$file->name]['edges'] = array();
    if (isset($file->info['dependencies']) && is_array($file->info['dependencies'])) {
223 224 225
      foreach ($file->info['dependencies'] as $dependency) {
        $dependency_data = drupal_parse_dependency($dependency);
        $graph[$file->name]['edges'][$dependency_data['name']] = $dependency_data;
226 227
      }
    }
228
  }
229
  drupal_depth_first_search($graph);
230
  foreach ($graph as $module => $data) {
231
    $files[$module]->required_by = isset($data['reverse_paths']) ? $data['reverse_paths'] : array();
232 233 234
    $files[$module]->requires = isset($data['paths']) ? $data['paths'] : array();
    $files[$module]->sort = $data['weight'];
  }
Steven Wittens's avatar
Steven Wittens committed
235 236 237
  return $files;
}

238 239 240 241 242
/**
 * Determine whether a given module exists.
 *
 * @param $module
 *   The name of the module (without the .module extension).
243
 *
244 245 246
 * @return
 *   TRUE if the module is both installed and enabled.
 */
247
function module_exists($module) {
248
  $list = module_list();
249
  return isset($list[$module]);
250 251
}

Steven Wittens's avatar
Steven Wittens committed
252 253
/**
 * Load a module's installation hooks.
254 255 256 257 258 259
 *
 * @param $module
 *   The name of the module (without the .module extension).
 *
 * @return
 *   The name of the module's install file, if successful; FALSE otherwise.
Steven Wittens's avatar
Steven Wittens committed
260 261 262
 */
function module_load_install($module) {
  // Make sure the installation API is available
263
  include_once DRUPAL_ROOT . '/includes/install.inc';
Steven Wittens's avatar
Steven Wittens committed
264

265
  return module_load_include('install', $module);
266 267 268 269
}

/**
 * Load a module include file.
270
 *
271 272
 * Examples:
 * @code
273
 *   // Load node.admin.inc from the node module.
274
 *   module_load_include('inc', 'node', 'node.admin');
275
 *   // Load content_types.inc from the node module.
276
 *   module_load_include('inc', 'node', 'content_types');
277
 * @endcode
278
 *
279 280 281
 * Do not use this function to load an install file, use module_load_install()
 * instead. Do not use this function in a global context since it requires
 * Drupal to be fully bootstrapped, use require_once DRUPAL_ROOT . '/path/file'
282 283
 * instead.
 *
284 285 286 287 288
 * @param $type
 *   The include file's type (file extension).
 * @param $module
 *   The module to which the include file belongs.
 * @param $name
289 290
 *   (optional) The base file name (without the $type extension). If omitted,
 *   $module is used; i.e., resulting in "$module.$type" by default.
291 292 293
 *
 * @return
 *   The name of the included file, if successful; FALSE otherwise.
294 295
 */
function module_load_include($type, $module, $name = NULL) {
296
  if (!isset($name)) {
297 298 299
    $name = $module;
  }

300
  if (function_exists('drupal_get_path')) {
301 302 303 304 305
    $file = DRUPAL_ROOT . '/' . drupal_get_path('module', $module) . "/$name.$type";
    if (is_file($file)) {
      require_once $file;
      return $file;
    }
306
  }
307
  return FALSE;
308 309 310 311 312 313 314 315 316 317
}

/**
 * Load an include file for each of the modules that have been enabled in
 * the system table.
 */
function module_load_all_includes($type, $name = NULL) {
  $modules = module_list();
  foreach ($modules as $module) {
    module_load_include($type, $module, $name);
Steven Wittens's avatar
Steven Wittens committed
318 319 320 321
  }
}

/**
322
 * Enables or installs a given list of modules.
Steven Wittens's avatar
Steven Wittens committed
323
 *
324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340
 * Definitions:
 * - "Enabling" is the process of activating a module for use by Drupal.
 * - "Disabling" is the process of deactivating a module.
 * - "Installing" is the process of enabling it for the first time or after it
 *   has been uninstalled.
 * - "Uninstalling" is the process of removing all traces of a module.
 *
 * Order of events:
 * - Gather and add module dependencies to $module_list (if applicable).
 * - For each module that is being enabled:
 *   - Install module schema and update system registries and caches.
 *   - If the module is being enabled for the first time or had been
 *     uninstalled, invoke hook_install() and add it to the list of installed
 *     modules.
 *   - Invoke hook_enable().
 * - Invoke hook_modules_installed().
 * - Invoke hook_modules_enabled().
341
 *
342 343
 * @param $module_list
 *   An array of module names.
344 345 346 347
 * @param $enable_dependencies
 *   If TRUE, dependencies will automatically be added and enabled in the
 *   correct order. This incurs a significant performance cost, so use FALSE
 *   if you know $module_list is already complete and in the correct order.
348
 *
349 350
 * @return
 *   FALSE if one or more dependencies are missing, TRUE otherwise.
351 352 353 354 355
 *
 * @see hook_install()
 * @see hook_enable()
 * @see hook_modules_installed()
 * @see hook_modules_enabled()
Steven Wittens's avatar
Steven Wittens committed
356
 */
357
function module_enable($module_list, $enable_dependencies = TRUE) {
358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377
  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.
378
      foreach (array_keys($module_data[$module]->requires) as $dependency) {
379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394
        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);
  }

395
  // Required for module installation checks.
396
  include_once DRUPAL_ROOT . '/includes/install.inc';
397 398 399

  $modules_installed = array();
  $modules_enabled = array();
400
  foreach ($module_list as $module) {
401
    // Only process modules that are not already enabled.
402 403 404 405
    $existing = db_query("SELECT status FROM {system} WHERE type = :type AND name = :name", array(
      ':type' => 'module',
      ':name' => $module))
      ->fetchObject();
406
    if ($existing->status == 0) {
407 408
      // Load the module's code.
      drupal_load('module', $module);
409
      module_load_install($module);
410 411 412 413 414

      // Update the database and module list to reflect the new module. This
      // needs to be done first so that the module's hook implementations,
      // hook_schema() in particular, can be called while it is being
      // installed.
415 416 417 418 419
      db_update('system')
        ->fields(array('status' => 1))
        ->condition('type', 'module')
        ->condition('name', $module)
        ->execute();
420
      // Refresh the module list to include it.
421
      system_list_reset();
422 423 424 425 426 427 428
      module_list(TRUE);
      module_implements('', FALSE, TRUE);
      _system_update_bootstrap_status();
      // Update the registry to include it.
      registry_update();
      // Refresh the schema to include it.
      drupal_get_schema(NULL, TRUE);
429 430
      // Clear entity cache.
      entity_info_cache_clear();
431 432 433 434

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

        // Set the schema version to the number of the last update provided
        // by the module.
438
        $versions = drupal_get_schema_versions($module);
439 440 441 442 443 444 445 446 447
        $version = $versions ? max($versions) : SCHEMA_INSTALLED;

        // 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 = module_invoke($module, 'update_last_removed')) {
          $version = max($version, $last_removed);
        }
        drupal_set_installed_schema_version($module, $version);
448 449
        // Allow the module to perform install tasks.
        module_invoke($module, 'install');
450 451
        // Record the fact that it was installed.
        $modules_installed[] = $module;
452
        watchdog('system', '%module module installed.', array('%module' => $module), WATCHDOG_INFO);
453
      }
454

455 456 457 458 459 460
      // Enable the module.
      module_invoke($module, 'enable');

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

464
  // If any modules were newly installed, invoke hook_modules_installed().
465
  if (!empty($modules_installed)) {
466
    module_invoke_all('modules_installed', $modules_installed);
Steven Wittens's avatar
Steven Wittens committed
467
  }
468

469 470 471
  // If any modules were newly enabled, invoke hook_modules_enabled().
  if (!empty($modules_enabled)) {
    module_invoke_all('modules_enabled', $modules_enabled);
472
  }
473 474

  return TRUE;
Steven Wittens's avatar
Steven Wittens committed
475 476 477
}

/**
478
 * Disable a given set of modules.
Steven Wittens's avatar
Steven Wittens committed
479
 *
480 481
 * @param $module_list
 *   An array of module names.
482 483 484 485
 * @param $disable_dependents
 *   If TRUE, dependent modules will automatically be added and disabled in the
 *   correct order. This incurs a significant performance cost, so use FALSE
 *   if you know $module_list is already complete and in the correct order.
Steven Wittens's avatar
Steven Wittens committed
486
 */
487 488 489 490 491 492 493
function module_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));

494
    $profile = drupal_get_profile();
495 496 497 498 499 500 501 502 503 504 505
    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) {
506
        if (!isset($module_list[$dependent]) && $dependent != $profile) {
507 508 509 510 511 512 513 514 515 516
          $module_list[$dependent] = 0;
        }
      }
    }

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

517
  $invoke_modules = array();
518

519 520
  foreach ($module_list as $module) {
    if (module_exists($module)) {
521 522 523 524 525
      // Check if node_access table needs rebuilding.
      if (!node_access_needs_rebuild() && module_hook($module, 'node_grants')) {
        node_access_needs_rebuild(TRUE);
      }

526 527
      module_load_install($module);
      module_invoke($module, 'disable');
528 529 530 531 532
      db_update('system')
        ->fields(array('status' => 0))
        ->condition('type', 'module')
        ->condition('name', $module)
        ->execute();
533
      $invoke_modules[] = $module;
534
      watchdog('system', '%module module disabled.', array('%module' => $module), WATCHDOG_INFO);
535
    }
Steven Wittens's avatar
Steven Wittens committed
536
  }
537 538

  if (!empty($invoke_modules)) {
539
    // Refresh the module list to exclude the disabled modules.
540
    system_list_reset();
541 542
    module_list(TRUE);
    module_implements('', FALSE, TRUE);
543
    // Invoke hook_modules_disabled before disabling modules,
544 545
    // so we can still call module hooks to get information.
    module_invoke_all('modules_disabled', $invoke_modules);
546 547
    // Update the registry to remove the newly-disabled module.
    registry_update();
548
    _system_update_bootstrap_status();
Steven Wittens's avatar
Steven Wittens committed
549
  }
550

551
  // If there remains no more node_access module, rebuilding will be
552 553 554 555
  // straightforward, we can do it right now.
  if (node_access_needs_rebuild() && count(module_implements('node_grants')) == 0) {
    node_access_rebuild();
  }
Steven Wittens's avatar
Steven Wittens committed
556 557
}

558 559
/**
 * @defgroup hooks Hooks
Dries's avatar
 
Dries committed
560 561
 * @{
 * Allow modules to interact with the Drupal core.
562 563
 *
 * Drupal's module system is based on the concept of "hooks". A hook is a PHP
564 565 566
 * function that is named foo_bar(), where "foo" is the name of the module
 * (whose filename is thus foo.module) and "bar" is the name of the hook. Each
 * hook has a defined set of parameters and a specified result type.
567
 *
568 569 570
 * To extend Drupal, a module need simply implement a hook. When Drupal wishes
 * to allow intervention from modules, it determines which modules implement a
 * hook and calls that hook in all enabled modules that implement it.
571 572 573
 *
 * The available hooks to implement are explained here in the Hooks section of
 * the developer documentation. The string "hook" is used as a placeholder for
574 575 576
 * the module name in the hook definitions. For example, if the module file is
 * called example.module, then hook_help() as implemented by that module would
 * be defined as example_help().
577
 *
578 579 580 581
 * The example functions included are not part of the Drupal core, they are
 * just models that you can modify. Only the hooks implemented within modules
 * are executed when running Drupal.
 *
582
 * See also @link themeable the themeable group page. @endlink
583 584 585 586 587 588 589 590 591
 */

/**
 * Determine whether a module implements a hook.
 *
 * @param $module
 *   The name of the module (without the .module extension).
 * @param $hook
 *   The name of the hook (e.g. "help" or "menu").
592
 *
593 594 595 596 597
 * @return
 *   TRUE if the module is both installed and enabled, and the hook is
 *   implemented in that module.
 */
function module_hook($module, $hook) {
598 599 600 601 602 603 604 605 606 607 608 609 610 611
  $function = $module . '_' . $hook;
  if (function_exists($function)) {
    return TRUE;
  }
  // If the hook implementation does not exist, check whether it may live in an
  // optional include file registered via hook_hook_info().
  $hook_info = module_hook_info();
  if (isset($hook_info[$hook]['group'])) {
    module_load_include('inc', $module, $module . '.' . $hook_info[$hook]['group']);
    if (function_exists($function)) {
      return TRUE;
    }
  }
  return FALSE;
612 613
}

Dries's avatar
 
Dries committed
614 615 616 617
/**
 * Determine which modules are implementing a hook.
 *
 * @param $hook
618
 *   The name of the hook (e.g. "help" or "menu").
619
 * @param $sort
620 621
 *   By default, modules are ordered by weight and filename, settings this option
 *   to TRUE, module list will be ordered by module name.
622
 * @param $reset
623 624 625
 *   For internal use only: Whether to force the stored list of hook
 *   implementations to be regenerated (such as after enabling a new module,
 *   before processing hook_enable).
626
 *
Dries's avatar
 
Dries committed
627 628
 * @return
 *   An array with the names of the modules which are implementing this hook.
629
 *
630
 * @see module_implements_write_cache()
Dries's avatar
 
Dries committed
631
 */
632
function module_implements($hook, $sort = FALSE, $reset = FALSE) {
633
  // Use the advanced drupal_static() pattern, since this is called very often.
634 635 636 637 638
  static $drupal_static_fast;
  if (!isset($drupal_static_fast)) {
    $drupal_static_fast['implementations'] = &drupal_static(__FUNCTION__);
  }
  $implementations = &$drupal_static_fast['implementations'];
639

640 641 642 643 644 645 646 647 648 649 650
  // 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
  // cache_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 module_hook() being called several thousand times
  // per request.
  if ($reset) {
651
    $implementations = array();
652
    cache_set('module_implements', array(), 'cache_bootstrap');
653
    drupal_static_reset('module_hook_info');
654
    drupal_static_reset('drupal_alter');
655
    cache_clear_all('hook_info', 'cache_bootstrap');
656
    return;
657 658
  }

659 660
  // Fetch implementations from cache.
  if (empty($implementations)) {
661
    $implementations = cache_get('module_implements', 'cache_bootstrap');
662 663 664 665 666 667 668 669
    if ($implementations === FALSE) {
      $implementations = array();
    }
    else {
      $implementations = $implementations->data;
    }
  }

670
  if (!isset($implementations[$hook])) {
671 672 673
    // The hook is not cached, so ensure that whether or not it has
    // implementations, that the cache is updated at the end of the request.
    $implementations['#write_cache'] = TRUE;
674
    $hook_info = module_hook_info();
675 676 677
    $implementations[$hook] = array();
    $list = module_list(FALSE, FALSE, $sort);
    foreach ($list as $module) {
678
      $include_file = isset($hook_info[$hook]['group']) && module_load_include('inc', $module, $module . '.' . $hook_info[$hook]['group']);
679 680 681
      // Since module_hook() may needlessly try to load the include file again,
      // function_exists() is used directly here.
      if (function_exists($module . '_' . $hook)) {
682
        $implementations[$hook][$module] = $include_file ? $hook_info[$hook]['group'] : FALSE;
683 684
      }
    }
685 686 687 688 689
    // Allow modules to change the weight of specific implementations but avoid
    // an infinite loop.
    if ($hook != 'module_implements_alter') {
      drupal_alter('module_implements', $implementations[$hook], $hook);
    }
690 691
  }
  else {
692 693 694 695 696 697
    foreach ($implementations[$hook] as $module => $group) {
      // If this hook implementation is stored in a lazy-loaded file, so include
      // that file first.
      if ($group) {
        module_load_include('inc', $module, "$module.$group");
      }
698
      // It is possible that a module removed a hook implementation without the
699 700 701 702 703
      // implementations cache being rebuilt yet, so we check whether the
      // function exists on each request to avoid undefined function errors.
      // Since module_hook() may needlessly try to load the include file again,
      // function_exists() is used directly here.
      if (!function_exists($module . '_' . $hook)) {
704 705 706 707
        // Clear out the stale implementation from the cache and force a cache
        // refresh to forget about no longer existing hook implementations.
        unset($implementations[$hook][$module]);
        $implementations['#write_cache'] = TRUE;
Dries's avatar
 
Dries committed
708 709
      }
    }
710
  }
Dries's avatar
 
Dries committed
711

712 713 714 715 716 717 718
  return array_keys($implementations[$hook]);
}

/**
 * Retrieve a list of what hooks are explicitly declared.
 */
function module_hook_info() {
719 720 721 722 723 724 725 726
  // This function is indirectly invoked from bootstrap_invoke_all(), in which
  // case common.inc, subsystems, and modules are not loaded yet, so it does not
  // make sense to support hook groups resp. lazy-loaded include files prior to
  // full bootstrap.
  if (drupal_bootstrap(NULL, FALSE) != DRUPAL_BOOTSTRAP_FULL) {
    return array();
  }
  $hook_info = &drupal_static(__FUNCTION__);
727

728 729
  if (!isset($hook_info)) {
    $hook_info = array();
730
    $cache = cache_get('hook_info', 'cache_bootstrap');
731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750
    if ($cache === FALSE) {
      // Rebuild the cache and save it.
      // We can't use module_invoke_all() here or it would cause an infinite
      // loop.
      foreach (module_list() as $module) {
        $function = $module . '_hook_info';
        if (function_exists($function)) {
          $result = $function();
          if (isset($result) && is_array($result)) {
            $hook_info = array_merge_recursive($hook_info, $result);
          }
        }
      }
      // We can't use drupal_alter() for the same reason as above.
      foreach (module_list() as $module) {
        $function = $module . '_hook_info_alter';
        if (function_exists($function)) {
          $function($hook_info);
        }
      }
751
      cache_set('hook_info', $hook_info, 'cache_bootstrap');
752 753 754 755 756 757 758
    }
    else {
      $hook_info = $cache->data;
    }
  }

  return $hook_info;
759 760
}

761 762 763 764 765 766 767
/**
 * Writes the hook implementation cache.
 *
 * @see module_implements()
 */
function module_implements_write_cache() {
  $implementations = &drupal_static('module_implements');
768 769 770 771
  // Check whether we need to write the cache. We do not want to cache hooks
  // which are only invoked on HTTP POST requests since these do not need to be
  // optimized as tightly, and not doing so keeps the cache entry smaller.
  if (isset($implementations['#write_cache']) && ($_SERVER['REQUEST_METHOD'] == 'GET' || $_SERVER['REQUEST_METHOD'] == 'HEAD')) {
772
    unset($implementations['#write_cache']);
773
    cache_set('module_implements', $implementations, 'cache_bootstrap');
774 775 776
  }
}

777 778 779 780 781 782 783 784 785
/**
 * Invoke a hook in a particular module.
 *
 * @param $module
 *   The name of the module (without the .module extension).
 * @param $hook
 *   The name of the hook to invoke.
 * @param ...
 *   Arguments to pass to the hook implementation.
786
 *
787 788 789
 * @return
 *   The return value of the hook implementation.
 */
790 791
function module_invoke() {
  $args = func_get_args();
792 793 794
  $module = $args[0];
  $hook = $args[1];
  unset($args[0], $args[1]);
795
  if (module_hook($module, $hook)) {
796
    return call_user_func_array($module . '_' . $hook, $args);
797 798
  }
}
799

800 801 802 803 804 805 806
/**
 * Invoke a hook in all enabled modules that implement it.
 *
 * @param $hook
 *   The name of the hook to invoke.
 * @param ...
 *   Arguments to pass to the hook.
807
 *
808 809 810 811
 * @return
 *   An array of return values of the hook implementations. If modules return
 *   arrays from their implementations, those are merged into one array.
 */
812 813
function module_invoke_all() {
  $args = func_get_args();
814 815
  $hook = $args[0];
  unset($args[0]);
816
  $return = array();
817
  foreach (module_implements($hook) as $module) {
818
    $function = $module . '_' . $hook;
819
    if (function_exists($function)) {
820 821 822 823
      $result = call_user_func_array($function, $args);
      if (isset($result) && is_array($result)) {
        $return = array_merge_recursive($return, $result);
      }
824
      elseif (isset($result)) {
825 826
        $return[] = $result;
      }
827
    }
828 829 830 831 832 833
  }

  return $return;
}

/**
Dries's avatar
 
Dries committed
834
 * @} End of "defgroup hooks".
835 836
 */

837 838 839 840
/**
 * Array of modules required by core.
 */
function drupal_required_modules() {
841
  $files = drupal_system_listing('/^' . DRUPAL_PHP_FUNCTION_PATTERN . '\.info$/', 'modules', 'name', 0);
842
  $required = array();
843 844 845 846

  // An install profile is required and one must always be loaded.
  $required[] = drupal_get_profile();

847
  foreach ($files as $name => $file) {
848
    $info = drupal_parse_info_file($file->uri);
849 850 851 852
    if (!empty($info) && !empty($info['required']) && $info['required']) {
      $required[] = $name;
    }
  }
853

854
  return $required;
855
}
856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886

/**
 * Hands off alterable variables to type-specific *_alter implementations.
 *
 * This dispatch function hands off the passed in variables to type-specific
 * hook_TYPE_alter() implementations in modules. It ensures a consistent
 * interface for all altering operations.
 *
 * A maximum of 2 alterable arguments is supported. In case more arguments need
 * to be passed and alterable, modules provide additional variables assigned by
 * reference in the last $context argument:
 * @code
 *   $context = array(
 *     'alterable' => &$alterable,
 *     'unalterable' => $unalterable,
 *     'foo' => 'bar',
 *   );
 *   drupal_alter('mymodule_data', $alterable1, $alterable2, $context);
 * @endcode
 *
 * Note that objects are always passed by reference in PHP5. If it is absolutely
 * required that no implementation alters a passed object in $context, then an
 * object needs to be cloned:
 * @code
 *   $context = array(
 *     'unalterable_object' => clone $object,
 *   );
 *   drupal_alter('mymodule_data', $data, $context);
 * @endcode
 *
 * @param $type
887
 *   A string describing the type of the alterable $data. 'form', 'links',
888 889 890 891 892 893
 *   'node_content', and so on are several examples. Alternatively can be an
 *   array, in which case hook_TYPE_alter() is invoked for each value in the
 *   array, ordered first by module, and then for each module, in the order of
 *   values in $type. For example, when Form API is using drupal_alter() to
 *   execute both hook_form_alter() and hook_form_FORM_ID_alter()
 *   implementations, it passes array('form', 'form_' . $form_id) for $type.
894
 * @param &$data
895 896 897 898
 *   The variable that will be passed to hook_TYPE_alter() implementations to be
 *   altered. The type of this variable depends on the value of the $type
 *   argument. For example, when altering a 'form', $data will be a structured
 *   array. When altering a 'profile', $data will be an object.
899 900 901 902 903
 * @param &$context1
 *   (optional) An additional variable that is passed by reference.
 * @param &$context2
 *   (optional) An additional variable that is passed by reference. If more
 *   context needs to be provided to implementations, then this should be an
904
 *   associative array as described above.
905 906 907 908 909 910 911 912 913
 */
function drupal_alter($type, &$data, &$context1 = NULL, &$context2 = NULL) {
  // Use the advanced drupal_static() pattern, since this is called very often.
  static $drupal_static_fast;
  if (!isset($drupal_static_fast)) {
    $drupal_static_fast['functions'] = &drupal_static(__FUNCTION__);
  }
  $functions = &$drupal_static_fast['functions'];

914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932
  // 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;
  }

933 934 935
  // Some alter hooks are invoked many times per page request, so statically
  // cache the list of functions to call, and on subsequent calls, iterate
  // through them quickly.
936 937
  if (!isset($functions[$cid])) {
    $functions[$cid] = array();
938
    $hook = $type . '_alter';
939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976
    $modules = module_implements($hook);
    if (!isset($extra_types)) {
      // For the more common case of a single hook, we do not need to call
      // function_exists(), since module_implements() returns only modules with
      // implementations.
      foreach ($modules as $module) {
        $functions[$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, module_implements($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.
      if (array_diff($extra_modules, $modules)) {
        // Order the modules by the order returned by module_list().
        $modules = array_intersect(module_list(), array_merge($modules, $extra_modules));
      }
      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)) {
          $functions[$cid][] = $function;
        }
        foreach ($extra_types as $extra_type) {
          $function = $module . '_' . $extra_type . '_alter';
          if (function_exists($function)) {
            $functions[$cid][] = $function;
          }
        }
      }
977 978 979 980 981 982 983 984 985 986 987 988 989
    }
    // 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)) {
990 991 992 993 994 995 996 997 998
          $functions[$cid][] = $function;
        }
        if (isset($extra_types)) {
          foreach ($extra_types as $extra_type) {
            $function = $theme_key . '_' . $extra_type . '_alter';
            if (function_exists($function)) {
              $functions[$cid][] = $function;
            }
          }
999 1000 1001 1002
        }
      }
    }
  }
1003 1004

  foreach ($functions[$cid] as $function) {
1005 1006 1007
    $function($data, $context1, $context2);
  }
}
1008