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