source: josm/trunk/src/org/openstreetmap/josm/tools/WinRegistry.java@ 12682

Last change on this file since 12682 was 12279, checked in by Don-vip, 7 years ago

sonar - squid:S3878 - Arrays should not be created for varargs parameters
  • Property svn:eol-style set to native
File size: 9.4 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.tools;
3
4import java.lang.reflect.InvocationTargetException;
5import java.lang.reflect.Method;
6import java.nio.charset.StandardCharsets;
7import java.util.ArrayList;
8import java.util.Arrays;
9import java.util.Collections;
10import java.util.HashMap;
11import java.util.List;
12import java.util.Map;
13import java.util.prefs.Preferences;
14
15/**
16 * Utility class to access Window registry (read access only).
17 * As the implementation relies on internal JDK class {@code java.util.prefs.WindowsPreferences} and its native JNI
18 * method {@code Java_java_util_prefs_WindowsPreferences_WindowsRegQueryValueEx}, only String values (REG_SZ)
19 * are supported.
20 * Adapted from <a href="http://stackoverflow.com/a/6163701/2257172">StackOverflow</a>.
21 * @since 12217
22 */
23public final class WinRegistry {
24
25 /**
26 * Registry entries subordinate to this key define the preferences of the current user.
27 * These preferences include the settings of environment variables, data about program groups,
28 * colors, printers, network connections, and application preferences.
29 * See <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/ms724836(v=vs.85).aspx">Predefined Keys</a>
30 */
31 public static final int HKEY_CURRENT_USER = 0x80000001;
32
33 /**
34 * Registry entries subordinate to this key define the physical state of the computer, including data about the bus type,
35 * system memory, and installed hardware and software. It contains subkeys that hold current configuration data,
36 * including Plug and Play information (the Enum branch, which includes a complete list of all hardware that has ever been
37 * on the system), network logon preferences, network security information, software-related information (such as server
38 * names and the location of the server), and other system information.
39 * See <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/ms724836(v=vs.85).aspx">Predefined Keys</a>
40 */
41 public static final int HKEY_LOCAL_MACHINE = 0x80000002;
42
43 private static final int REG_SUCCESS = 0;
44
45 private static final int KEY_READ = 0x20019;
46 private static final Preferences userRoot = Preferences.userRoot();
47 private static final Preferences systemRoot = Preferences.systemRoot();
48 private static final Class<? extends Preferences> userClass = userRoot.getClass();
49 private static final Method regOpenKey;
50 private static final Method regCloseKey;
51 private static final Method regQueryValueEx;
52 private static final Method regEnumValue;
53 private static final Method regQueryInfoKey;
54 private static final Method regEnumKeyEx;
55
56 static {
57 try {
58 regOpenKey = userClass.getDeclaredMethod("WindowsRegOpenKey", int.class, byte[].class, int.class);
59 regCloseKey = userClass.getDeclaredMethod("WindowsRegCloseKey", int.class);
60 regQueryValueEx = userClass.getDeclaredMethod("WindowsRegQueryValueEx", int.class, byte[].class);
61 regEnumValue = userClass.getDeclaredMethod("WindowsRegEnumValue", int.class, int.class, int.class);
62 regQueryInfoKey = userClass.getDeclaredMethod("WindowsRegQueryInfoKey1", int.class);
63 regEnumKeyEx = userClass.getDeclaredMethod("WindowsRegEnumKeyEx", int.class, int.class, int.class);
64 Utils.setObjectsAccessible(regOpenKey, regCloseKey, regQueryValueEx, regEnumValue, regQueryInfoKey, regEnumKeyEx);
65 } catch (SecurityException | ReflectiveOperationException e) {
66 throw new JosmRuntimeException(e);
67 }
68 }
69
70 private WinRegistry() {
71 // Hide default constructor for utilities classes
72 }
73
74 /**
75 * Read a value from key and value name
76 * @param hkey HKEY_CURRENT_USER/HKEY_LOCAL_MACHINE
77 * @param key key name
78 * @param valueName value name
79 * @return the value
80 * @throws IllegalArgumentException if hkey not HKEY_CURRENT_USER/HKEY_LOCAL_MACHINE
81 * @throws IllegalAccessException if Java language access control is enforced and the underlying method is inaccessible
82 * @throws InvocationTargetException if the underlying method throws an exception
83 */
84 public static String readString(int hkey, String key, String valueName)
85 throws IllegalAccessException, InvocationTargetException {
86 if (hkey == HKEY_LOCAL_MACHINE) {
87 return readString(systemRoot, hkey, key, valueName);
88 } else if (hkey == HKEY_CURRENT_USER) {
89 return readString(userRoot, hkey, key, valueName);
90 } else {
91 throw new IllegalArgumentException("hkey=" + hkey);
92 }
93 }
94
95 /**
96 * Read value(s) and value name(s) form given key
97 * @param hkey HKEY_CURRENT_USER/HKEY_LOCAL_MACHINE
98 * @param key key name
99 * @return the value name(s) plus the value(s)
100 * @throws IllegalArgumentException if hkey not HKEY_CURRENT_USER/HKEY_LOCAL_MACHINE
101 * @throws IllegalAccessException if Java language access control is enforced and the underlying method is inaccessible
102 * @throws InvocationTargetException if the underlying method throws an exception
103 */
104 public static Map<String, String> readStringValues(int hkey, String key)
105 throws IllegalAccessException, InvocationTargetException {
106 if (hkey == HKEY_LOCAL_MACHINE) {
107 return readStringValues(systemRoot, hkey, key);
108 } else if (hkey == HKEY_CURRENT_USER) {
109 return readStringValues(userRoot, hkey, key);
110 } else {
111 throw new IllegalArgumentException("hkey=" + hkey);
112 }
113 }
114
115 /**
116 * Read the value name(s) from a given key
117 * @param hkey HKEY_CURRENT_USER/HKEY_LOCAL_MACHINE
118 * @param key key name
119 * @return the value name(s)
120 * @throws IllegalArgumentException if hkey not HKEY_CURRENT_USER/HKEY_LOCAL_MACHINE
121 * @throws IllegalAccessException if Java language access control is enforced and the underlying method is inaccessible
122 * @throws InvocationTargetException if the underlying method throws an exception
123 */
124 public static List<String> readStringSubKeys(int hkey, String key)
125 throws IllegalAccessException, InvocationTargetException {
126 if (hkey == HKEY_LOCAL_MACHINE) {
127 return readStringSubKeys(systemRoot, hkey, key);
128 } else if (hkey == HKEY_CURRENT_USER) {
129 return readStringSubKeys(userRoot, hkey, key);
130 } else {
131 throw new IllegalArgumentException("hkey=" + hkey);
132 }
133 }
134
135 // =====================
136
137 private static String readString(Preferences root, int hkey, String key, String value)
138 throws IllegalAccessException, InvocationTargetException {
139 int[] handles = (int[]) regOpenKey.invoke(root, Integer.valueOf(hkey), toCstr(key), Integer.valueOf(KEY_READ));
140 if (handles[1] != REG_SUCCESS) {
141 return null;
142 }
143 byte[] valb = (byte[]) regQueryValueEx.invoke(root, Integer.valueOf(handles[0]), toCstr(value));
144 regCloseKey.invoke(root, Integer.valueOf(handles[0]));
145 return (valb != null ? new String(valb, StandardCharsets.UTF_8).trim() : null);
146 }
147
148 private static Map<String, String> readStringValues(Preferences root, int hkey, String key)
149 throws IllegalAccessException, InvocationTargetException {
150 HashMap<String, String> results = new HashMap<>();
151 int[] handles = (int[]) regOpenKey.invoke(root, Integer.valueOf(hkey), toCstr(key), Integer.valueOf(KEY_READ));
152 if (handles[1] != REG_SUCCESS) {
153 return null;
154 }
155 int[] info = (int[]) regQueryInfoKey.invoke(root, Integer.valueOf(handles[0]));
156
157 int count = info[0]; // count
158 int maxlen = info[3]; // value length max
159 for (int index = 0; index < count; index++) {
160 byte[] name = (byte[]) regEnumValue.invoke(root, Integer.valueOf(handles[0]), Integer.valueOf(index), Integer.valueOf(maxlen + 1));
161 String value = readString(hkey, key, new String(name, StandardCharsets.UTF_8));
162 results.put(new String(name, StandardCharsets.UTF_8).trim(), value);
163 }
164 regCloseKey.invoke(root, Integer.valueOf(handles[0]));
165 return results;
166 }
167
168 private static List<String> readStringSubKeys(Preferences root, int hkey, String key)
169 throws IllegalAccessException, InvocationTargetException {
170 List<String> results = new ArrayList<>();
171 int[] handles = (int[]) regOpenKey.invoke(root, Integer.valueOf(hkey), toCstr(key), Integer.valueOf(KEY_READ));
172 if (handles[1] != REG_SUCCESS) {
173 return Collections.emptyList();
174 }
175 int[] info = (int[]) regQueryInfoKey.invoke(root, Integer.valueOf(handles[0]));
176
177 int count = info[0]; // Fix: info[2] was being used here with wrong results. Suggested by davenpcj, confirmed by Petrucio
178 int maxlen = info[3]; // value length max
179 for (int index = 0; index < count; index++) {
180 byte[] name = (byte[]) regEnumKeyEx.invoke(root, Integer.valueOf(handles[0]), Integer.valueOf(index), Integer.valueOf(maxlen + 1));
181 results.add(new String(name, StandardCharsets.UTF_8).trim());
182 }
183 regCloseKey.invoke(root, Integer.valueOf(handles[0]));
184 return results;
185 }
186
187 // utility
188 private static byte[] toCstr(String str) {
189 byte[] array = str.getBytes(StandardCharsets.UTF_8);
190 byte[] biggerCopy = Arrays.copyOf(array, array.length + 1);
191 biggerCopy[array.length] = 0;
192 return biggerCopy;
193 }
194}
Note: See TracBrowser for help on using the repository browser.