module.inc 18.2 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 12 13 14 15 16 17 18 19
/**
 * Pass this to module_implements when its cache needs to be written.
 */
define('MODULE_IMPLEMENTS_WRITE_CACHE', -1);

/**
 * Pass this to module_implements when its cache needs to be cleared.
 */
define('MODULE_IMPLEMENTS_CLEAR_CACHE', -2);


20
/**
21
 * Load all the modules that have been enabled in the system table.
22
 */
23
function module_load_all() {
24
  foreach (module_list(TRUE) as $module) {
25 26
    drupal_load('module', $module);
  }
27 28
}

29
/**
30 31
 * Collect a list of all loaded modules. During the bootstrap, return only
 * vital modules. See bootstrap.inc
32 33 34 35
 *
 * @param $refresh
 *   Whether to force the module list to be regenerated (such as after the
 *   administrator has changed the system settings).
36
 * @param $sort
37 38
 *   By default, modules are ordered by weight and filename. Set this option to
 *   TRUE to return a module list ordered only by module name.
39 40 41
 * @param $fixed_list
 *   (Optional) Override the module list with the given modules. Stays until the
 *   next call with $refresh = TRUE.
42 43 44 45
 * @return
 *   An associative array whose keys and values are the names of all loaded
 *   modules.
 */
46
function module_list($refresh = FALSE, $sort = FALSE, $fixed_list = NULL) {
47
  static $list = array(), $sorted_list;
48

49
  if (empty($list) || $refresh || $fixed_list) {
Dries's avatar
Dries committed
50
    $list = array();
51
    $sorted_list = NULL;
52 53 54 55 56
    if ($fixed_list) {
      foreach ($fixed_list as $name => $module) {
        drupal_get_filename('module', $name, $module['filename']);
        $list[$name] = $name;
      }
57 58
    }
    else {
59
      $result = db_query("SELECT name, filename FROM {system} WHERE type = 'module' AND status = 1 ORDER BY weight ASC, filename ASC");
60
      foreach ($result as $module) {
61
        if (file_exists($module->filename)) {
62 63
          drupal_get_filename('module', $module->name, $module->filename);
          $list[$module->name] = $module->name;
Dries's avatar
 
Dries committed
64
        }
65
      }
66 67
    }
  }
68 69 70 71 72 73 74
  if ($sort) {
    if (!isset($sorted_list)) {
      $sorted_list = $list;
      ksort($sorted_list);
    }
    return $sorted_list;
  }
75 76 77
  return $list;
}

Steven Wittens's avatar
Steven Wittens committed
78 79
/**
 * Rebuild the database cache of module files.
80
 *
Steven Wittens's avatar
Steven Wittens committed
81 82 83 84
 * @return
 *   The array of filesystem objects used to rebuild the cache.
 */
function module_rebuild_cache() {
85
  // Get current list of modules, including uninstalled modules.
86
  $files = drupal_system_listing('/\.module$/', 'modules', 'name', 0);
Steven Wittens's avatar
Steven Wittens committed
87 88 89 90 91 92

  // Extract current files from database.
  system_get_files_database($files, 'module');

  ksort($files);

93 94 95 96 97
  // Set defaults for module info
  $defaults = array(
    'dependencies' => array(),
    'dependents' => array(),
    'description' => '',
98
    'package' => 'Other',
99 100
    'version' => NULL,
    'php' => DRUPAL_MINIMUM_PHP,
101
    'files' => array(),
102 103
  );

Steven Wittens's avatar
Steven Wittens committed
104
  foreach ($files as $filename => $file) {
105
    // Look for the info file.
106
    $file->info = drupal_parse_info_file(dirname($file->filename) . '/' . $file->name . '.info');
107

108 109 110 111 112
    // Skip modules that don't provide info.
    if (empty($file->info)) {
      unset($files[$filename]);
      continue;
    }
113 114
    // Merge in defaults and save.
    $files[$filename]->info = $file->info + $defaults;
Steven Wittens's avatar
Steven Wittens committed
115

116 117 118 119
    // Invoke hook_system_info_alter() to give installed modules a chance to
    // modify the data in the .info files if necessary.
    drupal_alter('system_info', $files[$filename]->info, $files[$filename]);

Steven Wittens's avatar
Steven Wittens committed
120 121
    // Update the contents of the system table:
    if (isset($file->status) || (isset($file->old_filename) && $file->old_filename != $file->filename)) {
122 123 124 125 126 127 128
      db_update('system')
        ->fields(array(
            'info' => serialize($files[$filename]->info),
            'name' => $file->name,
            'filename' => $file->filename))
        ->condition('filename', $file->old_filename)
        ->execute();
Steven Wittens's avatar
Steven Wittens committed
129 130 131
    }
    else {
      // This is a new module.
132
      $files[$filename]->status = 0;
133 134 135 136 137 138 139 140
      db_insert('system')
        ->fields(array(
            'name' => $file->name,
            'info' => serialize($files[$filename]->info),
            'type' => 'module',
            'filename' => $file->filename,
            'status' => 0))
        ->execute();
Steven Wittens's avatar
Steven Wittens committed
141 142
    }
  }
143
  $files = _module_build_dependencies($files);
144 145
  return $files;
}
Steven Wittens's avatar
Steven Wittens committed
146

