dlls/gameux/regsvr.c

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