feat(api): implement endpoint to update centreon web (#11391)

Refs: MON-12296

ci/debian/centreon-web.postinst

@@ -54,4 +54,10 @@ if [ "$1" = "configure" ] ; then
   fi
 
 fi
+
+# rebuild symfony cache on upgrade
+if [ -n "$2" ]; then
+  su - www-data -s /bin/bash -c "/usr/share/centreon/bin/console cache:clear --no-warmup"
+fi
+
 exit 0

composer.json

@@ -65,6 +65,7 @@
         "symfony/framework-bundle": "5.4.*",
         "symfony/http-client": "5.4.*",
         "symfony/http-kernel": "5.4.*",
+        "symfony/lock": "5.4.*",
         "symfony/maker-bundle": "^1.11",
         "symfony/monolog-bundle": "^3.7",
         "symfony/options-resolver": "5.4.*",

config/packages/Centreon.yaml

@@ -220,6 +220,42 @@ services:
         class: Core\Infrastructure\Platform\Repository\FileReadPlatformRepository
         arguments: ['%centreon_etc_path%', '%centreon_install_path%']
 
+    Core\Platform\Application\Validator\RequirementValidatorsInterface:
+        class: Core\Platform\Infrastructure\Validator\RequirementValidators
+        arguments:
+            $requirementValidators: !tagged_iterator 'platform.requirement.validators'
+
+    Core\Platform\Infrastructure\Validator\RequirementValidators\DatabaseRequirementValidator:
+        arguments:
+            $dbRequirementValidators: !tagged_iterator 'platform.requirement.database.validators'
+
+    Core\Platform\Infrastructure\Validator\RequirementValidators\PhpRequirementValidator:
+        arguments:
+            $requiredPhpVersion: '%required_php_version%'
+
+    Core\Platform\Infrastructure\Validator\RequirementValidators\DatabaseRequirementValidators\MariaDbRequirementValidator:
+        arguments:
+            $requiredMariaDbMinVersion: '%required_mariadb_min_version%'
+
+    Core\Platform\Application\Repository\ReadVersionRepositoryInterface:
+        class: Core\Platform\Infrastructure\Repository\DbReadVersionRepository
+        public: true
+
+    Core\Platform\Application\Repository\ReadUpdateRepositoryInterface:
+        class: Core\Platform\Infrastructure\Repository\FsReadUpdateRepository
+        arguments:
+            $installDir: '%centreon_install_path%'
+        public: true
+
+    Core\Platform\Application\Repository\UpdateLockerRepositoryInterface:
+        class: Core\Platform\Infrastructure\Repository\SymfonyUpdateLockerRepository
+        public: true
+
+    Core\Platform\Application\Repository\WriteUpdateRepositoryInterface:
+        class: Core\Platform\Infrastructure\Repository\DbWriteUpdateRepository
+        arguments: ['%centreon_var_lib%', '%centreon_install_path%']
+        public: true
+
     # Monitoring resources
     _instanceof:
         Core\Infrastructure\RealTime\Hypermedia\HypermediaProviderInterface:
@@ -230,6 +266,10 @@ services:
             tags: ['authentication.provider.responses']
         Core\Security\Infrastructure\Api\FindProviderConfigurations\ProviderPresenter\ProviderPresenterInterface:
             tags: ['authentication.provider.presenters']
+        Core\Platform\Application\Validator\RequirementValidatorInterface:
+            tags: ['platform.requirement.validators']
+        Core\Platform\Infrastructure\Validator\RequirementValidators\DatabaseRequirementValidatorInterface:
+            tags: ['platform.requirement.database.validators']
 
     Core\Resources\Application\Repository\ReadResourceRepositoryInterface:
         class: Core\Resources\Infrastructure\Repository\DbReadResourceRepository

config/routes/Centreon/platform.yaml

@@ -4,6 +4,12 @@ centreon_application_platform_getversion:
   controller: 'Centreon\Application\Controller\PlatformController::getVersions'
   condition: "request.attributes.get('version') >= 21.10"
 
+centreon_application_platform_updateversions:
+  methods: PATCH
+  path: /platform/updates
+  controller: 'Core\Platform\Infrastructure\Api\UpdateVersions\UpdateVersionsController'
+  condition: "request.attributes.get('version') >= 22.04"
+
 centreon_application_platformtopology_addplatformtotopology:
   methods: POST
   path: /platform/topology

config/services.yaml

@@ -22,6 +22,8 @@ parameters:
     media_path: "img/media"
     redirect_default_page: "/monitoring/resources"
     session_expiration_delay: 120
+    required_php_version: "%env(_CENTREON_PHP_VERSION_)%"
+    required_mariadb_min_version: "%env(_CENTREON_MARIA_DB_MIN_VERSION_)%"
 
 services:
     # Default configuration for services in *this* file
@@ -66,6 +68,9 @@ services:
         decorates: router
         arguments: ['@.inner']
 
+    Symfony\Component\Finder\Finder:
+        shared: false
+
 
     # Security
     Security\Domain\Authentication\Interfaces\AuthenticationRepositoryInterface:

doc/API/centreon-api-v22.10.yaml

@@ -3658,6 +3658,8 @@ paths:
                       moduleName:
                         type: object
                         $ref: '#/components/schemas/Platform.Versions'
+  /platform/updates:
+    $ref: "./v22.10/Administration/updates.yaml"
   /platform/installation/status:
     get:
       tags:

doc/API/v22.10/Administration/updates.yaml

@@ -0,0 +1,30 @@
+---
+patch:
+  tags:
+    - Platform
+  summary: "Update Centreon web"
+  description: |
+    Update Centreon web component
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          type: object
+          properties:
+            components:
+              type: array
+              items:
+                type: object
+                properties:
+                  name:
+                    type: string
+                    enum: [ centreon-web ]
+  responses:
+    204:
+      description: "Platform updated"
+    404:
+      description: "Updates not found"
+    500:
+      $ref: "../../centreon-api-v22.10.yaml#/components/responses/InternalServerError"
+...

lang/fr_FR.UTF-8/LC_MESSAGES/messages.po

@@ -16901,6 +16901,48 @@ msgstr "Une erreur s'est produite lors de la récupération des catégories d'h
 msgid "Warning, maximum size exceeded for input '%s' (max: %d), it will be truncated upon saving"
 msgstr "Attention, taille maximale dépassée pour le champ '%s' (max: %d), il sera tronqué à l'enregistrement"
 
+msgid "Update already in progress"
+msgstr "Une mise à jour est déjà en cours"
+
+msgid "An error occurred when retrieving the current version"
+msgstr "Une erreur s'est produite lors de la récupération de la version actuelle"
+
+msgid "Cannot retrieve the current version"
+msgstr "La version actuelle n'a pas pu être récupérée"
+
+msgid "An error occurred when retrieving available updates"
+msgstr "Une erreur s'est produite lors de la récupération des mises à jour disponibles"
+
+msgid "An error occurred when applying the update %s (%s)"
+msgstr "Une erreur s'est produite lors de l'application de la mise à jour %s (%s)"
+
+msgid "Error while locking the update process"
+msgstr "Erreur lors du verrouillage du processus de mise à jour"
+
+msgid "Error while unlocking the update process"
+msgstr "Erreur lors du déverrouillage du processus de mise à jour"
+
+msgid "An error occurred when applying post update actions"
+msgstr "Une erreur s'est produite lors de l'application des actions postérieures à la mise à jour"
+
+msgid "Updates not found"
+msgstr "Les mises à jour n'ont pas été trouvées"
+
+msgid "PHP version %s required (%s installed)"
+msgstr "La version %s de PHP est requise (%s installée)"
+
+msgid "PHP extension %s not loaded"
+msgstr "L'extension %s de PHP n'est pas chargée"
+
+msgid "Error when retrieving the database version"
+msgstr "Erreur lors de la récupération de la version de la base de données"
+
+msgid "Cannot retrieve the database version information"
+msgstr "Les informations de version de la base de données n'ont pas pu être récupérées"
+
+msgid "MariaDB version %s required (%s installed)"
+msgstr "La version %s de MariaDB est requise (%s installée)"
+
 msgid "Service severity"
 msgstr "Criticité du service"
 
@@ -16911,4 +16953,4 @@ msgid "Host severity"
 msgstr "Criticité d'hôte"
 
 msgid "Host severity level"
-msgstr "Niveau de criticité d'hôte"
+msgstr "Niveau de criticité d'hôte"

src/Centreon/Infrastructure/DatabaseConnection.php

@@ -91,4 +91,14 @@ public function setStorageDbName(string $storageDbName)
     {
         $this->storageDbName = $storageDbName;
     }
+
+    /**
+     * switch connection to another database
+     *
+     * @param string $dbName
+     */
+    public function switchToDb(string $dbName): void
+    {
+        $this->query('use ' . $dbName);
+    }
 }

