Improve c2man Documented-Total count. Changes:
[wine] / dlls / avifil32 / regsvr.c
1 /*
2  *      self-registerable dll functions for avifile.dll and avifil32.dll
3  *
4  * Copyright (C) 2003 John K. Hohm
5  *
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.
10  *
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.
15  *
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
19  */
20
21 #define COM_NO_WINDOWS_H
22 #include <stdarg.h>
23 #include <string.h>
24
25 #include "windef.h"
26 #include "winbase.h"
27 #include "wingdi.h"
28 #include "winuser.h"
29 #include "winreg.h"
30 #include "winerror.h"
31
32 #include "mmsystem.h"
33 #include "vfw.h"
34 #include "avifile_private.h"
35
36 #include "wine/debug.h"
37
38 WINE_DEFAULT_DEBUG_CHANNEL(avifile);
39
40 /*
41  * Near the bottom of this file are the exported DllRegisterServer and
42  * DllUnregisterServer, which make all this worthwhile.
43  */
44
45 /***********************************************************************
46  *              interface for self-registering
47  */
48 struct regsvr_interface
49 {
50     IID const *iid;             /* NULL for end of list */
51     LPCSTR name;                /* can be NULL to omit */
52     IID const *base_iid;        /* can be NULL to omit */
53     int num_methods;            /* can be <0 to omit */
54     CLSID const *ps_clsid;      /* can be NULL to omit */
55     CLSID const *ps_clsid32;    /* can be NULL to omit */
56 };
57
58 static HRESULT register_interfaces(struct regsvr_interface const *list);
59 static HRESULT unregister_interfaces(struct regsvr_interface const *list);
60
61 struct regsvr_coclass
62 {
63     CLSID const *clsid;         /* NULL for end of list */
64     LPCSTR name;                /* can be NULL to omit */
65     LPCSTR ips;                 /* can be NULL to omit */
66     LPCSTR ips32;               /* can be NULL to omit */
67     LPCSTR ips32_tmodel;        /* can be NULL to omit */
68     LPCSTR progid;              /* can be NULL to omit */
69     LPCSTR viprogid;            /* can be NULL to omit */
70     LPCSTR progid_extra;        /* can be NULL to omit */
71 };
72
73 static HRESULT register_coclasses(struct regsvr_coclass const *list);
74 static HRESULT unregister_coclasses(struct regsvr_coclass const *list);
75
76 /***********************************************************************
77  *              static string constants
78  */
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',
83     'e', 0 };
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',
88     'i', 'd', 0 };
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 curver_keyname[7] = {
95     'C', 'u', 'r', 'V', 'e', 'r', 0 };
96 static WCHAR const ips_keyname[13] = {
97     'I', 'n', 'P', 'r', 'o', 'c', 'S', 'e', 'r', 'v', 'e', 'r',
98     0 };
99 static WCHAR const ips32_keyname[15] = {
100     'I', 'n', 'P', 'r', 'o', 'c', 'S', 'e', 'r', 'v', 'e', 'r',
101     '3', '2', 0 };
102 static WCHAR const progid_keyname[7] = {
103     'P', 'r', 'o', 'g', 'I', 'D', 0 };
104 static WCHAR const viprogid_keyname[25] = {
105     'V', 'e', 'r', 's', 'i', 'o', 'n', 'I', 'n', 'd', 'e', 'p',
106     'e', 'n', 'd', 'e', 'n', 't', 'P', 'r', 'o', 'g', 'I', 'D',
107     0 };
108 static char const tmodel_valuename[] = "ThreadingModel";
109
110 /***********************************************************************
111  *              static helper functions
112  */
113 static LONG register_key_guid(HKEY base, WCHAR const *name, GUID const *guid);
114 static LONG register_key_defvalueW(HKEY base, WCHAR const *name,
115                                    WCHAR const *value);
116 static LONG register_key_defvalueA(HKEY base, WCHAR const *name,
117                                    char const *value);
118 static LONG register_progid(WCHAR const *clsid,
119                             char const *progid, char const *curver_progid,
120                             char const *name, char const *extra);
121 static LONG recursive_delete_key(HKEY key);
122 static LONG recursive_delete_keyA(HKEY base, char const *name);
123 static LONG recursive_delete_keyW(HKEY base, WCHAR const *name);
124
125 /***********************************************************************
126  *              register_interfaces
127  */
128 static HRESULT register_interfaces(struct regsvr_interface const *list)
129 {
130     LONG res = ERROR_SUCCESS;
131     HKEY interface_key;
132
133     res = RegCreateKeyExW(HKEY_CLASSES_ROOT, interface_keyname, 0, NULL, 0,
134                           KEY_READ | KEY_WRITE, NULL, &interface_key, NULL);
135     if (res != ERROR_SUCCESS) goto error_return;
136
137     for (; res == ERROR_SUCCESS && list->iid; ++list) {
138         WCHAR buf[39];
139         HKEY iid_key;
140
141         StringFromGUID2(list->iid, buf, 39);
142         res = RegCreateKeyExW(interface_key, buf, 0, NULL, 0,
143                               KEY_READ | KEY_WRITE, NULL, &iid_key, NULL);
144         if (res != ERROR_SUCCESS) goto error_close_interface_key;
145
146         if (list->name) {
147             res = RegSetValueExA(iid_key, NULL, 0, REG_SZ,
148                                  (CONST BYTE*)(list->name),
149                                  strlen(list->name) + 1);
150             if (res != ERROR_SUCCESS) goto error_close_iid_key;
151         }
152
153         if (list->base_iid) {
154             register_key_guid(iid_key, base_ifa_keyname, list->base_iid);
155             if (res != ERROR_SUCCESS) goto error_close_iid_key;
156         }
157
158         if (0 <= list->num_methods) {
159             static WCHAR const fmt[3] = { '%', 'd', 0 };
160             HKEY key;
161
162             res = RegCreateKeyExW(iid_key, num_methods_keyname, 0, NULL, 0,
163                                   KEY_READ | KEY_WRITE, NULL, &key, NULL);
164             if (res != ERROR_SUCCESS) goto error_close_iid_key;
165
166             wsprintfW(buf, fmt, list->num_methods);
167             res = RegSetValueExW(key, NULL, 0, REG_SZ,
168                                  (CONST BYTE*)buf,
169                                  (lstrlenW(buf) + 1) * sizeof(WCHAR));
170             RegCloseKey(key);
171
172             if (res != ERROR_SUCCESS) goto error_close_iid_key;
173         }
174
175         if (list->ps_clsid) {
176             register_key_guid(iid_key, ps_clsid_keyname, list->ps_clsid);
177             if (res != ERROR_SUCCESS) goto error_close_iid_key;
178         }
179
180         if (list->ps_clsid32) {
181             register_key_guid(iid_key, ps_clsid32_keyname, list->ps_clsid32);
182             if (res != ERROR_SUCCESS) goto error_close_iid_key;
183         }
184
185     error_close_iid_key:
186         RegCloseKey(iid_key);
187     }
188
189 error_close_interface_key:
190     RegCloseKey(interface_key);
191 error_return:
192     return res != ERROR_SUCCESS ? HRESULT_FROM_WIN32(res) : S_OK;
193 }
194
195 /***********************************************************************
196  *              unregister_interfaces
197  */
198 static HRESULT unregister_interfaces(struct regsvr_interface const *list)
199 {
200     LONG res = ERROR_SUCCESS;
201     HKEY interface_key;
202
203     res = RegOpenKeyExW(HKEY_CLASSES_ROOT, interface_keyname, 0,
204                         KEY_READ | KEY_WRITE, &interface_key);
205     if (res == ERROR_FILE_NOT_FOUND) return S_OK;
206     if (res != ERROR_SUCCESS) goto error_return;
207
208     for (; res == ERROR_SUCCESS && list->iid; ++list) {
209         WCHAR buf[39];
210
211         StringFromGUID2(list->iid, buf, 39);
212         res = recursive_delete_keyW(interface_key, buf);
213     }
214
215     RegCloseKey(interface_key);
216 error_return:
217     return res != ERROR_SUCCESS ? HRESULT_FROM_WIN32(res) : S_OK;
218 }
219
220 /***********************************************************************
221  *              register_coclasses
222  */
223 static HRESULT register_coclasses(struct regsvr_coclass const *list)
224 {
225     LONG res = ERROR_SUCCESS;
226     HKEY coclass_key;
227
228     res = RegCreateKeyExW(HKEY_CLASSES_ROOT, clsid_keyname, 0, NULL, 0,
229                           KEY_READ | KEY_WRITE, NULL, &coclass_key, NULL);
230     if (res != ERROR_SUCCESS) goto error_return;
231
232     for (; res == ERROR_SUCCESS && list->clsid; ++list) {
233         WCHAR buf[39];
234         HKEY clsid_key;
235
236         StringFromGUID2(list->clsid, buf, 39);
237         res = RegCreateKeyExW(coclass_key, buf, 0, NULL, 0,
238                               KEY_READ | KEY_WRITE, NULL, &clsid_key, NULL);
239         if (res != ERROR_SUCCESS) goto error_close_coclass_key;
240
241         if (list->name) {
242             res = RegSetValueExA(clsid_key, NULL, 0, REG_SZ,
243                                  (CONST BYTE*)(list->name),
244                                  strlen(list->name) + 1);
245             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
246         }
247
248         if (list->ips) {
249             res = register_key_defvalueA(clsid_key, ips_keyname, list->ips);
250             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
251         }
252
253         if (list->ips32) {
254             HKEY ips32_key;
255
256             res = RegCreateKeyExW(clsid_key, ips32_keyname, 0, NULL, 0,
257                                   KEY_READ | KEY_WRITE, NULL,
258                                   &ips32_key, NULL);
259             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
260
261             res = RegSetValueExA(ips32_key, NULL, 0, REG_SZ,
262                                  (CONST BYTE*)list->ips32,
263                                  lstrlenA(list->ips32) + 1);
264             if (res == ERROR_SUCCESS && list->ips32_tmodel)
265                 res = RegSetValueExA(ips32_key, tmodel_valuename, 0, REG_SZ,
266                                      (CONST BYTE*)list->ips32_tmodel,
267                                      strlen(list->ips32_tmodel) + 1);
268             RegCloseKey(ips32_key);
269             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
270         }
271
272         if (list->progid) {
273             res = register_key_defvalueA(clsid_key, progid_keyname,
274                                          list->progid);
275             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
276
277             res = register_progid(buf, list->progid, NULL,
278                                   list->name, list->progid_extra);
279             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
280         }
281
282         if (list->viprogid) {
283             res = register_key_defvalueA(clsid_key, viprogid_keyname,
284                                          list->viprogid);
285             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
286
287             res = register_progid(buf, list->viprogid, list->progid,
288                                   list->name, list->progid_extra);
289             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
290         }
291
292     error_close_clsid_key:
293         RegCloseKey(clsid_key);
294     }
295
296 error_close_coclass_key:
297     RegCloseKey(coclass_key);
298 error_return:
299     return res != ERROR_SUCCESS ? HRESULT_FROM_WIN32(res) : S_OK;
300 }
301
302 /***********************************************************************
303  *              unregister_coclasses
304  */
305 static HRESULT unregister_coclasses(struct regsvr_coclass const *list)
306 {
307     LONG res = ERROR_SUCCESS;
308     HKEY coclass_key;
309
310     res = RegOpenKeyExW(HKEY_CLASSES_ROOT, clsid_keyname, 0,
311                         KEY_READ | KEY_WRITE, &coclass_key);
312     if (res == ERROR_FILE_NOT_FOUND) return S_OK;
313     if (res != ERROR_SUCCESS) goto error_return;
314
315     for (; res == ERROR_SUCCESS && list->clsid; ++list) {
316         WCHAR buf[39];
317
318         StringFromGUID2(list->clsid, buf, 39);
319         res = recursive_delete_keyW(coclass_key, buf);
320         if (res != ERROR_SUCCESS) goto error_close_coclass_key;
321
322         if (list->progid) {
323             res = recursive_delete_keyA(HKEY_CLASSES_ROOT, list->progid);
324             if (res != ERROR_SUCCESS) goto error_close_coclass_key;
325         }
326
327         if (list->viprogid) {
328             res = recursive_delete_keyA(HKEY_CLASSES_ROOT, list->viprogid);
329             if (res != ERROR_SUCCESS) goto error_close_coclass_key;
330         }
331     }
332
333 error_close_coclass_key:
334     RegCloseKey(coclass_key);
335 error_return:
336     return res != ERROR_SUCCESS ? HRESULT_FROM_WIN32(res) : S_OK;
337 }
338
339 /***********************************************************************
340  *              regsvr_key_guid
341  */
342 static LONG register_key_guid(HKEY base, WCHAR const *name, GUID const *guid)
343 {
344     WCHAR buf[39];
345
346     StringFromGUID2(guid, buf, 39);
347     return register_key_defvalueW(base, name, buf);
348 }
349
350 /***********************************************************************
351  *              regsvr_key_defvalueW
352  */
353 static LONG register_key_defvalueW(
354     HKEY base,
355     WCHAR const *name,
356     WCHAR const *value)
357 {
358     LONG res;
359     HKEY key;
360
361     res = RegCreateKeyExW(base, name, 0, NULL, 0,
362                           KEY_READ | KEY_WRITE, NULL, &key, NULL);
363     if (res != ERROR_SUCCESS) return res;
364     res = RegSetValueExW(key, NULL, 0, REG_SZ, (CONST BYTE*)value,
365                          (lstrlenW(value) + 1) * sizeof(WCHAR));
366     RegCloseKey(key);
367     return res;
368 }
369
370 /***********************************************************************
371  *              regsvr_key_defvalueA
372  */
373 static LONG register_key_defvalueA(
374     HKEY base,
375     WCHAR const *name,
376     char const *value)
377 {
378     LONG res;
379     HKEY key;
380
381     res = RegCreateKeyExW(base, name, 0, NULL, 0,
382                           KEY_READ | KEY_WRITE, NULL, &key, NULL);
383     if (res != ERROR_SUCCESS) return res;
384     res = RegSetValueExA(key, NULL, 0, REG_SZ, (CONST BYTE*)value,
385                          lstrlenA(value) + 1);
386     RegCloseKey(key);
387     return res;
388 }
389
390 /***********************************************************************
391  *              regsvr_progid
392  */
393 static LONG register_progid(
394     WCHAR const *clsid,
395     char const *progid,
396     char const *curver_progid,
397     char const *name,
398     char const *extra)
399 {
400     LONG res;
401     HKEY progid_key;
402
403     res = RegCreateKeyExA(HKEY_CLASSES_ROOT, progid, 0,
404                           NULL, 0, KEY_READ | KEY_WRITE, NULL,
405                           &progid_key, NULL);
406     if (res != ERROR_SUCCESS) return res;
407
408     if (name) {
409         res = RegSetValueExA(progid_key, NULL, 0, REG_SZ,
410                              (CONST BYTE*)name, strlen(name) + 1);
411         if (res != ERROR_SUCCESS) goto error_close_progid_key;
412     }
413
414     if (clsid) {
415         res = register_key_defvalueW(progid_key, clsid_keyname, clsid);
416         if (res != ERROR_SUCCESS) goto error_close_progid_key;
417     }
418
419     if (curver_progid) {
420         res = register_key_defvalueA(progid_key, curver_keyname,
421                                      curver_progid);
422         if (res != ERROR_SUCCESS) goto error_close_progid_key;
423     }
424
425     if (extra) {
426         HKEY extra_key;
427
428         res = RegCreateKeyExA(progid_key, extra, 0,
429                               NULL, 0, KEY_READ | KEY_WRITE, NULL,
430                               &extra_key, NULL);
431         if (res == ERROR_SUCCESS)
432             RegCloseKey(extra_key);
433     }
434
435 error_close_progid_key:
436     RegCloseKey(progid_key);
437     return res;
438 }
439
440 /***********************************************************************
441  *              recursive_delete_key
442  */
443 static LONG recursive_delete_key(HKEY key)
444 {
445     LONG res;
446     WCHAR subkey_name[MAX_PATH];
447     DWORD cName;
448     HKEY subkey;
449
450     for (;;) {
451         cName = sizeof(subkey_name) / sizeof(WCHAR);
452         res = RegEnumKeyExW(key, 0, subkey_name, &cName,
453                             NULL, NULL, NULL, NULL);
454         if (res != ERROR_SUCCESS && res != ERROR_MORE_DATA) {
455             res = ERROR_SUCCESS; /* presumably we're done enumerating */
456             break;
457         }
458         res = RegOpenKeyExW(key, subkey_name, 0,
459                             KEY_READ | KEY_WRITE, &subkey);
460         if (res == ERROR_FILE_NOT_FOUND) continue;
461         if (res != ERROR_SUCCESS) break;
462
463         res = recursive_delete_key(subkey);
464         RegCloseKey(subkey);
465         if (res != ERROR_SUCCESS) break;
466     }
467
468     if (res == ERROR_SUCCESS) res = RegDeleteKeyW(key, 0);
469     return res;
470 }
471
472 /***********************************************************************
473  *              recursive_delete_keyA
474  */
475 static LONG recursive_delete_keyA(HKEY base, char const *name)
476 {
477     LONG res;
478     HKEY key;
479
480     res = RegOpenKeyExA(base, name, 0, KEY_READ | KEY_WRITE, &key);
481     if (res == ERROR_FILE_NOT_FOUND) return ERROR_SUCCESS;
482     if (res != ERROR_SUCCESS) return res;
483     res = recursive_delete_key(key);
484     RegCloseKey(key);
485     return res;
486 }
487
488 /***********************************************************************
489  *              recursive_delete_keyW
490  */
491 static LONG recursive_delete_keyW(HKEY base, WCHAR const *name)
492 {
493     LONG res;
494     HKEY key;
495
496     res = RegOpenKeyExW(base, name, 0, KEY_READ | KEY_WRITE, &key);
497     if (res == ERROR_FILE_NOT_FOUND) return ERROR_SUCCESS;
498     if (res != ERROR_SUCCESS) return res;
499     res = recursive_delete_key(key);
500     RegCloseKey(key);
501     return res;
502 }
503
504 /***********************************************************************
505  *              coclass list
506  */
507 static GUID const CLSID_AVIProxy = {
508     0x0002000D, 0x0000, 0x0000, {0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46} };
509
510 static struct regsvr_coclass const coclass_list[] = {
511     {   &CLSID_AVIFile,
512         "Microsoft AVI Files",
513         "avifile.dll",
514         "avifil32.dll",
515         "Apartment"
516     },
517     {   &CLSID_ICMStream,
518         "AVI Compressed Stream",
519         "avifile.dll",
520         "avifil32.dll",
521         "Apartment"
522     },
523     {   &CLSID_WAVFile,
524         "Microsoft Wave File",
525         "avifile.dll",
526         "avifil32.dll",
527         "Apartment"
528     },
529     {   &CLSID_AVIProxy,
530         "IAVIStream & IAVIFile Proxy",
531         "avifile.dll",
532         "avifil32.dll",
533         "Apartment"
534     },
535     {   &CLSID_ACMStream,
536         "ACM Compressed Audio Stream",
537         "avifile.dll",
538         "avifil32.dll",
539         "Apartment"
540     },
541     { NULL }                    /* list terminator */
542 };
543
544 /***********************************************************************
545  *              interface list
546  */
547
548 static struct regsvr_interface const interface_list[] = {
549     { NULL }                    /* list terminator */
550 };
551
552 /***********************************************************************
553  *              DllRegisterServer (AVIFILE.@)
554  */
555 HRESULT WINAPI DllRegisterServer(void)
556 {
557     HRESULT hr;
558
559     TRACE("\n");
560
561     hr = register_coclasses(coclass_list);
562     if (SUCCEEDED(hr))
563         hr = register_interfaces(interface_list);
564     return hr;
565 }
566
567 /***********************************************************************
568  *              DllUnregisterServer (AVIFILE.@)
569  */
570 HRESULT WINAPI DllUnregisterServer(void)
571 {
572     HRESULT hr;
573
574     TRACE("\n");
575
576     hr = unregister_coclasses(coclass_list);
577     if (SUCCEEDED(hr))
578         hr = unregister_interfaces(interface_list);
579     return hr;
580 }