All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • org.jooq.util.jaxb.tools.MiniJAXB Maven / Gradle / Ivy

    There is a newer version: 3.19.18
    Show newest version
    /*
 * Licensed 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
 *
 *  https://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.
 *
 * Other licenses:
 * -----------------------------------------------------------------------------
 * Commercial licenses for this work are available. These replace the above
 * Apache-2.0 license and offer limited warranties, support, maintenance, and
 * commercial database integrations.
 *
 * For more information, please visit: https://www.jooq.org/legal/licensing
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 */
package org.jooq.util.jaxb.tools;

import static java.util.Arrays.asList;

import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.io.Reader;
import java.io.StringReader;
import java.io.StringWriter;
import java.io.Writer;
import java.lang.annotation.Annotation;
import java.lang.reflect.Field;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
import java.lang.reflect.ParameterizedType;
import java.net.URL;
import java.nio.charset.Charset;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.IdentityHashMap;
import java.util.List;
import java.util.Map;

import javax.xml.XMLConstants;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.validation.Schema;
import javax.xml.validation.SchemaFactory;

import org.jooq.Constants;
import org.jooq.exception.ConfigurationException;
import org.jooq.tools.Convert;
import org.jooq.tools.JooqLogger;
import org.jooq.tools.reflect.Reflect;
import org.jooq.tools.reflect.ReflectException;

import org.jetbrains.annotations.ApiStatus.Internal;
import org.w3c.dom.Attr;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.ErrorHandler;
import org.xml.sax.InputSource;
import org.xml.sax.SAXException;
import org.xml.sax.SAXParseException;

import jakarta.xml.bind.annotation.XmlElement;
import jakarta.xml.bind.annotation.XmlElementWrapper;
import jakarta.xml.bind.annotation.XmlEnum;
import jakarta.xml.bind.annotation.XmlList;
import jakarta.xml.bind.annotation.XmlRootElement;
import jakarta.xml.bind.annotation.XmlSchema;
import jakarta.xml.bind.annotation.XmlType;
import jakarta.xml.bind.annotation.adapters.XmlAdapter;
import jakarta.xml.bind.annotation.adapters.XmlJavaTypeAdapter;

/**
 * This class allows for mashalling / unmarshalling XML content to jOOQ
 * configuration objects.
 * 
    
 * With jOOQ 3.12, the JAXB dependency has been removed in favour of this home
 * grown solution. Due to the modularisation that happened with JDK 9+ and the
 * removal of JAXB from the JDK 11+, it is unreasonable to leave the burden of
 * properly configuring transitive JAXB dependency to jOOQ users.
 *
 * @author Lukas Eder
 */
@Internal
public final class MiniJAXB {

    private static final JooqLogger log = JooqLogger.getLogger(MiniJAXB.class);
    private static final Map PROVIDED_SCHEMAS;

    static {
        PROVIDED_SCHEMAS = new HashMap<>();
        PROVIDED_SCHEMAS.put(Constants.NS_CODEGEN, Constants.CP_CODEGEN);
        PROVIDED_SCHEMAS.put(Constants.NS_EXPORT,  Constants.CP_EXPORT);
        PROVIDED_SCHEMAS.put(Constants.NS_META,    Constants.CP_META);
        PROVIDED_SCHEMAS.put(Constants.NS_RUNTIME, Constants.CP_RUNTIME);
    }

    public static String marshal(XMLAppendable object) {
        StringWriter writer = new StringWriter();
        marshal(object, writer);
        return writer.toString();
    }

    public static void marshal(XMLAppendable object, OutputStream out) {
        marshal(object, new OutputStreamWriter(out));
    }

    public static void marshal(XMLAppendable object, Writer out) {
        try {
            XMLBuilder builder = XMLBuilder.formatting();
            XmlRootElement e = getAnnotation(object.getClass(), XmlRootElement.class);
            if (e != null) {
                out.write("\n");
                builder.append(e.name(), object);
            }
            else
                builder.append(object);

            builder.appendTo(out);
            out.flush();
        }
        catch (Exception e) {
            throw new ConfigurationException("Cannot print object", e);
        }
    }

    public static  T unmarshal(Reader reader, Class type) {
        return unmarshal0(new InputSource(reader), type);
    }

    public static  T unmarshal(InputStream in, Class type) {
        return unmarshal0(new InputSource(in), type);
    }

    public static  T unmarshal(String xml, Class type) {
        return unmarshal0(new InputSource(new StringReader(xml)), type);
    }

