Files
searxng/searx/engines/unsplash.py
Markus Heiser 280aceb1ae [mod] add new category 'stock_images' - a specialization of 'images' (#6703)
Engines like Pexels provide images that one would more likely expect in a
category named ``stock_images``.

By classifying engines like Pexels more precisely, we enable a more specific
handling of them, which also helps to avoid mixing them with the more general
image search on the internet. [1]

We leave these engines *enabled* by default, take them out of ``images`` and
move them into the specialization ``stock_images``.

This makes it possible, on the one hand, for the admin to configure a tab in the
UI, and on the other hand, the user can always select the group directly using
the search syntax ``!stock_images ...``.

What we need to keep in mind:

1. Technically speaking, there are no subcategories in the strict
   sense.  Organizationally, the *subcategories* are derived from the
   `categories_as_tabs`.

2. From an admin’s perspective, `categories_as_tabs` is the tool for
   structuring their content.

3. In the context of “enabled/disabled by default”: We should avoid having
   the admin have to activate many individual engines when they want to
   structure their content (UI tabs).

So if we leave an engine enabled by default and **move** it from `images` to a
new category, the admin only needs to add the new category to
`categories_as_tabs` to restructure their content.  If the new category is also
part of the translations (see `searx/searxng.msg` in this PR), this UI structure
would also be available internationally.

[1] https://github.com/searxng/searxng/pull/6690#issuecomment-5646291679

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2026-09-18 16:13:42 +02:00

64 lines
1.9 KiB
Python

# SPDX-License-Identifier: AGPL-3.0-or-later
"""Unsplash"""
from urllib.parse import urlencode, urlparse, urlunparse, parse_qsl
from json import loads
from searx.utils import searxng_useragent
# about
about = {
"website": 'https://unsplash.com',
"wikidata_id": 'Q28233552',
"official_api_documentation": 'https://unsplash.com/developers',
"use_official_api": False,
"require_api_key": False,
"results": 'JSON',
}
base_url = 'https://unsplash.com/'
search_url = base_url + 'napi/search/photos?'
categories = ["stock_images"]
page_size = 20
paging = True
def clean_url(url):
parsed = urlparse(url)
query = [(k, v) for (k, v) in parse_qsl(parsed.query) if k != 'ixid']
return urlunparse((parsed.scheme, parsed.netloc, parsed.path, parsed.params, urlencode(query), parsed.fragment))
def request(query, params):
params['url'] = search_url + urlencode({'query': query, 'page': params['pageno'], 'per_page': page_size})
logger.debug("query_url --> %s", params['url'])
# common user agents (e.g. Firefox, Chrome) are blocked
# by Anubis (https://anubis.techaro.lol/)
# so we pass the searxng user agent instead, which is not
# commonly used by crawlers and hence not blocked
params["headers"]["User-Agent"] = searxng_useragent()
return params
def response(resp):
results = []
json_data = loads(resp.text)
if 'results' in json_data:
for result in json_data['results']:
results.append(
{
'template': 'images.html',
'url': clean_url(result['links']['html']),
'thumbnail_src': clean_url(result['urls']['thumb']),
'img_src': clean_url(result['urls']['regular']),
'title': result.get('alt_description') or 'unknown',
'content': result.get('description') or '',
}
)
return results