2 * Copyright 2008 Google Inc.
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.client.j2se.BufferedImageMonochromeBitmapSource;
25 import com.google.zxing.client.result.ParsedReaderResult;
26 import org.apache.commons.fileupload.FileItem;
27 import org.apache.commons.fileupload.FileUploadException;
28 import org.apache.commons.fileupload.disk.DiskFileItemFactory;
29 import org.apache.commons.fileupload.servlet.ServletFileUpload;
30 import org.apache.http.Header;
31 import org.apache.http.HttpException;
32 import org.apache.http.HttpMessage;
33 import org.apache.http.HttpResponse;
34 import org.apache.http.HttpVersion;
35 import org.apache.http.client.HttpClient;
36 import org.apache.http.client.methods.HttpGet;
37 import org.apache.http.conn.PlainSocketFactory;
38 import org.apache.http.conn.Scheme;
39 import org.apache.http.conn.SchemeRegistry;
40 import org.apache.http.conn.ssl.SSLSocketFactory;
41 import org.apache.http.impl.client.DefaultHttpClient;
42 import org.apache.http.impl.conn.tsccm.ThreadSafeClientConnManager;
43 import org.apache.http.params.BasicHttpParams;
44 import org.apache.http.params.HttpParams;
45 import org.apache.http.params.HttpProtocolParams;
47 import javax.imageio.ImageIO;
48 import javax.mail.Authenticator;
49 import javax.servlet.ServletConfig;
50 import javax.servlet.ServletException;
51 import javax.servlet.http.HttpServlet;
52 import javax.servlet.http.HttpServletRequest;
53 import javax.servlet.http.HttpServletResponse;
54 import java.awt.image.BufferedImage;
55 import java.io.IOException;
56 import java.io.InputStream;
57 import java.io.OutputStreamWriter;
58 import java.io.Writer;
60 import java.net.URISyntaxException;
61 import java.net.UnknownHostException;
62 import java.util.Arrays;
63 import java.util.Hashtable;
64 import java.util.List;
65 import java.util.Timer;
66 import java.util.logging.Logger;
69 * {@link HttpServlet} which decodes images containing barcodes. Given a URL, it will
70 * retrieve the image and decode it. It can also process image files uploaded via POST.
72 * @author Sean Owen (srowen@google.com)
74 public final class DecodeServlet extends HttpServlet {
76 private static final long MAX_IMAGE_SIZE = 500000L;
77 private static final long EMAIL_CHECK_INTERVAL = 2L * 60 * 1000;
79 private static final Logger log = Logger.getLogger(DecodeServlet.class.getName());
81 static final Hashtable<DecodeHintType, Object> HINTS;
84 HINTS = new Hashtable<DecodeHintType, Object>(3);
85 HINTS.put(DecodeHintType.TRY_HARDER, Boolean.TRUE);
88 private HttpClient client;
89 private DiskFileItemFactory diskFileItemFactory;
90 private Timer emailTimer;
93 public void init(ServletConfig servletConfig) throws ServletException {
95 Logger logger = Logger.getLogger("com.google.zxing");
96 logger.addHandler(new ServletContextLogHandler(servletConfig.getServletContext()));
98 String emailAddress = servletConfig.getInitParameter("emailAddress");
99 String emailPassword = servletConfig.getInitParameter("emailPassword");
100 if (emailAddress == null || emailPassword == null) {
101 throw new ServletException("emailAddress or emailPassword not specified");
104 HttpParams params = new BasicHttpParams();
105 HttpProtocolParams.setVersion(params, HttpVersion.HTTP_1_1);
107 SchemeRegistry registry = new SchemeRegistry();
108 registry.register(new Scheme("http", PlainSocketFactory.getSocketFactory(), 80));
109 registry.register(new Scheme("https", SSLSocketFactory.getSocketFactory(), 443));
111 client = new DefaultHttpClient(new ThreadSafeClientConnManager(params, registry), params);
113 diskFileItemFactory = new DiskFileItemFactory();
115 Authenticator emailAuthenticator = new EmailAuthenticator(emailAddress, emailPassword);
116 emailTimer = new Timer("Email decoder timer", true);
117 emailTimer.schedule(new DecodeEmailTask(emailAddress, emailAuthenticator), 0L, EMAIL_CHECK_INTERVAL);
119 log.info("DecodeServlet configured");
123 protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
125 String imageURIString = request.getParameter("u");
126 if (imageURIString == null || imageURIString.length() == 0) {
127 response.sendRedirect("badurl.jspx");
131 if (!(imageURIString.startsWith("http://") || imageURIString.startsWith("https://"))) {
132 imageURIString = "http://" + imageURIString;
137 imageURI = new URI(imageURIString);
138 } catch (URISyntaxException urise) {
139 response.sendRedirect("badurl.jspx");
143 HttpGet getRequest = new HttpGet(imageURI);
146 HttpResponse getResponse = client.execute(getRequest);
147 if (getResponse.getStatusLine().getStatusCode() != HttpServletResponse.SC_OK) {
148 response.sendRedirect("badurl.jspx");
151 if (!isSizeOK(getResponse)) {
152 response.sendRedirect("badimage.jspx");
155 log.info("Decoding " + imageURI);
156 InputStream is = getResponse.getEntity().getContent();
158 processStream(is, request, response);
162 } catch (InterruptedException ie) {
164 response.sendRedirect("badurl.jspx");
165 } catch (HttpException he) {
167 response.sendRedirect("badurl.jspx");
168 } catch (UnknownHostException uhe) {
170 response.sendRedirect("badurl.jspx");
176 protected void doPost(HttpServletRequest request, HttpServletResponse response)
177 throws ServletException, IOException {
179 if (!ServletFileUpload.isMultipartContent(request)) {
180 response.sendRedirect("badimage.jspx");
184 ServletFileUpload upload = new ServletFileUpload(diskFileItemFactory);
185 upload.setFileSizeMax(MAX_IMAGE_SIZE);
189 for (FileItem item : (List<FileItem>) upload.parseRequest(request)) {
190 if (!item.isFormField()) {
191 if (item.getSize() <= MAX_IMAGE_SIZE) {
192 log.info("Decoding uploaded file");
193 InputStream is = item.getInputStream();
195 processStream(is, request, response);
200 response.sendRedirect("badimage.jspx");
205 } catch (FileUploadException fue) {
206 response.sendRedirect("badimage.jspx");
211 private static void processStream(InputStream is, HttpServletRequest request, HttpServletResponse response)
212 throws ServletException, IOException {
213 BufferedImage image = ImageIO.read(is);
215 response.sendRedirect("badimage.jspx");
219 Reader reader = new MultiFormatReader();
222 result = reader.decode(new BufferedImageMonochromeBitmapSource(image), HINTS);
223 } catch (ReaderException re) {
224 log.info("DECODE FAILED: " + re.toString());
225 response.sendRedirect("notfound.jspx");
229 if (request.getParameter("full") == null) {
230 response.setContentType("text/plain");
231 response.setCharacterEncoding("UTF-8");
232 Writer out = new OutputStreamWriter(response.getOutputStream(), "UTF-8");
234 out.write(result.getText());
239 request.setAttribute("result", result);
240 byte[] rawBytes = result.getRawBytes();
241 if (rawBytes != null) {
242 request.setAttribute("rawBytesString", Arrays.toString(rawBytes));
244 request.setAttribute("rawBytesString", "(Not applicable)");
246 ParsedReaderResult parsedReaderResult = ParsedReaderResult.parseReaderResult(result);
247 request.setAttribute("parsedReaderResult", parsedReaderResult);
248 request.getRequestDispatcher("decoderesult.jspx").forward(request, response);
252 private static boolean isSizeOK(HttpMessage getResponse) {
253 Header lengthHeader = getResponse.getLastHeader("Content-Length");
254 if (lengthHeader != null) {
255 long length = Long.parseLong(lengthHeader.getValue());
256 if (length > MAX_IMAGE_SIZE) {
264 public void destroy() {
265 log.config("DecodeServlet shutting down...");