JAL-3141 Code checkout. Not compiling.

[jalview.git] / src / jalview / io / BackupFiles.java

diff --git a/src/jalview/io/BackupFiles.java b/src/jalview/io/BackupFiles.java
index da5209b..39cd23e 100644 (file)
--- a/src/jalview/io/BackupFiles.java
+++ b/src/jalview/io/BackupFiles.java
@@ -4,6 +4,19 @@ import jalview.bin.Cache;
 
 import java.io.File;
 import java.io.IOException;
+import java.util.Arrays;
+import java.util.HashMap;
+import java.util.TreeMap;
+
+/*
+ * BackupFiles used for manipulating (naming rolling/deleting) backup/version files when an alignment or project file is saved.
+ * User configurable options are:
+ * BACKUPFILES_ENABLED - boolean flag as to whether to use this mechanism or act as before, including overwriting files as saved.
+ * BACKUPFILES_SUFFIX - a template to insert just before the file extension.  Use '%n' to be replaced by a 0-led SUFFIX_DIGITS long integer.
+ * BACKUPFILES_ROLL_MAX - the maximum number of backupfiles to keep for any one alignment or project file.
+ * BACKUPFILES_SUFFIX_DIGITS - the number of digits to insert replace %n with (e.g. BACKUPFILES_SUFFIX_DIGITS = 3 would make "001", "002", etc)
+ * BACKUPFILES_REVERSE_ORDER - if true then "logfile" style numbering and file rolling will occur. If false then ever-increasing version numbering will occur, but old files will still be deleted if there are more than ROLL_MAX backup files. 
+ */
 
 public class BackupFiles
 {
@@ -159,13 +172,21 @@ public class BackupFiles
     if (reverseOrder)
     {
       // backup style numbering
-      for (int m = 0; m < max; m++)
+
+      int tempMax = max;
+      // max == -1 means no limits
+      if (max == -1)
       {
-        int n = max - m;
-        numString = String.format("%0" + digits + "d", n);
-        String backupSuffix = suffix.replaceAll(NUM_PLACEHOLDER, numString);
-        String backupfilename = dir + File.separatorChar + basename
-                + backupSuffix + extension;
+        // do something cleverer here (possibly)!
+        tempMax = 10000;
+      }
+
+      for (int m = 0; m < tempMax; m++)
+      {
+        int n = tempMax - m;
+        String backupfilename = dir + File.separatorChar
+                + BackupFilenameParts.getBackupFilename(n, basename, suffix,
+                        digits, extension);
         File backupfile_n = new File(backupfilename);
 
         if (!backupfile_n.exists())
@@ -209,11 +230,60 @@ public class BackupFiles
       // reached)
 
       // find existing backup files
-      BackupFileFilter bff = new BackupFileFilter(basename, suffix, digits,
+      BackupFilenameFilter bff = new BackupFilenameFilter(basename, suffix,
+              digits,
               extension);
       File[] backupFiles = dirFile.listFiles(bff);
-
+      int nextIndexNum;
       
+      if (backupFiles.length == 0)
+      {
+        nextIndexNum = 1;
+      } else {
+
+        // and sort them (based on integer found in the suffix) using a
+        // precomputed Hashmap for speed
+        HashMap bfHashMap = new HashMap<Integer, File>();
+        for (int i = 0; i < backupFiles.length; i++)
+        {
+          File f = backupFiles[i];
+          BackupFilenameParts bfp = new BackupFilenameParts(f, basename, suffix, digits, extension);
+          bfHashMap.put(bfp.indexNum(), f);
+        }
+        TreeMap<Integer, File> bfTreeMap = new TreeMap<>();
+        bfTreeMap.putAll(bfHashMap);
+
+        bfTreeMap.values().toArray(backupFiles);
+        
+        // max value of -1 means keep all backup files
+        if (bfTreeMap.size() >= max && max != -1)
+        {
+          // need to delete some files to keep number of backups to designated
+          // max
+          int numToDelete = bfTreeMap.size() - max;
+          File[] filesToDelete = Arrays.copyOfRange(backupFiles, 0,
+                  numToDelete - 1);
+
+          /******************************************
+           * CONFIRM THESE DELETIONS WITH THE USER! *
+           ******************************************/
+          for (int i = 0; i < filesToDelete.length; i++)
+          {
+            File toDelete = filesToDelete[i];
+            toDelete.delete();
+          }
+
+        }
+
+        nextIndexNum = bfTreeMap.lastKey() + 1;
+
+        // Let's make the new backup file!! yay, got there at last!
+        String nextBackupFilename = dir + File.separatorChar
+                + BackupFilenameParts.getBackupFilename(nextIndexNum,
+                        basename, suffix, digits, extension);
+        File nextBackupFile = new File(nextBackupFilename);
+        ret = ret && file.renameTo(nextBackupFile);
+      }
     }
 
     return ret;