Package com.pff

Class PSTFile

java.lang.Object

com.pff.PSTFile

public class PSTFile
extends Object

PSTFile is the containing class that allows you to access items within a .pst file. Start here, get the root of the folders and work your way down through your items.

Field Summary

Fields

Modifier and Type	Field	Description
private static boolean	bCPFirstTime
private static boolean	bFirstTime
private LinkedHashMap<Integer,LinkedList<DescriptorIndexNode>>	childrenDescriptorTree
static final int	ENCRYPTION_TYPE_COMPRESSIBLE
static final int	ENCRYPTION_TYPE_NONE
private int	encryptionType
private HashMap<UUID,Integer>	guidMap
private byte[]	guids
private static final String[]	guidStrings
private static HashMap<Integer,Long>	idToName
private HashMap<Integer,String>	idToString
private RandomAccessFile	in
private int	itemCount
private static final int	MESSAGE_STORE_DESCRIPTOR_IDENTIFIER
private HashMap<Long,Integer>	nameToId
private static Properties	propertyInternetCodePages
private static Properties	propertyNames
static final int	PS_INTERNET_HEADERS
static final int	PS_MAPI
static final int	PS_PUBLIC_STRINGS
static final int	PSETID_Address
static final int	PSETID_AirSync
static final int	PSETID_Appointment
static final int	PSETID_Common
static final int	PSETID_Log
static final int	PSETID_Meeting
static final int	PSETID_Messaging
static final int	PSETID_Note
static final int	PSETID_PostRss
static final int	PSETID_Sharing
static final int	PSETID_Task
static final int	PSETID_UnifiedMessaging
static final int	PST_TYPE_ANSI
protected static final int	PST_TYPE_ANSI_2
static final int	PST_TYPE_UNICODE
private int	pstFileType
private static final int	ROOT_FOLDER_DESCRIPTOR_IDENTIFIER
private HashMap<String,Integer>	stringToId

Constructor Summary

Constructors

Constructor	Description
PSTFile(File fileName)
PSTFile(String fileName)	constructor

Method Summary

Modifier and Type	Method	Description
protected long	extractLEFileOffset(long startOffset)	Read a file offset from the file PST Files have this tendency to store file offsets (pointers) in 8 little endian bytes.
protected void	finalize()	destructor just closes the file handle...
private byte[]	findBtreeItem(RandomAccessFile in, long index, boolean descTree)	Generic function used by getOffsetIndexNode and getDescriptorIndexNode for navigating the PST B-Trees
(package private) LinkedHashMap<Integer,LinkedList<DescriptorIndexNode>>	getChildDescriptorTree()	Build the children descriptor tree This goes through the entire descriptor B-Tree and adds every item to the childrenDescriptorTree.
private byte[]	getData(PSTTableItem item, HashMap<Integer,PSTDescriptorItem> localDescriptorItems)
(package private) DescriptorIndexNode	getDescriptorIndexNode(long identifier)	navigate the internal descriptor B-Tree and find a specific item
int	getEncryptionType()	get the type of encryption the file uses
RandomAccessFile	getFileHandle()	get the handle to the file we are currently accessing
(package private) static String	getInternetCodePageCharset(int propertyId)
int	getLeafSize(long bid)
PSTMessageStore	getMessageStore()	get the message store of the PST file.
(package private) int	getNameToIdMapItem(int key, int propertySetIndex)
(package private) static long	getNameToIdMapKey(int id)
(package private) OffsetIndexItem	getOffsetIndexNode(long identifier)	navigate the internal index B-Tree and find a specific item
(package private) static String	getPropertyDescription(int entryType, int entryValueType)
(package private) static String	getPropertyName(int propertyId, boolean bNamed)
(package private) HashMap<Integer,PSTDescriptorItem>	getPSTDescriptorItems(long localDescriptorsOffsetIndexIdentifier)	parse a PSTDescriptor and get all of its items
(package private) HashMap<Integer,PSTDescriptorItem>	getPSTDescriptorItems(PSTNodeInputStream in)
int	getPSTFileType()
(package private) int	getPublicStringToIdMapItem(String key)
PSTFolder	getRootFolder()	get the root folder for the PST file.
private void	processDescriptorBTree(long btreeStartOffset)	Recursive function for building the descriptor tree, used by buildDescriptorTree
private void	processNameToIdMap(RandomAccessFile in)	read the name-to-id map from the file and load it in
(package private) PSTNodeInputStream	readLeaf(long bid)

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ENCRYPTION_TYPE_NONE

