From f9740debb2b10d030387df2f576a69dc12440821 Mon Sep 17 00:00:00 2001
From: "Fabian Franz, BSc" <fabianfrz@users.noreply.github.com>
Date: Wed, 15 Nov 2017 18:35:00 +0100
Subject: [PATCH] add redis plugin to rspamd plugin (#372)

* add redis plugin to rspamd plugin
* add redis missing warning
---
 .../OPNsense/Rspamd/IndexController.php       |  3 ++
 .../OPNsense/Rspamd/forms/settings.xml        |  8 +++++-
 .../mvc/app/models/OPNsense/Rspamd/RSpamd.xml |  4 +++
 .../mvc/app/views/OPNsense/Rspamd/index.volt  | 11 +++++++-
 .../templates/OPNsense/Rspamd/+TARGETS        |  1 +
 .../templates/OPNsense/Rspamd/redis.conf      | 28 +++++++++++++++++++
 6 files changed, 53 insertions(+), 2 deletions(-)
 create mode 100644 mail/rspamd/src/opnsense/service/templates/OPNsense/Rspamd/redis.conf

diff --git a/mail/rspamd/src/opnsense/mvc/app/controllers/OPNsense/Rspamd/IndexController.php b/mail/rspamd/src/opnsense/mvc/app/controllers/OPNsense/Rspamd/IndexController.php
index f0039963e..ed98f68e1 100644
--- a/mail/rspamd/src/opnsense/mvc/app/controllers/OPNsense/Rspamd/IndexController.php
+++ b/mail/rspamd/src/opnsense/mvc/app/controllers/OPNsense/Rspamd/IndexController.php
@@ -32,6 +32,7 @@
 namespace OPNsense\Rspamd;
 
 use \OPNsense\Core\Backend;
+use \OPNsense\Rspamd\RSpamd;
 
 /**
 * Class IndexController
@@ -43,6 +44,8 @@ class IndexController extends \OPNsense\Base\IndexController
     {
         $backend = new Backend();
         $this->view->clamav_installed = (trim($backend->configdRun('firmware plugin clamav')) == '1');
+        $this->view->redis_installed = (trim($backend->configdRun('firmware plugin redis')) == '1');
+        $this->view->redis_plugin_enabled = ((string)((new RSpamd())->general->enable_redis_plugin)) == '1';
         $this->view->title = gettext("Rspamd Mail Protection");
         $this->view->settings = $this->getForm("settings");
         $this->view->pick('OPNsense/Rspamd/index');
diff --git a/mail/rspamd/src/opnsense/mvc/app/controllers/OPNsense/Rspamd/forms/settings.xml b/mail/rspamd/src/opnsense/mvc/app/controllers/OPNsense/Rspamd/forms/settings.xml
index 2fc66828a..a26568758 100644
--- a/mail/rspamd/src/opnsense/mvc/app/controllers/OPNsense/Rspamd/forms/settings.xml
+++ b/mail/rspamd/src/opnsense/mvc/app/controllers/OPNsense/Rspamd/forms/settings.xml
@@ -1,12 +1,18 @@
 <form>
     <tab id="rspamd-general" description="General Settings">
-        <subtab id="rspamd-general-settings" description="General rSpamd Settings">
+        <subtab id="rspamd-general-settings" description="General Rspamd Settings">
             <field>
                 <id>rspamd.general.enabled</id>
                 <label>Enable rspamd</label>
                 <type>checkbox</type>
                 <help>Enable or disable the rspamd service.</help>
             </field>
+            <field>
+                <id>rspamd.general.enable_redis_plugin</id>
+                <label>Enable Redis Plugin</label>
+                <type>checkbox</type>
+                <help>If you check this box, the local Redis server will be available to the modules (some do not work without it).</help>
+            </field>
         </subtab>
     </tab>
     <tab id="rspamd-anti-spam" description="Spam Protection">
diff --git a/mail/rspamd/src/opnsense/mvc/app/models/OPNsense/Rspamd/RSpamd.xml b/mail/rspamd/src/opnsense/mvc/app/models/OPNsense/Rspamd/RSpamd.xml
index fd73f75a3..8fc25cacf 100644
--- a/mail/rspamd/src/opnsense/mvc/app/models/OPNsense/Rspamd/RSpamd.xml
+++ b/mail/rspamd/src/opnsense/mvc/app/models/OPNsense/Rspamd/RSpamd.xml
@@ -7,6 +7,10 @@
         <default>0</default>
         <Required>Y</Required>
       </enabled>
+      <enable_redis_plugin type="BooleanField">
+        <default>0</default>
+        <Required>Y</Required>
+      </enable_redis_plugin>
     </general>
 
     <graylist>
diff --git a/mail/rspamd/src/opnsense/mvc/app/views/OPNsense/Rspamd/index.volt b/mail/rspamd/src/opnsense/mvc/app/views/OPNsense/Rspamd/index.volt
index 59d099068..f987bcde1 100644
--- a/mail/rspamd/src/opnsense/mvc/app/views/OPNsense/Rspamd/index.volt
+++ b/mail/rspamd/src/opnsense/mvc/app/views/OPNsense/Rspamd/index.volt
@@ -29,7 +29,7 @@
 #}
 
 <script type="text/javascript">
-
+    window.redis_installed = {{ redis_installed ? 'true' : 'false' }};
     $( document ).ready(function() {
 
         var data_get_map = {'frm_rspamd':'/api/rspamd/settings/get'};
@@ -51,6 +51,12 @@
         $('.nav-tabs a').on('shown.bs.tab', function (e) {
             history.pushState(null, null, e.target.hash);
         });
+        $('#rspamd\\.general\\.enable_redis_plugin').change(function (evt) {
+            $('#missing_redis_plugin').hide();
+            if (!window.redis_installed && $(this).is(':checked')) {
+                $('#missing_redis_plugin').show();
+            }
+        });
         
         
         
@@ -99,6 +105,9 @@
     <div style="margin-top: 8px;">{{ lang._('No ClamAV plugin found, please install via %sSystem > Firmware > Plugins%s. If the plugin is not installed and enabled, mails cannot be scanned for malware.')|format('<a href="/ui/core/firmware/#plugins">','</a>')}}</div>
 </div>
 {% endif %}
+<div class="alert alert-danger" role="alert" id="missing_redis_plugin" style="min-height:65px;{% if !redis_plugin_enabled or redis_installed %} display:none;{% endif %}">
+    <div style="margin-top: 8px;">{{ lang._('The Redis plugin is configured to use but it is not installed. Please install it via %sSystem > Firmware > Plugins%s.')|format('<a href="/ui/core/firmware/#plugins">','</a>')}}</div>
+</div>
 
 <ul class="nav nav-tabs" role="tablist"  id="maintabs">
 {% for tab in settings['tabs']|default([]) %}
diff --git a/mail/rspamd/src/opnsense/service/templates/OPNsense/Rspamd/+TARGETS b/mail/rspamd/src/opnsense/service/templates/OPNsense/Rspamd/+TARGETS
index c18e907b7..0f83e7ba9 100644
--- a/mail/rspamd/src/opnsense/service/templates/OPNsense/Rspamd/+TARGETS
+++ b/mail/rspamd/src/opnsense/service/templates/OPNsense/Rspamd/+TARGETS
@@ -11,4 +11,5 @@ greylist.conf:/usr/local/etc/rspamd/local.d/greylist.conf
 phishing.conf:/usr/local/etc/rspamd/local.d/phishing.conf
 mx_check.conf:/usr/local/etc/rspamd/local.d/mx_check.conf
 ratelimit.conf:/usr/local/etc/rspamd/local.d/ratelimit.conf
+redis.conf:/usr/local/etc/rspamd/local.d/redis.conf
 spamtrap.map:/usr/local/etc/rspamd/maps.d/spamtrap.map
diff --git a/mail/rspamd/src/opnsense/service/templates/OPNsense/Rspamd/redis.conf b/mail/rspamd/src/opnsense/service/templates/OPNsense/Rspamd/redis.conf
new file mode 100644
index 000000000..5425fefb0
--- /dev/null
+++ b/mail/rspamd/src/opnsense/service/templates/OPNsense/Rspamd/redis.conf
@@ -0,0 +1,28 @@
+# Please don't modify this file as your changes might be overwritten with
+# the next update.
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local.override' to redefine
+# parameters defined on the top level
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local' to add
+# parameters defined on the top level
+#
+# For specific modules or configuration you can also modify
+# '$LOCAL_CONFDIR/local.d/file.conf' - to add your options or rewrite defaults
+# '$LOCAL_CONFDIR/override.d/file.conf' - to override the defaults
+#
+# See https://rspamd.com/doc/configuration/redis.html
+
+{% if helpers.exists('OPNsense.Rspamd.general.enable_redis_plugin') and OPNsense.Rspamd.general.enable_redis_plugin == '1' %}
+{%   if helpers.exists('OPNsense.redis.general.enabled') and OPNsense.redis.general.enabled == '1' %}
+
+servers = "::1";
+write_servers = "::1";
+timeout = 10s;
+#db = "0";
+{%     if helpers.exists('OPNsense.redis.security.password') and OPNsense.redis.security.password != '' %}
+password = "{{ OPNsense.redis.security.password.replace('"',"\\\"") }}";
+{%     endif %}
+  
+{%   endif %}
+{% endif %}