X-Git-Url: http://git.rot13.org/?p=zxing.git;a=blobdiff_plain;f=zxingorg%2Fsrc%2Fcom%2Fgoogle%2Fzxing%2Fweb%2FDecodeServlet.java;h=8419c7ac12ad19454df3e8c8be54a217893196d3;hp=fce5b23d1250e56fc1d00f54a1e0034a8c3a0f60;hb=f2200f8ebe0f0eef72b8b916d085506a94c774b0;hpb=24a1cc39df4b7e200dbf468d1e128c3bab1feaaf diff --git a/zxingorg/src/com/google/zxing/web/DecodeServlet.java b/zxingorg/src/com/google/zxing/web/DecodeServlet.java index fce5b23d..8419c7ac 100644 --- a/zxingorg/src/com/google/zxing/web/DecodeServlet.java +++ b/zxingorg/src/com/google/zxing/web/DecodeServlet.java @@ -1,5 +1,5 @@ /* - * 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. @@ -16,41 +16,47 @@ package com.google.zxing.web; +import com.google.zxing.BarcodeFormat; +import com.google.zxing.BinaryBitmap; +import com.google.zxing.ChecksumException; import com.google.zxing.DecodeHintType; +import com.google.zxing.FormatException; +import com.google.zxing.LuminanceSource; import com.google.zxing.MultiFormatReader; +import com.google.zxing.NotFoundException; 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.result.ParsedReaderResult; +import com.google.zxing.client.j2se.BufferedImageLuminanceSource; +import com.google.zxing.common.GlobalHistogramBinarizer; +import com.google.zxing.common.HybridBinarizer; + +import com.google.zxing.multi.GenericMultipleBarcodeReader; +import com.google.zxing.multi.MultipleBarcodeReader; 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.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.HttpEntity; 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.methods.HttpUriRequest; +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.conn.ClientConnectionManager; import org.apache.http.impl.client.DefaultHttpClient; -import org.apache.http.impl.conn.tsccm.ThreadSafeClientConnManager; +import org.apache.http.impl.conn.SingleClientConnManager; import org.apache.http.params.BasicHttpParams; 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.color.CMMException; import java.awt.image.BufferedImage; import java.io.IOException; import java.io.InputStream; @@ -58,75 +64,96 @@ import java.io.OutputStreamWriter; import java.io.Writer; import java.net.URI; import java.net.URISyntaxException; -import java.net.UnknownHostException; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collection; 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.ServletRequest; +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 (srowen@google.com) + * + * @author Sean Owen */ public final class DecodeServlet extends HttpServlet { - private static final long MAX_IMAGE_SIZE = 500000L; - private static final long EMAIL_CHECK_INTERVAL = 2L * 60 * 1000; + // No real reason to let people upload more than a 2MB image + private static final long MAX_IMAGE_SIZE = 2000000L; + // No real reason to deal with more than maybe 2 megapixels + private static final int MAX_PIXELS = 1 << 21; private static final Logger log = Logger.getLogger(DecodeServlet.class.getName()); static final Hashtable HINTS; + static final Hashtable HINTS_PURE; static { - HINTS = new Hashtable(3); + HINTS = new Hashtable(5); HINTS.put(DecodeHintType.TRY_HARDER, Boolean.TRUE); + Collection possibleFormats = new Vector(17); + 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_93); + possibleFormats.add(BarcodeFormat.CODE_128); + //possibleFormats.add(BarcodeFormat.CODABAR); + possibleFormats.add(BarcodeFormat.ITF); + possibleFormats.add(BarcodeFormat.RSS14); + possibleFormats.add(BarcodeFormat.QR_CODE); + possibleFormats.add(BarcodeFormat.DATAMATRIX); + possibleFormats.add(BarcodeFormat.PDF417); + HINTS.put(DecodeHintType.POSSIBLE_FORMATS, possibleFormats); + HINTS_PURE = new Hashtable(HINTS); + HINTS_PURE.put(DecodeHintType.PURE_BARCODE, Boolean.TRUE); } - private HttpClient client; + private HttpParams params; + private SchemeRegistry registry; private DiskFileItemFactory diskFileItemFactory; - private Timer emailTimer; @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(); + params = new BasicHttpParams(); HttpProtocolParams.setVersion(params, HttpVersion.HTTP_1_1); - SchemeRegistry registry = new SchemeRegistry(); + registry = new SchemeRegistry(); registry.register(new Scheme("http", PlainSocketFactory.getSocketFactory(), 80)); registry.register(new Scheme("https", SSLSocketFactory.getSocketFactory(), 443)); - client = new DefaultHttpClient(new ThreadSafeClientConnManager(params, registry), params); - diskFileItemFactory = new DiskFileItemFactory(); - Authenticator emailAuthenticator = new EmailAuthenticator(emailAddress, emailPassword); - emailTimer = new Timer("Email decoder timer", true); - emailTimer.schedule(new DecodeEmailTask(emailAddress, emailAuthenticator), 0L, EMAIL_CHECK_INTERVAL); - log.info("DecodeServlet configured"); } @Override - protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { - + protected void doGet(HttpServletRequest request, HttpServletResponse response) + throws ServletException, IOException { String imageURIString = request.getParameter("u"); if (imageURIString == null || imageURIString.length() == 0) { + log.fine("URI was empty"); response.sendRedirect("badurl.jspx"); return; } + imageURIString = imageURIString.trim(); + if (!(imageURIString.startsWith("http://") || imageURIString.startsWith("https://"))) { imageURIString = "http://" + imageURIString; } @@ -135,38 +162,63 @@ public final class DecodeServlet extends HttpServlet { try { imageURI = new URI(imageURIString); } catch (URISyntaxException urise) { + log.fine("URI was not valid: " + imageURIString); response.sendRedirect("badurl.jspx"); return; } - HttpGet getRequest = new HttpGet(imageURI); + ClientConnectionManager connectionManager = new SingleClientConnManager(params, registry); + HttpClient client = new DefaultHttpClient(connectionManager, params); + + HttpUriRequest getRequest = new HttpGet(imageURI); + getRequest.addHeader("Connection", "close"); // Avoids CLOSE_WAIT socket issue? try { - HttpResponse getResponse = client.execute(getRequest); + + HttpResponse getResponse; + try { + getResponse = client.execute(getRequest); + } catch (IllegalArgumentException iae) { + // Thrown if hostname is bad or null + log.fine(iae.toString()); + getRequest.abort(); + response.sendRedirect("badurl.jspx"); + return; + } catch (IOException ioe) { + // Encompasses lots of stuff, including + // java.net.SocketException, java.net.UnknownHostException, + // javax.net.ssl.SSLPeerUnverifiedException, + // org.apache.http.NoHttpResponseException, + // org.apache.http.client.ClientProtocolException, + log.fine(ioe.toString()); + getRequest.abort(); + response.sendRedirect("badurl.jspx"); + return; + } + if (getResponse.getStatusLine().getStatusCode() != HttpServletResponse.SC_OK) { + log.fine("Unsuccessful return code: " + getResponse.getStatusLine().getStatusCode()); response.sendRedirect("badurl.jspx"); return; } if (!isSizeOK(getResponse)) { + log.fine("Too large"); response.sendRedirect("badimage.jspx"); return; } + log.info("Decoding " + imageURI); - InputStream is = getResponse.getEntity().getContent(); + HttpEntity entity = getResponse.getEntity(); + InputStream is = entity.getContent(); try { processStream(is, request, response); } finally { + entity.consumeContent(); is.close(); } - } catch (InterruptedException ie) { - getRequest.abort(); - response.sendRedirect("badurl.jspx"); - } catch (HttpException he) { - getRequest.abort(); - response.sendRedirect("badurl.jspx"); - } catch (UnknownHostException uhe) { - getRequest.abort(); - response.sendRedirect("badurl.jspx"); + + } finally { + connectionManager.shutdown(); } } @@ -176,6 +228,7 @@ public final class DecodeServlet extends HttpServlet { throws ServletException, IOException { if (!ServletFileUpload.isMultipartContent(request)) { + log.fine("File upload was not multipart"); response.sendRedirect("badimage.jspx"); return; } @@ -196,52 +249,145 @@ public final class DecodeServlet extends HttpServlet { is.close(); } } else { + log.fine("Too large"); response.sendRedirect("badimage.jspx"); } break; } } } catch (FileUploadException fue) { + log.fine(fue.toString()); response.sendRedirect("badimage.jspx"); } } - private static void processStream(InputStream is, HttpServletRequest request, HttpServletResponse response) - throws ServletException, IOException { - BufferedImage image = ImageIO.read(is); + private static void processStream(InputStream is, ServletRequest request, + HttpServletResponse response) throws ServletException, IOException { + + BufferedImage image; + try { + image = ImageIO.read(is); + } catch (IOException ioe) { + log.fine(ioe.toString()); + // Includes javax.imageio.IIOException + response.sendRedirect("badimage.jspx"); + return; + } catch (CMMException cmme) { + log.fine(cmme.toString()); + // Have seen this in logs + response.sendRedirect("badimage.jspx"); + return; + } catch (IllegalArgumentException iae) { + log.fine(iae.toString()); + // Have seen this in logs for some JPEGs + response.sendRedirect("badimage.jspx"); + return; + } if (image == null) { + response.sendRedirect("badimage.jspx"); + return; + } + if (image.getHeight() <= 1 || image.getWidth() <= 1 || + image.getHeight() * image.getWidth() > MAX_PIXELS) { + log.fine("Dimensions too large: " + image.getWidth() + 'x' + image.getHeight()); response.sendRedirect("badimage.jspx"); return; } Reader reader = new MultiFormatReader(); - Result result; + LuminanceSource source = new BufferedImageLuminanceSource(image); + BinaryBitmap bitmap = new BinaryBitmap(new GlobalHistogramBinarizer(source)); + Collection results = new ArrayList(1); + ReaderException savedException = null; + try { - result = reader.decode(new BufferedImageMonochromeBitmapSource(image), HINTS); + // Look for multiple barcodes + MultipleBarcodeReader multiReader = new GenericMultipleBarcodeReader(reader); + Result[] theResults = multiReader.decodeMultiple(bitmap, HINTS); + if (theResults != null) { + results.addAll(Arrays.asList(theResults)); + } } catch (ReaderException re) { - log.info("DECODE FAILED: " + re.toString()); - response.sendRedirect("notfound.jspx"); + savedException = re; + } + + if (results.isEmpty()) { + try { + // Look for pure barcode + Result theResult = reader.decode(bitmap, HINTS_PURE); + if (theResult != null) { + results.add(theResult); + } + } catch (ReaderException re) { + savedException = re; + } + } + + if (results.isEmpty()) { + try { + // Look for normal barcode in photo + Result theResult = reader.decode(bitmap, HINTS); + if (theResult != null) { + results.add(theResult); + } + } catch (ReaderException re) { + savedException = re; + } + } + + if (results.isEmpty()) { + try { + // Try again with other binarizer + BinaryBitmap hybridBitmap = new BinaryBitmap(new HybridBinarizer(source)); + Result theResult = reader.decode(hybridBitmap, HINTS); + if (theResult != null) { + results.add(theResult); + } + } catch (ReaderException re) { + savedException = re; + } + } + + if (results.isEmpty()) { + handleException(savedException, response); return; } if (request.getParameter("full") == null) { response.setContentType("text/plain"); - response.setCharacterEncoding("UTF-8"); - Writer out = new OutputStreamWriter(response.getOutputStream(), "UTF-8"); + response.setCharacterEncoding("UTF8"); + Writer out = new OutputStreamWriter(response.getOutputStream(), "UTF8"); try { - out.write(result.getText()); + for (Result result : results) { + out.write(result.getText()); + out.write('\n'); + } } finally { out.close(); } } else { - request.setAttribute("result", result); - ParsedReaderResult parsedReaderResult = ParsedReaderResult.parseReaderResult(result); - request.setAttribute("parsedReaderResult", parsedReaderResult); + request.setAttribute("results", results); request.getRequestDispatcher("decoderesult.jspx").forward(request, response); } } + private static void handleException(ReaderException re, HttpServletResponse response) throws IOException { + if (re instanceof NotFoundException) { + log.info("Not found: " + re); + response.sendRedirect("notfound.jspx"); + } else if (re instanceof FormatException) { + log.info("Format problem: " + re); + response.sendRedirect("format.jspx"); + } else if (re instanceof ChecksumException) { + log.info("Checksum problem: " + re); + response.sendRedirect("format.jspx"); + } else { + log.info("Unknown problem: " + re); + response.sendRedirect("notfound.jspx"); + } + } + private static boolean isSizeOK(HttpMessage getResponse) { Header lengthHeader = getResponse.getLastHeader("Content-Length"); if (lengthHeader != null) { @@ -256,7 +402,6 @@ public final class DecodeServlet extends HttpServlet { @Override public void destroy() { log.config("DecodeServlet shutting down..."); - emailTimer.cancel(); } }