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