oox/source/docprop/ooxmldocpropimport.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 "ooxmldocpropimport.hxx"
  21
  22 #include <vector>
  23 #include <com/sun/star/embed/ElementModes.hpp>
  24 #include <com/sun/star/embed/XHierarchicalStorageAccess.hpp>
  25 #include <com/sun/star/embed/XRelationshipAccess.hpp>
  26 #include <com/sun/star/embed/XStorage.hpp>
  27 #include <com/sun/star/io/IOException.hpp>
  28 #include <com/sun/star/lang/IllegalArgumentException.hpp>
  29 #include <com/sun/star/xml/sax/InputSource.hpp>
  30 #include <oox/core/fastparser.hxx>
  31 #include <oox/core/relations.hxx>
  32 #include "docprophandler.hxx"
  33
  34 #include <comphelper/sequence.hxx>
  35 #include <cppuhelper/supportsservice.hxx>
  36
  37 using namespace ::com::sun::star;
  38
  39 namespace oox::docprop {
  40
  41 using namespace ::com::sun::star::beans;
  42 using namespace ::com::sun::star::document;
  43 using namespace ::com::sun::star::embed;
  44 using namespace ::com::sun::star::io;
  45 using namespace ::com::sun::star::lang;
  46 using namespace ::com::sun::star::uno;
  47 using namespace ::com::sun::star::xml::sax;
  48
  49 namespace {
  50
  51 /// @throws RuntimeException
  52 /// @throws css::io::IOException
  53 Sequence< InputSource > lclGetRelatedStreams( const Reference< XStorage >& rxStorage, const OUString& rStreamType )
  54 {
  55     Reference< XRelationshipAccess > xRelation( rxStorage, UNO_QUERY_THROW );
  56     Reference< XHierarchicalStorageAccess > xHierarchy( rxStorage, UNO_QUERY_THROW );
  57
  58     const Sequence< Sequence< StringPair > > aPropsInfo = xRelation->getRelationshipsByType( rStreamType );
  59
  60     ::std::vector< InputSource > aResult;
  61
  62     for( const Sequence< StringPair >& rEntries : aPropsInfo )
  63     {
  64         auto pEntry = std::find_if(rEntries.begin(), rEntries.end(),
  65             [](const StringPair& rEntry) { return rEntry.First == "Target"; });
  66         if (pEntry != rEntries.end())
  67         {
  68             // The stream path is always a relative one, ignore the leading "/" if it's there.
  69             OUString aStreamPath = pEntry->Second;
  70             if (aStreamPath.startsWith("/"))
  71                 aStreamPath = aStreamPath.copy(1);
  72
  73             Reference< XExtendedStorageStream > xExtStream(
  74                 xHierarchy->openStreamElementByHierarchicalName( aStreamPath, ElementModes::READ ), UNO_SET_THROW );
  75             Reference< XInputStream > xInStream = xExtStream->getInputStream();
  76             if( xInStream.is() )
  77             {
  78                 aResult.emplace_back();
  79                 aResult.back().sSystemId = pEntry->Second;
  80                 aResult.back().aInputStream = xExtStream->getInputStream();
  81             }
  82         }
  83     }
  84
  85     return comphelper::containerToSequence( aResult );
  86 }
  87
  88 Sequence< InputSource > lclGetCoreStreams(const Reference< XStorage >& rxSource)
  89 {
  90     Sequence< InputSource > aCoreStreams = lclGetRelatedStreams(rxSource, CREATE_OFFICEDOC_RELATION_TYPE("metadata/core-properties"));
  91     // OOXML strict
  92     if (!aCoreStreams.hasElements())
  93         aCoreStreams = lclGetRelatedStreams(rxSource, CREATE_OFFICEDOC_RELATION_TYPE_STRICT("metadata/core-properties"));
  94     // MS Office seems to have a bug, so we have to do similar handling
  95     if (!aCoreStreams.hasElements())
  96         aCoreStreams = lclGetRelatedStreams(rxSource, u"http://schemas.openxmlformats.org/package/2006/relationships/metadata/core-properties"_ustr);
  97
  98     return aCoreStreams;
  99 }
 100
 101 Sequence< InputSource > lclGetExtStreams(const Reference< XStorage >& rxSource)
 102 {
 103     Sequence< InputSource > aExtStreams = lclGetRelatedStreams(rxSource, CREATE_OFFICEDOC_RELATION_TYPE("extended-properties"));
 104     // OOXML strict
 105     if (!aExtStreams.hasElements())
 106         aExtStreams = lclGetRelatedStreams(rxSource, CREATE_OFFICEDOC_RELATION_TYPE_STRICT("extended-properties"));
 107
 108     return aExtStreams;
 109 }
 110
 111 Sequence< InputSource > lclGetCustomStreams(const Reference< XStorage >& rxSource)
 112 {
 113     Sequence< InputSource > aCustomStreams = lclGetRelatedStreams(rxSource, CREATE_OFFICEDOC_RELATION_TYPE("custom-properties"));
 114     // OOXML strict
 115     if (!aCustomStreams.hasElements())
 116         aCustomStreams = lclGetRelatedStreams(rxSource, CREATE_OFFICEDOC_RELATION_TYPE_STRICT("custom-properties"));
 117
 118     return aCustomStreams;
 119 }
 120
 121
 122 } // namespace
 123
 124 DocumentPropertiesImport::DocumentPropertiesImport( const Reference< XComponentContext >& rxContext ) :
 125     mxContext( rxContext )
 126 {
 127 }
 128
 129 // XServiceInfo
 130 OUString SAL_CALL DocumentPropertiesImport::getImplementationName()
 131 {
 132     return u"com.sun.star.comp.oox.docprop.DocumentPropertiesImporter"_ustr;
 133 }
 134
 135 sal_Bool SAL_CALL DocumentPropertiesImport::supportsService( const OUString& rServiceName )
 136 {
 137     return cppu::supportsService(this, rServiceName);
 138 }
 139
 140 Sequence< OUString > SAL_CALL DocumentPropertiesImport::getSupportedServiceNames()
 141 {
 142     Sequence<OUString> aServices { u"com.sun.star.document.OOXMLDocumentPropertiesImporter"_ustr };
 143     return aServices;
 144 }
 145
 146 // XOOXMLDocumentPropertiesImporter
 147 void SAL_CALL DocumentPropertiesImport::importProperties(
 148         const Reference< XStorage >& rxSource, const Reference< XDocumentProperties >& rxDocumentProperties )
 149 {
 150     if( !mxContext.is() )
 151         throw RuntimeException();
 152
 153     if( !rxSource.is() || !rxDocumentProperties.is() )
 154         throw IllegalArgumentException();
 155
 156     Sequence< InputSource > aCoreStreams = lclGetCoreStreams(rxSource);
 157
 158     Sequence< InputSource > aExtStreams = lclGetExtStreams(rxSource);
 159
 160     Sequence< InputSource > aCustomStreams = lclGetCustomStreams(rxSource);
 161
 162     if( !(aCoreStreams.hasElements() || aExtStreams.hasElements() || aCustomStreams.hasElements()) )
 163         return;
 164
 165     if( aCoreStreams.getLength() > 1 )
 166         throw IOException( u"Unexpected core properties stream!"_ustr );
 167
 168     ::oox::core::FastParser aParser;
 169     aParser.registerNamespace( NMSP_packageMetaCorePr );
 170     aParser.registerNamespace( NMSP_dc );
 171     aParser.registerNamespace( NMSP_dcTerms );
 172     aParser.registerNamespace( NMSP_officeExtPr );
 173     aParser.registerNamespace( NMSP_officeCustomPr );
 174     aParser.registerNamespace( NMSP_officeDocPropsVT );
 175     aParser.setDocumentHandler( new OOXMLDocPropHandler( mxContext, rxDocumentProperties ) );
 176
 177     if( aCoreStreams.hasElements() )
 178         aParser.parseStream( aCoreStreams[ 0 ], true );
 179     for (const auto& rExtStream : aExtStreams)
 180         aParser.parseStream( rExtStream, true );
 181     for (const auto& rCustomStream : aCustomStreams)
 182         aParser.parseStream( rCustomStream, true );
 183 }
 184
 185 Reference < css::io::XInputStream > SAL_CALL DocumentPropertiesImport::getCorePropertiesStream(
 186     const Reference< XStorage >& rxSource)
 187 {
 188     Sequence< InputSource > aCoreStreams = lclGetCoreStreams(rxSource);
 189     if (!aCoreStreams.hasElements())
 190         return nullptr;
 191
 192     return aCoreStreams[0].aInputStream;
 193 }
 194
 195 Reference < css::io::XInputStream > SAL_CALL DocumentPropertiesImport::getExtendedPropertiesStream(
 196     const Reference< XStorage >& rxSource)
 197 {
 198     Sequence< InputSource > aExtStreams = lclGetExtStreams(rxSource);
 199     if (!aExtStreams.hasElements())
 200         return nullptr;
 201
 202     return aExtStreams[0].aInputStream;
 203 }
 204
 205 css::uno::Sequence< css::uno::Reference< css::io::XInputStream > > SAL_CALL DocumentPropertiesImport::getCustomPropertiesStreams(
 206     const Reference< XStorage >& rxSource)
 207 {
 208     Sequence <InputSource> aExtStreams = lclGetCustomStreams(rxSource);
 209
 210     // Repack the sequence
 211     std::vector<Reference<XInputStream>> aResult(aExtStreams.getLength());
 212     for (const auto& aInputSource : aExtStreams)
 213     {
 214         aResult.push_back(aInputSource.aInputStream);
 215     }
 216
 217     return comphelper::containerToSequence(aResult);
 218 }
 219
 220 } // namespace oox::docprop
 221
 222 extern "C" SAL_DLLPUBLIC_EXPORT uno::XInterface*
 223 com_sun_star_comp_oox_docprop_DocumentPropertiesImporter_get_implementation(
 224     uno::XComponentContext* pCtx, uno::Sequence<uno::Any> const& /*rSeq*/)
 225 {
 226     return cppu::acquire(new oox::docprop::DocumentPropertiesImport(pCtx));
 227 }
 228
 229 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */