searxng/searx/engines/mojeek.py

# SPDX-License-Identifier: AGPL-3.0-or-later
"""Mojeek (general, images, news)"""

from datetime import datetime
from urllib.parse import urlencode

from dateutil.relativedelta import relativedelta
from lxml import html

from searx.enginelib.traits import EngineTraits
from searx.utils import eval_xpath, eval_xpath_list, extract_text

about = {
    "website": "https://mojeek.com",
    "wikidata_id": "Q60747299",
    "official_api_documentation": "https://www.mojeek.com/support/api/search/request_parameters.html",
    "use_official_api": False,
    "require_api_key": False,
    "results": "HTML",
}
paging = True  # paging is only supported for general search
safesearch = True
time_range_support = True  # time range search is supported for general and news
max_page = 10

base_url = "https://www.mojeek.com"

categories = ["general", "web"]
search_type = ""  # leave blank for general, other possible values: images, news

results_xpath = '//ul[@class="results-standard"]/li/a[@class="ob"]'
url_xpath = "./@href"
title_xpath = "../h2/a"
content_xpath = '..//p[@class="s"]'
suggestion_xpath = '//div[@class="top-info"]/p[@class="top-info spell"]/em/a'

image_results_xpath = '//div[@id="results"]/div[contains(@class, "image")]'
image_url_xpath = "./a/@href"
image_title_xpath = "./a/@data-title"
image_img_src_xpath = "./a/img/@src"

news_results_xpath = '//section[contains(@class, "news-search-result")]//article'
news_url_xpath = ".//h2/a/@href"
news_title_xpath = ".//h2/a"
news_content_xpath = './/p[@class="s"]'

language_param = "lb"
region_param = "arc"

_delta_kwargs = {"day": "days", "week": "weeks", "month": "months", "year": "years"}


def init(_):
    if search_type not in ("", "images", "news"):
        raise ValueError(f"Invalid search type {search_type}")


def request(query, params):
    args = {
        "q": query,
        "safe": min(params["safesearch"], 1),
        language_param: traits.get_language(params["searxng_locale"], traits.custom["language_all"]),
        region_param: traits.get_region(params["searxng_locale"], traits.custom["region_all"]),
    }

    if search_type:
        args["fmt"] = search_type

    # setting the page number on the first page (i.e. s=0) triggers a rate-limit
    if search_type == "" and params["pageno"] > 1:
        args["s"] = 10 * (params["pageno"] - 1)

    if params["time_range"] and search_type != "images":
        kwargs = {_delta_kwargs[params["time_range"]]: 1}
        args["since"] = (datetime.now() - relativedelta(**kwargs)).strftime("%Y%m%d")  # type: ignore
        logger.debug(args["since"])

    params["url"] = f"{base_url}/search?{urlencode(args)}"

    return params


def _general_results(dom):
    results = []

    for result in eval_xpath_list(dom, results_xpath):
        results.append(
            {
                "url": extract_text(eval_xpath(result, url_xpath)),
                "title": extract_text(eval_xpath(result, title_xpath)),
                "content": extract_text(eval_xpath(result, content_xpath)),
            }
        )

    for suggestion in eval_xpath(dom, suggestion_xpath):
        results.append({"suggestion": extract_text(suggestion)})

    return results


def _image_results(dom):
    results = []

    for result in eval_xpath_list(dom, image_results_xpath):
        results.append(
            {
                "template": "images.html",
                "url": extract_text(eval_xpath(result, image_url_xpath)),
                "title": extract_text(eval_xpath(result, image_title_xpath)),
                "img_src": base_url + extract_text(eval_xpath(result, image_img_src_xpath)),  # type: ignore
                "content": "",
            }
        )

    return results


def _news_results(dom):
    results = []

    for result in eval_xpath_list(dom, news_results_xpath):
        results.append(
            {
                "url": extract_text(eval_xpath(result, news_url_xpath)),
                "title": extract_text(eval_xpath(result, news_title_xpath)),
                "content": extract_text(eval_xpath(result, news_content_xpath)),
            }
        )

    return results


def response(resp):
    dom = html.fromstring(resp.text)

    if search_type == "":
        return _general_results(dom)

    if search_type == "images":
        return _image_results(dom)

    if search_type == "news":
        return _news_results(dom)

    raise ValueError(f"Invalid search type {search_type}")


def fetch_traits(engine_traits: EngineTraits):
    # pylint: disable=import-outside-toplevel
    import contextlib

    from babel import Locale, UnknownLocaleError

    from searx.locales import get_official_locales, region_tag
    from searx.network import get  # see https://github.com/searxng/searxng/issues/762

    resp = get(
        base_url + "/preferences",
        headers={"Accept-Language": "en-US,en;q=0.5"},
        timeout=5,
    )
    if not resp.ok:
        raise RuntimeError("Response from Mojeek is not OK.")

    dom = html.fromstring(resp.text)

    languages = eval_xpath_list(dom, f'//select[@name="{language_param}"]/option/@value')

    engine_traits.custom["language_all"] = languages[0]

    for code in languages[1:]:
        with contextlib.suppress(UnknownLocaleError):
            locale = Locale(code)
            engine_traits.languages[locale.language] = code

    regions = eval_xpath_list(dom, f'//select[@name="{region_param}"]/option/@value')

    engine_traits.custom["region_all"] = regions[1]

    for code in regions[2:]:
        for locale in get_official_locales(code, engine_traits.languages):
            engine_traits.regions[region_tag(locale)] = code