1*b5088357SAndrew Rist /**************************************************************
2cdf0e10cSrcweir *
3*b5088357SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*b5088357SAndrew Rist * or more contributor license agreements. See the NOTICE file
5*b5088357SAndrew Rist * distributed with this work for additional information
6*b5088357SAndrew Rist * regarding copyright ownership. The ASF licenses this file
7*b5088357SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*b5088357SAndrew Rist * "License"); you may not use this file except in compliance
9*b5088357SAndrew Rist * with the License. You may obtain a copy of the License at
10*b5088357SAndrew Rist *
11*b5088357SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0
12*b5088357SAndrew Rist *
13*b5088357SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*b5088357SAndrew Rist * software distributed under the License is distributed on an
15*b5088357SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b5088357SAndrew Rist * KIND, either express or implied. See the License for the
17*b5088357SAndrew Rist * specific language governing permissions and limitations
18*b5088357SAndrew Rist * under the License.
19*b5088357SAndrew Rist *
20*b5088357SAndrew Rist *************************************************************/
21*b5088357SAndrew Rist
22*b5088357SAndrew Rist
23cdf0e10cSrcweir
24cdf0e10cSrcweir // MARKER(update_precomp.py): autogen include statement, do not remove
25cdf0e10cSrcweir #include "precompiled_unotools.hxx"
26cdf0e10cSrcweir
27cdf0e10cSrcweir #include <unotools/ucblockbytes.hxx>
28cdf0e10cSrcweir #include <unotools/ucbstreamhelper.hxx>
29cdf0e10cSrcweir #include <comphelper/processfactory.hxx>
30cdf0e10cSrcweir #include <com/sun/star/ucb/CommandAbortedException.hpp>
31cdf0e10cSrcweir
32cdf0e10cSrcweir #ifndef _COM_SUN_STAR_UCB_XCOMMANDENVIRONMENT_HDL_
33cdf0e10cSrcweir #include <com/sun/star/ucb/XCommandEnvironment.hdl>
34cdf0e10cSrcweir #endif
35cdf0e10cSrcweir #include <com/sun/star/ucb/InsertCommandArgument.hpp>
36cdf0e10cSrcweir #include <com/sun/star/io/XActiveDataStreamer.hpp>
37cdf0e10cSrcweir
38cdf0e10cSrcweir #include <ucbhelper/contentbroker.hxx>
39cdf0e10cSrcweir #include <ucbhelper/content.hxx>
40cdf0e10cSrcweir #include <tools/debug.hxx>
41cdf0e10cSrcweir #include <unotools/streamwrap.hxx>
42cdf0e10cSrcweir
43cdf0e10cSrcweir using namespace ::com::sun::star::uno;
44cdf0e10cSrcweir using namespace ::com::sun::star::io;
45cdf0e10cSrcweir using namespace ::com::sun::star::uno;
46cdf0e10cSrcweir using namespace ::com::sun::star::ucb;
47cdf0e10cSrcweir using namespace ::com::sun::star::task;
48cdf0e10cSrcweir using namespace ::com::sun::star::lang;
49cdf0e10cSrcweir using namespace ::com::sun::star::beans;
50cdf0e10cSrcweir
51cdf0e10cSrcweir namespace utl
52cdf0e10cSrcweir {
53cdf0e10cSrcweir
lcl_CreateStream(const String & rFileName,StreamMode eOpenMode,Reference<XInteractionHandler> xInteractionHandler,UcbLockBytesHandler * pHandler,sal_Bool,sal_Bool bEnsureFileExists)54cdf0e10cSrcweir static SvStream* lcl_CreateStream( const String& rFileName, StreamMode eOpenMode,
55cdf0e10cSrcweir Reference < XInteractionHandler > xInteractionHandler,
56cdf0e10cSrcweir UcbLockBytesHandler* pHandler, sal_Bool /*bForceSynchron*/, sal_Bool bEnsureFileExists )
57cdf0e10cSrcweir {
58cdf0e10cSrcweir SvStream* pStream = NULL;
59cdf0e10cSrcweir ::ucbhelper::ContentBroker* pBroker = ::ucbhelper::ContentBroker::get();
60cdf0e10cSrcweir if ( pBroker )
61cdf0e10cSrcweir {
62cdf0e10cSrcweir UcbLockBytesRef xLockBytes;
63cdf0e10cSrcweir if ( eOpenMode & STREAM_WRITE )
64cdf0e10cSrcweir {
65cdf0e10cSrcweir sal_Bool bTruncate = ( eOpenMode & STREAM_TRUNC ) != 0;
66cdf0e10cSrcweir if ( bTruncate )
67cdf0e10cSrcweir {
68cdf0e10cSrcweir try
69cdf0e10cSrcweir {
70cdf0e10cSrcweir // truncate is implemented with deleting the original file
71cdf0e10cSrcweir ::ucbhelper::Content aCnt( rFileName, Reference < XCommandEnvironment >() );
72cdf0e10cSrcweir aCnt.executeCommand( ::rtl::OUString::createFromAscii( "delete" ), makeAny( sal_Bool( sal_True ) ) );
73cdf0e10cSrcweir }
74cdf0e10cSrcweir
75cdf0e10cSrcweir catch ( CommandAbortedException& )
76cdf0e10cSrcweir {
77cdf0e10cSrcweir // couldn't truncate/delete
78cdf0e10cSrcweir }
79cdf0e10cSrcweir catch ( ContentCreationException& )
80cdf0e10cSrcweir {
81cdf0e10cSrcweir }
82cdf0e10cSrcweir catch ( Exception& )
83cdf0e10cSrcweir {
84cdf0e10cSrcweir }
85cdf0e10cSrcweir }
86cdf0e10cSrcweir
87cdf0e10cSrcweir if ( bEnsureFileExists || bTruncate )
88cdf0e10cSrcweir {
89cdf0e10cSrcweir try
90cdf0e10cSrcweir {
91cdf0e10cSrcweir // make sure that the desired file exists before trying to open
92cdf0e10cSrcweir SvMemoryStream aStream(0,0);
93cdf0e10cSrcweir ::utl::OInputStreamWrapper* pInput = new ::utl::OInputStreamWrapper( aStream );
94cdf0e10cSrcweir Reference< XInputStream > xInput( pInput );
95cdf0e10cSrcweir
96cdf0e10cSrcweir ::ucbhelper::Content aContent( rFileName, Reference < XCommandEnvironment >() );
97cdf0e10cSrcweir InsertCommandArgument aInsertArg;
98cdf0e10cSrcweir aInsertArg.Data = xInput;
99cdf0e10cSrcweir
100cdf0e10cSrcweir aInsertArg.ReplaceExisting = sal_False;
101cdf0e10cSrcweir Any aCmdArg;
102cdf0e10cSrcweir aCmdArg <<= aInsertArg;
103cdf0e10cSrcweir aContent.executeCommand( ::rtl::OUString::createFromAscii( "insert" ), aCmdArg );
104cdf0e10cSrcweir }
105cdf0e10cSrcweir
106cdf0e10cSrcweir // it is NOT an error when the stream already exists and no truncation was desired
107cdf0e10cSrcweir catch ( CommandAbortedException& )
108cdf0e10cSrcweir {
109cdf0e10cSrcweir // currently never an error is detected !
110cdf0e10cSrcweir }
111cdf0e10cSrcweir catch ( ContentCreationException& )
112cdf0e10cSrcweir {
113cdf0e10cSrcweir }
114cdf0e10cSrcweir catch ( Exception& )
115cdf0e10cSrcweir {
116cdf0e10cSrcweir }
117cdf0e10cSrcweir }
118cdf0e10cSrcweir }
119cdf0e10cSrcweir
120cdf0e10cSrcweir try
121cdf0e10cSrcweir {
122cdf0e10cSrcweir // create LockBytes using UCB
123cdf0e10cSrcweir ::ucbhelper::Content aContent( rFileName, Reference < XCommandEnvironment >() );
124cdf0e10cSrcweir xLockBytes = UcbLockBytes::CreateLockBytes( aContent.get(), Sequence < PropertyValue >(),
125cdf0e10cSrcweir eOpenMode, xInteractionHandler, pHandler );
126cdf0e10cSrcweir if ( xLockBytes.Is() )
127cdf0e10cSrcweir {
128cdf0e10cSrcweir pStream = new SvStream( xLockBytes );
129cdf0e10cSrcweir pStream->SetBufferSize( 4096 );
130cdf0e10cSrcweir pStream->SetError( xLockBytes->GetError() );
131cdf0e10cSrcweir }
132cdf0e10cSrcweir }
133cdf0e10cSrcweir catch ( CommandAbortedException& )
134cdf0e10cSrcweir {
135cdf0e10cSrcweir }
136cdf0e10cSrcweir catch ( ContentCreationException& )
137cdf0e10cSrcweir {
138cdf0e10cSrcweir }
139cdf0e10cSrcweir catch ( Exception& )
140cdf0e10cSrcweir {
141cdf0e10cSrcweir }
142cdf0e10cSrcweir }
143cdf0e10cSrcweir else
144cdf0e10cSrcweir // if no UCB is present at least conventional file io is supported
145cdf0e10cSrcweir pStream = new SvFileStream( rFileName, eOpenMode );
146cdf0e10cSrcweir
147cdf0e10cSrcweir return pStream;
148cdf0e10cSrcweir }
149cdf0e10cSrcweir
150cdf0e10cSrcweir //============================================================================
151cdf0e10cSrcweir
CreateStream(const String & rFileName,StreamMode eOpenMode,UcbLockBytesHandler * pHandler,sal_Bool bForceSynchron)152cdf0e10cSrcweir SvStream* UcbStreamHelper::CreateStream( const String& rFileName, StreamMode eOpenMode,
153cdf0e10cSrcweir UcbLockBytesHandler* pHandler, sal_Bool bForceSynchron )
154cdf0e10cSrcweir {
155cdf0e10cSrcweir return lcl_CreateStream( rFileName, eOpenMode, Reference < XInteractionHandler >(), pHandler, bForceSynchron, sal_True /* bEnsureFileExists */ );
156cdf0e10cSrcweir }
157cdf0e10cSrcweir
CreateStream(const String & rFileName,StreamMode eOpenMode,Reference<XInteractionHandler> xInteractionHandler,UcbLockBytesHandler * pHandler,sal_Bool bForceSynchron)158cdf0e10cSrcweir SvStream* UcbStreamHelper::CreateStream( const String& rFileName, StreamMode eOpenMode,
159cdf0e10cSrcweir Reference < XInteractionHandler > xInteractionHandler,
160cdf0e10cSrcweir UcbLockBytesHandler* pHandler, sal_Bool bForceSynchron )
161cdf0e10cSrcweir {
162cdf0e10cSrcweir return lcl_CreateStream( rFileName, eOpenMode, xInteractionHandler, pHandler, bForceSynchron, sal_True /* bEnsureFileExists */ );
163cdf0e10cSrcweir }
164cdf0e10cSrcweir
CreateStream(const String & rFileName,StreamMode eOpenMode,sal_Bool bFileExists,UcbLockBytesHandler * pHandler,sal_Bool bForceSynchron)165cdf0e10cSrcweir SvStream* UcbStreamHelper::CreateStream( const String& rFileName, StreamMode eOpenMode,
166cdf0e10cSrcweir sal_Bool bFileExists,
167cdf0e10cSrcweir UcbLockBytesHandler* pHandler, sal_Bool bForceSynchron )
168cdf0e10cSrcweir {
169cdf0e10cSrcweir return lcl_CreateStream( rFileName, eOpenMode, Reference < XInteractionHandler >(), pHandler, bForceSynchron, !bFileExists );
170cdf0e10cSrcweir }
171cdf0e10cSrcweir
CreateStream(Reference<XInputStream> xStream)172cdf0e10cSrcweir SvStream* UcbStreamHelper::CreateStream( Reference < XInputStream > xStream )
173cdf0e10cSrcweir {
174cdf0e10cSrcweir SvStream* pStream = NULL;
175cdf0e10cSrcweir UcbLockBytesRef xLockBytes = UcbLockBytes::CreateInputLockBytes( xStream );
176cdf0e10cSrcweir if ( xLockBytes.Is() )
177cdf0e10cSrcweir {
178cdf0e10cSrcweir pStream = new SvStream( xLockBytes );
179cdf0e10cSrcweir pStream->SetBufferSize( 4096 );
180cdf0e10cSrcweir pStream->SetError( xLockBytes->GetError() );
181cdf0e10cSrcweir }
182cdf0e10cSrcweir
183cdf0e10cSrcweir return pStream;
184cdf0e10cSrcweir }
185cdf0e10cSrcweir
CreateStream(Reference<XStream> xStream)186cdf0e10cSrcweir SvStream* UcbStreamHelper::CreateStream( Reference < XStream > xStream )
187cdf0e10cSrcweir {
188cdf0e10cSrcweir SvStream* pStream = NULL;
189cdf0e10cSrcweir if ( xStream->getOutputStream().is() )
190cdf0e10cSrcweir {
191cdf0e10cSrcweir UcbLockBytesRef xLockBytes = UcbLockBytes::CreateLockBytes( xStream );
192cdf0e10cSrcweir if ( xLockBytes.Is() )
193cdf0e10cSrcweir {
194cdf0e10cSrcweir pStream = new SvStream( xLockBytes );
195cdf0e10cSrcweir pStream->SetBufferSize( 4096 );
196cdf0e10cSrcweir pStream->SetError( xLockBytes->GetError() );
197cdf0e10cSrcweir }
198cdf0e10cSrcweir }
199cdf0e10cSrcweir else
200cdf0e10cSrcweir return CreateStream( xStream->getInputStream() );
201cdf0e10cSrcweir
202cdf0e10cSrcweir return pStream;
203cdf0e10cSrcweir }
204cdf0e10cSrcweir
CreateStream(Reference<XInputStream> xStream,sal_Bool bCloseStream)205cdf0e10cSrcweir SvStream* UcbStreamHelper::CreateStream( Reference < XInputStream > xStream, sal_Bool bCloseStream )
206cdf0e10cSrcweir {
207cdf0e10cSrcweir SvStream* pStream = NULL;
208cdf0e10cSrcweir UcbLockBytesRef xLockBytes = UcbLockBytes::CreateInputLockBytes( xStream );
209cdf0e10cSrcweir if ( xLockBytes.Is() )
210cdf0e10cSrcweir {
211cdf0e10cSrcweir if ( !bCloseStream )
212cdf0e10cSrcweir xLockBytes->setDontClose_Impl();
213cdf0e10cSrcweir
214cdf0e10cSrcweir pStream = new SvStream( xLockBytes );
215cdf0e10cSrcweir pStream->SetBufferSize( 4096 );
216cdf0e10cSrcweir pStream->SetError( xLockBytes->GetError() );
217cdf0e10cSrcweir }
218cdf0e10cSrcweir
219cdf0e10cSrcweir return pStream;
220cdf0e10cSrcweir };
221cdf0e10cSrcweir
CreateStream(Reference<XStream> xStream,sal_Bool bCloseStream)222cdf0e10cSrcweir SvStream* UcbStreamHelper::CreateStream( Reference < XStream > xStream, sal_Bool bCloseStream )
223cdf0e10cSrcweir {
224cdf0e10cSrcweir SvStream* pStream = NULL;
225cdf0e10cSrcweir if ( xStream->getOutputStream().is() )
226cdf0e10cSrcweir {
227cdf0e10cSrcweir UcbLockBytesRef xLockBytes = UcbLockBytes::CreateLockBytes( xStream );
228cdf0e10cSrcweir if ( xLockBytes.Is() )
229cdf0e10cSrcweir {
230cdf0e10cSrcweir if ( !bCloseStream )
231cdf0e10cSrcweir xLockBytes->setDontClose_Impl();
232cdf0e10cSrcweir
233cdf0e10cSrcweir pStream = new SvStream( xLockBytes );
234cdf0e10cSrcweir pStream->SetBufferSize( 4096 );
235cdf0e10cSrcweir pStream->SetError( xLockBytes->GetError() );
236cdf0e10cSrcweir }
237cdf0e10cSrcweir }
238cdf0e10cSrcweir else
239cdf0e10cSrcweir return CreateStream( xStream->getInputStream(), bCloseStream );
240cdf0e10cSrcweir
241cdf0e10cSrcweir return pStream;
242cdf0e10cSrcweir };
243cdf0e10cSrcweir
244cdf0e10cSrcweir }
245