147
/**
148
 * Find dependencies any level deep and fill in dependents information too.
149
 *
150 151 152 153 154 155 156 157 158 159 160 161
 * If module A depends on B which in turn depends on C then this function will
 * add C to the list of modules A depends on. This will be repeated until
 * module A has a list of all modules it depends on. If it depends on itself,
 * called a circular dependency, that's marked by adding a nonexistent module,
 * called -circular- to this list of modules. Because this does not exist,
 * it'll be impossible to switch module A on.
 *
 * Also we fill in a dependents array in $file->info. Using the names above,
 * the dependents array of module B lists A.
 *
 * @param $files
 *   The array of filesystem objects used to rebuild the cache.
162
 * @return
163
 *   The same array with dependencies and dependents added where applicable.
164
 */
165 166 167 168 169 170 171 172 173
function _module_build_dependencies($files) {
  do {
    $new_dependency = FALSE;
    foreach ($files as $filename => $file) {
      // We will modify this object (module A, see doxygen for module A, B, C).
      $file = &$files[$filename];
      if (isset($file->info['dependencies']) && is_array($file->info['dependencies'])) {
        foreach ($file->info['dependencies'] as $dependency_name) {
          // This is a nonexistent module.
174
          if ($dependency_name == '-circular-' || !isset($files[$dependency_name])) {
175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203
            continue;
          }
          // $dependency_name is module B (again, see doxygen).
          $files[$dependency_name]->info['dependents'][$filename] = $filename;
          $dependency = $files[$dependency_name];
          if (isset($dependency->info['dependencies']) && is_array($dependency->info['dependencies'])) {
            // Let's find possible C modules.
            foreach ($dependency->info['dependencies'] as $candidate) {
              if (array_search($candidate, $file->info['dependencies']) === FALSE) {
                // Is this a circular dependency?
                if ($candidate == $filename) {
                  // As a module name can not contain dashes, this makes
                  // impossible to switch on the module.
                  $candidate = '-circular-';
                  // Do not display the message or add -circular- more than once.
                  if (array_search($candidate, $file->info['dependencies']) !== FALSE) {
                    continue;
                  }
                  drupal_set_message(t('%module is part of a circular dependency. This is not supported and you will not be able to switch it on.', array('%module' => $file->info['name'])), 'error');
                }
                else {
                  // We added a new dependency to module A. The next loop will
                  // be able to use this as "B module" thus finding even
                  // deeper dependencies.
                  $new_dependency = TRUE;
                }
                $file->info['dependencies'][] = $candidate;
              }
            }
204 205 206
          }
        }
      }
207 208
      // Don't forget to break the reference.
      unset($file);
209
    }
210
  } while ($new_dependency);
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 239 240 241 242 243 244 245 246 247 248 249 250 251
}

/**
 * Load a module include file.
 *
 * @param $type
 *   The include file's type (file extension).
 * @param $module
 *   The module to which the include file belongs.
 * @param $name
 *   Optionally, specify the file name. If not set, the module's name is used.
 */
function module_load_include($type, $module, $name = NULL) {
  if (empty($name)) {
    $name = $module;
  }

252
  if (drupal_function_exists('drupal_get_path')) {
253 254 255 256 257
    $file = DRUPAL_ROOT . '/' . drupal_get_path('module', $module) . "/$name.$type";
    if (is_file($file)) {
      require_once $file;
      return $file;
    }
258
  }
259
  return FALSE;
260 261 262 263 264 265 266 267 268 269
}

