/*
    * SPDX-FileCopyrightText: none
    * SPDX-License-Identifier: CC0-1.0
    */
   
   package gov.nist.secauto.metaschema.databind.io.xml;
   
   import gov.nist.secauto.metaschema.core.model.IBoundObject;
   import gov.nist.secauto.metaschema.core.model.IMetaschemaData;
  import gov.nist.secauto.metaschema.core.model.util.XmlEventUtil;
  import gov.nist.secauto.metaschema.core.qname.IEnhancedQName;
  import gov.nist.secauto.metaschema.core.util.CollectionUtil;
  import gov.nist.secauto.metaschema.core.util.ObjectUtils;
  import gov.nist.secauto.metaschema.databind.io.BindingException;
  import gov.nist.secauto.metaschema.databind.model.IBoundDefinitionModelAssembly;
  import gov.nist.secauto.metaschema.databind.model.IBoundDefinitionModelComplex;
  import gov.nist.secauto.metaschema.databind.model.IBoundDefinitionModelFieldComplex;
  import gov.nist.secauto.metaschema.databind.model.IBoundFieldValue;
  import gov.nist.secauto.metaschema.databind.model.IBoundInstanceFlag;
  import gov.nist.secauto.metaschema.databind.model.IBoundInstanceModel;
  import gov.nist.secauto.metaschema.databind.model.IBoundInstanceModelAssembly;
  import gov.nist.secauto.metaschema.databind.model.IBoundInstanceModelChoiceGroup;
  import gov.nist.secauto.metaschema.databind.model.IBoundInstanceModelFieldComplex;
  import gov.nist.secauto.metaschema.databind.model.IBoundInstanceModelFieldScalar;
  import gov.nist.secauto.metaschema.databind.model.IBoundInstanceModelGroupedAssembly;
  import gov.nist.secauto.metaschema.databind.model.IBoundInstanceModelGroupedField;
  import gov.nist.secauto.metaschema.databind.model.IBoundInstanceModelGroupedNamed;
  import gov.nist.secauto.metaschema.databind.model.info.AbstractModelInstanceReadHandler;
  import gov.nist.secauto.metaschema.databind.model.info.IFeatureScalarItemValueHandler;
  import gov.nist.secauto.metaschema.databind.model.info.IItemReadHandler;
  import gov.nist.secauto.metaschema.databind.model.info.IModelInstanceCollectionInfo;
  
  import org.apache.logging.log4j.LogManager;
  import org.apache.logging.log4j.Logger;
  import org.codehaus.stax2.XMLEventReader2;
  
  import java.io.IOException;
  import java.net.URI;
  import java.util.Collection;
  import java.util.HashSet;
  import java.util.LinkedHashMap;
  import java.util.LinkedList;
  import java.util.List;
  import java.util.Map;
  import java.util.Set;
  import java.util.function.Function;
  import java.util.stream.Collectors;
  
  import javax.xml.namespace.QName;
  import javax.xml.stream.Location;
  import javax.xml.stream.XMLStreamConstants;
  import javax.xml.stream.XMLStreamException;
  import javax.xml.stream.events.Attribute;
  import javax.xml.stream.events.StartElement;
  import javax.xml.stream.events.XMLEvent;
  
  import edu.umd.cs.findbugs.annotations.NonNull;
  import edu.umd.cs.findbugs.annotations.Nullable;
  
  /**
   * Supports reading XML-based Metaschema module instances.
   */
  @SuppressWarnings("PMD.CouplingBetweenObjects")
  public class MetaschemaXmlReader
      implements IXmlParsingContext {
    private static final Logger LOGGER = LogManager.getLogger(MetaschemaXmlReader.class);
    @NonNull
    private final XMLEventReader2 reader;
    @NonNull
    private final URI source;
    @NonNull
    private final IXmlProblemHandler problemHandler;
  
    /**
     * Construct a new Module-aware XML parser using the default problem handler.
     *
     * @param reader
     *          the XML reader to parse with
     * @param source
     *          the resource being parsed
     * @see DefaultXmlProblemHandler
     */
    public MetaschemaXmlReader(
        @NonNull XMLEventReader2 reader,
        @NonNull URI source) {
      this(reader, source, new DefaultXmlProblemHandler());
    }
  
    /**
     * Construct a new Module-aware parser.
     *
     * @param reader
     *          the XML reader to parse with
     * @param source
     *          the resource being parsed
     * @param problemHandler
     *          the problem handler implementation to use
     */
    public MetaschemaXmlReader(
       @NonNull XMLEventReader2 reader,
       @NonNull URI source,
       @NonNull IXmlProblemHandler problemHandler) {
     this.reader = reader;
     this.source = source;
     this.problemHandler = problemHandler;
   }
 
   @Override
   public XMLEventReader2 getReader() {
     return reader;
   }
 
   @Override
   public URI getSource() {
     return source;
   }
 
   @Override
   public IXmlProblemHandler getProblemHandler() {
     return problemHandler;
   }
 
   /**
    * Parses XML into a bound object based on the provided {@code definition}.
    * <p>
    * Parses the {@link XMLStreamConstants#START_DOCUMENT}, any processing
    * instructions, and the element.
    *
    * @param <CLASS>
    *          the returned object type
    * @param definition
    *          the definition describing the element data to read
    * @return the parsed object
    * @throws IOException
    *           if an error occurred while parsing the input
    */
   @Override
   @NonNull
   public <CLASS> CLASS read(@NonNull IBoundDefinitionModelComplex definition) throws IOException {
     URI resource = getSource();
     try {
       // we may be at the START_DOCUMENT
       if (reader.peek().isStartDocument()) {
         XmlEventUtil.consumeAndAssert(reader, resource, XMLStreamConstants.START_DOCUMENT);
       }
 
       // advance past any other info to get to next start element
       XmlEventUtil.skipEvents(reader, XMLStreamConstants.CHARACTERS, XMLStreamConstants.PROCESSING_INSTRUCTION,
           XMLStreamConstants.DTD);
 
       XMLEvent event = ObjectUtils.requireNonNull(reader.peek());
       if (!event.isStartElement()) {
         throw new IOException(
             String.format("The token '%s' is not an XML element%s.",
                 XmlEventUtil.toEventName(event),
                 XmlEventUtil.generateLocationMessage(event, resource)));
       }
 
       ItemReadHandler handler = new ItemReadHandler(ObjectUtils.notNull(event.asStartElement()));
       Object value = definition.readItem(null, handler);
       if (value == null) {
         event = reader.peek();
         throw new IOException(String.format("Unable to read data.%s",
             event == null ? "" : XmlEventUtil.generateLocationMessage(event, resource)));
       }
 
       return ObjectUtils.asType(value);
     } catch (XMLStreamException ex) {
       throw new IOException(ex);
     }
   }
 
   /**
    * Read the XML attribute data described by the {@code targetDefinition} and
    * apply it to the provided {@code targetObject}.
    *
    * @param targetDefinition
    *          the Module definition that describes the syntax of the data to read
    * @param targetObject
    *          the Java object that data parsed by this method will be stored in
    * @param start
    *          the containing XML element that was previously parsed
    * @throws IOException
    *           if an error occurred while parsing the input
    * @throws XMLStreamException
    *           if an error occurred while parsing XML events
    */
   protected void readFlagInstances(
       @NonNull IBoundDefinitionModelComplex targetDefinition,
       @NonNull IBoundObject targetObject,
       @NonNull StartElement start) throws IOException, XMLStreamException {
     URI resource = getSource();
 
     Map<IEnhancedQName, IBoundInstanceFlag> flagInstanceMap = targetDefinition.getFlagInstances().stream()
         .collect(Collectors.toMap(
             IBoundInstanceFlag::getQName,
             Function.identity()));
 
     for (Attribute attribute : CollectionUtil.toIterable(ObjectUtils.notNull(start.getAttributes()))) {
       IEnhancedQName qname = IEnhancedQName.of(ObjectUtils.requireNonNull(attribute.getName()));
       IBoundInstanceFlag instance = flagInstanceMap.get(qname);
       if (instance == null) {
         // unrecognized flag
         if (!getProblemHandler().handleUnknownAttribute(targetDefinition, targetObject, attribute, this)) {
           throw new IOException(
               String.format("Unrecognized attribute '%s'%s.",
                   qname,
                   XmlEventUtil.generateLocationMessage(attribute, resource)));
         }
       } else {
         try {
           // get the attribute value
           Object value = instance.getDefinition().getJavaTypeAdapter().parse(ObjectUtils.notNull(attribute.getValue()));
           // apply the value to the parentObject
           instance.setValue(targetObject, value);
           flagInstanceMap.remove(qname);
         } catch (IllegalArgumentException ex) {
           throw new IOException(
               String.format("Malformed data '%s'%s. %s",
                   attribute.getValue(),
                   XmlEventUtil.generateLocationMessage(start, resource),
                   ex.getLocalizedMessage()),
               ex);
         }
       }
     }
 
     if (!flagInstanceMap.isEmpty()) {
       getProblemHandler().handleMissingFlagInstances(
           targetDefinition,
           targetObject,
           ObjectUtils.notNull(flagInstanceMap.values()));
     }
   }
 
   /**
    * Read the XML element data described by the {@code targetDefinition} and apply
    * it to the provided {@code targetObject}.
    *
    * @param targetDefinition
    *          the Module definition that describes the syntax of the data to read
    * @param targetObject
    *          the Java object that data parsed by this method will be stored in
    * @throws IOException
    *           if an error occurred while parsing the input
    */
   protected void readModelInstances(
       @NonNull IBoundDefinitionModelAssembly targetDefinition,
       @NonNull IBoundObject targetObject)
       throws IOException {
     Collection<? extends IBoundInstanceModel<?>> instances = targetDefinition.getModelInstances();
     Set<IBoundInstanceModel<?>> unhandledProperties = new HashSet<>();
     for (IBoundInstanceModel<?> modelInstance : instances) {
       assert modelInstance != null;
       if (!readItems(modelInstance, targetObject, true)) {
         unhandledProperties.add(modelInstance);
       }
     }
 
     // process all properties that did not get a value
     getProblemHandler().handleMissingModelInstances(targetDefinition, targetObject, unhandledProperties);
 
     XMLEventReader2 reader = getReader();
     URI resource = getSource();
 
     // handle any
     try {
       if (!getReader().peek().isEndElement()) {
         // handle any
         XmlEventUtil.skipWhitespace(reader);
         XmlEventUtil.skipElement(reader);
         XmlEventUtil.skipWhitespace(reader);
       }
 
       XmlEventUtil.assertNext(reader, resource, XMLStreamConstants.END_ELEMENT);
     } catch (XMLStreamException ex) {
       throw new IOException(ex);
     }
   }
 
   /**
    * Determine if the next data to read corresponds to the next model instance.
    *
    * @param targetInstance
    *          the model instance that describes the syntax of the data to read
    * @return {@code true} if the Module instance needs to be parsed, or
    *         {@code false} otherwise
    * @throws XMLStreamException
    *           if an error occurred while parsing XML events
    */
   @SuppressWarnings("PMD.OnlyOneReturn")
   protected boolean isNextInstance(
       @NonNull IBoundInstanceModel<?> targetInstance)
       throws XMLStreamException {
 
     XmlEventUtil.skipWhitespace(reader);
 
     XMLEvent nextEvent = reader.peek();
 
     boolean retval = nextEvent.isStartElement();
     if (retval) {
       IEnhancedQName qname = IEnhancedQName.of(ObjectUtils.notNull(nextEvent.asStartElement().getName()));
       retval = qname.equals(targetInstance.getEffectiveXmlGroupAsQName()) // parse the grouping element
           || targetInstance.canHandleXmlQName(qname); // parse the instance(s)
     }
     return retval;
   }
 
   /**
    * Read the data associated with the {@code instance} and apply it to the
    * provided {@code parentObject}.
    *
    * @param instance
    *          the instance to parse data for
    * @param parentObject
    *          the Java object that data parsed by this method will be stored in
    * @return {@code true} if the instance was parsed, or {@code false} if the data
    *         did not contain information for this instance
    * @throws IOException
    *           if an error occurred while parsing the input
    */
   @Override
   public <T> boolean readItems(
       @NonNull IBoundInstanceModel<T> instance,
       @NonNull IBoundObject parentObject,
       boolean parseGrouping)
       throws IOException {
     try {
       boolean handled = isNextInstance(instance);
       if (handled) {
         XMLEventReader2 reader = getReader();
         URI resource = getSource();
 
         // XmlEventUtil.skipWhitespace(reader);
 
         IEnhancedQName groupEQName = parseGrouping ? instance.getEffectiveXmlGroupAsQName() : null;
         QName groupQName = groupEQName == null ? null : groupEQName.toQName();
         if (groupQName != null) {
           // we need to parse the grouping element, if the next token matches
           XmlEventUtil.requireStartElement(reader, resource, groupQName);
         }
 
         IModelInstanceCollectionInfo<T> collectionInfo = instance.getCollectionInfo();
 
         ModelInstanceReadHandler<T> handler = new ModelInstanceReadHandler<>(instance, parentObject);
 
         // let the property info decide how to parse the value
         Object value = collectionInfo.readItems(handler);
         if (value != null) {
           instance.setValue(parentObject, value);
         }
 
         // consume extra whitespace between elements
         XmlEventUtil.skipWhitespace(reader);
 
         if (groupQName != null) {
           // consume the end of the group
           XmlEventUtil.requireEndElement(reader, resource, groupQName);
         }
       }
       return handled;
     } catch (XMLStreamException ex) {
       throw new IOException(ex);
     }
   }
 
   private final class ModelInstanceReadHandler<ITEM>
       extends AbstractModelInstanceReadHandler<ITEM> {
 
     private ModelInstanceReadHandler(
         @NonNull IBoundInstanceModel<ITEM> instance,
         @NonNull IBoundObject parentObject) {
       super(instance, parentObject);
     }
 
     @Override
     public List<ITEM> readList() throws IOException {
       return ObjectUtils.notNull(readCollection());
     }
 
     @Override
     public Map<String, ITEM> readMap() throws IOException {
       IBoundInstanceModel<?> instance = getCollectionInfo().getInstance();
 
       return ObjectUtils.notNull(readCollection().stream()
           .collect(Collectors.toMap(
               item -> {
                 assert item != null;
 
                 IBoundInstanceFlag jsonKey = instance.getItemJsonKey(item);
                 assert jsonKey != null;
                 return ObjectUtils.requireNonNull(jsonKey.getValue(item)).toString();
               },
               Function.identity(),
               (t, u) -> u,
               LinkedHashMap::new)));
     }
 
     @NonNull
     private List<ITEM> readCollection() throws IOException {
       List<ITEM> retval = new LinkedList<>();
       XMLEventReader2 reader = getReader();
       try {
 
         // consume extra whitespace between elements
         XmlEventUtil.skipWhitespace(reader);
 
         IBoundInstanceModel<?> instance = getCollectionInfo().getInstance();
         XMLEvent event;
         while ((event = reader.peek()).isStartElement()
             && instance.canHandleXmlQName(
                 IEnhancedQName.of(ObjectUtils.notNull(event.asStartElement().getName())))) {
 
           // Consume the start element
           ITEM value = readItem();
           retval.add(value);
 
           // consume extra whitespace between elements
           XmlEventUtil.skipWhitespace(reader);
         }
       } catch (XMLStreamException ex) {
         throw new IOException(ex);
       }
       return retval;
     }
 
     @Override
     public ITEM readItem() throws IOException {
       try {
         return getCollectionInfo().getInstance().readItem(
             getParentObject(),
             new ItemReadHandler(ObjectUtils.notNull(getReader().peek().asStartElement())));
       } catch (XMLStreamException ex) {
         throw new IOException(ex);
       }
     }
   }
 
   private final class ItemReadHandler implements IItemReadHandler {
     @NonNull
     private final StartElement startElement;
 
     private ItemReadHandler(@NonNull StartElement startElement) {
       this.startElement = startElement;
     }
 
     /**
      * Get the current start element.
      *
      * @return the startElement
      */
     @NonNull
     private StartElement getStartElement() {
       return startElement;
     }
 
     @NonNull
     private <DEF extends IBoundDefinitionModelComplex> IBoundObject readDefinitionElement(
         @NonNull DEF definition,
         @NonNull StartElement start,
         @NonNull IEnhancedQName expectedEQName,
         @Nullable IBoundObject parent,
         @NonNull DefinitionBodyHandler<DEF, IBoundObject> bodyHandler) throws IOException {
       XMLEventReader2 reader = getReader();
       URI resource = getSource();
       QName expectedQName = expectedEQName.toQName();
 
       try {
         // consume the start element
         XmlEventUtil.requireStartElement(reader, resource, expectedQName);
 
         Location location = start.getLocation();
 
         // construct the item
         IBoundObject item = definition.newInstance(location == null ? null : () -> new MetaschemaData(location));
 
         // call pre-parse initialization hook
         definition.callBeforeDeserialize(item, parent);
 
         // read the flags
         readFlagInstances(definition, item, start);
 
         // read the body
         bodyHandler.accept(definition, item);
 
         XmlEventUtil.skipWhitespace(reader);
 
         // call post-parse initialization hook
         definition.callAfterDeserialize(item, parent);
 
         // consume the end element
         XmlEventUtil.requireEndElement(reader, resource, expectedQName);
         return ObjectUtils.asType(item);
       } catch (BindingException | XMLStreamException ex) {
         throw new IOException(ex);
       }
     }
 
     @Override
     public Object readItemFlag(
         IBoundObject parent,
         IBoundInstanceFlag flag) throws IOException {
       // should never be called
       throw new UnsupportedOperationException("should be handled by readFlagInstances()");
     }
 
     private void handleFieldDefinitionBody(
         @NonNull IBoundDefinitionModelFieldComplex definition,
         @NonNull IBoundObject item) throws IOException {
       IBoundFieldValue fieldValue = definition.getFieldValue();
 
       // parse the value
       Object value = fieldValue.readItem(item, this);
       if (value != null) {
         fieldValue.setValue(item, value);
       }
     }
 
     @Override
     public Object readItemField(
         IBoundObject parent,
         IBoundInstanceModelFieldScalar instance)
         throws IOException {
       XMLEventReader2 reader = getReader();
       URI resource = getSource();
       try {
         QName wrapper = null;
         if (instance.isEffectiveValueWrappedInXml()) {
           wrapper = instance.getQName().toQName();
 
           XmlEventUtil.skipWhitespace(reader);
           XmlEventUtil.requireStartElement(reader, resource, wrapper);
         }
 
         Object retval = readScalarItem(instance);
 
         if (wrapper != null) {
           XmlEventUtil.skipWhitespace(reader);
 
           XmlEventUtil.requireEndElement(reader, resource, wrapper);
         }
         return retval;
       } catch (XMLStreamException ex) {
         throw new IOException(ex);
       }
     }
 
     @Override
     public IBoundObject readItemField(
         IBoundObject parent,
         IBoundInstanceModelFieldComplex instance)
         throws IOException {
       return readDefinitionElement(
           instance.getDefinition(),
           getStartElement(),
           instance.getQName(),
           parent,
           this::handleFieldDefinitionBody);
     }
 
     @Override
     public IBoundObject readItemField(IBoundObject parent, IBoundInstanceModelGroupedField instance)
         throws IOException {
       return readDefinitionElement(
           instance.getDefinition(),
           getStartElement(),
           instance.getQName(),
           parent,
           this::handleFieldDefinitionBody);
     }
 
     @Override
     public IBoundObject readItemField(
         IBoundObject parent,
         IBoundDefinitionModelFieldComplex definition) throws IOException {
       return readDefinitionElement(
           definition,
           getStartElement(),
           definition.getQName(),
           parent,
           this::handleFieldDefinitionBody);
     }
 
     @Override
     public Object readItemFieldValue(
         IBoundObject parent,
         IBoundFieldValue fieldValue) throws IOException {
       return checkMissingFieldValue(readScalarItem(fieldValue));
     }
 
     @Nullable
     private Object checkMissingFieldValue(Object value) {
       if (value == null && LOGGER.isWarnEnabled()) {
         StartElement start = getStartElement();
         LOGGER.atWarn().log("Missing property value{}",
             XmlEventUtil.generateLocationMessage(start, getSource()));
       }
       return value;
     }
 
     private void handleAssemblyDefinitionBody(
         @NonNull IBoundDefinitionModelAssembly definition,
         @NonNull IBoundObject item) throws IOException {
       readModelInstances(definition, item);
     }
 
     @Override
     public IBoundObject readItemAssembly(
         IBoundObject parent,
         IBoundInstanceModelAssembly instance) throws IOException {
       return readDefinitionElement(
           instance.getDefinition(),
           getStartElement(),
           instance.getQName(),
           parent,
           this::handleAssemblyDefinitionBody);
     }
 
     @Override
     public IBoundObject readItemAssembly(IBoundObject parent, IBoundInstanceModelGroupedAssembly instance)
         throws IOException {
       return readDefinitionElement(
           instance.getDefinition(),
           getStartElement(),
           instance.getQName(),
           parent,
           this::handleAssemblyDefinitionBody);
     }
 
     @Override
     public IBoundObject readItemAssembly(
         IBoundObject parent,
         IBoundDefinitionModelAssembly definition) throws IOException {
       return readDefinitionElement(
           definition,
           getStartElement(),
           ObjectUtils.requireNonNull(definition.getRootQName()),
           parent,
           this::handleAssemblyDefinitionBody);
     }
 
     @Nullable
     private Object readScalarItem(@NonNull IFeatureScalarItemValueHandler handler)
         throws IOException {
       return handler.getJavaTypeAdapter().parse(getReader(), getSource());
     }
 
     @Override
     public IBoundObject readChoiceGroupItem(IBoundObject parent, IBoundInstanceModelChoiceGroup instance)
         throws IOException {
       try {
         XMLEventReader2 eventReader = getReader();
         // consume extra whitespace between elements
         XmlEventUtil.skipWhitespace(eventReader);
 
         XMLEvent event = eventReader.peek();
         IEnhancedQName nextQName = IEnhancedQName.of(ObjectUtils.notNull(event.asStartElement().getName()));
         IBoundInstanceModelGroupedNamed actualInstance = instance.getGroupedModelInstance(nextQName);
         assert actualInstance != null;
         return actualInstance.readItem(parent, this);
       } catch (XMLStreamException ex) {
         throw new IOException(ex);
       }
     }
   }
 
   private static class MetaschemaData implements IMetaschemaData {
     private final int line;
     private final int column;
     private final long charOffset;
 
     public MetaschemaData(@NonNull Location location) {
       this.line = location.getLineNumber();
       this.column = location.getColumnNumber();
       this.charOffset = location.getCharacterOffset();
     }
 
     @Override
     public int getLine() {
       return line;
     }
 
     @Override
     public int getColumn() {
       return column;
     }
 
     @Override
     public long getCharOffset() {
       return charOffset;
     }
 
     @Override
     public long getByteOffset() {
       return -1;
     }
   }
 
   @FunctionalInterface
   private interface DefinitionBodyHandler<DEF extends IBoundDefinitionModelComplex, ITEM> {
     void accept(
         @NonNull DEF definition,
         @NonNull ITEM item) throws IOException;
   }
 
 }