From 2573081f09804a969cef0386dd77edd486b21ab4 Mon Sep 17 00:00:00 2001
From: radny <poradzisz.pawel@gmail.com>
Date: Sun, 3 Mar 2024 21:31:32 +0100
Subject: [PATCH] Add archiver-enabled config.xml option

---
 .gitignore                                     |  3 ++-
 README.adoc                                    | 10 +++++++++-
 gradle.properties                              |  2 +-
 src/hivemq-extension/conf/config.xml           |  3 +++
 .../file/configuration/ConfigArchiver.java     | 10 +++++++++-
 .../CredentialsConfiguration.java              |  2 +-
 .../entities/ExtensionConfig.java              | 15 +++++++++++++++
 .../file/configuration/ConfigArchiverTest.java | 18 +++++++++++++++++-
 src/test/resources/test-extension-config.xml   |  3 ++-
 9 files changed, 59 insertions(+), 7 deletions(-)

diff --git a/.gitignore b/.gitignore
index a5b3e62..5fe2f3f 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,7 +1,8 @@
 # Gradle
 .gradle
 build/
-
+#VS Code
+.vscode/
 # IntelliJ
 out/
 *.iml
diff --git a/README.adoc b/README.adoc
index dda2869..5758092 100644
--- a/README.adoc
+++ b/README.adoc
@@ -216,7 +216,14 @@ The credentials configuration includes the following settings.
 
     <!-- Reload interval for credentials in seconds -->
     <credentials-reload-interval>60</credentials-reload-interval>
-
+    
+    <!-- Avoid save previous credentials.xml to archive folder       
+    Use this option to enable or disable save archive credentials.xml in case of replace
+        true (default) -> archiver enabled
+        false          -> archiver disabled
+    -->        
+    <archiver-enabled>true</archiver-enabled>
+    
     <!-- Optional list of names of listeners this extension is used for
     <listener-names>
         <listener-name>my-listener</listener-name>
@@ -238,6 +245,7 @@ The credentials configuration includes the following settings.
 |===
 |Configuration |Default |Description
 |`credentials-reload-interval` |`60` |Regular interval in seconds, in which the `credentials.xml` configuration file is checked for changes and reloaded.
+|`archiver-enabled` |`true` |Use this option to enable or disable save archive credentials.xml in case of replace.
 |`listener-names` |`null` |List of names of listeners, this extension will be used for. See {hivemq-listener}[HiveMQ config details^].
 |`password-type` |`HASHED` |How passwords are stored in the `credentials.xml` configuration file. Can either bei `PLAIN` for plain text passwords, or `HASHED` for a salted password hash.
 |`next-extension-instead-of-fail` |`false` |The outcome in case the RBAC could not authenticate the client successfully.
diff --git a/gradle.properties b/gradle.properties
index ae3b03c..8f10c51 100644
--- a/gradle.properties
+++ b/gradle.properties
@@ -1 +1 @@
-version=4.6.0
+version=4.6.1
diff --git a/src/hivemq-extension/conf/config.xml b/src/hivemq-extension/conf/config.xml
index a96aa4b..a918383 100644
--- a/src/hivemq-extension/conf/config.xml
+++ b/src/hivemq-extension/conf/config.xml
@@ -4,6 +4,9 @@
     <!-- Reload interval for credentials in seconds -->
     <credentials-reload-interval>60</credentials-reload-interval>
 
+    <!-- Avoid save old config to archive folder -->        
+    <archiver-enabled>true</archiver-enabled>
+
     <!-- Optional list of names of listeners this extension is used for
     <listener-names>
         <listener-name>my-listener</listener-name>
diff --git a/src/main/java/com/hivemq/extensions/rbac/file/configuration/ConfigArchiver.java b/src/main/java/com/hivemq/extensions/rbac/file/configuration/ConfigArchiver.java
index 56292f2..8df035d 100644
--- a/src/main/java/com/hivemq/extensions/rbac/file/configuration/ConfigArchiver.java
+++ b/src/main/java/com/hivemq/extensions/rbac/file/configuration/ConfigArchiver.java
@@ -19,6 +19,7 @@
 import com.hivemq.extension.sdk.api.annotations.NotNull;
 import com.hivemq.extension.sdk.api.annotations.Nullable;
 import com.hivemq.extension.sdk.api.annotations.ThreadSafe;
