forked from amazingfate/loongoffice
e2bfc34d14
... to make sure that object methods are called in correct apartment The user-visible problem was, that running a Java code that connects to LibreOffice, and opening a document with an embedded OLE object (it was Word object in a specific case, which needs activation at opening stage, because these objects have OLEMISC_RECOMPOSEONRESIZE flag), using loadComponentFromURL with "OnMainThread" set to true, then closing the document, resulted in a hang after several hundreds iterations. This was caused by Word process, that was started in background to serve the COM calls, wasn't closed properly, and kept all the objects in memory, until OOM. The reason why it wasn't closed was failed call to IOleObject::Close in OleComponent::CloseObject, which returned RPC_E_WRONG_THREAD, because the activation of the OLE object happened in the main thread (because of "OnMainThread"), which is STA, but closing happened in the handler thread (belonging to MTA). Similar problems previously were addressed in commits 2dc3a6c273cb82506842864481d78df7294debbf (framework: allow loading a component on the main thread, 2018-12-20), 6002014ce0a5c9cea22c14b2437b7a508b2c72cb (framework: allow loading a component on the main thread, using XDesktop, 2021-04-28), d5cd62164d32273a25913c93aa04be9f7f3a4073 (embeddedobj: handle getting the visible area on a thread, 2021-05-07). These changes tried different workarounds for the same problem, when a COM object instantiated in one apartment is later manipulated from another, which fails. First two handled the case when the document is loaded from a non-UI thread, and then manipulated with the UI; to handle that, they introduced flags that delegated opening the file to the main (UI) thread. The last change tried to handle the reverse problem of the OLE object instantiated in the main thread was saved in a handler thread, which again failed; the workaround was, again, to try to delegate the second attempt to the main thread. But basically all methods can fail in such circumstations, as shown in this problem's case. The "OnMainThread" flag must be passed to fileopen functions explicitly. Also, the workarounds only work by passing everything to STA, and don't target a case when the calls must be passed from STA to MTA. Since Windows 2000, there is IGlobalInterfaceTable, which goal is to solve this problem. It allows to use an intermediate object, which can transparently delegate all calls to the correct thread. This change re-implements how OLE objects are referenced from OleComponentNative_Impl, using the said IGlobalInterfaceTable. This should hopefully obsolete the previous workarounds, which nevertheless are kept for now. Change-Id: Ia1c590e547ed24a2c7389283aed6cc3d8ea024b0 Reviewed-on: https://gerrit.libreoffice.org/c/core/+/164457 Tested-by: Jenkins Reviewed-by: Mike Kaganski <mike.kaganski@collabora.com>
160 lines
6.5 KiB
C++
160 lines
6.5 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 .
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <com/sun/star/uno/Sequence.hxx>
|
|
#include <com/sun/star/uno/Reference.hxx>
|
|
#include <com/sun/star/uno/Any.hxx>
|
|
#include <com/sun/star/lang/XComponent.hpp>
|
|
#include <com/sun/star/util/XCloseable.hpp>
|
|
#include <com/sun/star/datatransfer/XTransferable.hpp>
|
|
#include <com/sun/star/embed/VerbDescriptor.hpp>
|
|
#include <com/sun/star/awt/Size.hpp>
|
|
#include <com/sun/star/lang/XUnoTunnel.hpp>
|
|
#include <cppuhelper/implbase.hxx>
|
|
#include <com/sun/star/util/XModifiable.hpp>
|
|
#include <com/sun/star/util/XModifyListener.hpp>
|
|
#include <com/sun/star/uno/XComponentContext.hpp>
|
|
#include <rtl/ref.hxx>
|
|
|
|
namespace comphelper {
|
|
class OMultiTypeInterfaceContainerHelper2;
|
|
}
|
|
|
|
class OleWrapperClientSite;
|
|
class OleWrapperAdviseSink;
|
|
class OleEmbeddedObject;
|
|
class OleComponentNative_Impl;
|
|
|
|
class OleComponent : public ::cppu::WeakImplHelper< css::util::XCloseable, css::lang::XComponent,
|
|
css::lang::XUnoTunnel, css::util::XModifiable,
|
|
css::datatransfer::XTransferable >
|
|
{
|
|
::osl::Mutex m_aMutex;
|
|
comphelper::OMultiTypeInterfaceContainerHelper2* m_pInterfaceContainer;
|
|
|
|
bool m_bDisposed;
|
|
bool m_bModified;
|
|
std::unique_ptr<OleComponentNative_Impl> m_pNativeImpl;
|
|
|
|
OleEmbeddedObject* m_pUnoOleObject;
|
|
OleWrapperClientSite* m_pOleWrapClientSite;
|
|
OleWrapperAdviseSink* m_pImplAdviseSink;
|
|
|
|
css::uno::Sequence< css::embed::VerbDescriptor > m_aVerbList;
|
|
css::uno::Sequence< css::datatransfer::DataFlavor > m_aDataFlavors;
|
|
|
|
css::uno::Reference< css::uno::XComponentContext > m_xContext;
|
|
|
|
bool m_bOleInitialized;
|
|
|
|
// specifies whether the workaround for some rare embedded objects is activated ( f.e. AcrobatReader 7.0.8 object )
|
|
// such objects report the dirty state wrongly sometimes and do not allow to store them any time
|
|
bool m_bWorkaroundActive;
|
|
|
|
void InitializeObject_Impl();
|
|
|
|
OUString getTempURL() const;
|
|
|
|
void RetrieveObjectDataFlavors_Impl();
|
|
void Dispose();
|
|
|
|
|
|
public:
|
|
OleComponent( const css::uno::Reference< css::uno::XComponentContext >& xContext,
|
|
OleEmbeddedObject* pOleObj );
|
|
|
|
virtual ~OleComponent() override;
|
|
|
|
OleComponent* createEmbeddedCopyOfLink();
|
|
|
|
void disconnectEmbeddedObject();
|
|
|
|
static css::awt::Size CalculateWithFactor( const css::awt::Size& aSize,
|
|
const css::awt::Size& aMultiplier,
|
|
const css::awt::Size& aDivisor );
|
|
|
|
css::awt::Size CalculateTheRealSize( const css::awt::Size& aContSize, bool bUpdate );
|
|
|
|
// ==== Initialization ==================================================
|
|
void LoadEmbeddedObject( const OUString& aTempURL );
|
|
void CreateObjectFromClipboard();
|
|
void CreateNewEmbeddedObject( const css::uno::Sequence< sal_Int8 >& aSeqCLSID );
|
|
static void CreateObjectFromData(
|
|
const css::uno::Reference< css::datatransfer::XTransferable >& xTransfer );
|
|
void CreateObjectFromFile( const OUString& aFileName );
|
|
void CreateLinkFromFile( const OUString& aFileName );
|
|
void InitEmbeddedCopyOfLink( rtl::Reference<OleComponent> const & pOleLinkComponent );
|
|
|
|
|
|
void RunObject(); // switch OLE object to running state
|
|
void CloseObject(); // switch OLE object to loaded state
|
|
|
|
css::uno::Sequence< css::embed::VerbDescriptor > GetVerbList();
|
|
|
|
void ExecuteVerb( sal_Int32 nVerbID );
|
|
void SetHostName( const OUString& aEmbDocName );
|
|
void SetExtent( const css::awt::Size& aVisAreaSize, sal_Int64 nAspect );
|
|
|
|
css::awt::Size GetExtent( sal_Int64 nAspect );
|
|
css::awt::Size GetCachedExtent( sal_Int64 nAspect );
|
|
css::awt::Size GetRecommendedExtent( sal_Int64 nAspect );
|
|
|
|
sal_Int64 GetMiscStatus( sal_Int64 nAspect );
|
|
|
|
css::uno::Sequence< sal_Int8 > GetCLSID();
|
|
|
|
bool IsWorkaroundActive() const { return m_bWorkaroundActive; }
|
|
bool IsDirty();
|
|
|
|
void StoreOwnTmpIfNecessary();
|
|
|
|
bool SaveObject_Impl();
|
|
bool OnShowWindow_Impl( bool bShow );
|
|
void OnViewChange_Impl( sal_uInt32 dwAspect );
|
|
void OnClose_Impl();
|
|
|
|
// 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;
|
|
|
|
// XTransferable
|
|
virtual css::uno::Any SAL_CALL getTransferData( const css::datatransfer::DataFlavor& aFlavor ) override;
|
|
virtual css::uno::Sequence< css::datatransfer::DataFlavor > SAL_CALL getTransferDataFlavors( ) override;
|
|
virtual sal_Bool SAL_CALL isDataFlavorSupported( const css::datatransfer::DataFlavor& aFlavor ) override;
|
|
|
|
// XComponent
|
|
virtual void SAL_CALL dispose() override;
|
|
virtual void SAL_CALL addEventListener(const css::uno::Reference < css::lang::XEventListener >& aListener) override;
|
|
virtual void SAL_CALL removeEventListener(const css::uno::Reference < css::lang::XEventListener >& aListener) override;
|
|
|
|
// XUnoTunnel
|
|
virtual sal_Int64 SAL_CALL getSomething( const css::uno::Sequence< sal_Int8 >& aIdentifier ) override;
|
|
|
|
// XModifiable
|
|
virtual sal_Bool SAL_CALL isModified() override;
|
|
virtual void SAL_CALL setModified( sal_Bool bModified ) override;
|
|
virtual void SAL_CALL addModifyListener( const css::uno::Reference < css::util::XModifyListener >& xListener ) override;
|
|
virtual void SAL_CALL removeModifyListener( const css::uno::Reference < css::util::XModifyListener >& xListener) override;
|
|
};
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|