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