Add a new hook to let a module add information about it self, also add a sanitycheck to resolve missing module dependencies

andreassolberg · andreassolberg · commit d8b9ade1594f · 2008-11-14T21:55:18.000Z
git-svn-id: https://simplesamlphp.googlecode.com/svn/trunk@999 44740490-163a-0410-bde0-09ae8108e29a
diff --git a/modules/core/hooks/hook_sanitycheck.php b/modules/core/hooks/hook_sanitycheck.php
@@ -31,5 +31,22 @@ function core_hook_sanitycheck(&$hookinfo) {
 		$hookinfo['errors'][] = '[core] You are running PHP version ' . phpversion() . '. SimpleSAMLphp requires version >= 5.1.2, and reccomends version >= 5.2. Please upgrade!';
 	}
 	
+	$info = array();
+	$mihookinfo = array(
+		'info' => &$info,
+	);
+	$availmodules = SimpleSAML_Module::getModules();
+	SimpleSAML_Module::callHooks('moduleinfo', $mihookinfo);
+	foreach($info AS $mi => $i) {
+		if (isset($i['dependencies']) && is_array($i['dependencies'])) {
+			foreach ($i['dependencies'] AS $dep) {
+				// $hookinfo['info'][] = '[core] Module ' . $mi . ' requires ' . $dep;
+				if (!in_array($dep, $availmodules)) {
+					$hookinfo['errors'][] = '[core] Module dependency not met: ' . $mi . ' requires ' . $dep;
+				}
+			}
+		}
+	}
+	
 }
 ?>
diff --git a/modules/modinfo/hooks/hook_moduleinfo.php b/modules/modinfo/hooks/hook_moduleinfo.php
@@ -0,0 +1,21 @@
+<?php
+/**
+ * This hook lets the module describe itself.
+ *
+ * @param array &$moduleinfo  The links on the frontpage, split into sections.
+ */
+function modinfo_hook_moduleinfo(&$moduleinfo) {
+	assert('is_array($moduleinfo)');
+	assert('array_key_exists("info", $moduleinfo)');
+	
+
+	$moduleinfo['info']['modinfo'] = array(
+		'name' => array('en' => 'Module information'),
+		'description' => array('en' => 'This module lists all available modules, and tells whether they are enabled or not.'),
+		
+		'dependencies' => array('core'),
+		'uses' => array('sanitycheck'),
+	);
+
+}
+?>
diff --git a/modules/modinfo/www/index.php b/modules/modinfo/www/index.php
@@ -8,7 +8,7 @@
 foreach($modules as $m) {
 	$modinfo[$m] = array(
 		'enabled' => SimpleSAML_Module::isModuleEnabled($m),
-		);
+	);
 }
 
 $config = SimpleSAML_Configuration::getInstance();
diff --git a/modules/sanitycheck/hooks/hook_moduleinfo.php b/modules/sanitycheck/hooks/hook_moduleinfo.php
@@ -0,0 +1,20 @@
+<?php
+/**
+ * This hook lets the module describe itself.
+ *
+ * @param array &$moduleinfo  The links on the frontpage, split into sections.
+ */
+function sanitycheck_hook_moduleinfo(&$moduleinfo) {
+	assert('is_array($moduleinfo)');
+	assert('array_key_exists("info", $moduleinfo)');
+
+	$moduleinfo['info']['sanitycheck'] = array(
+		'name' => array('en' => 'Sanity check'),
+		'description' => array('en' => 'This module adds functionality for other modules to provide santity checks.'),
+		
+		'dependencies' => array('core'),
+		'uses' => array('cron'),
+	);
+
+}
+?>
diff --git a/modules/sanitycheck/hooks/hook_sanitycheck.php b/modules/sanitycheck/hooks/hook_sanitycheck.php
@@ -9,11 +9,7 @@ function sanitycheck_hook_sanitycheck(&$hookinfo) {
 	assert('array_key_exists("errors", $hookinfo)');
 	assert('array_key_exists("info", $hookinfo)');
 
-
-
 	$hookinfo['info'][] = '[sanitycheck] At least the sanity check it self is working :)';	
-
-	
 	
 }
 ?>

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`	`foreach($modules as $m) {`
`9`	`9`	`$modinfo[$m] = array(`
`10`	`10`	`'enabled' => SimpleSAML_Module::isModuleEnabled($m),`
`11`		`- );`
	`11`	`+ );`
`12`	`12`	`}`
`13`	`13`
`14`	`14`	`$config = SimpleSAML_Configuration::getInstance();`