LibreOffice Module oox (master) 1
zipstorage.cxx
Go to the documentation of this file.
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
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/uno/XComponentContext.hpp>
28#include <osl/diagnose.h>
29#include <sal/log.hxx>
30#include <tools/diagnose_ex.h>
32
33namespace oox {
34
35using namespace ::com::sun::star::container;
36using namespace ::com::sun::star::embed;
37using namespace ::com::sun::star::io;
38using namespace ::com::sun::star::lang;
39using namespace ::com::sun::star::uno;
40
41ZipStorage::ZipStorage( const Reference< XComponentContext >& rxContext, const Reference< XInputStream >& rxInStream ) :
42 StorageBase( rxInStream, false )
43{
44 OSL_ENSURE( rxContext.is(), "ZipStorage::ZipStorage - missing component context" );
45 // create base storage object
46 if( !rxContext.is() )
47 return;
48
49 try
50 {
51 /* #i105325# ::comphelper::OStorageHelper::GetStorageFromInputStream()
52 cannot be used here as it will open a storage with format type
53 'PackageFormat' that will not work with OOXML packages.
54
55 #161971# The MS-document storages should always be opened in repair
56 mode to ignore the format errors and get so much info as possible.
57 I hate this solution, but it seems to be the only consistent way to
58 handle the MS documents.
59
60 TODO: #i105410# switch to 'OFOPXMLFormat' and use its
61 implementation of relations handling.
62 */
64 ZIP_STORAGE_FORMAT_STRING, rxInStream, rxContext, false);
65 }
66 catch (Exception const&)
67 {
68 TOOLS_WARN_EXCEPTION("oox.storage", "ZipStorage::ZipStorage exception opening input storage");
69 }
70}
71
72ZipStorage::ZipStorage( const Reference< XComponentContext >& rxContext, const Reference< XStream >& rxStream ) :
73 StorageBase( rxStream, false )
74{
75 OSL_ENSURE( rxContext.is(), "ZipStorage::ZipStorage - missing component context" );
76 // create base storage object
77 if( rxContext.is() ) try
78 {
79 const sal_Int32 nOpenMode = ElementModes::READWRITE | ElementModes::TRUNCATE;
81 OFOPXML_STORAGE_FORMAT_STRING, rxStream, nOpenMode, rxContext, true);
82 }
83 catch (Exception const&)
84 {
85 TOOLS_WARN_EXCEPTION("oox.storage", "ZipStorage::ZipStorage exception opening output storage");
86 }
87}
88
89ZipStorage::ZipStorage( const ZipStorage& rParentStorage, const Reference< XStorage >& rxStorage, const OUString& rElementName ) :
90 StorageBase( rParentStorage, rElementName, rParentStorage.isReadOnly() ),
91 mxStorage( rxStorage )
92{
93 SAL_WARN_IF(!mxStorage.is(), "oox.storage", "ZipStorage::ZipStorage "
94 " - missing storage" );
95}
96
97ZipStorage::~ZipStorage()
98{
99}
100
101bool ZipStorage::implIsStorage() const
102{
103 return mxStorage.is();
104}
105
106Reference< XStorage > ZipStorage::implGetXStorage() const
107{
108 return mxStorage;
109}
110
111void ZipStorage::implGetElementNames( ::std::vector< OUString >& orElementNames ) const
112{
113 if( mxStorage.is() ) try
114 {
115 const Sequence<OUString> 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
125StorageRef 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
161Reference< 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
175Reference< 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
189void 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: */
static css::uno::Reference< css::embed::XStorage > GetStorageOfFormatFromInputStream(const OUString &aFormat, const css::uno::Reference< css::io::XInputStream > &xStream, const css::uno::Reference< css::uno::XComponentContext > &rxContext=css::uno::Reference< css::uno::XComponentContext >(), bool bRepairStorage=false)
static css::uno::Reference< css::embed::XStorage > GetStorageOfFormatFromStream(const OUString &aFormat, const css::uno::Reference< css::io::XStream > &xStream, sal_Int32 nStorageMode=css::embed::ElementModes::READWRITE, const css::uno::Reference< css::uno::XComponentContext > &rxContext=css::uno::Reference< css::uno::XComponentContext >(), bool bRepairStorage=false)
Implements stream access for ZIP storages containing XML streams.
Definition: zipstorage.hxx:42
ZipStorage(const css::uno::Reference< css::uno::XComponentContext > &rxContext, const css::uno::Reference< css::io::XInputStream > &rxInStream)
#define TOOLS_WARN_EXCEPTION(area, stream)
#define TOOLS_INFO_EXCEPTION(area, stream)
#define SAL_WARN_IF(condition, area, stream)
@ Exception
std::shared_ptr< StorageBase > StorageRef
Definition: storagebase.hxx:42
Reference< XNameContainer > mxStorage
Definition: olestorage.cxx:76