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