Skip to content

Admin interface locale breaks "Expiration date" field #33033

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 16, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 39 additions & 20 deletions app/code/Magento/Security/Model/ResourceModel/UserExpiration.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,19 @@

namespace Magento\Security\Model\ResourceModel;

use Magento\Framework\App\ObjectManager;
use Magento\Framework\Exception\LocalizedException;
use Magento\Framework\Model\AbstractModel;
use Magento\Framework\Model\ResourceModel\Db\AbstractDb;
use Magento\Framework\Model\ResourceModel\Db\Context;
use Magento\Framework\Stdlib\DateTime\Timezone\LocalizedDateToUtcConverterInterface;
use Magento\Framework\Stdlib\DateTime\TimezoneInterface;
use Magento\Security\Model\UserExpiration as UserExpirationModel;

/**
* Admin User Expiration resource model
*/
class UserExpiration extends \Magento\Framework\Model\ResourceModel\Db\AbstractDb
class UserExpiration extends AbstractDb
{

/**
Expand All @@ -21,24 +30,31 @@ class UserExpiration extends \Magento\Framework\Model\ResourceModel\Db\AbstractD
protected $_isPkAutoIncrement = false;

/**
* @var \Magento\Framework\Stdlib\DateTime\TimezoneInterface
* @var TimezoneInterface
*/
private $timezone;

/**
* UserExpiration constructor.
*
* @param \Magento\Framework\Model\ResourceModel\Db\Context $context
* @param \Magento\Framework\Stdlib\DateTime\TimezoneInterface $timezone
* @param string $connectionName
* @var LocalizedDateToUtcConverterInterface
*/
private $localizedDateToUtcConverter;

/**
* @param Context $context
* @param TimezoneInterface $timezone
* @param string|null $connectionName
* @param LocalizedDateToUtcConverterInterface|null $localizedDateToUtcConverter
*/
public function __construct(
\Magento\Framework\Model\ResourceModel\Db\Context $context,
\Magento\Framework\Stdlib\DateTime\TimezoneInterface $timezone,
?string $connectionName = null
Context $context,
TimezoneInterface $timezone,
?string $connectionName = null,
?LocalizedDateToUtcConverterInterface $localizedDateToUtcConverter = null
) {
parent::__construct($context, $connectionName);
$this->timezone = $timezone;
$this->localizedDateToUtcConverter = $localizedDateToUtcConverter ?: ObjectManager::getInstance()
->get(LocalizedDateToUtcConverterInterface::class);
}

/**
Expand All @@ -54,15 +70,17 @@ protected function _construct()
/**
* Convert to UTC time.
*
* @param \Magento\Framework\Model\AbstractModel $userExpiration
* @param AbstractModel $userExpiration
* @return $this
* @throws \Magento\Framework\Exception\LocalizedException
* @throws LocalizedException
*/
protected function _beforeSave(\Magento\Framework\Model\AbstractModel $userExpiration)
protected function _beforeSave(AbstractModel $userExpiration)
{
/** @var $userExpiration \Magento\Security\Model\UserExpiration */
/** @var $userExpiration UserExpirationModel */
$expiresAt = $userExpiration->getExpiresAt();
$utcValue = $this->timezone->convertConfigTimeToUtc($expiresAt);
$utcValue = strtotime($expiresAt)
? $this->timezone->convertConfigTimeToUtc($expiresAt)
: $this->localizedDateToUtcConverter->convertLocalizedDateToUtc($expiresAt);
$userExpiration->setExpiresAt($utcValue);

return $this;
Expand All @@ -71,15 +89,16 @@ protected function _beforeSave(\Magento\Framework\Model\AbstractModel $userExpir
/**
* Convert to store time.
*
* @param \Magento\Framework\Model\AbstractModel $userExpiration
* @return $this|\Magento\Framework\Model\ResourceModel\Db\AbstractDb
* @param AbstractModel $userExpiration
* @return $this|AbstractDb
* @throws \Exception
*/
protected function _afterLoad(\Magento\Framework\Model\AbstractModel $userExpiration)
protected function _afterLoad(AbstractModel $userExpiration)
{
/** @var $userExpiration \Magento\Security\Model\UserExpiration */
/** @var $userExpiration UserExpirationModel */
if ($userExpiration->getExpiresAt()) {
$storeValue = $this->timezone->date($userExpiration->getExpiresAt());
$date = new \DateTime($userExpiration->getExpiresAt());
$storeValue = $this->timezone->date($date);
$userExpiration->setExpiresAt($storeValue->format('Y-m-d H:i:s'));
}

Expand Down
41 changes: 24 additions & 17 deletions app/code/Magento/Security/Model/UserExpiration/Validator.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@

namespace Magento\Security\Model\UserExpiration;

use Magento\Framework\App\ObjectManager;
use Magento\Framework\Stdlib\DateTime\DateTime;
use Magento\Framework\Stdlib\DateTime\Timezone\LocalizedDateToUtcConverterInterface;
use Magento\Framework\Stdlib\DateTime\TimezoneInterface;
use Magento\Framework\Validator\AbstractValidator;

Expand All @@ -16,25 +18,35 @@
*/
class Validator extends AbstractValidator
{

/**@var TimezoneInterface */
/**
* @var TimezoneInterface
*/
private $timezone;

/**@var DateTime */
/**
* @var DateTime
*/
private $dateTime;

/**
* Validator constructor.
*
* @var LocalizedDateToUtcConverterInterface
*/
private $localizedDateToUtcConverter;

/**
* @param TimezoneInterface $timezone
* @param DateTime $dateTime
* @param LocalizedDateToUtcConverterInterface|null $localizedDateToUtcConverter
*/
public function __construct(
TimezoneInterface $timezone,
DateTime $dateTime
DateTime $dateTime,
?LocalizedDateToUtcConverterInterface $localizedDateToUtcConverter = null
) {
$this->timezone = $timezone;
$this->dateTime = $dateTime;
$this->localizedDateToUtcConverter = $localizedDateToUtcConverter ?: ObjectManager::getInstance()
->get(LocalizedDateToUtcConverterInterface::class);
}

/**
Expand All @@ -48,18 +60,13 @@ public function isValid($value)
{
$this->_clearMessages();
$messages = [];
$expiresAt = $value;
$label = 'Expiration date';
if (\Zend_Validate::is($expiresAt, 'NotEmpty')) {
if (strtotime($expiresAt)) {
$currentTime = $this->dateTime->gmtTimestamp();
$utcExpiresAt = $this->timezone->convertConfigTimeToUtc($expiresAt);
$expiresAt = $this->timezone->date($utcExpiresAt)->getTimestamp();
if ($expiresAt < $currentTime) {
$messages['expires_at'] = __('"%1" must be later than the current date.', $label);
}
} else {
$messages['expires_at'] = __('"%1" is not a valid date.', $label);
if (\Zend_Validate::is($value, 'NotEmpty')) {
$utcExpiresAt = $this->localizedDateToUtcConverter->convertLocalizedDateToUtc($value);
$currentTime = $this->dateTime->gmtTimestamp();
$expiresAt = $this->timezone->date($utcExpiresAt)->getTimestamp();
if ($expiresAt < $currentTime) {
$messages['expires_at'] = __('"%1" must be later than the current date.', $label);
}
}
$this->_addMessages($messages);
Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);

namespace Magento\Security\Model\ResourceModel;

use Magento\Framework\Locale\ResolverInterface;
use Magento\Framework\Stdlib\DateTime\TimezoneInterface;
use Magento\Security\Model\UserExpirationFactory;
use Magento\TestFramework\Helper\Bootstrap;
use Magento\User\Model\ResourceModel\User as UserResource;
use PHPUnit\Framework\TestCase;

/**
* Verify user expiration resource model.
*/
class UserExpirationTest extends TestCase
{
/**
* @var UserExpiration
*/
private $userExpirationResource;

/**
* @inheritdoc
*/
protected function setUp(): void
{
$this->userExpirationResource = Bootstrap::getObjectManager()->get(UserExpiration::class);
}

/**
* Verify user expiration saved with correct date.
*
* @magentoDataFixture Magento/User/_files/dummy_user.php
* @dataProvider userExpirationSaveDataProvider
* @magentoAppArea adminhtml
* @return void
*/
public function testUserExpirationSave(string $locale): void
{
$localeResolver = Bootstrap::getObjectManager()->get(ResolverInterface::class);
$timeZone = Bootstrap::getObjectManager()->get(TimezoneInterface::class);
$localeResolver->setLocale($locale);
$initialExpirationDate = $timeZone->date()->modify('+10 day');
$expireDate = $timeZone->formatDateTime(
$initialExpirationDate,
\IntlDateFormatter::MEDIUM,
\IntlDateFormatter::MEDIUM
);
$userExpirationFactory = Bootstrap::getObjectManager()->get(UserExpirationFactory::class);
$userExpiration = $userExpirationFactory->create();
$userExpiration->setExpiresAt($expireDate);
$userExpiration->setUserId($this->getUserId());
$this->userExpirationResource->save($userExpiration);
$loadedUserExpiration = $userExpirationFactory->create();
$this->userExpirationResource->load($loadedUserExpiration, $userExpiration->getId());

self::assertEquals($initialExpirationDate->format('Y-m-d H:i:s'), $loadedUserExpiration->getExpiresAt());
}

/**
* Provides locale codes for validation test.
*
* @return array
*/
public function userExpirationSaveDataProvider(): array
{
return [
'default' => [
'locale_code' => 'en_US',
],
'non_default_english_textual' => [
'locale_code' => 'de_DE',
],
'non_default_non_english_textual' => [
'locale_code' => 'uk_UA',
],
];
}

/**
* Retrieve user id from db.
*
* @return int
*/
private function getUserId(): int
{
$userResource = Bootstrap::getObjectManager()->get(UserResource::class);
$data = $userResource->loadByUsername('dummy_username');

return (int)$data['user_id'];
}
}
Loading