OXYGENHUB
# 8a3334b7a364 oxygenhub / crates / hub / src / web / mod.rs
26.9 KiB · Rust · last changed Admin runner settings: job time limits; each job runs under its own 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))
173 
        .route("/{owner}/{name}/flow/{id}", get(flow::run))
174 
        .route("/{owner}/{name}/flow/{id}/live", get(flow::live))
1edac4b6 Andy McCall ↶ 175 
        .route("/{owner}/{name}/flow/start", post(flow::start))
176 
        .route("/{owner}/{name}/flow/{id}/rerun", post(flow::rerun))
736f6813 Andy McCall ↶ 177 
        .route("/{owner}/{name}/flow/stamp/{r}", get(flow::stamp))
178 
        .route("/{owner}/{name}/flow/at/{r}", get(flow::at))
cc19697f Andy McCall ↶ 179 
        .route("/{owner}/{name}/receipts/{attest}", get(flow::receipt_file))
a3c8288b Andy McCall ↶ 180 
        .route("/{owner}/{name}/flow/{id}/artifacts/{job}/{artifact}", get(flow::artifact_file))
10708ab8 Andy McCall ↶ 181 
        .route("/{owner}/{name}/flow/{id}/artifacts/{job}/{artifact}/attach", post(flow::attach))
3f4b0ea6 Andy McCall ↶ 182 
        .route("/{owner}/{name}/releases", get(releases::list))
183 
        .route("/{owner}/{name}/releases/new", get(releases::new_form).post(releases::create))
184 
        .route("/{owner}/{name}/releases/tag/{*tag}", get(releases::show))
df940d75 Andy McCall ↶ 185 
        .route("/{owner}/{name}/releases/trust/{*tag}", get(release_trust::page))
3f4b0ea6 Andy McCall ↶ 186 
        .route("/{owner}/{name}/releases/edit/{id}", post(releases::edit))
187 
        .route(
188 
            "/{owner}/{name}/releases/upload/{id}",
189 
            post(releases::upload).layer(DefaultBodyLimit::max(app.config.limits.asset_limit.0 as usize + (1 << 20))),
190 
        )
191 
        .route("/{owner}/{name}/asset/{id}/{file}", get(releases::download))
192 
        .route("/{owner}/{name}/archive", get(releases::source_archive))
193 
        .route("/{owner}/{name}/search", get(repo::code_search))
194 
        .route("/{owner}/{name}/info/{*rest}", any(git_info))
195 
        .route("/{owner}/{name}/HEAD", get(git_head))
196 
        .route("/{owner}/{name}/objects/{*rest}", get(git_objects))
197 
        .route("/{owner}/{name}/git-upload-pack", post(git_upload_pack))
198 
        .route("/{owner}/{name}/git-receive-pack", post(git_receive_pack))
199 
        .route("/{owner}/{name}/settings/mirror", post(repo_settings::mirror))
9008bf6c Andy McCall ↶ 200 
        .route("/{owner}/{name}/settings/flow", post(repo_settings::flow))
7974adb0 Andy McCall ↶ 201 
        .route("/{owner}/{name}/settings/runners/token", post(repo_settings::runner_token))
202 
        .route("/{owner}/{name}/settings/runners/{id}/remove", post(repo_settings::runner_remove))
18e381ea Andy McCall ↶ 203 
        .route("/{owner}/{name}/issues", get(issues::list))
204 
        .route("/{owner}/{name}/issues/new", get(issues::new_form).post(issues::create))
205 
        .route("/{owner}/{name}/issue/{number}", get(issues::show))
206 
        .route("/{owner}/{name}/issue/{number}/comment", post(issues::comment))
207 
        .route("/{owner}/{name}/issue/{number}/comment/{id}/delete", post(issues::delete_comment))
208 
        .route("/{owner}/{name}/issue/{number}/edit", post(issues::edit))
209 
        .route("/{owner}/{name}/issue/{number}/state", post(issues::state))
210 
        .route("/{owner}/{name}/issue/{number}/labels", post(issues::set_labels))
211 
        .route("/{owner}/{name}/issue/{number}/assign", post(issues::assign))
212 
        .route("/{owner}/{name}/issue/{number}/milestone", post(issues::set_milestone))
