433 lines
10 KiB
PHP
Executable File
433 lines
10 KiB
PHP
Executable File
<?php
|
|
|
|
class DBA {
|
|
|
|
/**
|
|
* @file dba_driver.php
|
|
* @brief some database related functions and abstract driver class.
|
|
*
|
|
* This file contains the abstract database driver class dba_driver and some
|
|
* functions for working with databases.
|
|
*/
|
|
|
|
static public $dba = null;
|
|
static public $dbtype = null;
|
|
static public $logging = false;
|
|
|
|
/**
|
|
* @brief Returns the database driver object.
|
|
*
|
|
* If available it will use PHP's mysqli otherwise mysql driver.
|
|
*
|
|
* @param string $server DB server name
|
|
* @param string $port DB port
|
|
* @param string $user DB username
|
|
* @param string $pass DB password
|
|
* @param string $db database name
|
|
* @param string $dbtype 0 for mysql, 1 for postgres
|
|
* @param bool $install Defaults to false
|
|
* @return null|dba_driver A database driver object (dba_mysql|dba_mysqli) or null if no driver found.
|
|
*/
|
|
|
|
static public function dba_factory($server, $port,$user,$pass,$db,$dbtype,$install = false) {
|
|
|
|
self::$dba = null;
|
|
|
|
self::$dbtype = intval($dbtype);
|
|
$set_port = $port;
|
|
|
|
if(self::$dbtype == DBTYPE_POSTGRES) {
|
|
require_once('include/dba/dba_postgres.php');
|
|
if(is_null($port)) $set_port = 5432;
|
|
self::$dba = new dba_postgres($server, $set_port, $user, $pass, $db, $install);
|
|
}
|
|
else {
|
|
|
|
// Highly experimental at the present time.
|
|
// require_once('include/dba/dba_pdo.php');
|
|
// self::$dba = new dba_pdo($server, $set_port,$user,$pass,$db,$install);
|
|
// }
|
|
|
|
if(class_exists('mysqli')) {
|
|
if (is_null($port)) $set_port = ini_get("mysqli.default_port");
|
|
require_once('include/dba/dba_mysqli.php');
|
|
self::$dba = new dba_mysqli($server, $set_port,$user,$pass,$db,$install);
|
|
}
|
|
}
|
|
|
|
// Until we have a proper PDO driver, store the DB connection parameters for
|
|
// plugins/addons which use PDO natively (such as cdav). This is wasteful as
|
|
// it opens a separate connection to the DB, but saves a lot of effort re-writing
|
|
// third-party interfaces that are working and well tested.
|
|
|
|
|
|
if(is_object(self::$dba) && self::$dba->connected) {
|
|
$dns = ((self::$dbtype == DBTYPE_POSTGRES) ? 'postgres' : 'mysql')
|
|
. ':host=' . $server . (is_null($port) ? '' : ';port=' . $port)
|
|
. ';dbname=' . $db;
|
|
self::$dba->pdo_set(array($dns,$user,$pass));
|
|
}
|
|
|
|
define('NULL_DATE', self::$dba->get_null_date());
|
|
define('ACTIVE_DBTYPE', self::$dbtype);
|
|
return self::$dba;
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* @brief abstract database driver class.
|
|
*
|
|
* This class gets extended by the real database driver classes, e.g. dba_mysql,
|
|
* dba_mysqli.
|
|
*/
|
|
abstract class dba_driver {
|
|
// legacy behavior
|
|
const INSTALL_SCRIPT='install/schema_mysql.sql';
|
|
const NULL_DATE = '0000-00-00 00:00:00';
|
|
const UTC_NOW = 'UTC_TIMESTAMP()';
|
|
|
|
protected $db;
|
|
protected $pdo = array();
|
|
|
|
public $debug = 0;
|
|
public $connected = false;
|
|
public $error = false;
|
|
|
|
/**
|
|
* @brief Connect to the database.
|
|
*
|
|
* This abstract function needs to be implemented in the real driver.
|
|
*
|
|
* @param string $server DB server name
|
|
* @param string $port DB port
|
|
* @param string $user DB username
|
|
* @param string $pass DB password
|
|
* @param string $db database name
|
|
* @return bool
|
|
*/
|
|
abstract function connect($server, $port, $user, $pass, $db);
|
|
|
|
/**
|
|
* @brief Perform a DB query with the SQL statement $sql.
|
|
*
|
|
* This abstract function needs to be implemented in the real driver.
|
|
*
|
|
* @param string $sql The SQL query to execute
|
|
*/
|
|
abstract function q($sql);
|
|
|
|
/**
|
|
* @brief Escape a string before being passed to a DB query.
|
|
*
|
|
* This abstract function needs to be implemented in the real driver.
|
|
*
|
|
* @param string $str The string to escape.
|
|
*/
|
|
abstract function escape($str);
|
|
|
|
/**
|
|
* @brief Close the database connection.
|
|
*
|
|
* This abstract function needs to be implemented in the real driver.
|
|
*/
|
|
abstract function close();
|
|
|
|
/**
|
|
* @brief Return text name for db driver
|
|
*
|
|
* This abstract function needs to be implemented in the real driver.
|
|
*/
|
|
abstract function getdriver();
|
|
|
|
function __construct($server, $port, $user,$pass,$db,$install = false) {
|
|
if(($install) && (! $this->install($server, $port, $user, $pass, $db))) {
|
|
return;
|
|
}
|
|
$this->connect($server, $port, $user, $pass, $db);
|
|
}
|
|
|
|
function get_null_date() {
|
|
return static::NULL_DATE;
|
|
}
|
|
|
|
function get_install_script() {
|
|
return static::INSTALL_SCRIPT;
|
|
}
|
|
|
|
function utcnow() {
|
|
return static::UTC_NOW;
|
|
}
|
|
|
|
function install($server,$user,$pass,$db) {
|
|
if (!(strlen($server) && strlen($user))){
|
|
$this->connected = false;
|
|
$this->db = null;
|
|
return false;
|
|
}
|
|
|
|
if(strlen($server) && ($server !== 'localhost') && ($server !== '127.0.0.1')) {
|
|
if((! dns_get_record($server, DNS_A + DNS_CNAME + DNS_PTR)) && (! filter_var($server, FILTER_VALIDATE_IP))) {
|
|
$this->error = sprintf( t('Cannot locate DNS info for database server \'%s\''), $server);
|
|
$this->connected = false;
|
|
$this->db = null;
|
|
return false;
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* @brief Sets the database driver's debugging state.
|
|
*
|
|
* @param int $dbg 0 to disable debugging
|
|
*/
|
|
function dbg($dbg) {
|
|
$this->debug = $dbg;
|
|
}
|
|
|
|
function __destruct() {
|
|
if($this->db && $this->connected) {
|
|
$this->close();
|
|
}
|
|
}
|
|
|
|
function quote_interval($txt) {
|
|
return $txt;
|
|
}
|
|
|
|
function optimize_table($table) {
|
|
q('OPTIMIZE TABLE '.$table);
|
|
}
|
|
|
|
function concat($fld, $sep) {
|
|
return 'GROUP_CONCAT(DISTINCT '.$fld.' SEPARATOR \''.$sep.'\')';
|
|
}
|
|
|
|
function escapebin($str) {
|
|
return $this->escape($str);
|
|
}
|
|
|
|
function unescapebin($str) {
|
|
return $str;
|
|
}
|
|
|
|
function pdo_set($x) {
|
|
$this->pdo = $x;
|
|
}
|
|
|
|
function pdo_get() {
|
|
return $this->pdo;
|
|
}
|
|
|
|
} // end abstract dba_driver class
|
|
|
|
|
|
|
|
// Procedural functions
|
|
|
|
function printable($s) {
|
|
$s = preg_replace("~([\x01-\x08\x0E-\x0F\x10-\x1F\x7F-\xFF])~",".", $s);
|
|
$s = str_replace("\x00",'.',$s);
|
|
if(x($_SERVER,'SERVER_NAME'))
|
|
$s = escape_tags($s);
|
|
|
|
return $s;
|
|
}
|
|
|
|
/**
|
|
* @brief set database driver debugging state.
|
|
*
|
|
* @param int $state 0 to disable debugging
|
|
*/
|
|
function dbg($state) {
|
|
global $db;
|
|
|
|
if(\DBA::$dba)
|
|
\DBA::$dba->dbg($state);
|
|
}
|
|
|
|
/**
|
|
* @brief Escape strings being passed to DB queries.
|
|
*
|
|
* Always escape strings being used in DB queries. This function returns the
|
|
* escaped string. Integer DB parameters should all be proven integers by
|
|
* wrapping with intval().
|
|
*
|
|
* @param string $str A string to pass to a DB query
|
|
* @return Return an escaped string of the value to pass to a DB query.
|
|
*/
|
|
function dbesc($str) {
|
|
|
|
if(\DBA::$dba && \DBA::$dba->connected)
|
|
return(\DBA::$dba->escape($str));
|
|
else
|
|
return(str_replace("'", "\\'", $str));
|
|
}
|
|
function dbescbin($str) {
|
|
return \DBA::$dba->escapebin($str);
|
|
}
|
|
|
|
function dbunescbin($str) {
|
|
return \DBA::$dba->unescapebin($str);
|
|
}
|
|
|
|
function dbescdate($date) {
|
|
if(ACTIVE_DBTYPE == DBTYPE_POSTGRES && $date == '0000-00-00 00:00:00') {
|
|
$date = NULL_DATE;
|
|
} else if(ACTIVE_DBTYPE != DBTYPE_POSTGRES && $date == '0001-01-01 00:00:00') {
|
|
$date = NULL_DATE;
|
|
}
|
|
return $date;
|
|
}
|
|
|
|
function db_quoteinterval($txt) {
|
|
return \DBA::$dba->quote_interval($txt);
|
|
}
|
|
|
|
function dbesc_identifier($str) {
|
|
return \DBA::$dba->escape_identifier($str);
|
|
}
|
|
|
|
function db_utcnow() {
|
|
return \DBA::$dba->utcnow();
|
|
}
|
|
|
|
function db_optimizetable($table) {
|
|
\DBA::$dba->optimize_table($table);
|
|
}
|
|
|
|
function db_concat($fld, $sep) {
|
|
return \DBA::$dba->concat($fld, $sep);
|
|
}
|
|
|
|
/**
|
|
* @brief Execute a SQL query with printf style args.
|
|
*
|
|
* printf style arguments %s and %d are replaced with variable arguments, which
|
|
* should each be appropriately dbesc() or intval().
|
|
* SELECT queries return an array of results or false if SQL or DB error. Other
|
|
* queries return true if the command was successful or false if it wasn't.
|
|
*
|
|
* Example:
|
|
* $r = q("SELECT * FROM `%s` WHERE `uid` = %d",
|
|
* 'user', 1);
|
|
*
|
|
* @param string $sql The SQL query to execute
|
|
* @return bool|array
|
|
*/
|
|
|
|
function q($sql) {
|
|
|
|
$args = func_get_args();
|
|
unset($args[0]);
|
|
|
|
if(\DBA::$dba && \DBA::$dba->connected) {
|
|
$stmt = vsprintf($sql, $args);
|
|
if($stmt === false) {
|
|
if(version_compare(PHP_VERSION, '5.4.0') >= 0)
|
|
db_logger('dba: vsprintf error: ' .
|
|
print_r(debug_backtrace(DEBUG_BACKTRACE_PROVIDE_OBJECT, 1), true),LOGGER_NORMAL,LOG_CRIT);
|
|
else
|
|
db_logger('dba: vsprintf error: ' . print_r(debug_backtrace(), true),LOGGER_NORMAL,LOG_CRIT);
|
|
}
|
|
return \DBA::$dba->q($stmt);
|
|
}
|
|
|
|
/*
|
|
* This will happen occasionally trying to store the
|
|
* session data after abnormal program termination
|
|
*/
|
|
|
|
db_logger('dba: no database: ' . print_r($args,true),LOGGER_NORMAL,LOG_CRIT);
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* @brief Raw DB query, no arguments.
|
|
*
|
|
* This function executes a raw DB query without any arguments.
|
|
*
|
|
* @param string $sql The SQL query to execute
|
|
*/
|
|
function dbq($sql) {
|
|
|
|
if(\DBA::$dba && \DBA::$dba->connected)
|
|
$ret = \DBA::$dba->q($sql);
|
|
else
|
|
$ret = false;
|
|
|
|
return $ret;
|
|
}
|
|
|
|
|
|
|
|
// Caller is responsible for ensuring that any integer arguments to
|
|
// dbesc_array are actually integers and not malformed strings containing
|
|
// SQL injection vectors. All integer array elements should be specifically
|
|
// cast to int to avoid trouble.
|
|
|
|
function dbesc_array_cb(&$item, $key) {
|
|
if(is_string($item)) {
|
|
if($item == '0000-00-00 00:00:00' && ACTIVE_DBTYPE == DBTYPE_POSTGRES)
|
|
$item = '0001-01-01 00:00:00';
|
|
else if($item == '0001-01-01 00:00:00' && ACTIVE_DBTYPE == DBTYPE_MYSQL)
|
|
$item = '0000-00-00 00:00:00';
|
|
|
|
$item = dbesc($item);
|
|
}
|
|
}
|
|
|
|
|
|
function dbesc_array(&$arr) {
|
|
if(is_array($arr) && count($arr)) {
|
|
array_walk($arr,'dbesc_array_cb');
|
|
}
|
|
}
|
|
|
|
function db_getfunc($f) {
|
|
$lookup = array(
|
|
'rand'=>array(
|
|
DBTYPE_MYSQL=>'RAND()',
|
|
DBTYPE_POSTGRES=>'RANDOM()'
|
|
),
|
|
'utc_timestamp'=>array(
|
|
DBTYPE_MYSQL=>'UTC_TIMESTAMP()',
|
|
DBTYPE_POSTGRES=>"now() at time zone 'UTC'"
|
|
),
|
|
'regexp'=>array(
|
|
DBTYPE_MYSQL=>'REGEXP',
|
|
DBTYPE_POSTGRES=>'~'
|
|
),
|
|
'^'=>array(
|
|
DBTYPE_MYSQL=>'^',
|
|
DBTYPE_POSTGRES=>'#'
|
|
)
|
|
);
|
|
$f = strtolower($f);
|
|
if(isset($lookup[$f]) && isset($lookup[$f][ACTIVE_DBTYPE]))
|
|
return $lookup[$f][ACTIVE_DBTYPE];
|
|
|
|
db_logger('Unable to abstract DB function "'. $f . '" for dbtype ' . ACTIVE_DBTYPE, LOGGER_DEBUG, LOG_ERR);
|
|
return $f;
|
|
}
|
|
|
|
// The logger function may make DB calls internally to query the system logging parameters.
|
|
// This can cause a recursion if database debugging is enabled.
|
|
// So this function preserves the current database debugging state and then turns it off
|
|
// temporarily while doing the logger() call
|
|
|
|
function db_logger($s,$level = LOGGER_NORMAL,$syslog = LOG_INFO) {
|
|
|
|
if(\DBA::$logging)
|
|
return;
|
|
|
|
$saved = \DBA::$dba->debug;
|
|
\DBA::$dba->debug = false;
|
|
\DBA::$logging = true;
|
|
logger($s,$level,$syslog);
|
|
\DBA::$logging = false;
|
|
\DBA::$dba->debug = $saved;
|
|
} |