2 * self-registerable dll functions for shell32.dll
4 * Copyright (C) 2003 John K. Hohm
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
33 #include "wine/debug.h"
35 WINE_DEFAULT_DEBUG_CHANNEL(ole);
38 * Near the bottom of this file are the exported DllRegisterServer and
39 * DllUnregisterServer, which make all this worthwhile.
42 /***********************************************************************
43 * interface for self-registering
45 struct regsvr_interface
47 IID const *iid; /* NULL for end of list */
48 LPCSTR name; /* can be NULL to omit */
49 IID const *base_iid; /* can be NULL to omit */
50 int num_methods; /* can be <0 to omit */
51 CLSID const *ps_clsid; /* can be NULL to omit */
52 CLSID const *ps_clsid32; /* can be NULL to omit */
55 static HRESULT register_interfaces(struct regsvr_interface const *list);
56 static HRESULT unregister_interfaces(struct regsvr_interface const *list);
60 CLSID const *clsid; /* NULL for end of list */
61 LPCSTR name; /* can be NULL to omit */
62 LPCSTR ips; /* can be NULL to omit */
63 LPCSTR ips32; /* can be NULL to omit */
64 LPCSTR ips32_tmodel; /* can be NULL to omit */
66 LPCSTR clsid_str; /* can be NULL to omit */
67 LPCSTR progid; /* can be NULL to omit */
70 /* flags for regsvr_coclass.flags */
71 #define SHELLEX_MAYCHANGEDEFAULTMENU 0x00000001
73 static HRESULT register_coclasses(struct regsvr_coclass const *list);
74 static HRESULT unregister_coclasses(struct regsvr_coclass const *list);
76 /***********************************************************************
77 * static string constants
79 static WCHAR const interface_keyname[10] = {
80 'I', 'n', 't', 'e', 'r', 'f', 'a', 'c', 'e', 0 };
81 static WCHAR const base_ifa_keyname[14] = {
82 'B', 'a', 's', 'e', 'I', 'n', 't', 'e', 'r', 'f', 'a', 'c',
84 static WCHAR const num_methods_keyname[11] = {
85 'N', 'u', 'm', 'M', 'e', 't', 'h', 'o', 'd', 's', 0 };
86 static WCHAR const ps_clsid_keyname[15] = {
87 'P', 'r', 'o', 'x', 'y', 'S', 't', 'u', 'b', 'C', 'l', 's',
89 static WCHAR const ps_clsid32_keyname[17] = {
90 'P', 'r', 'o', 'x', 'y', 'S', 't', 'u', 'b', 'C', 'l', 's',
91 'i', 'd', '3', '2', 0 };
92 static WCHAR const clsid_keyname[6] = {
93 'C', 'L', 'S', 'I', 'D', 0 };
94 static WCHAR const ips_keyname[13] = {
95 'I', 'n', 'P', 'r', 'o', 'c', 'S', 'e', 'r', 'v', 'e', 'r',
97 static WCHAR const ips32_keyname[15] = {
98 'I', 'n', 'P', 'r', 'o', 'c', 'S', 'e', 'r', 'v', 'e', 'r',
100 static WCHAR const progid_keyname[7] = {
101 'P', 'r', 'o', 'g', 'I', 'D', 0 };
102 static WCHAR const shellex_keyname[8] = {
103 's', 'h', 'e', 'l', 'l', 'e', 'x', 0 };
104 static WCHAR const mcdm_keyname[21] = {
105 'M', 'a', 'y', 'C', 'h', 'a', 'n', 'g', 'e', 'D', 'e', 'f',
106 'a', 'u', 'l', 't', 'M', 'e', 'n', 'u', 0 };
107 static char const tmodel_valuename[] = "ThreadingModel";
109 /***********************************************************************
110 * static helper functions
112 static LONG register_key_guid(HKEY base, WCHAR const *name, GUID const *guid);
113 static LONG register_key_defvalueW(HKEY base, WCHAR const *name,
115 static LONG register_key_defvalueA(HKEY base, WCHAR const *name,
117 static LONG recursive_delete_key(HKEY key);
118 static LONG recursive_delete_keyA(HKEY base, char const *name);
119 static LONG recursive_delete_keyW(HKEY base, WCHAR const *name);
121 /***********************************************************************
122 * register_interfaces
124 static HRESULT register_interfaces(struct regsvr_interface const *list)
126 LONG res = ERROR_SUCCESS;
129 res = RegCreateKeyExW(HKEY_CLASSES_ROOT, interface_keyname, 0, NULL, 0,
130 KEY_READ | KEY_WRITE, NULL, &interface_key, NULL);
131 if (res != ERROR_SUCCESS) goto error_return;
133 for (; res == ERROR_SUCCESS && list->iid; ++list) {
137 StringFromGUID2(list->iid, buf, 39);
138 res = RegCreateKeyExW(interface_key, buf, 0, NULL, 0,
139 KEY_READ | KEY_WRITE, NULL, &iid_key, NULL);
140 if (res != ERROR_SUCCESS) goto error_close_interface_key;
143 res = RegSetValueExA(iid_key, NULL, 0, REG_SZ,
144 (CONST BYTE*)(list->name),
145 strlen(list->name) + 1);
146 if (res != ERROR_SUCCESS) goto error_close_iid_key;
149 if (list->base_iid) {
150 register_key_guid(iid_key, base_ifa_keyname, list->base_iid);
151 if (res != ERROR_SUCCESS) goto error_close_iid_key;
154 if (0 <= list->num_methods) {
155 static WCHAR const fmt[3] = { '%', 'd', 0 };
158 res = RegCreateKeyExW(iid_key, num_methods_keyname, 0, NULL, 0,
159 KEY_READ | KEY_WRITE, NULL, &key, NULL);
160 if (res != ERROR_SUCCESS) goto error_close_iid_key;
162 wsprintfW(buf, fmt, list->num_methods);
163 res = RegSetValueExW(key, NULL, 0, REG_SZ,
165 (lstrlenW(buf) + 1) * sizeof(WCHAR));
168 if (res != ERROR_SUCCESS) goto error_close_iid_key;
171 if (list->ps_clsid) {
172 register_key_guid(iid_key, ps_clsid_keyname, list->ps_clsid);
173 if (res != ERROR_SUCCESS) goto error_close_iid_key;
176 if (list->ps_clsid32) {
177 register_key_guid(iid_key, ps_clsid32_keyname, list->ps_clsid32);
178 if (res != ERROR_SUCCESS) goto error_close_iid_key;
182 RegCloseKey(iid_key);
185 error_close_interface_key:
186 RegCloseKey(interface_key);
188 return res != ERROR_SUCCESS ? HRESULT_FROM_WIN32(res) : S_OK;
191 /***********************************************************************
192 * unregister_interfaces
194 static HRESULT unregister_interfaces(struct regsvr_interface const *list)
196 LONG res = ERROR_SUCCESS;
199 res = RegOpenKeyExW(HKEY_CLASSES_ROOT, interface_keyname, 0,
200 KEY_READ | KEY_WRITE, &interface_key);
201 if (res == ERROR_FILE_NOT_FOUND) return S_OK;
202 if (res != ERROR_SUCCESS) goto error_return;
204 for (; res == ERROR_SUCCESS && list->iid; ++list) {
207 StringFromGUID2(list->iid, buf, 39);
208 res = recursive_delete_keyW(interface_key, buf);
211 RegCloseKey(interface_key);
213 return res != ERROR_SUCCESS ? HRESULT_FROM_WIN32(res) : S_OK;
216 /***********************************************************************
219 static HRESULT register_coclasses(struct regsvr_coclass const *list)
221 LONG res = ERROR_SUCCESS;
224 res = RegCreateKeyExW(HKEY_CLASSES_ROOT, clsid_keyname, 0, NULL, 0,
225 KEY_READ | KEY_WRITE, NULL, &coclass_key, NULL);
226 if (res != ERROR_SUCCESS) goto error_return;
228 for (; res == ERROR_SUCCESS && list->clsid; ++list) {
232 StringFromGUID2(list->clsid, buf, 39);
233 res = RegCreateKeyExW(coclass_key, buf, 0, NULL, 0,
234 KEY_READ | KEY_WRITE, NULL, &clsid_key, NULL);
235 if (res != ERROR_SUCCESS) goto error_close_coclass_key;
238 res = RegSetValueExA(clsid_key, NULL, 0, REG_SZ,
239 (CONST BYTE*)(list->name),
240 strlen(list->name) + 1);
241 if (res != ERROR_SUCCESS) goto error_close_clsid_key;
245 res = register_key_defvalueA(clsid_key, ips_keyname, list->ips);
246 if (res != ERROR_SUCCESS) goto error_close_clsid_key;
252 res = RegCreateKeyExW(clsid_key, ips32_keyname, 0, NULL, 0,
253 KEY_READ | KEY_WRITE, NULL,
255 if (res != ERROR_SUCCESS) goto error_close_clsid_key;
257 res = RegSetValueExA(ips32_key, NULL, 0, REG_SZ,
258 (CONST BYTE*)list->ips32,
259 lstrlenA(list->ips32) + 1);
260 if (res == ERROR_SUCCESS && list->ips32_tmodel)
261 res = RegSetValueExA(ips32_key, tmodel_valuename, 0, REG_SZ,
262 (CONST BYTE*)list->ips32_tmodel,
263 strlen(list->ips32_tmodel) + 1);
264 RegCloseKey(ips32_key);
265 if (res != ERROR_SUCCESS) goto error_close_clsid_key;
268 if (list->flags & SHELLEX_MAYCHANGEDEFAULTMENU) {
269 HKEY shellex_key, mcdm_key;
271 res = RegCreateKeyExW(clsid_key, shellex_keyname, 0, NULL, 0,
272 KEY_READ | KEY_WRITE, NULL,
274 if (res != ERROR_SUCCESS) goto error_close_clsid_key;
275 res = RegCreateKeyExW(shellex_key, mcdm_keyname, 0, NULL, 0,
276 KEY_READ | KEY_WRITE, NULL,
278 RegCloseKey(shellex_key);
279 if (res != ERROR_SUCCESS) goto error_close_clsid_key;
280 RegCloseKey(mcdm_key);
283 if (list->clsid_str) {
284 res = register_key_defvalueA(clsid_key, clsid_keyname,
286 if (res != ERROR_SUCCESS) goto error_close_clsid_key;
292 res = register_key_defvalueA(clsid_key, progid_keyname,
294 if (res != ERROR_SUCCESS) goto error_close_clsid_key;
296 res = RegCreateKeyExA(HKEY_CLASSES_ROOT, list->progid, 0,
297 NULL, 0, KEY_READ | KEY_WRITE, NULL,
299 if (res != ERROR_SUCCESS) goto error_close_clsid_key;
301 res = register_key_defvalueW(progid_key, clsid_keyname, buf);
302 RegCloseKey(progid_key);
303 if (res != ERROR_SUCCESS) goto error_close_clsid_key;
306 error_close_clsid_key:
307 RegCloseKey(clsid_key);
310 error_close_coclass_key:
311 RegCloseKey(coclass_key);
313 return res != ERROR_SUCCESS ? HRESULT_FROM_WIN32(res) : S_OK;
316 /***********************************************************************
317 * unregister_coclasses
319 static HRESULT unregister_coclasses(struct regsvr_coclass const *list)
321 LONG res = ERROR_SUCCESS;
324 res = RegOpenKeyExW(HKEY_CLASSES_ROOT, clsid_keyname, 0,
325 KEY_READ | KEY_WRITE, &coclass_key);
326 if (res == ERROR_FILE_NOT_FOUND) return S_OK;
327 if (res != ERROR_SUCCESS) goto error_return;
329 for (; res == ERROR_SUCCESS && list->clsid; ++list) {
332 StringFromGUID2(list->clsid, buf, 39);
333 res = recursive_delete_keyW(coclass_key, buf);
334 if (res != ERROR_SUCCESS) goto error_close_coclass_key;
337 res = recursive_delete_keyA(HKEY_CLASSES_ROOT, list->progid);
338 if (res != ERROR_SUCCESS) goto error_close_coclass_key;
342 error_close_coclass_key:
343 RegCloseKey(coclass_key);
345 return res != ERROR_SUCCESS ? HRESULT_FROM_WIN32(res) : S_OK;
348 /***********************************************************************
351 static LONG register_key_guid(HKEY base, WCHAR const *name, GUID const *guid)
355 StringFromGUID2(guid, buf, 39);
356 return register_key_defvalueW(base, name, buf);
359 /***********************************************************************
360 * regsvr_key_defvalueW
362 static LONG register_key_defvalueW(
370 res = RegCreateKeyExW(base, name, 0, NULL, 0,
371 KEY_READ | KEY_WRITE, NULL, &key, NULL);
372 if (res != ERROR_SUCCESS) return res;
373 res = RegSetValueExW(key, NULL, 0, REG_SZ, (CONST BYTE*)value,
374 (lstrlenW(value) + 1) * sizeof(WCHAR));
379 /***********************************************************************
380 * regsvr_key_defvalueA
382 static LONG register_key_defvalueA(
390 res = RegCreateKeyExW(base, name, 0, NULL, 0,
391 KEY_READ | KEY_WRITE, NULL, &key, NULL);
392 if (res != ERROR_SUCCESS) return res;
393 res = RegSetValueExA(key, NULL, 0, REG_SZ, (CONST BYTE*)value,
394 lstrlenA(value) + 1);
399 /***********************************************************************
400 * recursive_delete_key
402 static LONG recursive_delete_key(HKEY key)
405 WCHAR subkey_name[MAX_PATH];
410 cName = sizeof(subkey_name) / sizeof(WCHAR);
411 res = RegEnumKeyExW(key, 0, subkey_name, &cName,
412 NULL, NULL, NULL, NULL);
413 if (res != ERROR_SUCCESS && res != ERROR_MORE_DATA) {
414 res = ERROR_SUCCESS; /* presumably we're done enumerating */
417 res = RegOpenKeyExW(key, subkey_name, 0,
418 KEY_READ | KEY_WRITE, &subkey);
419 if (res == ERROR_FILE_NOT_FOUND) continue;
420 if (res != ERROR_SUCCESS) break;
422 res = recursive_delete_key(subkey);
424 if (res != ERROR_SUCCESS) break;
427 if (res == ERROR_SUCCESS) res = RegDeleteKeyW(key, 0);
431 /***********************************************************************
432 * recursive_delete_keyA
434 static LONG recursive_delete_keyA(HKEY base, char const *name)
439 res = RegOpenKeyExA(base, name, 0, KEY_READ | KEY_WRITE, &key);
440 if (res == ERROR_FILE_NOT_FOUND) return ERROR_SUCCESS;
441 if (res != ERROR_SUCCESS) return res;
442 res = recursive_delete_key(key);
447 /***********************************************************************
448 * recursive_delete_keyW
450 static LONG recursive_delete_keyW(HKEY base, WCHAR const *name)
455 res = RegOpenKeyExW(base, name, 0, KEY_READ | KEY_WRITE, &key);
456 if (res == ERROR_FILE_NOT_FOUND) return ERROR_SUCCESS;
457 if (res != ERROR_SUCCESS) return res;
458 res = recursive_delete_key(key);
463 /***********************************************************************
466 static GUID const CLSID_Desktop = {
467 0x00021400, 0x0000, 0x0000, {0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46} };
469 static GUID const CLSID_Shortcut = {
470 0x00021401, 0x0000, 0x0000, {0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46} };
472 static struct regsvr_coclass const coclass_list[] = {
490 SHELLEX_MAYCHANGEDEFAULTMENU
492 { &CLSID_AutoComplete,
498 { NULL } /* list terminator */
501 /***********************************************************************
505 static struct regsvr_interface const interface_list[] = {
506 { NULL } /* list terminator */
509 /***********************************************************************
510 * DllRegisterServer (SHELL32.@)
512 HRESULT WINAPI SHELL32_DllRegisterServer()
518 hr = register_coclasses(coclass_list);
520 hr = register_interfaces(interface_list);
524 /***********************************************************************
525 * DllUnregisterServer (SHELL32.@)
527 HRESULT WINAPI SHELL32_DllUnregisterServer()
533 hr = unregister_coclasses(coclass_list);
535 hr = unregister_interfaces(interface_list);