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