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   private static final String WS_PARAM_FILES = "WS_PARAM_FILES";
  51   Hashtable<String, ParamDatastoreI> paramparsers = new Hashtable<>();
  52
  53   @Override
  54   public WsParamSetI[] getParameterSet(String name, String serviceUrl,
  55           boolean modifiable, boolean unmodifiable)
  56   {
  57     String files = Cache.getProperty(WS_PARAM_FILES);
  58     if (files == null)
  59     {
  60       return null;
  61     }
  62     StringTokenizer st = new StringTokenizer(files, "|");
  63     String pfile = null;
  64     ArrayList<WsParamSetI> params = new ArrayList<>();
  65     while (st.hasMoreTokens())
  66     {
  67       pfile = st.nextToken();
  68       try
  69       {
  70         WsParamSetI[] pset = parseParamFile(pfile);
  71         for (WsParamSetI p : pset)
  72         {
  73           boolean add = false;
  74           if (serviceUrl != null)
  75           {
  76             for (String url : p.getApplicableUrls())
  77             {
  78               if (url.equals(serviceUrl))
  79               {
  80                 add = true;
  81               }
  82             }
  83           }
  84           else
  85           {
  86             add = true;
  87           }
  88           add &= (modifiable == p.isModifiable()
  89                   || unmodifiable == !p.isModifiable());
  90           add &= name == null || p.getName().equals(name);
  91
  92           if (add)
  93           {
  94
  95             params.add(p);
  96           }
  97
  98         }
  99       } catch (IOException e)
 100       {
 101         Cache.log.info("Failed to parse parameter file " + pfile
 102                 + " (Check that all " + WS_PARAM_FILES
 103                 + " 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<>();
 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(MessageManager.getString(
 181               "error.implementation_error_cannot_find_marshaller_for_param_set"));
 182     }
 183     if (filename == null)
 184     {
 185       JalviewFileChooser chooser = new JalviewFileChooser("wsparams",
 186               "Web Service Parameter File");
 187       chooser.setFileView(new JalviewFileView());
 188       chooser.setDialogTitle(MessageManager
 189               .getString("label.choose_filename_for_param_file"));
 190       chooser.setToolTipText(MessageManager.getString("action.save"));
 191       int value = chooser.showSaveDialog(Desktop.instance);
 192       if (value == JalviewFileChooser.APPROVE_OPTION)
 193       {
 194         outfile = chooser.getSelectedFile();
 195         jalview.bin.Cache.setProperty("LAST_DIRECTORY",
 196                 outfile.getParent());
 197         filename = outfile.getAbsolutePath();
 198         if (!filename.endsWith(".wsparams"))
 199         {
 200           filename = filename.concat(".wsparams");
 201           outfile = new File(filename);
 202         }
 203       }
 204     }
 205     if (outfile != null)
 206     {
 207       String paramFiles = jalview.bin.Cache.getDefault(WS_PARAM_FILES,
 208               filename);
 209       if (paramFiles.indexOf(filename) == -1)
 210       {
 211         if (paramFiles.length() > 0)
 212         {
 213           paramFiles = paramFiles.concat("|");
 214         }
 215         paramFiles = paramFiles.concat(filename);
 216       }
 217       jalview.bin.Cache.setProperty(WS_PARAM_FILES, paramFiles);
 218
 219       jalview.schemabinding.version2.WebServiceParameterSet paramxml = new jalview.schemabinding.version2.WebServiceParameterSet();
 220
 221       paramxml.setName(parameterSet.getName());
 222       paramxml.setDescription(parameterSet.getDescription());
 223       paramxml.setServiceURL(parameterSet.getApplicableUrls().clone());
 224       paramxml.setVersion("1.0");
 225       try
 226       {
 227         paramxml.setParameters(
 228                 parser.generateServiceParameterFile(parameterSet));
 229         PrintWriter out = new PrintWriter(new OutputStreamWriter(
 230                 new FileOutputStream(outfile), "UTF-8"));
 231         paramxml.marshal(out);
 232         out.close();
 233         parameterSet.setSourceFile(filename);
 234       } catch (Exception e)
 235       {
 236         Cache.log.error("Couldn't write parameter file to " + outfile, e);
 237       }
 238     }
 239   }
 240
 241   /*
 242    *
 243    * JalviewFileChooser chooser = new JalviewFileChooser(jalview.bin.Cache
 244    * .getProperty("LAST_DIRECTORY"), new String[] { "jc" }, new String[] {
 245    * "Jalview User Colours" }, "Jalview User Colours"); chooser.setFileView(new
 246    * jalview.io.JalviewFileView());
 247    * chooser.setDialogTitle("Load colour scheme");
 248    * chooser.setToolTipText("Load");
 249    *
 250    * int value = chooser.showOpenDialog(this);
 251    *
 252    * if (value == JalviewFileChooser.APPROVE_OPTION) { File choice =
 253    * chooser.getSelectedFile(); jalview.bin.Cache.setProperty("LAST_DIRECTORY",
 254    * choice.getParent()); String defaultColours = jalview.bin.Cache.getDefault(
 255    * "USER_DEFINED_COLOURS", choice.getPath()); if
 256    * (defaultColours.indexOf(choice.getPath()) == -1) { defaultColours =
 257    * defaultColours.concat("|") .concat(choice.getPath()); } (non-Javadoc)
 258    *
 259    * @see
 260    * jalview.ws.params.ParamManager#deleteParameterSet(jalview.ws.params.WsParamSetI
 261    * )
 262    */
 263   @Override
 264   public void deleteParameterSet(WsParamSetI parameterSet)
 265   {
 266     String filename = parameterSet.getSourceFile();
 267     if (filename == null || filename.trim().length() < 1)
 268     {
 269       return;
 270     }
 271     String paramFiles = jalview.bin.Cache.getDefault(WS_PARAM_FILES, "");
 272     if (paramFiles.indexOf(filename) > -1)
 273     {
 274       String nparamFiles = new String();
 275       StringTokenizer st = new StringTokenizer(paramFiles, "|");
 276       while (st.hasMoreElements())
 277       {
 278         String fl = st.nextToken();
 279         if (!fl.equals(filename))
 280         {
 281           nparamFiles = nparamFiles.concat("|").concat(fl);
 282         }
 283       }
 284       jalview.bin.Cache.setProperty(WS_PARAM_FILES, nparamFiles);
 285     }
 286
 287     try
 288     {
 289       File pfile = new File(filename);
 290       if (pfile.exists() && pfile.canWrite())
 291       {
 292         if (JvOptionPane.showConfirmDialog(Desktop.instance,
 293                 "Delete the preset's file, too ?", "Delete User Preset ?",
 294                 JvOptionPane.OK_CANCEL_OPTION) == JvOptionPane.OK_OPTION)
 295         {
 296           pfile.delete();
 297         }
 298       }
 299     } catch (Exception e)
 300     {
 301       Cache.log.error(
 302               "Exception when trying to delete webservice user preset: ",
 303               e);
 304     }
 305   }
 306
 307   @Override
 308   public void registerParser(String hosturl, ParamDatastoreI paramdataStore)
 309   {
 310     paramparsers.put(hosturl, paramdataStore);
 311   }
 312
 313 }