Find path to bash automatically for Windows #17 and add check if the path to bash is really point to bash #7

Author: introfog

src/main/java/com/github/introfog/gitwave/GitWaveLauncher.java

@@ -17,7 +17,6 @@
 package com.github.introfog.gitwave;
 
 import com.github.introfog.gitwave.model.AppConfig;
-import com.github.introfog.gitwave.model.OsRecogniser;
 import com.github.introfog.gitwave.model.StageFactory;
 
 import javafx.application.Application;
@@ -28,11 +27,8 @@ public class GitWaveLauncher extends Application {
     public void start(Stage stage) {
         StageFactory.createPrimaryExecuteWindow(stage).getStage().show();
         AppConfig.getInstance().setHostServices(getHostServices());
-        if (!OsRecogniser.isCurrentOsUnixLike()) {
-            final String pathToGitBashExe = AppConfig.getInstance().getPathToGitBashExe();
-            if (pathToGitBashExe == null || pathToGitBashExe.isEmpty()) {
-                StageFactory.createModalSetupWindow().getStage().showAndWait();
-            }
+        if (AppConfig.getInstance().getPathToBash() == null) {
+            StageFactory.createModalSetupWindow().getStage().showAndWait();
         }
     }
 

src/main/java/com/github/introfog/gitwave/controller/SettingsController.java

@@ -18,7 +18,6 @@
 
 import com.github.introfog.gitwave.model.AppConfig;
 import com.github.introfog.gitwave.model.DialogFactory;
-import com.github.introfog.gitwave.model.OsRecogniser;
 import com.github.introfog.gitwave.model.StageFactory.FxmlStageHolder;
 
 import java.io.File;
@@ -33,6 +32,7 @@
 import javafx.scene.control.Label;
 import javafx.scene.control.TextField;
 import javafx.stage.FileChooser;
+import javafx.stage.FileChooser.ExtensionFilter;
 import javafx.util.Duration;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -59,15 +59,9 @@ public class SettingsController extends BaseController {
     public void initialize(FxmlStageHolder fxmlStageHolder) {
         super.initialize(fxmlStageHolder);
         super.setClosingOnEscapePressing(fxmlStageHolder);
-        if (OsRecogniser.isCurrentOsUnixLike()) {
-            pathToBashExe.disableProperty().set(true);
-            browse.setDisable(true);
-            pathToBashText.setDisable(true);
-        } else {
-            final String pathToGitBashExeStr = AppConfig.getInstance().getPathToGitBashExe();
-            if (pathToGitBashExeStr != null && !pathToGitBashExeStr.isEmpty()) {
-                pathToBashExe.setText(pathToGitBashExeStr);
-            }
+        final String pathToGitBashExeStr = AppConfig.getInstance().getPathToBash();
+        if (pathToGitBashExeStr != null) {
+            pathToBashExe.setText(pathToGitBashExeStr);
         }
         save.requestFocus();
         if (done != null) {
@@ -77,17 +71,13 @@ public void initialize(FxmlStageHolder fxmlStageHolder) {
 
     @FXML
     protected void save() {
-        File bashExeFile = new File(pathToBashExe.getText());
-        if (bashExeFile.exists() && bashExeFile.getAbsolutePath().endsWith(".exe")) {
-            final String absolutePath = bashExeFile.getAbsolutePath();
-            AppConfig.getInstance().setPathToGitBashExe(absolutePath);
-            // TODO #7 add check that path is specified to GitBash.exe not for any other .exe
-            LOGGER.info("Path to GitBash.exe registered to '{}'", absolutePath);
+        File bashFile = new File(pathToBashExe.getText());
+        if (bashFile.exists() && AppConfig.getInstance().setPathToBash(bashFile.getAbsolutePath())) {
             closeStage();
         } else {
-            LOGGER.error("Wrong path to GitBash.exe '{}'", bashExeFile.getAbsolutePath());
-            DialogFactory.createErrorAlert("Git Bash executable hasn't been specified",
-                    "Git Bash executable hasn't been specified correctly. Either specify path manually or find via file browser.", 210);
+            LOGGER.error("Wrong path to bash '{}'", bashFile.getAbsolutePath());
+            DialogFactory.createErrorAlert("Bash hasn't been specified",
+                    "Bash hasn't been specified correctly. Either specify path manually or find via file browser.", 210);
         }
     }
 
@@ -119,14 +109,14 @@ protected void cleanLogs() {
     @FXML
     protected void browseGitBashExe() {
         FileChooser fileChooser = new FileChooser();
-        FileChooser.ExtensionFilter exeFilter = new FileChooser.ExtensionFilter("Bash executable (*.exe)", "*.exe");
-        fileChooser.getExtensionFilters().add(exeFilter);
-
-        final String pathToGitBashExeStr = AppConfig.getInstance().getPathToGitBashExe();
-        if (pathToGitBashExeStr != null && !pathToGitBashExeStr.isEmpty()) {
-            File gitBashDir = new File(pathToGitBashExeStr.substring(0, pathToGitBashExeStr.lastIndexOf("\\")));
-            if (gitBashDir.exists() && gitBashDir.isDirectory()) {
-                fileChooser.setInitialDirectory(gitBashDir);
+        FileChooser.ExtensionFilter bashFilter = new ExtensionFilter("Path to bash", "*.*") ;
+        fileChooser.getExtensionFilters().add(bashFilter);
+
+        final String pathToGitBashStr = AppConfig.getInstance().getPathToBash();
+        if (pathToGitBashStr != null) {
+            File bashDir = new File(pathToGitBashStr.substring(0, pathToGitBashStr.lastIndexOf('/')));
+            if (bashDir.exists() && bashDir.isDirectory()) {
+                fileChooser.setInitialDirectory(bashDir);
             }
         }
 
@@ -135,7 +125,7 @@ protected void browseGitBashExe() {
             if (selectedFile.exists()) {
                 pathToBashExe.setText(selectedFile.getAbsolutePath());
             } else {
-                LOGGER.error("Wrong browsed path to GitBash.exe '{}'", selectedFile);
+                LOGGER.error("Wrong browsed path to bash '{}'", selectedFile);
                 DialogFactory.createErrorAlert("Provided file wasn't found", "Provided file wasn't found, try again");
             }
         } else {

src/main/java/com/github/introfog/gitwave/controller/main/MenuController.java

@@ -3,12 +3,11 @@
 import com.github.introfog.gitwave.controller.SupportController;
 import com.github.introfog.gitwave.model.AppConfig;
 import com.github.introfog.gitwave.model.DialogFactory;
-import com.github.introfog.gitwave.model.OsRecogniser;
+import com.github.introfog.gitwave.model.OsHelper;
 import com.github.introfog.gitwave.model.StageFactory;
 import com.github.introfog.gitwave.model.StageFactory.FxmlStageHolder;
 import com.github.introfog.gitwave.model.UpdateChecker;
 
-import java.io.File;
 import javafx.concurrent.Task;
 import javafx.scene.control.Menu;
 import javafx.scene.control.MenuItem;
@@ -32,17 +31,14 @@ public MenuController(FxmlStageHolder fxmlStageHolder, Menu menu, MenuItem updat
 
     @Override
     public boolean isValid() {
-        if (OsRecogniser.isCurrentOsUnixLike()) {
-            return true;
-        }
-        final String pathToGitBashExe = AppConfig.getInstance().getPathToGitBashExe();
-        if (pathToGitBashExe == null || pathToGitBashExe.isEmpty()) {
-            DialogFactory.createErrorAlert("GitBash path hasn't been specified", "Specify path to GitBash in Menu->Settings.");
+        if (AppConfig.getInstance().getPathToBash() == null) {
+            DialogFactory.createErrorAlert("Bash hasn't been specified", "Specify bash in Menu->Settings.");
             return false;
-        } if (!(new File(pathToGitBashExe)).exists()) {
-            LOGGER.error("Specified GitBash.exe path '{}' points to not-existent file, running git command was skipped.", pathToGitBashExe);
-            DialogFactory.createErrorAlert("Invalid path to GitBash.exe", "Specified path \"" + pathToGitBashExe +
-                    "\" points to not-existent file. Specify correct path in settings.", 210);
+        } if (!OsHelper.isValidPathToBash(AppConfig.getInstance().getPathToBash())) {
+            LOGGER.error("Specified path to bash '{}' doesn't point to bash, running git command was skipped.",
+                    AppConfig.getInstance().getPathToBash());
+            DialogFactory.createErrorAlert("Invalid path to bash", "Specified path \"" + AppConfig.getInstance().getPathToBash() +
+                    "\" doesn't point to bash. Specify correct path in settings.", 210);
             return false;
         }
         return true;

src/main/java/com/github/introfog/gitwave/model/AppConfig.java

@@ -16,6 +16,7 @@
 
 package com.github.introfog.gitwave.model;
 
+import com.github.introfog.gitwave.model.OsHelper.CurrentOs;
 import com.github.introfog.gitwave.model.dto.CommandDto;
 import com.github.introfog.gitwave.model.dto.ConfigDto;
 
@@ -41,33 +42,57 @@ public final class AppConfig {
 
     private final ConfigDto config;
     private HostServices hostServices;
+    private final CurrentOs currentOs;
+    private String pathToBash;
 
     private final AtomicBoolean appWasClosed = new AtomicBoolean(false);
 
 
     private AppConfig() {
         this.config = AppConfig.initConfig();
+        this.currentOs = OsHelper.getCurrentOs();
+        final String pathToBashFromConfig = config.getPathToGitBash();
+        if (pathToBashFromConfig != null) {
+            LOGGER.info("Check path to bash from config.");
+            if (OsHelper.isValidPathToBash(pathToBashFromConfig)) {
+                this.pathToBash = pathToBashFromConfig;
+            } else {
+                config.setPathToGitBash(null);
+                saveConfig();
+                DialogFactory.createInfoAlert("Invalid config path to bash", "Path to bash \"" + pathToBashFromConfig + "\" "
+                        + "specified in config invalid, path will be found automatically.");
+            }
+        }
+        if (pathToBash == null) {
+            this.pathToBash = OsHelper.getPathToBash(currentOs);
+        }
     }
 
     public static AppConfig getInstance() {
         return INSTANCE;
     }
 
-    public HostServices getHostServices() {
-        return hostServices;
+    public String getPathToBash() {
+        return pathToBash;
     }
 
-    public void setHostServices(HostServices hostServices) {
-        this.hostServices = hostServices;
+    public boolean setPathToBash(String pathToBashParam) {
+        if (OsHelper.isValidPathToBash(pathToBashParam)) {
+            LOGGER.info("Path to bash registered to '{}'", pathToBashParam);
+            this.pathToBash = pathToBashParam;
+            config.setPathToGitBash(pathToBashParam);
+            saveConfig();
+            return true;
+        }
+        return false;
     }
 
-    public void setPathToGitBashExe(String pathToGitBashExe) {
-        config.setPathToGitBash(pathToGitBashExe);
-        saveConfig();
+    public HostServices getHostServices() {
+        return hostServices;
     }
 
-    public String getPathToGitBashExe() {
-        return config.getPathToGitBash();
+    public void setHostServices(HostServices hostServices) {
+        this.hostServices = hostServices;
     }
 
     public void setLastRunFolder(String lastRunFolder) {

src/main/java/com/github/introfog/gitwave/model/CommandExecutor.java

@@ -86,11 +86,7 @@ private static List<RunnableCommand> createRunnableCommands(List<File> repositor
 
     private static String[] constructCmdCommand(String gitRepoPath, String command) {
         List<String> cmdCommand = new ArrayList<>();
-        if (OsRecogniser.isCurrentOsUnixLike()) {
-            cmdCommand.add("bash");
-        } else {
-            cmdCommand.add(AppConfig.getInstance().getPathToGitBashExe().replace("\\", "/"));
-        }
+        cmdCommand.add(AppConfig.getInstance().getPathToBash());
         cmdCommand.add("-c");
         cmdCommand.add("cd '" + gitRepoPath + "' && " + command);
         return cmdCommand.toArray(new String[]{});

src/main/java/com/github/introfog/gitwave/model/OsHelper.java

@@ -0,0 +1,148 @@
+/*
+ * Copyright 2023-2024 Dmitry Chubrick
+ *
+ * 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.
+ */
+
+package com.github.introfog.gitwave.model;
+
+import java.io.BufferedReader;
+import java.io.IOException;
+import java.io.InputStreamReader;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public final class OsHelper {
+    private static final Logger LOGGER = LoggerFactory.getLogger(OsHelper.class);
+
+    private OsHelper() {
+        // Do nothing
+    }
+
+    public static String getPathToBash(CurrentOs currentOs) {
+        switch (currentOs) {
+            case WINDOWS:
+                LOGGER.info("Find path to git bash for Windows OS.");
+                String pathToBash = extractPathToGitForWindows();
+                LOGGER.info("Extracted path from Windows Registry: {}", pathToBash);
+                if (pathToBash != null) {
+                    pathToBash = pathToBash.replace("\\", "/");
+                }
+                return isValidPathToBash(pathToBash) ? pathToBash : null;
+            case LINUX:
+            case MACOS:
+                return "bash";
+            default:
+                return null;
+        }
+    }
+
+    public static boolean isValidPathToBash(String pathToBash) {
+        try {
+            LOGGER.info("Check if the following path to bash is valid: '{}'", pathToBash);
+            if (pathToBash == null || pathToBash.isEmpty()) {
+                LOGGER.info("'{}' isn't valid path to bash.", pathToBash);
+                return false;
+            }
+            Process process = Runtime.getRuntime().exec(new String[]{pathToBash, "--version"});
+
+            String line;
+            StringBuilder result = new StringBuilder();
+            BufferedReader stdout = new BufferedReader(new InputStreamReader(process.getInputStream()));
+
+            while ((line = stdout.readLine()) != null) {
+                result.append(line);
+            }
+            stdout.close();
+
+            String output = result.toString();
+            final boolean isValid = output.contains("bash");
+            LOGGER.info("Output of the command '{} --version', and the result of check for validity is: {}", pathToBash, isValid);
+            return isValid;
+        } catch (IOException e) {
+            LOGGER.warn("Command '{} --version' fail with the following exception.", pathToBash, e);
+            return false;
+        }
+    }
+
+    public static CurrentOs getCurrentOs() {
+        CurrentOs currentOs;
+        String os = System.getProperty("os.name").toLowerCase();
+        if (os.contains("win")) {
+            currentOs = CurrentOs.WINDOWS;
+        } else if (os.contains("mac")) {
+            currentOs = CurrentOs.MACOS;
+        } else if (os.contains("nix") || os.contains("nux") || os.contains("aix")) {
+            currentOs = CurrentOs.LINUX;
+        } else {
+            currentOs = CurrentOs.UNRECOGNISED;
+        }
+        LOGGER.info("System.getProperty(\"os.name\")={}. Recognised OS: {}", os, currentOs);
+        return currentOs;
+    }
+
+    private static String extractPathToGitForWindows() {
+        String installPath = null;
+
+        try {
+            String value = readRegistry("HKLM\\SOFTWARE\\GitForWindows", "InstallPath");
+            if (value != null && !value.isEmpty()) {
+                installPath = value;
+            }
+
+            if (installPath == null) {
+                value = readRegistry("HKCU\\Software\\GitForWindows", "InstallPath");
+                if (value != null && !value.isEmpty()) {
+                    installPath = value;
+                }
+            }
+        } catch (Exception e) {
+            LOGGER.warn("Extracting path from Windows Registry throw an exception.", e);
+        }
+
+        return installPath == null ? null : installPath + "\\bin\\bash.exe";
+    }
+
+    private static String readRegistry(String location, String key){
+        try {
+            Process process = Runtime.getRuntime().exec("REG QUERY " + location + " /v " + key);
+
+            String line;
+            StringBuilder result = new StringBuilder();
+            BufferedReader stdout = new BufferedReader(new InputStreamReader(process.getInputStream()));
+
+            while ((line = stdout.readLine()) != null) {
+                result.append(line);
+            }
+            stdout.close();
+
+            // Example of result: HKEY_LOCAL_MACHINE\SOFTWARE\GitForWindows InstallPath REG_SZ E:\Programs\Git
+            if( !result.toString().contains(key)){
+                return null;
+            }
+
+            String[] parsed = result.toString().split("\\s+");
+            return parsed[parsed.length-1];
+        }
+        catch (Exception e) {
+            return null;
+        }
+    }
+
+    public enum CurrentOs {
+        WINDOWS,
+        MACOS,
+        LINUX,
+        UNRECOGNISED
+    }
+}