9 files changed, 390 insertions, 334 deletions
diff --git a/phpBB/includes/db/driver/driver.php b/phpBB/includes/db/driver/driver.php
index 8dda94bc2c..b915ee081b 100644
--- a/phpBB/includes/db/driver/driver.php
+++ b/phpBB/includes/db/driver/driver.php
@@ -568,12 +568,12 @@ class phpbb_db_driver
 	* Run more than one insert statement.
 	*
 	* @param string $table table name to run the statements on
-	* @param array &$sql_ary multi-dimensional array holding the statement data.
+	* @param array $sql_ary multi-dimensional array holding the statement data.
 	*
 	* @return bool false if no statements were executed.
 	* @access public
 	*/
-	function sql_multi_insert($table, &$sql_ary)
+	function sql_multi_insert($table, $sql_ary)
 	{
 		if (!sizeof($sql_ary))
 		{
diff --git a/phpBB/includes/db/driver/mssql_base.php b/phpBB/includes/db/driver/mssql_base.php
new file mode 100644
index 0000000000..56c111c871
--- /dev/null
+++ b/phpBB/includes/db/driver/mssql_base.php
@@ -0,0 +1,65 @@
+<?php
+/**
+*
+* @package dbal
+* @copyright (c) 2013 phpBB Group
+* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
+*
+*/
+
+/**
+* @ignore
+*/
+if (!defined('IN_PHPBB'))
+{
+	exit;
+}
+
+/**
+* MSSQL Database Base Abstraction Layer
+* @package dbal
+ */
+abstract class phpbb_db_driver_mssql_base extends phpbb_db_driver
+{
+	/**
+	* {@inheritDoc}
+	*/
+	public function sql_concatenate($expr1, $expr2)
+	{
+		return $expr1 . ' + ' . $expr2;
+	}
+
+	/**
+	* Escape string used in sql query
+	*/
+	function sql_escape($msg)
+	{
+		return str_replace(array("'", "\0"), array("''", ''), $msg);
+	}
+
+	/**
+	* {@inheritDoc}
+	*/
+	function sql_lower_text($column_name)
+	{
+		return "LOWER(SUBSTRING($column_name, 1, DATALENGTH($column_name)))";
+	}
+
+	/**
+	* Build LIKE expression
+	* @access private
+	*/
+	function _sql_like_expression($expression)
+	{
+		return $expression . " ESCAPE '\\'";
+	}
+
+	/**
+	* Build db-specific query data
+	* @access private
+	*/
+	function _sql_custom_build($stage, $data)
+	{
+		return $data;
+	}
+}
diff --git a/phpBB/includes/db/driver/mssql_odbc.php b/phpBB/includes/db/driver/mssql_odbc.php
index f7834443eb..cde9d332ba 100644
--- a/phpBB/includes/db/driver/mssql_odbc.php
+++ b/phpBB/includes/db/driver/mssql_odbc.php
@@ -26,7 +26,7 @@ if (!defined('IN_PHPBB'))
 *
 * @package dbal
 */
-class phpbb_db_driver_mssql_odbc extends phpbb_db_driver
+class phpbb_db_driver_mssql_odbc extends phpbb_db_driver_mssql_base
 {
 	var $last_query_text = '';
 	var $connect_error = '';
@@ -126,14 +126,6 @@ class phpbb_db_driver_mssql_odbc extends phpbb_db_driver
 	}
 
 	/**
-	* {@inheritDoc}
-	*/
-	public function sql_concatenate($expr1, $expr2)
-	{
-		return $expr1 . ' + ' . $expr2;
-	}
-
-	/**
 	* SQL Transaction
 	* @access private
 	*/
@@ -326,40 +318,6 @@ class phpbb_db_driver_mssql_odbc extends phpbb_db_driver
 	}
 
 	/**
-	* Escape string used in sql query
-	*/
-	function sql_escape($msg)
-	{
-		return str_replace(array("'", "\0"), array("''", ''), $msg);
-	}
-
-	/**
-	* {@inheritDoc}
-	*/
-	function sql_lower_text($column_name)
-	{
-		return "LOWER(SUBSTRING($column_name, 1, DATALENGTH($column_name)))";
-	}
-
-	/**
-	* Build LIKE expression
-	* @access private
-	*/
-	function _sql_like_expression($expression)
-	{
-		return $expression . " ESCAPE '\\'";
-	}
-
-	/**
-	* Build db-specific query data
-	* @access private
-	*/
-	function _sql_custom_build($stage, $data)
-	{
-		return $data;
-	}
-
-	/**
 	* return sql error array
 	* @access private
 	*/
diff --git a/phpBB/includes/db/driver/mssqlnative.php b/phpBB/includes/db/driver/mssqlnative.php
index 656cbd2437..6f433e10cf 100644
--- a/phpBB/includes/db/driver/mssqlnative.php
+++ b/phpBB/includes/db/driver/mssqlnative.php
@@ -191,7 +191,7 @@ class result_mssqlnative
 /**
 * @package dbal
 */
-class phpbb_db_driver_mssqlnative extends phpbb_db_driver
+class phpbb_db_driver_mssqlnative extends phpbb_db_driver_mssql_base
 {
 	var $m_insert_id = NULL;
 	var $last_query_text = '';
@@ -259,14 +259,6 @@ class phpbb_db_driver_mssqlnative extends phpbb_db_driver
 	/**
 	* {@inheritDoc}
 	*/
-	public function sql_concatenate($expr1, $expr2)
-	{
-		return $expr1 . ' + ' . $expr2;
-	}
-
-	/**
-	* {@inheritDoc}
-	*/
 	function sql_buffer_nested_transactions()
 	{
 		return true;
@@ -491,31 +483,6 @@ class phpbb_db_driver_mssqlnative extends phpbb_db_driver
 	}
 
 	/**
-	* Escape string used in sql query
-	*/
-	function sql_escape($msg)
-	{
-		return str_replace(array("'", "\0"), array("''", ''), $msg);
-	}
-
-	/**
-	* {@inheritDoc}
-	*/
-	function sql_lower_text($column_name)
-	{
-		return "LOWER(SUBSTRING($column_name, 1, DATALENGTH($column_name)))";
-	}
-
-	/**
-	* Build LIKE expression
-	* @access private
-	*/
-	function _sql_like_expression($expression)
-	{
-		return $expression . " ESCAPE '\\'";
-	}
-
-	/**
 	* return sql error array
 	* @access private
 	*/
@@ -561,15 +528,6 @@ class phpbb_db_driver_mssqlnative extends phpbb_db_driver
 	}
 
 	/**
-	* Build db-specific query data
-	* @access private
-	*/
-	function _sql_custom_build($stage, $data)
-	{
-		return $data;
-	}
-
-	/**
 	* Close sql connection
 	* @access private
 	*/
diff --git a/phpBB/includes/db/driver/mysql.php b/phpBB/includes/db/driver/mysql.php
index 9de7283a42..f3744ac09d 100644
--- a/phpBB/includes/db/driver/mysql.php
+++ b/phpBB/includes/db/driver/mysql.php
@@ -24,7 +24,7 @@ if (!defined('IN_PHPBB'))
 * MySQL 5.0+
 * @package dbal
 */
-class phpbb_db_driver_mysql extends phpbb_db_driver
+class phpbb_db_driver_mysql extends phpbb_db_driver_mysql_base
 {
 	var $multi_insert = true;
 	var $connect_error = '';
@@ -136,14 +136,6 @@ class phpbb_db_driver_mysql extends phpbb_db_driver
 	}
 
 	/**
-	* {@inheritDoc}
-	*/
-	public function sql_concatenate($expr1, $expr2)
-	{
-		return 'CONCAT(' . $expr1 . ', ' . $expr2 . ')';
-	}
-
-	/**
 	* SQL Transaction
 	* @access private
 	*/
@@ -227,25 +219,6 @@ class phpbb_db_driver_mysql extends phpbb_db_driver
 	}
 
 	/**
-	* Build LIMIT query
-	*/
-	function _sql_query_limit($query, $total, $offset = 0, $cache_ttl = 0)
-	{
-		$this->query_result = false;
-
-		// if $total is set to 0 we do not want to limit the number of rows
-		if ($total == 0)
-		{
-			// Having a value of -1 was always a bug
-			$total = '18446744073709551615';
-		}
-
-		$query .= "\n LIMIT " . ((!empty($offset)) ? $offset . ', ' . $total : $total);
-
-		return $this->sql_query($query, $cache_ttl);
-	}
-
-	/**
 	* Return number of affected rows
 	*/
 	function sql_affectedrows()
