dlls/shlwapi/regstream.c

   1 /*
   2  * SHLWAPI Registry Stream functions
   3  *
   4  * Copyright 1999 Juergen Schmied
   5  * Copyright 2002 Jon Griffiths
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with this library; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  20  */
  21
  22 #include <stdarg.h>
  23 #include <string.h>
  24
  25 #define COBJMACROS
  26
  27 #include "winerror.h"
  28 #include "windef.h"
  29 #include "winbase.h"
  30 #include "objbase.h"
  31 #include "winreg.h"
  32
  33 #include "wine/debug.h"
  34
  35 WINE_DEFAULT_DEBUG_CHANNEL(shell);
  36
  37 typedef struct
  38 {       IStreamVtbl *lpVtbl;
  39         DWORD  ref;
  40         HKEY   hKey;
  41         LPBYTE pbBuffer;
  42         DWORD  dwLength;
  43         DWORD  dwPos;
  44 } ISHRegStream;
  45
  46 /**************************************************************************
  47 *  IStream_fnQueryInterface
  48 */
  49 static HRESULT WINAPI IStream_fnQueryInterface(IStream *iface, REFIID riid, LPVOID *ppvObj)
  50 {
  51         ISHRegStream *This = (ISHRegStream *)iface;
  52
  53         TRACE("(%p)->(\n\tIID:\t%s,%p)\n",This,debugstr_guid(riid),ppvObj);
  54
  55         *ppvObj = NULL;
  56
  57         if(IsEqualIID(riid, &IID_IUnknown))     /*IUnknown*/
  58           *ppvObj = This;
  59         else if(IsEqualIID(riid, &IID_IStream)) /*IStream*/
  60           *ppvObj = This;
  61
  62         if(*ppvObj)
  63         {
  64           IStream_AddRef((IStream*)*ppvObj);
  65           TRACE("-- Interface: (%p)->(%p)\n",ppvObj,*ppvObj);
  66           return S_OK;
  67         }
  68         TRACE("-- Interface: E_NOINTERFACE\n");
  69         return E_NOINTERFACE;
  70 }
  71
  72 /**************************************************************************
  73 *  IStream_fnAddRef
  74 */
  75 static ULONG WINAPI IStream_fnAddRef(IStream *iface)
  76 {
  77         ISHRegStream *This = (ISHRegStream *)iface;
  78
  79         TRACE("(%p)->(count=%lu)\n",This, This->ref);
  80
  81         return InterlockedIncrement(&This->ref);
  82 }
  83
  84 /**************************************************************************
  85 *  IStream_fnRelease
  86 */
  87 static ULONG WINAPI IStream_fnRelease(IStream *iface)
  88 {
  89         ISHRegStream *This = (ISHRegStream *)iface;
  90
  91         TRACE("(%p)->()\n",This);
  92
  93         if (!InterlockedDecrement(&This->ref))
  94         {
  95           TRACE(" destroying SHReg IStream (%p)\n",This);
  96
  97           if (This->pbBuffer)
  98             HeapFree(GetProcessHeap(),0,This->pbBuffer);
  99
 100           if (This->hKey)
 101             RegCloseKey(This->hKey);
 102
 103           HeapFree(GetProcessHeap(),0,This);
 104           return 0;
 105         }
 106         return This->ref;
 107 }
 108
 109 /**************************************************************************
 110  * IStream_fnRead
 111  */
 112 static HRESULT WINAPI IStream_fnRead (IStream * iface, void* pv, ULONG cb, ULONG* pcbRead)
 113 {
 114         ISHRegStream *This = (ISHRegStream *)iface;
 115
 116         DWORD dwBytesToRead, dwBytesLeft;
 117
 118         TRACE("(%p)->(%p,0x%08lx,%p)\n",This, pv, cb, pcbRead);
 119
 120         if (!pv)
 121           return STG_E_INVALIDPOINTER;
 122
 123         dwBytesLeft = This->dwLength - This->dwPos;
 124
 125         if ( 0 >= dwBytesLeft ) /* end of buffer */
 126           return S_FALSE;
 127
 128         dwBytesToRead = ( cb > dwBytesLeft) ? dwBytesLeft : cb;
 129
 130         memmove ( pv, (This->pbBuffer) + (This->dwPos), dwBytesToRead);
 131
 132         This->dwPos += dwBytesToRead; /* adjust pointer */
 133
 134         if (pcbRead)
 135           *pcbRead = dwBytesToRead;
 136
 137         return S_OK;
 138 }
 139
 140 /**************************************************************************
 141  * IStream_fnWrite
 142  */
 143 static HRESULT WINAPI IStream_fnWrite (IStream * iface, const void* pv, ULONG cb, ULONG* pcbWritten)
 144 {
 145         ISHRegStream *This = (ISHRegStream *)iface;
 146
 147         TRACE("(%p)\n",This);
 148
 149         if (pcbWritten)
 150           *pcbWritten = 0;
 151
 152         return E_NOTIMPL;
 153 }
 154
 155 /**************************************************************************
 156  *  IStream_fnSeek
 157  */
 158 static HRESULT WINAPI IStream_fnSeek (IStream * iface, LARGE_INTEGER dlibMove, DWORD dwOrigin, ULARGE_INTEGER* plibNewPosition)
 159 {
 160         ISHRegStream *This = (ISHRegStream *)iface;
 161
 162         TRACE("(%p)\n",This);
 163
 164         if (plibNewPosition)
 165           plibNewPosition->QuadPart = 0;
 166         return E_NOTIMPL;
 167 }
 168
 169 /**************************************************************************
 170  * IStream_fnSetSize
 171  */
 172 static HRESULT WINAPI IStream_fnSetSize (IStream * iface, ULARGE_INTEGER libNewSize)
 173 {
 174         ISHRegStream *This = (ISHRegStream *)iface;
 175
 176         TRACE("(%p)\n",This);
 177         return E_NOTIMPL;
 178 }
 179
 180 /**************************************************************************
 181  * IStream_fnCopyTo
 182  */
 183 static HRESULT WINAPI IStream_fnCopyTo (IStream * iface, IStream* pstm, ULARGE_INTEGER cb, ULARGE_INTEGER* pcbRead, ULARGE_INTEGER* pcbWritten)
 184 {
 185         ISHRegStream *This = (ISHRegStream *)iface;
 186
 187         TRACE("(%p)\n",This);
 188         if (pcbRead)
 189           pcbRead->QuadPart = 0;
 190         if (pcbWritten)
 191           pcbWritten->QuadPart = 0;
 192         return E_NOTIMPL;
 193 }
 194
 195 /**************************************************************************
 196  * IStream_fnCommit
 197  */
 198 static HRESULT WINAPI IStream_fnCommit (IStream * iface, DWORD grfCommitFlags)
 199 {
 200         ISHRegStream *This = (ISHRegStream *)iface;
 201
 202         TRACE("(%p)\n",This);
 203
 204         return E_NOTIMPL;
 205 }
 206
 207 /**************************************************************************
 208  * IStream_fnRevert
 209  */
 210 static HRESULT WINAPI IStream_fnRevert (IStream * iface)
 211 {
 212         ISHRegStream *This = (ISHRegStream *)iface;
 213
 214         TRACE("(%p)\n",This);
 215
 216         return E_NOTIMPL;
 217 }
 218
 219 /**************************************************************************
 220  * IStream_fnLockUnlockRegion
 221  */
 222 static HRESULT WINAPI IStream_fnLockUnlockRegion (IStream * iface, ULARGE_INTEGER libOffset, ULARGE_INTEGER cb, DWORD dwLockType)
 223 {
 224         ISHRegStream *This = (ISHRegStream *)iface;
 225
 226         TRACE("(%p)\n",This);
 227
 228         return E_NOTIMPL;
 229 }
 230
 231 /*************************************************************************
 232  * IStream_fnStat
 233  */
 234 static HRESULT WINAPI IStream_fnStat (IStream * iface, STATSTG*   pstatstg, DWORD grfStatFlag)
 235 {
 236         ISHRegStream *This = (ISHRegStream *)iface;
 237
 238         TRACE("(%p)\n",This);
 239
 240         return E_NOTIMPL;
 241 }
 242
 243 /*************************************************************************
 244  * IStream_fnClone
 245  */
 246 static HRESULT WINAPI IStream_fnClone (IStream * iface, IStream** ppstm)
 247 {
 248         ISHRegStream *This = (ISHRegStream *)iface;
 249
 250         TRACE("(%p)\n",This);
 251         if (ppstm)
 252           *ppstm = NULL;
 253         return E_NOTIMPL;
 254 }
 255
 256 static struct IStreamVtbl rstvt =
 257 {
 258         IStream_fnQueryInterface,
 259         IStream_fnAddRef,
 260         IStream_fnRelease,
 261         IStream_fnRead,
 262         IStream_fnWrite,
 263         IStream_fnSeek,
 264         IStream_fnSetSize,
 265         IStream_fnCopyTo,
 266         IStream_fnCommit,
 267         IStream_fnRevert,
 268         IStream_fnLockUnlockRegion,
 269         IStream_fnLockUnlockRegion,
 270         IStream_fnStat,
 271         IStream_fnClone
 272 };
 273
 274 /* Methods overridden by the dummy stream */
 275
 276 /**************************************************************************
 277  *  IStream_fnAddRefDummy
 278  */
 279 static ULONG WINAPI IStream_fnAddRefDummy(IStream *iface)
 280 {
 281         ISHRegStream *This = (ISHRegStream *)iface;
 282         TRACE("(%p)\n", This);
 283         return 2;
 284 }
 285
 286 /**************************************************************************
 287  *  IStream_fnReleaseDummy
 288  */
 289 static ULONG WINAPI IStream_fnReleaseDummy(IStream *iface)
 290 {
 291         ISHRegStream *This = (ISHRegStream *)iface;
 292         TRACE("(%p)\n", This);
 293         return 1;
 294 }
 295
 296 /**************************************************************************
 297  * IStream_fnReadDummy
 298  */
 299 static HRESULT WINAPI IStream_fnReadDummy(IStream *iface, LPVOID pv, ULONG cb, ULONG* pcbRead)
 300 {
 301   if (pcbRead)
 302     *pcbRead = 0;
 303   return E_NOTIMPL;
 304 }
 305
 306 static struct IStreamVtbl DummyRegStreamVTable =
 307 {
 308   IStream_fnQueryInterface,
 309   IStream_fnAddRefDummy,  /* Overridden */
 310   IStream_fnReleaseDummy, /* Overridden */
 311   IStream_fnReadDummy,    /* Overridden */
 312   IStream_fnWrite,
 313   IStream_fnSeek,
 314   IStream_fnSetSize,
 315   IStream_fnCopyTo,
 316   IStream_fnCommit,
 317   IStream_fnRevert,
 318   IStream_fnLockUnlockRegion,
 319   IStream_fnLockUnlockRegion,
 320   IStream_fnStat,
 321   IStream_fnClone
 322 };
 323
 324 /* Dummy registry stream object */
 325 static ISHRegStream rsDummyRegStream =
 326 {
 327  &DummyRegStreamVTable,
 328  1,
 329  NULL,
 330  NULL,
 331  0,
 332  0
 333 };
 334
 335 /**************************************************************************
 336  * IStream_Create
 337  *
 338  * Internal helper: Create and initialise a new registry stream object.
 339  */
 340 static IStream *IStream_Create(HKEY hKey, LPBYTE pbBuffer, DWORD dwLength)
 341 {
 342  ISHRegStream* regStream;
 343
 344  regStream = (ISHRegStream*)HeapAlloc(GetProcessHeap(), 0, sizeof(ISHRegStream));
 345
 346  if (regStream)
 347  {
 348    regStream->lpVtbl = &rstvt;
 349    regStream->ref = 1;
 350    regStream->hKey = hKey;
 351    regStream->pbBuffer = pbBuffer;
 352    regStream->dwLength = dwLength;
 353    regStream->dwPos = 0;
 354  }
 355  TRACE ("Returning %p\n", regStream);
 356  return (IStream *)regStream;
 357 }
 358
 359 /*************************************************************************
 360  * SHOpenRegStream2A    [SHLWAPI.@]
 361  *
 362  * Create a stream to read binary registry data.
 363  *
 364  * PARAMS
 365  * hKey      [I] Registry handle
 366  * pszSubkey [I] The sub key name
 367  * pszValue  [I] The value name under the sub key
 368  * dwMode    [I] Unused
 369  *
 370  * RETURNS
 371  * Success: An IStream interface referring to the registry data
 372  * Failure: NULL, if the registry key could not be opened or is not binary.
 373  */
 374 IStream * WINAPI SHOpenRegStream2A(HKEY hKey, LPCSTR pszSubkey,
 375                                    LPCSTR pszValue,DWORD dwMode)
 376 {
 377   HKEY hStrKey = NULL;
 378   LPBYTE lpBuff = NULL;
 379   DWORD dwLength, dwType;
 380
 381   TRACE("(%p,%s,%s,0x%08lx)\n", hKey, pszSubkey, pszValue, dwMode);
 382
 383   /* Open the key, read in binary data and create stream */
 384   if (!RegOpenKeyExA (hKey, pszSubkey, 0, KEY_READ, &hStrKey) &&
 385       !RegQueryValueExA (hStrKey, pszValue, 0, 0, 0, &dwLength) &&
 386       (lpBuff = HeapAlloc (GetProcessHeap(), 0, dwLength)) &&
 387       !RegQueryValueExA (hStrKey, pszValue, 0, &dwType, lpBuff, &dwLength) &&
 388       dwType == REG_BINARY)
 389     return IStream_Create(hStrKey, lpBuff, dwLength);
 390
 391   if (lpBuff)
 392     HeapFree (GetProcessHeap(), 0, lpBuff);
 393   if (hStrKey)
 394     RegCloseKey(hStrKey);
 395   return NULL;
 396 }
 397
 398 /*************************************************************************
 399  * SHOpenRegStream2W    [SHLWAPI.@]
 400  *
 401  * See SHOpenRegStream2A.
 402  */
 403 IStream * WINAPI SHOpenRegStream2W(HKEY hKey, LPCWSTR pszSubkey,
 404                                    LPCWSTR pszValue, DWORD dwMode)
 405 {
 406   HKEY hStrKey = NULL;
 407   LPBYTE lpBuff = NULL;
 408   DWORD dwLength, dwType;
 409
 410   TRACE("(%p,%s,%s,0x%08lx)\n", hKey, debugstr_w(pszSubkey),
 411         debugstr_w(pszValue), dwMode);
 412
 413   /* Open the key, read in binary data and create stream */
 414   if (!RegOpenKeyExW (hKey, pszSubkey, 0, KEY_READ, &hStrKey) &&
 415       !RegQueryValueExW (hStrKey, pszValue, 0, 0, 0, &dwLength) &&
 416       (lpBuff = HeapAlloc (GetProcessHeap(), 0, dwLength)) &&
 417       !RegQueryValueExW (hStrKey, pszValue, 0, &dwType, lpBuff, &dwLength) &&
 418       dwType == REG_BINARY)
 419     return IStream_Create(hStrKey, lpBuff, dwLength);
 420
 421   if (lpBuff)
 422     HeapFree (GetProcessHeap(), 0, lpBuff);
 423   if (hStrKey)
 424     RegCloseKey(hStrKey);
 425   return NULL;
 426 }
 427
 428 /*************************************************************************
 429  * SHOpenRegStreamA     [SHLWAPI.@]
 430  *
 431  * Create a stream to read binary registry data.
 432  *
 433  * PARAMS
 434  * hKey      [I] Registry handle
 435  * pszSubkey [I] The sub key name
 436  * pszValue  [I] The value name under the sub key
 437  * dwMode    [I] STGM mode for opening the file
 438  *
 439  * RETURNS
 440  * Success: An IStream interface referring to the registry data
 441  * Failure: If the registry key could not be opened or is not binary,
 442  *          A dummy (empty) IStream object is returned.
 443  */
 444 IStream * WINAPI SHOpenRegStreamA(HKEY hkey, LPCSTR pszSubkey,
 445                                   LPCSTR pszValue, DWORD dwMode)
 446 {
 447   IStream *iStream;
 448
 449   TRACE("(%p,%s,%s,0x%08lx)\n", hkey, pszSubkey, pszValue, dwMode);
 450
 451   iStream = SHOpenRegStream2A(hkey, pszSubkey, pszValue, dwMode);
 452   return iStream ? iStream : (IStream *)&rsDummyRegStream;
 453 }
 454
 455 /*************************************************************************
 456  * SHOpenRegStreamW     [SHLWAPI.@]
 457  *
 458  * See SHOpenRegStreamA.
 459  */
 460 IStream * WINAPI SHOpenRegStreamW(HKEY hkey, LPCWSTR pszSubkey,
 461                                   LPCWSTR pszValue, DWORD dwMode)
 462 {
 463   IStream *iStream;
 464
 465   TRACE("(%p,%s,%s,0x%08lx)\n", hkey, debugstr_w(pszSubkey),
 466         debugstr_w(pszValue), dwMode);
 467   iStream = SHOpenRegStream2W(hkey, pszSubkey, pszValue, dwMode);
 468   return iStream ? iStream : (IStream *)&rsDummyRegStream;
 469 }
 470
 471 /*************************************************************************
 472  * @   [SHLWAPI.12]
 473  *
 474  * Create an IStream object on a block of memory.
 475  *
 476  * PARAMS
 477  * lpbData   [I] Memory block to create the IStream object on
 478  * dwDataLen [I] Length of data block
 479  *
 480  * RETURNS
 481  * Success: A pointer to the IStream object.
 482  * Failure: NULL, if any parameters are invalid or an error occurs.
 483  *
 484  * NOTES
 485  *  A copy of the memory pointed to by lpbData is made, and is freed
 486  *  when the stream is released.
 487  */
 488 IStream * WINAPI SHCreateMemStream(LPBYTE lpbData, DWORD dwDataLen)
 489 {
 490   IStream *iStrmRet = NULL;
 491
 492   TRACE("(%p,%ld)\n", lpbData, dwDataLen);
 493
 494   if (lpbData)
 495   {
 496     LPBYTE lpbDup = (LPBYTE)HeapAlloc(GetProcessHeap(), 0, dwDataLen);
 497
 498     if (lpbDup)
 499     {
 500       memcpy(lpbDup, lpbData, dwDataLen);
 501       iStrmRet = IStream_Create(NULL, lpbDup, dwDataLen);
 502
 503       if (!iStrmRet)
 504         HeapFree(GetProcessHeap(), 0, lpbDup);
 505     }
 506   }
 507   return iStrmRet;
 508 }
 509
 510 /*************************************************************************
 511  * SHCreateStreamWrapper   [SHLWAPI.@]
 512  *
 513  * Create an IStream object on a block of memory.
 514  *
 515  * PARAMS
 516  * lpbData    [I] Memory block to create the IStream object on
 517  * dwDataLen  [I] Length of data block
 518  * dwReserved [I] Reserved, Must be 0.
 519  * lppStream  [O] Destination for IStream object
 520  *
 521  * RETURNS
 522  * Success: S_OK. lppStream contains the new IStream object.
 523  * Failure: E_INVALIDARG, if any parameters are invalid,
 524  *          E_OUTOFMEMORY if memory allocation fails.
 525  *
 526  * NOTES
 527  *  The stream assumes ownership of the memory passed to it.
 528  */
 529 HRESULT WINAPI SHCreateStreamWrapper(LPBYTE lpbData, DWORD dwDataLen,
 530                                      DWORD dwReserved, IStream **lppStream)
 531 {
 532   IStream* lpStream;
 533
 534   if (lppStream)
 535     *lppStream = NULL;
 536
 537   if(dwReserved || !lppStream)
 538     return E_INVALIDARG;
 539
 540   lpStream = IStream_Create(NULL, lpbData, dwDataLen);
 541
 542   if(!lpStream)
 543     return E_OUTOFMEMORY;
 544
 545   IStream_QueryInterface(lpStream, &IID_IStream, (void**)lppStream);
 546   IStream_Release(lpStream);
 547   return S_OK;
 548 }