.oO SearXNG Developer Documentation Oo.
Loading...
Searching...
No Matches
__init__.py
Go to the documentation of this file.
1# SPDX-License-Identifier: AGPL-3.0-or-later
2# pylint: disable=missing-module-docstring, too-few-public-methods
3
4__all__ = ["SearchWithPlugins"]
5
6import typing as t
7
8import threading
9from timeit import default_timer
10from uuid import uuid4
11
12from flask import copy_current_request_context
13
14from searx import logger
15from searx import settings
16import searx.answerers
17import searx.plugins
18from searx.engines import load_engines
19from searx.external_bang import get_bang_url
20from searx.metrics import initialize as initialize_metrics, counter_inc
21from searx.network import initialize as initialize_network, check_network_configuration
22from searx.results import ResultContainer
23from searx.search.checker import initialize as initialize_checker
24from searx.search.processors import PROCESSORS
25
26
27if t.TYPE_CHECKING:
28 from .models import SearchQuery
29 from searx.extended_types import SXNG_Request
30
31logger = logger.getChild('search')
32
33
35 settings_engines: list[dict[str, t.Any]] = None, # pyright: ignore[reportArgumentType]
36 enable_checker: bool = False,
37 check_network: bool = False,
38 enable_metrics: bool = True,
39):
40 settings_engines = settings_engines or settings['engines']
41 load_engines(settings_engines)
42 initialize_network(settings_engines, settings['outgoing'])
43 if check_network:
44 check_network_configuration()
45 initialize_metrics([engine['name'] for engine in settings_engines], enable_metrics)
46 PROCESSORS.init(settings_engines)
47 if enable_checker:
48 initialize_checker()
49
50
51class Search:
52 """Search information container"""
53
54 def __init__(self, search_query: "SearchQuery"):
55 """Initialize the Search"""
56 # init vars
57 super().__init__()
58 self.search_query: "SearchQuery" = search_query
59 self.result_container: ResultContainer = ResultContainer()
60 self.start_time: float | None = None
61 self.actual_timeout: float | None = None
62
63 def search_external_bang(self) -> bool:
64 """Check if there is a external bang. If yes, update
65 self.result_container and return True."""
66 if self.search_query.external_bang:
67 self.result_container.redirect_url = get_bang_url(self.search_query)
68
69 # This means there was a valid bang and the rest of the search does
70 # not need to be continued
71 if isinstance(self.result_container.redirect_url, str):
72 return True
73 return False
74
75 def search_answerers(self):
76
77 results = searx.answerers.STORAGE.ask(self.search_query.query)
78 self.result_container.extend(None, results) # pyright: ignore[reportArgumentType]
79 return bool(results)
80
81 # do search-request
82 def _get_requests(self) -> tuple[list[tuple[str, str, dict[str, t.Any]]], int]:
83 # init vars
84 requests: list[tuple[str, str, dict[str, t.Any]]] = []
85
86 # max of all selected engine timeout
87 default_timeout = 0
88
89 # start search-request for all selected engines
90 for engineref in self.search_query.engineref_list:
91 processor = PROCESSORS[engineref.name]
92
93 # stop the request now if the engine is suspend
94 if processor.extend_container_if_suspended(self.result_container):
95 continue
96
97 # set default request parameters
98 request_params = processor.get_params(self.search_query, engineref.category)
99 if request_params is None:
100 continue
101
102 counter_inc('engine', engineref.name, 'search', 'count', 'sent')
103
104 # append request to list
105 requests.append((engineref.name, self.search_query.query, request_params))
106
107 # update default_timeout
108 default_timeout = max(default_timeout, processor.engine.timeout)
109
110 # adjust timeout
111 max_request_timeout = settings['outgoing']['max_request_timeout']
112 actual_timeout = default_timeout
113 query_timeout = self.search_query.timeout_limit
114
115 if max_request_timeout is None and query_timeout is None:
116 # No max, no user query: default_timeout
117 pass
118 elif max_request_timeout is None and query_timeout is not None:
119 # No max, but user query: From user query except if above default
120 actual_timeout = min(default_timeout, query_timeout)
121 elif max_request_timeout is not None and query_timeout is None:
122 # Max, no user query: Default except if above max
123 actual_timeout = min(default_timeout, max_request_timeout)
124 elif max_request_timeout is not None and query_timeout is not None:
125 # Max & user query: From user query except if above max
126 actual_timeout = min(query_timeout, max_request_timeout)
127
128 logger.debug(
129 "actual_timeout={0} (default_timeout={1}, ?timeout_limit={2}, max_request_timeout={3})".format(
130 actual_timeout, default_timeout, query_timeout, max_request_timeout
131 )
132 )
133
134 return requests, actual_timeout
135
136 def search_multiple_requests(self, requests: list[tuple[str, str, dict[str, t.Any]]]):
137 # pylint: disable=protected-access
138 search_id = str(uuid4())
139
140 for engine_name, query, request_params in requests:
141 _search = copy_current_request_context(PROCESSORS[engine_name].search)
142 th = threading.Thread( # pylint: disable=invalid-name
143 target=_search,
144 args=(query, request_params, self.result_container, self.start_time, self.actual_timeout),
145 name=search_id,
146 )
147 th._timeout = False
148 th._engine_name = engine_name
149 th.start()
150
151 for th in threading.enumerate(): # pylint: disable=invalid-name
152 if th.name == search_id:
153 remaining_time = max(0.0, self.actual_timeout - (default_timer() - self.start_time))
154 th.join(remaining_time)
155 if th.is_alive():
156 th._timeout = True
157 self.result_container.add_unresponsive_engine(th._engine_name, 'timeout')
158 PROCESSORS[th._engine_name].logger.error('engine timeout')
159
160 def search_standard(self):
161 """
162 Update self.result_container, self.actual_timeout
163 """
164 requests, self.actual_timeout = self._get_requests()
165
166 # send all search-request
167 if requests:
168 self.search_multiple_requests(requests)
169
170 # return results, suggestions, answers and infoboxes
171 return True
172
173 # do search-request
174 def search(self) -> ResultContainer:
175 self.start_time = default_timer()
176 if not self.search_external_bang():
177 if not self.search_answerers():
178 self.search_standard()
179 return self.result_container
180
181
182class SearchWithPlugins(Search):
183 """Inherit from the Search class, add calls to the plugins."""
184
185 def __init__(self, search_query: "SearchQuery", request: "SXNG_Request", user_plugins: list[str]):
186 super().__init__(search_query)
187 self.user_plugins = user_plugins
188 self.result_container.on_result = self._on_result
189 # pylint: disable=line-too-long
190 # get the "real" request to use it outside the Flask context.
191 # see
192 # * https://github.com/pallets/flask/blob/d01d26e5210e3ee4cbbdef12f05c886e08e92852/src/flask/globals.py#L55
193 # * https://github.com/pallets/werkzeug/blob/3c5d3c9bd0d9ce64590f0af8997a38f3823b368d/src/werkzeug/local.py#L548-L559
194 # * https://werkzeug.palletsprojects.com/en/2.0.x/local/#werkzeug.local.LocalProxy._get_current_object
195 # pylint: enable=line-too-long
196 self.request = request._get_current_object()
197
198 def _on_result(self, result):
199 return searx.plugins.STORAGE.on_result(self.request, self, result)
200
201 def search(self) -> ResultContainer:
202
203 if searx.plugins.STORAGE.pre_search(self.request, self):
204 super().search()
205
206 searx.plugins.STORAGE.post_search(self.request, self)
207 self.result_container.close()
208
209 return self.result_container
::1337x
Definition 1337x.py:1
initialize(list[dict[str, t.Any]] settings_engines=None, bool enable_checker=False, bool check_network=False, bool enable_metrics=True)
Definition __init__.py:39