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