25431217639

Committed 06 May 2026 10:58AM UTC coverage: 70.703% (-0.03%) from 70.728%

Build # 25431217639

Build Type

Pull #1876

github

Committed by

web-flow

Commit Message

Merge e05473ad9 into 2e54dfef7

Pull Request Pull Request #1876: #1869: Improve windows helper to search windows registry

Coverage Stats

4410 of 6892 branches covered (63.99%)

Branch coverage included in aggregate %.

11373 of 15431 relevant lines covered (73.7%)

3.12 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

61.76

cli/src/main/java/com/devonfw/tools/ide/os/WindowsHelperImpl.java

package com.devonfw.tools.ide.os;

import java.util.List;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.devonfw.tools.ide.context.IdeContext;
import com.devonfw.tools.ide.log.IdeLogLevel;
import com.devonfw.tools.ide.process.ProcessErrorHandling;
import com.devonfw.tools.ide.process.ProcessMode;
import com.devonfw.tools.ide.process.ProcessResult;

/**
 * Implementation of {@link WindowsHelper}.
 */
public class WindowsHelperImpl implements WindowsHelper {

  private static final Logger LOG = LoggerFactory.getLogger(WindowsHelperImpl.class);

  /** Registry key for the users environment variables. */
  public static final String HKCU_ENVIRONMENT = "HKCU\\Environment";

  /** Common Windows registry base paths containing (uninstall) information for installed applications (system-wide and per-user). */
  private static final String[] REGISTRY_BASE_PATHS = {
      "HKCU\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Uninstall",
      "HKLM\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Uninstall",
      "HKLM\\SOFTWARE\\WOW6432Node\\Microsoft\\Windows\\CurrentVersion\\Uninstall"
  };

  private final IdeContext context;

  /**
   * The constructor.
   *
   * @param context the {@link IdeContext}.
   */
  public WindowsHelperImpl(IdeContext context) {

    this.context = context;
  }

  @Override
  public void setUserEnvironmentValue(String key, String value) {

    ProcessResult result = this.context.newProcess().executable("setx").addArgs(key, value).run(ProcessMode.DEFAULT_SILENT);
    assert (result.isSuccessful());
  }

  @Override
  public void removeUserEnvironmentValue(String key) {
    ProcessResult result = this.context.newProcess().executable("reg").addArgs("delete", HKCU_ENVIRONMENT, "/v", key, "/f")
        .errorHandling(ProcessErrorHandling.LOG_WARNING).run(ProcessMode.DEFAULT_CAPTURE);
    if (result.isSuccessful()) {
      LOG.debug("Removed environment variable {}", key);
    } else {
      result.log(IdeLogLevel.WARNING);
    }
  }

  @Override
  public String getUserEnvironmentValue(String key) {

    return getRegistryValue(HKCU_ENVIRONMENT, key);
  }

  @Override
  public String getRegistryValue(String path, String key) {

    List<String> out = runReg("query", path, "/v", key);
    if (out != null) {
      return retrieveRegString(key, out);
    }
    return null;
  }

  @Override
  public String getDisplayVersionFromRegistry(String appName) {
    return getRegistryValueBySearch(appName, "DisplayVersion");
  }

  @Override
  public String getDisplayIconFromRegistry(String appName) {
    return getRegistryValueBySearch(appName, "DisplayIcon");
  }

  @Override
  public String getUninstallStringFromRegistry(String appName) {
    return getRegistryValueBySearch(appName, "UninstallString");
  }

  @Override
  public String getInstallLocationFromRegistry(String appName) {
    return getRegistryValueBySearch(appName, "InstallLocation");
  }

  private String getRegistryValueBySearch(String appName, String key) {

    String uninstallKey = findUninstallKey(appName);
    if (uninstallKey == null) {
      return null;
    }
    List<String> out = runReg("query", uninstallKey);
    if (out != null) {
      return retrieveRegString(key, out);
    }
    return null;
  }

  private String findUninstallKey(String appName) {

    for (String registryBasePath : REGISTRY_BASE_PATHS) {
      List<String> out = runReg("query", registryBasePath, "/s", "/f", appName);
      if (out == null) {
        continue;
      }
      for (String line : out) {
        line = line.trim();
        if (line.startsWith("HKEY_")) {
          return line; // exact registry path (key) for tool
        }
      }
    }
    return null;

  }

