Menu
▾
▴
[Archive-access-cvs] SF.net SVN: archive-access: [2113] trunk/archive-access/projects/wayback/ wayback-core/src/main/java/org/archive/wayback/replay/BaseReplayRenderer. java
Revision: 2113
http://archive-access.svn.sourceforge.net/archive-access/?rev=2113&view=rev
Author: bradtofel
Date: 2007-12-11 19:08:58 -0800 (Tue, 11 Dec 2007)
Log Message:
-----------
REMOVE: all this code has been refactored into the new ReplayRendererDispatcher, and the various ReplayRenderer implementations.
Removed Paths:
-------------
trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/replay/BaseReplayRenderer.java
Deleted: trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/replay/BaseReplayRenderer.java
===================================================================
--- trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/replay/BaseReplayRenderer.java 2007-12-12 03:06:53 UTC (rev 2112)
+++ trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/replay/BaseReplayRenderer.java 2007-12-12 03:08:58 UTC (rev 2113)
@@ -1,524 +0,0 @@
-/* BaseReplayRenderer
- *
- * $Id$
- *
- * Created on 12:35:07 PM Apr 24, 2006.
- *
- * Copyright (C) 2006 Internet Archive.
- *
- * This file is part of wayback.
- *
- * wayback is free software; you can redistribute it and/or modify
- * it under the terms of the GNU Lesser Public License as published by
- * the Free Software Foundation; either version 2.1 of the License, or
- * any later version.
- *
- * wayback is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Lesser Public License for more details.
- *
- * You should have received a copy of the GNU Lesser Public License
- * along with wayback; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
- */
-package org.archive.wayback.replay;
-
-import java.io.IOException;
-import java.io.InputStream;
-import java.io.InputStreamReader;
-import java.io.OutputStream;
-import java.util.Iterator;
-import java.util.Map;
-import java.util.regex.Matcher;
-import java.util.regex.Pattern;
-
-import javax.servlet.RequestDispatcher;
-import javax.servlet.ServletException;
-import javax.servlet.ServletOutputStream;
-import javax.servlet.http.HttpServletRequest;
-import javax.servlet.http.HttpServletResponse;
-
-import org.archive.wayback.ReplayRenderer;
-import org.archive.wayback.ResultURIConverter;
-import org.archive.wayback.WaybackConstants;
-import org.archive.wayback.core.Resource;
-import org.archive.wayback.core.SearchResult;
-import org.archive.wayback.core.SearchResults;
-import org.archive.wayback.core.UIResults;
-import org.archive.wayback.core.WaybackRequest;
-import org.archive.wayback.exception.WaybackException;
-import org.mozilla.universalchardet.UniversalDetector;
-
-
-/**
- *
- *
- * @author brad
- * @version $Date$, $Revision$
- */
-public class BaseReplayRenderer implements ReplayRenderer {
-
- // in several places, this class defers generation of client responses
- // to a .jsp file, once the business logic of replaying is done.
-
- private String errorJsp = "/jsp/HTMLError.jsp";
- private String imageErrorJsp = "/jsp/HTMLError.jsp";
- private String javascriptErrorJsp = "/jsp/JavaScriptError.jsp";
- private String cssErrorJsp = "/jsp/CSSError.jsp";
-
- // if documents are marked up before sending to clients, the data is
- // decoded into a String in chunks. This is how big a chunk to decode with.
- private final static int C_BUFFER_SIZE = 4096;
-
- // hand off this many bytes to the chardet library
- private final static int MAX_CHARSET_READAHEAD = 65536;
-
- // ...and if the chardet library fails, use the Content-Type header
- private final static String HTTP_CONTENT_TYPE_HEADER = "Content-Type";
-
- // ...if it also includes "charset="
- private final static String CHARSET_TOKEN = "charset=";
-
- private final static int BYTE_BUFFER_SIZE = 4096;
-
- protected final Pattern IMAGE_REGEX = Pattern
- .compile(".*\\.(jpg|jpeg|gif|png|bmp|tiff|tif)$");
-
- /* ERROR HANDLING RESPONSES: */
-
- private boolean requestIsEmbedded(HttpServletRequest httpRequest,
- WaybackRequest wbRequest) {
- // without a wbRequest, assume it is not embedded: send back HTML
- if(wbRequest == null) {
- return false;
- }
- String referer = wbRequest.get(WaybackConstants.REQUEST_REFERER_URL);
- return (referer != null && referer.length() > 0);
- }
-
- private boolean requestIsImage(HttpServletRequest httpRequest,
- WaybackRequest wbRequest) {
- String requestUrl = wbRequest.get(WaybackConstants.REQUEST_URL);
- if (requestUrl == null)
- return false;
- Matcher matcher = IMAGE_REGEX.matcher(requestUrl);
- return (matcher != null && matcher.matches());
- }
-
- private boolean requestIsJavascript(HttpServletRequest httpRequest,
- WaybackRequest wbRequest) {
-
- String requestUrl = wbRequest.get(WaybackConstants.REQUEST_URL);
- return (requestUrl != null) && requestUrl.endsWith(".js");
- }
-
- private boolean requestIsCSS(HttpServletRequest httpRequest,
- WaybackRequest wbRequest) {
-
- String requestUrl = wbRequest.get(WaybackConstants.REQUEST_URL);
- return (requestUrl != null) && requestUrl.endsWith(".css");
- }
-
- /**
- * @param httpRequest
- * @param httpResponse
- * @param wbRequest
- * @param exception
- * @throws ServletException
- * @throws IOException
- */
- public void renderException(HttpServletRequest httpRequest,
- HttpServletResponse httpResponse, WaybackRequest wbRequest,
- WaybackException exception) throws ServletException, IOException {
-
- // the "standard HTML" response handler:
- String finalJspPath = errorJsp;
-
- // try to not cause client errors by sending the HTML response if
- // this request is ebedded, and is obviously one of the special types:
- if (requestIsEmbedded(httpRequest, wbRequest)) {
-
- if (requestIsJavascript(httpRequest, wbRequest)) {
-
- finalJspPath = javascriptErrorJsp;
-
- } else if (requestIsCSS(httpRequest, wbRequest)) {
-
- finalJspPath = cssErrorJsp;
-
- } else if (requestIsImage(httpRequest, wbRequest)) {
-
- finalJspPath = imageErrorJsp;
-
- }
- }
-
- httpRequest.setAttribute("exception", exception);
- UIResults uiResults = new UIResults(wbRequest);
- uiResults.storeInRequest(httpRequest, finalJspPath);
-
- RequestDispatcher dispatcher = httpRequest
- .getRequestDispatcher(finalJspPath);
-
- dispatcher.forward(httpRequest, httpResponse);
- }
-
- /* GENERIC RESPONSE HELPER METHODS: */
-
- /**
- * Send the raw bytes from is (presumably the Resource/ARCRecord) to
- * os (presumably the clients/HTTPResponse's OutputStream) with no
- * decoding. Send them all as-is.
- *
- * @param is
- * @param os
- * @throws IOException
- */
- protected void copy(InputStream is, OutputStream os) throws IOException {
- byte[] buffer = new byte[BYTE_BUFFER_SIZE];
- for (int r = -1; (r = is.read(buffer, 0, BYTE_BUFFER_SIZE)) != -1;) {
- os.write(buffer, 0, r);
- }
- }
-
- protected boolean isExactVersionRequested(WaybackRequest wbRequest,
- SearchResult result) {
-
- String reqDateStr = wbRequest.get(WaybackConstants.REQUEST_EXACT_DATE);
- String resDateStr = result.get(WaybackConstants.RESULT_CAPTURE_DATE);
-
- // some capture dates are not 14 digits, only compare as many
- // digits as are in the result date:
- return resDateStr.equals(reqDateStr.substring(0, resDateStr.length()));
- }
-
- /**
- * test if the Resource and SearchResult should be replayed raw, without
- * any markup.
- *
- * This version always indicates that the document should be returned raw,
- * but is intended to be overriden.
- *
- * @param resource
- * @param result
- * @return boolean, true if the document should be returned raw.
- */
- protected boolean isRawReplayResult(Resource resource,
- SearchResult result) {
- return true;
- }
-
- /**
- * callback function for each HTTP header. If null is returned, header is
- * omitted from final response to client, otherwise, the possibly modified
- * http header value is returned to the client.
- *
- * This version just hands back all headers transparently, but is intended
- * to be overriden.
- *
- * @param key
- * @param value
- * @param uriConverter
- * @param result
- * @return String
- */
- protected String filterHeader(final String key, final String value,
- final ResultURIConverter uriConverter, SearchResult result) {
- return value;
- }
-
- /**
- * Iterate over all HTTP headers in resource, possibly sending them on
- * to the client. The determination as to omit, send as-is, or send modified
- * is handled thru the overridable filterHeader() method.
- *
- * @param response
- * @param resource
- * @param uriConverter
- * @param result
- * @throws IOException
- */
- protected void copyRecordHttpHeader(HttpServletResponse response,
- Resource resource, ResultURIConverter uriConverter,
- SearchResult result) throws IOException {
- Map<String,String> headers = resource.getHttpHeaders();
- int code = resource.getStatusCode();
- // Only return legit status codes -- don't return any minus
- // codes, etc.
- if (code <= HttpServletResponse.SC_CONTINUE) {
- String identifier = "";
- response.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR,
- "Bad status code " + code + " (" + identifier + ").");
- return;
- }
- response.setStatus(code);
- if (headers != null) {
- Iterator<String> itr = headers.keySet().iterator();
- while(itr.hasNext()) {
- String key = itr.next();
- String value = headers.get(key);
- String finalValue = value;
- if (value != null) {
- finalValue = filterHeader(key, value, uriConverter, result);
- if (finalValue == null) {
- continue;
- }
- }
- response.setHeader(key, (finalValue == null) ? "" : finalValue);
- }
- }
- }
-
- private String contentTypeToCharset(final String contentType) {
- int offset = contentType.indexOf(CHARSET_TOKEN);
- if (offset != -1) {
- return contentType.substring(offset + CHARSET_TOKEN.length());
- }
- return null;
- }
-
- /**
- * Attempt to divine the character encoding of the document from the
- * Content-Type HTTP header (with a "charset=")
- *
- * @param resource
- * @return String character set found or null if the header was not present
- * @throws IOException
- */
- protected String getCharsetFromHeaders(Resource resource)
- throws IOException {
-
- String charsetName = null;
-
- Map<String,String> httpHeaders = resource.getHttpHeaders();
- String ctype = httpHeaders.get(HTTP_CONTENT_TYPE_HEADER);
- if (ctype != null) {
- charsetName = contentTypeToCharset(ctype);
- }
- return charsetName;
- }
-
- /**
- * Attempt to find a META tag in the HTML that hints at the character set
- * used to write the document.
- *
- * @param resource
- * @return String character set found from META tags in the HTML
- * @throws IOException
- */
- protected String getCharsetFromMeta(Resource resource) throws IOException {
- String charsetName = null;
-
- byte[] bbuffer = new byte[MAX_CHARSET_READAHEAD];
- resource.mark(MAX_CHARSET_READAHEAD);
- resource.read(bbuffer, 0, MAX_CHARSET_READAHEAD);
- resource.reset();
- // convert to UTF-8 String -- which hopefully will not mess up the
- // characters we're interested in...
- StringBuilder sb = new StringBuilder(new String(bbuffer,"UTF-8"));
- String metaContentType = TagMagix.getTagAttrWhere(sb, "META",
- "content", "http-equiv", "Content-Type");
- if(metaContentType != null) {
- charsetName = contentTypeToCharset(metaContentType);
- }
- return charsetName;
- }
-
- /**
- * Attempts to figure out the character set of the document using
- * the excellent juniversalchardet library.
- *
- * @param resource
- * @return String character encoding found, or null if nothing looked good.
- * @throws IOException
- */
- protected String getCharsetFromBytes(Resource resource) throws IOException {
- String charsetName = null;
-
- byte[] bbuffer = new byte[MAX_CHARSET_READAHEAD];
- // (1)
- UniversalDetector detector = new UniversalDetector(null);
-
- // (2)
- resource.mark(MAX_CHARSET_READAHEAD);
- int len = resource.read(bbuffer, 0, MAX_CHARSET_READAHEAD);
- resource.reset();
- detector.handleData(bbuffer, 0, len);
- // (3)
- detector.dataEnd();
- // (4)
- charsetName = detector.getDetectedCharset();
-
- // (5)
- detector.reset();
-
- return charsetName;
- }
-
- /**
- * Use META tags, byte-character-detection, HTTP headers, hope, and prayer
- * to figure out what character encoding is being used for the document.
- * If nothing else works, assumes UTF-8 for now.
- *
- * @param resource
- * @return String charset for Resource
- * @throws IOException
- */
- protected String getCharset(Resource resource) throws IOException {
-
- String charSet = getCharsetFromMeta(resource);
- if(charSet == null) {
- charSet = getCharsetFromBytes(resource);
- if(charSet == null) {
- charSet = getCharsetFromHeaders(resource);
- if(charSet == null) {
- charSet = "UTF-8";
- }
- }
- }
- return charSet;
- }
-
- /**
- * Do "stuff" to the StringBuilder page argument.
- *
- * This version does nothing at all, but is intended to be overridden.
- *
- * @param page
- * @param httpRequest
- * @param httpResponse
- * @param wbRequest
- * @param result
- * @param resource
- * @param uriConverter
- */
- protected void markUpPage(StringBuilder page,
- HttpServletRequest httpRequest, HttpServletResponse httpResponse,
- WaybackRequest wbRequest, SearchResult result, Resource resource,
- ResultURIConverter uriConverter) {
-
- }
-
-
- /* (non-Javadoc)
- * @see org.archive.wayback.ReplayRenderer#renderResource(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, org.archive.wayback.core.WaybackRequest, org.archive.wayback.core.SearchResult, org.archive.wayback.core.Resource, org.archive.wayback.ResultURIConverter)
- */
- public void renderResource(HttpServletRequest httpRequest,
- HttpServletResponse httpResponse, WaybackRequest wbRequest,
- SearchResult result, Resource resource,
- ResultURIConverter uriConverter, SearchResults results) throws ServletException,
- IOException {
-
- if (resource == null) {
- throw new IllegalArgumentException("No resource");
- }
- if (result == null) {
- throw new IllegalArgumentException("No result");
- }
-
- if (isRawReplayResult(resource,result)) {
-
- resource.parseHeaders();
- copyRecordHttpHeader(httpResponse, resource, uriConverter, result);
- copy(resource, httpResponse.getOutputStream());
-
- } else {
-
- // We're going to do some markup on the page.
- // first we'll need to convert the bytes to a String, which
- // includes character encoding detection, then we'll call into the
- // overridable markUpPage(), then we'll convert back to bytes and
- // return them to the client
-
- resource.parseHeaders();
- copyRecordHttpHeader(httpResponse, resource, uriConverter, result);
-
- int recordLength = (int) resource.getRecordLength();
-
- // get the charset:
- String charSet = getCharset(resource);
-
- // convert bytes to characters for charset:
- InputStreamReader isr = new InputStreamReader(resource, charSet);
-
- char[] cbuffer = new char[C_BUFFER_SIZE];
-
- // slurp the whole thing into RAM:
- StringBuilder sbuffer = new StringBuilder(recordLength);
- for (int r = -1; (r = isr.read(cbuffer, 0, C_BUFFER_SIZE)) != -1;) {
- sbuffer.append(cbuffer, 0, r);
- }
-
- // do the "usual" markup:
- markUpPage(sbuffer, httpRequest, httpResponse, wbRequest, result,
- resource, uriConverter);
-
- // back to bytes...
- byte[] ba = sbuffer.toString().getBytes(charSet);
-
- // inform browser how much is coming back:
- httpResponse.setHeader("Content-Length", String.valueOf(ba.length));
-
- // and send it out the door...
- ServletOutputStream out = httpResponse.getOutputStream();
- out.write(ba);
- }
- }
-
- /**
- * @return the errorJsp
- */
- public String getErrorJsp() {
- return errorJsp;
- }
-
- /**
- * @param errorJsp the errorJsp to set
- */
- public void setErrorJsp(String errorJsp) {
- this.errorJsp = errorJsp;
- }
-
- /**
- * @return the imageErrorJsp
- */
- public String getImageErrorJsp() {
- return imageErrorJsp;
- }
-
- /**
- * @param imageErrorJsp the imageErrorJsp to set
- */
- public void setImageErrorJsp(String imageErrorJsp) {
- this.imageErrorJsp = imageErrorJsp;
- }
-
- /**
- * @return the javascriptErrorJsp
- */
- public String getJavascriptErrorJsp() {
- return javascriptErrorJsp;
- }
-
- /**
- * @param javascriptErrorJsp the javascriptErrorJsp to set
- */
- public void setJavascriptErrorJsp(String javascriptErrorJsp) {
- this.javascriptErrorJsp = javascriptErrorJsp;
- }
-
- /**
- * @return the cssErrorJsp
- */
- public String getCssErrorJsp() {
- return cssErrorJsp;
- }
-
- /**
- * @param cssErrorJsp the cssErrorJsp to set
- */
- public void setCssErrorJsp(String cssErrorJsp) {
- this.cssErrorJsp = cssErrorJsp;
- }
-}
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
