# abrignoni/rleapp architecture

> Architecture diagram of the GitHub repository abrignoni/rleapp, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-13). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/abrignoni/rleapp
- Repository: https://github.com/abrignoni/rleapp

## Overview

##### Project type and purpose
- From the README and file tree, RLEAPP is a Python-based DFIR (Digital Forensics and Incident Response) tool that can be run as a CLI or GUI.
- It ingests a data source (archive or file system), dynamically loads “artifact” plugins, parses forensic artifacts, and emits HTML/TSV reports and timeline data.

##### File structure
- Top‐level entrypoints:
- rleapp.py (CLI)
- rleappGUI.py (Tkinter GUI)
- Administrative:
- admin/docs, admin/scripts – module metadata/maintenance
- Assets:
- Dependency listing: requirements.txt
- scripts/ directory: the core of the system, subdivided into:
- plugin_loader.py – dynamically discovers and loads artifact modules
- artifacts/ – ~300+ individual artifact extractor modules, each defining __artifacts_v2__ and an entry function
- filetypes/ – classes to identify different file formats
- ilapfuncs.py & artifact_report.py & report*.py – reporting utilities (HTML, TSV, timeline)
- html_parts.py – HTML templating fragments
- parse3.py, lavafuncs.py, names/, areacodes/, etc. – supporting lookup & parsing data
- version_info.py – version metadata
- pyinstaller/ – packaging hooks and spec files for building standalone executables

##### Key architectural insights from README
- Core workflow:
Input → File seeker → Plugin loader → Artifact modules → Report generator
- Plugin contract (__artifacts_v2__, entry-point signature, output expectations)
- Support for both CLI parameters and GUI invocation
- Output: HTML reports, TSV exports, timeline records

1. User Interfaces
- CLI Runner (rleapp.py)
- GUI Runner (rleappGUI.py + Tkinter)
2. Core Engine
- Argument Parser & Controller
- File Seeker (discovers files based on paths/patterns)
- Plugin Loader (scans scripts/artifacts folder, loads __artifacts_v2__ dicts)
3. Artifact Modules
- Conforms to plugin contract, calls specific extraction functions
4. Supporting Libraries
- Filetype detectors (scripts/filetypes)
- Parsing utilities (parse3.py, lavafuncs.py)
- Data lookups (names/, areacodes/)
5. Reporting Layer
- HTML parts & ArtifactHtmlReport (artifact_report.py, html_parts.py)
- TSV and timeline generators (ilapfuncs.py)
6. Output Storage
- Report folder with HTML/TSV/timeline files
7. Packaging
- PyInstaller specs for building executables (scripts/pyinstaller)

- User clicks “Run CLI/GUI” → Core Engine
- Core Engine passes input path to File Seeker → returns list of candidate files
- Plugin Loader discovers artifact modules → for each, invokes its entry function with files_found, report_folder, seeker, wrap_text
- Artifact functions use filetypes & parsing utilities → produce rows of data
- Reporting Layer consumes rows → creates HTML, TSV, timeline outputs → writes to Output Storage

c. Architectural patterns & principles
- Plugin architecture: loose coupling between core engine and artifact modules
- Separation of concerns: file discovery vs. data extraction vs. report generation
- Extensibility: new artifacts simply drop in scripts/artifacts with correct __artifacts_v2__ signature
- Reusability: shared utility modules (filetypes, parse functions)

d. Key technologies & frameworks
- Python 3.9+
- Tkinter (for GUI)
- PyInstaller (for bundling executables)
- Standard libs: argparse, glob, importlib, datetime, html templating

## Diagram (Mermaid)

