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
 131 /***********************************************************************
 132  *              register_interfaces
 133  */
 134 static HRESULT register_interfaces(struct regsvr_interface const *list) {
 135     LONG res = ERROR_SUCCESS;
 136     HKEY interface_key;
 137
 138     res = RegCreateKeyExW(HKEY_CLASSES_ROOT, interface_keyname, 0, NULL, 0,
 139                           KEY_READ | KEY_WRITE, NULL, &interface_key, NULL);
 140     if (res != ERROR_SUCCESS) goto error_return;
 141
 142     for (; res == ERROR_SUCCESS && list->iid; ++list) {
 143         WCHAR buf[39];
 144         HKEY iid_key;
 145
 146         StringFromGUID2(list->iid, buf, 39);
 147         res = RegCreateKeyExW(interface_key, buf, 0, NULL, 0,
 148                               KEY_READ | KEY_WRITE, NULL, &iid_key, NULL);
 149         if (res != ERROR_SUCCESS) goto error_close_interface_key;
 150
 151         if (list->name) {
 152             res = RegSetValueExA(iid_key, NULL, 0, REG_SZ,
 153                                  (CONST BYTE*)(list->name),
 154                                  strlen(list->name) + 1);
 155             if (res != ERROR_SUCCESS) goto error_close_iid_key;
 156         }
 157
 158         if (list->base_iid) {
 159             res = register_key_guid(iid_key, base_ifa_keyname, list->base_iid);
 160             if (res != ERROR_SUCCESS) goto error_close_iid_key;
 161         }
 162
 163         if (0 <= list->num_methods) {
 164             static WCHAR const fmt[3] = { '%', 'd', 0 };
 165             HKEY key;
 166
 167             res = RegCreateKeyExW(iid_key, num_methods_keyname, 0, NULL, 0,
 168                                   KEY_READ | KEY_WRITE, NULL, &key, NULL);
 169             if (res != ERROR_SUCCESS) goto error_close_iid_key;
 170
 171             wsprintfW(buf, fmt, list->num_methods);
 172             res = RegSetValueExW(key, NULL, 0, REG_SZ,
 173                                  (CONST BYTE*)buf,
 174                                  (lstrlenW(buf) + 1) * sizeof(WCHAR));
 175             RegCloseKey(key);
 176
 177             if (res != ERROR_SUCCESS) goto error_close_iid_key;
 178         }
 179
 180         if (list->ps_clsid) {
 181             res = register_key_guid(iid_key, ps_clsid_keyname, list->ps_clsid);
 182             if (res != ERROR_SUCCESS) goto error_close_iid_key;
 183         }
 184
 185         if (list->ps_clsid32) {
 186             res = register_key_guid(iid_key, ps_clsid32_keyname, list->ps_clsid32);
 187             if (res != ERROR_SUCCESS) goto error_close_iid_key;
 188         }
 189
 190     error_close_iid_key:
 191         RegCloseKey(iid_key);
 192     }
 193
 194 error_close_interface_key:
 195     RegCloseKey(interface_key);
 196 error_return:
 197     return res != ERROR_SUCCESS ? HRESULT_FROM_WIN32(res) : S_OK;
 198 }
 199
 200 /***********************************************************************
 201  *              unregister_interfaces
 202  */
 203 static HRESULT unregister_interfaces(struct regsvr_interface const *list) {
 204     LONG res = ERROR_SUCCESS;
 205     HKEY interface_key;
 206
 207     res = RegOpenKeyExW(HKEY_CLASSES_ROOT, interface_keyname, 0,
 208                         KEY_READ | KEY_WRITE, &interface_key);
 209     if (res == ERROR_FILE_NOT_FOUND) return S_OK;
 210     if (res != ERROR_SUCCESS) goto error_return;
 211
 212     for (; res == ERROR_SUCCESS && list->iid; ++list) {
 213         WCHAR buf[39];
 214
 215         StringFromGUID2(list->iid, buf, 39);
 216         res = RegDeleteTreeW(interface_key, buf);
 217         if (res == ERROR_FILE_NOT_FOUND) res = ERROR_SUCCESS;
 218     }
 219
 220     RegCloseKey(interface_key);
 221 error_return:
 222     return res != ERROR_SUCCESS ? HRESULT_FROM_WIN32(res) : S_OK;
 223 }
 224
 225 /***********************************************************************
 226  *              register_coclasses
 227  */
 228 static HRESULT register_coclasses(struct regsvr_coclass const *list) {
 229     LONG res = ERROR_SUCCESS;
 230     HKEY coclass_key;
 231
 232     res = RegCreateKeyExW(HKEY_CLASSES_ROOT, clsid_keyname, 0, NULL, 0,
 233                           KEY_READ | KEY_WRITE, NULL, &coclass_key, NULL);
 234     if (res != ERROR_SUCCESS) goto error_return;
 235
 236     for (; res == ERROR_SUCCESS && list->clsid; ++list) {
 237         WCHAR buf[39];
 238         HKEY clsid_key;
 239
 240         StringFromGUID2(list->clsid, buf, 39);
 241         res = RegCreateKeyExW(coclass_key, buf, 0, NULL, 0,
 242                               KEY_READ | KEY_WRITE, NULL, &clsid_key, NULL);
 243         if (res != ERROR_SUCCESS) goto error_close_coclass_key;
 244
 245         if (list->name) {
 246             res = RegSetValueExA(clsid_key, NULL, 0, REG_SZ,
 247                                  (CONST BYTE*)(list->name),
 248                                  strlen(list->name) + 1);
 249             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
 250         }
 251
 252         if (list->iph32) {
 253             HKEY iph32_key;
 254
 255             res = RegCreateKeyExW(clsid_key, iph32_keyname, 0, NULL, 0,
 256                                   KEY_READ | KEY_WRITE, NULL,
 257                                   &iph32_key, NULL);
 258             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
 259
 260             res = RegSetValueExA(iph32_key, NULL, 0, REG_SZ,
 261                                  (CONST BYTE*)list->iph32,
 262                                  lstrlenA(list->iph32) + 1);
 263             RegCloseKey(iph32_key);
 264             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
 265         }
 266
 267         if (list->ips) {
 268             res = register_key_defvalueA(clsid_key, ips_keyname, list->ips);
 269             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
 270         }
 271
 272         if (list->ips32) {
 273             HKEY ips32_key;
 274
 275             res = RegCreateKeyExW(clsid_key, ips32_keyname, 0, NULL, 0,
 276                                   KEY_READ | KEY_WRITE, NULL,
 277                                   &ips32_key, NULL);
 278             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
 279
 280             res = RegSetValueExA(ips32_key, NULL, 0, REG_SZ,
 281                                  (CONST BYTE*)list->ips32,
 282                                  lstrlenA(list->ips32) + 1);
 283             if (res == ERROR_SUCCESS && list->ips32_tmodel)
 284                 res = RegSetValueExA(ips32_key, tmodel_valuename, 0, REG_SZ,
 285                                      (CONST BYTE*)list->ips32_tmodel,
 286                                      strlen(list->ips32_tmodel) + 1);
 287             RegCloseKey(ips32_key);
 288             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
 289         }
 290
 291         if (list->progid) {
 292             res = register_key_defvalueA(clsid_key, progid_keyname,
 293                                          list->progid);
 294             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
 295
 296             res = register_progid(buf, list->progid, NULL,
 297                                   list->name, list->progid_extra);
 298             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
 299         }
 300
 301         if (list->viprogid) {
 302             res = register_key_defvalueA(clsid_key, viprogid_keyname,
 303                                          list->viprogid);
 304             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
 305
 306             res = register_progid(buf, list->viprogid, list->progid,
 307                                   list->name, list->progid_extra);
 308             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
 309         }
 310
 311     error_close_clsid_key:
 312         RegCloseKey(clsid_key);
 313     }
 314
 315 error_close_coclass_key:
 316     RegCloseKey(coclass_key);
 317 error_return:
 318     return res != ERROR_SUCCESS ? HRESULT_FROM_WIN32(res) : S_OK;
 319 }
 320
 321 /***********************************************************************
 322  *              unregister_coclasses
 323  */
 324 static HRESULT unregister_coclasses(struct regsvr_coclass const *list) {
 325     LONG res = ERROR_SUCCESS;
 326     HKEY coclass_key;
 327
 328     res = RegOpenKeyExW(HKEY_CLASSES_ROOT, clsid_keyname, 0,
 329                         KEY_READ | KEY_WRITE, &coclass_key);
 330     if (res == ERROR_FILE_NOT_FOUND) return S_OK;
 331     if (res != ERROR_SUCCESS) goto error_return;
 332
 333     for (; res == ERROR_SUCCESS && list->clsid; ++list) {
 334         WCHAR buf[39];
 335
 336         StringFromGUID2(list->clsid, buf, 39);
 337         res = RegDeleteTreeW(coclass_key, buf);
 338         if (res == ERROR_FILE_NOT_FOUND) res = ERROR_SUCCESS;
 339         if (res != ERROR_SUCCESS) goto error_close_coclass_key;
 340
 341         if (list->progid) {
 342             res = RegDeleteTreeA(HKEY_CLASSES_ROOT, list->progid);
 343             if (res == ERROR_FILE_NOT_FOUND) res = ERROR_SUCCESS;
 344             if (res != ERROR_SUCCESS) goto error_close_coclass_key;
 345         }
 346
 347         if (list->viprogid) {
 348             res = RegDeleteTreeA(HKEY_CLASSES_ROOT, list->viprogid);
 349             if (res == ERROR_FILE_NOT_FOUND) res = ERROR_SUCCESS;
 350             if (res != ERROR_SUCCESS) goto error_close_coclass_key;
 351         }
 352     }
 353
 354 error_close_coclass_key:
 355     RegCloseKey(coclass_key);
 356 error_return:
 357     return res != ERROR_SUCCESS ? HRESULT_FROM_WIN32(res) : S_OK;
 358 }
 359
 360 /***********************************************************************
 361  *              regsvr_key_guid
 362  */
 363 static LONG register_key_guid(HKEY base, WCHAR const *name, GUID const *guid) {
 364     WCHAR buf[39];
 365
 366     StringFromGUID2(guid, buf, 39);
 367     return register_key_defvalueW(base, name, buf);
 368 }
 369
 370 /***********************************************************************
 371  *              regsvr_key_defvalueW
 372  */
 373 static LONG register_key_defvalueW(
 374     HKEY base,
 375     WCHAR const *name,
 376     WCHAR const *value) {
 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 = RegSetValueExW(key, NULL, 0, REG_SZ, (CONST BYTE*)value,
 384                          (lstrlenW(value) + 1) * sizeof(WCHAR));
 385     RegCloseKey(key);
 386     return res;
 387 }
 388
 389 /***********************************************************************
 390  *              regsvr_key_defvalueA
 391  */
 392 static LONG register_key_defvalueA(
 393     HKEY base,
 394     WCHAR const *name,
 395     char const *value) {
 396     LONG res;
 397     HKEY key;
 398
 399     res = RegCreateKeyExW(base, name, 0, NULL, 0,
 400                           KEY_READ | KEY_WRITE, NULL, &key, NULL);
 401     if (res != ERROR_SUCCESS) return res;
 402     res = RegSetValueExA(key, NULL, 0, REG_SZ, (CONST BYTE*)value,
 403                          lstrlenA(value) + 1);
 404     RegCloseKey(key);
 405     return res;
 406 }
 407
 408 /***********************************************************************
 409  *              regsvr_progid
 410  */
 411 static LONG register_progid(
 412     WCHAR const *clsid,
 413     char const *progid,
 414     char const *curver_progid,
 415     char const *name,
 416     char const *extra) {
 417     LONG res;
 418     HKEY progid_key;
 419
 420     res = RegCreateKeyExA(HKEY_CLASSES_ROOT, progid, 0,
 421                           NULL, 0, KEY_READ | KEY_WRITE, NULL,
 422                           &progid_key, NULL);
 423     if (res != ERROR_SUCCESS) return res;
 424
 425     if (name) {
 426         res = RegSetValueExA(progid_key, NULL, 0, REG_SZ,
 427                              (CONST BYTE*)name, strlen(name) + 1);
 428         if (res != ERROR_SUCCESS) goto error_close_progid_key;
 429     }
 430
 431     if (clsid) {
 432         res = register_key_defvalueW(progid_key, clsid_keyname, clsid);
 433         if (res != ERROR_SUCCESS) goto error_close_progid_key;
 434     }
 435
 436     if (curver_progid) {
 437         res = register_key_defvalueA(progid_key, curver_keyname,
 438                                      curver_progid);
 439         if (res != ERROR_SUCCESS) goto error_close_progid_key;
 440     }
 441
 442     if (extra) {
 443         HKEY extra_key;
 444
 445         res = RegCreateKeyExA(progid_key, extra, 0,
 446                               NULL, 0, KEY_READ | KEY_WRITE, NULL,
 447                               &extra_key, NULL);
 448         if (res == ERROR_SUCCESS)
 449             RegCloseKey(extra_key);
 450     }
 451
 452 error_close_progid_key:
 453     RegCloseKey(progid_key);
 454     return res;
 455 }
 456
 457 /***********************************************************************
 458  *              coclass list
 459  */
 460 static struct regsvr_coclass const coclass_list[] = {
 461     {
 462         &CLSID_DsObjectPicker,
 463         "DsObjectPicker",
 464         NULL,
 465         NULL,
 466         "objsel.dll",
 467         "Both",
 468         NULL,
 469         NULL
 470     },
 471     { NULL }                    /* list terminator */
 472 };
 473
 474 /***********************************************************************
 475  *              interface list
 476  */
 477 static struct regsvr_interface const interface_list[] = {
 478     { NULL }                    /* list terminator */
 479 };
 480
 481 /***********************************************************************
 482  *              DllRegisterServer
 483  */
 484 HRESULT WINAPI DllRegisterServer(void) {
 485     HRESULT hr;
 486
 487     TRACE("\n");
 488
 489     hr = register_coclasses(coclass_list);
 490     if (SUCCEEDED(hr))
 491         hr = register_interfaces(interface_list);
 492     return hr;
 493 }
 494
 495 /***********************************************************************
 496  *              DllUnregisterServer
 497  */
 498 HRESULT WINAPI DllUnregisterServer(void) {
 499     HRESULT hr;
 500
 501     TRACE("\n");
 502
 503     hr = unregister_coclasses(coclass_list);
 504     if (SUCCEEDED(hr))
 505         hr = unregister_interfaces(interface_list);
 506     return hr;
 507 }