module.inc 24.8 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 15 16 17
 * @param $bootstrap
 *   Whether to load only the reduced set of modules loaded in "bootstrap mode"
 *   for cached pages. See bootstrap.inc.
 * @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
 * Collect a list of all loaded modules. During the bootstrap, return only
 * vital modules. See bootstrap.inc
36 37 38 39
 *
 * @param $refresh
 *   Whether to force the module list to be regenerated (such as after the
 *   administrator has changed the system settings).
40 41 42
 * @param $bootstrap
 *   Whether to return the reduced set of modules loaded in "bootstrap mode"
 *   for cached pages. See bootstrap.inc.
43
 * @param $sort
44 45
 *   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.
46 47 48
 * @param $fixed_list
 *   (Optional) Override the module list with the given modules. Stays until the
 *   next call with $refresh = TRUE.
49 50 51 52
 * @return
 *   An associative array whose keys and values are the names of all loaded
 *   modules.
 */
53
function module_list($refresh = FALSE, $bootstrap = FALSE, $sort = FALSE, $fixed_list = NULL) {
54
  static $list = array(), $sorted_list;
55

56
  if (empty($list) || $refresh || $fixed_list) {
Dries's avatar
Dries committed
57
    $list = array();
58
    $sorted_list = NULL;
59 60 61 62 63
    if ($fixed_list) {
      foreach ($fixed_list as $name => $module) {
        drupal_get_filename('module', $name, $module['filename']);
        $list[$name] = $name;
      }
64 65
    }
    else {
66 67 68
      // As this is the $refresh case, make sure that system_list() returns
      // fresh data.
      drupal_static_reset('system_list');
69
      if ($bootstrap) {
70
        $list = system_list('bootstrap');
71 72
      }
      else {
73
        $list = system_list('module_enabled');
74
      }
75 76
    }
  }
77 78 79 80 81 82 83
  if ($sort) {
    if (!isset($sorted_list)) {
      $sorted_list = $list;
      ksort($sorted_list);
    }
    return $sorted_list;
  }
84 85 86
  return $list;
}

87 88 89 90
/**
 * Build a list of bootstrap modules and enabled modules and themes.
 *
 * @param $type
91 92 93 94
 *   The type of list to return:
 *   - module_enabled: All enabled modules.
 *   - bootstrap: All enabled modules required for bootstrap.
 *   - theme: All themes.
95 96
 *
 * @return
97 98 99
 *   An associative array of modules or themes, keyed by name, and having the
 *   respective database row as value. For $type 'module_enabled' and
 *   'bootstrap', the array values equal the keys.
100 101 102 103 104 105 106
 *
 * @see module_list()
 * @see list_themes()
 */
function system_list($type) {
  $lists = &drupal_static(__FUNCTION__);

107 108 109 110 111 112 113 114 115
  // 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') {
    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');
116
      cache_set('bootstrap_modules', $bootstrap_list, 'cache_bootstrap');
117
    }
118
    // To avoid a separate database lookup for the filepath, prime the
119 120
    // drupal_get_filename() static cache for bootstrap modules only.
    // The rest is stored separately to keep the bootstrap module cache small.
121 122 123 124 125 126 127 128
    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.
129
  elseif (!isset($lists['module_enabled'])) {
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
    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().
      $result = db_query("SELECT * FROM {system} ORDER BY weight ASC, name ASC");
      foreach ($result as $record) {
        if ($record->type == 'module' && $record->status) {
          // Build a list of all enabled modules.
          $lists['module_enabled'][$record->name] = $record->name;
        }
        // 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);
        }
158
      }
159 160
      cache_set('system_list', $lists, 'cache_bootstrap');
    }
161
    // To avoid a separate database lookup for the filepath, prime the
162 163 164
    // 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']);
165 166 167 168 169 170
    }
  }

  return $lists[$type];
}

171 172 173 174 175 176
/**
 * Reset all system_list() caches.
 */
function system_list_reset() {
  drupal_static_reset('system_list');
  cache_clear_all('bootstrap_modules', 'cache_bootstrap');
177
  cache_clear_all('system_list', 'cache_bootstrap');
178 179
}

180
/**
181
 * Find dependencies any level deep and fill in required by information too.
182 183 184
 *
 * @param $files
 *   The array of filesystem objects used to rebuild the cache.
185
 * @return
186 187 188 189 190
 *   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.
191
 */
192
function _module_build_dependencies($files) {
193
  require_once DRUPAL_ROOT . '/includes/graph.inc';
194 195 196 197
  $roots = $files;
  foreach ($files as $filename => $file) {
    $graph[$file->name]['edges'] = array();
    if (isset($file->info['dependencies']) && is_array($file->info['dependencies'])) {
198 199 200 201
      foreach ($file->info['dependencies'] as $dependency) {
        $dependency_data = drupal_parse_dependency($dependency);
        $graph[$file->name]['edges'][$dependency_data['name']] = $dependency_data;
        unset($roots[$dependency_data['name']]);
202 203
      }
    }
204 205 206
  }
  drupal_depth_first_search($graph, array_keys($roots));
  foreach ($graph as $module => $data) {
207
    $files[$module]->required_by = isset($data['reverse_paths']) ? $data['reverse_paths'] : array();
208 209 210
    $files[$module]->requires = isset($data['paths']) ? $data['paths'] : array();
    $files[$module]->sort = $data['weight'];
  }
Steven Wittens's avatar
Steven Wittens committed
211 212 213
  return $files;
}

214 215 216 217 218 219 220 221
/**
 * Determine whether a given module exists.
 *
 * @param $module
 *   The name of the module (without the .module extension).
 * @return
 *   TRUE if the module is both installed and enabled.
 */
222
function module_exists($module) {
223
  $list = module_list();
224
  return isset($list[$module]);
225 226
}

Steven Wittens's avatar
Steven Wittens committed
227 228 229 230 231
/**
 * Load a module's installation hooks.
 */
function module_load_install($module) {
  // Make sure the installation API is available
232
  include_once DRUPAL_ROOT . '/includes/install.inc';
Steven Wittens's avatar
Steven Wittens committed
233

234
  module_load_include('install', $module);
235 236 237 238
}

/**
 * Load a module include file.
239
 *
240 241
 * Examples:
 * @code
242
 *   // Load node.admin.inc from the node module.
243
 *   module_load_include('inc', 'node', 'node.admin');
244
 *   // Load content_types.inc from the node module.
245
 *   module_load_include('inc', 'node', 'content_types');
246
 * @endcode
247
 *
248 249 250
 * 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'
251 252
 * instead.
 *
253 254 255 256 257
 * @param $type
 *   The include file's type (file extension).
 * @param $module
 *   The module to which the include file belongs.
 * @param $name
258
 *   Optionally, specify the base file name (without the $type extension).
259
 *   If not set, $module is used.
260 261 262 263 264 265
 */
function module_load_include($type, $module, $name = NULL) {
  if (empty($name)) {
    $name = $module;
  }

266
  if (function_exists('drupal_get_path')) {
267 268 269 270 271
    $file = DRUPAL_ROOT . '/' . drupal_get_path('module', $module) . "/$name.$type";
    if (is_file($file)) {
      require_once $file;
      return $file;
    }
272
  }
273
  return FALSE;
274 275 276 277 278 279 280 281 282 283
}

/**
 * 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
284 285 286 287
  }
}

/**
288
 * Enable a given list of modules.
Steven Wittens's avatar
Steven Wittens committed
289
 *
290 291
 * @param $module_list
 *   An array of module names.
292 293 294 295
 * @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.
296 297
 * @param $disable_modules_installed_hook
 *   Normally just testing wants to set this to TRUE.
298 299
 * @return
 *   FALSE if one or more dependencies are missing, TRUE otherwise.
Steven Wittens's avatar
Steven Wittens committed
300
 */
301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338
function module_enable($module_list, $enable_dependencies = TRUE, $disable_modules_installed_hook = FALSE) {
  if ($enable_dependencies) {
    // Get all module data so we can find dependencies and sort.
    $module_data = system_rebuild_module_data();
    // Create an associative array with weights as values.
    $module_list = array_flip(array_values($module_list));

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

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

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

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

339
  $invoke_modules = array();
340

341 342
  // Required for _drupal_install_module().
  include_once DRUPAL_ROOT . '/includes/install.inc';
343 344 345
  // Try to install the enabled modules and collect which were installed.
  // $module_list is not changed and already installed modules are ignored.
  $modules_installed = array_filter($module_list, '_drupal_install_module');
346
  foreach ($module_list as $module) {
347 348 349 350
    $existing = db_query("SELECT status FROM {system} WHERE type = :type AND name = :name", array(
      ':type' => 'module',
      ':name' => $module))
      ->fetchObject();
351
    if ($existing->status == 0) {
352
      module_load_install($module);
353 354 355 356 357
      db_update('system')
        ->fields(array('status' => 1))
        ->condition('type', 'module')
        ->condition('name', $module)
        ->execute();
358 359
      drupal_load('module', $module);
      $invoke_modules[] = $module;
360
      watchdog('system', '%module module enabled.', array('%module' => $module), WATCHDOG_INFO);
361
    }
Steven Wittens's avatar
Steven Wittens committed
362
  }
363 364

  if (!empty($invoke_modules)) {
365
    // Refresh the module list to exclude the disabled modules.
366
    system_list_reset();
367
    module_list(TRUE);
368
    module_implements('', FALSE, TRUE);
369 370
    // Update the registry to include the new enabled module.
    registry_update();
371 372
    // Refresh the schema to include the new enabled module.
    drupal_get_schema(NULL, TRUE);
373 374 375 376 377

    // If any modules were newly installed, execute the hook for them.
    if (!$disable_modules_installed_hook && !empty($modules_installed)) {
      module_invoke_all('modules_installed', $modules_installed);
    }
378
    _system_update_bootstrap_status();
379 380 381 382
  }

  foreach ($invoke_modules as $module) {
    module_invoke($module, 'enable');
383
    // Check if node_access table needs rebuilding.
384 385 386
    // We check for the existence of node_access_needs_rebuild() since
    // at install time, module_enable() could be called while node.module
    // is not enabled yet.
387
    if (function_exists('node_access_needs_rebuild') && !node_access_needs_rebuild() && module_hook($module, 'node_grants')) {
388 389
      node_access_needs_rebuild(TRUE);
    }
Steven Wittens's avatar
Steven Wittens committed
390
  }
391 392

  if (!empty($invoke_modules)) {
393
    // Invoke hook_modules_enabled after all the modules have been
394 395 396
    // enabled.
    module_invoke_all('modules_enabled', $invoke_modules);
  }
397 398

  return TRUE;
Steven Wittens's avatar
Steven Wittens committed
399 400 401
}

/**
402
 * Disable a given set of modules.
Steven Wittens's avatar
Steven Wittens committed
403
 *
404 405
 * @param $module_list
 *   An array of module names.
406 407 408 409
 * @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
410
 */
411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439
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));

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

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

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

