rlkollman/meekrodb
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

handle non-sql errors (such as failure to connect to MySQL server) in a user-defined way

Browse Source 
adds DB::$nonsql_error_handler and DB::$throw_exception_on_nonsql_error
This commit is contained in:
Sergey Tsalkov
2011-08-25 23:33:15 -07:00
parent 4122fe52c1
commit 7621b50a02
2 changed files with 49 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
db.class.php
View File

@@ -34,10 +34,14 @@ class DB
public static $port = null; public static $port = null;
public static $encoding = 'latin1'; public static $encoding = 'latin1';
public static $queryMode = 'queryAllRows'; public static $queryMode = 'queryAllRows';
public static $param_char = '%';
public static $success_handler = false; public static $success_handler = false;
public static $error_handler = true; public static $error_handler = true;
public static $throw_exception_on_error = false; public static $throw_exception_on_error = false;
public static $param_char = '%'; public static $nonsql_error_handler = null;
public static $throw_exception_on_nonsql_error = false;
public static function get() { public static function get() {
$mysql = DB::$internal_mysql; $mysql = DB::$internal_mysql;
@@ -46,6 +50,11 @@ class DB
if (! DB::$port) DB::$port = ini_get('mysqli.default_port'); if (! DB::$port) DB::$port = ini_get('mysqli.default_port');
DB::$current_db = DB::$dbName; DB::$current_db = DB::$dbName;
$mysql = new mysqli(DB::$host, DB::$user, DB::$password, DB::$dbName, DB::$port); $mysql = new mysqli(DB::$host, DB::$user, DB::$password, DB::$dbName, DB::$port);
if ($mysql->connect_error) {
DB::nonSQLError('Unable to connect to MySQL server! Error: ' . $mysql->connect_error);
}
$mysql->set_charset(DB::$encoding); $mysql->set_charset(DB::$encoding);
DB::$internal_mysql = $mysql; DB::$internal_mysql = $mysql;
} }
@@ -53,6 +62,20 @@ class DB
return $mysql; return $mysql;
} }
protected static function nonSQLError($message) {
if (DB::$throw_exception_on_nonsql_error) {
$e = new MeekroDBException($message);
throw $e;
}
$error_handler = is_callable(DB::$nonsql_error_handler) ? DB::$nonsql_error_handler : 'meekrodb_error_handler';
call_user_func($error_handler, array(
'type' => 'nonsql',
'error' => $message
));
}
public static function debugMode($handler = true) { public static function debugMode($handler = true) {
DB::$success_handler = $handler; DB::$success_handler = $handler;
} }
@@ -66,7 +89,7 @@ class DB
public static function setDB($dbName) { public static function setDB($dbName) {
$db = DB::get(); $db = DB::get();
DB::$old_db = DB::$current_db; DB::$old_db = DB::$current_db;
if (! $db->select_db($dbName)) die("unable to set db to $dbName"); if (! $db->select_db($dbName)) DB::nonSQLError("Unable to set database to $dbName");
DB::$current_db = $dbName; DB::$current_db = $dbName;
} }
@@ -176,7 +199,7 @@ class DB
$insert_values = array(); $insert_values = array();
foreach ($keys as $key) { foreach ($keys as $key) {
if ($many && !isset($data[$key])) die("insert/replace many: each assoc array must have the same keys!"); if ($many && !isset($data[$key])) DB::nonSQLError('insert/replace many: each assoc array must have the same keys!');
$datum = $data[$key]; $datum = $data[$key];
$datum = DB::sanitize($datum); $datum = DB::sanitize($datum);
$insert_values[] = $datum; $insert_values[] = $datum;
@@ -236,11 +259,11 @@ class DB
foreach ($args as $arg) { foreach ($args as $arg) {
$type = array_shift($types); $type = array_shift($types);
$pos = strpos($sql, '?'); $pos = strpos($sql, '?');
if ($pos === false) die("Badly formatted SQL query: $sql"); if ($pos === false) DB::nonSQLError("Badly formatted SQL query: $sql");
if ($type == 's') $replacement = "'" . DB::escape($arg) . "'"; if ($type == 's') $replacement = "'" . DB::escape($arg) . "'";
else if ($type == 'i') $replacement = intval($arg); else if ($type == 'i') $replacement = intval($arg);
else die("Badly formatted SQL query: $sql"); else DB::nonSQLError("Badly formatted SQL query: $sql");
$sql = substr_replace($sql, $replacement, $pos, 1); $sql = substr_replace($sql, $replacement, $pos, 1);
} }
@@ -291,7 +314,7 @@ class DB
$result = "'%" . DB::escape(str_replace(array('%', '_'), array('\%', '\_'), $arg)) . "%'"; $result = "'%" . DB::escape(str_replace(array('%', '_'), array('\%', '\_'), $arg)) . "%'";
} else { } else {
$array_type = true; $array_type = true;
if (! is_array($arg)) die("Badly formatted SQL query: $sql -- expecting array, but didn't get one!"); if (! is_array($arg)) DB::nonSQLError("Badly formatted SQL query: $sql -- expecting array, but didn't get one!");
} }
if ($type == 'ls') $result = DB::wrapStr($arg, "'", true); if ($type == 'ls') $result = DB::wrapStr($arg, "'", true);
@@ -299,7 +322,7 @@ class DB
else if ($type == 'ld') $result = array_map('floatval', $arg); else if ($type == 'ld') $result = array_map('floatval', $arg);
else if ($type == 'lb') $result = array_map('DB::formatTableName', $arg); else if ($type == 'lb') $result = array_map('DB::formatTableName', $arg);
else if ($type == 'll') $result = $arg; else if ($type == 'll') $result = $arg;
else if (! $result) die("Badly formatted SQL query: $sql"); else if (! $result) DB::nonSQLError("Badly formatted SQL query: $sql");
if (is_array($result)) { if (is_array($result)) {
if (! $array_type) $result = $result[0]; if (! $array_type) $result = $result[0];
@@ -340,7 +363,9 @@ class DB
public static function queryHelper() { public static function queryHelper() {
$args = func_get_args(); $args = func_get_args();
$type = array_shift($args); $type = array_shift($args);
if ($type != 'buffered' && $type != 'unbuffered' && $type != 'null') die("Error -- first argument to queryHelper must be buffered or unbuffered!"); if ($type != 'buffered' && $type != 'unbuffered' && $type != 'null') {
DB::nonSQLError('Error -- first argument to queryHelper must be buffered or unbuffered!');
}
$is_buffered = ($type == 'buffered'); $is_buffered = ($type == 'buffered');
$is_null = ($type == 'null'); $is_null = ($type == 'null');
@@ -357,6 +382,7 @@ class DB
$error_handler = is_callable(DB::$error_handler) ? DB::$error_handler : 'meekrodb_error_handler'; $error_handler = is_callable(DB::$error_handler) ? DB::$error_handler : 'meekrodb_error_handler';
call_user_func($error_handler, array( call_user_func($error_handler, array(
'type' => 'sql',
'query' => $sql, 'query' => $sql,
'error' => $error 'error' => $error
)); ));
@@ -621,8 +647,8 @@ class MeekroDBException extends Exception {
} }
function meekrodb_error_handler($params) { function meekrodb_error_handler($params) {
$out[] = "QUERY: " . $params['query']; if (isset($params['query'])) $out[] = "QUERY: " . $params['query'];
$out[] = "ERROR: " . $params['error']; if (isset($params['error'])) $out[] = "ERROR: " . $params['error'];
$out[] = ""; $out[] = "";
if (php_sapi_name() == 'cli' && empty($_SERVER['REMOTE_ADDR'])) { if (php_sapi_name() == 'cli' && empty($_SERVER['REMOTE_ADDR'])) {

23
simpletest/BasicTest.php
View File

@@ -15,12 +15,14 @@ class BasicTest extends SimpleTest {
function __construct() { function __construct() {
error_reporting(E_ALL); error_reporting(E_ALL);
require_once '../db.class.php'; require_once '../db.class.php';
DB::$user = 'libdb_user'; DB::$user = 'meekrodb_test_us';
DB::$password = 'sdf235sklj'; DB::$password = 'akdfo59fg';
DB::$dbName = 'libdb_test'; DB::$dbName = 'meekrodb_test';
DB::query("DROP DATABASE libdb_test"); DB::$host = 'mysql.meekro.com';
DB::query("CREATE DATABASE libdb_test");
DB::useDB('libdb_test'); foreach (DB::tableList() as $table) {
DB::query("DROP TABLE $table");
}
} }
@@ -74,8 +76,8 @@ class BasicTest extends SimpleTest {
'age' => 15, 'age' => 15,
'height' => 10.371 'height' => 10.371
)); ));
$dbname = DB::$dbName;
DB::insert('`libdb_test`.`accounts`', array( DB::insert("`$dbname`.`accounts`", array(
'username' => 'Charlie\'s Friend', 'username' => 'Charlie\'s Friend',
'password' => 'goodbye', 'password' => 'goodbye',
'age' => 30, 'age' => 30,
@@ -134,7 +136,7 @@ class BasicTest extends SimpleTest {
$this->assert($tablelist[0] === 'accounts'); $this->assert($tablelist[0] === 'accounts');
$tablelist = null; $tablelist = null;
$tablelist = DB::tableList('libdb_test'); $tablelist = DB::tableList(DB::$dbName);
$this->assert(count($tablelist) === 1); $this->assert(count($tablelist) === 1);
$this->assert($tablelist[0] === 'accounts'); $this->assert($tablelist[0] === 'accounts');
} }
@@ -246,6 +248,7 @@ class BasicTest extends SimpleTest {
} }
function test_6_exception_catch() { function test_6_exception_catch() {
$dbname = DB::$dbName;
DB::$error_handler = ''; DB::$error_handler = '';
DB::$throw_exception_on_error = true; DB::$throw_exception_on_error = true;
try { try {
@@ -258,7 +261,7 @@ class BasicTest extends SimpleTest {
$this->assert($exception_was_caught === 1); $this->assert($exception_was_caught === 1);
try { try {
DB::insert('`libdb_test`.`accounts`', array( DB::insert("`$dbname`.`accounts`", array(
'id' => 2, 'id' => 2,
'username' => 'Another Dude\'s \'Mom"', 'username' => 'Another Dude\'s \'Mom"',
'password' => 'asdfsdse', 'password' => 'asdfsdse',