ole/storage32.c

   1 /*
   2  * Compound Storage (32 bit version)
   3  * Storage implementation
   4  *
   5  * This file contains the compound file implementation
   6  * of the storage interface.
   7  *
   8  * Copyright 1999 Francis Beaudet
   9  * Copyright 1999 Sylvain St-Germain
  10  * Copyright 1999 Thuy Nguyen
  11  */
  12
  13 #include <assert.h>
  14 #include <stdlib.h>
  15 #include <stdio.h>
  16 #include <string.h>
  17
  18 #include "winbase.h"
  19 #include "winerror.h"
  20 #include "wine/obj_storage.h"
  21 #include "wine/winestring.h"
  22 #include "crtdll.h"
  23 #include "tchar.h"
  24 #include "debugtools.h"
  25 #include "windef.h"
  26
  27 #include "storage32.h"
  28 #include "ole2.h"
  29
  30 DEFAULT_DEBUG_CHANNEL(storage)
  31
  32 #define FILE_BEGIN 0
  33
  34 static const char rootPropertyName[] = "Root Entry";
  35
  36 /***********************************************************************
  37  * Forward declaration of internal functions used by the method DestroyElement
  38  */
  39 static HRESULT deleteStorageProperty(
  40   StorageImpl *parentStorage,
  41   OLECHAR     *propertyToDeleteName);
  42
  43 static HRESULT deleteStreamProperty(
  44   StorageImpl *parentStorage,
  45   ULONG         foundPropertyIndexToDelete,
  46   StgProperty   propertyToDelete);
  47
  48 static HRESULT findPlaceholder(
  49   StorageImpl *storage,
  50   ULONG         propertyIndexToStore,
  51   ULONG         storagePropertyIndex,
  52   INT         typeOfRelation);
  53
  54 static HRESULT adjustPropertyChain(
  55   StorageImpl *This,
  56   StgProperty   propertyToDelete,
  57   StgProperty   parentProperty,
  58   ULONG         parentPropertyId,
  59   INT         typeOfRelation);
  60
  61 /***********************************************************************
  62  * Declaration of the functions used to manipulate StgProperty
  63  */
  64
  65 static ULONG getFreeProperty(
  66   StorageImpl *storage);
  67
  68 static void updatePropertyChain(
  69   StorageImpl *storage,
  70   ULONG       newPropertyIndex,
  71   StgProperty newProperty);
  72
  73 static LONG propertyNameCmp(
  74   OLECHAR *newProperty,
  75   OLECHAR *currentProperty);
  76
  77
  78 /***********************************************************************
  79  * Declaration of miscellaneous functions...
  80  */
  81 static HRESULT validateSTGM(DWORD stgmValue);
  82
  83 static DWORD GetShareModeFromSTGM(DWORD stgm);
  84 static DWORD GetAccessModeFromSTGM(DWORD stgm);
  85 static DWORD GetCreationModeFromSTGM(DWORD stgm);
  86
  87 /*
  88  * Virtual function table for the IStorage32Impl class.
  89  */
  90 static ICOM_VTABLE(IStorage) Storage32Impl_Vtbl =
  91 {
  92     ICOM_MSVTABLE_COMPAT_DummyRTTIVALUE
  93     StorageBaseImpl_QueryInterface,
  94     StorageBaseImpl_AddRef,
  95     StorageBaseImpl_Release,
  96     StorageBaseImpl_CreateStream,
  97     StorageBaseImpl_OpenStream,
  98     StorageImpl_CreateStorage,
  99     StorageBaseImpl_OpenStorage,
 100     StorageImpl_CopyTo,
 101     StorageImpl_MoveElementTo,
 102     StorageImpl_Commit,
 103     StorageImpl_Revert,
 104     StorageBaseImpl_EnumElements,
 105     StorageImpl_DestroyElement,
 106     StorageBaseImpl_RenameElement,
 107     StorageImpl_SetElementTimes,
 108     StorageBaseImpl_SetClass,
 109     StorageImpl_SetStateBits,
 110     StorageBaseImpl_Stat
 111 };
 112
 113 /*
 114  * Virtual function table for the Storage32InternalImpl class.
 115  */
 116 static ICOM_VTABLE(IStorage) Storage32InternalImpl_Vtbl =
 117   {
 118     ICOM_MSVTABLE_COMPAT_DummyRTTIVALUE
 119     StorageBaseImpl_QueryInterface,
 120     StorageBaseImpl_AddRef,
 121     StorageBaseImpl_Release,
 122     StorageBaseImpl_CreateStream,
 123     StorageBaseImpl_OpenStream,
 124     StorageImpl_CreateStorage,
 125     StorageBaseImpl_OpenStorage,
 126     StorageImpl_CopyTo,
 127     StorageImpl_MoveElementTo,
 128     StorageInternalImpl_Commit,
 129     StorageInternalImpl_Revert,
 130     StorageBaseImpl_EnumElements,
 131     StorageImpl_DestroyElement,
 132     StorageBaseImpl_RenameElement,
 133     StorageImpl_SetElementTimes,
 134     StorageBaseImpl_SetClass,
 135     StorageImpl_SetStateBits,
 136     StorageBaseImpl_Stat
 137 };
 138
 139 /*
 140  * Virtual function table for the IEnumSTATSTGImpl class.
 141  */
 142 static ICOM_VTABLE(IEnumSTATSTG) IEnumSTATSTGImpl_Vtbl =
 143 {
 144     ICOM_MSVTABLE_COMPAT_DummyRTTIVALUE
 145     IEnumSTATSTGImpl_QueryInterface,
 146     IEnumSTATSTGImpl_AddRef,
 147     IEnumSTATSTGImpl_Release,
 148     IEnumSTATSTGImpl_Next,
 149     IEnumSTATSTGImpl_Skip,
 150     IEnumSTATSTGImpl_Reset,
 151     IEnumSTATSTGImpl_Clone
 152 };
 153
 154
 155
 156
 157
 158 /************************************************************************
 159 ** Storage32BaseImpl implementatiion
 160 */
 161
 162 /************************************************************************
 163  * Storage32BaseImpl_QueryInterface (IUnknown)
 164  *
 165  * This method implements the common QueryInterface for all IStorage32
 166  * implementations contained in this file.
 167  *
 168  * See Windows documentation for more details on IUnknown methods.
 169  */
 170 HRESULT WINAPI StorageBaseImpl_QueryInterface(
 171   IStorage*        iface,
 172   REFIID             riid,
 173   void**             ppvObject)
 174 {
 175   ICOM_THIS(StorageBaseImpl,iface);
 176   /*
 177    * Perform a sanity check on the parameters.
 178    */
 179   if ( (This==0) || (ppvObject==0) )
 180     return E_INVALIDARG;
 181
 182   /*
 183    * Initialize the return parameter.
 184    */
 185   *ppvObject = 0;
 186
 187   /*
 188    * Compare the riid with the interface IDs implemented by this object.
 189    */
 190   if (memcmp(&IID_IUnknown, riid, sizeof(IID_IUnknown)) == 0)
 191   {
 192     *ppvObject = (IStorage*)This;
 193   }
 194   else if (memcmp(&IID_IStorage, riid, sizeof(IID_IStorage)) == 0)
 195   {
 196     *ppvObject = (IStorage*)This;
 197   }
 198
 199   /*
 200    * Check that we obtained an interface.
 201    */
 202   if ((*ppvObject)==0)
 203     return E_NOINTERFACE;
 204
 205   /*
 206    * Query Interface always increases the reference count by one when it is
 207    * successful
 208    */
 209   StorageBaseImpl_AddRef(iface);
 210
 211   return S_OK;
 212 }
 213
 214 /************************************************************************
 215  * Storage32BaseImpl_AddRef (IUnknown)
 216  *
 217  * This method implements the common AddRef for all IStorage32
 218  * implementations contained in this file.
 219  *
 220  * See Windows documentation for more details on IUnknown methods.
 221  */
 222 ULONG WINAPI StorageBaseImpl_AddRef(
 223             IStorage* iface)
 224 {
 225   ICOM_THIS(StorageBaseImpl,iface);
 226   This->ref++;
 227
 228   return This->ref;
 229 }
 230
 231 /************************************************************************
 232  * Storage32BaseImpl_Release (IUnknown)
 233  *
 234  * This method implements the common Release for all IStorage32
 235  * implementations contained in this file.
 236  *
 237  * See Windows documentation for more details on IUnknown methods.
 238  */
 239 ULONG WINAPI StorageBaseImpl_Release(
 240       IStorage* iface)
 241 {
 242   ICOM_THIS(StorageBaseImpl,iface);
 243   /*
 244    * Decrease the reference count on this object.
 245    */
 246   This->ref--;
 247
 248   /*
 249    * If the reference count goes down to 0, perform suicide.
 250    */
 251   if (This->ref==0)
 252   {
 253     /*
 254      * Since we are using a system of base-classes, we want to call the
 255      * destructor of the appropriate derived class. To do this, we are
 256      * using virtual functions to implement the destructor.
 257      */
 258     This->v_destructor(This);
 259
 260     return 0;
 261   }
 262
 263   return This->ref;
 264 }
 265
 266 /************************************************************************
 267  * Storage32BaseImpl_OpenStream (IStorage)
 268  *
 269  * This method will open the specified stream object from the current storage.
 270  *
 271  * See Windows documentation for more details on IStorage methods.
 272  */
 273 HRESULT WINAPI StorageBaseImpl_OpenStream(
 274   IStorage*        iface,
 275   const OLECHAR*   pwcsName,  /* [string][in] */
 276   void*            reserved1, /* [unique][in] */
 277   DWORD            grfMode,   /* [in]  */
 278   DWORD            reserved2, /* [in]  */
 279   IStream**        ppstm)     /* [out] */
 280 {
 281   ICOM_THIS(StorageBaseImpl,iface);
 282   IEnumSTATSTGImpl* propertyEnumeration;
 283   StgStreamImpl*    newStream;
 284   StgProperty       currentProperty;
 285   ULONG             foundPropertyIndex;
 286
 287   TRACE("(%p, %s, %p, %lx, %ld, %p)\n",
 288         iface, debugstr_w(pwcsName), reserved1, grfMode, reserved2, ppstm);
 289
 290   /*
 291    * Perform a sanity check on the parameters.
 292    */
 293   if ( (pwcsName==NULL) || (ppstm==0) )
 294     return E_INVALIDARG;
 295
 296   /*
 297    * Initialize the out parameter
 298    */
 299   *ppstm = 0;
 300
 301   /*
 302    * Validate the STGM flags
 303    */
 304   if ( FAILED( validateSTGM(grfMode) ))
 305     return STG_E_INVALIDFLAG;
 306
 307   /*
 308    * As documented.
 309    */
 310   if ( !(grfMode & STGM_SHARE_EXCLUSIVE) ||
 311         (grfMode & STGM_DELETEONRELEASE) ||
 312         (grfMode & STGM_TRANSACTED) )
 313     return STG_E_INVALIDFUNCTION;
 314
 315   /*
 316    * Create a property enumeration to search the properties
 317    */
 318   propertyEnumeration = IEnumSTATSTGImpl_Construct(
 319     This->ancestorStorage,
 320     This->rootPropertySetIndex);
 321
 322   /*
 323    * Search the enumeration for the property with the given name
 324    */
 325   foundPropertyIndex = IEnumSTATSTGImpl_FindProperty(
 326     propertyEnumeration,
 327     pwcsName,
 328     &currentProperty);
 329
 330   /*
 331    * Delete the property enumeration since we don't need it anymore
 332    */
 333   IEnumSTATSTGImpl_Destroy(propertyEnumeration);
 334
 335   /*
 336    * If it was found, construct the stream object and return a pointer to it.
 337    */
 338   if ( (foundPropertyIndex!=PROPERTY_NULL) &&
 339        (currentProperty.propertyType==PROPTYPE_STREAM) )
 340   {
 341     newStream = StgStreamImpl_Construct(This, foundPropertyIndex);
 342
 343     if (newStream!=0)
 344     {
 345       *ppstm = (IStream*)newStream;
 346
 347       /*
 348        * Since we are returning a pointer to the interface, we have to
 349        * nail down the reference.
 350        */
 351       StgStreamImpl_AddRef(*ppstm);
 352
 353       return S_OK;
 354     }
 355
 356     return E_OUTOFMEMORY;
 357   }
 358
 359   return STG_E_FILENOTFOUND;
 360 }
 361
 362 /************************************************************************
 363  * Storage32BaseImpl_OpenStorage (IStorage)
 364  *
 365  * This method will open a new storage object from the current storage.
 366  *
 367  * See Windows documentation for more details on IStorage methods.
 368  */
 369 HRESULT WINAPI StorageBaseImpl_OpenStorage(
 370   IStorage*        iface,
 371   const OLECHAR*   pwcsName,      /* [string][unique][in] */
 372   IStorage*        pstgPriority,  /* [unique][in] */
 373   DWORD            grfMode,       /* [in] */
 374   SNB              snbExclude,    /* [unique][in] */
 375   DWORD            reserved,      /* [in] */
 376   IStorage**       ppstg)         /* [out] */
 377 {
 378   ICOM_THIS(StorageBaseImpl,iface);
 379   StorageInternalImpl* newStorage;
 380   IEnumSTATSTGImpl*      propertyEnumeration;
 381   StgProperty            currentProperty;
 382   ULONG                  foundPropertyIndex;
 383
 384   TRACE("(%p, %s, %p, %lx, %p, %ld, %p)\n",
 385         iface, debugstr_w(pwcsName), pstgPriority,
 386         grfMode, snbExclude, reserved, ppstg);
 387
 388   /*
 389    * Perform a sanity check on the parameters.
 390    */
 391   if ( (This==0) || (pwcsName==NULL) || (ppstg==0) )
 392     return E_INVALIDARG;
 393
 394   /*
 395    * Validate the STGM flags
 396    */
 397   if ( FAILED( validateSTGM(grfMode) ))
 398     return STG_E_INVALIDFLAG;
 399
 400   /*
 401    * As documented.
 402    */
 403   if ( !(grfMode & STGM_SHARE_EXCLUSIVE) ||
 404         (grfMode & STGM_DELETEONRELEASE) ||
 405         (grfMode & STGM_PRIORITY) )
 406     return STG_E_INVALIDFUNCTION;
 407
 408   /*
 409    * Initialize the out parameter
 410    */
 411   *ppstg = 0;
 412
 413   /*
 414    * Create a property enumeration to search the properties
 415    */
 416   propertyEnumeration = IEnumSTATSTGImpl_Construct(
 417                           This->ancestorStorage,
 418                           This->rootPropertySetIndex);
 419
 420   /*
 421    * Search the enumeration for the property with the given name
 422    */
 423   foundPropertyIndex = IEnumSTATSTGImpl_FindProperty(
 424                          propertyEnumeration,
 425                          pwcsName,
 426                          &currentProperty);
 427
 428   /*
 429    * Delete the property enumeration since we don't need it anymore
 430    */
 431   IEnumSTATSTGImpl_Destroy(propertyEnumeration);
 432
 433   /*
 434    * If it was found, construct the stream object and return a pointer to it.
 435    */
 436   if ( (foundPropertyIndex!=PROPERTY_NULL) &&
 437        (currentProperty.propertyType==PROPTYPE_STORAGE) )
 438   {
 439     /*
 440      * Construct a new Storage object
 441      */
 442     newStorage = StorageInternalImpl_Construct(
 443                    This->ancestorStorage,
 444                    foundPropertyIndex);
 445
 446     if (newStorage != 0)
 447     {
 448       *ppstg = (IStorage*)newStorage;
 449
 450       /*
 451        * Since we are returning a pointer to the interface,
 452        * we have to nail down the reference.
 453        */
 454       StorageBaseImpl_AddRef(*ppstg);
 455
 456       return S_OK;
 457     }
 458
 459     return STG_E_INSUFFICIENTMEMORY;
 460   }
 461
 462   return STG_E_FILENOTFOUND;
 463 }
 464
 465 /************************************************************************
 466  * Storage32BaseImpl_EnumElements (IStorage)
 467  *
 468  * This method will create an enumerator object that can be used to
 469  * retrieve informatino about all the properties in the storage object.
 470  *
 471  * See Windows documentation for more details on IStorage methods.
 472  */
 473 HRESULT WINAPI StorageBaseImpl_EnumElements(
 474   IStorage*       iface,
 475   DWORD           reserved1, /* [in] */
 476   void*           reserved2, /* [size_is][unique][in] */
 477   DWORD           reserved3, /* [in] */
 478   IEnumSTATSTG**  ppenum)    /* [out] */
 479 {
 480   ICOM_THIS(StorageBaseImpl,iface);
 481   IEnumSTATSTGImpl* newEnum;
 482
 483   TRACE("(%p, %ld, %p, %ld, %p)\n",
 484         iface, reserved1, reserved2, reserved3, ppenum);
 485
 486   /*
 487    * Perform a sanity check on the parameters.
 488    */
 489   if ( (This==0) || (ppenum==0))
 490     return E_INVALIDARG;
 491
 492   /*
 493    * Construct the enumerator.
 494    */
 495   newEnum = IEnumSTATSTGImpl_Construct(
 496               This->ancestorStorage,
 497               This->rootPropertySetIndex);
 498
 499   if (newEnum!=0)
 500   {
 501     *ppenum = (IEnumSTATSTG*)newEnum;
 502
 503     /*
 504      * Don't forget to nail down a reference to the new object before
 505      * returning it.
 506      */
 507     IEnumSTATSTGImpl_AddRef(*ppenum);
 508
 509     return S_OK;
 510   }
 511
 512   return E_OUTOFMEMORY;
 513 }
 514
 515 /************************************************************************
 516  * Storage32BaseImpl_Stat (IStorage)
 517  *
 518  * This method will retrieve information about this storage object.
 519  *
 520  * See Windows documentation for more details on IStorage methods.
 521  */
 522 HRESULT WINAPI StorageBaseImpl_Stat(
 523   IStorage*        iface,
 524   STATSTG*         pstatstg,     /* [out] */
 525   DWORD            grfStatFlag)  /* [in] */
 526 {
 527   ICOM_THIS(StorageBaseImpl,iface);
 528   StgProperty    curProperty;
 529   BOOL         readSucessful;
 530
 531   TRACE("(%p, %p, %lx)\n",
 532         iface, pstatstg, grfStatFlag);
 533
 534   /*
 535    * Perform a sanity check on the parameters.
 536    */
 537   if ( (This==0) || (pstatstg==0))
 538     return E_INVALIDARG;
 539
 540   /*
 541    * Read the information from the property.
 542    */
 543   readSucessful = StorageImpl_ReadProperty(
 544                     This->ancestorStorage,
 545                     This->rootPropertySetIndex,
 546                     &curProperty);
 547
 548   if (readSucessful)
 549   {
 550     StorageUtl_CopyPropertyToSTATSTG(
 551       pstatstg,
 552       &curProperty,
 553       grfStatFlag);
 554
 555     return S_OK;
 556   }
 557
 558   return E_FAIL;
 559 }
 560
 561 /************************************************************************
 562  * Storage32BaseImpl_RenameElement (IStorage)
 563  *
 564  * This method will rename the specified element.
 565  *
 566  * See Windows documentation for more details on IStorage methods.
 567  *
 568  * Implementation notes: The method used to rename consists of creating a clone
 569  *    of the deleted StgProperty object setting it with the new name and to
 570  *    perform a DestroyElement of the old StgProperty.
 571  */
 572 HRESULT WINAPI StorageBaseImpl_RenameElement(
 573             IStorage*        iface,
 574             const OLECHAR*   pwcsOldName,  /* [in] */
 575             const OLECHAR*   pwcsNewName)  /* [in] */
 576 {
 577   ICOM_THIS(StorageBaseImpl,iface);
 578   IEnumSTATSTGImpl* propertyEnumeration;
 579   StgProperty       currentProperty;
 580   ULONG             foundPropertyIndex;
 581
 582   TRACE("(%p, %s, %s)\n",
 583         iface, debugstr_w(pwcsOldName), debugstr_w(pwcsNewName));
 584
 585   /*
 586    * Create a property enumeration to search the properties
 587    */
 588   propertyEnumeration = IEnumSTATSTGImpl_Construct(This->ancestorStorage,
 589                                                    This->rootPropertySetIndex);
 590
 591   /*
 592    * Search the enumeration for the new property name
 593    */
 594   foundPropertyIndex = IEnumSTATSTGImpl_FindProperty(propertyEnumeration,
 595                                                      pwcsNewName,
 596                                                      &currentProperty);
 597
 598   if (foundPropertyIndex != PROPERTY_NULL)
 599   {
 600     /*
 601      * There is already a property with the new name
 602      */
 603     IEnumSTATSTGImpl_Destroy(propertyEnumeration);
 604     return STG_E_FILEALREADYEXISTS;
 605   }
 606
 607   IEnumSTATSTGImpl_Reset((IEnumSTATSTG*)propertyEnumeration);
 608
 609   /*
 610    * Search the enumeration for the old property name
 611    */
 612   foundPropertyIndex = IEnumSTATSTGImpl_FindProperty(propertyEnumeration,
 613                                                      pwcsOldName,
 614                                                      &currentProperty);
 615
 616   /*
 617    * Delete the property enumeration since we don't need it anymore
 618    */
 619   IEnumSTATSTGImpl_Destroy(propertyEnumeration);
 620
 621   if (foundPropertyIndex != PROPERTY_NULL)
 622   {
 623     StgProperty renamedProperty;
 624     ULONG       renamedPropertyIndex;
 625
 626     /*
 627      * Setup a new property for the renamed property
 628      */
 629     renamedProperty.sizeOfNameString =
 630       ( lstrlenW(pwcsNewName)+1 ) * sizeof(WCHAR);
 631
 632     if (renamedProperty.sizeOfNameString > PROPERTY_NAME_BUFFER_LEN)
 633       return STG_E_INVALIDNAME;
 634
 635     lstrcpyW(renamedProperty.name, pwcsNewName);
 636
 637     renamedProperty.propertyType  = currentProperty.propertyType;
 638     renamedProperty.startingBlock = currentProperty.startingBlock;
 639     renamedProperty.size.LowPart  = currentProperty.size.LowPart;
 640     renamedProperty.size.HighPart = currentProperty.size.HighPart;
 641
 642     renamedProperty.previousProperty = PROPERTY_NULL;
 643     renamedProperty.nextProperty     = PROPERTY_NULL;
 644
 645     /*
 646      * Bring the dirProperty link in case it is a storage and in which
 647      * case the renamed storage elements don't require to be reorganized.
 648      */
 649     renamedProperty.dirProperty = currentProperty.dirProperty;
 650
 651     /* call CoFileTime to get the current time
 652     renamedProperty.timeStampS1
 653     renamedProperty.timeStampD1
 654     renamedProperty.timeStampS2
 655     renamedProperty.timeStampD2
 656     renamedProperty.propertyUniqueID
 657     */
 658
 659     /*
 660      * Obtain a free property in the property chain
 661      */
 662     renamedPropertyIndex = getFreeProperty(This->ancestorStorage);
 663
 664     /*
 665      * Save the new property into the new property spot
 666      */
 667     StorageImpl_WriteProperty(
 668       This->ancestorStorage,
 669       renamedPropertyIndex,
 670       &renamedProperty);
 671
 672     /*
 673      * Find a spot in the property chain for our newly created property.
 674      */
 675     updatePropertyChain(
 676       (StorageImpl*)This,
 677       renamedPropertyIndex,
 678       renamedProperty);
 679
 680     /*
 681      * At this point the renamed property has been inserted in the tree,
 682      * now, before to Destroy the old property we must zeroed it's dirProperty
 683      * otherwise the DestroyProperty below will zap it all and we do not want
 684      * this to happen.
 685      * Also, we fake that the old property is a storage so the DestroyProperty
 686      * will not do a SetSize(0) on the stream data.
 687      *
 688      * This means that we need to tweek the StgProperty if it is a stream or a
 689      * non empty storage.
 690      */
 691     currentProperty.dirProperty  = PROPERTY_NULL;
 692     currentProperty.propertyType = PROPTYPE_STORAGE;
 693     StorageImpl_WriteProperty(
 694       This->ancestorStorage,
 695       foundPropertyIndex,
 696       &currentProperty);
 697
 698     /*
 699      * Invoke Destroy to get rid of the ole property and automatically redo
 700      * the linking of it's previous and next members...
 701      */
 702     StorageImpl_DestroyElement((IStorage*)This->ancestorStorage, pwcsOldName);
 703
 704   }
 705   else
 706   {
 707     /*
 708      * There is no property with the old name
 709      */
 710     return STG_E_FILENOTFOUND;
 711   }
 712
 713   return S_OK;
 714 }
 715
 716 /************************************************************************
 717  * Storage32BaseImpl_CreateStream (IStorage)
 718  *
 719  * This method will create a stream object within this storage
 720  *
 721  * See Windows documentation for more details on IStorage methods.
 722  */
 723 HRESULT WINAPI StorageBaseImpl_CreateStream(
 724             IStorage*        iface,
 725             const OLECHAR*   pwcsName,  /* [string][in] */
 726             DWORD            grfMode,   /* [in] */
 727             DWORD            reserved1, /* [in] */
 728             DWORD            reserved2, /* [in] */
 729             IStream**        ppstm)     /* [out] */
 730 {
 731   ICOM_THIS(StorageBaseImpl,iface);
 732   IEnumSTATSTGImpl* propertyEnumeration;
 733   StgStreamImpl*    newStream;
 734   StgProperty       currentProperty, newStreamProperty;
 735   ULONG             foundPropertyIndex, newPropertyIndex;
 736
 737   TRACE("(%p, %s, %lx, %ld, %ld, %p)\n",
 738         iface, debugstr_w(pwcsName), grfMode,
 739         reserved1, reserved2, ppstm);
 740
 741   /*
 742    * Validate parameters
 743    */
 744   if (ppstm == 0)
 745     return STG_E_INVALIDPOINTER;
 746
 747   if (pwcsName == 0)
 748     return STG_E_INVALIDNAME;
 749
 750   /*
 751    * Validate the STGM flags
 752    */
 753   if ( FAILED( validateSTGM(grfMode) ))
 754     return STG_E_INVALIDFLAG;
 755
 756   /*
 757    * As documented.
 758    */
 759   if ( !(grfMode & STGM_SHARE_EXCLUSIVE) ||
 760         (grfMode & STGM_DELETEONRELEASE) ||
 761         (grfMode & STGM_TRANSACTED) )
 762     return STG_E_INVALIDFUNCTION;
 763
 764   /*
 765    * Initialize the out parameter
 766    */
 767   *ppstm = 0;
 768
 769   /*
 770    * Create a property enumeration to search the properties
 771    */
 772   propertyEnumeration = IEnumSTATSTGImpl_Construct(This->ancestorStorage,
 773                                                    This->rootPropertySetIndex);
 774
 775   foundPropertyIndex = IEnumSTATSTGImpl_FindProperty(propertyEnumeration,
 776                                                      pwcsName,
 777                                                      &currentProperty);
 778
 779   IEnumSTATSTGImpl_Destroy(propertyEnumeration);
 780
 781   if (foundPropertyIndex != PROPERTY_NULL)
 782   {
 783     /*
 784      * An element with this name already exists
 785      */
 786     if (grfMode & STGM_CREATE)
 787     {
 788       IStorage_DestroyElement(iface, pwcsName);
 789     }
 790     else
 791       return STG_E_FILEALREADYEXISTS;
 792   }
 793
 794   /*
 795    * memset the empty property
 796    */
 797   memset(&newStreamProperty, 0, sizeof(StgProperty));
 798
 799   newStreamProperty.sizeOfNameString =
 800       ( lstrlenW(pwcsName)+1 ) * sizeof(WCHAR);
 801
 802   if (newStreamProperty.sizeOfNameString > PROPERTY_NAME_BUFFER_LEN)
 803     return STG_E_INVALIDNAME;
 804
 805   lstrcpyW(newStreamProperty.name, pwcsName);
 806
 807   newStreamProperty.propertyType  = PROPTYPE_STREAM;
 808   newStreamProperty.startingBlock = BLOCK_END_OF_CHAIN;
 809   newStreamProperty.size.LowPart  = 0;
 810   newStreamProperty.size.HighPart = 0;
 811
 812   newStreamProperty.previousProperty = PROPERTY_NULL;
 813   newStreamProperty.nextProperty     = PROPERTY_NULL;
 814   newStreamProperty.dirProperty      = PROPERTY_NULL;
 815
 816   /* call CoFileTime to get the current time
 817   newStreamProperty.timeStampS1
 818   newStreamProperty.timeStampD1
 819   newStreamProperty.timeStampS2
 820   newStreamProperty.timeStampD2
 821   */
 822
 823   /*  newStreamProperty.propertyUniqueID */
 824
 825   /*
 826    * Get a free property or create a new one
 827    */
 828   newPropertyIndex = getFreeProperty(This->ancestorStorage);
 829
 830   /*
 831    * Save the new property into the new property spot
 832    */
 833   StorageImpl_WriteProperty(
 834     This->ancestorStorage,
 835     newPropertyIndex,
 836     &newStreamProperty);
 837
 838   /*
 839    * Find a spot in the property chain for our newly created property.
 840    */
 841   updatePropertyChain(
 842     (StorageImpl*)This,
 843     newPropertyIndex,
 844     newStreamProperty);
 845
 846   /*
 847    * Open the stream to return it.
 848    */
 849   newStream = StgStreamImpl_Construct(This, newPropertyIndex);
 850
 851   if (newStream != 0)
 852   {
 853     *ppstm = (IStream*)newStream;
 854
 855     /*
 856      * Since we are returning a pointer to the interface, we have to nail down
 857      * the reference.
 858      */
 859     StgStreamImpl_AddRef(*ppstm);
 860   }
 861   else
 862   {
 863     return STG_E_INSUFFICIENTMEMORY;
 864   }
 865
 866   return S_OK;
 867 }
 868
 869 /************************************************************************
 870  * Storage32BaseImpl_SetClass (IStorage)
 871  *
 872  * This method will write the specified CLSID in the property of this
 873  * storage.
 874  *
 875  * See Windows documentation for more details on IStorage methods.
 876  */
 877 HRESULT WINAPI StorageBaseImpl_SetClass(
 878   IStorage*        iface,
 879   REFCLSID         clsid) /* [in] */
 880 {
 881   ICOM_THIS(StorageBaseImpl,iface);
 882   HRESULT hRes = E_FAIL;
 883   StgProperty curProperty;
 884   BOOL success;
 885
 886   TRACE("(%p, %p)\n", iface, clsid);
 887
 888   success = StorageImpl_ReadProperty(This->ancestorStorage,
 889                                        This->rootPropertySetIndex,
 890                                        &curProperty);
 891   if (success)
 892   {
 893     curProperty.propertyUniqueID = *clsid;
 894
 895     success =  StorageImpl_WriteProperty(This->ancestorStorage,
 896                                            This->rootPropertySetIndex,
 897                                            &curProperty);
 898     if (success)
 899       hRes = S_OK;
 900   }
 901
 902   return hRes;
 903 }
 904
 905 /************************************************************************
 906 ** Storage32Impl implementation
 907 */
 908
 909 /************************************************************************
 910  * Storage32Impl_CreateStorage (IStorage)
 911  *
 912  * This method will create the storage object within the provided storage.
 913  *
 914  * See Windows documentation for more details on IStorage methods.
 915  */
 916 HRESULT WINAPI StorageImpl_CreateStorage(
 917   IStorage*      iface,
 918   const OLECHAR  *pwcsName, /* [string][in] */
 919   DWORD            grfMode,   /* [in] */
 920   DWORD            reserved1, /* [in] */
 921   DWORD            reserved2, /* [in] */
 922   IStorage       **ppstg)   /* [out] */
 923 {
 924   StorageImpl* const This=(StorageImpl*)iface;
 925
 926   IEnumSTATSTGImpl *propertyEnumeration;
 927   StgProperty      currentProperty;
 928   StgProperty      newProperty;
 929   ULONG            foundPropertyIndex;
 930   ULONG            newPropertyIndex;
 931   HRESULT          hr;
 932
 933   TRACE("(%p, %s, %lx, %ld, %ld, %p)\n",
 934         iface, debugstr_w(pwcsName), grfMode,
 935         reserved1, reserved2, ppstg);
 936
 937   /*
 938    * Validate parameters
 939    */
 940   if (ppstg == 0)
 941     return STG_E_INVALIDPOINTER;
 942
 943   if (pwcsName == 0)
 944     return STG_E_INVALIDNAME;
 945
 946   /*
 947    * Validate the STGM flags
 948    */
 949   if ( FAILED( validateSTGM(grfMode) ) ||
 950        (grfMode & STGM_DELETEONRELEASE) )
 951     return STG_E_INVALIDFLAG;
 952
 953   /*
 954    * Initialize the out parameter
 955    */
 956   *ppstg = 0;
 957
 958   /*
 959    * Create a property enumeration and search the properties
 960    */
 961   propertyEnumeration = IEnumSTATSTGImpl_Construct( This->ancestorStorage,
 962                                                     This->rootPropertySetIndex);
 963
 964   foundPropertyIndex = IEnumSTATSTGImpl_FindProperty(propertyEnumeration,
 965                                                      pwcsName,
 966                                                      &currentProperty);
 967   IEnumSTATSTGImpl_Destroy(propertyEnumeration);
 968
 969   if (foundPropertyIndex != PROPERTY_NULL)
 970   {
 971     /*
 972      * An element with this name already exists
 973      */
 974     if (grfMode & STGM_CREATE)
 975       IStorage_DestroyElement(iface, pwcsName);
 976     else
 977       return STG_E_FILEALREADYEXISTS;
 978   }
 979
 980   /*
 981    * memset the empty property
 982    */
 983   memset(&newProperty, 0, sizeof(StgProperty));
 984
 985   newProperty.sizeOfNameString = (lstrlenW(pwcsName)+1)*sizeof(WCHAR);
 986
 987   if (newProperty.sizeOfNameString > PROPERTY_NAME_BUFFER_LEN)
 988     return STG_E_INVALIDNAME;
 989
 990   lstrcpyW(newProperty.name, pwcsName);
 991
 992   newProperty.propertyType  = PROPTYPE_STORAGE;
 993   newProperty.startingBlock = BLOCK_END_OF_CHAIN;
 994   newProperty.size.LowPart  = 0;
 995   newProperty.size.HighPart = 0;
 996
 997   newProperty.previousProperty = PROPERTY_NULL;
 998   newProperty.nextProperty     = PROPERTY_NULL;
 999   newProperty.dirProperty      = PROPERTY_NULL;
1000
1001   /* call CoFileTime to get the current time
1002   newProperty.timeStampS1
1003   newProperty.timeStampD1
1004   newProperty.timeStampS2
1005   newProperty.timeStampD2
1006   */
1007
1008   /*  newStorageProperty.propertyUniqueID */
1009
1010   /*
1011    * Obtain a free property in the property chain
1012    */
1013   newPropertyIndex = getFreeProperty(This->ancestorStorage);
1014
1015   /*
1016    * Save the new property into the new property spot
1017    */
1018   StorageImpl_WriteProperty(
1019     This->ancestorStorage,
1020     newPropertyIndex,
1021     &newProperty);
1022
1023   /*
1024    * Find a spot in the property chain for our newly created property.
1025    */
1026   updatePropertyChain(
1027     This,
1028     newPropertyIndex,
1029     newProperty);
1030
1031   /*
1032    * Open it to get a pointer to return.
1033    */
1034   hr = IStorage_OpenStorage(
1035          iface,
1036          (OLECHAR*)pwcsName,
1037          0,
1038          grfMode,
1039          0,
1040          0,
1041          ppstg);
1042
1043   if( (hr != S_OK) || (*ppstg == NULL))
1044   {
1045     return hr;
1046   }
1047
1048
1049   return S_OK;
1050 }
1051
1052
1053 /***************************************************************************
1054  *
1055  * Internal Method
1056  *
1057  * Get a free property or create a new one.
1058  */
1059 static ULONG getFreeProperty(
1060   StorageImpl *storage)
1061 {
1062   ULONG       currentPropertyIndex = 0;
1063   ULONG       newPropertyIndex     = PROPERTY_NULL;
1064   BOOL      readSucessful        = TRUE;
1065   StgProperty currentProperty;
1066
1067   do
1068   {
1069     /*
1070      * Start by reading the root property
1071      */
1072     readSucessful = StorageImpl_ReadProperty(storage->ancestorStorage,
1073                                                currentPropertyIndex,
1074                                                &currentProperty);
1075     if (readSucessful)
1076     {
1077       if (currentProperty.sizeOfNameString == 0)
1078       {
1079         /*
1080          * The property existis and is available, we found it.
1081          */
1082         newPropertyIndex = currentPropertyIndex;
1083       }
1084     }
1085     else
1086     {
1087       /*
1088        * We exhausted the property list, we will create more space below
1089        */
1090       newPropertyIndex = currentPropertyIndex;
1091     }
1092     currentPropertyIndex++;
1093
1094   } while (newPropertyIndex == PROPERTY_NULL);
1095
1096   /*
1097    * grow the property chain
1098    */
1099   if (! readSucessful)
1100   {
1101     StgProperty    emptyProperty;
1102     ULARGE_INTEGER newSize;
1103     ULONG          propertyIndex;
1104     ULONG          lastProperty  = 0;
1105     ULONG          blockCount    = 0;
1106
1107     /*
1108      * obtain the new count of property blocks
1109      */
1110     blockCount = BlockChainStream_GetCount(
1111                    storage->ancestorStorage->rootBlockChain)+1;
1112
1113     /*
1114      * initialize the size used by the property stream
1115      */
1116     newSize.HighPart = 0;
1117     newSize.LowPart  = storage->bigBlockSize * blockCount;
1118
1119     /*
1120      * add a property block to the property chain
1121      */
1122     BlockChainStream_SetSize(storage->ancestorStorage->rootBlockChain, newSize);
1123
1124     /*
1125      * memset the empty property in order to initialize the unused newly
1126      * created property
1127      */
1128     memset(&emptyProperty, 0, sizeof(StgProperty));
1129
1130     /*
1131      * initialize them
1132      */
1133     lastProperty = storage->bigBlockSize / PROPSET_BLOCK_SIZE * blockCount;
1134
1135     for(
1136       propertyIndex = newPropertyIndex;
1137       propertyIndex < lastProperty;
1138       propertyIndex++)
1139     {
1140       StorageImpl_WriteProperty(
1141         storage->ancestorStorage,
1142         propertyIndex,
1143         &emptyProperty);
1144     }
1145   }
1146
1147   return newPropertyIndex;
1148 }
1149
1150 /****************************************************************************
1151  *
1152  * Internal Method
1153  *
1154  * Case insensitive comparaison of StgProperty.name by first considering
1155  * their size.
1156  *
1157  * Returns <0 when newPrpoerty < currentProperty
1158  *         >0 when newPrpoerty > currentProperty
1159  *          0 when newPrpoerty == currentProperty
1160  */
1161 static LONG propertyNameCmp(
1162   OLECHAR *newProperty,
1163   OLECHAR *currentProperty)
1164 {
1165   LONG diff      = lstrlenW(newProperty) - lstrlenW(currentProperty);
1166
1167   if (diff == 0)
1168   {
1169     /*
1170      * We compare the string themselves only when they are of the same lenght
1171      */
1172     diff = lstrcmpiW( newProperty, currentProperty);
1173   }
1174
1175   return diff;
1176 }
1177
1178 /****************************************************************************
1179  *
1180  * Internal Method
1181  *
1182  * Properly link this new element in the property chain.
1183  */
1184 static void updatePropertyChain(
1185   StorageImpl *storage,
1186   ULONG         newPropertyIndex,
1187   StgProperty   newProperty)
1188 {
1189   StgProperty currentProperty;
1190
1191   /*
1192    * Read the root property
1193    */
1194   StorageImpl_ReadProperty(storage->ancestorStorage,
1195                              storage->rootPropertySetIndex,
1196                              &currentProperty);
1197
1198   if (currentProperty.dirProperty != PROPERTY_NULL)
1199   {
1200     /*
1201      * The root storage contains some element, therefore, start the research
1202      * for the appropriate location.
1203      */
1204     BOOL found = 0;
1205     ULONG  current, next, previous, currentPropertyId;
1206
1207     /*
1208      * Keep the StgProperty sequence number of the storage first property
1209      */
1210     currentPropertyId = currentProperty.dirProperty;
1211
1212     /*
1213      * Read
1214      */
1215     StorageImpl_ReadProperty(storage->ancestorStorage,
1216                                currentProperty.dirProperty,
1217                                &currentProperty);
1218
1219     previous = currentProperty.previousProperty;
1220     next     = currentProperty.nextProperty;
1221     current  = currentPropertyId;
1222
1223     while (found == 0)
1224     {
1225       LONG diff = propertyNameCmp( newProperty.name, currentProperty.name);
1226
1227       if (diff < 0)
1228       {
1229         if (previous != PROPERTY_NULL)
1230         {
1231           StorageImpl_ReadProperty(storage->ancestorStorage,
1232                                      previous,
1233                                      &currentProperty);
1234           current = previous;
1235         }
1236         else
1237         {
1238           currentProperty.previousProperty = newPropertyIndex;
1239           StorageImpl_WriteProperty(storage->ancestorStorage,
1240                                       current,
1241                                       &currentProperty);
1242           found = 1;
1243         }
1244       }
1245       else if (diff > 0)
1246       {
1247         if (next != PROPERTY_NULL)
1248         {
1249           StorageImpl_ReadProperty(storage->ancestorStorage,
1250                                      next,
1251                                      &currentProperty);
1252           current = next;
1253         }
1254         else
1255         {
1256           currentProperty.nextProperty = newPropertyIndex;
1257           StorageImpl_WriteProperty(storage->ancestorStorage,
1258                                       current,
1259                                       &currentProperty);
1260           found = 1;
1261         }
1262       }
1263       else
1264       {
1265         /*
1266          * Trying to insert an item with the same name in the
1267          * subtree structure.
1268          */
1269         assert(FALSE);
1270       }
1271
1272       previous = currentProperty.previousProperty;
1273       next     = currentProperty.nextProperty;
1274     }
1275   }
1276   else
1277   {
1278     /*
1279      * The root storage is empty, link the new property to it's dir property
1280      */
1281     currentProperty.dirProperty = newPropertyIndex;
1282     StorageImpl_WriteProperty(storage->ancestorStorage,
1283                                 storage->rootPropertySetIndex,
1284                                 &currentProperty);
1285   }
1286 }
1287
1288
1289 /*************************************************************************
1290  * CopyTo (IStorage)
1291  */
1292 HRESULT WINAPI StorageImpl_CopyTo(
1293   IStorage*   iface,
1294   DWORD       ciidExclude,  /* [in] */
1295   const IID*  rgiidExclude, /* [size_is][unique][in] */
1296   SNB         snbExclude,   /* [unique][in] */
1297   IStorage*   pstgDest)     /* [unique][in] */
1298 {
1299   IEnumSTATSTG *elements     = 0;
1300   STATSTG      curElement, strStat;
1301   HRESULT      hr;
1302   IStorage     *pstgTmp, *pstgChild;
1303   IStream      *pstrTmp, *pstrChild;
1304
1305   if ((ciidExclude != 0) || (rgiidExclude != NULL) || (snbExclude != NULL))
1306     FIXME("Exclude option not implemented\n");
1307
1308   TRACE("(%p, %ld, %p, %p, %p)\n",
1309         iface, ciidExclude, rgiidExclude,
1310         snbExclude, pstgDest);
1311
1312   /*
1313    * Perform a sanity check
1314    */
1315   if ( pstgDest == 0 )
1316     return STG_E_INVALIDPOINTER;
1317
1318   /*
1319    * Enumerate the elements
1320    */
1321   hr = IStorage_EnumElements( iface, 0, 0, 0, &elements );
1322
1323   if ( hr != S_OK )
1324     return hr;
1325
1326   /*
1327    * set the class ID
1328    */
1329   IStorage_Stat( iface, &curElement, STATFLAG_NONAME);
1330   IStorage_SetClass( pstgDest, &curElement.clsid );
1331
1332   do
1333   {
1334     /*
1335      * Obtain the next element
1336      */
1337     hr = IEnumSTATSTG_Next( elements, 1, &curElement, NULL );
1338
1339     if ( hr == S_FALSE )
1340     {
1341       hr = S_OK;   /* done, every element has been copied */
1342       break;
1343     }
1344
1345     if (curElement.type == STGTY_STORAGE)
1346     {
1347       /*
1348        * open child source storage
1349        */
1350       hr = IStorage_OpenStorage( iface, curElement.pwcsName, NULL,
1351                                  STGM_READ|STGM_SHARE_EXCLUSIVE,
1352                                  NULL, 0, &pstgChild );
1353
1354       if (hr != S_OK)
1355         break;
1356
1357       /*
1358        * Check if destination storage is not a child of the source
1359        * storage, which will cause an infinite loop
1360        */
1361       if (pstgChild == pstgDest)
1362       {
1363         IEnumSTATSTG_Release(elements);
1364
1365         return STG_E_ACCESSDENIED;
1366       }
1367
1368       /*
1369        * create a new storage in destination storage
1370        */
1371       hr = IStorage_CreateStorage( pstgDest, curElement.pwcsName,
1372                                    STGM_FAILIFTHERE|STGM_WRITE|STGM_SHARE_EXCLUSIVE,
1373                                    0, 0,
1374                                    &pstgTmp );
1375       /*
1376        * if it already exist, don't create a new one use this one
1377        */
1378       if (hr == STG_E_FILEALREADYEXISTS)
1379       {
1380         hr = IStorage_OpenStorage( pstgDest, curElement.pwcsName, NULL,
1381                                    STGM_WRITE|STGM_SHARE_EXCLUSIVE,
1382                                    NULL, 0, &pstgTmp );
1383       }
1384
1385       if (hr != S_OK)
1386         break;
1387
1388
1389       /*
1390        * do the copy recursively
1391        */
1392       hr = IStorage_CopyTo( pstgChild, ciidExclude, rgiidExclude,
1393                                snbExclude, pstgTmp );
1394
1395       IStorage_Release( pstgTmp );
1396       IStorage_Release( pstgChild );
1397     }
1398     else if (curElement.type == STGTY_STREAM)
1399     {
1400       /*
1401        * create a new stream in destination storage. If the stream already
1402        * exist, it will be deleted and a new one will be created.
1403        */
1404       hr = IStorage_CreateStream( pstgDest, curElement.pwcsName,
1405                                   STGM_CREATE|STGM_WRITE|STGM_SHARE_EXCLUSIVE,
1406                                   0, 0, &pstrTmp );
1407
1408       if (hr != S_OK)
1409         break;
1410
1411       /*
1412        * open child stream storage
1413        */
1414       hr = IStorage_OpenStream( iface, curElement.pwcsName, NULL,
1415                                 STGM_READ|STGM_SHARE_EXCLUSIVE,
1416                                 0, &pstrChild );
1417
1418       if (hr != S_OK)
1419         break;
1420
1421       /*
1422        * Get the size of the source stream
1423        */
1424       IStream_Stat( pstrChild, &strStat, STATFLAG_NONAME );
1425
1426       /*
1427        * Set the size of the destination stream.
1428        */
1429       IStream_SetSize(pstrTmp, strStat.cbSize);
1430
1431       /*
1432        * do the copy
1433        */
1434       hr = IStream_CopyTo( pstrChild, pstrTmp, strStat.cbSize,
1435                            NULL, NULL );
1436
1437       IStream_Release( pstrTmp );
1438       IStream_Release( pstrChild );
1439     }
1440     else
1441     {
1442       WARN("unknown element type: %ld\n", curElement.type);
1443     }
1444
1445   } while (hr == S_OK);
1446
1447   /*
1448    * Clean-up
1449    */
1450   IEnumSTATSTG_Release(elements);
1451
1452   return hr;
1453 }
1454
1455 /*************************************************************************
1456  * MoveElementTo (IStorage)
1457  */
1458 HRESULT WINAPI StorageImpl_MoveElementTo(
1459   IStorage*     iface,
1460   const OLECHAR *pwcsName,   /* [string][in] */
1461   IStorage      *pstgDest,   /* [unique][in] */
1462   const OLECHAR *pwcsNewName,/* [string][in] */
1463   DWORD           grfFlags)    /* [in] */
1464 {
1465   FIXME("not implemented!\n");
1466   return E_NOTIMPL;
1467 }
1468
1469 /*************************************************************************
1470  * Commit (IStorage)
1471  */
1472 HRESULT WINAPI StorageImpl_Commit(
1473   IStorage*   iface,
1474   DWORD         grfCommitFlags)/* [in] */
1475 {
1476   FIXME("(%ld): stub!\n", grfCommitFlags);
1477   return S_OK;
1478 }
1479
1480 /*************************************************************************
1481  * Revert (IStorage)
1482  */
1483 HRESULT WINAPI StorageImpl_Revert(
1484   IStorage* iface)
1485 {
1486   FIXME("not implemented!\n");
1487   return E_NOTIMPL;
1488 }
1489
1490 /*************************************************************************
1491  * DestroyElement (IStorage)
1492  *
1493  * Stategy: This implementation is build this way for simplicity not for speed.
1494  *          I always delete the top most element of the enumeration and adjust
1495  *          the deleted element pointer all the time.  This takes longer to
1496  *          do but allow to reinvoke DestroyElement whenever we encounter a
1497  *          storage object.  The optimisation reside in the usage of another
1498  *          enumeration stategy that would give all the leaves of a storage
1499  *          first. (postfix order)
1500  */
1501 HRESULT WINAPI StorageImpl_DestroyElement(
1502   IStorage*     iface,
1503   const OLECHAR *pwcsName)/* [string][in] */
1504 {
1505   StorageImpl* const This=(StorageImpl*)iface;
1506
1507   IEnumSTATSTGImpl* propertyEnumeration;
1508   HRESULT           hr = S_OK;
1509   BOOL            res;
1510   StgProperty       propertyToDelete;
1511   StgProperty       parentProperty;
1512   ULONG             foundPropertyIndexToDelete;
1513   ULONG             typeOfRelation;
1514   ULONG             parentPropertyId;
1515
1516   TRACE("(%p, %s)\n",
1517         iface, debugstr_w(pwcsName));
1518
1519   /*
1520    * Perform a sanity check on the parameters.
1521    */
1522   if (pwcsName==NULL)
1523     return STG_E_INVALIDPOINTER;
1524
1525   /*
1526    * Create a property enumeration to search the property with the given name
1527    */
1528   propertyEnumeration = IEnumSTATSTGImpl_Construct(
1529     This->ancestorStorage,
1530     This->rootPropertySetIndex);
1531
1532   foundPropertyIndexToDelete = IEnumSTATSTGImpl_FindProperty(
1533     propertyEnumeration,
1534     pwcsName,
1535     &propertyToDelete);
1536
1537   IEnumSTATSTGImpl_Destroy(propertyEnumeration);
1538
1539   if ( foundPropertyIndexToDelete == PROPERTY_NULL )
1540   {
1541     return STG_E_FILENOTFOUND;
1542   }
1543
1544   /*
1545    * Find the parent property of the property to delete (the one that
1546    * link to it).  If This->dirProperty == foundPropertyIndexToDelete,
1547    * the parent is This. Otherwise, the parent is one of it's sibling...
1548    */
1549
1550   /*
1551    * First, read This's StgProperty..
1552    */
1553   res = StorageImpl_ReadProperty(
1554           This->ancestorStorage,
1555           This->rootPropertySetIndex,
1556           &parentProperty);
1557
1558   assert(res==TRUE);
1559
1560   /*
1561    * Second, check to see if by any chance the actual storage (This) is not
1562    * the parent of the property to delete... We never know...
1563    */
1564   if ( parentProperty.dirProperty == foundPropertyIndexToDelete )
1565   {
1566     /*
1567      * Set data as it would have been done in the else part...
1568      */
1569     typeOfRelation   = PROPERTY_RELATION_DIR;
1570     parentPropertyId = This->rootPropertySetIndex;
1571   }
1572   else
1573   {
1574     /*
1575      * Create a property enumeration to search the parent properties, and
1576      * delete it once done.
1577      */
1578     IEnumSTATSTGImpl* propertyEnumeration2;
1579
1580     propertyEnumeration2 = IEnumSTATSTGImpl_Construct(
1581       This->ancestorStorage,
1582       This->rootPropertySetIndex);
1583
1584     typeOfRelation = IEnumSTATSTGImpl_FindParentProperty(
1585       propertyEnumeration2,
1586       foundPropertyIndexToDelete,
1587       &parentProperty,
1588       &parentPropertyId);
1589
1590     IEnumSTATSTGImpl_Destroy(propertyEnumeration2);
1591   }
1592
1593   if ( propertyToDelete.propertyType == PROPTYPE_STORAGE )
1594   {
1595     hr = deleteStorageProperty(
1596            This,
1597            propertyToDelete.name);
1598   }
1599   else if ( propertyToDelete.propertyType == PROPTYPE_STREAM )
1600   {
1601     hr = deleteStreamProperty(
1602            This,
1603            foundPropertyIndexToDelete,
1604            propertyToDelete);
1605   }
1606
1607   if (hr!=S_OK)
1608     return hr;
1609
1610   /*
1611    * Adjust the property chain
1612    */
1613   hr = adjustPropertyChain(
1614         This,
1615         propertyToDelete,
1616         parentProperty,
1617         parentPropertyId,
1618         typeOfRelation);
1619
1620   return hr;
1621 }
1622
1623
1624 /*********************************************************************
1625  *
1626  * Internal Method
1627  *
1628  * Perform the deletion of a complete storage node
1629  *
1630  */
1631 static HRESULT deleteStorageProperty(
1632   StorageImpl *parentStorage,
1633   OLECHAR     *propertyToDeleteName)
1634 {
1635   IEnumSTATSTG *elements     = 0;
1636   IStorage   *childStorage = 0;
1637   STATSTG      currentElement;
1638   HRESULT      hr;
1639   HRESULT      destroyHr = S_OK;
1640
1641   /*
1642    * Open the storage and enumerate it
1643    */
1644   hr = StorageBaseImpl_OpenStorage(
1645         (IStorage*)parentStorage,
1646         propertyToDeleteName,
1647         0,
1648         STGM_SHARE_EXCLUSIVE,
1649         0,
1650         0,
1651         &childStorage);
1652
1653   if (hr != S_OK)
1654   {
1655     return hr;
1656   }
1657
1658   /*
1659    * Enumerate the elements
1660    */
1661   IStorage_EnumElements( childStorage, 0, 0, 0, &elements);
1662
1663   do
1664   {
1665     /*
1666      * Obtain the next element
1667      */
1668     hr = IEnumSTATSTG_Next(elements, 1, &currentElement, NULL);
1669     if (hr==S_OK)
1670     {
1671       destroyHr = StorageImpl_DestroyElement(
1672                     (IStorage*)childStorage,
1673                     (OLECHAR*)currentElement.pwcsName);
1674
1675       CoTaskMemFree(currentElement.pwcsName);
1676     }
1677
1678     /*
1679      * We need to Reset the enumeration every time because we delete elements
1680      * and the enumeration could be invalid
1681      */
1682     IEnumSTATSTG_Reset(elements);
1683
1684   } while ((hr == S_OK) && (destroyHr == S_OK));
1685
1686   IStorage_Release(childStorage);
1687   IEnumSTATSTG_Release(elements);
1688
1689   return destroyHr;
1690 }
1691
1692 /*********************************************************************
1693  *
1694  * Internal Method
1695  *
1696  * Perform the deletion of a stream node
1697  *
1698  */
1699 static HRESULT deleteStreamProperty(
1700   StorageImpl *parentStorage,
1701   ULONG         indexOfPropertyToDelete,
1702   StgProperty   propertyToDelete)
1703 {
1704   IStream      *pis;
1705   HRESULT        hr;
1706   ULARGE_INTEGER size;
1707
1708   size.HighPart = 0;
1709   size.LowPart = 0;
1710
1711   hr = StorageBaseImpl_OpenStream(
1712          (IStorage*)parentStorage,
1713          (OLECHAR*)propertyToDelete.name,
1714          NULL,
1715          STGM_SHARE_EXCLUSIVE,
1716          0,
1717          &pis);
1718
1719   if (hr!=S_OK)
1720   {
1721     return(hr);
1722   }
1723
1724   /*
1725    * Zap the stream
1726    */
1727   hr = IStream_SetSize(pis, size);
1728
1729   if(hr != S_OK)
1730   {
1731     return hr;
1732   }
1733
1734   /*
1735    * Release the stream object.
1736    */
1737   IStream_Release(pis);
1738
1739   /*
1740    * Invalidate the property by zeroing it's name member.
1741    */
1742   propertyToDelete.sizeOfNameString = 0;
1743
1744   /*
1745    * Here we should re-read the property so we get the updated pointer
1746    * but since we are here to zap it, I don't do it...
1747    */
1748   StorageImpl_WriteProperty(
1749     parentStorage->ancestorStorage,
1750     indexOfPropertyToDelete,
1751     &propertyToDelete);
1752
1753   return S_OK;
1754 }
1755
1756 /*********************************************************************
1757  *
1758  * Internal Method
1759  *
1760  * Finds a placeholder for the StgProperty within the Storage
1761  *
1762  */
1763 static HRESULT findPlaceholder(
1764   StorageImpl *storage,
1765   ULONG         propertyIndexToStore,
1766   ULONG         storePropertyIndex,
1767   INT         typeOfRelation)
1768 {
1769   StgProperty storeProperty;
1770   HRESULT     hr = S_OK;
1771   BOOL      res = TRUE;
1772
1773   /*
1774    * Read the storage property
1775    */
1776   res = StorageImpl_ReadProperty(
1777           storage->ancestorStorage,
1778           storePropertyIndex,
1779           &storeProperty);
1780
1781   if(! res)
1782   {
1783     return E_FAIL;
1784   }
1785
1786   if (typeOfRelation == PROPERTY_RELATION_PREVIOUS)
1787   {
1788     if (storeProperty.previousProperty != PROPERTY_NULL)
1789     {
1790       return findPlaceholder(
1791                storage,
1792                propertyIndexToStore,
1793                storeProperty.previousProperty,
1794                typeOfRelation);
1795     }
1796     else
1797     {
1798       storeProperty.previousProperty = propertyIndexToStore;
1799     }
1800   }
1801   else if (typeOfRelation == PROPERTY_RELATION_NEXT)
1802   {
1803     if (storeProperty.nextProperty != PROPERTY_NULL)
1804     {
1805       return findPlaceholder(
1806                storage,
1807                propertyIndexToStore,
1808                storeProperty.nextProperty,
1809                typeOfRelation);
1810     }
1811     else
1812     {
1813       storeProperty.nextProperty = propertyIndexToStore;
1814     }
1815   }
1816   else if (typeOfRelation == PROPERTY_RELATION_DIR)
1817   {
1818     if (storeProperty.dirProperty != PROPERTY_NULL)
1819     {
1820       return findPlaceholder(
1821                storage,
1822                propertyIndexToStore,
1823                storeProperty.dirProperty,
1824                typeOfRelation);
1825     }
1826     else
1827     {
1828       storeProperty.dirProperty = propertyIndexToStore;
1829     }
1830   }
1831
1832   hr = StorageImpl_WriteProperty(
1833          storage->ancestorStorage,
1834          storePropertyIndex,
1835          &storeProperty);
1836
1837   if(! hr)
1838   {
1839     return E_FAIL;
1840   }
1841
1842   return S_OK;
1843 }
1844
1845 /*************************************************************************
1846  *
1847  * Internal Method
1848  *
1849  * This method takes the previous and the next property link of a property
1850  * to be deleted and find them a place in the Storage.
1851  */
1852 static HRESULT adjustPropertyChain(
1853   StorageImpl *This,
1854   StgProperty   propertyToDelete,
1855   StgProperty   parentProperty,
1856   ULONG         parentPropertyId,
1857   INT         typeOfRelation)
1858 {
1859   ULONG   newLinkProperty        = PROPERTY_NULL;
1860   BOOL  needToFindAPlaceholder = FALSE;
1861   ULONG   storeNode              = PROPERTY_NULL;
1862   ULONG   toStoreNode            = PROPERTY_NULL;
1863   INT   relationType           = 0;
1864   HRESULT hr                     = S_OK;
1865   BOOL  res                    = TRUE;
1866
1867   if (typeOfRelation == PROPERTY_RELATION_PREVIOUS)
1868   {
1869     if (propertyToDelete.previousProperty != PROPERTY_NULL)
1870     {
1871       /*
1872        * Set the parent previous to the property to delete previous
1873        */
1874       newLinkProperty = propertyToDelete.previousProperty;
1875
1876       if (propertyToDelete.nextProperty != PROPERTY_NULL)
1877       {
1878         /*
1879          * We also need to find a storage for the other link, setup variables
1880          * to do this at the end...
1881          */
1882         needToFindAPlaceholder = TRUE;
1883         storeNode              = propertyToDelete.previousProperty;
1884         toStoreNode            = propertyToDelete.nextProperty;
1885         relationType           = PROPERTY_RELATION_NEXT;
1886       }
1887     }
1888     else if (propertyToDelete.nextProperty != PROPERTY_NULL)
1889     {
1890       /*
1891        * Set the parent previous to the property to delete next
1892        */
1893       newLinkProperty = propertyToDelete.nextProperty;
1894     }
1895
1896     /*
1897      * Link it for real...
1898      */
1899     parentProperty.previousProperty = newLinkProperty;
1900
1901   }
1902   else if (typeOfRelation == PROPERTY_RELATION_NEXT)
1903   {
1904     if (propertyToDelete.previousProperty != PROPERTY_NULL)
1905     {
1906       /*
1907        * Set the parent next to the property to delete next previous
1908        */
1909       newLinkProperty = propertyToDelete.previousProperty;
1910
1911       if (propertyToDelete.nextProperty != PROPERTY_NULL)
1912       {
1913         /*
1914          * We also need to find a storage for the other link, setup variables
1915          * to do this at the end...
1916          */
1917         needToFindAPlaceholder = TRUE;
1918         storeNode              = propertyToDelete.previousProperty;
1919         toStoreNode            = propertyToDelete.nextProperty;
1920         relationType           = PROPERTY_RELATION_NEXT;
1921       }
1922     }
1923     else if (propertyToDelete.nextProperty != PROPERTY_NULL)
1924     {
1925       /*
1926        * Set the parent next to the property to delete next
1927        */
1928       newLinkProperty = propertyToDelete.nextProperty;
1929     }
1930
1931     /*
1932      * Link it for real...
1933      */
1934     parentProperty.nextProperty = newLinkProperty;
1935   }
1936   else /* (typeOfRelation == PROPERTY_RELATION_DIR) */
1937   {
1938     if (propertyToDelete.previousProperty != PROPERTY_NULL)
1939     {
1940       /*
1941        * Set the parent dir to the property to delete previous
1942        */
1943       newLinkProperty = propertyToDelete.previousProperty;
1944
1945       if (propertyToDelete.nextProperty != PROPERTY_NULL)
1946       {
1947         /*
1948          * We also need to find a storage for the other link, setup variables
1949          * to do this at the end...
1950          */
1951         needToFindAPlaceholder = TRUE;
1952         storeNode              = propertyToDelete.previousProperty;
1953         toStoreNode            = propertyToDelete.nextProperty;
1954         relationType           = PROPERTY_RELATION_NEXT;
1955       }
1956     }
1957     else if (propertyToDelete.nextProperty != PROPERTY_NULL)
1958     {
1959       /*
1960        * Set the parent dir to the property to delete next
1961        */
1962       newLinkProperty = propertyToDelete.nextProperty;
1963     }
1964
1965     /*
1966      * Link it for real...
1967      */
1968     parentProperty.dirProperty = newLinkProperty;
1969   }
1970
1971   /*
1972    * Write back the parent property
1973    */
1974   res = StorageImpl_WriteProperty(
1975           This->ancestorStorage,
1976           parentPropertyId,
1977           &parentProperty);
1978   if(! res)
1979   {
1980     return E_FAIL;
1981   }
1982
1983   /*
1984    * If a placeholder is required for the other link, then, find one and
1985    * get out of here...
1986    */
1987   if (needToFindAPlaceholder)
1988   {
1989     hr = findPlaceholder(
1990            This,
1991            toStoreNode,
1992            storeNode,
1993            relationType);
1994   }
1995
1996   return hr;
1997 }
1998
1999
2000 /******************************************************************************
2001  * SetElementTimes (IStorage)
2002  */
2003 HRESULT WINAPI StorageImpl_SetElementTimes(
2004   IStorage*     iface,
2005   const OLECHAR *pwcsName,/* [string][in] */
2006   const FILETIME  *pctime,  /* [in] */
2007   const FILETIME  *patime,  /* [in] */
2008   const FILETIME  *pmtime)  /* [in] */
2009 {
2010   FIXME("not implemented!\n");
2011   return E_NOTIMPL;
2012 }
2013
2014 /******************************************************************************
2015  * SetStateBits (IStorage)
2016  */
2017 HRESULT WINAPI StorageImpl_SetStateBits(
2018   IStorage*   iface,
2019   DWORD         grfStateBits,/* [in] */
2020   DWORD         grfMask)     /* [in] */
2021 {
2022   FIXME("not implemented!\n");
2023   return E_NOTIMPL;
2024 }
2025
2026 HRESULT StorageImpl_Construct(
2027   StorageImpl* This,
2028   HANDLE       hFile,
2029   ILockBytes*  pLkbyt,
2030   DWORD        openFlags,
2031   BOOL         fileBased)
2032 {
2033   HRESULT     hr = S_OK;
2034   StgProperty currentProperty;
2035   BOOL      readSucessful;
2036   ULONG       currentPropertyIndex;
2037
2038   if ( FAILED( validateSTGM(openFlags) ))
2039     return STG_E_INVALIDFLAG;
2040
2041   memset(This, 0, sizeof(StorageImpl));
2042
2043   /*
2044    * Initialize the virtual fgunction table.
2045    */
2046   This->lpvtbl       = &Storage32Impl_Vtbl;
2047   This->v_destructor = &StorageImpl_Destroy;
2048
2049   /*
2050    * This is the top-level storage so initialize the ancester pointer
2051    * to this.
2052    */
2053   This->ancestorStorage = This;
2054
2055   /*
2056    * Initialize the physical support of the storage.
2057    */
2058   This->hFile = hFile;
2059
2060   /*
2061    * Initialize the big block cache.
2062    */
2063   This->bigBlockSize   = DEF_BIG_BLOCK_SIZE;
2064   This->smallBlockSize = DEF_SMALL_BLOCK_SIZE;
2065   This->bigBlockFile   = BIGBLOCKFILE_Construct(hFile,
2066                                                 pLkbyt,
2067                                                 openFlags,
2068                                                 This->bigBlockSize,
2069                                                 fileBased);
2070
2071   if (This->bigBlockFile == 0)
2072     return E_FAIL;
2073
2074   if (openFlags & STGM_CREATE)
2075   {
2076     ULARGE_INTEGER size;
2077     BYTE* bigBlockBuffer;
2078
2079     /*
2080      * Initialize all header variables:
2081      * - The big block depot consists of one block and it is at block 0
2082      * - The properties start at block 1
2083      * - There is no small block depot
2084      */
2085     memset( This->bigBlockDepotStart,
2086             BLOCK_UNUSED,
2087             sizeof(This->bigBlockDepotStart));
2088
2089     This->bigBlockDepotCount    = 1;
2090     This->bigBlockDepotStart[0] = 0;
2091     This->rootStartBlock        = 1;
2092     This->smallBlockDepotStart  = BLOCK_END_OF_CHAIN;
2093     This->bigBlockSizeBits      = DEF_BIG_BLOCK_SIZE_BITS;
2094     This->smallBlockSizeBits    = DEF_SMALL_BLOCK_SIZE_BITS;
2095     This->extBigBlockDepotStart = BLOCK_END_OF_CHAIN;
2096     This->extBigBlockDepotCount = 0;
2097
2098     StorageImpl_SaveFileHeader(This);
2099
2100     /*
2101      * Add one block for the big block depot and one block for the properties
2102      */
2103     size.HighPart = 0;
2104     size.LowPart  = This->bigBlockSize * 3;
2105     BIGBLOCKFILE_SetSize(This->bigBlockFile, size);
2106
2107     /*
2108      * Initialize the big block depot
2109      */
2110     bigBlockBuffer = StorageImpl_GetBigBlock(This, 0);
2111     memset(bigBlockBuffer, BLOCK_UNUSED, This->bigBlockSize);
2112     StorageUtl_WriteDWord(bigBlockBuffer, 0, BLOCK_SPECIAL);
2113     StorageUtl_WriteDWord(bigBlockBuffer, sizeof(ULONG), BLOCK_END_OF_CHAIN);
2114     StorageImpl_ReleaseBigBlock(This, bigBlockBuffer);
2115   }
2116   else
2117   {
2118     /*
2119      * Load the header for the file.
2120      */
2121     hr = StorageImpl_LoadFileHeader(This);
2122
2123     if (FAILED(hr))
2124     {
2125       BIGBLOCKFILE_Destructor(This->bigBlockFile);
2126
2127       return hr;
2128     }
2129   }
2130
2131   /*
2132    * There is no block depot cached yet.
2133    */
2134   This->indexBlockDepotCached = 0xFFFFFFFF;
2135
2136   /*
2137    * Start searching for free blocks with block 0.
2138    */
2139   This->prevFreeBlock = 0;
2140
2141   /*
2142    * Create the block chain abstractions.
2143    */
2144   This->rootBlockChain =
2145     BlockChainStream_Construct(This, &This->rootStartBlock, PROPERTY_NULL);
2146
2147   This->smallBlockDepotChain = BlockChainStream_Construct(
2148                                  This,
2149                                  &This->smallBlockDepotStart,
2150                                  PROPERTY_NULL);
2151
2152   /*
2153    * Write the root property
2154    */
2155   if (openFlags & STGM_CREATE)
2156   {
2157     StgProperty rootProp;
2158     /*
2159      * Initialize the property chain
2160      */
2161     memset(&rootProp, 0, sizeof(rootProp));
2162     lstrcpyAtoW(rootProp.name, rootPropertyName);
2163
2164     rootProp.sizeOfNameString = (lstrlenW(rootProp.name)+1) * sizeof(WCHAR);
2165     rootProp.propertyType     = PROPTYPE_ROOT;
2166     rootProp.previousProperty = PROPERTY_NULL;
2167     rootProp.nextProperty     = PROPERTY_NULL;
2168     rootProp.dirProperty      = PROPERTY_NULL;
2169     rootProp.startingBlock    = BLOCK_END_OF_CHAIN;
2170     rootProp.size.HighPart    = 0;
2171     rootProp.size.LowPart     = 0;
2172
2173     StorageImpl_WriteProperty(This, 0, &rootProp);
2174   }
2175
2176   /*
2177    * Find the ID of the root int he property sets.
2178    */
2179   currentPropertyIndex = 0;
2180
2181   do
2182   {
2183     readSucessful = StorageImpl_ReadProperty(
2184                       This,
2185                       currentPropertyIndex,
2186                       &currentProperty);
2187
2188     if (readSucessful)
2189     {
2190       if ( (currentProperty.sizeOfNameString != 0 ) &&
2191            (currentProperty.propertyType     == PROPTYPE_ROOT) )
2192       {
2193         This->rootPropertySetIndex = currentPropertyIndex;
2194       }
2195     }
2196
2197     currentPropertyIndex++;
2198
2199   } while (readSucessful && (This->rootPropertySetIndex == PROPERTY_NULL) );
2200
2201   if (!readSucessful)
2202   {
2203     /* TODO CLEANUP */
2204     return E_FAIL;
2205   }
2206
2207   /*
2208    * Create the block chain abstraction for the small block root chain.
2209    */
2210   This->smallBlockRootChain = BlockChainStream_Construct(
2211                                 This,
2212                                 NULL,
2213                                 This->rootPropertySetIndex);
2214
2215   return hr;
2216 }
2217
2218 void StorageImpl_Destroy(
2219   StorageImpl* This)
2220 {
2221   TRACE("(%p)\n", This);
2222
2223   BlockChainStream_Destroy(This->smallBlockRootChain);
2224   BlockChainStream_Destroy(This->rootBlockChain);
2225   BlockChainStream_Destroy(This->smallBlockDepotChain);
2226
2227   BIGBLOCKFILE_Destructor(This->bigBlockFile);
2228   return;
2229 }
2230
2231 /******************************************************************************
2232  *      Storage32Impl_GetNextFreeBigBlock
2233  *
2234  * Returns the index of the next free big block.
2235  * If the big block depot is filled, this method will enlarge it.
2236  *
2237  */
2238 ULONG StorageImpl_GetNextFreeBigBlock(
2239   StorageImpl* This)
2240 {
2241   ULONG depotBlockIndexPos;
2242   void  *depotBuffer;
2243   ULONG depotBlockOffset;
2244   ULONG blocksPerDepot    = This->bigBlockSize / sizeof(ULONG);
2245   ULONG nextBlockIndex    = BLOCK_SPECIAL;
2246   int   depotIndex        = 0;
2247   ULONG freeBlock         = BLOCK_UNUSED;
2248
2249   depotIndex = This->prevFreeBlock / blocksPerDepot;
2250   depotBlockOffset = (This->prevFreeBlock % blocksPerDepot) * sizeof(ULONG);
2251
2252   /*
2253    * Scan the entire big block depot until we find a block marked free
2254    */
2255   while (nextBlockIndex != BLOCK_UNUSED)
2256   {
2257     if (depotIndex < COUNT_BBDEPOTINHEADER)
2258     {
2259       depotBlockIndexPos = This->bigBlockDepotStart[depotIndex];
2260
2261       /*
2262        * Grow the primary depot.
2263        */
2264       if (depotBlockIndexPos == BLOCK_UNUSED)
2265       {
2266         depotBlockIndexPos = depotIndex*blocksPerDepot;
2267
2268         /*
2269          * Add a block depot.
2270          */
2271         Storage32Impl_AddBlockDepot(This, depotBlockIndexPos);
2272         This->bigBlockDepotCount++;
2273         This->bigBlockDepotStart[depotIndex] = depotBlockIndexPos;
2274
2275         /*
2276          * Flag it as a block depot.
2277          */
2278         StorageImpl_SetNextBlockInChain(This,
2279                                           depotBlockIndexPos,
2280                                           BLOCK_SPECIAL);
2281
2282         /* Save new header information.
2283          */
2284         StorageImpl_SaveFileHeader(This);
2285       }
2286     }
2287     else
2288     {
2289       depotBlockIndexPos = Storage32Impl_GetExtDepotBlock(This, depotIndex);
2290
2291       if (depotBlockIndexPos == BLOCK_UNUSED)
2292       {
2293         /*
2294          * Grow the extended depot.
2295          */
2296         ULONG extIndex       = BLOCK_UNUSED;
2297         ULONG numExtBlocks   = depotIndex - COUNT_BBDEPOTINHEADER;
2298         ULONG extBlockOffset = numExtBlocks % (blocksPerDepot - 1);
2299
2300         if (extBlockOffset == 0)
2301         {
2302           /* We need an extended block.
2303            */
2304           extIndex = Storage32Impl_AddExtBlockDepot(This);
2305           This->extBigBlockDepotCount++;
2306           depotBlockIndexPos = extIndex + 1;
2307         }
2308         else
2309           depotBlockIndexPos = depotIndex * blocksPerDepot;
2310
2311         /*
2312          * Add a block depot and mark it in the extended block.
2313          */
2314         Storage32Impl_AddBlockDepot(This, depotBlockIndexPos);
2315         This->bigBlockDepotCount++;
2316         Storage32Impl_SetExtDepotBlock(This, depotIndex, depotBlockIndexPos);
2317
2318         /* Flag the block depot.
2319          */
2320         StorageImpl_SetNextBlockInChain(This,
2321                                           depotBlockIndexPos,
2322                                           BLOCK_SPECIAL);
2323
2324         /* If necessary, flag the extended depot block.
2325          */
2326         if (extIndex != BLOCK_UNUSED)
2327           StorageImpl_SetNextBlockInChain(This, extIndex, BLOCK_EXTBBDEPOT);
2328
2329         /* Save header information.
2330          */
2331         StorageImpl_SaveFileHeader(This);
2332       }
2333     }
2334
2335     depotBuffer = StorageImpl_GetROBigBlock(This, depotBlockIndexPos);
2336
2337     if (depotBuffer != 0)
2338     {
2339       while ( ( (depotBlockOffset/sizeof(ULONG) ) < blocksPerDepot) &&
2340               ( nextBlockIndex != BLOCK_UNUSED))
2341       {
2342         StorageUtl_ReadDWord(depotBuffer, depotBlockOffset, &nextBlockIndex);
2343
2344         if (nextBlockIndex == BLOCK_UNUSED)
2345         {
2346           freeBlock = (depotIndex * blocksPerDepot) +
2347                       (depotBlockOffset/sizeof(ULONG));
2348         }
2349
2350         depotBlockOffset += sizeof(ULONG);
2351       }
2352
2353       StorageImpl_ReleaseBigBlock(This, depotBuffer);
2354     }
2355
2356     depotIndex++;
2357     depotBlockOffset = 0;
2358   }
2359
2360   This->prevFreeBlock = freeBlock;
2361
2362   return freeBlock;
2363 }
2364
2365 /******************************************************************************
2366  *      Storage32Impl_AddBlockDepot
2367  *
2368  * This will create a depot block, essentially it is a block initialized
2369  * to BLOCK_UNUSEDs.
2370  */
2371 void Storage32Impl_AddBlockDepot(StorageImpl* This, ULONG blockIndex)
2372 {
2373   BYTE* blockBuffer;
2374
2375   blockBuffer = StorageImpl_GetBigBlock(This, blockIndex);
2376
2377   /*
2378    * Initialize blocks as free
2379    */
2380   memset(blockBuffer, BLOCK_UNUSED, This->bigBlockSize);
2381
2382   StorageImpl_ReleaseBigBlock(This, blockBuffer);
2383 }
2384
2385 /******************************************************************************
2386  *      Storage32Impl_GetExtDepotBlock
2387  *
2388  * Returns the index of the block that corresponds to the specified depot
2389  * index. This method is only for depot indexes equal or greater than
2390  * COUNT_BBDEPOTINHEADER.
2391  */
2392 ULONG Storage32Impl_GetExtDepotBlock(StorageImpl* This, ULONG depotIndex)
2393 {
2394   ULONG depotBlocksPerExtBlock = (This->bigBlockSize / sizeof(ULONG)) - 1;
2395   ULONG numExtBlocks           = depotIndex - COUNT_BBDEPOTINHEADER;
2396   ULONG extBlockCount          = numExtBlocks / depotBlocksPerExtBlock;
2397   ULONG extBlockOffset         = numExtBlocks % depotBlocksPerExtBlock;
2398   ULONG blockIndex             = BLOCK_UNUSED;
2399   ULONG extBlockIndex          = This->extBigBlockDepotStart;
2400
2401   assert(depotIndex >= COUNT_BBDEPOTINHEADER);
2402
2403   if (This->extBigBlockDepotStart == BLOCK_END_OF_CHAIN)
2404     return BLOCK_UNUSED;
2405
2406   while (extBlockCount > 0)
2407   {
2408     extBlockIndex = Storage32Impl_GetNextExtendedBlock(This, extBlockIndex);
2409     extBlockCount--;
2410   }
2411
2412   if (extBlockIndex != BLOCK_UNUSED)
2413   {
2414     BYTE* depotBuffer;
2415
2416     depotBuffer = StorageImpl_GetROBigBlock(This, extBlockIndex);
2417
2418     if (depotBuffer != 0)
2419     {
2420       StorageUtl_ReadDWord(depotBuffer,
2421                            extBlockOffset * sizeof(ULONG),
2422                            &blockIndex);
2423
2424       StorageImpl_ReleaseBigBlock(This, depotBuffer);
2425     }
2426   }
2427
2428   return blockIndex;
2429 }
2430
2431 /******************************************************************************
2432  *      Storage32Impl_SetExtDepotBlock
2433  *
2434  * Associates the specified block index to the specified depot index.
2435  * This method is only for depot indexes equal or greater than
2436  * COUNT_BBDEPOTINHEADER.
2437  */
2438 void Storage32Impl_SetExtDepotBlock(StorageImpl* This,
2439                                     ULONG depotIndex,
2440                                     ULONG blockIndex)
2441 {
2442   ULONG depotBlocksPerExtBlock = (This->bigBlockSize / sizeof(ULONG)) - 1;
2443   ULONG numExtBlocks           = depotIndex - COUNT_BBDEPOTINHEADER;
2444   ULONG extBlockCount          = numExtBlocks / depotBlocksPerExtBlock;
2445   ULONG extBlockOffset         = numExtBlocks % depotBlocksPerExtBlock;
2446   ULONG extBlockIndex          = This->extBigBlockDepotStart;
2447
2448   assert(depotIndex >= COUNT_BBDEPOTINHEADER);
2449
2450   while (extBlockCount > 0)
2451   {
2452     extBlockIndex = Storage32Impl_GetNextExtendedBlock(This, extBlockIndex);
2453     extBlockCount--;
2454   }
2455
2456   if (extBlockIndex != BLOCK_UNUSED)
2457   {
2458     BYTE* depotBuffer;
2459
2460     depotBuffer = StorageImpl_GetBigBlock(This, extBlockIndex);
2461
2462     if (depotBuffer != 0)
2463     {
2464       StorageUtl_WriteDWord(depotBuffer,
2465                             extBlockOffset * sizeof(ULONG),
2466                             blockIndex);
2467
2468       StorageImpl_ReleaseBigBlock(This, depotBuffer);
2469     }
2470   }
2471 }
2472
2473 /******************************************************************************
2474  *      Storage32Impl_AddExtBlockDepot
2475  *
2476  * Creates an extended depot block.
2477  */
2478 ULONG Storage32Impl_AddExtBlockDepot(StorageImpl* This)
2479 {
2480   ULONG numExtBlocks           = This->extBigBlockDepotCount;
2481   ULONG nextExtBlock           = This->extBigBlockDepotStart;
2482   BYTE* depotBuffer            = NULL;
2483   ULONG index                  = BLOCK_UNUSED;
2484   ULONG nextBlockOffset        = This->bigBlockSize - sizeof(ULONG);
2485   ULONG blocksPerDepotBlock    = This->bigBlockSize / sizeof(ULONG);
2486   ULONG depotBlocksPerExtBlock = blocksPerDepotBlock - 1;
2487
2488   index = (COUNT_BBDEPOTINHEADER + (numExtBlocks * depotBlocksPerExtBlock)) *
2489           blocksPerDepotBlock;
2490
2491   if ((numExtBlocks == 0) && (nextExtBlock == BLOCK_END_OF_CHAIN))
2492   {
2493     /*
2494      * The first extended block.
2495      */
2496     This->extBigBlockDepotStart = index;
2497   }
2498   else
2499   {
2500     int i;
2501     /*
2502      * Follow the chain to the last one.
2503      */
2504     for (i = 0; i < (numExtBlocks - 1); i++)
2505     {
2506       nextExtBlock = Storage32Impl_GetNextExtendedBlock(This, nextExtBlock);
2507     }
2508
2509     /*
2510      * Add the new extended block to the chain.
2511      */
2512     depotBuffer = StorageImpl_GetBigBlock(This, nextExtBlock);
2513     StorageUtl_WriteDWord(depotBuffer, nextBlockOffset, index);
2514     StorageImpl_ReleaseBigBlock(This, depotBuffer);
2515   }
2516
2517   /*
2518    * Initialize this block.
2519    */
2520   depotBuffer = StorageImpl_GetBigBlock(This, index);
2521   memset(depotBuffer, BLOCK_UNUSED, This->bigBlockSize);
2522   StorageImpl_ReleaseBigBlock(This, depotBuffer);
2523
2524   return index;
2525 }
2526
2527 /******************************************************************************
2528  *      Storage32Impl_FreeBigBlock
2529  *
2530  * This method will flag the specified block as free in the big block depot.
2531  */
2532 void  StorageImpl_FreeBigBlock(
2533   StorageImpl* This,
2534   ULONG          blockIndex)
2535 {
2536   StorageImpl_SetNextBlockInChain(This, blockIndex, BLOCK_UNUSED);
2537
2538   if (blockIndex < This->prevFreeBlock)
2539     This->prevFreeBlock = blockIndex;
2540 }
2541
2542 /************************************************************************
2543  * Storage32Impl_GetNextBlockInChain
2544  *
2545  * This method will retrieve the block index of the next big block in
2546  * in the chain.
2547  *
2548  * Params:  This       - Pointer to the Storage object.
2549  *          blockIndex - Index of the block to retrieve the chain
2550  *                       for.
2551  *
2552  * Returns: This method returns the index of the next block in the chain.
2553  *          It will return the constants:
2554  *              BLOCK_SPECIAL - If the block given was not part of a
2555  *                              chain.
2556  *              BLOCK_END_OF_CHAIN - If the block given was the last in
2557  *                                   a chain.
2558  *              BLOCK_UNUSED - If the block given was not past of a chain
2559  *                             and is available.
2560  *              BLOCK_EXTBBDEPOT - This block is part of the extended
2561  *                                 big block depot.
2562  *
2563  * See Windows documentation for more details on IStorage methods.
2564  */
2565 ULONG StorageImpl_GetNextBlockInChain(
2566   StorageImpl* This,
2567   ULONG          blockIndex)
2568 {
2569   ULONG offsetInDepot    = blockIndex * sizeof (ULONG);
2570   ULONG depotBlockCount  = offsetInDepot / This->bigBlockSize;
2571   ULONG depotBlockOffset = offsetInDepot % This->bigBlockSize;
2572   ULONG nextBlockIndex   = BLOCK_SPECIAL;
2573   void* depotBuffer;
2574   ULONG depotBlockIndexPos;
2575
2576   assert(depotBlockCount < This->bigBlockDepotCount);
2577
2578   /*
2579    * Cache the currently accessed depot block.
2580    */
2581   if (depotBlockCount != This->indexBlockDepotCached)
2582   {
2583     This->indexBlockDepotCached = depotBlockCount;
2584
2585     if (depotBlockCount < COUNT_BBDEPOTINHEADER)
2586     {
2587       depotBlockIndexPos = This->bigBlockDepotStart[depotBlockCount];
2588     }
2589     else
2590     {
2591       /*
2592        * We have to look in the extended depot.
2593        */
2594       depotBlockIndexPos = Storage32Impl_GetExtDepotBlock(This, depotBlockCount);
2595     }
2596
2597     depotBuffer = StorageImpl_GetROBigBlock(This, depotBlockIndexPos);
2598
2599     if (depotBuffer!=0)
2600     {
2601       int index;
2602
2603       for (index = 0; index < NUM_BLOCKS_PER_DEPOT_BLOCK; index++)
2604       {
2605         StorageUtl_ReadDWord(depotBuffer, index*sizeof(ULONG), &nextBlockIndex);
2606         This->blockDepotCached[index] = nextBlockIndex;
2607       }
2608
2609       StorageImpl_ReleaseBigBlock(This, depotBuffer);
2610     }
2611   }
2612
2613   nextBlockIndex = This->blockDepotCached[depotBlockOffset/sizeof(ULONG)];
2614
2615   return nextBlockIndex;
2616 }
2617
2618 /******************************************************************************
2619  *      Storage32Impl_GetNextExtendedBlock
2620  *
2621  * Given an extended block this method will return the next extended block.
2622  *
2623  * NOTES:
2624  * The last ULONG of an extended block is the block index of the next
2625  * extended block. Extended blocks are marked as BLOCK_EXTBBDEPOT in the
2626  * depot.
2627  *
2628  * Return values:
2629  *    - The index of the next extended block
2630  *    - BLOCK_UNUSED: there is no next extended block.
2631  *    - Any other return values denotes failure.
2632  */
2633 ULONG Storage32Impl_GetNextExtendedBlock(StorageImpl* This, ULONG blockIndex)
2634 {
2635   ULONG nextBlockIndex   = BLOCK_SPECIAL;
2636   ULONG depotBlockOffset = This->bigBlockSize - sizeof(ULONG);
2637   void* depotBuffer;
2638
2639   depotBuffer = StorageImpl_GetROBigBlock(This, blockIndex);
2640
2641   if (depotBuffer!=0)
2642   {
2643     StorageUtl_ReadDWord(depotBuffer, depotBlockOffset, &nextBlockIndex);
2644
2645     StorageImpl_ReleaseBigBlock(This, depotBuffer);
2646   }
2647
2648   return nextBlockIndex;
2649 }
2650
2651 /******************************************************************************
2652  *      Storage32Impl_SetNextBlockInChain
2653  *
2654  * This method will write the index of the specified block's next block
2655  * in the big block depot.
2656  *
2657  * For example: to create the chain 3 -> 1 -> 7 -> End of Chain
2658  *              do the following
2659  *
2660  * Storage32Impl_SetNextBlockInChain(This, 3, 1);
2661  * Storage32Impl_SetNextBlockInChain(This, 1, 7);
2662  * Storage32Impl_SetNextBlockInChain(This, 7, BLOCK_END_OF_CHAIN);
2663  *
2664  */
2665 void  StorageImpl_SetNextBlockInChain(
2666           StorageImpl* This,
2667           ULONG          blockIndex,
2668           ULONG          nextBlock)
2669 {
2670   ULONG offsetInDepot    = blockIndex * sizeof (ULONG);
2671   ULONG depotBlockCount  = offsetInDepot / This->bigBlockSize;
2672   ULONG depotBlockOffset = offsetInDepot % This->bigBlockSize;
2673   ULONG depotBlockIndexPos;
2674   void* depotBuffer;
2675
2676   assert(depotBlockCount < This->bigBlockDepotCount);
2677   assert(blockIndex != nextBlock);
2678
2679   if (depotBlockCount < COUNT_BBDEPOTINHEADER)
2680   {
2681     depotBlockIndexPos = This->bigBlockDepotStart[depotBlockCount];
2682   }
2683   else
2684   {
2685     /*
2686      * We have to look in the extended depot.
2687      */
2688     depotBlockIndexPos = Storage32Impl_GetExtDepotBlock(This, depotBlockCount);
2689   }
2690
2691   depotBuffer = StorageImpl_GetBigBlock(This, depotBlockIndexPos);
2692
2693   if (depotBuffer!=0)
2694   {
2695     StorageUtl_WriteDWord(depotBuffer, depotBlockOffset, nextBlock);
2696     StorageImpl_ReleaseBigBlock(This, depotBuffer);
2697   }
2698
2699   /*
2700    * Update the cached block depot, if necessary.
2701    */
2702   if (depotBlockCount == This->indexBlockDepotCached)
2703   {
2704     This->blockDepotCached[depotBlockOffset/sizeof(ULONG)] = nextBlock;
2705   }
2706 }
2707
2708 /******************************************************************************
2709  *      Storage32Impl_LoadFileHeader
2710  *
2711  * This method will read in the file header, i.e. big block index -1.
2712  */
2713 HRESULT StorageImpl_LoadFileHeader(
2714           StorageImpl* This)
2715 {
2716   HRESULT hr = STG_E_FILENOTFOUND;
2717   void*   headerBigBlock = NULL;
2718   int     index;
2719
2720   /*
2721    * Get a pointer to the big block of data containing the header.
2722    */
2723   headerBigBlock = StorageImpl_GetROBigBlock(This, -1);
2724
2725   /*
2726    * Extract the information from the header.
2727    */
2728   if (headerBigBlock!=0)
2729   {
2730     /*
2731      * Check for the "magic number" signature and return an error if it is not
2732      * found.
2733      */
2734     if (memcmp(headerBigBlock, STORAGE_oldmagic, sizeof(STORAGE_oldmagic))==0)
2735     {
2736       StorageImpl_ReleaseBigBlock(This, headerBigBlock);
2737       return STG_E_OLDFORMAT;
2738     }
2739
2740     if (memcmp(headerBigBlock, STORAGE_magic, sizeof(STORAGE_magic))!=0)
2741     {
2742       StorageImpl_ReleaseBigBlock(This, headerBigBlock);
2743       return STG_E_INVALIDHEADER;
2744     }
2745
2746     StorageUtl_ReadWord(
2747       headerBigBlock,
2748       OFFSET_BIGBLOCKSIZEBITS,
2749       &This->bigBlockSizeBits);
2750
2751     StorageUtl_ReadWord(
2752       headerBigBlock,
2753       OFFSET_SMALLBLOCKSIZEBITS,
2754       &This->smallBlockSizeBits);
2755
2756     StorageUtl_ReadDWord(
2757       headerBigBlock,
2758       OFFSET_BBDEPOTCOUNT,
2759       &This->bigBlockDepotCount);
2760
2761     StorageUtl_ReadDWord(
2762       headerBigBlock,
2763       OFFSET_ROOTSTARTBLOCK,
2764       &This->rootStartBlock);
2765
2766     StorageUtl_ReadDWord(
2767       headerBigBlock,
2768       OFFSET_SBDEPOTSTART,
2769       &This->smallBlockDepotStart);
2770
2771     StorageUtl_ReadDWord(
2772       headerBigBlock,
2773       OFFSET_EXTBBDEPOTSTART,
2774       &This->extBigBlockDepotStart);
2775
2776     StorageUtl_ReadDWord(
2777       headerBigBlock,
2778       OFFSET_EXTBBDEPOTCOUNT,
2779       &This->extBigBlockDepotCount);
2780
2781     for (index = 0; index < COUNT_BBDEPOTINHEADER; index ++)
2782     {
2783       StorageUtl_ReadDWord(
2784         headerBigBlock,
2785         OFFSET_BBDEPOTSTART + (sizeof(ULONG)*index),
2786         &(This->bigBlockDepotStart[index]));
2787     }
2788
2789     /*
2790      * Make the bitwise arithmetic to get the size of the blocks in bytes.
2791      */
2792     if ((1 << 2) == 4)
2793     {
2794       This->bigBlockSize   = 0x000000001 << (DWORD)This->bigBlockSizeBits;
2795       This->smallBlockSize = 0x000000001 << (DWORD)This->smallBlockSizeBits;
2796     }
2797     else
2798     {
2799       This->bigBlockSize   = 0x000000001 >> (DWORD)This->bigBlockSizeBits;
2800       This->smallBlockSize = 0x000000001 >> (DWORD)This->smallBlockSizeBits;
2801     }
2802
2803     /*
2804      * Right now, the code is making some assumptions about the size of the
2805      * blocks, just make sure they are what we're expecting.
2806      */
2807     assert( (This->bigBlockSize==DEF_BIG_BLOCK_SIZE) &&
2808             (This->smallBlockSize==DEF_SMALL_BLOCK_SIZE));
2809
2810     /*
2811      * Release the block.
2812      */
2813     StorageImpl_ReleaseBigBlock(This, headerBigBlock);
2814
2815     hr = S_OK;
2816   }
2817
2818   return hr;
2819 }
2820
2821 /******************************************************************************
2822  *      Storage32Impl_SaveFileHeader
2823  *
2824  * This method will save to the file the header, i.e. big block -1.
2825  */
2826 void StorageImpl_SaveFileHeader(
2827           StorageImpl* This)
2828 {
2829   BYTE   headerBigBlock[BIG_BLOCK_SIZE];
2830   int    index;
2831   BOOL success;
2832
2833   /*
2834    * Get a pointer to the big block of data containing the header.
2835    */
2836   success = StorageImpl_ReadBigBlock(This, -1, headerBigBlock);
2837
2838   /*
2839    * If the block read failed, the file is probably new.
2840    */
2841   if (!success)
2842   {
2843     /*
2844      * Initialize for all unknown fields.
2845      */
2846     memset(headerBigBlock, 0, BIG_BLOCK_SIZE);
2847
2848     /*
2849      * Initialize the magic number.
2850      */
2851     memcpy(headerBigBlock, STORAGE_magic, sizeof(STORAGE_magic));
2852
2853     /*
2854      * And a bunch of things we don't know what they mean
2855      */
2856     StorageUtl_WriteWord(headerBigBlock,  0x18, 0x3b);
2857     StorageUtl_WriteWord(headerBigBlock,  0x1a, 0x3);
2858     StorageUtl_WriteWord(headerBigBlock,  0x1c, (WORD)-2);
2859     StorageUtl_WriteDWord(headerBigBlock, 0x38, (DWORD)0x1000);
2860     StorageUtl_WriteDWord(headerBigBlock, 0x40, (DWORD)0x0001);
2861   }
2862
2863   /*
2864    * Write the information to the header.
2865    */
2866   if (headerBigBlock!=0)
2867   {
2868     StorageUtl_WriteWord(
2869       headerBigBlock,
2870       OFFSET_BIGBLOCKSIZEBITS,
2871       This->bigBlockSizeBits);
2872
2873     StorageUtl_WriteWord(
2874       headerBigBlock,
2875       OFFSET_SMALLBLOCKSIZEBITS,
2876       This->smallBlockSizeBits);
2877
2878     StorageUtl_WriteDWord(
2879       headerBigBlock,
2880       OFFSET_BBDEPOTCOUNT,
2881       This->bigBlockDepotCount);
2882
2883     StorageUtl_WriteDWord(
2884       headerBigBlock,
2885       OFFSET_ROOTSTARTBLOCK,
2886       This->rootStartBlock);
2887
2888     StorageUtl_WriteDWord(
2889       headerBigBlock,
2890       OFFSET_SBDEPOTSTART,
2891       This->smallBlockDepotStart);
2892
2893     StorageUtl_WriteDWord(
2894       headerBigBlock,
2895       OFFSET_EXTBBDEPOTSTART,
2896       This->extBigBlockDepotStart);
2897
2898     StorageUtl_WriteDWord(
2899       headerBigBlock,
2900       OFFSET_EXTBBDEPOTCOUNT,
2901       This->extBigBlockDepotCount);
2902
2903     for (index = 0; index < COUNT_BBDEPOTINHEADER; index ++)
2904     {
2905       StorageUtl_WriteDWord(
2906         headerBigBlock,
2907         OFFSET_BBDEPOTSTART + (sizeof(ULONG)*index),
2908         (This->bigBlockDepotStart[index]));
2909     }
2910   }
2911
2912   /*
2913    * Write the big block back to the file.
2914    */
2915   StorageImpl_WriteBigBlock(This, -1, headerBigBlock);
2916 }
2917
2918 /******************************************************************************
2919  *      Storage32Impl_ReadProperty
2920  *
2921  * This method will read the specified property from the property chain.
2922  */
2923 BOOL StorageImpl_ReadProperty(
2924   StorageImpl* This,
2925   ULONG          index,
2926   StgProperty*   buffer)
2927 {
2928   BYTE           currentProperty[PROPSET_BLOCK_SIZE];
2929   ULARGE_INTEGER offsetInPropSet;
2930   BOOL         readSucessful;
2931   ULONG          bytesRead;
2932
2933   offsetInPropSet.HighPart = 0;
2934   offsetInPropSet.LowPart  = index * PROPSET_BLOCK_SIZE;
2935
2936   readSucessful = BlockChainStream_ReadAt(
2937                     This->rootBlockChain,
2938                     offsetInPropSet,
2939                     PROPSET_BLOCK_SIZE,
2940                     currentProperty,
2941                     &bytesRead);
2942
2943   if (readSucessful)
2944   {
2945     memset(buffer->name, 0, sizeof(buffer->name));
2946     memcpy(
2947       buffer->name,
2948       currentProperty+OFFSET_PS_NAME,
2949       PROPERTY_NAME_BUFFER_LEN );
2950
2951     memcpy(&buffer->propertyType, currentProperty + OFFSET_PS_PROPERTYTYPE, 1);
2952
2953     StorageUtl_ReadWord(
2954       currentProperty,
2955       OFFSET_PS_NAMELENGTH,
2956       &buffer->sizeOfNameString);
2957
2958     StorageUtl_ReadDWord(
2959       currentProperty,
2960       OFFSET_PS_PREVIOUSPROP,
2961       &buffer->previousProperty);
2962
2963     StorageUtl_ReadDWord(
2964       currentProperty,
2965       OFFSET_PS_NEXTPROP,
2966       &buffer->nextProperty);
2967
2968     StorageUtl_ReadDWord(
2969       currentProperty,
2970       OFFSET_PS_DIRPROP,
2971       &buffer->dirProperty);
2972
2973     StorageUtl_ReadGUID(
2974       currentProperty,
2975       OFFSET_PS_GUID,
2976       &buffer->propertyUniqueID);
2977
2978     StorageUtl_ReadDWord(
2979       currentProperty,
2980       OFFSET_PS_TSS1,
2981       &buffer->timeStampS1);
2982
2983     StorageUtl_ReadDWord(
2984       currentProperty,
2985       OFFSET_PS_TSD1,
2986       &buffer->timeStampD1);
2987
2988     StorageUtl_ReadDWord(
2989       currentProperty,
2990       OFFSET_PS_TSS2,
2991       &buffer->timeStampS2);
2992
2993     StorageUtl_ReadDWord(
2994       currentProperty,
2995       OFFSET_PS_TSD2,
2996       &buffer->timeStampD2);
2997
2998     StorageUtl_ReadDWord(
2999       currentProperty,
3000       OFFSET_PS_STARTBLOCK,
3001       &buffer->startingBlock);
3002
3003     StorageUtl_ReadDWord(
3004       currentProperty,
3005       OFFSET_PS_SIZE,
3006       &buffer->size.LowPart);
3007
3008     buffer->size.HighPart = 0;
3009   }
3010
3011   return readSucessful;
3012 }
3013
3014 /*********************************************************************
3015  * Write the specified property into the property chain
3016  */
3017 BOOL StorageImpl_WriteProperty(
3018   StorageImpl* This,
3019   ULONG          index,
3020   StgProperty*   buffer)
3021 {
3022   BYTE           currentProperty[PROPSET_BLOCK_SIZE];
3023   ULARGE_INTEGER offsetInPropSet;
3024   BOOL         writeSucessful;
3025   ULONG          bytesWritten;
3026
3027   offsetInPropSet.HighPart = 0;
3028   offsetInPropSet.LowPart  = index * PROPSET_BLOCK_SIZE;
3029
3030   memset(currentProperty, 0, PROPSET_BLOCK_SIZE);
3031
3032   memcpy(
3033     currentProperty + OFFSET_PS_NAME,
3034     buffer->name,
3035     PROPERTY_NAME_BUFFER_LEN );
3036
3037   memcpy(currentProperty + OFFSET_PS_PROPERTYTYPE, &buffer->propertyType, 1);
3038
3039   /*
3040    * Reassign the size in case of mistake....
3041    */
3042   buffer->sizeOfNameString = (lstrlenW(buffer->name)+1) * sizeof(WCHAR);
3043
3044   StorageUtl_WriteWord(
3045     currentProperty,
3046       OFFSET_PS_NAMELENGTH,
3047       buffer->sizeOfNameString);
3048
3049   StorageUtl_WriteDWord(
3050     currentProperty,
3051       OFFSET_PS_PREVIOUSPROP,
3052       buffer->previousProperty);
3053
3054   StorageUtl_WriteDWord(
3055     currentProperty,
3056       OFFSET_PS_NEXTPROP,
3057       buffer->nextProperty);
3058
3059   StorageUtl_WriteDWord(
3060     currentProperty,
3061       OFFSET_PS_DIRPROP,
3062       buffer->dirProperty);
3063
3064   StorageUtl_WriteGUID(
3065     currentProperty,
3066       OFFSET_PS_GUID,
3067       &buffer->propertyUniqueID);
3068
3069   StorageUtl_WriteDWord(
3070     currentProperty,
3071       OFFSET_PS_TSS1,
3072       buffer->timeStampS1);
3073
3074   StorageUtl_WriteDWord(
3075     currentProperty,
3076       OFFSET_PS_TSD1,
3077       buffer->timeStampD1);
3078
3079   StorageUtl_WriteDWord(
3080     currentProperty,
3081       OFFSET_PS_TSS2,
3082       buffer->timeStampS2);
3083
3084   StorageUtl_WriteDWord(
3085     currentProperty,
3086       OFFSET_PS_TSD2,
3087       buffer->timeStampD2);
3088
3089   StorageUtl_WriteDWord(
3090     currentProperty,
3091       OFFSET_PS_STARTBLOCK,
3092       buffer->startingBlock);
3093
3094   StorageUtl_WriteDWord(
3095     currentProperty,
3096       OFFSET_PS_SIZE,
3097       buffer->size.LowPart);
3098
3099   writeSucessful = BlockChainStream_WriteAt(This->rootBlockChain,
3100                                             offsetInPropSet,
3101                                             PROPSET_BLOCK_SIZE,
3102                                             currentProperty,
3103                                             &bytesWritten);
3104   return writeSucessful;
3105 }
3106
3107 BOOL StorageImpl_ReadBigBlock(
3108   StorageImpl* This,
3109   ULONG          blockIndex,
3110   void*          buffer)
3111 {
3112   void* bigBlockBuffer;
3113
3114   bigBlockBuffer = StorageImpl_GetROBigBlock(This, blockIndex);
3115
3116   if (bigBlockBuffer!=0)
3117   {
3118     memcpy(buffer, bigBlockBuffer, This->bigBlockSize);
3119
3120     StorageImpl_ReleaseBigBlock(This, bigBlockBuffer);
3121
3122     return TRUE;
3123   }
3124
3125   return FALSE;
3126 }
3127
3128 BOOL StorageImpl_WriteBigBlock(
3129   StorageImpl* This,
3130   ULONG          blockIndex,
3131   void*          buffer)
3132 {
3133   void* bigBlockBuffer;
3134
3135   bigBlockBuffer = StorageImpl_GetBigBlock(This, blockIndex);
3136
3137   if (bigBlockBuffer!=0)
3138   {
3139     memcpy(bigBlockBuffer, buffer, This->bigBlockSize);
3140
3141     StorageImpl_ReleaseBigBlock(This, bigBlockBuffer);
3142
3143     return TRUE;
3144   }
3145
3146   return FALSE;
3147 }
3148
3149 void* StorageImpl_GetROBigBlock(
3150   StorageImpl* This,
3151   ULONG          blockIndex)
3152 {
3153   return BIGBLOCKFILE_GetROBigBlock(This->bigBlockFile, blockIndex);
3154 }
3155
3156 void* StorageImpl_GetBigBlock(
3157   StorageImpl* This,
3158   ULONG          blockIndex)
3159 {
3160   return BIGBLOCKFILE_GetBigBlock(This->bigBlockFile, blockIndex);
3161 }
3162
3163 void StorageImpl_ReleaseBigBlock(
3164   StorageImpl* This,
3165   void*          pBigBlock)
3166 {
3167   BIGBLOCKFILE_ReleaseBigBlock(This->bigBlockFile, pBigBlock);
3168 }
3169
3170 /******************************************************************************
3171  *              Storage32Impl_SmallBlocksToBigBlocks
3172  *
3173  * This method will convert a small block chain to a big block chain.
3174  * The small block chain will be destroyed.
3175  */
3176 BlockChainStream* Storage32Impl_SmallBlocksToBigBlocks(
3177                       StorageImpl* This,
3178                       SmallBlockChainStream** ppsbChain)
3179 {
3180   ULONG bbHeadOfChain = BLOCK_END_OF_CHAIN;
3181   ULARGE_INTEGER size, offset;
3182   ULONG cbRead, cbWritten, cbTotalRead, cbTotalWritten;
3183   ULONG propertyIndex;
3184   BOOL successRead, successWrite;
3185   StgProperty chainProperty;
3186   BYTE buffer[DEF_SMALL_BLOCK_SIZE];
3187   BlockChainStream *bbTempChain = NULL;
3188   BlockChainStream *bigBlockChain = NULL;
3189
3190   /*
3191    * Create a temporary big block chain that doesn't have
3192    * an associated property. This temporary chain will be
3193    * used to copy data from small blocks to big blocks.
3194    */
3195   bbTempChain = BlockChainStream_Construct(This,
3196                                            &bbHeadOfChain,
3197                                            PROPERTY_NULL);
3198
3199   /*
3200    * Grow the big block chain.
3201    */
3202   size = SmallBlockChainStream_GetSize(*ppsbChain);
3203   BlockChainStream_SetSize(bbTempChain, size);
3204
3205   /*
3206    * Copy the contents of the small block chain to the big block chain
3207    * by small block size increments.
3208    */
3209   offset.LowPart = 0;
3210   offset.HighPart = 0;
3211   cbTotalRead = 0;
3212   cbTotalWritten = 0;
3213
3214   do
3215   {
3216     successRead = SmallBlockChainStream_ReadAt(*ppsbChain,
3217                                                offset,
3218                                                sizeof(buffer),
3219                                                buffer,
3220                                                &cbRead);
3221     cbTotalRead += cbRead;
3222
3223     successWrite = BlockChainStream_WriteAt(bbTempChain,
3224                                             offset,
3225                                             cbRead,
3226                                             buffer,
3227                                             &cbWritten);
3228     cbTotalWritten += cbWritten;
3229
3230     offset.LowPart += This->smallBlockSize;
3231
3232   } while (successRead && successWrite);
3233
3234   assert(cbTotalRead == cbTotalWritten);
3235
3236   /*
3237    * Destroy the small block chain.
3238    */
3239   propertyIndex = (*ppsbChain)->ownerPropertyIndex;
3240   size.HighPart = 0;
3241   size.LowPart  = 0;
3242   SmallBlockChainStream_SetSize(*ppsbChain, size);
3243   SmallBlockChainStream_Destroy(*ppsbChain);
3244   *ppsbChain = 0;
3245
3246   /*
3247    * Change the property information. This chain is now a big block chain
3248    * and it doesn't reside in the small blocks chain anymore.
3249    */
3250   StorageImpl_ReadProperty(This, propertyIndex, &chainProperty);
3251
3252   chainProperty.startingBlock = bbHeadOfChain;
3253
3254   StorageImpl_WriteProperty(This, propertyIndex, &chainProperty);
3255
3256   /*
3257    * Destroy the temporary propertyless big block chain.
3258    * Create a new big block chain associated with this property.
3259    */
3260   BlockChainStream_Destroy(bbTempChain);
3261   bigBlockChain = BlockChainStream_Construct(This,
3262                                              NULL,
3263                                              propertyIndex);
3264
3265   return bigBlockChain;
3266 }
3267
3268 /******************************************************************************
3269 ** Storage32InternalImpl implementation
3270 */
3271
3272 StorageInternalImpl* StorageInternalImpl_Construct(
3273   StorageImpl* ancestorStorage,
3274   ULONG          rootPropertyIndex)
3275 {
3276   StorageInternalImpl* newStorage;
3277
3278   /*
3279    * Allocate space for the new storage object
3280    */
3281   newStorage = HeapAlloc(GetProcessHeap(), 0, sizeof(StorageInternalImpl));
3282
3283   if (newStorage!=0)
3284   {
3285     memset(newStorage, 0, sizeof(StorageInternalImpl));
3286
3287     /*
3288      * Initialize the virtual function table.
3289      */
3290     newStorage->lpvtbl       = &Storage32InternalImpl_Vtbl;
3291     newStorage->v_destructor = &StorageInternalImpl_Destroy;
3292
3293     /*
3294      * Keep the ancestor storage pointer and nail a reference to it.
3295      */
3296     newStorage->ancestorStorage = ancestorStorage;
3297     StorageBaseImpl_AddRef((IStorage*)(newStorage->ancestorStorage));
3298
3299     /*
3300      * Keep the index of the root property set for this storage,
3301      */
3302     newStorage->rootPropertySetIndex = rootPropertyIndex;
3303
3304     return newStorage;
3305   }
3306
3307   return 0;
3308 }
3309
3310 void StorageInternalImpl_Destroy(
3311   StorageInternalImpl* This)
3312 {
3313   StorageBaseImpl_Release((IStorage*)This->ancestorStorage);
3314   HeapFree(GetProcessHeap(), 0, This);
3315 }
3316
3317 /******************************************************************************
3318 **
3319 ** Storage32InternalImpl_Commit
3320 **
3321 ** The non-root storages cannot be opened in transacted mode thus this function
3322 ** does nothing.
3323 */
3324 HRESULT WINAPI StorageInternalImpl_Commit(
3325   IStorage*            iface,
3326   DWORD                  grfCommitFlags)  /* [in] */
3327 {
3328   return S_OK;
3329 }
3330
3331 /******************************************************************************
3332 **
3333 ** Storage32InternalImpl_Revert
3334 **
3335 ** The non-root storages cannot be opened in transacted mode thus this function
3336 ** does nothing.
3337 */
3338 HRESULT WINAPI StorageInternalImpl_Revert(
3339   IStorage*            iface)
3340 {
3341   return S_OK;
3342 }
3343
3344 /******************************************************************************
3345 ** IEnumSTATSTGImpl implementation
3346 */
3347
3348 IEnumSTATSTGImpl* IEnumSTATSTGImpl_Construct(
3349   StorageImpl* parentStorage,
3350   ULONG          firstPropertyNode)
3351 {
3352   IEnumSTATSTGImpl* newEnumeration;
3353
3354   newEnumeration = HeapAlloc(GetProcessHeap(), 0, sizeof(IEnumSTATSTGImpl));
3355
3356   if (newEnumeration!=0)
3357   {
3358     /*
3359      * Set-up the virtual function table and reference count.
3360      */
3361     newEnumeration->lpvtbl = &IEnumSTATSTGImpl_Vtbl;
3362     newEnumeration->ref    = 0;
3363
3364     /*
3365      * We want to nail-down the reference to the storage in case the
3366      * enumeration out-lives the storage in the client application.
3367      */
3368     newEnumeration->parentStorage = parentStorage;
3369     IStorage_AddRef((IStorage*)newEnumeration->parentStorage);
3370
3371     newEnumeration->firstPropertyNode   = firstPropertyNode;
3372
3373     /*
3374      * Initialize the search stack
3375      */
3376     newEnumeration->stackSize    = 0;
3377     newEnumeration->stackMaxSize = ENUMSTATSGT_SIZE_INCREMENT;
3378     newEnumeration->stackToVisit =
3379       HeapAlloc(GetProcessHeap(), 0, sizeof(ULONG)*ENUMSTATSGT_SIZE_INCREMENT);
3380
3381     /*
3382      * Make sure the current node of the iterator is the first one.
3383      */
3384     IEnumSTATSTGImpl_Reset((IEnumSTATSTG*)newEnumeration);
3385   }
3386
3387   return newEnumeration;
3388 }
3389
3390 void IEnumSTATSTGImpl_Destroy(IEnumSTATSTGImpl* This)
3391 {
3392   IStorage_Release((IStorage*)This->parentStorage);
3393   HeapFree(GetProcessHeap(), 0, This->stackToVisit);
3394   HeapFree(GetProcessHeap(), 0, This);
3395 }
3396
3397 HRESULT WINAPI IEnumSTATSTGImpl_QueryInterface(
3398   IEnumSTATSTG*     iface,
3399   REFIID            riid,
3400   void**            ppvObject)
3401 {
3402   IEnumSTATSTGImpl* const This=(IEnumSTATSTGImpl*)iface;
3403
3404   /*
3405    * Perform a sanity check on the parameters.
3406    */
3407   if (ppvObject==0)
3408     return E_INVALIDARG;
3409
3410   /*
3411    * Initialize the return parameter.
3412    */
3413   *ppvObject = 0;
3414
3415   /*
3416    * Compare the riid with the interface IDs implemented by this object.
3417    */
3418   if (memcmp(&IID_IUnknown, riid, sizeof(IID_IUnknown)) == 0)
3419   {
3420     *ppvObject = (IEnumSTATSTG*)This;
3421   }
3422   else if (memcmp(&IID_IStorage, riid, sizeof(IID_IEnumSTATSTG)) == 0)
3423   {
3424     *ppvObject = (IEnumSTATSTG*)This;
3425   }
3426
3427   /*
3428    * Check that we obtained an interface.
3429    */
3430   if ((*ppvObject)==0)
3431     return E_NOINTERFACE;
3432
3433   /*
3434    * Query Interface always increases the reference count by one when it is
3435    * successful
3436    */
3437   IEnumSTATSTGImpl_AddRef((IEnumSTATSTG*)This);
3438
3439   return S_OK;
3440 }
3441
3442 ULONG   WINAPI IEnumSTATSTGImpl_AddRef(
3443   IEnumSTATSTG* iface)
3444 {
3445   IEnumSTATSTGImpl* const This=(IEnumSTATSTGImpl*)iface;
3446
3447   This->ref++;
3448   return This->ref;
3449 }
3450
3451 ULONG   WINAPI IEnumSTATSTGImpl_Release(
3452   IEnumSTATSTG* iface)
3453 {
3454   IEnumSTATSTGImpl* const This=(IEnumSTATSTGImpl*)iface;
3455
3456   ULONG newRef;
3457
3458   This->ref--;
3459   newRef = This->ref;
3460
3461   /*
3462    * If the reference count goes down to 0, perform suicide.
3463    */
3464   if (newRef==0)
3465   {
3466     IEnumSTATSTGImpl_Destroy(This);
3467   }
3468
3469   return newRef;;
3470 }
3471
3472 HRESULT WINAPI IEnumSTATSTGImpl_Next(
3473   IEnumSTATSTG* iface,
3474   ULONG             celt,
3475   STATSTG*          rgelt,
3476   ULONG*            pceltFetched)
3477 {
3478   IEnumSTATSTGImpl* const This=(IEnumSTATSTGImpl*)iface;
3479
3480   StgProperty currentProperty;
3481   STATSTG*    currentReturnStruct = rgelt;
3482   ULONG       objectFetched       = 0;
3483   ULONG      currentSearchNode;
3484
3485   /*
3486    * Perform a sanity check on the parameters.
3487    */
3488   if ( (rgelt==0) || ( (celt!=1) && (pceltFetched==0) ) )
3489     return E_INVALIDARG;
3490
3491   /*
3492    * To avoid the special case, get another pointer to a ULONG value if
3493    * the caller didn't supply one.
3494    */
3495   if (pceltFetched==0)
3496     pceltFetched = &objectFetched;
3497
3498   /*
3499    * Start the iteration, we will iterate until we hit the end of the
3500    * linked list or until we hit the number of items to iterate through
3501    */
3502   *pceltFetched = 0;
3503
3504   /*
3505    * Start with the node at the top of the stack.
3506    */
3507   currentSearchNode = IEnumSTATSTGImpl_PopSearchNode(This, FALSE);
3508
3509   while ( ( *pceltFetched < celt) &&
3510           ( currentSearchNode!=PROPERTY_NULL) )
3511   {
3512     /*
3513      * Remove the top node from the stack
3514      */
3515     IEnumSTATSTGImpl_PopSearchNode(This, TRUE);
3516
3517     /*
3518      * Read the property from the storage.
3519      */
3520     StorageImpl_ReadProperty(This->parentStorage,
3521       currentSearchNode,
3522       &currentProperty);
3523
3524     /*
3525      * Copy the information to the return buffer.
3526      */
3527     StorageUtl_CopyPropertyToSTATSTG(currentReturnStruct,
3528       &currentProperty,
3529       STATFLAG_DEFAULT);
3530
3531     /*
3532      * Step to the next item in the iteration
3533      */
3534     (*pceltFetched)++;
3535     currentReturnStruct++;
3536
3537     /*
3538      * Push the next search node in the search stack.
3539      */
3540     IEnumSTATSTGImpl_PushSearchNode(This, currentProperty.nextProperty);
3541
3542     /*
3543      * continue the iteration.
3544      */
3545     currentSearchNode = IEnumSTATSTGImpl_PopSearchNode(This, FALSE);
3546   }
3547
3548   if (*pceltFetched == celt)
3549     return S_OK;
3550
3551   return S_FALSE;
3552 }
3553
3554
3555 HRESULT WINAPI IEnumSTATSTGImpl_Skip(
3556   IEnumSTATSTG* iface,
3557   ULONG             celt)
3558 {
3559   IEnumSTATSTGImpl* const This=(IEnumSTATSTGImpl*)iface;
3560
3561   StgProperty currentProperty;
3562   ULONG       objectFetched       = 0;
3563   ULONG       currentSearchNode;
3564
3565   /*
3566    * Start with the node at the top of the stack.
3567    */
3568   currentSearchNode = IEnumSTATSTGImpl_PopSearchNode(This, FALSE);
3569
3570   while ( (objectFetched < celt) &&
3571           (currentSearchNode!=PROPERTY_NULL) )
3572   {
3573     /*
3574      * Remove the top node from the stack
3575      */
3576     IEnumSTATSTGImpl_PopSearchNode(This, TRUE);
3577
3578     /*
3579      * Read the property from the storage.
3580      */
3581     StorageImpl_ReadProperty(This->parentStorage,
3582       currentSearchNode,
3583       &currentProperty);
3584
3585     /*
3586      * Step to the next item in the iteration
3587      */
3588     objectFetched++;
3589
3590     /*
3591      * Push the next search node in the search stack.
3592      */
3593     IEnumSTATSTGImpl_PushSearchNode(This, currentProperty.nextProperty);
3594
3595     /*
3596      * continue the iteration.
3597      */
3598     currentSearchNode = IEnumSTATSTGImpl_PopSearchNode(This, FALSE);
3599   }
3600
3601   if (objectFetched == celt)
3602     return S_OK;
3603
3604   return S_FALSE;
3605 }
3606
3607 HRESULT WINAPI IEnumSTATSTGImpl_Reset(
3608   IEnumSTATSTG* iface)
3609 {
3610   IEnumSTATSTGImpl* const This=(IEnumSTATSTGImpl*)iface;
3611
3612   StgProperty rootProperty;
3613   BOOL      readSucessful;
3614
3615   /*
3616    * Re-initialize the search stack to an empty stack
3617    */
3618   This->stackSize = 0;
3619
3620   /*
3621    * Read the root property from the storage.
3622    */
3623   readSucessful = StorageImpl_ReadProperty(
3624                     This->parentStorage,
3625                     This->firstPropertyNode,
3626                     &rootProperty);
3627
3628   if (readSucessful)
3629   {
3630     assert(rootProperty.sizeOfNameString!=0);
3631
3632     /*
3633      * Push the search node in the search stack.
3634      */
3635     IEnumSTATSTGImpl_PushSearchNode(This, rootProperty.dirProperty);
3636   }
3637
3638   return S_OK;
3639 }
3640
3641 HRESULT WINAPI IEnumSTATSTGImpl_Clone(
3642   IEnumSTATSTG* iface,
3643   IEnumSTATSTG**    ppenum)
3644 {
3645   IEnumSTATSTGImpl* const This=(IEnumSTATSTGImpl*)iface;
3646
3647   IEnumSTATSTGImpl* newClone;
3648
3649   /*
3650    * Perform a sanity check on the parameters.
3651    */
3652   if (ppenum==0)
3653     return E_INVALIDARG;
3654
3655   newClone = IEnumSTATSTGImpl_Construct(This->parentStorage,
3656                This->firstPropertyNode);
3657
3658
3659   /*
3660    * The new clone enumeration must point to the same current node as
3661    * the ole one.
3662    */
3663   newClone->stackSize    = This->stackSize    ;
3664   newClone->stackMaxSize = This->stackMaxSize ;
3665   newClone->stackToVisit =
3666     HeapAlloc(GetProcessHeap(), 0, sizeof(ULONG) * newClone->stackMaxSize);
3667
3668   memcpy(
3669     newClone->stackToVisit,
3670     This->stackToVisit,
3671     sizeof(ULONG) * newClone->stackSize);
3672
3673   *ppenum = (IEnumSTATSTG*)newClone;
3674
3675   /*
3676    * Don't forget to nail down a reference to the clone before
3677    * returning it.
3678    */
3679   IEnumSTATSTGImpl_AddRef(*ppenum);
3680
3681   return S_OK;
3682 }
3683
3684 INT IEnumSTATSTGImpl_FindParentProperty(
3685   IEnumSTATSTGImpl *This,
3686   ULONG             childProperty,
3687   StgProperty      *currentProperty,
3688   ULONG            *thisNodeId)
3689 {
3690   ULONG currentSearchNode;
3691   ULONG foundNode;
3692
3693   /*
3694    * To avoid the special case, get another pointer to a ULONG value if
3695    * the caller didn't supply one.
3696    */
3697   if (thisNodeId==0)
3698     thisNodeId = &foundNode;
3699
3700   /*
3701    * Start with the node at the top of the stack.
3702    */
3703   currentSearchNode = IEnumSTATSTGImpl_PopSearchNode(This, FALSE);
3704
3705
3706   while (currentSearchNode!=PROPERTY_NULL)
3707   {
3708     /*
3709      * Store the current node in the returned parameters
3710      */
3711     *thisNodeId = currentSearchNode;
3712
3713     /*
3714      * Remove the top node from the stack
3715      */
3716     IEnumSTATSTGImpl_PopSearchNode(This, TRUE);
3717
3718     /*
3719      * Read the property from the storage.
3720      */
3721     StorageImpl_ReadProperty(
3722       This->parentStorage,
3723       currentSearchNode,
3724       currentProperty);
3725
3726     if (currentProperty->previousProperty == childProperty)
3727       return PROPERTY_RELATION_PREVIOUS;
3728
3729     else if (currentProperty->nextProperty == childProperty)
3730       return PROPERTY_RELATION_NEXT;
3731
3732     else if (currentProperty->dirProperty == childProperty)
3733       return PROPERTY_RELATION_DIR;
3734
3735     /*
3736      * Push the next search node in the search stack.
3737      */
3738     IEnumSTATSTGImpl_PushSearchNode(This, currentProperty->nextProperty);
3739
3740     /*
3741      * continue the iteration.
3742      */
3743     currentSearchNode = IEnumSTATSTGImpl_PopSearchNode(This, FALSE);
3744   }
3745
3746   return PROPERTY_NULL;
3747 }
3748
3749 ULONG IEnumSTATSTGImpl_FindProperty(
3750   IEnumSTATSTGImpl* This,
3751   const OLECHAR*  lpszPropName,
3752   StgProperty*      currentProperty)
3753 {
3754   ULONG currentSearchNode;
3755
3756   /*
3757    * Start with the node at the top of the stack.
3758    */
3759   currentSearchNode = IEnumSTATSTGImpl_PopSearchNode(This, FALSE);
3760
3761   while (currentSearchNode!=PROPERTY_NULL)
3762   {
3763     /*
3764      * Remove the top node from the stack
3765      */
3766     IEnumSTATSTGImpl_PopSearchNode(This, TRUE);
3767
3768     /*
3769      * Read the property from the storage.
3770      */
3771     StorageImpl_ReadProperty(This->parentStorage,
3772       currentSearchNode,
3773       currentProperty);
3774
3775     if ( propertyNameCmp(
3776           (OLECHAR*)currentProperty->name,
3777           (OLECHAR*)lpszPropName) == 0)
3778       return currentSearchNode;
3779
3780     /*
3781      * Push the next search node in the search stack.
3782      */
3783     IEnumSTATSTGImpl_PushSearchNode(This, currentProperty->nextProperty);
3784
3785     /*
3786      * continue the iteration.
3787      */
3788     currentSearchNode = IEnumSTATSTGImpl_PopSearchNode(This, FALSE);
3789   }
3790
3791   return PROPERTY_NULL;
3792 }
3793
3794 void IEnumSTATSTGImpl_PushSearchNode(
3795   IEnumSTATSTGImpl* This,
3796   ULONG             nodeToPush)
3797 {
3798   StgProperty rootProperty;
3799   BOOL      readSucessful;
3800
3801   /*
3802    * First, make sure we're not trying to push an unexisting node.
3803    */
3804   if (nodeToPush==PROPERTY_NULL)
3805     return;
3806
3807   /*
3808    * First push the node to the stack
3809    */
3810   if (This->stackSize == This->stackMaxSize)
3811   {
3812     This->stackMaxSize += ENUMSTATSGT_SIZE_INCREMENT;
3813
3814     This->stackToVisit = HeapReAlloc(
3815                            GetProcessHeap(),
3816                            0,
3817                            This->stackToVisit,
3818                            sizeof(ULONG) * This->stackMaxSize);
3819   }
3820
3821   This->stackToVisit[This->stackSize] = nodeToPush;
3822   This->stackSize++;
3823
3824   /*
3825    * Read the root property from the storage.
3826    */
3827   readSucessful = StorageImpl_ReadProperty(
3828                     This->parentStorage,
3829                     nodeToPush,
3830                     &rootProperty);
3831
3832   if (readSucessful)
3833   {
3834     assert(rootProperty.sizeOfNameString!=0);
3835
3836     /*
3837      * Push the previous search node in the search stack.
3838      */
3839     IEnumSTATSTGImpl_PushSearchNode(This, rootProperty.previousProperty);
3840   }
3841 }
3842
3843 ULONG IEnumSTATSTGImpl_PopSearchNode(
3844   IEnumSTATSTGImpl* This,
3845   BOOL            remove)
3846 {
3847   ULONG topNode;
3848
3849   if (This->stackSize == 0)
3850     return PROPERTY_NULL;
3851
3852   topNode = This->stackToVisit[This->stackSize-1];
3853
3854   if (remove)
3855     This->stackSize--;
3856
3857   return topNode;
3858 }
3859
3860 /******************************************************************************
3861 ** StorageUtl implementation
3862 */
3863
3864 void StorageUtl_ReadWord(void* buffer, ULONG offset, WORD* value)
3865 {
3866   memcpy(value, (BYTE*)buffer+offset, sizeof(WORD));
3867 }
3868
3869 void StorageUtl_WriteWord(void* buffer, ULONG offset, WORD value)
3870 {
3871   memcpy((BYTE*)buffer+offset, &value, sizeof(WORD));
3872 }
3873
3874 void StorageUtl_ReadDWord(void* buffer, ULONG offset, DWORD* value)
3875 {
3876   memcpy(value, (BYTE*)buffer+offset, sizeof(DWORD));
3877 }
3878
3879 void StorageUtl_WriteDWord(void* buffer, ULONG offset, DWORD value)
3880 {
3881   memcpy((BYTE*)buffer+offset, &value, sizeof(DWORD));
3882 }
3883
3884 void StorageUtl_ReadGUID(void* buffer, ULONG offset, GUID* value)
3885 {
3886   StorageUtl_ReadDWord(buffer, offset,   &(value->Data1));
3887   StorageUtl_ReadWord(buffer,  offset+4, &(value->Data2));
3888   StorageUtl_ReadWord(buffer,  offset+6, &(value->Data3));
3889
3890   memcpy(value->Data4, (BYTE*)buffer+offset+8, sizeof(value->Data4));
3891 }
3892
3893 void StorageUtl_WriteGUID(void* buffer, ULONG offset, GUID* value)
3894 {
3895   StorageUtl_WriteDWord(buffer, offset,   value->Data1);
3896   StorageUtl_WriteWord(buffer,  offset+4, value->Data2);
3897   StorageUtl_WriteWord(buffer,  offset+6, value->Data3);
3898
3899   memcpy((BYTE*)buffer+offset+8, value->Data4, sizeof(value->Data4));
3900 }
3901
3902 void StorageUtl_CopyPropertyToSTATSTG(
3903   STATSTG*     destination,
3904   StgProperty* source,
3905   int          statFlags)
3906 {
3907   /*
3908    * The copy of the string occurs only when the flag is not set
3909    */
3910   if ((statFlags & STATFLAG_NONAME) != 0)
3911   {
3912     destination->pwcsName = 0;
3913   }
3914   else
3915   {
3916     destination->pwcsName =
3917       CoTaskMemAlloc((lstrlenW(source->name)+1)*sizeof(WCHAR));
3918
3919     lstrcpyW((LPWSTR)destination->pwcsName, source->name);
3920   }
3921
3922   switch (source->propertyType)
3923   {
3924     case PROPTYPE_STORAGE:
3925     case PROPTYPE_ROOT:
3926       destination->type = STGTY_STORAGE;
3927       break;
3928     case PROPTYPE_STREAM:
3929       destination->type = STGTY_STREAM;
3930       break;
3931     default:
3932       destination->type = STGTY_STREAM;
3933       break;
3934   }
3935
3936   destination->cbSize            = source->size;
3937 /*
3938   currentReturnStruct->mtime     = {0}; TODO
3939   currentReturnStruct->ctime     = {0};
3940   currentReturnStruct->atime     = {0};
3941 */
3942   destination->grfMode           = 0;
3943   destination->grfLocksSupported = 0;
3944   destination->clsid             = source->propertyUniqueID;
3945   destination->grfStateBits      = 0;
3946   destination->reserved          = 0;
3947 }
3948
3949 /******************************************************************************
3950 ** BlockChainStream implementation
3951 */
3952
3953 BlockChainStream* BlockChainStream_Construct(
3954   StorageImpl* parentStorage,
3955   ULONG*         headOfStreamPlaceHolder,
3956   ULONG          propertyIndex)
3957 {
3958   BlockChainStream* newStream;
3959   ULONG blockIndex;
3960
3961   newStream = HeapAlloc(GetProcessHeap(), 0, sizeof(BlockChainStream));
3962
3963   newStream->parentStorage           = parentStorage;
3964   newStream->headOfStreamPlaceHolder = headOfStreamPlaceHolder;
3965   newStream->ownerPropertyIndex      = propertyIndex;
3966   newStream->lastBlockNoInSequence   = 0xFFFFFFFF;
3967   newStream->tailIndex               = BLOCK_END_OF_CHAIN;
3968   newStream->numBlocks               = 0;
3969
3970   blockIndex = BlockChainStream_GetHeadOfChain(newStream);
3971
3972   while (blockIndex != BLOCK_END_OF_CHAIN)
3973   {
3974     newStream->numBlocks++;
3975     newStream->tailIndex = blockIndex;
3976
3977     blockIndex = StorageImpl_GetNextBlockInChain(
3978                    parentStorage,
3979                    blockIndex);
3980   }
3981
3982   return newStream;
3983 }
3984
3985 void BlockChainStream_Destroy(BlockChainStream* This)
3986 {
3987   HeapFree(GetProcessHeap(), 0, This);
3988 }
3989
3990 /******************************************************************************
3991  *      BlockChainStream_GetHeadOfChain
3992  *
3993  * Returns the head of this stream chain.
3994  * Some special chains don't have properties, their heads are kept in
3995  * This->headOfStreamPlaceHolder.
3996  *
3997  */
3998 ULONG BlockChainStream_GetHeadOfChain(BlockChainStream* This)
3999 {
4000   StgProperty chainProperty;
4001   BOOL      readSucessful;
4002
4003   if (This->headOfStreamPlaceHolder != 0)
4004     return *(This->headOfStreamPlaceHolder);
4005
4006   if (This->ownerPropertyIndex != PROPERTY_NULL)
4007   {
4008     readSucessful = StorageImpl_ReadProperty(
4009                       This->parentStorage,
4010                       This->ownerPropertyIndex,
4011                       &chainProperty);
4012
4013     if (readSucessful)
4014     {
4015       return chainProperty.startingBlock;
4016     }
4017   }
4018
4019   return BLOCK_END_OF_CHAIN;
4020 }
4021
4022 /******************************************************************************
4023  *       BlockChainStream_GetCount
4024  *
4025  * Returns the number of blocks that comprises this chain.
4026  * This is not the size of the stream as the last block may not be full!
4027  *
4028  */
4029 ULONG BlockChainStream_GetCount(BlockChainStream* This)
4030 {
4031   ULONG blockIndex;
4032   ULONG count = 0;
4033
4034   blockIndex = BlockChainStream_GetHeadOfChain(This);
4035
4036   while (blockIndex != BLOCK_END_OF_CHAIN)
4037   {
4038     count++;
4039
4040     blockIndex = StorageImpl_GetNextBlockInChain(
4041                    This->parentStorage,
4042                    blockIndex);
4043   }
4044
4045   return count;
4046 }
4047
4048 /******************************************************************************
4049  *      BlockChainStream_ReadAt
4050  *
4051  * Reads a specified number of bytes from this chain at the specified offset.
4052  * bytesRead may be NULL.
4053  * Failure will be returned if the specified number of bytes has not been read.
4054  */
4055 BOOL BlockChainStream_ReadAt(BlockChainStream* This,
4056   ULARGE_INTEGER offset,
4057   ULONG          size,
4058   void*          buffer,
4059   ULONG*         bytesRead)
4060 {
4061   ULONG blockNoInSequence = offset.LowPart / This->parentStorage->bigBlockSize;
4062   ULONG offsetInBlock     = offset.LowPart % This->parentStorage->bigBlockSize;
4063   ULONG bytesToReadInBuffer;
4064   ULONG blockIndex;
4065   BYTE* bufferWalker;
4066   BYTE* bigBlockBuffer;
4067
4068   /*
4069    * Find the first block in the stream that contains part of the buffer.
4070    */
4071   if ( (This->lastBlockNoInSequence == 0xFFFFFFFF) ||
4072        (This->lastBlockNoInSequenceIndex == BLOCK_END_OF_CHAIN) ||
4073        (blockNoInSequence < This->lastBlockNoInSequence) )
4074   {
4075     blockIndex = BlockChainStream_GetHeadOfChain(This);
4076     This->lastBlockNoInSequence = blockNoInSequence;
4077   }
4078   else
4079   {
4080     ULONG temp = blockNoInSequence;
4081
4082     blockIndex = This->lastBlockNoInSequenceIndex;
4083     blockNoInSequence -= This->lastBlockNoInSequence;
4084     This->lastBlockNoInSequence = temp;
4085   }
4086
4087   while ( (blockNoInSequence > 0) &&  (blockIndex != BLOCK_END_OF_CHAIN))
4088   {
4089     blockIndex =
4090       StorageImpl_GetNextBlockInChain(This->parentStorage, blockIndex);
4091
4092     blockNoInSequence--;
4093   }
4094
4095   This->lastBlockNoInSequenceIndex = blockIndex;
4096
4097   /*
4098    * Start reading the buffer.
4099    */
4100   *bytesRead   = 0;
4101   bufferWalker = buffer;
4102
4103   while ( (size > 0) && (blockIndex != BLOCK_END_OF_CHAIN) )
4104   {
4105     /*
4106      * Calculate how many bytes we can copy from this big block.
4107      */
4108     bytesToReadInBuffer =
4109       MIN(This->parentStorage->bigBlockSize - offsetInBlock, size);
4110
4111     /*
4112      * Copy those bytes to the buffer
4113      */
4114     bigBlockBuffer =
4115       StorageImpl_GetROBigBlock(This->parentStorage, blockIndex);
4116
4117     memcpy(bufferWalker, bigBlockBuffer + offsetInBlock, bytesToReadInBuffer);
4118
4119     StorageImpl_ReleaseBigBlock(This->parentStorage, bigBlockBuffer);
4120
4121     /*
4122      * Step to the next big block.
4123      */
4124     blockIndex    =
4125       StorageImpl_GetNextBlockInChain(This->parentStorage, blockIndex);
4126
4127     bufferWalker += bytesToReadInBuffer;
4128     size         -= bytesToReadInBuffer;
4129     *bytesRead   += bytesToReadInBuffer;
4130     offsetInBlock = 0;  /* There is no offset on the next block */
4131
4132   }
4133
4134   return (size == 0);
4135 }
4136
4137 /******************************************************************************
4138  *      BlockChainStream_WriteAt
4139  *
4140  * Writes the specified number of bytes to this chain at the specified offset.
4141  * bytesWritten may be NULL.
4142  * Will fail if not all specified number of bytes have been written.
4143  */
4144 BOOL BlockChainStream_WriteAt(BlockChainStream* This,
4145   ULARGE_INTEGER    offset,
4146   ULONG             size,
4147   const void*       buffer,
4148   ULONG*            bytesWritten)
4149 {
4150   ULONG blockNoInSequence = offset.LowPart / This->parentStorage->bigBlockSize;
4151   ULONG offsetInBlock     = offset.LowPart % This->parentStorage->bigBlockSize;
4152   ULONG bytesToWrite;
4153   ULONG blockIndex;
4154   BYTE* bufferWalker;
4155   BYTE* bigBlockBuffer;
4156
4157   /*
4158    * Find the first block in the stream that contains part of the buffer.
4159    */
4160   if ( (This->lastBlockNoInSequence == 0xFFFFFFFF) ||
4161        (This->lastBlockNoInSequenceIndex == BLOCK_END_OF_CHAIN) ||
4162        (blockNoInSequence < This->lastBlockNoInSequence) )
4163   {
4164     blockIndex = BlockChainStream_GetHeadOfChain(This);
4165     This->lastBlockNoInSequence = blockNoInSequence;
4166   }
4167   else
4168   {
4169     ULONG temp = blockNoInSequence;
4170
4171     blockIndex = This->lastBlockNoInSequenceIndex;
4172     blockNoInSequence -= This->lastBlockNoInSequence;
4173     This->lastBlockNoInSequence = temp;
4174   }
4175
4176   while ( (blockNoInSequence > 0) &&  (blockIndex != BLOCK_END_OF_CHAIN))
4177   {
4178     blockIndex =
4179       StorageImpl_GetNextBlockInChain(This->parentStorage, blockIndex);
4180
4181     blockNoInSequence--;
4182   }
4183
4184   This->lastBlockNoInSequenceIndex = blockIndex;
4185
4186   /*
4187    * Here, I'm casting away the constness on the buffer variable
4188    * This is OK since we don't intend to modify that buffer.
4189    */
4190   *bytesWritten   = 0;
4191   bufferWalker = (BYTE*)buffer;
4192
4193   while ( (size > 0) && (blockIndex != BLOCK_END_OF_CHAIN) )
4194   {
4195     /*
4196      * Calculate how many bytes we can copy from this big block.
4197      */
4198     bytesToWrite =
4199       MIN(This->parentStorage->bigBlockSize - offsetInBlock, size);
4200
4201     /*
4202      * Copy those bytes to the buffer
4203      */
4204     bigBlockBuffer = StorageImpl_GetBigBlock(This->parentStorage, blockIndex);
4205
4206     memcpy(bigBlockBuffer + offsetInBlock, bufferWalker, bytesToWrite);
4207
4208     StorageImpl_ReleaseBigBlock(This->parentStorage, bigBlockBuffer);
4209
4210     /*
4211      * Step to the next big block.
4212      */
4213     blockIndex    =
4214       StorageImpl_GetNextBlockInChain(This->parentStorage, blockIndex);
4215
4216     bufferWalker  += bytesToWrite;
4217     size          -= bytesToWrite;
4218     *bytesWritten += bytesToWrite;
4219     offsetInBlock  = 0;      /* There is no offset on the next block */
4220   }
4221
4222   return (size == 0);
4223 }
4224
4225 /******************************************************************************
4226  *      BlockChainStream_Shrink
4227  *
4228  * Shrinks this chain in the big block depot.
4229  */
4230 BOOL BlockChainStream_Shrink(BlockChainStream* This,
4231                                ULARGE_INTEGER    newSize)
4232 {
4233   ULONG blockIndex, extraBlock;
4234   ULONG numBlocks;
4235   ULONG count = 1;
4236
4237   /*
4238    * Reset the last accessed block cache.
4239    */
4240   This->lastBlockNoInSequence = 0xFFFFFFFF;
4241   This->lastBlockNoInSequenceIndex = BLOCK_END_OF_CHAIN;
4242
4243   /*
4244    * Figure out how many blocks are needed to contain the new size
4245    */
4246   numBlocks = newSize.LowPart / This->parentStorage->bigBlockSize;
4247
4248   if ((newSize.LowPart % This->parentStorage->bigBlockSize) != 0)
4249     numBlocks++;
4250
4251   blockIndex = BlockChainStream_GetHeadOfChain(This);
4252
4253   /*
4254    * Go to the new end of chain
4255    */
4256   while (count < numBlocks)
4257   {
4258     blockIndex =
4259       StorageImpl_GetNextBlockInChain(This->parentStorage, blockIndex);
4260
4261     count++;
4262   }
4263
4264   /* Get the next block before marking the new end */
4265   extraBlock =
4266     StorageImpl_GetNextBlockInChain(This->parentStorage, blockIndex);
4267
4268   /* Mark the new end of chain */
4269   StorageImpl_SetNextBlockInChain(
4270     This->parentStorage,
4271     blockIndex,
4272     BLOCK_END_OF_CHAIN);
4273
4274   This->tailIndex = blockIndex;
4275   This->numBlocks = numBlocks;
4276
4277   /*
4278    * Mark the extra blocks as free
4279    */
4280   while (extraBlock != BLOCK_END_OF_CHAIN)
4281   {
4282     blockIndex =
4283       StorageImpl_GetNextBlockInChain(This->parentStorage, extraBlock);
4284
4285     StorageImpl_FreeBigBlock(This->parentStorage, extraBlock);
4286     extraBlock = blockIndex;
4287   }
4288
4289   return TRUE;
4290 }
4291
4292 /******************************************************************************
4293  *      BlockChainStream_Enlarge
4294  *
4295  * Grows this chain in the big block depot.
4296  */
4297 BOOL BlockChainStream_Enlarge(BlockChainStream* This,
4298                                 ULARGE_INTEGER    newSize)
4299 {
4300   ULONG blockIndex, currentBlock;
4301   ULONG newNumBlocks;
4302   ULONG oldNumBlocks = 0;
4303
4304   blockIndex = BlockChainStream_GetHeadOfChain(This);
4305
4306   /*
4307    * Empty chain. Create the head.
4308    */
4309   if (blockIndex == BLOCK_END_OF_CHAIN)
4310   {
4311     blockIndex = StorageImpl_GetNextFreeBigBlock(This->parentStorage);
4312     StorageImpl_SetNextBlockInChain(This->parentStorage,
4313                                       blockIndex,
4314                                       BLOCK_END_OF_CHAIN);
4315
4316     if (This->headOfStreamPlaceHolder != 0)
4317     {
4318       *(This->headOfStreamPlaceHolder) = blockIndex;
4319     }
4320     else
4321     {
4322       StgProperty chainProp;
4323       assert(This->ownerPropertyIndex != PROPERTY_NULL);
4324
4325       StorageImpl_ReadProperty(
4326         This->parentStorage,
4327         This->ownerPropertyIndex,
4328         &chainProp);
4329
4330       chainProp.startingBlock = blockIndex;
4331
4332       StorageImpl_WriteProperty(
4333         This->parentStorage,
4334         This->ownerPropertyIndex,
4335         &chainProp);
4336     }
4337
4338     This->tailIndex = blockIndex;
4339     This->numBlocks = 1;
4340   }
4341
4342   /*
4343    * Figure out how many blocks are needed to contain this stream
4344    */
4345   newNumBlocks = newSize.LowPart / This->parentStorage->bigBlockSize;
4346
4347   if ((newSize.LowPart % This->parentStorage->bigBlockSize) != 0)
4348     newNumBlocks++;
4349
4350   /*
4351    * Go to the current end of chain
4352    */
4353   if (This->tailIndex == BLOCK_END_OF_CHAIN)
4354   {
4355     currentBlock = blockIndex;
4356
4357     while (blockIndex != BLOCK_END_OF_CHAIN)
4358     {
4359       This->numBlocks++;
4360       currentBlock = blockIndex;
4361
4362       blockIndex =
4363         StorageImpl_GetNextBlockInChain(This->parentStorage, currentBlock);
4364     }
4365
4366     This->tailIndex = currentBlock;
4367   }
4368
4369   currentBlock = This->tailIndex;
4370   oldNumBlocks = This->numBlocks;
4371
4372   /*
4373    * Add new blocks to the chain
4374    */
4375   if (oldNumBlocks < newNumBlocks)
4376   {
4377     while (oldNumBlocks < newNumBlocks)
4378     {
4379       blockIndex = StorageImpl_GetNextFreeBigBlock(This->parentStorage);
4380
4381       StorageImpl_SetNextBlockInChain(
4382         This->parentStorage,
4383         currentBlock,
4384         blockIndex);
4385
4386       StorageImpl_SetNextBlockInChain(
4387         This->parentStorage,
4388         blockIndex,
4389         BLOCK_END_OF_CHAIN);
4390
4391       currentBlock = blockIndex;
4392       oldNumBlocks++;
4393     }
4394
4395     This->tailIndex = blockIndex;
4396     This->numBlocks = newNumBlocks;
4397   }
4398
4399   return TRUE;
4400 }
4401
4402 /******************************************************************************
4403  *      BlockChainStream_SetSize
4404  *
4405  * Sets the size of this stream. The big block depot will be updated.
4406  * The file will grow if we grow the chain.
4407  *
4408  * TODO: Free the actual blocks in the file when we shrink the chain.
4409  *       Currently, the blocks are still in the file. So the file size
4410  *       doesn't shrink even if we shrink streams.
4411  */
4412 BOOL BlockChainStream_SetSize(
4413   BlockChainStream* This,
4414   ULARGE_INTEGER    newSize)
4415 {
4416   ULARGE_INTEGER size = BlockChainStream_GetSize(This);
4417
4418   if (newSize.LowPart == size.LowPart)
4419     return TRUE;
4420
4421   if (newSize.LowPart < size.LowPart)
4422   {
4423     BlockChainStream_Shrink(This, newSize);
4424   }
4425   else
4426   {
4427     ULARGE_INTEGER fileSize =
4428       BIGBLOCKFILE_GetSize(This->parentStorage->bigBlockFile);
4429
4430     ULONG diff = newSize.LowPart - size.LowPart;
4431
4432     /*
4433      * Make sure the file stays a multiple of blocksize
4434      */
4435     if ((diff % This->parentStorage->bigBlockSize) != 0)
4436       diff += (This->parentStorage->bigBlockSize -
4437                 (diff % This->parentStorage->bigBlockSize) );
4438
4439     fileSize.LowPart += diff;
4440     BIGBLOCKFILE_SetSize(This->parentStorage->bigBlockFile, fileSize);
4441
4442     BlockChainStream_Enlarge(This, newSize);
4443   }
4444
4445   return TRUE;
4446 }
4447
4448 /******************************************************************************
4449  *      BlockChainStream_GetSize
4450  *
4451  * Returns the size of this chain.
4452  * Will return the block count if this chain doesn't have a property.
4453  */
4454 ULARGE_INTEGER BlockChainStream_GetSize(BlockChainStream* This)
4455 {
4456   StgProperty chainProperty;
4457
4458   if(This->headOfStreamPlaceHolder == NULL)
4459   {
4460     /*
4461      * This chain is a data stream read the property and return
4462      * the appropriate size
4463      */
4464     StorageImpl_ReadProperty(
4465       This->parentStorage,
4466       This->ownerPropertyIndex,
4467       &chainProperty);
4468
4469     return chainProperty.size;
4470   }
4471   else
4472   {
4473     /*
4474      * this chain is a chain that does not have a property, figure out the
4475      * size by making the product number of used blocks times the
4476      * size of them
4477      */
4478     ULARGE_INTEGER result;
4479     result.HighPart = 0;
4480
4481     result.LowPart  =
4482       BlockChainStream_GetCount(This) *
4483       This->parentStorage->bigBlockSize;
4484
4485     return result;
4486   }
4487 }
4488
4489 /******************************************************************************
4490 ** SmallBlockChainStream implementation
4491 */
4492
4493 SmallBlockChainStream* SmallBlockChainStream_Construct(
4494   StorageImpl* parentStorage,
4495   ULONG          propertyIndex)
4496 {
4497   SmallBlockChainStream* newStream;
4498
4499   newStream = HeapAlloc(GetProcessHeap(), 0, sizeof(SmallBlockChainStream));
4500
4501   newStream->parentStorage      = parentStorage;
4502   newStream->ownerPropertyIndex = propertyIndex;
4503
4504   return newStream;
4505 }
4506
4507 void SmallBlockChainStream_Destroy(
4508   SmallBlockChainStream* This)
4509 {
4510   HeapFree(GetProcessHeap(), 0, This);
4511 }
4512
4513 /******************************************************************************
4514  *      SmallBlockChainStream_GetHeadOfChain
4515  *
4516  * Returns the head of this chain of small blocks.
4517  */
4518 ULONG SmallBlockChainStream_GetHeadOfChain(
4519   SmallBlockChainStream* This)
4520 {
4521   StgProperty chainProperty;
4522   BOOL      readSucessful;
4523
4524   if (This->ownerPropertyIndex)
4525   {
4526     readSucessful = StorageImpl_ReadProperty(
4527                       This->parentStorage,
4528                       This->ownerPropertyIndex,
4529                       &chainProperty);
4530
4531     if (readSucessful)
4532     {
4533       return chainProperty.startingBlock;
4534     }
4535
4536   }
4537
4538   return BLOCK_END_OF_CHAIN;
4539 }
4540
4541 /******************************************************************************
4542  *      SmallBlockChainStream_GetNextBlockInChain
4543  *
4544  * Returns the index of the next small block in this chain.
4545  *
4546  * Return Values:
4547  *    - BLOCK_END_OF_CHAIN: end of this chain
4548  *    - BLOCK_UNUSED: small block 'blockIndex' is free
4549  */
4550 ULONG SmallBlockChainStream_GetNextBlockInChain(
4551   SmallBlockChainStream* This,
4552   ULONG                  blockIndex)
4553 {
4554   ULARGE_INTEGER offsetOfBlockInDepot;
4555   DWORD  buffer;
4556   ULONG  nextBlockInChain = BLOCK_END_OF_CHAIN;
4557   ULONG  bytesRead;
4558   BOOL success;
4559
4560   offsetOfBlockInDepot.HighPart = 0;
4561   offsetOfBlockInDepot.LowPart  = blockIndex * sizeof(ULONG);
4562
4563   /*
4564    * Read those bytes in the buffer from the small block file.
4565    */
4566   success = BlockChainStream_ReadAt(
4567               This->parentStorage->smallBlockDepotChain,
4568               offsetOfBlockInDepot,
4569               sizeof(DWORD),
4570               &buffer,
4571               &bytesRead);
4572
4573   if (success)
4574   {
4575     StorageUtl_ReadDWord(&buffer, 0, &nextBlockInChain);
4576   }
4577
4578   return nextBlockInChain;
4579 }
4580
4581 /******************************************************************************
4582  *       SmallBlockChainStream_SetNextBlockInChain
4583  *
4584  * Writes the index of the next block of the specified block in the small
4585  * block depot.
4586  * To set the end of chain use BLOCK_END_OF_CHAIN as nextBlock.
4587  * To flag a block as free use BLOCK_UNUSED as nextBlock.
4588  */
4589 void SmallBlockChainStream_SetNextBlockInChain(
4590   SmallBlockChainStream* This,
4591   ULONG                  blockIndex,
4592   ULONG                  nextBlock)
4593 {
4594   ULARGE_INTEGER offsetOfBlockInDepot;
4595   DWORD  buffer;
4596   ULONG  bytesWritten;
4597
4598   offsetOfBlockInDepot.HighPart = 0;
4599   offsetOfBlockInDepot.LowPart  = blockIndex * sizeof(ULONG);
4600
4601   StorageUtl_WriteDWord(&buffer, 0, nextBlock);
4602
4603   /*
4604    * Read those bytes in the buffer from the small block file.
4605    */
4606   BlockChainStream_WriteAt(
4607     This->parentStorage->smallBlockDepotChain,
4608     offsetOfBlockInDepot,
4609     sizeof(DWORD),
4610     &buffer,
4611     &bytesWritten);
4612 }
4613
4614 /******************************************************************************
4615  *      SmallBlockChainStream_FreeBlock
4616  *
4617  * Flag small block 'blockIndex' as free in the small block depot.
4618  */
4619 void SmallBlockChainStream_FreeBlock(
4620   SmallBlockChainStream* This,
4621   ULONG                  blockIndex)
4622 {
4623   SmallBlockChainStream_SetNextBlockInChain(This, blockIndex, BLOCK_UNUSED);
4624 }
4625
4626 /******************************************************************************
4627  *      SmallBlockChainStream_GetNextFreeBlock
4628  *
4629  * Returns the index of a free small block. The small block depot will be
4630  * enlarged if necessary. The small block chain will also be enlarged if
4631  * necessary.
4632  */
4633 ULONG SmallBlockChainStream_GetNextFreeBlock(
4634   SmallBlockChainStream* This)
4635 {
4636   ULARGE_INTEGER offsetOfBlockInDepot;
4637   DWORD buffer;
4638   ULONG bytesRead;
4639   ULONG blockIndex = 0;
4640   ULONG nextBlockIndex = BLOCK_END_OF_CHAIN;
4641   BOOL success = TRUE;
4642   ULONG smallBlocksPerBigBlock;
4643
4644   offsetOfBlockInDepot.HighPart = 0;
4645
4646   /*
4647    * Scan the small block depot for a free block
4648    */
4649   while (nextBlockIndex != BLOCK_UNUSED)
4650   {
4651     offsetOfBlockInDepot.LowPart = blockIndex * sizeof(ULONG);
4652
4653     success = BlockChainStream_ReadAt(
4654                 This->parentStorage->smallBlockDepotChain,
4655                 offsetOfBlockInDepot,
4656                 sizeof(DWORD),
4657                 &buffer,
4658                 &bytesRead);
4659
4660     /*
4661      * If we run out of space for the small block depot, enlarge it
4662      */
4663     if (success)
4664     {
4665       StorageUtl_ReadDWord(&buffer, 0, &nextBlockIndex);
4666
4667       if (nextBlockIndex != BLOCK_UNUSED)
4668         blockIndex++;
4669     }
4670     else
4671     {
4672       ULONG count =
4673         BlockChainStream_GetCount(This->parentStorage->smallBlockDepotChain);
4674
4675       ULONG sbdIndex = This->parentStorage->smallBlockDepotStart;
4676       ULONG nextBlock, newsbdIndex;
4677       BYTE* smallBlockDepot;
4678
4679       nextBlock = sbdIndex;
4680       while (nextBlock != BLOCK_END_OF_CHAIN)
4681       {
4682         sbdIndex = nextBlock;
4683         nextBlock =
4684           StorageImpl_GetNextBlockInChain(This->parentStorage, sbdIndex);
4685       }
4686
4687       newsbdIndex = StorageImpl_GetNextFreeBigBlock(This->parentStorage);
4688       if (sbdIndex != BLOCK_END_OF_CHAIN)
4689         StorageImpl_SetNextBlockInChain(
4690           This->parentStorage,
4691           sbdIndex,
4692           newsbdIndex);
4693
4694       StorageImpl_SetNextBlockInChain(
4695         This->parentStorage,
4696         newsbdIndex,
4697         BLOCK_END_OF_CHAIN);
4698
4699       /*
4700        * Initialize all the small blocks to free
4701        */
4702       smallBlockDepot =
4703         StorageImpl_GetBigBlock(This->parentStorage, newsbdIndex);
4704
4705       memset(smallBlockDepot, BLOCK_UNUSED, This->parentStorage->bigBlockSize);
4706       StorageImpl_ReleaseBigBlock(This->parentStorage, smallBlockDepot);
4707
4708       if (count == 0)
4709       {
4710         /*
4711          * We have just created the small block depot.
4712          */
4713         StgProperty rootProp;
4714         ULONG sbStartIndex;
4715
4716         /*
4717          * Save it in the header
4718          */
4719         This->parentStorage->smallBlockDepotStart = newsbdIndex;
4720         StorageImpl_SaveFileHeader(This->parentStorage);
4721
4722         /*
4723          * And allocate the first big block that will contain small blocks
4724          */
4725         sbStartIndex =
4726           StorageImpl_GetNextFreeBigBlock(This->parentStorage);
4727
4728         StorageImpl_SetNextBlockInChain(
4729           This->parentStorage,
4730           sbStartIndex,
4731           BLOCK_END_OF_CHAIN);
4732
4733         StorageImpl_ReadProperty(
4734           This->parentStorage,
4735           This->parentStorage->rootPropertySetIndex,
4736           &rootProp);
4737
4738         rootProp.startingBlock = sbStartIndex;
4739         rootProp.size.HighPart = 0;
4740         rootProp.size.LowPart  = This->parentStorage->bigBlockSize;
4741
4742         StorageImpl_WriteProperty(
4743           This->parentStorage,
4744           This->parentStorage->rootPropertySetIndex,
4745           &rootProp);
4746       }
4747     }
4748   }
4749
4750   smallBlocksPerBigBlock =
4751     This->parentStorage->bigBlockSize / This->parentStorage->smallBlockSize;
4752
4753   /*
4754    * Verify if we have to allocate big blocks to contain small blocks
4755    */
4756   if (blockIndex % smallBlocksPerBigBlock == 0)
4757   {
4758     StgProperty rootProp;
4759     ULONG blocksRequired = (blockIndex / smallBlocksPerBigBlock) + 1;
4760
4761     StorageImpl_ReadProperty(
4762       This->parentStorage,
4763       This->parentStorage->rootPropertySetIndex,
4764       &rootProp);
4765
4766     if (rootProp.size.LowPart <
4767        (blocksRequired * This->parentStorage->bigBlockSize))
4768     {
4769       rootProp.size.LowPart += This->parentStorage->bigBlockSize;
4770
4771       BlockChainStream_SetSize(
4772         This->parentStorage->smallBlockRootChain,
4773         rootProp.size);
4774
4775       StorageImpl_WriteProperty(
4776         This->parentStorage,
4777         This->parentStorage->rootPropertySetIndex,
4778         &rootProp);
4779     }
4780   }
4781
4782   return blockIndex;
4783 }
4784
4785 /******************************************************************************
4786  *      SmallBlockChainStream_ReadAt
4787  *
4788  * Reads a specified number of bytes from this chain at the specified offset.
4789  * bytesRead may be NULL.
4790  * Failure will be returned if the specified number of bytes has not been read.
4791  */
4792 BOOL SmallBlockChainStream_ReadAt(
4793   SmallBlockChainStream* This,
4794   ULARGE_INTEGER         offset,
4795   ULONG                  size,
4796   void*                  buffer,
4797   ULONG*                 bytesRead)
4798 {
4799   ULARGE_INTEGER offsetInBigBlockFile;
4800   ULONG blockNoInSequence =
4801     offset.LowPart / This->parentStorage->smallBlockSize;
4802
4803   ULONG offsetInBlock = offset.LowPart % This->parentStorage->smallBlockSize;
4804   ULONG bytesToReadInBuffer;
4805   ULONG blockIndex;
4806   ULONG bytesReadFromBigBlockFile;
4807   BYTE* bufferWalker;
4808
4809   /*
4810    * This should never happen on a small block file.
4811    */
4812   assert(offset.HighPart==0);
4813
4814   /*
4815    * Find the first block in the stream that contains part of the buffer.
4816    */
4817   blockIndex = SmallBlockChainStream_GetHeadOfChain(This);
4818
4819   while ( (blockNoInSequence > 0) &&  (blockIndex != BLOCK_END_OF_CHAIN))
4820   {
4821     blockIndex = SmallBlockChainStream_GetNextBlockInChain(This, blockIndex);
4822
4823     blockNoInSequence--;
4824   }
4825
4826   /*
4827    * Start reading the buffer.
4828    */
4829   *bytesRead   = 0;
4830   bufferWalker = buffer;
4831
4832   while ( (size > 0) && (blockIndex != BLOCK_END_OF_CHAIN) )
4833   {
4834     /*
4835      * Calculate how many bytes we can copy from this small block.
4836      */
4837     bytesToReadInBuffer =
4838       MIN(This->parentStorage->smallBlockSize - offsetInBlock, size);
4839
4840     /*
4841      * Calculate the offset of the small block in the small block file.
4842      */
4843     offsetInBigBlockFile.HighPart  = 0;
4844     offsetInBigBlockFile.LowPart   =
4845       blockIndex * This->parentStorage->smallBlockSize;
4846
4847     offsetInBigBlockFile.LowPart  += offsetInBlock;
4848
4849     /*
4850      * Read those bytes in the buffer from the small block file.
4851      */
4852     BlockChainStream_ReadAt(This->parentStorage->smallBlockRootChain,
4853       offsetInBigBlockFile,
4854       bytesToReadInBuffer,
4855       bufferWalker,
4856       &bytesReadFromBigBlockFile);
4857
4858     assert(bytesReadFromBigBlockFile == bytesToReadInBuffer);
4859
4860     /*
4861      * Step to the next big block.
4862      */
4863     blockIndex    = SmallBlockChainStream_GetNextBlockInChain(This, blockIndex);
4864     bufferWalker += bytesToReadInBuffer;
4865     size         -= bytesToReadInBuffer;
4866     *bytesRead   += bytesToReadInBuffer;
4867     offsetInBlock = 0;  /* There is no offset on the next block */
4868   }
4869
4870   return (size == 0);
4871 }
4872
4873 /******************************************************************************
4874  *       SmallBlockChainStream_WriteAt
4875  *
4876  * Writes the specified number of bytes to this chain at the specified offset.
4877  * bytesWritten may be NULL.
4878  * Will fail if not all specified number of bytes have been written.
4879  */
4880 BOOL SmallBlockChainStream_WriteAt(
4881   SmallBlockChainStream* This,
4882   ULARGE_INTEGER offset,
4883   ULONG          size,
4884   const void*    buffer,
4885   ULONG*         bytesWritten)
4886 {
4887   ULARGE_INTEGER offsetInBigBlockFile;
4888   ULONG blockNoInSequence =
4889     offset.LowPart / This->parentStorage->smallBlockSize;
4890
4891   ULONG offsetInBlock = offset.LowPart % This->parentStorage->smallBlockSize;
4892   ULONG bytesToWriteInBuffer;
4893   ULONG blockIndex;
4894   ULONG bytesWrittenFromBigBlockFile;
4895   BYTE* bufferWalker;
4896
4897   /*
4898    * This should never happen on a small block file.
4899    */
4900   assert(offset.HighPart==0);
4901
4902   /*
4903    * Find the first block in the stream that contains part of the buffer.
4904    */
4905   blockIndex = SmallBlockChainStream_GetHeadOfChain(This);
4906
4907   while ( (blockNoInSequence > 0) &&  (blockIndex != BLOCK_END_OF_CHAIN))
4908   {
4909     blockIndex = SmallBlockChainStream_GetNextBlockInChain(This, blockIndex);
4910
4911     blockNoInSequence--;
4912   }
4913
4914   /*
4915    * Start writing the buffer.
4916    *
4917    * Here, I'm casting away the constness on the buffer variable
4918    * This is OK since we don't intend to modify that buffer.
4919    */
4920   *bytesWritten   = 0;
4921   bufferWalker = (BYTE*)buffer;
4922   while ( (size > 0) && (blockIndex != BLOCK_END_OF_CHAIN) )
4923   {
4924     /*
4925      * Calculate how many bytes we can copy to this small block.
4926      */
4927     bytesToWriteInBuffer =
4928       MIN(This->parentStorage->smallBlockSize - offsetInBlock, size);
4929
4930     /*
4931      * Calculate the offset of the small block in the small block file.
4932      */
4933     offsetInBigBlockFile.HighPart  = 0;
4934     offsetInBigBlockFile.LowPart   =
4935       blockIndex * This->parentStorage->smallBlockSize;
4936
4937     offsetInBigBlockFile.LowPart  += offsetInBlock;
4938
4939     /*
4940      * Write those bytes in the buffer to the small block file.
4941      */
4942     BlockChainStream_WriteAt(This->parentStorage->smallBlockRootChain,
4943       offsetInBigBlockFile,
4944       bytesToWriteInBuffer,
4945       bufferWalker,
4946       &bytesWrittenFromBigBlockFile);
4947
4948     assert(bytesWrittenFromBigBlockFile == bytesToWriteInBuffer);
4949
4950     /*
4951      * Step to the next big block.
4952      */
4953     blockIndex    = SmallBlockChainStream_GetNextBlockInChain(This, blockIndex);
4954     bufferWalker  += bytesToWriteInBuffer;
4955     size          -= bytesToWriteInBuffer;
4956     *bytesWritten += bytesToWriteInBuffer;
4957     offsetInBlock  = 0;     /* There is no offset on the next block */
4958   }
4959
4960   return (size == 0);
4961 }
4962
4963 /******************************************************************************
4964  *       SmallBlockChainStream_Shrink
4965  *
4966  * Shrinks this chain in the small block depot.
4967  */
4968 BOOL SmallBlockChainStream_Shrink(
4969   SmallBlockChainStream* This,
4970   ULARGE_INTEGER newSize)
4971 {
4972   ULONG blockIndex, extraBlock;
4973   ULONG numBlocks;
4974   ULONG count = 0;
4975
4976   numBlocks = newSize.LowPart / This->parentStorage->smallBlockSize;
4977
4978   if ((newSize.LowPart % This->parentStorage->smallBlockSize) != 0)
4979     numBlocks++;
4980
4981   blockIndex = SmallBlockChainStream_GetHeadOfChain(This);
4982
4983   /*
4984    * Go to the new end of chain
4985    */
4986   while (count < numBlocks)
4987   {
4988     blockIndex = SmallBlockChainStream_GetNextBlockInChain(This, blockIndex);
4989     count++;
4990   }
4991
4992   /*
4993    * If the count is 0, we have a special case, the head of the chain was
4994    * just freed.
4995    */
4996   if (count == 0)
4997   {
4998     StgProperty chainProp;
4999
5000     StorageImpl_ReadProperty(This->parentStorage,
5001                              This->ownerPropertyIndex,
5002                              &chainProp);
5003
5004     chainProp.startingBlock = BLOCK_END_OF_CHAIN;
5005
5006     StorageImpl_WriteProperty(This->parentStorage,
5007                               This->ownerPropertyIndex,
5008                               &chainProp);
5009
5010     /*
5011      * We start freeing the chain at the head block.
5012      */
5013     extraBlock = blockIndex;
5014   }
5015   else
5016   {
5017     /* Get the next block before marking the new end */
5018     extraBlock = SmallBlockChainStream_GetNextBlockInChain(This, blockIndex);
5019
5020     /* Mark the new end of chain */
5021     SmallBlockChainStream_SetNextBlockInChain(
5022       This,
5023       blockIndex,
5024       BLOCK_END_OF_CHAIN);
5025   }
5026
5027   /*
5028    * Mark the extra blocks as free
5029    */
5030   while (extraBlock != BLOCK_END_OF_CHAIN)
5031   {
5032     blockIndex = SmallBlockChainStream_GetNextBlockInChain(This, extraBlock);
5033     SmallBlockChainStream_FreeBlock(This, extraBlock);
5034     extraBlock = blockIndex;
5035   }
5036
5037   return TRUE;
5038 }
5039
5040 /******************************************************************************
5041  *      SmallBlockChainStream_Enlarge
5042  *
5043  * Grows this chain in the small block depot.
5044  */
5045 BOOL SmallBlockChainStream_Enlarge(
5046   SmallBlockChainStream* This,
5047   ULARGE_INTEGER newSize)
5048 {
5049   ULONG blockIndex, currentBlock;
5050   ULONG newNumBlocks;
5051   ULONG oldNumBlocks = 0;
5052
5053   blockIndex = SmallBlockChainStream_GetHeadOfChain(This);
5054
5055   /*
5056    * Empty chain
5057    */
5058   if (blockIndex == BLOCK_END_OF_CHAIN)
5059   {
5060
5061     StgProperty chainProp;
5062
5063     StorageImpl_ReadProperty(This->parentStorage, This->ownerPropertyIndex,
5064                                &chainProp);
5065
5066     chainProp.startingBlock = SmallBlockChainStream_GetNextFreeBlock(This);
5067
5068     StorageImpl_WriteProperty(This->parentStorage, This->ownerPropertyIndex,
5069                                 &chainProp);
5070
5071     blockIndex = chainProp.startingBlock;
5072     SmallBlockChainStream_SetNextBlockInChain(
5073       This,
5074       blockIndex,
5075       BLOCK_END_OF_CHAIN);
5076   }
5077
5078   currentBlock = blockIndex;
5079
5080   /*
5081    * Figure out how many blocks are needed to contain this stream
5082    */
5083   newNumBlocks = newSize.LowPart / This->parentStorage->smallBlockSize;
5084
5085   if ((newSize.LowPart % This->parentStorage->smallBlockSize) != 0)
5086     newNumBlocks++;
5087
5088   /*
5089    * Go to the current end of chain
5090    */
5091   while (blockIndex != BLOCK_END_OF_CHAIN)
5092   {
5093     oldNumBlocks++;
5094     currentBlock = blockIndex;
5095     blockIndex = SmallBlockChainStream_GetNextBlockInChain(This, currentBlock);
5096   }
5097
5098   /*
5099    * Add new blocks to the chain
5100    */
5101   while (oldNumBlocks < newNumBlocks)
5102   {
5103     blockIndex = SmallBlockChainStream_GetNextFreeBlock(This);
5104     SmallBlockChainStream_SetNextBlockInChain(This, currentBlock, blockIndex);
5105
5106     SmallBlockChainStream_SetNextBlockInChain(
5107       This,
5108       blockIndex,
5109       BLOCK_END_OF_CHAIN);
5110
5111     currentBlock = blockIndex;
5112     oldNumBlocks++;
5113   }
5114
5115   return TRUE;
5116 }
5117
5118 /******************************************************************************
5119  *      SmallBlockChainStream_GetCount
5120  *
5121  * Returns the number of blocks that comprises this chain.
5122  * This is not the size of this chain as the last block may not be full!
5123  */
5124 ULONG SmallBlockChainStream_GetCount(SmallBlockChainStream* This)
5125 {
5126   ULONG blockIndex;
5127   ULONG count = 0;
5128
5129   blockIndex = SmallBlockChainStream_GetHeadOfChain(This);
5130
5131   while (blockIndex != BLOCK_END_OF_CHAIN)
5132   {
5133     count++;
5134
5135     blockIndex = SmallBlockChainStream_GetNextBlockInChain(This, blockIndex);
5136   }
5137
5138   return count;
5139 }
5140
5141 /******************************************************************************
5142  *      SmallBlockChainStream_SetSize
5143  *
5144  * Sets the size of this stream.
5145  * The file will grow if we grow the chain.
5146  *
5147  * TODO: Free the actual blocks in the file when we shrink the chain.
5148  *       Currently, the blocks are still in the file. So the file size
5149  *       doesn't shrink even if we shrink streams.
5150  */
5151 BOOL SmallBlockChainStream_SetSize(
5152                 SmallBlockChainStream* This,
5153                 ULARGE_INTEGER    newSize)
5154 {
5155   ULARGE_INTEGER size = SmallBlockChainStream_GetSize(This);
5156
5157   if (newSize.LowPart == size.LowPart)
5158     return TRUE;
5159
5160   if (newSize.LowPart < size.LowPart)
5161   {
5162     SmallBlockChainStream_Shrink(This, newSize);
5163   }
5164   else
5165   {
5166     SmallBlockChainStream_Enlarge(This, newSize);
5167   }
5168
5169   return TRUE;
5170 }
5171
5172 /******************************************************************************
5173  *      SmallBlockChainStream_GetSize
5174  *
5175  * Returns the size of this chain.
5176  */
5177 ULARGE_INTEGER SmallBlockChainStream_GetSize(SmallBlockChainStream* This)
5178 {
5179   StgProperty chainProperty;
5180
5181   StorageImpl_ReadProperty(
5182     This->parentStorage,
5183     This->ownerPropertyIndex,
5184     &chainProperty);
5185
5186   return chainProperty.size;
5187 }
5188
5189 /******************************************************************************
5190  *    StgCreateDocfile32  [OLE32.144]
5191  */
5192 HRESULT WINAPI StgCreateDocfile(
5193   LPCOLESTR pwcsName,
5194   DWORD       grfMode,
5195   DWORD       reserved,
5196   IStorage  **ppstgOpen)
5197 {
5198   StorageImpl* newStorage = 0;
5199   HANDLE       hFile      = INVALID_HANDLE_VALUE;
5200   HRESULT        hr         = S_OK;
5201   DWORD          shareMode;
5202   DWORD          accessMode;
5203   DWORD          creationMode;
5204   DWORD          fileAttributes;
5205   WCHAR          tempFileName[MAX_PATH];
5206
5207   TRACE("(%s, %lx, %ld, %p)\n",
5208         debugstr_w(pwcsName), grfMode,
5209         reserved, ppstgOpen);
5210
5211   /*
5212    * Validate the parameters
5213    */
5214   if (ppstgOpen == 0)
5215     return STG_E_INVALIDPOINTER;
5216
5217   /*
5218    * Validate the STGM flags
5219    */
5220   if ( FAILED( validateSTGM(grfMode) ))
5221     return STG_E_INVALIDFLAG;
5222
5223   /*
5224    * Generate a unique name.
5225    */
5226   if (pwcsName == 0)
5227   {
5228     WCHAR tempPath[MAX_PATH];
5229     WCHAR prefix[] = { 'S', 'T', 'O', 0 };
5230
5231     memset(tempPath, 0, sizeof(tempPath));
5232     memset(tempFileName, 0, sizeof(tempFileName));
5233
5234     if ((GetTempPathW(MAX_PATH, tempPath)) == 0 )
5235       tempPath[0] = '.';
5236
5237     if (GetTempFileNameW(tempPath, prefix, 0, tempFileName) != 0)
5238       pwcsName = tempFileName;
5239     else
5240       return STG_E_INSUFFICIENTMEMORY;
5241   }
5242
5243   /*
5244    * Interpret the STGM value grfMode
5245    */
5246   shareMode    = GetShareModeFromSTGM(grfMode);
5247   accessMode   = GetAccessModeFromSTGM(grfMode);
5248   creationMode = GetCreationModeFromSTGM(grfMode);
5249
5250   if (grfMode & STGM_DELETEONRELEASE)
5251     fileAttributes = FILE_FLAG_RANDOM_ACCESS | FILE_FLAG_DELETE_ON_CLOSE;
5252   else
5253     fileAttributes = FILE_ATTRIBUTE_NORMAL | FILE_FLAG_RANDOM_ACCESS;
5254
5255   if (grfMode & STGM_TRANSACTED)
5256     FIXME("Transacted mode not implemented.\n");
5257
5258   /*
5259    * Initialize the "out" parameter.
5260    */
5261   *ppstgOpen = 0;
5262
5263   hFile = CreateFileW(pwcsName,
5264                         accessMode,
5265                         shareMode,
5266             NULL,
5267                         creationMode,
5268                         fileAttributes,
5269             0);
5270
5271   if (hFile == INVALID_HANDLE_VALUE)
5272   {
5273     return E_FAIL;
5274   }
5275
5276   /*
5277    * Allocate and initialize the new IStorage32object.
5278    */
5279   newStorage = HeapAlloc(GetProcessHeap(), 0, sizeof(StorageImpl));
5280
5281   if (newStorage == 0)
5282     return STG_E_INSUFFICIENTMEMORY;
5283
5284   hr = StorageImpl_Construct(
5285          newStorage,
5286          hFile,
5287          NULL,
5288          grfMode,
5289          TRUE);
5290
5291   if (FAILED(hr))
5292   {
5293     HeapFree(GetProcessHeap(), 0, newStorage);
5294     return hr;
5295   }
5296
5297   /*
5298    * Get an "out" pointer for the caller.
5299    */
5300   hr = StorageBaseImpl_QueryInterface(
5301          (IStorage*)newStorage,
5302          (REFIID)&IID_IStorage,
5303          (void**)ppstgOpen);
5304
5305   return hr;
5306 }
5307
5308 /******************************************************************************
5309  *              StgOpenStorage32        [OLE32.148]
5310  */
5311 HRESULT WINAPI StgOpenStorage(
5312   const OLECHAR *pwcsName,
5313   IStorage      *pstgPriority,
5314   DWORD           grfMode,
5315   SNB           snbExclude,
5316   DWORD           reserved,
5317   IStorage      **ppstgOpen)
5318 {
5319   StorageImpl* newStorage = 0;
5320   HRESULT        hr = S_OK;
5321   HANDLE       hFile = 0;
5322   DWORD          shareMode;
5323   DWORD          accessMode;
5324
5325   TRACE("(%s, %p, %lx, %p, %ld, %p)\n",
5326         debugstr_w(pwcsName), pstgPriority, grfMode,
5327         snbExclude, reserved, ppstgOpen);
5328
5329   /*
5330    * Perform a sanity check
5331    */
5332   if (( pwcsName == 0) || (ppstgOpen == 0) )
5333     return STG_E_INVALIDPOINTER;
5334
5335   /*
5336    * Validate the STGM flags
5337    */
5338   if ( FAILED( validateSTGM(grfMode) ))
5339     return STG_E_INVALIDFLAG;
5340
5341   /*
5342    * Interpret the STGM value grfMode
5343    */
5344   shareMode    = GetShareModeFromSTGM(grfMode);
5345   accessMode   = GetAccessModeFromSTGM(grfMode);
5346
5347   /*
5348    * Initialize the "out" parameter.
5349    */
5350   *ppstgOpen = 0;
5351
5352   hFile = CreateFileW( pwcsName,
5353                         accessMode,
5354                         shareMode,
5355             NULL,
5356             OPEN_EXISTING,
5357             FILE_ATTRIBUTE_NORMAL | FILE_FLAG_RANDOM_ACCESS,
5358             0);
5359
5360
5361   if (hFile==INVALID_HANDLE_VALUE)
5362   {
5363     return E_FAIL;
5364   }
5365
5366   /*
5367    * Allocate and initialize the new IStorage32object.
5368    */
5369   newStorage = HeapAlloc(GetProcessHeap(), 0, sizeof(StorageImpl));
5370
5371   if (newStorage == 0)
5372     return STG_E_INSUFFICIENTMEMORY;
5373
5374   hr = StorageImpl_Construct(
5375          newStorage,
5376          hFile,
5377          NULL,
5378          grfMode,
5379          TRUE);
5380
5381   if (FAILED(hr))
5382   {
5383     HeapFree(GetProcessHeap(), 0, newStorage);
5384     return hr;
5385   }
5386
5387   /*
5388    * Get an "out" pointer for the caller.
5389    */
5390   hr = StorageBaseImpl_QueryInterface(
5391          (IStorage*)newStorage,
5392          (REFIID)&IID_IStorage,
5393          (void**)ppstgOpen);
5394
5395   return hr;
5396 }
5397
5398 /******************************************************************************
5399  *    StgCreateDocfileOnILockBytes    [OLE32.145]
5400  */
5401 HRESULT WINAPI StgCreateDocfileOnILockBytes(
5402       ILockBytes *plkbyt,
5403       DWORD grfMode,
5404       DWORD reserved,
5405       IStorage** ppstgOpen)
5406 {
5407   StorageImpl*   newStorage = 0;
5408   HRESULT        hr         = S_OK;
5409
5410   /*
5411    * Validate the parameters
5412    */
5413   if ((ppstgOpen == 0) || (plkbyt == 0))
5414     return STG_E_INVALIDPOINTER;
5415
5416   /*
5417    * Allocate and initialize the new IStorage object.
5418    */
5419   newStorage = HeapAlloc(GetProcessHeap(), 0, sizeof(StorageImpl));
5420
5421   if (newStorage == 0)
5422     return STG_E_INSUFFICIENTMEMORY;
5423
5424   hr = StorageImpl_Construct(
5425          newStorage,
5426          0,
5427          plkbyt,
5428          grfMode,
5429          FALSE);
5430
5431   if (FAILED(hr))
5432   {
5433     HeapFree(GetProcessHeap(), 0, newStorage);
5434     return hr;
5435   }
5436
5437   /*
5438    * Get an "out" pointer for the caller.
5439    */
5440   hr = StorageBaseImpl_QueryInterface(
5441          (IStorage*)newStorage,
5442          (REFIID)&IID_IStorage,
5443          (void**)ppstgOpen);
5444
5445   return hr;
5446 }
5447
5448 /******************************************************************************
5449  *    StgOpenStorageOnILockBytes    [OLE32.149]
5450  */
5451 HRESULT WINAPI StgOpenStorageOnILockBytes(
5452       ILockBytes *plkbyt,
5453       IStorage *pstgPriority,
5454       DWORD grfMode,
5455       SNB snbExclude,
5456       DWORD reserved,
5457       IStorage **ppstgOpen)
5458 {
5459   StorageImpl* newStorage = 0;
5460   HRESULT        hr = S_OK;
5461
5462   /*
5463    * Perform a sanity check
5464    */
5465   if ((plkbyt == 0) || (ppstgOpen == 0))
5466     return STG_E_INVALIDPOINTER;
5467
5468   /*
5469    * Validate the STGM flags
5470    */
5471   if ( FAILED( validateSTGM(grfMode) ))
5472     return STG_E_INVALIDFLAG;
5473
5474   /*
5475    * Initialize the "out" parameter.
5476    */
5477   *ppstgOpen = 0;
5478
5479   /*
5480    * Allocate and initialize the new IStorage object.
5481    */
5482   newStorage = HeapAlloc(GetProcessHeap(), 0, sizeof(StorageImpl));
5483
5484   if (newStorage == 0)
5485     return STG_E_INSUFFICIENTMEMORY;
5486
5487   hr = StorageImpl_Construct(
5488          newStorage,
5489          0,
5490          plkbyt,
5491          grfMode,
5492          FALSE);
5493
5494   if (FAILED(hr))
5495   {
5496     HeapFree(GetProcessHeap(), 0, newStorage);
5497     return hr;
5498   }
5499
5500   /*
5501    * Get an "out" pointer for the caller.
5502    */
5503   hr = StorageBaseImpl_QueryInterface(
5504          (IStorage*)newStorage,
5505          (REFIID)&IID_IStorage,
5506          (void**)ppstgOpen);
5507
5508   return hr;
5509 }
5510
5511 /******************************************************************************
5512  *              StgIsStorageILockBytes        [OLE32.147]
5513  *
5514  * Determines if the ILockBytes contains a storage object.
5515  */
5516 HRESULT WINAPI StgIsStorageILockBytes(ILockBytes *plkbyt)
5517 {
5518   BYTE sig[8];
5519   ULARGE_INTEGER offset;
5520
5521   offset.HighPart = 0;
5522   offset.LowPart  = 0;
5523
5524   ILockBytes_ReadAt(plkbyt, offset, sig, sizeof(sig), NULL);
5525
5526   if (memcmp(sig, STORAGE_magic, sizeof(STORAGE_magic)) == 0)
5527     return S_OK;
5528
5529   return S_FALSE;
5530 }
5531
5532 /******************************************************************************
5533  *              WriteClassStg32        [OLE32.158]
5534  *
5535  * This method will store the specified CLSID in the specified storage object
5536  */
5537 HRESULT WINAPI WriteClassStg(IStorage* pStg, REFCLSID rclsid)
5538 {
5539   HRESULT hRes;
5540
5541   assert(pStg != 0);
5542
5543   hRes = IStorage_SetClass(pStg, rclsid);
5544
5545   return hRes;
5546 }
5547
5548 /*******************************************************************************************
5549  *    ReadClassStg
5550  *
5551  * This method reads the CLSID previously written to a storage object with the WriteClassStg.
5552  */
5553 HRESULT WINAPI ReadClassStg(IStorage *pstg,CLSID *pclsid){
5554
5555     STATSTG pstatstg;
5556     HRESULT hRes;
5557
5558     TRACE("()\n");
5559
5560     if(pclsid==NULL)
5561         return E_POINTER;
5562    /*
5563     * read a STATSTG structure (contains the clsid) from the storage
5564     */
5565     hRes=IStorage_Stat(pstg,&pstatstg,STATFLAG_DEFAULT);
5566
5567     if(SUCCEEDED(hRes))
5568         *pclsid=pstatstg.clsid;
5569
5570     return hRes;
5571 }
5572
5573 /*************************************************************************************
5574  *    OleLoadFromStream
5575  *
5576  * This function loads an object from stream
5577  */
5578 HRESULT  WINAPI OleLoadFromStream(IStream *pStm,REFIID iidInterface,void** ppvObj)
5579 {
5580     CLSID clsid;
5581     HRESULT res;
5582
5583     FIXME("(),stub!\n");
5584
5585     res=ReadClassStm(pStm,&clsid);
5586
5587     if (SUCCEEDED(res)){
5588
5589         res=CoCreateInstance(&clsid,NULL,CLSCTX_INPROC_SERVER,iidInterface,ppvObj);
5590
5591         if (SUCCEEDED(res))
5592
5593             res=IPersistStream_Load((IPersistStream*)ppvObj,pStm);
5594     }
5595
5596     return res;
5597 }
5598
5599 /************************************************************************************************
5600  *    OleSaveToStream
5601  *
5602  * This function saves an object with the IPersistStream interface on it to the specified stream
5603  */
5604 HRESULT  WINAPI OleSaveToStream(IPersistStream *pPStm,IStream *pStm)
5605 {
5606
5607     CLSID clsid;
5608     HRESULT res;
5609
5610     TRACE("(%p,%p)\n",pPStm,pStm);
5611
5612     res=IPersistStream_GetClassID(pPStm,&clsid);
5613
5614     if (SUCCEEDED(res)){
5615
5616         res=WriteClassStm(pStm,&clsid);
5617
5618         if (SUCCEEDED(res))
5619
5620             res=IPersistStream_Save(pPStm,pStm,FALSE);
5621     }
5622
5623     return res;
5624 }
5625
5626 /****************************************************************************
5627  * This method validate a STGM parameter that can contain the values below
5628  *
5629  * STGM_DIRECT               0x00000000
5630  * STGM_TRANSACTED           0x00010000
5631  * STGM_SIMPLE               0x08000000
5632  *
5633  * STGM_READ                 0x00000000
5634  * STGM_WRITE                0x00000001
5635  * STGM_READWRITE            0x00000002
5636  *
5637  * STGM_SHARE_DENY_NONE      0x00000040
5638  * STGM_SHARE_DENY_READ      0x00000030
5639  * STGM_SHARE_DENY_WRITE     0x00000020
5640  * STGM_SHARE_EXCLUSIVE      0x00000010
5641  *
5642  * STGM_PRIORITY             0x00040000
5643  * STGM_DELETEONRELEASE      0x04000000
5644  *
5645  * STGM_CREATE               0x00001000
5646  * STGM_CONVERT              0x00020000
5647  * STGM_FAILIFTHERE          0x00000000
5648  *
5649  * STGM_NOSCRATCH            0x00100000
5650  * STGM_NOSNAPSHOT           0x00200000
5651  */
5652 static HRESULT validateSTGM(DWORD stgm)
5653 {
5654   BOOL bSTGM_TRANSACTED       = ((stgm & STGM_TRANSACTED) == STGM_TRANSACTED);
5655   BOOL bSTGM_SIMPLE           = ((stgm & STGM_SIMPLE) == STGM_SIMPLE);
5656   BOOL bSTGM_DIRECT           = ! (bSTGM_TRANSACTED || bSTGM_SIMPLE);
5657
5658   BOOL bSTGM_WRITE            = ((stgm & STGM_WRITE) == STGM_WRITE);
5659   BOOL bSTGM_READWRITE        = ((stgm & STGM_READWRITE) == STGM_READWRITE);
5660   BOOL bSTGM_READ             = ! (bSTGM_WRITE || bSTGM_READWRITE);
5661
5662   BOOL bSTGM_SHARE_DENY_NONE  =
5663                      ((stgm & STGM_SHARE_DENY_NONE)  == STGM_SHARE_DENY_NONE);
5664
5665   BOOL bSTGM_SHARE_DENY_READ  =
5666                      ((stgm & STGM_SHARE_DENY_READ)  == STGM_SHARE_DENY_READ);
5667
5668   BOOL bSTGM_SHARE_DENY_WRITE =
5669                      ((stgm & STGM_SHARE_DENY_WRITE) == STGM_SHARE_DENY_WRITE);
5670
5671   BOOL bSTGM_SHARE_EXCLUSIVE  =
5672                      ((stgm & STGM_SHARE_EXCLUSIVE)  == STGM_SHARE_EXCLUSIVE);
5673
5674   BOOL bSTGM_CREATE           = ((stgm & STGM_CREATE) == STGM_CREATE);
5675   BOOL bSTGM_CONVERT          = ((stgm & STGM_CONVERT) == STGM_CONVERT);
5676
5677   BOOL bSTGM_NOSCRATCH        = ((stgm & STGM_NOSCRATCH) == STGM_NOSCRATCH);
5678   BOOL bSTGM_NOSNAPSHOT       = ((stgm & STGM_NOSNAPSHOT) == STGM_NOSNAPSHOT);
5679
5680   /*
5681    * STGM_DIRECT | STGM_TRANSACTED | STGM_SIMPLE
5682    */
5683   if ( ! bSTGM_DIRECT )
5684     if( bSTGM_TRANSACTED && bSTGM_SIMPLE )
5685       return E_FAIL;
5686
5687   /*
5688    * STGM_WRITE |  STGM_READWRITE | STGM_READ
5689    */
5690   if ( ! bSTGM_READ )
5691     if( bSTGM_WRITE && bSTGM_READWRITE )
5692       return E_FAIL;
5693
5694   /*
5695    * STGM_SHARE_DENY_NONE | others
5696    * (I assume here that DENY_READ implies DENY_WRITE)
5697    */
5698   if ( bSTGM_SHARE_DENY_NONE )
5699     if ( bSTGM_SHARE_DENY_READ ||
5700          bSTGM_SHARE_DENY_WRITE ||
5701          bSTGM_SHARE_EXCLUSIVE)
5702       return E_FAIL;
5703
5704   /*
5705    * STGM_CREATE | STGM_CONVERT
5706    * if both are false, STGM_FAILIFTHERE is set to TRUE
5707    */
5708   if ( bSTGM_CREATE && bSTGM_CONVERT )
5709     return E_FAIL;
5710
5711   /*
5712    * STGM_NOSCRATCH requires STGM_TRANSACTED
5713    */
5714   if ( bSTGM_NOSCRATCH && ! bSTGM_TRANSACTED )
5715     return E_FAIL;
5716
5717   /*
5718    * STGM_NOSNAPSHOT requires STGM_TRANSACTED and
5719    * not STGM_SHARE_EXCLUSIVE or STGM_SHARE_DENY_WRITE`
5720    */
5721   if (bSTGM_NOSNAPSHOT)
5722   {
5723     if ( ! ( bSTGM_TRANSACTED &&
5724            !(bSTGM_SHARE_EXCLUSIVE || bSTGM_SHARE_DENY_WRITE)) )
5725     return E_FAIL;
5726   }
5727
5728   return S_OK;
5729 }
5730
5731 /****************************************************************************
5732  *      GetShareModeFromSTGM
5733  *
5734  * This method will return a share mode flag from a STGM value.
5735  * The STGM value is assumed valid.
5736  */
5737 static DWORD GetShareModeFromSTGM(DWORD stgm)
5738 {
5739   DWORD dwShareMode = 0;
5740   BOOL bSTGM_SHARE_DENY_NONE  =
5741                      ((stgm & STGM_SHARE_DENY_NONE)  == STGM_SHARE_DENY_NONE);
5742
5743   BOOL bSTGM_SHARE_DENY_READ  =
5744                      ((stgm & STGM_SHARE_DENY_READ)  == STGM_SHARE_DENY_READ);
5745
5746   BOOL bSTGM_SHARE_DENY_WRITE =
5747                      ((stgm & STGM_SHARE_DENY_WRITE) == STGM_SHARE_DENY_WRITE);
5748
5749   BOOL bSTGM_SHARE_EXCLUSIVE  =
5750                      ((stgm & STGM_SHARE_EXCLUSIVE)  == STGM_SHARE_EXCLUSIVE);
5751
5752   if ((bSTGM_SHARE_EXCLUSIVE) || (bSTGM_SHARE_DENY_READ))
5753     dwShareMode = 0;
5754
5755   if (bSTGM_SHARE_DENY_NONE)
5756     dwShareMode = FILE_SHARE_READ | FILE_SHARE_WRITE;
5757
5758   if (bSTGM_SHARE_DENY_WRITE)
5759     dwShareMode = FILE_SHARE_READ;
5760
5761   return dwShareMode;
5762 }
5763
5764 /****************************************************************************
5765  *      GetAccessModeFromSTGM
5766  *
5767  * This method will return an access mode flag from a STGM value.
5768  * The STGM value is assumed valid.
5769  */
5770 static DWORD GetAccessModeFromSTGM(DWORD stgm)
5771 {
5772   DWORD dwDesiredAccess = GENERIC_READ;
5773   BOOL bSTGM_WRITE     = ((stgm & STGM_WRITE) == STGM_WRITE);
5774   BOOL bSTGM_READWRITE = ((stgm & STGM_READWRITE) == STGM_READWRITE);
5775   BOOL bSTGM_READ      = ! (bSTGM_WRITE || bSTGM_READWRITE);
5776
5777   if (bSTGM_READ)
5778     dwDesiredAccess = GENERIC_READ;
5779
5780   if (bSTGM_WRITE)
5781     dwDesiredAccess |= GENERIC_WRITE;
5782
5783   if (bSTGM_READWRITE)
5784     dwDesiredAccess = GENERIC_READ | GENERIC_WRITE;
5785
5786   return dwDesiredAccess;
5787 }
5788
5789 /****************************************************************************
5790  *      GetCreationModeFromSTGM
5791  *
5792  * This method will return a creation mode flag from a STGM value.
5793  * The STGM value is assumed valid.
5794  */
5795 static DWORD GetCreationModeFromSTGM(DWORD stgm)
5796 {
5797   if ( stgm & STGM_CREATE)
5798     return CREATE_ALWAYS;
5799   if (stgm & STGM_CONVERT) {
5800     FIXME("STGM_CONVERT not implemented!\n");
5801     return CREATE_NEW;
5802   }
5803   /* All other cases */
5804   if (stgm & ~ (STGM_CREATE|STGM_CONVERT))
5805         FIXME("unhandled storage mode : 0x%08lx\n",stgm & ~ (STGM_CREATE|STGM_CONVERT));
5806   return CREATE_NEW;
5807 }