ElkArte\Search\API\Manticore

Complexity

Total Complexity

38

Size/Duplication

Total Lines	289
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	indexedWordQuery()	0	2	1
A	supportsExtended()	0	3	1
A	prepareIndexes()	0	9	3
A	__construct()	0	8	2
A	isValid()	0	5	2
B	buildQueryLimits()	0	27	7
F	searchQuery()	0	130	17
A	useWordIndex()	0	3	1
A	manticoreConnect()	0	25	4

<?php

/**
 * Used when the Manticore search daemon is running and Access
 *
 * @package   ElkArte Forum
 * @copyright ElkArte Forum contributors
 * @license   BSD http://opensource.org/licenses/BSD-3-Clause (see accompanying LICENSE.txt file)
 *
 * This file contains code covered by:
 * copyright: 2011 Simple Machines (http://www.simplemachines.org)
 *
 * @version 2.0 Beta 1
 *
 */

namespace ElkArte\Search\API;

use ElkArte\Cache\Cache;
use ElkArte\Database\AbstractResult;
use ElkArte\Errors\Errors;

The type ElkArte\Errors\Errors was not found. Maybe you did not declare it correctly or list all dependencies?

use ElkArte\User;
use Exception;
use mysqli;

/**
 * Manticore API,
 *
 * What it does:
 *
 * - Used when the Manticore search daemon is running
 * - Access is via Manticore's own implementation of MySQL network protocol
 * - Uses the Manticore search engine (https://manticoresearch.com/) which is a drop-in replacement for Sphinx
 *
 * @package Search
 */
class Manticore extends AbstractAPI
{
	/** @var string This is the last version of ElkArte that this was tested on, to protect against API changes. */
	public $version_compatible = 'ElkArte 2.0 dev';

	/** @var string This won't work with versions of ElkArte less than this. */
	public $min_elk_version = 'ElkArte 1.0 Beta 1';

	/** @var bool Is it supported?  */
	public $is_supported = true;

	/** @var array What words are banned? */
	protected $bannedWords = [];

	/** @var int What is the minimum word length? */
	protected $min_word_length = 4;

	/** @var array What databases are supported? */
	protected $supported_databases = ['MySQL'];

	/**
	 * Nothing to do ...
	 */
	public function __construct($config, $searchParams)
	{
		parent::__construct($config, $searchParams);

		// Is this database supported?
		if (!in_array($this->_db->title(), $this->supported_databases, true))
		{
			$this->is_supported = false;
		}
	}

	/**
	 * If the settings don't exist we can't continue.
	 */
	public function isValid(): bool
	{
		global $modSettings;

		return !empty($modSettings['manticore_searchd_server']) && !empty($modSettings['manticore_searchd_port']);
	}

	/**
	 * {@inheritDoc}
	 */
	public function indexedWordQuery(array $words, array $search_data)
	{
		// Manticore uses its internal engine
	}

	/**
	 * {@inheritDoc}
	 */
	public function supportsExtended(): bool
	{
		return true;
	}

	/**
	 * {@inheritDoc}
	 */
	public function prepareIndexes($word, &$wordsSearch, &$wordsExclude, $isExcluded, $excludedSubjectWords)
	{
		$subwords = text2words($word);

		$fulltextWord = count($subwords) === 1 ? $word : '"' . $word . '"';
		$wordsSearch['indexed_words'][] = $fulltextWord;
		if ($isExcluded !== false)
		{
			$wordsExclude[] = $fulltextWord;
		}
	}

	/**
	 * Wrapper for searchQuery of the SearchAPI
	 *
	 * @param string[] $search_words
	 * @param string[] $excluded_words
	 * @param bool[] $participants
	 *
	 * @return array
	 */
	public function searchQuery($search_words, $excluded_words, &$participants)

The parameter $excluded_words is not used and could be removed.

