diff options
author | Dries Buytaert <dries@buytaert.net> | 2001-05-05 13:57:29 +0000 |
---|---|---|
committer | Dries Buytaert <dries@buytaert.net> | 2001-05-05 13:57:29 +0000 |
commit | be8e898d23a3f9ca515f59fbcc8d82e112ed7ee8 (patch) | |
tree | cf0d05f6b767f36e7feb09a3bc59cbc9a01e459b /includes/module.inc | |
parent | 16818777616eadeb8a4670324e099b95c8d53e3b (diff) | |
download | brdo-be8e898d23a3f9ca515f59fbcc8d82e112ed7ee8.tar.gz brdo-be8e898d23a3f9ca515f59fbcc8d82e112ed7ee8.tar.bz2 |
- Uhm. Rewrote the module system: less code clutter, less run-time
overhead, and a lot better (simpler) module API. I had to edit a
LOT of files to get this refactored but I'm sure it was worth the
effort.
For module writers / maintainers:
None of the hooks changed, so 95% of the old modules should still
work. You can remove some code instead as "$module = array(...)"
just became obsolete. Also - and let's thank God for this - the
global variable "$repository" has been eliminated to avoid modules
relying on, and poking in drupal's internal data structures. Take
a look at include/module.inc to investigate the details/changes.
- Improved design of the content modules "story", "book" and "node"
(to aid smooth integration of permisions + moderate.module). I'm
still working on the permissions but I got side tracked for which
I "Oops!".
Diffstat (limited to 'includes/module.inc')
-rw-r--r-- | includes/module.inc | 96 |
1 files changed, 57 insertions, 39 deletions
diff --git a/includes/module.inc b/includes/module.inc index a23d142a0..732584861 100644 --- a/includes/module.inc +++ b/includes/module.inc @@ -1,28 +1,60 @@ <?php -// applies function $function to every known module: +// initialize modules: +function module_init() { + module_list(); +} + +// apply function $function to every known module: function module_iterate($function, $argument = "") { - global $repository; - foreach ($repository as $name=>$module) { - $function($name, $module, $argument); + foreach (module_list() as $name) $function($name, $argument); +} + +// invoke hook $hook of module $name with optional arguments: +function module_invoke($name, $hook, $argument = "") { + $function = $name ."_". $hook; + if (function_exists($function)) return $function($argument); +} + +// return true if module $name supports hook $hook, and false otherwise: +function module_is_hook($name, $hook) { + return function_exists($name ."_". $hook); +} + +// return an array of module names (includes lazy module loading): +function module_list() { + static $list; + + if (!$list) { + $handle = opendir("modules"); + $list = array(); + while ($file = readdir($handle)) { + if (".module" == substr($file, -7)) { + $filename = substr($file, 0, -7); + include "modules/$filename.module"; + $list[$filename] = $filename; + } + } + closedir($handle); } + + return $list; } -// executes hook $hook of module $module with optional arguments: -function module_execute($module, $hook, $argument = "") { - global $repository; - return ($repository[$module][$hook]) ? $repository[$module][$hook]($argument) : ""; +// return 1 if module $name exists, 0 otherwise: +function module_exist($name) { + $list = module_list(); + return ($list[$name]) ? 1 : 0; } -// returns true if module $module supports hook $hook, and false otherwise: -function module_hook($module, $hook) { - global $repository; - return $repository[$module][$hook]; +// return 1 if module $name implements hook $hook, 0 otherwise: +function module_hook($name, $hook) { + return function_exists($name ."_". $hook); } -// rehashes the crons: -function module_rehash_crons($name, $module) { - if ($module["cron"]) { +// rehash module-exported crons: +function module_rehash_crons($name) { + if (module_hook($name, "cron")) { if (!db_fetch_object(db_query("SELECT * FROM crons WHERE module = '$name'"))) { db_query("INSERT INTO crons (module, scheduled, timestamp) VALUES ('$name', '172800', '0')"); } @@ -32,10 +64,10 @@ function module_rehash_crons($name, $module) { } } -// rehashes the blocks: -function module_rehash_blocks($name, $module) { +// rehash module-exported blocks: +function module_rehash_blocks($name) { db_query("UPDATE blocks SET remove = '1' WHERE module = '$name'"); - if ($module["block"] && $blocks = $module["block"]()) { + if ($blocks = module_invoke($name, "block")) { foreach ($blocks as $offset=>$block) { foreach ($block as $item=>$data) { $block[$item] = addslashes($data); @@ -51,22 +83,20 @@ function module_rehash_blocks($name, $module) { db_query("DELETE FROM blocks WHERE module = '$name' AND remove = '1'"); } -// rehashes a module: +// rehash a module: function module_rehash($name) { - global $repository; - - if ($module = $repository[$name]) { + if (module_exist($name)) { $result = db_query("SELECT * FROM modules WHERE name = '$name'"); if (!$object = db_fetch_object($result)) { db_query("INSERT INTO modules (name) VALUES ('$name')"); } - // rehash crons (if necessary): - module_rehash_crons($name, $module); + // rehash module-exported crons (if necessary): + module_rehash_crons($name); - // rehash blocks (if necessary): - module_rehash_blocks($name, $module); + // rehash module-exported blocks (if necessary): + module_rehash_blocks($name); } else { // remove all reference to module: @@ -76,16 +106,4 @@ function module_rehash($name) { } } -// load modules into repository: -$handle = opendir("modules"); -$repository = array(); -while ($file = readdir($handle)) { - if (".module" == substr($file, -7)) { - $filename = substr($file, 0, -7); - include "modules/$filename.module"; - $repository[$filename] = $module; - } -} -closedir($handle); - -?> +?>
\ No newline at end of file |