grails.plugin.freemarker.GrailsFreeMarkerView Maven / Gradle / Ivy

Go to download
/*
* Copyright 2009-2011 the original author or authors.
*
* 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 grails.plugin.freemarker;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.grails.web.util.WebUtils;
import org.springframework.beans.BeansException;
import org.springframework.web.servlet.view.freemarker.FreeMarkerConfig;
import org.springframework.web.servlet.view.freemarker.FreeMarkerView;

import javax.servlet.ServletContext;
import javax.servlet.http.HttpServletRequest;
import java.util.Locale;
import java.util.Map;

/**
 * @author Jeff Brown
 * @author Joshua Burnett
 */
//request.setAttribute(GrailsLayoutDecoratorMapper.RENDERING_VIEW, Boolean.TRUE);
public class GrailsFreeMarkerView extends FreeMarkerView {
    protected final Log log = LogFactory.getLog(getClass());
    public FreeMarkerConfig freeMarkerConfigurer;

    @Override
    protected void exposeHelpers(Map model, HttpServletRequest request) throws Exception {
        //for Grails 2 we need to set this so sitemesh works
        request.setAttribute("org.grails.rendering.view", true);
        model.put("flash", WebUtils.retrieveGrailsWebRequest().getAttributes().getFlashScope(request));
        super.exposeHelpers(model, request);
    }

    /**
     * called on instantiation,
     * overrides the super default so that it uses the FreeMarkerConfigurer that is
     * injected into this without doing a new TaglibFactory each time. We have grails taglibs and dont need jsp taglibs
     * the freemarker config already has one setup
     * also, the old way only allowed 1 FreeMarkerConfig bean. This lets you have multiple FreeMarkerConfigs if need be.
     * we don't need the
     */
    @Override
    protected void initServletContext(ServletContext servletContext) throws BeansException {
        setConfiguration(freeMarkerConfigurer.getConfiguration());
    }

    /**
     * Check that the FreeMarker template used for this view exists and is valid.
     * Can be overridden to customize the behavior, for example in case of
     * multiple templates to be rendered into a single view.
     */
    @Override
    public boolean checkResource(Locale locale) throws Exception {
        log.debug("Checking resource");
        boolean gotit =  super.checkResource(locale);
        if(gotit){
            log.debug("checkResource found: " + getUrl());
        }
        return gotit;
    }

}