    public static  T unmarshal(File xml, Class type) {
        try {
            return unmarshal0(new InputSource(new FileInputStream(xml)), type);
        }
        catch (Exception e) {
            throw new ConfigurationException("Error while opening file", e);
        }
    }

    private static  T unmarshal0(InputSource in, Class type) {
        try {
            addDefaultNamespace(in, type);
            Document document = builder(type).parse(in);
            T result = Reflect.on(type).create().get();
            unmarshal0(result, document.getDocumentElement(), new IdentityHashMap, Map>());
            return result;
        }
        catch (Exception e) {
            throw new ConfigurationException("Error while reading xml", e);
        }
    }

    private static void addDefaultNamespace(InputSource in, Class type)
        throws IOException {
        String namespace = getNamespace(type);
        if (namespace != null) {
            Reader reader;
            if (in.getCharacterStream() != null)
                reader = in.getCharacterStream();
            else
                reader = new InputStreamReader(in.getByteStream(),
                    in.getEncoding() != null ? in.getEncoding() : Charset.defaultCharset().name());
            StringWriter writer = new StringWriter();
            copyLarge(reader, writer);
            String xml = writer.toString();

            int startIdx = xml.indexOf('<');
            // skip over all processing instructions (like 
            while (startIdx > 0 && xml.length() > startIdx + 1 && xml.charAt(startIdx + 1) == '?')
                startIdx = xml.indexOf('<', startIdx + 1);
            int endIdx = xml.indexOf('>', startIdx);
            if (!xml.substring(startIdx, endIdx).contains("xmlns")) {
                xml = xml.replaceFirst(
                    "<([a-z_]+)\\s*(/?>)",
                    "<$1 xmlns=\"" + namespace + "\"$2");
            }
            in.setCharacterStream(new StringReader(xml));
        }
    }

    private static long copyLarge(Reader reader, Writer writer) throws IOException {
        char[] buffer = new char[1024 * 4];
        long count = 0;
        int n = 0;
        while (-1 != (n = reader.read(buffer))) {
            writer.write(buffer, 0, n);
            count += n;
        }
        return count;
    }

    private static void unmarshal0(Object result, Element element, Map, Map> fieldsByClass) throws Exception {
        if (result == null)
            return;

        Map fieldsByElementName = fieldsByElementName(fieldsByClass, result.getClass());
        NodeList childNodes = element.getChildNodes();

        for (int i = 0; i < childNodes.getLength(); i++) {
            Node item = childNodes.item(i);
            unmarshal1(result, item, fieldsByClass, fieldsByElementName);
        }

        NamedNodeMap attributes = element.getAttributes();

        for (int i = 0; i < attributes.getLength(); i++) {
            Node item = attributes.item(i);
            unmarshal1(result, item, fieldsByClass, fieldsByElementName);
        }
    }

    private static void unmarshal1(Object result, Node item, Map, Map> fieldsByClass, Map fieldsByName) throws Exception {
        Field child = null;
        Element childElement = null;
        String textContent = null;

        if (item.getNodeType() == Node.ELEMENT_NODE) {
            childElement = (Element) item;
            child = fieldsByName.remove(childElement.getTagName());

            if (child == null)
                child = fieldsByName.remove(childElement.getLocalName());

            if (child != null)
                textContent = childElement.getTextContent();
        }
        else if (item.getNodeType() == Node.ATTRIBUTE_NODE) {
            Attr childAttr = (Attr) item;
            child = fieldsByName.remove(childAttr.getName());

            if (child == null)
                child = fieldsByName.remove(childAttr.getLocalName());

            if (child != null)
                textContent = childAttr.getValue();
        }

        // skip unknown elements
        if (child == null)
            return;

        XmlElementWrapper w = child.getAnnotation(XmlElementWrapper.class);
        XmlElement e = child.getAnnotation(XmlElement.class);
        XmlJavaTypeAdapter a = child.getAnnotation(XmlJavaTypeAdapter.class);
        XmlList l = child.getAnnotation(XmlList.class);

        String childName = child.getName();
        Class childType = child.getType();

        if (List.class.isAssignableFrom(childType) && w != null && e != null) {
            if (childElement == null)
                return;

            List list = new ArrayList();
            unmarshalList0(list, childElement, e.name(), (Class) ((ParameterizedType) child.getGenericType()).getActualTypeArguments()[0], fieldsByClass);
            Reflect.on(result).set(childName, list);
        }
        else if (List.class.isAssignableFrom(childType) && l != null) {
            if (childElement == null)
                return;

            List list = new ArrayList(asList(childElement.getTextContent().split(" +")));
            Reflect.on(result).set(childName, Convert.convert(list, (Class) ((ParameterizedType) child.getGenericType()).getActualTypeArguments()[0]));
        }
        else if (getAnnotation(childType, XmlEnum.class) != null) {
            Reflect.on(result).set(childName, Reflect.onClass(childType).call("fromValue", textContent.trim()));
        }
        else if (getAnnotation(childType, XmlType.class) != null) {
            Object object = Reflect.on(childType).create().get();
            Reflect.on(result).set(childName, object);

            unmarshal0(object, childElement, fieldsByClass);
        }
        else if (a != null) {
            @SuppressWarnings("unchecked")
            XmlAdapter adapter = a.value().getDeclaredConstructor().newInstance();
            Reflect.on(result).set(childName, adapter.unmarshal(textContent.trim()));
        }
        else {
            Reflect.on(result).set(childName, Convert.convert(textContent.trim(), childType));
        }
    }

