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