X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/61b027446e3ec6ffa2e49d25fd72f22e3cb0a880..9ca7505f1243ed1d2a2012caa09a52d41115c069:/src/common/file.cpp diff --git a/src/common/file.cpp b/src/common/file.cpp index 9011987266..b8d659f833 100644 --- a/src/common/file.cpp +++ b/src/common/file.cpp @@ -7,82 +7,142 @@ // Created: 29/01/98 // RCS-ID: $Id$ // Copyright: (c) 1998 Vadim Zeitlin -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// // ---------------------------------------------------------------------------- // headers // ---------------------------------------------------------------------------- -#ifdef __GNUG__ -#pragma implementation "file.h" +#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) + #pragma implementation "file.h" #endif // For compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" -#include "wx/defs.h" #ifdef __BORLANDC__ -#pragma hdrstop + #pragma hdrstop #endif +#if wxUSE_FILE + // standard -#if defined(__WINDOWS__) && !defined(__GNUWIN32__) - #include +#if defined(__WXMSW__) && !defined(__GNUWIN32__) && !defined(__WXMICROWIN__) && !defined(__WXWINCE__) + +#ifndef __SALFORDC__ + #define WIN32_LEAN_AND_MEAN + #define NOSERVICE + #define NOIME + #define NOATOM + #define NOGDI + #define NOGDICAPMASKS + #define NOMETAFILE + #define NOMINMAX + #define NOMSG + #define NOOPENFILE + #define NORASTEROPS + #define NOSCROLL + #define NOSOUND + #define NOSYSMETRICS + #define NOTEXTMETRIC + #define NOWH + #define NOCOMM + #define NOKANJI + #define NOCRYPT + #define NOMCX +#endif + +#elif defined(__WXMSW__) && defined(__WXWINCE__) + #include "wx/msw/missing.h" +#elif (defined(__OS2__)) + #include #elif (defined(__UNIX__) || defined(__GNUWIN32__)) - #include + #include + #include + #include + #ifdef __GNUWIN32__ + #include "wx/msw/wrapwin.h" + #endif +#elif defined(__DOS__) + #if defined(__WATCOMC__) + #include + #elif defined(__DJGPP__) + #include + #include + #include + #else + #error "Please specify the header with file functions declarations." + #endif +#elif (defined(__WXSTUBS__)) + // Have to ifdef this for different environments + #include +#elif (defined(__WXMAC__)) +#if __MSL__ < 0x6000 + int access( const char *path, int mode ) { return 0 ; } #else - #error "Please specify the header with file functions declarations." + int _access( const char *path, int mode ) { return 0 ; } +#endif + char* mktemp( char * path ) { return path ;} + #include + #include +#else + #error "Please specify the header with file functions declarations." #endif //Win/UNIX #include // SEEK_xxx constants -#include // O_RDONLY &c -#include // needed for stat -#include // stat - -// Microsoft compiler loves underscores, feed them to it -#ifdef _MSC_VER - // functions - #define open _open - #define close _close - #define read _read - #define write _write - #define lseek _lseek - #define fsync _commit - #define access _access - #define eof _eof - - // types - #define stat _stat - - // constants - #define O_RDONLY _O_RDONLY - #define O_WRONLY _O_WRONLY - #define O_RDWR _O_RDWR - #define O_EXCL _O_EXCL - #define O_CREAT _O_CREAT - #define O_BINARY _O_BINARY - - #define S_IFDIR _S_IFDIR - #define S_IFREG _S_IFREG - - #define S_IREAD _S_IREAD - #define S_IWRITE _S_IWRITE -#else - #define tell(fd) lseek(fd, 0, SEEK_CUR) -#endif //_MSC_VER -// there is no distinction between text and binary files under Unix -#ifdef __UNIX__ - #define O_BINARY (0) -#endif //__UNIX__ +// Windows compilers don't have these constants +#ifndef W_OK + enum + { + F_OK = 0, // test for existence + X_OK = 1, // execute permission + W_OK = 2, // write + R_OK = 4 // read + }; +#endif // W_OK + +// there is no distinction between text and binary files under Unix, so define +// O_BINARY as 0 if the system headers don't do it already +#if defined(__UNIX__) && !defined(O_BINARY) + #define O_BINARY (0) +#endif //__UNIX__ + +#ifdef __SALFORDC__ + #include +#endif -// wxWindows -#include -#include -#include -#include +#ifndef MAX_PATH + #define MAX_PATH 512 +#endif +// some broken compilers don't have 3rd argument in open() and creat() +#ifdef __SALFORDC__ + #define ACCESS(access) + #define stat _stat +#else // normal compiler + #define ACCESS(access) , (access) +#endif // Salford C + +// wxWidgets +#ifndef WX_PRECOMP + #include "wx/string.h" + #include "wx/intl.h" + #include "wx/log.h" +#endif // !WX_PRECOMP + +#include "wx/filename.h" +#include "wx/file.h" +#include "wx/filefn.h" + +#ifdef __WXMSW__ + #include "wx/msw/mslu.h" +#endif + +#ifdef __WXWINCE__ + #include "wx/msw/private.h" +#endif // ============================================================================ // implementation of wxFile @@ -91,10 +151,36 @@ // ---------------------------------------------------------------------------- // static functions // ---------------------------------------------------------------------------- -bool wxFile::Exists(const char *sz) -{ - struct stat st; - return !access(sz, 0) && !stat(sz, &st) && (st.st_mode & S_IFREG); + +bool wxFile::Exists(const wxChar *name) +{ + return wxFileExists(name); +} + +bool wxFile::Access(const wxChar *name, OpenMode mode) +{ + int how; + + switch ( mode ) + { + default: + wxFAIL_MSG(wxT("bad wxFile::Access mode parameter.")); + // fall through + + case read: + how = R_OK; + break; + + case write: + how = W_OK; + break; + + case read_write: + how = R_OK | W_OK; + break; + } + + return wxAccess(name, how) == 0; } // ---------------------------------------------------------------------------- @@ -102,85 +188,109 @@ bool wxFile::Exists(const char *sz) // ---------------------------------------------------------------------------- // ctors -wxFile::wxFile(const char *szFileName, OpenMode mode) +wxFile::wxFile(const wxChar *szFileName, OpenMode mode) { - m_fd = fd_invalid; + m_fd = fd_invalid; + m_error = false; - Open(szFileName, mode); -} - -// dtor -wxFile::~wxFile() -{ - Close(); + Open(szFileName, mode); } // create the file, fail if it already exists and bOverwrite -bool wxFile::Create(const char *szFileName, bool bOverwrite) +bool wxFile::Create(const wxChar *szFileName, bool bOverwrite, int accessMode) { - // if bOverwrite we create a new file or truncate the existing one, - // otherwise we only create the new file and fail if it already exists - int fd = open(szFileName, O_CREAT | (bOverwrite ? O_TRUNC : O_EXCL)); - - if ( fd == -1 ) { - wxLogSysError("can't create file '%s'", szFileName); - return FALSE; - } - else { - Attach(fd); - return TRUE; - } + // if bOverwrite we create a new file or truncate the existing one, + // otherwise we only create the new file and fail if it already exists +#if defined(__WXMAC__) && !defined(__UNIX__) && !wxUSE_UNICODE + // Dominic Mazzoni [dmazzoni+@cs.cmu.edu] reports that open is still broken on the mac, so we replace + // int fd = open( szFileName , O_CREAT | (bOverwrite ? O_TRUNC : O_EXCL), access); + int fd = creat( szFileName , accessMode); +#else + int fd = wxOpen( szFileName, + O_BINARY | O_WRONLY | O_CREAT | + (bOverwrite ? O_TRUNC : O_EXCL) + ACCESS(accessMode) ); +#endif + if ( fd == -1 ) + { + wxLogSysError(_("can't create file '%s'"), szFileName); + return false; + } + else + { + Attach(fd); + return true; + } } // open the file -bool wxFile::Open(const char *szFileName, OpenMode mode) +bool wxFile::Open(const wxChar *szFileName, OpenMode mode, int accessMode) { - int flags = O_BINARY; - - switch ( mode ) { - case read: - flags |= O_RDONLY; - break; - - case write: - flags |= O_WRONLY | O_CREAT | O_TRUNC; - break; - - case write_append: - flags |= O_WRONLY | O_APPEND; - break; - - case read_write: - flags |= O_RDWR; - break; - } - - int fd = open(szFileName, flags, S_IREAD | S_IWRITE); - - if ( fd == -1 ) { - wxLogSysError("can't open file '%s'", szFileName); - return FALSE; - } - else { - Attach(fd); - return TRUE; - } + int flags = O_BINARY; + + switch ( mode ) + { + case read: + flags |= O_RDONLY; + break; + + case write_append: + if ( wxFile::Exists(szFileName) ) + { + flags |= O_WRONLY | O_APPEND; + break; + } + //else: fall through as write_append is the same as write if the + // file doesn't exist + + case write: + flags |= O_WRONLY | O_CREAT | O_TRUNC; + break; + + case write_excl: + flags |= O_WRONLY | O_CREAT | O_EXCL; + break; + + case read_write: + flags |= O_RDWR; + break; + } + +#ifdef __WINDOWS__ + // only read/write bits for "all" are supported by this function under + // Windows, and VC++ 8 returns EINVAL if any other bits are used in + // accessMode, so clear them as they have at best no effect anyhow + accessMode &= wxS_IRUSR | wxS_IWUSR; +#endif // __WINDOWS__ + + int fd = wxOpen( szFileName, flags ACCESS(accessMode)); + + if ( fd == -1 ) + { + wxLogSysError(_("can't open file '%s'"), szFileName); + return false; + } + else { + Attach(fd); + return true; + } } // close bool wxFile::Close() { - if ( IsOpened() ) { - if ( close(m_fd) == -1 ) { - wxLogSysError("can't close file descriptor %d", m_fd); - m_fd = fd_invalid; - return FALSE; + if ( IsOpened() ) { + if (wxClose(m_fd) == -1) + { + wxLogSysError(_("can't close file descriptor %d"), m_fd); + m_fd = fd_invalid; + return false; + } + else + m_fd = fd_invalid; } - else - m_fd = fd_invalid; - } - return TRUE; + return true; } // ---------------------------------------------------------------------------- @@ -188,46 +298,52 @@ bool wxFile::Close() // ---------------------------------------------------------------------------- // read -off_t wxFile::Read(void *pBuf, off_t nCount) +size_t wxFile::Read(void *pBuf, size_t nCount) { - wxCHECK_RET( (pBuf != NULL) && IsOpened(), 0 ); - - int iRc = ::read(m_fd, pBuf, nCount); - if ( iRc == -1 ) { - wxLogSysError("can't read from file descriptor %d", m_fd); - return ofsInvalid; - } - else - return (uint)iRc; + wxCHECK( (pBuf != NULL) && IsOpened(), 0 ); + + int iRc = wxRead(m_fd, pBuf, nCount); + + if ( iRc == -1 ) { + wxLogSysError(_("can't read from file descriptor %d"), m_fd); + return (size_t)wxInvalidOffset; + } + else + return (size_t)iRc; } // write -bool wxFile::Write(const void *pBuf, uint nCount) +size_t wxFile::Write(const void *pBuf, size_t nCount) { - wxCHECK_RET( (pBuf != NULL) && IsOpened(), 0 ); - - int iRc = ::write(m_fd, pBuf, nCount); - if ( iRc == -1 ) { - wxLogSysError("can't write to file descriptor %d", m_fd); - return FALSE; - } - else - return TRUE; + wxCHECK( (pBuf != NULL) && IsOpened(), 0 ); + + int iRc = wxWrite(m_fd, pBuf, nCount); + + if ( iRc == -1 ) { + wxLogSysError(_("can't write to file descriptor %d"), m_fd); + m_error = true; + return 0; + } + else + return iRc; } // flush bool wxFile::Flush() { - if ( IsOpened() ) { - // @@@ fsync() is not ANSI (BSDish) -// if ( fsync(m_fd) == -1 ) { // TODO - if (TRUE) { - wxLogSysError("can't flush file descriptor %d", m_fd); - return FALSE; + if ( IsOpened() ) { +#if defined(__VISUALC__) || wxHAVE_FSYNC + if ( wxFsync(m_fd) == -1 ) + { + wxLogSysError(_("can't flush file descriptor %d"), m_fd); + return false; + } +#else // no fsync + // just do nothing +#endif // fsync } - } - return TRUE; + return true; } // ---------------------------------------------------------------------------- @@ -235,120 +351,119 @@ bool wxFile::Flush() // ---------------------------------------------------------------------------- // seek -off_t wxFile::Seek(off_t ofs, SeekMode mode) +wxFileOffset wxFile::Seek(wxFileOffset ofs, wxSeekMode mode) { - wxASSERT( IsOpened() ); - - int flag = -1; - switch ( mode ) { - case FromStart: - flag = SEEK_SET; - break; - - case FromCurrent: - flag = SEEK_CUR; - break; - - case FromEnd: - flag = SEEK_END; - break; - - default: - wxFAIL_MSG("unknown seek origin"); - } - - int iRc = lseek(m_fd, ofs, flag); - if ( iRc == -1 ) { - wxLogSysError("can't seek on file descriptor %d", m_fd); - return ofsInvalid; - } - else - return (off_t)iRc; + wxASSERT( IsOpened() ); + + int origin; + switch ( mode ) { + default: + wxFAIL_MSG(_("unknown seek origin")); + + case wxFromStart: + origin = SEEK_SET; + break; + + case wxFromCurrent: + origin = SEEK_CUR; + break; + + case wxFromEnd: + origin = SEEK_END; + break; + } + + if (ofs == wxInvalidOffset) + { + wxLogSysError(_("can't seek on file descriptor %d, large files support is not enabled."), m_fd); + return wxInvalidOffset; + } + wxFileOffset iRc = wxSeek(m_fd, ofs, origin); + if ( iRc == -1 ) { + wxLogSysError(_("can't seek on file descriptor %d"), m_fd); + return wxInvalidOffset; + } + else + return iRc; } -// get current off_t -off_t wxFile::Tell() const +// get current wxFileOffset +wxFileOffset wxFile::Tell() const { - wxASSERT( IsOpened() ); - - int iRc = tell(m_fd); - if ( iRc == -1 ) { - wxLogSysError("can't get seek position on file descriptor %d", m_fd); - return ofsInvalid; - } - else - return (off_t)iRc; + wxASSERT( IsOpened() ); + + wxFileOffset iRc = wxTell(m_fd); + if ( iRc == -1 ) { + wxLogSysError(_("can't get seek position on file descriptor %d"), m_fd); + return wxInvalidOffset; + } + else + return iRc; } // get current file length -off_t wxFile::Length() const +wxFileOffset wxFile::Length() const { - wxASSERT( IsOpened() ); + wxASSERT( IsOpened() ); - #ifdef _MSC_VER - int iRc = _filelength(m_fd); - #else - int iRc = tell(m_fd); + wxFileOffset iRc = Tell(); if ( iRc != -1 ) { - // @ have to use const_cast :-( - int iLen = ((wxFile *)this)->SeekEnd(); - if ( iLen != -1 ) { - // restore old position - if ( ((wxFile *)this)->Seek(iRc) == -1 ) { - // error - iLen = -1; + // @ have to use const_cast :-( + wxFileOffset iLen = ((wxFile *)this)->SeekEnd(); + if ( iLen != -1 ) { + // restore old position + if ( ((wxFile *)this)->Seek(iRc) == -1 ) { + // error + iLen = -1; + } } - } - iRc = iLen; + iRc = iLen; } - #endif //_MSC_VER - - if ( iRc == -1 ) { - wxLogSysError("can't find length of file on file descriptor %d", m_fd); - return ofsInvalid; - } - else - return (off_t)iRc; + if ( iRc == -1 ) { + wxLogSysError(_("can't find length of file on file descriptor %d"), m_fd); + return wxInvalidOffset; + } + else + return iRc; } // is end of file reached? bool wxFile::Eof() const { - wxASSERT( IsOpened() ); + wxASSERT( IsOpened() ); - int iRc; + int iRc; - #if defined(__UNIX__) || defined(__GNUWIN32__) +#if defined(__DOS__) || defined(__UNIX__) || defined(__GNUWIN32__) || defined( __MWERKS__ ) || defined(__SALFORDC__) // @@ this doesn't work, of course, on unseekable file descriptors - off_t ofsCur = Tell(), - ofsMax = Length(); - if ( ofsCur == ofsInvalid || ofsMax == ofsInvalid ) - iRc = -1; + wxFileOffset ofsCur = Tell(), + ofsMax = Length(); + if ( ofsCur == wxInvalidOffset || ofsMax == wxInvalidOffset ) + iRc = -1; else - iRc = ofsCur == ofsMax; - #else // Windows and "native" compiler - iRc = eof(m_fd); - #endif // Windows/Unix + iRc = ofsCur == ofsMax; +#else // Windows and "native" compiler + iRc = wxEof(m_fd); +#endif // Windows/Unix - switch ( iRc ) { - case 1: - break; + switch ( iRc ) { + case 1: + break; - case 0: - return FALSE; + case 0: + return false; - case -1: - wxLogSysError("can't determine if the end of file is reached on " - "descriptor %d", m_fd); - break; + case -1: + wxLogSysError(_("can't determine if the end of file is reached on descriptor %d"), m_fd); + break; - default: - wxFAIL_MSG("invalid eof() return value."); - } + default: + wxFAIL_MSG(_("invalid eof() return value.")); + } - return TRUE; + return true; } // ============================================================================ @@ -358,16 +473,64 @@ bool wxFile::Eof() const // ---------------------------------------------------------------------------- // construction // ---------------------------------------------------------------------------- + wxTempFile::wxTempFile(const wxString& strName) { - Open(strName); + Open(strName); } bool wxTempFile::Open(const wxString& strName) { - m_strName = strName; - m_strTemp = tmpnam(NULL); - return m_file.Open(m_strTemp, wxFile::write); + // we must have an absolute filename because otherwise CreateTempFileName() + // would create the temp file in $TMP (i.e. the system standard location + // for the temp files) which might be on another volume/drive/mount and + // wxRename()ing it later to m_strName from Commit() would then fail + // + // with the absolute filename, the temp file is created in the same + // directory as this one which ensures that wxRename() may work later + wxFileName fn(strName); + if ( !fn.IsAbsolute() ) + { + fn.Normalize(wxPATH_NORM_ABSOLUTE); + } + + m_strName = fn.GetFullPath(); + + m_strTemp = wxFileName::CreateTempFileName(m_strName, &m_file); + + if ( m_strTemp.empty() ) + { + // CreateTempFileName() failed + return false; + } + +#ifdef __UNIX__ + // the temp file should have the same permissions as the original one + mode_t mode; + + wxStructStat st; + if ( stat( (const char*) m_strName.fn_str(), &st) == 0 ) + { + mode = st.st_mode; + } + else + { + // file probably didn't exist, just give it the default mode _using_ + // user's umask (new files creation should respect umask) + mode_t mask = umask(0777); + mode = 0666 & ~mask; + umask(mask); + } + + if ( chmod( (const char*) m_strTemp.fn_str(), mode) == -1 ) + { +#ifndef __OS2__ + wxLogSysError(_("Failed to set temporary file permissions")); +#endif + } +#endif // Unix + + return true; } // ---------------------------------------------------------------------------- @@ -376,30 +539,33 @@ bool wxTempFile::Open(const wxString& strName) wxTempFile::~wxTempFile() { - if ( IsOpened() ) - Discard(); + if ( IsOpened() ) + Discard(); } bool wxTempFile::Commit() { - m_file.Close(); + m_file.Close(); - if ( wxFile::Exists(m_strName) && remove(m_strName) != 0 ) { - wxLogSysError("can't remove file '%s'", m_strName.c_str()); - return FALSE; - } + if ( wxFile::Exists(m_strName) && wxRemove(m_strName) != 0 ) { + wxLogSysError(_("can't remove file '%s'"), m_strName.c_str()); + return false; + } - if ( rename(m_strTemp, m_strName) != 0 ) { - wxLogSysError("can't commit changes to file '%s'", m_strName.c_str()); - return FALSE; - } + if ( !wxRenameFile(m_strTemp, m_strName) ) { + wxLogSysError(_("can't commit changes to file '%s'"), m_strName.c_str()); + return false; + } - return TRUE; + return true; } void wxTempFile::Discard() { - m_file.Close(); - if ( remove(m_strTemp) != 0 ) - wxLogSysError("can't remove temporary file '%s'", m_strTemp.c_str()); + m_file.Close(); + if ( wxRemove(m_strTemp) != 0 ) + wxLogSysError(_("can't remove temporary file '%s'"), m_strTemp.c_str()); } + +#endif // wxUSE_FILE +