src/web/org/codehaus/groovy/grails/web/servlet/DefaultGrailsApplicationAttributes.java

   1 /* Copyright 2004-2005 the original author or authors.
   2  *
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at
   6  *
   7  *      http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15 package org.codehaus.groovy.grails.web.servlet;
  16
  17 import groovy.lang.GroovyObject;
  18 import org.apache.commons.logging.Log;
  19 import org.apache.commons.logging.LogFactory;
  20 import org.codehaus.groovy.grails.commons.GrailsApplication;
  21 import org.codehaus.groovy.grails.commons.GrailsTagLibClass;
  22 import org.codehaus.groovy.grails.commons.TagLibArtefactHandler;
  23 import org.codehaus.groovy.grails.web.metaclass.ControllerDynamicMethods;
  24 import org.codehaus.groovy.grails.web.pages.GroovyPage;
  25 import org.codehaus.groovy.grails.web.pages.GroovyPagesTemplateEngine;
  26 import org.codehaus.groovy.grails.web.pages.exceptions.GroovyPagesException;
  27 import org.codehaus.groovy.grails.plugins.PluginMetaManager;
  28 import org.springframework.context.ApplicationContext;
  29 import org.springframework.validation.Errors;
  30 import org.springframework.web.util.UrlPathHelper;
  31
  32 import javax.servlet.ServletContext;
  33 import javax.servlet.ServletRequest;
  34 import javax.servlet.http.HttpServletRequest;
  35 import javax.servlet.http.HttpServletResponse;
  36 import javax.servlet.http.HttpSession;
  37 import java.io.Writer;
  38
  39 /**
  40  * Implementation of the GrailsApplicationAttributes interface that holds knowledge about how to obtain
  41  * certain attributes from either the ServletContext or the HttpServletRequest instance.
  42  *
  43  * @see org.codehaus.groovy.grails.web.servlet.mvc.GrailsWebRequest
  44  *
  45  * @author Graeme Rocher
  46  * @since 0.3
  47  *
  48  * Created: 17-Jan-2006
  49  */
  50 public class DefaultGrailsApplicationAttributes implements GrailsApplicationAttributes {
  51
  52         private static Log LOG = LogFactory.getLog(DefaultGrailsApplicationAttributes.class);
  53
  54     private UrlPathHelper urlHelper = new UrlPathHelper();
  55
  56     private ServletContext context;
  57
  58     public DefaultGrailsApplicationAttributes(ServletContext context) {
  59         this.context = context;
  60     }
  61
  62     public ApplicationContext getApplicationContext() {
  63         return (ApplicationContext)this.context.getAttribute(APPLICATION_CONTEXT);
  64     }
  65
  66     public String getPluginContextPath(HttpServletRequest request) {
  67         GroovyObject controller = getController(request);
  68         GrailsApplication application = getGrailsApplication();
  69
  70         if(controller != null && application != null) {
  71             final Class controllerClass = controller.getClass();
  72             PluginMetaManager metaManager = (PluginMetaManager)getApplicationContext().getBean(PluginMetaManager.BEAN_ID);
  73             String path = metaManager.getPluginPathForResource(controllerClass.getName());
  74             return path == null ? "" : path;
  75         }
  76         else {
  77             return "";
  78         }
  79     }
  80
  81     public GroovyObject getController(ServletRequest request) {
  82         return (GroovyObject)request.getAttribute(CONTROLLER);
  83     }
  84
  85     public String getControllerUri(ServletRequest request) {
  86         GroovyObject controller = getController(request);
  87         if(controller != null)
  88             return (String)controller.getProperty(ControllerDynamicMethods.CONTROLLER_URI_PROPERTY);
  89         else {
  90             return "/" + request.getAttribute(GrailsApplicationAttributes.CONTROLLER_NAME_ATTRIBUTE);
  91         }
  92     }
  93
  94     public String getApplicationUri(ServletRequest request) {
  95         return this.urlHelper.getContextPath((HttpServletRequest)request);
  96     }
  97
  98     public ServletContext getServletContext() {
  99         return this.context;
 100     }
 101
 102     public FlashScope getFlashScope(ServletRequest request) {
 103         if(request instanceof HttpServletRequest) {
 104             HttpServletRequest servletRequest = (HttpServletRequest) request;
 105             HttpSession session = servletRequest.getSession(false);
 106             FlashScope fs;
 107             if(session != null) {
 108                 fs = (FlashScope)session.getAttribute(FLASH_SCOPE);
 109             }
 110             else {
 111                 fs = (FlashScope)request.getAttribute(FLASH_SCOPE);
 112             }
 113             if(fs == null) {
 114                 fs = new GrailsFlashScope();
 115                 if(session!=null) {
 116                     session.setAttribute(FLASH_SCOPE,fs);
 117                 }
 118                 else {
 119                     request.setAttribute(FLASH_SCOPE,fs);
 120                 }
 121             }
 122             return fs;
 123         }
 124         return null;
 125     }
 126
 127     public String getTemplateUri(String templateName, ServletRequest request) {
 128        StringBuffer buf = new StringBuffer();
 129
 130        if(templateName.startsWith("/")) {
 131            String tmp = templateName.substring(1,templateName.length());
 132            if(tmp.indexOf('/') > -1) {
 133                    buf.append('/');
 134                int i = tmp.lastIndexOf('/');
 135                buf.append(tmp.substring(0, i));
 136                    buf.append("/_");
 137                    buf.append(tmp.substring(i + 1,tmp.length()));
 138            }
 139            else {
 140                    buf.append("/_");
 141                    buf.append(templateName.substring(1,templateName.length()));
 142            }
 143        }
 144        else {
 145            String pathToTemplate = "";
 146
 147            int lastSlash = templateName.lastIndexOf('/');
 148            if (lastSlash > -1) {
 149                pathToTemplate = templateName.substring(0, lastSlash + 1);
 150                templateName = templateName.substring(lastSlash + 1);
 151            }
 152            buf.append(getControllerUri(request))
 153                    .append("/")
 154                    .append(pathToTemplate)
 155                    .append("_")
 156                    .append(templateName);
 157        }
 158        return buf
 159                         .append(".gsp")
 160                         .toString();
 161    }
 162
 163     public String getControllerActionUri(ServletRequest request) {
 164         GroovyObject controller = getController(request);
 165
 166         return (String)controller.getProperty(ControllerDynamicMethods.ACTION_URI_PROPERTY);
 167     }
 168
 169     public Errors getErrors(ServletRequest request) {
 170         return (Errors)request.getAttribute(ERRORS);
 171     }
 172
 173     public GroovyPagesTemplateEngine getPagesTemplateEngine() {
 174        ApplicationContext appCtx = getApplicationContext();
 175        if(appCtx.containsBean(GroovyPagesTemplateEngine.BEAN_ID)) {
 176             return (GroovyPagesTemplateEngine)appCtx.getBean(GroovyPagesTemplateEngine.BEAN_ID);
 177        }
 178        else {
 179            throw new GroovyPagesException("No bean named ["+GroovyPagesTemplateEngine.BEAN_ID+"] defined in Spring application context!");
 180        }
 181     }
 182
 183     public GrailsApplication getGrailsApplication() {
 184         return (GrailsApplication)getApplicationContext()
 185                                     .getBean(GrailsApplication.APPLICATION_ID);
 186     }
 187
 188
 189     public GroovyObject getTagLibraryForTag(HttpServletRequest request, HttpServletResponse response,String tagName) {
 190         return getTagLibraryForTag(request, response, tagName, GroovyPage.DEFAULT_NAMESPACE);
 191     }
 192
 193         public GroovyObject getTagLibraryForTag(HttpServletRequest request, HttpServletResponse response,String tagName, String namespace) {
 194                 String nonNullNamesapce = namespace == null ? GroovyPage.DEFAULT_NAMESPACE : namespace;
 195                 String fullTagName = nonNullNamesapce + ":" + tagName;
 196
 197                 GrailsTagLibClass tagLibClass = (GrailsTagLibClass) getGrailsApplication().getArtefactForFeature(
 198                 TagLibArtefactHandler.TYPE, fullTagName);
 199                 if(tagLibClass == null)return null;
 200                 return (GroovyObject)getApplicationContext()
 201                                                                                                 .getBean(tagLibClass.getFullName());
 202         }
 203
 204         public String getViewUri(String viewName, HttpServletRequest request) {
 205                StringBuffer buf = new StringBuffer(PATH_TO_VIEWS);
 206
 207                if(viewName.startsWith("/")) {
 208                    String tmp = viewName.substring(1,viewName.length());
 209                    if(tmp.indexOf('/') > -1) {
 210                            buf.append('/');
 211                            buf.append(tmp.substring(0,tmp.lastIndexOf('/')));
 212                            buf.append("/");
 213                            buf.append(tmp.substring(tmp.lastIndexOf('/') + 1,tmp.length()));
 214                    }
 215                    else {
 216                            buf.append("/");
 217                            buf.append(viewName.substring(1,viewName.length()));
 218                    }
 219                }
 220                else {
 221                    buf.append(getControllerUri(request))
 222                    .append("/")
 223                    .append(viewName);
 224
 225                }
 226                return buf
 227                                 .append(".gsp")
 228                                 .toString();
 229         }
 230
 231
 232         public Writer getOut(HttpServletRequest request) {
 233                 return (Writer)request.getAttribute(OUT);
 234         }
 235
 236         public void setOut(HttpServletRequest request, Writer out2) {
 237                 request.setAttribute(OUT, out2);
 238         }
 239 }