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