aboutsummaryrefslogtreecommitdiffstats
path: root/lib/db.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/db.php')
-rw-r--r--lib/db.php104
1 files changed, 71 insertions, 33 deletions
diff --git a/lib/db.php b/lib/db.php
index 8598f659cad..db4aca19dbe 100644
--- a/lib/db.php
+++ b/lib/db.php
@@ -28,18 +28,30 @@ class OC_DB {
const BACKEND_PDO=0;
const BACKEND_MDB2=1;
+ /**
+ * @var MDB2_Driver_Common
+ */
static private $connection; //the prefered connection to use, either PDO or MDB2
static private $backend=null;
- static private $MDB2=false;
- static private $PDO=false;
- static private $schema=false;
+ /**
+ * @var MDB2_Driver_Common
+ */
+ static private $MDB2=null;
+ /**
+ * @var PDO
+ */
+ static private $PDO=null;
+ /**
+ * @var MDB2_Schema
+ */
+ static private $schema=null;
static private $inTransaction=false;
static private $prefix=null;
static private $type=null;
/**
* check which backend we should use
- * @return BACKEND_MDB2 or BACKEND_PDO
+ * @return int BACKEND_MDB2 or BACKEND_PDO
*/
private static function getDBBackend() {
//check if we can use PDO, else use MDB2 (installation always needs to be done my mdb2)
@@ -59,37 +71,41 @@ class OC_DB {
/**
* @brief connects to the database
- * @returns true if connection can be established or nothing (die())
+ * @param int $backend
+ * @return bool true if connection can be established or false on error
*
* Connects to the database as specified in config.php
*/
public static function connect($backend=null) {
if(self::$connection) {
- return;
+ return true;
}
if(is_null($backend)) {
$backend=self::getDBBackend();
}
if($backend==self::BACKEND_PDO) {
- self::connectPDO();
+ $success = self::connectPDO();
self::$connection=self::$PDO;
self::$backend=self::BACKEND_PDO;
}else{
- self::connectMDB2();
+ $success = self::connectMDB2();
self::$connection=self::$MDB2;
self::$backend=self::BACKEND_MDB2;
}
+ return $success;
}
/**
* connect to the database using pdo
+ *
+ * @return bool
*/
public static function connectPDO() {
if(self::$connection) {
if(self::$backend==self::BACKEND_MDB2) {
self::disconnect();
}else{
- return;
+ return true;
}
}
// The global data we need
@@ -146,6 +162,8 @@ class OC_DB {
$dsn = 'oci:dbname=//' . $host . '/' . $name;
}
break;
+ default:
+ return false;
}
try{
self::$PDO=new PDO($dsn, $user, $pass, $opts);
@@ -168,7 +186,7 @@ class OC_DB {
if(self::$backend==self::BACKEND_PDO) {
self::disconnect();
}else{
- return;
+ return true;
}
}
// The global data we need
@@ -226,14 +244,18 @@ class OC_DB {
'phptype' => 'oci8',
'username' => $user,
'password' => $pass,
+ 'charset' => 'AL32UTF8',
);
if ($host != '') {
$dsn['hostspec'] = $host;
$dsn['database'] = $name;
} else { // use dbname for hostspec
$dsn['hostspec'] = $name;
+ $dsn['database'] = $user;
}
break;
+ default:
+ return false;
}
// Try to establish connection
@@ -244,7 +266,7 @@ class OC_DB {
echo( '<b>can not connect to database, using '.$type.'. ('.self::$MDB2->getUserInfo().')</center>');
OC_Log::write('core', self::$MDB2->getUserInfo(), OC_Log::FATAL);
OC_Log::write('core', self::$MDB2->getMessage(), OC_Log::FATAL);
- die( $error );
+ die();
}
// We always, really always want associative arrays
@@ -257,8 +279,10 @@ class OC_DB {
/**
* @brief Prepare a SQL query
- * @param $query Query string
- * @returns prepared SQL query
+ * @param string $query Query string
+ * @param int $limit
+ * @param int $offset
+ * @return MDB2_Statement_Common prepared SQL query
*
* SQL query via MDB2 prepare(), needs to be execute()'d!
*/
@@ -273,8 +297,10 @@ class OC_DB {
//FIXME: check limit notation for other dbs
//the following sql thus might needs to take into account db ways of representing it
//(oracle has no LIMIT / OFFSET)
- $limitsql = ' LIMIT ' . $limit;
+ $limit = (int)$limit;
+ $limitsql = ' LIMIT ' . $limit;
if (!is_null($offset)) {
+ $offset = (int)$offset;
$limitsql .= ' OFFSET ' . $offset;
}
//insert limitsql
@@ -297,7 +323,7 @@ class OC_DB {
// Die if we have an error (error means: bad query, not 0 results!)
if( PEAR::isError($result)) {
$entry = 'DB Error: "'.$result->getMessage().'"<br />';
- $entry .= 'Offending command was: '.$query.'<br />';
+ $entry .= 'Offending command was: '.htmlentities($query).'<br />';
OC_Log::write('core', $entry,OC_Log::FATAL);
error_log('DB error: '.$entry);
die( $entry );
@@ -307,7 +333,7 @@ class OC_DB {
$result=self::$connection->prepare($query);
}catch(PDOException $e) {
$entry = 'DB Error: "'.$e->getMessage().'"<br />';
- $entry .= 'Offending command was: '.$query.'<br />';
+ $entry .= 'Offending command was: '.htmlentities($query).'<br />';
OC_Log::write('core', $entry,OC_Log::FATAL);
error_log('DB error: '.$entry);
die( $entry );
@@ -319,8 +345,8 @@ class OC_DB {
/**
* @brief gets last value of autoincrement
- * @param $table string The optional table name (will replace *PREFIX*) and add sequence suffix
- * @returns id
+ * @param string $table The optional table name (will replace *PREFIX*) and add sequence suffix
+ * @return int id
*
* MDB2 lastInsertID()
*
@@ -332,14 +358,14 @@ class OC_DB {
if($table !== null) {
$prefix = OC_Config::getValue( "dbtableprefix", "oc_" );
$suffix = OC_Config::getValue( "dbsequencesuffix", "_id_seq" );
- $table = str_replace( '*PREFIX*', $prefix, $table );
+ $table = str_replace( '*PREFIX*', $prefix, $table ).$suffix;
}
- return self::$connection->lastInsertId($table.$suffix);
+ return self::$connection->lastInsertId($table);
}
/**
* @brief Disconnect
- * @returns true/false
+ * @return bool
*
* This is good bye, good bye, yeah!
*/
@@ -359,8 +385,9 @@ class OC_DB {
/**
* @brief saves database scheme to xml file
- * @param $file name of file
- * @returns true/false
+ * @param string $file name of file
+ * @param int $mode
+ * @return bool
*
* TODO: write more documentation
*/
@@ -381,8 +408,8 @@ class OC_DB {
/**
* @brief Creates tables from XML file
- * @param $file file to read structure from
- * @returns true/false
+ * @param string $file file to read structure from
+ * @return bool
*
* TODO: write more documentation
*/
@@ -443,11 +470,11 @@ class OC_DB {
/**
* @brief update the database scheme
- * @param $file file to read structure from
+ * @param string $file file to read structure from
+ * @return bool
*/
public static function updateDbFromStructure($file) {
$CONFIG_DBTABLEPREFIX = OC_Config::getValue( "dbtableprefix", "oc_" );
- $CONFIG_DBTYPE = OC_Config::getValue( "dbtype", "sqlite" );
self::connectScheme();
@@ -493,7 +520,7 @@ class OC_DB {
/**
* @brief connects to a MDB2 database scheme
- * @returns true/false
+ * @returns bool
*
* Connects to a MDB2 database scheme
*/
@@ -562,12 +589,12 @@ class OC_DB {
}
/**
- * @brief does minor chages to query
- * @param $query Query string
- * @returns corrected query string
+ * @brief does minor changes to query
+ * @param string $query Query string
+ * @return string corrected query string
*
* This function replaces *PREFIX* with the value of $CONFIG_DBTABLEPREFIX
- * and replaces the ` woth ' or " according to the database driver.
+ * and replaces the ` with ' or " according to the database driver.
*/
private static function processQuery( $query ) {
self::connect();
@@ -602,7 +629,7 @@ class OC_DB {
/**
* @brief drop a table
- * @param string $tableNamme the table to drop
+ * @param string $tableName the table to drop
*/
public static function dropTable($tableName) {
self::connectMDB2();
@@ -663,6 +690,7 @@ class OC_DB {
/**
* Start a transaction
+ * @return bool
*/
public static function beginTransaction() {
self::connect();
@@ -671,10 +699,12 @@ class OC_DB {
}
self::$connection->beginTransaction();
self::$inTransaction=true;
+ return true;
}
/**
* Commit the database changes done during a transaction that is in progress
+ * @return bool
*/
public static function commit() {
self::connect();
@@ -683,6 +713,7 @@ class OC_DB {
}
self::$connection->commit();
self::$inTransaction=false;
+ return true;
}
/**
@@ -719,7 +750,11 @@ class OC_DB {
$msg .= 'SQLSTATE = '.$errorInfo[0] . ', ';
$msg .= 'Driver Code = '.$errorInfo[1] . ', ';
$msg .= 'Driver Message = '.$errorInfo[2];
+ }else{
+ $msg = '';
}
+ }else{
+ $msg = '';
}
return $msg;
}
@@ -729,6 +764,9 @@ class OC_DB {
* small wrapper around PDOStatement to make it behave ,more like an MDB2 Statement
*/
class PDOStatementWrapper{
+ /**
+ * @var PDOStatement
+ */
private $statement=null;
private $lastArguments=array();
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-28 07:27:52 +0000