OXYGENHUB
# 6ae3fa0af4f6 oxygenhub / crates / hub / src / web / mod.rs
34.5 KiB · Rust · last changed fix(web): a long state no longer runs across the sidebar (closes #170) 22 days ago source blame history raw
1
//! Pages (hub spec §6): the router, the shell every template extends, the
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.
5
6
mod admin;
7
pub(crate) mod assistants;
8
mod avatar;
9
mod backups;
10
pub mod chain;
11
pub mod coverage;
12
mod device;
13
mod diffusion;
14
pub mod edit;
15
pub mod filters;
16
pub mod flow;
17
mod forks;
18
pub mod help;
19
pub mod history;
20
pub mod home;
21
pub mod icons;
22
23
/// A state as people read it (oxygenhub#170): `02a6c9d4746a+… (14 heads)`
24
/// for heads joined by `+`, which can run to hundreds of characters; a
25
/// single head, or text that is not heads, unchanged.
26
pub fn state_label(text: &str) -> String {
27
    let parts: Vec<&str> = text.split('+').collect();
28
    let heads = parts.len() > 1 && parts.iter().all(|p| p.len() >= 7 && p.chars().all(|c| c.is_ascii_hexdigit()));
29
    if !heads {
30
        return text.to_string();
31
    }
32
    format!("{}+… ({} heads)", &parts[0][..12.min(parts[0].len())], parts.len())
33
}
34
mod inbox;
35
pub mod issues;
36
mod orgs;
37
pub mod projects;
38
pub mod proposals;
39
mod recovery;
40
mod refs;
41
pub mod release_trust;
42
pub mod releases;
43
mod repo;
44
mod repo_settings;
45
pub mod reports;
46
mod resolve;
47
pub mod runners;
48
mod secrets;
49
mod session;
50
pub(crate) mod settings;
51
mod signin;
52
mod statics;
53
pub mod test_reports;
54
mod variables;
55
mod webhooks;
56
mod wiki;
57
58
use crate::auth::{self, Access, Role, Viewer};
59
use crate::repos::RepoError;
60
use crate::{db, Shared};
61
use askama::Template;
62
use axum::extract::DefaultBodyLimit;
63
use axum::http::{header, StatusCode};
64
use axum::response::{Html, IntoResponse, Redirect, Response};
65
use axum::routing::{any, get, post};
66
use axum::Router;
67
use tower_http::compression::CompressionLayer;
68
use tower_http::trace::TraceLayer;
69
70
pub fn router(app: Shared) -> Router {
71
    let push_limit = app.config.limits.push_body_limit.0 as usize;
72
    Router::new()
73
        .route("/", get(home::index))
74
        .route("/explore", get(home::explore))
75
        .route("/avatar/agent/{name}", get(avatar::agent))
76
        .route("/avatar/{name}", get(avatar::avatar))
77
        .route("/health", get(home::health))
78
        .route("/about", get(home::about))
79
        .route("/.well-known/oxyhub-key", get(home::hub_key))
80
        .route("/.well-known/oxyhub-ca.pem", get(home::hub_ca))
81
        .route("/.well-known/openid-configuration", get(crate::oidc::discovery))
82
        .route("/.well-known/jwks.json", get(crate::oidc::jwks))
83
        .route("/style.css", get(statics::style))
84
        .route("/favicon.svg", get(statics::favicon))
85
        .route("/favicon.ico", get(statics::favicon))
86
        .route("/static/{*path}", get(statics::asset))
87
        .route("/login", get(session::login_form).post(session::login))
88
        .route("/device", get(device::form).post(device::answer))
89
        .route("/logout", post(session::logout))
90
        .route("/register", get(session::register_form).post(session::register))
91
        .route("/settings", get(settings::profile).post(settings::update_profile))
92
        .route("/settings/password", post(settings::change_password))
93
        .route("/settings/appearance", post(settings::appearance))
94
        .route("/settings/security", get(settings::security))
95
        .route("/settings/security/totp/begin", post(settings::totp_begin))
96
        .route("/settings/security/totp/enable", post(settings::totp_enable))
97
        .route("/settings/security/totp/disable", post(settings::totp_disable))
98
        .route("/settings/security/sessions", post(settings::sessions_reset))
99
        .route("/settings/keys", get(settings::keys))
100
        .route("/settings/keys/upload", post(settings::keys_upload))
101
        .route("/settings/keys/verify", post(settings::keys_verify))
102
        .route("/settings/keys/unlink", post(settings::keys_unlink))
103
        .route("/settings/tokens", get(settings::tokens).post(settings::tokens_create))
104
        .route("/settings/backups", get(backups::user).post(backups::user_save))
105
        .route("/settings/backups/run", post(backups::user_run))
106
        .route("/orgs/{name}/settings/backups", get(backups::org).post(backups::org_save))
107
        .route("/orgs/{name}/settings/backups/run", post(backups::org_run))
108
        .route("/settings/tokens/{id}/delete", post(settings::tokens_delete))
109
        .route("/new", get(repo_settings::new_form).post(repo_settings::create))
110
        .route("/orgs/new", get(orgs::new_form).post(orgs::create))
111
        .route("/orgs/{name}/settings", get(orgs::settings).post(orgs::update))
112
        .route("/orgs/{name}/settings/members", post(orgs::member))
113
        .route("/orgs/{name}/settings/teams", post(orgs::team))
114
        .route("/orgs/{name}/settings/hooks", post(orgs::hooks))
115
        .route("/orgs/{name}/settings/assistants", post(orgs::assistants))
116
        .route("/orgs/{name}/settings/assistants/models", post(orgs::assistant_models))
117
        .route("/orgs/{name}/settings/variables", post(orgs::variables))
118
        .route("/orgs/{name}/settings/secrets", post(orgs::secrets))
119
        .route("/orgs/{name}/settings/storage", post(orgs::storage))
120
        .route("/orgs/{name}/settings/runners/token", post(orgs::runner_token))
121
        .route("/orgs/{name}/settings/runners/{id}/remove", post(orgs::runner_remove))
122
        .route("/orgs/{name}/settings/hooks/{id}/deliveries", get(orgs::deliveries))
123
        .route("/orgs/{name}/settings/hooks/{id}/redeliver/{delivery}", post(orgs::redeliver))
124
        .route("/orgs/{name}/settings/avatar", post(orgs::avatar).layer(DefaultBodyLimit::max(avatar::MAX_BYTES + (64 << 10))))
125
        .route("/settings/avatar", post(settings::avatar).layer(DefaultBodyLimit::max(avatar::MAX_BYTES + (64 << 10))))
126
        .route("/notifications", get(inbox::inbox))
127
        .route("/notifications/read", post(inbox::mark_read))
128
        .route("/settings/notifications", get(inbox::unsubscribe).post(inbox::prefs))
129
        .route("/search", get(inbox::search))
130
        .route("/admin", get(admin::index))
131
        .route("/admin/registration", post(admin::set_mode))
132
        .route("/admin/invite", post(admin::invite))
133
        .route("/admin/account", post(admin::account))
134
        .route("/admin/storage", get(admin::storage).post(admin::maintain))
135
        .route("/admin/runners", get(runners::list))
136
        .route("/admin/runners/settings", get(runners::settings).post(runners::save_settings))
137
        .route("/admin/runners/images", get(runners::images))
138
        .route("/admin/diffusion", get(diffusion::admin))
139
        .route("/{owner}/{name}/diffusion", get(diffusion::page))
140
        .route("/admin/runners/token", post(runners::new_token))
141
        .route("/admin/runners/{id}", get(runners::show))
142
        .route("/admin/runners/{id}/state", post(runners::set_state))
143
        .route("/admin/runners/{id}/scope", post(runners::set_scope))
144
        .route("/admin/runners/{id}/limits", post(runners::set_limits))
145
        .route("/admin/mail", post(admin::set_mail))
146
        .route("/admin/mail/test", post(admin::test_mail))
147
        .route("/admin/assistants", post(admin::assistants))
148
        .route("/admin/assistants/models", post(admin::assistant_models))
149
        .route("/admin/signin", post(admin::signin))
150
        .route("/login/{provider}", get(signin::start))
151
        .route("/login/{provider}/callback", get(signin::callback))
152
        .route("/settings/security/connect/{provider}", get(signin::connect))
153
        .route("/settings/security/disconnect/{provider}", post(signin::disconnect))
154
        .route("/admin/variables", post(admin::variables))
155
        .route("/admin/secrets", post(admin::secrets))
156
        .route("/admin/runners/{id}/remove", post(runners::remove))
157
        .nest("/api/v1", crate::api::router(app.config.limits.asset_limit.0 as usize))
158
        .route("/{owner}", get(home::owner))
159
        .route("/{owner}/{name}", get(repo::overview))
160
        .route("/{owner}/{name}/tree/{r}", get(repo::tree_root))
161
        .route("/{owner}/{name}/tree/{r}/{*path}", get(repo::tree))
162
        .route("/{owner}/{name}/file/{r}/{*path}", get(repo::file))
163
        .route("/{owner}/{name}/function/{r}/{*path}", get(history::function))
164
        .route("/{owner}/{name}/lanes/{r}", get(history::lanes))
165
        .route("/{owner}/{name}/lanes/{r}/plan", post(history::plan))
166
        .route("/{owner}/{name}/raw/{r}/{*path}", get(repo::raw_file))
167
        .route("/{owner}/{name}/last/{r}", get(repo::last_changes))
168
        .route("/{owner}/{name}/changes/{r}", get(history::history))
169
        .route("/{owner}/{name}/change/{hash}", get(history::change))
170
        .route("/apt", get(crate::apt::home))
171
        .route("/apt/{file}", get(crate::apt::key))
172
        .route("/apt/dists/{suite}/{*rest}", get(crate::apt::dists))
173
        .route("/apt/pool/{*path}", get(crate::apt::pool))
174
        .route("/help", get(help::help))
175
        .route("/projects/{owner}", get(projects::list).post(projects::create))
176
        .route("/projects/{owner}/{number}", get(projects::show).post(projects::act))
177
        .route("/notifications/thread", post(inbox::thread))
178
        .route("/notifications/open/{id}", get(inbox::open))
179
        .route("/login/reset", get(recovery::request_form).post(recovery::request))
180
        .route("/login/reset/{secret}", get(recovery::new_password_form).post(recovery::set_new_password))
181
        .route("/verify/{secret}", get(recovery::verify))
182
        .route("/settings/email/verify", post(settings::resend_verification))
183
        .route("/{owner}/{name}/compare", get(history::compare_index))
184
        .route("/{owner}/{name}/compare/{spec}", get(history::compare))
185
        .route("/{owner}/{name}/bookmarks", get(refs::bookmarks))
186
        .route("/{owner}/{name}/bookmarks/delete", post(refs::delete_bookmark))
187
        .route("/{owner}/{name}/tags", get(refs::tags))
188
        .route("/{owner}/{name}/conflicts", get(refs::conflicts))
189
        .route("/{owner}/{name}/trust", get(refs::trust))
190
        .route("/{owner}/{name}/pushes", get(refs::pushes))
191
        .route("/{owner}/{name}/fork", get(forks::form).post(forks::create))
192
        .route("/{owner}/{name}/forks", get(forks::list))
193
        .route("/{owner}/{name}/settings", get(repo_settings::settings).post(repo_settings::update))
194
        .route("/{owner}/{name}/settings/collaborators", post(repo_settings::collaborator))
195
        .route("/{owner}/{name}/settings/delete", post(repo_settings::delete))
196
        .route("/{owner}/{name}/settings/transfer", post(repo_settings::transfer))
197
        .route("/{owner}/{name}/settings/archive", post(repo_settings::archive))
198
        .route("/{owner}/{name}/settings/wiki/delete", post(repo_settings::wiki_delete))
199
        .route("/{owner}/{name}/wiki", get(wiki::home))
200
        .route("/{owner}/{name}/wiki/_pages", get(wiki::pages))
201
        .route("/{owner}/{name}/wiki/_new", get(wiki::new_form))
202
        .route("/{owner}/{name}/wiki/_raw/{*path}", get(wiki::raw))
203
        .route("/{owner}/{name}/wiki/{slug}", get(wiki::show))
204
        .route("/{owner}/{name}/wiki/{slug}/edit", get(wiki::edit_form).post(wiki::save))
205
        .route("/{owner}/{name}/wiki/{slug}/history", get(wiki::history))
206
        .route("/{owner}/{name}/wiki/{slug}/delete", post(wiki::delete))
207
        .route("/{owner}/{name}/settings/requirements", post(repo_settings::requirements))
208
        .route("/{owner}/{name}/proposals", get(proposals::list))
209
        .route("/{owner}/{name}/proposals/new", get(proposals::new_form).post(proposals::create))
210
        .route("/{owner}/{name}/proposals/new/draft", post(proposals::new_draft))
211
        .route("/{owner}/{name}/proposal/{number}", get(proposals::show))
212
        .route("/{owner}/{name}/proposal/{number}/comment", post(proposals::comment))
213
        .route("/{owner}/{name}/proposal/{number}/comment/{id}/resolve", post(proposals::resolve_comment))
214
        .route("/{owner}/{name}/proposal/{number}/review", post(proposals::review))
215
        .route("/{owner}/{name}/proposal/{number}/reviewers", post(proposals::reviewers))
216
        .route("/{owner}/{name}/proposal/{number}/assistant", post(proposals::assistant))
217
        .route("/{owner}/{name}/proposal/{number}/draft", post(proposals::draft))
218
        .route("/{owner}/{name}/proposal/{number}/edit", post(proposals::edit))
219
        .route("/{owner}/{name}/proposal/{number}/state", post(proposals::state))
220
        .route("/{owner}/{name}/proposal/{number}/land", post(proposals::land))
221
        .route("/{owner}/{name}/proposal/{number}/labels", post(proposals::set_labels))
222
        .route("/{owner}/{name}/proposal/{number}/project", post(projects::place_proposal))
223
        .route("/{owner}/{name}/issue/{number}/project", post(projects::place_issue))
224
        .route("/{owner}/{name}/proposal/{number}/events", get(proposals::events))
225
        .route("/{owner}/{name}/settings/hooks", post(repo_settings::hooks))
226
        .route("/{owner}/{name}/settings/assistants", post(repo_settings::assistants))
227
        .route("/{owner}/{name}/settings/assistants/models", post(repo_settings::assistant_models))
228
        .route("/{owner}/{name}/settings/variables", post(repo_settings::variables))
229
        .route("/{owner}/{name}/settings/secrets", post(repo_settings::secrets))
230
        .route("/{owner}/{name}/settings/hooks/{id}/deliveries", get(repo_settings::deliveries))
231
        .route("/{owner}/{name}/settings/hooks/{id}/redeliver/{delivery}", post(repo_settings::redeliver))
232
        .route("/{owner}/{name}/settings/checks", post(repo_settings::required_checks))
233
        .route("/{owner}/{name}/watch", post(issues::watch))
234
        .route("/{owner}/{name}/star", post(issues::star))
235
        .route("/{owner}/{name}/edit/{r}", post(edit::save))
236
        .route("/{owner}/{name}/edit/{r}/{*path}", get(edit::edit_form))
237
        .route("/{owner}/{name}/resolve/{bookmark}/{*path}", get(resolve::form).post(resolve::save))
238
        .route("/{owner}/{name}/resolve-live/{bookmark}/{*path}", get(resolve::live_events).post(resolve::live_choose))
239
        .route("/{owner}/{name}/newfile/{r}", get(edit::new_form))
240
        .route("/{owner}/{name}/flow", get(flow::runs))
241
        .route("/{owner}/{name}/flow/badge.svg", get(flow::badge))
242
        .route("/{owner}/{name}/tests", get(test_reports::overview))
243
        .route("/{owner}/{name}/tests/case", get(test_reports::case))
244
        .route("/{owner}/{name}/reports", get(reports::overview))
245
        .route("/{owner}/{name}/reports/files/{id}/{mac}/{*path}", get(reports::file))
246
        .route("/{owner}/{name}/reports/{report}", get(reports::show))
247
        .route("/{owner}/{name}/coverage", get(coverage::overview))
248
        .route("/{owner}/{name}/coverage/badge.svg", get(coverage::badge))
249
        .route("/{owner}/{name}/coverage/{id}/file/{*path}", get(coverage::file))
250
        .route("/{owner}/{name}/flow/{id}", get(flow::run))
251
        .route("/{owner}/{name}/flow/{id}/live", get(flow::live))
252
        .route("/{owner}/{name}/flow/start", post(flow::start))
253
        .route("/{owner}/{name}/flow/{id}/rerun", post(flow::rerun))
254
        .route("/{owner}/{name}/flow/{id}/cancel", post(flow::cancel))
255
        .route("/{owner}/{name}/flow/stamp/{r}", get(flow::stamp))
256
        .route("/{owner}/{name}/flow/at/{r}", get(flow::at))
257
        .route("/{owner}/{name}/receipts/{attest}", get(flow::receipt_file))
258
        .route("/{owner}/{name}/flow/{id}/artifacts/{job}/{artifact}", get(flow::artifact_file))
259
        .route("/{owner}/{name}/flow/{id}/artifacts/{job}/{artifact}/attach", post(flow::attach))
260
        .route("/{owner}/{name}/releases", get(releases::list))
261
        .route("/{owner}/{name}/releases/new", get(releases::new_form).post(releases::create))
262
        .route("/{owner}/{name}/releases/tag/{*tag}", get(releases::show))
263
        .route("/{owner}/{name}/releases/trust/{*tag}", get(release_trust::page))
264
        .route("/{owner}/{name}/releases/edit/{id}", post(releases::edit))
265
        .route(
266
            "/{owner}/{name}/releases/upload/{id}",
267
            post(releases::upload).layer(DefaultBodyLimit::max(app.config.limits.asset_limit.0 as usize + (1 << 20))),
268
        )
269
        .route("/{owner}/{name}/asset/{id}/{file}", get(releases::download))
270
        .route("/{owner}/{name}/archive", get(releases::source_archive))
271
        .route("/{owner}/{name}/search", get(repo::code_search))
272
        .route("/{owner}/{name}/info/{*rest}", any(git_info))
273
        .route("/{owner}/{name}/HEAD", get(git_head))
274
        .route("/{owner}/{name}/objects/{*rest}", get(git_objects))
275
        .route("/{owner}/{name}/git-upload-pack", post(git_upload_pack))
276
        .route("/{owner}/{name}/git-receive-pack", post(git_receive_pack))
277
        .route("/{owner}/{name}/settings/mirror", post(repo_settings::mirror))
278
        .route("/{owner}/{name}/settings/flow", post(repo_settings::flow))
279
        .route("/{owner}/{name}/settings/diffusion", post(repo_settings::diffusion))
280
        .route("/{owner}/{name}/settings/storage", post(repo_settings::storage))
281
        .route("/{owner}/{name}/settings/coverage", post(repo_settings::coverage))
282
        .route("/{owner}/{name}/settings/runners/token", post(repo_settings::runner_token))
283
        .route("/{owner}/{name}/settings/runners/{id}/remove", post(repo_settings::runner_remove))
284
        .route("/{owner}/{name}/issues", get(issues::list))
285
        .route("/{owner}/{name}/issues/new", get(issues::new_form).post(issues::create))
286
        .route("/{owner}/{name}/issue/{number}", get(issues::show))
287
        .route("/{owner}/{name}/issue/{number}/comment", post(issues::comment))
288
        .route("/{owner}/{name}/issue/{number}/comment/{id}/delete", post(issues::delete_comment))
289
        .route("/{owner}/{name}/issue/{number}/edit", post(issues::edit))
290
        .route("/{owner}/{name}/issue/{number}/state", post(issues::state))
291
        .route("/{owner}/{name}/issue/{number}/labels", post(issues::set_labels))
292
        .route("/{owner}/{name}/issue/{number}/assign", post(issues::assign))
293
        .route("/{owner}/{name}/issue/{number}/milestone", post(issues::set_milestone))
294
        .route("/{owner}/{name}/issue/{number}/subscribe", post(issues::subscribe))
295
        .route("/{owner}/{name}/labels", get(issues::labels).post(issues::save_label))
296
        .route("/{owner}/{name}/milestones", get(issues::milestones).post(issues::save_milestone))
297
        .route("/{owner}/{name}/oxy/v1/{endpoint}", any(crate::protocol::dispatch).layer(DefaultBodyLimit::max(push_limit)))
298
        .fallback(not_found)
299
        .layer(axum::middleware::from_fn_with_state(app.clone(), same_origin))
300
        .layer(CompressionLayer::new())
301
        .layer(TraceLayer::new_for_http())
302
        .with_state(app)
303
}
304
305
// Git's smart HTTP paths under `/{owner}/{name}.git/`, forwarded to the
306
// mirror (hub spec §14).
307
async fn git_info(
308
    st: axum::extract::State<Shared>,
309
    axum::extract::Path((o, n, rest)): axum::extract::Path<(String, String, String)>,
310
    m: axum::http::Method,
311
    q: axum::extract::RawQuery,
312
    h: axum::http::HeaderMap,
313
    b: axum::body::Bytes,
314
) -> Response {
315
    crate::mirror::serve(st, axum::extract::Path((o, n, format!("info/{rest}"))), m, q, h, b).await
316
}
317
318
async fn git_head(
319
    st: axum::extract::State<Shared>,
320
    axum::extract::Path((o, n)): axum::extract::Path<(String, String)>,
321
    m: axum::http::Method,
322
    q: axum::extract::RawQuery,
323
    h: axum::http::HeaderMap,
324
    b: axum::body::Bytes,
325
) -> Response {
326
    crate::mirror::serve(st, axum::extract::Path((o, n, "HEAD".into())), m, q, h, b).await
327
}
328
329
async fn git_objects(
330
    st: axum::extract::State<Shared>,
331
    axum::extract::Path((o, n, rest)): axum::extract::Path<(String, String, String)>,
332
    m: axum::http::Method,
333
    q: axum::extract::RawQuery,
334
    h: axum::http::HeaderMap,
335
    b: axum::body::Bytes,
336
) -> Response {
337
    crate::mirror::serve(st, axum::extract::Path((o, n, format!("objects/{rest}"))), m, q, h, b).await
338
}
339
340
async fn git_upload_pack(
341
    st: axum::extract::State<Shared>,
342
    axum::extract::Path((o, n)): axum::extract::Path<(String, String)>,
343
    m: axum::http::Method,
344
    q: axum::extract::RawQuery,
345
    h: axum::http::HeaderMap,
346
    b: axum::body::Bytes,
347
) -> Response {
348
    crate::mirror::serve(st, axum::extract::Path((o, n, "git-upload-pack".into())), m, q, h, b).await
349
}
350
351
async fn git_receive_pack(
352
    st: axum::extract::State<Shared>,
353
    axum::extract::Path((o, n)): axum::extract::Path<(String, String)>,
354
    m: axum::http::Method,
355
    q: axum::extract::RawQuery,
356
    h: axum::http::HeaderMap,
357
    b: axum::body::Bytes,
358
) -> Response {
359
    crate::mirror::serve(st, axum::extract::Path((o, n, "git-receive-pack".into())), m, q, h, b).await
360
}
361
362
/// Cross-site form posts are refused (hub spec §15.2): a browser that
363
/// sends `Origin` or `Sec-Fetch-Site` must name this site. Protocol and
364
/// API clients send neither.
365
async fn same_origin(
366
    axum::extract::State(app): axum::extract::State<Shared>,
367
    req: axum::extract::Request,
368
    next: axum::middleware::Next,
369
) -> Response {
370
    if req.method() != axum::http::Method::GET && req.method() != axum::http::Method::HEAD {
371
        let headers = req.headers();
372
        if headers.get("sec-fetch-site").and_then(|v| v.to_str().ok()) == Some("cross-site") {
373
            return (StatusCode::FORBIDDEN, "cross-site request refused").into_response();
374
        }
375
        if let Some(origin) = headers.get(header::ORIGIN).and_then(|v| v.to_str().ok()) {
376
            let host_of = |u: &str| u.split("://").nth(1).unwrap_or(u).split('/').next().unwrap_or("").to_ascii_lowercase();
377
            let request_host = headers.get(header::HOST).and_then(|v| v.to_str().ok()).map(|h| h.to_ascii_lowercase());
378
            let ok = host_of(origin) == host_of(app.config.base_url()) || request_host.as_deref() == Some(host_of(origin).as_str());
379
            if !ok && origin != "null" {
380
                return (StatusCode::FORBIDDEN, "cross-site request refused").into_response();
381
            }
382
        }
383
    }
384
    next.run(req).await
385
}
386
387
/// What every page's chrome needs.
388
#[derive(Clone, Debug)]
389
pub struct Shell {
390
    pub site: String,
391
    pub base_url: String,
392
    pub path: String,
393
    pub version: &'static str,
394
    /// What was built: `oxy describe` at deploy, a Flow build's heads, or "local build".
395
    pub build: &'static str,
396
    /// The signed-in username, if any.
397
    pub user: Option<String>,
398
    pub is_admin: bool,
399
    pub csrf: String,
400
    pub unread: i64,
401
}
402
403
impl Shell {
404
    /// The version in the stylesheet and script URLs (`statics::assets_version`).
405
    pub fn assets(&self) -> &'static str {
406
        statics::assets_version()
407
    }
408
409
    pub fn new(app: &Shared, path: &str, viewer: &Viewer) -> Shell {
410
        Shell {
411
            site: app.config.site.name.clone(),
412
            base_url: app.config.base_url().to_string(),
413
            path: path.to_string(),
414
            version: env!("CARGO_PKG_VERSION"),
415
            build: env!("OXY_BUILD_ID"),
416
            user: viewer.account().map(|a| a.username.clone()),
417
            is_admin: viewer.is_admin(),
418
            csrf: viewer.csrf().to_string(),
419
            unread: viewer.0.as_ref().map(|v| v.unread).unwrap_or(0),
420
        }
421
    }
422
423
    pub fn anonymous(app: &Shared, path: &str) -> Shell {
424
        Shell::new(app, path, &Viewer(None))
425
    }
426
}
427
428
/// The repository chrome: tabs and counts.
429
#[derive(Clone, Debug)]
430
pub struct RepoShell {
431
    pub owner: String,
432
    pub name: String,
433
    pub url: String,
434
    pub description: String,
435
    pub default_bookmark: String,
436
    pub visibility: String,
437
    pub tab: &'static str,
438
    pub clone_url: String,
439
    /// The viewer's role, for showing settings and write actions.
440
    pub role: Option<Role>,
441
    /// Open issues and proposals, shown on their tabs.
442
    pub open_issues: i64,
443
    pub open_proposals: i64,
444
    /// Read-only (#108).
445
    pub archived: bool,
446
    /// Whether the repository has a wiki (§6.11).
447
    pub wiki: bool,
448
    /// The bucket its data lives in, when not this hub's disk (#96), as
449
    /// the header's provider icon shows it (#123).
450
    pub stored_in: Option<crate::storage::StoreBadge>,
451
    /// Whether it has coverage reports, for the Coverage tab (#113).
452
    pub coverage: bool,
453
    /// Whether it has test reports, for the Tests tab (#114).
454
    pub tests: bool,
455
    /// Whether it has reports of its own (#127); with coverage or tests,
456
    /// the Reports tab.
457
    pub reports: bool,
458
    /// Whether it pins, or is pinned by, another repository here: the
459
    /// Diffusion tab (#150).
460
    pub diffusion: bool,
461
}
462
463
impl RepoShell {
464
    pub fn new(app: &Shared, row: &db::repos::RepoRow, tab: &'static str) -> RepoShell {
465
        RepoShell {
466
            owner: row.owner.clone(),
467
            name: row.name.clone(),
468
            url: format!("/{}/{}", row.owner, row.name),
469
            description: row.description.clone(),
470
            default_bookmark: row.default_bookmark.clone(),
471
            visibility: row.visibility.clone(),
472
            tab,
473
            clone_url: format!("{}/{}/{}", app.config.base_url(), row.owner, row.name),
474
            role: None,
475
            open_issues: row.open_issues,
476
            open_proposals: row.open_proposals,
477
            archived: row.archived,
478
            wiki: crate::repos::RepoName::new(&row.owner, &row.name).is_some_and(|n| app.wikis.exists(&n)),
479
            stored_in: crate::storage::location(app, &row.owner, &row.name).and_then(|u| crate::storage::StoreBadge::of(&u)),
480
            coverage: crate::coverage::has_reports(app, row.id),
481
            tests: crate::junit::has_reports(app, row.id),
482
            reports: crate::reports::has_reports(app, row.id),
483
            diffusion: crate::diffusion::involved(app, row.id),
484
        }
485
    }
486
487
    pub fn with_role(mut self, role: Role) -> RepoShell {
488
        self.role = Some(role);
489
        self
490
    }
491
492
    pub fn can(&self, access: Access) -> bool {
493
        auth::roles::allows(self.role, access)
494
    }
495
496
    pub fn can_maintain(&self) -> bool {
497
        self.can(Access::Maintain)
498
    }
499
}
500
501
/// Render a template as an HTML response.
502
/// One page of a long list: which page, how many, and links that keep
503
/// the rest of the query.
504
#[derive(Clone, Debug)]
505
pub struct Pager {
506
    pub page: usize,
507
    pub pages: usize,
508
    pub total: usize,
509
    /// The query without `page`, each pair encoded, joined with `&`.
510
    query: String,
511
}
512
513
impl Pager {
514
    pub const PER_PAGE: usize = 25;
515
516
    /// `page` counts from 1; out-of-range pages clamp to the last.
517
    pub fn new(total: usize, page: Option<usize>, query: &[(&str, &str)]) -> Pager {
518
        let pages = total.div_ceil(Self::PER_PAGE).max(1);
519
        let page = page.unwrap_or(1).clamp(1, pages);
520
        let query = query
521
            .iter()
522
            .filter(|(_, v)| !v.is_empty())
523
            .map(|(k, v)| format!("{k}={}", settings::urlencode(v).replace('/', "%2F")))
524
            .collect::<Vec<_>>()
525
            .join("&");
526
        Pager { page, pages, total, query }
527
    }
528
529
    /// This page's items.
530
    pub fn slice<T>(&self, all: Vec<T>) -> Vec<T> {
531
        all.into_iter().skip((self.page - 1) * Self::PER_PAGE).take(Self::PER_PAGE).collect()
532
    }
533
534
    pub fn url(&self, page: usize) -> String {
535
        if self.query.is_empty() {
536
            format!("?page={page}")
537
        } else {
538
            format!("?{}&page={page}", self.query)
539
        }
540
    }
541
542
    /// The same query with another sort, back on page one.
543
    pub fn sorted(&self, sort: &str) -> String {
544
        let rest: Vec<&str> = self.query.split('&').filter(|p| !p.is_empty() && !p.starts_with("sort=")).collect();
545
        let mut q = rest.join("&");
546
        if !q.is_empty() {
547
            q.push('&');
548
        }
549
        format!("?{q}sort={sort}")
550
    }
551
}
552
553
pub struct Page<T: Template>(pub T);
554
555
impl<T: Template> IntoResponse for Page<T> {
556
    fn into_response(self) -> Response {
557
        match self.0.render() {
558
            Ok(s) => Html(s).into_response(),
559
            Err(e) => {
560
                tracing::error!("template: {e}");
561
                (StatusCode::INTERNAL_SERVER_ERROR, "template error").into_response()
562
            }
563
        }
564
    }
565
}
566
567
#[derive(Template)]
568
#[template(path = "error.html")]
569
struct ErrorPage {
570
    shell: Shell,
571
    status: u16,
572
    title: String,
573
    detail: String,
574
}
575
576
/// A page-level failure, rendered inside the shell, or a redirect.
577
#[derive(Debug)]
578
pub struct Error {
579
    pub status: StatusCode,
580
    pub detail: String,
581
    shell: Option<Box<Shell>>,
582
    redirect: Option<String>,
583
}
584
585
impl Error {
586
    pub fn redirect(to: String) -> Error {
587
        Error { status: StatusCode::SEE_OTHER, detail: String::new(), shell: None, redirect: Some(to) }
588
    }
589
590
    pub fn not_found(shell: Shell) -> Error {
591
        Error {
592
            status: StatusCode::NOT_FOUND,
593
            detail: "There is nothing at this address.".into(),
594
            shell: Some(Box::new(shell)),
595
            redirect: None,
596
        }
597
    }
598
599
    pub fn bad(shell: Shell, detail: impl Into<String>) -> Error {
600
        Error { status: StatusCode::BAD_REQUEST, detail: detail.into(), shell: Some(Box::new(shell)), redirect: None }
601
    }
602
603
    pub fn from_repo(shell: Shell, e: RepoError) -> Error {
604
        match e {
605
            RepoError::NotFound => Error::not_found(shell),
606
            RepoError::Oxy(oxy_core::repo::RepoError::Msg(m)) => {
607
                Error { status: StatusCode::NOT_FOUND, detail: m, shell: Some(Box::new(shell)), redirect: None }
608
            }
609
            other => {
610
                Error { status: StatusCode::INTERNAL_SERVER_ERROR, detail: other.to_string(), shell: Some(Box::new(shell)), redirect: None }
611
            }
612
        }
613
    }
614
615
    pub fn from_db(shell: Shell, e: sqlx::Error) -> Error {
616
        Error { status: StatusCode::INTERNAL_SERVER_ERROR, detail: e.to_string(), shell: Some(Box::new(shell)), redirect: None }
617
    }
618
}
619
620
impl IntoResponse for Error {
621
    fn into_response(self) -> Response {
622
        if let Some(to) = self.redirect {
623
            return Redirect::to(&to).into_response();
624
        }
625
        let title = match self.status {
626
            StatusCode::NOT_FOUND => "Not found",
627
            StatusCode::BAD_REQUEST => "Bad request",
628
            _ => "Something went wrong",
629
        };
630
        if self.status.is_server_error() {
631
            tracing::error!("{}", self.detail);
632
        }
633
        let shell = self.shell.map(|b| *b).unwrap_or(Shell {
634
            site: "OxygenHub".into(),
635
            base_url: String::new(),
636
            path: String::new(),
637
            version: "",
638
            build: "",
639
            user: None,
640
            is_admin: false,
641
            csrf: String::new(),
642
            unread: 0,
643
        });
644
        let page = ErrorPage { shell, status: self.status.as_u16(), title: title.into(), detail: self.detail };
645
        match page.render() {
646
            Ok(s) => (self.status, Html(s)).into_response(),
647
            Err(_) => (self.status, title).into_response(),
648
        }
649
    }
650
}
651
652
async fn not_found(axum::extract::State(app): axum::extract::State<Shared>, viewer: Viewer, uri: axum::http::Uri) -> Response {
653
    Error::not_found(Shell::new(&app, uri.path(), &viewer)).into_response()
654
}
655
656
/// A raw file response with a safe content type (hub spec §15.2).
657
pub fn raw(bytes: Vec<u8>, name: &str, inline_image: bool) -> Response {
658
    let mime = mime_of(name);
659
    let disposition = if inline_image && mime.starts_with("image/") { "inline" } else { "attachment" };
660
    (
661
        [
662
            (header::CONTENT_TYPE, mime.to_string()),
663
            (header::CONTENT_DISPOSITION, format!("{disposition}; filename=\"{}\"", name.replace('"', ""))),
664
            (header::X_CONTENT_TYPE_OPTIONS, "nosniff".to_string()),
665
        ],
666
        bytes,
667
    )
668
        .into_response()
669
}
670
671
pub fn mime_of(name: &str) -> &'static str {
672
    match name.rsplit('.').next().map(|e| e.to_ascii_lowercase()).as_deref() {
673
        Some("png") => "image/png",
674
        Some("jpg" | "jpeg") => "image/jpeg",
675
        Some("gif") => "image/gif",
676
        Some("webp") => "image/webp",
677
        Some("svg") => "image/svg+xml",
678
        Some("pdf") => "application/pdf",
679
        Some(
680
            "txt" | "md" | "rs" | "toml" | "json" | "yml" | "yaml" | "c" | "h" | "cpp" | "hpp" | "py" | "js" | "ts" | "html" | "css" | "sh",
681
        ) => "text/plain; charset=utf-8",
682
        _ => "application/octet-stream",
683
    }
