source: main/trunk/greenstone3/src/java/org/greenstone/gsdl3/util/GSXSLT.java@ 26086

/*
 *    GSXSLT.java
 *    Copyright (C) 2008 New Zealand Digital Library, http://www.nzdl.org
 *
 *    This program is free software; you can redistribute it and/or modify
 *    it under the terms of the GNU General Public License as published by
 *    the Free Software Foundation; either version 2 of the License, or
 *    (at your option) any later version.
 *
 *    This program 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 General Public License for more details.
 *
 *    You should have received a copy of the GNU General Public License
 *    along with this program; if not, write to the Free Software
 *    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
package org.greenstone.gsdl3.util;

import java.io.File;
import java.util.ArrayList;
import java.util.Vector;

import org.greenstone.util.GlobalProperties;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;

import org.apache.log4j.*;

/** various functions for manipulating Greenstone xslt */
public class GSXSLT
{

    static Logger logger = Logger.getLogger(org.greenstone.gsdl3.util.GSXSLT.class.getName());

    public static void mergeStylesheets(Document main_xsl, Element extra_xsl, boolean overwrite)
    {
        mergeStylesheetsDebug(main_xsl, extra_xsl, overwrite, false, null, null);
    }

    /**
     * takes a stylesheet Document, and adds in any child nodes from extra_xsl
     * named templates overwrite any existing one, while match templates are
     * just added to the end of the stylesheet
     * 
     * elements are added in following order, and added to preserve original
     * order with imported ones coming after existing ones import, include,
     * output, variable, template
     */
    public static void mergeStylesheetsDebug(Document main_xsl, Element extra_xsl, boolean overwrite, boolean debug, String firstDocFileName, String secondDocFileName)
    {
        if (debug)
        {
            System.err.println("ADDING DEBUG ELEMENTS WITH FILE NAME " + firstDocFileName);
            insertDebugElements(main_xsl, firstDocFileName);
        }

        Element main = main_xsl.getDocumentElement();
        Node insertion_point = null;
        Element last_import = GSXML.getLastElementByTagNameNS(main, GSXML.XSL_NAMESPACE, "import");
        if (last_import != null)
        {
            insertion_point = last_import.getNextSibling();
        }
        else
        {
            insertion_point = main.getFirstChild();
        }

        // imports
        NodeList children = extra_xsl.getElementsByTagNameNS(GSXML.XSL_NAMESPACE, "import");
        for (int i = 0; i < children.getLength(); i++)
        {
            Element node = (Element) children.item(i);
            // If the new xsl:import element is identical (in terms of href attr value) 
            // to any in the merged document, don't copy it over
            if (GSXML.getNamedElementNS(main, GSXML.XSL_NAMESPACE, "import", "href", node.getAttribute("href")) == null)
            {
                // Import statements should be the first children of an xsl:stylesheet element
                // If firstchild is null, then this xsl:import element will be inserted at the "end"
                // Although Node.insertBefore() will first remove identical nodes before inserting, we check
                // only the href attribute to see if they're "identical" to any pre-existing <xsl:import>
                //main.insertBefore(main_xsl.importNode(node, true), main.getFirstChild());
                main.insertBefore(main_xsl.importNode(node, true), insertion_point);
            }
        }

        // do we have a new insertion point??
        Element last_include = GSXML.getLastElementByTagNameNS(main, GSXML.XSL_NAMESPACE, "include");
        if (last_include != null)
        {
            insertion_point = last_include.getNextSibling();
        }

        // includes
        children = extra_xsl.getElementsByTagNameNS(GSXML.XSL_NAMESPACE, "include");
        for (int i = 0; i < children.getLength(); i++)
        {
            Element node = (Element) children.item(i);
            // If the new xsl:include element is identical (in terms of href attr value)
            // to any in the merged document, don't copy it over
            // Although Node.appendChild() will first remove identical nodes before appending, we check
            // only the href attribute to see if they're "identical" to any pre-existing <xsl:include>
            if (GSXML.getNamedElementNS(main, GSXML.XSL_NAMESPACE, "include", "href", node.getAttribute("href")) == null)
            {
                //main.appendChild(main_xsl.importNode(node, true));
                main.insertBefore(main_xsl.importNode(node, true), insertion_point);
            }
        } // for each include

        if (main.getElementsByTagNameNS(GSXML.XSL_NAMESPACE, "output").getLength() == 0)
        {
            // outputs
            children = extra_xsl.getElementsByTagNameNS(GSXML.XSL_NAMESPACE, "output");
            for (int i = 0; i < children.getLength(); i++)
            {
                Element node = (Element) children.item(i);
                // If the new xsl:output element is identical (in terms of the value for the method attr) 
                // to any in the merged document, don't copy it over

                main.insertBefore(main_xsl.importNode(node, true), insertion_point);
            }
        }

        // variables - only top level ones!!
        // append to end of document
        children = GSXML.getChildrenByTagNameNS(extra_xsl, GSXML.XSL_NAMESPACE, "variable");
        for (int i = 0; i < children.getLength(); i++)
        {
            Element node = (Element) children.item(i);
            // If the new xsl:import element is identical (in terms of href attr value) 
            // to any in the merged document, don't copy it over
            if (GSXML.getNamedElementNS(main, GSXML.XSL_NAMESPACE, "variable", "name", node.getAttribute("name")) == null)
            {
                main.appendChild(main_xsl.importNode(node, true));
            }
        }

        // params - only top level ones!!
        // append to end of document
        children = GSXML.getChildrenByTagNameNS(extra_xsl, GSXML.XSL_NAMESPACE, "param");
        for (int i = 0; i < children.getLength(); i++)
        {
            Element node = (Element) children.item(i);
            // If the new xsl:import element is identical (in terms of href attr value) 
            // to any in the merged document, don't copy it over
            if (GSXML.getNamedElementNS(main, GSXML.XSL_NAMESPACE, "param", "name", node.getAttribute("name")) == null)
            {
                main.appendChild(main_xsl.importNode(node, true));
            }
        }

        // templates
        // append to end of document
        children = extra_xsl.getElementsByTagNameNS(GSXML.XSL_NAMESPACE, "template");
        for (int i = 0; i < children.getLength(); i++)
        {
            Element node = (Element) children.item(i);
            // remove any previous occurrences of xsl:template with the same value for name or match 
            String template_match = node.getAttribute("match");
            String template_name = node.getAttribute("name");
            String template_mode = node.getAttribute("mode");

            if (overwrite)
            {
                // if we have a name attribute, remove any other similarly named template
                GSXML.removeElementsWithAttributesNS(main, GSXML.XSL_NAMESPACE, "template", new String[] { "name", "match", "mode" }, new String[] { template_name, template_match, template_mode });

                // now add our good template in
                main.appendChild(main_xsl.importNode(node, true));
            }
            else
            {
                // if overwrite is false, then we only add in templates if they don't match something else.
                // In this case (eg from expanding imported stylesheets)
                // there can't be any duplicate named templates, so just look for matches
                // we already have the one with highest import precedence (from the top most level) so don't add any more in
                if (GSXML.getElementsWithAttributesNS(main, GSXML.XSL_NAMESPACE, "template", new String[] { "name", "match", "mode" }, new String[] { template_name, template_match, template_mode }).getLength() == 0)
                {
                    main.appendChild(main_xsl.importNode(node, true));
                }
            }
        }

        if (debug)
        {
            System.err.println("ADDING DEBUG ELEMENTS WITH FILE NAME " + secondDocFileName);
            insertDebugElements(main_xsl, secondDocFileName);
        }
    }

