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