unotools/source/ucbhelper/xtempfile.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 #include <XTempFile.hxx>
  20 #include <cppuhelper/factory.hxx>
  21 #include <cppuhelper/typeprovider.hxx>
  22 #include <unotools/tempfile.hxx>
  23 #include <osl/file.hxx>
  24 #include <unotools/configmgr.hxx>
  25
  26 OTempFileService::OTempFileService(::css::uno::Reference< ::css::uno::XComponentContext > const & context)
  27 : ::cppu::PropertySetMixin< ::css::io::XTempFile >(
  28     context
  29     , static_cast< Implements >( IMPLEMENTS_PROPERTY_SET | IMPLEMENTS_FAST_PROPERTY_SET | IMPLEMENTS_PROPERTY_ACCESS )
  30     , com::sun::star::uno::Sequence< rtl::OUString >() )
  31 , mpStream( NULL )
  32 , mbRemoveFile( sal_True )
  33 , mbInClosed( sal_False )
  34 , mbOutClosed( sal_False )
  35 , mnCachedPos( 0 )
  36 , mbHasCachedPos( sal_False )
  37
  38 {
  39     mpTempFile = new ::utl::TempFile;
  40     mpTempFile->EnableKillingFile ( sal_True );
  41 }
  42
  43 OTempFileService::~OTempFileService ()
  44 {
  45     if ( mpTempFile )
  46         delete mpTempFile;
  47 }
  48
  49
  50 // XInterface
  51
  52 ::css::uno::Any SAL_CALL OTempFileService::queryInterface( ::css::uno::Type const & aType )
  53 throw ( ::css::uno::RuntimeException )
  54 {
  55     ::css::uno::Any aResult( OTempFileBase::queryInterface( aType ) );
  56     if (!aResult.hasValue())
  57         aResult = cppu::PropertySetMixin< ::css::io::XTempFile >::queryInterface( aType ) ;
  58     return aResult;
  59 };
  60 void SAL_CALL OTempFileService::acquire(  )
  61 throw ()
  62 {
  63     OTempFileBase::acquire();
  64 }
  65 void SAL_CALL OTempFileService::release(  )
  66 throw ()
  67 {
  68     OTempFileBase::release();
  69 }
  70
  71 //  XTypeProvider
  72
  73 ::css::uno::Sequence< ::css::uno::Type > SAL_CALL OTempFileService::getTypes(  )
  74 throw ( ::css::uno::RuntimeException )
  75 {
  76     static ::cppu::OTypeCollection* pTypeCollection = NULL;
  77     if ( pTypeCollection == NULL )
  78     {
  79         ::osl::MutexGuard aGuard( ::osl::Mutex::getGlobalMutex() ) ;
  80
  81         if ( pTypeCollection == NULL )
  82         {
  83             static ::cppu::OTypeCollection aTypeCollection(
  84                 ::getCppuType( ( const ::css::uno::Reference< ::css::beans::XPropertySet >*)NULL )
  85                 ,OTempFileBase::getTypes() );
  86             pTypeCollection = &aTypeCollection;
  87         }
  88     }
  89     return pTypeCollection->getTypes();
  90 };
  91 ::css::uno::Sequence< sal_Int8 > SAL_CALL OTempFileService::getImplementationId(  )
  92 throw ( ::css::uno::RuntimeException )
  93 {
  94     return OTempFileBase::getImplementationId();
  95 }
  96
  97 //  XTempFile
  98
  99 sal_Bool SAL_CALL OTempFileService::getRemoveFile()
 100 throw ( ::css::uno::RuntimeException )
 101 {
 102     ::osl::MutexGuard aGuard( maMutex );
 103
 104     if ( !mpTempFile )
 105     {
 106         // the stream is already disconnected
 107         throw ::css::uno::RuntimeException();
 108         }
 109
 110     return mbRemoveFile;
 111 };
 112 void SAL_CALL OTempFileService::setRemoveFile( sal_Bool _removefile )
 113 throw ( ::css::uno::RuntimeException )
 114 {
 115     ::osl::MutexGuard aGuard( maMutex );
 116
 117     if ( !mpTempFile )
 118     {
 119         // the stream is already disconnected
 120         throw ::css::uno::RuntimeException();
 121     }
 122
 123     mbRemoveFile = _removefile;
 124     mpTempFile->EnableKillingFile( mbRemoveFile );
 125 };
 126 ::rtl::OUString SAL_CALL OTempFileService::getUri()
 127 throw ( ::css::uno::RuntimeException )
 128 {
 129     ::osl::MutexGuard aGuard( maMutex );
 130
 131     if ( !mpTempFile )
 132     {
 133         throw ::css::uno::RuntimeException();
 134     }
 135
 136     return ::rtl::OUString( mpTempFile->GetURL() );
 137
 138 };
 139 ::rtl::OUString SAL_CALL OTempFileService::getResourceName()
 140 throw ( ::css::uno::RuntimeException )
 141 {
 142     ::osl::MutexGuard aGuard( maMutex );
 143
 144     if ( !mpTempFile )
 145     {
 146         throw ::css::uno::RuntimeException();
 147 }
 148
 149     return ::rtl::OUString( mpTempFile->GetFileName() );
 150 };
 151
 152
 153
 154 // XInputStream
 155
 156 sal_Int32 SAL_CALL OTempFileService::readBytes( ::css::uno::Sequence< sal_Int8 >& aData, sal_Int32 nBytesToRead )
 157 throw (::css::io::NotConnectedException, ::css::io::BufferSizeExceededException, ::css::io::IOException, ::css::uno::RuntimeException )
 158 {
 159     ::osl::MutexGuard aGuard( maMutex );
 160     if ( mbInClosed )
 161         throw ::css::io::NotConnectedException ( ::rtl::OUString(), const_cast < ::css::uno::XWeak * > ( static_cast < const ::css::uno::XWeak * > (this ) ) );
 162
 163     checkConnected();
 164     if (nBytesToRead < 0)
 165         throw ::css::io::BufferSizeExceededException( ::rtl::OUString(), static_cast< ::css::uno::XWeak * >(this));
 166
 167     aData.realloc(nBytesToRead);
 168
 169     sal_uInt32 nRead = mpStream->Read(static_cast < void* > ( aData.getArray() ), nBytesToRead);
 170     checkError();
 171
 172     if (nRead < static_cast < sal_uInt32 > ( nBytesToRead ) )
 173         aData.realloc( nRead );
 174
 175     if ( sal::static_int_cast<sal_uInt32>(nBytesToRead) > nRead )
 176     {
 177         // usually that means that the stream was read till the end
 178         // TODO/LATER: it is better to get rid of this optimization by avoiding using of multiple temporary files ( there should be only one temporary file? )
 179         mnCachedPos = mpStream->Tell();
 180         mbHasCachedPos = sal_True;
 181
 182         mpStream = NULL;
 183         if ( mpTempFile )
 184             mpTempFile->CloseStream();
 185     }
 186
 187     return nRead;
 188 }
 189 sal_Int32 SAL_CALL OTempFileService::readSomeBytes( ::css::uno::Sequence< sal_Int8 >& aData, sal_Int32 nMaxBytesToRead )
 190 throw ( ::css::io::NotConnectedException, ::css::io::BufferSizeExceededException, ::css::io::IOException, ::css::uno::RuntimeException )
 191 {
 192     ::osl::MutexGuard aGuard( maMutex );
 193     if ( mbInClosed )
 194         throw ::css::io::NotConnectedException ( ::rtl::OUString(), const_cast < ::css::uno::XWeak * > ( static_cast < const ::css::uno::XWeak * > (this ) ) );
 195
 196     checkConnected();
 197     checkError();
 198
 199     if (nMaxBytesToRead < 0)
 200         throw ::css::io::BufferSizeExceededException( ::rtl::OUString(), static_cast < ::css::uno::XWeak * >( this ) );
 201
 202     if (mpStream->IsEof())
 203     {
 204         aData.realloc(0);
 205         return 0;
 206     }
 207     else
 208         return readBytes(aData, nMaxBytesToRead);
 209 }
 210 void SAL_CALL OTempFileService::skipBytes( sal_Int32 nBytesToSkip )
 211 throw ( ::css::io::NotConnectedException, ::css::io::BufferSizeExceededException, ::css::io::IOException, ::css::uno::RuntimeException )
 212 {
 213     ::osl::MutexGuard aGuard( maMutex );
 214     if ( mbInClosed )
 215         throw ::css::io::NotConnectedException ( ::rtl::OUString(), const_cast < ::css::uno::XWeak * > ( static_cast < const ::css::uno::XWeak * > (this ) ) );
 216
 217     checkConnected();
 218     checkError();
 219     mpStream->SeekRel(nBytesToSkip);
 220     checkError();
 221 }
 222 sal_Int32 SAL_CALL OTempFileService::available(  )
 223 throw ( ::css::io::NotConnectedException, ::css::io::IOException, ::css::uno::RuntimeException )
 224 {
 225     ::osl::MutexGuard aGuard( maMutex );
 226     if ( mbInClosed )
 227         throw ::css::io::NotConnectedException ( ::rtl::OUString(), const_cast < ::css::uno::XWeak * > ( static_cast < const ::css::uno::XWeak * > (this ) ) );
 228
 229     checkConnected();
 230
 231     sal_uInt32 nPos = mpStream->Tell();
 232     checkError();
 233
 234     mpStream->Seek(STREAM_SEEK_TO_END);
 235     checkError();
 236
 237     sal_Int32 nAvailable = (sal_Int32)mpStream->Tell() - nPos;
 238     mpStream->Seek(nPos);
 239     checkError();
 240
 241     return nAvailable;
 242 }
 243 void SAL_CALL OTempFileService::closeInput(  )
 244 throw ( ::css::io::NotConnectedException, ::css::io::IOException, ::css::uno::RuntimeException )
 245 {
 246     ::osl::MutexGuard aGuard( maMutex );
 247     if ( mbInClosed )
 248         throw ::css::io::NotConnectedException ( ::rtl::OUString(), const_cast < ::css::uno::XWeak  * > ( static_cast < const ::css::uno::XWeak * > (this ) ) );
 249
 250     mbInClosed = sal_True;
 251
 252     if ( mbOutClosed )
 253     {
 254         // stream will be deleted by TempFile implementation
 255         mpStream = NULL;
 256
 257         if ( mpTempFile )
 258         {
 259             delete mpTempFile;
 260             mpTempFile = NULL;
 261         }
 262     }
 263 }
 264
 265 // XOutputStream
 266
 267 void SAL_CALL OTempFileService::writeBytes( const ::css::uno::Sequence< sal_Int8 >& aData )
 268 throw ( ::css::io::NotConnectedException, ::css::io::BufferSizeExceededException, ::css::io::IOException, ::css::uno::RuntimeException )
 269 {
 270     ::osl::MutexGuard aGuard( maMutex );
 271     if ( mbOutClosed )
 272         throw ::css::io::NotConnectedException ( ::rtl::OUString(), const_cast < ::css::uno::XWeak * > ( static_cast < const ::css::uno::XWeak * > (this ) ) );
 273
 274     checkConnected();
 275     sal_uInt32 nWritten = mpStream->Write(aData.getConstArray(),aData.getLength());
 276     checkError();
 277     if  ( nWritten != (sal_uInt32)aData.getLength())
 278         throw ::css::io::BufferSizeExceededException( ::rtl::OUString(),static_cast < ::css::uno::XWeak * > ( this ) );
 279 }
 280 void SAL_CALL OTempFileService::flush(  )
 281 throw ( ::css::io::NotConnectedException, ::css::io::BufferSizeExceededException, ::css::io::IOException, ::css::uno::RuntimeException )
 282 {
 283     ::osl::MutexGuard aGuard( maMutex );
 284     if ( mbOutClosed )
 285         throw ::css::io::NotConnectedException ( ::rtl::OUString(), const_cast < ::css::uno::XWeak * > ( static_cast < const ::css::uno::XWeak * > (this ) ) );
 286
 287     checkConnected();
 288     mpStream->Flush();
 289     checkError();
 290 }
 291 void SAL_CALL OTempFileService::closeOutput(  )
 292 throw ( ::css::io::NotConnectedException, ::css::io::BufferSizeExceededException, ::css::io::IOException, ::css::uno::RuntimeException )
 293 {
 294     ::osl::MutexGuard aGuard( maMutex );
 295     if ( mbOutClosed )
 296         throw ::css::io::NotConnectedException ( ::rtl::OUString(), const_cast < ::css::uno::XWeak * > ( static_cast < const ::css::uno::XWeak * > (this ) ) );
 297
 298     mbOutClosed = sal_True;
 299
 300     // TODO/LATER: it is better to get rid of this optimization by avoiding using of multiple temporary files ( there should be only one temporary file? )
 301     if ( mpStream )
 302     {
 303         mnCachedPos = mpStream->Tell();
 304         mbHasCachedPos = sal_True;
 305
 306         mpStream = NULL;
 307         if ( mpTempFile )
 308             mpTempFile->CloseStream();
 309     }
 310
 311     if ( mbInClosed )
 312     {
 313         // stream will be deleted by TempFile implementation
 314         mpStream = NULL;
 315
 316         if ( mpTempFile )
 317         {
 318             delete mpTempFile;
 319             mpTempFile = NULL;
 320         }
 321     }
 322 }
 323
 324
 325 void OTempFileService::checkError () const
 326 {
 327     if (!mpStream || mpStream->SvStream::GetError () != ERRCODE_NONE )
 328         throw ::css::io::NotConnectedException ( ::rtl::OUString(), const_cast < ::css::uno::XWeak * > ( static_cast < const ::css::uno::XWeak * > (this ) ) );
 329 }
 330 void OTempFileService::checkConnected ()
 331 {
 332     if (!mpStream && mpTempFile)
 333     {
 334         mpStream = mpTempFile->GetStream( STREAM_STD_READWRITE );
 335         if ( mpStream && mbHasCachedPos )
 336         {
 337             mpStream->Seek( sal::static_int_cast<sal_Size>(mnCachedPos) );
 338             if ( mpStream->SvStream::GetError () == ERRCODE_NONE )
 339             {
 340                 mbHasCachedPos = sal_False;
 341                 mnCachedPos = 0;
 342             }
 343             else
 344             {
 345                 mpStream = NULL;
 346                 mpTempFile->CloseStream();
 347             }
 348         }
 349     }
 350
 351     if (!mpStream)
 352         throw ::css::io::NotConnectedException ( ::rtl::OUString(), const_cast < ::css::uno::XWeak * > ( static_cast < const ::css::uno::XWeak * > (this ) ) );
 353 }
 354
 355 // XSeekable
 356
 357 void SAL_CALL OTempFileService::seek( sal_Int64 nLocation )
 358 throw ( ::css::lang::IllegalArgumentException, ::css::io::IOException, ::css::uno::RuntimeException )
 359 {
 360     ::osl::MutexGuard aGuard( maMutex );
 361     checkConnected();
 362     if ( nLocation < 0 || nLocation > getLength() )
 363         throw ::css::lang::IllegalArgumentException();
 364
 365     mpStream->Seek((sal_uInt32) nLocation );
 366     checkError();
 367 }
 368 sal_Int64 SAL_CALL OTempFileService::getPosition(  )
 369 throw ( ::css::io::IOException, ::css::uno::RuntimeException )
 370 {
 371     ::osl::MutexGuard aGuard( maMutex );
 372     checkConnected();
 373
 374     sal_uInt32 nPos = mpStream->Tell();
 375     checkError();
 376     return (sal_Int64)nPos;
 377 }
 378 sal_Int64 SAL_CALL OTempFileService::getLength(  )
 379 throw ( ::css::io::IOException, ::css::uno::RuntimeException )
 380 {
 381     ::osl::MutexGuard aGuard( maMutex );
 382     checkConnected();
 383
 384     sal_uInt32 nCurrentPos = mpStream->Tell();
 385     checkError();
 386
 387     mpStream->Seek(STREAM_SEEK_TO_END);
 388     sal_uInt32 nEndPos = mpStream->Tell();
 389     mpStream->Seek(nCurrentPos);
 390
 391     checkError();
 392
 393     return (sal_Int64)nEndPos;
 394 }
 395
 396
 397 // XStream
 398
 399 ::css::uno::Reference< ::css::io::XInputStream > SAL_CALL OTempFileService::getInputStream()
 400 throw ( ::css::uno::RuntimeException )
 401     {
 402     return ::css::uno::Reference< ::css::io::XInputStream >( *this, ::css::uno::UNO_QUERY );
 403 }
 404
 405 ::css::uno::Reference< ::css::io::XOutputStream > SAL_CALL OTempFileService::getOutputStream()
 406 throw ( ::css::uno::RuntimeException )
 407     {
 408     return ::css::uno::Reference< ::css::io::XOutputStream >( *this, ::css::uno::UNO_QUERY );
 409     }
 410
 411 // XTruncate
 412
 413 void SAL_CALL OTempFileService::truncate()
 414 throw ( ::css::io::IOException, ::css::uno::RuntimeException )
 415 {
 416     ::osl::MutexGuard aGuard( maMutex );
 417     checkConnected();
 418     // SetStreamSize() call does not change the position
 419     mpStream->Seek( 0 );
 420     mpStream->SetStreamSize( 0 );
 421     checkError();
 422 }
 423
 424 // XServiceInfo
 425
 426 ::rtl::OUString SAL_CALL OTempFileService::getImplementationName()
 427 throw ( ::css::uno::RuntimeException )
 428 {
 429     return getImplementationName_Static();
 430 }
 431
 432 sal_Bool SAL_CALL OTempFileService::supportsService( ::rtl::OUString const & rServiceName )
 433 throw ( ::css::uno::RuntimeException )
 434 {
 435     ::css::uno::Sequence< ::rtl::OUString > aServices(getSupportedServiceNames_Static());
 436     return rServiceName == aServices[0];
 437 }
 438
 439 ::css::uno::Sequence < ::rtl::OUString > SAL_CALL OTempFileService::getSupportedServiceNames()
 440 throw ( ::css::uno::RuntimeException )
 441 {
 442     return getSupportedServiceNames_Static();
 443 }
 444
 445
 446
 447 ::rtl::OUString OTempFileService::getImplementationName_Static ()
 448 {
 449     return ::rtl::OUString ( RTL_CONSTASCII_USTRINGPARAM ( "com.sun.star.io.comp.TempFile" ) );
 450 }
 451 ::css::uno::Sequence < ::rtl::OUString > OTempFileService::getSupportedServiceNames_Static()
 452 {
 453     ::css::uno::Sequence < ::rtl::OUString > aNames ( 1 );
 454     aNames[0] = ::rtl::OUString ( RTL_CONSTASCII_USTRINGPARAM ( "com.sun.star.io.TempFile" ) );
 455     return aNames;
 456 }
 457 ::css::uno::Reference < ::css::uno::XInterface >SAL_CALL XTempFile_createInstance(
 458     css::uno::Reference< ::css::uno::XComponentContext > const & context)
 459     SAL_THROW( ( css::uno::Exception ) )
 460 {
 461     return static_cast< ::cppu::OWeakObject * >( new OTempFileService(context) );
 462 }
 463
 464 ::css::uno::Reference < ::css::lang::XSingleComponentFactory > OTempFileService::createServiceFactory_Static()
 465 {
 466     return ::cppu::createSingleComponentFactory( XTempFile_createInstance, getImplementationName_Static(), getSupportedServiceNames_Static() );
 467 }
 468
 469 /**
 470  * This function is called to get service factories for an implementation.
 471  * @param pImplName name of implementation
 472  * @param pServiceManager generic uno interface providing a service manager to instantiate components
 473  * @param pRegistryKey registry data key to read and write component persistent data
 474  * @return a component factory (generic uno interface)
 475  */
 476 extern "C" SAL_DLLPUBLIC_EXPORT void * SAL_CALL utl_component_getFactory(
 477     const sal_Char * pImplName, void * pServiceManager,
 478     SAL_UNUSED_PARAMETER void * /*pRegistryKey*/ )
 479 {
 480     void * pRet = 0;
 481     ::css::uno::Reference< ::css::lang::XMultiServiceFactory > xSMgr(
 482         reinterpret_cast< ::css::lang::XMultiServiceFactory * >( pServiceManager ) );
 483     ::css::uno::Reference< ::css::lang::XSingleComponentFactory > xFactory;
 484
 485     if (OTempFileService::getImplementationName_Static().compareToAscii( pImplName ) == 0)
 486         xFactory = OTempFileService::createServiceFactory_Static();
 487
 488     if ( xFactory.is() )
 489     {
 490         xFactory->acquire();
 491         pRet = xFactory.get();
 492     }
 493     return pRet;
 494 }
 495
 496 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */