first commit

2025-07-20 13:25:51 +10:00
commit a2971879f0
294 changed files with 42788 additions and 0 deletions
@@ -0,0 +1,161 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+# lint: pylint
+"""YaCy_ is a free distributed search engine, built on the principles of
+peer-to-peer (P2P) networks.
+
+API: Dev:APIyacysearch_
+
+Releases:
+
+- https://github.com/yacy/yacy_search_server/tags
+- https://download.yacy.net/
+
+.. _Yacy: https://yacy.net/
+.. _Dev:APIyacysearch: https://wiki.yacy.net/index.php/Dev:APIyacysearch
+
+Configuration
+=============
+
+The engine has the following (additional) settings:
+
+.. code:: yaml
+
+   - name: yacy
+     engine: yacy
+     shortcut: ya
+     base_url: http://localhost:8090
+     # Yacy search mode. 'global' or 'local'.
+     search_mode: 'global'
+     number_of_results: 5
+     http_digest_auth_user: ""
+     http_digest_auth_pass: ""
+
+
+Implementations
+===============
+"""
+# pylint: disable=fixme
+
+from json import loads
+from urllib.parse import urlencode
+from dateutil import parser
+
+from httpx import DigestAuth
+
+from searx.utils import html_to_text
+
+# about
+about = {
+    "website": 'https://yacy.net/',
+    "wikidata_id": 'Q1759675',
+    "official_api_documentation": 'https://wiki.yacy.net/index.php/Dev:API',
+    "use_official_api": True,
+    "require_api_key": False,
+    "results": 'JSON',
+}
+
+# engine dependent config
+categories = ['general', 'images']  # TODO , 'music', 'videos', 'files'
+paging = True
+number_of_results = 5
+http_digest_auth_user = ""
+http_digest_auth_pass = ""
+search_mode = 'global'
+"""Yacy search mode ``global`` or ``local``.  By default, Yacy operates in ``global``
+mode.
+
+``global``
+  Peer-to-Peer search
+
+``local``
+  Privacy or Stealth mode, restricts the search to local yacy instance.
+"""
+# search-url
+base_url = 'http://localhost:8090'
+search_url = (
+    '/yacysearch.json?{query}'
+    '&startRecord={offset}'
+    '&maximumRecords={limit}'
+    '&contentdom={search_type}'
+    '&resource={resource}'
+)
+
+# yacy specific type-definitions
+search_types = {'general': 'text', 'images': 'image', 'files': 'app', 'music': 'audio', 'videos': 'video'}
+
+
+def request(query, params):
+    offset = (params['pageno'] - 1) * number_of_results
+    search_type = search_types.get(params.get('category'), '0')
+
+    params['url'] = base_url + search_url.format(
+        query=urlencode({'query': query}),
+        offset=offset,
+        limit=number_of_results,
+        search_type=search_type,
+        resource=search_mode,
+    )
+
+    if http_digest_auth_user and http_digest_auth_pass:
+        params['auth'] = DigestAuth(http_digest_auth_user, http_digest_auth_pass)
+
+    # add language tag if specified
+    if params['language'] != 'all':
+        params['url'] += '&lr=lang_' + params['language'].split('-')[0]
+
+    return params
+
+
+def response(resp):
+    results = []
+
+    raw_search_results = loads(resp.text)
+
+    # return empty array if there are no results
+    if not raw_search_results:
+        return []
+
+    search_results = raw_search_results.get('channels', [])
+
+    if len(search_results) == 0:
+        return []
+
+    for result in search_results[0].get('items', []):
+        # parse image results
+        if resp.search_params.get('category') == 'images':
+            result_url = ''
+            if 'url' in result:
+                result_url = result['url']
+            elif 'link' in result:
+                result_url = result['link']
+            else:
+                continue
+
+            # append result
+            results.append(
+                {
+                    'url': result_url,
+                    'title': result['title'],
+                    'content': '',
+                    'img_src': result['image'],
+                    'template': 'images.html',
+                }
+            )
+
+        # parse general results
+        else:
+            publishedDate = parser.parse(result['pubDate'])
+
+            # append result
+            results.append(
+                {
+                    'url': result['link'],
+                    'title': result['title'],
+                    'content': html_to_text(result['description']),
+                    'publishedDate': publishedDate,
+                }
+            )
+
+        # TODO parse video, audio and file results
+
+    return results