experiment with reinstating the sandbox permissions
[jalview.git] / src / jalview / appletgui / AppletJmol.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8)
3  * Copyright (C) 2012 J Procter, AM Waterhouse, LM Lui, J Engelhardt, G Barton, M Clamp, S Searle
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 of the License, or (at your option) any later version.
10  *  
11  * Jalview is distributed in the hope that it will be useful, but 
12  * WITHOUT ANY WARRANTY; without even the implied warranty 
13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
14  * PURPOSE.  See the GNU General Public License for more details.
15  * 
16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
17  */
18 package jalview.appletgui;
19
20 import java.util.*;
21 import java.awt.*;
22 import java.awt.event.*;
23
24 import jalview.api.SequenceStructureBinding;
25 import jalview.datamodel.*;
26 import jalview.structure.*;
27 import jalview.io.*;
28
29 import jalview.schemes.*;
30
31 public class AppletJmol extends EmbmenuFrame implements
32 // StructureListener,
33         KeyListener, ActionListener, ItemListener, SequenceStructureBinding
34
35 {
36   Menu fileMenu = new Menu("File");
37
38   Menu viewMenu = new Menu("View");
39
40   Menu coloursMenu = new Menu("Colours");
41
42   Menu chainMenu = new Menu("Show Chain");
43
44   Menu helpMenu = new Menu("Help");
45
46   MenuItem mappingMenuItem = new MenuItem("View Mapping");
47
48   CheckboxMenuItem seqColour = new CheckboxMenuItem("By Sequence", true);
49
50   CheckboxMenuItem jmolColour = new CheckboxMenuItem("Using Jmol", false);
51
52   MenuItem chain = new MenuItem("By Chain");
53
54   MenuItem charge = new MenuItem("Charge & Cysteine");
55
56   MenuItem zappo = new MenuItem("Zappo");
57
58   MenuItem taylor = new MenuItem("Taylor");
59
60   MenuItem hydro = new MenuItem("Hydrophobicity");
61
62   MenuItem helix = new MenuItem("Helix Propensity");
63
64   MenuItem strand = new MenuItem("Strand Propensity");
65
66   MenuItem turn = new MenuItem("Turn Propensity");
67
68   MenuItem buried = new MenuItem("Buried Index");
69
70   MenuItem purinepyrimidine = new MenuItem("Purine/Pyrimidine");
71
72   MenuItem user = new MenuItem("User Defined Colours");
73
74   MenuItem jmolHelp = new MenuItem("Jmol Help");
75
76   Panel scriptWindow;
77
78   TextField inputLine;
79
80   TextArea history;
81
82   RenderPanel renderPanel;
83
84   AlignmentPanel ap;
85
86   ArrayList _aps = new ArrayList();
87
88   String fileLoadingError;
89
90   boolean loadedInline;
91
92   // boolean colourBySequence = true;
93
94   FeatureRenderer fr = null;
95
96   AppletJmolBinding jmb;
97
98   /**
99    * datasource protocol for access to PDBEntry
100    */
101   String protocol = null;
102
103   /**
104    * Load a bunch of pdb entries associated with sequences in the alignment and
105    * display them - aligning them if necessary.
106    * 
107    * @param pdbentries
108    *          each pdb file (at least one needed)
109    * @param boundseqs
110    *          each set of sequences for each pdb file (must match number of pdb
111    *          files)
112    * @param boundchains
113    *          the target pdb chain corresponding with each sequence associated
114    *          with each pdb file (may be null at any level)
115    * @param align
116    *          true/false
117    * @param ap
118    *          associated alignment
119    * @param protocol
120    *          how to get pdb data
121    */
122   public AppletJmol(PDBEntry[] pdbentries, SequenceI[][] boundseqs,
123           String[][] boundchains, boolean align, AlignmentPanel ap,
124           String protocol)
125   {
126     throw new Error("Not yet implemented.");
127   }
128
129   public AppletJmol(PDBEntry pdbentry, SequenceI[] seq, String[] chains,
130           AlignmentPanel ap, String protocol)
131   {
132     this.ap = ap;
133     jmb = new AppletJmolBinding(this, ap.getStructureSelectionManager(),
134             new PDBEntry[]
135             { pdbentry }, new SequenceI[][]
136             { seq }, new String[][]
137             { chains }, protocol);
138     jmb.setColourBySequence(true);
139     if (pdbentry.getId() == null || pdbentry.getId().length() < 1)
140     {
141       if (protocol.equals(AppletFormatAdapter.PASTE))
142       {
143         pdbentry.setId("PASTED PDB"
144                 + (chains == null ? "_" : chains.toString()));
145       }
146       else
147       {
148         pdbentry.setId(pdbentry.getFile());
149       }
150     }
151
152     if (jalview.bin.JalviewLite.debug)
153     {
154       System.err
155               .println("AppletJmol: PDB ID is '" + pdbentry.getId() + "'");
156     }
157
158     String alreadyMapped = StructureSelectionManager
159             .getStructureSelectionManager(ap.av.applet)
160             .alreadyMappedToFile(pdbentry.getId());
161     MCview.PDBfile reader = null;
162     if (alreadyMapped != null)
163     {
164       reader = StructureSelectionManager.getStructureSelectionManager(
165               ap.av.applet).setMapping(seq, chains, pdbentry.getFile(),
166               protocol);
167       // PROMPT USER HERE TO ADD TO NEW OR EXISTING VIEW?
168       // FOR NOW, LETS JUST OPEN A NEW WINDOW
169     }
170     MenuBar menuBar = new MenuBar();
171     menuBar.add(fileMenu);
172     fileMenu.add(mappingMenuItem);
173     menuBar.add(viewMenu);
174     mappingMenuItem.addActionListener(this);
175     viewMenu.add(chainMenu);
176     menuBar.add(coloursMenu);
177     menuBar.add(helpMenu);
178
179     charge.addActionListener(this);
180     hydro.addActionListener(this);
181     chain.addActionListener(this);
182     seqColour.addItemListener(this);
183     jmolColour.addItemListener(this);
184     zappo.addActionListener(this);
185     taylor.addActionListener(this);
186     helix.addActionListener(this);
187     strand.addActionListener(this);
188     turn.addActionListener(this);
189     buried.addActionListener(this);
190     purinepyrimidine.addActionListener(this);
191     user.addActionListener(this);
192
193     jmolHelp.addActionListener(this);
194
195     coloursMenu.add(seqColour);
196     coloursMenu.add(chain);
197     coloursMenu.add(charge);
198     coloursMenu.add(zappo);
199     coloursMenu.add(taylor);
200     coloursMenu.add(hydro);
201     coloursMenu.add(helix);
202     coloursMenu.add(strand);
203     coloursMenu.add(turn);
204     coloursMenu.add(buried);
205     coloursMenu.add(purinepyrimidine);
206     coloursMenu.add(user);
207     coloursMenu.add(jmolColour);
208     helpMenu.add(jmolHelp);
209     this.setLayout(new BorderLayout());
210
211     setMenuBar(menuBar);
212
213     renderPanel = new RenderPanel();
214     embedMenuIfNeeded(renderPanel);
215     this.add(renderPanel, BorderLayout.CENTER);
216     scriptWindow = new Panel();
217     scriptWindow.setVisible(false);
218     // this.add(scriptWindow, BorderLayout.SOUTH);
219
220     try
221     {
222       jmb.allocateViewer(renderPanel, true, ap.av.applet.getName()
223               + "_jmol_", ap.av.applet.getDocumentBase(),
224               ap.av.applet.getCodeBase(), "-applet", scriptWindow, null);
225     } catch (Exception e)
226     {
227       System.err
228               .println("Couldn't create a jmol viewer. Args to allocate viewer were:\nDocumentBase="
229                       + ap.av.applet.getDocumentBase()
230                       + "\nCodebase="
231                       + ap.av.applet.getCodeBase());
232       e.printStackTrace();
233       dispose();
234       return;
235     }
236     jmb.newJmolPopup(true, "Jmol", true);
237
238     this.addWindowListener(new WindowAdapter()
239     {
240       public void windowClosing(WindowEvent evt)
241       {
242         closeViewer();
243       }
244     });
245     if (pdbentry.getProperty() == null)
246     {
247       pdbentry.setProperty(new Hashtable());
248       pdbentry.getProperty().put("protocol", protocol);
249     }
250     if (pdbentry.getFile() != null)
251     {
252       // import structure data from pdbentry.getFile based on given protocol
253       if (protocol.equals(AppletFormatAdapter.PASTE))
254       {
255         // TODO: JAL-623 : correctly record file contents for matching up later
256         // pdbentry.getProperty().put("pdbfilehash",""+pdbentry.getFile().hashCode());
257         loadInline(pdbentry.getFile());
258       }
259       else if (protocol.equals(AppletFormatAdapter.FILE)
260               || protocol.equals(AppletFormatAdapter.URL))
261       {
262         jmb.viewer.openFile(pdbentry.getFile());
263       }
264       else
265       {
266         // probably CLASSLOADER based datasource..
267         // Try and get a reader on the datasource, and pass that to Jmol
268         try
269         {
270           java.io.Reader freader = null;
271           if (reader != null)
272           {
273             if (jalview.bin.JalviewLite.debug)
274             {
275               System.err
276                       .println("AppletJmol:Trying to reuse existing PDBfile IO parser.");
277             }
278             // re-use the one we opened earlier
279             freader = reader.getReader();
280           }
281           if (freader == null)
282           {
283             if (jalview.bin.JalviewLite.debug)
284             {
285               System.err
286                       .println("AppletJmol:Creating new PDBfile IO parser.");
287             }
288             FileParse fp = new FileParse(pdbentry.getFile(), protocol);
289             fp.mark();
290             // reader = new MCview.PDBfile(fp);
291             // could set ID, etc.
292             // if (!reader.isValid())
293             // {
294             // throw new Exception("Invalid datasource.
295             // "+reader.getWarningMessage());
296             // }
297             // fp.reset();
298             freader = fp.getReader();
299           }
300           if (freader == null)
301           {
302             throw new Exception(
303                     "Invalid datasource. Could not obtain Reader.");
304           }
305           jmb.viewer.openReader(pdbentry.getFile(), pdbentry.getId(),
306                   freader);
307         } catch (Exception e)
308         {
309           // give up!
310           System.err.println("Couldn't access pdbentry id="
311                   + pdbentry.getId() + " and file=" + pdbentry.getFile()
312                   + " using protocol=" + protocol);
313           e.printStackTrace();
314         }
315       }
316     }
317
318     jalview.bin.JalviewLite.addFrame(this, jmb.getViewerTitle(), 400, 400);
319   }
320
321   public void loadInline(String string)
322   {
323     loadedInline = true;
324     jmb.loadInline(string);
325   }
326
327   void setChainMenuItems(Vector chains)
328   {
329     chainMenu.removeAll();
330
331     MenuItem menuItem = new MenuItem("All");
332     menuItem.addActionListener(this);
333
334     chainMenu.add(menuItem);
335
336     CheckboxMenuItem menuItemCB;
337     for (int c = 0; c < chains.size(); c++)
338     {
339       menuItemCB = new CheckboxMenuItem(chains.elementAt(c).toString(),
340               true);
341       menuItemCB.addItemListener(this);
342       chainMenu.add(menuItemCB);
343     }
344   }
345
346   boolean allChainsSelected = false;
347
348   void centerViewer()
349   {
350     Vector toshow = new Vector();
351     String lbl;
352     int mlength, p, mnum;
353     for (int i = 0; i < chainMenu.getItemCount(); i++)
354     {
355       if (chainMenu.getItem(i) instanceof CheckboxMenuItem)
356       {
357         CheckboxMenuItem item = (CheckboxMenuItem) chainMenu.getItem(i);
358         if (item.getState())
359         {
360           toshow.addElement(item.getLabel());
361         }
362       }
363     }
364     jmb.centerViewer(toshow);
365   }
366
367   void closeViewer()
368   {
369     jmb.closeViewer();
370     jmb = null;
371     this.setVisible(false);
372   }
373
374   public void actionPerformed(ActionEvent evt)
375   {
376     if (evt.getSource() == mappingMenuItem)
377     {
378       jalview.appletgui.CutAndPasteTransfer cap = new jalview.appletgui.CutAndPasteTransfer(
379               false, null);
380       Frame frame = new Frame();
381       frame.add(cap);
382
383       StringBuffer sb = new StringBuffer();
384       try
385       {
386         for (int s = 0; s < jmb.pdbentry.length; s++)
387         {
388           sb.append(jmb.printMapping(jmb.pdbentry[s].getFile()));
389           sb.append("\n");
390         }
391         cap.setText(sb.toString());
392       } catch (OutOfMemoryError ex)
393       {
394         frame.dispose();
395         System.err
396                 .println("Out of memory when trying to create dialog box with sequence-structure mapping.");
397         return;
398       }
399       jalview.bin.JalviewLite.addFrame(frame, "PDB - Sequence Mapping",
400               550, 600);
401     }
402     else if (evt.getSource() == charge)
403     {
404       setEnabled(charge);
405       jmb.colourByCharge();
406     }
407
408     else if (evt.getSource() == chain)
409     {
410       setEnabled(chain);
411       jmb.colourByChain();
412     }
413     else if (evt.getSource() == zappo)
414     {
415       setEnabled(zappo);
416       jmb.setJalviewColourScheme(new ZappoColourScheme());
417     }
418     else if (evt.getSource() == taylor)
419     {
420       setEnabled(taylor);
421       jmb.setJalviewColourScheme(new TaylorColourScheme());
422     }
423     else if (evt.getSource() == hydro)
424     {
425       setEnabled(hydro);
426       jmb.setJalviewColourScheme(new HydrophobicColourScheme());
427     }
428     else if (evt.getSource() == helix)
429     {
430       setEnabled(helix);
431       jmb.setJalviewColourScheme(new HelixColourScheme());
432     }
433     else if (evt.getSource() == strand)
434     {
435       setEnabled(strand);
436       jmb.setJalviewColourScheme(new StrandColourScheme());
437     }
438     else if (evt.getSource() == turn)
439     {
440       setEnabled(turn);
441       jmb.setJalviewColourScheme(new TurnColourScheme());
442     }
443     else if (evt.getSource() == buried)
444     {
445       setEnabled(buried);
446       jmb.setJalviewColourScheme(new BuriedColourScheme());
447     }
448     else if (evt.getSource() == purinepyrimidine)
449     {
450       jmb.setJalviewColourScheme(new PurinePyrimidineColourScheme());
451     }
452     else if (evt.getSource() == user)
453     {
454       setEnabled(user);
455       new UserDefinedColours(this);
456     }
457     else if (evt.getSource() == jmolHelp)
458     {
459       try
460       {
461         ap.av.applet.getAppletContext().showDocument(
462                 new java.net.URL(
463                         "http://jmol.sourceforge.net/docs/JmolUserGuide/"),
464                 "jmolHelp");
465       } catch (java.net.MalformedURLException ex)
466       {
467       }
468     }
469     else
470     {
471       allChainsSelected = true;
472       for (int i = 0; i < chainMenu.getItemCount(); i++)
473       {
474         if (chainMenu.getItem(i) instanceof CheckboxMenuItem)
475           ((CheckboxMenuItem) chainMenu.getItem(i)).setState(true);
476       }
477
478       centerViewer();
479       allChainsSelected = false;
480     }
481   }
482
483   /**
484    * tick or untick the seqColour menu entry or jmoColour entry depending upon
485    * if it was selected or not.
486    * 
487    * @param itm
488    */
489   private void setEnabled(MenuItem itm)
490   {
491     jmolColour.setState(itm == jmolColour);
492     seqColour.setState(itm == seqColour);
493     jmb.setColourBySequence(itm == seqColour);
494   }
495
496   public void itemStateChanged(ItemEvent evt)
497   {
498     if (evt.getSource() == jmolColour)
499     {
500       setEnabled(jmolColour);
501       jmb.setColourBySequence(false);
502     }
503     else if (evt.getSource() == seqColour)
504     {
505       setEnabled(seqColour);
506       jmb.colourBySequence(ap.av.getShowSequenceFeatures(), ap);
507     }
508     else if (!allChainsSelected)
509       centerViewer();
510   }
511
512   public void keyPressed(KeyEvent evt)
513   {
514     if (evt.getKeyCode() == KeyEvent.VK_ENTER && scriptWindow.isVisible())
515     {
516       jmb.eval(inputLine.getText());
517       history.append("\n$ " + inputLine.getText());
518       inputLine.setText("");
519     }
520
521   }
522
523   public void keyTyped(KeyEvent evt)
524   {
525   }
526
527   public void keyReleased(KeyEvent evt)
528   {
529   }
530
531   public void updateColours(Object source)
532   {
533     AlignmentPanel ap = (AlignmentPanel) source;
534     jmb.colourBySequence(ap.av.getShowSequenceFeatures(), ap);
535   }
536
537   public void updateTitleAndMenus()
538   {
539     if (jmb.fileLoadingError != null && jmb.fileLoadingError.length() > 0)
540     {
541       repaint();
542       return;
543     }
544     setChainMenuItems(jmb.chainNames);
545     jmb.colourBySequence(ap.av.getShowSequenceFeatures(), ap);
546
547     setTitle(jmb.getViewerTitle());
548   }
549
550   public void showUrl(String url)
551   {
552     try
553     {
554       ap.av.applet.getAppletContext().showDocument(new java.net.URL(url),
555               "jmolOutput");
556     } catch (java.net.MalformedURLException ex)
557     {
558     }
559   }
560
561   Panel splitPane = null;
562
563   public void showConsole(boolean showConsole)
564   {
565     if (showConsole)
566     {
567       remove(renderPanel);
568       splitPane = new Panel();
569
570       splitPane.setLayout(new java.awt.GridLayout(2, 1));
571       splitPane.add(renderPanel);
572       splitPane.add(scriptWindow);
573       scriptWindow.setVisible(true);
574       this.add(splitPane, BorderLayout.CENTER);
575       splitPane.setVisible(true);
576       splitPane.validate();
577     }
578     else
579     {
580       scriptWindow.setVisible(false);
581       remove(splitPane);
582       add(renderPanel, BorderLayout.CENTER);
583       splitPane = null;
584     }
585     validate();
586   }
587
588   public float[][] functionXY(String functionName, int x, int y)
589   {
590     return null;
591   }
592
593   // /End JmolStatusListener
594   // /////////////////////////////
595
596   class RenderPanel extends Panel
597   {
598     Dimension currentSize = new Dimension();
599
600     Rectangle rectClip = new Rectangle();
601
602     public void update(Graphics g)
603     {
604       paint(g);
605     }
606
607     public void paint(Graphics g)
608     {
609       currentSize = this.getSize();
610       rectClip = g.getClipBounds();
611
612       if (jmb.viewer == null)
613       {
614         g.setColor(Color.black);
615         g.fillRect(0, 0, currentSize.width, currentSize.height);
616         g.setColor(Color.white);
617         g.setFont(new Font("Verdana", Font.BOLD, 14));
618         g.drawString("Retrieving PDB data....", 20, currentSize.height / 2);
619       }
620       else
621       {
622         jmb.viewer.renderScreenImage(g, currentSize, rectClip);
623       }
624     }
625   }
626
627   /*
628    * @Override public Color getColour(int atomIndex, int pdbResNum, String
629    * chain, String pdbId) { return jmb.getColour(atomIndex, pdbResNum, chain,
630    * pdbId); }
631    * 
632    * @Override public String[] getPdbFile() { return jmb.getPdbFile(); }
633    * 
634    * @Override public void highlightAtom(int atomIndex, int pdbResNum, String
635    * chain, String pdbId) { jmb.highlightAtom(atomIndex, pdbResNum, chain,
636    * pdbId);
637    * 
638    * }
639    * 
640    * @Override public void mouseOverStructure(int atomIndex, String strInfo) {
641    * jmb.mouseOverStructure(atomIndex, strInfo);
642    * 
643    * }
644    */
645   public void setJalviewColourScheme(UserColourScheme ucs)
646   {
647     jmb.setJalviewColourScheme(ucs);
648   }
649
650   public AlignmentPanel getAlignmentPanelFor(AlignmentI alignment)
651   {
652     for (int i = 0; i < _aps.size(); i++)
653     {
654       if (((AlignmentPanel) _aps.get(i)).av.getAlignment() == alignment)
655       {
656         return ((AlignmentPanel) _aps.get(i));
657       }
658     }
659     return ap;
660   }
661 }