    private static void unmarshalList0(List result, Element element, String name, Class type, Map, Map> fieldsByClass) throws Exception {
        if (result == null)
            return;

        // [#13897] Distinguish between lists of xs:complexType and xs:simpleType
        boolean isComplexType = getAnnotation(type, XmlType.class) != null;
        NodeList list = element.getChildNodes();
        for (int i = 0; i < list.getLength(); i++) {
            Node item = list.item(i);

            if (item.getNodeType() == Node.ELEMENT_NODE) {
                if (name.equals(((Element) item).getTagName()) || name.equals(((Element) item).getLocalName())) {
                    if (isComplexType) {
                        Object o = Reflect.on(type).create().get();
                        unmarshal0(o, (Element) item, fieldsByClass);
                        result.add(o);
                    }
                    else
                        result.add(Convert.convert(item.getTextContent().trim(), type));
                }
            }
        }
    }

    private static Map fieldsByElementName(Map, Map> fieldsByClass, Class type) {
        Map result = fieldsByClass.get(type);

        if (result == null) {
            result = new HashMap();
            fieldsByClass.put(type, result);

            for (Field child : type.getDeclaredFields()) {
                int modifiers = child.getModifiers();
                if (Modifier.isFinal(modifiers) ||
                    Modifier.isStatic(modifiers))
                    continue;

                XmlElementWrapper w = child.getAnnotation(XmlElementWrapper.class);
                XmlElement e = child.getAnnotation(XmlElement.class);

                String childName = child.getName();
                String childElementName = w != null
                    ? "##default".equals(w.name())
                        ? child.getName()
                        : w.name()
                    : e == null || "##default".equals(e.name())
                        ? childName
                        : e.name();

                result.put(childElementName, child);
            }
        }

        return new HashMap<>(result);
    }

    private static DocumentBuilder builder(Class type) {
        try {
            DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();

            // -----------------------------------------------------------------
            // [JOOX #136] FIX START: Prevent OWASP attack vectors
            try {
                factory.setFeature("http://apache.org/xml/features/disallow-doctype-decl", true);
            }
            catch (ParserConfigurationException ignore) {}

            try {
                factory.setFeature("http://xml.org/sax/features/external-general-entities", false);
            }
            catch (ParserConfigurationException ignore) {}

            try {
                factory.setFeature("http://xml.org/sax/features/external-parameter-entities", false);
            }
            catch (ParserConfigurationException ignore) {}

            // [JOOX #149] Not implemented on Android
            try {
                factory.setXIncludeAware(false);
            }
            catch (UnsupportedOperationException ignore) {}

            // [#8918] log warnings for unknown elements
            String namespace = getNamespace(type);
            if (namespace != null)
                try {
                    Schema schema = getSchema(type, namespace);
                    factory.setSchema(schema);
                }
                catch (UnsupportedOperationException ignore) {}

            factory.setExpandEntityReferences(false);
            // [JOOX #136] FIX END
            // -----------------------------------------------------------------

            // [JOOX #9] [JOOX #107] In order to take advantage of namespace-related DOM
            // features, the internal builder should be namespace-aware
            factory.setNamespaceAware(true);
            DocumentBuilder builder = factory.newDocumentBuilder();
            builder.setErrorHandler(new ErrorHandler() {
                @Override
                public void warning(SAXParseException exception) throws SAXException {
                    log.warn(exception);
                }

                @Override
                public void fatalError(SAXParseException exception) throws SAXException {
                    log.warn(exception);
                }

                @Override
                public void error(SAXParseException exception) throws SAXException {
                    log.warn(exception);
                }
            });

            return builder;
        }
        catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

    private static String getNamespace(Class type) {
        if (type != null && type.getPackage() != null && type.getPackage().isAnnotationPresent(XmlSchema.class))
            return type.getPackage().getAnnotation(XmlSchema.class).namespace();

        return null;
    }

    private static Schema getSchema(Class type, String namespace) {
        try {
            URL url;
            if (PROVIDED_SCHEMAS.containsKey(namespace))
                url = type.getResource(PROVIDED_SCHEMAS.get(namespace));
            else
                url = new URL(namespace);

            if (url != null) {
                SchemaFactory schemaFactory = SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI);
                Schema schema = schemaFactory.newSchema(url);
                return schema;
            }
        }
        catch (Exception e) {
            log.warn("Failed to load schema for namespace " + namespace, e);
        }
        return null;
    }

