src/ext/edu/ucsf/rbvi/strucviz2/ChimeraManager.java

   1 /* vim: set ts=2: */
   2 /**
   3  * Copyright (c) 2006 The Regents of the University of California.
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  *   1. Redistributions of source code must retain the above copyright
  10  *      notice, this list of conditions, and the following disclaimer.
  11  *   2. Redistributions in binary form must reproduce the above
  12  *      copyright notice, this list of conditions, and the following
  13  *      disclaimer in the documentation and/or other materials provided
  14  *      with the distribution.
  15  *   3. Redistributions must acknowledge that this software was
  16  *      originally developed by the UCSF Computer Graphics Laboratory
  17  *      under support by the NIH National Center for Research Resources,
  18  *      grant P41-RR01081.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER "AS IS" AND ANY
  21  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  23  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS BE LIABLE
  24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
  26  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  27  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  28  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
  29  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  30  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31  *
  32  */
  33 package ext.edu.ucsf.rbvi.strucviz2;
  34
  35 import jalview.ws.HttpClientUtils;
  36
  37 import java.awt.Color;
  38 import java.io.BufferedReader;
  39 import java.io.File;
  40 import java.io.IOException;
  41 import java.io.InputStream;
  42 import java.io.InputStreamReader;
  43 import java.nio.file.Paths;
  44 import java.util.ArrayList;
  45 import java.util.Collection;
  46 import java.util.HashMap;
  47 import java.util.List;
  48 import java.util.Map;
  49
  50 import org.apache.http.NameValuePair;
  51 import org.apache.http.message.BasicNameValuePair;
  52 import org.slf4j.Logger;
  53 import org.slf4j.LoggerFactory;
  54
  55 import ext.edu.ucsf.rbvi.strucviz2.StructureManager.ModelType;
  56 import ext.edu.ucsf.rbvi.strucviz2.port.ListenerThreads;
  57
  58 /**
  59  * This object maintains the Chimera communication information.
  60  */
  61 public class ChimeraManager
  62 {
  63   private static final int REST_REPLY_TIMEOUT_MS = 15000;
  64
  65   private static final int CONNECTION_TIMEOUT_MS = 100;
  66
  67   private static final boolean debug = false;
  68
  69   private int chimeraRestPort;
  70
  71   private Process chimera;
  72
  73   private ListenerThreads chimeraListenerThread;
  74
  75   private Map<Integer, ChimeraModel> currentModelsMap;
  76
  77   private Logger logger = LoggerFactory
  78           .getLogger(ext.edu.ucsf.rbvi.strucviz2.ChimeraManager.class);
  79
  80   private StructureManager structureManager;
  81
  82   public ChimeraManager(StructureManager structureManager)
  83   {
  84     this.structureManager = structureManager;
  85     chimera = null;
  86     chimeraListenerThread = null;
  87     currentModelsMap = new HashMap<>();
  88
  89   }
  90
  91   public List<ChimeraModel> getChimeraModels(String modelName)
  92   {
  93     List<ChimeraModel> models = getChimeraModels(modelName,
  94             ModelType.PDB_MODEL);
  95     models.addAll(getChimeraModels(modelName, ModelType.SMILES));
  96     return models;
  97   }
  98
  99   public List<ChimeraModel> getChimeraModels(String modelName,
 100           ModelType modelType)
 101   {
 102     List<ChimeraModel> models = new ArrayList<>();
 103     for (ChimeraModel model : currentModelsMap.values())
 104     {
 105       if (modelName.equals(model.getModelName())
 106               && modelType.equals(model.getModelType()))
 107       {
 108         models.add(model);
 109       }
 110     }
 111     return models;
 112   }
 113
 114   public Map<String, List<ChimeraModel>> getChimeraModelsMap()
 115   {
 116     Map<String, List<ChimeraModel>> models = new HashMap<>();
 117     for (ChimeraModel model : currentModelsMap.values())
 118     {
 119       String modelName = model.getModelName();
 120       if (!models.containsKey(modelName))
 121       {
 122         models.put(modelName, new ArrayList<ChimeraModel>());
 123       }
 124       if (!models.get(modelName).contains(model))
 125       {
 126         models.get(modelName).add(model);
 127       }
 128     }
 129     return models;
 130   }
 131
 132   public ChimeraModel getChimeraModel(Integer modelNumber,
 133           Integer subModelNumber)
 134   {
 135     Integer key = ChimUtils.makeModelKey(modelNumber, subModelNumber);
 136     if (currentModelsMap.containsKey(key))
 137     {
 138       return currentModelsMap.get(key);
 139     }
 140     return null;
 141   }
 142
 143   public ChimeraModel getChimeraModel()
 144   {
 145     return currentModelsMap.values().iterator().next();
 146   }
 147
 148   public Collection<ChimeraModel> getChimeraModels()
 149   {
 150     // this method is invoked by the model navigator dialog
 151     return currentModelsMap.values();
 152   }
 153
 154   public int getChimeraModelsCount(boolean smiles)
 155   {
 156     // this method is invokes by the model navigator dialog
 157     int counter = currentModelsMap.size();
 158     if (smiles)
 159     {
 160       return counter;
 161     }
 162
 163     for (ChimeraModel model : currentModelsMap.values())
 164     {
 165       if (model.getModelType() == ModelType.SMILES)
 166       {
 167         counter--;
 168       }
 169     }
 170     return counter;
 171   }
 172
 173   public boolean hasChimeraModel(Integer modelNubmer)
 174   {
 175     return hasChimeraModel(modelNubmer, 0);
 176   }
 177
 178   public boolean hasChimeraModel(Integer modelNubmer, Integer subModelNumber)
 179   {
 180     return currentModelsMap.containsKey(ChimUtils.makeModelKey(modelNubmer,
 181             subModelNumber));
 182   }
 183
 184   public void addChimeraModel(Integer modelNumber, Integer subModelNumber,
 185           ChimeraModel model)
 186   {
 187     currentModelsMap.put(
 188             ChimUtils.makeModelKey(modelNumber, subModelNumber), model);
 189   }
 190
 191   public void removeChimeraModel(Integer modelNumber, Integer subModelNumber)
 192   {
 193     int modelKey = ChimUtils.makeModelKey(modelNumber, subModelNumber);
 194     if (currentModelsMap.containsKey(modelKey))
 195     {
 196       currentModelsMap.remove(modelKey);
 197     }
 198   }
 199
 200   public List<ChimeraModel> openModel(String modelPath, ModelType type)
 201   {
 202     return openModel(modelPath, getFileNameFromPath(modelPath), type);
 203   }
 204
 205   /**
 206    * Overloaded method to allow Jalview to pass in a model name.
 207    *
 208    * @param modelPath
 209    * @param modelName
 210    * @param type
 211    * @return
 212    */
 213   public List<ChimeraModel> openModel(String modelPath, String modelName,
 214           ModelType type)
 215   {
 216     logger.info("chimera open " + modelPath);
 217     // stopListening();
 218     List<ChimeraModel> modelList = getModelList();
 219     List<String> response = null;
 220     // TODO: [Optional] Handle modbase models
 221     if (type == ModelType.MODBASE_MODEL)
 222     {
 223       response = sendChimeraCommand("open modbase:" + modelPath, true);
 224       // } else if (type == ModelType.SMILES) {
 225       // response = sendChimeraCommand("open smiles:" + modelName, true);
 226       // modelName = "smiles:" + modelName;
 227     }
 228     else
 229     {
 230       response = sendChimeraCommand("open " + modelPath, true);
 231     }
 232     if (response == null)
 233     {
 234       // something went wrong
 235       logger.warn("Could not open " + modelPath);
 236       return null;
 237     }
 238
 239     // patch for Jalview - set model name in Chimera
 240     // TODO: find a variant that works for sub-models
 241     for (ChimeraModel newModel : getModelList())
 242     {
 243       if (!modelList.contains(newModel))
 244       {
 245         newModel.setModelName(modelName);
 246         sendChimeraCommand(
 247                 "setattr M name " + modelName + " #"
 248                         + newModel.getModelNumber(), false);
 249         modelList.add(newModel);
 250       }
 251     }
 252
 253     // assign color and residues to open models
 254     for (ChimeraModel chimeraModel : modelList)
 255     {
 256       // get model color
 257       Color modelColor = getModelColor(chimeraModel);
 258       if (modelColor != null)
 259       {
 260         chimeraModel.setModelColor(modelColor);
 261       }
 262
 263       // Get our properties (default color scheme, etc.)
 264       // Make the molecule look decent
 265       // chimeraSend("repr stick "+newModel.toSpec());
 266
 267       // Create the information we need for the navigator
 268       if (type != ModelType.SMILES)
 269       {
 270         addResidues(chimeraModel);
 271       }
 272     }
 273
 274     sendChimeraCommand("focus", false);
 275     // startListening(); // see ChimeraListener
 276     return modelList;
 277   }
 278
 279   /**
 280    * Refactored method to extract the last (or only) element delimited by file
 281    * path separator.
 282    *
 283    * @param modelPath
 284    * @return
 285    */
 286   private String getFileNameFromPath(String modelPath)
 287   {
 288     String modelName = modelPath;
 289     if (modelPath == null)
 290     {
 291       return null;
 292     }
 293     // TODO: [Optional] Convert path to name in a better way
 294     if (modelPath.lastIndexOf(File.separator) > 0)
 295     {
 296       modelName = modelPath
 297               .substring(modelPath.lastIndexOf(File.separator) + 1);
 298     }
 299     else if (modelPath.lastIndexOf("/") > 0)
 300     {
 301       modelName = modelPath.substring(modelPath.lastIndexOf("/") + 1);
 302     }
 303     return modelName;
 304   }
 305
 306   public void closeModel(ChimeraModel model)
 307   {
 308     // int model = structure.modelNumber();
 309     // int subModel = structure.subModelNumber();
 310     // Integer modelKey = makeModelKey(model, subModel);
 311     stopListening();
 312     logger.info("chimera close model " + model.getModelName());
 313     if (currentModelsMap.containsKey(ChimUtils.makeModelKey(
 314             model.getModelNumber(), model.getSubModelNumber())))
 315     {
 316       sendChimeraCommand("close " + model.toSpec(), false);
 317       // currentModelNamesMap.remove(model.getModelName());
 318       currentModelsMap.remove(ChimUtils.makeModelKey(
 319               model.getModelNumber(), model.getSubModelNumber()));
 320       // selectionList.remove(chimeraModel);
 321     }
 322     else
 323     {
 324       logger.warn("Could not find model " + model.getModelName()
 325               + " to close.");
 326     }
 327     startListening();
 328   }
 329
 330   public void startListening()
 331   {
 332     sendChimeraCommand("listen start models; listen start selection", false);
 333   }
 334
 335   public void stopListening()
 336   {
 337     sendChimeraCommand("listen stop models ; listen stop selection ", false);
 338   }
 339
 340   /**
 341    * Tell Chimera we are listening on the given URI
 342    *
 343    * @param uri
 344    */
 345   public void startListening(String uri)
 346   {
 347     sendChimeraCommand("listen start models url " + uri
 348             + ";listen start select prefix SelectionChanged url " + uri,
 349             false);
 350   }
 351
 352   /**
 353    * Select something in Chimera
 354    *
 355    * @param command
 356    *          the selection command to pass to Chimera
 357    */
 358   public void select(String command)
 359   {
 360     sendChimeraCommand("listen stop selection; " + command
 361             + "; listen start selection", false);
 362   }
 363
 364   public void focus()
 365   {
 366     sendChimeraCommand("focus", false);
 367   }
 368
 369   public void clearOnChimeraExit()
 370   {
 371     chimera = null;
 372     currentModelsMap.clear();
 373     this.chimeraRestPort = 0;
 374     structureManager.clearOnChimeraExit();
 375   }
 376
 377   public void exitChimera()
 378   {
 379     if (isChimeraLaunched() && chimera != null)
 380     {
 381       sendChimeraCommand("stop really", false);
 382       try
 383       {
 384         // TODO is this too violent? could it force close the process
 385         // before it has done an orderly shutdown?
 386         chimera.destroy();
 387       } catch (Exception ex)
 388       {
 389         // ignore
 390       }
 391     }
 392     clearOnChimeraExit();
 393   }
 394
 395   public Map<Integer, ChimeraModel> getSelectedModels()
 396   {
 397     Map<Integer, ChimeraModel> selectedModelsMap = new HashMap<>();
 398     List<String> chimeraReply = sendChimeraCommand(
 399             "list selection level molecule", true);
 400     if (chimeraReply != null)
 401     {
 402       for (String modelLine : chimeraReply)
 403       {
 404         ChimeraModel chimeraModel = new ChimeraModel(modelLine);
 405         Integer modelKey = ChimUtils.makeModelKey(
 406                 chimeraModel.getModelNumber(),
 407                 chimeraModel.getSubModelNumber());
 408         selectedModelsMap.put(modelKey, chimeraModel);
 409       }
 410     }
 411     return selectedModelsMap;
 412   }
 413
 414   /**
 415    * Sends a 'list selection level residue' command to Chimera and returns the
 416    * list of selected atomspecs
 417    *
 418    * @return
 419    */
 420   public List<String> getSelectedResidueSpecs()
 421   {
 422     List<String> selectedResidues = new ArrayList<>();
 423     List<String> chimeraReply = sendChimeraCommand(
 424             "list selection level residue", true);
 425     if (chimeraReply != null)
 426     {
 427       /*
 428        * expect 0, 1 or more lines of the format
 429        * residue id #0:43.A type GLY
 430        * where we are only interested in the atomspec #0.43.A
 431        */
 432       for (String inputLine : chimeraReply)
 433       {
 434         String[] inputLineParts = inputLine.split("\\s+");
 435         if (inputLineParts.length == 5)
 436         {
 437           selectedResidues.add(inputLineParts[2]);
 438         }
 439       }
 440     }
 441     return selectedResidues;
 442   }
 443
 444   public void getSelectedResidues(
 445           Map<Integer, ChimeraModel> selectedModelsMap)
 446   {
 447     List<String> chimeraReply = sendChimeraCommand(
 448             "list selection level residue", true);
 449     if (chimeraReply != null)
 450     {
 451       for (String inputLine : chimeraReply)
 452       {
 453         ChimeraResidue r = new ChimeraResidue(inputLine);
 454         Integer modelKey = ChimUtils.makeModelKey(r.getModelNumber(),
 455                 r.getSubModelNumber());
 456         if (selectedModelsMap.containsKey(modelKey))
 457         {
 458           ChimeraModel model = selectedModelsMap.get(modelKey);
 459           model.addResidue(r);
 460         }
 461       }
 462     }
 463   }
 464
 465   /**
 466    * Return the list of ChimeraModels currently open. Warning: if smiles model
 467    * name too long, only part of it with "..." is printed.
 468    *
 469    *
 470    * @return List of ChimeraModel's
 471    */
 472   // TODO: [Optional] Handle smiles names in a better way in Chimera?
 473   public List<ChimeraModel> getModelList()
 474   {
 475     List<ChimeraModel> modelList = new ArrayList<>();
 476     List<String> list = sendChimeraCommand("list models type molecule",
 477             true);
 478     if (list != null)
 479     {
 480       for (String modelLine : list)
 481       {
 482         ChimeraModel chimeraModel = new ChimeraModel(modelLine);
 483         modelList.add(chimeraModel);
 484       }
 485     }
 486     return modelList;
 487   }
 488
 489   /**
 490    * Return the list of depiction presets available from within Chimera. Chimera
 491    * will return the list as a series of lines with the format: Preset type
 492    * number "description"
 493    *
 494    * @return list of presets
 495    */
 496   public List<String> getPresets()
 497   {
 498     ArrayList<String> presetList = new ArrayList<>();
 499     List<String> output = sendChimeraCommand("preset list", true);
 500     if (output != null)
 501     {
 502       for (String preset : output)
 503       {
 504         preset = preset.substring(7); // Skip over the "Preset"
 505         preset = preset.replaceFirst("\"", "(");
 506         preset = preset.replaceFirst("\"", ")");
 507         // string now looks like: type number (description)
 508         presetList.add(preset);
 509       }
 510     }
 511     return presetList;
 512   }
 513
 514   public boolean isChimeraLaunched()
 515   {
 516     boolean launched = false;
 517     if (chimera != null)
 518     {
 519       try
 520       {
 521         chimera.exitValue();
 522         // if we get here, process has ended
 523       } catch (IllegalThreadStateException e)
 524       {
 525         // ok - not yet terminated
 526         launched = true;
 527       }
 528     }
 529     return launched;
 530   }
 531
 532   /**
 533    * Launch Chimera, unless an instance linked to this object is already
 534    * running. Returns true if chimera is successfully launched, or already
 535    * running, else false.
 536    *
 537    * @param chimeraPaths
 538    * @return
 539    */
 540   public boolean launchChimera(List<String> chimeraPaths)
 541   {
 542     // Do nothing if Chimera is already launched
 543     if (isChimeraLaunched())
 544     {
 545       return true;
 546     }
 547
 548     // Try to launch Chimera (eventually using one of the possible paths)
 549     String error = "Error message: ";
 550     String workingPath = "";
 551     // iterate over possible paths for starting Chimera
 552     for (String chimeraPath : chimeraPaths)
 553     {
 554       try
 555       {
 556         // ensure symbolic links are resolved
 557         chimeraPath = Paths.get(chimeraPath).toRealPath().toString();
 558         File path = new File(chimeraPath);
 559         // uncomment the next line to simulate Chimera not installed
 560         // path = new File(chimeraPath + "x");
 561         if (!path.canExecute())
 562         {
 563           error += "File '" + path + "' does not exist.\n";
 564           continue;
 565         }
 566         List<String> args = new ArrayList<>();
 567         args.add(chimeraPath);
 568         // shows Chimera output window but suppresses REST responses:
 569         // args.add("--debug");
 570         args.add("--start");
 571         args.add("RESTServer");
 572         ProcessBuilder pb = new ProcessBuilder(args);
 573         chimera = pb.start();
 574         error = "";
 575         workingPath = chimeraPath;
 576         break;
 577       } catch (Exception e)
 578       {
 579         // Chimera could not be started using this path
 580         error += e.getMessage();
 581       }
 582     }
 583     // If no error, then Chimera was launched successfully
 584     if (error.length() == 0)
 585     {
 586       this.chimeraRestPort = getPortNumber();
 587       System.out.println("Chimera REST API started on port "
 588               + chimeraRestPort);
 589       // structureManager.initChimTable();
 590       structureManager.setChimeraPathProperty(workingPath);
 591       // TODO: [Optional] Check Chimera version and show a warning if below 1.8
 592       // Ask Chimera to give us updates
 593       // startListening(); // later - see ChimeraListener
 594       return (chimeraRestPort > 0);
 595     }
 596
 597     // Tell the user that Chimera could not be started because of an error
 598     logger.warn(error);
 599     return false;
 600   }
 601
 602   /**
 603    * Read and return the port number returned in the reply to --start RESTServer
 604    */
 605   private int getPortNumber()
 606   {
 607     int port = 0;
 608     InputStream readChan = chimera.getInputStream();
 609     BufferedReader lineReader = new BufferedReader(new InputStreamReader(
 610             readChan));
 611     StringBuilder responses = new StringBuilder();
 612     try
 613     {
 614       String response = lineReader.readLine();
 615       while (response != null)
 616       {
 617         responses.append("\n" + response);
 618         // expect: REST server on host 127.0.0.1 port port_number
 619         if (response.startsWith("REST server"))
 620         {
 621           String[] tokens = response.split(" ");
 622           if (tokens.length == 7 && "port".equals(tokens[5]))
 623           {
 624             port = Integer.parseInt(tokens[6]);
 625             break;
 626           }
 627         }
 628         response = lineReader.readLine();
 629       }
 630     } catch (Exception e)
 631     {
 632       logger.error("Failed to get REST port number from " + responses
 633               + ": " + e.getMessage());
 634     } finally
 635     {
 636       try
 637       {
 638         lineReader.close();
 639       } catch (IOException e2)
 640       {
 641       }
 642     }
 643     if (port == 0)
 644     {
 645       System.err
 646               .println("Failed to start Chimera with REST service, response was: "
 647                       + responses);
 648     }
 649     logger.info("Chimera REST service listening on port " + chimeraRestPort);
 650     return port;
 651   }
 652
 653   /**
 654    * Determine the color that Chimera is using for this model.
 655    *
 656    * @param model
 657    *          the ChimeraModel we want to get the Color for
 658    * @return the default model Color for this model in Chimera
 659    */
 660   public Color getModelColor(ChimeraModel model)
 661   {
 662     List<String> colorLines = sendChimeraCommand(
 663             "list model spec " + model.toSpec() + " attribute color", true);
 664     if (colorLines == null || colorLines.size() == 0)
 665     {
 666       return null;
 667     }
 668     return ChimUtils.parseModelColor(colorLines.get(0));
 669   }
 670
 671   /**
 672    *
 673    * Get information about the residues associated with a model. This uses the
 674    * Chimera listr command. We don't return the resulting residues, but we add
 675    * the residues to the model.
 676    *
 677    * @param model
 678    *          the ChimeraModel to get residue information for
 679    *
 680    */
 681   public void addResidues(ChimeraModel model)
 682   {
 683     int modelNumber = model.getModelNumber();
 684     int subModelNumber = model.getSubModelNumber();
 685     // Get the list -- it will be in the reply log
 686     List<String> reply = sendChimeraCommand(
 687             "list residues spec " + model.toSpec(), true);
 688     if (reply == null)
 689     {
 690       return;
 691     }
 692     for (String inputLine : reply)
 693     {
 694       ChimeraResidue r = new ChimeraResidue(inputLine);
 695       if (r.getModelNumber() == modelNumber
 696               || r.getSubModelNumber() == subModelNumber)
 697       {
 698         model.addResidue(r);
 699       }
 700     }
 701   }
 702
 703   public List<String> getAttrList()
 704   {
 705     List<String> attributes = new ArrayList<>();
 706     final List<String> reply = sendChimeraCommand("list resattr", true);
 707     if (reply != null)
 708     {
 709       for (String inputLine : reply)
 710       {
 711         String[] lineParts = inputLine.split("\\s");
 712         if (lineParts.length == 2 && lineParts[0].equals("resattr"))
 713         {
 714           attributes.add(lineParts[1]);
 715         }
 716       }
 717     }
 718     return attributes;
 719   }
 720
 721   public Map<ChimeraResidue, Object> getAttrValues(String aCommand,
 722           ChimeraModel model)
 723   {
 724     Map<ChimeraResidue, Object> values = new HashMap<>();
 725     final List<String> reply = sendChimeraCommand("list residue spec "
 726             + model.toSpec() + " attribute " + aCommand, true);
 727     if (reply != null)
 728     {
 729       for (String inputLine : reply)
 730       {
 731         String[] lineParts = inputLine.split("\\s");
 732         if (lineParts.length == 5)
 733         {
 734           ChimeraResidue residue = ChimUtils
 735                   .getResidue(lineParts[2], model);
 736           String value = lineParts[4];
 737           if (residue != null)
 738           {
 739             if (value.equals("None"))
 740             {
 741               continue;
 742             }
 743             if (value.equals("True") || value.equals("False"))
 744             {
 745               values.put(residue, Boolean.valueOf(value));
 746               continue;
 747             }
 748             try
 749             {
 750               Double doubleValue = Double.valueOf(value);
 751               values.put(residue, doubleValue);
 752             } catch (NumberFormatException ex)
 753             {
 754               values.put(residue, value);
 755             }
 756           }
 757         }
 758       }
 759     }
 760     return values;
 761   }
 762
 763   private volatile boolean busy = false;
 764
 765   /**
 766    * Send a command to Chimera.
 767    *
 768    * @param command
 769    *          Command string to be send.
 770    * @param reply
 771    *          Flag indicating whether the method should return the reply from
 772    *          Chimera or not.
 773    * @return List of Strings corresponding to the lines in the Chimera reply or
 774    *         <code>null</code>.
 775    */
 776   public List<String> sendChimeraCommand(String command, boolean reply)
 777   {
 778    // System.out.println("chimeradebug>> " + command);
 779     if (!isChimeraLaunched() || command == null
 780             || "".equals(command.trim()))
 781     {
 782       return null;
 783     }
 784     // TODO do we need a maximum wait time before aborting?
 785     while (busy)
 786     {
 787       try
 788       {
 789         Thread.sleep(25);
 790       } catch (InterruptedException q)
 791       {
 792       }
 793     }
 794     busy = true;
 795     long startTime = System.currentTimeMillis();
 796     try
 797     {
 798       return sendRestCommand(command);
 799     } finally
 800     {
 801       /*
 802        * Make sure busy flag is reset come what may!
 803        */
 804       busy = false;
 805       if (debug)
 806       {
 807         System.out.println("Chimera command took "
 808                 + (System.currentTimeMillis() - startTime) + "ms: "
 809                 + command);
 810       }
 811
 812     }
 813   }
 814
 815   /**
 816    * Sends the command to Chimera's REST API, and returns any response lines.
 817    *
 818    * @param command
 819    * @return
 820    */
 821   protected List<String> sendRestCommand(String command)
 822   {
 823     String restUrl = "http://127.0.0.1:" + this.chimeraRestPort + "/run";
 824     List<NameValuePair> commands = new ArrayList<>(1);
 825     commands.add(new BasicNameValuePair("command", command));
 826
 827     List<String> reply = new ArrayList<>();
 828     BufferedReader response = null;
 829     try
 830     {
 831       response = HttpClientUtils.doHttpUrlPost(restUrl, commands, CONNECTION_TIMEOUT_MS,
 832               REST_REPLY_TIMEOUT_MS);
 833       String line = "";
 834       while ((line = response.readLine()) != null)
 835       {
 836         reply.add(line);
 837       }
 838     } catch (Exception e)
 839     {
 840       logger.error("REST call '" + command + "' failed: " + e.getMessage());
 841     } finally
 842     {
 843       if (response != null)
 844       {
 845         try
 846         {
 847           response.close();
 848         } catch (IOException e)
 849         {
 850         }
 851       }
 852     }
 853     return reply;
 854   }
 855
 856   /**
 857    * Send a command to stdin of Chimera process, and optionally read any
 858    * responses.
 859    *
 860    * @param command
 861    * @param readReply
 862    * @return
 863    */
 864   protected List<String> sendStdinCommand(String command, boolean readReply)
 865   {
 866     chimeraListenerThread.clearResponse(command);
 867     String text = command.concat("\n");
 868     try
 869     {
 870       // send the command
 871       chimera.getOutputStream().write(text.getBytes());
 872       chimera.getOutputStream().flush();
 873     } catch (IOException e)
 874     {
 875       // logger.info("Unable to execute command: " + text);
 876       // logger.info("Exiting...");
 877       logger.warn("Unable to execute command: " + text);
 878       logger.warn("Exiting...");
 879       clearOnChimeraExit();
 880       return null;
 881     }
 882     if (!readReply)
 883     {
 884       return null;
 885     }
 886     List<String> rsp = chimeraListenerThread.getResponse(command);
 887     return rsp;
 888   }
 889
 890   public StructureManager getStructureManager()
 891   {
 892     return structureManager;
 893   }
 894
 895   public boolean isBusy()
 896   {
 897     return busy;
 898   }
 899
 900   public Process getChimeraProcess()
 901   {
 902     return chimera;
 903   }
 904 }