src/CFile.cpp

   1 //
   2 // This file is part of the aMule Project.
   3 //
   4 // Copyright (c) 2003-2011 aMule Team ( admin@amule.org / http://www.amule.org )
   5 // Copyright (c) 1998-2011 Vadim Zeitlin ( zeitlin@dptmaths.ens-cachan.fr )
   6 //
   7 // Any parts of this program derived from the xMule, lMule or eMule project,
   8 // or contributed by third-party developers are copyrighted by their
   9 // respective authors.
  10 //
  11 // This program is free software; you can redistribute it and/or modify
  12 // it under the terms of the GNU General Public License as published by
  13 // the Free Software Foundation; either version 2 of the License, or
  14 // (at your option) any later version.
  15 //
  16 // This program is distributed in the hope that it will be useful,
  17 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 // GNU General Public License for more details.
  20 //
  21 // You should have received a copy of the GNU General Public License
  22 // along with this program; if not, write to the Free Software
  23 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301, USA
  24 //
  25
  26
  27 #include "CFile.h"              // Interface declarations.
  28 #include "Logger.h"             // Needed for AddDebugLogLineC
  29 #include <common/Path.h>        // Needed for CPath
  30
  31
  32 #ifdef HAVE_CONFIG_H
  33 #include "config.h"             // Needed for HAVE_SYS_PARAM_H
  34 #endif
  35
  36
  37 #ifdef HAVE_SYS_PARAM_H
  38 #include <sys/param.h>
  39 #endif
  40
  41 // standard
  42 #if defined(__WXMSW__) && !defined(__GNUWIN32__) && !defined(__WXWINE__) && !defined(__WXMICROWIN__)
  43 #       include <io.h>
  44 #       ifndef __SALFORDC__
  45 #               define   WIN32_LEAN_AND_MEAN
  46 #               define   NOSERVICE
  47 #               define   NOIME
  48 #               define   NOATOM
  49 #               define   NOGDI
  50 #               define   NOGDICAPMASKS
  51 #               define   NOMETAFILE
  52 #               define   NOMINMAX
  53 #               define   NOMSG
  54 #               define   NOOPENFILE
  55 #               define   NORASTEROPS
  56 #               define   NOSCROLL
  57 #               define   NOSOUND
  58 #               define   NOSYSMETRICS
  59 #               define   NOTEXTMETRIC
  60 #               define   NOWH
  61 #               define   NOCOMM
  62 #               define   NOKANJI
  63 #               define   NOCRYPT
  64 #               define   NOMCX
  65 #       endif
  66 #elif (defined(__UNIX__) || defined(__GNUWIN32__))
  67 #       ifdef __GNUWIN32__
  68 #               include <windows.h>
  69 #       endif
  70 #elif (defined(__WXPM__))
  71 #       include <io.h>
  72 #elif (defined(__WXSTUBS__))
  73         // Have to ifdef this for different environments
  74 #       include <io.h>
  75 #elif (defined(__WXMAC__))
  76 #if __MSL__ < 0x6000
  77 int access( const char *path, int mode ) { return 0 ; }
  78 #else
  79 int _access( const char *path, int mode ) { return 0 ; }
  80 #endif
  81 char* mktemp( char * path ) { return path ;}
  82 #       include <stat.h>
  83 #else
  84 #       error  "Please specify the header with file functions declarations."
  85 #endif  //Win/UNIX
  86
  87 // there is no distinction between text and binary files under Unix, so define
  88 // O_BINARY as 0 if the system headers don't do it already
  89 #if defined(__UNIX__) && !defined(O_BINARY)
  90 #       define   O_BINARY    (0)
  91 #endif  //__UNIX__
  92
  93 #ifdef __WXMSW__
  94 #include <wx/msw/mslu.h>
  95 #endif
  96
  97
  98 // The following defines handle different names across platforms,
  99 // and ensures that we use 64b IO on windows (only 32b by default).
 100 #ifdef __WXMSW__
 101         #define FLUSH_FD(x)                     _commit(x)
 102         #define SEEK_FD(x, y, z)                _lseeki64(x, y, z)
 103         #define TELL_FD(x)                      _telli64(x)
 104
 105         #if (__MSVCRT_VERSION__ < 0x0601)
 106                 //#warning MSCVRT-Version smaller than 6.01
 107                 #define STAT_FD(x, y)           _fstati64(x, y)
 108                 #define STAT_STRUCT             struct _stati64
 109         #else
 110                 #define STAT_FD(x, y)           _fstat64(x, y)
 111                 #define STAT_STRUCT             struct __stat64
 112         #endif
 113 #else
 114
 115 // We don't need to sync all meta-data, just the contents,
 116 // so use fdatasync when possible (see man fdatasync).
 117         #if defined(_POSIX_SYNCHRONIZED_IO) && (_POSIX_SYNCHRONIZED_IO > 0)
 118                 #define FLUSH_FD(x)             fdatasync(x)
 119         #else
 120                 #define FLUSH_FD(x)             fsync(x)
 121         #endif
 122
 123         #define SEEK_FD(x, y, z)                lseek(x, y, z)
 124         #define TELL_FD(x)                      wxTell(x)
 125         #define STAT_FD(x, y)                   fstat(x, y)
 126         #define STAT_STRUCT                     struct stat
 127 #endif
 128
 129
 130 // This function is used to check if a syscall failed, in that case
 131 // log an appropriate message containing the errno string.
 132 inline void syscall_check(
 133         bool check,
 134         const CPath& filePath,
 135         const wxString& what)
 136 {
 137         if (!check) {
 138                 AddDebugLogLineC(logCFile,
 139                         CFormat(wxT("Error when %s (%s): %s"))
 140                                 % what % filePath % wxSysErrorMsg());
 141         }
 142 }
 143
 144
 145 CSeekFailureException::CSeekFailureException(const wxString& desc)
 146         : CIOFailureException(wxT("SeekFailure"), desc)
 147 {}
 148
 149
 150 CFile::CFile()
 151         : m_fd(fd_invalid), m_safeWrite(false)
 152 {}
 153
 154
 155 CFile::CFile(const CPath& fileName, OpenMode mode)
 156         : m_fd(fd_invalid)
 157 {
 158         Open(fileName, mode);
 159 }
 160
 161
 162 CFile::CFile(const wxString& fileName, OpenMode mode)
 163         : m_fd(fd_invalid)
 164 {
 165         Open(fileName, mode);
 166 }
 167
 168
 169 CFile::~CFile()
 170 {
 171         if (IsOpened()) {
 172                 // If the writing gets aborted, dtor is still called.
 173                 // In this case do NOT replace the original file with the
 174                 // probably broken new one!
 175                 m_safeWrite = false;
 176                 Close();
 177         }
 178 }
 179
 180
 181 int CFile::fd() const
 182 {
 183         return m_fd;
 184 }
 185
 186
 187 bool CFile::IsOpened() const
 188 {
 189         return m_fd != fd_invalid;
 190 }
 191
 192
 193 const CPath& CFile::GetFilePath() const
 194 {
 195         return m_filePath;
 196 }
 197
 198
 199 bool CFile::Create(const CPath& path, bool overwrite, int accessMode)
 200 {
 201         if (!overwrite && path.FileExists()) {
 202                 return false;
 203         }
 204
 205         return Open(path, write, accessMode);
 206 }
 207
 208 bool CFile::Create(const wxString& path, bool overwrite, int accessMode)
 209 {
 210         return Create(CPath(path), overwrite, accessMode);
 211 }
 212
 213
 214 bool CFile::Open(const wxString& fileName, OpenMode mode, int accessMode)
 215 {
 216         MULE_VALIDATE_PARAMS(fileName.Length(), wxT("CFile: Cannot open, empty path."));
 217
 218         return Open(CPath(fileName), mode, accessMode);
 219 }
 220
 221
 222 bool CFile::Open(const CPath& fileName, OpenMode mode, int accessMode)
 223 {
 224         MULE_VALIDATE_PARAMS(fileName.IsOk(), wxT("CFile: Cannot open, empty path."));
 225         m_safeWrite = false;
 226         m_filePath = fileName;
 227
 228 #ifdef __linux__
 229         int flags = O_BINARY | O_LARGEFILE;
 230 #else
 231         int flags = O_BINARY;
 232 #endif
 233         switch ( mode ) {
 234                 case read:
 235                         flags |= O_RDONLY;
 236                         break;
 237
 238                 case write_append:
 239                         if (fileName.FileExists())
 240                         {
 241                                 flags |= O_WRONLY | O_APPEND;
 242                                 break;
 243                         }
 244                         //else: fall through as write_append is the same as write if the
 245                         //      file doesn't exist
 246
 247                 case write:
 248                         flags |= O_WRONLY | O_CREAT | O_TRUNC;
 249                         break;
 250
 251                 case write_safe:
 252                         flags |= O_WRONLY | O_CREAT | O_TRUNC;
 253                         m_filePath = m_filePath.AppendExt(wxT(".new"));
 254                         m_safeWrite = true;
 255                         break;
 256
 257                 case write_excl:
 258                         flags |= O_WRONLY | O_CREAT | O_EXCL;
 259                         break;
 260
 261                 case read_write:
 262                         flags |= O_RDWR;
 263                 break;
 264         }
 265
 266         if (IsOpened()) {
 267                 Close();
 268         }
 269
 270         // Windows needs wide character file names
 271 #ifdef __WXMSW__
 272         m_fd = _wopen(m_filePath.GetRaw().c_str(), flags, accessMode);
 273 #else
 274         Unicode2CharBuf tmpFileName = filename2char(m_filePath.GetRaw());
 275         wxASSERT_MSG(tmpFileName, wxT("Convertion failed in CFile::Open"));
 276         m_fd = open(tmpFileName, flags, accessMode);
 277 #endif
 278         syscall_check(m_fd != fd_invalid, m_filePath, wxT("opening file"));
 279
 280         return IsOpened();
 281 }
 282
 283
 284 void CFile::Reopen(OpenMode mode)
 285 {
 286         if (!Open(m_filePath, mode)) {
 287                 throw CIOFailureException(wxString(wxT("Error reopening file")));
 288         }
 289 }
 290
 291
 292 bool CFile::Close()
 293 {
 294         MULE_VALIDATE_STATE(IsOpened(), wxT("CFile: Cannot close closed file."));
 295
 296         bool closed = (close(m_fd) != -1);
 297         syscall_check(closed, m_filePath, wxT("closing file"));
 298
 299         m_fd = fd_invalid;
 300
 301         if (m_safeWrite) {
 302                 CPath filePathTemp(m_filePath);
 303                 m_filePath = m_filePath.RemoveExt();    // restore m_filePath for Reopen()
 304                 if (closed) {
 305                         closed = CPath::RenameFile(filePathTemp, m_filePath, true);
 306                 }
 307         }
 308
 309         return closed;
 310 }
 311
 312
 313 bool CFile::Flush()
 314 {
 315         MULE_VALIDATE_STATE(IsOpened(), wxT("CFile: Cannot flush closed file."));
 316
 317         bool flushed = (FLUSH_FD(m_fd) != -1);
 318         syscall_check(flushed, m_filePath, wxT("flushing file"));
 319
 320         return flushed;
 321 }
 322
 323
 324 sint64 CFile::doRead(void* buffer, size_t count) const
 325 {
 326         MULE_VALIDATE_PARAMS(buffer, wxT("CFile: Invalid buffer in read operation."));
 327         MULE_VALIDATE_STATE(IsOpened(), wxT("CFile: Cannot read from closed file."));
 328
 329         size_t totalRead = 0;
 330         while (totalRead < count) {
 331                 int current = ::read(m_fd, (char*)buffer + totalRead, count - totalRead);
 332
 333                 if (current == -1) {
 334                         // Read error, nothing we can do other than abort.
 335                         throw CIOFailureException(wxString(wxT("Error reading from file: ")) + wxSysErrorMsg());
 336                 } else if ((totalRead + current < count) && Eof()) {
 337                         // We may fail to read the specified count in a couple
 338                         // of situations: EOF and interrupts. The check for EOF
 339                         // is needed to avoid inf. loops.
 340                         break;
 341                 }
 342
 343                 totalRead += current;
 344         }
 345
 346         return totalRead;
 347 }
 348
 349
 350 sint64 CFile::doWrite(const void* buffer, size_t nCount)
 351 {
 352         MULE_VALIDATE_PARAMS(buffer, wxT("CFile: Invalid buffer in write operation."));
 353         MULE_VALIDATE_STATE(IsOpened(), wxT("CFile: Cannot write to closed file."));
 354
 355         sint64 result = ::write(m_fd, buffer, nCount);
 356
 357         if (result != (sint64)nCount) {
 358                 throw CIOFailureException(wxString(wxT("Error writing to file: ")) + wxSysErrorMsg());
 359         }
 360
 361         return result;
 362 }
 363
 364
 365 sint64 CFile::doSeek(sint64 offset) const
 366 {
 367         MULE_VALIDATE_STATE(IsOpened(), wxT("Cannot seek on closed file."));
 368         MULE_VALIDATE_PARAMS(offset >= 0, wxT("Invalid position, must be positive."));
 369
 370         sint64 result = SEEK_FD(m_fd, offset, SEEK_SET);
 371
 372         if (result == offset) {
 373                 return result;
 374         } else if (result == wxInvalidOffset) {
 375                 throw CSeekFailureException(wxString(wxT("Seeking failed: ")) + wxSysErrorMsg());
 376         } else {
 377                 throw CSeekFailureException(wxT("Seeking returned incorrect position"));
 378         }
 379 }
 380
 381
 382 uint64 CFile::GetPosition() const
 383 {
 384         MULE_VALIDATE_STATE(IsOpened(), wxT("Cannot get position in closed file."));
 385
 386         sint64 pos = TELL_FD(m_fd);
 387         if (pos == wxInvalidOffset) {
 388                 throw CSeekFailureException(wxString(wxT("Failed to retrieve position in file: ")) + wxSysErrorMsg());
 389         }
 390
 391         return pos;
 392 }
 393
 394
 395 uint64 CFile::GetLength() const
 396 {
 397         MULE_VALIDATE_STATE(IsOpened(), wxT("CFile: Cannot get length of closed file."));
 398
 399         STAT_STRUCT buf;
 400         if (STAT_FD(m_fd, &buf) == -1) {
 401                 throw CIOFailureException(wxString(wxT("Failed to retrieve length of file: ")) + wxSysErrorMsg());
 402         }
 403
 404         return buf.st_size;
 405 }
 406
 407
 408 uint64 CFile::GetAvailable() const
 409 {
 410         const uint64 length = GetLength();
 411         const uint64 position = GetPosition();
 412
 413         // Safely handle seeking past EOF
 414         if (position < length) {
 415                 return length - position;
 416         }
 417
 418         // File is at or after EOF
 419         return 0;
 420 }
 421
 422
 423 bool CFile::SetLength(uint64 new_len)
 424 {
 425         MULE_VALIDATE_STATE(IsOpened(), wxT("CFile: Cannot set length when no file is open."));
 426
 427 #ifdef __WXMSW__
 428 #ifdef _MSC_VER
 429 // MSVC has a 64bit version
 430         bool result = _chsize_s(m_fd, new_len) == 0;
 431 #else
 432 // MingW has an old runtime without it
 433         bool result = chsize(m_fd, new_len) == 0;
 434 #endif
 435 #else
 436         bool result = ftruncate(m_fd, new_len) != -1;
 437 #endif
 438
 439         syscall_check(result, m_filePath, wxT("truncating file"));
 440
 441         return result;
 442 }
 443 // File_checked_for_headers