aria2/src/DefaultBtProgressInfoFile.cc

/* <!-- copyright */
/*
 * aria2 - The high speed download utility
 *
 * Copyright (C) 2006 Tatsuhiro Tsujikawa
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 *
 * In addition, as a special exception, the copyright holders give
 * permission to link the code of portions of this program with the
 * OpenSSL library under certain conditions as described in each
 * individual source file, and distribute linked combinations
 * including the two.
 * You must obey the GNU General Public License in all respects
 * for all of the code used other than OpenSSL.  If you modify
 * file(s) with this exception, you may extend this exception to your
 * version of the file(s), but you are not obligated to do so.  If you
 * do not wish to do so, delete this exception statement from your
 * version.  If you delete this exception statement from all source
 * files in the program, then also delete it here.
 */
/* copyright --> */
#include "DefaultBtProgressInfoFile.h"

#include <cstring>
#include <cstdio>

#include "PieceStorage.h"
#include "Piece.h"
#include "BitfieldMan.h"
#include "Option.h"
#include "TransferStat.h"
#include "LogFactory.h"
#include "Logger.h"
#include "prefs.h"
#include "DlAbortEx.h"
#include "message.h"
#include "File.h"
#include "util.h"
#include "a2io.h"
#include "DownloadFailureException.h"
#include "fmt.h"
#include "array_fun.h"
#include "DownloadContext.h"
#ifdef ENABLE_BITTORRENT
# include "PeerStorage.h"
# include "BtRuntime.h"
# include "bittorrent_helper.h"
#endif // ENABLE_BITTORRENT

