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