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