@@ -342,101 +315,6 @@ class phpbb_db_driver_mysql extends phpbb_db_driver
 	}
 
 	/**
-	* Gets the estimated number of rows in a specified table.
-	*
-	* @param string $table_name		Table name
-	*
-	* @return string				Number of rows in $table_name.
-	*								Prefixed with ~ if estimated (otherwise exact).
-	*
-	* @access public
-	*/
-	function get_estimated_row_count($table_name)
-	{
-		$table_status = $this->get_table_status($table_name);
-
-		if (isset($table_status['Engine']))
-		{
-			if ($table_status['Engine'] === 'MyISAM')
-			{
-				return $table_status['Rows'];
-			}
-			else if ($table_status['Engine'] === 'InnoDB' && $table_status['Rows'] > 100000)
-			{
-				return '~' . $table_status['Rows'];
-			}
-		}
-
-		return parent::get_row_count($table_name);
-	}
-
-	/**
-	* Gets the exact number of rows in a specified table.
-	*
-	* @param string $table_name		Table name
-	*
-	* @return string				Exact number of rows in $table_name.
-	*
-	* @access public
-	*/
-	function get_row_count($table_name)
-	{
-		$table_status = $this->get_table_status($table_name);
-
-		if (isset($table_status['Engine']) && $table_status['Engine'] === 'MyISAM')
-		{
-			return $table_status['Rows'];
-		}
-
-		return parent::get_row_count($table_name);
-	}
-
-	/**
-	* Gets some information about the specified table.
-	*
-	* @param string $table_name		Table name
-	*
-	* @return array
-	*
-	* @access protected
-	*/
-	function get_table_status($table_name)
-	{
-		$sql = "SHOW TABLE STATUS
-			LIKE '" . $this->sql_escape($table_name) . "'";
-		$result = $this->sql_query($sql);
-		$table_status = $this->sql_fetchrow($result);
-		$this->sql_freeresult($result);
-
-		return $table_status;
-	}
-
-	/**
-	* Build LIKE expression
-	* @access private
-	*/
-	function _sql_like_expression($expression)
-	{
-		return $expression;
-	}
-
-	/**
-	* Build db-specific query data
-	* @access private
-	*/
-	function _sql_custom_build($stage, $data)
-	{
-		switch ($stage)
-		{
-			case 'FROM':
-				$data = '(' . $data . ')';
-			break;
-		}
-
-		return $data;
-	}
-
-	/**
 	* return sql error array
 	* @access private
 	*/
