/*
* Copyright 2004-2005 Graeme Rocher
*
* 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 org.grails.web.servlet;
import grails.util.GrailsWebUtil;
import java.io.IOException;
import java.io.Writer;
import java.util.Collections;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import grails.web.util.GrailsApplicationAttributes;
import org.grails.web.errors.GrailsExceptionResolver;
import org.grails.web.errors.GrailsWrappedRuntimeException;
import grails.web.mapping.UrlMappingInfo;
import org.grails.web.mapping.UrlMappingUtils;
import grails.web.mapping.UrlMappingsHolder;
import org.grails.web.servlet.WrappedResponseHolder;
import org.grails.web.servlet.mvc.GrailsDispatcherServlet;
import org.grails.web.servlet.mvc.GrailsWebRequest;
import org.grails.web.util.WebUtils;
import org.springframework.beans.BeansException;
import org.springframework.web.context.WebApplicationContext;
import org.springframework.web.context.request.RequestAttributes;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.WebRequest;
import org.springframework.web.context.support.WebApplicationContextUtils;
import org.springframework.web.multipart.MultipartException;
import org.springframework.web.servlet.View;
import org.springframework.web.servlet.ViewResolver;
/**
* A servlet for handling errors.
*
* @author mike
* @since 1.0-RC1
*/
public class ErrorHandlingServlet extends GrailsDispatcherServlet {
public static final String UTF_8 = "UTF-8";
private static final String CONFIG_OPTION_GSP_ENCODING = "grails.views.gsp.encoding";
private static final long serialVersionUID = 8792197458391395589L;
private static final String GSP_SUFFIX = ".gsp";
private static final String JSP_SUFFIX = ".jsp";
private static final String TEXT_HTML = "text/html";
private String defaultEncoding = UTF_8;
@Override
protected void initFrameworkServlet() throws ServletException, BeansException {
super.initFrameworkServlet();
String encoding = (String)GrailsWebUtil.lookupApplication(getServletContext()).getFlatConfig().get(CONFIG_OPTION_GSP_ENCODING);
if (encoding != null) {
defaultEncoding = encoding;
}
}
@Override
protected HttpServletRequest checkMultipart(HttpServletRequest request) throws MultipartException {
return request; // ignore multipart requests when an error occurs
}
@SuppressWarnings("unchecked")
@Override
protected void doDispatch(final HttpServletRequest request, final HttpServletResponse response) throws Exception {
// Do nothing in the case of an already committed response. Assume error already handled
if (response.isCommitted()) return;
int statusCode;
if (request.getAttribute("javax.servlet.error.status_code") != null) {
statusCode = Integer.parseInt(request.getAttribute("javax.servlet.error.status_code").toString());
}
else {
statusCode = 500;
}
Throwable t = null;
if (request.getAttribute("javax.servlet.error.exception") != null) {
t = (Throwable)request.getAttribute("javax.servlet.error.exception");
if (!(t instanceof GrailsWrappedRuntimeException) && request.getAttribute("exception") == null) {
request.setAttribute("exception", new GrailsWrappedRuntimeException(getServletContext(), t));
}
}
final UrlMappingsHolder urlMappingsHolder = (UrlMappingsHolder)getBean(UrlMappingsHolder.BEAN_ID);
UrlMappingInfo urlMappingInfo = null;
if (t != null) {
// stackFilterer.filter(t, true);
urlMappingInfo = urlMappingsHolder.matchStatusCode(statusCode, t);
if (urlMappingInfo == null) {
urlMappingInfo = urlMappingsHolder.matchStatusCode(statusCode, GrailsExceptionResolver.getRootCause(t));
}
}
if (urlMappingInfo == null) {
urlMappingInfo = urlMappingsHolder.matchStatusCode(statusCode);
}
if (urlMappingInfo == null) {
renderDefaultResponse(response, statusCode);
return;
}
RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
boolean restoreOriginalRequestAttributes = false;
final GrailsWebRequest webRequest;
if (requestAttributes instanceof GrailsWebRequest) {
webRequest = (GrailsWebRequest) requestAttributes;
urlMappingInfo.configure(webRequest);
}
else {
restoreOriginalRequestAttributes = true;
webRequest = new GrailsWebRequest(request, response, getServletContext());
RequestContextHolder.setRequestAttributes(webRequest);
urlMappingInfo.configure(webRequest);
}
// don't reuse cached controller attribute
webRequest.removeAttribute(GrailsApplicationAttributes.GRAILS_CONTROLLER_CLASS_AVAILABLE, WebRequest.SCOPE_REQUEST);
HttpServletResponse originalResponse = WrappedResponseHolder.getWrappedResponse();
try {
WrappedResponseHolder.setWrappedResponse(response);
String viewName = urlMappingInfo.getViewName();
if (viewName == null || viewName.endsWith(GSP_SUFFIX) || viewName.endsWith(JSP_SUFFIX)) {
// GrailsClass controller = UrlMappingUtils.passControllerForUrlMappingInfoInRequest(webRequest, urlMappingInfo,
// webRequest.getApplicationContext().getBean(UrlConverter.BEAN_NAME, UrlConverter.class),
// webRequest.getAttributes().getGrailsApplication());
// if(controller != null) {
// UrlMappingUtils.forwardRequestForUrlMappingInfo(request, response, urlMappingInfo, Collections.EMPTY_MAP);
// }
}
else {
ViewResolver viewResolver = WebUtils.lookupViewResolver(getServletContext());
if (viewResolver != null) {
View v;
try {
if (!response.isCommitted()) {
response.setContentType("text/html;charset="+defaultEncoding);
}
v = UrlMappingUtils.resolveView(request, urlMappingInfo, viewName, viewResolver);
v.render(Collections.EMPTY_MAP, request, response);
}
catch (Throwable e) {
// stackFilterer.filter(e);
renderDefaultResponse(response, statusCode, "Internal Server Error", e.getMessage());
}
}
}
} finally {
WrappedResponseHolder.setWrappedResponse(originalResponse);
if (restoreOriginalRequestAttributes) {
RequestContextHolder.setRequestAttributes(requestAttributes);
}
}
}
private void renderDefaultResponse(HttpServletResponse response, int statusCode) throws IOException {
if (statusCode == 404) {
renderDefaultResponse(response, statusCode, "Not Found", "Page not found.");
}
else {
renderDefaultResponse(response, statusCode, "Internal Error", "Internal server error.");
}
}
private void renderDefaultResponse(HttpServletResponse response, int statusCode, String title, String text) throws IOException {
response.setStatus(HttpServletResponse.SC_NOT_FOUND);
response.setContentType(TEXT_HTML);
Writer writer = response.getWriter();
writer.write("<HTML>\n<HEAD>\n<TITLE>Error " + statusCode + " - " + title);
writer.write("</TITLE>\n<BODY>\n<H2>Error " + statusCode + " - " + title + ".</H2>\n");
writer.write(text + "<BR/>");
for (int i = 0; i < 20; i++) {
writer.write("\n<!-- Padding for IE -->");
}
writer.write("\n</BODY>\n</HTML>\n");
writer.flush();
}
private Object getBean(String name) {
WebApplicationContext wac = WebApplicationContextUtils.getRequiredWebApplicationContext(getServletContext());
return wac.getBean(name);
}
}