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