X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fbin%2FJalview.java;h=2efa0fb38c702027e3b0b81a237954ee15c4bedd;hb=bd678dba41df83658dcbd93b3ec57c46f0cd14c9;hp=f4b38d47a573042669da4219e994d809140f0cbb;hpb=58399507cc82e8c7940a8500af73c3ed1bdd720d;p=jalview.git diff --git a/src/jalview/bin/Jalview.java b/src/jalview/bin/Jalview.java index f4b38d4..2efa0fb 100755 --- a/src/jalview/bin/Jalview.java +++ b/src/jalview/bin/Jalview.java @@ -20,65 +20,249 @@ */ package jalview.bin; +import jalview.api.AlignCalcWorkerI; +import jalview.api.AlignFrameI; +import jalview.api.AlignViewportI; +import jalview.api.JalviewApp; +import jalview.api.StructureSelectionManagerProvider; +import jalview.bin.ApplicationSingletonProvider.ApplicationSingletonI; +import jalview.datamodel.ColumnSelection; +import jalview.datamodel.HiddenColumns; +import jalview.datamodel.PDBEntry; +import jalview.datamodel.SequenceGroup; +import jalview.datamodel.SequenceI; +import jalview.ext.so.SequenceOntology; import jalview.gui.AlignFrame; +import jalview.gui.AlignViewport; +import jalview.gui.AlignmentPanel; +import jalview.gui.CalculationChooser; import jalview.gui.Desktop; +import jalview.gui.Preferences; +import jalview.gui.PromptUserConfig; +import jalview.gui.StructureViewer; +import jalview.io.AppletFormatAdapter; import jalview.io.BioJsHTMLOutput; +import jalview.io.DataSourceType; +import jalview.io.FileFormat; +import jalview.io.FileFormatException; +import jalview.io.FileFormatI; +import jalview.io.FileFormats; +import jalview.io.FileLoader; import jalview.io.HtmlSvgOutput; +import jalview.io.IdentifyFile; +import jalview.io.NewickFile; +import jalview.io.gff.SequenceOntologyFactory; +import jalview.javascript.JSFunctionExec; +import jalview.javascript.MouseOverStructureListener; +import jalview.renderer.seqfeatures.FeatureRenderer; +import jalview.schemes.ColourSchemeI; +import jalview.schemes.ColourSchemeProperty; +import jalview.structure.SelectionSource; +import jalview.structure.VamsasSource; import jalview.util.MessageManager; import jalview.util.Platform; import jalview.ws.jws2.Jws2Discoverer; -import java.awt.event.ActionEvent; -import java.awt.event.ActionListener; +import java.applet.AppletContext; import java.io.BufferedReader; import java.io.File; import java.io.FileOutputStream; import java.io.IOException; +import java.io.InputStreamReader; import java.io.OutputStreamWriter; import java.io.PrintWriter; -import java.lang.reflect.Constructor; import java.net.MalformedURLException; import java.net.URI; +import java.net.URISyntaxException; import java.net.URL; -import java.net.URLDecoder; import java.security.AllPermission; import java.security.CodeSource; import java.security.PermissionCollection; import java.security.Permissions; import java.security.Policy; import java.util.HashMap; +import java.util.Hashtable; import java.util.Map; import java.util.Vector; +import javax.swing.LookAndFeel; import javax.swing.UIManager; -import javax.swing.UnsupportedLookAndFeelException; + +import groovy.lang.Binding; +import groovy.util.GroovyScriptEngine; +import netscape.javascript.JSObject; /** * Main class for Jalview Application
*
- * start with java -Djava.ext.dirs=$PATH_TO_LIB$ jalview.bin.Jalview + * start with: java -classpath "$PATH_TO_LIB$/*:$PATH_TO_CLASSES$" \ + * jalview.bin.Jalview + * + * or on Windows: java -classpath "$PATH_TO_LIB$/*;$PATH_TO_CLASSES$" \ + * jalview.bin.Jalview jalview.bin.Jalview + * + * (ensure -classpath arg is quoted to avoid shell expansion of '*' and do not + * embellish '*' to e.g. '*.jar') * * @author $author$ * @version $Revision$ */ -public class Jalview +public class Jalview implements ApplicationSingletonI, JalviewJSApi { + + public static Jalview getInstance() + { + return (Jalview) ApplicationSingletonProvider + .getInstance(Jalview.class); + } + + private Jalview() + { + } + + static + { + Platform.getURLCommandArguments(); + } + + private boolean headless; + + public static boolean isHeadlessMode() + { + return getInstance().headless; + } + + private Desktop desktop; + + private AlignFrame currentAlignFrame; + + public boolean isJavaAppletTag; + + public String appletResourcePath; + + JalviewAppLoader appLoader; + + protected JSFunctionExec jsFunctionExec; + + private boolean noCalculation, noMenuBar, noStatus; + + private boolean noAnnotation; + + public boolean getStartCalculations() + { + return !noCalculation; + } + + public boolean getAllowMenuBar() + { + return !noMenuBar; + } + + public boolean getShowStatus() + { + return !noStatus; + } + + public boolean getShowAnnotation() + { + return !noAnnotation; + } + + public static AlignFrame getCurrentAlignFrame() + { + return getInstance().currentAlignFrame; + } + + public static void setCurrentAlignFrame(AlignFrame currentAlignFrame) + { + getInstance().currentAlignFrame = currentAlignFrame; + } + static { - // grab all the rights we can the JVM - Policy.setPolicy(new Policy() + if (!Platform.isJS()) + /** + * Java only + * + * @j2sIgnore + */ { - public PermissionCollection getPermissions(CodeSource codesource) + // grab all the rights we can for the JVM + Policy.setPolicy(new Policy() { - Permissions perms = new Permissions(); - perms.add(new AllPermission()); - return (perms); - } + @Override + public PermissionCollection getPermissions(CodeSource codesource) + { + Permissions perms = new Permissions(); + perms.add(new AllPermission()); + return (perms); + } + + @Override + public void refresh() + { + } + }); + } + } + + /** + * keep track of feature fetching tasks. + * + * @author JimP + * + */ + class FeatureFetcher + { + /* + * TODO: generalise to track all jalview events to orchestrate batch + * processing events. + */ + + private int queued = 0; + + private int running = 0; - public void refresh() + public FeatureFetcher() + { + + } + + public void addFetcher(final AlignFrame af, + final Vector dasSources) + { + final long id = System.currentTimeMillis(); + queued++; + final FeatureFetcher us = this; + new Thread(new Runnable() { - } - }); + + @Override + public void run() + { + synchronized (us) + { + queued--; + running++; + } + + af.setProgressBar(MessageManager + .getString("status.das_features_being_retrived"), id); + af.featureSettings_actionPerformed(null); + af.setProgressBar(null, id); + synchronized (us) + { + running--; + } + } + }).start(); + } + + public synchronized boolean allFinished() + { + return queued == 0 && running == 0; + } + } /** @@ -89,43 +273,97 @@ public class Jalview */ public static void main(String[] args) { - System.out.println("Java version: " - + System.getProperty("java.version")); + // Platform.startJavaLogging(); + getInstance().doMain(args); + } + + + @SuppressWarnings("unused") + /** + * @param args + */ + void doMain(String[] args) + { + + boolean isJS = Platform.isJS(); + if (isJS) + { + Platform.setAppClass(this); + } + else + { + System.setSecurityManager(null); + } + + System.out + .println("Java version: " + System.getProperty("java.version")); System.out.println(System.getProperty("os.arch") + " " + System.getProperty("os.name") + " " + System.getProperty("os.version")); ArgsParser aparser = new ArgsParser(args); - boolean headless = false; - if (aparser.contains("help") || aparser.contains("h")) + String usrPropsFile = aparser.getValue(ArgsParser.PROPS); + Cache.loadProperties(usrPropsFile); + if (isJS) { - showUsage(); - System.exit(0); + isJavaAppletTag = aparser.isApplet(); + if (isJavaAppletTag) + { + Preferences.setAppletDefaults(); + Cache.loadProperties(usrPropsFile); // again, because we + // might be changing defaults here? + } + System.out.println( + " found: " + aparser.getValue("Info.j2sAppletID")); + appletResourcePath = aparser.getValue("Info.resourcePath"); } - if (aparser.contains("nodisplay") || aparser.contains("nogui") - || aparser.contains("headless")) + else + /** + * Java only + * + * @j2sIgnore + */ { - System.setProperty("java.awt.headless", "true"); - headless = true; - } - Cache.loadProperties(aparser.getValue("props")); // must do this before - // anything else! + if (usrPropsFile != null) + { + System.out.println( + "CMD [-props " + usrPropsFile + "] executed successfully!"); + } - final String jabawsUrl = aparser.getValue("jabaws"); - if (jabawsUrl != null) - { - try + if (aparser.contains("help") || aparser.contains("h")) { - Jws2Discoverer.getDiscoverer().setPreferredUrl(jabawsUrl); - } catch (MalformedURLException e) + showUsage(); + System.exit(0); + } + if (aparser.contains(ArgsParser.NODISPLAY) + || aparser.contains(ArgsParser.NOGUI) + || aparser.contains(ArgsParser.HEADLESS) + || "true".equals(System.getProperty("java.awt.headless"))) { - System.err.println("Invalid jabaws parameter: " + jabawsUrl - + " ignored"); + headless = true; } - } - String defs = aparser.getValue("setprop"); + // anything else! + + final String jabawsUrl = aparser.getValue(ArgsParser.JABAWS); + if (jabawsUrl != null) + { + try + { + Jws2Discoverer.getInstance().setPreferredUrl(jabawsUrl); + System.out.println( + "CMD [-jabaws " + jabawsUrl + "] executed successfully!"); + } catch (MalformedURLException e) + { + System.err.println( + "Invalid jabaws parameter: " + jabawsUrl + " ignored"); + } + } + + } + // check for property setting + String defs = aparser.getValue(ArgsParser.SETPROP); while (defs != null) { int p = defs.indexOf('='); @@ -136,303 +374,456 @@ public class Jalview else { System.out.println("Executing setprop argument: " + defs); - // DISABLED FOR SECURITY REASONS - // TODO: add a property to allow properties to be overriden by cli args - // Cache.setProperty(defs.substring(0,p), defs.substring(p+1)); + if (isJS) + { + Cache.setProperty(defs.substring(0, p), defs.substring(p + 1)); + } } - defs = aparser.getValue("setprop"); - } - if (System.getProperty("java.awt.headless") != null - && System.getProperty("java.awt.headless").equals("true")) - { - headless = true; + defs = aparser.getValue(ArgsParser.SETPROP); } System.setProperty("http.agent", "Jalview Desktop/" + Cache.getDefault("VERSION", "Unknown")); try { Cache.initLogger(); - } catch (java.lang.NoClassDefFoundError error) + } catch (NoClassDefFoundError error) { error.printStackTrace(); - System.out - .println("\nEssential logging libraries not found." - + "\nUse: java -Djava.ext.dirs=$PATH_TO_LIB$ jalview.bin.Jalview"); + System.out.println("\nEssential logging libraries not found." + + "\nUse: java -classpath \"$PATH_TO_LIB$/*:$PATH_TO_CLASSES$\" jalview.bin.Jalview"); System.exit(0); } - Desktop desktop = null; + desktop = null; try { - UIManager.setLookAndFeel(UIManager.getSystemLookAndFeelClassName()); + if (Platform.isWin()) + { + UIManager.setLookAndFeel( + headless ? "javax.swing.plaf.metal.MetalLookAndFeel" + : UIManager.getSystemLookAndFeelClassName()); +// UIManager.setLookAndFeel(UIManager.getSystemLookAndFeelClassName()); + } } catch (Exception ex) { + System.err.println("Unexpected Look and Feel Exception"); + ex.printStackTrace(); } - if (new Platform().isAMac()) + if (Platform.isAMacAndNotJS()) { + + LookAndFeel lookAndFeel = ch.randelshofer.quaqua.QuaquaManager + .getLookAndFeel(); System.setProperty("com.apple.mrj.application.apple.menu.about.name", "Jalview"); System.setProperty("apple.laf.useScreenMenuBar", "true"); - try + if (lookAndFeel != null) { - UIManager.setLookAndFeel(ch.randelshofer.quaqua.QuaquaManager - .getLookAndFeel()); - } catch (UnsupportedLookAndFeelException e) + try + { + UIManager.setLookAndFeel(lookAndFeel); + } catch (Throwable e) + { + System.err.println( + "Failed to set QuaQua look and feel: " + e.toString()); + } + } + if (lookAndFeel == null + || !(lookAndFeel.getClass().isAssignableFrom( + UIManager.getLookAndFeel().getClass())) + || !UIManager.getLookAndFeel().getClass().toString() + .toLowerCase().contains("quaqua")) { - // TODO Auto-generated catch block - e.printStackTrace(); + try + { + System.err.println( + "Quaqua LaF not available on this plaform. Using VAqua(4).\nSee https://issues.jalview.org/browse/JAL-2976"); + UIManager.setLookAndFeel("org.violetlib.aqua.AquaLookAndFeel"); + } catch (Throwable e) + { + System.err.println( + "Failed to reset look and feel: " + e.toString()); + } } } + /* + * configure 'full' SO model if preferences say to, + * else use the default (SO Lite) + */ + if (Cache.getDefault(Preferences.USE_FULL_SO, false)) + { + SequenceOntologyFactory.setSequenceOntology(new SequenceOntology()); + } + if (!headless) { - desktop = new Desktop(); + desktop = Desktop.getInstance(); desktop.setInBatchMode(true); // indicate we are starting up desktop.setVisible(true); - desktop.startServiceDiscovery(); - if (!aparser.contains("nousagestats")) - { - startUsageStats(desktop); - } - if (!aparser.contains("noquestionnaire")) + + if (!isJS) + /** + * Java only + * + * @j2sIgnore + */ { - String url = aparser.getValue("questionnaire"); - if (url != null) + desktop.startServiceDiscovery(); + if (!aparser.contains(ArgsParser.NOUSAGESTATS)) { - // Start the desktop questionnaire prompter with the specified - // questionnaire - Cache.log.debug("Starting questionnaire url at " + url); - desktop.checkForQuestionnaire(url); + startUsageStats(desktop); } else { - if (Cache.getProperty("NOQUESTIONNAIRES") == null) + System.err.println("CMD [-nousagestats] executed successfully!"); + } + + if (!aparser.contains(ArgsParser.NOQUESTIONNAIRE)) + { + String url = aparser.getValue(ArgsParser.QUESTIONNAIRE); + if (url != null) { // Start the desktop questionnaire prompter with the specified // questionnaire - // String defurl = - // "http://anaplog.compbio.dundee.ac.uk/cgi-bin/questionnaire.pl"; - // // - String defurl = "http://www.jalview.org/cgi-bin/questionnaire.pl"; - Cache.log.debug("Starting questionnaire with default url: " - + defurl); - desktop.checkForQuestionnaire(defurl); - + Cache.log.debug("Starting questionnaire url at " + url); + desktop.checkForQuestionnaire(url); + System.out.println("CMD questionnaire[-" + url + + "] executed successfully!"); + } + else + { + if (Cache.getProperty(Preferences.NOQUESTIONNAIRES) == null) + { + // Start the desktop questionnaire prompter with the specified + // questionnaire + // String defurl = + // "http://anaplog.compbio.dundee.ac.uk/cgi-bin/questionnaire.pl"; + // // + String defurl = "http://www.jalview.org/cgi-bin/questionnaire.pl"; + Cache.log.debug( + "Starting questionnaire with default url: " + defurl); + desktop.checkForQuestionnaire(defurl); + } } } + else + { + System.err + .println("CMD [-noquestionnaire] executed successfully!"); + } + + if (!aparser.contains(ArgsParser.NONEWS)) + { + desktop.checkForNews(); + } + + BioJsHTMLOutput.updateBioJS(); } - desktop.checkForNews(); } - BioJsHTMLOutput.updateBioJS(); + parseArguments(aparser, true); + } + + /** + * Allow an outside entity to initiate the second half of argument parsing + * (only). + * + * @param args + * @return null is good + */ + @Override + public Object parseArguments(String[] args) + { + + try + { + ArgsParser aparser = new ArgsParser(args); + return parseArguments(aparser, false); + } catch (Throwable t) + { + return t; + } + } + + /** + * + * @param aparser + * @param isStartup + * @return + */ + private Object parseArguments(ArgsParser aparser, boolean isStartup) + { + boolean isJS = Platform.isJS(); - String file = null, protocol = null, format = null, data = null; - jalview.io.FileLoader fileLoader = new jalview.io.FileLoader(); - Vector getFeatures = null; // vector of das source nicknames to fetch - // features from - // loading is done. - String groovyscript = null; // script to execute after all loading is + Desktop desktop = (headless ? null : Desktop.getInstance()); + // script to execute after all loading is // completed one way or another // extract groovy argument and execute if necessary - groovyscript = aparser.getValue("groovy", true); - file = aparser.getValue("open", true); + String groovyscript = (isJS ? null + : aparser.getValue(ArgsParser.GROOVY, true)); + String file = aparser.getValue(ArgsParser.OPEN, true); + // BH this here to allow split frame; not working as of 5/17/2019 + String file2 = aparser.getValue(ArgsParser.OPEN2, true); + String fileFormat = (isJavaAppletTag + ? aparser.getAppletValue("format", null) + : null); + FileFormatI format = null; + DataSourceType protocol = null; if (file == null && desktop == null) { System.out.println("No files to open!"); System.exit(1); } - String vamsasImport = aparser.getValue("vdoc"), vamsasSession = aparser - .getValue("vsess"); - if (vamsasImport != null || vamsasSession != null) + boolean haveImport = checkStartVamas(aparser); + // Finally, deal with the remaining input data. + long progress = -1; + if (file == null && isJavaAppletTag) { - if (desktop == null || headless) - { - System.out - .println("Headless vamsas sessions not yet supported. Sorry."); - System.exit(1); - } - // if we have a file, start a new session and import it. - boolean inSession = false; - if (vamsasImport != null) + // Maybe the sequences are added as parameters + StringBuffer data = new StringBuffer("PASTE"); + int i = 1; + while ((file = aparser.getAppletValue("sequence" + i, null)) != null) { - try - { - String viprotocol = jalview.io.AppletFormatAdapter - .checkProtocol(vamsasImport); - if (viprotocol == jalview.io.FormatAdapter.FILE) - { - inSession = desktop.vamsasImport(new File(vamsasImport)); - } - else if (viprotocol == jalview.io.FormatAdapter.URL) - { - inSession = desktop.vamsasImport(new URL(vamsasImport)); - } - - } catch (Exception e) - { - System.err.println("Exeption when importing " + vamsasImport - + " as a vamsas document."); - e.printStackTrace(); - } - if (!inSession) - { - System.err.println("Failed to import " + vamsasImport - + " as a vamsas document."); - } - else - { - System.out.println("Imported Successfully into new session " - + desktop.getVamsasApplication().getCurrentSession()); - } + data.append(file.toString() + "\n"); + i++; } - if (vamsasSession != null) + if (data.length() > 5) { - if (vamsasImport != null) - { - // close the newly imported session and import the Jalview specific - // remnants into the new session later on. - desktop.vamsasStop_actionPerformed(null); - } - // now join the new session - try - { - if (desktop.joinVamsasSession(vamsasSession)) - { - System.out.println("Successfully joined vamsas session " - + vamsasSession); - } - else - { - System.err.println("WARNING: Failed to join vamsas session " - + vamsasSession); - } - } catch (Exception e) - { - System.err.println("ERROR: Failed to join vamsas session " - + vamsasSession); - e.printStackTrace(); - } - if (vamsasImport != null) - { - // the Jalview specific remnants can now be imported into the new - // session at the user's leisure. - Cache.log - .info("Skipping Push for import of data into existing vamsas session."); // TODO: - // enable - // this - // when - // debugged - // desktop.getVamsasApplication().push_update(); - } + file = data.toString(); } } - long progress = -1; - // Finally, deal with the remaining input data. + + String data; + if (file != null) { + if (!headless) { - desktop.setProgressBar(MessageManager.getString("status.processing_commandline_args"), + desktop.setProgressBar( + MessageManager + .getString("status.processing_commandline_args"), progress = System.currentTimeMillis()); } - System.out.println("Opening file: " + file); - if (!file.startsWith("http://")) + if (!isJS) + /** + * ignore in JavaScript -- can't just check file existence - could load + * it? + * + * @j2sIgnore + */ { - if (!(new java.io.File(file)).exists()) + if (!file.startsWith("http://") && !file.startsWith("https://")) + // BH 2019 added https check for Java { - System.out.println("Can't find " + file); - if (headless) + if (!(new File(file)).exists()) { - System.exit(1); + System.out.println("Can't find " + file); + if (headless) + { + System.exit(1); + } } } } - protocol = jalview.io.AppletFormatAdapter.checkProtocol(file); + protocol = AppletFormatAdapter.checkProtocol(file); + + try + { + format = (isJavaAppletTag && fileFormat != null + ? FileFormats.getInstance().forName(fileFormat) + : null); + if (format == null) + { + format = new IdentifyFile().identify(file, protocol); + } + } catch (FileFormatException e1) + { + // TODO ? + } + + if (aparser.contains(ArgsParser.NOMENUBAR)) + { + noMenuBar = true; + System.out.println("CMD [nomenu] executed successfully!"); + } + + if (aparser.contains(ArgsParser.NOSTATUS)) + { + noStatus = true; + System.out.println("CMD [nostatus] executed successfully!"); + } - format = new jalview.io.IdentifyFile().Identify(file, protocol); + if (aparser.contains(ArgsParser.NOANNOTATION) + || aparser.contains(ArgsParser.NOANNOTATION2)) + { + noAnnotation = true; + System.out.println("CMD no-annotation executed successfully!"); + } + if (aparser.contains(ArgsParser.NOCALCULATION)) + { + noCalculation = true; + System.out.println("CMD [nocalculation] executed successfully!"); + } - AlignFrame af = fileLoader.LoadFileWaitTillLoaded(file, protocol, - format); + AlignFrame af = new FileLoader(!headless).loadFileWaitTillLoaded(file, + protocol, format); if (af == null) { System.out.println("error"); } else { - - data = aparser.getValue("colour", true); - if (data != null) + System.out + .println("CMD [-open " + file + "] executed successfully!"); + if (file2 != null) { - data.replaceAll("%20", " "); - - jalview.schemes.ColourSchemeI cs = jalview.schemes.ColourSchemeProperty - .getColour(af.getViewport().getAlignment(), data); - - if (cs == null) + protocol = AppletFormatAdapter.checkProtocol(file2); + try { - jalview.schemes.UserColourScheme ucs = new jalview.schemes.UserColourScheme( - "white"); - ucs.parseAppletParameter(data); - cs = ucs; + format = new IdentifyFile().identify(file2, protocol); + } catch (FileFormatException e1) + { + // TODO ? } - - System.out.println("colour is " + data); - af.changeColour(cs); - } + AlignFrame af2 = new FileLoader(!headless) + .loadFileWaitTillLoaded(file2, protocol, format); + if (af2 == null) + { + System.out.println("error"); + } + else + { + AlignViewport.openLinkedAlignmentAs(af, + af.getViewport().getAlignment(), + af2.getViewport().getAlignment(), "", + AlignViewport.SPLIT_FRAME); + System.out.println( + "CMD [-open2 " + file2 + "] executed successfully!"); + } + } + + setCurrentAlignFrame(af); + + // TODO: file2 How to implement file2 for the applet spit screen? + + data = aparser.getValue(ArgsParser.COLOUR, true); + if (data != null) + { + data.replaceAll("%20", " "); + + ColourSchemeI cs = ColourSchemeProperty.getColourScheme( + af.getViewport(), af.getViewport().getAlignment(), data); + + if (cs != null) + { + System.out.println( + "CMD [-color " + data + "] executed successfully!"); + } + af.changeColour(cs); + } // Must maintain ability to use the groups flag - data = aparser.getValue("groups", true); + data = aparser.getValue(ArgsParser.GROUPS, true); if (data != null) { af.parseFeaturesFile(data, - jalview.io.AppletFormatAdapter.checkProtocol(data)); - System.out.println("Added " + data); + AppletFormatAdapter.checkProtocol(data)); + // System.out.println("Added " + data); + System.out.println( + "CMD groups[-" + data + "] executed successfully!"); } - data = aparser.getValue("features", true); + data = aparser.getValue(ArgsParser.FEATURES, true); if (data != null) { af.parseFeaturesFile(data, - jalview.io.AppletFormatAdapter.checkProtocol(data)); - System.out.println("Added " + data); + AppletFormatAdapter.checkProtocol(data)); + // System.out.println("Added " + data); + System.out.println( + "CMD [-features " + data + "] executed successfully!"); } - data = aparser.getValue("annotations", true); + data = aparser.getValue(ArgsParser.ANNOTATIONS, true); if (data != null) { af.loadJalviewDataFile(data, null, null, null); - System.out.println("Added " + data); + // System.out.println("Added " + data); + System.out.println( + "CMD [-annotations " + data + "] executed successfully!"); + } + + if (aparser.contains(ArgsParser.SHOWOVERVIEW)) + { + af.overviewMenuItem_actionPerformed(null); + System.out.println("CMD [showoverview] executed successfully!"); } + // set or clear the sortbytree flag. - if (aparser.contains("sortbytree")) + if (aparser.contains(ArgsParser.SORTBYTREE)) { af.getViewport().setSortByTree(true); + if (af.getViewport().getSortByTree()) + { + System.out.println("CMD [-sortbytree] executed successfully!"); + } } - if (aparser.contains("no-annotation")) + + boolean doUpdateAnnotation = false; + + /** + * we do this earlier in JalviewJS because of a complication with + * SHOWOVERVIEW + * + * For now, just fixing this in JalviewJS. + * + * + * @j2sIgnore + * + */ { - af.getViewport().setShowAnnotation(false); + if (aparser.contains(ArgsParser.NOANNOTATION) + || aparser.contains(ArgsParser.NOANNOTATION2)) + { + af.getViewport().setShowAnnotation(false); + if (!af.getViewport().isShowAnnotation()) + { + doUpdateAnnotation = true; + System.out + .println("CMD no-annotation executed successfully!"); + } + } } - if (aparser.contains("nosortbytree")) + if (aparser.contains(ArgsParser.NOSORTBYTREE)) { af.getViewport().setSortByTree(false); + if (!af.getViewport().getSortByTree()) + { + doUpdateAnnotation = true; + System.out + .println("CMD [-nosortbytree] executed successfully!"); + } + } + if (doUpdateAnnotation) + { // BH 2019.07.24 + af.setMenusForViewport(); + af.alignPanel.updateLayout(); } - data = aparser.getValue("tree", true); + data = aparser.getValue(ArgsParser.TREE, true); if (data != null) { - jalview.io.NewickFile fin = null; try { - fin = new jalview.io.NewickFile(data, - jalview.io.AppletFormatAdapter.checkProtocol(data)); - if (fin != null) - { - af.getViewport().setCurrentTree( - af.ShowNewickTree(fin, data).getTree()); - System.out.println("Added tree " + data); - } + System.out.println( + "CMD [-tree " + data + "] executed successfully!"); + NewickFile nf = new NewickFile(data, + AppletFormatAdapter.checkProtocol(data)); + af.getViewport() + .setCurrentTree(af.showNewickTree(nf, data).getTree()); } catch (IOException ex) { System.err.println("Couldn't add tree " + data); @@ -442,103 +833,33 @@ public class Jalview // TODO - load PDB structure(s) to alignment JAL-629 // (associate with identical sequence in alignment, or a specified // sequence) - - getFeatures = checkDasArguments(aparser); - if (af != null && getFeatures != null) + if (isJavaAppletTag) { - FeatureFetcher ff = startFeatureFetching(getFeatures); - if (ff != null) - { - while (!ff.allFinished() || af.operationInProgress()) - { - // wait around until fetching is finished. - try - { - Thread.sleep(100); - } catch (Exception e) - { - - } - } - } - getFeatures = null; // have retrieved features - forget them now. + loadAppletParams(aparser, af); } - if (groovyscript != null) + else if (!isJS) + /** + * Java only + * + * @j2sIgnore + */ { - // Execute the groovy script after we've done all the rendering stuff - // and before any images or figures are generated. - if (jalview.bin.Cache.groovyJarsPresent()) + if (groovyscript != null) { + // Execute the groovy script after we've done all the rendering + // stuff + // and before any images or figures are generated. System.out.println("Executing script " + groovyscript); - executeGroovyScript(groovyscript, new Object[] - { desktop, af }); - } - else - { - System.err - .println("Sorry. Groovy Support is not available, so ignoring the provided groovy script " - + groovyscript); - } - groovyscript = null; - } - String imageName = "unnamed.png"; - while (aparser.getSize() > 1) - { - format = aparser.nextValue(); - file = aparser.nextValue(); - - if (format.equalsIgnoreCase("png")) - { - af.createPNG(new java.io.File(file)); - imageName = (new java.io.File(file)).getName(); - System.out.println("Creating PNG image: " + file); - continue; - } - else if (format.equalsIgnoreCase("svg")) - { - File imageFile = new java.io.File(file); - imageName = imageFile.getName(); - af.createSVG(imageFile); - System.out.println("Creating SVG image: " + file); - continue; - } - else if (format.equalsIgnoreCase("html")) - { - File imageFile = new java.io.File(file); - imageName = imageFile.getName(); - new HtmlSvgOutput(new java.io.File(file), af.alignPanel); - System.out.println("Creating HTML image: " + file); - continue; - } - else if (format.equalsIgnoreCase("imgMap")) - { - af.createImageMap(new java.io.File(file), imageName); - System.out.println("Creating image map: " + file); - continue; - } - else if (format.equalsIgnoreCase("eps")) - { - System.out.println("Creating EPS file: " + file); - af.createEPS(new java.io.File(file)); - continue; - } - - if (af.saveAlignment(file, format)) - { - System.out.println("Written alignment in " + format - + " format to " + file); + executeGroovyScript(groovyscript, af); + System.out.println("CMD groovy[" + groovyscript + + "] executed successfully!"); + groovyscript = null; } - else + checkOutputFile(aparser, af, format); + while (aparser.getSize() > 0) { - System.out.println("Error writing file " + file + " in " - + format + " format!!"); + System.out.println("Unknown arg: " + aparser.nextValue()); } - - } - - while (aparser.getSize() > 0) - { - System.out.println("Unknown arg: " + aparser.nextValue()); } } } @@ -547,15 +868,20 @@ public class Jalview // And the user // //////////////////// - if (!headless && file == null && vamsasImport == null + if (!isJS && !headless && file == null && !haveImport && jalview.bin.Cache.getDefault("SHOW_STARTUP_FILE", true)) + /** + * Java only + * + * @j2sIgnore + */ { - file = jalview.bin.Cache.getDefault( - "STARTUP_FILE", + file = jalview.bin.Cache.getDefault("STARTUP_FILE", jalview.bin.Cache.getDefault("www.jalview.org", "http://www.jalview.org") + "/examples/exampleFile_2_7.jar"); - if (file.equals("http://www.jalview.org/examples/exampleFile_2_3.jar")) + if (file.equals( + "http://www.jalview.org/examples/exampleFile_2_3.jar")) { // hardwire upgrade of the startup file file.replace("_2_3.jar", "_2_7.jar"); @@ -563,51 +889,45 @@ public class Jalview jalview.bin.Cache.removeProperty("STARTUP_FILE"); } - protocol = "File"; + protocol = DataSourceType.FILE; if (file.indexOf("http:") > -1) { - protocol = "URL"; + protocol = DataSourceType.URL; } if (file.endsWith(".jar")) { - format = "Jalview"; + format = FileFormat.Jalview; } else { - format = new jalview.io.IdentifyFile().Identify(file, protocol); + try + { + format = new IdentifyFile().identify(file, protocol); + } catch (FileFormatException e) + { + // TODO what? + } } - startUpAlframe = fileLoader.LoadFileWaitTillLoaded(file, protocol, - format); - getFeatures = checkDasArguments(aparser); + startUpAlframe = new FileLoader(!headless) + .loadFileWaitTillLoaded(file, protocol, format); // extract groovy arguments before anything else. } - // If the user has specified features to be retrieved, - // or a groovy script to be executed, do them if they - // haven't been done already - // fetch features for the default alignment - if (getFeatures != null) - { - if (startUpAlframe != null) - { - startFeatureFetching(getFeatures); - } - } + // Once all other stuff is done, execute any groovy scripts (in order) if (groovyscript != null) { - if (jalview.bin.Cache.groovyJarsPresent()) + if (Cache.groovyJarsPresent()) { System.out.println("Executing script " + groovyscript); - executeGroovyScript(groovyscript, new Object[] - { desktop, startUpAlframe }); + executeGroovyScript(groovyscript, startUpAlframe); } else { - System.err - .println("Sorry. Groovy Support is not available, so ignoring the provided groovy script " + System.err.println( + "Sorry. Groovy Support is not available, so ignoring the provided groovy script " + groovyscript); } } @@ -620,12 +940,194 @@ public class Jalview } desktop.setInBatchMode(false); } + + return null; + } + + private boolean checkStartVamas(ArgsParser aparser) + { + String vamsasImport = aparser.getValue(ArgsParser.VDOC); + String vamsasSession = aparser.getValue(ArgsParser.VSESS); + if (vamsasImport == null && vamsasSession == null) + { + return false; + } + if (desktop == null || headless) + { + System.out.println( + "Headless vamsas sessions not yet supported. Sorry."); + System.exit(1); + } + boolean haveImport = (vamsasImport != null); + if (haveImport) + { + // if we have a file, start a new session and import it. + boolean inSession = false; + try + { + DataSourceType viprotocol = AppletFormatAdapter + .checkProtocol(vamsasImport); + if (viprotocol == DataSourceType.FILE) + { + inSession = desktop.vamsasImport(new File(vamsasImport)); + } + else if (viprotocol == DataSourceType.URL) + { + inSession = desktop.vamsasImport(new URL(vamsasImport)); + } + + } catch (Exception e) + { + System.err.println("Exeption when importing " + vamsasImport + + " as a vamsas document."); + e.printStackTrace(); + } + if (!inSession) + { + System.err.println("Failed to import " + vamsasImport + + " as a vamsas document."); + } + else + { + System.out.println("Imported Successfully into new session " + + desktop.getVamsasApplication().getCurrentSession()); + } + } + if (vamsasSession != null) + { + if (vamsasImport != null) + { + // close the newly imported session and import the Jalview specific + // remnants into the new session later on. + desktop.vamsasStop_actionPerformed(null); + } + // now join the new session + try + { + if (desktop.joinVamsasSession(vamsasSession)) + { + System.out.println( + "Successfully joined vamsas session " + vamsasSession); + } + else + { + System.err.println("WARNING: Failed to join vamsas session " + + vamsasSession); + } + } catch (Exception e) + { + System.err.println( + "ERROR: Failed to join vamsas session " + vamsasSession); + e.printStackTrace(); + } + if (vamsasImport != null) + { + // the Jalview specific remnants can now be imported into the new + // session at the user's leisure. + Cache.log.info( + "Skipping Push for import of data into existing vamsas session."); + // TODO: + // enable + // this + // when + // debugged + // desktop.getVamsasApplication().push_update(); + } + } + return haveImport; + } + + private void checkOutputFile(ArgsParser aparser, AlignFrame af, + FileFormatI format) + { + String imageName = "unnamed.png"; + while (aparser.getSize() > 1) + { + // PNG filename + // SVG filename + // HTML filename + // biojsmsa filename + String outputFormat = aparser.nextValue(); + String file = aparser.nextValue(); + if (outputFormat.equalsIgnoreCase("png")) + { + af.createPNG(new File(file)); + imageName = (new File(file)).getName(); + System.out.println("Creating PNG image: " + file); + continue; + } + else if (outputFormat.equalsIgnoreCase("svg")) + { + File imageFile = new File(file); + imageName = imageFile.getName(); + af.createSVG(imageFile); + System.out.println("Creating SVG image: " + file); + continue; + } + else if (outputFormat.equalsIgnoreCase("html")) + { + File imageFile = new File(file); + imageName = imageFile.getName(); + HtmlSvgOutput htmlSVG = new HtmlSvgOutput(af.alignPanel); + htmlSVG.exportHTML(file); + + System.out.println("Creating HTML image: " + file); + continue; + } + else if (outputFormat.equalsIgnoreCase("biojsmsa")) + { + if (file == null) + { + System.err.println("The output html file must not be null"); + return; + } + try + { + BioJsHTMLOutput.refreshVersionInfo( + BioJsHTMLOutput.BJS_TEMPLATES_LOCAL_DIRECTORY); + } catch (URISyntaxException e) + { + e.printStackTrace(); + } + BioJsHTMLOutput bjs = new BioJsHTMLOutput(af.alignPanel); + bjs.exportHTML(file); + System.out.println("Creating BioJS MSA Viwer HTML file: " + file); + continue; + } + else if (outputFormat.equalsIgnoreCase("imgMap")) + { + af.createImageMap(new File(file), imageName); + System.out.println("Creating image map: " + file); + continue; + } + else if (outputFormat.equalsIgnoreCase("eps")) + { + File outputFile = new File(file); + System.out.println( + "Creating EPS file: " + outputFile.getAbsolutePath()); + af.createEPS(outputFile); + continue; + } + + af.saveAlignment(file, format); + if (af.isSaveAlignmentSuccessful()) + { + System.out.println( + "Written alignment in " + format + " format to " + file); + } + else + { + System.out.println("Error writing file " + file + " in " + format + + " format!!"); + } + + } } private static void showUsage() { - System.out - .println("Usage: jalview -open [FILE] [OUTPUT_FORMAT] [OUTPUT_FILE]\n\n" + System.out.println( + "Usage: jalview -open [FILE] [OUTPUT_FORMAT] [OUTPUT_FILE]\n\n" + "-nodisplay\tRun Jalview without User Interface.\n" + "-props FILE\tUse the given Jalview properties file instead of users default.\n" + "-colour COLOURSCHEME\tThe colourscheme to be applied to the alignment\n" @@ -639,25 +1141,29 @@ public class Jalview + "-pileup FILE\tCreate alignment file FILE in Pileup format\n" + "-pir FILE\tCreate alignment file FILE in PIR format.\n" + "-blc FILE\tCreate alignment file FILE in BLC format.\n" + + "-json FILE\tCreate alignment file FILE in JSON format.\n" + "-jalview FILE\tCreate alignment file FILE in Jalview format.\n" + "-png FILE\tCreate PNG image FILE from alignment.\n" + "-svg FILE\tCreate SVG image FILE from alignment.\n" + "-html FILE\tCreate HTML file from alignment.\n" + + "-biojsMSA FILE\tCreate BioJS MSA Viewer HTML file from alignment.\n" + "-imgMap FILE\tCreate HTML file FILE with image map of PNG image.\n" + "-eps FILE\tCreate EPS file FILE from alignment.\n" + "-questionnaire URL\tQueries the given URL for information about any Jalview user questionnaires.\n" + "-noquestionnaire\tTurn off questionnaire check.\n" + + "-nonews\tTurn off check for Jalview news.\n" + "-nousagestats\tTurn off google analytics tracking for this session.\n" + "-sortbytree OR -nosortbytree\tEnable or disable sorting of the given alignment by the given tree\n" // + - // "-setprop PROPERTY=VALUE\tSet the given Jalview property, after all other properties files have been read\n\t (quote the 'PROPERTY=VALUE' pair to ensure spaces are passed in correctly)" + // "-setprop PROPERTY=VALUE\tSet the given Jalview property, + // after all other properties files have been read\n\t + // (quote the 'PROPERTY=VALUE' pair to ensure spaces are + // passed in correctly)" + "-jabaws URL\tSpecify URL for Jabaws services (e.g. for a local installation).\n" - + "-dasserver nickname=URL\tAdd and enable a das server with given nickname\n\t\t\t(alphanumeric or underscores only) for retrieval of features for all alignments.\n" - + "\t\t\tSources that also support the sequence command may be specified by prepending the URL with sequence:\n" - + "\t\t\t e.g. sequence:http://localdas.somewhere.org/das/source)\n" + "-fetchfrom nickname\tQuery nickname for features for the alignments and display them.\n" // + - // "-vdoc vamsas-document\tImport vamsas document into new session or join existing session with same URN\n" + // "-vdoc vamsas-document\tImport vamsas document into new + // session or join existing session with same URN\n" // + "-vses vamsas-session\tJoin session with given URN\n" + "-groovy FILE\tExecute groovy script in FILE, after all other arguments have been processed (if FILE is the text 'STDIN' then the file will be read from STDIN)\n" + "\n~Read documentation in Application or visit http://www.jalview.org for description of Features and Annotations file~\n\n"); @@ -668,24 +1174,25 @@ public class Jalview /** * start a User Config prompt asking if we can log usage statistics. */ - jalview.gui.PromptUserConfig prompter = new jalview.gui.PromptUserConfig( - desktop.desktop, - "USAGESTATS", + PromptUserConfig prompter = new PromptUserConfig( + Desktop.getDesktopPane(), "USAGESTATS", "Jalview Usage Statistics", "Do you want to help make Jalview better by enabling " + "the collection of usage statistics with Google Analytics ?" + "\n\n(you can enable or disable usage tracking in the preferences)", new Runnable() { + @Override public void run() { - Cache.log - .debug("Initialising googletracker for usage stats."); + Cache.log.debug( + "Initialising googletracker for usage stats."); Cache.initGoogleTracker(); Cache.log.debug("Tracking enabled."); } }, new Runnable() { + @Override public void run() { Cache.log.debug("Not enabling Google Tracking."); @@ -703,14 +1210,8 @@ public class Jalview * the Jalview Desktop object passed in to the groovy binding as the * 'Jalview' object. */ - private static void executeGroovyScript(String groovyscript, - Object[] jalviewContext) + private void executeGroovyScript(String groovyscript, AlignFrame af) { - if (jalviewContext == null) - { - System.err - .println("Sorry. Groovy support is currently only available when running with the Jalview GUI enabled."); - } /** * for scripts contained in files */ @@ -725,10 +1226,10 @@ public class Jalview try { tfile = File.createTempFile("jalview", "groovy"); - PrintWriter outfile = new PrintWriter(new OutputStreamWriter( - new FileOutputStream(tfile))); + PrintWriter outfile = new PrintWriter( + new OutputStreamWriter(new FileOutputStream(tfile))); BufferedReader br = new BufferedReader( - new java.io.InputStreamReader(System.in)); + new InputStreamReader(System.in)); String line = null; while ((line = br.readLine()) != null) { @@ -741,8 +1242,8 @@ public class Jalview } catch (Exception ex) { System.err.println("Failed to read from STDIN into tempfile " - + ((tfile == null) ? "(tempfile wasn't created)" : tfile - .toString())); + + ((tfile == null) ? "(tempfile wasn't created)" + : tfile.toString())); ex.printStackTrace(); return; } @@ -751,8 +1252,8 @@ public class Jalview sfile = tfile.toURI().toURL(); } catch (Exception x) { - System.err - .println("Unexpected Malformed URL Exception for temporary file created from STDIN: " + System.err.println( + "Unexpected Malformed URL Exception for temporary file created from STDIN: " + tfile.toURI()); x.printStackTrace(); return; @@ -792,76 +1293,23 @@ public class Jalview } } } - boolean success = false; try { - /* - * The following code performs the GroovyScriptEngine invocation using - * reflection, and is equivalent to this fragment from the embedding - * groovy documentation on the groovy site: import - * groovy.lang.Binding; import groovy.util.GroovyScriptEngine; - * - * String[] roots = new String[] { "/my/groovy/script/path" }; - * GroovyScriptEngine gse = new GroovyScriptEngine(roots); Binding binding - * = new Binding(); binding.setVariable("input", "world"); - * gse.run("hello.groovy", binding); - */ - Class[] bspec; - Object[] binding; - int blen = ((jalviewContext[0] == null) ? 0 : 1) - + ((jalviewContext[1] == null) ? 0 : 1); - String cnames[] = new String[] - { "Jalview", "currentAlFrame" }; - bspec = new Class[blen * 2]; - binding = new Object[blen * 2]; - blen = 0; - ClassLoader cl = null; - Map vbinding = new HashMap(); - for (int jc = 0; jc < jalviewContext.length; jc++) - { - if (jalviewContext[jc] != null) - { - if (cl == null) - { - cl = jalviewContext[jc].getClass().getClassLoader(); - } - bspec[blen * 2] = String.class; - bspec[blen * 2 + 1] = Object.class; - binding[blen * 2] = cnames[jc]; - binding[blen * 2 + 1] = jalviewContext[jc]; - vbinding.put(cnames[jc], jalviewContext[jc]); - blen++; - } + Map vbinding = new HashMap<>(); + vbinding.put("Jalview", this); + if (af != null) + { + vbinding.put("currentAlFrame", af); } - Class gbindingc = cl.loadClass("groovy.lang.Binding"); - Constructor gbcons; - Object gbinding; - try + Binding gbinding = new Binding(vbinding); + GroovyScriptEngine gse = new GroovyScriptEngine(new URL[] { sfile }); + gse.run(sfile.toString(), gbinding); + if ("STDIN".equals(groovyscript)) { - gbcons = gbindingc.getConstructor(Map.class); - gbinding = gbcons.newInstance(vbinding); - } catch (NoSuchMethodException x) - { - // old style binding config - using series of string/object values to - // setVariable. - gbcons = gbindingc.getConstructor(); - gbinding = gbcons.newInstance(); - java.lang.reflect.Method setvar = gbindingc.getMethod( - "setVariable", bspec); - setvar.invoke(gbinding, binding); - } - - Class gsec = cl.loadClass("groovy.util.GroovyScriptEngine"); - Constructor gseccons = gsec.getConstructor(new Class[] - { URL[].class }); // String[].class }); - Object gse = gseccons.newInstance(new Object[] - { new URL[] - { sfile } }); // .toString() } }); - java.lang.reflect.Method run = gsec.getMethod("run", new Class[] - { String.class, gbindingc }); - run.invoke(gse, new Object[] - { sfile.toString(), gbinding }); - success = true; + // delete temp file that we made - + // only if it was successfully executed + tfile.delete(); + } } catch (Exception e) { System.err.println("Exception Whilst trying to execute file " + sfile @@ -869,276 +1317,750 @@ public class Jalview e.printStackTrace(System.err); } - if (success && groovyscript.equals("STDIN")) - { - // delete temp file that we made - but only if it was successfully - // executed - tfile.delete(); - } + } + + public AlignFrame[] getAlignFrames() + { + return desktop == null ? new AlignFrame[] { getCurrentAlignFrame() } + : Desktop.getAlignFrames(); + } /** - * Check commandline for any das server definitions or any fetchfrom switches - * - * @return vector of DAS source nicknames to retrieve from + * Quit method delegates to Desktop.quit - unless running in headless mode + * when it just ends the JVM */ - private static Vector checkDasArguments(ArgsParser aparser) + public void quit() { - Vector source = null; - String data; - String locsources = Cache.getProperty(Cache.DAS_LOCAL_SOURCE); - while ((data = aparser.getValue("dasserver", true)) != null) + if (jsFunctionExec != null) { - String nickname = null; - String url = null; - boolean seq = false, feat = true; - int pos = data.indexOf('='); - // determine capabilities - if (pos > 0) - { - nickname = data.substring(0, pos); - } - url = data.substring(pos + 1); - if (url != null - && (url.startsWith("http:") || url - .startsWith("sequence:http:"))) - { - if (nickname == null) - { - nickname = url; - } - if (locsources == null) - { - locsources = ""; - } - else - { - locsources += "\t"; - } - locsources = locsources + nickname + "|" + url; - System.err - .println("NOTE! dasserver parameter not yet really supported (got args of " - + nickname + "|" + url); - if (source == null) - { - source = new Vector(); - } - source.addElement(nickname); - } - } // loop until no more server entries are found. - if (locsources != null && locsources.indexOf('|') > -1) + jsFunctionExec.tidyUp(); + jsFunctionExec = null; + } + + if (desktop != null) { - Cache.log.debug("Setting local source list in properties file to:\n" - + locsources); - Cache.setProperty(Cache.DAS_LOCAL_SOURCE, locsources); + desktop.quit(); } - while ((data = aparser.getValue("fetchfrom", true)) != null) + else { - System.out.println("adding source '" + data + "'"); - if (source == null) - { - source = new Vector(); - } - source.addElement(data); + System.exit(0); } - return source; } /** - * start a feature fetcher for every alignment frame + * Get the SwingJS applet ID and combine that with the frameType * - * @param dasSources + * @param frameType + * "alignment", "desktop", etc., or null + * @return */ - private static FeatureFetcher startFeatureFetching(final Vector dasSources) + public static String getAppID(String frameType) { - FeatureFetcher ff = new FeatureFetcher(); - AlignFrame afs[] = Desktop.getAlignFrames(); - if (afs == null || afs.length == 0) - { - return null; - } - for (int i = 0; i < afs.length; i++) + String id = Cache.getProperty("Info.j2sAppletID"); + if (id == null) { - ff.addFetcher(afs[i], dasSources); + id = "jalview"; } - return ff; + return id + (frameType == null ? "" : "-" + frameType); } - public static boolean isHeadlessMode() + /** + * Handle all JalviewLite applet parameters + * + * @param aparser + * @param af + */ + private void loadAppletParams(ArgsParser aparser, AlignFrame af) { - String isheadless = System.getProperty("java.awt.headless"); - if (isheadless != null && isheadless.equalsIgnoreCase("true")) + JalviewApp app = new JalviewApp() { - return true; - } - return false; - } -} -/** - * Notes: this argParser does not distinguish between parameter switches, - * parameter values and argument text. If an argument happens to be identical to - * a parameter, it will be taken as such (even though it didn't have a '-' - * prefixing it). - * - * @author Andrew Waterhouse and JBP documented. - * - */ + // TODO BH 2019 + // + // These are methods that are in JalviewLite that various classes call + // but are not in JalviewLiteJsApi. Or, even if they are, other classes + // call + // them to JalviewLite directly. Some may not be necessary, but they have + // to + // be at least mentioned here, or the classes calling them should + // reference + // JalviewLite itself. -class rnabuttonlistener implements ActionListener -{ - public void actionPerformed(ActionEvent arg0) - { - System.out.println("Good idea ! "); + private boolean alignPDBStructures; // From JalviewLite; not implemented - } -} + private Hashtable> jsmessages; -class pbuttonlistener implements ActionListener -{ - public void actionPerformed(ActionEvent arg0) - { + private Hashtable jshashes; - } -} + @Override + public String getParameter(String name) + { + return aparser.getAppletValue(name, null); + } -class ArgsParser -{ - Vector vargs = null; + @Override + public boolean getDefaultParameter(String name, boolean def) + { + String stn; + return ((stn = getParameter(name)) == null ? def + : "true".equalsIgnoreCase(stn)); + } - public ArgsParser(String[] args) - { - vargs = new Vector(); - for (int i = 0; i < args.length; i++) - { - String arg = args[i].trim(); - if (arg.charAt(0) == '-') + /** + * Get the applet-like document base even though this is an application. + */ + @Override + public URL getDocumentBase() { - arg = arg.substring(1); + return Platform.getDocumentBase(); } - vargs.addElement(arg); - } - } - /** - * check for and remove first occurence of arg+parameter in arglist. - * - * @param arg - * @return return the argument following the given arg if arg was in list. - */ - public String getValue(String arg) - { - return getValue(arg, false); - } + /** + * Get the applet-like code base even though this is an application. + */ + @Override + public URL getCodeBase() + { + return Platform.getCodeBase(); + } - public String getValue(String arg, boolean utf8decode) - { - int index = vargs.indexOf(arg); - String dc = null, ret = null; - if (index != -1) - { - ret = vargs.elementAt(index + 1).toString(); - vargs.removeElementAt(index); - vargs.removeElementAt(index); - if (utf8decode && ret != null) + @Override + public AlignViewportI getViewport() { - try - { - dc = URLDecoder.decode(ret, "UTF-8"); - ret = dc; - } catch (Exception e) - { - // TODO: log failure to decode - } + return af.getViewport(); } - } - return ret; - } - /** - * check for and remove first occurence of arg in arglist. - * - * @param arg - * @return true if arg was present in argslist. - */ - public boolean contains(String arg) - { - if (vargs.contains(arg)) - { - vargs.removeElement(arg); - return true; - } - else - { - return false; - } + /** + * features + * + */ + @Override + public boolean parseFeaturesFile(String filename, + DataSourceType protocol) + { + return af.parseFeaturesFile(filename, protocol); + } + + /** + * scorefile + * + */ + @Override + public boolean loadScoreFile(String sScoreFile) throws IOException + { + af.loadJalviewDataFile(sScoreFile, null, null, null); + return true; + } + + /** + * annotations, jpredfile, jnetfile + * + */ + @Override + public void updateForAnnotations() + { + af.updateForAnnotations(); + } + + @Override + public void loadTree(NewickFile fin, String treeFile) + throws IOException + { + // n/a -- already done by standard Jalview command line processing + } + + @Override + public void setAlignPdbStructures(boolean defaultParameter) + { + alignPDBStructures = true; + } + + @Override + public void newStructureView(PDBEntry pdb, SequenceI[] seqs, + String[] chains, DataSourceType protocol) + { + StructureViewer.launchStructureViewer(af.alignPanel, pdb, seqs); + } + + @Override + public void setFeatureGroupState(String[] groups, boolean state) + { + af.setFeatureGroupState(groups, state); + } + + @Override + public void alignedStructureView(PDBEntry[] pdb, SequenceI[][] seqs, + String[][] chains, String[] protocols) + { + System.err.println( + "Jalview applet interface alignedStructureView not implemented"); + } + + @Override + public void newFeatureSettings() + { + System.err.println( + "Jalview applet interface newFeatureSettings not implemented"); + } + + private Vector jsExecQueue; + + @Override + public Vector getJsExecQueue(JSFunctionExec exec) + { + jsFunctionExec = exec; + return (jsExecQueue == null ? (jsExecQueue = new Vector<>()) + : jsExecQueue); + } + + @Override + public AppletContext getAppletContext() + { + // TODO Auto-generated method stub + return null; + } + + @Override + public boolean isJsfallbackEnabled() + { + // TODO Auto-generated method stub + return false; + } + + @Override + public JSObject getJSObject() + { + // TODO Auto-generated method stub + return null; + } + + @Override + public StructureSelectionManagerProvider getStructureSelectionManagerProvider() + { + // TODO Q: what exactly is this? BH + return null; + } + + @Override + public void updateColoursFromMouseOver(Object source, + MouseOverStructureListener mouseOverStructureListener) + { + // TODO Auto-generated method stub + + } + + @Override + public Object[] getSelectionForListener(SequenceGroup seqsel, + ColumnSelection colsel, HiddenColumns hidden, + SelectionSource source, Object alignFrame) + { + return appLoader.getSelectionForListener(getCurrentAlignFrame(), + seqsel, colsel, hidden, source, alignFrame); + } + + @Override + public String arrayToSeparatorList(String[] array) + { + return appLoader.arrayToSeparatorList(array); + } + + @Override + public Hashtable getJSHashes() + { + return (jshashes == null ? (jshashes = new Hashtable<>()) + : jshashes); + } + + @Override + public Hashtable> getJSMessages() + { + return (jsmessages == null ? (jsmessages = new Hashtable<>()) + : jsmessages); + } + + @Override + public Object getFrameForSource(VamsasSource source) + { + if (source != null) + { + AlignFrame af; + if (source instanceof jalview.gui.AlignViewport + && source == (af = getCurrentAlignFrame()).getViewport()) + { + // should be valid if it just generated an event! + return af; + } + // TODO: ensure that if '_af' is specified along with a handler + // function, then only events from that alignFrame are sent to that + // function + } + return null; + } + + @Override + public FeatureRenderer getNewFeatureRenderer(AlignViewportI vp) + { + return new jalview.gui.FeatureRenderer((AlignmentPanel) vp); + } + + }; + + appLoader = new JalviewAppLoader(true); + appLoader.load(app); } - public String nextValue() + /** + * + * @see jalview.bin.JalviewLiteJsApi#getSelectedSequences() + */ + @Override + public String getSelectedSequences() { - return vargs.remove(0).toString(); + return getSelectedSequencesFrom(getCurrentAlignFrame()); } - public int getSize() + /** + * + * @see jalview.bin.JalviewLiteJsApi#getSelectedSequences(java.lang.String) + */ + @Override + public String getSelectedSequences(String sep) { - return vargs.size(); + return getSelectedSequencesFrom(getCurrentAlignFrame(), sep); } -} + /** + * + * @see jalview.bin.JalviewLiteJsApi#getSelectedSequencesFrom(jalview.appletgui + * .AlignFrame) + */ + @Override + public String getSelectedSequencesFrom(AlignFrameI alf) + { + return getSelectedSequencesFrom(alf, null); + } -/** - * keep track of feature fetching tasks. - * - * @author JimP - * - */ -class FeatureFetcher -{ - /* - * TODO: generalise to track all jalview events to orchestrate batch - * processing events. + /** + * + * @see jalview.bin.JalviewLiteJsApi#getSelectedSequencesFrom(jalview.appletgui + * .AlignFrame, java.lang.String) */ + @Override + public String getSelectedSequencesFrom(AlignFrameI alf, String sep) + { + return appLoader.getSelectedSequencesFrom(alf, sep); + } - private int queued = 0; + /** + * + * @see jalview.bin.JalviewLiteJsApi#getSelectedSequencesFrom(jalview.appletgui + * .AlignFrame, java.lang.String) + */ + @Override + public void highlight(String sequenceId, String position, + String alignedPosition) + { + highlightIn(getCurrentAlignFrame(), sequenceId, position, + alignedPosition); + } - private int running = 0; + @Override + public void highlightIn(AlignFrameI alf, String sequenceId, + String position, String alignedPosition) + { + appLoader.highlightIn(alf, sequenceId, position, alignedPosition); + } - public FeatureFetcher() + @Override + public void select(String sequenceIds, String columns) { + selectIn(getCurrentAlignFrame(), sequenceIds, columns, null); + } + @Override + public void select(String sequenceIds, String columns, String sep) + { + selectIn(getCurrentAlignFrame(), sequenceIds, columns, sep); } - public void addFetcher(final AlignFrame af, final Vector dasSources) + @Override + public void selectIn(AlignFrameI alf, String sequenceIds, String columns) { - final long id = System.currentTimeMillis(); - queued++; - final FeatureFetcher us = this; - new Thread(new Runnable() - { + selectIn(alf, sequenceIds, columns, null); + } - public void run() - { - synchronized (us) - { - queued--; - running++; - } + @Override + public void selectIn(AlignFrameI alf, String sequenceIds, String columns, + String sep) + { + appLoader.selectIn(alf, sequenceIds, columns, sep); + } - af.setProgressBar(MessageManager.getString("status.das_features_being_retrived"), id); - af.featureSettings_actionPerformed(null); - af.featureSettings.fetchDasFeatures(dasSources, true); - af.setProgressBar(null, id); - synchronized (us) - { - running--; - } - } - }).start(); + @Override + public String getSelectedSequencesAsAlignment(String format, + String suffix) + { + return getSelectedSequencesAsAlignmentFrom(getCurrentAlignFrame(), + format, suffix); + } + + @Override + public String getSelectedSequencesAsAlignmentFrom(AlignFrameI alf, + String format, String sep) + { + return appLoader.getSelectedSequencesAsAlignmentFrom(alf, format, sep); + } + + @Override + public String getAlignmentOrder() + { + return getAlignmentFrom(getCurrentAlignFrame(), null); + } + + @Override + public String getAlignmentOrderFrom(AlignFrameI alf) + { + return getAlignmentFrom(alf, null); } - public synchronized boolean allFinished() + @Override + public String getAlignmentOrderFrom(AlignFrameI alf, String sep) { - return queued == 0 && running == 0; + return appLoader.getAlignmentOrderFrom(alf, sep); + } + + @Override + public String orderBy(String order, String undoName) + { + return orderBy(order, undoName, null); + } + + @Override + public String orderBy(String order, String undoName, String sep) + { + return orderAlignmentBy(getCurrentAlignFrame(), order, undoName, sep); + } + + @Override + public String orderAlignmentBy(AlignFrameI alf, String order, + String undoName, String sep) + { + return appLoader.orderAlignmentBy(alf, order, undoName, sep); + } + + @Override + public String getAlignment(String format) + { + return getAlignmentFrom(null, format, null); + } + + @Override + public String getAlignmentFrom(AlignFrameI alf, String format) + { + return getAlignmentFrom(alf, format, null); + } + + @Override + public String getAlignment(String format, String suffix) + { + return getAlignmentFrom(getCurrentAlignFrame(), format, suffix); + } + + @Override + public String getAlignmentFrom(AlignFrameI alf, String format, + String suffix) + { + return appLoader.getAlignmentFrom(alf, format, suffix); + } + + @Override + public void loadAnnotation(String annotation) + { + loadAnnotationFrom(getCurrentAlignFrame(), annotation); + } + + @Override + public void loadAnnotationFrom(AlignFrameI alf, String annotation) + { + appLoader.loadAnnotationFrom(alf, annotation); + } + + @Override + public void loadFeatures(String features, boolean autoenabledisplay) + { + loadFeaturesFrom(currentAlignFrame, features, autoenabledisplay); + } + + @Override + public boolean loadFeaturesFrom(AlignFrameI alf, String features, + boolean autoenabledisplay) + { + return appLoader.loadFeaturesFrom(alf, features, autoenabledisplay); + } + + @Override + public String getFeatures(String format) + { + return getFeaturesFrom(getCurrentAlignFrame(), format); + } + + @Override + public String getFeaturesFrom(AlignFrameI alf, String format) + { + return appLoader.getFeaturesFrom(alf, format); + } + + @Override + public String getAnnotation() + { + return getAnnotationFrom(getCurrentAlignFrame()); + } + + @Override + public String getAnnotationFrom(AlignFrameI alf) + { + return appLoader.getAnnotationFrom(alf); + } + + @Override + public AlignFrameI newView() + { + return newViewFrom(getCurrentAlignFrame(), null); + } + + @Override + public AlignFrameI newView(String name) + { + return newViewFrom(getCurrentAlignFrame(), name); + } + + @Override + public AlignFrameI newViewFrom(AlignFrameI alf) + { + return newViewFrom(alf, null); + } + + @Override + public AlignFrameI newViewFrom(AlignFrameI alf, String name) + { + return appLoader.newViewFrom(alf, name); + } + + @Override + public AlignFrameI loadAlignment(String text, String title) + { + return appLoader.loadAlignment(text, AlignFrame.DEFAULT_WIDTH, + AlignFrame.DEFAULT_HEIGHT, title); + } + + @Override + public boolean addPdbFile(AlignFrameI alFrame, String sequenceId, + String pdbEntryString, String pdbFile) + { + return appLoader.addPdbFile(alFrame, sequenceId, pdbEntryString, + pdbFile); + } + + @Override + public void scrollViewToIn(AlignFrameI alf, String topRow, + String leftHandColumn) + { + appLoader.scrollViewToIn(alf, topRow, leftHandColumn); + } + + @Override + public void scrollViewToRowIn(AlignFrameI alf, String topRow) + { + appLoader.scrollViewToRowIn(alf, topRow); + } + + @Override + public void scrollViewToColumnIn(AlignFrameI alf, String leftHandColumn) + { + appLoader.scrollViewToColumnIn(alf, leftHandColumn); + } + + @Override + public String getFeatureGroups() + { + return getFeatureGroupsOn(getCurrentAlignFrame()); + } + + @Override + public String getFeatureGroupsOn(AlignFrameI alf) + { + return appLoader.getFeatureGroupsOn(alf); + } + + @Override + public String getFeatureGroupsOfState(boolean visible) + { + return getFeatureGroupsOfStateOn(getCurrentAlignFrame(), visible); + } + + @Override + public String getFeatureGroupsOfStateOn(AlignFrameI alf, boolean visible) + { + return appLoader.getFeatureGroupsOfStateOn(alf, visible); + } + + @Override + public void setFeatureGroupStateOn(AlignFrameI alf, String groups, + boolean state) + { + setFeatureGroupStateOn(alf, groups, state); + } + + @Override + public void setFeatureGroupState(String groups, boolean state) + { + appLoader.setFeatureGroupStateOn(getCurrentAlignFrame(), groups, state); + } + + @Override + public String getSeparator() + { + return appLoader.getSeparator(); + } + + @Override + public void setSeparator(String separator) + { + appLoader.setSeparator(separator); + } + + @Override + public String getJsMessage(String messageclass, String viewId) + { + // see http://www.jalview.org/examples/jalviewLiteJs.html + return null; + } + + /** + * Open a new Tree panel on the desktop statically. Params are standard (not + * set by Groovy). No dialog is opened. + * + * @param af + * @param treeType + * @param modelName + * @return null, or the string "label.you_need_at_least_n_sequences" if number + * of sequences selected is inappropriate + */ + @Override + public Object openTreePanel(AlignFrame af, String treeType, + String modelName) + { + return CalculationChooser.openTreePanel(af, treeType, modelName, null); + } + + /** + * public static method for JalviewJS API to open a PCAPanel without + * necessarily using a dialog. + * + * @param af + * @param modelName + * @return the PCAPanel, or the string "label.you_need_at_least_n_sequences" + * if number of sequences selected is inappropriate + */ + @Override + public Object openPcaPanel(AlignFrame af, String modelName) + { + return CalculationChooser.openPcaPanel(af, modelName, null); + } + + @Override + public String getSelectedSequencesAsAlignment(String format, + boolean suffix) + { + return getSelectedSequencesAsAlignmentFrom(getCurrentAlignFrame(), + format, suffix); + } + + @Override + public String getSelectedSequencesAsAlignmentFrom(AlignFrameI alf, + String format, boolean suffix) + { + return appLoader.getSelectedSequencesAsAlignmentFrom(alf, format, + "" + suffix); + } + + @Override + public String arrayToSeparatorList(String[] array) + { + return appLoader.arrayToSeparatorList(array); + } + + @Override + public String[] separatorListToArray(String list) + { + return appLoader.separatorListToArray(list); + } + + //// probably not needed in JalviewJS -- From when Jmol and Jalview did not + //// have a direct connection? + + @Override + public void setMouseoverListener(String listener) + { + // TODO Auto-generated method stub + + } + + @Override + public void setMouseoverListener(AlignFrameI af, String listener) + { + // TODO Auto-generated method stub + + } + + @Override + public void setSelectionListener(String listener) + { + // TODO Auto-generated method stub + + } + + @Override + public void setSelectionListener(AlignFrameI af, String listener) + { + // TODO Auto-generated method stub + + } + + @Override + public void setStructureListener(String listener, String modelSet) + { + // TODO Auto-generated method stub + + } + + @Override + public void removeJavascriptListener(AlignFrameI af, String listener) + { + // TODO Auto-generated method stub + + } + + @Override + public void mouseOverStructure(String pdbResNum, String chain, + String pdbfile) + { + // TODO Auto-generated method stub + + } + + @Override + public void showOverview() + { + currentAlignFrame.overviewMenuItem_actionPerformed(null); + } + + public void notifyWorker(AlignCalcWorkerI worker, String status) + { + // System.out.println("Jalview worker " + worker.getClass().getSimpleName() + // + " " + status); } } +