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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, 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)
30 #define WIN32_LEAN_AND_MEAN
37 #include <wine/debug.h>
38 #include <wine/list.h>
40 WINE_DEFAULT_DEBUG_CHANNEL(winecfg
);
45 HKEY config_key
= NULL
;
46 HMENU hPopupMenus
= 0;
49 /* this is called from the WM_SHOWWINDOW handlers of each tab page.
51 * it's a nasty hack, necessary because the property sheet insists on resetting the window title
52 * to the title of the tab, which is utterly useless. dropping the property sheet is on the todo list.
54 void set_window_title(HWND dialog
)
58 /* update the window title */
62 LoadStringW (GetModuleHandle(NULL
), IDS_WINECFG_TITLE_APP
, apptitle
,
63 sizeof(apptitle
)/sizeof(apptitle
[0]));
64 wsprintfW (newtitle
, apptitle
, current_app
);
68 LoadStringW (GetModuleHandle(NULL
), IDS_WINECFG_TITLE
, newtitle
,
69 sizeof(newtitle
)/sizeof(newtitle
[0]));
72 WINE_TRACE("setting title to %s\n", wine_dbgstr_w (newtitle
));
73 SendMessageW (GetParent(dialog
), PSM_SETTITLEW
, 0, (LPARAM
) newtitle
);
77 WCHAR
* load_string (UINT id
)
83 LoadStringW (GetModuleHandle (NULL
), id
, buf
, sizeof(buf
)/sizeof(buf
[0]));
86 newStr
= HeapAlloc (GetProcessHeap(), 0, (len
+ 1) * sizeof (WCHAR
));
87 memcpy (newStr
, buf
, len
* sizeof (WCHAR
));
93 * get_config_key: Retrieves a configuration value from the registry
95 * char *subkey : the name of the config section
96 * char *name : the name of the config value
97 * char *default : if the key isn't found, return this value instead
99 * Returns a buffer holding the value if successful, NULL if
100 * not. Caller is responsible for releasing the result.
103 static WCHAR
*get_config_key (HKEY root
, const WCHAR
*subkey
, const WCHAR
*name
, const WCHAR
*def
)
105 LPWSTR buffer
= NULL
;
110 WINE_TRACE("subkey=%s, name=%s, def=%s\n", wine_dbgstr_w(subkey
),
111 wine_dbgstr_w(name
), wine_dbgstr_w(def
));
113 res
= RegOpenKeyW(root
, subkey
, &hSubKey
);
114 if (res
!= ERROR_SUCCESS
)
116 if (res
== ERROR_FILE_NOT_FOUND
)
118 WINE_TRACE("Section key not present - using default\n");
119 return def
? strdupW(def
) : NULL
;
123 WINE_ERR("RegOpenKey failed on wine config key (res=%d)\n", res
);
128 res
= RegQueryValueExW(hSubKey
, name
, NULL
, NULL
, NULL
, &len
);
129 if (res
== ERROR_FILE_NOT_FOUND
)
131 WINE_TRACE("Value not present - using default\n");
132 buffer
= def
? strdupW(def
) : NULL
;
134 } else if (res
!= ERROR_SUCCESS
)
136 WINE_ERR("Couldn't query value's length (res=%d)\n", res
);
140 buffer
= HeapAlloc(GetProcessHeap(), 0, len
+ sizeof(WCHAR
));
142 RegQueryValueExW(hSubKey
, name
, NULL
, NULL
, (LPBYTE
) buffer
, &len
);
144 WINE_TRACE("buffer=%s\n", wine_dbgstr_w(buffer
));
146 if (hSubKey
&& hSubKey
!= root
) RegCloseKey(hSubKey
);
152 * set_config_key: convenience wrapper to set a key/value pair
154 * const char *subKey : the name of the config section
155 * const char *valueName : the name of the config value
156 * const char *value : the value to set the configuration key to
158 * Returns 0 on success, non-zero otherwise
160 * If valueName or value is NULL, an empty section will be created
162 static int set_config_key(HKEY root
, const WCHAR
*subkey
, const WCHAR
*name
, const void *value
, DWORD type
) {
166 WINE_TRACE("subkey=%s: name=%s, value=%p, type=%d\n", wine_dbgstr_w(subkey
),
167 wine_dbgstr_w(name
), value
, type
);
169 assert( subkey
!= NULL
);
173 res
= RegCreateKeyW(root
, subkey
, &key
);
174 if (res
!= ERROR_SUCCESS
) goto end
;
177 if (name
== NULL
|| value
== NULL
) goto end
;
181 case REG_SZ
: res
= RegSetValueExW(key
, name
, 0, REG_SZ
, value
, (lstrlenW(value
)+1)*sizeof(WCHAR
)); break;
182 case REG_DWORD
: res
= RegSetValueExW(key
, name
, 0, REG_DWORD
, value
, sizeof(DWORD
)); break;
184 if (res
!= ERROR_SUCCESS
) goto end
;
188 if (key
&& key
!= root
) RegCloseKey(key
);
190 WINE_ERR("Unable to set configuration key %s in section %s, res=%d\n",
191 wine_dbgstr_w(name
), wine_dbgstr_w(subkey
), res
);
195 /* removes the requested value from the registry, however, does not
196 * remove the section if empty. Returns S_OK (0) on success.
198 static HRESULT
remove_value(HKEY root
, const WCHAR
*subkey
, const WCHAR
*name
)
203 WINE_TRACE("subkey=%s, name=%s\n", wine_dbgstr_w(subkey
), wine_dbgstr_w(name
));
205 hr
= RegOpenKeyW(root
, subkey
, &key
);
206 if (hr
!= S_OK
) return hr
;
208 hr
= RegDeleteValueW(key
, name
);
209 if (hr
!= ERROR_SUCCESS
) return hr
;
214 /* ========================================================================= */
216 /* This code exists for the following reasons:
218 * - It makes working with the registry easier
219 * - By storing a mini cache of the registry, we can more easily implement
220 * cancel/revert and apply. The 'settings list' is an overlay on top of
221 * the actual registry data that we can write out at will.
223 * Rather than model a tree in memory, we simply store each absolute (rooted
224 * at the config key) path.
231 HKEY root
; /* the key on which path is rooted */
232 WCHAR
*path
; /* path in the registry rooted at root */
233 WCHAR
*name
; /* name of the registry value. if null, this means delete the key */
234 WCHAR
*value
; /* contents of the registry value. if null, this means delete the value */
235 DWORD type
; /* type of registry value. REG_SZ or REG_DWORD for now */
238 struct list
*settings
;
240 static void free_setting(struct setting
*setting
)
242 assert( setting
!= NULL
);
243 assert( setting
->path
);
245 WINE_TRACE("destroying %p: %s\n", setting
,
246 wine_dbgstr_w(setting
->path
));
248 HeapFree(GetProcessHeap(), 0, setting
->path
);
249 HeapFree(GetProcessHeap(), 0, setting
->name
);
250 HeapFree(GetProcessHeap(), 0, setting
->value
);
252 list_remove(&setting
->entry
);
254 HeapFree(GetProcessHeap(), 0, setting
);
258 * Returns the contents of the value at path. If not in the settings
259 * list, it will be fetched from the registry - failing that, the
260 * default will be used.
262 * If already in the list, the contents as given there will be
263 * returned. You are expected to HeapFree the result.
265 WCHAR
*get_reg_keyW(HKEY root
, const WCHAR
*path
, const WCHAR
*name
, const WCHAR
*def
)
271 WINE_TRACE("path=%s, name=%s, def=%s\n", wine_dbgstr_w(path
),
272 wine_dbgstr_w(name
), wine_dbgstr_w(def
));
274 /* check if it's in the list */
275 LIST_FOR_EACH( cursor
, settings
)
277 s
= LIST_ENTRY(cursor
, struct setting
, entry
);
279 if (root
!= s
->root
) continue;
280 if (lstrcmpiW(path
, s
->path
) != 0) continue;
281 if (!s
->name
) continue;
282 if (lstrcmpiW(name
, s
->name
) != 0) continue;
284 WINE_TRACE("found %s:%s in settings list, returning %s\n",
285 wine_dbgstr_w(path
), wine_dbgstr_w(name
),
286 wine_dbgstr_w(s
->value
));
287 return s
->value
? strdupW(s
->value
) : NULL
;
290 /* no, so get from the registry */
291 val
= get_config_key(root
, path
, name
, def
);
293 WINE_TRACE("returning %s\n", wine_dbgstr_w(val
));
298 char *get_reg_key(HKEY root
, const char *path
, const char *name
, const char *def
)
300 WCHAR
*wpath
, *wname
, *wdef
= NULL
, *wRet
= NULL
;
304 WINE_TRACE("path=%s, name=%s, def=%s\n", path
, name
, def
);
306 wpath
= HeapAlloc(GetProcessHeap(), 0, (strlen(path
)+1)*sizeof(WCHAR
));
307 wname
= HeapAlloc(GetProcessHeap(), 0, (strlen(name
)+1)*sizeof(WCHAR
));
309 MultiByteToWideChar(CP_ACP
, 0, path
, -1, wpath
, strlen(path
)+1);
310 MultiByteToWideChar(CP_ACP
, 0, name
, -1, wname
, strlen(name
)+1);
314 wdef
= HeapAlloc(GetProcessHeap(), 0, (strlen(def
)+1)*sizeof(WCHAR
));
315 MultiByteToWideChar(CP_ACP
, 0, def
, -1, wdef
, strlen(def
)+1);
318 wRet
= get_reg_keyW(root
, wpath
, wname
, wdef
);
320 len
= WideCharToMultiByte(CP_ACP
, 0, wRet
, -1, NULL
, 0, NULL
, NULL
);
323 szRet
= HeapAlloc(GetProcessHeap(), 0, len
);
324 WideCharToMultiByte(CP_ACP
, 0, wRet
, -1, szRet
, len
, NULL
, NULL
);
327 HeapFree(GetProcessHeap(), 0, wpath
);
328 HeapFree(GetProcessHeap(), 0, wname
);
329 HeapFree(GetProcessHeap(), 0, wdef
);
330 HeapFree(GetProcessHeap(), 0, wRet
);
336 * Used to set a registry key.
338 * path is rooted at the config key, ie use "Version" or
339 * "AppDefaults\\fooapp.exe\\Version". You can use keypath()
340 * to get such a string.
342 * name is the value name, or NULL to delete the path.
344 * value is what to set the value to, or NULL to delete it.
346 * type is REG_SZ or REG_DWORD.
348 * These values will be copied when necessary.
350 static void set_reg_key_ex(HKEY root
, const WCHAR
*path
, const WCHAR
*name
, const void *value
, DWORD type
)
355 assert( path
!= NULL
);
357 WINE_TRACE("path=%s, name=%s, value=%s\n", wine_dbgstr_w(path
),
358 wine_dbgstr_w(name
), wine_dbgstr_w(value
));
360 /* firstly, see if we already set this setting */
361 LIST_FOR_EACH( cursor
, settings
)
363 struct setting
*s
= LIST_ENTRY(cursor
, struct setting
, entry
);
365 if (root
!= s
->root
) continue;
366 if (lstrcmpiW(s
->path
, path
) != 0) continue;
367 if ((s
->name
&& name
) && lstrcmpiW(s
->name
, name
) != 0) continue;
369 /* are we attempting a double delete? */
370 if (!s
->name
&& !name
) return;
372 /* do we want to undelete this key? */
373 if (!s
->name
&& name
) s
->name
= strdupW(name
);
375 /* yes, we have already set it, so just replace the content and return */
376 HeapFree(GetProcessHeap(), 0, s
->value
);
381 s
->value
= value
? strdupW(value
) : NULL
;
384 s
->value
= HeapAlloc(GetProcessHeap(), 0, sizeof(DWORD
));
385 memcpy( s
->value
, value
, sizeof(DWORD
) );
389 /* are we deleting this key? this won't remove any of the
390 * children from the overlay so if the user adds it again in
391 * that session it will appear to undelete the settings, but
392 * in reality only the settings actually modified by the user
393 * in that session will be restored. we might want to fix this
394 * corner case in future by actually deleting all the children
395 * here so that once it's gone, it's gone.
397 if (!name
) s
->name
= NULL
;
402 /* otherwise add a new setting for it */
403 s
= HeapAlloc(GetProcessHeap(), 0, sizeof(struct setting
));
405 s
->path
= strdupW(path
);
406 s
->name
= name
? strdupW(name
) : NULL
;
411 s
->value
= value
? strdupW(value
) : NULL
;
414 s
->value
= HeapAlloc(GetProcessHeap(), 0, sizeof(DWORD
));
415 memcpy( s
->value
, value
, sizeof(DWORD
) );
419 list_add_tail(settings
, &s
->entry
);
422 void set_reg_key(HKEY root
, const char *path
, const char *name
, const char *value
)
424 WCHAR
*wpath
, *wname
= NULL
, *wvalue
= NULL
;
426 wpath
= HeapAlloc(GetProcessHeap(), 0, (strlen(path
)+1)*sizeof(WCHAR
));
427 MultiByteToWideChar(CP_ACP
, 0, path
, -1, wpath
, strlen(path
)+1);
431 wname
= HeapAlloc(GetProcessHeap(), 0, (strlen(name
)+1)*sizeof(WCHAR
));
432 MultiByteToWideChar(CP_ACP
, 0, name
, -1, wname
, strlen(name
)+1);
437 wvalue
= HeapAlloc(GetProcessHeap(), 0, (strlen(value
)+1)*sizeof(WCHAR
));
438 MultiByteToWideChar(CP_ACP
, 0, value
, -1, wvalue
, strlen(value
)+1);
441 set_reg_key_ex(root
, wpath
, wname
, wvalue
, REG_SZ
);
443 HeapFree(GetProcessHeap(), 0, wpath
);
444 HeapFree(GetProcessHeap(), 0, wname
);
445 HeapFree(GetProcessHeap(), 0, wvalue
);
448 void set_reg_key_dword(HKEY root
, const char *path
, const char *name
, DWORD value
)
450 WCHAR
*wpath
, *wname
;
452 wpath
= HeapAlloc(GetProcessHeap(), 0, (strlen(path
)+1)*sizeof(WCHAR
));
453 wname
= HeapAlloc(GetProcessHeap(), 0, (strlen(name
)+1)*sizeof(WCHAR
));
455 MultiByteToWideChar(CP_ACP
, 0, path
, -1, wpath
, strlen(path
)+1);
456 MultiByteToWideChar(CP_ACP
, 0, name
, -1, wname
, strlen(name
)+1);
458 set_reg_key_ex(root
, wpath
, wname
, &value
, REG_DWORD
);
460 HeapFree(GetProcessHeap(), 0, wpath
);
461 HeapFree(GetProcessHeap(), 0, wname
);
464 void set_reg_keyW(HKEY root
, const WCHAR
*path
, const WCHAR
*name
, const WCHAR
*value
)
466 set_reg_key_ex(root
, path
, name
, value
, REG_SZ
);
469 void set_reg_key_dwordW(HKEY root
, const WCHAR
*path
, const WCHAR
*name
, DWORD value
)
471 set_reg_key_ex(root
, path
, name
, &value
, REG_DWORD
);
475 * enumerates the value names at the given path, taking into account
476 * the changes in the settings list.
478 * you are expected to HeapFree each element of the array, which is null
479 * terminated, as well as the array itself.
481 WCHAR
**enumerate_valuesW(HKEY root
, WCHAR
*path
)
484 DWORD res
, i
= 0, valueslen
= 0;
485 WCHAR
**values
= NULL
;
488 res
= RegOpenKeyW(root
, path
, &key
);
489 if (res
== ERROR_SUCCESS
)
494 DWORD namesize
= sizeof(name
);
495 BOOL removed
= FALSE
;
497 /* find out the needed size, allocate a buffer, read the value */
498 if ((res
= RegEnumValueW(key
, i
, name
, &namesize
, NULL
, NULL
, NULL
, NULL
)) != ERROR_SUCCESS
)
501 WINE_TRACE("name=%s\n", wine_dbgstr_w(name
));
503 /* check if this value name has been removed in the settings list */
504 LIST_FOR_EACH( cursor
, settings
)
506 struct setting
*s
= LIST_ENTRY(cursor
, struct setting
, entry
);
507 if (lstrcmpiW(s
->path
, path
) != 0) continue;
508 if (lstrcmpiW(s
->name
, name
) != 0) continue;
512 WINE_TRACE("this key has been removed, so skipping\n");
518 if (removed
) /* this value was deleted by the user, so don't include it */
520 HeapFree(GetProcessHeap(), 0, name
);
525 /* grow the array if necessary, add buffer to it, iterate */
526 if (values
) values
= HeapReAlloc(GetProcessHeap(), 0, values
, sizeof(WCHAR
*) * (valueslen
+ 1));
527 else values
= HeapAlloc(GetProcessHeap(), 0, sizeof(WCHAR
*));
529 values
[valueslen
++] = strdupW(name
);
530 WINE_TRACE("valueslen is now %d\n", valueslen
);
536 WINE_WARN("failed opening registry key %s, res=0x%x\n",
537 wine_dbgstr_w(path
), res
);
540 WINE_TRACE("adding settings in list but not registry\n");
542 /* now we have to add the values that aren't in the registry but are in the settings list */
543 LIST_FOR_EACH( cursor
, settings
)
545 struct setting
*setting
= LIST_ENTRY(cursor
, struct setting
, entry
);
548 if (lstrcmpiW(setting
->path
, path
) != 0) continue;
550 if (!setting
->value
) continue;
552 for (i
= 0; i
< valueslen
; i
++)
554 if (lstrcmpiW(setting
->name
, values
[i
]) == 0)
563 WINE_TRACE("%s in list but not registry\n", wine_dbgstr_w(setting
->name
));
565 /* otherwise it's been set by the user but isn't in the registry */
566 if (values
) values
= HeapReAlloc(GetProcessHeap(), 0, values
, sizeof(WCHAR
*) * (valueslen
+ 1));
567 else values
= HeapAlloc(GetProcessHeap(), 0, sizeof(WCHAR
*));
569 values
[valueslen
++] = strdupW(setting
->name
);
572 WINE_TRACE("adding null terminator\n");
575 values
= HeapReAlloc(GetProcessHeap(), 0, values
, sizeof(WCHAR
*) * (valueslen
+ 1));
576 values
[valueslen
] = NULL
;
584 char **enumerate_values(HKEY root
, char *path
)
591 wpath
= HeapAlloc(GetProcessHeap(), 0, (strlen(path
)+1)*sizeof(WCHAR
));
592 MultiByteToWideChar(CP_ACP
, 0, path
, -1, wpath
, strlen(path
)+1);
594 wret
= enumerate_valuesW(root
, wpath
);
598 for(len
=0; wret
[len
]; len
++);
599 ret
= HeapAlloc(GetProcessHeap(), 0, (len
+1)*sizeof(char*));
601 /* convert WCHAR ** to char ** and HeapFree each WCHAR * element on our way */
602 for (i
=0; i
<len
; i
++)
604 ret
[i
] = HeapAlloc(GetProcessHeap(), 0,
605 (lstrlenW(wret
[i
]) + 1) * sizeof(char));
606 WideCharToMultiByte(CP_ACP
, 0, wret
[i
], -1, ret
[i
],
607 lstrlenW(wret
[i
]) + 1, NULL
, NULL
);
608 HeapFree(GetProcessHeap(), 0, wret
[i
]);
613 HeapFree(GetProcessHeap(), 0, wpath
);
614 HeapFree(GetProcessHeap(), 0, wret
);
620 * returns true if the given key/value pair exists in the registry or
621 * has been written to.
623 BOOL
reg_key_exists(HKEY root
, const char *path
, const char *name
)
625 char *val
= get_reg_key(root
, path
, name
, NULL
);
629 HeapFree(GetProcessHeap(), 0, val
);
636 static void process_setting(struct setting
*s
)
640 WINE_TRACE("Setting %s:%s to '%s'\n", wine_dbgstr_w(s
->path
),
641 wine_dbgstr_w(s
->name
), wine_dbgstr_w(s
->value
));
642 set_config_key(s
->root
, s
->path
, s
->name
, s
->value
, s
->type
);
646 /* NULL name means remove that path/section entirely */
647 if (s
->path
&& s
->name
) remove_value(s
->root
, s
->path
, s
->name
);
648 else if (s
->path
&& !s
->name
) RegDeleteTreeW(s
->root
, s
->path
);
654 if (list_empty(settings
)) return; /* we will be called for each page when the user clicks OK */
658 while (!list_empty(settings
))
660 struct setting
*s
= (struct setting
*) list_head(settings
);
666 /* ================================== utility functions ============================ */
668 WCHAR
* current_app
= NULL
; /* the app we are currently editing, or NULL if editing global */
670 /* returns a registry key path suitable for passing to addTransaction */
671 char *keypath(const char *section
)
673 static char *result
= NULL
;
675 HeapFree(GetProcessHeap(), 0, result
);
679 result
= HeapAlloc(GetProcessHeap(), 0, strlen("AppDefaults\\") + lstrlenW(current_app
)*2 + 2 /* \\ */ + strlen(section
) + 1 /* terminator */);
680 wsprintf(result
, "AppDefaults\\%ls", current_app
);
681 if (section
[0]) sprintf( result
+ strlen(result
), "\\%s", section
);
685 result
= strdupA(section
);
691 WCHAR
*keypathW(const WCHAR
*section
)
693 static const WCHAR appdefaultsW
[] = {'A','p','p','D','e','f','a','u','l','t','s','\\',0};
694 static WCHAR
*result
= NULL
;
696 HeapFree(GetProcessHeap(), 0, result
);
700 DWORD len
= sizeof(appdefaultsW
) + (lstrlenW(current_app
) + lstrlenW(section
) + 1) * sizeof(WCHAR
);
701 result
= HeapAlloc(GetProcessHeap(), 0, len
);
702 lstrcpyW( result
, appdefaultsW
);
703 lstrcatW( result
, current_app
);
706 len
= lstrlenW(result
);
707 result
[len
++] = '\\';
708 lstrcpyW( result
+ len
, section
);
713 result
= strdupW(section
);
719 void PRINTERROR(void)
723 FormatMessageA(FORMAT_MESSAGE_ALLOCATE_BUFFER
|FORMAT_MESSAGE_FROM_SYSTEM
,
724 0, GetLastError(), MAKELANGID(LANG_NEUTRAL
,SUBLANG_DEFAULT
),
725 (LPSTR
)&msg
, 0, NULL
);
727 /* eliminate trailing newline, is this a Wine bug? */
728 *(strrchr(msg
, '\r')) = '\0';
730 WINE_TRACE("error: '%s'\n", msg
);
733 int initialize(HINSTANCE hInstance
)
735 DWORD res
= RegCreateKey(HKEY_CURRENT_USER
, WINE_KEY_ROOT
, &config_key
);
737 if (res
!= ERROR_SUCCESS
) {
738 WINE_ERR("RegOpenKey failed on wine config key (%d)\n", res
);
743 hPopupMenus
= LoadMenu(hInstance
, MAKEINTRESOURCE(IDR_WINECFG
));
745 /* we could probably just have the list as static data */
746 settings
= HeapAlloc(GetProcessHeap(), 0, sizeof(struct list
));