# psyclone20/library architecture

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

- Interactive diagram: https://gitdiagram.com/psyclone20/library
- Repository: https://github.com/psyclone20/library

## Overview

##### Project Type & Purpose
- This is a monolithic, server-rendered full-stack web application written in PHP.
- It supports two user roles—Member and Librarian—with workflows for registration, book requests, returns, penalties, and email notifications.
- It persists data in a MySQL (library_db) database and uses SMTP for outgoing email.

##### File Structure
- Top-level: LICENSE, README.md, db/, screenshots/, src/
- db/: Holds the database DDL (library_db.sql).
- src/: All PHP entry points, shared include files, CSS, images.
- src/db_connect.php: Database connection logic.
- src/header.php, src/message_display.php, src/logout.php, src/verify_logged_out.php: Common layout & session control.
- src/index.php: Public home/login landing.
- src/librarian/: Contains separate views & controllers for librarian workflows (insert_book.php, pending_registrations.php, due_handler.php, etc.).
- src/member/: Contains member workflows (register.php, my_books.php, etc.).

##### README for Key Behaviors
- Automatic email confirmations on registration & issue.
- Scheduled reminders & penalties for overdue books (due_handler.php likely invoked via cron).
- Role‐based access control: separate “verify_librarian.php” and “verify_member.php” guards.

##### Main Components & Their Interactions
a. User Clients
- Member’s Browser
- Librarian’s Browser
b. Web Server / PHP Application
- Authentication & Session Manager
- Member Module
- Librarian Module
- Notification Service (email logic invoked by user actions & scheduled via cron)
- Database Access Layer (db_connect.php + SQL queries)
c. Database
- MySQL instance hosting tables for users, books, issues, penalties, etc.
d. External Service
- SMTP mail server for sending notifications and reminders

##### Architectural Patterns & Tech
- Monolithic MVC‐style php scripts (each PHP file acts as a controller + view).
- Shared includes implement simple templating/layout (header.php).
- Scheduled batch job (due_handler.php) for periodic tasks.
- Role‐based access control through verify_*.php wrappers.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% User Clients
    memberBrowser["Member Browser"]:::user
    librarianBrowser["Librarian Browser"]:::user

    %% Web Server / PHP App
    subgraph "Web Server / PHP Application"
        direction TB
        subgraph "Authentication & Session Manager"
            direction TB
            header["header.php"]:::app
            verifyLoggedOut["verify_logged_out.php"]:::app
            logout["logout.php"]:::app
        end
        subgraph "Role-Based Access Control Guards"
            direction TB
            verifyLibrarian["verify_librarian.php"]:::app
            verifyMember["verify_member.php"]:::app
        end
        subgraph "Database Access Layer"
            direction TB
            dbConnect["db_connect.php"]:::app
        end
        subgraph "Member Services"
            direction TB
            memberIndex["index.php"]:::app
            memberRegister["register.php"]:::app
            memberHome["home.php"]:::app
            memberBooks["my_books.php"]:::app
            headerMember["header_member.php"]:::app
            memberCSS["css/"]:::asset
        end
        subgraph "Librarian Services"
            direction TB
            librarianIndex["index.php"]:::app
            insertBook["insert_book.php"]:::app
            pendingRegs["pending_registrations.php"]:::app
            pendingReqs["pending_book_requests.php"]:::app
            updateBalance["update_balance.php"]:::app
            updateCopies["update_copies.php"]:::app
            librarianHome["home.php"]:::app
            headerLibrarian["header_librarian.php"]:::app
            librarianCSS["css/"]:::asset
        end
        subgraph "Notification Service"
            direction TB
            dueHandler["due_handler.php\n(Cron)"]:::cron
        end
    end

    %% Database and Scripts
    subgraph "Database"
        direction TB
        mysqlDB["MySQL Database"]:::db
        sqlScript["library_db.sql"]:::script
    end

    %% External Services
    smtp["SMTP Mail Server"]:::external

    %% Connections
    memberBrowser -->|Login Request| header
    librarianBrowser -->|Login Request| header

    header --> verifyLoggedOut
    header --> verifyLibrarian
    header --> verifyMember

    memberBrowser --> memberIndex
    memberIndex --> headerMember
    memberIndex --> memberRegister
    memberRegister --> dbConnect
    memberRegister -->|"SMTP: sendMail()"| smtp
    memberHome --> dbConnect
    memberBooks --> dbConnect

    librarianBrowser --> librarianIndex
    librarianIndex --> headerLibrarian
    insertBook --> dbConnect
    insertBook -->|"SMTP: sendMail()"| smtp
    pendingRegs --> dbConnect
    pendingReqs --> dbConnect
    updateBalance --> dbConnect
    updateCopies --> dbConnect
    librarianHome --> dbConnect

    dbConnect -->|"SELECT/UPDATE Queries"| mysqlDB
    mysqlDB -->|Query Results| dbConnect

    dueHandler -.->|Cron Trigger| dueHandler
    dueHandler -->|"UPDATE penalties"| mysqlDB
    dueHandler -->|"SMTP: sendReminders()"| smtp

    sqlScript --> mysqlDB

    %% Click Events
    click header "https://github.com/psyclone20/library/blob/master/src/header.php"
    click verifyLoggedOut "https://github.com/psyclone20/library/blob/master/src/verify_logged_out.php"
    click logout "https://github.com/psyclone20/library/blob/master/src/logout.php"
    click verifyLibrarian "https://github.com/psyclone20/library/blob/master/src/librarian/verify_librarian.php"
    click verifyMember "https://github.com/psyclone20/library/blob/master/src/member/verify_member.php"
    click dbConnect "https://github.com/psyclone20/library/blob/master/src/db_connect.php"
    click memberIndex "https://github.com/psyclone20/library/blob/master/src/member/index.php"
    click memberRegister "https://github.com/psyclone20/library/blob/master/src/member/register.php"
    click memberHome "https://github.com/psyclone20/library/blob/master/src/member/home.php"
    click memberBooks "https://github.com/psyclone20/library/blob/master/src/member/my_books.php"
    click headerMember "https://github.com/psyclone20/library/blob/master/src/member/header_member.php"
    click memberCSS "https://github.com/psyclone20/library/tree/master/src/member/css/"
    click librarianIndex "https://github.com/psyclone20/library/blob/master/src/librarian/index.php"
    click insertBook "https://github.com/psyclone20/library/blob/master/src/librarian/insert_book.php"
    click pendingRegs "https://github.com/psyclone20/library/blob/master/src/librarian/pending_registrations.php"
    click pendingReqs "https://github.com/psyclone20/library/blob/master/src/librarian/pending_book_requests.php"
    click updateBalance "https://github.com/psyclone20/library/blob/master/src/librarian/update_balance.php"
    click updateCopies "https://github.com/psyclone20/library/blob/master/src/librarian/update_copies.php"
    click librarianHome "https://github.com/psyclone20/library/blob/master/src/librarian/home.php"
    click headerLibrarian "https://github.com/psyclone20/library/blob/master/src/librarian/header_librarian.php"
    click librarianCSS "https://github.com/psyclone20/library/tree/master/src/librarian/css/"
    click dueHandler "https://github.com/psyclone20/library/blob/master/src/librarian/due_handler.php"
    click sqlScript "https://github.com/psyclone20/library/blob/master/db/library_db.sql"

    %% Styles
    classDef user fill:#BBDEFB,stroke:#0D47A1,stroke-width:2px;
    classDef app fill:#C8E6C9,stroke:#1B5E20,stroke-width:2px;
    classDef db fill:#FFE0B2,stroke:#E65100,stroke-width:2px;
    classDef external fill:#E1BEE7,stroke:#4A148C,stroke-width:2px;
    classDef script fill:#FFE0B2,stroke:#E65100,stroke-width:2px,stroke-dasharray: 5 5;
    classDef cron fill:#FFF9C4,stroke:#F57F17,stroke-width:2px,stroke-dasharray: 5 5;
    classDef asset fill:#F5F5F5,stroke:#9E9E9E,stroke-width:1px;
```
