ElkArte\Controller\Search::action_results()

Complexity

Conditions	29
Paths	> 20000

Size

Total Lines	257
Code Lines	117

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	870

Importance

Changes	1
Bugs	0	Features	0

<?php
	public function action_results()
	{
		global $modSettings, $txt, $settings, $context, $options, $messages_request;

		// No, no, no... this is a bit hard on the server, so don't you go prefetching it!
		stop_prefetching();

		// These vars don't require an interface, they're just here for tweaking.
		$recentPercentage = 0.30;

		// Message length used to tweak messages relevance of the results
		$humungousTopicPosts = 200;
		$shortTopicPosts = 5;
		$maxMembersToSearch = 500;

		// Maximum number of results
		$maxMessageResults = empty($modSettings['search_max_results']) ? 0 : $modSettings['search_max_results'] * 5;

		// Start with no errors.
		$context['search_errors'] = [];

		// Number of pages hard maximum - normally not set at all.
		$modSettings['search_max_results'] = empty($modSettings['search_max_results']) ? 200 * $modSettings['search_results_per_page'] : (int) $modSettings['search_max_results'];

		// Maximum length of the string.
		$context['search_string_limit'] = 100;

		Txt::load('Search');
		if ($this->getApi() === false)
		{
			theme()->getTemplates()->load('Search');
		}
		// If we're doing XML, we need to use the results template regardless really.
		else
		{
			$context['sub_template'] = 'results';
		}

		// Are you allowed?
		isAllowedTo('search_posts');

		$this->_search = new \ElkArte\Search\Search();
		$this->_search->setWeights(new WeightFactors($modSettings, $this->user->is_admin));

		$params = $this->_req->getRequest('params', '', '');
		$search_params = new SearchParams($params);
		$search_params->merge((array) $this->_req->post, $recentPercentage, $maxMembersToSearch);

		$this->_search->setParams($search_params, !empty($modSettings['search_simple_fulltext']));

		$context['compact'] = $this->_search->isCompact();

		// Nothing??
		if ($this->_search->param('search') === false || $this->_search->param('search') === '')
		{
			$context['search_errors']['invalid_search_string'] = true;
		}
		// Too long?
		elseif (Util::strlen($this->_search->param('search')) > $context['search_string_limit'])
		{
			$context['search_errors']['string_too_long'] = true;
		}

		// Build the search array
		// $modSettings ['search_simple_fulltext'] is a hidden setting that will
		// do fulltext searching in the most basic way.
		$searchArray = $this->_search->getSearchArray();

		// This is used to remember words that will be ignored (because too short usually)
		$context['search_ignored'] = $this->_search->getIgnored();

		// Make sure at least one word is being searched for.
		if (empty($searchArray))
		{
			if (!empty($context['search_ignored']))
			{
				$context['search_errors']['search_string_small_words'] = true;
			}
			else
			{
				$context['search_errors']['invalid_search_string' . ($this->_search->foundBlockListedWords() ? '_blocklist' : '')] = true;
			}

			// Don't allow duplicate error messages if one string is too short.
			if (isset($context['search_errors']['search_string_small_words'], $context['search_errors']['invalid_search_string']))
			{
				unset($context['search_errors']['invalid_search_string']);
			}
		}

		// Let the user adjust the search query, should they wish?
		$context['search_params'] = (array) $this->_search->getSearchParams(true);
		if (isset($context['search_params']['search']))
		{
			$context['search_params']['search'] = Util::htmlspecialchars($context['search_params']['search']);
		}

		if (isset($context['search_params']['userspec']))
		{
			$context['search_params']['userspec'] = Util::htmlspecialchars($context['search_params']['userspec']);
		}

		if (empty($context['search_params']['minage']))
		{
			$context['search_params']['minage'] = 0;
		}

		if (empty($context['search_params']['maxage']))
		{
			$context['search_params']['maxage'] = 9999;
		}

		$context['search_params'] = $this->_fill_default_search_params($context['search_params']);

		$this->_controlVerifications();

		$context['params'] = $this->_search->compileURLparams();

		// ... and add the links to the link tree.
		$context['breadcrumbs'][] = [
			'url' => getUrl('action', ['action' => 'search', 'params' => $context['params']]),
			'name' => $txt['search']
		];

		$context['breadcrumbs'][] = [
			'url' => getUrl('action', ['action' => 'search', 'sa' => 'results', 'params' => $context['params']]),
			'name' => $txt['search_results']
		];

		// Start guest off collapsed
		if ($context['user']['is_guest'] && !isset($context['minmax_preferences']['asearch']))
		{
			$context['minmax_preferences']['asearch'] = 1;
		}

		// *** A last error check
		call_integration_hook('integrate_search_errors');

		// One or more search errors? Go back to the first search screen.
		if (!empty($context['search_errors']))
		{
			$this->action_search();
			return null;
		}

		// Spam me not, Spam-a-lot?
		if (empty($_SESSION['last_ss']) || $_SESSION['last_ss'] !== $this->_search->param('search'))
		{
			spamProtection('search');
		}

		// Store the last search string to allow pages of results to be browsed.
		$_SESSION['last_ss'] = $this->_search->param('search');

		try
		{
			$search_config = new ValuesContainer([
				'humungousTopicPosts' => $humungousTopicPosts,
				'shortTopicPosts' => $shortTopicPosts,
				'maxMessageResults' => $maxMessageResults,
				'search_index' => empty($modSettings['search_index']) ? '' : $modSettings['search_index'],
				'banned_words' => empty($modSettings['search_banned_words']) ? [] : explode(',', $modSettings['search_banned_words']),
			]);
			$context['topics'] = $this->_search->searchQuery(
				new SearchApiWrapper($search_config, $this->_search->getSearchParams())
			);
		}
		catch (\Exception $exception)
		{
			$context['search_errors'][$exception->getMessage()] = true;

			$this->action_search();
			return null;
		}

		// Did we find anything?
		if (!empty($context['topics']))
		{
			// Create an array for the permissions.
			$boards_can = boardsAllowedTo(['post_reply_own', 'post_reply_any', 'mark_any_notify'], true, false);

			// How's about some quick moderation?
			if (!empty($options['display_quick_mod']))
			{
				$boards_can = array_merge($boards_can, boardsAllowedTo(['lock_any', 'lock_own', 'make_sticky', 'move_any', 'move_own', 'remove_any', 'remove_own', 'merge_any'], true, false));

				$context['can_lock'] = in_array(0, $boards_can['lock_any']);
				$context['can_sticky'] = in_array(0, $boards_can['make_sticky']);
				$context['can_move'] = in_array(0, $boards_can['move_any']);
				$context['can_remove'] = in_array(0, $boards_can['remove_any']);
				$context['can_merge'] = in_array(0, $boards_can['merge_any']);
			}

			// What messages are we using?
			$msg_list = array_keys($context['topics']);
			$posters = $this->_search->loadPosters($msg_list, count($context['topics']));

			call_integration_hook('integrate_search_message_list', [&$msg_list, &$posters]);

			if (!empty($posters))
			{
				MembersList::load(array_unique($posters));
			}

			// Get the messages out for the callback - select enough that it can be made to look just like Display.
			$messages_request = $this->_search->loadMessagesRequest($msg_list, count($context['topics']));

			// If there are no results, that means the things in the cache got deleted, so pretend we have no topics anymore.
			if ($this->_search->noMessages($messages_request))
			{
				$context['topics'] = [];
			}

			$this->_prepareParticipants(!empty($modSettings['enableParticipation']), (int) $this->user->id);
		}

		// Now that we know how many results to expect, we can start calculating the page numbers.
		$start = $this->_req->getRequest('start', 'intval', 0);
		$context['page_index'] = constructPageIndex('{scripturl}?action=search;sa=results;' . $context['session_var'] . '=' . $context['session_id'] . ';params=' . $context['params'], $start, $this->_search->getNumResults(), $modSettings['search_results_per_page']);

		// Consider the search complete!
		Cache::instance()->remove('search_start:' . ($this->user->is_guest ? $this->user->ip : $this->user->id));

		$context['sub_template'] = 'results';
		$context['page_title'] = $txt['search_results'];

		$this->_icon_sources = new MessageTopicIcons(!empty($modSettings['messageIconChecks_enable']), $settings['theme_dir']);

		// Set the callback.  (do you REALIZE how much memory all the messages would take?!?)
		// This will be called from the template.
		if ($this->_search->isCompact())
		{
			$bodyParser = new Compact($this->_search->getSearchArray(), empty($modSettings['search_method']));
		}
		else
		{
			$bodyParser = new Normal($this->_search->getSearchArray(), empty($modSettings['search_method']));
		}

		$opt = new ValuesContainer([
			'icon_sources' => $this->_icon_sources,
			'show_signatures' => false,
			'boards_can' => $boards_can ?? [],
		]);
		$renderer = new SearchRenderer($messages_request, $this->user, $bodyParser, $opt);
		$renderer->setParticipants($this->_participants);

		$context['topic_starter_id'] = 0;
		$context['get_topics'] = [$renderer, 'getContext'];

		$context['jump_to'] = [
			'label' => addslashes(un_htmlspecialchars($txt['jump_to'])),
			'board_name' => addslashes(un_htmlspecialchars($txt['select_destination'])),
		];

		loadJavascriptFile('topic.js');
		$this->buildQuickModerationButtons();
	}