- recoll engine

   recoll is a local search engine based on Xapian:
   http://www.lesbonscomptes.com/recoll/

   By itself recoll does not offer web or API access,
   this can be achieved using recoll-webui:
   https://github.com/koniu/recoll-webui

   As recoll-webui by default does not support paged JSON
   results it is advisable to use a patched version which does:
   https://github.com/Yetangitu/recoll-webui/tree/jsonpage
   A pull request was sent upstream, if this is merged the patched
   version is no longer needed

   This engine uses a custom 'files' result template

   set base_url to the location where recoll-webui can be reached
   set dl_prefix to a location where the file hierarchy as indexed by recoll can be reached
   set search_dir to the part of the indexed file hierarchy to be searched, use an empty string to search the entire search domain

searx/engines/recoll.py

@@ -0,0 +1,75 @@
+"""
+ Recoll (local search engine)
+
+ @using-api   yes
+ @results     JSON
+ @stable      yes
+ @parse       url, content, size, abstract, author, mtype, time, filename, label
+"""
+
+from json import loads
+from searx.url_utils import urlencode
+from datetime import date, timedelta
+
+# engine dependent config
+paging = True
+time_range_support = True
+
+# parameters from settings.yml
+base_url = None
+search_dir = ''
+dl_prefix = None
+
+def get_time_range(time_range):
+    sw = {
+	    'day' : 1,
+	    'week': 7,
+	    'month': 30,
+	    'year': 365
+    }
+
+    offset = sw.get(time_range,0)
+    if not offset:
+	    return ''
+
+    return (date.today()-timedelta(days=offset)).isoformat()
+
+# do search-request
+def request(query, params):
+    search_after = get_time_range(params['time_range'])
+    search_url = base_url + 'pagedjson?query={query}&page={page}&after={after}&dir={dir}'
+
+    params['url'] = search_url.format(query=urlencode({'q': query}), page=params['pageno'], after=search_after, dir=search_dir)
+
+    return params
+
+# get response from search-request
+def response(resp):
+    results = []
+
+    raw_search_results = loads(resp.text)
+
+    if not raw_search_results:
+        return []
+
+    for result in raw_search_results.get('results', []):
+        title = result['label']
+        url = result['url'].replace('file:///export', dl_prefix)
+        content = u'{}'.format(result['snippet'])
+
+        # append result
+        item = {'url': url,
+                'title': title,
+                'content': content,
+                'template': 'files.html'}
+
+        if result['size']:
+            item['size'] = int(result['size'])
+
+        for parameter in ['filename', 'abstract', 'author', 'mtype', 'time']:
+            if result[parameter]:
+                item[parameter] = result[parameter]
+
+        results.append(item)
+
+    return results

searx/settings.yml

@@ -517,6 +517,47 @@ engines:
     shortcut : qws
     categories : social media
 
+    # recoll is a local search engine based on Xapian:
+    # http://www.lesbonscomptes.com/recoll/
+    #
+    # By itself recoll does not offer web or API access,
+    # this can be achieved using recoll-webui:
+    # https://github.com/koniu/recoll-webui
+    #
+    # As recoll-webui by default does not support paged JSON
+    # results it is advisable to use a patched version which does:
+    # https://github.com/Yetangitu/recoll-webui/tree/jsonpage
+    # A pull request was sent upstream, if this is merged the patched
+    # version is no longer needed
+    #
+    # This engine uses a custom 'files' result template
+    #
+    # set base_url to the location where recoll-webui can be reached
+    # set dl_prefix to a location where the file hierarchy as indexed by recoll can be reached
+    # set search_dir to the part of the indexed file hierarchy to be searched, use an empty string
+    #     to search the entire search domain
+
+    # this entry (with search_dir set to an empty string) covers the entire recoll search domain
+  - name : library
+    engine : recoll
+    shortcut : lib
+    base_url: 'https://recoll.example.org/'
+    search_dir : ''
+    dl_prefix : 'https://download.example.org'
+    timeout : 30.0
+    categories : files
+
+    # this entry only searches the 'reference' directory
+  - name : library reference
+    engine : recoll
+    base_url: 'https://recoll.example.org/'
+    search_dir : reference
+    dl_prefix : 'https://download.example.org'
+    shortcut : libr
+    timeout : 30.0
+    categories : files
+    disabled : True
+
   - name : reddit
     engine : reddit
     shortcut : re

searx/static/themes/oscar/less/logicodev/results.less

@@ -41,6 +41,11 @@
 
 }
 
+.result-abstract {
+    margin-top: 0.5em;
+    margin-bottom: 0.8em;
+}
+
 .external-link {
     color: @dark-green;
     font-size: 12px;
@@ -114,6 +119,20 @@
     }
 }
 
