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