src/jalview/bin/Commands.java

   1 package jalview.bin;
   2
   3 import java.io.File;
   4 import java.io.IOException;
   5 import java.net.URISyntaxException;
   6 import java.util.ArrayList;
   7 import java.util.Arrays;
   8 import java.util.Collections;
   9 import java.util.EnumSet;
  10 import java.util.HashMap;
  11 import java.util.Iterator;
  12 import java.util.List;
  13 import java.util.Locale;
  14 import java.util.Map;
  15
  16 import jalview.analysis.AlignmentUtils;
  17 import jalview.api.structures.JalviewStructureDisplayI;
  18 import jalview.bin.argparser.Arg;
  19 import jalview.bin.argparser.ArgParser;
  20 import jalview.bin.argparser.ArgParser.Position;
  21 import jalview.bin.argparser.ArgValue;
  22 import jalview.bin.argparser.ArgValuesMap;
  23 import jalview.bin.argparser.SubVals;
  24 import jalview.datamodel.AlignmentI;
  25 import jalview.datamodel.SequenceI;
  26 import jalview.datamodel.annotations.AlphaFoldAnnotationRowBuilder;
  27 import jalview.gui.AlignFrame;
  28 import jalview.gui.AlignmentPanel;
  29 import jalview.gui.AppJmol;
  30 import jalview.gui.Desktop;
  31 import jalview.gui.Preferences;
  32 import jalview.gui.StructureChooser;
  33 import jalview.gui.StructureViewer;
  34 import jalview.gui.StructureViewer.ViewerType;
  35 import jalview.io.AppletFormatAdapter;
  36 import jalview.io.BackupFiles;
  37 import jalview.io.BioJsHTMLOutput;
  38 import jalview.io.DataSourceType;
  39 import jalview.io.FileFormat;
  40 import jalview.io.FileFormatException;
  41 import jalview.io.FileFormatI;
  42 import jalview.io.FileFormats;
  43 import jalview.io.FileLoader;
  44 import jalview.io.HtmlSvgOutput;
  45 import jalview.io.IdentifyFile;
  46 import jalview.io.NewickFile;
  47 import jalview.structure.StructureImportSettings.TFType;
  48 import jalview.structure.StructureSelectionManager;
  49 import jalview.util.FileUtils;
  50 import jalview.util.HttpUtils;
  51 import jalview.util.ImageMaker;
  52 import jalview.util.ImageMaker.TYPE;
  53 import jalview.util.MessageManager;
  54 import jalview.util.Platform;
  55 import jalview.util.imagemaker.BitmapImageSizing;
  56
  57 public class Commands
  58 {
  59   Desktop desktop;
  60
  61   private boolean headless;
  62
  63   private ArgParser argParser;
  64
  65   private Map<String, AlignFrame> afMap;
  66
  67   private boolean commandArgsProvided = false;
  68
  69   private boolean argsWereParsed = false;
  70
  71   public Commands(ArgParser argparser, boolean headless)
  72   {
  73     this(Desktop.instance, argparser, headless);
  74   }
  75
  76   public Commands(Desktop d, ArgParser argparser, boolean h)
  77   {
  78     argParser = argparser;
  79     headless = h;
  80     desktop = d;
  81     afMap = new HashMap<>();
  82     if (argparser != null)
  83     {
  84       processArgs(argparser, headless);
  85     }
  86   }
  87
  88   private boolean processArgs(ArgParser argparser, boolean h)
  89   {
  90     argParser = argparser;
  91     headless = h;
  92     boolean theseArgsWereParsed = false;
  93
  94     if (argParser != null && argParser.getLinkedIds() != null)
  95     {
  96       for (String id : argParser.getLinkedIds())
  97       {
  98         ArgValuesMap avm = argParser.getLinkedArgs(id);
  99         theseArgsWereParsed = true;
 100         theseArgsWereParsed &= processLinked(id);
 101         processGroovyScript(id);
 102         boolean processLinkedOkay = theseArgsWereParsed;
 103         theseArgsWereParsed &= processImages(id);
 104         if (processLinkedOkay)
 105           theseArgsWereParsed &= processOutput(id);
 106
 107         // close ap
 108         if (avm.getBoolean(Arg.CLOSE))
 109         {
 110           AlignFrame af = afMap.get(id);
 111           if (af != null)
 112           {
 113             af.closeMenuItem_actionPerformed(true);
 114           }
 115         }
 116
 117       }
 118
 119     }
 120     if (argParser.getBoolean(Arg.QUIT))
 121     {
 122       Jalview.getInstance().quit();
 123       return true;
 124     }
 125     // carry on with jalview.bin.Jalview
 126     argsWereParsed = theseArgsWereParsed;
 127     return argsWereParsed;
 128   }
 129
 130   public boolean commandArgsProvided()
 131   {
 132     return commandArgsProvided;
 133   }
 134
 135   public boolean argsWereParsed()
 136   {
 137     return argsWereParsed;
 138   }
 139
 140   protected boolean processUnlinked(String id)
 141   {
 142     return processLinked(id);
 143   }
 144
 145   protected boolean processLinked(String id)
 146   {
 147     boolean theseArgsWereParsed = false;
 148     ArgValuesMap avm = argParser.getLinkedArgs(id);
 149     if (avm == null)
 150       return true;
 151
 152     /*
 153      * // script to execute after all loading is completed one way or another String
 154      * groovyscript = m.get(Arg.GROOVY) == null ? null :
 155      * m.get(Arg.GROOVY).getValue(); String file = m.get(Arg.OPEN) == null ? null :
 156      * m.get(Arg.OPEN).getValue(); String data = null; FileFormatI format = null;
 157      * DataSourceType protocol = null;
 158      */
 159     if (avm.containsArg(Arg.APPEND) || avm.containsArg(Arg.OPEN))
 160     {
 161       commandArgsProvided = true;
 162       long progress = -1;
 163
 164       boolean first = true;
 165       boolean progressBarSet = false;
 166       AlignFrame af;
 167       // Combine the APPEND and OPEN files into one list, along with whether it
 168       // was APPEND or OPEN
 169       List<ArgValue> openAvList = new ArrayList<>();
 170       openAvList.addAll(avm.getArgValueList(Arg.OPEN));
 171       openAvList.addAll(avm.getArgValueList(Arg.APPEND));
 172       // sort avlist based on av.getArgIndex()
 173       Collections.sort(openAvList);
 174       for (ArgValue av : openAvList)
 175       {
 176         Arg a = av.getArg();
 177         SubVals sv = av.getSubVals();
 178         String openFile = av.getValue();
 179         if (openFile == null)
 180           continue;
 181
 182         theseArgsWereParsed = true;
 183         if (first)
 184         {
 185           first = false;
 186           if (!headless && desktop != null)
 187           {
 188             desktop.setProgressBar(
 189                     MessageManager.getString(
 190                             "status.processing_commandline_args"),
 191                     progress = System.currentTimeMillis());
 192             progressBarSet = true;
 193           }
 194         }
 195
 196         if (!Platform.isJS())
 197         /**
 198          * ignore in JavaScript -- can't just file existence - could load it?
 199          *
 200          * @j2sIgnore
 201          */
 202         {
 203           if (!HttpUtils.startsWithHttpOrHttps(openFile))
 204           {
 205             if (!(new File(openFile)).exists())
 206             {
 207               Console.warn("Can't find file '" + openFile + "'");
 208             }
 209           }
 210         }
 211
 212         DataSourceType protocol = AppletFormatAdapter
 213                 .checkProtocol(openFile);
 214
 215         FileFormatI format = null;
 216         try
 217         {
 218           format = new IdentifyFile().identify(openFile, protocol);
 219         } catch (FileFormatException e1)
 220         {
 221           Console.error("Unknown file format for '" + openFile + "'");
 222         }
 223
 224         af = afMap.get(id);
 225         // When to open a new AlignFrame
 226         if (af == null || "true".equals(av.getSubVal("new"))
 227                 || a == Arg.OPEN || format == FileFormat.Jalview)
 228         {
 229           if (a == Arg.OPEN)
 230           {
 231             Jalview.testoutput(argParser, Arg.OPEN, "examples/uniref50.fa",
 232                     openFile);
 233           }
 234
 235           Console.debug(
 236                   "Opening '" + openFile + "' in new alignment frame");
 237           FileLoader fileLoader = new FileLoader(!headless);
 238
 239           af = fileLoader.LoadFileWaitTillLoaded(openFile, protocol,
 240                   format);
 241
 242           // wrap alignment?
 243           boolean wrap = ArgParser.getFromSubValArgOrPref(avm, Arg.WRAP, sv,
 244                   null, "WRAP_ALIGNMENT", false);
 245           af.getCurrentView().setWrapAlignment(wrap);
 246
 247           // colour alignment?
 248           String colour = ArgParser.getFromSubValArgOrPref(avm, av,
 249                   Arg.COLOUR, sv, null, "DEFAULT_COLOUR_PROT", "");
 250           if ("" != colour)
 251           {
 252             af.changeColour_actionPerformed(colour);
 253             Jalview.testoutput(argParser, Arg.COLOUR, "zappo", colour);
 254           }
 255
 256           // Change alignment frame title
 257           String title = ArgParser.getFromSubValArgOrPref(avm, av,
 258                   Arg.TITLE, sv, null, null, null);
 259           if (title != null)
 260           {
 261             af.setTitle(title);
 262             Jalview.testoutput(argParser, Arg.TITLE, "test title", title);
 263           }
 264
 265           // Add features
 266           String featuresfile = ArgParser.getValueFromSubValOrArg(avm, av,
 267                   Arg.FEATURES, sv);
 268           if (featuresfile != null)
 269           {
 270             af.parseFeaturesFile(featuresfile,
 271                     AppletFormatAdapter.checkProtocol(featuresfile));
 272             Jalview.testoutput(argParser, Arg.FEATURES,
 273                     "examples/testdata/plantfdx.features", featuresfile);
 274           }
 275
 276           // Add annotations from file
 277           String annotationsfile = ArgParser.getValueFromSubValOrArg(avm,
 278                   av, Arg.ANNOTATIONS, sv);
 279           if (annotationsfile != null)
 280           {
 281             af.loadJalviewDataFile(annotationsfile, null, null, null);
 282             Jalview.testoutput(argParser, Arg.ANNOTATIONS,
 283                     "examples/testdata/plantfdx.annotations",
 284                     annotationsfile);
 285           }
 286
 287           // Set or clear the sortbytree flag
 288           boolean sortbytree = ArgParser.getBoolFromSubValOrArg(avm,
 289                   Arg.SORTBYTREE, sv);
 290           if (sortbytree)
 291           {
 292             af.getViewport().setSortByTree(true);
 293             Jalview.testoutput(argParser, Arg.SORTBYTREE);
 294           }
 295
 296           // Load tree from file
 297           String treefile = ArgParser.getValueFromSubValOrArg(avm, av,
 298                   Arg.TREE, sv);
 299           if (treefile != null)
 300           {
 301             try
 302             {
 303               NewickFile nf = new NewickFile(treefile,
 304                       AppletFormatAdapter.checkProtocol(treefile));
 305               af.getViewport().setCurrentTree(
 306                       af.showNewickTree(nf, treefile).getTree());
 307               Jalview.testoutput(argParser, Arg.TREE,
 308                       "examples/testdata/uniref50_test_tree", treefile);
 309             } catch (IOException e)
 310             {
 311               Console.warn("Couldn't add tree " + treefile, e);
 312             }
 313           }
 314
 315           // Show secondary structure annotations?
 316           boolean showSSAnnotations = ArgParser.getFromSubValArgOrPref(avm,
 317                   Arg.SHOWSSANNOTATIONS, av.getSubVals(), null,
 318                   "STRUCT_FROM_PDB", true);
 319           af.setAnnotationsVisibility(showSSAnnotations, true, false);
 320
 321           // Show sequence annotations?
 322           boolean showAnnotations = ArgParser.getFromSubValArgOrPref(avm,
 323                   Arg.SHOWANNOTATIONS, av.getSubVals(), null,
 324                   "SHOW_ANNOTATIONS", true);
 325           af.setAnnotationsVisibility(showAnnotations, false, true);
 326
 327           // show temperature factor annotations?
 328           if (avm.getBoolean(Arg.NOTEMPFAC))
 329           {
 330             // do this better (annotation types?)
 331             List<String> hideThese = new ArrayList<>();
 332             hideThese.add("Temperature Factor");
 333             hideThese.add(AlphaFoldAnnotationRowBuilder.LABEL);
 334             AlignmentUtils.showOrHideSequenceAnnotations(
 335                     af.getCurrentView().getAlignment(), hideThese, null,
 336                     false, false);
 337           }
 338
 339           // store the AlignFrame for this id
 340           afMap.put(id, af);
 341
 342           // is it its own structure file?
 343           if (format.isStructureFile())
 344           {
 345             StructureSelectionManager ssm = StructureSelectionManager
 346                     .getStructureSelectionManager(Desktop.instance);
 347             SequenceI seq = af.alignPanel.getAlignment().getSequenceAt(0);
 348             ssm.computeMapping(false, new SequenceI[] { seq }, null,
 349                     openFile, DataSourceType.FILE, null, null, null, false);
 350           }
 351         }
 352         else
 353         {
 354           Console.debug(
 355                   "Opening '" + openFile + "' in existing alignment frame");
 356           DataSourceType dst = HttpUtils.startsWithHttpOrHttps(openFile)
 357                   ? DataSourceType.URL
 358                   : DataSourceType.FILE;
 359           FileLoader fileLoader = new FileLoader(!headless);
 360           fileLoader.LoadFile(af.getCurrentView(), openFile, dst, null,
 361                   false);
 362         }
 363
 364         Console.debug("Command " + Arg.APPEND + " executed successfully!");
 365
 366       }
 367       if (first) // first=true means nothing opened
 368       {
 369         if (headless)
 370         {
 371           Jalview.exit("Could not open any files in headless mode", 1);
 372         }
 373         else
 374         {
 375           Console.warn("No more files to open");
 376         }
 377       }
 378       if (progressBarSet && desktop != null)
 379         desktop.setProgressBar(null, progress);
 380
 381     }
 382
 383     // open the structure (from same PDB file or given PDBfile)
 384     if (!avm.getBoolean(Arg.NOSTRUCTURE))
 385     {
 386       AlignFrame af = afMap.get(id);
 387       if (avm.containsArg(Arg.STRUCTURE))
 388       {
 389         commandArgsProvided = true;
 390         for (ArgValue av : avm.getArgValueList(Arg.STRUCTURE))
 391         {
 392           String val = av.getValue();
 393           SubVals subVals = av.getSubVals();
 394           SequenceI seq = getSpecifiedSequence(af, avm, av);
 395           if (seq == null)
 396           {
 397             // Could not find sequence from subId, let's assume the first
 398             // sequence in the alignframe
 399             AlignmentI al = af.getCurrentView().getAlignment();
 400             seq = al.getSequenceAt(0);
 401           }
 402
 403           if (seq == null)
 404           {
 405             Console.warn("Could not find sequence for argument "
 406                     + Arg.STRUCTURE.argString() + "=" + val);
 407             // you probably want to continue here, not break
 408             // break;
 409             continue;
 410           }
 411           File structureFile = null;
 412           if (subVals.getContent() != null
 413                   && subVals.getContent().length() != 0)
 414           {
 415             structureFile = new File(subVals.getContent());
 416             Console.debug("Using structure file (from argument) '"
 417                     + structureFile.getAbsolutePath() + "'");
 418           }
 419           // TRY THIS
 420           /*
 421            * PDBEntry fileEntry = new AssociatePdbFileWithSeq()
 422            * .associatePdbWithSeq(selectedPdbFileName, DataSourceType.FILE,
 423            * selectedSequence, true, Desktop.instance);
 424            *
 425            * sViewer = launchStructureViewer(ssm, new PDBEntry[] { fileEntry }, ap, new
 426            * SequenceI[] { selectedSequence });
 427            *
 428            */
 429           /* THIS DOESN'T WORK */
 430           else if (seq.getAllPDBEntries() != null
 431                   && seq.getAllPDBEntries().size() > 0)
 432           {
 433             structureFile = new File(
 434                     seq.getAllPDBEntries().elementAt(0).getFile());
 435             Console.debug("Using structure file (from sequence) '"
 436                     + structureFile.getAbsolutePath() + "'");
 437           }
 438
 439           if (structureFile == null)
 440           {
 441             Console.warn("Not provided structure file with '" + val + "'");
 442             continue;
 443           }
 444
 445           if (!structureFile.exists())
 446           {
 447             Console.warn("Structure file '"
 448                     + structureFile.getAbsoluteFile() + "' not found.");
 449             continue;
 450           }
 451
 452           Console.debug("Using structure file "
 453                   + structureFile.getAbsolutePath());
 454
 455           // ##### Does this need to happen? Follow
 456           // openStructureFileForSequence() below
 457           /*
 458           PDBEntry fileEntry = new AssociatePdbFileWithSeq()
 459                   .associatePdbWithSeq(structureFile.getAbsolutePath(),
 460                           DataSourceType.FILE, seq, true, Desktop.instance);
 461                           */
 462
 463           // open structure view
 464           AlignmentPanel ap = af.alignPanel;
 465           if (headless)
 466           {
 467             Cache.setProperty(Preferences.STRUCTURE_DISPLAY,
 468                     StructureViewer.ViewerType.JMOL.toString());
 469           }
 470
 471           String structureFilepath = structureFile.getAbsolutePath();
 472
 473           // get PAEMATRIX file and label from subvals or Arg.PAEMATRIX
 474           String paeFilepath = ArgParser
 475                   .getFromSubValArgOrPrefWithSubstitutions(argParser, avm,
 476                           Arg.PAEMATRIX, Position.AFTER, av, subVals, null,
 477                           null, null);
 478           if (paeFilepath != null)
 479           {
 480             File paeFile = new File(paeFilepath);
 481
 482             try
 483             {
 484               paeFilepath = paeFile.getCanonicalPath();
 485             } catch (IOException e)
 486             {
 487               paeFilepath = paeFile.getAbsolutePath();
 488               Console.warn("Problem with the PAE file path: '"
 489                       + paeFile.getPath() + "'");
 490             }
 491           }
 492
 493           // showing annotations from structure file or not
 494           boolean ssFromStructure = ArgParser.getFromSubValArgOrPref(avm,
 495                   Arg.SHOWSSANNOTATIONS, subVals, null, "STRUCT_FROM_PDB",
 496                   true);
 497
 498           // get TEMPFAC type from subvals or Arg.TEMPFAC in case user Adds
 499           // reference annotations
 500           String tftString = ArgParser
 501                   .getFromSubValArgOrPrefWithSubstitutions(argParser, avm,
 502                           Arg.TEMPFAC, Position.AFTER, av, subVals, null,
 503                           null, null);
 504           boolean notempfac = ArgParser.getFromSubValArgOrPref(avm,
 505                   Arg.NOTEMPFAC, subVals, null, "ADD_TEMPFACT_ANN", false,
 506                   true);
 507           TFType tft = notempfac ? null : TFType.DEFAULT;
 508           /*
 509           String tftString = subVals.get("tempfac");
 510           ArgValue tftAv = getArgAssociatedWithStructure(Arg.TEMPFAC, avm,
 511                   af, structureFilepath);
 512           if (tftString == null && tftAv != null)
 513           {
 514             tftString = tftAv.getSubVals().getContent();
 515           }
 516           */
 517           if (tftString != null && !notempfac)
 518           {
 519             // get kind of temperature factor annotation
 520             try
 521             {
 522               tft = TFType.valueOf(tftString.toUpperCase(Locale.ROOT));
 523               Console.debug("Obtained Temperature Factor type of '" + tft
 524                       + "' for structure '" + structureFilepath + "'");
 525             } catch (IllegalArgumentException e)
 526             {
 527               // Just an error message!
 528               StringBuilder sb = new StringBuilder().append("Cannot set ")
 529                       .append(Arg.TEMPFAC.argString()).append(" to '")
 530                       .append(tft)
 531                       .append("', ignoring.  Valid values are: ");
 532               Iterator<TFType> it = Arrays.stream(TFType.values())
 533                       .iterator();
 534               while (it.hasNext())
 535               {
 536                 sb.append(it.next().toString().toLowerCase(Locale.ROOT));
 537                 if (it.hasNext())
 538                   sb.append(", ");
 539               }
 540               Console.warn(sb.toString());
 541             }
 542           }
 543
 544           String sViewer = ArgParser.getFromSubValArgOrPref(avm,
 545                   Arg.STRUCTUREVIEWER, Position.AFTER, av, subVals, null,
 546                   null, "jmol");
 547           ViewerType viewerType = null;
 548           if (!"none".equals(sViewer))
 549           {
 550             for (ViewerType v : EnumSet.allOf(ViewerType.class))
 551             {
 552               String name = v.name().toLowerCase(Locale.ROOT)
 553                       .replaceAll(" ", "");
 554               if (sViewer.equals(name))
 555               {
 556                 viewerType = v;
 557                 break;
 558               }
 559             }
 560           }
 561
 562           // TODO use ssFromStructure
 563           StructureViewer sv = StructureChooser
 564                   .openStructureFileForSequence(null, null, ap, seq, false,
 565                           structureFilepath, tft, paeFilepath, false,
 566                           ssFromStructure, false, viewerType);
 567
 568           if (headless)
 569           {
 570             sv.setAsync(false);
 571           }
 572
 573           String structureImageFilename = ArgParser.getValueFromSubValOrArg(
 574                   avm, av, Arg.STRUCTUREIMAGE, subVals);
 575           if (sv != null && structureImageFilename != null)
 576           {
 577             File structureImageFile = new File(structureImageFilename);
 578             String width = ArgParser.getValueFromSubValOrArg(avm, av,
 579                     Arg.STRUCTUREIMAGEWIDTH, subVals);
 580             String height = ArgParser.getValueFromSubValOrArg(avm, av,
 581                     Arg.STRUCTUREIMAGEHEIGHT, subVals);
 582             String scale = ArgParser.getValueFromSubValOrArg(avm, av,
 583                     Arg.STRUCTUREIMAGESCALE, subVals);
 584             String renderer = ArgParser.getValueFromSubValOrArg(avm, av,
 585                     Arg.STRUCTUREIMAGETEXTRENDERER, subVals);
 586             String typeS = ArgParser.getValueFromSubValOrArg(avm, av,
 587                     Arg.STRUCTUREIMAGETYPE, subVals);
 588             if (typeS == null || typeS.length() == 0)
 589             {
 590               typeS = FileUtils.getExtension(structureImageFile);
 591             }
 592             TYPE imageType;
 593             try
 594             {
 595               imageType = Enum.valueOf(TYPE.class,
 596                       typeS.toUpperCase(Locale.ROOT));
 597             } catch (IllegalArgumentException e)
 598             {
 599               Console.warn("Do not know image format '" + typeS
 600                       + "', using PNG");
 601               imageType = TYPE.PNG;
 602             }
 603             BitmapImageSizing userBis = ImageMaker
 604                     .parseScaleWidthHeightStrings(scale, width, height);
 605             switch (StructureViewer.getViewerType())
 606             {
 607             case JMOL:
 608               try
 609               {
 610                 Thread.sleep(1000);
 611               } catch (InterruptedException e)
 612               {
 613                 // TODO Auto-generated catch block
 614                 e.printStackTrace();
 615               }
 616               JalviewStructureDisplayI sview = sv
 617                       .getJalviewStructureDisplay();
 618               if (sview instanceof AppJmol)
 619               {
 620                 AppJmol jmol = (AppJmol) sview;
 621                 jmol.makePDBImage(structureImageFile, imageType, renderer,
 622                         userBis);
 623               }
 624               break;
 625             default:
 626               Console.warn("Cannot export image for structure viewer "
 627                       + sv.getViewerType() + " yet");
 628               break;
 629             }
 630           }
 631         }
 632       }
 633     }
 634
 635     /*
 636     boolean doShading = avm.getBoolean(Arg.TEMPFAC_SHADING);
 637     if (doShading)
 638     {
 639       AlignFrame af = afMap.get(id);
 640       for (AlignmentAnnotation aa : af.alignPanel.getAlignment()
 641               .findAnnotation(PDBChain.class.getName().toString()))
 642       {
 643         AnnotationColourGradient acg = new AnnotationColourGradient(aa,
 644                 af.alignPanel.av.getGlobalColourScheme(), 0);
 645         acg.setSeqAssociated(true);
 646         af.changeColour(acg);
 647         Console.info("Changed colour " + acg.toString());
 648       }
 649     }
 650     */
 651
 652     return theseArgsWereParsed;
 653   }
 654
 655   protected void processGroovyScript(String id)
 656   {
 657     ArgValuesMap avm = argParser.getLinkedArgs(id);
 658     AlignFrame af = afMap.get(id);
 659
 660     if (af == null)
 661     {
 662       Console.warn("Did not have an alignment window for id=" + id);
 663       return;
 664     }
 665
 666     if (avm.containsArg(Arg.GROOVY))
 667     {
 668       String groovyscript = avm.getValue(Arg.GROOVY);
 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         Console.info("Executing script " + groovyscript);
 674         Jalview.getInstance().executeGroovyScript(groovyscript, af);
 675       }
 676     }
 677   }
 678
 679   protected boolean processImages(String id)
 680   {
 681     ArgValuesMap avm = argParser.getLinkedArgs(id);
 682     AlignFrame af = afMap.get(id);
 683
 684     if (af == null)
 685     {
 686       Console.warn("Did not have an alignment window for id=" + id);
 687       return false;
 688     }
 689
 690     if (avm.containsArg(Arg.IMAGE))
 691     {
 692       for (ArgValue av : avm.getArgValueList(Arg.IMAGE))
 693       {
 694         String val = av.getValue();
 695         SubVals subVal = av.getSubVals();
 696         String fileName = subVal.getContent();
 697         File file = new File(fileName);
 698         String name = af.getName();
 699         String renderer = ArgParser.getValueFromSubValOrArg(avm, av,
 700                 Arg.TEXTRENDERER, subVal);
 701         if (renderer == null)
 702           renderer = "text";
 703         String type = "png"; // default
 704
 705         String scale = ArgParser.getValueFromSubValOrArg(avm, av, Arg.SCALE,
 706                 subVal);
 707         String width = ArgParser.getValueFromSubValOrArg(avm, av, Arg.WIDTH,
 708                 subVal);
 709         String height = ArgParser.getValueFromSubValOrArg(avm, av,
 710                 Arg.HEIGHT, subVal);
 711         BitmapImageSizing userBis = ImageMaker
 712                 .parseScaleWidthHeightStrings(scale, width, height);
 713
 714         type = ArgParser.getValueFromSubValOrArg(avm, av, Arg.TYPE, subVal);
 715         if (type == null && fileName != null)
 716         {
 717           for (String ext : new String[] { "svg", "png", "html", "eps" })
 718           {
 719             if (fileName.toLowerCase(Locale.ROOT).endsWith("." + ext))
 720             {
 721               type = ext;
 722             }
 723           }
 724         }
 725         // for moment we disable JSON export
 726         Cache.setPropsAreReadOnly(true);
 727         Cache.setProperty("EXPORT_EMBBED_BIOJSON", "false");
 728
 729         Console.info("Writing " + file);
 730
 731         switch (type)
 732         {
 733
 734         case "svg":
 735           Console.debug("Outputting type '" + type + "' to " + fileName);
 736           af.createSVG(file, renderer);
 737           break;
 738
 739         case "png":
 740           Console.debug("Outputting type '" + type + "' to " + fileName);
 741           af.createPNG(file, null, userBis);
 742           break;
 743
 744         case "html":
 745           Console.debug("Outputting type '" + type + "' to " + fileName);
 746           HtmlSvgOutput htmlSVG = new HtmlSvgOutput(af.alignPanel);
 747           htmlSVG.exportHTML(fileName, renderer);
 748           break;
 749
 750         case "biojs":
 751           try
 752           {
 753             BioJsHTMLOutput.refreshVersionInfo(
 754                     BioJsHTMLOutput.BJS_TEMPLATES_LOCAL_DIRECTORY);
 755           } catch (URISyntaxException e)
 756           {
 757             e.printStackTrace();
 758           }
 759           BioJsHTMLOutput bjs = new BioJsHTMLOutput(af.alignPanel);
 760           bjs.exportHTML(fileName);
 761           Console.debug("Creating BioJS MSA Viwer HTML file: " + fileName);
 762           break;
 763
 764         case "eps":
 765           af.createEPS(file, name);
 766           Console.debug("Creating EPS file: " + fileName);
 767           break;
 768
 769         case "imagemap":
 770           af.createImageMap(file, name);
 771           Console.debug("Creating ImageMap file: " + fileName);
 772           break;
 773
 774         default:
 775           Console.warn(Arg.IMAGE.argString() + " type '" + type
 776                   + "' not known. Ignoring");
 777           break;
 778         }
 779       }
 780     }
 781     return true;
 782   }
 783
 784   protected boolean processOutput(String id)
 785   {
 786     ArgValuesMap avm = argParser.getLinkedArgs(id);
 787     AlignFrame af = afMap.get(id);
 788
 789     if (af == null)
 790     {
 791       Console.warn("Did not have an alignment window for id=" + id);
 792       return false;
 793     }
 794
 795     if (avm.containsArg(Arg.OUTPUT))
 796     {
 797       for (ArgValue av : avm.getArgValueList(Arg.OUTPUT))
 798       {
 799         String val = av.getValue();
 800         SubVals subVals = av.getSubVals();
 801         String fileName = subVals.getContent();
 802         File file = new File(fileName);
 803         boolean overwrite = ArgParser.getFromSubValArgOrPref(avm,
 804                 Arg.OVERWRITE, subVals, null, "OVERWRITE_OUTPUT", false);
 805         // backups. Use the Arg.BACKUPS or subval "backups" setting first,
 806         // otherwise if headless assume false, if not headless use the user
 807         // preference with default true.
 808         boolean backups = ArgParser.getFromSubValArgOrPref(avm, Arg.BACKUPS,
 809                 subVals, null,
 810                 Platform.isHeadless() ? null : BackupFiles.ENABLED,
 811                 !Platform.isHeadless());
 812
 813         // if backups is not true then --overwrite must be specified
 814         if (file.exists() && !(overwrite || backups))
 815         {
 816           Console.error("Won't overwrite file '" + fileName + "' without "
 817                   + Arg.OVERWRITE.argString() + " or "
 818                   + Arg.BACKUPS.argString() + " set");
 819           return false;
 820         }
 821
 822         String name = af.getName();
 823         String format = ArgParser.getValueFromSubValOrArg(avm, av,
 824                 Arg.FORMAT, subVals);
 825         FileFormats ffs = FileFormats.getInstance();
 826         List<String> validFormats = ffs.getWritableFormats(false);
 827
 828         FileFormatI ff = null;
 829         if (format == null && fileName != null)
 830         {
 831           FORMAT: for (String fname : validFormats)
 832           {
 833             FileFormatI tff = ffs.forName(fname);
 834             String[] extensions = tff.getExtensions().split(",");
 835             for (String ext : extensions)
 836             {
 837               if (fileName.toLowerCase(Locale.ROOT).endsWith("." + ext))
 838               {
 839                 ff = tff;
 840                 format = ff.getName();
 841                 break FORMAT;
 842               }
 843             }
 844           }
 845         }
 846         if (ff == null && format != null)
 847         {
 848           ff = ffs.forName(format);
 849         }
 850         if (ff == null)
 851         {
 852           StringBuilder validSB = new StringBuilder();
 853           for (String f : validFormats)
 854           {
 855             if (validSB.length() > 0)
 856               validSB.append(", ");
 857             validSB.append(f);
 858             FileFormatI tff = ffs.forName(f);
 859             validSB.append(" (");
 860             validSB.append(tff.getExtensions());
 861             validSB.append(")");
 862           }
 863
 864           Jalview.exit("No valid format specified for "
 865                   + Arg.OUTPUT.argString() + ". Valid formats are "
 866                   + validSB.toString() + ".", 1);
 867           // this return really shouldn't happen
 868           return false;
 869         }
 870
 871         String savedBackupsPreference = Cache
 872                 .getDefault(BackupFiles.ENABLED, null);
 873         Console.debug("Setting backups to " + backups);
 874         Cache.applicationProperties.put(BackupFiles.ENABLED,
 875                 Boolean.toString(backups));
 876
 877         Console.info("Writing " + fileName);
 878
 879         af.saveAlignment(fileName, ff);
 880         Console.debug("Returning backups to " + savedBackupsPreference);
 881         if (savedBackupsPreference != null)
 882           Cache.applicationProperties.put(BackupFiles.ENABLED,
 883                   savedBackupsPreference);
 884         if (af.isSaveAlignmentSuccessful())
 885         {
 886           Console.debug("Written alignment '" + name + "' in "
 887                   + ff.getName() + " format to " + file);
 888         }
 889         else
 890         {
 891           Console.warn("Error writing file " + file + " in " + ff.getName()
 892                   + " format!");
 893         }
 894
 895       }
 896     }
 897     return true;
 898   }
 899
 900   private SequenceI getSpecifiedSequence(AlignFrame af, ArgValuesMap avm,
 901           ArgValue av)
 902   {
 903     SubVals subVals = av.getSubVals();
 904     ArgValue idAv = avm.getClosestNextArgValueOfArg(av, Arg.SEQID);
 905     SequenceI seq = null;
 906     if (subVals == null && idAv == null)
 907       return null;
 908     if (af == null || af.getCurrentView() == null)
 909     {
 910       return null;
 911     }
 912     AlignmentI al = af.getCurrentView().getAlignment();
 913     if (al == null)
 914     {
 915       return null;
 916     }
 917     if (subVals != null)
 918     {
 919       if (subVals.has(Arg.SEQID.getName()))
 920       {
 921         seq = al.findName(subVals.get(Arg.SEQID.getName()));
 922       }
 923       else if (-1 < subVals.getIndex()
 924               && subVals.getIndex() < al.getSequences().size())
 925       {
 926         seq = al.getSequenceAt(subVals.getIndex());
 927       }
 928     }
 929     else if (idAv != null)
 930     {
 931       seq = al.findName(idAv.getValue());
 932     }
 933     return seq;
 934   }
 935 }