+.result-metadata {
+    clear: both;
+    margin: 1em;
+
+    td {
+        padding-right: 1em;
+        color: @gray;
+    }
+
+    td:first-of-type {
+        color: @dark-gray;
+    }
+}
+
 // map formating of results
 .result-map {
     clear: both;

searx/templates/oscar/macros.html

@@ -39,6 +39,20 @@
 <div class="external-link">{{ result.pretty_url }}</div>
 {%- endmacro %}
 
+<!-- Draw result footer without cache link -->
+{% macro result_footer_nocache(result) -%}
+    <div class="clearfix"></div>
+    <div class="pull-right">
+    {% for engine in result.engines %}
+        <span class="label label-default">{{ engine }}</span>
+    {% endfor %}
+    {% if proxify %}
+    <small>{{ result_link(proxify(result.url), icon('sort') + _('proxied'), "text-info") }}</small>
+    {% endif %}
+</div>
+<div class="external-link">{{ result.pretty_url }}</div>
+{%- endmacro %}
+
 <!-- Draw result footer -->
 {% macro result_footer_rtl(result) -%}
     <div class="clearfix"></div>
@@ -52,6 +66,18 @@
     <div class="external-link">{{ result.pretty_url }}</div>
 {%- endmacro %}
 
+<!-- Draw result footer without cache link -->
+{% macro result_footer_nocache_rtl(result) -%}
+    <div class="clearfix"></div>
+    {% for engine in result.engines %}
+        <span class="label label-default">{{ engine }}</span>
+    {% endfor %}
+    {% if proxify %}
+    <small>{{ result_link(proxify(result.url), icon('sort') + _('proxied'), "text-info") }}</small>
+    {% endif %}
+    <div class="external-link">{{ result.pretty_url }}</div>
+{%- endmacro %}
+
 {% macro preferences_item_header(info, label, rtl) -%}
     {% if rtl %}
     <div class="row form-group">

searx/templates/oscar/result_templates/files.html

@@ -0,0 +1,52 @@
+{% from 'oscar/macros.html' import result_header, result_sub_header, result_footer_nocache, result_footer_nocache_rtl, icon with context %}
+
+{{ result_header(result, favicons) }}
+{{ result_sub_header(result) }}
+
+{% if result.embedded %}
+    <small> &bull; <a class="text-info btn-collapse collapsed cursor-pointer media-loader disabled_if_nojs" data-toggle="collapse" data-target="#result-media-{{ index }}" data-btn-text-collapsed="{{ _('show media') }}" data-btn-text-not-collapsed="{{ _('hide media') }}">{{ icon('music') }} {{ _('show media') }}</a></small>
+{% endif %}
+
+{% if result.embedded %}
+<div id="result-media-{{ index }}" class="collapse">
+   {{ result.embedded|safe }}
+</div>
+{% endif %}
+
+{% if result.abstract %}<p class="result-content result-abstract">{{ result.abstract|safe }}</p>{% endif %}
+
+{% if result.img_src %}
+<div class="container-fluid">
+    <div class="row">
+<img src="{{ image_proxify(result.img_src) }}" alt="{{ result.title|striptags }}" title="{{ result.title|striptags }}" style="width: auto; max-height: 60px; min-height: 60px;" class="col-xs-2 col-sm-4 col-md-4 result-content">
+{% if result.content %}<p class="result-content col-xs-8 col-sm-8 col-md-8">{{ result.content|safe }}</p>{% endif %}
+    </div>
+</div>
+{% else %}
+{% if result.content %}<p class="result-content">{{ result.content|safe }}</p>{% endif %}
+{% endif %}
+
+<table class="result-metadata result-content">
+{% if result.author %}<tr><td>{{ _('Author') }}</td><td>{{ result.author|safe }}</td></tr>{% endif %}
+
+{% if result.filename %}<tr><td>{{ _('Filename') }}</td><td>{{ result.filename|safe }}</td></tr>{% endif %}
+
+{% if result.size %}<tr><td>{{ _('Filesize') }}</td><td>
+        {% if result.size < 1024 %}{{ result.size }} {{ _('Bytes') }}
+        {% elif result.size < 1024*1024 %}{{ '{0:0.2f}'.format(result.size/1024) }} {{ _('kiB') }}
+        {% elif result.size < 1024*1024*1024 %}{{ '{0:0.2f}'.format(result.size/1024/1024) }} {{ _('MiB') }}
+        {% elif result.size < 1024*1024*1024*1024 %}{{ '{0:0.2f}'.format(result.size/1024/1024/1024) }} {{ _('GiB') }}
+        {% else %}{{ '{0:0.2f}'.format(result.size/1024/1024/1024/1024) }} {{ _('TiB') }}{% endif %}
+    </td></tr>
+{% endif %}
+
+{% if result.time %}<tr><td>{{ _('Date') }}</td><td>{{ result.time|safe }}</td></tr>{% endif %}
+
+{% if result.mtype %}<tr><td>{{ _('Type') }}</td><td>{{ result.mtype|safe }}</td></tr>{% endif %}
+</table>
+
+{% if rtl %}
+{{ result_footer_nocache_rtl(result) }}
+{% else %}
+{{ result_footer_nocache(result) }}
+{% endif %}