feat(install): options to force install or upgrade

Signed-off-by: Thierry Bugier <[email protected]>

Author: btry

hook.php

@@ -37,8 +37,18 @@ function plugin_flyvemdm_install() {
    $migration = new Migration($version['version']);
    require_once(PLUGIN_FLYVEMDM_ROOT . "/install/install.class.php");
    spl_autoload_register([PluginFlyvemdmInstall::class, 'autoload']);
+   $forceInstall = false;
+   $forceUpgrade = false;
+   if (isCommandLine()) {
+      if (array_search('--force-install', $_SERVER['argv'])) {
+         $forceInstall = true;
+      }
+      if (array_search('--force-upgrade', $_SERVER['argv'])) {
+         $forceUpgrade = true;
+      }
+   }
    $install = new PluginFlyvemdmInstall();
-   if (!$install->isPluginInstalled()) {
+   if ($forceInstall || !$install->isPluginInstalled() && !$forceUpgrade) {
       return $install->install($migration);
    }
    return $install->upgrade($migration);

install/install.class.php

@@ -49,6 +49,22 @@ class PluginFlyvemdmInstall {
 
    protected $migration;
 
+   /**
+    * array of upgrade steps key => value
+    * key   is the version to upgrade from
+    * value is the version to upgrade to
+    *
+    * Exemple: an entry '2.0' => '2.1' tells that versions 2.0
+    * are upgradable to 2.1
+    *
+    * @var array
+    */
+   private $upgradeSteps = [
+      '0.0' => '2.0',
+      // '2.0' => '2.1',
+      // '2.1 => '3.0',
+   ];
+
    /**
     * Autoloader for installation
     * @param string $classname
@@ -472,30 +488,26 @@ public function createNotificationTargetInvitation() {
     *
     * @param string version to upgrade from
     */
-   public function upgrade(Migration $migration) {
+   public function upgrade(Migration $migration, $forceUpgrade = false) {
       spl_autoload_register([__CLASS__, 'autoload']);
 
       $this->migration = $migration;
-      $fromSchemaVersion = $this->getSchemaVersion();
+      if ($forceUpgrade) {
+         // Might return false
+         $fromSchemaVersion = array_search(PLUGIN_FLYVEMDM_SCHEMA_VERSION, $this->upgradeSteps);
+      } else {
+         $fromSchemaVersion = $this->getSchemaVersion();
+      }
 
       // Prevent problem of execution time
       ini_set("max_execution_time", "0");
       ini_set("memory_limit", "-1");
 
-      switch ($fromSchemaVersion) {
-         case '0.0':
-            // Upgrade to 2.0
-            $this->upgradeOneStep('2.0');
-
-         case '2.0':
-            // Example : upgrade to version 2.1
-            // $this->upgradeOneStep('2.1');
-
-         case '3.0':
-            // Example : upgrade to version 3.0
-            // $this->upgradeOneStep('3.0');
-
+      while ($fromSchemaVersion && isset($this->upgradeSteps[$fromSchemaVersion])) {
+         $this->upgradeOneStep($this->upgradeSteps[$fromSchemaVersion]);
+         $fromSchemaVersion = $this->upgradeSteps[$fromSchemaVersion];
       }
+
       if (!PLUGIN_FLYVEMDM_IS_OFFICIAL_RELEASE) {
          $this->upgradeOneStep('develop');
       }

tools/cli_install.php

@@ -39,7 +39,7 @@
 cli_install.php
 
 Usage:
-   cli_install.php [--as-user USER] [--api-user-token APITOKEN] [--enable-api ] [--enable-email ] [ --tests ] [--dev] [--mqtt-address MQTTADDRESS] [--mqtt-internal-address MQTTINTERNALADDRESS] [--mqtt-port MQTTPORT] [--mqtt-port-tls MQTTPORTTLS]
+   cli_install.php [--as-user USER] [--api-user-token APITOKEN] [--enable-api ] [--enable-email ] [ --tests ] [--dev] [--mqtt-address MQTTADDRESS] [--mqtt-internal-address MQTTINTERNALADDRESS] [--mqtt-port MQTTPORT] [--mqtt-port-tls MQTTPORTTLS] [--force-install | --force-upgrade]
 
 Options:
    --as-user USER                               Do install/upgrade as specified USER. If not provided, 'glpi' user will be used
@@ -52,6 +52,8 @@
    --mqtt-internal-address MQTTINTERNALADDRESS  Sets the Internal address for Mosquitto MQTTINTERNALADDRESS. This parameter can be [ IP Address/Hostname ]
    --mqtt-port MQTTPORT                         Sets the Listen Port for Mosquitto MQTTPORT
    --mqtt-port-tls MQTTPORTTLS                  Sets the Listen Port TLS for Mosquitto MQTTPORTTLS
+   --force-install                              Force a fresh install
+   --force-upgrade                              Force upgrade from the latest previous version
 
 DOC;