module.inc 35.3 KB
Newer Older
1 2
<?php

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

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

32

33
/**
34 35 36 37 38 39 40 41
 * 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.
42 43
 *
 * @param $refresh
44 45 46 47 48 49 50 51
 *   (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.
52
 * @param $sort
53 54
 *   (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.
55
 * @param $fixed_list
56 57 58 59 60
 *   (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).
61
 *
62
 * @return
63 64
 *   An associative array whose keys and values are the names of the modules in
 *   the list.
65
 */
66
function module_list($refresh = FALSE, $bootstrap_refresh = FALSE, $sort = FALSE, $fixed_list = NULL) {
67
  static $list = array(), $sorted_list;
68

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

104 105 106 107
/**
 * Build a list of bootstrap modules and enabled modules and themes.
 *
 * @param $type
108 109 110 111
 *   The type of list to return:
 *   - module_enabled: All enabled modules.
 *   - bootstrap: All enabled modules required for bootstrap.
 *   - theme: All themes.
112 113
 *
 * @return
114 115 116 117
 *   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.
118 119 120 121 122 123 124
 *
 * @see module_list()
 * @see list_themes()
 */
function system_list($type) {
  $lists = &drupal_static(__FUNCTION__);

125 126 127 128
  // 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') {
129 130 131
    if (isset($lists['bootstrap'])) {
      return $lists['bootstrap'];
    }
132
    if ($cached = cache('bootstrap')->get('bootstrap_modules')) {
133 134 135 136
      $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');
137
      cache('bootstrap')->set('bootstrap_modules', $bootstrap_list);
138
    }
139
    // To avoid a separate database lookup for the filepath, prime the
140 141
    // drupal_get_filename() static cache for bootstrap modules only.
    // The rest is stored separately to keep the bootstrap module cache small.
142 143 144 145 146 147 148 149
    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.
150
  elseif (!isset($lists['module_enabled'])) {
151
    if ($cached = cache('bootstrap')->get('system_list')) {
152 153 154 155 156 157 158 159 160 161 162 163 164
      $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().
165
      $result = db_query("SELECT * FROM {system} WHERE type = 'theme' OR (type = 'module' AND status = 1) ORDER BY weight ASC, name ASC");
166
      foreach ($result as $record) {
167 168 169 170
        $record->info = unserialize($record->info);
        // Build a list of all enabled modules.
        if ($record->type == 'module') {
          $lists['module_enabled'][$record->name] = $record;
171 172 173 174 175 176 177 178 179
        }
        // 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);
        }
180
      }
181
      cache('bootstrap')->set('system_list', $lists);
182
    }
183
    // To avoid a separate database lookup for the filepath, prime the
184 185 186
    // 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']);
187 188 189 190 191 192
    }
  }

  return $lists[$type];
}

193 194 195 196 197
/**
 * Reset all system_list() caches.
 */
function system_list_reset() {
  drupal_static_reset('system_list');
198
  drupal_static_reset('system_rebuild_module_data');
199
  drupal_static_reset('list_themes');
200
  cache('bootstrap')->deleteMultiple(array('bootstrap_modules', 'system_list'));
201 202
}

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

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

Steven Wittens's avatar
Steven Wittens committed
250 251
/**
 * Load a module's installation hooks.
252 253 254 255 256 257
 *
 * @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
258 259 260
 */
function module_load_install($module) {
  // Make sure the installation API is available
261
  include_once DRUPAL_ROOT . '/includes/install.inc';
Steven Wittens's avatar
Steven Wittens committed
262

263
  return module_load_include('install', $module);
264 265 266 267
}

/**
 * Load a module include file.
268
 *
269 270
 * Examples:
 * @code
271
 *   // Load node.admin.inc from the node module.
272
 *   module_load_include('inc', 'node', 'node.admin');
273
 *   // Load content_types.inc from the node module.
274
 *   module_load_include('inc', 'node', 'content_types');
275
 * @endcode
276
 *
277 278 279
 * 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'
280 281
 * instead.
 *
282 283 284 285 286
 * @param $type
 *   The include file's type (file extension).
 * @param $module
 *   The module to which the include file belongs.
 * @param $name
287 288
 *   (optional) The base file name (without the $type extension). If omitted,
 *   $module is used; i.e., resulting in "$module.$type" by default.
289 290 291
 *
 * @return
 *   The name of the included file, if successful; FALSE otherwise.
292 293
 */
