src/common/file.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        file.cpp
   3 // Purpose:     wxFile - encapsulates low-level "file descriptor"
   4 //              wxTempFile
   5 // Author:      Vadim Zeitlin
   6 // Modified by:
   7 // Created:     29/01/98
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
  10 // Licence:     wxWindows licence
  11 /////////////////////////////////////////////////////////////////////////////
  12
  13 // ----------------------------------------------------------------------------
  14 // headers
  15 // ----------------------------------------------------------------------------
  16
  17 // For compilers that support precompilation, includes "wx.h".
  18 #include "wx/wxprec.h"
  19
  20 #ifdef __BORLANDC__
  21   #pragma hdrstop
  22 #endif
  23
  24 #if wxUSE_FILE
  25
  26 // standard
  27 #if defined(__WXMSW__) && !defined(__GNUWIN32__) && !defined(__WXMICROWIN__) && !defined(__WXWINCE__)
  28
  29 #ifndef __SALFORDC__
  30     #define   WIN32_LEAN_AND_MEAN
  31     #define   NOSERVICE
  32     #define   NOIME
  33     #define   NOATOM
  34     #define   NOGDI
  35     #define   NOGDICAPMASKS
  36     #define   NOMETAFILE
  37     #define   NOMINMAX
  38     #define   NOMSG
  39     #define   NOOPENFILE
  40     #define   NORASTEROPS
  41     #define   NOSCROLL
  42     #define   NOSOUND
  43     #define   NOSYSMETRICS
  44     #define   NOTEXTMETRIC
  45     #define   NOWH
  46     #define   NOCOMM
  47     #define   NOKANJI
  48     #define   NOCRYPT
  49     #define   NOMCX
  50 #endif
  51
  52 #elif defined(__WXMSW__) && defined(__WXWINCE__)
  53     #include  "wx/msw/missing.h"
  54 #elif (defined(__OS2__))
  55     #include <io.h>
  56 #elif (defined(__UNIX__) || defined(__GNUWIN32__))
  57     #include  <unistd.h>
  58     #include  <time.h>
  59     #include  <sys/stat.h>
  60     #ifdef __GNUWIN32__
  61         #include "wx/msw/wrapwin.h"
  62     #endif
  63 #elif defined(__DOS__)
  64     #if defined(__WATCOMC__)
  65        #include <io.h>
  66     #elif defined(__DJGPP__)
  67        #include <io.h>
  68        #include <unistd.h>
  69        #include <stdio.h>
  70     #else
  71         #error  "Please specify the header with file functions declarations."
  72     #endif
  73 #elif (defined(__WXSTUBS__))
  74     // Have to ifdef this for different environments
  75     #include <io.h>
  76 #elif (defined(__WXMAC__))
  77 #if __MSL__ < 0x6000
  78     int access( const char *path, int mode ) { return 0 ; }
  79 #else
  80     int _access( const char *path, int mode ) { return 0 ; }
  81 #endif
  82     char* mktemp( char * path ) { return path ;}
  83     #include <stat.h>
  84     #include <unistd.h>
  85 #else
  86     #error  "Please specify the header with file functions declarations."
  87 #endif  //Win/UNIX
  88
  89 #include  <stdio.h>       // SEEK_xxx constants
  90
  91 // Windows compilers don't have these constants
  92 #ifndef W_OK
  93     enum
  94     {
  95         F_OK = 0,   // test for existence
  96         X_OK = 1,   //          execute permission
  97         W_OK = 2,   //          write
  98         R_OK = 4    //          read
  99     };
 100 #endif // W_OK
 101
 102 #ifdef __SALFORDC__
 103     #include <unix.h>
 104 #endif
 105
 106 // some broken compilers don't have 3rd argument in open() and creat()
 107 #ifdef __SALFORDC__
 108     #define ACCESS(access)
 109     #define stat    _stat
 110 #else // normal compiler
 111     #define ACCESS(access)  , (access)
 112 #endif // Salford C
 113
 114 // wxWidgets
 115 #ifndef WX_PRECOMP
 116     #include  "wx/string.h"
 117     #include  "wx/intl.h"
 118     #include  "wx/log.h"
 119 #endif // !WX_PRECOMP
 120
 121 #include  "wx/filename.h"
 122 #include  "wx/file.h"
 123 #include  "wx/filefn.h"
 124
 125 // there is no distinction between text and binary files under Unix, so define
 126 // O_BINARY as 0 if the system headers don't do it already
 127 #if defined(__UNIX__) && !defined(O_BINARY)
 128     #define   O_BINARY    (0)
 129 #endif  //__UNIX__
 130
 131 #ifdef __WXMSW__
 132     #include "wx/msw/mslu.h"
 133 #endif
 134
 135 #ifdef __WXWINCE__
 136     #include "wx/msw/private.h"
 137 #endif
 138
 139 #ifndef MAX_PATH
 140     #define MAX_PATH 512
 141 #endif
 142
 143 // ============================================================================
 144 // implementation of wxFile
 145 // ============================================================================
 146
 147 // ----------------------------------------------------------------------------
 148 // static functions
 149 // ----------------------------------------------------------------------------
 150
 151 bool wxFile::Exists(const wxString& name)
 152 {
 153     return wxFileExists(name);
 154 }
 155
 156 bool wxFile::Access(const wxString& name, OpenMode mode)
 157 {
 158     int how;
 159
 160     switch ( mode )
 161     {
 162         default:
 163             wxFAIL_MSG(wxT("bad wxFile::Access mode parameter."));
 164             // fall through
 165
 166         case read:
 167             how = R_OK;
 168             break;
 169
 170         case write:
 171             how = W_OK;
 172             break;
 173
 174         case read_write:
 175             how = R_OK | W_OK;
 176             break;
 177     }
 178
 179     return wxAccess(name, how) == 0;
 180 }
 181
 182 // ----------------------------------------------------------------------------
 183 // opening/closing
 184 // ----------------------------------------------------------------------------
 185
 186 // ctors
 187 wxFile::wxFile(const wxString& fileName, OpenMode mode)
 188 {
 189     m_fd = fd_invalid;
 190     m_error = false;
 191
 192     Open(fileName, mode);
 193 }
 194
 195 // create the file, fail if it already exists and bOverwrite
 196 bool wxFile::Create(const wxString& fileName, bool bOverwrite, int accessMode)
 197 {
 198     // if bOverwrite we create a new file or truncate the existing one,
 199     // otherwise we only create the new file and fail if it already exists
 200 #if defined(__WXMAC__) && !defined(__UNIX__) && !wxUSE_UNICODE
 201     // Dominic Mazzoni [dmazzoni+@cs.cmu.edu] reports that open is still broken on the mac, so we replace
 202     // int fd = open( fileName , O_CREAT | (bOverwrite ? O_TRUNC : O_EXCL), access);
 203     int fd = creat( fileName , accessMode);
 204 #else
 205     int fd = wxOpen( fileName,
 206                      O_BINARY | O_WRONLY | O_CREAT |
 207                      (bOverwrite ? O_TRUNC : O_EXCL)
 208                      ACCESS(accessMode) );
 209 #endif
 210     if ( fd == -1 )
 211     {
 212         wxLogSysError(_("can't create file '%s'"), fileName);
 213         return false;
 214     }
 215
 216     Attach(fd);
 217     return true;
 218 }
 219
 220 // open the file
 221 bool wxFile::Open(const wxString& fileName, OpenMode mode, int accessMode)
 222 {
 223     int flags = O_BINARY;
 224
 225     switch ( mode )
 226     {
 227         case read:
 228             flags |= O_RDONLY;
 229             break;
 230
 231         case write_append:
 232             if ( wxFile::Exists(fileName) )
 233             {
 234                 flags |= O_WRONLY | O_APPEND;
 235                 break;
 236             }
 237             //else: fall through as write_append is the same as write if the
 238             //      file doesn't exist
 239
 240         case write:
 241             flags |= O_WRONLY | O_CREAT | O_TRUNC;
 242             break;
 243
 244         case write_excl:
 245             flags |= O_WRONLY | O_CREAT | O_EXCL;
 246             break;
 247
 248         case read_write:
 249             flags |= O_RDWR;
 250             break;
 251     }
 252
 253 #ifdef __WINDOWS__
 254     // only read/write bits for "all" are supported by this function under
 255     // Windows, and VC++ 8 returns EINVAL if any other bits are used in
 256     // accessMode, so clear them as they have at best no effect anyhow
 257     accessMode &= wxS_IRUSR | wxS_IWUSR;
 258 #endif // __WINDOWS__
 259
 260     int fd = wxOpen( fileName, flags ACCESS(accessMode));
 261
 262     if ( fd == -1 )
 263     {
 264         wxLogSysError(_("can't open file '%s'"), fileName);
 265         return false;
 266     }
 267
 268     Attach(fd);
 269     return true;
 270 }
 271
 272 // close
 273 bool wxFile::Close()
 274 {
 275     if ( IsOpened() ) {
 276         if (wxClose(m_fd) == -1)
 277         {
 278             wxLogSysError(_("can't close file descriptor %d"), m_fd);
 279             m_fd = fd_invalid;
 280             return false;
 281         }
 282         else
 283             m_fd = fd_invalid;
 284     }
 285
 286     return true;
 287 }
 288
 289 // ----------------------------------------------------------------------------
 290 // read/write
 291 // ----------------------------------------------------------------------------
 292
 293 // read
 294 ssize_t wxFile::Read(void *pBuf, size_t nCount)
 295 {
 296     wxCHECK( (pBuf != NULL) && IsOpened(), 0 );
 297
 298     ssize_t iRc = wxRead(m_fd, pBuf, nCount);
 299
 300     if ( iRc == -1 )
 301     {
 302         wxLogSysError(_("can't read from file descriptor %d"), m_fd);
 303         return wxInvalidOffset;
 304     }
 305
 306     return iRc;
 307 }
 308
 309 // write
 310 size_t wxFile::Write(const void *pBuf, size_t nCount)
 311 {
 312     wxCHECK( (pBuf != NULL) && IsOpened(), 0 );
 313
 314     ssize_t iRc = wxWrite(m_fd, pBuf, nCount);
 315
 316     if ( iRc == -1 )
 317     {
 318         wxLogSysError(_("can't write to file descriptor %d"), m_fd);
 319         m_error = true;
 320         iRc = 0;
 321     }
 322
 323     return iRc;
 324 }
 325
 326 bool wxFile::Write(const wxString& s, const wxMBConv& conv)
 327 {
 328   const wxWX2MBbuf buf = s.mb_str(conv);
 329   if ( !buf )
 330       return false;
 331
 332   const size_t size = strlen(buf); // FIXME: use buf.length() when available
 333   return Write(buf, size) == size;
 334 }
 335
 336 // flush
 337 bool wxFile::Flush()
 338 {
 339 #ifdef HAVE_FSYNC
 340     // fsync() only works on disk files and returns errors for pipes, don't
 341     // call it then
 342     if ( IsOpened() && GetKind() == wxFILE_KIND_DISK )
 343     {
 344         if ( wxFsync(m_fd) == -1 )
 345         {
 346             wxLogSysError(_("can't flush file descriptor %d"), m_fd);
 347             return false;
 348         }
 349     }
 350 #endif // HAVE_FSYNC
 351
 352     return true;
 353 }
 354
 355 // ----------------------------------------------------------------------------
 356 // seek
 357 // ----------------------------------------------------------------------------
 358
 359 // seek
 360 wxFileOffset wxFile::Seek(wxFileOffset ofs, wxSeekMode mode)
 361 {
 362     wxASSERT_MSG( IsOpened(), _T("can't seek on closed file") );
 363     wxCHECK_MSG( ofs != wxInvalidOffset || mode != wxFromStart,
 364                  wxInvalidOffset,
 365                  _T("invalid absolute file offset") );
 366
 367     int origin;
 368     switch ( mode ) {
 369         default:
 370             wxFAIL_MSG(_T("unknown seek origin"));
 371
 372         case wxFromStart:
 373             origin = SEEK_SET;
 374             break;
 375
 376         case wxFromCurrent:
 377             origin = SEEK_CUR;
 378             break;
 379
 380         case wxFromEnd:
 381             origin = SEEK_END;
 382             break;
 383     }
 384
 385     wxFileOffset iRc = wxSeek(m_fd, ofs, origin);
 386     if ( iRc == wxInvalidOffset )
 387     {
 388         wxLogSysError(_("can't seek on file descriptor %d"), m_fd);
 389     }
 390
 391     return iRc;
 392 }
 393
 394 // get current file offset
 395 wxFileOffset wxFile::Tell() const
 396 {
 397     wxASSERT( IsOpened() );
 398
 399     wxFileOffset iRc = wxTell(m_fd);
 400     if ( iRc == wxInvalidOffset )
 401     {
 402         wxLogSysError(_("can't get seek position on file descriptor %d"), m_fd);
 403     }
 404
 405     return iRc;
 406 }
 407
 408 // get current file length
 409 wxFileOffset wxFile::Length() const
 410 {
 411     wxASSERT( IsOpened() );
 412
 413     wxFileOffset iRc = Tell();
 414     if ( iRc != wxInvalidOffset ) {
 415         // have to use const_cast :-(
 416         wxFileOffset iLen = ((wxFile *)this)->SeekEnd();
 417         if ( iLen != wxInvalidOffset ) {
 418             // restore old position
 419             if ( ((wxFile *)this)->Seek(iRc) == wxInvalidOffset ) {
 420                 // error
 421                 iLen = wxInvalidOffset;
 422             }
 423         }
 424
 425         iRc = iLen;
 426     }
 427
 428     if ( iRc == wxInvalidOffset )
 429     {
 430         wxLogSysError(_("can't find length of file on file descriptor %d"), m_fd);
 431     }
 432
 433     return iRc;
 434 }
 435
 436 // is end of file reached?
 437 bool wxFile::Eof() const
 438 {
 439     wxASSERT( IsOpened() );
 440
 441     wxFileOffset iRc;
 442
 443 #if defined(__DOS__) || defined(__UNIX__) || defined(__GNUWIN32__) || defined( __MWERKS__ ) || defined(__SALFORDC__)
 444     // @@ this doesn't work, of course, on unseekable file descriptors
 445     wxFileOffset ofsCur = Tell(),
 446     ofsMax = Length();
 447     if ( ofsCur == wxInvalidOffset || ofsMax == wxInvalidOffset )
 448         iRc = wxInvalidOffset;
 449     else
 450         iRc = ofsCur == ofsMax;
 451 #else  // Windows and "native" compiler
 452     iRc = wxEof(m_fd);
 453 #endif // Windows/Unix
 454
 455     if ( iRc == 1)
 456         {}
 457     else if ( iRc == 0 )
 458         return false;
 459     else if ( iRc == wxInvalidOffset )
 460         wxLogSysError(_("can't determine if the end of file is reached on descriptor %d"), m_fd);
 461     else
 462         wxFAIL_MSG(_T("invalid eof() return value."));
 463
 464     return true;
 465 }
 466
 467 // ============================================================================
 468 // implementation of wxTempFile
 469 // ============================================================================
 470
 471 // ----------------------------------------------------------------------------
 472 // construction
 473 // ----------------------------------------------------------------------------
 474
 475 wxTempFile::wxTempFile(const wxString& strName)
 476 {
 477     Open(strName);
 478 }
 479
 480 bool wxTempFile::Open(const wxString& strName)
 481 {
 482     // we must have an absolute filename because otherwise CreateTempFileName()
 483     // would create the temp file in $TMP (i.e. the system standard location
 484     // for the temp files) which might be on another volume/drive/mount and
 485     // wxRename()ing it later to m_strName from Commit() would then fail
 486     //
 487     // with the absolute filename, the temp file is created in the same
 488     // directory as this one which ensures that wxRename() may work later
 489     wxFileName fn(strName);
 490     if ( !fn.IsAbsolute() )
 491     {
 492         fn.Normalize(wxPATH_NORM_ABSOLUTE);
 493     }
 494
 495     m_strName = fn.GetFullPath();
 496
 497     m_strTemp = wxFileName::CreateTempFileName(m_strName, &m_file);
 498
 499     if ( m_strTemp.empty() )
 500     {
 501         // CreateTempFileName() failed
 502         return false;
 503     }
 504
 505 #ifdef __UNIX__
 506     // the temp file should have the same permissions as the original one
 507     mode_t mode;
 508
 509     wxStructStat st;
 510     if ( stat( (const char*) m_strName.fn_str(), &st) == 0 )
 511     {
 512         mode = st.st_mode;
 513     }
 514     else
 515     {
 516         // file probably didn't exist, just give it the default mode _using_
 517         // user's umask (new files creation should respect umask)
 518         mode_t mask = umask(0777);
 519         mode = 0666 & ~mask;
 520         umask(mask);
 521     }
 522
 523     if ( chmod( (const char*) m_strTemp.fn_str(), mode) == -1 )
 524     {
 525 #ifndef __OS2__
 526         wxLogSysError(_("Failed to set temporary file permissions"));
 527 #endif
 528     }
 529 #endif // Unix
 530
 531     return true;
 532 }
 533
 534 // ----------------------------------------------------------------------------
 535 // destruction
 536 // ----------------------------------------------------------------------------
 537
 538 wxTempFile::~wxTempFile()
 539 {
 540     if ( IsOpened() )
 541         Discard();
 542 }
 543
 544 bool wxTempFile::Commit()
 545 {
 546     m_file.Close();
 547
 548     if ( wxFile::Exists(m_strName) && wxRemove(m_strName) != 0 ) {
 549         wxLogSysError(_("can't remove file '%s'"), m_strName.c_str());
 550         return false;
 551     }
 552
 553     if ( !wxRenameFile(m_strTemp, m_strName)  ) {
 554         wxLogSysError(_("can't commit changes to file '%s'"), m_strName.c_str());
 555         return false;
 556     }
 557
 558     return true;
 559 }
 560
 561 void wxTempFile::Discard()
 562 {
 563     m_file.Close();
 564     if ( wxRemove(m_strTemp) != 0 )
 565         wxLogSysError(_("can't remove temporary file '%s'"), m_strTemp.c_str());
 566 }
 567
 568 #endif // wxUSE_FILE
 569