unotools/source/streaming/streamwrap.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/NotConnectedException.hpp>
  24 #include <o3tl/safeint.hxx>
  25 #include <unotools/streamwrap.hxx>
  26 #include <tools/stream.hxx>
  27
  28 namespace utl
  29 {
  30
  31 using namespace ::com::sun::star::uno;
  32 using namespace ::com::sun::star::io;
  33 using namespace ::com::sun::star::lang;
  34
  35 OInputStreamWrapper::OInputStreamWrapper( SvStream& _rStream )
  36                  :m_pSvStream(&_rStream)
  37                  ,m_bSvStreamOwner(false)
  38 {
  39 }
  40
  41 OInputStreamWrapper::OInputStreamWrapper( SvStream* pStream, bool bOwner )
  42                  :m_pSvStream( pStream )
  43                  ,m_bSvStreamOwner( bOwner )
  44 {
  45 }
  46
  47 OInputStreamWrapper::OInputStreamWrapper( std::unique_ptr<SvStream> pStream )
  48                  :m_pSvStream( pStream.release() )
  49                  ,m_bSvStreamOwner( true )
  50 {
  51 }
  52
  53 OInputStreamWrapper::~OInputStreamWrapper()
  54 {
  55     if( m_bSvStreamOwner )
  56         delete m_pSvStream;
  57 }
  58
  59 sal_Int32 SAL_CALL OInputStreamWrapper::readBytes(css::uno::Sequence< sal_Int8 >& aData, sal_Int32 nBytesToRead)
  60 {
  61     checkConnected();
  62
  63     if (nBytesToRead < 0)
  64         throw css::io::BufferSizeExceededException(OUString(), getXWeak());
  65
  66     std::scoped_lock aGuard( m_aMutex );
  67
  68     if (aData.getLength() < nBytesToRead)
  69         aData.realloc(nBytesToRead);
  70
  71     sal_uInt32 nRead = m_pSvStream->ReadBytes(static_cast<void*>(aData.getArray()), nBytesToRead);
  72     checkError();
  73
  74     // If read characters < MaxLength, adjust css::uno::Sequence
  75     if (nRead < o3tl::make_unsigned(aData.getLength()))
  76         aData.realloc( nRead );
  77
  78     return nRead;
  79 }
  80
  81 sal_Int32 OInputStreamWrapper::readSomeBytes(sal_Int8* pData, sal_Int32 nBytesToRead)
  82 {
  83     checkConnected();
  84
  85     if (nBytesToRead < 0)
  86         throw css::io::BufferSizeExceededException(OUString(), getXWeak());
  87
  88     std::scoped_lock aGuard( m_aMutex );
  89
  90     sal_uInt32 nRead = m_pSvStream->ReadBytes(static_cast<void*>(pData), nBytesToRead);
  91     checkError();
  92
  93     return nRead;
  94 }
  95
  96 sal_Int32 SAL_CALL OInputStreamWrapper::readSomeBytes(css::uno::Sequence< sal_Int8 >& aData, sal_Int32 nMaxBytesToRead)
  97 {
  98     checkError();
  99
 100     if (nMaxBytesToRead < 0)
 101         throw css::io::BufferSizeExceededException(OUString(), getXWeak());
 102
 103     if (m_pSvStream->eof())
 104     {
 105         aData.realloc(0);
 106         return 0;
 107     }
 108     else
 109         return readBytes(aData, nMaxBytesToRead);
 110 }
 111
 112 void SAL_CALL OInputStreamWrapper::skipBytes(sal_Int32 nBytesToSkip)
 113 {
 114     std::scoped_lock aGuard( m_aMutex );
 115     checkError();
 116
 117     m_pSvStream->SeekRel(nBytesToSkip);
 118     checkError();
 119 }
 120
 121 sal_Int32 SAL_CALL OInputStreamWrapper::available()
 122 {
 123     std::scoped_lock aGuard( m_aMutex );
 124     checkConnected();
 125
 126     sal_Int64 nAvailable = m_pSvStream->remainingSize();
 127     checkError();
 128
 129     return std::min<sal_Int64>(SAL_MAX_INT32, nAvailable);
 130 }
 131
 132 void SAL_CALL OInputStreamWrapper::closeInput()
 133 {
 134     std::scoped_lock aGuard( m_aMutex );
 135     if (m_pSvStream)
 136     {
 137         if (m_bSvStreamOwner)
 138             delete m_pSvStream;
 139
 140         m_pSvStream = nullptr;
 141     }
 142 }
 143
 144 void OInputStreamWrapper::checkConnected() const
 145 {
 146     if (!m_pSvStream)
 147         throw css::io::NotConnectedException(OUString(), const_cast<OInputStreamWrapper*>(this)->getXWeak());
 148 }
 149
 150 void OInputStreamWrapper::checkError() const
 151 {
 152     checkConnected();
 153
 154     auto const e = m_pSvStream->SvStream::GetError();
 155     if (e != ERRCODE_NONE)
 156         // TODO: really evaluate the error
 157         throw css::io::NotConnectedException("utl::OInputStreamWrapper error " + e.toString(), const_cast<OInputStreamWrapper*>(this)->getXWeak());
 158 }
 159
 160 //= OSeekableInputStreamWrapper
 161
 162 OSeekableInputStreamWrapper::~OSeekableInputStreamWrapper() = default;
 163
 164 OSeekableInputStreamWrapper::OSeekableInputStreamWrapper(SvStream& _rStream)
 165 {
 166     SetStream( &_rStream, false );
 167 }
 168
 169 OSeekableInputStreamWrapper::OSeekableInputStreamWrapper(SvStream* _pStream, bool _bOwner)
 170 {
 171     SetStream( _pStream, _bOwner );
 172 }
 173
 174 void SAL_CALL OSeekableInputStreamWrapper::seek( sal_Int64 _nLocation )
 175 {
 176     std::scoped_lock aGuard( m_aMutex );
 177     checkConnected();
 178
 179     m_pSvStream->Seek(static_cast<sal_uInt64>(_nLocation));
 180     checkError();
 181 }
 182
 183 sal_Int64 SAL_CALL OSeekableInputStreamWrapper::getPosition(  )
 184 {
 185     std::scoped_lock aGuard( m_aMutex );
 186     checkConnected();
 187
 188     sal_uInt32 nPos = m_pSvStream->Tell();
 189     checkError();
 190     return static_cast<sal_Int64>(nPos);
 191 }
 192
 193 sal_Int64 SAL_CALL OSeekableInputStreamWrapper::getLength(  )
 194 {
 195     std::scoped_lock aGuard( m_aMutex );
 196     checkConnected();
 197
 198     checkError();
 199
 200     sal_Int64 nEndPos = m_pSvStream->TellEnd();
 201
 202     return nEndPos;
 203 }
 204
 205 //= OOutputStreamWrapper
 206
 207 OOutputStreamWrapper::OOutputStreamWrapper(SvStream& _rStream):
 208     rStream(_rStream)
 209 {}
 210
 211 OOutputStreamWrapper::~OOutputStreamWrapper() {}
 212
 213 void SAL_CALL OOutputStreamWrapper::writeBytes(const css::uno::Sequence< sal_Int8 >& aData)
 214 {
 215     sal_uInt32 nWritten = rStream.WriteBytes(aData.getConstArray(), aData.getLength());
 216     ErrCode err = rStream.GetError();
 217     if  (   (ERRCODE_NONE != err)
 218         ||  (nWritten != static_cast<sal_uInt32>(aData.getLength()))
 219         )
 220     {
 221         throw css::io::BufferSizeExceededException(OUString(), getXWeak());
 222     }
 223 }
 224
 225 void SAL_CALL OOutputStreamWrapper::flush()
 226 {
 227     rStream.FlushBuffer();
 228     checkError();
 229 }
 230
 231 void SAL_CALL OOutputStreamWrapper::closeOutput()
 232 {
 233 }
 234
 235 void OOutputStreamWrapper::checkError() const
 236 {
 237     if (rStream.GetError() != ERRCODE_NONE)
 238         // TODO: really evaluate the error
 239         throw css::io::NotConnectedException(OUString(), const_cast<OOutputStreamWrapper*>(this)->getXWeak());
 240 }
 241
 242 //= OSeekableOutputStreamWrapper
 243
 244 OSeekableOutputStreamWrapper::OSeekableOutputStreamWrapper(SvStream& _rStream)
 245     :OOutputStreamWrapper(_rStream)
 246 {
 247 }
 248
 249 OSeekableOutputStreamWrapper::~OSeekableOutputStreamWrapper() {}
 250
 251 Any SAL_CALL OSeekableOutputStreamWrapper::queryInterface( const Type& _rType )
 252 {
 253     Any aReturn = OOutputStreamWrapper::queryInterface(_rType);
 254     if (!aReturn.hasValue())
 255         aReturn = OSeekableOutputStreamWrapper_Base::queryInterface(_rType);
 256     return aReturn;
 257 }
 258
 259 void SAL_CALL OSeekableOutputStreamWrapper::seek( sal_Int64 _nLocation )
 260 {
 261     rStream.Seek(static_cast<sal_uInt32>(_nLocation));
 262     checkError();
 263 }
 264
 265 sal_Int64 SAL_CALL OSeekableOutputStreamWrapper::getPosition(  )
 266 {
 267     sal_uInt32 nPos = rStream.Tell();
 268     checkError();
 269     return static_cast<sal_Int64>(nPos);
 270 }
 271
 272 sal_Int64 SAL_CALL OSeekableOutputStreamWrapper::getLength(  )
 273 {
 274     checkError();
 275
 276     sal_Int64 nEndPos = rStream.TellEnd();
 277
 278     return nEndPos;
 279 }
 280
 281 OStreamWrapper::~OStreamWrapper() = default;
 282
 283 OStreamWrapper::OStreamWrapper(SvStream& _rStream)
 284 {
 285     SetStream( &_rStream, false );
 286 }
 287
 288 OStreamWrapper::OStreamWrapper(std::unique_ptr<SvStream> pStream)
 289 {
 290     SetStream( pStream.release(), true );
 291 }
 292
 293 OStreamWrapper::OStreamWrapper(SvStream* pStream, bool bOwner)
 294 {
 295     SetStream( pStream, bOwner );
 296 }
 297
 298 css::uno::Reference< css::io::XInputStream > SAL_CALL OStreamWrapper::getInputStream(  )
 299 {
 300     return this;
 301 }
 302
 303 css::uno::Reference< css::io::XOutputStream > SAL_CALL OStreamWrapper::getOutputStream(  )
 304 {
 305     return this;
 306 }
 307
 308 void SAL_CALL OStreamWrapper::writeBytes(const css::uno::Sequence< sal_Int8 >& aData)
 309 {
 310     sal_uInt32 nWritten = m_pSvStream->WriteBytes(aData.getConstArray(), aData.getLength());
 311     ErrCode err = m_pSvStream->GetError();
 312     if  (   (ERRCODE_NONE != err)
 313         ||  (nWritten != static_cast<sal_uInt32>(aData.getLength()))
 314         )
 315     {
 316         throw css::io::BufferSizeExceededException(OUString(), getXWeak());
 317     }
 318 }
 319
 320 void SAL_CALL OStreamWrapper::flush()
 321 {
 322     m_pSvStream->FlushBuffer();
 323     if (m_pSvStream->GetError() != ERRCODE_NONE)
 324         throw css::io::NotConnectedException(OUString(), getXWeak());
 325 }
 326
 327 void SAL_CALL OStreamWrapper::closeOutput()
 328 {
 329 }
 330
 331 void SAL_CALL OStreamWrapper::truncate()
 332 {
 333     m_pSvStream->SetStreamSize(0);
 334 }
 335
 336 } // namespace utl
 337
 338 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */