module.inc 10.3 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
function module_load_all() {
13
14
15
  foreach (module_list(TRUE, FALSE) as $module) {
    drupal_load('module', $module);
  }
16
17
}

18
19
20
21
/**
 * Call a function repeatedly with each module in turn as an argument.
 */
function module_iterate($function, $argument = '') {
Kjartan's avatar
Kjartan committed
22
23
24
  foreach (module_list() as $name) {
    $function($name, $argument);
  }
25
26
}

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

50
  if ($refresh || $fixed_list) {
51
    unset($sorted_list);
Dries's avatar
Dries committed
52
    $list = array();
53
54
55
56
57
    if ($fixed_list) {
      foreach ($fixed_list as $name => $module) {
        drupal_get_filename('module', $name, $module['filename']);
        $list[$name] = $name;
      }
58
59
    }
    else {
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
      if ($bootstrap) {
        $result = db_query("SELECT name, filename, throttle, bootstrap FROM {system} WHERE type = 'module' AND status = 1 AND bootstrap = 1 ORDER BY weight ASC, filename ASC");
      }
      else {
        $result = db_query("SELECT name, filename, throttle, bootstrap FROM {system} WHERE type = 'module' AND status = 1 ORDER BY weight ASC, filename ASC");
      }
      while ($module = db_fetch_object($result)) {
        if (file_exists($module->filename)) {
          // Determine the current throttle status and see if the module should be
          // loaded based on server load. We have to directly access the throttle
          // variables, since throttle.module may not be loaded yet.
          $throttle = ($module->throttle && variable_get('throttle_level', 0) > 0);
          if (!$throttle) {
            drupal_get_filename('module', $module->name, $module->filename);
            $list[$module->name] = $module->name;
          }
Dries's avatar
   
Dries committed
76
        }
77
      }
78
79
    }
  }
80
81
82
83
84
85
86
  if ($sort) {
    if (!isset($sorted_list)) {
      $sorted_list = $list;
      ksort($sorted_list);
    }
    return $sorted_list;
  }
87
88
89
  return $list;
}

Steven Wittens's avatar
Steven Wittens committed
90
91
/**
 * Rebuild the database cache of module files.
92
 *
Steven Wittens's avatar
Steven Wittens committed
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 * @return
 *   The array of filesystem objects used to rebuild the cache.
 */
function module_rebuild_cache() {
  // Get current list of modules
  $files = system_listing('\.module$', 'modules', 'name', 0);

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

  ksort($files);

  foreach ($files as $filename => $file) {
    drupal_get_filename('module', $file->name, $file->filename);
    drupal_load('module', $file->name);

    // log the critical hooks implemented by this module
    $bootstrap = 0;
    foreach (bootstrap_hooks() as $hook) {
      if (module_hook($file->name, $hook)) {
        $bootstrap = 1;
        break;
      }
    }

    // Update the contents of the system table:
    if (isset($file->status) || (isset($file->old_filename) && $file->old_filename != $file->filename)) {
      db_query("UPDATE {system} SET description = '%s', name = '%s', filename = '%s', bootstrap = %d WHERE filename = '%s'", $file->description, $file->name, $file->filename, $bootstrap, $file->old_filename);
    }
    else {
      // This is a new module.
      db_query("INSERT INTO {system} (name, description, type, filename, status, throttle, bootstrap) VALUES ('%s', '%s', '%s', '%s', %d, %d, %d)", $file->name, $file->description, 'module', $file->filename, $file->status, $file->throttle, $bootstrap);
    }
  }

  return $files;
}

131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
/**
 * Parse Drupal meta file format.
 * Uses ini parser provided by php's parse_ini_file().
 * You should not use the meta files to store module specific settings:
 * user <code>variable_get()</code> and <code>variable_set()</code> for those.
 *
 * Files should use the ini format to specify values:
 *   key = "value"
 *   key2 = value2
 *
 * @param $filename
 *   The file we are parsing.  Accepts file with relative or absolute path.
 * @return
 *   The meta data array.
 */
function module_parse_meta_file($filename) {
  $metadata = array();

  if (file_exists($filename)) {
    $metadata = parse_ini_file($filename);
  }
  return $metadata;
}

155
156
157
158
159
160
161
162
/**
 * 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.
 */
163
function module_exists($module) {
164
  $list = module_list();
165
  return array_key_exists($module, $list);
166
167
}

Steven Wittens's avatar
Steven Wittens committed
168
169
170
171
172
173
174
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
204
205
206
207
/**
 * Load a module's installation hooks.
 */
function module_load_install($module) {
  // Make sure the installation API is available
  include_once './includes/install.inc';

  $install_file = './'. drupal_get_path('module', $module) .'/'. $module .'.install';
  if (is_file($install_file)) {
    include_once $install_file;
  }
}

/**
 * Enable a given module.
 *
 * @param $module
 * Enable a given module and call its enable hook.
 */
function module_enable($module) {
  $existing = db_fetch_object(db_query("SELECT name, status FROM {system} WHERE type = 'module' AND name = '%s'", $module));
  if ($existing->status === '0') {
    module_load_install($module);
    db_query("UPDATE {system} SET status = 1, throttle = 0 WHERE type = 'module' AND name = '%s'", $module);
    drupal_load('module', $module);
    module_invoke($module, 'enable');
    return TRUE;
  }
  else {
    return FALSE;
  }
}

/**
 * Disable a given module and call its disable hook.
 *
 * @param $module
 *   The name of the module (without the .module extension).
 */
function module_disable($module) {
208
  if (module_exists($module)) {
Steven Wittens's avatar
Steven Wittens committed
209
210
211
212
213
214
215
216
217
218
    module_load_install($module);
    module_invoke($module, 'disable');
    db_query("UPDATE {system} SET status = 0, throttle = 0 WHERE type = 'module' AND name = '%s'", $module);
    return TRUE;
  }
  else {
    return FALSE;
  }
}

219
220
/**
 * @defgroup hooks Hooks
Dries's avatar
   
Dries committed
221
222
 * @{
 * Allow modules to interact with the Drupal core.
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 *
 * 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) {
  return function_exists($module .'_'. $hook);
253
254
}

Dries's avatar
   
Dries committed
255
256
257
258
259
/**
 * Determine which modules are implementing a hook.
 *
 * @param $hook
 *   The name of the hook (e.g. "help" or "menu").
260
261
262
 * @param $sort
 *   By default, modules are ordered by weight and filename, settings this option
 *   to TRUE, module list will be ordered by module name.
Dries's avatar
   
Dries committed
263
264
265
 * @return
 *   An array with the names of the modules which are implementing this hook.
 */
266
function module_implements($hook, $sort = FALSE) {
Dries's avatar
   
Dries committed
267
268
269
270
  static $implementations;

  if (!isset($implementations[$hook])) {
    $implementations[$hook] = array();
271
    $list = module_list(FALSE, TRUE, $sort);
Dries's avatar
   
Dries committed
272
273
274
275
276
277
278
    foreach ($list as $module) {
      if (module_hook($module, $hook)) {
        $implementations[$hook][] = $module;
      }
    }
  }

279
  // The explicit cast forces a copy to be made. This is needed because
280
281
282
283
284
285
  // $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];
Dries's avatar
   
Dries committed
286
287
}

288
289
290
291
292
293
294
295
296
297
298
299
/**
 * 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.
 */
300
301
302
303
function module_invoke() {
  $args = func_get_args();
  $module = array_shift($args);
  $hook = array_shift($args);
304
  $function = $module .'_'. $hook;
305
306
  if (module_hook($module, $hook)) {
    return call_user_func_array($function, $args);
307
308
309
310
311
312
313
314
315
316
317
318
319
  }
}
/**
 * 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.
 */
320
321
322
function module_invoke_all() {
  $args = func_get_args();
  $hook = array_shift($args);
323
  $return = array();
324
325
326
  foreach (module_implements($hook) as $module) {
    $function = $module .'_'. $hook;
    $result = call_user_func_array($function, $args);
327
    if (isset($result) && is_array($result)) {
328
329
      $return = array_merge($return, $result);
    }
330
331
332
    else if (isset($result)) {
      $return[] = $result;
    }
333
334
335
336
337
338
  }

  return $return;
}

/**
Dries's avatar
   
Dries committed
339
 * @} End of "defgroup hooks".
340
341
 */

342