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