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