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 (HttpException he) {
 174       getRequest.abort();
 175       response.sendRedirect("badurl.jspx");
 176     } catch (UnknownHostException uhe) {
 177       getRequest.abort();
 178       response.sendRedirect("badurl.jspx");
 179     }
 180
 181   }
 182
 183   @Override
 184   protected void doPost(HttpServletRequest request, HttpServletResponse response)
 185           throws ServletException, IOException {
 186
 187     if (!ServletFileUpload.isMultipartContent(request)) {
 188       response.sendRedirect("badimage.jspx");
 189       return;
 190     }
 191
 192     ServletFileUpload upload = new ServletFileUpload(diskFileItemFactory);
 193     upload.setFileSizeMax(MAX_IMAGE_SIZE);
 194
 195     // Parse the request
 196     try {
 197       for (FileItem item : (List<FileItem>) upload.parseRequest(request)) {
 198         if (!item.isFormField()) {
 199           if (item.getSize() <= MAX_IMAGE_SIZE) {
 200             log.info("Decoding uploaded file");
 201             InputStream is = item.getInputStream();
 202             try {
 203               processStream(is, request, response);
 204             } finally {
 205               is.close();
 206             }
 207           } else {
 208             response.sendRedirect("badimage.jspx");
 209           }
 210           break;
 211         }
 212       }
 213     } catch (FileUploadException fue) {
 214       response.sendRedirect("badimage.jspx");
 215     }
 216
 217   }
 218
 219   private static void processStream(InputStream is, HttpServletRequest request, HttpServletResponse response)
 220       throws ServletException, IOException {
 221     BufferedImage image = ImageIO.read(is);
 222     if (image == null) {
 223       response.sendRedirect("badimage.jspx");
 224       return;
 225     }
 226
 227     Reader reader = new MultiFormatReader();
 228     Result result;
 229     try {
 230       result = reader.decode(new BufferedImageMonochromeBitmapSource(image), HINTS);
 231     } catch (ReaderException re) {
 232       log.info("DECODE FAILED: " + re.toString());
 233       response.sendRedirect("notfound.jspx");
 234       return;
 235     }
 236
 237     if (request.getParameter("full") == null) {
 238       response.setContentType("text/plain");
 239       response.setCharacterEncoding("UTF8");
 240       Writer out = new OutputStreamWriter(response.getOutputStream(), "UTF8");
 241       try {
 242         out.write(result.getText());
 243       } finally {
 244         out.close();
 245       }
 246     } else {
 247       request.setAttribute("result", result);
 248       byte[] rawBytes = result.getRawBytes();
 249       if (rawBytes != null) {
 250         request.setAttribute("rawBytesString", arrayToString(rawBytes));
 251       } else {
 252         request.setAttribute("rawBytesString", "(Not applicable)");
 253       }
 254       String text = result.getText();
 255       if (text != null) {
 256         request.setAttribute("text", StringEscapeUtils.escapeXml(text));
 257       } else {
 258         request.setAttribute("text", "(Not applicable)");
 259       }
 260       ParsedResult parsedResult = ResultParser.parseResult(result);
 261       request.setAttribute("parsedResult", parsedResult);
 262       String displayResult = parsedResult.getDisplayResult();
 263       if (displayResult != null) {
 264         request.setAttribute("displayResult", StringEscapeUtils.escapeXml(displayResult));
 265       } else {
 266         request.setAttribute("displayResult", "(Not applicable)");
 267       }
 268       request.getRequestDispatcher("decoderesult.jspx").forward(request, response);
 269     }
 270   }
 271
 272   private static boolean isSizeOK(HttpMessage getResponse) {
 273     Header lengthHeader = getResponse.getLastHeader("Content-Length");
 274     if (lengthHeader != null) {
 275       long length = Long.parseLong(lengthHeader.getValue());
 276       if (length > MAX_IMAGE_SIZE) {
 277         return false;
 278       }
 279     }
 280     return true;
 281   }
 282
 283   private static String arrayToString(byte[] bytes) {
 284     int length = bytes.length;
 285     StringBuilder result = new StringBuilder(length << 2);
 286     int i = 0;
 287     while (i < length) {
 288       int max = Math.min(i + 8, length);
 289       for (int j = i; j < max; j++) {
 290         int value = bytes[j] & 0xFF;
 291         result.append(Integer.toHexString(value / 16));
 292         result.append(Integer.toHexString(value % 16));
 293         result.append(' ');
 294       }
 295       result.append('\n');
 296       i += 8;
 297     }
 298     for (int j = i - 8; j < length; j++) {
 299       result.append(Integer.toHexString(bytes[j] & 0xFF));
 300       result.append(' ');
 301     }
 302     return result.toString();
 303   }
 304
 305   @Override
 306   public void destroy() {
 307     log.config("DecodeServlet shutting down...");
 308   }
 309
 310 }