  /**
   * Executes a Windows registry command and returns its output.
   *
   * @param args the registry command arguments.
   * @return the command output lines, or {@code null} if the command failed
   */
  protected List<String> runReg(String... args) {
    ProcessResult result = this.context.newProcess()
        .errorHandling(ProcessErrorHandling.LOG_WARNING)
        .executable("reg")
        .addArgs(args)
        .run(ProcessMode.DEFAULT_CAPTURE);
    if (!result.isSuccessful()) {
      return null;
    }
    return result.getOut();
  }

  /**
   * Parses the result of a registry query and outputs the given key.
   *
   * @param key the key to look for.
   * @param out List of keys from registry query result.
   * @return the registry value.
   */
  protected String retrieveRegString(String key, List<String> out) {
    for (String line : out) {
      int i = line.indexOf(key);
      if (i >= 0) {
        assert (i == 4);
        i += key.length();
        i = skipWhitespaces(line, i);
        i = skipNonWhitespaces(line, i); // the type (e.g. "REG_SZ")
        i = skipWhitespaces(line, i);
        line = line.substring(i);
        return line;
      }
    }
    return null;
  }

  private static int skipWhitespaces(String string, int i) {

    int len = string.length();
    while ((i < len) && Character.isWhitespace(string.charAt(i))) {
      i++;
    }
    return i;
  }

  private static int skipNonWhitespaces(String string, int i) {

    int len = string.length();
    while ((i < len) && !Character.isWhitespace(string.charAt(i))) {
      i++;
    }
    return i;
  }

}

