dlls/hhctrl.ocx/regsvr.c

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