[mod] add support for the ipfs-search engine

- enable paging for ipfs search
- added support for images, music and video to the ipfs search engine

searx/engines/ipfs_search.py

@@ -0,0 +1,72 @@
+from urllib.parse import urlencode
+import json
+import re
+from datetime import datetime
+
+categories = ['general', 'images', 'music', 'videos']  # optional
+
+mime_types_map = {'general': "*", 'images': 'image*', 'music': 'audio*', 'videos': 'video*'}
+
+base_url = 'https://api.ipfs-search.com/v1/'
+search_string = 'search?{query} metadata.Content-Type:({mimeType})&page={page} '
+
+
+ipfs_url = 'https://gateway.ipfs.io/ipfs/{hash}'
+
+
+def request(query, params):
+    mime_type = mime_types_map.get(params['category'], '*')
+    search_path = search_string.format(query=urlencode({'q': query}), page=params['pageno'], mimeType=mime_type)
+
+    params['url'] = base_url + search_path
+
+    return params
+
+
+def clean_html(text):
+    if not text:
+        return ""
+    return str(re.sub(re.compile('<.*?>'), '', text))
+
+
+def create_base_result(record):
+    url = ipfs_url.format(hash=record.get('hash'))
+    title = clean_html(record.get('title'))
+    published_date = datetime.strptime(record.get('first-seen'), '%Y-%m-%dT%H:%M:%SZ')
+    return {'url': url, 'title': title, 'publishedDate': published_date}
+
+
+def create_text_result(record):
+    result = create_base_result(record)
+    description = clean_html(record.get('description'))
+    result['description'] = description
+    return result
+
+
+def create_image_result(record):
+    result = create_base_result(record)
+    result['img_src'] = result['url']
+    result['template'] = 'images.html'
+    return result
+
+
+def create_video_result(record):
+    result = create_base_result(record)
+    result['thumbnail'] = ''
+    result['template'] = 'videos.html'
+    return result
+
+
+def response(resp):
+    api_results = json.loads(resp.text)
+    results = []
+    for result in api_results.get('hits', []):
+        mime_type = result.get('mimetype', 'text/plain')
+
+        if mime_type.startswith('image'):
+            results.append(create_image_result(result))
+        elif mime_type.startswith('video'):
+            results.append(create_video_result(result))
+        else:
+            results.append(create_text_result(result))
+    return results

searx/settings.yml

@@ -858,6 +858,13 @@ engines:
     timeout: 3.0
     disabled: true
 
+  - name: ipfs search
+    engine: ipfs_search
+    shortcut: ipfs
+    paging: true
+    timeout: 5.0
+    disabled: true
+
   - name: kickass
     engine: kickass
     shortcut: kc