OXYGENHUB
# e71846aa07b9 oxygenhub / crates / hub / src / web / mod.rs
27.4 KiB · Rust · last changed AI assistants: settings per site, organisation and repository 1 month ago source blame history raw
d23464c0 Andy McCall ↶ 1
//! Pages (hub spec §6): the router, the shell every template extends, the
19bb31ff Andy McCall ↶ 2
//! error page, viewer-aware lookups and askama filters. Handlers are thin:
3
//! they resolve names, call the view layer under the repository lock, and
4
//! render.
d23464c0 Andy McCall ↶ 5
19bb31ff Andy McCall ↶ 6
mod admin;
e71846aa Andy McCall ↶ 7
mod assistants;
10174045 Andy McCall ↶ 8
mod avatar;
38833ed7 Andy McCall ↶ 9
pub mod chain;
df71c789 Andy McCall ↶ 10
mod device;
14530604 Andy McCall ↶ 11
pub mod edit;
d23464c0 Andy McCall ↶ 12
pub mod filters;
42fa9554 Andy McCall ↶ 13
pub mod flow;
07b1a5bb Andy McCall ↶ 14
mod forks;
43e8ca33 Andy McCall ↶ 15
pub mod help;
b64e2537 Andy McCall ↶ 16
pub mod history;
e9bfea8e Andy McCall ↶ 17
pub mod home;
18e381ea Andy McCall ↶ 18
mod inbox;
19
pub mod issues;
19bb31ff Andy McCall ↶ 20
mod orgs;
ef20fdc1 Andy McCall ↶ 21
pub mod projects;
de505df5 Andy McCall ↶ 22
pub mod proposals;
34beb1a7 Andy McCall ↶ 23
mod recovery;
d23464c0 Andy McCall ↶ 24
mod refs;
df940d75 Andy McCall ↶ 25
pub mod release_trust;
3f4b0ea6 Andy McCall ↶ 26
pub mod releases;
d23464c0 Andy McCall ↶ 27
mod repo;
19bb31ff Andy McCall ↶ 28
mod repo_settings;
c5f3bde4 Andy McCall ↶ 29
mod resolve;
b6b7e4cf Andy McCall ↶ 30
pub mod runners;
19bb31ff Andy McCall ↶ 31
mod session;
df71c789 Andy McCall ↶ 32
pub(crate) mod settings;
d23464c0 Andy McCall ↶ 33
mod statics;
8fb35df7 Andy McCall ↶ 34
mod webhooks;
d23464c0 Andy McCall ↶ 35
19bb31ff Andy McCall ↶ 36
use crate::auth::{self, Access, Role, Viewer};
d23464c0 Andy McCall ↶ 37
use crate::repos::RepoError;
38
use crate::{db, Shared};
39
use askama::Template;
40
use axum::extract::DefaultBodyLimit;
41
use axum::http::{header, StatusCode};
19bb31ff Andy McCall ↶ 42
use axum::response::{Html, IntoResponse, Redirect, Response};
43
use axum::routing::{any, get, post};
d23464c0 Andy McCall ↶ 44
use axum::Router;
45
use tower_http::compression::CompressionLayer;
46
use tower_http::trace::TraceLayer;
47
48
pub fn router(app: Shared) -> Router {
49
    let push_limit = app.config.limits.push_body_limit.0 as usize;
50
    Router::new()
51
        .route("/", get(home::index))
52
        .route("/explore", get(home::explore))
10174045 Andy McCall ↶ 53
        .route("/avatar/{name}", get(avatar::avatar))
d23464c0 Andy McCall ↶ 54
        .route("/health", get(home::health))
e9bfea8e Andy McCall ↶ 55
        .route("/about", get(home::about))
d23464c0 Andy McCall ↶ 56
        .route("/.well-known/oxyhub-key", get(home::hub_key))
8f3d2ccf Andy McCall ↶ 57
        .route("/.well-known/oxyhub-ca.pem", get(home::hub_ca))
d23464c0 Andy McCall ↶ 58
        .route("/style.css", get(statics::style))
59
        .route("/favicon.svg", get(statics::favicon))
60
        .route("/favicon.ico", get(statics::favicon))
61
        .route("/static/{*path}", get(statics::asset))
19bb31ff Andy McCall ↶ 62
        .route("/login", get(session::login_form).post(session::login))
df71c789 Andy McCall ↶ 63
        .route("/device", get(device::form).post(device::answer))
19bb31ff Andy McCall ↶ 64
        .route("/logout", post(session::logout))
65
        .route("/register", get(session::register_form).post(session::register))
66
        .route("/settings", get(settings::profile).post(settings::update_profile))
67
        .route("/settings/password", post(settings::change_password))
c40c2d3e Andy McCall ↶ 68
        .route("/settings/appearance", post(settings::appearance))
19bb31ff Andy McCall ↶ 69
        .route("/settings/security", get(settings::security))
70
        .route("/settings/security/totp/begin", post(settings::totp_begin))
71
        .route("/settings/security/totp/enable", post(settings::totp_enable))
72
        .route("/settings/security/totp/disable", post(settings::totp_disable))
73
        .route("/settings/security/sessions", post(settings::sessions_reset))
74
        .route("/settings/keys", get(settings::keys))
75
        .route("/settings/keys/upload", post(settings::keys_upload))
76
        .route("/settings/keys/verify", post(settings::keys_verify))
77
        .route("/settings/keys/unlink", post(settings::keys_unlink))
78
        .route("/settings/tokens", get(settings::tokens).post(settings::tokens_create))
79
        .route("/settings/tokens/{id}/delete", post(settings::tokens_delete))
80
        .route("/new", get(repo_settings::new_form).post(repo_settings::create))
81
        .route("/orgs/new", get(orgs::new_form).post(orgs::create))
82
        .route("/orgs/{name}/settings", get(orgs::settings).post(orgs::update))
83
        .route("/orgs/{name}/settings/members", post(orgs::member))
84
        .route("/orgs/{name}/settings/teams", post(orgs::team))
8fb35df7 Andy McCall ↶ 85
        .route("/orgs/{name}/settings/hooks", post(orgs::hooks))
e71846aa Andy McCall ↶ 86
        .route("/orgs/{name}/settings/assistants", post(orgs::assistants))
7974adb0 Andy McCall ↶ 87
        .route("/orgs/{name}/settings/runners/token", post(orgs::runner_token))
88
        .route("/orgs/{name}/settings/runners/{id}/remove", post(orgs::runner_remove))
8fb35df7 Andy McCall ↶ 89
        .route("/orgs/{name}/settings/hooks/{id}/deliveries", get(orgs::deliveries))
90
        .route("/orgs/{name}/settings/hooks/{id}/redeliver/{delivery}", post(orgs::redeliver))
a160b98f Andy McCall ↶ 91
        .route("/orgs/{name}/settings/avatar", post(orgs::avatar).layer(DefaultBodyLimit::max(avatar::MAX_BYTES + (64 << 10))))
92
        .route("/settings/avatar", post(settings::avatar).layer(DefaultBodyLimit::max(avatar::MAX_BYTES + (64 << 10))))
18e381ea Andy McCall ↶ 93
        .route("/notifications", get(inbox::inbox))
94
        .route("/notifications/read", post(inbox::mark_read))
95
        .route("/settings/notifications", get(inbox::unsubscribe).post(inbox::prefs))
96
        .route("/search", get(inbox::search))
19bb31ff Andy McCall ↶ 97
        .route("/admin", get(admin::index))
98
        .route("/admin/registration", post(admin::set_mode))
99
        .route("/admin/invite", post(admin::invite))
100
        .route("/admin/account", post(admin::account))
8fb35df7 Andy McCall ↶ 101
        .route("/admin/storage", get(admin::storage).post(admin::maintain))
b6b7e4cf Andy McCall ↶ 102
        .route("/admin/runners", get(runners::list))
5dead1f4 Andy McCall ↶ 103
        .route("/admin/runners/settings", get(runners::settings).post(runners::save_settings))
b6b7e4cf Andy McCall ↶ 104
        .route("/admin/runners/token", post(runners::new_token))
105
        .route("/admin/runners/{id}", get(runners::show))
106
        .route("/admin/runners/{id}/state", post(runners::set_state))
74be9796 Andy McCall ↶ 107
        .route("/admin/runners/{id}/scope", post(runners::set_scope))
3556d08e Andy McCall ↶ 108
        .route("/admin/runners/{id}/limits", post(runners::set_limits))
109
        .route("/admin/mail", post(admin::set_mail))
110
        .route("/admin/mail/test", post(admin::test_mail))
e71846aa Andy McCall ↶ 111
        .route("/admin/assistants", post(admin::assistants))
b6b7e4cf Andy McCall ↶ 112
        .route("/admin/runners/{id}/remove", post(runners::remove))
5533e91a Andy McCall ↶ 113
        .nest("/api/v1", crate::api::router(app.config.limits.asset_limit.0 as usize))
d23464c0 Andy McCall ↶ 114
        .route("/{owner}", get(home::owner))
115
        .route("/{owner}/{name}", get(repo::overview))
116
        .route("/{owner}/{name}/tree/{r}", get(repo::tree_root))
117
        .route("/{owner}/{name}/tree/{r}/{*path}", get(repo::tree))
118
        .route("/{owner}/{name}/file/{r}/{*path}", get(repo::file))
65be9f9c Andy McCall ↶ 119
        .route("/{owner}/{name}/function/{r}/{*path}", get(history::function))
92574625 Andy McCall ↶ 120
        .route("/{owner}/{name}/lanes/{r}", get(history::lanes))
2bfe5ef6 Andy McCall ↶ 121
        .route("/{owner}/{name}/lanes/{r}/plan", post(history::plan))
736f6813 Andy McCall ↶ 122
        .route("/{owner}/{name}/raw/{r}/{*path}", get(repo::raw_file))
d23464c0 Andy McCall ↶ 123
        .route("/{owner}/{name}/last/{r}", get(repo::last_changes))
124
        .route("/{owner}/{name}/changes/{r}", get(history::history))
125
        .route("/{owner}/{name}/change/{hash}", get(history::change))
ea85398a Andy McCall ↶ 126
        .route("/apt", get(crate::apt::home))
127
        .route("/apt/{file}", get(crate::apt::key))
128
        .route("/apt/dists/{suite}/{*rest}", get(crate::apt::dists))
129
        .route("/apt/pool/{*path}", get(crate::apt::pool))
43e8ca33 Andy McCall ↶ 130
        .route("/help", get(help::help))
e1ec9fbf Andy McCall ↶ 131
        .route("/projects/{owner}", get(projects::list).post(projects::create))
132
        .route("/projects/{owner}/{number}", get(projects::show).post(projects::act))
eb0c44a9 Andy McCall ↶ 133
        .route("/notifications/thread", post(inbox::thread))
134
        .route("/notifications/open/{id}", get(inbox::open))
34beb1a7 Andy McCall ↶ 135
        .route("/login/reset", get(recovery::request_form).post(recovery::request))
136
        .route("/login/reset/{secret}", get(recovery::new_password_form).post(recovery::set_new_password))
137
        .route("/verify/{secret}", get(recovery::verify))
138
        .route("/settings/email/verify", post(settings::resend_verification))
3d1e74cd Andy McCall ↶ 139
        .route("/{owner}/{name}/compare", get(history::compare_index))
d23464c0 Andy McCall ↶ 140
        .route("/{owner}/{name}/compare/{spec}", get(history::compare))
141
        .route("/{owner}/{name}/bookmarks", get(refs::bookmarks))
e271a37b Andy McCall ↶ 142
        .route("/{owner}/{name}/bookmarks/delete", post(refs::delete_bookmark))
d23464c0 Andy McCall ↶ 143
        .route("/{owner}/{name}/tags", get(refs::tags))
144
        .route("/{owner}/{name}/conflicts", get(refs::conflicts))
145
        .route("/{owner}/{name}/trust", get(refs::trust))
146
        .route("/{owner}/{name}/pushes", get(refs::pushes))
07b1a5bb Andy McCall ↶ 147
        .route("/{owner}/{name}/fork", get(forks::form).post(forks::create))
148
        .route("/{owner}/{name}/forks", get(forks::list))
19bb31ff Andy McCall ↶ 149
        .route("/{owner}/{name}/settings", get(repo_settings::settings).post(repo_settings::update))
150
        .route("/{owner}/{name}/settings/collaborators", post(repo_settings::collaborator))
151
        .route("/{owner}/{name}/settings/delete", post(repo_settings::delete))
de505df5 Andy McCall ↶ 152
        .route("/{owner}/{name}/settings/requirements", post(repo_settings::requirements))
153
        .route("/{owner}/{name}/proposals", get(proposals::list))
154
        .route("/{owner}/{name}/proposals/new", get(proposals::new_form).post(proposals::create))
155
        .route("/{owner}/{name}/proposal/{number}", get(proposals::show))
156
        .route("/{owner}/{name}/proposal/{number}/comment", post(proposals::comment))
157
        .route("/{owner}/{name}/proposal/{number}/comment/{id}/resolve", post(proposals::resolve_comment))
158
        .route("/{owner}/{name}/proposal/{number}/review", post(proposals::review))
cc1cd197 Andy McCall ↶ 159
        .route("/{owner}/{name}/proposal/{number}/reviewers", post(proposals::reviewers))
de505df5 Andy McCall ↶ 160
        .route("/{owner}/{name}/proposal/{number}/edit", post(proposals::edit))
161
        .route("/{owner}/{name}/proposal/{number}/state", post(proposals::state))
162
        .route("/{owner}/{name}/proposal/{number}/land", post(proposals::land))
18e381ea Andy McCall ↶ 163
        .route("/{owner}/{name}/proposal/{number}/labels", post(proposals::set_labels))
a1b98695 Andy McCall ↶ 164
        .route("/{owner}/{name}/proposal/{number}/project", post(projects::place_proposal))
165
        .route("/{owner}/{name}/issue/{number}/project", post(projects::place_issue))
b64e2537 Andy McCall ↶ 166
        .route("/{owner}/{name}/proposal/{number}/events", get(proposals::events))
167
        .route("/{owner}/{name}/settings/hooks", post(repo_settings::hooks))
e71846aa Andy McCall ↶ 168
        .route("/{owner}/{name}/settings/assistants", post(repo_settings::assistants))
b64e2537 Andy McCall ↶ 169
        .route("/{owner}/{name}/settings/hooks/{id}/deliveries", get(repo_settings::deliveries))
170
        .route("/{owner}/{name}/settings/hooks/{id}/redeliver/{delivery}", post(repo_settings::redeliver))
171
        .route("/{owner}/{name}/settings/checks", post(repo_settings::required_checks))
18e381ea Andy McCall ↶ 172
        .route("/{owner}/{name}/watch", post(issues::watch))
1553bfc9 Andy McCall ↶ 173
        .route("/{owner}/{name}/star", post(issues::star))
14530604 Andy McCall ↶ 174
        .route("/{owner}/{name}/edit/{r}", post(edit::save))
175
        .route("/{owner}/{name}/edit/{r}/{*path}", get(edit::edit_form))
c5f3bde4 Andy McCall ↶ 176
        .route("/{owner}/{name}/resolve/{bookmark}/{*path}", get(resolve::form).post(resolve::save))
5e6d6484 Andy McCall ↶ 177
        .route("/{owner}/{name}/resolve-live/{bookmark}/{*path}", get(resolve::live_events).post(resolve::live_choose))
14530604 Andy McCall ↶ 178
        .route("/{owner}/{name}/newfile/{r}", get(edit::new_form))
42fa9554 Andy McCall ↶ 179
        .route("/{owner}/{name}/flow", get(flow::runs))
8933faff Andy McCall ↶ 180
        .route("/{owner}/{name}/flow/badge.svg", get(flow::badge))
42fa9554 Andy McCall ↶ 181
        .route("/{owner}/{name}/flow/{id}", get(flow::run))
182
        .route("/{owner}/{name}/flow/{id}/live", get(flow::live))
1edac4b6 Andy McCall ↶ 183
        .route("/{owner}/{name}/flow/start", post(flow::start))
184
        .route("/{owner}/{name}/flow/{id}/rerun", post(flow::rerun))
745d225d Andy McCall ↶ 185
        .route("/{owner}/{name}/flow/{id}/cancel", post(flow::cancel))
736f6813 Andy McCall ↶ 186
        .route("/{owner}/{name}/flow/stamp/{r}", get(flow::stamp))
187
        .route("/{owner}/{name}/flow/at/{r}", get(flow::at))
cc19697f Andy McCall ↶ 188
        .route("/{owner}/{name}/receipts/{attest}", get(flow::receipt_file))
a3c8288b Andy McCall ↶ 189
        .route("/{owner}/{name}/flow/{id}/artifacts/{job}/{artifact}", get(flow::artifact_file))
10708ab8 Andy McCall ↶ 190
        .route("/{owner}/{name}/flow/{id}/artifacts/{job}/{artifact}/attach", post(flow::attach))
3f4b0ea6 Andy McCall ↶ 191
        .route("/{owner}/{name}/releases", get(releases::list))
192
        .route("/{owner}/{name}/releases/new", get(releases::new_form).post(releases::create))
193
        .route("/{owner}/{name}/releases/tag/{*tag}", get(releases::show))
df940d75 Andy McCall ↶ 194
        .route("/{owner}/{name}/releases/trust/{*tag}", get(release_trust::page))
3f4b0ea6 Andy McCall ↶ 195
        .route("/{owner}/{name}/releases/edit/{id}", post(releases::edit))
196
        .route(
197
            "/{owner}/{name}/releases/upload/{id}",
198
            post(releases::upload).layer(DefaultBodyLimit::max(app.config.limits.asset_limit.0 as usize + (1 << 20))),
199
        )
200
        .route("/{owner}/{name}/asset/{id}/{file}", get(releases::download))
201
        .route("/{owner}/{name}/archive", get(releases::source_archive))
202
        .route("/{owner}/{name}/search", get(repo::code_search))
203
        .route("/{owner}/{name}/info/{*rest}", any(git_info))
204
        .route("/{owner}/{name}/HEAD", get(git_head))
205
        .route("/{owner}/{name}/objects/{*rest}", get(git_objects))
206
        .route("/{owner}/{name}/git-upload-pack", post(git_upload_pack))
207
        .route("/{owner}/{name}/git-receive-pack", post(git_receive_pack))
208
        .route("/{owner}/{name}/settings/mirror", post(repo_settings::mirror))
9008bf6c Andy McCall ↶ 209
        .route("/{owner}/{name}/settings/flow", post(repo_settings::flow))
7974adb0 Andy McCall ↶ 210
        .route("/{owner}/{name}/settings/runners/token", post(repo_settings::runner_token))
211
        .route("/{owner}/{name}/settings/runners/{id}/remove", post(repo_settings::runner_remove))
18e381ea Andy McCall ↶ 212
        .route("/{owner}/{name}/issues", get(issues::list))
213
        .route("/{owner}/{name}/issues/new", get(issues::new_form).post(issues::create))
214
        .route("/{owner}/{name}/issue/{number}", get(issues::show))
215
        .route("/{owner}/{name}/issue/{number}/comment", post(issues::comment))
216
        .route("/{owner}/{name}/issue/{number}/comment/{id}/delete", post(issues::delete_comment))
217
        .route("/{owner}/{name}/issue/{number}/edit", post(issues::edit))
218
        .route("/{owner}/{name}/issue/{number}/state", post(issues::state))
219
        .route("/{owner}/{name}/issue/{number}/labels", post(issues::set_labels))
220
        .route("/{owner}/{name}/issue/{number}/assign", post(issues::assign))
221
        .route("/{owner}/{name}/issue/{number}/milestone", post(issues::set_milestone))
222
        .route("/{owner}/{name}/issue/{number}/subscribe", post(issues::subscribe))
223
        .route("/{owner}/{name}/labels", get(issues::labels).post(issues::save_label))
224
        .route("/{owner}/{name}/milestones", get(issues::milestones).post(issues::save_milestone))
d23464c0 Andy McCall ↶ 225
        .route("/{owner}/{name}/oxy/v1/{endpoint}", any(crate::protocol::dispatch).layer(DefaultBodyLimit::max(push_limit)))
226
        .fallback(not_found)
19bb31ff Andy McCall ↶ 227
        .layer(axum::middleware::from_fn_with_state(app.clone(), same_origin))
d23464c0 Andy McCall ↶ 228
        .layer(CompressionLayer::new())
229
        .layer(TraceLayer::new_for_http())
230
        .with_state(app)
231
}
232
3f4b0ea6 Andy McCall ↶ 233
// Git's smart HTTP paths under `/{owner}/{name}.git/`, forwarded to the
234
// mirror (hub spec §14).
235
async fn git_info(
236
    st: axum::extract::State<Shared>,
237
    axum::extract::Path((o, n, rest)): axum::extract::Path<(String, String, String)>,
238
    m: axum::http::Method,
239
    q: axum::extract::RawQuery,
240
    h: axum::http::HeaderMap,
241
    b: axum::body::Bytes,
242
) -> Response {
243
    crate::mirror::serve(st, axum::extract::Path((o, n, format!("info/{rest}"))), m, q, h, b).await
244
}
245
246
async fn git_head(
247
    st: axum::extract::State<Shared>,
248
    axum::extract::Path((o, n)): axum::extract::Path<(String, String)>,
249
    m: axum::http::Method,
250
    q: axum::extract::RawQuery,
251
    h: axum::http::HeaderMap,
252
    b: axum::body::Bytes,
253
) -> Response {
254
    crate::mirror::serve(st, axum::extract::Path((o, n, "HEAD".into())), m, q, h, b).await
255
}
256
257
async fn git_objects(
258
    st: axum::extract::State<Shared>,
259
    axum::extract::Path((o, n, rest)): axum::extract::Path<(String, String, String)>,
260
    m: axum::http::Method,
261
    q: axum::extract::RawQuery,
262
    h: axum::http::HeaderMap,
263
    b: axum::body::Bytes,
264
) -> Response {
265
    crate::mirror::serve(st, axum::extract::Path((o, n, format!("objects/{rest}"))), m, q, h, b).await
266
}
267
268
async fn git_upload_pack(
269
    st: axum::extract::State<Shared>,
270
    axum::extract::Path((o, n)): axum::extract::Path<(String, String)>,
271
    m: axum::http::Method,
272
    q: axum::extract::RawQuery,
273
    h: axum::http::HeaderMap,
274
    b: axum::body::Bytes,
275
) -> Response {
276
    crate::mirror::serve(st, axum::extract::Path((o, n, "git-upload-pack".into())), m, q, h, b).await
277
}
278
279
async fn git_receive_pack(
280
    st: axum::extract::State<Shared>,
281
    axum::extract::Path((o, n)): axum::extract::Path<(String, String)>,
282
    m: axum::http::Method,
283
    q: axum::extract::RawQuery,
284
    h: axum::http::HeaderMap,
285
    b: axum::body::Bytes,
286
) -> Response {
287
    crate::mirror::serve(st, axum::extract::Path((o, n, "git-receive-pack".into())), m, q, h, b).await
288
}
289
19bb31ff Andy McCall ↶ 290
/// Cross-site form posts are refused (hub spec §15.2): a browser that
291
/// sends `Origin` or `Sec-Fetch-Site` must name this site. Protocol and
292
/// API clients send neither.
293
async fn same_origin(
294
    axum::extract::State(app): axum::extract::State<Shared>,
295
    req: axum::extract::Request,
296
    next: axum::middleware::Next,
297
) -> Response {
298
    if req.method() != axum::http::Method::GET && req.method() != axum::http::Method::HEAD {
299
        let headers = req.headers();
300
        if headers.get("sec-fetch-site").and_then(|v| v.to_str().ok()) == Some("cross-site") {
301
            return (StatusCode::FORBIDDEN, "cross-site request refused").into_response();
302
        }
303
        if let Some(origin) = headers.get(header::ORIGIN).and_then(|v| v.to_str().ok()) {
304
            let host_of = |u: &str| u.split("://").nth(1).unwrap_or(u).split('/').next().unwrap_or("").to_ascii_lowercase();
305
            let request_host = headers.get(header::HOST).and_then(|v| v.to_str().ok()).map(|h| h.to_ascii_lowercase());
306
            let ok = host_of(origin) == host_of(app.config.base_url()) || request_host.as_deref() == Some(host_of(origin).as_str());
307
            if !ok && origin != "null" {
308
                return (StatusCode::FORBIDDEN, "cross-site request refused").into_response();
309
            }
310
        }
311
    }
312
    next.run(req).await
313
}
314
d23464c0 Andy McCall ↶ 315
/// What every page's chrome needs.
316
#[derive(Clone, Debug)]
317
pub struct Shell {
318
    pub site: String,
319
    pub base_url: String,
320
    pub path: String,
321
    pub version: &'static str,
e9bfea8e Andy McCall ↶ 322
    /// What was built: `oxy describe` at deploy, a Flow build's heads, or "local build".
323
    pub build: &'static str,
19bb31ff Andy McCall ↶ 324
    /// The signed-in username, if any.
325
    pub user: Option<String>,
326
    pub is_admin: bool,
327
    pub csrf: String,
18e381ea Andy McCall ↶ 328
    pub unread: i64,
d23464c0 Andy McCall ↶ 329
}
330
331
impl Shell {
19bb31ff Andy McCall ↶ 332
    pub fn new(app: &Shared, path: &str, viewer: &Viewer) -> Shell {
d23464c0 Andy McCall ↶ 333
        Shell {
334
            site: app.config.site.name.clone(),
335
            base_url: app.config.base_url().to_string(),
336
            path: path.to_string(),
337
            version: env!("CARGO_PKG_VERSION"),
e9bfea8e Andy McCall ↶ 338
            build: env!("OXY_BUILD_ID"),
19bb31ff Andy McCall ↶ 339
            user: viewer.account().map(|a| a.username.clone()),
340
            is_admin: viewer.is_admin(),
341
            csrf: viewer.csrf().to_string(),
18e381ea Andy McCall ↶ 342
            unread: viewer.0.as_ref().map(|v| v.unread).unwrap_or(0),
d23464c0 Andy McCall ↶ 343
        }
344
    }
19bb31ff Andy McCall ↶ 345
346
    pub fn anonymous(app: &Shared, path: &str) -> Shell {
347
        Shell::new(app, path, &Viewer(None))
348
    }
d23464c0 Andy McCall ↶ 349
}
350
351
/// The repository chrome: tabs and counts.
352
#[derive(Clone, Debug)]
353
pub struct RepoShell {
354
    pub owner: String,
355
    pub name: String,
356
    pub url: String,
357
    pub description: String,
358
    pub default_bookmark: String,
359
    pub visibility: String,
360
    pub tab: &'static str,
361
    pub clone_url: String,
19bb31ff Andy McCall ↶ 362
    /// The viewer's role, for showing settings and write actions.
363
    pub role: Option<Role>,
1ac84c62 Andy McCall ↶ 364
    /// Open issues and proposals, shown on their tabs.
365
    pub open_issues: i64,
366
    pub open_proposals: i64,
d23464c0 Andy McCall ↶ 367
}
368
369
impl RepoShell {
370
    pub fn new(app: &Shared, row: &db::repos::RepoRow, tab: &'static str) -> RepoShell {
371
        RepoShell {
372
            owner: row.owner.clone(),
373
            name: row.name.clone(),
374
            url: format!("/{}/{}", row.owner, row.name),
375
            description: row.description.clone(),
376
            default_bookmark: row.default_bookmark.clone(),
377
            visibility: row.visibility.clone(),
378
            tab,
379
            clone_url: format!("{}/{}/{}", app.config.base_url(), row.owner, row.name),
19bb31ff Andy McCall ↶ 380
            role: None,
1ac84c62 Andy McCall ↶ 381
            open_issues: row.open_issues,
382
            open_proposals: row.open_proposals,
d23464c0 Andy McCall ↶ 383
        }
384
    }
19bb31ff Andy McCall ↶ 385
386
    pub fn with_role(mut self, role: Role) -> RepoShell {
387
        self.role = Some(role);
388
        self
389
    }
390
391
    pub fn can(&self, access: Access) -> bool {
392
        auth::roles::allows(self.role, access)
393
    }
394
395
    pub fn can_maintain(&self) -> bool {
396
        self.can(Access::Maintain)
397
    }
d23464c0 Andy McCall ↶ 398
}
399
400
/// Render a template as an HTML response.
1ac84c62 Andy McCall ↶ 401
/// One page of a long list: which page, how many, and links that keep
402
/// the rest of the query.
403
#[derive(Clone, Debug)]
404
pub struct Pager {
405
    pub page: usize,
406
    pub pages: usize,
407
    pub total: usize,
408
    /// The query without `page`, each pair encoded, joined with `&`.
409
    query: String,
410
}
411
412
impl Pager {
413
    pub const PER_PAGE: usize = 25;
414
415
    /// `page` counts from 1; out-of-range pages clamp to the last.
416
    pub fn new(total: usize, page: Option<usize>, query: &[(&str, &str)]) -> Pager {
417
        let pages = total.div_ceil(Self::PER_PAGE).max(1);
418
        let page = page.unwrap_or(1).clamp(1, pages);
419
        let query = query
420
            .iter()
421
            .filter(|(_, v)| !v.is_empty())
422
            .map(|(k, v)| format!("{k}={}", settings::urlencode(v).replace('/', "%2F")))
423
            .collect::<Vec<_>>()
424
            .join("&");
425
        Pager { page, pages, total, query }
426
    }
427
428
    /// This page's items.
429
    pub fn slice<T>(&self, all: Vec<T>) -> Vec<T> {
430
        all.into_iter().skip((self.page - 1) * Self::PER_PAGE).take(Self::PER_PAGE).collect()
431
    }
432
433
    pub fn url(&self, page: usize) -> String {
434
        if self.query.is_empty() {
435
            format!("?page={page}")
436
        } else {
437
            format!("?{}&page={page}", self.query)
438
        }
439
    }
440
441
    /// The same query with another sort, back on page one.
442
    pub fn sorted(&self, sort: &str) -> String {
443
        let rest: Vec<&str> = self.query.split('&').filter(|p| !p.is_empty() && !p.starts_with("sort=")).collect();
444
        let mut q = rest.join("&");
445
        if !q.is_empty() {
446
            q.push('&');
447
        }
448
        format!("?{q}sort={sort}")
449
    }
450
}
451
d23464c0 Andy McCall ↶ 452
pub struct Page<T: Template>(pub T);
453
454
impl<T: Template> IntoResponse for Page<T> {
455
    fn into_response(self) -> Response {
456
        match self.0.render() {
457
            Ok(s) => Html(s).into_response(),
458
            Err(e) => {
459
                tracing::error!("template: {e}");
460
                (StatusCode::INTERNAL_SERVER_ERROR, "template error").into_response()
461
            }
462
        }
463
    }
464
}
465
466
#[derive(Template)]
467
#[template(path = "error.html")]
468
struct ErrorPage {
469
    shell: Shell,
470
    status: u16,
471
    title: String,
472
    detail: String,
473
}
474
19bb31ff Andy McCall ↶ 475
/// A page-level failure, rendered inside the shell, or a redirect.
d23464c0 Andy McCall ↶ 476
#[derive(Debug)]
477
pub struct Error {
478
    pub status: StatusCode,
479
    pub detail: String,
19bb31ff Andy McCall ↶ 480
    shell: Option<Box<Shell>>,
481
    redirect: Option<String>,
d23464c0 Andy McCall ↶ 482
}
483
484
impl Error {
19bb31ff Andy McCall ↶ 485
    pub fn redirect(to: String) -> Error {
486
        Error { status: StatusCode::SEE_OTHER, detail: String::new(), shell: None, redirect: Some(to) }
487
    }
488
d23464c0 Andy McCall ↶ 489
    pub fn not_found(shell: Shell) -> Error {
19bb31ff Andy McCall ↶ 490
        Error {
491
            status: StatusCode::NOT_FOUND,
492
            detail: "There is nothing at this address.".into(),
493
            shell: Some(Box::new(shell)),
494
            redirect: None,
495
        }
d23464c0 Andy McCall ↶ 496
    }
497
498
    pub fn bad(shell: Shell, detail: impl Into<String>) -> Error {
19bb31ff Andy McCall ↶ 499
        Error { status: StatusCode::BAD_REQUEST, detail: detail.into(), shell: Some(Box::new(shell)), redirect: None }
d23464c0 Andy McCall ↶ 500
    }
501
502
    pub fn from_repo(shell: Shell, e: RepoError) -> Error {
503
        match e {
504
            RepoError::NotFound => Error::not_found(shell),
19bb31ff Andy McCall ↶ 505
            RepoError::Oxy(oxy_core::repo::RepoError::Msg(m)) => {
506
                Error { status: StatusCode::NOT_FOUND, detail: m, shell: Some(Box::new(shell)), redirect: None }
507
            }
508
            other => {
509
                Error { status: StatusCode::INTERNAL_SERVER_ERROR, detail: other.to_string(), shell: Some(Box::new(shell)), redirect: None }
510
            }
d23464c0 Andy McCall ↶ 511
        }
512
    }
513
514
    pub fn from_db(shell: Shell, e: sqlx::Error) -> Error {
19bb31ff Andy McCall ↶ 515
        Error { status: StatusCode::INTERNAL_SERVER_ERROR, detail: e.to_string(), shell: Some(Box::new(shell)), redirect: None }
d23464c0 Andy McCall ↶ 516
    }
517
}
518
519
impl IntoResponse for Error {
520
    fn into_response(self) -> Response {
19bb31ff Andy McCall ↶ 521
        if let Some(to) = self.redirect {
522
            return Redirect::to(&to).into_response();
523
        }
d23464c0 Andy McCall ↶ 524
        let title = match self.status {
525
            StatusCode::NOT_FOUND => "Not found",
526
            StatusCode::BAD_REQUEST => "Bad request",
527
            _ => "Something went wrong",
528
        };
529
        if self.status.is_server_error() {
530
            tracing::error!("{}", self.detail);
531
        }
19bb31ff Andy McCall ↶ 532
        let shell = self.shell.map(|b| *b).unwrap_or(Shell {
8d2caf12 Andy McCall ↶ 533
            site: "OxygenHub".into(),
19bb31ff Andy McCall ↶ 534
            base_url: String::new(),
535
            path: String::new(),
536
            version: "",
e9bfea8e Andy McCall ↶ 537
            build: "",
19bb31ff Andy McCall ↶ 538
            user: None,
539
            is_admin: false,
540
            csrf: String::new(),
18e381ea Andy McCall ↶ 541
            unread: 0,
19bb31ff Andy McCall ↶ 542
        });
d23464c0 Andy McCall ↶ 543
        let page = ErrorPage { shell, status: self.status.as_u16(), title: title.into(), detail: self.detail };
544
        match page.render() {
545
            Ok(s) => (self.status, Html(s)).into_response(),
546
            Err(_) => (self.status, title).into_response(),
547
        }
548
    }
549
}
550
19bb31ff Andy McCall ↶ 551
async fn not_found(axum::extract::State(app): axum::extract::State<Shared>, viewer: Viewer, uri: axum::http::Uri) -> Response {
552
    Error::not_found(Shell::new(&app, uri.path(), &viewer)).into_response()
d23464c0 Andy McCall ↶ 553
}
554
555
/// A raw file response with a safe content type (hub spec §15.2).
556
pub fn raw(bytes: Vec<u8>, name: &str, inline_image: bool) -> Response {
557
    let mime = mime_of(name);
558
    let disposition = if inline_image && mime.starts_with("image/") { "inline" } else { "attachment" };
559
    (
560
        [
561
            (header::CONTENT_TYPE, mime.to_string()),
562
            (header::CONTENT_DISPOSITION, format!("{disposition}; filename=\"{}\"", name.replace('"', ""))),
563
            (header::X_CONTENT_TYPE_OPTIONS, "nosniff".to_string()),
564
        ],
565
        bytes,
566
    )
567
        .into_response()
568
}
569
570
pub fn mime_of(name: &str) -> &'static str {
571
    match name.rsplit('.').next().map(|e| e.to_ascii_lowercase()).as_deref() {
572
        Some("png") => "image/png",
573
        Some("jpg" | "jpeg") => "image/jpeg",
574
        Some("gif") => "image/gif",
575
        Some("webp") => "image/webp",
576
        Some("svg") => "image/svg+xml",
577
        Some("pdf") => "application/pdf",
578
        Some(
579
            "txt" | "md" | "rs" | "toml" | "json" | "yml" | "yaml" | "c" | "h" | "cpp" | "hpp" | "py" | "js" | "ts" | "html" | "css" | "sh",
580
        ) => "text/plain; charset=utf-8",
581
        _ => "application/octet-stream",
582
    }
