OXYGENHUB
◆ v0.9.6 oxygenhub / crates / hub / src / api / projects.rs
14.9 KiB · Rust · last changed Board cards can be archived, by hand or by age (refs #293) 10 days ago source blame history raw
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;
8
use axum::extract::{Path, Query, State};
9
use axum::http::{HeaderMap, StatusCode};
10
use axum::Json;
11
use hub_api::{
12
    Board, CardMove, CardsArchive, CardsArchived, CardsMove, CardsMoved, NewCard, NewProject, Project, ProjectCard, ProjectColumn,
13
    ProjectEdit,
14
};
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 {
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(),
38
        archived_ms: v.card.archived_ms,
39
    }
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?;
119
    let (_, p) = visible(&app, &c, &owner, number).await?;
120
    let (columns, _) = wp::board_columns(&app, c.account.as_ref(), &owner, &p, false).await?;
121
    Ok(Json(Board {
122
        project: project_of(&app, &p),
123
        columns: columns
124
            .iter()
125
            .map(|col| ProjectColumn { id: col.column.id, name: col.column.name.clone(), cards: col.cards.iter().map(card_of).collect() })
126
            .collect(),
127
    }))
128
}
129
130
/// `PATCH /projects/{owner}/{n}`.
131
pub async fn edit(
132
    State(app): State<Shared>,
133
    headers: HeaderMap,
134
    Path((owner, number)): Path<(String, i64)>,
135
    Json(body): Json<ProjectEdit>,
136
) -> Result<Json<Project>, ApiError> {
137
    let (c, p) = changeable(&app, &headers, &owner, number, true).await?;
138
    // A transfer (#125) first: the other fields then apply where it went.
139
    let (owner, number) = match body.owner.as_deref().map(str::trim).filter(|to| !to.is_empty() && *to != owner) {
140
        Some(to) => match wp::rights_of(&app, c.account.as_ref(), to).await? {
141
            Some(r) if r.edit => {
142
                let moved = pdb::transfer(&app.db, p.id, to).await?;
143
                let detail = format!("{owner}/{number} to {to}/{}", moved.number);
144
                crate::db::accounts::audit(&app.db, c.account.as_ref(), "project.transferred", &detail, &p.title).await.ok();
145
                (moved.owner, moved.number)
146
            }
147
            _ => return Err(ApiError(StatusCode::FORBIDDEN, format!("you cannot make projects under {to}"))),
148
        },
149
        None => (owner, number),
150
    };
151
    let p = pdb::get(&app.db, &owner, number).await?.unwrap_or(p);
152
    let title = body.title.as_deref().map(str::trim).filter(|t| !t.is_empty()).unwrap_or(&p.title).chars().take(100).collect::<String>();
153
    pdb::set(
154
        &app.db,
155
        p.id,
156
        &title,
157
        body.description.as_deref().map(str::trim).unwrap_or(&p.description),
158
        body.private.map(|x| !x).unwrap_or(p.public),
159
        body.closed.unwrap_or(p.closed),
160
    )
161
    .await?;
162
    let fresh = pdb::get(&app.db, &owner, number).await?.unwrap_or(p);
163
    Ok(Json(project_of(&app, &fresh)))
164
}
165
166
/// `GET /projects/{owner}/{n}/cards`: the cards by column, as the board
167
/// has them.
168
#[derive(serde::Deserialize, Default)]
169
pub struct CardsQuery {
170
    /// The archived cards instead (#293).
171
    #[serde(default)]
172
    archived: bool,
173
}
174
175
/// `GET /projects/{owner}/{n}/cards`, `?archived=true` for the archived ones.
176
pub async fn cards(
177
    State(app): State<Shared>,
178
    headers: HeaderMap,
179
    Path((owner, number)): Path<(String, i64)>,
180
    Query(q): Query<CardsQuery>,
181
) -> Result<Json<Vec<ProjectColumn>>, ApiError> {
182
    if !q.archived {
183
        return Ok(Json(board(State(app), headers, Path((owner, number))).await?.0.columns));
184
    }
185
    let c = caller(&app, &headers).await?;
186
    let (_, p) = visible(&app, &c, &owner, number).await?;
187
    let (columns, _) = wp::board_columns(&app, c.account.as_ref(), &owner, &p, true).await?;
188
    Ok(Json(
189
        columns
190
            .iter()
191
            .map(|col| ProjectColumn { id: col.column.id, name: col.column.name.clone(), cards: col.cards.iter().map(card_of).collect() })
192
            .collect(),
193
    ))
194
}
195
196
/// `POST /projects/{owner}/{n}/cards`.
197
pub async fn add_card(
198
    State(app): State<Shared>,
199
    headers: HeaderMap,
200
    Path((owner, number)): Path<(String, i64)>,
201
    Json(body): Json<NewCard>,
202
) -> Result<(StatusCode, Json<ProjectCard>), ApiError> {
203
    let (c, p) = changeable(&app, &headers, &owner, number, false).await?;
204
    let col = column(&app, p.id, body.column.as_deref()).await?;
205
    let actor = c.account.as_ref().map(|a| a.username.clone()).unwrap_or_default();
206
    let card = match wp::add_card(&app, c.account.as_ref(), &owner, p.id, col.id, &body.reference, "", &body.note, &actor).await? {
207
        Ok(card) => card,
208
        Err(why) => return Err(ApiError(StatusCode::BAD_REQUEST, why)),
209
    };
210
    // Answer with the card as the board shows it.
211
    let (columns, _) = wp::board_columns(&app, c.account.as_ref(), &owner, &p, false).await?;
212
    let view = columns
213
        .iter()
214
        .flat_map(|col| col.cards.iter())
215
        .find(|v| v.card.id == card.id)
216
        .map(card_of)
217
        .ok_or_else(|| not_found("no such card"))?;
218
    Ok((StatusCode::CREATED, Json(view)))
219
}
220
221
/// `PATCH /projects/{owner}/{n}/cards/{id}`: move to another column.
222
pub async fn move_card(
223
    State(app): State<Shared>,
224
    headers: HeaderMap,
225
    Path((owner, number, id)): Path<(String, i64, i64)>,
226
    Json(body): Json<CardMove>,
227
) -> Result<StatusCode, ApiError> {
228
    let (_, p) = changeable(&app, &headers, &owner, number, false).await?;
229
    let col = column(&app, p.id, Some(&body.column)).await?;
230
    if !pdb::cards(&app.db, p.id).await?.iter().any(|c| c.id == id) {
231
        return Err(not_found("no such card"));
232
    }
233
    pdb::move_card(&app.db, p.id, id, col.id).await?;
234
    Ok(StatusCode::NO_CONTENT)
235
}
236
237
/// Whether `card` is the one `name` names: its id, or its issue or
238
/// proposal as `12`, `#12`, `name#12` or `owner/name#12`.
239
fn names_card(name: &str, card: &ProjectCard) -> bool {
240
    let name = name.trim();
241
    if name.is_empty() {
242
        return false;
243
    }
244
    if name.parse::<i64>().is_ok_and(|id| id == card.id) {
245
        return true;
246
    }
247
    let Some((_, number)) = card.reference.rsplit_once('#') else { return false };
248
    match name.rsplit_once('#') {
249
        None => name == number,
250
        Some(("", n)) => n == number,
251
        Some((repo, n)) => n == number && (card.reference == format!("{repo}#{n}") || card.reference.ends_with(&format!("/{repo}#{n}"))),
252
    }
253
}
254
255
/// `POST /projects/{owner}/{n}/cards/move` (#289): a column's cards to
256
/// another at once, with exceptions and a state filter; one audit entry.
257
pub async fn move_cards(
258
    State(app): State<Shared>,
259
    headers: HeaderMap,
260
    Path((owner, number)): Path<(String, i64)>,
261
    Json(body): Json<CardsMove>,
262
) -> Result<Json<CardsMoved>, ApiError> {
263
    let (c, p) = changeable(&app, &headers, &owner, number, false).await?;
264
    let from = column(&app, p.id, Some(&body.from)).await?;
265
    let to = column(&app, p.id, Some(&body.column)).await?;
266
    if from.id == to.id {
267
        return Err(ApiError(StatusCode::BAD_REQUEST, "the cards are in that column already".into()));
268
    }
269
    let (columns, _) = wp::board_columns(&app, c.account.as_ref(), &owner, &p, false).await?;
270
    let cards: Vec<ProjectCard> =
271
        columns.iter().filter(|col| col.column.id == from.id).flat_map(|col| col.cards.iter().map(card_of)).collect();
272
    let states: Vec<String> = body.state.iter().map(|s| s.trim().to_ascii_lowercase()).filter(|s| !s.is_empty()).collect();
273
    let (moved, kept): (Vec<ProjectCard>, Vec<ProjectCard>) = cards.into_iter().partition(|card| {
274
        !body.except.iter().any(|e| names_card(e, card)) && (states.is_empty() || states.iter().any(|s| card.state.eq_ignore_ascii_case(s)))
275
    });
276
    if !body.dry_run && !moved.is_empty() {
277
        let ids: Vec<i64> = moved.iter().map(|c| c.id).collect();
278
        pdb::move_cards(&app.db, p.id, &ids, to.id).await?;
279
        let detail = format!("{} card(s) from {} to {}", moved.len(), from.name, to.name);
280
        crate::db::accounts::audit(&app.db, c.account.as_ref(), "project.cards_moved", &format!("{owner}/{number}"), &detail).await.ok();
281
    }
282
    Ok(Json(CardsMoved { moved, kept, dry_run: body.dry_run }))
283
}
284
285
/// `POST /projects/{owner}/{n}/cards/archive` (#293): a column's cards off
286
/// the board at once, kept, with #289's exceptions and state filter and an
287
/// age; one audit entry.
288
pub async fn archive_cards(
289
    State(app): State<Shared>,
290
    headers: HeaderMap,
291
    Path((owner, number)): Path<(String, i64)>,
292
    Json(body): Json<CardsArchive>,
293
) -> Result<Json<CardsArchived>, ApiError> {
294
    let (c, p) = changeable(&app, &headers, &owner, number, false).await?;
295
    let from = column(&app, p.id, Some(&body.from)).await?;
296
    if body.older_days.is_some_and(|d| !(0..=3650).contains(&d)) {
297
        return Err(ApiError(StatusCode::BAD_REQUEST, "older_days is 0 to 3650".into()));
298
    }
299
    let (columns, _) = wp::board_columns(&app, c.account.as_ref(), &owner, &p, false).await?;
300
    let now = crate::db::now_ms();
301
    let states: Vec<String> = body.state.iter().map(|s| s.trim().to_ascii_lowercase()).filter(|s| !s.is_empty()).collect();
302
    let (archived, kept): (Vec<&wp::CardView>, Vec<&wp::CardView>) =
303
        columns.iter().filter(|col| col.column.id == from.id).flat_map(|col| col.cards.iter()).partition(|v| {
304
            let card = card_of(v);
305
            !body.except.iter().any(|e| names_card(e, &card))
306
                && (states.is_empty() || states.iter().any(|s| card.state.eq_ignore_ascii_case(s)))
307
                && body.older_days.is_none_or(|d| pdb::older_than(&v.card, d, now))
308
        });
309
    if !body.dry_run && !archived.is_empty() {
310
        let ids: Vec<i64> = archived.iter().map(|v| v.card.id).collect();
311
        pdb::archive_cards(&app.db, p.id, &ids).await?;
312
        let detail = format!("{} card(s) of {}", ids.len(), from.name);
313
        crate::db::accounts::audit(&app.db, c.account.as_ref(), "project.cards_archived", &format!("{owner}/{number}"), &detail).await.ok();
314
    }
315
    let stamp = |v: &wp::CardView| ProjectCard { archived_ms: (!body.dry_run).then_some(now), ..card_of(v) };
316
    Ok(Json(CardsArchived {
317
        archived: archived.into_iter().map(stamp).collect(),
318
        kept: kept.into_iter().map(card_of).collect(),
319
        dry_run: body.dry_run,
320
    }))
321
}
322
323
/// `POST /projects/{owner}/{n}/cards/{id}/restore` (#293): an archived
324
/// card back on the board, at the end of its column.
325
pub async fn restore_card(
326
    State(app): State<Shared>,
327
    headers: HeaderMap,
328
    Path((owner, number, id)): Path<(String, i64, i64)>,
329
) -> Result<StatusCode, ApiError> {
330
    let (_, p) = changeable(&app, &headers, &owner, number, false).await?;
331
    if !pdb::cards(&app.db, p.id).await?.iter().any(|c| c.id == id && c.archived_ms.is_some()) {
332
        return Err(not_found("no such archived card"));
333
    }
334
    pdb::restore_card(&app.db, p.id, id).await?;
335
    Ok(StatusCode::NO_CONTENT)
336
}
337
338
/// `DELETE /projects/{owner}/{n}/cards/{id}`.
339
pub async fn remove_card(
340
    State(app): State<Shared>,
341
    headers: HeaderMap,
342
    Path((owner, number, id)): Path<(String, i64, i64)>,
343
) -> Result<StatusCode, ApiError> {
344
    let (_, p) = changeable(&app, &headers, &owner, number, false).await?;
345
    if !pdb::cards(&app.db, p.id).await?.iter().any(|c| c.id == id) {
346
        return Err(not_found("no such card"));
347
    }
348
    pdb::remove_card(&app.db, p.id, id).await?;
349
    Ok(StatusCode::NO_CONTENT)
350
}