OXYGENHUB
◆ v0.9.23 oxygenhub / crates / hub / src / api / mod.rs
154.0 KiB · Rust · last changed Board columns by API and oh, newest-run watch, close with a comment (closes #366, closes #367, closes #368) 1 day ago source blame history raw
1
//! The JSON API (hub spec §12.1) under `/api/v1`: bearer tokens, RFC 7807
2
//! problems, the same shapes as `oxy --json` where one exists. Reads need
3
//! `repo:read` (anonymous for public repositories); writes the scope named
4
//! on each handler.
5
6
use crate::auth::{self, Access, Role};
7
use crate::db::{self, accounts::Account};
8
use crate::repos::{view, RepoError, RepoName};
9
use crate::Shared;
10
use axum::extract::{Path, Query, State};
11
use axum::http::{HeaderMap, StatusCode};
12
use axum::response::{IntoResponse, Response};
13
use axum::routing::{get, post};
14
use axum::{Json, Router};
15
use hub_api::*;
16
use serde::Deserialize;
17
18
mod approvals;
19
mod attachments;
20
mod backups;
21
pub mod device;
22
pub use attachments::image_type as attachment_image_type;
23
mod drops;
24
mod images;
25
mod projects;
26
mod reports;
27
28
/// Any other path under `/api/v1`: a problem document, not the site's page.
29
/// `GET /api/v1/version`: the hub's version and build, and the Oxygen and
30
/// OxygenFlow library versions it is built on.
31
async fn version() -> Json<serde_json::Value> {
32
    Json(crate::web::home::versions())
33
}
34
35
async fn no_route() -> ApiError {
36
    ApiError(StatusCode::NOT_FOUND, "no such API route".into())
37
}
38
39
/// A known route asked with a method it does not take: a problem body
40
/// rather than axum's empty 405 (oxygenhub#115).
41
async fn wrong_method(method: axum::http::Method, uri: axum::http::Uri) -> ApiError {
42
    ApiError(StatusCode::METHOD_NOT_ALLOWED, format!("{} is an API route, but not for {method}", uri.path()))
43
}
44
45
/// The API, with release assets up to `asset_limit` bytes (the web form's
46
/// limit too; axum's default of 2 MiB refused ordinary builds).
47
pub fn router(asset_limit: usize) -> Router<Shared> {
48
    Router::new()
49
        .fallback(no_route)
50
        .route("/keyless/certify", post(crate::keyless::certify))
51
        .route("/agents/grants", get(crate::keyless::grants_list).post(crate::keyless::grants_create))
52
        .route(
53
            "/repos/{owner}/{name}/terraform/state/{state}",
54
            axum::routing::any(crate::terraform::state)
55
                .layer(axum::extract::DefaultBodyLimit::max(crate::terraform::MAX_STATE_BYTES + 4096)),
56
        )
57
        .route("/repos/{owner}/{name}/terraform/state/{state}/versions", axum::routing::get(crate::terraform::versions))
58
        .route("/repos/{owner}/{name}/terraform/state/{state}/versions/{id}", axum::routing::get(crate::terraform::version))
59
        .route(
60
            "/repos/{owner}/{name}/terraform/state/{state}/versions/{id}/restore",
61
            axum::routing::post(crate::terraform::restore_version),
62
        )
63
        .route("/agents/grants/{id}", axum::routing::delete(crate::keyless::grants_revoke))
64
        .route("/flow/claim", post(crate::flow::claim))
65
        .route("/flow/runners/register", post(crate::flow::register))
66
        .route("/flow/runners/heartbeat", post(crate::flow::heartbeat))
67
        .route("/flow/runner/update", get(crate::flow::runner_update).post(crate::flow::report_update))
68
        .route("/flow/images/missing", post(images::missing).layer(axum::extract::DefaultBodyLimit::max(images::MAX_ASK_BYTES)))
69
        .route("/flow/images/held", post(images::held))
70
        .route("/flow/swarm/announce", post(crate::swarm::announce))
71
        .route("/flow/images/chunks/{hash}", axum::routing::put(images::put_chunk).get(images::get_chunk))
72
        .route(
73
            "/flow/images/{hash}",
74
            axum::routing::put(images::put_manifest).get(images::get_manifest).layer(axum::extract::DefaultBodyLimit::max(64 << 20)),
75
        )
76
        // A runner's manifest of an image only runners hold (oxygenflow#94);
77
        // a 14 GB image's is about 11 MB.
78
        .route("/flow/images/{hash}/held", axum::routing::put(images::put_held).layer(axum::extract::DefaultBodyLimit::max(64 << 20)))
79
        .route("/flow/jobs/{id}/log", post(crate::flow::log))
80
        .route("/flow/jobs/{id}/finish", post(crate::flow::finish))
81
        .route("/flow/jobs/{id}/decline", post(crate::flow::decline))
82
        .route("/flow/jobs/{id}/release", post(crate::flow::release))
83
        .route(
84
            "/flow/jobs/{id}/checkpoint",
85
            post(crate::flow::save_checkpoint)
86
                .get(crate::flow::checkpoint)
87
                .layer(axum::extract::DefaultBodyLimit::max(crate::flow::MAX_ARTIFACT_BYTES + (1 << 20))),
88
        )
89
        .route(
90
            "/flow/jobs/{id}/artifacts/{name}",
91
            post(crate::flow::artifact).layer(axum::extract::DefaultBodyLimit::max(crate::flow::MAX_ARTIFACT_BYTES + (1 << 20))),
92
        )
93
        .route("/flow/jobs/{id}/inputs/{index}", get(crate::flow::input))
94
        .route(
95
            "/flow/jobs/{id}/reports/{name}/files",
96
            post(crate::flow::report_file).layer(axum::extract::DefaultBodyLimit::max(crate::flow::MAX_ARTIFACT_BYTES + (1 << 20))),
97
        )
98
        .route("/projects/{owner}", get(projects::list).post(projects::create))
99
        .route("/projects/{owner}/{number}", get(projects::board).patch(projects::edit))
100
        .route("/projects/{owner}/{number}/cards", get(projects::cards).post(projects::add_card))
101
        .route("/projects/{owner}/{number}/columns", post(projects::add_column))
102
        .route("/projects/{owner}/{number}/columns/{column}", axum::routing::patch(projects::edit_column).delete(projects::remove_column))
103
        .route("/projects/{owner}/{number}/cards/move", post(projects::move_cards))
104
        .route("/projects/{owner}/{number}/cards/archive", post(projects::archive_cards))
105
        .route("/projects/{owner}/{number}/cards/{id}/restore", post(projects::restore_card))
106
        .route("/projects/{owner}/{number}/cards/{id}", axum::routing::patch(projects::move_card).delete(projects::remove_card))
107
        .route("/device/code", post(device::code).delete(device::cancel))
108
        .route("/device/token", post(device::token))
109
        .route("/runners", get(runners))
110
        .route("/runners/queue", get(runner_queue))
111
        .route("/runners/{id}/jobs", get(runner_jobs))
112
        .route("/user", get(me))
113
        .route("/user/repos", get(user_repos))
114
        .route("/user/orgs", get(user_orgs))
115
        .route("/user/proposals", get(user_proposals))
116
        .route("/user/issues", get(user_issues))
117
        .route("/user/authenticators", get(approvals::list).post(approvals::add).delete(approvals::remove))
118
        .route("/user/approvals", get(approvals::pending))
119
        .route("/user/approvals/{id}", post(approvals::answer))
120
        .route("/user/sky", get(user_sky))
121
        .route("/user/starter", get(user_starter))
122
        .route("/user/flow/runs", get(user_flow_runs))
123
        .route("/user/runner-token", post(user_runner_token))
124
        .route("/user/token", axum::routing::delete(revoke_own_token))
125
        .route("/user/push", axum::routing::put(register_push).delete(forget_push))
126
        .route("/version", get(version))
127
        .route("/notifications", get(notifications))
128
        .route("/notifications/read", post(notifications_read_all))
129
        .route("/notifications/{id}/read", post(notification_read))
130
        .route("/users/{name}", get(user))
131
        .route("/users/{name}/drops", get(drops::of_user))
132
        .route("/drops", get(drops::mine).post(drops::create))
133
        .route("/drops/{id}", get(drops::view).patch(drops::edit).delete(drops::delete))
134
        .route("/drops/{id}/fork", post(drops::fork))
135
        .route(
136
            "/repos/{owner}/{name}/attachments",
137
            post(attachments::upload).layer(axum::extract::DefaultBodyLimit::max(attachments::ATTACHMENT_MAX + 4096)),
138
        )
139
        .route("/drops/{id}/star", axum::routing::put(drops::star).delete(drops::unstar))
140
        .route("/drops/{id}/comments", get(drops::comments).post(drops::add_comment))
141
        .route("/drops/{id}/comments/{n}", axum::routing::delete(drops::delete_comment))
142
        .route("/orgs/{name}", get(org))
143
        .route("/search", get(search))
144
        .route("/repos", get(list_repos).post(create_repo))
145
        .route("/repos/{owner}/{name}", get(get_repo))
146
        .route("/repos/{owner}/{name}/bookmarks", get(bookmarks))
147
        .route("/repos/{owner}/{name}/tags", get(tags).post(create_tag))
148
        .route("/repos/{owner}/{name}/tags/{tag}", axum::routing::delete(withdraw_tag))
149
        .route("/repos/{owner}/{name}/consumers", get(consumers))
150
        .route("/repos/{owner}/{name}/diffusion", get(diffusion).put(set_diffusion))
151
        .route("/repos/{owner}/{name}/backup", axum::routing::put(set_backup))
152
        .route("/user/backups", get(backups::user_get).put(backups::user_put))
153
        .route("/user/backups/test", post(backups::user_test))
154
        .route("/user/backups/run", post(backups::user_run))
155
        .route("/user/backups/runs", get(backups::user_runs))
156
        .route("/orgs/{name}/backups", get(backups::org_get).put(backups::org_put))
157
        .route("/orgs/{name}/backups/test", post(backups::org_test))
158
        .route("/orgs/{name}/backups/run", post(backups::org_run))
159
        .route("/orgs/{name}/backups/runs", get(backups::org_runs))
160
        .route("/repos/{owner}/{name}/history/{r}", get(history))
161
        .route("/repos/{owner}/{name}/changes/{hash}", get(change))
162
        .route("/repos/{owner}/{name}/tree/{r}", get(tree_root))
163
        .route("/repos/{owner}/{name}/tree/{r}/{*path}", get(tree))
164
        .route("/repos/{owner}/{name}/file/{r}/{*path}", get(file))
165
        .route("/repos/{owner}/{name}/blame/{r}/{*path}", get(blame))
166
        .route("/repos/{owner}/{name}/conflicts", get(conflicts))
167
        .route("/repos/{owner}/{name}/trust", get(trust))
168
        .route("/repos/{owner}/{name}/releases/trust/{*tag}", get(release_trust))
169
        .route("/repos/{owner}/{name}/pushes", get(pushes))
170
        .route("/repos/{owner}/{name}/proposals", get(proposals).post(create_proposal))
171
        .route("/repos/{owner}/{name}/proposals/{number}", get(proposal).patch(edit_proposal))
172
        .route("/repos/{owner}/{name}/proposals/{number}/land", post(land_proposal))
173
        .route("/repos/{owner}/{name}/proposals/{number}/auto-land", post(auto_land_on).delete(auto_land_off))
174
        .route("/repos/{owner}/{name}/proposals/{number}/comments", get(proposal_comments).post(proposal_comment))
175
        .route("/repos/{owner}/{name}/proposals/{number}/reviews", get(proposal_reviews).post(proposal_review))
176
        .route("/repos/{owner}/{name}/proposals/{number}/reviewers", post(request_reviewers))
177
        .route("/repos/{owner}/{name}/proposals/{number}/review-requests", post(request_assistant))
178
        .route("/repos/{owner}/{name}/proposals/{number}/reviewers/{username}", axum::routing::delete(withdraw_reviewer))
179
        .route("/repos/{owner}/{name}/proposals/{number}/checks", get(proposal_checks))
180
        .route("/repos/{owner}/{name}/proposals/{number}/files", get(proposal_files))
181
        .route("/repos/{owner}/{name}/proposals/{number}/diff", get(proposal_diff))
182
        .route("/repos/{owner}/{name}/proposals/{number}/content/{side}/{*path}", get(proposal_content))
183
        .route("/repos/{owner}/{name}/issues", get(issues).post(create_issue))
184
        .route("/repos/{owner}/{name}/issues/{number}", get(issue).post(issue_state).patch(issue_edit))
185
        .route("/repos/{owner}/{name}/issues/{number}/comments", get(issue_comments).post(issue_comment))
186
        .route("/repos/{owner}/{name}/labels", get(labels).post(create_label))
187
        .route("/repos/{owner}/{name}/labels/{label}", axum::routing::delete(delete_label))
188
        .route("/repos/{owner}/{name}/milestones", get(milestones).post(create_milestone))
189
        .route(
190
            "/repos/{owner}/{name}/coverage",
191
            get(reports::coverage_list)
192
                .post(reports::coverage_upload)
193
                .layer(axum::extract::DefaultBodyLimit::max(crate::coverage::MAX_REPORT + (1 << 20))),
194
        )
195
        .route("/repos/{owner}/{name}/coverage/{id}", get(reports::coverage_one))
196
        .route("/repos/{owner}/{name}/tests", get(reports::tests_list))
197
        .route("/repos/{owner}/{name}/tests/{id}", get(reports::tests_one))
198
        .route("/repos/{owner}/{name}/milestones/{title}", axum::routing::patch(edit_milestone))
199
        .route("/repos/{owner}/{name}/hooks", get(hooks).post(create_hook))
200
        .route("/repos/{owner}/{name}/assistants", get(repo_assistants).post(repo_assistant_put))
201
        .route("/repos/{owner}/{name}/assistants/prompt", get(repo_prompt).put(repo_prompt_put))
202
        .route("/repos/{owner}/{name}/assistants/{assistant}", axum::routing::delete(repo_assistant_delete))
203
        .route("/orgs/{org}/assistants", get(org_assistants).post(org_assistant_put))
204
        .route("/orgs/{org}/assistants/prompt", get(org_prompt).put(org_prompt_put))
205
        .route("/orgs/{org}/assistants/{assistant}", axum::routing::delete(org_assistant_delete))
206
        .route("/admin/runner-updates", get(runner_updates))
207
        .route("/admin/runner-updates/settings", axum::routing::put(runner_update_setting))
208
        .route("/admin/runner-updates/holds/{version}/lift", post(runner_update_lift))
209
        .route("/admin/assistants", get(site_assistants).post(site_assistant_put))
210
        .route("/admin/assistants/prompt", get(site_prompt).put(site_prompt_put))
211
        .route("/admin/assistants/{assistant}", axum::routing::delete(site_assistant_delete))
212
        .route("/repos/{owner}/{name}/hooks/{id}/delete", post(delete_hook))
213
        .route("/repos/{owner}/{name}/checks", post(post_check))
214
        .route("/repos/{owner}/{name}/flow/runs", get(flow_runs).post(start_flow_run))
215
        .route("/repos/{owner}/{name}/flow/runs/{number}", get(flow_run))
216
        .route("/repos/{owner}/{name}/flow/runs/{number}/jobs/{job}/log", get(flow_job_log))
217
        .route("/repos/{owner}/{name}/flow/runs/{number}/jobs/{job}/reports", get(reports::job_reports))
218
        .route("/repos/{owner}/{name}/flow/runs/{number}/jobs/{job}/report", get(reports::job_report_one))
219
        .route("/repos/{owner}/{name}/flow/runs/{number}/jobs/{job}/report/{*path}", get(reports::job_report_file))
220
        .route("/repos/{owner}/{name}/reports", get(reports::latest_reports))
221
        .route("/repos/{owner}/{name}/reports/{report}", get(reports::named_report_one))
222
        .route("/repos/{owner}/{name}/reports/{report}/files/{*path}", get(reports::named_report_file))
223
        .route("/repos/{owner}/{name}/flow/runs/{number}/rerun", post(rerun_flow_run))
224
        .route("/repos/{owner}/{name}/flow/runs/{number}/jobs/{job}/rerun", post(rerun_flow_job))
225
        .route("/repos/{owner}/{name}/flow/runs/{number}/cancel", post(cancel_flow_run))
226
        .route("/repos/{owner}/{name}/deployments", get(list_deployments))
227
        .route("/repos/{owner}/{name}/flow/runs/{number}/expedite", post(expedite_flow_run))
228
        .route("/repos/{owner}/{name}/flow/runs/{number}/jobs/{job}/approve", post(approve_flow_job))
229
        .route("/repos/{owner}/{name}/flow/runs/{number}/jobs/{job}/reject", post(reject_flow_job))
230
        .route("/repos/{owner}/{name}/flow/runs/{number}/jobs/{job}/approval", get(flow_job_statement))
231
        .route("/repos/{owner}/{name}/flow/runs/{number}/jobs/{job}/seal", post(seal_flow_job))
232
        .route("/repos/{owner}/{name}/checks/required", get(required_checks).put(set_required_checks))
233
        .route("/repos/{owner}/{name}/checks/{state}", get(checks_for_state))
234
        .route("/repos/{owner}/{name}/releases", get(releases).post(create_release))
235
        .route("/repos/{owner}/{name}/sky", get(repo_sky))
236
        .route("/repos/{owner}/{name}/starter", get(starter_status).post(start_starter))
237
        .route("/repos/{owner}/{name}/releases/{tag}", axum::routing::patch(edit_release))
238
        .route(
239
            "/repos/{owner}/{name}/releases/{tag}/assets",
240
            post(upload_asset).layer(axum::extract::DefaultBodyLimit::max(asset_limit + (1 << 20))),
241
        )
242
        // Last: it applies to the routes registered before it.
243
        .method_not_allowed_fallback(wrong_method)
244
}
245
246
async fn releases(
247
    State(app): State<Shared>,
248
    headers: HeaderMap,
249
    Path((owner, name)): Path<(String, String)>,
250
) -> Result<Json<Vec<Release>>, ApiError> {
251
    let c = caller(&app, &headers).await?;
252
    let (repo, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
253
    Ok(Json(crate::web::releases::api_views(&app, &repo, &row).await?))
254
}
255
256
/// `GET /repos/{owner}/{name}/sky` (oxygenhub-android#23): the
257
/// repository's sky, its pages' backdrop (#196), in the shape of
258
/// `/user/sky`: the one repository and its events of the last 30 days.
259
async fn repo_sky(
260
    State(app): State<Shared>,
261
    headers: HeaderMap,
262
    Path((owner, name)): Path<(String, String)>,
263
) -> Result<Json<hub_api::UserSky>, ApiError> {
264
    let c = caller(&app, &headers).await?;
265
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
266
    let now = db::now_ms();
267
    let since = now - crate::web::home::SKY_DAYS * 86_400_000;
268
    let events = db::activity::sky(&app.db, &[row.id], since, crate::web::home::SKY_EVENTS).await?;
269
    Ok(Json(hub_api::UserSky {
270
        now,
271
        repos: vec![format!("{}/{}", row.owner, row.name)],
272
        events: events.iter().map(|e| [0, e.kind, e.at_ms, e.n]).collect(),
273
    }))
274
}
275
276
async fn create_release(
277
    State(app): State<Shared>,
278
    headers: HeaderMap,
279
    Path((owner, name)): Path<(String, String)>,
280
    Json(body): Json<NewRelease>,
281
) -> Result<(StatusCode, Json<Release>), ApiError> {
282
    let c = caller(&app, &headers).await?;
283
    let me = c.require("repo:write")?.clone();
284
    let (repo, row, _) = reach(&app, &c, &owner, &name, Access::Write).await?;
285
    crate::web::releases::create_release(&app, &repo, &row, &me, &body.tag, &body.title, body.notes, body.prerelease)
286
        .await
287
        .map_err(|m| ApiError(StatusCode::BAD_REQUEST, m))?;
288
    let r = crate::web::releases::api_views(&app, &repo, &row)
289
        .await?
290
        .into_iter()
291
        .find(|r| r.tag == body.tag)
292
        .ok_or_else(|| not_found("no such release"))?;
293
    Ok((StatusCode::CREATED, Json(r)))
294
}
295
296
/// `PATCH …/releases/{tag}` (oxygenhub#72): change a release's title,
297
/// notes or prerelease flag, as the release page's Edit does.
298
async fn edit_release(
299
    State(app): State<Shared>,
300
    headers: HeaderMap,
301
    Path((owner, name, tag)): Path<(String, String, String)>,
302
    Json(body): Json<ReleaseEdit>,
303
) -> Result<Json<Release>, ApiError> {
304
    let c = caller(&app, &headers).await?;
305
    let me = c.require("repo:write")?.clone();
306
    let (repo, row, _) = reach(&app, &c, &owner, &name, Access::Write).await?;
307
    let r = db::releases::get(&app.db, row.id, &tag).await?.ok_or_else(|| not_found("no such release"))?;
308
    let title = body.title.as_deref().map(str::trim).filter(|t| !t.is_empty()).unwrap_or(&r.title);
309
    let notes = body.notes.as_deref().map(str::trim).unwrap_or(&r.notes);
310
    db::releases::edit(&app.db, r.id, title, notes, body.prerelease.unwrap_or(r.prerelease)).await?;
311
    db::accounts::audit(&app.db, Some(&me), "release.edited", &format!("{owner}/{name}@{tag}"), "").await.ok();
312
    let r = crate::web::releases::api_views(&app, &repo, &row)
313
        .await?
314
        .into_iter()
315
        .find(|r| r.tag == tag)
316
        .ok_or_else(|| not_found("no such release"))?;
317
    Ok(Json(r))
318
}
319
320
#[derive(Deserialize)]
321
struct AssetQuery {
322
    name: String,
323
}
324
325
/// `POST …/releases/{tag}/assets?name=file.tar.gz` with the file as the body.
326
async fn upload_asset(
327
    State(app): State<Shared>,
328
    headers: HeaderMap,
329
    Path((owner, name, tag)): Path<(String, String, String)>,
330
    Query(q): Query<AssetQuery>,
331
    body: axum::body::Bytes,
332
) -> Result<(StatusCode, Json<Release>), ApiError> {
333
    let c = caller(&app, &headers).await?;
334
    c.require("repo:write")?;
335
    let (repo, row, _) = reach(&app, &c, &owner, &name, Access::Write).await?;
336
    let r = db::releases::get(&app.db, row.id, &tag).await?.ok_or_else(|| not_found("no such release"))?;
337
    let ct = headers.get(axum::http::header::CONTENT_TYPE).and_then(|v| v.to_str().ok()).unwrap_or("application/octet-stream").to_string();
338
    crate::web::releases::store_asset(&app, r.id, &q.name, &ct, &body).await.map_err(|m| ApiError(StatusCode::BAD_REQUEST, m))?;
339
    let r = crate::web::releases::api_views(&app, &repo, &row)
340
        .await?
341
        .into_iter()
342
        .find(|r| r.tag == tag)
343
        .ok_or_else(|| not_found("no such release"))?;
344
    Ok((StatusCode::CREATED, Json(r)))
345
}
346
347
pub struct ApiError(pub StatusCode, pub String);
348
349
impl IntoResponse for ApiError {
350
    fn into_response(self) -> Response {
351
        let body = Problem { status: self.0.as_u16(), title: self.0.canonical_reason().unwrap_or("error").into(), detail: self.1 };
352
        (self.0, [("content-type", "application/problem+json")], Json(body)).into_response()
353
    }
354
}
355
356
impl From<RepoError> for ApiError {
357
    fn from(e: RepoError) -> ApiError {
358
        match e {
359
            RepoError::NotFound => not_found("no such repository"),
360
            RepoError::Oxy(oxy_core::repo::RepoError::Msg(m)) => ApiError(StatusCode::NOT_FOUND, m),
361
            other => ApiError(StatusCode::INTERNAL_SERVER_ERROR, other.to_string()),
362
        }
363
    }
364
}
365
366
impl From<sqlx::Error> for ApiError {
367
    fn from(e: sqlx::Error) -> ApiError {
368
        ApiError(StatusCode::INTERNAL_SERVER_ERROR, e.to_string())
369
    }
370
}
371
372
pub(crate) fn not_found(what: &str) -> ApiError {
373
    ApiError(StatusCode::NOT_FOUND, what.into())
374
}
375
376
pub(crate) fn forbidden(what: &str) -> ApiError {
377
    ApiError(StatusCode::FORBIDDEN, what.into())
378
}
379
380
/// The address a request came from: the client's, as the proxy reports
381
/// it when the hub is behind one (`server.behind_proxy`), else the peer's.
382
/// Only an address's characters are kept, so it is safe to show.
383
pub fn client_addr(app: &Shared, headers: &HeaderMap, extensions: &axum::http::Extensions) -> String {
384
    let from_proxy = || {
385
        ["cf-connecting-ip", "x-forwarded-for", "x-real-ip"]
386
            .iter()
387
            .find_map(|h| headers.get(*h).and_then(|v| v.to_str().ok()).and_then(|v| v.split(',').next()).map(|v| v.trim().to_string()))
388
    };
389
    let addr = if app.config.server.behind_proxy {
390
        from_proxy()
391
    } else {
392
        extensions.get::<axum::extract::ConnectInfo<std::net::SocketAddr>>().map(|c| c.0.ip().to_string())
393
    };
394
    addr.map(|a| a.chars().filter(|c| c.is_ascii_hexdigit() || matches!(c, '.' | ':')).take(45).collect()).unwrap_or_default()
395
}
396
397
/// `DELETE /api/v1/user/token`: revoke the token this request is made
398
/// with, as `oxy auth logout` does.
399
async fn revoke_own_token(State(app): State<Shared>, headers: HeaderMap) -> Result<StatusCode, ApiError> {
400
    let c = caller(&app, &headers).await?;
401
    let (Some(account), Some(id)) = (c.account.as_ref(), c.token_id) else {
402
        return Err(ApiError(StatusCode::UNAUTHORIZED, "revoking needs the personal access token to revoke".into()));
403
    };
404
    db::accounts::delete_token(&app.db, account.id, id).await?;
405
    db::accounts::audit(&app.db, Some(account), "token.revoke", &c.token, "").await.ok();
406
    Ok(StatusCode::NO_CONTENT)
407
}
408
409
#[derive(Deserialize)]
410
struct PushRegistration {
411
    /// The phone's Cloud Messaging registration token.
412
    fcm_token: String,
413
    /// The phone's X25519 public key, hex: alerts are sealed to it.
414
    public_key: String,
415
}
416
417
/// `PUT /api/v1/user/push` (oxygenhub-android#16): the phone signed in
418
/// with this token takes alerts, sealed to its key; registering again
419
/// replaces its registration. It ends with the token.
420
async fn register_push(
421
    State(app): State<Shared>,
422
    headers: HeaderMap,
423
    Json(r): Json<PushRegistration>,
424
) -> Result<Json<serde_json::Value>, ApiError> {
425
    let c = caller(&app, &headers).await?;
426
    let (Some(account), Some(id)) = (c.account.as_ref(), c.token_id) else {
427
        return Err(ApiError(StatusCode::UNAUTHORIZED, "a phone registers with the token it signed in with".into()));
428
    };
429
    let key = r.public_key.trim().to_ascii_lowercase();
430
    if key.len() != 64 || hex::decode(&key).is_err() {
431
        return Err(ApiError(StatusCode::BAD_REQUEST, "public_key is 32 bytes of hex".into()));
432
    }
433
    let fcm = r.fcm_token.trim();
434
    if fcm.is_empty() || fcm.len() > 4096 {
435
        return Err(ApiError(StatusCode::BAD_REQUEST, "fcm_token is the phone's registration token".into()));
436
    }
437
    db::push::register(&app.db, id, account.id, fcm, &key).await?;
438
    Ok(Json(serde_json::json!({ "alerts": crate::push::enabled(&app) })))
439
}
440
441
/// `DELETE /api/v1/user/push`: this phone takes no more alerts.
442
async fn forget_push(State(app): State<Shared>, headers: HeaderMap) -> Result<StatusCode, ApiError> {
443
    let c = caller(&app, &headers).await?;
444
    let Some(id) = c.token_id.filter(|_| c.account.is_some()) else {
445
        return Err(ApiError(StatusCode::UNAUTHORIZED, "a phone unregisters with the token it signed in with".into()));
446
    };
447
    db::push::forget(&app.db, id).await?;
448
    Ok(StatusCode::NO_CONTENT)
449
}
450
451
/// Who calls: the account behind a bearer token, with the token's scopes.
452
pub struct Caller {
453
    pub account: Option<Account>,
454
    pub scopes: Vec<String>,
455
    pub site: bool,
456
    /// The token's name, for records of what a call did.
457
    pub token: String,
458
    /// The personal access token's id, when one is used.
459
    pub token_id: Option<i64>,
460
    /// The token is an agent's (oxygenhub#183): what it does says so.
461
    pub agent: bool,
462
}
463
464
impl Caller {
465
    fn has(&self, scope: &str) -> bool {
466
        self.site
467
            || self.scopes.iter().any(|s| {
468
                s == scope
469
                    || (scope == "repo:read" && (s == "repo:write" || s == "repo:admin"))
470
                    || (scope == "repo:write" && s == "repo:admin")
471
            })
472
    }
473
474
    fn require(&self, scope: &str) -> Result<&Account, ApiError> {
475
        // No token is 401, sign in; a token without the scope is 403 (#303).
476
        let Some(account) = self.account.as_ref() else {
477
            return Err(ApiError(StatusCode::UNAUTHORIZED, "a personal access token is required: sign in (`oh auth login`)".into()));
478
        };
479
        if !self.has(scope) {
480
            return Err(forbidden(&format!("this token lacks the {scope} scope")));
481
        }
482
        Ok(account)
483
    }
484
}
485
486
pub async fn caller(app: &Shared, headers: &HeaderMap) -> Result<Caller, ApiError> {
487
    let Some(t) = oxy_server::bearer_token(headers) else {
488
        return Ok(Caller { account: None, scopes: vec![], site: false, token: String::new(), token_id: None, agent: false });
489
    };
490
    if app.config.auth.push_tokens.iter().any(|x| auth::mac_equal(x, t)) {
491
        let admin = db::accounts::accounts(&app.db).await?.into_iter().find(|a| a.is_admin);
492
        return Ok(Caller {
493
            account: admin,
494
            scopes: vec!["repo:admin".into(), "user:read".into(), "checks:write".into()],
495
            site: true,
496
            token: "site token".into(),
497
            token_id: None,
498
            agent: false,
499
        });
500
    }
501
    // An agent's grant token (keyless agents, #241, #253): an agent's token
502
    // of its owner, reading, and writing when the grant lets its keys move
503
    // references, as it is for the protocol.
504
    if t.starts_with(crate::keyless::GRANT_TOKEN_PREFIX) {
505
        let grant = db::accounts::agent_grant_by_token(&app.db, &auth::token_hash(t)).await?.filter(|g| g.live(db::now_ms()));
506
        let Some(g) = grant else {
507
            return Err(ApiError(StatusCode::UNAUTHORIZED, "this agent grant is not valid (revoked, ended or unknown)".into()));
508
        };
509
        let account = db::accounts::account_by_id(&app.db, g.account_id).await?.filter(|a| !a.blocked());
510
        db::accounts::touch_agent_grant(&app.db, g.id).await.ok();
511
        let mut scopes = vec!["repo:read".to_string(), "user:read".to_string()];
512
        if g.scope.split(',').any(|s| s.trim() == "refs") {
513
            scopes.push("repo:write".into());
514
        }
515
        return Ok(Caller { account, scopes, site: false, token: g.agent.clone(), token_id: None, agent: true });
516
    }
517
    let token = db::accounts::token_by_hash(&app.db, &auth::token_hash(t)).await?;
518
    match token {
519
        Some(tok) if !tok.expired(db::now_ms()) => {
520
            let account = db::accounts::account_by_id(&app.db, tok.account_id).await?.filter(|a| !a.blocked());
521
            db::accounts::touch_token(&app.db, tok.id).await.ok();
522
            Ok(Caller {
523
                account,
524
                scopes: tok.scope_list().iter().map(|s| s.to_string()).collect(),
525
                site: false,
526
                token: tok.name.clone(),
527
                token_id: Some(tok.id),
528
                agent: tok.agent,
529
            })
530
        }
531
        _ => Err(ApiError(StatusCode::UNAUTHORIZED, "unknown or expired token".into())),
532
    }
533
}
534
535
fn repository(app: &Shared, r: &db::repos::RepoRow) -> Repository {
536
    Repository {
537
        owner: r.owner.clone(),
538
        name: r.name.clone(),
539
        description: r.description.clone(),
540
        default_bookmark: r.default_bookmark.clone(),
541
        visibility: r.visibility(),
542
        created_ms: r.created_ms,
543
        updated_ms: r.updated_ms,
544
        clone_url: format!("{}/{}/{}", app.config.base_url(), r.owner, r.name),
545
    }
546
}
547
548
/// A repository the caller may reach with `access`, else 404.
549
pub(super) async fn reach(
550
    app: &Shared,
551
    c: &Caller,
552
    owner: &str,
553
    name: &str,
554
    access: Access,
555
) -> Result<(RepoName, db::repos::RepoRow, Role), ApiError> {
556
    // A wiki (`NAME.wiki`) has no row of its own, so no proposals, issues
557
    // or runs (oxygenhub#128): say so to those who may read it, rather than
558
    // that it does not exist.
559
    if let Some(base) = name.strip_suffix(".wiki") {
560
        if let Some(row) = db::repos::get(&app.db, owner, base).await? {
561
            let role = auth::roles::role_for(&app.db, c.account.as_ref(), &row).await?;
562
            if auth::roles::allows(role, Access::Read) {
563
                return Err(not_found(&format!(
564
                    "{owner}/{name} is the wiki of {owner}/{base}: it is cloned and pushed with oxy, and takes no proposals, \
565
                     issues or runs; to publish a bookmark, merge it into main (oxy merge BOOKMARK on main) and push main"
566
                )));
567
            }
568
        }
569
    }
570
    let repo = RepoName::new(owner, name).ok_or_else(|| not_found("no such repository"))?;
571
    let row = db::repos::get(&app.db, owner, name).await?.ok_or_else(|| not_found("no such repository"))?;
572
    // A drop is reached through `/drops` only (#279).
573
    if row.is_drop() {
574
        return Err(not_found("no such repository"));
575
    }
576
    let role = auth::roles::role_for(&app.db, c.account.as_ref(), &row).await?;
577
    if !auth::roles::allows(role, access) {
578
        return Err(not_found("no such repository"));
579
    }
580
    Ok((repo, row, role.unwrap_or(Role::Read)))
581
}
582
583
fn summary(c: &view::ChangeView) -> ChangeSummary {
584
    ChangeSummary {
585
        hash: c.hash.clone(),
586
        message: if c.body.is_empty() { c.title.clone() } else { format!("{}\n\n{}", c.title, c.body) },
587
        author: Author {
588
            name: c.author.name.clone(),
589
            email: c.author.email.clone(),
590
            key: c.author.key.clone(),
591
            account: c.author.account.clone(),
592
            note: Author::note_for(&c.author.key, &c.author.account),
593
        },
594
        when_ms: c.when_ms,
595
        deps: c.deps.clone(),
596
        head: c.head,
597
        via: c.via.as_ref().map(|v| Via {
598
            name: v.name.clone(),
599
            key: v.key.clone(),
600
            scope: v.scope.clone(),
601
            expires_ms: v.expires_ms,
602
            revoked: v.revoked,
603
        }),
604
        signature: match &c.signature {
605
            view::SigView::Unsigned => Signature::Unsigned,
606
            view::SigView::Valid { key, sealed, revoked, .. } => Signature::Valid { key: key.clone(), sealed: *sealed, revoked: *revoked },
607
            view::SigView::Invalid(why) => Signature::Invalid { reason: why.clone() },
608
        },
609
    }
610
}
611
612
// ---------------------------------------------------------------- accounts
613
614
async fn me(State(app): State<Shared>, headers: HeaderMap) -> Result<Json<User>, ApiError> {
615
    let c = caller(&app, &headers).await?;
616
    let a = c.require("user:read")?;
617
    Ok(Json(user_of(&app, a).await?))
618
}
619
620
#[derive(Deserialize)]
621
struct InboxQuery {
622
    #[serde(default)]
623
    limit: Option<i64>,
624
}
625
626
/// The caller's inbox; reading and clearing it needs `user:read`, since
627
/// it touches nothing but the caller's own notifications.
628
async fn notifications(
629
    State(app): State<Shared>,
630
    headers: HeaderMap,
631
    Query(q): Query<InboxQuery>,
632
) -> Result<Json<hub_api::Inbox>, ApiError> {
633
    let c = caller(&app, &headers).await?;
634
    let a = c.require("user:read")?;
635
    let limit = q.limit.unwrap_or(50).clamp(1, 200);
636
    let base = app.config.base_url().trim_end_matches('/').to_string();
637
    let rows = db::notify::inbox(&app.db, a.id, limit).await?;
638
    // Repositories by id, each looked up once (#305).
639
    let mut repos: std::collections::HashMap<i64, Option<String>> = std::collections::HashMap::new();
640
    for id in rows.iter().filter_map(|n| n.repo_id) {
641
        if let std::collections::hash_map::Entry::Vacant(e) = repos.entry(id) {
642
            e.insert(db::repos::get_by_id(&app.db, id).await?.map(|r| format!("{}/{}", r.owner, r.name)));
643
        }
644
    }
645
    let absolute = |u: String| if u.starts_with('/') { format!("{base}{u}") } else { u };
646
    let items = rows
647
        .into_iter()
648
        .map(|n| hub_api::Notification {
649
            id: n.id,
650
            at_ms: n.at_ms,
651
            label: crate::notify::label(&n.kind).map(String::from),
652
            kind: n.kind,
653
            title: n.title,
654
            url: absolute(n.url),
655
            actor: n.actor,
656
            read: n.read,
657
            repository: n.repo_id.and_then(|id| repos.get(&id).cloned().flatten()),
658
            reason: n.reason,
659
            thread: if n.thread.is_empty() { String::new() } else { absolute(n.thread) },
660
        })
661
        .collect();
662
    Ok(Json(hub_api::Inbox { unread: db::notify::unread(&app.db, a.id).await?, items }))
663
}
664
665
async fn notification_read(State(app): State<Shared>, headers: HeaderMap, Path(id): Path<i64>) -> Result<StatusCode, ApiError> {
666
    let c = caller(&app, &headers).await?;
667
    let a = c.require("user:read")?;
668
    db::notify::mark_read(&app.db, a.id, Some(id)).await?;
669
    Ok(StatusCode::NO_CONTENT)
670
}
671
672
async fn notifications_read_all(State(app): State<Shared>, headers: HeaderMap) -> Result<StatusCode, ApiError> {
673
    let c = caller(&app, &headers).await?;
674
    let a = c.require("user:read")?;
675
    db::notify::mark_read(&app.db, a.id, None).await?;
676
    Ok(StatusCode::NO_CONTENT)
677
}
678
679
async fn user_of(app: &Shared, a: &Account) -> Result<User, ApiError> {
680
    let keys = db::accounts::identities_of(&app.db, a.id).await?.into_iter().map(|i| i.key).collect();
681
    Ok(User { username: a.username.clone(), display_name: a.display_name.clone(), is_admin: a.is_admin, keys, created_ms: a.created_ms })
682
}
683
684
async fn user(State(app): State<Shared>, Path(name): Path<String>) -> Result<Json<User>, ApiError> {
685
    let a = db::accounts::account_by_name(&app.db, &name).await?.ok_or_else(|| not_found("no such account"))?;
686
    Ok(Json(user_of(&app, &a).await?))
687
}
688
689
async fn org(State(app): State<Shared>, Path(name): Path<String>) -> Result<Json<Organisation>, ApiError> {
690
    let o = db::accounts::org_by_name(&app.db, &name).await?.ok_or_else(|| not_found("no such organisation"))?;
691
    let members = db::accounts::org_members(&app.db, o.id).await?.into_iter().map(|(a, _)| a.username).collect();
692
    Ok(Json(Organisation { name: o.name, display_name: o.display_name, description: o.description, members }))
693
}
694
695
#[derive(Deserialize)]
696
struct SearchQuery {
697
    q: String,
698
}
699
700
async fn search(
701
    State(app): State<Shared>,
702
    headers: HeaderMap,
703
    Query(q): Query<SearchQuery>,
704
) -> Result<Json<Vec<serde_json::Value>>, ApiError> {
705
    let c = caller(&app, &headers).await?;
706
    let mut out = Vec::new();
707
    for h in db::notify::search(&app.db, &q.q, None, 50).await? {
708
        let Some(row) = db::repos::get_by_id(&app.db, h.repo_id).await? else { continue };
709
        let role = auth::roles::role_for(&app.db, c.account.as_ref(), &row).await?;
710
        if !auth::roles::allows(role, Access::Read) {
711
            continue;
712
        }
713
        out.push(
714
            serde_json::json!({ "kind": h.kind, "repository": row.slug(), "number": h.number, "title": h.title, "snippet": h.snippet }),
715
        );
716
    }
717
    Ok(Json(out))
718
}
719
720
// ------------------------------------------------------------ repositories
721
722
async fn list_repos(State(app): State<Shared>, headers: HeaderMap) -> Result<Json<Vec<Repository>>, ApiError> {
723
    let c = caller(&app, &headers).await?;
724
    let mut out = Vec::new();
725
    for r in db::repos::list(&app.db).await? {
726
        let role = auth::roles::role_for(&app.db, c.account.as_ref(), &r).await?;
727
        if auth::roles::allows(role, Access::Read) {
728
            out.push(repository(&app, &r));
729
        }
730
    }
731
    Ok(Json(out))
732
}
733
734
#[derive(Deserialize)]
735
struct UserReposQuery {
736
    /// Which: `owner`, `organization`, `collaborator`, comma-separated (all three by default).
737
    #[serde(default)]
738
    affiliation: Option<String>,
739
    /// The last `owner/name` of the previous page.
740
    #[serde(default)]
741
    after: Option<String>,
742
    #[serde(default)]
743
    limit: Option<usize>,
744
}
745
746
/// `GET /user/repos` (#302): the caller's repositories, their
747
/// organisations' and those they collaborate on, by `owner/name`, a page
748
/// at a time (`?after=owner/name&limit=`, at most 100, default 50).
749
/// `POST /user/runner-token` (repo:write): a one-time registration token
750
/// for a runner that serves the caller's own repositories and no one
751
/// else's, as a phone registers itself (oxygenhub-android#8). Like the
752
/// settings pages' tokens it lasts a day.
753
async fn user_runner_token(State(app): State<Shared>, headers: HeaderMap) -> Result<(StatusCode, Json<RunnerToken>), ApiError> {
754
    let c = caller(&app, &headers).await?;
755
    let me = c.require("repo:write")?.clone();
756
    let token = format!("flowreg_{}", crate::auth::random_hex(24));
757
    let scope = db::runners::Scope { owner: me.username.clone(), repo_id: None };
758
    db::runners::add_registration(&app.db, &blake3::hash(token.as_bytes()).to_hex(), &me.username, &scope).await?;
759
    db::accounts::audit(&app.db, Some(&me), "flow.runner.token", &me.username, "registration token for the caller's repositories (API)")
760
        .await
761
        .ok();
762
    Ok((StatusCode::CREATED, Json(RunnerToken { token, owner: me.username })))
763
}
764
765
/// `GET /user/issues` (repo:read, #359): the open issues assigned to the
766
/// caller, in repositories it can see, as the dashboard's "Assigned to you".
767
async fn user_issues(State(app): State<Shared>, headers: HeaderMap) -> Result<Json<Vec<IssueBrief>>, ApiError> {
768
    let c = caller(&app, &headers).await?;
769
    let me = c.require("repo:read")?.clone();
770
    let member = db::accounts::visible_repo_ids(&app.db, me.id).await?;
771
    let seen: Vec<i64> = db::repos::list(&app.db)
772
        .await?
773
        .into_iter()
774
        .filter(|r| me.is_admin || r.visibility() != Visibility::Private || member.contains(&r.id))
775
        .map(|r| r.id)
776
        .collect();
777
    let base = app.config.base_url().trim_end_matches('/').to_string();
778
    Ok(Json(
779
        db::activity::assigned(&app.db, me.id, &seen)
780
            .await?
781
            .into_iter()
782
            .map(|i| IssueBrief {
783
                url: format!("{base}/{}/{}/issue/{}", i.owner, i.name, i.number),
784
                repository: format!("{}/{}", i.owner, i.name),
785
                number: i.number,
786
                title: i.title,
787
                updated_ms: i.updated_ms,
788
            })
789
            .collect(),
790
    ))
791
}
792
793
/// `GET /user/proposals` (repo:read): what the dashboard lists, for apps;
794
/// with `?landable=true`, also what the caller can land now (#311).
795
async fn user_proposals(
796
    State(app): State<Shared>,
797
    headers: HeaderMap,
798
    Query(q): Query<UserProposalsQuery>,
799
) -> Result<Json<UserProposals>, ApiError> {
800
    let c = caller(&app, &headers).await?;
801
    let me = c.require("repo:read")?.clone();
802
    // As the dashboard: reviews in repositories the caller belongs to, its
803
    // own proposals in any it can still see.
804
    let member = db::accounts::visible_repo_ids(&app.db, me.id).await?;
805
    let seen: Vec<i64> = db::repos::list(&app.db)
806
        .await?
807
        .into_iter()
808
        .filter(|r| me.is_admin || r.visibility() != Visibility::Private || member.contains(&r.id))
809
        .map(|r| r.id)
810
        .collect();
811
    let base = app.config.base_url().trim_end_matches('/').to_string();
812
    let brief = |p: db::activity::ProposalLine| ProposalBrief {
813
        url: format!("{base}/{}/{}/proposal/{}", p.owner, p.name, p.number),
814
        repository: format!("{}/{}", p.owner, p.name),
815
        number: p.number,
816
        title: p.title,
817
        author: p.author,
818
        state: match p.state.as_str() {
819
            "draft" => ProposalState::Draft,
820
            "landed" => ProposalState::Landed,
821
            "closed" => ProposalState::Closed,
822
            _ => ProposalState::Open,
823
        },
824
        conflicted: p.conflicted,
825
        updated_ms: p.updated_ms,
826
    };
827
    let landable = if q.landable { landable_for(&app, &c, &member, &base).await? } else { Vec::new() };
828
    Ok(Json(UserProposals {
829
        review: db::activity::awaiting_review(&app.db, me.id, &member).await?.into_iter().map(brief).collect(),
830
        authored: db::activity::authored(&app.db, me.id, &seen).await?.into_iter().map(brief).collect(),
831
        landable,
832
    }))
833
}
834
835
/// The open proposals the caller could land now (#311): in repositories
836
/// it belongs to and can write to, whose verdict has no blockers. Each
837
/// projected state is worked out four at a time, as `proposals` does
838
/// (#171); one that cannot be is left out rather than failing the list.
839
async fn landable_for(app: &Shared, c: &Caller, member: &[i64], base: &str) -> Result<Vec<ProposalBrief>, ApiError> {
840
    use futures::StreamExt;
841
    let mut todo = Vec::new();
842
    for row in db::repos::list(&app.db).await?.into_iter().filter(|r| member.contains(&r.id) && !r.is_drop()) {
843
        let role = auth::roles::role_for(&app.db, c.account.as_ref(), &row).await?;
844
        if !auth::roles::allows(role, Access::Write) {
845
            continue;
846
        }
847
        let Some(repo) = RepoName::new(&row.owner, &row.name) else { continue };
848
        for p in db::proposals::list(&app.db, row.id, &["open"]).await? {
849
            todo.push((repo.clone(), row.clone(), p));
850
        }
851
    }
852
    let found: Vec<Option<ProposalBrief>> = futures::stream::iter(todo)
853
        .map(|(repo, row, p)| {
854
            let (app, base) = (app.clone(), base.to_string());
855
            async move {
856
                let (number, title, author, updated_ms) = (p.number, p.title.clone(), p.author.clone(), p.updated_ms);
857
                let loaded = crate::web::proposals::load_summary(&app, &repo, p).await.ok()?;
858
                let v = crate::web::proposals::verdict(&app, &loaded, row.id).await.ok()?;
859
                v.blockers.is_empty().then(|| ProposalBrief {
860
                    url: format!("{base}/{}/{}/proposal/{number}", row.owner, row.name),
861
                    repository: format!("{}/{}", row.owner, row.name),
862
                    number,
863
                    title,
864
                    author,
865
                    state: ProposalState::Open,
866
                    conflicted: loaded.conflicted,
867
                    updated_ms,
868
                })
869
            }
870
        })
871
        .buffered(4)
872
        .collect()
873
        .await;
874
    Ok(found.into_iter().flatten().collect())
875
}
876
877
/// `GET /user/sky` (oxygenhub-android#23): Your sky's data for the app,
878
/// what the web dashboard's backdrop draws: the repositories the caller
879
/// belongs to and may read, and their events of the last 30 days. Only the
880
/// database is read, never a repository's store.
881
async fn user_sky(State(app): State<Shared>, headers: HeaderMap) -> Result<Json<hub_api::UserSky>, ApiError> {
882
    let c = caller(&app, &headers).await?;
883
    let me = c.require("repo:read")?.clone();
884
    let member = db::accounts::visible_repo_ids(&app.db, me.id).await?;
885
    let mut mine = Vec::new();
886
    for r in db::repos::list(&app.db).await? {
887
        if member.contains(&r.id) && auth::roles::allows(auth::roles::role_for(&app.db, Some(&me), &r).await?, Access::Read) {
888
            mine.push(r);
889
        }
890
    }
891
    mine.sort_by_key(|r| std::cmp::Reverse(r.updated_ms));
892
    let ids: Vec<i64> = mine.iter().map(|r| r.id).collect();
893
    let now = db::now_ms();
894
    let since = now - crate::web::home::SKY_DAYS * 86_400_000;
895
    let events = db::activity::sky(&app.db, &ids, since, crate::web::home::SKY_EVENTS).await?;
896
    let events = events.iter().filter_map(|e| Some([ids.iter().position(|&id| id == e.repo_id)? as i64, e.kind, e.at_ms, e.n])).collect();
897
    Ok(Json(hub_api::UserSky { now, repos: mine.iter().map(|r| format!("{}/{}", r.owner, r.name)).collect(), events }))
898
}
899
900
/// `GET /user/flow/runs` (oxygenhub-android#26): the newest runs of the
901
/// repositories the caller belongs to and may read, each with its jobs,
902
/// newest first; `before` pages back by creation time.
903
async fn user_flow_runs(
904
    State(app): State<Shared>,
905
    headers: HeaderMap,
906
    Query(q): Query<hub_api::UserFlowRunsQuery>,
907
) -> Result<Json<Vec<hub_api::UserFlowRun>>, ApiError> {
908
    let c = caller(&app, &headers).await?;
909
    let me = c.require("repo:read")?.clone();
910
    let member = db::accounts::visible_repo_ids(&app.db, me.id).await?;
911
    let mut mine = std::collections::HashMap::new();
912
    for r in db::repos::list(&app.db).await? {
913
        if member.contains(&r.id) && auth::roles::allows(auth::roles::role_for(&app.db, Some(&me), &r).await?, Access::Read) {
914
            mine.insert(r.id, r);
915
        }
916
    }
917
    let ids: Vec<i64> = mine.keys().copied().collect();
918
    let limit = q.limit.unwrap_or(30).clamp(1, 100);
919
    let runs = db::activity::recent_runs(&app.db, &ids, q.before.unwrap_or(i64::MAX), limit).await?;
920
    let queue = if runs.iter().any(|r| r.live()) { db::flow::queue(&app.db).await? } else { vec![] };
921
    let mut out = Vec::with_capacity(runs.len());
922
    for run in &runs {
923
        let Some(row) = mine.get(&run.repo_id) else { continue };
924
        let jobs = db::flow::jobs(&app.db, run.id).await?;
925
        out.push(hub_api::UserFlowRun {
926
            repository: format!("{}/{}", row.owner, row.name),
927
            run: flow_run_of(&app, row, run, jobs, &queue),
928
        });
929
    }
930
    Ok(Json(out))
931
}
932
933
#[derive(Deserialize)]
934
struct StarterQuery {
935
    owner: String,
936
}
937
938
/// `GET /user/starter?owner=X` (#347): the assistants a new repository
939
/// under `owner` may ask for its starting files, when the caller may
940
/// create repositories there.
941
async fn user_starter(
942
    State(app): State<Shared>,
943
    headers: HeaderMap,
944
    Query(q): Query<StarterQuery>,
945
) -> Result<Json<hub_api::StarterAssistants>, ApiError> {
946
    let c = caller(&app, &headers).await?;
947
    let me = c.require("repo:read")?;
948
    if !auth::roles::may_create_under(&app.db, me, q.owner.trim()).await? {
949
        return Ok(Json(hub_api::StarterAssistants { assistants: vec![] }));
950
    }
951
    let found = crate::starter::assistants_for(&app.db, q.owner.trim()).await?;
952
    Ok(Json(hub_api::StarterAssistants {
953
        assistants: found
954
            .into_iter()
955
            .map(|a| hub_api::StarterAssistant {
956
                name: a.assistant.name,
957
                model: a.assistant.model,
958
                from: if a.from.is_empty() { "the site".into() } else { a.from },
959
            })
960
            .collect(),
961
    }))
962
}
963
964
fn starter_status_of(s: Option<crate::starter::State>) -> hub_api::StarterStatus {
965
    use crate::starter::State;
966
    let mut out = hub_api::StarterStatus {
967
        status: "none".into(),
968
        assistant: String::new(),
969
        change: String::new(),
970
        files: vec![],
971
        error: String::new(),
972
    };
973
    match s {
974
        None => {}
975
        Some(State::Running { assistant }) => (out.status, out.assistant) = ("running".into(), assistant),
976
        Some(State::Done { assistant, change, files }) => {
977
            (out.status, out.assistant, out.change, out.files) = ("done".into(), assistant, change, files)
978
        }
979
        Some(State::Failed { assistant, error }) => (out.status, out.assistant, out.error) = ("failed".into(), assistant, error),
980
    }
981
    out
982
}
983
984
/// `GET /repos/{owner}/{name}/starter` (#347): where its starter stands.
985
async fn starter_status(
986
    State(app): State<Shared>,
987
    headers: HeaderMap,
988
    Path((owner, name)): Path<(String, String)>,
989
) -> Result<Json<hub_api::StarterStatus>, ApiError> {
990
    let c = caller(&app, &headers).await?;
991
    let (repo, _, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
992
    Ok(Json(starter_status_of(crate::starter::state(&app, &repo))))
993
}
994
995
/// `POST /repos/{owner}/{name}/starter` (#347): ask an assistant for an
996
/// empty repository's starting files; `202` while it works, then
997
/// `GET …/starter` says how it went.
998
async fn start_starter(
999
    State(app): State<Shared>,
1000
    headers: HeaderMap,
1001
    Path((owner, name)): Path<(String, String)>,
1002
    Json(body): Json<hub_api::StarterRequest>,
1003
) -> Result<(StatusCode, Json<hub_api::StarterStatus>), ApiError> {
1004
    let c = caller(&app, &headers).await?;
1005
    let me = c.require("repo:admin")?.clone();
1006
    let (repo, row, _) = reach(&app, &c, &owner, &name, Access::Admin).await?;
1007
    let description = body.description.trim();
1008
    if description.is_empty() {
1009
        return Err(ApiError(StatusCode::UNPROCESSABLE_ENTITY, "say what the repository is for (description)".into()));
1010
    }
1011
    if description.chars().count() > crate::starter::MAX_DESCRIPTION {
1012
        return Err(ApiError(
1013
            StatusCode::UNPROCESSABLE_ENTITY,
1014
            format!("a description is at most {} characters", crate::starter::MAX_DESCRIPTION),
1015
        ));
1016
    }
1017
    if matches!(crate::starter::state(&app, &repo), Some(crate::starter::State::Running { .. })) {
1018
        return Err(ApiError(StatusCode::CONFLICT, "a starter is being drafted for it already".into()));
1019
    }
1020
    if !crate::starter::is_empty(&app, &repo, &row.default_bookmark).await.map_err(|e| ApiError(StatusCode::INTERNAL_SERVER_ERROR, e))? {
1021
        return Err(ApiError(StatusCode::CONFLICT, "the repository has files already; a starter is only for an empty one".into()));
1022
    }
1023
    let available = crate::starter::assistants_for(&app.db, &row.owner).await?;
1024
    let chosen = match body.assistant.as_deref().map(str::trim).filter(|n| !n.is_empty()) {
1025
        Some(n) => available.into_iter().find(|a| a.assistant.name.eq_ignore_ascii_case(n)),
1026
        None => available.into_iter().next(),
1027
    };
1028
    let Some(a) = chosen else {
1029
        return Err(ApiError(
1030
            StatusCode::UNPROCESSABLE_ENTITY,
1031
            "no assistant is set up for this owner (Admin › Assistants, or the organisation's settings)".into(),
1032
        ));
1033
    };
1034
    if let Err(why) = crate::web::edit::signer_for(&app, me.id).await {
1035
        return Err(ApiError(StatusCode::UNPROCESSABLE_ENTITY, why));
1036
    }
1037
    crate::starter::start(app.clone(), row, me, a.assistant, description.to_string());
1038
    Ok((StatusCode::ACCEPTED, Json(starter_status_of(crate::starter::state(&app, &repo)))))
1039
}
1040
1041
async fn user_repos(
1042
    State(app): State<Shared>,
1043
    headers: HeaderMap,
1044
    Query(q): Query<UserReposQuery>,
1045
) -> Result<Json<Vec<Repository>>, ApiError> {
1046
    let c = caller(&app, &headers).await?;
1047
    let me = c.require("repo:read")?.clone();
1048
    let wanted: Vec<String> = q
1049
        .affiliation
1050
        .as_deref()
1051
        .unwrap_or("owner,organization,collaborator")
1052
        .split(',')
1053
        .map(|s| s.trim().to_ascii_lowercase())
1054
        .filter(|s| !s.is_empty())
1055
        .collect();
1056
    if let Some(bad) = wanted.iter().find(|w| !["owner", "organization", "collaborator"].contains(&w.as_str())) {
1057
        return Err(ApiError(StatusCode::BAD_REQUEST, format!("unknown affiliation {bad:?}: owner, organization or collaborator")));
1058
    }
1059
    let orgs: Vec<String> = db::accounts::orgs_of(&app.db, me.id).await?.into_iter().map(|(o, _)| o.name).collect();
1060
    let limit = q.limit.unwrap_or(50).clamp(1, 100);
1061
    let mut rows = db::repos::list(&app.db).await?;
1062
    rows.sort_by(|a, b| (&a.owner, &a.name).cmp(&(&b.owner, &b.name)));
1063
    let mut out = Vec::new();
1064
    for r in rows {
1065
        if let Some(after) = q.after.as_deref() {
1066
            if format!("{}/{}", r.owner, r.name).as_str() <= after {
1067
                continue;
1068
            }
1069
        }
1070
        let mine = (wanted.iter().any(|w| w == "owner") && r.owner == me.username)
1071
            || (wanted.iter().any(|w| w == "organization") && orgs.contains(&r.owner))
1072
            || (wanted.iter().any(|w| w == "collaborator") && db::accounts::collaborator_role(&app.db, r.id, me.id).await?.is_some());
1073
        if !mine || !auth::roles::allows(auth::roles::role_for(&app.db, Some(&me), &r).await?, Access::Read) {
1074
            continue;
1075
        }
1076
        out.push(repository(&app, &r));
1077
        if out.len() == limit {
1078
            break;
1079
        }
1080
    }
1081
    Ok(Json(out))
1082
}
1083
1084
/// `GET /user/orgs` (#302): the organisations the caller belongs to.
1085
async fn user_orgs(State(app): State<Shared>, headers: HeaderMap) -> Result<Json<Vec<hub_api::UserOrg>>, ApiError> {
1086
    let c = caller(&app, &headers).await?;
1087
    let me = c.require("user:read")?;
1088
    let orgs = db::accounts::orgs_of(&app.db, me.id).await?;
1089
    Ok(Json(orgs.into_iter().map(|(o, role)| hub_api::UserOrg { name: o.name, display_name: o.display_name, role }).collect()))
1090
}
1091
1092
async fn create_repo(
1093
    State(app): State<Shared>,
1094
    headers: HeaderMap,
1095
    Json(body): Json<NewRepository>,
1096
) -> Result<(StatusCode, Json<Repository>), ApiError> {
1097
    let c = caller(&app, &headers).await?;
1098
    let me = c.require("repo:admin")?;
1099
    let name = RepoName::new(&body.owner, &body.name).ok_or_else(|| ApiError(StatusCode::BAD_REQUEST, "invalid owner or name".into()))?;
1100
    if name.name.ends_with(crate::wiki::SUFFIX) {
1101
        return Err(ApiError(StatusCode::BAD_REQUEST, "a name cannot end in .wiki: that is the address of a repository's wiki".into()));
1102
    }
1103
    if !auth::roles::may_create_under(&app.db, me, &name.owner).await? {
1104
        return Err(forbidden("you cannot create repositories under that owner"));
1105
    }
1106
    if db::repos::get(&app.db, &name.owner, &name.name).await?.is_some() || app.repos.exists(&name) {
1107
        return Err(ApiError(StatusCode::CONFLICT, "that repository exists".into()));
1108
    }
1109
    app.repos.create_async(&name, None).await?;
1110
    let row = db::repos::create(&app.db, &name.owner, &name.name, &body.description, body.visibility).await?;
1111
    db::accounts::audit(&app.db, Some(me), "repo.created", &name.to_string(), "api").await.ok();
1112
    Ok((StatusCode::CREATED, Json(repository(&app, &row))))
1113
}
1114
1115
async fn get_repo(
1116
    State(app): State<Shared>,
1117
    headers: HeaderMap,
1118
    Path((owner, name)): Path<(String, String)>,
1119
) -> Result<Json<Repository>, ApiError> {
1120
    let c = caller(&app, &headers).await?;
1121
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1122
    Ok(Json(repository(&app, &row)))
1123
}
1124
1125
async fn bookmarks(
1126
    State(app): State<Shared>,
1127
    headers: HeaderMap,
1128
    Path((owner, name)): Path<(String, String)>,
1129
) -> Result<Json<Vec<Bookmark>>, ApiError> {
1130
    let c = caller(&app, &headers).await?;
1131
    let (repo, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1132
    let default = row.default_bookmark.clone();
1133
    let list = app.repos.read(&repo, move |r, cache| view::bookmarks(r, cache, &default)).await?;
1134
    Ok(Json(list.into_iter().map(|b| Bookmark { name: b.name, heads: b.heads, changes: b.changes, default: b.default }).collect()))
1135
}
1136
1137
#[derive(serde::Deserialize)]
1138
struct BackupSetting {
1139
    /// `owner` (with its owner's), `hourly`, `daily` or `off`.
1140
    backup: String,
1141
}
1142
1143
/// `PUT /repos/{owner}/{name}/backup {"backup": ...}`: this repository's
1144
/// backup (docs/backups.md §5). Owners and admins.
1145
async fn set_backup(
1146
    State(app): State<Shared>,
1147
    headers: HeaderMap,
1148
    Path((owner, name)): Path<(String, String)>,
1149
    Json(b): Json<BackupSetting>,
1150
) -> Result<Json<serde_json::Value>, ApiError> {
1151
    let c = caller(&app, &headers).await?;
1152
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Maintain).await?;
1153
    let setting = match b.backup.as_str() {
1154
        "owner" => "",
1155
        "hourly" | "daily" | "off" => b.backup.as_str(),
1156
        _ => return Err(ApiError(StatusCode::BAD_REQUEST, "backup is owner, hourly, daily or off".into())),
1157
    };
1158
    db::repos::set_backup(&app.db, row.id, setting).await?;
1159
    db::accounts::audit(&app.db, c.account.as_ref(), "repo.backup", &format!("{owner}/{name}"), &b.backup).await.ok();
1160
    Ok(Json(serde_json::json!({ "backup": b.backup })))
1161
}
1162
1163
#[derive(serde::Deserialize)]
1164
struct DiffusionSetting {
1165
    /// `off`, `green`, `any`, or `default` (the site's).
1166
    follow: String,
1167
    /// `auto` or `propose`; absent keeps it as it is.
1168
    #[serde(default)]
1169
    land: Option<String>,
1170
}
1171
1172
/// `PUT /repos/{owner}/{name}/diffusion {"follow": ...}`: whether this
1173
/// repository follows the upstreams it pins (#148). Owners and admins.
1174
async fn set_diffusion(
1175
    State(app): State<Shared>,
1176
    headers: HeaderMap,
1177
    Path((owner, name)): Path<(String, String)>,
1178
    Json(d): Json<DiffusionSetting>,
1179
) -> Result<Json<serde_json::Value>, ApiError> {
1180
    let c = caller(&app, &headers).await?;
1181
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Maintain).await?;
1182
    let setting = match d.follow.as_str() {
1183
        "off" | "green" | "any" => d.follow.as_str(),
1184
        "default" => "",
1185
        _ => return Err(ApiError(StatusCode::BAD_REQUEST, "follow is off, green, any or default".into())),
1186
    };
1187
    let land = match d.land.as_deref() {
1188
        Some(l @ ("auto" | "propose")) => Some(l),
1189
        None => None,
1190
        Some(_) => return Err(ApiError(StatusCode::BAD_REQUEST, "land is auto or propose".into())),
1191
    };
1192
    db::repos::set_diffusion(&app.db, row.id, setting).await?;
1193
    if let Some(l) = land {
1194
        db::repos::set_diffusion_land(&app.db, row.id, l).await?;
1195
    }
1196
    db::accounts::audit(
1197
        &app.db,
1198
        c.account.as_ref(),
1199
        "repo.diffusion",
1200
        &format!("{owner}/{name}"),
1201
        if setting.is_empty() { "default" } else { setting },
1202
    )
1203
    .await
1204
    .ok();
1205
    let row = db::repos::get_by_id(&app.db, row.id).await?.unwrap_or(row);
1206
    let rule = crate::diffusion::rule(&app.config.diffusion.follow, &row, None, "");
1207
    // Turned on: bumped at once to where its upstreams are (#148).
1208
    if rule.follow != crate::diffusion::Follow::Off {
1209
        let (app, row) = (app.clone(), row.clone());
1210
        tokio::spawn(async move { crate::diffusion::catch_up(&app, &row).await });
1211
    }
1212
    if land == Some("auto") {
1213
        let (app, row) = (app.clone(), row.clone());
1214
        tokio::spawn(async move { crate::diffusion::land_ready(&app, &row).await });
1215
    }
1216
    Ok(Json(
1217
        serde_json::json!({ "follow": rule.follow, "from": rule.from, "land": if row.diffusion_land == "auto" { "auto" } else { "propose" } }),
1218
    ))
1219
}
1220
1221
/// `GET /repos/{owner}/{name}/consumers`: the repositories that pin this
1222
/// one as a subrepo and that the caller may read, each with its pin and
1223
/// how far behind this repository's default bookmark it is (#148).
1224
async fn consumers(
1225
    State(app): State<Shared>,
1226
    headers: HeaderMap,
1227
    Path((owner, name)): Path<(String, String)>,
1228
) -> Result<Json<Vec<crate::diffusion::Consumer>>, ApiError> {
1229
    let c = caller(&app, &headers).await?;
1230
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1231
    Ok(Json(crate::diffusion::consumers(&app, &row, c.account.as_ref()).await?))
1232
}
1233
1234
/// `GET /repos/{owner}/{name}/diffusion`: what this repository takes from
1235
/// and what it diffuses to, as its Diffusion tab shows them (#153).
1236
async fn diffusion(
1237
    State(app): State<Shared>,
1238
    headers: HeaderMap,
1239
    Path((owner, name)): Path<(String, String)>,
1240
) -> Result<Json<hub_api::Diffusion>, ApiError> {
1241
    let c = caller(&app, &headers).await?;
1242
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1243
    let slug = format!("{owner}/{name}");
1244
    let takes_from = crate::diffusion::follows(&app, &row, c.account.as_ref())
1245
        .await
1246
        .iter()
1247
        .map(|(up, p)| p.api(&format!("{}/{}", up.owner, up.name)))
1248
        .collect();
1249
    let diffuses_to = crate::diffusion::consumers(&app, &row, c.account.as_ref()).await?.iter().map(|p| p.api(&slug)).collect();
1250
    Ok(Json(hub_api::Diffusion { takes_from, diffuses_to }))
1251
}
1252
1253
async fn tags(
1254
    State(app): State<Shared>,
1255
    headers: HeaderMap,
1256
    Path((owner, name)): Path<(String, String)>,
1257
) -> Result<Json<Vec<Tag>>, ApiError> {
1258
    let c = caller(&app, &headers).await?;
1259
    let (repo, _, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1260
    let list = app.repos.read(&repo, |r, _| view::tags(r)).await?;
1261
    Ok(Json(list.into_iter().map(|t| Tag { name: t.name, heads: t.heads, message: t.message, signer: t.signer }).collect()))
1262
}
1263
1264
/// `POST …/tags` (#295): what the Tags page's Create does.
1265
async fn create_tag(
1266
    State(app): State<Shared>,
1267
    headers: HeaderMap,
1268
    Path((owner, name)): Path<(String, String)>,
1269
    Json(body): Json<NewTag>,
1270
) -> Result<(StatusCode, Json<Tag>), ApiError> {
1271
    let c = caller(&app, &headers).await?;
1272
    let me = c.require("repo:write")?.clone();
1273
    let (repo, row, _) = reach(&app, &c, &owner, &name, Access::Write).await?;
1274
    let made = crate::tags::create(
1275
        &app,
1276
        &row,
1277
        &repo,
1278
        &me,
1279
        &body.name,
1280
        body.target.as_deref().unwrap_or(""),
1281
        body.message.as_deref().unwrap_or(""),
1282
    )
1283
    .await
1284
    .map_err(|m| ApiError(StatusCode::BAD_REQUEST, m))?;
1285
    let t = app
1286
        .repos
1287
        .read(&repo, |r, _| view::tags(r))
1288
        .await?
1289
        .into_iter()
1290
        .find(|t| t.name == made.name)
1291
        .ok_or_else(|| not_found("no such tag"))?;
1292
    Ok((StatusCode::CREATED, Json(Tag { name: t.name, heads: t.heads, message: t.message, signer: t.signer })))
1293
}
1294
1295
#[derive(Deserialize)]
1296
struct WithdrawQuery {
1297
    #[serde(default)]
1298
    reason: String,
1299
}
1300
1301
/// `DELETE …/tags/{tag}?reason=…` (#301): what the Tags page's Withdraw
1302
/// does. Maintainers; refused (409) while a release uses the tag.
1303
async fn withdraw_tag(
1304
    State(app): State<Shared>,
1305
    headers: HeaderMap,
1306
    Path((owner, name, tag)): Path<(String, String, String)>,
1307
    Query(q): Query<WithdrawQuery>,
1308
) -> Result<StatusCode, ApiError> {
1309
    let c = caller(&app, &headers).await?;
1310
    let me = c.require("repo:write")?.clone();
1311
    let (repo, row, _) = reach(&app, &c, &owner, &name, Access::Maintain).await?;
1312
    if db::releases::get(&app.db, row.id, &tag).await?.is_some() {
1313
        return Err(ApiError(StatusCode::CONFLICT, format!("a release uses {tag}: delete the release first")));
1314
    }
1315
    crate::tags::withdraw(&app, &row, &repo, &me, &tag, &q.reason).await.map_err(|m| ApiError(StatusCode::BAD_REQUEST, m))?;
1316
    Ok(StatusCode::NO_CONTENT)
1317
}
1318
1319
#[derive(Deserialize)]
1320
struct HistoryQuery {
1321
    path: Option<String>,
1322
    offset: Option<usize>,
1323
    limit: Option<usize>,
1324
    /// A revset (Oxygen's docs/revset_query_language.md) in place of the
1325
    /// reference's whole history; the reference still gives the labels.
1326
    r: Option<String>,
1327
}
1328
1329
async fn history(
1330
    State(app): State<Shared>,
1331
    headers: HeaderMap,
1332
    Path((owner, name, r)): Path<(String, String, String)>,
1333
    Query(q): Query<HistoryQuery>,
1334
) -> Result<Json<History>, ApiError> {
1335
    let c = caller(&app, &headers).await?;
1336
    let (repo, _, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1337
    let (offset, limit) = (q.offset.unwrap_or(0), q.limit.unwrap_or(50).min(500));
1338
    let revset = q.r.clone().filter(|s| !s.trim().is_empty());
1339
    let by_revset = revset.is_some();
1340
    let h = app
1341
        .repos
1342
        .read(&repo, move |repo, cache| {
1343
            let target = view::resolve(repo, cache, &r)?;
1344
            match &revset {
1345
                Some(rs) => view::history_revset(repo, cache, target, rs, offset, limit),
1346
                None => view::history(repo, cache, target, q.path.as_deref(), offset, limit),
1347
            }
1348
        })
1349
        .await
1350
        .map_err(|e| {
1351
            // A revset that does not parse, names nothing, or goes past the
1352
            // budget is the caller's to fix.
1353
            if by_revset {
1354
                ApiError(StatusCode::BAD_REQUEST, e.to_string())
1355
            } else {
1356
                e.into()
1357
            }
1358
        })?;
1359
    let mut entries = h.entries;
1360
    crate::web::attribute(&app, &mut entries.iter_mut().collect::<Vec<_>>()).await;
1361
    Ok(Json(History {
1362
        reference: h.target.label,
1363
        heads: h.target.heads.iter().map(|x| x.to_hex()).collect(),
1364
        total: h.total,
1365
        offset: h.offset,
1366
        changes: entries.iter().map(summary).collect(),
1367
    }))
1368
}
1369
1370
async fn change(
1371
    State(app): State<Shared>,
1372
    headers: HeaderMap,
1373
    Path((owner, name, hash)): Path<(String, String, String)>,
1374
) -> Result<Json<ChangeDetail>, ApiError> {
1375
    let c = caller(&app, &headers).await?;
1376
    let (repo, _, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1377
    let d = app
1378
        .repos
1379
        .read(&repo, move |repo, cache| {
1380
            let h = view::resolve_change(repo, cache, &hash)?;
1381
            view::change(repo, cache, &h)
1382
        })
1383
        .await?;
1384
    let mut v = d.view;
1385
    crate::web::attribute(&app, &mut [&mut v]).await;
1386
    let files = crate::web::history::render_files(&d.files, &d.bases).into_iter().map(file_change).collect();
1387
    Ok(Json(ChangeDetail {
1388
        body: v.body.clone(),
1389
        change: summary(&v),
1390
        dependents: d.dependents.iter().map(|x| x.hash.clone()).collect(),
1391
        in_bookmarks: d.in_bookmarks,
1392
        in_tags: d.in_tags,
1393
        files,
1394
    }))
1395
}
1396
1397
fn file_change(f: crate::web::history::FileRows) -> FileChange {
1398
    use crate::render::diff::Kind;
1399
    let truncated = f.lines.len() > hub_api::DIFF_LINES;
1400
    let lines = f
1401
        .lines
1402
        .into_iter()
1403
        .take(hub_api::DIFF_LINES)
1404
        .map(|l| DiffLine {
1405
            kind: match l.kind {
1406
                Kind::Context => "context",
1407
                Kind::Add => "add",
1408
                Kind::Del => "del",
1409
                Kind::Gap => "gap",
1410
            }
1411
            .into(),
1412
            old: l.old_no,
1413
            new: l.new_no,
1414
            text: l.text,
1415
        })
1416
        .collect();
1417
    FileChange { path: f.path, kind: f.kind, from: f.from, added: f.added, removed: f.removed, lines, truncated }
1418
}
1419
1420
fn entry(e: &view::Entry) -> TreeEntry {
1421
    TreeEntry {
1422
        name: e.name.clone(),
1423
        path: e.path.clone(),
1424
        kind: match e.kind {
1425
            view::EntryKind::Dir => "dir",
1426
            view::EntryKind::File => "file",
1427
            view::EntryKind::Symlink => "symlink",
1428
            view::EntryKind::Subrepo => "subrepo",
1429
        }
1430
        .into(),
1431
        exec: e.exec,
1432
        size: e.size,
1433
        conflicted: e.conflicted,
1434
    }
1435
}
1436
1437
async fn tree_root(
1438
    State(app): State<Shared>,
1439
    headers: HeaderMap,
1440
    Path((owner, name, r)): Path<(String, String, String)>,
1441
) -> Result<Json<Vec<TreeEntry>>, ApiError> {
1442
    tree(State(app), headers, Path((owner, name, r, String::new()))).await
1443
}
1444
1445
async fn tree(
1446
    State(app): State<Shared>,
1447
    headers: HeaderMap,
1448
    Path((owner, name, r, path)): Path<(String, String, String, String)>,
1449
) -> Result<Json<Vec<TreeEntry>>, ApiError> {
1450
    let c = caller(&app, &headers).await?;
1451
    let (repo, _, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1452
    let t = app
1453
        .repos
1454
        .read(&repo, move |repo, cache| {
1455
            let target = view::resolve(repo, cache, &r)?;
1456
            view::tree(repo, cache, target, &path)
1457
        })
1458
        .await?;
1459
    Ok(Json(t.entries.iter().map(entry).collect()))
1460
}
1461
1462
async fn file(
1463
    State(app): State<Shared>,
1464
    headers: HeaderMap,
1465
    Path((owner, name, r, path)): Path<(String, String, String, String)>,
1466
) -> Result<Response, ApiError> {
1467
    let c = caller(&app, &headers).await?;
1468
    let (repo, _, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1469
    let limit = app.config.limits.render_limit.0;
1470
    let f = app
1471
        .repos
1472
        .read(&repo, move |repo, cache| {
1473
            let target = view::resolve(repo, cache, &r)?;
1474
            view::file(repo, cache, target, &path, limit)
1475
        })
1476
        .await?;
1477
    Ok(crate::web::raw(f.bytes, &f.name, false))
1478
}
1479
1480
async fn blame(
1481
    State(app): State<Shared>,
1482
    headers: HeaderMap,
1483
    Path((owner, name, r, path)): Path<(String, String, String, String)>,
1484
) -> Result<Json<Vec<BlameLine>>, ApiError> {
1485
    let c = caller(&app, &headers).await?;
1486
    let (repo, _, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1487
    let limit = app.config.limits.render_limit.0;
1488
    let b = app
1489
        .repos
1490
        .read(&repo, move |repo, cache| {
1491
            let target = view::resolve(repo, cache, &r)?;
1492
            view::blame(repo, cache, target, &path, limit)
1493
        })
1494
        .await?;
1495
    Ok(Json(
1496
        b.lines
1497
            .into_iter()
1498
            .map(|l| BlameLine {
1499
                line: l.line,
1500
                change: l.hash.to_hex(),
1501
                index: l.index,
1502
                author: l.author,
1503
                when_ms: l.when_ms,
1504
                text: String::from_utf8_lossy(&l.text).into_owned(),
1505
            })
1506
            .collect(),
1507
    ))
1508
}
1509
1510
async fn conflicts(
1511
    State(app): State<Shared>,
1512
    headers: HeaderMap,
1513
    Path((owner, name)): Path<(String, String)>,
1514
) -> Result<Json<Vec<Conflict>>, ApiError> {
1515
    let c = caller(&app, &headers).await?;
1516
    let (repo, _, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1517
    let list = app.repos.read(&repo, view::conflicts).await?;
1518
    Ok(Json(
1519
        list.into_iter()
1520
            .map(|c| Conflict {
1521
                bookmark: c.bookmark,
1522
                path: c.path,
1523
                kind: c.kind,
1524
                contributors: c.contributors.iter().map(|x| x.hash.clone()).collect(),
1525
            })
1526
            .collect(),
1527
    ))
1528
}
1529
1530
/// `GET /repos/{o}/{n}/releases/trust/{tag}`: a release's trust report
1531
/// (hub spec §9.1), as the page's JSON export.
1532
async fn release_trust(
1533
    State(app): State<Shared>,
1534
    headers: HeaderMap,
1535
    Path((owner, name, tag)): Path<(String, String, String)>,
1536
) -> Result<Json<crate::web::release_trust::ReleaseTrust>, ApiError> {
1537
    let c = caller(&app, &headers).await?;
1538
    let (repo, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1539
    match crate::web::release_trust::report(&app, &repo, &row, &tag).await.map_err(|m| ApiError(StatusCode::INTERNAL_SERVER_ERROR, m))? {
1540
        Some(t) => Ok(Json(t)),
1541
        None => Err(ApiError(StatusCode::NOT_FOUND, format!("no release {tag}"))),
1542
    }
1543
}
1544
1545
async fn trust(
1546
    State(app): State<Shared>,
1547
    headers: HeaderMap,
1548
    Path((owner, name)): Path<(String, String)>,
1549
) -> Result<Json<Trust>, ApiError> {
1550
    let c = caller(&app, &headers).await?;
1551
    let (repo, _, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1552
    let key = app.hub_key.key;
1553
    let t = app.repos.read(&repo, move |r, cache| view::trust(r, cache, &key)).await?;
1554
    Ok(Json(Trust {
1555
        policy: t.policy.map(|p| Policy {
1556
            serial: p.serial,
1557
            expires_ms: p.expires_ms,
1558
            roots: p.roots.iter().map(|k| k.key.clone()).collect(),
1559
            root_threshold: p.root_threshold,
1560
            rules: p
1561
                .rules
1562
                .iter()
1563
                .map(|r| Rule {
1564
                    pattern: r.pattern.clone(),
1565
                    keys: r.keys.iter().map(|k| k.key.clone()).collect(),
1566
                    threshold: r.threshold,
1567
                    require: r.require.clone(),
1568
                    allow_conflicts: r.allow_conflicts,
1569
                })
1570
                .collect(),
1571
        }),
1572
        signed: t.verification.signed,
1573
        sealed: t.verification.sealed,
1574
        unsigned: t.verification.unsigned,
1575
        invalid: t.verification.invalid.iter().map(|(h, _)| h.clone()).collect(),
1576
        hub_key: t.hub_key,
1577
    }))
1578
}
1579
1580
async fn pushes(
1581
    State(app): State<Shared>,
1582
    headers: HeaderMap,
1583
    Path((owner, name)): Path<(String, String)>,
1584
) -> Result<Json<Vec<Push>>, ApiError> {
1585
    let c = caller(&app, &headers).await?;
1586
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1587
    let rows = db::repos::pushes(&app.db, row.id, 200).await?;
1588
    Ok(Json(
1589
        rows.into_iter()
1590
            .map(|p| Push {
1591
                at_ms: p.at_ms,
1592
                pusher: p.pusher,
1593
                reference: p.reference,
1594
                ok: p.ok,
1595
                reason: p.reason,
1596
                old_state: p.old_state,
1597
                new_state: p.new_state,
1598
                heads: p.heads,
1599
                changes: p.changes,
1600
            })
1601
            .collect(),
1602
    ))
1603
}
1604
1605
// --------------------------------------------------------------- proposals
1606
1607
/// `GET /repos/{o}/{n}/proposals?state=open|draft|landed|closed|all&limit=N`:
1608
/// open ones (drafts too) by default, newest first, the first `limit` if
1609
/// given (#331).
1610
async fn proposals(
1611
    State(app): State<Shared>,
1612
    headers: HeaderMap,
1613
    Path((owner, name)): Path<(String, String)>,
1614
    Query(q): Query<ProposalsQuery>,
1615
) -> Result<Json<Vec<Proposal>>, ApiError> {
1616
    let c = caller(&app, &headers).await?;
1617
    let (repo, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1618
    let states: &[&str] = match q.state.as_deref().unwrap_or("open") {
1619
        "open" => &["open", "draft"],
1620
        "draft" => &["draft"],
1621
        "landed" => &["landed"],
1622
        "closed" => &["closed"],
1623
        "all" => &["open", "draft", "landed", "closed"],
1624
        other => return Err(ApiError(StatusCode::BAD_REQUEST, format!("state is open, draft, landed, closed or all, not {other:?}"))),
1625
    };
1626
    // Each proposal's projected state is worked out from the store, which
1627
    // for a bucket-backed repository is many slow round trips: four at a
1628
    // time, in order, each under the repository's read lock only. One at
1629
    // a time took 28 s for a repository on GCS (oxygenhub#171). A landed
1630
    // or closed one is as recorded, not projected again (#331).
1631
    use futures::StreamExt;
1632
    let mut rows = db::proposals::list(&app.db, row.id, states).await?;
1633
    if let Some(limit) = q.limit {
1634
        rows.truncate(limit);
1635
    }
1636
    let out: Vec<Result<Proposal, ApiError>> = futures::stream::iter(rows)
1637
        .map(|p| {
1638
            let (app, repo, owner, name, id) = (app.clone(), repo.clone(), owner.clone(), name.clone(), row.id);
1639
            async move {
1640
                let loaded = crate::web::proposals::load_for_api(&app, &repo, p).await?;
1641
                let v = crate::web::proposals::verdict(&app, &loaded, id).await?;
1642
                Ok(crate::web::proposals::to_api(&app, &owner, &name, &loaded, &v, None).await)
1643
            }
1644
        })
1645
        .buffered(4)
1646
        .collect()
1647
        .await;
1648
    Ok(Json(out.into_iter().collect::<Result<Vec<_>, _>>()?))
1649
}
1650
1651
async fn proposal(
1652
    State(app): State<Shared>,
1653
    headers: HeaderMap,
1654
    Path((owner, name, number)): Path<(String, String, i64)>,
1655
) -> Result<Json<Proposal>, ApiError> {
1656
    let c = caller(&app, &headers).await?;
1657
    let (repo, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1658
    let p = db::proposals::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such proposal"))?;
1659
    let source_url = match p.source_repo_id {
1660
        Some(id) => db::repos::get_by_id(&app.db, id).await?.map(|r| format!("{}/{}", app.config.base_url(), r.slug())),
1661
        None => None,
1662
    };
1663
    let loaded = crate::web::proposals::load_for_api(&app, &repo, p).await?;
1664
    let v = crate::web::proposals::verdict(&app, &loaded, row.id).await?;
1665
    Ok(Json(crate::web::proposals::to_api(&app, &owner, &name, &loaded, &v, source_url).await))
1666
}
1667
1668
/// `PATCH /repos/{o}/{n}/proposals/{number}`: change the title or body,
1669
/// keeping what is not given; the author or a maintainer, as on the page
1670
/// (oxygenhub#76). The target is changed on the page, which re-projects.
1671
async fn edit_proposal(
1672
    State(app): State<Shared>,
1673
    headers: HeaderMap,
1674
    Path((owner, name, number)): Path<(String, String, i64)>,
1675
    Json(body): Json<hub_api::ProposalEdit>,
1676
) -> Result<Json<Proposal>, ApiError> {
1677
    let c = caller(&app, &headers).await?;
1678
    let me = c.require("proposals:write").or_else(|_| c.require("repo:write"))?.clone();
1679
    let (repo, row, role) = reach(&app, &c, &owner, &name, Access::Read).await?;
1680
    let p = db::proposals::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such proposal"))?;
1681
    let text = body.title.is_some() || body.body.is_some();
1682
    if text && Some(me.id) != p.author_id && role < Role::Maintain {
1683
        return Err(ApiError(StatusCode::FORBIDDEN, "only the proposal's author or a maintainer can edit it".into()));
1684
    }
1685
    if body.labels.is_some() && role < Role::Triage {
1686
        return Err(forbidden("setting labels needs triage access"));
1687
    }
1688
    // Every name is checked before anything changes.
1689
    let labels = resolve_triage(&app, row.id, body.labels.as_deref(), None, None).await?.labels;
1690
    if text {
1691
        let title = match body.title.as_deref().map(str::trim) {
1692
            Some("") => return Err(ApiError(StatusCode::BAD_REQUEST, "a proposal needs a title".into())),
1693
            Some(t) => t,
1694
            None => p.title.as_str(),
1695
        };
1696
        let text = body.body.as_deref().map(str::trim).unwrap_or(&p.body);
1697
        db::proposals::edit(&app.db, p.id, title, text, &p.target).await?;
1698
        db::proposals::add_event(&app.db, p.id, &me.username, "edited", "").await.ok();
1699
    }
1700
    if let Some(want) = labels {
1701
        let have = db::issues::proposal_labels(&app.db, p.id).await?;
1702
        for l in &have {
1703
            if !want.iter().any(|w| w.id == l.id) {
1704
                db::issues::set_proposal_label(&app.db, p.id, l.id, false).await?;
1705
            }
1706
        }
1707
        for w in &want {
1708
            if !have.iter().any(|l| l.id == w.id) {
1709
                db::issues::set_proposal_label(&app.db, p.id, w.id, true).await?;
1710
            }
1711
        }
1712
        let names: Vec<&str> = want.iter().map(|l| l.name.as_str()).collect();
1713
        db::proposals::add_event(&app.db, p.id, &me.username, "set labels", &names.join(", ")).await.ok();
1714
    }
1715
    // `draft` says the same as `state`, in the words of creation (#313).
1716
    let want = match (body.state.as_deref(), body.draft) {
1717
        (Some(s), Some(d)) if (s == "draft") != d => {
1718
            return Err(ApiError(StatusCode::BAD_REQUEST, format!("state {s:?} and draft {d} disagree")));
1719
        }
1720
        (Some(s), _) => Some(s),
1721
        (None, Some(true)) => Some("draft"),
1722
        (None, Some(false)) => Some("open"),
1723
        (None, None) => None,
1724
    };
1725
    if let Some(want) = want {
1726
        if Some(me.id) != p.author_id && role < Role::Triage {
1727
            return Err(ApiError(
1728
                StatusCode::FORBIDDEN,
1729
                "only the proposal's author or someone with triage access can close, reopen or change whether it is a draft".into(),
1730
            ));
1731
        }
1732
        // The page's transitions: a draft is made ready (open), and an open
1733
        // proposal turned back into a draft.
1734
        let new_state = match (want, p.state.as_str()) {
1735
            ("closed", "open" | "draft") => "closed",
1736
            ("open", "closed" | "draft") => "open",
1737
            ("draft", "open") => "draft",
1738
            (w, now) if w == now => now,
1739
            ("closed" | "open" | "draft", now) => {
1740
                return Err(ApiError(StatusCode::CONFLICT, format!("a proposal that is {now} cannot become {want}")))
1741
            }
1742
            _ => return Err(ApiError(StatusCode::BAD_REQUEST, "state is closed, open or draft".into())),
1743
        };
1744
        if new_state != p.state {
1745
            db::proposals::set_state(&app.db, p.id, new_state, "").await?;
1746
            db::proposals::add_event(&app.db, p.id, &me.username, new_state, "").await.ok();
1747
            crate::hooks::emit(&app, &row, &format!("proposal.{new_state}"), &me.username, serde_json::json!({ "number": number })).await;
1748
        }
1749
    }
1750
    let p = db::proposals::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such proposal"))?;
1751
    let source_url = match p.source_repo_id {
1752
        Some(id) => db::repos::get_by_id(&app.db, id).await?.map(|r| format!("{}/{}", app.config.base_url(), r.slug())),
1753
        None => None,
1754
    };
1755
    let loaded = crate::web::proposals::load_for_api(&app, &repo, p).await?;
1756
    let v = crate::web::proposals::verdict(&app, &loaded, row.id).await?;
1757
    Ok(Json(crate::web::proposals::to_api(&app, &owner, &name, &loaded, &v, source_url).await))
1758
}
1759
1760
/// `POST /repos/{o}/{n}/proposals/{number}/land` (repo:write): land it as
1761
/// the page's Land button does; `409` with the blockers when it cannot.
1762
/// `{"over_checks": "reason"}` lands over required checks that have not
1763
/// passed, for maintainers (#261).
1764
async fn land_proposal(
1765
    State(app): State<Shared>,
1766
    headers: HeaderMap,
1767
    Path((owner, name, number)): Path<(String, String, i64)>,
1768
    body: axum::body::Bytes,
1769
) -> Result<Json<Proposal>, ApiError> {
1770
    let c = caller(&app, &headers).await?;
1771
    let me = c.require("repo:write")?.clone();
1772
    let over_checks: Option<String> = if body.iter().all(u8::is_ascii_whitespace) {
1773
        None
1774
    } else {
1775
        serde_json::from_slice::<serde_json::Value>(&body)
1776
            .map_err(|_| ApiError(StatusCode::BAD_REQUEST, "the body is JSON: {} or {\"over_checks\": \"reason\"}".into()))?
1777
            .get("over_checks")
1778
            .and_then(|v| v.as_str())
1779
            .map(String::from)
1780
    };
1781
    let need = if over_checks.is_some() { Access::Maintain } else { Access::Write };
1782
    let (repo, row, _) = reach(&app, &c, &owner, &name, need).await?;
1783
    let via = format!("api (token {})", c.token);
1784
    match crate::web::proposals::land_as(&app, &repo, &row, &me, number, &via, false, over_checks.as_deref()).await {
1785
        Ok(_) => proposal(State(app), headers, Path((owner, name, number))).await,
1786
        Err(crate::web::proposals::Landing::NotFound) => Err(not_found("no such proposal")),
1787
        Err(crate::web::proposals::Landing::Refused(m)) => Err(ApiError(StatusCode::CONFLICT, m)),
1788
    }
1789
}
1790
1791
/// `POST /repos/{o}/{n}/proposals/{number}/auto-land` (repo:write, #261):
1792
/// land it when its checks pass; at once if they already have.
1793
async fn auto_land_on(
1794
    State(app): State<Shared>,
1795
    headers: HeaderMap,
1796
    Path((owner, name, number)): Path<(String, String, i64)>,
1797
) -> Result<Json<Proposal>, ApiError> {
1798
    auto_land_set(&app, &headers, &owner, &name, number, true).await?;
1799
    proposal(State(app), headers, Path((owner, name, number))).await
1800
}
1801
1802
/// `DELETE …/auto-land`: it will not land by itself.
1803
async fn auto_land_off(
1804
    State(app): State<Shared>,
1805
    headers: HeaderMap,
1806
    Path((owner, name, number)): Path<(String, String, i64)>,
1807
) -> Result<Json<Proposal>, ApiError> {
1808
    auto_land_set(&app, &headers, &owner, &name, number, false).await?;
1809
    proposal(State(app), headers, Path((owner, name, number))).await
1810
}
1811
1812
async fn auto_land_set(app: &Shared, headers: &HeaderMap, owner: &str, name: &str, number: i64, on: bool) -> Result<(), ApiError> {
1813
    let c = caller(app, headers).await?;
1814
    let me = c.require("repo:write")?.clone();
1815
    let (_, row, _) = reach(app, &c, owner, name, Access::Write).await?;
1816
    let p = db::proposals::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such proposal"))?;
1817
    if !p.is_open() {
1818
        return Err(ApiError(StatusCode::CONFLICT, format!("the proposal is {}", p.state)));
1819
    }
1820
    crate::autoland::set(app, &row, &p, &me, on).await?;
1821
    Ok(())
1822
}
1823
1824
/// The files a proposal changes (hub spec §12.1).
1825
async fn proposal_files(
1826
    State(app): State<Shared>,
1827
    headers: HeaderMap,
1828
    Path((owner, name, number)): Path<(String, String, i64)>,
1829
) -> Result<Json<Vec<hub_api::ProposalFile>>, ApiError> {
1830
    let c = caller(&app, &headers).await?;
1831
    let (repo, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1832
    let p = db::proposals::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such proposal"))?;
1833
    let loaded = crate::web::proposals::load(&app, &repo, p).await?;
1834
    Ok(Json(
1835
        loaded
1836
            .files
1837
            .iter()
1838
            .map(|f| hub_api::ProposalFile {
1839
                path: f.path.clone(),
1840
                from: f.from.clone(),
1841
                kind: f.kind.clone(),
1842
                added: f.added,
1843
                removed: f.removed,
1844
            })
1845
            .collect(),
1846
    ))
1847
}
1848
1849
/// `GET …/proposals/{number}/diff`: each file the proposal changes with its
1850
/// diff (three lines of context, as a change's), as the proposal page shows
1851
/// them, for clients that draw diffs (oxygenhub-android#4).
1852
async fn proposal_diff(
1853
    State(app): State<Shared>,
1854
    headers: HeaderMap,
1855
    Path((owner, name, number)): Path<(String, String, i64)>,
1856
) -> Result<Json<Vec<FileChange>>, ApiError> {
1857
    let c = caller(&app, &headers).await?;
1858
    let (repo, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1859
    let p = db::proposals::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such proposal"))?;
1860
    let loaded = crate::web::proposals::load(&app, &repo, p).await?;
1861
    Ok(Json(loaded.files.into_iter().map(file_change).collect()))
1862
}
1863
1864
/// One file's bytes on a side of a proposal: `base` is the target's
1865
/// state, `head` the projected state. 404 when the file does not exist
1866
/// on that side.
1867
async fn proposal_content(
1868
    State(app): State<Shared>,
1869
    headers: HeaderMap,
1870
    Path((owner, name, number, side, path)): Path<(String, String, i64, String, String)>,
1871
) -> Result<Response, ApiError> {
1872
    let c = caller(&app, &headers).await?;
1873
    let (repo, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1874
    let p = db::proposals::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such proposal"))?;
1875
    let loaded = crate::web::proposals::load_summary(&app, &repo, p).await?;
1876
    let heads = match side.as_str() {
1877
        "base" => loaded.target_heads,
1878
        "head" => loaded.heads,
1879
        _ => return Err(ApiError(StatusCode::BAD_REQUEST, "the side is base or head".into())),
1880
    };
1881
    let limit = app.config.limits.render_limit.0;
1882
    let target = view::RefTarget { label: side, kind: view::RefKind::Change, heads };
1883
    let f = app.repos.read(&repo, move |repo, cache| view::file(repo, cache, target, &path, limit)).await?;
1884
    Ok(crate::web::raw(f.bytes, &f.name, false))
1885
}
1886
1887
async fn create_proposal(
1888
    State(app): State<Shared>,
1889
    headers: HeaderMap,
1890
    Path((owner, name)): Path<(String, String)>,
1891
    Json(body): Json<NewProposal>,
1892
) -> Result<(StatusCode, Json<Proposal>), ApiError> {
1893
    let c = caller(&app, &headers).await?;
1894
    let me = c.require("proposals:write").or_else(|_| c.require("repo:write"))?.clone();
1895
    let (repo, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1896
    let created =
1897
        crate::web::proposals::open_proposal(&app, &repo, &row, &me, &body.title, &body.body, &body.target, &body.source, body.draft)
1898
            .await
1899
            .map_err(|e| ApiError(StatusCode::BAD_REQUEST, e))?;
1900
    let loaded = crate::web::proposals::load_summary(&app, &repo, created).await?;
1901
    let v = crate::web::proposals::verdict(&app, &loaded, row.id).await?;
1902
    Ok((StatusCode::CREATED, Json(crate::web::proposals::to_api(&app, &owner, &name, &loaded, &v, None).await)))
1903
}
1904
1905
fn comment_of(c: &db::proposals::CommentRow) -> Comment {
1906
    Comment {
1907
        id: c.id,
1908
        author: c.author.clone(),
1909
        body: c.body.clone(),
1910
        created_ms: c.created_ms,
1911
        path: if c.path.is_empty() { None } else { Some(c.path.clone()) },
1912
        anchor: if c.anchor_change.is_empty() {
1913
            None
1914
        } else {
1915
            Some(Atom { change: c.anchor_change.clone(), index: c.anchor_index as u32 })
1916
        },
1917
        line: None,
1918
        resolved: c.resolved,
1919
    }
1920
}
1921
1922
async fn proposal_comments(
1923
    State(app): State<Shared>,
1924
    headers: HeaderMap,
1925
    Path((owner, name, number)): Path<(String, String, i64)>,
1926
) -> Result<Json<Vec<Comment>>, ApiError> {
1927
    let c = caller(&app, &headers).await?;
1928
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1929
    let p = db::proposals::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such proposal"))?;
1930
    let mut out: Vec<Comment> = db::proposals::comments(&app.db, p.id).await?.iter().map(comment_of).collect();
1931
    // Place anchored comments on their line of the projected state.
1932
    let paths: std::collections::BTreeSet<String> = out.iter().filter(|c| c.anchor.is_some()).filter_map(|c| c.path.clone()).collect();
1933
    if !paths.is_empty() {
1934
        let repo = RepoName::new(&owner, &name).ok_or_else(|| not_found("no such repository"))?;
1935
        let heads = crate::web::proposals::load_summary(&app, &repo, p).await?.heads;
1936
        let lines = app
1937
            .repos
1938
            .read(&repo, move |r, _| {
1939
                let mut at = std::collections::HashMap::new();
1940
                for path in paths {
1941
                    // A file the projection removed has no lines to place a comment on.
1942
                    for l in r.blame_in(&path, &heads).unwrap_or_default() {
1943
                        at.insert((path.clone(), l.hash.to_hex(), l.index), l.line);
1944
                    }
1945
                }
1946
                Ok(at)
1947
            })
1948
            .await?;
1949
        for c in &mut out {
1950
            if let (Some(path), Some(a)) = (&c.path, &c.anchor) {
1951
                c.line = lines.get(&(path.clone(), a.change.clone(), a.index)).copied();
1952
            }
1953
        }
1954
    }
1955
    Ok(Json(out))
1956
}
1957
1958
async fn proposal_comment(
1959
    State(app): State<Shared>,
1960
    headers: HeaderMap,
1961
    Path((owner, name, number)): Path<(String, String, i64)>,
1962
    Json(body): Json<NewComment>,
1963
) -> Result<(StatusCode, Json<Comment>), ApiError> {
1964
    let c = caller(&app, &headers).await?;
1965
    let me = c.require("proposals:write").or_else(|_| c.require("repo:write"))?.clone();
1966
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1967
    let p = db::proposals::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such proposal"))?;
1968
    if body.body.trim().is_empty() {
1969
        return Err(ApiError(StatusCode::BAD_REQUEST, "an empty comment says nothing".into()));
1970
    }
1971
    let (repo, _) = (RepoName::new(&owner, &name).ok_or_else(|| not_found("no such repository"))?, ());
1972
    let anchor = match (body.path.as_deref().map(|x| x.trim_matches('/')), body.line) {
1973
        (Some(path), Some(line)) if !path.is_empty() => {
1974
            let loaded = crate::web::proposals::load(&app, &repo, p.clone()).await?;
1975
            let (heads, file) = (loaded.heads.clone(), path.to_string());
1976
            let atom = app
1977
                .repos
1978
                .read(&repo, move |r, cache| {
1979
                    let projected = cache.load(r, &heads)?;
1980
                    Ok(crate::repos::proposals::atom_at(&projected, &file, line).map(|(h, i)| (h.to_hex(), i)))
1981
                })
1982
                .await?
1983
                .ok_or_else(|| ApiError(StatusCode::BAD_REQUEST, format!("{path}:{line} is not a line of the projected state")))?;
1984
            Some((path.to_string(), atom))
1985
        }
1986
        _ => None,
1987
    };
1988
    let row_c = db::proposals::add_comment(
1989
        &app.db,
1990
        p.id,
1991
        Some(me.id),
1992
        &me.username,
1993
        body.body.trim(),
1994
        anchor.as_ref().map(|(path, _)| path.as_str()).unwrap_or(""),
1995
        anchor.as_ref().map(|(_, (h, i))| (h.as_str(), *i as i64)),
1996
    )
1997
    .await?;
1998
    crate::notify::deliver(
1999
        &app,
2000
        crate::notify::Event {
2001
            kind: "proposal.comment",
2002
            title: format!("{owner}/{name}#{number}: {}", p.title),
2003
            url: format!("/{owner}/{name}/proposal/{number}"),
2004
            actor: &me,
2005
            repo_id: row.id,
2006
            thread: Some(("proposal", p.id)),
2007
            mention_text: &body.body,
2008
            direct: p.author_id.into_iter().collect(),
2009
        },
2010
    )
2011
    .await;
2012
    crate::hooks::emit(
2013
        &app,
2014
        &row,
2015
        "comment.proposal",
2016
        &me.username,
2017
        serde_json::json!({ "number": number, "comment": comment_of(&row_c) }),
2018
    )
2019
    .await;
2020
    let mut created = comment_of(&row_c);
2021
    created.line = created.anchor.as_ref().and(body.line);
2022
    Ok((StatusCode::CREATED, Json(created)))
2023
}
2024
2025
async fn proposal_reviews(
2026
    State(app): State<Shared>,
2027
    headers: HeaderMap,
2028
    Path((owner, name, number)): Path<(String, String, i64)>,
2029
) -> Result<Json<Vec<Review>>, ApiError> {
2030
    let c = caller(&app, &headers).await?;
2031
    let (repo, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
2032
    let p = db::proposals::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such proposal"))?;
2033
    let loaded = crate::web::proposals::load_summary(&app, &repo, p).await?;
2034
    let v = crate::web::proposals::verdict(&app, &loaded, row.id).await?;
2035
    Ok(Json(
2036
        v.reviews
2037
            .into_iter()
2038
            .map(|r| Review {
2039
                id: r.row.id,
2040
                author: r.row.author,
2041
                verdict: r.row.verdict,
2042
                body: r.row.body,
2043
                sealed: r.sealed,
2044
                created_ms: r.row.created_ms,
2045
                via: r.row.via,
2046
            })
2047
            .collect(),
2048
    ))
2049
}
2050
2051
async fn proposal_review(
2052
    State(app): State<Shared>,
2053
    headers: HeaderMap,
2054
    Path((owner, name, number)): Path<(String, String, i64)>,
2055
    Json(body): Json<NewReview>,
2056
) -> Result<(StatusCode, Json<Review>), ApiError> {
2057
    let c = caller(&app, &headers).await?;
2058
    let me = c.require("proposals:write").or_else(|_| c.require("repo:write"))?.clone();
2059
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
2060
    let p = db::proposals::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such proposal"))?;
2061
    if !matches!(body.verdict.as_str(), "comment" | "changes" | "approve") {
2062
        return Err(ApiError(StatusCode::BAD_REQUEST, "verdict is comment, changes or approve".into()));
2063
    }
2064
    if body.verdict == "approve" && Some(me.id) == p.author_id {
2065
        return Err(forbidden("you cannot approve your own proposal"));
2066
    }
2067
    let r = db::proposals::add_review(&app.db, p.id, me.id, &me.username, &body.verdict, body.body.trim()).await?;
2068
    db::proposals::add_event(&app.db, p.id, &me.username, &format!("review.{}", body.verdict), "").await.ok();
2069
    crate::web::proposals::reviewed(&app, &row, &p, &me, &body.verdict).await;
2070
    crate::hooks::emit(&app, &row, "review", &me.username, serde_json::json!({ "number": number, "verdict": body.verdict })).await;
2071
    Ok((
2072
        StatusCode::CREATED,
2073
        Json(Review { id: r.id, author: r.author, verdict: r.verdict, body: r.body, sealed: false, created_ms: r.created_ms, via: r.via }),
2074
    ))
2075
}
2076
2077
/// `POST .../proposals/{number}/reviewers`: ask accounts to review (the
2078
/// author, or a writer). Answers with everyone asked now.
2079
async fn request_reviewers(
2080
    State(app): State<Shared>,
2081
    headers: HeaderMap,
2082
    Path((owner, name, number)): Path<(String, String, i64)>,
2083
    Json(body): Json<ReviewRequest>,
2084
) -> Result<Json<Vec<String>>, ApiError> {
2085
    let c = caller(&app, &headers).await?;
2086
    let me = c.require("proposals:write").or_else(|_| c.require("repo:write"))?.clone();
2087
    let (_, row, role) = reach(&app, &c, &owner, &name, Access::Read).await?;
2088
    let p = db::proposals::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such proposal"))?;
2089
    if Some(me.id) != p.author_id && role < Role::Write {
2090
        return Err(forbidden("only the author or a writer asks for reviews"));
2091
    }
2092
    if !p.is_open() {
2093
        return Err(ApiError(StatusCode::CONFLICT, "the proposal is not open".into()));
2094
    }
2095
    crate::web::proposals::request_reviewers(&app, &row, &p, &me, &body.reviewers)
2096
        .await
2097
        .map_err(|e| ApiError(StatusCode::UNPROCESSABLE_ENTITY, e))?;
2098
    Ok(Json(db::proposals::review_requests(&app.db, p.id).await?))
2099
}
2100
2101
/// `DELETE .../proposals/{number}/reviewers/{username}`: withdraw a request.
2102
async fn withdraw_reviewer(
2103
    State(app): State<Shared>,
2104
    headers: HeaderMap,
2105
    Path((owner, name, number, username)): Path<(String, String, i64, String)>,
2106
) -> Result<StatusCode, ApiError> {
2107
    let c = caller(&app, &headers).await?;
2108
    let me = c.require("proposals:write").or_else(|_| c.require("repo:write"))?.clone();
2109
    let (_, row, role) = reach(&app, &c, &owner, &name, Access::Read).await?;
2110
    let p = db::proposals::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such proposal"))?;
2111
    if Some(me.id) != p.author_id && role < Role::Write {
2112
        return Err(forbidden("only the author or a writer withdraws review requests"));
2113
    }
2114
    let a = db::accounts::account_by_name(&app.db, &username).await?.ok_or_else(|| not_found("no such account"))?;
2115
    if db::proposals::unrequest_review(&app.db, p.id, a.id).await? {
2116
        db::proposals::add_event(&app.db, p.id, &me.username, "review request withdrawn", &a.username).await.ok();
2117
    }
2118
    Ok(StatusCode::NO_CONTENT)
2119
}
2120
2121
async fn proposal_checks(
2122
    State(app): State<Shared>,
2123
    headers: HeaderMap,
2124
    Path((owner, name, number)): Path<(String, String, i64)>,
2125
) -> Result<Json<Vec<Check>>, ApiError> {
2126
    let c = caller(&app, &headers).await?;
2127
    let (repo, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
2128
    let p = db::proposals::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such proposal"))?;
2129
    let loaded = crate::web::proposals::load_summary(&app, &repo, p).await?;
2130
    Ok(Json(db::hooks::checks_for_state(&app.db, row.id, &loaded.state).await?.iter().map(check_of).collect()))
2131
}
2132
2133
// ------------------------------------------------------------------ issues
2134
2135
async fn issue_of(app: &Shared, row: &db::repos::RepoRow, i: &db::issues::IssueRow) -> Result<Issue, ApiError> {
2136
    let labels = db::issues::issue_labels(&app.db, i.id)
2137
        .await?
2138
        .into_iter()
2139
        .map(|l| Label { name: l.name, colour: l.colour, description: l.description })
2140
        .collect();
2141
    let assignees = db::issues::assignees(&app.db, i.id).await?;
2142
    let milestone = match i.milestone_id {
2143
        Some(id) => db::issues::milestone(&app.db, id).await?.map(|m| m.title),
2144
        None => None,
2145
    };
2146
    let comments: i64 = sqlx::query_scalar("SELECT COUNT(*) FROM issue_comments WHERE issue_id = $1").bind(i.id).fetch_one(&app.db).await?;
2147
    Ok(Issue {
2148
        number: i.number,
2149
        title: i.title.clone(),
2150
        body: i.body.clone(),
2151
        author: i.author.clone(),
2152
        state: i.state.clone(),
2153
        reason: i.reason.clone(),
2154
        labels,
2155
        assignees,
2156
        milestone,
2157
        comments,
2158
        locked: i.locked,
2159
        pinned: i.pinned,
2160
        created_ms: i.created_ms,
2161
        updated_ms: i.updated_ms,
2162
        closed_ms: i.closed_ms,
2163
        url: format!("{}/{}/issue/{}", app.config.base_url(), row.slug(), i.number),
2164
    })
2165
}
2166
2167
#[derive(Deserialize)]
2168
struct IssuesQuery {
2169
    state: Option<String>,
2170
}
2171
2172
#[derive(Deserialize)]
2173
struct ProposalsQuery {
2174
    state: Option<String>,
2175
    limit: Option<usize>,
2176
}
2177
2178
async fn issues(
2179
    State(app): State<Shared>,
2180
    headers: HeaderMap,
2181
    Path((owner, name)): Path<(String, String)>,
2182
    Query(q): Query<IssuesQuery>,
2183
) -> Result<Json<Vec<Issue>>, ApiError> {
2184
    let c = caller(&app, &headers).await?;
2185
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
2186
    let state = q.state.unwrap_or_else(|| "open".into());
2187
    let mut out = Vec::new();
2188
    for i in db::issues::list(&app.db, row.id).await? {
2189
        if state == "all" || i.state == state {
2190
            out.push(issue_of(&app, &row, &i).await?);
2191
        }
2192
    }
2193
    Ok(Json(out))
2194
}
2195
2196
async fn create_issue(
2197
    State(app): State<Shared>,
2198
    headers: HeaderMap,
2199
    Path((owner, name)): Path<(String, String)>,
2200
    Json(body): Json<NewIssue>,
2201
) -> Result<(StatusCode, Json<Issue>), ApiError> {
2202
    let c = caller(&app, &headers).await?;
2203
    let me = c.require("issues:write").or_else(|_| c.require("repo:write"))?.clone();
2204
    let (_, row, role) = reach(&app, &c, &owner, &name, Access::Read).await?;
2205
    if body.title.trim().is_empty() {
2206
        return Err(ApiError(StatusCode::BAD_REQUEST, "an issue needs a title".into()));
2207
    }
2208
    let triage = !body.labels.is_empty() || !body.assignees.is_empty() || body.milestone.is_some();
2209
    if triage && role < Role::Triage {
2210
        return Err(forbidden("setting labels, assignees or a milestone needs triage access"));
2211
    }
2212
    // Check the names before anything is created.
2213
    resolve_triage(&app, row.id, Some(&body.labels), Some(&body.assignees), body.milestone.as_deref()).await?;
2214
    let i = db::issues::create(
2215
        &app.db,
2216
        db::issues::NewIssue {
2217
            repo_id: row.id,
2218
            title: body.title.trim(),
2219
            body: body.body.trim(),
2220
            author_id: Some(me.id),
2221
            author: &me.username,
2222
        },
2223
    )
2224
    .await?;
2225
    db::issues::add_event(&app.db, i.id, &me.username, "opened", "").await.ok();
2226
    if triage {
2227
        let t = resolve_triage(&app, row.id, Some(&body.labels), Some(&body.assignees), body.milestone.as_deref()).await?;
2228
        apply_triage(&app, &i, &me, t).await?;
2229
    }
2230
    let i = db::issues::get(&app.db, row.id, i.number).await?.unwrap_or(i);
2231
    crate::web::issues::reindex(&app, row.id, &i).await;
2232
    let api = issue_of(&app, &row, &i).await?;
2233
    crate::notify::deliver(
2234
        &app,
2235
        crate::notify::Event {
2236
            kind: "issue.opened",
2237
            title: format!("{owner}/{name}#{}: {}", i.number, i.title),
2238
            url: format!("/{owner}/{name}/issue/{}", i.number),
2239
            actor: &me,
2240
            repo_id: row.id,
2241
            thread: Some(("issue", i.id)),
2242
            mention_text: &body.body,
2243
            direct: vec![],
2244
        },
2245
    )
2246
    .await;
2247
    crate::hooks::emit(&app, &row, "issue.opened", &me.username, serde_json::json!({ "issue": api })).await;
2248
    Ok((StatusCode::CREATED, Json(api)))
2249
}
2250
2251
async fn issue(
2252
    State(app): State<Shared>,
2253
    headers: HeaderMap,
2254
    Path((owner, name, number)): Path<(String, String, i64)>,
2255
) -> Result<Json<Issue>, ApiError> {
2256
    let c = caller(&app, &headers).await?;
2257
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
2258
    let i = db::issues::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such issue"))?;
2259
    Ok(Json(issue_of(&app, &row, &i).await?))
2260
}
2261
2262
async fn issue_state(
2263
    State(app): State<Shared>,
2264
    headers: HeaderMap,
2265
    Path((owner, name, number)): Path<(String, String, i64)>,
2266
    Json(body): Json<IssueStateChange>,
2267
) -> Result<Json<Issue>, ApiError> {
2268
    let c = caller(&app, &headers).await?;
2269
    let me = c.require("issues:write").or_else(|_| c.require("repo:write"))?.clone();
2270
    let (_, row, role) = reach(&app, &c, &owner, &name, Access::Read).await?;
2271
    let i = db::issues::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such issue"))?;
2272
    if role < Role::Triage && Some(me.id) != i.author_id {
2273
        return Err(forbidden("only the author or triage may change the state"));
2274
    }
2275
    let (state, reason) = match body.state.as_str() {
2276
        "closed" => ("closed", if body.reason == "not_planned" { "not_planned" } else { "completed" }),
2277
        "open" => ("open", ""),
2278
        _ => return Err(ApiError(StatusCode::BAD_REQUEST, "state is open or closed".into())),
2279
    };
2280
    db::issues::set_state(&app.db, i.id, state, reason).await?;
2281
    db::issues::add_event(&app.db, i.id, &me.username, if state == "closed" { "closed" } else { "reopened" }, "").await.ok();
2282
    let fresh = db::issues::get(&app.db, row.id, number).await?.unwrap_or(i);
2283
    let api = issue_of(&app, &row, &fresh).await?;
2284
    crate::hooks::emit(
2285
        &app,
2286
        &row,
2287
        if state == "closed" { "issue.closed" } else { "issue.reopened" },
2288
        &me.username,
2289
        serde_json::json!({ "issue": api }),
2290
    )
2291
    .await;
2292
    Ok(Json(api))
2293
}
2294
2295
async fn issue_comments(
2296
    State(app): State<Shared>,
2297
    headers: HeaderMap,
2298
    Path((owner, name, number)): Path<(String, String, i64)>,
2299
) -> Result<Json<Vec<Comment>>, ApiError> {
2300
    let c = caller(&app, &headers).await?;
2301
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
2302
    let i = db::issues::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such issue"))?;
2303
    Ok(Json(
2304
        db::issues::comments(&app.db, i.id)
2305
            .await?
2306
            .into_iter()
2307
            .map(|c| Comment {
2308
                id: c.id,
2309
                author: c.author,
2310
                body: c.body,
2311
                created_ms: c.created_ms,
2312
                path: None,
2313
                anchor: None,
2314
                line: None,
2315
                resolved: false,
2316
            })
2317
            .collect(),
2318
    ))
2319
}
2320
2321
async fn issue_comment(
2322
    State(app): State<Shared>,
2323
    headers: HeaderMap,
2324
    Path((owner, name, number)): Path<(String, String, i64)>,
2325
    Json(body): Json<NewComment>,
2326
) -> Result<(StatusCode, Json<Comment>), ApiError> {
2327
    let c = caller(&app, &headers).await?;
2328
    let me = c.require("issues:write").or_else(|_| c.require("repo:write"))?.clone();
2329
    let (_, row, role) = reach(&app, &c, &owner, &name, Access::Read).await?;
2330
    let i = db::issues::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such issue"))?;
2331
    if i.locked && role < Role::Triage {
2332
        return Err(forbidden("this issue is locked"));
2333
    }
2334
    if body.body.trim().is_empty() {
2335
        return Err(ApiError(StatusCode::BAD_REQUEST, "an empty comment says nothing".into()));
2336
    }
2337
    let cm = db::issues::add_comment(&app.db, i.id, Some(me.id), &me.username, body.body.trim()).await?;
2338
    crate::web::issues::reindex(&app, row.id, &i).await;
2339
    crate::notify::deliver(
2340
        &app,
2341
        crate::notify::Event {
2342
            kind: "issue.comment",
2343
            title: format!("{owner}/{name}#{number}: {}", i.title),
2344
            url: format!("/{owner}/{name}/issue/{number}"),
2345
            actor: &me,
2346
            repo_id: row.id,
2347
            thread: Some(("issue", i.id)),
2348
            mention_text: &body.body,
2349
            direct: i.author_id.into_iter().collect(),
2350
        },
2351
    )
2352
    .await;
2353
    let api = Comment {
2354
        id: cm.id,
2355
        author: cm.author,
2356
        body: cm.body,
2357
        created_ms: cm.created_ms,
2358
        path: None,
2359
        anchor: None,
2360
        line: None,
2361
        resolved: false,
2362
    };
2363
    crate::hooks::emit(&app, &row, "comment.issue", &me.username, serde_json::json!({ "number": number, "comment": api })).await;
2364
    Ok((StatusCode::CREATED, Json(api)))
2365
}
2366
2367
/// Labels, assignees and milestone named in a request, looked up.
2368
struct Triage {
2369
    labels: Option<Vec<db::issues::Label>>,
2370
    assignees: Option<Vec<Account>>,
2371
    /// `Some(None)` clears the milestone.
2372
    milestone: Option<Option<db::issues::Milestone>>,
2373
}
2374
2375
async fn resolve_triage(
2376
    app: &Shared,
2377
    repo_id: i64,
2378
    labels: Option<&[String]>,
2379
    assignees: Option<&[String]>,
2380
    milestone: Option<&str>,
2381
) -> Result<Triage, ApiError> {
2382
    let bad = |m: String| ApiError(StatusCode::BAD_REQUEST, m);
2383
    let labels = match labels {
2384
        Some(names) => {
2385
            let mut out = Vec::new();
2386
            for n in names {
2387
                out.push(
2388
                    db::issues::label_by_name(&app.db, repo_id, n.trim())
2389
                        .await?
2390
                        .ok_or_else(|| bad(format!("no label {n:?}; create it first")))?,
2391
                );
2392
            }
2393
            Some(out)
2394
        }
2395
        None => None,
2396
    };
2397
    let assignees = match assignees {
2398
        Some(names) => {
2399
            let mut out = Vec::new();
2400
            for n in names {
2401
                out.push(db::accounts::account_by_name(&app.db, n.trim()).await?.ok_or_else(|| bad(format!("no account {n:?}")))?);
2402
            }
2403
            Some(out)
2404
        }
2405
        None => None,
2406
    };
2407
    let milestone = match milestone.map(str::trim) {
2408
        None => None,
2409
        Some("") => Some(None),
2410
        Some(title) => Some(Some(
2411
            db::issues::milestones(&app.db, repo_id)
2412
                .await?
2413
                .into_iter()
2414
                .find(|m| m.title == title)
2415
                .ok_or_else(|| bad(format!("no milestone {title:?}")))?,
2416
        )),
2417
    };
2418
    Ok(Triage { labels, assignees, milestone })
2419
}
2420
2421
/// Make an issue's labels, assignees and milestone what `t` says, with
2422
/// timeline events for what changed.
2423
async fn apply_triage(app: &Shared, i: &db::issues::IssueRow, me: &Account, t: Triage) -> Result<(), ApiError> {
2424
    if let Some(want) = t.labels {
2425
        let have = db::issues::issue_labels(&app.db, i.id).await?;
2426
        for l in &have {
2427
            if !want.iter().any(|w| w.id == l.id) {
2428
                db::issues::set_issue_label(&app.db, i.id, l.id, false).await?;
2429
            }
2430
        }
2431
        for w in &want {
2432
            if !have.iter().any(|l| l.id == w.id) {
2433
                db::issues::set_issue_label(&app.db, i.id, w.id, true).await?;
2434
            }
2435
        }
2436
        let names: Vec<&str> = want.iter().map(|l| l.name.as_str()).collect();
2437
        db::issues::add_event(&app.db, i.id, &me.username, "set labels", &names.join(", ")).await.ok();
2438
    }
2439
    if let Some(want) = t.assignees {
2440
        let have = db::issues::assignees(&app.db, i.id).await?;
2441
        for name in &have {
2442
            if !want.iter().any(|a| &a.username == name) {
2443
                if let Some(a) = db::accounts::account_by_name(&app.db, name).await? {
2444
                    db::issues::set_assignee(&app.db, i.id, a.id, false).await?;
2445
                    db::issues::add_event(&app.db, i.id, &me.username, "unassigned", name).await.ok();
2446
                }
2447
            }
2448
        }
2449
        for a in &want {
2450
            if !have.contains(&a.username) {
2451
                db::issues::set_assignee(&app.db, i.id, a.id, true).await?;
2452
                db::issues::add_event(&app.db, i.id, &me.username, "assigned", &a.username).await.ok();
2453
            }
2454
        }
2455
    }
2456
    if let Some(m) = t.milestone {
2457
        db::issues::set_milestone(&app.db, i.id, m.as_ref().map(|m| m.id)).await?;
2458
        db::issues::add_event(&app.db, i.id, &me.username, "set milestone", m.as_ref().map(|m| m.title.as_str()).unwrap_or("")).await.ok();
2459
    }
2460
    Ok(())
2461
}
2462
2463
/// `PATCH /repos/{o}/{n}/issues/{number}`.
2464
async fn issue_edit(
2465
    State(app): State<Shared>,
2466
    headers: HeaderMap,
2467
    Path((owner, name, number)): Path<(String, String, i64)>,
2468
    Json(body): Json<IssueEdit>,
2469
) -> Result<Json<Issue>, ApiError> {
2470
    let c = caller(&app, &headers).await?;
2471
    let me = c.require("issues:write").or_else(|_| c.require("repo:write"))?.clone();
2472
    let (_, row, role) = reach(&app, &c, &owner, &name, Access::Read).await?;
2473
    let i = db::issues::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such issue"))?;
2474
    let text = body.title.is_some() || body.body.is_some();
2475
    let triage = body.labels.is_some() || body.assignees.is_some() || body.milestone.is_some();
2476
    if text && role < Role::Triage && Some(me.id) != i.author_id {
2477
        return Err(forbidden("only the author or triage may edit the title and body"));
2478
    }
2479
    if triage && role < Role::Triage {
2480
        return Err(forbidden("setting labels, assignees or a milestone needs triage access"));
2481
    }
2482
    if i.locked && role < Role::Triage {
2483
        return Err(forbidden("this issue is locked"));
2484
    }
2485
    let t = resolve_triage(&app, row.id, body.labels.as_deref(), body.assignees.as_deref(), body.milestone.as_deref()).await?;
2486
    if text {
2487
        let title = body.title.as_deref().map(str::trim).unwrap_or(&i.title);
2488
        if title.is_empty() {
2489
            return Err(ApiError(StatusCode::BAD_REQUEST, "an issue needs a title".into()));
2490
        }
2491
        db::issues::edit(&app.db, i.id, title, body.body.as_deref().unwrap_or(&i.body)).await?;
2492
        db::issues::add_event(&app.db, i.id, &me.username, "edited", "").await.ok();
2493
    }
2494
    apply_triage(&app, &i, &me, t).await?;
2495
    db::issues::touch(&app.db, i.id).await.ok();
2496
    let fresh = db::issues::get(&app.db, row.id, number).await?.unwrap_or(i);
2497
    crate::web::issues::reindex(&app, row.id, &fresh).await;
2498
    let api = issue_of(&app, &row, &fresh).await?;
2499
    crate::hooks::emit(&app, &row, "issue.edited", &me.username, serde_json::json!({ "issue": api })).await;
2500
    Ok(Json(api))
2501
}
2502
2503
/// `POST /repos/{o}/{n}/labels` (triage).
2504
async fn create_label(
2505
    State(app): State<Shared>,
2506
    headers: HeaderMap,
2507
    Path((owner, name)): Path<(String, String)>,
2508
    Json(body): Json<NewLabel>,
2509
) -> Result<(StatusCode, Json<Label>), ApiError> {
2510
    let c = caller(&app, &headers).await?;
2511
    c.require("issues:write").or_else(|_| c.require("repo:write"))?;
2512
    let (_, row, role) = reach(&app, &c, &owner, &name, Access::Read).await?;
2513
    if role < Role::Triage {
2514
        return Err(forbidden("labels need triage access"));
2515
    }
2516
    let label = body.name.trim();
2517
    if label.is_empty() || label.len() > 50 {
2518
        return Err(ApiError(StatusCode::BAD_REQUEST, "a label has a name of 1 to 50 characters".into()));
2519
    }
2520
    let colour = match body.colour.as_deref() {
2521
        Some(c) if c.len() == 7 && c.starts_with('#') && c[1..].chars().all(|x| x.is_ascii_hexdigit()) => c.to_string(),
2522
        Some(c) => return Err(ApiError(StatusCode::BAD_REQUEST, format!("colour {c:?} is not #rrggbb"))),
2523
        None => "#5aa8ff".to_string(),
2524
    };
2525
    let l = db::issues::upsert_label(&app.db, row.id, label, &colour, body.description.trim()).await?;
2526
    Ok((StatusCode::CREATED, Json(Label { name: l.name, colour: l.colour, description: l.description })))
2527
}
2528
2529
/// `DELETE /repos/{o}/{n}/labels/{label}` (triage).
2530
async fn delete_label(
2531
    State(app): State<Shared>,
2532
    headers: HeaderMap,
2533
    Path((owner, name, label)): Path<(String, String, String)>,
2534
) -> Result<StatusCode, ApiError> {
2535
    let c = caller(&app, &headers).await?;
2536
    c.require("issues:write").or_else(|_| c.require("repo:write"))?;
2537
    let (_, row, role) = reach(&app, &c, &owner, &name, Access::Read).await?;
2538
    if role < Role::Triage {
2539
        return Err(forbidden("labels need triage access"));
2540
    }
2541
    let l = db::issues::label_by_name(&app.db, row.id, &label).await?.ok_or_else(|| not_found("no such label"))?;
2542
    db::issues::delete_label(&app.db, l.id).await?;
2543
    Ok(StatusCode::NO_CONTENT)
2544
}
2545
2546
async fn labels(
2547
    State(app): State<Shared>,
2548
    headers: HeaderMap,
2549
    Path((owner, name)): Path<(String, String)>,
2550
) -> Result<Json<Vec<Label>>, ApiError> {
2551
    let c = caller(&app, &headers).await?;
2552
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
2553
    Ok(Json(
2554
        db::issues::labels(&app.db, row.id)
2555
            .await?
2556
            .into_iter()
2557
            .map(|l| Label { name: l.name, colour: l.colour, description: l.description })
2558
            .collect(),
2559
    ))
2560
}
2561
2562
async fn milestones(
2563
    State(app): State<Shared>,
2564
    headers: HeaderMap,
2565
    Path((owner, name)): Path<(String, String)>,
2566
) -> Result<Json<Vec<Milestone>>, ApiError> {
2567
    let c = caller(&app, &headers).await?;
2568
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
2569
    let mut out = Vec::new();
2570
    for m in db::issues::milestones(&app.db, row.id).await? {
2571
        let (open, closed) = db::issues::milestone_counts(&app.db, m.id).await?;
2572
        out.push(Milestone { title: m.title, description: m.description, due_ms: m.due_ms, state: m.state, open, closed });
2573
    }
2574
    Ok(Json(out))
2575
}
2576
2577
fn milestone_of(m: db::issues::Milestone, open: i64, closed: i64) -> Milestone {
2578
    Milestone { title: m.title, description: m.description, due_ms: m.due_ms, state: m.state, open, closed }
2579
}
2580
2581
/// A due date as `YYYY-MM-DD` (UTC midnight), or the empty string for none.
2582
fn due_ms_of(due: &str) -> Result<Option<i64>, ApiError> {
2583
    let due = due.trim();
2584
    if due.is_empty() {
2585
        return Ok(None);
2586
    }
2587
    time::Date::parse(due, &time::macros::format_description!("[year]-[month]-[day]"))
2588
        .map(|d| Some(d.midnight().assume_utc().unix_timestamp() * 1000))
2589
        .map_err(|_| ApiError(StatusCode::BAD_REQUEST, format!("due {due:?} is not YYYY-MM-DD")))
2590
}
2591
2592
async fn triage_for_milestones(app: &Shared, headers: &HeaderMap, owner: &str, name: &str) -> Result<db::repos::RepoRow, ApiError> {
2593
    let c = caller(app, headers).await?;
2594
    c.require("issues:write").or_else(|_| c.require("repo:write"))?;
2595
    let (_, row, role) = reach(app, &c, owner, name, Access::Read).await?;
2596
    if role < Role::Triage {
2597
        return Err(forbidden("milestones need triage access"));
2598
    }
2599
    Ok(row)
2600
}
2601
2602
/// `POST /repos/{o}/{n}/milestones` (triage, oxygenhub#91): create a
2603
/// milestone, or change the description and due date of the one with
2604
/// that title.
2605
async fn create_milestone(
2606
    State(app): State<Shared>,
2607
    headers: HeaderMap,
2608
    Path((owner, name)): Path<(String, String)>,
2609
    Json(body): Json<NewMilestone>,
2610
) -> Result<(StatusCode, Json<Milestone>), ApiError> {
2611
    let row = triage_for_milestones(&app, &headers, &owner, &name).await?;
2612
    let title = body.title.trim();
2613
    if title.is_empty() || title.len() > 100 {
2614
        return Err(ApiError(StatusCode::BAD_REQUEST, "a milestone has a title of 1 to 100 characters".into()));
2615
    }
2616
    let due_ms = due_ms_of(body.due.as_deref().unwrap_or(""))?;
2617
    let m = db::issues::upsert_milestone(&app.db, row.id, title, body.description.trim(), due_ms).await?;
2618
    let (open, closed) = db::issues::milestone_counts(&app.db, m.id).await?;
2619
    Ok((StatusCode::CREATED, Json(milestone_of(m, open, closed))))
2620
}
2621
2622
/// `PATCH /repos/{o}/{n}/milestones/{title}` (triage): title,
2623
/// description, due date and state; what is not given stays.
2624
async fn edit_milestone(
2625
    State(app): State<Shared>,
2626
    headers: HeaderMap,
2627
    Path((owner, name, title)): Path<(String, String, String)>,
2628
    Json(body): Json<MilestoneEdit>,
2629
) -> Result<Json<Milestone>, ApiError> {
2630
    let row = triage_for_milestones(&app, &headers, &owner, &name).await?;
2631
    let m = db::issues::milestones(&app.db, row.id)
2632
        .await?
2633
        .into_iter()
2634
        .find(|m| m.title == title)
2635
        .ok_or_else(|| not_found("no such milestone"))?;
2636
    let new_title = body.title.as_deref().map(str::trim).unwrap_or(&m.title);
2637
    if new_title.is_empty() || new_title.len() > 100 {
2638
        return Err(ApiError(StatusCode::BAD_REQUEST, "a milestone has a title of 1 to 100 characters".into()));
2639
    }
2640
    let due_ms = match body.due.as_deref() {
2641
        Some(d) => due_ms_of(d)?,
2642
        None => m.due_ms,
2643
    };
2644
    let description = body.description.as_deref().map(str::trim).unwrap_or(&m.description);
2645
    if body.title.is_some() || body.description.is_some() || body.due.is_some() {
2646
        db::issues::update_milestone(&app.db, m.id, new_title, description, due_ms).await?;
2647
    }
2648
    if let Some(state) = body.state.as_deref() {
2649
        match state {
2650
            "open" | "closed" => db::issues::set_milestone_state(&app.db, m.id, state).await?,
2651
            other => return Err(ApiError(StatusCode::BAD_REQUEST, format!("state {other:?} is open or closed"))),
2652
        }
2653
    }
2654
    let fresh = db::issues::milestone(&app.db, m.id).await?.ok_or_else(|| not_found("no such milestone"))?;
2655
    let (open, closed) = db::issues::milestone_counts(&app.db, fresh.id).await?;
2656
    Ok(Json(milestone_of(fresh, open, closed)))
2657
}
2658
2659
// --------------------------------------------------------- hooks, checks
2660
2661
fn hook_of(h: &db::hooks::Hook) -> Hook {
2662
    Hook { id: h.id, url: h.url.clone(), events: h.events.clone(), active: h.active, created_ms: h.created_ms }
2663
}
2664
2665
async fn hooks(
2666
    State(app): State<Shared>,
2667
    headers: HeaderMap,
2668
    Path((owner, name)): Path<(String, String)>,
2669
) -> Result<Json<Vec<Hook>>, ApiError> {
2670
    let c = caller(&app, &headers).await?;
2671
    c.require("hooks:admin").or_else(|_| c.require("repo:admin"))?;
2672
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Admin).await?;
2673
    Ok(Json(db::hooks::hooks_for_repo(&app.db, row.id).await?.iter().map(hook_of).collect()))
2674
}
2675
2676
async fn create_hook(
2677
    State(app): State<Shared>,
2678
    headers: HeaderMap,
2679
    Path((owner, name)): Path<(String, String)>,
2680
    Json(body): Json<NewHook>,
2681
) -> Result<(StatusCode, Json<Hook>), ApiError> {
2682
    let c = caller(&app, &headers).await?;
2683
    let me = c.require("hooks:admin").or_else(|_| c.require("repo:admin"))?.clone();
2684
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Admin).await?;
2685
    if !(body.url.starts_with("http://") || body.url.starts_with("https://")) {
2686
        return Err(ApiError(StatusCode::BAD_REQUEST, "the URL must be http or https".into()));
2687
    }
2688
    let h = db::hooks::create_hook(&app.db, Some(row.id), None, &body.url, &body.secret, &body.events).await?;
2689
    db::accounts::audit(&app.db, Some(&me), "hook.created", &row.slug(), &body.url).await.ok();
2690
    Ok((StatusCode::CREATED, Json(hook_of(&h))))
2691
}
2692
2693
async fn delete_hook(
2694
    State(app): State<Shared>,
2695
    headers: HeaderMap,
2696
    Path((owner, name, id)): Path<(String, String, i64)>,
2697
) -> Result<StatusCode, ApiError> {
2698
    let c = caller(&app, &headers).await?;
2699
    c.require("hooks:admin").or_else(|_| c.require("repo:admin"))?;
2700
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Admin).await?;
2701
    if db::hooks::hook(&app.db, id).await?.is_some_and(|h| h.repo_id == Some(row.id)) {
2702
        db::hooks::delete_hook(&app.db, id).await?;
2703
    }
2704
    Ok(StatusCode::NO_CONTENT)
2705
}
2706
2707
pub fn check_of(c: &db::hooks::Check) -> Check {
2708
    Check {
2709
        state: c.state.clone(),
2710
        name: c.name.clone(),
2711
        status: CheckStatus::parse(&c.status).unwrap_or(CheckStatus::Queued),
2712
        summary: c.summary.clone(),
2713
        url: c.url.clone(),
2714
        reporter: c.reporter.clone(),
2715
        seal: if c.seal.is_empty() { None } else { Some(c.seal.clone()) },
2716
        started_ms: c.started_ms,
2717
        finished_ms: c.finished_ms,
2718
    }
2719
}
2720
2721
/// `GET /repos/{o}/{n}/checks/required`.
2722
async fn required_checks(
2723
    State(app): State<Shared>,
2724
    headers: HeaderMap,
2725
    Path((owner, name)): Path<(String, String)>,
2726
) -> Result<Json<RequiredChecks>, ApiError> {
2727
    let c = caller(&app, &headers).await?;
2728
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
2729
    Ok(Json(RequiredChecks { names: db::hooks::required_checks(&app.db, row.id).await? }))
2730
}
2731
2732
/// `PUT /repos/{o}/{n}/checks/required` (repository admin): the whole list.
2733
async fn set_required_checks(
2734
    State(app): State<Shared>,
2735
    headers: HeaderMap,
2736
    Path((owner, name)): Path<(String, String)>,
2737
    Json(body): Json<RequiredChecks>,
2738
) -> Result<Json<RequiredChecks>, ApiError> {
2739
    let c = caller(&app, &headers).await?;
2740
    c.require("repo:admin")?;
2741
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Admin).await?;
2742
    let mut names: Vec<String> = body.names.iter().map(|n| n.trim().to_string()).filter(|n| !n.is_empty()).collect();
2743
    names.sort();
2744
    names.dedup();
2745
    if names.len() > 32 || names.iter().any(|n| n.len() > 100 || n.contains(',')) {
2746
        return Err(ApiError(StatusCode::BAD_REQUEST, "at most 32 check names, each under 100 characters and without commas".into()));
2747
    }
2748
    db::hooks::set_required_checks(&app.db, row.id, &names).await?;
2749
    db::accounts::audit(&app.db, c.account.as_ref(), "repo.required_checks", &format!("{owner}/{name}"), &names.join(", ")).await.ok();
2750
    Ok(Json(RequiredChecks { names }))
2751
}
2752
2753
fn flow_run_of(
2754
    app: &Shared,
2755
    row: &db::repos::RepoRow,
2756
    r: &db::flow::Run,
2757
    jobs: Vec<db::flow::Job>,
2758
    queue: &[db::flow::QueueEntry],
2759
) -> FlowRun {
2760
    FlowRun {
2761
        queue_position: crate::flow::queue_info(queue, row.id, r.id).position.map(|p| p as i64),
2762
        number: r.number,
2763
        bookmark: r.bookmark.clone(),
2764
        state: r.state.clone(),
2765
        heads: r.head_list().into_iter().map(String::from).collect(),
2766
        status: r.status.clone(),
2767
        trigger: r.trigger_label(),
2768
        actor: r.actor.clone(),
2769
        pipeline_hash: r.pipeline_hash.clone(),
2770
        error: r.error.clone(),
2771
        created_ms: r.created_ms,
2772
        finished_ms: r.finished_ms,
2773
        url: format!("{}/{}/{}/flow/{}", app.config.base_url(), row.owner, row.name, r.number),
2774
        jobs: jobs
2775
            .into_iter()
2776
            .map(|j| FlowJob {
2777
                phases: j.phase_list().into_iter().map(|(name, ms)| hub_api::FlowPhase { name, ms }).collect(),
2778
                queued_ms: j.queued_ms,
2779
                ready_ms: j.ready_ms,
2780
                peak_disk_mib: j.peak_disk_mib,
2781
                peak_memory_mib: j.peak_memory_mib,
2782
                depends_on: j.depends_on(),
2783
                name: j.name,
2784
                status: j.status,
2785
                runner: j.runner,
2786
                exit_code: j.exit_code,
2787
                error: j.error,
2788
                started_ms: j.started_ms,
2789
                finished_ms: j.finished_ms,
2790
                log_lines: j.log_count,
2791
                waiting: j.waiting,
2792
                placed: j.placed,
2793
                approval: j.approval,
2794
            })
2795
            .collect(),
2796
    }
2797
}
2798
2799
#[derive(Deserialize)]
2800
struct RunsPage {
2801
    /// Runs numbered below this one (the next page).
2802
    before: Option<i64>,
2803
    limit: Option<i64>,
2804
}
2805
2806
/// `GET /repos/{o}/{n}/flow/runs`: newest first, `?before=N&limit=` (max 100).
2807
async fn flow_runs(
2808
    State(app): State<Shared>,
2809
    headers: HeaderMap,
2810
    Path((owner, name)): Path<(String, String)>,
2811
    Query(q): Query<RunsPage>,
2812
) -> Result<Json<Vec<FlowRun>>, ApiError> {
2813
    let c = caller(&app, &headers).await?;
2814
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
2815
    let limit = q.limit.unwrap_or(30).clamp(1, 100);
2816
    let runs = db::flow::runs_by_number(&app.db, row.id, limit, q.before).await?;
2817
    let queue = if runs.iter().any(|r| r.live()) { db::flow::queue(&app.db).await? } else { vec![] };
2818
    Ok(Json(runs.iter().map(|r| flow_run_of(&app, &row, r, vec![], &queue)).collect()))
2819
}
2820
2821
/// `GET /repos/{o}/{n}/flow/runs/{number}`: a run with its jobs.
2822
async fn flow_run(
2823
    State(app): State<Shared>,
2824
    headers: HeaderMap,
2825
    Path((owner, name, number)): Path<(String, String, i64)>,
2826
) -> Result<Json<FlowRun>, ApiError> {
2827
    let c = caller(&app, &headers).await?;
2828
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
2829
    let run = db::flow::run(&app.db, row.id, number).await?.ok_or_else(|| ApiError(StatusCode::NOT_FOUND, "no such run".into()))?;
2830
    let jobs = db::flow::jobs(&app.db, run.id).await?;
2831
    let queue = if run.live() { db::flow::queue(&app.db).await? } else { vec![] };
2832
    Ok(Json(flow_run_of(&app, &row, &run, jobs, &queue)))
2833
}
2834
2835
#[derive(Deserialize)]
2836
struct LogPage {
2837
    /// Lines after this `seq`.
2838
    #[serde(default)]
2839
    after: i64,
2840
    limit: Option<i64>,
2841
}
2842
2843
/// `GET /repos/{o}/{n}/flow/runs/{number}/jobs/{job}/log`: `?after=seq&limit=` (max 5000).
2844
async fn flow_job_log(
2845
    State(app): State<Shared>,
2846
    headers: HeaderMap,
2847
    Path((owner, name, number, job)): Path<(String, String, i64, String)>,
2848
    Query(q): Query<LogPage>,
2849
) -> Result<Json<Vec<FlowLogLine>>, ApiError> {
2850
    let c = caller(&app, &headers).await?;
2851
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
2852
    let run = db::flow::run(&app.db, row.id, number).await?.ok_or_else(|| ApiError(StatusCode::NOT_FOUND, "no such run".into()))?;
2853
    let j = db::flow::jobs(&app.db, run.id)
2854
        .await?
2855
        .into_iter()
2856
        .find(|j| j.name == job)
2857
        .ok_or_else(|| ApiError(StatusCode::NOT_FOUND, "no such job".into()))?;
2858
    let lines = db::flow::log(&app.db, j.id, q.after, q.limit.unwrap_or(1000).clamp(1, 5000)).await?;
2859
    Ok(Json(lines.into_iter().map(|l| FlowLogLine { seq: l.seq, t: l.t, stream: l.stream, text: l.text }).collect()))
2860
}
2861
2862
#[derive(Deserialize)]
2863
struct StartRun {
2864
    /// Default: the repository's default bookmark.
2865
    #[serde(default)]
2866
    bookmark: Option<String>,
2867
    /// A change's full hash: run the state whose only head it is, instead
2868
    /// of a bookmark's.
2869
    #[serde(default)]
2870
    change: Option<String>,
2871
    /// Only these jobs, with what they depend on (oxygenhub#130); default:
2872
    /// every job a manual run starts.
2873
    #[serde(default)]
2874
    jobs: Vec<String>,
2875
}
2876
2877
fn started(app: &Shared, row: &db::repos::RepoRow, number: i64) -> (StatusCode, Json<serde_json::Value>) {
2878
    let url = format!("{}/{}/{}/flow/{number}", app.config.base_url(), row.owner, row.name);
2879
    (StatusCode::CREATED, Json(serde_json::json!({ "number": number, "url": url })))
2880
}
2881
2882
/// `POST /repos/{o}/{n}/flow/runs` (repo:write): run a bookmark's current
2883
/// state, or one change's, without moving anything (hub spec §13.2).
2884
async fn start_flow_run(
2885
    State(app): State<Shared>,
2886
    headers: HeaderMap,
2887
    Path((owner, name)): Path<(String, String)>,
2888
    Json(body): Json<StartRun>,
2889
) -> Result<(StatusCode, Json<serde_json::Value>), ApiError> {
2890
    let c = caller(&app, &headers).await?;
2891
    let me = c.require("repo:write")?.clone();
2892
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Write).await?;
2893
    let (n, what) = match body.change.clone().filter(|c| !c.trim().is_empty()) {
2894
        Some(change) => {
2895
            let n = crate::flow::run_change(&app, &row, &change, &me.username, &body.jobs)
2896
                .await
2897
                .map_err(|m| ApiError(StatusCode::CONFLICT, m))?;
2898
            (n, format!("change {}", change.trim()))
2899
        }
2900
        None => {
2901
            let bookmark = body.bookmark.unwrap_or_else(|| row.default_bookmark.clone());
2902
            (
2903
                crate::flow::run_bookmark(&app, &row, &bookmark, &me.username, &body.jobs)
2904
                    .await
2905
                    .map_err(|m| ApiError(StatusCode::CONFLICT, m))?,
2906
                bookmark,
2907
            )
2908
        }
2909
    };
2910
    db::accounts::audit(&app.db, Some(&me), "flow.run", &format!("{owner}/{name}"), &format!("#{n} {what}")).await.ok();
2911
    Ok(started(&app, &row, n))
2912
}
2913
2914
/// `POST /repos/{o}/{n}/flow/runs/{number}/rerun` (repo:write).
2915
async fn rerun_flow_run(
2916
    State(app): State<Shared>,
2917
    headers: HeaderMap,
2918
    Path((owner, name, number)): Path<(String, String, i64)>,
2919
) -> Result<(StatusCode, Json<serde_json::Value>), ApiError> {
2920
    let c = caller(&app, &headers).await?;
2921
    let me = c.require("repo:write")?.clone();
2922
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Write).await?;
2923
    let run = db::flow::run(&app.db, row.id, number).await?.ok_or_else(|| ApiError(StatusCode::NOT_FOUND, "no such run".into()))?;
2924
    let n = crate::flow::rerun(&app, &row, &run, &me.username).await.map_err(|m| ApiError(StatusCode::CONFLICT, m))?;
2925
    db::accounts::audit(&app.db, Some(&me), "flow.rerun", &format!("{owner}/{name}"), &format!("#{n} of #{number}")).await.ok();
2926
    Ok(started(&app, &row, n))
2927
}
2928
2929
/// `POST /repos/{o}/{n}/flow/runs/{number}/jobs/{job}/rerun` (repo:write,
2930
/// oxygenflow#31): that job again, with the jobs that depend on it, in the
2931
/// same run. Answers with how many jobs were queued.
2932
async fn rerun_flow_job(
2933
    State(app): State<Shared>,
2934
    headers: HeaderMap,
2935
    Path((owner, name, number, job)): Path<(String, String, i64, String)>,
2936
) -> Result<Json<serde_json::Value>, ApiError> {
2937
    let c = caller(&app, &headers).await?;
2938
    let me = c.require("repo:write")?.clone();
2939
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Write).await?;
2940
    let run = db::flow::run(&app.db, row.id, number).await?.ok_or_else(|| ApiError(StatusCode::NOT_FOUND, "no such run".into()))?;
2941
    let n = crate::flow::rerun_job(&app, &row, &run, &job, &me.username).await.map_err(|m| ApiError(StatusCode::CONFLICT, m))?;
2942
    db::accounts::audit(&app.db, Some(&me), "flow.rerun", &format!("{owner}/{name}"), &format!("{job} of #{number}")).await.ok();
2943
    Ok(Json(serde_json::json!({ "run": number, "job": job, "queued": n })))
2944
}
2945
2946
/// `POST /repos/{o}/{n}/flow/runs/{number}/cancel` (repo:write): answers
2947
/// with the run as it now stands.
2948
async fn cancel_flow_run(
2949
    State(app): State<Shared>,
2950
    headers: HeaderMap,
2951
    Path((owner, name, number)): Path<(String, String, i64)>,
2952
) -> Result<Json<serde_json::Value>, ApiError> {
2953
    let c = caller(&app, &headers).await?;
2954
    let me = c.require("repo:write")?.clone();
2955
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Write).await?;
2956
    let run = db::flow::run(&app.db, row.id, number).await?.ok_or_else(|| ApiError(StatusCode::NOT_FOUND, "no such run".into()))?;
2957
    crate::flow::cancel(&app, &row, &run, &me.username).await.map_err(|m| ApiError(StatusCode::CONFLICT, m))?;
2958
    db::accounts::audit(&app.db, Some(&me), "flow.cancel", &format!("{owner}/{name}"), &format!("#{number}")).await.ok();
2959
    Ok(Json(serde_json::json!({ "number": number, "status": "cancelled" })))
2960
}
2961
2962
/// `GET /repos/{o}/{n}/deployments`: deployments, newest first
2963
/// (oxygenflow#59).
2964
async fn list_deployments(
2965
    State(app): State<Shared>,
2966
    headers: HeaderMap,
2967
    Path((owner, name)): Path<(String, String)>,
2968
) -> Result<Json<Vec<serde_json::Value>>, ApiError> {
2969
    let c = caller(&app, &headers).await?;
2970
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
2971
    let list = db::flow::deployments(&app.db, row.id, 100).await?;
2972
    Ok(Json(
2973
        list.into_iter()
2974
            .map(|d| {
2975
                serde_json::json!({ "environment": d.environment, "job": d.job, "run": d.run_number, "state": d.state,
2976
                    "bookmark": d.bookmark, "actor": d.actor, "approved_by": d.approved_by, "finished_ms": d.finished_ms })
2977
            })
2978
            .collect(),
2979
    ))
2980
}
2981
2982
#[derive(Deserialize)]
2983
struct ExpediteBody {
2984
    reason: String,
2985
}
2986
2987
/// `POST /repos/{o}/{n}/flow/runs/{number}/expedite {"reason": …}`
2988
/// (oxygenhub#244): a maintainer makes a queued or running run urgent, as
2989
/// the run page's Expedite does, within the owner's cap of urgent runs.
2990
async fn expedite_flow_run(
2991
    State(app): State<Shared>,
2992
    headers: HeaderMap,
2993
    Path((owner, name, number)): Path<(String, String, i64)>,
2994
    Json(body): Json<ExpediteBody>,
2995
) -> Result<Json<serde_json::Value>, ApiError> {
2996
    let c = caller(&app, &headers).await?;
2997
    let me = c.require("repo:write")?.clone();
2998
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Maintain).await?;
2999
    let run = db::flow::run(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such run"))?;
3000
    crate::flow::expedite(&app, &row, &run, &me, &body.reason).await.map_err(|m| ApiError(StatusCode::CONFLICT, m))?;
3001
    Ok(Json(serde_json::json!({ "number": number, "expedited": true })))
3002
}
3003
3004
/// `POST /repos/{o}/{n}/flow/runs/{number}/jobs/{job}/approve` and
3005
/// `.../reject` (oxygenflow#57): the job's approval rules decide who may.
3006
async fn approve_flow_job(
3007
    State(app): State<Shared>,
3008
    headers: HeaderMap,
3009
    Path((owner, name, number, job)): Path<(String, String, i64, String)>,
3010
) -> Result<Json<serde_json::Value>, ApiError> {
3011
    decide_flow_job(&app, &headers, &owner, &name, number, &job, true).await
3012
}
3013
3014
async fn reject_flow_job(
3015
    State(app): State<Shared>,
3016
    headers: HeaderMap,
3017
    Path((owner, name, number, job)): Path<(String, String, i64, String)>,
3018
) -> Result<Json<serde_json::Value>, ApiError> {
3019
    decide_flow_job(&app, &headers, &owner, &name, number, &job, false).await
3020
}
3021
3022
/// `GET .../flow/runs/{n}/jobs/{job}/approval`: what approving the job
3023
/// means, for `oxy seal --flow` to sign (oxygenhub#235).
3024
async fn flow_job_statement(
3025
    State(app): State<Shared>,
3026
    headers: HeaderMap,
3027
    Path((owner, name, number, job)): Path<(String, String, i64, String)>,
3028
) -> Result<Json<serde_json::Value>, ApiError> {
3029
    let c = caller(&app, &headers).await?;
3030
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
3031
    let run = db::flow::run(&app.db, row.id, number).await?.ok_or_else(|| ApiError(StatusCode::NOT_FOUND, "no such run".into()))?;
3032
    let (s, j) = crate::flow::approval_statement(&app, &row, &run, &job).await.map_err(|m| ApiError(StatusCode::CONFLICT, m))?;
3033
    Ok(Json(serde_json::json!({
3034
        "repo": hex::encode(s.repo),
3035
        "run": s.run,
3036
        "job": s.job,
3037
        "job_hash": s.job_hash.to_hex(),
3038
        "state": s.state.to_hex(),
3039
        "inputs": s.inputs.iter().map(|i| i.to_hex()).collect::<Vec<_>>(),
3040
        "environment": s.environment,
3041
        "waiting": j.approval == "waiting" && j.status == "queued",
3042
    })))
3043
}
3044
3045
#[derive(Deserialize)]
3046
struct SealBody {
3047
    signed: String,
3048
}
3049
3050
/// `POST .../flow/runs/{n}/jobs/{job}/seal` `{"signed": hex}`: approve or
3051
/// reject with a signed approval (oxygenhub#235). The signature, not the
3052
/// caller, says who decided; the caller must be signed in.
3053
async fn seal_flow_job(
3054
    State(app): State<Shared>,
3055
    headers: HeaderMap,
3056
    Path((owner, name, number, job)): Path<(String, String, i64, String)>,
3057
    Json(body): Json<SealBody>,
3058
) -> Result<Json<serde_json::Value>, ApiError> {
3059
    let c = caller(&app, &headers).await?;
3060
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
3061
    let run = db::flow::run(&app.db, row.id, number).await?.ok_or_else(|| ApiError(StatusCode::NOT_FOUND, "no such run".into()))?;
3062
    let said = crate::flow::decide_sealed(&app, &row, &run, &job, &body.signed).await.map_err(|m| ApiError(StatusCode::CONFLICT, m))?;
3063
    Ok(Json(serde_json::json!({ "number": number, "job": job, "said": said })))
3064
}
3065
3066
async fn decide_flow_job(
3067
    app: &Shared,
3068
    headers: &HeaderMap,
3069
    owner: &str,
3070
    name: &str,
3071
    number: i64,
3072
    job: &str,
3073
    approve: bool,
3074
) -> Result<Json<serde_json::Value>, ApiError> {
3075
    let c = caller(app, headers).await?;
3076
    let me = c.require("repo:write")?.clone();
3077
    let (_, row, _) = reach(app, &c, owner, name, Access::Read).await?;
3078
    let run = db::flow::run(&app.db, row.id, number).await?.ok_or_else(|| ApiError(StatusCode::NOT_FOUND, "no such run".into()))?;
3079
    let via = c.agent.then_some(c.token.as_str());
3080
    let said = crate::flow::decide(app, &row, &run, job, &me, approve, via).await.map_err(|m| ApiError(StatusCode::CONFLICT, m))?;
3081
    Ok(Json(serde_json::json!({ "number": number, "job": job, "decision": if approve { "approved" } else { "rejected" }, "said": said })))
3082
}
3083
3084
/// `POST /repos/{o}/{n}/checks`: any `checks:write` (or write) token may
3085
/// report; the state hash names what was checked.
3086
async fn post_check(
3087
    State(app): State<Shared>,
3088
    headers: HeaderMap,
3089
    Path((owner, name)): Path<(String, String)>,
3090
    Json(body): Json<NewCheck>,
3091
) -> Result<(StatusCode, Json<Check>), ApiError> {
3092
    let c = caller(&app, &headers).await?;
3093
    let me = c.require("checks:write").or_else(|_| c.require("repo:write"))?.clone();
3094
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
3095
    if body.state.len() != 64 || !body.state.chars().all(|ch| ch.is_ascii_hexdigit()) {
3096
        return Err(ApiError(StatusCode::BAD_REQUEST, "state is a 64-character hex state hash".into()));
3097
    }
3098
    if body.name.trim().is_empty() || body.name.len() > 100 {
3099
        return Err(ApiError(StatusCode::BAD_REQUEST, "a check has a short name".into()));
3100
    }
3101
    let ch = db::hooks::upsert_check(
3102
        &app.db,
3103
        row.id,
3104
        db::hooks::CheckReport {
3105
            state: &body.state,
3106
            name: body.name.trim(),
3107
            status: body.status.as_str(),
3108
            summary: &body.summary,
3109
            url: &body.url,
3110
            reporter: Some((me.id, &me.username)),
3111
            seal: body.seal.as_deref().unwrap_or(""),
3112
        },
3113
    )
3114
    .await?;
3115
    let api = check_of(&ch);
3116
    app.bus.proposal(row.id, ProposalEvent { number: 0, kind: "check".into(), check: Some(api.clone()) });
3117
    crate::hooks::emit(&app, &row, "check", &me.username, serde_json::json!({ "check": api })).await;
3118
    Ok((StatusCode::CREATED, Json(api)))
3119
}
3120
3121
async fn checks_for_state(
3122
    State(app): State<Shared>,
3123
    headers: HeaderMap,
3124
    Path((owner, name, state)): Path<(String, String, String)>,
3125
) -> Result<Json<Vec<Check>>, ApiError> {
3126
    let c = caller(&app, &headers).await?;
3127
    let (repo, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
3128
    let state = state_key(&app, &repo, &state).await?;
3129
    Ok(Json(db::hooks::checks_for_state(&app.db, row.id, &state).await?.iter().map(check_of).collect()))
3130
}
3131
3132
/// The state hash checks are keyed by, from what a client has: a state
3133
/// hash, its heads (full change hashes joined with `+`, or the one head of
3134
/// a single-head state, which is what `oxy log` shows), or a bookmark.
3135
async fn state_key(app: &Shared, repo: &RepoName, s: &str) -> Result<String, ApiError> {
3136
    use oxy_core::hash::{hash_object, ChangeHash, ObjectType};
3137
    let hexes: Vec<&str> = s.split('+').collect();
3138
    let all_hashes = hexes.iter().all(|h| h.len() == 64 && h.bytes().all(|b| b.is_ascii_hexdigit()));
3139
    if all_hashes {
3140
        let row = db::repos::get(&app.db, &repo.owner, &repo.name).await?.ok_or_else(|| not_found("no such repository"))?;
3141
        if hexes.len() == 1 && !db::hooks::checks_for_state(&app.db, row.id, s).await?.is_empty() {
3142
            return Ok(s.to_string());
3143
        }
3144
        let heads: Vec<ChangeHash> = hexes.iter().filter_map(|h| ChangeHash::from_hex(h)).collect();
3145
        return Ok(hash_object(ObjectType::State, &oxy_core::objects::StateObject::new(heads).encode()).to_hex());
3146
    }
3147
    let b = s.to_string();
3148
    let found = app.repos.read(repo, move |r, _| Ok(r.view()?.bookmarks.get(&b).copied())).await?;
3149
    found.map(|st| st.to_hex()).ok_or_else(|| ApiError(StatusCode::NOT_FOUND, format!("{s:?} is not a state hash, heads or a bookmark")))
3150
}
3151
3152
// ----------------------------------------------------------------- runners
3153
3154
/// Site administrators only, with any token of theirs (hub spec §13.2).
3155
fn require_site_admin(c: &Caller) -> Result<&Account, ApiError> {
3156
    match c.account.as_ref() {
3157
        Some(a) if a.is_admin => Ok(a),
3158
        _ => Err(not_found("no such API route")),
3159
    }
3160
}
3161
3162
/// `GET /api/v1/admin/runner-updates` (oxygenhub#322, #326).
3163
async fn runner_updates(State(app): State<Shared>, headers: HeaderMap) -> Result<Json<RunnerUpdates>, ApiError> {
3164
    let c = caller(&app, &headers).await?;
3165
    require_site_admin(&c)?;
3166
    use crate::web::runner_updates::{views, Reach};
3167
    let v = views(&app, &Reach::Site).await?;
3168
    let setting = |p: &crate::web::runner_updates::PolicyView| UpdateSetting {
3169
        scope: p.scope.clone(),
3170
        key: p.key.clone(),
3171
        updates: match p.updates {
3172
            "on" => Some(true),
3173
            "off" => Some(false),
3174
            _ => None,
3175
        },
3176
        channel: Some(p.channel.clone()).filter(|c| !c.is_empty()),
3177
        window: Some(p.window.clone()).filter(|w| !w.is_empty()),
3178
        dry_run: match p.dry_run {
3179
            "on" => Some(true),
3180
            "off" => Some(false),
3181
            _ => None,
3182
        },
3183
    };
3184
    let mut settings = vec![setting(&v.site)];
3185
    settings.extend(v.owners.iter().map(setting));
3186
    settings.extend(v.groups.iter().map(|g| setting(&g.policy)));
3187
    settings.extend(v.runners.iter().map(|r| setting(&r.policy)));
3188
    settings.retain(|s| s.scope == "site" || s.updates.is_some() || s.channel.is_some() || s.window.is_some() || s.dry_run.is_some());
3189
    Ok(Json(RunnerUpdates {
3190
        repo: db::accounts::setting(&app.db, crate::runner_updates::SETTING_REPO).await?.unwrap_or_default(),
3191
        settings,
3192
        groups: v
3193
            .groups
3194
            .iter()
3195
            .map(|g| RunnerGroup {
3196
                id: g.g.id,
3197
                owner: g.g.owner.clone(),
3198
                name: g.g.name.clone(),
3199
                percent: g.g.percent,
3200
                members: g.members.clone(),
3201
                wave: g.g.wave,
3202
            })
3203
            .collect(),
3204
        runners: v
3205
            .runners
3206
            .iter()
3207
            .map(|r| RunnerUpdate {
3208
                id: r.r.id,
3209
                name: r.r.name.clone(),
3210
                owner: r.r.scope_owner.clone(),
3211
                version: r.r.version.clone(),
3212
                groups: r.groups.clone(),
3213
                updates: r.effective.updates,
3214
                channel: r.effective.channel.clone(),
3215
                window: r.effective.window.map(|(a, b)| format!("{a:02}-{b:02}")),
3216
                dry_run: r.effective.dry_run,
3217
                from: r.effective.from.clone(),
3218
                now: r.offer.clone(),
3219
                said: r.r.update_note.clone(),
3220
            })
3221
            .collect(),
3222
        holds: db::runner_updates::holds(&app.db)
3223
            .await?
3224
            .into_iter()
3225
            .map(|h| HeldBuild { version: h.version, runner: h.runner, why: h.why, at_ms: h.at_ms })
3226
            .collect(),
3227
    }))
3228
}
3229
3230
/// `PUT /api/v1/admin/runner-updates/settings`: one level's settings; what
3231
/// it set, in words, or 422 saying what is wrong.
3232
async fn runner_update_setting(
3233
    State(app): State<Shared>,
3234
    headers: HeaderMap,
3235
    Json(u): Json<UpdateSetting>,
3236
) -> Result<Json<serde_json::Value>, ApiError> {
3237
    let c = caller(&app, &headers).await?;
3238
    let me = require_site_admin(&c)?.clone();
3239
    use crate::web::runner_updates::{apply_policy, PolicyForm, Reach};
3240
    match apply_policy(&app, &me, &Reach::Site, &PolicyForm::of(&u)).await? {
3241
        Ok(notice) => Ok(Json(serde_json::json!({ "notice": notice }))),
3242
        Err(why) => Err(ApiError(StatusCode::UNPROCESSABLE_ENTITY, why)),
3243
    }
3244
}
3245
3246
/// `POST /api/v1/admin/runner-updates/holds/{version}/lift` (#326).
3247
async fn runner_update_lift(State(app): State<Shared>, headers: HeaderMap, Path(version): Path<String>) -> Result<StatusCode, ApiError> {
3248
    let c = caller(&app, &headers).await?;
3249
    let me = require_site_admin(&c)?.clone();
3250
    if !db::runner_updates::lift(&app.db, &version).await? {
3251
        return Err(not_found("that build is not held"));
3252
    }
3253
    db::accounts::audit(&app.db, Some(&me), "runner.update.lifted", &version, "offered again").await.ok();
3254
    Ok(StatusCode::NO_CONTENT)
3255
}
3256
3257
async fn runner_of(app: &Shared, r: db::runners::Runner, running: i64) -> hub_api::Runner {
3258
    let serves = match r.scope_repo_id {
3259
        Some(id) => db::repos::get_by_id(&app.db, id).await.ok().flatten().map(|p| p.slug()).unwrap_or_default(),
3260
        None => r.scope_owner.clone(),
3261
    };
3262
    hub_api::Runner {
3263
        id: r.id,
3264
        status: r.status().to_string(),
3265
        serves,
3266
        labels: r.label_list().into_iter().map(String::from).collect(),
3267
        name: r.name,
3268
        arch: r.arch,
3269
        os: r.os,
3270
        version: r.version,
3271
        max_jobs: r.max_jobs,
3272
        memory_mib: r.memory_mib,
3273
        cpus: r.cpus,
3274
        key: r.key,
3275
        source: r.source,
3276
        last_seen_ms: r.last_seen_ms,
3277
        running,
3278
        free_disk_mib: r.free_disk_mib,
3279
        load_x100: r.load_x100,
3280
        speed: r.speed,
3281
        speed_class: r.speed_class,
3282
        kernel: r.kernel,
3283
    }
3284
}
3285
3286
/// `GET /api/v1/runners`.
3287
async fn runners(State(app): State<Shared>, headers: HeaderMap) -> Result<Json<Vec<hub_api::Runner>>, ApiError> {
3288
    let c = caller(&app, &headers).await?;
3289
    require_site_admin(&c)?;
3290
    let running: std::collections::HashMap<i64, i64> = db::runners::running(&app.db).await?.into_iter().collect();
3291
    let mut out = Vec::new();
3292
    for r in db::runners::list(&app.db).await? {
3293
        let n = running.get(&r.id).copied().unwrap_or(0);
3294
        out.push(runner_of(&app, r, n).await);
3295
    }
3296
    Ok(Json(out))
3297
}
3298
3299
#[derive(Deserialize)]
3300
struct BeforeQuery {
3301
    #[serde(default)]
3302
    before: Option<i64>,
3303
    #[serde(default)]
3304
    limit: Option<i64>,
3305
}
3306
3307
/// `GET /api/v1/runners/{id}/jobs?before=MS&limit=N`: newest first.
3308
async fn runner_jobs(
3309
    State(app): State<Shared>,
3310
    headers: HeaderMap,
3311
    Path(id): Path<i64>,
3312
    Query(q): Query<BeforeQuery>,
3313
) -> Result<Json<Vec<hub_api::RunnerJob>>, ApiError> {
3314
    let c = caller(&app, &headers).await?;
3315
    require_site_admin(&c)?;
3316
    db::runners::get(&app.db, id).await?.ok_or_else(|| not_found("no such runner"))?;
3317
    let jobs = db::runners::history(&app.db, id, q.limit.unwrap_or(50).clamp(1, 200), q.before).await?;
3318
    Ok(Json(
3319
        jobs.into_iter()
3320
            .map(|j| hub_api::RunnerJob {
3321
                repo: format!("{}/{}", j.owner, j.repo),
3322
                run: j.run_number,
3323
                job: j.job,
3324
                status: j.status,
3325
                started_ms: j.started_ms,
3326
                finished_ms: j.finished_ms,
3327
            })
3328
            .collect(),
3329
    ))
3330
}
3331
3332
/// `GET /api/v1/runners/queue`: running jobs, then queued ones in claim order.
3333
async fn runner_queue(State(app): State<Shared>, headers: HeaderMap) -> Result<Json<Vec<hub_api::QueueItem>>, ApiError> {
3334
    let c = caller(&app, &headers).await?;
3335
    require_site_admin(&c)?;
3336
    Ok(Json(
3337
        db::flow::queue(&app.db)
3338
            .await?
3339
            .into_iter()
3340
            .map(|e| hub_api::QueueItem {
3341
                repo: format!("{}/{}", e.owner, e.name),
3342
                run: e.run_number,
3343
                job: e.job,
3344
                status: e.status,
3345
                runner: e.runner,
3346
            })
3347
            .collect(),
3348
    ))
3349
}
3350
3351
/// `POST .../proposals/{number}/review-requests`: ask an AI assistant the
3352
/// repository may use to review (hub spec §13.4). Accepted at once; the
3353
/// answer arrives as a `comment` review via the assistant.
3354
async fn request_assistant(
3355
    State(app): State<Shared>,
3356
    headers: HeaderMap,
3357
    Path((owner, name, number)): Path<(String, String, i64)>,
3358
    Json(body): Json<hub_api::AssistantRequest>,
3359
) -> Result<(StatusCode, Json<hub_api::AssistantRequest>), ApiError> {
3360
    let c = caller(&app, &headers).await?;
3361
    let me = c.require("proposals:write").or_else(|_| c.require("repo:write"))?.clone();
3362
    let (_, row, role) = reach(&app, &c, &owner, &name, Access::Read).await?;
3363
    let p = db::proposals::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such proposal"))?;
3364
    if Some(me.id) != p.author_id && role < Role::Write {
3365
        return Err(forbidden("only the author or a writer asks for reviews"));
3366
    }
3367
    if !p.is_open() {
3368
        return Err(ApiError(StatusCode::CONFLICT, "the proposal is not open".into()));
3369
    }
3370
    let a = crate::assistants::enabled_for_repo(&app.db, &row)
3371
        .await?
3372
        .into_iter()
3373
        .find(|a| a.name.eq_ignore_ascii_case(body.assistant.trim()))
3374
        .ok_or_else(|| ApiError(StatusCode::UNPROCESSABLE_ENTITY, format!("no assistant called {} here", body.assistant.trim())))?;
3375
    let asked = hub_api::AssistantRequest { assistant: a.name.clone() };
3376
    crate::assistants::request_review(&app, &row, &p, &me, a).await.map_err(|e| ApiError(StatusCode::CONFLICT, e))?;
3377
    Ok((StatusCode::ACCEPTED, Json(asked)))
3378
}
3379
3380
// -------------------------------------------------------- assistants (§13.4)
3381
3382
use crate::levels::At;
3383
use crate::web::assistants as aa;
3384
3385
/// The level a repository's assistants live at, for its admins (repo:admin).
3386
async fn repo_level(app: &Shared, c: &Caller, owner: &str, name: &str) -> Result<(Account, At), ApiError> {
3387
    let me = c.require("repo:admin")?.clone();
3388
    let (_, row, _) = reach(app, c, owner, name, Access::Admin).await?;
3389
    Ok((me, At::repo(&row)))
3390
}
3391
3392
/// An organisation's level, for its owners (repo:admin).
3393
async fn org_level(app: &Shared, c: &Caller, org: &str) -> Result<(Account, At), ApiError> {
3394
    let me = c.require("repo:admin")?.clone();
3395
    let o = db::accounts::org_by_name(&app.db, org).await?.ok_or_else(|| not_found("no such organisation"))?;
3396
    if !auth::roles::is_org_owner(&app.db, &me, o.id).await? {
3397
        return Err(not_found("no such organisation"));
3398
    }
3399
    Ok((me, At::org(&o)))
3400
}
3401
3402
/// The site's level, for its administrators.
3403
fn site_level(c: &Caller) -> Result<(Account, At), ApiError> {
3404
    Ok((require_site_admin(c)?.clone(), At::site()))
3405
}
3406
3407
fn put_outcome(r: Result<String, String>) -> Result<(StatusCode, Json<serde_json::Value>), ApiError> {
3408
    match r {
3409
        Ok(msg) => Ok((StatusCode::OK, Json(serde_json::json!({ "ok": msg })))),
3410
        Err(e) => Err(ApiError(StatusCode::UNPROCESSABLE_ENTITY, e)),
3411
    }
3412
}
3413
3414
macro_rules! assistant_routes {
3415
    ($list:ident, $put:ident, $del:ident, $prompt:ident, $prompt_put:ident, ($($p:ident: $t:ty),*), $level:expr) => {
3416
        async fn $list(State(app): State<Shared>, headers: HeaderMap, Path(($($p),*)): Path<($($t),*)>) -> Result<Json<Vec<Assistant>>, ApiError> {
3417
            let c = caller(&app, &headers).await?;
3418
            let (_, at) = $level(&app, &c, $(&$p),*).await?;
3419
            Ok(Json(aa::api_list(&app, &at).await?))
3420
        }
3421
        async fn $put(
3422
            State(app): State<Shared>,
3423
            headers: HeaderMap,
3424
            Path(($($p),*)): Path<($($t),*)>,
3425
            Json(body): Json<NewAssistant>,
3426
        ) -> Result<(StatusCode, Json<serde_json::Value>), ApiError> {
3427
            let c = caller(&app, &headers).await?;
3428
            let (me, at) = $level(&app, &c, $(&$p),*).await?;
3429
            put_outcome(aa::api_put(&app, &me, &at, body).await?)
3430
        }
3431
        async fn $prompt(State(app): State<Shared>, headers: HeaderMap, Path(($($p),*)): Path<($($t),*)>) -> Result<Json<AssistantPrompt>, ApiError> {
3432
            let c = caller(&app, &headers).await?;
3433
            let (_, at) = $level(&app, &c, $(&$p),*).await?;
3434
            Ok(Json(aa::api_prompt(&app, &at).await?))
3435
        }
3436
        async fn $prompt_put(
3437
            State(app): State<Shared>,
3438
            headers: HeaderMap,
3439
            Path(($($p),*)): Path<($($t),*)>,
3440
            Json(body): Json<AssistantPrompt>,
3441
        ) -> Result<Json<AssistantPrompt>, ApiError> {
3442
            let c = caller(&app, &headers).await?;
3443
            let (me, at) = $level(&app, &c, $(&$p),*).await?;
3444
            aa::api_set_prompt(&app, &me, &at, &body.prompt).await?.map_err(|e| ApiError(StatusCode::UNPROCESSABLE_ENTITY, e))?;
3445
            Ok(Json(aa::api_prompt(&app, &at).await?))
3446
        }
3447
    };
3448
}
3449
3450
assistant_routes!(repo_assistants, repo_assistant_put, _rd, repo_prompt, repo_prompt_put, (owner: String, name: String), repo_level);
3451
3452
async fn repo_assistant_delete(
3453
    State(app): State<Shared>,
3454
    headers: HeaderMap,
3455
    Path((owner, name, assistant)): Path<(String, String, String)>,
3456
) -> Result<StatusCode, ApiError> {
3457
    let c = caller(&app, &headers).await?;
3458
    let (me, at) = repo_level(&app, &c, &owner, &name).await?;
3459
    if aa::api_delete(&app, &me, &at, &assistant).await? {
3460
        Ok(StatusCode::NO_CONTENT)
3461
    } else {
3462
        Err(not_found("no such assistant at this level"))
3463
    }
3464
}
3465
3466
async fn org_level_one(app: &Shared, c: &Caller, org: &str) -> Result<(Account, At), ApiError> {
3467
    org_level(app, c, org).await
3468
}
3469
3470
async fn org_assistants(State(app): State<Shared>, headers: HeaderMap, Path(org): Path<String>) -> Result<Json<Vec<Assistant>>, ApiError> {
3471
    let c = caller(&app, &headers).await?;
3472
    let (_, at) = org_level_one(&app, &c, &org).await?;
3473
    Ok(Json(aa::api_list(&app, &at).await?))
3474
}
3475
3476
async fn org_assistant_put(
3477
    State(app): State<Shared>,
3478
    headers: HeaderMap,
3479
    Path(org): Path<String>,
3480
    Json(body): Json<NewAssistant>,
3481
) -> Result<(StatusCode, Json<serde_json::Value>), ApiError> {
3482
    let c = caller(&app, &headers).await?;
3483
    let (me, at) = org_level_one(&app, &c, &org).await?;
3484
    put_outcome(aa::api_put(&app, &me, &at, body).await?)
3485
}
3486
3487
async fn org_assistant_delete(
3488
    State(app): State<Shared>,
3489
    headers: HeaderMap,
3490
    Path((org, assistant)): Path<(String, String)>,
3491
) -> Result<StatusCode, ApiError> {
3492
    let c = caller(&app, &headers).await?;
3493
    let (me, at) = org_level_one(&app, &c, &org).await?;
3494
    if aa::api_delete(&app, &me, &at, &assistant).await? {
3495
        Ok(StatusCode::NO_CONTENT)
3496
    } else {
3497
        Err(not_found("no such assistant at this level"))
3498
    }
3499
}
3500
3501
async fn org_prompt(State(app): State<Shared>, headers: HeaderMap, Path(org): Path<String>) -> Result<Json<AssistantPrompt>, ApiError> {
3502
    let c = caller(&app, &headers).await?;
3503
    let (_, at) = org_level_one(&app, &c, &org).await?;
3504
    Ok(Json(aa::api_prompt(&app, &at).await?))
3505
}
3506
3507
async fn org_prompt_put(
3508
    State(app): State<Shared>,
3509
    headers: HeaderMap,
3510
    Path(org): Path<String>,
3511
    Json(body): Json<AssistantPrompt>,
3512
) -> Result<Json<AssistantPrompt>, ApiError> {
3513
    let c = caller(&app, &headers).await?;
3514
    let (me, at) = org_level_one(&app, &c, &org).await?;
3515
    aa::api_set_prompt(&app, &me, &at, &body.prompt).await?.map_err(|e| ApiError(StatusCode::UNPROCESSABLE_ENTITY, e))?;
3516
    Ok(Json(aa::api_prompt(&app, &at).await?))
3517
}
3518
3519
async fn site_assistants(State(app): State<Shared>, headers: HeaderMap) -> Result<Json<Vec<Assistant>>, ApiError> {
3520
    let c = caller(&app, &headers).await?;
3521
    let (_, at) = site_level(&c)?;
3522
    Ok(Json(aa::api_list(&app, &at).await?))
3523
}
3524
3525
async fn site_assistant_put(
3526
    State(app): State<Shared>,
3527
    headers: HeaderMap,
3528
    Json(body): Json<NewAssistant>,
3529
) -> Result<(StatusCode, Json<serde_json::Value>), ApiError> {
3530
    let c = caller(&app, &headers).await?;
3531
    let (me, at) = site_level(&c)?;
3532
    put_outcome(aa::api_put(&app, &me, &at, body).await?)
3533
}
3534
3535
async fn site_assistant_delete(
3536
    State(app): State<Shared>,
3537
    headers: HeaderMap,
3538
    Path(assistant): Path<String>,
3539
) -> Result<StatusCode, ApiError> {
3540
    let c = caller(&app, &headers).await?;
3541
    let (me, at) = site_level(&c)?;
3542
    if aa::api_delete(&app, &me, &at, &assistant).await? {
3543
        Ok(StatusCode::NO_CONTENT)
3544
    } else {
3545
        Err(not_found("no such assistant at this level"))
3546
    }
3547
}
3548
3549
async fn site_prompt(State(app): State<Shared>, headers: HeaderMap) -> Result<Json<AssistantPrompt>, ApiError> {
3550
    let c = caller(&app, &headers).await?;
3551
    let (_, at) = site_level(&c)?;
3552
    Ok(Json(aa::api_prompt(&app, &at).await?))
3553
}
3554
3555
async fn site_prompt_put(
3556
    State(app): State<Shared>,
3557
    headers: HeaderMap,
3558
    Json(body): Json<AssistantPrompt>,
3559
) -> Result<Json<AssistantPrompt>, ApiError> {
3560
    let c = caller(&app, &headers).await?;
3561
    let (me, at) = site_level(&c)?;
3562
    aa::api_set_prompt(&app, &me, &at, &body.prompt).await?.map_err(|e| ApiError(StatusCode::UNPROCESSABLE_ENTITY, e))?;
3563
    Ok(Json(aa::api_prompt(&app, &at).await?))
3564
}