public static final int ENCRYPTION_TYPE_NONE

See Also:

• Constant Field Values

ENCRYPTION_TYPE_COMPRESSIBLE

public static final int ENCRYPTION_TYPE_COMPRESSIBLE

See Also:

• Constant Field Values

MESSAGE_STORE_DESCRIPTOR_IDENTIFIER

private static final int MESSAGE_STORE_DESCRIPTOR_IDENTIFIER

See Also:

• Constant Field Values

ROOT_FOLDER_DESCRIPTOR_IDENTIFIER

private static final int ROOT_FOLDER_DESCRIPTOR_IDENTIFIER

See Also:

• Constant Field Values

PST_TYPE_ANSI

public static final int PST_TYPE_ANSI

See Also:

• Constant Field Values

PST_TYPE_ANSI_2

protected static final int PST_TYPE_ANSI_2

See Also:

• Constant Field Values

PST_TYPE_UNICODE

public static final int PST_TYPE_UNICODE

See Also:

• Constant Field Values

PS_PUBLIC_STRINGS

public static final int PS_PUBLIC_STRINGS

See Also:

• Constant Field Values

PSETID_Common

public static final int PSETID_Common

See Also:

• Constant Field Values

PSETID_Address

public static final int PSETID_Address

See Also:

• Constant Field Values

PS_INTERNET_HEADERS

public static final int PS_INTERNET_HEADERS

See Also:

• Constant Field Values

PSETID_Appointment

public static final int PSETID_Appointment

See Also:

• Constant Field Values

PSETID_Meeting

public static final int PSETID_Meeting

See Also:

• Constant Field Values

PSETID_Log

public static final int PSETID_Log

See Also:

• Constant Field Values

PSETID_Messaging

public static final int PSETID_Messaging

See Also:

• Constant Field Values

PSETID_Note

public static final int PSETID_Note

See Also:

• Constant Field Values

PSETID_PostRss

public static final int PSETID_PostRss

See Also:

• Constant Field Values

PSETID_Task

public static final int PSETID_Task

See Also:

• Constant Field Values

PSETID_UnifiedMessaging

public static final int PSETID_UnifiedMessaging

See Also:

• Constant Field Values

PS_MAPI

public static final int PS_MAPI

See Also:

• Constant Field Values

PSETID_AirSync

public static final int PSETID_AirSync

See Also:

• Constant Field Values

PSETID_Sharing

public static final int PSETID_Sharing

See Also:

• Constant Field Values

guidStrings

private static final String[] guidStrings

guidMap

private HashMap<UUID,Integer> guidMap

encryptionType

private int encryptionType

childrenDescriptorTree

private LinkedHashMap<Integer,LinkedList<DescriptorIndexNode>> childrenDescriptorTree

nameToId

private HashMap<Long,Integer> nameToId

stringToId

private HashMap<String,Integer> stringToId

idToName

private static HashMap<Integer,Long> idToName

idToString

private HashMap<Integer,String> idToString

guids

private byte[] guids

itemCount

private int itemCount

in

private RandomAccessFile in

pstFileType

private int pstFileType

propertyInternetCodePages

private static Properties propertyInternetCodePages

bCPFirstTime

private static boolean bCPFirstTime

propertyNames

private static Properties propertyNames

bFirstTime

private static boolean bFirstTime

Constructor Details

PSTFile

public PSTFile(String fileName)
        throws FileNotFoundException,
PSTException,
IOException

constructor

Parameters:

fileName -

Throws:

FileNotFoundException

PSTException

IOException

PSTFile

public PSTFile(File fileName)
        throws FileNotFoundException,
PSTException,
IOException

Throws:

FileNotFoundException

PSTException

IOException

Method Details

getPSTFileType

public int getPSTFileType()

processNameToIdMap

private void processNameToIdMap(RandomAccessFile in)
                         throws IOException,
PSTException

read the name-to-id map from the file and load it in

Parameters:

in -

Throws:

IOException

PSTException

getData

private byte[] getData(PSTTableItem item,
 HashMap<Integer,PSTDescriptorItem> localDescriptorItems)
                throws IOException,
PSTException

Throws:

IOException

PSTException

getNameToIdMapItem

int getNameToIdMapItem(int key,
 int propertySetIndex)

getPublicStringToIdMapItem

int getPublicStringToIdMapItem(String key)

getNameToIdMapKey

static long getNameToIdMapKey(int id)

getInternetCodePageCharset

static String getInternetCodePageCharset(int propertyId)

getPropertyName

static String getPropertyName(int propertyId,
 boolean bNamed)

getPropertyDescription

static String getPropertyDescription(int entryType,
 int entryValueType)

finalize

protected void finalize()
                 throws IOException

destructor just closes the file handle...

Overrides:

finalize in class Object

Throws:

IOException

getEncryptionType

public int getEncryptionType()

get the type of encryption the file uses

Returns:

encryption type used in the PST File

getFileHandle

public RandomAccessFile getFileHandle()

get the handle to the file we are currently accessing

getMessageStore

public PSTMessageStore getMessageStore()
                                throws PSTException,
IOException

get the message store of the PST file. Note that this doesn't really have much information, better to look under the root folder

Throws:

PSTException

IOException

getRootFolder

public PSTFolder getRootFolder()
                        throws PSTException,
IOException

get the root folder for the PST file. You should find all of your data under here...

Throws:

PSTException

IOException

readLeaf

PSTNodeInputStream readLeaf(long bid)
                     throws IOException,
PSTException

Throws:

IOException

PSTException

getLeafSize

public int getLeafSize(long bid)
                throws IOException,
PSTException

Throws:

IOException

PSTException

extractLEFileOffset

protected long extractLEFileOffset(long startOffset)
                            throws IOException

Read a file offset from the file PST Files have this tendency to store file offsets (pointers) in 8 little endian bytes. Convert this to a long for seeking to.

Parameters:

startOffset - where to read the 8 bytes from

in - handle for PST file

Returns:

long representing the read location

Throws:

IOException

findBtreeItem

private byte[] findBtreeItem(RandomAccessFile in,
 long index,
 boolean descTree)
                      throws IOException,
PSTException

Generic function used by getOffsetIndexNode and getDescriptorIndexNode for navigating the PST B-Trees

Parameters:

in -

index -

descTree -

Returns:

Throws:

IOException

PSTException

getDescriptorIndexNode

DescriptorIndexNode getDescriptorIndexNode(long identifier)
                                    throws IOException,
PSTException

navigate the internal descriptor B-Tree and find a specific item

Parameters:

identifier -

in -

Returns:

the descriptor node for the item

Throws:

IOException

PSTException

getOffsetIndexNode

OffsetIndexItem getOffsetIndexNode(long identifier)
                            throws IOException,
PSTException

navigate the internal index B-Tree and find a specific item

Parameters:

identifier -

in -

Returns:

the offset index item

Throws:

IOException

PSTException

getPSTDescriptorItems

HashMap<Integer,PSTDescriptorItem> getPSTDescriptorItems(long localDescriptorsOffsetIndexIdentifier)
                                                  throws PSTException,
IOException

parse a PSTDescriptor and get all of its items

Throws:

PSTException

IOException

getPSTDescriptorItems

HashMap<Integer,PSTDescriptorItem> getPSTDescriptorItems(PSTNodeInputStream in)
                                                  throws PSTException,
IOException

Throws:

PSTException

IOException

getChildDescriptorTree

LinkedHashMap<Integer,LinkedList<DescriptorIndexNode>> getChildDescriptorTree()
                                                                       throws IOException,
PSTException

Build the children descriptor tree This goes through the entire descriptor B-Tree and adds every item to the childrenDescriptorTree. This is used as fallback when the nodes that list file contents are broken.

Parameters:

in -

Throws:

IOException

PSTException

processDescriptorBTree

private void processDescriptorBTree(long btreeStartOffset)
                             throws IOException,
PSTException

Recursive function for building the descriptor tree, used by buildDescriptorTree

Parameters:

btreeStartOffset -

in -

Throws:

IOException

PSTException