function module_load_include($type, $module, $name = NULL) {
294
  if (!isset($name)) {
295 296 297
    $name = $module;
  }

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

/**
 * 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
316 317 318 319
  }
}

/**
320
 * Enables or installs a given list of modules.
Steven Wittens's avatar
Steven Wittens committed
321
 *
322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338
 * 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().
339
 *
340 341
 * @param $module_list
 *   An array of module names.
342 343 344 345
 * @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.
346
 *
347 348
 * @return
 *   FALSE if one or more dependencies are missing, TRUE otherwise.
349 350 351 352 353
 *
 * @see hook_install()
 * @see hook_enable()
 * @see hook_modules_installed()
 * @see hook_modules_enabled()
Steven Wittens's avatar
Steven Wittens committed
354
 */
355
function module_enable($module_list, $enable_dependencies = TRUE) {
356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375
  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.
376
      foreach (array_keys($module_data[$module]->requires) as $dependency) {
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392
        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);
  }

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

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

      // 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.
413 414 415 416 417
      db_update('system')
        ->fields(array('status' => 1))
        ->condition('type', 'module')
        ->condition('name', $module)
        ->execute();
418
      // Refresh the module list to include it.
419
      system_list_reset();
420
      module_list(TRUE);
421
      module_implements_reset();
422 423 424 425 426
      _system_update_bootstrap_status();
      // Update the registry to include it.
      registry_update();
      // Refresh the schema to include it.
      drupal_get_schema(NULL, TRUE);
427 428 429

      // Allow modules to react prior to the installation of a module.
      module_invoke_all('modules_preinstall', array($module));
430 431 432 433

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

        // Set the schema version to the number of the last update provided
        // by the module.
437
        $versions = drupal_get_schema_versions($module);
438 439 440 441 442 443 444 445 446
        $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);
447 448
        // Allow the module to perform install tasks.
        module_invoke($module, 'install');
449 450
        // Record the fact that it was installed.
        $modules_installed[] = $module;
451
        watchdog('system', '%module module installed.', array('%module' => $module), WATCHDOG_INFO);
452
      }
453

454 455 456
      // Allow modules to react prior to the enabling of a module.
      module_invoke_all('modules_preenable', array($module));

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

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

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

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

  return TRUE;
Steven Wittens's avatar
Steven Wittens committed
477 478 479
}

/**
480
 * Disable a given set of modules.
Steven Wittens's avatar
Steven Wittens committed
481
 *
482 483
 * @param $module_list
 *   An array of module names.
484 485 486 487
 * @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
488
 */
489 490 491 492 493 494 495
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));

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

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

519
  $invoke_modules = array();
520

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

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

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

553
  // If there remains no more node_access module, rebuilding will be
554 555 556 557
  // 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
558 559
}

560 561
/**
 * @defgroup hooks Hooks
562 563
 * @{
 * Allow modules to interact with the Drupal core.
564 565
 *
 * Drupal's module system is based on the concept of "hooks". A hook is a PHP
566 567 568
 * 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.
569
 *
570 571 572
 * 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.
573 574 575
 *
 * 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
576 577 578
 * 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().
579
 *
580 581 582 583
 * 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.
 *
584
 * See also @link themeable the themeable group page. @endlink
585 586 587 588 589 590 591 592 593
 */

/**
 * 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").
594
 *
595 596 597 598 599
 * @return
 *   TRUE if the module is both installed and enabled, and the hook is
 *   implemented in that module.
 */
function module_hook($module, $hook) {
600 601 602 603 604 605 606 607 608 609 610 611 612 613
  $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;
614 615
}

616 617 618 619
/**
 * Determine which modules are implementing a hook.
 *
 * @param $hook
620
 *   The name of the hook (e.g. "help" or "menu").
621
 * @param $sort
622 623
 *   By default, modules are ordered by weight and filename, settings this option
 *   to TRUE, module list will be ordered by module name.
624
 *
625 626
 * @return
 *   An array with the names of the modules which are implementing this hook.
627
 *
628
 * @see module_implements_write_cache()
629
 */
