Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Tests\user\Functional;
Chris@0: 
Chris@18: use Drupal\Core\Url;
Chris@0: use Drupal\Component\Render\FormattableMarkup;
Chris@0: use Drupal\Core\Render\BubbleableMetadata;
Chris@0: use Drupal\language\Entity\ConfigurableLanguage;
Chris@0: use Drupal\Tests\BrowserTestBase;
Chris@0: use Drupal\user\Entity\User;
Chris@0: 
Chris@0: /**
Chris@0:  * Generates text using placeholders for dummy content to check user token
Chris@0:  * replacement.
Chris@0:  *
Chris@0:  * @group user
Chris@0:  */
Chris@0: class UserTokenReplaceTest extends BrowserTestBase {
Chris@0: 
Chris@0:   /**
Chris@0:    * Modules to enable.
Chris@0:    *
Chris@0:    * @var array
Chris@0:    */
Chris@0:   public static $modules = ['language', 'user_hooks_test'];
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   protected function setUp() {
Chris@0:     parent::setUp();
Chris@0:     ConfigurableLanguage::createFromLangcode('de')->save();
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Creates a user, then tests the tokens generated from it.
Chris@0:    */
Chris@0:   public function testUserTokenReplacement() {
Chris@0:     $token_service = \Drupal::token();
Chris@0:     $language_interface = \Drupal::languageManager()->getCurrentLanguage();
Chris@0:     $url_options = [
Chris@0:       'absolute' => TRUE,
Chris@0:       'language' => $language_interface,
Chris@0:     ];
Chris@0: 
Chris@0:     \Drupal::state()->set('user_hooks_test_user_format_name_alter', TRUE);
Chris@0:     \Drupal::state()->set('user_hooks_test_user_format_name_alter_safe', TRUE);
Chris@0: 
Chris@0:     // Create two users and log them in one after another.
Chris@0:     $user1 = $this->drupalCreateUser([]);
Chris@0:     $user2 = $this->drupalCreateUser([]);
Chris@0:     $this->drupalLogin($user1);
Chris@0:     $this->drupalLogout();
Chris@0:     $this->drupalLogin($user2);
Chris@0: 
Chris@0:     $account = User::load($user1->id());
Chris@0:     $global_account = User::load(\Drupal::currentUser()->id());
Chris@0: 
Chris@18:     /** @var \Drupal\Core\Datetime\DateFormatterInterface $date_formatter */
Chris@18:     $date_formatter = $this->container->get('date.formatter');
Chris@18: 
Chris@0:     // Generate and test tokens.
Chris@0:     $tests = [];
Chris@0:     $tests['[user:uid]'] = $account->id();
Chris@0:     $tests['[user:name]'] = $account->getAccountName();
Chris@0:     $tests['[user:account-name]'] = $account->getAccountName();
Chris@0:     $tests['[user:display-name]'] = $account->getDisplayName();
Chris@0:     $tests['[user:mail]'] = $account->getEmail();
Chris@18:     $tests['[user:url]'] = $account->toUrl('canonical', $url_options)->toString();
Chris@18:     $tests['[user:edit-url]'] = $account->toUrl('edit-form', $url_options)->toString();
Chris@18:     $tests['[user:last-login]'] = $date_formatter->format($account->getLastLoginTime(), 'medium', '', NULL, $language_interface->getId());
Chris@18:     $tests['[user:last-login:short]'] = $date_formatter->format($account->getLastLoginTime(), 'short', '', NULL, $language_interface->getId());
Chris@18:     $tests['[user:created]'] = $date_formatter->format($account->getCreatedTime(), 'medium', '', NULL, $language_interface->getId());
Chris@18:     $tests['[user:created:short]'] = $date_formatter->format($account->getCreatedTime(), 'short', '', NULL, $language_interface->getId());
Chris@0:     $tests['[current-user:name]'] = $global_account->getAccountName();
Chris@0:     $tests['[current-user:account-name]'] = $global_account->getAccountName();
Chris@0:     $tests['[current-user:display-name]'] = $global_account->getDisplayName();
Chris@0: 
Chris@0:     $base_bubbleable_metadata = BubbleableMetadata::createFromObject($account);
Chris@0:     $metadata_tests = [];
Chris@0:     $metadata_tests['[user:uid]'] = $base_bubbleable_metadata;
Chris@0:     $metadata_tests['[user:name]'] = $base_bubbleable_metadata;
Chris@0:     $metadata_tests['[user:account-name]'] = $base_bubbleable_metadata;
Chris@0:     $metadata_tests['[user:display-name]'] = $base_bubbleable_metadata;
Chris@0:     $metadata_tests['[user:mail]'] = $base_bubbleable_metadata;
Chris@0:     $metadata_tests['[user:url]'] = $base_bubbleable_metadata;
Chris@0:     $metadata_tests['[user:edit-url]'] = $base_bubbleable_metadata;
Chris@0:     $bubbleable_metadata = clone $base_bubbleable_metadata;
Chris@0:     // This test runs with the Language module enabled, which means config is
Chris@0:     // overridden by LanguageConfigFactoryOverride (to provide translations of
Chris@0:     // config). This causes the interface language cache context to be added for
Chris@0:     // config entities. The four next tokens use DateFormat Config entities, and
Chris@0:     // therefore have the interface language cache context.
Chris@0:     $bubbleable_metadata->addCacheContexts(['languages:language_interface']);
Chris@0:     $metadata_tests['[user:last-login]'] = $bubbleable_metadata->addCacheTags(['rendered']);
Chris@0:     $metadata_tests['[user:last-login:short]'] = $bubbleable_metadata;
Chris@0:     $metadata_tests['[user:created]'] = $bubbleable_metadata;
Chris@0:     $metadata_tests['[user:created:short]'] = $bubbleable_metadata;
Chris@0:     $metadata_tests['[current-user:name]'] = $base_bubbleable_metadata->merge(BubbleableMetadata::createFromObject($global_account)->addCacheContexts(['user']));
Chris@0:     $metadata_tests['[current-user:account-name]'] = $base_bubbleable_metadata->merge(BubbleableMetadata::createFromObject($global_account)->addCacheContexts(['user']));
Chris@0:     $metadata_tests['[current-user:display-name]'] = $base_bubbleable_metadata->merge(BubbleableMetadata::createFromObject($global_account)->addCacheContexts(['user']));
Chris@0: 
Chris@0:     // Test to make sure that we generated something for each token.
Chris@0:     $this->assertFalse(in_array(0, array_map('strlen', $tests)), 'No empty tokens generated.');
Chris@0: 
Chris@0:     foreach ($tests as $input => $expected) {
Chris@0:       $bubbleable_metadata = new BubbleableMetadata();
Chris@0:       $output = $token_service->replace($input, ['user' => $account], ['langcode' => $language_interface->getId()], $bubbleable_metadata);
Chris@0:       $this->assertEqual($output, $expected, new FormattableMarkup('User token %token replaced.', ['%token' => $input]));
Chris@0:       $this->assertEqual($bubbleable_metadata, $metadata_tests[$input]);
Chris@0:     }
Chris@0: 
Chris@0:     // Generate tokens for the anonymous user.
Chris@0:     $anonymous_user = User::load(0);
Chris@0:     $tests = [];
Chris@0:     $tests['[user:uid]'] = t('not yet assigned');
Chris@0:     $tests['[user:display-name]'] = $anonymous_user->getDisplayName();
Chris@0: 
Chris@0:     $base_bubbleable_metadata = BubbleableMetadata::createFromObject($anonymous_user);
Chris@0:     $metadata_tests = [];
Chris@0:     $metadata_tests['[user:uid]'] = $base_bubbleable_metadata;
Chris@0:     $bubbleable_metadata = clone $base_bubbleable_metadata;
Chris@0:     $bubbleable_metadata->addCacheableDependency(\Drupal::config('user.settings'));
Chris@0:     $metadata_tests['[user:display-name]'] = $bubbleable_metadata;
Chris@0: 
Chris@0:     foreach ($tests as $input => $expected) {
Chris@0:       $bubbleable_metadata = new BubbleableMetadata();
Chris@0:       $output = $token_service->replace($input, ['user' => $anonymous_user], ['langcode' => $language_interface->getId()], $bubbleable_metadata);
Chris@0:       $this->assertEqual($output, $expected, format_string('Sanitized user token %token replaced.', ['%token' => $input]));
Chris@0:       $this->assertEqual($bubbleable_metadata, $metadata_tests[$input]);
Chris@0:     }
Chris@0: 
Chris@0:     // Generate login and cancel link.
Chris@0:     $tests = [];
Chris@0:     $tests['[user:one-time-login-url]'] = user_pass_reset_url($account);
Chris@0:     $tests['[user:cancel-url]'] = user_cancel_url($account);
Chris@0: 
Chris@0:     // Generate tokens with interface language.
Chris@18:     $link = Url::fromRoute('user.page', [], ['absolute' => TRUE])->toString();
Chris@0:     foreach ($tests as $input => $expected) {
Chris@0:       $output = $token_service->replace($input, ['user' => $account], ['langcode' => $language_interface->getId(), 'callback' => 'user_mail_tokens', 'clear' => TRUE]);
Chris@0:       $this->assertTrue(strpos($output, $link) === 0, 'Generated URL is in interface language.');
Chris@0:     }
Chris@0: 
Chris@0:     // Generate tokens with the user's preferred language.
Chris@0:     $account->preferred_langcode = 'de';
Chris@0:     $account->save();
Chris@18:     $link = Url::fromRoute('user.page', [], ['language' => \Drupal::languageManager()->getLanguage($account->getPreferredLangcode()), 'absolute' => TRUE])->toString();
Chris@0:     foreach ($tests as $input => $expected) {
Chris@0:       $output = $token_service->replace($input, ['user' => $account], ['callback' => 'user_mail_tokens', 'clear' => TRUE]);
Chris@0:       $this->assertTrue(strpos($output, $link) === 0, "Generated URL is in the user's preferred language.");
Chris@0:     }
Chris@0: 
Chris@0:     // Generate tokens with one specific language.
Chris@18:     $link = Url::fromRoute('user.page', [], ['language' => \Drupal::languageManager()->getLanguage('de'), 'absolute' => TRUE])->toString();
Chris@0:     foreach ($tests as $input => $expected) {
Chris@0:       foreach ([$user1, $user2] as $account) {
Chris@0:         $output = $token_service->replace($input, ['user' => $account], ['langcode' => 'de', 'callback' => 'user_mail_tokens', 'clear' => TRUE]);
Chris@0:         $this->assertTrue(strpos($output, $link) === 0, "Generated URL in the requested language.");
Chris@0:       }
Chris@0:     }
Chris@0: 
Chris@0:     // Generate user display name tokens when safe markup is returned.
Chris@0:     // @see user_hooks_test_user_format_name_alter()
Chris@0:     \Drupal::state()->set('user_hooks_test_user_format_name_alter_safe', TRUE);
Chris@0:     $input = '[user:display-name] [current-user:display-name]';
Chris@0:     $expected = "<em>{$user1->id()}</em> <em>{$user2->id()}</em>";
Chris@0:     $output = $token_service->replace($input, ['user' => $user1]);
Chris@0:     $this->assertEqual($output, $expected, new FormattableMarkup('User token %token does not escape safe markup.', ['%token' => 'display-name']));
Chris@0:   }
Chris@0: 
Chris@0: }