summaryrefslogtreecommitdiff
path: root/searx/engines/magnific.py
blob: ddec8dfa4cf7363947f005712472c3ebac3d3bfc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
# SPDX-License-Identifier: AGPL-3.0-or-later
"""Magnific_ is a database for images.

.. _Magnific: https://www.magnific.com
"""

from urllib.parse import urlencode

import typing as t

from searx.result_types import EngineResults

if t.TYPE_CHECKING:
    from searx.extended_types import SXNG_Response
    from searx.search.processors import OnlineParams


about = {
    "website": "https://www.magnific.com",
    "wikidata_id": "Q104211654",
    "official_api_documentation": None,
    "use_official_api": False,
    "require_api_key": False,
    "results": "JSON",
}

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

categories = ["images"]
paging = True

free_images_only = True
"""
Whether to only load images that may be used for free, without a Magnific account.
"""


def request(query: str, params: "OnlineParams") -> None:
    args = {"term": query, "filters[ai-generated][excluded]": 1, "page": params["pageno"], "locale": "en"}
    if free_images_only:
        args["filters[license]"] = "free"

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


def response(resp: "SXNG_Response"):
    res = EngineResults()

    result: dict[str, t.Any]  # TBH: dict[str, t.Any]
    for result in resp.json()["items"]:
        res.add(
            res.types.Image(
                title=result["name"],
                url=result["url"],
                thumbnail_src=result["preview"]["url"],
                img_src=result["preview"]["url"],
                resolution=f"{result['preview']['width']}x{result['preview']['height']}",
            )
        )

    return res