Use immutable DateTime

jtojnar · jtojnar · commit f14546b0c0d1 · 2023-07-25T00:02:33.000+02:00
Ensure DateTime cannot be accidentally mutated when passed as an argument.
diff --git a/src/controllers/Index.php b/src/controllers/Index.php
@@ -83,7 +83,7 @@ public function home(): void {
 
         $lastUpdate = $this->itemsDao->lastUpdate();
         $result = [
-            'lastUpdate' => $lastUpdate !== null ? $lastUpdate->format(\DateTime::ATOM) : null,
+            'lastUpdate' => $lastUpdate !== null ? $lastUpdate->format(\DateTimeImmutable::ATOM) : null,
             'hasMore' => $items['hasMore'],
             'entries' => $items['entries'],
             'all' => $statsAll,
diff --git a/src/controllers/Items/Sync.php b/src/controllers/Items/Sync.php
@@ -49,26 +49,26 @@ public function sync(): void {
             $this->view->jsonError(['sync' => 'missing since argument']);
         }
 
-        $since = new \DateTime($params['since']);
-        $since->setTimeZone(new \DateTimeZone(date_default_timezone_get()));
+        $since = new \DateTimeImmutable($params['since']);
+        $since = $since->setTimeZone(new \DateTimeZone(date_default_timezone_get()));
 
         $lastUpdate = $this->itemsDao->lastUpdate();
 
         $sync = [
-            'lastUpdate' => $lastUpdate !== null ? $lastUpdate->format(\DateTime::ATOM) : null,
+            'lastUpdate' => $lastUpdate !== null ? $lastUpdate->format(\DateTimeImmutable::ATOM) : null,
         ];
 
         if (array_key_exists('itemsSinceId', $params)) {
             $sinceId = (int) $params['itemsSinceId'];
             if ($sinceId >= 0) {
-                $notBefore = isset($params['itemsNotBefore']) ? new \DateTime($params['itemsNotBefore']) : null;
+                $notBefore = isset($params['itemsNotBefore']) ? new \DateTimeImmutable($params['itemsNotBefore']) : null;
                 if ($sinceId === 0 || !$notBefore) {
                     $sinceId = $this->itemsDao->lowestIdOfInterest() - 1;
                     // only send 1 day worth of items
-                    $notBefore = new \DateTime();
-                    $notBefore->setTimeZone(new \DateTimeZone(date_default_timezone_get()));
-                    $notBefore->sub(new \DateInterval('P1D'));
-                    $notBefore->setTimeZone(new \DateTimeZone(date_default_timezone_get()));
+                    $notBefore = new \DateTimeImmutable();
+                    $notBefore = $notBefore->setTimeZone(new \DateTimeZone(date_default_timezone_get()));
+                    $notBefore = $notBefore->sub(new \DateInterval('P1D'));
+                    $notBefore = $notBefore->setTimeZone(new \DateTimeZone(date_default_timezone_get()));
                 }
 
                 $itemsHowMany = $this->configuration->itemsPerpage;
diff --git a/src/controllers/Rss.php b/src/controllers/Rss.php
@@ -96,7 +96,7 @@ public function rss(): void {
         }
 
         if ($newestEntryDate === null) {
-            $newestEntryDate = new \DateTime();
+            $newestEntryDate = new \DateTimeImmutable();
         }
         $this->feedWriter->setDate($newestEntryDate);
 
diff --git a/src/daos/ItemOptions.php b/src/daos/ItemOptions.php
@@ -4,7 +4,7 @@
 
 namespace daos;
 
-use DateTime;
+use DateTimeImmutable;
 
 /**
  * Object holding parameters for querying items.
@@ -24,13 +24,13 @@ final class ItemOptions {
     public ?int $pageSize = null;
 
     /** @readonly */
-    public ?DateTime $fromDatetime = null;
+    public ?DateTimeImmutable $fromDatetime = null;
 
     /** @readonly */
     public ?int $fromId = null;
 
     /** @readonly */
-    public ?DateTime $updatedSince = null;
+    public ?DateTimeImmutable $updatedSince = null;
 
     /** @readonly */
     public ?string $tag = null;
@@ -71,15 +71,15 @@ public static function fromUser(array $data): self {
         }
 
         if (isset($data['fromDatetime']) && is_string($data['fromDatetime']) && strlen($data['fromDatetime']) > 0) {
-            $options->fromDatetime = new \DateTime($data['fromDatetime']);
+            $options->fromDatetime = new \DateTimeImmutable($data['fromDatetime']);
         }
 
         if (isset($data['fromId']) && is_numeric($data['fromId'])) {
             $options->fromId = (int) $data['fromId'];
         }
 
         if (isset($data['updatedsince']) && is_string($data['updatedsince']) && strlen($data['updatedsince']) > 0) {
-            $options->updatedSince = new \DateTime($data['updatedsince']);
+            $options->updatedSince = new \DateTimeImmutable($data['updatedsince']);
         }
 
         if (isset($data['tag']) && is_string($data['tag']) && strlen($tag = trim($data['tag'])) > 0) {
diff --git a/src/daos/Items.php b/src/daos/Items.php
@@ -4,7 +4,7 @@
 
 namespace daos;
 
-use DateTime;
+use DateTimeImmutable;
 use DateTimeImmutable;
 use helpers\Authentication;
 
@@ -60,7 +60,7 @@ public function updateLastSeen(array $itemIds): void {
         $this->backend->updateLastSeen($itemIds);
     }
 
-    public function cleanup(?DateTime $minDate): void {
+    public function cleanup(?DateTimeImmutable $minDate): void {
         $this->backend->cleanup($minDate);
     }
 
@@ -69,7 +69,7 @@ public function cleanup(?DateTime $minDate): void {
      *
      * @param ItemOptions $options search, offset and filter params
      *
-     * @return array<array{id: int, datetime: DateTime, title: string, content: string, unread: bool, starred: bool, source: int, thumbnail: string, icon: string, uid: string, link: string, updatetime: DateTime, author: string, sourcetitle: string, tags: string[]}> items as array
+     * @return array<array{id: int, datetime: DateTimeImmutable, title: string, content: string, unread: bool, starred: bool, source: int, thumbnail: string, icon: string, uid: string, link: string, updatetime: DateTimeImmutable, author: string, sourcetitle: string, tags: string[]}> items as array
      */
     public function get(ItemOptions $options): array {
         $items = $this->backend->get($options);
@@ -107,7 +107,7 @@ public function hasMore(): bool {
         return $this->backend->hasMore();
     }
 
-    public function sync(int $sinceId, DateTime $notBefore, DateTime $since, int $howMany): array {
+    public function sync(int $sinceId, DateTimeImmutable $notBefore, DateTimeImmutable $since, int $howMany): array {
         return $this->backend->sync($sinceId, $notBefore, $since, $howMany);
     }
 
@@ -147,7 +147,7 @@ public function lastUpdate(): ?DateTimeImmutable {
         return $this->backend->lastUpdate();
     }
 
-    public function statuses(DateTime $since): array {
+    public function statuses(DateTimeImmutable $since): array {
         return $this->backend->statuses($since);
     }
 
diff --git a/src/daos/ItemsInterface.php b/src/daos/ItemsInterface.php
@@ -4,7 +4,7 @@
 
 namespace daos;
 
-use DateTime;
+use DateTimeImmutable;
 use DateTimeImmutable;
 use helpers\HtmlString;
 
@@ -73,16 +73,16 @@ public function updateLastSeen(array $itemIds): void;
     /**
      * cleanup orphaned and old items
      *
-     * @param ?DateTime $date date to delete all items older than this value
+     * @param ?DateTimeImmutable $date date to delete all items older than this value
      */
-    public function cleanup(?DateTime $date): void;
+    public function cleanup(?DateTimeImmutable $date): void;
 
     /**
      * returns items
      *
      * @param ItemOptions $options search, offset and filter params
      *
-     * @return array<array{id: int, datetime: DateTime, title: string, content: string, unread: bool, starred: bool, source: int, thumbnail: string, icon: string, uid: string, link: string, updatetime: DateTime, author: string, sourcetitle: string, tags: string[]}> items as array
+     * @return array<array{id: int, datetime: DateTimeImmutable, title: string, content: string, unread: bool, starred: bool, source: int, thumbnail: string, icon: string, uid: string, link: string, updatetime: DateTimeImmutable, author: string, sourcetitle: string, tags: string[]}> items as array
      */
     public function get(ItemOptions $options): array;
 
@@ -96,12 +96,12 @@ public function hasMore(): bool;
      * Obtain new or changed items in the database for synchronization with clients.
      *
      * @param int $sinceId id of last seen item
-     * @param DateTime $notBefore cut off time stamp
-     * @param DateTime $since timestamp of last seen item
+     * @param DateTimeImmutable $notBefore cut off time stamp
+     * @param DateTimeImmutable $since timestamp of last seen item
      *
-     * @return array<array{id: int, datetime: DateTime, title: string, content: string, unread: bool, starred: bool, source: int, thumbnail: string, icon: string, uid: string, link: string, updatetime: DateTime, author: string, sourcetitle: string, tags: string[]}> of items
+     * @return array<array{id: int, datetime: DateTimeImmutable, title: string, content: string, unread: bool, starred: bool, source: int, thumbnail: string, icon: string, uid: string, link: string, updatetime: DateTimeImmutable, author: string, sourcetitle: string, tags: string[]}> of items
      */
-    public function sync(int $sinceId, DateTime $notBefore, DateTime $since, int $howMany): array;
+    public function sync(int $sinceId, DateTimeImmutable $notBefore, DateTimeImmutable $since, int $howMany): array;
 
     /**
      * Lowest id of interest
@@ -171,11 +171,11 @@ public function lastUpdate(): ?DateTimeImmutable;
     /**
      * returns the statuses of items last update
      *
-     * @param DateTime $since minimal date of returned items
+     * @param DateTimeImmutable $since minimal date of returned items
      *
      * @return array<array{id: int, unread: bool, starred: bool}> of unread, starred, etc. status of specified items
      */
-    public function statuses(DateTime $since): array;
+    public function statuses(DateTimeImmutable $since): array;
 
     /**
      * bulk update of item status
diff --git a/src/daos/StatementsInterface.php b/src/daos/StatementsInterface.php
@@ -93,11 +93,9 @@ public static function bool(bool $bool): string;
      * Convert a date into a representation suitable for comparison by
      * the database engine.
      *
-     * @param \DateTime $date datetime
-     *
      * @return string representation of datetime
      */
-    public static function datetime(\DateTime $date): string;
+    public static function datetime(\DateTimeImmutable $date): string;
 
     /**
      * Ensure row values have the appropriate PHP type. This assumes we are
diff --git a/src/daos/mysql/Items.php b/src/daos/mysql/Items.php
@@ -6,7 +6,7 @@
 
 use daos\DatabaseInterface;
 use daos\ItemOptions;
-use DateTime;
+use DateTimeImmutable;
 use DateTimeImmutable;
 use helpers\Configuration;
 use helpers\HtmlString;
@@ -206,9 +206,9 @@ public function updateLastSeen(array $itemIds): void {
     /**
      * cleanup orphaned and old items
      *
-     * @param ?DateTime $date date to delete all items older than this value
+     * @param ?DateTimeImmutable $date date to delete all items older than this value
      */
-    public function cleanup(?DateTime $date): void {
+    public function cleanup(?DateTimeImmutable $date): void {
         $this->database->exec('DELETE FROM ' . $this->configuration->dbPrefix . 'items
             WHERE source NOT IN (
                 SELECT id FROM ' . $this->configuration->dbPrefix . 'sources)');
@@ -226,7 +226,7 @@ public function cleanup(?DateTime $date): void {
      *
      * @param ItemOptions $options search, offset and filter params
      *
-     * @return array<array{id: int, datetime: DateTime, title: string, content: string, unread: bool, starred: bool, source: int, thumbnail: string, icon: string, uid: string, link: string, updatetime: DateTime, author: string, sourcetitle: string, tags: string[]}> items as array
+     * @return array<array{id: int, datetime: DateTimeImmutable, title: string, content: string, unread: bool, starred: bool, source: int, thumbnail: string, icon: string, uid: string, link: string, updatetime: DateTimeImmutable, author: string, sourcetitle: string, tags: string[]}> items as array
      */
     public function get(ItemOptions $options): array {
         $params = [];
@@ -375,12 +375,12 @@ public function hasMore(): bool {
      * Obtain new or changed items in the database for synchronization with clients.
      *
      * @param int $sinceId id of last seen item
-     * @param DateTime $notBefore cut off time stamp
-     * @param DateTime $since timestamp of last seen item
+     * @param DateTimeImmutable $notBefore cut off time stamp
+     * @param DateTimeImmutable $since timestamp of last seen item
      *
-     * @return array<array{id: int, datetime: DateTime, title: string, content: string, unread: bool, starred: bool, source: int, thumbnail: string, icon: string, uid: string, link: string, updatetime: DateTime, author: string, sourcetitle: string, tags: string[]}> of items
+     * @return array<array{id: int, datetime: DateTimeImmutable, title: string, content: string, unread: bool, starred: bool, source: int, thumbnail: string, icon: string, uid: string, link: string, updatetime: DateTimeImmutable, author: string, sourcetitle: string, tags: string[]}> of items
      */
-    public function sync(int $sinceId, DateTime $notBefore, DateTime $since, int $howMany): array {
+    public function sync(int $sinceId, DateTimeImmutable $notBefore, DateTimeImmutable $since, int $howMany): array {
         $query = 'SELECT
         items.id, datetime, items.title AS title, content, unread, starred, source, thumbnail, icon, uid, link, updatetime, author, sources.title as sourcetitle, sources.tags as tags
         FROM ' . $this->configuration->dbPrefix . 'items AS items, ' . $this->configuration->dbPrefix . 'sources AS sources
@@ -575,11 +575,11 @@ public function lastUpdate(): ?DateTimeImmutable {
     /**
      * returns the statuses of items last update
      *
-     * @param DateTime $since minimal date of returned items
+     * @param DateTimeImmutable $since minimal date of returned items
      *
      * @return array<array{id: int, unread: bool, starred: bool}> of unread, starred, etc. status of specified items
      */
-    public function statuses(DateTime $since): array {
+    public function statuses(DateTimeImmutable $since): array {
         $res = $this->database->exec(
             'SELECT id, unread, starred
             FROM ' . $this->configuration->dbPrefix . 'items
@@ -627,7 +627,7 @@ public function bulkStatusUpdate(array $statuses): void {
 
                     // sanitize update time
                     if (array_key_exists('datetime', $status)) {
-                        $updateDate = new \DateTime($status['datetime']);
+                        $updateDate = new \DateTimeImmutable($status['datetime']);
                     } else {
                         $updateDate = null;
                     }
diff --git a/src/daos/mysql/Statements.php b/src/daos/mysql/Statements.php
@@ -128,13 +128,11 @@ public static function bool(bool $bool): string {
      * Convert a date into a representation suitable for comparison by
      * the database engine.
      *
-     * @param \DateTime $date datetime
-     *
      * @return string representation of datetime
      */
-    public static function datetime(\DateTime $date): string {
+    public static function datetime(\DateTimeImmutable $date): string {
         // mysql supports ISO8601 datetime comparisons
-        return $date->format(\DateTime::ATOM);
+        return $date->format(\DateTimeImmutable::ATOM);
     }
 
     /**
@@ -179,7 +177,7 @@ public static function ensureRowTypes(array $rows, array $expectedRowTypes): arr
                             }
                             break;
                         case DatabaseInterface::PARAM_DATETIME:
-                            $value = new \DateTime($row[$columnIndex]);
+                            $value = new \DateTimeImmutable($row[$columnIndex]);
                             break;
                         default:
                             $value = null;
diff --git a/src/daos/pgsql/Statements.php b/src/daos/pgsql/Statements.php
@@ -104,7 +104,7 @@ public static function ensureRowTypes(array $rows, array $expectedRowTypes): arr
                             }
                             break;
                         case DatabaseInterface::PARAM_DATETIME:
-                            $value = new \DateTime($row[$columnIndex]);
+                            $value = new \DateTimeImmutable($row[$columnIndex]);
                             break;
                         default:
                             $value = null;
diff --git a/src/daos/sqlite/Statements.php b/src/daos/sqlite/Statements.php
@@ -47,17 +47,15 @@ public static function bool(bool $bool): string {
      * Convert a date into a representation suitable for comparison by
      * the database engine.
      *
-     * @param \DateTime $date datetime
-     *
      * @return string representation of datetime
      */
-    public static function datetime(\DateTime $date): string {
+    public static function datetime(\DateTimeImmutable $date): string {
         // SQLite does not support timezones.
         // The client previously sent the local timezone
         // but now it sends UTC time so we need to adjust it here
         // to avoid fromDatetime mismatch.
         // TODO: Switch to UTC everywhere.
-        $date->setTimeZone((new \DateTime())->getTimeZone());
+        $date = $date->setTimeZone((new \DateTimeImmutable())->getTimeZone());
 
         return $date->format('Y-m-d H:i:s');
     }
diff --git a/src/helpers/ContentLoader.php b/src/helpers/ContentLoader.php
@@ -121,8 +121,8 @@ public function fetch($source): void {
             // current date
             $minDate = null;
             if ($this->configuration->itemsLifetime !== 0) {
-                $minDate = new \DateTime();
-                $minDate->sub(new \DateInterval('P' . $this->configuration->itemsLifetime . 'D'));
+                $minDate = new \DateTimeImmutable();
+                $minDate = $minDate->sub(new \DateInterval('P' . $this->configuration->itemsLifetime . 'D'));
                 $this->logger->debug('minimum date: ' . $minDate->format('Y-m-d H:i:s'));
             }
 
@@ -168,7 +168,7 @@ public function fetch($source): void {
                     $itemDate = new \DateTimeImmutable();
                 }
                 if ($minDate !== null && $itemDate < $minDate) {
-                    $this->logger->debug('item "' . $titlePlainText . '" (' . $itemDate->format(\DateTime::ATOM) . ') older than ' . $this->configuration->itemsLifetime . ' days');
+                    $this->logger->debug('item "' . $titlePlainText . '" (' . $itemDate->format(\DateTimeImmutable::ATOM) . ') older than ' . $this->configuration->itemsLifetime . ' days');
                     continue;
                 }
 
@@ -426,8 +426,8 @@ public function cleanup(): void {
         $this->logger->debug('cleanup orphaned and old items');
         $minDate = null;
         if ($this->configuration->itemsLifetime !== 0) {
-            $minDate = new \DateTime();
-            $minDate->sub(new \DateInterval('P' . $this->configuration->itemsLifetime . 'D'));
+            $minDate = new \DateTimeImmutable();
+            $minDate = $minDate->sub(new \DateInterval('P' . $this->configuration->itemsLifetime . 'D'));
         }
         $this->itemsDao->cleanup($minDate);
         $this->logger->debug('cleanup orphaned and old items finished');
diff --git a/src/helpers/ViewHelper.php b/src/helpers/ViewHelper.php
@@ -4,7 +4,7 @@
 
 namespace helpers;
 
-use DateTime;
+use DateTimeImmutable;
 
 /**
  * Helper class for loading extern items
@@ -122,7 +122,7 @@ public function camoflauge(string $content): string {
     /**
      * Prepare entry as expected by the client.
      *
-     * @param array{title: string, content: string, datetime: DateTime, updatetime: DateTime, sourcetitle: string, tags: string[]} $item item to modify
+     * @param array{title: string, content: string, datetime: DateTimeImmutable, updatetime: DateTimeImmutable, sourcetitle: string, tags: string[]} $item item to modify
      * @param \controllers\Tags $tagsController tags controller
      * @param ?array<array{tag: string, color: string}> $tags list of tags
      * @param ?string $search search query
@@ -151,8 +151,8 @@ public function preprocessEntry(array $item, \controllers\Tags $tagsController,
         $item['content'] = ViewHelper::lazyimg($item['content']);
         $contentWithoutTags = strip_tags($item['content']);
         $item['wordCount'] = str_word_count($contentWithoutTags);
-        $item['datetime'] = $item['datetime']->format(\DateTime::ATOM);
-        $item['updatetime'] = $item['updatetime']->format(\DateTime::ATOM);
+        $item['datetime'] = $item['datetime']->format(\DateTimeImmutable::ATOM);
+        $item['updatetime'] = $item['updatetime']->format(\DateTimeImmutable::ATOM);
         $item['lengthWithoutTags'] = strlen($contentWithoutTags);
 
         return $item;

Original file line number	Diff line number	Diff line change
`@@ -96,7 +96,7 @@ public function rss(): void {`
`96`	`96`	`}`
`97`	`97`
`98`	`98`	`if ($newestEntryDate === null) {`
`99`		`- $newestEntryDate = new \DateTime();`
	`99`	`+ $newestEntryDate = new \DateTimeImmutable();`
`100`	`100`	`}`
`101`	`101`	`$this->feedWriter->setDate($newestEntryDate);`
`102`	`102`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`
`5`	`5`	`namespace daos;`
`6`	`6`
`7`		`-use DateTime;`
	`7`	`+use DateTimeImmutable;`
`8`	`8`	`use DateTimeImmutable;`
`9`	`9`	`use helpers\Authentication;`
`10`	`10`
`@@ -60,7 +60,7 @@ public function updateLastSeen(array $itemIds): void {`
`60`	`60`	`$this->backend->updateLastSeen($itemIds);`
`61`	`61`	`}`
`62`	`62`
`63`		`- public function cleanup(?DateTime $minDate): void {`
	`63`	`+ public function cleanup(?DateTimeImmutable $minDate): void {`
`64`	`64`	`$this->backend->cleanup($minDate);`
`65`	`65`	`}`
`66`	`66`
`@@ -69,7 +69,7 @@ public function cleanup(?DateTime $minDate): void {`
`69`	`69`	`*`
`70`	`70`	`* @param ItemOptions $options search, offset and filter params`
`71`	`71`	`*`
`72`		`- * @return array<array{id: int, datetime: DateTime, title: string, content: string, unread: bool, starred: bool, source: int, thumbnail: string, icon: string, uid: string, link: string, updatetime: DateTime, author: string, sourcetitle: string, tags: string[]}> items as array`
	`72`	`+ * @return array<array{id: int, datetime: DateTimeImmutable, title: string, content: string, unread: bool, starred: bool, source: int, thumbnail: string, icon: string, uid: string, link: string, updatetime: DateTimeImmutable, author: string, sourcetitle: string, tags: string[]}> items as array`
`73`	`73`	`*/`
`74`	`74`	`public function get(ItemOptions $options): array {`
`75`	`75`	`$items = $this->backend->get($options);`
`@@ -107,7 +107,7 @@ public function hasMore(): bool {`
`107`	`107`	`return $this->backend->hasMore();`
`108`	`108`	`}`
`109`	`109`
`110`		`- public function sync(int $sinceId, DateTime $notBefore, DateTime $since, int $howMany): array {`
	`110`	`+ public function sync(int $sinceId, DateTimeImmutable $notBefore, DateTimeImmutable $since, int $howMany): array {`
`111`	`111`	`return $this->backend->sync($sinceId, $notBefore, $since, $howMany);`
`112`	`112`	`}`
`113`	`113`
`@@ -147,7 +147,7 @@ public function lastUpdate(): ?DateTimeImmutable {`
`147`	`147`	`return $this->backend->lastUpdate();`
`148`	`148`	`}`
`149`	`149`
`150`		`- public function statuses(DateTime $since): array {`
	`150`	`+ public function statuses(DateTimeImmutable $since): array {`
`151`	`151`	`return $this->backend->statuses($since);`
`152`	`152`	`}`
`153`	`153`
Original file line number	Diff line number	Diff line change
`@@ -104,7 +104,7 @@ public static function ensureRowTypes(array $rows, array $expectedRowTypes): arr`
`104`	`104`	`}`
`105`	`105`	`break;`
`106`	`106`	`case DatabaseInterface::PARAM_DATETIME:`
`107`		`- $value = new \DateTime($row[$columnIndex]);`
	`107`	`+ $value = new \DateTimeImmutable($row[$columnIndex]);`
`108`	`108`	`break;`
`109`	`109`	`default:`
`110`	`110`	`$value = null;`