+import com.hivemq.extensions.rbac.file.configuration.entities.ExtensionConfig;
 import com.hivemq.extensions.rbac.file.configuration.entities.FileAuthConfig;
 import org.apache.commons.lang3.time.FastDateFormat;
 import org.slf4j.Logger;
@@ -35,11 +36,13 @@ class ConfigArchiver {
 
     private final @NotNull File archiveFolder;
     private final @NotNull XmlParser xmlParser;
+    private final @NotNull ExtensionConfig extensionConfig;
 
     ConfigArchiver(
-            final @NotNull File extensionHomeFolder, final @NotNull XmlParser xmlParser) {
+            final @NotNull File extensionHomeFolder, final @NotNull XmlParser xmlParser, final @NotNull ExtensionConfig extensionConfig) {
         this.xmlParser = xmlParser;
         archiveFolder = new File(extensionHomeFolder, "credentials-archive");
+        this.extensionConfig = extensionConfig;
     }
 
     /**
@@ -57,6 +60,11 @@ synchronized void archive(final @Nullable FileAuthConfig config) throws IOExcept
             LOG.debug("Configuration is invalid, archiving is not possible");
             return;
         }
+        //If someone don't want to create archive every time when he changed credentials.xml file. 
+        if (!this.extensionConfig.isArchiverEnabled()){
+            LOG.debug("Config Archiver is disabled , archiving is not enabled.");
+            return;
+        }
 
         //If someone's nasty and creates a file that looks like a folder
         if (archiveFolder.isFile()) {
diff --git a/src/main/java/com/hivemq/extensions/rbac/file/configuration/CredentialsConfiguration.java b/src/main/java/com/hivemq/extensions/rbac/file/configuration/CredentialsConfiguration.java
index e9269e1..3fbad29 100644
--- a/src/main/java/com/hivemq/extensions/rbac/file/configuration/CredentialsConfiguration.java
+++ b/src/main/java/com/hivemq/extensions/rbac/file/configuration/CredentialsConfiguration.java
@@ -67,7 +67,7 @@ public CredentialsConfiguration(
         final ReloadConfigFileTask reloadableTask = new ReloadConfigFileTask(//
                 unmodifiableList(callbacks) /* We don't want the task to modify the callbacks!*/,
                 configParser,
-                new ConfigArchiver(extensionHomeFolder, new XmlParser()),
+                new ConfigArchiver(extensionHomeFolder, new XmlParser(),extensionConfig),
                 this,
                 credentialsResolver);
         extensionExecutorService.scheduleWithFixedDelay(reloadableTask,
diff --git a/src/main/java/com/hivemq/extensions/rbac/file/configuration/entities/ExtensionConfig.java b/src/main/java/com/hivemq/extensions/rbac/file/configuration/entities/ExtensionConfig.java
index d21b7e4..d3ed44e 100644
--- a/src/main/java/com/hivemq/extensions/rbac/file/configuration/entities/ExtensionConfig.java
+++ b/src/main/java/com/hivemq/extensions/rbac/file/configuration/entities/ExtensionConfig.java
@@ -35,6 +35,9 @@ public class ExtensionConfig {
     @XmlElement(name = "credentials-reload-interval", defaultValue = "60")
     private int reloadInterval = 60;
 
+    @XmlElement(name = "archiver-enabled", defaultValue = "true")
+    private boolean archiverEnabled = true;
+
     @XmlElementWrapper(name = "listener-names")
     @XmlElement(name = "listener-name")
     private @Nullable Set<String> listenerNames;
@@ -50,10 +53,12 @@ public ExtensionConfig() {
 
     public ExtensionConfig(
             final int reloadInterval,
+            final boolean archiverEnabled,
             final @Nullable Set<String> listenerNames,
             final @Nullable PasswordType passwordType,
             final boolean nextExtensionInsteadOfFail) {
         this.reloadInterval = reloadInterval;
+        this.archiverEnabled = archiverEnabled;
         this.listenerNames = listenerNames;
         this.passwordType = passwordType;
         this.nextExtensionInsteadOfFail = nextExtensionInsteadOfFail;
@@ -67,6 +72,14 @@ public void setReloadInterval(final int reloadInterval) {
         this.reloadInterval = reloadInterval;
     }
 
+    public boolean isArchiverEnabled() {
+        return archiverEnabled;
+    }
+
+    public void setArchiverEnabled(final boolean archiverEnabled) {
+        this.archiverEnabled = archiverEnabled;
+    }
+
     public @Nullable Set<String> getListenerNames() {
         return listenerNames;
     }
@@ -88,6 +101,8 @@ public boolean isNextExtensionInsteadOfFail() {
         return "ExtensionConfig{" +
                 "reloadInterval=" +
                 reloadInterval +
+                "archiverEnabled=" +
+                archiverEnabled +
                 ", listenerNames=" +
                 listenerNames +
                 ", passwordType=" +
diff --git a/src/test/java/com/hivemq/extensions/rbac/file/configuration/ConfigArchiverTest.java b/src/test/java/com/hivemq/extensions/rbac/file/configuration/ConfigArchiverTest.java
index 558c6e6..a4822f0 100644
--- a/src/test/java/com/hivemq/extensions/rbac/file/configuration/ConfigArchiverTest.java
+++ b/src/test/java/com/hivemq/extensions/rbac/file/configuration/ConfigArchiverTest.java
@@ -17,6 +17,7 @@
 package com.hivemq.extensions.rbac.file.configuration;
 
 import com.hivemq.extension.sdk.api.annotations.NotNull;
+import com.hivemq.extensions.rbac.file.configuration.entities.ExtensionConfig;
 import com.hivemq.extensions.rbac.file.configuration.entities.FileAuthConfig;
 import com.hivemq.extensions.rbac.file.configuration.entities.Permission;
 import com.hivemq.extensions.rbac.file.configuration.entities.Role;
@@ -39,7 +40,7 @@ class ConfigArchiverTest {
     @BeforeEach
     void setUp(@TempDir final @NotNull File extensionFolder) {
         this.extensionFolder = extensionFolder;
-        configArchiver = new ConfigArchiver(extensionFolder, new XmlParser());
+        configArchiver = new ConfigArchiver(extensionFolder, new XmlParser(),new ExtensionConfig());
     }
 
     @Test
@@ -63,4 +64,19 @@ void test_archive() throws Exception {
         assertTrue(archivedFiles[0].getName().startsWith("20"));
         assertTrue(archivedFiles[0].getName().endsWith("credentials.xml"));
     }
+    @Test
+    void test_archiver_disabled() throws Exception {
+        final FileAuthConfig config = new FileAuthConfig();
+        config.setRoles(List.of(new Role("id1", List.of(new Permission("topic1")))));
+
+        ExtensionConfig extensionConfig= new ExtensionConfig();
+        extensionConfig.setArchiverEnabled(false);        
+        configArchiver = new ConfigArchiver(extensionFolder, new XmlParser(),extensionConfig);
+        configArchiver.archive(config);
+
+        final File[] files = extensionFolder.listFiles();
+        assertNotNull(files);
+        
+        assertEquals(0, files.length);
+    }
 }
diff --git a/src/test/resources/test-extension-config.xml b/src/test/resources/test-extension-config.xml
index 293dae7..a918b3f 100644
--- a/src/test/resources/test-extension-config.xml
+++ b/src/test/resources/test-extension-config.xml
@@ -21,7 +21,8 @@
 
     <!-- Reload interval for credentials -->
     <credentials-reload-interval>120</credentials-reload-interval>
-
+    <!-- Avoid save old config to archive folder -->        
+    <archiver-enabled>false</archiver-enabled>
     <!-- If the credentials file is using HASHED or PLAIN passwords -->
     <password-type>HASHED</password-type>