crates/api_crud/src/site/create.rs

   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::{
   5   context::LemmyContext,
   6   site::{CreateSite, SiteResponse},
   7   utils::{
   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,
  10   },
  11 };
  12 use lemmy_db_schema::{
  13   newtypes::DbUrl,
  14   source::{
  15     local_site::{LocalSite, LocalSiteUpdateForm},
  16     local_site_rate_limit::{LocalSiteRateLimit, LocalSiteRateLimitUpdateForm},
  17     site::{Site, SiteUpdateForm},
  18     tagline::Tagline,
  19   },
  20   traits::Crud,
  21   utils::{diesel_option_overwrite, diesel_option_overwrite_to_url, naive_now},
  22 };
  23 use lemmy_db_views::structs::SiteView;
  24 use lemmy_utils::{
  25   error::{LemmyError, LemmyErrorType, LemmyResult},
  26   utils::{
  27     slurs::{check_slurs, check_slurs_opt},
  28     validation::{
  29       build_and_check_regex, check_site_visibility_valid, is_valid_body_field,
  30       site_description_length_check, site_name_length_check,
  31     },
  32   },
  33 };
  34 use url::Url;
  35
  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?;
  43
  44   // Make sure user is an admin; other types of users should not create site data...
  45   is_admin(&local_user_view)?;
  46
  47   validate_create_payload(&local_site, &data)?;
  48
  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);
  55
  56   let site_form = SiteUpdateForm {
  57     name: Some(name),
  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()),
  64     inbox_url,
  65     private_key: Some(Some(keypair.private_key)),
  66     public_key: Some(keypair.public_key),
  67     ..Default::default()
  68   };
  69
  70   let site_id = local_site.site_id;
  71
  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);
  76
  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,
  88     default_theme,
  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(),
  99     ..Default::default()
 100   };
 101
 102   LocalSite::update(&mut context.pool(), &local_site_form).await?;
 103
 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,
 117     ..Default::default()
 118   };
 119
 120   LocalSiteRateLimit::update(&mut context.pool(), &local_site_rate_limit_form).await?;
 121
 122   let site_view = SiteView::read_local(&mut context.pool()).await?;
 123
 124   let new_taglines = data.taglines.clone();
 125   let taglines = Tagline::replace(&mut context.pool(), local_site.id, new_taglines).await?;
 126
 127   let rate_limit_config =
 128     local_site_rate_limit_to_rate_limit_config(&site_view.local_site_rate_limit);
 129   context
 130     .settings_updated_channel()
 131     .send(rate_limit_config)
 132     .await?;
 133
 134   Ok(Json(SiteResponse {
 135     site_view,
 136     taglines,
 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     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_federated_downvotes: false,
 510       enable_nsfw: 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(),
 526       updated: None,
 527       registration_mode: site_registration_mode,
 528       reports_email_admins: false,
 529     }
 530   }
 531
 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(
 536     site_name: String,
 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>,
 545   ) -> CreateSite {
 546     CreateSite {
 547       name: site_name,
 548       sidebar: site_sidebar,
 549       description: site_description,
 550       icon: None,
 551       banner: None,
 552       enable_downvotes: None,
 553       enable_federated_downvotes: None,
 554       enable_nsfw: None,
 555       community_creation_admin_only: None,
 556       require_email_verification: None,
 557       application_question: site_application_question,
 558       private_instance: site_is_private,
 559       default_theme: None,
 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,
 585       taglines: None,
 586       registration_mode: site_registration_mode,
 587       auth: Default::default(),
 588     }
 589   }
 590 }