move writerfilter inside sw

writerfilter wants to convert incoming RTF and OOXML files into
writer's document model. But it currently has to do so by
manipulating the limited subset that we expose through the UNO
API.

This is both slower and less accurate than having access
to the full document model.

So move it inside, and then we can strip out various hacks, and
optimise imports.

Change-Id: Ie1114d28130ef5f9a786531bc552cb8ee7768015
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/165953
Tested-by: Noel Grandin <noel.grandin@collabora.co.uk>
Reviewed-by: Noel Grandin <noel.grandin@collabora.co.uk>

1 files changed, 331 insertions, 0 deletions

diff --git a/sw/source/writerfilter/dmapper/OLEHandler.cxx b/sw/source/writerfilter/dmapper/OLEHandler.cxx
new file mode 100644
index 000000000000..e0671c8a21b6
--- /dev/null
+++ b/sw/source/writerfilter/dmapper/OLEHandler.cxx
@@ -0,0 +1,331 @@
+/* -*- 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 .
+ */
+#include "OLEHandler.hxx"
+#include "DomainMapper.hxx"
+#include "GraphicHelpers.hxx"
+
+#include <oox/ole/oleobjecthelper.hxx>
+#include <ooxml/resourceids.hxx>
+#include <rtl/ustring.hxx>
+#include <sal/log.hxx>
+#include <osl/diagnose.h>
+#include <comphelper/diagnose_ex.hxx>
+#include <unotools/mediadescriptor.hxx>
+#include <officecfg/Office/Common.hxx>
+#include <com/sun/star/container/XNameAccess.hpp>
+#include <com/sun/star/document/XEmbeddedObjectResolver.hpp>
+#include <com/sun/star/document/XEmbeddedObjectSupplier.hpp>
+#include <com/sun/star/document/XFilter.hpp>
+#include <com/sun/star/document/XImporter.hpp>
+#include <com/sun/star/drawing/XShape.hpp>
+#include <com/sun/star/graphic/XGraphic.hpp>
+#include <com/sun/star/io/XOutputStream.hpp>
+#include <com/sun/star/lang/XComponent.hpp>
+#include <com/sun/star/lang/XMultiServiceFactory.hpp>
+#include <com/sun/star/lang/XServiceInfo.hpp>
+#include <com/sun/star/text/XTextDocument.hpp>
+#include <com/sun/star/text/WrapTextMode.hpp>
+#include <com/sun/star/uno/XComponentContext.hpp>
+
+namespace writerfilter::dmapper {
+
+using namespace ::com::sun::star;
+
+
+OLEHandler::OLEHandler(DomainMapper& rDomainMapper) :
+LoggedProperties("OLEHandler"),
+    m_nWrapMode(text::WrapTextMode_THROUGHT),
+    m_rDomainMapper(rDomainMapper)
+{
+}
+
+
+OLEHandler::~OLEHandler()
+{
+}
+
+
+void OLEHandler::lcl_attribute(Id rName, Value & rVal)
+{
+    OUString sStringValue = rVal.getString();
+    switch( rName )
+    {
+        case NS_ooxml::LN_CT_OLEObject_Type:
+        break;
+        case NS_ooxml::LN_CT_OLEObject_ProgID:
+            m_sProgId = sStringValue;
+        break;
+        case NS_ooxml::LN_CT_OLEObject_ShapeID:
+        break;
+        case NS_ooxml::LN_CT_OLEObject_DrawAspect:
+            m_sDrawAspect = sStringValue;
+        break;
+        case NS_ooxml::LN_CT_OLEObject_ObjectID:
+        break;
+        case NS_ooxml::LN_CT_OLEObject_r_id:
+        break;
+        case NS_ooxml::LN_inputstream:
+            rVal.getAny() >>= m_xInputStream;
+        break;
+        case NS_ooxml::LN_CT_Object_dxaOrig:
+             m_sVisAreaWidth = sStringValue;
+        break;
+        case NS_ooxml::LN_CT_Object_dyaOrig:
+             m_sVisAreaHeight = sStringValue;
+        break;
+        case NS_ooxml::LN_shape:
+        {
+            uno::Reference< drawing::XShape > xTempShape;
+            rVal.getAny() >>= xTempShape;
+
+            // Control shape is handled on a different code path
+            uno::Reference< lang::XServiceInfo > xSInfo( xTempShape, uno::UNO_QUERY_THROW );
+            if(xSInfo->supportsService("com.sun.star.drawing.ControlShape"))
+            {
+                m_rDomainMapper.hasControls(true);
+                break;
+            }
+
+            if( xTempShape.is() )
+            {
+                m_xShape.set( xTempShape );
+
+                // No need to set the wrapping here as it's either set in oox or will be set later
+
+                // Shapes in the header or footer should be in the background, since the default is WrapTextMode_THROUGH.
+                if (m_rDomainMapper.IsInHeaderFooter())
+                {
+                    try
+                    {
+                        uno::Reference<beans::XPropertySet> xShapeProps(m_xShape, uno::UNO_QUERY);
+                        xShapeProps->setPropertyValue("Opaque", uno::Any(false));
+                    }
+                    catch( const uno::Exception& )
+                    {
+                        TOOLS_WARN_EXCEPTION("writerfilter", "Exception in OLE Handler");
+                    }
+                }
+            }
+        }
+        break;
+        default:
+            OSL_FAIL( "unknown attribute");
+    }
+}
+
+css::awt::Size OLEHandler::getSize() const
+{
+    if (!m_xShape)
+        return css::awt::Size();
+    return m_xShape->getSize();
+}
+
+css::uno::Reference<css::graphic::XGraphic> OLEHandler::getReplacement() const
+{
+    if (!m_xShape)
+        return nullptr;
+    uno::Reference<beans::XPropertySet> xShapeProps(m_xShape, uno::UNO_QUERY);
+    css::uno::Reference<css::graphic::XGraphic> xReplacement;
+    xShapeProps->getPropertyValue(getPropertyName(PROP_BITMAP)) >>= xReplacement;
+    return xReplacement;
+}
+
+void OLEHandler::lcl_sprm(Sprm & rSprm)
+{
+    sal_uInt32 nSprmId = rSprm.getId();
+    switch( nSprmId )
+    {
+        case NS_ooxml::LN_OLEObject_OLEObject:
+        {
+            writerfilter::Reference<Properties>::Pointer_t pProperties = rSprm.getProps();
+            if( pProperties )
+            {
+                pProperties->resolve(*this);
+            }
+        }
+        break;
+        case NS_ooxml::LN_wrap_wrap:
+        {
+            writerfilter::Reference<Properties>::Pointer_t pProperties = rSprm.getProps();
+            if ( pProperties )
+            {
+                tools::SvRef<WrapHandler> pHandler( new WrapHandler );
+                pProperties->resolve( *pHandler );
+
+                m_nWrapMode = pHandler->getWrapMode( );
+
+                try
+                {
+                    uno::Reference< beans::XPropertySet > xShapeProps( m_xShape, uno::UNO_QUERY_THROW );
+
+                    xShapeProps->setPropertyValue(
+                        getPropertyName( PROP_SURROUND ),
+                        uno::Any( static_cast<sal_Int32>(m_nWrapMode) ) );
+
+                    // Through shapes in the header or footer(that spill into the body) should be in the background.
+                    // It is just assumed that all shapes will spill into the body.
+                    if( m_rDomainMapper.IsInHeaderFooter() )
+                        xShapeProps->setPropertyValue("Opaque", uno::Any(m_nWrapMode != text::WrapTextMode_THROUGH));
+                }
+                catch( const uno::Exception& )
+                {
+                    TOOLS_WARN_EXCEPTION("writerfilter", "Exception in OLE Handler");
+                }
+            }
+        }
+        break;
+        default:
+        {
+            OSL_FAIL( "unknown attribute");
+        }
+    }
+}
+
+void OLEHandler::importStream(const uno::Reference<uno::XComponentContext>& xComponentContext, const uno::Reference<text::XTextDocument>& xTextDocument, const uno::Reference<text::XTextContent>& xOLE)
+{
+    OUString aFilterService;
+    if (m_sProgId == "Word.Document.12")
+        aFilterService = "com.sun.star.comp.Writer.WriterFilter";
+    else if (m_sProgId == "Excel.Sheet.12")
+        aFilterService = "com.sun.star.comp.oox.xls.ExcelFilter";
+    else if (m_sProgId == "Equation.3")
+        aFilterService = "com.sun.star.comp.Math.MathTypeFilter";
+    else
+        SAL_WARN("writerfilter", "OLEHandler::importStream: unhandled m_sProgId: " << m_sProgId);
+
+    if (!m_xInputStream.is() || aFilterService.isEmpty())
+        return;
+
+    // Create the filter service.
+    uno::Reference<uno::XInterface> xInterface = xComponentContext->getServiceManager()->createInstanceWithContext(aFilterService, xComponentContext);
+
+    // Set target document.
+    uno::Reference<document::XImporter> xImporter(xInterface, uno::UNO_QUERY);
+    uno::Reference<document::XEmbeddedObjectSupplier> xSupplier(xOLE, uno::UNO_QUERY);
+    uno::Reference<lang::XComponent> xEmbeddedObject = xSupplier->getEmbeddedObject();
+    if (!xEmbeddedObject.is())
+        return;
+    xImporter->setTargetDocument( xEmbeddedObject );
+
+    // Import the input stream.
+    utl::MediaDescriptor aMediaDescriptor;
+    aMediaDescriptor["InputStream"] <<= m_xInputStream;
+    uno::Reference<document::XFilter> xFilter(xInterface, uno::UNO_QUERY);
+    xFilter->filter(aMediaDescriptor.getAsConstPropertyValueList());
+
+    // Now that the data is imported, update the (typically) changed stream name.
+    uno::Reference<beans::XPropertySet> xPropertySet(xOLE, uno::UNO_QUERY);
+    ::oox::ole::SaveInteropProperties(xTextDocument,
+        xPropertySet->getPropertyValue("StreamName").get<OUString>(), &m_aURL,
+        m_sProgId);
+}
+
+OUString OLEHandler::getCLSID() const
+{
+    OUString aRet;
+
+    // See officecfg/registry/data/org/openoffice/Office/Embedding.xcu.
+    if (m_sProgId == "Word.Document.12")
+    {
+        if (officecfg::Office::Common::Filter::Microsoft::Import::WinWordToWriter::get())
+            aRet = "8BC6B165-B1B2-4EDD-aa47-dae2ee689dd6";
+    }
+    else if (m_sProgId == "Excel.Sheet.12")
+    {
+        if (officecfg::Office::Common::Filter::Microsoft::Import::ExcelToCalc::get())
+            aRet = "47BBB4CB-CE4C-4E80-A591-42D9AE74950F";
+    }
+    else if (m_sProgId == "Equation.3")
+    {
+        if (officecfg::Office::Common::Filter::Microsoft::Import::MathTypeToMath::get())
+            aRet = "078B7ABA-54FC-457F-8551-6147E776A997";
+    }
+    else
+        SAL_WARN("writerfilter", "OLEHandler::getCLSID: unhandled m_sProgId: " << m_sProgId);
+
+    return aRet;
+}
+
+OUString const & OLEHandler::GetDrawAspect() const
+{
+    return m_sDrawAspect;
+}
+
+OUString const & OLEHandler::GetVisAreaWidth() const
+{
+    return m_sVisAreaWidth;
+}
+
+OUString const & OLEHandler::GetVisAreaHeight() const
+{
+    return m_sVisAreaHeight;
+}
+
+OUString OLEHandler::copyOLEOStream(
+        uno::Reference<text::XTextDocument> const& xTextDocument)
+{
+    OUString sRet;
+    if( !m_xInputStream.is( ) )
+        return sRet;
+    try
+    {
+        uno::Reference < lang::XMultiServiceFactory > xFactory(xTextDocument, uno::UNO_QUERY_THROW);
+        uno::Reference< document::XEmbeddedObjectResolver > xEmbeddedResolver(
+            xFactory->createInstance("com.sun.star.document.ImportEmbeddedObjectResolver"), uno::UNO_QUERY_THROW );
+        //hack to work with the ImportEmbeddedObjectResolver
+        static sal_Int32 nObjectCount = 100;
+        uno::Reference< container::XNameAccess > xNA( xEmbeddedResolver, uno::UNO_QUERY_THROW );
+        OUString aURL = "Obj" + OUString::number( nObjectCount++ );
+        uno::Reference < io::XOutputStream > xOLEStream;
+        if( (xNA->getByName( aURL ) >>= xOLEStream) && xOLEStream.is() )
+        {
+            const sal_Int32 nReadRequest = 0x1000;
+            uno::Sequence< sal_Int8 > aData;
+
+            while( true )
+            {
+                sal_Int32 nRead = m_xInputStream->readBytes( aData, nReadRequest );
+                xOLEStream->writeBytes( aData );
+                if( nRead < nReadRequest )
+                {
+                    xOLEStream->closeOutput();
+                    break;
+                }
+            }
+
+            ::oox::ole::SaveInteropProperties(xTextDocument, aURL, nullptr, m_sProgId);
+
+            OUString aPersistName( xEmbeddedResolver->resolveEmbeddedObjectURL( aURL ) );
+            sRet = aPersistName.copy( strlen("vnd.sun.star.EmbeddedObject:") );
+
+        }
+        uno::Reference< lang::XComponent > xComp( xEmbeddedResolver, uno::UNO_QUERY_THROW );
+        xComp->dispose();
+        m_aURL = aURL;
+    }
+    catch( const uno::Exception& )
+    {
+        TOOLS_WARN_EXCEPTION( "writerfilter", "OLEHandler::createOLEObject");
+    }
+    return sRet;
+}
+
+} //namespace writerfilter::dmapper
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */