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