LibreOffice Module ucb (master) 1
filstr.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
20#include <sal/config.h>
21
22#include <com/sun/star/io/BufferSizeExceededException.hpp>
23#include <com/sun/star/io/IOException.hpp>
24#include <com/sun/star/lang/IllegalArgumentException.hpp>
25#include <com/sun/star/uno/RuntimeException.hpp>
26#include <osl/diagnose.h>
27#include "filstr.hxx"
28#include "filerror.hxx"
29
30using namespace fileaccess;
31using namespace com::sun::star;
32
33#if OSL_DEBUG_LEVEL > 0
34#define THROW_WHERE SAL_WHERE
35#else
36#define THROW_WHERE ""
37#endif
38
39/******************************************************************************/
40/* */
41/* XStream_impl implementation */
42/* */
43/******************************************************************************/
44
45XStream_impl::XStream_impl( const OUString& aUncPath, bool bLock )
46 : m_bInputStreamCalled( false ),
47 m_bOutputStreamCalled( false ),
48 m_aFile( aUncPath ),
49 m_nErrorCode( TASKHANDLER_NO_ERROR ),
50 m_nMinorErrorCode( TASKHANDLER_NO_ERROR )
51{
52 sal_uInt32 nFlags = ( osl_File_OpenFlag_Read | osl_File_OpenFlag_Write );
53 if ( !bLock )
54 nFlags |= osl_File_OpenFlag_NoLock;
55
56 osl::FileBase::RC err = m_aFile.open( nFlags );
57 if( err != osl::FileBase::E_None )
58 {
59 m_nIsOpen = false;
60 m_aFile.close();
61
64 }
65 else
66 m_nIsOpen = true;
67}
68
69
71{
72 try
73 {
75 }
76 catch (const io::IOException&)
77 {
78 OSL_FAIL("unexpected situation");
79 }
80 catch (const uno::RuntimeException&)
81 {
82 OSL_FAIL("unexpected situation");
83 }
84}
85
86
87uno::Reference< io::XInputStream > SAL_CALL
89{
90 {
91 std::scoped_lock aGuard( m_aMutex );
93 }
94 return uno::Reference< io::XInputStream >( this );
95}
96
97
98uno::Reference< io::XOutputStream > SAL_CALL
100{
101 {
102 std::scoped_lock aGuard( m_aMutex );
104 }
105 return uno::Reference< io::XOutputStream >( this );
106}
107
108
110{
111 if (osl::FileBase::E_None != m_aFile.setSize(0))
112 throw io::IOException( THROW_WHERE );
113
114 if (osl::FileBase::E_None != m_aFile.setPos(osl_Pos_Absolut,sal_uInt64(0)))
115 throw io::IOException( THROW_WHERE );
116}
117
118
119// XStream_impl private non interface methods
120
121
122sal_Int32 SAL_CALL
124 uno::Sequence< sal_Int8 >& aData,
125 sal_Int32 nBytesToRead )
126{
127 if( ! m_nIsOpen )
128 throw io::IOException( THROW_WHERE );
129
130 try
131 {
132 aData.realloc(nBytesToRead);
133 }
134 catch (const std::bad_alloc&)
135 {
136 if( m_nIsOpen ) m_aFile.close();
137 throw io::BufferSizeExceededException( THROW_WHERE );
138 }
139
140 sal_uInt64 nrc(0);
141 if(m_aFile.read( aData.getArray(), sal_uInt64(nBytesToRead), nrc )
142 != osl::FileBase::E_None)
143 {
144 throw io::IOException( THROW_WHERE );
145 }
146 if (nrc != static_cast<sal_uInt64>(nBytesToRead))
147 aData.realloc(nrc);
148 return static_cast<sal_Int32>(nrc);
149}
150
151sal_Int32
153 sal_Int8* pData,
154 sal_Int32 nBytesToRead )
155{
156 if( ! m_nIsOpen )
157 throw io::IOException( THROW_WHERE );
158
159 sal_uInt64 nrc(0);
160 if(m_aFile.read( pData, sal_uInt64(nBytesToRead), nrc )
161 != osl::FileBase::E_None)
162 {
163 throw io::IOException( THROW_WHERE );
164 }
165 return static_cast<sal_Int32>(nrc);
166}
167
168sal_Int32 SAL_CALL
170 uno::Sequence< sal_Int8 >& aData,
171 sal_Int32 nMaxBytesToRead )
172{
173 return readBytes( aData,nMaxBytesToRead );
174}
175
176
177void SAL_CALL
178XStream_impl::skipBytes( sal_Int32 nBytesToSkip )
179{
180 m_aFile.setPos( osl_Pos_Current, sal_uInt64( nBytesToSkip ) );
181}
182
183
184sal_Int32 SAL_CALL
186{
187 sal_Int64 avail = getLength() - getPosition();
188 return std::min<sal_Int64>(avail, SAL_MAX_INT32);
189}
190
191
192void SAL_CALL
193XStream_impl::writeBytes( const uno::Sequence< sal_Int8 >& aData )
194{
195 sal_uInt32 length = aData.getLength();
196 if(length)
197 {
198 sal_uInt64 nWrittenBytes(0);
199 const sal_Int8* p = aData.getConstArray();
200 if(osl::FileBase::E_None != m_aFile.write(static_cast<void const *>(p),sal_uInt64(length),nWrittenBytes) ||
201 nWrittenBytes != length )
202 throw io::IOException( THROW_WHERE );
203 }
204}
205
206
207void
209{
210 if( m_nIsOpen )
211 {
212 osl::FileBase::RC err = m_aFile.close();
213
214 if( err != osl::FileBase::E_None ) {
215 io::IOException ex;
216 ex.Message = "could not close file";
217 throw ex;
218 }
219
220 m_nIsOpen = false;
221 }
222}
223
224void SAL_CALL
226{
227 std::scoped_lock aGuard( m_aMutex );
228 m_bInputStreamCalled = false;
229
231 closeStream();
232}
233
234
235void SAL_CALL
237{
238 std::scoped_lock aGuard( m_aMutex );
239 m_bOutputStreamCalled = false;
240
242 closeStream();
243}
244
245
246void SAL_CALL
247XStream_impl::seek( sal_Int64 location )
248{
249 if( location < 0 )
250 throw lang::IllegalArgumentException( THROW_WHERE, uno::Reference< uno::XInterface >(), 0 );
251 if( osl::FileBase::E_None != m_aFile.setPos( osl_Pos_Absolut, sal_uInt64( location ) ) )
252 throw io::IOException( THROW_WHERE );
253}
254
255
256sal_Int64 SAL_CALL
258{
259 sal_uInt64 uPos;
260 if( osl::FileBase::E_None != m_aFile.getPos( uPos ) )
261 throw io::IOException( THROW_WHERE );
262 return sal_Int64( uPos );
263}
264
265sal_Int64 SAL_CALL
267{
268 sal_uInt64 uEndPos;
269 if ( m_aFile.getSize(uEndPos) != osl::FileBase::E_None )
270 throw io::IOException( THROW_WHERE );
271 return sal_Int64( uEndPos );
272}
273
274void SAL_CALL
276{}
277
279{
280 // At least on UNIX, to reliably learn about any errors encountered by
281 // asynchronous NFS write operations, without closing the file directly
282 // afterwards, there appears to be no cheaper way than to call fsync:
283 if (m_nIsOpen && m_aFile.sync() != osl::FileBase::E_None) {
284 throw io::IOException(
285 "could not synchronize file to disc",
286 getXWeak());
287 }
288}
289
290/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
::osl::FileBase::RC close()
Definition: filrec.cxx:64
::osl::FileBase::RC setSize(sal_uInt64 uSize)
Definition: filrec.cxx:112
::osl::FileBase::RC getPos(sal_uInt64 &uPos)
Definition: filrec.cxx:104
::osl::FileBase::RC write(const void *pBuffer, sal_uInt64 uBytesToWrite, sal_uInt64 &rBytesWritten)
Definition: filrec.cxx:174
::osl::FileBase::RC read(void *pBuffer, sal_uInt64 uBytesRequested, sal_uInt64 &rBytesRead)
Definition: filrec.cxx:166
::osl::FileBase::RC setPos(sal_uInt32 uHow, sal_Int64 uPos)
Definition: filrec.cxx:73
::osl::FileBase::RC sync() const
Definition: filrec.cxx:182
::osl::FileBase::RC getSize(sal_uInt64 &rSize)
Definition: filrec.cxx:143
::osl::FileBase::RC open(sal_uInt32 uFlags)
Definition: filrec.cxx:48
void SAL_CALL closeInput() override
Definition: filstr.cxx:225
virtual ~XStream_impl() override
Definition: filstr.cxx:70
sal_Int64 SAL_CALL getLength() override
Definition: filstr.cxx:266
virtual css::uno::Reference< css::io::XInputStream > SAL_CALL getInputStream() override
Definition: filstr.cxx:88
void SAL_CALL seek(sal_Int64 location) override
Definition: filstr.cxx:247
void SAL_CALL writeBytes(const css::uno::Sequence< sal_Int8 > &aData) override
Definition: filstr.cxx:193
sal_Int32 m_nMinorErrorCode
Definition: filstr.hxx:141
void SAL_CALL flush() override
Definition: filstr.cxx:275
sal_Int64 SAL_CALL getPosition() override
Definition: filstr.cxx:257
sal_Int32 SAL_CALL readBytes(css::uno::Sequence< sal_Int8 > &aData, sal_Int32 nBytesToRead) override
Definition: filstr.cxx:123
virtual css::uno::Reference< css::io::XOutputStream > SAL_CALL getOutputStream() override
Definition: filstr.cxx:99
void SAL_CALL skipBytes(sal_Int32 nBytesToSkip) override
Definition: filstr.cxx:178
void SAL_CALL closeOutput() override
Definition: filstr.cxx:236
sal_Int32 SAL_CALL available() override
Definition: filstr.cxx:185
sal_Int32 SAL_CALL readSomeBytes(css::uno::Sequence< sal_Int8 > &aData, sal_Int32 nMaxBytesToRead) override
virtual void SAL_CALL waitForCompletion() override
Definition: filstr.cxx:278
virtual void SAL_CALL truncate() override
Definition: filstr.cxx:109
ReconnectingFile m_aFile
Definition: filstr.hxx:138
#define TASKHANDLER_NO_ERROR
Definition: filerror.hxx:26
#define TASKHANDLING_OPEN_FOR_STREAM
Definition: filerror.hxx:47
#define THROW_WHERE
Definition: filstr.cxx:34
void * p
std::unique_ptr< sal_Int32[]> pData
constexpr OUStringLiteral aData
err
#define SAL_MAX_INT32
signed char sal_Int8