improve token expiration

Author: jrushlow

CHANGELOG.md

@@ -5,11 +5,14 @@ find a change that break's semver, please create an issue.*
 
 ## NEXT
 
+- [#135](https://github.com/SymfonyCasts/reset-password-bundle/pull/134) Add translation support for signature expiration time
+- [#135](https://github.com/SymfonyCasts/reset-password-bundle/pull/134) Fixed invalid signature expiration time
+
 ## v1.2.0
 
 *Dec 10th, 2020*
 
-- #134 - Allow the bundle to be used with PHP 8 - thanks to @ker0x
+- [#134](https://github.com/SymfonyCasts/reset-password-bundle/pull/134)  - Allow the bundle to be used with PHP 8 - thanks to @ker0x
 
 ## v1.1.0
 

composer.json

@@ -8,6 +8,7 @@
         "php": ">=7.2.5",
         "symfony/config": "^4.4 | ^5.0",
         "symfony/dependency-injection": "^4.4 | ^5.0",
+        "symfony/deprecation-contracts": "^2.2",
         "symfony/http-kernel": "^4.4 | ^5.0"
     },
     "require-dev": {

src/Exception/GeneratedAtNotSetException.php

@@ -25,10 +25,25 @@ final class ResetPasswordToken
      */
     private $expiresAt;
 
-    public function __construct(string $token, \DateTimeInterface $expiresAt)
+    /**
+     * @var int|null timestamp when the token was created
+     */
+    private $generatedAt;
+
+    /**
+     * @var int expiresAt translator interval
+     */
+    private $transInterval = 0;
+
+    public function __construct(string $token, \DateTimeInterface $expiresAt, int $generatedAt = null)
     {
         $this->token = $token;
         $this->expiresAt = $expiresAt;
+        $this->generatedAt = $generatedAt;
+
+        if (null === $generatedAt) {
+            $this->triggerDeprecation();
+        }
     }
 
     /**
@@ -47,4 +62,82 @@ public function getExpiresAt(): \DateTimeInterface
     {
         return $this->expiresAt;
     }
+
+    /**
+     * Get the translation message for when a token expires.
+     *
+     * This is used in conjunction with getExpirationMessageData() method.
+     * Example usage in a Twig template:
+     *
+     * <p>{{ components.expirationMessageKey|trans(components.expirationMessageData) }}</p>
+     *
+     * symfony/translation is required to translate into a non-English locale.
+     *
+     * @throws \LogicException
+     */
+    public function getExpirationMessageKey(): string
+    {
+        $interval = $this->getExpiresAtIntervalInstance();
+
+        switch ($interval) {
+            case $interval->y > 0:
+                $this->transInterval = $interval->y;
+
+                return '%count% year|%count% years';
+            case $interval->m > 0:
+                $this->transInterval = $interval->m;
+
+                return '%count% month|%count% months';
+            case $interval->d > 0:
+                $this->transInterval = $interval->d;
+
+                return '%count% day|%count% days';
+            case $interval->h > 0:
+                $this->transInterval = $interval->h;
+
+                return '%count% hour|%count% hours';
+            default:
+                $this->transInterval = $interval->i;
+
+                return '%count% minute|%count% minutes';
+        }
+    }
+
+    /**
+     * @throws \LogicException
+     */
+    public function getExpirationMessageData(): array
+    {
+        $this->getExpirationMessageKey();
+
+        return ['%count%' => $this->transInterval];
+    }
+
+    /**
+     * Get the interval that the token is valid for.
+     *
+     * @throws \LogicException
+     *
+     * @psalm-suppress PossiblyFalseArgument
+     */
+    public function getExpiresAtIntervalInstance(): \DateInterval
+    {
+        if (null === $this->generatedAt) {
+            throw new \LogicException(\sprintf('%s initialized without setting the $generatedAt timestamp.', self::class));
+        }
+
+        $createdAtTime = \DateTimeImmutable::createFromFormat('U', (string) $this->generatedAt);
+
+        return $this->expiresAt->diff($createdAtTime);
+    }
+
+    private function triggerDeprecation(): void
+    {
+        trigger_deprecation(
+            'symfonycasts/reset-password-bundle',
+            '1.2',
+            'Initializing the %s without setting the "$generatedAt" constructor argument is deprecated. The default "null" will be removed in the future.',
+            self::class
+        );
+    }
 }

src/Model/ResetPasswordToken.php

@@ -68,7 +68,11 @@ public function generateResetToken(object $user): ResetPasswordToken
             throw new TooManyPasswordRequestsException($availableAt);
         }
 
-        $expiresAt = new \DateTimeImmutable(\sprintf('+%d seconds', $this->resetRequestLifetime));
+        $generatedAt = \time();
+        $expiresAtTimestamp = $generatedAt + $this->resetRequestLifetime;
+
+        /** @var \DateTimeImmutable $expiresAt */
+        $expiresAt = \DateTimeImmutable::createFromFormat('U', (string) $expiresAtTimestamp);
 
         $tokenComponents = $this->tokenGenerator->createToken($expiresAt, $this->repository->getUserIdentifier($user));
 
@@ -84,7 +88,8 @@ public function generateResetToken(object $user): ResetPasswordToken
         // final "public" token is the selector + non-hashed verifier token
         return new ResetPasswordToken(
             $tokenComponents->getPublicToken(),
-            $expiresAt
+            $expiresAt,
+            $generatedAt
         );
     }
 

