Add recoll engine (#2325)

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://framagit.org/medoc92/recollwebui.git

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

2 files changed, 81 insertions, 0 deletions

diff --git a/searx/templates/oscar/macros.html b/searx/templates/oscar/macros.html
index 57a90aaa2..2bc1e7805 100644
--- a/searx/templates/oscar/macros.html
+++ b/searx/templates/oscar/macros.html
@@ -47,6 +47,20 @@
     {%- endif -%}
 {%- 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, id) -%}
     <div class="clearfix"></div>{{- "" -}}
@@ -68,6 +82,18 @@
     {%- endif %}
 {%- 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, id) -%}
     {% if rtl %}
     <div class="row form-group">
diff --git a/searx/templates/oscar/result_templates/files.html b/searx/templates/oscar/result_templates/files.html
new file mode 100644
index 000000000..5e3894e0a
--- /dev/null
+++ b/searx/templates/oscar/result_templates/files.html
@@ -0,0 +1,55 @@
+{% 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') }}">

+    {% if result.mtype == 'audio' %}{{ icon('music') }}

+    {% elif result.mtype == 'video' %} {{ icon('film') }}

+    {% endif %} {{ _('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 }}/{{ result.subtype|safe }}</td></tr>{% endif %}

+</table>

+

+{% if rtl %}

+{{ result_footer_nocache_rtl(result) }}

+{% else %}

+{{ result_footer_nocache(result) }}

+{% endif %}