module.inc 14.1 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
  module_implements('', FALSE, TRUE);
18 19
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  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
248 249 250
}

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

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

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

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

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

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

349
  if ($refresh) {
350
    $implementations = array();
351
    return;
352 353
  }

354 355 356 357 358 359
  if (!isset($implementations[$hook])) {
    $implementations[$hook] = array();
    $list = module_list(FALSE, FALSE, $sort);
    foreach ($list as $module) {
      if (module_hook($module, $hook)) {
        $implementations[$hook][] = $module;
Dries's avatar
 
Dries committed
360 361
      }
    }
362
  }
Dries's avatar
 
Dries committed
363

364 365 366 367 368 369 370
  // 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];
371 372
}

373 374 375 376 377 378 379 380 381 382 383 384
/**
 * 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.
 */
385 386
function module_invoke() {
  $args = func_get_args();
387 388 389
  $module = $args[0];
  $hook = $args[1];
  unset($args[0], $args[1]);
390
  if (module_hook($module, $hook)) {
391
    return call_user_func_array($module . '_' . $hook, $args);
392 393 394 395 396 397 398 399 400 401 402 403 404
  }
}
/**
 * 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.
 */
405 406
function module_invoke_all() {
  $args = func_get_args();
407 408
  $hook = $args[0];
  unset($args[0]);
409
  $return = array();
410
  foreach (module_implements($hook) as $module) {
411
    $function = $module . '_' . $hook;
412
    if (function_exists($function)) {
413 414 415 416
      $result = call_user_func_array($function, $args);
      if (isset($result) && is_array($result)) {
        $return = array_merge_recursive($return, $result);
      }
417
      elseif (isset($result)) {
418 419
        $return[] = $result;
      }
420
    }
421 422 423 424 425 426
  }

  return $return;
}

/**
Dries's avatar
 
Dries committed
427
 * @} End of "defgroup hooks".
428 429
 */

430 431 432 433
/**
 * Array of modules required by core.
 */
function drupal_required_modules() {
434 435
  $files = drupal_system_listing('/\.info$/', 'modules', 'name', 0);
  $required = array();
436 437 438 439

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

440
  foreach ($files as $name => $file) {
441
    $info = drupal_parse_info_file($file->uri);
442 443 444 445
    if (!empty($info) && !empty($info['required']) && $info['required']) {
      $required[] = $name;
    }
  }
446

447
  return $required;
448
}