diff --git a/phpBB/includes/db/driver/mysql_base.php b/phpBB/includes/db/driver/mysql_base.php
new file mode 100644
index 0000000000..ba44ea61aa
--- /dev/null
+++ b/phpBB/includes/db/driver/mysql_base.php
@@ -0,0 +1,145 @@
+<?php
+/**
+*
+* @package dbal
+* @copyright (c) 2013 phpBB Group
+* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
+*
+*/
+
+/**
+* @ignore
+*/
+if (!defined('IN_PHPBB'))
+{
+	exit;
+}
+
+/**
+* Abstract MySQL Database Base Abstraction Layer
+* @package dbal
+*/
+abstract class phpbb_db_driver_mysql_base extends phpbb_db_driver
+{
+	/**
+	* {@inheritDoc}
+	*/
+	public function sql_concatenate($expr1, $expr2)
+	{
+		return 'CONCAT(' . $expr1 . ', ' . $expr2 . ')';
+	}
+
+	/**
+	* Build LIMIT query
+	*/
+	function _sql_query_limit($query, $total, $offset = 0, $cache_ttl = 0)
+	{
+		$this->query_result = false;
+
+		// if $total is set to 0 we do not want to limit the number of rows
+		if ($total == 0)
+		{
+			// MySQL 4.1+ no longer supports -1 in limit queries
+			$total = '18446744073709551615';
+		}
+
+		$query .= "\n LIMIT " . ((!empty($offset)) ? $offset . ', ' . $total : $total);
+
+		return $this->sql_query($query, $cache_ttl);
+	}
+
+	/**
+	* Gets the estimated number of rows in a specified table.
+	*
+	* @param string $table_name		Table name
+	*
+	* @return string				Number of rows in $table_name.
+	*								Prefixed with ~ if estimated (otherwise exact).
+	*
+	* @access public
+	*/
+	function get_estimated_row_count($table_name)
+	{
+		$table_status = $this->get_table_status($table_name);
+
+		if (isset($table_status['Engine']))
+		{
+			if ($table_status['Engine'] === 'MyISAM')
+			{
+				return $table_status['Rows'];
+			}
+			else if ($table_status['Engine'] === 'InnoDB' && $table_status['Rows'] > 100000)
+			{
+				return '~' . $table_status['Rows'];
+			}
+		}
+
+		return parent::get_row_count($table_name);
+	}
+
+	/**
+	* Gets the exact number of rows in a specified table.
+	*
+	* @param string $table_name		Table name
+	*
+	* @return string				Exact number of rows in $table_name.
+	*
+	* @access public
+	*/
+	function get_row_count($table_name)
+	{
+		$table_status = $this->get_table_status($table_name);
+
+		if (isset($table_status['Engine']) && $table_status['Engine'] === 'MyISAM')
+		{
+			return $table_status['Rows'];
+		}
+
+		return parent::get_row_count($table_name);
+	}
+
+	/**
+	* Gets some information about the specified table.
+	*
+	* @param string $table_name		Table name
+	*
+	* @return array
+	*
+	* @access protected
+	*/
+	function get_table_status($table_name)
+	{
+		$sql = "SHOW TABLE STATUS
+			LIKE '" . $this->sql_escape($table_name) . "'";
+		$result = $this->sql_query($sql);
+		$table_status = $this->sql_fetchrow($result);
+		$this->sql_freeresult($result);
+
+		return $table_status;
+	}
+
+	/**
+	* Build LIKE expression
+	* @access private
+	*/
+	function _sql_like_expression($expression)
+	{
+		return $expression;
+	}
+
+	/**
+	* Build db-specific query data
+	* @access private
+	*/
+	function _sql_custom_build($stage, $data)
+	{
+		switch ($stage)
+		{
+			case 'FROM':
+				$data = '(' . $data . ')';
+			break;
+		}
+
+		return $data;
+	}
+}
diff --git a/phpBB/includes/db/driver/mysqli.php b/phpBB/includes/db/driver/mysqli.php
index 7448bf1670..0f7a73ee6e 100644
--- a/phpBB/includes/db/driver/mysqli.php
+++ b/phpBB/includes/db/driver/mysqli.php
@@ -21,7 +21,7 @@ if (!defined('IN_PHPBB'))
 * MySQL 4.1+ or MySQL 5.0+
 * @package dbal
 */