src/Centreon/Infrastructure/Repository/AbstractRepositoryDRB.php

@@ -48,8 +48,8 @@ class AbstractRepositoryDRB
     protected function translateDbName(string $request): string
     {
         return str_replace(
-            array(':dbstg', ':db'),
-            array($this->db->getStorageDbName(), $this->db->getCentreonDbName()),
+            [':dbstg', ':db'],
+            [$this->db->getStorageDbName(), $this->db->getCentreonDbName()],
             $request
         );
     }

src/Core/Platform/Application/Repository/ReadUpdateRepositoryInterface.php

@@ -0,0 +1,34 @@
+<?php
+
+/*
+ * Copyright 2005 - 2022 Centreon (https://www.centreon.com/)
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * For more information : contact@centreon.com
+ *
+ */
+declare(strict_types=1);
+
+namespace Core\Platform\Application\Repository;
+
+interface ReadUpdateRepositoryInterface
+{
+    /**
+     * Get ordered available updates
+     *
+     * @param string $currentVersion
+     * @return string[]
+     */
+    public function findOrderedAvailableUpdates(string $currentVersion): array;
+}

src/Core/Platform/Application/Repository/ReadVersionRepositoryInterface.php

@@ -0,0 +1,33 @@
+<?php
+
+/*
+ * Copyright 2005 - 2022 Centreon (https://www.centreon.com/)
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * For more information : contact@centreon.com
+ *
+ */
+declare(strict_types=1);
+
+namespace Core\Platform\Application\Repository;
+
+interface ReadVersionRepositoryInterface
+{
+    /**
+     * Get current version
+     *
+     * @return string|null
+     */
+    public function findCurrentVersion(): ?string;
+}