583
}
584
19bb31ff Andy McCall ↶ 585
/// Resolve `{owner}/{name}` for the viewer with at least `access`, or 404:
586
/// a repository the viewer may not see does not exist for them (hub spec
587
/// §4.4). Returns the viewer's role too.
588
pub async fn lookup_role(
589
    app: &Shared,
590
    shell: &Shell,
591
    viewer: &Viewer,
592
    owner: &str,
593
    name: &str,
594
    access: Access,
595
) -> Result<(crate::repos::RepoName, db::repos::RepoRow, Role), Error> {
d23464c0 Andy McCall ↶ 596
    let repo = crate::repos::RepoName::new(owner, name).ok_or_else(|| Error::not_found(shell.clone()))?;
19bb31ff Andy McCall ↶ 597
    let row = db::repos::get(&app.db, owner, name)
598
        .await
599
        .map_err(|e| Error::from_db(shell.clone(), e))?
600
        .ok_or_else(|| Error::not_found(shell.clone()))?;
601
    let role = auth::roles::role_for(&app.db, viewer.account(), &row).await.map_err(|e| Error::from_db(shell.clone(), e))?;
602
    if !auth::roles::allows(role, access) {
603
        return Err(Error::not_found(shell.clone()));
604
    }
605
    Ok((repo, row, role.unwrap_or(Role::Read)))
606
}
607
608
/// `lookup_role` for reading.
609
pub async fn lookup(
610
    app: &Shared,
611
    shell: &Shell,
612
    viewer: &Viewer,
613
    owner: &str,
614
    name: &str,
615
) -> Result<(crate::repos::RepoName, db::repos::RepoRow, Role), Error> {
616
    lookup_role(app, shell, viewer, owner, name, Access::Read).await
617
}
618
619
/// Fill `account` on change authors whose key is linked to an account.
620
pub async fn attribute(app: &Shared, changes: &mut [&mut crate::repos::view::ChangeView]) {
621
    if changes.is_empty() {
622
        return;
623
    }
624
    let Ok(links) = db::accounts::identity_accounts(&app.db).await else { return };
625
    let map: std::collections::HashMap<String, String> = links.into_iter().collect();
626
    for c in changes.iter_mut() {
627
        if let Some(u) = map.get(&c.author.key) {
628
            c.author.account = Some(u.clone());
629
        }
d23464c0 Andy McCall ↶ 630
    }
631
}