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