OXYGENHUB
# 6a306cd03fc1 oxygenhub / crates / hub / src / api / projects.rs
11.4 KiB · Rust · last changed Board cards show labels and assignees, and the board filters by them (refs #293) 11 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, State};
9
use axum::http::{HeaderMap, StatusCode};
10
use axum::Json;
11
use hub_api::{Board, CardMove, CardsMove, CardsMoved, NewCard, NewProject, Project, ProjectCard, ProjectColumn, ProjectEdit};
12
13
fn project_of(app: &Shared, p: &pdb::Project) -> Project {
14
    Project {
15
        owner: p.owner.clone(),
16
        number: p.number,
17
        title: p.title.clone(),
18
        description: p.description.clone(),
19
        public: p.public,
20
        closed: p.closed,
21
        updated_ms: p.updated_ms,
22
        url: format!("{}/projects/{}/{}", app.config.base_url().trim_end_matches('/'), p.owner, p.number),
23
    }
24
}
25
26
fn card_of(v: &wp::CardView) -> ProjectCard {
27
    ProjectCard {
28
        id: v.card.id,
29
        kind: v.card.kind.clone(),
30
        reference: v.reference.clone(),
31
        title: v.title.clone(),
32
        state: v.state.clone(),
33
        labels: v.labels.iter().map(|l| l.name.clone()).collect(),
34
        assignees: v.assignees.clone(),
35
    }
36
}
37
38
async fn rights(app: &Shared, c: &Caller, owner: &str) -> Result<wp::Rights, ApiError> {
39
    wp::rights_of(app, c.account.as_ref(), owner).await?.ok_or_else(|| not_found("no such owner"))
40
}
41
42
/// A project the caller may see.
43
async fn visible(app: &Shared, c: &Caller, owner: &str, number: i64) -> Result<(wp::Rights, pdb::Project), ApiError> {
44
    let r = rights(app, c, owner).await?;
45
    let p = pdb::get(&app.db, owner, number).await?.filter(|p| p.public || r.member).ok_or_else(|| not_found("no such project"))?;
46
    Ok((r, p))
47
}
48
49
/// A project the caller may change: a write token, edit rights, and open unless `closed_ok`.
50
async fn changeable(
51
    app: &Shared,
52
    headers: &HeaderMap,
53
    owner: &str,
54
    number: i64,
55
    closed_ok: bool,
56
) -> Result<(Caller, pdb::Project), ApiError> {
57
    let c = caller(app, headers).await?;
58
    c.require("repo:write")?;
59
    let (r, p) = visible(app, &c, owner, number).await?;
60
    if !r.edit {
61
        return Err(forbidden("only the owner (or the organisation's members) may change this project"));
62
    }
63
    if p.closed && !closed_ok {
64
        return Err(ApiError(StatusCode::CONFLICT, "this project is closed; reopen it to change it".into()));
65
    }
66
    Ok((c, p))
67
}
68
69
/// A column by id or by name (case-insensitive); the first when absent.
70
async fn column(app: &Shared, project_id: i64, spec: Option<&str>) -> Result<pdb::Column, ApiError> {
71
    let cols = pdb::columns(&app.db, project_id).await?;
72
    let found = match spec.map(str::trim).filter(|s| !s.is_empty()) {
73
        None => cols.into_iter().next(),
74
        Some(s) => cols.into_iter().find(|c| c.id.to_string() == s || c.name.eq_ignore_ascii_case(s)),
75
    };
76
    found.ok_or_else(|| ApiError(StatusCode::BAD_REQUEST, "no such column".into()))
77
}
78
79
/// `GET /projects/{owner}`.
80
pub async fn list(State(app): State<Shared>, headers: HeaderMap, Path(owner): Path<String>) -> Result<Json<Vec<Project>>, ApiError> {
81
    let c = caller(&app, &headers).await?;
82
    let r = rights(&app, &c, &owner).await?;
83
    let list = pdb::of_owner(&app.db, &owner).await?;
84
    Ok(Json(list.iter().filter(|p| p.public || r.member).map(|p| project_of(&app, p)).collect()))
85
}
86
87
/// `POST /projects/{owner}`.
88
pub async fn create(
89
    State(app): State<Shared>,
90
    headers: HeaderMap,
91
    Path(owner): Path<String>,
92
    Json(body): Json<NewProject>,
93
) -> Result<(StatusCode, Json<Project>), ApiError> {
94
    let c = caller(&app, &headers).await?;
95
    c.require("repo:write")?;
96
    if !rights(&app, &c, &owner).await?.edit {
97
        return Err(forbidden("only the owner (or the organisation's members) may create projects"));
98
    }
99
    let title = body.title.trim();
100
    if title.is_empty() || title.chars().count() > 100 {
101
        return Err(ApiError(StatusCode::BAD_REQUEST, "a project needs a title of up to 100 characters".into()));
102
    }
103
    let p = pdb::create(&app.db, &owner, title, body.description.trim(), !body.private).await?;
104
    crate::db::accounts::audit(&app.db, c.account.as_ref(), "project.created", &format!("{owner}/{}", p.number), title).await.ok();
105
    Ok((StatusCode::CREATED, Json(project_of(&app, &p))))
106
}
107
108
/// `GET /projects/{owner}/{n}`.
109
pub async fn board(
110
    State(app): State<Shared>,
111
    headers: HeaderMap,
112
    Path((owner, number)): Path<(String, i64)>,
113
) -> Result<Json<Board>, ApiError> {
114
    let c = caller(&app, &headers).await?;
115
    let (_, p) = visible(&app, &c, &owner, number).await?;
116
    let (columns, _) = wp::board_columns(&app, c.account.as_ref(), &owner, &p).await?;
117
    Ok(Json(Board {
118
        project: project_of(&app, &p),
119
        columns: columns
120
            .iter()
121
            .map(|col| ProjectColumn { id: col.column.id, name: col.column.name.clone(), cards: col.cards.iter().map(card_of).collect() })
122
            .collect(),
123
    }))
124
}
125
126
/// `PATCH /projects/{owner}/{n}`.
127
pub async fn edit(
128
    State(app): State<Shared>,
129
    headers: HeaderMap,
130
    Path((owner, number)): Path<(String, i64)>,
131
    Json(body): Json<ProjectEdit>,
132
) -> Result<Json<Project>, ApiError> {
133
    let (c, p) = changeable(&app, &headers, &owner, number, true).await?;
134
    // A transfer (#125) first: the other fields then apply where it went.
135
    let (owner, number) = match body.owner.as_deref().map(str::trim).filter(|to| !to.is_empty() && *to != owner) {
136
        Some(to) => match wp::rights_of(&app, c.account.as_ref(), to).await? {
137
            Some(r) if r.edit => {
138
                let moved = pdb::transfer(&app.db, p.id, to).await?;
139
                let detail = format!("{owner}/{number} to {to}/{}", moved.number);
140
                crate::db::accounts::audit(&app.db, c.account.as_ref(), "project.transferred", &detail, &p.title).await.ok();
141
                (moved.owner, moved.number)
142
            }
143
            _ => return Err(ApiError(StatusCode::FORBIDDEN, format!("you cannot make projects under {to}"))),
144
        },
145
        None => (owner, number),
146
    };
147
    let p = pdb::get(&app.db, &owner, number).await?.unwrap_or(p);
148
    let title = body.title.as_deref().map(str::trim).filter(|t| !t.is_empty()).unwrap_or(&p.title).chars().take(100).collect::<String>();
149
    pdb::set(
150
        &app.db,
151
        p.id,
152
        &title,
153
        body.description.as_deref().map(str::trim).unwrap_or(&p.description),
154
        body.private.map(|x| !x).unwrap_or(p.public),
155
        body.closed.unwrap_or(p.closed),
156
    )
157
    .await?;
158
    let fresh = pdb::get(&app.db, &owner, number).await?.unwrap_or(p);
159
    Ok(Json(project_of(&app, &fresh)))
160
}
161
162
/// `GET /projects/{owner}/{n}/cards`: the cards by column, as the board
163
/// has them.
164
pub async fn cards(
165
    State(app): State<Shared>,
166
    headers: HeaderMap,
167
    Path((owner, number)): Path<(String, i64)>,
168
) -> Result<Json<Vec<ProjectColumn>>, ApiError> {
169
    Ok(Json(board(State(app), headers, Path((owner, number))).await?.0.columns))
170
}
171
172
/// `POST /projects/{owner}/{n}/cards`.
173
pub async fn add_card(
174
    State(app): State<Shared>,
175
    headers: HeaderMap,
176
    Path((owner, number)): Path<(String, i64)>,
177
    Json(body): Json<NewCard>,
178
) -> Result<(StatusCode, Json<ProjectCard>), ApiError> {
179
    let (c, p) = changeable(&app, &headers, &owner, number, false).await?;
180
    let col = column(&app, p.id, body.column.as_deref()).await?;
181
    let actor = c.account.as_ref().map(|a| a.username.clone()).unwrap_or_default();
182
    let card = match wp::add_card(&app, c.account.as_ref(), &owner, p.id, col.id, &body.reference, "", &body.note, &actor).await? {
183
        Ok(card) => card,
184
        Err(why) => return Err(ApiError(StatusCode::BAD_REQUEST, why)),
185
    };
186
    // Answer with the card as the board shows it.
187
    let (columns, _) = wp::board_columns(&app, c.account.as_ref(), &owner, &p).await?;
188
    let view = columns
189
        .iter()
190
        .flat_map(|col| col.cards.iter())
191
        .find(|v| v.card.id == card.id)
192
        .map(card_of)
193
        .ok_or_else(|| not_found("no such card"))?;
194
    Ok((StatusCode::CREATED, Json(view)))
195
}
196
197
/// `PATCH /projects/{owner}/{n}/cards/{id}`: move to another column.
198
pub async fn move_card(
199
    State(app): State<Shared>,
200
    headers: HeaderMap,
201
    Path((owner, number, id)): Path<(String, i64, i64)>,
202
    Json(body): Json<CardMove>,
203
) -> Result<StatusCode, ApiError> {
204
    let (_, p) = changeable(&app, &headers, &owner, number, false).await?;
205
    let col = column(&app, p.id, Some(&body.column)).await?;
206
    if !pdb::cards(&app.db, p.id).await?.iter().any(|c| c.id == id) {
207
        return Err(not_found("no such card"));
208
    }
209
    pdb::move_card(&app.db, p.id, id, col.id).await?;
210
    Ok(StatusCode::NO_CONTENT)
211
}
212
213
/// Whether `card` is the one `name` names: its id, or its issue or
214
/// proposal as `12`, `#12`, `name#12` or `owner/name#12`.
215
fn names_card(name: &str, card: &ProjectCard) -> bool {
216
    let name = name.trim();
217
    if name.is_empty() {
218
        return false;
219
    }
220
    if name.parse::<i64>().is_ok_and(|id| id == card.id) {
221
        return true;
222
    }
223
    let Some((_, number)) = card.reference.rsplit_once('#') else { return false };
224
    match name.rsplit_once('#') {
225
        None => name == number,
226
        Some(("", n)) => n == number,
227
        Some((repo, n)) => n == number && (card.reference == format!("{repo}#{n}") || card.reference.ends_with(&format!("/{repo}#{n}"))),
228
    }
229
}
230
231
/// `POST /projects/{owner}/{n}/cards/move` (#289): a column's cards to
232
/// another at once, with exceptions and a state filter; one audit entry.
233
pub async fn move_cards(
234
    State(app): State<Shared>,
235
    headers: HeaderMap,
236
    Path((owner, number)): Path<(String, i64)>,
237
    Json(body): Json<CardsMove>,
238
) -> Result<Json<CardsMoved>, ApiError> {
239
    let (c, p) = changeable(&app, &headers, &owner, number, false).await?;
240
    let from = column(&app, p.id, Some(&body.from)).await?;
241
    let to = column(&app, p.id, Some(&body.column)).await?;
242
    if from.id == to.id {
243
        return Err(ApiError(StatusCode::BAD_REQUEST, "the cards are in that column already".into()));
244
    }
245
    let (columns, _) = wp::board_columns(&app, c.account.as_ref(), &owner, &p).await?;
246
    let cards: Vec<ProjectCard> =
247
        columns.iter().filter(|col| col.column.id == from.id).flat_map(|col| col.cards.iter().map(card_of)).collect();
248
    let states: Vec<String> = body.state.iter().map(|s| s.trim().to_ascii_lowercase()).filter(|s| !s.is_empty()).collect();
249
    let (moved, kept): (Vec<ProjectCard>, Vec<ProjectCard>) = cards.into_iter().partition(|card| {
250
        !body.except.iter().any(|e| names_card(e, card)) && (states.is_empty() || states.iter().any(|s| card.state.eq_ignore_ascii_case(s)))
251
    });
252
    if !body.dry_run && !moved.is_empty() {
253
        let ids: Vec<i64> = moved.iter().map(|c| c.id).collect();
254
        pdb::move_cards(&app.db, p.id, &ids, to.id).await?;
255
        let detail = format!("{} card(s) from {} to {}", moved.len(), from.name, to.name);
256
        crate::db::accounts::audit(&app.db, c.account.as_ref(), "project.cards_moved", &format!("{owner}/{number}"), &detail).await.ok();
257
    }
258
    Ok(Json(CardsMoved { moved, kept, dry_run: body.dry_run }))
259
}
260
261
/// `DELETE /projects/{owner}/{n}/cards/{id}`.
262
pub async fn remove_card(
263
    State(app): State<Shared>,
264
    headers: HeaderMap,
265
    Path((owner, number, id)): Path<(String, i64, i64)>,
266
) -> Result<StatusCode, ApiError> {
267
    let (_, p) = changeable(&app, &headers, &owner, number, false).await?;
268
    if !pdb::cards(&app.db, p.id).await?.iter().any(|c| c.id == id) {
269
        return Err(not_found("no such card"));
270
    }
271
    pdb::remove_card(&app.db, p.id, id).await?;
272
    Ok(StatusCode::NO_CONTENT)
273
}