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