module.inc 18.5 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
69
70
      // 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().
71
72
73
74
75
76
      if ($bootstrap) {
        $result = db_query("SELECT name, filename FROM {system} WHERE type = 'module' AND status = 1 AND bootstrap = 1 ORDER BY weight ASC, name ASC");
      }
      else {
        $result = db_query("SELECT name, filename FROM {system} WHERE type = 'module' AND status = 1 ORDER BY weight ASC, name ASC");
      }
77
      foreach ($result as $module) {
78
        if (file_exists($module->filename)) {
79
80
81
82
83
          // First call drupal_get_filename() to prime the static cache for
          // later lookups of the module path. Since we've already queried for
          // the filename and can pass that in as an argument, this avoids a
          // database hit for every module when drupal_get_filename() is
          // subsequently called by drupal_load().
84
85
          drupal_get_filename('module', $module->name, $module->filename);
          $list[$module->name] = $module->name;
Dries's avatar
   
Dries committed
86
        }
87
      }
88
89
    }
  }
90
91
92
93
94
95
96
  if ($sort) {
    if (!isset($sorted_list)) {
      $sorted_list = $list;
      ksort($sorted_list);
    }
    return $sorted_list;
  }
97
98
99
  return $list;
}

100
/**
101
 * Find dependencies any level deep and fill in required by information too.
102
103
104
 *
 * @param $files
 *   The array of filesystem objects used to rebuild the cache.
105
 * @return
106
107
108
109
110
 *   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.
111
 */
112
function _module_build_dependencies($files) {
113
  require_once DRUPAL_ROOT . '/includes/graph.inc';
114
115
116
117
  $roots = $files;
  foreach ($files as $filename => $file) {
    $graph[$file->name]['edges'] = array();
    if (isset($file->info['dependencies']) && is_array($file->info['dependencies'])) {
118
119
120
121
      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']]);
122
123
      }
    }
124
125
126
  }
  drupal_depth_first_search($graph, array_keys($roots));
  foreach ($graph as $module => $data) {
127
    $files[$module]->required_by = isset($data['reverse_paths']) ? $data['reverse_paths'] : array();
128
129
130
    $files[$module]->requires = isset($data['paths']) ? $data['paths'] : array();
    $files[$module]->sort = $data['weight'];
  }
Steven Wittens's avatar
Steven Wittens committed
131
132
133
  return $files;
}

134
135
136
137
138
139
140
141
/**
 * 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.
 */
142
function module_exists($module) {
143
  $list = module_list();
144
  return isset($list[$module]);
145
146
}

Steven Wittens's avatar
Steven Wittens committed
147
148
149
150
151
/**
 * Load a module's installation hooks.
 */
function module_load_install($module) {
  // Make sure the installation API is available
152
  include_once DRUPAL_ROOT . '/includes/install.inc';
Steven Wittens's avatar
Steven Wittens committed
153

154
  module_load_include('install', $module);
155
156
157
158
}

/**
 * Load a module include file.
159
 *
160
161
 * Examples:
 * @code
162
 *   // Load node.admin.inc from the node module.
163
 *   module_load_include('inc', 'node', 'node.admin');
164
 *   // Load content_types.inc from the node module.
165
 *   module_load_include('inc', 'node', 'content_types');
166
 * @endcode
167
 *
168
169
170
 * Do not use this function to load an install file. Use module_load_install()
 * instead.
 *
171
172
173
174
175
 * @param $type
 *   The include file's type (file extension).
 * @param $module
 *   The module to which the include file belongs.
 * @param $name
176
 *   Optionally, specify the base file name (without the $type extension).
177
 *   If not set, $module is used.
178
179
180
181
182
183
 */
function module_load_include($type, $module, $name = NULL) {
  if (empty($name)) {
    $name = $module;
  }

184
  if (function_exists('drupal_get_path')) {
185
186
187
188
189
    $file = DRUPAL_ROOT . '/' . drupal_get_path('module', $module) . "/$name.$type";
    if (is_file($file)) {
      require_once $file;
      return $file;
    }
190
  }
191
  return FALSE;
192
193
194
195
196
197
198
199
200
201
}

/**
 * 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
202
203
204
205
  }
}

/**
206
 * Enable a given list of modules.
Steven Wittens's avatar
Steven Wittens committed
207
 *
208
209
 * @param $module_list
 *   An array of module names.
210
211
 * @param $disable_modules_installed_hook
 *   Normally just testing wants to set this to TRUE.
Steven Wittens's avatar
Steven Wittens committed
212
 */
