JAL-2416 allow space in score matrix name
[jalview.git] / src / jalview / gui / WsParamSetManager.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.gui;
22
23 import jalview.bin.Cache;
24 import jalview.io.JalviewFileChooser;
25 import jalview.io.JalviewFileView;
26 import jalview.util.MessageManager;
27 import jalview.ws.params.ParamDatastoreI;
28 import jalview.ws.params.ParamManager;
29 import jalview.ws.params.WsParamSetI;
30
31 import java.io.File;
32 import java.io.FileOutputStream;
33 import java.io.IOException;
34 import java.io.InputStreamReader;
35 import java.io.OutputStreamWriter;
36 import java.io.PrintWriter;
37 import java.util.ArrayList;
38 import java.util.Hashtable;
39 import java.util.List;
40 import java.util.StringTokenizer;
41
42 /**
43  * store and retrieve web service parameter sets.
44  * 
45  * @author JimP
46  * 
47  */
48 public class WsParamSetManager implements ParamManager
49 {
50   Hashtable<String, ParamDatastoreI> paramparsers = new Hashtable<String, ParamDatastoreI>();
51
52   @Override
53   public WsParamSetI[] getParameterSet(String name, String serviceUrl,
54           boolean modifiable, boolean unmodifiable)
55   {
56     String files = Cache.getProperty("WS_PARAM_FILES");
57     if (files == null)
58     {
59       return null;
60     }
61     StringTokenizer st = new StringTokenizer(files, "|");
62     String pfile = null;
63     ArrayList<WsParamSetI> params = new ArrayList<WsParamSetI>();
64     while (st.hasMoreTokens())
65     {
66       pfile = st.nextToken();
67       try
68       {
69         WsParamSetI[] pset = parseParamFile(pfile);
70         for (WsParamSetI p : pset)
71         {
72           boolean add = false;
73           if (serviceUrl != null)
74           {
75             for (String url : p.getApplicableUrls())
76             {
77               if (url.equals(serviceUrl))
78               {
79                 add = true;
80               }
81             }
82           }
83           else
84           {
85             add = true;
86           }
87           add &= (modifiable == p.isModifiable() || unmodifiable == !p
88                   .isModifiable());
89           add &= name == null || p.getName().equals(name);
90
91           if (add)
92           {
93
94             params.add(p);
95           }
96
97         }
98       } catch (IOException e)
99       {
100         Cache.log
101                 .info("Failed to parse parameter file "
102                         + pfile
103                         + " (Check that all JALVIEW_WSPARAMFILES entries are valid!)",
104                         e);
105       }
106     }
107     return params.toArray(new WsParamSetI[0]);
108   }
109
110   private WsParamSetI[] parseParamFile(String filename) throws IOException
111   {
112     List<WsParamSetI> psets = new ArrayList<WsParamSetI>();
113     InputStreamReader is = new InputStreamReader(
114             new java.io.FileInputStream(new File(filename)), "UTF-8");
115
116     jalview.schemabinding.version2.WebServiceParameterSet wspset = new jalview.schemabinding.version2.WebServiceParameterSet();
117
118     org.exolab.castor.xml.Unmarshaller unmar = new org.exolab.castor.xml.Unmarshaller(
119             wspset);
120     unmar.setWhitespacePreserve(true);
121     try
122     {
123       wspset = (jalview.schemabinding.version2.WebServiceParameterSet) unmar
124               .unmarshal(is);
125     } catch (Exception ex)
126     {
127       throw new IOException(ex);
128     }
129     if (wspset != null && wspset.getParameters().length() > 0)
130     {
131       for (String url : wspset.getServiceURL())
132       {
133         ParamDatastoreI parser = paramparsers.get(url);
134         if (parser != null)
135         {
136           WsParamSetI pset = parser.parseServiceParameterFile(
137                   wspset.getName(), wspset.getDescription(),
138                   wspset.getServiceURL(), wspset.getParameters());
139           if (pset != null)
140           {
141             pset.setSourceFile(filename);
142             psets.add(pset);
143             break;
144           }
145         }
146       }
147     }
148
149     return psets.toArray(new WsParamSetI[0]);
150   }
151
152   @Override
153   public void storeParameterSet(WsParamSetI parameterSet)
154   {
155     String filename = parameterSet.getSourceFile();
156     File outfile = null;
157     try
158     {
159       if (filename != null && !((outfile = new File(filename)).canWrite()))
160       {
161         Cache.log.warn("Can't write to " + filename
162                 + " - Prompting for new file to write to.");
163         filename = null;
164       }
165     } catch (Exception e)
166     {
167       filename = null;
168     }
169
170     ParamDatastoreI parser = null;
171     for (String urls : parameterSet.getApplicableUrls())
172     {
173       if (parser == null)
174       {
175         parser = paramparsers.get(urls);
176       }
177     }
178     if (parser == null)
179     {
180       throw new Error(
181               MessageManager
182                       .getString("error.implementation_error_cannot_find_marshaller_for_param_set"));
183     }
184     if (filename == null)
185     {
186       JalviewFileChooser chooser = new JalviewFileChooser("wsparams",
187               "Web Service Parameter File");
188       chooser.setFileView(new JalviewFileView());
189       chooser.setDialogTitle(MessageManager
190               .getString("label.choose_filename_for_param_file"));
191       chooser.setToolTipText(MessageManager.getString("action.save"));
192       int value = chooser.showSaveDialog(Desktop.instance);
193       if (value == JalviewFileChooser.APPROVE_OPTION)
194       {
195         outfile = chooser.getSelectedFile();
196         jalview.bin.Cache
197                 .setProperty("LAST_DIRECTORY", outfile.getParent());
198         filename = outfile.getAbsolutePath();
199         if (!filename.endsWith(".wsparams"))
200         {
201           filename = filename.concat(".wsparams");
202           outfile = new File(filename);
203         }
204       }
205     }
206     if (outfile != null)
207     {
208       String paramFiles = jalview.bin.Cache.getDefault("WS_PARAM_FILES",
209               filename);
210       if (paramFiles.indexOf(filename) == -1)
211       {
212         if (paramFiles.length() > 0)
213         {
214           paramFiles = paramFiles.concat("|");
215         }
216         paramFiles = paramFiles.concat(filename);
217       }
218       jalview.bin.Cache.setProperty("WS_PARAM_FILES", paramFiles);
219
220       jalview.schemabinding.version2.WebServiceParameterSet paramxml = new jalview.schemabinding.version2.WebServiceParameterSet();
221
222       paramxml.setName(parameterSet.getName());
223       paramxml.setDescription(parameterSet.getDescription());
224       paramxml.setServiceURL(parameterSet.getApplicableUrls().clone());
225       paramxml.setVersion("1.0");
226       try
227       {
228         paramxml.setParameters(parser
229                 .generateServiceParameterFile(parameterSet));
230         PrintWriter out = new PrintWriter(new OutputStreamWriter(
231                 new FileOutputStream(outfile), "UTF-8"));
232         paramxml.marshal(out);
233         out.close();
234         parameterSet.setSourceFile(filename);
235       } catch (Exception e)
236       {
237         Cache.log.error("Couldn't write parameter file to " + outfile, e);
238       }
239     }
240   }
241
242   /*
243    * 
244    * JalviewFileChooser chooser = new JalviewFileChooser(jalview.bin.Cache
245    * .getProperty("LAST_DIRECTORY"), new String[] { "jc" }, new String[] {
246    * "Jalview User Colours" }, "Jalview User Colours"); chooser.setFileView(new
247    * jalview.io.JalviewFileView());
248    * chooser.setDialogTitle("Load colour scheme");
249    * chooser.setToolTipText("Load");
250    * 
251    * int value = chooser.showOpenDialog(this);
252    * 
253    * if (value == JalviewFileChooser.APPROVE_OPTION) { File choice =
254    * chooser.getSelectedFile(); jalview.bin.Cache.setProperty("LAST_DIRECTORY",
255    * choice.getParent()); String defaultColours = jalview.bin.Cache.getDefault(
256    * "USER_DEFINED_COLOURS", choice.getPath()); if
257    * (defaultColours.indexOf(choice.getPath()) == -1) { defaultColours =
258    * defaultColours.concat("|") .concat(choice.getPath()); } (non-Javadoc)
259    * 
260    * @see
261    * jalview.ws.params.ParamManager#deleteParameterSet(jalview.ws.params.WsParamSetI
262    * )
263    */
264   @Override
265   public void deleteParameterSet(WsParamSetI parameterSet)
266   {
267     String filename = parameterSet.getSourceFile();
268     if (filename == null || filename.trim().length() < 1)
269     {
270       return;
271     }
272     String paramFiles = jalview.bin.Cache.getDefault("WS_PARAM_FILES", "");
273     if (paramFiles.indexOf(filename) > -1)
274     {
275       String nparamFiles = new String();
276       StringTokenizer st = new StringTokenizer(paramFiles, "|");
277       while (st.hasMoreElements())
278       {
279         String fl = st.nextToken();
280         if (!fl.equals(filename))
281         {
282           nparamFiles = nparamFiles.concat("|").concat(fl);
283         }
284       }
285       jalview.bin.Cache.setProperty("WS_PARAM_FILES", nparamFiles);
286     }
287
288     try
289     {
290       File pfile = new File(filename);
291       if (pfile.exists() && pfile.canWrite())
292       {
293         if (JvOptionPane.showConfirmDialog(Desktop.instance,
294                 "Delete the preset's file, too ?", "Delete User Preset ?",
295                 JvOptionPane.OK_CANCEL_OPTION) == JvOptionPane.OK_OPTION)
296         {
297           pfile.delete();
298         }
299       }
300     } catch (Exception e)
301     {
302       Cache.log
303               .error("Exception when trying to delete webservice user preset: ",
304                       e);
305     }
306   }
307
308   @Override
309   public void registerParser(String hosturl, ParamDatastoreI paramdataStore)
310   {
311     paramparsers.put(hosturl, paramdataStore);
312   }
313
314 }