```mermaid
graph TB
    %% User Interface Layer
    subgraph "User Interfaces"
        CLI["CLI Runner"]:::ui
        GUI["GUI Runner"]:::ui
        Icon["GUI Icon Asset"]:::ui
    end

    %% Core Engine Layer
    subgraph "Core Engine"
        ArgParser["Argument Parser & Controller"]:::core
        FileSeeker["File Seeker"]:::core
        PluginLoader["Plugin Loader"]:::core
    end

    %% Plugins Layer
    subgraph "Plugin Modules"
        Artifacts["Artifact Modules"]:::plugin
    end

    %% Utilities Layer
    subgraph "Supporting Libraries"
        Filetypes["Filetype Detectors"]:::util
        Parse3["parse3.py"]:::util
        LavaFuncs["lavafuncs.py"]:::util
        Names["names/"]:::util
        AreaCodes["areacodes/"]:::util
    end

    %% Reporting Layer
    subgraph "Reporting Layer"
        HtmlReport["ArtifactHtmlReport"]:::report
        HtmlParts["HTML Templating Fragments"]:::report
        ILAP["ilapfuncs.py"]:::report
        ReportIcons["Report Icons"]:::report
    end

    %% Output Storage
    Output["Report Folder (HTML/TSV/Timeline)"]:::storage

    %% Packaging
    subgraph "Packaging (PyInstaller)"
        PyInstaller["PyInstaller Hooks & Specs"]:::pack
    end

    %% Administration
    subgraph "Administrative"
        AdminDocs["Module Documentation"]:::admin
        AdminScripts["Metadata Scripts"]:::admin
    end

    %% Connections
    CLI -->|"runs"| ArgParser
    GUI -->|"runs"| ArgParser
    GUI -->|"loads icon"| Icon
    ArgParser -->|"file paths list"| FileSeeker
    FileSeeker -->|"candidates list"| PluginLoader
    PluginLoader -->|"loads plugins"| Artifacts
    Artifacts -->|"use detectors"| Filetypes
    Artifacts -->|"use parsing"| Parse3
    Artifacts -->|"use parsing"| LavaFuncs
    Artifacts -->|"lookup data"| Names
    Artifacts -->|"lookup data"| AreaCodes
    Artifacts -->|"artifact rows"| HtmlReport
    ILAP -->|"tsv & timeline"| HtmlReport
    HtmlReport -->|"templating"| HtmlParts
    HtmlReport -->|"generate reports"| Output
    HtmlParts -->|"fragments"| HtmlReport
    ILAP -->|"write outputs"| Output
    ReportIcons -->|"icons"| HtmlReport

    ArgParser --> PyInstaller
    FileSeeker --> PyInstaller
    PluginLoader --> PyInstaller
    Artifacts --> PyInstaller
    Filetypes --> PyInstaller
    Parse3 --> PyInstaller
    LavaFuncs --> PyInstaller
    Names --> PyInstaller
    AreaCodes --> PyInstaller
    HtmlReport --> PyInstaller
    ILAP --> PyInstaller
    HtmlParts --> PyInstaller

    %% Click Events
    click CLI "https://github.com/abrignoni/rleapp/blob/main/rleapp.py"
    click GUI "https://github.com/abrignoni/rleapp/blob/main/rleappGUI.py"
    click Icon "https://github.com/abrignoni/rleapp/blob/main/assets/icon.icns"
    click ArgParser "https://github.com/abrignoni/rleapp/blob/main/scripts/report.py"
    click FileSeeker "https://github.com/abrignoni/rleapp/blob/main/scripts/search_files.py"
    click PluginLoader "https://github.com/abrignoni/rleapp/blob/main/scripts/plugin_loader.py"
    click Artifacts "https://github.com/abrignoni/rleapp/tree/main/scripts/artifacts/"
    click Filetypes "https://github.com/abrignoni/rleapp/tree/main/scripts/filetypes/"
    click Parse3 "https://github.com/abrignoni/rleapp/blob/main/scripts/parse3.py"
    click LavaFuncs "https://github.com/abrignoni/rleapp/blob/main/scripts/lavafuncs.py"
    click Names "https://github.com/abrignoni/rleapp/tree/main/scripts/names/"
    click AreaCodes "https://github.com/abrignoni/rleapp/tree/main/scripts/areacodes/"
    click HtmlReport "https://github.com/abrignoni/rleapp/blob/main/scripts/artifact_report.py"
    click HtmlParts "https://github.com/abrignoni/rleapp/blob/main/scripts/html_parts.py"
    click ILAP "https://github.com/abrignoni/rleapp/blob/main/scripts/ilapfuncs.py"
    click ReportIcons "https://github.com/abrignoni/rleapp/blob/main/scripts/report_icons.py"
    click PyInstaller "https://github.com/abrignoni/rleapp/tree/main/scripts/pyinstaller/"
    click AdminDocs "https://github.com/abrignoni/rleapp/blob/main/admin/docs/module_info.md"
    click AdminScripts "https://github.com/abrignoni/rleapp/blob/main/admin/scripts/module_info.py"

    %% Styles
    classDef ui fill:#f9f,stroke:#333,stroke-width:1px
    classDef core fill:#bbf,stroke:#333,stroke-width:1px
    classDef plugin fill:#bfb,stroke:#333,stroke-width:1px
    classDef util fill:#ddd,stroke:#333,stroke-width:1px
    classDef report fill:#fc8,stroke:#333,stroke-width:1px
    classDef storage fill:#fff,stroke:#333,stroke-width:1px,stroke-dasharray: 5 5
    classDef pack fill:#dcb,stroke:#333,stroke-width:1px
    classDef admin fill:#eee,stroke:#333,stroke-width:1px
```
