From 213cb74378a02a0863c3028d6817751124c62183 Mon Sep 17 00:00:00 2001
From: Aine <aine@etke.cc>
Date: Sun, 8 Oct 2023 23:27:43 +0300
Subject: [fix] matrixrooms add proper MRS integration

Related:

- https://github.com/searxng/searxng/issues/2918
---
 docs/dev/engines/online/mrs.rst | 13 ++++++++
 searx/engines/matrixrooms.py    | 45 --------------------------
 searx/engines/mrs.py            | 71 +++++++++++++++++++++++++++++++++++++++++
 searx/settings.yml              | 10 +++---
 4 files changed, 90 insertions(+), 49 deletions(-)
 create mode 100644 docs/dev/engines/online/mrs.rst
 delete mode 100644 searx/engines/matrixrooms.py
 create mode 100644 searx/engines/mrs.py

diff --git a/docs/dev/engines/online/mrs.rst b/docs/dev/engines/online/mrs.rst
new file mode 100644
index 000000000..671f35ea5
--- /dev/null
+++ b/docs/dev/engines/online/mrs.rst
@@ -0,0 +1,13 @@
+.. _mrs engine:
+
+=========================
+Matrix Rooms Search (MRS)
+=========================
+
+.. contents:: Contents
+   :depth: 2
+   :local:
+   :backlinks: entry
+
+.. automodule:: searx.engines.mrs
+   :members:
diff --git a/searx/engines/matrixrooms.py b/searx/engines/matrixrooms.py
deleted file mode 100644
index 06c4d99a9..000000000
--- a/searx/engines/matrixrooms.py
+++ /dev/null
@@ -1,45 +0,0 @@
-# SPDX-License-Identifier: AGPL-3.0-or-later
-# lint: pylint
-"""Matrixrooms.info (social media)
-"""
-
-from urllib.parse import quote_plus
-
-about = {
-    "website": 'https://matrixrooms.info',
-    "wikidata_id": 'Q107565255',
-    "official_api_documentation": None,
-    "use_official_api": False,
-    "require_api_key": False,
-    "results": 'JSON',
-}
-paging = True
-categories = ['social media']
-
-base_url = "https://apicdn.matrixrooms.info"
-matrix_url = "https://matrix.to"
-page_size = 20
-
-
-def request(query, params):
-    params['url'] = f"{base_url}/search/{quote_plus(query)}/{page_size}/{(params['pageno']-1)*page_size}"
-    return params
-
-
-def response(resp):
-    results = []
-
-    for result in resp.json():
-        results.append(
-            {
-                'url': matrix_url + '/#/' + result['alias'],
-                'title': result['name'],
-                'content': result['topic']
-                + f" // {result['members']} members"
-                + f" // {result['alias']}"
-                + f" // {result['server']}",
-                'thumbnail': result['avatar_url'],
-            }
-        )
-
-    return results
diff --git a/searx/engines/mrs.py b/searx/engines/mrs.py
new file mode 100644
index 000000000..68e34d21d
--- /dev/null
+++ b/searx/engines/mrs.py
@@ -0,0 +1,71 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+# lint: pylint
+"""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": 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 = ""
+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
+
+
+def response(resp):
+    results = []
+
+    for result in resp.json():
+        results.append(
+            {
+                'url': matrix_url + '/#/' + result['alias'],
+                'title': result['name'],
+                'content': result['topic']
+                + f" // {result['members']} members"
+                + f" // {result['alias']}"
+                + f" // {result['server']}",
+                'thumbnail': result['avatar_url'],
+            }
+        )
+
+    return results
diff --git a/searx/settings.yml b/searx/settings.yml
index 8b6d32301..a96199c0c 100644
--- a/searx/settings.yml
+++ b/searx/settings.yml
@@ -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
-- 
cgit v1.2.3