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