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