OXYGENHUB
# 7d2eb590051f oxygenhub / crates / hub / src / web / orgs.rs
17.5 KiB · Rust · last changed AI assistants: settings per site, organisation and repository 1 month ago source blame history raw
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()
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))?;
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>)>,
65
    hooks: Vec<super::webhooks::HookRow>,
66
    notice: Option<String>,
67
    error: Option<String>,
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>,
73
    /// The organisation's AI assistants and prompt (#97).
74
    assistants: super::assistants::Panel,
75
}
76
77
async fn org_page(
78
    app: &Shared,
79
    shell: Shell,
80
    org: accounts::Organisation,
81
    notice: Option<String>,
82
    error: Option<String>,
83
) -> Result<Page<OrgSettingsPage>, Error> {
84
    let members = accounts::org_members(&app.db, org.id).await.map_err(|e| Error::from_db(shell.clone(), e))?;
85
    let mut teams = Vec::new();
86
    for t in accounts::teams(&app.db, org.id).await.map_err(|e| Error::from_db(shell.clone(), e))? {
87
        let members = accounts::team_members(&app.db, t.id).await.map_err(|e| Error::from_db(shell.clone(), e))?;
88
        teams.push((t, members));
89
    }
90
    let hooks = crate::db::hooks::hooks_for_org(&app.db, org.id).await.map_err(|e| Error::from_db(shell.clone(), e))?;
91
    let hooks = super::webhooks::rows(app, hooks).await.map_err(|e| Error::from_db(shell.clone(), e))?;
92
    let mut runners = Vec::new();
93
    for r in crate::db::runners::serving_owner(&app.db, &org.name).await.map_err(|e| Error::from_db(shell.clone(), e))? {
94
        let own = r.scope_owner == org.name;
95
        let serves = match r.scope_repo_id {
96
            Some(id) => crate::db::repos::get_by_id(&app.db, id).await.ok().flatten().map(|p| p.slug()).unwrap_or_default(),
97
            None if own => "the organisation's repositories".into(),
98
            None => "the whole site".into(),
99
        };
100
        runners.push((r, serves, own));
101
    }
102
    let assistants = super::assistants::panel(app, &org_assistants(&org)).await.map_err(|e| Error::from_db(shell.clone(), e))?;
103
    Ok(Page(OrgSettingsPage { shell, org, members, teams, hooks, notice, error, runners, runner_token: None, assistants }))
104
}
105
106
async fn owned_org(app: &Shared, shell: &Shell, viewer: &Viewer, name: &str) -> Result<(accounts::Account, accounts::Organisation), Error> {
107
    let me = require(viewer, shell)?;
108
    let org = accounts::org_by_name(&app.db, name)
109
        .await
110
        .map_err(|e| Error::from_db(shell.clone(), e))?
111
        .ok_or_else(|| Error::not_found(shell.clone()))?;
112
    if !roles::is_org_owner(&app.db, &me.account, org.id).await.map_err(|e| Error::from_db(shell.clone(), e))? {
113
        return Err(Error::not_found(shell.clone()));
114
    }
115
    Ok((me.account, org))
116
}
117
118
pub async fn settings(State(app): State<Shared>, viewer: Viewer, Path(name): Path<String>) -> Result<Page<OrgSettingsPage>, Error> {
119
    let shell = Shell::new(&app, &format!("/orgs/{name}/settings"), &viewer);
120
    let (_, org) = owned_org(&app, &shell, &viewer, &name).await?;
121
    org_page(&app, shell, org, None, None).await
122
}
123
124
#[derive(Deserialize)]
125
pub struct OrgForm {
126
    #[serde(rename = "_csrf")]
127
    csrf_token: String,
128
    display_name: String,
129
    description: String,
130
    default_role: String,
131
}
132
133
pub async fn update(
134
    State(app): State<Shared>,
135
    viewer: Viewer,
136
    Path(name): Path<String>,
137
    Form(f): Form<OrgForm>,
138
) -> Result<Page<OrgSettingsPage>, Error> {
139
    let shell = Shell::new(&app, &format!("/orgs/{name}/settings"), &viewer);
140
    let (me, org) = owned_org(&app, &shell, &viewer, &name).await?;
141
    csrf(&viewer, &f.csrf_token, &shell)?;
142
    let role = if f.default_role == "none" || roles::Role::parse(&f.default_role).is_some() { f.default_role.as_str() } else { "read" };
143
    accounts::set_org(&app.db, org.id, f.display_name.trim(), f.description.trim(), role)
144
        .await
145
        .map_err(|e| Error::from_db(shell.clone(), e))?;
146
    accounts::audit(&app.db, Some(&me), "org.updated", &org.name, "").await.ok();
147
    let org = accounts::org_by_name(&app.db, &name).await.map_err(|e| Error::from_db(shell.clone(), e))?.unwrap_or(org);
148
    org_page(&app, shell, org, Some("Saved.".into()), None).await
149
}
150
151
#[derive(Deserialize)]
152
pub struct MemberForm {
153
    #[serde(rename = "_csrf")]
154
    csrf_token: String,
155
    username: String,
156
    #[serde(default)]
157
    role: String,
158
    #[serde(default)]
159
    remove: Option<String>,
160
}
161
162
pub async fn member(
163
    State(app): State<Shared>,
164
    viewer: Viewer,
165
    Path(name): Path<String>,
166
    Form(f): Form<MemberForm>,
167
) -> Result<Page<OrgSettingsPage>, Error> {
168
    let shell = Shell::new(&app, &format!("/orgs/{name}/settings"), &viewer);
169
    let (me, org) = owned_org(&app, &shell, &viewer, &name).await?;
170
    csrf(&viewer, &f.csrf_token, &shell)?;
171
    let Some(target) = accounts::account_by_name(&app.db, f.username.trim()).await.map_err(|e| Error::from_db(shell.clone(), e))? else {
172
        return org_page(&app, shell, org, None, Some("No such account.".into())).await;
173
    };
174
    if f.remove.is_some() {
175
        let owners = accounts::org_members(&app.db, org.id)
176
            .await
177
            .map_err(|e| Error::from_db(shell.clone(), e))?
178
            .iter()
179
            .filter(|(_, r)| r == "owner")
180
            .count();
181
        let is_owner =
182
            accounts::org_role(&app.db, org.id, target.id).await.map_err(|e| Error::from_db(shell.clone(), e))?.as_deref() == Some("owner");
183
        if is_owner && owners <= 1 {
184
            return org_page(&app, shell, org, None, Some("An organisation keeps at least one owner.".into())).await;
185
        }
186
        accounts::remove_org_member(&app.db, org.id, target.id).await.map_err(|e| Error::from_db(shell.clone(), e))?;
187
        accounts::audit(&app.db, Some(&me), "org.member.removed", &org.name, &target.username).await.ok();
188
        return org_page(&app, shell, org, Some(format!("Removed {}.", target.username)), None).await;
189
    }
190
    let role = if f.role == "owner" { "owner" } else { "member" };
191
    accounts::set_org_member(&app.db, org.id, target.id, role).await.map_err(|e| Error::from_db(shell.clone(), e))?;
192
    accounts::audit(&app.db, Some(&me), "org.member.set", &org.name, &format!("{} {role}", target.username)).await.ok();
193
    org_page(&app, shell, org, Some(format!("{} is now {role}.", target.username)), None).await
194
}
195
196
#[derive(Deserialize)]
197
pub struct TeamForm {
198
    #[serde(rename = "_csrf")]
199
    csrf_token: String,
200
    team: String,
201
    #[serde(default)]
202
    username: String,
203
    #[serde(default)]
204
    action: String,
205
}
206
207
pub async fn team(
208
    State(app): State<Shared>,
209
    viewer: Viewer,
210
    Path(name): Path<String>,
211
    Form(f): Form<TeamForm>,
212
) -> Result<Page<OrgSettingsPage>, Error> {
213
    let shell = Shell::new(&app, &format!("/orgs/{name}/settings"), &viewer);
214
    let (me, org) = owned_org(&app, &shell, &viewer, &name).await?;
215
    csrf(&viewer, &f.csrf_token, &shell)?;
216
    let team_name = f.team.trim().to_string();
217
    if !crate::repos::names::valid_segment(&team_name) {
218
        return org_page(&app, shell, org, None, Some("A team name is letters, digits, dots, dashes and underscores.".into())).await;
219
    }
220
    let existing = accounts::team_by_name(&app.db, org.id, &team_name).await.map_err(|e| Error::from_db(shell.clone(), e))?;
221
    let notice = match f.action.as_str() {
222
        "create" => {
223
            if existing.is_some() {
224
                return org_page(&app, shell, org, None, Some("That team exists.".into())).await;
225
            }
226
            accounts::create_team(&app.db, org.id, &team_name).await.map_err(|e| Error::from_db(shell.clone(), e))?;
227
            format!("Team {team_name} created.")
228
        }
229
        "delete" => {
230
            if let Some(t) = existing {
231
                accounts::delete_team(&app.db, t.id).await.map_err(|e| Error::from_db(shell.clone(), e))?;
232
            }
233
            format!("Team {team_name} deleted.")
234
        }
235
        "add" | "remove" => {
236
            let Some(t) = existing else { return org_page(&app, shell, org, None, Some("No such team.".into())).await };
237
            let Some(target) = accounts::account_by_name(&app.db, f.username.trim()).await.map_err(|e| Error::from_db(shell.clone(), e))?
238
            else {
239
                return org_page(&app, shell, org, None, Some("No such account.".into())).await;
240
            };
241
            if f.action == "add" {
242
                accounts::set_org_member(&app.db, org.id, target.id, "member").await.ok();
243
                accounts::add_team_member(&app.db, t.id, target.id).await.map_err(|e| Error::from_db(shell.clone(), e))?;
244
                format!("{} added to {team_name}.", target.username)
245
            } else {
246
                accounts::remove_team_member(&app.db, t.id, target.id).await.map_err(|e| Error::from_db(shell.clone(), e))?;
247
                format!("{} removed from {team_name}.", target.username)
248
            }
249
        }
250
        _ => return Err(Error::bad(shell, "unknown team action")),
251
    };
252
    accounts::audit(&app.db, Some(&me), "org.team", &org.name, &format!("{} {team_name} {}", f.action, f.username.trim())).await.ok();
253
    org_page(&app, shell, org, Some(notice), None).await
254
}
255
256
/// `POST /orgs/{name}/settings/avatar`: upload or remove the organisation's logo.
257
pub async fn avatar(
258
    State(app): State<Shared>,
259
    viewer: Viewer,
260
    Path(name): Path<String>,
261
    multipart: axum::extract::Multipart,
262
) -> Result<Page<OrgSettingsPage>, Error> {
263
    let shell = Shell::new(&app, &format!("/orgs/{name}/settings"), &viewer);
264
    let (me, org) = owned_org(&app, &shell, &viewer, &name).await?;
265
    let upload = super::avatar::read_upload(multipart).await;
266
    csrf(&viewer, &upload.csrf, &shell)?;
267
    let result = super::avatar::apply(&app, "org", org.id, upload).await;
268
    if result.is_ok() {
269
        accounts::audit(&app.db, Some(&me), "org.picture", &org.name, "").await.ok();
270
    }
271
    let org = accounts::org_by_name(&app.db, &name).await.map_err(|e| Error::from_db(shell.clone(), e))?.unwrap_or(org);
272
    match result {
273
        Ok(m) => org_page(&app, shell, org, Some(m), None).await,
274
        Err(e) => org_page(&app, shell, org, None, Some(e)).await,
275
    }
276
}
277
278
/// `POST /orgs/{name}/settings/hooks`: webhooks that hear every repository of the organisation.
279
pub async fn hooks(
280
    State(app): State<Shared>,
281
    viewer: Viewer,
282
    Path(name): Path<String>,
283
    Form(f): Form<super::webhooks::HookForm>,
284
) -> Result<Page<OrgSettingsPage>, Error> {
285
    let shell = Shell::new(&app, &format!("/orgs/{name}/settings"), &viewer);
286
    let (_, org) = owned_org(&app, &shell, &viewer, &name).await?;
287
    csrf(&viewer, &f.csrf_token, &shell)?;
288
    let scope = super::webhooks::Scope::Org { id: org.id, name: org.name.clone() };
289
    match super::webhooks::apply(&app, &viewer, &scope, f).await.map_err(|e| Error::from_db(shell.clone(), e))? {
290
        Ok(notice) => org_page(&app, shell, org, Some(notice), None).await,
291
        Err(error) => org_page(&app, shell, org, None, Some(error)).await,
292
    }
293
}
294
295
pub async fn deliveries(
296
    State(app): State<Shared>,
297
    viewer: Viewer,
298
    Path((name, id)): Path<(String, i64)>,
299
) -> Result<Page<super::webhooks::DeliveriesPage>, Error> {
300
    let shell = Shell::new(&app, &format!("/orgs/{name}/settings/hooks/{id}/deliveries"), &viewer);
301
    let (_, org) = owned_org(&app, &shell, &viewer, &name).await?;
302
    let scope = super::webhooks::Scope::Org { id: org.id, name: org.name };
303
    super::webhooks::deliveries_page(&app, shell, &scope, None, id).await
304
}
305
306
pub async fn redeliver(
307
    State(app): State<Shared>,
308
    viewer: Viewer,
309
    Path((name, id, delivery)): Path<(String, i64, i64)>,
310
    Form(f): Form<super::session::CsrfForm>,
311
) -> Result<Page<super::webhooks::DeliveriesPage>, Error> {
312
    let shell = Shell::new(&app, &format!("/orgs/{name}/settings/hooks/{id}/deliveries"), &viewer);
313
    let (_, org) = owned_org(&app, &shell, &viewer, &name).await?;
314
    csrf(&viewer, &f.csrf, &shell)?;
315
    let scope = super::webhooks::Scope::Org { id: org.id, name: org.name };
316
    super::webhooks::redeliver(&app, &scope, id, delivery).await.map_err(|e| Error::from_db(shell.clone(), e))?;
317
    super::webhooks::deliveries_page(&app, shell, &scope, None, id).await
318
}
319
320
/// `POST /orgs/{name}/settings/runners/token`: a one-time registration
321
/// token for a runner that serves the organisation's repositories
322
/// (oxygenhub#41).
323
pub async fn runner_token(
324
    State(app): State<Shared>,
325
    viewer: Viewer,
326
    Path(name): Path<String>,
327
    Form(f): Form<super::session::CsrfForm>,
328
) -> Result<Page<OrgSettingsPage>, Error> {
329
    let shell = Shell::new(&app, &format!("/orgs/{name}/settings"), &viewer);
330
    let (me, org) = owned_org(&app, &shell, &viewer, &name).await?;
331
    csrf(&viewer, &f.csrf, &shell)?;
332
    let token = format!("flowreg_{}", crate::auth::random_hex(24));
333
    let scope = crate::db::runners::Scope { owner: org.name.clone(), repo_id: None };
334
    crate::db::runners::add_registration(&app.db, &blake3::hash(token.as_bytes()).to_hex(), &me.username, &scope)
335
        .await
336
        .map_err(|e| Error::from_db(shell.clone(), e))?;
337
    accounts::audit(&app.db, Some(&me), "flow.runner.token", &org.name, "registration token for the organisation").await.ok();
338
    let mut page = org_page(&app, shell, org, Some("Copy the token now; it is not shown again.".into()), None).await?;
339
    page.0.runner_token = Some(token);
340
    Ok(page)
341
}
342
343
/// `POST /orgs/{name}/settings/runners/{id}/remove`: remove a runner scoped
344
/// to the organisation or one of its repositories, when it runs nothing.
345
pub async fn runner_remove(
346
    State(app): State<Shared>,
347
    viewer: Viewer,
348
    Path((name, id)): Path<(String, i64)>,
349
    Form(f): Form<super::session::CsrfForm>,
350
) -> Result<Page<OrgSettingsPage>, Error> {
351
    let shell = Shell::new(&app, &format!("/orgs/{name}/settings"), &viewer);
352
    let (me, org) = owned_org(&app, &shell, &viewer, &name).await?;
353
    csrf(&viewer, &f.csrf, &shell)?;
354
    let e = |e| Error::from_db(shell.clone(), e);
355
    let Some(r) = crate::db::runners::get(&app.db, id).await.map_err(e)?.filter(|r| r.scope_owner == org.name) else {
356
        return Err(Error::not_found(shell));
357
    };
358
    if crate::db::runners::running(&app.db).await.map_err(e)?.iter().any(|(rid, n)| *rid == id && *n > 0) {
359
        return org_page(&app, shell, org, None, Some(format!("{} is running jobs: wait for them to finish.", r.name))).await;
360
    }
361
    crate::db::runners::remove(&app.db, id).await.map_err(e)?;
362
    accounts::audit(&app.db, Some(&me), "flow.runner.removed", &r.name, &org.name).await.ok();
363
    org_page(&app, shell, org, Some(format!("{} removed: its credential no longer works.", r.name)), None).await
364
}
365
366
fn org_assistants(org: &accounts::Organisation) -> super::assistants::Where {
367
    super::assistants::Where { scope: crate::assistants::Scope::Org(org.id), owner: org.name.clone(), label: org.name.clone() }
368
}
369
370
/// `POST /orgs/{name}/settings/assistants`: the organisation's assistants
371
/// and prompt (#97).
372
pub async fn assistants(
373
    State(app): State<Shared>,
374
    viewer: Viewer,
375
    Path(name): Path<String>,
376
    Form(f): Form<super::assistants::AssistantForm>,
377
) -> Result<Page<OrgSettingsPage>, Error> {
378
    let shell = Shell::new(&app, &format!("/orgs/{name}/settings"), &viewer);
379
    let (_, org) = owned_org(&app, &shell, &viewer, &name).await?;
380
    csrf(&viewer, &f.csrf_token, &shell)?;
381
    match super::assistants::apply(&app, &viewer, &org_assistants(&org), f).await.map_err(|e| Error::from_db(shell.clone(), e))? {
382
        Ok(notice) => org_page(&app, shell, org, Some(notice), None).await,
383
        Err(error) => org_page(&app, shell, org, None, Some(error)).await,
384
    }
385
}