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