Update Error_AuthSource to become a standard base class for authsource

olavmo-sikt · olavmo-sikt · commit 7644eb4e1b81 · 2011-04-12T13:44:19.000Z
errors. Thanks to Andjelko Horvat for adding this. git-svn-id: https://simplesamlphp.googlecode.com/svn/trunk@2812 44740490-163a-0410-bde0-09ae8108e29a
diff --git a/dictionaries/errors.definition.json b/dictionaries/errors.definition.json
@@ -211,5 +211,11 @@
 	},
 	"descr_METADATANOTFOUND": {
 		"en": "Unable to locate metadata for %ENTITYID%"
+	},
+	"title_AUTHSOURCEERROR": {
+		"en": "Authentication source error"
+	},
+	"descr_AUTHSOURCEERROR": {
+		"en": "Authentication error in source %AUTHSOURCE%. The reason was: %REASON%"
 	}
 }
diff --git a/dictionaries/errors.translation.json b/dictionaries/errors.translation.json
@@ -1498,5 +1498,11 @@
 		"hr": "Metapodaci za %ENTITYID% nisu prona\u0111eni",
 		"it": "Impossibile individuare i metatadi per %ENTITYID%",
 		"sv": "Kan inte hitta metadata f\u00f6r %ENTITYID%"
+	},
+	"title_AUTHSOURCEERROR": {
+		"hr": "Pogreška u autentikacijskom modulu"
+	},
+	"descr_AUTHSOURCEERROR": {
+		"hr": "Pogreška u %AUTHSOURCE% autentikacijskom modulu. Razlog: %REASON%"
 	}
 }
diff --git a/lib/SimpleSAML/Auth/LDAP.php b/lib/SimpleSAML/Auth/LDAP.php
@@ -136,9 +136,9 @@ private function makeException($description, $type = NULL) {
 				case ERR_WRONG_PW:// 3 - ExInvalidCredential
 					return new SimpleSAML_Error_InvalidCredential($description, $errNo);
 				case ERR_AS_DATA_INCONSIST:// 4 - ExAsDataInconsist
-					return new SimpleSAML_Error_AuthSource($description, $errNo);
+					return new SimpleSAML_Error_AuthSource('ldap', $description);
 				case ERR_AS_INTERNAL:// 5 - ExAsInternal
-					return new SimpleSAML_Error_AuthSource($description, $errNo);
+					return new SimpleSAML_Error_AuthSource('ldap', $description);
 			}
 		}else{
 			switch ($errNo){
@@ -150,10 +150,10 @@ private function makeException($description, $type = NULL) {
 					return new SimpleSAML_Error_InvalidCredential($description, $errNo);
 				case -1://NO_SERVER_CONNECTION
 					SimpleSAML_Logger::error($description . '; cause: \'' . ldap_error($this->ldap) . '\' (0x' . dechex($errNo) . ')');
-					return new SimpleSAML_Error_AuthSource($description, $errNo);
+					return new SimpleSAML_Error_AuthSource('ldap', $description);
 				default:
 					SimpleSAML_Logger::error($description . '; cause: \'' . ldap_error($this->ldap) . '\' (0x' . dechex($errNo) . ')');
-					return new SimpleSAML_Error_AuthSource($description, $errNo);
+					return new SimpleSAML_Error_AuthSource('ldap', $description);
 			}
 		}
 	}
diff --git a/lib/SimpleSAML/Error/AuthSource.php b/lib/SimpleSAML/Error/AuthSource.php
@@ -2,12 +2,67 @@
 /**
  * Baseclass for auth source exceptions.
  * 
- * @author Thomas Graff <thomas.graff@uninett.no>
  * @package simpleSAMLphp_base
  * @version $Id$
  *
  */
