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