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