package org.testng.reporters;

import java.io.Writer;
import java.util.Properties;
import java.util.Stack;
import java.util.regex.Pattern;
import javax.annotation.Nullable;

This class allows you to generate an XML text document by pushing and popping tags from a stack
maintained internally.
Author:
Cedric Beust Jul 21, 2003/**
 * This class allows you to generate an XML text document by pushing and popping tags from a stack
 * maintained internally.
 *
 * @author <a href="mailto:cedric@beust.com">Cedric Beust</a> Jul 21, 2003
 */
public class XMLStringBuffer {
  
End of line, value of 'line.separator' system property or '\n' /** End of line, value of 'line.separator' system property or '\n' */
  public static final String EOL = RuntimeBehavior.getLineSeparatorOrNewLine();

  
Tab space indent for XML document /** Tab space indent for XML document */
  private static final String DEFAULT_INDENT_INCREMENT = "  ";

  
The buffer to hold the xml document /** The buffer to hold the xml document */
  private IBuffer m_buffer;

  
The stack of tags to make sure XML document is well formed. /** The stack of tags to make sure XML document is well formed. */
  private final Stack<Tag> m_tagStack = new Stack<>();

  
A string of space character representing the current indentation. /** A string of space character representing the current indentation. */
  private String m_currentIndent = "";

  private String defaultComment = null;

  public XMLStringBuffer() {
    init(Buffer.create(), "", "1.0", "UTF-8");
  }

  
Params:
start – A string of spaces indicating the indentation at which to start the generation.
    This constructor will not insert an <?xml prologue./**
   * @param start A string of spaces indicating the indentation at which to start the generation.
   *     This constructor will not insert an <code>&lt;?xml</code> prologue.
   */
  public XMLStringBuffer(String start) {
    init(Buffer.create(), start);
  }

  
Params:
buffer – The StringBuffer to use internally to represent the document.
start – A string of spaces indicating the indentation at which to start the generation./**
   * @param buffer The StringBuffer to use internally to represent the document.
   * @param start A string of spaces indicating the indentation at which to start the generation.
   */
  public XMLStringBuffer(IBuffer buffer, String start) {
    init(buffer, start);
  }

  private void init(IBuffer buffer, String start) {
    init(buffer, start, null, null);
  }

  
Params:
start – A string of spaces indicating the indentation at which to start the generation./**
   * @param start A string of spaces indicating the indentation at which to start the generation.
   */
  private void init(
      IBuffer buffer, String start, @Nullable String version, @Nullable String encoding) {
    m_buffer = buffer;
    m_currentIndent = start;
    if (version != null) {
      setXmlDetails(version, encoding);
    }
  }

  
Set the xml version and encoding for this document.
Params:
v – the XML version
enc – the XML encoding/**
   * Set the xml version and encoding for this document.
   *
   * @param v the XML version
   * @param enc the XML encoding
   */
  public void setXmlDetails(String v, String enc) {
    if (m_buffer.toString().length() != 0) {
      throw new IllegalStateException("Buffer should be empty: '" + m_buffer.toString() + "'");
    }
    m_buffer.append("<?xml version=\"" + v + "\" encoding=\"" + enc + "\"?>").append(EOL);
  }

  
Set the doctype for this document.
Params:
docType – The DOCTYPE string, without the "<!DOCTYPE " ">"/**
   * Set the doctype for this document.
   *
   * @param docType The DOCTYPE string, without the "&lt;!DOCTYPE " "&gt;"
   */
  public void setDocType(String docType) {
    m_buffer.append("<!DOCTYPE " + docType + ">" + EOL);
  }

  
Push a new tag. Its value is stored and will be compared against the parameter passed to pop().
Params:
tagName – The name of the tag.
schema – The schema to use (can be null or an empty string).
attributes – A Properties file representing the attributes (or null)/**
   * Push a new tag. Its value is stored and will be compared against the parameter passed to pop().
   *
   * @param tagName The name of the tag.
   * @param schema The schema to use (can be null or an empty string).
   * @param attributes A Properties file representing the attributes (or null)
   */
  public void push(String tagName, @Nullable String schema, @Nullable Properties attributes) {
    XMLUtils.xmlOpen(m_buffer, m_currentIndent, tagName + schema, attributes);
    m_tagStack.push(new Tag(m_currentIndent, tagName, attributes));
    m_currentIndent += DEFAULT_INDENT_INCREMENT;
  }

  
Push a new tag. Its value is stored and will be compared against the parameter passed to pop().
Params:
tagName – The name of the tag.
schema – The schema to use (can be null or an empty string)./**
   * Push a new tag. Its value is stored and will be compared against the parameter passed to pop().
   *
   * @param tagName The name of the tag.
   * @param schema The schema to use (can be null or an empty string).
   */
  public void push(String tagName, @Nullable String schema) {
    push(tagName, schema, null);
  }

  
Push a new tag. Its value is stored and will be compared against the parameter passed to pop().
Params:
tagName – The name of the tag.
attributes – A Properties file representing the attributes (or null)/**
   * Push a new tag. Its value is stored and will be compared against the parameter passed to pop().
   *
   * @param tagName The name of the tag.
   * @param attributes A Properties file representing the attributes (or null)
   */
  public void push(String tagName, @Nullable Properties attributes) {
    push(tagName, "", attributes);
  }