    protected static void insertDebugElements(Document doc, String fileName)
    {
        NodeList htmlTags = GSXML.getHTMLStructureElements(doc);
        System.err.println("HTML TAGS SIZE IS " + htmlTags.getLength());
        for (int i = 0; i < htmlTags.getLength(); i++)
        {
            Element current = (Element) htmlTags.item(i);
            if (current.getUserData("GSDEBUGFILENAME") == null)
            {
                Element xslParent = (Element) current.getParentNode();

                while (xslParent.getNamespaceURI() != GSXML.XSL_NAMESPACE && !xslParent.getNodeName().startsWith("xsl:"))
                {
                    xslParent = (Element) xslParent.getParentNode();
                }

                System.err.println("ADDING FILE NAME " + fileName);
                current.setUserData("GSDEBUGFILENAME", fileName, null);
                current.setUserData("GSDEBUGXML", xslParent.cloneNode(true), null);
            }
            else
            {
                System.err.println("ALREADY SET!");
            }
        }
    }

    public static void inlineImportAndIncludeFiles(Document doc, String pathExtra, String site, String collection, String interface_name, ArrayList<String> base_interfaces)
    {
        inlineImportAndIncludeFilesDebug(doc, pathExtra, false, null, site, collection, interface_name, base_interfaces);
    }

