dlls/dmusic/regsvr.c

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