# farnulfo/pst-exp architecture

> Architecture diagram of the GitHub repository farnulfo/pst-exp, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-27). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/farnulfo/pst-exp
- Repository: https://github.com/farnulfo/pst-exp

## Overview

Project Type: This is a specialized file format parser/reader for Microsoft Outlook PST files, implemented in Java. It's a technical library focused on reading and interpreting the complex PST file format structure.

##### Main Components Organization

a) Interface Layer:
- Center IPSTFile interface and PSTFile implementation
- This as the main entry point for clients

b) Core Processing Layer (show as interconnected components):
- Header Processing (Header.java)
- Node Management (NDB.java, NID.java, HN.java)
- Block Management (Block.java, BTH.java)
- Page Management (pages/*)

c) Data Structure Layer:
- Message Store (MessageStore.java)
- Folder (Folder.java)
- Message (Message.java)

##### Key Relationships to Highlight

a) File Structure Components:
- NID → Node → Block hierarchy
- BTH (B-tree) relationships

b) Data Flow:
- How PSTFile reads Header
- Demonstrate Node B-tree navigation flow
- Property Context (PC) handling

##### Component Groupings

Related components:
**[File Format Processing]**
- Header
- Block
- Page
- CRC

**[Data Structures]**
- MessageStore
- Folder
- Message
- EntryID

**[B-tree Components]**
- BTH
- BTHHEADER
- BTENTRY
- BBTENTRY
- NBTENTRY

##### Technical Details

Annotations for:
- CRC verification flows
- Property data type handling
- Special internal NID processing
- Heap-on-Node structures

##### Implementation Notes

Notes about:
- File format version handling (ANSI/Unicode)
- Error handling paths
- Critical processing paths
- Test coverage points

Remember to include bidirectional relationships where appropriate, as PST parsing involves both forward and backward references in the file structure.

This system design should help developers understand both the high-level architecture and the detailed interactions between components necessary for parsing PST files.

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph Interface
        IPSTFile[IPSTFile Interface]:::interface
        PSTFile[PSTFile Implementation]:::implementation
    end

    subgraph Core_Processing
        Header[Header Processing]:::core
        NDB[Node Database]:::core
        NID[Node ID]:::core
        HN[Heap Node]:::core
        Block[Block Management]:::core
        BTH[B-Tree Handler]:::core
        BTHHEADER[BTH Header]:::core
        Pages[Page Management]:::core
    end

    subgraph Data_Structures
        MessageStore[Message Store]:::data
        Folder[Folder]:::data
        Message[Message]:::data
        EntryID[Entry ID]:::data
    end

    subgraph BTree_Components
        BBTENTRY[BB Tree Entry]:::btree
        BTENTRY[B-Tree Entry]:::btree
        NBTENTRY[NB Tree Entry]:::btree
    end

    subgraph Property_Handling
        PropertyDataType[Property Data Type]:::property
        PropertyIdentifier[Property Identifier]:::property
        PropertyTag[Property Tag]:::property
        PC[Property Context]:::property
    end

    subgraph Utilities
        CRC[CRC Verification]:::utility
        PermEnc[Permutative Encoding]:::utility
    end

    %% Relationships
    IPSTFile --> PSTFile
    PSTFile --> Header
    PSTFile --> NDB
    NDB --> Block
    NDB --> BTH
    BTH --> BTHHEADER
    Block --> Pages
    NID --> HN
    HN --> Block

    BTH --> BBTENTRY
    BTH --> BTENTRY
    BTH --> NBTENTRY

    PSTFile --> MessageStore
    MessageStore --> Folder
    Folder --> Message
    Message --> EntryID

    Block --> PC
    PC --> PropertyDataType
    PC --> PropertyIdentifier
    PC --> PropertyTag

    Block --> CRC
    Block --> PermEnc

    %% Click Events
    click IPSTFile "https://github.com/farnulfo/pst-exp/blob/master/src/main/java/org/pipoware/pst/exp/IPSTFile.java"
    click PSTFile "https://github.com/farnulfo/pst-exp/blob/master/src/main/java/org/pipoware/pst/exp/PSTFile.java"
    click Header "https://github.com/farnulfo/pst-exp/blob/master/src/main/java/org/pipoware/pst/exp/Header.java"
    click NDB "https://github.com/farnulfo/pst-exp/blob/master/src/main/java/org/pipoware/pst/exp/NDB.java"
    click NID "https://github.com/farnulfo/pst-exp/blob/master/src/main/java/org/pipoware/pst/exp/NID.java"
    click HN "https://github.com/farnulfo/pst-exp/blob/master/src/main/java/org/pipoware/pst/exp/HN.java"
    click Block "https://github.com/farnulfo/pst-exp/blob/master/src/main/java/org/pipoware/pst/exp/Block.java"
    click BTH "https://github.com/farnulfo/pst-exp/blob/master/src/main/java/org/pipoware/pst/exp/BTH.java"
    click BTHHEADER "https://github.com/farnulfo/pst-exp/blob/master/src/main/java/org/pipoware/pst/exp/BTHHEADER.java"
    click Pages "https://github.com/farnulfo/pst-exp/tree/master/src/main/java/org/pipoware/pst/exp/pages"
    click MessageStore "https://github.com/farnulfo/pst-exp/blob/master/src/main/java/org/pipoware/pst/exp/MessageStore.java"
    click Folder "https://github.com/farnulfo/pst-exp/blob/master/src/main/java/org/pipoware/pst/exp/Folder.java"
    click Message "https://github.com/farnulfo/pst-exp/blob/master/src/main/java/org/pipoware/pst/exp/Message.java"
    click EntryID "https://github.com/farnulfo/pst-exp/blob/master/src/main/java/org/pipoware/pst/exp/EntryID.java"
    click BBTENTRY "https://github.com/farnulfo/pst-exp/blob/master/src/main/java/org/pipoware/pst/exp/pages/BBTENTRY.java"
    click BTENTRY "https://github.com/farnulfo/pst-exp/blob/master/src/main/java/org/pipoware/pst/exp/pages/BTENTRY.java"
    click NBTENTRY "https://github.com/farnulfo/pst-exp/blob/master/src/main/java/org/pipoware/pst/exp/pages/NBTENTRY.java"
    click PropertyDataType "https://github.com/farnulfo/pst-exp/blob/master/src/main/java/org/pipoware/pst/exp/PropertyDataType.java"
    click PropertyIdentifier "https://github.com/farnulfo/pst-exp/blob/master/src/main/java/org/pipoware/pst/exp/PropertyIdentifier.java"
    click PropertyTag "https://github.com/farnulfo/pst-exp/blob/master/src/main/java/org/pipoware/pst/exp/PropertyTag.java"
    click PC "https://github.com/farnulfo/pst-exp/blob/master/src/main/java/org/pipoware/pst/exp/PC.java"
    click CRC "https://github.com/farnulfo/pst-exp/blob/master/src/main/java/org/pipoware/pst/exp/CRC.java"
    click PermEnc "https://github.com/farnulfo/pst-exp/blob/master/src/main/java/org/pipoware/pst/exp/PermutativeEncoding.java"

    %% Styling
    classDef interface fill:#FFE873,stroke:#333,stroke-width:2px
    classDef implementation fill:#ADE4B5,stroke:#333,stroke-width:2px
    classDef core fill:#6CB4EE,stroke:#333,stroke-width:2px
    classDef data fill:#90EE90,stroke:#333,stroke-width:2px
    classDef btree fill:#FFB6C1,stroke:#333,stroke-width:2px
    classDef property fill:#DDA0DD,stroke:#333,stroke-width:2px
    classDef utility fill:#F0E68C,stroke:#333,stroke-width:2px
```
