PageRenderTime 61ms CodeModel.GetById 17ms RepoModel.GetById 0ms app.codeStats 0ms

/wwwroot/phpbb/phpbb/search/fulltext_sphinx.php

https://github.com/spring/spring-website
PHP | 921 lines | 566 code | 109 blank | 246 comment | 75 complexity | 40588ab126d8b7d68efe88ac6cead433 MD5 | raw file
Possible License(s): GPL-2.0, LGPL-2.1, Apache-2.0, LGPL-3.0, BSD-3-Clause 
    

  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 deamon
    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
    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 object
    147. 

  147. 		$this->db_tools = new \phpbb\db\tools($this->db);
    148. 

  148. 

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

  150. 		{
    151. 

  151. 			set_config('fulltext_sphinx_id', unique_id());
    152. 

  152. 		}
    153. 

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

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

  155. 

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

  157. 		{
    158. 

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

  159. 		}
    160. 

  160. 

  161. 		// Initialize sphinx client
    162. 

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

  163. 

  164. 		$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));
    165. 

  165. 

  166. 		$error = false;
    167. 

  167. 	}
    168. 

  168. 

  169. 	/**
    170. 

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

  171. 	*
    172. 

  172. 	* @return string Name
    173. 

  173. 	*/
    174. 

  174. 	public function get_name()
    175. 

  175. 	{
    176. 

  176. 		return 'Sphinx Fulltext';
    177. 

  177. 	}
    178. 

  178. 

  179. 	/**
    180. 

  180. 	 * Returns the search_query
    181. 

  181. 	 *
    182. 

  182. 	 * @return string search query
    183. 

  183. 	 */
    184. 

  184. 	public function get_search_query()
    185. 

  185. 	{
    186. 

  186. 		return $this->search_query;
    187. 

  187. 	}
    188. 

  188. 

  189. 	/**
    190. 

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

  191. 	 *
    192. 

  192. 	 * @return false
    193. 

  193. 	 */
    194. 

  194. 	public function get_word_length()
    195. 

  195. 	{
    196. 

  196. 		return false;
    197. 

  197. 	}
    198. 

  198. 

  199. 	/**
    200. 

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

  201. 	 *
    202. 

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

  203. 	 */
    204. 

  204. 	public function get_common_words()
    205. 

  205. 	{
    206. 

  206. 		return array();
    207. 

  207. 	}
    208. 

  208. 

  209. 	/**
    210. 

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

  211. 	*
    212. 

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

  213. 	*/
    214. 

  214. 	public function init()
    215. 

  215. 	{
    216. 

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

  217. 		{
    218. 

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

  219. 		}
    220. 

  220. 

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

  222. 		set_config('search_gc', 3600);
    223. 

  223. 

  224. 		return false;
    225. 

  225. 	}
    226. 

  226. 

  227. 	/**
    228. 

  228. 	 * Generates content of sphinx.conf
    229. 

  229. 	 *
    230. 

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

  231. 	 */
    232. 

  232. 	protected function config_generate()
    233. 

  233. 	{
    234. 

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

  235. 		if ($this->db->get_sql_layer() =='mysql' || $this->db->get_sql_layer() == 'mysql4' || $this->db->get_sql_layer() == 'mysqli')
    236. 

  236. 		{
    237. 

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

  238. 		}
    239. 

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

  240. 		{
    241. 

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

  242. 		}
    243. 

  243. 		else
    244. 

  244. 		{
    245. 

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

  246. 			return false;
    247. 

  247. 		}
    248. 

  248. 

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

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

  251. 		{
    252. 

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

  253. 			return false;
    254. 

  254. 		}
    255. 

  255. 

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

  257. 

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

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

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

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

  262. 		$config_data = array(
    263. 

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

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

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

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

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

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

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

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

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

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

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

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

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

  276. 						p.post_id AS id,
    277. 

  277. 						p.forum_id,
    278. 

  278. 						p.topic_id,
    279. 

  279. 						p.poster_id,
    280. 

  280. 						p.post_visibility,
    281. 

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

  282. 						p.post_time,
    283. 

  283. 						p.post_subject,
    284. 

  284. 						p.post_subject as title,
    285. 

  285. 						p.post_text as data,
    286. 

  286. 						t.topic_last_post_time,
    287. 

  287. 						0 as deleted
    288. 

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

  289. 					WHERE
    290. 

  290. 						p.topic_id = t.topic_id
    291. 

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

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

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

  294. 				array('sql_query_info',				'SELECT * FROM ' . POSTS_TABLE . ' WHERE post_id = $id'),
    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',				''),
    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. 			),
    327. 

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

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

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

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

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

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

  333. 				array('min_word_len',				'2'),
    334. 

  334. 				array('charset_type',				'utf-8'),
    335. 

  335. 				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'),
    336. 

  336. 				array('min_prefix_len',				'0'),
    337. 

  337. 				array('min_infix_len',				'0'),
    338. 

  338. 			),
    339. 

  339. 			'index index_phpbb_' . $this->id . '_delta : index_phpbb_' . $this->id . '_main' => array(
    340. 

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

  341. 				array('source',						'source_phpbb_' . $this->id . '_delta'),
    342. 

  342. 			),
    343. 

  343. 			'indexer' => array(
    344. 

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

  345. 			),
    346. 

  346. 			'searchd' => array(
    347. 

  347. 				array('compat_sphinxql_magics'	,	'0'),
    348. 

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

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

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

  351. 				array('read_timeout',				'5'),
    352. 

  352. 				array('max_children',				'30'),
    353. 

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

  354. 				array('max_matches',				(string) SPHINX_MAX_MATCHES),
    355. 

  355. 				array('binlog_path',				$this->config['fulltext_sphinx_data_path']),
    356. 

  356. 			),
    357. 

  357. 		);
    358. 

  358. 

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

  360. 		$delete = array('sql_group_column' => true, 'sql_date_column' => true, 'sql_str2ordinal_column' => true);
    361. 

  361. 		foreach ($config_data as $section_name => $section_data)
    362. 

  362. 		{
    363. 

  363. 			$section = $config_object->get_section_by_name($section_name);
    364. 

  364. 			if (!$section)
    365. 

  365. 			{
    366. 

  366. 				$section = $config_object->add_section($section_name);
    367. 

  367. 			}
    368. 

  368. 

  369. 			foreach ($delete as $key => $void)
    370. 

  370. 			{
    371. 

  371. 				$section->delete_variables_by_name($key);
    372. 

  372. 			}
    373. 

  373. 

  374. 			foreach ($non_unique as $key => $void)
    375. 

  375. 			{
    376. 

  376. 				$section->delete_variables_by_name($key);
    377. 

  377. 			}
    378. 

  378. 

  379. 			foreach ($section_data as $entry)
    380. 

  380. 			{
    381. 

  381. 				$key = $entry[0];
    382. 

  382. 				$value = $entry[1];
    383. 

  383. 

  384. 				if (!isset($non_unique[$key]))
    385. 

  385. 				{
    386. 

  386. 					$variable = $section->get_variable_by_name($key);
    387. 

  387. 					if (!$variable)
    388. 

  388. 					{
    389. 

  389. 						$variable = $section->create_variable($key, $value);
    390. 

  390. 					}
    391. 

  391. 					else
    392. 

  392. 					{
    393. 

  393. 						$variable->set_value($value);
    394. 

  394. 					}
    395. 

  395. 				}
    396. 

  396. 				else
    397. 

  397. 				{
    398. 

  398. 					$variable = $section->create_variable($key, $value);
    399. 

  399. 				}
    400. 

  400. 			}
    401. 

  401. 		}
    402. 

  402. 		$this->config_file_data = $config_object->get_data();
    403. 

  403. 

  404. 		return true;
    405. 

  405. 	}
    406. 

  406. 

  407. 	/**
    408. 

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

  409. 	* Stores the tidied search query in $this->search_query
    410. 

  410. 	*
    411. 

  411. 	* @param string $keywords Contains the keyword as entered by the user
    412. 

  412. 	* @param string $terms is either 'all' or 'any'
    413. 

  413. 	* @return false if no valid keywords were found and otherwise true
    414. 

  414. 	*/
    415. 

  415. 	public function split_keywords(&$keywords, $terms)
    416. 

  416. 	{
    417. 

  417. 		if ($terms == 'all')
    418. 

  418. 		{
    419. 

  419. 			$match		= array('#\sand\s#i', '#\sor\s#i', '#\snot\s#i', '#\+#', '#-#', '#\|#', '#@#');
    420. 

  420. 			$replace	= array(' & ', ' | ', '  - ', ' +', ' -', ' |', '');
    421. 

  421. 

  422. 			$replacements = 0;
    423. 

  423. 			$keywords = preg_replace($match, $replace, $keywords);
    424. 

  424. 			$this->sphinx->SetMatchMode(SPH_MATCH_EXTENDED);
    425. 

  425. 		}
    426. 

  426. 		else
    427. 

  427. 		{
    428. 

  428. 			$this->sphinx->SetMatchMode(SPH_MATCH_ANY);
    429. 

  429. 		}
    430. 

  430. 

  431. 		// Keep quotes and new lines
    432. 

  432. 		$keywords = str_replace(array('&quot;', "\n"), array('"', ' '), trim($keywords));
    433. 

  433. 

  434. 		if (strlen($keywords) > 0)
    435. 

  435. 		{
    436. 

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

  437. 			return true;
    438. 

  438. 		}
    439. 

  439. 

  440. 		return false;
    441. 

  441. 	}
    442. 

  442. 

  443. 	/**
    444. 

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

  445. 	*
    446. 

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

  447. 	* @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)
    448. 

  448. 	* @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)
    449. 

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

  450. 	* @param	string		$sort_key			is the key of $sort_by_sql for the selected sorting
    451. 

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

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

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

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

  455. 	* @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
    456. 

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

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

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

  459. 	* @param	int			$start				indicates the first index of the page
    460. 

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

  461. 	* @return	boolean|int						total number of results
    462. 

  462. 	*/
    463. 

  463. 	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)
    464. 

  464. 	{
    465. 

  465. 		// No keywords? No posts.
    466. 

  466. 		if (!strlen($this->search_query) && !sizeof($author_ary))
    467. 

  467. 		{
    468. 

  468. 			return false;
    469. 

  469. 		}
    470. 

  470. 

  471. 		$id_ary = array();
    472. 

  472. 

  473. 		$join_topic = ($type != 'posts');
    474. 

  474. 

  475. 		// Sorting
    476. 

  476. 

  477. 		if ($type == 'topics')
    478. 

  478. 		{
    479. 

  479. 			switch ($sort_key)
    480. 

  480. 			{
    481. 

  481. 				case 'a':
    482. 

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

  483. 				break;
    484. 

  484. 

  485. 				case 'f':
    486. 

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

  487. 				break;
    488. 

  488. 

  489. 				case 'i':
    490. 

  490. 

  491. 				case 's':
    492. 

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

  493. 				break;
    494. 

  494. 

  495. 				case 't':
    496. 

  496. 

  497. 				default:
    498. 

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

  499. 				break;
    500. 

  500. 			}
    501. 

  501. 		}
    502. 

  502. 		else
    503. 

  503. 		{
    504. 

  504. 			switch ($sort_key)
    505. 

  505. 			{
    506. 

  506. 				case 'a':
    507. 

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

  508. 				break;
    509. 

  509. 

  510. 				case 'f':
    511. 

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

  512. 				break;
    513. 

  513. 

  514. 				case 'i':
    515. 

  515. 

  516. 				case 's':
    517. 

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

  518. 				break;
    519. 

  519. 

  520. 				case 't':
    521. 

  521. 

  522. 				default:
    523. 

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

  524. 				break;
    525. 

  525. 			}
    526. 

  526. 		}
    527. 

  527. 

  528. 		// Most narrow filters first
    529. 

  529. 		if ($topic_id)
    530. 

  530. 		{
    531. 

  531. 			$this->sphinx->SetFilter('topic_id', array($topic_id));
    532. 

  532. 		}
    533. 

  533. 

  534. 		$search_query_prefix = '';
    535. 

  535. 

  536. 		switch ($fields)
    537. 

  537. 		{
    538. 

  538. 			case 'titleonly':
    539. 

  539. 				// Only search the title
    540. 

  540. 				if ($terms == 'all')
    541. 

  541. 				{
    542. 

  542. 					$search_query_prefix = '@title ';
    543. 

  543. 				}
    544. 

  544. 				// Weight for the title
    545. 

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

  546. 				// 1 is first_post, 0 is not first post
    547. 

  547. 				$this->sphinx->SetFilter('topic_first_post', array(1));
    548. 

  548. 			break;
    549. 

  549. 

  550. 			case 'msgonly':
    551. 

  551. 				// Only search the body
    552. 

  552. 				if ($terms == 'all')
    553. 

  553. 				{
    554. 

  554. 					$search_query_prefix = '@data ';
    555. 

  555. 				}
    556. 

  556. 				// Weight for the body
    557. 

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

  558. 			break;
    559. 

  559. 

  560. 			case 'firstpost':
    561. 

  561. 				// More relative weight for the title, also search the body
    562. 

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

  563. 				// 1 is first_post, 0 is not first post
    564. 

  564. 				$this->sphinx->SetFilter('topic_first_post', array(1));
    565. 

  565. 			break;
    566. 

  566. 

  567. 			default:
    568. 

  568. 				// More relative weight for the title, also search the body
    569. 

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

  570. 			break;
    571. 

  571. 		}
    572. 

  572. 

  573. 		if (sizeof($author_ary))
    574. 

  574. 		{
    575. 

  575. 			$this->sphinx->SetFilter('poster_id', $author_ary);
    576. 

  576. 		}
    577. 

  577. 

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

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

  580. 		// but at least it will also cause the same for normal users.
    581. 

  581. 		$this->sphinx->SetFilter('post_visibility', array(ITEM_APPROVED));
    582. 

  582. 

  583. 		if (sizeof($ex_fid_ary))
    584. 

  584. 		{
    585. 

  585. 			// All forums that a user is allowed to access
    586. 

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

  587. 			// All forums that the user wants to and can search in
    588. 

  588. 			$search_forums = array_diff($fid_ary, $ex_fid_ary);
    589. 

  589. 

  590. 			if (sizeof($search_forums))
    591. 

  591. 			{
    592. 

  592. 				$this->sphinx->SetFilter('forum_id', $search_forums);
    593. 

  593. 			}
    594. 

  594. 		}
    595. 

  595. 

  596. 		$this->sphinx->SetFilter('deleted', array(0));
    597. 

  597. 

  598. 		$this->sphinx->SetLimits($start, (int) $per_page, SPHINX_MAX_MATCHES);
    599. 

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

  600. 

  601. 		// Could be connection to localhost:9312 failed (errno=111,
    602. 

  602. 		// msg=Connection refused) during rotate, retry if so
    603. 

  603. 		$retries = SPHINX_CONNECT_RETRIES;
    604. 

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

  605. 		{
    606. 

  606. 			usleep(SPHINX_CONNECT_WAIT_TIME);
    607. 

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

  608. 		}
    609. 

  609. 

  610. 		if ($this->sphinx->GetLastError())
    611. 

  611. 		{
    612. 

  612. 			add_log('critical', 'LOG_SPHINX_ERROR', $this->sphinx->GetLastError());
    613. 

  613. 			if ($this->auth->acl_get('a_'))
    614. 

  614. 			{
    615. 

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

  616. 			}
    617. 

  617. 			else
    618. 

  618. 			{
    619. 

  619. 				trigger_error($this->user->lang('SPHINX_SEARCH_FAILED_LOG'));
    620. 

  620. 			}
    621. 

  621. 		}
    622. 

  622. 

  623. 		$result_count = $result['total_found'];
    624. 

  624. 

  625. 		if ($result_count && $start >= $result_count)
    626. 

  626. 		{
    627. 

  627. 			$start = floor(($result_count - 1) / $per_page) * $per_page;
    628. 

  628. 

  629. 			$this->sphinx->SetLimits((int) $start, (int) $per_page, SPHINX_MAX_MATCHES);
    630. 

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

  631. 

  632. 			// Could be connection to localhost:9312 failed (errno=111,
    633. 

  633. 			// msg=Connection refused) during rotate, retry if so
    634. 

  634. 			$retries = SPHINX_CONNECT_RETRIES;
    635. 

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

  636. 			{
    637. 

  637. 				usleep(SPHINX_CONNECT_WAIT_TIME);
    638. 

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

  639. 			}
    640. 

  640. 		}
    641. 

  641. 

  642. 		$id_ary = array();
    643. 

  643. 		if (isset($result['matches']))
    644. 

  644. 		{
    645. 

  645. 			if ($type == 'posts')
    646. 

  646. 			{
    647. 

  647. 				$id_ary = array_keys($result['matches']);
    648. 

  648. 			}
    649. 

  649. 			else
    650. 

  650. 			{
    651. 

  651. 				foreach ($result['matches'] as $key => $value)
    652. 

  652. 				{
    653. 

  653. 					$id_ary[] = $value['attrs']['topic_id'];
    654. 

  654. 				}
    655. 

  655. 			}
    656. 

  656. 		}
    657. 

  657. 		else
    658. 

  658. 		{
    659. 

  659. 			return false;
    660. 

  660. 		}
    661. 

  661. 

  662. 		$id_ary = array_slice($id_ary, 0, (int) $per_page);
    663. 

  663. 

  664. 		return $result_count;
    665. 

  665. 	}
    666. 

  666. 

  667. 	/**
    668. 

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

  669. 	*
    670. 

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

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

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

  673. 	* @param	string		$sort_key			is the key of $sort_by_sql for the selected sorting
    674. 

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

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

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

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

  678. 	* @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
    679. 

  679. 	* @param	array		$author_ary			an array of author ids
    680. 

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

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

  682. 	* @param	int			$start				indicates the first index of the page
    683. 

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

  684. 	* @return	boolean|int						total number of results
    685. 

  685. 	*/
    686. 

  686. 	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)
    687. 

  687. 	{
    688. 

  688. 		$this->search_query = '';
    689. 

  689. 

  690. 		$this->sphinx->SetMatchMode(SPH_MATCH_FULLSCAN);
    691. 

  691. 		$fields = ($firstpost_only) ? 'firstpost' : 'all';
    692. 

  692. 		$terms = 'all';
    693. 

  693. 		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);
    694. 

  694. 	}
    695. 

  695. 

  696. 	/**
    697. 

  697. 	 * Updates wordlist and wordmatch tables when a message is posted or changed
    698. 

  698. 	 *
    699. 

  699. 	 * @param	string	$mode	Contains the post mode: edit, post, reply, quote
    700. 

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

  701. 	 * @param	string	&$message	New or updated post content
    702. 

  702. 	 * @param	string	&$subject	New or updated post subject
    703. 

  703. 	 * @param	int	$poster_id	Post author's user id
    704. 

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

  705. 	 */
    706. 

  706. 	public function index($mode, $post_id, &$message, &$subject, $poster_id, $forum_id)
    707. 

  707. 	{
    708. 

  708. 		if ($mode == 'edit')
    709. 

  709. 		{
    710. 

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

  711. 		}
    712. 

  712. 		else if ($mode != 'post' && $post_id)
    713. 

  713. 		{
    714. 

  714. 			// Update topic_last_post_time for full topic
    715. 

  715. 			$sql_array = array(
    716. 

  716. 				'SELECT'	=> 'p1.post_id',
    717. 

  717. 				'FROM'		=> array(
    718. 

  718. 					POSTS_TABLE	=> 'p1',
    719. 

  719. 				),
    720. 

  720. 				'LEFT_JOIN'	=> array(array(
    721. 

  721. 					'FROM'	=> array(
    722. 

  722. 						POSTS_TABLE	=> 'p2'
    723. 

  723. 					),
    724. 

  724. 					'ON'	=> 'p1.topic_id = p2.topic_id',
    725. 

  725. 				)),
    726. 

  726. 				'WHERE' => 'p2.post_id = ' . ((int) $post_id),
    727. 

  727. 			);
    728. 

  728. 

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

  730. 			$result = $this->db->sql_query($sql);
    731. 

  731. 

  732. 			$post_updates = array();
    733. 

  733. 			$post_time = time();
    734. 

  734. 			while ($row = $this->db->sql_fetchrow($result))
    735. 

  735. 			{
    736. 

  736. 				$post_updates[(int) $row['post_id']] = array($post_time);
    737. 

  737. 			}
    738. 

  738. 			$this->db->sql_freeresult($result);
    739. 

  739. 

  740. 			if (sizeof($post_updates))
    741. 

  741. 			{
    742. 

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

  743. 			}
    744. 

  744. 		}
    745. 

  745. 	}
    746. 

  746. 

  747. 	/**
    748. 

  748. 	* Delete a post from the index after it was deleted
    749. 

  749. 	*/
    750. 

  750. 	public function index_remove($post_ids, $author_ids, $forum_ids)
    751. 

  751. 	{
    752. 

  752. 		$values = array();
    753. 

  753. 		foreach ($post_ids as $post_id)
    754. 

  754. 		{
    755. 

  755. 			$values[$post_id] = array(1);
    756. 

  756. 		}
    757. 

  757. 

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

  759. 	}
    760. 

  760. 

  761. 	/**
    762. 

  762. 	* Nothing needs to be destroyed
    763. 

  763. 	*/
    764. 

  764. 	public function tidy($create = false)
    765. 

  765. 	{
    766. 

  766. 		set_config('search_last_gc', time(), true);
    767. 

  767. 	}
    768. 

  768. 

  769. 	/**
    770. 

  770. 	* Create sphinx table
    771. 

  771. 	*
    772. 

  772. 	* @return string|bool error string is returned incase of errors otherwise false
    773. 

  773. 	*/
    774. 

  774. 	public function create_index($acp_module, $u_action)
    775. 

  775. 	{
    776. 

  776. 		if (!$this->index_created())
    777. 

  777. 		{
    778. 

  778. 			$table_data = array(
    779. 

  779. 				'COLUMNS'	=> array(
    780. 

  780. 					'counter_id'	=> array('UINT', 0),
    781. 

  781. 					'max_doc_id'	=> array('UINT', 0),
    782. 

  782. 				),
    783. 

  783. 				'PRIMARY_KEY'	=> 'counter_id',
    784. 

  784. 			);
    785. 

  785. 			$this->db_tools->sql_create_table(SPHINX_TABLE, $table_data);
    786. 

  786. 

  787. 			$sql = 'TRUNCATE TABLE ' . SPHINX_TABLE;
    788. 

  788. 			$this->db->sql_query($sql);
    789. 

  789. 

  790. 			$data = array(
    791. 

  791. 				'counter_id'	=> '1',
    792. 

  792. 				'max_doc_id'	=> '0',
    793. 

  793. 			);
    794. 

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

  795. 			$this->db->sql_query($sql);
    796. 

  796. 		}
    797. 

  797. 

  798. 		return false;
    799. 

  799. 	}
    800. 

  800. 

  801. 	/**
    802. 

  802. 	* Drop sphinx table
    803. 

  803. 	*
    804. 

  804. 	* @return string|bool error string is returned incase of errors otherwise false
    805. 

  805. 	*/
    806. 

  806. 	public function delete_index($acp_module, $u_action)
    807. 

  807. 	{
    808. 

  808. 		if (!$this->index_created())
    809. 

  809. 		{
    810. 

  810. 			return false;
    811. 

  811. 		}
    812. 

  812. 

  813. 		$this->db_tools->sql_table_drop(SPHINX_TABLE);
    814. 

  814. 

  815. 		return false;
    816. 

  816. 	}
    817. 

  817. 

  818. 	/**
    819. 

  819. 	* Returns true if the sphinx table was created
    820. 

  820. 	*
    821. 

  821. 	* @return bool true if sphinx table was created
    822. 

  822. 	*/
    823. 

  823. 	public function index_created($allow_new_files = true)
    824. 

  824. 	{
    825. 

  825. 		$created = false;
    826. 

  826. 

  827. 		if ($this->db_tools->sql_table_exists(SPHINX_TABLE))
    828. 

  828. 		{
    829. 

  829. 			$created = true;
    830. 

  830. 		}
    831. 

  831. 

  832. 		return $created;
    833. 

  833. 	}
    834. 

  834. 

  835. 	/**
    836. 

  836. 	* Returns an associative array containing information about the indexes
    837. 

  837. 	*
    838. 

  838. 	* @return string|bool Language string of error false otherwise
    839. 

  839. 	*/
    840. 

  840. 	public function index_stats()
    841. 

  841. 	{
    842. 

  842. 		if (empty($this->stats))
    843. 

  843. 		{
    844. 

  844. 			$this->get_stats();
    845. 

  845. 		}
    846. 

  846. 

  847. 		return array(
    848. 

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

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

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

  851. 		);
    852. 

  852. 	}
    853. 

  853. 

  854. 	/**
    855. 

  855. 	* Collects stats that can be displayed on the index maintenance page
    856. 

  856. 	*/
    857. 

  857. 	protected function get_stats()
    858. 

  858. 	{
    859. 

  859. 		if ($this->index_created())
    860. 

  860. 		{
    861. 

  861. 			$sql = 'SELECT COUNT(post_id) as total_posts
    862. 

  862. 				FROM ' . POSTS_TABLE;
    863. 

  863. 			$result = $this->db->sql_query($sql);
    864. 

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

  865. 			$this->db->sql_freeresult($result);
    866. 

  866. 

  867. 			$sql = 'SELECT COUNT(p.post_id) as main_posts
    868. 

  868. 				FROM ' . POSTS_TABLE . ' p, ' . SPHINX_TABLE . ' m
    869. 

  869. 				WHERE p.post_id <= m.max_doc_id
    870. 

  870. 					AND m.counter_id = 1';
    871. 

  871. 			$result = $this->db->sql_query($sql);
    872. 

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

  873. 			$this->db->sql_freeresult($result);
    874. 

  874. 		}
    875. 

  875. 	}
    876. 

  876. 

  877. 	/**
    878. 

  878. 	* Returns a list of options for the ACP to display
    879. 

  879. 	*
    880. 

  880. 	* @return associative array containing template and config variables
    881. 

  881. 	*/
    882. 

  882. 	public function acp()
    883. 

  883. 	{
    884. 

  884. 		$config_vars = array(
    885. 

  885. 			'fulltext_sphinx_data_path' => 'string',
    886. 

  886. 			'fulltext_sphinx_host' => 'string',
    887. 

  887. 			'fulltext_sphinx_port' => 'string',
    888. 

  888. 			'fulltext_sphinx_indexer_mem_limit' => 'int',
    889. 

  889. 		);
    890. 

  890. 

  891. 		$tpl = '
    892. 

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

  893. 		<dl>
    894. 

  894. 			<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>
    895. 

  895. 			<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>
    896. 

  896. 		</dl>
    897. 

  897. 		<dl>
    898. 

  898. 			<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>
    899. 

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

  900. 		</dl>
    901. 

  901. 		<dl>
    902. 

  902. 			<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>
    903. 

  903. 			<dd><input id="fulltext_sphinx_port" type="number" size="4" maxlength="10" name="config[fulltext_sphinx_port]" value="' . $this->config['fulltext_sphinx_port'] . '" /></dd>
    904. 

  904. 		</dl>
    905. 

  905. 		<dl>
    906. 

  906. 			<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>
    907. 

  907. 			<dd><input id="fulltext_sphinx_indexer_mem_limit" type="number" size="4" maxlength="10" name="config[fulltext_sphinx_indexer_mem_limit]" value="' . $this->config['fulltext_sphinx_indexer_mem_limit'] . '" /> ' . $this->user->lang['MIB'] . '</dd>
    908. 

  908. 		</dl>
    909. 

  909. 		<dl>
    910. 

  910. 			<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>
    911. 

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

  912. 		<dl>
    913. 

  913. 		';
    914. 

    915. 

  915. 		// These are fields required in the config table
    916. 

  916. 		return array(
    917. 

  917. 			'tpl'		=> $tpl,
    918. 

  918. 			'config'	=> $config_vars
    919. 

  919. 		);
    920. 

  920. 	}
    921. 

  921. }
    922. 

  922.