OXYGENHUB
# efb51b39db1c oxygenhub / crates / hub / src / web / projects.rs
17.9 KiB · Rust · last changed Project cards: take owner/repo#N, as the board shows them 28 days ago source blame history raw
1
//! Projects (hub spec §8.2): boards of issues, proposals and notes across
2
//! the repositories of one person or organisation.
3
4
use super::settings::csrf;
5
use super::{filters, Error, Page, Shell};
6
use crate::auth::{roles, Access, Viewer};
7
use crate::db::{self, projects as pdb};
8
use crate::Shared;
9
use askama::Template;
10
use axum::extract::{Form, Path, State};
11
use axum::response::{IntoResponse, Redirect, Response};
12
use serde::Deserialize;
13
14
/// What a caller may do with an owner's projects.
15
pub struct Rights {
16
    /// Sees private projects.
17
    pub member: bool,
18
    /// Creates and changes projects.
19
    pub edit: bool,
20
}
21
22
/// Rights of `account` (anonymous when `None`) over `owner`'s projects;
23
/// `None` when there is no such person or organisation.
24
pub async fn rights_of(app: &Shared, account: Option<&db::accounts::Account>, owner: &str) -> sqlx::Result<Option<Rights>> {
25
    let admin = account.is_some_and(|a| a.is_admin);
26
    if let Some(a) = db::accounts::account_by_name(&app.db, owner).await? {
27
        let me = account.is_some_and(|v| v.id == a.id);
28
        return Ok(Some(Rights { member: me || admin, edit: me || admin }));
29
    }
30
    if let Some(o) = db::accounts::org_by_name(&app.db, owner).await? {
31
        let member = match account {
32
            Some(v) => db::accounts::org_role(&app.db, o.id, v.id).await?.is_some(),
33
            None => false,
34
        };
35
        return Ok(Some(Rights { member: member || admin, edit: member || admin }));
36
    }
37
    Ok(None)
38
}
39
40
async fn rights(app: &Shared, shell: &Shell, viewer: &Viewer, owner: &str) -> Result<Rights, Error> {
41
    rights_of(app, viewer.account(), owner)
42
        .await
43
        .map_err(|e| Error::from_db(shell.clone(), e))?
44
        .ok_or_else(|| Error::not_found(shell.clone()))
45
}
46
47
#[derive(Template)]
48
#[template(path = "projects.html")]
49
pub struct ProjectsPage {
50
    shell: Shell,
51
    owner: String,
52
    projects: Vec<pdb::Project>,
53
    can_edit: bool,
54
    error: Option<String>,
55
}
56
57
pub async fn list(State(app): State<Shared>, viewer: Viewer, Path(owner): Path<String>) -> Result<Page<ProjectsPage>, Error> {
58
    let shell = Shell::new(&app, &format!("/projects/{owner}"), &viewer);
59
    let r = rights(&app, &shell, &viewer, &owner).await?;
60
    let projects = pdb::of_owner(&app.db, &owner)
61
        .await
62
        .map_err(|e| Error::from_db(shell.clone(), e))?
63
        .into_iter()
64
        .filter(|p| p.public || r.member)
65
        .collect();
66
    Ok(Page(ProjectsPage { shell, owner, projects, can_edit: r.edit, error: None }))
67
}
68
69
#[derive(Deserialize)]
70
pub struct NewProjectForm {
71
    #[serde(rename = "_csrf")]
72
    csrf_token: String,
73
    title: String,
74
    #[serde(default)]
75
    description: String,
76
    #[serde(default)]
77
    private: Option<String>,
78
}
79
80
pub async fn create(
81
    State(app): State<Shared>,
82
    viewer: Viewer,
83
    Path(owner): Path<String>,
84
    Form(f): Form<NewProjectForm>,
85
) -> Result<Response, Error> {
86
    let shell = Shell::new(&app, &format!("/projects/{owner}"), &viewer);
87
    csrf(&viewer, &f.csrf_token, &shell)?;
88
    let r = rights(&app, &shell, &viewer, &owner).await?;
89
    if !r.edit {
90
        return Err(Error::not_found(shell));
91
    }
92
    let title = f.title.trim();
93
    if title.is_empty() || title.len() > 100 {
94
        let projects = pdb::of_owner(&app.db, &owner).await.map_err(|e| Error::from_db(shell.clone(), e))?;
95
        return Ok(Page(ProjectsPage {
96
            shell,
97
            owner,
98
            projects,
99
            can_edit: true,
100
            error: Some("A project needs a title of up to 100 characters.".into()),
101
        })
102
        .into_response());
103
    }
104
    let p = pdb::create(&app.db, &owner, title, f.description.trim(), f.private.is_none())
105
        .await
106
        .map_err(|e| Error::from_db(shell.clone(), e))?;
107
    db::accounts::audit(&app.db, viewer.account(), "project.created", &format!("{owner}/{}", p.number), title).await.ok();
108
    Ok(Redirect::to(&format!("/projects/{owner}/{}", p.number)).into_response())
109
}
110
111
/// A card as the board shows it.
112
pub struct CardView {
113
    pub card: pdb::Card,
114
    /// `owner/name#N`, for issue and proposal cards.
115
    pub reference: String,
116
    pub url: String,
117
    pub title: String,
118
    /// `open`, `closed`, `landed`, `draft`… for issues and proposals.
119
    pub state: String,
120
}
121
122
pub struct ColumnView {
123
    pub column: pdb::Column,
124
    pub cards: Vec<CardView>,
125
}
126
127
#[derive(Template)]
128
#[template(path = "project.html")]
129
pub struct BoardPage {
130
    shell: Shell,
131
    project: pdb::Project,
132
    columns: Vec<ColumnView>,
133
    /// The owner's repositories the viewer can read, for adding cards.
134
    repos: Vec<String>,
135
    /// Changes cards and columns (an open project).
136
    can_edit: bool,
137
    /// Changes the settings (to reopen a closed project too).
138
    can_manage: bool,
139
    notice: Option<String>,
140
    error: Option<String>,
141
}
142
143
async fn board(
144
    app: &Shared,
145
    shell: Shell,
146
    viewer: &Viewer,
147
    owner: &str,
148
    number: i64,
149
    notice: Option<String>,
150
    error: Option<String>,
151
) -> Result<Page<BoardPage>, Error> {
152
    let e = |e| Error::from_db(shell.clone(), e);
153
    let r = rights(app, &shell, viewer, owner).await?;
154
    let project = pdb::get(&app.db, owner, number)
155
        .await
156
        .map_err(e)?
157
        .filter(|p| p.public || r.member)
158
        .ok_or_else(|| Error::not_found(shell.clone()))?;
159
    let (columns, repos) = board_columns(app, viewer.account(), owner, &project).await.map_err(e)?;
160
    let can_edit = r.edit && !project.closed;
161
    Ok(Page(BoardPage { shell, project, columns, repos, can_edit, can_manage: r.edit, notice, error }))
162
}
163
164
/// A project's columns with the cards `account` may see, and the owner's
165
/// repositories it can read (for adding cards).
166
pub async fn board_columns(
167
    app: &Shared,
168
    account: Option<&db::accounts::Account>,
169
    owner: &str,
170
    project: &pdb::Project,
171
) -> sqlx::Result<(Vec<ColumnView>, Vec<String>)> {
172
    let mut readable: std::collections::HashMap<i64, db::repos::RepoRow> = Default::default();
173
    for row in db::repos::list_by_owner(&app.db, owner).await? {
174
        let role = roles::role_for(&app.db, account, &row).await?;
175
        if roles::allows(role, Access::Read) {
176
            readable.insert(row.id, row);
177
        }
178
    }
179
    let cards = pdb::cards(&app.db, project.id).await?;
180
    let mut columns = Vec::new();
181
    for column in pdb::columns(&app.db, project.id).await? {
182
        let mut views = Vec::new();
183
        for card in cards.iter().filter(|c| c.column_id == column.id) {
184
            match (card.kind.as_str(), card.repo_id, card.number) {
185
                ("note", _, _) => views.push(CardView {
186
                    card: card.clone(),
187
                    reference: String::new(),
188
                    url: String::new(),
189
                    title: card.note.clone(),
190
                    state: String::new(),
191
                }),
192
                (kind, Some(rid), Some(n)) => {
193
                    // Cards of repositories the viewer cannot read are not shown at all.
194
                    let Some(row) = readable.get(&rid) else { continue };
195
                    let (title, state) = if kind == "issue" {
196
                        match db::issues::get(&app.db, rid, n).await? {
197
                            Some(i) => (i.title, i.state),
198
                            None => continue,
199
                        }
200
                    } else {
201
                        match db::proposals::get(&app.db, rid, n).await? {
202
                            Some(p) => (p.title, p.state),
203
                            None => continue,
204
                        }
205
                    };
206
                    let slug = format!("{}/{}", row.owner, row.name);
207
                    views.push(CardView {
208
                        card: card.clone(),
209
                        reference: format!("{slug}#{n}"),
210
                        url: format!("/{slug}/{kind}/{n}"),
211
                        title,
212
                        state,
213
                    });
214
                }
215
                _ => {}
216
            }
217
        }
218
        columns.push(ColumnView { column, cards: views });
219
    }
220
    let mut repos: Vec<String> = readable.values().map(|r| r.name.clone()).collect();
221
    repos.sort();
222
    Ok((columns, repos))
223
}
224
225
pub async fn show(State(app): State<Shared>, viewer: Viewer, Path((owner, number)): Path<(String, i64)>) -> Result<Page<BoardPage>, Error> {
226
    let shell = Shell::new(&app, &format!("/projects/{owner}/{number}"), &viewer);
227
    board(&app, shell, &viewer, &owner, number, None, None).await
228
}
229
230
#[derive(Deserialize)]
231
pub struct BoardForm {
232
    #[serde(rename = "_csrf")]
233
    csrf_token: String,
234
    action: String,
235
    #[serde(default)]
236
    card: Option<i64>,
237
    #[serde(default)]
238
    column: Option<i64>,
239
    #[serde(default)]
240
    name: String,
241
    /// `repo#12`, or `#12` with `repo`.
242
    #[serde(default)]
243
    reference: String,
244
    #[serde(default)]
245
    repo: String,
246
    #[serde(default)]
247
    note: String,
248
    #[serde(default)]
249
    title: String,
250
    #[serde(default)]
251
    description: String,
252
    #[serde(default)]
253
    private: Option<String>,
254
    #[serde(default)]
255
    closed: Option<String>,
256
}
257
258
/// `repo#12` or `#12` (with a repository chosen) to (repository, number).
259
/// `repo#12`, `#12` with `repo`, or `owner/repo#12` when `owner` is the
260
/// board's (the form the board itself shows, oxygenhub#118). `Err` says
261
/// what is wrong.
262
fn parse_reference(reference: &str, repo: &str, owner: &str) -> Result<(String, i64), String> {
263
    let bad = || "Name an issue or proposal as repo#12, or write a note.".to_string();
264
    let r = reference.trim();
265
    let (name, n) = r.split_once('#').ok_or_else(bad)?;
266
    let name = if name.is_empty() { repo.trim() } else { name.trim() };
267
    let name = match name.split_once('/') {
268
        Some((o, rest)) if o.eq_ignore_ascii_case(owner) => rest,
269
        Some((o, _)) => return Err(format!("This board holds only {owner}'s issues and proposals, not {o}'s.")),
270
        None => name,
271
    };
272
    let n: i64 = n.trim().parse().map_err(|_| bad())?;
273
    if name.is_empty() || n <= 0 || name.contains('/') {
274
        return Err(bad());
275
    }
276
    Ok((name.to_string(), n))
277
}
278
279
/// Add a note, or the issue or proposal `reference` names (`repo#12`, or
280
/// `#12` with `repo`), to a column. `Ok(Err(why))` for what the caller
281
/// should be told: an unknown repository or number, or a card already there.
282
#[allow(clippy::too_many_arguments)]
283
pub async fn add_card(
284
    app: &Shared,
285
    account: Option<&db::accounts::Account>,
286
    owner: &str,
287
    project_id: i64,
288
    column_id: i64,
289
    reference: &str,
290
    repo: &str,
291
    note: &str,
292
    actor: &str,
293
) -> sqlx::Result<Result<pdb::Card, String>> {
294
    if !note.trim().is_empty() {
295
        let note: String = note.trim().chars().take(500).collect();
296
        pdb::add_card(
297
            &app.db,
298
            project_id,
299
            pdb::NewCard { column_id, kind: "note", repo_id: None, number: None, note: &note, added_by: actor },
300
        )
301
        .await?;
302
        return Ok(Ok(newest_card(app, project_id).await?));
303
    }
304
    let (repo, n) = match parse_reference(reference, repo, owner) {
305
        Ok(r) => r,
306
        Err(why) => return Ok(Err(why)),
307
    };
308
    let Some(row) = db::repos::get(&app.db, owner, &repo).await? else { return Ok(Err(format!("{owner} has no repository {repo}."))) };
309
    let role = roles::role_for(&app.db, account, &row).await?;
310
    let (issues, proposals) = db::issues::numbers(&app.db, row.id).await?;
311
    let kind = if issues.contains(&n) {
312
        "issue"
313
    } else if proposals.contains(&n) {
314
        "proposal"
315
    } else {
316
        return Ok(Err(format!("{repo} has no issue or proposal #{n}.")));
317
    };
318
    if !roles::allows(role, Access::Read) {
319
        return Ok(Err(format!("{repo} has no issue or proposal #{n}.")));
320
    }
321
    if !pdb::add_card(
322
        &app.db,
323
        project_id,
324
        pdb::NewCard { column_id, kind, repo_id: Some(row.id), number: Some(n), note: "", added_by: actor },
325
    )
326
    .await?
327
    {
328
        return Ok(Err(format!("{repo}#{n} is already on this project.")));
329
    }
330
    Ok(Ok(newest_card(app, project_id).await?))
331
}
332
333
async fn newest_card(app: &Shared, project_id: i64) -> sqlx::Result<pdb::Card> {
334
    sqlx::query_as("SELECT * FROM project_cards WHERE project_id = ? ORDER BY id DESC LIMIT 1").bind(project_id).fetch_one(&app.db).await
335
}
336
337
pub async fn act(
338
    State(app): State<Shared>,
339
    viewer: Viewer,
340
    Path((owner, number)): Path<(String, i64)>,
341
    Form(f): Form<BoardForm>,
342
) -> Result<Response, Error> {
343
    let shell = Shell::new(&app, &format!("/projects/{owner}/{number}"), &viewer);
344
    csrf(&viewer, &f.csrf_token, &shell)?;
345
    let r = rights(&app, &shell, &viewer, &owner).await?;
346
    let e = |e| Error::from_db(shell.clone(), e);
347
    let project = pdb::get(&app.db, &owner, number)
348
        .await
349
        .map_err(e)?
350
        .filter(|p| p.public || r.member)
351
        .ok_or_else(|| Error::not_found(shell.clone()))?;
352
    if !r.edit {
353
        return Err(Error::not_found(shell));
354
    }
355
    if project.closed && !matches!(f.action.as_str(), "settings" | "delete") {
356
        return Ok(board(&app, shell, &viewer, &owner, number, None, Some("This project is closed; reopen it to change it.".into()))
357
            .await?
358
            .into_response());
359
    }
360
    let actor = viewer.account().map(|a| a.username.clone()).unwrap_or_default();
361
    let columns = pdb::columns(&app.db, project.id).await.map_err(e)?;
362
    let column = f.column.filter(|c| columns.iter().any(|x| x.id == *c)).or(columns.first().map(|c| c.id));
363
    let mut notice = None;
364
    let mut error = None;
365
    match f.action.as_str() {
366
        "add" => {
367
            let Some(column_id) = column else { return Err(Error::bad(shell, "no column")) };
368
            if let Err(msg) =
369
                add_card(&app, viewer.account(), &owner, project.id, column_id, &f.reference, &f.repo, &f.note, &actor).await.map_err(e)?
370
            {
371
                error = Some(msg);
372
            }
373
        }
374
        "move" => {
375
            if let (Some(card), Some(col)) = (f.card, f.column) {
376
                pdb::move_card(&app.db, project.id, card, col).await.map_err(e)?;
377
            }
378
        }
379
        "up" | "down" => {
380
            if let Some(card) = f.card {
381
                pdb::shift_card(&app.db, project.id, card, if f.action == "up" { -1 } else { 1 }).await.map_err(e)?;
382
            }
383
        }
384
        "remove" => {
385
            if let Some(card) = f.card {
386
                pdb::remove_card(&app.db, project.id, card).await.map_err(e)?;
387
            }
388
        }
389
        "add_column" => {
390
            let name = f.name.trim();
391
            if name.is_empty() || name.len() > 40 {
392
                error = Some("A column has a name of up to 40 characters.".into());
393
            } else {
394
                pdb::add_column(&app.db, project.id, name).await.map_err(e)?;
395
            }
396
        }
397
        "rename_column" => {
398
            if let (Some(col), name) = (f.column, f.name.trim()) {
399
                if !name.is_empty() && name.len() <= 40 {
400
                    pdb::rename_column(&app.db, project.id, col, name).await.map_err(e)?;
401
                }
402
            }
403
        }
404
        "left" | "right" => {
405
            if let Some(col) = f.column {
406
                pdb::shift_column(&app.db, project.id, col, if f.action == "left" { -1 } else { 1 }).await.map_err(e)?;
407
            }
408
        }
409
        "remove_column" => {
410
            if let Some(col) = f.column {
411
                if !pdb::remove_column(&app.db, project.id, col).await.map_err(e)? {
412
                    error = Some("A project keeps at least one column.".into());
413
                }
414
            }
415
        }
416
        "settings" => {
417
            let title = if f.title.trim().is_empty() { project.title.clone() } else { f.title.trim().chars().take(100).collect() };
418
            pdb::set(&app.db, project.id, &title, f.description.trim(), f.private.is_none(), f.closed.is_some()).await.map_err(e)?;
419
            notice = Some("Saved.".into());
420
        }
421
        "delete" => {
422
            pdb::delete(&app.db, project.id).await.map_err(e)?;
423
            db::accounts::audit(&app.db, viewer.account(), "project.deleted", &format!("{owner}/{number}"), &project.title).await.ok();
424
            return Ok(Redirect::to(&format!("/projects/{owner}")).into_response());
425
        }
426
        _ => return Err(Error::bad(shell, "unknown action")),
427
    }
428
    if notice.is_none() && error.is_none() {
429
        // Back to the board, so a reload does not repeat the action.
430
        return Ok(Redirect::to(&format!("/projects/{owner}/{number}")).into_response());
431
    }
432
    Ok(board(&app, shell, &viewer, &owner, number, notice, error).await?.into_response())
433
}
434
435
/// The projects an issue or proposal is on that the viewer may see, with
436
/// their column.
437
pub async fn placements_for(app: &Shared, viewer: &Viewer, repo: &db::repos::RepoRow, number: i64) -> Vec<(pdb::Project, String)> {
438
    let Ok(all) = pdb::placements(&app.db, repo.id, number).await else { return vec![] };
439
    let mut out = Vec::new();
440
    for (p, col) in all {
441
        let visible = p.public
442
            || viewer.is_admin()
443
            || match viewer.account() {
444
                Some(v) if v.username == p.owner => true,
445
                Some(v) => match db::accounts::org_by_name(&app.db, &p.owner).await.ok().flatten() {
446
                    Some(o) => db::accounts::org_role(&app.db, o.id, v.id).await.ok().flatten().is_some(),
447
                    None => false,
448
                },
449
                None => false,
450
            };
451
        if visible {
452
            out.push((p, col));
453
        }
454
    }
455
    out
456
}
457
458
#[cfg(test)]
459
mod tests {
460
    use super::parse_reference;
461
462
    #[test]
463
    fn references() {
464
        let p = |r: &str, repo: &str| parse_reference(r, repo, "andy").ok();
465
        assert_eq!(p("oxygen#12", ""), Some(("oxygen".into(), 12)));
466
        assert_eq!(p("#7", "hub"), Some(("hub".into(), 7)));
467
        assert_eq!(p(" hub # 3 ", ""), Some(("hub".into(), 3)));
468
        assert_eq!(p("#7", ""), None, "a repository is needed");
469
        assert_eq!(p("andy/hub#4", ""), Some(("hub".into(), 4)), "the board's own owner, as it shows cards");
470
        assert!(parse_reference("other/repo#1", "", "andy").unwrap_err().contains("only andy's"), "another owner is refused, saying why");
471
        assert_eq!(p("hub#0", ""), None);
472
        assert_eq!(p("hub", ""), None);
473
    }
474
}