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