aboutsummaryrefslogtreecommitdiffstats
path: root/src/scratchpad/testcases/org/apache/poi/hmef/TestCompressedRTF.java
blob: d8781c22c1c2c286e693fac547a240775c1cddde (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
/* ====================================================================
   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.poi.hmef;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;

import java.io.ByteArrayInputStream;
import java.io.InputStream;

import org.apache.poi.POIDataSamples;
import org.apache.poi.hmef.attribute.MAPIAttribute;
import org.apache.poi.hmef.attribute.MAPIRtfAttribute;
import org.apache.poi.hsmf.datatypes.MAPIProperty;
import org.apache.poi.util.IOUtils;
import org.apache.poi.util.LittleEndian;
import org.apache.poi.util.StringUtil;
import org.junit.Test;

public final class TestCompressedRTF {
    private static final POIDataSamples _samples = POIDataSamples.getHMEFInstance();

    private static final String block1 = "{\\rtf1\\adeflang102";
    private static final String block2 = block1 + "5\\ansi\\ansicpg1252";

    /**
     * Check that things are as we expected. If this fails,
     * then decoding has no hope...
     */
    @Test
    public void testQuickBasics() throws Exception {
        HMEFMessage msg;
        try (InputStream is = _samples.openResourceAsStream("quick-winmail.dat")) {
            msg = new HMEFMessage(is);
        }

        MAPIAttribute rtfAttr = msg.getMessageMAPIAttribute(MAPIProperty.RTF_COMPRESSED);
        assertNotNull(rtfAttr);
        assertTrue(rtfAttr instanceof MAPIRtfAttribute);

        // Check the start of the compressed version
        byte[] data = ((MAPIRtfAttribute) rtfAttr).getRawData();
        assertEquals(5907, data.length);

        // First 16 bytes is header stuff
        // Check it has the length + compressed marker
        assertEquals(5907 - 4, LittleEndian.getShort(data));
        assertEquals(
                "LZFu",
                StringUtil.getFromCompressedUnicode(data, 8, 4)
        );


        // Now Look at the code
        assertEquals((byte) 0x07, data[16 + 0]);  // Flag: cccUUUUU
        assertEquals((byte) 0x00, data[16 + 1]);  //  c1a: offset 0 / 0x000
        assertEquals((byte) 0x06, data[16 + 2]);  //  c1b: length 6+2  -> {\rtf1\a
        assertEquals((byte) 0x01, data[16 + 3]);  //  c2a: offset 16 / 0x010
        assertEquals((byte) 0x01, data[16 + 4]);  //  c2b: length 1+2  ->  def
        assertEquals((byte) 0x0b, data[16 + 5]);  //  c3a: offset 182 / 0xb6
        assertEquals((byte) 0x60, data[16 + 6]);  //  c3b: length 0+2  -> la
        assertEquals((byte) 0x6e, data[16 + 7]);  // n
        assertEquals((byte) 0x67, data[16 + 8]);  // g
        assertEquals((byte) 0x31, data[16 + 9]);  // 1
        assertEquals((byte) 0x30, data[16 + 10]); // 0
        assertEquals((byte) 0x32, data[16 + 11]); // 2

        assertEquals((byte) 0x66, data[16 + 12]); // Flag:  UccUUccU
        assertEquals((byte) 0x35, data[16 + 13]); // 5
        assertEquals((byte) 0x00, data[16 + 14]); //  c2a: offset 6 / 0x006
        assertEquals((byte) 0x64, data[16 + 15]); //  c2b: length 4+2  -> \ansi\a
        assertEquals((byte) 0x00, data[16 + 16]); //  c3a: offset 7 / 0x007
        assertEquals((byte) 0x72, data[16 + 17]); //  c3b: length 2+2  -> nsi
        assertEquals((byte) 0x63, data[16 + 18]); // c
        assertEquals((byte) 0x70, data[16 + 19]); // p
        assertEquals((byte) 0x0d, data[16 + 20]); //  c6a: offset 221 / 0x0dd
        assertEquals((byte) 0xd0, data[16 + 21]); //  c6b: length 0+2  -> g1
        assertEquals((byte) 0x0e, data[16 + 22]); //  c7a: offset 224 / 0x0e0
        assertEquals((byte) 0x00, data[16 + 23]); //  c7b: length 0+2  -> 25
        assertEquals((byte) 0x32, data[16 + 24]); // 2
    }

    /**
     * Check that we can decode the first 8 codes
     * (1 flag byte + 8 codes)
     */
    @Test
    public void testFirstBlock() throws Exception {
        HMEFMessage msg;
        try (InputStream is = _samples.openResourceAsStream("quick-winmail.dat")) {
            msg = new HMEFMessage(is);
        }

        MAPIAttribute attr = msg.getMessageMAPIAttribute(MAPIProperty.RTF_COMPRESSED);
        assertNotNull(attr);
        MAPIRtfAttribute rtfAttr = (MAPIRtfAttribute) attr;

        // Truncate to header + flag + data for flag
        byte[] data = new byte[16 + 12];
        System.arraycopy(rtfAttr.getRawData(), 0, data, 0, data.length);

        // Decompress it
        CompressedRTF comp = new CompressedRTF();
        byte[] decomp = comp.decompress(new ByteArrayInputStream(data));
        String decompStr = new String(decomp, "ASCII");

        // Test
        assertEquals(block1.length(), decomp.length);
        assertEquals(block1, decompStr);
    }

    /**
     * Check that we can decode the first 16 codes
     * (flag + 8 codes, flag + 8 codes)
     */
    @Test
    public void testFirstTwoBlocks() throws Exception {
        HMEFMessage msg;
        try (InputStream is = _samples.openResourceAsStream("quick-winmail.dat")) {
            msg = new HMEFMessage(is);
        }

        MAPIAttribute attr = msg.getMessageMAPIAttribute(MAPIProperty.RTF_COMPRESSED);
        assertNotNull(attr);
        MAPIRtfAttribute rtfAttr = (MAPIRtfAttribute) attr;

        // Truncate to header + flag + data for flag + flag + data
        byte[] data = new byte[16 + 12 + 13];
        System.arraycopy(rtfAttr.getRawData(), 0, data, 0, data.length);

        // Decompress it
        CompressedRTF comp = new CompressedRTF();
        byte[] decomp = comp.decompress(new ByteArrayInputStream(data));
        String decompStr = new String(decomp, "ASCII");

        // Test
        assertEquals(block2.length(), decomp.length);
        assertEquals(block2, decompStr);
    }

    /**
     * Check that we can correctly decode the whole file
     * TODO Fix what looks like a padding issue
     */
    @Test
    public void testFull() throws Exception {
        final HMEFMessage msg;
        try (InputStream is = _samples.openResourceAsStream("quick-winmail.dat")) {
            msg = new HMEFMessage(is);
        }

        MAPIAttribute attr = msg.getMessageMAPIAttribute(MAPIProperty.RTF_COMPRESSED);
        assertNotNull(attr);
        MAPIRtfAttribute rtfAttr = (MAPIRtfAttribute) attr;

        final byte[] expected;
        try (InputStream stream = _samples.openResourceAsStream("quick-contents/message.rtf")) {
            expected = IOUtils.toByteArray(stream);
        }

        CompressedRTF comp = new CompressedRTF();
        byte[] data = rtfAttr.getRawData();
        byte[] decomp = comp.decompress(new ByteArrayInputStream(data));

        // Check the length was as expected
        assertEquals(data.length, comp.getCompressedSize() + 16);
        assertEquals(expected.length, comp.getDeCompressedSize());

        // Will have been padded though
        assertEquals(expected.length + 2, decomp.length);
        byte[] tmp = new byte[expected.length];
        System.arraycopy(decomp, 0, tmp, 0, tmp.length);
        decomp = tmp;

        // By byte
        assertEquals(expected.length, decomp.length);
        for (int i = 0; i < expected.length; i++) {
            assertEquals(expected[i], decomp[i]);
        }

        // By String
        String expString = new String(expected, "ASCII");
        String decompStr = rtfAttr.getDataString();
        assertEquals(expString.length(), decompStr.length());
        assertEquals(expString, decompStr);
    }
}