dlls/ole32/bindctx.c

   1 /*
   2  *                            BindCtx implementation
   3  *
   4  *  Copyright 1999  Noomen Hamza
   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 #define COBJMACROS
  25
  26 #include "winerror.h"
  27 #include "windef.h"
  28 #include "winbase.h"
  29 #include "winnls.h"
  30 #include "objbase.h"
  31
  32 #include "wine/debug.h"
  33
  34 WINE_DEFAULT_DEBUG_CHANNEL(ole);
  35
  36 #define  BINDCTX_FIRST_TABLE_SIZE 4
  37
  38 /* data structure of the BindCtx table elements */
  39 typedef struct BindCtxObject{
  40
  41     IUnknown*   pObj; /* point on a bound object */
  42
  43     LPOLESTR  pkeyObj; /* key associated to this bound object */
  44
  45     BYTE regType; /* registration type: 1 if RegisterObjectParam and 0 if RegisterObjectBound */
  46
  47 } BindCtxObject;
  48
  49 /* BindCtx data structure */
  50 typedef struct BindCtxImpl{
  51
  52     IBindCtx IBindCtx_iface;
  53
  54     LONG ref; /* reference counter for this object */
  55
  56     BindCtxObject* bindCtxTable; /* this is a table in which all bounded objects are stored*/
  57     DWORD          bindCtxTableLastIndex;  /* first free index in the table */
  58     DWORD          bindCtxTableSize;   /* size table */
  59
  60     BIND_OPTS3 options;
  61
  62 } BindCtxImpl;
  63
  64 /* IBindCtx prototype functions : */
  65 static HRESULT WINAPI BindCtxImpl_ReleaseBoundObjects(IBindCtx*);
  66 static HRESULT BindCtxImpl_GetObjectIndex(BindCtxImpl*, IUnknown*, LPOLESTR, DWORD *);
  67 static HRESULT BindCtxImpl_ExpandTable(BindCtxImpl *);
  68
  69 static inline BindCtxImpl *impl_from_IBindCtx(IBindCtx *iface)
  70 {
  71 return CONTAINING_RECORD(iface, BindCtxImpl, IBindCtx_iface);
  72 }
  73
  74 /*******************************************************************************
  75  *        BindCtx_QueryInterface
  76  *******************************************************************************/
  77 static HRESULT WINAPI
  78 BindCtxImpl_QueryInterface(IBindCtx* iface,REFIID riid,void** ppvObject)
  79 {
  80     BindCtxImpl *This = impl_from_IBindCtx(iface);
  81
  82     TRACE("(%p %s %p)\n",This, debugstr_guid(riid), ppvObject);
  83
  84     /* Perform a sanity check on the parameters.*/
  85     if (!ppvObject)
  86         return E_POINTER;
  87
  88     /* Initialize the return parameter.*/
  89     *ppvObject = 0;
  90
  91     /* Compare the riid with the interface IDs implemented by this object.*/
  92     if (IsEqualIID(&IID_IUnknown, riid) ||
  93         IsEqualIID(&IID_IBindCtx, riid))
  94     {
  95         *ppvObject = &This->IBindCtx_iface;
  96         IBindCtx_AddRef(iface);
  97         return S_OK;
  98     }
  99
 100     return E_NOINTERFACE;
 101 }
 102
 103 /******************************************************************************
 104  *       BindCtx_AddRef
 105  ******************************************************************************/
 106 static ULONG WINAPI BindCtxImpl_AddRef(IBindCtx* iface)
 107 {
 108     BindCtxImpl *This = impl_from_IBindCtx(iface);
 109
 110     TRACE("(%p)\n",This);
 111
 112     return InterlockedIncrement(&This->ref);
 113 }
 114
 115 /******************************************************************************
 116  *        BindCtx_Destroy    (local function)
 117  *******************************************************************************/
 118 static HRESULT BindCtxImpl_Destroy(BindCtxImpl* This)
 119 {
 120     TRACE("(%p)\n",This);
 121
 122     /* free the table space memory */
 123     HeapFree(GetProcessHeap(),0,This->bindCtxTable);
 124
 125     /* free the bindctx structure */
 126     HeapFree(GetProcessHeap(),0,This);
 127
 128     return S_OK;
 129 }
 130
 131 /******************************************************************************
 132  *        BindCtx_Release
 133  ******************************************************************************/
 134 static ULONG WINAPI BindCtxImpl_Release(IBindCtx* iface)
 135 {
 136     BindCtxImpl *This = impl_from_IBindCtx(iface);
 137     ULONG ref;
 138
 139     TRACE("(%p)\n",This);
 140
 141     ref = InterlockedDecrement(&This->ref);
 142     if (ref == 0)
 143     {
 144         /* release all registered objects */
 145         BindCtxImpl_ReleaseBoundObjects(&This->IBindCtx_iface);
 146
 147         BindCtxImpl_Destroy(This);
 148     }
 149     return ref;
 150 }
 151
 152
 153 /******************************************************************************
 154  *        BindCtx_RegisterObjectBound
 155  ******************************************************************************/
 156 static HRESULT WINAPI
 157 BindCtxImpl_RegisterObjectBound(IBindCtx* iface,IUnknown* punk)
 158 {
 159     BindCtxImpl *This = impl_from_IBindCtx(iface);
 160     DWORD lastIndex=This->bindCtxTableLastIndex;
 161
 162     TRACE("(%p,%p)\n",This,punk);
 163
 164     if (punk==NULL)
 165         return S_OK;
 166
 167     if (lastIndex == This->bindCtxTableSize)
 168     {
 169         HRESULT hr = BindCtxImpl_ExpandTable(This);
 170         if (FAILED(hr))
 171             return hr;
 172     }
 173
 174     IUnknown_AddRef(punk);
 175
 176     /* put the object in the first free element in the table */
 177     This->bindCtxTable[lastIndex].pObj = punk;
 178     This->bindCtxTable[lastIndex].pkeyObj = NULL;
 179     This->bindCtxTable[lastIndex].regType = 0;
 180     lastIndex= ++This->bindCtxTableLastIndex;
 181
 182     return S_OK;
 183 }
 184
 185 /******************************************************************************
 186  *        BindCtx_RevokeObjectBound
 187  ******************************************************************************/
 188 static HRESULT WINAPI
 189 BindCtxImpl_RevokeObjectBound(IBindCtx* iface, IUnknown* punk)
 190 {
 191     DWORD index,j;
 192
 193     BindCtxImpl *This = impl_from_IBindCtx(iface);
 194
 195     TRACE("(%p,%p)\n",This,punk);
 196
 197     if (!punk)
 198         return E_INVALIDARG;
 199
 200     /* check if the object was registered or not */
 201     if (BindCtxImpl_GetObjectIndex(This,punk,NULL,&index)==S_FALSE)
 202         return MK_E_NOTBOUND;
 203
 204     if(This->bindCtxTable[index].pObj)
 205         IUnknown_Release(This->bindCtxTable[index].pObj);
 206     HeapFree(GetProcessHeap(),0,This->bindCtxTable[index].pkeyObj);
 207
 208     /* left-shift all elements in the right side of the current revoked object */
 209     for(j=index; j<This->bindCtxTableLastIndex-1; j++)
 210         This->bindCtxTable[j]= This->bindCtxTable[j+1];
 211
 212     This->bindCtxTableLastIndex--;
 213
 214     return S_OK;
 215 }
 216
 217 /******************************************************************************
 218  *        BindCtx_ReleaseBoundObjects
 219  ******************************************************************************/
 220 static HRESULT WINAPI
 221 BindCtxImpl_ReleaseBoundObjects(IBindCtx* iface)
 222 {
 223     DWORD i;
 224
 225     BindCtxImpl *This = impl_from_IBindCtx(iface);
 226
 227     TRACE("(%p)\n",This);
 228
 229     for(i=0;i<This->bindCtxTableLastIndex;i++)
 230     {
 231         if(This->bindCtxTable[i].pObj)
 232             IUnknown_Release(This->bindCtxTable[i].pObj);
 233         HeapFree(GetProcessHeap(),0,This->bindCtxTable[i].pkeyObj);
 234     }
 235
 236     This->bindCtxTableLastIndex = 0;
 237
 238     return S_OK;
 239 }
 240
 241 /******************************************************************************
 242  *        BindCtx_SetBindOptions
 243  ******************************************************************************/
 244 static HRESULT WINAPI
 245 BindCtxImpl_SetBindOptions(IBindCtx* iface,BIND_OPTS *pbindopts)
 246 {
 247     BindCtxImpl *This = impl_from_IBindCtx(iface);
 248
 249     TRACE("(%p,%p)\n",This, pbindopts);
 250
 251     if (pbindopts==NULL)
 252         return E_POINTER;
 253
 254     if (pbindopts->cbStruct > sizeof(This->options))
 255     {
 256         WARN("invalid size %u.\n", pbindopts->cbStruct);
 257         return E_INVALIDARG;
 258     }
 259     memcpy(&This->options, pbindopts, pbindopts->cbStruct);
 260     return S_OK;
 261 }
 262
 263 /******************************************************************************
 264  *        BindCtx_GetBindOptions
 265  ******************************************************************************/
 266 static HRESULT WINAPI
 267 BindCtxImpl_GetBindOptions(IBindCtx* iface,BIND_OPTS *pbindopts)
 268 {
 269     BindCtxImpl *This = impl_from_IBindCtx(iface);
 270     DWORD size;
 271
 272     TRACE("(%p,%p)\n",This,pbindopts);
 273
 274     if (pbindopts==NULL)
 275         return E_POINTER;
 276
 277     size = min(pbindopts->cbStruct, sizeof(This->options));
 278     memcpy(pbindopts, &This->options, size);
 279     pbindopts->cbStruct = size;
 280
 281     return S_OK;
 282 }
 283
 284 /******************************************************************************
 285  *        BindCtx_GetRunningObjectTable
 286  ******************************************************************************/
 287 static HRESULT WINAPI
 288 BindCtxImpl_GetRunningObjectTable(IBindCtx* iface,IRunningObjectTable** pprot)
 289 {
 290     BindCtxImpl *This = impl_from_IBindCtx(iface);
 291
 292     TRACE("(%p,%p)\n",This,pprot);
 293
 294     if (pprot==NULL)
 295         return E_POINTER;
 296
 297     return GetRunningObjectTable(0, pprot);
 298 }
 299
 300 /******************************************************************************
 301  *        BindCtx_RegisterObjectParam
 302  ******************************************************************************/
 303 static HRESULT WINAPI
 304 BindCtxImpl_RegisterObjectParam(IBindCtx* iface,LPOLESTR pszkey, IUnknown* punk)
 305 {
 306     DWORD index=0;
 307     BindCtxImpl *This = impl_from_IBindCtx(iface);
 308
 309     TRACE("(%p,%s,%p)\n",This,debugstr_w(pszkey),punk);
 310
 311     if (punk==NULL)
 312         return E_INVALIDARG;
 313
 314     if (pszkey!=NULL && BindCtxImpl_GetObjectIndex(This,NULL,pszkey,&index)==S_OK)
 315     {
 316         TRACE("Overwriting existing key\n");
 317         if(This->bindCtxTable[index].pObj!=NULL)
 318             IUnknown_Release(This->bindCtxTable[index].pObj);
 319         This->bindCtxTable[index].pObj=punk;
 320         IUnknown_AddRef(punk);
 321         return S_OK;
 322     }
 323
 324     if (This->bindCtxTableLastIndex == This->bindCtxTableSize)
 325     {
 326         HRESULT hr = BindCtxImpl_ExpandTable(This);
 327         if (FAILED(hr))
 328             return hr;
 329     }
 330
 331     This->bindCtxTable[This->bindCtxTableLastIndex].pObj = punk;
 332     This->bindCtxTable[This->bindCtxTableLastIndex].regType = 1;
 333
 334     if (pszkey==NULL)
 335
 336         This->bindCtxTable[This->bindCtxTableLastIndex].pkeyObj=NULL;
 337
 338     else
 339     {
 340
 341         This->bindCtxTable[This->bindCtxTableLastIndex].pkeyObj=
 342             HeapAlloc(GetProcessHeap(),0,(sizeof(WCHAR)*(1+lstrlenW(pszkey))));
 343
 344         if (This->bindCtxTable[This->bindCtxTableLastIndex].pkeyObj==NULL)
 345             return E_OUTOFMEMORY;
 346         lstrcpyW(This->bindCtxTable[This->bindCtxTableLastIndex].pkeyObj,pszkey);
 347     }
 348
 349     This->bindCtxTableLastIndex++;
 350
 351     IUnknown_AddRef(punk);
 352     return S_OK;
 353 }
 354
 355 /******************************************************************************
 356  *        BindCtx_GetObjectParam
 357  ******************************************************************************/
 358 static HRESULT WINAPI
 359 BindCtxImpl_GetObjectParam(IBindCtx* iface,LPOLESTR pszkey, IUnknown** punk)
 360 {
 361     DWORD index;
 362     BindCtxImpl *This = impl_from_IBindCtx(iface);
 363
 364     TRACE("(%p,%s,%p)\n",This,debugstr_w(pszkey),punk);
 365
 366     if (punk==NULL)
 367         return E_POINTER;
 368
 369     *punk=0;
 370
 371     if (BindCtxImpl_GetObjectIndex(This,NULL,pszkey,&index)==S_FALSE)
 372         return E_FAIL;
 373
 374     IUnknown_AddRef(This->bindCtxTable[index].pObj);
 375
 376     *punk = This->bindCtxTable[index].pObj;
 377
 378     return S_OK;
 379 }
 380
 381 /******************************************************************************
 382  *        BindCtx_RevokeObjectParam
 383  ******************************************************************************/
 384 static HRESULT WINAPI
 385 BindCtxImpl_RevokeObjectParam(IBindCtx* iface,LPOLESTR ppenum)
 386 {
 387     DWORD index,j;
 388
 389     BindCtxImpl *This = impl_from_IBindCtx(iface);
 390
 391     TRACE("(%p,%s)\n",This,debugstr_w(ppenum));
 392
 393     if (BindCtxImpl_GetObjectIndex(This,NULL,ppenum,&index)==S_FALSE)
 394         return E_FAIL;
 395
 396     /* release the object if it's found */
 397     if(This->bindCtxTable[index].pObj)
 398         IUnknown_Release(This->bindCtxTable[index].pObj);
 399     HeapFree(GetProcessHeap(),0,This->bindCtxTable[index].pkeyObj);
 400
 401     /* remove the object from the table with a left-shifting of all objects in the right side */
 402     for(j=index; j<This->bindCtxTableLastIndex-1; j++)
 403         This->bindCtxTable[j]= This->bindCtxTable[j+1];
 404
 405     This->bindCtxTableLastIndex--;
 406
 407     return S_OK;
 408 }
 409
 410 /******************************************************************************
 411  *        BindCtx_EnumObjectParam
 412  ******************************************************************************/
 413 static HRESULT WINAPI
 414 BindCtxImpl_EnumObjectParam(IBindCtx* iface,IEnumString** pszkey)
 415 {
 416     TRACE("(%p,%p)\n",iface,pszkey);
 417
 418     *pszkey = NULL;
 419
 420     /* not implemented in native either */
 421     return E_NOTIMPL;
 422 }
 423
 424 /********************************************************************************
 425  *        GetObjectIndex (local function)
 426  ********************************************************************************/
 427 static HRESULT BindCtxImpl_GetObjectIndex(BindCtxImpl* This,
 428                                           IUnknown* punk,
 429                                           LPOLESTR pszkey,
 430                                           DWORD *index)
 431 {
 432     DWORD i;
 433     BOOL found = FALSE;
 434
 435     TRACE("(%p,%p,%p,%p)\n",This,punk,pszkey,index);
 436
 437     if (punk==NULL)
 438         /* search object identified by a register key */
 439         for(i=0; ( (i<This->bindCtxTableLastIndex) && (!found));i++)
 440         {
 441             if(This->bindCtxTable[i].regType==1){
 442
 443                 if ( ( (This->bindCtxTable[i].pkeyObj==NULL) && (pszkey==NULL) ) ||
 444                      ( (This->bindCtxTable[i].pkeyObj!=NULL) &&
 445                        (pszkey!=NULL) &&
 446                        (wcscmp(This->bindCtxTable[i].pkeyObj,pszkey)==0)
 447                      )
 448                    )
 449
 450                     found = TRUE;
 451             }
 452         }
 453     else
 454         /* search object identified by a moniker*/
 455         for(i=0; ( (i<This->bindCtxTableLastIndex) && (!found));i++)
 456             if(This->bindCtxTable[i].pObj==punk)
 457                 found = TRUE;
 458
 459     if (index != NULL)
 460         *index=i-1;
 461
 462     if (found)
 463         return S_OK;
 464     TRACE("key not found\n");
 465     return S_FALSE;
 466 }
 467
 468 static HRESULT BindCtxImpl_ExpandTable(BindCtxImpl *This)
 469 {
 470     if (!This->bindCtxTableSize)
 471     {
 472         This->bindCtxTableSize = BINDCTX_FIRST_TABLE_SIZE;
 473         This->bindCtxTable = HeapAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,
 474                                        This->bindCtxTableSize * sizeof(BindCtxObject));
 475     }
 476     else
 477     {
 478         This->bindCtxTableSize *= 2;
 479
 480         This->bindCtxTable = HeapReAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,This->bindCtxTable,
 481                                          This->bindCtxTableSize * sizeof(BindCtxObject));
 482     }
 483
 484     if (!This->bindCtxTable)
 485         return E_OUTOFMEMORY;
 486
 487     return S_OK;
 488 }
 489
 490
 491 /* Virtual function table for the BindCtx class. */
 492 static const IBindCtxVtbl VT_BindCtxImpl =
 493 {
 494     BindCtxImpl_QueryInterface,
 495     BindCtxImpl_AddRef,
 496     BindCtxImpl_Release,
 497     BindCtxImpl_RegisterObjectBound,
 498     BindCtxImpl_RevokeObjectBound,
 499     BindCtxImpl_ReleaseBoundObjects,
 500     BindCtxImpl_SetBindOptions,
 501     BindCtxImpl_GetBindOptions,
 502     BindCtxImpl_GetRunningObjectTable,
 503     BindCtxImpl_RegisterObjectParam,
 504     BindCtxImpl_GetObjectParam,
 505     BindCtxImpl_EnumObjectParam,
 506     BindCtxImpl_RevokeObjectParam
 507 };
 508
 509 /******************************************************************************
 510  *         BindCtx_Construct (local function)
 511  *******************************************************************************/
 512 static HRESULT BindCtxImpl_Construct(BindCtxImpl* This)
 513 {
 514     TRACE("(%p)\n",This);
 515
 516     /* Initialize the virtual function table.*/
 517     This->IBindCtx_iface.lpVtbl = &VT_BindCtxImpl;
 518     This->ref          = 0;
 519
 520     memset(&This->options, 0, sizeof(This->options));
 521     This->options.cbStruct = sizeof(This->options);
 522     This->options.grfMode = STGM_READWRITE;
 523     This->options.dwClassContext = CLSCTX_SERVER;
 524     This->options.locale = GetThreadLocale();
 525
 526     /* Initialize the bindctx table */
 527     This->bindCtxTableSize=0;
 528     This->bindCtxTableLastIndex=0;
 529     This->bindCtxTable = NULL;
 530
 531     return S_OK;
 532 }
 533
 534 /******************************************************************************
 535  *        CreateBindCtx (OLE32.@)
 536  *
 537  * Creates a bind context. A bind context encompasses information and options
 538  * used when binding to a moniker.
 539  *
 540  * PARAMS
 541  *  reserved [I] Reserved. Set to 0.
 542  *  ppbc     [O] Address that receives the bind context object.
 543  *
 544  * RETURNS
 545  *  Success: S_OK.
 546  *  Failure: Any HRESULT code.
 547  */
 548 HRESULT WINAPI CreateBindCtx(DWORD reserved, LPBC * ppbc)
 549 {
 550     BindCtxImpl* newBindCtx;
 551     HRESULT hr;
 552
 553     TRACE("(%d,%p)\n",reserved,ppbc);
 554
 555     if (!ppbc) return E_INVALIDARG;
 556
 557     *ppbc = NULL;
 558
 559     if (reserved != 0)
 560     {
 561         ERR("reserved should be 0, not 0x%x\n", reserved);
 562         return E_INVALIDARG;
 563     }
 564
 565     newBindCtx = HeapAlloc(GetProcessHeap(), 0, sizeof(BindCtxImpl));
 566     if (newBindCtx == 0)
 567         return E_OUTOFMEMORY;
 568
 569     hr = BindCtxImpl_Construct(newBindCtx);
 570     if (FAILED(hr))
 571     {
 572         HeapFree(GetProcessHeap(),0,newBindCtx);
 573         return hr;
 574     }
 575
 576     return BindCtxImpl_QueryInterface(&newBindCtx->IBindCtx_iface,&IID_IBindCtx,(void**)ppbc);
 577 }
 578
 579 /******************************************************************************
 580  *              BindMoniker        [OLE32.@]
 581  *
 582  * Binds to a moniker.
 583  *
 584  * PARAMS
 585  *  pmk      [I] Moniker to bind to.
 586  *  grfOpt   [I] Reserved option flags. Set to 0.
 587  *  riid     [I] ID of the interface to bind to.
 588  *  pvResult [O] Address that receives the interface of the object that was bound to.
 589  *
 590  * RETURNS
 591  *  Success: S_OK.
 592  *  Failure: Any HRESULT code.
 593  */
 594 HRESULT WINAPI BindMoniker(LPMONIKER pmk, DWORD grfOpt, REFIID riid, LPVOID * ppvResult)
 595 {
 596     HRESULT res;
 597     IBindCtx * pbc;
 598
 599     TRACE("(%p, %x, %s, %p)\n", pmk, grfOpt, debugstr_guid(riid), ppvResult);
 600
 601     res = CreateBindCtx(grfOpt, &pbc);
 602     if (SUCCEEDED(res))
 603     {
 604         res = IMoniker_BindToObject(pmk, pbc, NULL, riid, ppvResult);
 605         IBindCtx_Release(pbc);
 606     }
 607     return res;
 608 }