forked from zaclys/searxng
[fix] matrixrooms add proper MRS integration
Related: - https://github.com/searxng/searxng/issues/2918
This commit is contained in:
parent
34d0d2c9ab
commit
fa830b375b
13
docs/dev/engines/online/mrs.rst
Normal file
13
docs/dev/engines/online/mrs.rst
Normal file
@ -0,0 +1,13 @@
|
||||
.. _mrs engine:
|
||||
|
||||
=========================
|
||||
Matrix Rooms Search (MRS)
|
||||
=========================
|
||||
|
||||
.. contents:: Contents
|
||||
:depth: 2
|
||||
:local:
|
||||
:backlinks: entry
|
||||
|
||||
.. automodule:: searx.engines.mrs
|
||||
:members:
|
@ -1,26 +1,52 @@
|
||||
# SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
# lint: pylint
|
||||
"""Matrixrooms.info (social media)
|
||||
"""Matrix Rooms Search - a fully-featured, standalone, matrix rooms search service.
|
||||
|
||||
Configuration
|
||||
=============
|
||||
|
||||
The engine has the following mandatory settings:
|
||||
|
||||
- :py:obj:`base_url`
|
||||
|
||||
.. code:: yaml
|
||||
|
||||
- name: MRS
|
||||
engine: mrs
|
||||
base_url: https://mrs-host
|
||||
...
|
||||
|
||||
Implementation
|
||||
==============
|
||||
"""
|
||||
|
||||
from urllib.parse import quote_plus
|
||||
|
||||
about = {
|
||||
"website": 'https://matrixrooms.info',
|
||||
"wikidata_id": 'Q107565255',
|
||||
"official_api_documentation": None,
|
||||
"use_official_api": False,
|
||||
"wikidata_id": None,
|
||||
"official_api_documentation": 'https://gitlab.com/etke.cc/mrs/api/-/blob/main/openapi.yml?ref_type=heads',
|
||||
"use_official_api": True,
|
||||
"require_api_key": False,
|
||||
"results": 'JSON',
|
||||
}
|
||||
paging = True
|
||||
categories = ['social media']
|
||||
|
||||
base_url = "https://apicdn.matrixrooms.info"
|
||||
base_url = ""
|
||||
matrix_url = "https://matrix.to"
|
||||
page_size = 20
|
||||
|
||||
|
||||
def init(engine_settings): # pylint: disable=unused-argument
|
||||
"""The ``base_url`` must be set in the configuration, if ``base_url`` is not
|
||||
set, a :py:obj:`ValueError` is raised during initialization.
|
||||
|
||||
"""
|
||||
if not base_url:
|
||||
raise ValueError('engine MRS, base_url is unset')
|
||||
|
||||
|
||||
def request(query, params):
|
||||
params['url'] = f"{base_url}/search/{quote_plus(query)}/{page_size}/{(params['pageno']-1)*page_size}"
|
||||
return params
|
@ -1043,10 +1043,12 @@ engines:
|
||||
base_url: https://mastodon.social
|
||||
shortcut: mah
|
||||
|
||||
- name: matrixrooms
|
||||
engine: matrixrooms
|
||||
shortcut: mtrx
|
||||
disabled: true
|
||||
# - name: matrixrooms
|
||||
# engine: mrs
|
||||
# # https://docs.searxng.org/dev/engines/online/mrs.html
|
||||
# # base_url: https://mrs-api-host
|
||||
# shortcut: mtrx
|
||||
# disabled: true
|
||||
|
||||
- name: metacpan
|
||||
engine: metacpan
|
||||
|
Loading…
Reference in New Issue
Block a user