/***********************************************************************************************************************
 Copyright (c) 2003, International Barcode Consortium
 All rights reserved.

 Redistribution and use in source and binary forms, with or without modification,
 are permitted provided that the following conditions are met:

 * Redistributions of source code must retain the above copyright notice, this list of
 conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright notice, this list of
 conditions and the following disclaimer in the documentation and/or other materials
 provided with the distribution.
 * Neither the name of the International Barcode Consortium nor the names of any contributors may be used to endorse
 or promote products derived from this software without specific prior written permission.

 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
 AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 POSSIBILITY OF SUCH DAMAGE.
 ***********************************************************************************************************************/

package net.sourceforge.barbecue;

import net.sourceforge.barbecue.env.EnvironmentFactory;
import net.sourceforge.barbecue.env.HeadlessEnvironment;
import net.sourceforge.barbecue.linear.code128.Code128Barcode;
import net.sourceforge.barbecue.linear.ean.UCCEAN128Barcode;

import javax.servlet.RequestDispatcher;
import javax.servlet.ServletException;
import javax.servlet.ServletInputStream;
import javax.servlet.ServletOutputStream;
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.PrintWriter;
import java.io.UnsupportedEncodingException;
import java.security.Principal;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.Locale;
import java.util.Map;

public class BarcodeServletTest extends BarcodeTestCase {
    private BarcodeServletMock servlet;
    private HttpServletResponseMock res;
    private HttpServletRequestMock req;
    private Map params;

    protected void setUp() throws Exception {
        super.setUp();
        servlet = new BarcodeServletMock();
        req = new HttpServletRequestMock();
        params = new HashMap();
        params.put("data", "1234567890");
        params.put("type", "SSCC18");
        params.put("resolution", "100");
        req.setParameters(params);
        res = new HttpServletResponseMock();
    }

    public void testValueIsRequired() throws Exception {
        params.remove("data");
        try {
            servlet.doGet(req, res);
            fail();
        } catch (ServletException e) {
            // Good
        }
    }

    public void testGetReturnsBarcodeImage() throws Exception {
        servlet.doGet(req, res);
        assertEquals("image/png", res.getContentType());
        assertTrue(res.hasOutput());
    }

    public void testPostReturnsBarcodeImage() throws Exception {
        servlet.doPost(req, res);
        assertEquals("image/png", res.getContentType());
        assertTrue(res.hasOutput());
    }

    public void testServletNameReturnsBarbecue() throws Exception {
        assertEquals("barbecue", servlet.getServletName());
    }

    public void testSettingResolutionChangesDefaultResolution() throws Exception {
        params.put("height", "200");
        params.put("width", "3");
        params.put("resolution", "72");
        req.setParameters(params);
        servlet.doGet(req, res);
        Barcode barcode = servlet.getBarcode();
        assertEquals(72, barcode.getResolution());
    }

    public void testGettingBarcodeWithNoTypeCreatesCode128Optimal() throws Exception {
        req.setParameters(params);
        servlet.doGet(req, res);
        assertTrue(servlet.getBarcode() instanceof Code128Barcode);
    }

    public void testSettingTypeToUCC128WithNoAppIdThrowsException() throws Exception {
        params.put("type", "UCC128");
        req.setParameters(params);
        try {
            servlet.doGet(req, res);
            fail();
        } catch (ServletException e) {
            // OK
        }
    }

    /**
     * Verifies fix for bug: 732629
     */
    public void testSettingWidthChangesDefault() throws Exception {
        params.put("data", "12345");
        params.put("width", "3");
        req.setParameters(params);
        servlet.doGet(req, res);
        assertEquals("image/png", res.getContentType());
        assertTrue(res.hasOutput());
        Barcode barcode = servlet.getBarcode();
        assertEquals(330, barcode.getWidth());
    }

    /**
     * Verifies fix for bug: 736794
     */
    public void testGettingUCC128BarcodeReturnsCorrectType() throws Exception {
        params.put("type", "UCC128");
        params.put("appid", UCCEAN128Barcode.GTIN_AI);
        req.setParameters(params);
        servlet.doGet(req, res);
        assertEquals("image/png", res.getContentType());
        assertTrue(res.hasOutput());
    }

    /**
     * Verifies fix for bug: 737122
     */
    public void testCanGetAllBarcodeTypes() throws Exception {
        assertCanGenerateBarcodeInServlet("EAN128");
        assertCanGenerateBarcodeInServlet("ean128");
        assertCanGenerateBarcodeInServlet("Code128");
        assertCanGenerateBarcodeInServlet("Code128A");
        assertCanGenerateBarcodeInServlet("Code128B");
        assertCanGenerateBarcodeInServlet("Code128C");
        assertCanGenerateBarcodeInServlet("code128c");
        assertCanGenerateBarcodeInServlet("USPS");
        assertCanGenerateBarcodeInServlet("usps");
        assertCanGenerateBarcodeInServlet("ShipmentIdentificationNumber");
        assertCanGenerateBarcodeInServlet("shipmentIdentificationnumber");
        assertCanGenerateBarcodeInServlet("SCC14ShippingCode");
        assertCanGenerateBarcodeInServlet("SCC14SHIPPINGcode");
        assertCanGenerateBarcodeInServlet("GlobalTradeItemNumber");
        assertCanGenerateBarcodeInServlet("PDF417");
        assertCanGenerateBarcodeInServlet("Code39");
        assertCanGenerateBarcodeInServlet("Std2of5");
        assertCanGenerateBarcodeInServlet("Int2of5");
        assertCanGenerateBarcodeInServlet("3of9");
        assertCanGenerateBarcodeInServlet("USD3");
        assertCanGenerateBarcodeInServlet("USD4");
        assertCanGenerateBarcodeInServlet("NW7");
        assertCanGenerateBarcodeInServlet("Monarch");
        assertCanGenerateBarcodeInServlet("2of7");
        assertCanGenerateBarcodeInServlet("Codabar");
    }

    public void testCheckSumParameterIsUsedForCode39Barcodes() throws Exception {
        params.put("type", "Code39");
        params.put("checksum", "true");
        params.put("data", "1234567890");
        req.setParameters(params);
        servlet.doGet(req, res);
        Barcode barcode = servlet.getBarcode();
        assertEquals(336, barcode.getWidth());
    }

    public void testServletForcesHeadlessModeByDefault() throws Exception {
        params.put("type", "Code128");
        req.setParameters(params);
        servlet.doGet(req, res);
        assertTrue(EnvironmentFactory.getEnvironment() instanceof HeadlessEnvironment);
    }

    public void testDrawTextParameterIsIgnoredIfHeadless() throws Exception {
        params.put("type", "Code128");
        params.put("drawText", "true");
        req.setParameters(params);
        servlet.doGet(req, res);
        Barcode barcode = servlet.getBarcode();
        assertFalse(barcode.isDrawingText());
    }

    public void testDrawTextParameterIsNotIgnoredIfNotHeadless() throws Exception {
        params.put("type", "Code128");
        params.put("headless", "false");
        params.put("drawText", "true");
        req.setParameters(params);
        servlet.doGet(req, res);
        Barcode barcode = servlet.getBarcode();
        assertTrue(barcode.isDrawingText());
    }

    private void assertCanGenerateBarcodeInServlet(String type) throws ServletException {
        params.put("type", type);
        req.setParameters(params);
        servlet.doGet(req, res);
        assertEquals("image/png", res.getContentType());
        assertTrue(res.hasOutput());
    }

    private class BarcodeServletMock extends BarcodeServlet {
        Barcode barcode;

        protected Barcode getBarcode(String type, String data, String appId, boolean checkSum) throws ServletException {
            barcode = super.getBarcode(type, data, appId, checkSum);
            return barcode;
        }

        public Barcode getBarcode() {
            return barcode;
        }
    }

    private class HttpServletResponseMock implements HttpServletResponse {
        private String contentType;
        private ServletOutputStreamMock outputStream;

        public HttpServletResponseMock() {
            outputStream = new ServletOutputStreamMock();
        }

        public void addCookie(Cookie cookie) {
        }

        public void addDateHeader(String s, long l) {
        }

        public void addHeader(String s, String s1) {
        }

        public void addIntHeader(String s, int i) {
        }

        public boolean containsHeader(String s) {
            return false;
        }

        public String encodeRedirectURL(String s) {
            return null;
        }

        public String encodeRedirectUrl(String s) {
            return null;
        }

        public String encodeURL(String s) {
            return null;
        }

        public String encodeUrl(String s) {
            return null;
        }

        public void sendError(int i) throws IOException {
        }

        public void sendError(int i, String s) throws IOException {
        }

        public void sendRedirect(String s) throws IOException {
        }