001package org.hl7.fhir.r4.terminologies;
002
003/*
004  Copyright (c) 2011+, HL7, Inc.
005  All rights reserved.
006  
007  Redistribution and use in source and binary forms, with or without modification, 
008  are permitted provided that the following conditions are met:
009    
010   * Redistributions of source code must retain the above copyright notice, this 
011     list of conditions and the following disclaimer.
012   * Redistributions in binary form must reproduce the above copyright notice, 
013     this list of conditions and the following disclaimer in the documentation 
014     and/or other materials provided with the distribution.
015   * Neither the name of HL7 nor the names of its contributors may be used to 
016     endorse or promote products derived from this software without specific 
017     prior written permission.
018  
019  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
020  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
021  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
022  IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
023  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
024  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
025  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
026  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
027  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
028  POSSIBILITY OF SUCH DAMAGE.
029  
030 */
031
032
033
034/*
035Copyright (c) 2011+, HL7, Inc
036All rights reserved.
037
038Redistribution and use in source and binary forms, with or without modification, 
039are permitted provided that the following conditions are met:
040
041 * Redistributions of source code must retain the above copyright notice, this 
042   list of conditions and the following disclaimer.
043 * Redistributions in binary form must reproduce the above copyright notice, 
044   this list of conditions and the following disclaimer in the documentation 
045   and/or other materials provided with the distribution.
046 * Neither the name of HL7 nor the names of its contributors may be used to 
047   endorse or promote products derived from this software without specific 
048   prior written permission.
049
050THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
051ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
052WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
053IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
054INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
055NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
056PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
057WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
058ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
059POSSIBILITY OF SUCH DAMAGE.
060
061*/
062
063import java.io.File;
064import java.io.FileInputStream;
065import java.io.FileOutputStream;
066import java.io.IOException;
067import java.util.HashMap;
068import java.util.Map;
069
070import org.apache.commons.io.IOUtils;
071import org.hl7.fhir.exceptions.FHIRFormatError;
072import org.hl7.fhir.r4.context.IWorkerContext;
073import org.hl7.fhir.r4.formats.IParser.OutputStyle;
074import org.hl7.fhir.r4.formats.JsonParser;
075import org.hl7.fhir.r4.model.MetadataResource;
076import org.hl7.fhir.r4.model.OperationOutcome;
077import org.hl7.fhir.r4.model.Parameters;
078import org.hl7.fhir.r4.model.Resource;
079import org.hl7.fhir.r4.model.ValueSet;
080import org.hl7.fhir.r4.terminologies.ValueSetExpander.TerminologyServiceErrorClass;
081import org.hl7.fhir.r4.terminologies.ValueSetExpander.ValueSetExpansionOutcome;
082import org.hl7.fhir.r4.utils.ToolingExtensions;
083import org.hl7.fhir.utilities.Utilities;
084import org.hl7.fhir.utilities.xhtml.XhtmlComposer;
085
086public class ValueSetExpansionCache implements ValueSetExpanderFactory {
087
088  public class CacheAwareExpander implements ValueSetExpander {
089
090          @Override
091          public ValueSetExpansionOutcome expand(ValueSet source, Parameters expParams) throws ETooCostly, IOException {
092            String cacheKey = makeCacheKey(source, expParams);
093                if (expansions.containsKey(cacheKey))
094                        return expansions.get(cacheKey);
095                ValueSetExpander vse = new ValueSetExpanderSimple(context);
096                ValueSetExpansionOutcome vso = vse.expand(source, expParams);
097                if (vso.getError() != null) {
098                  // well, we'll see if the designated server can expand it, and if it can, we'll cache it locally
099                        vso = context.expandVS(source, false, expParams == null || !expParams.getParameterBool("excludeNested"));
100                        if (cacheFolder != null) {
101                          FileOutputStream s = new FileOutputStream(Utilities.path(cacheFolder, makeFileName(source.getUrl())));
102                          context.newXmlParser().setOutputStyle(OutputStyle.PRETTY).compose(s, vso.getValueset());
103                          s.close();
104                        }
105                }
106                if (vso.getValueset() != null)
107                  expansions.put(cacheKey, vso);
108                return vso;
109          }
110
111    private String makeCacheKey(ValueSet source, Parameters expParams) throws IOException {
112      if (expParams == null)
113        return source.getUrl();
114      JsonParser p = new JsonParser();
115      String r = p.composeString(expParams);
116      return source.getUrl() + " " + r.hashCode(); 
117    }
118
119  }
120
121  private static final String VS_ID_EXT = "http://tools/cache";
122
123  private final Map<String, ValueSetExpansionOutcome> expansions = new HashMap<String, ValueSetExpansionOutcome>();
124  private final Map<String, MetadataResource> canonicals = new HashMap<String, MetadataResource>();
125  private final IWorkerContext context;
126  private final String cacheFolder;
127
128  private Object lock;
129        
130        public ValueSetExpansionCache(IWorkerContext context, Object lock) {
131    super();
132    cacheFolder = null;
133    this.lock = lock;
134    this.context = context;
135  }
136  
137        public ValueSetExpansionCache(IWorkerContext context, String cacheFolder, Object lock) throws FHIRFormatError, IOException {
138    super();
139    this.context = context;
140    this.cacheFolder = cacheFolder;
141    this.lock = lock;
142    if (this.cacheFolder != null)
143      loadCache();
144  }
145  
146  private String makeFileName(String url) {
147    return url.replace("$", "").replace(":", "").replace("|", ".").replace("//", "/").replace("/", "_")+".xml";
148  }
149  
150  private void loadCache() throws FHIRFormatError, IOException {
151    File[] files = new File(cacheFolder).listFiles();
152    for (File f : files) {
153      if (f.getName().endsWith(".xml")) {
154        final FileInputStream is = new FileInputStream(f);
155        try {      
156          Resource r = context.newXmlParser().setOutputStyle(OutputStyle.PRETTY).parse(is);
157          if (r instanceof OperationOutcome) {
158            OperationOutcome oo = (OperationOutcome) r;
159            expansions.put(ToolingExtensions.getExtension(oo,VS_ID_EXT).getValue().toString(),
160                new ValueSetExpansionOutcome(new XhtmlComposer(XhtmlComposer.XML, false).composePlainText(oo.getText().getDiv()), TerminologyServiceErrorClass.UNKNOWN));
161          } else if (r instanceof ValueSet) {
162            ValueSet vs = (ValueSet) r;
163            if (vs.hasExpansion())
164              expansions.put(vs.getUrl(), new ValueSetExpansionOutcome(vs));
165            else {
166              canonicals.put(vs.getUrl(), vs);
167              if (vs.hasVersion())
168                canonicals.put(vs.getUrl()+"|"+vs.getVersion(), vs);
169            }
170          } else if (r instanceof MetadataResource) {
171            MetadataResource md = (MetadataResource) r;
172            canonicals.put(md.getUrl(), md);
173            if (md.hasVersion())
174              canonicals.put(md.getUrl()+"|"+md.getVersion(), md);
175          }
176        } finally {
177          IOUtils.closeQuietly(is);
178        }
179      }
180    }
181  }
182
183  @Override
184        public ValueSetExpander getExpander() {
185                return new CacheAwareExpander();
186                // return new ValueSetExpander(valuesets, codesystems);
187        }
188
189  public MetadataResource getStoredResource(String canonicalUri) {
190    synchronized (lock) {
191    return canonicals.get(canonicalUri);
192    }
193  }
194
195  public void storeResource(MetadataResource md) throws IOException {
196    synchronized (lock) {
197      canonicals.put(md.getUrl(), md);
198      if (md.hasVersion())
199        canonicals.put(md.getUrl()+"|"+md.getVersion(), md);    
200    }
201    if (cacheFolder != null) {
202      FileOutputStream s = new FileOutputStream(Utilities.path(cacheFolder, makeFileName(md.getUrl()+"|"+md.getVersion())));
203      context.newXmlParser().setOutputStyle(OutputStyle.PRETTY).compose(s, md);
204      s.close();
205    }
206  }
207
208
209}