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, 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(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(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(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(context.pool(), &local_site_rate_limit_form).await?;
 120
 121     let site_view = SiteView::read_local(context.pool()).await?;
 122
 123     let new_taglines = data.taglines.clone();
 124     let taglines = Tagline::replace(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(LemmyError::from_message("site_already_exists"));
 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   use crate::site::create::validate_create_payload;
 187   use lemmy_api_common::site::CreateSite;
 188   use lemmy_db_schema::{source::local_site::LocalSite, ListingType, RegistrationMode};
 189
 190   #[test]
 191   fn test_validate_invalid_create_payload() {
 192     let invalid_payloads = [
 193       (
 194         "CreateSite attempted on set up LocalSite",
 195         "site_already_exists",
 196         &generate_local_site(
 197           true,
 198           None::<String>,
 199           true,
 200           false,
 201           None::<String>,
 202           RegistrationMode::Open,
 203         ),
 204         &generate_create_site(
 205           String::from("site_name"),
 206           None::<String>,
 207           None::<String>,
 208           None::<ListingType>,
 209           None::<String>,
 210           None::<bool>,
 211           None::<bool>,
 212           None::<String>,
 213           None::<RegistrationMode>,
 214         ),
 215       ),
 216       (
 217         "CreateSite name matches LocalSite slur filter",
 218         "slurs",
 219         &generate_local_site(
 220           false,
 221           Some(String::from("(foo|bar)")),
 222           true,
 223           false,
 224           None::<String>,
 225           RegistrationMode::Open,
 226         ),
 227         &generate_create_site(
 228           String::from("foo site_name"),
 229           None::<String>,
 230           None::<String>,
 231           None::<ListingType>,
 232           None::<String>,
 233           None::<bool>,
 234           None::<bool>,
 235           None::<String>,
 236           None::<RegistrationMode>,
 237         ),
 238       ),
 239       (
 240         "CreateSite name matches new slur filter",
 241         "slurs",
 242         &generate_local_site(
 243           false,
 244           Some(String::from("(foo|bar)")),
 245           true,
 246           false,
 247           None::<String>,
 248           RegistrationMode::Open,
 249         ),
 250         &generate_create_site(
 251           String::from("zeta site_name"),
 252           None::<String>,
 253           None::<String>,
 254           None::<ListingType>,
 255           Some(String::from("(zeta|alpha)")),
 256           None::<bool>,
 257           None::<bool>,
 258           None::<String>,
 259           None::<RegistrationMode>,
 260         ),
 261       ),
 262       (
 263         "CreateSite listing type is Subscribed, which is invalid",
 264         "invalid_default_post_listing_type",
 265         &generate_local_site(
 266           false,
 267           None::<String>,
 268           true,
 269           false,
 270           None::<String>,
 271           RegistrationMode::Open,
 272         ),
 273         &generate_create_site(
 274           String::from("site_name"),
 275           None::<String>,
 276           None::<String>,
 277           Some(ListingType::Subscribed),
 278           None::<String>,
 279           None::<bool>,
 280           None::<bool>,
 281           None::<String>,
 282           None::<RegistrationMode>,
 283         ),
 284       ),
 285       (
 286         "CreateSite is both private and federated",
 287         "cant_enable_private_instance_and_federation_together",
 288         &generate_local_site(
 289           false,
 290           None::<String>,
 291           true,
 292           false,
 293           None::<String>,
 294           RegistrationMode::Open,
 295         ),
 296         &generate_create_site(
 297           String::from("site_name"),
 298           None::<String>,
 299           None::<String>,
 300           None::<ListingType>,
 301           None::<String>,
 302           Some(true),
 303           Some(true),
 304           None::<String>,
 305           None::<RegistrationMode>,
 306         ),
 307       ),
 308       (
 309         "LocalSite is private, but CreateSite also makes it federated",
 310         "cant_enable_private_instance_and_federation_together",
 311         &generate_local_site(
 312           false,
 313           None::<String>,
 314           true,
 315           false,
 316           None::<String>,
 317           RegistrationMode::Open,
 318         ),
 319         &generate_create_site(
 320           String::from("site_name"),
 321           None::<String>,
 322           None::<String>,
 323           None::<ListingType>,
 324           None::<String>,
 325           None::<bool>,
 326           Some(true),
 327           None::<String>,
 328           None::<RegistrationMode>,
 329         ),
 330       ),
 331       (
 332         "CreateSite requires application, but neither it nor LocalSite has an application question",
 333         "application_question_required",
 334         &generate_local_site(
 335           false,
 336           None::<String>,
 337           true,
 338           false,
 339           None::<String>,
 340           RegistrationMode::Open,
 341         ),
 342         &generate_create_site(
 343           String::from("site_name"),
 344           None::<String>,
 345           None::<String>,
 346           None::<ListingType>,
 347           None::<String>,
 348           None::<bool>,
 349           None::<bool>,
 350           None::<String>,
 351           Some(RegistrationMode::RequireApplication),
 352         ),
 353       ),
 354     ];
 355
 356     invalid_payloads.iter().enumerate().for_each(
 357       |(
 358          idx,
 359          &(reason, expected_err, local_site, create_site),
 360        )| {
 361         match validate_create_payload(
 362           local_site,
 363           create_site,
 364         ) {
 365           Ok(_) => {
 366             panic!(
 367               "Got Ok, but validation should have failed with error: {} for reason: {}. invalid_payloads.nth({})",
 368               expected_err, reason, idx
 369             )
 370           }
 371           Err(error) => {
 372             assert!(
 373               error.message.eq(&Some(String::from(expected_err))),
 374               "Got Err {:?}, but should have failed with message: {} for reason: {}. invalid_payloads.nth({})",
 375               error.message,
 376               expected_err,
 377               reason,
 378               idx
 379             )
 380           }
 381         }
 382       },
 383     );
 384   }
 385
 386   #[test]
 387   fn test_validate_valid_create_payload() {
 388     let valid_payloads = [
 389       (
 390         "No changes between LocalSite and CreateSite",
 391         &generate_local_site(
 392           false,
 393           None::<String>,
 394           true,
 395           false,
 396           None::<String>,
 397           RegistrationMode::Open,
 398         ),
 399         &generate_create_site(
 400           String::from("site_name"),
 401           None::<String>,
 402           None::<String>,
 403           None::<ListingType>,
 404           None::<String>,
 405           None::<bool>,
 406           None::<bool>,
 407           None::<String>,
 408           None::<RegistrationMode>,
 409         ),
 410       ),
 411       (
 412         "CreateSite allows clearing and changing values",
 413         &generate_local_site(
 414           false,
 415           None::<String>,
 416           true,
 417           false,
 418           None::<String>,
 419           RegistrationMode::Open,
 420         ),
 421         &generate_create_site(
 422           String::from("site_name"),
 423           Some(String::new()),
 424           Some(String::new()),
 425           Some(ListingType::All),
 426           Some(String::new()),
 427           Some(false),
 428           Some(true),
 429           Some(String::new()),
 430           Some(RegistrationMode::Open),
 431         ),
 432       ),
 433       (
 434         "CreateSite clears existing slur filter regex",
 435         &generate_local_site(
 436           false,
 437           Some(String::from("(foo|bar)")),
 438           true,
 439           false,
 440           None::<String>,
 441           RegistrationMode::Open,
 442         ),
 443         &generate_create_site(
 444           String::from("foo site_name"),
 445           None::<String>,
 446           None::<String>,
 447           None::<ListingType>,
 448           Some(String::new()),
 449           None::<bool>,
 450           None::<bool>,
 451           None::<String>,
 452           None::<RegistrationMode>,
 453         ),
 454       ),
 455       (
 456         "LocalSite has application question and CreateSite now requires applications,",
 457         &generate_local_site(
 458           false,
 459           None::<String>,
 460           true,
 461           false,
 462           Some(String::from("question")),
 463           RegistrationMode::Open,
 464         ),
 465         &generate_create_site(
 466           String::from("site_name"),
 467           None::<String>,
 468           None::<String>,
 469           None::<ListingType>,
 470           None::<String>,
 471           None::<bool>,
 472           None::<bool>,
 473           None::<String>,
 474           Some(RegistrationMode::RequireApplication),
 475         ),
 476       ),
 477     ];
 478
 479     valid_payloads
 480       .iter()
 481       .enumerate()
 482       .for_each(|(idx, &(reason, local_site, edit_site))| {
 483         assert!(
 484           validate_create_payload(local_site, edit_site).is_ok(),
 485           "Got Err, but should have got Ok for reason: {}. valid_payloads.nth({})",
 486           reason,
 487           idx
 488         );
 489       })
 490   }
 491
 492   fn generate_local_site(
 493     site_setup: bool,
 494     site_slur_filter_regex: Option<String>,
 495     site_is_private: bool,
 496     site_is_federated: bool,
 497     site_application_question: Option<String>,
 498     site_registration_mode: RegistrationMode,
 499   ) -> LocalSite {
 500     LocalSite {
 501       id: Default::default(),
 502       site_id: Default::default(),
 503       site_setup,
 504       enable_downvotes: false,
 505       enable_nsfw: false,
 506       community_creation_admin_only: false,
 507       require_email_verification: false,
 508       application_question: site_application_question,
 509       private_instance: site_is_private,
 510       default_theme: String::new(),
 511       default_post_listing_type: ListingType::All,
 512       legal_information: None,
 513       hide_modlog_mod_names: false,
 514       application_email_admins: false,
 515       slur_filter_regex: site_slur_filter_regex,
 516       actor_name_max_length: 0,
 517       federation_enabled: site_is_federated,
 518       captcha_enabled: false,
 519       captcha_difficulty: String::new(),
 520       published: Default::default(),
 521       updated: None,
 522       registration_mode: site_registration_mode,
 523       reports_email_admins: false,
 524     }
 525   }
 526
 527   // Allow the test helper function to have too many arguments.
 528   // It's either this or generate the entire struct each time for testing.
 529   #[allow(clippy::too_many_arguments)]
 530   fn generate_create_site(
 531     site_name: String,
 532     site_description: Option<String>,
 533     site_sidebar: Option<String>,
 534     site_listing_type: Option<ListingType>,
 535     site_slur_filter_regex: Option<String>,
 536     site_is_private: Option<bool>,
 537     site_is_federated: Option<bool>,
 538     site_application_question: Option<String>,
 539     site_registration_mode: Option<RegistrationMode>,
 540   ) -> CreateSite {
 541     CreateSite {
 542       name: site_name,
 543       sidebar: site_sidebar,
 544       description: site_description,
 545       icon: None,
 546       banner: None,
 547       enable_downvotes: None,
 548       enable_nsfw: None,
 549       community_creation_admin_only: None,
 550       require_email_verification: None,
 551       application_question: site_application_question,
 552       private_instance: site_is_private,
 553       default_theme: None,
 554       default_post_listing_type: site_listing_type,
 555       legal_information: None,
 556       application_email_admins: None,
 557       hide_modlog_mod_names: None,
 558       discussion_languages: None,
 559       slur_filter_regex: site_slur_filter_regex,
 560       actor_name_max_length: None,
 561       rate_limit_message: None,
 562       rate_limit_message_per_second: None,
 563       rate_limit_post: None,
 564       rate_limit_post_per_second: None,
 565       rate_limit_register: None,
 566       rate_limit_register_per_second: None,
 567       rate_limit_image: None,
 568       rate_limit_image_per_second: None,
 569       rate_limit_comment: None,
 570       rate_limit_comment_per_second: None,
 571       rate_limit_search: None,
 572       rate_limit_search_per_second: None,
 573       federation_enabled: site_is_federated,
 574       federation_debug: None,
 575       captcha_enabled: None,
 576       captcha_difficulty: None,
 577       allowed_instances: None,
 578       blocked_instances: None,
 579       taglines: None,
 580       registration_mode: site_registration_mode,
 581       auth: Default::default(),
 582     }
 583   }
 584 }