From fff536ac9a598321f03f23f77a922487f7d41154 Mon Sep 17 00:00:00 2001 From: zYne Date: Thu, 14 Dec 2006 22:26:58 +0000 Subject: [PATCH] Added portable error functionality --- lib/Doctrine/Connection/Exception.php | 71 +++++++++++-- .../Connection/Firebird/Exception.php | 99 ++++++++++++++++++- lib/Doctrine/Connection/Mssql/Exception.php | 40 +++++++- lib/Doctrine/Connection/Mysql/Exception.php | 50 +++++++++- lib/Doctrine/Connection/Oracle/Exception.php | 45 ++++++++- lib/Doctrine/Connection/Pgsql/Exception.php | 69 ++++++++++++- lib/Doctrine/Connection/Sqlite/Exception.php | 43 +++++++- 7 files changed, 402 insertions(+), 15 deletions(-) diff --git a/lib/Doctrine/Connection/Exception.php b/lib/Doctrine/Connection/Exception.php index 3e1d69674..bfa7424df 100644 --- a/lib/Doctrine/Connection/Exception.php +++ b/lib/Doctrine/Connection/Exception.php @@ -22,12 +22,65 @@ Doctrine::autoload('Doctrine_Exception'); /** * Doctrine_Exception * - * @package Doctrine - * @license http://www.opensource.org/licenses/lgpl-license.php LGPL - * @category Object Relational Mapping - * @link www.phpdoctrine.com - * @since 1.0 - * @version $Revision$ - * @author Konsta Vesterinen - */ -class Doctrine_Connection_Exception extends Doctrine_Exception { } + * @package Doctrine + * @license http://www.opensource.org/licenses/lgpl-license.php LGPL + * @category Object Relational Mapping + * @link www.phpdoctrine.com + * @since 1.0 + * @version $Revision$ + * @author Konsta Vesterinen + */ +class Doctrine_Connection_Exception extends Doctrine_Exception { + /** + * @var array $errorMessages an array containing messages for portable error codes + */ + protected static $errorMessages = array( + Doctrine::ERR => 'unknown error', + Doctrine::ERR_ALREADY_EXISTS => 'already exists', + Doctrine::ERR_CANNOT_CREATE => 'can not create', + Doctrine::ERR_CANNOT_ALTER => 'can not alter', + Doctrine::ERR_CANNOT_REPLACE => 'can not replace', + Doctrine::ERR_CANNOT_DELETE => 'can not delete', + Doctrine::ERR_CANNOT_DROP => 'can not drop', + Doctrine::ERR_CONSTRAINT => 'constraint violation', + Doctrine::ERR_CONSTRAINT_NOT_NULL=> 'null value violates not-null constraint', + Doctrine::ERR_DIVZERO => 'division by zero', + Doctrine::ERR_INVALID => 'invalid', + Doctrine::ERR_INVALID_DATE => 'invalid date or time', + Doctrine::ERR_INVALID_NUMBER => 'invalid number', + Doctrine::ERR_MISMATCH => 'mismatch', + Doctrine::ERR_NODBSELECTED => 'no database selected', + Doctrine::ERR_NOSUCHFIELD => 'no such field', + Doctrine::ERR_NOSUCHTABLE => 'no such table', + Doctrine::ERR_NOT_CAPABLE => 'Doctrine backend not capable', + Doctrine::ERR_NOT_FOUND => 'not found', + Doctrine::ERR_NOT_LOCKED => 'not locked', + Doctrine::ERR_SYNTAX => 'syntax error', + Doctrine::ERR_UNSUPPORTED => 'not supported', + Doctrine::ERR_VALUE_COUNT_ON_ROW => 'value count on row', + Doctrine::ERR_INVALID_DSN => 'invalid DSN', + Doctrine::ERR_CONNECT_FAILED => 'connect failed', + Doctrine::ERR_NEED_MORE_DATA => 'insufficient data supplied', + Doctrine::ERR_EXTENSION_NOT_FOUND=> 'extension not found', + Doctrine::ERR_NOSUCHDB => 'no such database', + Doctrine::ERR_ACCESS_VIOLATION => 'insufficient permissions', + Doctrine::ERR_LOADMODULE => 'error while including on demand module', + Doctrine::ERR_TRUNCATED => 'truncated', + Doctrine::ERR_DEADLOCK => 'deadlock detected', + ); + + /** + * Return a textual error message for a Doctrine error code + * + * @param int|array integer error code, + null to get the current error code-message map, + or an array with a new error code-message map + * + * @return string error message, or false if the error code was + * not recognized + */ + public function errorMessage($value = null) { + return isset(self::$errorMessages[$value]) ? + self::$errorMessages[$value] : self::$errorMessages[Doctrine::ERR]; + } +} diff --git a/lib/Doctrine/Connection/Firebird/Exception.php b/lib/Doctrine/Connection/Firebird/Exception.php index 7120e12e9..f00dfde80 100644 --- a/lib/Doctrine/Connection/Firebird/Exception.php +++ b/lib/Doctrine/Connection/Firebird/Exception.php @@ -32,4 +32,101 @@ Doctrine::autoload('Doctrine_Connection_Exception'); * @author Lorenzo Alberton (PEAR MDB2 Interbase driver) * @author Lukas Smith (PEAR MDB2 library) */ -class Doctrine_Connection_Firebird_Exception extends Doctrine_Connection_Exception { } +class Doctrine_Connection_Firebird_Exception extends Doctrine_Connection_Exception { + /** + * @var array $errorCodeMap an array that is used for determining portable + * error code from a native database error code + */ + protected static $errorCodeMap = array( + -104 => Doctrine::ERR_SYNTAX, + -150 => Doctrine::ERR_ACCESS_VIOLATION, + -151 => Doctrine::ERR_ACCESS_VIOLATION, + -155 => Doctrine::ERR_NOSUCHTABLE, + -157 => Doctrine::ERR_NOSUCHFIELD, + -158 => Doctrine::ERR_VALUE_COUNT_ON_ROW, + -170 => Doctrine::ERR_MISMATCH, + -171 => Doctrine::ERR_MISMATCH, + -172 => Doctrine::ERR_INVALID, + // -204 => // Covers too many errors, need to use regex on msg + -205 => Doctrine::ERR_NOSUCHFIELD, + -206 => Doctrine::ERR_NOSUCHFIELD, + -208 => Doctrine::ERR_INVALID, + -219 => Doctrine::ERR_NOSUCHTABLE, + -297 => Doctrine::ERR_CONSTRAINT, + -303 => Doctrine::ERR_INVALID, + -413 => Doctrine::ERR_INVALID_NUMBER, + -530 => Doctrine::ERR_CONSTRAINT, + -551 => Doctrine::ERR_ACCESS_VIOLATION, + -552 => Doctrine::ERR_ACCESS_VIOLATION, + // -607 => // Covers too many errors, need to use regex on msg + -625 => Doctrine::ERR_CONSTRAINT_NOT_NULL, + -803 => Doctrine::ERR_CONSTRAINT, + -804 => Doctrine::ERR_VALUE_COUNT_ON_ROW, + -904 => Doctrine::ERR_CONNECT_FAILED, + -922 => Doctrine::ERR_NOSUCHDB, + -923 => Doctrine::ERR_CONNECT_FAILED, + -924 => Doctrine::ERR_CONNECT_FAILED + ); + /** + * @var array $errorRegexps an array that is used for determining portable + * error code from a native database error message + */ + protected static $errorRegexps = array( + '/generator .* is not defined/' + => Doctrine::ERR_SYNTAX, // for compat. w ibase_errcode() + '/table.*(not exist|not found|unknown)/i' + => Doctrine::ERR_NOSUCHTABLE, + '/table .* already exists/i' + => Doctrine::ERR_ALREADY_EXISTS, + '/unsuccessful metadata update .* failed attempt to store duplicate value/i' + => Doctrine::ERR_ALREADY_EXISTS, + '/unsuccessful metadata update .* not found/i' + => Doctrine::ERR_NOT_FOUND, + '/validation error for column .* value "\*\*\* null/i' + => Doctrine::ERR_CONSTRAINT_NOT_NULL, + '/violation of [\w ]+ constraint/i' + => Doctrine::ERR_CONSTRAINT, + '/conversion error from string/i' + => Doctrine::ERR_INVALID_NUMBER, + '/no permission for/i' + => Doctrine::ERR_ACCESS_VIOLATION, + '/arithmetic exception, numeric overflow, or string truncation/i' + => Doctrine::ERR_INVALID, + '/table unknown/i' + => Doctrine::ERR_NOSUCHTABLE, + ); + /** + * This method checks if native error code/message can be + * converted into a portable code and then adds this + * portable error code to errorInfo array and returns the modified array + * + * the portable error code is added at the end of array + * + * @param array $errorInfo error info array + * @since 1.0 + * @return array + */ + public function processErrorInfo(array $errorInfo) { + /** + // todo: are the following lines needed? + // memo for the interbase php module hackers: we need something similar + // to mysql_errno() to retrieve error codes instead of this ugly hack + if (preg_match('/^([^0-9\-]+)([0-9\-]+)\s+(.*)$/', $native_msg, $m)) { + $native_code = (int)$m[2]; + } else { + $native_code = null; + } + */ + + foreach(self::$errorRegexps as $regexp => $code) { + if (preg_match($regexp, $errorInfo[2])) { + $errorInfo[3] = $code; + break; + } + } + if(isset(self::$errorCodeMap[$errorInfo[1]])) + $errorInfo[3] = self::$errorCodeMap[$errorInfo[1]]; + + return $errorInfo; + } +} diff --git a/lib/Doctrine/Connection/Mssql/Exception.php b/lib/Doctrine/Connection/Mssql/Exception.php index e1737fb89..000ef8361 100644 --- a/lib/Doctrine/Connection/Mssql/Exception.php +++ b/lib/Doctrine/Connection/Mssql/Exception.php @@ -31,4 +31,42 @@ Doctrine::autoload('Doctrine_Connection_Exception'); * @category Object Relational Mapping * @link www.phpdoctrine.com */ -class Doctrine_Connection_Mssql_Exception extends Doctrine_Connection_Exception { } +class Doctrine_Connection_Mssql_Exception extends Doctrine_Connection_Exception { + /** + * @var array $errorCodeMap an array that is used for determining portable + * error code from a native database error code + */ + protected static $errorCodeMap = array( + 110 => Doctrine::ERR_VALUE_COUNT_ON_ROW, + 155 => Doctrine::ERR_NOSUCHFIELD, + 170 => Doctrine::ERR_SYNTAX, + 207 => Doctrine::ERR_NOSUCHFIELD, + 208 => Doctrine::ERR_NOSUCHTABLE, + 245 => Doctrine::ERR_INVALID_NUMBER, + 515 => Doctrine::ERR_CONSTRAINT_NOT_NULL, + 547 => Doctrine::ERR_CONSTRAINT, + 1913 => Doctrine::ERR_ALREADY_EXISTS, + 2627 => Doctrine::ERR_CONSTRAINT, + 2714 => Doctrine::ERR_ALREADY_EXISTS, + 3701 => Doctrine::ERR_NOSUCHTABLE, + 8134 => Doctrine::ERR_DIVZERO, + ); + /** + * This method checks if native error code/message can be + * converted into a portable code and then adds this + * portable error code to errorInfo array and returns the modified array + * + * the portable error code is added at the end of array + * + * @param array $errorInfo error info array + * @since 1.0 + * @return array + */ + public function processErrorInfo(array $errorInfo) { + $code = $errorInfo[1]; + if(isset(self::$errorCodeMap[$code])) + $errorInfo[3] = self::$errorCodeMap[$code]; + + return $errorInfo; + } +} diff --git a/lib/Doctrine/Connection/Mysql/Exception.php b/lib/Doctrine/Connection/Mysql/Exception.php index 9e5854920..30ed0e00d 100644 --- a/lib/Doctrine/Connection/Mysql/Exception.php +++ b/lib/Doctrine/Connection/Mysql/Exception.php @@ -31,4 +31,52 @@ Doctrine::autoload('Doctrine_Connection_Exception'); * @category Object Relational Mapping * @link www.phpdoctrine.com */ -class Doctrine_Connection_Mysql_Exception extends Doctrine_Connection_Exception { } +class Doctrine_Connection_Mysql_Exception extends Doctrine_Connection_Exception { + /** + * @var array $errorCodeMap an array that is used for determining portable + * error code from a native database error code + */ + protected static $errorCodeMap = array( + 1004 => Doctrine::ERR_CANNOT_CREATE, + 1005 => Doctrine::ERR_CANNOT_CREATE, + 1006 => Doctrine::ERR_CANNOT_CREATE, + 1007 => Doctrine::ERR_ALREADY_EXISTS, + 1008 => Doctrine::ERR_CANNOT_DROP, + 1022 => Doctrine::ERR_ALREADY_EXISTS, + 1044 => Doctrine::ERR_ACCESS_VIOLATION, + 1046 => Doctrine::ERR_NODBSELECTED, + 1048 => Doctrine::ERR_CONSTRAINT, + 1049 => Doctrine::ERR_NOSUCHDB, + 1050 => Doctrine::ERR_ALREADY_EXISTS, + 1051 => Doctrine::ERR_NOSUCHTABLE, + 1054 => Doctrine::ERR_NOSUCHFIELD, + 1061 => Doctrine::ERR_ALREADY_EXISTS, + 1062 => Doctrine::ERR_ALREADY_EXISTS, + 1064 => Doctrine::ERR_SYNTAX, + 1091 => Doctrine::ERR_NOT_FOUND, + 1100 => Doctrine::ERR_NOT_LOCKED, + 1136 => Doctrine::ERR_VALUE_COUNT_ON_ROW, + 1142 => Doctrine::ERR_ACCESS_VIOLATION, + 1146 => Doctrine::ERR_NOSUCHTABLE, + 1216 => Doctrine::ERR_CONSTRAINT, + 1217 => Doctrine::ERR_CONSTRAINT, + ); + /** + * This method checks if native error code/message can be + * converted into a portable code and then adds this + * portable error code to errorInfo array and returns the modified array + * + * the portable error code is added at the end of array + * + * @param array $errorInfo error info array + * @since 1.0 + * @return array + */ + public function processErrorInfo(array $errorInfo) { + $code = $errorInfo[1]; + if(isset(self::$errorCodeMap[$code])) + $errorInfo[3] = self::$errorCodeMap[$code]; + + return $errorInfo; + } +} diff --git a/lib/Doctrine/Connection/Oracle/Exception.php b/lib/Doctrine/Connection/Oracle/Exception.php index 9d80aba51..56762a2a9 100644 --- a/lib/Doctrine/Connection/Oracle/Exception.php +++ b/lib/Doctrine/Connection/Oracle/Exception.php @@ -31,4 +31,47 @@ Doctrine::autoload('Doctrine_Connection_Exception'); * @category Object Relational Mapping * @link www.phpdoctrine.com */ -class Doctrine_Connection_Oracle_Exception extends Doctrine_Connection_Exception { } +class Doctrine_Connection_Oracle_Exception extends Doctrine_Connection_Exception { + /** + * @var array $errorCodeMap an array that is used for determining portable + * error code from a native database error code + */ + protected static $errorCodeMap = array( + 1 => Doctrine::ERR_CONSTRAINT, + 900 => Doctrine::ERR_SYNTAX, + 904 => Doctrine::ERR_NOSUCHFIELD, + 913 => Doctrine::ERR_VALUE_COUNT_ON_ROW, + 921 => Doctrine::ERR_SYNTAX, + 923 => Doctrine::ERR_SYNTAX, + 942 => Doctrine::ERR_NOSUCHTABLE, + 955 => Doctrine::ERR_ALREADY_EXISTS, + 1400 => Doctrine::ERR_CONSTRAINT_NOT_NULL, + 1401 => Doctrine::ERR_INVALID, + 1407 => Doctrine::ERR_CONSTRAINT_NOT_NULL, + 1418 => Doctrine::ERR_NOT_FOUND, + 1476 => Doctrine::ERR_DIVZERO, + 1722 => Doctrine::ERR_INVALID_NUMBER, + 2289 => Doctrine::ERR_NOSUCHTABLE, + 2291 => Doctrine::ERR_CONSTRAINT, + 2292 => Doctrine::ERR_CONSTRAINT, + 2449 => Doctrine::ERR_CONSTRAINT, + ); + /** + * This method checks if native error code/message can be + * converted into a portable code and then adds this + * portable error code to errorInfo array and returns the modified array + * + * the portable error code is added at the end of array + * + * @param array $errorInfo error info array + * @since 1.0 + * @return array + */ + public function processErrorInfo(array $errorInfo) { + $code = $errorInfo[1]; + if(isset(self::$errorCodeMap[$code])) + $errorInfo[3] = self::$errorCodeMap[$code]; + + return $errorInfo; + } +} diff --git a/lib/Doctrine/Connection/Pgsql/Exception.php b/lib/Doctrine/Connection/Pgsql/Exception.php index 34f32138f..696b169a5 100644 --- a/lib/Doctrine/Connection/Pgsql/Exception.php +++ b/lib/Doctrine/Connection/Pgsql/Exception.php @@ -32,4 +32,71 @@ Doctrine::autoload('Doctrine_Connection_Exception'); * @since 1.0 * @version $Revision$ */ -class Doctrine_Connection_Pgsql_Exception extends Doctrine_Connection_Exception { } +class Doctrine_Connection_Pgsql_Exception extends Doctrine_Connection_Exception { + /** + * @var array $errorRegexps an array that is used for determining portable + * error code from a native database error message + */ + protected static $errorRegexps = array( + '/column .* (of relation .*)?does not exist/i' + => Doctrine::ERR_NOSUCHFIELD, + '/(relation|sequence|table).*does not exist|class .* not found/i' + => Doctrine::ERR_NOSUCHTABLE, + '/index .* does not exist/' + => Doctrine::ERR_NOT_FOUND, + '/relation .* already exists/i' + => Doctrine::ERR_ALREADY_EXISTS, + '/(divide|division) by zero$/i' + => Doctrine::ERR_DIVZERO, + '/pg_atoi: error in .*: can\'t parse /i' + => Doctrine::ERR_INVALID_NUMBER, + '/invalid input syntax for( type)? (integer|numeric)/i' + => Doctrine::ERR_INVALID_NUMBER, + '/value .* is out of range for type \w*int/i' + => Doctrine::ERR_INVALID_NUMBER, + '/integer out of range/i' + => Doctrine::ERR_INVALID_NUMBER, + '/value too long for type character/i' + => Doctrine::ERR_INVALID, + '/attribute .* not found|relation .* does not have attribute/i' + => Doctrine::ERR_NOSUCHFIELD, + '/column .* specified in USING clause does not exist in (left|right) table/i' + => Doctrine::ERR_NOSUCHFIELD, + '/parser: parse error at or near/i' + => Doctrine::ERR_SYNTAX, + '/syntax error at/' + => Doctrine::ERR_SYNTAX, + '/column reference .* is ambiguous/i' + => Doctrine::ERR_SYNTAX, + '/permission denied/' + => Doctrine::ERR_ACCESS_VIOLATION, + '/violates not-null constraint/' + => Doctrine::ERR_CONSTRAINT_NOT_NULL, + '/violates [\w ]+ constraint/' + => Doctrine::ERR_CONSTRAINT, + '/referential integrity violation/' + => Doctrine::ERR_CONSTRAINT, + '/more expressions than target columns/i' + => Doctrine::ERR_VALUE_COUNT_ON_ROW, + ); + /** + * This method checks if native error code/message can be + * converted into a portable code and then adds this + * portable error code to errorInfo array and returns the modified array + * + * the portable error code is added at the end of array + * + * @param array $errorInfo error info array + * @since 1.0 + * @return array + */ + public function processErrorInfo(array $errorInfo) { + foreach (self::$errorRegexps as $regexp => $code) { + if (preg_match($regexp, $errorInfo[2])) { + $errorInfo[3] = $code; + break; + } + } + return $errorInfo; + } +} diff --git a/lib/Doctrine/Connection/Sqlite/Exception.php b/lib/Doctrine/Connection/Sqlite/Exception.php index 8c24accce..cf40328ee 100644 --- a/lib/Doctrine/Connection/Sqlite/Exception.php +++ b/lib/Doctrine/Connection/Sqlite/Exception.php @@ -31,4 +31,45 @@ Doctrine::autoload('Doctrine_Connection_Exception'); * @category Object Relational Mapping * @link www.phpdoctrine.com */ -class Doctrine_Connection_Sqlite_Exception extends Doctrine_Connection_Exception { } +class Doctrine_Connection_Sqlite_Exception extends Doctrine_Connection_Exception { + /** + * @var array $errorRegexps an array that is used for determining portable + * error code from a native database error message + */ + protected static $errorRegexps = array( + '/^no such table:/' => Doctrine::ERR_NOSUCHTABLE, + '/^no such index:/' => Doctrine::ERR_NOT_FOUND, + '/^(table|index) .* already exists$/' => Doctrine::ERR_ALREADY_EXISTS, + '/PRIMARY KEY must be unique/i' => Doctrine::ERR_CONSTRAINT, + '/is not unique/' => Doctrine::ERR_CONSTRAINT, + '/columns .* are not unique/i' => Doctrine::ERR_CONSTRAINT, + '/uniqueness constraint failed/' => Doctrine::ERR_CONSTRAINT, + '/may not be NULL/' => Doctrine::ERR_CONSTRAINT_NOT_NULL, + '/^no such column:/' => Doctrine::ERR_NOSUCHFIELD, + '/column not present in both tables/i' => Doctrine::ERR_NOSUCHFIELD, + '/^near ".*": syntax error$/' => Doctrine::ERR_SYNTAX, + '/[0-9]+ values for [0-9]+ columns/i' => Doctrine::ERR_VALUE_COUNT_ON_ROW, + ); + + /** + * This method checks if native error code/message can be + * converted into a portable code and then adds this + * portable error code to errorInfo array and returns the modified array + * + * the portable error code is added at the end of array + * + * @param array $errorInfo error info array + * @since 1.0 + * @return array + */ + public function processErrorInfo(array $errorInfo) { + foreach (self::$errorRegexps as $regexp => $code) { + if (preg_match($regexp, $errorInfo[2])) { + $errorInfo[3] = $code; + break; + } + } + + return $errorInfo; + } +}