001package org.hl7.fhir.r4.utils;
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
032import java.io.FileNotFoundException;
033import java.io.IOException;
034import java.util.HashMap;
035import java.util.Map;
036
037import javax.xml.parsers.DocumentBuilder;
038import javax.xml.parsers.DocumentBuilderFactory;
039import javax.xml.parsers.ParserConfigurationException;
040
041import org.hl7.fhir.utilities.MarkedToMoveToAdjunctPackage;
042import org.hl7.fhir.utilities.filesystem.CSFileInputStream;
043import org.hl7.fhir.utilities.xml.XMLUtil;
044import org.w3c.dom.Document;
045import org.w3c.dom.Element;
046import org.xml.sax.SAXException;
047
048@MarkedToMoveToAdjunctPackage
049public class Translations {
050
051  private String[] lang;
052  private Map<String, Element> messages = new HashMap<String, Element>();
053
054  /**
055   * Set a default language to use
056   * 
057   * @param lang
058   */
059  public void setLang(String lang) {
060    this.lang = lang.split("[.;]");
061  }
062
063  /**
064   * Load from the XML translations file maintained by the FHIR project
065   * 
066   * @param filename
067   * @throws IOException
068   * @throws SAXException
069   * @throws FileNotFoundException
070   * @throws ParserConfigurationException
071   * @throws Exception
072   */
073  public void load(String filename)
074      throws FileNotFoundException, SAXException, IOException, ParserConfigurationException {
075    DocumentBuilderFactory factory = XMLUtil.newXXEProtectedDocumentBuilderFactory();
076    DocumentBuilder builder = factory.newDocumentBuilder();
077    loadMessages(builder.parse(new CSFileInputStream(filename)));
078  }
079
080  private void loadMessages(Document doc) {
081    // TODO Auto-generated method stub
082    Element element = XMLUtil.getFirstChild(doc.getDocumentElement());
083    while (element != null) {
084      messages.put(element.getAttribute("id"), element);
085      element = XMLUtil.getNextSibling(element);
086    }
087  }
088
089  public boolean hasTranslation(String id) {
090    return messages.containsKey(id);
091  }
092
093  /**
094   * use configured language
095   * 
096   * @param id         - the id of the message to retrieve
097   * @param defaultMsg - string to use if the message is not defined or a language
098   *                   match is not found (if null, then will default to english)
099   * @return the message
100   */
101  public String getMessage(String id, String defaultMsg) {
102    return getMessage(id, lang, defaultMsg);
103  }
104
105  /**
106   * return the message in a specified language
107   * 
108   * @param id         - the id of the message to retrieve
109   * @param lang       - a language string from a browser
110   * @param defaultMsg - string to use if the message is not defined or a language
111   *                   match is not found (if null, then will default to the
112   *                   english message)
113   * @return the message
114   */
115  public String getMessage(String id, String lang, String defaultMsg) {
116    return getMessage(id, lang.split("[.;]"), defaultMsg);
117  }
118
119  private String getMessage(String id, String[] lang, String defaultMsg) {
120    Element msg = messages.get(id);
121    if (msg == null)
122      return defaultMsg;
123    for (String l : lang) {
124      String res = getByLang(msg, l);
125      if (res != null)
126        return res;
127    }
128    if (defaultMsg == null) {
129      String res = getByLang(msg, "en");
130      if (res != null)
131        return res;
132    }
133    return defaultMsg;
134  }
135
136  private String getByLang(Element msg, String lang) {
137    Element c = XMLUtil.getFirstChild(msg);
138    while (c != null) {
139      if (c.getAttribute("lang").equals(lang))
140        return c.getTextContent();
141      c = XMLUtil.getNextSibling(c);
142    }
143    return null;
144  }
145
146  // http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes
147  public String getLangDesc(String s) {
148    if (s.equals("en"))
149      return "English";
150    if (s.equals("nl"))
151      return "Nederlands (Dutch)";
152    if (s.equals("de"))
153      return "Deutsch (German)";
154    if (s.equals("ru"))
155      return "\u0440\u0443\u0301\u0441\u0441\u043a\u0438\u0439 (Russian)";
156    return "\"" + s + "\"";
157  }
158
159}