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