dlls/urlmon/regsvr.c

   1 /*
   2  *      self-registerable dll functions for urlmon.dll
   3  *
   4  * Copyright (C) 2003 John K. Hohm
   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 <stdio.h>
  22
  23 #include "urlmon_main.h"
  24
  25 #include "winreg.h"
  26 #include "advpub.h"
  27
  28 #include "wine/debug.h"
  29
  30 WINE_DEFAULT_DEBUG_CHANNEL(urlmon);
  31
  32 /*
  33  * Near the bottom of this file are the exported DllRegisterServer and
  34  * DllUnregisterServer, which make all this worthwhile.
  35  */
  36
  37 /***********************************************************************
  38  *              interface for self-registering
  39  */
  40 struct regsvr_interface
  41 {
  42     IID const *iid;             /* NULL for end of list */
  43     LPCSTR name;                /* can be NULL to omit */
  44     IID const *base_iid;        /* can be NULL to omit */
  45     int num_methods;            /* can be <0 to omit */
  46     CLSID const *ps_clsid;      /* can be NULL to omit */
  47     CLSID const *ps_clsid32;    /* can be NULL to omit */
  48 };
  49
  50 static HRESULT register_interfaces(struct regsvr_interface const *list);
  51 static HRESULT unregister_interfaces(struct regsvr_interface const *list);
  52
  53 struct regsvr_coclass
  54 {
  55     CLSID const *clsid;         /* NULL for end of list */
  56     LPCSTR name;                /* can be NULL to omit */
  57     LPCSTR ips;                 /* can be NULL to omit */
  58     LPCSTR ips32;               /* can be NULL to omit */
  59     LPCSTR ips32_tmodel;        /* can be NULL to omit */
  60     LPCSTR progid;              /* can be NULL to omit */
  61     LPCSTR viprogid;            /* can be NULL to omit */
  62     LPCSTR progid_extra;        /* can be NULL to omit */
  63 };
  64
  65 static HRESULT register_coclasses(struct regsvr_coclass const *list);
  66 static HRESULT unregister_coclasses(struct regsvr_coclass const *list);
  67
  68 /***********************************************************************
  69  *              static string constants
  70  */
  71 static WCHAR const interface_keyname[10] = {
  72     'I', 'n', 't', 'e', 'r', 'f', 'a', 'c', 'e', 0 };
  73 static WCHAR const base_ifa_keyname[14] = {
  74     'B', 'a', 's', 'e', 'I', 'n', 't', 'e', 'r', 'f', 'a', 'c',
  75     'e', 0 };
  76 static WCHAR const num_methods_keyname[11] = {
  77     'N', 'u', 'm', 'M', 'e', 't', 'h', 'o', 'd', 's', 0 };
  78 static WCHAR const ps_clsid_keyname[15] = {
  79     'P', 'r', 'o', 'x', 'y', 'S', 't', 'u', 'b', 'C', 'l', 's',
  80     'i', 'd', 0 };
  81 static WCHAR const ps_clsid32_keyname[17] = {
  82     'P', 'r', 'o', 'x', 'y', 'S', 't', 'u', 'b', 'C', 'l', 's',
  83     'i', 'd', '3', '2', 0 };
  84 static WCHAR const clsid_keyname[6] = {
  85     'C', 'L', 'S', 'I', 'D', 0 };
  86 static WCHAR const curver_keyname[7] = {
  87     'C', 'u', 'r', 'V', 'e', 'r', 0 };
  88 static WCHAR const ips_keyname[13] = {
  89     'I', 'n', 'P', 'r', 'o', 'c', 'S', 'e', 'r', 'v', 'e', 'r',
  90     0 };
  91 static WCHAR const ips32_keyname[15] = {
  92     'I', 'n', 'P', 'r', 'o', 'c', 'S', 'e', 'r', 'v', 'e', 'r',
  93     '3', '2', 0 };
  94 static WCHAR const progid_keyname[7] = {
  95     'P', 'r', 'o', 'g', 'I', 'D', 0 };
  96 static WCHAR const viprogid_keyname[25] = {
  97     'V', 'e', 'r', 's', 'i', 'o', 'n', 'I', 'n', 'd', 'e', 'p',
  98     'e', 'n', 'd', 'e', 'n', 't', 'P', 'r', 'o', 'g', 'I', 'D',
  99     0 };
 100 static char const tmodel_valuename[] = "ThreadingModel";
 101
 102 /***********************************************************************
 103  *              static helper functions
 104  */
 105 static LONG register_key_guid(HKEY base, WCHAR const *name, GUID const *guid);
 106 static LONG register_key_defvalueW(HKEY base, WCHAR const *name,
 107                                    WCHAR const *value);
 108 static LONG register_key_defvalueA(HKEY base, WCHAR const *name,
 109                                    char const *value);
 110 static LONG register_progid(WCHAR const *clsid,
 111                             char const *progid, char const *curver_progid,
 112                             char const *name, char const *extra);
 113
 114 /***********************************************************************
 115  *              register_interfaces
 116  */
 117 static HRESULT register_interfaces(struct regsvr_interface const *list)
 118 {
 119     LONG res = ERROR_SUCCESS;
 120     HKEY interface_key;
 121
 122     res = RegCreateKeyExW(HKEY_CLASSES_ROOT, interface_keyname, 0, NULL, 0,
 123                           KEY_READ | KEY_WRITE, NULL, &interface_key, NULL);
 124     if (res != ERROR_SUCCESS) goto error_return;
 125
 126     for (; res == ERROR_SUCCESS && list->iid; ++list) {
 127         WCHAR buf[39];
 128         HKEY iid_key;
 129
 130         StringFromGUID2(list->iid, buf, 39);
 131         res = RegCreateKeyExW(interface_key, buf, 0, NULL, 0,
 132                               KEY_READ | KEY_WRITE, NULL, &iid_key, NULL);
 133         if (res != ERROR_SUCCESS) goto error_close_interface_key;
 134
 135         if (list->name) {
 136             res = RegSetValueExA(iid_key, NULL, 0, REG_SZ,
 137                                  (CONST BYTE*)(list->name),
 138                                  strlen(list->name) + 1);
 139             if (res != ERROR_SUCCESS) goto error_close_iid_key;
 140         }
 141
 142         if (list->base_iid) {
 143             res = register_key_guid(iid_key, base_ifa_keyname, list->base_iid);
 144             if (res != ERROR_SUCCESS) goto error_close_iid_key;
 145         }
 146
 147         if (0 <= list->num_methods) {
 148             static WCHAR const fmt[3] = { '%', 'd', 0 };
 149             HKEY key;
 150
 151             res = RegCreateKeyExW(iid_key, num_methods_keyname, 0, NULL, 0,
 152                                   KEY_READ | KEY_WRITE, NULL, &key, NULL);
 153             if (res != ERROR_SUCCESS) goto error_close_iid_key;
 154
 155             wsprintfW(buf, fmt, list->num_methods);
 156             res = RegSetValueExW(key, NULL, 0, REG_SZ,
 157                                  (CONST BYTE*)buf,
 158                                  (lstrlenW(buf) + 1) * sizeof(WCHAR));
 159             RegCloseKey(key);
 160
 161             if (res != ERROR_SUCCESS) goto error_close_iid_key;
 162         }
 163
 164         if (list->ps_clsid) {
 165             res = register_key_guid(iid_key, ps_clsid_keyname, list->ps_clsid);
 166             if (res != ERROR_SUCCESS) goto error_close_iid_key;
 167         }
 168
 169         if (list->ps_clsid32) {
 170             res = register_key_guid(iid_key, ps_clsid32_keyname, list->ps_clsid32);
 171             if (res != ERROR_SUCCESS) goto error_close_iid_key;
 172         }
 173
 174     error_close_iid_key:
 175         RegCloseKey(iid_key);
 176     }
 177
 178 error_close_interface_key:
 179     RegCloseKey(interface_key);
 180 error_return:
 181     return res != ERROR_SUCCESS ? HRESULT_FROM_WIN32(res) : S_OK;
 182 }
 183
 184 /***********************************************************************
 185  *              unregister_interfaces
 186  */
 187 static HRESULT unregister_interfaces(struct regsvr_interface const *list)
 188 {
 189     LONG res = ERROR_SUCCESS;
 190     HKEY interface_key;
 191
 192     res = RegOpenKeyExW(HKEY_CLASSES_ROOT, interface_keyname, 0,
 193                         KEY_READ | KEY_WRITE, &interface_key);
 194     if (res == ERROR_FILE_NOT_FOUND) return S_OK;
 195     if (res != ERROR_SUCCESS) goto error_return;
 196
 197     for (; res == ERROR_SUCCESS && list->iid; ++list) {
 198         WCHAR buf[39];
 199
 200         StringFromGUID2(list->iid, buf, 39);
 201         res = RegDeleteTreeW(interface_key, buf);
 202         if (res == ERROR_FILE_NOT_FOUND) res = ERROR_SUCCESS;
 203     }
 204
 205     RegCloseKey(interface_key);
 206 error_return:
 207     return res != ERROR_SUCCESS ? HRESULT_FROM_WIN32(res) : S_OK;
 208 }
 209
 210 /***********************************************************************
 211  *              register_coclasses
 212  */
 213 static HRESULT register_coclasses(struct regsvr_coclass const *list)
 214 {
 215     LONG res = ERROR_SUCCESS;
 216     HKEY coclass_key;
 217
 218     res = RegCreateKeyExW(HKEY_CLASSES_ROOT, clsid_keyname, 0, NULL, 0,
 219                           KEY_READ | KEY_WRITE, NULL, &coclass_key, NULL);
 220     if (res != ERROR_SUCCESS) goto error_return;
 221
 222     for (; res == ERROR_SUCCESS && list->clsid; ++list) {
 223         WCHAR buf[39];
 224         HKEY clsid_key;
 225
 226         StringFromGUID2(list->clsid, buf, 39);
 227         res = RegCreateKeyExW(coclass_key, buf, 0, NULL, 0,
 228                               KEY_READ | KEY_WRITE, NULL, &clsid_key, NULL);
 229         if (res != ERROR_SUCCESS) goto error_close_coclass_key;
 230
 231         if (list->name) {
 232             res = RegSetValueExA(clsid_key, NULL, 0, REG_SZ,
 233                                  (CONST BYTE*)(list->name),
 234                                  strlen(list->name) + 1);
 235             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
 236         }
 237
 238         if (list->ips) {
 239             res = register_key_defvalueA(clsid_key, ips_keyname, list->ips);
 240             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
 241         }
 242
 243         if (list->ips32) {
 244             HKEY ips32_key;
 245
 246             res = RegCreateKeyExW(clsid_key, ips32_keyname, 0, NULL, 0,
 247                                   KEY_READ | KEY_WRITE, NULL,
 248                                   &ips32_key, NULL);
 249             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
 250
 251             res = RegSetValueExA(ips32_key, NULL, 0, REG_SZ,
 252                                  (CONST BYTE*)list->ips32,
 253                                  lstrlenA(list->ips32) + 1);
 254             if (res == ERROR_SUCCESS && list->ips32_tmodel)
 255                 res = RegSetValueExA(ips32_key, tmodel_valuename, 0, REG_SZ,
 256                                      (CONST BYTE*)list->ips32_tmodel,
 257                                      strlen(list->ips32_tmodel) + 1);
 258             RegCloseKey(ips32_key);
 259             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
 260         }
 261
 262         if (list->progid) {
 263             res = register_key_defvalueA(clsid_key, progid_keyname,
 264                                          list->progid);
 265             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
 266
 267             res = register_progid(buf, list->progid, NULL,
 268                                   list->name, list->progid_extra);
 269             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
 270         }
 271
 272         if (list->viprogid) {
 273             res = register_key_defvalueA(clsid_key, viprogid_keyname,
 274                                          list->viprogid);
 275             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
 276
 277             res = register_progid(buf, list->viprogid, list->progid,
 278                                   list->name, list->progid_extra);
 279             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
 280         }
 281
 282     error_close_clsid_key:
 283         RegCloseKey(clsid_key);
 284     }
 285
 286 error_close_coclass_key:
 287     RegCloseKey(coclass_key);
 288 error_return:
 289     return res != ERROR_SUCCESS ? HRESULT_FROM_WIN32(res) : S_OK;
 290 }
 291
 292 /***********************************************************************
 293  *              unregister_coclasses
 294  */
 295 static HRESULT unregister_coclasses(struct regsvr_coclass const *list)
 296 {
 297     LONG res = ERROR_SUCCESS;
 298     HKEY coclass_key;
 299
 300     res = RegOpenKeyExW(HKEY_CLASSES_ROOT, clsid_keyname, 0,
 301                         KEY_READ | KEY_WRITE, &coclass_key);
 302     if (res == ERROR_FILE_NOT_FOUND) return S_OK;
 303     if (res != ERROR_SUCCESS) goto error_return;
 304
 305     for (; res == ERROR_SUCCESS && list->clsid; ++list) {
 306         WCHAR buf[39];
 307
 308         StringFromGUID2(list->clsid, buf, 39);
 309         res = RegDeleteTreeW(coclass_key, buf);
 310         if (res == ERROR_FILE_NOT_FOUND) res = ERROR_SUCCESS;
 311         if (res != ERROR_SUCCESS) goto error_close_coclass_key;
 312
 313         if (list->progid) {
 314             res = RegDeleteTreeA(HKEY_CLASSES_ROOT, list->progid);
 315             if (res == ERROR_FILE_NOT_FOUND) res = ERROR_SUCCESS;
 316             if (res != ERROR_SUCCESS) goto error_close_coclass_key;
 317         }
 318
 319         if (list->viprogid) {
 320             res = RegDeleteTreeA(HKEY_CLASSES_ROOT, list->viprogid);
 321             if (res == ERROR_FILE_NOT_FOUND) res = ERROR_SUCCESS;
 322             if (res != ERROR_SUCCESS) goto error_close_coclass_key;
 323         }
 324     }
 325
 326 error_close_coclass_key:
 327     RegCloseKey(coclass_key);
 328 error_return:
 329     return res != ERROR_SUCCESS ? HRESULT_FROM_WIN32(res) : S_OK;
 330 }
 331
 332 /***********************************************************************
 333  *              regsvr_key_guid
 334  */
 335 static LONG register_key_guid(HKEY base, WCHAR const *name, GUID const *guid)
 336 {
 337     WCHAR buf[39];
 338
 339     StringFromGUID2(guid, buf, 39);
 340     return register_key_defvalueW(base, name, buf);
 341 }
 342
 343 /***********************************************************************
 344  *              regsvr_key_defvalueW
 345  */
 346 static LONG register_key_defvalueW(
 347     HKEY base,
 348     WCHAR const *name,
 349     WCHAR const *value)
 350 {
 351     LONG res;
 352     HKEY key;
 353
 354     res = RegCreateKeyExW(base, name, 0, NULL, 0,
 355                           KEY_READ | KEY_WRITE, NULL, &key, NULL);
 356     if (res != ERROR_SUCCESS) return res;
 357     res = RegSetValueExW(key, NULL, 0, REG_SZ, (CONST BYTE*)value,
 358                          (lstrlenW(value) + 1) * sizeof(WCHAR));
 359     RegCloseKey(key);
 360     return res;
 361 }
 362
 363 /***********************************************************************
 364  *              regsvr_key_defvalueA
 365  */
 366 static LONG register_key_defvalueA(
 367     HKEY base,
 368     WCHAR const *name,
 369     char const *value)
 370 {
 371     LONG res;
 372     HKEY key;
 373
 374     res = RegCreateKeyExW(base, name, 0, NULL, 0,
 375                           KEY_READ | KEY_WRITE, NULL, &key, NULL);
 376     if (res != ERROR_SUCCESS) return res;
 377     res = RegSetValueExA(key, NULL, 0, REG_SZ, (CONST BYTE*)value,
 378                          lstrlenA(value) + 1);
 379     RegCloseKey(key);
 380     return res;
 381 }
 382
 383 /***********************************************************************
 384  *              regsvr_progid
 385  */
 386 static LONG register_progid(
 387     WCHAR const *clsid,
 388     char const *progid,
 389     char const *curver_progid,
 390     char const *name,
 391     char const *extra)
 392 {
 393     LONG res;
 394     HKEY progid_key;
 395
 396     res = RegCreateKeyExA(HKEY_CLASSES_ROOT, progid, 0,
 397                           NULL, 0, KEY_READ | KEY_WRITE, NULL,
 398                           &progid_key, NULL);
 399     if (res != ERROR_SUCCESS) return res;
 400
 401     if (name) {
 402         res = RegSetValueExA(progid_key, NULL, 0, REG_SZ,
 403                              (CONST BYTE*)name, strlen(name) + 1);
 404         if (res != ERROR_SUCCESS) goto error_close_progid_key;
 405     }
 406
 407     if (clsid) {
 408         res = register_key_defvalueW(progid_key, clsid_keyname, clsid);
 409         if (res != ERROR_SUCCESS) goto error_close_progid_key;
 410     }
 411
 412     if (curver_progid) {
 413         res = register_key_defvalueA(progid_key, curver_keyname,
 414                                      curver_progid);
 415         if (res != ERROR_SUCCESS) goto error_close_progid_key;
 416     }
 417
 418     if (extra) {
 419         HKEY extra_key;
 420
 421         res = RegCreateKeyExA(progid_key, extra, 0,
 422                               NULL, 0, KEY_READ | KEY_WRITE, NULL,
 423                               &extra_key, NULL);
 424         if (res == ERROR_SUCCESS)
 425             RegCloseKey(extra_key);
 426     }
 427
 428 error_close_progid_key:
 429     RegCloseKey(progid_key);
 430     return res;
 431 }
 432
 433 /***********************************************************************
 434  *              coclass list
 435  */
 436 static struct regsvr_coclass const coclass_list[] = {
 437     {   &CLSID_StdURLMoniker,
 438         "URL Moniker",
 439         NULL,
 440         "urlmon.dll",
 441         "Apartment"
 442     },
 443     {   &CLSID_CdlProtocol,
 444         "CDL: Asynchronous Pluggable Protocol Handler",
 445         NULL,
 446         "urlmon.dll",
 447         "Apartment"
 448     },
 449     {   &CLSID_FileProtocol,
 450         "file:, local: Asynchronous Pluggable Protocol Handler",
 451         NULL,
 452         "urlmon.dll",
 453         "Apartment"
 454     },
 455     {   &CLSID_FtpProtocol,
 456         "ftp: Asynchronous Pluggable Protocol Handler",
 457         NULL,
 458         "urlmon.dll",
 459         "Apartment"
 460     },
 461     {   &CLSID_GopherProtocol,
 462         "gopher: Asynchronous Pluggable Protocol Handler",
 463         NULL,
 464         "urlmon.dll",
 465         "Apartment"
 466     },
 467     {   &CLSID_HttpProtocol,
 468         "http: Asynchronous Pluggable Protocol Handler",
 469         NULL,
 470         "urlmon.dll",
 471         "Apartment"
 472     },
 473     {   &CLSID_HttpSProtocol,
 474         "https: Asynchronous Pluggable Protocol Handler",
 475         NULL,
 476         "urlmon.dll",
 477         "Apartment"
 478     },
 479     {   &CLSID_MkProtocol,
 480         "mk: Asynchronous Pluggable Protocol Handler",
 481         NULL,
 482         "urlmon.dll",
 483         "Apartment"
 484     },
 485     {   &CLSID_InternetSecurityManager,
 486         "Security Manager",
 487         NULL,
 488         "urlmon.dll",
 489         "Both"
 490     },
 491     {   &CLSID_InternetZoneManager,
 492         "URL Zone Manager",
 493         NULL,
 494         "urlmon.dll",
 495         "Both"
 496     },
 497     { NULL }                    /* list terminator */
 498 };
 499
 500 /***********************************************************************
 501  *              interface list
 502  */
 503
 504 static struct regsvr_interface const interface_list[] = {
 505     { NULL }                    /* list terminator */
 506 };
 507
 508 /***********************************************************************
 509  *              register_inf
 510  */
 511
 512 #define INF_SET_CLSID(clsid)                  \
 513     do                                        \
 514     {                                         \
 515         static CHAR name[] = "CLSID_" #clsid; \
 516                                               \
 517         pse[i].pszName = name;                \
 518         clsids[i++] = &CLSID_ ## clsid;       \
 519     } while (0)
 520
 521 static HRESULT register_inf(BOOL doregister)
 522 {
 523     HRESULT hres;
 524     HMODULE hAdvpack;
 525     HRESULT (WINAPI *pRegInstall)(HMODULE hm, LPCSTR pszSection, const STRTABLEA* pstTable);
 526     STRTABLEA strtable;
 527     STRENTRYA pse[7];
 528     static CLSID const *clsids[34];
 529     int i = 0;
 530
 531     static const WCHAR wszAdvpack[] = {'a','d','v','p','a','c','k','.','d','l','l',0};
 532
 533     INF_SET_CLSID(CdlProtocol);
 534     INF_SET_CLSID(FileProtocol);
 535     INF_SET_CLSID(FtpProtocol);
 536     INF_SET_CLSID(GopherProtocol);
 537     INF_SET_CLSID(HttpProtocol);
 538     INF_SET_CLSID(HttpSProtocol);
 539     INF_SET_CLSID(MkProtocol);
 540
 541     for(i = 0; i < sizeof(pse)/sizeof(pse[0]); i++) {
 542         pse[i].pszValue = heap_alloc(39);
 543         sprintf(pse[i].pszValue, "{%08X-%04X-%04X-%02X%02X-%02X%02X%02X%02X%02X%02X}",
 544                 clsids[i]->Data1, clsids[i]->Data2, clsids[i]->Data3, clsids[i]->Data4[0],
 545                 clsids[i]->Data4[1], clsids[i]->Data4[2], clsids[i]->Data4[3], clsids[i]->Data4[4],
 546                 clsids[i]->Data4[5], clsids[i]->Data4[6], clsids[i]->Data4[7]);
 547     }
 548
 549     strtable.cEntries = sizeof(pse)/sizeof(pse[0]);
 550     strtable.pse = pse;
 551
 552     hAdvpack = LoadLibraryW(wszAdvpack);
 553     pRegInstall = (void *)GetProcAddress(hAdvpack, "RegInstall");
 554
 555     hres = pRegInstall(URLMON_hInstance, doregister ? "RegisterDll" : "UnregisterDll", &strtable);
 556
 557     for(i=0; i < sizeof(pse)/sizeof(pse[0]); i++)
 558         heap_free(pse[i].pszValue);
 559
 560     return hres;
 561 }
 562
 563 #undef INF_SET_CLSID
 564
 565 /***********************************************************************
 566  *              DllRegisterServer (URLMON.@)
 567  */
 568 HRESULT WINAPI DllRegisterServer(void)
 569 {
 570     HRESULT hr;
 571
 572     TRACE("\n");
 573
 574     hr = register_coclasses(coclass_list);
 575     if (SUCCEEDED(hr))
 576         hr = register_interfaces(interface_list);
 577     if(FAILED(hr))
 578         return hr;
 579     return register_inf(TRUE);
 580 }
 581
 582 /***********************************************************************
 583  *              DllUnregisterServer (URLMON.@)
 584  */
 585 HRESULT WINAPI DllUnregisterServer(void)
 586 {
 587     HRESULT hr;
 588
 589     TRACE("\n");
 590
 591     hr = unregister_coclasses(coclass_list);
 592     if (SUCCEEDED(hr))
 593         hr = unregister_interfaces(interface_list);
 594     if(FAILED(hr))
 595         return hr;
 596     return register_inf(FALSE);
 597 }