oox/source/helper/zipstorage.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 <oox/helper/zipstorage.hxx>
  21
  22 #include <com/sun/star/embed/ElementModes.hpp>
  23 #include <com/sun/star/embed/XStorage.hpp>
  24 #include <com/sun/star/embed/XTransactedObject.hpp>
  25 #include <com/sun/star/io/XInputStream.hpp>
  26 #include <com/sun/star/io/XOutputStream.hpp>
  27 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  28 #include <com/sun/star/uno/XComponentContext.hpp>
  29 #include <osl/diagnose.h>
  30 #include <sal/log.hxx>
  31 #include <tools/diagnose_ex.h>
  32 #include <comphelper/storagehelper.hxx>
  33 #include <oox/helper/helper.hxx>
  34
  35 namespace oox {
  36
  37 using namespace ::com::sun::star::container;
  38 using namespace ::com::sun::star::embed;
  39 using namespace ::com::sun::star::io;
  40 using namespace ::com::sun::star::lang;
  41 using namespace ::com::sun::star::uno;
  42
  43 ZipStorage::ZipStorage( const Reference< XComponentContext >& rxContext, const Reference< XInputStream >& rxInStream ) :
  44     StorageBase( rxInStream, false )
  45 {
  46     OSL_ENSURE( rxContext.is(), "ZipStorage::ZipStorage - missing component context" );
  47     // create base storage object
  48     if( rxContext.is() ) try
  49     {
  50         /*  #i105325# ::comphelper::OStorageHelper::GetStorageFromInputStream()
  51             cannot be used here as it will open a storage with format type
  52             'PackageFormat' that will not work with OOXML packages.
  53
  54             #161971# The MS-document storages should always be opened in repair
  55             mode to ignore the format errors and get so much info as possible.
  56             I hate this solution, but it seems to be the only consistent way to
  57             handle the MS documents.
  58
  59             TODO: #i105410# switch to 'OFOPXMLFormat' and use its
  60             implementation of relations handling.
  61          */
  62         mxStorage = ::comphelper::OStorageHelper::GetStorageOfFormatFromInputStream(
  63             ZIP_STORAGE_FORMAT_STRING, rxInStream, rxContext, false);
  64     }
  65     catch (Exception const&)
  66     {
  67         TOOLS_WARN_EXCEPTION("oox.storage", "ZipStorage::ZipStorage exception opening input storage");
  68     }
  69 }
  70
  71 ZipStorage::ZipStorage( const Reference< XComponentContext >& rxContext, const Reference< XStream >& rxStream ) :
  72     StorageBase( rxStream, false )
  73 {
  74     OSL_ENSURE( rxContext.is(), "ZipStorage::ZipStorage - missing component context" );
  75     // create base storage object
  76     if( rxContext.is() ) try
  77     {
  78         const sal_Int32 nOpenMode = ElementModes::READWRITE | ElementModes::TRUNCATE;
  79         mxStorage = ::comphelper::OStorageHelper::GetStorageOfFormatFromStream(
  80             OFOPXML_STORAGE_FORMAT_STRING, rxStream, nOpenMode, rxContext, true);
  81     }
  82     catch (Exception const&)
  83     {
  84         TOOLS_WARN_EXCEPTION("oox.storage", "ZipStorage::ZipStorage exception opening output storage");
  85     }
  86 }
  87
  88 ZipStorage::ZipStorage( const ZipStorage& rParentStorage, const Reference< XStorage >& rxStorage, const OUString& rElementName ) :
  89     StorageBase( rParentStorage, rElementName, rParentStorage.isReadOnly() ),
  90     mxStorage( rxStorage )
  91 {
  92     SAL_WARN_IF(!mxStorage.is(), "oox.storage", "ZipStorage::ZipStorage "
  93             " - missing storage" );
  94 }
  95
  96 ZipStorage::~ZipStorage()
  97 {
  98 }
  99
 100 bool ZipStorage::implIsStorage() const
 101 {
 102     return mxStorage.is();
 103 }
 104
 105 Reference< XStorage > ZipStorage::implGetXStorage() const
 106 {
 107     return mxStorage;
 108 }
 109
 110 void ZipStorage::implGetElementNames( ::std::vector< OUString >& orElementNames ) const
 111 {
 112     Sequence< OUString > aNames;
 113     if( mxStorage.is() ) try
 114     {
 115         aNames = mxStorage->getElementNames();
 116         if( aNames.hasElements() )
 117             orElementNames.insert( orElementNames.end(), aNames.begin(), aNames.end() );
 118     }
 119     catch (Exception const&)
 120     {
 121         TOOLS_INFO_EXCEPTION("oox.storage", "getElementNames");
 122     }
 123 }
 124
 125 StorageRef ZipStorage::implOpenSubStorage( const OUString& rElementName, bool bCreateMissing )
 126 {
 127     Reference< XStorage > xSubXStorage;
 128     bool bMissing = false;
 129     if( mxStorage.is() ) try
 130     {
 131         // XStorage::isStorageElement may throw various exceptions...
 132         if( mxStorage->isStorageElement( rElementName ) )
 133             xSubXStorage = mxStorage->openStorageElement(
 134                 rElementName, css::embed::ElementModes::READ );
 135     }
 136     catch( NoSuchElementException& )
 137     {
 138         bMissing = true;
 139     }
 140     catch (Exception const&)
 141     {
 142         TOOLS_INFO_EXCEPTION("oox.storage", "openStorageElement");
 143     }
 144
 145     if( bMissing && bCreateMissing ) try
 146     {
 147         xSubXStorage = mxStorage->openStorageElement(
 148             rElementName, css::embed::ElementModes::READWRITE );
 149     }
 150     catch (Exception const&)
 151     {
 152         TOOLS_INFO_EXCEPTION("oox.storage", "openStorageElement");
 153     }
 154
 155     StorageRef xSubStorage;
 156     if( xSubXStorage.is() )
 157         xSubStorage.reset( new ZipStorage( *this, xSubXStorage, rElementName ) );
 158     return xSubStorage;
 159 }
 160
 161 Reference< XInputStream > ZipStorage::implOpenInputStream( const OUString& rElementName )
 162 {
 163     Reference< XInputStream > xInStream;
 164     if( mxStorage.is() ) try
 165     {
 166         xInStream.set( mxStorage->openStreamElement( rElementName, css::embed::ElementModes::READ ), UNO_QUERY );
 167     }
 168     catch (Exception const&)
 169     {
 170         TOOLS_INFO_EXCEPTION("oox.storage", "openStreamElement");
 171     }
 172     return xInStream;
 173 }
 174
 175 Reference< XOutputStream > ZipStorage::implOpenOutputStream( const OUString& rElementName )
 176 {
 177     Reference< XOutputStream > xOutStream;
 178     if( mxStorage.is() ) try
 179     {
 180         xOutStream.set( mxStorage->openStreamElement( rElementName, css::embed::ElementModes::READWRITE ), UNO_QUERY );
 181     }
 182     catch (Exception const&)
 183     {
 184         TOOLS_INFO_EXCEPTION("oox.storage", "openStreamElement");
 185     }
 186     return xOutStream;
 187 }
 188
 189 void ZipStorage::implCommit() const
 190 {
 191     try
 192     {
 193         Reference< XTransactedObject >( mxStorage, UNO_QUERY_THROW )->commit();
 194     }
 195     catch (Exception const&)
 196     {
 197         TOOLS_WARN_EXCEPTION("oox.storage", "commit");
 198     }
 199 }
 200
 201 } // namespace oox
 202
 203 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */