poi/src/scratchpad/testcases/org/apache/poi/hmef/TestHMEFMessage.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.poi.hmef;

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

import org.apache.poi.hmef.attribute.MAPIRtfAttribute;
import org.apache.poi.hmef.attribute.TNEFProperty;
import org.apache.poi.hsmf.datatypes.MAPIProperty;
import org.apache.poi.util.LittleEndian;

public final class TestHMEFMessage extends HMEFTest {
	public void testOpen() throws Exception {
		HMEFMessage msg = new HMEFMessage(
                _samples.openResourceAsStream("quick-winmail.dat")
		);

		assertNotNull(msg);
	}

	public void testCounts() throws Exception {
      HMEFMessage msg = new HMEFMessage(
            _samples.openResourceAsStream("quick-winmail.dat")
      );
      
      // Should have 4 attributes on the message
      assertEquals(4, msg.getMessageAttributes().size());
      
      // And should have 54 MAPI attributes on it
      assertEquals(54, msg.getMessageMAPIAttributes().size());
      
      
      // Should have 5 attachments
      assertEquals(5, msg.getAttachments().size());
      
      // Each attachment should have 6 normal attributes, and 
      //  20 or so MAPI ones
      for(Attachment attach : msg.getAttachments()) {
         int attrCount = attach.getAttributes().size();
         int mapiAttrCount = attach.getMAPIAttributes().size();
         
         assertEquals(6, attrCount);
         assertTrue("Should be 20-25 mapi attributes, found " + mapiAttrCount, mapiAttrCount >= 20);
         assertTrue("Should be 20-25 mapi attributes, found " + mapiAttrCount, mapiAttrCount <= 25);
      }
	}
	
	public void testBasicMessageAttributes() throws Exception {
      HMEFMessage msg = new HMEFMessage(
            _samples.openResourceAsStream("quick-winmail.dat")
      );
      
      // Should have version, codepage, class and MAPI
      assertEquals(4, msg.getMessageAttributes().size());
      assertNotNull(msg.getMessageAttribute(TNEFProperty.ID_TNEFVERSION));
      assertNotNull(msg.getMessageAttribute(TNEFProperty.ID_OEMCODEPAGE));
      assertNotNull(msg.getMessageAttribute(TNEFProperty.ID_MESSAGECLASS));
      assertNotNull(msg.getMessageAttribute(TNEFProperty.ID_MAPIPROPERTIES));
      
      // Check the order
      assertEquals(TNEFProperty.ID_TNEFVERSION, msg.getMessageAttributes().get(0).getProperty());
      assertEquals(TNEFProperty.ID_OEMCODEPAGE, msg.getMessageAttributes().get(1).getProperty());
      assertEquals(TNEFProperty.ID_MESSAGECLASS, msg.getMessageAttributes().get(2).getProperty());
      assertEquals(TNEFProperty.ID_MAPIPROPERTIES, msg.getMessageAttributes().get(3).getProperty());
      
      // Check some that aren't there
      assertNull(msg.getMessageAttribute(TNEFProperty.ID_AIDOWNER));
      assertNull(msg.getMessageAttribute(TNEFProperty.ID_ATTACHDATA));
      
      // Now check the details of one or two
      assertEquals(
            0x010000, 
            LittleEndian.getInt( msg.getMessageAttribute(TNEFProperty.ID_TNEFVERSION).getData() )
      );
      assertEquals(
            "IPM.Microsoft Mail.Note\0", 
            new String(msg.getMessageAttribute(TNEFProperty.ID_MESSAGECLASS).getData(), "ASCII")
      );
	}
   
   public void testBasicMessageMAPIAttributes() throws Exception {
      HMEFMessage msg = new HMEFMessage(
            _samples.openResourceAsStream("quick-winmail.dat")
      );
      
      assertEquals("This is a test message", msg.getSubject());
      assertEquals("{\\rtf1", msg.getBody().substring(0, 6));
   }

   /**
    * Checks that the compressed RTF message contents
    *  can be correctly extracted
    */
   public void testMessageContents() throws Exception {
      HMEFMessage msg = new HMEFMessage(
            _samples.openResourceAsStream("quick-winmail.dat")
      );
      
      // Firstly by byte
      MAPIRtfAttribute rtf = (MAPIRtfAttribute)
         msg.getMessageMAPIAttribute(MAPIProperty.RTF_COMPRESSED);
      assertContents("message.rtf", rtf.getData());
      
      // Then by String
      String contents = msg.getBody();
      // It's all low bytes
      byte[] contentsBytes = contents.getBytes("ASCII");
      assertContents("message.rtf", contentsBytes);
      
      // try to get a message id that does not exist
      assertNull(msg.getMessageMAPIAttribute(MAPIProperty.AB_DEFAULT_DIR));
   }
   
   public void testMessageSample1() throws Exception {
		HMEFMessage msg = new HMEFMessage(
				_samples.openResourceAsStream("winmail-sample1.dat"));

		// Firstly by byte
		MAPIRtfAttribute rtf = (MAPIRtfAttribute) msg
				.getMessageMAPIAttribute(MAPIProperty.RTF_COMPRESSED);
		// assertContents("message.rtf", rtf.getData());
		assertNotNull(rtf);

		// Then by String
		String contents = msg.getBody();
		//System.out.println(contents);
		// It's all low bytes
		byte[] contentsBytes = contents.getBytes("ASCII");
		// assertContents("message.rtf", contentsBytes);
		assertNotNull(contentsBytes);
		
		assertNotNull(msg.getSubject());
		assertNotNull(msg.getBody());
   }
   
   public void testInvalidMessage() throws Exception {
	   InputStream str = new ByteArrayInputStream(new byte[] {0, 0, 0, 0});
	   try {
		   assertNotNull(new HMEFMessage(str));
		   fail("Should catch an exception here");
	   } catch (IllegalArgumentException e) {
		   assertTrue(e.getMessage().contains("TNEF signature not detected in file, expected 574529400 but got 0"));
	   }
   }
   
   
   public void testNoData() throws Exception {
	   ByteArrayOutputStream out = new ByteArrayOutputStream();
	   
	   // Header
	   LittleEndian.putInt(HMEFMessage.HEADER_SIGNATURE, out);
	   
	   // field
	   LittleEndian.putUShort(0, out);
	   
	   byte[] bytes = out.toByteArray();
	   InputStream str = new ByteArrayInputStream(bytes);
	   HMEFMessage msg = new HMEFMessage(str);
	   assertNull(msg.getSubject());
	   assertNull(msg.getBody());
   }
   
   public void testInvalidLevel() throws Exception {
	   ByteArrayOutputStream out = new ByteArrayOutputStream();
	   
	   // Header
	   LittleEndian.putInt(HMEFMessage.HEADER_SIGNATURE, out);
	   
	   // field
	   LittleEndian.putUShort(0, out);
	   
	   // invalid level
	   LittleEndian.putUShort(90, out);
	   
	   byte[] bytes = out.toByteArray();
	   InputStream str = new ByteArrayInputStream(bytes);
	   try {
		   assertNotNull(new HMEFMessage(str));
		   fail("Should catch an exception here");
	   } catch (IllegalStateException e) {
		   assertTrue(e.getMessage().contains("Unhandled level 90"));
	   }
   }
}