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