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