440
  $invoke_modules = array();
441

442 443
  foreach ($module_list as $module) {
    if (module_exists($module)) {
444 445 446 447 448
      // Check if node_access table needs rebuilding.
      if (!node_access_needs_rebuild() && module_hook($module, 'node_grants')) {
        node_access_needs_rebuild(TRUE);
      }

449 450
      module_load_install($module);
      module_invoke($module, 'disable');
451 452 453 454 455
      db_update('system')
        ->fields(array('status' => 0))
        ->condition('type', 'module')
        ->condition('name', $module)
        ->execute();
456
      $invoke_modules[] = $module;
457
      watchdog('system', '%module module disabled.', array('%module' => $module), WATCHDOG_INFO);
458
    }
Steven Wittens's avatar
Steven Wittens committed
459
  }
460 461

  if (!empty($invoke_modules)) {
462
    // Refresh the module list to exclude the disabled modules.
463
    system_list_reset();
464 465
    module_list(TRUE);
    module_implements('', FALSE, TRUE);
466
    // Invoke hook_modules_disabled before disabling modules,
467 468
    // so we can still call module hooks to get information.
    module_invoke_all('modules_disabled', $invoke_modules);
469 470
    // Update the registry to remove the newly-disabled module.
    registry_update();
471
    _system_update_bootstrap_status();
Steven Wittens's avatar
Steven Wittens committed
472
  }
473

474
  // If there remains no more node_access module, rebuilding will be
475 476 477 478
  // 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
479 480
}

481 482
/**
 * @defgroup hooks Hooks
Dries's avatar
 
Dries committed
483 484
 * @{
 * Allow modules to interact with the Drupal core.
485 486
 *
 * Drupal's module system is based on the concept of "hooks". A hook is a PHP
487 488 489
 * 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.
490
 *
491 492 493
 * 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.
494 495 496
 *
 * 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
497 498 499
 * 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().
500 501 502 503 504 505 506 507 508 509 510 511 512 513
 */

/**
 * 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").
 * @return
 *   TRUE if the module is both installed and enabled, and the hook is
 *   implemented in that module.
 */
function module_hook($module, $hook) {
514
  return function_exists($module . '_' . $hook);
515 516
}

Dries's avatar
 
Dries committed
517 518 519 520
/**
 * Determine which modules are implementing a hook.
 *
 * @param $hook
521
 *   The name of the hook (e.g. "help" or "menu").
522
 * @param $sort
523 524
 *   By default, modules are ordered by weight and filename, settings this option
 *   to TRUE, module list will be ordered by module name.
525
 * @param $reset
526 527 528
 *   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).
529
 *
Dries's avatar
 
Dries committed
530 531
 * @return
 *   An array with the names of the modules which are implementing this hook.
532 533
 *
 * @see module_implements_write_cache().
Dries's avatar
 
Dries committed
534
 */
535
function module_implements($hook, $sort = FALSE, $reset = FALSE) {
536
  // Use the advanced drupal_static() pattern, since this is called very often.
537 538 539 540 541
  static $drupal_static_fast;
  if (!isset($drupal_static_fast)) {
    $drupal_static_fast['implementations'] = &drupal_static(__FUNCTION__);
  }
  $implementations = &$drupal_static_fast['implementations'];
542

543 544 545 546 547 548 549 550 551 552 553
  // 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) {
554
    $implementations = array();
555
    cache_set('module_implements', array(), 'cache_bootstrap');
556
    drupal_static_reset('module_hook_info');
557
    drupal_static_reset('drupal_alter');
558
    cache_clear_all('hook_info', 'cache_bootstrap');
559
    return;
560 561
  }

