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