embeddedobj/source/msole/olevisual.cxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: olevisual.cxx,v $
  10  * $Revision: 1.22 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_embeddedobj.hxx"
  33 #include <com/sun/star/lang/DisposedException.hpp>
  34 #include <com/sun/star/embed/EmbedStates.hpp>
  35 #include <com/sun/star/embed/EmbedMapUnits.hpp>
  36 #include <com/sun/star/embed/EmbedMisc.hpp>
  37 #include <com/sun/star/embed/Aspects.hpp>
  38 #include <com/sun/star/io/XSeekable.hpp>
  39 #include <com/sun/star/embed/NoVisualAreaSizeException.hpp>
  40
  41 #include <rtl/logfile.hxx>
  42
  43 #include <oleembobj.hxx>
  44 #include <olecomponent.hxx>
  45 #include <comphelper/mimeconfighelper.hxx>
  46 #include <comphelper/seqstream.hxx>
  47
  48 using namespace ::com::sun::star;
  49 using namespace ::comphelper;
  50
  51 embed::VisualRepresentation OleEmbeddedObject::GetVisualRepresentationInNativeFormat_Impl(
  52                     const uno::Reference< io::XStream > xCachedVisRepr )
  53         throw ( uno::Exception )
  54 {
  55     embed::VisualRepresentation aVisualRepr;
  56
  57     // TODO: detect the format in the future for now use workaround
  58     uno::Reference< io::XInputStream > xInStream = xCachedVisRepr->getInputStream();
  59     uno::Reference< io::XSeekable > xSeekable( xCachedVisRepr, uno::UNO_QUERY );
  60     if ( !xInStream.is() || !xSeekable.is() )
  61         throw uno::RuntimeException();
  62
  63     uno::Sequence< sal_Int8 > aSeq( 2 );
  64     xInStream->readBytes( aSeq, 2 );
  65     xSeekable->seek( 0 );
  66     if ( aSeq.getLength() == 2 && aSeq[0] == 'B' && aSeq[1] == 'M' )
  67     {
  68         // it's a bitmap
  69         aVisualRepr.Flavor = datatransfer::DataFlavor(
  70             ::rtl::OUString::createFromAscii( "application/x-openoffice-bitmap;windows_formatname=\"Bitmap\"" ),
  71             ::rtl::OUString::createFromAscii( "Bitmap" ),
  72             ::getCppuType( (const uno::Sequence< sal_Int8 >*) NULL ) );
  73     }
  74     else
  75     {
  76         // it's a metafile
  77         aVisualRepr.Flavor = datatransfer::DataFlavor(
  78             ::rtl::OUString::createFromAscii( "application/x-openoffice-wmf;windows_formatname=\"Image WMF\"" ),
  79             ::rtl::OUString::createFromAscii( "Windows Metafile" ),
  80             ::getCppuType( (const uno::Sequence< sal_Int8 >*) NULL ) );
  81     }
  82
  83     sal_Int32 nStreamLength = (sal_Int32)xSeekable->getLength();
  84     uno::Sequence< sal_Int8 > aRepresent( nStreamLength );
  85     xInStream->readBytes( aRepresent, nStreamLength );
  86     aVisualRepr.Data <<= aRepresent;
  87
  88     return aVisualRepr;
  89 }
  90
  91 void SAL_CALL OleEmbeddedObject::setVisualAreaSize( sal_Int64 nAspect, const awt::Size& aSize )
  92         throw ( lang::IllegalArgumentException,
  93                 embed::WrongStateException,
  94                 uno::Exception,
  95                 uno::RuntimeException )
  96 {
  97     RTL_LOGFILE_CONTEXT( aLog, "embeddedobj (mv76033) OleEmbeddedObject::setVisualAreaSize" );
  98
  99     // begin wrapping related part ====================
 100     uno::Reference< embed::XEmbeddedObject > xWrappedObject = m_xWrappedObject;
 101     if ( xWrappedObject.is() )
 102     {
 103         // the object was converted to OOo embedded object, the current implementation is now only a wrapper
 104         xWrappedObject->setVisualAreaSize( nAspect, aSize );
 105         return;
 106     }
 107     // end wrapping related part ====================
 108
 109     ::osl::ResettableMutexGuard aGuard( m_aMutex );
 110     if ( m_bDisposed )
 111         throw lang::DisposedException(); // TODO
 112
 113     OSL_ENSURE( nAspect != embed::Aspects::MSOLE_ICON, "For iconified objects no graphical replacement is required!\n" );
 114     if ( nAspect == embed::Aspects::MSOLE_ICON )
 115         // no representation can be retrieved
 116         throw embed::WrongStateException( ::rtl::OUString::createFromAscii( "Illegal call!\n" ),
 117                                     uno::Reference< uno::XInterface >( static_cast< ::cppu::OWeakObject* >(this) ) );
 118
 119     if ( m_nObjectState == -1 )
 120         throw embed::WrongStateException( ::rtl::OUString::createFromAscii( "The object is not loaded!\n" ),
 121                                     uno::Reference< uno::XInterface >( static_cast< ::cppu::OWeakObject* >(this) ) );
 122
 123 #ifdef WNT
 124     // RECOMPOSE_ON_RESIZE misc flag means that the object has to be switched to running state on resize.
 125     // SetExtent() is called only for objects that require it,
 126     // it should not be called for MSWord documents to workaround problem i49369
 127     // If cached size is not set, that means that this is the size initialization, so there is no need to set the real size
 128     sal_Bool bAllowToSetExtent =
 129       ( ( getStatus( nAspect ) & embed::EmbedMisc::MS_EMBED_RECOMPOSEONRESIZE )
 130       && !MimeConfigurationHelper::ClassIDsEqual( m_aClassID, MimeConfigurationHelper::GetSequenceClassID( 0x00020906L, 0x0000, 0x0000,
 131                                                            0xc0,0x00,0x00,0x00,0x00,0x00,0x00,0x46 ) )
 132       && m_bHasCachedSize );
 133
 134     if ( m_nObjectState == embed::EmbedStates::LOADED && bAllowToSetExtent )
 135     {
 136         aGuard.clear();
 137         try {
 138             changeState( embed::EmbedStates::RUNNING );
 139         }
 140         catch( uno::Exception& )
 141         {
 142             OSL_ENSURE( sal_False, "The object should not be resized without activation!\n" );
 143         }
 144         aGuard.reset();
 145     }
 146
 147     if ( m_pOleComponent && m_nObjectState != embed::EmbedStates::LOADED && bAllowToSetExtent )
 148     {
 149         awt::Size aSizeToSet = aSize;
 150         aGuard.clear();
 151         try {
 152             m_pOleComponent->SetExtent( aSizeToSet, nAspect ); // will throw an exception in case of failure
 153             m_bHasSizeToSet = sal_False;
 154         }
 155         catch( uno::Exception& )
 156         {
 157             // some objects do not allow to set the size even in running state
 158             m_bHasSizeToSet = sal_True;
 159             m_aSizeToSet = aSizeToSet;
 160             m_nAspectToSet = nAspect;
 161         }
 162         aGuard.reset();
 163     }
 164 #endif
 165
 166     // cache the values
 167     m_bHasCachedSize = sal_True;
 168     m_aCachedSize = aSize;
 169     m_nCachedAspect = nAspect;
 170 }
 171
 172 awt::Size SAL_CALL OleEmbeddedObject::getVisualAreaSize( sal_Int64 nAspect )
 173         throw ( lang::IllegalArgumentException,
 174                 embed::WrongStateException,
 175                 uno::Exception,
 176                 uno::RuntimeException )
 177 {
 178     RTL_LOGFILE_CONTEXT( aLog, "embeddedobj (mv76033) OleEmbeddedObject::getVisualAreaSize" );
 179
 180     // begin wrapping related part ====================
 181     uno::Reference< embed::XEmbeddedObject > xWrappedObject = m_xWrappedObject;
 182     if ( xWrappedObject.is() )
 183     {
 184         // the object was converted to OOo embedded object, the current implementation is now only a wrapper
 185         return xWrappedObject->getVisualAreaSize( nAspect );
 186     }
 187     // end wrapping related part ====================
 188
 189     ::osl::ResettableMutexGuard aGuard( m_aMutex );
 190     if ( m_bDisposed )
 191         throw lang::DisposedException(); // TODO
 192
 193     OSL_ENSURE( nAspect != embed::Aspects::MSOLE_ICON, "For iconified objects no graphical replacement is required!\n" );
 194     if ( nAspect == embed::Aspects::MSOLE_ICON )
 195         // no representation can be retrieved
 196         throw embed::WrongStateException( ::rtl::OUString::createFromAscii( "Illegal call!\n" ),
 197                                     uno::Reference< uno::XInterface >( static_cast< ::cppu::OWeakObject* >(this) ) );
 198
 199     if ( m_nObjectState == -1 )
 200         throw embed::WrongStateException( ::rtl::OUString::createFromAscii( "The object is not loaded!\n" ),
 201                                     uno::Reference< uno::XInterface >( static_cast< ::cppu::OWeakObject* >(this) ) );
 202
 203     awt::Size aResult;
 204
 205 #ifdef WNT
 206     // TODO/LATER: Support different aspects
 207     if ( m_pOleComponent && !m_bHasSizeToSet && nAspect == embed::Aspects::MSOLE_CONTENT )
 208     {
 209         try
 210         {
 211             // the cached size updated every time the object is stored
 212             if ( m_bHasCachedSize )
 213             {
 214                 aResult = m_aCachedSize;
 215             }
 216             else
 217             {
 218                 // there is no internal cache
 219                 awt::Size aSize;
 220                 aGuard.clear();
 221
 222                 sal_Bool bSuccess = sal_False;
 223                 if ( getCurrentState() == embed::EmbedStates::LOADED )
 224                 {
 225                     OSL_ENSURE( sal_False, "Loaded object has no cached size!\n" );
 226
 227                     // try to switch the object to RUNNING state and request the value again
 228                     try {
 229                         changeState( embed::EmbedStates::RUNNING );
 230                     }
 231                     catch( uno::Exception )
 232                     {
 233                         throw embed::NoVisualAreaSizeException(
 234                                 ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "No size available!\n" ) ),
 235                                 uno::Reference< uno::XInterface >( static_cast< ::cppu::OWeakObject* >(this) ) );
 236                     }
 237                 }
 238
 239                 try
 240                 {
 241                     // first try to get size using replacement image
 242                     aSize = m_pOleComponent->GetExtent( nAspect ); // will throw an exception in case of failure
 243                     bSuccess = sal_True;
 244                 }
 245                 catch( uno::Exception& )
 246                 {
 247                 }
 248
 249                 if ( !bSuccess )
 250                 {
 251                     try
 252                     {
 253                         // second try the cached replacement image
 254                         aSize = m_pOleComponent->GetCachedExtent( nAspect ); // will throw an exception in case of failure
 255                         bSuccess = sal_True;
 256                     }
 257                     catch( uno::Exception& )
 258                     {
 259                     }
 260                 }
 261
 262                 if ( !bSuccess )
 263                 {
 264                     try
 265                     {
 266                         // third try the size reported by the object
 267                         aSize = m_pOleComponent->GetReccomendedExtent( nAspect ); // will throw an exception in case of failure
 268                         bSuccess = sal_True;
 269                     }
 270                     catch( uno::Exception& )
 271                     {
 272                     }
 273                 }
 274
 275                 if ( !bSuccess )
 276                     throw embed::NoVisualAreaSizeException(
 277                                     ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "No size available!\n" ) ),
 278                                     uno::Reference< uno::XInterface >( static_cast< ::cppu::OWeakObject* >(this) ) );
 279
 280                 aGuard.reset();
 281
 282                 m_aCachedSize = aSize;
 283                 m_nCachedAspect = nAspect;
 284                 m_bHasCachedSize = sal_True;
 285
 286                 aResult = m_aCachedSize;
 287             }
 288         }
 289         catch ( embed::NoVisualAreaSizeException& )
 290         {
 291             throw;
 292         }
 293         catch ( uno::Exception& )
 294         {
 295             throw embed::NoVisualAreaSizeException(
 296                             ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "No size available!\n" ) ),
 297                             uno::Reference< uno::XInterface >( static_cast< ::cppu::OWeakObject* >(this) ) );
 298         }
 299     }
 300     else
 301 #endif
 302     {
 303         // return cached value
 304         if ( m_bHasCachedSize )
 305         {
 306             OSL_ENSURE( nAspect == m_nCachedAspect, "Unexpected aspect is requested!\n" );
 307             aResult = m_aCachedSize;
 308         }
 309         else
 310         {
 311             throw embed::NoVisualAreaSizeException(
 312                             ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "No size available!\n" ) ),
 313                             uno::Reference< uno::XInterface >( static_cast< ::cppu::OWeakObject* >(this) ) );
 314         }
 315     }
 316
 317     return aResult;
 318 }
 319
 320 embed::VisualRepresentation SAL_CALL OleEmbeddedObject::getPreferredVisualRepresentation( sal_Int64 nAspect )
 321         throw ( lang::IllegalArgumentException,
 322                 embed::WrongStateException,
 323                 uno::Exception,
 324                 uno::RuntimeException )
 325 {
 326     RTL_LOGFILE_CONTEXT( aLog, "embeddedobj (mv76033) OleEmbeddedObject::getPreferredVisualRepresentation" );
 327
 328     // begin wrapping related part ====================
 329     uno::Reference< embed::XEmbeddedObject > xWrappedObject = m_xWrappedObject;
 330     if ( xWrappedObject.is() )
 331     {
 332         // the object was converted to OOo embedded object, the current implementation is now only a wrapper
 333         return xWrappedObject->getPreferredVisualRepresentation( nAspect );
 334     }
 335     // end wrapping related part ====================
 336
 337     ::osl::MutexGuard aGuard( m_aMutex );
 338     if ( m_bDisposed )
 339         throw lang::DisposedException(); // TODO
 340
 341     OSL_ENSURE( nAspect != embed::Aspects::MSOLE_ICON, "For iconified objects no graphical replacement is required!\n" );
 342     if ( nAspect == embed::Aspects::MSOLE_ICON )
 343         // no representation can be retrieved
 344         throw embed::WrongStateException( ::rtl::OUString::createFromAscii( "Illegal call!\n" ),
 345                                     uno::Reference< uno::XInterface >( static_cast< ::cppu::OWeakObject* >(this) ) );
 346
 347     // TODO: if the object has cached representation then it should be returned
 348     // TODO: if the object has no cached representation and is in loaded state it should switch itself to the running state
 349     if ( m_nObjectState == -1 )
 350         throw embed::WrongStateException( ::rtl::OUString::createFromAscii( "The object is not loaded!\n" ),
 351                                     uno::Reference< uno::XInterface >( static_cast< ::cppu::OWeakObject* >(this) ) );
 352
 353     embed::VisualRepresentation aVisualRepr;
 354
 355     // TODO: in case of different aspects they must be applied to the mediatype and XTransferable must be used
 356     // the cache is used only as a fallback if object is not in loaded state
 357     if ( !m_xCachedVisualRepresentation.is() && ( !m_bVisReplInitialized || m_bVisReplInStream )
 358       && m_nObjectState == embed::EmbedStates::LOADED )
 359     {
 360         m_xCachedVisualRepresentation = TryToRetrieveCachedVisualRepresentation_Impl( m_xObjectStream, sal_True );
 361         SetVisReplInStream( m_xCachedVisualRepresentation.is() );
 362     }
 363
 364     if ( m_xCachedVisualRepresentation.is() )
 365     {
 366         return GetVisualRepresentationInNativeFormat_Impl( m_xCachedVisualRepresentation );
 367     }
 368 #ifdef WNT
 369     else if ( m_pOleComponent )
 370     {
 371         try
 372         {
 373             if ( m_nObjectState == embed::EmbedStates::LOADED )
 374                 changeState( embed::EmbedStates::RUNNING );
 375
 376             datatransfer::DataFlavor aDataFlavor(
 377                     ::rtl::OUString::createFromAscii( "application/x-openoffice-wmf;windows_formatname=\"Image WMF\"" ),
 378                     ::rtl::OUString::createFromAscii( "Windows Metafile" ),
 379                     ::getCppuType( (const uno::Sequence< sal_Int8 >*) NULL ) );
 380
 381             aVisualRepr.Data = m_pOleComponent->getTransferData( aDataFlavor );
 382             aVisualRepr.Flavor = aDataFlavor;
 383
 384             uno::Sequence< sal_Int8 > aVisReplSeq;
 385             aVisualRepr.Data >>= aVisReplSeq;
 386             if ( aVisReplSeq.getLength() )
 387             {
 388                 m_xCachedVisualRepresentation = GetNewFilledTempStream_Impl(
 389                         uno::Reference< io::XInputStream > ( static_cast< io::XInputStream* > (
 390                             new ::comphelper::SequenceInputStream( aVisReplSeq ) ) ) );
 391             }
 392
 393             return aVisualRepr;
 394         }
 395         catch( uno::Exception& )
 396         {}
 397     }
 398 #endif
 399
 400     // the cache is used only as a fallback if object is not in loaded state
 401     if ( !m_xCachedVisualRepresentation.is() && ( !m_bVisReplInitialized || m_bVisReplInStream ) )
 402     {
 403         m_xCachedVisualRepresentation = TryToRetrieveCachedVisualRepresentation_Impl( m_xObjectStream );
 404         SetVisReplInStream( m_xCachedVisualRepresentation.is() );
 405     }
 406
 407     if ( !m_xCachedVisualRepresentation.is() )
 408     {
 409         // no representation can be retrieved
 410         throw embed::WrongStateException( ::rtl::OUString::createFromAscii( "Illegal call!\n" ),
 411                                     uno::Reference< uno::XInterface >( static_cast< ::cppu::OWeakObject* >(this) ) );
 412     }
 413
 414     return GetVisualRepresentationInNativeFormat_Impl( m_xCachedVisualRepresentation );
 415 }
 416
 417 sal_Int32 SAL_CALL OleEmbeddedObject::getMapUnit( sal_Int64 nAspect )
 418         throw ( uno::Exception,
 419                 uno::RuntimeException)
 420 {
 421     // begin wrapping related part ====================
 422     uno::Reference< embed::XEmbeddedObject > xWrappedObject = m_xWrappedObject;
 423     if ( xWrappedObject.is() )
 424     {
 425         // the object was converted to OOo embedded object, the current implementation is now only a wrapper
 426         return xWrappedObject->getMapUnit( nAspect );
 427     }
 428     // end wrapping related part ====================
 429
 430     ::osl::MutexGuard aGuard( m_aMutex );
 431     if ( m_bDisposed )
 432         throw lang::DisposedException(); // TODO
 433
 434     OSL_ENSURE( nAspect != embed::Aspects::MSOLE_ICON, "For iconified objects no graphical replacement is required!\n" );
 435     if ( nAspect == embed::Aspects::MSOLE_ICON )
 436         // no representation can be retrieved
 437         throw embed::WrongStateException( ::rtl::OUString::createFromAscii( "Illegal call!\n" ),
 438                                     uno::Reference< uno::XInterface >( static_cast< ::cppu::OWeakObject* >(this) ) );
 439
 440     if ( m_nObjectState == -1 )
 441         throw embed::WrongStateException( ::rtl::OUString::createFromAscii( "The object is not loaded!\n" ),
 442                                     uno::Reference< uno::XInterface >( static_cast< ::cppu::OWeakObject* >(this) ) );
 443
 444     return embed::EmbedMapUnits::ONE_100TH_MM;
 445 }
 446
 447