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 /* removes the requested subkey from the registry, assuming it exists */
215 static LONG remove_path(HKEY root, WCHAR *section) {
217 DWORD max_sub_key_len;
220 LONG ret = ERROR_SUCCESS;
224 WINE_TRACE("section=%s\n", wine_dbgstr_w(section));
226 if ((ret = RegOpenKeyW(root, section, &branch_key)) != ERROR_SUCCESS)
229 /* get size information and resize the buffers if necessary */
230 if ((ret = RegQueryInfoKeyW(branch_key, NULL, NULL, NULL,
231 &subkeys, &max_sub_key_len,
232 NULL, NULL, NULL, NULL, NULL, NULL
236 curr_len = lstrlenW(section);
237 buffer = HeapAlloc(GetProcessHeap(), 0, (max_sub_key_len + curr_len + 1)*sizeof(WCHAR));
238 lstrcpyW(buffer, section);
240 buffer[curr_len] = '\\';
241 for (i = subkeys - 1; i >= 0; i--)
243 DWORD buf_len = max_sub_key_len - curr_len - 1;
245 ret = RegEnumKeyExW(branch_key, i, buffer + curr_len + 1,
246 &buf_len, NULL, NULL, NULL, NULL);
247 if (ret != ERROR_SUCCESS && ret != ERROR_MORE_DATA &&
248 ret != ERROR_NO_MORE_ITEMS)
251 remove_path(root, buffer);
253 HeapFree(GetProcessHeap(), 0, buffer);
254 RegCloseKey(branch_key);
256 return RegDeleteKeyW(root, section);
260 /* ========================================================================= */
262 /* This code exists for the following reasons:
264 * - It makes working with the registry easier
265 * - By storing a mini cache of the registry, we can more easily implement
266 * cancel/revert and apply. The 'settings list' is an overlay on top of
267 * the actual registry data that we can write out at will.
269 * Rather than model a tree in memory, we simply store each absolute (rooted
270 * at the config key) path.
277 HKEY root; /* the key on which path is rooted */
278 WCHAR *path; /* path in the registry rooted at root */
279 WCHAR *name; /* name of the registry value. if null, this means delete the key */
280 WCHAR *value; /* contents of the registry value. if null, this means delete the value */
281 DWORD type; /* type of registry value. REG_SZ or REG_DWORD for now */
284 struct list *settings;
286 static void free_setting(struct setting *setting)
288 assert( setting != NULL );
289 assert( setting->path );
291 WINE_TRACE("destroying %p: %s\n", setting,
292 wine_dbgstr_w(setting->path));
294 HeapFree(GetProcessHeap(), 0, setting->path);
295 HeapFree(GetProcessHeap(), 0, setting->name);
296 HeapFree(GetProcessHeap(), 0, setting->value);
298 list_remove(&setting->entry);
300 HeapFree(GetProcessHeap(), 0, setting);
304 * Returns the contents of the value at path. If not in the settings
305 * list, it will be fetched from the registry - failing that, the
306 * default will be used.
308 * If already in the list, the contents as given there will be
309 * returned. You are expected to HeapFree the result.
311 WCHAR *get_reg_keyW(HKEY root, const WCHAR *path, const WCHAR *name, const WCHAR *def)
317 WINE_TRACE("path=%s, name=%s, def=%s\n", wine_dbgstr_w(path),
318 wine_dbgstr_w(name), wine_dbgstr_w(def));
320 /* check if it's in the list */
321 LIST_FOR_EACH( cursor, settings )
323 s = LIST_ENTRY(cursor, struct setting, entry);
325 if (root != s->root) continue;
326 if (lstrcmpiW(path, s->path) != 0) continue;
327 if (!s->name) continue;
328 if (lstrcmpiW(name, s->name) != 0) continue;
330 WINE_TRACE("found %s:%s in settings list, returning %s\n",
331 wine_dbgstr_w(path), wine_dbgstr_w(name),
332 wine_dbgstr_w(s->value));
333 return s->value ? strdupW(s->value) : NULL;
336 /* no, so get from the registry */
337 val = get_config_key(root, path, name, def);
339 WINE_TRACE("returning %s\n", wine_dbgstr_w(val));
344 char *get_reg_key(HKEY root, const char *path, const char *name, const char *def)
346 WCHAR *wpath, *wname, *wdef = NULL, *wRet = NULL;
350 WINE_TRACE("path=%s, name=%s, def=%s\n", path, name, def);
352 wpath = HeapAlloc(GetProcessHeap(), 0, (strlen(path)+1)*sizeof(WCHAR));
353 wname = HeapAlloc(GetProcessHeap(), 0, (strlen(name)+1)*sizeof(WCHAR));
355 MultiByteToWideChar(CP_ACP, 0, path, -1, wpath, strlen(path)+1);
356 MultiByteToWideChar(CP_ACP, 0, name, -1, wname, strlen(name)+1);
360 wdef = HeapAlloc(GetProcessHeap(), 0, (strlen(def)+1)*sizeof(WCHAR));
361 MultiByteToWideChar(CP_ACP, 0, def, -1, wdef, strlen(def)+1);
364 wRet = get_reg_keyW(root, wpath, wname, wdef);
366 len = WideCharToMultiByte(CP_ACP, 0, wRet, -1, NULL, 0, NULL, NULL);
369 szRet = HeapAlloc(GetProcessHeap(), 0, len);
370 WideCharToMultiByte(CP_ACP, 0, wRet, -1, szRet, len, NULL, NULL);
373 HeapFree(GetProcessHeap(), 0, wpath);
374 HeapFree(GetProcessHeap(), 0, wname);
375 HeapFree(GetProcessHeap(), 0, wdef);
376 HeapFree(GetProcessHeap(), 0, wRet);
382 * Used to set a registry key.
384 * path is rooted at the config key, ie use "Version" or
385 * "AppDefaults\\fooapp.exe\\Version". You can use keypath()
386 * to get such a string.
388 * name is the value name, or NULL to delete the path.
390 * value is what to set the value to, or NULL to delete it.
392 * type is REG_SZ or REG_DWORD.
394 * These values will be copied when necessary.
396 static void set_reg_key_ex(HKEY root, const WCHAR *path, const WCHAR *name, const void *value, DWORD type)
401 assert( path != NULL );
403 WINE_TRACE("path=%s, name=%s, value=%s\n", wine_dbgstr_w(path),
404 wine_dbgstr_w(name), wine_dbgstr_w(value));
406 /* firstly, see if we already set this setting */
407 LIST_FOR_EACH( cursor, settings )
409 struct setting *s = LIST_ENTRY(cursor, struct setting, entry);
411 if (root != s->root) continue;
412 if (lstrcmpiW(s->path, path) != 0) continue;
413 if ((s->name && name) && lstrcmpiW(s->name, name) != 0) continue;
415 /* are we attempting a double delete? */
416 if (!s->name && !name) return;
418 /* do we want to undelete this key? */
419 if (!s->name && name) s->name = strdupW(name);
421 /* yes, we have already set it, so just replace the content and return */
422 HeapFree(GetProcessHeap(), 0, s->value);
427 s->value = value ? strdupW(value) : NULL;
430 s->value = HeapAlloc(GetProcessHeap(), 0, sizeof(DWORD));
431 memcpy( s->value, value, sizeof(DWORD) );
435 /* are we deleting this key? this won't remove any of the
436 * children from the overlay so if the user adds it again in
437 * that session it will appear to undelete the settings, but
438 * in reality only the settings actually modified by the user
439 * in that session will be restored. we might want to fix this
440 * corner case in future by actually deleting all the children
441 * here so that once it's gone, it's gone.
443 if (!name) s->name = NULL;
448 /* otherwise add a new setting for it */
449 s = HeapAlloc(GetProcessHeap(), 0, sizeof(struct setting));
451 s->path = strdupW(path);
452 s->name = name ? strdupW(name) : NULL;
457 s->value = value ? strdupW(value) : NULL;
460 s->value = HeapAlloc(GetProcessHeap(), 0, sizeof(DWORD));
461 memcpy( s->value, value, sizeof(DWORD) );
465 list_add_tail(settings, &s->entry);
468 void set_reg_key(HKEY root, const char *path, const char *name, const char *value)
470 WCHAR *wpath, *wname = NULL, *wvalue = NULL;
472 wpath = HeapAlloc(GetProcessHeap(), 0, (strlen(path)+1)*sizeof(WCHAR));
473 MultiByteToWideChar(CP_ACP, 0, path, -1, wpath, strlen(path)+1);
477 wname = HeapAlloc(GetProcessHeap(), 0, (strlen(name)+1)*sizeof(WCHAR));
478 MultiByteToWideChar(CP_ACP, 0, name, -1, wname, strlen(name)+1);
483 wvalue = HeapAlloc(GetProcessHeap(), 0, (strlen(value)+1)*sizeof(WCHAR));
484 MultiByteToWideChar(CP_ACP, 0, value, -1, wvalue, strlen(value)+1);
487 set_reg_key_ex(root, wpath, wname, wvalue, REG_SZ);
489 HeapFree(GetProcessHeap(), 0, wpath);
490 HeapFree(GetProcessHeap(), 0, wname);
491 HeapFree(GetProcessHeap(), 0, wvalue);
494 void set_reg_key_dword(HKEY root, const char *path, const char *name, DWORD value)
496 WCHAR *wpath, *wname;
498 wpath = HeapAlloc(GetProcessHeap(), 0, (strlen(path)+1)*sizeof(WCHAR));
499 wname = HeapAlloc(GetProcessHeap(), 0, (strlen(name)+1)*sizeof(WCHAR));
501 MultiByteToWideChar(CP_ACP, 0, path, -1, wpath, strlen(path)+1);
502 MultiByteToWideChar(CP_ACP, 0, name, -1, wname, strlen(name)+1);
504 set_reg_key_ex(root, wpath, wname, &value, REG_DWORD);
506 HeapFree(GetProcessHeap(), 0, wpath);
507 HeapFree(GetProcessHeap(), 0, wname);
511 * enumerates the value names at the given path, taking into account
512 * the changes in the settings list.
514 * you are expected to HeapFree each element of the array, which is null
515 * terminated, as well as the array itself.
517 WCHAR **enumerate_valuesW(HKEY root, WCHAR *path)
521 WCHAR **values = NULL;
525 res = RegOpenKeyW(root, path, &key);
526 if (res == ERROR_SUCCESS)
531 DWORD namesize = sizeof(name);
532 BOOL removed = FALSE;
534 /* find out the needed size, allocate a buffer, read the value */
535 if ((res = RegEnumValueW(key, i, name, &namesize, NULL, NULL, NULL, NULL)) != ERROR_SUCCESS)
538 WINE_TRACE("name=%s\n", wine_dbgstr_w(name));
540 /* check if this value name has been removed in the settings list */
541 LIST_FOR_EACH( cursor, settings )
543 struct setting *s = LIST_ENTRY(cursor, struct setting, entry);
544 if (lstrcmpiW(s->path, path) != 0) continue;
545 if (lstrcmpiW(s->name, name) != 0) continue;
549 WINE_TRACE("this key has been removed, so skipping\n");
555 if (removed) /* this value was deleted by the user, so don't include it */
557 HeapFree(GetProcessHeap(), 0, name);
562 /* grow the array if necessary, add buffer to it, iterate */
563 if (values) values = HeapReAlloc(GetProcessHeap(), 0, values, sizeof(WCHAR*) * (valueslen + 1));
564 else values = HeapAlloc(GetProcessHeap(), 0, sizeof(WCHAR*));
566 values[valueslen++] = strdupW(name);
567 WINE_TRACE("valueslen is now %d\n", valueslen);
573 WINE_WARN("failed opening registry key %s, res=0x%x\n",
574 wine_dbgstr_w(path), res);
577 WINE_TRACE("adding settings in list but not registry\n");
579 /* now we have to add the values that aren't in the registry but are in the settings list */
580 LIST_FOR_EACH( cursor, settings )
582 struct setting *setting = LIST_ENTRY(cursor, struct setting, entry);
585 if (lstrcmpiW(setting->path, path) != 0) continue;
587 if (!setting->value) continue;
589 for (i = 0; i < valueslen; i++)
591 if (lstrcmpiW(setting->name, values[i]) == 0)
600 WINE_TRACE("%s in list but not registry\n", wine_dbgstr_w(setting->name));
602 /* otherwise it's been set by the user but isn't in the registry */
603 if (values) values = HeapReAlloc(GetProcessHeap(), 0, values, sizeof(WCHAR*) * (valueslen + 1));
604 else values = HeapAlloc(GetProcessHeap(), 0, sizeof(WCHAR*));
606 values[valueslen++] = strdupW(setting->name);
609 WINE_TRACE("adding null terminator\n");
612 values = HeapReAlloc(GetProcessHeap(), 0, values, sizeof(WCHAR*) * (valueslen + 1));
613 values[valueslen] = NULL;
621 char **enumerate_values(HKEY root, char *path)
628 wpath = HeapAlloc(GetProcessHeap(), 0, (strlen(path)+1)*sizeof(WCHAR));
629 MultiByteToWideChar(CP_ACP, 0, path, -1, wpath, strlen(path)+1);
631 wret = enumerate_valuesW(root, wpath);
635 for(len=0; wret[len]; len++);
636 ret = HeapAlloc(GetProcessHeap(), 0, (len+1)*sizeof(char*));
638 /* convert WCHAR ** to char ** and HeapFree each WCHAR * element on our way */
639 for (i=0; i<len; i++)
641 ret[i] = HeapAlloc(GetProcessHeap(), 0,
642 (lstrlenW(wret[i]) + 1) * sizeof(char));
643 WideCharToMultiByte(CP_ACP, 0, wret[i], -1, ret[i],
644 lstrlenW(wret[i]) + 1, NULL, NULL);
645 HeapFree(GetProcessHeap(), 0, wret[i]);
650 HeapFree(GetProcessHeap(), 0, wpath);
651 HeapFree(GetProcessHeap(), 0, wret);
657 * returns true if the given key/value pair exists in the registry or
658 * has been written to.
660 BOOL reg_key_exists(HKEY root, const char *path, const char *name)
662 char *val = get_reg_key(root, path, name, NULL);
666 HeapFree(GetProcessHeap(), 0, val);
673 static void process_setting(struct setting *s)
677 WINE_TRACE("Setting %s:%s to '%s'\n", wine_dbgstr_w(s->path),
678 wine_dbgstr_w(s->name), wine_dbgstr_w(s->value));
679 set_config_key(s->root, s->path, s->name, s->value, s->type);
683 /* NULL name means remove that path/section entirely */
684 if (s->path && s->name) remove_value(s->root, s->path, s->name);
685 else if (s->path && !s->name) remove_path(s->root, s->path);
691 if (list_empty(settings)) return; /* we will be called for each page when the user clicks OK */
695 while (!list_empty(settings))
697 struct setting *s = (struct setting *) list_head(settings);
703 /* ================================== utility functions ============================ */
705 WCHAR* current_app = NULL; /* the app we are currently editing, or NULL if editing global */
707 /* returns a registry key path suitable for passing to addTransaction */
708 char *keypath(const char *section)
710 static char *result = NULL;
712 HeapFree(GetProcessHeap(), 0, result);
716 result = HeapAlloc(GetProcessHeap(), 0, strlen("AppDefaults\\") + lstrlenW(current_app)*2 + 2 /* \\ */ + strlen(section) + 1 /* terminator */);
717 wsprintf(result, "AppDefaults\\%ls", current_app);
718 if (section[0]) sprintf( result + strlen(result), "\\%s", section );
722 result = strdupA(section);
728 void PRINTERROR(void)
732 FormatMessageA(FORMAT_MESSAGE_ALLOCATE_BUFFER|FORMAT_MESSAGE_FROM_SYSTEM,
733 0, GetLastError(), MAKELANGID(LANG_NEUTRAL,SUBLANG_DEFAULT),
734 (LPSTR)&msg, 0, NULL);
736 /* eliminate trailing newline, is this a Wine bug? */
737 *(strrchr(msg, '\r')) = '\0';
739 WINE_TRACE("error: '%s'\n", msg);
742 int initialize(HINSTANCE hInstance)
744 DWORD res = RegCreateKey(HKEY_CURRENT_USER, WINE_KEY_ROOT, &config_key);
746 if (res != ERROR_SUCCESS) {
747 WINE_ERR("RegOpenKey failed on wine config key (%d)\n", res);
752 hPopupMenus = LoadMenu(hInstance, MAKEINTRESOURCE(IDR_WINECFG));
754 /* we could probably just have the list as static data */
755 settings = HeapAlloc(GetProcessHeap(), 0, sizeof(struct list));