__init__.py

Go to the documentation of this file.

# SPDX-License-Identifier: AGPL-3.0-or-later
# pylint: disable=missing-module-docstring, too-few-public-methods
 
# the public namespace has not yet been finally defined ..
# __all__ = [..., ]
 
import typing as t
 
import threading
from timeit import default_timer
from uuid import uuid4
 
from flask import copy_current_request_context
 
from searx import logger
from searx import settings
import searx.answerers
import searx.plugins
from searx.engines import load_engines
from searx.external_bang import get_bang_url
from searx.metrics import initialize as initialize_metrics, counter_inc
from searx.network import initialize as initialize_network, check_network_configuration
from searx.results import ResultContainer
from searx.search.checker import initialize as initialize_checker
from searx.search.processors import PROCESSORS, initialize as initialize_processors
 
 
if t.TYPE_CHECKING:
    from .models import SearchQuery
    from searx.extended_types import SXNG_Request
 
logger = logger.getChild('search')
 
 
def initialize(
    settings_engines: list[dict[str, t.Any]] = None,  # pyright: ignore[reportArgumentType]
    enable_checker: bool = False,
    check_network: bool = False,
    enable_metrics: bool = True,
):
    settings_engines = settings_engines or settings['engines']
    load_engines(settings_engines)
    initialize_network(settings_engines, settings['outgoing'])
    if check_network:
        check_network_configuration()
    initialize_metrics([engine['name'] for engine in settings_engines], enable_metrics)
    initialize_processors(settings_engines)
    if enable_checker:
        initialize_checker()
 
 
class Search:
    """Search information container"""
 
    __slots__ = "search_query", "result_container", "start_time", "actual_timeout"  # type: ignore
 
    def __init__(self, search_query: "SearchQuery"):
        """Initialize the Search"""
        # init vars
        super().__init__()
        self.search_query: "SearchQuery" = search_query
        self.result_container: ResultContainer = ResultContainer()
        self.start_time: float | None = None
        self.actual_timeout: float | None = None
 
    def search_external_bang(self) -> bool:
        """Check if there is a external bang.  If yes, update
        self.result_container and return True."""
        if self.search_query.external_bang:
            self.result_container.redirect_url = get_bang_url(self.search_query)
 
            # This means there was a valid bang and the rest of the search does
            # not need to be continued
            if isinstance(self.result_container.redirect_url, str):
                return True
        return False
 
    def search_answerers(self):
 
        results = searx.answerers.STORAGE.ask(self.search_query.query)
        self.result_container.extend(None, results)  # pyright: ignore[reportArgumentType]
        return bool(results)
 
    # do search-request
    def _get_requests(self) -> tuple[list[tuple[str, str, dict[str, t.Any]]], int]:
        # init vars
        requests: list[tuple[str, str, dict[str, t.Any]]] = []
 
        # max of all selected engine timeout
        default_timeout = 0
 
        # start search-request for all selected engines
        for engineref in self.search_query.engineref_list:
            processor = PROCESSORS[engineref.name]
 
            # stop the request now if the engine is suspend
            if processor.extend_container_if_suspended(self.result_container):
                continue
 
            # set default request parameters
            request_params = processor.get_params(self.search_query, engineref.category)
            if request_params is None:
                continue
 
            counter_inc('engine', engineref.name, 'search', 'count', 'sent')
 
            # append request to list
            requests.append((engineref.name, self.search_query.query, request_params))
 
            # update default_timeout
            default_timeout = max(default_timeout, processor.engine.timeout)
 
        # adjust timeout
        max_request_timeout = settings['outgoing']['max_request_timeout']
        actual_timeout = default_timeout
        query_timeout = self.search_query.timeout_limit
 
        if max_request_timeout is None and query_timeout is None:
            # No max, no user query: default_timeout
            pass
        elif max_request_timeout is None and query_timeout is not None:
            # No max, but user query: From user query except if above default
            actual_timeout = min(default_timeout, query_timeout)
        elif max_request_timeout is not None and query_timeout is None:
            # Max, no user query: Default except if above max
            actual_timeout = min(default_timeout, max_request_timeout)
        elif max_request_timeout is not None and query_timeout is not None:
            # Max & user query: From user query except if above max
            actual_timeout = min(query_timeout, max_request_timeout)
 
        logger.debug(
            "actual_timeout={0} (default_timeout={1}, ?timeout_limit={2}, max_request_timeout={3})".format(
                actual_timeout, default_timeout, query_timeout, max_request_timeout
            )
        )
 
        return requests, actual_timeout
 
    def search_multiple_requests(self, requests: list[tuple[str, str, dict[str, t.Any]]]):
        # pylint: disable=protected-access
        search_id = str(uuid4())
 
        for engine_name, query, request_params in requests:
            _search = copy_current_request_context(PROCESSORS[engine_name].search)
            th = threading.Thread(  # pylint: disable=invalid-name
                target=_search,
                args=(query, request_params, self.result_container, self.start_time, self.actual_timeout),
                name=search_id,
            )
            th._timeout = False
            th._engine_name = engine_name
            th.start()
 
        for th in threading.enumerate():  # pylint: disable=invalid-name
            if th.name == search_id:
                remaining_time = max(0.0, self.actual_timeout - (default_timer() - self.start_time))
                th.join(remaining_time)
                if th.is_alive():
                    th._timeout = True
                    self.result_container.add_unresponsive_engine(th._engine_name, 'timeout')
                    PROCESSORS[th._engine_name].logger.error('engine timeout')
 
    def search_standard(self):
        """
        Update self.result_container, self.actual_timeout
        """
        requests, self.actual_timeout = self._get_requests()
 
        # send all search-request
        if requests:
            self.search_multiple_requests(requests)
 
        # return results, suggestions, answers and infoboxes
        return True
 
    # do search-request
    def search(self) -> ResultContainer:
        self.start_time = default_timer()
        if not self.search_external_bang():
            if not self.search_answerers():
                self.search_standard()
        return self.result_container
 
 
class SearchWithPlugins(Search):
    """Inherit from the Search class, add calls to the plugins."""
 
    __slots__ = 'user_plugins', 'request'
 
    def __init__(self, search_query: "SearchQuery", request: "SXNG_Request", user_plugins: list[str]):
        super().__init__(search_query)
        self.user_plugins = user_plugins
        self.result_container.on_result = self._on_result
        # pylint: disable=line-too-long
        # get the "real" request to use it outside the Flask context.
        # see
        # * https://github.com/pallets/flask/blob/d01d26e5210e3ee4cbbdef12f05c886e08e92852/src/flask/globals.py#L55
        # * https://github.com/pallets/werkzeug/blob/3c5d3c9bd0d9ce64590f0af8997a38f3823b368d/src/werkzeug/local.py#L548-L559
        # * https://werkzeug.palletsprojects.com/en/2.0.x/local/#werkzeug.local.LocalProxy._get_current_object
        # pylint: enable=line-too-long
        self.request = request._get_current_object()
 
    def _on_result(self, result):
        return searx.plugins.STORAGE.on_result(self.request, self, result)
 
    def search(self) -> ResultContainer:
 
        if searx.plugins.STORAGE.pre_search(self.request, self):
            super().search()
 
        searx.plugins.STORAGE.post_search(self.request, self)
        self.result_container.close()
 
        return self.result_container