OXYGENHUB
# f28389bd6aab oxygenhub / crates / hub / src / api / mod.rs
88.4 KiB · Rust · last changed History API takes a revset: ?r= 1 month 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
pub mod device;
19
mod projects;
20
21
/// Any other path under `/api/v1`: a problem document, not the site's page.
22
/// `GET /api/v1/version`: the hub's version and build, and the Oxygen and
23
/// OxygenFlow library versions it is built on.
24
async fn version() -> Json<serde_json::Value> {
25
    Json(crate::web::home::versions())
26
}
27
28
async fn no_route() -> ApiError {
29
    ApiError(StatusCode::NOT_FOUND, "no such API route".into())
30
}
31
32
/// The API, with release assets up to `asset_limit` bytes (the web form's
33
/// limit too; axum's default of 2 MiB refused ordinary builds).
34
pub fn router(asset_limit: usize) -> Router<Shared> {
35
    Router::new()
36
        .fallback(no_route)
37
        .route("/flow/claim", post(crate::flow::claim))
38
        .route("/flow/runners/register", post(crate::flow::register))
39
        .route("/flow/jobs/{id}/log", post(crate::flow::log))
40
        .route("/flow/jobs/{id}/finish", post(crate::flow::finish))
41
        .route(
42
            "/flow/jobs/{id}/artifacts/{name}",
43
            post(crate::flow::artifact).layer(axum::extract::DefaultBodyLimit::max(crate::flow::MAX_ARTIFACT_BYTES + (1 << 20))),
44
        )
45
        .route("/projects/{owner}", get(projects::list).post(projects::create))
46
        .route("/projects/{owner}/{number}", get(projects::board).patch(projects::edit))
47
        .route("/projects/{owner}/{number}/cards", post(projects::add_card))
48
        .route("/projects/{owner}/{number}/cards/{id}", axum::routing::patch(projects::move_card).delete(projects::remove_card))
49
        .route("/device/code", post(device::code))
50
        .route("/device/token", post(device::token))
51
        .route("/runners", get(runners))
52
        .route("/runners/queue", get(runner_queue))
53
        .route("/runners/{id}/jobs", get(runner_jobs))
54
        .route("/user", get(me))
55
        .route("/user/token", axum::routing::delete(revoke_own_token))
56
        .route("/version", get(version))
57
        .route("/notifications", get(notifications))
58
        .route("/notifications/read", post(notifications_read_all))
59
        .route("/notifications/{id}/read", post(notification_read))
60
        .route("/users/{name}", get(user))
61
        .route("/orgs/{name}", get(org))
62
        .route("/search", get(search))
63
        .route("/repos", get(list_repos).post(create_repo))
64
        .route("/repos/{owner}/{name}", get(get_repo))
65
        .route("/repos/{owner}/{name}/bookmarks", get(bookmarks))
66
        .route("/repos/{owner}/{name}/tags", get(tags))
67
        .route("/repos/{owner}/{name}/history/{r}", get(history))
68
        .route("/repos/{owner}/{name}/changes/{hash}", get(change))
69
        .route("/repos/{owner}/{name}/tree/{r}", get(tree_root))
70
        .route("/repos/{owner}/{name}/tree/{r}/{*path}", get(tree))
71
        .route("/repos/{owner}/{name}/file/{r}/{*path}", get(file))
72
        .route("/repos/{owner}/{name}/blame/{r}/{*path}", get(blame))
73
        .route("/repos/{owner}/{name}/conflicts", get(conflicts))
74
        .route("/repos/{owner}/{name}/trust", get(trust))
75
        .route("/repos/{owner}/{name}/releases/trust/{*tag}", get(release_trust))
76
        .route("/repos/{owner}/{name}/pushes", get(pushes))
77
        .route("/repos/{owner}/{name}/proposals", get(proposals).post(create_proposal))
78
        .route("/repos/{owner}/{name}/proposals/{number}", get(proposal).patch(edit_proposal))
79
        .route("/repos/{owner}/{name}/proposals/{number}/land", post(land_proposal))
80
        .route("/repos/{owner}/{name}/proposals/{number}/comments", get(proposal_comments).post(proposal_comment))
81
        .route("/repos/{owner}/{name}/proposals/{number}/reviews", get(proposal_reviews).post(proposal_review))
82
        .route("/repos/{owner}/{name}/proposals/{number}/reviewers", post(request_reviewers))
83
        .route("/repos/{owner}/{name}/proposals/{number}/reviewers/{username}", axum::routing::delete(withdraw_reviewer))
84
        .route("/repos/{owner}/{name}/proposals/{number}/checks", get(proposal_checks))
85
        .route("/repos/{owner}/{name}/proposals/{number}/files", get(proposal_files))
86
        .route("/repos/{owner}/{name}/proposals/{number}/content/{side}/{*path}", get(proposal_content))
87
        .route("/repos/{owner}/{name}/issues", get(issues).post(create_issue))
88
        .route("/repos/{owner}/{name}/issues/{number}", get(issue).post(issue_state).patch(issue_edit))
89
        .route("/repos/{owner}/{name}/issues/{number}/comments", get(issue_comments).post(issue_comment))
90
        .route("/repos/{owner}/{name}/labels", get(labels).post(create_label))
91
        .route("/repos/{owner}/{name}/labels/{label}", axum::routing::delete(delete_label))
92
        .route("/repos/{owner}/{name}/milestones", get(milestones).post(create_milestone))
93
        .route("/repos/{owner}/{name}/milestones/{title}", axum::routing::patch(edit_milestone))
94
        .route("/repos/{owner}/{name}/hooks", get(hooks).post(create_hook))
95
        .route("/repos/{owner}/{name}/hooks/{id}/delete", post(delete_hook))
96
        .route("/repos/{owner}/{name}/checks", post(post_check))
97
        .route("/repos/{owner}/{name}/flow/runs", get(flow_runs).post(start_flow_run))
98
        .route("/repos/{owner}/{name}/flow/runs/{number}", get(flow_run))
99
        .route("/repos/{owner}/{name}/flow/runs/{number}/jobs/{job}/log", get(flow_job_log))
100
        .route("/repos/{owner}/{name}/flow/runs/{number}/rerun", post(rerun_flow_run))
101
        .route("/repos/{owner}/{name}/flow/runs/{number}/cancel", post(cancel_flow_run))
102
        .route("/repos/{owner}/{name}/checks/required", get(required_checks).put(set_required_checks))
103
        .route("/repos/{owner}/{name}/checks/{state}", get(checks_for_state))
104
        .route("/repos/{owner}/{name}/releases", get(releases).post(create_release))
105
        .route("/repos/{owner}/{name}/releases/{tag}", axum::routing::patch(edit_release))
106
        .route(
107
            "/repos/{owner}/{name}/releases/{tag}/assets",
108
            post(upload_asset).layer(axum::extract::DefaultBodyLimit::max(asset_limit + (1 << 20))),
109
        )
110
}
111
112
async fn releases(
113
    State(app): State<Shared>,
114
    headers: HeaderMap,
115
    Path((owner, name)): Path<(String, String)>,
116
) -> Result<Json<Vec<Release>>, ApiError> {
117
    let c = caller(&app, &headers).await?;
118
    let (repo, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
119
    Ok(Json(crate::web::releases::api_views(&app, &repo, &row).await?))
120
}
121
122
async fn create_release(
123
    State(app): State<Shared>,
124
    headers: HeaderMap,
125
    Path((owner, name)): Path<(String, String)>,
126
    Json(body): Json<NewRelease>,
127
) -> Result<(StatusCode, Json<Release>), ApiError> {
128
    let c = caller(&app, &headers).await?;
129
    let me = c.require("repo:write")?.clone();
130
    let (repo, row, _) = reach(&app, &c, &owner, &name, Access::Write).await?;
131
    crate::web::releases::create_release(&app, &repo, &row, &me, &body.tag, &body.title, body.notes, body.prerelease)
132
        .await
133
        .map_err(|m| ApiError(StatusCode::BAD_REQUEST, m))?;
134
    let r = crate::web::releases::api_views(&app, &repo, &row)
135
        .await?
136
        .into_iter()
137
        .find(|r| r.tag == body.tag)
138
        .ok_or_else(|| not_found("no such release"))?;
139
    Ok((StatusCode::CREATED, Json(r)))
140
}
141
142
/// `PATCH …/releases/{tag}` (oxygenhub#72): change a release's title,
143
/// notes or prerelease flag, as the release page's Edit does.
144
async fn edit_release(
145
    State(app): State<Shared>,
146
    headers: HeaderMap,
147
    Path((owner, name, tag)): Path<(String, String, String)>,
148
    Json(body): Json<ReleaseEdit>,
149
) -> Result<Json<Release>, ApiError> {
150
    let c = caller(&app, &headers).await?;
151
    let me = c.require("repo:write")?.clone();
152
    let (repo, row, _) = reach(&app, &c, &owner, &name, Access::Write).await?;
153
    let r = db::releases::get(&app.db, row.id, &tag).await?.ok_or_else(|| not_found("no such release"))?;
154
    let title = body.title.as_deref().map(str::trim).filter(|t| !t.is_empty()).unwrap_or(&r.title);
155
    let notes = body.notes.as_deref().map(str::trim).unwrap_or(&r.notes);
156
    db::releases::edit(&app.db, r.id, title, notes, body.prerelease.unwrap_or(r.prerelease)).await?;
157
    db::accounts::audit(&app.db, Some(&me), "release.edited", &format!("{owner}/{name}@{tag}"), "").await.ok();
158
    let r = crate::web::releases::api_views(&app, &repo, &row)
159
        .await?
160
        .into_iter()
161
        .find(|r| r.tag == tag)
162
        .ok_or_else(|| not_found("no such release"))?;
163
    Ok(Json(r))
164
}
165
166
#[derive(Deserialize)]
167
struct AssetQuery {
168
    name: String,
169
}
170
171
/// `POST …/releases/{tag}/assets?name=file.tar.gz` with the file as the body.
172
async fn upload_asset(
173
    State(app): State<Shared>,
174
    headers: HeaderMap,
175
    Path((owner, name, tag)): Path<(String, String, String)>,
176
    Query(q): Query<AssetQuery>,
177
    body: axum::body::Bytes,
178
) -> Result<(StatusCode, Json<Release>), ApiError> {
179
    let c = caller(&app, &headers).await?;
180
    c.require("repo:write")?;
181
    let (repo, row, _) = reach(&app, &c, &owner, &name, Access::Write).await?;
182
    let r = db::releases::get(&app.db, row.id, &tag).await?.ok_or_else(|| not_found("no such release"))?;
183
    let ct = headers.get(axum::http::header::CONTENT_TYPE).and_then(|v| v.to_str().ok()).unwrap_or("application/octet-stream").to_string();
184
    crate::web::releases::store_asset(&app, r.id, &q.name, &ct, &body).await.map_err(|m| ApiError(StatusCode::BAD_REQUEST, m))?;
185
    let r = crate::web::releases::api_views(&app, &repo, &row)
186
        .await?
187
        .into_iter()
188
        .find(|r| r.tag == tag)
189
        .ok_or_else(|| not_found("no such release"))?;
190
    Ok((StatusCode::CREATED, Json(r)))
191
}
192
193
pub struct ApiError(pub StatusCode, pub String);
194
195
impl IntoResponse for ApiError {
196
    fn into_response(self) -> Response {
197
        let body = Problem { status: self.0.as_u16(), title: self.0.canonical_reason().unwrap_or("error").into(), detail: self.1 };
198
        (self.0, [("content-type", "application/problem+json")], Json(body)).into_response()
199
    }
200
}
201
202
impl From<RepoError> for ApiError {
203
    fn from(e: RepoError) -> ApiError {
204
        match e {
205
            RepoError::NotFound => not_found("no such repository"),
206
            RepoError::Oxy(oxy_core::repo::RepoError::Msg(m)) => ApiError(StatusCode::NOT_FOUND, m),
207
            other => ApiError(StatusCode::INTERNAL_SERVER_ERROR, other.to_string()),
208
        }
209
    }
210
}
211
212
impl From<sqlx::Error> for ApiError {
213
    fn from(e: sqlx::Error) -> ApiError {
214
        ApiError(StatusCode::INTERNAL_SERVER_ERROR, e.to_string())
215
    }
216
}
217
218
pub(crate) fn not_found(what: &str) -> ApiError {
219
    ApiError(StatusCode::NOT_FOUND, what.into())
220
}
221
222
pub(crate) fn forbidden(what: &str) -> ApiError {
223
    ApiError(StatusCode::FORBIDDEN, what.into())
224
}
225
226
/// The address a request came from: the client's, as the proxy reports
227
/// it when the hub is behind one (`server.behind_proxy`), else the peer's.
228
/// Only an address's characters are kept, so it is safe to show.
229
pub fn client_addr(app: &Shared, headers: &HeaderMap, extensions: &axum::http::Extensions) -> String {
230
    let from_proxy = || {
231
        ["cf-connecting-ip", "x-forwarded-for", "x-real-ip"]
232
            .iter()
233
            .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()))
234
    };
