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