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