de.betterform.agent.web.WebFactory.java Source code

Java tutorial

Introduction

Here is the source code for de.betterform.agent.web.WebFactory.java

Source

/*
 * Copyright (c) 2012. betterFORM Project - http://www.betterform.de
 * Licensed under the terms of BSD License
 */

package de.betterform.agent.web;

import de.betterform.agent.web.cache.XFSessionCache;
import de.betterform.generator.XSLTGenerator;
import de.betterform.xml.config.Config;
import de.betterform.xml.config.XFormsConfigException;
import de.betterform.xml.xslt.TransformerService;
import de.betterform.xml.xslt.impl.CachingTransformerService;
import de.betterform.xml.xslt.impl.ClasspathResourceResolver;
import de.betterform.xml.xslt.impl.FileResourceResolver;
import de.betterform.xml.xslt.impl.HttpResourceResolver;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.log4j.xml.DOMConfigurator;

import javax.servlet.ServletContext;
import java.io.File;
import java.io.UnsupportedEncodingException;
import java.net.MalformedURLException;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URL;
import java.nio.charset.StandardCharsets;

/**
 * @author Joern Turner
 * 
 */
public class WebFactory {
    private static final Log LOGGER = LogFactory.getLog(WebFactory.class);
    public static final String BETTERFORM_CONFIG_PATH = "betterform.configfile";
    public static final String LOG_CONFIG = "log4j.file";
    public static final String BETTERFORM_SUBMISSION_RESPONSE = "betterform.submission.response";
    public static final String XSLT_CACHE_PROPERTY = "xslt.cache.enabled";

    public static final String UPLOADDIR_PROPERTY = "uploadDir";
    public static final String RELATIVE_URI_PROPERTY = "forms.uri.relative";
    public static final String ERROPAGE_PROPERTY = "error.page";

    public static final String XFORMS_NODE = "XFormsInputNode";
    public static final String XFORMS_INPUTSTREAM = "XFormsInputStream";
    public static final String XFORMS_INPUTSOURCE = "XFormsInputSource";
    public static final String XFORMS_URI = "XFormsInputURI";
    public static final String FORM_PARAM_NAME = "form";
    public static final String IGNORE_RESPONSEBODY = "filter.ignoreResponseBody";

    private ServletContext servletContext;
    private Config config;
    public static final String USER_AGENT = "useragent";
    public static final String PARSE_RESPONSE_BODY = "betterform.filter.parseResponseBody";
    public static final String IGNORE_RESPONSE_BODY = "betterform.filter.ignoreResponseBody";
    public static final String ACCEPT_CONTENTTYPE = "acceptContentTypePattern";
    public static final String ALL_XML_TYPES = "all_xml";
    private String userAgentId;
    private static final String DO_INIT_LOGGING = "initLogging";

    public WebFactory() {
    }

    public ServletContext getServletContext() {
        return this.servletContext;
    }

    public void setServletContext(ServletContext servletContext) {
        this.servletContext = servletContext;
    }

    public Config getConfig() {
        return this.config;
    }

    /**
     * factory method to create a WebProcessor which itself is a Decorator of XFormsProcessor
     * @param request
     * @return
     * @throws XFormsConfigException
     */
    /*public static WebProcessor createWebProcessor(HttpServletRequest request) throws XFormsConfigException {
    String useragent;
    if (request.getParameter(WebFactory.USER_AGENT) != null) {
        //passed as request param
        useragent = request.getParameter(WebFactory.USER_AGENT);
    } else if (request.getHeader(WebFactory.USER_AGENT) != null) {
        //passed as http header
        useragent = request.getHeader(WebFactory.USER_AGENT);
    } else if (request.getAttribute(WebFactory.USER_AGENT) != null) {
        useragent = (String) request.getAttribute(WebFactory.USER_AGENT);
    } else {
        throw new XFormsConfigException("Useragent has not been set.");
    }
        
    WebProcessor processor;
    Map useragents = Config.getInstance().getUserAgents();
    String className="";
    if(useragents.containsKey(useragent)){
        try {
            className = (String) useragents.get(useragent);
            Class clazz = Class.forName(className,true, WebFactory.class.getClassLoader());
            Object o = clazz.newInstance();
            if (!(o instanceof XFormsProcessor)) {
                throw new XFormsConfigException("This useragent is not configured properly: '" + useragent + "'");
    }
            processor = (WebProcessor) o;
            processor.setUseragent(useragent);
            return processor;
        }
        catch (ClassNotFoundException cnfe) {
            throw new XFormsConfigException(cnfe);
        }
        catch (ClassCastException cce) {
            throw new XFormsConfigException(cce);
        }
        catch (InstantiationException ie) {
            throw new XFormsConfigException(ie);
        }
        catch (IllegalAccessException iae) {
            throw new XFormsConfigException(iae);
        }
        
    }
    if (LOGGER.isInfoEnabled()) {
        LOGGER.info("request URI: " + request.getRequestURI());
        LOGGER.info("using user agent: " + useragent + " : " + useragent);
    }
    throw new XFormsConfigException("Processor class : '" + className + "' cannot be instanciated");
    }*/

