/*
- * Copyright 2008 Google Inc.
+ * Copyright 2008 ZXing authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
package com.google.zxing.web;
+import com.google.zxing.BarcodeFormat;
+import com.google.zxing.BinaryBitmap;
import com.google.zxing.DecodeHintType;
+import com.google.zxing.LuminanceSource;
import com.google.zxing.MultiFormatReader;
import com.google.zxing.Reader;
import com.google.zxing.ReaderException;
import com.google.zxing.Result;
-import com.google.zxing.client.j2se.BufferedImageMonochromeBitmapSource;
+import com.google.zxing.client.j2se.BufferedImageLuminanceSource;
+import com.google.zxing.client.result.ParsedResult;
+import com.google.zxing.client.result.ResultParser;
+import com.google.zxing.common.GlobalHistogramBinarizer;
+
import org.apache.commons.fileupload.FileItem;
import org.apache.commons.fileupload.FileUploadException;
import org.apache.commons.fileupload.disk.DiskFileItemFactory;
import org.apache.commons.fileupload.servlet.ServletFileUpload;
+import org.apache.commons.lang.StringEscapeUtils;
import org.apache.http.Header;
-import org.apache.http.HttpException;
import org.apache.http.HttpMessage;
import org.apache.http.HttpResponse;
import org.apache.http.HttpVersion;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
-import org.apache.http.conn.PlainSocketFactory;
-import org.apache.http.conn.Scheme;
-import org.apache.http.conn.SchemeRegistry;
+import org.apache.http.client.params.HttpClientParams;
+import org.apache.http.conn.scheme.PlainSocketFactory;
+import org.apache.http.conn.scheme.Scheme;
+import org.apache.http.conn.scheme.SchemeRegistry;
import org.apache.http.conn.ssl.SSLSocketFactory;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.impl.conn.tsccm.ThreadSafeClientConnManager;
import org.apache.http.params.HttpParams;
import org.apache.http.params.HttpProtocolParams;
-import javax.imageio.ImageIO;
-import javax.mail.Authenticator;
-import javax.servlet.ServletConfig;
-import javax.servlet.ServletException;
-import javax.servlet.http.HttpServlet;
-import javax.servlet.http.HttpServletRequest;
-import javax.servlet.http.HttpServletResponse;
import java.awt.image.BufferedImage;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStreamWriter;
import java.io.Writer;
+import java.net.SocketException;
import java.net.URI;
import java.net.URISyntaxException;
+import java.net.UnknownHostException;
import java.util.Hashtable;
import java.util.List;
-import java.util.Timer;
+import java.util.Vector;
import java.util.logging.Logger;
+import javax.imageio.ImageIO;
+import javax.servlet.ServletConfig;
+import javax.servlet.ServletException;
+import javax.servlet.http.HttpServlet;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
/**
+ * {@link HttpServlet} which decodes images containing barcodes. Given a URL, it will
+ * retrieve the image and decode it. It can also process image files uploaded via POST.
+ *
* @author Sean Owen
*/
public final class DecodeServlet extends HttpServlet {
- private static final long MAX_IMAGE_SIZE = 500000L;
- private static final long EMAIL_CHECK_INTERVAL = 60000L;
+ private static final long MAX_IMAGE_SIZE = 500000L;
private static final Logger log = Logger.getLogger(DecodeServlet.class.getName());
static final Hashtable<DecodeHintType, Object> HINTS;
+
static {
- HINTS = new Hashtable<DecodeHintType, Object>(3);
+ HINTS = new Hashtable<DecodeHintType, Object>(5);
HINTS.put(DecodeHintType.TRY_HARDER, Boolean.TRUE);
+ Vector<BarcodeFormat> possibleFormats = new Vector<BarcodeFormat>();
+ possibleFormats.add(BarcodeFormat.UPC_A);
+ possibleFormats.add(BarcodeFormat.UPC_E);
+ possibleFormats.add(BarcodeFormat.EAN_8);
+ possibleFormats.add(BarcodeFormat.EAN_13);
+ possibleFormats.add(BarcodeFormat.CODE_39);
+ possibleFormats.add(BarcodeFormat.CODE_128);
+ possibleFormats.add(BarcodeFormat.ITF);
+ possibleFormats.add(BarcodeFormat.QR_CODE);
+ possibleFormats.add(BarcodeFormat.DATAMATRIX);
+ HINTS.put(DecodeHintType.POSSIBLE_FORMATS, possibleFormats);
}
private HttpClient client;
- private DiskFileItemFactory diskFileItemFactory;
- private Timer emailTimer;
+ private DiskFileItemFactory diskFileItemFactory;
@Override
- public void init(ServletConfig servletConfig) throws ServletException {
+ public void init(ServletConfig servletConfig) {
Logger logger = Logger.getLogger("com.google.zxing");
logger.addHandler(new ServletContextLogHandler(servletConfig.getServletContext()));
- String emailAddress = servletConfig.getInitParameter("emailAddress");
- String emailPassword = servletConfig.getInitParameter("emailPassword");
- if (emailAddress == null || emailPassword == null) {
- throw new ServletException("emailAddress or emailPassword not specified");
- }
-
HttpParams params = new BasicHttpParams();
HttpProtocolParams.setVersion(params, HttpVersion.HTTP_1_1);
diskFileItemFactory = new DiskFileItemFactory();
- Authenticator emailAuthenticator = new EmailAuthenticator(emailAddress, emailPassword);
- emailTimer = new Timer("Email decoder timer", true);
- emailTimer.schedule(new DecodeEmailTask(emailAuthenticator), 0L, EMAIL_CHECK_INTERVAL);
-
log.info("DecodeServlet configured");
}
- @Override
- protected void doGet(HttpServletRequest request, HttpServletResponse response) throws IOException {
-
- String imageURIString = request.getParameter("u");
- if (imageURIString == null || imageURIString.length() == 0) {
- response.sendRedirect("badurl.jspx");
- return;
- }
+ @Override
+ protected void doGet(HttpServletRequest request, HttpServletResponse response)
+ throws ServletException, IOException {
+ String imageURIString = request.getParameter("u");
+ if (imageURIString == null || imageURIString.length() == 0) {
+ response.sendRedirect("badurl.jspx");
+ return;
+ }
- if (!(imageURIString.startsWith("http://") || imageURIString.startsWith("https://"))) {
- imageURIString = "http://" + imageURIString;
- }
+ if (!(imageURIString.startsWith("http://") || imageURIString.startsWith("https://"))) {
+ imageURIString = "http://" + imageURIString;
+ }
- URI imageURI;
- try {
- imageURI = new URI(imageURIString);
- } catch (URISyntaxException urise) {
- response.sendRedirect("badurl.jspx");
- return;
- }
+ URI imageURI;
+ try {
+ imageURI = new URI(imageURIString);
+ } catch (URISyntaxException urise) {
+ response.sendRedirect("badurl.jspx");
+ return;
+ }
HttpGet getRequest = new HttpGet(imageURI);
+ getRequest.addHeader("Connection", "close"); // Avoids CLOSE_WAIT socket issue?
- try {
+ try {
HttpResponse getResponse = client.execute(getRequest);
if (getResponse.getStatusLine().getStatusCode() != HttpServletResponse.SC_OK) {
- response.sendRedirect("badurl.jspx");
- return;
- }
- if (!isSizeOK(getResponse)) {
- response.sendRedirect("badimage.jspx");
- return;
- }
+ response.sendRedirect("badurl.jspx");
+ return;
+ }
+ if (!isSizeOK(getResponse)) {
+ response.sendRedirect("badimage.jspx");
+ return;
+ }
log.info("Decoding " + imageURI);
InputStream is = getResponse.getEntity().getContent();
- try {
- processStream(is, response);
- } finally {
- is.close();
- }
- } catch (InterruptedException ie) {
+ try {
+ processStream(is, request, response);
+ } finally {
+ is.close();
+ }
+ } catch (IllegalArgumentException iae) {
+ // Thrown if hostname is bad or null
getRequest.abort();
response.sendRedirect("badurl.jspx");
- } catch (HttpException he) {
+ } catch (SocketException se) {
+ // Thrown if hostname is bad or null
getRequest.abort();
response.sendRedirect("badurl.jspx");
- }
+ } catch (UnknownHostException uhe) {
+ getRequest.abort();
+ response.sendRedirect("badurl.jspx");
+ }
- }
+ }
- @Override
- protected void doPost(HttpServletRequest request, HttpServletResponse response)
- throws ServletException, IOException {
+ @Override
+ protected void doPost(HttpServletRequest request, HttpServletResponse response)
+ throws ServletException, IOException {
- if (!ServletFileUpload.isMultipartContent(request)) {
- response.sendRedirect("badimage.jspx");
- return;
- }
+ if (!ServletFileUpload.isMultipartContent(request)) {
+ response.sendRedirect("badimage.jspx");
+ return;
+ }
- ServletFileUpload upload = new ServletFileUpload(diskFileItemFactory);
- upload.setFileSizeMax(MAX_IMAGE_SIZE);
+ ServletFileUpload upload = new ServletFileUpload(diskFileItemFactory);
+ upload.setFileSizeMax(MAX_IMAGE_SIZE);
- // Parse the request
- try {
- for (FileItem item : (List<FileItem>) upload.parseRequest(request)) {
- if (!item.isFormField()) {
- if (item.getSize() <= MAX_IMAGE_SIZE) {
+ // Parse the request
+ try {
+ for (FileItem item : (List<FileItem>) upload.parseRequest(request)) {
+ if (!item.isFormField()) {
+ if (item.getSize() <= MAX_IMAGE_SIZE) {
log.info("Decoding uploaded file");
- InputStream is = item.getInputStream();
- try {
- processStream(is, response);
- } finally {
- is.close();
- }
- } else {
- throw new ServletException("File is too large: " + item.getSize());
- }
- break;
- }
- }
- } catch (FileUploadException fue) {
- response.sendRedirect("badimage.jspx");
- }
-
- }
-
- private static void processStream(InputStream is, HttpServletResponse response) throws IOException {
- BufferedImage image = ImageIO.read(is);
- if (image == null) {
- response.sendRedirect("badimage.jspx");
- return;
- }
-
- Reader reader = new MultiFormatReader();
- Result result;
- try {
- result = reader.decode(new BufferedImageMonochromeBitmapSource(image), HINTS);
- } catch (ReaderException re) {
- log.info("DECODE FAILED: " + re.toString());
- response.sendRedirect("notfound.jspx");
- return;
- }
-
- response.setContentType("text/plain");
- response.setCharacterEncoding("UTF-8");
- Writer out = new OutputStreamWriter(response.getOutputStream(), "UTF-8");
- try {
- out.write(result.getText());
- } finally {
- out.close();
- }
- }
-
- private static boolean isSizeOK(HttpMessage getResponse) {
+ InputStream is = item.getInputStream();
+ try {
+ processStream(is, request, response);
+ } finally {
+ is.close();
+ }
+ } else {
+ response.sendRedirect("badimage.jspx");
+ }
+ break;
+ }
+ }
+ } catch (FileUploadException fue) {
+ response.sendRedirect("badimage.jspx");
+ }
+
+ }
+
+ private static void processStream(InputStream is, HttpServletRequest request,
+ HttpServletResponse response) throws ServletException, IOException {
+ BufferedImage image = ImageIO.read(is);
+ if (image == null) {
+ response.sendRedirect("badimage.jspx");
+ return;
+ }
+
+ Reader reader = new MultiFormatReader();
+ Result result;
+ try {
+ LuminanceSource source = new BufferedImageLuminanceSource(image);
+ BinaryBitmap bitmap = new BinaryBitmap(new GlobalHistogramBinarizer(source));
+ result = reader.decode(bitmap, HINTS);
+ } catch (ReaderException re) {
+ log.info("DECODE FAILED: " + re.toString());
+ response.sendRedirect("notfound.jspx");
+ return;
+ }
+
+ if (request.getParameter("full") == null) {
+ response.setContentType("text/plain");
+ response.setCharacterEncoding("UTF8");
+ Writer out = new OutputStreamWriter(response.getOutputStream(), "UTF8");
+ try {
+ out.write(result.getText());
+ } finally {
+ out.close();
+ }
+ } else {
+ request.setAttribute("result", result);
+ byte[] rawBytes = result.getRawBytes();
+ if (rawBytes != null) {
+ request.setAttribute("rawBytesString", arrayToString(rawBytes));
+ } else {
+ request.setAttribute("rawBytesString", "(Not applicable)");
+ }
+ String text = result.getText();
+ if (text != null) {
+ request.setAttribute("text", StringEscapeUtils.escapeXml(text));
+ } else {
+ request.setAttribute("text", "(Not applicable)");
+ }
+ ParsedResult parsedResult = ResultParser.parseResult(result);
+ request.setAttribute("parsedResult", parsedResult);
+ String displayResult = parsedResult.getDisplayResult();
+ if (displayResult != null) {
+ request.setAttribute("displayResult", StringEscapeUtils.escapeXml(displayResult));
+ } else {
+ request.setAttribute("displayResult", "(Not applicable)");
+ }
+ request.getRequestDispatcher("decoderesult.jspx").forward(request, response);
+ }
+ }
+
+ private static boolean isSizeOK(HttpMessage getResponse) {
Header lengthHeader = getResponse.getLastHeader("Content-Length");
- if (lengthHeader != null) {
- long length = Long.parseLong(lengthHeader.getValue());
- if (length > MAX_IMAGE_SIZE) {
- return false;
- }
- }
- return true;
- }
-
- @Override
- public void destroy() {
- log.config("DecodeServlet shutting down...");
- emailTimer.cancel();
+ if (lengthHeader != null) {
+ long length = Long.parseLong(lengthHeader.getValue());
+ if (length > MAX_IMAGE_SIZE) {
+ return false;
+ }
+ }
+ return true;
+ }
+
+ private static String arrayToString(byte[] bytes) {
+ int length = bytes.length;
+ StringBuilder result = new StringBuilder(length << 2);
+ int i = 0;
+ while (i < length) {
+ int max = Math.min(i + 8, length);
+ for (int j = i; j < max; j++) {
+ int value = bytes[j] & 0xFF;
+ result.append(Integer.toHexString(value / 16));
+ result.append(Integer.toHexString(value % 16));
+ result.append(' ');
+ }
+ result.append('\n');
+ i += 8;
+ }
+ for (int j = i - 8; j < length; j++) {
+ result.append(Integer.toHexString(bytes[j] & 0xFF));
+ result.append(' ');
+ }
+ return result.toString();
+ }
+
+ @Override
+ public void destroy() {
+ log.config("DecodeServlet shutting down...");
}
}
projects / zxing.git / blobdiff