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