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