  public void push(String tagName, String... attributes) {
    push(tagName, createProperties(attributes));
  }

  private Properties createProperties(String[] attributes) {
    Properties result = new Properties();
    if (attributes == null) {
      return result;
    }
    if (attributes.length % 2 != 0) {
      throw new IllegalArgumentException(
          "Arguments 'attributes' length must be even. Actual: " + attributes.length);
    }
    for (int i = 0; i < attributes.length; i += 2) {
      result.put(attributes[i], attributes[i + 1]);
    }
    return result;
  }

  
Push a new tag. Its value is stored and will be compared against the parameter passed to pop().
Params:
tagName – The name of the tag./**
   * Push a new tag. Its value is stored and will be compared against the parameter passed to pop().
   *
   * @param tagName The name of the tag.
   */
  public void push(String tagName) {
    push(tagName, "");
  }

  
Pop the last pushed element without verifying it if matches the previously pushed tag. /** Pop the last pushed element without verifying it if matches the previously pushed tag. */
  public void pop() {
    pop(null);
  }

  
Pop the last pushed element and throws an AssertionError if it doesn't match the corresponding
tag that was pushed earlier.
Params:
tagName – The name of the tag this pop() is supposed to match./**
   * Pop the last pushed element and throws an AssertionError if it doesn't match the corresponding
   * tag that was pushed earlier.
   *
   * @param tagName The name of the tag this pop() is supposed to match.
   */
  public void pop(String tagName) {
    m_currentIndent = m_currentIndent.substring(DEFAULT_INDENT_INCREMENT.length());
    Tag t = m_tagStack.pop();
    if (null != tagName) {
      if (!tagName.equals(t.tagName)) {
        // TODO Is it normal to throw an Error here?
        throw new AssertionError(
            "Popping the wrong tag: " + t.tagName + " but expected " + tagName);
      }
    }

    String comment = defaultComment;
    if (comment == null) {
      comment = XMLUtils.extractComment(tagName, t.properties);
    }
    XMLUtils.xmlClose(m_buffer, m_currentIndent, t.tagName, comment);
  }

  
Add a required element to the current tag. An opening and closing tag will be generated even if
value is null.
Params:
tagName – The name of the tag
value – The value for this tag/**
   * Add a required element to the current tag. An opening and closing tag will be generated even if
   * value is null.
   *
   * @param tagName The name of the tag
   * @param value The value for this tag
   */
  public void addRequired(String tagName, @Nullable String value) {
    addRequired(tagName, value, (Properties) null);
  }

  
Add a required element to the current tag. An opening and closing tag will be generated even if
value is null.
Params:
tagName – The name of the tag
value – The value for this tag
attributes – A Properties file containing the attributes (or null)/**
   * Add a required element to the current tag. An opening and closing tag will be generated even if
   * value is null.
   *
   * @param tagName The name of the tag
   * @param value The value for this tag
   * @param attributes A Properties file containing the attributes (or null)
   */
  public void addRequired(String tagName, @Nullable String value, @Nullable Properties attributes) {
    XMLUtils.xmlRequired(m_buffer, m_currentIndent, tagName, value, attributes);
  }

  public void addRequired(String tagName, @Nullable String value, String... attributes) {
    addRequired(tagName, value, createProperties(attributes));
  }

  
Add an optional String element to the current tag. If value is null, nothing is added.
Params:
tagName – The name of the tag
value – The value for this tag
attributes – A Properties file containing the attributes (or null)/**
   * Add an optional String element to the current tag. If value is null, nothing is added.
   *
   * @param tagName The name of the tag
   * @param value The value for this tag
   * @param attributes A Properties file containing the attributes (or null)
   */
  public void addOptional(String tagName, @Nullable String value, @Nullable Properties attributes) {
    if (value != null) {
      XMLUtils.xmlOptional(m_buffer, m_currentIndent, tagName, value, attributes);
    }
  }

