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