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