mirror of
https://github.com/searxng/searxng
synced 2024-11-09 01:10:26 +00:00
6e5f22e558
Implementations of the *traits* of the engines.
Engine's traits are fetched from the origin engine and stored in a JSON file in
the *data folder*. Most often traits are languages and region codes and their
mapping from SearXNG's representation to the representation in the origin search
engine.
To load traits from the persistence::
searx.enginelib.traits.EngineTraitsMap.from_data()
For new traits new properties can be added to the class::
searx.enginelib.traits.EngineTraits
.. hint::
Implementation is downward compatible to the deprecated *supported_languages
method* from the vintage implementation.
The vintage code is tagged as *deprecated* an can be removed when all engines
has been ported to the *traits method*.
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
84 lines
2.3 KiB
Python
84 lines
2.3 KiB
Python
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
# lint: pylint
|
|
|
|
"""Implement request processores used by engine-types.
|
|
|
|
"""
|
|
|
|
__all__ = [
|
|
'EngineProcessor',
|
|
'OfflineProcessor',
|
|
'OnlineProcessor',
|
|
'OnlineDictionaryProcessor',
|
|
'OnlineCurrencyProcessor',
|
|
'OnlineUrlSearchProcessor',
|
|
'PROCESSORS',
|
|
]
|
|
|
|
import threading
|
|
from typing import Dict
|
|
|
|
from searx import logger
|
|
from searx import engines
|
|
|
|
from .online import OnlineProcessor
|
|
from .offline import OfflineProcessor
|
|
from .online_dictionary import OnlineDictionaryProcessor
|
|
from .online_currency import OnlineCurrencyProcessor
|
|
from .online_url_search import OnlineUrlSearchProcessor
|
|
from .abstract import EngineProcessor
|
|
|
|
logger = logger.getChild('search.processors')
|
|
PROCESSORS: Dict[str, EngineProcessor] = {}
|
|
"""Cache request processores, stored by *engine-name* (:py:func:`initialize`)
|
|
|
|
:meta hide-value:
|
|
"""
|
|
|
|
|
|
def get_processor_class(engine_type):
|
|
"""Return processor class according to the ``engine_type``"""
|
|
for c in [
|
|
OnlineProcessor,
|
|
OfflineProcessor,
|
|
OnlineDictionaryProcessor,
|
|
OnlineCurrencyProcessor,
|
|
OnlineUrlSearchProcessor,
|
|
]:
|
|
if c.engine_type == engine_type:
|
|
return c
|
|
return None
|
|
|
|
|
|
def get_processor(engine, engine_name):
|
|
"""Return processor instance that fits to ``engine.engine.type``)"""
|
|
engine_type = getattr(engine, 'engine_type', 'online')
|
|
processor_class = get_processor_class(engine_type)
|
|
if processor_class:
|
|
return processor_class(engine, engine_name)
|
|
return None
|
|
|
|
|
|
def initialize_processor(processor):
|
|
"""Initialize one processor
|
|
|
|
Call the init function of the engine
|
|
"""
|
|
if processor.has_initialize_function:
|
|
t = threading.Thread(target=processor.initialize, daemon=True)
|
|
t.start()
|
|
|
|
|
|
def initialize(engine_list):
|
|
"""Initialize all engines and store a processor for each engine in :py:obj:`PROCESSORS`."""
|
|
for engine_data in engine_list:
|
|
engine_name = engine_data['name']
|
|
engine = engines.engines.get(engine_name)
|
|
if engine:
|
|
processor = get_processor(engine, engine_name)
|
|
initialize_processor(processor)
|
|
if processor is None:
|
|
engine.logger.error('Error get processor for engine %s', engine_name)
|
|
else:
|
|
PROCESSORS[engine_name] = processor
|