# mikumifa/bilitickerbuy architecture

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

- Interactive diagram: https://gitdiagram.com/mikumifa/bilitickerbuy
- Repository: https://github.com/mikumifa/bilitickerbuy

## Overview

##### Project type and purpose
- From the file tree and README we see this is an open‑source, Python‑based CLI application (“biliTickerBuy”) that automates B站会员购 (Bilibili membership purchase) flows. It bundles captcha‑solving models (ONNX), HTTP clients, task schedulers and notification utilities into a single distributable script/Docker image.

##### File structure
- Top‑level:
- main.py / const.py / main.spec – the application entry point, constants and PyInstaller spec.
- Dockerfile – containerized deployment.
- requirements.txt – Python dependencies (requests, onnxruntime, etc.).
- Directories by functional area:
- geetest/ – captcha‑solving engine and ONNX models.
- tab/ – modules for listing/querying available tickets (“go.py”, “problems.py”, “train.py”, “settings.py”).
- task/ – higher‑level automation tasks (e.g., purchase logic in buy.py).
- util/ – shared utilities (HTTP request wrapper, cookie manager, KV database, push‑notification clients, time service, dynamic import).
- CI/Release: .github/workflows, release-drafter, templates.

##### README for additional insights
- Confirms it’s a free, easy‑to‑use Bilibili membership‑purchase helper.
- Points at a user manual (not in repo) and describes how to raise issues/discussions.

1. CLI Entry Point (main.py)
2. Configuration Loader (util/config.py + const.py)
3. Task Manager (task/buy.py + dynamic importer util/dynimport.py)
4. Tab Manager (tab/go.py + related modules)
5. HTTP Client (util/BiliRequest.py)
6. Cookie Manager (util/CookieManager.py)
7. Captcha Solver (geetest/Validator.py + Amorter/Normal/Triple + ONNX models)
8. Local Storage (util/KVDatabase.py)
9. Notification Services (util/PushPlusUtil.py, ServerChanUtil.py)
10. External Services:
- Bilibili API endpoints
- Geetest CAPTCHA endpoint
- PushPlus / ServerChan notification gateways
11. Deployment Container (Docker) or Local Python Runtime

