+-----------------------------------------------------------------------+
| program/include/rcube_mdb2.php |
| |
- | This file is part of the RoundCube Webmail client |
- | Copyright (C) 2005-2008, RoundCube Dev. - Switzerland |
+ | This file is part of the Roundcube Webmail client |
+ | Copyright (C) 2005-2009, The Roundcube Dev Team |
| Licensed under the GNU GPL |
| |
| PURPOSE: |
| Author: Lukas Kahwe Smith <smith@pooteeweet.org> |
+-----------------------------------------------------------------------+
- $Id: rcube_mdb2.php 1390 2008-05-15 11:15:58Z thomasb $
+ $Id: rcube_mdb2.php 5543 2011-12-05 07:24:36Z alec $
*/
* @author David Saez Padros <david@ols.es>
* @author Thomas Bruederli <roundcube@gmail.com>
* @author Lukas Kahwe Smith <smith@pooteeweet.org>
- * @version 1.16
+ * @version 1.18
* @link http://pear.php.net/package/MDB2
*/
class rcube_mdb2
- {
- var $db_dsnw; // DSN for write operations
- var $db_dsnr; // DSN for read operations
- var $db_connected = false; // Already connected ?
- var $db_mode = ''; // Connection mode
- var $db_handle = 0; // Connection handle
- var $db_error = false;
- var $db_error_msg = '';
- var $debug_mode = false;
-
- var $a_query_results = array('dummy');
- var $last_res_id = 0;
-
-
- /**
- * Object constructor
- *
- * @param string DSN for read/write operations
- * @param string Optional DSN for read only operations
- */
- function __construct($db_dsnw, $db_dsnr='', $pconn=false)
- {
- if ($db_dsnr=='')
- $db_dsnr=$db_dsnw;
-
- $this->db_dsnw = $db_dsnw;
- $this->db_dsnr = $db_dsnr;
- $this->db_pconn = $pconn;
-
- $dsn_array = MDB2::parseDSN($db_dsnw);
- $this->db_provider = $dsn_array['phptype'];
- }
-
-
- /**
- * PHP 4 object constructor
- *
- * @see rcube_mdb2::__construct
- */
- function rcube_db($db_dsnw,$db_dsnr='')
- {
- $this->__construct($db_dsnw,$db_dsnr);
- }
-
-
- /**
- * Connect to specific database
- *
- * @param string DSN for DB connections
- * @return object PEAR database handle
- * @access private
- */
- function dsn_connect($dsn)
- {
- // Use persistent connections if available
- $dbh = MDB2::connect($dsn, array(
- 'persistent' => $this->db_pconn,
- 'emulate_prepared' => $this->debug_mode,
- 'debug' => $this->debug_mode,
- 'debug_handler' => 'mdb2_debug_handler',
- 'portability' => MDB2_PORTABILITY_ALL ^ MDB2_PORTABILITY_EMPTY_TO_NULL));
-
- if (MDB2::isError($dbh))
- {
- $this->db_error = TRUE;
- $this->db_error_msg = $dbh->getMessage();
-
- raise_error(array('code' => 500, 'type' => 'db', 'line' => __LINE__,
- 'file' => __FILE__, 'message' => $dbh->getUserInfo()), TRUE, FALSE);
- }
- else if ($this->db_provider=='sqlite')
- {
- $dsn_array = MDB2::parseDSN($dsn);
- if (!filesize($dsn_array['database']) && !empty($this->sqlite_initials))
- $this->_sqlite_create_database($dbh, $this->sqlite_initials);
- }
- else
- $dbh->setCharset('utf8');
-
- return $dbh;
- }
-
-
- /**
- * Connect to appropiate databse
- * depending on the operation
- *
- * @param string Connection mode (r|w)
- * @access public
- */
- function db_connect($mode)
- {
- $this->db_mode = $mode;
-
- // Already connected
- if ($this->db_connected)
- {
- // no replication, current connection is ok
- if ($this->db_dsnw==$this->db_dsnr)
- return;
-
- // connected to master, current connection is ok
- if ($this->db_mode=='w')
- return;
-
- // Same mode, current connection is ok
- if ($this->db_mode==$mode)
- return;
- }
-
- if ($mode=='r')
- $dsn = $this->db_dsnr;
- else
- $dsn = $this->db_dsnw;
-
- $this->db_handle = $this->dsn_connect($dsn);
- $this->db_connected = true;
- }
-
-
- /**
- * Activate/deactivate debug mode
- *
- * @param boolean True if SQL queries should be logged
- */
- function set_debug($dbg = true)
- {
- $this->debug_mode = $dbg;
- if ($this->db_connected)
- {
- $this->db_handle->setOption('debug', $dbg);
- $this->db_handle->setOption('emulate_prepared', $dbg);
- }
- }
-
-
- /**
- * Getter for error state
- *
- * @param boolean True on error
- */
- function is_error()
- {
- return $this->db_error ? $this->db_error_msg : FALSE;
- }
-
-
- /**
- * Execute a SQL query
- *
- * @param string SQL query to execute
- * @param mixed Values to be inserted in query
- * @return number Query handle identifier
- * @access public
- */
- function query()
- {
- $params = func_get_args();
- $query = array_shift($params);
-
- return $this->_query($query, 0, 0, $params);
- }
-
-
- /**
- * Execute a SQL query with limits
- *
- * @param string SQL query to execute
- * @param number Offset for LIMIT statement
- * @param number Number of rows for LIMIT statement
- * @param mixed Values to be inserted in query
- * @return number Query handle identifier
- * @access public
- */
- function limitquery()
- {
- $params = func_get_args();
- $query = array_shift($params);
- $offset = array_shift($params);
- $numrows = array_shift($params);
-
- return $this->_query($query, $offset, $numrows, $params);
- }
-
-
- /**
- * Execute a SQL query with limits
- *
- * @param string SQL query to execute
- * @param number Offset for LIMIT statement
- * @param number Number of rows for LIMIT statement
- * @param array Values to be inserted in query
- * @return number Query handle identifier
- * @access private
- */
- function _query($query, $offset, $numrows, $params)
- {
- // Read or write ?
- if (strtolower(trim(substr($query,0,6)))=='select')
- $mode='r';
- else
- $mode='w';
-
- $this->db_connect($mode);
-
- if ($this->db_provider == 'sqlite')
- $this->_sqlite_prepare();
-
- if ($numrows || $offset)
- $result = $this->db_handle->setLimit($numrows,$offset);
-
- if (empty($params))
- $result = $this->db_handle->query($query);
- else
- {
- $params = (array)$params;
- $q = $this->db_handle->prepare($query);
- if ($this->db_handle->isError($q))
- {
- $this->db_error = TRUE;
- $this->db_error_msg = $q->userinfo;
-
- raise_error(array('code' => 500, 'type' => 'db', 'line' => __LINE__, 'file' => __FILE__,
- 'message' => $this->db_error_msg), TRUE, TRUE);
+{
+ public $db_dsnw; // DSN for write operations
+ public $db_dsnr; // DSN for read operations
+ public $db_connected = false; // Already connected ?
+ public $db_mode = ''; // Connection mode
+ public $db_handle = 0; // Connection handle
+ public $db_error = false;
+ public $db_error_msg = '';
+
+ private $debug_mode = false;
+ private $conn_failure = false;
+ private $a_query_results = array('dummy');
+ private $last_res_id = 0;
+ private $tables;
+
+
+ /**
+ * Object constructor
+ *
+ * @param string $db_dsnw DSN for read/write operations
+ * @param string $db_dsnr Optional DSN for read only operations
+ */
+ function __construct($db_dsnw, $db_dsnr='', $pconn=false)
+ {
+ if (empty($db_dsnr))
+ $db_dsnr = $db_dsnw;
+
+ $this->db_dsnw = $db_dsnw;
+ $this->db_dsnr = $db_dsnr;
+ $this->db_pconn = $pconn;
+
+ $dsn_array = MDB2::parseDSN($db_dsnw);
+ $this->db_provider = $dsn_array['phptype'];
+ }
+
+
+ /**
+ * Connect to specific database
+ *
+ * @param string $dsn DSN for DB connections
+ * @return MDB2 PEAR database handle
+ * @access private
+ */
+ private function dsn_connect($dsn)
+ {
+ // Use persistent connections if available
+ $db_options = array(
+ 'persistent' => $this->db_pconn,
+ 'emulate_prepared' => $this->debug_mode,
+ 'debug' => $this->debug_mode,
+ 'debug_handler' => array($this, 'debug_handler'),
+ 'portability' => MDB2_PORTABILITY_ALL ^ MDB2_PORTABILITY_EMPTY_TO_NULL);
+
+ if ($this->db_provider == 'pgsql') {
+ $db_options['disable_smart_seqname'] = true;
+ $db_options['seqname_format'] = '%s';
+ }
+ $this->db_error = false;
+ $this->db_error_msg = null;
+
+ $dbh = MDB2::connect($dsn, $db_options);
+
+ if (MDB2::isError($dbh)) {
+ $this->db_error = true;
+ $this->db_error_msg = $dbh->getMessage();
+
+ raise_error(array('code' => 500, 'type' => 'db',
+ 'line' => __LINE__, 'file' => __FILE__,
+ 'message' => $dbh->getUserInfo()), true, false);
+ }
+ else if ($this->db_provider == 'sqlite') {
+ $dsn_array = MDB2::parseDSN($dsn);
+ if (!filesize($dsn_array['database']) && !empty($this->sqlite_initials))
+ $this->_sqlite_create_database($dbh, $this->sqlite_initials);
+ }
+ else if ($this->db_provider!='mssql' && $this->db_provider!='sqlsrv')
+ $dbh->setCharset('utf8');
+
+ return $dbh;
+ }
+
+
+ /**
+ * Connect to appropiate database depending on the operation
+ *
+ * @param string $mode Connection mode (r|w)
+ * @access public
+ */
+ function db_connect($mode)
+ {
+ // previous connection failed, don't attempt to connect again
+ if ($this->conn_failure) {
+ return;
}
- else
- {
- $result = $q->execute($params);
- $q->free();
+
+ // no replication
+ if ($this->db_dsnw == $this->db_dsnr) {
+ $mode = 'w';
+ }
+
+ // Already connected
+ if ($this->db_connected) {
+ // connected to db with the same or "higher" mode
+ if ($this->db_mode == 'w' || $this->db_mode == $mode) {
+ return;
+ }
+ }
+
+ $dsn = ($mode == 'r') ? $this->db_dsnr : $this->db_dsnw;
+
+ $this->db_handle = $this->dsn_connect($dsn);
+ $this->db_connected = !PEAR::isError($this->db_handle);
+
+ // use write-master when read-only fails
+ if (!$this->db_connected && $mode == 'r') {
+ $mode = 'w';
+ $this->db_handle = $this->dsn_connect($this->db_dsnw);
+ $this->db_connected = !PEAR::isError($this->db_handle);
+ }
+
+ if ($this->db_connected)
+ $this->db_mode = $mode;
+ else
+ $this->conn_failure = true;
+ }
+
+
+ /**
+ * Activate/deactivate debug mode
+ *
+ * @param boolean $dbg True if SQL queries should be logged
+ * @access public
+ */
+ function set_debug($dbg = true)
+ {
+ $this->debug_mode = $dbg;
+ if ($this->db_connected) {
+ $this->db_handle->setOption('debug', $dbg);
+ $this->db_handle->setOption('emulate_prepared', $dbg);
+ }
+ }
+
+
+ /**
+ * Getter for error state
+ *
+ * @param boolean True on error
+ * @access public
+ */
+ function is_error()
+ {
+ return $this->db_error ? $this->db_error_msg : false;
+ }
+
+
+ /**
+ * Connection state checker
+ *
+ * @param boolean True if in connected state
+ * @access public
+ */
+ function is_connected()
+ {
+ return PEAR::isError($this->db_handle) ? false : $this->db_connected;
+ }
+
+
+ /**
+ * Is database replication configured?
+ * This returns true if dsnw != dsnr
+ */
+ function is_replicated()
+ {
+ return !empty($this->db_dsnr) && $this->db_dsnw != $this->db_dsnr;
+ }
+
+
+ /**
+ * Execute a SQL query
+ *
+ * @param string SQL query to execute
+ * @param mixed Values to be inserted in query
+ * @return number Query handle identifier
+ * @access public
+ */
+ function query()
+ {
+ $params = func_get_args();
+ $query = array_shift($params);
+
+ // Support one argument of type array, instead of n arguments
+ if (count($params) == 1 && is_array($params[0]))
+ $params = $params[0];
+
+ return $this->_query($query, 0, 0, $params);
+ }
+
+
+ /**
+ * Execute a SQL query with limits
+ *
+ * @param string SQL query to execute
+ * @param number Offset for LIMIT statement
+ * @param number Number of rows for LIMIT statement
+ * @param mixed Values to be inserted in query
+ * @return number Query handle identifier
+ * @access public
+ */
+ function limitquery()
+ {
+ $params = func_get_args();
+ $query = array_shift($params);
+ $offset = array_shift($params);
+ $numrows = array_shift($params);
+
+ return $this->_query($query, $offset, $numrows, $params);
+ }
+
+
+ /**
+ * Execute a SQL query with limits
+ *
+ * @param string $query SQL query to execute
+ * @param number $offset Offset for LIMIT statement
+ * @param number $numrows Number of rows for LIMIT statement
+ * @param array $params Values to be inserted in query
+ * @return number Query handle identifier
+ * @access private
+ */
+ private function _query($query, $offset, $numrows, $params)
+ {
+ // Read or write ?
+ $mode = (strtolower(substr(trim($query),0,6)) == 'select') ? 'r' : 'w';
+
+ $this->db_connect($mode);
+
+ // check connection before proceeding
+ if (!$this->is_connected())
+ return null;
+
+ if ($this->db_provider == 'sqlite')
+ $this->_sqlite_prepare();
+
+ if ($numrows || $offset)
+ $result = $this->db_handle->setLimit($numrows,$offset);
+
+ if (empty($params))
+ $result = $mode == 'r' ? $this->db_handle->query($query) : $this->db_handle->exec($query);
+ else {
+ $params = (array)$params;
+ $q = $this->db_handle->prepare($query, null, $mode=='w' ? MDB2_PREPARE_MANIP : null);
+ if ($this->db_handle->isError($q)) {
+ $this->db_error = true;
+ $this->db_error_msg = $q->userinfo;
+
+ raise_error(array('code' => 500, 'type' => 'db',
+ 'line' => __LINE__, 'file' => __FILE__,
+ 'message' => $this->db_error_msg), true, false);
+
+ $result = false;
+ }
+ else {
+ $result = $q->execute($params);
+ $q->free();
+ }
}
- }
- // add result, even if it's an error
- return $this->_add_result($result);
+ // add result, even if it's an error
+ return $this->_add_result($result);
}
- /**
- * Get number of rows for a SQL query
- * If no query handle is specified, the last query will be taken as reference
- *
- * @param number Optional query handle identifier
- * @return mixed Number of rows or FALSE on failure
- * @access public
- */
- function num_rows($res_id=NULL)
+ /**
+ * Get number of rows for a SQL query
+ * If no query handle is specified, the last query will be taken as reference
+ *
+ * @param number $res_id Optional query handle identifier
+ * @return mixed Number of rows or false on failure
+ * @access public
+ */
+ function num_rows($res_id=null)
{
- if (!$this->db_handle)
- return FALSE;
+ if (!$this->db_connected)
+ return false;
- if ($result = $this->_get_result($res_id))
- return $result->numRows();
- else
- return FALSE;
+ if ($result = $this->_get_result($res_id))
+ return $result->numRows();
+ else
+ return false;
}
- /**
- * Get number of affected rows fort he last query
- *
- * @return mixed Number of rows or FALSE on failure
- * @access public
- */
- function affected_rows($result = null)
+ /**
+ * Get number of affected rows for the last query
+ *
+ * @param number $res_id Optional query handle identifier
+ * @return mixed Number of rows or false on failure
+ * @access public
+ */
+ function affected_rows($res_id = null)
{
- if (!$this->db_handle)
- return FALSE;
+ if (!$this->db_connected)
+ return false;
- return $this->_get_result($result);
+ return $this->_get_result($res_id);
}
- /**
- * Get last inserted record ID
- * For Postgres databases, a sequence name is required
- *
- * @param string Sequence name for increment
- * @return mixed ID or FALSE on failure
- * @access public
- */
- function insert_id($sequence = '')
+ /**
+ * Get last inserted record ID
+ * For Postgres databases, a sequence name is required
+ *
+ * @param string $table Table name (to find the incremented sequence)
+ * @return mixed ID or false on failure
+ * @access public
+ */
+ function insert_id($table = '')
{
- if (!$this->db_handle || $this->db_mode=='r')
- return FALSE;
+ if (!$this->db_connected || $this->db_mode == 'r')
+ return false;
+
+ if ($table) {
+ if ($this->db_provider == 'pgsql')
+ // find sequence name
+ $table = get_sequence_name($table);
+ else
+ // resolve table name
+ $table = get_table_name($table);
+ }
+
+ $id = $this->db_handle->lastInsertID($table);
- return $this->db_handle->lastInsertID($sequence);
+ return $this->db_handle->isError($id) ? null : $id;
}
- /**
- * Get an associative array for one row
- * If no query handle is specified, the last query will be taken as reference
- *
- * @param number Optional query handle identifier
- * @return mixed Array with col values or FALSE on failure
- * @access public
- */
- function fetch_assoc($res_id=NULL)
+ /**
+ * Get an associative array for one row
+ * If no query handle is specified, the last query will be taken as reference
+ *
+ * @param number $res_id Optional query handle identifier
+ * @return mixed Array with col values or false on failure
+ * @access public
+ */
+ function fetch_assoc($res_id=null)
{
- $result = $this->_get_result($res_id);
- return $this->_fetch_row($result, MDB2_FETCHMODE_ASSOC);
+ $result = $this->_get_result($res_id);
+ return $this->_fetch_row($result, MDB2_FETCHMODE_ASSOC);
}
- /**
- * Get an index array for one row
- * If no query handle is specified, the last query will be taken as reference
- *
- * @param number Optional query handle identifier
- * @return mixed Array with col values or FALSE on failure
- * @access public
- */
- function fetch_array($res_id=NULL)
+ /**
+ * Get an index array for one row
+ * If no query handle is specified, the last query will be taken as reference
+ *
+ * @param number $res_id Optional query handle identifier
+ * @return mixed Array with col values or false on failure
+ * @access public
+ */
+ function fetch_array($res_id=null)
{
- $result = $this->_get_result($res_id);
- return $this->_fetch_row($result, MDB2_FETCHMODE_ORDERED);
+ $result = $this->_get_result($res_id);
+ return $this->_fetch_row($result, MDB2_FETCHMODE_ORDERED);
}
- /**
- * Get co values for a result row
- *
- * @param object Query result handle
- * @param number Fetch mode identifier
- * @return mixed Array with col values or FALSE on failure
- * @access private
- */
- function _fetch_row($result, $mode)
+ /**
+ * Get col values for a result row
+ *
+ * @param MDB2_Result_Common Query $result result handle
+ * @param number $mode Fetch mode identifier
+ * @return mixed Array with col values or false on failure
+ * @access private
+ */
+ private function _fetch_row($result, $mode)
{
- if (PEAR::isError($result))
- {
- raise_error(array('code' => 500, 'type' => 'db', 'line' => __LINE__, 'file' => __FILE__,
- 'message' => $this->db_link->getMessage()), TRUE, FALSE);
- return FALSE;
- }
+ if ($result === false || PEAR::isError($result) || !$this->is_connected())
+ return false;
- return $result->fetchRow($mode);
+ return $result->fetchRow($mode);
}
- /**
- * Formats input so it can be safely used in a query
- *
- * @param mixed Value to quote
- * @return string Quoted/converted string for use in query
- * @access public
- */
- function quote($input, $type = null)
+ /**
+ * Wrapper for the SHOW TABLES command
+ *
+ * @return array List of all tables of the current database
+ * @access public
+ * @since 0.4-beta
+ */
+ function list_tables()
{
- // create DB handle if not available
- if (!$this->db_handle)
- $this->db_connect('r');
+ // get tables if not cached
+ if (!$this->tables) {
+ $this->db_handle->loadModule('Manager');
+ if (!PEAR::isError($result = $this->db_handle->listTables()))
+ $this->tables = $result;
+ else
+ $this->tables = array();
+ }
+
+ return $this->tables;
+ }
+
- // escape pear identifier chars
- $rep_chars = array('?' => '\?',
- '!' => '\!',
- '&' => '\&');
+ /**
+ * Wrapper for SHOW COLUMNS command
+ *
+ * @param string Table name
+ * @return array List of table cols
+ */
+ function list_cols($table)
+ {
+ $this->db_handle->loadModule('Manager');
+ if (!PEAR::isError($result = $this->db_handle->listTableFields($table))) {
+ return $result;
+ }
- return $this->db_handle->quote($input, $type);
+ return null;
}
- /**
- * Quotes a string so it can be safely used as a table or column name
- *
- * @param string Value to quote
- * @return string Quoted string for use in query
- * @deprecated Replaced by rcube_MDB2::quote_identifier
- * @see rcube_MDB2::quote_identifier
- * @access public
- */
- function quoteIdentifier($str)
- {
- return $this->quote_identifier($str);
- }
-
-
- /**
- * Quotes a string so it can be safely used as a table or column name
- *
- * @param string Value to quote
- * @return string Quoted string for use in query
- * @access public
- */
- function quote_identifier($str)
- {
- if (!$this->db_handle)
- $this->db_connect('r');
-
- return $this->db_handle->quoteIdentifier($str);
- }
-
- /**
- * Escapes a string
- *
- * @param string The string to be escaped
- * @return string The escaped string
- * @access public
- * @since 0.1.1
- */
- function escapeSimple($str)
- {
- if (!$this->db_handle)
- $this->db_connect('r');
-
- return $this->db_handle->escape($str);
- }
-
-
- /**
- * Return SQL function for current time and date
- *
- * @return string SQL function to use in query
- * @access public
- */
- function now()
- {
- switch($this->db_provider)
- {
- case 'mssql':
- return "getdate()";
-
- default:
- return "now()";
- }
- }
-
-
- /**
- * Return SQL statement to convert a field value into a unix timestamp
- *
- * @param string Field name
- * @return string SQL statement to use in query
- * @access public
- */
- function unixtimestamp($field)
- {
- switch($this->db_provider)
- {
- case 'pgsql':
- return "EXTRACT (EPOCH FROM $field)";
- break;
-
- case 'mssql':
- return "datediff(s, '1970-01-01 00:00:00', $field)";
-
- default:
- return "UNIX_TIMESTAMP($field)";
- }
- }
-
-
- /**
- * Return SQL statement to convert from a unix timestamp
- *
- * @param string Field name
- * @return string SQL statement to use in query
- * @access public
- */
- function fromunixtime($timestamp)
- {
- switch($this->db_provider)
- {
- case 'mysqli':
- case 'mysql':
- case 'sqlite':
- return sprintf("FROM_UNIXTIME(%d)", $timestamp);
-
- default:
+ /**
+ * Formats input so it can be safely used in a query
+ *
+ * @param mixed $input Value to quote
+ * @param string $type Type of data
+ * @return string Quoted/converted string for use in query
+ * @access public
+ */
+ function quote($input, $type = null)
+ {
+ // handle int directly for better performance
+ if ($type == 'integer')
+ return intval($input);
+
+ // create DB handle if not available
+ if (!$this->db_handle)
+ $this->db_connect('r');
+
+ return $this->db_connected ? $this->db_handle->quote($input, $type) : addslashes($input);
+ }
+
+
+ /**
+ * Quotes a string so it can be safely used as a table or column name
+ *
+ * @param string $str Value to quote
+ * @return string Quoted string for use in query
+ * @deprecated Replaced by rcube_MDB2::quote_identifier
+ * @see rcube_mdb2::quote_identifier
+ * @access public
+ */
+ function quoteIdentifier($str)
+ {
+ return $this->quote_identifier($str);
+ }
+
+
+ /**
+ * Quotes a string so it can be safely used as a table or column name
+ *
+ * @param string $str Value to quote
+ * @return string Quoted string for use in query
+ * @access public
+ */
+ function quote_identifier($str)
+ {
+ if (!$this->db_handle)
+ $this->db_connect('r');
+
+ return $this->db_connected ? $this->db_handle->quoteIdentifier($str) : $str;
+ }
+
+
+ /**
+ * Escapes a string
+ *
+ * @param string $str The string to be escaped
+ * @return string The escaped string
+ * @access public
+ * @since 0.1.1
+ */
+ function escapeSimple($str)
+ {
+ if (!$this->db_handle)
+ $this->db_connect('r');
+
+ return $this->db_handle->escape($str);
+ }
+
+
+ /**
+ * Return SQL function for current time and date
+ *
+ * @return string SQL function to use in query
+ * @access public
+ */
+ function now()
+ {
+ switch ($this->db_provider) {
+ case 'mssql':
+ case 'sqlsrv':
+ return "getdate()";
+
+ default:
+ return "now()";
+ }
+ }
+
+
+ /**
+ * Return list of elements for use with SQL's IN clause
+ *
+ * @param array $arr Input array
+ * @param string $type Type of data
+ * @return string Comma-separated list of quoted values for use in query
+ * @access public
+ */
+ function array2list($arr, $type = null)
+ {
+ if (!is_array($arr))
+ return $this->quote($arr, $type);
+
+ foreach ($arr as $idx => $item)
+ $arr[$idx] = $this->quote($item, $type);
+
+ return implode(',', $arr);
+ }
+
+
+ /**
+ * Return SQL statement to convert a field value into a unix timestamp
+ *
+ * This method is deprecated and should not be used anymore due to limitations
+ * of timestamp functions in Mysql (year 2038 problem)
+ *
+ * @param string $field Field name
+ * @return string SQL statement to use in query
+ * @deprecated
+ */
+ function unixtimestamp($field)
+ {
+ switch($this->db_provider) {
+ case 'pgsql':
+ return "EXTRACT (EPOCH FROM $field)";
+
+ case 'mssql':
+ case 'sqlsrv':
+ return "DATEDIFF(second, '19700101', $field) + DATEDIFF(second, GETDATE(), GETUTCDATE())";
+
+ default:
+ return "UNIX_TIMESTAMP($field)";
+ }
+ }
+
+
+ /**
+ * Return SQL statement to convert from a unix timestamp
+ *
+ * @param string $timestamp Field name
+ * @return string SQL statement to use in query
+ * @access public
+ */
+ function fromunixtime($timestamp)
+ {
return date("'Y-m-d H:i:s'", $timestamp);
- }
}
- /**
- * Adds a query result and returns a handle ID
- *
- * @param object Query handle
- * @return mixed Handle ID or FALE on failure
- * @access private
- */
- function _add_result($res)
+ /**
+ * Return SQL statement for case insensitive LIKE
+ *
+ * @param string $column Field name
+ * @param string $value Search value
+ * @return string SQL statement to use in query
+ * @access public
+ */
+ function ilike($column, $value)
{
- // sql error occured
- if (PEAR::isError($res))
- {
- raise_error(array('code' => 500, 'type' => 'db', 'line' => __LINE__, 'file' => __FILE__,
- 'message' => $res->getMessage() . " Query: " . substr(preg_replace('/[\r\n]+\s*/', ' ', $res->userinfo), 0, 512)), TRUE, FALSE);
- return FALSE;
- }
- else
- {
- $res_id = sizeof($this->a_query_results);
- $this->a_query_results[$res_id] = $res;
- $this->last_res_id = $res_id;
- return $res_id;
- }
+ // TODO: use MDB2's matchPattern() function
+ switch($this->db_provider) {
+ case 'pgsql':
+ return $this->quote_identifier($column).' ILIKE '.$this->quote($value);
+ default:
+ return $this->quote_identifier($column).' LIKE '.$this->quote($value);
+ }
}
+ /**
+ * Abstract SQL statement for value concatenation
+ *
+ * @return string SQL statement to be used in query
+ * @access public
+ */
+ function concat(/* col1, col2, ... */)
+ {
+ $func = '';
+ $args = func_get_args();
+
+ switch($this->db_provider) {
+ case 'mysql':
+ case 'mysqli':
+ $func = 'CONCAT';
+ $delim = ', ';
+ break;
+ case 'mssql':
+ case 'sqlsrv':
+ $delim = ' + ';
+ break;
+ default:
+ $delim = ' || ';
+ }
- /**
- * Resolves a given handle ID and returns the according query handle
- * If no ID is specified, the last ressource handle will be returned
- *
- * @param number Handle ID
- * @return mixed Ressource handle or FALE on failure
- * @access private
- */
- function _get_result($res_id=NULL)
+ return $func . '(' . join($delim, $args) . ')';
+ }
+
+
+ /**
+ * Encodes non-UTF-8 characters in string/array/object (recursive)
+ *
+ * @param mixed $input Data to fix
+ * @return mixed Properly UTF-8 encoded data
+ * @access public
+ */
+ function encode($input)
{
- if ($res_id==NULL)
- $res_id = $this->last_res_id;
+ if (is_object($input)) {
+ foreach (get_object_vars($input) as $idx => $value)
+ $input->$idx = $this->encode($value);
+ return $input;
+ }
+ else if (is_array($input)) {
+ foreach ($input as $idx => $value)
+ $input[$idx] = $this->encode($value);
+ return $input;
+ }
- if ($res_id && isset($this->a_query_results[$res_id]))
- return $this->a_query_results[$res_id];
- else
- return FALSE;
+ return utf8_encode($input);
}
- /**
- * Create a sqlite database from a file
- *
- * @param object SQLite database handle
- * @param string File path to use for DB creation
- * @access private
- */
- function _sqlite_create_database($dbh, $file_name)
+ /**
+ * Decodes encoded UTF-8 string/object/array (recursive)
+ *
+ * @param mixed $input Input data
+ * @return mixed Decoded data
+ * @access public
+ */
+ function decode($input)
{
- if (empty($file_name) || !is_string($file_name))
- return;
+ if (is_object($input)) {
+ foreach (get_object_vars($input) as $idx => $value)
+ $input->$idx = $this->decode($value);
+ return $input;
+ }
+ else if (is_array($input)) {
+ foreach ($input as $idx => $value)
+ $input[$idx] = $this->decode($value);
+ return $input;
+ }
- $data = '';
- if ($fd = fopen($file_name, 'r'))
- {
- $data = fread($fd, filesize($file_name));
- fclose($fd);
- }
+ return utf8_decode($input);
+ }
- if (strlen($data))
- sqlite_exec($dbh->connection, $data);
+
+ /**
+ * Adds a query result and returns a handle ID
+ *
+ * @param object $res Query handle
+ * @return mixed Handle ID
+ * @access private
+ */
+ private function _add_result($res)
+ {
+ // sql error occured
+ if (PEAR::isError($res)) {
+ $this->db_error = true;
+ $this->db_error_msg = $res->getMessage();
+ raise_error(array('code' => 500, 'type' => 'db',
+ 'line' => __LINE__, 'file' => __FILE__,
+ 'message' => $res->getMessage() . " Query: "
+ . substr(preg_replace('/[\r\n]+\s*/', ' ', $res->userinfo), 0, 512)),
+ true, false);
+ }
+
+ $res_id = sizeof($this->a_query_results);
+ $this->last_res_id = $res_id;
+ $this->a_query_results[$res_id] = $res;
+ return $res_id;
}
- /**
- * Add some proprietary database functions to the current SQLite handle
- * in order to make it MySQL compatible
- *
- * @access private
- */
- function _sqlite_prepare()
+ /**
+ * Resolves a given handle ID and returns the according query handle
+ * If no ID is specified, the last resource handle will be returned
+ *
+ * @param number $res_id Handle ID
+ * @return mixed Resource handle or false on failure
+ * @access private
+ */
+ private function _get_result($res_id = null)
{
- include_once('include/rcube_sqlite.inc');
+ if ($res_id == null)
+ $res_id = $this->last_res_id;
- // we emulate via callback some missing MySQL function
- sqlite_create_function($this->db_handle->connection, "from_unixtime", "rcube_sqlite_from_unixtime");
- sqlite_create_function($this->db_handle->connection, "unix_timestamp", "rcube_sqlite_unix_timestamp");
- sqlite_create_function($this->db_handle->connection, "now", "rcube_sqlite_now");
- sqlite_create_function($this->db_handle->connection, "md5", "rcube_sqlite_md5");
+ if (isset($this->a_query_results[$res_id]))
+ if (!PEAR::isError($this->a_query_results[$res_id]))
+ return $this->a_query_results[$res_id];
+
+ return false;
}
- } // end class rcube_db
+ /**
+ * Create a sqlite database from a file
+ *
+ * @param MDB2 $dbh SQLite database handle
+ * @param string $file_name File path to use for DB creation
+ * @access private
+ */
+ private function _sqlite_create_database($dbh, $file_name)
+ {
+ if (empty($file_name) || !is_string($file_name))
+ return;
+ $data = file_get_contents($file_name);
-/* this is our own debug handler for the MDB2 connection */
-function mdb2_debug_handler(&$db, $scope, $message, $context = array())
-{
- if ($scope != 'prepare')
- {
- $debug_output = $scope . '('.$db->db_index.'): ';
- $debug_output .= $message . $db->getOption('log_line_break');
- write_log('sqllog', $debug_output);
- }
-}
+ if (strlen($data))
+ if (!sqlite_exec($dbh->connection, $data, $error) || MDB2::isError($dbh))
+ raise_error(array('code' => 500, 'type' => 'db',
+ 'line' => __LINE__, 'file' => __FILE__,
+ 'message' => $error), true, false);
+ }
+ /**
+ * Add some proprietary database functions to the current SQLite handle
+ * in order to make it MySQL compatible
+ *
+ * @access private
+ */
+ private function _sqlite_prepare()
+ {
+ include_once(INSTALL_PATH . 'program/include/rcube_sqlite.inc');
+
+ // we emulate via callback some missing MySQL function
+ sqlite_create_function($this->db_handle->connection,
+ 'from_unixtime', 'rcube_sqlite_from_unixtime');
+ sqlite_create_function($this->db_handle->connection,
+ 'unix_timestamp', 'rcube_sqlite_unix_timestamp');
+ sqlite_create_function($this->db_handle->connection,
+ 'now', 'rcube_sqlite_now');
+ sqlite_create_function($this->db_handle->connection,
+ 'md5', 'rcube_sqlite_md5');
+ }
+
+
+ /**
+ * Debug handler for the MDB2
+ */
+ function debug_handler(&$db, $scope, $message, $context = array())
+ {
+ if ($scope != 'prepare') {
+ $debug_output = sprintf('%s(%d): %s;',
+ $scope, $db->db_index, rtrim($message, ';'));
+ write_log('sql', $debug_output);
+ }
+ }
+
+} // end class rcube_db
projects / roundcube.git / blobdiff