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