OXYGENHUB
# a10446c68043 oxygenhub / crates / hub / src / web / mod.rs
38.4 KiB · Rust · last changed Live L5: the issue page, the overview and Diffusion (closes #207) 20 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
    /// The repository's row id: its live topics name it (docs/live.md).
463
    pub id: i64,
464
    pub owner: String,
465
    pub name: String,
466
    pub url: String,
467
    pub description: String,
468
    pub default_bookmark: String,
469
    pub visibility: String,
470
    pub tab: &'static str,
471
    pub clone_url: String,
472
    /// The viewer's role, for showing settings and write actions.
473
    pub role: Option<Role>,
474
    /// Open issues and proposals, shown on their tabs.
475
    pub open_issues: i64,
476
    pub open_proposals: i64,
477
    /// Read-only (#108).
478
    pub archived: bool,
479
    /// Whether the repository has a wiki (§6.11).
480
    pub wiki: bool,
481
    /// The bucket its data lives in, when not this hub's disk (#96), as
482
    /// the header's provider icon shows it (#123).
483
    pub stored_in: Option<crate::storage::StoreBadge>,
484
    /// Whether it has coverage reports, for the Coverage tab (#113).
485
    pub coverage: bool,
486
    /// Whether it has test reports, for the Tests tab (#114).
487
    pub tests: bool,
488
    /// Whether it has reports of its own (#127); with coverage or tests,
489
    /// the Reports tab.
490
    pub reports: bool,
491
    /// Whether it pins, or is pinned by, another repository here: the
492
    /// Diffusion tab (#150).
493
    pub diffusion: bool,
494
    /// The backdrop's data, a sky of this repository alone; empty for none
495
    /// (docs/backgrounds.md, oxygenhub#196).
496
    pub backdrop: String,
497
}
498
499
impl RepoShell {
500
    pub fn new(app: &Shared, row: &db::repos::RepoRow, tab: &'static str) -> RepoShell {
501
        RepoShell {
502
            id: row.id,
503
            owner: row.owner.clone(),
504
            name: row.name.clone(),
505
            url: format!("/{}/{}", row.owner, row.name),
506
            description: row.description.clone(),
507
            default_bookmark: row.default_bookmark.clone(),
508
            visibility: row.visibility.clone(),
509
            tab,
510
            clone_url: format!("{}/{}/{}", app.config.base_url(), row.owner, row.name),
511
            role: None,
512
            open_issues: row.open_issues,
513
            open_proposals: row.open_proposals,
514
            archived: row.archived,
515
            wiki: crate::repos::RepoName::new(&row.owner, &row.name).is_some_and(|n| app.wikis.exists(&n)),
516
            stored_in: crate::storage::location(app, &row.owner, &row.name).and_then(|u| crate::storage::StoreBadge::of(&u)),
517
            coverage: crate::coverage::has_reports(app, row.id),
518
            tests: crate::junit::has_reports(app, row.id),
519
            reports: crate::reports::has_reports(app, row.id),
520
            diffusion: crate::diffusion::involved(app, row.id),
521
            backdrop: String::new(),
522
        }
523
    }
524
525
    /// Give the page a backdrop: this repository's sky, its activity of the
526
    /// last 30 days from the database (#196).
527
    pub async fn with_sky(mut self, app: &Shared, row: &db::repos::RepoRow) -> RepoShell {
528
        self.backdrop = home::repo_sky(app, row).await;
529
        self
530
    }
531
532
    /// The repository's live topic (docs/live.md).
533
    pub fn live_topic(&self) -> String {
534
        crate::events::topic::repo(self.id)
535
    }
536
537
    /// Its Diffusion topic: bumps and pills.
538
    pub fn diffusion_topic(&self) -> String {
539
        crate::events::topic::diffusion(self.id)
540
    }
541
542
    pub fn with_role(mut self, role: Role) -> RepoShell {
543
        self.role = Some(role);
544
        self
545
    }
546
547
    pub fn can(&self, access: Access) -> bool {
548
        auth::roles::allows(self.role, access)
549
    }
550
551
    pub fn can_maintain(&self) -> bool {
552
        self.can(Access::Maintain)
553
    }
554
}
555
556
/// Render a template as an HTML response.
557
/// One page of a long list: which page, how many, and links that keep
558
/// the rest of the query.
559
#[derive(Clone, Debug)]
560
pub struct Pager {
561
    pub page: usize,
562
    pub pages: usize,
563
    pub total: usize,
564
    /// The query without `page`, each pair encoded, joined with `&`.
565
    query: String,
566
}
567
568
impl Pager {
569
    pub const PER_PAGE: usize = 25;
570
571
    /// `page` counts from 1; out-of-range pages clamp to the last.
572
    pub fn new(total: usize, page: Option<usize>, query: &[(&str, &str)]) -> Pager {
573
        let pages = total.div_ceil(Self::PER_PAGE).max(1);
574
        let page = page.unwrap_or(1).clamp(1, pages);
575
        let query = query
576
            .iter()
577
            .filter(|(_, v)| !v.is_empty())
578
            .map(|(k, v)| format!("{k}={}", settings::urlencode(v).replace('/', "%2F")))
579
            .collect::<Vec<_>>()
580
            .join("&");
581
        Pager { page, pages, total, query }
582
    }
583
584
    /// This page's items.
585
    pub fn slice<T>(&self, all: Vec<T>) -> Vec<T> {
586
        all.into_iter().skip((self.page - 1) * Self::PER_PAGE).take(Self::PER_PAGE).collect()
587
    }
588
589
    pub fn url(&self, page: usize) -> String {
590
        if self.query.is_empty() {
591
            format!("?page={page}")
592
        } else {
593
            format!("?{}&page={page}", self.query)
594
        }
595
    }
596
597
    /// The same query with another sort, back on page one.
598
    pub fn sorted(&self, sort: &str) -> String {
599
        let rest: Vec<&str> = self.query.split('&').filter(|p| !p.is_empty() && !p.starts_with("sort=")).collect();
600
        let mut q = rest.join("&");
601
        if !q.is_empty() {
602
            q.push('&');
603
        }
604
        format!("?{q}sort={sort}")
605
    }
606
}
607
608
pub struct Page<T: Template>(pub T);
609
610
impl<T: Template> IntoResponse for Page<T> {
611
    fn into_response(self) -> Response {
612
        match self.0.render() {
613
            Ok(s) => Html(s).into_response(),
614
            Err(e) => {
615
                tracing::error!("template: {e}");
616
                (StatusCode::INTERNAL_SERVER_ERROR, "template error").into_response()
617
            }
618
        }
619
    }
620
}
621
622
#[derive(Template)]
623
#[template(path = "error.html")]
624
struct ErrorPage {
625
    shell: Shell,
626
    status: u16,
627
    title: String,
628
    detail: String,
629
}
630
631
/// A page-level failure, rendered inside the shell, or a redirect.
632
#[derive(Debug)]
633
pub struct Error {
634
    pub status: StatusCode,
635
    pub detail: String,
636
    shell: Option<Box<Shell>>,
637
    redirect: Option<String>,
638
}
639
640
impl Error {
641
    pub fn redirect(to: String) -> Error {
642
        Error { status: StatusCode::SEE_OTHER, detail: String::new(), shell: None, redirect: Some(to) }
643
    }
644
645
    pub fn not_found(shell: Shell) -> Error {
646
        Error {
647
            status: StatusCode::NOT_FOUND,
648
            detail: "There is nothing at this address.".into(),
649
            shell: Some(Box::new(shell)),
650
            redirect: None,
651
        }
652
    }
653
654
    pub fn bad(shell: Shell, detail: impl Into<String>) -> Error {
655
        Error { status: StatusCode::BAD_REQUEST, detail: detail.into(), shell: Some(Box::new(shell)), redirect: None }
656
    }
657
658
    pub fn from_repo(shell: Shell, e: RepoError) -> Error {
659
        match e {
660
            RepoError::NotFound => Error::not_found(shell),
661
            RepoError::Oxy(oxy_core::repo::RepoError::Msg(m)) => {
662
                Error { status: StatusCode::NOT_FOUND, detail: m, shell: Some(Box::new(shell)), redirect: None }
663
            }
664
            other => {
665
                Error { status: StatusCode::INTERNAL_SERVER_ERROR, detail: other.to_string(), shell: Some(Box::new(shell)), redirect: None }
666
            }
667
        }
668
    }
669
670
    pub fn from_db(shell: Shell, e: sqlx::Error) -> Error {
671
        Error { status: StatusCode::INTERNAL_SERVER_ERROR, detail: e.to_string(), shell: Some(Box::new(shell)), redirect: None }
672
    }
673
}
674
675
impl IntoResponse for Error {
676
    fn into_response(self) -> Response {
677
        if let Some(to) = self.redirect {
678
            return Redirect::to(&to).into_response();
679
        }
680
        let title = match self.status {
681
            StatusCode::NOT_FOUND => "Not found",
682
            StatusCode::BAD_REQUEST => "Bad request",
683
            _ => "Something went wrong",
684
        };
685
        if self.status.is_server_error() {
686
            tracing::error!("{}", self.detail);
687
        }
688
        let shell = self.shell.map(|b| *b).unwrap_or(Shell {
689
            site: "OxygenHub".into(),
690
            base_url: String::new(),
691
            path: String::new(),
692
            version: "",
693
            build: "",
694
            user: None,
695
            is_admin: false,
696
            csrf: String::new(),
697
            unread: 0,
698
            live_user: String::new(),
699
        });
700
        let page = ErrorPage { shell, status: self.status.as_u16(), title: title.into(), detail: self.detail };
701
        match page.render() {
702
            Ok(s) => (self.status, Html(s)).into_response(),
703
            Err(_) => (self.status, title).into_response(),
704
        }
705
    }
706
}
707
708
async fn not_found(axum::extract::State(app): axum::extract::State<Shared>, viewer: Viewer, uri: axum::http::Uri) -> Response {
709
    Error::not_found(Shell::new(&app, uri.path(), &viewer)).into_response()
710
}
711
712
/// A raw file response with a safe content type (hub spec §15.2).
713
pub fn raw(bytes: Vec<u8>, name: &str, inline_image: bool) -> Response {
714
    let mime = mime_of(name);
715
    let disposition = if inline_image && mime.starts_with("image/") { "inline" } else { "attachment" };
716
    (
717
        [
718
            (header::CONTENT_TYPE, mime.to_string()),
719
            (header::CONTENT_DISPOSITION, format!("{disposition}; filename=\"{}\"", name.replace('"', ""))),
720
            (header::X_CONTENT_TYPE_OPTIONS, "nosniff".to_string()),
721
        ],
722
        bytes,
723
    )
724
        .into_response()
725
}
726
727
pub fn mime_of(name: &str) -> &'static str {
728
    match name.rsplit('.').next().map(|e| e.to_ascii_lowercase()).as_deref() {
729
        Some("png") => "image/png",
730
        Some("jpg" | "jpeg") => "image/jpeg",
731
        Some("gif") => "image/gif",
732
        Some("webp") => "image/webp",
733
        Some("svg") => "image/svg+xml",
734
        Some("pdf") => "application/pdf",
735
        Some(
736
            "txt" | "md" | "rs" | "toml" | "json" | "yml" | "yaml" | "c" | "h" | "cpp" | "hpp" | "py" | "js" | "ts" | "html" | "css" | "sh",
737
        ) => "text/plain; charset=utf-8",
738
        _ => "application/octet-stream",
739
    }