1	package com.devonfw.tools.ide.os;
2
3	import java.util.List;
4
5	import org.slf4j.Logger;
6	import org.slf4j.LoggerFactory;
7
8	import com.devonfw.tools.ide.context.IdeContext;
9	import com.devonfw.tools.ide.log.IdeLogLevel;
10	import com.devonfw.tools.ide.process.ProcessErrorHandling;
11	import com.devonfw.tools.ide.process.ProcessMode;
12	import com.devonfw.tools.ide.process.ProcessResult;
13
14	/**
15	* Implementation of {@link WindowsHelper}.
16	*/
17	public class WindowsHelperImpl implements WindowsHelper {
18
19	private static final Logger LOG = LoggerFactory.getLogger(WindowsHelperImpl.class);	3✔
20
21	/** Registry key for the users environment variables. */
22	public static final String HKCU_ENVIRONMENT = "HKCU\\Environment";
23
24	/** Common Windows registry base paths containing (uninstall) information for installed applications (system-wide and per-user). */
25	private static final String[] REGISTRY_BASE_PATHS = {	16✔
26	"HKCU\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Uninstall",
27	"HKLM\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Uninstall",
28	"HKLM\\SOFTWARE\\WOW6432Node\\Microsoft\\Windows\\CurrentVersion\\Uninstall"
29	};
30
31	private final IdeContext context;
32
33	/**
34	* The constructor.
35	*
36	* @param context the {@link IdeContext}.
37	*/
38	public WindowsHelperImpl(IdeContext context) {	2✔
39
40	this.context = context;	3✔
41	}	1✔
42
43	@Override
44	public void setUserEnvironmentValue(String key, String value) {
45
46	ProcessResult result = this.context.newProcess().executable("setx").addArgs(key, value).run(ProcessMode.DEFAULT_SILENT);	×
47	assert (result.isSuccessful());	×
48	}	×
49
50	@Override
51	public void removeUserEnvironmentValue(String key) {
52	ProcessResult result = this.context.newProcess().executable("reg").addArgs("delete", HKCU_ENVIRONMENT, "/v", key, "/f")	×
53	.errorHandling(ProcessErrorHandling.LOG_WARNING).run(ProcessMode.DEFAULT_CAPTURE);	×
54	if (result.isSuccessful()) {	×
55	LOG.debug("Removed environment variable {}", key);	×
56	} else {
57	result.log(IdeLogLevel.WARNING);	×
58	}
59	}	×
60
61	@Override
62	public String getUserEnvironmentValue(String key) {
63
64	return getRegistryValue(HKCU_ENVIRONMENT, key);	×
65	}
66
67	@Override
68	public String getRegistryValue(String path, String key) {
69
70	List<String> out = runReg("query", path, "/v", key);	×
71	if (out != null) {	×
72	return retrieveRegString(key, out);	×
73	}
74	return null;	×
75	}
76
77	@Override
78	public String getDisplayVersionFromRegistry(String appName) {
79	return getRegistryValueBySearch(appName, "DisplayVersion");	5✔
80	}
81
82	@Override
83	public String getDisplayIconFromRegistry(String appName) {
84	return getRegistryValueBySearch(appName, "DisplayIcon");	5✔
85	}
86
87	@Override
88	public String getUninstallStringFromRegistry(String appName) {
89	return getRegistryValueBySearch(appName, "UninstallString");	5✔
90	}
91
92	@Override
93	public String getInstallLocationFromRegistry(String appName) {
94	return getRegistryValueBySearch(appName, "InstallLocation");	5✔
95	}
96
97	private String getRegistryValueBySearch(String appName, String key) {
98
99	String uninstallKey = findUninstallKey(appName);	4✔
100	if (uninstallKey == null) {	2✔
101	return null;	2✔
102	}
103	List<String> out = runReg("query", uninstallKey);	13✔
104	if (out != null) {	2!
105	return retrieveRegString(key, out);	5✔
106	}
107	return null;	×
108	}
109
110	private String findUninstallKey(String appName) {
111
112	for (String registryBasePath : REGISTRY_BASE_PATHS) {	16✔
113	List<String> out = runReg("query", registryBasePath, "/s", "/f", appName);	25✔
114	if (out == null) {	2!
115	continue;	×
116	}
117	for (String line : out) {	10✔
118	line = line.trim();	3✔
119	if (line.startsWith("HKEY_")) {	4!
120	return line; // exact registry path (key) for tool	2✔
121	}
122	}	×
123	}
124	return null;	2✔
125
126	}
127
128	/**
129	* Executes a Windows registry command and returns its output.
130	*
131	* @param args the registry command arguments.
132	* @return the command output lines, or {@code null} if the command failed
133	*/
134	protected List<String> runReg(String... args) {
135	ProcessResult result = this.context.newProcess()	×
136	.errorHandling(ProcessErrorHandling.LOG_WARNING)	×
137	.executable("reg")	×
138	.addArgs(args)	×
139	.run(ProcessMode.DEFAULT_CAPTURE);	×
140	if (!result.isSuccessful()) {	×
141	return null;	×
142	}
143	return result.getOut();	×
144	}
145
146	/**
147	* Parses the result of a registry query and outputs the given key.
148	*
149	* @param key the key to look for.
150	* @param out List of keys from registry query result.
151	* @return the registry value.
152	*/
153	protected String retrieveRegString(String key, List<String> out) {
154	for (String line : out) {	10✔
155	int i = line.indexOf(key);	4✔
156	if (i >= 0) {	2✔
157	assert (i == 4);	4!
158	i += key.length();	5✔
159	i = skipWhitespaces(line, i);	4✔
160	i = skipNonWhitespaces(line, i); // the type (e.g. "REG_SZ")	4✔
161	i = skipWhitespaces(line, i);	4✔
162	line = line.substring(i);	4✔
163	return line;	2✔
164	}
165	}	1✔
166	return null;	2✔
167	}
168
169	private static int skipWhitespaces(String string, int i) {
170
171	int len = string.length();	3✔
172	while ((i < len) && Character.isWhitespace(string.charAt(i))) {	8!
173	i++;	2✔
174	}
175	return i;	2✔
176	}
177
178	private static int skipNonWhitespaces(String string, int i) {
179
180	int len = string.length();	3✔
181	while ((i < len) && !Character.isWhitespace(string.charAt(i))) {	8!
182	i++;	2✔
183	}
184	return i;	2✔
185	}
186
187	}

devonfw / IDEasy / 25431217639

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous