module.inc 20 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 95 96
 *   The type of list to return:
 *   - module: All modules.
 *   - module_enabled: All enabled modules.
 *   - bootstrap: All enabled modules required for bootstrap.
 *   - theme: All themes.
 *   - theme_enabled: All enabled themes.
97 98
 *
 * @return
99 100 101
 *   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.
102 103 104 105 106 107 108 109
 *
 * @see module_list()
 * @see list_themes()
 */
function system_list($type) {
  $lists = &drupal_static(__FUNCTION__);

  if (!isset($lists)) {
110 111 112 113 114 115 116
    $lists = array(
      'bootstrap' => array(),
      'module' => array(),
      'module_enabled' => array(),
      'theme' => array(),
      'theme_enabled' => array(),
    );
117 118 119 120 121
    // 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().
122
    $result = db_query("SELECT * FROM {system} ORDER BY weight ASC, name ASC");
123
    foreach ($result as $record) {
124
      // Build a list of all modules.
125
      if ($record->type == 'module') {
126
        $lists['module'][$record->name] = $record;
127 128 129 130 131 132 133
        // Build a list of all enabled modules.
        if ($record->status) {
          $lists['module_enabled'][$record->name] = $record->name;
          // Build a separate array of modules required for bootstrap.
          if ($record->bootstrap) {
            $lists['bootstrap'][$record->name] = $record->name;
          }
134 135
        }
      }
136
      // Build a list of themes.
137 138
      if ($record->type == 'theme') {
        $lists['theme'][$record->name] = $record;
139 140 141 142
        // Build a list of enabled themes.
        if ($record->status) {
          $lists['theme_enabled'][$record->name] = $record;
        }
143 144 145 146 147
      }

      // Additionally prime drupal_get_filename() with the filename and type
      // for each record, this prevents subsequent database lookups when
      // drupal_get_filename() is called without the 'file' argument.
148 149 150
      if ($record->status) {
        drupal_get_filename($record->type, $record->name, $record->filename);
      }
151 152 153 154 155 156
    }
  }

  return $lists[$type];
}

157
/**
158
 * Find dependencies any level deep and fill in required by information too.
159 160 161
 *
 * @param $files
 *   The array of filesystem objects used to rebuild the cache.
162
 * @return
163 164 165 166 167
 *   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.
168
 */
169
function _module_build_dependencies($files) {
170
  require_once DRUPAL_ROOT . '/includes/graph.inc';
171 172 173 174
  $roots = $files;
  foreach ($files as $filename => $file) {
    $graph[$file->name]['edges'] = array();
    if (isset($file->info['dependencies']) && is_array($file->info['dependencies'])) {
175 176 177 178
      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']]);
179 180
      }
    }
181 182 183
  }
  drupal_depth_first_search($graph, array_keys($roots));
  foreach ($graph as $module => $data) {
184
    $files[$module]->required_by = isset($data['reverse_paths']) ? $data['reverse_paths'] : array();
185 186 187
    $files[$module]->requires = isset($data['paths']) ? $data['paths'] : array();
    $files[$module]->sort = $data['weight'];
  }
Steven Wittens's avatar
Steven Wittens committed
188 189 190
  return $files;
}

191 192 193 194 195 196 197 198
/**
 * 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.
 */
199
function module_exists($module) {
200
  $list = module_list();
201
  return isset($list[$module]);
202 203
}

Steven Wittens's avatar
Steven Wittens committed
204 205 206 207 208
/**
 * Load a module's installation hooks.
 */
function module_load_install($module) {
  // Make sure the installation API is available
209
  include_once DRUPAL_ROOT . '/includes/install.inc';
Steven Wittens's avatar
Steven Wittens committed
210

211
  module_load_include('install', $module);
212 213 214 215
}

/**
 * Load a module include file.
216
 *
217 218
 * Examples:
 * @code
219
 *   // Load node.admin.inc from the node module.
220
 *   module_load_include('inc', 'node', 'node.admin');
221
 *   // Load content_types.inc from the node module.
222
 *   module_load_include('inc', 'node', 'content_types');
223
 * @endcode
224
 *
225 226 227
 * Do not use this function to load an install file. Use module_load_install()
 * instead.
 *
228 229 230 231 232
 * @param $type
 *   The include file's type (file extension).
 * @param $module
 *   The module to which the include file belongs.
 * @param $name
233
 *   Optionally, specify the base file name (without the $type extension).
234
 *   If not set, $module is used.
235 236 237 238 239 240
 */
function module_load_include($type, $module, $name = NULL) {
  if (empty($name)) {
    $name = $module;
  }

241
  if (function_exists('drupal_get_path')) {
242 243 244 245 246
    $file = DRUPAL_ROOT . '/' . drupal_get_path('module', $module) . "/$name.$type";
    if (is_file($file)) {
      require_once $file;
      return $file;
    }
247
  }
248
  return FALSE;
249 250 251 252 253 254 255 256 257 258
}

