dlls/propsys/propstore.c

   1 /*
   2  * standard IPropertyStore implementation
   3  *
   4  * Copyright 2012 Vincent Povirk for CodeWeavers
   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 #define COBJMACROS
  22 #include "config.h"
  23
  24 #include <stdarg.h>
  25
  26 #include "windef.h"
  27 #include "winbase.h"
  28 #include "objbase.h"
  29 #include "rpcproxy.h"
  30 #include "propsys.h"
  31 #include "wine/debug.h"
  32 #include "wine/unicode.h"
  33 #include "wine/list.h"
  34
  35 #include "initguid.h"
  36 #include "propsys_private.h"
  37
  38 DEFINE_GUID(FMTID_NamedProperties, 0xd5cdd505, 0x2e9c, 0x101b, 0x93, 0x97, 0x08, 0x00, 0x2b, 0x2c, 0xf9, 0xae);
  39
  40 WINE_DEFAULT_DEBUG_CHANNEL(propsys);
  41
  42 typedef struct {
  43     struct list entry;
  44     DWORD pid;
  45     PROPVARIANT propvar;
  46     PSC_STATE state;
  47 } propstore_value;
  48
  49 typedef struct {
  50     struct list entry;
  51     GUID fmtid;
  52     struct list values; /* list of struct propstore_value */
  53     DWORD count;
  54 } propstore_format;
  55
  56 typedef struct {
  57     IPropertyStoreCache IPropertyStoreCache_iface;
  58     LONG ref;
  59     CRITICAL_SECTION lock;
  60     struct list formats; /* list of struct propstore_format */
  61 } PropertyStore;
  62
  63 static inline PropertyStore *impl_from_IPropertyStoreCache(IPropertyStoreCache *iface)
  64 {
  65     return CONTAINING_RECORD(iface, PropertyStore, IPropertyStoreCache_iface);
  66 }
  67
  68 static HRESULT WINAPI PropertyStore_QueryInterface(IPropertyStoreCache *iface, REFIID iid,
  69     void **ppv)
  70 {
  71     PropertyStore *This = impl_from_IPropertyStoreCache(iface);
  72     TRACE("(%p,%s,%p)\n", iface, debugstr_guid(iid), ppv);
  73
  74     if (!ppv) return E_INVALIDARG;
  75
  76     if (IsEqualIID(&IID_IUnknown, iid) || IsEqualIID(&IID_IPropertyStore, iid) ||
  77         IsEqualIID(&IID_IPropertyStoreCache, iid))
  78     {
  79         *ppv = &This->IPropertyStoreCache_iface;
  80     }
  81     else
  82     {
  83         FIXME("No interface for %s\n", debugstr_guid(iid));
  84         *ppv = NULL;
  85         return E_NOINTERFACE;
  86     }
  87
  88     IUnknown_AddRef((IUnknown*)*ppv);
  89     return S_OK;
  90 }
  91
  92 static ULONG WINAPI PropertyStore_AddRef(IPropertyStoreCache *iface)
  93 {
  94     PropertyStore *This = impl_from_IPropertyStoreCache(iface);
  95     ULONG ref = InterlockedIncrement(&This->ref);
  96
  97     TRACE("(%p) refcount=%u\n", iface, ref);
  98
  99     return ref;
 100 }
 101
 102 static void destroy_format(propstore_format *format)
 103 {
 104     propstore_value *cursor, *cursor2;
 105     LIST_FOR_EACH_ENTRY_SAFE(cursor, cursor2, &format->values, propstore_value, entry)
 106     {
 107         PropVariantClear(&cursor->propvar);
 108         HeapFree(GetProcessHeap(), 0, cursor);
 109     }
 110     HeapFree(GetProcessHeap(), 0, format);
 111 }
 112
 113 static ULONG WINAPI PropertyStore_Release(IPropertyStoreCache *iface)
 114 {
 115     PropertyStore *This = impl_from_IPropertyStoreCache(iface);
 116     ULONG ref = InterlockedDecrement(&This->ref);
 117
 118     TRACE("(%p) refcount=%u\n", iface, ref);
 119
 120     if (ref == 0)
 121     {
 122         propstore_format *cursor, *cursor2;
 123         This->lock.DebugInfo->Spare[0] = 0;
 124         DeleteCriticalSection(&This->lock);
 125         LIST_FOR_EACH_ENTRY_SAFE(cursor, cursor2, &This->formats, propstore_format, entry)
 126             destroy_format(cursor);
 127         HeapFree(GetProcessHeap(), 0, This);
 128     }
 129
 130     return ref;
 131 }
 132
 133 static HRESULT WINAPI PropertyStore_GetCount(IPropertyStoreCache *iface,
 134     DWORD *cProps)
 135 {
 136     PropertyStore *This = impl_from_IPropertyStoreCache(iface);
 137     propstore_format *format;
 138
 139     TRACE("%p,%p\n", iface, cProps);
 140
 141     if (!cProps)
 142         return E_POINTER;
 143
 144     *cProps = 0;
 145
 146     EnterCriticalSection(&This->lock);
 147
 148     LIST_FOR_EACH_ENTRY(format, &This->formats, propstore_format, entry)
 149         *cProps += format->count;
 150
 151     LeaveCriticalSection(&This->lock);
 152
 153     return S_OK;
 154 }
 155
 156 static HRESULT WINAPI PropertyStore_GetAt(IPropertyStoreCache *iface,
 157     DWORD iProp, PROPERTYKEY *pkey)
 158 {
 159     PropertyStore *This = impl_from_IPropertyStoreCache(iface);
 160     propstore_format *format=NULL, *format_candidate;
 161     propstore_value *value;
 162     HRESULT hr;
 163
 164     TRACE("%p,%d,%p\n", iface, iProp, pkey);
 165
 166     if (!pkey)
 167         return E_POINTER;
 168
 169     EnterCriticalSection(&This->lock);
 170
 171     LIST_FOR_EACH_ENTRY(format_candidate, &This->formats, propstore_format, entry)
 172     {
 173         if (format_candidate->count > iProp)
 174         {
 175             format = format_candidate;
 176             pkey->fmtid = format->fmtid;
 177             break;
 178         }
 179
 180         iProp -= format_candidate->count;
 181     }
 182
 183     if (format)
 184     {
 185         LIST_FOR_EACH_ENTRY(value, &format->values, propstore_value, entry)
 186         {
 187             if (iProp == 0)
 188             {
 189                 pkey->pid = value->pid;
 190                 break;
 191             }
 192
 193             iProp--;
 194         }
 195
 196         hr = S_OK;
 197     }
 198     else
 199         hr = E_INVALIDARG;
 200
 201     LeaveCriticalSection(&This->lock);
 202
 203     return hr;
 204 }
 205
 206 static HRESULT PropertyStore_LookupValue(PropertyStore *This, REFPROPERTYKEY key,
 207     int insert, propstore_value **result)
 208 {
 209     propstore_format *format=NULL, *format_candidate;
 210     propstore_value *value=NULL, *value_candidate;
 211
 212     if (IsEqualGUID(&key->fmtid, &FMTID_NamedProperties))
 213     {
 214         /* This is used in the property store format [MS-PROPSTORE]
 215          * for named values and probably gets special treatment. */
 216         ERR("don't know how to handle FMTID_NamedProperties\n");
 217         return E_FAIL;
 218     }
 219
 220     LIST_FOR_EACH_ENTRY(format_candidate, &This->formats, propstore_format, entry)
 221     {
 222         if (IsEqualGUID(&format_candidate->fmtid, &key->fmtid))
 223         {
 224             format = format_candidate;
 225             break;
 226         }
 227     }
 228
 229     if (!format)
 230     {
 231         if (!insert)
 232             return TYPE_E_ELEMENTNOTFOUND;
 233
 234         format = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(*format));
 235         if (!format)
 236             return E_OUTOFMEMORY;
 237
 238         format->fmtid = key->fmtid;
 239         list_init(&format->values);
 240         list_add_tail(&This->formats, &format->entry);
 241     }
 242
 243     LIST_FOR_EACH_ENTRY(value_candidate, &format->values, propstore_value, entry)
 244     {
 245         if (value_candidate->pid == key->pid)
 246         {
 247             value = value_candidate;
 248             break;
 249         }
 250     }
 251
 252     if (!value)
 253     {
 254         if (!insert)
 255             return TYPE_E_ELEMENTNOTFOUND;
 256
 257         value = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(*value));
 258         if (!value)
 259             return E_OUTOFMEMORY;
 260
 261         value->pid = key->pid;
 262         list_add_tail(&format->values, &value->entry);
 263         format->count++;
 264     }
 265
 266     *result = value;
 267
 268     return S_OK;
 269 }
 270
 271 static HRESULT WINAPI PropertyStore_GetValue(IPropertyStoreCache *iface,
 272     REFPROPERTYKEY key, PROPVARIANT *pv)
 273 {
 274     PropertyStore *This = impl_from_IPropertyStoreCache(iface);
 275     propstore_value *value;
 276     HRESULT hr;
 277
 278     TRACE("%p,%p,%p\n", iface, key, pv);
 279
 280     if (!pv)
 281         return E_POINTER;
 282
 283     EnterCriticalSection(&This->lock);
 284
 285     hr = PropertyStore_LookupValue(This, key, 0, &value);
 286
 287     if (SUCCEEDED(hr))
 288         hr = PropVariantCopy(pv, &value->propvar);
 289     else if (hr == TYPE_E_ELEMENTNOTFOUND)
 290     {
 291         PropVariantInit(pv);
 292         hr = S_OK;
 293     }
 294
 295     LeaveCriticalSection(&This->lock);
 296
 297     return hr;
 298 }
 299
 300 static HRESULT WINAPI PropertyStore_SetValue(IPropertyStoreCache *iface,
 301     REFPROPERTYKEY key, REFPROPVARIANT propvar)
 302 {
 303     PropertyStore *This = impl_from_IPropertyStoreCache(iface);
 304     propstore_value *value;
 305     HRESULT hr;
 306
 307     TRACE("%p,%p,%p\n", iface, key, propvar);
 308
 309     EnterCriticalSection(&This->lock);
 310
 311     hr = PropertyStore_LookupValue(This, key, 1, &value);
 312
 313     if (SUCCEEDED(hr))
 314         hr = PropVariantCopy(&value->propvar, propvar);
 315
 316     LeaveCriticalSection(&This->lock);
 317
 318     return hr;
 319 }
 320
 321 static HRESULT WINAPI PropertyStore_Commit(IPropertyStoreCache *iface)
 322 {
 323     FIXME("%p: stub\n", iface);
 324     return S_OK;
 325 }
 326
 327 static HRESULT WINAPI PropertyStore_GetState(IPropertyStoreCache *iface,
 328     REFPROPERTYKEY key, PSC_STATE *pstate)
 329 {
 330     PropertyStore *This = impl_from_IPropertyStoreCache(iface);
 331     propstore_value *value;
 332     HRESULT hr;
 333
 334     TRACE("%p,%p,%p\n", iface, key, pstate);
 335
 336     EnterCriticalSection(&This->lock);
 337
 338     hr = PropertyStore_LookupValue(This, key, 0, &value);
 339
 340     if (SUCCEEDED(hr))
 341         *pstate = value->state;
 342
 343     LeaveCriticalSection(&This->lock);
 344
 345     if (FAILED(hr))
 346         *pstate = PSC_NORMAL;
 347
 348     return hr;
 349 }
 350
 351 static HRESULT WINAPI PropertyStore_GetValueAndState(IPropertyStoreCache *iface,
 352     REFPROPERTYKEY key, PROPVARIANT *ppropvar, PSC_STATE *pstate)
 353 {
 354     PropertyStore *This = impl_from_IPropertyStoreCache(iface);
 355     propstore_value *value;
 356     HRESULT hr;
 357
 358     TRACE("%p,%p,%p,%p\n", iface, key, ppropvar, pstate);
 359
 360     EnterCriticalSection(&This->lock);
 361
 362     hr = PropertyStore_LookupValue(This, key, 0, &value);
 363
 364     if (SUCCEEDED(hr))
 365         hr = PropVariantCopy(ppropvar, &value->propvar);
 366
 367     if (SUCCEEDED(hr))
 368         *pstate = value->state;
 369
 370     LeaveCriticalSection(&This->lock);
 371
 372     if (FAILED(hr))
 373     {
 374         PropVariantInit(ppropvar);
 375         *pstate = PSC_NORMAL;
 376     }
 377
 378     return hr;
 379 }
 380
 381 static HRESULT WINAPI PropertyStore_SetState(IPropertyStoreCache *iface,
 382     REFPROPERTYKEY key, PSC_STATE pstate)
 383 {
 384     PropertyStore *This = impl_from_IPropertyStoreCache(iface);
 385     propstore_value *value;
 386     HRESULT hr;
 387
 388     TRACE("%p,%p,%d\n", iface, key, pstate);
 389
 390     EnterCriticalSection(&This->lock);
 391
 392     hr = PropertyStore_LookupValue(This, key, 0, &value);
 393
 394     if (SUCCEEDED(hr))
 395         value->state = pstate;
 396
 397     LeaveCriticalSection(&This->lock);
 398
 399     return hr;
 400 }
 401
 402 static HRESULT WINAPI PropertyStore_SetValueAndState(IPropertyStoreCache *iface,
 403     REFPROPERTYKEY key, const PROPVARIANT *ppropvar, PSC_STATE state)
 404 {
 405     PropertyStore *This = impl_from_IPropertyStoreCache(iface);
 406     propstore_value *value;
 407     HRESULT hr;
 408
 409     TRACE("%p,%p,%p,%d\n", iface, key, ppropvar, state);
 410
 411     EnterCriticalSection(&This->lock);
 412
 413     hr = PropertyStore_LookupValue(This, key, 1, &value);
 414
 415     if (SUCCEEDED(hr))
 416         hr = PropVariantCopy(&value->propvar, ppropvar);
 417
 418     if (SUCCEEDED(hr))
 419         value->state = state;
 420
 421     LeaveCriticalSection(&This->lock);
 422
 423     return hr;
 424 }
 425
 426 static const IPropertyStoreCacheVtbl PropertyStore_Vtbl = {
 427     PropertyStore_QueryInterface,
 428     PropertyStore_AddRef,
 429     PropertyStore_Release,
 430     PropertyStore_GetCount,
 431     PropertyStore_GetAt,
 432     PropertyStore_GetValue,
 433     PropertyStore_SetValue,
 434     PropertyStore_Commit,
 435     PropertyStore_GetState,
 436     PropertyStore_GetValueAndState,
 437     PropertyStore_SetState,
 438     PropertyStore_SetValueAndState
 439 };
 440
 441 HRESULT PropertyStore_CreateInstance(IUnknown *pUnkOuter, REFIID iid, void** ppv)
 442 {
 443     PropertyStore *This;
 444     HRESULT ret;
 445
 446     TRACE("(%p,%s,%p)\n", pUnkOuter, debugstr_guid(iid), ppv);
 447
 448     *ppv = NULL;
 449
 450     if (pUnkOuter) return CLASS_E_NOAGGREGATION;
 451
 452     This = HeapAlloc(GetProcessHeap(), 0, sizeof(PropertyStore));
 453     if (!This) return E_OUTOFMEMORY;
 454
 455     This->IPropertyStoreCache_iface.lpVtbl = &PropertyStore_Vtbl;
 456     This->ref = 1;
 457     InitializeCriticalSection(&This->lock);
 458     This->lock.DebugInfo->Spare[0] = (DWORD_PTR)(__FILE__ ": PropertyStore.lock");
 459     list_init(&This->formats);
 460
 461     ret = IPropertyStoreCache_QueryInterface(&This->IPropertyStoreCache_iface, iid, ppv);
 462     IPropertyStoreCache_Release(&This->IPropertyStoreCache_iface);
 463
 464     return ret;
 465 }