    /**
     * reads the the context param 'betterform.configfile' to get the location of the configuration file. Then
     * the configuration will be initialized and stored within the servlet context. It may be accessed by using the constant key
     * AbstractXFormsServlet.BETTERFORM_CONFIGURATION.
     *
     * @param userAgentIdent a valid user agent identifier (either 'dojo' or 'html' at the moment)
     * @throws javax.servlet.ServletException if something goes terribly wrong with accessing the servlet context.
     */
    public void initConfiguration(String userAgentIdent) throws XFormsConfigException {
        LOGGER.info("--------------- initing betterForm... ---------------");
        this.userAgentId = userAgentIdent;
        String configPath = this.servletContext.getInitParameter("betterform.configfile");
        if (configPath == null) {
            throw new XFormsConfigException("Parameter 'betterform.configfile' not specified in web.xml");
        }
        String realPath = this.getRealPath(configPath, this.servletContext);
        this.config = Config.getInstance(realPath);
        //        this.config = Config.getInstance(this.servletContext.getResourceAsStream(configPath));
    }

    /**
     * initializes a XSLT Transformer service. Currently an implementation of CachingTransformerService is
     * instanciated. Future versions may make this configurable. This is the place to preload transformations
     * that are used throughout the application.
     *
     * @throws XFormsConfigException a Config exception will occur in case there's no valid setting for XSLT_CACHE_PROPERTY,XSLT_DEFAULT_PROPERTY or
     *                               XSLT_PATH_PROPERTY
     */
    public void initTransformerService(String realPath) throws XFormsConfigException {
        CachingTransformerService transformerService = new CachingTransformerService();

        transformerService.addResourceResolver(new FileResourceResolver());
        transformerService.addResourceResolver(new ClasspathResourceResolver(realPath));
        transformerService.addResourceResolver(new HttpResourceResolver());

        boolean xsltCacheEnabled = Config.getInstance().getProperty(WebFactory.XSLT_CACHE_PROPERTY)
                .equalsIgnoreCase("true");

        String xsltPath = WebProcessor.RESOURCE_DIR + "xslt/";
        //        String xsltDefault = Config.getInstance().getStylesheet(this.userAgentId);
        //        String xsltDefault = Config.getInstance().getStylesheet(this.userAgentId);
        String xsltDefault = Config.getInstance().getProperty("ui-transform");

        if (xsltCacheEnabled) {
            if (LOGGER.isDebugEnabled()) {
                LOGGER.debug("initializing xslt cache");
            }

            try {
                // load default stylesheet
                URI defaultTransformUri = getXsltURI(xsltPath, xsltDefault);
                transformerService.getTransformer(defaultTransformUri);

                URI errorTransformer = getXsltURI(xsltPath, "error.xsl");
                transformerService.getTransformer(errorTransformer);

                URI highlightingErrorTransformer = getXsltURI(xsltPath, "highlightError.xsl");
                transformerService.getTransformer(highlightingErrorTransformer);

                if (Config.getInstance().getProperty("betterform.debug-allowed").equals("true")) {
                    URI highlightingDocument = getXsltURI(xsltPath, "highlightDocument.xsl");
                    transformerService.getTransformer(highlightingDocument);
                }
                if (Config.getInstance().getProperty("webprocessor.doIncludes", "false").equals("true")) {
                    URI IncludeDocument = getXsltURI(xsltPath, "include.xsl");
                    transformerService.getTransformer(IncludeDocument);
                }
            } catch (Exception e) {
                throw new XFormsConfigException(e);
            }
        }

        // store service in servlet context
        // todo: contemplate about transformer service thread-safety
        servletContext.setAttribute(TransformerService.TRANSFORMER_SERVICE, transformerService);
    }

