lariv-rs 0.1.0

Compile-time plugin web application framework built on Axum, SeaORM, Maud, and HTMX
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

//! Virtual node (VNode) database filesystem.
//!
//! Integrates local or GCS blob storage with database VNode entities for
//! uploads, downloads, folder hierarchies, and file browsing.
//!
//! # Configurations
//!
//! - `[filesystem]` → [`config::FilesystemConfig`]: storage backend (local directory or GCS bucket),
//!   credentials, and path prefixes.
//!
//! # Database models
//!
//! - [`entities::VNode`]: file/directory nodes with parent links, sizes, and MIME metadata.
//!   [`storage::Filestore`] supports streaming writes via reader APIs.
//!
//! # Templates and layers
//!
//! - List, detail, create/update forms, and file selector ([`templates`]).
//! - View stacks in [`layers`] with auth via [`crate::plugins::users::middleware::RequireAuth`].
//!
//! # Routes
//!
//! - `/filesystem/`, `/filesystem/create/`, `/filesystem/u/{id}/`, edit/delete
//! - `/filesystem/select/` — file picker table

pub mod apps;
pub mod config;
pub mod create_modals;
pub mod entities;
pub mod forms;
pub mod handlers;
pub mod keys;
pub mod layers;
pub mod migrations;
pub mod node;
pub mod routes;
pub mod state;
pub mod storage;
pub mod templates;
pub mod zip;

use std::sync::Arc;

use frunk::{HCons, HNil, hlist::HList};

use crate::plugin_install::define_plugin_install;
use crate::{
    app::App,
    capability::{CapStore, define_passthrough_cap},
    config::{ConfigCap, ConfigTag},
    db::{DbCap, DbTag},
    hooks::AttachState,
    traits::{
        add::{AddCapability, CapTagAbsent},
        get::{GetByCapTag, GetByTag},
    },
};

use config::{FilesystemConfig, FilesystemConfigTag};
use state::FilesystemState;
use storage::{DynFilestore, filestore_from_config};

/// Capability tag for the filesystem plugin state.
pub struct FilesystemTag;

define_passthrough_cap!(FilesystemStateCap, FilesystemTag, FilesystemState);

define_plugin_install! {
    plugin: FilesystemTag;
    /// Register filesystem deferred hooks (apps, migrations, templates, slots, config, routes, state).
    steps: [
        apps(apps::Hook),
        migrations(migrations::Hook),
        templates(templates::Hook),
        slots(templates::SlotsHook),
        config(FilesystemConfigTag, FilesystemConfig),
        http(routes::Hook),
        state(StateHook),
    ]
}

/// Attaches [`FilesystemState`] (DB, filestore, config) at app mount.
#[derive(Clone, Copy, Default)]
pub struct StateHook;

impl<L, DbIdx, CfgIdx, Configs, FsCfgIdx, TagProof>
    AttachState<L, (DbIdx, CfgIdx, Configs, FsCfgIdx, TagProof)> for StateHook
where
    L: GetByCapTag<DbTag, DbIdx, Value = DbCap>,
    L: GetByCapTag<ConfigTag, CfgIdx, Value = ConfigCap<HNil, Configs>>,
    Configs: GetByTag<FilesystemConfigTag, FsCfgIdx, Value = FilesystemConfig>,
    L: HList + CapTagAbsent<FilesystemTag, TagProof>,
{
    type Output = HCons<FilesystemStateCap, L>;

    fn attach_state(app: App<L>) -> App<Self::Output> {
        let conn = app.get_capability::<DbTag, DbIdx>().items.conn.clone();
        let config = <Configs as GetByTag<FilesystemConfigTag, FsCfgIdx>>::get_by_tag(
            &app.get_capability::<ConfigTag, CfgIdx>().items,
        )
        .clone();
        let store: Arc<DynFilestore> = filestore_from_config(&config);
        app.add_capability(CapStore::with_items(FilesystemState::new(
            conn, store, config,
        )))
    }
}