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