module.inc 16.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
/**
11
 * Load all the modules that have been enabled in the system table.
12
 */
13
14
function module_load_all($bootstrap = FALSE) {
  foreach (module_list(TRUE, $bootstrap) as $module) {
15
16
    drupal_load('module', $module);
  }
17
18
}

19
/**
20
21
 * Collect a list of all loaded modules. During the bootstrap, return only
 * vital modules. See bootstrap.inc
22
23
24
25
 *
 * @param $refresh
 *   Whether to force the module list to be regenerated (such as after the
 *   administrator has changed the system settings).
26
27
28
 * @param $bootstrap
 *   Whether to return the reduced set of modules loaded in "bootstrap mode"
 *   for cached pages. See bootstrap.inc.
29
 * @param $sort
30
31
 *   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.
32
33
34
 * @param $fixed_list
 *   (Optional) Override the module list with the given modules. Stays until the
 *   next call with $refresh = TRUE.
35
36
37
38
 * @return
 *   An associative array whose keys and values are the names of all loaded
 *   modules.
 */
39
function module_list($refresh = FALSE, $bootstrap = FALSE, $sort = FALSE, $fixed_list = NULL) {
40
  static $list = array(), $sorted_list;
41

42
  if (empty($list) || $refresh || $fixed_list) {
Dries's avatar
Dries committed
43
    $list = array();
44
    $sorted_list = NULL;
45
46
47
48
49
    if ($fixed_list) {
      foreach ($fixed_list as $name => $module) {
        drupal_get_filename('module', $name, $module['filename']);
        $list[$name] = $name;
      }
50
51
    }
    else {
52
53
54
55
56
      // 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().
57
58
59
60
61
62
      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");
      }
63
      foreach ($result as $module) {
64
        if (file_exists($module->filename)) {
65
66
          drupal_get_filename('module', $module->name, $module->filename);
          $list[$module->name] = $module->name;
Dries's avatar
   
Dries committed
67
        }
68
      }
69
70
    }
  }
71
72
73
74
75
76
77
  if ($sort) {
    if (!isset($sorted_list)) {
      $sorted_list = $list;
      ksort($sorted_list);
    }
    return $sorted_list;
  }
78
79
80
  return $list;
}

81
/**
82
 * Find dependencies any level deep and fill in required by information too.
83
84
85
 *
 * @param $files
 *   The array of filesystem objects used to rebuild the cache.
86
 * @return
87
88
89
90
91
 *   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.
92
 */
93
function _module_build_dependencies($files) {
94
  require_once DRUPAL_ROOT . '/includes/graph.inc';
95
96
97
98
  $roots = $files;
  foreach ($files as $filename => $file) {
    $graph[$file->name]['edges'] = array();
    if (isset($file->info['dependencies']) && is_array($file->info['dependencies'])) {
99
100
101
102
      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']]);
103
104
      }
    }
105
106
107
  }
  drupal_depth_first_search($graph, array_keys($roots));
  foreach ($graph as $module => $data) {
108
    $files[$module]->required_by = isset($data['reverse_paths']) ? $data['reverse_paths'] : array();
109
110
111
    $files[$module]->requires = isset($data['paths']) ? $data['paths'] : array();
    $files[$module]->sort = $data['weight'];
  }
Steven Wittens's avatar
Steven Wittens committed
112
113
114
  return $files;
}

115
116
117
118
119
120
121
122
/**
 * 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.
 */
123
function module_exists($module) {
124
  $list = module_list();
125
  return isset($list[$module]);
126
127
}

Steven Wittens's avatar
Steven Wittens committed
128
129
130
131
132
/**
 * Load a module's installation hooks.
 */
function module_load_install($module) {
  // Make sure the installation API is available
133
  include_once DRUPAL_ROOT . '/includes/install.inc';
Steven Wittens's avatar
Steven Wittens committed
134

135
  module_load_include('install', $module);
136
137
138
139
}

/**
 * Load a module include file.
140
 *
141
142
 * Examples:
 * @code
143
 *   // Load node.admin.inc from the node module.
144
 *   module_load_include('inc', 'node', 'node.admin');
145
 *   // Load content_types.inc from the node module.
146
 *   module_load_include('inc', 'node', 'content_types');
147
 * @endcode
148
 *
149
150
151
 * Do not use this function to load an install file. Use module_load_install()
 * instead.
 *
152
153
154
155
156
 * @param $type
 *   The include file's type (file extension).
 * @param $module
 *   The module to which the include file belongs.
 * @param $name
157
 *   Optionally, specify the base file name (without the $type extension).
158
 *   If not set, $module is used.
159
160
161
162
163
164
 */
