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