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