Add compression level option

Author: SparklingComet

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>org.shanerx.backup</groupId>
     <artifactId>AutoBackup</artifactId>
-    <version>1.0.2</version>
+    <version>1.1.0</version>
     <description>Schedule and perform automatic backups</description>
 
     <properties>

src/main/java/org/shanerx/backup/AutoBackup.java

@@ -67,8 +67,6 @@ public void onDisable() {
     public void loadSettings() {
         saveDefaultConfig();
         getConfig().options().copyDefaults(true);
-        //reloadConfig();
-        //saveConfig();
 
         root = getConfig().getBoolean("relative-paths") ? new File(new File(getDataFolder().getAbsoluteFile().getParent()).getParent()) : null;
         backupsDir = new File(root, getConfig().getString("backup-dir"));
@@ -131,21 +129,24 @@ public void run() {
                     File zipFile = new File(backupsDir, zipName);
                     if (getConfig().getBoolean("exclude-backup")) {
                         ZipUtil.pack(mode.getDir(), zipFile, s -> {
-                            String path = mode.getDir().getAbsoluteFile().toPath().relativize(backupsDir.getAbsoluteFile().toPath()).toString();
+                            String path = mode.getDir().getAbsoluteFile().toPath().relativize(backupsDir
+                                    .getAbsoluteFile().toPath()).toString();
                             if (s.startsWith(path)) {
                                 return null;
                             }
                             return s;
-                        });
+                        }, mode.getCompressionLevel());
                     }
                     else {
-                        ZipUtil.pack(mode.getDir(), zipFile);
+                        ZipUtil.pack(mode.getDir(), zipFile, mode.getCompressionLevel());
                     }
 
-                    if (log) getServer().getConsoleSender().sendMessage(Message.BACKUP_SUCCESSFUL.toConsoleString() + mode.getName());
+                    if (log) getServer().getConsoleSender().sendMessage(Message.BACKUP_SUCCESSFUL.toConsoleString()
+                            + mode.getName());
                 } catch(Exception e){
                     e.printStackTrace();
-                    if (log) getServer().getConsoleSender().sendMessage(Message.BACKUP_FAILED.toConsoleString() + mode.getName());
+                    if (log) getServer().getConsoleSender().sendMessage(Message.BACKUP_FAILED.toConsoleString()
+                            + mode.getName());
                     success[0] = false;
                 }
             }
@@ -187,7 +188,9 @@ public boolean loadBackups() {
                     (String) map.get("name"),
                     new File(root, (String) map.get("dir")),
                     (Boolean) map.get("allow-manual"),
-                    (Integer) map.get("schedule")));
+                    (Integer) map.get("schedule"),
+                    (Integer) map.get("compression")
+            ));
         }
 
         for (BackupMode mode : backupModes) {

src/main/java/org/shanerx/backup/BackupMode.java

@@ -17,18 +17,41 @@
 package org.shanerx.backup;
 
 import java.io.File;
+import java.util.logging.Level;
+import java.util.zip.Deflater;
 
 public class BackupMode {
     private String name;
     private File dir;
     private boolean allowManual;
     private int schedule;
+    private int compressionLevel;
 
-    public BackupMode(String name, File dir, boolean allowManual, int schedule) {
+    public BackupMode(String name, File dir, boolean allowManual, int schedule, int compressionLevel) {
         this.name = name;
         this.dir = dir;
         this.allowManual = allowManual;
         this.schedule = Math.max(schedule, 0); // if <= 0 set to 0, otherwise to predefined value
+
+        switch (compressionLevel) {
+            case -1:
+                this.compressionLevel = Deflater.NO_COMPRESSION;
+                break;
+            case 0:
+                this.compressionLevel = Deflater.DEFAULT_COMPRESSION;
+                break;
+            case 1:
+                this.compressionLevel = Deflater.BEST_SPEED;
+                break;
+            case 2:
+                this.compressionLevel = Deflater.BEST_COMPRESSION;
+                break;
+            default:
+                AutoBackup.getInstance().getLogger().log(Level.WARNING,
+                    String.format("(Backup mode: %s) Invalid compression value: %d", name, compressionLevel));
+                this.compressionLevel = Deflater.DEFAULT_COMPRESSION;
+                break;
+        }
     }
 
     public String getName() {
@@ -46,4 +69,8 @@ public int getSchedule() {
     public boolean isAllowedManually() {
         return allowManual;
     }
+
+    public int getCompressionLevel() {
+        return compressionLevel;
+    }
 }

src/main/resources/config.yml

@@ -71,6 +71,12 @@ backup-log:
 # - The schedule option determines whether or not to perform the backup automatically every x minutes.
 #   If set to 0 or a negative integer, the scheduled backup is disabled.
 #   If set to a positive integer, the value indicates the time in minutes between every automatic backup.
+# - The compression option specifies the degree of the compression. Better compression means less disk space
+#   is occupied, but the backup itself takes longer.
+#   Possible settings: -1 (No compression); 0 (Default Compression); 1 (Best speed); 2 (Best Compression).
+#   Note: experimental results show that options 0 and 1 yield very similar results, although 0 has very slightly better
+#   compression and 1 has very slightly better speed. It is still possible that larger backup sizes lead to a divergence
+#   between these two.
 # NOTE: These are just (working) examples! You should add and tweak the ones you need and get rid of those you
 # do not need. In particular, the backup 'everything' is extremely inefficient and can take very long times. It
 # is therefore highly discouraged. You should rather setup separate smaller backups, ie. one for plugin data, one for
@@ -80,22 +86,27 @@ backup-modes:
     dir: '/'
     allow-manual: true
     schedule: 0
+    compression: 0
   - name: 'plugins'
     dir: '/plugins'
     allow-manual: false
     schedule: 0
+    compression: 0
   - name: 'overworld'
     dir: '/world'
     allow-manual: true
     schedule: 720
+    compression: 0
   - name: 'nether'
     dir: '/world_nether'
     allow-manual: true
     schedule: 1440
+    compression: 0
   - name: 'end'
     dir: '/world_the_end'
     allow-manual: true
     schedule: 2880
+    compression: 0
 
 # +-------------- End of Config --------------+
 # You are done configuring AutoBackup. Enjoy :)