    public static void inlineImportAndIncludeFilesDebug(Document doc, String pathExtra, boolean debug, String docFileName, String site, String collection, String interface_name, ArrayList<String> base_interfaces)
    {
        XMLConverter converter = new XMLConverter();

        String path = (pathExtra == null) ? "" : pathExtra;

        NodeList importList = doc.getElementsByTagNameNS(GSXML.XSL_NAMESPACE, "import");
        NodeList includeList = doc.getElementsByTagNameNS(GSXML.XSL_NAMESPACE, "include");

        for (int i = 0; i < importList.getLength() + includeList.getLength(); i++)
        {
            Element current = (Element) ((i < importList.getLength()) ? importList.item(i) : includeList.item(i - importList.getLength()));
            String href = current.getAttribute("href");
            //String filePath = GSFile.interfaceHome(GlobalProperties.getGSDL3Home(), interface_name) + File.separator + "transform" + File.separator + path.replace("/", File.separator) + href.replace("/", File.separator);
            //String filePath = GSFile.stylesheetFile(GlobalProperties.getGSDL3Home(), site_name, collection, interface_name, base_interfaces, 

            try
            {
                //Document inlineDoc = converter.getDOM(new File(filePath), "UTF-8");
                Document inlineDoc = mergedXSLTDocumentCascade(path + href, site, collection, interface_name, base_interfaces, debug);
                String newPath = path;
                int lastSepIndex = href.lastIndexOf("/");
                if (lastSepIndex != -1)
                {
                    newPath += href.substring(0, lastSepIndex + 1);
                }

                //Do this recursively
                inlineImportAndIncludeFilesDebug(inlineDoc, newPath, debug, "merged " + href/* filePath */, site, collection, interface_name, base_interfaces);

                GSXSLT.mergeStylesheetsDebug(doc, inlineDoc.getDocumentElement(), false, debug, docFileName, /* filePath */"merged " + href);
            }
            catch (Exception ex)
            {
                ex.printStackTrace();
                return;
            }
        }

        while (importList.getLength() > 0)
        {
            Element importElem = (Element) importList.item(0);
            importElem.getParentNode().removeChild(importElem);
        }
        while (includeList.getLength() > 0)
        {
            Element includeElem = (Element) includeList.item(0);
            includeElem.getParentNode().removeChild(includeElem);
        }
    }

    public static Document mergedXSLTDocumentCascade(String xslt_filename, String site, String collection, String this_interface, ArrayList<String> base_interfaces, boolean debug)
    {
        XMLConverter converter = new XMLConverter();
        // find the list of stylesheets with this name
        ArrayList<File> stylesheets = GSFile.getStylesheetFiles(GlobalProperties.getGSDL3Home(), site, collection, this_interface, base_interfaces, xslt_filename);
        if (stylesheets.size() == 0)
        {
            logger.error(" Can't find stylesheet for " + xslt_filename);
            return null;
        }
        logger.debug("Stylesheet: " + xslt_filename);

        Document finalDoc = converter.getDOM(stylesheets.get(stylesheets.size() - 1), "UTF-8");
        if (finalDoc == null)
        {
            return null;
        }

        for (int i = stylesheets.size() - 2; i >= 0; i--)
        {
            Document currentDoc = converter.getDOM(stylesheets.get(i), "UTF-8");
            if (currentDoc == null)
            {
                return null;
            }

            if (debug)
            {
                GSXSLT.mergeStylesheetsDebug(finalDoc, currentDoc.getDocumentElement(), true, true, stylesheets.get(stylesheets.size() - 1).getAbsolutePath(), stylesheets.get(i).getAbsolutePath());
            }
            else
            {
                GSXSLT.mergeStylesheets(finalDoc, currentDoc.getDocumentElement(), true);
            }
        }

        return finalDoc;
    }