namespace aria2 {

const std::string DefaultBtProgressInfoFile::V0000("0000");
const std::string DefaultBtProgressInfoFile::V0001("0001");

namespace {
std::string createFilename
(const SharedHandle<DownloadContext>& dctx, const std::string& suffix)
{
  std::string t = dctx->getBasePath();
  t += suffix;
  return t;
}
} // namespace

DefaultBtProgressInfoFile::DefaultBtProgressInfoFile
(const SharedHandle<DownloadContext>& dctx,
 const PieceStorageHandle& pieceStorage,
 const Option* option)
  : dctx_(dctx),
    pieceStorage_(pieceStorage),
    option_(option),
    filename_(createFilename(dctx_, getSuffix()))
{}

DefaultBtProgressInfoFile::~DefaultBtProgressInfoFile() {}

void DefaultBtProgressInfoFile::updateFilename()
{
  filename_ = createFilename(dctx_, getSuffix());
}

bool DefaultBtProgressInfoFile::isTorrentDownload()
{
#ifdef ENABLE_BITTORRENT
  return btRuntime_;
#else // !ENABLE_BITTORRENT
  return false;
#endif // !ENABLE_BITTORRENT
}

#define FWRITE_CHECK(ptr, count, fp)                                    \
  if(fwrite((ptr), 1, (count), (fp)) != (count)) {                      \
    fclose(fp);                                                         \
    throw DL_ABORT_EX                                                   \
      (fmt(EX_SEGMENT_FILE_WRITE, utf8ToNative(filename_).c_str()));    \
  }

// Since version 0001, Integers are saved in binary form, network byte order.
void DefaultBtProgressInfoFile::save()
{
  A2_LOG_INFO(fmt(MSG_SAVING_SEGMENT_FILE, utf8ToNative(filename_).c_str()));
  std::string filenameTemp = filename_+"__temp";
  {
    FILE* fp = a2fopen(utf8ToWChar(filenameTemp).c_str(), "wb");
    if(!fp) {
      throw DL_ABORT_EX
        (fmt(EX_SEGMENT_FILE_WRITE, utf8ToNative(filename_).c_str()));
    }
#ifdef ENABLE_BITTORRENT
    bool torrentDownload = isTorrentDownload();
#else // !ENABLE_BITTORRENT
    bool torrentDownload = false;
#endif // !ENABLE_BITTORRENT
    // file version: 16 bits
    // values: '1'
    char version[] = { 0x00u, 0x01u };
    FWRITE_CHECK(version, sizeof(version), fp);
    // extension: 32 bits
    // If this is BitTorrent download, then 0x00000001
    // Otherwise, 0x00000000
    char extension[4];
    memset(extension, 0, sizeof(extension));
    if(torrentDownload) {
      extension[3] = 1;
    }
    FWRITE_CHECK(extension, sizeof(extension), fp);
    if(torrentDownload) {
#ifdef ENABLE_BITTORRENT
      // infoHashLength:
      // length: 32 bits
      const unsigned char* infoHash = bittorrent::getInfoHash(dctx_);
      uint32_t infoHashLengthNL = htonl(INFO_HASH_LENGTH);
      FWRITE_CHECK(&infoHashLengthNL, sizeof(infoHashLengthNL), fp);
      // infoHash:
      FWRITE_CHECK(infoHash, INFO_HASH_LENGTH, fp);
#endif // ENABLE_BITTORRENT
    } else {
      // infoHashLength:
      // length: 32 bits
      uint32_t infoHashLength = 0;
      FWRITE_CHECK(&infoHashLength, sizeof(infoHashLength), fp);
    }
    // pieceLength: 32 bits
    uint32_t pieceLengthNL = htonl(dctx_->getPieceLength());
    FWRITE_CHECK(&pieceLengthNL, sizeof(pieceLengthNL), fp);
    // totalLength: 64 bits
    uint64_t totalLengthNL = hton64(dctx_->getTotalLength());
    FWRITE_CHECK(&totalLengthNL, sizeof(totalLengthNL), fp);
    // uploadLength: 64 bits
    uint64_t uploadLengthNL = 0;
#ifdef ENABLE_BITTORRENT
    if(torrentDownload) {
      TransferStat stat = peerStorage_->calculateStat();
      uploadLengthNL = hton64(stat.getAllTimeUploadLength());
    }
#endif // ENABLE_BITTORRENT
    FWRITE_CHECK(&uploadLengthNL, sizeof(uploadLengthNL), fp);
    // bitfieldLength: 32 bits
    uint32_t bitfieldLengthNL = htonl(pieceStorage_->getBitfieldLength());
    FWRITE_CHECK(&bitfieldLengthNL, sizeof(bitfieldLengthNL), fp);
    // bitfield
    FWRITE_CHECK(pieceStorage_->getBitfield(),
                 pieceStorage_->getBitfieldLength(), fp);
    // the number of in-flight piece: 32 bits
    // TODO implement this
    uint32_t numInFlightPieceNL = htonl(pieceStorage_->countInFlightPiece());
    FWRITE_CHECK(&numInFlightPieceNL, sizeof(numInFlightPieceNL), fp);
    std::vector<SharedHandle<Piece> > inFlightPieces;
    inFlightPieces.reserve(pieceStorage_->countInFlightPiece());
    pieceStorage_->getInFlightPieces(inFlightPieces);
    for(std::vector<SharedHandle<Piece> >::const_iterator itr =
          inFlightPieces.begin(), eoi = inFlightPieces.end();
        itr != eoi; ++itr) {
      uint32_t indexNL = htonl((*itr)->getIndex());
      FWRITE_CHECK(&indexNL, sizeof(indexNL), fp);
      uint32_t lengthNL = htonl((*itr)->getLength());
      FWRITE_CHECK(&lengthNL, sizeof(lengthNL), fp);
      uint32_t bitfieldLengthNL = htonl((*itr)->getBitfieldLength());
      FWRITE_CHECK(&bitfieldLengthNL, sizeof(bitfieldLengthNL), fp);
      FWRITE_CHECK((*itr)->getBitfield(), (*itr)->getBitfieldLength(), fp);
    }
    if(fclose(fp) == EOF) {
      throw DL_ABORT_EX
        (fmt(EX_SEGMENT_FILE_WRITE, utf8ToNative(filename_).c_str()));
    }
    A2_LOG_INFO(MSG_SAVED_SEGMENT_FILE);
  }
  if(!File(filenameTemp).renameTo(filename_)) {
    throw DL_ABORT_EX
      (fmt(EX_SEGMENT_FILE_WRITE, utf8ToNative(filename_).c_str()));
  }
}

#define FREAD_CHECK(ptr, count, fp)                                     \
  if(fread((ptr), 1, (count), (fp)) != (count)) {                       \
    throw DL_ABORT_EX(fmt(EX_SEGMENT_FILE_READ,                         \
                          utf8ToNative(filename_).c_str()));            \
  }

// It is assumed that integers are saved as:
// 1) host byte order if version == 0000
// 2) network byte order if version == 0001
void DefaultBtProgressInfoFile::load() 
{
  A2_LOG_INFO(fmt(MSG_LOADING_SEGMENT_FILE, utf8ToNative(filename_).c_str()));
  FILE* fp = a2fopen(utf8ToWChar(filename_).c_str(), "rb");
  if(!fp) {
    throw DL_ABORT_EX(fmt(EX_SEGMENT_FILE_READ,
                          utf8ToNative(filename_).c_str()));
  }
  auto_delete_r<FILE*, int> deleter(fp, fclose);
  unsigned char versionBuf[2];
  FREAD_CHECK(versionBuf, sizeof(versionBuf), fp);
  std::string versionHex = util::toHex(versionBuf, sizeof(versionBuf));
  int version;
  if(DefaultBtProgressInfoFile::V0000 == versionHex) {
    version = 0;
  } else if(DefaultBtProgressInfoFile::V0001 == versionHex) {
    version = 1;
  } else {
    throw DL_ABORT_EX
      (fmt("Unsupported ctrl file version: %s",
           versionHex.c_str()));
  }
  unsigned char extension[4];
  FREAD_CHECK(extension, sizeof(extension), fp);
  bool infoHashCheckEnabled = false;
  if(extension[3]&1 && isTorrentDownload()) {
    infoHashCheckEnabled = true;
    A2_LOG_DEBUG("InfoHash checking enabled.");
  }

  uint32_t infoHashLength;
  FREAD_CHECK(&infoHashLength, sizeof(infoHashLength), fp);
  if(version >= 1) {
    infoHashLength = ntohl(infoHashLength);
  }
  if((infoHashLength < 0) ||
     ((infoHashLength == 0) && infoHashCheckEnabled)) {
    throw DL_ABORT_EX
      (fmt("Invalid info hash length: %d", infoHashLength));
  }
  if(infoHashLength > 0) {
    array_ptr<unsigned char> savedInfoHash(new unsigned char[infoHashLength]);
    FREAD_CHECK(static_cast<unsigned char*>(savedInfoHash),
                infoHashLength, fp);
#ifdef ENABLE_BITTORRENT
    if(infoHashCheckEnabled) {
      const unsigned char* infoHash = bittorrent::getInfoHash(dctx_);
      if(infoHashLength != INFO_HASH_LENGTH ||
         memcmp(savedInfoHash, infoHash, INFO_HASH_LENGTH) != 0) {
        throw DL_ABORT_EX
          (fmt("info hash mismatch. expected: %s, actual: %s",
               util::toHex(infoHash, INFO_HASH_LENGTH).c_str(),
               util::toHex(savedInfoHash, infoHashLength).c_str()
               ));
      }
    }
#endif // ENABLE_BITTORRENT
  }

  uint32_t pieceLength;
  FREAD_CHECK(&pieceLength, sizeof(pieceLength), fp);
  if(version >= 1) {
    pieceLength = ntohl(pieceLength);
  }

  uint64_t totalLength;
  FREAD_CHECK(&totalLength, sizeof(totalLength), fp);
  if(version >= 1) {
    totalLength = ntoh64(totalLength);
  }
  if(totalLength != dctx_->getTotalLength()) {
    throw DL_ABORT_EX
      (fmt("total length mismatch. expected: %s, actual: %s",
           util::itos(dctx_->getTotalLength()).c_str(),
           util::itos(totalLength).c_str()));
  }
  uint64_t uploadLength;
  FREAD_CHECK(&uploadLength, sizeof(uploadLength), fp);
  if(version >= 1) {
    uploadLength = ntoh64(uploadLength);
  }
#ifdef ENABLE_BITTORRENT
  if(isTorrentDownload()) {
    btRuntime_->setUploadLengthAtStartup(uploadLength);
  }
#endif // ENABLE_BITTORRENT
  // TODO implement the conversion mechanism between different piece length.
  uint32_t bitfieldLength;
  FREAD_CHECK(&bitfieldLength, sizeof(bitfieldLength), fp);
  if(version >= 1) {
    bitfieldLength = ntohl(bitfieldLength);
  }
  uint32_t expectedBitfieldLength =
    ((totalLength+pieceLength-1)/pieceLength+7)/8;
  if(expectedBitfieldLength != bitfieldLength) {
    throw DL_ABORT_EX
      (fmt("bitfield length mismatch. expected: %d, actual: %d",
           expectedBitfieldLength,
           bitfieldLength));
  }

  array_ptr<unsigned char> savedBitfield(new unsigned char[bitfieldLength]);
  FREAD_CHECK(static_cast<unsigned char*>(savedBitfield),
              bitfieldLength, fp);
  if(pieceLength == dctx_->getPieceLength()) {
    pieceStorage_->setBitfield(savedBitfield, bitfieldLength);

    uint32_t numInFlightPiece;
    FREAD_CHECK(&numInFlightPiece, sizeof(numInFlightPiece), fp);
    if(version >= 1) {
      numInFlightPiece = ntohl(numInFlightPiece);
    }
    std::vector<SharedHandle<Piece> > inFlightPieces;
    inFlightPieces.reserve(numInFlightPiece);
    while(numInFlightPiece--) {
      uint32_t index;
      FREAD_CHECK(&index, sizeof(index), fp);
      if(version >= 1) {
        index = ntohl(index);
      }
      if(!(index < dctx_->getNumPieces())) {
        throw DL_ABORT_EX
          (fmt("piece index out of range: %u", index));
      }
      uint32_t length;
      FREAD_CHECK(&length, sizeof(length), fp);
      if(version >= 1) {
        length = ntohl(length);
      }
      if(!(length <=dctx_->getPieceLength())) {
        throw DL_ABORT_EX
          (fmt("piece length out of range: %u", length));
      }
      SharedHandle<Piece> piece(new Piece(index, length));
      uint32_t bitfieldLength;
      FREAD_CHECK(&bitfieldLength, sizeof(bitfieldLength), fp);
      if(version >= 1) {
        bitfieldLength = ntohl(bitfieldLength);
      }
      if(piece->getBitfieldLength() != bitfieldLength) {
        throw DL_ABORT_EX
          (fmt("piece bitfield length mismatch."
               " expected: %lu actual: %u",
               static_cast<unsigned long>(piece->getBitfieldLength()),
               bitfieldLength));
      }
      array_ptr<unsigned char> pieceBitfield
        (new unsigned char[bitfieldLength]);
      FREAD_CHECK(static_cast<unsigned char*>(pieceBitfield),
                  bitfieldLength, fp);
      piece->setBitfield(pieceBitfield, bitfieldLength);

#ifdef ENABLE_MESSAGE_DIGEST

      piece->setHashType(dctx_->getPieceHashType());

#endif // ENABLE_MESSAGE_DIGEST
        
      inFlightPieces.push_back(piece);
    }
    pieceStorage_->addInFlightPiece(inFlightPieces);
  } else {
    uint32_t numInFlightPiece;
    FREAD_CHECK(&numInFlightPiece, sizeof(numInFlightPiece), fp);
    if(version >= 1) {
      numInFlightPiece = ntohl(numInFlightPiece);
    }
    BitfieldMan src(pieceLength, totalLength);
    src.setBitfield(savedBitfield, bitfieldLength);
    if((src.getCompletedLength() || numInFlightPiece) &&
       !option_->getAsBool(PREF_ALLOW_PIECE_LENGTH_CHANGE)) {
      throw DOWNLOAD_FAILURE_EXCEPTION2
        ("WARNING: Detected a change in piece length. You can proceed with"
         " --allow-piece-length-change=true, but you may lose some download"
         " progress.",
         error_code::PIECE_LENGTH_CHANGED);
    }
    BitfieldMan dest(dctx_->getPieceLength(), totalLength);
    util::convertBitfield(&dest, &src);
    pieceStorage_->setBitfield(dest.getBitfield(), dest.getBitfieldLength());
  }
  A2_LOG_INFO(MSG_LOADED_SEGMENT_FILE);
}

void DefaultBtProgressInfoFile::removeFile()
{
  if(exists()) {
    File f(filename_);
    f.remove();
  }
}

bool DefaultBtProgressInfoFile::exists()
{
  File f(filename_);
  if(f.isFile()) {
    A2_LOG_INFO(fmt(MSG_SEGMENT_FILE_EXISTS,
                    utf8ToNative(filename_).c_str()));
    return true;
  } else {
    A2_LOG_INFO(fmt(MSG_SEGMENT_FILE_DOES_NOT_EXIST,
                    utf8ToNative(filename_).c_str()));
    return false;
  }
}

#ifdef ENABLE_BITTORRENT
void DefaultBtProgressInfoFile::setPeerStorage
(const SharedHandle<PeerStorage>& peerStorage)
{
  peerStorage_ = peerStorage;
}

void DefaultBtProgressInfoFile::setBtRuntime
(const SharedHandle<BtRuntime>& btRuntime)
{
  btRuntime_ = btRuntime;
}
#endif // ENABLE_BITTORRENT

} // namespace aria2