| /** |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| |
| package org.apache.oozie.util; |
| |
| import java.io.ByteArrayInputStream; |
| import java.io.IOException; |
| import java.io.InputStream; |
| import java.io.StringReader; |
| import java.io.StringWriter; |
| import java.nio.charset.StandardCharsets; |
| import java.text.CharacterIterator; |
| import java.text.StringCharacterIterator; |
| import java.util.Enumeration; |
| import java.util.Iterator; |
| import java.util.List; |
| import java.util.Map; |
| import java.util.Objects; |
| import java.util.Properties; |
| |
| import javax.xml.parsers.DocumentBuilder; |
| import javax.xml.parsers.DocumentBuilderFactory; |
| import javax.xml.parsers.ParserConfigurationException; |
| import javax.xml.transform.Result; |
| import javax.xml.transform.Source; |
| import javax.xml.transform.Transformer; |
| import javax.xml.transform.TransformerFactory; |
| import javax.xml.transform.dom.DOMSource; |
| import javax.xml.transform.stream.StreamResult; |
| import javax.xml.transform.stream.StreamSource; |
| import javax.xml.validation.Schema; |
| import javax.xml.validation.Validator; |
| |
| import org.apache.hadoop.conf.Configuration; |
| import org.apache.oozie.service.SchemaService; |
| import org.apache.oozie.service.SchemaService.SchemaName; |
| import org.apache.oozie.service.Services; |
| import org.jdom.Comment; |
| import org.jdom.Document; |
| import org.jdom.Element; |
| import org.jdom.JDOMException; |
| import org.jdom.Namespace; |
| import org.jdom.input.SAXBuilder; |
| import org.jdom.output.Format; |
| import org.jdom.output.XMLOutputter; |
| import org.xml.sax.SAXException; |
| |
| /** |
| * XML utility methods. |
| */ |
| public class XmlUtils { |
| |
| private static SAXBuilder createSAXBuilder() { |
| SAXBuilder saxBuilder = new SAXBuilder(); |
| saxBuilder.setFeature("http://apache.org/xml/features/disallow-doctype-decl",true); |
| saxBuilder.setFeature("http://xml.org/sax/features/external-general-entities", false); |
| saxBuilder.setFeature("http://xml.org/sax/features/external-parameter-entities", false); |
| saxBuilder.setFeature("http://apache.org/xml/features/nonvalidating/load-external-dtd", false); |
| return saxBuilder; |
| } |
| |
| /** |
| * Remove comments from any Xml String. |
| * |
| * @param xmlStr XML string to remove comments. |
| * @return String after removing comments. |
| * @throws JDOMException thrown if an error happend while XML parsing. |
| */ |
| public static String removeComments(String xmlStr) throws JDOMException { |
| if (xmlStr == null) { |
| return null; |
| } |
| try { |
| SAXBuilder saxBuilder = createSAXBuilder(); |
| Document document = saxBuilder.build(new StringReader(xmlStr)); |
| removeComments(document); |
| return prettyPrint(document.getRootElement()).toString(); |
| } |
| catch (IOException ex) { |
| throw new RuntimeException("Xml parsing failed " + ex.getMessage(), ex); |
| } |
| } |
| |
| private static void removeComments(List l) { |
| for (Iterator i = l.iterator(); i.hasNext();) { |
| Object node = i.next(); |
| if (node instanceof Comment) { |
| i.remove(); |
| } |
| else { |
| if (node instanceof Element) { |
| removeComments(((Element) node).getContent()); |
| } |
| } |
| } |
| } |
| |
| private static void removeComments(Document doc) { |
| removeComments(doc.getContent()); |
| } |
| |
| /** |
| * Parse a string assuming it is a valid XML document and return an JDOM Element for it. |
| * |
| * @param xmlStr XML string to parse. |
| * @return JDOM element for the parsed XML string. |
| * @throws JDOMException thrown if an error happend while XML parsing. |
| */ |
| public static Element parseXml(String xmlStr) throws JDOMException { |
| Objects.requireNonNull(xmlStr, "xmlStr cannot be null"); |
| try { |
| SAXBuilder saxBuilder = createSAXBuilder(); |
| Document document = saxBuilder.build(new StringReader(xmlStr)); |
| return document.getRootElement(); |
| } |
| catch (IOException ex) { |
| throw new RuntimeException("Xml parsing failed, " + ex.getMessage(), ex); |
| } |
| } |
| |
| /** |
| * Parse a inputstream assuming it is a valid XML document and return an JDOM Element for it. |
| * |
| * @param is inputstream to parse. |
| * @return JDOM element for the parsed XML string. |
| * @throws JDOMException thrown if an error happend while XML parsing. |
| * @throws IOException thrown if an IO error occurred. |
| */ |
| public static Element parseXml(InputStream is) throws JDOMException, IOException { |
| Objects.requireNonNull(is, "is cannot be null"); |
| SAXBuilder saxBuilder = createSAXBuilder(); |
| Document document = saxBuilder.build(is); |
| return document.getRootElement(); |
| } |
| |
| /** |
| * //TODO move this to action registry method Return the value of an attribute from the root element of an XML |
| * document. |
| * |
| * @param filePath path of the XML document. |
| * @param attributeName attribute to retrieve value for. |
| * @return value of the specified attribute. |
| */ |
| public static String getRootAttribute(String filePath, String attributeName) { |
| Objects.requireNonNull(filePath, "filePath cannot be null"); |
| Objects.requireNonNull(attributeName, "attributeName cannot be null"); |
| SAXBuilder saxBuilder = createSAXBuilder(); |
| try { |
| Document doc = saxBuilder.build(Thread.currentThread().getContextClassLoader().getResourceAsStream(filePath)); |
| return doc.getRootElement().getAttributeValue(attributeName); |
| } |
| catch (JDOMException | IOException e) { |
| throw new RuntimeException(); |
| } |
| } |
| |
| /** |
| * Pretty print string representation of an XML document that generates the pretty print on lazy mode when the |
| * {@link #toString} method is invoked. |
| */ |
| public static class PrettyPrint { |
| private String str; |
| private Element element; |
| |
| private PrettyPrint(String str) { |
| this.str = str; |
| } |
| |
| private PrettyPrint(Element element) { |
| this.element = Objects.requireNonNull(element, "element cannot be null"); |
| } |
| |
| /** |
| * Return the pretty print representation of an XML document. |
| * |
| * @return the pretty print representation of an XML document. |
| */ |
| @Override |
| public String toString() { |
| if (str != null) { |
| return str; |
| } |
| else { |
| XMLOutputter outputter = new XMLOutputter(); |
| StringWriter stringWriter = new StringWriter(); |
| outputter.setFormat(Format.getPrettyFormat()); |
| try { |
| outputter.output(element, stringWriter); |
| } |
| catch (Exception ex) { |
| throw new RuntimeException(ex); |
| } |
| return stringWriter.toString(); |
| } |
| } |
| } |
| |
| /** |
| * Return a pretty print string for a JDOM Element. |
| * |
| * @param element JDOM element. |
| * @return pretty print of the given JDOM Element. |
| */ |
| public static PrettyPrint prettyPrint(Element element) { |
| return new PrettyPrint(element); |
| } |
| |
| /** |
| * Return a pretty print string for a XML string. If the given string is not valid XML it returns the original |
| * string. |
| * |
| * @param xmlStr XML string. |
| * @return prettyprint of the given XML string or the original string if the given string is not valid XML. |
| */ |
| public static PrettyPrint prettyPrint(String xmlStr) { |
| try { |
| return new PrettyPrint(parseXml(xmlStr)); |
| } |
| catch (Exception e) { |
| return new PrettyPrint(xmlStr); |
| } |
| } |
| |
| /** |
| * Return a pretty print string for a Configuration object. |
| * |
| * @param conf Configuration object. |
| * @return prettyprint of the given Configuration object. |
| */ |
| public static PrettyPrint prettyPrint(Configuration conf) { |
| Element root = new Element("configuration"); |
| for (Map.Entry<String, String> entry : conf) { |
| Element property = new Element("property"); |
| Element name = new Element("name"); |
| name.setText(entry.getKey()); |
| Element value = new Element("value"); |
| value.setText(entry.getValue()); |
| property.addContent(name); |
| property.addContent(value); |
| root.addContent(property); |
| } |
| return new PrettyPrint(root); |
| } |
| |
| /** |
| * Schema validation for a given xml. <p> |
| * |
| * @param schema for validation |
| * @param xml to be validated |
| * @throws SAXException in case of validation error |
| * @throws IOException in case of IO error |
| */ |
| public static void validateXml(Schema schema, String xml) throws SAXException, IOException { |
| Validator validator = SchemaService.getValidator(schema); |
| validator.validate(new StreamSource(new ByteArrayInputStream(xml.getBytes(StandardCharsets.UTF_8)))); |
| } |
| |
| public static void validateData(String xmlData, SchemaName xsdFile) throws SAXException, IOException { |
| if (xmlData == null || xmlData.length() == 0) { |
| return; |
| } |
| javax.xml.validation.Schema schema = Services.get().get(SchemaService.class).getSchema(xsdFile); |
| validateXml(schema, xmlData); |
| } |
| |
| /** |
| * Convert Properties to string |
| * |
| * @param props the properties to convert |
| * @return xml string |
| * @throws IOException if there is an error during conversion |
| */ |
| public static String writePropToString(Properties props) throws IOException { |
| try { |
| org.w3c.dom.Document doc = getDocumentBuilder().newDocument(); |
| org.w3c.dom.Element conf = doc.createElement("configuration"); |
| doc.appendChild(conf); |
| conf.appendChild(doc.createTextNode("\n")); |
| for (Enumeration e = props.keys(); e.hasMoreElements();) { |
| String name = (String) e.nextElement(); |
| Object object = props.get(name); |
| String value; |
| if (object instanceof String) { |
| value = (String) object; |
| } |
| else { |
| continue; |
| } |
| org.w3c.dom.Element propNode = doc.createElement("property"); |
| conf.appendChild(propNode); |
| |
| org.w3c.dom.Element nameNode = doc.createElement("name"); |
| nameNode.appendChild(doc.createTextNode(name.trim())); |
| propNode.appendChild(nameNode); |
| |
| org.w3c.dom.Element valueNode = doc.createElement("value"); |
| valueNode.appendChild(doc.createTextNode(value.trim())); |
| propNode.appendChild(valueNode); |
| |
| conf.appendChild(doc.createTextNode("\n")); |
| } |
| |
| Source source = new DOMSource(doc); |
| StringWriter stringWriter = new StringWriter(); |
| Result result = new StreamResult(stringWriter); |
| TransformerFactory factory = TransformerFactory.newInstance(); |
| factory.setFeature("http://javax.xml.XMLConstants/feature/secure-processing", true); |
| Transformer transformer = factory.newTransformer(); |
| transformer.transform(source, result); |
| |
| return stringWriter.getBuffer().toString(); |
| } |
| catch (Exception e) { |
| throw new IOException(e); |
| } |
| } |
| |
| /** |
| * Returns a DocumentBuilder |
| * @return DocumentBuilder |
| * @throws ParserConfigurationException |
| */ |
| private static DocumentBuilder getDocumentBuilder() throws ParserConfigurationException { |
| DocumentBuilderFactory docBuilderFactory = DocumentBuilderFactory.newInstance(); |
| docBuilderFactory.setNamespaceAware(true); |
| docBuilderFactory.setXIncludeAware(false); |
| docBuilderFactory.setExpandEntityReferences(false); |
| docBuilderFactory.setFeature("http://apache.org/xml/features/disallow-doctype-decl",true); |
| //Redundant with disallow-doctype, but just in case |
| docBuilderFactory.setFeature("http://xml.org/sax/features/external-general-entities", false); |
| docBuilderFactory.setFeature("http://xml.org/sax/features/external-parameter-entities", false); |
| docBuilderFactory.setFeature("http://apache.org/xml/features/nonvalidating/load-external-dtd", false); |
| // ignore all comments inside the xml file |
| docBuilderFactory.setIgnoringComments(true); |
| return docBuilderFactory.newDocumentBuilder(); |
| } |
| |
| /** |
| * Escape characters for text appearing as XML data, between tags. |
| * <p> |
| * The following characters are replaced with corresponding character entities : |
| * '<' to '<' |
| * '>' to '>' |
| * '&' to '&' |
| * '"' to '"' |
| * "'" to "'" |
| * <p> |
| * Note that JSTL's {@code <c:out>} escapes the exact same set of characters as this method. |
| * |
| * @param aText the text to escape |
| * @return the escaped text |
| */ |
| public static String escapeCharsForXML(String aText) { |
| final StringBuilder result = new StringBuilder(); |
| final StringCharacterIterator iterator = new StringCharacterIterator(aText); |
| char character = iterator.current(); |
| while (character != CharacterIterator.DONE) { |
| if (character == '<') { |
| result.append("<"); |
| } |
| else if (character == '>') { |
| result.append(">"); |
| } |
| else if (character == '\"') { |
| result.append("""); |
| } |
| else if (character == '\'') { |
| result.append("'"); |
| } |
| else if (character == '&') { |
| result.append("&"); |
| } |
| else { |
| // the char is not a special one |
| // add it to the result as is |
| result.append(character); |
| } |
| character = iterator.next(); |
| } |
| return result.toString(); |
| } |
| |
| public static Element getSLAElement(Element elem) { |
| Element eSla_1 = elem.getChild("info", Namespace.getNamespace(SchemaService.SLA_NAME_SPACE_URI)); |
| Element eSla_2 = elem.getChild("info", Namespace.getNamespace(SchemaService.SLA_NAMESPACE_URI_2)); |
| |
| return (eSla_2 != null) ? eSla_2 : eSla_1; |
| } |
| |
| } |