/**
 * 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
270 271 272 273
  }
}

/**
274
 * Enable a given list of modules.
Steven Wittens's avatar
Steven Wittens committed
275
 *
276 277
 * @param $module_list
 *   An array of module names.
Steven Wittens's avatar
Steven Wittens committed
278
 */
279 280 281
function module_enable($module_list) {
  $invoke_modules = array();
  foreach ($module_list as $module) {
282 283 284 285
    $existing = db_query("SELECT status FROM {system} WHERE type = :type AND name = :name", array(
      ':type' => 'module',
      ':name' => $module))
      ->fetchObject();
286
    if ($existing->status == 0) {
287
      module_load_install($module);
288 289 290 291 292
      db_update('system')
        ->fields(array('status' => 1))
        ->condition('type', 'module')
        ->condition('name', $module)
        ->execute();
293 294 295
      drupal_load('module', $module);
      $invoke_modules[] = $module;
    }
Steven Wittens's avatar
Steven Wittens committed
296
  }
297 298 299

  if (!empty($invoke_modules)) {
    // Refresh the module list to include the new enabled module.
300
    module_list(TRUE);
301
    // Force to regenerate the stored list of hook implementations.
302
    registry_rebuild();
303 304 305 306
  }

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

  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
321 322 323
}

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

338 339
      module_load_install($module);
      module_invoke($module, 'disable');
340 341 342 343 344
      db_update('system')
        ->fields(array('status' => 0))
        ->condition('type', 'module')
        ->condition('name', $module)
        ->execute();
345 346
      $invoke_modules[] = $module;
    }
Steven Wittens's avatar
Steven Wittens committed
347
  }
348 349

  if (!empty($invoke_modules)) {
350 351 352
    // Invoke hook_module_disable before disabling modules,
    // so we can still call module hooks to get information.
    module_invoke_all('modules_disabled', $invoke_modules);
353
    // Refresh the module list to exclude the disabled modules.
354
    module_list(TRUE);
355
    // Force to regenerate the stored list of hook implementations.
356
    registry_rebuild();
Steven Wittens's avatar
Steven Wittens committed
357
  }
358

359
  // If there remains no more node_access module, rebuilding will be
360 361 362 363
  // 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
364 365
}

366 367
/**
 * @defgroup hooks Hooks
Dries's avatar
 
Dries committed
368 369
 * @{
 * Allow modules to interact with the Drupal core.
370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
 *
 * 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) {
399 400 401 402 403 404 405
  $function = $module . '_' . $hook;
  if (defined('MAINTENANCE_MODE')) {
    return function_exists($function);
  }
  else {
    return drupal_function_exists($function);
  }
406 407
}

Dries's avatar
 
Dries committed
408 409 410 411
/**
 * Determine which modules are implementing a hook.
 *
 * @param $hook
412 413
 *   The name of the hook (e.g. "help" or "menu"). Special cases:
 *     MODULE_IMPLEMENTS_CLEAR_CACHE: Force the stored list of hook
414
 *   implementations to be regenerated (such as after enabling a new module,
415 416 417 418
 *     before processing hook_enable).
 *     MODULE_IMPLEMENTS_WRITE_CACHE: Write the stored list of hook
 *     implementations into the cache_registry table.
 * @param $sort
419
 *   By default, modules are ordered by weight and filename. By setting this
420
 *   option to TRUE, modules will be ordered by module name.
Dries's avatar
 
Dries committed
421 422
 * @return
 *   An array with the names of the modules which are implementing this hook.
423 424
 *   All enabled modules are taken into consideration and the files containing
 *   the implementations are loaded as necessary.
Dries's avatar
 
Dries committed
425
 */
