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