213
function module_enable($module_list, $disable_modules_installed_hook = FALSE) {
214
  $invoke_modules = array();
215

216
217
218
  // 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');
219
  foreach ($module_list as $module) {
220
221
222
223
    $existing = db_query("SELECT status FROM {system} WHERE type = :type AND name = :name", array(
      ':type' => 'module',
      ':name' => $module))
      ->fetchObject();
224
    if ($existing->status == 0) {
225
      module_load_install($module);
226
227
228
229
230
      db_update('system')
        ->fields(array('status' => 1))
        ->condition('type', 'module')
        ->condition('name', $module)
        ->execute();
231
232
      drupal_load('module', $module);
      $invoke_modules[] = $module;
233
      watchdog('system', '%module module enabled.', array('%module' => $module), WATCHDOG_INFO);
234
    }
Steven Wittens's avatar
Steven Wittens committed
235
  }
236
237

  if (!empty($invoke_modules)) {
238
    // Refresh the module list to exclude the disabled modules.
239
    module_list(TRUE);
240
    module_implements('', FALSE, TRUE);
241
    // Force to regenerate the stored list of hook implementations.
242
    registry_rebuild();
243
244
    // Refresh the schema to include the new enabled module.
    drupal_get_schema(NULL, TRUE);
245
246
247
248
249

    // 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);
    }
250
251
252
253
  }

  foreach ($invoke_modules as $module) {
    module_invoke($module, 'enable');
254
    // Check if node_access table needs rebuilding.
255
256
257
    // 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.
258
    if (function_exists('node_access_needs_rebuild') && !node_access_needs_rebuild() && module_hook($module, 'node_grants')) {
259
260
      node_access_needs_rebuild(TRUE);
    }
Steven Wittens's avatar
Steven Wittens committed
261
  }
262
263

  if (!empty($invoke_modules)) {
264
    // Invoke hook_modules_enabled after all the modules have been
265
266
267
    // enabled.
    module_invoke_all('modules_enabled', $invoke_modules);
  }
Steven Wittens's avatar
Steven Wittens committed
268
269
270
}

/**
271
 * Disable a given set of modules.
Steven Wittens's avatar
Steven Wittens committed
272
 *
273
274
 * @param $module_list
 *   An array of module names.
Steven Wittens's avatar
Steven Wittens committed
275
 */
276
277
278
279
function module_disable($module_list) {
  $invoke_modules = array();
  foreach ($module_list as $module) {
    if (module_exists($module)) {
280
281
282
283
284
      // Check if node_access table needs rebuilding.
      if (!node_access_needs_rebuild() && module_hook($module, 'node_grants')) {
        node_access_needs_rebuild(TRUE);
      }

285
286
      module_load_install($module);
      module_invoke($module, 'disable');
287
288
289
290
291
      db_update('system')
        ->fields(array('status' => 0))
        ->condition('type', 'module')
        ->condition('name', $module)
        ->execute();
292
      $invoke_modules[] = $module;
293
      watchdog('system', '%module module disabled.', array('%module' => $module), WATCHDOG_INFO);
294
    }
Steven Wittens's avatar
Steven Wittens committed
295
  }
296
297

  if (!empty($invoke_modules)) {
298
299
300
    // Refresh the module list to exclude the disabled modules.
    module_list(TRUE);
    module_implements('', FALSE, TRUE);
301
    // Invoke hook_modules_disabled before disabling modules,
302
303
    // so we can still call module hooks to get information.
    module_invoke_all('modules_disabled', $invoke_modules);
304
    // Force to regenerate the stored list of hook implementations.
305
    registry_rebuild();
Steven Wittens's avatar
Steven Wittens committed
306
  }
307

308
  // If there remains no more node_access module, rebuilding will be
309
310
311
312
  // 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
313
314
}

315
316
/**
 * @defgroup hooks Hooks
Dries's avatar
   
Dries committed
317
318
 * @{
 * Allow modules to interact with the Drupal core.
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 *
 * Drupal's module system is based on the concept of "hooks". A hook is a PHP
 * 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.
 *
 * 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 call that hook in all enabled modules that implement it.
 *
 * 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
 * the module name is 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().
 */

