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 processing
 143      * 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     // report Jalview version
 270     Cache.loadBuildProperties(true);
 271
 272     ArgsParser aparser = new ArgsParser(args);
 273     boolean headless = false;
 274
 275     String usrPropsFile = aparser.getValue("props");
 276     Cache.loadProperties(usrPropsFile); // must do this before
 277     if (usrPropsFile != null)
 278     {
 279       System.out.println(
 280               "CMD [-props " + usrPropsFile + "] executed successfully!");
 281     }
 282
 283     if (!Platform.isJS())
 284     /**
 285      * Java only
 286      *
 287      * @j2sIgnore
 288      */
 289     {
 290       if (aparser.contains("help") || aparser.contains("h"))
 291       {
 292         showUsage();
 293         System.exit(0);
 294       }
 295       if (aparser.contains("nodisplay") || aparser.contains("nogui")
 296               || aparser.contains("headless"))
 297       {
 298         System.setProperty("java.awt.headless", "true");
 299         headless = true;
 300       }
 301       // anything else!
 302
 303       final String jabawsUrl = aparser.getValue("jabaws");
 304       if (jabawsUrl != null)
 305       {
 306         try
 307         {
 308           Jws2Discoverer.getDiscoverer().setPreferredUrl(jabawsUrl);
 309           System.out.println(
 310                   "CMD [-jabaws " + jabawsUrl + "] executed successfully!");
 311         } catch (MalformedURLException e)
 312         {
 313           System.err.println(
 314                   "Invalid jabaws parameter: " + jabawsUrl + " ignored");
 315         }
 316       }
 317
 318     }
 319     String defs = aparser.getValue("setprop");
 320     while (defs != null)
 321     {
 322       int p = defs.indexOf('=');
 323       if (p == -1)
 324       {
 325         System.err.println("Ignoring invalid setprop argument : " + defs);
 326       }
 327       else
 328       {
 329         System.out.println("Executing setprop argument: " + defs);
 330         if (Platform.isJS())
 331         {
 332           Cache.setProperty(defs.substring(0,p), defs.substring(p+1));
 333         }
 334       }
 335       defs = aparser.getValue("setprop");
 336     }
 337     if (System.getProperty("java.awt.headless") != null
 338             && System.getProperty("java.awt.headless").equals("true"))
 339     {
 340       headless = true;
 341     }
 342     System.setProperty("http.agent",
 343             "Jalview Desktop/" + Cache.getDefault("VERSION", "Unknown"));
 344     try
 345     {
 346       Cache.initLogger();
 347     } catch (NoClassDefFoundError error)
 348     {
 349       error.printStackTrace();
 350       System.out.println("\nEssential logging libraries not found."
 351               + "\nUse: java -classpath \"$PATH_TO_LIB$/*:$PATH_TO_CLASSES$\" jalview.bin.Jalview");
 352       System.exit(0);
 353     }
 354
 355     desktop = null;
 356
 357     try
 358     {
 359       UIManager.setLookAndFeel(UIManager.getSystemLookAndFeelClassName());
 360     } catch (Exception ex)
 361     {
 362       System.err.println("Unexpected Look and Feel Exception");
 363       ex.printStackTrace();
 364     }
 365     if (Platform.isAMacAndNotJS())
 366     {
 367
 368       LookAndFeel lookAndFeel = ch.randelshofer.quaqua.QuaquaManager
 369               .getLookAndFeel();
 370       System.setProperty("com.apple.mrj.application.apple.menu.about.name",
 371               "Jalview");
 372       System.setProperty("apple.laf.useScreenMenuBar", "true");
 373       if (lookAndFeel != null)
 374       {
 375         try
 376         {
 377           UIManager.setLookAndFeel(lookAndFeel);
 378         } catch (Throwable e)
 379         {
 380           System.err.println(
 381                   "Failed to set QuaQua look and feel: " + e.toString());
 382         }
 383       }
 384       if (lookAndFeel == null
 385               || !(lookAndFeel.getClass().isAssignableFrom(
 386                       UIManager.getLookAndFeel().getClass()))
 387               || !UIManager.getLookAndFeel().getClass().toString()
 388                       .toLowerCase().contains("quaqua"))
 389       {
 390         try
 391         {
 392           System.err.println(
 393                   "Quaqua LaF not available on this plaform. Using VAqua(4).\nSee https://issues.jalview.org/browse/JAL-2976");
 394           UIManager.setLookAndFeel("org.violetlib.aqua.AquaLookAndFeel");
 395         } catch (Throwable e)
 396         {
 397           System.err.println(
 398                   "Failed to reset look and feel: " + e.toString());
 399         }
 400       }
 401     }
 402
 403     /*
 404      * configure 'full' SO model if preferences say to, else use the default (full SO)
 405      * - as JS currently doesn't have OBO parsing, it must use 'Lite' version
 406      */
 407     boolean soDefault = !Platform.isJS();
 408     if (Cache.getDefault("USE_FULL_SO", soDefault))
 409     {
 410       SequenceOntologyFactory.setInstance(new SequenceOntology());
 411     }
 412
 413     if (!headless)
 414     {
 415       desktop = new Desktop();
 416       desktop.setInBatchMode(true); // indicate we are starting up
 417
 418       try
 419       {
 420         JalviewTaskbar.setTaskbar(this);
 421       } catch (Exception e)
 422       {
 423         System.out.println("Cannot set Taskbar");
 424         // e.printStackTrace();
 425       } catch (Throwable t)
 426       {
 427         System.out.println("Cannot set Taskbar");
 428         // t.printStackTrace();
 429       }
 430
 431       desktop.setVisible(true);
 432
 433       if (!Platform.isJS())
 434       /**
 435        * Java only
 436        *
 437        * @j2sIgnore
 438        */
 439       {
 440         desktop.startServiceDiscovery();
 441         if (!aparser.contains("nousagestats"))
 442         {
 443           startUsageStats(desktop);
 444         }
 445         else
 446         {
 447           System.err.println("CMD [-nousagestats] executed successfully!");
 448         }
 449
 450         if (!aparser.contains("noquestionnaire"))
 451         {
 452           String url = aparser.getValue("questionnaire");
 453           if (url != null)
 454           {
 455             // Start the desktop questionnaire prompter with the specified
 456             // questionnaire
 457             Cache.log.debug("Starting questionnaire url at " + url);
 458             desktop.checkForQuestionnaire(url);
 459             System.out.println("CMD questionnaire[-" + url
 460                     + "] executed successfully!");
 461           }
 462           else
 463           {
 464             if (Cache.getProperty("NOQUESTIONNAIRES") == null)
 465             {
 466               // Start the desktop questionnaire prompter with the specified
 467               // questionnaire
 468               // String defurl =
 469               // "http://anaplog.compbio.dundee.ac.uk/cgi-bin/questionnaire.pl";
 470               // //
 471               String defurl = "http://www.jalview.org/cgi-bin/questionnaire.pl";
 472               Cache.log.debug(
 473                       "Starting questionnaire with default url: " + defurl);
 474               desktop.checkForQuestionnaire(defurl);
 475             }
 476           }
 477         }
 478         else
 479         {
 480           System.err
 481                   .println("CMD [-noquestionnaire] executed successfully!");
 482         }
 483
 484         if (!aparser.contains("nonews"))
 485         {
 486           desktop.checkForNews();
 487         }
 488
 489         BioJsHTMLOutput.updateBioJS();
 490       }
 491     }
 492
 493     // Move any new getdown-launcher-new.jar into place over old
 494     // getdown-launcher.jar
 495     String appdirString = System.getProperty("getdownappdir");
 496     if (appdirString != null && appdirString.length() > 0)
 497     {
 498       final File appdir = new File(appdirString);
 499       new Thread()
 500       {
 501         @Override
 502         public void run()
 503         {
 504           LaunchUtil.upgradeGetdown(
 505                   new File(appdir, "getdown-launcher-old.jar"),
 506                   new File(appdir, "getdown-launcher.jar"),
 507                   new File(appdir, "getdown-launcher-new.jar"));
 508         }
 509       }.start();
 510     }
 511
 512     String file = null, data = null;
 513     FileFormatI format = null;
 514     DataSourceType protocol = null;
 515     FileLoader fileLoader = new FileLoader(!headless);
 516
 517     String groovyscript = null; // script to execute after all loading is
 518     // completed one way or another
 519     // extract groovy argument and execute if necessary
 520     groovyscript = aparser.getValue("groovy", true);
 521     file = aparser.getValue("open", true);
 522
 523     if (file == null && desktop == null)
 524     {
 525       System.out.println("No files to open!");
 526       System.exit(1);
 527     }
 528     long progress = -1;
 529     // Finally, deal with the remaining input data.
 530     if (file != null)
 531     {
 532       if (!headless)
 533       {
 534         desktop.setProgressBar(
 535                 MessageManager
 536                         .getString("status.processing_commandline_args"),
 537                 progress = System.currentTimeMillis());
 538       }
 539       System.out.println("CMD [-open " + file + "] executed successfully!");
 540
 541       if (!Platform.isJS())
 542         /**
 543          * ignore in JavaScript -- can't just file existence - could load it?
 544          *
 545          * @j2sIgnore
 546          */
 547       {
 548         if (!file.startsWith("http://") && !file.startsWith("https://"))
 549         // BH 2019 added https check for Java
 550         {
 551           if (!(new File(file)).exists())
 552           {
 553             System.out.println("Can't find " + file);
 554             if (headless)
 555             {
 556               System.exit(1);
 557             }
 558           }
 559         }
 560       }
 561
 562         protocol = AppletFormatAdapter.checkProtocol(file);
 563
 564       try
 565       {
 566         format = new IdentifyFile().identify(file, protocol);
 567       } catch (FileFormatException e1)
 568       {
 569         // TODO ?
 570       }
 571
 572       AlignFrame af = fileLoader.LoadFileWaitTillLoaded(file, protocol,
 573               format);
 574       if (af == null)
 575       {
 576         System.out.println("error");
 577       }
 578       else
 579       {
 580         setCurrentAlignFrame(af);
 581         data = aparser.getValue("colour", true);
 582         if (data != null)
 583         {
 584           data.replaceAll("%20", " ");
 585
 586           ColourSchemeI cs = ColourSchemeProperty.getColourScheme(
 587                   af.getViewport(), af.getViewport().getAlignment(), data);
 588
 589           if (cs != null)
 590           {
 591             System.out.println(
 592                     "CMD [-color " + data + "] executed successfully!");
 593           }
 594           af.changeColour(cs);
 595         }
 596
 597         // Must maintain ability to use the groups flag
 598         data = aparser.getValue("groups", true);
 599         if (data != null)
 600         {
 601           af.parseFeaturesFile(data,
 602                   AppletFormatAdapter.checkProtocol(data));
 603           // System.out.println("Added " + data);
 604           System.out.println(
 605                   "CMD groups[-" + data + "]  executed successfully!");
 606         }
 607         data = aparser.getValue("features", true);
 608         if (data != null)
 609         {
 610           af.parseFeaturesFile(data,
 611                   AppletFormatAdapter.checkProtocol(data));
 612           // System.out.println("Added " + data);
 613           System.out.println(
 614                   "CMD [-features " + data + "]  executed successfully!");
 615         }
 616
 617         data = aparser.getValue("annotations", true);
 618         if (data != null)
 619         {
 620           af.loadJalviewDataFile(data, null, null, null);
 621           // System.out.println("Added " + data);
 622           System.out.println(
 623                   "CMD [-annotations " + data + "] executed successfully!");
 624         }
 625         // set or clear the sortbytree flag.
 626         if (aparser.contains("sortbytree"))
 627         {
 628           af.getViewport().setSortByTree(true);
 629           if (af.getViewport().getSortByTree())
 630           {
 631             System.out.println("CMD [-sortbytree] executed successfully!");
 632           }
 633         }
 634         if (aparser.contains("no-annotation"))
 635         {
 636           af.getViewport().setShowAnnotation(false);
 637           if (!af.getViewport().isShowAnnotation())
 638           {
 639             System.out.println("CMD no-annotation executed successfully!");
 640           }
 641         }
 642         if (aparser.contains("nosortbytree"))
 643         {
 644           af.getViewport().setSortByTree(false);
 645           if (!af.getViewport().getSortByTree())
 646           {
 647             System.out
 648                     .println("CMD [-nosortbytree] executed successfully!");
 649           }
 650         }
 651         data = aparser.getValue("tree", true);
 652         if (data != null)
 653         {
 654           try
 655           {
 656             System.out.println(
 657                     "CMD [-tree " + data + "] executed successfully!");
 658             NewickFile nf = new NewickFile(data,
 659                     AppletFormatAdapter.checkProtocol(data));
 660             af.getViewport()
 661                     .setCurrentTree(af.showNewickTree(nf, data).getTree());
 662           } catch (IOException ex)
 663           {
 664             System.err.println("Couldn't add tree " + data);
 665             ex.printStackTrace(System.err);
 666           }
 667         }
 668         // TODO - load PDB structure(s) to alignment JAL-629
 669         // (associate with identical sequence in alignment, or a specified
 670         // sequence)
 671         if (groovyscript != null)
 672         {
 673           // Execute the groovy script after we've done all the rendering stuff
 674           // and before any images or figures are generated.
 675           System.out.println("Executing script " + groovyscript);
 676           executeGroovyScript(groovyscript, af);
 677           System.out.println("CMD groovy[" + groovyscript
 678                   + "] executed successfully!");
 679           groovyscript = null;
 680         }
 681         String imageName = "unnamed.png";
 682         while (aparser.getSize() > 1)
 683         {
 684           String outputFormat = aparser.nextValue();
 685           file = aparser.nextValue();
 686
 687           if (outputFormat.equalsIgnoreCase("png"))
 688           {
 689             af.createPNG(new File(file));
 690             imageName = (new File(file)).getName();
 691             System.out.println("Creating PNG image: " + file);
 692             continue;
 693           }
 694           else if (outputFormat.equalsIgnoreCase("svg"))
 695           {
 696             File imageFile = new File(file);
 697             imageName = imageFile.getName();
 698             af.createSVG(imageFile);
 699             System.out.println("Creating SVG image: " + file);
 700             continue;
 701           }
 702           else if (outputFormat.equalsIgnoreCase("html"))
 703           {
 704             File imageFile = new File(file);
 705             imageName = imageFile.getName();
 706             HtmlSvgOutput htmlSVG = new HtmlSvgOutput(af.alignPanel);
 707             htmlSVG.exportHTML(file);
 708
 709             System.out.println("Creating HTML image: " + file);
 710             continue;
 711           }
 712           else if (outputFormat.equalsIgnoreCase("biojsmsa"))
 713           {
 714             if (file == null)
 715             {
 716               System.err.println("The output html file must not be null");
 717               return;
 718             }
 719             try
 720             {
 721               BioJsHTMLOutput.refreshVersionInfo(
 722                       BioJsHTMLOutput.BJS_TEMPLATES_LOCAL_DIRECTORY);
 723             } catch (URISyntaxException e)
 724             {
 725               e.printStackTrace();
 726             }
 727             BioJsHTMLOutput bjs = new BioJsHTMLOutput(af.alignPanel);
 728             bjs.exportHTML(file);
 729             System.out
 730                     .println("Creating BioJS MSA Viwer HTML file: " + file);
 731             continue;
 732           }
 733           else if (outputFormat.equalsIgnoreCase("imgMap"))
 734           {
 735             af.createImageMap(new File(file), imageName);
 736             System.out.println("Creating image map: " + file);
 737             continue;
 738           }
 739           else if (outputFormat.equalsIgnoreCase("eps"))
 740           {
 741             File outputFile = new File(file);
 742             System.out.println(
 743                     "Creating EPS file: " + outputFile.getAbsolutePath());
 744             af.createEPS(outputFile);
 745             continue;
 746           }
 747
 748           af.saveAlignment(file, format);
 749           if (af.isSaveAlignmentSuccessful())
 750           {
 751             System.out.println("Written alignment in " + format
 752                     + " format to " + file);
 753           }
 754           else
 755           {
 756             System.out.println("Error writing file " + file + " in "
 757                     + format + " format!!");
 758           }
 759
 760         }
 761
 762         while (aparser.getSize() > 0)
 763         {
 764           System.out.println("Unknown arg: " + aparser.nextValue());
 765         }
 766       }
 767     }
 768     AlignFrame startUpAlframe = null;
 769     // We'll only open the default file if the desktop is visible.
 770     // And the user
 771     // ////////////////////
 772
 773     if (!Platform.isJS() && !headless && file == null
 774             && Cache.getDefault("SHOW_STARTUP_FILE", true))
 775     /**
 776      * Java only
 777      *
 778      * @j2sIgnore
 779      */
 780     {
 781       file = Cache.getDefault("STARTUP_FILE",
 782               Cache.getDefault("www.jalview.org",
 783                       "http://www.jalview.org")
 784                       + "/examples/exampleFile_2_7.jar");
 785       if (file.equals(
 786               "http://www.jalview.org/examples/exampleFile_2_3.jar"))
 787       {
 788         // hardwire upgrade of the startup file
 789         file.replace("_2_3.jar", "_2_7.jar");
 790         // and remove the stale setting
 791         Cache.removeProperty("STARTUP_FILE");
 792       }
 793
 794       protocol = DataSourceType.FILE;
 795
 796       if (file.indexOf("http:") > -1)
 797       {
 798         protocol = DataSourceType.URL;
 799       }
 800
 801       if (file.endsWith(".jar"))
 802       {
 803         format = FileFormat.Jalview;
 804       }
 805       else
 806       {
 807         try
 808         {
 809           format = new IdentifyFile().identify(file, protocol);
 810         } catch (FileFormatException e)
 811         {
 812           // TODO what?
 813         }
 814       }
 815
 816       startUpAlframe = fileLoader.LoadFileWaitTillLoaded(file, protocol,
 817               format);
 818       // extract groovy arguments before anything else.
 819     }
 820
 821     // Once all other stuff is done, execute any groovy scripts (in order)
 822     if (groovyscript != null)
 823     {
 824       if (Cache.groovyJarsPresent())
 825       {
 826         System.out.println("Executing script " + groovyscript);
 827         executeGroovyScript(groovyscript, startUpAlframe);
 828       }
 829       else
 830       {
 831         System.err.println(
 832                 "Sorry. Groovy Support is not available, so ignoring the provided groovy script "
 833                         + groovyscript);
 834       }
 835     }
 836     // and finally, turn off batch mode indicator - if the desktop still exists
 837     if (desktop != null)
 838     {
 839       if (progress != -1)
 840       {
 841         desktop.setProgressBar(null, progress);
 842       }
 843       desktop.setInBatchMode(false);
 844     }
 845   }
 846
 847   private static void showUsage()
 848   {
 849     System.out.println(
 850             "Usage: jalview -open [FILE] [OUTPUT_FORMAT] [OUTPUT_FILE]\n\n"
 851                     + "-nodisplay\tRun Jalview without User Interface.\n"
 852                     + "-props FILE\tUse the given Jalview properties file instead of users default.\n"
 853                     + "-colour COLOURSCHEME\tThe colourscheme to be applied to the alignment\n"
 854                     + "-annotations FILE\tAdd precalculated annotations to the alignment.\n"
 855                     + "-tree FILE\tLoad the given newick format tree file onto the alignment\n"
 856                     + "-features FILE\tUse the given file to mark features on the alignment.\n"
 857                     + "-fasta FILE\tCreate alignment file FILE in Fasta format.\n"
 858                     + "-clustal FILE\tCreate alignment file FILE in Clustal format.\n"
 859                     + "-pfam FILE\tCreate alignment file FILE in PFAM format.\n"
 860                     + "-msf FILE\tCreate alignment file FILE in MSF format.\n"
 861                     + "-pileup FILE\tCreate alignment file FILE in Pileup format\n"
 862                     + "-pir FILE\tCreate alignment file FILE in PIR format.\n"
 863                     + "-blc FILE\tCreate alignment file FILE in BLC format.\n"
 864                     + "-json FILE\tCreate alignment file FILE in JSON format.\n"
 865                     + "-jalview FILE\tCreate alignment file FILE in Jalview format.\n"
 866                     + "-png FILE\tCreate PNG image FILE from alignment.\n"
 867                     + "-svg FILE\tCreate SVG image FILE from alignment.\n"
 868                     + "-html FILE\tCreate HTML file from alignment.\n"
 869                     + "-biojsMSA FILE\tCreate BioJS MSA Viewer HTML file from alignment.\n"
 870                     + "-imgMap FILE\tCreate HTML file FILE with image map of PNG image.\n"
 871                     + "-eps FILE\tCreate EPS file FILE from alignment.\n"
 872                     + "-questionnaire URL\tQueries the given URL for information about any Jalview user questionnaires.\n"
 873                     + "-noquestionnaire\tTurn off questionnaire check.\n"
 874                     + "-nonews\tTurn off check for Jalview news.\n"
 875                     + "-nousagestats\tTurn off google analytics tracking for this session.\n"
 876                     + "-sortbytree OR -nosortbytree\tEnable or disable sorting of the given alignment by the given tree\n"
 877                     // +
 878                     // "-setprop PROPERTY=VALUE\tSet the given Jalview property,
 879                     // after all other properties files have been read\n\t
 880                     // (quote the 'PROPERTY=VALUE' pair to ensure spaces are
 881                     // passed in correctly)"
 882                     + "-jabaws URL\tSpecify URL for Jabaws services (e.g. for a local installation).\n"
 883                     + "-fetchfrom nickname\tQuery nickname for features for the alignments and display them.\n"
 884                     + "-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"
 885                     + "\n~Read documentation in Application or visit http://www.jalview.org for description of Features and Annotations file~\n\n");
 886   }
 887
 888   private static void startUsageStats(final Desktop desktop)
 889   {
 890     /**
 891      * start a User Config prompt asking if we can log usage statistics.
 892      */
 893     PromptUserConfig prompter = new PromptUserConfig(Desktop.desktop,
 894             "USAGESTATS", "Jalview Usage Statistics",
 895             "Do you want to help make Jalview better by enabling "
 896                     + "the collection of usage statistics with Google Analytics ?"
 897                     + "\n\n(you can enable or disable usage tracking in the preferences)",
 898             new Runnable()
 899             {
 900               @Override
 901               public void run()
 902               {
 903                 Cache.log.debug(
 904                         "Initialising googletracker for usage stats.");
 905                 Cache.initGoogleTracker();
 906                 Cache.log.debug("Tracking enabled.");
 907               }
 908             }, new Runnable()
 909             {
 910               @Override
 911               public void run()
 912               {
 913                 Cache.log.debug("Not enabling Google Tracking.");
 914               }
 915             }, null, true);
 916     desktop.addDialogThread(prompter);
 917   }
 918
 919   /**
 920    * Locate the given string as a file and pass it to the groovy interpreter.
 921    *
 922    * @param groovyscript
 923    *                         the script to execute
 924    * @param jalviewContext
 925    *                         the Jalview Desktop object passed in to the groovy
 926    *                         binding as the 'Jalview' object.
 927    */
 928   private void executeGroovyScript(String groovyscript, AlignFrame af)
 929   {
 930     /**
 931      * for scripts contained in files
 932      */
 933     File tfile = null;
 934     /**
 935      * script's URI
 936      */
 937     URL sfile = null;
 938     if (groovyscript.trim().equals("STDIN"))
 939     {
 940       // read from stdin into a tempfile and execute it
 941       try
 942       {
 943         tfile = File.createTempFile("jalview", "groovy");
 944         PrintWriter outfile = new PrintWriter(
 945                 new OutputStreamWriter(new FileOutputStream(tfile)));
 946         BufferedReader br = new BufferedReader(
 947                 new InputStreamReader(System.in));
 948         String line = null;
 949         while ((line = br.readLine()) != null)
 950         {
 951           outfile.write(line + "\n");
 952         }
 953         br.close();
 954         outfile.flush();
 955         outfile.close();
 956
 957       } catch (Exception ex)
 958       {
 959         System.err.println("Failed to read from STDIN into tempfile "
 960                 + ((tfile == null) ? "(tempfile wasn't created)"
 961                         : tfile.toString()));
 962         ex.printStackTrace();
 963         return;
 964       }
 965       try
 966       {
 967         sfile = tfile.toURI().toURL();
 968       } catch (Exception x)
 969       {
 970         System.err.println(
 971                 "Unexpected Malformed URL Exception for temporary file created from STDIN: "
 972                         + tfile.toURI());
 973         x.printStackTrace();
 974         return;
 975       }
 976     }
 977     else
 978     {
 979       try
 980       {
 981         sfile = new URI(groovyscript).toURL();
 982       } catch (Exception x)
 983       {
 984         tfile = new File(groovyscript);
 985         if (!tfile.exists())
 986         {
 987           System.err.println("File '" + groovyscript + "' does not exist.");
 988           return;
 989         }
 990         if (!tfile.canRead())
 991         {
 992           System.err.println("File '" + groovyscript + "' cannot be read.");
 993           return;
 994         }
 995         if (tfile.length() < 1)
 996         {
 997           System.err.println("File '" + groovyscript + "' is empty.");
 998           return;
 999         }
1000         try
1001         {
1002           sfile = tfile.getAbsoluteFile().toURI().toURL();
1003         } catch (Exception ex)
1004         {
1005           System.err.println("Failed to create a file URL for "
1006                   + tfile.getAbsoluteFile());
1007           return;
1008         }
1009       }
1010     }
1011     try
1012     {
1013       Map<String, java.lang.Object> vbinding = new HashMap<>();
1014       vbinding.put("Jalview", this);
1015       if (af != null)
1016       {
1017         vbinding.put("currentAlFrame", af);
1018       }
1019       Binding gbinding = new Binding(vbinding);
1020       GroovyScriptEngine gse = new GroovyScriptEngine(new URL[] { sfile });
1021       gse.run(sfile.toString(), gbinding);
1022       if ("STDIN".equals(groovyscript))
1023       {
1024         // delete temp file that we made -
1025         // only if it was successfully executed
1026         tfile.delete();
1027       }
1028     } catch (Exception e)
1029     {
1030       System.err.println("Exception Whilst trying to execute file " + sfile
1031               + " as a groovy script.");
1032       e.printStackTrace(System.err);
1033
1034     }
1035   }
1036
1037   public static boolean isHeadlessMode()
1038   {
1039     String isheadless = System.getProperty("java.awt.headless");
1040     if (isheadless != null && isheadless.equalsIgnoreCase("true"))
1041     {
1042       return true;
1043     }
1044     return false;
1045   }
1046
1047   public AlignFrame[] getAlignFrames()
1048   {
1049     return desktop == null ? new AlignFrame[] { getCurrentAlignFrame() }
1050             : Desktop.getAlignFrames();
1051
1052   }
1053
1054   /**
1055    * Quit method delegates to Desktop.quit - unless running in headless mode when
1056    * it just ends the JVM
1057    */
1058   public void quit()
1059   {
1060     if (desktop != null)
1061     {
1062       desktop.quit();
1063     }
1064     else
1065     {
1066       System.exit(0);
1067     }
1068   }
1069
1070   public static AlignFrame getCurrentAlignFrame()
1071   {
1072     return Jalview.currentAlignFrame;
1073   }
1074
1075   public static void setCurrentAlignFrame(AlignFrame currentAlignFrame)
1076   {
1077     Jalview.currentAlignFrame = currentAlignFrame;
1078   }
1079 }