2 * WineCfg configuration management
4 * Copyright 2002 Jaco Greeff
5 * Copyright 2003 Dimitrie O. Paun
6 * Copyright 2003-2004 Mike Hearn
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2.1 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 * - Icons in listviews/icons
25 * - Better add app dialog, scan c: for EXE files and add to list in background
26 * - Use [GNOME] HIG style groupboxes rather than win32 style (looks nicer, imho)
35 #include <wine/debug.h>
36 #include <wine/list.h>
38 WINE_DEFAULT_DEBUG_CHANNEL(winecfg
);
42 HKEY config_key
= NULL
;
46 /* this is called from the WM_SHOWWINDOW handlers of each tab page.
48 * it's a nasty hack, necessary because the property sheet insists on resetting the window title
49 * to the title of the tab, which is utterly useless. dropping the property sheet is on the todo list.
51 void set_window_title(HWND dialog
)
55 /* update the window title */
58 const char *template = "Wine Configuration for %s";
59 newtitle
= HeapAlloc(GetProcessHeap(), 0, strlen(template) + strlen(current_app
) + 1);
60 sprintf(newtitle
, template, current_app
);
64 newtitle
= strdupA("Wine Configuration");
67 WINE_TRACE("setting title to %s\n", newtitle
);
68 SendMessage(GetParent(dialog
), PSM_SETTITLE
, 0, (LPARAM
) newtitle
);
69 HeapFree(GetProcessHeap(), 0, newtitle
);
74 * get_config_key: Retrieves a configuration value from the registry
76 * char *subkey : the name of the config section
77 * char *name : the name of the config value
78 * char *default : if the key isn't found, return this value instead
80 * Returns a buffer holding the value if successful, NULL if
81 * not. Caller is responsible for releasing the result.
84 static char *get_config_key (HKEY root
, const char *subkey
, const char *name
, const char *def
)
91 WINE_TRACE("subkey=%s, name=%s, def=%s\n", subkey
, name
, def
);
93 res
= RegOpenKey(root
, subkey
, &hSubKey
);
94 if (res
!= ERROR_SUCCESS
)
96 if (res
== ERROR_FILE_NOT_FOUND
)
98 WINE_TRACE("Section key not present - using default\n");
99 return def
? strdupA(def
) : NULL
;
103 WINE_ERR("RegOpenKey failed on wine config key (res=%ld)\n", res
);
108 res
= RegQueryValueExA(hSubKey
, name
, NULL
, NULL
, NULL
, &len
);
109 if (res
== ERROR_FILE_NOT_FOUND
)
111 WINE_TRACE("Value not present - using default\n");
112 buffer
= def
? strdupA(def
) : NULL
;
114 } else if (res
!= ERROR_SUCCESS
)
116 WINE_ERR("Couldn't query value's length (res=%ld)\n", res
);
120 buffer
= HeapAlloc(GetProcessHeap(), 0, len
+ 1);
122 RegQueryValueEx(hSubKey
, name
, NULL
, NULL
, buffer
, &len
);
124 WINE_TRACE("buffer=%s\n", buffer
);
126 if (hSubKey
&& hSubKey
!= root
) RegCloseKey(hSubKey
);
128 return (char*)buffer
;
132 * set_config_key: convenience wrapper to set a key/value pair
134 * const char *subKey : the name of the config section
135 * const char *valueName : the name of the config value
136 * const char *value : the value to set the configuration key to
138 * Returns 0 on success, non-zero otherwise
140 * If valueName or value is NULL, an empty section will be created
142 static int set_config_key(HKEY root
, const char *subkey
, const char *name
, const char *value
) {
146 WINE_TRACE("subkey=%s: name=%s, value=%s\n", subkey
, name
, value
);
148 assert( subkey
!= NULL
);
152 res
= RegCreateKey(root
, subkey
, &key
);
153 if (res
!= ERROR_SUCCESS
) goto end
;
156 if (name
== NULL
|| value
== NULL
) goto end
;
158 res
= RegSetValueEx(key
, name
, 0, REG_SZ
, value
, strlen(value
) + 1);
159 if (res
!= ERROR_SUCCESS
) goto end
;
163 if (key
&& key
!= root
) RegCloseKey(key
);
164 if (res
!= 0) WINE_ERR("Unable to set configuration key %s in section %s to %s, res=%ld\n", name
, subkey
, value
, res
);
168 /* removes the requested value from the registry, however, does not
169 * remove the section if empty. Returns S_OK (0) on success.
171 static HRESULT
remove_value(HKEY root
, const char *subkey
, const char *name
)
176 WINE_TRACE("subkey=%s, name=%s\n", subkey
, name
);
178 hr
= RegOpenKey(root
, subkey
, &key
);
179 if (hr
!= S_OK
) return hr
;
181 hr
= RegDeleteValue(key
, name
);
182 if (hr
!= ERROR_SUCCESS
) return hr
;
187 /* removes the requested subkey from the registry, assuming it exists */
188 static HRESULT
remove_path(HKEY root
, char *section
) {
189 WINE_TRACE("section=%s\n", section
);
191 return RegDeleteKey(root
, section
);
195 /* ========================================================================= */
197 /* This code exists for the following reasons:
199 * - It makes working with the registry easier
200 * - By storing a mini cache of the registry, we can more easily implement
201 * cancel/revert and apply. The 'settings list' is an overlay on top of
202 * the actual registry data that we can write out at will.
204 * Rather than model a tree in memory, we simply store each absolute (rooted
205 * at the config key) path.
212 HKEY root
; /* the key on which path is rooted */
213 char *path
; /* path in the registry rooted at root */
214 char *name
; /* name of the registry value. if null, this means delete the key */
215 char *value
; /* contents of the registry value. if null, this means delete the value */
218 struct list
*settings
;
220 static void free_setting(struct setting
*setting
)
222 assert( setting
!= NULL
);
223 assert( setting
->path
);
225 WINE_TRACE("destroying %p: %s\n", setting
, setting
->path
);
227 HeapFree(GetProcessHeap(), 0, setting
->path
);
228 HeapFree(GetProcessHeap(), 0, setting
->name
);
229 HeapFree(GetProcessHeap(), 0, setting
->value
);
231 list_remove(&setting
->entry
);
233 HeapFree(GetProcessHeap(), 0, setting
);
237 * Returns the contents of the value at path. If not in the settings
238 * list, it will be fetched from the registry - failing that, the
239 * default will be used.
241 * If already in the list, the contents as given there will be
242 * returned. You are expected to HeapFree the result.
244 char *get_reg_key(HKEY root
, const char *path
, const char *name
, const char *def
)
250 WINE_TRACE("path=%s, name=%s, def=%s\n", path
, name
, def
);
252 /* check if it's in the list */
253 LIST_FOR_EACH( cursor
, settings
)
255 s
= LIST_ENTRY(cursor
, struct setting
, entry
);
257 if (root
!= s
->root
) continue;
258 if (strcasecmp(path
, s
->path
) != 0) continue;
259 if (strcasecmp(name
, s
->name
) != 0) continue;
261 WINE_TRACE("found %s:%s in settings list, returning %s\n", path
, name
, s
->value
);
262 return s
->value
? strdupA(s
->value
) : NULL
;
265 /* no, so get from the registry */
266 val
= get_config_key(root
, path
, name
, def
);
268 WINE_TRACE("returning %s\n", val
);
274 * Used to set a registry key.
276 * path is rooted at the config key, ie use "Version" or
277 * "AppDefaults\\fooapp.exe\\Version". You can use keypath()
278 * to get such a string.
280 * name is the value name, or NULL to delete the path.
282 * value is what to set the value to, or NULL to delete it.
284 * These values will be copied when necessary.
286 void set_reg_key(HKEY root
, const char *path
, const char *name
, const char *value
)
291 assert( path
!= NULL
);
293 WINE_TRACE("path=%s, name=%s, value=%s\n", path
, name
, value
);
295 /* firstly, see if we already set this setting */
296 LIST_FOR_EACH( cursor
, settings
)
298 struct setting
*s
= LIST_ENTRY(cursor
, struct setting
, entry
);
300 if (root
!= s
->root
) continue;
301 if (strcasecmp(s
->path
, path
) != 0) continue;
302 if ((s
->name
&& name
) && strcasecmp(s
->name
, name
) != 0) continue;
304 /* are we attempting a double delete? */
305 if (!s
->name
&& !name
) return;
307 /* do we want to undelete this key? */
308 if (!s
->name
&& name
) s
->name
= strdupA(name
);
310 /* yes, we have already set it, so just replace the content and return */
311 HeapFree(GetProcessHeap(), 0, s
->value
);
312 s
->value
= value
? strdupA(value
) : NULL
;
314 /* are we deleting this key? this won't remove any of the
315 * children from the overlay so if the user adds it again in
316 * that session it will appear to undelete the settings, but
317 * in reality only the settings actually modified by the user
318 * in that session will be restored. we might want to fix this
319 * corner case in future by actually deleting all the children
320 * here so that once it's gone, it's gone.
322 if (!name
) s
->name
= NULL
;
327 /* otherwise add a new setting for it */
328 s
= HeapAlloc(GetProcessHeap(), 0, sizeof(struct setting
));
330 s
->path
= strdupA(path
);
331 s
->name
= name
? strdupA(name
) : NULL
;
332 s
->value
= value
? strdupA(value
) : NULL
;
334 list_add_tail(settings
, &s
->entry
);
338 * enumerates the value names at the given path, taking into account
339 * the changes in the settings list.
341 * you are expected to HeapFree each element of the array, which is null
342 * terminated, as well as the array itself.
344 char **enumerate_values(HKEY root
, char *path
)
348 char **values
= NULL
;
352 res
= RegOpenKey(root
, path
, &key
);
353 if (res
== ERROR_SUCCESS
)
358 DWORD namesize
= sizeof(name
);
359 BOOL removed
= FALSE
;
361 /* find out the needed size, allocate a buffer, read the value */
362 if ((res
= RegEnumValue(key
, i
, name
, &namesize
, NULL
, NULL
, NULL
, NULL
)) != ERROR_SUCCESS
)
365 WINE_TRACE("name=%s\n", name
);
367 /* check if this value name has been removed in the settings list */
368 LIST_FOR_EACH( cursor
, settings
)
370 struct setting
*s
= LIST_ENTRY(cursor
, struct setting
, entry
);
371 if (strcasecmp(s
->path
, path
) != 0) continue;
372 if (strcasecmp(s
->name
, name
) != 0) continue;
376 WINE_TRACE("this key has been removed, so skipping\n");
382 if (removed
) /* this value was deleted by the user, so don't include it */
384 HeapFree(GetProcessHeap(), 0, name
);
389 /* grow the array if necessary, add buffer to it, iterate */
390 if (values
) values
= HeapReAlloc(GetProcessHeap(), 0, values
, sizeof(char*) * (valueslen
+ 1));
391 else values
= HeapAlloc(GetProcessHeap(), 0, sizeof(char*));
393 values
[valueslen
++] = strdupA(name
);
394 WINE_TRACE("valueslen is now %d\n", valueslen
);
400 WINE_WARN("failed opening registry key %s, res=0x%lx\n", path
, res
);
403 WINE_TRACE("adding settings in list but not registry\n");
405 /* now we have to add the values that aren't in the registry but are in the settings list */
406 LIST_FOR_EACH( cursor
, settings
)
408 struct setting
*setting
= LIST_ENTRY(cursor
, struct setting
, entry
);
411 if (strcasecmp(setting
->path
, path
) != 0) continue;
413 if (!setting
->value
) continue;
415 for (i
= 0; i
< valueslen
; i
++)
417 if (strcasecmp(setting
->name
, values
[i
]) == 0)
426 WINE_TRACE("%s in list but not registry\n", setting
->name
);
428 /* otherwise it's been set by the user but isn't in the registry */
429 if (values
) values
= HeapReAlloc(GetProcessHeap(), 0, values
, sizeof(char*) * (valueslen
+ 1));
430 else values
= HeapAlloc(GetProcessHeap(), 0, sizeof(char*));
432 values
[valueslen
++] = strdupA(setting
->name
);
435 WINE_TRACE("adding null terminator\n");
438 values
= HeapReAlloc(GetProcessHeap(), 0, values
, sizeof(char*) * (valueslen
+ 1));
439 values
[valueslen
] = NULL
;
448 * returns true if the given key/value pair exists in the registry or
449 * has been written to.
451 BOOL
reg_key_exists(HKEY root
, const char *path
, const char *name
)
453 char *val
= get_reg_key(root
, path
, name
, NULL
);
457 HeapFree(GetProcessHeap(), 0, val
);
464 static void process_setting(struct setting
*s
)
468 WINE_TRACE("Setting %s:%s to '%s'\n", s
->path
, s
->name
, s
->value
);
469 set_config_key(s
->root
, s
->path
, s
->name
, s
->value
);
473 /* NULL name means remove that path/section entirely */
474 if (s
->path
&& s
->name
) remove_value(s
->root
, s
->path
, s
->name
);
475 else if (s
->path
&& !s
->name
) remove_path(s
->root
, s
->path
);
481 if (list_empty(settings
)) return; /* we will be called for each page when the user clicks OK */
485 while (!list_empty(settings
))
487 struct setting
*s
= (struct setting
*) list_head(settings
);
493 /* ================================== utility functions ============================ */
495 char *current_app
= NULL
; /* the app we are currently editing, or NULL if editing global */
497 /* returns a registry key path suitable for passing to addTransaction */
498 char *keypath(const char *section
)
500 static char *result
= NULL
;
502 HeapFree(GetProcessHeap(), 0, result
);
506 result
= HeapAlloc(GetProcessHeap(), 0, strlen("AppDefaults\\") + strlen(current_app
) + 2 /* \\ */ + strlen(section
) + 1 /* terminator */);
507 sprintf(result
, "AppDefaults\\%s", current_app
);
508 if (section
[0]) sprintf( result
+ strlen(result
), "\\%s", section
);
512 result
= strdupA(section
);
518 void PRINTERROR(void)
522 FormatMessageA(FORMAT_MESSAGE_ALLOCATE_BUFFER
|FORMAT_MESSAGE_FROM_SYSTEM
,
523 0, GetLastError(), MAKELANGID(LANG_NEUTRAL
,SUBLANG_DEFAULT
),
524 (LPSTR
)&msg
, 0, NULL
);
526 /* eliminate trailing newline, is this a Wine bug? */
527 *(strrchr(msg
, '\r')) = '\0';
529 WINE_TRACE("error: '%s'\n", msg
);
532 int initialize(void) {
533 DWORD res
= RegCreateKey(HKEY_CURRENT_USER
, WINE_KEY_ROOT
, &config_key
);
535 if (res
!= ERROR_SUCCESS
) {
536 WINE_ERR("RegOpenKey failed on wine config key (%ld)\n", res
);
540 /* we could probably just have the list as static data */
541 settings
= HeapAlloc(GetProcessHeap(), 0, sizeof(struct list
));