    public static void modifyConfigFormatForDebug(Document doc, String fileName)
    {
        NodeList templateNodes = doc.getElementsByTagNameNS(GSXML.XSL_NAMESPACE, "template");
        if (templateNodes.getLength() == 0)
        {
            templateNodes = doc.getElementsByTagName("xsl:template");
        }

        String debugElementString = "";
        debugElementString += "<span class=\"configDebugSpan\" style=\"display:none;\">";
        debugElementString += "  \"filename\":\"" + fileName + "\",";
        debugElementString += "  \"xml\":\"<xsl:value-of select=\"util:xmlNodeToString(.)\"/>\""; //<xsl:copy><xsl:copy-of select=\"@*\"/></xsl:copy>
        debugElementString += "</span>";

        XMLConverter converter = new XMLConverter();
        Element debugElement = (Element) converter.getDOM("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<xslt:stylesheet version=\"1.0\" xmlns:xsl=\"" + GSXML.XSL_NAMESPACE + "\" xmlns:xslt=\"output.xsl\" xmlns:gsf=\"" + GSXML.GSF_NAMESPACE + "\">" + debugElementString + "</xslt:stylesheet>").getDocumentElement().getFirstChild();

        for (int i = 0; i < templateNodes.getLength(); i++)
        {
            Element currentTemplate = (Element) templateNodes.item(i);
            if (currentTemplate.getAttribute("match") != null && (currentTemplate.getAttribute("match").equals("gsf:metadata") || currentTemplate.getAttribute("match").equals("*") || currentTemplate.getAttribute("match").equals("format")))
            {
                continue;
            }

            if (currentTemplate.hasChildNodes())
            {
                currentTemplate.insertBefore(doc.importNode(debugElement.cloneNode(true), true), currentTemplate.getFirstChild());
            }
            else
            {
                currentTemplate.appendChild(doc.importNode(debugElement.cloneNode(true), true));
            }
        }
    }

    /**
     * takes any import or include nodes, and creates absolute path names for
     * the files
     */
    public static void absoluteIncludePaths(Document stylesheet, String gsdl3_home, String site_name, String collection, String interface_name, ArrayList<String> base_interfaces)
    {
        Element base_node = stylesheet.getDocumentElement();
        if (base_node == null)
        {
            return;
        }
        Node child = base_node.getFirstChild();
        while (child != null)
        {
            String name = child.getNodeName();
            if (name.equals("xsl:import") || name.equals("xsl:include"))
            {
                ((Element) child).setAttribute("href", GSFile.stylesheetFile(gsdl3_home, site_name, collection, interface_name, base_interfaces, ((Element) child).getAttribute("href")));
            }
            child = child.getNextSibling();
        }
    }

    /**
     * looks through a stylesheet for <xxx:template match='template_name'>
     * inside this template it looks for any <xxx:value-of
     * select='metadataList/metadata[@name=yyy]> elements, and extracts the
     * metadata names into a Vector
     */
    public static Vector<String> extractWantedMetadata(Document stylesheet, String template_name)
    {

        Vector<String> metadata = new Vector<String>();
        Element base_node = stylesheet.getDocumentElement();
        NodeList templates = base_node.getElementsByTagNameNS("*", "template");
        for (int i = 0; i < templates.getLength(); i++)
        {
            Element template = (Element) templates.item(i);
            String match_name = template.getAttribute("match");
            if (!match_name.equals(template_name))
            {
                continue; // we're only looking for specific templates
            }
            String mode = template.getAttribute("mode");
            if (!mode.equals(""))
            {
                continue; // we only want ones without modes - these are processing ones, not display ones
            }
            // we have one that we want to look through
            NodeList values = template.getElementsByTagNameNS("*", "value-of");
            for (int v = 0; v < values.getLength(); v++)
            {
                String select = ((Element) values.item(v)).getAttribute("select");
                if (select.startsWith("metadataList/metadata[@name="))
                {
                    String[] bits = select.split("'|\"");
                    // there should be two quotes in teh string, therefore 3 items, and the second one is teh one we want
                    String name = bits[1];
                    metadata.add(name);
                }
            }
        }
        return metadata;
    }

