crates/api_crud/src/site/create.rs

   1 use crate::{
   2   site::{application_question_check, site_default_post_listing_type_check},
   3   PerformCrud,
   4 };
   5 use activitypub_federation::http_signatures::generate_actor_keypair;
   6 use actix_web::web::Data;
   7 use lemmy_api_common::{
   8   context::LemmyContext,
   9   site::{CreateSite, SiteResponse},
  10   utils::{
  11     generate_site_inbox_url,
  12     is_admin,
  13     local_site_rate_limit_to_rate_limit_config,
  14     local_user_view_from_jwt,
  15   },
  16 };
  17 use lemmy_db_schema::{
  18   newtypes::DbUrl,
  19   source::{
  20     local_site::{LocalSite, LocalSiteUpdateForm},
  21     local_site_rate_limit::{LocalSiteRateLimit, LocalSiteRateLimitUpdateForm},
  22     site::{Site, SiteUpdateForm},
  23     tagline::Tagline,
  24   },
  25   traits::Crud,
  26   utils::{diesel_option_overwrite, diesel_option_overwrite_to_url, naive_now},
  27 };
  28 use lemmy_db_views::structs::SiteView;
  29 use lemmy_utils::{
  30   error::{LemmyError, LemmyErrorType, LemmyResult},
  31   utils::{
  32     slurs::{check_slurs, check_slurs_opt},
  33     validation::{
  34       build_and_check_regex,
  35       check_site_visibility_valid,
  36       is_valid_body_field,
  37       site_description_length_check,
  38       site_name_length_check,
  39     },
  40   },
  41 };
  42 use url::Url;
  43
  44 #[async_trait::async_trait(?Send)]
  45 impl PerformCrud for CreateSite {
  46   type Response = SiteResponse;
  47
  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(&mut context.pool()).await?;
  53
  54     // Make sure user is an admin; other types of users should not create site data...
  55     is_admin(&local_user_view)?;
  56
  57     validate_create_payload(&local_site, data)?;
  58
  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()))
  70       .inbox_url(inbox_url)
  71       .private_key(Some(Some(keypair.private_key)))
  72       .public_key(Some(keypair.public_key))
  73       .build();
  74
  75     let site_id = local_site.site_id;
  76
  77     Site::update(&mut context.pool(), site_id, &site_form).await?;
  78
  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())
 100       .build();
 101
 102     LocalSite::update(&mut context.pool(), &local_site_form).await?;
 103
 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)
 117       .build();
 118
 119     LocalSiteRateLimit::update(&mut context.pool(), &local_site_rate_limit_form).await?;
 120
 121     let site_view = SiteView::read_local(&mut context.pool()).await?;
 122
 123     let new_taglines = data.taglines.clone();
 124     let taglines = Tagline::replace(&mut context.pool(), local_site.id, new_taglines).await?;
 125
 126     let rate_limit_config =
 127       local_site_rate_limit_to_rate_limit_config(&site_view.local_site_rate_limit);
 128     context
 129       .settings_updated_channel()
 130       .send(rate_limit_config)
 131       .await?;
 132
 133     Ok(SiteResponse {
 134       site_view,
 135       taglines,
 136     })
 137   }
 138 }
 139
 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(LemmyErrorType::SiteAlreadyExists)?;
 144   };
 145
 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(
 149     &create_site
 150       .slur_filter_regex
 151       .as_deref()
 152       .or(local_site.slur_filter_regex.as_deref()),
 153   )?;
 154
 155   site_name_length_check(&create_site.name)?;
 156   check_slurs(&create_site.name, &slur_regex)?;
 157
 158   if let Some(desc) = &create_site.description {
 159     site_description_length_check(desc)?;
 160     check_slurs_opt(&create_site.description, &slur_regex)?;
 161   }
 162
 163   site_default_post_listing_type_check(&create_site.default_post_listing_type)?;
 164
 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,
 170   )?;
 171
 172   // Ensure that the sidebar has fewer than the max num characters...
 173   is_valid_body_field(&create_site.sidebar, false)?;
 174
 175   application_question_check(
 176     &local_site.application_question,
 177     &create_site.application_question,
 178     create_site
 179       .registration_mode
 180       .unwrap_or(local_site.registration_mode),
 181   )
 182 }
 183
 184 #[cfg(test)]
 185 mod tests {
 186   #![allow(clippy::unwrap_used)]
 187   #![allow(clippy::indexing_slicing)]
 188
 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;
 193
 194   #[test]
 195   fn test_validate_invalid_create_payload() {
 196     let invalid_payloads = [
 197       (
 198         "CreateSite attempted on set up LocalSite",
 199         LemmyErrorType::SiteAlreadyExists,
 200         &generate_local_site(
 201           true,
 202           None::<String>,
 203           true,
 204           false,
 205           None::<String>,
 206           RegistrationMode::Open,
 207         ),
 208         &generate_create_site(
 209           String::from("site_name"),
 210           None::<String>,
 211           None::<String>,
 212           None::<ListingType>,
 213           None::<String>,
 214           None::<bool>,
 215           None::<bool>,
 216           None::<String>,
 217           None::<RegistrationMode>,
 218         ),
 219       ),
 220       (
 221         "CreateSite name matches LocalSite slur filter",
 222         LemmyErrorType::Slurs,
 223         &generate_local_site(
 224           false,
 225           Some(String::from("(foo|bar)")),
 226           true,
 227           false,
 228           None::<String>,
 229           RegistrationMode::Open,
 230         ),
 231         &generate_create_site(
 232           String::from("foo site_name"),
 233           None::<String>,
 234           None::<String>,
 235           None::<ListingType>,
 236           None::<String>,
 237           None::<bool>,
 238           None::<bool>,
 239           None::<String>,
 240           None::<RegistrationMode>,
 241         ),
 242       ),
 243       (
 244         "CreateSite name matches new slur filter",
 245         LemmyErrorType::Slurs,
 246         &generate_local_site(
 247           false,
 248           Some(String::from("(foo|bar)")),
 249           true,
 250           false,
 251           None::<String>,
 252           RegistrationMode::Open,
 253         ),
 254         &generate_create_site(
 255           String::from("zeta site_name"),
 256           None::<String>,
 257           None::<String>,
 258           None::<ListingType>,
 259           Some(String::from("(zeta|alpha)")),
 260           None::<bool>,
 261           None::<bool>,
 262           None::<String>,
 263           None::<RegistrationMode>,
 264         ),
 265       ),
 266       (
 267         "CreateSite listing type is Subscribed, which is invalid",
 268         LemmyErrorType::InvalidDefaultPostListingType,
 269         &generate_local_site(
 270           false,
 271           None::<String>,
 272           true,
 273           false,
 274           None::<String>,
 275           RegistrationMode::Open,
 276         ),
 277         &generate_create_site(
 278           String::from("site_name"),
 279           None::<String>,
 280           None::<String>,
 281           Some(ListingType::Subscribed),
 282           None::<String>,
 283           None::<bool>,
 284           None::<bool>,
 285           None::<String>,
 286           None::<RegistrationMode>,
 287         ),
 288       ),
 289       (
 290         "CreateSite is both private and federated",
 291         LemmyErrorType::CantEnablePrivateInstanceAndFederationTogether,
 292         &generate_local_site(
 293           false,
 294           None::<String>,
 295           true,
 296           false,
 297           None::<String>,
 298           RegistrationMode::Open,
 299         ),
 300         &generate_create_site(
 301           String::from("site_name"),
 302           None::<String>,
 303           None::<String>,
 304           None::<ListingType>,
 305           None::<String>,
 306           Some(true),
 307           Some(true),
 308           None::<String>,
 309           None::<RegistrationMode>,
 310         ),
 311       ),
 312       (
 313         "LocalSite is private, but CreateSite also makes it federated",
 314         LemmyErrorType::CantEnablePrivateInstanceAndFederationTogether,
 315         &generate_local_site(
 316           false,
 317           None::<String>,
 318           true,
 319           false,
 320           None::<String>,
 321           RegistrationMode::Open,
 322         ),
 323         &generate_create_site(
 324           String::from("site_name"),
 325           None::<String>,
 326           None::<String>,
 327           None::<ListingType>,
 328           None::<String>,
 329           None::<bool>,
 330           Some(true),
 331           None::<String>,
 332           None::<RegistrationMode>,
 333         ),
 334       ),
 335       (
 336         "CreateSite requires application, but neither it nor LocalSite has an application question",
 337         LemmyErrorType::ApplicationQuestionRequired,
 338         &generate_local_site(
 339           false,
 340           None::<String>,
 341           true,
 342           false,
 343           None::<String>,
 344           RegistrationMode::Open,
 345         ),
 346         &generate_create_site(
 347           String::from("site_name"),
 348           None::<String>,
 349           None::<String>,
 350           None::<ListingType>,
 351           None::<String>,
 352           None::<bool>,
 353           None::<bool>,
 354           None::<String>,
 355           Some(RegistrationMode::RequireApplication),
 356         ),
 357       ),
 358     ];
 359
 360     invalid_payloads.iter().enumerate().for_each(
 361       |(
 362          idx,
 363          &(reason, ref expected_err, local_site, create_site),
 364        )| {
 365         match validate_create_payload(
 366           local_site,
 367           create_site,
 368         ) {
 369           Ok(_) => {
 370             panic!(
 371               "Got Ok, but validation should have failed with error: {} for reason: {}. invalid_payloads.nth({})",
 372               expected_err, reason, idx
 373             )
 374           }
 375           Err(error) => {
 376             assert!(
 377               error.error_type.eq(&expected_err.clone()),
 378               "Got Err {:?}, but should have failed with message: {} for reason: {}. invalid_payloads.nth({})",
 379               error.error_type,
 380               expected_err,
 381               reason,
 382               idx
 383             )
 384           }
 385         }
 386       },
 387     );
 388   }
 389
 390   #[test]
 391   fn test_validate_valid_create_payload() {
 392     let valid_payloads = [
 393       (
 394         "No changes between LocalSite and CreateSite",
 395         &generate_local_site(
 396           false,
 397           None::<String>,
 398           true,
 399           false,
 400           None::<String>,
 401           RegistrationMode::Open,
 402         ),
 403         &generate_create_site(
 404           String::from("site_name"),
 405           None::<String>,
 406           None::<String>,
 407           None::<ListingType>,
 408           None::<String>,
 409           None::<bool>,
 410           None::<bool>,
 411           None::<String>,
 412           None::<RegistrationMode>,
 413         ),
 414       ),
 415       (
 416         "CreateSite allows clearing and changing values",
 417         &generate_local_site(
 418           false,
 419           None::<String>,
 420           true,
 421           false,
 422           None::<String>,
 423           RegistrationMode::Open,
 424         ),
 425         &generate_create_site(
 426           String::from("site_name"),
 427           Some(String::new()),
 428           Some(String::new()),
 429           Some(ListingType::All),
 430           Some(String::new()),
 431           Some(false),
 432           Some(true),
 433           Some(String::new()),
 434           Some(RegistrationMode::Open),
 435         ),
 436       ),
 437       (
 438         "CreateSite clears existing slur filter regex",
 439         &generate_local_site(
 440           false,
 441           Some(String::from("(foo|bar)")),
 442           true,
 443           false,
 444           None::<String>,
 445           RegistrationMode::Open,
 446         ),
 447         &generate_create_site(
 448           String::from("foo site_name"),
 449           None::<String>,
 450           None::<String>,
 451           None::<ListingType>,
 452           Some(String::new()),
 453           None::<bool>,
 454           None::<bool>,
 455           None::<String>,
 456           None::<RegistrationMode>,
 457         ),
 458       ),
 459       (
 460         "LocalSite has application question and CreateSite now requires applications,",
 461         &generate_local_site(
 462           false,
 463           None::<String>,
 464           true,
 465           false,
 466           Some(String::from("question")),
 467           RegistrationMode::Open,
 468         ),
 469         &generate_create_site(
 470           String::from("site_name"),
 471           None::<String>,
 472           None::<String>,
 473           None::<ListingType>,
 474           None::<String>,
 475           None::<bool>,
 476           None::<bool>,
 477           None::<String>,
 478           Some(RegistrationMode::RequireApplication),
 479         ),
 480       ),
 481     ];
 482
 483     valid_payloads
 484       .iter()
 485       .enumerate()
 486       .for_each(|(idx, &(reason, local_site, edit_site))| {
 487         assert!(
 488           validate_create_payload(local_site, edit_site).is_ok(),
 489           "Got Err, but should have got Ok for reason: {}. valid_payloads.nth({})",
 490           reason,
 491           idx
 492         );
 493       })
 494   }
 495
 496   fn generate_local_site(
 497     site_setup: bool,
 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,
 503   ) -> LocalSite {
 504     LocalSite {
 505       id: Default::default(),
 506       site_id: Default::default(),
 507       site_setup,
 508       enable_downvotes: false,
 509       enable_nsfw: false,
 510       community_creation_admin_only: false,
 511       require_email_verification: false,
 512       application_question: site_application_question,
 513       private_instance: site_is_private,
 514       default_theme: String::new(),
 515       default_post_listing_type: ListingType::All,
 516       legal_information: None,
 517       hide_modlog_mod_names: false,
 518       application_email_admins: false,
 519       slur_filter_regex: site_slur_filter_regex,
 520       actor_name_max_length: 0,
 521       federation_enabled: site_is_federated,
 522       captcha_enabled: false,
 523       captcha_difficulty: String::new(),
 524       published: Default::default(),
 525       updated: None,
 526       registration_mode: site_registration_mode,
 527       reports_email_admins: false,
 528     }
 529   }
 530
 531   // Allow the test helper function to have too many arguments.
 532   // It's either this or generate the entire struct each time for testing.
 533   #[allow(clippy::too_many_arguments)]
 534   fn generate_create_site(
 535     site_name: String,
 536     site_description: Option<String>,
 537     site_sidebar: Option<String>,
 538     site_listing_type: Option<ListingType>,
 539     site_slur_filter_regex: Option<String>,
 540     site_is_private: Option<bool>,
 541     site_is_federated: Option<bool>,
 542     site_application_question: Option<String>,
 543     site_registration_mode: Option<RegistrationMode>,
 544   ) -> CreateSite {
 545     CreateSite {
 546       name: site_name,
 547       sidebar: site_sidebar,
 548       description: site_description,
 549       icon: None,
 550       banner: None,
 551       enable_downvotes: None,
 552       enable_nsfw: None,
 553       community_creation_admin_only: None,
 554       require_email_verification: None,
 555       application_question: site_application_question,
 556       private_instance: site_is_private,
 557       default_theme: None,
 558       default_post_listing_type: site_listing_type,
 559       legal_information: None,
 560       application_email_admins: None,
 561       hide_modlog_mod_names: None,
 562       discussion_languages: None,
 563       slur_filter_regex: site_slur_filter_regex,
 564       actor_name_max_length: None,
 565       rate_limit_message: None,
 566       rate_limit_message_per_second: None,
 567       rate_limit_post: None,
 568       rate_limit_post_per_second: None,
 569       rate_limit_register: None,
 570       rate_limit_register_per_second: None,
 571       rate_limit_image: None,
 572       rate_limit_image_per_second: None,
 573       rate_limit_comment: None,
 574       rate_limit_comment_per_second: None,
 575       rate_limit_search: None,
 576       rate_limit_search_per_second: None,
 577       federation_enabled: site_is_federated,
 578       federation_debug: None,
 579       captcha_enabled: None,
 580       captcha_difficulty: None,
 581       allowed_instances: None,
 582       blocked_instances: None,
 583       taglines: None,
 584       registration_mode: site_registration_mode,
 585       auth: Default::default(),
 586     }
 587   }
 588 }