Chris@76: <?php
Chris@76: 
Chris@76: /**
Chris@76:  * Simple Machines Forum (SMF)
Chris@76:  *
Chris@76:  * @package SMF
Chris@76:  * @author Simple Machines http://www.simplemachines.org
Chris@76:  * @copyright 2011 Simple Machines
Chris@76:  * @license http://www.simplemachines.org/about/smf/license.php BSD
Chris@76:  *
Chris@76:  * @version 2.0
Chris@76:  */
Chris@76: 
Chris@76: if (!defined('SMF'))
Chris@76: 	die('Hacking attempt...');
Chris@76: 
Chris@76: /* The admin screen to change the search settings.
Chris@76: 
Chris@76: 	void ManageSearch()
Chris@76: 		- main entry point for the admin search settings screen.
Chris@76: 		- called by ?action=admin;area=managesearch.
Chris@76: 		- requires the admin_forum permission.
Chris@76: 		- loads the ManageSearch template.
Chris@76: 		- loads the Search language file.
Chris@76: 		- calls a function based on the given sub-action.
Chris@76: 		- defaults to sub-action 'settings'.
Chris@76: 
Chris@76: 	void EditSearchSettings()
Chris@76: 		- edit some general settings related to the search function.
Chris@76: 		- called by ?action=admin;area=managesearch;sa=settings.
Chris@76: 		- requires the admin_forum permission.
Chris@76: 		- uses the 'modify_settings' sub template of the ManageSearch template.
Chris@76: 
Chris@76: 	void EditWeights()
Chris@76: 		- edit the relative weight of the search factors.
Chris@76: 		- called by ?action=admin;area=managesearch;sa=weights.
Chris@76: 		- requires the admin_forum permission.
Chris@76: 		- uses the 'modify_weights' sub template of the ManageSearch template.
Chris@76: 
Chris@76: 	void EditSearchMethod()
Chris@76: 		- edit the search method and search index used.
Chris@76: 		- called by ?action=admin;area=managesearch;sa=method.
Chris@76: 		- requires the admin_forum permission.
Chris@76: 		- uses the 'select_search_method' sub template of the ManageSearch
Chris@76: 		  template.
Chris@76: 		- allows to create and delete a fulltext index on the messages table.
Chris@76: 		- allows to delete a custom index (that CreateMessageIndex() created).
Chris@76: 		- calculates the size of the current search indexes in use.
Chris@76: 
Chris@76: 	void CreateMessageIndex()
Chris@76: 		- create a custom search index for the messages table.
Chris@76: 		- called by ?action=admin;area=managesearch;sa=createmsgindex.
Chris@76: 		- linked from the EditSearchMethod screen.
Chris@76: 		- requires the admin_forum permission.
Chris@76: 		- uses the 'create_index', 'create_index_progress', and
Chris@76: 		  'create_index_done' sub templates of the ManageSearch template.
Chris@76: 		- depending on the size of the message table, the process is divided
Chris@76: 		  in steps.
Chris@76: 
Chris@76: 	array loadSearchAPIs()
Chris@76: 		- get the installed APIs.
Chris@76: 
Chris@76: */
Chris@76: 
Chris@76: function ManageSearch()
Chris@76: {
Chris@76: 	global $context, $txt, $scripturl;
Chris@76: 
Chris@76: 	isAllowedTo('admin_forum');
Chris@76: 
Chris@76: 	loadLanguage('Search');
Chris@76: 	loadTemplate('ManageSearch');
Chris@76: 
Chris@76: 	db_extend('search');
Chris@76: 
Chris@76: 	$subActions = array(
Chris@76: 		'settings' => 'EditSearchSettings',
Chris@76: 		'weights' => 'EditWeights',
Chris@76: 		'method' => 'EditSearchMethod',
Chris@76: 		'createfulltext' => 'EditSearchMethod',
Chris@76: 		'removecustom' => 'EditSearchMethod',
Chris@76: 		'removefulltext' => 'EditSearchMethod',
Chris@76: 		'createmsgindex' => 'CreateMessageIndex',
Chris@76: 	);
Chris@76: 
Chris@76: 	// Default the sub-action to 'edit search settings'.
Chris@76: 	$_REQUEST['sa'] = isset($_REQUEST['sa']) && isset($subActions[$_REQUEST['sa']]) ? $_REQUEST['sa'] : 'weights';
Chris@76: 
Chris@76: 	$context['sub_action'] = $_REQUEST['sa'];
Chris@76: 
Chris@76: 	// Create the tabs for the template.
Chris@76: 	$context[$context['admin_menu_name']]['tab_data'] = array(
Chris@76: 		'title' => $txt['manage_search'],
Chris@76: 		'help' => 'search',
Chris@76: 		'description' => $txt['search_settings_desc'],
Chris@76: 		'tabs' => array(
Chris@76: 			'weights' => array(
Chris@76: 				'description' => $txt['search_weights_desc'],
Chris@76: 			),
Chris@76: 			'method' => array(
Chris@76: 				'description' => $txt['search_method_desc'],
Chris@76: 			),
Chris@76: 			'settings' => array(
Chris@76: 				'description' => $txt['search_settings_desc'],
Chris@76: 			),
Chris@76: 		),
Chris@76: 	);
Chris@76: 
Chris@76: 	// Call the right function for this sub-acton.
Chris@76: 	$subActions[$_REQUEST['sa']]();
Chris@76: }
Chris@76: 
Chris@76: function EditSearchSettings($return_config = false)
Chris@76: {
Chris@76: 	global $txt, $context, $scripturl, $sourcedir, $modSettings;
Chris@76: 
Chris@76: 	// What are we editing anyway?
Chris@76: 	$config_vars = array(
Chris@76: 			// Permission...
Chris@76: 			array('permissions', 'search_posts'),
Chris@76: 			// Some simple settings.
Chris@76: 			array('check', 'simpleSearch'),
Chris@76: 			array('int', 'search_results_per_page'),
Chris@76: 			array('int', 'search_max_results', 'subtext' => $txt['search_max_results_disable']),
Chris@76: 		'',
Chris@76: 			// Some limitations.
Chris@76: 			array('int', 'search_floodcontrol_time', 'subtext' => $txt['search_floodcontrol_time_desc']),
Chris@76: 	);
Chris@76: 
Chris@76: 	// Perhaps the search method wants to add some settings?
Chris@76: 	$modSettings['search_index'] = empty($modSettings['search_index']) ? 'standard' : $modSettings['search_index'];
Chris@76: 	if (file_exists($sourcedir . '/SearchAPI-' . ucwords($modSettings['search_index']) . '.php'))
Chris@76: 	{
Chris@76: 		loadClassFile('SearchAPI-' . ucwords($modSettings['search_index']) . '.php');
Chris@76: 
Chris@76: 		$method_call = array($modSettings['search_index'] . '_search', 'searchSettings');
Chris@76: 		if (is_callable($method_call))
Chris@76: 			call_user_func_array($method_call, array(&$config_vars));
Chris@76: 	}
Chris@76: 
Chris@76: 	if ($return_config)
Chris@76: 		return $config_vars;
Chris@76: 
Chris@76: 	$context['page_title'] = $txt['search_settings_title'];
Chris@76: 	$context['sub_template'] = 'show_settings';
Chris@76: 
Chris@76: 	// We'll need this for the settings.
Chris@76: 	require_once($sourcedir . '/ManageServer.php');
Chris@76: 
Chris@76: 	// A form was submitted.
Chris@76: 	if (isset($_REQUEST['save']))
Chris@76: 	{
Chris@76: 		checkSession();
Chris@76: 
Chris@76: 		saveDBSettings($config_vars);
Chris@76: 		redirectexit('action=admin;area=managesearch;sa=settings;' . $context['session_var'] . '=' . $context['session_id']);
Chris@76: 	}
Chris@76: 
Chris@76: 	// Prep the template!
Chris@76: 	$context['post_url'] = $scripturl . '?action=admin;area=managesearch;save;sa=settings';
Chris@76: 	$context['settings_title'] = $txt['search_settings_title'];
Chris@76: 
Chris@76: 	prepareDBSettingContext($config_vars);
Chris@76: }
Chris@76: 
Chris@76: function EditWeights()
Chris@76: {
Chris@76: 	global $txt, $context, $modSettings;
Chris@76: 
Chris@76: 	$context['page_title'] = $txt['search_weights_title'];
Chris@76: 	$context['sub_template'] = 'modify_weights';
Chris@76: 
Chris@76: 	$factors = array(
Chris@76: 		'search_weight_frequency',
Chris@76: 		'search_weight_age',
Chris@76: 		'search_weight_length',
Chris@76: 		'search_weight_subject',
Chris@76: 		'search_weight_first_message',
Chris@76: 		'search_weight_sticky',
Chris@76: 	);
Chris@76: 
Chris@76: 	// A form was submitted.
Chris@76: 	if (isset($_POST['save']))
Chris@76: 	{
Chris@76: 		checkSession();
Chris@76: 
Chris@76: 		$changes = array();
Chris@76: 		foreach ($factors as $factor)
Chris@76: 			$changes[$factor] = (int) $_POST[$factor];
Chris@76: 		updateSettings($changes);
Chris@76: 	}
Chris@76: 
Chris@76: 	$context['relative_weights'] = array('total' => 0);
Chris@76: 	foreach ($factors as $factor)
Chris@76: 		$context['relative_weights']['total'] += isset($modSettings[$factor]) ? $modSettings[$factor] : 0;
Chris@76: 
Chris@76: 	foreach ($factors as $factor)
Chris@76: 		$context['relative_weights'][$factor] = round(100 * (isset($modSettings[$factor]) ? $modSettings[$factor] : 0) / $context['relative_weights']['total'], 1);
Chris@76: }
Chris@76: 
Chris@76: function EditSearchMethod()
Chris@76: {
Chris@76: 	global $txt, $context, $modSettings, $smcFunc, $db_type, $db_prefix;
Chris@76: 
Chris@76: 	$context[$context['admin_menu_name']]['current_subsection'] = 'method';
Chris@76: 	$context['page_title'] = $txt['search_method_title'];
Chris@76: 	$context['sub_template'] = 'select_search_method';
Chris@76: 	$context['supports_fulltext'] = $smcFunc['db_search_support']('fulltext');
Chris@76: 
Chris@76: 	// Load any apis.
Chris@76: 	$context['search_apis'] = loadSearchAPIs();
Chris@76: 
Chris@76: 	// Detect whether a fulltext index is set.
Chris@76: 	if ($context['supports_fulltext'])
Chris@76: 	{
Chris@76: 		$request = $smcFunc['db_query']('', '
Chris@76: 			SHOW INDEX
Chris@76: 			FROM {db_prefix}messages',
Chris@76: 			array(
Chris@76: 			)
Chris@76: 		);
Chris@76: 		$context['fulltext_index'] = '';
Chris@76: 		if ($request !== false || $smcFunc['db_num_rows']($request) != 0)
Chris@76: 		{
Chris@76: 			while ($row = $smcFunc['db_fetch_assoc']($request))
Chris@76: 				if ($row['Column_name'] == 'body' && (isset($row['Index_type']) && $row['Index_type'] == 'FULLTEXT' || isset($row['Comment']) && $row['Comment'] == 'FULLTEXT'))
Chris@76: 					$context['fulltext_index'][] = $row['Key_name'];
Chris@76: 			$smcFunc['db_free_result']($request);
Chris@76: 
Chris@76: 			if (is_array($context['fulltext_index']))
Chris@76: 				$context['fulltext_index'] = array_unique($context['fulltext_index']);
Chris@76: 		}
Chris@76: 
Chris@76: 		$request = $smcFunc['db_query']('', '
Chris@76: 			SHOW COLUMNS
Chris@76: 			FROM {db_prefix}messages',
Chris@76: 			array(
Chris@76: 			)
Chris@76: 		);
Chris@76: 		if ($request !== false)
Chris@76: 		{
Chris@76: 			while ($row = $smcFunc['db_fetch_assoc']($request))
Chris@76: 				if ($row['Field'] == 'body' && $row['Type'] == 'mediumtext')
Chris@76: 					$context['cannot_create_fulltext'] = true;
Chris@76: 			$smcFunc['db_free_result']($request);
Chris@76: 		}
Chris@76: 
Chris@76: 		if (preg_match('~^`(.+?)`\.(.+?)$~', $db_prefix, $match) !== 0)
Chris@76: 			$request = $smcFunc['db_query']('', '
Chris@76: 				SHOW TABLE STATUS
Chris@76: 				FROM {string:database_name}
Chris@76: 				LIKE {string:table_name}',
Chris@76: 				array(
Chris@76: 					'database_name' => '`' . strtr($match[1], array('`' => '')) . '`',
Chris@76: 					'table_name' => str_replace('_', '\_', $match[2]) . 'messages',
Chris@76: 				)
Chris@76: 			);
Chris@76: 		else
Chris@76: 			$request = $smcFunc['db_query']('', '
Chris@76: 				SHOW TABLE STATUS
Chris@76: 				LIKE {string:table_name}',
Chris@76: 				array(
Chris@76: 					'table_name' => str_replace('_', '\_', $db_prefix) . 'messages',
Chris@76: 				)
Chris@76: 			);
Chris@76: 
Chris@76: 		if ($request !== false)
Chris@76: 		{
Chris@76: 			while ($row = $smcFunc['db_fetch_assoc']($request))
Chris@76: 				if ((isset($row['Type']) && strtolower($row['Type']) != 'myisam') || (isset($row['Engine']) && strtolower($row['Engine']) != 'myisam'))
Chris@76: 					$context['cannot_create_fulltext'] = true;
Chris@76: 			$smcFunc['db_free_result']($request);
Chris@76: 		}
Chris@76: 	}
Chris@76: 
Chris@76: 	if (!empty($_REQUEST['sa']) && $_REQUEST['sa'] == 'createfulltext')
Chris@76: 	{
Chris@76: 		checkSession('get');
Chris@76: 
Chris@76: 		// Make sure it's gone before creating it.
Chris@76: 		$smcFunc['db_query']('', '
Chris@76: 			ALTER TABLE {db_prefix}messages
Chris@76: 			DROP INDEX body',
Chris@76: 			array(
Chris@76: 				'db_error_skip' => true,
Chris@76: 			)
Chris@76: 		);
Chris@76: 
Chris@76: 		$smcFunc['db_query']('', '
Chris@76: 			ALTER TABLE {db_prefix}messages
Chris@76: 			ADD FULLTEXT body (body)',
Chris@76: 			array(
Chris@76: 			)
Chris@76: 		);
Chris@76: 
Chris@76: 		$context['fulltext_index'] = 'body';
Chris@76: 	}
Chris@76: 	elseif (!empty($_REQUEST['sa']) && $_REQUEST['sa'] == 'removefulltext' && !empty($context['fulltext_index']))
Chris@76: 	{
Chris@76: 		checkSession('get');
Chris@76: 
Chris@76: 		$smcFunc['db_query']('', '
Chris@76: 			ALTER TABLE {db_prefix}messages
Chris@76: 			DROP INDEX ' . implode(',
Chris@76: 			DROP INDEX ', $context['fulltext_index']),
Chris@76: 			array(
Chris@76: 				'db_error_skip' => true,
Chris@76: 			)
Chris@76: 		);
Chris@76: 
Chris@76: 		$context['fulltext_index'] = '';
Chris@76: 
Chris@76: 		// Go back to the default search method.
Chris@76: 		if (!empty($modSettings['search_index']) && $modSettings['search_index'] == 'fulltext')
Chris@76: 			updateSettings(array(
Chris@76: 				'search_index' => '',
Chris@76: 			));
Chris@76: 	}
Chris@76: 	elseif (!empty($_REQUEST['sa']) && $_REQUEST['sa'] == 'removecustom')
Chris@76: 	{
Chris@76: 		checkSession('get');
Chris@76: 
Chris@76: 		db_extend();
Chris@76: 		$tables = $smcFunc['db_list_tables'](false, $db_prefix . 'log_search_words');
Chris@76: 		if (!empty($tables))
Chris@76: 		{
Chris@76: 			$smcFunc['db_search_query']('drop_words_table', '
Chris@76: 				DROP TABLE {db_prefix}log_search_words',
Chris@76: 				array(
Chris@76: 				)
Chris@76: 			);
Chris@76: 		}
Chris@76: 
Chris@76: 		updateSettings(array(
Chris@76: 			'search_custom_index_config' => '',
Chris@76: 			'search_custom_index_resume' => '',
Chris@76: 		));
Chris@76: 
Chris@76: 		// Go back to the default search method.
Chris@76: 		if (!empty($modSettings['search_index']) && $modSettings['search_index'] == 'custom')
Chris@76: 			updateSettings(array(
Chris@76: 				'search_index' => '',
Chris@76: 			));
Chris@76: 	}
Chris@76: 	elseif (isset($_POST['save']))
Chris@76: 	{
Chris@76: 		checkSession();
Chris@76: 		updateSettings(array(
Chris@76: 			'search_index' => empty($_POST['search_index']) || (!in_array($_POST['search_index'], array('fulltext', 'custom')) && !isset($context['search_apis'][$_POST['search_index']])) ? '' : $_POST['search_index'],
Chris@76: 			'search_force_index' => isset($_POST['search_force_index']) ? '1' : '0',
Chris@76: 			'search_match_words' => isset($_POST['search_match_words']) ? '1' : '0',
Chris@76: 		));
Chris@76: 	}
Chris@76: 
Chris@76: 	$context['table_info'] = array(
Chris@76: 		'data_length' => 0,
Chris@76: 		'index_length' => 0,
Chris@76: 		'fulltext_length' => 0,
Chris@76: 		'custom_index_length' => 0,
Chris@76: 	);
Chris@76: 
Chris@76: 	// Get some info about the messages table, to show its size and index size.
Chris@76: 	if ($db_type == 'mysql')
Chris@76: 	{
Chris@76: 		if (preg_match('~^`(.+?)`\.(.+?)$~', $db_prefix, $match) !== 0)
Chris@76: 			$request = $smcFunc['db_query']('', '
Chris@76: 				SHOW TABLE STATUS
Chris@76: 				FROM {string:database_name}
Chris@76: 				LIKE {string:table_name}',
Chris@76: 				array(
Chris@76: 					'database_name' => '`' . strtr($match[1], array('`' => '')) . '`',
Chris@76: 					'table_name' => str_replace('_', '\_', $match[2]) . 'messages',
Chris@76: 				)
Chris@76: 			);
Chris@76: 		else
Chris@76: 			$request = $smcFunc['db_query']('', '
Chris@76: 				SHOW TABLE STATUS
Chris@76: 				LIKE {string:table_name}',
Chris@76: 				array(
Chris@76: 					'table_name' => str_replace('_', '\_', $db_prefix) . 'messages',
Chris@76: 				)
Chris@76: 			);
Chris@76: 		if ($request !== false && $smcFunc['db_num_rows']($request) == 1)
Chris@76: 		{
Chris@76: 			// Only do this if the user has permission to execute this query.
Chris@76: 			$row = $smcFunc['db_fetch_assoc']($request);
Chris@76: 			$context['table_info']['data_length'] = $row['Data_length'];
Chris@76: 			$context['table_info']['index_length'] = $row['Index_length'];
Chris@76: 			$context['table_info']['fulltext_length'] = $row['Index_length'];
Chris@76: 			$smcFunc['db_free_result']($request);
Chris@76: 		}
Chris@76: 
Chris@76: 		// Now check the custom index table, if it exists at all.
Chris@76: 		if (preg_match('~^`(.+?)`\.(.+?)$~', $db_prefix, $match) !== 0)
Chris@76: 			$request = $smcFunc['db_query']('', '
Chris@76: 				SHOW TABLE STATUS
Chris@76: 				FROM {string:database_name}
Chris@76: 				LIKE {string:table_name}',
Chris@76: 				array(
Chris@76: 					'database_name' => '`' . strtr($match[1], array('`' => '')) . '`',
Chris@76: 					'table_name' => str_replace('_', '\_', $match[2]) . 'log_search_words',
Chris@76: 				)
Chris@76: 			);
Chris@76: 		else
Chris@76: 			$request = $smcFunc['db_query']('', '
Chris@76: 				SHOW TABLE STATUS
Chris@76: 				LIKE {string:table_name}',
Chris@76: 				array(
Chris@76: 					'table_name' => str_replace('_', '\_', $db_prefix) . 'log_search_words',
Chris@76: 				)
Chris@76: 			);
Chris@76: 		if ($request !== false && $smcFunc['db_num_rows']($request) == 1)
Chris@76: 		{
Chris@76: 			// Only do this if the user has permission to execute this query.
Chris@76: 			$row = $smcFunc['db_fetch_assoc']($request);
Chris@76: 			$context['table_info']['index_length'] += $row['Data_length'] + $row['Index_length'];
Chris@76: 			$context['table_info']['custom_index_length'] = $row['Data_length'] + $row['Index_length'];
Chris@76: 			$smcFunc['db_free_result']($request);
Chris@76: 		}
Chris@76: 	}
Chris@76: 	elseif ($db_type == 'postgresql')
Chris@76: 	{
Chris@76: 		// In order to report the sizes correctly we need to perform vacuum (optimize) on the tables we will be using.
Chris@76: 		db_extend();
Chris@76: 		$temp_tables = $smcFunc['db_list_tables']();
Chris@76: 		foreach ($temp_tables as $table)
Chris@76: 			if ($table == $db_prefix. 'messages' || $table == $db_prefix. 'log_search_words')
Chris@76: 				$smcFunc['db_optimize_table']($table);
Chris@76: 
Chris@76: 		// PostGreSql has some hidden sizes.
Chris@76: 		$request = $smcFunc['db_query']('', '
Chris@76: 			SELECT relname, relpages * 8 *1024 AS "KB" FROM pg_class
Chris@76: 			WHERE relname = {string:messages} OR relname = {string:log_search_words}
Chris@76: 			ORDER BY relpages DESC',
Chris@76: 			array(
Chris@76: 				'messages' => $db_prefix. 'messages',
Chris@76: 				'log_search_words' => $db_prefix. 'log_search_words',
Chris@76: 			)
Chris@76: 		);
Chris@76: 
Chris@76: 		if ($request !== false && $smcFunc['db_num_rows']($request) > 0)
Chris@76: 		{
Chris@76: 			while ($row = $smcFunc['db_fetch_assoc']($request))
Chris@76: 			{
Chris@76: 				if ($row['relname'] == $db_prefix . 'messages')
Chris@76: 				{
Chris@76: 					$context['table_info']['data_length'] = (int) $row['KB'];
Chris@76: 					$context['table_info']['index_length'] = (int) $row['KB'];
Chris@76: 					// Doesn't support fulltext
Chris@76: 					$context['table_info']['fulltext_length'] = $txt['not_applicable'];
Chris@76: 				}
Chris@76: 				elseif ($row['relname'] == $db_prefix. 'log_search_words')
Chris@76: 				{
Chris@76: 					$context['table_info']['index_length'] = (int) $row['KB'];
Chris@76: 					$context['table_info']['custom_index_length'] = (int) $row['KB'];
Chris@76: 				}
Chris@76: 			}
Chris@76: 			$smcFunc['db_free_result']($request);
Chris@76: 		}
Chris@76: 		else
Chris@76: 			// Didn't work for some reason...
Chris@76: 			$context['table_info'] = array(
Chris@76: 				'data_length' => $txt['not_applicable'],
Chris@76: 				'index_length' => $txt['not_applicable'],
Chris@76: 				'fulltext_length' => $txt['not_applicable'],
Chris@76: 				'custom_index_length' => $txt['not_applicable'],
Chris@76: 			);
Chris@76: 	}
Chris@76: 	else
Chris@76: 		$context['table_info'] = array(
Chris@76: 			'data_length' => $txt['not_applicable'],
Chris@76: 			'index_length' => $txt['not_applicable'],
Chris@76: 			'fulltext_length' => $txt['not_applicable'],
Chris@76: 			'custom_index_length' => $txt['not_applicable'],
Chris@76: 		);
Chris@76: 
Chris@76: 	// Format the data and index length in kilobytes.
Chris@76: 	foreach ($context['table_info'] as $type => $size)
Chris@76: 	{
Chris@76: 		// If it's not numeric then just break.  This database engine doesn't support size.
Chris@76: 		if (!is_numeric($size))
Chris@76: 			break;
Chris@76: 
Chris@76: 		$context['table_info'][$type] = comma_format($context['table_info'][$type] / 1024) . ' ' . $txt['search_method_kilobytes'];
Chris@76: 	}
Chris@76: 
Chris@76: 	$context['custom_index'] = !empty($modSettings['search_custom_index_config']);
Chris@76: 	$context['partial_custom_index'] = !empty($modSettings['search_custom_index_resume']) && empty($modSettings['search_custom_index_config']);
Chris@76: 	$context['double_index'] = !empty($context['fulltext_index']) && $context['custom_index'];
Chris@76: }
Chris@76: 
Chris@76: function CreateMessageIndex()
Chris@76: {
Chris@76: 	global $modSettings, $context, $smcFunc, $db_prefix, $txt;
Chris@76: 
Chris@76: 	// Scotty, we need more time...
Chris@76: 	@set_time_limit(600);
Chris@76: 	if (function_exists('apache_reset_timeout'))
Chris@76: 		@apache_reset_timeout();
Chris@76: 
Chris@76: 	$context[$context['admin_menu_name']]['current_subsection'] = 'method';
Chris@76: 	$context['page_title'] = $txt['search_index_custom'];
Chris@76: 
Chris@76: 	$messages_per_batch = 50;
Chris@76: 
Chris@76: 	$index_properties = array(
Chris@76: 		2 => array(
Chris@76: 			'column_definition' => 'small',
Chris@76: 			'step_size' => 1000000,
Chris@76: 		),
Chris@76: 		4 => array(
Chris@76: 			'column_definition' => 'medium',
Chris@76: 			'step_size' => 1000000,
Chris@76: 			'max_size' => 16777215,
Chris@76: 		),
Chris@76: 		5 => array(
Chris@76: 			'column_definition' => 'large',
Chris@76: 			'step_size' => 100000000,
Chris@76: 			'max_size' => 2000000000,
Chris@76: 		),
Chris@76: 	);
Chris@76: 
Chris@76: 	if (isset($_REQUEST['resume']) && !empty($modSettings['search_custom_index_resume']))
Chris@76: 	{
Chris@76: 		$context['index_settings'] = unserialize($modSettings['search_custom_index_resume']);
Chris@76: 		$context['start'] = (int) $context['index_settings']['resume_at'];
Chris@76: 		unset($context['index_settings']['resume_at']);
Chris@76: 		$context['step'] = 1;
Chris@76: 	}
Chris@76: 	else
Chris@76: 	{
Chris@76: 		$context['index_settings'] = array(
Chris@76: 			'bytes_per_word' => isset($_REQUEST['bytes_per_word']) && isset($index_properties[$_REQUEST['bytes_per_word']]) ? (int) $_REQUEST['bytes_per_word'] : 2,
Chris@76: 		);
Chris@76: 		$context['start'] = isset($_REQUEST['start']) ? (int) $_REQUEST['start'] : 0;
Chris@76: 		$context['step'] = isset($_REQUEST['step']) ? (int) $_REQUEST['step'] : 0;
Chris@76: 	}
Chris@76: 
Chris@76: 	if ($context['step'] !== 0)
Chris@76: 		checkSession('request');
Chris@76: 
Chris@76: 	// Step 0: let the user determine how they like their index.
Chris@76: 	if ($context['step'] === 0)
Chris@76: 	{
Chris@76: 		$context['sub_template'] = 'create_index';
Chris@76: 	}
Chris@76: 
Chris@76: 	// Step 1: insert all the words.
Chris@76: 	if ($context['step'] === 1)
Chris@76: 	{
Chris@76: 		$context['sub_template'] = 'create_index_progress';
Chris@76: 
Chris@76: 		if ($context['start'] === 0)
Chris@76: 		{
Chris@76: 			db_extend();
Chris@76: 			$tables = $smcFunc['db_list_tables'](false, $db_prefix . 'log_search_words');
Chris@76: 			if (!empty($tables))
Chris@76: 			{
Chris@76: 				$smcFunc['db_search_query']('drop_words_table', '
Chris@76: 					DROP TABLE {db_prefix}log_search_words',
Chris@76: 					array(
Chris@76: 					)
Chris@76: 				);
Chris@76: 			}
Chris@76: 
Chris@76: 			$smcFunc['db_create_word_search']($index_properties[$context['index_settings']['bytes_per_word']]['column_definition']);
Chris@76: 
Chris@76: 			// Temporarily switch back to not using a search index.
Chris@76: 			if (!empty($modSettings['search_index']) && $modSettings['search_index'] == 'custom')
Chris@76: 				updateSettings(array('search_index' => ''));
Chris@76: 
Chris@76: 			// Don't let simultanious processes be updating the search index.
Chris@76: 			if (!empty($modSettings['search_custom_index_config']))
Chris@76: 				updateSettings(array('search_custom_index_config' => ''));
Chris@76: 		}
Chris@76: 
Chris@76: 		$num_messages = array(
Chris@76: 			'done' => 0,
Chris@76: 			'todo' => 0,
Chris@76: 		);
Chris@76: 
Chris@76: 		$request = $smcFunc['db_query']('', '
Chris@76: 			SELECT id_msg >= {int:starting_id} AS todo, COUNT(*) AS num_messages
Chris@76: 			FROM {db_prefix}messages
Chris@76: 			GROUP BY todo',
Chris@76: 			array(
Chris@76: 				'starting_id' => $context['start'],
Chris@76: 			)
Chris@76: 		);
Chris@76: 		while ($row = $smcFunc['db_fetch_assoc']($request))
Chris@76: 			$num_messages[empty($row['todo']) ? 'done' : 'todo'] = $row['num_messages'];
Chris@76: 
Chris@76: 		if (empty($num_messages['todo']))
Chris@76: 		{
Chris@76: 			$context['step'] = 2;
Chris@76: 			$context['percentage'] = 80;
Chris@76: 			$context['start'] = 0;
Chris@76: 		}
Chris@76: 		else
Chris@76: 		{
Chris@76: 			// Number of seconds before the next step.
Chris@76: 			$stop = time() + 3;
Chris@76: 			while (time() < $stop)
Chris@76: 			{
Chris@76: 				$inserts = array();
Chris@76: 				$request = $smcFunc['db_query']('', '
Chris@76: 					SELECT id_msg, body
Chris@76: 					FROM {db_prefix}messages
Chris@76: 					WHERE id_msg BETWEEN {int:starting_id} AND {int:ending_id}
Chris@76: 					LIMIT {int:limit}',
Chris@76: 					array(
Chris@76: 						'starting_id' => $context['start'],
Chris@76: 						'ending_id' => $context['start'] + $messages_per_batch - 1,
Chris@76: 						'limit' => $messages_per_batch,
Chris@76: 					)
Chris@76: 				);
Chris@76: 				$forced_break = false;
Chris@76: 				$number_processed = 0;
Chris@76: 				while ($row = $smcFunc['db_fetch_assoc']($request))
Chris@76: 				{
Chris@76: 					// In theory it's possible for one of these to take friggin ages so add more timeout protection.
Chris@76: 					if ($stop < time())
Chris@76: 					{
Chris@76: 						$forced_break = true;
Chris@76: 						break;
Chris@76: 					}
Chris@76: 
Chris@76: 					$number_processed++;
Chris@76: 					foreach (text2words($row['body'], $context['index_settings']['bytes_per_word'], true) as $id_word)
Chris@76: 					{
Chris@76: 						$inserts[] = array($id_word, $row['id_msg']);
Chris@76: 					}
Chris@76: 				}
Chris@76: 				$num_messages['done'] += $number_processed;
Chris@76: 				$num_messages['todo'] -= $number_processed;
Chris@76: 				$smcFunc['db_free_result']($request);
Chris@76: 
Chris@76: 				$context['start'] += $forced_break ? $number_processed : $messages_per_batch;
Chris@76: 
Chris@76: 				if (!empty($inserts))
Chris@76: 					$smcFunc['db_insert']('ignore',
Chris@76: 						'{db_prefix}log_search_words',
Chris@76: 						array('id_word' => 'int', 'id_msg' => 'int'),
Chris@76: 						$inserts,
Chris@76: 						array('id_word', 'id_msg')
Chris@76: 					);
Chris@76: 				if ($num_messages['todo'] === 0)
Chris@76: 				{
Chris@76: 					$context['step'] = 2;
Chris@76: 					$context['start'] = 0;
Chris@76: 					break;
Chris@76: 				}
Chris@76: 				else
Chris@76: 					updateSettings(array('search_custom_index_resume' => serialize(array_merge($context['index_settings'], array('resume_at' => $context['start'])))));
Chris@76: 			}
Chris@76: 
Chris@76: 			// Since there are still two steps to go, 90% is the maximum here.
Chris@76: 			$context['percentage'] = round($num_messages['done'] / ($num_messages['done'] + $num_messages['todo']), 3) * 80;
Chris@76: 		}
Chris@76: 	}
Chris@76: 
Chris@76: 	// Step 2: removing the words that occur too often and are of no use.
Chris@76: 	elseif ($context['step'] === 2)
Chris@76: 	{
Chris@76: 		if ($context['index_settings']['bytes_per_word'] < 4)
Chris@76: 			$context['step'] = 3;
Chris@76: 		else
Chris@76: 		{
Chris@76: 			$stop_words = $context['start'] === 0 || empty($modSettings['search_stopwords']) ? array() : explode(',', $modSettings['search_stopwords']);
Chris@76: 			$stop = time() + 3;
Chris@76: 			$context['sub_template'] = 'create_index_progress';
Chris@76: 			$max_messages = ceil(60 * $modSettings['totalMessages'] / 100);
Chris@76: 
Chris@76: 			while (time() < $stop)
Chris@76: 			{
Chris@76: 				$request = $smcFunc['db_query']('', '
Chris@76: 					SELECT id_word, COUNT(id_word) AS num_words
Chris@76: 					FROM {db_prefix}log_search_words
Chris@76: 					WHERE id_word BETWEEN {int:starting_id} AND {int:ending_id}
Chris@76: 					GROUP BY id_word
Chris@76: 					HAVING COUNT(id_word) > {int:minimum_messages}',
Chris@76: 					array(
Chris@76: 						'starting_id' => $context['start'],
Chris@76: 						'ending_id' => $context['start'] + $index_properties[$context['index_settings']['bytes_per_word']]['step_size'] - 1,
Chris@76: 						'minimum_messages' => $max_messages,
Chris@76: 					)
Chris@76: 				);
Chris@76: 				while ($row = $smcFunc['db_fetch_assoc']($request))
Chris@76: 					$stop_words[] = $row['id_word'];
Chris@76: 				$smcFunc['db_free_result']($request);
Chris@76: 
Chris@76: 				updateSettings(array('search_stopwords' => implode(',', $stop_words)));
Chris@76: 
Chris@76: 				if (!empty($stop_words))
Chris@76: 					$smcFunc['db_query']('', '
Chris@76: 						DELETE FROM {db_prefix}log_search_words
Chris@76: 						WHERE id_word in ({array_int:stop_words})',
Chris@76: 						array(
Chris@76: 							'stop_words' => $stop_words,
Chris@76: 						)
Chris@76: 					);
Chris@76: 
Chris@76: 				$context['start'] += $index_properties[$context['index_settings']['bytes_per_word']]['step_size'];
Chris@76: 				if ($context['start'] > $index_properties[$context['index_settings']['bytes_per_word']]['max_size'])
Chris@76: 				{
Chris@76: 					$context['step'] = 3;
Chris@76: 					break;
Chris@76: 				}
Chris@76: 			}
Chris@76: 			$context['percentage'] = 80 + round($context['start'] / $index_properties[$context['index_settings']['bytes_per_word']]['max_size'], 3) * 20;
Chris@76: 		}
Chris@76: 	}
Chris@76: 
Chris@76: 	// Step 3: remove words not distinctive enough.
Chris@76: 	if ($context['step'] === 3)
Chris@76: 	{
Chris@76: 		$context['sub_template'] = 'create_index_done';
Chris@76: 
Chris@76: 		updateSettings(array('search_index' => 'custom', 'search_custom_index_config' => serialize($context['index_settings'])));
Chris@76: 		$smcFunc['db_query']('', '
Chris@76: 			DELETE FROM {db_prefix}settings
Chris@76: 			WHERE variable = {string:search_custom_index_resume}',
Chris@76: 			array(
Chris@76: 				'search_custom_index_resume' => 'search_custom_index_resume',
Chris@76: 			)
Chris@76: 		);
Chris@76: 	}
Chris@76: }
Chris@76: 
Chris@76: // Get the installed APIs.
Chris@76: function loadSearchAPIs()
Chris@76: {
Chris@76: 	global $sourcedir, $txt;
Chris@76: 
Chris@76: 	$apis = array();
Chris@76: 	if ($dh = opendir($sourcedir))
Chris@76: 	{
Chris@76: 		while (($file = readdir($dh)) !== false)
Chris@76: 		{
Chris@76: 			if (is_file($sourcedir . '/' . $file) && preg_match('~SearchAPI-([A-Za-z\d_]+)\.php~', $file, $matches))
Chris@76: 			{
Chris@76: 				// Check this is definitely a valid API!
Chris@76: 				$fp = fopen($sourcedir . '/' . $file, 'rb');
Chris@76: 				$header = fread($fp, 4096);
Chris@76: 				fclose($fp);
Chris@76: 
Chris@76: 				if (strpos($header, '* SearchAPI-' . $matches[1] . '.php') !== false)
Chris@76: 				{
Chris@76: 					loadClassFile($file);
Chris@76: 
Chris@76: 					$index_name = strtolower($matches[1]);
Chris@76: 					$search_class_name = $index_name . '_search';
Chris@76: 					$searchAPI = new $search_class_name();
Chris@76: 
Chris@76: 					// No Support?  NEXT!
Chris@76: 					if (!$searchAPI->is_supported)
Chris@76: 						continue;
Chris@76: 
Chris@76: 					$apis[$index_name] = array(
Chris@76: 						'filename' => $file,
Chris@76: 						'setting_index' => $index_name,
Chris@76: 						'has_template' => in_array($index_name, array('custom', 'fulltext', 'standard')),
Chris@76: 						'label' => $index_name && isset($txt['search_index_' . $index_name]) ? $txt['search_index_' . $index_name] : '',
Chris@76: 						'desc' => $index_name && isset($txt['search_index_' . $index_name . '_desc']) ? $txt['search_index_' . $index_name . '_desc'] : '',
Chris@76: 					);
Chris@76: 				}
Chris@76: 			}
Chris@76: 		}
Chris@76: 	}
Chris@76: 	closedir($dh);
Chris@76: 
Chris@76: 	return $apis;
Chris@76: }
Chris@76: 
Chris@76: ?>