From 1eb7d27d73beabe1a1b74fd088c1c3254a8066be Mon Sep 17 00:00:00 2001
From: jprocter <Jim Procter>
Date: Fri, 20 Aug 2010 11:56:45 +0000
Subject: [PATCH] wrapped code from URL retrieval tester as a function to
 determine correct protocol to retrieve data of a certain
 type from a datasource string. note - not rigourously
 tested

---
 src/jalview/io/AppletFormatAdapter.java |  190 +++++++++++++++++++++++++++++--
 1 file changed, 181 insertions(+), 9 deletions(-)

diff --git a/src/jalview/io/AppletFormatAdapter.java b/src/jalview/io/AppletFormatAdapter.java
index 5301ab6..42e881c 100755
--- a/src/jalview/io/AppletFormatAdapter.java
+++ b/src/jalview/io/AppletFormatAdapter.java
@@ -18,6 +18,7 @@
 package jalview.io;
 
 import java.io.File;
+import java.io.InputStream;
 
 import jalview.datamodel.*;
 
@@ -65,18 +66,22 @@ public class AppletFormatAdapter
    * corresponding to READABLE_FNAMES
    */
   public static final String[] READABLE_EXTENSIONS = new String[]
-  { "fa, fasta, fastq", "aln", "pfam", "msf", "pir", "blc", "amsa", "jar", "sto" }; // ,
-                                                                             // ".blast"
-                                                                             // };
+  { "fa, fasta, fastq", "aln", "pfam", "msf", "pir", "blc", "amsa", "jar",
+      "sto" }; // ,
+
+  // ".blast"
+  // };
 
   /**
    * List of readable formats by application in order corresponding to
    * READABLE_EXTENSIONS
    */
   public static final String[] READABLE_FNAMES = new String[]
-  { "Fasta", "Clustal", "PFAM", "MSF", "PIR", "BLC", "AMSA", "Jalview", "Stockholm" };// ,
-                                                                         // "SimpleBLAST"
-                                                                         // };
+  { "Fasta", "Clustal", "PFAM", "MSF", "PIR", "BLC", "AMSA", "Jalview",
+      "Stockholm" };// ,
+
+  // "SimpleBLAST"
+  // };
 
   public static String INVALID_CHARACTERS = "Contains invalid characters";
 
@@ -474,8 +479,8 @@ public class AppletFormatAdapter
           System.gc();
           long memf = -r.totalMemory() + r.freeMemory();
           long t1 = -System.currentTimeMillis();
-          Alignment al = afa.readFile(args[i], FILE, new IdentifyFile()
-                  .Identify(args[i], FILE));
+          Alignment al = afa.readFile(args[i], FILE,
+                  new IdentifyFile().Identify(args[i], FILE));
           t1 += System.currentTimeMillis();
           System.gc();
           memf += r.totalMemory() - r.freeMemory();
@@ -516,6 +521,173 @@ public class AppletFormatAdapter
       }
       i++;
     }
+  }
+
+  /**
+   * try to discover how to access the given file as a valid datasource that
+   * will be identified as the given type.
+   * 
+   * @param file
+   * @param format
+   * @return protocol that yields the data parsable as the given type
+   */
+  public static String resolveProtocol(String file, String format)
+  {
+    return resolveProtocol(file, format, false);
+  }
+
+  public static String resolveProtocol(String file, String format,
+          boolean debug)
+  {
+    // TODO: test thoroughly!
+    String protocol = null;
+    if (debug)
+    {
+      System.out.println("resolving datasource started with:\n>>file\n"
+              + file + ">>endfile");
+    }
 
+    // This might throw a security exception in certain browsers
+    // Netscape Communicator for instance.
+    try
+    {
+      boolean rtn = false;
+      InputStream is = System.getSecurityManager().getClass()
+              .getResourceAsStream("/" + file);
+      if (is != null)
+      {
+        rtn = true;
+        is.close();
+      }
+      if (debug)
+      {
+        System.err.println("Resource '" + file + "' was "
+                + (rtn ? "" : "not") + " located by classloader.");
+      }
+      ;
+      if (rtn)
+      {
+        protocol = AppletFormatAdapter.CLASSLOADER;
+      }
+
+    } catch (Exception ex)
+    {
+      System.err
+              .println("Exception checking resources: " + file + " " + ex);
+    }
+
+    if (file.indexOf("://") > -1)
+    {
+      protocol = AppletFormatAdapter.URL;
+    }
+    else
+    {
+      // skipping codebase prepend check.
+      protocol = AppletFormatAdapter.FILE;
+    }
+    FileParse fp = null;
+    try
+    {
+      if (debug)
+      {
+        System.out.println("Trying to get contents of resource as "
+                + protocol + ":");
+      }
+      fp = new FileParse(file, protocol);
+      if (!fp.isValid())
+      {
+        fp = null;
+      } else {
+      if (debug)
+      {
+        System.out.println("Successful.");
+      }}
+    } catch (Exception e)
+    {
+      if (debug)
+      {
+        System.err.println("Exception when accessing content: " + e);
+      }
+      fp = null;
+    }
+    if (fp == null)
+    {
+      if (debug)
+      {
+        System.out.println("Accessing as paste.");
+      }
+      protocol = AppletFormatAdapter.PASTE;
+      fp = null;
+      try
+      {
+        fp = new FileParse(file, protocol);
+        if (!fp.isValid())
+        {
+          fp = null;
+        }
+      } catch (Exception e)
+      {
+        System.err.println("Failed to access content as paste!");
+        e.printStackTrace();
+        fp = null;
+      }
+    }
+    if (fp == null)
+    {
+      return null;
+    }
+    if (format == null || format.length() == 0)
+    {
+      return protocol;
+    }
+    else
+    {
+      try
+      {
+        String idformat = new jalview.io.IdentifyFile().Identify(file,
+                protocol);
+        if (idformat == null)
+        {
+          if (debug)
+          {
+            System.out.println("Format not identified. Inaccessible file.");
+          }
+          return null;
+        }
+        if (debug)
+        {
+          System.out.println("Format identified as " + idformat
+                  + "and expected as " + format);
+        }
+        if (idformat.equals(format))
+        {
+          if (debug)
+          {
+            System.out.println("Protocol identified as " + protocol);
+          }
+          return protocol;
+        }
+        else
+        {
+          if (debug)
+          {
+            System.out
+                    .println("File deemed not accessible via " + protocol);
+          }
+          fp.close();
+          return null;
+        }
+      } catch (Exception e)
+      {
+        if (debug)
+        {
+          System.err.println("File deemed not accessible via " + protocol);
+          e.printStackTrace();
+        }
+        ;
+
+      }
+    }
+    return null;
   }
-}
+}
\ No newline at end of file
-- 
1.7.10.2