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         JalviewTaskbar.setTaskbar(this);
 443       } catch (Exception e)
 444       {
 445         System.out.println("Cannot set Taskbar");
 446         // e.printStackTrace();
 447       } catch (Throwable t)
 448       {
 449         System.out.println("Cannot set Taskbar");
 450         // t.printStackTrace();
 451       }
 452
 453       desktop.setVisible(true);
 454
 455       if (!Platform.isJS())
 456       /**
 457        * Java only
 458        *
 459        * @j2sIgnore
 460        */
 461       {
 462         desktop.startServiceDiscovery();
 463         if (!aparser.contains("nousagestats"))
 464         {
 465           startUsageStats(desktop);
 466         }
 467         else
 468         {
 469           System.err.println("CMD [-nousagestats] executed successfully!");
 470         }
 471
 472         if (!aparser.contains("noquestionnaire"))
 473         {
 474           String url = aparser.getValue("questionnaire");
 475           if (url != null)
 476           {
 477             // Start the desktop questionnaire prompter with the specified
 478             // questionnaire
 479             Cache.log.debug("Starting questionnaire url at " + url);
 480             desktop.checkForQuestionnaire(url);
 481             System.out.println("CMD questionnaire[-" + url
 482                     + "] executed successfully!");
 483           }
 484           else
 485           {
 486             if (Cache.getProperty("NOQUESTIONNAIRES") == null)
 487             {
 488               // Start the desktop questionnaire prompter with the specified
 489               // questionnaire
 490               // String defurl =
 491               // "http://anaplog.compbio.dundee.ac.uk/cgi-bin/questionnaire.pl";
 492               // //
 493               String defurl = "http://www.jalview.org/cgi-bin/questionnaire.pl";
 494               Cache.log.debug(
 495                       "Starting questionnaire with default url: " + defurl);
 496               desktop.checkForQuestionnaire(defurl);
 497             }
 498           }
 499         }
 500         else
 501         {
 502           System.err
 503                   .println("CMD [-noquestionnaire] executed successfully!");
 504         }
 505
 506         if (!aparser.contains("nonews"))
 507         {
 508           desktop.checkForNews();
 509         }
 510
 511         BioJsHTMLOutput.updateBioJS();
 512       }
 513     }
 514
 515     String file = null, data = null;
 516     FileFormatI format = null;
 517     DataSourceType protocol = null;
 518     FileLoader fileLoader = new FileLoader(!headless);
 519
 520     String groovyscript = null; // script to execute after all loading is
 521     // completed one way or another
 522     // extract groovy argument and execute if necessary
 523     groovyscript = aparser.getValue("groovy", true);
 524     file = aparser.getValue("open", true);
 525
 526     if (file == null && desktop == null)
 527     {
 528       System.out.println("No files to open!");
 529       System.exit(1);
 530     }
 531     String vamsasImport = aparser.getValue("vdoc");
 532     String vamsasSession = aparser.getValue("vsess");
 533     if (vamsasImport != null || vamsasSession != null)
 534     {
 535       if (desktop == null || headless)
 536       {
 537         System.out.println(
 538                 "Headless vamsas sessions not yet supported. Sorry.");
 539         System.exit(1);
 540       }
 541       // if we have a file, start a new session and import it.
 542       boolean inSession = false;
 543       if (vamsasImport != null)
 544       {
 545         try
 546         {
 547           DataSourceType viprotocol = AppletFormatAdapter
 548                   .checkProtocol(vamsasImport);
 549           if (viprotocol == DataSourceType.FILE)
 550           {
 551             inSession = desktop.vamsasImport(new File(vamsasImport));
 552           }
 553           else if (viprotocol == DataSourceType.URL)
 554           {
 555             inSession = desktop.vamsasImport(new URL(vamsasImport));
 556           }
 557
 558         } catch (Exception e)
 559         {
 560           System.err.println("Exeption when importing " + vamsasImport
 561                   + " as a vamsas document.");
 562           e.printStackTrace();
 563         }
 564         if (!inSession)
 565         {
 566           System.err.println("Failed to import " + vamsasImport
 567                   + " as a vamsas document.");
 568         }
 569         else
 570         {
 571           System.out.println("Imported Successfully into new session "
 572                   + desktop.getVamsasApplication().getCurrentSession());
 573         }
 574       }
 575       if (vamsasSession != null)
 576       {
 577         if (vamsasImport != null)
 578         {
 579           // close the newly imported session and import the Jalview specific
 580           // remnants into the new session later on.
 581           desktop.vamsasStop_actionPerformed(null);
 582         }
 583         // now join the new session
 584         try
 585         {
 586           if (desktop.joinVamsasSession(vamsasSession))
 587           {
 588             System.out.println(
 589                     "Successfully joined vamsas session " + vamsasSession);
 590           }
 591           else
 592           {
 593             System.err.println("WARNING: Failed to join vamsas session "
 594                     + vamsasSession);
 595           }
 596         } catch (Exception e)
 597         {
 598           System.err.println(
 599                   "ERROR: Failed to join vamsas session " + vamsasSession);
 600           e.printStackTrace();
 601         }
 602         if (vamsasImport != null)
 603         {
 604           // the Jalview specific remnants can now be imported into the new
 605           // session at the user's leisure.
 606           Cache.log.info(
 607                   "Skipping Push for import of data into existing vamsas session."); // TODO:
 608           // enable
 609           // this
 610           // when
 611           // debugged
 612           // desktop.getVamsasApplication().push_update();
 613         }
 614       }
 615     }
 616     long progress = -1;
 617     // Finally, deal with the remaining input data.
 618     if (file != null)
 619     {
 620       if (!headless)
 621       {
 622         desktop.setProgressBar(
 623                 MessageManager
 624                         .getString("status.processing_commandline_args"),
 625                 progress = System.currentTimeMillis());
 626       }
 627       System.out.println("CMD [-open " + file + "] executed successfully!");
 628
 629       if (!Platform.isJS())
 630         /**
 631          * ignore in JavaScript -- can't just file existence - could load it?
 632          *
 633          * @j2sIgnore
 634          */
 635       {
 636         if (!file.startsWith("http://") && !file.startsWith("https://"))
 637         // BH 2019 added https check for Java
 638         {
 639           if (!(new File(file)).exists())
 640           {
 641             System.out.println("Can't find " + file);
 642             if (headless)
 643             {
 644               System.exit(1);
 645             }
 646           }
 647         }
 648       }
 649
 650         protocol = AppletFormatAdapter.checkProtocol(file);
 651
 652       try
 653       {
 654         format = new IdentifyFile().identify(file, protocol);
 655       } catch (FileFormatException e1)
 656       {
 657         // TODO ?
 658       }
 659
 660       AlignFrame af = fileLoader.LoadFileWaitTillLoaded(file, protocol,
 661               format);
 662       if (af == null)
 663       {
 664         System.out.println("error");
 665       }
 666       else
 667       {
 668         setCurrentAlignFrame(af);
 669         data = aparser.getValue("colour", true);
 670         if (data != null)
 671         {
 672           data.replaceAll("%20", " ");
 673
 674           ColourSchemeI cs = ColourSchemeProperty
 675                   .getColourScheme(af.getViewport(),
 676                           af.getViewport().getAlignment(), data);
 677
 678           if (cs != null)
 679           {
 680             System.out.println(
 681                     "CMD [-color " + data + "] executed successfully!");
 682           }
 683           af.changeColour(cs);
 684         }
 685
 686         // Must maintain ability to use the groups flag
 687         data = aparser.getValue("groups", true);
 688         if (data != null)
 689         {
 690           af.parseFeaturesFile(data,
 691                   AppletFormatAdapter.checkProtocol(data));
 692           // System.out.println("Added " + data);
 693           System.out.println(
 694                   "CMD groups[-" + data + "]  executed successfully!");
 695         }
 696         data = aparser.getValue("features", true);
 697         if (data != null)
 698         {
 699           af.parseFeaturesFile(data,
 700                   AppletFormatAdapter.checkProtocol(data));
 701           // System.out.println("Added " + data);
 702           System.out.println(
 703                   "CMD [-features " + data + "]  executed successfully!");
 704         }
 705
 706         data = aparser.getValue("annotations", true);
 707         if (data != null)
 708         {
 709           af.loadJalviewDataFile(data, null, null, null);
 710           // System.out.println("Added " + data);
 711           System.out.println(
 712                   "CMD [-annotations " + data + "] executed successfully!");
 713         }
 714         // set or clear the sortbytree flag.
 715         if (aparser.contains("sortbytree"))
 716         {
 717           af.getViewport().setSortByTree(true);
 718           if (af.getViewport().getSortByTree())
 719           {
 720             System.out.println("CMD [-sortbytree] executed successfully!");
 721           }
 722         }
 723         if (aparser.contains("no-annotation"))
 724         {
 725           af.getViewport().setShowAnnotation(false);
 726           if (!af.getViewport().isShowAnnotation())
 727           {
 728             System.out.println("CMD no-annotation executed successfully!");
 729           }
 730         }
 731         if (aparser.contains("nosortbytree"))
 732         {
 733           af.getViewport().setSortByTree(false);
 734           if (!af.getViewport().getSortByTree())
 735           {
 736             System.out
 737                     .println("CMD [-nosortbytree] executed successfully!");
 738           }
 739         }
 740         data = aparser.getValue("tree", true);
 741         if (data != null)
 742         {
 743           try
 744           {
 745             System.out.println(
 746                     "CMD [-tree " + data + "] executed successfully!");
 747             NewickFile nf = new NewickFile(data,
 748                     AppletFormatAdapter.checkProtocol(data));
 749             af.getViewport()
 750                     .setCurrentTree(af.showNewickTree(nf, data).getTree());
 751           } catch (IOException ex)
 752           {
 753             System.err.println("Couldn't add tree " + data);
 754             ex.printStackTrace(System.err);
 755           }
 756         }
 757         // TODO - load PDB structure(s) to alignment JAL-629
 758         // (associate with identical sequence in alignment, or a specified
 759         // sequence)
 760         if (groovyscript != null)
 761         {
 762           // Execute the groovy script after we've done all the rendering stuff
 763           // and before any images or figures are generated.
 764           System.out.println("Executing script " + groovyscript);
 765           executeGroovyScript(groovyscript, af);
 766           System.out.println("CMD groovy[" + groovyscript
 767                   + "] executed successfully!");
 768           groovyscript = null;
 769         }
 770         String imageName = "unnamed.png";
 771         while (aparser.getSize() > 1)
 772         {
 773           String outputFormat = aparser.nextValue();
 774           file = aparser.nextValue();
 775
 776           if (outputFormat.equalsIgnoreCase("png"))
 777           {
 778             af.createPNG(new File(file));
 779             imageName = (new File(file)).getName();
 780             System.out.println("Creating PNG image: " + file);
 781             continue;
 782           }
 783           else if (outputFormat.equalsIgnoreCase("svg"))
 784           {
 785             File imageFile = new File(file);
 786             imageName = imageFile.getName();
 787             af.createSVG(imageFile);
 788             System.out.println("Creating SVG image: " + file);
 789             continue;
 790           }
 791           else if (outputFormat.equalsIgnoreCase("html"))
 792           {
 793             File imageFile = new File(file);
 794             imageName = imageFile.getName();
 795             HtmlSvgOutput htmlSVG = new HtmlSvgOutput(af.alignPanel);
 796             htmlSVG.exportHTML(file);
 797
 798             System.out.println("Creating HTML image: " + file);
 799             continue;
 800           }
 801           else if (outputFormat.equalsIgnoreCase("biojsmsa"))
 802           {
 803             if (file == null)
 804             {
 805               System.err.println("The output html file must not be null");
 806               return;
 807             }
 808             try
 809             {
 810               BioJsHTMLOutput.refreshVersionInfo(
 811                       BioJsHTMLOutput.BJS_TEMPLATES_LOCAL_DIRECTORY);
 812             } catch (URISyntaxException e)
 813             {
 814               e.printStackTrace();
 815             }
 816             BioJsHTMLOutput bjs = new BioJsHTMLOutput(af.alignPanel);
 817             bjs.exportHTML(file);
 818             System.out
 819                     .println("Creating BioJS MSA Viwer HTML file: " + file);
 820             continue;
 821           }
 822           else if (outputFormat.equalsIgnoreCase("imgMap"))
 823           {
 824             af.createImageMap(new File(file), imageName);
 825             System.out.println("Creating image map: " + file);
 826             continue;
 827           }
 828           else if (outputFormat.equalsIgnoreCase("eps"))
 829           {
 830             File outputFile = new File(file);
 831             System.out.println(
 832                     "Creating EPS file: " + outputFile.getAbsolutePath());
 833             af.createEPS(outputFile);
 834             continue;
 835           }
 836
 837           af.saveAlignment(file, format);
 838           if (af.isSaveAlignmentSuccessful())
 839           {
 840             System.out.println("Written alignment in " + format
 841                     + " format to " + file);
 842           }
 843           else
 844           {
 845             System.out.println("Error writing file " + file + " in "
 846                     + format + " format!!");
 847           }
 848
 849         }
 850
 851         while (aparser.getSize() > 0)
 852         {
 853           System.out.println("Unknown arg: " + aparser.nextValue());
 854         }
 855       }
 856     }
 857     AlignFrame startUpAlframe = null;
 858     // We'll only open the default file if the desktop is visible.
 859     // And the user
 860     // ////////////////////
 861
 862     if (!Platform.isJS() && !headless && file == null
 863             && vamsasImport == null
 864             && jalview.bin.Cache.getDefault("SHOW_STARTUP_FILE", true))
 865     /**
 866      * Java only
 867      *
 868      * @j2sIgnore
 869      */
 870     {
 871       file = jalview.bin.Cache.getDefault("STARTUP_FILE",
 872               jalview.bin.Cache.getDefault("www.jalview.org",
 873                       "http://www.jalview.org")
 874                       + "/examples/exampleFile_2_7.jar");
 875       if (file.equals(
 876               "http://www.jalview.org/examples/exampleFile_2_3.jar"))
 877       {
 878         // hardwire upgrade of the startup file
 879         file.replace("_2_3.jar", "_2_7.jar");
 880         // and remove the stale setting
 881         jalview.bin.Cache.removeProperty("STARTUP_FILE");
 882       }
 883
 884       protocol = DataSourceType.FILE;
 885
 886       if (file.indexOf("http:") > -1)
 887       {
 888         protocol = DataSourceType.URL;
 889       }
 890
 891       if (file.endsWith(".jar"))
 892       {
 893         format = FileFormat.Jalview;
 894       }
 895       else
 896       {
 897         try
 898         {
 899           format = new IdentifyFile().identify(file, protocol);
 900         } catch (FileFormatException e)
 901         {
 902           // TODO what?
 903         }
 904       }
 905
 906       startUpAlframe = fileLoader.LoadFileWaitTillLoaded(file, protocol,
 907               format);
 908       // extract groovy arguments before anything else.
 909     }
 910
 911     // Once all other stuff is done, execute any groovy scripts (in order)
 912     if (groovyscript != null)
 913     {
 914       if (Cache.groovyJarsPresent())
 915       {
 916         System.out.println("Executing script " + groovyscript);
 917         executeGroovyScript(groovyscript, startUpAlframe);
 918       }
 919       else
 920       {
 921         System.err.println(
 922                 "Sorry. Groovy Support is not available, so ignoring the provided groovy script "
 923                         + groovyscript);
 924       }
 925     }
 926     // and finally, turn off batch mode indicator - if the desktop still exists
 927     if (desktop != null)
 928     {
 929       if (progress != -1)
 930       {
 931         desktop.setProgressBar(null, progress);
 932       }
 933       desktop.setInBatchMode(false);
 934     }
 935   }
 936
 937   private static void showUsage()
 938   {
 939     System.out.println(
 940             "Usage: jalview -open [FILE] [OUTPUT_FORMAT] [OUTPUT_FILE]\n\n"
 941                     + "-nodisplay\tRun Jalview without User Interface.\n"
 942                     + "-props FILE\tUse the given Jalview properties file instead of users default.\n"
 943                     + "-colour COLOURSCHEME\tThe colourscheme to be applied to the alignment\n"
 944                     + "-annotations FILE\tAdd precalculated annotations to the alignment.\n"
 945                     + "-tree FILE\tLoad the given newick format tree file onto the alignment\n"
 946                     + "-features FILE\tUse the given file to mark features on the alignment.\n"
 947                     + "-fasta FILE\tCreate alignment file FILE in Fasta format.\n"
 948                     + "-clustal FILE\tCreate alignment file FILE in Clustal format.\n"
 949                     + "-pfam FILE\tCreate alignment file FILE in PFAM format.\n"
 950                     + "-msf FILE\tCreate alignment file FILE in MSF format.\n"
 951                     + "-pileup FILE\tCreate alignment file FILE in Pileup format\n"
 952                     + "-pir FILE\tCreate alignment file FILE in PIR format.\n"
 953                     + "-blc FILE\tCreate alignment file FILE in BLC format.\n"
 954                     + "-json FILE\tCreate alignment file FILE in JSON format.\n"
 955                     + "-jalview FILE\tCreate alignment file FILE in Jalview format.\n"
 956                     + "-png FILE\tCreate PNG image FILE from alignment.\n"
 957                     + "-svg FILE\tCreate SVG image FILE from alignment.\n"
 958                     + "-html FILE\tCreate HTML file from alignment.\n"
 959                     + "-biojsMSA FILE\tCreate BioJS MSA Viewer HTML file from alignment.\n"
 960                     + "-imgMap FILE\tCreate HTML file FILE with image map of PNG image.\n"
 961                     + "-eps FILE\tCreate EPS file FILE from alignment.\n"
 962                     + "-questionnaire URL\tQueries the given URL for information about any Jalview user questionnaires.\n"
 963                     + "-noquestionnaire\tTurn off questionnaire check.\n"
 964                     + "-nonews\tTurn off check for Jalview news.\n"
 965                     + "-nousagestats\tTurn off google analytics tracking for this session.\n"
 966                     + "-sortbytree OR -nosortbytree\tEnable or disable sorting of the given alignment by the given tree\n"
 967                     // +
 968                     // "-setprop PROPERTY=VALUE\tSet the given Jalview property,
 969                     // after all other properties files have been read\n\t
 970                     // (quote the 'PROPERTY=VALUE' pair to ensure spaces are
 971                     // passed in correctly)"
 972                     + "-jabaws URL\tSpecify URL for Jabaws services (e.g. for a local installation).\n"
 973                     + "-fetchfrom nickname\tQuery nickname for features for the alignments and display them.\n"
 974                     // +
 975                     // "-vdoc vamsas-document\tImport vamsas document into new
 976                     // session or join existing session with same URN\n"
 977                     // + "-vses vamsas-session\tJoin session with given URN\n"
 978                     + "-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"
 979                     + "\n~Read documentation in Application or visit http://www.jalview.org for description of Features and Annotations file~\n\n");
 980   }
 981
 982   private static void startUsageStats(final Desktop desktop)
 983   {
 984     /**
 985      * start a User Config prompt asking if we can log usage statistics.
 986      */
 987     PromptUserConfig prompter = new PromptUserConfig(Desktop.desktop,
 988             "USAGESTATS", "Jalview Usage Statistics",
 989             "Do you want to help make Jalview better by enabling "
 990                     + "the collection of usage statistics with Google Analytics ?"
 991                     + "\n\n(you can enable or disable usage tracking in the preferences)",
 992             new Runnable()
 993             {
 994               @Override
 995               public void run()
 996               {
 997                 Cache.log.debug(
 998                         "Initialising googletracker for usage stats.");
 999                 Cache.initGoogleTracker();
1000                 Cache.log.debug("Tracking enabled.");
1001               }
1002             }, new Runnable()
1003             {
1004               @Override
1005               public void run()
1006               {
1007                 Cache.log.debug("Not enabling Google Tracking.");
1008               }
1009             }, null, true);
1010     desktop.addDialogThread(prompter);
1011   }
1012
1013   /**
1014    * Locate the given string as a file and pass it to the groovy interpreter.
1015    *
1016    * @param groovyscript
1017    *          the script to execute
1018    * @param jalviewContext
1019    *          the Jalview Desktop object passed in to the groovy binding as the
1020    *          'Jalview' object.
1021    */
1022   private void executeGroovyScript(String groovyscript, AlignFrame af)
1023   {
1024     /**
1025      * for scripts contained in files
1026      */
1027     File tfile = null;
1028     /**
1029      * script's URI
1030      */
1031     URL sfile = null;
1032     if (groovyscript.trim().equals("STDIN"))
1033     {
1034       // read from stdin into a tempfile and execute it
1035       try
1036       {
1037         tfile = File.createTempFile("jalview", "groovy");
1038         PrintWriter outfile = new PrintWriter(
1039                 new OutputStreamWriter(new FileOutputStream(tfile)));
1040         BufferedReader br = new BufferedReader(
1041                 new InputStreamReader(System.in));
1042         String line = null;
1043         while ((line = br.readLine()) != null)
1044         {
1045           outfile.write(line + "\n");
1046         }
1047         br.close();
1048         outfile.flush();
1049         outfile.close();
1050
1051       } catch (Exception ex)
1052       {
1053         System.err.println("Failed to read from STDIN into tempfile "
1054                 + ((tfile == null) ? "(tempfile wasn't created)"
1055                         : tfile.toString()));
1056         ex.printStackTrace();
1057         return;
1058       }
1059       try
1060       {
1061         sfile = tfile.toURI().toURL();
1062       } catch (Exception x)
1063       {
1064         System.err.println(
1065                 "Unexpected Malformed URL Exception for temporary file created from STDIN: "
1066                         + tfile.toURI());
1067         x.printStackTrace();
1068         return;
1069       }
1070     }
1071     else
1072     {
1073       try
1074       {
1075         sfile = new URI(groovyscript).toURL();
1076       } catch (Exception x)
1077       {
1078         tfile = new File(groovyscript);
1079         if (!tfile.exists())
1080         {
1081           System.err.println("File '" + groovyscript + "' does not exist.");
1082           return;
1083         }
1084         if (!tfile.canRead())
1085         {
1086           System.err.println("File '" + groovyscript + "' cannot be read.");
1087           return;
1088         }
1089         if (tfile.length() < 1)
1090         {
1091           System.err.println("File '" + groovyscript + "' is empty.");
1092           return;
1093         }
1094         try
1095         {
1096           sfile = tfile.getAbsoluteFile().toURI().toURL();
1097         } catch (Exception ex)
1098         {
1099           System.err.println("Failed to create a file URL for "
1100                   + tfile.getAbsoluteFile());
1101           return;
1102         }
1103       }
1104     }
1105     try
1106     {
1107       Map<String, java.lang.Object> vbinding = new HashMap<>();
1108       vbinding.put("Jalview", this);
1109       if (af != null)
1110       {
1111         vbinding.put("currentAlFrame", af);
1112       }
1113       Binding gbinding = new Binding(vbinding);
1114       GroovyScriptEngine gse = new GroovyScriptEngine(new URL[] { sfile });
1115       gse.run(sfile.toString(), gbinding);
1116       if ("STDIN".equals(groovyscript))
1117       {
1118         // delete temp file that we made -
1119         // only if it was successfully executed
1120         tfile.delete();
1121       }
1122     } catch (Exception e)
1123     {
1124       System.err.println("Exception Whilst trying to execute file " + sfile
1125               + " as a groovy script.");
1126       e.printStackTrace(System.err);
1127
1128     }
1129   }
1130
1131   public static boolean isHeadlessMode()
1132   {
1133     String isheadless = System.getProperty("java.awt.headless");
1134     if (isheadless != null && isheadless.equalsIgnoreCase("true"))
1135     {
1136       return true;
1137     }
1138     return false;
1139   }
1140
1141   public AlignFrame[] getAlignFrames()
1142   {
1143     return desktop == null ? new AlignFrame[] { getCurrentAlignFrame() }
1144             : Desktop.getAlignFrames();
1145
1146   }
1147
1148   /**
1149    * Quit method delegates to Desktop.quit - unless running in headless mode
1150    * when it just ends the JVM
1151    */
1152   public void quit()
1153   {
1154     if (desktop != null)
1155     {
1156       desktop.quit();
1157     }
1158     else
1159     {
1160       System.exit(0);
1161     }
1162   }
1163
1164   public static AlignFrame getCurrentAlignFrame()
1165   {
1166     return Jalview.currentAlignFrame;
1167   }
1168
1169   public static void setCurrentAlignFrame(AlignFrame currentAlignFrame)
1170   {
1171     Jalview.currentAlignFrame = currentAlignFrame;
1172   }
1173 }