Chris@0
|
1 <?php
|
Chris@0
|
2
|
Chris@0
|
3 namespace Drupal\Tests\user\Functional;
|
Chris@0
|
4
|
Chris@18
|
5 use Drupal\Core\Url;
|
Chris@0
|
6 use Drupal\Component\Render\FormattableMarkup;
|
Chris@0
|
7 use Drupal\Core\Render\BubbleableMetadata;
|
Chris@0
|
8 use Drupal\language\Entity\ConfigurableLanguage;
|
Chris@0
|
9 use Drupal\Tests\BrowserTestBase;
|
Chris@0
|
10 use Drupal\user\Entity\User;
|
Chris@0
|
11
|
Chris@0
|
12 /**
|
Chris@0
|
13 * Generates text using placeholders for dummy content to check user token
|
Chris@0
|
14 * replacement.
|
Chris@0
|
15 *
|
Chris@0
|
16 * @group user
|
Chris@0
|
17 */
|
Chris@0
|
18 class UserTokenReplaceTest extends BrowserTestBase {
|
Chris@0
|
19
|
Chris@0
|
20 /**
|
Chris@0
|
21 * Modules to enable.
|
Chris@0
|
22 *
|
Chris@0
|
23 * @var array
|
Chris@0
|
24 */
|
Chris@0
|
25 public static $modules = ['language', 'user_hooks_test'];
|
Chris@0
|
26
|
Chris@0
|
27 /**
|
Chris@0
|
28 * {@inheritdoc}
|
Chris@0
|
29 */
|
Chris@0
|
30 protected function setUp() {
|
Chris@0
|
31 parent::setUp();
|
Chris@0
|
32 ConfigurableLanguage::createFromLangcode('de')->save();
|
Chris@0
|
33 }
|
Chris@0
|
34
|
Chris@0
|
35 /**
|
Chris@0
|
36 * Creates a user, then tests the tokens generated from it.
|
Chris@0
|
37 */
|
Chris@0
|
38 public function testUserTokenReplacement() {
|
Chris@0
|
39 $token_service = \Drupal::token();
|
Chris@0
|
40 $language_interface = \Drupal::languageManager()->getCurrentLanguage();
|
Chris@0
|
41 $url_options = [
|
Chris@0
|
42 'absolute' => TRUE,
|
Chris@0
|
43 'language' => $language_interface,
|
Chris@0
|
44 ];
|
Chris@0
|
45
|
Chris@0
|
46 \Drupal::state()->set('user_hooks_test_user_format_name_alter', TRUE);
|
Chris@0
|
47 \Drupal::state()->set('user_hooks_test_user_format_name_alter_safe', TRUE);
|
Chris@0
|
48
|
Chris@0
|
49 // Create two users and log them in one after another.
|
Chris@0
|
50 $user1 = $this->drupalCreateUser([]);
|
Chris@0
|
51 $user2 = $this->drupalCreateUser([]);
|
Chris@0
|
52 $this->drupalLogin($user1);
|
Chris@0
|
53 $this->drupalLogout();
|
Chris@0
|
54 $this->drupalLogin($user2);
|
Chris@0
|
55
|
Chris@0
|
56 $account = User::load($user1->id());
|
Chris@0
|
57 $global_account = User::load(\Drupal::currentUser()->id());
|
Chris@0
|
58
|
Chris@18
|
59 /** @var \Drupal\Core\Datetime\DateFormatterInterface $date_formatter */
|
Chris@18
|
60 $date_formatter = $this->container->get('date.formatter');
|
Chris@18
|
61
|
Chris@0
|
62 // Generate and test tokens.
|
Chris@0
|
63 $tests = [];
|
Chris@0
|
64 $tests['[user:uid]'] = $account->id();
|
Chris@0
|
65 $tests['[user:name]'] = $account->getAccountName();
|
Chris@0
|
66 $tests['[user:account-name]'] = $account->getAccountName();
|
Chris@0
|
67 $tests['[user:display-name]'] = $account->getDisplayName();
|
Chris@0
|
68 $tests['[user:mail]'] = $account->getEmail();
|
Chris@18
|
69 $tests['[user:url]'] = $account->toUrl('canonical', $url_options)->toString();
|
Chris@18
|
70 $tests['[user:edit-url]'] = $account->toUrl('edit-form', $url_options)->toString();
|
Chris@18
|
71 $tests['[user:last-login]'] = $date_formatter->format($account->getLastLoginTime(), 'medium', '', NULL, $language_interface->getId());
|
Chris@18
|
72 $tests['[user:last-login:short]'] = $date_formatter->format($account->getLastLoginTime(), 'short', '', NULL, $language_interface->getId());
|
Chris@18
|
73 $tests['[user:created]'] = $date_formatter->format($account->getCreatedTime(), 'medium', '', NULL, $language_interface->getId());
|
Chris@18
|
74 $tests['[user:created:short]'] = $date_formatter->format($account->getCreatedTime(), 'short', '', NULL, $language_interface->getId());
|
Chris@0
|
75 $tests['[current-user:name]'] = $global_account->getAccountName();
|
Chris@0
|
76 $tests['[current-user:account-name]'] = $global_account->getAccountName();
|
Chris@0
|
77 $tests['[current-user:display-name]'] = $global_account->getDisplayName();
|
Chris@0
|
78
|
Chris@0
|
79 $base_bubbleable_metadata = BubbleableMetadata::createFromObject($account);
|
Chris@0
|
80 $metadata_tests = [];
|
Chris@0
|
81 $metadata_tests['[user:uid]'] = $base_bubbleable_metadata;
|
Chris@0
|
82 $metadata_tests['[user:name]'] = $base_bubbleable_metadata;
|
Chris@0
|
83 $metadata_tests['[user:account-name]'] = $base_bubbleable_metadata;
|
Chris@0
|
84 $metadata_tests['[user:display-name]'] = $base_bubbleable_metadata;
|
Chris@0
|
85 $metadata_tests['[user:mail]'] = $base_bubbleable_metadata;
|
Chris@0
|
86 $metadata_tests['[user:url]'] = $base_bubbleable_metadata;
|
Chris@0
|
87 $metadata_tests['[user:edit-url]'] = $base_bubbleable_metadata;
|
Chris@0
|
88 $bubbleable_metadata = clone $base_bubbleable_metadata;
|
Chris@0
|
89 // This test runs with the Language module enabled, which means config is
|
Chris@0
|
90 // overridden by LanguageConfigFactoryOverride (to provide translations of
|
Chris@0
|
91 // config). This causes the interface language cache context to be added for
|
Chris@0
|
92 // config entities. The four next tokens use DateFormat Config entities, and
|
Chris@0
|
93 // therefore have the interface language cache context.
|
Chris@0
|
94 $bubbleable_metadata->addCacheContexts(['languages:language_interface']);
|
Chris@0
|
95 $metadata_tests['[user:last-login]'] = $bubbleable_metadata->addCacheTags(['rendered']);
|
Chris@0
|
96 $metadata_tests['[user:last-login:short]'] = $bubbleable_metadata;
|
Chris@0
|
97 $metadata_tests['[user:created]'] = $bubbleable_metadata;
|
Chris@0
|
98 $metadata_tests['[user:created:short]'] = $bubbleable_metadata;
|
Chris@0
|
99 $metadata_tests['[current-user:name]'] = $base_bubbleable_metadata->merge(BubbleableMetadata::createFromObject($global_account)->addCacheContexts(['user']));
|
Chris@0
|
100 $metadata_tests['[current-user:account-name]'] = $base_bubbleable_metadata->merge(BubbleableMetadata::createFromObject($global_account)->addCacheContexts(['user']));
|
Chris@0
|
101 $metadata_tests['[current-user:display-name]'] = $base_bubbleable_metadata->merge(BubbleableMetadata::createFromObject($global_account)->addCacheContexts(['user']));
|
Chris@0
|
102
|
Chris@0
|
103 // Test to make sure that we generated something for each token.
|
Chris@0
|
104 $this->assertFalse(in_array(0, array_map('strlen', $tests)), 'No empty tokens generated.');
|
Chris@0
|
105
|
Chris@0
|
106 foreach ($tests as $input => $expected) {
|
Chris@0
|
107 $bubbleable_metadata = new BubbleableMetadata();
|
Chris@0
|
108 $output = $token_service->replace($input, ['user' => $account], ['langcode' => $language_interface->getId()], $bubbleable_metadata);
|
Chris@0
|
109 $this->assertEqual($output, $expected, new FormattableMarkup('User token %token replaced.', ['%token' => $input]));
|
Chris@0
|
110 $this->assertEqual($bubbleable_metadata, $metadata_tests[$input]);
|
Chris@0
|
111 }
|
Chris@0
|
112
|
Chris@0
|
113 // Generate tokens for the anonymous user.
|
Chris@0
|
114 $anonymous_user = User::load(0);
|
Chris@0
|
115 $tests = [];
|
Chris@0
|
116 $tests['[user:uid]'] = t('not yet assigned');
|
Chris@0
|
117 $tests['[user:display-name]'] = $anonymous_user->getDisplayName();
|
Chris@0
|
118
|
Chris@0
|
119 $base_bubbleable_metadata = BubbleableMetadata::createFromObject($anonymous_user);
|
Chris@0
|
120 $metadata_tests = [];
|
Chris@0
|
121 $metadata_tests['[user:uid]'] = $base_bubbleable_metadata;
|
Chris@0
|
122 $bubbleable_metadata = clone $base_bubbleable_metadata;
|
Chris@0
|
123 $bubbleable_metadata->addCacheableDependency(\Drupal::config('user.settings'));
|
Chris@0
|
124 $metadata_tests['[user:display-name]'] = $bubbleable_metadata;
|
Chris@0
|
125
|
Chris@0
|
126 foreach ($tests as $input => $expected) {
|
Chris@0
|
127 $bubbleable_metadata = new BubbleableMetadata();
|
Chris@0
|
128 $output = $token_service->replace($input, ['user' => $anonymous_user], ['langcode' => $language_interface->getId()], $bubbleable_metadata);
|
Chris@0
|
129 $this->assertEqual($output, $expected, format_string('Sanitized user token %token replaced.', ['%token' => $input]));
|
Chris@0
|
130 $this->assertEqual($bubbleable_metadata, $metadata_tests[$input]);
|
Chris@0
|
131 }
|
Chris@0
|
132
|
Chris@0
|
133 // Generate login and cancel link.
|
Chris@0
|
134 $tests = [];
|
Chris@0
|
135 $tests['[user:one-time-login-url]'] = user_pass_reset_url($account);
|
Chris@0
|
136 $tests['[user:cancel-url]'] = user_cancel_url($account);
|
Chris@0
|
137
|
Chris@0
|
138 // Generate tokens with interface language.
|
Chris@18
|
139 $link = Url::fromRoute('user.page', [], ['absolute' => TRUE])->toString();
|
Chris@0
|
140 foreach ($tests as $input => $expected) {
|
Chris@0
|
141 $output = $token_service->replace($input, ['user' => $account], ['langcode' => $language_interface->getId(), 'callback' => 'user_mail_tokens', 'clear' => TRUE]);
|
Chris@0
|
142 $this->assertTrue(strpos($output, $link) === 0, 'Generated URL is in interface language.');
|
Chris@0
|
143 }
|
Chris@0
|
144
|
Chris@0
|
145 // Generate tokens with the user's preferred language.
|
Chris@0
|
146 $account->preferred_langcode = 'de';
|
Chris@0
|
147 $account->save();
|
Chris@18
|
148 $link = Url::fromRoute('user.page', [], ['language' => \Drupal::languageManager()->getLanguage($account->getPreferredLangcode()), 'absolute' => TRUE])->toString();
|
Chris@0
|
149 foreach ($tests as $input => $expected) {
|
Chris@0
|
150 $output = $token_service->replace($input, ['user' => $account], ['callback' => 'user_mail_tokens', 'clear' => TRUE]);
|
Chris@0
|
151 $this->assertTrue(strpos($output, $link) === 0, "Generated URL is in the user's preferred language.");
|
Chris@0
|
152 }
|
Chris@0
|
153
|
Chris@0
|
154 // Generate tokens with one specific language.
|
Chris@18
|
155 $link = Url::fromRoute('user.page', [], ['language' => \Drupal::languageManager()->getLanguage('de'), 'absolute' => TRUE])->toString();
|
Chris@0
|
156 foreach ($tests as $input => $expected) {
|
Chris@0
|
157 foreach ([$user1, $user2] as $account) {
|
Chris@0
|
158 $output = $token_service->replace($input, ['user' => $account], ['langcode' => 'de', 'callback' => 'user_mail_tokens', 'clear' => TRUE]);
|
Chris@0
|
159 $this->assertTrue(strpos($output, $link) === 0, "Generated URL in the requested language.");
|
Chris@0
|
160 }
|
Chris@0
|
161 }
|
Chris@0
|
162
|
Chris@0
|
163 // Generate user display name tokens when safe markup is returned.
|
Chris@0
|
164 // @see user_hooks_test_user_format_name_alter()
|
Chris@0
|
165 \Drupal::state()->set('user_hooks_test_user_format_name_alter_safe', TRUE);
|
Chris@0
|
166 $input = '[user:display-name] [current-user:display-name]';
|
Chris@0
|
167 $expected = "<em>{$user1->id()}</em> <em>{$user2->id()}</em>";
|
Chris@0
|
168 $output = $token_service->replace($input, ['user' => $user1]);
|
Chris@0
|
169 $this->assertEqual($output, $expected, new FormattableMarkup('User token %token does not escape safe markup.', ['%token' => 'display-name']));
|
Chris@0
|
170 }
|
Chris@0
|
171
|
Chris@0
|
172 }
|