Enh: Consolidate (is|set)(Database)Installed() to ApplicationTrait

CHANGELOG-DEV.md

@@ -3,6 +3,7 @@ HumHub Changelog
 
 1.16.0 (Unreleased)
 -------------------
+- Enh #6720: Consolidate `isInstalled()`, `setInstalled()`, and `setDatabaseInstalled`
 - Fix #6693: `MigrateController::$migrationPathMap` stored rolling sum of migrations 
 - Enh #6697: Make state badge customizable
 - Fix #6636: Module Manager test

MIGRATE-DEV.md

@@ -11,6 +11,8 @@ Version 1.16 (Unreleased)
 - `\humhub\modules\content\components\ContentAddonActiveRecord::canWrite()`
 - `\humhub\modules\file\models\File::canRead()` use `canView()` instead
 - `\humhub\modules\content\components\ContentAddonActiveRecord::canRead()` use `canView()` instead
+- `\humhub\models\Setting::isInstalled()` use `Yii::$app->isInstalled()` instead
+- `\humhub\libs\BaseSettingsManager::isDatabaseInstalled()` use `Yii::$app->isDatabaseInstalled()` instead
 
 ### Type restrictions
 - `\humhub\modules\comment\models\Comment` on `canDelete()`

protected/humhub/components/ApplicationTrait.php

@@ -1,4 +1,5 @@
 <?php
+
 /*
  * @link      https://www.humhub.org/
  * @copyright Copyright (c) 2023 HumHub GmbH & Co. KG
@@ -7,7 +8,10 @@
 
 namespace humhub\components;
 
+use humhub\helpers\DatabaseHelper;
 use humhub\interfaces\MailerInterface;
+use humhub\libs\DynamicConfig;
+use Yii;
 use yii\helpers\Url;
 
 trait ApplicationTrait
@@ -66,4 +70,66 @@ public function getMailer(): MailerInterface
     {
         return parent::getMailer();
     }
+
+    /**
+     * Checks if Humhub is installed
+     *
+     * @return boolean
+     * @since 1.16
+     */
+    public function isInstalled(): bool
+    {
+        return isset(Yii::$app->params['installed']) && Yii::$app->params['installed'];
+    }
+
+    /**
+     * Sets application in installed state (disables installer)
+     *
+     * @since 1.16
+     */
+    public function setInstalled()
+    {
+        $config = DynamicConfig::load();
+        $config['params']['installed'] = true;
+        DynamicConfig::save($config);
+    }
+
+
+    /**
+     * Checks if settings table exists or application is not installed yet
+     *
+     * @since 1.16
+     */
+    public function isDatabaseInstalled(bool $checkConnection = false): bool
+    {
+        $dieOnError = isset(Yii::$app->params['databaseInstalled']) && $this->params['databaseInstalled'];
+
+        if (!$checkConnection) {
+            return $dieOnError;
+        }
+
+        try {
+            $db = Yii::$app->db;
+            $db->open();
+        } catch (\Exception $ex) {
+            if ($dieOnError) {
+                DatabaseHelper::handleConnectionErrors($ex);
+            }
+            return false;
+        }
+
+        return Yii::$app->params['databaseInstalled'] = in_array('setting', $db->schema->getTableNames());
+    }
+
+    /**
+     * Sets the application database in installed state
+     *
+     * @since 1.16
+     */
+    public function setDatabaseInstalled()
+    {
+        $config = DynamicConfig::load();
+        $config['params']['databaseInstalled'] = true;
+        DynamicConfig::save($config);
+    }
 }

protected/humhub/components/Controller.php

@@ -11,7 +11,6 @@
 use humhub\components\access\ControllerAccess;
 use humhub\components\access\StrictAccess;
 use humhub\components\behaviors\AccessControl;
-use humhub\models\Setting;
 use humhub\modules\user\services\IsOnlineService;
 use Yii;
 use yii\helpers\Html;