- The user invokes main.py → Configuration Loader initializes settings → Task Manager and/or Tab Manager instantiated.
- Task/Tab modules call HTTP Client, passing cookies from Cookie Manager.
- When a captcha challenge is encountered, HTTP Client routes to Captcha Solver, which loads ONNX models from geetest/model/*.onnx and returns a solved token.
- HTTP Client completes the Bilibili API request.
- Responses and state updates are written to Local Storage (KVDatabase).
- On success/failure, Notification Services push status to external channels.

c. Architectural patterns & design principles
- Layered structure: CLI → Orchestrator (tasks/tab) → Services (HTTP, Captcha, Storage) → External systems.
- Pluggable modules via dynamic import (util/dynimport.py).
- Separation of concerns between business logic (task/) and infrastructure (util/, geetest/).
- Containerization for repeatable deployment (Dockerfile + GitHub Actions).

d. Key technologies & frameworks
- Python 3.x
- requests or similar HTTP library (via util/BiliRequest)
- ONNX Runtime for model inference (geetest)
- PyInstaller spec (main.spec)
- Docker for container build/distribution

##### Diagramming conventions
- Rectangles (blue) for internal modules (main, task, tab).
- Rounded rectangles (green) for utility services (HTTP client, cookie, KV DB).
- Clouds (purple) for external endpoints (Bilibili API, Geetest, notification gateways).

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% CORE LOGIC Layer
    subgraph "CORE LOGIC"
        direction TB
        Main["CLI Entry Point\n(main.py)"]:::internal
        ConfigLoader["Configuration Loader\n(util/config.py, const.py)"]:::internal
        TaskManager["Task Manager\n(task/buy.py\nutil/dynimport.py)"]:::internal
        TabManager["Tab Manager\n(tab/go.py,\nproblems.py,\nsettings.py,\ntrain.py)"]:::internal
    end

    %% INFRASTRUCTURE Layer
    subgraph "INFRASTRUCTURE"
        direction TB
        HTTPClient["HTTP Client\n(util/BiliRequest.py)"]:::service
        CookieManager["Cookie Manager\n(util/CookieManager.py)"]:::service
        LocalStorage["Local Storage\n(util/KVDatabase.py)"]:::storage
        subgraph "Captcha Subsystem"
            direction TB
            Validator["Validator\n(geetest/Validator.py)"]:::service
            Amorter["AmorterValidator\n(geetest/AmorterValidator.py)"]:::service
            Normal["NormalValidator\n(geetest/NormalValidator.py)"]:::service
            Triple["TripleValidator\n(geetest/TripleValidator.py)"]:::service
            Models["ONNX Models\n(model/*.onnx)"]:::storage
        end
        Notification["Notification Services\n(util/PushPlusUtil.py,\nutil/ServerChanUtil.py)"]:::service
    end

    %% DEPLOYMENT Layer
    subgraph "DEPLOYMENT"
        direction TB
        Deployment["Deployment Container\n(Dockerfile,\nmain.spec)"]:::external
    end

    %% EXTERNAL Services
    subgraph "EXTERNAL SERVICES"
        direction TB
        BiliAPI["Bilibili API"]:::external
        GeetestAPI["Geetest CAPTCHA Endpoint"]:::external
        PushPlusAPI["PushPlus Gateway"]:::external
        ServerChanAPI["ServerChan Gateway"]:::external
    end

    %% Connections
    Main -->|"loads config"| ConfigLoader
    ConfigLoader -->|"init orchestrator"| TaskManager
    ConfigLoader -->|"init orchestrator"| TabManager
    TaskManager -->|"calls HTTP"| HTTPClient
    TabManager -->|"calls HTTP"| HTTPClient
    HTTPClient -->|"uses cookies"| CookieManager
    HTTPClient -->|"solve captcha"| Validator
    Validator -->|"chooses implementation"| Amorter
    Validator -->|"chooses implementation"| Normal
    Validator -->|"chooses implementation"| Triple
    Validator -->|"loads model"| Models
    HTTPClient -->|"request"| BiliAPI
    HTTPClient -->|"request challenge"| GeetestAPI
    TaskManager -->|"writes state"| LocalStorage
    TabManager -->|"writes state"| LocalStorage
    TaskManager -->|"push result"| Notification
    TabManager -->|"push result"| Notification
    Notification -->|"push to"| PushPlusAPI
    Notification -->|"push to"| ServerChanAPI
    Deployment -->|"packages"| Main
    Deployment -->|"packages"| ConfigLoader
    Deployment -->|"packages"| TaskManager
    Deployment -->|"packages"| TabManager
    Deployment -->|"packages"| HTTPClient
    Deployment -->|"packages"| CookieManager
    Deployment -->|"packages"| Validator
    Deployment -->|"packages"| LocalStorage
    Deployment -->|"packages"| Notification

    %% Click Events
    click Main "https://github.com/mikumifa/bilitickerbuy/blob/main/main.py"
    click ConfigLoader "https://github.com/mikumifa/bilitickerbuy/blob/main/util/config.py"
    click ConfigLoader "https://github.com/mikumifa/bilitickerbuy/blob/main/const.py"
    click TaskManager "https://github.com/mikumifa/bilitickerbuy/blob/main/task/buy.py"
    click TaskManager "https://github.com/mikumifa/bilitickerbuy/blob/main/util/dynimport.py"
    click TabManager "https://github.com/mikumifa/bilitickerbuy/blob/main/tab/go.py"
    click TabManager "https://github.com/mikumifa/bilitickerbuy/blob/main/tab/problems.py"
    click TabManager "https://github.com/mikumifa/bilitickerbuy/blob/main/tab/settings.py"
    click TabManager "https://github.com/mikumifa/bilitickerbuy/blob/main/tab/train.py"
    click HTTPClient "https://github.com/mikumifa/bilitickerbuy/blob/main/util/BiliRequest.py"
    click CookieManager "https://github.com/mikumifa/bilitickerbuy/blob/main/util/CookieManager.py"
    click Validator "https://github.com/mikumifa/bilitickerbuy/blob/main/geetest/Validator.py"
    click Amorter "https://github.com/mikumifa/bilitickerbuy/blob/main/geetest/AmorterValidator.py"
    click Normal "https://github.com/mikumifa/bilitickerbuy/blob/main/geetest/NormalValidator.py"
    click Triple "https://github.com/mikumifa/bilitickerbuy/blob/main/geetest/TripleValidator.py"
    click Models "https://github.com/mikumifa/bilitickerbuy/tree/main/geetest/model"
    click LocalStorage "https://github.com/mikumifa/bilitickerbuy/blob/main/util/KVDatabase.py"
    click Notification "https://github.com/mikumifa/bilitickerbuy/blob/main/util/PushPlusUtil.py"
    click Notification "https://github.com/mikumifa/bilitickerbuy/blob/main/util/ServerChanUtil.py"
    click Deployment "https://github.com/mikumifa/bilitickerbuy/tree/main/Dockerfile"
    click Deployment "https://github.com/mikumifa/bilitickerbuy/blob/main/main.spec"

    %% Styles
    classDef internal fill:#ADD8E6,stroke:#000,stroke-width:1px
    classDef service fill:#90EE90,stroke:#000,stroke-width:1px
    classDef storage fill:#FFA500,stroke:#000,stroke-width:1px
    classDef external fill:#DDA0DD,stroke:#000,stroke-width:1px
```
