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