    /**
     * Appends a second JAXB annotated object to a
     * first one using Maven's
     * combine.children="append" semantics.
     *
     * @return The modified first argument.
     */
    @SuppressWarnings({ "rawtypes", "unchecked" })
    public static  T append(T first, T second) {
        if (first == null)
            return second;
        if (second == null)
            return first;

        Class firstClass = (Class) first.getClass();
        Class secondClass = (Class) second.getClass();

        if (!firstClass.isAssignableFrom(secondClass) && !secondClass.isAssignableFrom(firstClass))
            throw new IllegalArgumentException("Can only append compatible types");
        // [#8527] support enum types
        else if (firstClass.isEnum())
            return first;

        // We're assuming that XJC generated objects are all in the same package
        Package pkg = firstClass.getPackage();
        try {
            Class defaultsClass = nonGradleExtensionClass(firstClass);
            T defaults = defaultsClass.getDeclaredConstructor().newInstance();

            methodLoop:
            for (Method setter : firstClass.getMethods()) {
                if (setter.getName().startsWith("set") && setter.getParameterCount() == 1) {

                    // [#12985] [#15974] [#15966] Don't call any gradle specific setters.
                    try {
                        defaultsClass.getMethod(setter.getName(), setter.getParameterTypes());
                    }
                    catch (NoSuchMethodException e) {
                        continue methodLoop;
                    }


                    Method defaultsGetter;
                    Method firstGetter;
                    Method secondGetter;

                    try {
                        defaultsGetter = defaultsClass.getMethod("get" + setter.getName().substring(3));
                        firstGetter = firstClass.getMethod("get" + setter.getName().substring(3));
                        secondGetter = secondClass.getMethod("get" + setter.getName().substring(3));
                    }
                    catch (NoSuchMethodException e) {
                        defaultsGetter = defaultsClass.getMethod("is" + setter.getName().substring(3));
                        firstGetter = firstClass.getMethod("is" + setter.getName().substring(3));
                        secondGetter = firstClass.getMethod("is" + setter.getName().substring(3));
                    }

                    Class childType = setter.getParameterTypes()[0];
                    Object firstChild = firstGetter.invoke(first);
                    Object secondChild = secondGetter.invoke(second);
                    Object defaultChild = defaults != null ? defaultsGetter.invoke(defaults) : null;

                    if (Collection.class.isAssignableFrom(childType))
                        ((List) firstChild).addAll((List) secondChild);
                    else if (secondChild != null && (firstChild == null || firstChild.equals(defaultChild)))
                        setter.invoke(first, secondChild);
                    else if (secondChild != null && pkg == childType.getPackage())
                        append(firstChild, secondChild);
                    else
                        ; // All other types cannot be merged
                }
            }
        }
        catch (Exception e) {
            throw new ReflectException(e);
        }

        return first;
    }

    /**
     * [#12985] [#15974] [#15966] Gradle generates a subclass for our
     * configuration extensions, which will accept an injected argument. We
     * shouldn't use that subclass here.
     */
    @SuppressWarnings("unchecked")
    private static  Class nonGradleExtensionClass(Class klass) {
        while (klass.getName().startsWith("org.jooq.codegen.gradle"))
            klass = (Class) klass.getSuperclass();

        return klass;
    }

    private static  A getAnnotation(Class klass, Class annotation) {
        return nonGradleExtensionClass(klass).getAnnotation(annotation);
    }
}
    
    
    
    

    




    
    
    © 2015 - 2025 Weber Informatics LLC | Privacy Policy