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,
10 local_site_rate_limit_to_rate_limit_config,
11 local_user_view_from_jwt,
16 use lemmy_db_schema::{
19 local_site::{LocalSite, LocalSiteUpdateForm},
20 local_site_rate_limit::{LocalSiteRateLimit, LocalSiteRateLimitUpdateForm},
21 site::{Site, SiteUpdateForm},
25 utils::{diesel_option_overwrite, diesel_option_overwrite_to_url, naive_now},
27 use lemmy_db_views::structs::SiteView;
29 error::{LemmyError, LemmyErrorType, LemmyResult},
31 slurs::{check_slurs, check_slurs_opt},
33 build_and_check_regex,
34 check_site_visibility_valid,
36 site_description_length_check,
37 site_name_length_check,
43 #[tracing::instrument(skip(context))]
44 pub async fn create_site(
45 data: Json<CreateSite>,
46 context: Data<LemmyContext>,
47 ) -> Result<Json<SiteResponse>, LemmyError> {
48 let local_user_view = local_user_view_from_jwt(&data.auth, &context).await?;
49 let local_site = LocalSite::read(&mut context.pool()).await?;
51 // Make sure user is an admin; other types of users should not create site data...
52 is_admin(&local_user_view)?;
54 validate_create_payload(&local_site, &data)?;
56 let actor_id: DbUrl = Url::parse(&context.settings().get_protocol_and_hostname())?.into();
57 let inbox_url = Some(generate_site_inbox_url(&actor_id)?);
58 let keypair = generate_actor_keypair()?;
59 let name = sanitize_html(&data.name);
60 let sidebar = sanitize_html_opt(&data.sidebar);
61 let description = sanitize_html_opt(&data.description);
63 let site_form = SiteUpdateForm {
65 sidebar: diesel_option_overwrite(sidebar),
66 description: diesel_option_overwrite(description),
67 icon: diesel_option_overwrite_to_url(&data.icon)?,
68 banner: diesel_option_overwrite_to_url(&data.banner)?,
69 actor_id: Some(actor_id),
70 last_refreshed_at: Some(naive_now()),
72 private_key: Some(Some(keypair.private_key)),
73 public_key: Some(keypair.public_key),
77 let site_id = local_site.site_id;
79 Site::update(&mut context.pool(), site_id, &site_form).await?;
81 let application_question = sanitize_html_opt(&data.application_question);
82 let default_theme = sanitize_html_opt(&data.default_theme);
83 let legal_information = sanitize_html_opt(&data.legal_information);
85 let local_site_form = LocalSiteUpdateForm {
86 // Set the site setup to true
87 site_setup: Some(true),
88 enable_downvotes: data.enable_downvotes,
89 registration_mode: data.registration_mode,
90 enable_nsfw: data.enable_nsfw,
91 community_creation_admin_only: data.community_creation_admin_only,
92 require_email_verification: data.require_email_verification,
93 application_question: diesel_option_overwrite(application_question),
94 private_instance: data.private_instance,
96 default_post_listing_type: data.default_post_listing_type,
97 legal_information: diesel_option_overwrite(legal_information),
98 application_email_admins: data.application_email_admins,
99 hide_modlog_mod_names: data.hide_modlog_mod_names,
100 updated: Some(Some(naive_now())),
101 slur_filter_regex: diesel_option_overwrite(data.slur_filter_regex.clone()),
102 actor_name_max_length: data.actor_name_max_length,
103 federation_enabled: data.federation_enabled,
104 captcha_enabled: data.captcha_enabled,
105 captcha_difficulty: data.captcha_difficulty.clone(),
109 LocalSite::update(&mut context.pool(), &local_site_form).await?;
111 let local_site_rate_limit_form = LocalSiteRateLimitUpdateForm {
112 message: data.rate_limit_message,
113 message_per_second: data.rate_limit_message_per_second,
114 post: data.rate_limit_post,
115 post_per_second: data.rate_limit_post_per_second,
116 register: data.rate_limit_register,
117 register_per_second: data.rate_limit_register_per_second,
118 image: data.rate_limit_image,
119 image_per_second: data.rate_limit_image_per_second,
120 comment: data.rate_limit_comment,
121 comment_per_second: data.rate_limit_comment_per_second,
122 search: data.rate_limit_search,
123 search_per_second: data.rate_limit_search_per_second,
127 LocalSiteRateLimit::update(&mut context.pool(), &local_site_rate_limit_form).await?;
129 let site_view = SiteView::read_local(&mut context.pool()).await?;
131 let new_taglines = data.taglines.clone();
132 let taglines = Tagline::replace(&mut context.pool(), local_site.id, new_taglines).await?;
134 let rate_limit_config =
135 local_site_rate_limit_to_rate_limit_config(&site_view.local_site_rate_limit);
137 .settings_updated_channel()
138 .send(rate_limit_config)
141 Ok(Json(SiteResponse {
147 fn validate_create_payload(local_site: &LocalSite, create_site: &CreateSite) -> LemmyResult<()> {
148 // Make sure the site hasn't already been set up...
149 if local_site.site_setup {
150 Err(LemmyErrorType::SiteAlreadyExists)?;
153 // Check that the slur regex compiles, and returns the regex if valid...
154 // Prioritize using new slur regex from the request; if not provided, use the existing regex.
155 let slur_regex = build_and_check_regex(
159 .or(local_site.slur_filter_regex.as_deref()),
162 site_name_length_check(&create_site.name)?;
163 check_slurs(&create_site.name, &slur_regex)?;
165 if let Some(desc) = &create_site.description {
166 site_description_length_check(desc)?;
167 check_slurs_opt(&create_site.description, &slur_regex)?;
170 site_default_post_listing_type_check(&create_site.default_post_listing_type)?;
172 check_site_visibility_valid(
173 local_site.private_instance,
174 local_site.federation_enabled,
175 &create_site.private_instance,
176 &create_site.federation_enabled,
179 // Ensure that the sidebar has fewer than the max num characters...
180 is_valid_body_field(&create_site.sidebar, false)?;
182 application_question_check(
183 &local_site.application_question,
184 &create_site.application_question,
187 .unwrap_or(local_site.registration_mode),
193 #![allow(clippy::unwrap_used)]
194 #![allow(clippy::indexing_slicing)]
196 use crate::site::create::validate_create_payload;
197 use lemmy_api_common::site::CreateSite;
198 use lemmy_db_schema::{source::local_site::LocalSite, ListingType, RegistrationMode};
199 use lemmy_utils::error::LemmyErrorType;
202 fn test_validate_invalid_create_payload() {
203 let invalid_payloads = [
205 "CreateSite attempted on set up LocalSite",
206 LemmyErrorType::SiteAlreadyExists,
207 &generate_local_site(
213 RegistrationMode::Open,
215 &generate_create_site(
216 String::from("site_name"),
224 None::<RegistrationMode>,
228 "CreateSite name matches LocalSite slur filter",
229 LemmyErrorType::Slurs,
230 &generate_local_site(
232 Some(String::from("(foo|bar)")),
236 RegistrationMode::Open,
238 &generate_create_site(
239 String::from("foo site_name"),
247 None::<RegistrationMode>,
251 "CreateSite name matches new slur filter",
252 LemmyErrorType::Slurs,
253 &generate_local_site(
255 Some(String::from("(foo|bar)")),
259 RegistrationMode::Open,
261 &generate_create_site(
262 String::from("zeta site_name"),
266 Some(String::from("(zeta|alpha)")),
270 None::<RegistrationMode>,
274 "CreateSite listing type is Subscribed, which is invalid",
275 LemmyErrorType::InvalidDefaultPostListingType,
276 &generate_local_site(
282 RegistrationMode::Open,
284 &generate_create_site(
285 String::from("site_name"),
288 Some(ListingType::Subscribed),
293 None::<RegistrationMode>,
297 "CreateSite is both private and federated",
298 LemmyErrorType::CantEnablePrivateInstanceAndFederationTogether,
299 &generate_local_site(
305 RegistrationMode::Open,
307 &generate_create_site(
308 String::from("site_name"),
316 None::<RegistrationMode>,
320 "LocalSite is private, but CreateSite also makes it federated",
321 LemmyErrorType::CantEnablePrivateInstanceAndFederationTogether,
322 &generate_local_site(
328 RegistrationMode::Open,
330 &generate_create_site(
331 String::from("site_name"),
339 None::<RegistrationMode>,
343 "CreateSite requires application, but neither it nor LocalSite has an application question",
344 LemmyErrorType::ApplicationQuestionRequired,
345 &generate_local_site(
351 RegistrationMode::Open,
353 &generate_create_site(
354 String::from("site_name"),
362 Some(RegistrationMode::RequireApplication),
367 invalid_payloads.iter().enumerate().for_each(
370 &(reason, ref expected_err, local_site, create_site),
372 match validate_create_payload(
378 "Got Ok, but validation should have failed with error: {} for reason: {}. invalid_payloads.nth({})",
379 expected_err, reason, idx
384 error.error_type.eq(&expected_err.clone()),
385 "Got Err {:?}, but should have failed with message: {} for reason: {}. invalid_payloads.nth({})",
398 fn test_validate_valid_create_payload() {
399 let valid_payloads = [
401 "No changes between LocalSite and CreateSite",
402 &generate_local_site(
408 RegistrationMode::Open,
410 &generate_create_site(
411 String::from("site_name"),
419 None::<RegistrationMode>,
423 "CreateSite allows clearing and changing values",
424 &generate_local_site(
430 RegistrationMode::Open,
432 &generate_create_site(
433 String::from("site_name"),
436 Some(ListingType::All),
441 Some(RegistrationMode::Open),
445 "CreateSite clears existing slur filter regex",
446 &generate_local_site(
448 Some(String::from("(foo|bar)")),
452 RegistrationMode::Open,
454 &generate_create_site(
455 String::from("foo site_name"),
463 None::<RegistrationMode>,
467 "LocalSite has application question and CreateSite now requires applications,",
468 &generate_local_site(
473 Some(String::from("question")),
474 RegistrationMode::Open,
476 &generate_create_site(
477 String::from("site_name"),
485 Some(RegistrationMode::RequireApplication),
493 .for_each(|(idx, &(reason, local_site, edit_site))| {
495 validate_create_payload(local_site, edit_site).is_ok(),
496 "Got Err, but should have got Ok for reason: {}. valid_payloads.nth({})",
503 fn generate_local_site(
505 site_slur_filter_regex: Option<String>,
506 site_is_private: bool,
507 site_is_federated: bool,
508 site_application_question: Option<String>,
509 site_registration_mode: RegistrationMode,
512 id: Default::default(),
513 site_id: Default::default(),
515 enable_downvotes: false,
517 community_creation_admin_only: false,
518 require_email_verification: false,
519 application_question: site_application_question,
520 private_instance: site_is_private,
521 default_theme: String::new(),
522 default_post_listing_type: ListingType::All,
523 legal_information: None,
524 hide_modlog_mod_names: false,
525 application_email_admins: false,
526 slur_filter_regex: site_slur_filter_regex,
527 actor_name_max_length: 0,
528 federation_enabled: site_is_federated,
529 captcha_enabled: false,
530 captcha_difficulty: String::new(),
531 published: Default::default(),
533 registration_mode: site_registration_mode,
534 reports_email_admins: false,
538 // Allow the test helper function to have too many arguments.
539 // It's either this or generate the entire struct each time for testing.
540 #[allow(clippy::too_many_arguments)]
541 fn generate_create_site(
543 site_description: Option<String>,
544 site_sidebar: Option<String>,
545 site_listing_type: Option<ListingType>,
546 site_slur_filter_regex: Option<String>,
547 site_is_private: Option<bool>,
548 site_is_federated: Option<bool>,
549 site_application_question: Option<String>,
550 site_registration_mode: Option<RegistrationMode>,
554 sidebar: site_sidebar,
555 description: site_description,
558 enable_downvotes: None,
560 community_creation_admin_only: None,
561 require_email_verification: None,
562 application_question: site_application_question,
563 private_instance: site_is_private,
565 default_post_listing_type: site_listing_type,
566 legal_information: None,
567 application_email_admins: None,
568 hide_modlog_mod_names: None,
569 discussion_languages: None,
570 slur_filter_regex: site_slur_filter_regex,
571 actor_name_max_length: None,
572 rate_limit_message: None,
573 rate_limit_message_per_second: None,
574 rate_limit_post: None,
575 rate_limit_post_per_second: None,
576 rate_limit_register: None,
577 rate_limit_register_per_second: None,
578 rate_limit_image: None,
579 rate_limit_image_per_second: None,
580 rate_limit_comment: None,
581 rate_limit_comment_per_second: None,
582 rate_limit_search: None,
583 rate_limit_search_per_second: None,
584 federation_enabled: site_is_federated,
585 federation_debug: None,
586 captcha_enabled: None,
587 captcha_difficulty: None,
588 allowed_instances: None,
589 blocked_instances: None,
591 registration_mode: site_registration_mode,
592 auth: Default::default(),