dlls/objsel/regsvr.c

   1 /*
   2  *      self-registerable dll functions for objsel.dll
   3  *
   4  * Copyright (C) 2004 Raphael Junqueira
   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 #include "windef.h"
  27 #include "winbase.h"
  28 #include "winuser.h"
  29 #include "winreg.h"
  30 #include "winerror.h"
  31
  32 #include "objbase.h"
  33 #include "unknwn.h"
  34 #include "objsel.h"
  35
  36 #include "wine/debug.h"
  37
  38 #include "initguid.h"
  39
  40 WINE_DEFAULT_DEBUG_CHANNEL(objsel);
  41
  42 /*
  43  * Near the bottom of this file are the exported DllRegisterServer and
  44  * DllUnregisterServer, which make all this worthwhile.
  45  */
  46
  47 /***********************************************************************
  48  *              interface for self-registering
  49  */
  50 struct regsvr_interface {
  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 /**
  63  * @todo: maybe adding typelibs support here
  64  * [Software\\Classes\\CLSID\\{000C1090-0000-0000-C000-000000000046}\\TypeLib] 1080380217
  65  * @="{000C1092-0000-0000-C000-000000000046}"
  66  */
  67 struct regsvr_coclass {
  68     CLSID const *clsid;         /* NULL for end of list */
  69     LPCSTR name;                /* can be NULL to omit */
  70     LPCSTR iph32;               /* can be NULL to omit */
  71     LPCSTR ips;                 /* can be NULL to omit */
  72     LPCSTR ips32;               /* can be NULL to omit */
  73     LPCSTR ips32_tmodel;        /* can be NULL to omit, if apartment, iph32 must be set */
  74     LPCSTR progid;              /* can be NULL to omit */
  75     LPCSTR viprogid;            /* can be NULL to omit */
  76     LPCSTR progid_extra;        /* can be NULL to omit */
  77 };
  78
  79 static HRESULT register_coclasses(struct regsvr_coclass const *list);
  80 static HRESULT unregister_coclasses(struct regsvr_coclass const *list);
  81
  82 /***********************************************************************
  83  *              static string constants
  84  */
  85 static WCHAR const interface_keyname[10] = {
  86     'I', 'n', 't', 'e', 'r', 'f', 'a', 'c', 'e', 0 };
  87 static WCHAR const base_ifa_keyname[14] = {
  88     'B', 'a', 's', 'e', 'I', 'n', 't', 'e', 'r', 'f', 'a', 'c',
  89     'e', 0 };
  90 static WCHAR const num_methods_keyname[11] = {
  91     'N', 'u', 'm', 'M', 'e', 't', 'h', 'o', 'd', 's', 0 };
  92 static WCHAR const ps_clsid_keyname[15] = {
  93     'P', 'r', 'o', 'x', 'y', 'S', 't', 'u', 'b', 'C', 'l', 's',
  94     'i', 'd', 0 };
  95 static WCHAR const ps_clsid32_keyname[17] = {
  96     'P', 'r', 'o', 'x', 'y', 'S', 't', 'u', 'b', 'C', 'l', 's',
  97     'i', 'd', '3', '2', 0 };
  98 static WCHAR const clsid_keyname[6] = {
  99     'C', 'L', 'S', 'I', 'D', 0 };
 100 static WCHAR const curver_keyname[7] = {
 101     'C', 'u', 'r', 'V', 'e', 'r', 0 };
 102 static WCHAR const iph32_keyname[] = {
 103     'I', 'n', 'P', 'r', 'o', 'c', 'H', 'a', 'n', 'd', 'l', 'e', 'r',
 104     '3', '2', 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 viprogid_keyname[25] = {
 114     'V', 'e', 'r', 's', 'i', 'o', 'n', 'I', 'n', 'd', 'e', 'p',
 115     'e', 'n', 'd', 'e', 'n', 't', 'P', 'r', 'o', 'g', 'I', 'D',
 116     0 };
 117 static char const tmodel_valuename[] = "ThreadingModel";
 118
 119 /***********************************************************************
 120  *              static helper functions
 121  */
 122 static LONG register_key_guid(HKEY base, WCHAR const *name, GUID const *guid);
 123 static LONG register_key_defvalueW(HKEY base, WCHAR const *name,
 124                                    WCHAR const *value);
 125 static LONG register_key_defvalueA(HKEY base, WCHAR const *name,
 126                                    char const *value);
 127 static LONG register_progid(WCHAR const *clsid,
 128                             char const *progid, char const *curver_progid,
 129                             char const *name, char const *extra);
 130 static LONG recursive_delete_key(HKEY key);
 131 static LONG recursive_delete_keyA(HKEY base, char const *name);
 132 static LONG recursive_delete_keyW(HKEY base, WCHAR const *name);
 133
 134 /***********************************************************************
 135  *              register_interfaces
 136  */
 137 static HRESULT register_interfaces(struct regsvr_interface const *list) {
 138     LONG res = ERROR_SUCCESS;
 139     HKEY interface_key;
 140
 141     res = RegCreateKeyExW(HKEY_CLASSES_ROOT, interface_keyname, 0, NULL, 0,
 142                           KEY_READ | KEY_WRITE, NULL, &interface_key, NULL);
 143     if (res != ERROR_SUCCESS) goto error_return;
 144
 145     for (; res == ERROR_SUCCESS && list->iid; ++list) {
 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             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             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     LONG res = ERROR_SUCCESS;
 208     HKEY interface_key;
 209
 210     res = RegOpenKeyExW(HKEY_CLASSES_ROOT, interface_keyname, 0,
 211                         KEY_READ | KEY_WRITE, &interface_key);
 212     if (res == ERROR_FILE_NOT_FOUND) return S_OK;
 213     if (res != ERROR_SUCCESS) goto error_return;
 214
 215     for (; res == ERROR_SUCCESS && list->iid; ++list) {
 216         WCHAR buf[39];
 217
 218         StringFromGUID2(list->iid, buf, 39);
 219         res = recursive_delete_keyW(interface_key, buf);
 220     }
 221
 222     RegCloseKey(interface_key);
 223 error_return:
 224     return res != ERROR_SUCCESS ? HRESULT_FROM_WIN32(res) : S_OK;
 225 }
 226
 227 /***********************************************************************
 228  *              register_coclasses
 229  */
 230 static HRESULT register_coclasses(struct regsvr_coclass const *list) {
 231     LONG res = ERROR_SUCCESS;
 232     HKEY coclass_key;
 233
 234     res = RegCreateKeyExW(HKEY_CLASSES_ROOT, clsid_keyname, 0, NULL, 0,
 235                           KEY_READ | KEY_WRITE, NULL, &coclass_key, NULL);
 236     if (res != ERROR_SUCCESS) goto error_return;
 237
 238     for (; res == ERROR_SUCCESS && list->clsid; ++list) {
 239         WCHAR buf[39];
 240         HKEY clsid_key;
 241
 242         StringFromGUID2(list->clsid, buf, 39);
 243         res = RegCreateKeyExW(coclass_key, buf, 0, NULL, 0,
 244                               KEY_READ | KEY_WRITE, NULL, &clsid_key, NULL);
 245         if (res != ERROR_SUCCESS) goto error_close_coclass_key;
 246
 247         if (list->name) {
 248             res = RegSetValueExA(clsid_key, NULL, 0, REG_SZ,
 249                                  (CONST BYTE*)(list->name),
 250                                  strlen(list->name) + 1);
 251             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
 252         }
 253
 254         if (list->iph32) {
 255             HKEY iph32_key;
 256
 257             res = RegCreateKeyExW(clsid_key, iph32_keyname, 0, NULL, 0,
 258                                   KEY_READ | KEY_WRITE, NULL,
 259                                   &iph32_key, NULL);
 260             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
 261
 262             res = RegSetValueExA(iph32_key, NULL, 0, REG_SZ,
 263                                  (CONST BYTE*)list->iph32,
 264                                  lstrlenA(list->iph32) + 1);
 265             RegCloseKey(iph32_key);
 266             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
 267         }
 268
 269         if (list->ips) {
 270             res = register_key_defvalueA(clsid_key, ips_keyname, list->ips);
 271             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
 272         }
 273
 274         if (list->ips32) {
 275             HKEY ips32_key;
 276
 277             res = RegCreateKeyExW(clsid_key, ips32_keyname, 0, NULL, 0,
 278                                   KEY_READ | KEY_WRITE, NULL,
 279                                   &ips32_key, NULL);
 280             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
 281
 282             res = RegSetValueExA(ips32_key, NULL, 0, REG_SZ,
 283                                  (CONST BYTE*)list->ips32,
 284                                  lstrlenA(list->ips32) + 1);
 285             if (res == ERROR_SUCCESS && list->ips32_tmodel)
 286                 res = RegSetValueExA(ips32_key, tmodel_valuename, 0, REG_SZ,
 287                                      (CONST BYTE*)list->ips32_tmodel,
 288                                      strlen(list->ips32_tmodel) + 1);
 289             RegCloseKey(ips32_key);
 290             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
 291         }
 292
 293         if (list->progid) {
 294             res = register_key_defvalueA(clsid_key, progid_keyname,
 295                                          list->progid);
 296             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
 297
 298             res = register_progid(buf, list->progid, NULL,
 299                                   list->name, list->progid_extra);
 300             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
 301         }
 302
 303         if (list->viprogid) {
 304             res = register_key_defvalueA(clsid_key, viprogid_keyname,
 305                                          list->viprogid);
 306             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
 307
 308             res = register_progid(buf, list->viprogid, list->progid,
 309                                   list->name, list->progid_extra);
 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     LONG res = ERROR_SUCCESS;
 328     HKEY coclass_key;
 329
 330     res = RegOpenKeyExW(HKEY_CLASSES_ROOT, clsid_keyname, 0,
 331                         KEY_READ | KEY_WRITE, &coclass_key);
 332     if (res == ERROR_FILE_NOT_FOUND) return S_OK;
 333     if (res != ERROR_SUCCESS) goto error_return;
 334
 335     for (; res == ERROR_SUCCESS && list->clsid; ++list) {
 336         WCHAR buf[39];
 337
 338         StringFromGUID2(list->clsid, buf, 39);
 339         res = recursive_delete_keyW(coclass_key, buf);
 340         if (res != ERROR_SUCCESS) goto error_close_coclass_key;
 341
 342         if (list->progid) {
 343             res = recursive_delete_keyA(HKEY_CLASSES_ROOT, list->progid);
 344             if (res != ERROR_SUCCESS) goto error_close_coclass_key;
 345         }
 346
 347         if (list->viprogid) {
 348             res = recursive_delete_keyA(HKEY_CLASSES_ROOT, list->viprogid);
 349             if (res != ERROR_SUCCESS) goto error_close_coclass_key;
 350         }
 351     }
 352
 353 error_close_coclass_key:
 354     RegCloseKey(coclass_key);
 355 error_return:
 356     return res != ERROR_SUCCESS ? HRESULT_FROM_WIN32(res) : S_OK;
 357 }
 358
 359 /***********************************************************************
 360  *              regsvr_key_guid
 361  */
 362 static LONG register_key_guid(HKEY base, WCHAR const *name, GUID const *guid) {
 363     WCHAR buf[39];
 364
 365     StringFromGUID2(guid, buf, 39);
 366     return register_key_defvalueW(base, name, buf);
 367 }
 368
 369 /***********************************************************************
 370  *              regsvr_key_defvalueW
 371  */
 372 static LONG register_key_defvalueW(
 373     HKEY base,
 374     WCHAR const *name,
 375     WCHAR const *value) {
 376     LONG res;
 377     HKEY key;
 378
 379     res = RegCreateKeyExW(base, name, 0, NULL, 0,
 380                           KEY_READ | KEY_WRITE, NULL, &key, NULL);
 381     if (res != ERROR_SUCCESS) return res;
 382     res = RegSetValueExW(key, NULL, 0, REG_SZ, (CONST BYTE*)value,
 383                          (lstrlenW(value) + 1) * sizeof(WCHAR));
 384     RegCloseKey(key);
 385     return res;
 386 }
 387
 388 /***********************************************************************
 389  *              regsvr_key_defvalueA
 390  */
 391 static LONG register_key_defvalueA(
 392     HKEY base,
 393     WCHAR const *name,
 394     char const *value) {
 395     LONG res;
 396     HKEY key;
 397
 398     res = RegCreateKeyExW(base, name, 0, NULL, 0,
 399                           KEY_READ | KEY_WRITE, NULL, &key, NULL);
 400     if (res != ERROR_SUCCESS) return res;
 401     res = RegSetValueExA(key, NULL, 0, REG_SZ, (CONST BYTE*)value,
 402                          lstrlenA(value) + 1);
 403     RegCloseKey(key);
 404     return res;
 405 }
 406
 407 /***********************************************************************
 408  *              regsvr_progid
 409  */
 410 static LONG register_progid(
 411     WCHAR const *clsid,
 412     char const *progid,
 413     char const *curver_progid,
 414     char const *name,
 415     char const *extra) {
 416     LONG res;
 417     HKEY progid_key;
 418
 419     res = RegCreateKeyExA(HKEY_CLASSES_ROOT, progid, 0,
 420                           NULL, 0, KEY_READ | KEY_WRITE, NULL,
 421                           &progid_key, NULL);
 422     if (res != ERROR_SUCCESS) return res;
 423
 424     if (name) {
 425         res = RegSetValueExA(progid_key, NULL, 0, REG_SZ,
 426                              (CONST BYTE*)name, strlen(name) + 1);
 427         if (res != ERROR_SUCCESS) goto error_close_progid_key;
 428     }
 429
 430     if (clsid) {
 431         res = register_key_defvalueW(progid_key, clsid_keyname, clsid);
 432         if (res != ERROR_SUCCESS) goto error_close_progid_key;
 433     }
 434
 435     if (curver_progid) {
 436         res = register_key_defvalueA(progid_key, curver_keyname,
 437                                      curver_progid);
 438         if (res != ERROR_SUCCESS) goto error_close_progid_key;
 439     }
 440
 441     if (extra) {
 442         HKEY extra_key;
 443
 444         res = RegCreateKeyExA(progid_key, extra, 0,
 445                               NULL, 0, KEY_READ | KEY_WRITE, NULL,
 446                               &extra_key, NULL);
 447         if (res == ERROR_SUCCESS)
 448             RegCloseKey(extra_key);
 449     }
 450
 451 error_close_progid_key:
 452     RegCloseKey(progid_key);
 453     return res;
 454 }
 455
 456 /***********************************************************************
 457  *              recursive_delete_key
 458  */
 459 static LONG recursive_delete_key(HKEY key) {
 460     LONG res;
 461     WCHAR subkey_name[MAX_PATH];
 462     DWORD cName;
 463     HKEY subkey;
 464
 465     for (;;) {
 466         cName = sizeof(subkey_name) / sizeof(WCHAR);
 467         res = RegEnumKeyExW(key, 0, subkey_name, &cName,
 468                             NULL, NULL, NULL, NULL);
 469         if (res != ERROR_SUCCESS && res != ERROR_MORE_DATA) {
 470             res = ERROR_SUCCESS; /* presumably we're done enumerating */
 471             break;
 472         }
 473         res = RegOpenKeyExW(key, subkey_name, 0,
 474                             KEY_READ | KEY_WRITE, &subkey);
 475         if (res == ERROR_FILE_NOT_FOUND) continue;
 476         if (res != ERROR_SUCCESS) break;
 477
 478         res = recursive_delete_key(subkey);
 479         RegCloseKey(subkey);
 480         if (res != ERROR_SUCCESS) break;
 481     }
 482
 483     if (res == ERROR_SUCCESS) res = RegDeleteKeyW(key, 0);
 484     return res;
 485 }
 486
 487 /***********************************************************************
 488  *              recursive_delete_keyA
 489  */
 490 static LONG recursive_delete_keyA(HKEY base, char const *name) {
 491     LONG res;
 492     HKEY key;
 493
 494     res = RegOpenKeyExA(base, name, 0, KEY_READ | KEY_WRITE, &key);
 495     if (res == ERROR_FILE_NOT_FOUND) return ERROR_SUCCESS;
 496     if (res != ERROR_SUCCESS) return res;
 497     res = recursive_delete_key(key);
 498     RegCloseKey(key);
 499     return res;
 500 }
 501
 502 /***********************************************************************
 503  *              recursive_delete_keyW
 504  */
 505 static LONG recursive_delete_keyW(HKEY base, WCHAR const *name) {
 506     LONG res;
 507     HKEY key;
 508
 509     res = RegOpenKeyExW(base, name, 0, KEY_READ | KEY_WRITE, &key);
 510     if (res == ERROR_FILE_NOT_FOUND) return ERROR_SUCCESS;
 511     if (res != ERROR_SUCCESS) return res;
 512     res = recursive_delete_key(key);
 513     RegCloseKey(key);
 514     return res;
 515 }
 516
 517 /***********************************************************************
 518  *              coclass list
 519  */
 520 static struct regsvr_coclass const coclass_list[] = {
 521     {
 522         &CLSID_DsObjectPicker,
 523         "DsObjectPicker",
 524         NULL,
 525         NULL,
 526         "objsel.dll",
 527         "Both",
 528         NULL,
 529         NULL
 530     },
 531     { NULL }                    /* list terminator */
 532 };
 533
 534 /***********************************************************************
 535  *              interface list
 536  */
 537 static struct regsvr_interface const interface_list[] = {
 538     { NULL }                    /* list terminator */
 539 };
 540
 541 /***********************************************************************
 542  *              DllRegisterServer
 543  */
 544 HRESULT WINAPI DllRegisterServer(void) {
 545     HRESULT hr;
 546
 547     TRACE("\n");
 548
 549     hr = register_coclasses(coclass_list);
 550     if (SUCCEEDED(hr))
 551         hr = register_interfaces(interface_list);
 552     return hr;
 553 }
 554
 555 /***********************************************************************
 556  *              DllUnregisterServer
 557  */
 558 HRESULT WINAPI DllUnregisterServer(void) {
 559     HRESULT hr;
 560
 561     TRACE("\n");
 562
 563     hr = unregister_coclasses(coclass_list);
 564     if (SUCCEEDED(hr))
 565         hr = unregister_interfaces(interface_list);
 566     return hr;
 567 }