ManageSearch.php 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803
  1. <?php
  2. /**
  3. * The admin screen to change the search settings.
  4. *
  5. * Simple Machines Forum (SMF)
  6. *
  7. * @package SMF
  8. * @author Simple Machines http://www.simplemachines.org
  9. * @copyright 2014 Simple Machines and individual contributors
  10. * @license http://www.simplemachines.org/about/smf/license.php BSD
  11. *
  12. * @version 2.1 Alpha 1
  13. */
  14. if (!defined('SMF'))
  15. die('No direct access...');
  16. /**
  17. * Main entry point for the admin search settings screen.
  18. * It checks permissions, and it forwards to the appropriate function based on
  19. * the given sub-action.
  20. * Defaults to sub-action 'settings'.
  21. * Called by ?action=admin;area=managesearch.
  22. * Requires the admin_forum permission.
  23. *
  24. * @uses ManageSearch template.
  25. * @uses Search language file.
  26. */
  27. function ManageSearch()
  28. {
  29. global $context, $txt;
  30. isAllowedTo('admin_forum');
  31. loadLanguage('Search');
  32. loadTemplate('ManageSearch');
  33. db_extend('search');
  34. $subActions = array(
  35. 'settings' => 'EditSearchSettings',
  36. 'weights' => 'EditWeights',
  37. 'method' => 'EditSearchMethod',
  38. 'createfulltext' => 'EditSearchMethod',
  39. 'removecustom' => 'EditSearchMethod',
  40. 'removefulltext' => 'EditSearchMethod',
  41. 'createmsgindex' => 'CreateMessageIndex',
  42. );
  43. call_integration_hook('integrate_manage_search', array(&$subActions));
  44. // Default the sub-action to 'edit search settings'.
  45. $_REQUEST['sa'] = isset($_REQUEST['sa']) && isset($subActions[$_REQUEST['sa']]) ? $_REQUEST['sa'] : 'weights';
  46. $context['sub_action'] = $_REQUEST['sa'];
  47. // Create the tabs for the template.
  48. $context[$context['admin_menu_name']]['tab_data'] = array(
  49. 'title' => $txt['manage_search'],
  50. 'help' => 'search',
  51. 'description' => $txt['search_settings_desc'],
  52. 'tabs' => array(
  53. 'weights' => array(
  54. 'description' => $txt['search_weights_desc'],
  55. ),
  56. 'method' => array(
  57. 'description' => $txt['search_method_desc'],
  58. ),
  59. 'settings' => array(
  60. 'description' => $txt['search_settings_desc'],
  61. ),
  62. ),
  63. );
  64. // Call the right function for this sub-action.
  65. $subActions[$_REQUEST['sa']]();
  66. }
  67. /**
  68. * Edit some general settings related to the search function.
  69. * Called by ?action=admin;area=managesearch;sa=settings.
  70. * Requires the admin_forum permission.
  71. *
  72. * @param $return_config
  73. * @uses ManageSearch template, 'modify_settings' sub-template.
  74. */
  75. function EditSearchSettings($return_config = false)
  76. {
  77. global $txt, $context, $scripturl, $sourcedir, $modSettings;
  78. // What are we editing anyway?
  79. $config_vars = array(
  80. // Permission...
  81. array('permissions', 'search_posts'),
  82. // Some simple settings.
  83. array('check', 'simpleSearch'),
  84. array('check', 'search_dropdown'),
  85. array('int', 'search_results_per_page'),
  86. array('int', 'search_max_results', 'subtext' => $txt['search_max_results_disable']),
  87. '',
  88. // Some limitations.
  89. array('int', 'search_floodcontrol_time', 'subtext' => $txt['search_floodcontrol_time_desc'], 6, 'postinput' => $txt['seconds']),
  90. );
  91. call_integration_hook('integrate_modify_search_settings', array(&$config_vars));
  92. // Perhaps the search method wants to add some settings?
  93. require_once($sourcedir . '/Search.php');
  94. $searchAPI = findSearchAPI();
  95. if (is_callable(array($searchAPI, 'searchSettings')))
  96. call_user_func_array($searchAPI->searchSettings, array(&$config_vars));
  97. if ($return_config)
  98. return $config_vars;
  99. $context['page_title'] = $txt['search_settings_title'];
  100. $context['sub_template'] = 'show_settings';
  101. // We'll need this for the settings.
  102. require_once($sourcedir . '/ManageServer.php');
  103. // A form was submitted.
  104. if (isset($_REQUEST['save']))
  105. {
  106. checkSession();
  107. call_integration_hook('integrate_save_search_settings');
  108. if (empty($_POST['search_results_per_page']))
  109. $_POST['search_results_per_page'] = !empty($modSettings['search_results_per_page']) ? $modSettings['search_results_per_page'] : $modSettings['defaultMaxMessages'];
  110. saveDBSettings($config_vars);
  111. $_SESSION['adm-save'] = true;
  112. redirectexit('action=admin;area=managesearch;sa=settings;' . $context['session_var'] . '=' . $context['session_id']);
  113. }
  114. // Prep the template!
  115. $context['post_url'] = $scripturl . '?action=admin;area=managesearch;save;sa=settings';
  116. $context['settings_title'] = $txt['search_settings_title'];
  117. // We need this for the in-line permissions
  118. createToken('admin-mp');
  119. prepareDBSettingContext($config_vars);
  120. }
  121. /**
  122. * Edit the relative weight of the search factors.
  123. * Called by ?action=admin;area=managesearch;sa=weights.
  124. * Requires the admin_forum permission.
  125. *
  126. * @uses ManageSearch template, 'modify_weights' sub-template.
  127. */
  128. function EditWeights()
  129. {
  130. global $txt, $context, $modSettings;
  131. $context['page_title'] = $txt['search_weights_title'];
  132. $context['sub_template'] = 'modify_weights';
  133. $factors = array(
  134. 'search_weight_frequency',
  135. 'search_weight_age',
  136. 'search_weight_length',
  137. 'search_weight_subject',
  138. 'search_weight_first_message',
  139. 'search_weight_sticky',
  140. );
  141. call_integration_hook('integrate_modify_search_weights', array(&$factors));
  142. // A form was submitted.
  143. if (isset($_POST['save']))
  144. {
  145. checkSession();
  146. validateToken('admin-msw');
  147. call_integration_hook('integrate_save_search_weights');
  148. $changes = array();
  149. foreach ($factors as $factor)
  150. $changes[$factor] = (int) $_POST[$factor];
  151. updateSettings($changes);
  152. }
  153. $context['relative_weights'] = array('total' => 0);
  154. foreach ($factors as $factor)
  155. $context['relative_weights']['total'] += isset($modSettings[$factor]) ? $modSettings[$factor] : 0;
  156. foreach ($factors as $factor)
  157. $context['relative_weights'][$factor] = round(100 * (isset($modSettings[$factor]) ? $modSettings[$factor] : 0) / $context['relative_weights']['total'], 1);
  158. createToken('admin-msw');
  159. }
  160. /**
  161. * Edit the search method and search index used.
  162. * Calculates the size of the current search indexes in use.
  163. * Allows to create and delete a fulltext index on the messages table.
  164. * Allows to delete a custom index (that CreateMessageIndex() created).
  165. * Called by ?action=admin;area=managesearch;sa=method.
  166. * Requires the admin_forum permission.
  167. *
  168. * @uses ManageSearch template, 'select_search_method' sub-template.
  169. */
  170. function EditSearchMethod()
  171. {
  172. global $txt, $context, $modSettings, $smcFunc, $db_type, $db_prefix;
  173. $context[$context['admin_menu_name']]['current_subsection'] = 'method';
  174. $context['page_title'] = $txt['search_method_title'];
  175. $context['sub_template'] = 'select_search_method';
  176. $context['supports_fulltext'] = $smcFunc['db_search_support']('fulltext');
  177. // Load any apis.
  178. $context['search_apis'] = loadSearchAPIs();
  179. // Detect whether a fulltext index is set.
  180. if ($context['supports_fulltext'])
  181. detectFulltextIndex();
  182. if (!empty($_REQUEST['sa']) && $_REQUEST['sa'] == 'createfulltext')
  183. {
  184. checkSession('get');
  185. validateToken('admin-msm', 'get');
  186. // Make sure it's gone before creating it.
  187. $smcFunc['db_query']('', '
  188. ALTER TABLE {db_prefix}messages
  189. DROP INDEX body',
  190. array(
  191. 'db_error_skip' => true,
  192. )
  193. );
  194. $smcFunc['db_query']('', '
  195. ALTER TABLE {db_prefix}messages
  196. ADD FULLTEXT body (body)',
  197. array(
  198. )
  199. );
  200. $context['fulltext_index'] = 'body';
  201. }
  202. elseif (!empty($_REQUEST['sa']) && $_REQUEST['sa'] == 'removefulltext' && !empty($context['fulltext_index']))
  203. {
  204. checkSession('get');
  205. validateToken('admin-msm', 'get');
  206. $smcFunc['db_query']('', '
  207. ALTER TABLE {db_prefix}messages
  208. DROP INDEX ' . implode(',
  209. DROP INDEX ', $context['fulltext_index']),
  210. array(
  211. 'db_error_skip' => true,
  212. )
  213. );
  214. $context['fulltext_index'] = '';
  215. // Go back to the default search method.
  216. if (!empty($modSettings['search_index']) && $modSettings['search_index'] == 'fulltext')
  217. updateSettings(array(
  218. 'search_index' => '',
  219. ));
  220. }
  221. elseif (!empty($_REQUEST['sa']) && $_REQUEST['sa'] == 'removecustom')
  222. {
  223. checkSession('get');
  224. validateToken('admin-msm', 'get');
  225. db_extend();
  226. $tables = $smcFunc['db_list_tables'](false, $db_prefix . 'log_search_words');
  227. if (!empty($tables))
  228. {
  229. $smcFunc['db_search_query']('drop_words_table', '
  230. DROP TABLE {db_prefix}log_search_words',
  231. array(
  232. )
  233. );
  234. }
  235. updateSettings(array(
  236. 'search_custom_index_config' => '',
  237. 'search_custom_index_resume' => '',
  238. ));
  239. // Go back to the default search method.
  240. if (!empty($modSettings['search_index']) && $modSettings['search_index'] == 'custom')
  241. updateSettings(array(
  242. 'search_index' => '',
  243. ));
  244. }
  245. elseif (isset($_POST['save']))
  246. {
  247. checkSession();
  248. validateToken('admin-msmpost');
  249. updateSettings(array(
  250. 'search_index' => empty($_POST['search_index']) || (!in_array($_POST['search_index'], array('fulltext', 'custom')) && !isset($context['search_apis'][$_POST['search_index']])) ? '' : $_POST['search_index'],
  251. 'search_force_index' => isset($_POST['search_force_index']) ? '1' : '0',
  252. 'search_match_words' => isset($_POST['search_match_words']) ? '1' : '0',
  253. ));
  254. }
  255. $context['table_info'] = array(
  256. 'data_length' => 0,
  257. 'index_length' => 0,
  258. 'fulltext_length' => 0,
  259. 'custom_index_length' => 0,
  260. );
  261. // Get some info about the messages table, to show its size and index size.
  262. if ($db_type == 'mysql' || $db_type == 'mysqli')
  263. {
  264. if (preg_match('~^`(.+?)`\.(.+?)$~', $db_prefix, $match) !== 0)
  265. $request = $smcFunc['db_query']('', '
  266. SHOW TABLE STATUS
  267. FROM {string:database_name}
  268. LIKE {string:table_name}',
  269. array(
  270. 'database_name' => '`' . strtr($match[1], array('`' => '')) . '`',
  271. 'table_name' => str_replace('_', '\_', $match[2]) . 'messages',
  272. )
  273. );
  274. else
  275. $request = $smcFunc['db_query']('', '
  276. SHOW TABLE STATUS
  277. LIKE {string:table_name}',
  278. array(
  279. 'table_name' => str_replace('_', '\_', $db_prefix) . 'messages',
  280. )
  281. );
  282. if ($request !== false && $smcFunc['db_num_rows']($request) == 1)
  283. {
  284. // Only do this if the user has permission to execute this query.
  285. $row = $smcFunc['db_fetch_assoc']($request);
  286. $context['table_info']['data_length'] = $row['Data_length'];
  287. $context['table_info']['index_length'] = $row['Index_length'];
  288. $context['table_info']['fulltext_length'] = $row['Index_length'];
  289. $smcFunc['db_free_result']($request);
  290. }
  291. // Now check the custom index table, if it exists at all.
  292. if (preg_match('~^`(.+?)`\.(.+?)$~', $db_prefix, $match) !== 0)
  293. $request = $smcFunc['db_query']('', '
  294. SHOW TABLE STATUS
  295. FROM {string:database_name}
  296. LIKE {string:table_name}',
  297. array(
  298. 'database_name' => '`' . strtr($match[1], array('`' => '')) . '`',
  299. 'table_name' => str_replace('_', '\_', $match[2]) . 'log_search_words',
  300. )
  301. );
  302. else
  303. $request = $smcFunc['db_query']('', '
  304. SHOW TABLE STATUS
  305. LIKE {string:table_name}',
  306. array(
  307. 'table_name' => str_replace('_', '\_', $db_prefix) . 'log_search_words',
  308. )
  309. );
  310. if ($request !== false && $smcFunc['db_num_rows']($request) == 1)
  311. {
  312. // Only do this if the user has permission to execute this query.
  313. $row = $smcFunc['db_fetch_assoc']($request);
  314. $context['table_info']['index_length'] += $row['Data_length'] + $row['Index_length'];
  315. $context['table_info']['custom_index_length'] = $row['Data_length'] + $row['Index_length'];
  316. $smcFunc['db_free_result']($request);
  317. }
  318. }
  319. elseif ($db_type == 'postgresql')
  320. {
  321. // In order to report the sizes correctly we need to perform vacuum (optimize) on the tables we will be using.
  322. db_extend();
  323. $temp_tables = $smcFunc['db_list_tables']();
  324. foreach ($temp_tables as $table)
  325. if ($table == $db_prefix. 'messages' || $table == $db_prefix. 'log_search_words')
  326. $smcFunc['db_optimize_table']($table);
  327. // PostGreSql has some hidden sizes.
  328. $request = $smcFunc['db_query']('', '
  329. SELECT relname, relpages * 8 *1024 AS "KB" FROM pg_class
  330. WHERE relname = {string:messages} OR relname = {string:log_search_words}
  331. ORDER BY relpages DESC',
  332. array(
  333. 'messages' => $db_prefix. 'messages',
  334. 'log_search_words' => $db_prefix. 'log_search_words',
  335. )
  336. );
  337. if ($request !== false && $smcFunc['db_num_rows']($request) > 0)
  338. {
  339. while ($row = $smcFunc['db_fetch_assoc']($request))
  340. {
  341. if ($row['relname'] == $db_prefix . 'messages')
  342. {
  343. $context['table_info']['data_length'] = (int) $row['KB'];
  344. $context['table_info']['index_length'] = (int) $row['KB'];
  345. // Doesn't support fulltext
  346. $context['table_info']['fulltext_length'] = $txt['not_applicable'];
  347. }
  348. elseif ($row['relname'] == $db_prefix. 'log_search_words')
  349. {
  350. $context['table_info']['index_length'] = (int) $row['KB'];
  351. $context['table_info']['custom_index_length'] = (int) $row['KB'];
  352. }
  353. }
  354. $smcFunc['db_free_result']($request);
  355. }
  356. else
  357. // Didn't work for some reason...
  358. $context['table_info'] = array(
  359. 'data_length' => $txt['not_applicable'],
  360. 'index_length' => $txt['not_applicable'],
  361. 'fulltext_length' => $txt['not_applicable'],
  362. 'custom_index_length' => $txt['not_applicable'],
  363. );
  364. }
  365. else
  366. $context['table_info'] = array(
  367. 'data_length' => $txt['not_applicable'],
  368. 'index_length' => $txt['not_applicable'],
  369. 'fulltext_length' => $txt['not_applicable'],
  370. 'custom_index_length' => $txt['not_applicable'],
  371. );
  372. // Format the data and index length in kilobytes.
  373. foreach ($context['table_info'] as $type => $size)
  374. {
  375. // If it's not numeric then just break. This database engine doesn't support size.
  376. if (!is_numeric($size))
  377. break;
  378. $context['table_info'][$type] = comma_format($context['table_info'][$type] / 1024) . ' ' . $txt['search_method_kilobytes'];
  379. }
  380. $context['custom_index'] = !empty($modSettings['search_custom_index_config']);
  381. $context['partial_custom_index'] = !empty($modSettings['search_custom_index_resume']) && empty($modSettings['search_custom_index_config']);
  382. $context['double_index'] = !empty($context['fulltext_index']) && $context['custom_index'];
  383. createToken('admin-msmpost');
  384. createToken('admin-msm', 'get');
  385. }
  386. /**
  387. * Create a custom search index for the messages table.
  388. * Called by ?action=admin;area=managesearch;sa=createmsgindex.
  389. * Linked from the EditSearchMethod screen.
  390. * Requires the admin_forum permission.
  391. * Depending on the size of the message table, the process is divided in steps.
  392. *
  393. * @uses ManageSearch template, 'create_index', 'create_index_progress', and 'create_index_done'
  394. * sub-templates.
  395. */
  396. function CreateMessageIndex()
  397. {
  398. global $modSettings, $context, $smcFunc, $db_prefix, $txt;
  399. // Scotty, we need more time...
  400. @set_time_limit(600);
  401. if (function_exists('apache_reset_timeout'))
  402. @apache_reset_timeout();
  403. $context[$context['admin_menu_name']]['current_subsection'] = 'method';
  404. $context['page_title'] = $txt['search_index_custom'];
  405. $messages_per_batch = 50;
  406. $index_properties = array(
  407. 2 => array(
  408. 'column_definition' => 'small',
  409. 'step_size' => 1000000,
  410. ),
  411. 4 => array(
  412. 'column_definition' => 'medium',
  413. 'step_size' => 1000000,
  414. 'max_size' => 16777215,
  415. ),
  416. 5 => array(
  417. 'column_definition' => 'large',
  418. 'step_size' => 100000000,
  419. 'max_size' => 2000000000,
  420. ),
  421. );
  422. if (isset($_REQUEST['resume']) && !empty($modSettings['search_custom_index_resume']))
  423. {
  424. $context['index_settings'] = unserialize($modSettings['search_custom_index_resume']);
  425. $context['start'] = (int) $context['index_settings']['resume_at'];
  426. unset($context['index_settings']['resume_at']);
  427. $context['step'] = 1;
  428. }
  429. else
  430. {
  431. $context['index_settings'] = array(
  432. 'bytes_per_word' => isset($_REQUEST['bytes_per_word']) && isset($index_properties[$_REQUEST['bytes_per_word']]) ? (int) $_REQUEST['bytes_per_word'] : 2,
  433. );
  434. $context['start'] = isset($_REQUEST['start']) ? (int) $_REQUEST['start'] : 0;
  435. $context['step'] = isset($_REQUEST['step']) ? (int) $_REQUEST['step'] : 0;
  436. // admin timeouts are painful when building these long indexes - but only if we actually have such things enabled
  437. if (empty($modSettings['securityDisable']) && $_SESSION['admin_time'] + 3300 < time() && $context['step'] >= 1)
  438. $_SESSION['admin_time'] = time();
  439. }
  440. if ($context['step'] !== 0)
  441. checkSession('request');
  442. // Step 0: let the user determine how they like their index.
  443. if ($context['step'] === 0)
  444. {
  445. $context['sub_template'] = 'create_index';
  446. }
  447. // Step 1: insert all the words.
  448. if ($context['step'] === 1)
  449. {
  450. $context['sub_template'] = 'create_index_progress';
  451. if ($context['start'] === 0)
  452. {
  453. db_extend();
  454. $tables = $smcFunc['db_list_tables'](false, $db_prefix . 'log_search_words');
  455. if (!empty($tables))
  456. {
  457. $smcFunc['db_search_query']('drop_words_table', '
  458. DROP TABLE {db_prefix}log_search_words',
  459. array(
  460. )
  461. );
  462. }
  463. $smcFunc['db_create_word_search']($index_properties[$context['index_settings']['bytes_per_word']]['column_definition']);
  464. // Temporarily switch back to not using a search index.
  465. if (!empty($modSettings['search_index']) && $modSettings['search_index'] == 'custom')
  466. updateSettings(array('search_index' => ''));
  467. // Don't let simultanious processes be updating the search index.
  468. if (!empty($modSettings['search_custom_index_config']))
  469. updateSettings(array('search_custom_index_config' => ''));
  470. }
  471. $num_messages = array(
  472. 'done' => 0,
  473. 'todo' => 0,
  474. );
  475. $request = $smcFunc['db_query']('', '
  476. SELECT id_msg >= {int:starting_id} AS todo, COUNT(*) AS num_messages
  477. FROM {db_prefix}messages
  478. GROUP BY todo',
  479. array(
  480. 'starting_id' => $context['start'],
  481. )
  482. );
  483. while ($row = $smcFunc['db_fetch_assoc']($request))
  484. $num_messages[empty($row['todo']) ? 'done' : 'todo'] = $row['num_messages'];
  485. if (empty($num_messages['todo']))
  486. {
  487. $context['step'] = 2;
  488. $context['percentage'] = 80;
  489. $context['start'] = 0;
  490. }
  491. else
  492. {
  493. // Number of seconds before the next step.
  494. $stop = time() + 3;
  495. while (time() < $stop)
  496. {
  497. $inserts = array();
  498. $request = $smcFunc['db_query']('', '
  499. SELECT id_msg, body
  500. FROM {db_prefix}messages
  501. WHERE id_msg BETWEEN {int:starting_id} AND {int:ending_id}
  502. LIMIT {int:limit}',
  503. array(
  504. 'starting_id' => $context['start'],
  505. 'ending_id' => $context['start'] + $messages_per_batch - 1,
  506. 'limit' => $messages_per_batch,
  507. )
  508. );
  509. $forced_break = false;
  510. $number_processed = 0;
  511. while ($row = $smcFunc['db_fetch_assoc']($request))
  512. {
  513. // In theory it's possible for one of these to take friggin ages so add more timeout protection.
  514. if ($stop < time())
  515. {
  516. $forced_break = true;
  517. break;
  518. }
  519. $number_processed++;
  520. foreach (text2words($row['body'], $context['index_settings']['bytes_per_word'], true) as $id_word)
  521. {
  522. $inserts[] = array($id_word, $row['id_msg']);
  523. }
  524. }
  525. $num_messages['done'] += $number_processed;
  526. $num_messages['todo'] -= $number_processed;
  527. $smcFunc['db_free_result']($request);
  528. $context['start'] += $forced_break ? $number_processed : $messages_per_batch;
  529. if (!empty($inserts))
  530. $smcFunc['db_insert']('ignore',
  531. '{db_prefix}log_search_words',
  532. array('id_word' => 'int', 'id_msg' => 'int'),
  533. $inserts,
  534. array('id_word', 'id_msg')
  535. );
  536. if ($num_messages['todo'] === 0)
  537. {
  538. $context['step'] = 2;
  539. $context['start'] = 0;
  540. break;
  541. }
  542. else
  543. updateSettings(array('search_custom_index_resume' => serialize(array_merge($context['index_settings'], array('resume_at' => $context['start'])))));
  544. }
  545. // Since there are still two steps to go, 80% is the maximum here.
  546. $context['percentage'] = round($num_messages['done'] / ($num_messages['done'] + $num_messages['todo']), 3) * 80;
  547. }
  548. }
  549. // Step 2: removing the words that occur too often and are of no use.
  550. elseif ($context['step'] === 2)
  551. {
  552. if ($context['index_settings']['bytes_per_word'] < 4)
  553. $context['step'] = 3;
  554. else
  555. {
  556. $stop_words = $context['start'] === 0 || empty($modSettings['search_stopwords']) ? array() : explode(',', $modSettings['search_stopwords']);
  557. $stop = time() + 3;
  558. $context['sub_template'] = 'create_index_progress';
  559. $max_messages = ceil(60 * $modSettings['totalMessages'] / 100);
  560. while (time() < $stop)
  561. {
  562. $request = $smcFunc['db_query']('', '
  563. SELECT id_word, COUNT(id_word) AS num_words
  564. FROM {db_prefix}log_search_words
  565. WHERE id_word BETWEEN {int:starting_id} AND {int:ending_id}
  566. GROUP BY id_word
  567. HAVING COUNT(id_word) > {int:minimum_messages}',
  568. array(
  569. 'starting_id' => $context['start'],
  570. 'ending_id' => $context['start'] + $index_properties[$context['index_settings']['bytes_per_word']]['step_size'] - 1,
  571. 'minimum_messages' => $max_messages,
  572. )
  573. );
  574. while ($row = $smcFunc['db_fetch_assoc']($request))
  575. $stop_words[] = $row['id_word'];
  576. $smcFunc['db_free_result']($request);
  577. updateSettings(array('search_stopwords' => implode(',', $stop_words)));
  578. if (!empty($stop_words))
  579. $smcFunc['db_query']('', '
  580. DELETE FROM {db_prefix}log_search_words
  581. WHERE id_word in ({array_int:stop_words})',
  582. array(
  583. 'stop_words' => $stop_words,
  584. )
  585. );
  586. $context['start'] += $index_properties[$context['index_settings']['bytes_per_word']]['step_size'];
  587. if ($context['start'] > $index_properties[$context['index_settings']['bytes_per_word']]['max_size'])
  588. {
  589. $context['step'] = 3;
  590. break;
  591. }
  592. }
  593. $context['percentage'] = 80 + round($context['start'] / $index_properties[$context['index_settings']['bytes_per_word']]['max_size'], 3) * 20;
  594. }
  595. }
  596. // Step 3: remove words not distinctive enough.
  597. if ($context['step'] === 3)
  598. {
  599. $context['sub_template'] = 'create_index_done';
  600. updateSettings(array('search_index' => 'custom', 'search_custom_index_config' => serialize($context['index_settings'])));
  601. $smcFunc['db_query']('', '
  602. DELETE FROM {db_prefix}settings
  603. WHERE variable = {string:search_custom_index_resume}',
  604. array(
  605. 'search_custom_index_resume' => 'search_custom_index_resume',
  606. )
  607. );
  608. }
  609. }
  610. /**
  611. * Get the installed Search API implementations.
  612. * This function checks for patterns in comments on top of the Search-API files!
  613. * In addition to filenames pattern.
  614. * It loads the search API classes if identified.
  615. * This function is used by EditSearchMethod to list all installed API implementations.
  616. */
  617. function loadSearchAPIs()
  618. {
  619. global $sourcedir, $txt;
  620. $apis = array();
  621. if ($dh = opendir($sourcedir))
  622. {
  623. while (($file = readdir($dh)) !== false)
  624. {
  625. if (is_file($sourcedir . '/' . $file) && preg_match('~^SearchAPI-([A-Za-z\d_]+)\.php$~', $file, $matches))
  626. {
  627. // Check this is definitely a valid API!
  628. $fp = fopen($sourcedir . '/' . $file, 'rb');
  629. $header = fread($fp, 4096);
  630. fclose($fp);
  631. if (strpos($header, '* SearchAPI-' . $matches[1] . '.php') !== false)
  632. {
  633. require_once($sourcedir . '/' . $file);
  634. $index_name = strtolower($matches[1]);
  635. $search_class_name = $index_name . '_search';
  636. $searchAPI = new $search_class_name();
  637. // No Support? NEXT!
  638. if (!$searchAPI->is_supported)
  639. continue;
  640. $apis[$index_name] = array(
  641. 'filename' => $file,
  642. 'setting_index' => $index_name,
  643. 'has_template' => in_array($index_name, array('custom', 'fulltext', 'standard')),
  644. 'label' => $index_name && isset($txt['search_index_' . $index_name]) ? $txt['search_index_' . $index_name] : '',
  645. 'desc' => $index_name && isset($txt['search_index_' . $index_name . '_desc']) ? $txt['search_index_' . $index_name . '_desc'] : '',
  646. );
  647. }
  648. }
  649. }
  650. }
  651. closedir($dh);
  652. return $apis;
  653. }
  654. /**
  655. * Checks if the message table already has a fulltext index created and returns the key name
  656. * Determines if a db is capable of creating a fulltext index
  657. */
  658. function detectFulltextIndex()
  659. {
  660. global $smcFunc, $context, $db_prefix;
  661. $request = $smcFunc['db_query']('', '
  662. SHOW INDEX
  663. FROM {db_prefix}messages',
  664. array(
  665. )
  666. );
  667. $context['fulltext_index'] = '';
  668. if ($request !== false || $smcFunc['db_num_rows']($request) != 0)
  669. {
  670. while ($row = $smcFunc['db_fetch_assoc']($request))
  671. if ($row['Column_name'] == 'body' && (isset($row['Index_type']) && $row['Index_type'] == 'FULLTEXT' || isset($row['Comment']) && $row['Comment'] == 'FULLTEXT'))
  672. $context['fulltext_index'][] = $row['Key_name'];
  673. $smcFunc['db_free_result']($request);
  674. if (is_array($context['fulltext_index']))
  675. $context['fulltext_index'] = array_unique($context['fulltext_index']);
  676. }
  677. if (preg_match('~^`(.+?)`\.(.+?)$~', $db_prefix, $match) !== 0)
  678. $request = $smcFunc['db_query']('', '
  679. SHOW TABLE STATUS
  680. FROM {string:database_name}
  681. LIKE {string:table_name}',
  682. array(
  683. 'database_name' => '`' . strtr($match[1], array('`' => '')) . '`',
  684. 'table_name' => str_replace('_', '\_', $match[2]) . 'messages',
  685. )
  686. );
  687. else
  688. $request = $smcFunc['db_query']('', '
  689. SHOW TABLE STATUS
  690. LIKE {string:table_name}',
  691. array(
  692. 'table_name' => str_replace('_', '\_', $db_prefix) . 'messages',
  693. )
  694. );
  695. if ($request !== false)
  696. {
  697. while ($row = $smcFunc['db_fetch_assoc']($request))
  698. if ((isset($row['Type']) && strtolower($row['Type']) != 'myisam') || (isset($row['Engine']) && strtolower($row['Engine']) != 'myisam'))
  699. $context['cannot_create_fulltext'] = true;
  700. $smcFunc['db_free_result']($request);
  701. }
  702. }
  703. ?>