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