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