1*b1cdbd2cSJim Jagielski /**************************************************************
2*b1cdbd2cSJim Jagielski *
3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file
5*b1cdbd2cSJim Jagielski * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file
7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski *
11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski *
13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the
17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski * under the License.
19*b1cdbd2cSJim Jagielski *
20*b1cdbd2cSJim Jagielski *************************************************************/
21*b1cdbd2cSJim Jagielski
22*b1cdbd2cSJim Jagielski
23*b1cdbd2cSJim Jagielski
24*b1cdbd2cSJim Jagielski #include "oox/helper/storagebase.hxx"
25*b1cdbd2cSJim Jagielski
26*b1cdbd2cSJim Jagielski #include <com/sun/star/embed/XTransactedObject.hpp>
27*b1cdbd2cSJim Jagielski #include <com/sun/star/io/XStream.hpp>
28*b1cdbd2cSJim Jagielski #include <rtl/ustrbuf.hxx>
29*b1cdbd2cSJim Jagielski #include "oox/helper/binaryinputstream.hxx"
30*b1cdbd2cSJim Jagielski #include "oox/helper/binaryoutputstream.hxx"
31*b1cdbd2cSJim Jagielski
32*b1cdbd2cSJim Jagielski namespace oox {
33*b1cdbd2cSJim Jagielski
34*b1cdbd2cSJim Jagielski // ============================================================================
35*b1cdbd2cSJim Jagielski
36*b1cdbd2cSJim Jagielski using namespace ::com::sun::star::embed;
37*b1cdbd2cSJim Jagielski using namespace ::com::sun::star::io;
38*b1cdbd2cSJim Jagielski using namespace ::com::sun::star::uno;
39*b1cdbd2cSJim Jagielski
40*b1cdbd2cSJim Jagielski using ::rtl::OUString;
41*b1cdbd2cSJim Jagielski using ::rtl::OUStringBuffer;
42*b1cdbd2cSJim Jagielski
43*b1cdbd2cSJim Jagielski // ============================================================================
44*b1cdbd2cSJim Jagielski
45*b1cdbd2cSJim Jagielski namespace {
46*b1cdbd2cSJim Jagielski
lclSplitFirstElement(OUString & orElement,OUString & orRemainder,const OUString & rFullName)47*b1cdbd2cSJim Jagielski void lclSplitFirstElement( OUString& orElement, OUString& orRemainder, const OUString& rFullName )
48*b1cdbd2cSJim Jagielski {
49*b1cdbd2cSJim Jagielski sal_Int32 nSlashPos = rFullName.indexOf( '/' );
50*b1cdbd2cSJim Jagielski if( (0 <= nSlashPos) && (nSlashPos < rFullName.getLength()) )
51*b1cdbd2cSJim Jagielski {
52*b1cdbd2cSJim Jagielski orElement = rFullName.copy( 0, nSlashPos );
53*b1cdbd2cSJim Jagielski orRemainder = rFullName.copy( nSlashPos + 1 );
54*b1cdbd2cSJim Jagielski }
55*b1cdbd2cSJim Jagielski else
56*b1cdbd2cSJim Jagielski {
57*b1cdbd2cSJim Jagielski orElement = rFullName;
58*b1cdbd2cSJim Jagielski }
59*b1cdbd2cSJim Jagielski }
60*b1cdbd2cSJim Jagielski
61*b1cdbd2cSJim Jagielski } // namespace
62*b1cdbd2cSJim Jagielski
63*b1cdbd2cSJim Jagielski // ----------------------------------------------------------------------------
64*b1cdbd2cSJim Jagielski
StorageBase(const Reference<XInputStream> & rxInStream,bool bBaseStreamAccess)65*b1cdbd2cSJim Jagielski StorageBase::StorageBase( const Reference< XInputStream >& rxInStream, bool bBaseStreamAccess ) :
66*b1cdbd2cSJim Jagielski mxInStream( rxInStream ),
67*b1cdbd2cSJim Jagielski mbBaseStreamAccess( bBaseStreamAccess ),
68*b1cdbd2cSJim Jagielski mbReadOnly( true )
69*b1cdbd2cSJim Jagielski {
70*b1cdbd2cSJim Jagielski OSL_ENSURE( mxInStream.is(), "StorageBase::StorageBase - missing base input stream" );
71*b1cdbd2cSJim Jagielski }
72*b1cdbd2cSJim Jagielski
StorageBase(const Reference<XStream> & rxOutStream,bool bBaseStreamAccess)73*b1cdbd2cSJim Jagielski StorageBase::StorageBase( const Reference< XStream >& rxOutStream, bool bBaseStreamAccess ) :
74*b1cdbd2cSJim Jagielski mxOutStream( rxOutStream ),
75*b1cdbd2cSJim Jagielski mbBaseStreamAccess( bBaseStreamAccess ),
76*b1cdbd2cSJim Jagielski mbReadOnly( false )
77*b1cdbd2cSJim Jagielski {
78*b1cdbd2cSJim Jagielski OSL_ENSURE( mxOutStream.is(), "StorageBase::StorageBase - missing base output stream" );
79*b1cdbd2cSJim Jagielski }
80*b1cdbd2cSJim Jagielski
StorageBase(const StorageBase & rParentStorage,const OUString & rStorageName,bool bReadOnly)81*b1cdbd2cSJim Jagielski StorageBase::StorageBase( const StorageBase& rParentStorage, const OUString& rStorageName, bool bReadOnly ) :
82*b1cdbd2cSJim Jagielski maParentPath( rParentStorage.getPath() ),
83*b1cdbd2cSJim Jagielski maStorageName( rStorageName ),
84*b1cdbd2cSJim Jagielski mbBaseStreamAccess( false ),
85*b1cdbd2cSJim Jagielski mbReadOnly( bReadOnly )
86*b1cdbd2cSJim Jagielski {
87*b1cdbd2cSJim Jagielski }
88*b1cdbd2cSJim Jagielski
~StorageBase()89*b1cdbd2cSJim Jagielski StorageBase::~StorageBase()
90*b1cdbd2cSJim Jagielski {
91*b1cdbd2cSJim Jagielski }
92*b1cdbd2cSJim Jagielski
isStorage() const93*b1cdbd2cSJim Jagielski bool StorageBase::isStorage() const
94*b1cdbd2cSJim Jagielski {
95*b1cdbd2cSJim Jagielski return implIsStorage();
96*b1cdbd2cSJim Jagielski }
97*b1cdbd2cSJim Jagielski
isRootStorage() const98*b1cdbd2cSJim Jagielski bool StorageBase::isRootStorage() const
99*b1cdbd2cSJim Jagielski {
100*b1cdbd2cSJim Jagielski return implIsStorage() && (maStorageName.getLength() == 0);
101*b1cdbd2cSJim Jagielski }
102*b1cdbd2cSJim Jagielski
isReadOnly() const103*b1cdbd2cSJim Jagielski bool StorageBase::isReadOnly() const
104*b1cdbd2cSJim Jagielski {
105*b1cdbd2cSJim Jagielski return mbReadOnly;
106*b1cdbd2cSJim Jagielski }
107*b1cdbd2cSJim Jagielski
getXStorage() const108*b1cdbd2cSJim Jagielski Reference< XStorage > StorageBase::getXStorage() const
109*b1cdbd2cSJim Jagielski {
110*b1cdbd2cSJim Jagielski return implGetXStorage();
111*b1cdbd2cSJim Jagielski }
112*b1cdbd2cSJim Jagielski
getName() const113*b1cdbd2cSJim Jagielski const OUString& StorageBase::getName() const
114*b1cdbd2cSJim Jagielski {
115*b1cdbd2cSJim Jagielski return maStorageName;
116*b1cdbd2cSJim Jagielski }
117*b1cdbd2cSJim Jagielski
getPath() const118*b1cdbd2cSJim Jagielski OUString StorageBase::getPath() const
119*b1cdbd2cSJim Jagielski {
120*b1cdbd2cSJim Jagielski OUStringBuffer aBuffer( maParentPath );
121*b1cdbd2cSJim Jagielski if( aBuffer.getLength() > 0 )
122*b1cdbd2cSJim Jagielski aBuffer.append( sal_Unicode( '/' ) );
123*b1cdbd2cSJim Jagielski aBuffer.append( maStorageName );
124*b1cdbd2cSJim Jagielski return aBuffer.makeStringAndClear();
125*b1cdbd2cSJim Jagielski }
126*b1cdbd2cSJim Jagielski
getElementNames(::std::vector<OUString> & orElementNames) const127*b1cdbd2cSJim Jagielski void StorageBase::getElementNames( ::std::vector< OUString >& orElementNames ) const
128*b1cdbd2cSJim Jagielski {
129*b1cdbd2cSJim Jagielski orElementNames.clear();
130*b1cdbd2cSJim Jagielski implGetElementNames( orElementNames );
131*b1cdbd2cSJim Jagielski }
132*b1cdbd2cSJim Jagielski
openSubStorage(const OUString & rStorageName,bool bCreateMissing)133*b1cdbd2cSJim Jagielski StorageRef StorageBase::openSubStorage( const OUString& rStorageName, bool bCreateMissing )
134*b1cdbd2cSJim Jagielski {
135*b1cdbd2cSJim Jagielski StorageRef xSubStorage;
136*b1cdbd2cSJim Jagielski OSL_ENSURE( !bCreateMissing || !mbReadOnly, "StorageBase::openSubStorage - cannot create substorage in read-only mode" );
137*b1cdbd2cSJim Jagielski if( !bCreateMissing || !mbReadOnly )
138*b1cdbd2cSJim Jagielski {
139*b1cdbd2cSJim Jagielski OUString aElement, aRemainder;
140*b1cdbd2cSJim Jagielski lclSplitFirstElement( aElement, aRemainder, rStorageName );
141*b1cdbd2cSJim Jagielski if( aElement.getLength() > 0 )
142*b1cdbd2cSJim Jagielski xSubStorage = getSubStorage( aElement, bCreateMissing );
143*b1cdbd2cSJim Jagielski if( xSubStorage.get() && (aRemainder.getLength() > 0) )
144*b1cdbd2cSJim Jagielski xSubStorage = xSubStorage->openSubStorage( aRemainder, bCreateMissing );
145*b1cdbd2cSJim Jagielski }
146*b1cdbd2cSJim Jagielski return xSubStorage;
147*b1cdbd2cSJim Jagielski }
148*b1cdbd2cSJim Jagielski
openInputStream(const OUString & rStreamName)149*b1cdbd2cSJim Jagielski Reference< XInputStream > StorageBase::openInputStream( const OUString& rStreamName )
150*b1cdbd2cSJim Jagielski {
151*b1cdbd2cSJim Jagielski Reference< XInputStream > xInStream;
152*b1cdbd2cSJim Jagielski OUString aElement, aRemainder;
153*b1cdbd2cSJim Jagielski lclSplitFirstElement( aElement, aRemainder, rStreamName );
154*b1cdbd2cSJim Jagielski if( aElement.getLength() > 0 )
155*b1cdbd2cSJim Jagielski {
156*b1cdbd2cSJim Jagielski if( aRemainder.getLength() > 0 )
157*b1cdbd2cSJim Jagielski {
158*b1cdbd2cSJim Jagielski StorageRef xSubStorage = getSubStorage( aElement, false );
159*b1cdbd2cSJim Jagielski if( xSubStorage.get() )
160*b1cdbd2cSJim Jagielski xInStream = xSubStorage->openInputStream( aRemainder );
161*b1cdbd2cSJim Jagielski }
162*b1cdbd2cSJim Jagielski else
163*b1cdbd2cSJim Jagielski {
164*b1cdbd2cSJim Jagielski xInStream = implOpenInputStream( aElement );
165*b1cdbd2cSJim Jagielski }
166*b1cdbd2cSJim Jagielski }
167*b1cdbd2cSJim Jagielski else if( mbBaseStreamAccess )
168*b1cdbd2cSJim Jagielski {
169*b1cdbd2cSJim Jagielski xInStream = mxInStream;
170*b1cdbd2cSJim Jagielski }
171*b1cdbd2cSJim Jagielski return xInStream;
172*b1cdbd2cSJim Jagielski }
173*b1cdbd2cSJim Jagielski
openOutputStream(const OUString & rStreamName)174*b1cdbd2cSJim Jagielski Reference< XOutputStream > StorageBase::openOutputStream( const OUString& rStreamName )
175*b1cdbd2cSJim Jagielski {
176*b1cdbd2cSJim Jagielski Reference< XOutputStream > xOutStream;
177*b1cdbd2cSJim Jagielski OSL_ENSURE( !mbReadOnly, "StorageBase::openOutputStream - cannot create output stream in read-only mode" );
178*b1cdbd2cSJim Jagielski if( !mbReadOnly )
179*b1cdbd2cSJim Jagielski {
180*b1cdbd2cSJim Jagielski OUString aElement, aRemainder;
181*b1cdbd2cSJim Jagielski lclSplitFirstElement( aElement, aRemainder, rStreamName );
182*b1cdbd2cSJim Jagielski if( aElement.getLength() > 0 )
183*b1cdbd2cSJim Jagielski {
184*b1cdbd2cSJim Jagielski if( aRemainder.getLength() > 0 )
185*b1cdbd2cSJim Jagielski {
186*b1cdbd2cSJim Jagielski StorageRef xSubStorage = getSubStorage( aElement, true );
187*b1cdbd2cSJim Jagielski if( xSubStorage.get() )
188*b1cdbd2cSJim Jagielski xOutStream = xSubStorage->openOutputStream( aRemainder );
189*b1cdbd2cSJim Jagielski }
190*b1cdbd2cSJim Jagielski else
191*b1cdbd2cSJim Jagielski {
192*b1cdbd2cSJim Jagielski xOutStream = implOpenOutputStream( aElement );
193*b1cdbd2cSJim Jagielski }
194*b1cdbd2cSJim Jagielski }
195*b1cdbd2cSJim Jagielski else if( mbBaseStreamAccess )
196*b1cdbd2cSJim Jagielski {
197*b1cdbd2cSJim Jagielski xOutStream = mxOutStream->getOutputStream();
198*b1cdbd2cSJim Jagielski }
199*b1cdbd2cSJim Jagielski }
200*b1cdbd2cSJim Jagielski return xOutStream;
201*b1cdbd2cSJim Jagielski }
202*b1cdbd2cSJim Jagielski
copyToStorage(StorageBase & rDestStrg,const OUString & rElementName)203*b1cdbd2cSJim Jagielski void StorageBase::copyToStorage( StorageBase& rDestStrg, const OUString& rElementName )
204*b1cdbd2cSJim Jagielski {
205*b1cdbd2cSJim Jagielski OSL_ENSURE( rDestStrg.isStorage() && !rDestStrg.isReadOnly(), "StorageBase::copyToStorage - invalid destination" );
206*b1cdbd2cSJim Jagielski OSL_ENSURE( rElementName.getLength() > 0, "StorageBase::copyToStorage - invalid element name" );
207*b1cdbd2cSJim Jagielski if( rDestStrg.isStorage() && !rDestStrg.isReadOnly() && (rElementName.getLength() > 0) )
208*b1cdbd2cSJim Jagielski {
209*b1cdbd2cSJim Jagielski StorageRef xSubStrg = openSubStorage( rElementName, false );
210*b1cdbd2cSJim Jagielski if( xSubStrg.get() )
211*b1cdbd2cSJim Jagielski {
212*b1cdbd2cSJim Jagielski StorageRef xDestSubStrg = rDestStrg.openSubStorage( rElementName, true );
213*b1cdbd2cSJim Jagielski if( xDestSubStrg.get() )
214*b1cdbd2cSJim Jagielski xSubStrg->copyStorageToStorage( *xDestSubStrg );
215*b1cdbd2cSJim Jagielski }
216*b1cdbd2cSJim Jagielski else
217*b1cdbd2cSJim Jagielski {
218*b1cdbd2cSJim Jagielski Reference< XInputStream > xInStrm = openInputStream( rElementName );
219*b1cdbd2cSJim Jagielski if( xInStrm.is() )
220*b1cdbd2cSJim Jagielski {
221*b1cdbd2cSJim Jagielski Reference< XOutputStream > xOutStrm = rDestStrg.openOutputStream( rElementName );
222*b1cdbd2cSJim Jagielski if( xOutStrm.is() )
223*b1cdbd2cSJim Jagielski {
224*b1cdbd2cSJim Jagielski BinaryXInputStream aInStrm( xInStrm, true );
225*b1cdbd2cSJim Jagielski BinaryXOutputStream aOutStrm( xOutStrm, true );
226*b1cdbd2cSJim Jagielski aInStrm.copyToStream( aOutStrm );
227*b1cdbd2cSJim Jagielski }
228*b1cdbd2cSJim Jagielski }
229*b1cdbd2cSJim Jagielski }
230*b1cdbd2cSJim Jagielski }
231*b1cdbd2cSJim Jagielski }
232*b1cdbd2cSJim Jagielski
copyStorageToStorage(StorageBase & rDestStrg)233*b1cdbd2cSJim Jagielski void StorageBase::copyStorageToStorage( StorageBase& rDestStrg )
234*b1cdbd2cSJim Jagielski {
235*b1cdbd2cSJim Jagielski OSL_ENSURE( rDestStrg.isStorage() && !rDestStrg.isReadOnly(), "StorageBase::copyToStorage - invalid destination" );
236*b1cdbd2cSJim Jagielski if( rDestStrg.isStorage() && !rDestStrg.isReadOnly() )
237*b1cdbd2cSJim Jagielski {
238*b1cdbd2cSJim Jagielski ::std::vector< OUString > aElements;
239*b1cdbd2cSJim Jagielski getElementNames( aElements );
240*b1cdbd2cSJim Jagielski for( ::std::vector< OUString >::iterator aIt = aElements.begin(), aEnd = aElements.end(); aIt != aEnd; ++aIt )
241*b1cdbd2cSJim Jagielski copyToStorage( rDestStrg, *aIt );
242*b1cdbd2cSJim Jagielski }
243*b1cdbd2cSJim Jagielski }
244*b1cdbd2cSJim Jagielski
commit()245*b1cdbd2cSJim Jagielski void StorageBase::commit()
246*b1cdbd2cSJim Jagielski {
247*b1cdbd2cSJim Jagielski OSL_ENSURE( !mbReadOnly, "StorageBase::commit - cannot commit in read-only mode" );
248*b1cdbd2cSJim Jagielski if( !mbReadOnly )
249*b1cdbd2cSJim Jagielski {
250*b1cdbd2cSJim Jagielski // commit all open substorages
251*b1cdbd2cSJim Jagielski maSubStorages.forEachMem( &StorageBase::commit );
252*b1cdbd2cSJim Jagielski // commit this storage
253*b1cdbd2cSJim Jagielski implCommit();
254*b1cdbd2cSJim Jagielski }
255*b1cdbd2cSJim Jagielski }
256*b1cdbd2cSJim Jagielski
257*b1cdbd2cSJim Jagielski // private --------------------------------------------------------------------
258*b1cdbd2cSJim Jagielski
getSubStorage(const OUString & rElementName,bool bCreateMissing)259*b1cdbd2cSJim Jagielski StorageRef StorageBase::getSubStorage( const OUString& rElementName, bool bCreateMissing )
260*b1cdbd2cSJim Jagielski {
261*b1cdbd2cSJim Jagielski StorageRef& rxSubStrg = maSubStorages[ rElementName ];
262*b1cdbd2cSJim Jagielski if( !rxSubStrg )
263*b1cdbd2cSJim Jagielski rxSubStrg = implOpenSubStorage( rElementName, bCreateMissing );
264*b1cdbd2cSJim Jagielski return rxSubStrg;
265*b1cdbd2cSJim Jagielski }
266*b1cdbd2cSJim Jagielski
267*b1cdbd2cSJim Jagielski // ============================================================================
268*b1cdbd2cSJim Jagielski
269*b1cdbd2cSJim Jagielski } // namespace oox
270