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