4 +-----------------------------------------------------------------------+
5 | program/include/rcube_mdb2.php |
7 | This file is part of the RoundCube Webmail client |
8 | Copyright (C) 2005-2008, RoundCube Dev. - Switzerland |
9 | Licensed under the GNU GPL |
12 | PEAR:DB wrapper class that implements PEAR MDB2 functions |
13 | See http://pear.php.net/package/MDB2 |
15 +-----------------------------------------------------------------------+
16 | Author: Lukas Kahwe Smith <smith@pooteeweet.org> |
17 +-----------------------------------------------------------------------+
19 $Id: rcube_mdb2.php 1978 2008-10-14 12:49:44Z thomasb $
25 * Database independent query interface
27 * This is a wrapper for the PEAR::MDB2 class
30 * @author David Saez Padros <david@ols.es>
31 * @author Thomas Bruederli <roundcube@gmail.com>
32 * @author Lukas Kahwe Smith <smith@pooteeweet.org>
34 * @link http://pear.php.net/package/MDB2
38 var $db_dsnw; // DSN for write operations
39 var $db_dsnr; // DSN for read operations
40 var $db_connected = false; // Already connected ?
41 var $db_mode = ''; // Connection mode
42 var $db_handle = 0; // Connection handle
43 var $db_error = false;
44 var $db_error_msg = '';
45 var $debug_mode = false;
47 var $a_query_results = array('dummy');
54 * @param string DSN for read/write operations
55 * @param string Optional DSN for read only operations
57 function __construct($db_dsnw, $db_dsnr='', $pconn=false)
62 $this->db_dsnw = $db_dsnw;
63 $this->db_dsnr = $db_dsnr;
64 $this->db_pconn = $pconn;
66 $dsn_array = MDB2::parseDSN($db_dsnw);
67 $this->db_provider = $dsn_array['phptype'];
72 * Connect to specific database
74 * @param string DSN for DB connections
75 * @return object PEAR database handle
78 function dsn_connect($dsn)
80 // Use persistent connections if available
82 'persistent' => $this->db_pconn,
83 'emulate_prepared' => $this->debug_mode,
84 'debug' => $this->debug_mode,
85 'debug_handler' => 'mdb2_debug_handler',
86 'portability' => MDB2_PORTABILITY_ALL ^ MDB2_PORTABILITY_EMPTY_TO_NULL);
88 if ($this->db_provider == 'pgsql') {
89 $db_options['disable_smart_seqname'] = true;
90 $db_options['seqname_format'] = '%s';
93 $dbh = MDB2::connect($dsn, $db_options);
95 if (MDB2::isError($dbh))
97 $this->db_error = TRUE;
98 $this->db_error_msg = $dbh->getMessage();
100 raise_error(array('code' => 500, 'type' => 'db', 'line' => __LINE__,
101 'file' => __FILE__, 'message' => $dbh->getUserInfo()), TRUE, FALSE);
103 else if ($this->db_provider=='sqlite')
105 $dsn_array = MDB2::parseDSN($dsn);
106 if (!filesize($dsn_array['database']) && !empty($this->sqlite_initials))
107 $this->_sqlite_create_database($dbh, $this->sqlite_initials);
110 $dbh->setCharset('utf8');
117 * Connect to appropiate databse
118 * depending on the operation
120 * @param string Connection mode (r|w)
123 function db_connect($mode)
125 $this->db_mode = $mode;
128 if ($this->db_connected)
130 // no replication, current connection is ok
131 if ($this->db_dsnw==$this->db_dsnr)
134 // connected to master, current connection is ok
135 if ($this->db_mode=='w')
138 // Same mode, current connection is ok
139 if ($this->db_mode==$mode)
144 $dsn = $this->db_dsnr;
146 $dsn = $this->db_dsnw;
148 $this->db_handle = $this->dsn_connect($dsn);
149 $this->db_connected = true;
154 * Activate/deactivate debug mode
156 * @param boolean True if SQL queries should be logged
158 function set_debug($dbg = true)
160 $this->debug_mode = $dbg;
161 if ($this->db_connected)
163 $this->db_handle->setOption('debug', $dbg);
164 $this->db_handle->setOption('emulate_prepared', $dbg);
170 * Getter for error state
172 * @param boolean True on error
176 return $this->db_error ? $this->db_error_msg : FALSE;
181 * Execute a SQL query
183 * @param string SQL query to execute
184 * @param mixed Values to be inserted in query
185 * @return number Query handle identifier
190 $params = func_get_args();
191 $query = array_shift($params);
193 return $this->_query($query, 0, 0, $params);
198 * Execute a SQL query with limits
200 * @param string SQL query to execute
201 * @param number Offset for LIMIT statement
202 * @param number Number of rows for LIMIT statement
203 * @param mixed Values to be inserted in query
204 * @return number Query handle identifier
207 function limitquery()
209 $params = func_get_args();
210 $query = array_shift($params);
211 $offset = array_shift($params);
212 $numrows = array_shift($params);
214 return $this->_query($query, $offset, $numrows, $params);
219 * Execute a SQL query with limits
221 * @param string SQL query to execute
222 * @param number Offset for LIMIT statement
223 * @param number Number of rows for LIMIT statement
224 * @param array Values to be inserted in query
225 * @return number Query handle identifier
228 function _query($query, $offset, $numrows, $params)
231 if (strtolower(trim(substr($query,0,6)))=='select')
236 $this->db_connect($mode);
238 if ($this->db_provider == 'sqlite')
239 $this->_sqlite_prepare();
241 if ($numrows || $offset)
242 $result = $this->db_handle->setLimit($numrows,$offset);
245 $result = $this->db_handle->query($query);
248 $params = (array)$params;
249 $q = $this->db_handle->prepare($query);
250 if ($this->db_handle->isError($q))
252 $this->db_error = TRUE;
253 $this->db_error_msg = $q->userinfo;
255 raise_error(array('code' => 500, 'type' => 'db', 'line' => __LINE__, 'file' => __FILE__,
256 'message' => $this->db_error_msg), TRUE, TRUE);
260 $result = $q->execute($params);
265 // add result, even if it's an error
266 return $this->_add_result($result);
271 * Get number of rows for a SQL query
272 * If no query handle is specified, the last query will be taken as reference
274 * @param number Optional query handle identifier
275 * @return mixed Number of rows or FALSE on failure
278 function num_rows($res_id=NULL)
280 if (!$this->db_handle)
283 if ($result = $this->_get_result($res_id))
284 return $result->numRows();
291 * Get number of affected rows fort he last query
293 * @return mixed Number of rows or FALSE on failure
296 function affected_rows($result = null)
298 if (!$this->db_handle)
301 return $this->_get_result($result);
306 * Get last inserted record ID
307 * For Postgres databases, a sequence name is required
309 * @param string Sequence name for increment
310 * @return mixed ID or FALSE on failure
313 function insert_id($sequence = '')
315 if (!$this->db_handle || $this->db_mode=='r')
318 return $this->db_handle->lastInsertID($sequence);
323 * Get an associative array for one row
324 * If no query handle is specified, the last query will be taken as reference
326 * @param number Optional query handle identifier
327 * @return mixed Array with col values or FALSE on failure
330 function fetch_assoc($res_id=NULL)
332 $result = $this->_get_result($res_id);
333 return $this->_fetch_row($result, MDB2_FETCHMODE_ASSOC);
338 * Get an index array for one row
339 * If no query handle is specified, the last query will be taken as reference
341 * @param number Optional query handle identifier
342 * @return mixed Array with col values or FALSE on failure
345 function fetch_array($res_id=NULL)
347 $result = $this->_get_result($res_id);
348 return $this->_fetch_row($result, MDB2_FETCHMODE_ORDERED);
353 * Get co values for a result row
355 * @param object Query result handle
356 * @param number Fetch mode identifier
357 * @return mixed Array with col values or FALSE on failure
360 function _fetch_row($result, $mode)
362 if (PEAR::isError($result))
364 raise_error(array('code' => 500, 'type' => 'db', 'line' => __LINE__, 'file' => __FILE__,
365 'message' => $this->db_link->getMessage()), TRUE, FALSE);
369 return $result->fetchRow($mode);
374 * Formats input so it can be safely used in a query
376 * @param mixed Value to quote
377 * @return string Quoted/converted string for use in query
380 function quote($input, $type = null)
382 // create DB handle if not available
383 if (!$this->db_handle)
384 $this->db_connect('r');
386 // escape pear identifier chars
387 $rep_chars = array('?' => '\?',
391 return $this->db_handle->quote($input, $type);
396 * Quotes a string so it can be safely used as a table or column name
398 * @param string Value to quote
399 * @return string Quoted string for use in query
400 * @deprecated Replaced by rcube_MDB2::quote_identifier
401 * @see rcube_MDB2::quote_identifier
404 function quoteIdentifier($str)
406 return $this->quote_identifier($str);
411 * Quotes a string so it can be safely used as a table or column name
413 * @param string Value to quote
414 * @return string Quoted string for use in query
417 function quote_identifier($str)
419 if (!$this->db_handle)
420 $this->db_connect('r');
422 return $this->db_handle->quoteIdentifier($str);
428 * @param string The string to be escaped
429 * @return string The escaped string
433 function escapeSimple($str)
435 if (!$this->db_handle)
436 $this->db_connect('r');
438 return $this->db_handle->escape($str);
443 * Return SQL function for current time and date
445 * @return string SQL function to use in query
450 switch($this->db_provider)
462 * Return SQL statement to convert a field value into a unix timestamp
464 * @param string Field name
465 * @return string SQL statement to use in query
468 function unixtimestamp($field)
470 switch($this->db_provider)
473 return "EXTRACT (EPOCH FROM $field)";
477 return "datediff(s, '1970-01-01 00:00:00', $field)";
480 return "UNIX_TIMESTAMP($field)";
486 * Return SQL statement to convert from a unix timestamp
488 * @param string Field name
489 * @return string SQL statement to use in query
492 function fromunixtime($timestamp)
494 switch($this->db_provider)
499 return sprintf("FROM_UNIXTIME(%d)", $timestamp);
502 return date("'Y-m-d H:i:s'", $timestamp);
508 * Return SQL statement for case insensitive LIKE
510 * @param string Field name
511 * @param string Search value
512 * @return string SQL statement to use in query
515 function ilike($column, $value)
517 // TODO: use MDB2's matchPattern() function
518 switch($this->db_provider)
521 return $this->quote_identifier($column).' ILIKE '.$this->quote($value);
523 return $this->quote_identifier($column).' LIKE '.$this->quote($value);
529 * Adds a query result and returns a handle ID
531 * @param object Query handle
532 * @return mixed Handle ID or FALE on failure
535 function _add_result($res)
538 if (PEAR::isError($res))
540 raise_error(array('code' => 500, 'type' => 'db', 'line' => __LINE__, 'file' => __FILE__,
541 'message' => $res->getMessage() . " Query: " . substr(preg_replace('/[\r\n]+\s*/', ' ', $res->userinfo), 0, 512)), TRUE, FALSE);
546 $res_id = sizeof($this->a_query_results);
547 $this->a_query_results[$res_id] = $res;
548 $this->last_res_id = $res_id;
555 * Resolves a given handle ID and returns the according query handle
556 * If no ID is specified, the last ressource handle will be returned
558 * @param number Handle ID
559 * @return mixed Ressource handle or FALE on failure
562 function _get_result($res_id=NULL)
565 $res_id = $this->last_res_id;
567 if ($res_id && isset($this->a_query_results[$res_id]))
568 return $this->a_query_results[$res_id];
575 * Create a sqlite database from a file
577 * @param object SQLite database handle
578 * @param string File path to use for DB creation
581 function _sqlite_create_database($dbh, $file_name)
583 if (empty($file_name) || !is_string($file_name))
586 $data = file_get_contents($file_name);
589 sqlite_exec($dbh->connection, $data);
594 * Add some proprietary database functions to the current SQLite handle
595 * in order to make it MySQL compatible
599 function _sqlite_prepare()
601 include_once('include/rcube_sqlite.inc');
603 // we emulate via callback some missing MySQL function
604 sqlite_create_function($this->db_handle->connection, "from_unixtime", "rcube_sqlite_from_unixtime");
605 sqlite_create_function($this->db_handle->connection, "unix_timestamp", "rcube_sqlite_unix_timestamp");
606 sqlite_create_function($this->db_handle->connection, "now", "rcube_sqlite_now");
607 sqlite_create_function($this->db_handle->connection, "md5", "rcube_sqlite_md5");
611 } // end class rcube_db
614 /* this is our own debug handler for the MDB2 connection */
615 function mdb2_debug_handler(&$db, $scope, $message, $context = array())
617 if ($scope != 'prepare')
619 $debug_output = $scope . '('.$db->db_index.'): ';
620 $debug_output .= $message . $db->getOption('log_line_break');
621 write_log('sqllog', $debug_output);