PageRenderTime 56ms CodeModel.GetById 28ms RepoModel.GetById 0ms app.codeStats 0ms

/phpBB/phpbb/search/fulltext_sphinx.php

http://github.com/phpbb/phpbb
PHP | 1058 lines | 651 code | 117 blank | 290 comment | 67 complexity | fed641d7e1b8758934ca5bbd89d1d33a MD5 | raw file
Possible License(s): GPL-3.0, AGPL-1.0 
    

  1. <?php
    2. 

  2. /**
    3. 

  3. *
    4. 

  4. * This file is part of the phpBB Forum Software package.
    5. 

  5. *
    6. 

  6. * @copyright (c) phpBB Limited <https://www.phpbb.com>
    7. 

  7. * @license GNU General Public License, version 2 (GPL-2.0)
    8. 

  8. *
    9. 

  9. * For full copyright and license information, please see
    10. 

  10. * the docs/CREDITS.txt file.
    11. 

  11. *
    12. 

  12. */
    13. 

  13. 

  14. namespace phpbb\search;
    15. 

  15. 

  16. define('SPHINX_MAX_MATCHES', 20000);
    17. 

  17. define('SPHINX_CONNECT_RETRIES', 3);
    18. 

  18. define('SPHINX_CONNECT_WAIT_TIME', 300);
    19. 

  19. 

  20. /**
    21. 

  21. * Fulltext search based on the sphinx search daemon
    22. 

  22. */
    23. 

  23. class fulltext_sphinx
    24. 

  24. {
    25. 

  25. 	/**
    26. 

  26. 	 * Associative array holding index stats
    27. 

  27. 	 * @var array
    28. 

  28. 	 */
    29. 

  29. 	protected $stats = array();
    30. 

  30. 

  31. 	/**
    32. 

  32. 	 * Holds the words entered by user, obtained by splitting the entered query on whitespace
    33. 

  33. 	 * @var array
    34. 

  34. 	 */
    35. 

  35. 	protected $split_words = array();
    36. 

  36. 

  37. 	/**
    38. 

  38. 	 * Holds unique sphinx id
    39. 

  39. 	 * @var string
    40. 

  40. 	 */
    41. 

  41. 	protected $id;
    42. 

  42. 

  43. 	/**
    44. 

  44. 	 * Stores the names of both main and delta sphinx indexes
    45. 

  45. 	 * separated by a semicolon
    46. 

  46. 	 * @var string
    47. 

  47. 	 */
    48. 

  48. 	protected $indexes;
    49. 

  49. 

  50. 	/**
    51. 

  51. 	 * Sphinx searchd client object
    52. 

  52. 	 * @var SphinxClient
    53. 

  53. 	 */
    54. 

  54. 	protected $sphinx;
    55. 

  55. 

  56. 	/**
    57. 

  57. 	 * Relative path to board root
    58. 

  58. 	 * @var string
    59. 

  59. 	 */
    60. 

  60. 	protected $phpbb_root_path;
    61. 

  61. 

  62. 	/**
    63. 

  63. 	 * PHP Extension
    64. 

  64. 	 * @var string
    65. 

  65. 	 */
    66. 

  66. 	protected $php_ext;
    67. 

  67. 

  68. 	/**
    69. 

  69. 	 * Auth object
    70. 

  70. 	 * @var \phpbb\auth\auth
    71. 

  71. 	 */
    72. 

  72. 	protected $auth;
    73. 

  73. 

  74. 	/**
    75. 

  75. 	 * Config object
    76. 

  76. 	 * @var \phpbb\config\config
    77. 

  77. 	 */
    78. 

  78. 	protected $config;
    79. 

  79. 

  80. 	/**
    81. 

  81. 	 * Database connection
    82. 

  82. 	 * @var \phpbb\db\driver\driver_interface
    83. 

  83. 	 */
    84. 

  84. 	protected $db;
    85. 

  85. 

  86. 	/**
    87. 

  87. 	 * Database Tools object
    88. 

  88. 	 * @var \phpbb\db\tools\tools_interface
    89. 

  89. 	 */
    90. 

  90. 	protected $db_tools;
    91. 

  91. 

  92. 	/**
    93. 

  93. 	 * Stores the database type if supported by sphinx
    94. 

  94. 	 * @var string
    95. 

  95. 	 */
    96. 

  96. 	protected $dbtype;
    97. 

  97. 

  98. 	/**
    99. 

  99. 	 * phpBB event dispatcher object
    100. 

  100. 	 * @var \phpbb\event\dispatcher_interface
    101. 

  101. 	 */
    102. 

  102. 	protected $phpbb_dispatcher;
    103. 

  103. 

  104. 	/**
    105. 

  105. 	 * User object
    106. 

  106. 	 * @var \phpbb\user
    107. 

  107. 	 */
    108. 

  108. 	protected $user;
    109. 

  109. 

  110. 	/**
    111. 

  111. 	 * Stores the generated content of the sphinx config file
    112. 

  112. 	 * @var string
    113. 

  113. 	 */
    114. 

  114. 	protected $config_file_data = '';
    115. 

  115. 

  116. 	/**
    117. 

  117. 	 * Contains tidied search query.
    118. 

  118. 	 * Operators are prefixed in search query and common words excluded
    119. 

  119. 	 * @var string
    120. 

  120. 	 */
    121. 

  121. 	protected $search_query;
    122. 

  122. 

  123. 	/**
    124. 

  124. 	 * Constructor
    125. 

  125. 	 * Creates a new \phpbb\search\fulltext_postgres, which is used as a search backend
    126. 

  126. 	 *
    127. 

  127. 	 * @param string|bool $error Any error that occurs is passed on through this reference variable otherwise false
    128. 

  128. 	 * @param string $phpbb_root_path Relative path to phpBB root
    129. 

  129. 	 * @param string $phpEx PHP file extension
    130. 

  130. 	 * @param \phpbb\auth\auth $auth Auth object
    131. 

  131. 	 * @param \phpbb\config\config $config Config object
    132. 

  132. 	 * @param \phpbb\db\driver\driver_interface Database object
    133. 

  133. 	 * @param \phpbb\user $user User object
    134. 

  134. 	 * @param \phpbb\event\dispatcher_interface	$phpbb_dispatcher	Event dispatcher object
    135. 

  135. 	 */
    136. 

  136. 	public function __construct(&$error, $phpbb_root_path, $phpEx, $auth, $config, $db, $user, $phpbb_dispatcher)
    137. 

  137. 	{
    138. 

  138. 		$this->phpbb_root_path = $phpbb_root_path;
    139. 

  139. 		$this->php_ext = $phpEx;
    140. 

  140. 		$this->config = $config;
    141. 

  141. 		$this->phpbb_dispatcher = $phpbb_dispatcher;
    142. 

  142. 		$this->user = $user;
    143. 

  143. 		$this->db = $db;
    144. 

  144. 		$this->auth = $auth;
    145. 

  145. 

  146. 		// Initialize \phpbb\db\tools\tools object
    147. 

  147. 		global $phpbb_container; // TODO inject into object
    148. 

  148. 		$this->db_tools = $phpbb_container->get('dbal.tools');
    149. 

  149. 

  150. 		if (!$this->config['fulltext_sphinx_id'])
    151. 

  151. 		{
    152. 

  152. 			$this->config->set('fulltext_sphinx_id', unique_id());
    153. 

  153. 		}
    154. 

  154. 		$this->id = $this->config['fulltext_sphinx_id'];
    155. 

  155. 		$this->indexes = 'index_phpbb_' . $this->id . '_delta;index_phpbb_' . $this->id . '_main';
    156. 

  156. 

  157. 		if (!class_exists('SphinxClient'))
    158. 

  158. 		{
    159. 

  159. 			require($this->phpbb_root_path . 'includes/sphinxapi.' . $this->php_ext);
    160. 

  160. 		}
    161. 

  161. 

  162. 		// Initialize sphinx client
    163. 

  163. 		$this->sphinx = new \SphinxClient();
    164. 

  164. 

  165. 		$this->sphinx->SetServer(($this->config['fulltext_sphinx_host'] ? $this->config['fulltext_sphinx_host'] : 'localhost'), ($this->config['fulltext_sphinx_port'] ? (int) $this->config['fulltext_sphinx_port'] : 9312));
    166. 

  166. 

  167. 		$error = false;
    168. 

  168. 	}
    169. 

  169. 

  170. 	/**
    171. 

  171. 	* Returns the name of this search backend to be displayed to administrators
    172. 

  172. 	*
    173. 

  173. 	* @return string Name
    174. 

  174. 	*/
    175. 

  175. 	public function get_name()
    176. 

  176. 	{
    177. 

  177. 		return 'Sphinx Fulltext';
    178. 

  178. 	}
    179. 

  179. 

  180. 	/**
    181. 

  181. 	 * Returns the search_query
    182. 

  182. 	 *
    183. 

  183. 	 * @return string search query
    184. 

  184. 	 */
    185. 

  185. 	public function get_search_query()
    186. 

  186. 	{
    187. 

  187. 		return $this->search_query;
    188. 

  188. 	}
    189. 

  189. 

  190. 	/**
    191. 

  191. 	 * Returns false as there is no word_len array
    192. 

  192. 	 *
    193. 

  193. 	 * @return false
    194. 

  194. 	 */
    195. 

  195. 	public function get_word_length()
    196. 

  196. 	{
    197. 

  197. 		return false;
    198. 

  198. 	}
    199. 

  199. 

  200. 	/**
    201. 

  201. 	 * Returns an empty array as there are no common_words
    202. 

  202. 	 *
    203. 

  203. 	 * @return array common words that are ignored by search backend
    204. 

  204. 	 */
    205. 

  205. 	public function get_common_words()
    206. 

  206. 	{
    207. 

  207. 		return array();
    208. 

  208. 	}
    209. 

  209. 

  210. 	/**
    211. 

  211. 	* Checks permissions and paths, if everything is correct it generates the config file
    212. 

  212. 	*
    213. 

  213. 	* @return string|bool Language key of the error/incompatibility encountered, or false if successful
    214. 

  214. 	*/
    215. 

  215. 	public function init()
    216. 

  216. 	{
    217. 

  217. 		if ($this->db->get_sql_layer() != 'mysqli' && $this->db->get_sql_layer() != 'postgres')
    218. 

  218. 		{
    219. 

  219. 			return $this->user->lang['FULLTEXT_SPHINX_WRONG_DATABASE'];
    220. 

  220. 		}
    221. 

  221. 

  222. 		// Move delta to main index each hour
    223. 

  223. 		$this->config->set('search_gc', 3600);
    224. 

  224. 

  225. 		return false;
    226. 

  226. 	}
    227. 

  227. 

  228. 	/**
    229. 

  229. 	 * Generates content of sphinx.conf
    230. 

  230. 	 *
    231. 

  231. 	 * @return bool True if sphinx.conf content is correctly generated, false otherwise
    232. 

  232. 	 */
    233. 

  233. 	protected function config_generate()
    234. 

  234. 	{
    235. 

  235. 		// Check if Database is supported by Sphinx
    236. 

  236. 		if ($this->db->get_sql_layer() == 'mysqli')
    237. 

  237. 		{
    238. 

  238. 			$this->dbtype = 'mysql';
    239. 

  239. 		}
    240. 

  240. 		else if ($this->db->get_sql_layer() == 'postgres')
    241. 

  241. 		{
    242. 

  242. 			$this->dbtype = 'pgsql';
    243. 

  243. 		}
    244. 

  244. 		else
    245. 

  245. 		{
    246. 

  246. 			$this->config_file_data = $this->user->lang('FULLTEXT_SPHINX_WRONG_DATABASE');
    247. 

  247. 			return false;
    248. 

  248. 		}
    249. 

  249. 

  250. 		// Check if directory paths have been filled
    251. 

  251. 		if (!$this->config['fulltext_sphinx_data_path'])
    252. 

  252. 		{
    253. 

  253. 			$this->config_file_data = $this->user->lang('FULLTEXT_SPHINX_NO_CONFIG_DATA');
    254. 

  254. 			return false;
    255. 

  255. 		}
    256. 

  256. 

  257. 		include($this->phpbb_root_path . 'config.' . $this->php_ext);
    258. 

  258. 

  259. 		/* Now that we're sure everything was entered correctly,
    260. 

  260. 		generate a config for the index. We use a config value
    261. 

  261. 		fulltext_sphinx_id for this, as it should be unique. */
    262. 

  262. 		$config_object = new \phpbb\search\sphinx\config($this->config_file_data);
    263. 

  263. 		$config_data = array(
    264. 

  264. 			'source source_phpbb_' . $this->id . '_main' => array(
    265. 

  265. 				array('type',						$this->dbtype . ' # mysql or pgsql'),
    266. 

  266. 				// This config value sql_host needs to be changed incase sphinx and sql are on different servers
    267. 

  267. 				array('sql_host',					$dbhost . ' # SQL server host sphinx connects to'),
    268. 

  268. 				array('sql_user',					'[dbuser]'),
    269. 

  269. 				array('sql_pass',					'[dbpassword]'),
    270. 

  270. 				array('sql_db',						$dbname),
    271. 

  271. 				array('sql_port',					$dbport . ' # optional, default is 3306 for mysql and 5432 for pgsql'),
    272. 

  272. 				array('sql_query_pre',				'SET NAMES \'utf8\''),
    273. 

  273. 				array('sql_query_pre',				'UPDATE ' . SPHINX_TABLE . ' SET max_doc_id = (SELECT MAX(post_id) FROM ' . POSTS_TABLE . ') WHERE counter_id = 1'),
    274. 

  274. 				array('sql_query_range',			'SELECT MIN(post_id), MAX(post_id) FROM ' . POSTS_TABLE . ''),
    275. 

  275. 				array('sql_range_step',				'5000'),
    276. 

  276. 				array('sql_query',					'SELECT
    277. 

  277. 						p.post_id AS id,
    278. 

  278. 						p.forum_id,
    279. 

  279. 						p.topic_id,
    280. 

  280. 						p.poster_id,
    281. 

  281. 						p.post_visibility,
    282. 

  282. 						CASE WHEN p.post_id = t.topic_first_post_id THEN 1 ELSE 0 END as topic_first_post,
    283. 

  283. 						p.post_time,
    284. 

  284. 						p.post_subject,
    285. 

  285. 						p.post_subject as title,
    286. 

  286. 						p.post_text as data,
    287. 

  287. 						t.topic_last_post_time,
    288. 

  288. 						0 as deleted
    289. 

  289. 					FROM ' . POSTS_TABLE . ' p, ' . TOPICS_TABLE . ' t
    290. 

  290. 					WHERE
    291. 

  291. 						p.topic_id = t.topic_id
    292. 

  292. 						AND p.post_id >= $start AND p.post_id <= $end'),
    293. 

  293. 				array('sql_query_post',				''),
    294. 

  294. 				array('sql_query_post_index',		'UPDATE ' . SPHINX_TABLE . ' SET max_doc_id = $maxid WHERE counter_id = 1'),
    295. 

  295. 				array('sql_attr_uint',				'forum_id'),
    296. 

  296. 				array('sql_attr_uint',				'topic_id'),
    297. 

  297. 				array('sql_attr_uint',				'poster_id'),
    298. 

  298. 				array('sql_attr_uint',				'post_visibility'),
    299. 

  299. 				array('sql_attr_bool',				'topic_first_post'),
    300. 

  300. 				array('sql_attr_bool',				'deleted'),
    301. 

  301. 				array('sql_attr_timestamp',			'post_time'),
    302. 

  302. 				array('sql_attr_timestamp',			'topic_last_post_time'),
    303. 

  303. 				array('sql_attr_string',			'post_subject'),
    304. 

  304. 			),
    305. 

  305. 			'source source_phpbb_' . $this->id . '_delta : source_phpbb_' . $this->id . '_main' => array(
    306. 

  306. 				array('sql_query_pre',				'SET NAMES \'utf8\''),
    307. 

  307. 				array('sql_query_range',			''),
    308. 

  308. 				array('sql_range_step',				''),
    309. 

  309. 				array('sql_query',					'SELECT
    310. 

  310. 						p.post_id AS id,
    311. 

  311. 						p.forum_id,
    312. 

  312. 						p.topic_id,
    313. 

  313. 						p.poster_id,
    314. 

  314. 						p.post_visibility,
    315. 

  315. 						CASE WHEN p.post_id = t.topic_first_post_id THEN 1 ELSE 0 END as topic_first_post,
    316. 

  316. 						p.post_time,
    317. 

  317. 						p.post_subject,
    318. 

  318. 						p.post_subject as title,
    319. 

  319. 						p.post_text as data,
    320. 

  320. 						t.topic_last_post_time,
    321. 

  321. 						0 as deleted
    322. 

  322. 					FROM ' . POSTS_TABLE . ' p, ' . TOPICS_TABLE . ' t
    323. 

  323. 					WHERE
    324. 

  324. 						p.topic_id = t.topic_id
    325. 

  325. 						AND p.post_id >=  ( SELECT max_doc_id FROM ' . SPHINX_TABLE . ' WHERE counter_id=1 )'),
    326. 

  326. 				array('sql_query_post_index',		''),
    327. 

  327. 			),
    328. 

  328. 			'index index_phpbb_' . $this->id . '_main' => array(
    329. 

  329. 				array('path',						$this->config['fulltext_sphinx_data_path'] . 'index_phpbb_' . $this->id . '_main'),
    330. 

  330. 				array('source',						'source_phpbb_' . $this->id . '_main'),
    331. 

  331. 				array('docinfo',					'extern'),
    332. 

  332. 				array('morphology',					'none'),
    333. 

  333. 				array('stopwords',					''),
    334. 

  334. 				array('wordforms',					'  # optional, specify path to wordforms file. See ./docs/sphinx_wordforms.txt for example'),
    335. 

  335. 				array('exceptions',					'  # optional, specify path to exceptions file. See ./docs/sphinx_exceptions.txt for example'),
    336. 

  336. 				array('min_word_len',				'2'),
    337. 

  337. 				array('charset_table',				'U+FF10..U+FF19->0..9, 0..9, U+FF41..U+FF5A->a..z, U+FF21..U+FF3A->a..z, A..Z->a..z, a..z, U+0149, U+017F, U+0138, U+00DF, U+00FF, U+00C0..U+00D6->U+00E0..U+00F6, U+00E0..U+00F6, U+00D8..U+00DE->U+00F8..U+00FE, U+00F8..U+00FE, U+0100->U+0101, U+0101, U+0102->U+0103, U+0103, U+0104->U+0105, U+0105, U+0106->U+0107, U+0107, U+0108->U+0109, U+0109, U+010A->U+010B, U+010B, U+010C->U+010D, U+010D, U+010E->U+010F, U+010F, U+0110->U+0111, U+0111, U+0112->U+0113, U+0113, U+0114->U+0115, U+0115, U+0116->U+0117, U+0117, U+0118->U+0119, U+0119, U+011A->U+011B, U+011B, U+011C->U+011D, U+011D, U+011E->U+011F, U+011F, U+0130->U+0131, U+0131, U+0132->U+0133, U+0133, U+0134->U+0135, U+0135, U+0136->U+0137, U+0137, U+0139->U+013A, U+013A, U+013B->U+013C, U+013C, U+013D->U+013E, U+013E, U+013F->U+0140, U+0140, U+0141->U+0142, U+0142, U+0143->U+0144, U+0144, U+0145->U+0146, U+0146, U+0147->U+0148, U+0148, U+014A->U+014B, U+014B, U+014C->U+014D, U+014D, U+014E->U+014F, U+014F, U+0150->U+0151, U+0151, U+0152->U+0153, U+0153, U+0154->U+0155, U+0155, U+0156->U+0157, U+0157, U+0158->U+0159, U+0159, U+015A->U+015B, U+015B, U+015C->U+015D, U+015D, U+015E->U+015F, U+015F, U+0160->U+0161, U+0161, U+0162->U+0163, U+0163, U+0164->U+0165, U+0165, U+0166->U+0167, U+0167, U+0168->U+0169, U+0169, U+016A->U+016B, U+016B, U+016C->U+016D, U+016D, U+016E->U+016F, U+016F, U+0170->U+0171, U+0171, U+0172->U+0173, U+0173, U+0174->U+0175, U+0175, U+0176->U+0177, U+0177, U+0178->U+00FF, U+00FF, U+0179->U+017A, U+017A, U+017B->U+017C, U+017C, U+017D->U+017E, U+017E, U+0410..U+042F->U+0430..U+044F, U+0430..U+044F, U+4E00..U+9FFF'),
    338. 

  338. 				array('ignore_chars', 				'U+0027, U+002C'),
    339. 

  339. 				array('min_prefix_len',				'3 # Minimum number of characters for wildcard searches by prefix (min 1). Default is 3. If specified, set min_infix_len to 0'),
    340. 

  340. 				array('min_infix_len',				'0 # Minimum number of characters for wildcard searches by infix (min 2). If specified, set min_prefix_len to 0'),
    341. 

  341. 				array('html_strip',					'1'),
    342. 

  342. 				array('index_exact_words',			'0 # Set to 1 to enable exact search operator. Requires wordforms or morphology'),
    343. 

  343. 				array('blend_chars', 				'U+23, U+24, U+25, U+26, U+40'),
    344. 

  344. 			),
    345. 

  345. 			'index index_phpbb_' . $this->id . '_delta : index_phpbb_' . $this->id . '_main' => array(
    346. 

  346. 				array('path',						$this->config['fulltext_sphinx_data_path'] . 'index_phpbb_' . $this->id . '_delta'),
    347. 

  347. 				array('source',						'source_phpbb_' . $this->id . '_delta'),
    348. 

  348. 			),
    349. 

  349. 			'indexer' => array(
    350. 

  350. 				array('mem_limit',					$this->config['fulltext_sphinx_indexer_mem_limit'] . 'M'),
    351. 

  351. 			),
    352. 

  352. 			'searchd' => array(
    353. 

  353. 				array('listen'	,					($this->config['fulltext_sphinx_host'] ? $this->config['fulltext_sphinx_host'] : 'localhost') . ':' . ($this->config['fulltext_sphinx_port'] ? $this->config['fulltext_sphinx_port'] : '9312')),
    354. 

  354. 				array('log',						$this->config['fulltext_sphinx_data_path'] . 'log/searchd.log'),
    355. 

  355. 				array('query_log',					$this->config['fulltext_sphinx_data_path'] . 'log/sphinx-query.log'),
    356. 

  356. 				array('read_timeout',				'5'),
    357. 

  357. 				array('max_children',				'30'),
    358. 

  358. 				array('pid_file',					$this->config['fulltext_sphinx_data_path'] . 'searchd.pid'),
    359. 

  359. 				array('binlog_path',				$this->config['fulltext_sphinx_data_path']),
    360. 

  360. 			),
    361. 

  361. 		);
    362. 

  362. 

  363. 		$non_unique = array('sql_query_pre' => true, 'sql_attr_uint' => true, 'sql_attr_timestamp' => true, 'sql_attr_str2ordinal' => true, 'sql_attr_bool' => true);
    364. 

  364. 		$delete = array('sql_group_column' => true, 'sql_date_column' => true, 'sql_str2ordinal_column' => true);
    365. 

  365. 

  366. 		/**
    367. 

  367. 		* Allow adding/changing the Sphinx configuration data
    368. 

  368. 		*
    369. 

  369. 		* @event core.search_sphinx_modify_config_data
    370. 

  370. 		* @var	array	config_data	Array with the Sphinx configuration data
    371. 

  371. 		* @var	array	non_unique	Array with the Sphinx non-unique variables to delete
    372. 

  372. 		* @var	array	delete		Array with the Sphinx variables to delete
    373. 

  373. 		* @since 3.1.7-RC1
    374. 

  374. 		*/
    375. 

  375. 		$vars = array(
    376. 

  376. 			'config_data',
    377. 

  377. 			'non_unique',
    378. 

  378. 			'delete',
    379. 

  379. 		);
    380. 

  380. 		extract($this->phpbb_dispatcher->trigger_event('core.search_sphinx_modify_config_data', compact($vars)));
    381. 

  381. 

  382. 		foreach ($config_data as $section_name => $section_data)
    383. 

  383. 		{
    384. 

  384. 			$section = $config_object->get_section_by_name($section_name);
    385. 

  385. 			if (!$section)
    386. 

  386. 			{
    387. 

  387. 				$section = $config_object->add_section($section_name);
    388. 

  388. 			}
    389. 

  389. 

  390. 			foreach ($delete as $key => $void)
    391. 

  391. 			{
    392. 

  392. 				$section->delete_variables_by_name($key);
    393. 

  393. 			}
    394. 

  394. 

  395. 			foreach ($non_unique as $key => $void)
    396. 

  396. 			{
    397. 

  397. 				$section->delete_variables_by_name($key);
    398. 

  398. 			}
    399. 

  399. 

  400. 			foreach ($section_data as $entry)
    401. 

  401. 			{
    402. 

  402. 				$key = $entry[0];
    403. 

  403. 				$value = $entry[1];
    404. 

  404. 

  405. 				if (!isset($non_unique[$key]))
    406. 

  406. 				{
    407. 

  407. 					$variable = $section->get_variable_by_name($key);
    408. 

  408. 					if (!$variable)
    409. 

  409. 					{
    410. 

  410. 						$section->create_variable($key, $value);
    411. 

  411. 					}
    412. 

  412. 					else
    413. 

  413. 					{
    414. 

  414. 						$variable->set_value($value);
    415. 

  415. 					}
    416. 

  416. 				}
    417. 

  417. 				else
    418. 

  418. 				{
    419. 

  419. 					$section->create_variable($key, $value);
    420. 

  420. 				}
    421. 

  421. 			}
    422. 

  422. 		}
    423. 

  423. 		$this->config_file_data = $config_object->get_data();
    424. 

  424. 

  425. 		return true;
    426. 

  426. 	}
    427. 

  427. 

  428. 	/**
    429. 

  429. 	* Splits keywords entered by a user into an array of words stored in $this->split_words
    430. 

  430. 	* Stores the tidied search query in $this->search_query
    431. 

  431. 	*
    432. 

  432. 	* @param string $keywords Contains the keyword as entered by the user
    433. 

  433. 	* @param string $terms is either 'all' or 'any'
    434. 

  434. 	* @return false if no valid keywords were found and otherwise true
    435. 

  435. 	*/
    436. 

  436. 	public function split_keywords(&$keywords, $terms)
    437. 

  437. 	{
    438. 

  438. 		// Keep quotes and new lines
    439. 

  439. 		$keywords = str_replace(['&quot;', "\n"], ['"', ' '], trim($keywords));
    440. 

  440. 

  441. 		if ($terms == 'all')
    442. 

  442. 		{
    443. 

  443. 			// Replaces verbal operators OR and NOT with special characters | and -, unless appearing within quotation marks
    444. 

  444. 			$match		= ['#\sor\s(?=([^"]*"[^"]*")*[^"]*$)#i', '#\snot\s(?=([^"]*"[^"]*")*[^"]*$)#i'];
    445. 

  445. 			$replace	= [' | ', ' -'];
    446. 

  446. 

  447. 			$keywords = preg_replace($match, $replace, $keywords);
    448. 

  448. 			$this->sphinx->SetMatchMode(SPH_MATCH_EXTENDED);
    449. 

  449. 		}
    450. 

  450. 		else
    451. 

  451. 		{
    452. 

  452. 			$match = ['\\', '(',')', '|', '!', '@', '~', '/', '^', '$', '=', '&amp;', '&lt;', '&gt;'];
    453. 

  453. 

  454. 			$keywords = str_replace($match, ' ', $keywords);
    455. 

  455. 			$this->sphinx->SetMatchMode(SPH_MATCH_ANY);
    456. 

  456. 		}
    457. 

  457. 

  458. 		if (strlen($keywords) > 0)
    459. 

  459. 		{
    460. 

  460. 			$this->search_query = str_replace('"', '&quot;', $keywords);
    461. 

  461. 			return true;
    462. 

  462. 		}
    463. 

  463. 

  464. 		return false;
    465. 

  465. 	}
    466. 

  466. 

  467. 	/**
    468. 

  468. 	* Cleans search query passed into Sphinx search engine, as follows:
    469. 

  469. 	* 1. Hyphenated words are replaced with keyword search for either the exact phrase with spaces
    470. 

  470. 	*    or as a single word without spaces eg search for "know-it-all" becomes ("know it all"|"knowitall*")
    471. 

  471. 	* 2. Words with apostrophes are contracted eg "it's" becomes "its"
    472. 

  472. 	* 3. <, >, " and & are decoded from HTML entities.
    473. 

  473. 	* 4. Following special characters used as search operators in Sphinx are preserved when used with correct syntax:
    474. 

  474. 	*    (a) quorum matching: "the world is a wonderful place"/3
    475. 

  475. 	*        Finds 3 of the words within the phrase. Number must be between 1 and 9.
    476. 

  476. 	*    (b) proximity search: "hello world"~10
    477. 

  477. 	*        Finds hello and world within 10 words of each other. Number can be between 1 and 99.
    478. 

  478. 	*    (c) strict word order: aaa << bbb << ccc
    479. 

  479. 	*        Finds "aaa" only where it appears before "bbb" and only where "bbb" appears before "ccc".
    480. 

  480. 	*    (d) exact match operator: if lemmatizer or stemming enabled,
    481. 

  481. 	*        search will find exact match only and ignore other grammatical forms of the same word stem.
    482. 

  482. 	*        eg. raining =cats and =dogs
    483. 

  483. 	*            will not return "raining cat and dog"
    484. 

  484. 	*        eg. ="search this exact phrase"
    485. 

  485. 	*            will not return "searched this exact phrase", "searching these exact phrases".
    486. 

  486. 	* 5. Special characters /, ~, << and = not complying with the correct syntax
    487. 

  487. 	*    and other reserved operators are escaped and searched literally.
    488. 

  488. 	*    Special characters not explicitly listed in charset_table or blend_chars in sphinx.conf
    489. 

  489. 	*    will not be indexed and keywords containing them will be ignored by Sphinx.
    490. 

  490. 	*    By default, only $, %, & and @ characters are indexed and searchable.
    491. 

  491. 	*    String transformation is in backend only and not visible to the end user
    492. 

  492. 	*    nor reflected in the results page URL or keyword highlighting.
    493. 

  493. 	*
    494. 

  494. 	* @param string	$search_string
    495. 

  495. 	* @return string
    496. 

  496. 	*/
    497. 

  497. 	public function sphinx_clean_search_string($search_string)
    498. 

  498. 	{
    499. 

  499. 		$from = ['@', '^', '$', '!', '&lt;', '&gt;', '&quot;', '&amp;', '\''];
    500. 

  500. 		$to = ['\@', '\^', '\$', '\!', '<', '>', '"', '&', ''];
    501. 

  501. 

  502. 		$search_string = str_replace($from, $to, $search_string);
    503. 

  503. 

  504. 		$search_string = strrev($search_string);
    505. 

  505. 		$search_string = preg_replace(['#\/(?!"[^"]+")#', '#~(?!"[^"]+")#'], ['/\\', '~\\'], $search_string);
    506. 

  506. 		$search_string = strrev($search_string);
    507. 

  507. 

  508. 		$match = ['#(/|\\\\/)(?![1-9](\s|$))#', '#(~|\\\\~)(?!\d{1,2}(\s|$))#', '#((?:\p{L}|\p{N})+)-((?:\p{L}|\p{N})+)(?:-((?:\p{L}|\p{N})+))?(?:-((?:\p{L}|\p{N})+))?#i', '#<<\s*$#', '#(\S\K=|=(?=\s)|=$)#'];
    509. 

  509. 		$replace = ['\/', '\~', '("$1 $2 $3 $4"|$1$2$3$4*)', '\<\<', '\='];
    510. 

  510. 

  511. 		$search_string = preg_replace($match, $replace, $search_string);
    512. 

  512. 		$search_string = preg_replace('#\s+"\|#', '"|', $search_string);
    513. 

  513. 

  514. 		/**
    515. 

  515. 		* OPTIONAL: Thousands separator stripped from numbers, eg search for '90,000' is queried as '90000'.
    516. 

  516. 		* By default commas are stripped from search index so that '90,000' is indexed as '90000'
    517. 

  517. 		*/
    518. 

  518. 		// $search_string = preg_replace('#[0-9]{1,3}\K,(?=[0-9]{3})#', '', $search_string);
    519. 

  519. 

  520. 		return $search_string;
    521. 

  521. 	}
    522. 

  522. 

  523. 	/**
    524. 

  524. 	* Performs a search on keywords depending on display specific params. You have to run split_keywords() first
    525. 

  525. 	*
    526. 

  526. 	* @param	string		$type				contains either posts or topics depending on what should be searched for
    527. 

  527. 	* @param	string		$fields				contains either titleonly (topic titles should be searched), msgonly (only message bodies should be searched), firstpost (only subject and body of the first post should be searched) or all (all post bodies and subjects should be searched)
    528. 

  528. 	* @param	string		$terms				is either 'all' (use query as entered, words without prefix should default to "have to be in field") or 'any' (ignore search query parts and just return all posts that contain any of the specified words)
    529. 

  529. 	* @param	array		$sort_by_sql		contains SQL code for the ORDER BY part of a query
    530. 

  530. 	* @param	string		$sort_key			is the key of $sort_by_sql for the selected sorting
    531. 

  531. 	* @param	string		$sort_dir			is either a or d representing ASC and DESC
    532. 

  532. 	* @param	string		$sort_days			specifies the maximum amount of days a post may be old
    533. 

  533. 	* @param	array		$ex_fid_ary			specifies an array of forum ids which should not be searched
    534. 

  534. 	* @param	string		$post_visibility	specifies which types of posts the user can view in which forums
    535. 

  535. 	* @param	int			$topic_id			is set to 0 or a topic id, if it is not 0 then only posts in this topic should be searched
    536. 

  536. 	* @param	array		$author_ary			an array of author ids if the author should be ignored during the search the array is empty
    537. 

  537. 	* @param	string		$author_name		specifies the author match, when ANONYMOUS is also a search-match
    538. 

  538. 	* @param	array		&$id_ary			passed by reference, to be filled with ids for the page specified by $start and $per_page, should be ordered
    539. 

  539. 	* @param	int			$start				indicates the first index of the page
    540. 

  540. 	* @param	int			$per_page			number of ids each page is supposed to contain
    541. 

  541. 	* @return	boolean|int						total number of results
    542. 

  542. 	*/
    543. 

  543. 	public function keyword_search($type, $fields, $terms, $sort_by_sql, $sort_key, $sort_dir, $sort_days, $ex_fid_ary, $post_visibility, $topic_id, $author_ary, $author_name, &$id_ary, &$start, $per_page)
    544. 

  544. 	{
    545. 

  545. 		global $user, $phpbb_log;
    546. 

  546. 

  547. 		// No keywords? No posts.
    548. 

  548. 		if (!strlen($this->search_query) && !count($author_ary))
    549. 

  549. 		{
    550. 

  550. 			return false;
    551. 

  551. 		}
    552. 

  552. 

  553. 		$id_ary = array();
    554. 

  554. 

  555. 		// Sorting
    556. 

  556. 

  557. 		if ($type == 'topics')
    558. 

  558. 		{
    559. 

  559. 			switch ($sort_key)
    560. 

  560. 			{
    561. 

  561. 				case 'a':
    562. 

  562. 					$this->sphinx->SetGroupBy('topic_id', SPH_GROUPBY_ATTR, 'poster_id ' . (($sort_dir == 'a') ? 'ASC' : 'DESC'));
    563. 

  563. 				break;
    564. 

  564. 

  565. 				case 'f':
    566. 

  566. 					$this->sphinx->SetGroupBy('topic_id', SPH_GROUPBY_ATTR, 'forum_id ' . (($sort_dir == 'a') ? 'ASC' : 'DESC'));
    567. 

  567. 				break;
    568. 

  568. 

  569. 				case 'i':
    570. 

  570. 

  571. 				case 's':
    572. 

  572. 					$this->sphinx->SetGroupBy('topic_id', SPH_GROUPBY_ATTR, 'post_subject ' . (($sort_dir == 'a') ? 'ASC' : 'DESC'));
    573. 

  573. 				break;
    574. 

  574. 

  575. 				case 't':
    576. 

  576. 

  577. 				default:
    578. 

  578. 					$this->sphinx->SetGroupBy('topic_id', SPH_GROUPBY_ATTR, 'topic_last_post_time ' . (($sort_dir == 'a') ? 'ASC' : 'DESC'));
    579. 

  579. 				break;
    580. 

  580. 			}
    581. 

  581. 		}
    582. 

  582. 		else
    583. 

  583. 		{
    584. 

  584. 			switch ($sort_key)
    585. 

  585. 			{
    586. 

  586. 				case 'a':
    587. 

  587. 					$this->sphinx->SetSortMode(($sort_dir == 'a') ? SPH_SORT_ATTR_ASC : SPH_SORT_ATTR_DESC, 'poster_id');
    588. 

  588. 				break;
    589. 

  589. 

  590. 				case 'f':
    591. 

  591. 					$this->sphinx->SetSortMode(($sort_dir == 'a') ? SPH_SORT_ATTR_ASC : SPH_SORT_ATTR_DESC, 'forum_id');
    592. 

  592. 				break;
    593. 

  593. 

  594. 				case 'i':
    595. 

  595. 

  596. 				case 's':
    597. 

  597. 					$this->sphinx->SetSortMode(($sort_dir == 'a') ? SPH_SORT_ATTR_ASC : SPH_SORT_ATTR_DESC, 'post_subject');
    598. 

  598. 				break;
    599. 

  599. 

  600. 				case 't':
    601. 

  601. 

  602. 				default:
    603. 

  603. 					$this->sphinx->SetSortMode(($sort_dir == 'a') ? SPH_SORT_ATTR_ASC : SPH_SORT_ATTR_DESC, 'post_time');
    604. 

  604. 				break;
    605. 

  605. 			}
    606. 

  606. 		}
    607. 

  607. 

  608. 		// Most narrow filters first
    609. 

  609. 		if ($topic_id)
    610. 

  610. 		{
    611. 

  611. 			$this->sphinx->SetFilter('topic_id', array($topic_id));
    612. 

  612. 		}
    613. 

  613. 

  614. 		/**
    615. 

  615. 		* Allow modifying the Sphinx search options
    616. 

  616. 		*
    617. 

  617. 		* @event core.search_sphinx_keywords_modify_options
    618. 

  618. 		* @var	string	type				Searching type ('posts', 'topics')
    619. 

  619. 		* @var	string	fields				Searching fields ('titleonly', 'msgonly', 'firstpost', 'all')
    620. 

  620. 		* @var	string	terms				Searching terms ('all', 'any')
    621. 

  621. 		* @var	int		sort_days			Time, in days, of the oldest possible post to list
    622. 

  622. 		* @var	string	sort_key			The sort type used from the possible sort types
    623. 

  623. 		* @var	int		topic_id			Limit the search to this topic_id only
    624. 

  624. 		* @var	array	ex_fid_ary			Which forums not to search on
    625. 

  625. 		* @var	string	post_visibility		Post visibility data
    626. 

  626. 		* @var	array	author_ary			Array of user_id containing the users to filter the results to
    627. 

  627. 		* @var	string	author_name			The username to search on
    628. 

  628. 		* @var	object	sphinx				The Sphinx searchd client object
    629. 

  629. 		* @since 3.1.7-RC1
    630. 

  630. 		*/
    631. 

  631. 		$sphinx = $this->sphinx;
    632. 

  632. 		$vars = array(
    633. 

  633. 			'type',
    634. 

  634. 			'fields',
    635. 

  635. 			'terms',
    636. 

  636. 			'sort_days',
    637. 

  637. 			'sort_key',
    638. 

  638. 			'topic_id',
    639. 

  639. 			'ex_fid_ary',
    640. 

  640. 			'post_visibility',
    641. 

  641. 			'author_ary',
    642. 

  642. 			'author_name',
    643. 

  643. 			'sphinx',
    644. 

  644. 		);
    645. 

  645. 		extract($this->phpbb_dispatcher->trigger_event('core.search_sphinx_keywords_modify_options', compact($vars)));
    646. 

  646. 		$this->sphinx = $sphinx;
    647. 

  647. 		unset($sphinx);
    648. 

  648. 

  649. 		$search_query_prefix = '';
    650. 

  650. 

  651. 		switch ($fields)
    652. 

  652. 		{
    653. 

  653. 			case 'titleonly':
    654. 

  654. 				// Only search the title
    655. 

  655. 				if ($terms == 'all')
    656. 

  656. 				{
    657. 

  657. 					$search_query_prefix = '@title ';
    658. 

  658. 				}
    659. 

  659. 				// Weight for the title
    660. 

  660. 				$this->sphinx->SetFieldWeights(array("title" => 5, "data" => 1));
    661. 

  661. 				// 1 is first_post, 0 is not first post
    662. 

  662. 				$this->sphinx->SetFilter('topic_first_post', array(1));
    663. 

  663. 			break;
    664. 

  664. 

  665. 			case 'msgonly':
    666. 

  666. 				// Only search the body
    667. 

  667. 				if ($terms == 'all')
    668. 

  668. 				{
    669. 

  669. 					$search_query_prefix = '@data ';
    670. 

  670. 				}
    671. 

  671. 				// Weight for the body
    672. 

  672. 				$this->sphinx->SetFieldWeights(array("title" => 1, "data" => 5));
    673. 

  673. 			break;
    674. 

  674. 

  675. 			case 'firstpost':
    676. 

  676. 				// More relative weight for the title, also search the body
    677. 

  677. 				$this->sphinx->SetFieldWeights(array("title" => 5, "data" => 1));
    678. 

  678. 				// 1 is first_post, 0 is not first post
    679. 

  679. 				$this->sphinx->SetFilter('topic_first_post', array(1));
    680. 

  680. 			break;
    681. 

  681. 

  682. 			default:
    683. 

  683. 				// More relative weight for the title, also search the body
    684. 

  684. 				$this->sphinx->SetFieldWeights(array("title" => 5, "data" => 1));
    685. 

  685. 			break;
    686. 

  686. 		}
    687. 

  687. 

  688. 		if (count($author_ary))
    689. 

  689. 		{
    690. 

  690. 			$this->sphinx->SetFilter('poster_id', $author_ary);
    691. 

  691. 		}
    692. 

  692. 

  693. 		// As this is not simply possible at the moment, we limit the result to approved posts.
    694. 

  694. 		// This will make it impossible for moderators to search unapproved and softdeleted posts,
    695. 

  695. 		// but at least it will also cause the same for normal users.
    696. 

  696. 		$this->sphinx->SetFilter('post_visibility', array(ITEM_APPROVED));
    697. 

  697. 

  698. 		if (count($ex_fid_ary))
    699. 

  699. 		{
    700. 

  700. 			// All forums that a user is allowed to access
    701. 

  701. 			$fid_ary = array_unique(array_intersect(array_keys($this->auth->acl_getf('f_read', true)), array_keys($this->auth->acl_getf('f_search', true))));
    702. 

  702. 			// All forums that the user wants to and can search in
    703. 

  703. 			$search_forums = array_diff($fid_ary, $ex_fid_ary);
    704. 

  704. 

  705. 			if (count($search_forums))
    706. 

  706. 			{
    707. 

  707. 				$this->sphinx->SetFilter('forum_id', $search_forums);
    708. 

  708. 			}
    709. 

  709. 		}
    710. 

  710. 

  711. 		$this->sphinx->SetFilter('deleted', array(0));
    712. 

  712. 

  713. 		$this->sphinx->SetLimits((int) $start, (int) $per_page, max(SPHINX_MAX_MATCHES, (int) $start + $per_page));
    714. 

  714. 		$result = $this->sphinx->Query($search_query_prefix . $this->sphinx->sphinx_clean_search_string(str_replace('&quot;', '"', $this->search_query)), $this->indexes);
    715. 

  715. 

  716. 		// Could be connection to localhost:9312 failed (errno=111,
    717. 

  717. 		// msg=Connection refused) during rotate, retry if so
    718. 

  718. 		$retries = SPHINX_CONNECT_RETRIES;
    719. 

  719. 		while (!$result && (strpos($this->sphinx->GetLastError(), "errno=111,") !== false) && $retries--)
    720. 

  720. 		{
    721. 

  721. 			usleep(SPHINX_CONNECT_WAIT_TIME);
    722. 

  722. 			$result = $this->sphinx->Query($search_query_prefix . $this->sphinx->sphinx_clean_search_string(str_replace('&quot;', '"', $this->search_query)), $this->indexes);
    723. 

  723. 		}
    724. 

  724. 

  725. 		if ($this->sphinx->GetLastError())
    726. 

  726. 		{
    727. 

  727. 			$phpbb_log->add('critical', $user->data['user_id'], $user->ip, 'LOG_SPHINX_ERROR', false, array($this->sphinx->GetLastError()));
    728. 

  728. 			if ($this->auth->acl_get('a_'))
    729. 

  729. 			{
    730. 

  730. 				trigger_error($this->user->lang('SPHINX_SEARCH_FAILED', $this->sphinx->GetLastError()));
    731. 

  731. 			}
    732. 

  732. 			else
    733. 

  733. 			{
    734. 

  734. 				trigger_error($this->user->lang('SPHINX_SEARCH_FAILED_LOG'));
    735. 

  735. 			}
    736. 

  736. 		}
    737. 

  737. 

  738. 		$result_count = $result['total_found'];
    739. 

  739. 

  740. 		if ($result_count && $start >= $result_count)
    741. 

  741. 		{
    742. 

  742. 			$start = floor(($result_count - 1) / $per_page) * $per_page;
    743. 

  743. 

  744. 			$this->sphinx->SetLimits((int) $start, (int) $per_page, max(SPHINX_MAX_MATCHES, (int) $start + $per_page));
    745. 

  745. 			$result = $this->sphinx->Query($search_query_prefix . $this->sphinx->sphinx_clean_search_string(str_replace('&quot;', '"', $this->search_query)), $this->indexes);
    746. 

  746. 

  747. 			// Could be connection to localhost:9312 failed (errno=111,
    748. 

  748. 			// msg=Connection refused) during rotate, retry if so
    749. 

  749. 			$retries = SPHINX_CONNECT_RETRIES;
    750. 

  750. 			while (!$result && (strpos($this->sphinx->GetLastError(), "errno=111,") !== false) && $retries--)
    751. 

  751. 			{
    752. 

  752. 				usleep(SPHINX_CONNECT_WAIT_TIME);
    753. 

  753. 				$result = $this->sphinx->Query($search_query_prefix . $this->sphinx->sphinx_clean_search_string(str_replace('&quot;', '"', $this->search_query)), $this->indexes);
    754. 

  754. 			}
    755. 

  755. 		}
    756. 

  756. 

  757. 		$id_ary = array();
    758. 

  758. 		if (isset($result['matches']))
    759. 

  759. 		{
    760. 

  760. 			if ($type == 'posts')
    761. 

  761. 			{
    762. 

  762. 				$id_ary = array_keys($result['matches']);
    763. 

  763. 			}
    764. 

  764. 			else
    765. 

  765. 			{
    766. 

  766. 				foreach ($result['matches'] as $key => $value)
    767. 

  767. 				{
    768. 

  768. 					$id_ary[] = $value['attrs']['topic_id'];
    769. 

  769. 				}
    770. 

  770. 			}
    771. 

  771. 		}
    772. 

  772. 		else
    773. 

  773. 		{
    774. 

  774. 			return false;
    775. 

  775. 		}
    776. 

  776. 

  777. 		$id_ary = array_slice($id_ary, 0, (int) $per_page);
    778. 

  778. 

  779. 		return $result_count;
    780. 

  780. 	}
    781. 

  781. 

  782. 	/**
    783. 

  783. 	* Performs a search on an author's posts without caring about message contents. Depends on display specific params
    784. 

  784. 	*
    785. 

  785. 	* @param	string		$type				contains either posts or topics depending on what should be searched for
    786. 

  786. 	* @param	boolean		$firstpost_only		if true, only topic starting posts will be considered
    787. 

  787. 	* @param	array		$sort_by_sql		contains SQL code for the ORDER BY part of a query
    788. 

  788. 	* @param	string		$sort_key			is the key of $sort_by_sql for the selected sorting
    789. 

  789. 	* @param	string		$sort_dir			is either a or d representing ASC and DESC
    790. 

  790. 	* @param	string		$sort_days			specifies the maximum amount of days a post may be old
    791. 

  791. 	* @param	array		$ex_fid_ary			specifies an array of forum ids which should not be searched
    792. 

  792. 	* @param	string		$post_visibility	specifies which types of posts the user can view in which forums
    793. 

  793. 	* @param	int			$topic_id			is set to 0 or a topic id, if it is not 0 then only posts in this topic should be searched
    794. 

  794. 	* @param	array		$author_ary			an array of author ids
    795. 

  795. 	* @param	string		$author_name		specifies the author match, when ANONYMOUS is also a search-match
    796. 

  796. 	* @param	array		&$id_ary			passed by reference, to be filled with ids for the page specified by $start and $per_page, should be ordered
    797. 

  797. 	* @param	int			$start				indicates the first index of the page
    798. 

  798. 	* @param	int			$per_page			number of ids each page is supposed to contain
    799. 

  799. 	* @return	boolean|int						total number of results
    800. 

  800. 	*/
    801. 

  801. 	public function author_search($type, $firstpost_only, $sort_by_sql, $sort_key, $sort_dir, $sort_days, $ex_fid_ary, $post_visibility, $topic_id, $author_ary, $author_name, &$id_ary, $start, $per_page)
    802. 

  802. 	{
    803. 

  803. 		$this->search_query = '';
    804. 

  804. 

  805. 		$this->sphinx->SetMatchMode(SPH_MATCH_FULLSCAN);
    806. 

  806. 		$fields = ($firstpost_only) ? 'firstpost' : 'all';
    807. 

  807. 		$terms = 'all';
    808. 

  808. 		return $this->keyword_search($type, $fields, $terms, $sort_by_sql, $sort_key, $sort_dir, $sort_days, $ex_fid_ary, $post_visibility, $topic_id, $author_ary, $author_name, $id_ary, $start, $per_page);
    809. 

  809. 	}
    810. 

  810. 

  811. 	/**
    812. 

  812. 	 * Updates wordlist and wordmatch tables when a message is posted or changed
    813. 

  813. 	 *
    814. 

  814. 	 * @param	string	$mode	Contains the post mode: edit, post, reply, quote
    815. 

  815. 	 * @param	int	$post_id	The id of the post which is modified/created
    816. 

  816. 	 * @param	string	&$message	New or updated post content
    817. 

  817. 	 * @param	string	&$subject	New or updated post subject
    818. 

  818. 	 * @param	int	$poster_id	Post author's user id
    819. 

  819. 	 * @param	int	$forum_id	The id of the forum in which the post is located
    820. 

  820. 	 */
    821. 

  821. 	public function index($mode, $post_id, &$message, &$subject, $poster_id, $forum_id)
    822. 

  822. 	{
    823. 

  823. 		/**
    824. 

  824. 		* Event to modify method arguments before the Sphinx search index is updated
    825. 

  825. 		*
    826. 

  826. 		* @event core.search_sphinx_index_before
    827. 

  827. 		* @var string	mode				Contains the post mode: edit, post, reply, quote
    828. 

  828. 		* @var int		post_id				The id of the post which is modified/created
    829. 

  829. 		* @var string	message				New or updated post content
    830. 

  830. 		* @var string	subject				New or updated post subject
    831. 

  831. 		* @var int		poster_id			Post author's user id
    832. 

  832. 		* @var int		forum_id			The id of the forum in which the post is located
    833. 

  833. 		* @since 3.2.3-RC1
    834. 

  834. 		*/
    835. 

  835. 		$vars = array(
    836. 

  836. 			'mode',
    837. 

  837. 			'post_id',
    838. 

  838. 			'message',
    839. 

  839. 			'subject',
    840. 

  840. 			'poster_id',
    841. 

  841. 			'forum_id',
    842. 

  842. 		);
    843. 

  843. 		extract($this->phpbb_dispatcher->trigger_event('core.search_sphinx_index_before', compact($vars)));
    844. 

  844. 

  845. 		if ($mode == 'edit')
    846. 

  846. 		{
    847. 

  847. 			$this->sphinx->UpdateAttributes($this->indexes, array('forum_id', 'poster_id'), array((int) $post_id => array((int) $forum_id, (int) $poster_id)));
    848. 

  848. 		}
    849. 

  849. 		else if ($mode != 'post' && $post_id)
    850. 

  850. 		{
    851. 

  851. 			// Update topic_last_post_time for full topic
    852. 

  852. 			$sql_array = array(
    853. 

  853. 				'SELECT'	=> 'p1.post_id',
    854. 

  854. 				'FROM'		=> array(
    855. 

  855. 					POSTS_TABLE	=> 'p1',
    856. 

  856. 				),
    857. 

  857. 				'LEFT_JOIN'	=> array(array(
    858. 

  858. 					'FROM'	=> array(
    859. 

  859. 						POSTS_TABLE	=> 'p2'
    860. 

  860. 					),
    861. 

  861. 					'ON'	=> 'p1.topic_id = p2.topic_id',
    862. 

  862. 				)),
    863. 

  863. 				'WHERE' => 'p2.post_id = ' . ((int) $post_id),
    864. 

  864. 			);
    865. 

  865. 

  866. 			$sql = $this->db->sql_build_query('SELECT', $sql_array);
    867. 

  867. 			$result = $this->db->sql_query($sql);
    868. 

  868. 

  869. 			$post_updates = array();
    870. 

  870. 			$post_time = time();
    871. 

  871. 			while ($row = $this->db->sql_fetchrow($result))
    872. 

  872. 			{
    873. 

  873. 				$post_updates[(int) $row['post_id']] = array($post_time);
    874. 

  874. 			}
    875. 

  875. 			$this->db->sql_freeresult($result);
    876. 

  876. 

  877. 			if (count($post_updates))
    878. 

  878. 			{
    879. 

  879. 				$this->sphinx->UpdateAttributes($this->indexes, array('topic_last_post_time'), $post_updates);
    880. 

  880. 			}
    881. 

  881. 		}
    882. 

  882. 	}
    883. 

  883. 

  884. 	/**
    885. 

  885. 	* Delete a post from the index after it was deleted
    886. 

  886. 	*/
    887. 

  887. 	public function index_remove($post_ids, $author_ids, $forum_ids)
    888. 

  888. 	{
    889. 

  889. 		$values = array();
    890. 

  890. 		foreach ($post_ids as $post_id)
    891. 

  891. 		{
    892. 

  892. 			$values[$post_id] = array(1);
    893. 

  893. 		}
    894. 

  894. 

  895. 		$this->sphinx->UpdateAttributes($this->indexes, array('deleted'), $values);
    896. 

  896. 	}
    897. 

  897. 

  898. 	/**
    899. 

  899. 	* Nothing needs to be destroyed
    900. 

  900. 	*/
    901. 

  901. 	public function tidy($create = false)
    902. 

  902. 	{
    903. 

  903. 		$this->config->set('search_last_gc', time(), false);
    904. 

  904. 	}
    905. 

  905. 

  906. 	/**
    907. 

  907. 	* Create sphinx table
    908. 

  908. 	*
    909. 

  909. 	* @return string|bool error string is returned incase of errors otherwise false
    910. 

  910. 	*/
    911. 

  911. 	public function create_index($acp_module, $u_action)
    912. 

  912. 	{
    913. 

  913. 		if (!$this->index_created())
    914. 

  914. 		{
    915. 

  915. 			$table_data = array(
    916. 

  916. 				'COLUMNS'	=> array(
    917. 

  917. 					'counter_id'	=> array('UINT', 0),
    918. 

  918. 					'max_doc_id'	=> array('UINT', 0),
    919. 

  919. 				),
    920. 

  920. 				'PRIMARY_KEY'	=> 'counter_id',
    921. 

  921. 			);
    922. 

  922. 			$this->db_tools->sql_create_table(SPHINX_TABLE, $table_data);
    923. 

  923. 

  924. 			$sql = 'TRUNCATE TABLE ' . SPHINX_TABLE;
    925. 

  925. 			$this->db->sql_query($sql);
    926. 

  926. 

  927. 			$data = array(
    928. 

  928. 				'counter_id'	=> '1',
    929. 

  929. 				'max_doc_id'	=> '0',
    930. 

  930. 			);
    931. 

  931. 			$sql = 'INSERT INTO ' . SPHINX_TABLE . ' ' . $this->db->sql_build_array('INSERT', $data);
    932. 

  932. 			$this->db->sql_query($sql);
    933. 

  933. 		}
    934. 

  934. 

  935. 		return false;
    936. 

  936. 	}
    937. 

  937. 

  938. 	/**
    939. 

  939. 	* Drop sphinx table
    940. 

  940. 	*
    941. 

  941. 	* @return string|bool error string is returned incase of errors otherwise false
    942. 

  942. 	*/
    943. 

  943. 	public function delete_index($acp_module, $u_action)
    944. 

  944. 	{
    945. 

  945. 		if (!$this->index_created())
    946. 

  946. 		{
    947. 

  947. 			return false;
    948. 

  948. 		}
    949. 

  949. 

  950. 		$this->db_tools->sql_table_drop(SPHINX_TABLE);
    951. 

  951. 

  952. 		return false;
    953. 

  953. 	}
    954. 

  954. 

  955. 	/**
    956. 

  956. 	* Returns true if the sphinx table was created
    957. 

  957. 	*
    958. 

  958. 	* @return bool true if sphinx table was created
    959. 

  959. 	*/
    960. 

  960. 	public function index_created($allow_new_files = true)
    961. 

  961. 	{
    962. 

  962. 		$created = false;
    963. 

  963. 

  964. 		if ($this->db_tools->sql_table_exists(SPHINX_TABLE))
    965. 

  965. 		{
    966. 

  966. 			$created = true;
    967. 

  967. 		}
    968. 

  968. 

  969. 		return $created;
    970. 

  970. 	}
    971. 

  971. 

  972. 	/**
    973. 

  973. 	* Returns an associative array containing information about the indexes
    974. 

  974. 	*
    975. 

  975. 	* @return string|bool Language string of error false otherwise
    976. 

  976. 	*/
    977. 

  977. 	public function index_stats()
    978. 

  978. 	{
    979. 

  979. 		if (empty($this->stats))
    980. 

  980. 		{
    981. 

  981. 			$this->get_stats();
    982. 

  982. 		}
    983. 

  983. 

  984. 		return array(
    985. 

  985. 			$this->user->lang['FULLTEXT_SPHINX_MAIN_POSTS']			=> ($this->index_created()) ? $this->stats['main_posts'] : 0,
    986. 

  986. 			$this->user->lang['FULLTEXT_SPHINX_DELTA_POSTS']			=> ($this->index_created()) ? $this->stats['total_posts'] - $this->stats['main_posts'] : 0,
    987. 

  987. 			$this->user->lang['FULLTEXT_MYSQL_TOTAL_POSTS']			=> ($this->index_created()) ? $this->stats['total_posts'] : 0,
    988. 

  988. 		);
    989. 

  989. 	}
    990. 

  990. 

  991. 	/**
    992. 

  992. 	* Collects stats that can be displayed on the index maintenance page
    993. 

  993. 	*/
    994. 

  994. 	protected function get_stats()
    995. 

  995. 	{
    996. 

  996. 		if ($this->index_created())
    997. 

  997. 		{
    998. 

  998. 			$sql = 'SELECT COUNT(post_id) as total_posts
    999. 

  999. 				FROM ' . POSTS_TABLE;
    1000. 

  1000. 			$result = $this->db->sql_query($sql);
    1001. 

  1001. 			$this->stats['total_posts'] = (int) $this->db->sql_fetchfield('total_posts');
    1002. 

  1002. 			$this->db->sql_freeresult($result);
    1003. 

  1003. 

  1004. 			$sql = 'SELECT COUNT(p.post_id) as main_posts
    1005. 

  1005. 				FROM ' . POSTS_TABLE . ' p, ' . SPHINX_TABLE . ' m
    1006. 

  1006. 				WHERE p.post_id <= m.max_doc_id
    1007. 

  1007. 					AND m.counter_id = 1';
    1008. 

  1008. 			$result = $this->db->sql_query($sql);
    1009. 

  1009. 			$this->stats['main_posts'] = (int) $this->db->sql_fetchfield('main_posts');
    1010. 

  1010. 			$this->db->sql_freeresult($result);
    1011. 

  1011. 		}
    1012. 

  1012. 	}
    1013. 

  1013. 

  1014. 	/**
    1015. 

  1015. 	* Returns a list of options for the ACP to display
    1016. 

  1016. 	*
    1017. 

  1017. 	* @return associative array containing template and config variables
    1018. 

  1018. 	*/
    1019. 

  1019. 	public function acp()
    1020. 

  1020. 	{
    1021. 

  1021. 		$config_vars = array(
    1022. 

  1022. 			'fulltext_sphinx_data_path' => 'string',
    1023. 

  1023. 			'fulltext_sphinx_host' => 'string',
    1024. 

  1024. 			'fulltext_sphinx_port' => 'string',
    1025. 

  1025. 			'fulltext_sphinx_indexer_mem_limit' => 'int',
    1026. 

  1026. 		);
    1027. 

  1027. 

  1028. 		$tpl = '
    1029. 

  1029. 		<span class="error">' . $this->user->lang['FULLTEXT_SPHINX_CONFIGURE']. '</span>
    1030. 

  1030. 		<dl>
    1031. 

  1031. 			<dt><label for="fulltext_sphinx_data_path">' . $this->user->lang['FULLTEXT_SPHINX_DATA_PATH'] . $this->user->lang['COLON'] . '</label><br /><span>' . $this->user->lang['FULLTEXT_SPHINX_DATA_PATH_EXPLAIN'] . '</span></dt>
    1032. 

  1032. 			<dd><input id="fulltext_sphinx_data_path" type="text" size="40" maxlength="255" name="config[fulltext_sphinx_data_path]" value="' . $this->config['fulltext_sphinx_data_path'] . '" /></dd>
    1033. 

  1033. 		</dl>
    1034. 

  1034. 		<dl>
    1035. 

  1035. 			<dt><label for="fulltext_sphinx_host">' . $this->user->lang['FULLTEXT_SPHINX_HOST'] . $this->user->lang['COLON'] . '</label><br /><span>' . $this->user->lang['FULLTEXT_SPHINX_HOST_EXPLAIN'] . '</span></dt>
    1036. 

  1036. 			<dd><input id="fulltext_sphinx_host" type="text" size="40" maxlength="255" name="config[fulltext_sphinx_host]" value="' . $this->config['fulltext_sphinx_host'] . '" /></dd>
    1037. 

  1037. 		</dl>
    1038. 

  1038. 		<dl>
    1039. 

  1039. 			<dt><label for="fulltext_sphinx_port">' . $this->user->lang['FULLTEXT_SPHINX_PORT'] . $this->user->lang['COLON'] . '</label><br /><span>' . $this->user->lang['FULLTEXT_SPHINX_PORT_EXPLAIN'] . '</span></dt>
    1040. 

  1040. 			<dd><input id="fulltext_sphinx_port" type="number" min="0" max="9999999999" name="config[fulltext_sphinx_port]" value="' . $this->config['fulltext_sphinx_port'] . '" /></dd>
    1041. 

  1041. 		</dl>
    1042. 

  1042. 		<dl>
    1043. 

  1043. 			<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>
    1044. 

  1044. 			<dd><input id="fulltext_sphinx_indexer_mem_limit" type="number" min="0" max="9999999999" name="config[fulltext_sphinx_indexer_mem_limit]" value="' . $this->config['fulltext_sphinx_indexer_mem_limit'] . '" /> ' . $this->user->lang['MIB'] . '</dd>
    1045. 

  1045. 		</dl>
    1046. 

  1046. 		<dl>
    1047. 

  1047. 			<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'] . '</span></dt>
    1048. 

  1048. 			<dd>' . (($this->config_generate()) ? '<textarea readonly="readonly" rows="6" id="sphinx_config_data">' . htmlspecialchars($this->config_file_data) . '</textarea>' : $this->config_file_data) . '</dd>
    1049. 

  1049. 		<dl>
    1050. 

  1050. 		';
    1051. 

    1052. 

  1052. 		// These are fields required in the config table
    1053. 

  1053. 		return array(
    1054. 

  1054. 			'tpl'		=> $tpl,
    1055. 

  1055. 			'config'	=> $config_vars
    1056. 

  1056. 		);
    1057. 

  1057. 	}
    1058. 

  1058. }
    1059. 

  1059.