Include state detection in VersionData

Author: markrandall

releases/states.php

@@ -3,32 +3,22 @@
 # Please use /releases/branches.php instead.
 # This API *may* be removed at an indeterminate point in the future.
 
-$_SERVER['BASE_PAGE'] = 'releases/active.php';
+use phpweb\Releases\VersionData;
 
+$_SERVER['BASE_PAGE'] = 'releases/active.php';
 include_once __DIR__ . '/../include/prepend.inc';
-include_once $_SERVER['DOCUMENT_ROOT'] . '/include/branches.inc';
 
 header('Content-Type: application/json; charset=UTF-8');
 
 $states = [];
 
-function formatDate($date = null) {
-    return $date !== null ? $date->format('c') : null;
+foreach (VersionData::all() as $release) {
+    $states[$release->majorVersion][$release->label] = [
+        'state' => $release->supportState->value,
+        'initial_release' => $release->releaseDate?->format('c'),
+        'active_support_end' => $release->bugfixEOL?->format('c'),
+        'security_support_end' => $release->securityEOL?->format('c'),
+    ];
 }
 
-foreach (get_all_branches() as $major => $releases) {
-    $states[$major] = [];
-    foreach ($releases as $branch => $release) {
-        $states[$major][$branch] = [
-            'state' => get_branch_support_state($branch),
-            'initial_release' => formatDate(get_branch_release_date($branch)),
-            'active_support_end' => formatDate(get_branch_bug_eol_date($branch)),
-            'security_support_end' => formatDate(get_branch_security_eol_date($branch)),
-        ];
-    }
-    krsort($states[$major]);
-}
-
-krsort($states);
-
 echo json_encode($states);

src/Releases/SupportState.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace phpweb\Releases;
+
+enum SupportState: string
+{
+    case Future = 'future';
+    case Stable = 'stable';
+    case Security = 'security';
+    case Eol = 'eol';
+    case Unknown = 'unknown';
+}

src/Releases/VersionData.php

@@ -2,15 +2,21 @@
 
 namespace phpweb\Releases;
 
+use DateTime;
 use DateTimeImmutable;
 use phpweb\Build\VarCache;
 use function array_key_last;
 use function array_reverse;
 use function get_active_branches;
-use function get_all_branches;
 use function get_branch_bug_eol_date;
+use function get_branch_release_date;
 use function get_branch_security_eol_date;
 
+/* have to force these files to be included */
+require_once __DIR__ . '/../../include/version.inc';
+require_once __DIR__ . '/../../include/releases.inc';
+require_once __DIR__ . '/../../include/branches.inc';
+
 final class VersionData
 {
     /** @var array<string, VersionData>  */
@@ -22,8 +28,12 @@ final class VersionData
     public readonly int $majorVersion;
     public readonly int $minorVersion;
 
+    /*
+     * Cached values that have expensive lookups
+     */
     private ?DateTimeImmutable $_bugfixEOL = null;
     private ?DateTimeImmutable $_securityEOL = null;
+    private ?DateTimeImmutable $_releaseDate = null;
     private ?array $_pointReleases = null;
     private ?array $_highlightSnippets = null;
 
@@ -64,34 +74,29 @@ public static function getSupportedVersions(bool $includeRecentEOL = true): arra
     public static function all(): array
     {
         if (self::$_all === null) {
-            foreach (get_all_branches() as $branch) {
-                self::$_all[$branch] = self::Create($branch['version']);
+            foreach (array_keys(ReleaseRawDataLoader::allReleaseDataByVersionByLabel()) as $releaseId) {
+                self::$_all[$releaseId] = self::Create($releaseId);
             }
         }
 
         return self::$_all;
     }
 
-    public ?DateTimeImmutable $bugfixEOL {
-        get {
-            if ($this->_bugfixEOL === null) {
-                $eol = get_branch_bug_eol_date($this->label);
-                $this->_bugfixEOL = $eol ? DateTimeImmutable::createFromInterface($eol) : null;
-            }
+    private static function castDate(?DateTime $date): ?DateTimeImmutable
+    {
+        return $date ? DateTimeImmutable::createFromInterface($date) : null;
+    }
 
-            return $this->_bugfixEOL;
-        }
+    public ?DateTimeImmutable $releaseDate {
+        get => $this->_releaseDate ??= self::castDate(get_branch_release_date($this->label));
     }
 
-    public ?DateTimeImmutable $securityEOL {
-        get {
-            if ($this->_securityEOL === null) {
-                $eol = get_branch_security_eol_date($this->label);
-                $this->_securityEOL = $eol ? DateTimeImmutable::createFromInterface($eol) : null;
-            }
+    public ?DateTimeImmutable $bugfixEOL {
+        get => $this->_bugfixEOL ??= self::castDate(get_branch_bug_eol_date($this->label));
+    }
 
-            return $this->_securityEOL;
-        }
+    public ?DateTimeImmutable $securityEOL {
+        get => $this->_securityEOL ??= self::castDate(get_branch_security_eol_date($this->label));
     }
 
     public string $logoUrl {
@@ -174,4 +179,29 @@ public function getMajorFeatureDescriptions(): array
     public string $downloadUri {
         get => '/downloads.php?version=' . $this->label;
     }
+
+    public SupportState $supportState {
+        get {
+            /* version 3 doesn't really exist in the data, so we assign it EOL */
+            if ($this->majorVersion <= 3) {
+                return SupportState::Eol;
+            }
+
+            $now = new DateTime();
+
+            if ($this->securityEOL && $now >= $this->securityEOL) {
+                return SupportState::Eol;
+            }
+
+            if ($this->bugfixEOL && $now >= $this->bugfixEOL) {
+                return SupportState::Security;
+            }
+
+            if ($this->releaseDate && $now >= $this->releaseDate) {
+                return SupportState::Stable;
+            }
+
+            return SupportState::Future;
+        }
+    }
 }