740
}
741
742
/// Resolve `{owner}/{name}` for the viewer with at least `access`, or 404:
743
/// a repository the viewer may not see does not exist for them (hub spec
744
/// §4.4). Returns the viewer's role too.
745
pub async fn lookup_role(
746
    app: &Shared,
747
    shell: &Shell,
748
    viewer: &Viewer,
749
    owner: &str,
750
    name: &str,
751
    access: Access,
752
) -> Result<(crate::repos::RepoName, db::repos::RepoRow, Role), Error> {
753
    let repo = crate::repos::RepoName::new(owner, name).ok_or_else(|| Error::not_found(shell.clone()))?;
754
    let row = match db::repos::get(&app.db, owner, name).await.map_err(|e| Error::from_db(shell.clone(), e))? {
755
        Some(row) => row,
756
        None => {
757
            // A transferred repository: the old URL goes to the new one (#108),
758
            // the rest of the path kept, when the viewer may see it.
759
            let moved = db::repos::moved_to(&app.db, owner, name).await.map_err(|e| Error::from_db(shell.clone(), e))?;
760
            let Some(moved) = moved else { return Err(Error::not_found(shell.clone())) };
761
            let role = auth::roles::role_for(&app.db, viewer.account(), &moved).await.map_err(|e| Error::from_db(shell.clone(), e))?;
762
            if !auth::roles::allows(role, Access::Read) {
763
                return Err(Error::not_found(shell.clone()));
764
            }
765
            let old = format!("/{owner}/{name}");
766
            let rest = shell.path.strip_prefix(&old).unwrap_or("");
767
            return Err(Error::redirect(format!("/{}/{}{rest}", moved.owner, moved.name)));
768
        }
769
    };
770
    let role = auth::roles::role_for(&app.db, viewer.account(), &row).await.map_err(|e| Error::from_db(shell.clone(), e))?;
771
    if !auth::roles::allows(role, access) {
772
        return Err(Error::not_found(shell.clone()));
773
    }
774
    if row.archived && matches!(access, Access::Write | Access::Maintain) {
775
        return Err(archived(shell));
776
    }
777
    Ok((repo, row, role.unwrap_or(Role::Read)))
778
}
779
780
/// The error for a write to an archived repository (#108).
781
pub fn archived(shell: &Shell) -> Error {
782
    Error::bad(shell.clone(), "This repository is archived and read-only. Its admins can bring it back under Settings › Advanced.")
783
}
784
785
/// Refuse a change to an archived repository, for handlers that open it
786
/// for reading and then write.
787
pub fn writable(row: &db::repos::RepoRow, shell: &Shell) -> Result<(), Error> {
788
    if row.archived {
789
        Err(archived(shell))
790
    } else {
791
        Ok(())
792
    }
793
}
794
795
/// `lookup_role` for reading.
796
pub async fn lookup(
797
    app: &Shared,
798
    shell: &Shell,
799
    viewer: &Viewer,
800
    owner: &str,
801
    name: &str,
802
) -> Result<(crate::repos::RepoName, db::repos::RepoRow, Role), Error> {
803
    lookup_role(app, shell, viewer, owner, name, Access::Read).await
804
}
805
806
/// Fill `account` on change authors whose key is linked to an account.
807
pub async fn attribute(app: &Shared, changes: &mut [&mut crate::repos::view::ChangeView]) {
808
    if changes.is_empty() {
809
        return;
810
    }
811
    let Ok(links) = db::accounts::identity_accounts(&app.db).await else { return };
812
    let map: std::collections::HashMap<String, String> = links.into_iter().collect();
813
    for c in changes.iter_mut() {
814
        if let Some(u) = map.get(&c.author.key) {
815
            c.author.account = Some(u.clone());
816
        }
817
    }
818
}
819
820
/// The part of a rendered page between `<!--frag:NAME-->` and
821
/// `<!--/frag:NAME-->` (live pages, docs/live.md): what a page fetches again
822
/// when its topic changes. `None` when the page has no such part.
823
pub fn fragment(html: &str, name: &str) -> Option<String> {
824
    if !name.bytes().all(|b| b.is_ascii_lowercase() || b == b'-') || name.is_empty() {
825
        return None;
826
    }
827
    let open = format!("<!--frag:{name}-->");
828
    let close = format!("<!--/frag:{name}-->");
829
    let start = html.find(&open)? + open.len();
830
    let end = start + html[start..].find(&close)?;
831
    Some(html[start..end].to_string())
832
}
833
834
#[cfg(test)]
835
mod fragment_tests {
836
    #[test]
837
    fn a_fragment_is_cut_from_the_page_by_its_markers() {
838
        let page = "<p>a</p><div data-fragment=\"x\"><!--frag:x--><b>inside</b><!--/frag:x--></div>";
839
        assert_eq!(super::fragment(page, "x").as_deref(), Some("<b>inside</b>"));
840
        assert_eq!(super::fragment(page, "y"), None);
841
        assert_eq!(super::fragment(page, "x--><b"), None, "names are plain");
842
    }
843
}