    public static void mergeFormatElements(Element mainFormat, Element secondaryFormat, boolean overwrite)
    {
        NodeList xslChildren = GSXML.getChildrenByTagNameNS(secondaryFormat, GSXML.XSL_NAMESPACE, "variable");
        NodeList gsfChildren = GSXML.getChildrenByTagNameNS(secondaryFormat, GSXML.GSF_NAMESPACE, "variable");
        for (int i = 0; i < xslChildren.getLength() + gsfChildren.getLength(); i++)
        {
            Element node = (Element) ((i < xslChildren.getLength()) ? xslChildren.item(i) : gsfChildren.item(i - xslChildren.getLength()));
            if (GSXML.getNamedElementNS(mainFormat, "http://www.w3.org/1999/XSL/Transform", "variable", "name", node.getAttribute("name")) == null && GSXML.getNamedElementNS(mainFormat, "http://www.greenstone.org/greenstone3/schema/ConfigFormat", "variable", "name", node.getAttribute("name")) == null)
            {
                mainFormat.appendChild(node);
            }
        }

        xslChildren = GSXML.getChildrenByTagNameNS(secondaryFormat, GSXML.XSL_NAMESPACE, "param");
        gsfChildren = GSXML.getChildrenByTagNameNS(secondaryFormat, GSXML.GSF_NAMESPACE, "param");
        for (int i = 0; i < xslChildren.getLength() + gsfChildren.getLength(); i++)
        {
            Element node = (Element) ((i < xslChildren.getLength()) ? xslChildren.item(i) : gsfChildren.item(i - xslChildren.getLength()));
            if (GSXML.getNamedElementNS(mainFormat, "http://www.w3.org/1999/XSL/Transform", "param", "name", node.getAttribute("name")) == null && GSXML.getNamedElementNS(mainFormat, "http://www.greenstone.org/greenstone3/schema/ConfigFormat", "param", "name", node.getAttribute("name")) == null)
            {
                mainFormat.appendChild(node);
            }
        }

        xslChildren = GSXML.getChildrenByTagNameNS(secondaryFormat, GSXML.XSL_NAMESPACE, "template");
        gsfChildren = GSXML.getChildrenByTagNameNS(secondaryFormat, GSXML.GSF_NAMESPACE, "template");
        for (int i = 0; i < xslChildren.getLength() + gsfChildren.getLength(); i++)
        {
            Element node = (Element) ((i < xslChildren.getLength()) ? xslChildren.item(i) : gsfChildren.item(i - xslChildren.getLength()));
            // remove any previous occurrences of xsl:template with the same value for name or match 
            String template_match = node.getAttribute("match");
            String template_name = node.getAttribute("name");
            String template_mode = node.getAttribute("mode");

            String[] attributeNames = new String[] { "name", "match", "mode" };
            String[] attributeValues = new String[] { template_name, template_match, template_mode };

            if (overwrite)
            {
                // if we have a name attribute, remove any other similarly named template
                GSXML.removeElementsWithAttributesNS(mainFormat, GSXML.XSL_NAMESPACE, "template", attributeNames, attributeValues);
                GSXML.removeElementsWithAttributesNS(mainFormat, GSXML.GSF_NAMESPACE, "template", attributeNames, attributeValues);

                // now add our good template in
                mainFormat.appendChild(node);
            }
            else
            {
                // if overwrite is false, then we only add in templates if they don't match something else.
                // In this case (eg from expanding imported stylesheets)
                // there can't be any duplicate named templates, so just look for matches
                // we already have the one with highest import precedence (from the top most level) so don't add any more in
                if (GSXML.getElementsWithAttributesNS(mainFormat, "http://www.w3.org/1999/XSL/Transform", "template", attributeNames, attributeValues).getLength() == 0 && GSXML.getElementsWithAttributesNS(mainFormat, "http://www.greenstone.org/greenstone3/schema/ConfigFormat", "template", attributeNames, attributeValues).getLength() == 0)
                {
                    mainFormat.appendChild(node);
                }
            }
        }

        gsfChildren = GSXML.getChildrenByTagNameNS(secondaryFormat, GSXML.GSF_NAMESPACE, "option");
        for (int i = 0; i < gsfChildren.getLength(); i++)
        {
            Element node = (Element) gsfChildren.item(i);
            if (GSXML.getNamedElementNS(mainFormat, GSXML.GSF_NAMESPACE, "option", "name", node.getAttribute("name")) == null)
            {
                mainFormat.appendChild(node);
            }
        }
    }
}