From 0d94fd45f422fe0d0460f5db7a7761f56bc18236 Mon Sep 17 00:00:00 2001
From: Aleksander Machniak <alec@alec.pl>
Date: Tue, 19 Jun 2012 10:46:41 +0200
Subject: New database layer based on PHP PDO

---
 program/include/rcube_db_pgsql.php | 89 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 89 insertions(+)
 create mode 100644 program/include/rcube_db_pgsql.php

(limited to 'program/include/rcube_db_pgsql.php')

diff --git a/program/include/rcube_db_pgsql.php b/program/include/rcube_db_pgsql.php
new file mode 100644
index 000000000..63bd92b40
--- /dev/null
+++ b/program/include/rcube_db_pgsql.php
@@ -0,0 +1,89 @@
+<?php
+
+/*
+ +-----------------------------------------------------------------------+
+ | program/include/rcube_db_pgsql.php                                    |
+ |                                                                       |
+ | This file is part of the Roundcube Webmail client                     |
+ | Copyright (C) 2005-2012, The Roundcube Dev Team                       |
+ |                                                                       |
+ | Licensed under the GNU General Public License version 3 or            |
+ | any later version with exceptions for skins & plugins.                |
+ | See the README file for a full license statement.                     |
+ |                                                                       |
+ | PURPOSE:                                                              |
+ |   Database wrapper class that implements PHP PDO functions            |
+ |   for PostgreSQL database                                             |
+ |                                                                       |
+ +-----------------------------------------------------------------------+
+ | Author: Aleksander Machniak <alec@alec.pl>                            |
+ +-----------------------------------------------------------------------+
+*/
+
+
+/**
+ * Database independent query interface
+ *
+ * This is a wrapper for the PHP PDO
+ *
+ * @package    Database
+ * @version    1.0
+ */
+class rcube_db_pgsql extends rcube_db
+{
+
+    /**
+     * Get last inserted record ID
+     * For Postgres databases, a table name is required
+     *
+     * @param  string $table  Table name (to find the incremented sequence)
+     *
+     * @return mixed   ID or false on failure
+     */
+    public function insert_id($table = '')
+    {
+        if (!$this->db_connected || $this->db_mode == 'r') {
+            return false;
+        }
+
+        if ($table) {
+            $table = $this->sequence_name($table);
+        }
+
+        $id = $this->dbh->lastInsertId($table);
+
+        return $id;
+    }
+
+
+    /**
+     * 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
+     */
+    public function unixtimestamp($field)
+    {
+        return "EXTRACT (EPOCH FROM $field)";
+    }
+
+
+    /**
+     * 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
+     */
+    public function ilike($column, $value)
+    {
+        return $this->quote_identifier($column).' ILIKE '.$this->quote($value);
+    }
+
+}
-- 
cgit v1.2.3


From 8c2375a07443231cad32bd4cbd1d9ffbd1aa5087 Mon Sep 17 00:00:00 2001
From: Aleksander Machniak <alec@alec.pl>
Date: Wed, 4 Jul 2012 13:11:09 +0200
Subject: More CS fixes and comments

---
 program/include/rcube_db.php        |  5 +++++
 program/include/rcube_db_mssql.php  | 44 +++++++++++++++++++++++++++----------
 program/include/rcube_db_mysql.php  |  7 +++---
 program/include/rcube_db_pgsql.php  |  3 ---
 program/include/rcube_db_sqlite.php | 18 ++++++++++-----
 program/include/rcube_db_sqlsrv.php | 18 ++++++++++-----
 6 files changed, 66 insertions(+), 29 deletions(-)

(limited to 'program/include/rcube_db_pgsql.php')

