Implementing cron hook in metarefresh module...

andreassolberg · andreassolberg · commit c754cda5e971 · 2008-11-29T07:54:42.000Z
git-svn-id: https://simplesamlphp.googlecode.com/svn/trunk@1032 44740490-163a-0410-bde0-09ae8108e29a
diff --git a/modules/metarefresh/hooks/hook_cron.php b/modules/metarefresh/hooks/hook_cron.php
@@ -0,0 +1,43 @@
+<?php
+/**
+ * Hook to run a cron job.
+ *
+ * @param array &$croninfo  Output
+ */
+function metarefresh_hook_cron(&$croninfo) {
+	assert('is_array($croninfo)');
+	assert('array_key_exists("summary", $croninfo)');
+	assert('array_key_exists("tag", $croninfo)');
+
+	SimpleSAML_Logger::info('cron [metarefresh]: Running cron in cron tag [' . $croninfo['tag'] . '] ');
+
+	try {
+		$config = SimpleSAML_Configuration::getInstance();
+		$mconfig = $config->copyFromBase('mconfig', 'config-metarefresh.php');
+		
+		$sets = $mconfig->getValue('sets');
+		if (count($sets) < 1) return; 
+	
+		foreach ($sets AS $setkey => $set) {
+			// Only process sets where cron matches the current cron tag.
+			if (!in_array($croninfo['tag'], $set['cron'])) continue;
+	
+			SimpleSAML_Logger::info('cron [metarefresh]: Executing set [' . $setkey . ']');
+	
+			$maxcache = NULL; if (array_key_exists('maxcache', $set)) $maxcache = $set['maxcache'];
+			$maxduration = NULL; if (array_key_exists('maxduration', $set)) $maxcache = $set['maxduration'];
+			$metaloader = new sspmod_metarefresh_MetaLoader($maxcache, $maxduration);		
+			
+			foreach($set['sources'] AS $source) {
+				SimpleSAML_Logger::debug('cron [metarefresh]: In set [' . $setkey . '] loading source ['  . $source['src'] . ']');
+				$metaloader->loadSource($source);
+			}
+			$metaloader->writeMetadataFiles($config->resolvePath($set['outputDir']));
+		}
+	
+	} catch (Exception $e) {
+		$croninfo['summary'][] = 'Error during metarefresh: ' . $e->getMessage();
+	}
+	
+}
+?>
diff --git a/modules/metarefresh/lib/MetaLoader.php b/modules/metarefresh/lib/MetaLoader.php
@@ -30,21 +30,21 @@ public function __construct($maxcache = NULL, $maxduration = NULL) {
 	 *
 	 * @param $src  Filename of the metadata file.
 	 */
-	public function loadSource($src, $validateFingerprint = NULL, $template = NULL) {
+	public function loadSource($source, $validateFingerprint = NULL, $template = NULL) {
 
-		$entities = SimpleSAML_Metadata_SAMLParser::parseDescriptorsFile($src);
+		$entities = SimpleSAML_Metadata_SAMLParser::parseDescriptorsFile($source['src']);
 	
 		foreach($entities as $entity) {
 			if($validateFingerprint !== NULL) {
 				if(!$entity->validateFingerprint($validateFingerprint)) {
-					echo('Skipping "' . $entity->getEntityId() . '" - could not verify signature.' . "\n");
+					SimpleSAML_Logger::info('Skipping "' . $entity->getEntityId() . '" - could not verify signature.' . "\n");
 					continue;
 				}
 			}
 	
 			if($ca !== NULL) {
 				if(!$entity->validateCA($ca)) {
-					echo('Skipping "' . $entity->getEntityId() . '" - could not verify certificate.' . "\n");
+					SimpleSAML_Logger::info('Skipping "' . $entity->getEntityId() . '" - could not verify certificate.' . "\n");
 					continue;
 				}
 			}
@@ -122,19 +122,19 @@ function writeMetadataFiles($outputDir) {
 		}
 	
 		if(!file_exists($outputDir)) {
-			echo('Creating directory: ' . $outputDir . "\n");
+			SimpleSAML_Logger::info('Creating directory: ' . $outputDir . "\n");
 			mkdir($outputDir, 0777, TRUE);
 		}
 	
 		foreach($this->metadata as $category => $elements) {
 	
 			$filename = $outputDir . '/' . $category . '.php';
 	
-			echo('Writing: ' . $filename . "\n");
+			SimpleSAML_Logger::debug('Writing: ' . $filename . "\n");
 	
-			$fh = fopen($filename, 'w');
+			$fh = @fopen($filename, 'w');
 			if($fh === FALSE) {
-				echo('Failed to open file for writing: ' . $filename . "\n");
+				throw new Exception('Failed to open file for writing: ' . $filename . "\n");
 				exit(1);
 			}
 	

Original file line number	Diff line number	Diff line change
`@@ -30,21 +30,21 @@ public function __construct($maxcache = NULL, $maxduration = NULL) {`
`30`	`30`	`*`
`31`	`31`	`* @param $src Filename of the metadata file.`
`32`	`32`	`*/`
`33`		`- public function loadSource($src, $validateFingerprint = NULL, $template = NULL) {`
	`33`	`+ public function loadSource($source, $validateFingerprint = NULL, $template = NULL) {`
`34`	`34`
`35`		`- $entities = SimpleSAML_Metadata_SAMLParser::parseDescriptorsFile($src);`
	`35`	`+ $entities = SimpleSAML_Metadata_SAMLParser::parseDescriptorsFile($source['src']);`
`36`	`36`
`37`	`37`	`foreach($entities as $entity) {`
`38`	`38`	`if($validateFingerprint !== NULL) {`
`39`	`39`	`if(!$entity->validateFingerprint($validateFingerprint)) {`
`40`		`- echo('Skipping "' . $entity->getEntityId() . '" - could not verify signature.' . "\n");`
	`40`	`+ SimpleSAML_Logger::info('Skipping "' . $entity->getEntityId() . '" - could not verify signature.' . "\n");`
`41`	`41`	`continue;`
`42`	`42`	`}`
`43`	`43`	`}`
`44`	`44`
`45`	`45`	`if($ca !== NULL) {`
`46`	`46`	`if(!$entity->validateCA($ca)) {`
`47`		`- echo('Skipping "' . $entity->getEntityId() . '" - could not verify certificate.' . "\n");`
	`47`	`+ SimpleSAML_Logger::info('Skipping "' . $entity->getEntityId() . '" - could not verify certificate.' . "\n");`
`48`	`48`	`continue;`
`49`	`49`	`}`
`50`	`50`	`}`
`@@ -122,19 +122,19 @@ function writeMetadataFiles($outputDir) {`
`122`	`122`	`}`
`123`	`123`
`124`	`124`	`if(!file_exists($outputDir)) {`
`125`		`- echo('Creating directory: ' . $outputDir . "\n");`
	`125`	`+ SimpleSAML_Logger::info('Creating directory: ' . $outputDir . "\n");`
`126`	`126`	`mkdir($outputDir, 0777, TRUE);`
`127`	`127`	`}`
`128`	`128`
`129`	`129`	`foreach($this->metadata as $category => $elements) {`
`130`	`130`
`131`	`131`	`$filename = $outputDir . '/' . $category . '.php';`
`132`	`132`
`133`		`- echo('Writing: ' . $filename . "\n");`
	`133`	`+ SimpleSAML_Logger::debug('Writing: ' . $filename . "\n");`
`134`	`134`
`135`		`- $fh = fopen($filename, 'w');`
	`135`	`+ $fh = @fopen($filename, 'w');`
`136`	`136`	`if($fh === FALSE) {`
`137`		`- echo('Failed to open file for writing: ' . $filename . "\n");`
	`137`	`+ throw new Exception('Failed to open file for writing: ' . $filename . "\n");`
`138`	`138`	`exit(1);`
`139`	`139`	`}`
`140`	`140`