/*
    * 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.rat.configuration;
  
  import java.io.IOException;
  import java.io.InputStream;
  import java.io.Reader;
  import java.lang.reflect.InvocationTargetException;
  import java.lang.reflect.Method;
  import java.net.URI;
  import java.util.ArrayList;
  import java.util.Collections;
  import java.util.HashMap;
  import java.util.Iterator;
  import java.util.List;
  import java.util.Map;
  import java.util.SortedSet;
  import java.util.TreeSet;
  import java.util.function.BiPredicate;
  import java.util.function.Consumer;
  
  import javax.xml.parsers.DocumentBuilder;
  
  import org.apache.commons.lang3.StringUtils;
  import org.apache.commons.lang3.tuple.ImmutablePair;
  import org.apache.commons.lang3.tuple.Pair;
  import org.apache.rat.BuilderParams;
  import org.apache.rat.ConfigurationException;
  import org.apache.rat.ImplementationException;
  import org.apache.rat.analysis.IHeaderMatcher;
  import org.apache.rat.config.parameters.ComponentType;
  import org.apache.rat.config.parameters.Description;
  import org.apache.rat.config.parameters.DescriptionBuilder;
  import org.apache.rat.configuration.builders.AbstractBuilder;
  import org.apache.rat.license.ILicense;
  import org.apache.rat.license.ILicenseFamily;
  import org.apache.rat.utils.DefaultLog;
  import org.apache.rat.utils.StandardXmlFactory;
  import org.w3c.dom.DOMException;
  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.InputSource;
  import org.xml.sax.SAXException;
  
  /**
   * A class that reads the XML configuration file format.
   */
  public final class XMLConfigurationReader implements LicenseReader, MatcherReader {
      /** The document we are building */
      private Document document;
      /** The root element in the document */
      private final Element rootElement;
      /** The families element in the document */
      private final Element familiesElement;
      /** The licenses element in the document */
      private final Element licensesElement;
      /** The approved element in the document */
      private final Element approvedElement;
      /** The matchers element in the document */
      private final Element matchersElement;
      /** The sorted set of licenses */
      private final SortedSet<ILicense> licenses;
      /** The map of matcher ids to matcher */
      private final Map<String, IHeaderMatcher> matchers;
      /** The builder parameters */
      private final BuilderParams builderParams;
      /** The sorted set of license families */
      private final SortedSet<ILicenseFamily> licenseFamilies;
      /** The sorted set of approved license family categories */
      private final SortedSet<String> approvedFamilies;
  
      /**
       * Constructs the XML configuration reader.
       */
      public XMLConfigurationReader() {
          document = StandardXmlFactory.documentBuilder().newDocument();
          rootElement = document.createElement(XMLConfig.ROOT);
          document.appendChild(rootElement);
          familiesElement = document.createElement(XMLConfig.FAMILIES);
          rootElement.appendChild(familiesElement);
         licensesElement = document.createElement(XMLConfig.LICENSES);
         rootElement.appendChild(licensesElement);
         approvedElement = document.createElement(XMLConfig.APPROVED);
         rootElement.appendChild(approvedElement);
         matchersElement = document.createElement(XMLConfig.MATCHERS);
         rootElement.appendChild(matchersElement);
         licenses = new TreeSet<>();
         licenseFamilies = new TreeSet<>();
         approvedFamilies = new TreeSet<>();
         matchers = new HashMap<>();
         builderParams = new BuilderParams() {
             @Override
             public Map<String, IHeaderMatcher> matcherMap() {
                 return matchers;
             }
 
             @Override
             public SortedSet<ILicenseFamily> licenseFamilies() {
                 return licenseFamilies;
             }
         };
     }
 
     /**
      * Creates textual representation of a node for display.
      * @param node the node to create the textual representation of.
      * @return the textual representation of the node for display.
      */
     private String nodeText(final Node node) {
         StringBuilder stringBuilder = new StringBuilder().append("<").append(node.getNodeName());
         NamedNodeMap attr = node.getAttributes();
         for (int i = 0; i < attr.getLength(); i++) {
             Node n = attr.item(i);
             stringBuilder.append(String.format(" %s='%s'", n.getNodeName(), n.getNodeValue()));
         }
         return stringBuilder.append(">").toString();
     }
 
     @Override
     public void addLicenses(final URI uri) {
         read(uri);
     }
 
     /**
      * Read xml from a reader.
      * @param reader the reader to read XML from.
      */
     public void read(final Reader reader) {
         try {
             add(StandardXmlFactory.documentBuilder().parse(new InputSource(reader)));
         } catch (SAXException | IOException e) {
             throw new ConfigurationException("Unable to read inputSource", e);
         }
     }
 
     /**
      * Read the uris and extract the DOM information to create new objects.
      * @param uris the URIs to read.
      */
     public void read(final URI... uris) {
         DocumentBuilder builder = StandardXmlFactory.documentBuilder();
         for (URI uri : uris) {
             try (InputStream inputStream = uri.toURL().openStream()) {
                 add(builder.parse(inputStream));
             } catch (SAXException | IOException e) {
                 throw new ConfigurationException("Unable to read uri: " + uri, e);
             }
         }
     }
 
     /**
      * Applies the {@code consumer} to each node in the {@code list}. Generally used for extracting info from a
      * {@code NodeList}.
      * @param list the NodeList to process.
      * @param consumer the consumer to apply to each node in the list.
      */
     public static void nodeListConsumer(final NodeList list, final Consumer<Node> consumer) {
         for (int i = 0; i < list.getLength(); i++) {
             consumer.accept(list.item(i));
         }
     }
 
     /**
      * Merge the new document into the document that this reader processes is building.
      * @param newDoc the Document to merge.
      */
     public void add(final Document newDoc) {
         nodeListConsumer(newDoc.getElementsByTagName(XMLConfig.FAMILIES), nl -> nodeListConsumer(nl.getChildNodes(),
                 n -> familiesElement.appendChild(rootElement.getOwnerDocument().adoptNode(n.cloneNode(true)))));
         nodeListConsumer(newDoc.getElementsByTagName(XMLConfig.LICENSE),
                 n -> licensesElement.appendChild(rootElement.getOwnerDocument().adoptNode(n.cloneNode(true))));
         nodeListConsumer(newDoc.getElementsByTagName(XMLConfig.APPROVED), nl -> nodeListConsumer(nl.getChildNodes(),
                 n -> approvedElement.appendChild(rootElement.getOwnerDocument().adoptNode(n.cloneNode(true)))));
         nodeListConsumer(newDoc.getElementsByTagName(XMLConfig.MATCHERS),
                 n -> matchersElement.appendChild(rootElement.getOwnerDocument().adoptNode(n.cloneNode(true))));
     }
 
     /**
      * Get a map of Node attribute names to values.
      * @param node the node to process.
      * @return the map of attributes on the node.
      */
     public static Map<String, String> attributes(final Node node) {
         NamedNodeMap nnm = node.getAttributes();
         Map<String, String> result = new HashMap<>();
         for (int i = 0; i < nnm.getLength(); i++) {
             Node n = nnm.item(i);
             result.put(n.getNodeName(), n.getNodeValue());
         }
         return result;
     }
 
     /**
      * Finds the setter description property in the builder and set it with the value.
      * @param desc the description for the setter.
      * @param builder the builder to set the value in.
      * @param value the value to set.
      */
     private void callSetter(final Description desc, final IHeaderMatcher.Builder builder, final Object value) {
         try {
             desc.setter(builder.getClass()).invoke(builder, value);
         } catch (NoSuchMethodException | IllegalAccessException | IllegalArgumentException | InvocationTargetException
                 | SecurityException e) {
             throw new ConfigurationException(e.getMessage(), e);
         }
     }
 
     /**
      * For any children of description that are BUILD_PARAMETERS set the builder property.
      * @param description the description for the builder.
      * @param builder the builder to set the properties in.
      */
     private void processBuilderParams(final Description description, final IHeaderMatcher.Builder builder) {
         for (Description desc : description.childrenOfType(ComponentType.BUILD_PARAMETER)) {
             Method m = builderParams.get(desc.getCommonName());
             try {
                 callSetter(desc, builder, m.invoke(builderParams));
             } catch (IllegalAccessException | IllegalArgumentException | InvocationTargetException e) {
                 throw ImplementationException.makeInstance(e);
             }
         }
     }
 
     /**
      * Processes a list of children by passing each child node and the description
      * of the child (if any) to the BiPredicate. If there is not a child description
      * for the node it is ignored. If the node is processed it is removed from list
      * of children.
      * @param description the description of the node being processed.
      * @param children the child nodes of that node.
      * @param childProcessor the function that handles the processing of the child
      * node.
      */
     private void processChildren(final Description description, final List<Node> children,
                                  final BiPredicate<Node, Description> childProcessor) {
         Iterator<Node> iter = children.iterator();
         while (iter.hasNext()) {
             Node child = iter.next();
             Description childDescription = description.getChildren().get(child.getNodeName());
             if (childDescription != null) {
                 if (childProcessor.test(child, childDescription)) {
                     iter.remove();
                 }
             }
         }
     }
 
     /**
      * Creates a child node processor for the builder described by the description.
      * @param builder the builder to set properties in.
      * @param description the description of the builder.
      * @return child node.
      */
     private BiPredicate<Node, Description> matcherChildNodeProcessor(final AbstractBuilder builder, final Description description) {
         return (child, childDescription) -> {
             switch (childDescription.getType()) {
             case LICENSE:
             case BUILD_PARAMETER:
                 throw new ConfigurationException(String.format(
                         "%s may not be used as an enclosed matcher.  %s '%s' found in '%s'", childDescription.getType(),
                         childDescription.getType(), childDescription.getCommonName(), description.getCommonName()));
             case MATCHER:
                 AbstractBuilder b = parseMatcher(child);
                 callSetter(b.getDescription(), builder, b);
                 return true;
             case PARAMETER:
                 if (!XMLConfig.isInlineNode(description.getCommonName(), childDescription.getCommonName())
                         || childDescription.getChildType() == String.class) {
                     callSetter(childDescription, builder, child.getTextContent());
                 } else {
                     callSetter(childDescription, builder, parseMatcher(child));
                 }
                 return true;
             }
             return false;
         };
     }
 
     /**
      * Sets the value of the element described by the description in the builder with the value from childDescription.
      * @param description the property in the builder to set.
      * @param childDescription the description of the child property to extract.
      * @param builder the builder to set the value in.
      * @param child the child to extract the value from.
      */
     private void setValue(final Description description, final Description childDescription, final IHeaderMatcher.Builder builder,
             final Node child) {
         if (childDescription.getChildType() == String.class) {
             callSetter(description, builder, child.getTextContent());
         } else {
             callSetter(description, builder, parseMatcher(child));
         }
     }
 
     /**
      * Process the ELEMENT_NODEs children of the parent whose names match child
      * descriptions. All children of children are processed with the childProcessor. If
      * the childProcessor handles the node it is not included in the resulting list.
      * @param description the description of the parent node.
      * @param parent the node being processed.
      * @param childProcessor the BiProcessor to handle process each child. If the
      * processor handles the child it must return {@code true}.
      * @return a Pair comprising a boolean flag indicating children were found, and
      * a list of all child nodes that were not processed by the childProcessor.
      */
     private Pair<Boolean, List<Node>> processChildNodes(final Description description, final Node parent,
             final BiPredicate<Node, Description> childProcessor) {
         try {
             boolean foundChildren = false;
             List<Node> children = new ArrayList<>();
             // check XML child nodes.
             if (parent.hasChildNodes()) {
 
                 nodeListConsumer(parent.getChildNodes(), n -> {
                     if (n.getNodeType() == Node.ELEMENT_NODE) {
                         children.add(n);
                     }
                 });
                 foundChildren = !children.isEmpty();
                 if (foundChildren) {
                     processChildren(description, children, childProcessor);
                 }
             }
             return new ImmutablePair<>(foundChildren, children);
         } catch (RuntimeException exception) {
             DefaultLog.getInstance().error(String.format("Child node extraction error in: '%s'", nodeText(parent)));
             throw exception;
         }
     }
 
     /**
      * Creates a Builder from a Matcher node.
      * @param matcherNode the Matcher node to parse.
      * @return the Builder for the matcher described by the node.
      */
     private AbstractBuilder parseMatcher(final Node matcherNode) {
         final AbstractBuilder builder = MatcherBuilderTracker.getMatcherBuilder(matcherNode.getNodeName());
 
         try {
             final Description description = DescriptionBuilder.buildMap(builder.getClass());
             if (description == null) {
                 throw new ConfigurationException(String.format("Unable to build description for %s", builder.getClass()));
             }
             processBuilderParams(description, builder);
 
             // process the attributes
             description.setChildren(builder, attributes(matcherNode));
 
             // check XML child nodes.
             Pair<Boolean, List<Node>> pair = processChildNodes(description, matcherNode,
                     matcherChildNodeProcessor(builder, description));
             boolean foundChildren = pair.getLeft();
             List<Node> children = pair.getRight();
 
             // check for inline nodes that can accept child nodes.
             List<Description> childDescriptions = description.getChildren().values().stream()
                     .filter(d -> XMLConfig.isInlineNode(description.getCommonName(), d.getCommonName()))
                     .toList();
 
             for (Description childDescription : childDescriptions) {
                 if (XMLConfig.isInlineNode(description.getCommonName(), childDescription.getCommonName())) {
                     // can only process text inline if there were no child nodes.
                     if (childDescription.getChildType() == String.class) {
                         if (!foundChildren) {
                             callSetter(childDescription, builder, matcherNode.getTextContent());
                         }
                     } else {
                         Iterator<Node> iter = children.iterator();
                         while (iter.hasNext()) {
                             Node child = iter.next();
                             callSetter(childDescription, builder, parseMatcher(child));
                             iter.remove();
                         }
                     }
                 } else {
                     processChildren(description, children, (child, childD) -> {
                         if (childD.getChildType().equals(description.getChildType())) {
                             setValue(childDescription, childD, builder, child);
                             return true;
                         }
                         return false;
                     });
                 }
             }
 
             if (!children.isEmpty()) {
                 children.forEach(n -> DefaultLog.getInstance().warn(String.format("unrecognised child node '%s' in node '%s'%n",
                         n.getNodeName(), matcherNode.getNodeName())));
             }
 
         } catch (DOMException e) {
             DefaultLog.getInstance().error(String.format("Matcher error in: '%s'", nodeText(matcherNode)));
             throw new ConfigurationException(e);
         }
         return builder.hasId() ? new IDRecordingBuilder(matchers, builder) : builder;
     }
 
     private BiPredicate<Node, Description> licenseChildNodeProcessor(final ILicense.Builder builder, final Description description) {
         return (child, childDescription) -> {
             switch (childDescription.getType()) {
             case LICENSE:
                 throw new ConfigurationException(String.format(
                         "%s may not be enclosed in another license. %s '%s' found in '%s'", childDescription.getType(),
                         childDescription.getType(), childDescription.getCommonName(), description.getCommonName()));
             case BUILD_PARAMETER:
                 break;
             case MATCHER:
                 AbstractBuilder b = parseMatcher(child);
                 callSetter(b.getDescription(), builder, b);
                 return true;
             case PARAMETER:
                 if (!XMLConfig.isLicenseChild(childDescription.getCommonName())
                         || childDescription.getChildType() == String.class) {
                     callSetter(childDescription, builder, child.getTextContent());
                 } else {
                     callSetter(childDescription, builder, parseMatcher(child));
                 }
                 return true;
             }
             return false;
         };
     }
 
     /**
      * Parses a license from a license node.
      * @param licenseNode the node to parse.
      * @return the License definition.
      */
     private ILicense parseLicense(final Node licenseNode) {
         try {
             ILicense.Builder builder = ILicense.builder();
             // get the description for the builder
             Description description = builder.getDescription();
             // set the BUILDER_PARAM options from the description
             processBuilderParams(description, builder);
             // set the children from attributes.
             description.setChildren(builder, attributes(licenseNode));
             // set children from the child nodes
             Pair<Boolean, List<Node>> pair = processChildNodes(description, licenseNode,
                     licenseChildNodeProcessor(builder, description));
             List<Node> children = pair.getRight();
 
             // check for inline nodes that can accept child nodes.
             List<Description> childDescriptions = description.getChildren().values().stream()
                     .filter(d -> XMLConfig.isLicenseInline(d.getCommonName())).toList();
             for (Description childDescription : childDescriptions) {
                 Iterator<Node> iter = children.iterator();
                 while (iter.hasNext()) {
                     callSetter(childDescription, builder, parseMatcher(iter.next()));
                     iter.remove();
                 }
             }
 
             if (!children.isEmpty()) {
                 children.forEach(n -> DefaultLog.getInstance().warn(String.format("unrecognised child node '%s' in node '%s'%n",
                         n.getNodeName(), licenseNode.getNodeName())));
             }
             return builder.build();
         } catch (RuntimeException exception) {
             DefaultLog.getInstance().error(String.format("License error in: '%s'", nodeText(licenseNode)));
             throw exception;
         }
     }
 
     @Override
     public SortedSet<ILicense> readLicenses() {
         if (this.document != null) {
             readFamilies();
             readMatcherBuilders();
             if (licenses.isEmpty()) {
                 nodeListConsumer(document.getElementsByTagName(XMLConfig.LICENSE), x -> licenses.add(parseLicense(x)));
                 document = null;
             }
         }
         return Collections.unmodifiableSortedSet(licenses);
     }
 
     @Override
     public SortedSet<ILicenseFamily> readFamilies() {
         if (licenseFamilies.isEmpty()) {
             nodeListConsumer(document.getElementsByTagName(XMLConfig.FAMILIES),
                     x -> nodeListConsumer(x.getChildNodes(), this::parseFamily));
             nodeListConsumer(document.getElementsByTagName(XMLConfig.APPROVED),
                     x -> nodeListConsumer(x.getChildNodes(), this::parseApproved));
         }
         return Collections.unmodifiableSortedSet(licenseFamilies);
     }
 
     /**
      * Parses a license family from a map that contains the ID and Name attributes.
      * @param attributes the map of attributes.
      * @return the license family defined in the map.
      */
     private ILicenseFamily parseFamily(final Map<String, String> attributes) {
         if (attributes.containsKey(XMLConfig.ATT_ID)) {
             ILicenseFamily.Builder builder = ILicenseFamily.builder();
             builder.setLicenseFamilyCategory(attributes.get(XMLConfig.ATT_ID));
             builder.setLicenseFamilyName(
                     StringUtils.defaultIfBlank(attributes.get(XMLConfig.ATT_NAME), attributes.get(XMLConfig.ATT_ID)));
             return builder.build();
         }
         return null;
     }
 
     /**
      * Parses a license family node into a license family and adds it to the license families set.
      * @param familyNode the node to parse.
      */
     private void parseFamily(final Node familyNode) {
         if (XMLConfig.FAMILY.equals(familyNode.getNodeName())) {
             try {
                 ILicenseFamily result = parseFamily(attributes(familyNode));
                 if (result == null) {
                     throw new ConfigurationException(
                             String.format("families/family tag requires %s attribute", XMLConfig.ATT_ID));
                 }
                 licenseFamilies.add(result);
             } catch (RuntimeException exception) {
                 DefaultLog.getInstance().error(String.format("Family error in: '%s'", nodeText(familyNode)));
                 throw exception;
             }
         }
     }
 
     /**
      * Parse an approved License family and adds it to the set of license families as well as the
      * set of approved license families.
      * @param approvedNode the node to parse.
      */
     private void parseApproved(final Node approvedNode) {
         if (XMLConfig.FAMILY.equals(approvedNode.getNodeName())) {
             try {
                 Map<String, String> attributes = attributes(approvedNode);
                 if (attributes.containsKey(XMLConfig.ATT_LICENSE_REF)) {
                     approvedFamilies.add(attributes.get(XMLConfig.ATT_LICENSE_REF));
                 } else if (attributes.containsKey(XMLConfig.ATT_ID)) {
                     ILicenseFamily target = parseFamily(attributes);
                     if (target != null) {
                         licenseFamilies.add(target);
                         String familyCategory = target.getFamilyCategory();
                         if (StringUtils.isNotBlank(familyCategory)) {
                             approvedFamilies.add(familyCategory);
                         }
                     }
                 } else {
                     throw new ConfigurationException(String.format("family tag requires %s or %s attribute",
                             XMLConfig.ATT_LICENSE_REF, XMLConfig.ATT_ID));
                 }
             } catch (RuntimeException exception) {
                 DefaultLog.getInstance().error(String.format("Approved error in: '%s'", nodeText(approvedNode)));
                 throw exception;
             }
         }
     }
 
     ////////////////////////////////////////// MatcherReader methods
     @Override
     public SortedSet<String> approvedLicenseId() {
         if (licenses.isEmpty()) {
             this.readLicenses();
         }
         if (approvedFamilies.isEmpty()) {
             SortedSet<String> result = new TreeSet<>();
             licenses.stream().map(x -> x.getLicenseFamily().getFamilyCategory()).forEach(result::add);
             return result;
         }
         return Collections.unmodifiableSortedSet(approvedFamilies);
     }
 
     private void parseMatcherBuilder(final Node classNode) {
         try {
             Map<String, String> attributes = attributes(classNode);
             if (attributes.get(XMLConfig.ATT_CLASS_NAME) == null) {
                 throw new ConfigurationException("matcher must have a " + XMLConfig.ATT_CLASS_NAME + " attribute");
             }
             MatcherBuilderTracker.addBuilder(attributes.get(XMLConfig.ATT_CLASS_NAME), attributes.get(XMLConfig.ATT_NAME));
         } catch (RuntimeException exception) {
             DefaultLog.getInstance().error(String.format("Matcher error in: '%s'", nodeText(classNode)));
             throw exception;
         }
     }
 
     @Override
     public void readMatcherBuilders() {
         nodeListConsumer(document.getElementsByTagName(XMLConfig.MATCHER), this::parseMatcherBuilder);
     }
 
     @Override
     public void addMatchers(final URI uri) {
         read(uri);
     }
 
     /**
      * An abstract builder that delegates to another abstract builder.
      */
     static class IDRecordingBuilder extends AbstractBuilder {
         /** The builder we are delegating to */
         private final AbstractBuilder delegate;
         /**
          * The map of matchers that the system is building during processing.
          * We will utilize this to set the matcher value later.
          */
         private final Map<String, IHeaderMatcher> matchers;
 
         IDRecordingBuilder(final Map<String, IHeaderMatcher> matchers, final AbstractBuilder delegate) {
             this.delegate = delegate;
             this.matchers = matchers;
             setId(delegate.getId());
         }
 
         @Override
         public IHeaderMatcher build() {
             IHeaderMatcher result = delegate.build();
             matchers.put(result.getId(), result);
             return result;
         }
 
         @Override
         public Description getDescription() {
             return delegate.getDescription();
         }
     }
 }