configmgr/source/localbe/localoutputstream.cxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: localoutputstream.cxx,v $
  10  * $Revision: 1.8 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_configmgr.hxx"
  33 #include "localoutputstream.hxx"
  34 #include <rtl/ustrbuf.hxx>
  35 #include <com/sun/star/configuration/backend/InsufficientAccessRightsException.hpp>
  36
  37 namespace configmgr { namespace localbe {
  38
  39 //==============================================================================
  40
  41 //------------------------------------------------------------------------------
  42
  43 LocalOutputStream::LocalOutputStream(const rtl::OUString& aFileUrl)
  44     throw (backend::BackendAccessException, uno::RuntimeException)
  45 : mFileUrl(aFileUrl)
  46 , mTemporaryFileUrl(mFileUrl)
  47 , mWriteFile(NULL)
  48 {
  49     // First, ensure the directory where the file is supposed to be
  50     // put exists.
  51     mTemporaryFileUrl += rtl::OUString::createFromAscii("_tmp") ;
  52     rtl::OUString parentDirectory = FileHelper::getParentDir(aFileUrl) ;
  53
  54     if (osl::File::RC errorCode = FileHelper::mkdirs(parentDirectory))
  55     {
  56         rtl::OUStringBuffer message ;
  57         message.appendAscii("Cannot create directory \"") ;
  58         message.append(parentDirectory).appendAscii("\". Error is ") ;
  59         message.append(FileHelper::createOSLErrorString(errorCode));
  60         message.appendAscii(" [").append(sal_Int32(errorCode)).appendAscii("].") ;
  61
  62         rtl::OUString const sIOMsg = message.makeStringAndClear();
  63         uno::Any ioe = uno::makeAny(io::IOException(sIOMsg,0));
  64
  65         switch (errorCode)
  66         {
  67         case osl::File::E_ACCES:
  68         case osl::File::E_ROFS:
  69             message.appendAscii("Configuration LocalOutputStream - No Write Access: ");
  70             message.append(sIOMsg);
  71             throw backend::InsufficientAccessRightsException(message.makeStringAndClear(), NULL, ioe) ;
  72
  73         case osl::File::E_None: OSL_ASSERT(!"can't happen");
  74         default:
  75             message.appendAscii("Configuration LocalOutputStream - IO Error: ");
  76             message.append(sIOMsg);
  77             throw backend::BackendAccessException(message.makeStringAndClear(), NULL, ioe) ;
  78         }
  79     }
  80
  81     osl::File::remove(mTemporaryFileUrl) ;
  82     mWriteFile = new osl::File(mTemporaryFileUrl) ;
  83
  84     if (osl::File::RC errorCode = mWriteFile->open(OpenFlag_Write |  OpenFlag_Create) )
  85     {
  86         delete mWriteFile, mWriteFile = NULL;
  87
  88         rtl::OUStringBuffer message ;
  89         message.appendAscii("Cannot open file \"") ;
  90         message.append(mTemporaryFileUrl).appendAscii("\" for writing. ");
  91         message.appendAscii("Error is ").append(FileHelper::createOSLErrorString(errorCode));
  92         message.appendAscii(" [").append(sal_Int32(errorCode)).appendAscii("].") ;
  93
  94         rtl::OUString const sIOMsg = message.makeStringAndClear();
  95         uno::Any ioe = uno::makeAny(io::IOException(sIOMsg,0));
  96
  97         switch (errorCode)
  98         {
  99         case osl::File::E_EXIST: // take inability to remove as indicator of missing rights
 100         case osl::File::E_ACCES:
 101         case osl::File::E_ROFS:
 102             message.appendAscii("Configuration LocalOutputStream - No Write Access: ");
 103             message.append(sIOMsg);
 104             throw backend::InsufficientAccessRightsException(message.makeStringAndClear(), NULL, ioe) ;
 105
 106         case osl::File::E_None: OSL_ASSERT(!"can't happen");
 107         default:
 108             message.appendAscii("Configuration LocalOutputStream - IO Error: ");
 109             message.append(sIOMsg);
 110             throw backend::BackendAccessException(message.makeStringAndClear(), NULL, ioe) ;
 111         }
 112     }
 113     mTemporaryFile = new OSLOutputStreamWrapper(*mWriteFile) ;
 114 }
 115 //------------------------------------------------------------------------------
 116
 117 LocalOutputStream::~LocalOutputStream()
 118 {
 119     try
 120     {
 121         this->closeOutput();
 122     }
 123     catch (uno::Exception&)
 124     {
 125         OSL_ENSURE(false,"Exception from closing LocalOutputStream ignored.");
 126     }
 127
 128     delete mWriteFile;
 129 }
 130 //------------------------------------------------------------------------------
 131
 132 void LocalOutputStream::finishOutput()
 133     throw (backend::BackendAccessException, uno::RuntimeException)
 134 {
 135     if (mWriteFile)
 136     try
 137     {
 138         this->closeOutput();
 139         delete mWriteFile, mWriteFile = NULL;
 140
 141         FileHelper::replaceFile(mFileUrl, mTemporaryFileUrl) ;
 142     }
 143     catch (io::IOException& ioe)
 144     {
 145         rtl::OUStringBuffer message ;
 146         message.appendAscii("Configuration LocalOutputStream - IO Error: ");
 147         message.appendAscii("Cannot finish output to \"").append(mTemporaryFileUrl) ;
 148         message.appendAscii("\" or copy the result to \"").append(mFileUrl).appendAscii("\". ");
 149         message.appendAscii("Error is \"").append(ioe.Message).appendAscii("\". ");
 150         throw backend::BackendAccessException(message.makeStringAndClear(), *this, uno::makeAny(ioe));
 151     }
 152 }
 153 //------------------------------------------------------------------------------
 154
 155 inline
 156 uno::Reference<io::XOutputStream> LocalOutputStream::getOutputFile()
 157 {
 158     if (!mTemporaryFile.is())
 159     {
 160         throw io::NotConnectedException(
 161             rtl::OUString::createFromAscii("LocalOutputStream: no output file."),
 162             *this);
 163     }
 164     return mTemporaryFile;
 165 }
 166 //------------------------------------------------------------------------------
 167
 168 void SAL_CALL LocalOutputStream::writeBytes(const uno::Sequence<sal_Int8>& aData)
 169     throw (io::NotConnectedException,
 170             io::BufferSizeExceededException,
 171             io::IOException, uno::RuntimeException)
 172 {
 173     getOutputFile()->writeBytes(aData) ;
 174 }
 175 //------------------------------------------------------------------------------
 176
 177 void SAL_CALL LocalOutputStream::flush()
 178     throw (io::NotConnectedException,
 179             io::BufferSizeExceededException,
 180             io::IOException, uno::RuntimeException)
 181 {
 182     getOutputFile()->flush() ;
 183 }
 184 //------------------------------------------------------------------------------
 185
 186 void SAL_CALL LocalOutputStream::closeOutput()
 187     throw (io::NotConnectedException, io::BufferSizeExceededException,
 188             io::IOException, uno::RuntimeException)
 189 {
 190     if (mTemporaryFile.is())
 191     {
 192         mTemporaryFile->closeOutput() ;
 193
 194         mTemporaryFile.clear();
 195     }
 196 }
 197 //------------------------------------------------------------------------------
 198
 199 } } // configmgr.localbe