diff --git a/program/include/rcube_db.php b/program/include/rcube_db.php
index feb16b2ac..2ee562395 100644
--- a/program/include/rcube_db.php
+++ b/program/include/rcube_db.php
@@ -463,6 +463,11 @@ class rcube_db
     /**
      * Adds LIMIT,OFFSET clauses to the query
      *
+     * @param string $query   SQL query
+     * @param int    $limit   Number of rows
+     * @param int    $offset  Offset
+     *
+     * @return string SQL query
      */
     protected function set_limit($query, $limit = 0, $offset = 0)
     {
diff --git a/program/include/rcube_db_mssql.php b/program/include/rcube_db_mssql.php
index 1f7328c3e..3a64c3b1d 100644
--- a/program/include/rcube_db_mssql.php
+++ b/program/include/rcube_db_mssql.php
@@ -31,17 +31,23 @@
  */
 class rcube_db_mssql extends rcube_db
 {
+    /**
+     * Driver initialization
+     */
     protected function init()
     {
         $this->options['identifier_start'] = '[';
         $this->options['identifier_end'] = ']';
     }
 
+    /**
+     * Character setting
+     */
     protected function set_charset($charset)
     {
+        // UTF-8 is default
     }
 
-
     /**
      * Return SQL function for current time and date
      *
@@ -52,7 +58,6 @@ class rcube_db_mssql extends rcube_db
         return "getdate()";
     }
 
-
     /**
      * Return SQL statement to convert a field value into a unix timestamp
      *
@@ -69,7 +74,6 @@ class rcube_db_mssql extends rcube_db
         return "DATEDIFF(second, '19700101', $field) + DATEDIFF(second, GETDATE(), GETUTCDATE())";
     }
 
-
     /**
      * Abstract SQL statement for value concatenation
      *
@@ -86,28 +90,44 @@ class rcube_db_mssql extends rcube_db
         return '(' . join('+', $args) . ')';
     }
 
-
     /**
      * Adds TOP (LIMIT,OFFSET) clause to the query
      *
+     * @param string $query   SQL query
+     * @param int    $limit   Number of rows
+     * @param int    $offset  Offset
+     *
+     * @return string SQL query
      */
     protected function set_limit($query, $limit = 0, $offset = 0)
     {
-        // code from MDB2 package
-        if ($limit > 0) {
-            $fetch = $offset + $limit;
-            return preg_replace('/^([\s(])*SELECT( DISTINCT)?(?!\s*TOP\s*\()/i',
-                "\\1SELECT\\2 TOP $fetch", $query);
+        $limit  = intval($limit);
+        $offset = intval($offset);
+
+        $orderby = stristr($query, 'ORDER BY');
+        if ($orderby !== false) {
+            $sort  = (stripos($orderby, ' desc') !== false) ? 'desc' : 'asc';
+            $order = str_ireplace('ORDER BY', '', $orderby);
+            $order = trim(preg_replace('/\bASC\b|\bDESC\b/i', '', $order));
         }
 
-// @TODO: proper OFFSET handling i _fetch_row()
+        $query = preg_replace('/^SELECT\s/i', 'SELECT TOP ' . ($limit + $offset) . ' ', $query);
+
+        $query = 'SELECT * FROM (SELECT TOP ' . $limit . ' * FROM (' . $query . ') AS inner_tbl';
+        if ($orderby !== false) {
+            $query .= ' ORDER BY ' . $order . ' ';
+            $query .= (stripos($sort, 'asc') !== false) ? 'DESC' : 'ASC';
+        }
+        $query .= ') AS outer_tbl';
+        if ($orderby !== false) {
+            $query .= ' ORDER BY ' . $order . ' ' . $sort;
+        }
 
         return $query;
     }
 
-
     /**
-     * Returns PDO DSN string from DSN array (parse_dsn() result)
+     * Returns PDO DSN string from DSN array
      */
     protected function dsn_string($dsn)
     {
diff --git a/program/include/rcube_db_mysql.php b/program/include/rcube_db_mysql.php
index 3eeee2ada..84a324701 100644
--- a/program/include/rcube_db_mysql.php
+++ b/program/include/rcube_db_mysql.php
@@ -31,6 +31,9 @@
  */
 class rcube_db_mysql extends rcube_db
 {
+    /**
+     * Driver initialization/configuration
+     */
     protected function init()
     {
         // SQL identifiers quoting
@@ -38,7 +41,6 @@ class rcube_db_mysql extends rcube_db
         $this->options['identifier_end'] = '`';
     }
 
-
     /**
      * Abstract SQL statement for value concatenation
      *
@@ -55,9 +57,8 @@ class rcube_db_mysql extends rcube_db
         return 'CONCAT(' . join(', ', $args) . ')';
     }
 
-
     /**
-     * Returns PDO DSN string from DSN array (parse_dsn() result)
+     * Returns PDO DSN string from DSN array
      */
     protected function dsn_string($dsn)
     {
diff --git a/program/include/rcube_db_pgsql.php b/program/include/rcube_db_pgsql.php
index 63bd92b40..641b884d6 100644
--- a/program/include/rcube_db_pgsql.php
+++ b/program/include/rcube_db_pgsql.php
@@ -31,7 +31,6 @@
  */
 class rcube_db_pgsql extends rcube_db
 {
-
     /**
      * Get last inserted record ID
      * For Postgres databases, a table name is required
@@ -55,7 +54,6 @@ class rcube_db_pgsql extends rcube_db
         return $id;
     }
 
-
     /**
      * Return SQL statement to convert a field value into a unix timestamp
      *
@@ -72,7 +70,6 @@ class rcube_db_pgsql extends rcube_db
         return "EXTRACT (EPOCH FROM $field)";
     }
 
-
     /**
      * Return SQL statement for case insensitive LIKE
      *
diff --git a/program/include/rcube_db_sqlite.php b/program/include/rcube_db_sqlite.php
index fe6b0dca9..1fcecd6da 100644
--- a/program/include/rcube_db_sqlite.php
+++ b/program/include/rcube_db_sqlite.php
@@ -31,11 +31,16 @@
  */
 class rcube_db_sqlite extends rcube_db
 {
-
+    /**
+     * Database character set
+     */
     protected function set_charset($charset)
     {
     }
 
+    /**
+     * Prepare connection
+     */
     protected function conn_prepare($dsn)
     {
         // Create database file, required by PDO to exist on connection
@@ -44,6 +49,9 @@ class rcube_db_sqlite extends rcube_db
         }
     }
 
+    /**
+     * Configure connection, create database if not exists
+     */
     protected function conn_configure($dsn, $dbh)
     {
         // we emulate via callback some missing functions
@@ -74,7 +82,6 @@ class rcube_db_sqlite extends rcube_db
         }
     }
 
-
     /**
      * Callback for sqlite: unix_timestamp()
      */
@@ -94,7 +101,6 @@ class rcube_db_sqlite extends rcube_db
         return $ret;
     }
 
-
     /**
      * Callback for sqlite: now()
      */
@@ -103,7 +109,6 @@ class rcube_db_sqlite extends rcube_db
         return date("Y-m-d H:i:s");
     }
 
-
     /**
      * Returns list of tables in database
      *
@@ -126,7 +131,6 @@ class rcube_db_sqlite extends rcube_db
         return $this->tables;
     }
 
-
     /**
      * Returns list of columns in database table
      *
@@ -161,7 +165,9 @@ class rcube_db_sqlite extends rcube_db
         return $columns;
     }
 
-
+    /**
+     * Build DSN string for PDO constructor
+     */
     protected function dsn_string($dsn)
     {
         return $dsn['phptype'] . ':' . $dsn['database'];
diff --git a/program/include/rcube_db_sqlsrv.php b/program/include/rcube_db_sqlsrv.php
index 4ea7e7318..143e02038 100644
--- a/program/include/rcube_db_sqlsrv.php
+++ b/program/include/rcube_db_sqlsrv.php
@@ -31,17 +31,23 @@
  */
 class rcube_db_sqlsrv extends rcube_db
 {
+    /**
+     * Driver initialization
+     */
     protected function init()
     {
         $this->options['identifier_start'] = '[';
         $this->options['identifier_end'] = ']';
     }
 
+    /**
+     * Database character set setting
+     */
     protected function set_charset($charset)
     {
+        // UTF-8 is default
     }
 
-
     /**
      * Return SQL function for current time and date
      *
@@ -52,7 +58,6 @@ class rcube_db_sqlsrv extends rcube_db
         return "getdate()";
     }
 
-
     /**
      * Return SQL statement to convert a field value into a unix timestamp
      *
@@ -69,7 +74,6 @@ class rcube_db_sqlsrv extends rcube_db
         return "DATEDIFF(second, '19700101', $field) + DATEDIFF(second, GETDATE(), GETUTCDATE())";
     }
 
-
     /**
      * Abstract SQL statement for value concatenation
      *
@@ -86,10 +90,14 @@ class rcube_db_sqlsrv extends rcube_db
         return '(' . join('+', $args) . ')';
     }
 
-
     /**
      * Adds TOP (LIMIT,OFFSET) clause to the query
      *
+     * @param string $query   SQL query
+     * @param int    $limit   Number of rows
+     * @param int    $offset  Offset
+     *
+     * @return string SQL query
      */
     protected function set_limit($query, $limit = 0, $offset = 0)
     {
@@ -119,7 +127,7 @@ class rcube_db_sqlsrv extends rcube_db
     }
 
     /**
-     * Returns PDO DSN string from DSN array (parse_dsn() result)
+     * Returns PDO DSN string from DSN array
      */
     protected function dsn_string($dsn)
     {
-- 
cgit v1.2.3


From c389a85978bc5cf8f0f9d06c58664a35c4746447 Mon Sep 17 00:00:00 2001
From: Aleksander Machniak <alec@alec.pl>
Date: Sun, 8 Jul 2012 10:32:13 +0200
Subject: Add get_variable() implementation

---
 program/include/rcube_db.php       | 17 ++++++++++++++++-
 program/include/rcube_db_mysql.php | 23 +++++++++++++++++++++++
 program/include/rcube_db_pgsql.php | 37 +++++++++++++++++++++++++++++++++----
 3 files changed, 72 insertions(+), 5 deletions(-)

(limited to 'program/include/rcube_db_pgsql.php')

diff --git a/program/include/rcube_db.php b/program/include/rcube_db.php
index ba7b96c9d..b1cbd8505 100644
--- a/program/include/rcube_db.php
+++ b/program/include/rcube_db.php
@@ -42,6 +42,7 @@ class rcube_db
     protected $a_query_results = array('dummy');
     protected $last_res_id = 0;
     protected $tables;
+    protected $variables;
     protected $db_index = 0;
 
     protected $options = array(
@@ -279,6 +280,20 @@ class rcube_db
       return !empty($this->db_dsnr) && $this->db_dsnw != $this->db_dsnr;
     }
 
+    /**
+     * Get database runtime variables
+     *
+     * @param string $varname  Variable name
+     * @param mixed  $default  Default value if variable is not set
+     *
+     * @return mixed Variable value or default
+     */
+    public function get_variable($varname, $default = null)
+    {
+        // to be implemented by driver class
+        return $default;
+    }
+
     /**
      * Execute a SQL query
      *
@@ -332,7 +347,7 @@ class rcube_db
     protected function _query($query, $offset, $numrows, $params)
     {
         // Read or write ?
-        $mode = preg_match('/^select/i', ltrim($query)) ? 'r' : 'w';
+        $mode = preg_match('/^(select|show)/i', ltrim($query)) ? 'r' : 'w';
 
         $this->db_connect($mode);
 
diff --git a/program/include/rcube_db_mysql.php b/program/include/rcube_db_mysql.php
index 84a324701..71f81956a 100644
--- a/program/include/rcube_db_mysql.php
+++ b/program/include/rcube_db_mysql.php
@@ -90,4 +90,27 @@ class rcube_db_mysql extends rcube_db
         return $result;
     }
 
+    /**
+     * Get database runtime variables
+     *
+     * @param string $varname  Variable name
+     * @param mixed  $default  Default value if variable is not set
+     *
+     * @return mixed Variable value or default
+     */
+    public function get_variable($varname, $default = null)
+    {
+        if (!isset($this->variables)) {
+            $this->variables = array();
+
+            $result = $this->query('SHOW VARIABLES');
+
+            while ($sql_arr = $this->fetch_array($result)) {
+                $this->variables[$row[0]] = $row[1];
+            }
+        }
+
+        return isset($this->variables[$varname]) ? $this->variables[$varname] : $default;
+    }
+
 }
diff --git a/program/include/rcube_db_pgsql.php b/program/include/rcube_db_pgsql.php
index 641b884d6..d357d88ce 100644
--- a/program/include/rcube_db_pgsql.php
+++ b/program/include/rcube_db_pgsql.php
@@ -1,6 +1,6 @@
 <?php
 
-/*
+/**
  +-----------------------------------------------------------------------+
  | program/include/rcube_db_pgsql.php                                    |
  |                                                                       |
@@ -26,8 +26,8 @@
  *
  * This is a wrapper for the PHP PDO
  *
- * @package    Database
- * @version    1.0
+ * @package Database
+ * @version 1.0
  */
 class rcube_db_pgsql extends rcube_db
 {
@@ -80,7 +80,36 @@ class rcube_db_pgsql extends rcube_db
      */
     public function ilike($column, $value)
     {
-        return $this->quote_identifier($column).' ILIKE '.$this->quote($value);
+        return $this->quote_identifier($column) . ' ILIKE ' . $this->quote($value);
+    }
+
+    /**
+     * Get database runtime variables
+     *
+     * @param string $varname  Variable name
+     * @param mixed  $default  Default value if variable is not set
+     *
+     * @return mixed Variable value or default
+     */
+    public function get_variable($varname, $default = null)
+    {
+        // There's a known case when max_allowed_packet is queried
+        // PostgreSQL doesn't have such limit, return immediately
+        if ($varname == 'max_allowed_packet') {
+            return $default;
+        }
+
+        if (!isset($this->variables)) {
+            $this->variables = array();
+
+            $result = $this->query('SHOW ALL');
+
+            while ($row = $this->fetch_array($result)) {
+                $this->variables[$row[0]] = $row[1];
+            }
+        }
+
+        return isset($this->variables[$varname]) ? $this->variables[$varname] : $default;
     }
 
 }
-- 
cgit v1.2.3


From 3d231c88fa299787fe52e00773d03a4efa51590d Mon Sep 17 00:00:00 2001
From: Aleksander Machniak <alec@alec.pl>
Date: Sun, 8 Jul 2012 10:58:11 +0200
Subject: CS fixes

---
 program/include/rcube_db.php        | 186 +++++++++++++++++++-----------------
 program/include/rcube_db_mssql.php  |  16 ++--
 program/include/rcube_db_mysql.php  |  10 +-
 program/include/rcube_db_pgsql.php  |  18 ++--
 program/include/rcube_db_sqlite.php |   8 +-
 program/include/rcube_db_sqlsrv.php |  16 ++--
 6 files changed, 131 insertions(+), 123 deletions(-)

(limited to 'program/include/rcube_db_pgsql.php')

diff --git a/program/include/rcube_db.php b/program/include/rcube_db.php
index b1cbd8505..f24e95913 100644
--- a/program/include/rcube_db.php
+++ b/program/include/rcube_db.php
@@ -1,6 +1,6 @@
 <?php
 
-/*
+/**
  +-----------------------------------------------------------------------+
  | program/include/rcube_db.php                                          |
  |                                                                       |
@@ -25,8 +25,8 @@
  *
  * This is a wrapper for the PHP PDO
  *
- * @package    Database
- * @version    1.0
+ * @package Database
+ * @version 1.0
  */
 class rcube_db
 {
@@ -36,14 +36,14 @@ class rcube_db
     protected $db_mode;               // Connection mode
     protected $dbh;                   // Connection handle
 
-    protected $db_error = false;
-    protected $db_error_msg = '';
-    protected $conn_failure = false;
+    protected $db_error        = false;
+    protected $db_error_msg    = '';
+    protected $conn_failure    = false;
     protected $a_query_results = array('dummy');
-    protected $last_res_id = 0;
+    protected $last_res_id     = 0;
+    protected $db_index        = 0;
     protected $tables;
     protected $variables;
-    protected $db_index = 0;
 
     protected $options = array(
         // column/table quotes
@@ -55,11 +55,11 @@ class rcube_db
     /**
      * Factory, returns driver-specific instance of the class
      *
-     * @param string $db_dsnw  DSN for read/write operations
-     * @param string $db_dsnr  Optional DSN for read only operations
-     * @param bool   $pconn    Enables persistent connections
+     * @param string $db_dsnw DSN for read/write operations
+     * @param string $db_dsnr Optional DSN for read only operations
+     * @param bool   $pconn   Enables persistent connections
      *
-     * @return rcube_db  Object instance
+     * @return rcube_db Object instance
      */
     public static function factory($db_dsnw, $db_dsnr = '', $pconn = false)
     {
@@ -87,9 +87,9 @@ class rcube_db
     /**
      * Object constructor
      *
-     * @param  string $db_dsnw  DSN for read/write operations
-     * @param  string $db_dsnr  Optional DSN for read only operations
-     * @param  bool   $pconn    Enables persistent connections
+     * @param string $db_dsnw DSN for read/write operations
+     * @param string $db_dsnr Optional DSN for read only operations
+     * @param bool   $pconn   Enables persistent connections
      */
     public function __construct($db_dsnw, $db_dsnr = '', $pconn = false)
     {
@@ -119,7 +119,7 @@ class rcube_db
     /**
      * Connect to specific database
      *
-     * @param  array $dsn  DSN for DB connections
+     * @param array $dsn DSN for DB connections
      *
      * @return PDO database handle
      */
@@ -169,7 +169,7 @@ class rcube_db
     /**
      * Driver-specific preparation of database connection
      *
-     * @param  array $dsn  DSN for DB connections
+     * @param array $dsn DSN for DB connections
      */
     protected function conn_prepare($dsn)
     {
@@ -178,8 +178,8 @@ class rcube_db
     /**
      * Driver-specific configuration of database connection
      *
-     * @param  array $dsn  DSN for DB connections
-     * @param  PDO   $dbh  Connection handler
+     * @param array $dsn DSN for DB connections
+     * @param PDO   $dbh Connection handler
      */
     protected function conn_configure($dsn, $dbh)
     {
@@ -188,7 +188,7 @@ class rcube_db
     /**
      * Driver-specific database character set setting
      *
-     * @param  string $charset  Character set name
+     * @param string $charset Character set name
      */
     protected function set_charset($charset)
     {
@@ -198,7 +198,7 @@ class rcube_db
     /**
      * Connect to appropiate database depending on the operation
      *
-     * @param  string $mode Connection mode (r|w)
+     * @param string $mode Connection mode (r|w)
      */
     public function db_connect($mode)
     {
@@ -254,7 +254,7 @@ class rcube_db
     /**
      * Getter for error state
      *
-     * @param  boolean  True on error
+     * @return boolean True on error
      */
     public function is_error()
     {
@@ -264,7 +264,7 @@ class rcube_db
     /**
      * Connection state checker
      *
-     * @param  boolean  True if in connected state
+     * @return boolean True if in connected state
      */
     public function is_connected()
     {
@@ -273,7 +273,8 @@ class rcube_db
 
     /**
      * Is database replication configured?
-     * This returns true if dsnw != dsnr
+     *
+     * @return bool Returns true if dsnw != dsnr
      */
     public function is_replicated()
     {
@@ -283,8 +284,8 @@ class rcube_db
     /**
      * Get database runtime variables
      *
-     * @param string $varname  Variable name
-     * @param mixed  $default  Default value if variable is not set
+     * @param string $varname Variable name
+     * @param mixed  $default Default value if variable is not set
      *
      * @return mixed Variable value or default
      */
@@ -297,8 +298,8 @@ class rcube_db
     /**
      * Execute a SQL query
      *
-     * @param  string  SQL query to execute
-     * @param  mixed   Values to be inserted in query
+     * @param string SQL query to execute
+     * @param mixed  Values to be inserted in query
      *
      * @return number  Query handle identifier
      */
@@ -318,12 +319,12 @@ class rcube_db
     /**
      * 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
+     * @param string SQL query to execute
+     * @param int    Offset for LIMIT statement
+     * @param int    Number of rows for LIMIT statement
+     * @param mixed  Values to be inserted in query
      *
-     * @return number  Query handle identifier
+     * @return int Query handle identifier
      */
     public function limitquery()
     {
@@ -338,11 +339,12 @@ class rcube_db
     /**
      * 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
+     * @param string $query   SQL query to execute
+     * @param int    $offset  Offset for LIMIT statement
+     * @param int    $numrows Number of rows for LIMIT statement
+     * @param array  $params  Values to be inserted in query
+     *
+     * @return int Query handle identifier
      */
     protected function _query($query, $offset, $numrows, $params)
     {
@@ -400,7 +402,8 @@ class rcube_db
      * 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
+     *
+     * @return int Number of rows or false on failure
      */
     public function affected_rows($res_id = null)
     {
@@ -415,9 +418,9 @@ class rcube_db
      * Get last inserted record ID
      * For Postgres databases, a sequence name is required
      *
-     * @param  string $table  Table name (to find the incremented sequence)
+     * @param string $table Table name (to find the incremented sequence)
      *
-     * @return mixed   ID or false on failure
+     * @return mixed ID or false on failure
      */
     public function insert_id($table = '')
     {
@@ -439,9 +442,9 @@ class rcube_db
      * 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
+     * @param int $res_id Optional query handle identifier
      *
-     * @return mixed   Array with col values or false on failure
+     * @return mixed Array with col values or false on failure
      */
     public function fetch_assoc($res_id = null)
     {
@@ -453,9 +456,9 @@ class rcube_db
      * 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
+     * @param int $res_id Optional query handle identifier
      *
-     * @return mixed   Array with col values or false on failure
+     * @return mixed Array with col values or false on failure
      */
     public function fetch_array($res_id = null)
     {
@@ -466,10 +469,10 @@ class rcube_db
     /**
      * Get col values for a result row
      *
-     * @param  PDOStatement $result Result handle
-     * @param  number       $mode   Fetch mode identifier
+     * @param PDOStatement $result Result handle
+     * @param int          $mode   Fetch mode identifier
      *
-     * @return mixed  Array with col values or false on failure
+     * @return mixed Array with col values or false on failure
      */
     protected function _fetch_row($result, $mode)
     {
@@ -483,9 +486,9 @@ class rcube_db
     /**
      * Adds LIMIT,OFFSET clauses to the query
      *
-     * @param string $query   SQL query
-     * @param int    $limit   Number of rows
-     * @param int    $offset  Offset
+     * @param string $query  SQL query
+     * @param int    $limit  Number of rows
+     * @param int    $offset Offset
      *
      * @return string SQL query
      */
@@ -527,7 +530,7 @@ class rcube_db
     /**
      * Returns list of columns in database table
      *
-     * @param string Table name
+     * @param string $table Table name
      *
      * @return array List of table cols
      */
@@ -546,10 +549,10 @@ class rcube_db
     /**
      * Formats input so it can be safely used in a query
      *
-     * @param  mixed  $input  Value to quote
-     * @param  string $type   Type of data
+     * @param mixed  $input Value to quote
+     * @param string $type  Type of data
      *
-     * @return string  Quoted/converted string for use in query
+     * @return string Quoted/converted string for use in query
      */
     public function quote($input, $type = null)
     {
@@ -578,11 +581,11 @@ class rcube_db
     /**
      * Quotes a string so it can be safely used as a table or column name
      *
-     * @param  string $str Value to quote
+     * @param string $str Value to quote
      *
-     * @return string  Quoted string for use in query
-     * @deprecated     Replaced by rcube_db::quote_identifier
-     * @see            rcube_db::quote_identifier
+     * @return string Quoted string for use in query
+     * @deprecated    Replaced by rcube_db::quote_identifier
+     * @see           rcube_db::quote_identifier
      */
     public function quoteIdentifier($str)
     {
@@ -592,9 +595,9 @@ class rcube_db
     /**
      * Quotes a string so it can be safely used as a table or column name
      *
-     * @param  string $str Value to quote
+     * @param string $str Value to quote
      *
-     * @return string  Quoted string for use in query
+     * @return string Quoted string for use in query
      */
     public function quote_identifier($str)
     {
@@ -623,8 +626,8 @@ class rcube_db
     /**
      * Return list of elements for use with SQL's IN clause
      *
-     * @param  array  $arr  Input array
-     * @param  string $type Type of data
+     * @param array  $arr  Input array
+     * @param string $type Type of data
      *
      * @return string Comma-separated list of quoted values for use in query
      */
@@ -647,7 +650,7 @@ class rcube_db
      * 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
+     * @param string $field Field name
      *
      * @return string  SQL statement to use in query
      * @deprecated
@@ -660,9 +663,9 @@ class rcube_db
     /**
      * Return SQL statement to convert from a unix timestamp
      *
-     * @param  string $timestamp Field name
+     * @param int $timestamp Unix timestamp
      *
-     * @return string  SQL statement to use in query
+     * @return string Date string in db-specific format
      */
     public function fromunixtime($timestamp)
     {
@@ -672,10 +675,10 @@ class rcube_db
     /**
      * Return SQL statement for case insensitive LIKE
      *
-     * @param  string $column  Field name
-     * @param  string $value   Search value
+     * @param string $column Field name
+     * @param string $value  Search value
      *
-     * @return string  SQL statement to use in query
+     * @return string SQL statement to use in query
      */
     public function ilike($column, $value)
     {
@@ -700,9 +703,9 @@ class rcube_db
     /**
      * Encodes non-UTF-8 characters in string/array/object (recursive)
      *
-     * @param  mixed  $input Data to fix
+     * @param mixed $input Data to fix
      *
-     * @return mixed  Properly UTF-8 encoded data
+     * @return mixed Properly UTF-8 encoded data
      */
     public static function encode($input)
     {
@@ -725,9 +728,9 @@ class rcube_db
     /**
      * Decodes encoded UTF-8 string/object/array (recursive)
      *
-     * @param  mixed $input Input data
+     * @param mixed $input Input data
      *
-     * @return mixed  Decoded data
+     * @return mixed Decoded data
      */
     public static function decode($input)
     {
@@ -750,26 +753,25 @@ class rcube_db
     /**
      * Adds a query result and returns a handle ID
      *
-     * @param  object $res Query handle
+     * @param object $res Query handle
      *
-     * @return mixed   Handle ID
+     * @return int Handle ID
      */
     protected function _add_result($res)
     {
-        $res_id = sizeof($this->a_query_results);
-        $this->last_res_id = $res_id;
-        $this->a_query_results[$res_id] = $res;
+        $this->last_res_id = sizeof($this->a_query_results);
+        $this->a_query_results[$this->last_res_id] = $res;
 
-        return $res_id;
+        return $this->last_res_id;
     }
 
     /**
      * 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
+     * @param int $res_id Handle ID
      *
-     * @return mixed   Resource handle or false on failure
+     * @return mixed Resource handle or false on failure
      */
     protected function _get_result($res_id = null)
     {
@@ -844,7 +846,8 @@ class rcube_db
         if (($pos = strpos($dsn, '://')) !== false) {
             $str = substr($dsn, 0, $pos);
             $dsn = substr($dsn, $pos + 3);
-        } else {
+        }
+        else {
             $str = $dsn;
             $dsn = null;
         }
@@ -854,7 +857,8 @@ class rcube_db
         if (preg_match('|^(.+?)\((.*?)\)$|', $str, $arr)) {
             $parsed['phptype']  = $arr[1];
             $parsed['dbsyntax'] = !$arr[2] ? $arr[1] : $arr[2];
-        } else {
+        }
+        else {
             $parsed['phptype']  = $str;
             $parsed['dbsyntax'] = $str;
         }
@@ -871,7 +875,8 @@ class rcube_db
             if (($pos = strpos($str, ':')) !== false) {
                 $parsed['username'] = rawurldecode(substr($str, 0, $pos));
                 $parsed['password'] = rawurldecode(substr($str, $pos + 1));
-            } else {
+            }
+            else {
                 $parsed['username'] = rawurldecode($str);
             }
         }
@@ -900,9 +905,11 @@ class rcube_db
                 $pos = strrpos($proto_opts, '/');
                 $dsn = substr($proto_opts, $pos + 1);
                 $proto_opts = substr($proto_opts, 0, $pos);
-            } elseif (strpos($dsn, '/') !== false) {
+            }
+            else if (strpos($dsn, '/') !== false) {
                 list($proto_opts, $dsn) = explode('/', $dsn, 2);
-            } else {
+            }
+            else {
                 $proto_opts = $dsn;
                 $dsn = null;
             }
@@ -934,7 +941,8 @@ class rcube_db
                 $dsn = substr($dsn, $pos + 1);
                 if (strpos($dsn, '&') !== false) {
                     $opts = explode('&', $dsn);
-                } else { // database?param1=value1
+                }
+                else { // database?param1=value1
                     $opts = array($dsn);
                 }
                 foreach ($opts as $opt) {
@@ -953,7 +961,7 @@ class rcube_db
     /**
      * Returns PDO DSN string from DSN array
      *
-     * @param array $dsn  DSN parameters
+     * @param array $dsn DSN parameters
      *
      * @return string DSN string
      */
@@ -984,7 +992,7 @@ class rcube_db
     /**
      * Returns driver-specific connection options
      *
-     * @param array  $dsn  DSN parameters
+     * @param array $dsn DSN parameters
      *
      * @return array Connection options
      */
diff --git a/program/include/rcube_db_mssql.php b/program/include/rcube_db_mssql.php
index 3a64c3b1d..5cbcfab36 100644
--- a/program/include/rcube_db_mssql.php
+++ b/program/include/rcube_db_mssql.php
@@ -1,6 +1,6 @@
 <?php
 
-/*
+/**
  +-----------------------------------------------------------------------+
  | program/include/rcube_db_mssql.php                                    |
  |                                                                       |
@@ -26,8 +26,8 @@
  *
  * This is a wrapper for the PHP PDO
  *
- * @package    Database
- * @version    1.0
+ * @package Database
+ * @version 1.0
  */
 class rcube_db_mssql extends rcube_db
 {
@@ -64,9 +64,9 @@ class rcube_db_mssql extends rcube_db
      * 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
+     * @param string $field Field name
      *
-     * @return string  SQL statement to use in query
+     * @return string SQL statement to use in query
      * @deprecated
      */
     public function unixtimestamp($field)
@@ -93,9 +93,9 @@ class rcube_db_mssql extends rcube_db
     /**
      * Adds TOP (LIMIT,OFFSET) clause to the query
      *
-     * @param string $query   SQL query
-     * @param int    $limit   Number of rows
-     * @param int    $offset  Offset
+     * @param string $query  SQL query
+     * @param int    $limit  Number of rows
+     * @param int    $offset Offset
      *
      * @return string SQL query
      */
diff --git a/program/include/rcube_db_mysql.php b/program/include/rcube_db_mysql.php
index 71f81956a..38b15fa42 100644
--- a/program/include/rcube_db_mysql.php
+++ b/program/include/rcube_db_mysql.php
@@ -1,6 +1,6 @@
 <?php
 
-/*
+/**
  +-----------------------------------------------------------------------+
  | program/include/rcube_db_mysql.php                                    |
  |                                                                       |
@@ -26,8 +26,8 @@
  *
  * This is a wrapper for the PHP PDO
  *
- * @package    Database
- * @version    1.0
+ * @package Database
+ * @version 1.0
  */
 class rcube_db_mysql extends rcube_db
 {
@@ -93,8 +93,8 @@ class rcube_db_mysql extends rcube_db
     /**
      * Get database runtime variables
      *
-     * @param string $varname  Variable name
-     * @param mixed  $default  Default value if variable is not set
+     * @param string $varname Variable name
+     * @param mixed  $default Default value if variable is not set
      *
      * @return mixed Variable value or default
      */
diff --git a/program/include/rcube_db_pgsql.php b/program/include/rcube_db_pgsql.php
index d357d88ce..782fc0ebb 100644
--- a/program/include/rcube_db_pgsql.php
+++ b/program/include/rcube_db_pgsql.php
@@ -35,9 +35,9 @@ class rcube_db_pgsql extends rcube_db
      * Get last inserted record ID
      * For Postgres databases, a table name is required
      *
-     * @param  string $table  Table name (to find the incremented sequence)
+     * @param string $table Table name (to find the incremented sequence)
      *
-     * @return mixed   ID or false on failure
+     * @return mixed ID or false on failure
      */
     public function insert_id($table = '')
     {
@@ -60,9 +60,9 @@ class rcube_db_pgsql extends rcube_db
      * 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
+     * @param string $field Field name
      *
-     * @return string  SQL statement to use in query
+     * @return string SQL statement to use in query
      * @deprecated
      */
     public function unixtimestamp($field)
@@ -73,10 +73,10 @@ class rcube_db_pgsql extends rcube_db
     /**
      * Return SQL statement for case insensitive LIKE
      *
-     * @param  string $column  Field name
-     * @param  string $value   Search value
+     * @param string $column Field name
+     * @param string $value  Search value
      *
-     * @return string  SQL statement to use in query
+     * @return string SQL statement to use in query
      */
     public function ilike($column, $value)
     {
@@ -86,8 +86,8 @@ class rcube_db_pgsql extends rcube_db
     /**
      * Get database runtime variables
      *
-     * @param string $varname  Variable name
-     * @param mixed  $default  Default value if variable is not set
+     * @param string $varname Variable name
+     * @param mixed  $default Default value if variable is not set
      *
      * @return mixed Variable value or default
      */
diff --git a/program/include/rcube_db_sqlite.php b/program/include/rcube_db_sqlite.php
index 1fcecd6da..0b41ef551 100644
--- a/program/include/rcube_db_sqlite.php
+++ b/program/include/rcube_db_sqlite.php
@@ -1,6 +1,6 @@
 <?php
 
-/*
+/**
  +-----------------------------------------------------------------------+
  | program/include/rcube_db_sqlite.php                                   |
  |                                                                       |
@@ -26,8 +26,8 @@
  *
  * This is a wrapper for the PHP PDO
  *
- * @package    Database
- * @version    1.0
+ * @package Database
+ * @version 1.0
  */
 class rcube_db_sqlite extends rcube_db
 {
@@ -134,7 +134,7 @@ class rcube_db_sqlite extends rcube_db
     /**
      * Returns list of columns in database table
      *
-     * @param string Table name
+     * @param string $table Table name
      *
      * @return array List of table cols
      */
diff --git a/program/include/rcube_db_sqlsrv.php b/program/include/rcube_db_sqlsrv.php
index 143e02038..feddbe73f 100644
--- a/program/include/rcube_db_sqlsrv.php
+++ b/program/include/rcube_db_sqlsrv.php
@@ -1,6 +1,6 @@
 <?php
 
-/*
+/**
  +-----------------------------------------------------------------------+
  | program/include/rcube_db_sqlsrv.php                                   |
  |                                                                       |
@@ -26,8 +26,8 @@
  *
  * This is a wrapper for the PHP PDO
  *
- * @package    Database
- * @version    1.0
+ * @package Database
+ * @version 1.0
  */
 class rcube_db_sqlsrv extends rcube_db
 {
@@ -64,9 +64,9 @@ class rcube_db_sqlsrv extends rcube_db
      * 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
+     * @param string $field Field name
      *
-     * @return string  SQL statement to use in query
+     * @return string SQL statement to use in query
      * @deprecated
      */
     public function unixtimestamp($field)
@@ -93,9 +93,9 @@ class rcube_db_sqlsrv extends rcube_db
     /**
      * Adds TOP (LIMIT,OFFSET) clause to the query
      *
-     * @param string $query   SQL query
-     * @param int    $limit   Number of rows
-     * @param int    $offset  Offset
+     * @param string $query  SQL query
+     * @param int    $limit  Number of rows
+     * @param int    $offset Offset
      *
      * @return string SQL query
      */
-- 
cgit v1.2.3


From 8e926e6201dbd8876ed26c9a4b3af5d7079d6247 Mon Sep 17 00:00:00 2001
From: Aleksander Machniak <alec@alec.pl>
Date: Sun, 8 Jul 2012 11:10:28 +0200
Subject: Move sequence_name() method into postgres driver class

---
 program/include/rcube_db.php       | 23 -----------------------
 program/include/rcube_db_pgsql.php | 24 ++++++++++++++++++++++--
 2 files changed, 22 insertions(+), 25 deletions(-)

(limited to 'program/include/rcube_db_pgsql.php')

diff --git a/program/include/rcube_db.php b/program/include/rcube_db.php
index f24e95913..31385d860 100644
--- a/program/include/rcube_db.php
+++ b/program/include/rcube_db.php
@@ -416,7 +416,6 @@ class rcube_db
 
     /**
      * Get last inserted record ID
-     * For Postgres databases, a sequence name is required
      *
      * @param string $table Table name (to find the incremented sequence)
      *
@@ -807,28 +806,6 @@ class rcube_db
         return $table;
     }
 
-    /**
-     * Return correct name for a specific database sequence
-     * (used for Postgres only)
-     *
-     * @param string $sequence Secuence name
-     *
-     * @return string Translated sequence name
-     */
-    public function sequence_name($sequence)
-    {
-        $rcube = rcube::get_instance();
-
-        // return sequence name if configured
-        $config_key = 'db_sequence_'.$sequence;
-
-        if ($name = $rcube->config->get($config_key)) {
-            return $name;
-        }
-
-        return $sequence;
-    }
-
     /**
      * MDB2 DSN string parser
      *
diff --git a/program/include/rcube_db_pgsql.php b/program/include/rcube_db_pgsql.php
index 782fc0ebb..285b8e2d4 100644
--- a/program/include/rcube_db_pgsql.php
+++ b/program/include/rcube_db_pgsql.php
@@ -33,13 +33,12 @@ class rcube_db_pgsql extends rcube_db
 {
     /**
      * Get last inserted record ID
-     * For Postgres databases, a table name is required
      *
      * @param string $table Table name (to find the incremented sequence)
      *
      * @return mixed ID or false on failure
      */
-    public function insert_id($table = '')
+    public function insert_id($table = null)
     {
         if (!$this->db_connected || $this->db_mode == 'r') {
             return false;
@@ -54,6 +53,27 @@ class rcube_db_pgsql extends rcube_db
         return $id;
     }
 
+    /**
+     * Return correct name for a specific database sequence
+     *
+     * @param string $sequence Secuence name
+     *
+     * @return string Translated sequence name
+     */
+    protected function sequence_name($sequence)
+    {
+        $rcube = rcube::get_instance();
+
+        // return sequence name if configured
+        $config_key = 'db_sequence_'.$sequence;
+
+        if ($name = $rcube->config->get($config_key)) {
+            return $name;
+        }
+
+        return $sequence;
+    }
+
     /**
      * Return SQL statement to convert a field value into a unix timestamp
      *
-- 
cgit v1.2.3