src/jalview/bin/Commands.java

   1 package jalview.bin;
   2
   3 import java.io.File;
   4 import java.io.IOException;
   5 import java.util.ArrayList;
   6 import java.util.Arrays;
   7 import java.util.Collections;
   8 import java.util.HashMap;
   9 import java.util.Iterator;
  10 import java.util.List;
  11 import java.util.Locale;
  12 import java.util.Map;
  13
  14 import jalview.analysis.AlignmentUtils;
  15 import jalview.api.AlignmentViewPanel;
  16 import jalview.bin.argparser.Arg;
  17 import jalview.bin.argparser.ArgParser;
  18 import jalview.bin.argparser.ArgValue;
  19 import jalview.bin.argparser.ArgValuesMap;
  20 import jalview.bin.argparser.SubVals;
  21 import jalview.datamodel.AlignmentAnnotation;
  22 import jalview.datamodel.AlignmentI;
  23 import jalview.datamodel.PDBEntry;
  24 import jalview.datamodel.SequenceI;
  25 import jalview.datamodel.annotations.AlphaFoldAnnotationRowBuilder;
  26 import jalview.gui.AlignFrame;
  27 import jalview.gui.AlignmentPanel;
  28 import jalview.gui.AssociatePdbFileWithSeq;
  29 import jalview.gui.Desktop;
  30 import jalview.gui.Preferences;
  31 import jalview.gui.StructureChooser;
  32 import jalview.gui.StructureViewer;
  33 import jalview.io.AppletFormatAdapter;
  34 import jalview.io.DataSourceType;
  35 import jalview.io.FileFormatException;
  36 import jalview.io.FileFormatI;
  37 import jalview.io.FileLoader;
  38 import jalview.io.HtmlSvgOutput;
  39 import jalview.io.IdentifyFile;
  40 import jalview.schemes.AnnotationColourGradient;
  41 import jalview.structure.StructureImportSettings;
  42 import jalview.structure.StructureImportSettings.TFType;
  43 import jalview.structure.StructureSelectionManager;
  44 import jalview.util.HttpUtils;
  45 import jalview.util.MessageManager;
  46 import jalview.util.Platform;
  47 import jalview.ws.dbsources.EBIAlfaFold;
  48 import mc_view.PDBChain;
  49
  50 public class Commands
  51 {
  52   Desktop desktop;
  53
  54   private boolean headless;
  55
  56   private ArgParser argParser;
  57
  58   private Map<String, AlignFrame> afMap;
  59
  60   private boolean commandArgsProvided = false;
  61
  62   private boolean argsWereParsed = false;
  63
  64   public Commands(ArgParser argparser, boolean headless)
  65   {
  66     this(Desktop.instance, argparser, headless);
  67   }
  68
  69   public Commands(Desktop d, ArgParser argparser, boolean h)
  70   {
  71     argParser = argparser;
  72     headless = h;
  73     desktop = d;
  74     afMap = new HashMap<String, AlignFrame>();
  75     if (argparser != null)
  76     {
  77       processArgs(argparser, headless);
  78     }
  79   }
  80
  81   private boolean processArgs(ArgParser argparser, boolean h)
  82   {
  83     argParser = argparser;
  84     headless = h;
  85     boolean theseArgsWereParsed = false;
  86
  87     if (argParser != null && argParser.linkedIds() != null)
  88     {
  89       for (String id : argParser.linkedIds())
  90       {
  91         ArgValuesMap avm = argParser.linkedArgs(id);
  92         theseArgsWereParsed = true;
  93         if (id == null)
  94         {
  95           theseArgsWereParsed &= processUnlinked(id);
  96         }
  97         else
  98         {
  99           theseArgsWereParsed &= processLinked(id);
 100         }
 101         theseArgsWereParsed &= processImages(id);
 102
 103         // close ap
 104         if (avm.getBoolean(Arg.CLOSE))
 105         {
 106           AlignFrame af = afMap.get(id);
 107           if (af != null)
 108           {
 109             af.closeMenuItem_actionPerformed(true);
 110           }
 111         }
 112
 113       }
 114
 115     }
 116     if (argParser.getBool(Arg.QUIT))
 117     {
 118       Jalview.getInstance().quit();
 119       return true;
 120     }
 121     // carry on with jalview.bin.Jalview
 122     argsWereParsed = theseArgsWereParsed;
 123     return argsWereParsed;
 124   }
 125
 126   public boolean commandArgsProvided()
 127   {
 128     return commandArgsProvided;
 129   }
 130
 131   public boolean argsWereParsed()
 132   {
 133     return argsWereParsed;
 134   }
 135
 136   protected boolean processUnlinked(String id)
 137   {
 138     return processLinked(id);
 139   }
 140
 141   protected boolean processLinked(String id)
 142   {
 143     boolean theseArgsWereParsed = false;
 144     ArgValuesMap avm = argParser.linkedArgs(id);
 145     if (avm == null)
 146       return true;
 147
 148     /*
 149     // script to execute after all loading is completed one way or another
 150     String groovyscript = m.get(Arg.GROOVY) == null ? null
 151             : m.get(Arg.GROOVY).getValue();
 152     String file = m.get(Arg.OPEN) == null ? null
 153             : m.get(Arg.OPEN).getValue();
 154     String data = null;
 155     FileFormatI format = null;
 156     DataSourceType protocol = null;
 157     */
 158     if (avm.containsArg(Arg.OPEN))
 159     {
 160       commandArgsProvided = true;
 161       long progress = -1;
 162
 163       boolean first = true;
 164       boolean progressBarSet = false;
 165       AlignFrame af;
 166       for (ArgValue av : avm.getArgValueList(Arg.OPEN))
 167       {
 168         String openFile = av.getValue();
 169         if (openFile == null)
 170           continue;
 171
 172         theseArgsWereParsed = true;
 173         if (first)
 174         {
 175           first = false;
 176           if (!headless && desktop != null)
 177           {
 178             desktop.setProgressBar(
 179                     MessageManager.getString(
 180                             "status.processing_commandline_args"),
 181                     progress = System.currentTimeMillis());
 182             progressBarSet = true;
 183           }
 184         }
 185
 186         if (!Platform.isJS())
 187         /**
 188          * ignore in JavaScript -- can't just file existence - could load it?
 189          *
 190          * @j2sIgnore
 191          */
 192         {
 193           if (!HttpUtils.startsWithHttpOrHttps(openFile))
 194           {
 195             if (!(new File(openFile)).exists())
 196             {
 197               Console.warn("Can't find file '" + openFile + "'");
 198             }
 199           }
 200         }
 201
 202         DataSourceType protocol = AppletFormatAdapter
 203                 .checkProtocol(openFile);
 204
 205         FileFormatI format = null;
 206         try
 207         {
 208           format = new IdentifyFile().identify(openFile, protocol);
 209         } catch (FileFormatException e1)
 210         {
 211           Console.error("Unknown file format for '" + openFile + "'");
 212         }
 213
 214         af = afMap.get(id);
 215         if (af == null)
 216         {
 217           /*
 218            * this approach isn't working yet
 219           // get default annotations before opening AlignFrame
 220           if (m.get(Arg.SSANNOTATION) != null)
 221           {
 222             Console.debug("***** SSANNOTATION="
 223                     + m.get(Arg.SSANNOTATION).getBoolean());
 224           }
 225           if (m.get(Arg.NOTEMPFAC) != null)
 226           {
 227             Console.debug(
 228                     "***** NOTEMPFAC=" + m.get(Arg.NOTEMPFAC).getBoolean());
 229           }
 230           boolean showSecondaryStructure = (m.get(Arg.SSANNOTATION) != null)
 231                   ? m.get(Arg.SSANNOTATION).getBoolean()
 232                   : false;
 233           boolean showTemperatureFactor = (m.get(Arg.NOTEMPFAC) != null)
 234                   ? !m.get(Arg.NOTEMPFAC).getBoolean()
 235                   : false;
 236           Console.debug("***** tempfac=" + showTemperatureFactor
 237                   + ", showSS=" + showSecondaryStructure);
 238           StructureSelectionManager ssm = StructureSelectionManager
 239                   .getStructureSelectionManager(Desktop.instance);
 240           if (ssm != null)
 241           {
 242             ssm.setAddTempFacAnnot(showTemperatureFactor);
 243             ssm.setProcessSecondaryStructure(showSecondaryStructure);
 244           }
 245            */
 246
 247           // get kind of temperature factor annotation
 248           StructureImportSettings.TFType tempfacType = TFType.DEFAULT;
 249           if ((!avm.getBoolean(Arg.NOTEMPFAC))
 250                   && avm.containsArg(Arg.TEMPFAC))
 251           {
 252             try
 253             {
 254               tempfacType = StructureImportSettings.TFType
 255                       .valueOf(avm.getArgValue(Arg.TEMPFAC).getValue()
 256                               .toUpperCase(Locale.ROOT));
 257               Console.debug("Obtained Temperature Factor type of '"
 258                       + tempfacType + "'");
 259             } catch (IllegalArgumentException e)
 260             {
 261               // Just an error message!
 262               StringBuilder sb = new StringBuilder().append("Cannot set --")
 263                       .append(Arg.TEMPFAC.getName()).append(" to '")
 264                       .append(tempfacType)
 265                       .append("', ignoring.  Valid values are: ");
 266               Iterator<StructureImportSettings.TFType> it = Arrays
 267                       .stream(StructureImportSettings.TFType.values())
 268                       .iterator();
 269               while (it.hasNext())
 270               {
 271                 sb.append(it.next().toString().toLowerCase(Locale.ROOT));
 272                 if (it.hasNext())
 273                   sb.append(", ");
 274               }
 275               Console.warn(sb.toString());
 276             }
 277           }
 278
 279           Console.debug(
 280                   "Opening '" + openFile + "' in new alignment frame");
 281           FileLoader fileLoader = new FileLoader(!headless);
 282
 283           StructureImportSettings.setTemperatureFactorType(tempfacType);
 284
 285           af = fileLoader.LoadFileWaitTillLoaded(openFile, protocol,
 286                   format);
 287
 288           // wrap alignment?
 289           if (avm.getBoolean(Arg.WRAP))
 290           {
 291             af.getCurrentView().setWrapAlignment(true);
 292           }
 293
 294           // colour aligment?
 295           if (avm.containsArg(Arg.COLOUR))
 296           {
 297             af.changeColour_actionPerformed(avm.getValue(Arg.COLOUR));
 298           }
 299
 300           // change alignment frame title
 301           if (avm.containsArg(Arg.TITLE))
 302             af.setTitle(avm.getValue(Arg.TITLE));
 303
 304           /* hacky approach to hiding the annotations */
 305           // show secondary structure annotations?
 306           if (avm.getBoolean(Arg.SSANNOTATION))
 307           {
 308             // do this better (annotation types?)
 309             AlignmentUtils.showOrHideSequenceAnnotations(
 310                     af.getCurrentView().getAlignment(),
 311                     Collections.singleton("Secondary Structure"), null,
 312                     false, false);
 313           }
 314
 315           // show temperature factor annotations?
 316           if (avm.getBoolean(Arg.NOTEMPFAC))
 317           {
 318             // do this better (annotation types?)
 319             List<String> hideThese = new ArrayList<>();
 320             hideThese.add("Temperature Factor");
 321             hideThese.add(AlphaFoldAnnotationRowBuilder.LABEL);
 322             AlignmentUtils.showOrHideSequenceAnnotations(
 323                     af.getCurrentView().getAlignment(), hideThese, null,
 324                     false, false);
 325           }
 326           else
 327           /* comment out hacky approach up to here and add this line:
 328            if (showTemperatureFactor)
 329              */
 330           {
 331             if (avm.containsArg(Arg.TEMPFAC_LABEL))
 332             {
 333               AlignmentAnnotation aa = AlignmentUtils
 334                       .getFirstSequenceAnnotationOfType(
 335                               af.getCurrentView().getAlignment(),
 336                               AlignmentAnnotation.LINE_GRAPH);
 337               String label = avm.getValue(Arg.TEMPFAC_LABEL);
 338               if (aa != null)
 339               {
 340                 aa.label = label;
 341               }
 342               else
 343               {
 344                 Console.info(
 345                         "Could not find annotation to apply tempfac_label '"
 346                                 + label);
 347               }
 348             }
 349           }
 350
 351           // store the AlignFrame for this id
 352           afMap.put(id, af);
 353
 354           // is it its own structure file?
 355           if (format.isStructureFile())
 356           {
 357             StructureSelectionManager ssm = StructureSelectionManager
 358                     .getStructureSelectionManager(Desktop.instance);
 359             SequenceI seq = af.alignPanel.getAlignment().getSequenceAt(0);
 360             ssm.computeMapping(false, new SequenceI[] { seq }, null,
 361                     openFile, DataSourceType.FILE, null, null, null);
 362           }
 363         }
 364         else
 365         {
 366           Console.debug(
 367                   "Opening '" + openFile + "' in existing alignment frame");
 368           af.getCurrentView().addFile(new File(openFile), format, false);
 369         }
 370
 371         Console.debug("Command " + Arg.OPEN + " executed successfully!");
 372
 373       }
 374       if (first) // first=true means nothing opened
 375       {
 376         if (headless)
 377         {
 378           Jalview.exit("Could not open any files in headless mode", 1);
 379         }
 380         else
 381         {
 382           Console.warn("No more files to open");
 383         }
 384       }
 385       if (progressBarSet && desktop != null)
 386         desktop.setProgressBar(null, progress);
 387
 388     }
 389
 390     // open the structure (from same PDB file or given PDBfile)
 391     if (!avm.getBoolean(Arg.NOSTRUCTURE))
 392     {
 393       AlignFrame af = afMap.get(id);
 394       if (avm.containsArg(Arg.STRUCTURE))
 395       {
 396         commandArgsProvided = true;
 397         for (ArgValue av : avm.getArgValueList(Arg.STRUCTURE))
 398         {
 399           String val = av.getValue();
 400           SubVals subId = new SubVals(val);
 401           SequenceI seq = getSpecifiedSequence(af, subId);
 402           if (seq == null)
 403           {
 404             Console.warn("Could not find sequence for argument --"
 405                     + Arg.STRUCTURE + "=" + val);
 406             // you probably want to continue here, not break
 407             // break;
 408             continue;
 409           }
 410           File structureFile = null;
 411           if (subId.getContent() != null
 412                   && subId.getContent().length() != 0)
 413           {
 414             structureFile = new File(subId.getContent());
 415             Console.debug("Using structure file (from argument) '"
 416                     + structureFile.getAbsolutePath() + "'");
 417           }
 418
 419           // TRY THIS
 420           /*
 421            PDBEntry fileEntry = new AssociatePdbFileWithSeq()
 422                   .associatePdbWithSeq(selectedPdbFileName,
 423                           DataSourceType.FILE, selectedSequence, true,
 424                           Desktop.instance);
 425
 426            sViewer = launchStructureViewer(ssm, new PDBEntry[] { fileEntry },
 427                   ap, new SequenceI[]
 428                   { selectedSequence });
 429
 430            */
 431
 432           /* THIS DOESN'T WORK */
 433           else if (seq.getAllPDBEntries() != null
 434                   && seq.getAllPDBEntries().size() > 0)
 435           {
 436             structureFile = new File(
 437                     seq.getAllPDBEntries().elementAt(0).getFile());
 438             Console.debug("Using structure file (from sequence) '"
 439                     + structureFile.getAbsolutePath() + "'");
 440           }
 441
 442           if (structureFile == null)
 443           {
 444             Console.warn("Not provided structure file with '" + val + "'");
 445             continue;
 446           }
 447
 448           if (!structureFile.exists())
 449           {
 450             Console.warn("Structure file '"
 451                     + structureFile.getAbsoluteFile() + "' not found.");
 452             continue;
 453           }
 454
 455           Console.debug("Using structure file "
 456                   + structureFile.getAbsolutePath());
 457
 458           PDBEntry fileEntry = new AssociatePdbFileWithSeq()
 459                   .associatePdbWithSeq(structureFile.getAbsolutePath(),
 460                           DataSourceType.FILE, seq, true, Desktop.instance);
 461
 462           // open structure view
 463           AlignmentPanel ap = af.alignPanel;
 464           if (headless)
 465           {
 466             Cache.setProperty(Preferences.STRUCTURE_DISPLAY,
 467                     StructureViewer.ViewerType.JMOL.toString());
 468           }
 469
 470           // get tft, paeFilename, label?
 471           /*
 472           ArgValue tftAv = avm.getArgValuesReferringTo("structid", structId,
 473                   Arg.TEMPFAC);
 474            */
 475           StructureChooser.openStructureFileForSequence(null, null, ap, seq,
 476                   false, structureFile.getAbsolutePath(), null, null); // tft,
 477                                                                        // paeFilename);
 478         }
 479       }
 480     }
 481
 482     // load a pAE file if given
 483     if (avm.containsArg(Arg.PAEMATRIX))
 484     {
 485       AlignFrame af = afMap.get(id);
 486       if (af != null)
 487       {
 488         for (ArgValue av : avm.getArgValueList(Arg.PAEMATRIX))
 489         {
 490           String val = av.getValue();
 491           SubVals subVals = ArgParser.getSubVals(val);
 492           File paeFile = new File(subVals.getContent());
 493           String paePath = null;
 494           try
 495           {
 496             paePath = paeFile.getCanonicalPath();
 497           } catch (IOException e)
 498           {
 499             paePath = paeFile.getAbsolutePath();
 500             Console.warn(
 501                     "Problem with the PAE file path: '" + paePath + "'");
 502           }
 503           String structId = subVals.get("structid");
 504           if (subVals.notSet())
 505           {
 506             // take structid from pdbfilename
 507           }
 508           if (subVals.has("structfile"))
 509           {
 510             Console.info("***** Attaching paeFile '" + paePath + "' to "
 511                     + "structfile=" + subVals.get("structfile"));
 512             EBIAlfaFold.addAlphaFoldPAE(af.getCurrentView().getAlignment(),
 513                     paeFile, subVals.getIndex(), subVals.get("structfile"),
 514                     true, false);
 515           }
 516           else if (subVals.has("structid"))
 517           {
 518             Console.info("***** Attaching paeFile '" + paePath + "' to "
 519                     + "structid=" + subVals.get("structid"));
 520             EBIAlfaFold.addAlphaFoldPAE(af.getCurrentView().getAlignment(),
 521                     paeFile, subVals.getIndex(), subVals.get("structid"),
 522                     true, true);
 523           }
 524           else
 525           {
 526             Console.debug("***** Attaching paeFile '" + paePath
 527                     + "' to sequence index " + subVals.getIndex());
 528             EBIAlfaFold.addAlphaFoldPAE(af.getCurrentView().getAlignment(),
 529                     paeFile, subVals.getIndex(), null, false, false);
 530             // required to readjust the height and position of the pAE
 531             // annotation
 532           }
 533           for (AlignmentViewPanel ap : af.getAlignPanels())
 534           {
 535             ap.adjustAnnotationHeight();
 536           }
 537         }
 538       }
 539     }
 540
 541     boolean doShading = avm.getBoolean(Arg.TEMPFAC_SHADING);
 542     if (doShading)
 543     {
 544       AlignFrame af = afMap.get(id);
 545       for (AlignmentAnnotation aa : af.alignPanel.getAlignment()
 546               .findAnnotation(PDBChain.class.getName().toString()))
 547       {
 548         AnnotationColourGradient acg = new AnnotationColourGradient(aa,
 549                 af.alignPanel.av.getGlobalColourScheme(), 0);
 550         acg.setSeqAssociated(true);
 551         af.changeColour(acg);
 552         Console.info("Changed colour " + acg.toString());
 553       }
 554     }
 555
 556     return theseArgsWereParsed;
 557   }
 558
 559   protected boolean processImages(String id)
 560   {
 561     ArgValuesMap avm = argParser.linkedArgs(id);
 562     AlignFrame af = afMap.get(id);
 563
 564     if (af == null)
 565     {
 566       Console.warn("Did not have an alignment window for id=" + id);
 567       return false;
 568     }
 569
 570     if (avm.containsArg(Arg.IMAGE))
 571     {
 572       for (ArgValue av : avm.getArgValueList(Arg.IMAGE))
 573       {
 574         String val = av.getValue();
 575         SubVals subVal = new SubVals(val);
 576         String type = "png"; // default
 577         String fileName = subVal.getContent();
 578         File file = new File(fileName);
 579         if (subVal.has("type"))
 580         {
 581           type = subVal.get("type");
 582         }
 583         else if (fileName != null)
 584         {
 585           for (String ext : new String[] { "svg", "png", "html" })
 586           {
 587             if (fileName.toLowerCase(Locale.ROOT).endsWith("." + ext))
 588             {
 589               type = ext;
 590             }
 591           }
 592         }
 593         // for moment we disable JSON export
 594         Cache.setPropsAreReadOnly(true);
 595         Cache.setProperty("EXPORT_EMBBED_BIOJSON", "false");
 596
 597         switch (type)
 598         {
 599         case "svg":
 600           Console.debug("Outputting type '" + type + "' to " + fileName);
 601           af.createSVG(file);
 602           break;
 603         case "png":
 604           Console.debug("Outputting type '" + type + "' to " + fileName);
 605           af.createPNG(file);
 606           break;
 607         case "html":
 608           Console.debug("Outputting type '" + type + "' to " + fileName);
 609           HtmlSvgOutput htmlSVG = new HtmlSvgOutput(af.alignPanel);
 610           htmlSVG.exportHTML(fileName);
 611           break;
 612         default:
 613           Console.warn("--image type '" + type + "' not known. Ignoring");
 614           break;
 615         }
 616       }
 617     }
 618     return true;
 619   }
 620
 621   private SequenceI getSpecifiedSequence(AlignFrame af, SubVals subId)
 622   {
 623     AlignmentI al = af.getCurrentView().getAlignment();
 624     if (-1 < subId.getIndex()
 625             && subId.getIndex() < al.getSequences().size())
 626     {
 627       return al.getSequenceAt(subId.getIndex());
 628     }
 629     else if (subId.has("seqid"))
 630     {
 631       return al.findName(subId.get("seqid"));
 632     }
 633     return null;
 634   }
 635 }