src/jalview/bin/Jalview.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.bin;
  22
  23 import jalview.ext.so.SequenceOntology;
  24 import jalview.gui.AlignFrame;
  25 import jalview.gui.Desktop;
  26 import jalview.gui.PromptUserConfig;
  27 import jalview.io.AppletFormatAdapter;
  28 import jalview.io.BioJsHTMLOutput;
  29 import jalview.io.DataSourceType;
  30 import jalview.io.FileFormat;
  31 import jalview.io.FileFormatException;
  32 import jalview.io.FileFormatI;
  33 import jalview.io.FileLoader;
  34 import jalview.io.HtmlSvgOutput;
  35 import jalview.io.IdentifyFile;
  36 import jalview.io.NewickFile;
  37 import jalview.io.gff.SequenceOntologyFactory;
  38 import jalview.schemes.ColourSchemeI;
  39 import jalview.schemes.ColourSchemeProperty;
  40 import jalview.util.MessageManager;
  41 import jalview.util.Platform;
  42 import jalview.ws.jws2.Jws2Discoverer;
  43
  44 import java.io.BufferedReader;
  45 import java.io.File;
  46 import java.io.FileOutputStream;
  47 import java.io.IOException;
  48 import java.io.InputStreamReader;
  49 import java.io.OutputStreamWriter;
  50 import java.io.PrintWriter;
  51 import java.net.MalformedURLException;
  52 import java.net.URI;
  53 import java.net.URISyntaxException;
  54 import java.net.URL;
  55 import java.security.AllPermission;
  56 import java.security.CodeSource;
  57 import java.security.PermissionCollection;
  58 import java.security.Permissions;
  59 import java.security.Policy;
  60 import java.util.HashMap;
  61 import java.util.Map;
  62 import java.util.Vector;
  63 import java.util.logging.ConsoleHandler;
  64 import java.util.logging.Level;
  65 import java.util.logging.Logger;
  66
  67 import javax.swing.LookAndFeel;
  68 import javax.swing.UIManager;
  69
  70 import com.threerings.getdown.util.LaunchUtil;
  71
  72 import groovy.lang.Binding;
  73 import groovy.util.GroovyScriptEngine;
  74
  75 /**
  76  * Main class for Jalview Application <br>
  77  * <br>
  78  * start with: java -classpath "$PATH_TO_LIB$/*:$PATH_TO_CLASSES$" \
  79  * jalview.bin.Jalview
  80  *
  81  * or on Windows: java -classpath "$PATH_TO_LIB$/*;$PATH_TO_CLASSES$" \
  82  * jalview.bin.Jalview jalview.bin.Jalview
  83  *
  84  * (ensure -classpath arg is quoted to avoid shell expansion of '*' and do not
  85  * embellish '*' to e.g. '*.jar')
  86  *
  87  * @author $author$
  88  * @version $Revision$
  89  */
  90 public class Jalview
  91 {
  92   static
  93   {
  94     Platform.getURLCommandArguments();
  95   }
  96
  97   // singleton instance of this class
  98
  99   private static Jalview instance;
 100
 101   private Desktop desktop;
 102
 103   public static AlignFrame currentAlignFrame;
 104
 105   static
 106   {
 107     if (!Platform.isJS())
 108     /**
 109      * Java only
 110      *
 111      * @j2sIgnore
 112      */
 113     {
 114       // grab all the rights we can for the JVM
 115             Policy.setPolicy(new Policy()
 116             {
 117               @Override
 118               public PermissionCollection getPermissions(CodeSource codesource)
 119               {
 120                 Permissions perms = new Permissions();
 121                 perms.add(new AllPermission());
 122                 return (perms);
 123               }
 124
 125               @Override
 126               public void refresh()
 127               {
 128               }
 129             });
 130     }
 131   }
 132
 133   /**
 134    * keep track of feature fetching tasks.
 135    *
 136    * @author JimP
 137    *
 138    */
 139   class FeatureFetcher
 140   {
 141     /*
 142      * TODO: generalise to track all jalview events to orchestrate batch
 143      * processing events.
 144      */
 145
 146     private int queued = 0;
 147
 148     private int running = 0;
 149
 150     public FeatureFetcher()
 151     {
 152
 153     }
 154
 155     public void addFetcher(final AlignFrame af,
 156             final Vector<String> dasSources)
 157     {
 158       final long id = System.currentTimeMillis();
 159       queued++;
 160       final FeatureFetcher us = this;
 161       new Thread(new Runnable()
 162       {
 163
 164         @Override
 165         public void run()
 166         {
 167           synchronized (us)
 168           {
 169             queued--;
 170             running++;
 171           }
 172
 173           af.setProgressBar(MessageManager
 174                   .getString("status.das_features_being_retrived"), id);
 175           af.featureSettings_actionPerformed(null);
 176           af.setProgressBar(null, id);
 177           synchronized (us)
 178           {
 179             running--;
 180           }
 181         }
 182       }).start();
 183     }
 184
 185     public synchronized boolean allFinished()
 186     {
 187       return queued == 0 && running == 0;
 188     }
 189
 190   }
 191
 192   public static Jalview getInstance()
 193   {
 194     return instance;
 195   }
 196
 197   /**
 198    * main class for Jalview application
 199    *
 200    * @param args
 201    *          open <em>filename</em>
 202    */
 203   public static void main(String[] args)
 204   {
 205 //      setLogging(); // BH - for event debugging in JavaScript
 206     instance = new Jalview();
 207     instance.doMain(args);
 208 }
 209
 210   private static void logClass(String name)
 211   {
 212           // BH - for event debugging in JavaScript
 213       ConsoleHandler consoleHandler = new ConsoleHandler();
 214       consoleHandler.setLevel(Level.ALL);
 215       Logger logger = Logger.getLogger(name);
 216       logger.setLevel(Level.ALL);
 217       logger.addHandler(consoleHandler);
 218   }
 219
 220   @SuppressWarnings("unused")
 221   private static void setLogging()
 222   {
 223
 224     /**
 225      * @j2sIgnore
 226      *
 227      */
 228     {
 229       System.out.println("not in js");
 230     }
 231
 232           // BH - for event debugging in JavaScript (Java mode only)
 233     if (!Platform.isJS())
 234     /**
 235      * Java only
 236      *
 237      * @j2sIgnore
 238      */
 239         {
 240                 Logger.getLogger("").setLevel(Level.ALL);
 241         logClass("java.awt.EventDispatchThread");
 242         logClass("java.awt.EventQueue");
 243         logClass("java.awt.Component");
 244         logClass("java.awt.focus.Component");
 245         logClass("java.awt.focus.DefaultKeyboardFocusManager");
 246         }
 247
 248   }
 249
 250
 251
 252
 253   /**
 254    * @param args
 255    */
 256   void doMain(String[] args)
 257   {
 258
 259     if (!Platform.isJS())
 260     {
 261       System.setSecurityManager(null);
 262     }
 263
 264     System.out
 265             .println("Java version: " + System.getProperty("java.version"));
 266     System.out.println(System.getProperty("os.arch") + " "
 267             + System.getProperty("os.name") + " "
 268             + System.getProperty("os.version"));
 269
 270     String appdirString = System.getProperty("getdownappdir");
 271     if (appdirString != null && appdirString.length() > 0)
 272     {
 273       final File appdir = new File(appdirString);
 274       new Thread()
 275       {
 276         @Override
 277         public void run()
 278         {
 279           LaunchUtil.upgradeGetdown(
 280                   new File(appdir, "getdown-launcher-old.jar"),
 281                   new File(appdir, "getdown-launcher.jar"),
 282                   new File(appdir, "getdown-launcher-new.jar"));
 283         }
 284       }.start();
 285
 286     }
 287     ArgsParser aparser = new ArgsParser(args);
 288     boolean headless = false;
 289
 290     String usrPropsFile = aparser.getValue("props");
 291     Cache.loadProperties(usrPropsFile); // must do this before
 292     if (usrPropsFile != null)
 293     {
 294       System.out.println(
 295               "CMD [-props " + usrPropsFile + "] executed successfully!");
 296     }
 297
 298     if (!Platform.isJS())
 299     /**
 300      * Java only
 301      *
 302      * @j2sIgnore
 303      */
 304     {
 305       if (aparser.contains("help") || aparser.contains("h"))
 306       {
 307         showUsage();
 308         System.exit(0);
 309       }
 310       if (aparser.contains("nodisplay") || aparser.contains("nogui")
 311               || aparser.contains("headless"))
 312       {
 313         System.setProperty("java.awt.headless", "true");
 314         headless = true;
 315       }
 316       // anything else!
 317
 318       final String jabawsUrl = aparser.getValue("jabaws");
 319       if (jabawsUrl != null)
 320       {
 321         try
 322         {
 323           Jws2Discoverer.getDiscoverer().setPreferredUrl(jabawsUrl);
 324           System.out.println(
 325                   "CMD [-jabaws " + jabawsUrl + "] executed successfully!");
 326         } catch (MalformedURLException e)
 327         {
 328           System.err.println(
 329                   "Invalid jabaws parameter: " + jabawsUrl + " ignored");
 330         }
 331       }
 332
 333     }
 334     String defs = aparser.getValue("setprop");
 335     while (defs != null)
 336     {
 337       int p = defs.indexOf('=');
 338       if (p == -1)
 339       {
 340         System.err.println("Ignoring invalid setprop argument : " + defs);
 341       }
 342       else
 343       {
 344         System.out.println("Executing setprop argument: " + defs);
 345         if (Platform.isJS())
 346         {
 347           Cache.setProperty(defs.substring(0,p), defs.substring(p+1));
 348         }
 349       }
 350       defs = aparser.getValue("setprop");
 351     }
 352     if (System.getProperty("java.awt.headless") != null
 353             && System.getProperty("java.awt.headless").equals("true"))
 354     {
 355       headless = true;
 356     }
 357     System.setProperty("http.agent",
 358             "Jalview Desktop/" + Cache.getDefault("VERSION", "Unknown"));
 359     try
 360     {
 361       Cache.initLogger();
 362     } catch (NoClassDefFoundError error)
 363     {
 364       error.printStackTrace();
 365       System.out.println("\nEssential logging libraries not found."
 366               + "\nUse: java -classpath \"$PATH_TO_LIB$/*:$PATH_TO_CLASSES$\" jalview.bin.Jalview");
 367       System.exit(0);
 368     }
 369
 370     desktop = null;
 371
 372     try
 373     {
 374       UIManager.setLookAndFeel(UIManager.getSystemLookAndFeelClassName());
 375     } catch (Exception ex)
 376     {
 377       System.err.println("Unexpected Look and Feel Exception");
 378       ex.printStackTrace();
 379     }
 380     if (Platform.isAMacAndNotJS())
 381     {
 382
 383       LookAndFeel lookAndFeel = ch.randelshofer.quaqua.QuaquaManager
 384               .getLookAndFeel();
 385       System.setProperty("com.apple.mrj.application.apple.menu.about.name",
 386               "Jalview");
 387       System.setProperty("apple.laf.useScreenMenuBar", "true");
 388       if (lookAndFeel != null)
 389       {
 390         try
 391         {
 392           UIManager.setLookAndFeel(lookAndFeel);
 393         } catch (Throwable e)
 394         {
 395           System.err.println(
 396                   "Failed to set QuaQua look and feel: " + e.toString());
 397         }
 398       }
 399       if (lookAndFeel == null || !(lookAndFeel.getClass()
 400               .isAssignableFrom(UIManager.getLookAndFeel().getClass()))
 401               || !UIManager.getLookAndFeel().getClass().toString()
 402                       .toLowerCase().contains("quaqua"))
 403       {
 404         try
 405         {
 406           System.err.println(
 407                   "Quaqua LaF not available on this plaform. Using VAqua(4).\nSee https://issues.jalview.org/browse/JAL-2976");
 408           UIManager.setLookAndFeel("org.violetlib.aqua.AquaLookAndFeel");
 409         } catch (Throwable e)
 410         {
 411           System.err.println(
 412                   "Failed to reset look and feel: " + e.toString());
 413         }
 414       }
 415     }
 416
 417     /*
 418      * configure 'full' SO model if preferences say to,
 419      * else use the default (SO Lite)
 420      */
 421     if (Cache.getDefault("USE_FULL_SO", false))
 422     {
 423       SequenceOntologyFactory.setInstance(new SequenceOntology());
 424     }
 425
 426     if (!headless)
 427     {
 428       desktop = new Desktop()
 429 //      {
 430 // // BH testing
 431 //        @Override
 432 //        protected void processEvent(AWTEvent e) {
 433 //                System.out.println("Jalview.java " + e);
 434 //                super.processEvent(e);
 435 //        }
 436 //       }
 437       ;
 438       desktop.setInBatchMode(true); // indicate we are starting up
 439
 440       try
 441       {
 442               if (! Platform.isJS())
 443                       /**
 444                        * Java only
 445                        *
 446                        * @j2sIgnore
 447                        */
 448               {
 449                 JalviewTaskbar.setTaskbar(this);
 450               }
 451       } catch (Exception e)
 452       {
 453         System.out.println("Cannot set Taskbar");
 454         // e.printStackTrace();
 455       } catch (Throwable t)
 456       {
 457         System.out.println("Cannot set Taskbar");
 458         // t.printStackTrace();
 459       }
 460
 461       desktop.setVisible(true);
 462
 463       if (!Platform.isJS())
 464       /**
 465        * Java only
 466        *
 467        * @j2sIgnore
 468        */
 469       {
 470         desktop.startServiceDiscovery();
 471         if (!aparser.contains("nousagestats"))
 472         {
 473           startUsageStats(desktop);
 474         }
 475         else
 476         {
 477           System.err.println("CMD [-nousagestats] executed successfully!");
 478         }
 479
 480         if (!aparser.contains("noquestionnaire"))
 481         {
 482           String url = aparser.getValue("questionnaire");
 483           if (url != null)
 484           {
 485             // Start the desktop questionnaire prompter with the specified
 486             // questionnaire
 487             Cache.log.debug("Starting questionnaire url at " + url);
 488             desktop.checkForQuestionnaire(url);
 489             System.out.println("CMD questionnaire[-" + url
 490                     + "] executed successfully!");
 491           }
 492           else
 493           {
 494             if (Cache.getProperty("NOQUESTIONNAIRES") == null)
 495             {
 496               // Start the desktop questionnaire prompter with the specified
 497               // questionnaire
 498               // String defurl =
 499               // "http://anaplog.compbio.dundee.ac.uk/cgi-bin/questionnaire.pl";
 500               // //
 501               String defurl = "http://www.jalview.org/cgi-bin/questionnaire.pl";
 502               Cache.log.debug(
 503                       "Starting questionnaire with default url: " + defurl);
 504               desktop.checkForQuestionnaire(defurl);
 505             }
 506           }
 507         }
 508         else
 509         {
 510           System.err
 511                   .println("CMD [-noquestionnaire] executed successfully!");
 512         }
 513
 514         if (!aparser.contains("nonews"))
 515         {
 516           desktop.checkForNews();
 517         }
 518
 519         BioJsHTMLOutput.updateBioJS();
 520       }
 521     }
 522
 523     String file = null, data = null;
 524     FileFormatI format = null;
 525     DataSourceType protocol = null;
 526     FileLoader fileLoader = new FileLoader(!headless);
 527
 528     String groovyscript = null; // script to execute after all loading is
 529     // completed one way or another
 530     // extract groovy argument and execute if necessary
 531     groovyscript = aparser.getValue("groovy", true);
 532     file = aparser.getValue("open", true);
 533
 534     if (file == null && desktop == null)
 535     {
 536       System.out.println("No files to open!");
 537       System.exit(1);
 538     }
 539     String vamsasImport = aparser.getValue("vdoc");
 540     String vamsasSession = aparser.getValue("vsess");
 541     if (vamsasImport != null || vamsasSession != null)
 542     {
 543       if (desktop == null || headless)
 544       {
 545         System.out.println(
 546                 "Headless vamsas sessions not yet supported. Sorry.");
 547         System.exit(1);
 548       }
 549       // if we have a file, start a new session and import it.
 550       boolean inSession = false;
 551       if (vamsasImport != null)
 552       {
 553         try
 554         {
 555           DataSourceType viprotocol = AppletFormatAdapter
 556                   .checkProtocol(vamsasImport);
 557           if (viprotocol == DataSourceType.FILE)
 558           {
 559             inSession = desktop.vamsasImport(new File(vamsasImport));
 560           }
 561           else if (viprotocol == DataSourceType.URL)
 562           {
 563             inSession = desktop.vamsasImport(new URL(vamsasImport));
 564           }
 565
 566         } catch (Exception e)
 567         {
 568           System.err.println("Exeption when importing " + vamsasImport
 569                   + " as a vamsas document.");
 570           e.printStackTrace();
 571         }
 572         if (!inSession)
 573         {
 574           System.err.println("Failed to import " + vamsasImport
 575                   + " as a vamsas document.");
 576         }
 577         else
 578         {
 579           System.out.println("Imported Successfully into new session "
 580                   + desktop.getVamsasApplication().getCurrentSession());
 581         }
 582       }
 583       if (vamsasSession != null)
 584       {
 585         if (vamsasImport != null)
 586         {
 587           // close the newly imported session and import the Jalview specific
 588           // remnants into the new session later on.
 589           desktop.vamsasStop_actionPerformed(null);
 590         }
 591         // now join the new session
 592         try
 593         {
 594           if (desktop.joinVamsasSession(vamsasSession))
 595           {
 596             System.out.println(
 597                     "Successfully joined vamsas session " + vamsasSession);
 598           }
 599           else
 600           {
 601             System.err.println("WARNING: Failed to join vamsas session "
 602                     + vamsasSession);
 603           }
 604         } catch (Exception e)
 605         {
 606           System.err.println(
 607                   "ERROR: Failed to join vamsas session " + vamsasSession);
 608           e.printStackTrace();
 609         }
 610         if (vamsasImport != null)
 611         {
 612           // the Jalview specific remnants can now be imported into the new
 613           // session at the user's leisure.
 614           Cache.log.info(
 615                   "Skipping Push for import of data into existing vamsas session."); // TODO:
 616           // enable
 617           // this
 618           // when
 619           // debugged
 620           // desktop.getVamsasApplication().push_update();
 621         }
 622       }
 623     }
 624     long progress = -1;
 625     // Finally, deal with the remaining input data.
 626     if (file != null)
 627     {
 628       if (!headless)
 629       {
 630         desktop.setProgressBar(
 631                 MessageManager
 632                         .getString("status.processing_commandline_args"),
 633                 progress = System.currentTimeMillis());
 634       }
 635       System.out.println("CMD [-open " + file + "] executed successfully!");
 636
 637       if (!Platform.isJS())
 638         /**
 639          * ignore in JavaScript -- can't just file existence - could load it?
 640          *
 641          * @j2sIgnore
 642          */
 643       {
 644         if (!file.startsWith("http://") && !file.startsWith("https://"))
 645         // BH 2019 added https check for Java
 646         {
 647           if (!(new File(file)).exists())
 648           {
 649             System.out.println("Can't find " + file);
 650             if (headless)
 651             {
 652               System.exit(1);
 653             }
 654           }
 655         }
 656       }
 657
 658         protocol = AppletFormatAdapter.checkProtocol(file);
 659
 660       try
 661       {
 662         format = new IdentifyFile().identify(file, protocol);
 663       } catch (FileFormatException e1)
 664       {
 665         // TODO ?
 666       }
 667
 668       AlignFrame af = fileLoader.LoadFileWaitTillLoaded(file, protocol,
 669               format);
 670       if (af == null)
 671       {
 672         System.out.println("error");
 673       }
 674       else
 675       {
 676         setCurrentAlignFrame(af);
 677         data = aparser.getValue("colour", true);
 678         if (data != null)
 679         {
 680           data.replaceAll("%20", " ");
 681
 682           ColourSchemeI cs = ColourSchemeProperty
 683                   .getColourScheme(af.getViewport(),
 684                           af.getViewport().getAlignment(), data);
 685
 686           if (cs != null)
 687           {
 688             System.out.println(
 689                     "CMD [-color " + data + "] executed successfully!");
 690           }
 691           af.changeColour(cs);
 692         }
 693
 694         // Must maintain ability to use the groups flag
 695         data = aparser.getValue("groups", true);
 696         if (data != null)
 697         {
 698           af.parseFeaturesFile(data,
 699                   AppletFormatAdapter.checkProtocol(data));
 700           // System.out.println("Added " + data);
 701           System.out.println(
 702                   "CMD groups[-" + data + "]  executed successfully!");
 703         }
 704         data = aparser.getValue("features", true);
 705         if (data != null)
 706         {
 707           af.parseFeaturesFile(data,
 708                   AppletFormatAdapter.checkProtocol(data));
 709           // System.out.println("Added " + data);
 710           System.out.println(
 711                   "CMD [-features " + data + "]  executed successfully!");
 712         }
 713
 714         data = aparser.getValue("annotations", true);
 715         if (data != null)
 716         {
 717           af.loadJalviewDataFile(data, null, null, null);
 718           // System.out.println("Added " + data);
 719           System.out.println(
 720                   "CMD [-annotations " + data + "] executed successfully!");
 721         }
 722         // set or clear the sortbytree flag.
 723         if (aparser.contains("sortbytree"))
 724         {
 725           af.getViewport().setSortByTree(true);
 726           if (af.getViewport().getSortByTree())
 727           {
 728             System.out.println("CMD [-sortbytree] executed successfully!");
 729           }
 730         }
 731         if (aparser.contains("no-annotation"))
 732         {
 733           af.getViewport().setShowAnnotation(false);
 734           if (!af.getViewport().isShowAnnotation())
 735           {
 736             System.out.println("CMD no-annotation executed successfully!");
 737           }
 738         }
 739         if (aparser.contains("nosortbytree"))
 740         {
 741           af.getViewport().setSortByTree(false);
 742           if (!af.getViewport().getSortByTree())
 743           {
 744             System.out
 745                     .println("CMD [-nosortbytree] executed successfully!");
 746           }
 747         }
 748         data = aparser.getValue("tree", true);
 749         if (data != null)
 750         {
 751           try
 752           {
 753             System.out.println(
 754                     "CMD [-tree " + data + "] executed successfully!");
 755             NewickFile nf = new NewickFile(data,
 756                     AppletFormatAdapter.checkProtocol(data));
 757             af.getViewport()
 758                     .setCurrentTree(af.showNewickTree(nf, data).getTree());
 759           } catch (IOException ex)
 760           {
 761             System.err.println("Couldn't add tree " + data);
 762             ex.printStackTrace(System.err);
 763           }
 764         }
 765         // TODO - load PDB structure(s) to alignment JAL-629
 766         // (associate with identical sequence in alignment, or a specified
 767         // sequence)
 768         if (groovyscript != null)
 769         {
 770           // Execute the groovy script after we've done all the rendering stuff
 771           // and before any images or figures are generated.
 772           System.out.println("Executing script " + groovyscript);
 773           executeGroovyScript(groovyscript, af);
 774           System.out.println("CMD groovy[" + groovyscript
 775                   + "] executed successfully!");
 776           groovyscript = null;
 777         }
 778         String imageName = "unnamed.png";
 779         while (aparser.getSize() > 1)
 780         {
 781           String outputFormat = aparser.nextValue();
 782           file = aparser.nextValue();
 783
 784           if (outputFormat.equalsIgnoreCase("png"))
 785           {
 786             af.createPNG(new File(file));
 787             imageName = (new File(file)).getName();
 788             System.out.println("Creating PNG image: " + file);
 789             continue;
 790           }
 791           else if (outputFormat.equalsIgnoreCase("svg"))
 792           {
 793             File imageFile = new File(file);
 794             imageName = imageFile.getName();
 795             af.createSVG(imageFile);
 796             System.out.println("Creating SVG image: " + file);
 797             continue;
 798           }
 799           else if (outputFormat.equalsIgnoreCase("html"))
 800           {
 801             File imageFile = new File(file);
 802             imageName = imageFile.getName();
 803             HtmlSvgOutput htmlSVG = new HtmlSvgOutput(af.alignPanel);
 804             htmlSVG.exportHTML(file);
 805
 806             System.out.println("Creating HTML image: " + file);
 807             continue;
 808           }
 809           else if (outputFormat.equalsIgnoreCase("biojsmsa"))
 810           {
 811             if (file == null)
 812             {
 813               System.err.println("The output html file must not be null");
 814               return;
 815             }
 816             try
 817             {
 818               BioJsHTMLOutput.refreshVersionInfo(
 819                       BioJsHTMLOutput.BJS_TEMPLATES_LOCAL_DIRECTORY);
 820             } catch (URISyntaxException e)
 821             {
 822               e.printStackTrace();
 823             }
 824             BioJsHTMLOutput bjs = new BioJsHTMLOutput(af.alignPanel);
 825             bjs.exportHTML(file);
 826             System.out
 827                     .println("Creating BioJS MSA Viwer HTML file: " + file);
 828             continue;
 829           }
 830           else if (outputFormat.equalsIgnoreCase("imgMap"))
 831           {
 832             af.createImageMap(new File(file), imageName);
 833             System.out.println("Creating image map: " + file);
 834             continue;
 835           }
 836           else if (outputFormat.equalsIgnoreCase("eps"))
 837           {
 838             File outputFile = new File(file);
 839             System.out.println(
 840                     "Creating EPS file: " + outputFile.getAbsolutePath());
 841             af.createEPS(outputFile);
 842             continue;
 843           }
 844
 845           af.saveAlignment(file, format);
 846           if (af.isSaveAlignmentSuccessful())
 847           {
 848             System.out.println("Written alignment in " + format
 849                     + " format to " + file);
 850           }
 851           else
 852           {
 853             System.out.println("Error writing file " + file + " in "
 854                     + format + " format!!");
 855           }
 856
 857         }
 858
 859         while (aparser.getSize() > 0)
 860         {
 861           System.out.println("Unknown arg: " + aparser.nextValue());
 862         }
 863       }
 864     }
 865     AlignFrame startUpAlframe = null;
 866     // We'll only open the default file if the desktop is visible.
 867     // And the user
 868     // ////////////////////
 869
 870     if (!Platform.isJS() && !headless && file == null
 871             && vamsasImport == null
 872             && jalview.bin.Cache.getDefault("SHOW_STARTUP_FILE", true))
 873     /**
 874      * Java only
 875      *
 876      * @j2sIgnore
 877      */
 878     {
 879       file = jalview.bin.Cache.getDefault("STARTUP_FILE",
 880               jalview.bin.Cache.getDefault("www.jalview.org",
 881                       "http://www.jalview.org")
 882                       + "/examples/exampleFile_2_7.jar");
 883       if (file.equals(
 884               "http://www.jalview.org/examples/exampleFile_2_3.jar"))
 885       {
 886         // hardwire upgrade of the startup file
 887         file.replace("_2_3.jar", "_2_7.jar");
 888         // and remove the stale setting
 889         jalview.bin.Cache.removeProperty("STARTUP_FILE");
 890       }
 891
 892       protocol = DataSourceType.FILE;
 893
 894       if (file.indexOf("http:") > -1)
 895       {
 896         protocol = DataSourceType.URL;
 897       }
 898
 899       if (file.endsWith(".jar"))
 900       {
 901         format = FileFormat.Jalview;
 902       }
 903       else
 904       {
 905         try
 906         {
 907           format = new IdentifyFile().identify(file, protocol);
 908         } catch (FileFormatException e)
 909         {
 910           // TODO what?
 911         }
 912       }
 913
 914       startUpAlframe = fileLoader.LoadFileWaitTillLoaded(file, protocol,
 915               format);
 916       // extract groovy arguments before anything else.
 917     }
 918
 919     // Once all other stuff is done, execute any groovy scripts (in order)
 920     if (groovyscript != null)
 921     {
 922       if (Cache.groovyJarsPresent())
 923       {
 924         System.out.println("Executing script " + groovyscript);
 925         executeGroovyScript(groovyscript, startUpAlframe);
 926       }
 927       else
 928       {
 929         System.err.println(
 930                 "Sorry. Groovy Support is not available, so ignoring the provided groovy script "
 931                         + groovyscript);
 932       }
 933     }
 934     // and finally, turn off batch mode indicator - if the desktop still exists
 935     if (desktop != null)
 936     {
 937       if (progress != -1)
 938       {
 939         desktop.setProgressBar(null, progress);
 940       }
 941       desktop.setInBatchMode(false);
 942     }
 943   }
 944
 945   private static void showUsage()
 946   {
 947     System.out.println(
 948             "Usage: jalview -open [FILE] [OUTPUT_FORMAT] [OUTPUT_FILE]\n\n"
 949                     + "-nodisplay\tRun Jalview without User Interface.\n"
 950                     + "-props FILE\tUse the given Jalview properties file instead of users default.\n"
 951                     + "-colour COLOURSCHEME\tThe colourscheme to be applied to the alignment\n"
 952                     + "-annotations FILE\tAdd precalculated annotations to the alignment.\n"
 953                     + "-tree FILE\tLoad the given newick format tree file onto the alignment\n"
 954                     + "-features FILE\tUse the given file to mark features on the alignment.\n"
 955                     + "-fasta FILE\tCreate alignment file FILE in Fasta format.\n"
 956                     + "-clustal FILE\tCreate alignment file FILE in Clustal format.\n"
 957                     + "-pfam FILE\tCreate alignment file FILE in PFAM format.\n"
 958                     + "-msf FILE\tCreate alignment file FILE in MSF format.\n"
 959                     + "-pileup FILE\tCreate alignment file FILE in Pileup format\n"
 960                     + "-pir FILE\tCreate alignment file FILE in PIR format.\n"
 961                     + "-blc FILE\tCreate alignment file FILE in BLC format.\n"
 962                     + "-json FILE\tCreate alignment file FILE in JSON format.\n"
 963                     + "-jalview FILE\tCreate alignment file FILE in Jalview format.\n"
 964                     + "-png FILE\tCreate PNG image FILE from alignment.\n"
 965                     + "-svg FILE\tCreate SVG image FILE from alignment.\n"
 966                     + "-html FILE\tCreate HTML file from alignment.\n"
 967                     + "-biojsMSA FILE\tCreate BioJS MSA Viewer HTML file from alignment.\n"
 968                     + "-imgMap FILE\tCreate HTML file FILE with image map of PNG image.\n"
 969                     + "-eps FILE\tCreate EPS file FILE from alignment.\n"
 970                     + "-questionnaire URL\tQueries the given URL for information about any Jalview user questionnaires.\n"
 971                     + "-noquestionnaire\tTurn off questionnaire check.\n"
 972                     + "-nonews\tTurn off check for Jalview news.\n"
 973                     + "-nousagestats\tTurn off google analytics tracking for this session.\n"
 974                     + "-sortbytree OR -nosortbytree\tEnable or disable sorting of the given alignment by the given tree\n"
 975                     // +
 976                     // "-setprop PROPERTY=VALUE\tSet the given Jalview property,
 977                     // after all other properties files have been read\n\t
 978                     // (quote the 'PROPERTY=VALUE' pair to ensure spaces are
 979                     // passed in correctly)"
 980                     + "-jabaws URL\tSpecify URL for Jabaws services (e.g. for a local installation).\n"
 981                     + "-fetchfrom nickname\tQuery nickname for features for the alignments and display them.\n"
 982                     // +
 983                     // "-vdoc vamsas-document\tImport vamsas document into new
 984                     // session or join existing session with same URN\n"
 985                     // + "-vses vamsas-session\tJoin session with given URN\n"
 986                     + "-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"
 987                     + "\n~Read documentation in Application or visit http://www.jalview.org for description of Features and Annotations file~\n\n");
 988   }
 989
 990   private static void startUsageStats(final Desktop desktop)
 991   {
 992     /**
 993      * start a User Config prompt asking if we can log usage statistics.
 994      */
 995     PromptUserConfig prompter = new PromptUserConfig(Desktop.desktop,
 996             "USAGESTATS", "Jalview Usage Statistics",
 997             "Do you want to help make Jalview better by enabling "
 998                     + "the collection of usage statistics with Google Analytics ?"
 999                     + "\n\n(you can enable or disable usage tracking in the preferences)",
1000             new Runnable()
1001             {
1002               @Override
1003               public void run()
1004               {
1005                 Cache.log.debug(
1006                         "Initialising googletracker for usage stats.");
1007                 Cache.initGoogleTracker();
1008                 Cache.log.debug("Tracking enabled.");
1009               }
1010             }, new Runnable()
1011             {
1012               @Override
1013               public void run()
1014               {
1015                 Cache.log.debug("Not enabling Google Tracking.");
1016               }
1017             }, null, true);
1018     desktop.addDialogThread(prompter);
1019   }
1020
1021   /**
1022    * Locate the given string as a file and pass it to the groovy interpreter.
1023    *
1024    * @param groovyscript
1025    *          the script to execute
1026    * @param jalviewContext
1027    *          the Jalview Desktop object passed in to the groovy binding as the
1028    *          'Jalview' object.
1029    */
1030   private void executeGroovyScript(String groovyscript, AlignFrame af)
1031   {
1032     /**
1033      * for scripts contained in files
1034      */
1035     File tfile = null;
1036     /**
1037      * script's URI
1038      */
1039     URL sfile = null;
1040     if (groovyscript.trim().equals("STDIN"))
1041     {
1042       // read from stdin into a tempfile and execute it
1043       try
1044       {
1045         tfile = File.createTempFile("jalview", "groovy");
1046         PrintWriter outfile = new PrintWriter(
1047                 new OutputStreamWriter(new FileOutputStream(tfile)));
1048         BufferedReader br = new BufferedReader(
1049                 new InputStreamReader(System.in));
1050         String line = null;
1051         while ((line = br.readLine()) != null)
1052         {
1053           outfile.write(line + "\n");
1054         }
1055         br.close();
1056         outfile.flush();
1057         outfile.close();
1058
1059       } catch (Exception ex)
1060       {
1061         System.err.println("Failed to read from STDIN into tempfile "
1062                 + ((tfile == null) ? "(tempfile wasn't created)"
1063                         : tfile.toString()));
1064         ex.printStackTrace();
1065         return;
1066       }
1067       try
1068       {
1069         sfile = tfile.toURI().toURL();
1070       } catch (Exception x)
1071       {
1072         System.err.println(
1073                 "Unexpected Malformed URL Exception for temporary file created from STDIN: "
1074                         + tfile.toURI());
1075         x.printStackTrace();
1076         return;
1077       }
1078     }
1079     else
1080     {
1081       try
1082       {
1083         sfile = new URI(groovyscript).toURL();
1084       } catch (Exception x)
1085       {
1086         tfile = new File(groovyscript);
1087         if (!tfile.exists())
1088         {
1089           System.err.println("File '" + groovyscript + "' does not exist.");
1090           return;
1091         }
1092         if (!tfile.canRead())
1093         {
1094           System.err.println("File '" + groovyscript + "' cannot be read.");
1095           return;
1096         }
1097         if (tfile.length() < 1)
1098         {
1099           System.err.println("File '" + groovyscript + "' is empty.");
1100           return;
1101         }
1102         try
1103         {
1104           sfile = tfile.getAbsoluteFile().toURI().toURL();
1105         } catch (Exception ex)
1106         {
1107           System.err.println("Failed to create a file URL for "
1108                   + tfile.getAbsoluteFile());
1109           return;
1110         }
1111       }
1112     }
1113     try
1114     {
1115       Map<String, java.lang.Object> vbinding = new HashMap<>();
1116       vbinding.put("Jalview", this);
1117       if (af != null)
1118       {
1119         vbinding.put("currentAlFrame", af);
1120       }
1121       Binding gbinding = new Binding(vbinding);
1122       GroovyScriptEngine gse = new GroovyScriptEngine(new URL[] { sfile });
1123       gse.run(sfile.toString(), gbinding);
1124       if ("STDIN".equals(groovyscript))
1125       {
1126         // delete temp file that we made -
1127         // only if it was successfully executed
1128         tfile.delete();
1129       }
1130     } catch (Exception e)
1131     {
1132       System.err.println("Exception Whilst trying to execute file " + sfile
1133               + " as a groovy script.");
1134       e.printStackTrace(System.err);
1135
1136     }
1137   }
1138
1139   public static boolean isHeadlessMode()
1140   {
1141     String isheadless = System.getProperty("java.awt.headless");
1142     if (isheadless != null && isheadless.equalsIgnoreCase("true"))
1143     {
1144       return true;
1145     }
1146     return false;
1147   }
1148
1149   public AlignFrame[] getAlignFrames()
1150   {
1151     return desktop == null ? new AlignFrame[] { getCurrentAlignFrame() }
1152             : Desktop.getAlignFrames();
1153
1154   }
1155
1156   /**
1157    * Quit method delegates to Desktop.quit - unless running in headless mode
1158    * when it just ends the JVM
1159    */
1160   public void quit()
1161   {
1162     if (desktop != null)
1163     {
1164       desktop.quit();
1165     }
1166     else
1167     {
1168       System.exit(0);
1169     }
1170   }
1171
1172   public static AlignFrame getCurrentAlignFrame()
1173   {
1174     return Jalview.currentAlignFrame;
1175   }
1176
1177   public static void setCurrentAlignFrame(AlignFrame currentAlignFrame)
1178   {
1179     Jalview.currentAlignFrame = currentAlignFrame;
1180   }
1181 }