From e3282748d0433d455336487f7e36b789fe6ade30 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?No=C3=A9mi=20V=C3=A1nyi?= <sitbackandwait@gmail.com>
Date: Sun, 29 Mar 2020 13:14:06 +0200
Subject: [PATCH] add display_error_messages option to engine settings

A new option is added to engines to hide error messages from users. It
is called `display_error_messages` and by default it is set to `True`.
If it is set to `False` error messages do not show up on the UI.

Keep in mind that engines are still suspended if needed regardless of
this setting.

Closes #1828
---
 docs/admin/engines.rst       | 4 ++++
 docs/admin/settings.rst      | 3 +++
 docs/dev/engine_overview.rst | 1 +
 searx/engines/__init__.py    | 1 +
 searx/results.py             | 3 ++-
 5 files changed, 11 insertions(+), 1 deletion(-)

diff --git a/docs/admin/engines.rst b/docs/admin/engines.rst
index 4b78c8c2..4d1872df 100644
--- a/docs/admin/engines.rst
+++ b/docs/admin/engines.rst
@@ -26,6 +26,8 @@ Safe search   **SS**
 Weigth        **W**
 ------------- ----------- ---------------------------------
 Disabled      **D**
+------------- ----------- ---------------------------------
+Show errors   **DE**
 ============= =========== =================================
 
 Configuration defaults (at built time):
@@ -51,6 +53,7 @@ Configuration defaults (at built time):
         - O
 	- W
 	- D
+	- DE
 
       {% for name, mod in engines.items() %}
 
@@ -67,5 +70,6 @@ Configuration defaults (at built time):
         - {{(mod.offline and "y") or ""}}
         - {{mod.weight or 1 }}
         - {{(mod.disabled and "y") or ""}}
+        - {{(mod.display_error_messages and "y") or ""}}
 
      {% endfor %}
diff --git a/docs/admin/settings.rst b/docs/admin/settings.rst
index 2c42a21e..2bfbae35 100644
--- a/docs/admin/settings.rst
+++ b/docs/admin/settings.rst
@@ -175,6 +175,9 @@ Engine settings
 ``weigth`` : default ``1``
   Weighting of the results of this engine.
 
+``display_error_messages`` : default ``True``
+  When an engine returns an error, the message is displayed on the user interface.
+
 .. note::
 
    A few more options are possible, but they are pretty specific to some
diff --git a/docs/dev/engine_overview.rst b/docs/dev/engine_overview.rst
index 449c837a..c3c81fff 100644
--- a/docs/dev/engine_overview.rst
+++ b/docs/dev/engine_overview.rst
@@ -57,6 +57,7 @@ engine                  string      name of searx-engine
                                     (filename without ``.py``)
 shortcut                string      shortcut of search-engine
 timeout                 string      specific timeout for search-engine
+display_error_messages  boolean     display error messages on the web UI
 ======================= =========== ===========================================
 
 
diff --git a/searx/engines/__init__.py b/searx/engines/__init__.py
index 9ccef8b5..48c02e2e 100644
--- a/searx/engines/__init__.py
+++ b/searx/engines/__init__.py
@@ -55,6 +55,7 @@ engine_default_args = {'paging': False,
                        'continuous_errors': 0,
                        'time_range_support': False,
                        'offline': False,
+                       'display_error_messages': True,
                        'tokens': []}
 
 
diff --git a/searx/results.py b/searx/results.py
index 02ab9efb..62a01a5b 100644
--- a/searx/results.py
+++ b/searx/results.py
@@ -346,7 +346,8 @@ class ResultContainer(object):
         return resultnum_sum / len(self._number_of_results)
 
     def add_unresponsive_engine(self, engine_name, error_type, error_message=None):
-        self.unresponsive_engines.add((engine_name, error_type, error_message))
+        if engines[engine_name].display_error_messages:
+            self.unresponsive_engines.add((engine_name, error_type, error_message))
 
     def add_timing(self, engine_name, engine_time, page_load_time):
         self.timings.append({