src/ResetPasswordHelper.php

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<xliff xmlns="urn:oasis:names:tc:xliff:document:1.2" version="1.2">
+    <file original="file.ext" source-language="en" datatype="plaintext">
+        <body>
+            <trans-unit id="1">
+                <source>%count% year|%count% years</source>
+                <target>%count% year|%count% years</target>
+            </trans-unit>
+            <trans-unit id="2">
+                <source>%count% month|%count% months</source>
+                <target>%count% month|%count% months</target>
+            </trans-unit>
+            <trans-unit id="3">
+                <source>%count% day|%count% days</source>
+                <target>%count% day|%count% days</target>
+            </trans-unit>
+            <trans-unit id="4">
+                <source>%count% hour|%count% hours</source>
+                <target>%count% hour|%count% hours</target>
+            </trans-unit>
+            <trans-unit id="5">
+                <source>%count% minute|%count% minutes</source>
+                <target>%count% minute|%count% minutes</target>
+            </trans-unit>
+        </body>
+    </file>
+</xliff>

src/Resources/translations/ResetPasswordBundle.en.xlf

@@ -0,0 +1,52 @@
+<?php
+
+/*
+ * This file is part of the SymfonyCasts ResetPasswordBundle package.
+ * Copyright (c) SymfonyCasts <https://symfonycasts.com/>
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace SymfonyCasts\Bundle\ResetPassword\Tests\UnitTests\Model;
+
+use PHPUnit\Framework\TestCase;
+use SymfonyCasts\Bundle\ResetPassword\Model\ResetPasswordToken;
+
+/**
+ * @author Jesse Rushlow <[email protected]>
+ */
+class ResetPasswordTokenTest extends TestCase
+{
+    /**
+     * @dataProvider translationIntervalDataProvider
+     */
+    public function testTranslations(int $lifetime, int $expectedInterval, string $unitOfMeasure): void
+    {
+        $created = \time();
+
+        $expire = \DateTimeImmutable::createFromFormat('U', (string) ($created + $lifetime));
+
+        $token = new ResetPasswordToken('token', $expire, $created);
+
+        self::assertSame(
+            \sprintf('%%count%% %s|%%count%% %ss', $unitOfMeasure, $unitOfMeasure),
+            $token->getExpirationMessageKey()
+        );
+
+        self::assertSame(['%count%' => $expectedInterval], $token->getExpirationMessageData());
+    }
+
+    public function translationIntervalDataProvider(): \Generator
+    {
+        yield [60, 1, 'minute'];
+        yield [900, 15, 'minute'];
+        yield [3600, 1, 'hour'];
+        yield [7200, 2, 'hour'];
+        yield [43200, 12, 'hour'];
+        yield [86400, 1, 'day'];
+        yield [864000, 10, 'day'];
+        yield [2678400, 1, 'month'];
+        yield [5356800, 2, 'month'];
+        yield [34819200, 1, 'year'];
+    }
+}