Files
searxng/searx/engines/mojeek.py

228 lines
7.0 KiB
Python

# SPDX-License-Identifier: AGPL-3.0-or-later
"""Mojeek (general, images, news)"""
import base64
import json
import random
import typing as t
from datetime import datetime
from urllib.parse import urlencode
import curl_cffi
from dateutil.relativedelta import relativedelta
from lxml import html
from searx.exceptions import SearxEngineAPIException
from searx.enginelib import EngineCache
from searx.network import get, post
from searx.result_types import EngineResults
from searx.enginelib.traits import EngineTraits
from searx.utils import eval_xpath, eval_xpath_list, extract_text, solve_altcha
if t.TYPE_CHECKING:
from searx.extended_types import SXNG_Response
from searx.search.processors import OnlineParams
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
language_support = 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"}
CACHE: EngineCache
"""Cache for storing the auth cookie after solving the CAPTCHA."""
def setup(engine_settings: dict[str, t.Any]) -> bool | None:
if search_type not in ("", "images", "news"):
raise ValueError(f"Invalid search type {search_type}")
global CACHE # pylint: disable=global-statement
CACHE = EngineCache(engine_settings["engine"])
def _captcha_token() -> str:
if token := CACHE.get("chllg"):
return token
challenge = get(f"{base_url}/captcha/challenge").json()
solution = solve_altcha(challenge["parameters"])
if not solution:
raise SearxEngineAPIException("failed to solve CAPTCHA")
key, counter = solution
solution = {
"challenge": challenge,
"solution": {"counter": counter, "derivedKey": key, "time": random.randint(100, 200)},
}
solution_encoded = base64.b64encode(json.dumps(solution).encode())
mp = curl_cffi.CurlMime()
mp.addpart(name="altcha", data=solution_encoded)
resp = post(f"{base_url}/captcha/verify", multipart=mp)
token = resp.cookies["chllg"]
CACHE.set("chllg", token)
return token
def request(query: str, params: "OnlineParams"):
args = {
"q": query,
"safe": min(params["safesearch"], 1),
}
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)}"
params["cookies"] = {
language_param: traits.get_language(params["searxng_locale"], traits.custom["language_all"]),
region_param: traits.get_region(params["searxng_locale"], traits.custom["region_all"]),
"chllg": _captcha_token(),
}
def _general_results(dom) -> EngineResults:
res = EngineResults()
for result in eval_xpath_list(dom, results_xpath):
res.add(
res.types.MainResult(
url=extract_text(eval_xpath(result, url_xpath)),
title=extract_text(eval_xpath(result, title_xpath)) or "",
content=extract_text(eval_xpath(result, content_xpath)) or "",
)
)
for suggestion in eval_xpath(dom, suggestion_xpath):
res.add(res.types.LegacyResult(suggestion=extract_text(suggestion)))
return res
def _image_results(dom) -> EngineResults:
res = EngineResults()
for result in eval_xpath_list(dom, image_results_xpath):
res.add(
res.types.Image(
template="images.html",
url=extract_text(eval_xpath(result, image_url_xpath)),
title=extract_text(eval_xpath(result, image_title_xpath)) or "",
img_src=base_url + extract_text(eval_xpath(result, image_img_src_xpath)), # type: ignore
content="",
)
)
return res
def _news_results(dom) -> EngineResults:
res = EngineResults()
for result in eval_xpath_list(dom, news_results_xpath):
res.add(
res.types.MainResult(
url=extract_text(eval_xpath(result, news_url_xpath)),
title=extract_text(eval_xpath(result, news_title_xpath)) or "",
content=extract_text(eval_xpath(result, news_content_xpath)) or "",
)
)
return res
def response(resp: "SXNG_Response") -> EngineResults:
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
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