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