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