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