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