2 * MSXML3 self-registerable dll functions
4 * Copyright (C) 2003 John K. Hohm
5 * Copyright (C) 2006 Robert Shearman
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
38 /* undef the #define in msxml2 so that we can access the v.2 version
39 independent CLSID as well as the v.3 one. */
40 #undef CLSID_DOMDocument
42 #include "msxml_private.h"
44 #include "wine/debug.h"
46 WINE_DEFAULT_DEBUG_CHANNEL(ole);
49 * Near the bottom of this file are the exported DllRegisterServer and
50 * DllUnregisterServer, which make all this worthwhile.
53 /***********************************************************************
54 * interface for self-registering
56 struct regsvr_interface
58 IID const *iid; /* NULL for end of list */
59 LPCSTR name; /* can be NULL to omit */
60 IID const *base_iid; /* can be NULL to omit */
61 int num_methods; /* can be <0 to omit */
62 CLSID const *ps_clsid; /* can be NULL to omit */
63 CLSID const *ps_clsid32; /* can be NULL to omit */
66 static HRESULT register_interfaces(struct regsvr_interface const *list);
67 static HRESULT unregister_interfaces(struct regsvr_interface const *list);
71 CLSID const *clsid; /* NULL for end of list */
72 LPCSTR name; /* can be NULL to omit */
73 LPCSTR ips; /* can be NULL to omit */
74 LPCSTR ips32; /* can be NULL to omit */
75 LPCSTR ips32_tmodel; /* can be NULL to omit */
76 LPCSTR progid; /* can be NULL to omit */
77 LPCSTR version; /* can be NULL to omit */
80 static HRESULT register_coclasses(struct regsvr_coclass const *list);
81 static HRESULT unregister_coclasses(struct regsvr_coclass const *list);
85 LPCSTR name; /* NULL for end of list */
86 LPCSTR description; /* can be NULL to omit */
88 LPCSTR curver; /* can be NULL to omit */
91 static HRESULT register_progids(struct progid const *list);
92 static HRESULT unregister_progids(struct progid const *list);
94 /***********************************************************************
95 * static string constants
97 static WCHAR const interface_keyname[10] = {
98 'I', 'n', 't', 'e', 'r', 'f', 'a', 'c', 'e', 0 };
99 static WCHAR const base_ifa_keyname[14] = {
100 'B', 'a', 's', 'e', 'I', 'n', 't', 'e', 'r', 'f', 'a', 'c',
102 static WCHAR const num_methods_keyname[11] = {
103 'N', 'u', 'm', 'M', 'e', 't', 'h', 'o', 'd', 's', 0 };
104 static WCHAR const ps_clsid_keyname[15] = {
105 'P', 'r', 'o', 'x', 'y', 'S', 't', 'u', 'b', 'C', 'l', 's',
107 static WCHAR const ps_clsid32_keyname[17] = {
108 'P', 'r', 'o', 'x', 'y', 'S', 't', 'u', 'b', 'C', 'l', 's',
109 'i', 'd', '3', '2', 0 };
110 static WCHAR const clsid_keyname[6] = {
111 'C', 'L', 'S', 'I', 'D', 0 };
112 static WCHAR const ips_keyname[13] = {
113 'I', 'n', 'P', 'r', 'o', 'c', 'S', 'e', 'r', 'v', 'e', 'r',
115 static WCHAR const ips32_keyname[15] = {
116 'I', 'n', 'P', 'r', 'o', 'c', 'S', 'e', 'r', 'v', 'e', 'r',
118 static WCHAR const progid_keyname[7] = {
119 'P', 'r', 'o', 'g', 'I', 'D', 0 };
120 static WCHAR const versionindependentprogid_keyname[] = {
121 'V', 'e', 'r', 's', 'i', 'o', 'n',
122 'I', 'n', 'd', 'e', 'p', 'e', 'n', 'd', 'e', 'n', 't',
123 'P', 'r', 'o', 'g', 'I', 'D', 0 };
124 static WCHAR const version_keyname[] = {
125 'V', 'e', 'r', 's', 'i', 'o', 'n', 0 };
126 static WCHAR const curver_keyname[] = {
127 'C', 'u', 'r', 'V', 'e', 'r', 0 };
128 static char const tmodel_valuename[] = "ThreadingModel";
130 /***********************************************************************
131 * static helper functions
133 static LONG register_key_guid(HKEY base, WCHAR const *name, GUID const *guid);
134 static LONG register_key_defvalueW(HKEY base, WCHAR const *name,
136 static LONG register_key_defvalueA(HKEY base, WCHAR const *name,
139 /***********************************************************************
140 * register_interfaces
142 static HRESULT register_interfaces(struct regsvr_interface const *list)
144 LONG res = ERROR_SUCCESS;
147 res = RegCreateKeyExW(HKEY_CLASSES_ROOT, interface_keyname, 0, NULL, 0,
148 KEY_READ | KEY_WRITE, NULL, &interface_key, NULL);
149 if (res != ERROR_SUCCESS) goto error_return;
151 for (; res == ERROR_SUCCESS && list->iid; ++list) {
155 StringFromGUID2(list->iid, buf, 39);
156 res = RegCreateKeyExW(interface_key, buf, 0, NULL, 0,
157 KEY_READ | KEY_WRITE, NULL, &iid_key, NULL);
158 if (res != ERROR_SUCCESS) goto error_close_interface_key;
161 res = RegSetValueExA(iid_key, NULL, 0, REG_SZ,
162 (CONST BYTE*)(list->name),
163 strlen(list->name) + 1);
164 if (res != ERROR_SUCCESS) goto error_close_iid_key;
167 if (list->base_iid) {
168 res = register_key_guid(iid_key, base_ifa_keyname, list->base_iid);
169 if (res != ERROR_SUCCESS) goto error_close_iid_key;
172 if (0 <= list->num_methods) {
173 static WCHAR const fmt[3] = { '%', 'd', 0 };
176 res = RegCreateKeyExW(iid_key, num_methods_keyname, 0, NULL, 0,
177 KEY_READ | KEY_WRITE, NULL, &key, NULL);
178 if (res != ERROR_SUCCESS) goto error_close_iid_key;
180 wsprintfW(buf, fmt, list->num_methods);
181 res = RegSetValueExW(key, NULL, 0, REG_SZ,
183 (lstrlenW(buf) + 1) * sizeof(WCHAR));
186 if (res != ERROR_SUCCESS) goto error_close_iid_key;
189 if (list->ps_clsid) {
190 res = register_key_guid(iid_key, ps_clsid_keyname, list->ps_clsid);
191 if (res != ERROR_SUCCESS) goto error_close_iid_key;
194 if (list->ps_clsid32) {
195 res = register_key_guid(iid_key, ps_clsid32_keyname, list->ps_clsid32);
196 if (res != ERROR_SUCCESS) goto error_close_iid_key;
200 RegCloseKey(iid_key);
203 error_close_interface_key:
204 RegCloseKey(interface_key);
206 return res != ERROR_SUCCESS ? HRESULT_FROM_WIN32(res) : S_OK;
209 /***********************************************************************
210 * unregister_interfaces
212 static HRESULT unregister_interfaces(struct regsvr_interface const *list)
214 LONG res = ERROR_SUCCESS;
217 res = RegOpenKeyExW(HKEY_CLASSES_ROOT, interface_keyname, 0,
218 KEY_READ | KEY_WRITE, &interface_key);
219 if (res == ERROR_FILE_NOT_FOUND) return S_OK;
220 if (res != ERROR_SUCCESS) goto error_return;
222 for (; res == ERROR_SUCCESS && list->iid; ++list) {
225 StringFromGUID2(list->iid, buf, 39);
226 res = RegDeleteTreeW(interface_key, buf);
227 if (res == ERROR_FILE_NOT_FOUND) res = ERROR_SUCCESS;
230 RegCloseKey(interface_key);
232 return res != ERROR_SUCCESS ? HRESULT_FROM_WIN32(res) : S_OK;
235 /***********************************************************************
238 static HRESULT register_coclasses(struct regsvr_coclass const *list)
240 LONG res = ERROR_SUCCESS;
243 res = RegCreateKeyExW(HKEY_CLASSES_ROOT, clsid_keyname, 0, NULL, 0,
244 KEY_READ | KEY_WRITE, NULL, &coclass_key, NULL);
245 if (res != ERROR_SUCCESS) goto error_return;
247 for (; res == ERROR_SUCCESS && list->clsid; ++list) {
251 StringFromGUID2(list->clsid, buf, 39);
252 res = RegCreateKeyExW(coclass_key, buf, 0, NULL, 0,
253 KEY_READ | KEY_WRITE, NULL, &clsid_key, NULL);
254 if (res != ERROR_SUCCESS) goto error_close_coclass_key;
257 res = RegSetValueExA(clsid_key, NULL, 0, REG_SZ,
258 (CONST BYTE*)(list->name),
259 strlen(list->name) + 1);
260 if (res != ERROR_SUCCESS) goto error_close_clsid_key;
264 res = register_key_defvalueA(clsid_key, ips_keyname, list->ips);
265 if (res != ERROR_SUCCESS) goto error_close_clsid_key;
271 res = RegCreateKeyExW(clsid_key, ips32_keyname, 0, NULL, 0,
272 KEY_READ | KEY_WRITE, NULL,
274 if (res != ERROR_SUCCESS) goto error_close_clsid_key;
276 res = RegSetValueExA(ips32_key, NULL, 0, REG_SZ,
277 (CONST BYTE*)list->ips32,
278 lstrlenA(list->ips32) + 1);
279 if (res == ERROR_SUCCESS && list->ips32_tmodel)
280 res = RegSetValueExA(ips32_key, tmodel_valuename, 0, REG_SZ,
281 (CONST BYTE*)list->ips32_tmodel,
282 strlen(list->ips32_tmodel) + 1);
283 RegCloseKey(ips32_key);
284 if (res != ERROR_SUCCESS) goto error_close_clsid_key;
292 buffer = HeapAlloc(GetProcessHeap(), 0, strlen(list->progid) + strlen(list->version) + 2);
294 res = ERROR_OUTOFMEMORY;
295 goto error_close_clsid_key;
297 strcpy(buffer, list->progid);
299 strcat(buffer, list->version);
302 progid = list->progid;
303 res = register_key_defvalueA(clsid_key, progid_keyname,
305 HeapFree(GetProcessHeap(), 0, buffer);
306 if (res != ERROR_SUCCESS) goto error_close_clsid_key;
309 res = register_key_defvalueA(clsid_key, versionindependentprogid_keyname,
311 if (res != ERROR_SUCCESS) goto error_close_clsid_key;
316 res = register_key_defvalueA(clsid_key, version_keyname,
318 if (res != ERROR_SUCCESS) goto error_close_clsid_key;
321 error_close_clsid_key:
322 RegCloseKey(clsid_key);
325 error_close_coclass_key:
326 RegCloseKey(coclass_key);
328 return res != ERROR_SUCCESS ? HRESULT_FROM_WIN32(res) : S_OK;
331 /***********************************************************************
332 * unregister_coclasses
334 static HRESULT unregister_coclasses(struct regsvr_coclass const *list)
336 LONG res = ERROR_SUCCESS;
339 res = RegOpenKeyExW(HKEY_CLASSES_ROOT, clsid_keyname, 0,
340 KEY_READ | KEY_WRITE, &coclass_key);
341 if (res == ERROR_FILE_NOT_FOUND) return S_OK;
342 if (res != ERROR_SUCCESS) goto error_return;
344 for (; res == ERROR_SUCCESS && list->clsid; ++list) {
347 StringFromGUID2(list->clsid, buf, 39);
348 res = RegDeleteTreeW(coclass_key, buf);
349 if (res == ERROR_FILE_NOT_FOUND) res = ERROR_SUCCESS;
350 if (res != ERROR_SUCCESS) goto error_close_coclass_key;
353 error_close_coclass_key:
354 RegCloseKey(coclass_key);
356 return res != ERROR_SUCCESS ? HRESULT_FROM_WIN32(res) : S_OK;
359 /***********************************************************************
362 static HRESULT register_progids(struct progid const *list)
364 LONG res = ERROR_SUCCESS;
366 for (; res == ERROR_SUCCESS && list->name; ++list) {
370 res = RegCreateKeyExA(HKEY_CLASSES_ROOT, list->name, 0,
371 NULL, 0, KEY_READ | KEY_WRITE, NULL,
373 if (res != ERROR_SUCCESS) goto error_close_clsid_key;
375 res = RegSetValueExA(progid_key, NULL, 0, REG_SZ,
376 (CONST BYTE*)list->description,
377 strlen(list->description) + 1);
378 if (res != ERROR_SUCCESS) goto error_close_clsid_key;
380 StringFromGUID2(list->clsid, buf, 39);
382 res = register_key_defvalueW(progid_key, clsid_keyname, buf);
383 if (res != ERROR_SUCCESS) goto error_close_clsid_key;
386 res = register_key_defvalueA(progid_key, curver_keyname, list->curver);
387 if (res != ERROR_SUCCESS) goto error_close_clsid_key;
390 error_close_clsid_key:
391 RegCloseKey(progid_key);
394 return res != ERROR_SUCCESS ? HRESULT_FROM_WIN32(res) : S_OK;
397 /***********************************************************************
400 static HRESULT unregister_progids(struct progid const *list)
402 LONG res = ERROR_SUCCESS;
404 for (; res == ERROR_SUCCESS && list->name; ++list) {
405 res = RegDeleteTreeA(HKEY_CLASSES_ROOT, list->name);
406 if (res == ERROR_FILE_NOT_FOUND) res = ERROR_SUCCESS;
409 return res != ERROR_SUCCESS ? HRESULT_FROM_WIN32(res) : S_OK;
412 /***********************************************************************
415 static LONG register_key_guid(HKEY base, WCHAR const *name, GUID const *guid)
419 StringFromGUID2(guid, buf, 39);
420 return register_key_defvalueW(base, name, buf);
423 /***********************************************************************
424 * regsvr_key_defvalueW
426 static LONG register_key_defvalueW(
434 res = RegCreateKeyExW(base, name, 0, NULL, 0,
435 KEY_READ | KEY_WRITE, NULL, &key, NULL);
436 if (res != ERROR_SUCCESS) return res;
437 res = RegSetValueExW(key, NULL, 0, REG_SZ, (CONST BYTE*)value,
438 (lstrlenW(value) + 1) * sizeof(WCHAR));
443 /***********************************************************************
444 * regsvr_key_defvalueA
446 static LONG register_key_defvalueA(
454 res = RegCreateKeyExW(base, name, 0, NULL, 0,
455 KEY_READ | KEY_WRITE, NULL, &key, NULL);
456 if (res != ERROR_SUCCESS) return res;
457 res = RegSetValueExA(key, NULL, 0, REG_SZ, (CONST BYTE*)value,
458 lstrlenA(value) + 1);
463 /***********************************************************************
466 static struct regsvr_coclass const coclass_list[] = {
467 { &CLSID_DOMDocument,
475 { &CLSID_DOMDocument2,
480 "Msxml2.DOMDocument",
483 { &CLSID_DOMDocument30,
484 "XML DOM Document 3.0",
488 "Msxml2.DOMDocument",
491 { &CLSID_DOMFreeThreadedDocument,
492 "Free threaded XML DOM Document",
496 "Microsoft.FreeThreadedXMLDOM",
499 { &CLSID_DOMFreeThreadedDocument,
500 "Free threaded XML DOM Document",
504 "Microsoft.FreeThreadedXMLDOM",
507 { &CLSID_FreeThreadedDOMDocument,
508 "Free Threaded XML DOM Document",
512 "Microsoft.FreeThreadedXMLDOM.1.0",
516 { &CLSID_XMLHTTPRequest,
524 { &CLSID_XMLDSOControl,
525 "XML Data Source Object",
532 { &CLSID_XMLDocument,
539 { &CLSID_XMLSchemaCache,
544 "Msxml2.XMLSchemaCache",
547 { &CLSID_XMLSchemaCache30,
548 "XML Schema Cache 3.0",
552 "Msxml2.XMLSchemaCache",
555 { NULL } /* list terminator */
558 /***********************************************************************
561 static struct regsvr_interface const interface_list[] = {
562 { NULL } /* list terminator */
565 /***********************************************************************
568 static struct progid const progid_list[] = {
569 { "Microsoft.XMLDOM",
572 "Microsoft.XMLDOM.1.0"
574 { "Microsoft.XMLDOM.1.0",
579 { "MSXML.DOMDocument",
582 "Microsoft.XMLDOM.1.0"
584 { "Msxml2.DOMDocument",
587 "Msxml2.DOMDocument.3.0"
589 { "Msxml2.DOMDocument.3.0",
590 "XML DOM Document 3.0",
591 &CLSID_DOMDocument30,
594 { "Microsoft.FreeThreadedXMLDOM",
595 "Free threaded XML DOM Document",
596 &CLSID_DOMFreeThreadedDocument,
597 "Microsoft.FreeThreadedXMLDOM.1.0"
599 { "Microsoft.FreeThreadedXMLDOM.1.0",
600 "Free threaded XML DOM Document",
601 &CLSID_DOMFreeThreadedDocument,
604 { "MSXML.FreeThreadedDOMDocument",
605 "Free threaded XML DOM Document",
606 &CLSID_DOMFreeThreadedDocument,
607 "Microsoft.FreeThreadedXMLDOM.1.0"
609 { "Microsoft.XMLHTTP",
611 &CLSID_XMLHTTPRequest,
612 "Microsoft.XMLHTTP.1.0"
614 { "Microsoft.XMLHTTP.1.0",
616 &CLSID_XMLHTTPRequest,
619 { "Microsoft.XMLDSO",
620 "XML Data Source Object",
621 &CLSID_XMLDSOControl,
622 "Microsoft.XMLDSO.1.0"
624 { "Microsoft.XMLDSO.1.0",
625 "XML Data Source Object",
626 &CLSID_XMLDSOControl,
634 { "Msxml2.XMLSchemaCache",
636 &CLSID_XMLSchemaCache,
637 "Msxml2.XMLSchemaCache.3.0"
639 { "Msxml2.XMLSchemaCache.3.0",
640 "XML Schema Cache 3.0",
641 &CLSID_XMLSchemaCache30,
645 { NULL } /* list terminator */
648 /***********************************************************************
649 * DllRegisterServer (OLEAUT32.@)
651 HRESULT WINAPI DllRegisterServer(void)
657 hr = register_coclasses(coclass_list);
659 hr = register_interfaces(interface_list);
661 hr = register_progids(progid_list);
665 /***********************************************************************
666 * DllUnregisterServer (OLEAUT32.@)
668 HRESULT WINAPI DllUnregisterServer(void)
674 hr = unregister_coclasses(coclass_list);
676 hr = unregister_interfaces(interface_list);
678 hr = unregister_progids(progid_list);