426 427
function module_implements($hook, $sort = FALSE) {
  static $implementations = array(), $sorted_implementations = array(), $loaded = array(), $cached_hooks = 0;
Dries's avatar
 
Dries committed
428

429 430
  if (defined('MAINTENANCE_MODE')) {
    return _module_implements_maintenance($hook, $sort);
431
  }
432
  if ($hook === MODULE_IMPLEMENTS_CLEAR_CACHE) {
433
    $implementations = array();
434 435 436 437 438
    $sorted_implementations = array();
    $loaded = array();
    $cached_hooks = 0;
    cache_clear_all('hooks', 'cache_registry');
    return;
439
  }
440 441 442 443 444 445
  if ($hook === MODULE_IMPLEMENTS_WRITE_CACHE) {
    // Only write this to cache if we loaded new implementations.
    if (count($implementations) > $cached_hooks) {
      cache_set('hooks', $implementations, 'cache_registry');
    }
    return;
446 447
  }

448 449 450 451 452
  if (!isset($loaded[$hook])) {
    if (empty($implementations) && ($cache = cache_get('hooks', 'cache_registry'))) {
      $implementations = $cache->data;
      $cached_hooks = count($implementations);
    }
453
    if (!isset($implementations[$hook])) {
454 455 456 457 458 459
      $implementations[$hook] = db_query("SELECT module FROM {registry} WHERE type = 'function' AND suffix = :hook ORDER BY weight, module", array(':hook' => $hook))->fetchCol();
    }
    foreach ($implementations[$hook] as $module) {
      $function = $module . '_' . $hook;
      if (!function_exists($function)) {
        drupal_function_exists($function);
Dries's avatar
 
Dries committed
460 461
      }
    }
462 463
    $loaded[$hook] = TRUE;
  }
Dries's avatar
 
Dries committed
464

465 466 467 468 469 470 471 472
  if ($sort) {
    if (!isset($sorted_implementations[$hook])) {
      $sorted_implementations[$hook] = $implementations[$hook];
      sort($sorted_implementations[$hook]);
    }
    return $sorted_implementations[$hook];
  }
  else {
473 474
    return $implementations[$hook];
  }
Dries's avatar
 
Dries committed
475 476
}

477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507
/**
 * This is the maintenance version of module_implements for internal use only.
 *
 * This function is called whenever MAINTENANCE_MODE is defined and is a
 * safe code path for Drupal installation or upgrade because it does not use
 * the database, instead it uses module_list. @see module_list $fixed_list on
 * how to make module_list also DB independent.
 *
 * @param $hook
 *   The name of the hook (e.g. "help" or "menu").
 * @param $sort
 *   By default, modules are ordered by weight and filename, settings this
 *   option to TRUE, module list will be ordered by module name.
 * @return
 *   An array with the names of the modules which are implementing this hook.
 *   Only enabled and already loaded modules are taken into consideration.
 */
function _module_implements_maintenance($hook, $sort = FALSE) {
  $implementations = array();
  foreach (module_list() as $module) {
    $function = $module . '_' . $hook;
    if (function_exists($function)) {
      $implementations[] = $module;
    }
    if ($sort) {
      sort($implementations);
    }
  }
  return $implementations;
}

508 509 510 511 512 513 514 515 516 517 518 519
/**
 * 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.
 */
520 521
function module_invoke() {
  $args = func_get_args();
522 523 524
  $module = $args[0];
  $hook = $args[1];
  unset($args[0], $args[1]);
525
  if (module_hook($module, $hook)) {
526
    return call_user_func_array($module . '_' . $hook, $args);
527 528 529 530 531 532 533 534 535 536 537 538 539
  }
}
/**
 * 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.
 */
540 541
function module_invoke_all() {
  $args = func_get_args();
542 543
  $hook = $args[0];
  unset($args[0]);
544
  $return = array();
545
  foreach (module_implements($hook) as $module) {
546
    $function = $module . '_' . $hook;
547 548 549 550 551
    if (drupal_function_exists($function)) {
      $result = call_user_func_array($function, $args);
      if (isset($result) && is_array($result)) {
        $return = array_merge_recursive($return, $result);
      }
552
      elseif (isset($result)) {
553 554
        $return[] = $result;
      }
555
    }
556 557 558 559 560 561
  }

  return $return;
}

/**
Dries's avatar
 
Dries committed
562
 * @} End of "defgroup hooks".
563 564
 */

565 566 567 568
/**
 * Array of modules required by core.
 */
function drupal_required_modules() {
569 570 571 572 573 574 575 576 577
  $files = drupal_system_listing('/\.info$/', 'modules', 'name', 0);
  $required = array();
  foreach ($files as $name => $file) {
    $info = drupal_parse_info_file($file->filename);
    if (!empty($info) && !empty($info['required']) && $info['required']) {
      $required[] = $name;
    }
  }
  return $required;
578
}