213 
        .route("/{owner}/{name}/issue/{number}/subscribe", post(issues::subscribe))
214 
        .route("/{owner}/{name}/labels", get(issues::labels).post(issues::save_label))
215 
        .route("/{owner}/{name}/milestones", get(issues::milestones).post(issues::save_milestone))
d23464c0 Andy McCall ↶ 216 
        .route("/{owner}/{name}/oxy/v1/{endpoint}", any(crate::protocol::dispatch).layer(DefaultBodyLimit::max(push_limit)))
217 
        .fallback(not_found)
19bb31ff Andy McCall ↶ 218 
        .layer(axum::middleware::from_fn_with_state(app.clone(), same_origin))
d23464c0 Andy McCall ↶ 219 
        .layer(CompressionLayer::new())
220 
        .layer(TraceLayer::new_for_http())
221 
        .with_state(app)
222 
}
223
3f4b0ea6 Andy McCall ↶ 224 
// Git's smart HTTP paths under `/{owner}/{name}.git/`, forwarded to the
225 
// mirror (hub spec §14).
226 
async fn git_info(
227 
    st: axum::extract::State<Shared>,
228 
    axum::extract::Path((o, n, rest)): axum::extract::Path<(String, String, String)>,
229 
    m: axum::http::Method,
230 
    q: axum::extract::RawQuery,
231 
    h: axum::http::HeaderMap,
232 
    b: axum::body::Bytes,
233 
) -> Response {
234 
    crate::mirror::serve(st, axum::extract::Path((o, n, format!("info/{rest}"))), m, q, h, b).await
235 
}
236
237 
async fn git_head(
238 
    st: axum::extract::State<Shared>,
239 
    axum::extract::Path((o, n)): axum::extract::Path<(String, String)>,
240 
    m: axum::http::Method,
241 
    q: axum::extract::RawQuery,
242 
    h: axum::http::HeaderMap,
243 
    b: axum::body::Bytes,
244 
) -> Response {
245 
    crate::mirror::serve(st, axum::extract::Path((o, n, "HEAD".into())), m, q, h, b).await
246 
}
247
248 
async fn git_objects(
249 
    st: axum::extract::State<Shared>,
250 
    axum::extract::Path((o, n, rest)): axum::extract::Path<(String, String, String)>,
251 
    m: axum::http::Method,
252 
    q: axum::extract::RawQuery,
253 
    h: axum::http::HeaderMap,
254 
    b: axum::body::Bytes,
255 
) -> Response {
256 
    crate::mirror::serve(st, axum::extract::Path((o, n, format!("objects/{rest}"))), m, q, h, b).await
257 
}
258
259 
async fn git_upload_pack(
260 
    st: axum::extract::State<Shared>,
261 
    axum::extract::Path((o, n)): axum::extract::Path<(String, String)>,
262 
    m: axum::http::Method,
263 
    q: axum::extract::RawQuery,
264 
    h: axum::http::HeaderMap,
265 
    b: axum::body::Bytes,
266 
) -> Response {
267 
    crate::mirror::serve(st, axum::extract::Path((o, n, "git-upload-pack".into())), m, q, h, b).await
268 
}
269
270 
async fn git_receive_pack(
271 
    st: axum::extract::State<Shared>,
272 
    axum::extract::Path((o, n)): axum::extract::Path<(String, String)>,
273 
    m: axum::http::Method,
274 
    q: axum::extract::RawQuery,
275 
    h: axum::http::HeaderMap,
276 
    b: axum::body::Bytes,
277 
) -> Response {
278 
    crate::mirror::serve(st, axum::extract::Path((o, n, "git-receive-pack".into())), m, q, h, b).await
279 
}
280
19bb31ff Andy McCall ↶ 281 
/// Cross-site form posts are refused (hub spec §15.2): a browser that
282 
/// sends `Origin` or `Sec-Fetch-Site` must name this site. Protocol and
283 
/// API clients send neither.
284 
async fn same_origin(
285 
    axum::extract::State(app): axum::extract::State<Shared>,
286 
    req: axum::extract::Request,
287 
    next: axum::middleware::Next,
288 
) -> Response {
289 
    if req.method() != axum::http::Method::GET && req.method() != axum::http::Method::HEAD {
290 
        let headers = req.headers();
291 
        if headers.get("sec-fetch-site").and_then(|v| v.to_str().ok()) == Some("cross-site") {
292 
            return (StatusCode::FORBIDDEN, "cross-site request refused").into_response();
293 
        }
294 
        if let Some(origin) = headers.get(header::ORIGIN).and_then(|v| v.to_str().ok()) {
295 
            let host_of = |u: &str| u.split("://").nth(1).unwrap_or(u).split('/').next().unwrap_or("").to_ascii_lowercase();
296 
            let request_host = headers.get(header::HOST).and_then(|v| v.to_str().ok()).map(|h| h.to_ascii_lowercase());
297 
            let ok = host_of(origin) == host_of(app.config.base_url()) || request_host.as_deref() == Some(host_of(origin).as_str());
298 
            if !ok && origin != "null" {
299 
                return (StatusCode::FORBIDDEN, "cross-site request refused").into_response();
300 
            }
301 
        }
302 
    }
303 
    next.run(req).await
304 
}
305
d23464c0 Andy McCall ↶ 306 
/// What every page's chrome needs.
307 
#[derive(Clone, Debug)]
308 
pub struct Shell {
309 
    pub site: String,
310 
    pub base_url: String,
311 
    pub path: String,
312 
    pub version: &'static str,
e9bfea8e Andy McCall ↶ 313 
    /// What was built: `oxy describe` at deploy, a Flow build's heads, or "local build".
314 
    pub build: &'static str,
19bb31ff Andy McCall ↶ 315 
    /// The signed-in username, if any.
316 
    pub user: Option<String>,
317 
    pub is_admin: bool,
318 
    pub csrf: String,
18e381ea Andy McCall ↶ 319 
    pub unread: i64,
d23464c0 Andy McCall ↶ 320 
}
321
322 
impl Shell {
19bb31ff Andy McCall ↶ 323 
    pub fn new(app: &Shared, path: &str, viewer: &Viewer) -> Shell {
d23464c0 Andy McCall ↶ 324 
        Shell {
325 
            site: app.config.site.name.clone(),
326 
            base_url: app.config.base_url().to_string(),
327 
            path: path.to_string(),
328 
            version: env!("CARGO_PKG_VERSION"),
e9bfea8e Andy McCall ↶ 329 
            build: env!("OXY_BUILD_ID"),
19bb31ff Andy McCall ↶ 330 
            user: viewer.account().map(|a| a.username.clone()),
331 
            is_admin: viewer.is_admin(),
332 
            csrf: viewer.csrf().to_string(),
18e381ea Andy McCall ↶ 333 
            unread: viewer.0.as_ref().map(|v| v.unread).unwrap_or(0),
d23464c0 Andy McCall ↶ 334 
        }
335 
    }
19bb31ff Andy McCall ↶ 336
337 
    pub fn anonymous(app: &Shared, path: &str) -> Shell {
338 
        Shell::new(app, path, &Viewer(None))
339 
    }
d23464c0 Andy McCall ↶ 340 
}
341
342 
/// The repository chrome: tabs and counts.
343 
#[derive(Clone, Debug)]
344 
pub struct RepoShell {
345 
    pub owner: String,
346 
    pub name: String,
347 
    pub url: String,
348 
    pub description: String,
349 
    pub default_bookmark: String,
350 
    pub visibility: String,
351 
    pub tab: &'static str,
352 
    pub clone_url: String,
19bb31ff Andy McCall ↶ 353 
    /// The viewer's role, for showing settings and write actions.
354 
    pub role: Option<Role>,
1ac84c62 Andy McCall ↶ 355 
    /// Open issues and proposals, shown on their tabs.
356 
    pub open_issues: i64,
357 
    pub open_proposals: i64,
d23464c0 Andy McCall ↶ 358 
}
359
360 
impl RepoShell {
361 
    pub fn new(app: &Shared, row: &db::repos::RepoRow, tab: &'static str) -> RepoShell {
362 
        RepoShell {
363 
            owner: row.owner.clone(),
364 
            name: row.name.clone(),
365 
            url: format!("/{}/{}", row.owner, row.name),
366 
            description: row.description.clone(),
367 
            default_bookmark: row.default_bookmark.clone(),
368 
            visibility: row.visibility.clone(),
369 
            tab,
370 
            clone_url: format!("{}/{}/{}", app.config.base_url(), row.owner, row.name),
19bb31ff Andy McCall ↶ 371 
            role: None,
1ac84c62 Andy McCall ↶ 372 
            open_issues: row.open_issues,
373 
            open_proposals: row.open_proposals,
d23464c0 Andy McCall ↶ 374 
        }
375 
    }
19bb31ff Andy McCall ↶ 376
377 
    pub fn with_role(mut self, role: Role) -> RepoShell {
378 
        self.role = Some(role);
379 
        self
380 
    }
381
382 
    pub fn can(&self, access: Access) -> bool {
383 
        auth::roles::allows(self.role, access)
384 
    }
385
386 
    pub fn can_maintain(&self) -> bool {
387 
        self.can(Access::Maintain)
388 
    }
d23464c0 Andy McCall ↶ 389 
}
390
391 
/// Render a template as an HTML response.
1ac84c62 Andy McCall ↶ 392 
/// One page of a long list: which page, how many, and links that keep
393 
/// the rest of the query.
394 
#[derive(Clone, Debug)]
395 
pub struct Pager {
396 
    pub page: usize,
397 
    pub pages: usize,
398 
    pub total: usize,
399 
    /// The query without `page`, each pair encoded, joined with `&`.
400 
    query: String,
401 
}
402
403 
impl Pager {
404 
    pub const PER_PAGE: usize = 25;
405
406 
    /// `page` counts from 1; out-of-range pages clamp to the last.
407 
    pub fn new(total: usize, page: Option<usize>, query: &[(&str, &str)]) -> Pager {
408 
        let pages = total.div_ceil(Self::PER_PAGE).max(1);
409 
        let page = page.unwrap_or(1).clamp(1, pages);
410 
        let query = query
411 
            .iter()
412 
            .filter(|(_, v)| !v.is_empty())
413 
            .map(|(k, v)| format!("{k}={}", settings::urlencode(v).replace('/', "%2F")))
414 
            .collect::<Vec<_>>()
415 
            .join("&");
416 
        Pager { page, pages, total, query }
417 
    }
418
419 
    /// This page's items.
420 
    pub fn slice<T>(&self, all: Vec<T>) -> Vec<T> {
421 
        all.into_iter().skip((self.page - 1) * Self::PER_PAGE).take(Self::PER_PAGE).collect()
422 
    }
423
424 
    pub fn url(&self, page: usize) -> String {
425 
        if self.query.is_empty() {
426 
            format!("?page={page}")
427 
        } else {
428 
            format!("?{}&page={page}", self.query)
429 
        }
430 
    }
431
432 
    /// The same query with another sort, back on page one.
433 
    pub fn sorted(&self, sort: &str) -> String {
434 
        let rest: Vec<&str> = self.query.split('&').filter(|p| !p.is_empty() && !p.starts_with("sort=")).collect();
435 
        let mut q = rest.join("&");
436 
        if !q.is_empty() {
437 
            q.push('&');
438 
        }
439 
        format!("?{q}sort={sort}")
440 
    }
441 
}
442
d23464c0 Andy McCall ↶ 443 
pub struct Page<T: Template>(pub T);
444
445 
impl<T: Template> IntoResponse for Page<T> {
446 
    fn into_response(self) -> Response {
447 
        match self.0.render() {
448 
            Ok(s) => Html(s).into_response(),
449 
            Err(e) => {
450 
                tracing::error!("template: {e}");
451 
                (StatusCode::INTERNAL_SERVER_ERROR, "template error").into_response()
452 
            }
453 
        }
454 
    }
455 
}
456
457 
#[derive(Template)]
458 
#[template(path = "error.html")]
459 
struct ErrorPage {
460 
    shell: Shell,
461 
    status: u16,
462 
    title: String,
463 
    detail: String,
464 
}
465
19bb31ff Andy McCall ↶ 466 
/// A page-level failure, rendered inside the shell, or a redirect.
d23464c0 Andy McCall ↶ 467 
#[derive(Debug)]
468 
pub struct Error {
469 
    pub status: StatusCode,
470 
    pub detail: String,
19bb31ff Andy McCall ↶ 471 
    shell: Option<Box<Shell>>,
472 
    redirect: Option<String>,
d23464c0 Andy McCall ↶ 473 
}
474
475 
impl Error {
19bb31ff Andy McCall ↶ 476 
    pub fn redirect(to: String) -> Error {
477 
        Error { status: StatusCode::SEE_OTHER, detail: String::new(), shell: None, redirect: Some(to) }
478 
    }
479
d23464c0 Andy McCall ↶ 480 
    pub fn not_found(shell: Shell) -> Error {
19bb31ff Andy McCall ↶ 481 
        Error {
482 
            status: StatusCode::NOT_FOUND,
483 
            detail: "There is nothing at this address.".into(),
484 
            shell: Some(Box::new(shell)),
485 
            redirect: None,
486 
        }
d23464c0 Andy McCall ↶ 487 
    }
488
489 
    pub fn bad(shell: Shell, detail: impl Into<String>) -> Error {
19bb31ff Andy McCall ↶ 490 
        Error { status: StatusCode::BAD_REQUEST, detail: detail.into(), shell: Some(Box::new(shell)), redirect: None }
d23464c0 Andy McCall ↶ 491 
    }
492
493 
    pub fn from_repo(shell: Shell, e: RepoError) -> Error {
494 
        match e {
495 
            RepoError::NotFound => Error::not_found(shell),
19bb31ff Andy McCall ↶ 496 
            RepoError::Oxy(oxy_core::repo::RepoError::Msg(m)) => {
497 
                Error { status: StatusCode::NOT_FOUND, detail: m, shell: Some(Box::new(shell)), redirect: None }
498 
            }
499 
            other => {
500 
                Error { status: StatusCode::INTERNAL_SERVER_ERROR, detail: other.to_string(), shell: Some(Box::new(shell)), redirect: None }
501 
            }
d23464c0 Andy McCall ↶ 502 
        }
503 
    }
504
505 
    pub fn from_db(shell: Shell, e: sqlx::Error) -> Error {
19bb31ff Andy McCall ↶ 506 
        Error { status: StatusCode::INTERNAL_SERVER_ERROR, detail: e.to_string(), shell: Some(Box::new(shell)), redirect: None }
d23464c0 Andy McCall ↶ 507 
    }
508 
}
509
510 
impl IntoResponse for Error {
511 
    fn into_response(self) -> Response {
19bb31ff Andy McCall ↶ 512 
        if let Some(to) = self.redirect {
513 
            return Redirect::to(&to).into_response();
514 
        }
d23464c0 Andy McCall ↶ 515 
        let title = match self.status {
516 
            StatusCode::NOT_FOUND => "Not found",
517 
            StatusCode::BAD_REQUEST => "Bad request",
518 
            _ => "Something went wrong",
519 
        };
520 
        if self.status.is_server_error() {
521 
            tracing::error!("{}", self.detail);
522 
        }
19bb31ff Andy McCall ↶ 523 
        let shell = self.shell.map(|b| *b).unwrap_or(Shell {
8d2caf12 Andy McCall ↶ 524 
            site: "OxygenHub".into(),
19bb31ff Andy McCall ↶ 525 
            base_url: String::new(),
526 
            path: String::new(),
527 
            version: "",
e9bfea8e Andy McCall ↶ 528 
            build: "",
19bb31ff Andy McCall ↶ 529 
            user: None,
530 
            is_admin: false,
531 
            csrf: String::new(),
18e381ea Andy McCall ↶ 532 
            unread: 0,
19bb31ff Andy McCall ↶ 533 
        });
d23464c0 Andy McCall ↶ 534 
        let page = ErrorPage { shell, status: self.status.as_u16(), title: title.into(), detail: self.detail };
535 
        match page.render() {
536 
            Ok(s) => (self.status, Html(s)).into_response(),
537 
            Err(_) => (self.status, title).into_response(),
538 
        }
539 
    }
540 
}
541
19bb31ff Andy McCall ↶ 542 
async fn not_found(axum::extract::State(app): axum::extract::State<Shared>, viewer: Viewer, uri: axum::http::Uri) -> Response {
543 
    Error::not_found(Shell::new(&app, uri.path(), &viewer)).into_response()
d23464c0 Andy McCall ↶ 544 
}
545
546 
/// A raw file response with a safe content type (hub spec §15.2).
547 
pub fn raw(bytes: Vec<u8>, name: &str, inline_image: bool) -> Response {
548 
    let mime = mime_of(name);
549 
    let disposition = if inline_image && mime.starts_with("image/") { "inline" } else { "attachment" };
550 
    (
551 
        [
552 
            (header::CONTENT_TYPE, mime.to_string()),
553 
            (header::CONTENT_DISPOSITION, format!("{disposition}; filename=\"{}\"", name.replace('"', ""))),
554 
            (header::X_CONTENT_TYPE_OPTIONS, "nosniff".to_string()),
555 
        ],
556 
        bytes,
557 
    )
558 
        .into_response()
559 
}
560
561 
pub fn mime_of(name: &str) -> &'static str {
562 
    match name.rsplit('.').next().map(|e| e.to_ascii_lowercase()).as_deref() {
563 
        Some("png") => "image/png",
564 
        Some("jpg" | "jpeg") => "image/jpeg",
565 
        Some("gif") => "image/gif",
566 
        Some("webp") => "image/webp",
567 
        Some("svg") => "image/svg+xml",
568 
        Some("pdf") => "application/pdf",
569 
        Some(
570 
            "txt" | "md" | "rs" | "toml" | "json" | "yml" | "yaml" | "c" | "h" | "cpp" | "hpp" | "py" | "js" | "ts" | "html" | "css" | "sh",
571 
        ) => "text/plain; charset=utf-8",
572 
        _ => "application/octet-stream",
573 
    }
