ucb/source/ucp/file/filstr.cxx

   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
  30 using namespace fileaccess;
  31 using 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
  45 XStream_impl::XStream_impl( const OUString& aUncPath, bool bLock )
  46     : m_bInputStreamCalled( false ),
  47       m_bOutputStreamCalled( false ),
  48       m_aFile( aUncPath ),
  49       m_nErrorCode( TaskHandlerErr::NO_ERROR ),
  50       m_nMinorErrorCode( 0 )
  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
  62         m_nErrorCode = TaskHandlerErr::OPEN_FOR_STREAM;
  63         m_nMinorErrorCode = err;
  64     }
  65     else
  66         m_nIsOpen = true;
  67 }
  68
  69
  70 XStream_impl::~XStream_impl()
  71 {
  72     try
  73     {
  74         closeStream();
  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
  87 uno::Reference< io::XInputStream > SAL_CALL
  88 XStream_impl::getInputStream(  )
  89 {
  90     {
  91         std::scoped_lock aGuard( m_aMutex );
  92         m_bInputStreamCalled = true;
  93     }
  94     return uno::Reference< io::XInputStream >( this );
  95 }
  96
  97
  98 uno::Reference< io::XOutputStream > SAL_CALL
  99 XStream_impl::getOutputStream(  )
 100 {
 101     {
 102         std::scoped_lock aGuard( m_aMutex );
 103         m_bOutputStreamCalled = true;
 104     }
 105     return uno::Reference< io::XOutputStream >( this );
 106 }
 107
 108
 109 void SAL_CALL XStream_impl::truncate()
 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
 122 sal_Int32 SAL_CALL
 123 XStream_impl::readBytes(
 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
 151 sal_Int32
 152 XStream_impl::readSomeBytes(
 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
 168 sal_Int32 SAL_CALL
 169 XStream_impl::readSomeBytes(
 170     uno::Sequence< sal_Int8 >& aData,
 171     sal_Int32 nMaxBytesToRead )
 172 {
 173     return readBytes( aData,nMaxBytesToRead );
 174 }
 175
 176
 177 void SAL_CALL
 178 XStream_impl::skipBytes( sal_Int32 nBytesToSkip )
 179 {
 180     m_aFile.setPos( osl_Pos_Current, sal_uInt64( nBytesToSkip ) );
 181 }
 182
 183
 184 sal_Int32 SAL_CALL
 185 XStream_impl::available()
 186 {
 187     sal_Int64 avail = getLength() - getPosition();
 188     return std::min<sal_Int64>(avail, SAL_MAX_INT32);
 189 }
 190
 191
 192 void SAL_CALL
 193 XStream_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
 207 void
 208 XStream_impl::closeStream()
 209 {
 210     if( m_nIsOpen )
 211     {
 212         osl::FileBase::RC err = m_aFile.close();
 213
 214         if( err != osl::FileBase::E_None ) {
 215             throw io::IOException(u"could not close file"_ustr);
 216         }
 217
 218         m_nIsOpen = false;
 219     }
 220 }
 221
 222 void SAL_CALL
 223 XStream_impl::closeInput()
 224 {
 225     std::scoped_lock aGuard( m_aMutex );
 226     m_bInputStreamCalled = false;
 227
 228     if( ! m_bOutputStreamCalled )
 229         closeStream();
 230 }
 231
 232
 233 void SAL_CALL
 234 XStream_impl::closeOutput()
 235 {
 236     std::scoped_lock aGuard( m_aMutex );
 237     m_bOutputStreamCalled = false;
 238
 239     if( ! m_bInputStreamCalled )
 240         closeStream();
 241 }
 242
 243
 244 void SAL_CALL
 245 XStream_impl::seek( sal_Int64 location )
 246 {
 247     if( location < 0 )
 248         throw lang::IllegalArgumentException( THROW_WHERE, uno::Reference< uno::XInterface >(), 0 );
 249     if( osl::FileBase::E_None != m_aFile.setPos( osl_Pos_Absolut, sal_uInt64( location ) ) )
 250         throw io::IOException( THROW_WHERE );
 251 }
 252
 253
 254 sal_Int64 SAL_CALL
 255 XStream_impl::getPosition()
 256 {
 257     sal_uInt64 uPos;
 258     if( osl::FileBase::E_None != m_aFile.getPos( uPos ) )
 259         throw io::IOException( THROW_WHERE );
 260     return sal_Int64( uPos );
 261 }
 262
 263 sal_Int64 SAL_CALL
 264 XStream_impl::getLength()
 265 {
 266     sal_uInt64 uEndPos;
 267     if ( m_aFile.getSize(uEndPos) != osl::FileBase::E_None )
 268             throw io::IOException( THROW_WHERE );
 269     return sal_Int64( uEndPos );
 270 }
 271
 272 void SAL_CALL
 273 XStream_impl::flush()
 274 {}
 275
 276 void XStream_impl::waitForCompletion()
 277 {
 278     // At least on UNIX, to reliably learn about any errors encountered by
 279     // asynchronous NFS write operations, without closing the file directly
 280     // afterwards, there appears to be no cheaper way than to call fsync:
 281     if (m_nIsOpen && m_aFile.sync() != osl::FileBase::E_None) {
 282         throw io::IOException(
 283             u"could not synchronize file to disc"_ustr,
 284             getXWeak());
 285     }
 286 }
 287
 288 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */