OXYGENHUB
# 67b24adbf35a oxygenhub / crates / hub / src / web / repo_settings.rs
16.4 KiB · Rust · last changed Webhooks: Discord and Slack formats (Discord hooks switched over), a masked URL that wraps, the last delivery in the table, an edit form, and web issue events delivered 1 month ago source blame history raw
1
//! Creating repositories and their settings pages (hub spec §6.3).
2
3
use super::settings::{csrf, require};
4
use super::{filters, lookup_role, Error, Page, RepoShell, Shell};
5
use crate::auth::{roles, Access, Role, Viewer};
6
use crate::db::{self, accounts};
7
use crate::repos::RepoName;
8
use crate::Shared;
9
use askama::Template;
10
use axum::extract::{Form, Path, State};
11
use axum::response::{IntoResponse, Redirect, Response};
12
use hub_api::Visibility;
13
use serde::Deserialize;
14
15
#[derive(Template)]
16
#[template(path = "repo_new.html")]
17
pub struct NewRepoPage {
18
    shell: Shell,
19
    owners: Vec<String>,
20
    error: Option<String>,
21
}
22
23
pub(crate) async fn owners_for(app: &Shared, me: &accounts::Account) -> Vec<String> {
24
    let mut owners = vec![me.username.clone()];
25
    if let Ok(orgs) = accounts::orgs_of(&app.db, me.id).await {
26
        owners.extend(orgs.into_iter().map(|(o, _)| o.name));
27
    }
28
    owners
29
}
30
31
pub async fn new_form(State(app): State<Shared>, viewer: Viewer) -> Result<Page<NewRepoPage>, Error> {
32
    let shell = Shell::new(&app, "/new", &viewer);
33
    let me = require(&viewer, &shell)?;
34
    let owners = owners_for(&app, &me.account).await;
35
    Ok(Page(NewRepoPage { shell, owners, error: None }))
36
}
37
38
#[derive(Deserialize)]
39
pub struct NewRepoForm {
40
    #[serde(rename = "_csrf")]
41
    csrf_token: String,
42
    owner: String,
43
    name: String,
44
    #[serde(default)]
45
    description: String,
46
    #[serde(default = "default_visibility")]
47
    visibility: String,
48
}
49
50
fn default_visibility() -> String {
51
    "public".into()
52
}
53
54
pub async fn create(State(app): State<Shared>, viewer: Viewer, Form(f): Form<NewRepoForm>) -> Result<Response, Error> {
55
    let shell = Shell::new(&app, "/new", &viewer);
56
    let me = require(&viewer, &shell)?;
57
    csrf(&viewer, &f.csrf_token, &shell)?;
58
    let owners = owners_for(&app, &me.account).await;
59
    let fail = |msg: &str| Page(NewRepoPage { shell: shell.clone(), owners: owners.clone(), error: Some(msg.into()) }).into_response();
60
    let Some(name) = RepoName::new(f.owner.trim(), f.name.trim()) else {
61
        return Ok(fail("A repository name is letters, digits, dots, dashes and underscores."));
62
    };
63
    if !roles::may_create_under(&app.db, &me.account, &name.owner).await.map_err(|e| Error::from_db(shell.clone(), e))? {
64
        return Ok(fail("You cannot create repositories under that owner."));
65
    }
66
    let Some(visibility) = Visibility::parse(&f.visibility) else { return Ok(fail("Visibility is public, internal or private.")) };
67
    if db::repos::get(&app.db, &name.owner, &name.name).await.map_err(|e| Error::from_db(shell.clone(), e))?.is_some()
68
        || app.repos.exists(&name)
69
    {
70
        return Ok(fail("That repository exists."));
71
    }
72
    app.repos.create(&name, None).map_err(|e| Error::from_repo(shell.clone(), e))?;
73
    db::repos::create(&app.db, &name.owner, &name.name, f.description.trim(), visibility)
74
        .await
75
        .map_err(|e| Error::from_db(shell.clone(), e))?;
76
    accounts::audit(&app.db, Some(&me.account), "repo.created", &name.to_string(), visibility.as_str()).await.ok();
77
    Ok(Redirect::to(&name.url()).into_response())
78
}
79
80
#[derive(Template)]
81
#[template(path = "repo_settings.html")]
82
pub struct RepoSettingsPage {
83
    shell: Shell,
84
    repo: RepoShell,
85
    row: db::repos::RepoRow,
86
    collaborators: Vec<accounts::Collaborator>,
87
    teams: Vec<accounts::Team>,
88
    role: Role,
89
    requirements: db::proposals::Requirements,
90
    hooks: Vec<super::webhooks::HookRow>,
91
    required_checks: String,
92
    notice: Option<String>,
93
    error: Option<String>,
94
}
95
96
async fn settings_page(
97
    app: &Shared,
98
    shell: Shell,
99
    row: db::repos::RepoRow,
100
    role: Role,
101
    notice: Option<String>,
102
    error: Option<String>,
103
) -> Result<Page<RepoSettingsPage>, Error> {
104
    let collaborators = accounts::collaborators(&app.db, row.id).await.map_err(|e| Error::from_db(shell.clone(), e))?;
105
    let teams = match accounts::org_by_name(&app.db, &row.owner).await.map_err(|e| Error::from_db(shell.clone(), e))? {
106
        Some(org) => accounts::teams(&app.db, org.id).await.map_err(|e| Error::from_db(shell.clone(), e))?,
107
        None => vec![],
108
    };
109
    let repo = RepoShell::new(app, &row, "settings").with_role(role);
110
    let requirements = db::proposals::requirements(&app.db, row.id).await.map_err(|e| Error::from_db(shell.clone(), e))?;
111
    let hooks = db::hooks::hooks_for_repo(&app.db, row.id).await.map_err(|e| Error::from_db(shell.clone(), e))?;
112
    let hooks = super::webhooks::rows(app, hooks).await.map_err(|e| Error::from_db(shell.clone(), e))?;
113
    let required_checks = db::hooks::required_checks(&app.db, row.id).await.map_err(|e| Error::from_db(shell.clone(), e))?.join(", ");
114
    Ok(Page(RepoSettingsPage { shell, repo, row, collaborators, teams, role, requirements, hooks, required_checks, notice, error }))
115
}
116
117
pub async fn settings(
118
    State(app): State<Shared>,
119
    viewer: Viewer,
120
    Path((owner, name)): Path<(String, String)>,
121
) -> Result<Page<RepoSettingsPage>, Error> {
122
    let shell = Shell::new(&app, &format!("/{owner}/{name}/settings"), &viewer);
123
    let (_, row, role) = lookup_role(&app, &shell, &viewer, &owner, &name, Access::Maintain).await?;
124
    settings_page(&app, shell, row, role, None, None).await
125
}
126
127
#[derive(Deserialize)]
128
pub struct GeneralForm {
129
    #[serde(rename = "_csrf")]
130
    csrf_token: String,
131
    description: String,
132
    default_bookmark: String,
133
    visibility: String,
134
    #[serde(default)]
135
    topics: String,
136
}
137
138
pub async fn update(
139
    State(app): State<Shared>,
140
    viewer: Viewer,
141
    Path((owner, name)): Path<(String, String)>,
142
    Form(f): Form<GeneralForm>,
143
) -> Result<Page<RepoSettingsPage>, Error> {
144
    let shell = Shell::new(&app, &format!("/{owner}/{name}/settings"), &viewer);
145
    let (_, row, role) = lookup_role(&app, &shell, &viewer, &owner, &name, Access::Maintain).await?;
146
    csrf(&viewer, &f.csrf_token, &shell)?;
147
    let e = |e| Error::from_db(shell.clone(), e);
148
    let topics = match db::repos::parse_topics(&f.topics) {
149
        Ok(t) => t,
150
        Err(msg) => return settings_page(&app, shell, row, role, None, Some(msg)).await,
151
    };
152
    db::repos::set_description(&app.db, row.id, f.description.trim()).await.map_err(e)?;
153
    db::repos::set_topics(&app.db, row.id, &topics).await.map_err(e)?;
154
    if crate::repos::names::valid_segment(f.default_bookmark.trim()) {
155
        db::repos::set_default_bookmark(&app.db, row.id, f.default_bookmark.trim()).await.map_err(e)?;
156
    }
157
    if role >= Role::Admin {
158
        if let Some(v) = Visibility::parse(&f.visibility) {
159
            db::repos::set_visibility(&app.db, row.id, v).await.map_err(e)?;
160
        }
161
    }
162
    accounts::audit(&app.db, viewer.account(), "repo.updated", &format!("{owner}/{name}"), "").await.ok();
163
    let row = db::repos::get_by_id(&app.db, row.id).await.map_err(e)?.unwrap_or(row);
164
    settings_page(&app, shell, row, role, Some("Saved.".into()), None).await
165
}
166
167
#[derive(Deserialize)]
168
pub struct CollaboratorForm {
169
    #[serde(rename = "_csrf")]
170
    csrf_token: String,
171
    #[serde(default)]
172
    username: String,
173
    #[serde(default)]
174
    team: String,
175
    #[serde(default)]
176
    role: String,
177
    #[serde(default)]
178
    remove: Option<String>,
179
}
180
181
pub async fn collaborator(
182
    State(app): State<Shared>,
183
    viewer: Viewer,
184
    Path((owner, name)): Path<(String, String)>,
185
    Form(f): Form<CollaboratorForm>,
186
) -> Result<Page<RepoSettingsPage>, Error> {
187
    let shell = Shell::new(&app, &format!("/{owner}/{name}/settings"), &viewer);
188
    let (_, row, role) = lookup_role(&app, &shell, &viewer, &owner, &name, Access::Admin).await?;
189
    csrf(&viewer, &f.csrf_token, &shell)?;
190
    let e = |e| Error::from_db(shell.clone(), e);
191
    let (account_id, team_id, label) = if !f.username.trim().is_empty() {
192
        match accounts::account_by_name(&app.db, f.username.trim()).await.map_err(e)? {
193
            Some(a) => (Some(a.id), None, a.username),
194
            None => return settings_page(&app, shell, row, role, None, Some("No such account.".into())).await,
195
        }
196
    } else if !f.team.trim().is_empty() {
197
        let org = accounts::org_by_name(&app.db, &row.owner).await.map_err(e)?;
198
        let team = match org {
199
            Some(o) => accounts::team_by_name(&app.db, o.id, f.team.trim()).await.map_err(e)?,
200
            None => None,
201
        };
202
        match team {
203
            Some(t) => (None, Some(t.id), format!("team {}", t.name)),
204
            None => return settings_page(&app, shell, row, role, None, Some("No such team in this organisation.".into())).await,
205
        }
206
    } else {
207
        return settings_page(&app, shell, row, role, None, Some("Name an account or a team.".into())).await;
208
    };
209
    if f.remove.is_some() {
210
        accounts::remove_collaborator(&app.db, row.id, account_id, team_id).await.map_err(e)?;
211
        accounts::audit(&app.db, viewer.account(), "repo.collaborator.removed", &format!("{owner}/{name}"), &label).await.ok();
212
        return settings_page(&app, shell, row, role, Some(format!("Removed {label}.")), None).await;
213
    }
214
    let Some(new_role) = Role::parse(&f.role) else {
215
        return settings_page(&app, shell, row, role, None, Some("Pick a role.".into())).await;
216
    };
217
    accounts::set_collaborator(&app.db, row.id, account_id, team_id, new_role.as_str()).await.map_err(e)?;
218
    accounts::audit(
219
        &app.db,
220
        viewer.account(),
221
        "repo.collaborator.set",
222
        &format!("{owner}/{name}"),
223
        &format!("{label} {}", new_role.as_str()),
224
    )
225
    .await
226
    .ok();
227
    settings_page(&app, shell, row, role, Some(format!("{label} now has {} access.", new_role.as_str())), None).await
228
}
229
230
#[derive(Deserialize)]
231
pub struct DeleteForm {
232
    #[serde(rename = "_csrf")]
233
    csrf_token: String,
234
    confirm: String,
235
}
236
237
pub async fn delete(
238
    State(app): State<Shared>,
239
    viewer: Viewer,
240
    Path((owner, name)): Path<(String, String)>,
241
    Form(f): Form<DeleteForm>,
242
) -> Result<Response, Error> {
243
    let shell = Shell::new(&app, &format!("/{owner}/{name}/settings"), &viewer);
244
    let (repo, row, role) = lookup_role(&app, &shell, &viewer, &owner, &name, Access::Admin).await?;
245
    csrf(&viewer, &f.csrf_token, &shell)?;
246
    if f.confirm.trim() != repo.to_string() {
247
        return Ok(settings_page(&app, shell, row, role, None, Some("Type the repository's full name to delete it.".into()))
248
            .await?
249
            .into_response());
250
    }
251
    let _guard = app.repos.write_guard(&repo).await;
252
    app.repos.trash(&repo).map_err(|e| Error::from_repo(shell.clone(), e))?;
253
    db::repos::delete(&app.db, row.id).await.map_err(|e| Error::from_db(shell.clone(), e))?;
254
    accounts::audit(&app.db, viewer.account(), "repo.deleted", &repo.to_string(), "moved to trash").await.ok();
255
    Ok(Redirect::to(&format!("/{owner}")).into_response())
256
}
257
258
#[derive(Deserialize)]
259
pub struct RequirementsForm {
260
    #[serde(rename = "_csrf")]
261
    csrf_token: String,
262
    #[serde(default)]
263
    required_approvals: i64,
264
    #[serde(default)]
265
    require_owners: Option<String>,
266
    #[serde(default)]
267
    allow_conflicts: Option<String>,
268
}
269
270
pub async fn requirements(
271
    State(app): State<Shared>,
272
    viewer: Viewer,
273
    Path((owner, name)): Path<(String, String)>,
274
    Form(f): Form<RequirementsForm>,
275
) -> Result<Page<RepoSettingsPage>, Error> {
276
    let shell = Shell::new(&app, &format!("/{owner}/{name}/settings"), &viewer);
277
    let (_, row, role) = lookup_role(&app, &shell, &viewer, &owner, &name, Access::Maintain).await?;
278
    csrf(&viewer, &f.csrf_token, &shell)?;
279
    let r = db::proposals::Requirements {
280
        required_approvals: f.required_approvals.max(0),
281
        require_owners: f.require_owners.is_some(),
282
        allow_conflicts: f.allow_conflicts.is_some(),
283
    };
284
    db::proposals::set_requirements(&app.db, row.id, r).await.map_err(|e| Error::from_db(shell.clone(), e))?;
285
    accounts::audit(
286
        &app.db,
287
        viewer.account(),
288
        "repo.requirements",
289
        &format!("{owner}/{name}"),
290
        &format!("{} approvals, owners {}, conflicts {}", r.required_approvals, r.require_owners, r.allow_conflicts),
291
    )
292
    .await
293
    .ok();
294
    settings_page(&app, shell, row, role, Some("Landing requirements saved.".into()), None).await
295
}
296
297
pub async fn hooks(
298
    State(app): State<Shared>,
299
    viewer: Viewer,
300
    Path((owner, name)): Path<(String, String)>,
301
    Form(f): Form<super::webhooks::HookForm>,
302
) -> Result<Page<RepoSettingsPage>, Error> {
303
    let shell = Shell::new(&app, &format!("/{owner}/{name}/settings"), &viewer);
304
    let (_, row, role) = lookup_role(&app, &shell, &viewer, &owner, &name, Access::Admin).await?;
305
    csrf(&viewer, &f.csrf_token, &shell)?;
306
    let scope = super::webhooks::Scope::Repo { id: row.id, slug: format!("{owner}/{name}") };
307
    match super::webhooks::apply(&app, &viewer, &scope, f).await.map_err(|e| Error::from_db(shell.clone(), e))? {
308
        Ok(notice) => settings_page(&app, shell, row, role, Some(notice), None).await,
309
        Err(error) => settings_page(&app, shell, row, role, None, Some(error)).await,
310
    }
311
}
312
313
pub async fn deliveries(
314
    State(app): State<Shared>,
315
    viewer: Viewer,
316
    Path((owner, name, id)): Path<(String, String, i64)>,
317
) -> Result<Page<super::webhooks::DeliveriesPage>, Error> {
318
    let shell = Shell::new(&app, &format!("/{owner}/{name}/settings/hooks/{id}/deliveries"), &viewer);
319
    let (_, row, role) = lookup_role(&app, &shell, &viewer, &owner, &name, Access::Admin).await?;
320
    let scope = super::webhooks::Scope::Repo { id: row.id, slug: format!("{owner}/{name}") };
321
    super::webhooks::deliveries_page(&app, shell, &scope, Some(RepoShell::new(&app, &row, "settings").with_role(role)), id).await
322
}
323
324
pub async fn redeliver(
325
    State(app): State<Shared>,
326
    viewer: Viewer,
327
    Path((owner, name, id, delivery)): Path<(String, String, i64, i64)>,
328
    Form(f): Form<super::session::CsrfForm>,
329
) -> Result<Page<super::webhooks::DeliveriesPage>, Error> {
330
    let shell = Shell::new(&app, &format!("/{owner}/{name}/settings/hooks/{id}/deliveries"), &viewer);
331
    let (_, row, role) = lookup_role(&app, &shell, &viewer, &owner, &name, Access::Admin).await?;
332
    csrf(&viewer, &f.csrf, &shell)?;
333
    let scope = super::webhooks::Scope::Repo { id: row.id, slug: format!("{owner}/{name}") };
334
    super::webhooks::redeliver(&app, &scope, id, delivery).await.map_err(|e| Error::from_db(shell.clone(), e))?;
335
    super::webhooks::deliveries_page(&app, shell, &scope, Some(RepoShell::new(&app, &row, "settings").with_role(role)), id).await
336
}
337
338
#[derive(Deserialize)]
339
pub struct ChecksForm {
340
    #[serde(rename = "_csrf")]
341
    csrf_token: String,
342
    #[serde(default)]
343
    required_checks: String,
344
}
345
346
pub async fn required_checks(
347
    State(app): State<Shared>,
348
    viewer: Viewer,
349
    Path((owner, name)): Path<(String, String)>,
350
    Form(f): Form<ChecksForm>,
351
) -> Result<Page<RepoSettingsPage>, Error> {
352
    let shell = Shell::new(&app, &format!("/{owner}/{name}/settings"), &viewer);
353
    let (_, row, role) = lookup_role(&app, &shell, &viewer, &owner, &name, Access::Maintain).await?;
354
    csrf(&viewer, &f.csrf_token, &shell)?;
355
    let names: Vec<String> = f.required_checks.split(',').map(str::trim).filter(|s| !s.is_empty()).map(String::from).collect();
356
    db::hooks::set_required_checks(&app.db, row.id, &names).await.map_err(|e| Error::from_db(shell.clone(), e))?;
357
    settings_page(&app, shell, row, role, Some("Required checks saved.".into()), None).await
358
}
359
360
#[derive(Deserialize)]
361
pub struct MirrorForm {
362
    #[serde(rename = "_csrf")]
363
    csrf_token: String,
364
    #[serde(default)]
365
    enabled: Option<String>,
366
}
367
368
pub async fn mirror(
369
    State(app): State<Shared>,
370
    viewer: Viewer,
371
    Path((owner, name)): Path<(String, String)>,
372
    Form(f): Form<MirrorForm>,
373
) -> Result<Page<RepoSettingsPage>, Error> {
374
    let shell = Shell::new(&app, &format!("/{owner}/{name}/settings"), &viewer);
375
    let (_, row, role) = lookup_role(&app, &shell, &viewer, &owner, &name, Access::Maintain).await?;
376
    csrf(&viewer, &f.csrf_token, &shell)?;
377
    db::repos::set_git_mirror(&app.db, row.id, f.enabled.is_some()).await.map_err(|e| Error::from_db(shell.clone(), e))?;
378
    let row = db::repos::get_by_id(&app.db, row.id).await.map_err(|e| Error::from_db(shell.clone(), e))?.unwrap_or(row);
379
    if row.git_mirror {
380
        crate::mirror::refresh(&app, &row).await;
381
    }
382
    accounts::audit(&app.db, viewer.account(), "repo.mirror", &format!("{owner}/{name}"), if row.git_mirror { "on" } else { "off" })
383
        .await
384
        .ok();
385
    let row = db::repos::get_by_id(&app.db, row.id).await.map_err(|e| Error::from_db(shell.clone(), e))?.unwrap_or(row);
386
    let notice = if row.git_mirror { "The Git mirror is on and up to date." } else { "The Git mirror is off." };
387
    settings_page(&app, shell, row, role, Some(notice.into()), None).await
388
}