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