/**
    * This file Copyright (c) 2017-2018 Magnolia International
    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
    *
    *
    * This file is dual-licensed under both the Magnolia
    * Network Agreement and the GNU General Public License.
    * You may elect to use one or the other of these licenses.
    *
   * This file is distributed in the hope that it will be
   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
   * implied warranty of MERCHANTABILITY or FITNESS FOR A
   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
   * Redistribution, except as permitted by whichever of the GPL
   * or MNA you select, is prohibited.
   *
   * 1. For the GPL license (GPL), you can redistribute and/or
   * modify this file under the terms of the GNU General
   * Public License, Version 3, as published by the Free Software
   * Foundation.  You should have received a copy of the GNU
   * General Public License, Version 3 along with this program;
   * if not, write to the Free Software Foundation, Inc., 51
   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
   *
   * 2. For the Magnolia Network Agreement (MNA), this file
   * and the accompanying materials are made available under the
   * terms of the MNA which accompanies this distribution, and
   * is available at http://www.magnolia-cms.com/mna.html
   *
   * Any modifications to this file must keep this entire header
   * intact.
   *
   */
  package info.magnolia.importexport.outputter;
  
  import java.io.IOException;
  import java.io.Writer;
  import java.util.ArrayList;
  import java.util.List;
  
  import org.jdom.Attribute;
  import org.jdom.Element;
  import org.jdom.Namespace;
  import org.jdom.output.Format;
  import org.jdom.output.XMLOutputter;
  
  /**
   * {@link org.jdom.output.XMLOutputter} which print every attribute to a separate line and exposes some private method from the parent class.
   */
  public class DocumentViewOutputter extends XMLOutputter {
  
      private String separatorChars = "\n";
      private String apostropheChars = "\"";
      private String asignmentChars = "=";
  
      private int currentLevel;
  
      public DocumentViewOutputter() {
          final Format format = Format.getPrettyFormat();
          format.setTextMode(Format.TextMode.NORMALIZE);
          format.setOmitDeclaration(true);
          setFormat(format);
      }
  
      @Override
      protected void printElement(Writer out, Element element, int level, NamespaceStack namespaces) throws IOException {
          currentLevel = level;
          super.printElement(out, element, level, namespaces);
      }
  
      @Override
      protected void printAttributes(Writer out, List attributes, Element parent, NamespaceStack namespaces) throws IOException {
          attributes = sortAttributes(attributes);
          for (int i = 0; i < attributes.size(); i++) {
              Attribute attribute = (Attribute) attributes.get(i);
              Namespace ns = attribute.getNamespace();
              if (ns != Namespace.NO_NAMESPACE && ns != Namespace.XML_NAMESPACE) { //TODO which print?
                  printNamespace(out, ns, namespaces);
              }
              attributeSeparator(out);
              if (separatorChars.contains("\n")) {
                  indent(out, currentLevel + 1);
              }
              printQualifiedName(out, attribute);
              out.write(asignmentChars);
              out.write(apostropheChars);
              out.write(escapeAttributeEntities(attribute.getValue()));
              out.write(apostropheChars);
          }
      }
  
      protected void attributeSeparator(Writer out) throws IOException {
          out.write(separatorChars);
      }
  
      protected void indent(Writer out, int level) throws IOException {
          if (getFormat().getIndent() == null || getFormat().getIndent().equals("")) {
              return;
          }
         for (int i = 0; i < level; i++) {
             out.write(getFormat().getIndent());
         }
     }
 
     protected void newline(Writer out) throws IOException {
         if (getFormat().getIndent() != null) {
             out.write(getFormat().getLineSeparator());
         }
     }
 
     protected void printQualifiedName(Writer out, Attribute a) throws IOException {
         String prefix = a.getNamespace().getPrefix();
         if ((prefix != null) && (!prefix.equals(""))) {
             out.write(prefix);
             out.write(':');
         }
         printName(out, a);
     }
 
     protected void printName(Writer out, Attribute a) throws IOException {
         out.write(a.getName());
     }
 
     private void printNamespace(Writer out, Namespace ns, NamespaceStack namespaces) throws IOException {
         if (namespaces == null) {
             return;
         }
         String prefix = ns.getPrefix();
         String uri = ns.getURI();
 
         // Already printed namespace decl?
         if (uri.equals(namespaces.getURI(prefix))) {
             return;
         }
 
         out.write(" xmlns");
         if (!prefix.equals("")) {
             out.write(":");
             out.write(prefix);
         }
         out.write("=\"");
         out.write(escapeAttributeEntities(uri));
         out.write("\"");
         namespaces.push(ns);
     }
 
     protected List<Attribute> sortAttributes(List attributes) throws IOException {
         List<Attribute> sortedAttributes = new ArrayList<>(attributes);
         sortedAttributes.sort((o1, o2) -> o1.getQualifiedName().compareTo(o2.getQualifiedName()));
         return sortedAttributes;
     }
 
     protected int getCurrentLevel() {
         return currentLevel;
     }
 
     protected void setCurrentLevel(int currentLevel) {
         this.currentLevel = currentLevel;
     }
 
     public String getSeparatorChars() {
         return separatorChars;
     }
 
     public void setSeparatorChars(String separatorChars) {
         this.separatorChars = separatorChars;
     }
 
     public String getApostropheChars() {
         return apostropheChars;
     }
 
     public void setApostropheChars(String apostropheChars) {
         this.apostropheChars = apostropheChars;
     }
 
     public String getAsignmentChars() {
         return asignmentChars;
     }
 
     public void setAsignmentChars(String asignmentChars) {
         this.asignmentChars = asignmentChars;
     }
 }