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