JAL-3141 improvement on BackupFilenameParts filename matching

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

diff --git a/src/jalview/io/BackupFilenameParts.java b/src/jalview/io/BackupFilenameParts.java
index 93aa602..4f93ece 100644 (file)
--- a/src/jalview/io/BackupFilenameParts.java
+++ b/src/jalview/io/BackupFilenameParts.java
@@ -1,42 +1,47 @@
 package jalview.io;
 
+import jalview.bin.Cache;
+
 import java.io.File;
 
 public class BackupFilenameParts
 {
-  String base;
+  private String base;
 
-  String templateStart;
+  private String templateStart;
 
-  int num;
+  private int num;
 
-  int digits;
+  private int digits;
 
-  String templateEnd;
+  private String templateEnd;
 
-  boolean isBackupFile;
+  private boolean isBackupFile;
 
-  public BackupFilenameParts(File file, String base, String template, int digits)
+  private BackupFilenameParts()
   {
-    this(file.getName(), base, template, digits);
+    this.isBackupFile = false;
   }
 
-  public BackupFilenameParts(String filename, String base, String template,
+  public BackupFilenameParts(File file, String base, String template,
           int digits)
   {
-    this.isBackupFile = false;
+    this(file.getName(), base, template, digits);
+  }
 
-    // calculate minimum length of a backup filename
-    int minlength = base.length() + template.length()
-            - BackupFiles.NUM_PLACEHOLDER.length() + digits ;
+  public BackupFilenameParts(String filename, String base, String template,
+          int suggesteddigits)
+  {
+    this(filename, base, template, suggesteddigits, false);
+  }
 
-    if (!(filename.startsWith(base) && filename.length() >= minlength))
-    {
-      // non-starter
-      return;
-    }
+  public BackupFilenameParts(String filename, String base, String template,
+          int suggesteddigits, boolean extensionMatch)
+  {
+    this.isBackupFile = false;
 
     int numcharstart = template.indexOf(BackupFiles.NUM_PLACEHOLDER);
+    int digits = 0;
     String templateStart = template;
     String templateEnd = "";
     if (numcharstart > -1)
@@ -44,27 +49,86 @@ public class BackupFilenameParts
       templateStart = template.substring(0, numcharstart);
       templateEnd = template.substring(
               numcharstart + BackupFiles.NUM_PLACEHOLDER.length());
+      digits = suggesteddigits;
+    }
+
+    String savedFilename = "";
+    // if extensionOnly is set then reset the filename to the last occurrence of the extension+templateStart and try the match
+    if (extensionMatch)
+    {
+      // only trying to match from extension onwards
+
+      int extensioncharstart = filename
+              .lastIndexOf('.' + base + templateStart);
+      if (extensioncharstart == -1)
+      {
+        return;
+      }
+
+      savedFilename = filename.substring(0, extensioncharstart + 1); // include
+                                                                     // the "."
+      filename = filename.substring(extensioncharstart + 1);
     }
-    
+
+    // full filename match
+
+    // calculate minimum length of a backup filename
+    int minlength = base.length() + template.length()
+            - BackupFiles.NUM_PLACEHOLDER.length() + digits;
+
+    if (!(filename.startsWith(base + templateStart)
+            && filename.endsWith(templateEnd)
+            && filename.length() >= minlength))
+    {
+      // non-starter
+      return;
+    }
+
     int startLength = base.length() + templateStart.length();
     int endLength = templateEnd.length();
-    String numString = filename.substring(startLength,
-            filename.length() - endLength);
+    String numString = numcharstart > -1
+            ? filename.substring(startLength, filename.length() - endLength)
+            : "";
 
     if (filename.length() >= startLength + digits + endLength
             && filename.startsWith(base + templateStart)
             && filename.endsWith(templateEnd)
-            && numString.matches("[0-9]+"))
+            // match exactly digits number of number-characters (numString
+            // should be all digits and at least the right length), or more than
+            // digits long with proviso it's not zero-leading.
+            && (numString.matches("[0-9]{" + digits + "}")
+                    || numString.matches("[1-9][0-9]{" + digits + ",}")))
     {
-      this.base = base;
+      this.base = extensionMatch ? savedFilename + base : base;
       this.templateStart = templateStart;
-      this.num = Integer.parseInt(numString);
+      this.num = numString.length() > 0 ? Integer.parseInt(numString) : 0;
       this.digits = digits;
-      this.templateStart = templateStart;
       this.templateEnd = templateEnd;
       this.isBackupFile = true;
     }
-    
+
+  }
+
+  public static BackupFilenameParts currentBackupFilenameParts(
+          String filename, String base, boolean extensionMatch)
+  {
+    BackupFilenameParts bfp = new BackupFilenameParts();
+    String template = Cache.getDefault(BackupFiles.SUFFIX, null);
+    if (template == null)
+    {
+      return bfp;
+    }
+    int digits;
+    try
+    {
+      digits = Integer
+              .parseInt(Cache.getDefault(BackupFiles.SUFFIX_DIGITS, null));
+    } catch (Exception e)
+    {
+      return bfp;
+    }
+    return new BackupFilenameParts(filename, base, template, digits,
+            extensionMatch);
   }
 
   public boolean isBackupFile()
@@ -76,4 +140,14 @@ public class BackupFilenameParts
   {
     return this.num;
   }
+
+  public static String getBackupFilename(int index, String base,
+          String template, int digits)
+  {
+    String numString = String.format("%0" + digits + "d", index);
+    String backupSuffix = template.replaceFirst(BackupFiles.NUM_PLACEHOLDER,
+            numString);
+    String backupfilename = base + backupSuffix;
+    return backupfilename;
+  }
 }