2 * Copyright 2008 ZXing authors
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 package com.google.zxing.web;
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;
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;
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;
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.
77 public final class DecodeServlet extends HttpServlet {
79 private static final long MAX_IMAGE_SIZE = 500000L;
81 private static final Logger log = Logger.getLogger(DecodeServlet.class.getName());
83 static final Hashtable<DecodeHintType, Object> HINTS;
86 HINTS = new Hashtable<DecodeHintType, Object>(5);
87 HINTS.put(DecodeHintType.TRY_HARDER, Boolean.TRUE);
88 Vector<BarcodeFormat> possibleFormats = new Vector<BarcodeFormat>();
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);
101 private HttpClient client;
102 private DiskFileItemFactory diskFileItemFactory;
105 public void init(ServletConfig servletConfig) {
107 Logger logger = Logger.getLogger("com.google.zxing");
108 logger.addHandler(new ServletContextLogHandler(servletConfig.getServletContext()));
110 HttpParams params = new BasicHttpParams();
111 HttpProtocolParams.setVersion(params, HttpVersion.HTTP_1_1);
113 SchemeRegistry registry = new SchemeRegistry();
114 registry.register(new Scheme("http", PlainSocketFactory.getSocketFactory(), 80));
115 registry.register(new Scheme("https", SSLSocketFactory.getSocketFactory(), 443));
117 client = new DefaultHttpClient(new ThreadSafeClientConnManager(params, registry), params);
119 diskFileItemFactory = new DiskFileItemFactory();
121 log.info("DecodeServlet configured");
125 protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
127 String imageURIString = request.getParameter("u");
128 if (imageURIString == null || imageURIString.length() == 0) {
129 response.sendRedirect("badurl.jspx");
133 if (!(imageURIString.startsWith("http://") || imageURIString.startsWith("https://"))) {
134 imageURIString = "http://" + imageURIString;
139 imageURI = new URI(imageURIString);
140 } catch (URISyntaxException urise) {
141 response.sendRedirect("badurl.jspx");
145 HttpGet getRequest = new HttpGet(imageURI);
146 getRequest.addHeader("Connection", "close"); // Avoids CLOSE_WAIT socket issue?
149 HttpResponse getResponse = client.execute(getRequest);
150 if (getResponse.getStatusLine().getStatusCode() != HttpServletResponse.SC_OK) {
151 response.sendRedirect("badurl.jspx");
154 if (!isSizeOK(getResponse)) {
155 response.sendRedirect("badimage.jspx");
158 log.info("Decoding " + imageURI);
159 InputStream is = getResponse.getEntity().getContent();
161 processStream(is, request, response);
165 } catch (IllegalArgumentException iae) {
166 // Thrown if hostname is bad or null
168 response.sendRedirect("badurl.jspx");
169 } catch (SocketException se) {
170 // Thrown if hostname is bad or null
172 response.sendRedirect("badurl.jspx");
173 } catch (UnknownHostException uhe) {
175 response.sendRedirect("badurl.jspx");
181 protected void doPost(HttpServletRequest request, HttpServletResponse response)
182 throws ServletException, IOException {
184 if (!ServletFileUpload.isMultipartContent(request)) {
185 response.sendRedirect("badimage.jspx");
189 ServletFileUpload upload = new ServletFileUpload(diskFileItemFactory);
190 upload.setFileSizeMax(MAX_IMAGE_SIZE);
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();
200 processStream(is, request, response);
205 response.sendRedirect("badimage.jspx");
210 } catch (FileUploadException fue) {
211 response.sendRedirect("badimage.jspx");
216 private static void processStream(InputStream is, HttpServletRequest request, HttpServletResponse response)
217 throws ServletException, IOException {
218 BufferedImage image = ImageIO.read(is);
220 response.sendRedirect("badimage.jspx");
224 Reader reader = new MultiFormatReader();
227 result = reader.decode(new BufferedImageMonochromeBitmapSource(image), HINTS);
228 } catch (ReaderException re) {
229 log.info("DECODE FAILED: " + re.toString());
230 response.sendRedirect("notfound.jspx");
234 if (request.getParameter("full") == null) {
235 response.setContentType("text/plain");
236 response.setCharacterEncoding("UTF8");
237 Writer out = new OutputStreamWriter(response.getOutputStream(), "UTF8");
239 out.write(result.getText());
244 request.setAttribute("result", result);
245 byte[] rawBytes = result.getRawBytes();
246 if (rawBytes != null) {
247 request.setAttribute("rawBytesString", arrayToString(rawBytes));
249 request.setAttribute("rawBytesString", "(Not applicable)");
251 String text = result.getText();
253 request.setAttribute("text", StringEscapeUtils.escapeXml(text));
255 request.setAttribute("text", "(Not applicable)");
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));
263 request.setAttribute("displayResult", "(Not applicable)");
265 request.getRequestDispatcher("decoderesult.jspx").forward(request, response);
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) {
280 private static String arrayToString(byte[] bytes) {
281 int length = bytes.length;
282 StringBuilder result = new StringBuilder(length << 2);
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));
295 for (int j = i - 8; j < length; j++) {
296 result.append(Integer.toHexString(bytes[j] & 0xFF));
299 return result.toString();
303 public void destroy() {
304 log.config("DecodeServlet shutting down...");