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