| 1 | <?php |
| 2 | /**site_has_non_default_locale |
| 3 | * Test cases for the `wp_send_user_request()` function. |
| 4 | * |
| 5 | * @package WordPress |
| 6 | * @since 4.9.9 |
| 7 | */ |
| 8 | |
| 9 | /** |
| 10 | * Tests_User_WpSendUserRequest class. |
| 11 | * |
| 12 | * @since 4.9.9 |
| 13 | * |
| 14 | * @group privacy |
| 15 | * @group user |
| 16 | * @covers wp_send_user_request |
| 17 | */ |
| 18 | class Tests_User_WpSendUserRequest extends WP_UnitTestCase { |
| 19 | |
| 20 | /** |
| 21 | * Test administrator user. |
| 22 | * |
| 23 | * @since 4.9.9 |
| 24 | * |
| 25 | * @var WP_User $admin_user |
| 26 | */ |
| 27 | protected static $admin_user; |
| 28 | |
| 29 | /** |
| 30 | * Test subscriber user. |
| 31 | * |
| 32 | * @since 4.9.9 |
| 33 | * |
| 34 | * @var WP_User $test_user |
| 35 | */ |
| 36 | protected static $test_user; |
| 37 | |
| 38 | /** |
| 39 | * Create users for tests. |
| 40 | * |
| 41 | * @since 4.9.9 |
| 42 | * |
| 43 | * @param WP_UnitTest_Factory $factory Test fixture factory. |
| 44 | */ |
| 45 | public static function wpSetUpBeforeClass( $factory ) { |
| 46 | self::$admin_user = $factory->user->create_and_get( |
| 47 | array( |
| 48 | 'user_email' => 'admin@local.dev', |
| 49 | 'role' => 'administrator', |
| 50 | ) |
| 51 | ); |
| 52 | |
| 53 | self::$test_user = $factory->user->create_and_get( |
| 54 | array( |
| 55 | 'user_email' => 'export-user@local.dev', |
| 56 | 'role' => 'subscriber', |
| 57 | ) |
| 58 | ); |
| 59 | } |
| 60 | |
| 61 | /** |
| 62 | * Reset the mocked phpmailer instance before each test method. |
| 63 | * |
| 64 | * @since 4.9.9 |
| 65 | */ |
| 66 | public function setUp() { |
| 67 | parent::setUp(); |
| 68 | |
| 69 | set_current_screen( 'dashboard' ); |
| 70 | reset_phpmailer_instance(); |
| 71 | } |
| 72 | |
| 73 | /** |
| 74 | * Reset the mocked phpmailer instance after each test method. |
| 75 | * |
| 76 | * @since 4.9.9 |
| 77 | */ |
| 78 | public function tearDown() { |
| 79 | delete_option( 'WPLANG' ); |
| 80 | reset_phpmailer_instance(); |
| 81 | |
| 82 | unset( $GLOBALS['locale'] ); |
| 83 | unset( $GLOBALS['current_screen'] ); |
| 84 | unset( $GLOBALS['taxnow'] ); |
| 85 | unset( $GLOBALS['typenow'] ); |
| 86 | |
| 87 | restore_previous_locale(); |
| 88 | parent::tearDown(); |
| 89 | } |
| 90 | |
| 91 | /** |
| 92 | * The function should error when the request ID is invalid. |
| 93 | * |
| 94 | * @ticket 43985 |
| 95 | */ |
| 96 | public function test_should_error_when_invalid_request_id() { |
| 97 | $result = wp_send_user_request( null ); |
| 98 | |
| 99 | $this->assertWPError( $result ); |
| 100 | $this->assertSame( 'invalid_request', $result->get_error_code() ); |
| 101 | } |
| 102 | |
| 103 | /** |
| 104 | * The function should send a user request export email when the requester is a registered user. |
| 105 | * |
| 106 | * @ticket 43985 |
| 107 | */ |
| 108 | public function test_should_send_user_request_export_email_when_requester_registered_user() { |
| 109 | $request_id = wp_create_user_request( self::$test_user->user_email, 'export_personal_data' ); |
| 110 | |
| 111 | $result = wp_send_user_request( $request_id ); |
| 112 | $mailer = tests_retrieve_phpmailer_instance(); |
| 113 | |
| 114 | $this->assertTrue( $result ); |
| 115 | $this->assertSame( self::$test_user->user_email, $mailer->get_recipient( 'to' )->address ); |
| 116 | $this->assertContains( 'Confirm Action: Export Personal Data', $mailer->get_sent()->subject ); |
| 117 | $this->assertContains( 'action=confirmaction&request_id=', $mailer->get_sent()->body ); |
| 118 | $this->assertContains( 'Export Personal Data', $mailer->get_sent()->body ); |
| 119 | } |
| 120 | |
| 121 | /** |
| 122 | * The function should send a user request erase email when the requester is a registered user. |
| 123 | * |
| 124 | * @ticket 43985 |
| 125 | */ |
| 126 | public function test_should_send_user_request_erase_email_when_requester_registered_user() { |
| 127 | $request_id = wp_create_user_request( self::$test_user->user_email, 'remove_personal_data' ); |
| 128 | |
| 129 | $result = wp_send_user_request( $request_id ); |
| 130 | $mailer = tests_retrieve_phpmailer_instance(); |
| 131 | |
| 132 | $this->assertTrue( $result ); |
| 133 | $this->assertSame( self::$test_user->user_email, $mailer->get_recipient( 'to' )->address ); |
| 134 | $this->assertContains( 'Confirm Action: Erase Personal Data', $mailer->get_sent()->subject ); |
| 135 | $this->assertContains( 'action=confirmaction&request_id=', $mailer->get_sent()->body ); |
| 136 | $this->assertContains( 'Erase Personal Data', $mailer->get_sent()->body ); |
| 137 | } |
| 138 | |
| 139 | /** |
| 140 | * The function should send a user request export email when the requester is an un-registered user. |
| 141 | * |
| 142 | * @ticket 43985 |
| 143 | */ |
| 144 | public function test_should_send_user_request_export_email_when_user_not_registered() { |
| 145 | $request_id = wp_create_user_request( self::$test_user->user_email, 'export_personal_data' ); |
| 146 | |
| 147 | $result = wp_send_user_request( $request_id ); |
| 148 | $mailer = tests_retrieve_phpmailer_instance(); |
| 149 | |
| 150 | $this->assertTrue( $result ); |
| 151 | $this->assertSame( self::$test_user->user_email, $mailer->get_recipient( 'to' )->address ); |
| 152 | $this->assertContains( 'Confirm Action: Export Personal Data', $mailer->get_sent()->subject ); |
| 153 | $this->assertContains( 'action=confirmaction&request_id=', $mailer->get_sent()->body ); |
| 154 | $this->assertContains( 'Export Personal Data', $mailer->get_sent()->body ); |
| 155 | } |
| 156 | |
| 157 | /** |
| 158 | * The function should send a user request erase email when the requester is an un-registered user. |
| 159 | * |
| 160 | * @ticket 43985 |
| 161 | */ |
| 162 | public function test_should_send_user_request_erase_email_when_user_not_registered() { |
| 163 | $request_id = wp_create_user_request( self::$test_user->user_email, 'remove_personal_data' ); |
| 164 | |
| 165 | $result = wp_send_user_request( $request_id ); |
| 166 | $mailer = tests_retrieve_phpmailer_instance(); |
| 167 | |
| 168 | $this->assertTrue( $result ); |
| 169 | $this->assertSame( self::$test_user->user_email, $mailer->get_recipient( 'to' )->address ); |
| 170 | $this->assertContains( 'Confirm Action: Erase Personal Data', $mailer->get_sent()->subject ); |
| 171 | $this->assertContains( 'action=confirmaction&request_id=', $mailer->get_sent()->body ); |
| 172 | $this->assertContains( 'Erase Personal Data', $mailer->get_sent()->body ); |
| 173 | } |
| 174 | |
| 175 | /** |
| 176 | * The email subject should be filterable. |
| 177 | * |
| 178 | * @ticket 43985 |
| 179 | */ |
| 180 | public function test_email_subject_should_be_filterable() { |
| 181 | $request_id = wp_create_user_request( self::$test_user->user_email, 'remove_personal_data' ); |
| 182 | |
| 183 | add_filter( 'user_request_action_email_subject', array( $this, 'modify_email_subject' ) ); |
| 184 | $result = wp_send_user_request( $request_id ); |
| 185 | $mailer = tests_retrieve_phpmailer_instance(); |
| 186 | |
| 187 | $this->assertTrue( $result ); |
| 188 | $this->assertSame( 'Custom Email Subject', $mailer->get_sent()->subject ); |
| 189 | } |
| 190 | |
| 191 | /** |
| 192 | * Filter callback to modify the subject of the email sent when an account action is attempted. |
| 193 | * |
| 194 | * @since 4.9.9 |
| 195 | * |
| 196 | * @param string $subject The email subject. |
| 197 | * @return string Filtered email subject. |
| 198 | */ |
| 199 | public function modify_email_subject( $subject ) { |
| 200 | return 'Custom Email Subject'; |
| 201 | } |
| 202 | |
| 203 | /** |
| 204 | * The email content should be filterable. |
| 205 | * |
| 206 | * @ticket 43985 |
| 207 | */ |
| 208 | public function test_email_content_should_be_filterable() { |
| 209 | $request_id = wp_create_user_request( self::$test_user->user_email, 'remove_personal_data' ); |
| 210 | |
| 211 | add_filter( 'user_request_action_email_content', array( $this, 'modify_email_content' ), 10, 2 ); |
| 212 | $result = wp_send_user_request( $request_id ); |
| 213 | $mailer = tests_retrieve_phpmailer_instance(); |
| 214 | |
| 215 | $this->assertTrue( $result ); |
| 216 | $this->assertContains( 'Custom Email Content.', $mailer->get_sent()->body ); |
| 217 | } |
| 218 | |
| 219 | /** |
| 220 | * Filter callback to modify the content of the email sent when an account action is attempted. |
| 221 | * |
| 222 | * @since 4.9.9 |
| 223 | * |
| 224 | * @param string $email_text Confirmation email text. |
| 225 | * @return string $email_text Filtered email text. |
| 226 | */ |
| 227 | public function modify_email_content( $email_text ) { |
| 228 | return 'Custom Email Content.'; |
| 229 | } |
| 230 | |
| 231 | /** |
| 232 | * The function should error when the email was not sent. |
| 233 | * |
| 234 | * @ticket 43985 |
| 235 | */ |
| 236 | public function test_return_wp_error_when_sending_fails() { |
| 237 | $request_id = wp_create_user_request( 'erase.request.from.unregistered.user@example.com', 'remove_personal_data' ); |
| 238 | |
| 239 | add_filter( 'wp_mail_from', '__return_empty_string' ); // Cause `wp_mail()` to return false. |
| 240 | $result = wp_send_user_request( $request_id ); |
| 241 | |
| 242 | $this->assertWPError( $result ); |
| 243 | $this->assertSame( 'privacy_email_error', $result->get_error_code() ); |
| 244 | } |
| 245 | |
| 246 | /** |
| 247 | * The function should respect the user locale settings when the site uses the default locale. |
| 248 | * |
| 249 | * @ticket 43985 |
| 250 | * @group l10n |
| 251 | */ |
| 252 | public function test_should_send_user_request_email_in_user_locale() { |
| 253 | update_user_meta( self::$test_user->ID, 'locale', 'es_ES' ); |
| 254 | |
| 255 | wp_set_current_user( self::$admin_user->ID ); |
| 256 | $request_id = wp_create_user_request( self::$test_user->user_email, 'export_personal_data' ); |
| 257 | |
| 258 | wp_send_user_request( $request_id ); |
| 259 | $mailer = tests_retrieve_phpmailer_instance(); |
| 260 | |
| 261 | $this->assertContains( 'Confirma la', $mailer->get_sent()->subject ); |
| 262 | } |
| 263 | |
| 264 | /** |
| 265 | * The function should respect the user locale settings when the site does not use en_US, the administrator |
| 266 | * uses the site's default locale, and the user has a different locale. |
| 267 | * |
| 268 | * @ticket 43985 |
| 269 | * @group l10n |
| 270 | */ |
| 271 | public function test_should_send_user_request_email_in_user_locale_when_site_is_not_en_us() { |
| 272 | update_option( 'WPLANG', 'es_ES' ); |
| 273 | switch_to_locale( 'es_ES' ); |
| 274 | |
| 275 | update_user_meta( self::$test_user->ID, 'locale', 'de_DE' ); |
| 276 | |
| 277 | wp_set_current_user( self::$admin_user->ID ); |
| 278 | $request_id = wp_create_user_request( self::$test_user->user_email, 'remove_personal_data' ); |
| 279 | |
| 280 | wp_send_user_request( $request_id ); |
| 281 | $mailer = tests_retrieve_phpmailer_instance(); |
| 282 | |
| 283 | $this->assertContains( 'Aktion bestätigen', $mailer->get_sent()->subject ); |
| 284 | } |
| 285 | |
| 286 | /** |
| 287 | * The function should respect the user locale settings when the site is not en_US, the administrator |
| 288 | * has a different selected locale, and the user uses the site's default locale. |
| 289 | * |
| 290 | * @ticket 43985 |
| 291 | * @group l10n |
| 292 | */ |
| 293 | public function test_should_send_user_request_email_in_user_locale_when_admin_and_site_have_different_locales() { |
| 294 | update_option( 'WPLANG', 'es_ES' ); |
| 295 | switch_to_locale( 'es_ES' ); |
| 296 | |
| 297 | update_user_meta( self::$admin_user->ID, 'locale', 'de_DE' ); |
| 298 | wp_set_current_user( self::$admin_user->ID ); |
| 299 | |
| 300 | $request_id = wp_create_user_request( self::$test_user->user_email, 'export_personal_data' ); |
| 301 | |
| 302 | wp_send_user_request( $request_id ); |
| 303 | $mailer = tests_retrieve_phpmailer_instance(); |
| 304 | |
| 305 | $this->assertContains( 'Confirma la', $mailer->get_sent()->subject ); |
| 306 | } |
| 307 | |
| 308 | /** |
| 309 | * The function should respect the user locale settings when the site is not en_US and both the |
| 310 | * administrator and the user use different locales. |
| 311 | * |
| 312 | * @ticket 43985 |
| 313 | * @group l10n |
| 314 | */ |
| 315 | public function test_should_send_user_request_email_in_user_locale_when_both_have_different_locales_than_site() { |
| 316 | update_option( 'WPLANG', 'es_ES' ); |
| 317 | switch_to_locale( 'es_ES' ); |
| 318 | |
| 319 | update_user_meta( self::$admin_user->ID, 'locale', 'de_DE' ); |
| 320 | update_user_meta( self::$test_user->ID, 'locale', 'en_US' ); |
| 321 | |
| 322 | wp_set_current_user( self::$admin_user->ID ); |
| 323 | |
| 324 | $request_id = wp_create_user_request( self::$test_user->user_email, 'export_personal_data' ); |
| 325 | |
| 326 | wp_send_user_request( $request_id ); |
| 327 | $mailer = tests_retrieve_phpmailer_instance(); |
| 328 | |
| 329 | $this->assertContains( 'Confirm Action', $mailer->get_sent()->subject ); |
| 330 | } |
| 331 | |
| 332 | /** |
| 333 | * The function should respect the site's locale when the request is for an unregistered user and the |
| 334 | * administrator does not use the site's locale. |
| 335 | * |
| 336 | * @ticket 43985 |
| 337 | * @group l10n |
| 338 | */ |
| 339 | public function test_should_send_user_request_email_in_site_locale() { |
| 340 | update_user_meta( self::$admin_user->ID, 'locale', 'es_ES' ); |
| 341 | wp_set_current_user( self::$admin_user->ID ); |
| 342 | |
| 343 | $request_id = wp_create_user_request( 'erase-user-not-registered@example.com', 'erase_personal_data' ); |
| 344 | |
| 345 | wp_send_user_request( $request_id ); |
| 346 | $mailer = tests_retrieve_phpmailer_instance(); |
| 347 | |
| 348 | $this->assertContains( 'Confirm Action', $mailer->get_sent()->subject ); |
| 349 | } |
| 350 | |
| 351 | /** |
| 352 | * The function should respect the site's locale when it is not en_US, the request is for an |
| 353 | * unregistered user, and the administrator does not use the site's default locale. |
| 354 | * |
| 355 | * @ticket 43985 |
| 356 | * @group l10n |
| 357 | */ |
| 358 | public function test_should_send_user_request_email_in_site_locale_when_not_en_us_and_admin_has_different_locale() { |
| 359 | update_option( 'WPLANG', 'es_ES' ); |
| 360 | switch_to_locale( 'es_ES' ); |
| 361 | |
| 362 | update_user_meta( self::$admin_user->ID, 'locale', 'de_DE' ); |
| 363 | wp_set_current_user( self::$admin_user->ID ); |
| 364 | |
| 365 | $request_id = wp_create_user_request( 'export-user-not-registered@example.com', 'erase_personal_data' ); |
| 366 | |
| 367 | wp_send_user_request( $request_id ); |
| 368 | $mailer = tests_retrieve_phpmailer_instance(); |
| 369 | |
| 370 | $this->assertContains( 'Confirma la', $mailer->get_sent()->subject ); |
| 371 | } |
| 372 | } |