-class phpbb_db_driver_mysqli extends phpbb_db_driver
+class phpbb_db_driver_mysqli extends phpbb_db_driver_mysql_base
 {
 	var $multi_insert = true;
 	var $connect_error = '';
@@ -103,6 +103,7 @@ class phpbb_db_driver_mysqli extends phpbb_db_driver
 
 	/**
 	* Version information about used database
+	* @param bool $raw if true, only return the fetched sql_server_version
 	* @param bool $use_cache If true, it is safe to retrieve the value from the cache
 	* @return string sql server version
 	*/
@@ -128,14 +129,6 @@ class phpbb_db_driver_mysqli extends phpbb_db_driver
 	}
 
 	/**
-	* {@inheritDoc}
-	*/
-	public function sql_concatenate($expr1, $expr2)
-	{
-		return 'CONCAT(' . $expr1 . ', ' . $expr2 . ')';
-	}
-
-	/**
 	* SQL Transaction
 	* @access private
 	*/
@@ -218,25 +211,6 @@ class phpbb_db_driver_mysqli extends phpbb_db_driver
 	}
 
 	/**
-	* Build LIMIT query
-	*/
-	function _sql_query_limit($query, $total, $offset = 0, $cache_ttl = 0)
-	{
-		$this->query_result = false;
-
-		// if $total is set to 0 we do not want to limit the number of rows
-		if ($total == 0)
-		{
-			// MySQL 4.1+ no longer supports -1 in limit queries
-			$total = '18446744073709551615';
-		}
-
-		$query .= "\n LIMIT " . ((!empty($offset)) ? $offset . ', ' . $total : $total);
-
-		return $this->sql_query($query, $cache_ttl);
-	}
-
-	/**
 	* Return number of affected rows
 	*/
 	function sql_affectedrows()