/**
 * 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) {
348
  return function_exists($module . '_' . $hook);
349
350
}

Dries's avatar
   
Dries committed
351
352
353
354
/**
 * Determine which modules are implementing a hook.
 *
 * @param $hook
355
 *   The name of the hook (e.g. "help" or "menu").
356
 * @param $sort
357
358
 *   By default, modules are ordered by weight and filename, settings this option
 *   to TRUE, module list will be ordered by module name.
359
 * @param $reset
360
361
362
 *   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).
363
 *
Dries's avatar
   
Dries committed
364
365
 * @return
 *   An array with the names of the modules which are implementing this hook.
366
367
 *
 * @see module_implements_write_cache().
Dries's avatar
   
Dries committed
368
 */
369
370
function module_implements($hook, $sort = FALSE, $reset = FALSE) {
  $implementations = &drupal_static(__FUNCTION__, array());
371

372
373
374
375
376
377
378
379
380
381
382
  // 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) {
383
    $implementations = array();
384
    cache_set('module_implements', array());
385
386
    drupal_static_reset('module_hook_info');
    cache_clear_all('hook_info', 'cache');
387
    return;
388
389
  }

390
391
392
393
394
395
396
397
398
399
400
  // Fetch implementations from cache.
  if (empty($implementations)) {
    $implementations = cache_get('module_implements');
    if ($implementations === FALSE) {
      $implementations = array();
    }
    else {
      $implementations = $implementations->data;
    }
  }

401
  if (!isset($implementations[$hook])) {
402
    $hook_info = module_hook_info();
403
404
405
    $implementations[$hook] = array();
    $list = module_list(FALSE, FALSE, $sort);
    foreach ($list as $module) {
406
407
408
      $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;
409
410
411
412
413
414
        // We added something to the cache, so write it when we are done.
        $implementations['#write_cache'] = TRUE;
      }
    }
  }
  else {
415
416
417
418
419
420
    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");
      }
421
422
423
424
425
426
427
428
      // 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
429
430
      }
    }
431
  }
Dries's avatar
   
Dries committed
432

433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
  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)) {
    $cache = cache_get('hook_info');
    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);
        }
      }
      cache_set('hook_info', $hook_info);
    }
    else {
      $hook_info = $cache->data;
    }
  }

  return $hook_info;
472
473
}

474
475
476
477
478
479
480
/**
 * Writes the hook implementation cache.
 *
 * @see module_implements()
 */
function module_implements_write_cache() {
  $implementations = &drupal_static('module_implements');
481
482
483
484
  // 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')) {
485
486
487
488
489
    unset($implementations['#write_cache']);
    cache_set('module_implements', $implementations);
  }
}

490
491
492
493
494
495
496
497
498
499
500
501
/**
 * 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.
 */
502
503
function module_invoke() {
  $args = func_get_args();
504
505
506
  $module = $args[0];
  $hook = $args[1];
  unset($args[0], $args[1]);
507
  if (module_hook($module, $hook)) {
508
    return call_user_func_array($module . '_' . $hook, $args);
509
510
511
512
513
514
515
516
517
518
519
520
521
  }
}
/**
 * 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.
 */
522
523
function module_invoke_all() {
  $args = func_get_args();
524
525
  $hook = $args[0];
  unset($args[0]);
526
  $return = array();
527
  foreach (module_implements($hook) as $module) {
528
    $function = $module . '_' . $hook;
529
    if (function_exists($function)) {
530
531
532
533
      $result = call_user_func_array($function, $args);
      if (isset($result) && is_array($result)) {
        $return = array_merge_recursive($return, $result);
      }
534
      elseif (isset($result)) {
535
536
        $return[] = $result;
      }
537
    }
538
539
540
541
542
543
  }

  return $return;
}

/**
Dries's avatar
   
Dries committed
544
 * @} End of "defgroup hooks".
545
546
 */

547
548
549
550
/**
 * Array of modules required by core.
 */
function drupal_required_modules() {
551
552
  $files = drupal_system_listing('/\.info$/', 'modules', 'name', 0);
  $required = array();
553
554
555
556

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

557
  foreach ($files as $name => $file) {
558
    $info = drupal_parse_info_file($file->uri);
559
560
561
562
    if (!empty($info) && !empty($info['required']) && $info['required']) {
      $required[] = $name;
    }
  }
563

564
  return $required;
565
}