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