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