    public static XSLTGenerator setupTransformer(URI uri, ServletContext context) throws URISyntaxException {
        TransformerService transformerService = (TransformerService) context
                .getAttribute(TransformerService.TRANSFORMER_SERVICE);

        XSLTGenerator generator = new XSLTGenerator();
        generator.setTransformerService(transformerService);
        generator.setStylesheetURI(uri);
        return generator;
    }

    public URI getXsltURI(String xsltPath, String xsltDefault) throws URISyntaxException, XFormsConfigException {
        String resolvePath = getRealPath(xsltPath + xsltDefault, servletContext);
        String pathToXSLDirectory = resolvePath.substring(0, resolvePath.lastIndexOf(File.separator));
        return new File(pathToXSLDirectory).toURI().resolve(new URI(xsltDefault));
    }

    public void initLogging(Class theClass) throws XFormsConfigException {
        String initLogging = this.config.getProperty(WebFactory.DO_INIT_LOGGING);

        if (initLogging.equals("true")) {
            String pathToLog4jConfig = getRealPath(this.config.getProperty(WebFactory.LOG_CONFIG), servletContext);
            File log4jFile = new File(pathToLog4jConfig);
            if (log4jFile.exists()) {
                DOMConfigurator.configure(pathToLog4jConfig);
                if (LOGGER.isDebugEnabled()) {
                    LOGGER.debug("Logger initialized");
                }
            } else {
                if (LOGGER.isWarnEnabled()) {
                    LOGGER.warn("Could not find " + pathToLog4jConfig);
                }
            }
        }
    }

    /**
     * allow absolute paths otherwise resolve relative to the servlet context
     *
     * @param resolvePath XPath locationpath
     * @return the absolute path or path relative to the servlet context
     * @deprecated
     */
    public static final String resolvePath(String resolvePath, ServletContext servletContext) {
        String path = resolvePath;
        try {
            if (path != null && !(path.startsWith("/"))) {
                path = "/" + path;
            }
            URL pathURL = servletContext.getResource(path);
            if (pathURL != null) {
                path = java.net.URLDecoder.decode(pathURL.getPath(), StandardCharsets.UTF_8.name());
            }
        } catch (MalformedURLException e) {
            e.printStackTrace();
        } catch (UnsupportedEncodingException ex) {
            ex.printStackTrace();
        }
        return path;
    }

    public void initXFormsSessionCache() throws XFormsConfigException {
        XFSessionCache.getCache();
    }

    /**
     * get the absolute file path for a given relative path in the webapp. Handles some differences in server behavior
     * with the execution of context.getRealPath on various servers/operating systems
     *
     * @param path    a path relative to the context root of the webapp
     * @param context the servletcontext
     * @return the absolute file path for given relative webapp path
     */
    public static String getRealPath(String path, ServletContext context) throws XFormsConfigException {
        if (path == null) {
            path = "/";
        }
        if (!path.startsWith("/")) {
            path = "/" + path;
        }
        try {
            URI resourceURI = null;
            String computedRealPath = null;
            URL rootURL = Thread.currentThread().getContextClassLoader().getResource("/");
            URL resourceURL = context.getResource(path);

            if (rootURL != null) {
                resourceURI = rootURL.toURI();
            }

            if (resourceURI != null && resourceURI.getScheme().equalsIgnoreCase("file")) {
                String resourcePath = rootURL.getPath();
                String rootPath = new File(resourcePath).getParentFile().getParent();
                computedRealPath = new File(rootPath, path).getAbsolutePath();
            } else if (resourceURL != null) {
                computedRealPath = new File(resourceURL.toExternalForm(), path).getAbsolutePath();
            } else {
                String resourcePath = context.getRealPath("/");
                computedRealPath = new File(resourcePath, path).getAbsolutePath();
            }
            return java.net.URLDecoder.decode(computedRealPath, StandardCharsets.UTF_8.name());
        } catch (UnsupportedEncodingException e) {
            throw new XFormsConfigException("path could not be resolved: " + path, e);
        } catch (URISyntaxException e) {
            throw new XFormsConfigException("path could not be resolved: " + path, e);
        } catch (MalformedURLException e) {
            throw new XFormsConfigException("path could not be resolved: " + path, e);
        }
    }
}