Send gapChar to print original Data
[jalview.git] / src / jalview / ws / Discoverer.java
1 /*
2 * Jalview - A Sequence Alignment Editor and Viewer
3 * Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
4 *
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License
7 * as published by the Free Software Foundation; either version 2
8 * of the License, or (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
18 */
19 package jalview.ws;
20
21 /**
22  * <p>Title: </p>
23  *
24  * <p>Description: </p>
25  *
26  * <p>Copyright: Copyright (c) 2004</p>
27  *
28  * <p>Company: Dundee University</p>
29  *
30  * @author not attributable
31  * @version 1.0
32  */
33 import ext.vamsas.*;
34 import java.util.Vector;
35 import java.util.Hashtable;
36 import java.util.StringTokenizer;
37 import javax.swing.JOptionPane;
38
39 public class Discoverer
40     extends Thread implements Runnable
41 {
42   ext.vamsas.IRegistry registry; // the root registry service.
43   private java.beans.PropertyChangeSupport changeSupport = new java.beans.
44       PropertyChangeSupport(this);
45
46   /**
47    * change listeners are notified of "services" property changes
48    *
49    * @param listener to be added that consumes new services Hashtable object.
50    */
51   public void addPropertyChangeListener(
52       java.beans.PropertyChangeListener listener)
53   {
54     changeSupport.addPropertyChangeListener(listener);
55   }
56
57   /**
58    *
59    *
60    * @param listener to be removed
61    */
62   public void removePropertyChangeListener(
63       java.beans.PropertyChangeListener listener)
64   {
65     changeSupport.removePropertyChangeListener(listener);
66   }
67
68   /**
69    * Property change listener firing routine
70    *
71    * @param prop services
72    * @param oldvalue old services hash
73    * @param newvalue new services hash
74    */
75   public void firePropertyChange(String prop, Object oldvalue, Object newvalue)
76   {
77     changeSupport.firePropertyChange(prop, oldvalue, newvalue);
78   }
79
80   /**
81    * Initializes the server field with a valid service implementation.
82    *
83    * @return true if service was located.
84    */
85   private IRegistry locateWebService(java.net.URL WsURL)
86   {
87     IRegistryServiceLocator loc = new IRegistryServiceLocator(); // Default
88     IRegistry server = null;
89     try
90     {
91       server = loc.getRegistryService(WsURL);
92       ( (RegistryServiceSoapBindingStub) server).setTimeout(60000); // One minute timeout
93     }
94     catch (Exception ex)
95     {
96       jalview.bin.Cache.log.error(
97           "Serious!  Service location failed\nfor URL :" + WsURL +
98           "\n", ex);
99
100       return null;
101     }
102
103     loc.getEngine().setOption("axis", "1");
104
105     return server;
106   }
107
108   static private java.net.URL RootServiceURL = null;
109   static public Vector ServiceURLList = null;
110   static private boolean reallyDiscoverServices = true;
111
112   public static java.util.Hashtable services = null; // vectors of services stored by abstractServiceType string
113   public static java.util.Vector serviceList = null; // flat list of services
114   static private Vector getDiscoveryURLS() {
115     Vector urls = new Vector();
116     String RootServiceURLs = jalview.bin.Cache.getDefault("DISCOVERY_URLS",
117         "http://www.compbio.dundee.ac.uk/JalviewWS/services/ServiceRegistry");
118
119     try{
120       StringTokenizer st = new StringTokenizer(RootServiceURLs, ",");
121       while (st.hasMoreElements())
122       {
123         String url = null;
124         try
125         {
126           java.net.URL u = new java.net.URL(url = st.nextToken());
127           if (!urls.contains(u))
128             urls.add(u);
129           else
130             jalview.bin.Cache.log.info("Ignoring duplicate url in DISCOVERY_URLS list");
131         }
132         catch (Exception ex)
133         {
134           jalview.bin.Cache.log.warn(
135               "Problem whilst trying to make a URL from '" +
136               ( (url != null) ? url : "<null>")+"'");
137           jalview.bin.Cache.log.warn("This was probably due to a malformed comma separated list"
138                                        +" in the DISCOVERY_URLS entry of $(HOME)/.jalview_properties)");
139           jalview.bin.Cache.log.debug("Exception was ",ex);
140         }
141       }
142     }catch(Exception ex)
143     {jalview.bin.Cache.log.warn("Error parsing comma separated list of urls in DISCOVERY_URLS.",ex);}
144     if (urls.size()>0)
145       return urls;
146     return null;
147   }
148
149   /**
150    * fetch new services or reset to hardwired defaults depending on preferences.
151    */
152   static public void doDiscovery()
153   {
154     jalview.bin.Cache.log.debug("(Re)-Initialising the discovery URL list.");
155     try
156     {
157       reallyDiscoverServices = jalview.bin.Cache.getDefault("DISCOVERY_START", false);
158       if (reallyDiscoverServices)
159       {
160         ServiceURLList = getDiscoveryURLS();
161       }
162       else
163       {
164         jalview.bin.Cache.log.debug("Setting default services");
165         services = new Hashtable();
166         // Muscle, Clustal and JPred.
167         ServiceHandle[] defServices = {
168             new ServiceHandle(
169                 "MsaWS",
170                 "Edgar, Robert C. (2004), MUSCLE: multiple sequence alignment " +
171                 "with high accuracy and high throughput, Nucleic Acids Research 32(5), 1792-97.",
172                 "http://www.compbio.dundee.ac.uk/JalviewWS/services/MuscleWS",
173                 "Muscle Multiple Protein Sequence Alignment"
174 ),
175             new ServiceHandle(
176                 "MsaWS",
177                 "Thompson, J.D., Higgins, D.G. and Gibson, T.J. (1994) CLUSTAL W: improving the sensitivity of progressive multiple" +
178                 " sequence alignment through sequence weighting, position specific gap penalties and weight matrix choice." +
179                 " Nucleic Acids Research, 22 4673-4680",
180                 "http://www.compbio.dundee.ac.uk/JalviewWS/services/ClustalWS",
181                 "ClustalW Multiple Sequence Alignment"),
182             new ServiceHandle(
183                 "SecStrPred",
184                 "Cuff J. A and Barton G.J (2000) Application of " +
185                 "multiple sequence alignment profiles to improve protein secondary structure prediction, " +
186                 "Proteins 40:502-511",
187                 "http://www.compbio.dundee.ac.uk/JalviewWS/services/jpred","JNet Secondary Structure Prediction"
188                 )};
189         services = new Hashtable();
190         serviceList = new Vector();
191         buildServiceLists(defServices, serviceList, services);
192       }
193
194     }
195     catch (Exception e)
196     {
197       System.err.println(
198           "jalview.rootRegistry is not a proper url!\nWas set to " +
199           RootServiceURL + "\n" + e);
200     }
201
202   }
203   // TODO: JBPNote : make this discover more services based on list of
204   // discovery service urls, break cyclic references to the same url and
205   // duplicate service entries (same endpoint *and* same interface)
206   private ServiceHandle[] getServices(java.net.URL location)
207   {
208     ServiceHandles shs = null;
209     try
210     {
211       jalview.bin.Cache.log.debug("Discovering services using " + location);
212       shs = locateWebService(location).getServices();
213     }
214     catch (org.apache.axis.AxisFault f) {
215       // JBPNote - should do this a better way!
216       if (f.getFaultReason().indexOf("(407)")>-1) {
217         if (jalview.gui.Desktop.desktop!=null)
218           JOptionPane.showMessageDialog(jalview.gui.Desktop.desktop, "Please set up your proxy settings in the 'Connections' tab of the Preferences window",
219                                       "Proxy Authorization Failed",
220                                       JOptionPane.WARNING_MESSAGE);
221       } else {
222         jalview.bin.Cache.log.warn("No Discovery service at " +
223                                    location);
224         jalview.bin.Cache.log.debug("Axis Fault", f);
225       }
226     }
227     catch (Exception e) {
228       jalview.bin.Cache.log.warn("No Discovery service at " +
229                                  location);
230       jalview.bin.Cache.log.debug("Discovery Service General Exception", e);
231     }
232     if ( (shs != null) && shs.getServices().length > 0)
233     {
234       return shs.getServices();
235     }
236     return null;
237   }
238
239   /**
240    * Adds a list of services to the service catalog and categorised catalog
241    * returns true if ServiceURLList was modified with a new DiscoveryService URL
242    * @param sh ServiceHandle[]
243    * @param cat Vector
244    * @param sscat Hashtable
245    * @return boolean
246    */
247   static private boolean buildServiceLists(ServiceHandle[] sh, Vector cat,
248                                     Hashtable sscat)
249   {
250     boolean seenNewDiscovery = false;
251     for (int i = 0, j = sh.length; i < j; i++)
252     {
253       if (!cat.contains(sh[i]))
254       {
255         jalview.bin.Cache.log.debug("A " + sh[i].getAbstractName() +
256                                       " service called " +
257                                       sh[i].getName() + " exists at " +
258                                       sh[i].getEndpointURL() + "\n");
259         if (!sscat.containsKey(sh[i].getAbstractName()))
260         {
261           sscat.put(sh[i].getAbstractName(), cat = new Vector());
262         }
263         else
264         {
265           cat = (Vector) sscat.get(sh[i].getAbstractName());
266         }
267         cat.add(sh[i]);
268         if (sh[i].getAbstractName().equals("Registry"))
269         {
270           for (int s = 0, sUrls = ServiceURLList.size(); s < sUrls; s++)
271           {
272             java.net.URL disc_serv = null;
273             try
274             {
275               disc_serv = new java.net.URL(sh[i].getEndpointURL());
276               if (!ServiceURLList.contains(disc_serv))
277               {
278                 jalview.bin.Cache.log.debug(
279                     "Adding new discovery service at " + disc_serv);
280                 ServiceURLList.add(disc_serv);
281                 seenNewDiscovery = true;
282               }
283             }
284             catch (Exception e)
285             {
286               jalview.bin.Cache.log.debug(
287                   "Ignoring bad discovery service URL " + sh[i].getEndpointURL(),
288                   e);
289             }
290           }
291         }
292       }
293     }
294     return seenNewDiscovery;
295   }
296
297   public void discoverServices()
298   {
299     Hashtable sscat = new Hashtable();
300     Vector cat = new Vector();
301     ServiceHandle sh[] = null;
302     int s_url = 0;
303     if (ServiceURLList==null)
304     {
305       jalview.bin.Cache.log.debug("No service endpoints to use for service discovery.");
306       return;
307     }
308     while (s_url < ServiceURLList.size())
309     {
310       if ( (sh = getServices( (java.net.URL) ServiceURLList.get(s_url))) != null)
311       {
312
313         buildServiceLists(sh, cat, sscat);
314       } else {
315         jalview.bin.Cache.log.warn(
316             "No services at "
317             +((java.net.URL) ServiceURLList.get(s_url))
318             +" - check DISCOVERY_URLS property in .jalview_properties");
319       }
320       s_url++;
321     }
322     // TODO: decide on correct semantics for services list - PropertyChange
323     // provides a way of passing the new object around
324     // so no need to access original discovery thread.
325     // Curent decision is to change properties then notify listeners with old and new values.
326     Hashtable oldServices = services;
327     //Vector oldServicelist = serviceList;
328     services = sscat;
329     serviceList = cat;
330     firePropertyChange("services", oldServices, services);
331   }
332
333   /**
334    * creates a new thread to call discoverServices()
335    */
336   public void run()
337   {
338     final Discoverer discoverer = this;
339     Thread discoverThread = new Thread() {
340       public void run() {
341         discoverer.doDiscovery();
342         discoverer.discoverServices();
343       }
344     };
345     discoverThread.start();
346   }
347 }