dlls/ddraw/regsvr.c

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