/**
 * 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
259 260 261 262
  }
}

/**
263
 * Enable a given list of modules.
Steven Wittens's avatar
Steven Wittens committed
264
 *
265 266
 * @param $module_list
 *   An array of module names.
267 268
 * @param $disable_modules_installed_hook
 *   Normally just testing wants to set this to TRUE.
Steven Wittens's avatar
Steven Wittens committed
269
 */
270
function module_enable($module_list, $disable_modules_installed_hook = FALSE) {
271
  $invoke_modules = array();
272

273 274 275
  // 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');
276
  foreach ($module_list as $module) {
277 278 279 280
    $existing = db_query("SELECT status FROM {system} WHERE type = :type AND name = :name", array(
      ':type' => 'module',
      ':name' => $module))
      ->fetchObject();
281
    if ($existing->status == 0) {
282
      module_load_install($module);
283 284 285 286 287
      db_update('system')
        ->fields(array('status' => 1))
        ->condition('type', 'module')
        ->condition('name', $module)
        ->execute();
288 289
      drupal_load('module', $module);
      $invoke_modules[] = $module;
290
      watchdog('system', '%module module enabled.', array('%module' => $module), WATCHDOG_INFO);
291
    }
Steven Wittens's avatar
Steven Wittens committed
292
  }
293 294

  if (!empty($invoke_modules)) {
295
    // Refresh the module list to exclude the disabled modules.
296
    module_list(TRUE);
297
    module_implements('', FALSE, TRUE);
298
    // Force to regenerate the stored list of hook implementations.
299
    registry_rebuild();
300 301
    // Refresh the schema to include the new enabled module.
    drupal_get_schema(NULL, TRUE);
302 303 304 305 306

    // 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);
    }
307 308 309 310
  }

  foreach ($invoke_modules as $module) {
    module_invoke($module, 'enable');
311
    // Check if node_access table needs rebuilding.
312 313 314
    // 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.
315
    if (function_exists('node_access_needs_rebuild') && !node_access_needs_rebuild() && module_hook($module, 'node_grants')) {
316 317
      node_access_needs_rebuild(TRUE);
    }
Steven Wittens's avatar
Steven Wittens committed
318
  }
319 320

  if (!empty($invoke_modules)) {
321
    // Invoke hook_modules_enabled after all the modules have been
322 323 324
    // enabled.
    module_invoke_all('modules_enabled', $invoke_modules);
  }
Steven Wittens's avatar
Steven Wittens committed
325 326 327
}

/**
328
 * Disable a given set of modules.
Steven Wittens's avatar
Steven Wittens committed
329
 *
330 331
 * @param $module_list
 *   An array of module names.
Steven Wittens's avatar
Steven Wittens committed
332
 */
333 334 335 336
function module_disable($module_list) {
  $invoke_modules = array();
  foreach ($module_list as $module) {
    if (module_exists($module)) {
337 338 339 340 341
      // Check if node_access table needs rebuilding.
      if (!node_access_needs_rebuild() && module_hook($module, 'node_grants')) {
        node_access_needs_rebuild(TRUE);
      }

342 343
      module_load_install($module);
      module_invoke($module, 'disable');
344 345 346 347 348
      db_update('system')
        ->fields(array('status' => 0))
        ->condition('type', 'module')
        ->condition('name', $module)
        ->execute();
349
      $invoke_modules[] = $module;
350
      watchdog('system', '%module module disabled.', array('%module' => $module), WATCHDOG_INFO);
351
    }
Steven Wittens's avatar
Steven Wittens committed
352
  }
353 354

  if (!empty($invoke_modules)) {
355 356 357
    // Refresh the module list to exclude the disabled modules.
    module_list(TRUE);
    module_implements('', FALSE, TRUE);
358
    // Invoke hook_modules_disabled before disabling modules,
359 360
    // so we can still call module hooks to get information.
    module_invoke_all('modules_disabled', $invoke_modules);
361
    // Force to regenerate the stored list of hook implementations.
362
    registry_rebuild();
Steven Wittens's avatar
Steven Wittens committed
363
  }
364

365
  // If there remains no more node_access module, rebuilding will be
366 367 368 369
  // 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
370 371
}

372 373
/**
 * @defgroup hooks Hooks
Dries's avatar
 
Dries committed
374 375
 * @{
 * Allow modules to interact with the Drupal core.
376 377
 *
 * Drupal's module system is based on the concept of "hooks". A hook is a PHP
378 379 380
 * 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.
381
 *
382 383 384
 * 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.
385 386 387
 *
 * 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
388 389 390
 * 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().
391 392 393 394 395 396 397 398 399 400 401 402 403 404
 */

