hphp/runtime/base/temp-file.cpp

   1 /*
   2    +----------------------------------------------------------------------+
   3    | HipHop for PHP                                                       |
   4    +----------------------------------------------------------------------+
   5    | Copyright (c) 2010-present Facebook, Inc. (http://www.facebook.com)  |
   6    +----------------------------------------------------------------------+
   7    | This source file is subject to version 3.01 of the PHP license,      |
   8    | that is bundled with this package in the file LICENSE, and is        |
   9    | available through the world-wide-web at the following url:           |
  10    | http://www.php.net/license/3_01.txt                                  |
  11    | If you did not receive a copy of the PHP license and are unable to   |
  12    | obtain it through the world-wide-web, please send a note to          |
  13    | license@php.net so we can mail you a copy immediately.               |
  14    +----------------------------------------------------------------------+
  15 */
  16
  17 #include "hphp/runtime/base/temp-file.h"
  18 #include "hphp/runtime/base/stat-cache.h"
  19 #include "hphp/runtime/base/runtime-error.h"
  20
  21 #include "hphp/util/logger.h"
  22
  23 namespace HPHP {
  24
  25 ///////////////////////////////////////////////////////////////////////////////
  26 // constructor and destructor
  27
  28 TempFile::TempFile(bool autoDelete /* = true */,
  29                    const String& wrapper_type,
  30                    const String& stream_type)
  31   : PlainFile(nullptr, false, wrapper_type, stream_type),
  32     m_autoDelete(autoDelete) {
  33   char path[PATH_MAX];
  34
  35   // open a temporary file
  36   snprintf(path, sizeof(path), "/tmp/XXXXXX");
  37   int fd = mkstemp(path);
  38   if (fd == -1) {
  39     raise_warning("Unable to open temporary file");
  40     return;
  41   }
  42   setFd(fd);
  43   m_stream = fdopen(fd, "r+");
  44   setName(path);
  45   m_rawName = std::string(path);
  46 }
  47
  48 TempFile::~TempFile() {
  49   closeImpl();
  50 }
  51
  52 void TempFile::sweep() {
  53   closeImpl();
  54   using std::string;
  55   m_rawName.~string();
  56   PlainFile::sweep();
  57 }
  58
  59 bool TempFile::open(const String& /*filename*/, const String& /*mode*/) {
  60   raise_fatal_error((std::string("cannot open a temp file ") +
  61                              getName()).c_str());
  62 }
  63
  64 bool TempFile::close() {
  65   invokeFiltersOnClose();
  66   return closeImpl();
  67 }
  68
  69 bool TempFile::closeImpl() {
  70   bool ret = true;
  71   s_pcloseRet = 0;
  72   if (!isClosed()) {
  73     assertx(valid());
  74     s_pcloseRet = ::fclose(m_stream);
  75     ret = (s_pcloseRet == 0);
  76     setIsClosed(true);
  77     m_stream = nullptr;
  78     setFd(-1);
  79   }
  80   if (!m_rawName.empty()) {
  81     if (m_autoDelete) {
  82       unlink(m_rawName.c_str());
  83     }
  84     m_rawName.clear();
  85   }
  86   File::closeImpl();
  87   return ret;
  88 }
  89
  90 bool TempFile::seek(int64_t offset, int whence /* = SEEK_SET */) {
  91   assertx(valid());
  92
  93   if (whence == SEEK_CUR) {
  94     off_t result = lseek(getFd(), 0, SEEK_CUR);
  95     if (result != (off_t)-1) {
  96       offset += result - (bufferedLen() + getPosition());
  97     }
  98     if (offset > 0 && offset < bufferedLen()) {
  99       setReadPosition(getReadPosition() + offset);
 100       setPosition(getPosition() + offset);
 101       return true;
 102     }
 103     offset += getPosition();
 104     whence = SEEK_SET;
 105   } else if (whence == SEEK_END) {
 106     if (getLength() == -1) {
 107       Logger::Verbose("%s/%d: error finding end of file", __FUNCTION__,
 108                        __LINE__);
 109       return false;
 110     }
 111     offset += getLength();
 112     whence = SEEK_SET;
 113   }
 114
 115   if (offset > getLength() || getLength() == -1) return false;
 116
 117   // invalidate the current buffer
 118   setWritePosition(0);
 119   setReadPosition(0);
 120   // clear the eof flag
 121   setEof(false);
 122   flush();
 123   // lseek instead of seek to be consistent with read
 124   off_t result = lseek(getFd(), offset, whence);
 125   setPosition(result);
 126   return result != (off_t)-1;
 127 }
 128
 129 int64_t TempFile::tell() {
 130   assertx(valid());
 131   if (getLength() < 0) return -1;
 132   return getPosition();
 133 }
 134
 135 bool TempFile::truncate(int64_t size) {
 136   assertx(valid());
 137   seek(size, SEEK_SET);
 138   return ftruncate(getFd(), size) == 0;
 139 }
 140
 141 int64_t TempFile::getLength() {
 142   struct stat sb;
 143   if (StatCache::lstat(File::TranslatePathWithFileCache(m_rawName).c_str(), &sb)) {
 144     Logger::Verbose("%s/%d: %s", __FUNCTION__, __LINE__,
 145                     folly::errnoStr(errno).c_str());
 146     // use fstat directly
 147     if (fstat(getFd(), &sb) != 0) return -1;
 148     return sb.st_size;
 149   }
 150   return sb.st_size;
 151 }
 152
 153 ///////////////////////////////////////////////////////////////////////////////
 154 }