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