	{
		global $context, $modSettings;

		// Only request the results if they haven't been cached yet.
		$cached_results = [];
		$cache_key = 'manticore_results_' . md5(User::$info->query_see_board . '_' . $context['params']);

The property query_see_board does not exist on ElkArte\Helper\ValuesContainer. Since you implemented __get, consider adding a @property annotation.

		if (!Cache::instance()->getVar($cached_results, $cache_key))
		{
			// Connect to the manticore searchd and set a few options.
			$myManticore = $this->manticoreConnect();

			// Compile different options for our query
			$index = (empty($modSettings['manticore_index_prefix']) ? 'elkarte' : $modSettings['manticore_index_prefix']) . '_index';
			$query = 'SELECT *' . (empty($this->_searchParams->topic) ? ', COUNT(*) num' : '') . ', WEIGHT() relevance FROM ' . $index;

The property topic does not exist on ElkArte\Search\SearchParams. Since you implemented __get, consider adding a @property annotation.

			// Construct the (binary mode & |) query.
			$where_match = $search_words[0];

			// Nothing to search, return zero results
			if (trim($where_match) === '')
			{
				return [];
			}

			if ($this->_searchParams->subject_only)

The property subject_only does not exist on ElkArte\Search\SearchParams. Since you implemented __get, consider adding a @property annotation.

			{
				$where_match = '@subject ' . $where_match;
			}

			$query .= " WHERE MATCH('" . $where_match . "')";

			// Set the limits based on the search parameters, board, member, dates, etc
			$extra_where = $this->buildQueryLimits();
			if (!empty($extra_where))
			{
				$query .= ' AND ' . implode(' AND ', $extra_where);
			}

			// Put together a sort string; besides the main column sort (relevance, id_topic, or num_replies)
			$this->_searchParams->sort_dir = strtoupper($this->_searchParams->sort_dir);

It seems like $this->_searchParams->sort_dir can also be of type null; however, parameter $string of strtoupper() does only seem to accept string, maybe add an additional type check?

The property sort_dir does not exist on ElkArte\Search\SearchParams. Since you implemented __set, consider adding a @property annotation.

The property sort_dir does not exist on ElkArte\Search\SearchParams. Since you implemented __get, consider adding a @property annotation.

			$manticore_sort = $this->_searchParams->sort === 'id_msg' ? 'id_topic' : $this->_searchParams->sort;

The property sort does not exist on ElkArte\Search\SearchParams. Since you implemented __get, consider adding a @property annotation.

			// Add secondary sorting based on relevance(rank) value (if not the main sort method) and age
			$manticore_sort .= ' ' . $this->_searchParams->sort_dir . ($this->_searchParams->sort === 'relevance' ? '' : ', relevance DESC') . ', poster_time DESC';

			// Grouping by topic id makes it return only one result per topic, so don't set that for in-topic searches
			if (empty($this->_searchParams->topic))
			{
				// In the topic group, use the most weighty result for display purposes
				$query .= ' GROUP BY id_topic WITHIN GROUP ORDER BY relevance DESC';
			}

			$query .= ' ORDER BY ' . $manticore_sort;
			$query .= ' LIMIT ' . min(500, $modSettings['manticore_max_results']);

			// Set any options needed, like field weights.
			// ranker is a modification of SPH_RANK_SPH04 sum((4*lcs+2*(min_hit_pos==1)+exact_hit)*user_weight)*1000+bm25
			// Each term will return a 0-1000 range we include our acprel value for the final total and order.  Position
			// is the relative reply # to a post, so the later a reply in a topic the less overall weight it is given
			// the calculated value of ranker is returned in WEIGHTS() which we name relevance in the query
			$subject_weight = empty($modSettings['search_weight_subject']) ? 30 : $modSettings['search_weight_subject'];
			$query .= '
			OPTION 
				field_weights=(subject=' . $subject_weight . ', body=' . (100 - $subject_weight) . '),
				ranker=expr(\'sum((4*lcs+2*(min_hit_pos==1)+word_count)*user_weight*position) + acprel + bm25 \'),
				idf=plain,
				boolean_simplify=1,
				max_matches=' . min(500, $modSettings['manticore_max_results']);

			// Execute the search query.
			$request = mysqli_query($myManticore, $query);

			// Bad query, lets log the error and act like it's not our fault
			if ($request === false)
			{
				// Just log the error.
				if (mysqli_error($myManticore) !== '')
				{
					Errors::instance()->log_error(mysqli_error($myManticore));
				}

				Errors::instance()->fatal_lang_error('error_invalid_search_daemon');
			}

			// Get the relevant information from the search results.
			$cached_results = [
				'num_results' => 0,
				'matches' => [],
			];

			if (mysqli_num_rows($request) !== 0)

It seems like $request can also be of type true; however, parameter $result of mysqli_num_rows() does only seem to accept mysqli_result, maybe add an additional type check?

			{
				while ($match = mysqli_fetch_assoc($request))

It seems like $request can also be of type true; however, parameter $result of mysqli_fetch_assoc() does only seem to accept mysqli_result, maybe add an additional type check?

				{
					$num = 0;
					if (empty($this->_searchParams->topic))
					{
						$num = $match['num'] ?? ($match['@count'] ?? 0);
					}

					$cached_results['matches'][$match['id']] = [
						'id' => $match['id_topic'],
						'num_matches' => $num,
						'matches' => [],
						'relevance' => round($match['relevance']),
					];
				}
			}

			mysqli_free_result($request);

It seems like $request can also be of type true; however, parameter $result of mysqli_free_result() does only seem to accept mysqli_result, maybe add an additional type check?

			mysqli_close($myManticore);

			$cached_results['num_results'] = count($cached_results['matches']);

			// Store the search results in the cache.
			Cache::instance()->put($cache_key, $cached_results, 600);
		}

		$participants = [];
		$topics = [];
		foreach (array_slice(array_keys($cached_results['matches']), $this->_req->getRequest('start', 'intval', 0), $modSettings['search_results_per_page']) as $msgID)
		{
			$topics[$msgID] = $cached_results['matches'][$msgID];
			$participants[$cached_results['matches'][$msgID]['id']] = false;
		}

		$this->_num_results = $cached_results['num_results'];

		return $topics;
	}

	/**
	 * Connect to the Manticore server, on failure log error and exit
	 *
	 * @return mysqli
	 * @throws \ElkArte\Exceptions\Exception
	 */
	private function manticoreConnect()
	{
		global $modSettings;

		set_error_handler(static function () { /* ignore errors */ });
		try
		{
			$myManticore = mysqli_connect(($modSettings['manticore_searchd_server'] === 'localhost' ? '127.0.0.1' : $modSettings['manticore_searchd_server']), '', '', '', (int) $modSettings['manticore_searchd_port']);

The call to mysqli_connect() has too few arguments starting with socket.

		}
		catch (Exception)
		{
			$myManticore = false;
		}
		finally
		{
			restore_error_handler();
		}

		// No connection, daemon not running? log the error and exit
		if ($myManticore === false)
		{
			Errors::instance()->fatal_lang_error('error_no_search_daemon');
		}

		return $myManticore;

The expression return $myManticore could also return false which is incompatible with the documented return type mysqli. Did you maybe forget to handle an error condition?

	}

	/**
	 * {@inheritDoc}
	 */
	public function useWordIndex()
	{
		return false;
	}

	/**
	 * Builds the query modifiers based on age, member, board etc
	 *
	 * @return array
	 */
	public function buildQueryLimits(): array
	{
		global $modSettings;

		$extra_where = [];

		if (!empty($this->_searchParams->_minMsgID) || !empty($this->_searchParams->_maxMsgID))
		{
			$extra_where[] = 'id BETWEEN ' . $this->_searchParams->_minMsgID . ' AND ' . (empty($this->_searchParams->_maxMsgID) ? (int) $modSettings['maxMsgID'] : $this->_searchParams->_maxMsgID);
		}

		if (!empty($this->_searchParams->topic))

The property topic does not exist on ElkArte\Search\SearchParams. Since you implemented __get, consider adding a @property annotation.

		{
			$extra_where[] = 'id_topic = ' . (int) $this->_searchParams->topic;
		}

		if (!empty($this->_searchParams->brd))

The property brd does not exist on ElkArte\Search\SearchParams. Since you implemented __get, consider adding a @property annotation.

		{
			$extra_where[] = 'id_board IN (' . implode(',', $this->_searchParams->brd) . ')';
		}

		if (!empty($this->_searchParams->_memberlist))
		{
			$extra_where[] = 'id_member IN (' . implode(',', $this->_searchParams->_memberlist) . ')';
		}

		return $extra_where;
	}
}