feat: added API to update the database (#2492)

docs/update.md

@@ -1,12 +1,12 @@
 # 3. Update
 
-First, please download the latest package of phpMyFAQ. Upgrading to phpMyFAQ 3.3.x is possible from the following
+First, please download the latest package of phpMyFAQ. Upgrading to phpMyFAQ 4.0 is possible from the following
 versions:
 
 - phpMyFAQ 3.0.x
 - phpMyFAQ 3.1.x
 - phpMyFAQ 3.2.x
-- phpMyFAQ 3.3.x
+- phpMyFAQ 4.0.x
 
 If you're running an older version of phpMyFAQ than listed above, we recommend a new and fresh installation. If you need
 support for updating an old FAQ from the 1.x or 2.x series, [please email us](thorsten_AT_phpmyfaq_DOT_de).
@@ -76,7 +76,7 @@ URL in your browser:
 Choose your installed phpMyFAQ version and click the button of the update script, your version will automatically be
 updated.
 
-## Upgrading from phpMyFAQ 3.3.x
+## Upgrading from phpMyFAQ 4.0.x
 
 Please make a full backup before you run the upgrade!
 First, log in as admin into the admin section and enable the maintenance mode.

mkdocs.yml

@@ -1,4 +1,4 @@
-site_name: phpMyFAQ v3.3
+site_name: phpMyFAQ v4.0
 theme:
   name: readthedocs
   highlightjs: true

nginx.conf

@@ -142,6 +142,7 @@ server {
             rewrite admin/api/extract-package              /admin/api/index.php last;
             rewrite admin/api/create-temporary-backup      /admin/api/index.php last;
             rewrite admin/api/install-package              /admin/api/index.php last;
+            rewrite admin/api/update-database              /admin/api/index.php last;
 
             # REST API v2.0
             # * http://[...]/api/v2.0/<ACTION>

phpmyfaq/.htaccess

@@ -152,6 +152,7 @@ RewriteRule admin/api/download-package             admin/api/index.php
 RewriteRule admin/api/extract-package              admin/api/index.php
 RewriteRule admin/api/create-temporary-backup      admin/api/index.php
 RewriteRule admin/api/install-package              admin/api/index.php
+RewriteRule admin/api/update-database              admin/api/index.php
 
 # REST API v2.0
 # * http://[...]/api/v2.0/<ACTION>

phpmyfaq/src/admin-routes.php

@@ -97,4 +97,15 @@
     )
 );
 
+$routes->add(
+    'admin.api.update-database',
+    new Route(
+        '/update-database',
+        [
+            '_controller' => [UpdateController::class, 'updateDatabase'],
+            '_methods' => 'POST'
+        ]
+    )
+);
+
 return $routes;

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

@@ -23,6 +23,7 @@
 use phpMyFAQ\Configuration;
 use phpMyFAQ\Core\Exception;
 use phpMyFAQ\Filter;
+use phpMyFAQ\Setup\Update;
 use phpMyFAQ\Setup\Upgrade;
 use phpMyFAQ\System;
 use phpMyFAQ\Translation;
@@ -245,4 +246,28 @@ public function installPackage(): StreamedResponse
             }
         });
     }
+
+    #[Route('admin/api/update-database')]
+    public function updateDatabase(): StreamedResponse
+    {
+        $configuration = Configuration::getConfigurationInstance();
+        $update = new Update(new System(), $configuration);
+        $update->setVersion(System::getVersion());
+
+        return new StreamedResponse(function () use ($update) {
+            $progressCallback = function ($progress) {
+                echo json_encode(['progress' => $progress]) . "\n";
+                ob_flush();
+                flush();
+            };
+
+            try {
+                if ($update->applyUpdates($progressCallback)) {
+                    echo json_encode(['message' => '✅ Database successfully updated.']);
+                }
+            } catch (Exception $e) {
+                echo json_encode(['message' => 'Update database failed: ' . $e->getMessage()]);
+            }
+        });
+    }
 }

phpmyfaq/src/phpMyFAQ/Database/Mysqli.php

@@ -294,8 +294,8 @@ public function nextId(string $table, string $id): int
     /**
      * This function sends a query to the database.
      *
-     *
      * @return mysqli_result $result
+     * @throws Exception
      */
     public function query(string $query, int $offset = 0, int $rowcount = 0): mixed
     {
@@ -305,7 +305,11 @@ public function query(string $query, int $offset = 0, int $rowcount = 0): mixed
             $query .= sprintf(' LIMIT %d,%d', $offset, $rowcount);
         }
 
-        $result = $this->conn->query($query);
+        try {
+            $result = $this->conn->query($query);
+        } catch (mysqli_sql_exception $exception) {
+            throw new Exception($exception->getMessage());
+        }
 
         if (false === $result) {
             $this->sqllog .= $this->conn->errno . ': ' . $this->error();

phpmyfaq/src/phpMyFAQ/Setup/Update.php

@@ -18,6 +18,7 @@
 namespace phpMyFAQ\Setup;
 
 use phpMyFAQ\Configuration;
+use phpMyFAQ\Core\Exception;
 use phpMyFAQ\Database;
 use phpMyFAQ\Database\DatabaseDriver;
 use phpMyFAQ\Enums\ReleaseType;
@@ -56,7 +57,7 @@ public function isConfigTableAvailable(DatabaseDriver $database): bool
         return $database->numRows($result) === 0;
     }
 
-    public function applyUpdates(callable $progressCallback): void
+    public function applyUpdates(callable $progressCallback): bool
     {
         // 3.1 updates
         $this->applyUpdates310Alpha();
@@ -81,6 +82,8 @@ public function applyUpdates(callable $progressCallback): void
 
         // Always the last step: Update version number
         $this->updateVersion();
+
+        return true;
     }
 
     public function optimizeTables(): void
@@ -114,9 +117,13 @@ private function executeQueries(callable $progressCallback): void
             }
         } else {
             foreach ($this->queries as $query) {
-                $this->configuration->getDb()->query($query);
-                if ($progressCallback !== null) {
-                    $progressCallback($query);
+                try {
+                    $this->configuration->getDb()->query($query);
+                    if ($progressCallback !== null) {
+                        $progressCallback($query);
+                    }
+                } catch (Exception $exception) {
+                    throw new Exception($exception->getMessage());
                 }
             }
         }