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