1 use crate::site::{application_question_check, site_default_post_listing_type_check};
2 use actix_web::web::{Data, Json};
3 use lemmy_api_common::{
5 site::{EditSite, SiteResponse},
8 local_site_rate_limit_to_rate_limit_config,
9 local_user_view_from_jwt,
13 use lemmy_db_schema::{
15 actor_language::SiteLanguage,
16 federation_allowlist::FederationAllowList,
17 federation_blocklist::FederationBlockList,
18 local_site::{LocalSite, LocalSiteUpdateForm},
19 local_site_rate_limit::{LocalSiteRateLimit, LocalSiteRateLimitUpdateForm},
20 local_user::LocalUser,
21 site::{Site, SiteUpdateForm},
25 utils::{diesel_option_overwrite, diesel_option_overwrite_to_url, naive_now},
28 use lemmy_db_views::structs::SiteView;
30 error::{LemmyError, LemmyErrorExt, LemmyErrorType, LemmyResult},
32 slurs::check_slurs_opt,
34 build_and_check_regex,
35 check_site_visibility_valid,
37 site_description_length_check,
38 site_name_length_check,
43 #[tracing::instrument(skip(context))]
44 pub async fn update_site(
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 site_view = SiteView::read_local(&mut context.pool()).await?;
50 let local_site = site_view.local_site;
51 let site = site_view.site;
53 // Make sure user is an admin; other types of users should not update site data...
54 is_admin(&local_user_view)?;
56 validate_update_payload(&local_site, &data)?;
58 if let Some(discussion_languages) = data.discussion_languages.clone() {
59 SiteLanguage::update(&mut context.pool(), discussion_languages.clone(), &site).await?;
62 let name = sanitize_html_opt(&data.name);
63 let sidebar = sanitize_html_opt(&data.sidebar);
64 let description = sanitize_html_opt(&data.description);
66 let site_form = SiteUpdateForm {
68 sidebar: diesel_option_overwrite(sidebar),
69 description: diesel_option_overwrite(description),
70 icon: diesel_option_overwrite_to_url(&data.icon)?,
71 banner: diesel_option_overwrite_to_url(&data.banner)?,
72 updated: Some(Some(naive_now())),
76 Site::update(&mut context.pool(), site.id, &site_form)
78 // Ignore errors for all these, so as to not throw errors if no update occurs
79 // Diesel will throw an error for empty update forms
82 let application_question = sanitize_html_opt(&data.application_question);
83 let default_theme = sanitize_html_opt(&data.default_theme);
84 let legal_information = sanitize_html_opt(&data.legal_information);
86 let local_site_form = LocalSiteUpdateForm {
87 enable_downvotes: data.enable_downvotes,
88 registration_mode: data.registration_mode,
89 enable_nsfw: data.enable_nsfw,
90 community_creation_admin_only: data.community_creation_admin_only,
91 require_email_verification: data.require_email_verification,
92 application_question: diesel_option_overwrite(application_question),
93 private_instance: data.private_instance,
95 default_post_listing_type: data.default_post_listing_type,
96 legal_information: diesel_option_overwrite(legal_information),
97 application_email_admins: data.application_email_admins,
98 hide_modlog_mod_names: data.hide_modlog_mod_names,
99 updated: Some(Some(naive_now())),
100 slur_filter_regex: diesel_option_overwrite(data.slur_filter_regex.clone()),
101 actor_name_max_length: data.actor_name_max_length,
102 federation_enabled: data.federation_enabled,
103 captcha_enabled: data.captcha_enabled,
104 captcha_difficulty: data.captcha_difficulty.clone(),
105 reports_email_admins: data.reports_email_admins,
109 let update_local_site = LocalSite::update(&mut context.pool(), &local_site_form)
113 let local_site_rate_limit_form = LocalSiteRateLimitUpdateForm {
114 message: data.rate_limit_message,
115 message_per_second: data.rate_limit_message_per_second,
116 post: data.rate_limit_post,
117 post_per_second: data.rate_limit_post_per_second,
118 register: data.rate_limit_register,
119 register_per_second: data.rate_limit_register_per_second,
120 image: data.rate_limit_image,
121 image_per_second: data.rate_limit_image_per_second,
122 comment: data.rate_limit_comment,
123 comment_per_second: data.rate_limit_comment_per_second,
124 search: data.rate_limit_search,
125 search_per_second: data.rate_limit_search_per_second,
129 LocalSiteRateLimit::update(&mut context.pool(), &local_site_rate_limit_form)
133 // Replace the blocked and allowed instances
134 let allowed = data.allowed_instances.clone();
135 FederationAllowList::replace(&mut context.pool(), allowed).await?;
136 let blocked = data.blocked_instances.clone();
137 FederationBlockList::replace(&mut context.pool(), blocked).await?;
139 // TODO can't think of a better way to do this.
140 // If the server suddenly requires email verification, or required applications, no old users
141 // will be able to log in. It really only wants this to be a requirement for NEW signups.
142 // So if it was set from false, to true, you need to update all current users columns to be verified.
144 let old_require_application =
145 local_site.registration_mode == RegistrationMode::RequireApplication;
146 let new_require_application = update_local_site
148 .map(|ols| ols.registration_mode == RegistrationMode::RequireApplication)
150 if !old_require_application && new_require_application {
151 LocalUser::set_all_users_registration_applications_accepted(&mut context.pool())
153 .with_lemmy_type(LemmyErrorType::CouldntSetAllRegistrationsAccepted)?;
156 let new_require_email_verification = update_local_site
158 .map(|ols| ols.require_email_verification)
160 if !local_site.require_email_verification && new_require_email_verification {
161 LocalUser::set_all_users_email_verified(&mut context.pool())
163 .with_lemmy_type(LemmyErrorType::CouldntSetAllEmailVerified)?;
166 let new_taglines = data.taglines.clone();
167 let taglines = Tagline::replace(&mut context.pool(), local_site.id, new_taglines).await?;
169 let site_view = SiteView::read_local(&mut context.pool()).await?;
171 let rate_limit_config =
172 local_site_rate_limit_to_rate_limit_config(&site_view.local_site_rate_limit);
174 .settings_updated_channel()
175 .send(rate_limit_config)
178 Ok(Json(SiteResponse {
184 fn validate_update_payload(local_site: &LocalSite, edit_site: &EditSite) -> LemmyResult<()> {
185 // Check that the slur regex compiles, and return the regex if valid...
186 // Prioritize using new slur regex from the request; if not provided, use the existing regex.
187 let slur_regex = build_and_check_regex(
191 .or(local_site.slur_filter_regex.as_deref()),
194 if let Some(name) = &edit_site.name {
195 // The name doesn't need to be updated, but if provided it cannot be blanked out...
196 site_name_length_check(name)?;
197 check_slurs_opt(&edit_site.name, &slur_regex)?;
200 if let Some(desc) = &edit_site.description {
201 site_description_length_check(desc)?;
202 check_slurs_opt(&edit_site.description, &slur_regex)?;
205 site_default_post_listing_type_check(&edit_site.default_post_listing_type)?;
207 check_site_visibility_valid(
208 local_site.private_instance,
209 local_site.federation_enabled,
210 &edit_site.private_instance,
211 &edit_site.federation_enabled,
214 // Ensure that the sidebar has fewer than the max num characters...
215 is_valid_body_field(&edit_site.sidebar, false)?;
217 application_question_check(
218 &local_site.application_question,
219 &edit_site.application_question,
222 .unwrap_or(local_site.registration_mode),
228 #![allow(clippy::unwrap_used)]
229 #![allow(clippy::indexing_slicing)]
231 use crate::site::update::validate_update_payload;
232 use lemmy_api_common::site::EditSite;
233 use lemmy_db_schema::{source::local_site::LocalSite, ListingType, RegistrationMode};
234 use lemmy_utils::error::LemmyErrorType;
237 fn test_validate_invalid_update_payload() {
238 let invalid_payloads = [
240 "EditSite name matches LocalSite slur filter",
241 LemmyErrorType::Slurs,
242 &generate_local_site(
243 Some(String::from("(foo|bar)")),
247 RegistrationMode::Open,
250 Some(String::from("foo site_name")),
258 None::<RegistrationMode>,
262 "EditSite name matches new slur filter",
263 LemmyErrorType::Slurs,
264 &generate_local_site(
265 Some(String::from("(foo|bar)")),
269 RegistrationMode::Open,
272 Some(String::from("zeta site_name")),
276 Some(String::from("(zeta|alpha)")),
280 None::<RegistrationMode>,
284 "EditSite listing type is Subscribed, which is invalid",
285 LemmyErrorType::InvalidDefaultPostListingType,
286 &generate_local_site(
291 RegistrationMode::Open,
294 Some(String::from("site_name")),
297 Some(ListingType::Subscribed),
302 None::<RegistrationMode>,
306 "EditSite is both private and federated",
307 LemmyErrorType::CantEnablePrivateInstanceAndFederationTogether,
308 &generate_local_site(
313 RegistrationMode::Open,
316 Some(String::from("site_name")),
324 None::<RegistrationMode>,
328 "LocalSite is private, but EditSite also makes it federated",
329 LemmyErrorType::CantEnablePrivateInstanceAndFederationTogether,
330 &generate_local_site(
335 RegistrationMode::Open,
338 Some(String::from("site_name")),
346 None::<RegistrationMode>,
350 "EditSite requires application, but neither it nor LocalSite has an application question",
351 LemmyErrorType::ApplicationQuestionRequired,
352 &generate_local_site(
357 RegistrationMode::Open,
360 Some(String::from("site_name")),
368 Some(RegistrationMode::RequireApplication),
373 invalid_payloads.iter().enumerate().for_each(
376 &(reason, ref expected_err, local_site, edit_site),
378 match validate_update_payload(local_site, edit_site) {
381 "Got Ok, but validation should have failed with error: {} for reason: {}. invalid_payloads.nth({})",
382 expected_err, reason, idx
387 error.error_type.eq(&expected_err.clone()),
388 "Got Err {:?}, but should have failed with message: {} for reason: {}. invalid_payloads.nth({})",
401 fn test_validate_valid_update_payload() {
402 let valid_payloads = [
404 "No changes between LocalSite and EditSite",
405 &generate_local_site(
410 RegistrationMode::Open,
421 None::<RegistrationMode>,
425 "EditSite allows clearing and changing values",
426 &generate_local_site(
431 RegistrationMode::Open,
434 Some(String::from("site_name")),
437 Some(ListingType::All),
442 Some(RegistrationMode::Open),
446 "EditSite name passes slur filter regex",
447 &generate_local_site(
448 Some(String::from("(foo|bar)")),
452 RegistrationMode::Open,
455 Some(String::from("foo site_name")),
463 None::<RegistrationMode>,
467 "LocalSite has application question and EditSite now requires applications,",
468 &generate_local_site(
472 Some(String::from("question")),
473 RegistrationMode::Open,
476 Some(String::from("site_name")),
484 Some(RegistrationMode::RequireApplication),
492 .for_each(|(idx, &(reason, local_site, edit_site))| {
494 validate_update_payload(local_site, edit_site).is_ok(),
495 "Got Err, but should have got Ok for reason: {}. valid_payloads.nth({})",
502 fn generate_local_site(
503 site_slur_filter_regex: Option<String>,
504 site_is_private: bool,
505 site_is_federated: bool,
506 site_application_question: Option<String>,
507 site_registration_mode: RegistrationMode,
510 id: Default::default(),
511 site_id: Default::default(),
513 enable_downvotes: false,
515 community_creation_admin_only: false,
516 require_email_verification: false,
517 application_question: site_application_question,
518 private_instance: site_is_private,
519 default_theme: String::new(),
520 default_post_listing_type: ListingType::All,
521 legal_information: None,
522 hide_modlog_mod_names: false,
523 application_email_admins: false,
524 slur_filter_regex: site_slur_filter_regex,
525 actor_name_max_length: 0,
526 federation_enabled: site_is_federated,
527 captcha_enabled: false,
528 captcha_difficulty: String::new(),
529 published: Default::default(),
531 registration_mode: site_registration_mode,
532 reports_email_admins: false,
536 // Allow the test helper function to have too many arguments.
537 // It's either this or generate the entire struct each time for testing.
538 #[allow(clippy::too_many_arguments)]
539 fn generate_edit_site(
540 site_name: Option<String>,
541 site_description: Option<String>,
542 site_sidebar: Option<String>,
543 site_listing_type: Option<ListingType>,
544 site_slur_filter_regex: Option<String>,
545 site_is_private: Option<bool>,
546 site_is_federated: Option<bool>,
547 site_application_question: Option<String>,
548 site_registration_mode: Option<RegistrationMode>,
552 sidebar: site_sidebar,
553 description: site_description,
556 enable_downvotes: None,
558 community_creation_admin_only: None,
559 require_email_verification: None,
560 application_question: site_application_question,
561 private_instance: site_is_private,
563 default_post_listing_type: site_listing_type,
564 legal_information: None,
565 application_email_admins: None,
566 hide_modlog_mod_names: None,
567 discussion_languages: None,
568 slur_filter_regex: site_slur_filter_regex,
569 actor_name_max_length: None,
570 rate_limit_message: None,
571 rate_limit_message_per_second: None,
572 rate_limit_post: None,
573 rate_limit_post_per_second: None,
574 rate_limit_register: None,
575 rate_limit_register_per_second: None,
576 rate_limit_image: None,
577 rate_limit_image_per_second: None,
578 rate_limit_comment: None,
579 rate_limit_comment_per_second: None,
580 rate_limit_search: None,
581 rate_limit_search_per_second: None,
582 federation_enabled: site_is_federated,
583 federation_debug: None,
584 captcha_enabled: None,
585 captcha_difficulty: None,
586 allowed_instances: None,
587 blocked_instances: None,
589 registration_mode: site_registration_mode,
590 reports_email_admins: None,
591 auth: Default::default(),