1 use crate::site::{application_question_check, site_default_post_listing_type_check};
2 use activitypub_federation::http_signatures::generate_actor_keypair;
3 use actix_web::web::{Data, Json};
4 use lemmy_api_common::{
6 site::{CreateSite, SiteResponse},
8 generate_site_inbox_url, is_admin, local_site_rate_limit_to_rate_limit_config,
9 local_user_view_from_jwt, sanitize_html, sanitize_html_opt,
12 use lemmy_db_schema::{
15 local_site::{LocalSite, LocalSiteUpdateForm},
16 local_site_rate_limit::{LocalSiteRateLimit, LocalSiteRateLimitUpdateForm},
17 site::{Site, SiteUpdateForm},
21 utils::{diesel_option_overwrite, diesel_option_overwrite_to_url, naive_now},
23 use lemmy_db_views::structs::SiteView;
25 error::{LemmyError, LemmyErrorType, LemmyResult},
27 slurs::{check_slurs, check_slurs_opt},
29 build_and_check_regex, check_site_visibility_valid, is_valid_body_field,
30 site_description_length_check, site_name_length_check,
36 #[tracing::instrument(skip(context))]
37 pub async fn create_site(
38 data: Json<CreateSite>,
39 context: Data<LemmyContext>,
40 ) -> Result<Json<SiteResponse>, LemmyError> {
41 let local_user_view = local_user_view_from_jwt(&data.auth, &context).await?;
42 let local_site = LocalSite::read(&mut context.pool()).await?;
44 // Make sure user is an admin; other types of users should not create site data...
45 is_admin(&local_user_view)?;
47 validate_create_payload(&local_site, &data)?;
49 let actor_id: DbUrl = Url::parse(&context.settings().get_protocol_and_hostname())?.into();
50 let inbox_url = Some(generate_site_inbox_url(&actor_id)?);
51 let keypair = generate_actor_keypair()?;
52 let name = sanitize_html(&data.name);
53 let sidebar = sanitize_html_opt(&data.sidebar);
54 let description = sanitize_html_opt(&data.description);
56 let site_form = SiteUpdateForm {
58 sidebar: diesel_option_overwrite(sidebar),
59 description: diesel_option_overwrite(description),
60 icon: diesel_option_overwrite_to_url(&data.icon)?,
61 banner: diesel_option_overwrite_to_url(&data.banner)?,
62 actor_id: Some(actor_id),
63 last_refreshed_at: Some(naive_now()),
65 private_key: Some(Some(keypair.private_key)),
66 public_key: Some(keypair.public_key),
70 let site_id = local_site.site_id;
72 Site::update(&mut context.pool(), site_id, &site_form).await?;
73 let application_question = sanitize_html_opt(&data.application_question);
74 let default_theme = sanitize_html_opt(&data.default_theme);
75 let legal_information = sanitize_html_opt(&data.legal_information);
77 let local_site_form = LocalSiteUpdateForm {
78 // Set the site setup to true
79 site_setup: Some(true),
80 enable_downvotes: data.enable_downvotes,
81 enable_federated_downvotes: data.enable_federated_downvotes,
82 registration_mode: data.registration_mode,
83 enable_nsfw: data.enable_nsfw,
84 community_creation_admin_only: data.community_creation_admin_only,
85 require_email_verification: data.require_email_verification,
86 application_question: diesel_option_overwrite(application_question),
87 private_instance: data.private_instance,
89 default_post_listing_type: data.default_post_listing_type,
90 legal_information: diesel_option_overwrite(legal_information),
91 application_email_admins: data.application_email_admins,
92 hide_modlog_mod_names: data.hide_modlog_mod_names,
93 updated: Some(Some(naive_now())),
94 slur_filter_regex: diesel_option_overwrite(data.slur_filter_regex.clone()),
95 actor_name_max_length: data.actor_name_max_length,
96 federation_enabled: data.federation_enabled,
97 captcha_enabled: data.captcha_enabled,
98 captcha_difficulty: data.captcha_difficulty.clone(),
102 LocalSite::update(&mut context.pool(), &local_site_form).await?;
104 let local_site_rate_limit_form = LocalSiteRateLimitUpdateForm {
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,
120 LocalSiteRateLimit::update(&mut context.pool(), &local_site_rate_limit_form).await?;
122 let site_view = SiteView::read_local(&mut context.pool()).await?;
124 let new_taglines = data.taglines.clone();
125 let taglines = Tagline::replace(&mut context.pool(), local_site.id, new_taglines).await?;
127 let rate_limit_config =
128 local_site_rate_limit_to_rate_limit_config(&site_view.local_site_rate_limit);
130 .settings_updated_channel()
131 .send(rate_limit_config)
134 Ok(Json(SiteResponse {
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 Err(LemmyErrorType::SiteAlreadyExists)?;
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 #![allow(clippy::unwrap_used)]
187 #![allow(clippy::indexing_slicing)]
189 use crate::site::create::validate_create_payload;
190 use lemmy_api_common::site::CreateSite;
191 use lemmy_db_schema::{source::local_site::LocalSite, ListingType, RegistrationMode};
192 use lemmy_utils::error::LemmyErrorType;
195 fn test_validate_invalid_create_payload() {
196 let invalid_payloads = [
198 "CreateSite attempted on set up LocalSite",
199 LemmyErrorType::SiteAlreadyExists,
200 &generate_local_site(
206 RegistrationMode::Open,
208 &generate_create_site(
209 String::from("site_name"),
217 None::<RegistrationMode>,
221 "CreateSite name matches LocalSite slur filter",
222 LemmyErrorType::Slurs,
223 &generate_local_site(
225 Some(String::from("(foo|bar)")),
229 RegistrationMode::Open,
231 &generate_create_site(
232 String::from("foo site_name"),
240 None::<RegistrationMode>,
244 "CreateSite name matches new slur filter",
245 LemmyErrorType::Slurs,
246 &generate_local_site(
248 Some(String::from("(foo|bar)")),
252 RegistrationMode::Open,
254 &generate_create_site(
255 String::from("zeta site_name"),
259 Some(String::from("(zeta|alpha)")),
263 None::<RegistrationMode>,
267 "CreateSite listing type is Subscribed, which is invalid",
268 LemmyErrorType::InvalidDefaultPostListingType,
269 &generate_local_site(
275 RegistrationMode::Open,
277 &generate_create_site(
278 String::from("site_name"),
281 Some(ListingType::Subscribed),
286 None::<RegistrationMode>,
290 "CreateSite is both private and federated",
291 LemmyErrorType::CantEnablePrivateInstanceAndFederationTogether,
292 &generate_local_site(
298 RegistrationMode::Open,
300 &generate_create_site(
301 String::from("site_name"),
309 None::<RegistrationMode>,
313 "LocalSite is private, but CreateSite also makes it federated",
314 LemmyErrorType::CantEnablePrivateInstanceAndFederationTogether,
315 &generate_local_site(
321 RegistrationMode::Open,
323 &generate_create_site(
324 String::from("site_name"),
332 None::<RegistrationMode>,
336 "CreateSite requires application, but neither it nor LocalSite has an application question",
337 LemmyErrorType::ApplicationQuestionRequired,
338 &generate_local_site(
344 RegistrationMode::Open,
346 &generate_create_site(
347 String::from("site_name"),
355 Some(RegistrationMode::RequireApplication),
360 invalid_payloads.iter().enumerate().for_each(
363 &(reason, ref expected_err, local_site, create_site),
365 match validate_create_payload(
371 "Got Ok, but validation should have failed with error: {} for reason: {}. invalid_payloads.nth({})",
372 expected_err, reason, idx
377 error.error_type.eq(&expected_err.clone()),
378 "Got Err {:?}, but should have failed with message: {} for reason: {}. invalid_payloads.nth({})",
391 fn test_validate_valid_create_payload() {
392 let valid_payloads = [
394 "No changes between LocalSite and CreateSite",
395 &generate_local_site(
401 RegistrationMode::Open,
403 &generate_create_site(
404 String::from("site_name"),
412 None::<RegistrationMode>,
416 "CreateSite allows clearing and changing values",
417 &generate_local_site(
423 RegistrationMode::Open,
425 &generate_create_site(
426 String::from("site_name"),
429 Some(ListingType::All),
434 Some(RegistrationMode::Open),
438 "CreateSite clears existing slur filter regex",
439 &generate_local_site(
441 Some(String::from("(foo|bar)")),
445 RegistrationMode::Open,
447 &generate_create_site(
448 String::from("foo site_name"),
456 None::<RegistrationMode>,
460 "LocalSite has application question and CreateSite now requires applications,",
461 &generate_local_site(
466 Some(String::from("question")),
467 RegistrationMode::Open,
469 &generate_create_site(
470 String::from("site_name"),
478 Some(RegistrationMode::RequireApplication),
486 .for_each(|(idx, &(reason, local_site, edit_site))| {
488 validate_create_payload(local_site, edit_site).is_ok(),
489 "Got Err, but should have got Ok for reason: {}. valid_payloads.nth({})",
496 fn generate_local_site(
498 site_slur_filter_regex: Option<String>,
499 site_is_private: bool,
500 site_is_federated: bool,
501 site_application_question: Option<String>,
502 site_registration_mode: RegistrationMode,
505 id: Default::default(),
506 site_id: Default::default(),
508 enable_downvotes: false,
509 enable_federated_downvotes: false,
511 community_creation_admin_only: false,
512 require_email_verification: false,
513 application_question: site_application_question,
514 private_instance: site_is_private,
515 default_theme: String::new(),
516 default_post_listing_type: ListingType::All,
517 legal_information: None,
518 hide_modlog_mod_names: false,
519 application_email_admins: false,
520 slur_filter_regex: site_slur_filter_regex,
521 actor_name_max_length: 0,
522 federation_enabled: site_is_federated,
523 captcha_enabled: false,
524 captcha_difficulty: String::new(),
525 published: Default::default(),
527 registration_mode: site_registration_mode,
528 reports_email_admins: false,
532 // Allow the test helper function to have too many arguments.
533 // It's either this or generate the entire struct each time for testing.
534 #[allow(clippy::too_many_arguments)]
535 fn generate_create_site(
537 site_description: Option<String>,
538 site_sidebar: Option<String>,
539 site_listing_type: Option<ListingType>,
540 site_slur_filter_regex: Option<String>,
541 site_is_private: Option<bool>,
542 site_is_federated: Option<bool>,
543 site_application_question: Option<String>,
544 site_registration_mode: Option<RegistrationMode>,
548 sidebar: site_sidebar,
549 description: site_description,
552 enable_downvotes: None,
553 enable_federated_downvotes: None,
555 community_creation_admin_only: None,
556 require_email_verification: None,
557 application_question: site_application_question,
558 private_instance: site_is_private,
560 default_post_listing_type: site_listing_type,
561 legal_information: None,
562 application_email_admins: None,
563 hide_modlog_mod_names: None,
564 discussion_languages: None,
565 slur_filter_regex: site_slur_filter_regex,
566 actor_name_max_length: None,
567 rate_limit_message: None,
568 rate_limit_message_per_second: None,
569 rate_limit_post: None,
570 rate_limit_post_per_second: None,
571 rate_limit_register: None,
572 rate_limit_register_per_second: None,
573 rate_limit_image: None,
574 rate_limit_image_per_second: None,
575 rate_limit_comment: None,
576 rate_limit_comment_per_second: None,
577 rate_limit_search: None,
578 rate_limit_search_per_second: None,
579 federation_enabled: site_is_federated,
580 federation_debug: None,
581 captcha_enabled: None,
582 captcha_difficulty: None,
583 allowed_instances: None,
584 blocked_instances: None,
586 registration_mode: site_registration_mode,
587 auth: Default::default(),