From 4a3712de2f453cce145ddfd2b2308f42c8f57780 Mon Sep 17 00:00:00 2001
From: gmungoc <g.m.carstairs@dundee.ac.uk>
Date: Tue, 29 May 2018 17:33:08 +0100
Subject: [PATCH] JAL-3005 refactor updateRecentlyOpened to enable reuse

---
 src/jalview/io/FileLoader.java      |   77 ++++++++++++++++++++++-------------
 test/jalview/io/FileLoaderTest.java |   34 ++++++++++++++++
 2 files changed, 83 insertions(+), 28 deletions(-)

diff --git a/src/jalview/io/FileLoader.java b/src/jalview/io/FileLoader.java
index 798875f..66b51cd 100755
--- a/src/jalview/io/FileLoader.java
+++ b/src/jalview/io/FileLoader.java
@@ -43,13 +43,16 @@ import jalview.ws.utils.UrlDownloadClient;
 
 import java.io.File;
 import java.io.IOException;
+import java.util.ArrayList;
+import java.util.List;
 import java.util.StringTokenizer;
-import java.util.Vector;
 
 import javax.swing.SwingUtilities;
 
 public class FileLoader implements Runnable
 {
+  private static final String TAB = "\t";
+
   String file;
 
   DataSourceType protocol;
@@ -225,56 +228,69 @@ public class FileLoader implements Runnable
     }
   }
 
-  public void updateRecentlyOpened()
+  /**
+   * Updates (or creates) the tab-separated list of recently opened files held
+   * under the given property name by inserting the filePath at the front of the
+   * list. Duplicates are removed, and the list is limited to 11 entries. The
+   * method returns the updated value of the property.
+   * 
+   * @param filePath
+   * @param sourceType
+   */
+  public static String updateRecentlyOpened(String filePath,
+          DataSourceType sourceType)
   {
-    Vector recent = new Vector();
-    if (protocol == DataSourceType.PASTE)
+    if (sourceType != DataSourceType.FILE
+            && sourceType != DataSourceType.URL)
     {
-      // do nothing if the file was pasted in as text... there is no filename to
-      // refer to it as.
-      return;
+      return null;
     }
-    if (file != null
-            && file.indexOf(System.getProperty("java.io.tmpdir")) > -1)
+
+    String propertyName = sourceType == DataSourceType.FILE ? "RECENT_FILE"
+            : "RECENT_URL";
+    String historyItems = Cache.getProperty(propertyName);
+    if (filePath != null
+            && filePath.indexOf(System.getProperty("java.io.tmpdir")) > -1)
     {
       // ignore files loaded from the system's temporary directory
-      return;
+      return null;
     }
-    String type = protocol == DataSourceType.FILE ? "RECENT_FILE"
-            : "RECENT_URL";
 
-    String historyItems = jalview.bin.Cache.getProperty(type);
-
-    StringTokenizer st;
+    List<String> recent = new ArrayList<>();
 
     if (historyItems != null)
     {
-      st = new StringTokenizer(historyItems, "\t");
+      StringTokenizer st = new StringTokenizer(historyItems, TAB);
 
       while (st.hasMoreTokens())
       {
-        recent.addElement(st.nextElement().toString().trim());
+        String trimmed = st.nextToken().trim();
+        if (!recent.contains(trimmed))
+        {
+          recent.add(trimmed);
+        }
       }
     }
 
-    if (recent.contains(file))
+    /*
+     * if file was already in the list, it moves to the top
+     */
+    if (recent.contains(filePath))
     {
-      recent.remove(file);
+      recent.remove(filePath);
     }
 
-    StringBuffer newHistory = new StringBuffer(file);
+    StringBuilder newHistory = new StringBuilder(filePath);
     for (int i = 0; i < recent.size() && i < 10; i++)
     {
-      newHistory.append("\t");
-      newHistory.append(recent.elementAt(i));
+      newHistory.append(TAB);
+      newHistory.append(recent.get(i));
     }
 
-    Cache.setProperty(type, newHistory.toString());
+    String newProperty = newHistory.toString();
+    Cache.setProperty(propertyName, newProperty);
 
-    if (protocol == DataSourceType.FILE)
-    {
-      Cache.setProperty("DEFAULT_FILE_FORMAT", format.getName());
-    }
+    return newProperty;
   }
 
   @Override
@@ -539,7 +555,12 @@ public class FileLoader implements Runnable
         }
       }
 
-      updateRecentlyOpened();
+      updateRecentlyOpened(file, protocol);
+
+      if (protocol == DataSourceType.FILE && format != null)
+      {
+        Cache.setProperty("DEFAULT_FILE_FORMAT", format.getName());
+      }
 
     } catch (Exception er)
     {
diff --git a/test/jalview/io/FileLoaderTest.java b/test/jalview/io/FileLoaderTest.java
index 968901f..84bd714 100644
--- a/test/jalview/io/FileLoaderTest.java
+++ b/test/jalview/io/FileLoaderTest.java
@@ -1,5 +1,9 @@
 package jalview.io;
 
+import static org.testng.Assert.assertEquals;
+
+import jalview.bin.Cache;
+
 import org.junit.Assert;
 import org.testng.annotations.Test;
 
@@ -19,4 +23,34 @@ public class FileLoaderTest
     // Data source type expected to be DataSourceType.URL
     Assert.assertEquals(DataSourceType.URL, fileLoader.protocol);
   }
+
+  @Test(groups = "Functional")
+  public void testUpdateRecentlyOpened()
+  {
+    // ensure properties file is read-only
+    Cache.loadProperties("test/jalview/io/testProps.jvprops");
+
+    String recent = "RECENT_FILE";
+    Cache.removeProperty(recent);
+
+    String prop = FileLoader.updateRecentlyOpened("a/b/c",
+            DataSourceType.FILE);
+    assertEquals(prop, "a/b/c");
+
+    prop = FileLoader.updateRecentlyOpened("d/e/f", DataSourceType.FILE);
+    assertEquals(prop, "d/e/f\ta/b/c");
+
+    // revisiting a file moves it to the top of the list
+    prop = FileLoader.updateRecentlyOpened("a/b/c", DataSourceType.FILE);
+    assertEquals(prop, "a/b/c\td/e/f");
+    
+    // history list is limited to the most recent 11 items
+    for (int i = 0; i < 20; i++)
+    {
+      prop = FileLoader.updateRecentlyOpened(String.format("%d.fa", i),
+              DataSourceType.FILE);
+    }
+    assertEquals(prop,
+            "19.fa\t18.fa\t17.fa\t16.fa\t15.fa\t14.fa\t13.fa\t12.fa\t11.fa\t10.fa\t9.fa");
+  }
 }
-- 
1.7.10.2