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