diff options
| author | Marc Alexander <admin@m-a-styles.de> | 2012-12-24 14:34:10 +0100 | 
|---|---|---|
| committer | Marc Alexander <admin@m-a-styles.de> | 2012-12-24 14:34:10 +0100 | 
| commit | c9338b38b35675bd1d620e4a8ca7d44a522faace (patch) | |
| tree | 0746db7f0eb5f22780c04e3ece5fb6a549045860 /phpBB/includes | |
| parent | e6aaef6066549696453063417167e5a79c53b353 (diff) | |
| parent | 46b3c3ecc43721e53c9711a196e91c300e03a1c8 (diff) | |
| download | forums-c9338b38b35675bd1d620e4a8ca7d44a522faace.tar forums-c9338b38b35675bd1d620e4a8ca7d44a522faace.tar.gz forums-c9338b38b35675bd1d620e4a8ca7d44a522faace.tar.bz2 forums-c9338b38b35675bd1d620e4a8ca7d44a522faace.tar.xz forums-c9338b38b35675bd1d620e4a8ca7d44a522faace.zip  | |
Merge branch 'develop' of github.com:marc1706/phpbb3 into feature/avatars
Diffstat (limited to 'phpBB/includes')
49 files changed, 2395 insertions, 1895 deletions
diff --git a/phpBB/includes/acp/info/acp_extensions.php b/phpBB/includes/acp/info/acp_extensions.php index f5953fb1dd..03d7059165 100644 --- a/phpBB/includes/acp/info/acp_extensions.php +++ b/phpBB/includes/acp/info/acp_extensions.php @@ -16,10 +16,10 @@ class acp_extensions_info  	{  		return array(  			'filename'	=> 'acp_extensions', -			'title'		=> 'ACP_EXTENSIONS', +			'title'		=> 'ACP_EXTENSIONS_MANAGEMENT',  			'version'	=> '1.0.0',  			'modes'		=> array( -				'main'		=> array('title' => 'ACP_EXTENSIONS', 'auth' => 'acl_a_extensions', 'cat' => array('ACP_GENERAL_TASKS')), +				'main'		=> array('title' => 'ACP_EXTENSIONS', 'auth' => 'acl_a_extensions', 'cat' => array('ACP_EXTENSIONS_MANAGEMENT')),  			),  		);  	} diff --git a/phpBB/includes/acp/info/acp_language.php b/phpBB/includes/acp/info/acp_language.php index 85dfb119ea..7f33a22fa6 100644 --- a/phpBB/includes/acp/info/acp_language.php +++ b/phpBB/includes/acp/info/acp_language.php @@ -19,7 +19,7 @@ class acp_language_info  			'title'		=> 'ACP_LANGUAGE',  			'version'	=> '1.0.0',  			'modes'		=> array( -				'lang_packs'		=> array('title' => 'ACP_LANGUAGE_PACKS', 'auth' => 'acl_a_language', 'cat' => array('ACP_GENERAL_TASKS')), +				'lang_packs'		=> array('title' => 'ACP_LANGUAGE_PACKS', 'auth' => 'acl_a_language', 'cat' => array('ACP_LANGUAGE')),  			),  		);  	} diff --git a/phpBB/includes/bbcode.php b/phpBB/includes/bbcode.php index b9ffa8091c..e8681420d4 100644 --- a/phpBB/includes/bbcode.php +++ b/phpBB/includes/bbcode.php @@ -134,7 +134,7 @@ class bbcode  			$style_resource_locator = new phpbb_style_resource_locator();  			$style_path_provider = new phpbb_style_extension_path_provider($phpbb_extension_manager, new phpbb_style_path_provider()); -			$template = new phpbb_template($phpbb_root_path, $phpEx, $config, $user, $style_resource_locator, new phpbb_template_context()); +			$template = new phpbb_template($phpbb_root_path, $phpEx, $config, $user, $style_resource_locator, new phpbb_template_context(), $phpbb_extension_manager);  			$style = new phpbb_style($phpbb_root_path, $phpEx, $config, $user, $style_resource_locator, $style_path_provider, $template);  			$style->set_style();  			$template->set_filenames(array('bbcode.html' => 'bbcode.html')); diff --git a/phpBB/includes/cache/driver/file.php b/phpBB/includes/cache/driver/file.php index 691abe0438..85decbe3e8 100644 --- a/phpBB/includes/cache/driver/file.php +++ b/phpBB/includes/cache/driver/file.php @@ -367,12 +367,10 @@ class phpbb_cache_driver_file extends phpbb_cache_driver_base  	}  	/** -	* Save sql query +	* {@inheritDoc}  	*/ -	function sql_save($query, $query_result, $ttl) +	function sql_save(phpbb_db_driver $db, $query, $query_result, $ttl)  	{ -		global $db; -  		// Remove extra spaces and tabs  		$query = preg_replace('/[\n\r\s\t]+/', ' ', $query); diff --git a/phpBB/includes/cache/driver/interface.php b/phpBB/includes/cache/driver/interface.php index d403bbcd71..53f684d1c8 100644 --- a/phpBB/includes/cache/driver/interface.php +++ b/phpBB/includes/cache/driver/interface.php @@ -85,6 +85,7 @@ interface phpbb_cache_driver_interface  	* result to persistent storage. In other words, there is no need  	* to call save() afterwards.  	* +	* @param phpbb_db_driver $db	Database connection  	* @param string $query			SQL query, should be used for generating storage key  	* @param mixed $query_result	The result from dbal::sql_query, to be passed to  	* 								dbal::sql_fetchrow to get all rows and store them @@ -95,7 +96,7 @@ interface phpbb_cache_driver_interface  	* 								representing the query should be returned. Otherwise  	* 								the original $query_result should be returned.  	*/ -	public function sql_save($query, $query_result, $ttl); +	public function sql_save(phpbb_db_driver $db, $query, $query_result, $ttl);  	/**  	* Check if result for a given SQL query exists in cache. diff --git a/phpBB/includes/cache/driver/memory.php b/phpBB/includes/cache/driver/memory.php index c39f9f7850..f77a1df316 100644 --- a/phpBB/includes/cache/driver/memory.php +++ b/phpBB/includes/cache/driver/memory.php @@ -283,12 +283,10 @@ abstract class phpbb_cache_driver_memory extends phpbb_cache_driver_base  	}  	/** -	* Save sql query +	* {@inheritDoc}  	*/ -	function sql_save($query, $query_result, $ttl) +	function sql_save(phpbb_db_driver $db, $query, $query_result, $ttl)  	{ -		global $db; -  		// Remove extra spaces and tabs  		$query = preg_replace('/[\n\r\s\t]+/', ' ', $query);  		$hash = md5($query); diff --git a/phpBB/includes/cache/driver/null.php b/phpBB/includes/cache/driver/null.php index 687604d14f..2fadc27ba3 100644 --- a/phpBB/includes/cache/driver/null.php +++ b/phpBB/includes/cache/driver/null.php @@ -105,9 +105,9 @@ class phpbb_cache_driver_null extends phpbb_cache_driver_base  	}  	/** -	* Save sql query +	* {@inheritDoc}  	*/ -	function sql_save($query, $query_result, $ttl) +	function sql_save(phpbb_db_driver $db, $query, $query_result, $ttl)  	{  		return $query_result;  	} diff --git a/phpBB/includes/config/db.php b/phpBB/includes/config/db.php index 45f9f1cb21..b18369a479 100644 --- a/phpBB/includes/config/db.php +++ b/phpBB/includes/config/db.php @@ -29,7 +29,7 @@ class phpbb_config_db extends phpbb_config  	/**  	* Database connection -	* @var dbal +	* @var phpbb_db_driver  	*/  	protected $db; @@ -42,11 +42,11 @@ class phpbb_config_db extends phpbb_config  	/**  	* Creates a configuration container with a default set of values  	* -	* @param dbal                         $db    Database connection +	* @param phpbb_db_driver              $db    Database connection  	* @param phpbb_cache_driver_interface $cache Cache instance  	* @param string                       $table Configuration table name  	*/ -	public function __construct(dbal $db, phpbb_cache_driver_interface $cache, $table) +	public function __construct(phpbb_db_driver $db, phpbb_cache_driver_interface $cache, $table)  	{  		$this->db = $db;  		$this->cache = $cache; diff --git a/phpBB/includes/cron/task/core/prune_all_forums.php b/phpBB/includes/cron/task/core/prune_all_forums.php index ee0b5f7626..2c5d38cec0 100644 --- a/phpBB/includes/cron/task/core/prune_all_forums.php +++ b/phpBB/includes/cron/task/core/prune_all_forums.php @@ -37,9 +37,9 @@ class phpbb_cron_task_core_prune_all_forums extends phpbb_cron_task_base  	* @param string $phpbb_root_path The root path  	* @param string $php_ext The PHP extension  	* @param phpbb_config $config The config -	* @param dbal $db The db connection +	* @param phpbb_db_driver $db The db connection  	*/ -	public function __construct($phpbb_root_path, $php_ext, phpbb_config $config, dbal $db) +	public function __construct($phpbb_root_path, $php_ext, phpbb_config $config, phpbb_db_driver $db)  	{  		$this->phpbb_root_path = $phpbb_root_path;  		$this->php_ext = $php_ext; diff --git a/phpBB/includes/cron/task/core/prune_forum.php b/phpBB/includes/cron/task/core/prune_forum.php index fa7a761d88..e3c497f072 100644 --- a/phpBB/includes/cron/task/core/prune_forum.php +++ b/phpBB/includes/cron/task/core/prune_forum.php @@ -47,9 +47,9 @@ class phpbb_cron_task_core_prune_forum extends phpbb_cron_task_base implements p  	* @param string $phpbb_root_path The root path  	* @param string $php_ext The PHP extension  	* @param phpbb_config $config The config -	* @param dbal $db The db connection +	* @param phpbb_db_driver $db The db connection  	*/ -	public function __construct($phpbb_root_path, $php_ext, phpbb_config $config, dbal $db) +	public function __construct($phpbb_root_path, $php_ext, phpbb_config $config, phpbb_db_driver $db)  	{  		$this->phpbb_root_path = $phpbb_root_path;  		$this->php_ext = $php_ext; diff --git a/phpBB/includes/cron/task/core/tidy_search.php b/phpBB/includes/cron/task/core/tidy_search.php index fdbe31346e..3ec25aa021 100644 --- a/phpBB/includes/cron/task/core/tidy_search.php +++ b/phpBB/includes/cron/task/core/tidy_search.php @@ -38,10 +38,10 @@ class phpbb_cron_task_core_tidy_search extends phpbb_cron_task_base  	* @param string $php_ext The PHP extension  	* @param phpbb_auth $auth The auth  	* @param phpbb_config $config The config -	* @param dbal $db The db connection +	* @param phpbb_db_driver $db The db connection  	* @param phpbb_user $user The user  	*/ -	public function __construct($phpbb_root_path, $php_ext, phpbb_auth $auth, phpbb_config $config, dbal $db, phpbb_user $user) +	public function __construct($phpbb_root_path, $php_ext, phpbb_auth $auth, phpbb_config $config, phpbb_db_driver $db, phpbb_user $user)  	{  		$this->phpbb_root_path = $phpbb_root_path;  		$this->php_ext = $php_ext; diff --git a/phpBB/includes/db/db_tools.php b/phpBB/includes/db/db_tools.php index 6df3aac9ce..2bb016cebd 100644 --- a/phpBB/includes/db/db_tools.php +++ b/phpBB/includes/db/db_tools.php @@ -300,7 +300,7 @@ class phpbb_db_tools  	/**  	* Constructor. Set DB Object and set {@link $return_statements return_statements}.  	* -	* @param phpbb_dbal	$db					DBAL object +	* @param phpbb_db_driver	$db					Database connection  	* @param bool		$return_statements	True if only statements should be returned and no SQL being executed  	*/  	function phpbb_db_tools(&$db, $return_statements = false) diff --git a/phpBB/includes/db/dbal.php b/phpBB/includes/db/driver/driver.php index ef1dd7d14d..25daa7243d 100644 --- a/phpBB/includes/db/dbal.php +++ b/phpBB/includes/db/driver/driver.php @@ -19,7 +19,7 @@ if (!defined('IN_PHPBB'))  * Database Abstraction Layer  * @package dbal  */ -class dbal +class phpbb_db_driver  {  	var $db_connect_id;  	var $query_result; @@ -72,17 +72,17 @@ class dbal  	/**  	* Constructor  	*/ -	function dbal() +	function __construct()  	{  		$this->num_queries = array( -			'cached'		=> 0, -			'normal'		=> 0, -			'total'			=> 0, +			'cached'	=> 0, +			'normal'	=> 0, +			'total'		=> 0,  		);  		// Fill default sql layer based on the class being called.  		// This can be changed by the specified layer itself later if needed. -		$this->sql_layer = substr(get_class($this), 5); +		$this->sql_layer = substr(get_class($this), strlen('phpbb_db_driver_'));  		// Do not change this please! This variable is used to easy the use of it - and is hardcoded.  		$this->any_char = chr(0) . '%'; @@ -1042,8 +1042,3 @@ class dbal  		return $rows_total;  	}  } - -/** -* This variable holds the class name to use later -*/ -$sql_db = (!empty($dbms)) ? 'dbal_' . basename($dbms) : 'dbal'; diff --git a/phpBB/includes/db/firebird.php b/phpBB/includes/db/driver/firebird.php index 5728eb901c..4767b29f63 100644 --- a/phpBB/includes/db/firebird.php +++ b/phpBB/includes/db/driver/firebird.php @@ -15,14 +15,12 @@ if (!defined('IN_PHPBB'))  	exit;  } -include_once($phpbb_root_path . 'includes/db/dbal.' . $phpEx); -  /**  * Firebird/Interbase Database Abstraction Layer  * Minimum Requirement is Firebird 2.1  * @package dbal  */ -class dbal_firebird extends dbal +class phpbb_db_driver_firebird extends phpbb_db_driver  {  	var $last_query_text = '';  	var $service_handle = false; @@ -272,7 +270,7 @@ class dbal_firebird extends dbal  				if ($cache_ttl)  				{  					$this->open_queries[(int) $this->query_result] = $this->query_result; -					$this->query_result = $cache->sql_save($query, $this->query_result, $cache_ttl); +					$this->query_result = $cache->sql_save($this, $query, $this->query_result, $cache_ttl);  				}  				else if (strpos($query, 'SELECT') === 0 && $this->query_result)  				{ diff --git a/phpBB/includes/db/mssql.php b/phpBB/includes/db/driver/mssql.php index 235c48d3f0..215c6345c6 100644 --- a/phpBB/includes/db/mssql.php +++ b/phpBB/includes/db/driver/mssql.php @@ -15,14 +15,12 @@ if (!defined('IN_PHPBB'))  	exit;  } -include_once($phpbb_root_path . 'includes/db/dbal.' . $phpEx); -  /**  * MSSQL Database Abstraction Layer  * Minimum Requirement is MSSQL 2000+  * @package dbal  */ -class dbal_mssql extends dbal +class phpbb_db_driver_mssql extends phpbb_db_driver  {  	var $connect_error = ''; @@ -170,7 +168,7 @@ class dbal_mssql extends dbal  				if ($cache_ttl)  				{  					$this->open_queries[(int) $this->query_result] = $this->query_result; -					$this->query_result = $cache->sql_save($query, $this->query_result, $cache_ttl); +					$this->query_result = $cache->sql_save($this, $query, $this->query_result, $cache_ttl);  				}  				else if (strpos($query, 'SELECT') === 0 && $this->query_result)  				{ diff --git a/phpBB/includes/db/mssql_odbc.php b/phpBB/includes/db/driver/mssql_odbc.php index 2194de4a5e..7d93f939a2 100644 --- a/phpBB/includes/db/mssql_odbc.php +++ b/phpBB/includes/db/driver/mssql_odbc.php @@ -15,8 +15,6 @@ if (!defined('IN_PHPBB'))  	exit;  } -include_once($phpbb_root_path . 'includes/db/dbal.' . $phpEx); -  /**  * Unified ODBC functions  * Unified ODBC functions support any database having ODBC driver, for example Adabas D, IBM DB2, iODBC, Solid, Sybase SQL Anywhere... @@ -28,7 +26,7 @@ include_once($phpbb_root_path . 'includes/db/dbal.' . $phpEx);  *  * @package dbal  */ -class dbal_mssql_odbc extends dbal +class phpbb_db_driver_mssql_odbc extends phpbb_db_driver  {  	var $last_query_text = '';  	var $connect_error = ''; @@ -199,7 +197,7 @@ class dbal_mssql_odbc extends dbal  				if ($cache_ttl)  				{  					$this->open_queries[(int) $this->query_result] = $this->query_result; -					$this->query_result = $cache->sql_save($query, $this->query_result, $cache_ttl); +					$this->query_result = $cache->sql_save($this, $query, $this->query_result, $cache_ttl);  				}  				else if (strpos($query, 'SELECT') === 0 && $this->query_result)  				{ diff --git a/phpBB/includes/db/mssqlnative.php b/phpBB/includes/db/driver/mssqlnative.php index 4a969828e7..f88c702d07 100644 --- a/phpBB/includes/db/mssqlnative.php +++ b/phpBB/includes/db/driver/mssqlnative.php @@ -19,8 +19,6 @@ if (!defined('IN_PHPBB'))  	exit;  } -include_once($phpbb_root_path . 'includes/db/dbal.' . $phpEx); -  /**   * Prior to version 1.1 the SQL Server Native PHP driver didn't support sqlsrv_num_rows, or cursor based seeking so we recall all rows into an array   * and maintain our own cursor index into that array. @@ -193,7 +191,7 @@ class result_mssqlnative  /**  * @package dbal  */ -class dbal_mssqlnative extends dbal +class phpbb_db_driver_mssqlnative extends phpbb_db_driver  {  	var $m_insert_id = NULL;  	var $last_query_text = ''; @@ -339,7 +337,7 @@ class dbal_mssqlnative extends dbal  				if ($cache_ttl)  				{  					$this->open_queries[(int) $this->query_result] = $this->query_result; -					$this->query_result = $cache->sql_save($query, $this->query_result, $cache_ttl); +					$this->query_result = $cache->sql_save($this, $query, $this->query_result, $cache_ttl);  				}  				else if (strpos($query, 'SELECT') === 0 && $this->query_result)  				{ diff --git a/phpBB/includes/db/mysql.php b/phpBB/includes/db/driver/mysql.php index dcdeec0401..30f78c9231 100644 --- a/phpBB/includes/db/mysql.php +++ b/phpBB/includes/db/driver/mysql.php @@ -15,8 +15,6 @@ if (!defined('IN_PHPBB'))  	exit;  } -include_once($phpbb_root_path . 'includes/db/dbal.' . $phpEx); -  /**  * MySQL4 Database Abstraction Layer  * Compatible with: @@ -26,7 +24,7 @@ include_once($phpbb_root_path . 'includes/db/dbal.' . $phpEx);  * MySQL 5.0+  * @package dbal  */ -class dbal_mysql extends dbal +class phpbb_db_driver_mysql extends phpbb_db_driver  {  	var $multi_insert = true;  	var $connect_error = ''; @@ -208,7 +206,7 @@ class dbal_mysql extends dbal  				if ($cache_ttl)  				{  					$this->open_queries[(int) $this->query_result] = $this->query_result; -					$this->query_result = $cache->sql_save($query, $this->query_result, $cache_ttl); +					$this->query_result = $cache->sql_save($this, $query, $this->query_result, $cache_ttl);  				}  				else if (strpos($query, 'SELECT') === 0 && $this->query_result)  				{ diff --git a/phpBB/includes/db/mysqli.php b/phpBB/includes/db/driver/mysqli.php index 5713b1992c..4f45c5781c 100644 --- a/phpBB/includes/db/mysqli.php +++ b/phpBB/includes/db/driver/mysqli.php @@ -15,15 +15,13 @@ if (!defined('IN_PHPBB'))  	exit;  } -include_once($phpbb_root_path . 'includes/db/dbal.' . $phpEx); -  /**  * MySQLi Database Abstraction Layer  * mysqli-extension has to be compiled with:  * MySQL 4.1+ or MySQL 5.0+  * @package dbal  */ -class dbal_mysqli extends dbal +class phpbb_db_driver_mysqli extends phpbb_db_driver  {  	var $multi_insert = true;  	var $connect_error = ''; @@ -203,7 +201,7 @@ class dbal_mysqli extends dbal  				if ($cache_ttl)  				{ -					$this->query_result = $cache->sql_save($query, $this->query_result, $cache_ttl); +					$this->query_result = $cache->sql_save($this, $query, $this->query_result, $cache_ttl);  				}  			}  			else if (defined('DEBUG')) diff --git a/phpBB/includes/db/oracle.php b/phpBB/includes/db/driver/oracle.php index 4a2b107865..53f9dd71e0 100644 --- a/phpBB/includes/db/oracle.php +++ b/phpBB/includes/db/driver/oracle.php @@ -15,13 +15,11 @@ if (!defined('IN_PHPBB'))  	exit;  } -include_once($phpbb_root_path . 'includes/db/dbal.' . $phpEx); -  /**  * Oracle Database Abstraction Layer  * @package dbal  */ -class dbal_oracle extends dbal +class phpbb_db_driver_oracle extends phpbb_db_driver  {  	var $last_query_text = '';  	var $connect_error = ''; @@ -448,7 +446,7 @@ class dbal_oracle extends dbal  				if ($cache_ttl)  				{  					$this->open_queries[(int) $this->query_result] = $this->query_result; -					$this->query_result = $cache->sql_save($query, $this->query_result, $cache_ttl); +					$this->query_result = $cache->sql_save($this, $query, $this->query_result, $cache_ttl);  				}  				else if (strpos($query, 'SELECT') === 0 && $this->query_result)  				{ diff --git a/phpBB/includes/db/postgres.php b/phpBB/includes/db/driver/postgres.php index 8dfbfc3b60..cca97c9c0e 100644 --- a/phpBB/includes/db/postgres.php +++ b/phpBB/includes/db/driver/postgres.php @@ -15,19 +15,12 @@ if (!defined('IN_PHPBB'))  	exit;  } -include_once($phpbb_root_path . 'includes/db/dbal.' . $phpEx); - -if (!class_exists('phpbb_error_collector')) -{ -	include($phpbb_root_path . 'includes/error_collector.' . $phpEx); -} -  /**  * PostgreSQL Database Abstraction Layer  * Minimum Requirement is Version 7.3+  * @package dbal  */ -class dbal_postgres extends dbal +class phpbb_db_driver_postgres extends phpbb_db_driver  {  	var $last_query_text = '';  	var $connect_error = ''; @@ -218,7 +211,7 @@ class dbal_postgres extends dbal  				if ($cache_ttl)  				{  					$this->open_queries[(int) $this->query_result] = $this->query_result; -					$this->query_result = $cache->sql_save($query, $this->query_result, $cache_ttl); +					$this->query_result = $cache->sql_save($this, $query, $this->query_result, $cache_ttl);  				}  				else if (strpos($query, 'SELECT') === 0 && $this->query_result)  				{ diff --git a/phpBB/includes/db/sqlite.php b/phpBB/includes/db/driver/sqlite.php index 06e368d586..155409b665 100644 --- a/phpBB/includes/db/sqlite.php +++ b/phpBB/includes/db/driver/sqlite.php @@ -15,14 +15,12 @@ if (!defined('IN_PHPBB'))  	exit;  } -include_once($phpbb_root_path . 'includes/db/dbal.' . $phpEx); -  /**  * Sqlite Database Abstraction Layer  * Minimum Requirement: 2.8.2+  * @package dbal  */ -class dbal_sqlite extends dbal +class phpbb_db_driver_sqlite extends phpbb_db_driver  {  	var $connect_error = ''; @@ -154,7 +152,7 @@ class dbal_sqlite extends dbal  				if ($cache_ttl)  				{  					$this->open_queries[(int) $this->query_result] = $this->query_result; -					$this->query_result = $cache->sql_save($query, $this->query_result, $cache_ttl); +					$this->query_result = $cache->sql_save($this, $query, $this->query_result, $cache_ttl);  				}  				else if (strpos($query, 'SELECT') === 0 && $this->query_result)  				{ diff --git a/phpBB/includes/di/extension/config.php b/phpBB/includes/di/extension/config.php index fb5ca90070..97a6290066 100644 --- a/phpBB/includes/di/extension/config.php +++ b/phpBB/includes/di/extension/config.php @@ -43,8 +43,8 @@ class phpbb_di_extension_config extends Extension  		require($this->config_file);  		$container->setParameter('core.table_prefix', $table_prefix); -		$container->setParameter('cache.driver.class', $this->fix_acm_type($acm_type)); -		$container->setParameter('dbal.driver.class', 'dbal_'.$dbms); +		$container->setParameter('cache.driver.class', $this->convert_30_acm_type($acm_type)); +		$container->setParameter('dbal.driver.class', phpbb_convert_30_dbms_to_31($dbms));  		$container->setParameter('dbal.dbhost', $dbhost);  		$container->setParameter('dbal.dbuser', $dbuser);  		$container->setParameter('dbal.dbpasswd', $dbpasswd); @@ -66,12 +66,12 @@ class phpbb_di_extension_config extends Extension  	}  	/** -	* Convert old (3.0) values to 3.1 class names +	* Convert 3.0 ACM type to 3.1 cache driver class name  	* -	* @param style $acm_type ACM type -	* @return ACM type class +	* @param string $acm_type ACM type +	* @return cache driver class  	*/ -	protected function fix_acm_type($acm_type) +	protected function convert_30_acm_type($acm_type)  	{  		if (preg_match('#^[a-z]+$#', $acm_type))  		{ diff --git a/phpBB/includes/extension/manager.php b/phpBB/includes/extension/manager.php index bfd4edde93..67cc81e407 100644 --- a/phpBB/includes/extension/manager.php +++ b/phpBB/includes/extension/manager.php @@ -34,7 +34,7 @@ class phpbb_extension_manager  	/**  	* Creates a manager and loads information from database  	* -	* @param dbal $db A database connection +	* @param phpbb_db_driver $db A database connection  	* @param phpbb_config $config phpbb_config  	* @param string $extension_table The name of the table holding extensions  	* @param string $phpbb_root_path Path to the phpbb includes directory. @@ -42,7 +42,7 @@ class phpbb_extension_manager  	* @param phpbb_cache_driver_interface $cache A cache instance or null  	* @param string $cache_name The name of the cache variable, defaults to _ext  	*/ -	public function __construct(dbal $db, phpbb_config $config, $extension_table, $phpbb_root_path, $php_ext = '.php', phpbb_cache_driver_interface $cache = null, $cache_name = '_ext') +	public function __construct(phpbb_db_driver $db, phpbb_config $config, $extension_table, $phpbb_root_path, $php_ext = '.php', phpbb_cache_driver_interface $cache = null, $cache_name = '_ext')  	{  		$this->phpbb_root_path = $phpbb_root_path;  		$this->db = $db; diff --git a/phpBB/includes/extension/metadata_manager.php b/phpBB/includes/extension/metadata_manager.php index ea85bd3c4e..36b0f8b184 100644 --- a/phpBB/includes/extension/metadata_manager.php +++ b/phpBB/includes/extension/metadata_manager.php @@ -34,12 +34,12 @@ class phpbb_extension_metadata_manager  	/**  	* Creates the metadata manager  	* -	* @param dbal $db A database connection +	* @param phpbb_db_driver $db A database connection  	* @param string $extension_manager An instance of the phpbb extension manager  	* @param string $phpbb_root_path Path to the phpbb includes directory.  	* @param string $phpEx php file extension  	*/ -	public function __construct($ext_name, dbal $db, phpbb_extension_manager $extension_manager, $phpbb_root_path, $phpEx = '.php', phpbb_template $template, phpbb_config $config) +	public function __construct($ext_name, phpbb_db_driver $db, phpbb_extension_manager $extension_manager, $phpbb_root_path, $phpEx = '.php', phpbb_template $template, phpbb_config $config)  	{  		$this->phpbb_root_path = $phpbb_root_path;  		$this->db = $db; diff --git a/phpBB/includes/functions.php b/phpBB/includes/functions.php index e492f97022..8ef5284134 100644 --- a/phpBB/includes/functions.php +++ b/phpBB/includes/functions.php @@ -5550,6 +5550,52 @@ function phpbb_to_numeric($input)  }  /** +* Convert either 3.0 dbms or 3.1 db driver class name to 3.1 db driver class name. +* +* If $dbms is a valid 3.1 db driver class name, returns it unchanged. +* Otherwise prepends phpbb_db_driver_ to the dbms to convert a 3.0 dbms +* to 3.1 db driver class name. +* +* @param string $dbms dbms parameter +* @return db driver class +*/ +function phpbb_convert_30_dbms_to_31($dbms) +{ +	// Note: this check is done first because mysqli extension +	// supplies a mysqli class, and class_exists($dbms) would return +	// true for mysqli class. +	// However, per the docblock any valid 3.1 driver name should be +	// recognized by this function, and have priority over 3.0 dbms. +	if (class_exists('phpbb_db_driver_' . $dbms)) +	{ +		return 'phpbb_db_driver_' . $dbms; +	} + +	if (class_exists($dbms)) +	{ +		// Additionally we could check that $dbms extends phpbb_db_driver. +		// http://php.net/manual/en/class.reflectionclass.php +		// Beware of possible performance issues: +		// http://stackoverflow.com/questions/294582/php-5-reflection-api-performance +		// We could check for interface implementation in all paths or +		// only when we do not prepend phpbb_db_driver_. + +		/* +		$reflection = new \ReflectionClass($dbms); +   	  +		if ($reflection->isSubclassOf('phpbb_db_driver')) +		{ +			return $dbms; +		} +		*/ + +		return $dbms; +	} + +	throw new \RuntimeException("You have specified an invalid dbms driver: $dbms"); +} + +/**  * Create a Symfony Request object from phpbb_request object  *  * @param phpbb_request $request Request object diff --git a/phpBB/includes/functions_database_helper.php b/phpBB/includes/functions_database_helper.php new file mode 100644 index 0000000000..1b508e6a02 --- /dev/null +++ b/phpBB/includes/functions_database_helper.php @@ -0,0 +1,206 @@ +<?php +/** +* +* @package phpBB3 +* @copyright (c) 2012 phpBB Group +* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2 +* +*/ + +/** +* @ignore +*/ +if (!defined('IN_PHPBB')) +{ +	exit; +} + +/** +* Updates rows in given table from a set of values to a new value. +* If this results in rows violating uniqueness constraints, the duplicate +* rows are eliminated. +* +* The only supported table is bookmarks. +* +* @param phpbb_db_driver $db Database object +* @param string $table Table on which to perform the update +* @param string $column Column whose values to change +* @param array $from_values An array of values that should be changed +* @param int $to_value The new value +* @return null +*/ +function phpbb_update_rows_avoiding_duplicates(phpbb_db_driver $db, $table, $column, $from_values, $to_value) +{ +	$sql = "SELECT $column, user_id +		FROM $table +		WHERE " . $db->sql_in_set($column, $from_values); +	$result = $db->sql_query($sql); + +	$old_user_ids = array(); +	while ($row = $db->sql_fetchrow($result)) +	{ +		$old_user_ids[$row[$column]][] = (int) $row['user_id']; +	} +	$db->sql_freeresult($result); + +	$sql = "SELECT $column, user_id +		FROM $table +		WHERE $column = " . (int) $to_value; +	$result = $db->sql_query($sql); + +	$new_user_ids = array(); +	while ($row = $db->sql_fetchrow($result)) +	{ +		$new_user_ids[$row[$column]][] = (int) $row['user_id']; +	} +	$db->sql_freeresult($result); + +	$queries = array(); +	foreach ($from_values as $from_value) +	{ +		if (!isset($old_user_ids[$from_value])) +		{ +			continue; +		} +		if (empty($new_user_ids)) +		{ +			$sql = "UPDATE $table +				SET $column = " . (int) $to_value . " +				WHERE $column = '" . $db->sql_escape($from_value) . "'"; +			$queries[] = $sql; +		} +		else +		{ +			$different_user_ids = array_diff($old_user_ids[$from_value], $new_user_ids[$to_value]); +			if (!empty($different_user_ids)) +			{ +				$sql = "UPDATE $table +					SET $column = " . (int) $to_value . " +					WHERE $column = '" . $db->sql_escape($from_value) . "' +					AND " . $db->sql_in_set('user_id', $different_user_ids); +				$queries[] = $sql; +			} +		} +	} + +	if (!empty($queries)) +	{ +		$db->sql_transaction('begin'); + +		foreach ($queries as $sql) +		{ +			$db->sql_query($sql); +		} + +		$sql = "DELETE FROM $table +			WHERE " . $db->sql_in_set($column, $from_values); +		$db->sql_query($sql); + +		$db->sql_transaction('commit'); +	} +} + +/** +* Updates rows in given table from a set of values to a new value. +* If this results in rows violating uniqueness constraints, the duplicate +* rows are merged respecting notify_status (0 takes precedence over 1). +* +* The only supported table is topics_watch. +* +* @param phpbb_db_driver $db Database object +* @param string $table Table on which to perform the update +* @param string $column Column whose values to change +* @param array $from_values An array of values that should be changed +* @param int $to_value The new value +* @return null +*/ +function phpbb_update_rows_avoiding_duplicates_notify_status(phpbb_db_driver $db, $table, $column, $from_values, $to_value) +{ +	$sql = "SELECT $column, user_id, notify_status +		FROM $table +		WHERE " . $db->sql_in_set($column, $from_values); +	$result = $db->sql_query($sql); + +	$old_user_ids = array(); +	while ($row = $db->sql_fetchrow($result)) +	{ +		$old_user_ids[(int) $row['notify_status']][$row[$column]][] = (int) $row['user_id']; +	} +	$db->sql_freeresult($result); + +	$sql = "SELECT $column, user_id +		FROM $table +		WHERE $column = " . (int) $to_value; +	$result = $db->sql_query($sql); + +	$new_user_ids = array(); +	while ($row = $db->sql_fetchrow($result)) +	{ +		$new_user_ids[$row[$column]][] = (int) $row['user_id']; +	} +	$db->sql_freeresult($result); + +	$queries = array(); +	$extra_updates = array( +		0 => 'notify_status = 0', +		1 => '', +	); +	foreach ($from_values as $from_value) +	{ +		foreach ($extra_updates as $notify_status => $extra_update) +		{ +			if (!isset($old_user_ids[$notify_status][$from_value])) +			{ +				continue; +			} +			if (empty($new_user_ids)) +			{ +				$sql = "UPDATE $table +					SET $column = " . (int) $to_value . " +					WHERE $column = '" . $db->sql_escape($from_value) . "'"; +				$queries[] = $sql; +			} +			else +			{ +				$different_user_ids = array_diff($old_user_ids[$notify_status][$from_value], $new_user_ids[$to_value]); +				if (!empty($different_user_ids)) +				{ +					$sql = "UPDATE $table +						SET $column = " . (int) $to_value . " +						WHERE $column = '" . $db->sql_escape($from_value) . "' +						AND " . $db->sql_in_set('user_id', $different_user_ids); +					$queries[] = $sql; +				} + +				if ($extra_update) +				{ +					$same_user_ids = array_diff($old_user_ids[$notify_status][$from_value], $different_user_ids); +					if (!empty($same_user_ids)) +					{ +						$sql = "UPDATE $table +							SET $extra_update +							WHERE $column = '" . (int) $to_value . "' +							AND " . $db->sql_in_set('user_id', $same_user_ids); +						$queries[] = $sql; +					} +				} +			} +		} +	} + +	if (!empty($queries)) +	{ +		$db->sql_transaction('begin'); + +		foreach ($queries as $sql) +		{ +			$db->sql_query($sql); +		} + +		$sql = "DELETE FROM $table +			WHERE " . $db->sql_in_set($column, $from_values); +		$db->sql_query($sql); + +		$db->sql_transaction('commit'); +	} +} diff --git a/phpBB/includes/functions_display.php b/phpBB/includes/functions_display.php index 6b267bc901..cf56250296 100644 --- a/phpBB/includes/functions_display.php +++ b/phpBB/includes/functions_display.php @@ -61,6 +61,20 @@ function display_forums($root_data = '', $display_moderators = true, $return_mod  		{  			markread('all', false, false, request_var('mark_time', 0)); +			if ($request->is_ajax()) +			{ +				// Tell the ajax script what language vars and URL need to be replaced +				$data = array( +					'NO_UNREAD_POSTS'	=> $user->lang['NO_UNREAD_POSTS'], +					'UNREAD_POSTS'		=> $user->lang['UNREAD_POSTS'], +					'U_MARK_FORUMS'		=> ($user->data['is_registered'] || $config['load_anon_lastread']) ? append_sid("{$phpbb_root_path}index.$phpEx", 'hash=' . generate_link_hash('global') . '&mark=forums&mark_time=' . time()) : '', +					'MESSAGE_TITLE'		=> $user->lang['INFORMATION'], +					'MESSAGE_TEXT'		=> $user->lang['FORUMS_MARKED'] +				); +				$json_response = new phpbb_json_response(); +				$json_response->send($data); +			} +  			trigger_error(  				$user->lang['FORUMS_MARKED'] . '<br /><br />' .  				sprintf($user->lang['RETURN_INDEX'], '<a href="' . $redirect . '">', '</a>') @@ -313,6 +327,20 @@ function display_forums($root_data = '', $display_moderators = true, $return_mod  			$message = sprintf($user->lang['RETURN_FORUM'], '<a href="' . $redirect . '">', '</a>');  			meta_refresh(3, $redirect); +			if ($request->is_ajax()) +			{ +				// Tell the ajax script what language vars and URL need to be replaced +				$data = array( +					'NO_UNREAD_POSTS'	=> $user->lang['NO_UNREAD_POSTS'], +					'UNREAD_POSTS'		=> $user->lang['UNREAD_POSTS'], +					'U_MARK_FORUMS'		=> ($user->data['is_registered'] || $config['load_anon_lastread']) ? append_sid("{$phpbb_root_path}viewforum.$phpEx", 'hash=' . generate_link_hash('global') . '&f=' . $root_data['forum_id'] . '&mark=forums&mark_time=' . time()) : '', +					'MESSAGE_TITLE'		=> $user->lang['INFORMATION'], +					'MESSAGE_TEXT'		=> $user->lang['FORUMS_MARKED'] +				); +				$json_response = new phpbb_json_response(); +				$json_response->send($data); +			} +  			trigger_error($user->lang['FORUMS_MARKED'] . '<br /><br />' . $message);  		}  		else diff --git a/phpBB/includes/functions_download.php b/phpBB/includes/functions_download.php index fc6f1cc762..9ae647d806 100644 --- a/phpBB/includes/functions_download.php +++ b/phpBB/includes/functions_download.php @@ -596,7 +596,7 @@ function phpbb_parse_range_request($request_array, $filesize)  /**  * Increments the download count of all provided attachments  * -* @param dbal $db The database object +* @param phpbb_db_driver $db The database object  * @param array|int $ids The attach_id of each attachment  *  * @return null @@ -617,7 +617,7 @@ function phpbb_increment_downloads($db, $ids)  /**  * Handles authentication when downloading attachments from a post or topic  * -* @param dbal $db The database object +* @param phpbb_db_driver $db The database object  * @param phpbb_auth $auth The authentication object  * @param int $topic_id The id of the topic that we are downloading from  * @@ -651,7 +651,7 @@ function phpbb_download_handle_forum_auth($db, $auth, $topic_id)  /**  * Handles authentication when downloading attachments from PMs  * -* @param dbal $db The database object +* @param phpbb_db_driver $db The database object  * @param phpbb_auth $auth The authentication object  * @param int $user_id The user id  * @param int $msg_id The id of the PM that we are downloading from @@ -678,7 +678,7 @@ function phpbb_download_handle_pm_auth($db, $auth, $user_id, $msg_id)  /**  * Checks whether a user can download from a particular PM  * -* @param dbal $db The database object +* @param phpbb_db_driver $db The database object  * @param int $user_id The user id  * @param int $msg_id The id of the PM that we are downloading from  * diff --git a/phpBB/includes/functions_install.php b/phpBB/includes/functions_install.php index ab6b3ea009..2b4b7eb10d 100644 --- a/phpBB/includes/functions_install.php +++ b/phpBB/includes/functions_install.php @@ -28,7 +28,7 @@ function get_available_dbms($dbms = false, $return_unavailable = false, $only_20  			'SCHEMA'		=> 'firebird',  			'MODULE'		=> 'interbase',  			'DELIM'			=> ';;', -			'DRIVER'		=> 'firebird', +			'DRIVER'		=> 'phpbb_db_driver_firebird',  			'AVAILABLE'		=> true,  			'2.0.x'			=> false,  		), @@ -37,7 +37,7 @@ function get_available_dbms($dbms = false, $return_unavailable = false, $only_20  			'SCHEMA'		=> 'mysql_41',  			'MODULE'		=> 'mysqli',  			'DELIM'			=> ';', -			'DRIVER'		=> 'mysqli', +			'DRIVER'		=> 'phpbb_db_driver_mysqli',  			'AVAILABLE'		=> true,  			'2.0.x'			=> true,  		), @@ -46,7 +46,7 @@ function get_available_dbms($dbms = false, $return_unavailable = false, $only_20  			'SCHEMA'		=> 'mysql',  			'MODULE'		=> 'mysql',  			'DELIM'			=> ';', -			'DRIVER'		=> 'mysql', +			'DRIVER'		=> 'phpbb_db_driver_mysql',  			'AVAILABLE'		=> true,  			'2.0.x'			=> true,  		), @@ -55,7 +55,7 @@ function get_available_dbms($dbms = false, $return_unavailable = false, $only_20  			'SCHEMA'		=> 'mssql',  			'MODULE'		=> 'mssql',  			'DELIM'			=> 'GO', -			'DRIVER'		=> 'mssql', +			'DRIVER'		=> 'phpbb_db_driver_mssql',  			'AVAILABLE'		=> true,  			'2.0.x'			=> true,  		), @@ -64,7 +64,7 @@ function get_available_dbms($dbms = false, $return_unavailable = false, $only_20  			'SCHEMA'		=> 'mssql',  			'MODULE'		=> 'odbc',  			'DELIM'			=> 'GO', -			'DRIVER'		=> 'mssql_odbc', +			'DRIVER'		=> 'phpbb_db_driver_mssql_odbc',  			'AVAILABLE'		=> true,  			'2.0.x'			=> true,  		), @@ -73,7 +73,7 @@ function get_available_dbms($dbms = false, $return_unavailable = false, $only_20  			'SCHEMA'		=> 'mssql',  			'MODULE'		=> 'sqlsrv',  			'DELIM'			=> 'GO', -			'DRIVER'		=> 'mssqlnative', +			'DRIVER'		=> 'phpbb_db_driver_mssqlnative',  			'AVAILABLE'		=> true,  			'2.0.x'			=> false,  		), @@ -82,7 +82,7 @@ function get_available_dbms($dbms = false, $return_unavailable = false, $only_20  			'SCHEMA'		=> 'oracle',  			'MODULE'		=> 'oci8',  			'DELIM'			=> '/', -			'DRIVER'		=> 'oracle', +			'DRIVER'		=> 'phpbb_db_driver_oracle',  			'AVAILABLE'		=> true,  			'2.0.x'			=> false,  		), @@ -91,7 +91,7 @@ function get_available_dbms($dbms = false, $return_unavailable = false, $only_20  			'SCHEMA'		=> 'postgres',  			'MODULE'		=> 'pgsql',  			'DELIM'			=> ';', -			'DRIVER'		=> 'postgres', +			'DRIVER'		=> 'phpbb_db_driver_postgres',  			'AVAILABLE'		=> true,  			'2.0.x'			=> true,  		), @@ -100,7 +100,7 @@ function get_available_dbms($dbms = false, $return_unavailable = false, $only_20  			'SCHEMA'		=> 'sqlite',  			'MODULE'		=> 'sqlite',  			'DELIM'			=> ';', -			'DRIVER'		=> 'sqlite', +			'DRIVER'		=> 'phpbb_db_driver_sqlite',  			'AVAILABLE'		=> true,  			'2.0.x'			=> false,  		), @@ -205,26 +205,19 @@ function connect_check_db($error_connect, &$error, $dbms_details, $table_prefix,  	$dbms = $dbms_details['DRIVER']; -	if ($load_dbal) -	{ -		// Include the DB layer -		include($phpbb_root_path . 'includes/db/' . $dbms . '.' . $phpEx); -	} -  	// Instantiate it and set return on error true -	$sql_db = 'dbal_' . $dbms; -	$db = new $sql_db(); +	$db = new $dbms();  	$db->sql_return_on_error(true);  	// Check that we actually have a database name before going any further..... -	if ($dbms_details['DRIVER'] != 'sqlite' && $dbms_details['DRIVER'] != 'oracle' && $dbname === '') +	if ($dbms_details['DRIVER'] != 'phpbb_db_driver_sqlite' && $dbms_details['DRIVER'] != 'phpbb_db_driver_oracle' && $dbname === '')  	{  		$error[] = $lang['INST_ERR_DB_NO_NAME'];  		return false;  	}  	// Make sure we don't have a daft user who thinks having the SQLite database in the forum directory is a good idea -	if ($dbms_details['DRIVER'] == 'sqlite' && stripos(phpbb_realpath($dbhost), phpbb_realpath('../')) === 0) +	if ($dbms_details['DRIVER'] == 'phpbb_db_driver_sqlite' && stripos(phpbb_realpath($dbhost), phpbb_realpath('../')) === 0)  	{  		$error[] = $lang['INST_ERR_DB_FORUM_PATH'];  		return false; @@ -233,8 +226,8 @@ function connect_check_db($error_connect, &$error, $dbms_details, $table_prefix,  	// Check the prefix length to ensure that index names are not too long and does not contain invalid characters  	switch ($dbms_details['DRIVER'])  	{ -		case 'mysql': -		case 'mysqli': +		case 'phpbb_db_driver_mysql': +		case 'phpbb_db_driver_mysqli':  			if (strspn($table_prefix, '-./\\') !== 0)  			{  				$error[] = $lang['INST_ERR_PREFIX_INVALID']; @@ -243,22 +236,22 @@ function connect_check_db($error_connect, &$error, $dbms_details, $table_prefix,  		// no break; -		case 'postgres': +		case 'phpbb_db_driver_postgres':  			$prefix_length = 36;  		break; -		case 'mssql': -		case 'mssql_odbc': -		case 'mssqlnative': +		case 'phpbb_db_driver_mssql': +		case 'phpbb_db_driver_mssql_odbc': +		case 'phpbb_db_driver_mssqlnative':  			$prefix_length = 90;  		break; -		case 'sqlite': +		case 'phpbb_db_driver_sqlite':  			$prefix_length = 200;  		break; -		case 'firebird': -		case 'oracle': +		case 'phpbb_db_driver_firebird': +		case 'phpbb_db_driver_oracle':  			$prefix_length = 6;  		break;  	} @@ -296,21 +289,21 @@ function connect_check_db($error_connect, &$error, $dbms_details, $table_prefix,  		// Make sure that the user has selected a sensible DBAL for the DBMS actually installed  		switch ($dbms_details['DRIVER'])  		{ -			case 'mysqli': +			case 'phpbb_db_driver_mysqli':  				if (version_compare(mysqli_get_server_info($db->db_connect_id), '4.1.3', '<'))  				{  					$error[] = $lang['INST_ERR_DB_NO_MYSQLI'];  				}  			break; -			case 'sqlite': +			case 'phpbb_db_driver_sqlite':  				if (version_compare(sqlite_libversion(), '2.8.2', '<'))  				{  					$error[] = $lang['INST_ERR_DB_NO_SQLITE'];  				}  			break; -			case 'firebird': +			case 'phpbb_db_driver_firebird':  				// check the version of FB, use some hackery if we can't get access to the server info  				if ($db->service_handle !== false && function_exists('ibase_server_info'))  				{ @@ -391,7 +384,7 @@ function connect_check_db($error_connect, &$error, $dbms_details, $table_prefix,  				}  			break; -			case 'oracle': +			case 'phpbb_db_driver_oracle':  				if ($unicode_check)  				{  					$sql = "SELECT * @@ -413,7 +406,7 @@ function connect_check_db($error_connect, &$error, $dbms_details, $table_prefix,  				}  			break; -			case 'postgres': +			case 'phpbb_db_driver_postgres':  				if ($unicode_check)  				{  					$sql = "SHOW server_encoding;"; diff --git a/phpBB/includes/functions_messenger.php b/phpBB/includes/functions_messenger.php index a18aeddabd..d0a02567ad 100644 --- a/phpBB/includes/functions_messenger.php +++ b/phpBB/includes/functions_messenger.php @@ -210,7 +210,7 @@ class messenger  		{  			$style_resource_locator = new phpbb_style_resource_locator();  			$style_path_provider = new phpbb_style_extension_path_provider($phpbb_extension_manager, new phpbb_style_path_provider()); -			$tpl = new phpbb_template($phpbb_root_path, $phpEx, $config, $user, $style_resource_locator, new phpbb_template_context()); +			$tpl = new phpbb_template($phpbb_root_path, $phpEx, $config, $user, $style_resource_locator, new phpbb_template_context(), $phpbb_extension_manager);  			$style = new phpbb_style($phpbb_root_path, $phpEx, $config, $user, $style_resource_locator, $style_path_provider, $tpl);  			$this->tpl_msg[$template_lang . $template_file] = $tpl; @@ -231,7 +231,7 @@ class messenger  				}  			} -			$style->set_custom_style($template_lang . '_email', array($template_path, $fallback_template_path), ''); +			$style->set_custom_style($template_lang . '_email', array($template_path, $fallback_template_path), array(), '');  			$tpl->set_filenames(array(  				'body'		=> $template_file . '.txt', diff --git a/phpBB/includes/functions_posting.php b/phpBB/includes/functions_posting.php index 171cf988ce..8aea27a9ef 100644 --- a/phpBB/includes/functions_posting.php +++ b/phpBB/includes/functions_posting.php @@ -1695,8 +1695,9 @@ function submit_post($mode, $subject, $username, $topic_type, &$poll, &$data, $u  	// The variable name should be $post_approved, because it indicates if the post is approved or not  	$post_approval = 1; -	// Check the permissions for post approval. Moderators are not affected. -	if (!$auth->acl_get('f_noapprove', $data['forum_id']) && !$auth->acl_get('m_approve', $data['forum_id'])) +	// Check the permissions for post approval. +	// Moderators must go through post approval like ordinary users. +	if (!$auth->acl_get('f_noapprove', $data['forum_id']))  	{  		// Post not approved, but in queue  		$post_approval = 0; diff --git a/phpBB/includes/functions_upload.php b/phpBB/includes/functions_upload.php index b467aa93d1..4f31a85e83 100644 --- a/phpBB/includes/functions_upload.php +++ b/phpBB/includes/functions_upload.php @@ -70,7 +70,7 @@ class filespec  			$this->mimetype = 'application/octetstream';  		} -		$this->extension = strtolower($this->get_extension($this->realname)); +		$this->extension = strtolower(self::get_extension($this->realname));  		// Try to get real filesize from temporary folder (not always working) ;)  		$this->filesize = (@filesize($this->filename)) ? @filesize($this->filename) : $this->filesize; @@ -187,8 +187,11 @@ class filespec  	/**  	* Get file extension +	* +	* @param string Filename that needs to be checked +	* @return string Extension of the supplied filename  	*/ -	function get_extension($filename) +	static public function get_extension($filename)  	{  		if (strpos($filename, '.') === false)  		{ @@ -369,7 +372,7 @@ class filespec  				}  				// Check image type -				$types = $this->upload->image_types(); +				$types = fileupload::image_types();  				if (!isset($types[$this->image_info[2]]) || !in_array($this->extension, $types[$this->image_info[2]]))  				{ @@ -1019,9 +1022,11 @@ class fileupload  	}  	/** -	* Return image type/extension mapping +	* Get image type/extension mapping +	* +	* @return array Array containing the image types and their extensions  	*/ -	function image_types() +	static public function image_types()  	{  		return array(  			IMAGETYPE_GIF		=> array('gif'), diff --git a/phpBB/includes/lock/db.php b/phpBB/includes/lock/db.php index 6e94dd5a85..ccdaed0b28 100644 --- a/phpBB/includes/lock/db.php +++ b/phpBB/includes/lock/db.php @@ -48,7 +48,7 @@ class phpbb_lock_db  	/**  	* A database connection -	* @var dbal +	* @var phpbb_db_driver  	*/  	private $db; @@ -59,9 +59,9 @@ class phpbb_lock_db  	*  	* @param	string	$config_name	A config variable to be used for locking  	* @param	array	$config			The phpBB configuration -	* @param	dbal	$db				A database connection +	* @param	phpbb_db_driver	$db				A database connection  	*/ -	public function __construct($config_name, phpbb_config $config, dbal $db) +	public function __construct($config_name, phpbb_config $config, phpbb_db_driver $db)  	{  		$this->config_name = $config_name;  		$this->config = $config; diff --git a/phpBB/includes/mcp/mcp_forum.php b/phpBB/includes/mcp/mcp_forum.php index 4dd5e5856a..0fad9e2a22 100644 --- a/phpBB/includes/mcp/mcp_forum.php +++ b/phpBB/includes/mcp/mcp_forum.php @@ -430,13 +430,16 @@ function merge_topics($forum_id, $topic_ids, $to_topic_id)  		// Message and return links  		$success_msg = 'POSTS_MERGED_SUCCESS'; -		// If the topic no longer exist, we will update the topic watch table. -		// To not let it error out on users watching both topics, we just return on an error... -		$db->sql_return_on_error(true); -		$db->sql_query('UPDATE ' . TOPICS_WATCH_TABLE . ' SET topic_id = ' . (int) $to_topic_id . ' WHERE ' . $db->sql_in_set('topic_id', $topic_ids)); -		$db->sql_return_on_error(false); +		if (!function_exists('phpbb_update_rows_avoiding_duplicates_notify_status')) +		{ +			include($phpbb_root_path . 'includes/functions_database_helper.' . $phpEx); +		} + +		// Update the topic watch table. +		phpbb_update_rows_avoiding_duplicates_notify_status($db, TOPICS_WATCH_TABLE, 'topic_id', $topic_ids, $to_topic_id); -		$db->sql_query('DELETE FROM ' . TOPICS_WATCH_TABLE . ' WHERE ' . $db->sql_in_set('topic_id', $topic_ids)); +		// Update the bookmarks table. +		phpbb_update_rows_avoiding_duplicates($db, BOOKMARKS_TABLE, 'topic_id', $topic_ids, $to_topic_id);  		// Link to the new topic  		$return_link .= (($return_link) ? '<br /><br />' : '') . sprintf($user->lang['RETURN_NEW_TOPIC'], '<a href="' . append_sid("{$phpbb_root_path}viewtopic.$phpEx", 'f=' . $to_forum_id . '&t=' . $to_topic_id) . '">', '</a>'); diff --git a/phpBB/includes/mcp/mcp_main.php b/phpBB/includes/mcp/mcp_main.php index 95ca7c2e1b..c28b466bcf 100644 --- a/phpBB/includes/mcp/mcp_main.php +++ b/phpBB/includes/mcp/mcp_main.php @@ -1080,6 +1080,7 @@ function mcp_fork_topic($topic_ids)  				}  			} +			// Copy topic subscriptions to new topic  			$sql = 'SELECT user_id, notify_status  				FROM ' . TOPICS_WATCH_TABLE . '  				WHERE topic_id = ' . $topic_id; @@ -1100,6 +1101,27 @@ function mcp_fork_topic($topic_ids)  			{  				$db->sql_multi_insert(TOPICS_WATCH_TABLE, $sql_ary);  			} + +			// Copy bookmarks to new topic +			$sql = 'SELECT user_id +				FROM ' . BOOKMARKS_TABLE . ' +				WHERE topic_id = ' . $topic_id; +			$result = $db->sql_query($sql); + +			$sql_ary = array(); +			while ($row = $db->sql_fetchrow($result)) +			{ +				$sql_ary[] = array( +					'topic_id'		=> (int) $new_topic_id, +					'user_id'		=> (int) $row['user_id'], +				); +			} +			$db->sql_freeresult($result); + +			if (sizeof($sql_ary)) +			{ +				$db->sql_multi_insert(BOOKMARKS_TABLE, $sql_ary); +			}  		}  		// Sync new topics, parent forums and board stats diff --git a/phpBB/includes/mcp/mcp_topic.php b/phpBB/includes/mcp/mcp_topic.php index 63ff7bed72..e3dd5a6b57 100644 --- a/phpBB/includes/mcp/mcp_topic.php +++ b/phpBB/includes/mcp/mcp_topic.php @@ -521,6 +521,49 @@ function split_topic($action, $topic_id, $to_forum_id, $subject)  			WHERE post_id = {$post_id_list[0]}";  		$db->sql_query($sql); +		// Copy topic subscriptions to new topic +		$sql = 'SELECT user_id, notify_status +			FROM ' . TOPICS_WATCH_TABLE . ' +			WHERE topic_id = ' . $topic_id; +		$result = $db->sql_query($sql); + +		$sql_ary = array(); +		while ($row = $db->sql_fetchrow($result)) +		{ +			$sql_ary[] = array( +				'topic_id'		=> (int) $to_topic_id, +				'user_id'		=> (int) $row['user_id'], +				'notify_status'	=> (int) $row['notify_status'], +			); +		} +		$db->sql_freeresult($result); + +		if (sizeof($sql_ary)) +		{ +			$db->sql_multi_insert(TOPICS_WATCH_TABLE, $sql_ary); +		} + +		// Copy bookmarks to new topic +		$sql = 'SELECT user_id +			FROM ' . BOOKMARKS_TABLE . ' +			WHERE topic_id = ' . $topic_id; +		$result = $db->sql_query($sql); + +		$sql_ary = array(); +		while ($row = $db->sql_fetchrow($result)) +		{ +			$sql_ary[] = array( +				'topic_id'		=> (int) $to_topic_id, +				'user_id'		=> (int) $row['user_id'], +			); +		} +		$db->sql_freeresult($result); + +		if (sizeof($sql_ary)) +		{ +			$db->sql_multi_insert(BOOKMARKS_TABLE, $sql_ary); +		} +  		$success_msg = 'TOPIC_SPLIT_SUCCESS';  		// Update forum statistics @@ -623,13 +666,16 @@ function merge_posts($topic_id, $to_topic_id)  		}  		else  		{ +			if (!function_exists('phpbb_update_rows_avoiding_duplicates_notify_status')) +			{ +				include($phpbb_root_path . 'includes/functions_database_helper.' . $phpEx); +			} +  			// If the topic no longer exist, we will update the topic watch table. -			// To not let it error out on users watching both topics, we just return on an error... -			$db->sql_return_on_error(true); -			$db->sql_query('UPDATE ' . TOPICS_WATCH_TABLE . ' SET topic_id = ' . (int) $to_topic_id . ' WHERE topic_id = ' . (int) $topic_id); -			$db->sql_return_on_error(false); +			phpbb_update_rows_avoiding_duplicates_notify_status($db, TOPICS_WATCH_TABLE, 'topic_id', $topic_ids, $to_topic_id); -			$db->sql_query('DELETE FROM ' . TOPICS_WATCH_TABLE . ' WHERE topic_id = ' . (int) $topic_id); +			// If the topic no longer exist, we will update the bookmarks table. +			phpbb_update_rows_avoiding_duplicates($db, BOOKMARKS_TABLE, 'topic_id', $topic_id, $to_topic_id);  		}  		// Link to the new topic diff --git a/phpBB/includes/message_parser.php b/phpBB/includes/message_parser.php index 1cd2a46fa1..44960dd78d 100644 --- a/phpBB/includes/message_parser.php +++ b/phpBB/includes/message_parser.php @@ -702,17 +702,6 @@ class bbcode_firstpass extends bbcode  	{  		global $config, $user; -		/** -		* If you change this code, make sure the cases described within the following reports are still working: -		* #3572 - [quote="[test]test"]test [ test[/quote] - (correct: parsed) -		* #14667 - [quote]test[/quote] test ] and [ test [quote]test[/quote] (correct: parsed) -		* #14770 - [quote="["]test[/quote] (correct: parsed) -		* [quote="[i]test[/i]"]test[/quote] (correct: parsed) -		* [quote="[quote]test[/quote]"]test[/quote] (correct: parsed - Username displayed as [quote]test[/quote]) -		* #20735 - [quote]test[/[/b]quote] test [/quote][/quote] test - (correct: quoted: "test[/[/b]quote] test" / non-quoted: "[/quote] test" - also failed if layout distorted) -		* #40565 - [quote="a"]a[/quote][quote="a]a[/quote] (correct: first quote tag parsed, second quote tag unparsed) -		*/ -  		$in = str_replace("\r\n", "\n", str_replace('\"', '"', trim($in)));  		if (!$in) diff --git a/phpBB/includes/questionnaire/questionnaire.php b/phpBB/includes/questionnaire/questionnaire.php index 2d29fe978e..6f2727a38c 100644 --- a/phpBB/includes/questionnaire/questionnaire.php +++ b/phpBB/includes/questionnaire/questionnaire.php @@ -260,6 +260,8 @@ class phpbb_questionnaire_phpbb_data_provider  		include("{$phpbb_root_path}config.$phpEx");  		unset($dbhost, $dbport, $dbname, $dbuser, $dbpasswd); // Just a precaution +		$dbms = phpbb_convert_30_dbms_to_31($dbms); +  		// Only send certain config vars  		$config_vars = array(  			'active_sessions' => true, diff --git a/phpBB/includes/search/fulltext_mysql.php b/phpBB/includes/search/fulltext_mysql.php index ff2e24aa05..324c214e91 100644 --- a/phpBB/includes/search/fulltext_mysql.php +++ b/phpBB/includes/search/fulltext_mysql.php @@ -41,8 +41,8 @@ class phpbb_search_fulltext_mysql extends phpbb_search_base  	protected $config;  	/** -	 * DBAL object -	 * @var dbal +	 * Database connection +	 * @var phpbb_db_driver  	 */  	protected $db; diff --git a/phpBB/includes/search/fulltext_native.php b/phpBB/includes/search/fulltext_native.php index 4623326fc7..53df8348ae 100644 --- a/phpBB/includes/search/fulltext_native.php +++ b/phpBB/includes/search/fulltext_native.php @@ -85,8 +85,8 @@ class phpbb_search_fulltext_native extends phpbb_search_base  	protected $config;  	/** -	 * DBAL object -	 * @var dbal +	 * Database connection +	 * @var phpbb_db_driver  	 */  	protected $db; diff --git a/phpBB/includes/search/fulltext_postgres.php b/phpBB/includes/search/fulltext_postgres.php index 2880610655..f22ee2ca16 100644 --- a/phpBB/includes/search/fulltext_postgres.php +++ b/phpBB/includes/search/fulltext_postgres.php @@ -66,8 +66,8 @@ class phpbb_search_fulltext_postgres extends phpbb_search_base  	protected $config;  	/** -	 * DBAL object -	 * @var dbal +	 * Database connection +	 * @var phpbb_db_driver  	 */  	protected $db; diff --git a/phpBB/includes/search/fulltext_sphinx.php b/phpBB/includes/search/fulltext_sphinx.php index dd5634b623..4bacf74f93 100644 --- a/phpBB/includes/search/fulltext_sphinx.php +++ b/phpBB/includes/search/fulltext_sphinx.php @@ -84,8 +84,8 @@ class phpbb_search_fulltext_sphinx  	protected $config;  	/** -	 * DBAL object -	 * @var dbal +	 * Database connection +	 * @var phpbb_db_driver  	 */  	protected $db; @@ -875,7 +875,7 @@ class phpbb_search_fulltext_sphinx  		</dl>  		<dl>  			<dt><label for="fulltext_sphinx_indexer_mem_limit">' . $this->user->lang['FULLTEXT_SPHINX_INDEXER_MEM_LIMIT'] . $this->user->lang['COLON'] . '</label><br /><span>' . $this->user->lang['FULLTEXT_SPHINX_INDEXER_MEM_LIMIT_EXPLAIN'] . '</span></dt> -			<dd><input id="fulltext_sphinx_indexer_mem_limit" type="text" size="4" maxlength="10" name="config[fulltext_sphinx_indexer_mem_limit]" value="' . $this->config['fulltext_sphinx_indexer_mem_limit'] . '" />' . $this->user->lang['MIB'] . '</dd> +			<dd><input id="fulltext_sphinx_indexer_mem_limit" type="text" size="4" maxlength="10" name="config[fulltext_sphinx_indexer_mem_limit]" value="' . $this->config['fulltext_sphinx_indexer_mem_limit'] . '" /> ' . $this->user->lang['MIB'] . '</dd>  		</dl>  		<dl>  			<dt><label for="fulltext_sphinx_config_file">' . $this->user->lang['FULLTEXT_SPHINX_CONFIG_FILE'] . $this->user->lang['COLON'] . '</label><br /><span>' . $this->user->lang['FULLTEXT_SPHINX_CONFIG_FILE_EXPLAIN'] . '</dt> diff --git a/phpBB/includes/sphinxapi.php b/phpBB/includes/sphinxapi.php index bd83b1d2e0..6c3b66710c 100644 --- a/phpBB/includes/sphinxapi.php +++ b/phpBB/includes/sphinxapi.php @@ -1,1712 +1,1712 @@ -<?php
 -
 -//
 -// $Id: sphinxapi.php 3087 2012-01-30 23:07:35Z shodan $
 -//
 -
 -//
 -// Copyright (c) 2001-2012, Andrew Aksyonoff
 -// Copyright (c) 2008-2012, Sphinx Technologies Inc
 -// All rights reserved
 -//
 -// This program is free software; you can redistribute it and/or modify
 -// it under the terms of the GNU General Public License. You should have
 -// received a copy of the GPL license along with this program; if you
 -// did not, you can find it at http://www.gnu.org/
 -//
 -
 -/////////////////////////////////////////////////////////////////////////////
 -// PHP version of Sphinx searchd client (PHP API)
 -/////////////////////////////////////////////////////////////////////////////
 -
 -/// known searchd commands
 -define ( "SEARCHD_COMMAND_SEARCH",		0 );
 -define ( "SEARCHD_COMMAND_EXCERPT",		1 );
 -define ( "SEARCHD_COMMAND_UPDATE",		2 );
 -define ( "SEARCHD_COMMAND_KEYWORDS",	3 );
 -define ( "SEARCHD_COMMAND_PERSIST",		4 );
 -define ( "SEARCHD_COMMAND_STATUS",		5 );
 -define ( "SEARCHD_COMMAND_FLUSHATTRS",	7 );
 -
 -/// current client-side command implementation versions
 -define ( "VER_COMMAND_SEARCH",		0x119 );
 -define ( "VER_COMMAND_EXCERPT",		0x104 );
 -define ( "VER_COMMAND_UPDATE",		0x102 );
 -define ( "VER_COMMAND_KEYWORDS",	0x100 );
 -define ( "VER_COMMAND_STATUS",		0x100 );
 -define ( "VER_COMMAND_QUERY",		0x100 );
 -define ( "VER_COMMAND_FLUSHATTRS",	0x100 );
 -
 -/// known searchd status codes
 -define ( "SEARCHD_OK",				0 );
 -define ( "SEARCHD_ERROR",			1 );
 -define ( "SEARCHD_RETRY",			2 );
 -define ( "SEARCHD_WARNING",			3 );
 -
 -/// known match modes
 -define ( "SPH_MATCH_ALL",			0 );
 -define ( "SPH_MATCH_ANY",			1 );
 -define ( "SPH_MATCH_PHRASE",		2 );
 -define ( "SPH_MATCH_BOOLEAN",		3 );
 -define ( "SPH_MATCH_EXTENDED",		4 );
 -define ( "SPH_MATCH_FULLSCAN",		5 );
 -define ( "SPH_MATCH_EXTENDED2",		6 );	// extended engine V2 (TEMPORARY, WILL BE REMOVED)
 -
 -/// known ranking modes (ext2 only)
 -define ( "SPH_RANK_PROXIMITY_BM25",	0 );	///< default mode, phrase proximity major factor and BM25 minor one
 -define ( "SPH_RANK_BM25",			1 );	///< statistical mode, BM25 ranking only (faster but worse quality)
 -define ( "SPH_RANK_NONE",			2 );	///< no ranking, all matches get a weight of 1
 -define ( "SPH_RANK_WORDCOUNT",		3 );	///< simple word-count weighting, rank is a weighted sum of per-field keyword occurence counts
 -define ( "SPH_RANK_PROXIMITY",		4 );
 -define ( "SPH_RANK_MATCHANY",		5 );
 -define ( "SPH_RANK_FIELDMASK",		6 );
 -define ( "SPH_RANK_SPH04",			7 );
 -define ( "SPH_RANK_EXPR",			8 );
 -define ( "SPH_RANK_TOTAL",			9 );
 -
 -/// known sort modes
 -define ( "SPH_SORT_RELEVANCE",		0 );
 -define ( "SPH_SORT_ATTR_DESC",		1 );
 -define ( "SPH_SORT_ATTR_ASC",		2 );
 -define ( "SPH_SORT_TIME_SEGMENTS", 	3 );
 -define ( "SPH_SORT_EXTENDED", 		4 );
 -define ( "SPH_SORT_EXPR", 			5 );
 -
 -/// known filter types
 -define ( "SPH_FILTER_VALUES",		0 );
 -define ( "SPH_FILTER_RANGE",		1 );
 -define ( "SPH_FILTER_FLOATRANGE",	2 );
 -
 -/// known attribute types
 -define ( "SPH_ATTR_INTEGER",		1 );
 -define ( "SPH_ATTR_TIMESTAMP",		2 );
 -define ( "SPH_ATTR_ORDINAL",		3 );
 -define ( "SPH_ATTR_BOOL",			4 );
 -define ( "SPH_ATTR_FLOAT",			5 );
 -define ( "SPH_ATTR_BIGINT",			6 );
 -define ( "SPH_ATTR_STRING",			7 );
 -define ( "SPH_ATTR_MULTI",			0x40000001 );
 -define ( "SPH_ATTR_MULTI64",			0x40000002 );
 -
 -/// known grouping functions
 -define ( "SPH_GROUPBY_DAY",			0 );
 -define ( "SPH_GROUPBY_WEEK",		1 );
 -define ( "SPH_GROUPBY_MONTH",		2 );
 -define ( "SPH_GROUPBY_YEAR",		3 );
 -define ( "SPH_GROUPBY_ATTR",		4 );
 -define ( "SPH_GROUPBY_ATTRPAIR",	5 );
 -
 -// important properties of PHP's integers:
 -//  - always signed (one bit short of PHP_INT_SIZE)
 -//  - conversion from string to int is saturated
 -//  - float is double
 -//  - div converts arguments to floats
 -//  - mod converts arguments to ints
 -
 -// the packing code below works as follows:
 -//  - when we got an int, just pack it
 -//    if performance is a problem, this is the branch users should aim for
 -//
 -//  - otherwise, we got a number in string form
 -//    this might be due to different reasons, but we assume that this is
 -//    because it didn't fit into PHP int
 -//
 -//  - factor the string into high and low ints for packing
 -//    - if we have bcmath, then it is used
 -//    - if we don't, we have to do it manually (this is the fun part)
 -//
 -//    - x64 branch does factoring using ints
 -//    - x32 (ab)uses floats, since we can't fit unsigned 32-bit number into an int
 -//
 -// unpacking routines are pretty much the same.
 -//  - return ints if we can
 -//  - otherwise format number into a string
 -
 -/// pack 64-bit signed
 -function sphPackI64 ( $v )
 -{
 -	assert ( is_numeric($v) );
 -	
 -	// x64
 -	if ( PHP_INT_SIZE>=8 )
 -	{
 -		$v = (int)$v;
 -		return pack ( "NN", $v>>32, $v&0xFFFFFFFF );
 -	}
 -
 -	// x32, int
 -	if ( is_int($v) )
 -		return pack ( "NN", $v < 0 ? -1 : 0, $v );
 -
 -	// x32, bcmath	
 -	if ( function_exists("bcmul") )
 -	{
 -		if ( bccomp ( $v, 0 ) == -1 )
 -			$v = bcadd ( "18446744073709551616", $v );
 -		$h = bcdiv ( $v, "4294967296", 0 );
 -		$l = bcmod ( $v, "4294967296" );
 -		return pack ( "NN", (float)$h, (float)$l ); // conversion to float is intentional; int would lose 31st bit
 -	}
 -
 -	// x32, no-bcmath
 -	$p = max(0, strlen($v) - 13);
 -	$lo = abs((float)substr($v, $p));
 -	$hi = abs((float)substr($v, 0, $p));
 -
 -	$m = $lo + $hi*1316134912.0; // (10 ^ 13) % (1 << 32) = 1316134912
 -	$q = floor($m/4294967296.0);
 -	$l = $m - ($q*4294967296.0);
 -	$h = $hi*2328.0 + $q; // (10 ^ 13) / (1 << 32) = 2328
 -
 -	if ( $v<0 )
 -	{
 -		if ( $l==0 )
 -			$h = 4294967296.0 - $h;
 -		else
 -		{
 -			$h = 4294967295.0 - $h;
 -			$l = 4294967296.0 - $l;
 -		}
 -	}
 -	return pack ( "NN", $h, $l );
 -}
 -
 -/// pack 64-bit unsigned
 -function sphPackU64 ( $v )
 -{
 -	assert ( is_numeric($v) );
 -	
 -	// x64
 -	if ( PHP_INT_SIZE>=8 )
 -	{
 -		assert ( $v>=0 );
 -		
 -		// x64, int
 -		if ( is_int($v) )
 -			return pack ( "NN", $v>>32, $v&0xFFFFFFFF );
 -						  
 -		// x64, bcmath
 -		if ( function_exists("bcmul") )
 -		{
 -			$h = bcdiv ( $v, 4294967296, 0 );
 -			$l = bcmod ( $v, 4294967296 );
 -			return pack ( "NN", $h, $l );
 -		}
 -		
 -		// x64, no-bcmath
 -		$p = max ( 0, strlen($v) - 13 );
 -		$lo = (int)substr ( $v, $p );
 -		$hi = (int)substr ( $v, 0, $p );
 -	
 -		$m = $lo + $hi*1316134912;
 -		$l = $m % 4294967296;
 -		$h = $hi*2328 + (int)($m/4294967296);
 -
 -		return pack ( "NN", $h, $l );
 -	}
 -
 -	// x32, int
 -	if ( is_int($v) )
 -		return pack ( "NN", 0, $v );
 -	
 -	// x32, bcmath
 -	if ( function_exists("bcmul") )
 -	{
 -		$h = bcdiv ( $v, "4294967296", 0 );
 -		$l = bcmod ( $v, "4294967296" );
 -		return pack ( "NN", (float)$h, (float)$l ); // conversion to float is intentional; int would lose 31st bit
 -	}
 -
 -	// x32, no-bcmath
 -	$p = max(0, strlen($v) - 13);
 -	$lo = (float)substr($v, $p);
 -	$hi = (float)substr($v, 0, $p);
 -	
 -	$m = $lo + $hi*1316134912.0;
 -	$q = floor($m / 4294967296.0);
 -	$l = $m - ($q * 4294967296.0);
 -	$h = $hi*2328.0 + $q;
 -
 -	return pack ( "NN", $h, $l );
 -}
 -
 -// unpack 64-bit unsigned
 -function sphUnpackU64 ( $v )
 -{
 -	list ( $hi, $lo ) = array_values ( unpack ( "N*N*", $v ) );
 -
 -	if ( PHP_INT_SIZE>=8 )
 -	{
 -		if ( $hi<0 ) $hi += (1<<32); // because php 5.2.2 to 5.2.5 is totally fucked up again
 -		if ( $lo<0 ) $lo += (1<<32);
 -
 -		// x64, int
 -		if ( $hi<=2147483647 )
 -			return ($hi<<32) + $lo;
 -
 -		// x64, bcmath
 -		if ( function_exists("bcmul") )
 -			return bcadd ( $lo, bcmul ( $hi, "4294967296" ) );
 -
 -		// x64, no-bcmath
 -		$C = 100000;
 -		$h = ((int)($hi / $C) << 32) + (int)($lo / $C);
 -		$l = (($hi % $C) << 32) + ($lo % $C);
 -		if ( $l>$C )
 -		{
 -			$h += (int)($l / $C);
 -			$l  = $l % $C;
 -		}
 -
 -		if ( $h==0 )
 -			return $l;
 -		return sprintf ( "%d%05d", $h, $l );
 -	}
 -
 -	// x32, int
 -	if ( $hi==0 )
 -	{
 -		if ( $lo>0 )
 -			return $lo;
 -		return sprintf ( "%u", $lo );
 -	}
 -
 -	$hi = sprintf ( "%u", $hi );
 -	$lo = sprintf ( "%u", $lo );
 -
 -	// x32, bcmath
 -	if ( function_exists("bcmul") )
 -		return bcadd ( $lo, bcmul ( $hi, "4294967296" ) );
 -	
 -	// x32, no-bcmath
 -	$hi = (float)$hi;
 -	$lo = (float)$lo;
 -	
 -	$q = floor($hi/10000000.0);
 -	$r = $hi - $q*10000000.0;
 -	$m = $lo + $r*4967296.0;
 -	$mq = floor($m/10000000.0);
 -	$l = $m - $mq*10000000.0;
 -	$h = $q*4294967296.0 + $r*429.0 + $mq;
 -
 -	$h = sprintf ( "%.0f", $h );
 -	$l = sprintf ( "%07.0f", $l );
 -	if ( $h=="0" )
 -		return sprintf( "%.0f", (float)$l );
 -	return $h . $l;
 -}
 -
 -// unpack 64-bit signed
 -function sphUnpackI64 ( $v )
 -{
 -	list ( $hi, $lo ) = array_values ( unpack ( "N*N*", $v ) );
 -
 -	// x64
 -	if ( PHP_INT_SIZE>=8 )
 -	{
 -		if ( $hi<0 ) $hi += (1<<32); // because php 5.2.2 to 5.2.5 is totally fucked up again
 -		if ( $lo<0 ) $lo += (1<<32);
 -
 -		return ($hi<<32) + $lo;
 -	}
 -
 -	// x32, int
 -	if ( $hi==0 )
 -	{
 -		if ( $lo>0 )
 -			return $lo;
 -		return sprintf ( "%u", $lo );
 -	}
 -	// x32, int
 -	elseif ( $hi==-1 )
 -	{
 -		if ( $lo<0 )
 -			return $lo;
 -		return sprintf ( "%.0f", $lo - 4294967296.0 );
 -	}
 -	
 -	$neg = "";
 -	$c = 0;
 -	if ( $hi<0 )
 -	{
 -		$hi = ~$hi;
 -		$lo = ~$lo;
 -		$c = 1;
 -		$neg = "-";
 -	}	
 -
 -	$hi = sprintf ( "%u", $hi );
 -	$lo = sprintf ( "%u", $lo );
 -
 -	// x32, bcmath
 -	if ( function_exists("bcmul") )
 -		return $neg . bcadd ( bcadd ( $lo, bcmul ( $hi, "4294967296" ) ), $c );
 -
 -	// x32, no-bcmath
 -	$hi = (float)$hi;
 -	$lo = (float)$lo;
 -	
 -	$q = floor($hi/10000000.0);
 -	$r = $hi - $q*10000000.0;
 -	$m = $lo + $r*4967296.0;
 -	$mq = floor($m/10000000.0);
 -	$l = $m - $mq*10000000.0 + $c;
 -	$h = $q*4294967296.0 + $r*429.0 + $mq;
 -	if ( $l==10000000 )
 -	{
 -		$l = 0;
 -		$h += 1;
 -	}
 -
 -	$h = sprintf ( "%.0f", $h );
 -	$l = sprintf ( "%07.0f", $l );
 -	if ( $h=="0" )
 -		return $neg . sprintf( "%.0f", (float)$l );
 -	return $neg . $h . $l;
 -}
 -
 -
 -function sphFixUint ( $value )
 -{
 -	if ( PHP_INT_SIZE>=8 )
 -	{
 -		// x64 route, workaround broken unpack() in 5.2.2+
 -		if ( $value<0 ) $value += (1<<32);
 -		return $value;
 -	}
 -	else
 -	{
 -		// x32 route, workaround php signed/unsigned braindamage
 -		return sprintf ( "%u", $value );
 -	}
 -}
 -
 -
 -/// sphinx searchd client class
 -class SphinxClient
 -{
 -	var $_host;			///< searchd host (default is "localhost")
 -	var $_port;			///< searchd port (default is 9312)
 -	var $_offset;		///< how many records to seek from result-set start (default is 0)
 -	var $_limit;		///< how many records to return from result-set starting at offset (default is 20)
 -	var $_mode;			///< query matching mode (default is SPH_MATCH_ALL)
 -	var $_weights;		///< per-field weights (default is 1 for all fields)
 -	var $_sort;			///< match sorting mode (default is SPH_SORT_RELEVANCE)
 -	var $_sortby;		///< attribute to sort by (defualt is "")
 -	var $_min_id;		///< min ID to match (default is 0, which means no limit)
 -	var $_max_id;		///< max ID to match (default is 0, which means no limit)
 -	var $_filters;		///< search filters
 -	var $_groupby;		///< group-by attribute name
 -	var $_groupfunc;	///< group-by function (to pre-process group-by attribute value with)
 -	var $_groupsort;	///< group-by sorting clause (to sort groups in result set with)
 -	var $_groupdistinct;///< group-by count-distinct attribute
 -	var $_maxmatches;	///< max matches to retrieve
 -	var $_cutoff;		///< cutoff to stop searching at (default is 0)
 -	var $_retrycount;	///< distributed retries count
 -	var $_retrydelay;	///< distributed retries delay
 -	var $_anchor;		///< geographical anchor point
 -	var $_indexweights;	///< per-index weights
 -	var $_ranker;		///< ranking mode (default is SPH_RANK_PROXIMITY_BM25)
 -	var $_rankexpr;		///< ranking mode expression (for SPH_RANK_EXPR)
 -	var $_maxquerytime;	///< max query time, milliseconds (default is 0, do not limit)
 -	var $_fieldweights;	///< per-field-name weights
 -	var $_overrides;	///< per-query attribute values overrides
 -	var $_select;		///< select-list (attributes or expressions, with optional aliases)
 -
 -	var $_error;		///< last error message
 -	var $_warning;		///< last warning message
 -	var $_connerror;		///< connection error vs remote error flag
 -
 -	var $_reqs;			///< requests array for multi-query
 -	var $_mbenc;		///< stored mbstring encoding
 -	var $_arrayresult;	///< whether $result["matches"] should be a hash or an array
 -	var $_timeout;		///< connect timeout
 -
 -	/////////////////////////////////////////////////////////////////////////////
 -	// common stuff
 -	/////////////////////////////////////////////////////////////////////////////
 -
 -	/// create a new client object and fill defaults
 -	function SphinxClient ()
 -	{
 -		// per-client-object settings
 -		$this->_host		= "localhost";
 -		$this->_port		= 9312;
 -		$this->_path		= false;
 -		$this->_socket		= false;
 -
 -		// per-query settings
 -		$this->_offset		= 0;
 -		$this->_limit		= 20;
 -		$this->_mode		= SPH_MATCH_ALL;
 -		$this->_weights		= array ();
 -		$this->_sort		= SPH_SORT_RELEVANCE;
 -		$this->_sortby		= "";
 -		$this->_min_id		= 0;
 -		$this->_max_id		= 0;
 -		$this->_filters		= array ();
 -		$this->_groupby		= "";
 -		$this->_groupfunc	= SPH_GROUPBY_DAY;
 -		$this->_groupsort	= "@group desc";
 -		$this->_groupdistinct= "";
 -		$this->_maxmatches	= 1000;
 -		$this->_cutoff		= 0;
 -		$this->_retrycount	= 0;
 -		$this->_retrydelay	= 0;
 -		$this->_anchor		= array ();
 -		$this->_indexweights= array ();
 -		$this->_ranker		= SPH_RANK_PROXIMITY_BM25;
 -		$this->_rankexpr	= "";
 -		$this->_maxquerytime= 0;
 -		$this->_fieldweights= array();
 -		$this->_overrides 	= array();
 -		$this->_select		= "*";
 -
 -		$this->_error		= ""; // per-reply fields (for single-query case)
 -		$this->_warning		= "";
 -		$this->_connerror	= false;
 -
 -		$this->_reqs		= array ();	// requests storage (for multi-query case)
 -		$this->_mbenc		= "";
 -		$this->_arrayresult	= false;
 -		$this->_timeout		= 0;
 -	}
 -
 -	function __destruct()
 -	{
 -		if ( $this->_socket !== false )
 -			fclose ( $this->_socket );
 -	}
 -
 -	/// get last error message (string)
 -	function GetLastError ()
 -	{
 -		return $this->_error;
 -	}
 -
 -	/// get last warning message (string)
 -	function GetLastWarning ()
 -	{
 -		return $this->_warning;
 -	}
 -
 -	/// get last error flag (to tell network connection errors from searchd errors or broken responses)
 -	function IsConnectError()
 -	{
 -		return $this->_connerror;
 -	}
 -
 -	/// set searchd host name (string) and port (integer)
 -	function SetServer ( $host, $port = 0 )
 -	{
 -		assert ( is_string($host) );
 -		if ( $host[0] == '/')
 -		{
 -			$this->_path = 'unix://' . $host;
 -			return;
 -		}
 -		if ( substr ( $host, 0, 7 )=="unix://" )
 -		{
 -			$this->_path = $host;
 -			return;
 -		}
 -				
 -		assert ( is_int($port) );
 -		$this->_host = $host;
 -		$this->_port = $port;
 -		$this->_path = '';
 -
 -	}
 -
 -	/// set server connection timeout (0 to remove)
 -	function SetConnectTimeout ( $timeout )
 -	{
 -		assert ( is_numeric($timeout) );
 -		$this->_timeout = $timeout;
 -	}
 -
 -
 -	function _Send ( $handle, $data, $length )
 -	{
 -		if ( feof($handle) || fwrite ( $handle, $data, $length ) !== $length )
 -		{
 -			$this->_error = 'connection unexpectedly closed (timed out?)';
 -			$this->_connerror = true;
 -			return false;
 -		}
 -		return true;
 -	}
 -
 -	/////////////////////////////////////////////////////////////////////////////
 -
 -	/// enter mbstring workaround mode
 -	function _MBPush ()
 -	{
 -		$this->_mbenc = "";
 -		if ( ini_get ( "mbstring.func_overload" ) & 2 )
 -		{
 -			$this->_mbenc = mb_internal_encoding();
 -			mb_internal_encoding ( "latin1" );
 -		}
 -    }
 -
 -	/// leave mbstring workaround mode
 -	function _MBPop ()
 -	{
 -		if ( $this->_mbenc )
 -			mb_internal_encoding ( $this->_mbenc );
 -	}
 -
 -	/// connect to searchd server
 -	function _Connect ()
 -	{
 -		if ( $this->_socket!==false )
 -		{
 -			// we are in persistent connection mode, so we have a socket
 -			// however, need to check whether it's still alive
 -			if ( !@feof ( $this->_socket ) )
 -				return $this->_socket;
 -
 -			// force reopen
 -			$this->_socket = false;
 -		}
 -
 -		$errno = 0;
 -		$errstr = "";
 -		$this->_connerror = false;
 -
 -		if ( $this->_path )
 -		{
 -			$host = $this->_path;
 -			$port = 0;
 -		}
 -		else
 -		{
 -			$host = $this->_host;
 -			$port = $this->_port;
 -		}
 -
 -		if ( $this->_timeout<=0 )
 -			$fp = @fsockopen ( $host, $port, $errno, $errstr );
 -		else
 -			$fp = @fsockopen ( $host, $port, $errno, $errstr, $this->_timeout );
 -		
 -		if ( !$fp )
 -		{
 -			if ( $this->_path )
 -				$location = $this->_path;
 -			else
 -				$location = "{$this->_host}:{$this->_port}";
 -			
 -			$errstr = trim ( $errstr );
 -			$this->_error = "connection to $location failed (errno=$errno, msg=$errstr)";
 -			$this->_connerror = true;
 -			return false;
 -		}
 -
 -		// send my version
 -		// this is a subtle part. we must do it before (!) reading back from searchd.
 -		// because otherwise under some conditions (reported on FreeBSD for instance)
 -		// TCP stack could throttle write-write-read pattern because of Nagle.
 -		if ( !$this->_Send ( $fp, pack ( "N", 1 ), 4 ) )
 -		{
 -			fclose ( $fp );
 -			$this->_error = "failed to send client protocol version";
 -			return false;
 -		}
 -
 -		// check version
 -		list(,$v) = unpack ( "N*", fread ( $fp, 4 ) );
 -		$v = (int)$v;
 -		if ( $v<1 )
 -		{
 -			fclose ( $fp );
 -			$this->_error = "expected searchd protocol version 1+, got version '$v'";
 -			return false;
 -		}
 -
 -		return $fp;
 -	}
 -
 -	/// get and check response packet from searchd server
 -	function _GetResponse ( $fp, $client_ver )
 -	{
 -		$response = "";
 -		$len = 0;
 -
 -		$header = fread ( $fp, 8 );
 -		if ( strlen($header)==8 )
 -		{
 -			list ( $status, $ver, $len ) = array_values ( unpack ( "n2a/Nb", $header ) );
 -			$left = $len;
 -			while ( $left>0 && !feof($fp) )
 -			{
 -				$chunk = fread ( $fp, min ( 8192, $left ) );
 -				if ( $chunk )
 -				{
 -					$response .= $chunk;
 -					$left -= strlen($chunk);
 -				}
 -			}
 -		}
 -		if ( $this->_socket === false )
 -			fclose ( $fp );
 -
 -		// check response
 -		$read = strlen ( $response );
 -		if ( !$response || $read!=$len )
 -		{
 -			$this->_error = $len
 -				? "failed to read searchd response (status=$status, ver=$ver, len=$len, read=$read)"
 -				: "received zero-sized searchd response";
 -			return false;
 -		}
 -
 -		// check status
 -		if ( $status==SEARCHD_WARNING )
 -		{
 -			list(,$wlen) = unpack ( "N*", substr ( $response, 0, 4 ) );
 -			$this->_warning = substr ( $response, 4, $wlen );
 -			return substr ( $response, 4+$wlen );
 -		}
 -		if ( $status==SEARCHD_ERROR )
 -		{
 -			$this->_error = "searchd error: " . substr ( $response, 4 );
 -			return false;
 -		}
 -		if ( $status==SEARCHD_RETRY )
 -		{
 -			$this->_error = "temporary searchd error: " . substr ( $response, 4 );
 -			return false;
 -		}
 -		if ( $status!=SEARCHD_OK )
 -		{
 -			$this->_error = "unknown status code '$status'";
 -			return false;
 -		}
 -
 -		// check version
 -		if ( $ver<$client_ver )
 -		{
 -			$this->_warning = sprintf ( "searchd command v.%d.%d older than client's v.%d.%d, some options might not work",
 -				$ver>>8, $ver&0xff, $client_ver>>8, $client_ver&0xff );
 -		}
 -
 -		return $response;
 -	}
 -
 -	/////////////////////////////////////////////////////////////////////////////
 -	// searching
 -	/////////////////////////////////////////////////////////////////////////////
 -
 -	/// set offset and count into result set,
 -	/// and optionally set max-matches and cutoff limits
 -	function SetLimits ( $offset, $limit, $max=0, $cutoff=0 )
 -	{
 -		assert ( is_int($offset) );
 -		assert ( is_int($limit) );
 -		assert ( $offset>=0 );
 -		assert ( $limit>0 );
 -		assert ( $max>=0 );
 -		$this->_offset = $offset;
 -		$this->_limit = $limit;
 -		if ( $max>0 )
 -			$this->_maxmatches = $max;
 -		if ( $cutoff>0 )
 -			$this->_cutoff = $cutoff;
 -	}
 -
 -	/// set maximum query time, in milliseconds, per-index
 -	/// integer, 0 means "do not limit"
 -	function SetMaxQueryTime ( $max )
 -	{
 -		assert ( is_int($max) );
 -		assert ( $max>=0 );
 -		$this->_maxquerytime = $max;
 -	}
 -
 -	/// set matching mode
 -	function SetMatchMode ( $mode )
 -	{
 -		assert ( $mode==SPH_MATCH_ALL
 -			|| $mode==SPH_MATCH_ANY
 -			|| $mode==SPH_MATCH_PHRASE
 -			|| $mode==SPH_MATCH_BOOLEAN
 -			|| $mode==SPH_MATCH_EXTENDED
 -			|| $mode==SPH_MATCH_FULLSCAN
 -			|| $mode==SPH_MATCH_EXTENDED2 );
 -		$this->_mode = $mode;
 -	}
 -
 -	/// set ranking mode
 -	function SetRankingMode ( $ranker, $rankexpr="" )
 -	{
 -		assert ( $ranker>=0 && $ranker<SPH_RANK_TOTAL );
 -		assert ( is_string($rankexpr) );
 -		$this->_ranker = $ranker;
 -		$this->_rankexpr = $rankexpr;
 -	}
 -
 -	/// set matches sorting mode
 -	function SetSortMode ( $mode, $sortby="" )
 -	{
 -		assert (
 -			$mode==SPH_SORT_RELEVANCE ||
 -			$mode==SPH_SORT_ATTR_DESC ||
 -			$mode==SPH_SORT_ATTR_ASC ||
 -			$mode==SPH_SORT_TIME_SEGMENTS ||
 -			$mode==SPH_SORT_EXTENDED ||
 -			$mode==SPH_SORT_EXPR );
 -		assert ( is_string($sortby) );
 -		assert ( $mode==SPH_SORT_RELEVANCE || strlen($sortby)>0 );
 -
 -		$this->_sort = $mode;
 -		$this->_sortby = $sortby;
 -	}
 -
 -	/// bind per-field weights by order
 -	/// DEPRECATED; use SetFieldWeights() instead
 -	function SetWeights ( $weights )
 -	{
 -		assert ( is_array($weights) );
 -		foreach ( $weights as $weight )
 -			assert ( is_int($weight) );
 -
 -		$this->_weights = $weights;
 -	}
 -
 -	/// bind per-field weights by name
 -	function SetFieldWeights ( $weights )
 -	{
 -		assert ( is_array($weights) );
 -		foreach ( $weights as $name=>$weight )
 -		{
 -			assert ( is_string($name) );
 -			assert ( is_int($weight) );
 -		}
 -		$this->_fieldweights = $weights;
 -	}
 -
 -	/// bind per-index weights by name
 -	function SetIndexWeights ( $weights )
 -	{
 -		assert ( is_array($weights) );
 -		foreach ( $weights as $index=>$weight )
 -		{
 -			assert ( is_string($index) );
 -			assert ( is_int($weight) );
 -		}
 -		$this->_indexweights = $weights;
 -	}
 -
 -	/// set IDs range to match
 -	/// only match records if document ID is beetwen $min and $max (inclusive)
 -	function SetIDRange ( $min, $max )
 -	{
 -		assert ( is_numeric($min) );
 -		assert ( is_numeric($max) );
 -		assert ( $min<=$max );
 -		$this->_min_id = $min;
 -		$this->_max_id = $max;
 -	}
 -
 -	/// set values set filter
 -	/// only match records where $attribute value is in given set
 -	function SetFilter ( $attribute, $values, $exclude=false )
 -	{
 -		assert ( is_string($attribute) );
 -		assert ( is_array($values) );
 -		assert ( count($values) );
 -
 -		if ( is_array($values) && count($values) )
 -		{
 -			foreach ( $values as $value )
 -				assert ( is_numeric($value) );
 -
 -			$this->_filters[] = array ( "type"=>SPH_FILTER_VALUES, "attr"=>$attribute, "exclude"=>$exclude, "values"=>$values );
 -		}
 -	}
 -
 -	/// set range filter
 -	/// only match records if $attribute value is beetwen $min and $max (inclusive)
 -	function SetFilterRange ( $attribute, $min, $max, $exclude=false )
 -	{
 -		assert ( is_string($attribute) );
 -		assert ( is_numeric($min) );
 -		assert ( is_numeric($max) );
 -		assert ( $min<=$max );
 -
 -		$this->_filters[] = array ( "type"=>SPH_FILTER_RANGE, "attr"=>$attribute, "exclude"=>$exclude, "min"=>$min, "max"=>$max );
 -	}
 -
 -	/// set float range filter
 -	/// only match records if $attribute value is beetwen $min and $max (inclusive)
 -	function SetFilterFloatRange ( $attribute, $min, $max, $exclude=false )
 -	{
 -		assert ( is_string($attribute) );
 -		assert ( is_float($min) );
 -		assert ( is_float($max) );
 -		assert ( $min<=$max );
 -
 -		$this->_filters[] = array ( "type"=>SPH_FILTER_FLOATRANGE, "attr"=>$attribute, "exclude"=>$exclude, "min"=>$min, "max"=>$max );
 -	}
 -
 -	/// setup anchor point for geosphere distance calculations
 -	/// required to use @geodist in filters and sorting
 -	/// latitude and longitude must be in radians
 -	function SetGeoAnchor ( $attrlat, $attrlong, $lat, $long )
 -	{
 -		assert ( is_string($attrlat) );
 -		assert ( is_string($attrlong) );
 -		assert ( is_float($lat) );
 -		assert ( is_float($long) );
 -
 -		$this->_anchor = array ( "attrlat"=>$attrlat, "attrlong"=>$attrlong, "lat"=>$lat, "long"=>$long );
 -	}
 -
 -	/// set grouping attribute and function
 -	function SetGroupBy ( $attribute, $func, $groupsort="@group desc" )
 -	{
 -		assert ( is_string($attribute) );
 -		assert ( is_string($groupsort) );
 -		assert ( $func==SPH_GROUPBY_DAY
 -			|| $func==SPH_GROUPBY_WEEK
 -			|| $func==SPH_GROUPBY_MONTH
 -			|| $func==SPH_GROUPBY_YEAR
 -			|| $func==SPH_GROUPBY_ATTR
 -			|| $func==SPH_GROUPBY_ATTRPAIR );
 -
 -		$this->_groupby = $attribute;
 -		$this->_groupfunc = $func;
 -		$this->_groupsort = $groupsort;
 -	}
 -
 -	/// set count-distinct attribute for group-by queries
 -	function SetGroupDistinct ( $attribute )
 -	{
 -		assert ( is_string($attribute) );
 -		$this->_groupdistinct = $attribute;
 -	}
 -
 -	/// set distributed retries count and delay
 -	function SetRetries ( $count, $delay=0 )
 -	{
 -		assert ( is_int($count) && $count>=0 );
 -		assert ( is_int($delay) && $delay>=0 );
 -		$this->_retrycount = $count;
 -		$this->_retrydelay = $delay;
 -	}
 -
 -	/// set result set format (hash or array; hash by default)
 -	/// PHP specific; needed for group-by-MVA result sets that may contain duplicate IDs
 -	function SetArrayResult ( $arrayresult )
 -	{
 -		assert ( is_bool($arrayresult) );
 -		$this->_arrayresult = $arrayresult;
 -	}
 -
 -	/// set attribute values override
 -	/// there can be only one override per attribute
 -	/// $values must be a hash that maps document IDs to attribute values
 -	function SetOverride ( $attrname, $attrtype, $values )
 -	{
 -		assert ( is_string ( $attrname ) );
 -		assert ( in_array ( $attrtype, array ( SPH_ATTR_INTEGER, SPH_ATTR_TIMESTAMP, SPH_ATTR_BOOL, SPH_ATTR_FLOAT, SPH_ATTR_BIGINT ) ) );
 -		assert ( is_array ( $values ) );
 -
 -		$this->_overrides[$attrname] = array ( "attr"=>$attrname, "type"=>$attrtype, "values"=>$values );
 -	}
 -
 -	/// set select-list (attributes or expressions), SQL-like syntax
 -	function SetSelect ( $select )
 -	{
 -		assert ( is_string ( $select ) );
 -		$this->_select = $select;
 -	}
 -
 -	//////////////////////////////////////////////////////////////////////////////
 -
 -	/// clear all filters (for multi-queries)
 -	function ResetFilters ()
 -	{
 -		$this->_filters = array();
 -		$this->_anchor = array();
 -	}
 -
 -	/// clear groupby settings (for multi-queries)
 -	function ResetGroupBy ()
 -	{
 -		$this->_groupby		= "";
 -		$this->_groupfunc	= SPH_GROUPBY_DAY;
 -		$this->_groupsort	= "@group desc";
 -		$this->_groupdistinct= "";
 -	}
 -
 -	/// clear all attribute value overrides (for multi-queries)
 -	function ResetOverrides ()
 -    {
 -    	$this->_overrides = array ();
 -    }
 -
 -	//////////////////////////////////////////////////////////////////////////////
 -
 -	/// connect to searchd server, run given search query through given indexes,
 -	/// and return the search results
 -	function Query ( $query, $index="*", $comment="" )
 -	{
 -		assert ( empty($this->_reqs) );
 -
 -		$this->AddQuery ( $query, $index, $comment );
 -		$results = $this->RunQueries ();
 -		$this->_reqs = array (); // just in case it failed too early
 -
 -		if ( !is_array($results) )
 -			return false; // probably network error; error message should be already filled
 -
 -		$this->_error = $results[0]["error"];
 -		$this->_warning = $results[0]["warning"];
 -		if ( $results[0]["status"]==SEARCHD_ERROR )
 -			return false;
 -		else
 -			return $results[0];
 -	}
 -
 -	/// helper to pack floats in network byte order
 -	function _PackFloat ( $f )
 -	{
 -		$t1 = pack ( "f", $f ); // machine order
 -		list(,$t2) = unpack ( "L*", $t1 ); // int in machine order
 -		return pack ( "N", $t2 );
 -	}
 -
 -	/// add query to multi-query batch
 -	/// returns index into results array from RunQueries() call
 -	function AddQuery ( $query, $index="*", $comment="" )
 -	{
 -		// mbstring workaround
 -		$this->_MBPush ();
 -
 -		// build request
 -		$req = pack ( "NNNN", $this->_offset, $this->_limit, $this->_mode, $this->_ranker );
 -		if ( $this->_ranker==SPH_RANK_EXPR )
 -			$req .= pack ( "N", strlen($this->_rankexpr) ) . $this->_rankexpr;
 -		$req .= pack ( "N", $this->_sort ); // (deprecated) sort mode
 -		$req .= pack ( "N", strlen($this->_sortby) ) . $this->_sortby;
 -		$req .= pack ( "N", strlen($query) ) . $query; // query itself
 -		$req .= pack ( "N", count($this->_weights) ); // weights
 -		foreach ( $this->_weights as $weight )
 -			$req .= pack ( "N", (int)$weight );
 -		$req .= pack ( "N", strlen($index) ) . $index; // indexes
 -		$req .= pack ( "N", 1 ); // id64 range marker
 -		$req .= sphPackU64 ( $this->_min_id ) . sphPackU64 ( $this->_max_id ); // id64 range
 -
 -		// filters
 -		$req .= pack ( "N", count($this->_filters) );
 -		foreach ( $this->_filters as $filter )
 -		{
 -			$req .= pack ( "N", strlen($filter["attr"]) ) . $filter["attr"];
 -			$req .= pack ( "N", $filter["type"] );
 -			switch ( $filter["type"] )
 -			{
 -				case SPH_FILTER_VALUES:
 -					$req .= pack ( "N", count($filter["values"]) );
 -					foreach ( $filter["values"] as $value )
 -						$req .= sphPackI64 ( $value );
 -					break;
 -
 -				case SPH_FILTER_RANGE:
 -					$req .= sphPackI64 ( $filter["min"] ) . sphPackI64 ( $filter["max"] );
 -					break;
 -
 -				case SPH_FILTER_FLOATRANGE:
 -					$req .= $this->_PackFloat ( $filter["min"] ) . $this->_PackFloat ( $filter["max"] );
 -					break;
 -
 -				default:
 -					assert ( 0 && "internal error: unhandled filter type" );
 -			}
 -			$req .= pack ( "N", $filter["exclude"] );
 -		}
 -
 -		// group-by clause, max-matches count, group-sort clause, cutoff count
 -		$req .= pack ( "NN", $this->_groupfunc, strlen($this->_groupby) ) . $this->_groupby;
 -		$req .= pack ( "N", $this->_maxmatches );
 -		$req .= pack ( "N", strlen($this->_groupsort) ) . $this->_groupsort;
 -		$req .= pack ( "NNN", $this->_cutoff, $this->_retrycount, $this->_retrydelay );
 -		$req .= pack ( "N", strlen($this->_groupdistinct) ) . $this->_groupdistinct;
 -
 -		// anchor point
 -		if ( empty($this->_anchor) )
 -		{
 -			$req .= pack ( "N", 0 );
 -		} else
 -		{
 -			$a =& $this->_anchor;
 -			$req .= pack ( "N", 1 );
 -			$req .= pack ( "N", strlen($a["attrlat"]) ) . $a["attrlat"];
 -			$req .= pack ( "N", strlen($a["attrlong"]) ) . $a["attrlong"];
 -			$req .= $this->_PackFloat ( $a["lat"] ) . $this->_PackFloat ( $a["long"] );
 -		}
 -
 -		// per-index weights
 -		$req .= pack ( "N", count($this->_indexweights) );
 -		foreach ( $this->_indexweights as $idx=>$weight )
 -			$req .= pack ( "N", strlen($idx) ) . $idx . pack ( "N", $weight );
 -
 -		// max query time
 -		$req .= pack ( "N", $this->_maxquerytime );
 -
 -		// per-field weights
 -		$req .= pack ( "N", count($this->_fieldweights) );
 -		foreach ( $this->_fieldweights as $field=>$weight )
 -			$req .= pack ( "N", strlen($field) ) . $field . pack ( "N", $weight );
 -
 -		// comment
 -		$req .= pack ( "N", strlen($comment) ) . $comment;
 -
 -		// attribute overrides
 -		$req .= pack ( "N", count($this->_overrides) );
 -		foreach ( $this->_overrides as $key => $entry )
 -		{
 -			$req .= pack ( "N", strlen($entry["attr"]) ) . $entry["attr"];
 -			$req .= pack ( "NN", $entry["type"], count($entry["values"]) );
 -			foreach ( $entry["values"] as $id=>$val )
 -			{
 -				assert ( is_numeric($id) );
 -				assert ( is_numeric($val) );
 -
 -				$req .= sphPackU64 ( $id );
 -				switch ( $entry["type"] )
 -				{
 -					case SPH_ATTR_FLOAT:	$req .= $this->_PackFloat ( $val ); break;
 -					case SPH_ATTR_BIGINT:	$req .= sphPackI64 ( $val ); break;
 -					default:				$req .= pack ( "N", $val ); break;
 -				}
 -			}
 -		}
 -
 -		// select-list
 -		$req .= pack ( "N", strlen($this->_select) ) . $this->_select;
 -
 -		// mbstring workaround
 -		$this->_MBPop ();
 -
 -		// store request to requests array
 -		$this->_reqs[] = $req;
 -		return count($this->_reqs)-1;
 -	}
 -
 -	/// connect to searchd, run queries batch, and return an array of result sets
 -	function RunQueries ()
 -	{
 -		if ( empty($this->_reqs) )
 -		{
 -			$this->_error = "no queries defined, issue AddQuery() first";
 -			return false;
 -		}
 -
 -		// mbstring workaround
 -		$this->_MBPush ();
 -
 -		if (!( $fp = $this->_Connect() ))
 -		{
 -			$this->_MBPop ();
 -			return false;
 -		}
 -
 -		// send query, get response
 -		$nreqs = count($this->_reqs);
 -		$req = join ( "", $this->_reqs );
 -		$len = 8+strlen($req);
 -		$req = pack ( "nnNNN", SEARCHD_COMMAND_SEARCH, VER_COMMAND_SEARCH, $len, 0, $nreqs ) . $req; // add header
 -
 -		if ( !( $this->_Send ( $fp, $req, $len+8 ) ) ||
 -			 !( $response = $this->_GetResponse ( $fp, VER_COMMAND_SEARCH ) ) )
 -		{
 -			$this->_MBPop ();
 -			return false;
 -		}
 -
 -		// query sent ok; we can reset reqs now
 -		$this->_reqs = array ();
 -
 -		// parse and return response
 -		return $this->_ParseSearchResponse ( $response, $nreqs );
 -	}
 -
 -	/// parse and return search query (or queries) response
 -	function _ParseSearchResponse ( $response, $nreqs )
 -	{
 -		$p = 0; // current position
 -		$max = strlen($response); // max position for checks, to protect against broken responses
 -
 -		$results = array ();
 -		for ( $ires=0; $ires<$nreqs && $p<$max; $ires++ )
 -		{
 -			$results[] = array();
 -			$result =& $results[$ires];
 -
 -			$result["error"] = "";
 -			$result["warning"] = "";
 -
 -			// extract status
 -			list(,$status) = unpack ( "N*", substr ( $response, $p, 4 ) ); $p += 4;
 -			$result["status"] = $status;
 -			if ( $status!=SEARCHD_OK )
 -			{
 -				list(,$len) = unpack ( "N*", substr ( $response, $p, 4 ) ); $p += 4;
 -				$message = substr ( $response, $p, $len ); $p += $len;
 -
 -				if ( $status==SEARCHD_WARNING )
 -				{
 -					$result["warning"] = $message;
 -				} else
 -				{
 -					$result["error"] = $message;
 -					continue;
 -				}
 -			}
 -
 -			// read schema
 -			$fields = array ();
 -			$attrs = array ();
 -
 -			list(,$nfields) = unpack ( "N*", substr ( $response, $p, 4 ) ); $p += 4;
 -			while ( $nfields-->0 && $p<$max )
 -			{
 -				list(,$len) = unpack ( "N*", substr ( $response, $p, 4 ) ); $p += 4;
 -				$fields[] = substr ( $response, $p, $len ); $p += $len;
 -			}
 -			$result["fields"] = $fields;
 -
 -			list(,$nattrs) = unpack ( "N*", substr ( $response, $p, 4 ) ); $p += 4;
 -			while ( $nattrs-->0 && $p<$max  )
 -			{
 -				list(,$len) = unpack ( "N*", substr ( $response, $p, 4 ) ); $p += 4;
 -				$attr = substr ( $response, $p, $len ); $p += $len;
 -				list(,$type) = unpack ( "N*", substr ( $response, $p, 4 ) ); $p += 4;
 -				$attrs[$attr] = $type;
 -			}
 -			$result["attrs"] = $attrs;
 -
 -			// read match count
 -			list(,$count) = unpack ( "N*", substr ( $response, $p, 4 ) ); $p += 4;
 -			list(,$id64) = unpack ( "N*", substr ( $response, $p, 4 ) ); $p += 4;
 -
 -			// read matches
 -			$idx = -1;
 -			while ( $count-->0 && $p<$max )
 -			{
 -				// index into result array
 -				$idx++;
 -
 -				// parse document id and weight
 -				if ( $id64 )
 -				{
 -					$doc = sphUnpackU64 ( substr ( $response, $p, 8 ) ); $p += 8;
 -					list(,$weight) = unpack ( "N*", substr ( $response, $p, 4 ) ); $p += 4;
 -				}
 -				else
 -				{
 -					list ( $doc, $weight ) = array_values ( unpack ( "N*N*",
 -						substr ( $response, $p, 8 ) ) );
 -					$p += 8;
 -					$doc = sphFixUint($doc);
 -				}
 -				$weight = sprintf ( "%u", $weight );
 -
 -				// create match entry
 -				if ( $this->_arrayresult )
 -					$result["matches"][$idx] = array ( "id"=>$doc, "weight"=>$weight );
 -				else
 -					$result["matches"][$doc]["weight"] = $weight;
 -
 -				// parse and create attributes
 -				$attrvals = array ();
 -				foreach ( $attrs as $attr=>$type )
 -				{
 -					// handle 64bit ints
 -					if ( $type==SPH_ATTR_BIGINT )
 -					{
 -						$attrvals[$attr] = sphUnpackI64 ( substr ( $response, $p, 8 ) ); $p += 8;
 -						continue;
 -					}
 -
 -					// handle floats
 -					if ( $type==SPH_ATTR_FLOAT )
 -					{
 -						list(,$uval) = unpack ( "N*", substr ( $response, $p, 4 ) ); $p += 4;
 -						list(,$fval) = unpack ( "f*", pack ( "L", $uval ) ); 
 -						$attrvals[$attr] = $fval;
 -						continue;
 -					}
 -
 -					// handle everything else as unsigned ints
 -					list(,$val) = unpack ( "N*", substr ( $response, $p, 4 ) ); $p += 4;
 -					if ( $type==SPH_ATTR_MULTI )
 -					{
 -						$attrvals[$attr] = array ();
 -						$nvalues = $val;
 -						while ( $nvalues-->0 && $p<$max )
 -						{
 -							list(,$val) = unpack ( "N*", substr ( $response, $p, 4 ) ); $p += 4;
 -							$attrvals[$attr][] = sphFixUint($val);
 -						}
 -					} else if ( $type==SPH_ATTR_MULTI64 )
 -					{
 -						$attrvals[$attr] = array ();
 -						$nvalues = $val;
 -						while ( $nvalues>0 && $p<$max )
 -						{
 -							$attrvals[$attr][] = sphUnpackU64 ( substr ( $response, $p, 8 ) ); $p += 8;
 -							$nvalues -= 2;
 -						}
 -					} else if ( $type==SPH_ATTR_STRING )
 -					{
 -						$attrvals[$attr] = substr ( $response, $p, $val );
 -						$p += $val;						
 -					} else
 -					{
 -						$attrvals[$attr] = sphFixUint($val);
 -					}
 -				}
 -
 -				if ( $this->_arrayresult )
 -					$result["matches"][$idx]["attrs"] = $attrvals;
 -				else
 -					$result["matches"][$doc]["attrs"] = $attrvals;
 -			}
 -
 -			list ( $total, $total_found, $msecs, $words ) =
 -				array_values ( unpack ( "N*N*N*N*", substr ( $response, $p, 16 ) ) );
 -			$result["total"] = sprintf ( "%u", $total );
 -			$result["total_found"] = sprintf ( "%u", $total_found );
 -			$result["time"] = sprintf ( "%.3f", $msecs/1000 );
 -			$p += 16;
 -
 -			while ( $words-->0 && $p<$max )
 -			{
 -				list(,$len) = unpack ( "N*", substr ( $response, $p, 4 ) ); $p += 4;
 -				$word = substr ( $response, $p, $len ); $p += $len;
 -				list ( $docs, $hits ) = array_values ( unpack ( "N*N*", substr ( $response, $p, 8 ) ) ); $p += 8;
 -				$result["words"][$word] = array (
 -					"docs"=>sprintf ( "%u", $docs ),
 -					"hits"=>sprintf ( "%u", $hits ) );
 -			}
 -		}
 -
 -		$this->_MBPop ();
 -		return $results;
 -	}
 -
 -	/////////////////////////////////////////////////////////////////////////////
 -	// excerpts generation
 -	/////////////////////////////////////////////////////////////////////////////
 -
 -	/// connect to searchd server, and generate exceprts (snippets)
 -	/// of given documents for given query. returns false on failure,
 -	/// an array of snippets on success
 -	function BuildExcerpts ( $docs, $index, $words, $opts=array() )
 -	{
 -		assert ( is_array($docs) );
 -		assert ( is_string($index) );
 -		assert ( is_string($words) );
 -		assert ( is_array($opts) );
 -
 -		$this->_MBPush ();
 -
 -		if (!( $fp = $this->_Connect() ))
 -		{
 -			$this->_MBPop();
 -			return false;
 -		}
 -
 -		/////////////////
 -		// fixup options
 -		/////////////////
 -
 -		if ( !isset($opts["before_match"]) )		$opts["before_match"] = "<b>";
 -		if ( !isset($opts["after_match"]) )			$opts["after_match"] = "</b>";
 -		if ( !isset($opts["chunk_separator"]) )		$opts["chunk_separator"] = " ... ";
 -		if ( !isset($opts["limit"]) )				$opts["limit"] = 256;
 -		if ( !isset($opts["limit_passages"]) )		$opts["limit_passages"] = 0;
 -		if ( !isset($opts["limit_words"]) )			$opts["limit_words"] = 0;
 -		if ( !isset($opts["around"]) )				$opts["around"] = 5;
 -		if ( !isset($opts["exact_phrase"]) )		$opts["exact_phrase"] = false;
 -		if ( !isset($opts["single_passage"]) )		$opts["single_passage"] = false;
 -		if ( !isset($opts["use_boundaries"]) )		$opts["use_boundaries"] = false;
 -		if ( !isset($opts["weight_order"]) )		$opts["weight_order"] = false;
 -		if ( !isset($opts["query_mode"]) )			$opts["query_mode"] = false;
 -		if ( !isset($opts["force_all_words"]) )		$opts["force_all_words"] = false;
 -		if ( !isset($opts["start_passage_id"]) )	$opts["start_passage_id"] = 1;
 -		if ( !isset($opts["load_files"]) )			$opts["load_files"] = false;
 -		if ( !isset($opts["html_strip_mode"]) )		$opts["html_strip_mode"] = "index";
 -		if ( !isset($opts["allow_empty"]) )			$opts["allow_empty"] = false;
 -		if ( !isset($opts["passage_boundary"]) )	$opts["passage_boundary"] = "none";
 -		if ( !isset($opts["emit_zones"]) )			$opts["emit_zones"] = false;
 -		if ( !isset($opts["load_files_scattered"]) )		$opts["load_files_scattered"] = false;
 -		
 -
 -		/////////////////
 -		// build request
 -		/////////////////
 -
 -		// v.1.2 req
 -		$flags = 1; // remove spaces
 -		if ( $opts["exact_phrase"] )	$flags |= 2;
 -		if ( $opts["single_passage"] )	$flags |= 4;
 -		if ( $opts["use_boundaries"] )	$flags |= 8;
 -		if ( $opts["weight_order"] )	$flags |= 16;
 -		if ( $opts["query_mode"] )		$flags |= 32;
 -		if ( $opts["force_all_words"] )	$flags |= 64;
 -		if ( $opts["load_files"] )		$flags |= 128;
 -		if ( $opts["allow_empty"] )		$flags |= 256;
 -		if ( $opts["emit_zones"] )		$flags |= 512;
 -		if ( $opts["load_files_scattered"] )	$flags |= 1024;
 -		$req = pack ( "NN", 0, $flags ); // mode=0, flags=$flags
 -		$req .= pack ( "N", strlen($index) ) . $index; // req index
 -		$req .= pack ( "N", strlen($words) ) . $words; // req words
 -
 -		// options
 -		$req .= pack ( "N", strlen($opts["before_match"]) ) . $opts["before_match"];
 -		$req .= pack ( "N", strlen($opts["after_match"]) ) . $opts["after_match"];
 -		$req .= pack ( "N", strlen($opts["chunk_separator"]) ) . $opts["chunk_separator"];
 -		$req .= pack ( "NN", (int)$opts["limit"], (int)$opts["around"] );
 -		$req .= pack ( "NNN", (int)$opts["limit_passages"], (int)$opts["limit_words"], (int)$opts["start_passage_id"] ); // v.1.2
 -		$req .= pack ( "N", strlen($opts["html_strip_mode"]) ) . $opts["html_strip_mode"];
 -		$req .= pack ( "N", strlen($opts["passage_boundary"]) ) . $opts["passage_boundary"];
 -
 -		// documents
 -		$req .= pack ( "N", count($docs) );
 -		foreach ( $docs as $doc )
 -		{
 -			assert ( is_string($doc) );
 -			$req .= pack ( "N", strlen($doc) ) . $doc;
 -		}
 -
 -		////////////////////////////
 -		// send query, get response
 -		////////////////////////////
 -
 -		$len = strlen($req);
 -		$req = pack ( "nnN", SEARCHD_COMMAND_EXCERPT, VER_COMMAND_EXCERPT, $len ) . $req; // add header
 -		if ( !( $this->_Send ( $fp, $req, $len+8 ) ) ||
 -			 !( $response = $this->_GetResponse ( $fp, VER_COMMAND_EXCERPT ) ) )
 -		{
 -			$this->_MBPop ();
 -			return false;
 -		}
 -
 -		//////////////////
 -		// parse response
 -		//////////////////
 -
 -		$pos = 0;
 -		$res = array ();
 -		$rlen = strlen($response);
 -		for ( $i=0; $i<count($docs); $i++ )
 -		{
 -			list(,$len) = unpack ( "N*", substr ( $response, $pos, 4 ) );
 -			$pos += 4;
 -
 -			if ( $pos+$len > $rlen )
 -			{
 -				$this->_error = "incomplete reply";
 -				$this->_MBPop ();
 -				return false;
 -			}
 -			$res[] = $len ? substr ( $response, $pos, $len ) : "";
 -			$pos += $len;
 -		}
 -
 -		$this->_MBPop ();
 -		return $res;
 -	}
 -
 -
 -	/////////////////////////////////////////////////////////////////////////////
 -	// keyword generation
 -	/////////////////////////////////////////////////////////////////////////////
 -
 -	/// connect to searchd server, and generate keyword list for a given query
 -	/// returns false on failure,
 -	/// an array of words on success
 -	function BuildKeywords ( $query, $index, $hits )
 -	{
 -		assert ( is_string($query) );
 -		assert ( is_string($index) );
 -		assert ( is_bool($hits) );
 -
 -		$this->_MBPush ();
 -
 -		if (!( $fp = $this->_Connect() ))
 -		{
 -			$this->_MBPop();
 -			return false;
 -		}
 -
 -		/////////////////
 -		// build request
 -		/////////////////
 -
 -		// v.1.0 req
 -		$req  = pack ( "N", strlen($query) ) . $query; // req query
 -		$req .= pack ( "N", strlen($index) ) . $index; // req index
 -		$req .= pack ( "N", (int)$hits );
 -
 -		////////////////////////////
 -		// send query, get response
 -		////////////////////////////
 -
 -		$len = strlen($req);
 -		$req = pack ( "nnN", SEARCHD_COMMAND_KEYWORDS, VER_COMMAND_KEYWORDS, $len ) . $req; // add header
 -		if ( !( $this->_Send ( $fp, $req, $len+8 ) ) ||
 -			 !( $response = $this->_GetResponse ( $fp, VER_COMMAND_KEYWORDS ) ) )
 -		{
 -			$this->_MBPop ();
 -			return false;
 -		}
 -
 -		//////////////////
 -		// parse response
 -		//////////////////
 -
 -		$pos = 0;
 -		$res = array ();
 -		$rlen = strlen($response);
 -		list(,$nwords) = unpack ( "N*", substr ( $response, $pos, 4 ) );
 -		$pos += 4;
 -		for ( $i=0; $i<$nwords; $i++ )
 -		{
 -			list(,$len) = unpack ( "N*", substr ( $response, $pos, 4 ) );	$pos += 4;
 -			$tokenized = $len ? substr ( $response, $pos, $len ) : "";
 -			$pos += $len;
 -
 -			list(,$len) = unpack ( "N*", substr ( $response, $pos, 4 ) );	$pos += 4;
 -			$normalized = $len ? substr ( $response, $pos, $len ) : "";
 -			$pos += $len;
 -
 -			$res[] = array ( "tokenized"=>$tokenized, "normalized"=>$normalized );
 -
 -			if ( $hits )
 -			{
 -				list($ndocs,$nhits) = array_values ( unpack ( "N*N*", substr ( $response, $pos, 8 ) ) );
 -				$pos += 8;
 -				$res [$i]["docs"] = $ndocs;
 -				$res [$i]["hits"] = $nhits;
 -			}
 -
 -			if ( $pos > $rlen )
 -			{
 -				$this->_error = "incomplete reply";
 -				$this->_MBPop ();
 -				return false;
 -			}
 -		}
 -
 -		$this->_MBPop ();
 -		return $res;
 -	}
 -
 -	function EscapeString ( $string )
 -	{
 -		$from = array ( '\\', '(',')','|','-','!','@','~','"','&', '/', '^', '$', '=' );
 -		$to   = array ( '\\\\', '\(','\)','\|','\-','\!','\@','\~','\"', '\&', '\/', '\^', '\$', '\=' );
 -
 -		return str_replace ( $from, $to, $string );
 -	}
 -
 -	/////////////////////////////////////////////////////////////////////////////
 -	// attribute updates
 -	/////////////////////////////////////////////////////////////////////////////
 -
 -	/// batch update given attributes in given rows in given indexes
 -	/// returns amount of updated documents (0 or more) on success, or -1 on failure
 -	function UpdateAttributes ( $index, $attrs, $values, $mva=false )
 -	{
 -		// verify everything
 -		assert ( is_string($index) );
 -		assert ( is_bool($mva) );
 -
 -		assert ( is_array($attrs) );
 -		foreach ( $attrs as $attr )
 -			assert ( is_string($attr) );
 -
 -		assert ( is_array($values) );
 -		foreach ( $values as $id=>$entry )
 -		{
 -			assert ( is_numeric($id) );
 -			assert ( is_array($entry) );
 -			assert ( count($entry)==count($attrs) );
 -			foreach ( $entry as $v )
 -			{
 -				if ( $mva )
 -				{
 -					assert ( is_array($v) );
 -					foreach ( $v as $vv )
 -						assert ( is_int($vv) );
 -				} else
 -					assert ( is_int($v) );
 -			}
 -		}
 -
 -		// build request
 -		$this->_MBPush ();
 -		$req = pack ( "N", strlen($index) ) . $index;
 -
 -		$req .= pack ( "N", count($attrs) );
 -		foreach ( $attrs as $attr )
 -		{
 -			$req .= pack ( "N", strlen($attr) ) . $attr;
 -			$req .= pack ( "N", $mva ? 1 : 0 );
 -		}
 -
 -		$req .= pack ( "N", count($values) );
 -		foreach ( $values as $id=>$entry )
 -		{
 -			$req .= sphPackU64 ( $id );
 -			foreach ( $entry as $v )
 -			{
 -				$req .= pack ( "N", $mva ? count($v) : $v );
 -				if ( $mva )
 -					foreach ( $v as $vv )
 -						$req .= pack ( "N", $vv );
 -			}
 -		}
 -
 -		// connect, send query, get response
 -		if (!( $fp = $this->_Connect() ))
 -		{
 -			$this->_MBPop ();
 -			return -1;
 -		}
 -
 -		$len = strlen($req);
 -		$req = pack ( "nnN", SEARCHD_COMMAND_UPDATE, VER_COMMAND_UPDATE, $len ) . $req; // add header
 -		if ( !$this->_Send ( $fp, $req, $len+8 ) )
 -		{
 -			$this->_MBPop ();
 -			return -1;
 -		}
 -
 -		if (!( $response = $this->_GetResponse ( $fp, VER_COMMAND_UPDATE ) ))
 -		{
 -			$this->_MBPop ();
 -			return -1;
 -		}
 -
 -		// parse response
 -		list(,$updated) = unpack ( "N*", substr ( $response, 0, 4 ) );
 -		$this->_MBPop ();
 -		return $updated;
 -	}
 -
 -	/////////////////////////////////////////////////////////////////////////////
 -	// persistent connections
 -	/////////////////////////////////////////////////////////////////////////////
 -
 -	function Open()
 -	{
 -		if ( $this->_socket !== false )
 -		{
 -			$this->_error = 'already connected';
 -			return false;
 -		}
 -		if ( !$fp = $this->_Connect() )
 -			return false;
 -
 -		// command, command version = 0, body length = 4, body = 1
 -		$req = pack ( "nnNN", SEARCHD_COMMAND_PERSIST, 0, 4, 1 );
 -		if ( !$this->_Send ( $fp, $req, 12 ) )
 -			return false;
 -
 -		$this->_socket = $fp;
 -		return true;
 -	}
 -
 -	function Close()
 -	{
 -		if ( $this->_socket === false )
 -		{
 -			$this->_error = 'not connected';
 -			return false;
 -		}
 -
 -		fclose ( $this->_socket );
 -		$this->_socket = false;
 -		
 -		return true;
 -	}
 -
 -	//////////////////////////////////////////////////////////////////////////
 -	// status
 -	//////////////////////////////////////////////////////////////////////////
 -
 -	function Status ()
 -	{
 -		$this->_MBPush ();
 -		if (!( $fp = $this->_Connect() ))
 -		{
 -			$this->_MBPop();
 -			return false;
 -		}
 -
 -		$req = pack ( "nnNN", SEARCHD_COMMAND_STATUS, VER_COMMAND_STATUS, 4, 1 ); // len=4, body=1
 -		if ( !( $this->_Send ( $fp, $req, 12 ) ) ||
 -			 !( $response = $this->_GetResponse ( $fp, VER_COMMAND_STATUS ) ) )
 -		{
 -			$this->_MBPop ();
 -			return false;
 -		}
 -
 -		$res = substr ( $response, 4 ); // just ignore length, error handling, etc
 -		$p = 0;
 -		list ( $rows, $cols ) = array_values ( unpack ( "N*N*", substr ( $response, $p, 8 ) ) ); $p += 8;
 -
 -		$res = array();
 -		for ( $i=0; $i<$rows; $i++ )
 -			for ( $j=0; $j<$cols; $j++ )
 -		{
 -			list(,$len) = unpack ( "N*", substr ( $response, $p, 4 ) ); $p += 4;
 -			$res[$i][] = substr ( $response, $p, $len ); $p += $len;
 -		}
 -
 -		$this->_MBPop ();
 -		return $res;
 -	}
 -
 -	//////////////////////////////////////////////////////////////////////////
 -	// flush
 -	//////////////////////////////////////////////////////////////////////////
 -
 -	function FlushAttributes ()
 -	{
 -		$this->_MBPush ();
 -		if (!( $fp = $this->_Connect() ))
 -		{
 -			$this->_MBPop();
 -			return -1;
 -		}
 -
 -		$req = pack ( "nnN", SEARCHD_COMMAND_FLUSHATTRS, VER_COMMAND_FLUSHATTRS, 0 ); // len=0
 -		if ( !( $this->_Send ( $fp, $req, 8 ) ) ||
 -			 !( $response = $this->_GetResponse ( $fp, VER_COMMAND_FLUSHATTRS ) ) )
 -		{
 -			$this->_MBPop ();
 -			return -1;
 -		}
 -
 -		$tag = -1;
 -		if ( strlen($response)==4 )
 -			list(,$tag) = unpack ( "N*", $response );
 -		else
 -			$this->_error = "unexpected response length";
 -
 -		$this->_MBPop ();
 -		return $tag;
 -	}
 -}
 -
 -//
 -// $Id: sphinxapi.php 3087 2012-01-30 23:07:35Z shodan $
 -//
 +<?php + +// +// $Id: sphinxapi.php 3087 2012-01-30 23:07:35Z shodan $ +// + +// +// Copyright (c) 2001-2012, Andrew Aksyonoff +// Copyright (c) 2008-2012, Sphinx Technologies Inc +// All rights reserved +// +// This program is free software; you can redistribute it and/or modify +// it under the terms of the GNU General Public License. You should have +// received a copy of the GPL license along with this program; if you +// did not, you can find it at http://www.gnu.org/ +// + +///////////////////////////////////////////////////////////////////////////// +// PHP version of Sphinx searchd client (PHP API) +///////////////////////////////////////////////////////////////////////////// + +/// known searchd commands +define ( "SEARCHD_COMMAND_SEARCH",		0 ); +define ( "SEARCHD_COMMAND_EXCERPT",		1 ); +define ( "SEARCHD_COMMAND_UPDATE",		2 ); +define ( "SEARCHD_COMMAND_KEYWORDS",	3 ); +define ( "SEARCHD_COMMAND_PERSIST",		4 ); +define ( "SEARCHD_COMMAND_STATUS",		5 ); +define ( "SEARCHD_COMMAND_FLUSHATTRS",	7 ); + +/// current client-side command implementation versions +define ( "VER_COMMAND_SEARCH",		0x119 ); +define ( "VER_COMMAND_EXCERPT",		0x104 ); +define ( "VER_COMMAND_UPDATE",		0x102 ); +define ( "VER_COMMAND_KEYWORDS",	0x100 ); +define ( "VER_COMMAND_STATUS",		0x100 ); +define ( "VER_COMMAND_QUERY",		0x100 ); +define ( "VER_COMMAND_FLUSHATTRS",	0x100 ); + +/// known searchd status codes +define ( "SEARCHD_OK",				0 ); +define ( "SEARCHD_ERROR",			1 ); +define ( "SEARCHD_RETRY",			2 ); +define ( "SEARCHD_WARNING",			3 ); + +/// known match modes +define ( "SPH_MATCH_ALL",			0 ); +define ( "SPH_MATCH_ANY",			1 ); +define ( "SPH_MATCH_PHRASE",		2 ); +define ( "SPH_MATCH_BOOLEAN",		3 ); +define ( "SPH_MATCH_EXTENDED",		4 ); +define ( "SPH_MATCH_FULLSCAN",		5 ); +define ( "SPH_MATCH_EXTENDED2",		6 );	// extended engine V2 (TEMPORARY, WILL BE REMOVED) + +/// known ranking modes (ext2 only) +define ( "SPH_RANK_PROXIMITY_BM25",	0 );	///< default mode, phrase proximity major factor and BM25 minor one +define ( "SPH_RANK_BM25",			1 );	///< statistical mode, BM25 ranking only (faster but worse quality) +define ( "SPH_RANK_NONE",			2 );	///< no ranking, all matches get a weight of 1 +define ( "SPH_RANK_WORDCOUNT",		3 );	///< simple word-count weighting, rank is a weighted sum of per-field keyword occurence counts +define ( "SPH_RANK_PROXIMITY",		4 ); +define ( "SPH_RANK_MATCHANY",		5 ); +define ( "SPH_RANK_FIELDMASK",		6 ); +define ( "SPH_RANK_SPH04",			7 ); +define ( "SPH_RANK_EXPR",			8 ); +define ( "SPH_RANK_TOTAL",			9 ); + +/// known sort modes +define ( "SPH_SORT_RELEVANCE",		0 ); +define ( "SPH_SORT_ATTR_DESC",		1 ); +define ( "SPH_SORT_ATTR_ASC",		2 ); +define ( "SPH_SORT_TIME_SEGMENTS", 	3 ); +define ( "SPH_SORT_EXTENDED", 		4 ); +define ( "SPH_SORT_EXPR", 			5 ); + +/// known filter types +define ( "SPH_FILTER_VALUES",		0 ); +define ( "SPH_FILTER_RANGE",		1 ); +define ( "SPH_FILTER_FLOATRANGE",	2 ); + +/// known attribute types +define ( "SPH_ATTR_INTEGER",		1 ); +define ( "SPH_ATTR_TIMESTAMP",		2 ); +define ( "SPH_ATTR_ORDINAL",		3 ); +define ( "SPH_ATTR_BOOL",			4 ); +define ( "SPH_ATTR_FLOAT",			5 ); +define ( "SPH_ATTR_BIGINT",			6 ); +define ( "SPH_ATTR_STRING",			7 ); +define ( "SPH_ATTR_MULTI",			0x40000001 ); +define ( "SPH_ATTR_MULTI64",			0x40000002 ); + +/// known grouping functions +define ( "SPH_GROUPBY_DAY",			0 ); +define ( "SPH_GROUPBY_WEEK",		1 ); +define ( "SPH_GROUPBY_MONTH",		2 ); +define ( "SPH_GROUPBY_YEAR",		3 ); +define ( "SPH_GROUPBY_ATTR",		4 ); +define ( "SPH_GROUPBY_ATTRPAIR",	5 ); + +// important properties of PHP's integers: +//  - always signed (one bit short of PHP_INT_SIZE) +//  - conversion from string to int is saturated +//  - float is double +//  - div converts arguments to floats +//  - mod converts arguments to ints + +// the packing code below works as follows: +//  - when we got an int, just pack it +//    if performance is a problem, this is the branch users should aim for +// +//  - otherwise, we got a number in string form +//    this might be due to different reasons, but we assume that this is +//    because it didn't fit into PHP int +// +//  - factor the string into high and low ints for packing +//    - if we have bcmath, then it is used +//    - if we don't, we have to do it manually (this is the fun part) +// +//    - x64 branch does factoring using ints +//    - x32 (ab)uses floats, since we can't fit unsigned 32-bit number into an int +// +// unpacking routines are pretty much the same. +//  - return ints if we can +//  - otherwise format number into a string + +/// pack 64-bit signed +function sphPackI64 ( $v ) +{ +	assert ( is_numeric($v) ); +	 +	// x64 +	if ( PHP_INT_SIZE>=8 ) +	{ +		$v = (int)$v; +		return pack ( "NN", $v>>32, $v&0xFFFFFFFF ); +	} + +	// x32, int +	if ( is_int($v) ) +		return pack ( "NN", $v < 0 ? -1 : 0, $v ); + +	// x32, bcmath	 +	if ( function_exists("bcmul") ) +	{ +		if ( bccomp ( $v, 0 ) == -1 ) +			$v = bcadd ( "18446744073709551616", $v ); +		$h = bcdiv ( $v, "4294967296", 0 ); +		$l = bcmod ( $v, "4294967296" ); +		return pack ( "NN", (float)$h, (float)$l ); // conversion to float is intentional; int would lose 31st bit +	} + +	// x32, no-bcmath +	$p = max(0, strlen($v) - 13); +	$lo = abs((float)substr($v, $p)); +	$hi = abs((float)substr($v, 0, $p)); + +	$m = $lo + $hi*1316134912.0; // (10 ^ 13) % (1 << 32) = 1316134912 +	$q = floor($m/4294967296.0); +	$l = $m - ($q*4294967296.0); +	$h = $hi*2328.0 + $q; // (10 ^ 13) / (1 << 32) = 2328 + +	if ( $v<0 ) +	{ +		if ( $l==0 ) +			$h = 4294967296.0 - $h; +		else +		{ +			$h = 4294967295.0 - $h; +			$l = 4294967296.0 - $l; +		} +	} +	return pack ( "NN", $h, $l ); +} + +/// pack 64-bit unsigned +function sphPackU64 ( $v ) +{ +	assert ( is_numeric($v) ); +	 +	// x64 +	if ( PHP_INT_SIZE>=8 ) +	{ +		assert ( $v>=0 ); +		 +		// x64, int +		if ( is_int($v) ) +			return pack ( "NN", $v>>32, $v&0xFFFFFFFF ); +						   +		// x64, bcmath +		if ( function_exists("bcmul") ) +		{ +			$h = bcdiv ( $v, 4294967296, 0 ); +			$l = bcmod ( $v, 4294967296 ); +			return pack ( "NN", $h, $l ); +		} +		 +		// x64, no-bcmath +		$p = max ( 0, strlen($v) - 13 ); +		$lo = (int)substr ( $v, $p ); +		$hi = (int)substr ( $v, 0, $p ); +	 +		$m = $lo + $hi*1316134912; +		$l = $m % 4294967296; +		$h = $hi*2328 + (int)($m/4294967296); + +		return pack ( "NN", $h, $l ); +	} + +	// x32, int +	if ( is_int($v) ) +		return pack ( "NN", 0, $v ); +	 +	// x32, bcmath +	if ( function_exists("bcmul") ) +	{ +		$h = bcdiv ( $v, "4294967296", 0 ); +		$l = bcmod ( $v, "4294967296" ); +		return pack ( "NN", (float)$h, (float)$l ); // conversion to float is intentional; int would lose 31st bit +	} + +	// x32, no-bcmath +	$p = max(0, strlen($v) - 13); +	$lo = (float)substr($v, $p); +	$hi = (float)substr($v, 0, $p); +	 +	$m = $lo + $hi*1316134912.0; +	$q = floor($m / 4294967296.0); +	$l = $m - ($q * 4294967296.0); +	$h = $hi*2328.0 + $q; + +	return pack ( "NN", $h, $l ); +} + +// unpack 64-bit unsigned +function sphUnpackU64 ( $v ) +{ +	list ( $hi, $lo ) = array_values ( unpack ( "N*N*", $v ) ); + +	if ( PHP_INT_SIZE>=8 ) +	{ +		if ( $hi<0 ) $hi += (1<<32); // because php 5.2.2 to 5.2.5 is totally fucked up again +		if ( $lo<0 ) $lo += (1<<32); + +		// x64, int +		if ( $hi<=2147483647 ) +			return ($hi<<32) + $lo; + +		// x64, bcmath +		if ( function_exists("bcmul") ) +			return bcadd ( $lo, bcmul ( $hi, "4294967296" ) ); + +		// x64, no-bcmath +		$C = 100000; +		$h = ((int)($hi / $C) << 32) + (int)($lo / $C); +		$l = (($hi % $C) << 32) + ($lo % $C); +		if ( $l>$C ) +		{ +			$h += (int)($l / $C); +			$l  = $l % $C; +		} + +		if ( $h==0 ) +			return $l; +		return sprintf ( "%d%05d", $h, $l ); +	} + +	// x32, int +	if ( $hi==0 ) +	{ +		if ( $lo>0 ) +			return $lo; +		return sprintf ( "%u", $lo ); +	} + +	$hi = sprintf ( "%u", $hi ); +	$lo = sprintf ( "%u", $lo ); + +	// x32, bcmath +	if ( function_exists("bcmul") ) +		return bcadd ( $lo, bcmul ( $hi, "4294967296" ) ); +	 +	// x32, no-bcmath +	$hi = (float)$hi; +	$lo = (float)$lo; +	 +	$q = floor($hi/10000000.0); +	$r = $hi - $q*10000000.0; +	$m = $lo + $r*4967296.0; +	$mq = floor($m/10000000.0); +	$l = $m - $mq*10000000.0; +	$h = $q*4294967296.0 + $r*429.0 + $mq; + +	$h = sprintf ( "%.0f", $h ); +	$l = sprintf ( "%07.0f", $l ); +	if ( $h=="0" ) +		return sprintf( "%.0f", (float)$l ); +	return $h . $l; +} + +// unpack 64-bit signed +function sphUnpackI64 ( $v ) +{ +	list ( $hi, $lo ) = array_values ( unpack ( "N*N*", $v ) ); + +	// x64 +	if ( PHP_INT_SIZE>=8 ) +	{ +		if ( $hi<0 ) $hi += (1<<32); // because php 5.2.2 to 5.2.5 is totally fucked up again +		if ( $lo<0 ) $lo += (1<<32); + +		return ($hi<<32) + $lo; +	} + +	// x32, int +	if ( $hi==0 ) +	{ +		if ( $lo>0 ) +			return $lo; +		return sprintf ( "%u", $lo ); +	} +	// x32, int +	elseif ( $hi==-1 ) +	{ +		if ( $lo<0 ) +			return $lo; +		return sprintf ( "%.0f", $lo - 4294967296.0 ); +	} +	 +	$neg = ""; +	$c = 0; +	if ( $hi<0 ) +	{ +		$hi = ~$hi; +		$lo = ~$lo; +		$c = 1; +		$neg = "-"; +	}	 + +	$hi = sprintf ( "%u", $hi ); +	$lo = sprintf ( "%u", $lo ); + +	// x32, bcmath +	if ( function_exists("bcmul") ) +		return $neg . bcadd ( bcadd ( $lo, bcmul ( $hi, "4294967296" ) ), $c ); + +	// x32, no-bcmath +	$hi = (float)$hi; +	$lo = (float)$lo; +	 +	$q = floor($hi/10000000.0); +	$r = $hi - $q*10000000.0; +	$m = $lo + $r*4967296.0; +	$mq = floor($m/10000000.0); +	$l = $m - $mq*10000000.0 + $c; +	$h = $q*4294967296.0 + $r*429.0 + $mq; +	if ( $l==10000000 ) +	{ +		$l = 0; +		$h += 1; +	} + +	$h = sprintf ( "%.0f", $h ); +	$l = sprintf ( "%07.0f", $l ); +	if ( $h=="0" ) +		return $neg . sprintf( "%.0f", (float)$l ); +	return $neg . $h . $l; +} + + +function sphFixUint ( $value ) +{ +	if ( PHP_INT_SIZE>=8 ) +	{ +		// x64 route, workaround broken unpack() in 5.2.2+ +		if ( $value<0 ) $value += (1<<32); +		return $value; +	} +	else +	{ +		// x32 route, workaround php signed/unsigned braindamage +		return sprintf ( "%u", $value ); +	} +} + + +/// sphinx searchd client class +class SphinxClient +{ +	var $_host;			///< searchd host (default is "localhost") +	var $_port;			///< searchd port (default is 9312) +	var $_offset;		///< how many records to seek from result-set start (default is 0) +	var $_limit;		///< how many records to return from result-set starting at offset (default is 20) +	var $_mode;			///< query matching mode (default is SPH_MATCH_ALL) +	var $_weights;		///< per-field weights (default is 1 for all fields) +	var $_sort;			///< match sorting mode (default is SPH_SORT_RELEVANCE) +	var $_sortby;		///< attribute to sort by (defualt is "") +	var $_min_id;		///< min ID to match (default is 0, which means no limit) +	var $_max_id;		///< max ID to match (default is 0, which means no limit) +	var $_filters;		///< search filters +	var $_groupby;		///< group-by attribute name +	var $_groupfunc;	///< group-by function (to pre-process group-by attribute value with) +	var $_groupsort;	///< group-by sorting clause (to sort groups in result set with) +	var $_groupdistinct;///< group-by count-distinct attribute +	var $_maxmatches;	///< max matches to retrieve +	var $_cutoff;		///< cutoff to stop searching at (default is 0) +	var $_retrycount;	///< distributed retries count +	var $_retrydelay;	///< distributed retries delay +	var $_anchor;		///< geographical anchor point +	var $_indexweights;	///< per-index weights +	var $_ranker;		///< ranking mode (default is SPH_RANK_PROXIMITY_BM25) +	var $_rankexpr;		///< ranking mode expression (for SPH_RANK_EXPR) +	var $_maxquerytime;	///< max query time, milliseconds (default is 0, do not limit) +	var $_fieldweights;	///< per-field-name weights +	var $_overrides;	///< per-query attribute values overrides +	var $_select;		///< select-list (attributes or expressions, with optional aliases) + +	var $_error;		///< last error message +	var $_warning;		///< last warning message +	var $_connerror;		///< connection error vs remote error flag + +	var $_reqs;			///< requests array for multi-query +	var $_mbenc;		///< stored mbstring encoding +	var $_arrayresult;	///< whether $result["matches"] should be a hash or an array +	var $_timeout;		///< connect timeout + +	///////////////////////////////////////////////////////////////////////////// +	// common stuff +	///////////////////////////////////////////////////////////////////////////// + +	/// create a new client object and fill defaults +	function SphinxClient () +	{ +		// per-client-object settings +		$this->_host		= "localhost"; +		$this->_port		= 9312; +		$this->_path		= false; +		$this->_socket		= false; + +		// per-query settings +		$this->_offset		= 0; +		$this->_limit		= 20; +		$this->_mode		= SPH_MATCH_ALL; +		$this->_weights		= array (); +		$this->_sort		= SPH_SORT_RELEVANCE; +		$this->_sortby		= ""; +		$this->_min_id		= 0; +		$this->_max_id		= 0; +		$this->_filters		= array (); +		$this->_groupby		= ""; +		$this->_groupfunc	= SPH_GROUPBY_DAY; +		$this->_groupsort	= "@group desc"; +		$this->_groupdistinct= ""; +		$this->_maxmatches	= 1000; +		$this->_cutoff		= 0; +		$this->_retrycount	= 0; +		$this->_retrydelay	= 0; +		$this->_anchor		= array (); +		$this->_indexweights= array (); +		$this->_ranker		= SPH_RANK_PROXIMITY_BM25; +		$this->_rankexpr	= ""; +		$this->_maxquerytime= 0; +		$this->_fieldweights= array(); +		$this->_overrides 	= array(); +		$this->_select		= "*"; + +		$this->_error		= ""; // per-reply fields (for single-query case) +		$this->_warning		= ""; +		$this->_connerror	= false; + +		$this->_reqs		= array ();	// requests storage (for multi-query case) +		$this->_mbenc		= ""; +		$this->_arrayresult	= false; +		$this->_timeout		= 0; +	} + +	function __destruct() +	{ +		if ( $this->_socket !== false ) +			fclose ( $this->_socket ); +	} + +	/// get last error message (string) +	function GetLastError () +	{ +		return $this->_error; +	} + +	/// get last warning message (string) +	function GetLastWarning () +	{ +		return $this->_warning; +	} + +	/// get last error flag (to tell network connection errors from searchd errors or broken responses) +	function IsConnectError() +	{ +		return $this->_connerror; +	} + +	/// set searchd host name (string) and port (integer) +	function SetServer ( $host, $port = 0 ) +	{ +		assert ( is_string($host) ); +		if ( $host[0] == '/') +		{ +			$this->_path = 'unix://' . $host; +			return; +		} +		if ( substr ( $host, 0, 7 )=="unix://" ) +		{ +			$this->_path = $host; +			return; +		} +				 +		assert ( is_int($port) ); +		$this->_host = $host; +		$this->_port = $port; +		$this->_path = ''; + +	} + +	/// set server connection timeout (0 to remove) +	function SetConnectTimeout ( $timeout ) +	{ +		assert ( is_numeric($timeout) ); +		$this->_timeout = $timeout; +	} + + +	function _Send ( $handle, $data, $length ) +	{ +		if ( feof($handle) || fwrite ( $handle, $data, $length ) !== $length ) +		{ +			$this->_error = 'connection unexpectedly closed (timed out?)'; +			$this->_connerror = true; +			return false; +		} +		return true; +	} + +	///////////////////////////////////////////////////////////////////////////// + +	/// enter mbstring workaround mode +	function _MBPush () +	{ +		$this->_mbenc = ""; +		if ( ini_get ( "mbstring.func_overload" ) & 2 ) +		{ +			$this->_mbenc = mb_internal_encoding(); +			mb_internal_encoding ( "latin1" ); +		} +    } + +	/// leave mbstring workaround mode +	function _MBPop () +	{ +		if ( $this->_mbenc ) +			mb_internal_encoding ( $this->_mbenc ); +	} + +	/// connect to searchd server +	function _Connect () +	{ +		if ( $this->_socket!==false ) +		{ +			// we are in persistent connection mode, so we have a socket +			// however, need to check whether it's still alive +			if ( !@feof ( $this->_socket ) ) +				return $this->_socket; + +			// force reopen +			$this->_socket = false; +		} + +		$errno = 0; +		$errstr = ""; +		$this->_connerror = false; + +		if ( $this->_path ) +		{ +			$host = $this->_path; +			$port = 0; +		} +		else +		{ +			$host = $this->_host; +			$port = $this->_port; +		} + +		if ( $this->_timeout<=0 ) +			$fp = @fsockopen ( $host, $port, $errno, $errstr ); +		else +			$fp = @fsockopen ( $host, $port, $errno, $errstr, $this->_timeout ); +		 +		if ( !$fp ) +		{ +			if ( $this->_path ) +				$location = $this->_path; +			else +				$location = "{$this->_host}:{$this->_port}"; +			 +			$errstr = trim ( $errstr ); +			$this->_error = "connection to $location failed (errno=$errno, msg=$errstr)"; +			$this->_connerror = true; +			return false; +		} + +		// send my version +		// this is a subtle part. we must do it before (!) reading back from searchd. +		// because otherwise under some conditions (reported on FreeBSD for instance) +		// TCP stack could throttle write-write-read pattern because of Nagle. +		if ( !$this->_Send ( $fp, pack ( "N", 1 ), 4 ) ) +		{ +			fclose ( $fp ); +			$this->_error = "failed to send client protocol version"; +			return false; +		} + +		// check version +		list(,$v) = unpack ( "N*", fread ( $fp, 4 ) ); +		$v = (int)$v; +		if ( $v<1 ) +		{ +			fclose ( $fp ); +			$this->_error = "expected searchd protocol version 1+, got version '$v'"; +			return false; +		} + +		return $fp; +	} + +	/// get and check response packet from searchd server +	function _GetResponse ( $fp, $client_ver ) +	{ +		$response = ""; +		$len = 0; + +		$header = fread ( $fp, 8 ); +		if ( strlen($header)==8 ) +		{ +			list ( $status, $ver, $len ) = array_values ( unpack ( "n2a/Nb", $header ) ); +			$left = $len; +			while ( $left>0 && !feof($fp) ) +			{ +				$chunk = fread ( $fp, min ( 8192, $left ) ); +				if ( $chunk ) +				{ +					$response .= $chunk; +					$left -= strlen($chunk); +				} +			} +		} +		if ( $this->_socket === false ) +			fclose ( $fp ); + +		// check response +		$read = strlen ( $response ); +		if ( !$response || $read!=$len ) +		{ +			$this->_error = $len +				? "failed to read searchd response (status=$status, ver=$ver, len=$len, read=$read)" +				: "received zero-sized searchd response"; +			return false; +		} + +		// check status +		if ( $status==SEARCHD_WARNING ) +		{ +			list(,$wlen) = unpack ( "N*", substr ( $response, 0, 4 ) ); +			$this->_warning = substr ( $response, 4, $wlen ); +			return substr ( $response, 4+$wlen ); +		} +		if ( $status==SEARCHD_ERROR ) +		{ +			$this->_error = "searchd error: " . substr ( $response, 4 ); +			return false; +		} +		if ( $status==SEARCHD_RETRY ) +		{ +			$this->_error = "temporary searchd error: " . substr ( $response, 4 ); +			return false; +		} +		if ( $status!=SEARCHD_OK ) +		{ +			$this->_error = "unknown status code '$status'"; +			return false; +		} + +		// check version +		if ( $ver<$client_ver ) +		{ +			$this->_warning = sprintf ( "searchd command v.%d.%d older than client's v.%d.%d, some options might not work", +				$ver>>8, $ver&0xff, $client_ver>>8, $client_ver&0xff ); +		} + +		return $response; +	} + +	///////////////////////////////////////////////////////////////////////////// +	// searching +	///////////////////////////////////////////////////////////////////////////// + +	/// set offset and count into result set, +	/// and optionally set max-matches and cutoff limits +	function SetLimits ( $offset, $limit, $max=0, $cutoff=0 ) +	{ +		assert ( is_int($offset) ); +		assert ( is_int($limit) ); +		assert ( $offset>=0 ); +		assert ( $limit>0 ); +		assert ( $max>=0 ); +		$this->_offset = $offset; +		$this->_limit = $limit; +		if ( $max>0 ) +			$this->_maxmatches = $max; +		if ( $cutoff>0 ) +			$this->_cutoff = $cutoff; +	} + +	/// set maximum query time, in milliseconds, per-index +	/// integer, 0 means "do not limit" +	function SetMaxQueryTime ( $max ) +	{ +		assert ( is_int($max) ); +		assert ( $max>=0 ); +		$this->_maxquerytime = $max; +	} + +	/// set matching mode +	function SetMatchMode ( $mode ) +	{ +		assert ( $mode==SPH_MATCH_ALL +			|| $mode==SPH_MATCH_ANY +			|| $mode==SPH_MATCH_PHRASE +			|| $mode==SPH_MATCH_BOOLEAN +			|| $mode==SPH_MATCH_EXTENDED +			|| $mode==SPH_MATCH_FULLSCAN +			|| $mode==SPH_MATCH_EXTENDED2 ); +		$this->_mode = $mode; +	} + +	/// set ranking mode +	function SetRankingMode ( $ranker, $rankexpr="" ) +	{ +		assert ( $ranker>=0 && $ranker<SPH_RANK_TOTAL ); +		assert ( is_string($rankexpr) ); +		$this->_ranker = $ranker; +		$this->_rankexpr = $rankexpr; +	} + +	/// set matches sorting mode +	function SetSortMode ( $mode, $sortby="" ) +	{ +		assert ( +			$mode==SPH_SORT_RELEVANCE || +			$mode==SPH_SORT_ATTR_DESC || +			$mode==SPH_SORT_ATTR_ASC || +			$mode==SPH_SORT_TIME_SEGMENTS || +			$mode==SPH_SORT_EXTENDED || +			$mode==SPH_SORT_EXPR ); +		assert ( is_string($sortby) ); +		assert ( $mode==SPH_SORT_RELEVANCE || strlen($sortby)>0 ); + +		$this->_sort = $mode; +		$this->_sortby = $sortby; +	} + +	/// bind per-field weights by order +	/// DEPRECATED; use SetFieldWeights() instead +	function SetWeights ( $weights ) +	{ +		assert ( is_array($weights) ); +		foreach ( $weights as $weight ) +			assert ( is_int($weight) ); + +		$this->_weights = $weights; +	} + +	/// bind per-field weights by name +	function SetFieldWeights ( $weights ) +	{ +		assert ( is_array($weights) ); +		foreach ( $weights as $name=>$weight ) +		{ +			assert ( is_string($name) ); +			assert ( is_int($weight) ); +		} +		$this->_fieldweights = $weights; +	} + +	/// bind per-index weights by name +	function SetIndexWeights ( $weights ) +	{ +		assert ( is_array($weights) ); +		foreach ( $weights as $index=>$weight ) +		{ +			assert ( is_string($index) ); +			assert ( is_int($weight) ); +		} +		$this->_indexweights = $weights; +	} + +	/// set IDs range to match +	/// only match records if document ID is beetwen $min and $max (inclusive) +	function SetIDRange ( $min, $max ) +	{ +		assert ( is_numeric($min) ); +		assert ( is_numeric($max) ); +		assert ( $min<=$max ); +		$this->_min_id = $min; +		$this->_max_id = $max; +	} + +	/// set values set filter +	/// only match records where $attribute value is in given set +	function SetFilter ( $attribute, $values, $exclude=false ) +	{ +		assert ( is_string($attribute) ); +		assert ( is_array($values) ); +		assert ( count($values) ); + +		if ( is_array($values) && count($values) ) +		{ +			foreach ( $values as $value ) +				assert ( is_numeric($value) ); + +			$this->_filters[] = array ( "type"=>SPH_FILTER_VALUES, "attr"=>$attribute, "exclude"=>$exclude, "values"=>$values ); +		} +	} + +	/// set range filter +	/// only match records if $attribute value is beetwen $min and $max (inclusive) +	function SetFilterRange ( $attribute, $min, $max, $exclude=false ) +	{ +		assert ( is_string($attribute) ); +		assert ( is_numeric($min) ); +		assert ( is_numeric($max) ); +		assert ( $min<=$max ); + +		$this->_filters[] = array ( "type"=>SPH_FILTER_RANGE, "attr"=>$attribute, "exclude"=>$exclude, "min"=>$min, "max"=>$max ); +	} + +	/// set float range filter +	/// only match records if $attribute value is beetwen $min and $max (inclusive) +	function SetFilterFloatRange ( $attribute, $min, $max, $exclude=false ) +	{ +		assert ( is_string($attribute) ); +		assert ( is_float($min) ); +		assert ( is_float($max) ); +		assert ( $min<=$max ); + +		$this->_filters[] = array ( "type"=>SPH_FILTER_FLOATRANGE, "attr"=>$attribute, "exclude"=>$exclude, "min"=>$min, "max"=>$max ); +	} + +	/// setup anchor point for geosphere distance calculations +	/// required to use @geodist in filters and sorting +	/// latitude and longitude must be in radians +	function SetGeoAnchor ( $attrlat, $attrlong, $lat, $long ) +	{ +		assert ( is_string($attrlat) ); +		assert ( is_string($attrlong) ); +		assert ( is_float($lat) ); +		assert ( is_float($long) ); + +		$this->_anchor = array ( "attrlat"=>$attrlat, "attrlong"=>$attrlong, "lat"=>$lat, "long"=>$long ); +	} + +	/// set grouping attribute and function +	function SetGroupBy ( $attribute, $func, $groupsort="@group desc" ) +	{ +		assert ( is_string($attribute) ); +		assert ( is_string($groupsort) ); +		assert ( $func==SPH_GROUPBY_DAY +			|| $func==SPH_GROUPBY_WEEK +			|| $func==SPH_GROUPBY_MONTH +			|| $func==SPH_GROUPBY_YEAR +			|| $func==SPH_GROUPBY_ATTR +			|| $func==SPH_GROUPBY_ATTRPAIR ); + +		$this->_groupby = $attribute; +		$this->_groupfunc = $func; +		$this->_groupsort = $groupsort; +	} + +	/// set count-distinct attribute for group-by queries +	function SetGroupDistinct ( $attribute ) +	{ +		assert ( is_string($attribute) ); +		$this->_groupdistinct = $attribute; +	} + +	/// set distributed retries count and delay +	function SetRetries ( $count, $delay=0 ) +	{ +		assert ( is_int($count) && $count>=0 ); +		assert ( is_int($delay) && $delay>=0 ); +		$this->_retrycount = $count; +		$this->_retrydelay = $delay; +	} + +	/// set result set format (hash or array; hash by default) +	/// PHP specific; needed for group-by-MVA result sets that may contain duplicate IDs +	function SetArrayResult ( $arrayresult ) +	{ +		assert ( is_bool($arrayresult) ); +		$this->_arrayresult = $arrayresult; +	} + +	/// set attribute values override +	/// there can be only one override per attribute +	/// $values must be a hash that maps document IDs to attribute values +	function SetOverride ( $attrname, $attrtype, $values ) +	{ +		assert ( is_string ( $attrname ) ); +		assert ( in_array ( $attrtype, array ( SPH_ATTR_INTEGER, SPH_ATTR_TIMESTAMP, SPH_ATTR_BOOL, SPH_ATTR_FLOAT, SPH_ATTR_BIGINT ) ) ); +		assert ( is_array ( $values ) ); + +		$this->_overrides[$attrname] = array ( "attr"=>$attrname, "type"=>$attrtype, "values"=>$values ); +	} + +	/// set select-list (attributes or expressions), SQL-like syntax +	function SetSelect ( $select ) +	{ +		assert ( is_string ( $select ) ); +		$this->_select = $select; +	} + +	////////////////////////////////////////////////////////////////////////////// + +	/// clear all filters (for multi-queries) +	function ResetFilters () +	{ +		$this->_filters = array(); +		$this->_anchor = array(); +	} + +	/// clear groupby settings (for multi-queries) +	function ResetGroupBy () +	{ +		$this->_groupby		= ""; +		$this->_groupfunc	= SPH_GROUPBY_DAY; +		$this->_groupsort	= "@group desc"; +		$this->_groupdistinct= ""; +	} + +	/// clear all attribute value overrides (for multi-queries) +	function ResetOverrides () +    { +    	$this->_overrides = array (); +    } + +	////////////////////////////////////////////////////////////////////////////// + +	/// connect to searchd server, run given search query through given indexes, +	/// and return the search results +	function Query ( $query, $index="*", $comment="" ) +	{ +		assert ( empty($this->_reqs) ); + +		$this->AddQuery ( $query, $index, $comment ); +		$results = $this->RunQueries (); +		$this->_reqs = array (); // just in case it failed too early + +		if ( !is_array($results) ) +			return false; // probably network error; error message should be already filled + +		$this->_error = $results[0]["error"]; +		$this->_warning = $results[0]["warning"]; +		if ( $results[0]["status"]==SEARCHD_ERROR ) +			return false; +		else +			return $results[0]; +	} + +	/// helper to pack floats in network byte order +	function _PackFloat ( $f ) +	{ +		$t1 = pack ( "f", $f ); // machine order +		list(,$t2) = unpack ( "L*", $t1 ); // int in machine order +		return pack ( "N", $t2 ); +	} + +	/// add query to multi-query batch +	/// returns index into results array from RunQueries() call +	function AddQuery ( $query, $index="*", $comment="" ) +	{ +		// mbstring workaround +		$this->_MBPush (); + +		// build request +		$req = pack ( "NNNN", $this->_offset, $this->_limit, $this->_mode, $this->_ranker ); +		if ( $this->_ranker==SPH_RANK_EXPR ) +			$req .= pack ( "N", strlen($this->_rankexpr) ) . $this->_rankexpr; +		$req .= pack ( "N", $this->_sort ); // (deprecated) sort mode +		$req .= pack ( "N", strlen($this->_sortby) ) . $this->_sortby; +		$req .= pack ( "N", strlen($query) ) . $query; // query itself +		$req .= pack ( "N", count($this->_weights) ); // weights +		foreach ( $this->_weights as $weight ) +			$req .= pack ( "N", (int)$weight ); +		$req .= pack ( "N", strlen($index) ) . $index; // indexes +		$req .= pack ( "N", 1 ); // id64 range marker +		$req .= sphPackU64 ( $this->_min_id ) . sphPackU64 ( $this->_max_id ); // id64 range + +		// filters +		$req .= pack ( "N", count($this->_filters) ); +		foreach ( $this->_filters as $filter ) +		{ +			$req .= pack ( "N", strlen($filter["attr"]) ) . $filter["attr"]; +			$req .= pack ( "N", $filter["type"] ); +			switch ( $filter["type"] ) +			{ +				case SPH_FILTER_VALUES: +					$req .= pack ( "N", count($filter["values"]) ); +					foreach ( $filter["values"] as $value ) +						$req .= sphPackI64 ( $value ); +					break; + +				case SPH_FILTER_RANGE: +					$req .= sphPackI64 ( $filter["min"] ) . sphPackI64 ( $filter["max"] ); +					break; + +				case SPH_FILTER_FLOATRANGE: +					$req .= $this->_PackFloat ( $filter["min"] ) . $this->_PackFloat ( $filter["max"] ); +					break; + +				default: +					assert ( 0 && "internal error: unhandled filter type" ); +			} +			$req .= pack ( "N", $filter["exclude"] ); +		} + +		// group-by clause, max-matches count, group-sort clause, cutoff count +		$req .= pack ( "NN", $this->_groupfunc, strlen($this->_groupby) ) . $this->_groupby; +		$req .= pack ( "N", $this->_maxmatches ); +		$req .= pack ( "N", strlen($this->_groupsort) ) . $this->_groupsort; +		$req .= pack ( "NNN", $this->_cutoff, $this->_retrycount, $this->_retrydelay ); +		$req .= pack ( "N", strlen($this->_groupdistinct) ) . $this->_groupdistinct; + +		// anchor point +		if ( empty($this->_anchor) ) +		{ +			$req .= pack ( "N", 0 ); +		} else +		{ +			$a =& $this->_anchor; +			$req .= pack ( "N", 1 ); +			$req .= pack ( "N", strlen($a["attrlat"]) ) . $a["attrlat"]; +			$req .= pack ( "N", strlen($a["attrlong"]) ) . $a["attrlong"]; +			$req .= $this->_PackFloat ( $a["lat"] ) . $this->_PackFloat ( $a["long"] ); +		} + +		// per-index weights +		$req .= pack ( "N", count($this->_indexweights) ); +		foreach ( $this->_indexweights as $idx=>$weight ) +			$req .= pack ( "N", strlen($idx) ) . $idx . pack ( "N", $weight ); + +		// max query time +		$req .= pack ( "N", $this->_maxquerytime ); + +		// per-field weights +		$req .= pack ( "N", count($this->_fieldweights) ); +		foreach ( $this->_fieldweights as $field=>$weight ) +			$req .= pack ( "N", strlen($field) ) . $field . pack ( "N", $weight ); + +		// comment +		$req .= pack ( "N", strlen($comment) ) . $comment; + +		// attribute overrides +		$req .= pack ( "N", count($this->_overrides) ); +		foreach ( $this->_overrides as $key => $entry ) +		{ +			$req .= pack ( "N", strlen($entry["attr"]) ) . $entry["attr"]; +			$req .= pack ( "NN", $entry["type"], count($entry["values"]) ); +			foreach ( $entry["values"] as $id=>$val ) +			{ +				assert ( is_numeric($id) ); +				assert ( is_numeric($val) ); + +				$req .= sphPackU64 ( $id ); +				switch ( $entry["type"] ) +				{ +					case SPH_ATTR_FLOAT:	$req .= $this->_PackFloat ( $val ); break; +					case SPH_ATTR_BIGINT:	$req .= sphPackI64 ( $val ); break; +					default:				$req .= pack ( "N", $val ); break; +				} +			} +		} + +		// select-list +		$req .= pack ( "N", strlen($this->_select) ) . $this->_select; + +		// mbstring workaround +		$this->_MBPop (); + +		// store request to requests array +		$this->_reqs[] = $req; +		return count($this->_reqs)-1; +	} + +	/// connect to searchd, run queries batch, and return an array of result sets +	function RunQueries () +	{ +		if ( empty($this->_reqs) ) +		{ +			$this->_error = "no queries defined, issue AddQuery() first"; +			return false; +		} + +		// mbstring workaround +		$this->_MBPush (); + +		if (!( $fp = $this->_Connect() )) +		{ +			$this->_MBPop (); +			return false; +		} + +		// send query, get response +		$nreqs = count($this->_reqs); +		$req = join ( "", $this->_reqs ); +		$len = 8+strlen($req); +		$req = pack ( "nnNNN", SEARCHD_COMMAND_SEARCH, VER_COMMAND_SEARCH, $len, 0, $nreqs ) . $req; // add header + +		if ( !( $this->_Send ( $fp, $req, $len+8 ) ) || +			 !( $response = $this->_GetResponse ( $fp, VER_COMMAND_SEARCH ) ) ) +		{ +			$this->_MBPop (); +			return false; +		} + +		// query sent ok; we can reset reqs now +		$this->_reqs = array (); + +		// parse and return response +		return $this->_ParseSearchResponse ( $response, $nreqs ); +	} + +	/// parse and return search query (or queries) response +	function _ParseSearchResponse ( $response, $nreqs ) +	{ +		$p = 0; // current position +		$max = strlen($response); // max position for checks, to protect against broken responses + +		$results = array (); +		for ( $ires=0; $ires<$nreqs && $p<$max; $ires++ ) +		{ +			$results[] = array(); +			$result =& $results[$ires]; + +			$result["error"] = ""; +			$result["warning"] = ""; + +			// extract status +			list(,$status) = unpack ( "N*", substr ( $response, $p, 4 ) ); $p += 4; +			$result["status"] = $status; +			if ( $status!=SEARCHD_OK ) +			{ +				list(,$len) = unpack ( "N*", substr ( $response, $p, 4 ) ); $p += 4; +				$message = substr ( $response, $p, $len ); $p += $len; + +				if ( $status==SEARCHD_WARNING ) +				{ +					$result["warning"] = $message; +				} else +				{ +					$result["error"] = $message; +					continue; +				} +			} + +			// read schema +			$fields = array (); +			$attrs = array (); + +			list(,$nfields) = unpack ( "N*", substr ( $response, $p, 4 ) ); $p += 4; +			while ( $nfields-->0 && $p<$max ) +			{ +				list(,$len) = unpack ( "N*", substr ( $response, $p, 4 ) ); $p += 4; +				$fields[] = substr ( $response, $p, $len ); $p += $len; +			} +			$result["fields"] = $fields; + +			list(,$nattrs) = unpack ( "N*", substr ( $response, $p, 4 ) ); $p += 4; +			while ( $nattrs-->0 && $p<$max  ) +			{ +				list(,$len) = unpack ( "N*", substr ( $response, $p, 4 ) ); $p += 4; +				$attr = substr ( $response, $p, $len ); $p += $len; +				list(,$type) = unpack ( "N*", substr ( $response, $p, 4 ) ); $p += 4; +				$attrs[$attr] = $type; +			} +			$result["attrs"] = $attrs; + +			// read match count +			list(,$count) = unpack ( "N*", substr ( $response, $p, 4 ) ); $p += 4; +			list(,$id64) = unpack ( "N*", substr ( $response, $p, 4 ) ); $p += 4; + +			// read matches +			$idx = -1; +			while ( $count-->0 && $p<$max ) +			{ +				// index into result array +				$idx++; + +				// parse document id and weight +				if ( $id64 ) +				{ +					$doc = sphUnpackU64 ( substr ( $response, $p, 8 ) ); $p += 8; +					list(,$weight) = unpack ( "N*", substr ( $response, $p, 4 ) ); $p += 4; +				} +				else +				{ +					list ( $doc, $weight ) = array_values ( unpack ( "N*N*", +						substr ( $response, $p, 8 ) ) ); +					$p += 8; +					$doc = sphFixUint($doc); +				} +				$weight = sprintf ( "%u", $weight ); + +				// create match entry +				if ( $this->_arrayresult ) +					$result["matches"][$idx] = array ( "id"=>$doc, "weight"=>$weight ); +				else +					$result["matches"][$doc]["weight"] = $weight; + +				// parse and create attributes +				$attrvals = array (); +				foreach ( $attrs as $attr=>$type ) +				{ +					// handle 64bit ints +					if ( $type==SPH_ATTR_BIGINT ) +					{ +						$attrvals[$attr] = sphUnpackI64 ( substr ( $response, $p, 8 ) ); $p += 8; +						continue; +					} + +					// handle floats +					if ( $type==SPH_ATTR_FLOAT ) +					{ +						list(,$uval) = unpack ( "N*", substr ( $response, $p, 4 ) ); $p += 4; +						list(,$fval) = unpack ( "f*", pack ( "L", $uval ) );  +						$attrvals[$attr] = $fval; +						continue; +					} + +					// handle everything else as unsigned ints +					list(,$val) = unpack ( "N*", substr ( $response, $p, 4 ) ); $p += 4; +					if ( $type==SPH_ATTR_MULTI ) +					{ +						$attrvals[$attr] = array (); +						$nvalues = $val; +						while ( $nvalues-->0 && $p<$max ) +						{ +							list(,$val) = unpack ( "N*", substr ( $response, $p, 4 ) ); $p += 4; +							$attrvals[$attr][] = sphFixUint($val); +						} +					} else if ( $type==SPH_ATTR_MULTI64 ) +					{ +						$attrvals[$attr] = array (); +						$nvalues = $val; +						while ( $nvalues>0 && $p<$max ) +						{ +							$attrvals[$attr][] = sphUnpackU64 ( substr ( $response, $p, 8 ) ); $p += 8; +							$nvalues -= 2; +						} +					} else if ( $type==SPH_ATTR_STRING ) +					{ +						$attrvals[$attr] = substr ( $response, $p, $val ); +						$p += $val;						 +					} else +					{ +						$attrvals[$attr] = sphFixUint($val); +					} +				} + +				if ( $this->_arrayresult ) +					$result["matches"][$idx]["attrs"] = $attrvals; +				else +					$result["matches"][$doc]["attrs"] = $attrvals; +			} + +			list ( $total, $total_found, $msecs, $words ) = +				array_values ( unpack ( "N*N*N*N*", substr ( $response, $p, 16 ) ) ); +			$result["total"] = sprintf ( "%u", $total ); +			$result["total_found"] = sprintf ( "%u", $total_found ); +			$result["time"] = sprintf ( "%.3f", $msecs/1000 ); +			$p += 16; + +			while ( $words-->0 && $p<$max ) +			{ +				list(,$len) = unpack ( "N*", substr ( $response, $p, 4 ) ); $p += 4; +				$word = substr ( $response, $p, $len ); $p += $len; +				list ( $docs, $hits ) = array_values ( unpack ( "N*N*", substr ( $response, $p, 8 ) ) ); $p += 8; +				$result["words"][$word] = array ( +					"docs"=>sprintf ( "%u", $docs ), +					"hits"=>sprintf ( "%u", $hits ) ); +			} +		} + +		$this->_MBPop (); +		return $results; +	} + +	///////////////////////////////////////////////////////////////////////////// +	// excerpts generation +	///////////////////////////////////////////////////////////////////////////// + +	/// connect to searchd server, and generate exceprts (snippets) +	/// of given documents for given query. returns false on failure, +	/// an array of snippets on success +	function BuildExcerpts ( $docs, $index, $words, $opts=array() ) +	{ +		assert ( is_array($docs) ); +		assert ( is_string($index) ); +		assert ( is_string($words) ); +		assert ( is_array($opts) ); + +		$this->_MBPush (); + +		if (!( $fp = $this->_Connect() )) +		{ +			$this->_MBPop(); +			return false; +		} + +		///////////////// +		// fixup options +		///////////////// + +		if ( !isset($opts["before_match"]) )		$opts["before_match"] = "<b>"; +		if ( !isset($opts["after_match"]) )			$opts["after_match"] = "</b>"; +		if ( !isset($opts["chunk_separator"]) )		$opts["chunk_separator"] = " ... "; +		if ( !isset($opts["limit"]) )				$opts["limit"] = 256; +		if ( !isset($opts["limit_passages"]) )		$opts["limit_passages"] = 0; +		if ( !isset($opts["limit_words"]) )			$opts["limit_words"] = 0; +		if ( !isset($opts["around"]) )				$opts["around"] = 5; +		if ( !isset($opts["exact_phrase"]) )		$opts["exact_phrase"] = false; +		if ( !isset($opts["single_passage"]) )		$opts["single_passage"] = false; +		if ( !isset($opts["use_boundaries"]) )		$opts["use_boundaries"] = false; +		if ( !isset($opts["weight_order"]) )		$opts["weight_order"] = false; +		if ( !isset($opts["query_mode"]) )			$opts["query_mode"] = false; +		if ( !isset($opts["force_all_words"]) )		$opts["force_all_words"] = false; +		if ( !isset($opts["start_passage_id"]) )	$opts["start_passage_id"] = 1; +		if ( !isset($opts["load_files"]) )			$opts["load_files"] = false; +		if ( !isset($opts["html_strip_mode"]) )		$opts["html_strip_mode"] = "index"; +		if ( !isset($opts["allow_empty"]) )			$opts["allow_empty"] = false; +		if ( !isset($opts["passage_boundary"]) )	$opts["passage_boundary"] = "none"; +		if ( !isset($opts["emit_zones"]) )			$opts["emit_zones"] = false; +		if ( !isset($opts["load_files_scattered"]) )		$opts["load_files_scattered"] = false; +		 + +		///////////////// +		// build request +		///////////////// + +		// v.1.2 req +		$flags = 1; // remove spaces +		if ( $opts["exact_phrase"] )	$flags |= 2; +		if ( $opts["single_passage"] )	$flags |= 4; +		if ( $opts["use_boundaries"] )	$flags |= 8; +		if ( $opts["weight_order"] )	$flags |= 16; +		if ( $opts["query_mode"] )		$flags |= 32; +		if ( $opts["force_all_words"] )	$flags |= 64; +		if ( $opts["load_files"] )		$flags |= 128; +		if ( $opts["allow_empty"] )		$flags |= 256; +		if ( $opts["emit_zones"] )		$flags |= 512; +		if ( $opts["load_files_scattered"] )	$flags |= 1024; +		$req = pack ( "NN", 0, $flags ); // mode=0, flags=$flags +		$req .= pack ( "N", strlen($index) ) . $index; // req index +		$req .= pack ( "N", strlen($words) ) . $words; // req words + +		// options +		$req .= pack ( "N", strlen($opts["before_match"]) ) . $opts["before_match"]; +		$req .= pack ( "N", strlen($opts["after_match"]) ) . $opts["after_match"]; +		$req .= pack ( "N", strlen($opts["chunk_separator"]) ) . $opts["chunk_separator"]; +		$req .= pack ( "NN", (int)$opts["limit"], (int)$opts["around"] ); +		$req .= pack ( "NNN", (int)$opts["limit_passages"], (int)$opts["limit_words"], (int)$opts["start_passage_id"] ); // v.1.2 +		$req .= pack ( "N", strlen($opts["html_strip_mode"]) ) . $opts["html_strip_mode"]; +		$req .= pack ( "N", strlen($opts["passage_boundary"]) ) . $opts["passage_boundary"]; + +		// documents +		$req .= pack ( "N", count($docs) ); +		foreach ( $docs as $doc ) +		{ +			assert ( is_string($doc) ); +			$req .= pack ( "N", strlen($doc) ) . $doc; +		} + +		//////////////////////////// +		// send query, get response +		//////////////////////////// + +		$len = strlen($req); +		$req = pack ( "nnN", SEARCHD_COMMAND_EXCERPT, VER_COMMAND_EXCERPT, $len ) . $req; // add header +		if ( !( $this->_Send ( $fp, $req, $len+8 ) ) || +			 !( $response = $this->_GetResponse ( $fp, VER_COMMAND_EXCERPT ) ) ) +		{ +			$this->_MBPop (); +			return false; +		} + +		////////////////// +		// parse response +		////////////////// + +		$pos = 0; +		$res = array (); +		$rlen = strlen($response); +		for ( $i=0; $i<count($docs); $i++ ) +		{ +			list(,$len) = unpack ( "N*", substr ( $response, $pos, 4 ) ); +			$pos += 4; + +			if ( $pos+$len > $rlen ) +			{ +				$this->_error = "incomplete reply"; +				$this->_MBPop (); +				return false; +			} +			$res[] = $len ? substr ( $response, $pos, $len ) : ""; +			$pos += $len; +		} + +		$this->_MBPop (); +		return $res; +	} + + +	///////////////////////////////////////////////////////////////////////////// +	// keyword generation +	///////////////////////////////////////////////////////////////////////////// + +	/// connect to searchd server, and generate keyword list for a given query +	/// returns false on failure, +	/// an array of words on success +	function BuildKeywords ( $query, $index, $hits ) +	{ +		assert ( is_string($query) ); +		assert ( is_string($index) ); +		assert ( is_bool($hits) ); + +		$this->_MBPush (); + +		if (!( $fp = $this->_Connect() )) +		{ +			$this->_MBPop(); +			return false; +		} + +		///////////////// +		// build request +		///////////////// + +		// v.1.0 req +		$req  = pack ( "N", strlen($query) ) . $query; // req query +		$req .= pack ( "N", strlen($index) ) . $index; // req index +		$req .= pack ( "N", (int)$hits ); + +		//////////////////////////// +		// send query, get response +		//////////////////////////// + +		$len = strlen($req); +		$req = pack ( "nnN", SEARCHD_COMMAND_KEYWORDS, VER_COMMAND_KEYWORDS, $len ) . $req; // add header +		if ( !( $this->_Send ( $fp, $req, $len+8 ) ) || +			 !( $response = $this->_GetResponse ( $fp, VER_COMMAND_KEYWORDS ) ) ) +		{ +			$this->_MBPop (); +			return false; +		} + +		////////////////// +		// parse response +		////////////////// + +		$pos = 0; +		$res = array (); +		$rlen = strlen($response); +		list(,$nwords) = unpack ( "N*", substr ( $response, $pos, 4 ) ); +		$pos += 4; +		for ( $i=0; $i<$nwords; $i++ ) +		{ +			list(,$len) = unpack ( "N*", substr ( $response, $pos, 4 ) );	$pos += 4; +			$tokenized = $len ? substr ( $response, $pos, $len ) : ""; +			$pos += $len; + +			list(,$len) = unpack ( "N*", substr ( $response, $pos, 4 ) );	$pos += 4; +			$normalized = $len ? substr ( $response, $pos, $len ) : ""; +			$pos += $len; + +			$res[] = array ( "tokenized"=>$tokenized, "normalized"=>$normalized ); + +			if ( $hits ) +			{ +				list($ndocs,$nhits) = array_values ( unpack ( "N*N*", substr ( $response, $pos, 8 ) ) ); +				$pos += 8; +				$res [$i]["docs"] = $ndocs; +				$res [$i]["hits"] = $nhits; +			} + +			if ( $pos > $rlen ) +			{ +				$this->_error = "incomplete reply"; +				$this->_MBPop (); +				return false; +			} +		} + +		$this->_MBPop (); +		return $res; +	} + +	function EscapeString ( $string ) +	{ +		$from = array ( '\\', '(',')','|','-','!','@','~','"','&', '/', '^', '$', '=' ); +		$to   = array ( '\\\\', '\(','\)','\|','\-','\!','\@','\~','\"', '\&', '\/', '\^', '\$', '\=' ); + +		return str_replace ( $from, $to, $string ); +	} + +	///////////////////////////////////////////////////////////////////////////// +	// attribute updates +	///////////////////////////////////////////////////////////////////////////// + +	/// batch update given attributes in given rows in given indexes +	/// returns amount of updated documents (0 or more) on success, or -1 on failure +	function UpdateAttributes ( $index, $attrs, $values, $mva=false ) +	{ +		// verify everything +		assert ( is_string($index) ); +		assert ( is_bool($mva) ); + +		assert ( is_array($attrs) ); +		foreach ( $attrs as $attr ) +			assert ( is_string($attr) ); + +		assert ( is_array($values) ); +		foreach ( $values as $id=>$entry ) +		{ +			assert ( is_numeric($id) ); +			assert ( is_array($entry) ); +			assert ( count($entry)==count($attrs) ); +			foreach ( $entry as $v ) +			{ +				if ( $mva ) +				{ +					assert ( is_array($v) ); +					foreach ( $v as $vv ) +						assert ( is_int($vv) ); +				} else +					assert ( is_int($v) ); +			} +		} + +		// build request +		$this->_MBPush (); +		$req = pack ( "N", strlen($index) ) . $index; + +		$req .= pack ( "N", count($attrs) ); +		foreach ( $attrs as $attr ) +		{ +			$req .= pack ( "N", strlen($attr) ) . $attr; +			$req .= pack ( "N", $mva ? 1 : 0 ); +		} + +		$req .= pack ( "N", count($values) ); +		foreach ( $values as $id=>$entry ) +		{ +			$req .= sphPackU64 ( $id ); +			foreach ( $entry as $v ) +			{ +				$req .= pack ( "N", $mva ? count($v) : $v ); +				if ( $mva ) +					foreach ( $v as $vv ) +						$req .= pack ( "N", $vv ); +			} +		} + +		// connect, send query, get response +		if (!( $fp = $this->_Connect() )) +		{ +			$this->_MBPop (); +			return -1; +		} + +		$len = strlen($req); +		$req = pack ( "nnN", SEARCHD_COMMAND_UPDATE, VER_COMMAND_UPDATE, $len ) . $req; // add header +		if ( !$this->_Send ( $fp, $req, $len+8 ) ) +		{ +			$this->_MBPop (); +			return -1; +		} + +		if (!( $response = $this->_GetResponse ( $fp, VER_COMMAND_UPDATE ) )) +		{ +			$this->_MBPop (); +			return -1; +		} + +		// parse response +		list(,$updated) = unpack ( "N*", substr ( $response, 0, 4 ) ); +		$this->_MBPop (); +		return $updated; +	} + +	///////////////////////////////////////////////////////////////////////////// +	// persistent connections +	///////////////////////////////////////////////////////////////////////////// + +	function Open() +	{ +		if ( $this->_socket !== false ) +		{ +			$this->_error = 'already connected'; +			return false; +		} +		if ( !$fp = $this->_Connect() ) +			return false; + +		// command, command version = 0, body length = 4, body = 1 +		$req = pack ( "nnNN", SEARCHD_COMMAND_PERSIST, 0, 4, 1 ); +		if ( !$this->_Send ( $fp, $req, 12 ) ) +			return false; + +		$this->_socket = $fp; +		return true; +	} + +	function Close() +	{ +		if ( $this->_socket === false ) +		{ +			$this->_error = 'not connected'; +			return false; +		} + +		fclose ( $this->_socket ); +		$this->_socket = false; +		 +		return true; +	} + +	////////////////////////////////////////////////////////////////////////// +	// status +	////////////////////////////////////////////////////////////////////////// + +	function Status () +	{ +		$this->_MBPush (); +		if (!( $fp = $this->_Connect() )) +		{ +			$this->_MBPop(); +			return false; +		} + +		$req = pack ( "nnNN", SEARCHD_COMMAND_STATUS, VER_COMMAND_STATUS, 4, 1 ); // len=4, body=1 +		if ( !( $this->_Send ( $fp, $req, 12 ) ) || +			 !( $response = $this->_GetResponse ( $fp, VER_COMMAND_STATUS ) ) ) +		{ +			$this->_MBPop (); +			return false; +		} + +		$res = substr ( $response, 4 ); // just ignore length, error handling, etc +		$p = 0; +		list ( $rows, $cols ) = array_values ( unpack ( "N*N*", substr ( $response, $p, 8 ) ) ); $p += 8; + +		$res = array(); +		for ( $i=0; $i<$rows; $i++ ) +			for ( $j=0; $j<$cols; $j++ ) +		{ +			list(,$len) = unpack ( "N*", substr ( $response, $p, 4 ) ); $p += 4; +			$res[$i][] = substr ( $response, $p, $len ); $p += $len; +		} + +		$this->_MBPop (); +		return $res; +	} + +	////////////////////////////////////////////////////////////////////////// +	// flush +	////////////////////////////////////////////////////////////////////////// + +	function FlushAttributes () +	{ +		$this->_MBPush (); +		if (!( $fp = $this->_Connect() )) +		{ +			$this->_MBPop(); +			return -1; +		} + +		$req = pack ( "nnN", SEARCHD_COMMAND_FLUSHATTRS, VER_COMMAND_FLUSHATTRS, 0 ); // len=0 +		if ( !( $this->_Send ( $fp, $req, 8 ) ) || +			 !( $response = $this->_GetResponse ( $fp, VER_COMMAND_FLUSHATTRS ) ) ) +		{ +			$this->_MBPop (); +			return -1; +		} + +		$tag = -1; +		if ( strlen($response)==4 ) +			list(,$tag) = unpack ( "N*", $response ); +		else +			$this->_error = "unexpected response length"; + +		$this->_MBPop (); +		return $tag; +	} +} + +// +// $Id: sphinxapi.php 3087 2012-01-30 23:07:35Z shodan $ +// diff --git a/phpBB/includes/style/style.php b/phpBB/includes/style/style.php index effd496fb9..4703c3a219 100644 --- a/phpBB/includes/style/style.php +++ b/phpBB/includes/style/style.php @@ -91,16 +91,22 @@ class phpbb_style  	{  		$style_path = $this->user->style['style_path'];  		$style_dirs = ($this->user->style['style_parent_id']) ? array_reverse(explode('/', $this->user->style['style_parent_tree'])) : array(); -		$paths = array($this->get_style_path($style_path)); + +		$names = array($style_path);  		foreach ($style_dirs as $dir)  		{ -			$paths[] = $this->get_style_path($dir); +			$names[] = $dir;  		} +		// Add 'all' path, used as last fallback path by events and extensions +		//$names[] = 'all'; -		// Add 'all' path, used as last fallback path by hooks and extensions -		$paths[] = $this->get_style_path('all'); +		$paths = array(); +		foreach ($names as $name) +		{ +			$paths[] = $this->get_style_path($name); +		} -		return $this->set_custom_style($style_path, $paths); +		return $this->set_custom_style($style_path, $paths, $names);  	}  	/** @@ -110,18 +116,27 @@ class phpbb_style  	*  	* @param string $name Name of style, used for cache prefix. Examples: "admin", "prosilver"  	* @param array or string $paths Array of style paths, relative to current root directory +	* @param array $names Array of names of templates in inheritance tree order, used by extensions. If empty, $name will be used.  	* @param string $template_path Path to templates, relative to style directory. False if path should be set to default (templates/).  	*/ -	public function set_custom_style($name, $paths, $template_path = false) +	public function set_custom_style($name, $paths, $names = array(), $template_path = false)  	{  		if (is_string($paths))  		{  			$paths = array($paths);  		} +		if (empty($names)) +		{ +			$names = array($name); +		} +		$this->names = $names; +  		$this->provider->set_styles($paths);  		$this->locator->set_paths($this->provider); +		$this->template->set_style_names($names); +  		if ($template_path !== false)  		{  			$this->locator->set_template_path($template_path); diff --git a/phpBB/includes/template/compile.php b/phpBB/includes/template/compile.php index 22da21820e..fcdaf7abda 100644 --- a/phpBB/includes/template/compile.php +++ b/phpBB/includes/template/compile.php @@ -35,16 +35,23 @@ class phpbb_template_compile  	/**  	* Constructor.  	* -	* @param bool @allow_php Whether PHP code will be allowed in templates (inline PHP code, PHP tag and INCLUDEPHP tag) +	* @param bool $allow_php Whether PHP code will be allowed in templates (inline PHP code, PHP tag and INCLUDEPHP tag) +	* @param array $style_names Name of style to which the template being compiled belongs and parents in style tree order  	* @param phpbb_style_resource_locator $locator Resource locator  	* @param string $phpbb_root_path Path to phpBB root directory +	* @param phpbb_extension_manager $extension_manager Extension manager to use for finding template fragments in extensions; if null, template events will not be invoked +	* @param phpbb_user $user Current user  	*/ -	public function __construct($allow_php, $locator, $phpbb_root_path) +	public function __construct($allow_php, $style_names, $locator, $phpbb_root_path, $extension_manager = null, $user = null)  	{  		$this->filter_params = array(  			'allow_php'	=> $allow_php, +			'style_names'	=> $style_names,  			'locator'	=> $locator, -			'phpbb_root_path'	=> $phpbb_root_path +			'phpbb_root_path'	=> $phpbb_root_path, +			'extension_manager'	=> $extension_manager, +			'user'          => $user, +			'template_compile'	=> $this,  		);  	} diff --git a/phpBB/includes/template/filter.php b/phpBB/includes/template/filter.php index 66d28242a3..f73ad28ba1 100644 --- a/phpBB/includes/template/filter.php +++ b/phpBB/includes/template/filter.php @@ -88,6 +88,37 @@ class phpbb_template_filter extends php_user_filter  	private $phpbb_root_path;  	/** +	* Name of the style that the template being compiled and/or rendered +	* belongs to, and its parents, in inheritance tree order. +	* +	* Used to invoke style-specific template events. +	* +	* @var array +	*/ +	private $style_names; + +	/** +	* Extension manager. +	* +	* @var phpbb_extension_manager +	*/ +	private $extension_manager; + +	/** +	* Current user +	* +	* @var phpbb_user +	*/ +	private $user; + +	/** +	* Template compiler. +	* +	* @var phpbb_template_compile +	*/ +	private $template_compile; + +	/**  	* Stream filter  	*  	* Is invoked for evey chunk of the stream, allowing us @@ -138,8 +169,10 @@ class phpbb_template_filter extends php_user_filter  	/**  	* Initializer, called on creation.  	* -	* Get the allow_php option, root directory and locator from params, +	* Get the allow_php option, style_names, root directory and locator from params,  	* which are passed to stream_filter_append. +	* +	* @return boolean Returns true  	*/  	public function onCreate()  	{ @@ -148,6 +181,13 @@ class phpbb_template_filter extends php_user_filter  		$this->allow_php = $this->params['allow_php'];  		$this->locator = $this->params['locator'];  		$this->phpbb_root_path = $this->params['phpbb_root_path']; +		$this->style_names = $this->params['style_names']; +		$this->extension_manager = $this->params['extension_manager']; +		if (isset($this->params['user'])) +		{ +			$this->user = $this->params['user']; +		} +		$this->template_compile = $this->params['template_compile'];  		return true;  	} @@ -229,7 +269,9 @@ class phpbb_template_filter extends php_user_filter  	}  	/** -	* Callback for replacing matched tokens with PHP code +	* Callback for replacing matched tokens with compiled template code. +	* +	* Compiled template code is an HTML stream with embedded PHP.  	*  	* @param array $matches Regular expression matches  	* @return string compiled template code @@ -317,6 +359,10 @@ class phpbb_template_filter extends php_user_filter  				return '<!-- ENDPHP -->';  			break; +			case 'EVENT': +				return '<?php ' . $this->compile_tag_event($matches[2]) . '?>'; +			break; +  			default:  				return $matches[0];  			break; @@ -836,6 +882,97 @@ class phpbb_template_filter extends php_user_filter  	}  	/** +	* Compile EVENT tag. +	* +	* $tag_args should be a single string identifying the event. +	* The event name can contain letters, numbers and underscores only. +	* If an invalid event name is specified, an E_USER_ERROR will be +	* triggered. +	* +	* Event tags are only functional when the template engine has +	* an instance of the extension manager. Extension manager would +	* be called upon to find all extensions listening for the specified +	* event, and to obtain additional template fragments. All such +	* template fragments will be compiled and included in the generated +	* compiled template code for the current template being compiled. +	* +	* The above means that whenever an extension is enabled or disabled, +	* template cache should be cleared in order to update the compiled +	* template code for the active set of template event listeners. +	* +	* This also means that extensions cannot return different template +	* fragments at different times. Once templates are compiled, changing +	* such template fragments would have no effect. +	* +	* @param string $tag_args EVENT tag arguments, as a string - for EVENT this is the event name +	* @return string compiled template code +	*/ +	private function compile_tag_event($tag_args) +	{ +		if (!preg_match('/^\w+$/', $tag_args)) +		{ +			// The event location is improperly formatted, +			if ($this->user) +			{ +				trigger_error($this->user->lang('ERR_TEMPLATE_EVENT_LOCATION', $tag_args), E_USER_ERROR); +			} +			else +			{ +				trigger_error(sprintf('The specified template event location <em>[%s]</em> is improperly formatted.', $tag_args), E_USER_ERROR); +			} +		} +		$location = $tag_args; + +		if ($this->extension_manager) +		{ +			$finder = $this->extension_manager->get_finder(); + +			$files = $finder +				->extension_prefix($location) +				->extension_suffix('.html') +				->extension_directory("/styles/all/template") +				->get_files(); + +			foreach ($this->style_names as $style_name) +			{ +				$more_files = $finder +					->extension_prefix($location) +					->extension_suffix('.html') +					->extension_directory("/styles/" . $style_name . "/template") +					->get_files(); +				if (!empty($more_files)) +				{ +					$files = array_merge($files, $more_files); +					break; +				} +			} + +			$all_compiled = ''; +			foreach ($files as $file) +			{ +				$compiled = $this->template_compile->compile_file($file); + +				if ($compiled === false) +				{ +					if ($this->user) +					{ +						trigger_error($this->user->lang('ERR_TEMPLATE_COMPILATION', phpbb_filter_root_path($file)), E_USER_ERROR); +					} +					else +					{ +						trigger_error(sprintf('The file could not be compiled: %s', phpbb_filter_root_path($file)), E_USER_ERROR); +					} +				} + +				$all_compiled .= $compiled; +			} +			// Need spaces inside php tags as php cannot grok +			// < ?php? > sans the spaces +			return ' ?' . '>' . $all_compiled . '<?php '; +		} +	} + +	/**  	* parse expression  	* This is from Smarty  	*/ diff --git a/phpBB/includes/template/locator.php b/phpBB/includes/template/locator.php index 42db91efb2..f6fd20bcc2 100644 --- a/phpBB/includes/template/locator.php +++ b/phpBB/includes/template/locator.php @@ -39,7 +39,7 @@ interface phpbb_template_locator  	* Sets the template filenames for handles. $filename_array  	* should be a hash of handle => filename pairs.  	* -	* @param array $filname_array Should be a hash of handle => filename pairs. +	* @param array $filename_array Should be a hash of handle => filename pairs.  	*/  	public function set_filenames(array $filename_array); @@ -66,7 +66,7 @@ interface phpbb_template_locator  	* returns actually exists, it is faster than get_source_file_for_handle.  	*  	* Use get_source_file_for_handle to obtain the actual path that is -	* guaranteed to exist (which might come from the parent style  +	* guaranteed to exist (which might come from the parent style  	* directory if primary style has parent styles).  	*  	* This function will trigger an error if the handle was never diff --git a/phpBB/includes/template/template.php b/phpBB/includes/template/template.php index 5396ddbfad..bbec768613 100644 --- a/phpBB/includes/template/template.php +++ b/phpBB/includes/template/template.php @@ -75,14 +75,32 @@ class phpbb_template  	private $locator;  	/** +	* Extension manager. +	* +	* @var phpbb_extension_manager +	*/ +	private $extension_manager; + +	/** +	* Name of the style that the template being compiled and/or rendered +	* belongs to, and its parents, in inheritance tree order. +	* +	* Used to invoke style-specific template events. +	* +	* @var array +	*/ +	private $style_names; + +	/**  	* Constructor.  	*  	* @param string $phpbb_root_path phpBB root path  	* @param user $user current user  	* @param phpbb_template_locator $locator template locator  	* @param phpbb_template_context $context template context +	* @param phpbb_extension_manager $extension_manager extension manager, if null then template events will not be invoked  	*/ -	public function __construct($phpbb_root_path, $php_ext, $config, $user, phpbb_template_locator $locator, phpbb_template_context $context) +	public function __construct($phpbb_root_path, $php_ext, $config, $user, phpbb_template_locator $locator, phpbb_template_context $context, phpbb_extension_manager $extension_manager = null)  	{  		$this->phpbb_root_path = $phpbb_root_path;  		$this->php_ext = $php_ext; @@ -90,12 +108,13 @@ class phpbb_template  		$this->user = $user;  		$this->locator = $locator;  		$this->context = $context; +		$this->extension_manager = $extension_manager;  	}  	/**  	* Sets the template filenames for handles.  	* -	* @param array $filname_array Should be a hash of handle => filename pairs. +	* @param array $filename_array Should be a hash of handle => filename pairs.  	*/  	public function set_filenames(array $filename_array)  	{ @@ -105,6 +124,18 @@ class phpbb_template  	}  	/** +	* Sets the style names corresponding to style hierarchy being compiled +	* and/or rendered. +	* +	* @param array $style_names List of style names in inheritance tree order +	* @return null +	*/ +	public function set_style_names(array $style_names) +	{ +		$this->style_names = $style_names; +	} + +	/**  	* Clears all variables and blocks assigned to this template.  	*/  	public function destroy() @@ -282,7 +313,7 @@ class phpbb_template  			return new phpbb_template_renderer_include($output_file, $this);  		} -		$compile = new phpbb_template_compile($this->config['tpl_allow_php'], $this->locator, $this->phpbb_root_path); +		$compile = new phpbb_template_compile($this->config['tpl_allow_php'], $this->style_names, $this->locator, $this->phpbb_root_path, $this->extension_manager, $this->user);  		if ($compile->compile_file_to_file($source_file, $output_file) !== false)  		{  | 
