2 site::{application_question_check, site_default_post_listing_type_check},
5 use actix_web::web::Data;
6 use lemmy_api_common::{
8 site::{EditSite, SiteResponse},
9 utils::{is_admin, local_site_rate_limit_to_rate_limit_config, local_user_view_from_jwt},
11 use lemmy_db_schema::{
13 actor_language::SiteLanguage,
14 federation_allowlist::FederationAllowList,
15 federation_blocklist::FederationBlockList,
16 local_site::{LocalSite, LocalSiteUpdateForm},
17 local_site_rate_limit::{LocalSiteRateLimit, LocalSiteRateLimitUpdateForm},
18 local_user::LocalUser,
19 site::{Site, SiteUpdateForm},
23 utils::{diesel_option_overwrite, diesel_option_overwrite_to_url, naive_now},
26 use lemmy_db_views::structs::SiteView;
28 error::{LemmyError, LemmyErrorExt, LemmyErrorType, LemmyResult},
30 slurs::check_slurs_opt,
32 build_and_check_regex,
33 check_site_visibility_valid,
35 site_description_length_check,
36 site_name_length_check,
41 #[async_trait::async_trait(?Send)]
42 impl PerformCrud for EditSite {
43 type Response = SiteResponse;
45 #[tracing::instrument(skip(context))]
46 async fn perform(&self, context: &Data<LemmyContext>) -> Result<SiteResponse, LemmyError> {
47 let data: &EditSite = self;
48 let local_user_view = local_user_view_from_jwt(&data.auth, context).await?;
49 let site_view = SiteView::read_local(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(context.pool(), discussion_languages.clone(), &site).await?;
62 let site_form = SiteUpdateForm::builder()
63 .name(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 .updated(Some(Some(naive_now())))
71 Site::update(context.pool(), site.id, &site_form)
73 // Ignore errors for all these, so as to not throw errors if no update occurs
74 // Diesel will throw an error for empty update forms
77 let local_site_form = LocalSiteUpdateForm::builder()
78 .enable_downvotes(data.enable_downvotes)
79 .registration_mode(data.registration_mode)
80 .enable_nsfw(data.enable_nsfw)
81 .community_creation_admin_only(data.community_creation_admin_only)
82 .require_email_verification(data.require_email_verification)
83 .application_question(diesel_option_overwrite(&data.application_question))
84 .private_instance(data.private_instance)
85 .default_theme(data.default_theme.clone())
86 .default_post_listing_type(data.default_post_listing_type)
87 .legal_information(diesel_option_overwrite(&data.legal_information))
88 .application_email_admins(data.application_email_admins)
89 .hide_modlog_mod_names(data.hide_modlog_mod_names)
90 .updated(Some(Some(naive_now())))
91 .slur_filter_regex(diesel_option_overwrite(&data.slur_filter_regex))
92 .actor_name_max_length(data.actor_name_max_length)
93 .federation_enabled(data.federation_enabled)
94 .captcha_enabled(data.captcha_enabled)
95 .captcha_difficulty(data.captcha_difficulty.clone())
96 .reports_email_admins(data.reports_email_admins)
99 let update_local_site = LocalSite::update(context.pool(), &local_site_form)
103 let local_site_rate_limit_form = LocalSiteRateLimitUpdateForm::builder()
104 .message(data.rate_limit_message)
105 .message_per_second(data.rate_limit_message_per_second)
106 .post(data.rate_limit_post)
107 .post_per_second(data.rate_limit_post_per_second)
108 .register(data.rate_limit_register)
109 .register_per_second(data.rate_limit_register_per_second)
110 .image(data.rate_limit_image)
111 .image_per_second(data.rate_limit_image_per_second)
112 .comment(data.rate_limit_comment)
113 .comment_per_second(data.rate_limit_comment_per_second)
114 .search(data.rate_limit_search)
115 .search_per_second(data.rate_limit_search_per_second)
118 LocalSiteRateLimit::update(context.pool(), &local_site_rate_limit_form)
122 // Replace the blocked and allowed instances
123 let allowed = data.allowed_instances.clone();
124 FederationAllowList::replace(context.pool(), allowed).await?;
125 let blocked = data.blocked_instances.clone();
126 FederationBlockList::replace(context.pool(), blocked).await?;
128 // TODO can't think of a better way to do this.
129 // If the server suddenly requires email verification, or required applications, no old users
130 // will be able to log in. It really only wants this to be a requirement for NEW signups.
131 // So if it was set from false, to true, you need to update all current users columns to be verified.
133 let old_require_application =
134 local_site.registration_mode == RegistrationMode::RequireApplication;
135 let new_require_application = update_local_site
137 .map(|ols| ols.registration_mode == RegistrationMode::RequireApplication)
139 if !old_require_application && new_require_application {
140 LocalUser::set_all_users_registration_applications_accepted(context.pool())
142 .with_lemmy_type(LemmyErrorType::CouldntSetAllRegistrationsAccepted)?;
145 let new_require_email_verification = update_local_site
147 .map(|ols| ols.require_email_verification)
149 if !local_site.require_email_verification && new_require_email_verification {
150 LocalUser::set_all_users_email_verified(context.pool())
152 .with_lemmy_type(LemmyErrorType::CouldntSetAllEmailVerified)?;
155 let new_taglines = data.taglines.clone();
156 let taglines = Tagline::replace(context.pool(), local_site.id, new_taglines).await?;
158 let site_view = SiteView::read_local(context.pool()).await?;
160 let rate_limit_config =
161 local_site_rate_limit_to_rate_limit_config(&site_view.local_site_rate_limit);
163 .settings_updated_channel()
164 .send(rate_limit_config)
167 let res = SiteResponse {
176 fn validate_update_payload(local_site: &LocalSite, edit_site: &EditSite) -> LemmyResult<()> {
177 // Check that the slur regex compiles, and return the regex if valid...
178 // Prioritize using new slur regex from the request; if not provided, use the existing regex.
179 let slur_regex = build_and_check_regex(
183 .or(local_site.slur_filter_regex.as_deref()),
186 if let Some(name) = &edit_site.name {
187 // The name doesn't need to be updated, but if provided it cannot be blanked out...
188 site_name_length_check(name)?;
189 check_slurs_opt(&edit_site.name, &slur_regex)?;
192 if let Some(desc) = &edit_site.description {
193 site_description_length_check(desc)?;
194 check_slurs_opt(&edit_site.description, &slur_regex)?;
197 site_default_post_listing_type_check(&edit_site.default_post_listing_type)?;
199 check_site_visibility_valid(
200 local_site.private_instance,
201 local_site.federation_enabled,
202 &edit_site.private_instance,
203 &edit_site.federation_enabled,
206 // Ensure that the sidebar has fewer than the max num characters...
207 is_valid_body_field(&edit_site.sidebar, false)?;
209 application_question_check(
210 &local_site.application_question,
211 &edit_site.application_question,
214 .unwrap_or(local_site.registration_mode),
220 use crate::site::update::validate_update_payload;
221 use lemmy_api_common::site::EditSite;
222 use lemmy_db_schema::{source::local_site::LocalSite, ListingType, RegistrationMode};
223 use lemmy_utils::error::LemmyErrorType;
226 fn test_validate_invalid_update_payload() {
227 let invalid_payloads = [
229 "EditSite name matches LocalSite slur filter",
230 LemmyErrorType::Slurs,
231 &generate_local_site(
232 Some(String::from("(foo|bar)")),
236 RegistrationMode::Open,
239 Some(String::from("foo site_name")),
247 None::<RegistrationMode>,
251 "EditSite name matches new slur filter",
252 LemmyErrorType::Slurs,
253 &generate_local_site(
254 Some(String::from("(foo|bar)")),
258 RegistrationMode::Open,
261 Some(String::from("zeta site_name")),
265 Some(String::from("(zeta|alpha)")),
269 None::<RegistrationMode>,
273 "EditSite listing type is Subscribed, which is invalid",
274 LemmyErrorType::InvalidDefaultPostListingType,
275 &generate_local_site(
280 RegistrationMode::Open,
283 Some(String::from("site_name")),
286 Some(ListingType::Subscribed),
291 None::<RegistrationMode>,
295 "EditSite is both private and federated",
296 LemmyErrorType::CantEnablePrivateInstanceAndFederationTogether,
297 &generate_local_site(
302 RegistrationMode::Open,
305 Some(String::from("site_name")),
313 None::<RegistrationMode>,
317 "LocalSite is private, but EditSite also makes it federated",
318 LemmyErrorType::CantEnablePrivateInstanceAndFederationTogether,
319 &generate_local_site(
324 RegistrationMode::Open,
327 Some(String::from("site_name")),
335 None::<RegistrationMode>,
339 "EditSite requires application, but neither it nor LocalSite has an application question",
340 LemmyErrorType::ApplicationQuestionRequired,
341 &generate_local_site(
346 RegistrationMode::Open,
349 Some(String::from("site_name")),
357 Some(RegistrationMode::RequireApplication),
362 invalid_payloads.iter().enumerate().for_each(
365 &(reason, ref expected_err, local_site, edit_site),
367 match validate_update_payload(local_site, edit_site) {
370 "Got Ok, but validation should have failed with error: {} for reason: {}. invalid_payloads.nth({})",
371 expected_err, reason, idx
376 error.error_type.eq(&expected_err.clone()),
377 "Got Err {:?}, but should have failed with message: {} for reason: {}. invalid_payloads.nth({})",
390 fn test_validate_valid_update_payload() {
391 let valid_payloads = [
393 "No changes between LocalSite and EditSite",
394 &generate_local_site(
399 RegistrationMode::Open,
410 None::<RegistrationMode>,
414 "EditSite allows clearing and changing values",
415 &generate_local_site(
420 RegistrationMode::Open,
423 Some(String::from("site_name")),
426 Some(ListingType::All),
431 Some(RegistrationMode::Open),
435 "EditSite name passes slur filter regex",
436 &generate_local_site(
437 Some(String::from("(foo|bar)")),
441 RegistrationMode::Open,
444 Some(String::from("foo site_name")),
452 None::<RegistrationMode>,
456 "LocalSite has application question and EditSite now requires applications,",
457 &generate_local_site(
461 Some(String::from("question")),
462 RegistrationMode::Open,
465 Some(String::from("site_name")),
473 Some(RegistrationMode::RequireApplication),
481 .for_each(|(idx, &(reason, local_site, edit_site))| {
483 validate_update_payload(local_site, edit_site).is_ok(),
484 "Got Err, but should have got Ok for reason: {}. valid_payloads.nth({})",
491 fn generate_local_site(
492 site_slur_filter_regex: Option<String>,
493 site_is_private: bool,
494 site_is_federated: bool,
495 site_application_question: Option<String>,
496 site_registration_mode: RegistrationMode,
499 id: Default::default(),
500 site_id: Default::default(),
502 enable_downvotes: false,
504 community_creation_admin_only: false,
505 require_email_verification: false,
506 application_question: site_application_question,
507 private_instance: site_is_private,
508 default_theme: String::new(),
509 default_post_listing_type: ListingType::All,
510 legal_information: None,
511 hide_modlog_mod_names: false,
512 application_email_admins: false,
513 slur_filter_regex: site_slur_filter_regex,
514 actor_name_max_length: 0,
515 federation_enabled: site_is_federated,
516 captcha_enabled: false,
517 captcha_difficulty: String::new(),
518 published: Default::default(),
520 registration_mode: site_registration_mode,
521 reports_email_admins: false,
525 // Allow the test helper function to have too many arguments.
526 // It's either this or generate the entire struct each time for testing.
527 #[allow(clippy::too_many_arguments)]
528 fn generate_edit_site(
529 site_name: Option<String>,
530 site_description: Option<String>,
531 site_sidebar: Option<String>,
532 site_listing_type: Option<ListingType>,
533 site_slur_filter_regex: Option<String>,
534 site_is_private: Option<bool>,
535 site_is_federated: Option<bool>,
536 site_application_question: Option<String>,
537 site_registration_mode: Option<RegistrationMode>,
541 sidebar: site_sidebar,
542 description: site_description,
545 enable_downvotes: None,
547 community_creation_admin_only: None,
548 require_email_verification: None,
549 application_question: site_application_question,
550 private_instance: site_is_private,
552 default_post_listing_type: site_listing_type,
553 legal_information: None,
554 application_email_admins: None,
555 hide_modlog_mod_names: None,
556 discussion_languages: None,
557 slur_filter_regex: site_slur_filter_regex,
558 actor_name_max_length: None,
559 rate_limit_message: None,
560 rate_limit_message_per_second: None,
561 rate_limit_post: None,
562 rate_limit_post_per_second: None,
563 rate_limit_register: None,
564 rate_limit_register_per_second: None,
565 rate_limit_image: None,
566 rate_limit_image_per_second: None,
567 rate_limit_comment: None,
568 rate_limit_comment_per_second: None,
569 rate_limit_search: None,
570 rate_limit_search_per_second: None,
571 federation_enabled: site_is_federated,
572 federation_debug: None,
573 captcha_enabled: None,
574 captcha_difficulty: None,
575 allowed_instances: None,
576 blocked_instances: None,
578 registration_mode: site_registration_mode,
579 reports_email_admins: None,
580 auth: Default::default(),