OXYGENHUB
◆ v0.3.1 oxygenhub / crates / hub / src / web / orgs.rs
16.3 KiB · Rust · last changed Admins disable, enable and delete accounts 1 month ago source blame history raw
19bb31ff Andy McCall ↶ 1
//! Organisations and teams (hub spec §5.2).
2
3
use super::settings::{csrf, require};
4
use super::{Error, Page, Shell};
5
use crate::auth::{roles, Viewer};
6
use crate::db::accounts;
7
use crate::Shared;
8
use askama::Template;
9
use axum::extract::{Form, Path, State};
10
use axum::response::{IntoResponse, Redirect, Response};
11
use serde::Deserialize;
12
13
#[derive(Template)]
14
#[template(path = "org_new.html")]
15
pub struct OrgNewPage {
16
    shell: Shell,
17
    error: Option<String>,
18
}
19
20
pub async fn new_form(State(app): State<Shared>, viewer: Viewer) -> Result<Page<OrgNewPage>, Error> {
21
    let shell = Shell::new(&app, "/orgs/new", &viewer);
22
    require(&viewer, &shell)?;
23
    Ok(Page(OrgNewPage { shell, error: None }))
24
}
25
26
#[derive(Deserialize)]
27
pub struct OrgNewForm {
28
    #[serde(rename = "_csrf")]
29
    csrf_token: String,
30
    name: String,
31
    display_name: String,
32
}
33
34
pub async fn create(State(app): State<Shared>, viewer: Viewer, Form(f): Form<OrgNewForm>) -> Result<Response, Error> {
35
    let shell = Shell::new(&app, "/orgs/new", &viewer);
36
    let me = require(&viewer, &shell)?;
37
    csrf(&viewer, &f.csrf_token, &shell)?;
38
    let name = f.name.trim().to_string();
39
    if !crate::repos::names::valid_owner(&name) {
40
        return Ok(Page(OrgNewPage {
41
            shell,
42
            error: Some("An organisation name is letters, digits, dots, dashes and underscores.".into()),
43
        })
44
        .into_response());
45
    }
46
    let taken = accounts::account_by_name(&app.db, &name).await.map_err(|e| Error::from_db(shell.clone(), e))?.is_some()
6a178055 Andy McCall ↶ 47
        || accounts::org_by_name(&app.db, &name).await.map_err(|e| Error::from_db(shell.clone(), e))?.is_some()
48
        || accounts::username_retired(&app.db, &name).await.map_err(|e| Error::from_db(shell.clone(), e))?;
19bb31ff Andy McCall ↶ 49
    if taken {
50
        return Ok(Page(OrgNewPage { shell, error: Some("That name is taken.".into()) }).into_response());
51
    }
52
    let org =
53
        accounts::create_org(&app.db, &name, f.display_name.trim(), me.account.id).await.map_err(|e| Error::from_db(shell.clone(), e))?;
54
    accounts::audit(&app.db, Some(&me.account), "org.created", &org.name, "").await.ok();
55
    Ok(Redirect::to(&format!("/orgs/{}/settings", org.name)).into_response())
56
}
57
58
#[derive(Template)]
59
#[template(path = "org_settings.html")]
60
pub struct OrgSettingsPage {
61
    shell: Shell,
62
    org: accounts::Organisation,
63
    members: Vec<(accounts::Account, String)>,
64
    teams: Vec<(accounts::Team, Vec<accounts::Account>)>,
9756c67d Andy McCall ↶ 65
    hooks: Vec<super::webhooks::HookRow>,
19bb31ff Andy McCall ↶ 66
    notice: Option<String>,
67
    error: Option<String>,
7974adb0 Andy McCall ↶ 68
    /// Runners serving the organisation: (runner, what it serves, whether
69
    /// it is the organisation's own).
70
    runners: Vec<(crate::db::runners::Runner, String, bool)>,
71
    /// A registration token just made, shown once.
72
    runner_token: Option<String>,
19bb31ff Andy McCall ↶ 73
}
74
75
async fn org_page(
76
    app: &Shared,
77
    shell: Shell,
78
    org: accounts::Organisation,
79
    notice: Option<String>,
80
    error: Option<String>,
81
) -> Result<Page<OrgSettingsPage>, Error> {
82
    let members = accounts::org_members(&app.db, org.id).await.map_err(|e| Error::from_db(shell.clone(), e))?;
83
    let mut teams = Vec::new();
84
    for t in accounts::teams(&app.db, org.id).await.map_err(|e| Error::from_db(shell.clone(), e))? {
85
        let members = accounts::team_members(&app.db, t.id).await.map_err(|e| Error::from_db(shell.clone(), e))?;
86
        teams.push((t, members));
87
    }
8fb35df7 Andy McCall ↶ 88
    let hooks = crate::db::hooks::hooks_for_org(&app.db, org.id).await.map_err(|e| Error::from_db(shell.clone(), e))?;
9756c67d Andy McCall ↶ 89
    let hooks = super::webhooks::rows(app, hooks).await.map_err(|e| Error::from_db(shell.clone(), e))?;
7974adb0 Andy McCall ↶ 90
    let mut runners = Vec::new();
91
    for r in crate::db::runners::serving_owner(&app.db, &org.name).await.map_err(|e| Error::from_db(shell.clone(), e))? {
92
        let own = r.scope_owner == org.name;
93
        let serves = match r.scope_repo_id {
94
            Some(id) => crate::db::repos::get_by_id(&app.db, id).await.ok().flatten().map(|p| p.slug()).unwrap_or_default(),
95
            None if own => "the organisation's repositories".into(),
96
            None => "the whole site".into(),
97
        };
98
        runners.push((r, serves, own));
99
    }
100
    Ok(Page(OrgSettingsPage { shell, org, members, teams, hooks, notice, error, runners, runner_token: None }))
19bb31ff Andy McCall ↶ 101
}
102
103
async fn owned_org(app: &Shared, shell: &Shell, viewer: &Viewer, name: &str) -> Result<(accounts::Account, accounts::Organisation), Error> {
104
    let me = require(viewer, shell)?;
105
    let org = accounts::org_by_name(&app.db, name)
106
        .await
107
        .map_err(|e| Error::from_db(shell.clone(), e))?
108
        .ok_or_else(|| Error::not_found(shell.clone()))?;
109
    if !roles::is_org_owner(&app.db, &me.account, org.id).await.map_err(|e| Error::from_db(shell.clone(), e))? {
110
        return Err(Error::not_found(shell.clone()));
111
    }
112
    Ok((me.account, org))
113
}
114
115
pub async fn settings(State(app): State<Shared>, viewer: Viewer, Path(name): Path<String>) -> Result<Page<OrgSettingsPage>, Error> {
116
    let shell = Shell::new(&app, &format!("/orgs/{name}/settings"), &viewer);
117
    let (_, org) = owned_org(&app, &shell, &viewer, &name).await?;
118
    org_page(&app, shell, org, None, None).await
119
}
120
121
#[derive(Deserialize)]
122
pub struct OrgForm {
123
    #[serde(rename = "_csrf")]
124
    csrf_token: String,
125
    display_name: String,
126
    description: String,
127
    default_role: String,
128
}
129
130
pub async fn update(
131
    State(app): State<Shared>,
132
    viewer: Viewer,
133
    Path(name): Path<String>,
134
    Form(f): Form<OrgForm>,
135
) -> Result<Page<OrgSettingsPage>, Error> {
136
    let shell = Shell::new(&app, &format!("/orgs/{name}/settings"), &viewer);
137
    let (me, org) = owned_org(&app, &shell, &viewer, &name).await?;
138
    csrf(&viewer, &f.csrf_token, &shell)?;
139
    let role = if f.default_role == "none" || roles::Role::parse(&f.default_role).is_some() { f.default_role.as_str() } else { "read" };
140
    accounts::set_org(&app.db, org.id, f.display_name.trim(), f.description.trim(), role)
141
        .await
142
        .map_err(|e| Error::from_db(shell.clone(), e))?;
143
    accounts::audit(&app.db, Some(&me), "org.updated", &org.name, "").await.ok();
144
    let org = accounts::org_by_name(&app.db, &name).await.map_err(|e| Error::from_db(shell.clone(), e))?.unwrap_or(org);
145
    org_page(&app, shell, org, Some("Saved.".into()), None).await
146
}
147
148
#[derive(Deserialize)]
149
pub struct MemberForm {
150
    #[serde(rename = "_csrf")]
151
    csrf_token: String,
152
    username: String,
153
    #[serde(default)]
154
    role: String,
155
    #[serde(default)]
156
    remove: Option<String>,
157
}
158
159
pub async fn member(
160
    State(app): State<Shared>,
161
    viewer: Viewer,
162
    Path(name): Path<String>,
163
    Form(f): Form<MemberForm>,
164
) -> Result<Page<OrgSettingsPage>, Error> {
165
    let shell = Shell::new(&app, &format!("/orgs/{name}/settings"), &viewer);
166
    let (me, org) = owned_org(&app, &shell, &viewer, &name).await?;
167
    csrf(&viewer, &f.csrf_token, &shell)?;
168
    let Some(target) = accounts::account_by_name(&app.db, f.username.trim()).await.map_err(|e| Error::from_db(shell.clone(), e))? else {
169
        return org_page(&app, shell, org, None, Some("No such account.".into())).await;
170
    };
171
    if f.remove.is_some() {
172
        let owners = accounts::org_members(&app.db, org.id)
173
            .await
174
            .map_err(|e| Error::from_db(shell.clone(), e))?
175
            .iter()
176
            .filter(|(_, r)| r == "owner")
177
            .count();
178
        let is_owner =
179
            accounts::org_role(&app.db, org.id, target.id).await.map_err(|e| Error::from_db(shell.clone(), e))?.as_deref() == Some("owner");
180
        if is_owner && owners <= 1 {
181
            return org_page(&app, shell, org, None, Some("An organisation keeps at least one owner.".into())).await;
182
        }
183
        accounts::remove_org_member(&app.db, org.id, target.id).await.map_err(|e| Error::from_db(shell.clone(), e))?;
184
        accounts::audit(&app.db, Some(&me), "org.member.removed", &org.name, &target.username).await.ok();
185
        return org_page(&app, shell, org, Some(format!("Removed {}.", target.username)), None).await;
186
    }
187
    let role = if f.role == "owner" { "owner" } else { "member" };
188
    accounts::set_org_member(&app.db, org.id, target.id, role).await.map_err(|e| Error::from_db(shell.clone(), e))?;
189
    accounts::audit(&app.db, Some(&me), "org.member.set", &org.name, &format!("{} {role}", target.username)).await.ok();
190
    org_page(&app, shell, org, Some(format!("{} is now {role}.", target.username)), None).await
191
}
192
193
#[derive(Deserialize)]
194
pub struct TeamForm {
195
    #[serde(rename = "_csrf")]
196
    csrf_token: String,
197
    team: String,
198
    #[serde(default)]
199
    username: String,
200
    #[serde(default)]
201
    action: String,
202
}
203
204
pub async fn team(
205
    State(app): State<Shared>,
206
    viewer: Viewer,
207
    Path(name): Path<String>,
208
    Form(f): Form<TeamForm>,
209
) -> Result<Page<OrgSettingsPage>, Error> {
210
    let shell = Shell::new(&app, &format!("/orgs/{name}/settings"), &viewer);
211
    let (me, org) = owned_org(&app, &shell, &viewer, &name).await?;
212
    csrf(&viewer, &f.csrf_token, &shell)?;
213
    let team_name = f.team.trim().to_string();
214
    if !crate::repos::names::valid_segment(&team_name) {
215
        return org_page(&app, shell, org, None, Some("A team name is letters, digits, dots, dashes and underscores.".into())).await;
216
    }
217
    let existing = accounts::team_by_name(&app.db, org.id, &team_name).await.map_err(|e| Error::from_db(shell.clone(), e))?;
218
    let notice = match f.action.as_str() {
219
        "create" => {
220
            if existing.is_some() {
221
                return org_page(&app, shell, org, None, Some("That team exists.".into())).await;
222
            }
223
            accounts::create_team(&app.db, org.id, &team_name).await.map_err(|e| Error::from_db(shell.clone(), e))?;
224
            format!("Team {team_name} created.")
225
        }
226
        "delete" => {
227
            if let Some(t) = existing {
228
                accounts::delete_team(&app.db, t.id).await.map_err(|e| Error::from_db(shell.clone(), e))?;
229
            }
230
            format!("Team {team_name} deleted.")
231
        }
232
        "add" | "remove" => {
233
            let Some(t) = existing else { return org_page(&app, shell, org, None, Some("No such team.".into())).await };
234
            let Some(target) = accounts::account_by_name(&app.db, f.username.trim()).await.map_err(|e| Error::from_db(shell.clone(), e))?
235
            else {
236
                return org_page(&app, shell, org, None, Some("No such account.".into())).await;
237
            };
238
            if f.action == "add" {
239
                accounts::set_org_member(&app.db, org.id, target.id, "member").await.ok();
240
                accounts::add_team_member(&app.db, t.id, target.id).await.map_err(|e| Error::from_db(shell.clone(), e))?;
241
                format!("{} added to {team_name}.", target.username)
242
            } else {
243
                accounts::remove_team_member(&app.db, t.id, target.id).await.map_err(|e| Error::from_db(shell.clone(), e))?;
244
                format!("{} removed from {team_name}.", target.username)
245
            }
246
        }
247
        _ => return Err(Error::bad(shell, "unknown team action")),
248
    };
249
    accounts::audit(&app.db, Some(&me), "org.team", &org.name, &format!("{} {team_name} {}", f.action, f.username.trim())).await.ok();
250
    org_page(&app, shell, org, Some(notice), None).await
251
}
a160b98f Andy McCall ↶ 252
253
/// `POST /orgs/{name}/settings/avatar`: upload or remove the organisation's logo.
254
pub async fn avatar(
255
    State(app): State<Shared>,
256
    viewer: Viewer,
257
    Path(name): Path<String>,
258
    multipart: axum::extract::Multipart,
259
) -> Result<Page<OrgSettingsPage>, Error> {
260
    let shell = Shell::new(&app, &format!("/orgs/{name}/settings"), &viewer);
261
    let (me, org) = owned_org(&app, &shell, &viewer, &name).await?;
262
    let upload = super::avatar::read_upload(multipart).await;
263
    csrf(&viewer, &upload.csrf, &shell)?;
264
    let result = super::avatar::apply(&app, "org", org.id, upload).await;
265
    if result.is_ok() {
266
        accounts::audit(&app.db, Some(&me), "org.picture", &org.name, "").await.ok();
267
    }
268
    let org = accounts::org_by_name(&app.db, &name).await.map_err(|e| Error::from_db(shell.clone(), e))?.unwrap_or(org);
269
    match result {
270
        Ok(m) => org_page(&app, shell, org, Some(m), None).await,
271
        Err(e) => org_page(&app, shell, org, None, Some(e)).await,
272
    }
8fb35df7 Andy McCall ↶ 273
}
274
275
/// `POST /orgs/{name}/settings/hooks`: webhooks that hear every repository of the organisation.
276
pub async fn hooks(
277
    State(app): State<Shared>,
278
    viewer: Viewer,
279
    Path(name): Path<String>,
280
    Form(f): Form<super::webhooks::HookForm>,
281
) -> Result<Page<OrgSettingsPage>, Error> {
282
    let shell = Shell::new(&app, &format!("/orgs/{name}/settings"), &viewer);
283
    let (_, org) = owned_org(&app, &shell, &viewer, &name).await?;
284
    csrf(&viewer, &f.csrf_token, &shell)?;
285
    let scope = super::webhooks::Scope::Org { id: org.id, name: org.name.clone() };
286
    match super::webhooks::apply(&app, &viewer, &scope, f).await.map_err(|e| Error::from_db(shell.clone(), e))? {
287
        Ok(notice) => org_page(&app, shell, org, Some(notice), None).await,
288
        Err(error) => org_page(&app, shell, org, None, Some(error)).await,
289
    }
290
}
291
292
pub async fn deliveries(
293
    State(app): State<Shared>,
294
    viewer: Viewer,
295
    Path((name, id)): Path<(String, i64)>,
296
) -> Result<Page<super::webhooks::DeliveriesPage>, Error> {
297
    let shell = Shell::new(&app, &format!("/orgs/{name}/settings/hooks/{id}/deliveries"), &viewer);
298
    let (_, org) = owned_org(&app, &shell, &viewer, &name).await?;
299
    let scope = super::webhooks::Scope::Org { id: org.id, name: org.name };
300
    super::webhooks::deliveries_page(&app, shell, &scope, None, id).await
301
}
302
303
pub async fn redeliver(
304
    State(app): State<Shared>,
305
    viewer: Viewer,
306
    Path((name, id, delivery)): Path<(String, i64, i64)>,
307
    Form(f): Form<super::session::CsrfForm>,
308
) -> Result<Page<super::webhooks::DeliveriesPage>, Error> {
309
    let shell = Shell::new(&app, &format!("/orgs/{name}/settings/hooks/{id}/deliveries"), &viewer);
310
    let (_, org) = owned_org(&app, &shell, &viewer, &name).await?;
311
    csrf(&viewer, &f.csrf, &shell)?;
312
    let scope = super::webhooks::Scope::Org { id: org.id, name: org.name };
313
    super::webhooks::redeliver(&app, &scope, id, delivery).await.map_err(|e| Error::from_db(shell.clone(), e))?;
314
    super::webhooks::deliveries_page(&app, shell, &scope, None, id).await
7974adb0 Andy McCall ↶ 315
}
316
317
/// `POST /orgs/{name}/settings/runners/token`: a one-time registration
318
/// token for a runner that serves the organisation's repositories
319
/// (oxygenhub#41).
320
pub async fn runner_token(
321
    State(app): State<Shared>,
322
    viewer: Viewer,
323
    Path(name): Path<String>,
324
    Form(f): Form<super::session::CsrfForm>,
325
) -> Result<Page<OrgSettingsPage>, Error> {
326
    let shell = Shell::new(&app, &format!("/orgs/{name}/settings"), &viewer);
327
    let (me, org) = owned_org(&app, &shell, &viewer, &name).await?;
328
    csrf(&viewer, &f.csrf, &shell)?;
329
    let token = format!("flowreg_{}", crate::auth::random_hex(24));
330
    let scope = crate::db::runners::Scope { owner: org.name.clone(), repo_id: None };
331
    crate::db::runners::add_registration(&app.db, &blake3::hash(token.as_bytes()).to_hex(), &me.username, &scope)
332
        .await
333
        .map_err(|e| Error::from_db(shell.clone(), e))?;
334
    accounts::audit(&app.db, Some(&me), "flow.runner.token", &org.name, "registration token for the organisation").await.ok();
335
    let mut page = org_page(&app, shell, org, Some("Copy the token now; it is not shown again.".into()), None).await?;
336
    page.0.runner_token = Some(token);
337
    Ok(page)
338
}
339
340
/// `POST /orgs/{name}/settings/runners/{id}/remove`: remove a runner scoped
341
/// to the organisation or one of its repositories, when it runs nothing.
342
pub async fn runner_remove(
343
    State(app): State<Shared>,
344
    viewer: Viewer,
345
    Path((name, id)): Path<(String, i64)>,
346
    Form(f): Form<super::session::CsrfForm>,
347
) -> Result<Page<OrgSettingsPage>, Error> {
348
    let shell = Shell::new(&app, &format!("/orgs/{name}/settings"), &viewer);
349
    let (me, org) = owned_org(&app, &shell, &viewer, &name).await?;
350
    csrf(&viewer, &f.csrf, &shell)?;
351
    let e = |e| Error::from_db(shell.clone(), e);
352
    let Some(r) = crate::db::runners::get(&app.db, id).await.map_err(e)?.filter(|r| r.scope_owner == org.name) else {
353
        return Err(Error::not_found(shell));
354
    };
355
    if crate::db::runners::running(&app.db).await.map_err(e)?.iter().any(|(rid, n)| *rid == id && *n > 0) {
356
        return org_page(&app, shell, org, None, Some(format!("{} is running jobs: wait for them to finish.", r.name))).await;
357
    }
358
    crate::db::runners::remove(&app.db, id).await.map_err(e)?;
359
    accounts::audit(&app.db, Some(&me), "flow.runner.removed", &r.name, &org.name).await.ok();
360
    org_page(&app, shell, org, Some(format!("{} removed: its credential no longer works.", r.name)), None).await
a160b98f Andy McCall ↶ 361
}