dlls/ole32/filelockbytes.c

   1 /******************************************************************************
   2  *
   3  * File-based ILockBytes implementation
   4  *
   5  * Copyright 1999 Thuy Nguyen
   6  * Copyright 2010 Vincent Povirk for CodeWeavers
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2.1 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with this library; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  21  */
  22
  23 #include <assert.h>
  24 #include <stdlib.h>
  25 #include <stdarg.h>
  26 #include <stdio.h>
  27 #include <string.h>
  28 #include <limits.h>
  29
  30 #define COBJMACROS
  31 #define NONAMELESSUNION
  32 #define NONAMELESSSTRUCT
  33
  34 #include "windef.h"
  35 #include "winbase.h"
  36 #include "winuser.h"
  37 #include "winerror.h"
  38 #include "objbase.h"
  39 #include "ole2.h"
  40
  41 #include "storage32.h"
  42
  43 #include "wine/debug.h"
  44 #include "wine/unicode.h"
  45
  46 WINE_DEFAULT_DEBUG_CHANNEL(storage);
  47
  48 typedef struct FileLockBytesImpl
  49 {
  50     ILockBytes ILockBytes_iface;
  51     LONG ref;
  52     HANDLE hfile;
  53     DWORD flProtect;
  54     LPWSTR pwcsName;
  55 } FileLockBytesImpl;
  56
  57 static const ILockBytesVtbl FileLockBytesImpl_Vtbl;
  58
  59 static inline FileLockBytesImpl *impl_from_ILockBytes(ILockBytes *iface)
  60 {
  61     return CONTAINING_RECORD(iface, FileLockBytesImpl, ILockBytes_iface);
  62 }
  63
  64 /***********************************************************
  65  * Prototypes for private methods
  66  */
  67
  68 /* Note that this evaluates a and b multiple times, so don't
  69  * pass expressions with side effects. */
  70 #define ROUND_UP(a, b) ((((a) + (b) - 1)/(b))*(b))
  71
  72 /****************************************************************************
  73  *      GetProtectMode
  74  *
  75  * This function will return a protection mode flag for a file-mapping object
  76  * from the open flags of a file.
  77  */
  78 static DWORD GetProtectMode(DWORD openFlags)
  79 {
  80     switch(STGM_ACCESS_MODE(openFlags))
  81     {
  82     case STGM_WRITE:
  83     case STGM_READWRITE:
  84         return PAGE_READWRITE;
  85     }
  86     return PAGE_READONLY;
  87 }
  88
  89 /******************************************************************************
  90  *      FileLockBytesImpl_Construct
  91  *
  92  * Initialize a big block object supported by a file.
  93  */
  94 HRESULT FileLockBytesImpl_Construct(HANDLE hFile, DWORD openFlags, LPCWSTR pwcsName, ILockBytes **pLockBytes)
  95 {
  96   FileLockBytesImpl *This;
  97   WCHAR fullpath[MAX_PATH];
  98
  99   if (hFile == INVALID_HANDLE_VALUE)
 100     return E_FAIL;
 101
 102   This = HeapAlloc(GetProcessHeap(), 0, sizeof(FileLockBytesImpl));
 103
 104   if (!This)
 105     return E_OUTOFMEMORY;
 106
 107   This->ILockBytes_iface.lpVtbl = &FileLockBytesImpl_Vtbl;
 108   This->ref = 1;
 109   This->hfile = hFile;
 110   This->flProtect = GetProtectMode(openFlags);
 111
 112   if(pwcsName) {
 113     if (!GetFullPathNameW(pwcsName, MAX_PATH, fullpath, NULL))
 114     {
 115       lstrcpynW(fullpath, pwcsName, MAX_PATH);
 116     }
 117     This->pwcsName = HeapAlloc(GetProcessHeap(), 0,
 118                               (lstrlenW(fullpath)+1)*sizeof(WCHAR));
 119     if (!This->pwcsName)
 120     {
 121        HeapFree(GetProcessHeap(), 0, This);
 122        return E_OUTOFMEMORY;
 123     }
 124     strcpyW(This->pwcsName, fullpath);
 125   }
 126   else
 127     This->pwcsName = NULL;
 128
 129   *pLockBytes = &This->ILockBytes_iface;
 130
 131   return S_OK;
 132 }
 133
 134 /* ILockByte Interfaces */
 135
 136 static HRESULT WINAPI FileLockBytesImpl_QueryInterface(ILockBytes *iface, REFIID riid,
 137     void **ppvObject)
 138 {
 139     if (IsEqualIID(riid, &IID_IUnknown) || IsEqualIID(riid, &IID_ILockBytes))
 140         *ppvObject = iface;
 141     else
 142     {
 143         *ppvObject = NULL;
 144         return E_NOINTERFACE;
 145     }
 146
 147     IUnknown_AddRef((IUnknown*)*ppvObject);
 148
 149     return S_OK;
 150 }
 151
 152 static ULONG WINAPI FileLockBytesImpl_AddRef(ILockBytes *iface)
 153 {
 154     FileLockBytesImpl* This = impl_from_ILockBytes(iface);
 155     return InterlockedIncrement(&This->ref);
 156 }
 157
 158 static ULONG WINAPI FileLockBytesImpl_Release(ILockBytes *iface)
 159 {
 160     FileLockBytesImpl* This = impl_from_ILockBytes(iface);
 161     ULONG ref;
 162
 163     ref = InterlockedDecrement(&This->ref);
 164
 165     if (ref == 0)
 166     {
 167         CloseHandle(This->hfile);
 168         HeapFree(GetProcessHeap(), 0, This->pwcsName);
 169         HeapFree(GetProcessHeap(), 0, This);
 170     }
 171
 172     return ref;
 173 }
 174
 175 /******************************************************************************
 176  * This method is part of the ILockBytes interface.
 177  *
 178  * It reads a block of information from the byte array at the specified
 179  * offset.
 180  *
 181  * See the documentation of ILockBytes for more info.
 182  */
 183 static HRESULT WINAPI FileLockBytesImpl_ReadAt(
 184       ILockBytes* iface,
 185       ULARGE_INTEGER ulOffset,  /* [in] */
 186       void*          pv,        /* [length_is][size_is][out] */
 187       ULONG          cb,        /* [in] */
 188       ULONG*         pcbRead)   /* [out] */
 189 {
 190     FileLockBytesImpl* This = impl_from_ILockBytes(iface);
 191     ULONG bytes_left = cb;
 192     LPBYTE readPtr = pv;
 193     BOOL ret;
 194     LARGE_INTEGER offset;
 195     ULONG cbRead;
 196
 197     TRACE("(%p)-> %i %p %i %p\n",This, ulOffset.u.LowPart, pv, cb, pcbRead);
 198
 199     /* verify a sane environment */
 200     if (!This) return E_FAIL;
 201
 202     if (pcbRead)
 203         *pcbRead = 0;
 204
 205     offset.QuadPart = ulOffset.QuadPart;
 206
 207     ret = SetFilePointerEx(This->hfile, offset, NULL, FILE_BEGIN);
 208
 209     if (!ret)
 210         return STG_E_READFAULT;
 211
 212     while (bytes_left)
 213     {
 214         ret = ReadFile(This->hfile, readPtr, bytes_left, &cbRead, NULL);
 215
 216         if (!ret || cbRead == 0)
 217             return STG_E_READFAULT;
 218
 219         if (pcbRead)
 220             *pcbRead += cbRead;
 221
 222         bytes_left -= cbRead;
 223         readPtr += cbRead;
 224     }
 225
 226     TRACE("finished\n");
 227     return S_OK;
 228 }
 229
 230 /******************************************************************************
 231  * This method is part of the ILockBytes interface.
 232  *
 233  * It writes the specified bytes at the specified offset.
 234  * position. If the file is too small, it will be resized.
 235  *
 236  * See the documentation of ILockBytes for more info.
 237  */
 238 static HRESULT WINAPI FileLockBytesImpl_WriteAt(
 239       ILockBytes* iface,
 240       ULARGE_INTEGER ulOffset,    /* [in] */
 241       const void*    pv,          /* [size_is][in] */
 242       ULONG          cb,          /* [in] */
 243       ULONG*         pcbWritten)  /* [out] */
 244 {
 245     FileLockBytesImpl* This = impl_from_ILockBytes(iface);
 246     ULONG bytes_left = cb;
 247     const BYTE *writePtr = pv;
 248     BOOL ret;
 249     LARGE_INTEGER offset;
 250     ULONG cbWritten;
 251
 252     TRACE("(%p)-> %i %p %i %p\n",This, ulOffset.u.LowPart, pv, cb, pcbWritten);
 253
 254     /* verify a sane environment */
 255     if (!This) return E_FAIL;
 256
 257     if (This->flProtect != PAGE_READWRITE)
 258         return STG_E_ACCESSDENIED;
 259
 260     if (pcbWritten)
 261         *pcbWritten = 0;
 262
 263     offset.QuadPart = ulOffset.QuadPart;
 264
 265     ret = SetFilePointerEx(This->hfile, offset, NULL, FILE_BEGIN);
 266
 267     if (!ret)
 268         return STG_E_WRITEFAULT;
 269
 270     while (bytes_left)
 271     {
 272         ret = WriteFile(This->hfile, writePtr, bytes_left, &cbWritten, NULL);
 273
 274         if (!ret)
 275             return STG_E_WRITEFAULT;
 276
 277         if (pcbWritten)
 278             *pcbWritten += cbWritten;
 279
 280         bytes_left -= cbWritten;
 281         writePtr += cbWritten;
 282     }
 283
 284     TRACE("finished\n");
 285     return S_OK;
 286 }
 287
 288 static HRESULT WINAPI FileLockBytesImpl_Flush(ILockBytes* iface)
 289 {
 290     return S_OK;
 291 }
 292
 293 /******************************************************************************
 294  *      ILockBytes_SetSize
 295  *
 296  * Sets the size of the file.
 297  *
 298  */
 299 static HRESULT WINAPI FileLockBytesImpl_SetSize(ILockBytes* iface, ULARGE_INTEGER newSize)
 300 {
 301     FileLockBytesImpl* This = impl_from_ILockBytes(iface);
 302     HRESULT hr = S_OK;
 303     LARGE_INTEGER newpos;
 304
 305     TRACE("new size %u\n", newSize.u.LowPart);
 306
 307     newpos.QuadPart = newSize.QuadPart;
 308     if (SetFilePointerEx(This->hfile, newpos, NULL, FILE_BEGIN))
 309     {
 310         SetEndOfFile(This->hfile);
 311     }
 312
 313     return hr;
 314 }
 315
 316 static HRESULT get_lock_error(void)
 317 {
 318     switch (GetLastError())
 319     {
 320     case ERROR_LOCK_VIOLATION: return STG_E_LOCKVIOLATION; break;
 321     case ERROR_ACCESS_DENIED:  return STG_E_ACCESSDENIED; break;
 322     case ERROR_NOT_SUPPORTED:  return STG_E_INVALIDFUNCTION; break;
 323     default:
 324         FIXME("no mapping for error %d\n", GetLastError());
 325         return STG_E_INVALIDFUNCTION;
 326     }
 327 }
 328
 329 static HRESULT WINAPI FileLockBytesImpl_LockRegion(ILockBytes* iface,
 330     ULARGE_INTEGER libOffset, ULARGE_INTEGER cb, DWORD dwLockType)
 331 {
 332     FileLockBytesImpl* This = impl_from_ILockBytes(iface);
 333     OVERLAPPED ol;
 334     DWORD lock_flags = LOCKFILE_FAIL_IMMEDIATELY;
 335
 336     TRACE("ofs %u count %u flags %x\n", libOffset.u.LowPart, cb.u.LowPart, dwLockType);
 337
 338     if (dwLockType & LOCK_WRITE)
 339         return STG_E_INVALIDFUNCTION;
 340
 341     if (dwLockType & (LOCK_EXCLUSIVE|LOCK_ONLYONCE))
 342         lock_flags |= LOCKFILE_EXCLUSIVE_LOCK;
 343
 344     ol.hEvent = 0;
 345     ol.u.s.Offset = libOffset.u.LowPart;
 346     ol.u.s.OffsetHigh = libOffset.u.HighPart;
 347
 348     if (LockFileEx(This->hfile, lock_flags, 0, cb.u.LowPart, cb.u.HighPart, &ol))
 349         return S_OK;
 350     return get_lock_error();
 351 }
 352
 353 HRESULT FileLockBytesImpl_LockRegionSync(ILockBytes* iface,
 354     ULARGE_INTEGER libOffset, ULARGE_INTEGER cb)
 355 {
 356     FileLockBytesImpl* This = impl_from_ILockBytes(iface);
 357     OVERLAPPED ol;
 358
 359     if (iface->lpVtbl != &FileLockBytesImpl_Vtbl)
 360         return E_NOTIMPL;
 361
 362     ol.hEvent = 0;
 363     ol.u.s.Offset = libOffset.u.LowPart;
 364     ol.u.s.OffsetHigh = libOffset.u.HighPart;
 365
 366     if (LockFileEx(This->hfile, LOCKFILE_EXCLUSIVE_LOCK, 0, cb.u.LowPart, cb.u.HighPart, &ol))
 367         return S_OK;
 368     return get_lock_error();
 369 }
 370
 371 static HRESULT WINAPI FileLockBytesImpl_UnlockRegion(ILockBytes* iface,
 372     ULARGE_INTEGER libOffset, ULARGE_INTEGER cb, DWORD dwLockType)
 373 {
 374     FileLockBytesImpl* This = impl_from_ILockBytes(iface);
 375     OVERLAPPED ol;
 376
 377     TRACE("ofs %u count %u flags %x\n", libOffset.u.LowPart, cb.u.LowPart, dwLockType);
 378
 379     if (dwLockType & LOCK_WRITE)
 380         return STG_E_INVALIDFUNCTION;
 381
 382     ol.hEvent = 0;
 383     ol.u.s.Offset = libOffset.u.LowPart;
 384     ol.u.s.OffsetHigh = libOffset.u.HighPart;
 385
 386     if (UnlockFileEx(This->hfile, 0, cb.u.LowPart, cb.u.HighPart, &ol))
 387         return S_OK;
 388     return get_lock_error();
 389 }
 390
 391 static HRESULT WINAPI FileLockBytesImpl_Stat(ILockBytes* iface,
 392     STATSTG *pstatstg, DWORD grfStatFlag)
 393 {
 394     FileLockBytesImpl* This = impl_from_ILockBytes(iface);
 395
 396     if (!(STATFLAG_NONAME & grfStatFlag) && This->pwcsName)
 397     {
 398         pstatstg->pwcsName =
 399           CoTaskMemAlloc((lstrlenW(This->pwcsName)+1)*sizeof(WCHAR));
 400
 401         strcpyW(pstatstg->pwcsName, This->pwcsName);
 402     }
 403     else
 404         pstatstg->pwcsName = NULL;
 405
 406     pstatstg->type = STGTY_LOCKBYTES;
 407
 408     pstatstg->cbSize.u.LowPart = GetFileSize(This->hfile, &pstatstg->cbSize.u.HighPart);
 409     /* FIXME: If the implementation is exported, we'll need to set other fields. */
 410
 411     return S_OK;
 412 }
 413
 414 static const ILockBytesVtbl FileLockBytesImpl_Vtbl = {
 415     FileLockBytesImpl_QueryInterface,
 416     FileLockBytesImpl_AddRef,
 417     FileLockBytesImpl_Release,
 418     FileLockBytesImpl_ReadAt,
 419     FileLockBytesImpl_WriteAt,
 420     FileLockBytesImpl_Flush,
 421     FileLockBytesImpl_SetSize,
 422     FileLockBytesImpl_LockRegion,
 423     FileLockBytesImpl_UnlockRegion,
 424     FileLockBytesImpl_Stat
 425 };