2002-05-11 10:47:24 -04:00
|
|
|
/*
|
|
|
|
* ====================================================================
|
|
|
|
* The Apache Software License, Version 1.1
|
2002-02-13 23:00:59 -05:00
|
|
|
*
|
2002-05-11 10:47:24 -04:00
|
|
|
* Copyright (c) 2000 The Apache Software Foundation. All rights
|
|
|
|
* reserved.
|
2002-02-13 23:00:59 -05:00
|
|
|
*
|
2002-05-11 10:47:24 -04:00
|
|
|
* Redistribution and use in source and binary forms, with or without
|
|
|
|
* modification, are permitted provided that the following conditions
|
|
|
|
* are met:
|
2002-02-13 23:00:59 -05:00
|
|
|
*
|
2002-05-11 10:47:24 -04:00
|
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
|
|
* notice, this list of conditions and the following disclaimer.
|
2002-02-13 23:00:59 -05:00
|
|
|
*
|
2002-05-11 10:47:24 -04:00
|
|
|
* 2. 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.
|
2002-02-13 23:00:59 -05:00
|
|
|
*
|
2002-05-11 10:47:24 -04:00
|
|
|
* 3. The end-user documentation included with the redistribution,
|
|
|
|
* if any, must include the following acknowledgment:
|
|
|
|
* "This product includes software developed by the
|
|
|
|
* Apache Software Foundation (http://www.apache.org/)."
|
|
|
|
* Alternately, this acknowledgment may appear in the software itself,
|
|
|
|
* if and wherever such third-party acknowledgments normally appear.
|
2002-02-13 23:00:59 -05:00
|
|
|
*
|
2002-05-11 10:47:24 -04:00
|
|
|
* 4. The names "Apache" and "Apache Software Foundation" must
|
|
|
|
* not be used to endorse or promote products derived from this
|
|
|
|
* software without prior written permission. For written
|
|
|
|
* permission, please contact apache@apache.org.
|
2002-02-13 23:00:59 -05:00
|
|
|
*
|
2002-05-11 10:47:24 -04:00
|
|
|
* 5. Products derived from this software may not be called "Apache",
|
|
|
|
* nor may "Apache" appear in their name, without prior written
|
|
|
|
* permission of the Apache Software Foundation.
|
2002-02-13 23:00:59 -05:00
|
|
|
*
|
2002-05-11 10:47:24 -04:00
|
|
|
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED 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 APACHE SOFTWARE FOUNDATION OR
|
|
|
|
* ITS 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.
|
|
|
|
* ====================================================================
|
2002-02-13 23:00:59 -05:00
|
|
|
*
|
2002-05-11 10:47:24 -04:00
|
|
|
* This software consists of voluntary contributions made by many
|
|
|
|
* individuals on behalf of the Apache Software Foundation. For more
|
|
|
|
* information on the Apache Software Foundation, please see
|
|
|
|
* <http://www.apache.org/>.
|
2002-02-13 23:00:59 -05:00
|
|
|
*
|
2002-05-11 10:47:24 -04:00
|
|
|
* Portions of this software are based upon public domain software
|
|
|
|
* originally written at the National Center for Supercomputing Applications,
|
|
|
|
* University of Illinois, Urbana-Champaign.
|
|
|
|
*
|
|
|
|
* Portions of this software are based upon public domain software
|
|
|
|
* originally written at the National Center for Supercomputing Applications,
|
|
|
|
* University of Illinois, Urbana-Champaign.
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
|
|
|
package org.apache.poi.hpsf;
|
|
|
|
|
2003-08-02 15:02:28 -04:00
|
|
|
import java.util.HashMap;
|
|
|
|
import java.util.Map;
|
2002-05-26 18:18:40 -04:00
|
|
|
import org.apache.poi.util.LittleEndian;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
|
|
|
/**
|
2002-07-18 11:51:39 -04:00
|
|
|
* <p>A property in a {@link Section} of a {@link PropertySet}.</p>
|
2002-02-13 23:00:59 -05:00
|
|
|
*
|
2002-07-18 11:51:39 -04:00
|
|
|
* <p>The property's <strong>ID</strong> gives the property a meaning
|
|
|
|
* in the context of its {@link Section}. Each {@link Section} spans
|
|
|
|
* its own name space of property IDs.</p>
|
2002-02-13 23:00:59 -05:00
|
|
|
*
|
2002-07-18 11:51:39 -04:00
|
|
|
* <p>The property's <strong>type</strong> determines how its
|
|
|
|
* <strong>value </strong> is interpreted. For example, if the type is
|
|
|
|
* {@link Variant#VT_LPSTR} (byte string), the value consists of a
|
2002-07-22 04:25:19 -04:00
|
|
|
* DWord telling how many bytes the string contains. The bytes follow
|
|
|
|
* immediately, including any null bytes that terminate the
|
2002-07-18 11:51:39 -04:00
|
|
|
* string. The type {@link Variant#VT_I4} denotes a four-byte integer
|
|
|
|
* value, {@link Variant#VT_FILETIME} some date and time (of a
|
|
|
|
* file).</p>
|
2002-02-13 23:00:59 -05:00
|
|
|
*
|
2002-12-10 01:15:20 -05:00
|
|
|
* <p><strong>FIXME:</strong> Reading is not implemented for all
|
|
|
|
* {@link Variant} types yet. Feel free to submit error reports or
|
|
|
|
* patches for the types you need.</p>
|
2002-02-13 23:00:59 -05:00
|
|
|
*
|
2002-07-18 11:51:39 -04:00
|
|
|
* @author Rainer Klute (klute@rainer-klute.de)
|
|
|
|
* @author Drew Varner (Drew.Varner InAndAround sc.edu)
|
|
|
|
* @see Section
|
|
|
|
* @see Variant
|
|
|
|
* @version $Id$
|
|
|
|
* @since 2002-02-09
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
2002-07-18 11:51:39 -04:00
|
|
|
public class Property
|
|
|
|
{
|
2002-02-13 23:00:59 -05:00
|
|
|
|
2003-08-02 15:02:28 -04:00
|
|
|
/** <p>Codepage 1200 denotes Unicode.</p> */
|
|
|
|
private static final int CP_UNICODE = 1200;
|
2002-12-10 01:15:20 -05:00
|
|
|
|
2003-08-02 15:02:28 -04:00
|
|
|
/** <p>The property's ID.</p> */
|
2003-08-03 16:16:46 -04:00
|
|
|
protected int id;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
2002-05-11 10:47:24 -04:00
|
|
|
|
2002-02-13 23:00:59 -05:00
|
|
|
/**
|
2002-07-18 11:51:39 -04:00
|
|
|
* <p>Returns the property's ID.</p>
|
2002-05-11 10:47:24 -04:00
|
|
|
*
|
2002-07-18 11:51:39 -04:00
|
|
|
* @return The ID value
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
2002-07-18 11:51:39 -04:00
|
|
|
public int getID()
|
|
|
|
{
|
2002-02-13 23:00:59 -05:00
|
|
|
return id;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
2003-08-02 15:02:28 -04:00
|
|
|
/** <p>The property's type.</p> */
|
2003-08-03 16:16:46 -04:00
|
|
|
protected long type;
|
2002-05-11 10:47:24 -04:00
|
|
|
|
2002-02-13 23:00:59 -05:00
|
|
|
|
|
|
|
/**
|
2002-07-18 11:51:39 -04:00
|
|
|
* <p>Returns the property's type.</p>
|
2002-05-11 10:47:24 -04:00
|
|
|
*
|
2002-07-18 11:51:39 -04:00
|
|
|
* @return The type value
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
2002-07-18 11:51:39 -04:00
|
|
|
public long getType()
|
|
|
|
{
|
2002-02-13 23:00:59 -05:00
|
|
|
return type;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
2003-08-02 15:02:28 -04:00
|
|
|
/** <p>The property's value.</p> */
|
2003-08-03 16:16:46 -04:00
|
|
|
protected Object value;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
2002-05-11 10:47:24 -04:00
|
|
|
|
2002-02-13 23:00:59 -05:00
|
|
|
/**
|
2002-07-18 11:51:39 -04:00
|
|
|
* <p>Returns the property's value.</p>
|
2002-05-11 10:47:24 -04:00
|
|
|
*
|
2002-07-18 11:51:39 -04:00
|
|
|
* @return The property's value
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
2002-07-18 11:51:39 -04:00
|
|
|
public Object getValue()
|
|
|
|
{
|
2002-02-13 23:00:59 -05:00
|
|
|
return value;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
2002-07-18 11:51:39 -04:00
|
|
|
* <p>Creates a {@link Property} instance by reading its bytes
|
|
|
|
* from the property set stream.</p>
|
2002-02-13 23:00:59 -05:00
|
|
|
*
|
2002-07-18 11:51:39 -04:00
|
|
|
* @param id The property's ID.
|
|
|
|
* @param src The bytes the property set stream consists of.
|
|
|
|
* @param offset The property's type/value pair's offset in the
|
|
|
|
* section.
|
|
|
|
* @param length The property's type/value pair's length in bytes.
|
2002-12-10 01:15:20 -05:00
|
|
|
* @param codepage The section's and thus the property's
|
|
|
|
* codepage. It is needed only when reading string values.
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
2002-05-11 10:47:24 -04:00
|
|
|
public Property(final int id, final byte[] src, final long offset,
|
2003-08-02 15:02:28 -04:00
|
|
|
final int length, final int codepage)
|
2002-07-18 11:51:39 -04:00
|
|
|
{
|
2002-02-13 23:00:59 -05:00
|
|
|
this.id = id;
|
|
|
|
|
2002-05-11 10:47:24 -04:00
|
|
|
/*
|
2002-12-10 01:15:20 -05:00
|
|
|
* ID 0 is a special case since it specifies a dictionary of
|
|
|
|
* property IDs and property names.
|
2002-05-11 10:47:24 -04:00
|
|
|
*/
|
2002-07-18 11:51:39 -04:00
|
|
|
if (id == 0)
|
2003-08-02 15:02:28 -04:00
|
|
|
{
|
2002-12-10 01:15:20 -05:00
|
|
|
value = readDictionary(src, offset, length, codepage);
|
2002-02-13 23:00:59 -05:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2002-05-11 10:47:24 -04:00
|
|
|
int o = (int) offset;
|
|
|
|
type = LittleEndian.getUInt(src, o);
|
|
|
|
o += LittleEndian.INT_SIZE;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
2003-08-02 15:02:28 -04:00
|
|
|
try
|
|
|
|
{
|
|
|
|
value = TypeReader.read(src, o, length, (int) type);
|
|
|
|
}
|
|
|
|
catch (Throwable t)
|
|
|
|
{
|
|
|
|
t.printStackTrace();
|
|
|
|
value = "*** null ***";
|
|
|
|
}
|
2002-02-13 23:00:59 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
2003-08-03 16:16:46 -04:00
|
|
|
/**
|
|
|
|
* <p>Creates an empty property. It must be filled using the set method to
|
|
|
|
* be usable.</p>
|
|
|
|
*/
|
|
|
|
protected Property()
|
|
|
|
{}
|
|
|
|
|
|
|
|
|
|
|
|
|
2002-02-13 23:00:59 -05:00
|
|
|
/**
|
2002-07-18 11:51:39 -04:00
|
|
|
* <p>Reads a dictionary.</p>
|
2002-02-13 23:00:59 -05:00
|
|
|
*
|
2002-07-18 11:51:39 -04:00
|
|
|
* @param src The byte array containing the bytes making out the
|
|
|
|
* dictionary.
|
|
|
|
* @param offset At this offset within <var>src</var> the
|
|
|
|
* dictionary starts.
|
|
|
|
* @param length The dictionary contains at most this many bytes.
|
2002-12-10 01:15:20 -05:00
|
|
|
* @param codepage The codepage of the string values.
|
2002-07-18 11:51:39 -04:00
|
|
|
* @return The dictonary
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
2002-05-11 10:47:24 -04:00
|
|
|
protected Map readDictionary(final byte[] src, final long offset,
|
2003-08-02 15:02:28 -04:00
|
|
|
final int length, final int codepage)
|
2002-07-18 11:51:39 -04:00
|
|
|
{
|
2003-08-02 15:02:28 -04:00
|
|
|
/* Check whether "offset" points into the "src" array". */
|
|
|
|
if (offset < 0 || offset > src.length)
|
|
|
|
throw new HPSFRuntimeException
|
|
|
|
("Illegal offset " + offset + " while HPSF stream contains " +
|
|
|
|
length + " bytes.");
|
2002-12-10 01:15:20 -05:00
|
|
|
int o = (int) offset;
|
2002-05-11 10:47:24 -04:00
|
|
|
|
|
|
|
/*
|
2002-12-10 01:15:20 -05:00
|
|
|
* Read the number of dictionary entries.
|
2002-05-11 10:47:24 -04:00
|
|
|
*/
|
|
|
|
final long nrEntries = LittleEndian.getUInt(src, o);
|
|
|
|
o += LittleEndian.INT_SIZE;
|
|
|
|
|
2002-12-10 01:15:20 -05:00
|
|
|
final Map m = new HashMap((int) nrEntries, (float) 1.0);
|
2002-07-18 11:51:39 -04:00
|
|
|
for (int i = 0; i < nrEntries; i++)
|
2003-08-02 15:02:28 -04:00
|
|
|
{
|
2002-12-10 01:15:20 -05:00
|
|
|
/* The key. */
|
2002-05-11 10:47:24 -04:00
|
|
|
final Long id = new Long(LittleEndian.getUInt(src, o));
|
|
|
|
o += LittleEndian.INT_SIZE;
|
|
|
|
|
2002-12-10 01:15:20 -05:00
|
|
|
/* The value (a string). The length is the either the
|
|
|
|
* number of characters if the character set is Unicode or
|
|
|
|
* else the number of bytes. The length includes
|
|
|
|
* terminating 0x00 bytes which we have to strip off to
|
|
|
|
* create a Java string. */
|
|
|
|
long sLength = LittleEndian.getUInt(src, o);
|
2002-05-11 10:47:24 -04:00
|
|
|
o += LittleEndian.INT_SIZE;
|
2002-07-18 11:51:39 -04:00
|
|
|
|
2002-12-10 01:15:20 -05:00
|
|
|
/* Read the bytes or characters depending on whether the
|
|
|
|
* character set is Unicode or not. */
|
2003-08-02 15:02:28 -04:00
|
|
|
StringBuffer b = new StringBuffer((int) sLength);
|
|
|
|
for (int j = 0; j < sLength; j++)
|
|
|
|
if (codepage == CP_UNICODE)
|
|
|
|
{
|
|
|
|
final int i1 = o + (j * 2);
|
|
|
|
final int i2 = i1 + 1;
|
|
|
|
b.append((char) ((src[i2] << 8) + src[i1]));
|
|
|
|
}
|
|
|
|
else
|
|
|
|
b.append((char) src[o + j]);
|
|
|
|
|
|
|
|
/* Strip 0x00 characters from the end of the string: */
|
|
|
|
while (b.charAt(b.length() - 1) == 0x00)
|
|
|
|
b.setLength(b.length() - 1);
|
|
|
|
if (codepage == CP_UNICODE)
|
|
|
|
{
|
|
|
|
if (sLength % 2 == 1)
|
|
|
|
sLength++;
|
|
|
|
o += (sLength + sLength);
|
|
|
|
}
|
|
|
|
else
|
|
|
|
o += sLength;
|
2002-12-10 01:15:20 -05:00
|
|
|
m.put(id, b.toString());
|
2002-02-13 23:00:59 -05:00
|
|
|
}
|
|
|
|
return m;
|
|
|
|
}
|
|
|
|
|
2003-08-02 15:02:28 -04:00
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* <p>Returns the property's size in bytes. This is always a multiple of
|
|
|
|
* 4.</p>
|
|
|
|
*
|
|
|
|
* @return the property's size in bytes
|
|
|
|
*/
|
|
|
|
protected int getSize()
|
|
|
|
{
|
|
|
|
throw new UnsupportedOperationException("FIXME: Not yet implemented.");
|
|
|
|
}
|
|
|
|
|
2003-08-03 16:16:46 -04:00
|
|
|
|
|
|
|
|
|
|
|
public boolean equals(Object o)
|
|
|
|
{
|
|
|
|
throw new UnsupportedOperationException("FIXME: Not yet implemented.");
|
|
|
|
}
|
|
|
|
|
2002-02-13 23:00:59 -05:00
|
|
|
}
|