Add backups-log.txt logging system and version bump to 1.0.2 (release)

Author: SparklingComet

pom.xml

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

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

@@ -22,6 +22,8 @@
 import org.zeroturnaround.zip.ZipUtil;
 
 import java.io.File;
+import java.io.FileWriter;
+import java.io.IOException;
 import java.time.LocalDateTime;
 import java.util.HashSet;
 import java.util.LinkedHashMap;
@@ -33,7 +35,7 @@ public class AutoBackup extends JavaPlugin {
 
     private static AutoBackup plugin;
     private Set<BackupMode> backupModes, defaultModes;
-    private File root, backupsDir;
+    private File root, backupsDir, logFile;
 
     @Override
     public void onEnable() {
@@ -70,6 +72,9 @@ public void loadSettings() {
 
         root = getConfig().getBoolean("relative-paths") ? new File(new File(getDataFolder().getAbsoluteFile().getParent()).getParent()) : null;
         backupsDir = new File(root, getConfig().getString("backup-dir"));
+        if (getConfig().getBoolean("backup-log.enable")) {
+            logFile = new File(backupsDir, "backup-log.txt");
+        }
 
         loadBackups();
         scheduleAll();
@@ -87,7 +92,7 @@ public void scheduleAll() {
                     public void run() {
                         if (log) getServer().getConsoleSender().sendMessage(Message.SCHEDULED_BACKUP_LOG.toConsoleString()
                                 .replaceAll("%NAME%", getServer().getConsoleSender().getName()).replaceAll("%MODE%", mode.getName()));
-                        performBackup(mode, true);
+                        performBackup(mode, true, getConfig().getBoolean("backup-log.enable") ? "CONSOLE" : null);
                     }
                 }.runTaskTimer(this, getConfig().getBoolean("immediate-backup") ? 0 : period, period);
             }
@@ -102,7 +107,7 @@ public Set<BackupMode> getDefaultBackups() {
         return defaultModes;
     }
 
-    public boolean performBackup(BackupMode mode, boolean async) {
+    public boolean performBackup(BackupMode mode, boolean async, String logEntity) {
         if (!backupsDir.isDirectory()) {
             if (!backupsDir.mkdirs()) {
                 getLogger().log(Level.SEVERE, Message.DIR_NOT_CREATED.toConsoleString());
@@ -128,7 +133,6 @@ public void run() {
                         ZipUtil.pack(mode.getDir(), zipFile, s -> {
                             String path = mode.getDir().getAbsoluteFile().toPath().relativize(backupsDir.getAbsoluteFile().toPath()).toString();
                             if (s.startsWith(path)) {
-                            //    System.out.println(s);
                                 return null;
                             }
                             return s;
@@ -149,6 +153,26 @@ public void run() {
 
         if (async) runnable.runTaskAsynchronously(this);
         else runnable.runTask(this);
+
+        if (success[0] && getConfig().getBoolean("backup-log.enable")) {
+            try {
+                if (!logFile.exists()) {
+                    logFile.createNewFile();
+                }
+
+                FileWriter writer = new FileWriter(plugin.getLogFile(), true);
+                if (logEntity != null)
+                    writer.append(String.format("%s    (by %s)\n", zipName, logEntity));
+                else
+                    writer.append(zipName + "\n");
+
+                writer.flush();
+                writer.close();
+            } catch (IOException e) {
+                e.printStackTrace();
+            }
+        }
+
         return success[0];
     }
 
@@ -177,4 +201,8 @@ public boolean loadBackups() {
     public static AutoBackup getInstance() {
         return plugin;
     }
+
+    public File getLogFile() {
+        return logFile;
+    }
 }

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

@@ -21,6 +21,10 @@
 import org.bukkit.command.CommandSender;
 import org.bukkit.entity.Player;
 
+import java.io.FileWriter;
+import java.io.IOException;
+import java.io.OutputStreamWriter;
+
 public class BackupCommand implements CommandExecutor {
 
     private AutoBackup plugin;
@@ -103,8 +107,11 @@ else if (plugin.getConfig().getBoolean("log-to-console")) {
                 }
 
                 StringBuilder sb = new StringBuilder();
+                String name = sender.getName() +
+                        ((sender instanceof Player) ? " : " + ((Player) sender).getUniqueId().toString() : "");
+
                 for (BackupMode mode : plugin.getDefaultBackups()) {
-                    if (plugin.performBackup(mode, true)) {
+                    if (plugin.performBackup(mode, true, plugin.getConfig().getBoolean("backup-log.log-entity") ? name : null)) {
                         sb.append(mode.getName()).append("  ");
                         continue;
                     }
@@ -142,7 +149,9 @@ else if (args.length == 2) {
                             return true;
                         }
 
-                        if (plugin.performBackup(mode, true)) {
+                        String name = sender.getName() +
+                                ((sender instanceof Player) ? " : " + ((Player) sender).getUniqueId().toString() : "");
+                        if (plugin.performBackup(mode, true, plugin.getConfig().getBoolean("backup-log.log-entity") ? name : null)) {
                             if (sender instanceof Player) sender.sendMessage(Message.BACKUP_PERFORMING.toString() + mode.getName());
                             if (plugin.getConfig().getBoolean("log-to-console")) {
                                 plugin.getServer().getConsoleSender().sendMessage(Message.BACKUP_PERFORMING.toConsoleString() + mode.getName());

src/main/resources/config.yml

@@ -25,8 +25,16 @@ default-modes: ['overworld', 'nether', 'end']
 # Set to false at your own risk!
 exclude-backup: true
 
-# Determines where to save the backups. DO NOT CHANGE unless you are exporting the backups outside
-# the Minecraft server root.
+# Determines where to save the backups.
+# Warnings:
+# - DO NOT CHANGE unless you are exporting the backups outside!
+# - If you are storing backups inside the Minecraft server directory, DO NOT CHANGE this value once you have started
+#   taking backups, unless you erased those backups from where they used to be (as in exported them outside the
+#   Minecraft server root).
+# - Either way, DO NOT set this to the same path as the Minecraft server root! (Subdirectories, sibling and parent
+#   directories are fine).
+# If you do not wish to worry about these things, it is recommended you leave this setting to its default value
+# ('/backups').
 backup-dir: '/backups'
 
 # Determines whether the paths in this config are to be taken relative to the Minecraft server root
@@ -48,6 +56,12 @@ immediate-backup: false
 # (allow-manual option) is disabled.
 allow-force-console: true
 
+# Should AutoBackup log all backups to the backup-log.txt file? Should AutoBackup log which entity (player or console)
+# issued the backup?
+backup-log:
+  enable: true
+  log-entity: false
+
 # Use this configuration section to determine what is backed up.
 # Every list entry is a different backup mode. Feel free to add your own modes and remove the examples
 # you don't need.