blob: 80adcf2dc59f64e90d1779b5eb30ec436d93b638 [file] [log] [blame]
/**************************************************************
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
*************************************************************/
#include <string.h>
#include <limits.h>
#define INCL_PM
#define INCL_DOS
#define INCL_DOSERRORS
#include <svpm.h>
#include <tools/debug.hxx>
#include <tools/fsys.hxx>
#include <tools/stream.hxx>
// class FileBase
#include <osl/file.hxx>
using namespace osl;
// class FileBase
#ifndef _OSL_FILE_HXX_
#include <osl/file.hxx>
#endif
using namespace osl;
// -----------------------------------------------------------------------
// --------------
// - StreamData -
// --------------
class StreamData
{
public:
HFILE hFile;
sal_Bool bIsEof;
StreamData()
{
hFile = 0;
bIsEof = sal_True;
}
};
// -----------------------------------------------------------------------
sal_uIntPtr GetSvError( APIRET nPMError )
{
static struct { APIRET pm; sal_uIntPtr sv; } errArr[] =
{
{ ERROR_FILE_NOT_FOUND, SVSTREAM_FILE_NOT_FOUND },
{ ERROR_PATH_NOT_FOUND, SVSTREAM_PATH_NOT_FOUND },
{ ERROR_TOO_MANY_OPEN_FILES, SVSTREAM_TOO_MANY_OPEN_FILES },
{ ERROR_ACCESS_DENIED, SVSTREAM_ACCESS_DENIED },
{ ERROR_INVALID_ACCESS, SVSTREAM_INVALID_ACCESS },
{ ERROR_SHARING_VIOLATION, SVSTREAM_SHARING_VIOLATION },
{ ERROR_SHARING_BUFFER_EXCEEDED,SVSTREAM_SHARE_BUFF_EXCEEDED },
{ ERROR_CANNOT_MAKE, SVSTREAM_CANNOT_MAKE },
{ ERROR_INVALID_PARAMETER, SVSTREAM_INVALID_PARAMETER },
{ ERROR_DRIVE_LOCKED, SVSTREAM_LOCKING_VIOLATION },
{ ERROR_LOCK_VIOLATION, SVSTREAM_LOCKING_VIOLATION },
{ ERROR_FILENAME_EXCED_RANGE, SVSTREAM_INVALID_PARAMETER },
{ ERROR_ATOMIC_LOCK_NOT_SUPPORTED, SVSTREAM_INVALID_PARAMETER },
{ ERROR_READ_LOCKS_NOT_SUPPORTED, SVSTREAM_INVALID_PARAMETER },
{ 0xFFFF, SVSTREAM_GENERALERROR }
};
sal_uIntPtr nRetVal = SVSTREAM_GENERALERROR; // Standardfehler
int i=0;
do
{
if( errArr[i].pm == nPMError )
{
nRetVal = errArr[i].sv;
break;
}
i++;
}
while( errArr[i].pm != 0xFFFF );
return nRetVal;
}
/*************************************************************************
|*
|* SvFileStream::SvFileStream()
|*
|* Beschreibung STREAM.SDW
|* Ersterstellung OV 15.06.94
|* Letzte Aenderung OV 15.06.94
|*
*************************************************************************/
SvFileStream::SvFileStream( const String& rFileName, StreamMode nOpenMode )
{
bIsOpen = sal_False;
nLockCounter = 0;
bIsWritable = sal_False;
pInstanceData = new StreamData;
SetBufferSize( 8192 );
// convert URL to SystemPath, if necessary
::rtl::OUString aFileName, aNormPath;
if ( FileBase::getSystemPathFromFileURL( rFileName, aFileName ) != FileBase::E_None )
aFileName = rFileName;
Open( aFileName, nOpenMode );
}
/*************************************************************************
|*
|* SvFileStream::SvFileStream()
|*
|* Beschreibung STREAM.SDW
|* Ersterstellung OV 22.11.94
|* Letzte Aenderung OV 22.11.94
|*
*************************************************************************/
SvFileStream::SvFileStream()
{
bIsOpen = sal_False;
nLockCounter = 0;
bIsWritable = sal_False;
pInstanceData = new StreamData;
SetBufferSize( 8192 );
}
/*************************************************************************
|*
|* SvFileStream::~SvFileStream()
|*
|* Beschreibung STREAM.SDW
|* Ersterstellung OV 14.06.94
|* Letzte Aenderung OV 14.06.94
|*
*************************************************************************/
SvFileStream::~SvFileStream()
{
Close();
if( pInstanceData )
delete pInstanceData;
}
/*************************************************************************
|*
|* SvFileStream::GetFileHandle()
|*
|* Beschreibung STREAM.SDW
|* Ersterstellung OV 14.06.94
|* Letzte Aenderung OV 14.06.94
|*
*************************************************************************/
sal_uIntPtr SvFileStream::GetFileHandle() const
{
return (sal_uIntPtr)pInstanceData->hFile;
}
/*************************************************************************
|*
|* SvFileStream::IsA()
|*
|* Beschreibung STREAM.SDW
|* Ersterstellung OV 14.06.94
|* Letzte Aenderung OV 14.06.94
|*
*************************************************************************/
sal_uInt16 SvFileStream::IsA() const
{
return ID_FILESTREAM;
}
/*************************************************************************
|*
|* SvFileStream::GetData()
|*
|* Beschreibung STREAM.SDW, Prueft nicht Eof; IsEof danach rufbar
|* Ersterstellung OV 15.06.94
|* Letzte Aenderung OV 15.06.94
|*
*************************************************************************/
sal_uIntPtr SvFileStream::GetData( void* pData, sal_uIntPtr nSize )
{
#ifdef DBG_UTIL
ByteString aTraceStr( "SvFileStream::GetData(): " );
aTraceStr += ByteString::CreateFromInt64(nSize);
aTraceStr += " Bytes from ";
aTraceStr += ByteString(aFilename, osl_getThreadTextEncoding());
DBG_TRACE( aTraceStr.GetBuffer() );
#endif
sal_uIntPtr nCount = 0L;
if( IsOpen() )
{
APIRET nResult;
nResult = DosRead( pInstanceData->hFile,(PVOID)pData,nSize,&nCount );
if( nResult )
SetError(::GetSvError(nResult) );
}
return nCount;
}
/*************************************************************************
|*
|* SvFileStream::PutData()
|*
|* Beschreibung STREAM.SDW
|* Ersterstellung OV 15.06.94
|* Letzte Aenderung OV 15.06.94
|*
*************************************************************************/
sal_uIntPtr SvFileStream::PutData( const void* pData, sal_uIntPtr nSize )
{
#ifdef DBG_UTIL
ByteString aTraceStr( "SvFileStrean::PutData: " );
aTraceStr += ByteString::CreateFromInt64(nSize);
aTraceStr += " Bytes to ";
aTraceStr += ByteString(aFilename, osl_getThreadTextEncoding());
DBG_TRACE( aTraceStr.GetBuffer() );
#endif
sal_uIntPtr nCount = 0L;
if( IsOpen() )
{
APIRET nResult;
nResult = DosWrite( pInstanceData->hFile,(PVOID)pData,nSize,&nCount );
if( nResult )
SetError(::GetSvError(nResult) );
else if( !nCount )
SetError( SVSTREAM_DISK_FULL );
}
return nCount;
}
/*************************************************************************
|*
|* SvFileStream::SeekPos()
|*
|* Beschreibung STREAM.SDW
|* Ersterstellung OV 15.06.94
|* Letzte Aenderung OV 15.06.94
|*
*************************************************************************/
sal_uIntPtr SvFileStream::SeekPos( sal_uIntPtr nPos )
{
sal_uIntPtr nNewPos = 0L;
if( IsOpen() )
{
APIRET nResult;
if( nPos != STREAM_SEEK_TO_END )
nResult = DosSetFilePtr( pInstanceData->hFile,(long)nPos,
FILE_BEGIN, &nNewPos );
else
nResult = DosSetFilePtr( pInstanceData->hFile,0L,
FILE_END, &nNewPos );
if( nResult )
SetError(::GetSvError(nResult) );
}
else
SetError( SVSTREAM_GENERALERROR );
return nNewPos;
}
/*************************************************************************
|*
|* SvFileStream::Tell()
|*
|* Beschreibung STREAM.SDW
|* Ersterstellung OV 15.06.94
|* Letzte Aenderung OV 15.06.94
|*
*************************************************************************/
/*
sal_uIntPtr SvFileStream::Tell()
{
sal_uIntPtr nPos = 0L;
if( IsOpen() )
{
APIRET nResult;
nResult = DosSetFilePtr(pInstanceData->hFile,0L,FILE_CURRENT,&nPos);
if( nResult )
SetError(::GetSvError(nResult) );
}
return nPos;
}
*/
/*************************************************************************
|*
|* SvFileStream::FlushData()
|*
|* Beschreibung STREAM.SDW
|* Ersterstellung OV 15.06.94
|* Letzte Aenderung OV 15.06.94
|*
*************************************************************************/
void SvFileStream::FlushData()
{
if( IsOpen() )
{
APIRET nResult;
nResult = DosResetBuffer(pInstanceData->hFile );
if( nResult )
SetError(::GetSvError(nResult) );
}
}
/*************************************************************************
|*
|* SvFileStream::LockRange()
|*
|* Beschreibung STREAM.SDW
|* Ersterstellung OV 15.06.94
|* Letzte Aenderung OV 15.06.94
|*
*************************************************************************/
sal_Bool SvFileStream::LockRange( sal_uIntPtr nByteOffset, sal_uIntPtr nBytes )
{
sal_Bool bRetVal = sal_False;
if( IsOpen() )
{
APIRET nResult;
FILELOCK aLockArea, aUnlockArea;
aUnlockArea.lOffset = 0L;
aUnlockArea.lRange = 0L;
aLockArea.lOffset = (long)nByteOffset;
aLockArea.lRange = (long)nBytes;
nResult = DosSetFileLocks(pInstanceData->hFile,
&aUnlockArea, &aLockArea,
1000UL, // Zeit in ms bis Abbruch
0L // kein Atomic-Lock
);
if( nResult )
SetError(::GetSvError(nResult) );
else
bRetVal = sal_True;
}
return bRetVal;
}
/*************************************************************************
|*
|* SvFileStream::UnlockRange()
|*
|* Beschreibung STREAM.SDW
|* Ersterstellung OV 15.06.94
|* Letzte Aenderung OV 15.06.94
|*
*************************************************************************/
sal_Bool SvFileStream::UnlockRange( sal_uIntPtr nByteOffset, sal_uIntPtr nBytes )
{
sal_Bool bRetVal = sal_False;
if( IsOpen() )
{
APIRET nResult;
FILELOCK aLockArea, aUnlockArea;
aLockArea.lOffset = 0L;
aLockArea.lRange = 0L;
aUnlockArea.lOffset = (long)nByteOffset;
aUnlockArea.lRange = (long)nBytes;
nResult = DosSetFileLocks(pInstanceData->hFile,
&aUnlockArea, &aLockArea,
1000UL, // Zeit in ms bis Abbruch
0L // kein Atomic-Lock
);
if( nResult )
SetError(::GetSvError(nResult) );
else
bRetVal = sal_True;
}
return bRetVal;
}
/*************************************************************************
|*
|* SvFileStream::LockFile()
|*
|* Beschreibung STREAM.SDW
|* Ersterstellung OV 15.06.94
|* Letzte Aenderung OV 15.06.94
|*
*************************************************************************/
sal_Bool SvFileStream::LockFile()
{
sal_Bool bRetVal = sal_False;
if( !nLockCounter )
{
if( LockRange( 0L, LONG_MAX ) )
{
nLockCounter = 1;
bRetVal = sal_True;
}
}
else
{
nLockCounter++;
bRetVal = sal_True;
}
return bRetVal;
}
/*************************************************************************
|*
|* SvFileStream::UnlockFile()
|*
|* Beschreibung STREAM.SDW
|* Ersterstellung OV 15.06.94
|* Letzte Aenderung OV 15.06.94
|*
*************************************************************************/
sal_Bool SvFileStream::UnlockFile()
{
sal_Bool bRetVal = sal_False;
if( nLockCounter > 0)
{
if( nLockCounter == 1)
{
if( UnlockRange( 0L, LONG_MAX ) )
{
nLockCounter = 0;
bRetVal = sal_True;
}
}
else
{
nLockCounter--;
bRetVal = sal_True;
}
}
return bRetVal;
}
/*************************************************************************
|*
|* SvFileStream::Open()
|*
|* Beschreibung STREAM.SDW
|* Ersterstellung OV 15.06.94
|* Letzte Aenderung OV 15.06.94
|*
*************************************************************************/
#if 0
sal_Bool createLongNameEA ( const PCSZ pszPath, sal_uIntPtr ulAttributes, const String& aLongName );
#endif
void SvFileStream::Open( const String& rFilename, StreamMode nOpenMode )
{
String aParsedFilename;
#if 0
if ( Folder::IsAvailable() && (rFilename.Search('{') < 9) )
{
String aVirtualPart;
String aRealPart;
String aVirtualPath;
ItemIDPath aVirtualURL;
sal_uIntPtr nDivider = 0;
String aVirtualString(rFilename);
for (int x=aVirtualString.Len(); x>0; x--)
{
if (aVirtualString.Copy(x,1).Compare("}")==COMPARE_EQUAL)
{
nDivider = x;
break;
}
}
aVirtualPart = aVirtualString.Copy(0,nDivider+1);
aRealPart = aVirtualString.Copy(nDivider+2);
aVirtualURL = aVirtualPart;
aVirtualPath = aVirtualURL.GetHostNotationPath();
DirEntry aTempDirEntry(aVirtualPath);
aTempDirEntry += aRealPart;
aParsedFilename = aTempDirEntry.GetFull();
}
else
#endif // 0
{
aParsedFilename = rFilename;
}
Close();
SvStream::ClearBuffer();
sal_uIntPtr nActionTaken;
sal_uIntPtr nOpenAction = 0L;
sal_uIntPtr nShareBits = 0L;
sal_uIntPtr nReadWriteBits = 0L;
eStreamMode = nOpenMode;
eStreamMode &= ~STREAM_TRUNC; // beim ReOpen nicht cutten
nOpenMode |= STREAM_SHARE_DENYNONE; // definierten Zustand garantieren
// ********* Zugriffsflags ***********
if( nOpenMode & STREAM_SHARE_DENYNONE)
nShareBits = OPEN_SHARE_DENYNONE;
if( nOpenMode & STREAM_SHARE_DENYREAD)
nShareBits = OPEN_SHARE_DENYREAD;
if( nOpenMode & STREAM_SHARE_DENYWRITE)
nShareBits = OPEN_SHARE_DENYWRITE;
if( nOpenMode & STREAM_SHARE_DENYALL)
nShareBits = OPEN_SHARE_DENYREADWRITE;
if( (nOpenMode & STREAM_READ) )
{
if( nOpenMode & STREAM_WRITE )
nReadWriteBits |= OPEN_ACCESS_READWRITE;
else
{
nReadWriteBits |= OPEN_ACCESS_READONLY;
nOpenMode |= STREAM_NOCREATE;
}
}
else
nReadWriteBits |= OPEN_ACCESS_WRITEONLY;
if( nOpenMode & STREAM_NOCREATE )
{
// Datei nicht erzeugen
nOpenAction = OPEN_ACTION_FAIL_IF_NEW | OPEN_ACTION_OPEN_IF_EXISTS;
}
else
{
// Datei erzeugen, wenn nicht vorhanden
nOpenAction = OPEN_ACTION_CREATE_IF_NEW;
if( nOpenMode & STREAM_TRUNC )
// Auf Nullaenge kuerzen, wenn existiert
nOpenAction |= OPEN_ACTION_REPLACE_IF_EXISTS;
else
// Inhalt der Datei nicht wegwerfen
nOpenAction |= OPEN_ACTION_OPEN_IF_EXISTS;
}
#if 0 // YD
//
// resolves long FAT names used by OS2
//
sal_Bool bIsLongOS2=sal_False;
if (Folder::IsAvailable())
{
DirEntry aDirEntry(rFilename);
if (aDirEntry.IsLongNameOnFAT())
{
// in kurzen Pfad wandeln
ItemIDPath aItemIDPath(rFilename);
aParsedFilename = aItemIDPath.GetHostNotationPath();
bIsLongOS2 = sal_True;
}
}
#endif
aFilename = aParsedFilename;
ByteString aFileNameA( aFilename, gsl_getSystemTextEncoding());
FSysRedirector::DoRedirect( aFilename );
#ifdef DBG_UTIL
ByteString aTraceStr( "SvFileStream::Open(): " );
aTraceStr += aFileNameA;
DBG_TRACE( aTraceStr.GetBuffer() );
#endif
APIRET nRet = DosOpen( aFileNameA.GetBuffer(), &pInstanceData->hFile,
&nActionTaken, 0L, FILE_NORMAL, nOpenAction,
nReadWriteBits | nShareBits | OPEN_FLAGS_NOINHERIT, 0L);
if( nRet == ERROR_TOO_MANY_OPEN_FILES )
{
long nToAdd = 10;
sal_uIntPtr nCurMaxFH;
nRet = DosSetRelMaxFH( &nToAdd, &nCurMaxFH );
nRet = DosOpen( aFileNameA.GetBuffer(), &pInstanceData->hFile,
&nActionTaken, 0L, FILE_NORMAL, nOpenAction,
nReadWriteBits | nShareBits | OPEN_FLAGS_NOINHERIT, 0L);
}
// Bei Fehler pruefen, ob wir lesen duerfen
if( nRet==ERROR_ACCESS_DENIED || nRet==ERROR_SHARING_VIOLATION )
{
nReadWriteBits = OPEN_ACCESS_READONLY;
nRet = DosOpen( aFileNameA.GetBuffer(), &pInstanceData->hFile,
&nActionTaken, 0L, FILE_NORMAL, nOpenAction,
nReadWriteBits | nShareBits | OPEN_FLAGS_NOINHERIT, 0L);
}
if( nRet )
{
bIsOpen = sal_False;
SetError(::GetSvError(nRet) );
}
else
{
bIsOpen = sal_True;
pInstanceData->bIsEof = sal_False;
if( nReadWriteBits != OPEN_ACCESS_READONLY )
bIsWritable = sal_True;
}
#if 0
if (bIsOpen && bIsLongOS2)
{
//file schließen, da sonst createLongName u.U. nicht möglich
Close();
// erzeugtem File langen Namen geben
DirEntry aDirEntry(rFilename);
createLongNameEA(aFileNameA.GetBuffer(), FILE_NORMAL, aDirEntry.GetName());
// und wieder oeffnen
ReOpen();
}
#endif
}
/*************************************************************************
|*
|* SvFileStream::ReOpen()
|*
|* Beschreibung STREAM.SDW
|* Ersterstellung OV 15.06.94
|* Letzte Aenderung OV 15.06.94
|*
*************************************************************************/
void SvFileStream::ReOpen()
{
if( !bIsOpen && aFilename.Len() )
Open( aFilename, eStreamMode );
}
/*************************************************************************
|*
|* SvFileStream::Close()
|*
|* Beschreibung STREAM.SDW
|* Ersterstellung OV 15.06.94
|* Letzte Aenderung OV 15.06.94
|*
*************************************************************************/
void SvFileStream::Close()
{
if( IsOpen() )
{
#ifdef DBG_UTIL
ByteString aTraceStr( "SvFileStream::Close(): " );
aTraceStr += ByteString(aFilename, osl_getThreadTextEncoding());
DBG_TRACE( aTraceStr.GetBuffer() );
#endif
if( nLockCounter )
{
nLockCounter = 1;
UnlockFile();
}
Flush();
DosClose( pInstanceData->hFile );
}
bIsOpen = sal_False;
nLockCounter= 0;
bIsWritable = sal_False;
pInstanceData->bIsEof = sal_True;
SvStream::ClearBuffer();
SvStream::ClearError();
}
/*************************************************************************
|*
|* SvFileStream::ResetError()
|*
|* Beschreibung STREAM.SDW; Setzt Filepointer auf Dateianfang
|* Ersterstellung OV 15.06.94
|* Letzte Aenderung OV 15.06.94
|*
*************************************************************************/
void SvFileStream::ResetError()
{
SvStream::ClearError();
}
/*************************************************************************
|*
|* SvFileStream::SetSize()
|*
|* Beschreibung
|* Ersterstellung OV 19.10.95
|* Letzte Aenderung OV 19.10.95
|*
*************************************************************************/
void SvFileStream::SetSize( sal_uIntPtr nSize )
{
if( IsOpen() )
{
APIRET nRet = DosSetFileSize( pInstanceData->hFile, nSize );
if( nRet )
SetError( ::GetSvError( nRet ) );
}
}