ElkArte\PersonalMessage\Search::action_search2()

Complexity

Conditions	49
Paths	> 20000

Size

Total Lines	316
Code Lines	144

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

<?php
	public function action_search2(): ?bool
	{
		global $scripturl, $modSettings, $context, $txt;

		$context['display_mode'] = PmHelper::getDisplayMode();

		// Make sure the server is able to do this right now
		if (!empty($modSettings['loadavg_search']) && $modSettings['current_load'] >= $modSettings['loadavg_search'])
		{
			throw new Exception('loadavg_search_disabled', false);
		}

		// Some useful general permissions.
		$context['can_send_pm'] = allowedTo('pm_send');

		// Extract all the search parameters if coming in from pagination, etc.
		$this->_searchParamsFromString();

		// Set a start for pagination
		$context['start'] = $this->_req->getQuery('start', 'intval', 0);

		// Set/clean search criteria
		$this->_prepareSearchParams();

		$context['folder'] = empty($this->_search_params['sent_only']) ? 'inbox' : 'sent';

		// Searching for specific members
		$userQuery = $this->_setUserQuery();

		// Set up the sorting variables...
		$this->_setSortParams();

		// Sort out any labels we may be searching for.
		$labelQuery = $this->_setLabelQuery();

		// Unfortunately, searching for words like this is going to be slow, so we're blocking them.
		$blocklist_words = ['quote', 'the', 'is', 'it', 'are', 'if', 'in'];

		// What are we actually searching for?
		if (empty($this->_search_params['search']))
		{
			$this->_search_params['search'] = $this->_req->getPost('search', 'trim|strval', '');
		}

		// If nothing is left to search on - we set an error!
		if (!isset($this->_search_params['search']) || $this->_search_params['search'] === '')
		{
			$context['search_errors']['invalid_search_string'] = true;
		}

		// Change non-word characters into spaces.
		$stripped_query = preg_replace('~(?:[\x0B\0\x{A0}\t\r\s\n(){}\\[\\]<>!@$%^*.,:+=`\~\?/\\\\]+|&(?:amp|lt|gt|quot);)+~u', ' ', $this->_search_params['search']);

		// Make the query lower case since it will case-insensitive anyway.
		$stripped_query = un_htmlspecialchars(Util::strtolower($stripped_query));

		// Extract phrase parts first (e.g., some words "this is a phrase" some more words.)
		preg_match_all('/(?:^|\s)([-]?)"([^"]+)"(?:$|\s)/', $stripped_query, $matches, PREG_PATTERN_ORDER);
		$phraseArray = $matches[2];

		// Remove the phrase parts and extract the words.
		$wordArray = preg_replace('~(?:^|\s)(?:[-]?)"(?:[^"]+)"(?:$|\s)~u', ' ', $this->_search_params['search']);
		$wordArray = explode(' ', Util::htmlspecialchars(un_htmlspecialchars($wordArray), ENT_QUOTES));

		// A minus sign in front of a word excludes the word.... so...
		$excludedWords = [];

		// Check for things like -"some words", but not "-some words".
		foreach ($matches[1] as $index => $word)
		{
			if ($word === '-')
			{
				if (($word = trim($phraseArray[$index], "-_' ")) !== '' && !in_array($word, $blocklist_words))
				{
					$excludedWords[] = $word;
				}

				unset($phraseArray[$index]);
			}
		}

		// Now we look for -test, etc.
		foreach ($wordArray as $index => $word)
		{
			if (str_starts_with(trim($word), '-'))
			{
				if (($word = trim($word, "-_' ")) !== '' && !in_array($word, $blocklist_words))
				{
					$excludedWords[] = $word;
				}

				unset($wordArray[$index]);
			}
		}

		// The remaining words and phrases are all included.
		$searchArray = array_merge($phraseArray, $wordArray);

		// Trim everything and make sure there are no words that are the same.
		foreach ($searchArray as $index => $value)
		{
			// Skip anything that's close to empty.
			if (($searchArray[$index] = trim($value, "-_' ")) === '')
			{
				unset($searchArray[$index]);
			}
			// Skip blocked words. Make sure to note we skipped them as well
			elseif (in_array($searchArray[$index], $blocklist_words))
			{
				$foundBlockListedWords = true;
				unset($searchArray[$index]);

			}

			if (isset($searchArray[$index]))
			{
				$searchArray[$index] = Util::strtolower(trim($value));

				if ($searchArray[$index] === '')
				{
					unset($searchArray[$index]);
				}
				else
				{
					// Sort out entities first.
					$searchArray[$index] = Util::htmlspecialchars($searchArray[$index]);
				}
			}
		}

		$searchArray = array_slice(array_unique($searchArray), 0, 10);

		// This contains *everything*
		$searchWords = array_merge($searchArray, $excludedWords);

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

		// Sort out the search query so the user can edit it - if they want.
		$context['search_params'] = $this->_search_params;
		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']);
		}

		// Now we have all the parameters, combine them together for pagination and the like...
		$context['params'] = $this->_compileURLparams();

		// Compile the subject query part.
		$andQueryParts = [];
		foreach ($searchWords as $index => $word)
		{
			if ($word === '')
			{
				continue;
			}

			if ($this->_search_params['subject_only'])
			{
				$andQueryParts[] = 'pm.subject' . (in_array($word, $excludedWords) ? ' NOT' : '') . ' LIKE {string:search_' . $index . '}';
			}
			else
			{
				$andQueryParts[] = '(pm.subject' . (in_array($word, $excludedWords) ? ' NOT' : '') . ' LIKE {string:search_' . $index . '} ' . (in_array($word, $excludedWords) ? 'AND pm.body NOT' : 'OR pm.body') . ' LIKE {string:search_' . $index . '})';
			}

			$this->_searchq_parameters ['search_' . $index] = '%' . strtr($word, ['_' => '\\_', '%' => '\\%']) . '%';
		}

		$searchQuery = ' 1=1';
		if (!empty($andQueryParts))
		{
			$searchQuery = implode(!empty($this->_search_params['searchtype']) && $this->_search_params['searchtype'] == 2 ? ' OR ' : ' AND ', $andQueryParts);
		}

		// Age limits?
		$timeQuery = '';
		if (!empty($this->_search_params['minage']))
		{
			$timeQuery .= ' AND pm.msgtime < ' . (time() - $this->_search_params['minage'] * 86400);
		}

		if (!empty($this->_search_params['maxage']))
		{
			$timeQuery .= ' AND pm.msgtime > ' . (time() - $this->_search_params['maxage'] * 86400);
		}

		// If we have errors - return back to the first screen...
		if (!empty($context['search_errors']))
		{
			$this->_req->post->params = $context['params'];

			$this->action_search();

			return false;
		}

		// Get the number of results.
		$numResults = numPMSeachResults($userQuery, $labelQuery, $timeQuery, $searchQuery, $this->_searchq_parameters);

		// Get all the matching message ids, senders and head pm nodes
		[$foundMessages, $posters, $head_pms] = loadPMSearchMessages($userQuery, $labelQuery, $timeQuery, $searchQuery, $this->_searchq_parameters, $this->_search_params);

		// Find the real head pm when in the conversation view
		if ($context['display_mode'] === PmHelper::DISPLAY_AS_CONVERSATION && !empty($head_pms))
		{
			$real_pm_ids = loadPMSearchHeads($head_pms);
		}

		// Load the found user data
		$posters = array_unique($posters);
		if (!empty($posters))
		{
			MembersList::load($posters);
		}

		// Sort out the page index.
		$context['page_index'] = constructPageIndex('{scripturl}?action=pm;sa=search2;params=' . $context['params'], $context['start'], $numResults, $modSettings['search_results_per_page']);

		$context['message_labels'] = [];
		$context['message_replied'] = [];
		$context['personal_messages'] = [];
		$context['first_label'] = [];

		// If we have results, we have work to do!
		if (!empty($foundMessages))
		{
			$recipients = [];
			[$context['message_labels'], $context['message_replied'], $context['message_unread'], $context['first_label']] = loadPMRecipientInfo($foundMessages, $recipients, $context['folder'], true);

			// Prepare for the callback!
			$search_results = loadPMSearchResults($foundMessages, $this->_search_params);
			$counter = 0;
			$bbc_parser = ParserWrapper::instance();
			foreach ($search_results as $row)
			{
				// If there's no subject, use the default.
				$row['subject'] = $row['subject'] === '' ? $txt['no_subject'] : $row['subject'];

				// Load this poster context info, if not there, then fill in the essentials...
				$member = MembersList::get($row['id_member_from']);
				$member->loadContext();
				if ($member->isEmpty())
				{
					$member['name'] = $row['from_name'];
					$member['id'] = 0;
					$member['group'] = $txt['guest_title'];
					$member['link'] = $row['from_name'];
					$member['email'] = '';
					$member['show_email'] = showEmailAddress(0);
					$member['is_guest'] = true;
				}

				// Censor anything we don't want to see...
				$row['body'] = censor($row['body']);
				$row['subject'] = censor($row['subject']);

				// Parse out any BBC...
				$row['body'] = $bbc_parser->parsePM($row['body']);

				// Highlight the hits
				$body_highlighted = '';
				$subject_highlighted = '';
				foreach ($searchArray as $query)
				{
					// Fix the international characters in the keyword too.
					$query = un_htmlspecialchars($query);
					$query = trim($query, '\*+');
					$query = strtr(Util::htmlspecialchars($query), ['\\\'' => "'"]);

					$body_highlighted = preg_replace_callback('/((<[^>]*)|' . preg_quote(strtr($query, ["'" => '&#039;']), '/') . ')/iu',
						fn($matches) => $this->_highlighted_callback($matches), $row['body']);
					$subject_highlighted = preg_replace('/(' . preg_quote($query, '/') . ')/iu', '<strong class="highlight">$1</strong>', $row['subject']);
				}

				// Set a link using the first label information
				$href = $scripturl . '?action=pm;f=' . $context['folder'] . (isset($context['first_label'][$row['id_pm']]) ? ';l=' . $context['first_label'][$row['id_pm']] : '') . ';pmid=' . ($context['display_mode'] === PmHelper::DISPLAY_AS_CONVERSATION && isset($real_pm_ids[$head_pms[$row['id_pm']]]) && $context['folder'] === 'inbox' ? $real_pm_ids[$head_pms[$row['id_pm']]] : $row['id_pm']) . '#msg_' . $row['id_pm'];

				$context['personal_messages'][] = [
					'id' => $row['id_pm'],
					'member' => $member,
					'subject' => $subject_highlighted,
					'body' => $body_highlighted,
					'time' => standardTime($row['msgtime']),
					'html_time' => htmlTime($row['msgtime']),
					'timestamp' => forum_time(true, $row['msgtime']),
					'recipients' => &$recipients[$row['id_pm']],
					'labels' => &$context['message_labels'][$row['id_pm']],
					'fully_labeled' => (empty($context['message_labels'][$row['id_pm']]) ? 0 : count($context['message_labels'][$row['id_pm']])) === count($context['labels']),
					'is_replied_to' => &$context['message_replied'][$row['id_pm']],
					'href' => $href,
					'link' => '<a href="' . $href . '">' . $subject_highlighted . '</a>',
					'counter' => ++$counter,
					'pmbuttons' => $this->_setSearchPmButtons($row['id_pm'], $member),
				];
			}
		}

		// Finish off the context.
		$context['page_title'] = $txt['pm_search_title'];
		$context['sub_template'] = 'search_results';
		$context['menu_data_' . $context['pm_menu_id']]['current_area'] = 'search';
		$context['breadcrumbs'][] = [
			'url' => getUrl('action', ['action' => 'pm', 'sa' => 'search']),
			'name' => $txt['pm_search_bar_title'],
		];

		return true;
	}