update author list in license for (JAL-826)
[jalview.git] / src / jalview / ws / jws1 / Discoverer.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
3  * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, 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.ws.jws1;
19
20 import java.util.*;
21
22 import javax.swing.*;
23
24 import ext.vamsas.*;
25
26 public class Discoverer implements Runnable
27 {
28   ext.vamsas.IRegistry registry; // the root registry service.
29
30   private java.beans.PropertyChangeSupport changeSupport = new java.beans.PropertyChangeSupport(
31           this);
32
33   /**
34    * change listeners are notified of "services" property changes
35    * 
36    * @param listener
37    *          to be added that consumes new services Hashtable object.
38    */
39   public void addPropertyChangeListener(
40           java.beans.PropertyChangeListener listener)
41   {
42     changeSupport.addPropertyChangeListener(listener);
43   }
44
45   /**
46    * 
47    * 
48    * @param listener
49    *          to be removed
50    */
51   public void removePropertyChangeListener(
52           java.beans.PropertyChangeListener listener)
53   {
54     changeSupport.removePropertyChangeListener(listener);
55   }
56
57   /**
58    * Property change listener firing routine
59    * 
60    * @param prop
61    *          services
62    * @param oldvalue
63    *          old services hash
64    * @param newvalue
65    *          new services hash
66    */
67   public void firePropertyChange(String prop, Object oldvalue,
68           Object newvalue)
69   {
70     changeSupport.firePropertyChange(prop, oldvalue, newvalue);
71   }
72
73   /**
74    * Initializes the server field with a valid service implementation.
75    * 
76    * @return true if service was located.
77    */
78   private IRegistry locateWebService(java.net.URL WsURL)
79   {
80     IRegistryServiceLocator loc = new IRegistryServiceLocator(); // Default
81     IRegistry server = null;
82     try
83     {
84       server = loc.getRegistryService(WsURL);
85       ((RegistryServiceSoapBindingStub) server).setTimeout(60000); // One
86       // minute
87       // timeout
88     } catch (Exception ex)
89     {
90       jalview.bin.Cache.log
91               .error("Serious!  Service location failed\nfor URL :" + WsURL
92                       + "\n", ex);
93
94       return null;
95     }
96
97     loc.getEngine().setOption("axis", "1");
98
99     return server;
100   }
101
102   static private java.net.URL RootServiceURL = null;
103
104   static public Vector ServiceURLList = null;
105
106   static private boolean reallyDiscoverServices = true;
107
108   public static java.util.Hashtable services = null; // vectors of services
109
110   // stored by
111   // abstractServiceType
112   // string
113
114   public static java.util.Vector serviceList = null; // flat list of services
115
116   static private Vector getDiscoveryURLS()
117   {
118     Vector urls = new Vector();
119     String RootServiceURLs = jalview.bin.Cache
120             .getDefault("DISCOVERY_URLS",
121                     "http://www.compbio.dundee.ac.uk/JalviewWS/services/ServiceRegistry");
122
123     try
124     {
125       StringTokenizer st = new StringTokenizer(RootServiceURLs, ",");
126       while (st.hasMoreElements())
127       {
128         String url = null;
129         try
130         {
131           java.net.URL u = new java.net.URL(url = st.nextToken());
132           if (!urls.contains(u))
133           {
134             urls.add(u);
135           }
136           else
137           {
138             jalview.bin.Cache.log
139                     .info("Ignoring duplicate url in DISCOVERY_URLS list");
140           }
141         } catch (Exception ex)
142         {
143           jalview.bin.Cache.log
144                   .warn("Problem whilst trying to make a URL from '"
145                           + ((url != null) ? url : "<null>") + "'");
146           jalview.bin.Cache.log
147                   .warn("This was probably due to a malformed comma separated list"
148                           + " in the DISCOVERY_URLS entry of $(HOME)/.jalview_properties)");
149           jalview.bin.Cache.log.debug("Exception was ", ex);
150         }
151       }
152     } catch (Exception ex)
153     {
154       jalview.bin.Cache.log
155               .warn("Error parsing comma separated list of urls in DISCOVERY_URLS.",
156                       ex);
157     }
158     if (urls.size() > 0)
159     {
160       return urls;
161     }
162     return null;
163   }
164
165   /**
166    * fetch new services or reset to hardwired defaults depending on preferences.
167    */
168   static public void doDiscovery()
169   {
170     jalview.bin.Cache.log
171             .debug("(Re)-Initialising the discovery URL list.");
172     try
173     {
174       reallyDiscoverServices = jalview.bin.Cache.getDefault(
175               "DISCOVERY_START", false);
176       if (reallyDiscoverServices)
177       {
178         ServiceURLList = getDiscoveryURLS();
179       }
180       else
181       {
182         jalview.bin.Cache.log.debug("Setting default services");
183         services = new Hashtable();
184         // Muscle, Clustal and JPred.
185         ServiceHandle[] defServices =
186         {
187             new ServiceHandle(
188                     "MsaWS",
189                     "Edgar, Robert C. (2004), MUSCLE: multiple sequence alignment "
190                             + "with high accuracy and high throughput, Nucleic Acids Research 32(5), 1792-97.",
191                     "http://www.compbio.dundee.ac.uk/JalviewWS/services/MuscleWS",
192                     "Muscle Multiple Protein Sequence Alignment"),
193             new ServiceHandle(
194                     "MsaWS",
195                     "Katoh, K., K. Kuma, K., Toh, H.,  and Miyata, T. (2005) "
196                             + "\"MAFFT version 5: improvement in accuracy of multiple sequence alignment.\""
197                             + " Nucleic Acids Research, 33 511-518",
198                     "http://www.compbio.dundee.ac.uk/JalviewWS/services/MafftWS",
199                     "MAFFT Multiple Sequence Alignment"),
200             new ServiceHandle(
201                     "MsaWS",
202                     "Thompson, J.D., Higgins, D.G. and Gibson, T.J. (1994) CLUSTAL W: improving the sensitivity of progressive multiple"
203                             + " sequence alignment through sequence weighting, position specific gap penalties and weight matrix choice."
204                             + " Nucleic Acids Research, 22 4673-4680",
205                     "http://www.compbio.dundee.ac.uk/JalviewWS/services/ClustalWS",
206                     "ClustalW Multiple Sequence Alignment"),
207             new ServiceHandle(
208                     "SecStrPred",
209                     "Cole C., Barber J. D., Barton G.J (2008) "
210                             + "The Jpred 3 secondary structure prediction server "
211                             + "Nucleic Acids Research, 36 W197-W201",
212                     "http://www.compbio.dundee.ac.uk/JalviewWS/services/jpred",
213                     "JNet Secondary Structure Prediction") };
214         services = new Hashtable();
215         serviceList = new Vector();
216         buildServiceLists(defServices, serviceList, services);
217       }
218
219     } catch (Exception e)
220     {
221       System.err
222               .println("jalview.rootRegistry is not a proper url!\nWas set to "
223                       + RootServiceURL + "\n" + e);
224     }
225
226   }
227
228   // TODO: JBPNote : make this discover more services based on list of
229   // discovery service urls, break cyclic references to the same url and
230   // duplicate service entries (same endpoint *and* same interface)
231   private ServiceHandle[] getServices(java.net.URL location)
232   {
233     ServiceHandles shs = null;
234     try
235     {
236       jalview.bin.Cache.log.debug("Discovering services using " + location);
237       shs = locateWebService(location).getServices();
238     } catch (org.apache.axis.AxisFault f)
239     {
240       // JBPNote - should do this a better way!
241       if (f.getFaultReason().indexOf("(407)") > -1)
242       {
243         if (jalview.gui.Desktop.desktop != null)
244         {
245           JOptionPane
246                   .showMessageDialog(
247                           jalview.gui.Desktop.desktop,
248                           "Please set up your proxy settings in the 'Connections' tab of the Preferences window",
249                           "Proxy Authorization Failed",
250                           JOptionPane.WARNING_MESSAGE);
251         }
252       }
253       else
254       {
255         jalview.bin.Cache.log.warn("No Discovery service at " + location);
256         jalview.bin.Cache.log.debug("Axis Fault", f);
257       }
258     } catch (Exception e)
259     {
260       jalview.bin.Cache.log.warn("No Discovery service at " + location);
261       jalview.bin.Cache.log.debug("Discovery Service General Exception", e);
262     }
263     if ((shs != null) && shs.getServices().length > 0)
264     {
265       return shs.getServices();
266     }
267     return null;
268   }
269
270   /**
271    * Adds a list of services to the service catalog and categorised catalog
272    * returns true if ServiceURLList was modified with a new DiscoveryService URL
273    * 
274    * @param sh
275    *          ServiceHandle[]
276    * @param cat
277    *          Vector
278    * @param sscat
279    *          Hashtable
280    * @return boolean
281    */
282   static private boolean buildServiceLists(ServiceHandle[] sh, Vector cat,
283           Hashtable sscat)
284   {
285     boolean seenNewDiscovery = false;
286     for (int i = 0, j = sh.length; i < j; i++)
287     {
288       if (!cat.contains(sh[i]))
289       {
290         jalview.bin.Cache.log.debug("A " + sh[i].getAbstractName()
291                 + " service called " + sh[i].getName() + " exists at "
292                 + sh[i].getEndpointURL() + "\n");
293         if (!sscat.containsKey(sh[i].getAbstractName()))
294         {
295           sscat.put(sh[i].getAbstractName(), cat = new Vector());
296         }
297         else
298         {
299           cat = (Vector) sscat.get(sh[i].getAbstractName());
300         }
301         cat.add(sh[i]);
302         if (sh[i].getAbstractName().equals("Registry"))
303         {
304           for (int s = 0, sUrls = ServiceURLList.size(); s < sUrls; s++)
305           {
306             java.net.URL disc_serv = null;
307             try
308             {
309               disc_serv = new java.net.URL(sh[i].getEndpointURL());
310               if (!ServiceURLList.contains(disc_serv))
311               {
312                 jalview.bin.Cache.log
313                         .debug("Adding new discovery service at "
314                                 + disc_serv);
315                 ServiceURLList.add(disc_serv);
316                 seenNewDiscovery = true;
317               }
318             } catch (Exception e)
319             {
320               jalview.bin.Cache.log.debug(
321                       "Ignoring bad discovery service URL "
322                               + sh[i].getEndpointURL(), e);
323             }
324           }
325         }
326       }
327     }
328     return seenNewDiscovery;
329   }
330
331   public void discoverServices()
332   {
333     Hashtable sscat = new Hashtable();
334     Vector cat = new Vector();
335     ServiceHandle sh[] = null;
336     int s_url = 0;
337     if (ServiceURLList == null)
338     {
339       jalview.bin.Cache.log
340               .debug("No service endpoints to use for service discovery.");
341       return;
342     }
343     while (s_url < ServiceURLList.size())
344     {
345       if ((sh = getServices((java.net.URL) ServiceURLList.get(s_url))) != null)
346       {
347
348         buildServiceLists(sh, cat, sscat);
349       }
350       else
351       {
352         jalview.bin.Cache.log
353                 .warn("No services at "
354                         + ((java.net.URL) ServiceURLList.get(s_url))
355                         + " - check DISCOVERY_URLS property in .jalview_properties");
356       }
357       s_url++;
358     }
359     // TODO: decide on correct semantics for services list - PropertyChange
360     // provides a way of passing the new object around
361     // so no need to access original discovery thread.
362     // Curent decision is to change properties then notify listeners with old
363     // and new values.
364     Hashtable oldServices = services;
365     // Vector oldServicelist = serviceList;
366     services = sscat;
367     serviceList = cat;
368     changeSupport.firePropertyChange("services", oldServices, services);
369   }
370
371   /**
372    * creates a new thread to call discoverServices()
373    */
374   public void run()
375   {
376     final Discoverer discoverer = this;
377     Thread discoverThread = new Thread()
378     {
379       public void run()
380       {
381         discoverer.doDiscovery();
382         discoverer.discoverServices();
383       }
384     };
385     discoverThread.start();
386   }
387
388   /**
389    * binding service abstract name to handler class
390    */
391   private static Hashtable serviceClientBindings;
392
393   public static WS1Client getServiceClient(ServiceHandle sh)
394   {
395     if (serviceClientBindings == null)
396     {
397       // get a list from Config or create below
398       serviceClientBindings = new Hashtable();
399       serviceClientBindings.put("MsaWS", new MsaWSClient());
400       serviceClientBindings.put("SecStrPred", new JPredClient());
401       serviceClientBindings.put("SeqSearch", new SeqSearchWSClient());
402     }
403     WS1Client instance = (WS1Client) serviceClientBindings.get(sh
404             .getAbstractName());
405     if (instance == null)
406     {
407       System.err
408               .println("WARNING - POSSIBLE IMPLEMENTATION ERROR - cannot find WSClient implementation for "
409                       + sh.getAbstractName());
410     }
411     else
412     {
413       instance.serviceHandle = sh;
414     }
415     return instance;
416   }
417   /**
418    * notes on discovery service 1. need to allow multiple discovery source urls.
419    * 2. user interface to add/control list of urls in preferences notes on
420    * wsclient discovery 1. need a classpath property with list of additional
421    * plugin directories 2. optional config to cite specific bindings between
422    * class name and Abstract service name. 3. precedence for automatic discovery
423    * by using getAbstractName for WSClient - user added plugins override default
424    * plugins ? notes on wsclient gui code for gui attachment now moved to
425    * wsclient implementation. Needs more abstraction but approach seems to work.
426    * is it possible to 'generalise' the data retrieval calls further ? current
427    * methods are very specific (gatherForMSA or gatherForSeqOrMsaSecStrPred),
428    * new methods for conservation (group or alignment), treecalc (aligned
429    * profile), seqannot (sequences selected from dataset, annotation back to
430    * dataset).
431    * 
432    */
433 }