  public void addOptional(String tagName, @Nullable String value, String... attributes) {
    if (value != null) {
      XMLUtils.xmlOptional(m_buffer, m_currentIndent, tagName, value, createProperties(attributes));
    }
  }

  
Add an optional String element to the current tag. If value is null, nothing is added.
Params:
tagName – The name of the tag
value – The value for this tag/**
   * Add an optional String element to the current tag. If value is null, nothing is added.
   *
   * @param tagName The name of the tag
   * @param value The value for this tag
   */
  public void addOptional(String tagName, @Nullable String value) {
    addOptional(tagName, value, (Properties) null);
  }

  
Add an optional Boolean element to the current tag. If value is null, nothing is added.
Params:
tagName – The name of the tag
value – The value for this tag
attributes – A Properties file containing the attributes (or null)/**
   * Add an optional Boolean element to the current tag. If value is null, nothing is added.
   *
   * @param tagName The name of the tag
   * @param value The value for this tag
   * @param attributes A Properties file containing the attributes (or null)
   */
  public void addOptional(
      String tagName, @Nullable Boolean value, @Nullable Properties attributes) {
    if (null != value) {
      XMLUtils.xmlOptional(m_buffer, m_currentIndent, tagName, value.toString(), attributes);
    }
  }

  
Add an optional Boolean element to the current tag. If value is null, nothing is added.
Params:
tagName – The name of the tag
value – The value for this tag/**
   * Add an optional Boolean element to the current tag. If value is null, nothing is added.
   *
   * @param tagName The name of the tag
   * @param value The value for this tag
   */
  public void addOptional(String tagName, @Nullable Boolean value) {
    addOptional(tagName, value, null);
  }

  
Add an empty element tag (e.g. <foo/>)
Params:
tagName – The name of the tag/**
   * Add an empty element tag (e.g. <code>&lt;foo/&gt;</code>)
   *
   * @param tagName The name of the tag
   */
  public void addEmptyElement(String tagName) {
    addEmptyElement(tagName, (Properties) null);
  }

  
Add an empty element tag (e.g. >foo/<)
Params:
tagName – The name of the tag
attributes – A Properties file containing the attributes (or null)/**
   * Add an empty element tag (e.g. <code>&gt;foo/&lt;</code>)
   *
   * @param tagName The name of the tag
   * @param attributes A Properties file containing the attributes (or null)
   */
  public void addEmptyElement(String tagName, @Nullable Properties attributes) {
    m_buffer.append(m_currentIndent).append("<").append(tagName);
    XMLUtils.appendAttributes(m_buffer, attributes);
    m_buffer.append("/>").append(EOL);
  }

  public void addEmptyElement(String tagName, String... attributes) {
    addEmptyElement(tagName, createProperties(attributes));
  }

  public void addComment(String comment) {
    m_buffer
        .append(m_currentIndent)
        .append("<!-- " + comment.replaceAll("[-]{2,}", "-") + " -->\n");
  }

  public void addString(String s) {
    m_buffer.append(s);
  }

  public void setDefaultComment(String defaultComment) {
    this.defaultComment = defaultComment;
  }

  public void addCDATA(String content) {
    if (content != null) {
      // Solution from https://coderanch.com/t/455930/java/Remove-control-characters
      content = content.replaceAll("[\\p{Cc}&&[^\\r\\n]]", "");
    }
    m_buffer.append(m_currentIndent);
    if (content == null) {
      m_buffer.append("<![CDATA[null]]>");
    } else if (!content.contains("]]>")) {
      m_buffer.append("<![CDATA[").append(content).append("]]>");
    } else if ("]]>".equals(content)) {
      // Solution from https://stackoverflow.com/q/223652/4234729
      m_buffer.append("<![CDATA[]]]]><![CDATA[>]]>");
    } else { // content contains "]]>"
      String[] subStrings = content.split("]]>");
      m_buffer.append("<![CDATA[").append(subStrings[0]).append("]]]]>");
      for (int i = 1; i < subStrings.length - 1; i++) {
        m_buffer.append("<![CDATA[>").append(subStrings[i]).append("]]]]>");
      }
      m_buffer.append("<![CDATA[>").append(subStrings[subStrings.length - 1]).append("]]>");
      if (content.endsWith("]]>")) {
        m_buffer.append("<![CDATA[]]]]>").append("<![CDATA[>]]>");
      }
    }
    m_buffer.append(EOL);
  }

  
Returns:
The StringBuffer used to create the document./** @return The StringBuffer used to create the document. */
  public IBuffer getStringBuffer() {
    return m_buffer;
  }

  private static final Pattern INVALID_XML_CHARS =
      Pattern.compile(
          "[^\\u0009\\u000A\\u000D\\u0020-\\uD7FF\\uE000-\\uFFFD\uD800\uDC00-\uDBFF\uDFFF]");

  
Returns:
The String representation of the XML for this XMLStringBuffer./** @return The String representation of the XML for this XMLStringBuffer. */
  public String toXML() {
    return INVALID_XML_CHARS.matcher(m_buffer.toString()).replaceAll("");
  }

  public String getCurrentIndent() {
    return m_currentIndent;
  }

  public void toWriter(Writer fw) {
    m_buffer.toWriter(fw);
  }
}

////////////////////////

class Tag {
  public final String tagName;
  public final String indent;
  public final Properties properties;

  public Tag(String ind, String n, Properties p) {
    tagName = n;
    indent = ind;
    properties = p;
  }

  @Override
  public String toString() {
    return tagName;
  }
}