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