OXYGENHUB
◆ v0.9.23 oxygenhub / crates / hub / src / api / projects.rs
18.4 KiB · Rust · last changed Board columns by API and oh, newest-run watch, close with a comment (closes #366, closes #367, closes #368) 1 day ago source blame history raw
ef20fdc1 Andy McCall ↶ 1
//! Projects over the API (hub spec §8.2, §12.1): the same rules as the
2
//! pages, through the functions they use.
3
4
use super::{caller, forbidden, not_found, ApiError, Caller};
5
use crate::db::projects as pdb;
6
use crate::web::projects as wp;
7
use crate::Shared;
439ecd87 Andy McCall ↶ 8
use axum::extract::{Path, Query, State};
ef20fdc1 Andy McCall ↶ 9
use axum::http::{HeaderMap, StatusCode};
10
use axum::Json;
439ecd87 Andy McCall ↶ 11
use hub_api::{
12
    Board, CardMove, CardsArchive, CardsArchived, CardsMove, CardsMoved, NewCard, NewProject, Project, ProjectCard, ProjectColumn,
13
    ProjectEdit,
14
};
ef20fdc1 Andy McCall ↶ 15
16
fn project_of(app: &Shared, p: &pdb::Project) -> Project {
17
    Project {
18
        owner: p.owner.clone(),
19
        number: p.number,
20
        title: p.title.clone(),
21
        description: p.description.clone(),
22
        public: p.public,
23
        closed: p.closed,
24
        updated_ms: p.updated_ms,
25
        url: format!("{}/projects/{}/{}", app.config.base_url().trim_end_matches('/'), p.owner, p.number),
26
    }
27
}
28
29
fn card_of(v: &wp::CardView) -> ProjectCard {
6a306cd0 Andy McCall ↶ 30
    ProjectCard {
31
        id: v.card.id,
32
        kind: v.card.kind.clone(),
33
        reference: v.reference.clone(),
34
        title: v.title.clone(),
35
        state: v.state.clone(),
36
        labels: v.labels.iter().map(|l| l.name.clone()).collect(),
37
        assignees: v.assignees.clone(),
439ecd87 Andy McCall ↶ 38
        archived_ms: v.card.archived_ms,
6a306cd0 Andy McCall ↶ 39
    }
ef20fdc1 Andy McCall ↶ 40
}
41
42
async fn rights(app: &Shared, c: &Caller, owner: &str) -> Result<wp::Rights, ApiError> {
43
    wp::rights_of(app, c.account.as_ref(), owner).await?.ok_or_else(|| not_found("no such owner"))
44
}
45
46
/// A project the caller may see.
47
async fn visible(app: &Shared, c: &Caller, owner: &str, number: i64) -> Result<(wp::Rights, pdb::Project), ApiError> {
48
    let r = rights(app, c, owner).await?;
49
    let p = pdb::get(&app.db, owner, number).await?.filter(|p| p.public || r.member).ok_or_else(|| not_found("no such project"))?;
50
    Ok((r, p))
51
}
52
53
/// A project the caller may change: a write token, edit rights, and open unless `closed_ok`.
54
async fn changeable(
55
    app: &Shared,
56
    headers: &HeaderMap,
57
    owner: &str,
58
    number: i64,
59
    closed_ok: bool,
60
) -> Result<(Caller, pdb::Project), ApiError> {
61
    let c = caller(app, headers).await?;
62
    c.require("repo:write")?;
63
    let (r, p) = visible(app, &c, owner, number).await?;
64
    if !r.edit {
65
        return Err(forbidden("only the owner (or the organisation's members) may change this project"));
66
    }
67
    if p.closed && !closed_ok {
68
        return Err(ApiError(StatusCode::CONFLICT, "this project is closed; reopen it to change it".into()));
69
    }
70
    Ok((c, p))
71
}
72
73
/// A column by id or by name (case-insensitive); the first when absent.
74
async fn column(app: &Shared, project_id: i64, spec: Option<&str>) -> Result<pdb::Column, ApiError> {
75
    let cols = pdb::columns(&app.db, project_id).await?;
76
    let found = match spec.map(str::trim).filter(|s| !s.is_empty()) {
77
        None => cols.into_iter().next(),
78
        Some(s) => cols.into_iter().find(|c| c.id.to_string() == s || c.name.eq_ignore_ascii_case(s)),
79
    };
80
    found.ok_or_else(|| ApiError(StatusCode::BAD_REQUEST, "no such column".into()))
81
}
82
83
/// `GET /projects/{owner}`.
84
pub async fn list(State(app): State<Shared>, headers: HeaderMap, Path(owner): Path<String>) -> Result<Json<Vec<Project>>, ApiError> {
85
    let c = caller(&app, &headers).await?;
86
    let r = rights(&app, &c, &owner).await?;
87
    let list = pdb::of_owner(&app.db, &owner).await?;
88
    Ok(Json(list.iter().filter(|p| p.public || r.member).map(|p| project_of(&app, p)).collect()))
89
}
90
91
/// `POST /projects/{owner}`.
92
pub async fn create(
93
    State(app): State<Shared>,
94
    headers: HeaderMap,
95
    Path(owner): Path<String>,
96
    Json(body): Json<NewProject>,
97
) -> Result<(StatusCode, Json<Project>), ApiError> {
98
    let c = caller(&app, &headers).await?;
99
    c.require("repo:write")?;
100
    if !rights(&app, &c, &owner).await?.edit {
101
        return Err(forbidden("only the owner (or the organisation's members) may create projects"));
102
    }
103
    let title = body.title.trim();
104
    if title.is_empty() || title.chars().count() > 100 {
105
        return Err(ApiError(StatusCode::BAD_REQUEST, "a project needs a title of up to 100 characters".into()));
106
    }
107
    let p = pdb::create(&app.db, &owner, title, body.description.trim(), !body.private).await?;
108
    crate::db::accounts::audit(&app.db, c.account.as_ref(), "project.created", &format!("{owner}/{}", p.number), title).await.ok();
109
    Ok((StatusCode::CREATED, Json(project_of(&app, &p))))
110
}
111
112
/// `GET /projects/{owner}/{n}`.
113
pub async fn board(
114
    State(app): State<Shared>,
115
    headers: HeaderMap,
116
    Path((owner, number)): Path<(String, i64)>,
117
) -> Result<Json<Board>, ApiError> {
118
    let c = caller(&app, &headers).await?;
306aec18 Andy McCall ↶ 119
    board_of(&app, &c, &owner, number).await
ef20fdc1 Andy McCall ↶ 120
}
121
122
/// `PATCH /projects/{owner}/{n}`.
123
pub async fn edit(
124
    State(app): State<Shared>,
125
    headers: HeaderMap,
126
    Path((owner, number)): Path<(String, i64)>,
127
    Json(body): Json<ProjectEdit>,
128
) -> Result<Json<Project>, ApiError> {
b1e92a62 Andy McCall ↶ 129
    let (c, p) = changeable(&app, &headers, &owner, number, true).await?;
130
    // A transfer (#125) first: the other fields then apply where it went.
131
    let (owner, number) = match body.owner.as_deref().map(str::trim).filter(|to| !to.is_empty() && *to != owner) {
132
        Some(to) => match wp::rights_of(&app, c.account.as_ref(), to).await? {
133
            Some(r) if r.edit => {
134
                let moved = pdb::transfer(&app.db, p.id, to).await?;
135
                let detail = format!("{owner}/{number} to {to}/{}", moved.number);
136
                crate::db::accounts::audit(&app.db, c.account.as_ref(), "project.transferred", &detail, &p.title).await.ok();
137
                (moved.owner, moved.number)
138
            }
139
            _ => return Err(ApiError(StatusCode::FORBIDDEN, format!("you cannot make projects under {to}"))),
140
        },
141
        None => (owner, number),
142
    };
143
    let p = pdb::get(&app.db, &owner, number).await?.unwrap_or(p);
ef20fdc1 Andy McCall ↶ 144
    let title = body.title.as_deref().map(str::trim).filter(|t| !t.is_empty()).unwrap_or(&p.title).chars().take(100).collect::<String>();
145
    pdb::set(
146
        &app.db,
147
        p.id,
148
        &title,
149
        body.description.as_deref().map(str::trim).unwrap_or(&p.description),
150
        body.private.map(|x| !x).unwrap_or(p.public),
151
        body.closed.unwrap_or(p.closed),
152
    )
153
    .await?;
154
    let fresh = pdb::get(&app.db, &owner, number).await?.unwrap_or(p);
155
    Ok(Json(project_of(&app, &fresh)))
306aec18 Andy McCall ↶ 156
}
157
158
/// A board's columns as `GET /projects/{owner}/{n}` gives them, for the
159
/// column calls to answer with (#366).
160
async fn board_of(app: &Shared, c: &Caller, owner: &str, number: i64) -> Result<Json<Board>, ApiError> {
161
    let (_, p) = visible(app, c, owner, number).await?;
162
    let (columns, _) = wp::board_columns(app, c.account.as_ref(), owner, &p, false).await?;
163
    Ok(Json(Board {
164
        project: project_of(app, &p),
165
        columns: columns
166
            .iter()
167
            .map(|col| ProjectColumn { id: col.column.id, name: col.column.name.clone(), cards: col.cards.iter().map(card_of).collect() })
168
            .collect(),
169
    }))
170
}
171
172
/// A column's name: trimmed, 1 to 40 characters, as the board page has it.
173
fn column_name(name: &str) -> Result<&str, ApiError> {
174
    let name = name.trim();
175
    if name.is_empty() || name.chars().count() > 40 {
176
        return Err(ApiError(StatusCode::BAD_REQUEST, "a column has a name of 1 to 40 characters".into()));
177
    }
178
    Ok(name)
179
}
180
181
/// `POST /projects/{owner}/{n}/columns` (#366): add a column at the right;
182
/// answers the board.
183
pub async fn add_column(
184
    State(app): State<Shared>,
185
    headers: HeaderMap,
186
    Path((owner, number)): Path<(String, i64)>,
187
    Json(body): Json<hub_api::NewColumn>,
188
) -> Result<Json<Board>, ApiError> {
189
    let (c, p) = changeable(&app, &headers, &owner, number, false).await?;
190
    let name = column_name(&body.name)?;
191
    if pdb::columns(&app.db, p.id).await?.iter().any(|col| col.name.eq_ignore_ascii_case(name)) {
192
        return Err(ApiError(StatusCode::CONFLICT, format!("the board has a column {name} already")));
193
    }
194
    pdb::add_column(&app.db, p.id, name).await?;
195
    board_of(&app, &c, &owner, number).await
196
}
197
198
/// `PATCH /projects/{owner}/{n}/columns/{column}` (#366): rename or move a
199
/// column named by id or name; answers the board.
200
pub async fn edit_column(
201
    State(app): State<Shared>,
202
    headers: HeaderMap,
203
    Path((owner, number, spec)): Path<(String, i64, String)>,
204
    Json(body): Json<hub_api::ColumnEdit>,
205
) -> Result<Json<Board>, ApiError> {
206
    let (c, p) = changeable(&app, &headers, &owner, number, false).await?;
207
    let col = named_column(&app, p.id, &spec).await?;
208
    if body.name.is_none() && body.position.is_none() {
209
        return Err(ApiError(StatusCode::BAD_REQUEST, "say what to change: name or position".into()));
210
    }
211
    if let Some(name) = body.name.as_deref() {
212
        let name = column_name(name)?;
213
        let others = pdb::columns(&app.db, p.id).await?;
214
        if others.iter().any(|o| o.id != col.id && o.name.eq_ignore_ascii_case(name)) {
215
            return Err(ApiError(StatusCode::CONFLICT, format!("the board has a column {name} already")));
216
        }
217
        pdb::rename_column(&app.db, p.id, col.id, name).await?;
218
    }
219
    if let Some(pos) = body.position {
220
        pdb::place_column(&app.db, p.id, col.id, pos).await?;
221
    }
222
    board_of(&app, &c, &owner, number).await
223
}
224
225
/// `DELETE /projects/{owner}/{n}/columns/{column}` (#366): its cards go to
226
/// the first remaining column; a board keeps at least one. Answers the board.
227
pub async fn remove_column(
228
    State(app): State<Shared>,
229
    headers: HeaderMap,
230
    Path((owner, number, spec)): Path<(String, i64, String)>,
231
) -> Result<Json<Board>, ApiError> {
232
    let (c, p) = changeable(&app, &headers, &owner, number, false).await?;
233
    let col = named_column(&app, p.id, &spec).await?;
234
    if !pdb::remove_column(&app.db, p.id, col.id).await? {
235
        return Err(ApiError(StatusCode::CONFLICT, "a board keeps at least one column".into()));
236
    }
237
    board_of(&app, &c, &owner, number).await
238
}
239
240
/// A column named by id or name, or 404.
241
async fn named_column(app: &Shared, project_id: i64, spec: &str) -> Result<pdb::Column, ApiError> {
242
    let cols = pdb::columns(&app.db, project_id).await?;
243
    cols.into_iter()
244
        .find(|c| c.id.to_string() == spec.trim() || c.name.eq_ignore_ascii_case(spec.trim()))
245
        .ok_or_else(|| ApiError(StatusCode::NOT_FOUND, format!("no column {spec}")))
ef20fdc1 Andy McCall ↶ 246
}
247
17a3a84b Andy McCall ↶ 248
/// `GET /projects/{owner}/{n}/cards`: the cards by column, as the board
249
/// has them.
439ecd87 Andy McCall ↶ 250
#[derive(serde::Deserialize, Default)]
251
pub struct CardsQuery {
252
    /// The archived cards instead (#293).
253
    #[serde(default)]
254
    archived: bool,
255
}
256
257
/// `GET /projects/{owner}/{n}/cards`, `?archived=true` for the archived ones.
17a3a84b Andy McCall ↶ 258
pub async fn cards(
259
    State(app): State<Shared>,
260
    headers: HeaderMap,
261
    Path((owner, number)): Path<(String, i64)>,
439ecd87 Andy McCall ↶ 262
    Query(q): Query<CardsQuery>,
17a3a84b Andy McCall ↶ 263
) -> Result<Json<Vec<ProjectColumn>>, ApiError> {
439ecd87 Andy McCall ↶ 264
    if !q.archived {
265
        return Ok(Json(board(State(app), headers, Path((owner, number))).await?.0.columns));
266
    }
267
    let c = caller(&app, &headers).await?;
268
    let (_, p) = visible(&app, &c, &owner, number).await?;
269
    let (columns, _) = wp::board_columns(&app, c.account.as_ref(), &owner, &p, true).await?;
270
    Ok(Json(
271
        columns
272
            .iter()
273
            .map(|col| ProjectColumn { id: col.column.id, name: col.column.name.clone(), cards: col.cards.iter().map(card_of).collect() })
274
            .collect(),
275
    ))
17a3a84b Andy McCall ↶ 276
}
277
ef20fdc1 Andy McCall ↶ 278
/// `POST /projects/{owner}/{n}/cards`.
279
pub async fn add_card(
280
    State(app): State<Shared>,
281
    headers: HeaderMap,
282
    Path((owner, number)): Path<(String, i64)>,
283
    Json(body): Json<NewCard>,
284
) -> Result<(StatusCode, Json<ProjectCard>), ApiError> {
285
    let (c, p) = changeable(&app, &headers, &owner, number, false).await?;
286
    let col = column(&app, p.id, body.column.as_deref()).await?;
287
    let actor = c.account.as_ref().map(|a| a.username.clone()).unwrap_or_default();
288
    let card = match wp::add_card(&app, c.account.as_ref(), &owner, p.id, col.id, &body.reference, "", &body.note, &actor).await? {
289
        Ok(card) => card,
290
        Err(why) => return Err(ApiError(StatusCode::BAD_REQUEST, why)),
291
    };
292
    // Answer with the card as the board shows it.
439ecd87 Andy McCall ↶ 293
    let (columns, _) = wp::board_columns(&app, c.account.as_ref(), &owner, &p, false).await?;
ef20fdc1 Andy McCall ↶ 294
    let view = columns
295
        .iter()
296
        .flat_map(|col| col.cards.iter())
297
        .find(|v| v.card.id == card.id)
298
        .map(card_of)
299
        .ok_or_else(|| not_found("no such card"))?;
300
    Ok((StatusCode::CREATED, Json(view)))
301
}
302
303
/// `PATCH /projects/{owner}/{n}/cards/{id}`: move to another column.
304
pub async fn move_card(
305
    State(app): State<Shared>,
306
    headers: HeaderMap,
307
    Path((owner, number, id)): Path<(String, i64, i64)>,
308
    Json(body): Json<CardMove>,
309
) -> Result<StatusCode, ApiError> {
310
    let (_, p) = changeable(&app, &headers, &owner, number, false).await?;
311
    let col = column(&app, p.id, Some(&body.column)).await?;
312
    if !pdb::cards(&app.db, p.id).await?.iter().any(|c| c.id == id) {
313
        return Err(not_found("no such card"));
314
    }
315
    pdb::move_card(&app.db, p.id, id, col.id).await?;
316
    Ok(StatusCode::NO_CONTENT)
317
}
318
456f4197 Andy McCall ↶ 319
/// Whether `card` is the one `name` names: its id, or its issue or
320
/// proposal as `12`, `#12`, `name#12` or `owner/name#12`.
321
fn names_card(name: &str, card: &ProjectCard) -> bool {
322
    let name = name.trim();
323
    if name.is_empty() {
324
        return false;
325
    }
326
    if name.parse::<i64>().is_ok_and(|id| id == card.id) {
327
        return true;
328
    }
329
    let Some((_, number)) = card.reference.rsplit_once('#') else { return false };
330
    match name.rsplit_once('#') {
331
        None => name == number,
332
        Some(("", n)) => n == number,
333
        Some((repo, n)) => n == number && (card.reference == format!("{repo}#{n}") || card.reference.ends_with(&format!("/{repo}#{n}"))),
334
    }
335
}
336
337
/// `POST /projects/{owner}/{n}/cards/move` (#289): a column's cards to
338
/// another at once, with exceptions and a state filter; one audit entry.
339
pub async fn move_cards(
340
    State(app): State<Shared>,
341
    headers: HeaderMap,
342
    Path((owner, number)): Path<(String, i64)>,
343
    Json(body): Json<CardsMove>,
344
) -> Result<Json<CardsMoved>, ApiError> {
345
    let (c, p) = changeable(&app, &headers, &owner, number, false).await?;
346
    let from = column(&app, p.id, Some(&body.from)).await?;
347
    let to = column(&app, p.id, Some(&body.column)).await?;
348
    if from.id == to.id {
349
        return Err(ApiError(StatusCode::BAD_REQUEST, "the cards are in that column already".into()));
350
    }
439ecd87 Andy McCall ↶ 351
    let (columns, _) = wp::board_columns(&app, c.account.as_ref(), &owner, &p, false).await?;
456f4197 Andy McCall ↶ 352
    let cards: Vec<ProjectCard> =
353
        columns.iter().filter(|col| col.column.id == from.id).flat_map(|col| col.cards.iter().map(card_of)).collect();
354
    let states: Vec<String> = body.state.iter().map(|s| s.trim().to_ascii_lowercase()).filter(|s| !s.is_empty()).collect();
355
    let (moved, kept): (Vec<ProjectCard>, Vec<ProjectCard>) = cards.into_iter().partition(|card| {
356
        !body.except.iter().any(|e| names_card(e, card)) && (states.is_empty() || states.iter().any(|s| card.state.eq_ignore_ascii_case(s)))
357
    });
358
    if !body.dry_run && !moved.is_empty() {
359
        let ids: Vec<i64> = moved.iter().map(|c| c.id).collect();
360
        pdb::move_cards(&app.db, p.id, &ids, to.id).await?;
361
        let detail = format!("{} card(s) from {} to {}", moved.len(), from.name, to.name);
362
        crate::db::accounts::audit(&app.db, c.account.as_ref(), "project.cards_moved", &format!("{owner}/{number}"), &detail).await.ok();
363
    }
364
    Ok(Json(CardsMoved { moved, kept, dry_run: body.dry_run }))
439ecd87 Andy McCall ↶ 365
}
366
367
/// `POST /projects/{owner}/{n}/cards/archive` (#293): a column's cards off
368
/// the board at once, kept, with #289's exceptions and state filter and an
369
/// age; one audit entry.
370
pub async fn archive_cards(
371
    State(app): State<Shared>,
372
    headers: HeaderMap,
373
    Path((owner, number)): Path<(String, i64)>,
374
    Json(body): Json<CardsArchive>,
375
) -> Result<Json<CardsArchived>, ApiError> {
376
    let (c, p) = changeable(&app, &headers, &owner, number, false).await?;
377
    let from = column(&app, p.id, Some(&body.from)).await?;
378
    if body.older_days.is_some_and(|d| !(0..=3650).contains(&d)) {
379
        return Err(ApiError(StatusCode::BAD_REQUEST, "older_days is 0 to 3650".into()));
380
    }
381
    let (columns, _) = wp::board_columns(&app, c.account.as_ref(), &owner, &p, false).await?;
382
    let now = crate::db::now_ms();
383
    let states: Vec<String> = body.state.iter().map(|s| s.trim().to_ascii_lowercase()).filter(|s| !s.is_empty()).collect();
384
    let (archived, kept): (Vec<&wp::CardView>, Vec<&wp::CardView>) =
385
        columns.iter().filter(|col| col.column.id == from.id).flat_map(|col| col.cards.iter()).partition(|v| {
386
            let card = card_of(v);
387
            !body.except.iter().any(|e| names_card(e, &card))
388
                && (states.is_empty() || states.iter().any(|s| card.state.eq_ignore_ascii_case(s)))
389
                && body.older_days.is_none_or(|d| pdb::older_than(&v.card, d, now))
390
        });
391
    if !body.dry_run && !archived.is_empty() {
392
        let ids: Vec<i64> = archived.iter().map(|v| v.card.id).collect();
393
        pdb::archive_cards(&app.db, p.id, &ids).await?;
394
        let detail = format!("{} card(s) of {}", ids.len(), from.name);
395
        crate::db::accounts::audit(&app.db, c.account.as_ref(), "project.cards_archived", &format!("{owner}/{number}"), &detail).await.ok();
396
    }
397
    let stamp = |v: &wp::CardView| ProjectCard { archived_ms: (!body.dry_run).then_some(now), ..card_of(v) };
398
    Ok(Json(CardsArchived {
399
        archived: archived.into_iter().map(stamp).collect(),
400
        kept: kept.into_iter().map(card_of).collect(),
401
        dry_run: body.dry_run,
402
    }))
403
}
404
405
/// `POST /projects/{owner}/{n}/cards/{id}/restore` (#293): an archived
406
/// card back on the board, at the end of its column.
407
pub async fn restore_card(
408
    State(app): State<Shared>,
409
    headers: HeaderMap,
410
    Path((owner, number, id)): Path<(String, i64, i64)>,
411
) -> Result<StatusCode, ApiError> {
412
    let (_, p) = changeable(&app, &headers, &owner, number, false).await?;
413
    if !pdb::cards(&app.db, p.id).await?.iter().any(|c| c.id == id && c.archived_ms.is_some()) {
414
        return Err(not_found("no such archived card"));
415
    }
416
    pdb::restore_card(&app.db, p.id, id).await?;
417
    Ok(StatusCode::NO_CONTENT)
456f4197 Andy McCall ↶ 418
}
419
ef20fdc1 Andy McCall ↶ 420
/// `DELETE /projects/{owner}/{n}/cards/{id}`.
421
pub async fn remove_card(
422
    State(app): State<Shared>,
423
    headers: HeaderMap,
424
    Path((owner, number, id)): Path<(String, i64, i64)>,
425
) -> Result<StatusCode, ApiError> {
426
    let (_, p) = changeable(&app, &headers, &owner, number, false).await?;
427
    if !pdb::cards(&app.db, p.id).await?.iter().any(|c| c.id == id) {
428
        return Err(not_found("no such card"));
429
    }
430
    pdb::remove_card(&app.db, p.id, id).await?;
431
    Ok(StatusCode::NO_CONTENT)
432
}