feat: added nightly and release paths for downloads (#2492)

Author: thorsten

phpmyfaq/admin/assets/src/configuration/upgrade.js

@@ -63,7 +63,7 @@ export const handleCheckForUpdates = () => {
   if (downloadButton) {
     downloadButton.addEventListener('click', (event) => {
       event.preventDefault();
-      fetch(window.location.pathname + 'api/download-package/3.2.1', {
+      fetch(window.location.pathname + 'api/download-package/nightly', {
         method: 'POST',
         headers: {
           Accept: 'application/json, text/plain, */*',

phpmyfaq/admin/upgrade.php

@@ -17,8 +17,6 @@
 
 use phpMyFAQ\Configuration;
 use phpMyFAQ\Enums\ReleaseType;
-use phpMyFAQ\Setup\Upgrade;
-use phpMyFAQ\System;
 use phpMyFAQ\Template\TwigWrapper;
 use phpMyFAQ\Translation;
 use phpMyFAQ\User\CurrentUser;
@@ -44,8 +42,6 @@
         'dateLastChecked' => $faqConfig->get('upgrade.dateLastChecked')
     ];
 
-    $upgrade = new Upgrade(new System(), $faqConfig);
-
     echo $template->render($templateVars);
 } else {
     require 'no-permission.php';

phpmyfaq/src/phpMyFAQ/Controller/Administration/UpdateController.php

@@ -104,9 +104,15 @@ public function downloadPackage(Request $request): JsonResponse
         $versionNumber = Filter::filterVar($request->get('versionNumber'), FILTER_SANITIZE_SPECIAL_CHARS);
 
         $upgrade = new Upgrade(new System(), Configuration::getConfigurationInstance());
+        $upgrade->setIsNightly(true);
         $result = $upgrade->downloadPackage($versionNumber);
 
-        $response->setData(['success' => $result]);
+        if ($result !== false) {
+            $response->setStatusCode(Response::HTTP_OK);
+            $response->setData(['success' => $result]);
+        } else {
+            $response->setStatusCode(Response::HTTP_BAD_GATEWAY);
+        }
 
         return $response;
     }

phpmyfaq/src/phpMyFAQ/Enums/DownloadHostType.php

@@ -19,6 +19,6 @@
 
 enum DownloadHostType: string
 {
-    case GITHUB = 'https://github.com/thorsten/phpMyFAQ/releases/download/';
+    case GITHUB = 'https://github.com/';
     case PHPMYFAQ = 'https://download.phpmyfaq.de/';
 }

phpmyfaq/src/phpMyFAQ/Setup/Upgrade.php

@@ -16,6 +16,7 @@
 
 namespace phpMyFAQ\Setup;
 
+use JsonException;
 use Monolog\Level;
 use phpMyFAQ\Configuration;
 use phpMyFAQ\Enums\DownloadHostType;
@@ -31,6 +32,12 @@
 
 class Upgrade extends Setup
 {
+    public const GITHUB_PATH = 'thorsten/phpMyFAQ/releases/download/development-nightly-%s/';
+    private const GITHUB_FILENAME = 'phpMyFAQ-nightly-%s.zip';
+    private const PHPMYFAQ_FILENAME = 'phpMyFAQ-%s.zip';
+
+    private $isNightly = false;
+
     public function __construct(protected System $system, private readonly Configuration $configuration)
     {
         parent::__construct($this->system);
@@ -49,14 +56,14 @@ public function checkFilesystem(): bool
             }
         }
         if (
-            is_dir(PMF_CONTENT_DIR . '\user\attachments') && is_dir(PMF_CONTENT_DIR . '\user\images') && is_dir(
-                PMF_CONTENT_DIR . '\core\data'
-            ) && is_dir(PMF_ROOT_DIR . '\assets\themes')
+            is_dir(PMF_CONTENT_DIR . '\user\attachments') &&
+            is_dir(PMF_CONTENT_DIR . '\user\images') &&
+            is_dir(PMF_CONTENT_DIR . '\core\data') &&
+            is_dir(PMF_ROOT_DIR . '\assets\themes')
         ) {
             if (
-                is_file(PMF_CONTENT_DIR . '\core\config\constants.php') && is_file(
-                    PMF_CONTENT_DIR . '\core\config\database.php'
-                )
+                is_file(PMF_CONTENT_DIR . '\core\config\constants.php') &&
+                is_file(PMF_CONTENT_DIR . '\core\config\database.php')
             ) {
                 if ($this->configuration->isElasticsearchActive()) {
                     if (!is_file(PMF_CONTENT_DIR . '\core\config\elasticsearch.php')) {
@@ -92,8 +99,7 @@ public function checkFilesystem(): bool
      */
     public function downloadPackage(string $version): string|bool
     {
-        $zipFile = 'phpMyFAQ-' . $version . '.zip';
-        $url = DownloadHostType::PHPMYFAQ->value . $zipFile;
+        $url = $this->getDownloadHost() . $this->getPath() . $this->getFilename($version);
 
         $client = HttpClient::create();
 
@@ -106,9 +112,9 @@ public function downloadPackage(string $version): string|bool
 
             $package = $response->getContent();
 
-            file_put_contents(PMF_CONTENT_DIR . '/upgrades/' . $zipFile, $package);
+            file_put_contents(PMF_CONTENT_DIR . '/upgrades/' . $this->getFilename($version), $package);
 
-            return PMF_CONTENT_DIR . '/upgrades/' . $zipFile;
+            return PMF_CONTENT_DIR . '/upgrades/' . $this->getFilename($version);
         } catch (
             TransportExceptionInterface |
             ClientExceptionInterface |
@@ -124,10 +130,10 @@ public function downloadPackage(string $version): string|bool
     /**
      * Method to verify the downloaded phpMyFAQ package
      *
-     * @return bool
-     * @throws TransportExceptionInterface|ClientExceptionInterface|RedirectionExceptionInterface|ServerExceptionInterface|JsonException
      * @param string $path | Path to zip file
      * @param string $version | Version to verify
+     * @return bool
+     * @throws TransportExceptionInterface|ClientExceptionInterface|RedirectionExceptionInterface|ServerExceptionInterface|JsonException
      */
     public function verifyPackage(string $path, string $version): bool
     {
@@ -161,7 +167,6 @@ public function verifyPackage(string $path, string $version): bool
      *
      * @return bool
      * @param string $path | Path of the package
-     * @throws ZipException
      */
     public function unpackPackage(string $path): bool
     {
@@ -187,7 +192,6 @@ public function unpackPackage(string $path): bool
      *
      * @param string $backupName | Name of the created backup
      * @return bool
-     * @throws ZipException
      */
     public function createTemporaryBackup(string $backupName): bool
     {
@@ -240,4 +244,60 @@ public function restoreTemporaryBackup()
     public function installPackage()
     {
     }
+
+    /**
+     * Returns the host for download packages, so either github.com or download.phpmyfaq.de
+     * @return string
+     */
+    public function getDownloadHost(): string
+    {
+        if ($this->isNightly()) {
+            return DownloadHostType::GITHUB->value;
+        }
+
+        return DownloadHostType::PHPMYFAQ->value;
+    }
+
+    /**
+     * Returns the path to the download package, it's an empty string for development and production releases
+     * @return string
+     */
+    public function getPath(): string
+    {
+        if ($this->isNightly()) {
+            return sprintf(self::GITHUB_PATH, date('Y-m-d', strtotime('-1 days')));
+        }
+
+        return '';
+    }
+
+    /**
+     * Returns the filename of the download package
+     * @param string $version
+     * @return string
+     */
+    public function getFilename(string $version): string
+    {
+        if ($this->isNightly()) {
+            return sprintf(self::GITHUB_FILENAME, date('Y-m-d', strtotime('-1 days')));
+        }
+
+        return sprintf(self::PHPMYFAQ_FILENAME, $version);
+    }
+
+    /**
+     * @return bool
+     */
+    public function isNightly(): bool
+    {
+        return $this->isNightly;
+    }
+
+    /**
+     * @param bool $isNightly
+     */
+    public function setIsNightly(bool $isNightly): void
+    {
+        $this->isNightly = $isNightly;
+    }
 }

tests/phpMyFAQ/Setup/UpgradeTest.php

@@ -4,6 +4,7 @@
 
 use phpMyFAQ\Configuration;
 use phpMyFAQ\Database\Sqlite3;
+use phpMyFAQ\Enums\DownloadHostType;
 use phpMyFAQ\System;
 use PHPUnit\Framework\TestCase;
 
@@ -58,4 +59,32 @@ public function testInstallPackage(): void
     {
         $this->markTestSkipped();
     }
+    public function testGetDownloadHostForNightly(): void
+    {
+        $this->upgrade->setIsNightly(true);
+
+        $this->assertEquals(DownloadHostType::GITHUB->value, $this->upgrade->getDownloadHost());
+    }
+
+    public function testGetDownloadHostForNonNightly(): void
+    {
+        $this->upgrade->setIsNightly(false);
+
+        $this->assertEquals(DownloadHostType::PHPMYFAQ->value, $this->upgrade->getDownloadHost());
+    }
+
+    public function testGetPathForNightly(): void
+    {
+        $this->upgrade->setIsNightly(true);
+
+        $expectedPath = sprintf(Upgrade::GITHUB_PATH, date('Y-m-d', strtotime('-1 days')));
+        $this->assertEquals($expectedPath, $this->upgrade->getPath());
+    }
+
+    public function testGetPathForNonNightly(): void
+    {
+        $this->upgrade->setIsNightly(false);
+
+        $this->assertEquals('', $this->upgrade->getPath());
+    }
 }