2 site::{application_question_check, site_default_post_listing_type_check},
5 use activitypub_federation::http_signatures::generate_actor_keypair;
6 use actix_web::web::Data;
7 use lemmy_api_common::{
9 site::{CreateSite, SiteResponse},
11 generate_site_inbox_url,
13 local_site_rate_limit_to_rate_limit_config,
14 local_user_view_from_jwt,
17 use lemmy_db_schema::{
20 local_site::{LocalSite, LocalSiteUpdateForm},
21 local_site_rate_limit::{LocalSiteRateLimit, LocalSiteRateLimitUpdateForm},
22 site::{Site, SiteUpdateForm},
26 utils::{diesel_option_overwrite, diesel_option_overwrite_to_url, naive_now},
28 use lemmy_db_views::structs::SiteView;
30 error::{LemmyError, LemmyResult},
32 slurs::{check_slurs, check_slurs_opt},
34 build_and_check_regex,
35 check_site_visibility_valid,
37 site_description_length_check,
38 site_name_length_check,
44 #[async_trait::async_trait(?Send)]
45 impl PerformCrud for CreateSite {
46 type Response = SiteResponse;
48 #[tracing::instrument(skip(context))]
49 async fn perform(&self, context: &Data<LemmyContext>) -> Result<SiteResponse, LemmyError> {
50 let data: &CreateSite = self;
51 let local_user_view = local_user_view_from_jwt(&data.auth, context).await?;
52 let local_site = LocalSite::read(context.pool()).await?;
54 // Make sure user is an admin; other types of users should not create site data...
55 is_admin(&local_user_view)?;
57 validate_create_payload(&local_site, data)?;
59 let actor_id: DbUrl = Url::parse(&context.settings().get_protocol_and_hostname())?.into();
60 let inbox_url = Some(generate_site_inbox_url(&actor_id)?);
61 let keypair = generate_actor_keypair()?;
62 let site_form = SiteUpdateForm::builder()
63 .name(Some(data.name.clone()))
64 .sidebar(diesel_option_overwrite(&data.sidebar))
65 .description(diesel_option_overwrite(&data.description))
66 .icon(diesel_option_overwrite_to_url(&data.icon)?)
67 .banner(diesel_option_overwrite_to_url(&data.banner)?)
68 .actor_id(Some(actor_id))
69 .last_refreshed_at(Some(naive_now()))
71 .private_key(Some(Some(keypair.private_key)))
72 .public_key(Some(keypair.public_key))
75 let site_id = local_site.site_id;
77 Site::update(context.pool(), site_id, &site_form).await?;
79 let local_site_form = LocalSiteUpdateForm::builder()
80 // Set the site setup to true
81 .site_setup(Some(true))
82 .enable_downvotes(data.enable_downvotes)
83 .registration_mode(data.registration_mode)
84 .enable_nsfw(data.enable_nsfw)
85 .community_creation_admin_only(data.community_creation_admin_only)
86 .require_email_verification(data.require_email_verification)
87 .application_question(diesel_option_overwrite(&data.application_question))
88 .private_instance(data.private_instance)
89 .default_theme(data.default_theme.clone())
90 .default_post_listing_type(data.default_post_listing_type)
91 .legal_information(diesel_option_overwrite(&data.legal_information))
92 .application_email_admins(data.application_email_admins)
93 .hide_modlog_mod_names(data.hide_modlog_mod_names)
94 .updated(Some(Some(naive_now())))
95 .slur_filter_regex(diesel_option_overwrite(&data.slur_filter_regex))
96 .actor_name_max_length(data.actor_name_max_length)
97 .federation_enabled(data.federation_enabled)
98 .captcha_enabled(data.captcha_enabled)
99 .captcha_difficulty(data.captcha_difficulty.clone())
102 LocalSite::update(context.pool(), &local_site_form).await?;
104 let local_site_rate_limit_form = LocalSiteRateLimitUpdateForm::builder()
105 .message(data.rate_limit_message)
106 .message_per_second(data.rate_limit_message_per_second)
107 .post(data.rate_limit_post)
108 .post_per_second(data.rate_limit_post_per_second)
109 .register(data.rate_limit_register)
110 .register_per_second(data.rate_limit_register_per_second)
111 .image(data.rate_limit_image)
112 .image_per_second(data.rate_limit_image_per_second)
113 .comment(data.rate_limit_comment)
114 .comment_per_second(data.rate_limit_comment_per_second)
115 .search(data.rate_limit_search)
116 .search_per_second(data.rate_limit_search_per_second)
119 LocalSiteRateLimit::update(context.pool(), &local_site_rate_limit_form).await?;
121 let site_view = SiteView::read_local(context.pool()).await?;
123 let new_taglines = data.taglines.clone();
124 let taglines = Tagline::replace(context.pool(), local_site.id, new_taglines).await?;
126 let rate_limit_config =
127 local_site_rate_limit_to_rate_limit_config(&site_view.local_site_rate_limit);
129 .settings_updated_channel()
130 .send(rate_limit_config)
140 fn validate_create_payload(local_site: &LocalSite, create_site: &CreateSite) -> LemmyResult<()> {
141 // Make sure the site hasn't already been set up...
142 if local_site.site_setup {
143 return Err(LemmyError::from_message("site_already_exists"));
146 // Check that the slur regex compiles, and returns the regex if valid...
147 // Prioritize using new slur regex from the request; if not provided, use the existing regex.
148 let slur_regex = build_and_check_regex(
152 .or(local_site.slur_filter_regex.as_deref()),
155 site_name_length_check(&create_site.name)?;
156 check_slurs(&create_site.name, &slur_regex)?;
158 if let Some(desc) = &create_site.description {
159 site_description_length_check(desc)?;
160 check_slurs_opt(&create_site.description, &slur_regex)?;
163 site_default_post_listing_type_check(&create_site.default_post_listing_type)?;
165 check_site_visibility_valid(
166 local_site.private_instance,
167 local_site.federation_enabled,
168 &create_site.private_instance,
169 &create_site.federation_enabled,
172 // Ensure that the sidebar has fewer than the max num characters...
173 is_valid_body_field(&create_site.sidebar, false)?;
175 application_question_check(
176 &local_site.application_question,
177 &create_site.application_question,
180 .unwrap_or(local_site.registration_mode),
186 use crate::site::create::validate_create_payload;
187 use lemmy_api_common::site::CreateSite;
188 use lemmy_db_schema::{source::local_site::LocalSite, ListingType, RegistrationMode};
191 fn test_validate_invalid_create_payload() {
192 let invalid_payloads = [
194 "CreateSite attempted on set up LocalSite",
195 "site_already_exists",
196 &generate_local_site(
202 RegistrationMode::Open,
204 &generate_create_site(
205 String::from("site_name"),
213 None::<RegistrationMode>,
217 "CreateSite name matches LocalSite slur filter",
219 &generate_local_site(
221 Some(String::from("(foo|bar)")),
225 RegistrationMode::Open,
227 &generate_create_site(
228 String::from("foo site_name"),
236 None::<RegistrationMode>,
240 "CreateSite name matches new slur filter",
242 &generate_local_site(
244 Some(String::from("(foo|bar)")),
248 RegistrationMode::Open,
250 &generate_create_site(
251 String::from("zeta site_name"),
255 Some(String::from("(zeta|alpha)")),
259 None::<RegistrationMode>,
263 "CreateSite listing type is Subscribed, which is invalid",
264 "invalid_default_post_listing_type",
265 &generate_local_site(
271 RegistrationMode::Open,
273 &generate_create_site(
274 String::from("site_name"),
277 Some(ListingType::Subscribed),
282 None::<RegistrationMode>,
286 "CreateSite is both private and federated",
287 "cant_enable_private_instance_and_federation_together",
288 &generate_local_site(
294 RegistrationMode::Open,
296 &generate_create_site(
297 String::from("site_name"),
305 None::<RegistrationMode>,
309 "LocalSite is private, but CreateSite also makes it federated",
310 "cant_enable_private_instance_and_federation_together",
311 &generate_local_site(
317 RegistrationMode::Open,
319 &generate_create_site(
320 String::from("site_name"),
328 None::<RegistrationMode>,
332 "CreateSite requires application, but neither it nor LocalSite has an application question",
333 "application_question_required",
334 &generate_local_site(
340 RegistrationMode::Open,
342 &generate_create_site(
343 String::from("site_name"),
351 Some(RegistrationMode::RequireApplication),
356 invalid_payloads.iter().enumerate().for_each(
359 &(reason, expected_err, local_site, create_site),
361 match validate_create_payload(
367 "Got Ok, but validation should have failed with error: {} for reason: {}. invalid_payloads.nth({})",
368 expected_err, reason, idx
373 error.message.eq(&Some(String::from(expected_err))),
374 "Got Err {:?}, but should have failed with message: {} for reason: {}. invalid_payloads.nth({})",
387 fn test_validate_valid_create_payload() {
388 let valid_payloads = [
390 "No changes between LocalSite and CreateSite",
391 &generate_local_site(
397 RegistrationMode::Open,
399 &generate_create_site(
400 String::from("site_name"),
408 None::<RegistrationMode>,
412 "CreateSite allows clearing and changing values",
413 &generate_local_site(
419 RegistrationMode::Open,
421 &generate_create_site(
422 String::from("site_name"),
425 Some(ListingType::All),
430 Some(RegistrationMode::Open),
434 "CreateSite clears existing slur filter regex",
435 &generate_local_site(
437 Some(String::from("(foo|bar)")),
441 RegistrationMode::Open,
443 &generate_create_site(
444 String::from("foo site_name"),
452 None::<RegistrationMode>,
456 "LocalSite has application question and CreateSite now requires applications,",
457 &generate_local_site(
462 Some(String::from("question")),
463 RegistrationMode::Open,
465 &generate_create_site(
466 String::from("site_name"),
474 Some(RegistrationMode::RequireApplication),
482 .for_each(|(idx, &(reason, local_site, edit_site))| {
484 validate_create_payload(local_site, edit_site).is_ok(),
485 "Got Err, but should have got Ok for reason: {}. valid_payloads.nth({})",
492 fn generate_local_site(
494 site_slur_filter_regex: Option<String>,
495 site_is_private: bool,
496 site_is_federated: bool,
497 site_application_question: Option<String>,
498 site_registration_mode: RegistrationMode,
501 id: Default::default(),
502 site_id: Default::default(),
504 enable_downvotes: false,
506 community_creation_admin_only: false,
507 require_email_verification: false,
508 application_question: site_application_question,
509 private_instance: site_is_private,
510 default_theme: String::new(),
511 default_post_listing_type: ListingType::All,
512 legal_information: None,
513 hide_modlog_mod_names: false,
514 application_email_admins: false,
515 slur_filter_regex: site_slur_filter_regex,
516 actor_name_max_length: 0,
517 federation_enabled: site_is_federated,
518 captcha_enabled: false,
519 captcha_difficulty: String::new(),
520 published: Default::default(),
522 registration_mode: site_registration_mode,
523 reports_email_admins: false,
527 // Allow the test helper function to have too many arguments.
528 // It's either this or generate the entire struct each time for testing.
529 #[allow(clippy::too_many_arguments)]
530 fn generate_create_site(
532 site_description: Option<String>,
533 site_sidebar: Option<String>,
534 site_listing_type: Option<ListingType>,
535 site_slur_filter_regex: Option<String>,
536 site_is_private: Option<bool>,
537 site_is_federated: Option<bool>,
538 site_application_question: Option<String>,
539 site_registration_mode: Option<RegistrationMode>,
543 sidebar: site_sidebar,
544 description: site_description,
547 enable_downvotes: None,
549 community_creation_admin_only: None,
550 require_email_verification: None,
551 application_question: site_application_question,
552 private_instance: site_is_private,
554 default_post_listing_type: site_listing_type,
555 legal_information: None,
556 application_email_admins: None,
557 hide_modlog_mod_names: None,
558 discussion_languages: None,
559 slur_filter_regex: site_slur_filter_regex,
560 actor_name_max_length: None,
561 rate_limit_message: None,
562 rate_limit_message_per_second: None,
563 rate_limit_post: None,
564 rate_limit_post_per_second: None,
565 rate_limit_register: None,
566 rate_limit_register_per_second: None,
567 rate_limit_image: None,
568 rate_limit_image_per_second: None,
569 rate_limit_comment: None,
570 rate_limit_comment_per_second: None,
571 rate_limit_search: None,
572 rate_limit_search_per_second: None,
573 federation_enabled: site_is_federated,
574 federation_debug: None,
575 captcha_enabled: None,
576 captcha_difficulty: None,
577 allowed_instances: None,
578 blocked_instances: None,
580 registration_mode: site_registration_mode,
581 auth: Default::default(),