sot/source/sdstor/storage.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #include <sal/config.h>
  21 #include <sal/log.hxx>
  22
  23 #include <com/sun/star/embed/XStorage.hpp>
  24 #include <com/sun/star/embed/ElementModes.hpp>
  25 #include <com/sun/star/beans/XPropertySet.hpp>
  26
  27 #include <rtl/digest.h>
  28 #include <osl/file.hxx>
  29 #include <sot/stg.hxx>
  30 #include <sot/storinfo.hxx>
  31 #include <sot/storage.hxx>
  32 #include <sot/formats.hxx>
  33 #include <sot/exchange.hxx>
  34 #include <unotools/ucbstreamhelper.hxx>
  35 #include <tools/debug.hxx>
  36 #include <tools/urlobj.hxx>
  37 #include <unotools/ucbhelper.hxx>
  38 #include <comphelper/fileformat.h>
  39 #include <com/sun/star/uno/Reference.h>
  40 #include <com/sun/star/ucb/XCommandEnvironment.hpp>
  41 #include <ucbhelper/content.hxx>
  42
  43 #include <memory>
  44
  45 using namespace ::com::sun::star;
  46
  47 static SvLockBytesRef MakeLockBytes_Impl( const OUString & rName, StreamMode nMode )
  48 {
  49     SvLockBytesRef xLB;
  50     if( !rName.isEmpty() )
  51     {
  52         SvStream * pFileStm = new SvFileStream( rName, nMode );
  53         xLB = new SvLockBytes( pFileStm, true );
  54     }
  55     else
  56     {
  57         SvStream * pCacheStm = new SvMemoryStream();
  58         xLB = new SvLockBytes( pCacheStm, true );
  59     }
  60     return xLB;
  61 }
  62
  63 SotStorageStream::SotStorageStream( const OUString & rName, StreamMode nMode )
  64     : SvStream( MakeLockBytes_Impl( rName, nMode ).get() )
  65     , pOwnStm( nullptr )
  66 {
  67     if( nMode & StreamMode::WRITE )
  68         m_isWritable = true;
  69     else
  70         m_isWritable = false;
  71 }
  72
  73 SotStorageStream::SotStorageStream( BaseStorageStream * pStm )
  74 {
  75     if( pStm )
  76     {
  77         if( StreamMode::WRITE & pStm->GetMode() )
  78             m_isWritable = true;
  79         else
  80             m_isWritable = false;
  81
  82         pOwnStm = pStm;
  83         SetError( pStm->GetError() );
  84         pStm->ResetError();
  85     }
  86     else
  87     {
  88         pOwnStm = nullptr;
  89         m_isWritable = true;
  90         SetError( SVSTREAM_INVALID_PARAMETER );
  91     }
  92 }
  93
  94 SotStorageStream::~SotStorageStream()
  95 {
  96     Flush(); //SetBufferSize(0);
  97     delete pOwnStm;
  98 }
  99
 100 void SotStorageStream::ResetError()
 101 {
 102     SvStream::ResetError();
 103     if( pOwnStm )
 104          pOwnStm->ResetError();
 105 }
 106
 107 std::size_t SotStorageStream::GetData(void* pData, std::size_t const nSize)
 108 {
 109     std::size_t nRet = 0;
 110
 111     if( pOwnStm )
 112     {
 113         nRet = pOwnStm->Read( pData, nSize );
 114         SetError( pOwnStm->GetError() );
 115     }
 116     else
 117         nRet = SvStream::GetData( pData, nSize );
 118
 119     return nRet;
 120 }
 121
 122 std::size_t SotStorageStream::PutData(const void* pData, std::size_t const nSize)
 123 {
 124     std::size_t nRet = 0;
 125
 126     if( pOwnStm )
 127     {
 128         nRet = pOwnStm->Write( pData, nSize );
 129         SetError( pOwnStm->GetError() );
 130     }
 131     else
 132         nRet = SvStream::PutData( pData, nSize );
 133     return nRet;
 134 }
 135
 136 sal_uInt64 SotStorageStream::SeekPos(sal_uInt64 nPos)
 137 {
 138     sal_uLong nRet = 0;
 139
 140     if( pOwnStm )
 141     {
 142         nRet = pOwnStm->Seek( nPos );
 143         SetError( pOwnStm->GetError() );
 144     }
 145     else
 146         nRet = SvStream::SeekPos( nPos );
 147
 148     return nRet;
 149 }
 150
 151 void SotStorageStream::FlushData()
 152 {
 153     if( pOwnStm )
 154     {
 155         pOwnStm->Flush();
 156         SetError( pOwnStm->GetError() );
 157     }
 158     else
 159         SvStream::FlushData();
 160 }
 161
 162 void SotStorageStream::SetSize(sal_uInt64 const nNewSize)
 163 {
 164     sal_uInt64 const nPos = Tell();
 165     if( pOwnStm )
 166     {
 167         pOwnStm->SetSize( nNewSize );
 168         SetError( pOwnStm->GetError() );
 169     }
 170     else
 171         SvStream::SetSize( nNewSize );
 172
 173     if( nNewSize < nPos )
 174         // jump to the end
 175         Seek( nNewSize );
 176 }
 177
 178 sal_uInt32 SotStorageStream::GetSize() const
 179 {
 180     sal_uInt64 nSize = const_cast<SotStorageStream*>(this)->TellEnd();
 181     return nSize;
 182 }
 183
 184 sal_uInt64 SotStorageStream::TellEnd()
 185 {
 186     // Need to flush the buffer so we materialise the stream and return the correct answer
 187     // otherwise we return a 0 value from StgEntry::GetSize
 188     FlushBuffer(true);
 189
 190     if (pOwnStm)
 191         return pOwnStm->GetSize();
 192
 193     return SvStream::TellEnd();
 194 }
 195
 196 void SotStorageStream::CopyTo( SotStorageStream * pDestStm )
 197 {
 198     Flush(); // write all data
 199     pDestStm->ClearBuffer();
 200     if( !pOwnStm || !pDestStm->pOwnStm )
 201     {
 202         // If Ole2 or not only own StorageStreams
 203         sal_uInt64 nPos = Tell();    // save position
 204         Seek( 0 );
 205         pDestStm->SetSize( 0 ); // empty target stream
 206
 207         std::unique_ptr<sal_uInt8[]> pMem(new sal_uInt8[ 8192 ]);
 208         sal_uLong  nRead;
 209         while (0 != (nRead = ReadBytes(pMem.get(), 8192)))
 210         {
 211             if (nRead != pDestStm->WriteBytes(pMem.get(), nRead))
 212             {
 213                 SetError( SVSTREAM_GENERALERROR );
 214                 break;
 215             }
 216         }
 217         pMem.reset();
 218         // set position
 219         pDestStm->Seek( nPos );
 220         Seek( nPos );
 221     }
 222     else
 223     {
 224         pOwnStm->CopyTo( pDestStm->pOwnStm );
 225         SetError( pOwnStm->GetError() );
 226     }
 227 }
 228
 229 bool SotStorageStream::Commit()
 230 {
 231     if( pOwnStm )
 232     {
 233         pOwnStm->Flush();
 234         if( pOwnStm->GetError() == ERRCODE_NONE )
 235             pOwnStm->Commit();
 236         SetError( pOwnStm->GetError() );
 237     }
 238     return GetError() == ERRCODE_NONE;
 239 }
 240
 241 bool SotStorageStream::SetProperty( const OUString& rName, const css::uno::Any& rValue )
 242 {
 243     UCBStorageStream* pStg =  dynamic_cast<UCBStorageStream*>( pOwnStm );
 244     if ( pStg )
 245     {
 246         return pStg->SetProperty( rName, rValue );
 247     }
 248     else
 249     {
 250         OSL_FAIL("Not implemented!");
 251         return false;
 252     }
 253 }
 254
 255 /**
 256  * SotStorage::SotStorage()
 257  *
 258  * A I.. object must be passed to SvObject, because otherwise itself will
 259  * create and define an IUnknown, so that all other I... objects would be
 260  * destroyed with delete (Owner() == true).
 261  * But IStorage objects are only used and not implemented by ourselves,
 262  * therefore we pretend the IStorage object was passed from the outside
 263  * and it will be freed with Release().
 264  * The CreateStorage methods are needed to create an IStorage object before the
 265  * call of SvObject (Own, !Own automatic).
 266  * If CreateStorage has created an object, then the RefCounter was already
 267  * incremented.
 268  * The transfer is done in pStorageCTor and the variable is NULL, if it didn't
 269  * work.
 270  */
 271 #define INIT_SotStorage()                     \
 272     : m_pOwnStg( nullptr )                       \
 273     , m_pStorStm( nullptr )                      \
 274     , m_nError( ERRCODE_NONE )                 \
 275     , m_bIsRoot( false )                      \
 276     , m_bDelStm( false )                      \
 277     , m_nVersion( SOFFICE_FILEFORMAT_CURRENT )
 278
 279 #define ERASEMASK  ( StreamMode::TRUNC | StreamMode::WRITE | StreamMode::SHARE_DENYALL )
 280
 281 SotStorage::SotStorage( const OUString & rName, StreamMode nMode )
 282     INIT_SotStorage()
 283 {
 284     m_aName = rName; // save name
 285     CreateStorage( true, nMode );
 286     if ( IsOLEStorage() )
 287         m_nVersion = SOFFICE_FILEFORMAT_50;
 288 }
 289
 290 void SotStorage::CreateStorage( bool bForceUCBStorage, StreamMode nMode )
 291 {
 292     DBG_ASSERT( !m_pStorStm && !m_pOwnStg, "Use only in ctor!" );
 293     if( !m_aName.isEmpty() )
 294     {
 295         // named storage
 296         if( ( nMode & ERASEMASK ) == ERASEMASK )
 297             ::utl::UCBContentHelper::Kill( m_aName );
 298
 299         INetURLObject aObj( m_aName );
 300         if ( aObj.GetProtocol() == INetProtocol::NotValid )
 301         {
 302             OUString aURL;
 303             osl::FileBase::getFileURLFromSystemPath( m_aName, aURL );
 304             aObj.SetURL( aURL );
 305             m_aName = aObj.GetMainURL( INetURLObject::DecodeMechanism::NONE );
 306         }
 307
 308         // check the stream
 309         m_pStorStm = ::utl::UcbStreamHelper::CreateStream( m_aName, nMode ).release();
 310         if ( m_pStorStm && m_pStorStm->GetError() )
 311             DELETEZ( m_pStorStm );
 312
 313         if ( m_pStorStm )
 314         {
 315             // try as UCBStorage, next try as OLEStorage
 316             bool bIsUCBStorage = UCBStorage::IsStorageFile( m_pStorStm );
 317             if ( !bIsUCBStorage && bForceUCBStorage )
 318                 // if UCBStorage has priority, it should not be used only if it is really an OLEStorage
 319                 bIsUCBStorage = !Storage::IsStorageFile( m_pStorStm );
 320
 321             if ( bIsUCBStorage )
 322             {
 323                 if ( !(UCBStorage::GetLinkedFile( *m_pStorStm ).isEmpty()) )
 324                 {
 325                     // detect special unpacked storages
 326                     m_pOwnStg = new UCBStorage( *m_pStorStm, true );
 327                     m_bDelStm = true;
 328                 }
 329                 else
 330                 {
 331                     // UCBStorage always works directly on the UCB content, so discard the stream first
 332                     DELETEZ( m_pStorStm );
 333                     m_pOwnStg = new UCBStorage( m_aName, nMode, true, true/*bIsRoot*/ );
 334                 }
 335             }
 336             else
 337             {
 338                 // OLEStorage can be opened with a stream
 339                 m_pOwnStg = new Storage( *m_pStorStm, true );
 340                 m_bDelStm = true;
 341             }
 342         }
 343         else if ( bForceUCBStorage )
 344         {
 345             m_pOwnStg = new UCBStorage( m_aName, nMode, true, true/*bIsRoot*/ );
 346             SetError( ERRCODE_IO_NOTSUPPORTED );
 347         }
 348         else
 349         {
 350             m_pOwnStg = new Storage( m_aName, nMode, true );
 351             SetError( ERRCODE_IO_NOTSUPPORTED );
 352         }
 353     }
 354     else
 355     {
 356         // temporary storage
 357         if ( bForceUCBStorage )
 358             m_pOwnStg = new UCBStorage( m_aName, nMode, true, true/*bIsRoot*/ );
 359         else
 360             m_pOwnStg = new Storage( m_aName, nMode, true );
 361         m_aName = m_pOwnStg->GetName();
 362     }
 363
 364     SetError( m_pOwnStg->GetError() );
 365
 366     SignAsRoot( m_pOwnStg->IsRoot() );
 367 }
 368
 369 SotStorage::SotStorage( bool bUCBStorage, const OUString & rName, StreamMode nMode )
 370     INIT_SotStorage()
 371 {
 372     m_aName = rName;
 373     CreateStorage( bUCBStorage, nMode );
 374     if ( IsOLEStorage() )
 375         m_nVersion = SOFFICE_FILEFORMAT_50;
 376 }
 377
 378 SotStorage::SotStorage( BaseStorage * pStor )
 379     INIT_SotStorage()
 380 {
 381     if ( pStor )
 382     {
 383         m_aName = pStor->GetName(); // save name
 384         SignAsRoot( pStor->IsRoot() );
 385         SetError( pStor->GetError() );
 386     }
 387
 388     m_pOwnStg = pStor;
 389     const ErrCode nErr = m_pOwnStg ? m_pOwnStg->GetError() : SVSTREAM_CANNOT_MAKE;
 390     SetError( nErr );
 391     if ( IsOLEStorage() )
 392         m_nVersion = SOFFICE_FILEFORMAT_50;
 393 }
 394
 395 SotStorage::SotStorage( bool bUCBStorage, SvStream & rStm )
 396     INIT_SotStorage()
 397 {
 398     SetError( rStm.GetError() );
 399
 400     // try as UCBStorage, next try as OLEStorage
 401     if ( UCBStorage::IsStorageFile( &rStm ) || bUCBStorage )
 402         m_pOwnStg = new UCBStorage( rStm, false );
 403     else
 404         m_pOwnStg = new Storage( rStm, false );
 405
 406     SetError( m_pOwnStg->GetError() );
 407
 408     if ( IsOLEStorage() )
 409         m_nVersion = SOFFICE_FILEFORMAT_50;
 410
 411     SignAsRoot( m_pOwnStg->IsRoot() );
 412 }
 413
 414 SotStorage::SotStorage( SvStream & rStm )
 415     INIT_SotStorage()
 416 {
 417     SetError( rStm.GetError() );
 418
 419     // try as UCBStorage, next try as OLEStorage
 420     if ( UCBStorage::IsStorageFile( &rStm ) )
 421         m_pOwnStg = new UCBStorage( rStm, false );
 422     else
 423         m_pOwnStg = new Storage( rStm, false );
 424
 425     SetError( m_pOwnStg->GetError() );
 426
 427     if ( IsOLEStorage() )
 428         m_nVersion = SOFFICE_FILEFORMAT_50;
 429
 430     SignAsRoot( m_pOwnStg->IsRoot() );
 431 }
 432
 433 SotStorage::SotStorage( SvStream * pStm, bool bDelete )
 434     INIT_SotStorage()
 435 {
 436     SetError( pStm->GetError() );
 437
 438     // try as UCBStorage, next try as OLEStorage
 439     if ( UCBStorage::IsStorageFile( pStm ) )
 440         m_pOwnStg = new UCBStorage( *pStm, false );
 441     else
 442         m_pOwnStg = new Storage( *pStm, false );
 443
 444     SetError( m_pOwnStg->GetError() );
 445
 446     m_pStorStm = pStm;
 447     m_bDelStm = bDelete;
 448     if ( IsOLEStorage() )
 449         m_nVersion = SOFFICE_FILEFORMAT_50;
 450
 451     SignAsRoot( m_pOwnStg->IsRoot() );
 452 }
 453
 454 SotStorage::~SotStorage()
 455 {
 456     delete m_pOwnStg;
 457     if( m_bDelStm )
 458         delete m_pStorStm;
 459 }
 460
 461 std::unique_ptr<SvMemoryStream> SotStorage::CreateMemoryStream()
 462 {
 463     std::unique_ptr<SvMemoryStream> pStm(new SvMemoryStream( 0x8000, 0x8000 ));
 464     tools::SvRef<SotStorage> aStg = new SotStorage( *pStm );
 465     if( CopyTo( aStg.get() ) )
 466     {
 467         aStg->Commit();
 468     }
 469     else
 470     {
 471         aStg.clear(); // release storage beforehand
 472         pStm.reset();
 473     }
 474     return pStm;
 475 }
 476
 477 bool SotStorage::IsStorageFile( const OUString & rFileName )
 478 {
 479     OUString aName( rFileName );
 480     INetURLObject aObj( aName );
 481     if ( aObj.GetProtocol() == INetProtocol::NotValid )
 482     {
 483         OUString aURL;
 484         osl::FileBase::getFileURLFromSystemPath( aName, aURL );
 485         aObj.SetURL( aURL );
 486         aName = aObj.GetMainURL( INetURLObject::DecodeMechanism::NONE );
 487     }
 488
 489     std::unique_ptr<SvStream> pStm(::utl::UcbStreamHelper::CreateStream( aName, StreamMode::STD_READ ));
 490     bool bRet = SotStorage::IsStorageFile( pStm.get() );
 491     return bRet;
 492 }
 493
 494 bool SotStorage::IsStorageFile( SvStream* pStream )
 495 {
 496     /** code for new storages must come first! **/
 497     if ( pStream )
 498     {
 499         sal_uInt64 nPos = pStream->Tell();
 500         bool bRet = UCBStorage::IsStorageFile( pStream );
 501         if ( !bRet )
 502             bRet = Storage::IsStorageFile( pStream );
 503         pStream->Seek( nPos );
 504         return bRet;
 505     }
 506     else
 507         return false;
 508 }
 509
 510 const OUString & SotStorage::GetName() const
 511 {
 512     if( m_aName.isEmpty() && m_pOwnStg )
 513         const_cast<SotStorage *>(this)->m_aName = m_pOwnStg->GetName();
 514     return m_aName;
 515 }
 516
 517 void SotStorage::SetClass( const SvGlobalName & rName,
 518                            SotClipboardFormatId nOriginalClipFormat,
 519                            const OUString & rUserTypeName )
 520 {
 521     if( m_pOwnStg )
 522         m_pOwnStg->SetClass( rName, nOriginalClipFormat, rUserTypeName );
 523     else
 524         SetError( SVSTREAM_GENERALERROR );
 525 }
 526
 527 SvGlobalName SotStorage::GetClassName()
 528 {
 529     SvGlobalName aGN;
 530     if( m_pOwnStg )
 531         aGN = m_pOwnStg->GetClassName();
 532     else
 533         SetError( SVSTREAM_GENERALERROR );
 534     return aGN;
 535 }
 536
 537 SotClipboardFormatId SotStorage::GetFormat()
 538 {
 539     SotClipboardFormatId nFormat = SotClipboardFormatId::NONE;
 540     if( m_pOwnStg )
 541         nFormat = m_pOwnStg->GetFormat();
 542     else
 543         SetError( SVSTREAM_GENERALERROR );
 544     return nFormat;
 545 }
 546
 547 OUString SotStorage::GetUserName()
 548 {
 549     OUString aName;
 550     if( m_pOwnStg )
 551         aName = m_pOwnStg->GetUserName();
 552     else
 553         SetError( SVSTREAM_GENERALERROR );
 554     return aName;
 555 }
 556
 557 void SotStorage::FillInfoList( SvStorageInfoList * pFillList ) const
 558 {
 559     if( m_pOwnStg )
 560         m_pOwnStg->FillInfoList( pFillList );
 561 }
 562
 563 bool SotStorage::CopyTo( SotStorage * pDestStg )
 564 {
 565     if( m_pOwnStg && pDestStg->m_pOwnStg )
 566     {
 567         m_pOwnStg->CopyTo( pDestStg->m_pOwnStg );
 568         SetError( m_pOwnStg->GetError() );
 569         pDestStg->m_aKey = m_aKey;
 570         pDestStg->m_nVersion = m_nVersion;
 571     }
 572     else
 573         SetError( SVSTREAM_GENERALERROR );
 574
 575     return ERRCODE_NONE == GetError();
 576 }
 577
 578 bool SotStorage::Commit()
 579 {
 580     if( m_pOwnStg )
 581     {
 582         if( !m_pOwnStg->Commit() )
 583             SetError( m_pOwnStg->GetError() );
 584     }
 585     else
 586         SetError( SVSTREAM_GENERALERROR );
 587
 588     return ERRCODE_NONE == GetError();
 589 }
 590
 591 SotStorageStream * SotStorage::OpenSotStream( const OUString & rEleName,
 592                                               StreamMode nMode )
 593 {
 594     SotStorageStream * pStm = nullptr;
 595     if( m_pOwnStg )
 596     {
 597         // enable full Ole patches,
 598         // regardless what is coming, only exclusively allowed
 599         nMode |= StreamMode::SHARE_DENYALL;
 600         ErrCode nE = m_pOwnStg->GetError();
 601         BaseStorageStream * p = m_pOwnStg->OpenStream( rEleName, nMode );
 602         pStm = new SotStorageStream( p );
 603
 604         if( !nE )
 605             m_pOwnStg->ResetError(); // don't set error
 606         if( nMode & StreamMode::TRUNC )
 607             pStm->SetSize( 0 );
 608     }
 609     else
 610         SetError( SVSTREAM_GENERALERROR );
 611
 612     return pStm;
 613 }
 614
 615 SotStorage * SotStorage::OpenSotStorage( const OUString & rEleName,
 616                                          StreamMode nMode,
 617                                          bool transacted )
 618 {
 619     if( m_pOwnStg )
 620     {
 621         nMode |= StreamMode::SHARE_DENYALL;
 622         ErrCode nE = m_pOwnStg->GetError();
 623         BaseStorage * p = m_pOwnStg->OpenStorage(rEleName, nMode, !transacted);
 624         if( p )
 625         {
 626             SotStorage * pStor = new SotStorage( p );
 627             if( !nE )
 628                 m_pOwnStg->ResetError(); // don't set error
 629
 630             return pStor;
 631         }
 632     }
 633
 634     SetError( SVSTREAM_GENERALERROR );
 635
 636     return nullptr;
 637 }
 638
 639 bool SotStorage::IsStorage( const OUString & rEleName ) const
 640 {
 641     // a little bit faster
 642     if( m_pOwnStg )
 643         return m_pOwnStg->IsStorage( rEleName );
 644
 645     return false;
 646 }
 647
 648 bool SotStorage::IsStream( const OUString & rEleName ) const
 649 {
 650     // a little bit faster
 651     if( m_pOwnStg )
 652         return m_pOwnStg->IsStream( rEleName );
 653
 654     return false;
 655 }
 656
 657 bool SotStorage::IsContained( const OUString & rEleName ) const
 658 {
 659     // a little bit faster
 660     if( m_pOwnStg )
 661         return m_pOwnStg->IsContained( rEleName );
 662
 663     return false;
 664 }
 665
 666 bool SotStorage::Remove( const OUString & rEleName )
 667 {
 668     if( m_pOwnStg )
 669     {
 670         m_pOwnStg->Remove( rEleName );
 671         SetError( m_pOwnStg->GetError() );
 672     }
 673     else
 674         SetError( SVSTREAM_GENERALERROR );
 675
 676     return ERRCODE_NONE == GetError();
 677 }
 678
 679 bool SotStorage::CopyTo( const OUString & rEleName,
 680                          SotStorage * pNewSt, const OUString & rNewName )
 681 {
 682     if( m_pOwnStg )
 683     {
 684         m_pOwnStg->CopyTo( rEleName, pNewSt->m_pOwnStg, rNewName );
 685         SetError( m_pOwnStg->GetError() );
 686         SetError( pNewSt->GetError() );
 687     }
 688     else
 689         SetError( SVSTREAM_GENERALERROR );
 690
 691     return ERRCODE_NONE == GetError();
 692 }
 693
 694 bool SotStorage::Validate()
 695 {
 696     DBG_ASSERT( m_bIsRoot, "Validate only if root storage" );
 697     if( m_pOwnStg )
 698         return m_pOwnStg->ValidateFAT();
 699     else
 700         return true;
 701 }
 702
 703 bool SotStorage::IsOLEStorage() const
 704 {
 705     UCBStorage* pStg =  dynamic_cast<UCBStorage*>( m_pOwnStg );
 706     return !pStg;
 707 }
 708
 709 bool SotStorage::IsOLEStorage( const OUString & rFileName )
 710 {
 711     return Storage::IsStorageFile( rFileName );
 712 }
 713
 714 bool SotStorage::IsOLEStorage( SvStream* pStream )
 715 {
 716     return Storage::IsStorageFile( pStream );
 717 }
 718
 719 SotStorage* SotStorage::OpenOLEStorage( const css::uno::Reference < css::embed::XStorage >& xStorage,
 720                                         const OUString& rEleName, StreamMode nMode )
 721 {
 722     sal_Int32 nEleMode = embed::ElementModes::SEEKABLEREAD;
 723     if ( nMode & StreamMode::WRITE )
 724         nEleMode |= embed::ElementModes::WRITE;
 725     if ( nMode & StreamMode::TRUNC )
 726         nEleMode |= embed::ElementModes::TRUNCATE;
 727     if ( nMode & StreamMode::NOCREATE )
 728         nEleMode |= embed::ElementModes::NOCREATE;
 729
 730     std::unique_ptr<SvStream> pStream;
 731     try
 732     {
 733         uno::Reference < io::XStream > xStream = xStorage->openStreamElement( rEleName, nEleMode );
 734
 735         // TODO/LATER: should it be done this way?
 736         if ( nMode & StreamMode::WRITE )
 737         {
 738             uno::Reference < beans::XPropertySet > xStreamProps( xStream, uno::UNO_QUERY_THROW );
 739             xStreamProps->setPropertyValue( "MediaType",
 740                                             uno::makeAny( OUString(  "application/vnd.sun.star.oleobject"  ) ) );
 741         }
 742
 743         pStream = utl::UcbStreamHelper::CreateStream( xStream );
 744     }
 745     catch ( uno::Exception& )
 746     {
 747         //TODO/LATER: ErrorHandling
 748         pStream.reset( new SvMemoryStream );
 749         pStream->SetError( ERRCODE_IO_GENERAL );
 750     }
 751
 752     return new SotStorage( pStream.release(), true );
 753 }
 754
 755 SotClipboardFormatId SotStorage::GetFormatID( const css::uno::Reference < css::embed::XStorage >& xStorage )
 756 {
 757     uno::Reference< beans::XPropertySet > xProps( xStorage, uno::UNO_QUERY );
 758     if ( !xProps.is() )
 759         return SotClipboardFormatId::NONE;
 760
 761     OUString aMediaType;
 762     try
 763     {
 764         xProps->getPropertyValue("MediaType") >>= aMediaType;
 765     }
 766     catch (uno::Exception const& e)
 767     {
 768         SAL_INFO("sot", "SotStorage::GetFormatID: exception: " << e);
 769     }
 770
 771     if ( !aMediaType.isEmpty() )
 772     {
 773         css::datatransfer::DataFlavor aDataFlavor;
 774         aDataFlavor.MimeType = aMediaType;
 775         return SotExchange::GetFormat( aDataFlavor );
 776     }
 777
 778     return SotClipboardFormatId::NONE;
 779 }
 780
 781 sal_Int32 SotStorage::GetVersion( const css::uno::Reference < css::embed::XStorage >& xStorage )
 782 {
 783     SotClipboardFormatId nSotFormatID = SotStorage::GetFormatID( xStorage );
 784     switch( nSotFormatID )
 785     {
 786     case SotClipboardFormatId::STARWRITER_8:
 787     case SotClipboardFormatId::STARWRITER_8_TEMPLATE:
 788     case SotClipboardFormatId::STARWRITERWEB_8:
 789     case SotClipboardFormatId::STARWRITERGLOB_8:
 790     case SotClipboardFormatId::STARWRITERGLOB_8_TEMPLATE:
 791     case SotClipboardFormatId::STARDRAW_8:
 792     case SotClipboardFormatId::STARDRAW_8_TEMPLATE:
 793     case SotClipboardFormatId::STARIMPRESS_8:
 794     case SotClipboardFormatId::STARIMPRESS_8_TEMPLATE:
 795     case SotClipboardFormatId::STARCALC_8:
 796     case SotClipboardFormatId::STARCALC_8_TEMPLATE:
 797     case SotClipboardFormatId::STARCHART_8:
 798     case SotClipboardFormatId::STARCHART_8_TEMPLATE:
 799     case SotClipboardFormatId::STARMATH_8:
 800     case SotClipboardFormatId::STARMATH_8_TEMPLATE:
 801         return SOFFICE_FILEFORMAT_8;
 802     case SotClipboardFormatId::STARWRITER_60:
 803     case SotClipboardFormatId::STARWRITERWEB_60:
 804     case SotClipboardFormatId::STARWRITERGLOB_60:
 805     case SotClipboardFormatId::STARDRAW_60:
 806     case SotClipboardFormatId::STARIMPRESS_60:
 807     case SotClipboardFormatId::STARCALC_60:
 808     case SotClipboardFormatId::STARCHART_60:
 809     case SotClipboardFormatId::STARMATH_60:
 810         return SOFFICE_FILEFORMAT_60;
 811     default: break;
 812     }
 813
 814     return 0;
 815 }
 816
 817 namespace
 818 {
 819     void traverse(const tools::SvRef<SotStorage>& rStorage, std::vector<unsigned char>& rBuf)
 820     {
 821         SvStorageInfoList infos;
 822
 823         rStorage->FillInfoList(&infos);
 824
 825         for (const auto& info: infos)
 826         {
 827             if (info.IsStream())
 828             {
 829                 // try to open and read all content
 830                 tools::SvRef<SotStorageStream> xStream(rStorage->OpenSotStream(info.GetName(), StreamMode::STD_READ));
 831                 const size_t nSize = xStream->GetSize();
 832                 const size_t nRead = xStream->ReadBytes(rBuf.data(), nSize);
 833                 SAL_INFO("sot", "Read " << nRead << "bytes");
 834             }
 835             else if (info.IsStorage())
 836             {
 837                 tools::SvRef<SotStorage> xStorage(rStorage->OpenSotStorage(info.GetName(), StreamMode::STD_READ));
 838
 839                 // continue with children
 840                 traverse(xStorage, rBuf);
 841             }
 842         }
 843     }
 844 }
 845
 846 extern "C" SAL_DLLPUBLIC_EXPORT bool TestImportOLE2(SvStream &rStream)
 847 {
 848     try
 849     {
 850         size_t nSize = rStream.remainingSize();
 851         tools::SvRef<SotStorage> xRootStorage(new SotStorage(&rStream, false));
 852         std::vector<unsigned char> aTmpBuf(nSize);
 853         traverse(xRootStorage, aTmpBuf);
 854     }
 855     catch (...)
 856     {
 857         return false;
 858     }
 859     return true;
 860 }
 861
 862 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */