src/jalview/bin/Jalview.java

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