function module_load_include($type, $module, $name = NULL) {
  if (empty($name)) {
    $name = $module;
  }

165
  if (function_exists('drupal_get_path')) {
166
167
168
169
170
    $file = DRUPAL_ROOT . '/' . drupal_get_path('module', $module) . "/$name.$type";
    if (is_file($file)) {
      require_once $file;
      return $file;
    }
171
  }
172
  return FALSE;
173
174
175
176
177
178
179
180
181
182
}

/**
 * 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
183
184
185
186
  }
}

/**
187
 * Enable a given list of modules.
Steven Wittens's avatar
Steven Wittens committed
188
 *
189
190
 * @param $module_list
 *   An array of module names.
191
192
 * @param $disable_modules_installed_hook
 *   Normally just testing wants to set this to TRUE.
Steven Wittens's avatar
Steven Wittens committed
193
 */
194
function module_enable($module_list, $disable_modules_installed_hook = FALSE) {
195
  $invoke_modules = array();
196

197
198
199
  // 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');
200
  foreach ($module_list as $module) {
201
202
203
204
    $existing = db_query("SELECT status FROM {system} WHERE type = :type AND name = :name", array(
      ':type' => 'module',
      ':name' => $module))
      ->fetchObject();
205
    if ($existing->status == 0) {
206
      module_load_install($module);
207
208
209
210
211
      db_update('system')
        ->fields(array('status' => 1))
        ->condition('type', 'module')
        ->condition('name', $module)
        ->execute();
212
213
      drupal_load('module', $module);
      $invoke_modules[] = $module;
214
      watchdog('system', '%module module enabled.', array('%module' => $module), WATCHDOG_INFO);
215
    }
Steven Wittens's avatar
Steven Wittens committed
216
  }
217
218

  if (!empty($invoke_modules)) {
219
    // Refresh the module list to exclude the disabled modules.
220
    module_list(TRUE);
221
    module_implements('', FALSE, TRUE);
222
    // Force to regenerate the stored list of hook implementations.
223
    registry_rebuild();
224
225
226
227
228

    // 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);
    }
229
230
231
232
  }

  foreach ($invoke_modules as $module) {
    module_invoke($module, 'enable');
233
    // Check if node_access table needs rebuilding.
234
235
236
    // 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.
237
    if (function_exists('node_access_needs_rebuild') && !node_access_needs_rebuild() && module_hook($module, 'node_grants')) {
238
239
      node_access_needs_rebuild(TRUE);
    }
Steven Wittens's avatar
Steven Wittens committed
240
  }
241
242
243
244
245
246

  if (!empty($invoke_modules)) {
    // Invoke the hook_module_enable after all the modules have been
    // enabled.
    module_invoke_all('modules_enabled', $invoke_modules);
  }
Steven Wittens's avatar
Steven Wittens committed
247
248
249
}

/**
250
 * Disable a given set of modules.
Steven Wittens's avatar
Steven Wittens committed
251
 *
252
253
 * @param $module_list
 *   An array of module names.
Steven Wittens's avatar
Steven Wittens committed
254
 */
255
256
257
258
function module_disable($module_list) {
  $invoke_modules = array();
  foreach ($module_list as $module) {
    if (module_exists($module)) {
259
260
261
262
263
      // Check if node_access table needs rebuilding.
      if (!node_access_needs_rebuild() && module_hook($module, 'node_grants')) {
        node_access_needs_rebuild(TRUE);
      }

264
265
      module_load_install($module);
      module_invoke($module, 'disable');
266
267
268
269
270
      db_update('system')
        ->fields(array('status' => 0))
        ->condition('type', 'module')
        ->condition('name', $module)
        ->execute();
271
      $invoke_modules[] = $module;
272
      watchdog('system', '%module module disabled.', array('%module' => $module), WATCHDOG_INFO);
273
    }
Steven Wittens's avatar
Steven Wittens committed
274
  }
275
276

  if (!empty($invoke_modules)) {
277
278
279
    // Refresh the module list to exclude the disabled modules.
    module_list(TRUE);
    module_implements('', FALSE, TRUE);
280
281
282
    // Invoke hook_module_disable before disabling modules,
    // so we can still call module hooks to get information.
    module_invoke_all('modules_disabled', $invoke_modules);
283
    // Force to regenerate the stored list of hook implementations.
284
    registry_rebuild();
Steven Wittens's avatar
Steven Wittens committed
285
  }
286

287
  // If there remains no more node_access module, rebuilding will be
288
289
290
291
  // 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
292
293
}

