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