TempXMLManager

/*
 * $Id: TempXMLManager.java 2993 2011-11-24 19:51:48Z andrewinkler $
 * ============================================================================
 * Project gluehloch-homepage-core
 * Copyright (c) 2004-2010 by Andre Winkler. All rights reserved.
 * ============================================================================
 *          GNU LESSER GENERAL PUBLIC LICENSE
 *  TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */

package de.awtools.homegen.xml;

import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.UnsupportedEncodingException;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;

import org.apache.commons.io.IOUtils;
import org.apache.commons.lang.StringUtils;
import org.dom4j.Document;
import org.dom4j.DocumentException;
import org.dom4j.Node;
import org.dom4j.io.OutputFormat;
import org.dom4j.io.SAXReader;
import org.dom4j.io.XMLWriter;

import de.awtools.homegen.TransformerException;
import de.awtools.xml.XMLUtils;

/**
 * Verwaltet die XML/HTML Schnipsel die nach dem ersten Transformationsprozeß
 * entstanden sind. Die XML/HTML Schnipsel besitzen folgende Struktur:
 * <pre>
 *   document/head -> Strukturinformationen: CSS.
 *   document/body -> Enthält HTML-Code. Wird 1:1 übernommen.
 * </pre>
 *
 * @version $LastChangedRevision: 2993 $ $LastChangedDate: 2011-11-24 20:51:48 +0100 (Thu, 24 Nov 2011) $
 * @author by Andre Winkler, $LastChangedBy: andrewinkler $
 */
public final class TempXMLManager {

    /** Zeichensatzcodierung. */
    private final String encoding;

    /** Der 'body' des XML/HTML Schnipsels. */
    private String body;

    /** Der 'title' für die HTML Seite. */
    private String title;

    /** Die einzubindenden CSS Dateien. */
    private List<String> cssImports;

    /**
     * Konstruktor.
     *
     * @param _encoding Zeichensatzkodierung (z.B. UTF-8).
     */
    public TempXMLManager(final String _encoding) {
        encoding = _encoding;
    }

    /**
     * Liefert den 'body' des XML/HTML Schnipsels. Der Inhalt des body Tags
     * ohne das 'body' Tag selbst.
     *
     * @return Der 'body'.
     */
    public String getBody() {
        return body;
    }

    /**
     * Liefert den 'title' für die HTML Seite.
     *
     * @return Der 'title'.
     */
    public String getTitle() {
        return title;
    }

    /**
     * Die lokal zu ergänzenden CSS Dateien.
     *
     * @return Ein Liste mit CSS Import Anweisungen.
     */
    public List<String> getCss() {
        return cssImports;
    }

    /**
     * Parst einen XML/HTML Schnipsel und stellt dessen Inhalt zur Verfügung.
     *
     * @param in Ein InputStream für einen XML/HTML Schnipsel.
     * @param name Der Name des InputStreams. I.d.R. der Dateiname oder eine
     *     andere ID, die den InputStream im Fehlerfall identifizieren kann.
     */
    public void parse(final InputStream in, final String name) {
        SAXReader reader = new SAXReader();
        reader.setStripWhitespaceText(false);
        try {
            Document document = reader.read(in);
            title = extractTitle(document);
            body = extractBody(document);
            cssImports = extractCss(document);
        } catch (DocumentException ex) {
            throw new TransformerException(name, ex);
        }
    }

    /**
     * Extrahiert den Titel für die HTML Seite.
     *
     * @param document Ein XML Dokument.
     * @return Der Titel für die HTML Seite.
     */
    private String extractTitle(final Document document) {
        Node node = document.selectSingleNode("//document/head/title");
        String result = null;
        if ((node != null) && (!StringUtils.isBlank(node.getText()))) {
            result = node.getText();
        }
        return result;
    }

    /**
     * Extrahiert die CSS Import Informationen.
     *
     * @param document Ein XML Dokument.
     * @return Die CSS Import Anweisungen.
     */
    private List<String> extractCss(final Document document) {
        List<?> nodes = document.selectNodes("//document/head/css");
        List<String> css = new ArrayList<String>(nodes.size());
        for (Iterator<?> i = nodes.iterator(); i.hasNext();) {
            Node node = (Node) i.next();
            css.add(node.getText());
        }
        return css;
    }

    /**
     * Extrahiert den Body und liefert diesen als String zurück ohne das
     * 'body' Tag selbst.
     *
     * @param document Ein XML Dokument.
     * @return Der Body.
     */
    private String extractBody(final Document document) {
        Node node = document.selectSingleNode("//document/body/.");
        String result = null;

        // Möglicherweise ist der Dokumenten-Body leer. Dann die nächsten
        // Schritte überspringen.
        if (node != null) {
            OutputFormat format = OutputFormat.createPrettyPrint();
            format.setEncoding(encoding);
            format.setNewlines(true);
            format.setLineSeparator("\n");
            format.setTrimText(false);

            ByteArrayOutputStream baos = new ByteArrayOutputStream();
            XMLWriter writer = null;
            try {
                writer = new XMLWriter(baos, format);
                writer.write(node);
            } catch (UnsupportedEncodingException ex) {
                throw new TransformerException(ex);
            } catch (IOException ex) {
                throw new TransformerException(ex);
            } finally {
                IOUtils.closeQuietly(baos);
                XMLUtils.close(writer);
            }

            result = StringUtils.replaceOnce(baos.toString(), "<body>", " ");
            result = StringUtils.replaceOnce(result, "</body>", " ");
            // @todo Problem:
            // javascript:menuManager.openHref('./subitem3.html'); wird nach
            // javascript:menuManager.openHref(&apos;./subitem3.html&apos;)
            // umgewandelt!
            result = StringUtils.replace(result, "&apos;", "'");
        }

        return result;
    }

}