/*******************************************************************************
    * jhunters: Pool League
    * Copyright 2015 Tony Washer
    *
    * Licensed 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 net.sourceforge.jhunters.pool.ui;
  
  import java.io.IOException;
  import java.io.InputStream;
  import java.io.StringWriter;
  import java.nio.file.Files;
  import java.nio.file.LinkOption;
  import java.nio.file.Path;
  import java.nio.file.StandardCopyOption;
  import java.time.LocalDate;
  import java.util.Formatter;
  import java.util.Locale;
  
  import javax.xml.parsers.DocumentBuilder;
  import javax.xml.parsers.DocumentBuilderFactory;
  import javax.xml.parsers.ParserConfigurationException;
  import javax.xml.transform.Transformer;
  import javax.xml.transform.TransformerConfigurationException;
  import javax.xml.transform.TransformerException;
  import javax.xml.transform.TransformerFactory;
  import javax.xml.transform.dom.DOMSource;
  import javax.xml.transform.stream.StreamResult;
  
  import org.w3c.dom.Document;
  import org.w3c.dom.Element;
  
  import net.sourceforge.jhunters.pool.PoolException;
  import net.sourceforge.jhunters.pool.data.DataParser;
  import net.sourceforge.jhunters.pool.data.Fixture;
  import net.sourceforge.jhunters.pool.data.Player;
  import net.sourceforge.jhunters.pool.data.Result;
  
  /**
   * Report Builder.
   */
  public class ReportBuilder {
      /**
       * jQuery functions.
       */
      private static final String JS_TABS = "jtabs.js";
  
      /**
       * Standard CSS.
       */
      private static final String CSS_STANDARD = "jhuntersPrint.css";
  
      /**
       * WebSite CSS.
       */
      private static final String CSS_WEB = "jhuntersWeb.css";
  
      /**
       * division element.
       */
      private static final String ELEMENT_DIV = "div";
  
      /**
       * Id attribute.
       */
      private static final String ATTR_ID = "id";
  
      /**
       * Class attribute.
       */
      private static final String ATTR_CLASS = "class";
  
      /**
       * RowSpan attribute.
       */
      protected static final String ATTR_ROWSPAN = "rowspan";
  
      /**
       * Table separator attribute.
       */
      protected static final String CLASS_SEPARATOR = "jhp-table-separator";
  
      /**
       * DocumentBuilder.
       */
      private final DocumentBuilder theBuilder;
  
      /**
       * Transformer.
      */
     private final Transformer theXformer;
 
     /**
      * The document.
      */
     private final Document theDocument;
 
     /**
      * StringBuilder.
      */
     private final StringBuilder theStringBuilder;
 
     /**
      * Message Formatter.
      */
     private final Formatter theFormatter;
 
     /**
      * The Document body.
      */
     private final Element theBody;
 
     /**
      * The WebControl.
      */
     private final WebControl theWebControl;
 
     /**
      * The Current section.
      */
     private Element theSection;
 
     /**
      * The Current table .
      */
     private Element theTable;
 
     /**
      * The Table Header row.
      */
     private Element theTableHdrRow;
 
     /**
      * The Table body.
      */
     private Element theTableBody;
 
     /**
      * The Current row.
      */
     private Element theRow;
 
     /**
      * The row count.
      */
     private int theRowCount;
 
     /**
      * Has the document been reset?
      */
     private boolean isReset = true;
 
     /**
      * Constructor.
      * @param pWeb is this a web page builder?
      * @throws PoolException on error
      */
     protected ReportBuilder(final boolean pWeb) throws PoolException {
         /* protect against exceptions */
         try {
             /* Create a Document builder */
             DocumentBuilderFactory myFactory = DocumentBuilderFactory.newInstance();
             theBuilder = myFactory.newDocumentBuilder();
             theDocument = theBuilder.newDocument();
 
             /* Create the transformer */
             TransformerFactory myXformFactory = TransformerFactory.newInstance();
             theXformer = myXformFactory.newTransformer();
 
             /* Create the formatter */
             theStringBuilder = new StringBuilder();
             theFormatter = new Formatter(theStringBuilder, Locale.getDefault());
 
             /* Create the HTML body */
             Element myHTML = theDocument.createElement("html");
             theDocument.appendChild(myHTML);
             Element myHead = theDocument.createElement("head");
             myHTML.appendChild(myHead);
 
             /* Create the body */
             theBody = theDocument.createElement("body");
             myHTML.appendChild(theBody);
 
             /* Switch on type of builder */
             if (pWeb) {
                 /* initialise the web builder */
                 theWebControl = initWebBuilder(myHead);
             } else {
                 /* initialise the report builder */
                 initReportBuilder(myHead);
                 theWebControl = null;
             }
 
         } catch (ParserConfigurationException | TransformerConfigurationException e) {
             throw new PoolException("Failed to initialise report builder", e);
         }
     }
 
     /**
      * Initialise the ReportBuilder.
      * @param pHeader the header
      */
     private void initReportBuilder(final Element pHeader) {
         /* Create the title */
         setTitle(pHeader, "Test");
 
         /* Link to the styleSheet */
         setStyleSheet(pHeader, getClass().getResource(CSS_STANDARD).toString());
 
         /* Current section is the body */
         theSection = theBody;
     }
 
     /**
      * Initialise the WebBuilder.
      * @param pHeader the header
      * @return the webControl
      */
     private WebControl initWebBuilder(final Element pHeader) {
         /* Create the title element */
         Element myTitle = setTitle(pHeader, null);
 
         /* Link to the styleSheets */
         setStyleSheet(pHeader, CSS_STANDARD);
         setStyleSheet(pHeader, CSS_WEB);
 
         /* Attach scripts */
         setScript(pHeader, "https://ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js");
         setScript(pHeader, JS_TABS);
 
         return new WebControl(myTitle);
     }
 
     /**
      * Set a title.
      * @param pHeader the header
      * @param pTitle the title
      * @return the title element
      */
     private Element setTitle(final Element pHeader,
                              final String pTitle) {
         /* Create the title */
         Element myTitle = theDocument.createElement("title");
         pHeader.appendChild(myTitle);
         if (pTitle != null) {
             myTitle.setTextContent(pTitle);
         }
         return myTitle;
     }
 
     /**
      * Set a styleSheet.
      * @param pHeader the header
      * @param pStyleSheet the styleSheet
      */
     private void setStyleSheet(final Element pHeader,
                                final String pStyleSheet) {
         /* Create the link */
         Element myLink = theDocument.createElement("link");
         pHeader.appendChild(myLink);
         myLink.setAttribute("REL", "StyleSheet");
         myLink.setAttribute("HREF", pStyleSheet);
         myLink.setAttribute("TYPE", "text/css");
         myLink.setAttribute("MEDIA", "screen, print");
     }
 
     /**
      * Set a script.
      * @param pHeader the header
      * @param pScript the script
      */
     private void setScript(final Element pHeader,
                            final String pScript) {
         /* Create the script */
         Element myScript = theDocument.createElement("script");
         pHeader.appendChild(myScript);
         myScript.setAttribute("type", "text/javascript");
         myScript.setAttribute("src", pScript);
     }
 
     /**
      * Clear an element.
      * @param pElement the element to clear
      */
     private void clearElement(final Element pElement) {
         /* Clear the existing document */
         while (pElement.hasChildNodes()) {
             pElement.removeChild(pElement.getFirstChild());
         }
     }
 
     /**
      * Is the document reset?
      * @return true/false
      */
     protected boolean isReset() {
         return isReset;
     }
 
     /**
      * Clear the document.
      */
     protected void resetDocument() {
         /* Clear body */
         clearElement(theBody);
         isReset = true;
     }
 
     /**
      * Set the title.
      * @param pTitle the title
      */
     protected void setTheTitle(final String pTitle) {
         theWebControl.setTheTitle(pTitle);
     }
 
     /**
      * Create a new section.
      * @param pTitle the title
      */
     protected void newSection(final String pTitle) {
         theWebControl.newSection(pTitle);
     }
 
     /**
      * Set a page break.
      */
     protected void setPageBreak() {
         /* Close any existing table */
         closeTable();
 
         /* Create the page break */
         Element myDiv = theDocument.createElement(ELEMENT_DIV);
         myDiv.setAttribute(ATTR_CLASS, "page-break");
         theSection.appendChild(myDiv);
     }
 
     /**
      * Set line space.
      */
     protected void setLineSpace() {
         /* Close any existing table */
         closeTable();
 
         /* Create the page break */
         Element myBreak = theDocument.createElement(ELEMENT_DIV);
         myBreak.setAttribute(ATTR_CLASS, "line-space");
         theSection.appendChild(myBreak);
     }
 
     /**
      * Set the heading.
      * @param pHeading the table heading
      * @param pArgs the variable arguments
      * @return the heading element
      */
     protected Element setHeading(final String pHeading,
                                  final Object... pArgs) {
         /* Close any existing table */
         closeTable();
         isReset = false;
 
         /* Format the message */
         theStringBuilder.setLength(0);
         theFormatter.format(pHeading, pArgs);
 
         /* Create the heading */
         Element myHeading = theDocument.createElement("h2");
         myHeading.setTextContent(theStringBuilder.toString());
         theSection.appendChild(myHeading);
         return myHeading;
     }
 
     /**
      * Close any table.
      */
     private void closeTable() {
         /* Close any existing table */
         theTable = null;
         theTableHdrRow = null;
         theTableBody = null;
         theRow = null;
     }
 
     /**
      * Create standard table.
      * @return the table element
      */
     protected Element newTable() {
         return newTable(null);
     }
 
     /**
      * Create small table.
      * @return the table element
      */
     protected Element newSmallTable() {
         return newTable("jhp-table-small");
     }
 
     /**
      * Create tiny table.
      * @return the table element
      */
     protected Element newTinyTable() {
         return newTable("jhp-table-tiny");
     }
 
     /**
      * Create table.
      * @param pClass the class of the table
      * @return the table element
      */
     private Element newTable(final String pClass) {
         isReset = false;
         theTable = theDocument.createElement("table");
         Element myHeader = theDocument.createElement("thead");
         theTable.appendChild(myHeader);
         theTableBody = theDocument.createElement("tbody");
         theTable.appendChild(theTableBody);
         theSection.appendChild(theTable);
         if (pClass != null) {
             theTable.setAttribute(ATTR_CLASS, pClass);
         }
 
         /* Create an active row for the headers */
         theTableHdrRow = theDocument.createElement("tr");
         myHeader.appendChild(theTableHdrRow);
         theTableHdrRow.setAttribute(ATTR_CLASS, "jhp-row-header");
 
         /* Clear row details */
         theRow = null;
         theRowCount = 0;
         return theTable;
     }
 
     /**
      * Set the table caption.
      * @param pCaption the caption
      * @param pArgs the variable arguments
      */
     protected void setTableCaption(final String pCaption,
                                    final Object... pArgs) {
         /* Format the message */
         theStringBuilder.setLength(0);
         theFormatter.format(pCaption, pArgs);
 
         /* Create the caption */
         Element myCaption = theDocument.createElement("caption");
         theTable.insertBefore(myCaption, theTable.getFirstChild());
         myCaption.setTextContent(theStringBuilder.toString());
     }
 
     /**
      * Set the next column heading.
      * @param pHeading the table heading
      * @return the cell element
      */
     protected Element setColumnHeading(final String pHeading) {
         Element myCell = theDocument.createElement("th");
         theTableHdrRow.appendChild(myCell);
         myCell.setTextContent(pHeading);
         return myCell;
     }
 
     /**
      * Set the next rotated column heading.
      * @param pHeading the table heading
      * @return the cell element
      */
     protected Element setRotatedColumnHeading(final String pHeading) {
         Element myCell = theDocument.createElement("th");
         myCell.setAttribute(ATTR_CLASS, "rotate");
         theTableHdrRow.appendChild(myCell);
         Element myDiv = theDocument.createElement(ELEMENT_DIV);
         myCell.appendChild(myDiv);
         Element mySpan = theDocument.createElement("span");
         myDiv.appendChild(mySpan);
         mySpan.setTextContent(pHeading);
         return myCell;
     }
 
     /**
      * Set the next row.
      * @return the row element
      */
     protected Element newRow() {
         theRow = theDocument.createElement("tr");
         theTableBody.appendChild(theRow);
         theRow.setAttribute(ATTR_CLASS, (theRowCount % 2 == 0)
                                                                ? "jhp-row-even"
                                                                : "jhp-row-odd");
         theRowCount++;
         return theRow;
     }
 
     /**
      * Set the next cell.
      * @param pData the cell contents
      * @param pClass the class of the cell
      * @return the cell element
      */
     private Element setCellData(final String pData,
                                 final String pClass) {
         Element myCell = theDocument.createElement("td");
         theRow.appendChild(myCell);
         if (pData != null) {
             myCell.setTextContent(pData);
             myCell.setAttribute(ATTR_CLASS, pClass);
         }
         return myCell;
     }
 
     /**
      * Set the next object cell.
      * @param pData the cell contents
      * @return the cell element
      */
     protected Element setCellObject(final Object pData) {
         return setCellData(pData == null
                                          ? null
                                          : pData.toString(),
                 "jhp-cell-data");
     }
 
     /**
      * Set the next fixture cell.
      * @param pData the cell contents
      * @return the cell element
      */
     protected Element setCellResult(final Result pData) {
         return setCellData(pData == null
                                          ? Fixture.MATCH_VERSUS
                                          : pData.toString(),
                 "jhp-cell-result");
     }
 
     /**
      * Set the next fixture cell.
      * @param pData the cell contents
      * @return the cell element
      */
     protected Element setCellNullResult(final Result pData) {
         return setCellData(pData == null
                                          ? "-"
                                          : pData.toString(),
                 "jhp-cell-null-result");
     }
 
     /**
      * Set the next date cell.
      * @param pData the cell contents
      * @return the cell element
      */
     protected Element setCellDate(final LocalDate pData) {
         return setCellData(pData == null
                                          ? null
                                          : DataParser.formatShortDate(pData),
                 "jhp-cell-date");
     }
 
     /**
      * Set the next integer cell.
      * @param pData the cell contents
      * @return the cell element
      */
     protected Element setCellInteger(final Integer pData) {
         return setCellData(pData == null
                                          ? null
                                          : Integer.toString(pData),
                 "jhp-cell-integer");
     }
 
     /**
      * Set the next left-aligned player cell.
      * @param pData the cell contents
      * @return the cell element
      */
     protected Element setCellId(final String pData) {
         return setCellData(pData == null
                                          ? null
                                          : pData,
                 "jhp-cell-id");
     }
 
     /**
      * Set the next right-aligned player cell.
      * @param pData the cell contents
      * @return the cell element
      */
     protected Element setCellPlayerRight(final Player pData) {
         return setCellData(pData == null
                                          ? null
                                          : pData.getName(),
                 "jhp-cell-name-right");
     }
 
     /**
      * Set the next left-aligned player cell.
      * @param pData the cell contents
      * @return the cell element
      */
     protected Element setCellPlayerLeft(final Player pData) {
         return setCellData(pData == null
                                          ? null
                                          : pData.getName(),
                 "jhp-cell-name-left");
     }
 
     /**
      * Set the next left-aligned contact cell.
      * @param pData the cell contents
      * @return the cell element
      */
     protected Element setCellContact(final Player pData) {
         return setCellData(pData == null
                                          ? null
                                          : pData.getContact(),
                 "jhp-cell-contact");
     }
 
     /**
      * Add class attribute.
      * @param pElement the element to add the attribute to
      * @param pAttr the attribute to add
      */
     protected void addClassAttribute(final Element pElement,
                                      final String pAttr) {
         /* determine whether we have an existing attribute */
         String myAttr = pElement.getAttribute(ATTR_CLASS);
 
         /* New attribute */
         if (myAttr.length() == 0) {
             /* Just set the attribute */
             pElement.setAttribute(ATTR_CLASS, pAttr);
 
             /* else existing attribute */
         } else {
             /* Build new attribute and set it */
             theStringBuilder.setLength(0);
             theStringBuilder.append(myAttr);
             theStringBuilder.append(' ');
             theStringBuilder.append(pAttr);
             pElement.setAttribute(ATTR_CLASS, theStringBuilder.toString());
         }
     }
 
     /**
      * Format report.
      * @return the formatted report
      * @throws PoolException on error
      */
     protected String formatReport() throws PoolException {
         /* protect against exceptions */
         try {
             /* Format the XML and write to stream */
             StringWriter myWriter = new StringWriter();
             theXformer.transform(new DOMSource(theDocument), new StreamResult(myWriter));
 
             /* Convert result to string */
             return myWriter.toString();
 
         } catch (TransformerException e) {
             throw new PoolException("Failed to format document", e);
         }
     }
 
     /**
      * copy Web Resources.
      * @param pDir the target directory
      * @throws PoolException on error
      */
     protected void copyWebResources(final Path pDir) throws PoolException {
 
         /* Protect against exceptions */
         try {
             /* If the directory does not exist */
             if (!Files.exists(pDir, LinkOption.NOFOLLOW_LINKS)) {
                 /* Create the directory */
                 Files.createDirectory(pDir);
             }
 
             /* Catch Exceptions */
         } catch (IOException e) {
             throw new PoolException("Failed to ensure directory", e);
         }
 
         /* Copy the various resources */
         copyResource(JS_TABS, pDir);
         copyResource(CSS_STANDARD, pDir);
         copyResource(CSS_WEB, pDir);
     }
 
     /**
      * copy Resource to file.
      * @param pName the resource to copy
      * @param pDir the target directory
      * @throws PoolException on error
      */
     private void copyResource(final String pName,
                               final Path pDir) throws PoolException {
         /* Protect against exceptions */
         Path myFile = pDir.resolve(pName);
         try (InputStream myStream = getClass().getResourceAsStream(pName)) {
             /* Copy the resource to the directory */
             Files.copy(myStream, myFile, StandardCopyOption.REPLACE_EXISTING);
 
             /* Catch Exceptions */
         } catch (IOException e) {
             throw new PoolException("Failed to copy resource", e);
         }
     }
 
     /**
      * Web Control class.
      */
     private final class WebControl {
         /**
          * Header.
          */
         private final Element theTitle;
 
         /**
          * Heading.
          */
         private final Element theHeading;
 
         /**
          * Tab Links.
          */
         private final Element theTabLinks;
 
         /**
          * Tabs.
          */
         private final Element theTabs;
 
         /**
          * Constructor.
          * @param pTitle the title element
          */
         private WebControl(final Element pTitle) {
             /* Store the parameters */
             theTitle = pTitle;
 
             /* Create the header division */
             Element myDiv = theDocument.createElement(ELEMENT_DIV);
             theBody.appendChild(myDiv);
             myDiv.setAttribute(ATTR_ID, "header");
             myDiv.setAttribute(ATTR_CLASS, "tabs");
 
             /* Create the title division */
             theHeading = theDocument.createElement("h2");
             myDiv.appendChild(theHeading);
 
             /* Create the tab links */
             theTabLinks = theDocument.createElement("ul");
             myDiv.appendChild(theTabLinks);
             theTabLinks.setAttribute(ATTR_CLASS, "tab-links");
 
             /* Create the contents division */
             theTabs = theDocument.createElement(ELEMENT_DIV);
             theBody.appendChild(theTabs);
             theTabs.setAttribute(ATTR_ID, "content");
             theTabs.setAttribute(ATTR_CLASS, "tabs tab-content");
         }
 
         /**
          * Set the document title.
          * @param pTitle the title
          */
         private void setTheTitle(final String pTitle) {
             /* Reset the links and tabs */
             clearElement(theTabLinks);
             clearElement(theTabs);
 
             /* Set the title */
             theTitle.setTextContent(pTitle);
             theHeading.setTextContent(pTitle);
         }
 
         /**
          * Create a new section.
          * @param pSection the new section title
          */
         private void newSection(final String pSection) {
             /* Create the new link */
             Element myItem = theDocument.createElement("li");
             theTabLinks.appendChild(myItem);
             Element myLink = theDocument.createElement("a");
             myItem.appendChild(myLink);
             myLink.setAttribute("href", "#" + pSection);
             myLink.setTextContent(pSection);
 
             /* Create the new section */
             Element mySection = theDocument.createElement(ELEMENT_DIV);
             mySection.setAttribute(ATTR_ID, pSection);
             mySection.setAttribute(ATTR_CLASS, "tab");
             theTabs.appendChild(mySection);
 
             /* If this is the first element */
             if (isReset) {
                 /* Mark as active */
                 myLink.setAttribute(ATTR_CLASS, "active");
                 addClassAttribute(mySection, "active");
             }
 
             /* record the section */
             theSection = mySection;
         }
     }
 }