@iobroker/js-controller-cli 7.2.5 → 8.0.0-alpha.11-20261103-58da667b3

package/build/cjs/lib/setup/setupInstall.js

@@ -5,6 +5,7 @@ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
 var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
 var __export = (target, all) => {
   for (var name in all)
     __defProp(target, name, { get: all[name], enumerable: true });
@@ -28,28 +29,36 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var setupInstall_exports = {};
 __export(setupInstall_exports, {
-  Install: () => Install
+  Install: () => Install,
+  processCommandDelete: () => processCommandDelete,
+  processCommandInstall: () => processCommandInstall,
+  processCommandUrl: () => processCommandUrl
 });
 module.exports = __toCommonJS(setupInstall_exports);
 var __import_meta_url = typeof document === "undefined" ? new (require("url".replace("", ""))).URL("file:" + __filename).href : document.currentScript && document.currentScript.src || new URL("main.js", document.baseURI).href;
-var import_js_controller_common = require("@iobroker/js-controller-common");
-var import_fs_extra = __toESM(require("fs-extra"), 1);
 var import_node_path = __toESM(require("node:path"), 1);
-var import_semver = __toESM(require("semver"), 1);
 var import_node_child_process = __toESM(require("node:child_process"), 1);
-var import_axios = __toESM(require("axios"), 1);
 var import_node_url = require("node:url");
+var import_node_module = require("node:module");
+var import_axios = __toESM(require("axios"), 1);
+var import_fs_extra = __toESM(require("fs-extra"), 1);
+var import_semver = __toESM(require("semver"), 1);
+var import_js_controller_common = require("@iobroker/js-controller-common");
 var import_setupUpload = require("../../lib/setup/setupUpload.js");
 var import_setupPacketManager = require("../../lib/setup/setupPacketManager.js");
 var import_utils = require("../../lib/setup/utils.js");
 var import_customError = require("../../lib/setup/customError.js");
+var import_dbConnection = require("../../lib/setup/dbConnection.js");
+var CLITools = __toESM(require("../../lib/cli/cliTools.js"), 1);
 var import_constants = require("@iobroker/js-controller-common-db/constants");
-var import_node_module = require("node:module");
 const require2 = (0, import_node_module.createRequire)(__import_meta_url || `file://${__filename}`);
 const hostname = import_js_controller_common.tools.getHostName();
 const osPlatform = process.platform;
 const RECOMMENDED_NPM_VERSION = 8;
 class Install {
+  static {
+    __name(this, "Install");
+  }
   isRootOnUnix;
   objects;
   states;
@@ -58,6 +67,9 @@ class Install {
   tarballRegex;
   upload;
   packetManager;
+  /**
+   * @param options The states/objects clients, CLI parameters and the process-exit callback
+   */
   constructor(options) {
     this.isRootOnUnix = typeof process.getuid === "function" && process.getuid() === 0;
     options = options || {};
@@ -111,7 +123,7 @@ class Install {
     if (!options || typeof options !== "object") {
       options = {};
     }
-    stoppedList = stoppedList || [];
+    stoppedList ||= [];
     let sources;
     if (!repoUrlOrRepo || !import_js_controller_common.tools.isObject(repoUrlOrRepo)) {
       sources = await (0, import_utils.getRepository)({ repoName: repoUrlOrRepo, objects: this.objects });
@@ -432,7 +444,7 @@ class Install {
         obj.from = `system.host.${hostname}.cli`;
         obj.ts = Date.now();
         try {
-          await this.objects.extendObjectAsync(obj._id, obj);
+          await this.objects.extendObject(obj._id, obj);
         } catch (err) {
           console.error(`host.${hostname} error setObject ${obj._id} ${err.message}`);
           return;
@@ -445,8 +457,8 @@ class Install {
    * Installs given adapter
    *
    * @param adapter The adapter name
-   * @param repoUrl
-   * @param _installCount
+   * @param repoUrl Optional repository URL to install the adapter from
+   * @param _installCount Internal recursion counter limiting the number of dependency installs
    */
   async installAdapter(adapter, repoUrl, _installCount) {
     _installCount = _installCount || 0;
@@ -506,6 +518,11 @@ class Install {
     await this.upload.upgradeAdapterObjects(adapter);
     return adapter;
   }
+  /**
+   * Install the OS packages required by an adapter
+   *
+   * @param osDependencies The OS dependencies declared by the adapter, keyed by platform
+   */
   async installOSPackages(osDependencies) {
     if (osPlatform in osDependencies) {
       try {
@@ -517,6 +534,12 @@ class Install {
       }
     }
   }
+  /**
+   * Run the custom install script of an adapter if it defines one
+   *
+   * @param adapter The adapter name
+   * @param config The adapter object containing the install configuration
+   */
   async callInstallOfAdapter(adapter, config) {
     if (config.common.install) {
       let cmd = "node ";
@@ -740,10 +763,10 @@ class Install {
   /**
    * Enumerate all instances of an adapter
    *
-   * @param knownObjIDs
-   * @param notDeleted
-   * @param adapter
-   * @param instance
+   * @param knownObjIDs Accumulator of object IDs found so far
+   * @param notDeleted Accumulator of object IDs that must not be deleted
+   * @param adapter The adapter name
+   * @param instance Optional instance number to restrict the search to
    */
   async _enumerateAdapterInstances(knownObjIDs, notDeleted, adapter, instance) {
     if (!notDeleted) {
@@ -775,9 +798,9 @@ class Install {
   /**
    * Enumerate all meta objects of an adapter
    *
-   * @param knownObjIDs
-   * @param adapter
-   * @param metaFilesToDelete
+   * @param knownObjIDs Accumulator of object IDs found so far
+   * @param adapter The adapter name
+   * @param metaFilesToDelete Accumulator of meta files that should be deleted
    */
   async _enumerateAdapterMeta(knownObjIDs, adapter, metaFilesToDelete) {
     try {
@@ -934,9 +957,9 @@ class Install {
   /**
    * Enumerate all state IDs of an adapter (or instance)
    *
-   * @param knownStateIDs
-   * @param adapter
-   * @param instance
+   * @param knownStateIDs Accumulator of state IDs found so far
+   * @param adapter The adapter name
+   * @param instance Optional instance number to restrict the search to
    */
   async _enumerateAdapterStates(knownStateIDs, adapter, instance) {
     for (const pattern of [
@@ -963,8 +986,8 @@ class Install {
   /**
    * delete WWW pages, objects and meta files
    *
-   * @param adapter
-   * @param metaFilesToDelete
+   * @param adapter The adapter name
+   * @param metaFilesToDelete The meta files that should be deleted
    */
   async _deleteAdapterFiles(adapter, metaFilesToDelete) {
     const filesToDelete = [
@@ -1051,7 +1074,7 @@ class Install {
     const notDeletedObjectIDs = [];
     const knownStateIDs = [];
     let resultCode = import_js_controller_common.EXIT_CODES.NO_ERROR;
-    const _uninstallNpm = async () => {
+    const _uninstallNpm = /* @__PURE__ */ __name(async () => {
       try {
         const adapterNpm = `${import_js_controller_common.tools.appName.toLowerCase()}.${adapter}`;
         const ioPackPath = require2.resolve(`${adapterNpm}/io-package.json`);
@@ -1094,7 +1117,7 @@ class Install {
         console.error(`Error deleting adapter ${adapter} from disk: ${e.message}`);
         console.error(`You might have to delete it yourself!`);
       }
-    };
+    }, "_uninstallNpm");
     try {
       await this._enumerateAdapterInstances(knownObjectIDs, notDeletedObjectIDs, adapter);
       if (notDeletedObjectIDs.length) {
@@ -1103,6 +1126,7 @@ class Install {
         }
         await this._removeCustomFromObjects([adapter]);
         await _uninstallNpm();
+        await this._removePythonEnvironment(adapter);
       } else {
         const dependentInstance = await this._hasDependentInstances(adapter);
         if (dependentInstance) {
@@ -1120,16 +1144,43 @@ class Install {
         await this._deleteAdapterFiles(adapter, metaFilesToDelete);
         await this._deleteAdapterObjects(knownObjectIDs);
         await this._deleteAdapterStates(knownStateIDs);
+        await this._freeUsedResources(adapter);
         if (this.params.custom) {
           await this._removeCustomFromObjects([...instances, adapter]);
         }
         await _uninstallNpm();
+        await this._removePythonEnvironment(adapter);
       }
     } catch (e) {
       console.error(`There was an error uninstalling ${adapter} on ${hostname}: ${e.message}`);
     }
     return resultCode;
   }
+  /**
+   * Remove the virtual environment a Python adapter leaves behind in the data directory
+   *
+   * Host-local state like `node_modules` - rebuildable, but easily a few hundred megabytes - so it goes when
+   * the adapter goes. Deliberately not part of the npm uninstall: that one starts by resolving the adapter's
+   * `io-package.json`, so for a half-removed installation, where the package directory is already gone, it
+   * throws before ever getting here - and that is precisely the case which leaves the environment behind with
+   * nothing pointing at it.
+   *
+   * Removed without looking at `common.platform` for the same reason: the directory only exists for Python
+   * adapters, and the `io-package.json` that would say so may no longer be there.
+   *
+   * @param adapter adapter name, e.g. "pyexample"
+   */
+  async _removePythonEnvironment(adapter) {
+    try {
+      const pythonEnvDir = import_js_controller_common.tools.getPythonEnvDir(adapter);
+      if (await import_fs_extra.default.pathExists(pythonEnvDir)) {
+        await import_fs_extra.default.remove(pythonEnvDir);
+        console.log(`host.${hostname} Python environment "${pythonEnvDir}" deleted`);
+      }
+    } catch (e) {
+      console.error(`Cannot delete the Python environment of ${adapter}: ${e.message}`);
+    }
+  }
   /**
    * Deletes given instance of an adapter
    *
@@ -1153,10 +1204,79 @@ class Install {
     await this._enumerateAdapterDocs(knownObjectIDs, adapter, instance);
     await this._deleteAdapterObjects(knownObjectIDs);
     await this._deleteAdapterStates(knownStateIDs);
+    await this._freeUsedResources(adapter, instance);
     if (this.params.custom) {
       await this._removeCustomFromObjects([`${adapter}.${instance}`]);
     }
   }
+  /**
+   * Free all exclusive resources (serial ports, TCP/UDP ports, ...) the given instance(s) had registered.
+   *
+   * This is needed because an instance can be deleted via the CLI while a js-controller is not running: it
+   * cannot notice that the instance object disappeared, so its `system.host.<host>.usedResources.<type>`
+   * states would keep listing the resources of an instance that no longer exists.
+   *
+   * Hosts that are running are deliberately skipped. Such a host cleans its own registry up when it sees the
+   * instance object being deleted, and it holds the registry in memory: it rewrites the state from that copy
+   * on its next change, which would silently undo a write made here.
+   *
+   * @param adapter adapter name, e.g. "mqtt"
+   * @param instance instance number; if undefined, all instances of the adapter are freed
+   */
+  async _freeUsedResources(adapter, instance) {
+    const matches = /* @__PURE__ */ __name((namespace) => instance !== void 0 ? namespace === `${adapter}.${instance}` : namespace.startsWith(`${adapter}.`), "matches");
+    let keys;
+    try {
+      keys = await this.states.getKeys("system.host.*.usedResources.*");
+    } catch (e) {
+      console.warn(`Cannot read the used resources registry: ${e.message}`);
+      return;
+    }
+    if (!keys?.length) {
+      return;
+    }
+    const hostPrefix = "system.host.";
+    const registryMarker = ".usedResources.";
+    const hostIsRunning = /* @__PURE__ */ new Map();
+    for (const id of keys) {
+      const markerIndex = id.lastIndexOf(registryMarker);
+      if (!id.startsWith(hostPrefix) || markerIndex <= hostPrefix.length) {
+        continue;
+      }
+      const host = id.substring(hostPrefix.length, markerIndex);
+      let isRunning = hostIsRunning.get(host);
+      if (isRunning === void 0) {
+        try {
+          const aliveState = await this.states.getState(`${hostPrefix}${host}.alive`);
+          isRunning = aliveState?.val === true;
+        } catch (e) {
+          console.warn(`Cannot check whether host "${host}" is running: ${e.message}`);
+          isRunning = true;
+        }
+        hostIsRunning.set(host, isRunning);
+      }
+      if (isRunning) {
+        continue;
+      }
+      try {
+        const state = await this.states.getState(id);
+        if (!state || typeof state.val !== "string" || !state.val) {
+          continue;
+        }
+        const parsed = JSON.parse(state.val);
+        if (!Array.isArray(parsed)) {
+          continue;
+        }
+        const original = parsed;
+        const filtered = original.filter((entry) => typeof entry?.instance !== "string" || !matches(entry.instance));
+        if (filtered.length !== original.length) {
+          await this.states.setStateAsync(id, { val: JSON.stringify(filtered), ack: true });
+        }
+      } catch (e) {
+        console.warn(`Cannot free the used resources in "${id}": ${e.message}`);
+      }
+    }
+  }
   /**
    * Remove all node modules that has been installed by this instance
    *
@@ -1226,7 +1346,7 @@ class Install {
             headers: {
               "User-Agent": "ioBroker Adapter install",
               // @ts-expect-error should be okay...
-              validateStatus: (status) => status === 200
+              validateStatus: /* @__PURE__ */ __name((status) => status === 200, "validateStatus")
             }
           });
           if (result.data && Array.isArray(result.data) && result.data.length >= 1 && result.data[0].sha) {
@@ -1401,8 +1521,169 @@ class Install {
     return instances;
   }
 }
+function processCommandUrl(options) {
+  const { args, params, callback } = options;
+  let url = args[0];
+  const name = args[1];
+  if (!url) {
+    console.log("Please provide a URL to install from and optionally a name of the adapter to install");
+    return void callback(import_js_controller_common.EXIT_CODES.INVALID_ARGUMENTS);
+  }
+  if (url[0] === '"' && url[url.length - 1] === '"') {
+    url = url.substring(1, url.length - 1);
+  }
+  url = url.trim();
+  (0, import_dbConnection.dbConnect)(params, async ({ objects, states }) => {
+    const install = new Install({
+      objects,
+      states,
+      processExit: callback,
+      params
+    });
+    try {
+      await install.installAdapterFromUrl(url, name);
+      return void callback(import_js_controller_common.EXIT_CODES.NO_ERROR);
+    } catch (e) {
+      console.error(`Could not install adapter from url: ${e.message}`);
+      return void callback(import_js_controller_common.EXIT_CODES.CANNOT_INSTALL_NPM_PACKET);
+    }
+  });
+}
+__name(processCommandUrl, "processCommandUrl");
+function processCommandInstall(options) {
+  const { command, args, params, callback } = options;
+  const { showHelp } = options.commandOptions;
+  let name = args[0];
+  let instance = args[1];
+  let repoUrl = args[2];
+  if (parseInt(instance, 10).toString() !== (instance || "").toString()) {
+    repoUrl = instance;
+    instance = void 0;
+  }
+  if (parseInt(repoUrl, 10).toString() === (repoUrl || "").toString()) {
+    const temp = instance;
+    instance = repoUrl;
+    repoUrl = temp;
+  }
+  if (instance && parseInt(instance, 10).toString() === (instance || "").toString()) {
+    params.instance = parseInt(instance, 10);
+  }
+  name = CLITools.normalizeAdapterName(name);
+  const parsedName = CLITools.splitAdapterOrInstanceIdentifierWithVersion(name);
+  if (!parsedName) {
+    console.log("Invalid adapter name for install");
+    showHelp();
+    return void callback(import_js_controller_common.EXIT_CODES.INVALID_ADAPTER_ID);
+  }
+  if (parsedName.instance !== null) {
+    params.instance = parsedName.instance;
+  }
+  name = parsedName.name;
+  const installName = parsedName.nameWithVersion;
+  const adapterDir = import_js_controller_common.tools.getAdapterDir(name);
+  (0, import_dbConnection.dbConnect)(params, async ({ objects, states }) => {
+    const install = new Install({
+      objects,
+      states,
+      processExit: callback,
+      params
+    });
+    if (params.host && params.host !== import_js_controller_common.tools.getHostName()) {
+      let obj;
+      try {
+        obj = await objects.getObjectAsync(`system.host.${params.host}`);
+      } catch (err) {
+        console.warn(`Could not check existence of host "${params.host}": ${err.message}`);
+      }
+      if (!obj) {
+        console.error(`Cannot add instance to non-existing host "${params.host}"`);
+        return void callback(import_js_controller_common.EXIT_CODES.NON_EXISTING_HOST);
+      }
+    }
+    if (!adapterDir || !import_fs_extra.default.existsSync(adapterDir)) {
+      try {
+        const { stoppedList } = await install.downloadPacket(repoUrl, installName);
+        await install.installAdapter(installName, repoUrl);
+        await install.enableInstances(stoppedList, true);
+        if (command !== "install" && command !== "i") {
+          await install.createInstance(name, params);
+        }
+        return void callback();
+      } catch (e) {
+        console.error(`adapter "${name}" cannot be installed: ${e.message}`);
+        return void callback(e instanceof import_customError.IoBrokerError ? e.code : import_js_controller_common.EXIT_CODES.UNKNOWN_ERROR);
+      }
+    } else if (command !== "install" && command !== "i") {
+      try {
+        await install.createInstance(name, params);
+        return void callback();
+      } catch (err) {
+        console.error(`adapter "${name}" cannot be installed: ${err.message}`);
+        return void callback(import_js_controller_common.EXIT_CODES.UNKNOWN_ERROR);
+      }
+    } else {
+      console.log(`adapter "${name}" already installed. Use "upgrade" to upgrade to a newer version.`);
+      return void callback(import_js_controller_common.EXIT_CODES.ADAPTER_ALREADY_INSTALLED);
+    }
+  });
+}
+__name(processCommandInstall, "processCommandInstall");
+function processCommandDelete(options) {
+  const { args, params, callback } = options;
+  const { showHelp } = options.commandOptions;
+  let adapter = args[0];
+  let instance = args[1];
+  if (!adapter) {
+    showHelp();
+    return void callback(import_js_controller_common.EXIT_CODES.INVALID_ADAPTER_ID);
+  }
+  adapter = CLITools.normalizeAdapterName(adapter);
+  if (!instance) {
+    if (!CLITools.validateAdapterOrInstanceIdentifier(adapter)) {
+      showHelp();
+      return void callback(import_js_controller_common.EXIT_CODES.INVALID_ADAPTER_ID);
+    }
+    if (adapter.indexOf(".") > -1) {
+      [adapter, instance] = adapter.split(".", 2);
+    }
+  } else {
+    if (!CLITools.validateAdapterIdentifier(adapter) || !/^\d+$/.test(instance)) {
+      showHelp();
+      return void callback(import_js_controller_common.EXIT_CODES.INVALID_ADAPTER_ID);
+    }
+  }
+  if (instance) {
+    (0, import_dbConnection.dbConnect)(params, async ({ objects, states }) => {
+      const install = new Install({
+        objects,
+        states,
+        processExit: callback,
+        params
+      });
+      console.log(`Delete instance "${adapter}.${instance}"`);
+      await install.deleteInstance(adapter, parseInt(instance));
+      callback();
+    });
+  } else {
+    (0, import_dbConnection.dbConnect)(params, async ({ objects, states }) => {
+      const install = new Install({
+        objects,
+        states,
+        processExit: callback,
+        params
+      });
+      console.log(`Delete adapter "${adapter}"`);
+      const resultCode = await install.deleteAdapter(adapter);
+      callback(resultCode);
+    });
+  }
+}
+__name(processCommandDelete, "processCommandDelete");
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  Install
+  Install,
+  processCommandDelete,
+  processCommandInstall,
+  processCommandUrl
 });
 //# sourceMappingURL=setupInstall.js.map