#47: Support for global tools

cli/src/main/java/com/devonfw/tools/ide/tool/GlobalToolCommandlet.java

@@ -0,0 +1,85 @@
+package com.devonfw.tools.ide.tool;
+
+import com.devonfw.tools.ide.context.IdeContext;
+import com.devonfw.tools.ide.process.ProcessContext;
+import com.devonfw.tools.ide.process.ProcessErrorHandling;
+import com.devonfw.tools.ide.repo.ToolRepository;
+import com.devonfw.tools.ide.version.VersionIdentifier;
+
+import java.io.File;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.Set;
+
+public abstract class GlobalToolCommandlet extends ToolCommandlet {
+  /**
+   * The constructor.
+   *
+   * @param context the {@link IdeContext}.
+   * @param tool the {@link #getName() tool name}.
+   * @param tags the {@link #getTags() tags} classifying the tool. Should be created via {@link Set#of(Object) Set.of}
+   *        method.
+   */
+  public GlobalToolCommandlet(IdeContext context, String tool, Set<String> tags) {
+
+    super(context, tool, tags);
+  }
+
+  /**
+   * @return the {@link Path} where the main executable file of this tool is installed.
+   */
+  @Override
+  public Path getToolBinary() {
+
+    String path = System.getenv("PATH");
+    String[] pathDirs = path.split(File.pathSeparator);
+    for (String dir : pathDirs) {
+      Path toolPath = Paths.get(dir, getName());
+      if (Files.isExecutable(toolPath)) {
+        return toolPath;
+      }
+    }
+    return null;
+  }
+
+  /**
+   * @return the {@link Path} where the tool is located (installed).
+   */
+  @Override
+  public Path getToolPath() {
+
+    // TODO: get rootDir of global tool? is RootDir accessible from BinDir (getToolBinary())?
+    return null;
+  }
+
+  /**
+   * Installs or updates the managed {@link #getName() tool}.
+   *
+   * @param silent - {@code true} if called recursively to suppress verbose logging, {@code false} otherwise.
+   * @return {@code true} if the tool was newly installed, {@code false} if the tool was already installed before and
+   *         nothing has changed.
+   */
+  @Override
+  protected boolean doInstall(boolean silent) {
+
+    String edition = getEdition();
+    ToolRepository toolRepository = this.context.getDefaultToolRepository();
+    VersionIdentifier configuredVersion = getConfiguredVersion();
+    VersionIdentifier resolvedVersion = toolRepository.resolveVersion(this.tool, edition, configuredVersion);
+    Path binaryPath = getToolBinary();
+    if (Files.exists(binaryPath)) {
+      // TODO: check whether resolvedVersion is different than installedVersion, if so update the tool?
+      return false;
+    }
+    // download and install the global tool
+    Path target = toolRepository.download(this.tool, edition, resolvedVersion);
+    ProcessContext pc = this.context.newProcess().errorHandling(ProcessErrorHandling.WARNING).executable(target);
+    pc.run();
+    this.context.success("Successfully installed {} in version {}", this.tool, resolvedVersion);
+    //TODO: create a toolVersionFile? If so, in binDir or rootDir? if not, how do we retrieve the version so that getInstalledVersion works?
+    postInstall();
+    return true;
+  }
+
+}