574 
}
575
19bb31ff Andy McCall ↶ 576 
/// Resolve `{owner}/{name}` for the viewer with at least `access`, or 404:
577 
/// a repository the viewer may not see does not exist for them (hub spec
578 
/// §4.4). Returns the viewer's role too.
579 
pub async fn lookup_role(
580 
    app: &Shared,
581 
    shell: &Shell,
582 
    viewer: &Viewer,
583 
    owner: &str,
584 
    name: &str,
585 
    access: Access,
586 
) -> Result<(crate::repos::RepoName, db::repos::RepoRow, Role), Error> {
d23464c0 Andy McCall ↶ 587 
    let repo = crate::repos::RepoName::new(owner, name).ok_or_else(|| Error::not_found(shell.clone()))?;
19bb31ff Andy McCall ↶ 588 
    let row = db::repos::get(&app.db, owner, name)
589 
        .await
590 
        .map_err(|e| Error::from_db(shell.clone(), e))?
591 
        .ok_or_else(|| Error::not_found(shell.clone()))?;
592 
    let role = auth::roles::role_for(&app.db, viewer.account(), &row).await.map_err(|e| Error::from_db(shell.clone(), e))?;
593 
    if !auth::roles::allows(role, access) {
594 
        return Err(Error::not_found(shell.clone()));
595 
    }
596 
    Ok((repo, row, role.unwrap_or(Role::Read)))
597 
}
598
599 
/// `lookup_role` for reading.
600 
pub async fn lookup(
601 
    app: &Shared,
602 
    shell: &Shell,
603 
    viewer: &Viewer,
604 
    owner: &str,
605 
    name: &str,
606 
) -> Result<(crate::repos::RepoName, db::repos::RepoRow, Role), Error> {
607 
    lookup_role(app, shell, viewer, owner, name, Access::Read).await
608 
}
609
610 
/// Fill `account` on change authors whose key is linked to an account.
611 
pub async fn attribute(app: &Shared, changes: &mut [&mut crate::repos::view::ChangeView]) {
612 
    if changes.is_empty() {
613 
        return;
614 
    }
615 
    let Ok(links) = db::accounts::identity_accounts(&app.db).await else { return };
616 
    let map: std::collections::HashMap<String, String> = links.into_iter().collect();
617 
    for c in changes.iter_mut() {
618 
        if let Some(u) = map.get(&c.author.key) {
619 
            c.author.account = Some(u.clone());
620 
        }
d23464c0 Andy McCall ↶ 621 
    }
622 
}