562 563
  // Fetch implementations from cache.
  if (empty($implementations)) {
564
    $implementations = cache_get('module_implements', 'cache_bootstrap');
565 566 567 568 569 570 571 572
    if ($implementations === FALSE) {
      $implementations = array();
    }
    else {
      $implementations = $implementations->data;
    }
  }

573
  if (!isset($implementations[$hook])) {
574
    $hook_info = module_hook_info();
575 576 577
    $implementations[$hook] = array();
    $list = module_list(FALSE, FALSE, $sort);
    foreach ($list as $module) {
578 579 580
      $include_file = FALSE;
      if (module_hook($module, $hook) || (isset($hook_info[$hook]['group']) && $include_file = module_load_include('inc', $module, $module . '.' . $hook_info[$hook]['group']) && module_hook($module, $hook))) {
        $implementations[$hook][$module] = $include_file ? $hook_info[$hook]['group'] : FALSE;
581 582 583 584 585 586
        // We added something to the cache, so write it when we are done.
        $implementations['#write_cache'] = TRUE;
      }
    }
  }
  else {
587 588 589 590 591 592
    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");
      }
593 594 595 596 597 598 599 600
      // It is possible that a module removed a hook implementation without the
      // implementations cache being rebuilt yet, so we check module_hook() on
      // each request to avoid undefined function errors.
      if (!module_hook($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[$hook][$module]);
        $implementations['#write_cache'] = TRUE;
Dries's avatar
 
Dries committed
601 602
      }
    }
603
  }
Dries's avatar
 
Dries committed
604

605 606 607 608 609 610 611 612 613 614
  return array_keys($implementations[$hook]);
}

/**
 * Retrieve a list of what hooks are explicitly declared.
 */
function module_hook_info() {
  $hook_info = &drupal_static(__FUNCTION__, array());

  if (empty($hook_info)) {
615
    $cache = cache_get('hook_info', 'cache_bootstrap');
616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635
    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);
        }
      }
636
      cache_set('hook_info', $hook_info, 'cache_bootstrap');
637 638 639 640 641 642 643
    }
    else {
      $hook_info = $cache->data;
    }
  }

  return $hook_info;
644 645
}

646 647 648 649 650 651 652
/**
 * Writes the hook implementation cache.
 *
 * @see module_implements()
 */
function module_implements_write_cache() {
  $implementations = &drupal_static('module_implements');
653 654 655 656
  // 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')) {
657
    unset($implementations['#write_cache']);
658
    cache_set('module_implements', $implementations, 'cache_bootstrap');
659 660 661
  }
}

662 663 664 665 666 667 668 669 670 671 672 673
/**
 * 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.
 * @return
 *   The return value of the hook implementation.
 */
674 675
function module_invoke() {
  $args = func_get_args();
676 677 678
  $module = $args[0];
  $hook = $args[1];
  unset($args[0], $args[1]);
679
  if (module_hook($module, $hook)) {
680
    return call_user_func_array($module . '_' . $hook, $args);
681 682 683 684 685 686 687 688 689 690 691 692 693
  }
}
/**
 * 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.
 * @return
 *   An array of return values of the hook implementations. If modules return
 *   arrays from their implementations, those are merged into one array.
 */
694 695
function module_invoke_all() {
  $args = func_get_args();
696 697
  $hook = $args[0];
  unset($args[0]);
698
  $return = array();
699
  foreach (module_implements($hook) as $module) {
700
    $function = $module . '_' . $hook;
701
    if (function_exists($function)) {
702 703 704 705
      $result = call_user_func_array($function, $args);
      if (isset($result) && is_array($result)) {
        $return = array_merge_recursive($return, $result);
      }
706
      elseif (isset($result)) {
707 708
        $return[] = $result;
      }
709
    }
710 711 712 713 714 715
  }

  return $return;
}

/**
Dries's avatar
 
Dries committed
716
 * @} End of "defgroup hooks".
717 718
 */

719 720 721 722
/**
 * Array of modules required by core.
 */
function drupal_required_modules() {
723 724
  $files = drupal_system_listing('/\.info$/', 'modules', 'name', 0);
  $required = array();
725 726 727 728

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

729
  foreach ($files as $name => $file) {
730
    $info = drupal_parse_info_file($file->uri);
731 732 733 734
    if (!empty($info) && !empty($info['required']) && $info['required']) {
      $required[] = $name;
    }
  }
735

736
  return $required;
737
}