zxingorg/src/com/google/zxing/web/DecodeServlet.java

   1 /*
   2  * Copyright 2008 ZXing authors
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 package com.google.zxing.web;
  18
  19 import com.google.zxing.BarcodeFormat;
  20 import com.google.zxing.BinaryBitmap;
  21 import com.google.zxing.DecodeHintType;
  22 import com.google.zxing.LuminanceSource;
  23 import com.google.zxing.MultiFormatReader;
  24 import com.google.zxing.Reader;
  25 import com.google.zxing.ReaderException;
  26 import com.google.zxing.Result;
  27 import com.google.zxing.client.j2se.BufferedImageLuminanceSource;
  28 import com.google.zxing.client.result.ParsedResult;
  29 import com.google.zxing.client.result.ResultParser;
  30 import com.google.zxing.common.GlobalHistogramBinarizer;
  31 import com.google.zxing.common.HybridBinarizer;
  32
  33 import org.apache.commons.fileupload.FileItem;
  34 import org.apache.commons.fileupload.FileUploadException;
  35 import org.apache.commons.fileupload.disk.DiskFileItemFactory;
  36 import org.apache.commons.fileupload.servlet.ServletFileUpload;
  37 import org.apache.commons.lang.StringEscapeUtils;
  38 import org.apache.http.Header;
  39 import org.apache.http.HttpMessage;
  40 import org.apache.http.HttpResponse;
  41 import org.apache.http.HttpVersion;
  42 import org.apache.http.HttpEntity;
  43 import org.apache.http.client.HttpClient;
  44 import org.apache.http.client.methods.HttpGet;
  45 import org.apache.http.client.methods.HttpUriRequest;
  46 import org.apache.http.conn.scheme.PlainSocketFactory;
  47 import org.apache.http.conn.scheme.Scheme;
  48 import org.apache.http.conn.scheme.SchemeRegistry;
  49 import org.apache.http.conn.ssl.SSLSocketFactory;
  50 import org.apache.http.conn.ClientConnectionManager;
  51 import org.apache.http.impl.client.DefaultHttpClient;
  52 import org.apache.http.impl.conn.SingleClientConnManager;
  53 import org.apache.http.params.BasicHttpParams;
  54 import org.apache.http.params.HttpParams;
  55 import org.apache.http.params.HttpProtocolParams;
  56
  57 import java.awt.image.BufferedImage;
  58 import java.io.IOException;
  59 import java.io.InputStream;
  60 import java.io.OutputStreamWriter;
  61 import java.io.Writer;
  62 import java.net.SocketException;
  63 import java.net.URI;
  64 import java.net.URISyntaxException;
  65 import java.net.UnknownHostException;
  66 import java.util.Hashtable;
  67 import java.util.List;
  68 import java.util.Vector;
  69 import java.util.logging.Logger;
  70
  71 import javax.imageio.ImageIO;
  72 import javax.servlet.ServletConfig;
  73 import javax.servlet.ServletException;
  74 import javax.servlet.ServletRequest;
  75 import javax.servlet.http.HttpServlet;
  76 import javax.servlet.http.HttpServletRequest;
  77 import javax.servlet.http.HttpServletResponse;
  78
  79 /**
  80  * {@link HttpServlet} which decodes images containing barcodes. Given a URL, it will
  81  * retrieve the image and decode it. It can also process image files uploaded via POST.
  82  *
  83  * @author Sean Owen
  84  */
  85 public final class DecodeServlet extends HttpServlet {
  86
  87   private static final long MAX_IMAGE_SIZE = 500000L;
  88
  89   private static final Logger log = Logger.getLogger(DecodeServlet.class.getName());
  90
  91   static final Hashtable<DecodeHintType, Object> HINTS;
  92
  93   static {
  94     HINTS = new Hashtable<DecodeHintType, Object>(5);
  95     HINTS.put(DecodeHintType.TRY_HARDER, Boolean.TRUE);
  96     Vector<BarcodeFormat> possibleFormats = new Vector<BarcodeFormat>();
  97     possibleFormats.add(BarcodeFormat.UPC_A);
  98     possibleFormats.add(BarcodeFormat.UPC_E);
  99     possibleFormats.add(BarcodeFormat.EAN_8);
 100     possibleFormats.add(BarcodeFormat.EAN_13);
 101     possibleFormats.add(BarcodeFormat.CODE_39);
 102     possibleFormats.add(BarcodeFormat.CODE_128);
 103     possibleFormats.add(BarcodeFormat.ITF);
 104     possibleFormats.add(BarcodeFormat.QR_CODE);
 105     possibleFormats.add(BarcodeFormat.DATAMATRIX);
 106     possibleFormats.add(BarcodeFormat.PDF417);
 107     HINTS.put(DecodeHintType.POSSIBLE_FORMATS, possibleFormats);
 108   }
 109
 110   private HttpParams params;
 111   private SchemeRegistry registry;
 112   private DiskFileItemFactory diskFileItemFactory;
 113
 114   @Override
 115   public void init(ServletConfig servletConfig) {
 116
 117     Logger logger = Logger.getLogger("com.google.zxing");
 118     logger.addHandler(new ServletContextLogHandler(servletConfig.getServletContext()));
 119
 120     params = new BasicHttpParams();
 121     HttpProtocolParams.setVersion(params, HttpVersion.HTTP_1_1);
 122
 123     registry = new SchemeRegistry();
 124     registry.register(new Scheme("http", PlainSocketFactory.getSocketFactory(), 80));
 125     registry.register(new Scheme("https", SSLSocketFactory.getSocketFactory(), 443));
 126
 127     diskFileItemFactory = new DiskFileItemFactory();
 128
 129     log.info("DecodeServlet configured");
 130   }
 131
 132   @Override
 133   protected void doGet(HttpServletRequest request, HttpServletResponse response)
 134       throws ServletException, IOException {
 135     String imageURIString = request.getParameter("u");
 136     if (imageURIString == null || imageURIString.length() == 0) {
 137       response.sendRedirect("badurl.jspx");
 138       return;
 139     }
 140
 141     if (!(imageURIString.startsWith("http://") || imageURIString.startsWith("https://"))) {
 142       imageURIString = "http://" + imageURIString;
 143     }
 144
 145     URI imageURI;
 146     try {
 147       imageURI = new URI(imageURIString);
 148     } catch (URISyntaxException urise) {
 149       response.sendRedirect("badurl.jspx");
 150       return;
 151     }
 152
 153     ClientConnectionManager connectionManager = new SingleClientConnManager(params, registry);
 154     HttpClient client = new DefaultHttpClient(connectionManager, params);
 155
 156     HttpUriRequest getRequest = new HttpGet(imageURI);
 157     getRequest.addHeader("Connection", "close"); // Avoids CLOSE_WAIT socket issue?
 158
 159     try {
 160
 161       HttpResponse getResponse;
 162       try {
 163         getResponse = client.execute(getRequest);
 164       } catch (IllegalArgumentException iae) {
 165         // Thrown if hostname is bad or null
 166         getRequest.abort();
 167         response.sendRedirect("badurl.jspx");
 168         return;
 169       } catch (SocketException se) {
 170         // Thrown if hostname is bad or null
 171         getRequest.abort();
 172         response.sendRedirect("badurl.jspx");
 173         return;
 174       } catch (UnknownHostException uhe) {
 175         getRequest.abort();
 176         response.sendRedirect("badurl.jspx");
 177         return;
 178       }
 179
 180       if (getResponse.getStatusLine().getStatusCode() != HttpServletResponse.SC_OK) {
 181         response.sendRedirect("badurl.jspx");
 182         return;
 183       }
 184       if (!isSizeOK(getResponse)) {
 185         response.sendRedirect("badimage.jspx");
 186         return;
 187       }
 188
 189       log.info("Decoding " + imageURI);
 190       HttpEntity entity = getResponse.getEntity();
 191       InputStream is = entity.getContent();
 192       try {
 193         processStream(is, request, response);
 194       } finally {
 195         entity.consumeContent();
 196         is.close();
 197       }
 198
 199     } finally {
 200       connectionManager.shutdown();
 201     }
 202
 203   }
 204
 205   @Override
 206   protected void doPost(HttpServletRequest request, HttpServletResponse response)
 207           throws ServletException, IOException {
 208
 209     if (!ServletFileUpload.isMultipartContent(request)) {
 210       response.sendRedirect("badimage.jspx");
 211       return;
 212     }
 213
 214     ServletFileUpload upload = new ServletFileUpload(diskFileItemFactory);
 215     upload.setFileSizeMax(MAX_IMAGE_SIZE);
 216
 217     // Parse the request
 218     try {
 219       for (FileItem item : (List<FileItem>) upload.parseRequest(request)) {
 220         if (!item.isFormField()) {
 221           if (item.getSize() <= MAX_IMAGE_SIZE) {
 222             log.info("Decoding uploaded file");
 223             InputStream is = item.getInputStream();
 224             try {
 225               processStream(is, request, response);
 226             } finally {
 227               is.close();
 228             }
 229           } else {
 230             response.sendRedirect("badimage.jspx");
 231           }
 232           break;
 233         }
 234       }
 235     } catch (FileUploadException fue) {
 236       response.sendRedirect("badimage.jspx");
 237     }
 238
 239   }
 240
 241   private static void processStream(InputStream is, ServletRequest request,
 242       HttpServletResponse response) throws ServletException, IOException {
 243     BufferedImage image = ImageIO.read(is);
 244     if (image == null) {
 245       response.sendRedirect("badimage.jspx");
 246       return;
 247     }
 248
 249     Reader reader = new MultiFormatReader();
 250     Result result;
 251     try {
 252       LuminanceSource source = new BufferedImageLuminanceSource(image);
 253       BinaryBitmap bitmap = new BinaryBitmap(new GlobalHistogramBinarizer(source));
 254       result = reader.decode(bitmap, HINTS);
 255     } catch (ReaderException re) {
 256       log.info("DECODE FAILED: " + re.toString());
 257       response.sendRedirect("notfound.jspx");
 258       return;
 259     }
 260
 261     if (request.getParameter("full") == null) {
 262       response.setContentType("text/plain");
 263       response.setCharacterEncoding("UTF8");
 264       Writer out = new OutputStreamWriter(response.getOutputStream(), "UTF8");
 265       try {
 266         out.write(result.getText());
 267       } finally {
 268         out.close();
 269       }
 270     } else {
 271       request.setAttribute("result", result);
 272       byte[] rawBytes = result.getRawBytes();
 273       if (rawBytes != null) {
 274         request.setAttribute("rawBytesString", arrayToString(rawBytes));
 275       } else {
 276         request.setAttribute("rawBytesString", "(Not applicable)");
 277       }
 278       String text = result.getText();
 279       if (text != null) {
 280         request.setAttribute("text", StringEscapeUtils.escapeXml(text));
 281       } else {
 282         request.setAttribute("text", "(Not applicable)");
 283       }
 284       ParsedResult parsedResult = ResultParser.parseResult(result);
 285       request.setAttribute("parsedResult", parsedResult);
 286       String displayResult = parsedResult.getDisplayResult();
 287       if (displayResult != null) {
 288         request.setAttribute("displayResult", StringEscapeUtils.escapeXml(displayResult));
 289       } else {
 290         request.setAttribute("displayResult", "(Not applicable)");
 291       }
 292       request.getRequestDispatcher("decoderesult.jspx").forward(request, response);
 293     }
 294   }
 295
 296   private static boolean isSizeOK(HttpMessage getResponse) {
 297     Header lengthHeader = getResponse.getLastHeader("Content-Length");
 298     if (lengthHeader != null) {
 299       long length = Long.parseLong(lengthHeader.getValue());
 300       if (length > MAX_IMAGE_SIZE) {
 301         return false;
 302       }
 303     }
 304     return true;
 305   }
 306
 307   private static String arrayToString(byte[] bytes) {
 308     int length = bytes.length;
 309     StringBuilder result = new StringBuilder(length << 2);
 310     int i = 0;
 311     while (i < length) {
 312       int max = Math.min(i + 8, length);
 313       for (int j = i; j < max; j++) {
 314         int value = bytes[j] & 0xFF;
 315         result.append(Integer.toHexString(value / 16));
 316         result.append(Integer.toHexString(value % 16));
 317         result.append(' ');
 318       }
 319       result.append('\n');
 320       i += 8;
 321     }
 322     for (int j = i - 8; j < length; j++) {
 323       result.append(Integer.toHexString(bytes[j] & 0xFF));
 324       result.append(' ');
 325     }
 326     return result.toString();
 327   }
 328
 329   @Override
 330   public void destroy() {
 331     log.config("DecodeServlet shutting down...");
 332   }
 333
 334 }