de.ingrid.portal.portlets.HelpPortlet.java Source code

Introduction

Here is the source code for de.ingrid.portal.portlets.HelpPortlet.java

Source

/*
 * **************************************************-
 * Ingrid Portal Apps
 * ==================================================
 * Copyright (C) 2014 - 2015 wemove digital solutions GmbH
 * ==================================================
 * Licensed under the EUPL, Version 1.1 or  as soon they will be
 * approved by the European Commission - subsequent versions of the
 * EUPL (the "Licence");
 * 
 * You may not use this work except in compliance with the Licence.
 * You may obtain a copy of the Licence at:
 * 
 * http://ec.europa.eu/idabc/eupl5
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the Licence is distributed on an "AS IS" basis,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the Licence for the specific language governing permissions and
 * limitations under the Licence.
 * **************************************************#
 */
package de.ingrid.portal.portlets;

import java.io.IOException;

import javax.portlet.PortletConfig;
import javax.portlet.PortletException;
import javax.portlet.RenderRequest;
import javax.portlet.RenderResponse;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.stream.StreamSource;

import org.apache.portals.bridges.velocity.GenericVelocityPortlet;
import org.apache.velocity.context.Context;
import org.dom4j.Document;
import org.dom4j.DocumentHelper;
import org.dom4j.io.DocumentResult;
import org.dom4j.io.DocumentSource;
import org.dom4j.io.SAXReader;
import org.dom4j.tree.DefaultElement;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import de.ingrid.portal.global.IngridResourceBundle;
import de.ingrid.portal.global.Utils;

/**
 * TODO Describe your created type (class, etc.) here.
 *
 * @author joachim@wemove.com
 */
public class HelpPortlet extends GenericVelocityPortlet {

    private final static Logger log = LoggerFactory.getLogger(HelpPortlet.class);

    /**
     * @see org.apache.portals.bridges.velocity.GenericVelocityPortlet#doView(javax.portlet.RenderRequest, javax.portlet.RenderResponse)
     */
    public void doView(RenderRequest request, RenderResponse response) throws PortletException, IOException {
        Context context = getContext(request);

        IngridResourceBundle messages = new IngridResourceBundle(
                getPortletConfig().getResourceBundle(request.getLocale()), request.getLocale());
        context.put("MESSAGES", messages);

        // find help file according to the language
        String lang = Utils.checkSupportedLanguage(request.getLocale().getLanguage());
        String fileName = "ingrid-portal-help_" + lang + ".xml";
        String filePath = null;
        try {
            filePath = Utils.getResourceAsStream(fileName);
        } catch (Exception e1) {
            log.warn(fileName + " not found!");
        }
        if (filePath == null) {
            try {
                filePath = Utils.getResourceAsStream("ingrid-portal-help.xml");
            } catch (Exception e) {
                log.error("ingrid-portal-help.xml not found!");
            }
        }

        // read help resource
        SAXReader xmlReader = new SAXReader();
        Document doc = null;
        try {
            doc = xmlReader.read(filePath);
        } catch (Exception e) {
            log.error("Error reading help source file: " + filePath, e);
        }

        // get the help chapter
        String helpKey = request.getParameter("hkey");
        if (helpKey == null) {
            helpKey = "index";
        }

        // read help chapter
        Object chapterObj = null;
        String myPath = "//section[@help-key='" + helpKey + "']/ancestor::chapter";
        try {
            chapterObj = doc.selectSingleNode(myPath);
        } catch (Throwable t) {
            log.error("Error reading '" + myPath + "' from help source file: " + filePath, t);
        }

        // transform the xml content to valid html using xslt
        if (chapterObj == null) {
            context.put("help_content", "<p>help key (" + helpKey + ") not found!</p>");
        } else {
            TransformerFactory factory;
            try {
                factory = TransformerFactory.newInstance();
            } catch (Throwable t) {
                System.setProperty("javax.xml.transform.TransformerFactory",
                        "com.sun.org.apache.xalan.internal.xsltc.trax.TransformerFactoryImpl");
                factory = TransformerFactory.newInstance();
            }

            try {
                StreamSource stylesheet = new StreamSource(Utils.getResourceAsStream("ingrid-portal-help.xsl"));
                Transformer transformer = factory.newTransformer(stylesheet);
                DocumentResult result = new DocumentResult();
                String subtree = ((DefaultElement) chapterObj).asXML();
                DocumentSource source = new DocumentSource(DocumentHelper.parseText(subtree));

                transformer.transform(source, result);
                String helpContent = result.getDocument().asXML();
                context.put("help_content", helpContent);
            } catch (Exception e) {
                log.error("Error processing help entry!", e);
            }
        }

        super.doView(request, response);
    }

    /**
     * @see org.apache.portals.bridges.velocity.GenericVelocityPortlet#init(javax.portlet.PortletConfig)
     */
    public void init(PortletConfig config) throws PortletException {
        super.init(config);
    }

}