/*
    * SPDX-FileCopyrightText: Copyright (c) 2012-2025 Yegor Bugayenko
    * SPDX-License-Identifier: MIT
    */
   package com.jcabi.xml;
   
   import com.jcabi.log.Logger;
   import java.io.ByteArrayInputStream;
   import java.io.File;
  import java.io.IOException;
  import java.nio.charset.StandardCharsets;
  import javax.xml.parsers.DocumentBuilder;
  import javax.xml.parsers.DocumentBuilderFactory;
  import javax.xml.parsers.ParserConfigurationException;
  import lombok.EqualsAndHashCode;
  import lombok.ToString;
  import org.w3c.dom.Document;
  import org.xml.sax.SAXException;
  
  /**
   * Convenient parser of XML to DOM.
   *
   * <p>Objects of this class are immutable and thread-safe.
   *
   * @since 0.1
   */
  @ToString
  @EqualsAndHashCode
  final class DomParser {
  
      /**
       * Document builder factory to use for parsing.
       */
      private final transient DocumentBuilderFactory factory;
  
      /**
       * Source of XML.
       */
      private final DocSource source;
  
      /**
       * Public ctor.
       *
       * <p>An {@link IllegalArgumentException} may be thrown if the parameter
       * passed is not in XML format. It doesn't perform a strict validation
       * and is not guaranteed that an exception will be thrown whenever
       * the parameter is not XML.
       *
       * <p>It is assumed that the text is in UTF-8.
       *
       * @param fct Document builder factory to use
       * @param txt The XML in text (in UTF-8)
       */
      DomParser(final DocumentBuilderFactory fct, final String txt) {
          this(fct, new BytesSource(txt));
      }
  
      /**
       * Public ctor.
       *
       * <p>An {@link IllegalArgumentException} may be thrown if the parameter
       * passed is not in XML format. It doesn't perform a strict validation
       * and is not guaranteed that an exception will be thrown whenever
       * the parameter is not XML.
       *
       * @param fct Document builder factory to use
       * @param bytes The XML in bytes
       */
      @SuppressWarnings("PMD.ArrayIsStoredDirectly")
      DomParser(final DocumentBuilderFactory fct, final byte[] bytes) {
          this(fct, new BytesSource(bytes));
      }
  
      /**
       * Public ctor.
       *
       * <p>An {@link IllegalArgumentException} may be thrown if the parameter
       * passed is not in XML format. It doesn't perform a strict validation
       * and is not guaranteed that an exception will be thrown whenever
       * the parameter is not XML.
       *
       * @param fct Document builder factory to use
       * @param file The XML as a file
       */
      DomParser(final DocumentBuilderFactory fct, final File file) {
          this(fct, new FileSource(file));
      }
  
      /**
       * Private ctor.
       * @param factory Document builder factory to use
       * @param source Source of XML
       */
      private DomParser(final DocumentBuilderFactory factory, final DocSource source) {
          this.factory = factory;
          this.source = source;
      }
  
      /**
      * Get the document body.
      * @return The document
      */
     @SuppressWarnings("PMD.PrematureDeclaration")
     public Document document() {
         final DocumentBuilder builder;
         try {
             builder = this.factory.newDocumentBuilder();
         } catch (final ParserConfigurationException ex) {
             throw new IllegalArgumentException(
                 String.format(
                     "Failed to create document builder by %s",
                     this.factory.getClass().getName()
                 ),
                 ex
             );
         }
         final long start = System.nanoTime();
         final Document doc;
         try {
             doc = this.source.apply(builder);
         } catch (final IOException | SAXException ex) {
             throw new IllegalArgumentException(
                 String.format(
                     "Can't parse by %s, most probably the XML is invalid",
                     builder.getClass().getName()
                 ),
                 ex
             );
         }
         if (Logger.isTraceEnabled(this)) {
             Logger.trace(
                 this,
                 "%s parsed %d bytes of XML in %[nano]s",
                 builder.getClass().getName(),
                 this.source.length(),
                 System.nanoTime() - start
             );
         }
         return doc;
     }
 
     /**
      * Source of XML.
      * @since 0.32
      */
     private interface DocSource {
 
         /**
          * Parse XML by the builder.
          * @param builder The builder to use during parsing.
          * @return The document.
          * @throws IOException If fails.
          * @throws SAXException If fails.
          */
         Document apply(DocumentBuilder builder) throws IOException, SAXException;
 
         /**
          * The length of the source.
          * @return The length.
          */
         long length();
     }
 
     /**
      * File source of XML from a file.
      * @since 0.32
      */
     private static class FileSource implements DocSource {
 
         /**
          * The file.
          */
         private final File file;
 
         /**
          * Public ctor.
          * @param file The file.
          */
         FileSource(final File file) {
             this.file = file;
         }
 
         @Override
         public Document apply(final DocumentBuilder builder) throws IOException, SAXException {
             return builder.parse(this.file);
         }
 
         @Override
         public long length() {
             return this.file.length();
         }
     }
 
     /**
      * Bytes source of XML.
      * @since 0.32
      */
     private static class BytesSource implements DocSource {
 
         /**
          * Bytes of the XML.
          */
         private final byte[] xml;
 
         /**
          * Public ctor.
          * @param xml Bytes of the XML.
          */
         BytesSource(final String xml) {
             this(xml.getBytes(StandardCharsets.UTF_8));
         }
 
         /**
          * Public ctor.
          * @param xml Bytes of the XML.
          */
         @SuppressWarnings("PMD.ArrayIsStoredDirectly")
         BytesSource(final byte[] xml) {
             this.xml = xml;
         }
 
         @Override
         public Document apply(final DocumentBuilder builder) throws IOException, SAXException {
             return builder.parse(new ByteArrayInputStream(this.xml));
         }
 
         @Override
         public long length() {
             return this.xml.length;
         }
     }
 }