Killing time()

craftcms · Dec 15, 2024 · f2786e7 · f2786e7
1 parent 2df06c0
commit f2786e7
Show file tree

Hide file tree

Showing 17 changed files with 82 additions and 47 deletions.
diff --git a/src/Craft.php b/src/Craft.php
@@ -12,6 +12,7 @@
 use craft\helpers\App;
 use craft\helpers\ArrayHelper;
 use craft\helpers\Component;
+use craft\helpers\DateTimeHelper;
 use craft\helpers\FileHelper;
 use craft\helpers\StringHelper;
 use GuzzleHttp\Client;
@@ -334,7 +335,7 @@ private static function _generateCustomFieldBehavior(array $fieldHandles, ?strin
 
             // Delete any CustomFieldBehavior files that are over 10 seconds old
             $basename = basename($filePath);
-            $time = time() - 10;
+            $time = DateTimeHelper::currentTimeStamp() - 10;
             FileHelper::clearDirectory($dir, [
                 'filter' => function(string $path) use ($basename, $time): bool {
                     $b = basename($path);

diff --git a/src/cache/DbCache.php b/src/cache/DbCache.php
@@ -9,6 +9,7 @@
 
 use Craft;
 use craft\db\Connection;
+use craft\helpers\DateTimeHelper;
 use craft\helpers\Db;
 use Exception;
 use PDO;
@@ -60,7 +61,7 @@ protected function setValue($key, $value, $duration): bool
             $this->db->noCache(function(Connection $db) use ($key, $value, $duration) {
                 Db::upsert($this->cacheTable, [
                     'id' => $key,
-                    'expire' => $duration > 0 ? $duration + time() : 0,
+                    'expire' => $duration > 0 ? DateTimeHelper::currentTimeStamp() + $duration : 0,
                     'data' => new PdoValue($value, PDO::PARAM_LOB),
                 ], db: $db);
             });
@@ -83,7 +84,7 @@ protected function addValue($key, $value, $duration): bool
             $this->db->noCache(function(Connection $db) use ($key, $value, $duration) {
                 Db::insert($this->cacheTable, [
                     'id' => $key,
-                    'expire' => $duration > 0 ? $duration + time() : 0,
+                    'expire' => $duration > 0 ? DateTimeHelper::currentTimeStamp() + $duration : 0,
                     'data' => new PdoValue($value, PDO::PARAM_LOB),
                 ], $db);
             });

diff --git a/src/console/controllers/ProjectConfigController.php b/src/console/controllers/ProjectConfigController.php
@@ -11,6 +11,7 @@
 use craft\console\Controller;
 use craft\events\ConfigEvent;
 use craft\helpers\Console;
+use craft\helpers\DateTimeHelper;
 use craft\helpers\FileHelper;
 use craft\helpers\ProjectConfig;
 use craft\services\ProjectConfig as ProjectConfigService;
@@ -459,7 +460,7 @@ public function actionRebuild(): int
      */
     public function actionTouch(): int
     {
-        $time = time();
+        $time = DateTimeHelper::currentTimeStamp();
         ProjectConfig::touch($time);
         $this->stdout("The dateModified value in project.yaml is now set to $time." . PHP_EOL, Console::FG_GREEN);
         return ExitCode::OK;

diff --git a/src/helpers/Api.php b/src/helpers/Api.php
@@ -206,7 +206,7 @@ public static function processResponseHeaders(array $headers): void
                     ) {
                         $timestamp = $oldLicenseInfo[$handle]['timestamp'];
                     } else {
-                        $timestamp = time();
+                        $timestamp = DateTimeHelper::currentTimeStamp();
                     }
                 }
                 $licenseInfo[$handle] = [

diff --git a/src/helpers/DateTimeHelper.php b/src/helpers/DateTimeHelper.php
@@ -524,9 +524,7 @@ public static function currentUTCDateTime(): DateTime
      */
     public static function currentTimeStamp(): int
     {
-        $date = static::currentUTCDateTime();
-
-        return $date->getTimestamp();
+        return static::now()->getTimestamp();
     }
 
     /**
@@ -671,9 +669,7 @@ public static function isWithinLast(mixed $date, mixed $timeInterval): bool
      */
     public static function isInThePast(mixed $date): bool
     {
-        $date = static::toDateTime($date);
-
-        return $date->getTimestamp() < time();
+        return static::toDateTime($date)->getTimestamp() < static::currentTimeStamp();
     }
 
     /**

diff --git a/src/helpers/ProjectConfig.php b/src/helpers/ProjectConfig.php
@@ -632,7 +632,7 @@ public static function diff(bool $invert = false): string
     public static function touch(?int $timestamp = null): void
     {
         if ($timestamp === null) {
-            $timestamp = time();
+            $timestamp = DateTimeHelper::currentTimeStamp();
         }
 
         $timestampLine = "dateModified: $timestamp\n";

diff --git a/src/models/ImageTransformIndex.php b/src/models/ImageTransformIndex.php
@@ -9,6 +9,7 @@
 
 use craft\base\imagetransforms\ImageTransformerInterface;
 use craft\base\Model;
+use craft\helpers\DateTimeHelper;
 use craft\helpers\ImageTransforms;
 use craft\validators\DateTimeValidator;
 use DateTime;
@@ -102,7 +103,7 @@ public function init(): void
 
         // Only respect inProgress if it's been less than 30 seconds since the last time the index was updated
         if ($this->inProgress) {
-            $duration = time() - ($this->dateUpdated?->getTimestamp() ?? 0);
+            $duration = DateTimeHelper::currentTimeStamp() - ($this->dateUpdated?->getTimestamp() ?? 0);
             if ($duration > 30) {
                 $this->inProgress = false;
             }

diff --git a/src/queue/Queue.php b/src/queue/Queue.php
@@ -13,6 +13,7 @@
 use craft\errors\MutexException;
 use craft\helpers\App;
 use craft\helpers\ArrayHelper;
+use craft\helpers\DateTimeHelper;
 use craft\helpers\Db;
 use craft\helpers\Json;
 use craft\helpers\Queue as QueueHelper;
@@ -381,7 +382,7 @@ public function setProgress(int $progress, ?string $label = null): void
         $this->_lock(function() use ($progress, $label) {
             $data = [
                 'progress' => $progress,
-                'timeUpdated' => time(),
+                'timeUpdated' => DateTimeHelper::currentTimeStamp(),
             ];
 
             if ($label !== null) {
@@ -546,7 +547,9 @@ public function getJobInfo(?int $limit = null): array
             // then running first
             ->addOrderBy(new Expression("CASE WHEN $runningSql THEN 1 ELSE 0 END DESC"))
             // then earliest start time (now or timePushed + delay)
-            ->addOrderBy(new Expression('GREATEST(:time, [[timePushed]] + [[delay]]) ASC', [':time' => time()]))
+            ->addOrderBy(new Expression('GREATEST(:time, [[timePushed]] + [[delay]]) ASC', [
+                ':time' => DateTimeHelper::currentTimeStamp(),
+            ]))
             // then priority and ID
             ->addOrderBy(['priority' => SORT_ASC, 'id' => SORT_ASC])
             ->limit($limit);
@@ -661,7 +664,7 @@ protected function pushMessage($message, $ttr, $delay, $priority): string
             'channel' => $this->channel(),
             'job' => $message,
             'description' => $this->_jobDescription,
-            'timePushed' => time(),
+            'timePushed' => DateTimeHelper::currentTimeStamp(),
             'ttr' => $ttr,
             'delay' => $delay,
             'priority' => $priority ?: 1024,
@@ -733,7 +736,9 @@ protected function reserve(?string $id = null): ?array
             $payload = $this->db->usePrimary(function() use ($id) {
                 $query = $this->_createJobQuery()
                     ->andWhere(['fail' => false, 'timeUpdated' => null])
-                    ->andWhere('[[timePushed]] + [[delay]] <= :time', ['time' => time()])
+                    ->andWhere('[[timePushed]] + [[delay]] <= :time', [
+                        'time' => DateTimeHelper::currentTimeStamp(),
+                    ])
                     ->orderBy(['priority' => SORT_ASC, 'id' => SORT_ASC])
                     ->limit(1);
 
@@ -793,8 +798,9 @@ private function _jobData(mixed $job): string
      */
     private function _moveExpired(): void
     {
-        if ($this->_reserveTime !== time()) {
-            $this->_reserveTime = time();
+        $timestamp = DateTimeHelper::currentTimeStamp();
+        if ($this->_reserveTime !== $timestamp) {
+            $this->_reserveTime = $timestamp;
 
             $expiredIds = $this->db->usePrimary(function() {
                 return (new Query())
@@ -856,7 +862,9 @@ private function _createWaitingJobQuery(): Query
     {
         return $this->_createJobQuery()
             ->andWhere(['fail' => false, 'timeUpdated' => null])
-            ->andWhere('[[timePushed]] + [[delay]] <= :time', ['time' => time()]);
+            ->andWhere('[[timePushed]] + [[delay]] <= :time', [
+                'time' => DateTimeHelper::currentTimeStamp(),
+            ]);
     }
 
     /**
@@ -868,7 +876,9 @@ private function _createDelayedJobQuery(): Query
     {
         return $this->_createJobQuery()
             ->andWhere(['fail' => false, 'timeUpdated' => null])
-            ->andWhere('[[timePushed]] + [[delay]] > :time', ['time' => time()]);
+            ->andWhere('[[timePushed]] + [[delay]] > :time', [
+                'time' => DateTimeHelper::currentTimeStamp(),
+            ]);
     }
 
     /**

diff --git a/src/services/Elements.php b/src/services/Elements.php
@@ -619,7 +619,7 @@ public function setCacheExpiryDate(DateTime $expiryDate): void
             return;
         }
 
-        $duration = $expiryDate->getTimestamp() - time();
+        $duration = $expiryDate->getTimestamp() - DateTimeHelper::currentTimeStamp();
 
         if ($duration > 0 && (!$this->_cacheDuration || $duration < $this->_cacheDuration)) {
             $this->_cacheDuration = $duration;

diff --git a/src/services/Fields.php b/src/services/Fields.php
@@ -50,6 +50,7 @@
 use craft\fields\Users as UsersField;
 use craft\helpers\ArrayHelper;
 use craft\helpers\Component as ComponentHelper;
+use craft\helpers\DateTimeHelper;
 use craft\helpers\Db;
 use craft\helpers\ElementHelper;
 use craft\helpers\FieldHelper;
@@ -1840,7 +1841,7 @@ private function _backupFieldColumn(Connection $db, string $table, string $colum
         $shortTableName = Db::rawTableShortName($table);
         $schema = $db->getSchema();
         $prefix = "{$shortTableName}_$column";
-        $timestamp = time();
+        $timestamp = DateTimeHelper::currentTimeStamp();
         $n = 1;
         do {
             $suffix = $n === 1 ? '' : "_$n";

diff --git a/src/services/TemplateCaches.php b/src/services/TemplateCaches.php
@@ -245,7 +245,7 @@ public function endTemplateCache(string $key, bool $global, ?string $duration, m
             $expiration = (new DateTime($duration));
         }
         if ($expiration !== null) {
-            $duration = DateTimeHelper::toDateTime($expiration)->getTimestamp() - time();
+            $duration = DateTimeHelper::toDateTime($expiration)->getTimestamp() - DateTimeHelper::currentTimeStamp();
         }
 
         if ($duration <= 0) {

diff --git a/src/web/Response.php b/src/web/Response.php
@@ -9,6 +9,7 @@
 
 use Craft;
 use craft\helpers\ArrayHelper;
+use craft\helpers\DateTimeHelper;
 use craft\helpers\Session;
 use craft\helpers\UrlHelper;
 use Throwable;
@@ -122,7 +123,8 @@ public function setCacheHeaders(int $duration = 31536000, bool $overwrite = true
             return $this;
         }
 
-        $this->setHeader('Expires', sprintf('%s GMT', gmdate('D, d M Y H:i:s', time() + $duration)), $overwrite);
+        $expires = DateTimeHelper::currentTimeStamp() + $duration;
+        $this->setHeader('Expires', sprintf('%s GMT', gmdate('D, d M Y H:i:s', $expires)), $overwrite);
         $this->setHeader('Pragma', 'cache', $overwrite);
         $this->setHeader('Cache-Control', "public, max-age=$duration", $overwrite);
         return $this;

diff --git a/src/web/User.php b/src/web/User.php
@@ -14,6 +14,7 @@
 use craft\errors\UserLockedException;
 use craft\events\LoginFailureEvent;
 use craft\helpers\ConfigHelper;
+use craft\helpers\DateTimeHelper;
 use craft\helpers\Db;
 use craft\helpers\Session as SessionHelper;
 use craft\helpers\UrlHelper;
@@ -99,7 +100,7 @@ public function sendUsernameCookie(UserElement $user): void
             $cookie = new Cookie($this->usernameCookie);
             $cookie->value = $user->username;
             $seconds = ConfigHelper::durationInSeconds($generalConfig->rememberUsernameDuration);
-            $cookie->expire = time() + $seconds;
+            $cookie->expire = DateTimeHelper::currentTimeStamp() + $seconds;
             Craft::$app->getResponse()->getCookies()->add($cookie);
         } else {
             Craft::$app->getResponse()->getCookies()->remove(new Cookie($this->usernameCookie));
@@ -234,7 +235,7 @@ public function getRemainingSessionTime(): int
             }
 
             $expire = SessionHelper::get($this->authTimeoutParam);
-            $time = time();
+            $time = DateTimeHelper::currentTimeStamp();
 
             if ($expire !== null && $expire > $time) {
                 return $expire - $time;
@@ -285,7 +286,7 @@ public function getElevatedSessionTimeout(): int|false
             $expires = SessionHelper::get($this->elevatedSessionTimeoutParam);
 
             if ($expires !== null) {
-                $currentTime = time();
+                $currentTime = DateTimeHelper::currentTimeStamp();
 
                 if ($expires > $currentTime) {
                     return $expires - $currentTime;
@@ -364,7 +365,7 @@ public function startElevatedSession(string $password): bool
         }
 
         // Set the elevated session expiration date
-        $timeout = time() + $generalConfig->elevatedSessionDuration;
+        $timeout = DateTimeHelper::currentTimeStamp() + $generalConfig->elevatedSessionDuration;
         SessionHelper::set($this->elevatedSessionTimeoutParam, $timeout);
 
         return true;

diff --git a/src/web/twig/nodes/ExpiresNode.php b/src/web/twig/nodes/ExpiresNode.php
@@ -31,7 +31,11 @@ public function compile(Compiler $compiler): void
                 ->write('$expiration = ')
                 ->subcompile($expiration)
                 ->raw(";\n")
-                ->write('$duration = \craft\helpers\DateTimeHelper::toDateTime($expiration)->getTimestamp() - time();');
+                ->write(sprintf(
+                    '$duration = %s::toDateTime($expiration)->getTimestamp() - %s::currentTimeStamp();',
+                    DateTimeHelper::class,
+                    DateTimeHelper::class,
+                ));
         } else {
             $duration = DateTimeHelper::relativeTimeToSeconds(
                 $this->getAttribute('durationNum'),

diff --git a/tests/unit/helpers/ProjectConfigHelperTest.php b/tests/unit/helpers/ProjectConfigHelperTest.php
@@ -8,6 +8,7 @@
 namespace crafttests\unit\helpers;
 
 use Craft;
+use craft\helpers\DateTimeHelper;
 use craft\helpers\FileHelper;
 use craft\helpers\ProjectConfig as ProjectConfigHelper;
 use craft\helpers\StringHelper;
@@ -68,10 +69,11 @@ public function testTouch(string $input, string $expected): void
         FileHelper::writeToFile($path, $input);
 
         // Test
-        $timestamp = time();
-        $expected = str_replace('__TIMESTAMP__', (string)$timestamp, $expected);
-        ProjectConfigHelper::touch($timestamp);
+        DateTimeHelper::pause();
+        $expected = str_replace('__TIMESTAMP__', (string)DateTimeHelper::currentTimeStamp(), $expected);
+        ProjectConfigHelper::touch();
         self::assertSame($expected, file_get_contents($path));
+        DateTimeHelper::resume();
 
         // Put the old project.yaml back
         FileHelper::unlink($path);

diff --git a/tests/unit/web/ResponseTest.php b/tests/unit/web/ResponseTest.php
@@ -8,6 +8,7 @@
 namespace crafttests\unit\web;
 
 use Codeception\Test\Unit;
+use craft\helpers\DateTimeHelper;
 use craft\test\TestCase;
 use craft\web\Response;
 
@@ -47,15 +48,16 @@ public function testGetContentType(?string $expected, ?string $format = null, ?s
      */
     public function testSetCacheHeaders(): void
     {
+        DateTimeHelper::pause();
         $this->response->setCacheHeaders();
         $headers = $this->response->getHeaders();
-
         $cacheTime = 31536000; // 1 year
-
         self::assertSame('cache', $headers->get('Pragma'));
         self::assertSame('cache', $headers->get('Pragma'));
         self::assertSame('public, max-age=31536000', $headers->get('Cache-Control'));
-        self::assertSame(gmdate('D, d M Y H:i:s', time() + $cacheTime) . ' GMT', $headers->get('Expires'));
+        $expectedExpires = DateTimeHelper::currentTimeStamp() + $cacheTime;
+        self::assertSame(gmdate('D, d M Y H:i:s', $expectedExpires) . ' GMT', $headers->get('Expires'));
+        DateTimeHelper::resume();
     }
 
     /**