OXYGENHUB
# ae138eea7a71 oxygenhub / crates / hub / src / api / projects.rs
7.7 KiB · Rust · last changed Projects API: list, create, board, edit, and cards by reference or note, moved and removed, with the pages' rules 1 month 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;
8
use axum::extract::{Path, State};
9
use axum::http::{HeaderMap, StatusCode};
10
use axum::Json;
11
use hub_api::{Board, CardMove, 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 { id: v.card.id, kind: v.card.kind.clone(), reference: v.reference.clone(), title: v.title.clone(), state: v.state.clone() }
28
}
29
30
async fn rights(app: &Shared, c: &Caller, owner: &str) -> Result<wp::Rights, ApiError> {
31
    wp::rights_of(app, c.account.as_ref(), owner).await?.ok_or_else(|| not_found("no such owner"))
32
}
33
34
/// A project the caller may see.
35
async fn visible(app: &Shared, c: &Caller, owner: &str, number: i64) -> Result<(wp::Rights, pdb::Project), ApiError> {
36
    let r = rights(app, c, owner).await?;
37
    let p = pdb::get(&app.db, owner, number).await?.filter(|p| p.public || r.member).ok_or_else(|| not_found("no such project"))?;
38
    Ok((r, p))
39
}
40
41
/// A project the caller may change: a write token, edit rights, and open unless `closed_ok`.
42
async fn changeable(
43
    app: &Shared,
44
    headers: &HeaderMap,
45
    owner: &str,
46
    number: i64,
47
    closed_ok: bool,
48
) -> Result<(Caller, pdb::Project), ApiError> {
49
    let c = caller(app, headers).await?;
50
    c.require("repo:write")?;
51
    let (r, p) = visible(app, &c, owner, number).await?;
52
    if !r.edit {
53
        return Err(forbidden("only the owner (or the organisation's members) may change this project"));
54
    }
55
    if p.closed && !closed_ok {
56
        return Err(ApiError(StatusCode::CONFLICT, "this project is closed; reopen it to change it".into()));
57
    }
58
    Ok((c, p))
59
}
60
61
/// A column by id or by name (case-insensitive); the first when absent.
62
async fn column(app: &Shared, project_id: i64, spec: Option<&str>) -> Result<pdb::Column, ApiError> {
63
    let cols = pdb::columns(&app.db, project_id).await?;
64
    let found = match spec.map(str::trim).filter(|s| !s.is_empty()) {
65
        None => cols.into_iter().next(),
66
        Some(s) => cols.into_iter().find(|c| c.id.to_string() == s || c.name.eq_ignore_ascii_case(s)),
67
    };
68
    found.ok_or_else(|| ApiError(StatusCode::BAD_REQUEST, "no such column".into()))
69
}
70
71
/// `GET /projects/{owner}`.
72
pub async fn list(State(app): State<Shared>, headers: HeaderMap, Path(owner): Path<String>) -> Result<Json<Vec<Project>>, ApiError> {
73
    let c = caller(&app, &headers).await?;
74
    let r = rights(&app, &c, &owner).await?;
75
    let list = pdb::of_owner(&app.db, &owner).await?;
76
    Ok(Json(list.iter().filter(|p| p.public || r.member).map(|p| project_of(&app, p)).collect()))
77
}
78
79
/// `POST /projects/{owner}`.
80
pub async fn create(
81
    State(app): State<Shared>,
82
    headers: HeaderMap,
83
    Path(owner): Path<String>,
84
    Json(body): Json<NewProject>,
85
) -> Result<(StatusCode, Json<Project>), ApiError> {
86
    let c = caller(&app, &headers).await?;
87
    c.require("repo:write")?;
88
    if !rights(&app, &c, &owner).await?.edit {
89
        return Err(forbidden("only the owner (or the organisation's members) may create projects"));
90
    }
91
    let title = body.title.trim();
92
    if title.is_empty() || title.chars().count() > 100 {
93
        return Err(ApiError(StatusCode::BAD_REQUEST, "a project needs a title of up to 100 characters".into()));
94
    }
95
    let p = pdb::create(&app.db, &owner, title, body.description.trim(), !body.private).await?;
96
    crate::db::accounts::audit(&app.db, c.account.as_ref(), "project.created", &format!("{owner}/{}", p.number), title).await.ok();
97
    Ok((StatusCode::CREATED, Json(project_of(&app, &p))))
98
}
99
100
/// `GET /projects/{owner}/{n}`.
101
pub async fn board(
102
    State(app): State<Shared>,
103
    headers: HeaderMap,
104
    Path((owner, number)): Path<(String, i64)>,
105
) -> Result<Json<Board>, ApiError> {
106
    let c = caller(&app, &headers).await?;
107
    let (_, p) = visible(&app, &c, &owner, number).await?;
108
    let (columns, _) = wp::board_columns(&app, c.account.as_ref(), &owner, &p).await?;
109
    Ok(Json(Board {
110
        project: project_of(&app, &p),
111
        columns: columns
112
            .iter()
113
            .map(|col| ProjectColumn { id: col.column.id, name: col.column.name.clone(), cards: col.cards.iter().map(card_of).collect() })
114
            .collect(),
115
    }))
116
}
117
118
/// `PATCH /projects/{owner}/{n}`.
119
pub async fn edit(
120
    State(app): State<Shared>,
121
    headers: HeaderMap,
122
    Path((owner, number)): Path<(String, i64)>,
123
    Json(body): Json<ProjectEdit>,
124
) -> Result<Json<Project>, ApiError> {
125
    let (_, p) = changeable(&app, &headers, &owner, number, true).await?;
126
    let title = body.title.as_deref().map(str::trim).filter(|t| !t.is_empty()).unwrap_or(&p.title).chars().take(100).collect::<String>();
127
    pdb::set(
128
        &app.db,
129
        p.id,
130
        &title,
131
        body.description.as_deref().map(str::trim).unwrap_or(&p.description),
132
        body.private.map(|x| !x).unwrap_or(p.public),
133
        body.closed.unwrap_or(p.closed),
134
    )
135
    .await?;
136
    let fresh = pdb::get(&app.db, &owner, number).await?.unwrap_or(p);
137
    Ok(Json(project_of(&app, &fresh)))
138
}
139
140
/// `POST /projects/{owner}/{n}/cards`.
141
pub async fn add_card(
142
    State(app): State<Shared>,
143
    headers: HeaderMap,
144
    Path((owner, number)): Path<(String, i64)>,
145
    Json(body): Json<NewCard>,
146
) -> Result<(StatusCode, Json<ProjectCard>), ApiError> {
147
    let (c, p) = changeable(&app, &headers, &owner, number, false).await?;
148
    let col = column(&app, p.id, body.column.as_deref()).await?;
149
    let actor = c.account.as_ref().map(|a| a.username.clone()).unwrap_or_default();
150
    let card = match wp::add_card(&app, c.account.as_ref(), &owner, p.id, col.id, &body.reference, "", &body.note, &actor).await? {
151
        Ok(card) => card,
152
        Err(why) => return Err(ApiError(StatusCode::BAD_REQUEST, why)),
153
    };
154
    // Answer with the card as the board shows it.
155
    let (columns, _) = wp::board_columns(&app, c.account.as_ref(), &owner, &p).await?;
156
    let view = columns
157
        .iter()
158
        .flat_map(|col| col.cards.iter())
159
        .find(|v| v.card.id == card.id)
160
        .map(card_of)
161
        .ok_or_else(|| not_found("no such card"))?;
162
    Ok((StatusCode::CREATED, Json(view)))
163
}
164
165
/// `PATCH /projects/{owner}/{n}/cards/{id}`: move to another column.
166
pub async fn move_card(
167
    State(app): State<Shared>,
168
    headers: HeaderMap,
169
    Path((owner, number, id)): Path<(String, i64, i64)>,
170
    Json(body): Json<CardMove>,
171
) -> Result<StatusCode, ApiError> {
172
    let (_, p) = changeable(&app, &headers, &owner, number, false).await?;
173
    let col = column(&app, p.id, Some(&body.column)).await?;
174
    if !pdb::cards(&app.db, p.id).await?.iter().any(|c| c.id == id) {
175
        return Err(not_found("no such card"));
176
    }
177
    pdb::move_card(&app.db, p.id, id, col.id).await?;
178
    Ok(StatusCode::NO_CONTENT)
179
}
180
181
/// `DELETE /projects/{owner}/{n}/cards/{id}`.
182
pub async fn remove_card(
183
    State(app): State<Shared>,
184
    headers: HeaderMap,
185
    Path((owner, number, id)): Path<(String, i64, i64)>,
186
) -> Result<StatusCode, ApiError> {
187
    let (_, p) = changeable(&app, &headers, &owner, number, false).await?;
188
    if !pdb::cards(&app.db, p.id).await?.iter().any(|c| c.id == id) {
189
        return Err(not_found("no such card"));
190
    }
191
    pdb::remove_card(&app.db, p.id, id).await?;
192
    Ok(StatusCode::NO_CONTENT)
193
}