-class SimpleSAML_Error_AuthSource extends SimpleSAML_Error_Exception{
+class SimpleSAML_Error_AuthSource extends SimpleSAML_Error_Error {
+
+
+	/**
+	 * Authsource module name.
+	 */
+	private $authsource;
+
+
+	/**
+	 * Reason why this request was invalid.
+	 */
+	private $reason;
+
+
+	/**
+	 * Create a new AuthSource error.
+	 *
+	 * @param string $authsource  Authsource module name from where this error was thrown.
+	 * @param string $reason  Description of the error.
+	 */
+	public function __construct($authsource, $reason, $cause = NULL) {
+		assert('is_string($authsource)');
+		assert('is_string($reason)');
+
+		$this->authsource = $authsource;
+		$this->reason = $reason;
+		parent::__construct(
+			array(
+				'AUTHSOURCEERROR',
+				'%AUTHSOURCE%' => htmlspecialchars(var_export($this->authsource, TRUE)),
+				'%REASON%' => htmlspecialchars(var_export($this->reason, TRUE))
+			),
+			$cause
+		);
+	}
+
+
+	/**
+	 * Retrieve the authsource module name from where this error was thrown.
+	 *
+	 * @return string  Authsource module name.
+	 */
+	public function getAuthSource() {
+		return $this->authsource;
+	}
+
+
+	/**
+	 * Retrieve the reason why the request was invalid.
+	 *
+	 * @return string  The reason why the request was invalid.
+	 */
+	public function getReason() {
+		return $this->reason;
+	}
+
 	
 }
 

Original file line number	Diff line number	Diff line change
`@@ -211,5 +211,11 @@`
`211`	`211`	`},`
`212`	`212`	`"descr_METADATANOTFOUND": {`
`213`	`213`	`"en": "Unable to locate metadata for %ENTITYID%"`
	`214`	`+ },`
	`215`	`+ "title_AUTHSOURCEERROR": {`
	`216`	`+ "en": "Authentication source error"`
	`217`	`+ },`
	`218`	`+ "descr_AUTHSOURCEERROR": {`
	`219`	`+ "en": "Authentication error in source %AUTHSOURCE%. The reason was: %REASON%"`
`214`	`220`	`}`
`215`	`221`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1498,5 +1498,11 @@`
`1498`	`1498`	`"hr": "Metapodaci za %ENTITYID% nisu prona\u0111eni",`
`1499`	`1499`	`"it": "Impossibile individuare i metatadi per %ENTITYID%",`
`1500`	`1500`	`"sv": "Kan inte hitta metadata f\u00f6r %ENTITYID%"`
	`1501`	`+ },`
	`1502`	`+ "title_AUTHSOURCEERROR": {`
	`1503`	`+ "hr": "Pogreška u autentikacijskom modulu"`
	`1504`	`+ },`
	`1505`	`+ "descr_AUTHSOURCEERROR": {`
	`1506`	`+ "hr": "Pogreška u %AUTHSOURCE% autentikacijskom modulu. Razlog: %REASON%"`
`1501`	`1507`	`}`
`1502`	`1508`	`}`
Original file line number	Diff line number	Diff line change
`@@ -136,9 +136,9 @@ private function makeException($description, $type = NULL) {`
`136`	`136`	`case ERR_WRONG_PW:// 3 - ExInvalidCredential`
`137`	`137`	`return new SimpleSAML_Error_InvalidCredential($description, $errNo);`
`138`	`138`	`case ERR_AS_DATA_INCONSIST:// 4 - ExAsDataInconsist`
`139`		`- return new SimpleSAML_Error_AuthSource($description, $errNo);`
	`139`	`+ return new SimpleSAML_Error_AuthSource('ldap', $description);`
`140`	`140`	`case ERR_AS_INTERNAL:// 5 - ExAsInternal`
`141`		`- return new SimpleSAML_Error_AuthSource($description, $errNo);`
	`141`	`+ return new SimpleSAML_Error_AuthSource('ldap', $description);`
`142`	`142`	`}`
`143`	`143`	`}else{`
`144`	`144`	`switch ($errNo){`
`@@ -150,10 +150,10 @@ private function makeException($description, $type = NULL) {`
`150`	`150`	`return new SimpleSAML_Error_InvalidCredential($description, $errNo);`
`151`	`151`	`case -1://NO_SERVER_CONNECTION`
`152`	`152`	`SimpleSAML_Logger::error($description . '; cause: \'' . ldap_error($this->ldap) . '\' (0x' . dechex($errNo) . ')');`
`153`		`- return new SimpleSAML_Error_AuthSource($description, $errNo);`
	`153`	`+ return new SimpleSAML_Error_AuthSource('ldap', $description);`
`154`	`154`	`default:`
`155`	`155`	`SimpleSAML_Logger::error($description . '; cause: \'' . ldap_error($this->ldap) . '\' (0x' . dechex($errNo) . ')');`
`156`		`- return new SimpleSAML_Error_AuthSource($description, $errNo);`
	`156`	`+ return new SimpleSAML_Error_AuthSource('ldap', $description);`
`157`	`157`	`}`
`158`	`158`	`}`
`159`	`159`	`}`