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