/**
 * 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) {
405
  return function_exists($module . '_' . $hook);
406 407
}

Dries's avatar
 
Dries committed
408 409 410 411
/**
 * Determine which modules are implementing a hook.
 *
 * @param $hook
412
 *   The name of the hook (e.g. "help" or "menu").
413
 * @param $sort
414 415
 *   By default, modules are ordered by weight and filename, settings this option
 *   to TRUE, module list will be ordered by module name.
416
 * @param $reset
417 418 419
 *   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).
420
 *
Dries's avatar
 
Dries committed
421 422
 * @return
 *   An array with the names of the modules which are implementing this hook.
423 424
 *
 * @see module_implements_write_cache().
Dries's avatar
 
Dries committed
425
 */
426 427
function module_implements($hook, $sort = FALSE, $reset = FALSE) {
  $implementations = &drupal_static(__FUNCTION__, array());
428

429 430 431 432 433 434 435 436 437 438 439
  // 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) {
440
    $implementations = array();
441
    cache_set('module_implements', array(), 'cache_bootstrap');
442
    drupal_static_reset('module_hook_info');
443
    drupal_static_reset('drupal_alter');
444
    cache_clear_all('hook_info', 'cache_bootstrap');
445
    return;
446 447
  }

448 449
  // Fetch implementations from cache.
  if (empty($implementations)) {
450
    $implementations = cache_get('module_implements', 'cache_bootstrap');
451 452 453 454 455 456 457 458
    if ($implementations === FALSE) {
      $implementations = array();
    }
    else {
      $implementations = $implementations->data;
    }
  }

459
  if (!isset($implementations[$hook])) {
460
    $hook_info = module_hook_info();
461 462 463
    $implementations[$hook] = array();
    $list = module_list(FALSE, FALSE, $sort);
    foreach ($list as $module) {
464 465 466
      $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;
467 468 469 470 471 472
        // We added something to the cache, so write it when we are done.
        $implementations['#write_cache'] = TRUE;
      }
    }
  }
  else {
473 474 475 476 477 478
    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");
      }
479 480 481 482 483 484 485 486
      // 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
487 488
      }
    }
489
  }
Dries's avatar
 
Dries committed
490

491 492 493 494 495 496 497 498 499 500
  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)) {
501
    $cache = cache_get('hook_info', 'cache_bootstrap');
502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521
    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);
        }
      }
522
      cache_set('hook_info', $hook_info, 'cache_bootstrap');
523 524 525 526 527 528 529
    }
    else {
      $hook_info = $cache->data;
    }
  }

  return $hook_info;
530 531
}

532 533 534 535 536 537 538
/**
 * Writes the hook implementation cache.
 *
 * @see module_implements()
 */
function module_implements_write_cache() {
  $implementations = &drupal_static('module_implements');
539 540 541 542
  // 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')) {
543 544 545 546 547
    unset($implementations['#write_cache']);
    cache_set('module_implements', $implementations);
  }
}

548 549 550 551 552 553 554 555 556 557 558 559
/**
 * 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.
 */
560 561
function module_invoke() {
  $args = func_get_args();
562 563 564
  $module = $args[0];
  $hook = $args[1];
  unset($args[0], $args[1]);
565
  if (module_hook($module, $hook)) {
566
    return call_user_func_array($module . '_' . $hook, $args);
567 568 569 570 571 572 573 574 575 576 577 578 579
  }
}
/**
 * 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.
 */
580 581
function module_invoke_all() {
  $args = func_get_args();
582 583
  $hook = $args[0];
  unset($args[0]);
584
  $return = array();
585
  foreach (module_implements($hook) as $module) {
586
    $function = $module . '_' . $hook;
587
    if (function_exists($function)) {
588 589 590 591
      $result = call_user_func_array($function, $args);
      if (isset($result) && is_array($result)) {
        $return = array_merge_recursive($return, $result);
      }
592
      elseif (isset($result)) {
593 594
        $return[] = $result;
      }
595
    }
596 597 598 599 600 601
  }

  return $return;
}

/**
Dries's avatar
 
Dries committed
602
 * @} End of "defgroup hooks".
603 604
 */

605 606 607 608
/**
 * Array of modules required by core.
 */
function drupal_required_modules() {
609 610
  $files = drupal_system_listing('/\.info$/', 'modules', 'name', 0);
  $required = array();
611 612 613 614

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

615
  foreach ($files as $name => $file) {
616
    $info = drupal_parse_info_file($file->uri);
617 618 619 620
    if (!empty($info) && !empty($info['required']) && $info['required']) {
      $required[] = $name;
    }
  }
621

622
  return $required;
623
}