427c763a1a
When on Windows the MSO wasn't installed DOCX and XLSX embedded documents weren't accessible. General OLE error was shown after doubleclick on the object. Linux solution is reused, OLE storage is extracted to get the document inside. Change-Id: If4d00fddad8e127fcf1a222836896d2907549d0c Reviewed-on: https://gerrit.libreoffice.org/39814 Tested-by: Jenkins <ci@libreoffice.org> Reviewed-by: Miklos Vajna <vmiklos@collabora.co.uk>
439 lines
16 KiB
C++
439 lines
16 KiB
C++
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/*
|
|
* This file is part of the LibreOffice project.
|
|
*
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
*
|
|
* This file incorporates work covered by the following license notice:
|
|
*
|
|
* Licensed to the Apache Software Foundation (ASF) under one or more
|
|
* contributor license agreements. See the NOTICE file distributed
|
|
* with this work for additional information regarding copyright
|
|
* ownership. The ASF licenses this file to you under the Apache
|
|
* License, Version 2.0 (the "License"); you may not use this file
|
|
* except in compliance with the License. You may obtain a copy of
|
|
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
|
|
*/
|
|
|
|
#ifndef INCLUDED_EMBEDDEDOBJ_SOURCE_INC_OLEEMBOBJ_HXX
|
|
#define INCLUDED_EMBEDDEDOBJ_SOURCE_INC_OLEEMBOBJ_HXX
|
|
|
|
#include <com/sun/star/uno/Sequence.hxx>
|
|
#include <com/sun/star/uno/Reference.hxx>
|
|
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
|
|
#include <com/sun/star/embed/XEmbeddedObject.hpp>
|
|
#include <com/sun/star/embed/XEmbeddedOleObject.hpp>
|
|
#include <com/sun/star/embed/XInplaceObject.hpp>
|
|
#include <com/sun/star/embed/XVisualObject.hpp>
|
|
#include <com/sun/star/embed/XEmbedPersist.hpp>
|
|
#include <com/sun/star/embed/XLinkageSupport.hpp>
|
|
#include <com/sun/star/embed/XClassifiedObject.hpp>
|
|
#include <com/sun/star/embed/XComponentSupplier.hpp>
|
|
#include <com/sun/star/embed/VerbDescriptor.hpp>
|
|
#include <com/sun/star/document/XEventBroadcaster.hpp>
|
|
#include <com/sun/star/container/XChild.hpp>
|
|
#include <com/sun/star/util/XCloseable.hpp>
|
|
#include <com/sun/star/util/XCloseListener.hpp>
|
|
#include <cppuhelper/implbase.hxx>
|
|
#include <rtl/ref.hxx>
|
|
|
|
#include <osl/thread.h>
|
|
|
|
namespace cppu {
|
|
class OMultiTypeInterfaceContainerHelper;
|
|
}
|
|
|
|
class VerbExecutionController
|
|
{
|
|
// the following mutex is allowed to be locked only for variables initialization, so no deadlock can be caused
|
|
::osl::Mutex m_aVerbExecutionMutex;
|
|
|
|
sal_Int32 m_nNotificationLock;
|
|
|
|
#ifdef _WIN32
|
|
bool m_bWasEverActive;
|
|
bool m_bVerbExecutionInProgress;
|
|
oslThreadIdentifier m_nVerbExecutionThreadIdentifier;
|
|
bool m_bChangedOnVerbExecution;
|
|
#endif
|
|
|
|
public:
|
|
|
|
VerbExecutionController()
|
|
: m_nNotificationLock( 0 )
|
|
#ifdef _WIN32
|
|
, m_bWasEverActive( false )
|
|
, m_bVerbExecutionInProgress( false )
|
|
, m_nVerbExecutionThreadIdentifier( 0 )
|
|
, m_bChangedOnVerbExecution( false )
|
|
#endif
|
|
{}
|
|
|
|
#ifdef _WIN32
|
|
void StartControlExecution();
|
|
bool EndControlExecution_WasModified();
|
|
void ModificationNotificationIsDone();
|
|
// no need to lock anything to check the value of the numeric members
|
|
bool CanDoNotification() { return ( !m_bVerbExecutionInProgress && !m_bWasEverActive && !m_nNotificationLock ); }
|
|
// ... or to change it
|
|
void ObjectIsActive() { m_bWasEverActive = true; }
|
|
#endif
|
|
void LockNotification();
|
|
void UnlockNotification();
|
|
};
|
|
|
|
class VerbExecutionControllerGuard
|
|
{
|
|
VerbExecutionController& m_rController;
|
|
public:
|
|
|
|
VerbExecutionControllerGuard( VerbExecutionController& rController )
|
|
: m_rController( rController )
|
|
{
|
|
m_rController.LockNotification();
|
|
}
|
|
|
|
~VerbExecutionControllerGuard()
|
|
{
|
|
m_rController.UnlockNotification();
|
|
}
|
|
};
|
|
|
|
|
|
class OleComponent;
|
|
class OwnView_Impl;
|
|
class OleEmbeddedObject : public ::cppu::WeakImplHelper
|
|
< css::embed::XEmbeddedObject
|
|
, css::embed::XEmbeddedOleObject
|
|
, css::embed::XEmbedPersist
|
|
, css::embed::XLinkageSupport
|
|
, css::embed::XInplaceObject
|
|
, css::container::XChild >
|
|
{
|
|
friend class OleComponent;
|
|
|
|
::osl::Mutex m_aMutex;
|
|
|
|
OleComponent* m_pOleComponent;
|
|
|
|
::cppu::OMultiTypeInterfaceContainerHelper* m_pInterfaceContainer;
|
|
|
|
bool m_bReadOnly;
|
|
|
|
bool m_bDisposed;
|
|
sal_Int32 m_nObjectState;
|
|
sal_Int32 m_nTargetState;
|
|
sal_Int32 m_nUpdateMode;
|
|
|
|
css::uno::Reference< css::lang::XMultiServiceFactory > m_xFactory;
|
|
|
|
css::uno::Sequence< sal_Int8 > m_aClassID;
|
|
OUString m_aClassName;
|
|
|
|
css::uno::Reference< css::embed::XEmbeddedClient > m_xClientSite;
|
|
|
|
OUString m_aContainerName;
|
|
|
|
css::uno::Reference< css::util::XCloseListener > m_xClosePreventer;
|
|
|
|
bool m_bWaitSaveCompleted;
|
|
bool m_bNewVisReplInStream;
|
|
css::uno::Reference< css::io::XStream > m_xNewCachedVisRepl;
|
|
OUString m_aNewEntryName;
|
|
css::uno::Reference< css::embed::XStorage > m_xNewParentStorage;
|
|
css::uno::Reference< css::io::XStream > m_xNewObjectStream;
|
|
bool m_bStoreLoaded;
|
|
|
|
css::uno::Reference< css::io::XStream > m_xCachedVisualRepresentation;
|
|
bool m_bVisReplInitialized;
|
|
bool m_bVisReplInStream;
|
|
bool m_bStoreVisRepl;
|
|
|
|
bool m_bIsLink;
|
|
|
|
// TODO/LATER: may need to cache more than one aspect in future
|
|
bool m_bHasCachedSize; // the object has cached size
|
|
css::awt::Size m_aCachedSize;
|
|
sal_Int64 m_nCachedAspect;
|
|
|
|
bool m_bHasSizeToSet; // the object has cached size that should be set to OLE component
|
|
css::awt::Size m_aSizeToSet; // this size might be different from the cached one ( scaling is applied )
|
|
sal_Int64 m_nAspectToSet;
|
|
|
|
|
|
// cache the status of the object
|
|
// TODO/LATER: may need to cache more than one aspect in future
|
|
bool m_bGotStatus;
|
|
sal_Int64 m_nStatus;
|
|
sal_Int64 m_nStatusAspect;
|
|
|
|
// embedded object related stuff
|
|
OUString m_aEntryName;
|
|
css::uno::Reference< css::embed::XStorage > m_xParentStorage;
|
|
css::uno::Reference< css::io::XStream > m_xObjectStream;
|
|
|
|
// link related stuff
|
|
OUString m_aLinkURL; // ???
|
|
|
|
// points to own view provider if the object has no server
|
|
rtl::Reference<OwnView_Impl> m_xOwnView;
|
|
|
|
// whether the object should be initialized from clipboard in case of default initialization
|
|
bool m_bFromClipboard;
|
|
|
|
OUString m_aTempURL;
|
|
|
|
OUString m_aTempDumpURL;
|
|
|
|
// STAMPIT solution
|
|
// the following member is used during verb execution to detect whether the verb execution modifies the object
|
|
VerbExecutionController m_aVerbExecutionController;
|
|
|
|
// if the following member is set, the object works in wrapper mode
|
|
css::uno::Reference< css::embed::XEmbeddedObject > m_xWrappedObject;
|
|
bool m_bTriedConversion;
|
|
OUString m_aFilterName; // if m_bTriedConversion, then the filter detected by that
|
|
|
|
css::uno::Reference< css::uno::XInterface > m_xParent;
|
|
|
|
protected:
|
|
/// @throws css::uno::Exception
|
|
css::uno::Reference< css::io::XStream > TryToGetAcceptableFormat_Impl(
|
|
const css::uno::Reference< css::io::XStream >& xStream );
|
|
|
|
/// @throws css::io::IOException
|
|
/// @throws css::uno::RuntimeException
|
|
css::uno::Reference< css::io::XStream > GetNewFilledTempStream_Impl(
|
|
const css::uno::Reference< css::io::XInputStream >& xInStream );
|
|
#ifdef _WIN32
|
|
void SwitchComponentToRunningState_Impl();
|
|
#endif
|
|
void MakeEventListenerNotification_Impl( const OUString& aEventName );
|
|
#ifdef _WIN32
|
|
void StateChangeNotification_Impl( bool bBeforeChange, sal_Int32 nOldState, sal_Int32 nNewState );
|
|
css::uno::Reference< css::io::XOutputStream > GetStreamForSaving();
|
|
|
|
|
|
css::uno::Sequence< sal_Int32 > GetIntermediateVerbsSequence_Impl( sal_Int32 nNewState );
|
|
|
|
static css::uno::Sequence< sal_Int32 > GetReachableStatesList_Impl(
|
|
const css::uno::Sequence< css::embed::VerbDescriptor >& aVerbList );
|
|
#endif
|
|
|
|
void Dispose();
|
|
|
|
void SwitchOwnPersistence(
|
|
const css::uno::Reference< css::embed::XStorage >& xNewParentStorage,
|
|
const css::uno::Reference< css::io::XStream >& xNewObjectStream,
|
|
const OUString& aNewName );
|
|
|
|
void SwitchOwnPersistence(
|
|
const css::uno::Reference< css::embed::XStorage >& xNewParentStorage,
|
|
const OUString& aNewName );
|
|
|
|
void GetRidOfComponent();
|
|
|
|
/// @throws css::uno::Exception
|
|
void StoreToLocation_Impl(
|
|
const css::uno::Reference< css::embed::XStorage >& xStorage,
|
|
const OUString& sEntName,
|
|
const css::uno::Sequence< css::beans::PropertyValue >& lObjArgs,
|
|
bool bSaveAs );
|
|
#ifdef _WIN32
|
|
/// @throws css::uno::Exception
|
|
void StoreObjectToStream( css::uno::Reference< css::io::XOutputStream > const & xOutStream );
|
|
#endif
|
|
/// @throws css::uno::Exception
|
|
void InsertVisualCache_Impl(
|
|
const css::uno::Reference< css::io::XStream >& xTargetStream,
|
|
const css::uno::Reference< css::io::XStream >& xCachedVisualRepresentation );
|
|
|
|
/// @throws css::uno::Exception
|
|
void RemoveVisualCache_Impl( const css::uno::Reference< css::io::XStream >& xTargetStream );
|
|
|
|
void SetVisReplInStream( bool bExists );
|
|
bool HasVisReplInStream();
|
|
|
|
/// @throws css::uno::Exception
|
|
css::embed::VisualRepresentation GetVisualRepresentationInNativeFormat_Impl(
|
|
const css::uno::Reference< css::io::XStream >& xCachedVisRepr );
|
|
|
|
css::uno::Reference< css::io::XStream > TryToRetrieveCachedVisualRepresentation_Impl(
|
|
const css::uno::Reference< css::io::XStream >& xStream,
|
|
bool bAllowRepair50 = false )
|
|
throw ();
|
|
#ifdef _WIN32
|
|
bool SaveObject_Impl();
|
|
bool OnShowWindow_Impl( bool bShow );
|
|
void CreateOleComponent_Impl( OleComponent* pOleComponent = nullptr );
|
|
void CreateOleComponentAndLoad_Impl( OleComponent* pOleComponent = nullptr );
|
|
void CreateOleComponentFromClipboard_Impl( OleComponent* pOleComponent = nullptr );
|
|
OUString CreateTempURLEmpty_Impl();
|
|
OUString GetTempURL_Impl();
|
|
void SetObjectIsLink_Impl( bool bIsLink ) { m_bIsLink = bIsLink; }
|
|
#endif
|
|
|
|
// the following 4 methods are related to switch to wrapping mode
|
|
void MoveListeners();
|
|
css::uno::Reference< css::embed::XStorage > CreateTemporarySubstorage( OUString& o_aStorageName );
|
|
OUString MoveToTemporarySubstream();
|
|
bool TryToConvertToOOo( const css::uno::Reference< css::io::XStream >& xStream );
|
|
|
|
public:
|
|
// in case a new object must be created the class ID must be specified
|
|
OleEmbeddedObject( const css::uno::Reference< css::lang::XMultiServiceFactory >& xFactory,
|
|
const css::uno::Sequence< sal_Int8 >& aClassID,
|
|
const OUString& aClassName );
|
|
|
|
// in case object will be loaded from a persistent entry or from a file the class ID will be detected on loading
|
|
// factory can do it for OOo objects, but for OLE objects OS dependent code is required
|
|
OleEmbeddedObject( const css::uno::Reference< css::lang::XMultiServiceFactory >& xFactory,
|
|
bool bLink );
|
|
#ifdef _WIN32
|
|
// this constructor let object be initialized from clipboard
|
|
OleEmbeddedObject( const css::uno::Reference< css::lang::XMultiServiceFactory >& xFactory );
|
|
#endif
|
|
|
|
virtual ~OleEmbeddedObject() override;
|
|
|
|
#ifdef _WIN32
|
|
static void OnIconChanged_Impl();
|
|
void OnViewChanged_Impl();
|
|
void OnClosed_Impl();
|
|
#endif
|
|
|
|
// XEmbeddedObject
|
|
|
|
virtual void SAL_CALL changeState( sal_Int32 nNewState ) override;
|
|
|
|
virtual css::uno::Sequence< sal_Int32 > SAL_CALL getReachableStates() override;
|
|
|
|
virtual sal_Int32 SAL_CALL getCurrentState() override;
|
|
|
|
virtual void SAL_CALL doVerb( sal_Int32 nVerbID ) override;
|
|
|
|
virtual css::uno::Sequence< css::embed::VerbDescriptor > SAL_CALL getSupportedVerbs() override;
|
|
|
|
virtual void SAL_CALL setClientSite(
|
|
const css::uno::Reference< css::embed::XEmbeddedClient >& xClient ) override;
|
|
|
|
virtual css::uno::Reference< css::embed::XEmbeddedClient > SAL_CALL getClientSite() override;
|
|
|
|
virtual void SAL_CALL update() override;
|
|
|
|
virtual void SAL_CALL setUpdateMode( sal_Int32 nMode ) override;
|
|
|
|
virtual sal_Int64 SAL_CALL getStatus( sal_Int64 nAspect ) override;
|
|
|
|
virtual void SAL_CALL setContainerName( const OUString& sName ) override;
|
|
|
|
|
|
// XVisualObject
|
|
|
|
virtual void SAL_CALL setVisualAreaSize( sal_Int64 nAspect, const css::awt::Size& aSize ) override;
|
|
|
|
virtual css::awt::Size SAL_CALL getVisualAreaSize( sal_Int64 nAspect ) override;
|
|
|
|
virtual css::embed::VisualRepresentation SAL_CALL getPreferredVisualRepresentation( ::sal_Int64 nAspect ) override;
|
|
|
|
virtual sal_Int32 SAL_CALL getMapUnit( sal_Int64 nAspect ) override;
|
|
|
|
|
|
// XEmbedPersist
|
|
|
|
virtual void SAL_CALL setPersistentEntry(
|
|
const css::uno::Reference< css::embed::XStorage >& xStorage,
|
|
const OUString& sEntName,
|
|
sal_Int32 nEntryConnectionMode,
|
|
const css::uno::Sequence< css::beans::PropertyValue >& lArguments,
|
|
const css::uno::Sequence< css::beans::PropertyValue >& lObjArgs ) override;
|
|
|
|
virtual void SAL_CALL storeToEntry( const css::uno::Reference< css::embed::XStorage >& xStorage, const OUString& sEntName, const css::uno::Sequence< css::beans::PropertyValue >& lArguments, const css::uno::Sequence< css::beans::PropertyValue >& lObjArgs ) override;
|
|
|
|
virtual void SAL_CALL storeAsEntry(
|
|
const css::uno::Reference< css::embed::XStorage >& xStorage,
|
|
const OUString& sEntName,
|
|
const css::uno::Sequence< css::beans::PropertyValue >& lArguments,
|
|
const css::uno::Sequence< css::beans::PropertyValue >& lObjArgs ) override;
|
|
|
|
virtual void SAL_CALL saveCompleted( sal_Bool bUseNew ) override;
|
|
|
|
virtual sal_Bool SAL_CALL hasEntry() override;
|
|
|
|
virtual OUString SAL_CALL getEntryName() override;
|
|
|
|
// XLinkageSupport
|
|
|
|
virtual void SAL_CALL breakLink( const css::uno::Reference< css::embed::XStorage >& xStorage,
|
|
const OUString& sEntName ) override;
|
|
|
|
virtual sal_Bool SAL_CALL isLink() override;
|
|
|
|
virtual OUString SAL_CALL getLinkURL() override;
|
|
|
|
// XCommonEmbedPersist
|
|
virtual void SAL_CALL storeOwn() override;
|
|
|
|
virtual sal_Bool SAL_CALL isReadonly() override;
|
|
|
|
virtual void SAL_CALL reload(
|
|
const css::uno::Sequence< css::beans::PropertyValue >& lArguments,
|
|
const css::uno::Sequence< css::beans::PropertyValue >& lObjArgs ) override;
|
|
|
|
// XClassifiedObject
|
|
|
|
virtual css::uno::Sequence< sal_Int8 > SAL_CALL getClassID() override;
|
|
|
|
virtual OUString SAL_CALL getClassName() override;
|
|
|
|
virtual void SAL_CALL setClassInfo(
|
|
const css::uno::Sequence< sal_Int8 >& aClassID, const OUString& aClassName ) override;
|
|
|
|
// XStateChangeBroadcaster
|
|
virtual void SAL_CALL addStateChangeListener( const css::uno::Reference< css::embed::XStateChangeListener >& xListener ) override;
|
|
virtual void SAL_CALL removeStateChangeListener( const css::uno::Reference< css::embed::XStateChangeListener >& xListener ) override;
|
|
|
|
|
|
// XComponentSupplier
|
|
|
|
virtual css::uno::Reference< css::util::XCloseable > SAL_CALL getComponent() override;
|
|
|
|
// XCloseable
|
|
|
|
virtual void SAL_CALL close( sal_Bool DeliverOwnership ) override;
|
|
|
|
virtual void SAL_CALL addCloseListener(
|
|
const css::uno::Reference< css::util::XCloseListener >& Listener ) override;
|
|
|
|
virtual void SAL_CALL removeCloseListener(
|
|
const css::uno::Reference< css::util::XCloseListener >& Listener ) override;
|
|
|
|
// XEventBroadcaster
|
|
virtual void SAL_CALL addEventListener(
|
|
const css::uno::Reference< css::document::XEventListener >& Listener ) override;
|
|
|
|
virtual void SAL_CALL removeEventListener(
|
|
const css::uno::Reference< css::document::XEventListener >& Listener ) override;
|
|
|
|
// XInplaceObject ( only for wrapping scenario here )
|
|
|
|
virtual void SAL_CALL setObjectRectangles( const css::awt::Rectangle& aPosRect,
|
|
const css::awt::Rectangle& aClipRect ) override;
|
|
|
|
virtual void SAL_CALL enableModeless( sal_Bool bEnable ) override;
|
|
|
|
virtual void SAL_CALL translateAccelerators(
|
|
const css::uno::Sequence< css::awt::KeyEvent >& aKeys ) override;
|
|
|
|
// XChild ( only for wrapping scenario here )
|
|
virtual css::uno::Reference< css::uno::XInterface > SAL_CALL getParent( ) override;
|
|
virtual void SAL_CALL setParent( const css::uno::Reference< css::uno::XInterface >& Parent ) override;
|
|
|
|
};
|
|
|
|
#endif
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|