2 * MSXML3 self-registerable dll functions
4 * Copyright (C) 2003 John K. Hohm
5 * Copyright (C) 2006 Robert Shearman
6 * Copyright (C) 2008 Alistair Leslie-Hughes
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
41 /* undef the #define in msxml2 so that we can access the v.2 version
42 independent CLSID as well as the v.3 one. */
43 #undef CLSID_DOMDocument
45 #include "msxml_private.h"
47 #include "wine/debug.h"
48 #include "wine/unicode.h"
50 WINE_DEFAULT_DEBUG_CHANNEL(ole);
53 * Near the bottom of this file are the exported DllRegisterServer and
54 * DllUnregisterServer, which make all this worthwhile.
57 /***********************************************************************
58 * interface for self-registering
60 struct regsvr_interface
62 IID const *iid; /* NULL for end of list */
63 LPCSTR name; /* can be NULL to omit */
64 IID const *base_iid; /* can be NULL to omit */
65 int num_methods; /* can be <0 to omit */
66 CLSID const *ps_clsid; /* can be NULL to omit */
67 CLSID const *ps_clsid32; /* can be NULL to omit */
70 static HRESULT register_interfaces(struct regsvr_interface const *list);
71 static HRESULT unregister_interfaces(struct regsvr_interface const *list);
75 CLSID const *clsid; /* NULL for end of list */
76 LPCSTR name; /* can be NULL to omit */
77 LPCSTR ips; /* can be NULL to omit */
78 LPCSTR ips32; /* can be NULL to omit */
79 LPCSTR ips32_tmodel; /* can be NULL to omit */
80 LPCSTR progid; /* can be NULL to omit */
81 LPCSTR version; /* can be NULL to omit */
84 static HRESULT register_coclasses(struct regsvr_coclass const *list);
85 static HRESULT unregister_coclasses(struct regsvr_coclass const *list);
89 LPCSTR name; /* NULL for end of list */
90 LPCSTR description; /* can be NULL to omit */
92 LPCSTR curver; /* can be NULL to omit */
95 static HRESULT register_progids(struct progid const *list);
96 static HRESULT unregister_progids(struct progid const *list);
98 /***********************************************************************
99 * static string constants
101 static WCHAR const interface_keyname[10] = {
102 'I', 'n', 't', 'e', 'r', 'f', 'a', 'c', 'e', 0 };
103 static WCHAR const base_ifa_keyname[14] = {
104 'B', 'a', 's', 'e', 'I', 'n', 't', 'e', 'r', 'f', 'a', 'c',
106 static WCHAR const num_methods_keyname[11] = {
107 'N', 'u', 'm', 'M', 'e', 't', 'h', 'o', 'd', 's', 0 };
108 static WCHAR const ps_clsid_keyname[15] = {
109 'P', 'r', 'o', 'x', 'y', 'S', 't', 'u', 'b', 'C', 'l', 's',
111 static WCHAR const ps_clsid32_keyname[17] = {
112 'P', 'r', 'o', 'x', 'y', 'S', 't', 'u', 'b', 'C', 'l', 's',
113 'i', 'd', '3', '2', 0 };
114 static WCHAR const clsid_keyname[6] = {
115 'C', 'L', 'S', 'I', 'D', 0 };
116 static WCHAR const ips_keyname[13] = {
117 'I', 'n', 'P', 'r', 'o', 'c', 'S', 'e', 'r', 'v', 'e', 'r',
119 static WCHAR const ips32_keyname[15] = {
120 'I', 'n', 'P', 'r', 'o', 'c', 'S', 'e', 'r', 'v', 'e', 'r',
122 static WCHAR const progid_keyname[7] = {
123 'P', 'r', 'o', 'g', 'I', 'D', 0 };
124 static WCHAR const versionindependentprogid_keyname[] = {
125 'V', 'e', 'r', 's', 'i', 'o', 'n',
126 'I', 'n', 'd', 'e', 'p', 'e', 'n', 'd', 'e', 'n', 't',
127 'P', 'r', 'o', 'g', 'I', 'D', 0 };
128 static WCHAR const version_keyname[] = {
129 'V', 'e', 'r', 's', 'i', 'o', 'n', 0 };
130 static WCHAR const curver_keyname[] = {
131 'C', 'u', 'r', 'V', 'e', 'r', 0 };
132 static char const tmodel_valuename[] = "ThreadingModel";
134 /***********************************************************************
135 * static helper functions
137 static LONG register_key_guid(HKEY base, WCHAR const *name, GUID const *guid);
138 static LONG register_key_defvalueW(HKEY base, WCHAR const *name,
140 static LONG register_key_defvalueA(HKEY base, WCHAR const *name,
143 /***********************************************************************
144 * register_interfaces
146 static HRESULT register_interfaces(struct regsvr_interface const *list)
148 LONG res = ERROR_SUCCESS;
151 res = RegCreateKeyExW(HKEY_CLASSES_ROOT, interface_keyname, 0, NULL, 0,
152 KEY_READ | KEY_WRITE, NULL, &interface_key, NULL);
153 if (res != ERROR_SUCCESS) goto error_return;
155 for (; res == ERROR_SUCCESS && list->iid; ++list) {
159 StringFromGUID2(list->iid, buf, 39);
160 res = RegCreateKeyExW(interface_key, buf, 0, NULL, 0,
161 KEY_READ | KEY_WRITE, NULL, &iid_key, NULL);
162 if (res != ERROR_SUCCESS) goto error_close_interface_key;
165 res = RegSetValueExA(iid_key, NULL, 0, REG_SZ,
166 (CONST BYTE*)(list->name),
167 strlen(list->name) + 1);
168 if (res != ERROR_SUCCESS) goto error_close_iid_key;
171 if (list->base_iid) {
172 res = register_key_guid(iid_key, base_ifa_keyname, list->base_iid);
173 if (res != ERROR_SUCCESS) goto error_close_iid_key;
176 if (0 <= list->num_methods) {
177 static WCHAR const fmt[3] = { '%', 'd', 0 };
180 res = RegCreateKeyExW(iid_key, num_methods_keyname, 0, NULL, 0,
181 KEY_READ | KEY_WRITE, NULL, &key, NULL);
182 if (res != ERROR_SUCCESS) goto error_close_iid_key;
184 sprintfW(buf, fmt, list->num_methods);
185 res = RegSetValueExW(key, NULL, 0, REG_SZ,
187 (lstrlenW(buf) + 1) * sizeof(WCHAR));
190 if (res != ERROR_SUCCESS) goto error_close_iid_key;
193 if (list->ps_clsid) {
194 res = register_key_guid(iid_key, ps_clsid_keyname, list->ps_clsid);
195 if (res != ERROR_SUCCESS) goto error_close_iid_key;
198 if (list->ps_clsid32) {
199 res = register_key_guid(iid_key, ps_clsid32_keyname, list->ps_clsid32);
200 if (res != ERROR_SUCCESS) goto error_close_iid_key;
204 RegCloseKey(iid_key);
207 error_close_interface_key:
208 RegCloseKey(interface_key);
210 return res != ERROR_SUCCESS ? HRESULT_FROM_WIN32(res) : S_OK;
213 /***********************************************************************
214 * unregister_interfaces
216 static HRESULT unregister_interfaces(struct regsvr_interface const *list)
218 LONG res = ERROR_SUCCESS;
221 res = RegOpenKeyExW(HKEY_CLASSES_ROOT, interface_keyname, 0,
222 KEY_READ | KEY_WRITE, &interface_key);
223 if (res == ERROR_FILE_NOT_FOUND) return S_OK;
224 if (res != ERROR_SUCCESS) goto error_return;
226 for (; res == ERROR_SUCCESS && list->iid; ++list) {
229 StringFromGUID2(list->iid, buf, 39);
230 res = RegDeleteTreeW(interface_key, buf);
231 if (res == ERROR_FILE_NOT_FOUND) res = ERROR_SUCCESS;
234 RegCloseKey(interface_key);
236 return res != ERROR_SUCCESS ? HRESULT_FROM_WIN32(res) : S_OK;
239 /***********************************************************************
242 static HRESULT register_coclasses(struct regsvr_coclass const *list)
244 LONG res = ERROR_SUCCESS;
247 res = RegCreateKeyExW(HKEY_CLASSES_ROOT, clsid_keyname, 0, NULL, 0,
248 KEY_READ | KEY_WRITE, NULL, &coclass_key, NULL);
249 if (res != ERROR_SUCCESS) goto error_return;
251 for (; res == ERROR_SUCCESS && list->clsid; ++list) {
255 StringFromGUID2(list->clsid, buf, 39);
256 res = RegCreateKeyExW(coclass_key, buf, 0, NULL, 0,
257 KEY_READ | KEY_WRITE, NULL, &clsid_key, NULL);
258 if (res != ERROR_SUCCESS) goto error_close_coclass_key;
261 res = RegSetValueExA(clsid_key, NULL, 0, REG_SZ,
262 (CONST BYTE*)(list->name),
263 strlen(list->name) + 1);
264 if (res != ERROR_SUCCESS) goto error_close_clsid_key;
268 res = register_key_defvalueA(clsid_key, ips_keyname, list->ips);
269 if (res != ERROR_SUCCESS) goto error_close_clsid_key;
275 res = RegCreateKeyExW(clsid_key, ips32_keyname, 0, NULL, 0,
276 KEY_READ | KEY_WRITE, NULL,
278 if (res != ERROR_SUCCESS) goto error_close_clsid_key;
280 res = RegSetValueExA(ips32_key, NULL, 0, REG_SZ,
281 (CONST BYTE*)list->ips32,
282 lstrlenA(list->ips32) + 1);
283 if (res == ERROR_SUCCESS && list->ips32_tmodel)
284 res = RegSetValueExA(ips32_key, tmodel_valuename, 0, REG_SZ,
285 (CONST BYTE*)list->ips32_tmodel,
286 strlen(list->ips32_tmodel) + 1);
287 RegCloseKey(ips32_key);
288 if (res != ERROR_SUCCESS) goto error_close_clsid_key;
296 buffer = HeapAlloc(GetProcessHeap(), 0, strlen(list->progid) + strlen(list->version) + 2);
298 res = ERROR_OUTOFMEMORY;
299 goto error_close_clsid_key;
301 strcpy(buffer, list->progid);
303 strcat(buffer, list->version);
306 progid = list->progid;
307 res = register_key_defvalueA(clsid_key, progid_keyname,
309 HeapFree(GetProcessHeap(), 0, buffer);
310 if (res != ERROR_SUCCESS) goto error_close_clsid_key;
313 res = register_key_defvalueA(clsid_key, versionindependentprogid_keyname,
315 if (res != ERROR_SUCCESS) goto error_close_clsid_key;
320 res = register_key_defvalueA(clsid_key, version_keyname,
322 if (res != ERROR_SUCCESS) goto error_close_clsid_key;
325 error_close_clsid_key:
326 RegCloseKey(clsid_key);
329 error_close_coclass_key:
330 RegCloseKey(coclass_key);
332 return res != ERROR_SUCCESS ? HRESULT_FROM_WIN32(res) : S_OK;
335 /***********************************************************************
336 * unregister_coclasses
338 static HRESULT unregister_coclasses(struct regsvr_coclass const *list)
340 LONG res = ERROR_SUCCESS;
343 res = RegOpenKeyExW(HKEY_CLASSES_ROOT, clsid_keyname, 0,
344 KEY_READ | KEY_WRITE, &coclass_key);
345 if (res == ERROR_FILE_NOT_FOUND) return S_OK;
346 if (res != ERROR_SUCCESS) goto error_return;
348 for (; res == ERROR_SUCCESS && list->clsid; ++list) {
351 StringFromGUID2(list->clsid, buf, 39);
352 res = RegDeleteTreeW(coclass_key, buf);
353 if (res == ERROR_FILE_NOT_FOUND) res = ERROR_SUCCESS;
354 if (res != ERROR_SUCCESS) goto error_close_coclass_key;
357 error_close_coclass_key:
358 RegCloseKey(coclass_key);
360 return res != ERROR_SUCCESS ? HRESULT_FROM_WIN32(res) : S_OK;
363 /***********************************************************************
366 static HRESULT register_progids(struct progid const *list)
368 LONG res = ERROR_SUCCESS;
370 for (; res == ERROR_SUCCESS && list->name; ++list) {
374 res = RegCreateKeyExA(HKEY_CLASSES_ROOT, list->name, 0,
375 NULL, 0, KEY_READ | KEY_WRITE, NULL,
377 if (res != ERROR_SUCCESS) goto error_close_clsid_key;
379 res = RegSetValueExA(progid_key, NULL, 0, REG_SZ,
380 (CONST BYTE*)list->description,
381 strlen(list->description) + 1);
382 if (res != ERROR_SUCCESS) goto error_close_clsid_key;
384 StringFromGUID2(list->clsid, buf, 39);
386 res = register_key_defvalueW(progid_key, clsid_keyname, buf);
387 if (res != ERROR_SUCCESS) goto error_close_clsid_key;
390 res = register_key_defvalueA(progid_key, curver_keyname, list->curver);
391 if (res != ERROR_SUCCESS) goto error_close_clsid_key;
394 error_close_clsid_key:
395 RegCloseKey(progid_key);
398 return res != ERROR_SUCCESS ? HRESULT_FROM_WIN32(res) : S_OK;
401 /***********************************************************************
404 static HRESULT unregister_progids(struct progid const *list)
406 LONG res = ERROR_SUCCESS;
408 for (; res == ERROR_SUCCESS && list->name; ++list) {
409 res = RegDeleteTreeA(HKEY_CLASSES_ROOT, list->name);
410 if (res == ERROR_FILE_NOT_FOUND) res = ERROR_SUCCESS;
413 return res != ERROR_SUCCESS ? HRESULT_FROM_WIN32(res) : S_OK;
416 /***********************************************************************
419 static LONG register_key_guid(HKEY base, WCHAR const *name, GUID const *guid)
423 StringFromGUID2(guid, buf, 39);
424 return register_key_defvalueW(base, name, buf);
427 /***********************************************************************
428 * regsvr_key_defvalueW
430 static LONG register_key_defvalueW(
438 res = RegCreateKeyExW(base, name, 0, NULL, 0,
439 KEY_READ | KEY_WRITE, NULL, &key, NULL);
440 if (res != ERROR_SUCCESS) return res;
441 res = RegSetValueExW(key, NULL, 0, REG_SZ, (CONST BYTE*)value,
442 (lstrlenW(value) + 1) * sizeof(WCHAR));
447 /***********************************************************************
448 * regsvr_key_defvalueA
450 static LONG register_key_defvalueA(
458 res = RegCreateKeyExW(base, name, 0, NULL, 0,
459 KEY_READ | KEY_WRITE, NULL, &key, NULL);
460 if (res != ERROR_SUCCESS) return res;
461 res = RegSetValueExA(key, NULL, 0, REG_SZ, (CONST BYTE*)value,
462 lstrlenA(value) + 1);
467 /***********************************************************************
470 static struct regsvr_coclass const coclass_list[] = {
471 { &CLSID_DOMDocument,
479 { &CLSID_DOMDocument2,
484 "Msxml2.DOMDocument",
487 { &CLSID_DOMDocument30,
488 "XML DOM Document 3.0",
492 "Msxml2.DOMDocument",
495 { &CLSID_DOMFreeThreadedDocument,
496 "Free threaded XML DOM Document",
500 "Microsoft.FreeThreadedXMLDOM",
503 { &CLSID_DOMFreeThreadedDocument,
504 "Free threaded XML DOM Document",
508 "Microsoft.FreeThreadedXMLDOM",
511 { &CLSID_FreeThreadedDOMDocument,
512 "Free Threaded XML DOM Document",
516 "Microsoft.FreeThreadedXMLDOM.1.0",
520 { &CLSID_XMLHTTPRequest,
528 { &CLSID_XMLDSOControl,
529 "XML Data Source Object",
536 { &CLSID_XMLDocument,
543 { &CLSID_XMLSchemaCache,
548 "Msxml2.XMLSchemaCache",
551 { &CLSID_XMLSchemaCache30,
552 "XML Schema Cache 3.0",
556 "Msxml2.XMLSchemaCache",
559 { &CLSID_SAXXMLReader,
564 "Msxml2.SAXXMLReader",
567 { &CLSID_SAXXMLReader30,
568 "SAX XML Reader 3.0",
572 "Msxml2.SAXXMLReader",
575 { NULL } /* list terminator */
578 /***********************************************************************
581 static struct regsvr_interface const interface_list[] = {
582 { NULL } /* list terminator */
585 /***********************************************************************
588 static struct progid const progid_list[] = {
589 { "Microsoft.XMLDOM",
592 "Microsoft.XMLDOM.1.0"
594 { "Microsoft.XMLDOM.1.0",
599 { "MSXML.DOMDocument",
602 "Microsoft.XMLDOM.1.0"
604 { "Msxml2.DOMDocument",
607 "Msxml2.DOMDocument.3.0"
609 { "Msxml2.DOMDocument.3.0",
610 "XML DOM Document 3.0",
611 &CLSID_DOMDocument30,
614 { "Microsoft.FreeThreadedXMLDOM",
615 "Free threaded XML DOM Document",
616 &CLSID_DOMFreeThreadedDocument,
617 "Microsoft.FreeThreadedXMLDOM.1.0"
619 { "Microsoft.FreeThreadedXMLDOM.1.0",
620 "Free threaded XML DOM Document",
621 &CLSID_DOMFreeThreadedDocument,
624 { "MSXML.FreeThreadedDOMDocument",
625 "Free threaded XML DOM Document",
626 &CLSID_DOMFreeThreadedDocument,
627 "Microsoft.FreeThreadedXMLDOM.1.0"
629 { "Microsoft.XMLHTTP",
631 &CLSID_XMLHTTPRequest,
632 "Microsoft.XMLHTTP.1.0"
634 { "Microsoft.XMLHTTP.1.0",
636 &CLSID_XMLHTTPRequest,
639 { "Microsoft.XMLDSO",
640 "XML Data Source Object",
641 &CLSID_XMLDSOControl,
642 "Microsoft.XMLDSO.1.0"
644 { "Microsoft.XMLDSO.1.0",
645 "XML Data Source Object",
646 &CLSID_XMLDSOControl,
654 { "Msxml2.XMLSchemaCache",
656 &CLSID_XMLSchemaCache,
657 "Msxml2.XMLSchemaCache.3.0"
659 { "Msxml2.XMLSchemaCache.3.0",
660 "XML Schema Cache 3.0",
661 &CLSID_XMLSchemaCache30,
664 { "Msxml2.SAXXMLReader",
667 "Msxml2.SAXXMLReader.3.0"
669 { "Msxml2.SAXXMLReader.3.0",
670 "SAX XML Reader 3.0",
671 &CLSID_SAXXMLReader30,
675 { NULL } /* list terminator */
678 /***********************************************************************
679 * DllRegisterServer (OLEAUT32.@)
681 HRESULT WINAPI DllRegisterServer(void)
685 static const WCHAR wszMsXml3[] = {'m','s','x','m','l','3','.','d','l','l',0};
689 hr = register_coclasses(coclass_list);
691 hr = register_interfaces(interface_list);
693 hr = register_progids(progid_list);
697 hr = LoadTypeLibEx(wszMsXml3, REGKIND_REGISTER, &tl);
699 ITypeLib_Release(tl);
705 /***********************************************************************
706 * DllUnregisterServer (OLEAUT32.@)
708 HRESULT WINAPI DllUnregisterServer(void)
714 hr = unregister_coclasses(coclass_list);
716 hr = unregister_interfaces(interface_list);
718 hr = unregister_progids(progid_list);
720 hr = UnRegisterTypeLib(&LIBID_MSXML2, 3, 0, LOCALE_SYSTEM_DEFAULT, SYS_WIN32);