@@ -328,101 +302,6 @@ class phpbb_db_driver_mysqli extends phpbb_db_driver
 	}
 
 	/**
-	* Gets the estimated number of rows in a specified table.
-	*
-	* @param string $table_name		Table name
-	*
-	* @return string				Number of rows in $table_name.
-	*								Prefixed with ~ if estimated (otherwise exact).
-	*
-	* @access public
-	*/
-	function get_estimated_row_count($table_name)
-	{
-		$table_status = $this->get_table_status($table_name);
-
-		if (isset($table_status['Engine']))
-		{
-			if ($table_status['Engine'] === 'MyISAM')
-			{
-				return $table_status['Rows'];
-			}
-			else if ($table_status['Engine'] === 'InnoDB' && $table_status['Rows'] > 100000)
-			{
-				return '~' . $table_status['Rows'];
-			}
-		}
-
-		return parent::get_row_count($table_name);
-	}
-
-	/**
-	* Gets the exact number of rows in a specified table.
-	*
-	* @param string $table_name		Table name
-	*
-	* @return string				Exact number of rows in $table_name.
-	*
-	* @access public
-	*/
-	function get_row_count($table_name)
-	{
-		$table_status = $this->get_table_status($table_name);
-
-		if (isset($table_status['Engine']) && $table_status['Engine'] === 'MyISAM')
-		{
-			return $table_status['Rows'];
-		}
-
-		return parent::get_row_count($table_name);
-	}
-
-	/**
-	* Gets some information about the specified table.
-	*
-	* @param string $table_name		Table name
-	*
-	* @return array
-	*
-	* @access protected
-	*/
-	function get_table_status($table_name)
-	{
-		$sql = "SHOW TABLE STATUS
-			LIKE '" . $this->sql_escape($table_name) . "'";
-		$result = $this->sql_query($sql);
-		$table_status = $this->sql_fetchrow($result);
-		$this->sql_freeresult($result);
-
-		return $table_status;
-	}
-
-	/**
-	* Build LIKE expression
-	* @access private
-	*/
-	function _sql_like_expression($expression)
-	{
-		return $expression;
-	}
-
-	/**
-	* Build db-specific query data
-	* @access private
-	*/
-	function _sql_custom_build($stage, $data)
-	{
-		switch ($stage)
-		{
-			case 'FROM':
-				$data = '(' . $data . ')';
-			break;
-		}
-
-		return $data;
-	}
-
-	/**
 	* return sql error array
 	* @access private
 	*/
diff --git a/phpBB/includes/db/migration/data/310/boardindex.php b/phpBB/includes/db/migration/data/310/boardindex.php
new file mode 100644
index 0000000000..965e32c15c
--- /dev/null
+++ b/phpBB/includes/db/migration/data/310/boardindex.php
@@ -0,0 +1,23 @@
+<?php
+/**
+*
+* @package migration
+* @copyright (c) 2013 phpBB Group
+* @license http://opensource.org/licenses/gpl-license.php GNU Public License v2
+*
+*/
+
+class phpbb_db_migration_data_310_boardindex extends phpbb_db_migration
+{
+	public function effectively_installed()
+	{
+		return isset($this->config['board_index_text']);
+	}
+
+	public function update_data()
+	{
+		return array(
+			array('config.add', array('board_index_text', '')),
+		);
+	}
+}
diff --git a/phpBB/includes/db/sql_insert_buffer.php b/phpBB/includes/db/sql_insert_buffer.php
new file mode 100644
index 0000000000..c18f908429
--- /dev/null
+++ b/phpBB/includes/db/sql_insert_buffer.php
@@ -0,0 +1,150 @@
+<?php
+/**
+*
+* @package dbal
+* @copyright (c) 2013 phpBB Group
+* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
+*
+*/
+
+/**
+* @ignore
+*/
+if (!defined('IN_PHPBB'))
+{
+	exit;
+}
+
+/**
+* Collects rows for insert into a database until the buffer size is reached.
+* Then flushes the buffer to the database and starts over again.
+*
+* Benefits over collecting a (possibly huge) insert array and then using
+* $db->sql_multi_insert() include:
+*
+*  - Going over max packet size of the database connection is usually prevented
+*    because the data is submitted in batches.
+*
+*  - Reaching database connection timeout is usually prevented because
+*    submission of batches talks to the database every now and then.
+*
+*  - Usage of less PHP memory because data no longer needed is discarded on
+*    buffer flush.
+*
+* Attention:
+* Please note that users of this class have to call flush() to flush the
+* remaining rows to the database after their batch insert operation is
+* finished.
+*
+* Usage:
+* <code>
+*	$buffer = new phpbb_db_sql_insert_buffer($db, 'test_table', 1234);
+*
+*	while (do_stuff())
+*	{
+*		$buffer->insert(array(
+*			'column1' => 'value1',
+*			'column2' => 'value2',
+*		));
+*	}
+*
+*	$buffer->flush();
+* </code>
+*
+* @package dbal
+*/
+class phpbb_db_sql_insert_buffer
+{
+	/** @var phpbb_db_driver */
+	protected $db;
+
+	/** @var string */
+	protected $table_name;
+
+	/** @var int */
+	protected $max_buffered_rows;
+
+	/** @var array */
+	protected $buffer = array();
+
+	/**
+	* @param phpbb_db_driver $db
+	* @param string          $table_name
+	* @param int             $max_buffered_rows
+	*/
+	public function __construct(phpbb_db_driver $db, $table_name, $max_buffered_rows = 500)
+	{
+		$this->db = $db;
+		$this->table_name = $table_name;
+		$this->max_buffered_rows = $max_buffered_rows;
+	}
+
+	/**
+	* Inserts a single row into the buffer if multi insert is supported by the
+	* database (otherwise an insert query is sent immediately). Then flushes
+	* the buffer if the number of rows in the buffer is now greater than or
+	* equal to $max_buffered_rows.
+	*
+	* @param array $row
+	*
+	* @return bool		True when some data was flushed to the database.
+	*					False otherwise.
+	*/
+	public function insert(array $row)
+	{
+		$this->buffer[] = $row;
+
+		// Flush buffer if it is full or when DB does not support multi inserts.
+		// In the later case, the buffer will always only contain one row.
+		if (!$this->db->multi_insert || sizeof($this->buffer) >= $this->max_buffered_rows)
+		{
+			return $this->flush();
+		}
+
+		return false;
+	}
+
+	/**
+	* Inserts a row set, i.e. an array of rows, by calling insert().
+	*
+	* Please note that it is in most cases better to use insert() instead of
+	* first building a huge rowset. Or at least sizeof($rows) should be kept
+	* small.
+	*
+	* @param array $rows 
+	*
+	* @return bool		True when some data was flushed to the database.
+	*					False otherwise.
+	*/
+	public function insert_all(array $rows)
+	{
+		// Using bitwise |= because PHP does not have logical ||=
+		$result = 0;
+
+		foreach ($rows as $row)
+		{
+			$result |= (int) $this->insert($row);
+		}
+
+		return (bool) $result;
+	}
+
+	/**
+	* Flushes the buffer content to the DB and clears the buffer.
+	*
+	* @return bool		True when some data was flushed to the database.
+	*					False otherwise.
+	*/
+	public function flush()
+	{
+		if (!empty($this->buffer))
+		{
+			$this->db->sql_multi_insert($this->table_name, $this->buffer);
+			$this->buffer = array();
+
+			return true;
+		}
+
+		return false;
+	}
+}