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
,
138 static LONG
recursive_delete_key(HKEY key
);
139 static LONG
recursive_delete_keyA(HKEY base
, char const *name
);
140 static LONG
recursive_delete_keyW(HKEY base
, WCHAR
const *name
);
142 /***********************************************************************
143 * register_interfaces
145 static HRESULT
register_interfaces(struct regsvr_interface
const *list
)
147 LONG res
= ERROR_SUCCESS
;
150 res
= RegCreateKeyExW(HKEY_CLASSES_ROOT
, interface_keyname
, 0, NULL
, 0,
151 KEY_READ
| KEY_WRITE
, NULL
, &interface_key
, NULL
);
152 if (res
!= ERROR_SUCCESS
) goto error_return
;
154 for (; res
== ERROR_SUCCESS
&& list
->iid
; ++list
) {
158 StringFromGUID2(list
->iid
, buf
, 39);
159 res
= RegCreateKeyExW(interface_key
, buf
, 0, NULL
, 0,
160 KEY_READ
| KEY_WRITE
, NULL
, &iid_key
, NULL
);
161 if (res
!= ERROR_SUCCESS
) goto error_close_interface_key
;
164 res
= RegSetValueExA(iid_key
, NULL
, 0, REG_SZ
,
165 (CONST BYTE
*)(list
->name
),
166 strlen(list
->name
) + 1);
167 if (res
!= ERROR_SUCCESS
) goto error_close_iid_key
;
170 if (list
->base_iid
) {
171 res
= register_key_guid(iid_key
, base_ifa_keyname
, list
->base_iid
);
172 if (res
!= ERROR_SUCCESS
) goto error_close_iid_key
;
175 if (0 <= list
->num_methods
) {
176 static WCHAR
const fmt
[3] = { '%', 'd', 0 };
179 res
= RegCreateKeyExW(iid_key
, num_methods_keyname
, 0, NULL
, 0,
180 KEY_READ
| KEY_WRITE
, NULL
, &key
, NULL
);
181 if (res
!= ERROR_SUCCESS
) goto error_close_iid_key
;
183 wsprintfW(buf
, fmt
, list
->num_methods
);
184 res
= RegSetValueExW(key
, NULL
, 0, REG_SZ
,
186 (lstrlenW(buf
) + 1) * sizeof(WCHAR
));
189 if (res
!= ERROR_SUCCESS
) goto error_close_iid_key
;
192 if (list
->ps_clsid
) {
193 res
= register_key_guid(iid_key
, ps_clsid_keyname
, list
->ps_clsid
);
194 if (res
!= ERROR_SUCCESS
) goto error_close_iid_key
;
197 if (list
->ps_clsid32
) {
198 res
= register_key_guid(iid_key
, ps_clsid32_keyname
, list
->ps_clsid32
);
199 if (res
!= ERROR_SUCCESS
) goto error_close_iid_key
;
203 RegCloseKey(iid_key
);
206 error_close_interface_key
:
207 RegCloseKey(interface_key
);
209 return res
!= ERROR_SUCCESS
? HRESULT_FROM_WIN32(res
) : S_OK
;
212 /***********************************************************************
213 * unregister_interfaces
215 static HRESULT
unregister_interfaces(struct regsvr_interface
const *list
)
217 LONG res
= ERROR_SUCCESS
;
220 res
= RegOpenKeyExW(HKEY_CLASSES_ROOT
, interface_keyname
, 0,
221 KEY_READ
| KEY_WRITE
, &interface_key
);
222 if (res
== ERROR_FILE_NOT_FOUND
) return S_OK
;
223 if (res
!= ERROR_SUCCESS
) goto error_return
;
225 for (; res
== ERROR_SUCCESS
&& list
->iid
; ++list
) {
228 StringFromGUID2(list
->iid
, buf
, 39);
229 res
= recursive_delete_keyW(interface_key
, buf
);
232 RegCloseKey(interface_key
);
234 return res
!= ERROR_SUCCESS
? HRESULT_FROM_WIN32(res
) : S_OK
;
237 /***********************************************************************
240 static HRESULT
register_coclasses(struct regsvr_coclass
const *list
)
242 LONG res
= ERROR_SUCCESS
;
245 res
= RegCreateKeyExW(HKEY_CLASSES_ROOT
, clsid_keyname
, 0, NULL
, 0,
246 KEY_READ
| KEY_WRITE
, NULL
, &coclass_key
, NULL
);
247 if (res
!= ERROR_SUCCESS
) goto error_return
;
249 for (; res
== ERROR_SUCCESS
&& list
->clsid
; ++list
) {
253 StringFromGUID2(list
->clsid
, buf
, 39);
254 res
= RegCreateKeyExW(coclass_key
, buf
, 0, NULL
, 0,
255 KEY_READ
| KEY_WRITE
, NULL
, &clsid_key
, NULL
);
256 if (res
!= ERROR_SUCCESS
) goto error_close_coclass_key
;
259 res
= RegSetValueExA(clsid_key
, NULL
, 0, REG_SZ
,
260 (CONST BYTE
*)(list
->name
),
261 strlen(list
->name
) + 1);
262 if (res
!= ERROR_SUCCESS
) goto error_close_clsid_key
;
266 res
= register_key_defvalueA(clsid_key
, ips_keyname
, list
->ips
);
267 if (res
!= ERROR_SUCCESS
) goto error_close_clsid_key
;
273 res
= RegCreateKeyExW(clsid_key
, ips32_keyname
, 0, NULL
, 0,
274 KEY_READ
| KEY_WRITE
, NULL
,
276 if (res
!= ERROR_SUCCESS
) goto error_close_clsid_key
;
278 res
= RegSetValueExA(ips32_key
, NULL
, 0, REG_SZ
,
279 (CONST BYTE
*)list
->ips32
,
280 lstrlenA(list
->ips32
) + 1);
281 if (res
== ERROR_SUCCESS
&& list
->ips32_tmodel
)
282 res
= RegSetValueExA(ips32_key
, tmodel_valuename
, 0, REG_SZ
,
283 (CONST BYTE
*)list
->ips32_tmodel
,
284 strlen(list
->ips32_tmodel
) + 1);
285 RegCloseKey(ips32_key
);
286 if (res
!= ERROR_SUCCESS
) goto error_close_clsid_key
;
294 buffer
= HeapAlloc(GetProcessHeap(), 0, strlen(list
->progid
) + strlen(list
->version
) + 2);
296 res
= ERROR_OUTOFMEMORY
;
297 goto error_close_clsid_key
;
299 strcpy(buffer
, list
->progid
);
301 strcat(buffer
, list
->version
);
304 progid
= list
->progid
;
305 res
= register_key_defvalueA(clsid_key
, progid_keyname
,
307 HeapFree(GetProcessHeap(), 0, buffer
);
308 if (res
!= ERROR_SUCCESS
) goto error_close_clsid_key
;
311 res
= register_key_defvalueA(clsid_key
, versionindependentprogid_keyname
,
313 if (res
!= ERROR_SUCCESS
) goto error_close_clsid_key
;
318 res
= register_key_defvalueA(clsid_key
, version_keyname
,
320 if (res
!= ERROR_SUCCESS
) goto error_close_clsid_key
;
323 error_close_clsid_key
:
324 RegCloseKey(clsid_key
);
327 error_close_coclass_key
:
328 RegCloseKey(coclass_key
);
330 return res
!= ERROR_SUCCESS
? HRESULT_FROM_WIN32(res
) : S_OK
;
333 /***********************************************************************
334 * unregister_coclasses
336 static HRESULT
unregister_coclasses(struct regsvr_coclass
const *list
)
338 LONG res
= ERROR_SUCCESS
;
341 res
= RegOpenKeyExW(HKEY_CLASSES_ROOT
, clsid_keyname
, 0,
342 KEY_READ
| KEY_WRITE
, &coclass_key
);
343 if (res
== ERROR_FILE_NOT_FOUND
) return S_OK
;
344 if (res
!= ERROR_SUCCESS
) goto error_return
;
346 for (; res
== ERROR_SUCCESS
&& list
->clsid
; ++list
) {
349 StringFromGUID2(list
->clsid
, buf
, 39);
350 res
= recursive_delete_keyW(coclass_key
, buf
);
351 if (res
!= ERROR_SUCCESS
) goto error_close_coclass_key
;
354 error_close_coclass_key
:
355 RegCloseKey(coclass_key
);
357 return res
!= ERROR_SUCCESS
? HRESULT_FROM_WIN32(res
) : S_OK
;
360 /***********************************************************************
363 static HRESULT
register_progids(struct progid
const *list
)
365 LONG res
= ERROR_SUCCESS
;
367 for (; res
== ERROR_SUCCESS
&& list
->name
; ++list
) {
371 res
= RegCreateKeyExA(HKEY_CLASSES_ROOT
, list
->name
, 0,
372 NULL
, 0, KEY_READ
| KEY_WRITE
, NULL
,
374 if (res
!= ERROR_SUCCESS
) goto error_close_clsid_key
;
376 res
= RegSetValueExA(progid_key
, NULL
, 0, REG_SZ
,
377 (CONST BYTE
*)list
->description
,
378 strlen(list
->description
) + 1);
379 if (res
!= ERROR_SUCCESS
) goto error_close_clsid_key
;
381 StringFromGUID2(list
->clsid
, buf
, 39);
383 res
= register_key_defvalueW(progid_key
, clsid_keyname
, buf
);
384 if (res
!= ERROR_SUCCESS
) goto error_close_clsid_key
;
387 res
= register_key_defvalueA(progid_key
, curver_keyname
, list
->curver
);
388 if (res
!= ERROR_SUCCESS
) goto error_close_clsid_key
;
391 error_close_clsid_key
:
392 RegCloseKey(progid_key
);
395 return res
!= ERROR_SUCCESS
? HRESULT_FROM_WIN32(res
) : S_OK
;
398 /***********************************************************************
401 static HRESULT
unregister_progids(struct progid
const *list
)
403 LONG res
= ERROR_SUCCESS
;
405 for (; res
== ERROR_SUCCESS
&& list
->name
; ++list
) {
406 res
= recursive_delete_keyA(HKEY_CLASSES_ROOT
, list
->name
);
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 /***********************************************************************
464 * recursive_delete_key
466 static LONG
recursive_delete_key(HKEY key
)
469 WCHAR subkey_name
[MAX_PATH
];
474 cName
= sizeof(subkey_name
) / sizeof(WCHAR
);
475 res
= RegEnumKeyExW(key
, 0, subkey_name
, &cName
,
476 NULL
, NULL
, NULL
, NULL
);
477 if (res
!= ERROR_SUCCESS
&& res
!= ERROR_MORE_DATA
) {
478 res
= ERROR_SUCCESS
; /* presumably we're done enumerating */
481 res
= RegOpenKeyExW(key
, subkey_name
, 0,
482 KEY_READ
| KEY_WRITE
, &subkey
);
483 if (res
== ERROR_FILE_NOT_FOUND
) continue;
484 if (res
!= ERROR_SUCCESS
) break;
486 res
= recursive_delete_key(subkey
);
488 if (res
!= ERROR_SUCCESS
) break;
491 if (res
== ERROR_SUCCESS
) res
= RegDeleteKeyW(key
, 0);
495 /***********************************************************************
496 * recursive_delete_keyA
498 static LONG
recursive_delete_keyA(HKEY base
, char const *name
)
503 res
= RegOpenKeyExA(base
, name
, 0, KEY_READ
| KEY_WRITE
, &key
);
504 if (res
== ERROR_FILE_NOT_FOUND
) return ERROR_SUCCESS
;
505 if (res
!= ERROR_SUCCESS
) return res
;
506 res
= recursive_delete_key(key
);
511 /***********************************************************************
512 * recursive_delete_keyW
514 static LONG
recursive_delete_keyW(HKEY base
, WCHAR
const *name
)
519 res
= RegOpenKeyExW(base
, name
, 0, KEY_READ
| KEY_WRITE
, &key
);
520 if (res
== ERROR_FILE_NOT_FOUND
) return ERROR_SUCCESS
;
521 if (res
!= ERROR_SUCCESS
) return res
;
522 res
= recursive_delete_key(key
);
527 /***********************************************************************
530 static struct regsvr_coclass
const coclass_list
[] = {
531 { &CLSID_DOMDocument
,
539 { &CLSID_DOMDocument2
,
544 "Msxml2.DOMDocument",
547 { &CLSID_DOMDocument30
,
548 "XML DOM Document 3.0",
552 "Msxml2.DOMDocument",
555 { &CLSID_DOMFreeThreadedDocument
,
556 "Free threaded XML DOM Document",
560 "Microsoft.FreeThreadedXMLDOM",
563 { &CLSID_XMLHTTPRequest
,
571 { &CLSID_XMLDSOControl
,
572 "XML Data Source Object",
579 { &CLSID_XMLDocument
,
586 { &CLSID_XMLSchemaCache
,
591 "Msxml2.XMLSchemaCache",
594 { &CLSID_XMLSchemaCache30
,
595 "XML Schema Cache 3.0",
599 "Msxml2.XMLSchemaCache",
602 { NULL
} /* list terminator */
605 /***********************************************************************
608 static struct regsvr_interface
const interface_list
[] = {
609 { NULL
} /* list terminator */
612 /***********************************************************************
615 static struct progid
const progid_list
[] = {
616 { "Microsoft.XMLDOM",
619 "Microsoft.XMLDOM.1.0"
621 { "Microsoft.XMLDOM.1.0",
626 { "MSXML.DOMDocument",
629 "Microsoft.XMLDOM.1.0"
631 { "Msxml2.DOMDocument",
634 "Msxml2.DOMDocument.3.0"
636 { "Msxml2.DOMDocument.3.0",
637 "XML DOM Document 3.0",
638 &CLSID_DOMDocument30
,
641 { "Microsoft.FreeThreadedXMLDOM",
642 "Free threaded XML DOM Document",
643 &CLSID_DOMFreeThreadedDocument
,
644 "Microsoft.FreeThreadedXMLDOM.1.0"
646 { "Microsoft.FreeThreadedXMLDOM.1.0",
647 "Free threaded XML DOM Document",
648 &CLSID_DOMFreeThreadedDocument
,
651 { "MSXML.FreeThreadedDOMDocument",
652 "Free threaded XML DOM Document",
653 &CLSID_DOMFreeThreadedDocument
,
654 "Microsoft.FreeThreadedXMLDOM.1.0"
656 { "Microsoft.XMLHTTP",
658 &CLSID_XMLHTTPRequest
,
659 "Microsoft.XMLHTTP.1.0"
661 { "Microsoft.XMLHTTP.1.0",
663 &CLSID_XMLHTTPRequest
,
666 { "Microsoft.XMLDSO",
667 "XML Data Source Object",
668 &CLSID_XMLDSOControl
,
669 "Microsoft.XMLDSO.1.0"
671 { "Microsoft.XMLDSO.1.0",
672 "XML Data Source Object",
673 &CLSID_XMLDSOControl
,
681 { "Msxml2.XMLSchemaCache",
683 &CLSID_XMLSchemaCache
,
684 "Msxml2.XMLSchemaCache.3.0"
686 { "Msxml2.XMLSchemaCache.3.0",
687 "XML Schema Cache 3.0",
688 &CLSID_XMLSchemaCache30
,
692 { NULL
} /* list terminator */
695 /***********************************************************************
696 * DllRegisterServer (OLEAUT32.@)
698 HRESULT WINAPI
DllRegisterServer(void)
704 hr
= register_coclasses(coclass_list
);
706 hr
= register_interfaces(interface_list
);
708 hr
= register_progids(progid_list
);
712 /***********************************************************************
713 * DllUnregisterServer (OLEAUT32.@)
715 HRESULT WINAPI
DllUnregisterServer(void)
721 hr
= unregister_coclasses(coclass_list
);
723 hr
= unregister_interfaces(interface_list
);
725 hr
= unregister_progids(progid_list
);