294
295
/**
 * @defgroup hooks Hooks
Dries's avatar
   
Dries committed
296
297
 * @{
 * Allow modules to interact with the Drupal core.
298
299
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
 *
 * 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) {
327
  return function_exists($module . '_' . $hook);
328
329
}

Dries's avatar
   
Dries committed
330
331
332
333
/**
 * Determine which modules are implementing a hook.
 *
 * @param $hook
334
 *   The name of the hook (e.g. "help" or "menu").
335
 * @param $sort
336
337
 *   By default, modules are ordered by weight and filename, settings this option
 *   to TRUE, module list will be ordered by module name.
338
 * @param $reset
339
340
341
 *   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).
342
 *
Dries's avatar
   
Dries committed
343
344
 * @return
 *   An array with the names of the modules which are implementing this hook.
345
346
 *
 * @see module_implements_write_cache().
Dries's avatar
   
Dries committed
347
 */
348
349
function module_implements($hook, $sort = FALSE, $reset = FALSE) {
  $implementations = &drupal_static(__FUNCTION__, array());
350

351
352
353
354
355
356
357
358
359
360
361
  // 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) {
362
    $implementations = array();
363
    cache_set('module_implements', array());
364
    return;
365
366
  }

367
368
369
370
371
372
373
374
375
376
377
  // Fetch implementations from cache.
  if (empty($implementations)) {
    $implementations = cache_get('module_implements');
    if ($implementations === FALSE) {
      $implementations = array();
    }
    else {
      $implementations = $implementations->data;
    }
  }

378
379
380
381
382
  if (!isset($implementations[$hook])) {
    $implementations[$hook] = array();
    $list = module_list(FALSE, FALSE, $sort);
    foreach ($list as $module) {
      if (module_hook($module, $hook)) {
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
        $implementations[$hook][$module] = $module;
        // We added something to the cache, so write it when we are done.
        $implementations['#write_cache'] = TRUE;
      }
    }
  }
  else {
    foreach ($implementations[$hook] as $module) {
      // 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
399
400
      }
    }
401
  }
Dries's avatar
   
Dries committed
402

403
404
405
406
407
408
409
  // The explicit cast forces a copy to be made. This is needed because
  // $implementations[$hook] is only a reference to an element of
  // $implementations and if there are nested foreaches (due to nested node
  // API calls, for example), they would both manipulate the same array's
  // references, which causes some modules' hooks not to be called.
  // See also http://www.zend.com/zend/art/ref-count.php.
  return (array)$implementations[$hook];
410
411
}

412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
/**
 * Writes the hook implementation cache.
 *
 * @see module_implements()
 */
function module_implements_write_cache() {
  $implementations = &drupal_static('module_implements');
  // Check whether we need to write the cache. We do not want to cache hooks,
  // which are only invoked on HTTP POST requests. Maybe the page is not
  // cacheable for other reasons than the HTTP request type as well, but this
  // does not matter for the hook implementation cache, because nothing breaks
  // if hook implementations are not cached.
  if (isset($implementations['#write_cache']) && drupal_page_is_cacheable()) {
    unset($implementations['#write_cache']);
    cache_set('module_implements', $implementations);
  }
}

430
431
432
433
434
435
436
437
438
439
440
441
/**
 * 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.
 */
442
443
function module_invoke() {
  $args = func_get_args();
444
445
446
  $module = $args[0];
  $hook = $args[1];
  unset($args[0], $args[1]);
447
  if (module_hook($module, $hook)) {
448
    return call_user_func_array($module . '_' . $hook, $args);
449
450
451
452
453
454
455
456
457
458
459
460
461
  }
}
/**
 * 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.
 */
462
463
function module_invoke_all() {
  $args = func_get_args();
464
465
  $hook = $args[0];
  unset($args[0]);
466
  $return = array();
467
  foreach (module_implements($hook) as $module) {
468
    $function = $module . '_' . $hook;
469
    if (function_exists($function)) {
470
471
472
473
      $result = call_user_func_array($function, $args);
      if (isset($result) && is_array($result)) {
        $return = array_merge_recursive($return, $result);
      }
474
      elseif (isset($result)) {
475
476
        $return[] = $result;
      }
477
    }
478
479
480
481
482
483
  }

  return $return;
}

/**
Dries's avatar
   
Dries committed
484
 * @} End of "defgroup hooks".
485
486
 */

487
488
489
490
/**
 * Array of modules required by core.
 */
function drupal_required_modules() {
491
492
  $files = drupal_system_listing('/\.info$/', 'modules', 'name', 0);
  $required = array();
493
494
495
496

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

497
  foreach ($files as $name => $file) {
498
    $info = drupal_parse_info_file($file->uri);
499
500
501
502
    if (!empty($info) && !empty($info['required']) && $info['required']) {
      $required[] = $name;
    }
  }
503

504
  return $required;
505
}