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