src/jalview/ext/rbvi/chimera/JalviewChimeraBinding.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.ext.rbvi.chimera;
  22
  23 import jalview.api.AlignmentViewPanel;
  24 import jalview.api.SequenceRendererI;
  25 import jalview.api.structures.JalviewStructureDisplayI;
  26 import jalview.bin.Cache;
  27 import jalview.datamodel.AlignmentI;
  28 import jalview.datamodel.HiddenColumns;
  29 import jalview.datamodel.PDBEntry;
  30 import jalview.datamodel.SearchResultMatchI;
  31 import jalview.datamodel.SearchResultsI;
  32 import jalview.datamodel.SequenceFeature;
  33 import jalview.datamodel.SequenceI;
  34 import jalview.httpserver.AbstractRequestHandler;
  35 import jalview.io.DataSourceType;
  36 import jalview.schemes.ColourSchemeI;
  37 import jalview.schemes.ResidueProperties;
  38 import jalview.structure.AtomSpec;
  39 import jalview.structure.StructureMappingcommandSet;
  40 import jalview.structure.StructureSelectionManager;
  41 import jalview.structures.models.AAStructureBindingModel;
  42 import jalview.util.MessageManager;
  43
  44 import java.awt.Color;
  45 import java.io.File;
  46 import java.io.FileOutputStream;
  47 import java.io.IOException;
  48 import java.io.PrintWriter;
  49 import java.net.BindException;
  50 import java.util.ArrayList;
  51 import java.util.BitSet;
  52 import java.util.Collections;
  53 import java.util.Hashtable;
  54 import java.util.LinkedHashMap;
  55 import java.util.List;
  56 import java.util.Map;
  57
  58 import ext.edu.ucsf.rbvi.strucviz2.ChimeraManager;
  59 import ext.edu.ucsf.rbvi.strucviz2.ChimeraModel;
  60 import ext.edu.ucsf.rbvi.strucviz2.StructureManager;
  61 import ext.edu.ucsf.rbvi.strucviz2.StructureManager.ModelType;
  62
  63 public abstract class JalviewChimeraBinding extends AAStructureBindingModel
  64 {
  65   public static final String CHIMERA_FEATURE_GROUP = "Chimera";
  66
  67   // Chimera clause to exclude alternate locations in atom selection
  68   private static final String NO_ALTLOCS = "&~@.B-Z&~@.2-9";
  69
  70   private static final String COLOURING_CHIMERA = MessageManager
  71           .getString("status.colouring_chimera");
  72
  73   private static final boolean debug = false;
  74
  75   private static final String PHOSPHORUS = "P";
  76
  77   private static final String ALPHACARBON = "CA";
  78
  79   private List<String> chainNames = new ArrayList<String>();
  80
  81   private Hashtable<String, String> chainFile = new Hashtable<String, String>();
  82
  83   /*
  84    * Object through which we talk to Chimera
  85    */
  86   private ChimeraManager viewer;
  87
  88   /*
  89    * Object which listens to Chimera notifications
  90    */
  91   private AbstractRequestHandler chimeraListener;
  92
  93   /*
  94    * set if chimera state is being restored from some source - instructs binding
  95    * not to apply default display style when structure set is updated for first
  96    * time.
  97    */
  98   private boolean loadingFromArchive = false;
  99
 100   /*
 101    * flag to indicate if the Chimera viewer should ignore sequence colouring
 102    * events from the structure manager because the GUI is still setting up
 103    */
 104   private boolean loadingFinished = true;
 105
 106   /*
 107    * Map of ChimeraModel objects keyed by PDB full local file name
 108    */
 109   private Map<String, List<ChimeraModel>> chimeraMaps = new LinkedHashMap<String, List<ChimeraModel>>();
 110
 111   String lastHighlightCommand;
 112
 113   /*
 114    * incremented every time a load notification is successfully handled -
 115    * lightweight mechanism for other threads to detect when they can start
 116    * referring to new structures.
 117    */
 118   private long loadNotifiesHandled = 0;
 119
 120   private Thread chimeraMonitor;
 121
 122   /**
 123    * Open a PDB structure file in Chimera and set up mappings from Jalview.
 124    *
 125    * We check if the PDB model id is already loaded in Chimera, if so don't
 126    * reopen it. This is the case if Chimera has opened a saved session file.
 127    *
 128    * @param pe
 129    * @return
 130    */
 131   public boolean openFile(PDBEntry pe)
 132   {
 133     String file = pe.getFile();
 134     try
 135     {
 136       List<ChimeraModel> modelsToMap = new ArrayList<ChimeraModel>();
 137       List<ChimeraModel> oldList = viewer.getModelList();
 138       boolean alreadyOpen = false;
 139
 140       /*
 141        * If Chimera already has this model, don't reopen it, but do remap it.
 142        */
 143       for (ChimeraModel open : oldList)
 144       {
 145         if (open.getModelName().equals(pe.getId()))
 146         {
 147           alreadyOpen = true;
 148           modelsToMap.add(open);
 149         }
 150       }
 151
 152       /*
 153        * If Chimera doesn't yet have this model, ask it to open it, and retrieve
 154        * the model name(s) added by Chimera.
 155        */
 156       if (!alreadyOpen)
 157       {
 158         viewer.openModel(file, pe.getId(), ModelType.PDB_MODEL);
 159         List<ChimeraModel> newList = viewer.getModelList();
 160         // JAL-1728 newList.removeAll(oldList) does not work
 161         for (ChimeraModel cm : newList)
 162         {
 163           if (cm.getModelName().equals(pe.getId()))
 164           {
 165             modelsToMap.add(cm);
 166           }
 167         }
 168       }
 169
 170       chimeraMaps.put(file, modelsToMap);
 171
 172       if (getSsm() != null)
 173       {
 174         getSsm().addStructureViewerListener(this);
 175       }
 176       return true;
 177     } catch (Exception q)
 178     {
 179       log("Exception when trying to open model " + file + "\n"
 180               + q.toString());
 181       q.printStackTrace();
 182     }
 183     return false;
 184   }
 185
 186   /**
 187    * Constructor
 188    *
 189    * @param ssm
 190    * @param pdbentry
 191    * @param sequenceIs
 192    * @param protocol
 193    */
 194   public JalviewChimeraBinding(StructureSelectionManager ssm,
 195           PDBEntry[] pdbentry, SequenceI[][] sequenceIs,
 196           DataSourceType protocol)
 197   {
 198     super(ssm, pdbentry, sequenceIs, protocol);
 199     viewer = new ChimeraManager(new StructureManager(true));
 200   }
 201
 202   /**
 203    * Starts a thread that waits for the Chimera process to finish, so that we
 204    * can then close the associated resources. This avoids leaving orphaned
 205    * Chimera viewer panels in Jalview if the user closes Chimera.
 206    */
 207   protected void startChimeraProcessMonitor()
 208   {
 209     final Process p = viewer.getChimeraProcess();
 210     chimeraMonitor = new Thread(new Runnable()
 211     {
 212
 213       @Override
 214       public void run()
 215       {
 216         try
 217         {
 218           p.waitFor();
 219           JalviewStructureDisplayI display = getViewer();
 220           if (display != null)
 221           {
 222             display.closeViewer(false);
 223           }
 224         } catch (InterruptedException e)
 225         {
 226           // exit thread if Chimera Viewer is closed in Jalview
 227         }
 228       }
 229     });
 230     chimeraMonitor.start();
 231   }
 232
 233   /**
 234    * Start a dedicated HttpServer to listen for Chimera notifications, and tell
 235    * it to start listening
 236    */
 237   public void startChimeraListener()
 238   {
 239     try
 240     {
 241       chimeraListener = new ChimeraListener(this);
 242       viewer.startListening(chimeraListener.getUri());
 243     } catch (BindException e)
 244     {
 245       System.err.println(
 246               "Failed to start Chimera listener: " + e.getMessage());
 247     }
 248   }
 249
 250   /**
 251    * Tells Chimera to display only the specified chains
 252    *
 253    * @param toshow
 254    */
 255   public void showChains(List<String> toshow)
 256   {
 257     /*
 258      * Construct a chimera command like
 259      *
 260      * ~display #*;~ribbon #*;ribbon :.A,:.B
 261      */
 262     StringBuilder cmd = new StringBuilder(64);
 263     boolean first = true;
 264     for (String chain : toshow)
 265     {
 266       int modelNumber = getModelNoForChain(chain);
 267       String showChainCmd = modelNumber == -1 ? ""
 268               : modelNumber + ":." + chain.split(":")[1];
 269       if (!first)
 270       {
 271         cmd.append(",");
 272       }
 273       cmd.append(showChainCmd);
 274       first = false;
 275     }
 276
 277     /*
 278      * could append ";focus" to this command to resize the display to fill the
 279      * window, but it looks more helpful not to (easier to relate chains to the
 280      * whole)
 281      */
 282     final String command = "~display #*; ~ribbon #*; ribbon :"
 283             + cmd.toString();
 284     sendChimeraCommand(command, false);
 285   }
 286
 287   /**
 288    * Close down the Jalview viewer and listener, and (optionally) the associated
 289    * Chimera window.
 290    */
 291   public void closeViewer(boolean closeChimera)
 292   {
 293     getSsm().removeStructureViewerListener(this, this.getStructureFiles());
 294     if (closeChimera)
 295     {
 296       viewer.exitChimera();
 297     }
 298     if (this.chimeraListener != null)
 299     {
 300       chimeraListener.shutdown();
 301       chimeraListener = null;
 302     }
 303     viewer = null;
 304
 305     if (chimeraMonitor != null)
 306     {
 307       chimeraMonitor.interrupt();
 308     }
 309     releaseUIResources();
 310   }
 311
 312   @Override
 313   public void colourByChain()
 314   {
 315     super.colourByChain();
 316     sendAsynchronousCommand("rainbow chain", COLOURING_CHIMERA);
 317   }
 318
 319   /**
 320    * Constructs and sends a Chimera command to colour by charge
 321    * <ul>
 322    * <li>Aspartic acid and Glutamic acid (negative charge) red</li>
 323    * <li>Lysine and Arginine (positive charge) blue</li>
 324    * <li>Cysteine - yellow</li>
 325    * <li>all others - white</li>
 326    * </ul>
 327    */
 328   @Override
 329   public void colourByCharge()
 330   {
 331     super.colourByCharge();
 332     String command = "color white;color red ::ASP;color red ::GLU;color blue ::LYS;color blue ::ARG;color yellow ::CYS";
 333     sendAsynchronousCommand(command, COLOURING_CHIMERA);
 334   }
 335
 336   /**
 337    * {@inheritDoc}
 338    */
 339   @Override
 340   public String superposeStructures(AlignmentI[] _alignment,
 341           int[] _refStructure, HiddenColumns[] _hiddenCols)
 342   {
 343     StringBuilder allComs = new StringBuilder(128);
 344     String[] files = getStructureFiles();
 345
 346     if (!waitForFileLoad(files))
 347     {
 348       return null;
 349     }
 350
 351     refreshPdbEntries();
 352     StringBuilder selectioncom = new StringBuilder(256);
 353     for (int a = 0; a < _alignment.length; a++)
 354     {
 355       int refStructure = _refStructure[a];
 356       AlignmentI alignment = _alignment[a];
 357       HiddenColumns hiddenCols = _hiddenCols[a];
 358
 359       if (refStructure >= files.length)
 360       {
 361         System.err.println("Ignoring invalid reference structure value "
 362                 + refStructure);
 363         refStructure = -1;
 364       }
 365
 366       /*
 367        * 'matched' bit i will be set for visible alignment columns i where
 368        * all sequences have a residue with a mapping to the PDB structure
 369        */
 370       BitSet matched = new BitSet();
 371       for (int m = 0; m < alignment.getWidth(); m++)
 372       {
 373         if (hiddenCols == null || hiddenCols.isVisible(m))
 374         {
 375           matched.set(m);
 376         }
 377       }
 378
 379       SuperposeData[] structures = new SuperposeData[files.length];
 380       for (int f = 0; f < files.length; f++)
 381       {
 382         structures[f] = new SuperposeData(alignment.getWidth());
 383       }
 384
 385       /*
 386        * Calculate the superposable alignment columns ('matched'), and the
 387        * corresponding structure residue positions (structures.pdbResNo)
 388        */
 389       int candidateRefStructure = findSuperposableResidues(alignment,
 390               matched, structures);
 391       if (refStructure < 0)
 392       {
 393         /*
 394          * If no reference structure was specified, pick the first one that has
 395          * a mapping in the alignment
 396          */
 397         refStructure = candidateRefStructure;
 398       }
 399
 400       int nmatched = matched.cardinality();
 401       if (nmatched < 4)
 402       {
 403         return MessageManager.formatMessage("label.insufficient_residues",
 404                 nmatched);
 405       }
 406
 407       /*
 408        * Generate select statements to select regions to superimpose structures
 409        */
 410       String[] selcom = new String[files.length];
 411       for (int pdbfnum = 0; pdbfnum < files.length; pdbfnum++)
 412       {
 413         String chainCd = "." + structures[pdbfnum].chain;
 414         int lpos = -1;
 415         boolean run = false;
 416         StringBuilder molsel = new StringBuilder();
 417
 418         int nextColumnMatch = matched.nextSetBit(0);
 419         while (nextColumnMatch != -1)
 420         {
 421           int pdbResNum = structures[pdbfnum].pdbResNo[nextColumnMatch];
 422           if (lpos != pdbResNum - 1)
 423           {
 424             /*
 425              * discontiguous - append last residue now
 426              */
 427             if (lpos != -1)
 428             {
 429               molsel.append(String.valueOf(lpos));
 430               molsel.append(chainCd);
 431               molsel.append(",");
 432             }
 433             run = false;
 434           }
 435           else
 436           {
 437             /*
 438              * extending a contiguous run
 439              */
 440             if (!run)
 441             {
 442               /*
 443                * start the range selection
 444                */
 445               molsel.append(String.valueOf(lpos));
 446               molsel.append("-");
 447             }
 448             run = true;
 449           }
 450           lpos = pdbResNum;
 451           nextColumnMatch = matched.nextSetBit(nextColumnMatch + 1);
 452         }
 453
 454         /*
 455          * and terminate final selection
 456          */
 457         if (lpos != -1)
 458         {
 459           molsel.append(String.valueOf(lpos));
 460           molsel.append(chainCd);
 461         }
 462         if (molsel.length() > 1)
 463         {
 464           selcom[pdbfnum] = molsel.toString();
 465           selectioncom.append("#").append(String.valueOf(pdbfnum))
 466                   .append(":");
 467           selectioncom.append(selcom[pdbfnum]);
 468           selectioncom.append(" ");
 469           if (pdbfnum < files.length - 1)
 470           {
 471             selectioncom.append("| ");
 472           }
 473         }
 474         else
 475         {
 476           selcom[pdbfnum] = null;
 477         }
 478       }
 479
 480       StringBuilder command = new StringBuilder(256);
 481       for (int pdbfnum = 0; pdbfnum < files.length; pdbfnum++)
 482       {
 483         if (pdbfnum == refStructure || selcom[pdbfnum] == null
 484                 || selcom[refStructure] == null)
 485         {
 486           continue;
 487         }
 488         if (command.length() > 0)
 489         {
 490           command.append(";");
 491         }
 492
 493         /*
 494          * Form Chimera match command, from the 'new' structure to the
 495          * 'reference' structure e.g. (50 residues, chain B/A, alphacarbons):
 496          *
 497          * match #1:1-30.B,81-100.B@CA #0:21-40.A,61-90.A@CA
 498          *
 499          * @see
 500          * https://www.cgl.ucsf.edu/chimera/docs/UsersGuide/midas/match.html
 501          */
 502         command.append("match ").append(getModelSpec(pdbfnum)).append(":");
 503         command.append(selcom[pdbfnum]);
 504         command.append("@").append(
 505                 structures[pdbfnum].isRna ? PHOSPHORUS : ALPHACARBON);
 506         // JAL-1757 exclude alternate CA locations
 507         command.append(NO_ALTLOCS);
 508         command.append(" ").append(getModelSpec(refStructure)).append(":");
 509         command.append(selcom[refStructure]);
 510         command.append("@").append(
 511                 structures[refStructure].isRna ? PHOSPHORUS : ALPHACARBON);
 512         command.append(NO_ALTLOCS);
 513       }
 514       if (selectioncom.length() > 0)
 515       {
 516         if (debug)
 517         {
 518           System.out.println("Select regions:\n" + selectioncom.toString());
 519           System.out.println(
 520                   "Superimpose command(s):\n" + command.toString());
 521         }
 522         allComs.append("~display all; chain @CA|P; ribbon ")
 523                 .append(selectioncom.toString())
 524                 .append(";" + command.toString());
 525       }
 526     }
 527
 528     String error = null;
 529     if (selectioncom.length() > 0)
 530     {
 531       // TODO: visually distinguish regions that were superposed
 532       if (selectioncom.substring(selectioncom.length() - 1).equals("|"))
 533       {
 534         selectioncom.setLength(selectioncom.length() - 1);
 535       }
 536       if (debug)
 537       {
 538         System.out.println("Select regions:\n" + selectioncom.toString());
 539       }
 540       allComs.append("; ~display all; chain @CA|P; ribbon ")
 541               .append(selectioncom.toString()).append("; focus");
 542       List<String> chimeraReplies = sendChimeraCommand(allComs.toString(),
 543               true);
 544       for (String reply : chimeraReplies)
 545       {
 546         if (reply.toLowerCase().contains("unequal numbers of atoms"))
 547         {
 548           error = reply;
 549         }
 550       }
 551     }
 552     return error;
 553   }
 554
 555   /**
 556    * Helper method to construct model spec in Chimera format:
 557    * <ul>
 558    * <li>#0 (#1 etc) for a PDB file with no sub-models</li>
 559    * <li>#0.1 (#1.1 etc) for a PDB file with sub-models</li>
 560    * <ul>
 561    * Note for now we only ever choose the first of multiple models. This
 562    * corresponds to the hard-coded Jmol equivalent (compare {1.1}). Refactor in
 563    * future if there is a need to select specific sub-models.
 564    *
 565    * @param pdbfnum
 566    * @return
 567    */
 568   protected String getModelSpec(int pdbfnum)
 569   {
 570     if (pdbfnum < 0 || pdbfnum >= getPdbCount())
 571     {
 572       return "";
 573     }
 574
 575     /*
 576      * For now, the test for having sub-models is whether multiple Chimera
 577      * models are mapped for the PDB file; the models are returned as a response
 578      * to the Chimera command 'list models type molecule', see
 579      * ChimeraManager.getModelList().
 580      */
 581     List<ChimeraModel> maps = chimeraMaps.get(getStructureFiles()[pdbfnum]);
 582     boolean hasSubModels = maps != null && maps.size() > 1;
 583     return "#" + String.valueOf(pdbfnum) + (hasSubModels ? ".1" : "");
 584   }
 585
 586   /**
 587    * Launch Chimera, unless an instance linked to this object is already
 588    * running. Returns true if Chimera is successfully launched, or already
 589    * running, else false.
 590    *
 591    * @return
 592    */
 593   public boolean launchChimera()
 594   {
 595     if (viewer.isChimeraLaunched())
 596     {
 597       return true;
 598     }
 599
 600     boolean launched = viewer
 601             .launchChimera(StructureManager.getChimeraPaths());
 602     if (launched)
 603     {
 604       startChimeraProcessMonitor();
 605     }
 606     else
 607     {
 608       log("Failed to launch Chimera!");
 609     }
 610     return launched;
 611   }
 612
 613   /**
 614    * Answers true if the Chimera process is still running, false if ended or not
 615    * started.
 616    *
 617    * @return
 618    */
 619   public boolean isChimeraRunning()
 620   {
 621     return viewer.isChimeraLaunched();
 622   }
 623
 624   /**
 625    * Send a command to Chimera, and optionally log and return any responses.
 626    * <p>
 627    * Does nothing, and returns null, if the command is the same as the last one
 628    * sent [why?].
 629    *
 630    * @param command
 631    * @param getResponse
 632    */
 633   public List<String> sendChimeraCommand(final String command,
 634           boolean getResponse)
 635   {
 636     if (viewer == null)
 637     {
 638       // ? thread running after viewer shut down
 639       return null;
 640     }
 641     List<String> reply = null;
 642     viewerCommandHistory(false);
 643     if (true /*lastCommand == null || !lastCommand.equals(command)*/)
 644     {
 645       // trim command or it may never find a match in the replyLog!!
 646       List<String> lastReply = viewer.sendChimeraCommand(command.trim(),
 647               getResponse);
 648       if (getResponse)
 649       {
 650         reply = lastReply;
 651         if (debug)
 652         {
 653           log("Response from command ('" + command + "') was:\n"
 654                   + lastReply);
 655         }
 656       }
 657     }
 658     viewerCommandHistory(true);
 659
 660     return reply;
 661   }
 662
 663   /**
 664    * Send a Chimera command asynchronously in a new thread. If the progress
 665    * message is not null, display this message while the command is executing.
 666    *
 667    * @param command
 668    * @param progressMsg
 669    */
 670   protected abstract void sendAsynchronousCommand(String command,
 671           String progressMsg);
 672
 673   /**
 674    * Sends a set of colour commands to the structure viewer
 675    *
 676    * @param colourBySequenceCommands
 677    */
 678   @Override
 679   protected void colourBySequence(
 680           StructureMappingcommandSet[] colourBySequenceCommands)
 681   {
 682     for (StructureMappingcommandSet cpdbbyseq : colourBySequenceCommands)
 683     {
 684       for (String command : cpdbbyseq.commands)
 685       {
 686         sendAsynchronousCommand(command, COLOURING_CHIMERA);
 687       }
 688     }
 689   }
 690
 691   /**
 692    * @param files
 693    * @param sr
 694    * @param viewPanel
 695    * @return
 696    */
 697   @Override
 698   protected StructureMappingcommandSet[] getColourBySequenceCommands(
 699           String[] files, SequenceRendererI sr, AlignmentViewPanel viewPanel)
 700   {
 701     return ChimeraCommands.getColourBySequenceCommand(getSsm(), files,
 702             getSequence(), sr, viewPanel);
 703   }
 704
 705   /**
 706    * @param command
 707    */
 708   protected void executeWhenReady(String command)
 709   {
 710     waitForChimera();
 711     sendChimeraCommand(command, false);
 712     waitForChimera();
 713   }
 714
 715   private void waitForChimera()
 716   {
 717     while (viewer != null && viewer.isBusy())
 718     {
 719       try
 720       {
 721         Thread.sleep(15);
 722       } catch (InterruptedException q)
 723       {
 724       }
 725     }
 726   }
 727
 728   // End StructureListener
 729   // //////////////////////////
 730
 731   /**
 732    * instruct the Jalview binding to update the pdbentries vector if necessary
 733    * prior to matching the viewer's contents to the list of structure files
 734    * Jalview knows about.
 735    */
 736   public abstract void refreshPdbEntries();
 737
 738   /**
 739    * map between index of model filename returned from getPdbFile and the first
 740    * index of models from this file in the viewer. Note - this is not trimmed -
 741    * use getPdbFile to get number of unique models.
 742    */
 743   private int _modelFileNameMap[];
 744
 745   // ////////////////////////////////
 746   // /StructureListener
 747   @Override
 748   public synchronized String[] getStructureFiles()
 749   {
 750     if (viewer == null)
 751     {
 752       return new String[0];
 753     }
 754
 755     return chimeraMaps.keySet()
 756             .toArray(modelFileNames = new String[chimeraMaps.size()]);
 757   }
 758
 759   /**
 760    * Construct and send a command to highlight zero, one or more atoms. We do
 761    * this by sending an "rlabel" command to show the residue label at that
 762    * position.
 763    */
 764   @Override
 765   public void highlightAtoms(List<AtomSpec> atoms)
 766   {
 767     if (atoms == null || atoms.size() == 0)
 768     {
 769       return;
 770     }
 771
 772     StringBuilder cmd = new StringBuilder(128);
 773     boolean first = true;
 774     boolean found = false;
 775
 776     for (AtomSpec atom : atoms)
 777     {
 778       int pdbResNum = atom.getPdbResNum();
 779       String chain = atom.getChain();
 780       String pdbfile = atom.getPdbFile();
 781       List<ChimeraModel> cms = chimeraMaps.get(pdbfile);
 782       if (cms != null && !cms.isEmpty())
 783       {
 784         if (first)
 785         {
 786           cmd.append("rlabel #").append(cms.get(0).getModelNumber())
 787                   .append(":");
 788         }
 789         else
 790         {
 791           cmd.append(",");
 792         }
 793         first = false;
 794         cmd.append(pdbResNum);
 795         if (!chain.equals(" "))
 796         {
 797           cmd.append(".").append(chain);
 798         }
 799         found = true;
 800       }
 801     }
 802     String command = cmd.toString();
 803
 804     /*
 805      * avoid repeated commands for the same residue
 806      */
 807     if (command.equals(lastHighlightCommand))
 808     {
 809       return;
 810     }
 811
 812     /*
 813      * unshow the label for the previous residue
 814      */
 815     if (lastHighlightCommand != null)
 816     {
 817       viewer.sendChimeraCommand("~" + lastHighlightCommand, false);
 818     }
 819     if (found)
 820     {
 821       viewer.sendChimeraCommand(command, false);
 822     }
 823     this.lastHighlightCommand = command;
 824   }
 825
 826   /**
 827    * Query Chimera for its current selection, and highlight it on the alignment
 828    */
 829   public void highlightChimeraSelection()
 830   {
 831     /*
 832      * Ask Chimera for its current selection
 833      */
 834     List<String> selection = viewer.getSelectedResidueSpecs();
 835
 836     /*
 837      * Parse model number, residue and chain for each selected position,
 838      * formatted as #0:123.A or #1.2:87.B (#model.submodel:residue.chain)
 839      */
 840     List<AtomSpec> atomSpecs = convertStructureResiduesToAlignment(
 841             selection);
 842
 843     /*
 844      * Broadcast the selection (which may be empty, if the user just cleared all
 845      * selections)
 846      */
 847     getSsm().mouseOverStructure(atomSpecs);
 848   }
 849
 850   /**
 851    * Converts a list of Chimera atomspecs to a list of AtomSpec representing the
 852    * corresponding residues (if any) in Jalview
 853    *
 854    * @param structureSelection
 855    * @return
 856    */
 857   protected List<AtomSpec> convertStructureResiduesToAlignment(
 858           List<String> structureSelection)
 859   {
 860     List<AtomSpec> atomSpecs = new ArrayList<AtomSpec>();
 861     for (String atomSpec : structureSelection)
 862     {
 863       try
 864       {
 865         AtomSpec spec = AtomSpec.fromChimeraAtomspec(atomSpec);
 866         String pdbfilename = getPdbFileForModel(spec.getModelNumber());
 867         spec.setPdbFile(pdbfilename);
 868         atomSpecs.add(spec);
 869       } catch (IllegalArgumentException e)
 870       {
 871         System.err.println("Failed to parse atomspec: " + atomSpec);
 872       }
 873     }
 874     return atomSpecs;
 875   }
 876
 877   /**
 878    * @param modelId
 879    * @return
 880    */
 881   protected String getPdbFileForModel(int modelId)
 882   {
 883     /*
 884      * Work out the pdbfilename from the model number
 885      */
 886     String pdbfilename = modelFileNames[0];
 887     findfileloop: for (String pdbfile : this.chimeraMaps.keySet())
 888     {
 889       for (ChimeraModel cm : chimeraMaps.get(pdbfile))
 890       {
 891         if (cm.getModelNumber() == modelId)
 892         {
 893           pdbfilename = pdbfile;
 894           break findfileloop;
 895         }
 896       }
 897     }
 898     return pdbfilename;
 899   }
 900
 901   private void log(String message)
 902   {
 903     System.err.println("## Chimera log: " + message);
 904   }
 905
 906   private void viewerCommandHistory(boolean enable)
 907   {
 908     // log("(Not yet implemented) History "
 909     // + ((debug || enable) ? "on" : "off"));
 910   }
 911
 912   public long getLoadNotifiesHandled()
 913   {
 914     return loadNotifiesHandled;
 915   }
 916
 917   @Override
 918   public void setSimpleColourScheme(ColourSchemeI cs)
 919   {
 920     // Chimera expects RBG values in the range 0-1
 921     final double normalise = 255D;
 922     viewerCommandHistory(false);
 923     StringBuilder command = new StringBuilder(128);
 924
 925     List<String> residueSet = ResidueProperties.getResidues(isNucleotide(),
 926             false);
 927     for (String resName : residueSet)
 928     {
 929       char res = resName.length() == 3
 930               ? ResidueProperties.getSingleCharacterCode(resName)
 931               : resName.charAt(0);
 932       Color col = cs == null ? Color.WHITE : cs.findColour(res);
 933       command.append("color " + col.getRed() / normalise + ","
 934               + col.getGreen() / normalise + "," + col.getBlue() / normalise
 935               + " ::" + resName + ";");
 936     }
 937
 938     sendAsynchronousCommand(command.toString(), COLOURING_CHIMERA);
 939     viewerCommandHistory(true);
 940   }
 941
 942   /**
 943    * called when the binding thinks the UI needs to be refreshed after a Chimera
 944    * state change. this could be because structures were loaded, or because an
 945    * error has occurred.
 946    */
 947   public abstract void refreshGUI();
 948
 949   @Override
 950   public void setLoadingFromArchive(boolean loadingFromArchive)
 951   {
 952     this.loadingFromArchive = loadingFromArchive;
 953   }
 954
 955   /**
 956    *
 957    * @return true if Chimeral is still restoring state or loading is still going
 958    *         on (see setFinsihedLoadingFromArchive)
 959    */
 960   @Override
 961   public boolean isLoadingFromArchive()
 962   {
 963     return loadingFromArchive && !loadingFinished;
 964   }
 965
 966   /**
 967    * modify flag which controls if sequence colouring events are honoured by the
 968    * binding. Should be true for normal operation
 969    *
 970    * @param finishedLoading
 971    */
 972   @Override
 973   public void setFinishedLoadingFromArchive(boolean finishedLoading)
 974   {
 975     loadingFinished = finishedLoading;
 976   }
 977
 978   /**
 979    * Send the Chimera 'background solid <color>" command.
 980    *
 981    * @see https
 982    *      ://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/background
 983    *      .html
 984    * @param col
 985    */
 986   @Override
 987   public void setBackgroundColour(Color col)
 988   {
 989     viewerCommandHistory(false);
 990     double normalise = 255D;
 991     final String command = "background solid " + col.getRed() / normalise
 992             + "," + col.getGreen() / normalise + ","
 993             + col.getBlue() / normalise + ";";
 994     viewer.sendChimeraCommand(command, false);
 995     viewerCommandHistory(true);
 996   }
 997
 998   /**
 999    * Ask Chimera to save its session to the given file. Returns true if
1000    * successful, else false.
1001    *
1002    * @param filepath
1003    * @return
1004    */
1005   public boolean saveSession(String filepath)
1006   {
1007     if (isChimeraRunning())
1008     {
1009       List<String> reply = viewer.sendChimeraCommand("save " + filepath,
1010               true);
1011       if (reply.contains("Session written"))
1012       {
1013         return true;
1014       }
1015       else
1016       {
1017         Cache.log
1018                 .error("Error saving Chimera session: " + reply.toString());
1019       }
1020     }
1021     return false;
1022   }
1023
1024   /**
1025    * Ask Chimera to open a session file. Returns true if successful, else false.
1026    * The filename must have a .py extension for this command to work.
1027    *
1028    * @param filepath
1029    * @return
1030    */
1031   public boolean openSession(String filepath)
1032   {
1033     sendChimeraCommand("open " + filepath, true);
1034     // todo: test for failure - how?
1035     return true;
1036   }
1037
1038   /**
1039    * Returns a list of chains mapped in this viewer. Note this list is not
1040    * currently scoped per structure.
1041    *
1042    * @return
1043    */
1044   @Override
1045   public List<String> getChainNames()
1046   {
1047     return chainNames;
1048   }
1049
1050   /**
1051    * Send a 'focus' command to Chimera to recentre the visible display
1052    */
1053   public void focusView()
1054   {
1055     sendChimeraCommand("focus", false);
1056   }
1057
1058   /**
1059    * Send a 'show' command for all atoms in the currently selected columns
1060    *
1061    * TODO: pull up to abstract structure viewer interface
1062    *
1063    * @param vp
1064    */
1065   public void highlightSelection(AlignmentViewPanel vp)
1066   {
1067     List<Integer> cols = vp.getAlignViewport().getColumnSelection()
1068             .getSelected();
1069     AlignmentI alignment = vp.getAlignment();
1070     StructureSelectionManager sm = getSsm();
1071     for (SequenceI seq : alignment.getSequences())
1072     {
1073       /*
1074        * convert selected columns into sequence positions
1075        */
1076       int[] positions = new int[cols.size()];
1077       int i = 0;
1078       for (Integer col : cols)
1079       {
1080         positions[i++] = seq.findPosition(col);
1081       }
1082       sm.highlightStructure(this, seq, positions);
1083     }
1084   }
1085
1086   /**
1087    * Constructs and send commands to Chimera to set attributes on residues for
1088    * features visible in Jalview
1089    *
1090    * @param avp
1091    * @return
1092    */
1093   public int sendFeaturesToViewer(AlignmentViewPanel avp)
1094   {
1095     // TODO refactor as required to pull up to an interface
1096     AlignmentI alignment = avp.getAlignment();
1097
1098     String[] files = getStructureFiles();
1099     if (files == null)
1100     {
1101       return 0;
1102     }
1103
1104     StructureMappingcommandSet commandSet = ChimeraCommands
1105             .getSetAttributeCommandsForFeatures(getSsm(), files,
1106                     getSequence(), avp);
1107     String[] commands = commandSet.commands;
1108     if (commands.length > 10)
1109     {
1110       sendCommandsByFile(commands);
1111     }
1112     else
1113     {
1114       for (String command : commands)
1115       {
1116         sendAsynchronousCommand(command, null);
1117       }
1118     }
1119     return commands.length;
1120   }
1121
1122   /**
1123    * Write commands to a temporary file, and send a command to Chimera to open
1124    * the file as a commands script. For use when sending a large number of
1125    * separate commands would overload the REST interface mechanism.
1126    *
1127    * @param commands
1128    */
1129   protected void sendCommandsByFile(String[] commands)
1130   {
1131     try
1132     {
1133       File tmp = File.createTempFile("chim", ".com");
1134       tmp.deleteOnExit();
1135       PrintWriter out = new PrintWriter(new FileOutputStream(tmp));
1136       for (String command : commands)
1137       {
1138         out.println(command);
1139       }
1140       out.flush();
1141       out.close();
1142       String path = tmp.getAbsolutePath();
1143       sendAsynchronousCommand("open cmd:" + path, null);
1144     } catch (IOException e)
1145     {
1146       System.err.println("Sending commands to Chimera via file failed with "
1147               + e.getMessage());
1148     }
1149   }
1150
1151   /**
1152    * Get Chimera residues which have the named attribute, find the mapped
1153    * positions in the Jalview sequence(s), and set as sequence features
1154    *
1155    * @param attName
1156    * @param alignmentPanel
1157    */
1158   public void copyStructureAttributesToFeatures(String attName,
1159           AlignmentViewPanel alignmentPanel)
1160   {
1161     // todo pull up to AAStructureBindingModel (and interface?)
1162
1163     /*
1164      * ask Chimera to list residues with the attribute, reporting its value
1165      */
1166     // this alternative command
1167     // list residues spec ':*/attName' attr attName
1168     // doesn't report 'None' values (which is good), but
1169     // fails for 'average.bfactor' (which is bad):
1170
1171     String cmd = "list residues attr '" + attName + "'";
1172     List<String> residues = sendChimeraCommand(cmd, true);
1173
1174     boolean featureAdded = createFeaturesForAttributes(attName, residues);
1175     if (featureAdded)
1176     {
1177       alignmentPanel.getFeatureRenderer().featuresAdded();
1178     }
1179   }
1180
1181   /**
1182    * Create features in Jalview for the given attribute name and structure
1183    * residues.
1184    *
1185    * <pre>
1186    * The residue list should be 0, 1 or more reply lines of the format:
1187    *     residue id #0:5.A isHelix -155.000836316 index 5
1188    * or
1189    *     residue id #0:6.A isHelix None
1190    * </pre>
1191    *
1192    * @param attName
1193    * @param residues
1194    * @return
1195    */
1196   protected boolean createFeaturesForAttributes(String attName,
1197           List<String> residues)
1198   {
1199     boolean featureAdded = false;
1200     String featureGroup = getViewerFeatureGroup();
1201
1202     for (String residue : residues)
1203     {
1204       AtomSpec spec = null;
1205       String[] tokens = residue.split(" ");
1206       if (tokens.length < 5)
1207       {
1208         continue;
1209       }
1210       String atomSpec = tokens[2];
1211       String attValue = tokens[4];
1212
1213       /*
1214        * ignore 'None' (e.g. for phi) or 'False' (e.g. for isHelix)
1215        */
1216       if ("None".equalsIgnoreCase(attValue)
1217               || "False".equalsIgnoreCase(attValue))
1218       {
1219         continue;
1220       }
1221
1222       try
1223       {
1224         spec = AtomSpec.fromChimeraAtomspec(atomSpec);
1225       } catch (IllegalArgumentException e)
1226       {
1227         System.err.println("Problem parsing atomspec " + atomSpec);
1228         continue;
1229       }
1230
1231       String chainId = spec.getChain();
1232       String description = attValue;
1233       float score = Float.NaN;
1234       try
1235       {
1236         score = Float.valueOf(attValue);
1237         description = chainId;
1238       } catch (NumberFormatException e)
1239       {
1240         // was not a float value
1241       }
1242
1243       String pdbFile = getPdbFileForModel(spec.getModelNumber());
1244       spec.setPdbFile(pdbFile);
1245
1246       List<AtomSpec> atoms = Collections.singletonList(spec);
1247
1248       /*
1249        * locate the mapped position in the alignment (if any)
1250        */
1251       SearchResultsI sr = getSsm()
1252               .findAlignmentPositionsForStructurePositions(atoms);
1253
1254       /*
1255        * expect one matched alignment position, or none
1256        * (if the structure position is not mapped)
1257        */
1258       for (SearchResultMatchI m : sr.getResults())
1259       {
1260         SequenceI seq = m.getSequence();
1261         int start = m.getStart();
1262         int end = m.getEnd();
1263         SequenceFeature sf = new SequenceFeature(attName, description,
1264                 start, end, score, featureGroup);
1265         // todo: should SequenceFeature have an explicit property for chain?
1266         // note: repeating the action shouldn't duplicate features
1267         featureAdded |= seq.addSequenceFeature(sf);
1268       }
1269     }
1270     return featureAdded;
1271   }
1272
1273   /**
1274    * Answers the feature group name to apply to features created in Jalview from
1275    * Chimera attributes
1276    *
1277    * @return
1278    */
1279   protected String getViewerFeatureGroup()
1280   {
1281     // todo pull up to interface
1282     return CHIMERA_FEATURE_GROUP;
1283   }
1284
1285   public Hashtable<String, String> getChainFile()
1286   {
1287     return chainFile;
1288   }
1289
1290   public List<ChimeraModel> getChimeraModelByChain(String chain)
1291   {
1292     return chimeraMaps.get(chainFile.get(chain));
1293   }
1294
1295   public int getModelNoForChain(String chain)
1296   {
1297     List<ChimeraModel> foundModels = getChimeraModelByChain(chain);
1298     if (foundModels != null && !foundModels.isEmpty())
1299     {
1300       return foundModels.get(0).getModelNumber();
1301     }
1302     return -1;
1303   }
1304 }