Functions
	request (query, params)

	response (resp)

	video_response (resp)

	fetch_traits (EngineTraits engine_traits)

Variables
dict	about

list	categories = ["videos"]

bool	paging = True

str	base_url = "https://peer.tube"

bool	time_range_support = True

dict	time_range_table

bool	safesearch = True

dict	safesearch_table = {0: 'both', 1: 'false', 2: 'false'}

Detailed Description

Peertube and :py:obj:`SepiaSearch <searx.engines.sepiasearch>` do share
(more or less) the same REST API and the schema of the JSON result is identical.

Function Documentation

◆ fetch_traits()

searx.engines.peertube.fetch_traits ( EngineTraits engine_traits )

Fetch languages from peertube's search-index source code.

See videoLanguages_ in commit `8ed5c729 - Refactor and redesign client`_

.. _8ed5c729 - Refactor and redesign client:
   https://framagit.org/framasoft/peertube/search-index/-/commit/8ed5c729
.. _videoLanguages:
   https://framagit.org/framasoft/peertube/search-index/-/commit/8ed5c729#3d8747f9a60695c367c70bb64efba8f403721fad_0_291

Definition at line 137 of file peertube.py.

def fetch_traits(engine_traits: EngineTraits):
    """Fetch languages from peertube's search-index source code.
 
    See videoLanguages_ in commit `8ed5c729 - Refactor and redesign client`_
 
    .. _8ed5c729 - Refactor and redesign client:
       https://framagit.org/framasoft/peertube/search-index/-/commit/8ed5c729
    .. _videoLanguages:
       https://framagit.org/framasoft/peertube/search-index/-/commit/8ed5c729#3d8747f9a60695c367c70bb64efba8f403721fad_0_291
    """
 
    resp = get(
        'https://framagit.org/framasoft/peertube/search-index/-/raw/master/client/src/components/Filters.vue',
        # the response from search-index repository is very slow
        timeout=60,
    )
 
    if not resp.ok:  # type: ignore
        print("ERROR: response from peertube is not OK.")
        return
 
    js_lang = re.search(r"videoLanguages \‍(\‍)[^\n]+(.*?)\]", resp.text, re.DOTALL)  # type: ignore
    if not js_lang:
        print("ERROR: can't determine languages from peertube")
        return
 
    for lang in re.finditer(r"\{ id: '([a-z]+)', label:", js_lang.group(1)):
        eng_tag = lang.group(1)
        if eng_tag == 'oc':
            # Occitanis not known by babel, its closest relative is Catalan
            # but 'ca' is already in the list of engine_traits.languages -->
            # 'oc' will be ignored.
            continue
        try:
            sxng_tag = language_tag(babel.Locale.parse(eng_tag))
        except babel.UnknownLocaleError:
            print("ERROR: %s is unknown by babel" % eng_tag)
            continue
 
        conflict = engine_traits.languages.get(sxng_tag)
        if conflict:
            if conflict != eng_tag:
                print("CONFLICT: babel %s --> %s, %s" % (sxng_tag, conflict, eng_tag))
            continue
        engine_traits.languages[sxng_tag] = eng_tag
 
    engine_traits.languages['zh_Hans'] = 'zh'
    engine_traits.languages['zh_Hant'] = 'zh'

◆ request()

searx.engines.peertube.request	(		query,
			params )

Assemble request for the Peertube API

Definition at line 53 of file peertube.py.

def request(query, params):
    """Assemble request for the Peertube API"""
 
    if not query:
        return False
 
    # eng_region = traits.get_region(params['searxng_locale'], 'en_US')
    eng_lang = traits.get_language(params['searxng_locale'], None)
 
    params['url'] = (
        base_url.rstrip("/")
        + "/api/v1/search/videos?"
        + urlencode(
            {
                'search': query,
                'searchTarget': 'search-index',  # Vidiversum
                'resultType': 'videos',
                'start': (params['pageno'] - 1) * 10,
                'count': 10,
                # -createdAt: sort by date ascending / createdAt: date descending
                'sort': '-match',  # sort by *match descending*
                'nsfw': safesearch_table[params['safesearch']],
            }
        )
    )
 
    if eng_lang is not None:
        params['url'] += '&languageOneOf[]=' + eng_lang
        params['url'] += '&boostLanguages[]=' + eng_lang
 
    if params['time_range'] in time_range_table:
        time = datetime.now().date() + time_range_table[params['time_range']]
        params['url'] += '&startDate=' + time.isoformat()
 
    return params
 
 

◆ response()

searx.engines.peertube.response ( resp )

Definition at line 90 of file peertube.py.

def response(resp):
    return video_response(resp)

References video_response().

Here is the call graph for this function:

◆ video_response()

searx.engines.peertube.video_response ( resp )

Parse video response from SepiaSearch and Peertube instances.

Definition at line 94 of file peertube.py.

def video_response(resp):
    """Parse video response from SepiaSearch and Peertube instances."""
    results = []
 
    json_data = resp.json()
 
    if 'data' not in json_data:
        return []
 
    for result in json_data['data']:
        metadata = [
            x
            for x in [
                result.get('channel', {}).get('displayName'),
                result.get('channel', {}).get('name') + '@' + result.get('channel', {}).get('host'),
                ', '.join(result.get('tags', [])),
            ]
            if x
        ]
 
        duration = result.get('duration')
        if duration:
            duration = timedelta(seconds=duration)
 
        results.append(
            {
                'url': result['url'],
                'title': result['name'],
                'content': html_to_text(result.get('description') or ''),
                'author': result.get('account', {}).get('displayName'),
                'length': duration,
                'views': humanize_number(result['views']),
                'template': 'videos.html',
                'publishedDate': parse(result['publishedAt']),
                'iframe_src': result.get('embedUrl'),
                'thumbnail': result.get('thumbnailUrl') or result.get('previewUrl'),
                'metadata': ' | '.join(metadata),
            }
        )
 
    return results
 
 

Referenced by response().

Here is the caller graph for this function:

Variable Documentation

◆ about

dict searx.engines.peertube.about

Initial value:

=  {
    # pylint: disable=line-too-long
    "website": 'https://joinpeertube.org',
    "wikidata_id": 'Q50938515',
    "official_api_documentation": 'https://docs.joinpeertube.org/api-rest-reference.html#tag/Search/operation/searchVideos',
    "use_official_api": True,
    "require_api_key": False,
    "results": 'JSON',
}

Definition at line 22 of file peertube.py.

◆ base_url

str searx.engines.peertube.base_url = "https://peer.tube"

Definition at line 35 of file peertube.py.

◆ categories

list searx.engines.peertube.categories = ["videos"]

Definition at line 33 of file peertube.py.

◆ paging

bool searx.engines.peertube.paging = True

Definition at line 34 of file peertube.py.

◆ safesearch

bool searx.engines.peertube.safesearch = True

Definition at line 49 of file peertube.py.

◆ safesearch_table

dict searx.engines.peertube.safesearch_table = {0: 'both', 1: 'false', 2: 'false'}

Definition at line 50 of file peertube.py.

◆ time_range_support

bool searx.engines.peertube.time_range_support = True

Definition at line 41 of file peertube.py.

◆ time_range_table

dict searx.engines.peertube.time_range_table