Sweden-Number/programs/winecfg/winecfg.c

627 lines
18 KiB
C

/*
* WineCfg configuration management
*
* Copyright 2002 Jaco Greeff
* Copyright 2003 Dimitrie O. Paun
* Copyright 2003-2004 Mike Hearn
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* TODO:
* - Use unicode
* - Icons in listviews/icons
* - Better add app dialog, scan c: for EXE files and add to list in background
* - Use [GNOME] HIG style groupboxes rather than win32 style (looks nicer, imho)
*
*/
#define WIN32_LEAN_AND_MEAN
#include <assert.h>
#include <stdio.h>
#include <limits.h>
#include <windows.h>
#include <winreg.h>
#include <wine/debug.h>
#include <wine/list.h>
WINE_DEFAULT_DEBUG_CHANNEL(winecfg);
#include "winecfg.h"
#include "resource.h"
HKEY config_key = NULL;
HMENU hPopupMenus = 0;
/* this is called from the WM_SHOWWINDOW handlers of each tab page.
*
* it's a nasty hack, necessary because the property sheet insists on resetting the window title
* to the title of the tab, which is utterly useless. dropping the property sheet is on the todo list.
*/
void set_window_title(HWND dialog)
{
char newtitle[256];
/* update the window title */
if (current_app)
{
char apptitle[256];
LoadString(GetModuleHandle(NULL), IDS_WINECFG_TITLE_APP, apptitle, 256);
sprintf(newtitle, apptitle, current_app);
}
else
{
LoadString(GetModuleHandle(NULL), IDS_WINECFG_TITLE, newtitle, 256);
}
WINE_TRACE("setting title to %s\n", newtitle);
SendMessage(GetParent(dialog), PSM_SETTITLE, 0, (LPARAM) newtitle);
}
/**
* get_config_key: Retrieves a configuration value from the registry
*
* char *subkey : the name of the config section
* char *name : the name of the config value
* char *default : if the key isn't found, return this value instead
*
* Returns a buffer holding the value if successful, NULL if
* not. Caller is responsible for releasing the result.
*
*/
static char *get_config_key (HKEY root, const char *subkey, const char *name, const char *def)
{
LPSTR buffer = NULL;
DWORD len;
HKEY hSubKey = NULL;
DWORD res;
WINE_TRACE("subkey=%s, name=%s, def=%s\n", subkey, name, def);
res = RegOpenKey(root, subkey, &hSubKey);
if (res != ERROR_SUCCESS)
{
if (res == ERROR_FILE_NOT_FOUND)
{
WINE_TRACE("Section key not present - using default\n");
return def ? strdupA(def) : NULL;
}
else
{
WINE_ERR("RegOpenKey failed on wine config key (res=%ld)\n", res);
}
goto end;
}
res = RegQueryValueExA(hSubKey, name, NULL, NULL, NULL, &len);
if (res == ERROR_FILE_NOT_FOUND)
{
WINE_TRACE("Value not present - using default\n");
buffer = def ? strdupA(def) : NULL;
goto end;
} else if (res != ERROR_SUCCESS)
{
WINE_ERR("Couldn't query value's length (res=%ld)\n", res);
goto end;
}
buffer = HeapAlloc(GetProcessHeap(), 0, len + 1);
RegQueryValueEx(hSubKey, name, NULL, NULL, (LPBYTE) buffer, &len);
WINE_TRACE("buffer=%s\n", buffer);
end:
if (hSubKey && hSubKey != root) RegCloseKey(hSubKey);
return buffer;
}
/**
* set_config_key: convenience wrapper to set a key/value pair
*
* const char *subKey : the name of the config section
* const char *valueName : the name of the config value
* const char *value : the value to set the configuration key to
*
* Returns 0 on success, non-zero otherwise
*
* If valueName or value is NULL, an empty section will be created
*/
static int set_config_key(HKEY root, const char *subkey, const char *name, const void *value, DWORD type) {
DWORD res = 1;
HKEY key = NULL;
WINE_TRACE("subkey=%s: name=%s, value=%p, type=%ld\n", subkey, name, value, type);
assert( subkey != NULL );
if (subkey[0])
{
res = RegCreateKey(root, subkey, &key);
if (res != ERROR_SUCCESS) goto end;
}
else key = root;
if (name == NULL || value == NULL) goto end;
switch (type)
{
case REG_SZ: res = RegSetValueEx(key, name, 0, REG_SZ, value, strlen(value) + 1); break;
case REG_DWORD: res = RegSetValueEx(key, name, 0, REG_DWORD, value, sizeof(DWORD)); break;
}
if (res != ERROR_SUCCESS) goto end;
res = 0;
end:
if (key && key != root) RegCloseKey(key);
if (res != 0) WINE_ERR("Unable to set configuration key %s in section %s, res=%ld\n", name, subkey, res);
return res;
}
/* removes the requested value from the registry, however, does not
* remove the section if empty. Returns S_OK (0) on success.
*/
static HRESULT remove_value(HKEY root, const char *subkey, const char *name)
{
HRESULT hr;
HKEY key;
WINE_TRACE("subkey=%s, name=%s\n", subkey, name);
hr = RegOpenKey(root, subkey, &key);
if (hr != S_OK) return hr;
hr = RegDeleteValue(key, name);
if (hr != ERROR_SUCCESS) return hr;
return S_OK;
}
/* removes the requested subkey from the registry, assuming it exists */
static LONG remove_path(HKEY root, char *section) {
HKEY branch_key;
DWORD max_sub_key_len;
DWORD subkeys;
DWORD curr_len;
LONG ret = ERROR_SUCCESS;
long int i;
char *buffer;
WINE_TRACE("section=%s\n", section);
if ((ret = RegOpenKey(root, section, &branch_key)) != ERROR_SUCCESS)
return ret;
/* get size information and resize the buffers if necessary */
if ((ret = RegQueryInfoKey(branch_key, NULL, NULL, NULL,
&subkeys, &max_sub_key_len,
NULL, NULL, NULL, NULL, NULL, NULL
)) != ERROR_SUCCESS)
return ret;
curr_len = strlen(section);
buffer = HeapAlloc(GetProcessHeap(), 0, max_sub_key_len + curr_len + 1);
strcpy(buffer, section);
buffer[curr_len] = '\\';
for (i = subkeys - 1; i >= 0; i--)
{
DWORD buf_len = max_sub_key_len - curr_len - 1;
ret = RegEnumKeyEx(branch_key, i, buffer + curr_len + 1,
&buf_len, NULL, NULL, NULL, NULL);
if (ret != ERROR_SUCCESS && ret != ERROR_MORE_DATA &&
ret != ERROR_NO_MORE_ITEMS)
break;
else
remove_path(root, buffer);
}
HeapFree(GetProcessHeap(), 0, buffer);
RegCloseKey(branch_key);
return RegDeleteKey(root, section);
}
/* ========================================================================= */
/* This code exists for the following reasons:
*
* - It makes working with the registry easier
* - By storing a mini cache of the registry, we can more easily implement
* cancel/revert and apply. The 'settings list' is an overlay on top of
* the actual registry data that we can write out at will.
*
* Rather than model a tree in memory, we simply store each absolute (rooted
* at the config key) path.
*
*/
struct setting
{
struct list entry;
HKEY root; /* the key on which path is rooted */
char *path; /* path in the registry rooted at root */
char *name; /* name of the registry value. if null, this means delete the key */
char *value; /* contents of the registry value. if null, this means delete the value */
DWORD type; /* type of registry value. REG_SZ or REG_DWORD for now */
};
struct list *settings;
static void free_setting(struct setting *setting)
{
assert( setting != NULL );
assert( setting->path );
WINE_TRACE("destroying %p: %s\n", setting, setting->path);
HeapFree(GetProcessHeap(), 0, setting->path);
HeapFree(GetProcessHeap(), 0, setting->name);
HeapFree(GetProcessHeap(), 0, setting->value);
list_remove(&setting->entry);
HeapFree(GetProcessHeap(), 0, setting);
}
/**
* Returns the contents of the value at path. If not in the settings
* list, it will be fetched from the registry - failing that, the
* default will be used.
*
* If already in the list, the contents as given there will be
* returned. You are expected to HeapFree the result.
*/
char *get_reg_key(HKEY root, const char *path, const char *name, const char *def)
{
struct list *cursor;
struct setting *s;
char *val;
WINE_TRACE("path=%s, name=%s, def=%s\n", path, name, def);
/* check if it's in the list */
LIST_FOR_EACH( cursor, settings )
{
s = LIST_ENTRY(cursor, struct setting, entry);
if (root != s->root) continue;
if (strcasecmp(path, s->path) != 0) continue;
if (strcasecmp(name, s->name) != 0) continue;
WINE_TRACE("found %s:%s in settings list, returning %s\n", path, name, s->value);
return s->value ? strdupA(s->value) : NULL;
}
/* no, so get from the registry */
val = get_config_key(root, path, name, def);
WINE_TRACE("returning %s\n", val);
return val;
}
/**
* Used to set a registry key.
*
* path is rooted at the config key, ie use "Version" or
* "AppDefaults\\fooapp.exe\\Version". You can use keypath()
* to get such a string.
*
* name is the value name, or NULL to delete the path.
*
* value is what to set the value to, or NULL to delete it.
*
* type is REG_SZ or REG_DWORD.
*
* These values will be copied when necessary.
*/
static void set_reg_key_ex(HKEY root, const char *path, const char *name, const void *value, DWORD type)
{
struct list *cursor;
struct setting *s;
assert( path != NULL );
WINE_TRACE("path=%s, name=%s, value=%p\n", path, name, value);
/* firstly, see if we already set this setting */
LIST_FOR_EACH( cursor, settings )
{
struct setting *s = LIST_ENTRY(cursor, struct setting, entry);
if (root != s->root) continue;
if (strcasecmp(s->path, path) != 0) continue;
if ((s->name && name) && strcasecmp(s->name, name) != 0) continue;
/* are we attempting a double delete? */
if (!s->name && !name) return;
/* do we want to undelete this key? */
if (!s->name && name) s->name = strdupA(name);
/* yes, we have already set it, so just replace the content and return */
HeapFree(GetProcessHeap(), 0, s->value);
s->type = type;
switch (type)
{
case REG_SZ:
s->value = value ? strdupA(value) : NULL;
break;
case REG_DWORD:
s->value = HeapAlloc(GetProcessHeap(), 0, sizeof(DWORD));
memcpy( s->value, value, sizeof(DWORD) );
break;
}
/* are we deleting this key? this won't remove any of the
* children from the overlay so if the user adds it again in
* that session it will appear to undelete the settings, but
* in reality only the settings actually modified by the user
* in that session will be restored. we might want to fix this
* corner case in future by actually deleting all the children
* here so that once it's gone, it's gone.
*/
if (!name) s->name = NULL;
return;
}
/* otherwise add a new setting for it */
s = HeapAlloc(GetProcessHeap(), 0, sizeof(struct setting));
s->root = root;
s->path = strdupA(path);
s->name = name ? strdupA(name) : NULL;
s->type = type;
switch (type)
{
case REG_SZ:
s->value = value ? strdupA(value) : NULL;
break;
case REG_DWORD:
s->value = HeapAlloc(GetProcessHeap(), 0, sizeof(DWORD));
memcpy( s->value, value, sizeof(DWORD) );
break;
}
list_add_tail(settings, &s->entry);
}
void set_reg_key(HKEY root, const char *path, const char *name, const char *value)
{
set_reg_key_ex(root, path, name, value, REG_SZ);
}
void set_reg_key_dword(HKEY root, const char *path, const char *name, DWORD value)
{
set_reg_key_ex(root, path, name, &value, REG_DWORD);
}
/**
* enumerates the value names at the given path, taking into account
* the changes in the settings list.
*
* you are expected to HeapFree each element of the array, which is null
* terminated, as well as the array itself.
*/
char **enumerate_values(HKEY root, char *path)
{
HKEY key;
DWORD res, i = 0;
char **values = NULL;
int valueslen = 0;
struct list *cursor;
res = RegOpenKey(root, path, &key);
if (res == ERROR_SUCCESS)
{
while (TRUE)
{
char name[1024];
DWORD namesize = sizeof(name);
BOOL removed = FALSE;
/* find out the needed size, allocate a buffer, read the value */
if ((res = RegEnumValue(key, i, name, &namesize, NULL, NULL, NULL, NULL)) != ERROR_SUCCESS)
break;
WINE_TRACE("name=%s\n", name);
/* check if this value name has been removed in the settings list */
LIST_FOR_EACH( cursor, settings )
{
struct setting *s = LIST_ENTRY(cursor, struct setting, entry);
if (strcasecmp(s->path, path) != 0) continue;
if (strcasecmp(s->name, name) != 0) continue;
if (!s->value)
{
WINE_TRACE("this key has been removed, so skipping\n");
removed = TRUE;
break;
}
}
if (removed) /* this value was deleted by the user, so don't include it */
{
HeapFree(GetProcessHeap(), 0, name);
i++;
continue;
}
/* grow the array if necessary, add buffer to it, iterate */
if (values) values = HeapReAlloc(GetProcessHeap(), 0, values, sizeof(char*) * (valueslen + 1));
else values = HeapAlloc(GetProcessHeap(), 0, sizeof(char*));
values[valueslen++] = strdupA(name);
WINE_TRACE("valueslen is now %d\n", valueslen);
i++;
}
}
else
{
WINE_WARN("failed opening registry key %s, res=0x%lx\n", path, res);
}
WINE_TRACE("adding settings in list but not registry\n");
/* now we have to add the values that aren't in the registry but are in the settings list */
LIST_FOR_EACH( cursor, settings )
{
struct setting *setting = LIST_ENTRY(cursor, struct setting, entry);
BOOL found = FALSE;
if (strcasecmp(setting->path, path) != 0) continue;
if (!setting->value) continue;
for (i = 0; i < valueslen; i++)
{
if (strcasecmp(setting->name, values[i]) == 0)
{
found = TRUE;
break;
}
}
if (found) continue;
WINE_TRACE("%s in list but not registry\n", setting->name);
/* otherwise it's been set by the user but isn't in the registry */
if (values) values = HeapReAlloc(GetProcessHeap(), 0, values, sizeof(char*) * (valueslen + 1));
else values = HeapAlloc(GetProcessHeap(), 0, sizeof(char*));
values[valueslen++] = strdupA(setting->name);
}
WINE_TRACE("adding null terminator\n");
if (values)
{
values = HeapReAlloc(GetProcessHeap(), 0, values, sizeof(char*) * (valueslen + 1));
values[valueslen] = NULL;
}
RegCloseKey(key);
return values;
}
/**
* returns true if the given key/value pair exists in the registry or
* has been written to.
*/
BOOL reg_key_exists(HKEY root, const char *path, const char *name)
{
char *val = get_reg_key(root, path, name, NULL);
if (val)
{
HeapFree(GetProcessHeap(), 0, val);
return TRUE;
}
return FALSE;
}
static void process_setting(struct setting *s)
{
if (s->value)
{
WINE_TRACE("Setting %s:%s to '%s'\n", s->path, s->name, s->value);
set_config_key(s->root, s->path, s->name, s->value, s->type);
}
else
{
/* NULL name means remove that path/section entirely */
if (s->path && s->name) remove_value(s->root, s->path, s->name);
else if (s->path && !s->name) remove_path(s->root, s->path);
}
}
void apply(void)
{
if (list_empty(settings)) return; /* we will be called for each page when the user clicks OK */
WINE_TRACE("()\n");
while (!list_empty(settings))
{
struct setting *s = (struct setting *) list_head(settings);
process_setting(s);
free_setting(s);
}
}
/* ================================== utility functions ============================ */
char *current_app = NULL; /* the app we are currently editing, or NULL if editing global */
/* returns a registry key path suitable for passing to addTransaction */
char *keypath(const char *section)
{
static char *result = NULL;
HeapFree(GetProcessHeap(), 0, result);
if (current_app)
{
result = HeapAlloc(GetProcessHeap(), 0, strlen("AppDefaults\\") + strlen(current_app) + 2 /* \\ */ + strlen(section) + 1 /* terminator */);
sprintf(result, "AppDefaults\\%s", current_app);
if (section[0]) sprintf( result + strlen(result), "\\%s", section );
}
else
{
result = strdupA(section);
}
return result;
}
void PRINTERROR(void)
{
LPSTR msg;
FormatMessageA(FORMAT_MESSAGE_ALLOCATE_BUFFER|FORMAT_MESSAGE_FROM_SYSTEM,
0, GetLastError(), MAKELANGID(LANG_NEUTRAL,SUBLANG_DEFAULT),
(LPSTR)&msg, 0, NULL);
/* eliminate trailing newline, is this a Wine bug? */
*(strrchr(msg, '\r')) = '\0';
WINE_TRACE("error: '%s'\n", msg);
}
int initialize(HINSTANCE hInstance)
{
DWORD res = RegCreateKey(HKEY_CURRENT_USER, WINE_KEY_ROOT, &config_key);
if (res != ERROR_SUCCESS) {
WINE_ERR("RegOpenKey failed on wine config key (%ld)\n", res);
return 1;
}
/* load any menus */
hPopupMenus = LoadMenu(hInstance, MAKEINTRESOURCE(IDR_WINECFG));
/* we could probably just have the list as static data */
settings = HeapAlloc(GetProcessHeap(), 0, sizeof(struct list));
list_init(settings);
return 0;
}