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
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
/**************************************************************************
TODO
**************************************************************************
- remove root storage access workaround
*************************************************************************/
#define ROOTSTORAGE_ACCESS_WORKAROUND 1
#include <memory>
#include "com/sun/star/beans/XPropertySet.hpp"
#include "com/sun/star/embed/ElementModes.hpp"
#include "com/sun/star/lang/XSingleServiceFactory.hpp"
#include "tdoc_uri.hxx"
#include "tdoc_docmgr.hxx"
#include "tdoc_stgelems.hxx"
#include "tdoc_storage.hxx"
using namespace com::sun::star;
using namespace tdoc_ucp;
//=========================================================================
//=========================================================================
//
// StorageElementFactory Implementation.
//
//=========================================================================
//=========================================================================
StorageElementFactory::StorageElementFactory(
const uno::Reference< lang::XMultiServiceFactory > & xSMgr,
const rtl::Reference< OfficeDocumentsManager > & xDocsMgr )
: m_xDocsMgr( xDocsMgr ),
m_xSMgr( xSMgr )
{
}
//=========================================================================
StorageElementFactory::~StorageElementFactory()
{
OSL_ENSURE( m_aMap.size() == 0,
"StorageElementFactory::~StorageElementFactory - Dangling storages!" );
}
//=========================================================================
uno::Reference< embed::XStorage >
StorageElementFactory::createTemporaryStorage()
throw ( uno::Exception,
uno::RuntimeException )
{
uno::Reference< embed::XStorage > xStorage;
uno::Reference< lang::XSingleServiceFactory > xStorageFac;
if ( m_xSMgr.is() )
{
xStorageFac = uno::Reference< lang::XSingleServiceFactory >(
m_xSMgr->createInstance(
rtl::OUString( RTL_CONSTASCII_USTRINGPARAM(
"com.sun.star.embed.StorageFactory" ) ) ),
uno::UNO_QUERY );
}
OSL_ENSURE( xStorageFac.is(), "Can't create storage factory!" );
if ( xStorageFac.is() )
xStorage = uno::Reference< embed::XStorage >(
xStorageFac->createInstance(),
uno::UNO_QUERY );
if ( !xStorage.is() )
throw uno::RuntimeException();
return xStorage;
}
//=========================================================================
uno::Reference< embed::XStorage >
StorageElementFactory::createStorage( const rtl::OUString & rUri,
StorageAccessMode eMode )
throw ( embed::InvalidStorageException,
lang::IllegalArgumentException,
io::IOException,
embed::StorageWrappedTargetException,
uno::RuntimeException )
{
osl::MutexGuard aGuard( m_aMutex );
if ( ( eMode != READ ) &&
( eMode != READ_WRITE_NOCREATE ) &&
( eMode != READ_WRITE_CREATE ) )
throw lang::IllegalArgumentException(
rtl::OUString( RTL_CONSTASCII_USTRINGPARAM(
"Invalid open mode!" ) ),
uno::Reference< uno::XInterface >(),
sal_Int16( 2 ) );
Uri aUri( rUri );
if ( aUri.isRoot() )
{
throw lang::IllegalArgumentException(
rtl::OUString( RTL_CONSTASCII_USTRINGPARAM(
"Root never has a storage!" ) ),
uno::Reference< uno::XInterface >(),
sal_Int16( 1 ) );
}
rtl::OUString aUriKey
( ( rUri.getStr()[ rUri.getLength() - 1 ] == sal_Unicode( '/' ) )
? rUri.copy( 0, rUri.getLength() - 1 )
: rUri );
StorageMap::iterator aIt ( m_aMap.begin() );
StorageMap::iterator aEnd( m_aMap.end() );
while ( aIt != aEnd )
{
if ( (*aIt).first.first == aUriKey )
{
// URI matches. Now, check open mode.
bool bMatch = true;
switch ( eMode )
{
case READ:
// No need to check; storage is at least readable.
bMatch = true;
break;
case READ_WRITE_NOCREATE:
case READ_WRITE_CREATE:
// If found storage is writable, it can be used.
// If not, a new one must be created.
bMatch = (*aIt).first.second;
break;
}
if ( bMatch )
break;
}
++aIt;
}
if ( aIt == aEnd )
{
uno::Reference< embed::XStorage > xParentStorage;
// documents never have a parent storage.
if ( !aUri.isDocument() )
{
xParentStorage = queryParentStorage( aUriKey, eMode );
if ( !xParentStorage.is() )
{
// requested to create new storage, but failed?
OSL_ENSURE( eMode != READ_WRITE_CREATE,
"Unable to create parent storage!" );
return xParentStorage;
}
}
uno::Reference< embed::XStorage > xStorage
= queryStorage( xParentStorage, aUriKey, eMode );
if ( !xStorage.is() )
{
// requested to create new storage, but failed?
OSL_ENSURE( eMode != READ_WRITE_CREATE,
"Unable to create storage!" );
return xStorage;
}
bool bWritable = ( ( eMode == READ_WRITE_NOCREATE )
|| ( eMode == READ_WRITE_CREATE ) );
std::auto_ptr< Storage > xElement(
new Storage( m_xSMgr, this, aUriKey, xParentStorage, xStorage ) );
aIt = m_aMap.insert(
StorageMap::value_type(
std::pair< rtl::OUString, bool >( aUriKey, bWritable ),
xElement.get() ) ).first;
aIt->second->m_aContainerIt = aIt;
xElement.release();
return aIt->second;
}
else if ( osl_incrementInterlockedCount( &aIt->second->m_refCount ) > 1 )
{
rtl::Reference< Storage > xElement( aIt->second );
osl_decrementInterlockedCount( &aIt->second->m_refCount );
return aIt->second;
}
else
{
osl_decrementInterlockedCount( &aIt->second->m_refCount );
aIt->second->m_aContainerIt = m_aMap.end();
uno::Reference< embed::XStorage > xParentStorage;
// documents never have a parent storage.
if ( !aUri.isDocument() )
{
xParentStorage = queryParentStorage( aUriKey, eMode );
if ( !xParentStorage.is() )
{
// requested to create new storage, but failed?
OSL_ENSURE( eMode != READ_WRITE_CREATE,
"Unable to create parent storage!" );
return xParentStorage;
}
}
uno::Reference< embed::XStorage > xStorage
= queryStorage( xParentStorage, aUriKey, eMode );
if ( !xStorage.is() )
{
// requested to create new storage, but failed?
OSL_ENSURE( eMode != READ_WRITE_CREATE,
"Unable to create storage!" );
return xStorage;
}
aIt->second
= new Storage( m_xSMgr, this, aUriKey, xParentStorage, xStorage );
aIt->second->m_aContainerIt = aIt;
return aIt->second;
}
}
//=========================================================================
uno::Reference< io::XInputStream >
StorageElementFactory::createInputStream( const rtl::OUString & rUri,
const rtl::OUString & rPassword )
throw ( embed::InvalidStorageException,
lang::IllegalArgumentException,
io::IOException,
embed::StorageWrappedTargetException,
packages::WrongPasswordException,
uno::RuntimeException )
{
osl::MutexGuard aGuard( m_aMutex );
uno::Reference< embed::XStorage > xParentStorage
= queryParentStorage( rUri, READ );
// Each stream must have a parent storage.
if ( !xParentStorage.is() )
return uno::Reference< io::XInputStream >();
uno::Reference< io::XStream > xStream
= queryStream( xParentStorage, rUri, rPassword, READ, false );
if ( !xStream.is() )
return uno::Reference< io::XInputStream >();
return xStream->getInputStream();
}
//=========================================================================
uno::Reference< io::XOutputStream >
StorageElementFactory::createOutputStream( const rtl::OUString & rUri,
const rtl::OUString & rPassword,
bool bTruncate )
throw ( embed::InvalidStorageException,
lang::IllegalArgumentException,
io::IOException,
embed::StorageWrappedTargetException,
packages::WrongPasswordException,
uno::RuntimeException )
{
osl::MutexGuard aGuard( m_aMutex );
uno::Reference< embed::XStorage > xParentStorage
= queryParentStorage( rUri, READ_WRITE_CREATE );
// Each stream must have a parent storage.
if ( !xParentStorage.is() )
{
OSL_FAIL( "StorageElementFactory::createOutputStream - "
"Unable to create parent storage!" );
return uno::Reference< io::XOutputStream >();
}
uno::Reference< io::XStream > xStream
= queryStream(
xParentStorage, rUri, rPassword, READ_WRITE_CREATE, bTruncate );
if ( !xStream.is() )
{
OSL_FAIL( "StorageElementFactory::createOutputStream - "
"Unable to create stream!" );
return uno::Reference< io::XOutputStream >();
}
// Note: We need a wrapper to hold a reference to the parent storage to
// ensure that nobody else owns it at the moment we want to commit
// our changes. (There can be only one writable instance at a time
// and even no writable instance if there is already another
// read-only instance!)
return uno::Reference< io::XOutputStream >(
new OutputStream(
m_xSMgr, rUri, xParentStorage, xStream->getOutputStream() ) );
}
//=========================================================================
uno::Reference< io::XStream >
StorageElementFactory::createStream( const rtl::OUString & rUri,
const rtl::OUString & rPassword,
bool bTruncate )
throw ( embed::InvalidStorageException,
lang::IllegalArgumentException,
io::IOException,
embed::StorageWrappedTargetException,
packages::WrongPasswordException,
uno::RuntimeException )
{
osl::MutexGuard aGuard( m_aMutex );
uno::Reference< embed::XStorage > xParentStorage
= queryParentStorage( rUri, READ_WRITE_CREATE );
// Each stream must have a parent storage.
if ( !xParentStorage.is() )
{
OSL_FAIL( "StorageElementFactory::createStream - "
"Unable to create parent storage!" );
return uno::Reference< io::XStream >();
}
uno::Reference< io::XStream > xStream
= queryStream(
xParentStorage, rUri, rPassword, READ_WRITE_NOCREATE, bTruncate );
if ( !xStream.is() )
{
OSL_FAIL( "StorageElementFactory::createStream - "
"Unable to create stream!" );
return uno::Reference< io::XStream >();
}
return uno::Reference< io::XStream >(
new Stream( m_xSMgr, rUri, xParentStorage, xStream ) );
}
//=========================================================================
void StorageElementFactory::releaseElement( Storage * pElement ) SAL_THROW( () )
{
OSL_ASSERT( pElement );
osl::MutexGuard aGuard( m_aMutex );
if ( pElement->m_aContainerIt != m_aMap.end() )
m_aMap.erase( pElement->m_aContainerIt );
}
//=========================================================================
//
// Non-UNO interface
//
//=========================================================================
uno::Reference< embed::XStorage > StorageElementFactory::queryParentStorage(
const rtl::OUString & rUri, StorageAccessMode eMode )
throw ( embed::InvalidStorageException,
lang::IllegalArgumentException,
io::IOException,
embed::StorageWrappedTargetException,
uno::RuntimeException )
{
uno::Reference< embed::XStorage > xParentStorage;
Uri aUri( rUri );
Uri aParentUri( aUri.getParentUri() );
if ( !aParentUri.isRoot() )
{
xParentStorage = createStorage( aUri.getParentUri(), eMode );
OSL_ENSURE( xParentStorage.is()
// requested to create new storage, but failed?
|| ( eMode != READ_WRITE_CREATE ),
"StorageElementFactory::queryParentStorage - No storage!" );
}
return xParentStorage;
}
//=========================================================================
uno::Reference< embed::XStorage > StorageElementFactory::queryStorage(
const uno::Reference< embed::XStorage > & xParentStorage,
const rtl::OUString & rUri,
StorageAccessMode eMode )
throw ( embed::InvalidStorageException,
lang::IllegalArgumentException,
io::IOException,
embed::StorageWrappedTargetException,
uno::RuntimeException )
{
uno::Reference< embed::XStorage > xStorage;
Uri aUri( rUri );
if ( !xParentStorage.is() )
{
// document storage
xStorage = m_xDocsMgr->queryStorage( aUri.getDocumentId() );
if ( !xStorage.is() )
{
if ( eMode == READ_WRITE_CREATE )
throw lang::IllegalArgumentException(
rtl::OUString( RTL_CONSTASCII_USTRINGPARAM(
"Invalid open mode: document storages cannot be "
"created!" ) ),
uno::Reference< uno::XInterface >(),
sal_Int16( 2 ) );
else
throw embed::InvalidStorageException(
rtl::OUString( RTL_CONSTASCII_USTRINGPARAM(
"Invalid document id!" ) ),
uno::Reference< uno::XInterface >() );
}
// match xStorage's open mode against requested open mode
uno::Reference< beans::XPropertySet > xPropSet(
xStorage, uno::UNO_QUERY );
OSL_ENSURE( xPropSet.is(),
"StorageElementFactory::queryStorage - "
"No XPropertySet interface!" );
try
{
uno::Any aPropValue = xPropSet->getPropertyValue(
rtl::OUString(
RTL_CONSTASCII_USTRINGPARAM( "OpenMode" ) ) );
sal_Int32 nOpenMode = 0;
if ( aPropValue >>= nOpenMode )
{
switch ( eMode )
{
case READ:
if ( !( nOpenMode & embed::ElementModes::READ ) )
{
// document opened, but not readable.
throw embed::InvalidStorageException(
rtl::OUString( RTL_CONSTASCII_USTRINGPARAM(
"Storage is open, but not readable!" ) ),
uno::Reference< uno::XInterface >() );
}
// storage okay
break;
case READ_WRITE_NOCREATE:
case READ_WRITE_CREATE:
if ( !( nOpenMode & embed::ElementModes::WRITE ) )
{
// document opened, but not writable.
throw embed::InvalidStorageException(
rtl::OUString( RTL_CONSTASCII_USTRINGPARAM(
"Storage is open, but not writable!" ) ),
uno::Reference< uno::XInterface >() );
}
// storage okay
break;
}
}
else
{
OSL_FAIL(
"Bug! Value of property OpenMode has wrong type!" );
throw uno::RuntimeException(
rtl::OUString( RTL_CONSTASCII_USTRINGPARAM(
"Bug! Value of property OpenMode has wrong type!" ) ),
uno::Reference< uno::XInterface >() );
}
}
catch ( beans::UnknownPropertyException const & e )
{
OSL_FAIL( "Property OpenMode not supported!" );
throw embed::StorageWrappedTargetException(
rtl::OUString( RTL_CONSTASCII_USTRINGPARAM(
"Bug! Value of property OpenMode has wrong type!" ) ),
uno::Reference< uno::XInterface >(),
uno::makeAny( e ) );
}
catch ( lang::WrappedTargetException const & e )
{
OSL_FAIL( "Caught WrappedTargetException!" );
throw embed::StorageWrappedTargetException(
rtl::OUString( RTL_CONSTASCII_USTRINGPARAM(
"WrappedTargetException during getPropertyValue!" ) ),
uno::Reference< uno::XInterface >(),
uno::makeAny( e ) );
}
}
else
{
// sub storage
const rtl::OUString & rName = aUri.getDecodedName();
if ( eMode == READ )
{
try
{
sal_Int32 nOpenMode = embed::ElementModes::READ
| embed::ElementModes::NOCREATE;
xStorage
= xParentStorage->openStorageElement( rName, nOpenMode );
}
catch ( io::IOException const & )
{
// Another chance: Try to clone storage.
xStorage = createTemporaryStorage();
xParentStorage->copyStorageElementLastCommitTo( rName,
xStorage );
}
}
else
{
sal_Int32 nOpenMode = embed::ElementModes::READWRITE;
if ( eMode == READ_WRITE_NOCREATE )
nOpenMode |= embed::ElementModes::NOCREATE;
xStorage = xParentStorage->openStorageElement( rName, nOpenMode );
}
}
OSL_ENSURE( xStorage.is() || ( eMode != READ_WRITE_CREATE ),
"StorageElementFactory::queryStorage - No storage!" );
return xStorage;
}
//=========================================================================
uno::Reference< io::XStream >
StorageElementFactory::queryStream(
const uno::Reference< embed::XStorage > & xParentStorage,
const rtl::OUString & rUri,
const rtl::OUString & rPassword,
StorageAccessMode eMode,
bool bTruncate )
throw ( embed::InvalidStorageException,
lang::IllegalArgumentException,
io::IOException,
embed::StorageWrappedTargetException,
packages::WrongPasswordException,
uno::RuntimeException )
{
osl::MutexGuard aGuard( m_aMutex );
if ( !xParentStorage.is() )
{
throw lang::IllegalArgumentException(
rtl::OUString( RTL_CONSTASCII_USTRINGPARAM(
"No parent storage!" ) ),
uno::Reference< uno::XInterface >(),
sal_Int16( 2 ) );
}
Uri aUri( rUri );
if ( aUri.isRoot() )
{
throw lang::IllegalArgumentException(
rtl::OUString( RTL_CONSTASCII_USTRINGPARAM(
"Root never is a stream!" ) ),
uno::Reference< uno::XInterface >(),
sal_Int16( 2 ) );
}
else if ( aUri.isDocument() )
{
throw lang::IllegalArgumentException(
rtl::OUString( RTL_CONSTASCII_USTRINGPARAM(
"A document never is a stream!" ) ),
uno::Reference< uno::XInterface >(),
sal_Int16( 2 ) );
}
sal_Int32 nOpenMode;
switch ( eMode )
{
case READ:
nOpenMode = embed::ElementModes::READ
| embed::ElementModes::NOCREATE
| embed::ElementModes::SEEKABLE;
break;
case READ_WRITE_NOCREATE:
nOpenMode = embed::ElementModes::READWRITE
| embed::ElementModes::NOCREATE
| embed::ElementModes::SEEKABLE;
if ( bTruncate )
nOpenMode |= embed::ElementModes::TRUNCATE;
break;
case READ_WRITE_CREATE:
nOpenMode = embed::ElementModes::READWRITE
| embed::ElementModes::SEEKABLE;
if ( bTruncate )
nOpenMode |= embed::ElementModes::TRUNCATE;
break;
default:
OSL_FAIL( "StorageElementFactory::queryStream : Unknown open mode!" );
throw embed::InvalidStorageException(
rtl::OUString( RTL_CONSTASCII_USTRINGPARAM(
"Unknown open mode!" ) ),
uno::Reference< uno::XInterface >() );
}
// No object re-usage mechanism; streams are seekable => not stateless.
uno::Reference< io::XStream > xStream;
if ( rPassword.getLength() > 0 )
{
if ( eMode == READ )
{
try
{
xStream = xParentStorage->cloneEncryptedStreamElement(
aUri.getDecodedName(),
rPassword );
}
catch ( packages::NoEncryptionException const & )
{
xStream
= xParentStorage->cloneStreamElement( aUri.getDecodedName() );
}
}
else
{
try
{
xStream = xParentStorage->openEncryptedStreamElement(
aUri.getDecodedName(),
nOpenMode,
rPassword );
}
catch ( packages::NoEncryptionException const & )
{
xStream
= xParentStorage->openStreamElement( aUri.getDecodedName(),
nOpenMode );
}
}
}
else
{
if ( eMode == READ )
{
xStream = xParentStorage->cloneStreamElement( aUri.getDecodedName() );
}
else
{
xStream = xParentStorage->openStreamElement( aUri.getDecodedName(),
nOpenMode );
}
}
if ( !xStream.is() )
{
throw embed::InvalidStorageException(
rtl::OUString( RTL_CONSTASCII_USTRINGPARAM(
"No stream!" ) ),
uno::Reference< uno::XInterface >() );
}
return xStream;
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
