src/jalview/bin/Jalview.java

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