1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
|
/* -*- 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 "oox/ole/olestorage.hxx"
#include <com/sun/star/beans/PropertyValue.hpp>
#include <com/sun/star/container/XNameContainer.hpp>
#include <com/sun/star/embed/XTransactedObject.hpp>
#include <com/sun/star/io/TempFile.hpp>
#include <com/sun/star/io/XInputStream.hpp>
#include <com/sun/star/io/XOutputStream.hpp>
#include <com/sun/star/io/XSeekable.hpp>
#include <com/sun/star/io/XStream.hpp>
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
#include <com/sun/star/uno/XComponentContext.hpp>
#include <cppuhelper/implbase2.hxx>
#include "oox/helper/binaryinputstream.hxx"
#include "oox/helper/binaryoutputstream.hxx"
#include "oox/helper/containerhelper.hxx"
#include "oox/helper/helper.hxx"
namespace oox {
namespace ole {
// ============================================================================
using namespace ::com::sun::star::beans;
using namespace ::com::sun::star::container;
using namespace ::com::sun::star::embed;
using namespace ::com::sun::star::io;
using namespace ::com::sun::star::lang;
using namespace ::com::sun::star::uno;
// ============================================================================
namespace {
typedef ::cppu::WeakImplHelper2< XSeekable, XOutputStream > OleOutputStreamBase;
/** Implementation of an OLE storage output stream that inserts itself into the
storage when it is closed.
*/
class OleOutputStream : public OleOutputStreamBase
{
public:
explicit OleOutputStream(
const Reference< XComponentContext >& rxContext,
const Reference< XNameContainer >& rxStorage,
const OUString& rElementName );
virtual ~OleOutputStream();
virtual void SAL_CALL seek( sal_Int64 nPos ) throw( IllegalArgumentException, IOException, RuntimeException );
virtual sal_Int64 SAL_CALL getPosition() throw( IOException, RuntimeException );
virtual sal_Int64 SAL_CALL getLength() throw( IOException, RuntimeException );
virtual void SAL_CALL writeBytes( const Sequence< sal_Int8 >& rData ) throw( NotConnectedException, BufferSizeExceededException, IOException, RuntimeException );
virtual void SAL_CALL flush() throw( NotConnectedException, BufferSizeExceededException, IOException, RuntimeException );
virtual void SAL_CALL closeOutput() throw( NotConnectedException, BufferSizeExceededException, IOException, RuntimeException );
private:
void ensureSeekable() const throw( IOException );
void ensureConnected() const throw( NotConnectedException );
private:
Reference< XNameContainer > mxStorage;
Reference< XStream > mxTempFile;
Reference< XOutputStream > mxOutStrm;
Reference< XSeekable > mxSeekable;
OUString maElementName;
};
// ----------------------------------------------------------------------------
OleOutputStream::OleOutputStream( const Reference< XComponentContext >& rxContext,
const Reference< XNameContainer >& rxStorage, const OUString& rElementName ) :
mxStorage( rxStorage ),
maElementName( rElementName )
{
try
{
mxTempFile.set( TempFile::create(rxContext), UNO_QUERY_THROW );
mxOutStrm = mxTempFile->getOutputStream();
mxSeekable.set( mxOutStrm, UNO_QUERY );
}
catch(const Exception& )
{
}
}
OleOutputStream::~OleOutputStream()
{
}
void SAL_CALL OleOutputStream::seek( sal_Int64 nPos ) throw( IllegalArgumentException, IOException, RuntimeException )
{
ensureSeekable();
mxSeekable->seek( nPos );
}
sal_Int64 SAL_CALL OleOutputStream::getPosition() throw( IOException, RuntimeException )
{
ensureSeekable();
return mxSeekable->getPosition();
}
sal_Int64 SAL_CALL OleOutputStream::getLength() throw( IOException, RuntimeException )
{
ensureSeekable();
return mxSeekable->getLength();
}
void SAL_CALL OleOutputStream::writeBytes( const Sequence< sal_Int8 >& rData ) throw( NotConnectedException, BufferSizeExceededException, IOException, RuntimeException )
{
ensureConnected();
mxOutStrm->writeBytes( rData );
}
void SAL_CALL OleOutputStream::flush() throw( NotConnectedException, BufferSizeExceededException, IOException, RuntimeException )
{
ensureConnected();
mxOutStrm->flush();
}
void SAL_CALL OleOutputStream::closeOutput() throw( NotConnectedException, BufferSizeExceededException, IOException, RuntimeException )
{
ensureConnected();
ensureSeekable();
// remember the class members
Reference< XOutputStream > xOutStrm = mxOutStrm;
Reference< XSeekable > xSeekable = mxSeekable;
// reset all class members
mxOutStrm.clear();
mxSeekable.clear();
// close stream (and let it throw something if needed)
xOutStrm->closeOutput();
// on success, insert the stream into the OLE storage (must be seeked back before)
xSeekable->seek( 0 );
if( !ContainerHelper::insertByName( mxStorage, maElementName, Any( mxTempFile ) ) )
throw IOException();
}
void OleOutputStream::ensureSeekable() const throw( IOException )
{
if( !mxSeekable.is() )
throw IOException();
}
void OleOutputStream::ensureConnected() const throw( NotConnectedException )
{
if( !mxOutStrm.is() )
throw NotConnectedException();
}
} // namespace
// ============================================================================
OleStorage::OleStorage( const Reference< XComponentContext >& rxContext,
const Reference< XInputStream >& rxInStream, bool bBaseStreamAccess ) :
StorageBase( rxInStream, bBaseStreamAccess ),
mxContext( rxContext ),
mpParentStorage( 0 )
{
OSL_ENSURE( mxContext.is(), "OleStorage::OleStorage - missing component context" );
initStorage( rxInStream );
}
OleStorage::OleStorage( const Reference< XComponentContext >& rxContext,
const Reference< XStream >& rxOutStream, bool bBaseStreamAccess ) :
StorageBase( rxOutStream, bBaseStreamAccess ),
mxContext( rxContext ),
mpParentStorage( 0 )
{
OSL_ENSURE( mxContext.is(), "OleStorage::OleStorage - missing component context" );
initStorage( rxOutStream );
}
OleStorage::OleStorage( const OleStorage& rParentStorage,
const Reference< XNameContainer >& rxStorage, const OUString& rElementName, bool bReadOnly ) :
StorageBase( rParentStorage, rElementName, bReadOnly ),
mxContext( rParentStorage.mxContext ),
mxStorage( rxStorage ),
mpParentStorage( &rParentStorage )
{
OSL_ENSURE( mxStorage.is(), "OleStorage::OleStorage - missing substorage elements" );
}
OleStorage::OleStorage( const OleStorage& rParentStorage,
const Reference< XStream >& rxOutStream, const OUString& rElementName ) :
StorageBase( rParentStorage, rElementName, false ),
mxContext( rParentStorage.mxContext ),
mpParentStorage( &rParentStorage )
{
initStorage( rxOutStream );
}
OleStorage::~OleStorage()
{
}
// ----------------------------------------------------------------------------
void OleStorage::initStorage( const Reference< XInputStream >& rxInStream )
{
// if stream is not seekable, create temporary copy
Reference< XInputStream > xInStrm = rxInStream;
if( !Reference< XSeekable >( xInStrm, UNO_QUERY ).is() ) try
{
Reference< XStream > xTempFile( TempFile::create(mxContext), UNO_QUERY_THROW );
{
Reference< XOutputStream > xOutStrm( xTempFile->getOutputStream(), UNO_SET_THROW );
/* Pass false to both binary stream objects to keep the UNO
streams alive. Life time of these streams is controlled by the
tempfile implementation. */
BinaryXOutputStream aOutStrm( xOutStrm, false );
BinaryXInputStream aInStrm( xInStrm, false );
aInStrm.copyToStream( aOutStrm );
} // scope closes output stream of tempfile
xInStrm = xTempFile->getInputStream();
}
catch(const Exception& )
{
OSL_FAIL( "OleStorage::initStorage - cannot create temporary copy of input stream" );
}
// create base storage object
if( xInStrm.is() ) try
{
Reference< XMultiServiceFactory > xFactory( mxContext->getServiceManager(), UNO_QUERY_THROW );
Sequence< Any > aArgs( 2 );
aArgs[ 0 ] <<= xInStrm;
aArgs[ 1 ] <<= true; // true = do not create a copy of the input stream
mxStorage.set( xFactory->createInstanceWithArguments(
CREATE_OUSTRING( "com.sun.star.embed.OLESimpleStorage" ), aArgs ), UNO_QUERY_THROW );
}
catch(const Exception& )
{
}
}
void OleStorage::initStorage( const Reference< XStream >& rxOutStream )
{
// create base storage object
if( rxOutStream.is() ) try
{
Reference< XMultiServiceFactory > xFactory( mxContext->getServiceManager(), UNO_QUERY_THROW );
Sequence< Any > aArgs( 2 );
aArgs[ 0 ] <<= rxOutStream;
aArgs[ 1 ] <<= true; // true = do not create a copy of the stream
mxStorage.set( xFactory->createInstanceWithArguments(
CREATE_OUSTRING( "com.sun.star.embed.OLESimpleStorage" ), aArgs ), UNO_QUERY_THROW );
}
catch(const Exception& )
{
}
}
// StorageBase interface ------------------------------------------------------
bool OleStorage::implIsStorage() const
{
if( mxStorage.is() ) try
{
/* If this is not an OLE storage, hasElements() of the OLESimpleStorage
implementation throws an exception. But we do not return the result
of hasElements(), because an empty storage is a valid storage too. */
mxStorage->hasElements();
return true;
}
catch(const Exception& )
{
}
return false;
}
Reference< XStorage > OleStorage::implGetXStorage() const
{
OSL_FAIL( "OleStorage::getXStorage - not implemented" );
return Reference< XStorage >();
}
void OleStorage::implGetElementNames( ::std::vector< OUString >& orElementNames ) const
{
Sequence< OUString > aNames;
if( mxStorage.is() ) try
{
aNames = mxStorage->getElementNames();
if( aNames.getLength() > 0 )
orElementNames.insert( orElementNames.end(), aNames.getConstArray(), aNames.getConstArray() + aNames.getLength() );
}
catch(const Exception& )
{
}
}
StorageRef OleStorage::implOpenSubStorage( const OUString& rElementName, bool bCreateMissing )
{
StorageRef xSubStorage;
if( mxStorage.is() && !rElementName.isEmpty() )
{
try
{
Reference< XNameContainer > xSubElements( mxStorage->getByName( rElementName ), UNO_QUERY_THROW );
xSubStorage.reset( new OleStorage( *this, xSubElements, rElementName, true ) );
}
catch(const Exception& )
{
}
/* The OLESimpleStorage API implementation seems to be buggy in the
area of writable inplace substorage (sometimes it overwrites other
unrelated streams with zero bytes). We go the save way and create a
new OLE storage based on a temporary file. All operations are
performed on this clean storage. On committing, the storage will be
completely re-inserted into the parent storage. */
if( !isReadOnly() && (bCreateMissing || xSubStorage.get()) ) try
{
// create new storage based on a temp file
Reference< XStream > xTempFile( TempFile::create(mxContext), UNO_QUERY_THROW );
StorageRef xTempStorage( new OleStorage( *this, xTempFile, rElementName ) );
// copy existing substorage into temp storage
if( xSubStorage.get() )
xSubStorage->copyStorageToStorage( *xTempStorage );
// return the temp storage to caller
xSubStorage = xTempStorage;
}
catch(const Exception& )
{
}
}
return xSubStorage;
}
Reference< XInputStream > OleStorage::implOpenInputStream( const OUString& rElementName )
{
Reference< XInputStream > xInStream;
if( mxStorage.is() ) try
{
xInStream.set( mxStorage->getByName( rElementName ), UNO_QUERY );
}
catch(const Exception& )
{
}
return xInStream;
}
Reference< XOutputStream > OleStorage::implOpenOutputStream( const OUString& rElementName )
{
Reference< XOutputStream > xOutStream;
if( mxStorage.is() && !rElementName.isEmpty() )
xOutStream.set( new OleOutputStream( mxContext, mxStorage, rElementName ) );
return xOutStream;
}
void OleStorage::implCommit() const
{
try
{
// commit this storage (finalizes the file this storage is based on)
Reference< XTransactedObject >( mxStorage, UNO_QUERY_THROW )->commit();
// re-insert this storage into the parent storage
if( mpParentStorage )
{
if( mpParentStorage->mxStorage->hasByName( getName() ) )
{
// replaceByName() does not work (#i109539#)
mpParentStorage->mxStorage->removeByName( getName() );
Reference< XTransactedObject >( mpParentStorage->mxStorage, UNO_QUERY_THROW )->commit();
}
mpParentStorage->mxStorage->insertByName( getName(), Any( mxStorage ) );
// this requires another commit(), which will be performed by the parent storage
}
}
catch(const Exception& )
{
}
}
// ============================================================================
} // namespace ole
} // namespace oox
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|