core/src/test/java/org/apache/james/mime4j/codec/QuotedPrintableInputStreamTest.java

/****************************************************************
 * Licensed to the Apache Software Foundation (ASF) under one   *
 * or more contributor license agreements.  See the NOTICE file *
 * distributed with this work for additional information        *
 * regarding copyright ownership.  The ASF licenses this file   *
 * to you under the Apache License, Version 2.0 (the            *
 * "License"); you may not use this file except in compliance   *
 * with the License.  You may obtain a copy of the License at   *
 *                                                              *
 *   http://www.apache.org/licenses/LICENSE-2.0                 *
 *                                                              *
 * Unless required by applicable law or agreed to in writing,   *
 * software distributed under the License is distributed on an  *
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY       *
 * KIND, either express or implied.  See the License for the    *
 * specific language governing permissions and limitations      *
 * under the License.                                           *
 ****************************************************************/

package org.apache.james.mime4j.codec;

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.UnsupportedEncodingException;

import junit.framework.TestCase;

public class QuotedPrintableInputStreamTest extends TestCase {

    public void testBasicDecode() throws IOException, UnsupportedEncodingException {
        ByteArrayInputStream bis = new ByteArrayInputStream("=e1=e2=E3=E4\r\n".getBytes("US-ASCII"));
        QuotedPrintableInputStream decoder = new QuotedPrintableInputStream(bis);
        assertEquals("\u00e1\u00e2\u00e3\u00e4\r\n", new String(read(decoder), "ISO8859-1"));
    }

    public void testDecodeBufferWrapping() throws IOException, UnsupportedEncodingException {
        ByteArrayInputStream bis = new ByteArrayInputStream(
                "=e1=e2=E3=E4\r\n=e1=e2=E3=E4\r\n=e1=e2=E3=E4\r\n=e1=e2=E3=E4\r\n=e1=e2=E3=E4\r\n".getBytes("US-ASCII"));
        QuotedPrintableInputStream decoder = new QuotedPrintableInputStream(bis);
        assertEquals("\u00e1\u00e2\u00e3\u00e4\r\n\u00e1\u00e2\u00e3\u00e4\r\n\u00e1\u00e2\u00e3" +
                "\u00e4\r\n\u00e1\u00e2\u00e3\u00e4\r\n\u00e1\u00e2\u00e3\u00e4\r\n", new String(read(decoder), "ISO8859-1"));
    }

    public void testInvalidValueDecode() throws IOException, UnsupportedEncodingException {
        ByteArrayInputStream bis = new ByteArrayInputStream("=e1=g2=E3=E4\r\n".getBytes("US-ASCII"));
        QuotedPrintableInputStream decoder = new QuotedPrintableInputStream(bis);
        assertEquals("\u00e1=g2\u00e3\u00e4\r\n", new String(read(decoder), "ISO8859-1"));
    }

    public void testDecodeTrailingBlanks() throws IOException, UnsupportedEncodingException {
        ByteArrayInputStream bis = new ByteArrayInputStream("   =e1 =e2  =E3\t=E4  \t \t    \r\n".getBytes("US-ASCII"));
        QuotedPrintableInputStream decoder = new QuotedPrintableInputStream(bis);
        assertEquals("   \u00e1 \u00e2  \u00e3\t\u00e4\r\n", new String(read(decoder), "ISO8859-1"));
    }

    public void testCanonicalSoftBreakDecode() throws IOException, UnsupportedEncodingException {
        ByteArrayInputStream bis = new ByteArrayInputStream("Soft line   =\r\nHard line   \r\n".getBytes("US-ASCII"));
        QuotedPrintableInputStream decoder = new QuotedPrintableInputStream(bis);
        assertEquals("Soft line   Hard line\r\n", new String(read(decoder), "ISO8859-1"));
    }

    public void testSoftBreakStrictMode() throws IOException {
        String input = "<?xml version=3D\"1.0\" standalone=3D\"no\"?>\r\n" +
                "<!DOCTYPE svg PUBLIC \"-//W3C//DTD SVG 1.1//EN\" \"http://www.w3.org/Graphics/=\r\n" +
                "SVG/1.1/DTD/svg11.dtd\" >\r\n";
        String expected = "<?xml version=\"1.0\" standalone=\"no\"?>\r\n" +
                "<!DOCTYPE svg PUBLIC \"-//W3C//DTD SVG 1.1//EN\" \"http://www.w3.org/Graphics/" +
                "SVG/1.1/DTD/svg11.dtd\" >\r\n";
        ByteArrayInputStream bis = new ByteArrayInputStream(input.getBytes("US-ASCII"));
        QuotedPrintableInputStream decoder = new QuotedPrintableInputStream(bis, DecodeMonitor.STRICT);
        assertEquals(expected, new String(read(decoder), "ISO8859-1"));
    }

    public void testInvalidCR() throws IOException {
        ByteArrayInputStream bis = new ByteArrayInputStream("Invalid=\rCR\rHard line   \r\n".getBytes("US-ASCII"));
        QuotedPrintableInputStream decoder = new QuotedPrintableInputStream(bis);
        assertEquals("Invalid=\rCR\rHard line\r\n", new String(read(decoder), "ISO8859-1"));
    }

    public void testInvalidCRStrictMode() throws IOException {
        ByteArrayInputStream bis = new ByteArrayInputStream("Invalid=\rCR\rHard line   \r\n".getBytes("US-ASCII"));
        QuotedPrintableInputStream decoder = new QuotedPrintableInputStream(bis, DecodeMonitor.STRICT);
        try {
            read(decoder);
            fail("IOException should have been thrown");
        } catch (IOException expected) {
        }
    }

    public void testSoftBreakLoneLFDecode() throws IOException, UnsupportedEncodingException {
        ByteArrayInputStream bis = new ByteArrayInputStream("Soft line   =\nHard line   \r\n".getBytes("US-ASCII"));
        QuotedPrintableInputStream decoder = new QuotedPrintableInputStream(bis);
        assertEquals("Soft line   Hard line\r\n", new String(read(decoder), "ISO8859-1"));
    }

    public void testSpaceBeforeSoftBreakStrictMode() throws IOException, UnsupportedEncodingException {
        ByteArrayInputStream bis = new ByteArrayInputStream("text before eq sign =\r\n text after LF".getBytes("US-ASCII"));
        QuotedPrintableInputStream decoder = new QuotedPrintableInputStream(bis,DecodeMonitor.STRICT);
        assertEquals("text before eq sign  text after LF", new String(read(decoder), "ISO8859-1"));
    }
    
    public void testSoftBreakTrailingBalnksDecode() throws IOException, UnsupportedEncodingException {
        ByteArrayInputStream bis = new ByteArrayInputStream("Soft line   = \t \r\nHard line   \r\n".getBytes("US-ASCII"));
        QuotedPrintableInputStream decoder = new QuotedPrintableInputStream(bis);
        assertEquals("Soft line   Hard line\r\n", new String(read(decoder), "ISO8859-1"));
    }

    public void testBrokenSoftBreakDecode() throws IOException, UnsupportedEncodingException {
        ByteArrayInputStream bis = new ByteArrayInputStream("Soft line   =\rHard line   \r\n".getBytes("US-ASCII"));
        QuotedPrintableInputStream decoder = new QuotedPrintableInputStream(bis);
        assertEquals("Soft line   =\rHard line\r\n", new String(read(decoder), "ISO8859-1"));
    }

    public void testEscapedEQDecode() throws IOException, UnsupportedEncodingException {
        ByteArrayInputStream bis = new ByteArrayInputStream("width==340 height=3d200\r\n".getBytes("US-ASCII"));
        QuotedPrintableInputStream decoder = new QuotedPrintableInputStream(bis);
        assertEquals("width=340 height=200\r\n", new String(read(decoder), "ISO8859-1"));
        // TODO this could be even decoded as width=40 height=200.
    }

    public void testBrokenEscapedEQDecode() throws IOException, UnsupportedEncodingException {
        /*
         * This isn't valid qp (==) but it is known to occur in certain
         * messages, especially spam.
         */
        ByteArrayInputStream bis = new ByteArrayInputStream("width==\r\n340 height=3d200\r\n".getBytes("US-ASCII"));
        QuotedPrintableInputStream decoder = new QuotedPrintableInputStream(bis);
        assertEquals("width=340 height=200\r\n", new String(read(decoder), "ISO8859-1"));
    }

    public void testSpacesBeforeEOL() throws IOException, UnsupportedEncodingException {
        ByteArrayInputStream bis = new ByteArrayInputStream("some \r\n spaced\t\r\ncontent \t \r\n".getBytes("US-ASCII"));
        QuotedPrintableInputStream decoder = new QuotedPrintableInputStream(bis);
        assertEquals("some\r\n spaced\r\ncontent\r\n", new String(read(decoder), "ISO8859-1"));
    }


    public void testDecodeEndOfStream1() throws IOException, UnsupportedEncodingException {
        ByteArrayInputStream bis = new ByteArrayInputStream("01234567".getBytes("US-ASCII"));
        QuotedPrintableInputStream decoder = new QuotedPrintableInputStream(6, bis, false);
        assertEquals("01234567", new String(read(decoder), "ISO8859-1"));
    }

    public void testDecodeEndOfStream2() throws IOException, UnsupportedEncodingException {
        ByteArrayInputStream bis = new ByteArrayInputStream("012345\r".getBytes("US-ASCII"));
        QuotedPrintableInputStream decoder = new QuotedPrintableInputStream(6, bis, false);
        assertEquals("012345", new String(read(decoder), "ISO8859-1"));
    }

    public void testDecodeEndOfStream3() throws IOException, UnsupportedEncodingException {
        ByteArrayInputStream bis = new ByteArrayInputStream("012345\n".getBytes("US-ASCII"));
        QuotedPrintableInputStream decoder = new QuotedPrintableInputStream(6, bis, false);
        assertEquals("012345\r\n", new String(read(decoder), "ISO8859-1"));
    }

    public void testDecodeEndOfStream4() throws IOException, UnsupportedEncodingException {
        ByteArrayInputStream bis = new ByteArrayInputStream("01234= ".getBytes("US-ASCII"));
        QuotedPrintableInputStream decoder = new QuotedPrintableInputStream(6, bis, false);
        assertEquals("01234", new String(read(decoder), "ISO8859-1"));
    }

    public void testDecodeEndOfStream5() throws IOException, UnsupportedEncodingException {
        ByteArrayInputStream bis = new ByteArrayInputStream("01234=\r\n".getBytes("US-ASCII"));
        QuotedPrintableInputStream decoder = new QuotedPrintableInputStream(6, bis, false);
        assertEquals("01234", new String(read(decoder), "ISO8859-1"));
    }

    public void testDecodeEndOfStream6() throws IOException, UnsupportedEncodingException {
        ByteArrayInputStream bis = new ByteArrayInputStream("01234\r\n".getBytes("US-ASCII"));
        QuotedPrintableInputStream decoder = new QuotedPrintableInputStream(6, bis, false);
        assertEquals("01234\r\n", new String(read(decoder), "ISO8859-1"));
    }

    public void testDecodePrematureClose() throws IOException, UnsupportedEncodingException {
        ByteArrayInputStream bis = null;
        QuotedPrintableInputStream decoder = null;

        bis = new ByteArrayInputStream("=e1=e2=E3=E4\r\n".getBytes("US-ASCII"));
        decoder = new QuotedPrintableInputStream(bis);
        assertEquals('\u00e1', decoder.read());
        assertEquals('\u00e2', decoder.read());
        decoder.close();

        try {
            decoder.read();
            fail();
        } catch (IOException expected) {
        }
    }

    private byte[] read(InputStream is) throws IOException {
        ByteArrayOutputStream bos = new ByteArrayOutputStream();
        int b;
        while ((b = is.read()) != -1) {
            bos.write(b);
        }
        return bos.toByteArray();
    }
}