235
    let addr = if app.config.server.behind_proxy {
236
        from_proxy()
237
    } else {
238
        extensions.get::<axum::extract::ConnectInfo<std::net::SocketAddr>>().map(|c| c.0.ip().to_string())
239
    };
240
    addr.map(|a| a.chars().filter(|c| c.is_ascii_hexdigit() || matches!(c, '.' | ':')).take(45).collect()).unwrap_or_default()
241
}
242
243
/// `DELETE /api/v1/user/token`: revoke the token this request is made
244
/// with, as `oxy auth logout` does.
245
async fn revoke_own_token(State(app): State<Shared>, headers: HeaderMap) -> Result<StatusCode, ApiError> {
246
    let c = caller(&app, &headers).await?;
247
    let (Some(account), Some(id)) = (c.account.as_ref(), c.token_id) else {
248
        return Err(ApiError(StatusCode::UNAUTHORIZED, "revoking needs the personal access token to revoke".into()));
249
    };
250
    db::accounts::delete_token(&app.db, account.id, id).await?;
251
    db::accounts::audit(&app.db, Some(account), "token.revoke", &c.token, "").await.ok();
252
    Ok(StatusCode::NO_CONTENT)
253
}
254
255
/// Who calls: the account behind a bearer token, with the token's scopes.
256
pub struct Caller {
257
    pub account: Option<Account>,
258
    pub scopes: Vec<String>,
259
    pub site: bool,
260
    /// The token's name, for records of what a call did.
261
    pub token: String,
262
    /// The personal access token's id, when one is used.
263
    pub token_id: Option<i64>,
264
}
265
266
impl Caller {
267
    fn has(&self, scope: &str) -> bool {
268
        self.site
269
            || self.scopes.iter().any(|s| {
270
                s == scope
271
                    || (scope == "repo:read" && (s == "repo:write" || s == "repo:admin"))
272
                    || (scope == "repo:write" && s == "repo:admin")
273
            })
274
    }
275
276
    fn require(&self, scope: &str) -> Result<&Account, ApiError> {
277
        if !self.has(scope) {
278
            return Err(forbidden(&format!("this token lacks the {scope} scope")));
279
        }
280
        self.account.as_ref().ok_or_else(|| ApiError(StatusCode::UNAUTHORIZED, "a personal access token is required".into()))
281
    }
282
}
283
284
pub async fn caller(app: &Shared, headers: &HeaderMap) -> Result<Caller, ApiError> {
285
    let Some(t) = oxy_server::bearer_token(headers) else {
286
        return Ok(Caller { account: None, scopes: vec![], site: false, token: String::new(), token_id: None });
287
    };
288
    if app.config.auth.push_tokens.iter().any(|x| auth::mac_equal(x, t)) {
289
        let admin = db::accounts::accounts(&app.db).await?.into_iter().find(|a| a.is_admin);
290
        return Ok(Caller {
291
            account: admin,
292
            scopes: vec!["repo:admin".into(), "user:read".into(), "checks:write".into()],
293
            site: true,
294
            token: "site token".into(),
295
            token_id: None,
296
        });
297
    }
298
    let token = db::accounts::token_by_hash(&app.db, &auth::token_hash(t)).await?;
299
    match token {
300
        Some(tok) if !tok.expired(db::now_ms()) => {
301
            let account = db::accounts::account_by_id(&app.db, tok.account_id).await?.filter(|a| !a.blocked());
302
            db::accounts::touch_token(&app.db, tok.id).await.ok();
303
            Ok(Caller {
304
                account,
305
                scopes: tok.scope_list().iter().map(|s| s.to_string()).collect(),
306
                site: false,
307
                token: tok.name.clone(),
308
                token_id: Some(tok.id),
309
            })
310
        }
311
        _ => Err(ApiError(StatusCode::UNAUTHORIZED, "unknown or expired token".into())),
312
    }
313
}
314
315
fn repository(app: &Shared, r: &db::repos::RepoRow) -> Repository {
316
    Repository {
317
        owner: r.owner.clone(),
318
        name: r.name.clone(),
319
        description: r.description.clone(),
320
        default_bookmark: r.default_bookmark.clone(),
321
        visibility: r.visibility(),
322
        created_ms: r.created_ms,
323
        updated_ms: r.updated_ms,
324
        clone_url: format!("{}/{}/{}", app.config.base_url(), r.owner, r.name),
325
    }
326
}
327
328
/// A repository the caller may reach with `access`, else 404.
329
async fn reach(
330
    app: &Shared,
331
    c: &Caller,
332
    owner: &str,
333
    name: &str,
334
    access: Access,
335
) -> Result<(RepoName, db::repos::RepoRow, Role), ApiError> {
336
    let repo = RepoName::new(owner, name).ok_or_else(|| not_found("no such repository"))?;
337
    let row = db::repos::get(&app.db, owner, name).await?.ok_or_else(|| not_found("no such repository"))?;
338
    let role = auth::roles::role_for(&app.db, c.account.as_ref(), &row).await?;
339
    if !auth::roles::allows(role, access) {
340
        return Err(not_found("no such repository"));
341
    }
342
    Ok((repo, row, role.unwrap_or(Role::Read)))
343
}
344
345
fn summary(c: &view::ChangeView) -> ChangeSummary {
346
    ChangeSummary {
347
        hash: c.hash.clone(),
348
        message: if c.body.is_empty() { c.title.clone() } else { format!("{}\n\n{}", c.title, c.body) },
349
        author: Author {
350
            name: c.author.name.clone(),
351
            email: c.author.email.clone(),
352
            key: c.author.key.clone(),
353
            account: c.author.account.clone(),
354
            note: Author::note_for(&c.author.key, &c.author.account),
355
        },
356
        when_ms: c.when_ms,
357
        deps: c.deps.clone(),
358
        head: c.head,
359
        signature: match &c.signature {
360
            view::SigView::Unsigned => Signature::Unsigned,
361
            view::SigView::Valid { key, sealed, revoked, .. } => Signature::Valid { key: key.clone(), sealed: *sealed, revoked: *revoked },
362
            view::SigView::Invalid(why) => Signature::Invalid { reason: why.clone() },
363
        },
364
    }
365
}
366
367
// ---------------------------------------------------------------- accounts
368
369
async fn me(State(app): State<Shared>, headers: HeaderMap) -> Result<Json<User>, ApiError> {
370
    let c = caller(&app, &headers).await?;
371
    let a = c.require("user:read")?;
372
    Ok(Json(user_of(&app, a).await?))
373
}
374
375
#[derive(Deserialize)]
376
struct InboxQuery {
377
    #[serde(default)]
378
    limit: Option<i64>,
379
}
380
381
/// The caller's inbox; reading and clearing it needs `user:read`, since
382
/// it touches nothing but the caller's own notifications.
383
async fn notifications(
384
    State(app): State<Shared>,
385
    headers: HeaderMap,
386
    Query(q): Query<InboxQuery>,
387
) -> Result<Json<hub_api::Inbox>, ApiError> {
388
    let c = caller(&app, &headers).await?;
389
    let a = c.require("user:read")?;
390
    let limit = q.limit.unwrap_or(50).clamp(1, 200);
391
    let base = app.config.base_url().trim_end_matches('/').to_string();
392
    let items = db::notify::inbox(&app.db, a.id, limit)
393
        .await?
394
        .into_iter()
395
        .map(|n| hub_api::Notification {
396
            id: n.id,
397
            at_ms: n.at_ms,
398
            kind: n.kind,
399
            title: n.title,
400
            url: if n.url.starts_with('/') { format!("{base}{}", n.url) } else { n.url },
401
            actor: n.actor,
402
            read: n.read,
403
        })
404
        .collect();
405
    Ok(Json(hub_api::Inbox { unread: db::notify::unread(&app.db, a.id).await?, items }))
406
}
407
408
async fn notification_read(State(app): State<Shared>, headers: HeaderMap, Path(id): Path<i64>) -> Result<StatusCode, ApiError> {
409
    let c = caller(&app, &headers).await?;
410
    let a = c.require("user:read")?;
411
    db::notify::mark_read(&app.db, a.id, Some(id)).await?;
412
    Ok(StatusCode::NO_CONTENT)
413
}
414
415
async fn notifications_read_all(State(app): State<Shared>, headers: HeaderMap) -> Result<StatusCode, ApiError> {
416
    let c = caller(&app, &headers).await?;
417
    let a = c.require("user:read")?;
418
    db::notify::mark_read(&app.db, a.id, None).await?;
419
    Ok(StatusCode::NO_CONTENT)
420
}
421
422
async fn user_of(app: &Shared, a: &Account) -> Result<User, ApiError> {
423
    let keys = db::accounts::identities_of(&app.db, a.id).await?.into_iter().map(|i| i.key).collect();
424
    Ok(User { username: a.username.clone(), display_name: a.display_name.clone(), is_admin: a.is_admin, keys, created_ms: a.created_ms })
425
}
426
427
async fn user(State(app): State<Shared>, Path(name): Path<String>) -> Result<Json<User>, ApiError> {
428
    let a = db::accounts::account_by_name(&app.db, &name).await?.ok_or_else(|| not_found("no such account"))?;
429
    Ok(Json(user_of(&app, &a).await?))
430
}
431
432
async fn org(State(app): State<Shared>, Path(name): Path<String>) -> Result<Json<Organisation>, ApiError> {
433
    let o = db::accounts::org_by_name(&app.db, &name).await?.ok_or_else(|| not_found("no such organisation"))?;
434
    let members = db::accounts::org_members(&app.db, o.id).await?.into_iter().map(|(a, _)| a.username).collect();
435
    Ok(Json(Organisation { name: o.name, display_name: o.display_name, description: o.description, members }))
436
}
437
438
#[derive(Deserialize)]
439
struct SearchQuery {
440
    q: String,
441
}
442
443
async fn search(
444
    State(app): State<Shared>,
445
    headers: HeaderMap,
446
    Query(q): Query<SearchQuery>,
447
) -> Result<Json<Vec<serde_json::Value>>, ApiError> {
448
    let c = caller(&app, &headers).await?;
449
    let mut out = Vec::new();
450
    for h in db::notify::search(&app.db, &q.q, None, 50).await? {
451
        let Some(row) = db::repos::get_by_id(&app.db, h.repo_id).await? else { continue };
452
        let role = auth::roles::role_for(&app.db, c.account.as_ref(), &row).await?;
453
        if !auth::roles::allows(role, Access::Read) {
454
            continue;
455
        }
456
        out.push(
457
            serde_json::json!({ "kind": h.kind, "repository": row.slug(), "number": h.number, "title": h.title, "snippet": h.snippet }),
458
        );
459
    }
460
    Ok(Json(out))
461
}
462
463
// ------------------------------------------------------------ repositories
464
465
async fn list_repos(State(app): State<Shared>, headers: HeaderMap) -> Result<Json<Vec<Repository>>, ApiError> {
466
    let c = caller(&app, &headers).await?;
467
    let mut out = Vec::new();
468
    for r in db::repos::list(&app.db).await? {
469
        let role = auth::roles::role_for(&app.db, c.account.as_ref(), &r).await?;
470
        if auth::roles::allows(role, Access::Read) {
471
            out.push(repository(&app, &r));
472
        }
473
    }
474
    Ok(Json(out))
475
}
476
477
async fn create_repo(
478
    State(app): State<Shared>,
479
    headers: HeaderMap,
480
    Json(body): Json<NewRepository>,
481
) -> Result<(StatusCode, Json<Repository>), ApiError> {
482
    let c = caller(&app, &headers).await?;
483
    let me = c.require("repo:admin")?;
484
    let name = RepoName::new(&body.owner, &body.name).ok_or_else(|| ApiError(StatusCode::BAD_REQUEST, "invalid owner or name".into()))?;
485
    if !auth::roles::may_create_under(&app.db, me, &name.owner).await? {
486
        return Err(forbidden("you cannot create repositories under that owner"));
487
    }
488
    if db::repos::get(&app.db, &name.owner, &name.name).await?.is_some() || app.repos.exists(&name) {
489
        return Err(ApiError(StatusCode::CONFLICT, "that repository exists".into()));
490
    }
491
    app.repos.create(&name, None)?;
492
    let row = db::repos::create(&app.db, &name.owner, &name.name, &body.description, body.visibility).await?;
493
    db::accounts::audit(&app.db, Some(me), "repo.created", &name.to_string(), "api").await.ok();
494
    Ok((StatusCode::CREATED, Json(repository(&app, &row))))
495
}
496
497
async fn get_repo(
498
    State(app): State<Shared>,
499
    headers: HeaderMap,
500
    Path((owner, name)): Path<(String, String)>,
501
) -> Result<Json<Repository>, ApiError> {
502
    let c = caller(&app, &headers).await?;
503
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
504
    Ok(Json(repository(&app, &row)))
505
}
506
507
async fn bookmarks(
508
    State(app): State<Shared>,
509
    headers: HeaderMap,
510
    Path((owner, name)): Path<(String, String)>,
511
) -> Result<Json<Vec<Bookmark>>, ApiError> {
512
    let c = caller(&app, &headers).await?;
513
    let (repo, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
514
    let default = row.default_bookmark.clone();
515
    let list = app.repos.read(&repo, move |r, cache| view::bookmarks(r, cache, &default)).await?;
516
    Ok(Json(list.into_iter().map(|b| Bookmark { name: b.name, heads: b.heads, changes: b.changes, default: b.default }).collect()))
517
}
518
519
async fn tags(
520
    State(app): State<Shared>,
521
    headers: HeaderMap,
522
    Path((owner, name)): Path<(String, String)>,
523
) -> Result<Json<Vec<Tag>>, ApiError> {
524
    let c = caller(&app, &headers).await?;
525
    let (repo, _, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
526
    let list = app.repos.read(&repo, |r, _| view::tags(r)).await?;
527
    Ok(Json(list.into_iter().map(|t| Tag { name: t.name, heads: t.heads, message: t.message, signer: t.signer }).collect()))
528
}
529
530
#[derive(Deserialize)]
531
struct HistoryQuery {
532
    path: Option<String>,
533
    offset: Option<usize>,
534
    limit: Option<usize>,
535
    /// A revset (Oxygen's docs/revset_query_language.md) in place of the
536
    /// reference's whole history; the reference still gives the labels.
537
    r: Option<String>,
538
}
539
540
async fn history(
541
    State(app): State<Shared>,
542
    headers: HeaderMap,
543
    Path((owner, name, r)): Path<(String, String, String)>,
544
    Query(q): Query<HistoryQuery>,
545
) -> Result<Json<History>, ApiError> {
546
    let c = caller(&app, &headers).await?;
547
    let (repo, _, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
548
    let (offset, limit) = (q.offset.unwrap_or(0), q.limit.unwrap_or(50).min(500));
549
    let revset = q.r.clone().filter(|s| !s.trim().is_empty());
550
    let by_revset = revset.is_some();
551
    let h = app
552
        .repos
553
        .read(&repo, move |repo, cache| {
554
            let target = view::resolve(repo, cache, &r)?;
555
            match &revset {
556
                Some(rs) => view::history_revset(repo, cache, target, rs, offset, limit),
557
                None => view::history(repo, cache, target, q.path.as_deref(), offset, limit),
558
            }
559
        })
560
        .await
561
        .map_err(|e| {
562
            // A revset that does not parse, names nothing, or goes past the
563
            // budget is the caller's to fix.
564
            if by_revset {
565
                ApiError(StatusCode::BAD_REQUEST, e.to_string())
566
            } else {
567
                e.into()
568
            }
569
        })?;
570
    let mut entries = h.entries;
571
    crate::web::attribute(&app, &mut entries.iter_mut().collect::<Vec<_>>()).await;
572
    Ok(Json(History {
573
        reference: h.target.label,
574
        heads: h.target.heads.iter().map(|x| x.to_hex()).collect(),
575
        total: h.total,
576
        offset: h.offset,
577
        changes: entries.iter().map(summary).collect(),
578
    }))
579
}
580
581
async fn change(
582
    State(app): State<Shared>,
583
    headers: HeaderMap,
584
    Path((owner, name, hash)): Path<(String, String, String)>,
585
) -> Result<Json<ChangeDetail>, ApiError> {
586
    let c = caller(&app, &headers).await?;
587
    let (repo, _, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
588
    let d = app
589
        .repos
590
        .read(&repo, move |repo, cache| {
591
            let h = view::resolve_change(repo, cache, &hash)?;
592
            view::change(repo, cache, &h)
593
        })
594
        .await?;
595
    let mut v = d.view;
596
    crate::web::attribute(&app, &mut [&mut v]).await;
597
    let files = crate::web::history::render_files(&d.files, &d.bases)
598
        .into_iter()
599
        .map(|f| FileChange { path: f.path, kind: f.kind, from: f.from, added: f.added, removed: f.removed })
600
        .collect();
601
    Ok(Json(ChangeDetail {
602
        body: v.body.clone(),
603
        change: summary(&v),
604
        dependents: d.dependents.iter().map(|x| x.hash.clone()).collect(),
605
        in_bookmarks: d.in_bookmarks,
606
        in_tags: d.in_tags,
607
        files,
608
    }))
609
}
610
611
fn entry(e: &view::Entry) -> TreeEntry {
612
    TreeEntry {
613
        name: e.name.clone(),
614
        path: e.path.clone(),
615
        kind: match e.kind {
616
            view::EntryKind::Dir => "dir",
617
            view::EntryKind::File => "file",
618
            view::EntryKind::Symlink => "symlink",
619
            view::EntryKind::Subrepo => "subrepo",
620
        }
621
        .into(),
622
        exec: e.exec,
623
        size: e.size,
624
        conflicted: e.conflicted,
625
    }
626
}
627
628
async fn tree_root(
629
    State(app): State<Shared>,
630
    headers: HeaderMap,
631
    Path((owner, name, r)): Path<(String, String, String)>,
632
) -> Result<Json<Vec<TreeEntry>>, ApiError> {
633
    tree(State(app), headers, Path((owner, name, r, String::new()))).await
634
}
635
636
async fn tree(
637
    State(app): State<Shared>,
638
    headers: HeaderMap,
639
    Path((owner, name, r, path)): Path<(String, String, String, String)>,
640
) -> Result<Json<Vec<TreeEntry>>, ApiError> {
641
    let c = caller(&app, &headers).await?;
642
    let (repo, _, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
643
    let t = app
644
        .repos
645
        .read(&repo, move |repo, cache| {
646
            let target = view::resolve(repo, cache, &r)?;
647
            view::tree(repo, cache, target, &path)
648
        })
649
        .await?;
650
    Ok(Json(t.entries.iter().map(entry).collect()))
651
}
652
653
async fn file(
654
    State(app): State<Shared>,
655
    headers: HeaderMap,
656
    Path((owner, name, r, path)): Path<(String, String, String, String)>,
657
) -> Result<Response, ApiError> {
658
    let c = caller(&app, &headers).await?;
659
    let (repo, _, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
660
    let limit = app.config.limits.render_limit.0;
661
    let f = app
662
        .repos
663
        .read(&repo, move |repo, cache| {
664
            let target = view::resolve(repo, cache, &r)?;
665
            view::file(repo, cache, target, &path, limit)
666
        })
667
        .await?;
668
    Ok(crate::web::raw(f.bytes, &f.name, false))
669
}
670
671
async fn blame(
672
    State(app): State<Shared>,
673
    headers: HeaderMap,
674
    Path((owner, name, r, path)): Path<(String, String, String, String)>,
675
) -> Result<Json<Vec<BlameLine>>, ApiError> {
676
    let c = caller(&app, &headers).await?;
677
    let (repo, _, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
678
    let limit = app.config.limits.render_limit.0;
679
    let b = app
680
        .repos
681
        .read(&repo, move |repo, cache| {
682
            let target = view::resolve(repo, cache, &r)?;
683
            view::blame(repo, cache, target, &path, limit)
684
        })
685
        .await?;
686
    Ok(Json(
687
        b.lines
688
            .into_iter()
689
            .map(|l| BlameLine {
690
                line: l.line,
691
                change: l.hash.to_hex(),
692
                index: l.index,
693
                author: l.author,
694
                when_ms: l.when_ms,
695
                text: String::from_utf8_lossy(&l.text).into_owned(),
696
            })
697
            .collect(),
698
    ))
699
}
700
701
async fn conflicts(
702
    State(app): State<Shared>,
703
    headers: HeaderMap,
704
    Path((owner, name)): Path<(String, String)>,
705
) -> Result<Json<Vec<Conflict>>, ApiError> {
706
    let c = caller(&app, &headers).await?;
707
    let (repo, _, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
708
    let list = app.repos.read(&repo, view::conflicts).await?;
709
    Ok(Json(
710
        list.into_iter()
711
            .map(|c| Conflict {
712
                bookmark: c.bookmark,
713
                path: c.path,
714
                kind: c.kind,
715
                contributors: c.contributors.iter().map(|x| x.hash.clone()).collect(),
716
            })
717
            .collect(),
718
    ))
719
}
720
721
/// `GET /repos/{o}/{n}/releases/trust/{tag}`: a release's trust report
722
/// (hub spec §9.1), as the page's JSON export.
723
async fn release_trust(
724
    State(app): State<Shared>,
725
    headers: HeaderMap,
726
    Path((owner, name, tag)): Path<(String, String, String)>,
727
) -> Result<Json<crate::web::release_trust::ReleaseTrust>, ApiError> {
728
    let c = caller(&app, &headers).await?;
729
    let (repo, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
730
    match crate::web::release_trust::report(&app, &repo, &row, &tag).await.map_err(|m| ApiError(StatusCode::INTERNAL_SERVER_ERROR, m))? {
731
        Some(t) => Ok(Json(t)),
732
        None => Err(ApiError(StatusCode::NOT_FOUND, format!("no release {tag}"))),
733
    }
734
}
735
736
async fn trust(
737
    State(app): State<Shared>,
738
    headers: HeaderMap,
739
    Path((owner, name)): Path<(String, String)>,
740
) -> Result<Json<Trust>, ApiError> {
741
    let c = caller(&app, &headers).await?;
742
    let (repo, _, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
743
    let key = app.hub_key.key;
744
    let t = app.repos.read(&repo, move |r, cache| view::trust(r, cache, &key)).await?;
745
    Ok(Json(Trust {
746
        policy: t.policy.map(|p| Policy {
747
            serial: p.serial,
748
            expires_ms: p.expires_ms,
749
            roots: p.roots.iter().map(|k| k.key.clone()).collect(),
750
            root_threshold: p.root_threshold,
751
            rules: p
752
                .rules
753
                .iter()
754
                .map(|r| Rule {
755
                    pattern: r.pattern.clone(),
756
                    keys: r.keys.iter().map(|k| k.key.clone()).collect(),
757
                    threshold: r.threshold,
758
                    require: r.require.clone(),
759
                    allow_conflicts: r.allow_conflicts,
760
                })
761
                .collect(),
762
        }),
763
        signed: t.verification.signed,
764
        sealed: t.verification.sealed,
765
        unsigned: t.verification.unsigned,
766
        invalid: t.verification.invalid.iter().map(|(h, _)| h.clone()).collect(),
767
        hub_key: t.hub_key,
768
    }))
769
}
770
771
async fn pushes(
772
    State(app): State<Shared>,
773
    headers: HeaderMap,
774
    Path((owner, name)): Path<(String, String)>,
775
) -> Result<Json<Vec<Push>>, ApiError> {
776
    let c = caller(&app, &headers).await?;
777
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
778
    let rows = db::repos::pushes(&app.db, row.id, 200).await?;
779
    Ok(Json(
780
        rows.into_iter()
781
            .map(|p| Push {
782
                at_ms: p.at_ms,
783
                pusher: p.pusher,
784
                reference: p.reference,
785
                ok: p.ok,
786
                reason: p.reason,
787
                old_state: p.old_state,
788
                new_state: p.new_state,
789
                heads: p.heads,
790
                changes: p.changes,
791
            })
792
            .collect(),
793
    ))
794
}
795
796
// --------------------------------------------------------------- proposals
797
798
/// `GET /repos/{o}/{n}/proposals?state=open|draft|landed|closed|all`:
799
/// open ones (drafts too) by default.
800
async fn proposals(
801
    State(app): State<Shared>,
802
    headers: HeaderMap,
803
    Path((owner, name)): Path<(String, String)>,
804
    Query(q): Query<IssuesQuery>,
805
) -> Result<Json<Vec<Proposal>>, ApiError> {
806
    let c = caller(&app, &headers).await?;
807
    let (repo, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
808
    let states: &[&str] = match q.state.as_deref().unwrap_or("open") {
809
        "open" => &["open", "draft"],
810
        "draft" => &["draft"],
811
        "landed" => &["landed"],
812
        "closed" => &["closed"],
813
        "all" => &["open", "draft", "landed", "closed"],
814
        other => return Err(ApiError(StatusCode::BAD_REQUEST, format!("state is open, draft, landed, closed or all, not {other:?}"))),
815
    };
816
    let mut out = Vec::new();
817
    for p in db::proposals::list(&app.db, row.id, states).await? {
818
        let loaded = crate::web::proposals::load(&app, &repo, p).await?;
819
        let v = crate::web::proposals::verdict(&app, &loaded, row.id).await?;
820
        out.push(crate::web::proposals::to_api(&app, &owner, &name, &loaded, &v, None).await);
821
    }
822
    Ok(Json(out))
823
}
824
825
async fn proposal(
826
    State(app): State<Shared>,
827
    headers: HeaderMap,
828
    Path((owner, name, number)): Path<(String, String, i64)>,
829
) -> Result<Json<Proposal>, ApiError> {
830
    let c = caller(&app, &headers).await?;
831
    let (repo, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
832
    let p = db::proposals::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such proposal"))?;
833
    let source_url = match p.source_repo_id {
834
        Some(id) => db::repos::get_by_id(&app.db, id).await?.map(|r| format!("{}/{}", app.config.base_url(), r.slug())),
835
        None => None,
836
    };
837
    let loaded = crate::web::proposals::load(&app, &repo, p).await?;
838
    let v = crate::web::proposals::verdict(&app, &loaded, row.id).await?;
839
    Ok(Json(crate::web::proposals::to_api(&app, &owner, &name, &loaded, &v, source_url).await))
840
}
841
842
/// `PATCH /repos/{o}/{n}/proposals/{number}`: change the title or body,
843
/// keeping what is not given; the author or a maintainer, as on the page
844
/// (oxygenhub#76). The target is changed on the page, which re-projects.
845
async fn edit_proposal(
846
    State(app): State<Shared>,
847
    headers: HeaderMap,
848
    Path((owner, name, number)): Path<(String, String, i64)>,
849
    Json(body): Json<hub_api::ProposalEdit>,
850
) -> Result<Json<Proposal>, ApiError> {
851
    let c = caller(&app, &headers).await?;
852
    let me = c.require("proposals:write").or_else(|_| c.require("repo:write"))?.clone();
853
    let (repo, row, role) = reach(&app, &c, &owner, &name, Access::Read).await?;
854
    let p = db::proposals::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such proposal"))?;
855
    let text = body.title.is_some() || body.body.is_some();
856
    if text && Some(me.id) != p.author_id && role < Role::Maintain {
857
        return Err(ApiError(StatusCode::FORBIDDEN, "only the proposal's author or a maintainer can edit it".into()));
858
    }
859
    if body.labels.is_some() && role < Role::Triage {
860
        return Err(forbidden("setting labels needs triage access"));
861
    }
862
    // Every name is checked before anything changes.
863
    let labels = resolve_triage(&app, row.id, body.labels.as_deref(), None, None).await?.labels;
864
    if text {
865
        let title = match body.title.as_deref().map(str::trim) {
866
            Some("") => return Err(ApiError(StatusCode::BAD_REQUEST, "a proposal needs a title".into())),
867
            Some(t) => t,
868
            None => p.title.as_str(),
869
        };
870
        let text = body.body.as_deref().map(str::trim).unwrap_or(&p.body);
871
        db::proposals::edit(&app.db, p.id, title, text, &p.target).await?;
872
        db::proposals::add_event(&app.db, p.id, &me.username, "edited", "").await.ok();
873
    }
874
    if let Some(want) = labels {
875
        let have = db::issues::proposal_labels(&app.db, p.id).await?;
876
        for l in &have {
877
            if !want.iter().any(|w| w.id == l.id) {
878
                db::issues::set_proposal_label(&app.db, p.id, l.id, false).await?;
879
            }
880
        }
881
        for w in &want {
882
            if !have.iter().any(|l| l.id == w.id) {
883
                db::issues::set_proposal_label(&app.db, p.id, w.id, true).await?;
884
            }
885
        }
886
        let names: Vec<&str> = want.iter().map(|l| l.name.as_str()).collect();
887
        db::proposals::add_event(&app.db, p.id, &me.username, "set labels", &names.join(", ")).await.ok();
888
    }
889
    let p = db::proposals::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such proposal"))?;
890
    let source_url = match p.source_repo_id {
891
        Some(id) => db::repos::get_by_id(&app.db, id).await?.map(|r| format!("{}/{}", app.config.base_url(), r.slug())),
892
        None => None,
893
    };
894
    let loaded = crate::web::proposals::load(&app, &repo, p).await?;
895
    let v = crate::web::proposals::verdict(&app, &loaded, row.id).await?;
896
    Ok(Json(crate::web::proposals::to_api(&app, &owner, &name, &loaded, &v, source_url).await))
897
}
898
899
/// `POST /repos/{o}/{n}/proposals/{number}/land` (repo:write): land it as
900
/// the page's Land button does; `409` with the blockers when it cannot.
901
async fn land_proposal(
902
    State(app): State<Shared>,
903
    headers: HeaderMap,
904
    Path((owner, name, number)): Path<(String, String, i64)>,
905
) -> Result<Json<Proposal>, ApiError> {
906
    let c = caller(&app, &headers).await?;
907
    let me = c.require("repo:write")?.clone();
908
    let (repo, row, _) = reach(&app, &c, &owner, &name, Access::Write).await?;
909
    let via = format!("api (token {})", c.token);
910
    match crate::web::proposals::land_as(&app, &repo, &row, &me, number, &via).await {
911
        Ok(_) => proposal(State(app), headers, Path((owner, name, number))).await,
912
        Err(crate::web::proposals::Landing::NotFound) => Err(not_found("no such proposal")),
913
        Err(crate::web::proposals::Landing::Refused(m)) => Err(ApiError(StatusCode::CONFLICT, m)),
914
    }
915
}
916
917
/// The files a proposal changes (hub spec §12.1).
918
async fn proposal_files(
919
    State(app): State<Shared>,
920
    headers: HeaderMap,
921
    Path((owner, name, number)): Path<(String, String, i64)>,
922
) -> Result<Json<Vec<hub_api::ProposalFile>>, ApiError> {
923
    let c = caller(&app, &headers).await?;
924
    let (repo, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
925
    let p = db::proposals::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such proposal"))?;
926
    let loaded = crate::web::proposals::load(&app, &repo, p).await?;
927
    Ok(Json(
928
        loaded
929
            .files
930
            .iter()
931
            .map(|f| hub_api::ProposalFile {
932
                path: f.path.clone(),
933
                from: f.from.clone(),
934
                kind: f.kind.clone(),
935
                added: f.added,
936
                removed: f.removed,
937
            })
938
            .collect(),
939
    ))
940
}
941
942
/// One file's bytes on a side of a proposal: `base` is the target's
943
/// state, `head` the projected state. 404 when the file does not exist
944
/// on that side.
945
async fn proposal_content(
946
    State(app): State<Shared>,
947
    headers: HeaderMap,
948
    Path((owner, name, number, side, path)): Path<(String, String, i64, String, String)>,
949
) -> Result<Response, ApiError> {
950
    let c = caller(&app, &headers).await?;
951
    let (repo, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
952
    let p = db::proposals::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such proposal"))?;
953
    let loaded = crate::web::proposals::load(&app, &repo, p).await?;
954
    let heads = match side.as_str() {
955
        "base" => loaded.target_heads,
956
        "head" => loaded.heads,
957
        _ => return Err(ApiError(StatusCode::BAD_REQUEST, "the side is base or head".into())),
958
    };
959
    let limit = app.config.limits.render_limit.0;
960
    let target = view::RefTarget { label: side, kind: view::RefKind::Change, heads };
961
    let f = app.repos.read(&repo, move |repo, cache| view::file(repo, cache, target, &path, limit)).await?;
962
    Ok(crate::web::raw(f.bytes, &f.name, false))
963
}
964
965
async fn create_proposal(
966
    State(app): State<Shared>,
967
    headers: HeaderMap,
968
    Path((owner, name)): Path<(String, String)>,
969
    Json(body): Json<NewProposal>,
970
) -> Result<(StatusCode, Json<Proposal>), ApiError> {
971
    let c = caller(&app, &headers).await?;
972
    let me = c.require("proposals:write").or_else(|_| c.require("repo:write"))?.clone();
973
    let (repo, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
974
    let created =
975
        crate::web::proposals::open_proposal(&app, &repo, &row, &me, &body.title, &body.body, &body.target, &body.source, body.draft)
976
            .await
977
            .map_err(|e| ApiError(StatusCode::BAD_REQUEST, e))?;
978
    let loaded = crate::web::proposals::load(&app, &repo, created).await?;
979
    let v = crate::web::proposals::verdict(&app, &loaded, row.id).await?;
980
    Ok((StatusCode::CREATED, Json(crate::web::proposals::to_api(&app, &owner, &name, &loaded, &v, None).await)))
981
}
982
983
fn comment_of(c: &db::proposals::CommentRow) -> Comment {
984
    Comment {
985
        id: c.id,
986
        author: c.author.clone(),
987
        body: c.body.clone(),
988
        created_ms: c.created_ms,
989
        path: if c.path.is_empty() { None } else { Some(c.path.clone()) },
990
        anchor: if c.anchor_change.is_empty() {
991
            None
992
        } else {
993
            Some(Atom { change: c.anchor_change.clone(), index: c.anchor_index as u32 })
994
        },
995
        resolved: c.resolved,
996
    }
997
}
998
999
async fn proposal_comments(
1000
    State(app): State<Shared>,
1001
    headers: HeaderMap,
1002
    Path((owner, name, number)): Path<(String, String, i64)>,
1003
) -> Result<Json<Vec<Comment>>, ApiError> {
1004
    let c = caller(&app, &headers).await?;
1005
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1006
    let p = db::proposals::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such proposal"))?;
1007
    Ok(Json(db::proposals::comments(&app.db, p.id).await?.iter().map(comment_of).collect()))
1008
}
1009
1010
async fn proposal_comment(
1011
    State(app): State<Shared>,
1012
    headers: HeaderMap,
1013
    Path((owner, name, number)): Path<(String, String, i64)>,
1014
    Json(body): Json<NewComment>,
1015
) -> Result<(StatusCode, Json<Comment>), ApiError> {
1016
    let c = caller(&app, &headers).await?;
1017
    let me = c.require("proposals:write").or_else(|_| c.require("repo:write"))?.clone();
1018
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1019
    let p = db::proposals::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such proposal"))?;
1020
    if body.body.trim().is_empty() {
1021
        return Err(ApiError(StatusCode::BAD_REQUEST, "an empty comment says nothing".into()));
1022
    }
1023
    let (repo, _) = (RepoName::new(&owner, &name).ok_or_else(|| not_found("no such repository"))?, ());
1024
    let anchor = match (body.path.as_deref().map(|x| x.trim_matches('/')), body.line) {
1025
        (Some(path), Some(line)) if !path.is_empty() => {
1026
            let loaded = crate::web::proposals::load(&app, &repo, p.clone()).await?;
1027
            let (heads, file) = (loaded.heads.clone(), path.to_string());
1028
            let atom = app
1029
                .repos
1030
                .read(&repo, move |r, cache| {
1031
                    let projected = cache.load(r, &heads)?;
1032
                    Ok(crate::repos::proposals::atom_at(&projected, &file, line).map(|(h, i)| (h.to_hex(), i)))
1033
                })
1034
                .await?
1035
                .ok_or_else(|| ApiError(StatusCode::BAD_REQUEST, format!("{path}:{line} is not a line of the projected state")))?;
1036
            Some((path.to_string(), atom))
1037
        }
1038
        _ => None,
1039
    };
1040
    let row_c = db::proposals::add_comment(
1041
        &app.db,
1042
        p.id,
1043
        Some(me.id),
1044
        &me.username,
1045
        body.body.trim(),
1046
        anchor.as_ref().map(|(path, _)| path.as_str()).unwrap_or(""),
1047
        anchor.as_ref().map(|(_, (h, i))| (h.as_str(), *i as i64)),
1048
    )
1049
    .await?;
1050
    crate::notify::deliver(
1051
        &app,
1052
        crate::notify::Event {
1053
            kind: "proposal.comment",
1054
            title: format!("{owner}/{name}#{number}: {}", p.title),
1055
            url: format!("/{owner}/{name}/proposal/{number}"),
1056
            actor: &me,
1057
            repo_id: row.id,
1058
            thread: Some(("proposal", p.id)),
1059
            mention_text: &body.body,
1060
            direct: p.author_id.into_iter().collect(),
1061
        },
1062
    )
1063
    .await;
1064
    crate::hooks::emit(
1065
        &app,
1066
        &row,
1067
        "comment.proposal",
1068
        &me.username,
1069
        serde_json::json!({ "number": number, "comment": comment_of(&row_c) }),
1070
    )
1071
    .await;
1072
    Ok((StatusCode::CREATED, Json(comment_of(&row_c))))
1073
}
1074
1075
async fn proposal_reviews(
1076
    State(app): State<Shared>,
1077
    headers: HeaderMap,
1078
    Path((owner, name, number)): Path<(String, String, i64)>,
1079
) -> Result<Json<Vec<Review>>, ApiError> {
1080
    let c = caller(&app, &headers).await?;
1081
    let (repo, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1082
    let p = db::proposals::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such proposal"))?;
1083
    let loaded = crate::web::proposals::load(&app, &repo, p).await?;
1084
    let v = crate::web::proposals::verdict(&app, &loaded, row.id).await?;
1085
    Ok(Json(
1086
        v.reviews
1087
            .into_iter()
1088
            .map(|r| Review {
1089
                id: r.row.id,
1090
                author: r.row.author,
1091
                verdict: r.row.verdict,
1092
                body: r.row.body,
1093
                sealed: r.sealed,
1094
                created_ms: r.row.created_ms,
1095
            })
1096
            .collect(),
1097
    ))
1098
}
1099
1100
async fn proposal_review(
1101
    State(app): State<Shared>,
1102
    headers: HeaderMap,
1103
    Path((owner, name, number)): Path<(String, String, i64)>,
1104
    Json(body): Json<NewReview>,
1105
) -> Result<(StatusCode, Json<Review>), ApiError> {
1106
    let c = caller(&app, &headers).await?;
1107
    let me = c.require("proposals:write").or_else(|_| c.require("repo:write"))?.clone();
1108
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1109
    let p = db::proposals::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such proposal"))?;
1110
    if !matches!(body.verdict.as_str(), "comment" | "changes" | "approve") {
1111
        return Err(ApiError(StatusCode::BAD_REQUEST, "verdict is comment, changes or approve".into()));
1112
    }
1113
    if body.verdict == "approve" && Some(me.id) == p.author_id {
1114
        return Err(forbidden("you cannot approve your own proposal"));
1115
    }
1116
    let r = db::proposals::add_review(&app.db, p.id, me.id, &me.username, &body.verdict, body.body.trim()).await?;
1117
    db::proposals::add_event(&app.db, p.id, &me.username, &format!("review.{}", body.verdict), "").await.ok();
1118
    crate::web::proposals::reviewed(&app, &row, &p, &me, &body.verdict).await;
1119
    crate::hooks::emit(&app, &row, "review", &me.username, serde_json::json!({ "number": number, "verdict": body.verdict })).await;
1120
    Ok((
1121
        StatusCode::CREATED,
1122
        Json(Review { id: r.id, author: r.author, verdict: r.verdict, body: r.body, sealed: false, created_ms: r.created_ms }),
1123
    ))
1124
}
1125
1126
/// `POST .../proposals/{number}/reviewers`: ask accounts to review (the
1127
/// author, or a writer). Answers with everyone asked now.
1128
async fn request_reviewers(
1129
    State(app): State<Shared>,
1130
    headers: HeaderMap,
1131
    Path((owner, name, number)): Path<(String, String, i64)>,
1132
    Json(body): Json<ReviewRequest>,
1133
) -> Result<Json<Vec<String>>, ApiError> {
1134
    let c = caller(&app, &headers).await?;
1135
    let me = c.require("proposals:write").or_else(|_| c.require("repo:write"))?.clone();
1136
    let (_, row, role) = reach(&app, &c, &owner, &name, Access::Read).await?;
1137
    let p = db::proposals::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such proposal"))?;
1138
    if Some(me.id) != p.author_id && role < Role::Write {
1139
        return Err(forbidden("only the author or a writer asks for reviews"));
1140
    }
1141
    if !p.is_open() {
1142
        return Err(ApiError(StatusCode::CONFLICT, "the proposal is not open".into()));
1143
    }
1144
    crate::web::proposals::request_reviewers(&app, &row, &p, &me, &body.reviewers)
1145
        .await
1146
        .map_err(|e| ApiError(StatusCode::UNPROCESSABLE_ENTITY, e))?;
1147
    Ok(Json(db::proposals::review_requests(&app.db, p.id).await?))
1148
}
1149
1150
/// `DELETE .../proposals/{number}/reviewers/{username}`: withdraw a request.
1151
async fn withdraw_reviewer(
1152
    State(app): State<Shared>,
1153
    headers: HeaderMap,
1154
    Path((owner, name, number, username)): Path<(String, String, i64, String)>,
1155
) -> Result<StatusCode, ApiError> {
1156
    let c = caller(&app, &headers).await?;
1157
    let me = c.require("proposals:write").or_else(|_| c.require("repo:write"))?.clone();
1158
    let (_, row, role) = reach(&app, &c, &owner, &name, Access::Read).await?;
1159
    let p = db::proposals::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such proposal"))?;
1160
    if Some(me.id) != p.author_id && role < Role::Write {
1161
        return Err(forbidden("only the author or a writer withdraws review requests"));
1162
    }
1163
    let a = db::accounts::account_by_name(&app.db, &username).await?.ok_or_else(|| not_found("no such account"))?;
1164
    if db::proposals::unrequest_review(&app.db, p.id, a.id).await? {
1165
        db::proposals::add_event(&app.db, p.id, &me.username, "review request withdrawn", &a.username).await.ok();
1166
    }
1167
    Ok(StatusCode::NO_CONTENT)
1168
}
1169
1170
async fn proposal_checks(
1171
    State(app): State<Shared>,
1172
    headers: HeaderMap,
1173
    Path((owner, name, number)): Path<(String, String, i64)>,
1174
) -> Result<Json<Vec<Check>>, ApiError> {
1175
    let c = caller(&app, &headers).await?;
1176
    let (repo, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1177
    let p = db::proposals::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such proposal"))?;
1178
    let loaded = crate::web::proposals::load(&app, &repo, p).await?;
1179
    Ok(Json(db::hooks::checks_for_state(&app.db, row.id, &loaded.state).await?.iter().map(check_of).collect()))
1180
}
1181
1182
// ------------------------------------------------------------------ issues
1183
1184
async fn issue_of(app: &Shared, row: &db::repos::RepoRow, i: &db::issues::IssueRow) -> Result<Issue, ApiError> {
1185
    let labels = db::issues::issue_labels(&app.db, i.id)
1186
        .await?
1187
        .into_iter()
1188
        .map(|l| Label { name: l.name, colour: l.colour, description: l.description })
1189
        .collect();
1190
    let assignees = db::issues::assignees(&app.db, i.id).await?;
1191
    let milestone = match i.milestone_id {
1192
        Some(id) => db::issues::milestone(&app.db, id).await?.map(|m| m.title),
1193
        None => None,
1194
    };
1195
    let comments: i64 = sqlx::query_scalar("SELECT COUNT(*) FROM issue_comments WHERE issue_id = ?").bind(i.id).fetch_one(&app.db).await?;
1196
    Ok(Issue {
1197
        number: i.number,
1198
        title: i.title.clone(),
1199
        body: i.body.clone(),
1200
        author: i.author.clone(),
1201
        state: i.state.clone(),
1202
        reason: i.reason.clone(),
1203
        labels,
1204
        assignees,
1205
        milestone,
1206
        comments,
1207
        locked: i.locked,
1208
        pinned: i.pinned,
1209
        created_ms: i.created_ms,
1210
        updated_ms: i.updated_ms,
1211
        closed_ms: i.closed_ms,
1212
        url: format!("{}/{}/issue/{}", app.config.base_url(), row.slug(), i.number),
1213
    })
1214
}
1215
1216
#[derive(Deserialize)]
1217
struct IssuesQuery {
1218
    state: Option<String>,
1219
}
1220
1221
async fn issues(
1222
    State(app): State<Shared>,
1223
    headers: HeaderMap,
1224
    Path((owner, name)): Path<(String, String)>,
1225
    Query(q): Query<IssuesQuery>,
1226
) -> Result<Json<Vec<Issue>>, ApiError> {
1227
    let c = caller(&app, &headers).await?;
1228
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1229
    let state = q.state.unwrap_or_else(|| "open".into());
1230
    let mut out = Vec::new();
1231
    for i in db::issues::list(&app.db, row.id).await? {
1232
        if state == "all" || i.state == state {
1233
            out.push(issue_of(&app, &row, &i).await?);
1234
        }
1235
    }
1236
    Ok(Json(out))
1237
}
1238
1239
async fn create_issue(
1240
    State(app): State<Shared>,
1241
    headers: HeaderMap,
1242
    Path((owner, name)): Path<(String, String)>,
1243
    Json(body): Json<NewIssue>,
1244
) -> Result<(StatusCode, Json<Issue>), ApiError> {
1245
    let c = caller(&app, &headers).await?;
1246
    let me = c.require("issues:write").or_else(|_| c.require("repo:write"))?.clone();
1247
    let (_, row, role) = reach(&app, &c, &owner, &name, Access::Read).await?;
1248
    if body.title.trim().is_empty() {
1249
        return Err(ApiError(StatusCode::BAD_REQUEST, "an issue needs a title".into()));
1250
    }
1251
    let triage = !body.labels.is_empty() || !body.assignees.is_empty() || body.milestone.is_some();
1252
    if triage && role < Role::Triage {
1253
        return Err(forbidden("setting labels, assignees or a milestone needs triage access"));
1254
    }
1255
    // Check the names before anything is created.
1256
    resolve_triage(&app, row.id, Some(&body.labels), Some(&body.assignees), body.milestone.as_deref()).await?;
1257
    let i = db::issues::create(
1258
        &app.db,
1259
        db::issues::NewIssue {
1260
            repo_id: row.id,
1261
            title: body.title.trim(),
1262
            body: body.body.trim(),
1263
            author_id: Some(me.id),
1264
            author: &me.username,
1265
        },
1266
    )
1267
    .await?;
1268
    db::issues::add_event(&app.db, i.id, &me.username, "opened", "").await.ok();
1269
    if triage {
1270
        let t = resolve_triage(&app, row.id, Some(&body.labels), Some(&body.assignees), body.milestone.as_deref()).await?;
1271
        apply_triage(&app, &i, &me, t).await?;
1272
    }
1273
    let i = db::issues::get(&app.db, row.id, i.number).await?.unwrap_or(i);
1274
    crate::web::issues::reindex(&app, row.id, &i).await;
1275
    let api = issue_of(&app, &row, &i).await?;
1276
    crate::notify::deliver(
1277
        &app,
1278
        crate::notify::Event {
1279
            kind: "issue.opened",
1280
            title: format!("{owner}/{name}#{}: {}", i.number, i.title),
1281
            url: format!("/{owner}/{name}/issue/{}", i.number),
1282
            actor: &me,
1283
            repo_id: row.id,
1284
            thread: Some(("issue", i.id)),
1285
            mention_text: &body.body,
1286
            direct: vec![],
1287
        },
1288
    )
1289
    .await;
1290
    crate::hooks::emit(&app, &row, "issue.opened", &me.username, serde_json::json!({ "issue": api })).await;
1291
    Ok((StatusCode::CREATED, Json(api)))
1292
}
1293
1294
async fn issue(
1295
    State(app): State<Shared>,
1296
    headers: HeaderMap,
1297
    Path((owner, name, number)): Path<(String, String, i64)>,
1298
) -> Result<Json<Issue>, ApiError> {
1299
    let c = caller(&app, &headers).await?;
1300
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1301
    let i = db::issues::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such issue"))?;
1302
    Ok(Json(issue_of(&app, &row, &i).await?))
1303
}
1304
1305
async fn issue_state(
1306
    State(app): State<Shared>,
1307
    headers: HeaderMap,
1308
    Path((owner, name, number)): Path<(String, String, i64)>,
1309
    Json(body): Json<IssueStateChange>,
1310
) -> Result<Json<Issue>, ApiError> {
1311
    let c = caller(&app, &headers).await?;
1312
    let me = c.require("issues:write").or_else(|_| c.require("repo:write"))?.clone();
1313
    let (_, row, role) = reach(&app, &c, &owner, &name, Access::Read).await?;
1314
    let i = db::issues::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such issue"))?;
1315
    if role < Role::Triage && Some(me.id) != i.author_id {
1316
        return Err(forbidden("only the author or triage may change the state"));
1317
    }
1318
    let (state, reason) = match body.state.as_str() {
1319
        "closed" => ("closed", if body.reason == "not_planned" { "not_planned" } else { "completed" }),
1320
        "open" => ("open", ""),
1321
        _ => return Err(ApiError(StatusCode::BAD_REQUEST, "state is open or closed".into())),
1322
    };
1323
    db::issues::set_state(&app.db, i.id, state, reason).await?;
1324
    db::issues::add_event(&app.db, i.id, &me.username, if state == "closed" { "closed" } else { "reopened" }, "").await.ok();
1325
    let fresh = db::issues::get(&app.db, row.id, number).await?.unwrap_or(i);
1326
    let api = issue_of(&app, &row, &fresh).await?;
1327
    crate::hooks::emit(
1328
        &app,
1329
        &row,
1330
        if state == "closed" { "issue.closed" } else { "issue.reopened" },
1331
        &me.username,
1332
        serde_json::json!({ "issue": api }),
1333
    )
1334
    .await;
1335
    Ok(Json(api))
1336
}
1337
1338
async fn issue_comments(
1339
    State(app): State<Shared>,
1340
    headers: HeaderMap,
1341
    Path((owner, name, number)): Path<(String, String, i64)>,
1342
) -> Result<Json<Vec<Comment>>, ApiError> {
1343
    let c = caller(&app, &headers).await?;
1344
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1345
    let i = db::issues::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such issue"))?;
1346
    Ok(Json(
1347
        db::issues::comments(&app.db, i.id)
1348
            .await?
1349
            .into_iter()
1350
            .map(|c| Comment {
1351
                id: c.id,
1352
                author: c.author,
1353
                body: c.body,
1354
                created_ms: c.created_ms,
1355
                path: None,
1356
                anchor: None,
1357
                resolved: false,
1358
            })
1359
            .collect(),
1360
    ))
1361
}
1362
1363
async fn issue_comment(
1364
    State(app): State<Shared>,
1365
    headers: HeaderMap,
1366
    Path((owner, name, number)): Path<(String, String, i64)>,
1367
    Json(body): Json<NewComment>,
1368
) -> Result<(StatusCode, Json<Comment>), ApiError> {
1369
    let c = caller(&app, &headers).await?;
1370
    let me = c.require("issues:write").or_else(|_| c.require("repo:write"))?.clone();
1371
    let (_, row, role) = reach(&app, &c, &owner, &name, Access::Read).await?;
1372
    let i = db::issues::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such issue"))?;
1373
    if i.locked && role < Role::Triage {
1374
        return Err(forbidden("this issue is locked"));
1375
    }
1376
    if body.body.trim().is_empty() {
1377
        return Err(ApiError(StatusCode::BAD_REQUEST, "an empty comment says nothing".into()));
1378
    }
1379
    let cm = db::issues::add_comment(&app.db, i.id, Some(me.id), &me.username, body.body.trim()).await?;
1380
    crate::web::issues::reindex(&app, row.id, &i).await;
1381
    crate::notify::deliver(
1382
        &app,
1383
        crate::notify::Event {
1384
            kind: "issue.comment",
1385
            title: format!("{owner}/{name}#{number}: {}", i.title),
1386
            url: format!("/{owner}/{name}/issue/{number}"),
1387
            actor: &me,
1388
            repo_id: row.id,
1389
            thread: Some(("issue", i.id)),
1390
            mention_text: &body.body,
1391
            direct: i.author_id.into_iter().collect(),
1392
        },
1393
    )
1394
    .await;
1395
    let api = Comment { id: cm.id, author: cm.author, body: cm.body, created_ms: cm.created_ms, path: None, anchor: None, resolved: false };
1396
    crate::hooks::emit(&app, &row, "comment.issue", &me.username, serde_json::json!({ "number": number, "comment": api })).await;
1397
    Ok((StatusCode::CREATED, Json(api)))
1398
}
1399
1400
/// Labels, assignees and milestone named in a request, looked up.
1401
struct Triage {
1402
    labels: Option<Vec<db::issues::Label>>,
1403
    assignees: Option<Vec<Account>>,
1404
    /// `Some(None)` clears the milestone.
1405
    milestone: Option<Option<db::issues::Milestone>>,
1406
}
1407
1408
async fn resolve_triage(
1409
    app: &Shared,
1410
    repo_id: i64,
1411
    labels: Option<&[String]>,
1412
    assignees: Option<&[String]>,
1413
    milestone: Option<&str>,
1414
) -> Result<Triage, ApiError> {
1415
    let bad = |m: String| ApiError(StatusCode::BAD_REQUEST, m);
1416
    let labels = match labels {
1417
        Some(names) => {
1418
            let mut out = Vec::new();
1419
            for n in names {
1420
                out.push(
1421
                    db::issues::label_by_name(&app.db, repo_id, n.trim())
1422
                        .await?
1423
                        .ok_or_else(|| bad(format!("no label {n:?}; create it first")))?,
1424
                );
1425
            }
1426
            Some(out)
1427
        }
1428
        None => None,
1429
    };
1430
    let assignees = match assignees {
1431
        Some(names) => {
1432
            let mut out = Vec::new();
1433
            for n in names {
1434
                out.push(db::accounts::account_by_name(&app.db, n.trim()).await?.ok_or_else(|| bad(format!("no account {n:?}")))?);
1435
            }
1436
            Some(out)
1437
        }
1438
        None => None,
1439
    };
1440
    let milestone = match milestone.map(str::trim) {
1441
        None => None,
1442
        Some("") => Some(None),
1443
        Some(title) => Some(Some(
1444
            db::issues::milestones(&app.db, repo_id)
1445
                .await?
1446
                .into_iter()
1447
                .find(|m| m.title == title)
1448
                .ok_or_else(|| bad(format!("no milestone {title:?}")))?,
1449
        )),
1450
    };
1451
    Ok(Triage { labels, assignees, milestone })
1452
}
1453
1454
/// Make an issue's labels, assignees and milestone what `t` says, with
1455
/// timeline events for what changed.
1456
async fn apply_triage(app: &Shared, i: &db::issues::IssueRow, me: &Account, t: Triage) -> Result<(), ApiError> {
1457
    if let Some(want) = t.labels {
1458
        let have = db::issues::issue_labels(&app.db, i.id).await?;
1459
        for l in &have {
1460
            if !want.iter().any(|w| w.id == l.id) {
1461
                db::issues::set_issue_label(&app.db, i.id, l.id, false).await?;
1462
            }
1463
        }
1464
        for w in &want {
1465
            if !have.iter().any(|l| l.id == w.id) {
1466
                db::issues::set_issue_label(&app.db, i.id, w.id, true).await?;
1467
            }
1468
        }
1469
        let names: Vec<&str> = want.iter().map(|l| l.name.as_str()).collect();
1470
        db::issues::add_event(&app.db, i.id, &me.username, "set labels", &names.join(", ")).await.ok();
1471
    }
1472
    if let Some(want) = t.assignees {
1473
        let have = db::issues::assignees(&app.db, i.id).await?;
1474
        for name in &have {
1475
            if !want.iter().any(|a| &a.username == name) {
1476
                if let Some(a) = db::accounts::account_by_name(&app.db, name).await? {
1477
                    db::issues::set_assignee(&app.db, i.id, a.id, false).await?;
1478
                    db::issues::add_event(&app.db, i.id, &me.username, "unassigned", name).await.ok();
1479
                }
1480
            }
1481
        }
1482
        for a in &want {
1483
            if !have.contains(&a.username) {
1484
                db::issues::set_assignee(&app.db, i.id, a.id, true).await?;
1485
                db::issues::add_event(&app.db, i.id, &me.username, "assigned", &a.username).await.ok();
1486
            }
1487
        }
1488
    }
1489
    if let Some(m) = t.milestone {
1490
        db::issues::set_milestone(&app.db, i.id, m.as_ref().map(|m| m.id)).await?;
1491
        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();
1492
    }
1493
    Ok(())
1494
}
1495
1496
/// `PATCH /repos/{o}/{n}/issues/{number}`.
1497
async fn issue_edit(
1498
    State(app): State<Shared>,
1499
    headers: HeaderMap,
1500
    Path((owner, name, number)): Path<(String, String, i64)>,
1501
    Json(body): Json<IssueEdit>,
1502
) -> Result<Json<Issue>, ApiError> {
1503
    let c = caller(&app, &headers).await?;
1504
    let me = c.require("issues:write").or_else(|_| c.require("repo:write"))?.clone();
1505
    let (_, row, role) = reach(&app, &c, &owner, &name, Access::Read).await?;
1506
    let i = db::issues::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such issue"))?;
1507
    let text = body.title.is_some() || body.body.is_some();
1508
    let triage = body.labels.is_some() || body.assignees.is_some() || body.milestone.is_some();
1509
    if text && role < Role::Triage && Some(me.id) != i.author_id {
1510
        return Err(forbidden("only the author or triage may edit the title and body"));
1511
    }
1512
    if triage && role < Role::Triage {
1513
        return Err(forbidden("setting labels, assignees or a milestone needs triage access"));
1514
    }
1515
    if i.locked && role < Role::Triage {
1516
        return Err(forbidden("this issue is locked"));
1517
    }
1518
    let t = resolve_triage(&app, row.id, body.labels.as_deref(), body.assignees.as_deref(), body.milestone.as_deref()).await?;
1519
    if text {
1520
        let title = body.title.as_deref().map(str::trim).unwrap_or(&i.title);
1521
        if title.is_empty() {
1522
            return Err(ApiError(StatusCode::BAD_REQUEST, "an issue needs a title".into()));
1523
        }
1524
        db::issues::edit(&app.db, i.id, title, body.body.as_deref().unwrap_or(&i.body)).await?;
1525
        db::issues::add_event(&app.db, i.id, &me.username, "edited", "").await.ok();
1526
    }
1527
    apply_triage(&app, &i, &me, t).await?;
1528
    db::issues::touch(&app.db, i.id).await.ok();
1529
    let fresh = db::issues::get(&app.db, row.id, number).await?.unwrap_or(i);
1530
    crate::web::issues::reindex(&app, row.id, &fresh).await;
1531
    let api = issue_of(&app, &row, &fresh).await?;
1532
    crate::hooks::emit(&app, &row, "issue.edited", &me.username, serde_json::json!({ "issue": api })).await;
1533
    Ok(Json(api))
1534
}
1535
1536
/// `POST /repos/{o}/{n}/labels` (triage).
1537
async fn create_label(
1538
    State(app): State<Shared>,
1539
    headers: HeaderMap,
1540
    Path((owner, name)): Path<(String, String)>,
1541
    Json(body): Json<NewLabel>,
1542
) -> Result<(StatusCode, Json<Label>), ApiError> {
1543
    let c = caller(&app, &headers).await?;
1544
    c.require("issues:write").or_else(|_| c.require("repo:write"))?;
1545
    let (_, row, role) = reach(&app, &c, &owner, &name, Access::Read).await?;
1546
    if role < Role::Triage {
1547
        return Err(forbidden("labels need triage access"));
1548
    }
1549
    let label = body.name.trim();
1550
    if label.is_empty() || label.len() > 50 {
1551
        return Err(ApiError(StatusCode::BAD_REQUEST, "a label has a name of 1 to 50 characters".into()));
1552
    }
1553
    let colour = match body.colour.as_deref() {
1554
        Some(c) if c.len() == 7 && c.starts_with('#') && c[1..].chars().all(|x| x.is_ascii_hexdigit()) => c.to_string(),
1555
        Some(c) => return Err(ApiError(StatusCode::BAD_REQUEST, format!("colour {c:?} is not #rrggbb"))),
1556
        None => "#5aa8ff".to_string(),
1557
    };
1558
    let l = db::issues::upsert_label(&app.db, row.id, label, &colour, body.description.trim()).await?;
1559
    Ok((StatusCode::CREATED, Json(Label { name: l.name, colour: l.colour, description: l.description })))
1560
}
1561
1562
/// `DELETE /repos/{o}/{n}/labels/{label}` (triage).
1563
async fn delete_label(
1564
    State(app): State<Shared>,
1565
    headers: HeaderMap,
1566
    Path((owner, name, label)): Path<(String, String, String)>,
1567
) -> Result<StatusCode, ApiError> {
1568
    let c = caller(&app, &headers).await?;
1569
    c.require("issues:write").or_else(|_| c.require("repo:write"))?;
1570
    let (_, row, role) = reach(&app, &c, &owner, &name, Access::Read).await?;
1571
    if role < Role::Triage {
1572
        return Err(forbidden("labels need triage access"));
1573
    }
1574
    let l = db::issues::label_by_name(&app.db, row.id, &label).await?.ok_or_else(|| not_found("no such label"))?;
1575
    db::issues::delete_label(&app.db, l.id).await?;
1576
    Ok(StatusCode::NO_CONTENT)
1577
}
1578
1579
async fn labels(
1580
    State(app): State<Shared>,
1581
    headers: HeaderMap,
1582
    Path((owner, name)): Path<(String, String)>,
1583
) -> Result<Json<Vec<Label>>, ApiError> {
1584
    let c = caller(&app, &headers).await?;
1585
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1586
    Ok(Json(
1587
        db::issues::labels(&app.db, row.id)
1588
            .await?
1589
            .into_iter()
1590
            .map(|l| Label { name: l.name, colour: l.colour, description: l.description })
1591
            .collect(),
1592
    ))
1593
}
1594
1595
async fn milestones(
1596
    State(app): State<Shared>,
1597
    headers: HeaderMap,
1598
    Path((owner, name)): Path<(String, String)>,
1599
) -> Result<Json<Vec<Milestone>>, ApiError> {
1600
    let c = caller(&app, &headers).await?;
1601
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1602
    let mut out = Vec::new();
1603
    for m in db::issues::milestones(&app.db, row.id).await? {
1604
        let (open, closed) = db::issues::milestone_counts(&app.db, m.id).await?;
1605
        out.push(Milestone { title: m.title, description: m.description, due_ms: m.due_ms, state: m.state, open, closed });
1606
    }
1607
    Ok(Json(out))
1608
}
1609
1610
fn milestone_of(m: db::issues::Milestone, open: i64, closed: i64) -> Milestone {
1611
    Milestone { title: m.title, description: m.description, due_ms: m.due_ms, state: m.state, open, closed }
1612
}
1613
1614
/// A due date as `YYYY-MM-DD` (UTC midnight), or the empty string for none.
1615
fn due_ms_of(due: &str) -> Result<Option<i64>, ApiError> {
1616
    let due = due.trim();
1617
    if due.is_empty() {
1618
        return Ok(None);
1619
    }
1620
    time::Date::parse(due, &time::macros::format_description!("[year]-[month]-[day]"))
1621
        .map(|d| Some(d.midnight().assume_utc().unix_timestamp() * 1000))
1622
        .map_err(|_| ApiError(StatusCode::BAD_REQUEST, format!("due {due:?} is not YYYY-MM-DD")))
1623
}
1624
1625
async fn triage_for_milestones(app: &Shared, headers: &HeaderMap, owner: &str, name: &str) -> Result<db::repos::RepoRow, ApiError> {
1626
    let c = caller(app, headers).await?;
1627
    c.require("issues:write").or_else(|_| c.require("repo:write"))?;
1628
    let (_, row, role) = reach(app, &c, owner, name, Access::Read).await?;
1629
    if role < Role::Triage {
1630
        return Err(forbidden("milestones need triage access"));
1631
    }
1632
    Ok(row)
1633
}
1634
1635
/// `POST /repos/{o}/{n}/milestones` (triage, oxygenhub#91): create a
1636
/// milestone, or change the description and due date of the one with
1637
/// that title.
1638
async fn create_milestone(
1639
    State(app): State<Shared>,
1640
    headers: HeaderMap,
1641
    Path((owner, name)): Path<(String, String)>,
1642
    Json(body): Json<NewMilestone>,
1643
) -> Result<(StatusCode, Json<Milestone>), ApiError> {
1644
    let row = triage_for_milestones(&app, &headers, &owner, &name).await?;
1645
    let title = body.title.trim();
1646
    if title.is_empty() || title.len() > 100 {
1647
        return Err(ApiError(StatusCode::BAD_REQUEST, "a milestone has a title of 1 to 100 characters".into()));
1648
    }
1649
    let due_ms = due_ms_of(body.due.as_deref().unwrap_or(""))?;
1650
    let m = db::issues::upsert_milestone(&app.db, row.id, title, body.description.trim(), due_ms).await?;
1651
    let (open, closed) = db::issues::milestone_counts(&app.db, m.id).await?;
1652
    Ok((StatusCode::CREATED, Json(milestone_of(m, open, closed))))
1653
}
1654
1655
/// `PATCH /repos/{o}/{n}/milestones/{title}` (triage): title,
1656
/// description, due date and state; what is not given stays.
1657
async fn edit_milestone(
1658
    State(app): State<Shared>,
1659
    headers: HeaderMap,
1660
    Path((owner, name, title)): Path<(String, String, String)>,
1661
    Json(body): Json<MilestoneEdit>,
1662
) -> Result<Json<Milestone>, ApiError> {
1663
    let row = triage_for_milestones(&app, &headers, &owner, &name).await?;
1664
    let m = db::issues::milestones(&app.db, row.id)
1665
        .await?
1666
        .into_iter()
1667
        .find(|m| m.title == title)
1668
        .ok_or_else(|| not_found("no such milestone"))?;
1669
    let new_title = body.title.as_deref().map(str::trim).unwrap_or(&m.title);
1670
    if new_title.is_empty() || new_title.len() > 100 {
1671
        return Err(ApiError(StatusCode::BAD_REQUEST, "a milestone has a title of 1 to 100 characters".into()));
1672
    }
1673
    let due_ms = match body.due.as_deref() {
1674
        Some(d) => due_ms_of(d)?,
1675
        None => m.due_ms,
1676
    };
1677
    let description = body.description.as_deref().map(str::trim).unwrap_or(&m.description);
1678
    if body.title.is_some() || body.description.is_some() || body.due.is_some() {
1679
        db::issues::update_milestone(&app.db, m.id, new_title, description, due_ms).await?;
1680
    }
1681
    if let Some(state) = body.state.as_deref() {
1682
        match state {
1683
            "open" | "closed" => db::issues::set_milestone_state(&app.db, m.id, state).await?,
1684
            other => return Err(ApiError(StatusCode::BAD_REQUEST, format!("state {other:?} is open or closed"))),
1685
        }
1686
    }
1687
    let fresh = db::issues::milestone(&app.db, m.id).await?.ok_or_else(|| not_found("no such milestone"))?;
1688
    let (open, closed) = db::issues::milestone_counts(&app.db, fresh.id).await?;
1689
    Ok(Json(milestone_of(fresh, open, closed)))
1690
}
1691
1692
// --------------------------------------------------------- hooks, checks
1693
1694
fn hook_of(h: &db::hooks::Hook) -> Hook {
1695
    Hook { id: h.id, url: h.url.clone(), events: h.events.clone(), active: h.active, created_ms: h.created_ms }
1696
}
1697
1698
async fn hooks(
1699
    State(app): State<Shared>,
1700
    headers: HeaderMap,
1701
    Path((owner, name)): Path<(String, String)>,
1702
) -> Result<Json<Vec<Hook>>, ApiError> {
1703
    let c = caller(&app, &headers).await?;
1704
    c.require("hooks:admin").or_else(|_| c.require("repo:admin"))?;
1705
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Admin).await?;
1706
    Ok(Json(db::hooks::hooks_for_repo(&app.db, row.id).await?.iter().map(hook_of).collect()))
1707
}
1708
1709
async fn create_hook(
1710
    State(app): State<Shared>,
1711
    headers: HeaderMap,
1712
    Path((owner, name)): Path<(String, String)>,
1713
    Json(body): Json<NewHook>,
1714
) -> Result<(StatusCode, Json<Hook>), ApiError> {
1715
    let c = caller(&app, &headers).await?;
1716
    let me = c.require("hooks:admin").or_else(|_| c.require("repo:admin"))?.clone();
1717
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Admin).await?;
1718
    if !(body.url.starts_with("http://") || body.url.starts_with("https://")) {
1719
        return Err(ApiError(StatusCode::BAD_REQUEST, "the URL must be http or https".into()));
1720
    }
1721
    let h = db::hooks::create_hook(&app.db, Some(row.id), None, &body.url, &body.secret, &body.events).await?;
1722
    db::accounts::audit(&app.db, Some(&me), "hook.created", &row.slug(), &body.url).await.ok();
1723
    Ok((StatusCode::CREATED, Json(hook_of(&h))))
1724
}
1725
1726
async fn delete_hook(
1727
    State(app): State<Shared>,
1728
    headers: HeaderMap,
1729
    Path((owner, name, id)): Path<(String, String, i64)>,
1730
) -> Result<StatusCode, ApiError> {
1731
    let c = caller(&app, &headers).await?;
1732
    c.require("hooks:admin").or_else(|_| c.require("repo:admin"))?;
1733
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Admin).await?;
1734
    if db::hooks::hook(&app.db, id).await?.is_some_and(|h| h.repo_id == Some(row.id)) {
1735
        db::hooks::delete_hook(&app.db, id).await?;
1736
    }
1737
    Ok(StatusCode::NO_CONTENT)
1738
}
1739
1740
pub fn check_of(c: &db::hooks::Check) -> Check {
1741
    Check {
1742
        state: c.state.clone(),
1743
        name: c.name.clone(),
1744
        status: CheckStatus::parse(&c.status).unwrap_or(CheckStatus::Queued),
1745
        summary: c.summary.clone(),
1746
        url: c.url.clone(),
1747
        reporter: c.reporter.clone(),
1748
        seal: if c.seal.is_empty() { None } else { Some(c.seal.clone()) },
1749
        started_ms: c.started_ms,
1750
        finished_ms: c.finished_ms,
1751
    }
1752
}
1753
1754
/// `GET /repos/{o}/{n}/checks/required`.
1755
async fn required_checks(
1756
    State(app): State<Shared>,
1757
    headers: HeaderMap,
1758
    Path((owner, name)): Path<(String, String)>,
1759
) -> Result<Json<RequiredChecks>, ApiError> {
1760
    let c = caller(&app, &headers).await?;
1761
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1762
    Ok(Json(RequiredChecks { names: db::hooks::required_checks(&app.db, row.id).await? }))
1763
}
1764
1765
/// `PUT /repos/{o}/{n}/checks/required` (repository admin): the whole list.
1766
async fn set_required_checks(
1767
    State(app): State<Shared>,
1768
    headers: HeaderMap,
1769
    Path((owner, name)): Path<(String, String)>,
1770
    Json(body): Json<RequiredChecks>,
1771
) -> Result<Json<RequiredChecks>, ApiError> {
1772
    let c = caller(&app, &headers).await?;
1773
    c.require("repo:admin")?;
1774
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Admin).await?;
1775
    let mut names: Vec<String> = body.names.iter().map(|n| n.trim().to_string()).filter(|n| !n.is_empty()).collect();
1776
    names.sort();
1777
    names.dedup();
1778
    if names.len() > 32 || names.iter().any(|n| n.len() > 100 || n.contains(',')) {
1779
        return Err(ApiError(StatusCode::BAD_REQUEST, "at most 32 check names, each under 100 characters and without commas".into()));
1780
    }
1781
    db::hooks::set_required_checks(&app.db, row.id, &names).await?;
1782
    db::accounts::audit(&app.db, c.account.as_ref(), "repo.required_checks", &format!("{owner}/{name}"), &names.join(", ")).await.ok();
1783
    Ok(Json(RequiredChecks { names }))
1784
}
1785
1786
fn flow_run_of(
1787
    app: &Shared,
1788
    row: &db::repos::RepoRow,
1789
    r: &db::flow::Run,
1790
    jobs: Vec<db::flow::Job>,
1791
    queue: &[db::flow::QueueEntry],
1792
) -> FlowRun {
1793
    FlowRun {
1794
        queue_position: crate::flow::queue_info(queue, row.id, r.id).position.map(|p| p as i64),
1795
        number: r.number,
1796
        bookmark: r.bookmark.clone(),
1797
        state: r.state.clone(),
1798
        heads: r.head_list().into_iter().map(String::from).collect(),
1799
        status: r.status.clone(),
1800
        trigger: r.trigger_label(),
1801
        actor: r.actor.clone(),
1802
        pipeline_hash: r.pipeline_hash.clone(),
1803
        error: r.error.clone(),
1804
        created_ms: r.created_ms,
1805
        finished_ms: r.finished_ms,
1806
        url: format!("{}/{}/{}/flow/{}", app.config.base_url(), row.owner, row.name, r.number),
1807
        jobs: jobs
1808
            .into_iter()
1809
            .map(|j| FlowJob {
1810
                depends_on: j.depends_on(),
1811
                name: j.name,
1812
                status: j.status,
1813
                runner: j.runner,
1814
                exit_code: j.exit_code,
1815
                error: j.error,
1816
                started_ms: j.started_ms,
1817
                finished_ms: j.finished_ms,
1818
                log_lines: j.log_count,
1819
            })
1820
            .collect(),
1821
    }
1822
}
1823
1824
#[derive(Deserialize)]
1825
struct RunsPage {
1826
    /// Runs numbered below this one (the next page).
1827
    before: Option<i64>,
1828
    limit: Option<i64>,
1829
}
1830
1831
/// `GET /repos/{o}/{n}/flow/runs`: newest first, `?before=N&limit=` (max 100).
1832
async fn flow_runs(
1833
    State(app): State<Shared>,
1834
    headers: HeaderMap,
1835
    Path((owner, name)): Path<(String, String)>,
1836
    Query(q): Query<RunsPage>,
1837
) -> Result<Json<Vec<FlowRun>>, ApiError> {
1838
    let c = caller(&app, &headers).await?;
1839
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1840
    let limit = q.limit.unwrap_or(30).clamp(1, 100);
1841
    let runs = db::flow::runs_by_number(&app.db, row.id, limit, q.before).await?;
1842
    let queue = if runs.iter().any(|r| r.live()) { db::flow::queue(&app.db).await? } else { vec![] };
1843
    Ok(Json(runs.iter().map(|r| flow_run_of(&app, &row, r, vec![], &queue)).collect()))
1844
}
1845
1846
/// `GET /repos/{o}/{n}/flow/runs/{number}`: a run with its jobs.
1847
async fn flow_run(
1848
    State(app): State<Shared>,
1849
    headers: HeaderMap,
1850
    Path((owner, name, number)): Path<(String, String, i64)>,
1851
) -> Result<Json<FlowRun>, ApiError> {
1852
    let c = caller(&app, &headers).await?;
1853
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1854
    let run = db::flow::run(&app.db, row.id, number).await?.ok_or_else(|| ApiError(StatusCode::NOT_FOUND, "no such run".into()))?;
1855
    let jobs = db::flow::jobs(&app.db, run.id).await?;
1856
    let queue = if run.live() { db::flow::queue(&app.db).await? } else { vec![] };
1857
    Ok(Json(flow_run_of(&app, &row, &run, jobs, &queue)))
1858
}
1859
1860
#[derive(Deserialize)]
1861
struct LogPage {
1862
    /// Lines after this `seq`.
1863
    #[serde(default)]
1864
    after: i64,
1865
    limit: Option<i64>,
1866
}
1867
1868
/// `GET /repos/{o}/{n}/flow/runs/{number}/jobs/{job}/log`: `?after=seq&limit=` (max 5000).
1869
async fn flow_job_log(
1870
    State(app): State<Shared>,
1871
    headers: HeaderMap,
1872
    Path((owner, name, number, job)): Path<(String, String, i64, String)>,
1873
    Query(q): Query<LogPage>,
1874
) -> Result<Json<Vec<FlowLogLine>>, ApiError> {
1875
    let c = caller(&app, &headers).await?;
1876
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1877
    let run = db::flow::run(&app.db, row.id, number).await?.ok_or_else(|| ApiError(StatusCode::NOT_FOUND, "no such run".into()))?;
1878
    let j = db::flow::jobs(&app.db, run.id)
1879
        .await?
1880
        .into_iter()
1881
        .find(|j| j.name == job)
1882
        .ok_or_else(|| ApiError(StatusCode::NOT_FOUND, "no such job".into()))?;
1883
    let lines = db::flow::log(&app.db, j.id, q.after, q.limit.unwrap_or(1000).clamp(1, 5000)).await?;
1884
    Ok(Json(lines.into_iter().map(|l| FlowLogLine { seq: l.seq, t: l.t, stream: l.stream, text: l.text }).collect()))
1885
}
1886
1887
#[derive(Deserialize)]
1888
struct StartRun {
1889
    /// Default: the repository's default bookmark.
1890
    #[serde(default)]
1891
    bookmark: Option<String>,
1892
    /// A change's full hash: run the state whose only head it is, instead
1893
    /// of a bookmark's.
1894
    #[serde(default)]
1895
    change: Option<String>,
1896
}
1897
1898
fn started(app: &Shared, row: &db::repos::RepoRow, number: i64) -> (StatusCode, Json<serde_json::Value>) {
1899
    let url = format!("{}/{}/{}/flow/{number}", app.config.base_url(), row.owner, row.name);
1900
    (StatusCode::CREATED, Json(serde_json::json!({ "number": number, "url": url })))
1901
}
1902
1903
/// `POST /repos/{o}/{n}/flow/runs` (repo:write): run a bookmark's current
1904
/// state, or one change's, without moving anything (hub spec §13.2).
1905
async fn start_flow_run(
1906
    State(app): State<Shared>,
1907
    headers: HeaderMap,
1908
    Path((owner, name)): Path<(String, String)>,
1909
    Json(body): Json<StartRun>,
1910
) -> Result<(StatusCode, Json<serde_json::Value>), ApiError> {
1911
    let c = caller(&app, &headers).await?;
1912
    let me = c.require("repo:write")?.clone();
1913
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Write).await?;
1914
    let (n, what) = match body.change.filter(|c| !c.trim().is_empty()) {
1915
        Some(change) => {
1916
            let n = crate::flow::run_change(&app, &row, &change, &me.username).await.map_err(|m| ApiError(StatusCode::CONFLICT, m))?;
1917
            (n, format!("change {}", change.trim()))
1918
        }
1919
        None => {
1920
            let bookmark = body.bookmark.unwrap_or_else(|| row.default_bookmark.clone());
1921
            (crate::flow::run_bookmark(&app, &row, &bookmark, &me.username).await.map_err(|m| ApiError(StatusCode::CONFLICT, m))?, bookmark)
1922
        }
1923
    };
1924
    db::accounts::audit(&app.db, Some(&me), "flow.run", &format!("{owner}/{name}"), &format!("#{n} {what}")).await.ok();
1925
    Ok(started(&app, &row, n))
1926
}
1927
1928
/// `POST /repos/{o}/{n}/flow/runs/{number}/rerun` (repo:write).
1929
async fn rerun_flow_run(
1930
    State(app): State<Shared>,
1931
    headers: HeaderMap,
1932
    Path((owner, name, number)): Path<(String, String, i64)>,
1933
) -> Result<(StatusCode, Json<serde_json::Value>), ApiError> {
1934
    let c = caller(&app, &headers).await?;
1935
    let me = c.require("repo:write")?.clone();
1936
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Write).await?;
1937
    let run = db::flow::run(&app.db, row.id, number).await?.ok_or_else(|| ApiError(StatusCode::NOT_FOUND, "no such run".into()))?;
1938
    let n = crate::flow::rerun(&app, &row, &run, &me.username).await.map_err(|m| ApiError(StatusCode::CONFLICT, m))?;
1939
    db::accounts::audit(&app.db, Some(&me), "flow.rerun", &format!("{owner}/{name}"), &format!("#{n} of #{number}")).await.ok();
1940
    Ok(started(&app, &row, n))
1941
}
1942
1943
/// `POST /repos/{o}/{n}/flow/runs/{number}/cancel` (repo:write): answers
1944
/// with the run as it now stands.
1945
async fn cancel_flow_run(
1946
    State(app): State<Shared>,
1947
    headers: HeaderMap,
1948
    Path((owner, name, number)): Path<(String, String, i64)>,
1949
) -> Result<Json<serde_json::Value>, ApiError> {
1950
    let c = caller(&app, &headers).await?;
1951
    let me = c.require("repo:write")?.clone();
1952
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Write).await?;
1953
    let run = db::flow::run(&app.db, row.id, number).await?.ok_or_else(|| ApiError(StatusCode::NOT_FOUND, "no such run".into()))?;
1954
    crate::flow::cancel(&app, &row, &run, &me.username).await.map_err(|m| ApiError(StatusCode::CONFLICT, m))?;
1955
    db::accounts::audit(&app.db, Some(&me), "flow.cancel", &format!("{owner}/{name}"), &format!("#{number}")).await.ok();
1956
    Ok(Json(serde_json::json!({ "number": number, "status": "cancelled" })))
1957
}
1958
1959
/// `POST /repos/{o}/{n}/checks`: any `checks:write` (or write) token may
1960
/// report; the state hash names what was checked.
1961
async fn post_check(
1962
    State(app): State<Shared>,
1963
    headers: HeaderMap,
1964
    Path((owner, name)): Path<(String, String)>,
1965
    Json(body): Json<NewCheck>,
1966
) -> Result<(StatusCode, Json<Check>), ApiError> {
1967
    let c = caller(&app, &headers).await?;
1968
    let me = c.require("checks:write").or_else(|_| c.require("repo:write"))?.clone();
1969
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1970
    if body.state.len() != 64 || !body.state.chars().all(|ch| ch.is_ascii_hexdigit()) {
1971
        return Err(ApiError(StatusCode::BAD_REQUEST, "state is a 64-character hex state hash".into()));
1972
    }
1973
    if body.name.trim().is_empty() || body.name.len() > 100 {
1974
        return Err(ApiError(StatusCode::BAD_REQUEST, "a check has a short name".into()));
1975
    }
1976
    let ch = db::hooks::upsert_check(
1977
        &app.db,
1978
        row.id,
1979
        &body.state,
1980
        body.name.trim(),
1981
        body.status.as_str(),
1982
        &body.summary,
1983
        &body.url,
1984
        Some((me.id, &me.username)),
1985
        body.seal.as_deref().unwrap_or(""),
1986
    )
1987
    .await?;
1988
    let api = check_of(&ch);
1989
    app.events.proposal(row.id, ProposalEvent { number: 0, kind: "check".into(), check: Some(api.clone()) });
1990
    crate::hooks::emit(&app, &row, "check", &me.username, serde_json::json!({ "check": api })).await;
1991
    Ok((StatusCode::CREATED, Json(api)))
1992
}
1993
1994
async fn checks_for_state(
1995
    State(app): State<Shared>,
1996
    headers: HeaderMap,
1997
    Path((owner, name, state)): Path<(String, String, String)>,
1998
) -> Result<Json<Vec<Check>>, ApiError> {
1999
    let c = caller(&app, &headers).await?;
2000
    let (repo, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
2001
    let state = state_key(&app, &repo, &state).await?;
2002
    Ok(Json(db::hooks::checks_for_state(&app.db, row.id, &state).await?.iter().map(check_of).collect()))
2003
}
2004
2005
/// The state hash checks are keyed by, from what a client has: a state
2006
/// hash, its heads (full change hashes joined with `+`, or the one head of
2007
/// a single-head state, which is what `oxy log` shows), or a bookmark.
2008
async fn state_key(app: &Shared, repo: &RepoName, s: &str) -> Result<String, ApiError> {
2009
    use oxy_core::hash::{hash_object, ChangeHash, ObjectType};
2010
    let hexes: Vec<&str> = s.split('+').collect();
2011
    let all_hashes = hexes.iter().all(|h| h.len() == 64 && h.bytes().all(|b| b.is_ascii_hexdigit()));
2012
    if all_hashes {
2013
        let row = db::repos::get(&app.db, &repo.owner, &repo.name).await?.ok_or_else(|| not_found("no such repository"))?;
2014
        if hexes.len() == 1 && !db::hooks::checks_for_state(&app.db, row.id, s).await?.is_empty() {
2015
            return Ok(s.to_string());
2016
        }
2017
        let heads: Vec<ChangeHash> = hexes.iter().filter_map(|h| ChangeHash::from_hex(h)).collect();
2018
        return Ok(hash_object(ObjectType::State, &oxy_core::objects::StateObject::new(heads).encode()).to_hex());
2019
    }
2020
    let b = s.to_string();
2021
    let found = app.repos.read(repo, move |r, _| Ok(r.view()?.bookmarks.get(&b).copied())).await?;
2022
    found.map(|st| st.to_hex()).ok_or_else(|| ApiError(StatusCode::NOT_FOUND, format!("{s:?} is not a state hash, heads or a bookmark")))
2023
}
2024
2025
// ----------------------------------------------------------------- runners
2026
2027
/// Site administrators only, with any token of theirs (hub spec §13.2).
2028
fn require_site_admin(c: &Caller) -> Result<&Account, ApiError> {
2029
    match c.account.as_ref() {
2030
        Some(a) if a.is_admin => Ok(a),
2031
        _ => Err(not_found("no such API route")),
2032
    }
2033
}
2034
2035
async fn runner_of(app: &Shared, r: db::runners::Runner, running: i64) -> hub_api::Runner {
2036
    let serves = match r.scope_repo_id {
2037
        Some(id) => db::repos::get_by_id(&app.db, id).await.ok().flatten().map(|p| p.slug()).unwrap_or_default(),
2038
        None => r.scope_owner.clone(),
2039
    };
2040
    hub_api::Runner {
2041
        id: r.id,
2042
        status: r.status().to_string(),
2043
        serves,
2044
        labels: r.label_list().into_iter().map(String::from).collect(),
2045
        name: r.name,
2046
        arch: r.arch,
2047
        os: r.os,
2048
        version: r.version,
2049
        max_jobs: r.max_jobs,
2050
        memory_mib: r.memory_mib,
2051
        cpus: r.cpus,
2052
        key: r.key,
2053
        source: r.source,
2054
        last_seen_ms: r.last_seen_ms,
2055
        running,
2056
    }
2057
}
2058
2059
/// `GET /api/v1/runners`.
2060
async fn runners(State(app): State<Shared>, headers: HeaderMap) -> Result<Json<Vec<hub_api::Runner>>, ApiError> {
2061
    let c = caller(&app, &headers).await?;
2062
    require_site_admin(&c)?;
2063
    let running: std::collections::HashMap<i64, i64> = db::runners::running(&app.db).await?.into_iter().collect();
2064
    let mut out = Vec::new();
2065
    for r in db::runners::list(&app.db).await? {
2066
        let n = running.get(&r.id).copied().unwrap_or(0);
2067
        out.push(runner_of(&app, r, n).await);
2068
    }
2069
    Ok(Json(out))
2070
}
2071
2072
#[derive(Deserialize)]
2073
struct BeforeQuery {
2074
    #[serde(default)]
2075
    before: Option<i64>,
2076
    #[serde(default)]
2077
    limit: Option<i64>,
2078
}
2079
2080
/// `GET /api/v1/runners/{id}/jobs?before=MS&limit=N`: newest first.
2081
async fn runner_jobs(
2082
    State(app): State<Shared>,
2083
    headers: HeaderMap,
2084
    Path(id): Path<i64>,
2085
    Query(q): Query<BeforeQuery>,
2086
) -> Result<Json<Vec<hub_api::RunnerJob>>, ApiError> {
2087
    let c = caller(&app, &headers).await?;
2088
    require_site_admin(&c)?;
2089
    db::runners::get(&app.db, id).await?.ok_or_else(|| not_found("no such runner"))?;
2090
    let jobs = db::runners::history(&app.db, id, q.limit.unwrap_or(50).clamp(1, 200), q.before).await?;
2091
    Ok(Json(
2092
        jobs.into_iter()
2093
            .map(|j| hub_api::RunnerJob {
2094
                repo: format!("{}/{}", j.owner, j.repo),
2095
                run: j.run_number,
2096
                job: j.job,
2097
                status: j.status,
2098
                started_ms: j.started_ms,
2099
                finished_ms: j.finished_ms,
2100
            })
2101
            .collect(),
2102
    ))
2103
}
2104
2105
/// `GET /api/v1/runners/queue`: running jobs, then queued ones in claim order.
2106
async fn runner_queue(State(app): State<Shared>, headers: HeaderMap) -> Result<Json<Vec<hub_api::QueueItem>>, ApiError> {
2107
    let c = caller(&app, &headers).await?;
2108
    require_site_admin(&c)?;
2109
    Ok(Json(
2110
        db::flow::queue(&app.db)
2111
            .await?
2112
            .into_iter()
2113
            .map(|e| hub_api::QueueItem {
2114
                repo: format!("{}/{}", e.owner, e.name),
2115
                run: e.run_number,
2116
                job: e.job,
2117
                status: e.status,
2118
                runner: e.runner,
2119
            })
2120
            .collect(),
2121
    ))
2122
}