@@ -28,7 +27,6 @@
  */
 class Controller extends \yii\web\Controller
 {
-
     /**
      * @event \yii\base\Event an event raised on init a controller.
      */
@@ -121,6 +119,7 @@ public function renderAjaxContent($content)
      * Renders a string as Ajax including assets without end page so it can be called several times.
      *
      * @param string $content
+     *
      * @return string Rendered content
      */
     public function renderAjaxPartial(string $content): string
@@ -132,6 +131,7 @@ public function renderAjaxPartial(string $content): string
      * Renders a static string by applying the layouts (sublayout + layout.
      *
      * @param string $content the static string being rendered
+     *
      * @return string the rendering result of the layout with the given static string as the `$content` variable.
      * If the layout is disabled, the string will be returned back.
      *
@@ -223,7 +223,7 @@ public function beforeAction($action)
             if (!Yii::$app->request->isAjax || Yii::$app->request->isPjax) {
                 $this->setJsViewStatus();
 
-                if (Setting::isInstalled()) {
+                if (Yii::$app->isInstalled()) {
                     // Update "is online" status ony on full page loads
                     (new IsOnlineService(Yii::$app->user->identity))->updateStatus();
                 }
@@ -313,6 +313,7 @@ public function setJsViewStatus()
      * Check if action cannot be intercepted
      *
      * @param string|null $actionId , NULL - to use current action
+     *
      * @return bool
      * @since 1.9
      */

protected/humhub/components/Migration.php

@@ -8,7 +8,6 @@
 
 namespace humhub\components;
 
-use humhub\models\Setting;
 use humhub\modules\like\activities\Liked;
 use humhub\modules\like\models\Like;
 use Throwable;
@@ -76,6 +75,7 @@ public function down()
      * Helper function for self::up() and self::down()
      *
      * @param array $action
+     *
      * @return bool|null
      * @since 1.15.0
      */
@@ -127,6 +127,7 @@ protected function saveUpDown(array $action): ?bool
      * @param string $table
      * @param $columns
      * @param string|null $options
+     *
      * @return bool indicates if the table has been created
      * @see static::createTable()
      * @noinspection PhpMissingReturnTypeInspection
@@ -147,6 +148,7 @@ protected function safeCreateTable(string $table, $columns, ?string $options = n
 
     /**
      * @param string $table
+     *
      * @return bool indicates if the table has been dropped
      * @see static::dropTable()
      * @noinspection PhpUnused
@@ -171,6 +173,7 @@ protected function safeDropTable(string $table)
      *
      * @param string $column
      * @param string $table
+     *
      * @return bool
      * @since 1.9.1
      */
@@ -226,6 +229,7 @@ protected function safeAddColumn(string $table, string $column, $type)
      *
      * @param string $index
      * @param string $table
+     *
      * @return bool
      * @throws Exception
      * @since 1.9.1
@@ -242,6 +246,7 @@ protected function indexExists(string $index, string $table): bool
      *
      * @param string $index
      * @param string $table
+     *
      * @return bool
      * @throws Exception
      * @since 1.9.1
@@ -263,6 +268,7 @@ protected function foreignIndexExists(string $index, string $table): bool
      * @param string $table
      * @param string|array $columns
      * @param bool $unique
+     *
      * @return bool indicates if the index has been created
      * @throws Exception
      * @since 1.9.1
@@ -288,6 +294,7 @@ protected function safeCreateIndex(string $index, string $table, $columns, bool
      *
      * @param string $index
      * @param string $table
+     *
      * @return bool indicates if the index has been dropped
      * @throws Exception
      * @since 1.9.1
@@ -315,6 +322,7 @@ protected function safeDropIndex(string $index, string $table)
      * @param string $index
      * @param string $table
      * @param string|array $columns
+     *
      * @return bool indicates if key has been added
      * @throws Exception
      * @since 1.9.1
@@ -372,6 +380,7 @@ protected function safeDropPrimaryKey(string $index, string $table)
      * @param string|array $refColumns
      * @param string|null $delete
      * @param string|null $update
+     *
      * @return bool indicates if key has been added
      * @throws Exception
      * @since 1.9.1
@@ -397,6 +406,7 @@ protected function safeAddForeignKey(string $index, string $table, $columns, str
      *
      * @param string $index
      * @param string $table
+     *
      * @return bool indicates if key has been dropped
      * @throws Exception
      * @since 1.9.1
@@ -483,15 +493,15 @@ public function safeAddForeignKeyCreatedBy()
     public function integerReferenceKey(): ColumnSchemaBuilder
     {
         return $this->integer(11)
-            ->notNull()
-            ;
+            ->notNull();
     }
 
     /**
      * Returns the field configuration for a timestamp field that does not get automatically updated by mysql in case it
      * being the first timestamp column in the table.
      *
      * @param $precision
+     *
      * @return ColumnSchemaBuilder
      * @since 1.15
      * @see https://dev.mysql.com/doc/refman/8.0/en/timestamp-initialization.html
@@ -516,6 +526,7 @@ public function timestampWithoutAutoUpdate($precision = null): ColumnSchemaBuild
      *
      * @param string $oldClass
      * @param string $newClass
+     *
      * @throws Exception
      */
     protected function renameClass(string $oldClass, string $newClass): void
@@ -561,6 +572,7 @@ protected function renameClass(string $oldClass, string $newClass): void
      * @param array|string $condition the conditions that will be put in the WHERE part. Please
      * refer to [[Query::where()]] on how to specify conditions.
      * @param array|Traversable $params the parameters to be bound to the query.
+     *
      * @throws Exception
      */
     public function updateSilent(string $table, $columns, $condition = '', $params = []): void
@@ -571,8 +583,10 @@ public function updateSilent(string $table, $columns, $condition = '', $params =
     /**
      * Creates and executes an INSERT SQL statement without any output
      * The method will properly escape the column names, and bind the values to be inserted.
+     *
      * @param string $table the table that new rows will be inserted into.
      * @param array|Traversable $columns the column data (name => value) to be inserted into the table.
+     *
      * @throws Exception
      */
     public function insertSilent(string $table, $columns): void
@@ -588,14 +602,16 @@ public function insertSilent(string $table, $columns): void
      */
     protected function isInitialInstallation(): bool
     {
-        return (!Setting::isInstalled());
+        return (!Yii::$app->isInstalled());
     }
 
     /**
      * Get data from database dsn config
      *
      * @since 1.9.3
+     *
      * @param string $name 'host', 'port', 'dbname'
+     *
      * @return string|null
      */
     private function getDsnAttribute(string $name): ?string
@@ -608,6 +624,7 @@ private function getDsnAttribute(string $name): ?string
     /**
      * @param string $message Message to be logged
      * @param array $params Parameters to translate in $message
+     *
      * @return void
      * @since 1.15.0
      */
@@ -619,6 +636,7 @@ protected function logError(string $message, array $params = []): void
     /**
      * @param string $message Message to be logged
      * @param array $params Parameters to translate in $message
+     *
      * @return void
      * @since 1.15.0
      */
@@ -630,6 +648,7 @@ protected function logWarning(string $message, array $params = []): void
     /**
      * @param string $message Message to be logged
      * @param array $params Parameters to translate in $message
+     *
      * @return void
      * @since 1.15.0
      * @noinspection PhpUnused
@@ -642,6 +661,7 @@ protected function logInfo(string $message, array $params = []): void
     /**
      * @param string $message Message to be logged
      * @param array $params Parameters to translate in $message
+     *
      * @return void
      * @since 1.15.0
      */
@@ -656,6 +676,7 @@ protected function logDebug(string $message, array $params = []): void
      *
      * @param string $message Message to be logged
      * @param array $params Parameters to translate in $message
+     *
      * @return void
      * @since 1.15.0
      */
@@ -680,6 +701,7 @@ protected function logTranslation(string $message, array $params = []): string
      *
      * @param Throwable $e The Throwable to be logged
      * @param string $method The Method that was running
+     *
      * @since 1.15.0
      */
     protected function logException(Throwable $e, string $method): void