684
}
685
686
/// Resolve `{owner}/{name}` for the viewer with at least `access`, or 404:
687
/// a repository the viewer may not see does not exist for them (hub spec
688
/// §4.4). Returns the viewer's role too.
689
pub async fn lookup_role(
690
    app: &Shared,
691
    shell: &Shell,
692
    viewer: &Viewer,
693
    owner: &str,
694
    name: &str,
695
    access: Access,
696
) -> Result<(crate::repos::RepoName, db::repos::RepoRow, Role), Error> {
697
    let repo = crate::repos::RepoName::new(owner, name).ok_or_else(|| Error::not_found(shell.clone()))?;
698
    let row = match db::repos::get(&app.db, owner, name).await.map_err(|e| Error::from_db(shell.clone(), e))? {
699
        Some(row) => row,
700
        None => {
701
            // A transferred repository: the old URL goes to the new one (#108),
702
            // the rest of the path kept, when the viewer may see it.
703
            let moved = db::repos::moved_to(&app.db, owner, name).await.map_err(|e| Error::from_db(shell.clone(), e))?;
704
            let Some(moved) = moved else { return Err(Error::not_found(shell.clone())) };
705
            let role = auth::roles::role_for(&app.db, viewer.account(), &moved).await.map_err(|e| Error::from_db(shell.clone(), e))?;
706
            if !auth::roles::allows(role, Access::Read) {
707
                return Err(Error::not_found(shell.clone()));
708
            }
709
            let old = format!("/{owner}/{name}");
710
            let rest = shell.path.strip_prefix(&old).unwrap_or("");
711
            return Err(Error::redirect(format!("/{}/{}{rest}", moved.owner, moved.name)));
712
        }
713
    };
714
    let role = auth::roles::role_for(&app.db, viewer.account(), &row).await.map_err(|e| Error::from_db(shell.clone(), e))?;
715
    if !auth::roles::allows(role, access) {
716
        return Err(Error::not_found(shell.clone()));
717
    }
718
    if row.archived && matches!(access, Access::Write | Access::Maintain) {
719
        return Err(archived(shell));
720
    }
721
    Ok((repo, row, role.unwrap_or(Role::Read)))
722
}
723
724
/// The error for a write to an archived repository (#108).
725
pub fn archived(shell: &Shell) -> Error {
726
    Error::bad(shell.clone(), "This repository is archived and read-only. Its admins can bring it back under Settings › Advanced.")
727
}
728
729
/// Refuse a change to an archived repository, for handlers that open it
730
/// for reading and then write.
731
pub fn writable(row: &db::repos::RepoRow, shell: &Shell) -> Result<(), Error> {
732
    if row.archived {
733
        Err(archived(shell))
734
    } else {
735
        Ok(())
736
    }
737
}
738
739
/// `lookup_role` for reading.
740
pub async fn lookup(
741
    app: &Shared,
742
    shell: &Shell,
743
    viewer: &Viewer,
744
    owner: &str,
745
    name: &str,
746
) -> Result<(crate::repos::RepoName, db::repos::RepoRow, Role), Error> {
747
    lookup_role(app, shell, viewer, owner, name, Access::Read).await
748
}
749
750
/// Fill `account` on change authors whose key is linked to an account.
751
pub async fn attribute(app: &Shared, changes: &mut [&mut crate::repos::view::ChangeView]) {
752
    if changes.is_empty() {
753
        return;
754
    }
755
    let Ok(links) = db::accounts::identity_accounts(&app.db).await else { return };
756
    let map: std::collections::HashMap<String, String> = links.into_iter().collect();
757
    for c in changes.iter_mut() {
758
        if let Some(u) = map.get(&c.author.key) {
759
            c.author.account = Some(u.clone());
760
        }
761
    }
762
}