630
function module_implements($hook, $sort = FALSE) {
631
  // Use the advanced drupal_static() pattern, since this is called very often.
632 633 634 635 636
  static $drupal_static_fast;
  if (!isset($drupal_static_fast)) {
    $drupal_static_fast['implementations'] = &drupal_static(__FUNCTION__);
  }
  $implementations = &$drupal_static_fast['implementations'];
637

638 639
  // Fetch implementations from cache.
  if (empty($implementations)) {
640
    $implementations = cache('bootstrap')->get('module_implements');
641 642 643 644 645 646 647 648
    if ($implementations === FALSE) {
      $implementations = array();
    }
    else {
      $implementations = $implementations->data;
    }
  }

649
  if (!isset($implementations[$hook])) {
650 651 652
    // 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;
653
    $hook_info = module_hook_info();
654 655 656
    $implementations[$hook] = array();
    $list = module_list(FALSE, FALSE, $sort);
    foreach ($list as $module) {
657
      $include_file = isset($hook_info[$hook]['group']) && module_load_include('inc', $module, $module . '.' . $hook_info[$hook]['group']);
658 659 660
      // Since module_hook() may needlessly try to load the include file again,
      // function_exists() is used directly here.
      if (function_exists($module . '_' . $hook)) {
661
        $implementations[$hook][$module] = $include_file ? $hook_info[$hook]['group'] : FALSE;
662 663
      }
    }
664 665 666 667 668
    // 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);
    }
669 670
  }
  else {
671 672 673 674 675 676
    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");
      }
677
      // It is possible that a module removed a hook implementation without the
678 679 680 681 682
      // 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)) {
683 684 685 686
        // 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;
687 688
      }
    }
689
  }
690

691
  return array_keys($implementations[$hook]);
692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712
}

/**
 * Regenerate the stored list of hook implementations.
 */
function module_implements_reset() {
  // 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.
  drupal_static_reset('module_implements');
  cache('bootstrap')->set('module_implements', array());
  drupal_static_reset('module_hook_info');
  drupal_static_reset('drupal_alter');
  cache('bootstrap')->delete('hook_info');
713 714 715 716 717 718
}

/**
 * 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('bootstrap')->get('hook_info');
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('bootstrap')->set('hook_info', $hook_info);
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('bootstrap')->set('module_implements', $implementations);
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
function module_invoke($module, $hook) {
791
  $args = func_get_args();
792
  // Remove $module and $hook from the arguments.
793
  unset($args[0], $args[1]);
794
  if (module_hook($module, $hook)) {
795
    return call_user_func_array($module . '_' . $hook, $args);
796 797
  }
}
798

799 800 801 802 803 804 805
/**
 * 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.
806
 *
807 808 809 810
 * @return
 *   An array of return values of the hook implementations. If modules return
 *   arrays from their implementations, those are merged into one array.
 */
811
function module_invoke_all($hook) {
812
  $args = func_get_args();
813
  // Remove $hook from the arguments.
814
  unset($args[0]);
815
  $return = array();
816
  foreach (module_implements($hook) as $module) {
817
    $function = $module . '_' . $hook;
818
    if (function_exists($function)) {
819 820 821 822
      $result = call_user_func_array($function, $args);
      if (isset($result) && is_array($result)) {
        $return = array_merge_recursive($return, $result);
      }
823
      elseif (isset($result)) {
824 825
        $return[] = $result;
      }
826
    }
827 828 829 830 831 832
  }

  return $return;
}

/**
833
 * @} End of "defgroup hooks".
834 835
 */

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

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

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

853
  return $required;
854
}
855 856 857 858

/**
 * Hands off alterable variables to type-specific *_alter implementations.
 *
859
 * This dispatch function hands off the passed-in variables to type-specific
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
 * 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
886
 *   A string describing the type of the alterable $data. 'form', 'links',
887 888 889 890 891 892
 *   '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.
893
 * @param $data
894 895 896 897
 *   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.
898
 * @param $context1
899
 *   (optional) An additional variable that is passed by reference.
900
 * @param $context2
901 902
 *   (optional) An additional variable that is passed by reference. If more
 *   context needs to be provided to implementations, then this should be an
903
 *   associative array as described above.
904 905 906 907 908 909 910 911 912
 */
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'];

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

932 933 934
  // 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.
935 936
  if (!isset($functions[$cid])) {
    $functions[$cid] = array();
937
    $hook = $type . '_alter';
938 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
    $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;
          }
        }
      }
976 977 978 979 980 981 982 983 984 985 986 987 988
    }
    // 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)) {
989 990 991 992 993 994 995 996 997
          $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;
            }
          }
998 999 1000 1001
        }
      }
    }
  }
1002 1003

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