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