mirror
/
transmission
mirror of https://github.com/transmission/transmission
1
0
Fork 0
Code Issues Releases Wiki Activity
transmission/libtransmission/torrent.cc

3302 lines
84 KiB
C++
Raw Blame History

/*
* This file Copyright (C) 2009-2017 Mnemosyne LLC
*
* It may be used under the GNU GPL versions 2 or 3
* or any future license endorsed by Mnemosyne LLC.
*
*/
#include <algorithm> /* EINVAL */
#include <array>
#include <cerrno> /* EINVAL */
#include <climits> /* INT_MAX */
#include <cmath>
#include <csignal> /* signal() */
#include <cstdarg>
#include <cstdlib> /* qsort */
#include <cstring> /* memcmp */
#include <set>
#include <sstream>
#include <string>
#include <unordered_map>
#include <vector>
#ifndef _WIN32
#include <sys/wait.h> /* wait() */
#include <unistd.h> /* fork(), execvp(), _exit() */
#else
#include <windows.h> /* CreateProcess(), GetLastError() */
#endif
#include <event2/util.h> /* evutil_vsnprintf() */
#include "transmission.h"
#include "announcer.h"
#include "bandwidth.h"
#include "cache.h"
#include "completion.h"
#include "crypto-utils.h" /* for tr_sha1 */
#include "error.h"
#include "fdlimit.h" /* tr_fdTorrentClose */
#include "file.h"
#include "inout.h" /* tr_ioTestPiece() */
#include "log.h"
#include "magnet-metainfo.h"
#include "metainfo.h"
#include "peer-common.h" /* MAX_BLOCK_SIZE */
#include "peer-mgr.h"
#include "platform.h" /* TR_PATH_DELIMITER_STR */
#include "resume.h"
#include "session.h"
#include "subprocess.h"
#include "torrent-magnet.h"
#include "torrent.h"
#include "tr-assert.h"
#include "trevent.h" /* tr_runInEventThread() */
#include "utils.h"
#include "variant.h"
#include "verify.h"
#include "version.h"
#include "web-utils.h"
/***
****
***/
#define tr_deeplog_tor(tor, ...) tr_logAddDeepNamed(tr_torrentName(tor), __VA_ARGS__)
using namespace std::literals;
/***
****
***/
char const* tr_torrentName(tr_torrent const* tor)
{
return tor != nullptr ? tor->info.name : "";
}
uint64_t tr_torrentTotalSize(tr_torrent const* tor)
{
TR_ASSERT(tr_isTorrent(tor));
return tor->info.totalSize;
}
int tr_torrentId(tr_torrent const* tor)
{
return tor != nullptr ? tor->uniqueId : -1;
}
tr_sha1_digest_t tr_torrentInfoHash(tr_torrent const* torrent)
{
auto digest = tr_sha1_digest_t{};
std::copy_n(reinterpret_cast<std::byte const*>(torrent->info.hash), SHA_DIGEST_LENGTH, std::begin(digest));
return digest;
}
tr_torrent* tr_torrentFindFromId(tr_session* session, int id)
{
auto& src = session->torrentsById;
auto it = src.find(id);
return it == std::end(src) ? nullptr : it->second;
}
tr_torrent* tr_torrentFindFromHashString(tr_session* session, std::string_view hash_string)
{
auto& src = session->torrentsByHashString;
auto it = src.find(hash_string);
return it == std::end(src) ? nullptr : it->second;
}
tr_torrent* tr_torrentFindFromHash(tr_session* session, uint8_t const* hash)
{
auto& src = session->torrentsByHash;
auto it = src.find(hash);
return it == std::end(src) ? nullptr : it->second;
}
tr_torrent* tr_torrentFindFromHash(tr_session* session, tr_sha1_digest_t const& info_dict_hash)
{
return tr_torrentFindFromHash(session, reinterpret_cast<uint8_t const*>(std::data(info_dict_hash)));
}
tr_torrent* tr_torrentFindFromMagnetLink(tr_session* session, char const* magnet_link)
{
auto mm = tr_magnet_metainfo{};
return mm.parseMagnet(magnet_link ? magnet_link : "") ? tr_torrentFindFromHash(session, mm.info_hash) : nullptr;
}
tr_torrent* tr_torrentFindFromObfuscatedHash(tr_session* session, uint8_t const* obfuscatedTorrentHash)
{
for (auto* tor : session->torrents)
{
if (memcmp(tor->obfuscatedHash, obfuscatedTorrentHash, SHA_DIGEST_LENGTH) == 0)
{
return tor;
}
}
return nullptr;
}
bool tr_torrentIsPieceTransferAllowed(tr_torrent const* tor, tr_direction direction)
{
TR_ASSERT(tr_isTorrent(tor));
TR_ASSERT(tr_isDirection(direction));
bool allowed = true;
if (tr_torrentUsesSpeedLimit(tor, direction) && tr_torrentGetSpeedLimit_Bps(tor, direction) <= 0)
{
allowed = false;
}
if (tr_torrentUsesSessionLimits(tor))
{
unsigned int limit = 0;
if (tr_sessionGetActiveSpeedLimit_Bps(tor->session, direction, &limit) && (limit <= 0))
{
allowed = false;
}
}
return allowed;
}
/***
****
***/
static void tr_torrentUnsetPeerId(tr_torrent* tor)
{
// triggers a rebuild next time tr_torrentGetPeerId() is called
tor->peer_id.reset();
}
static int peerIdTTL(tr_torrent const* tor)
{
auto const ctime = tor->peer_id_creation_time;
return ctime == 0 ? 0 : (int)difftime(ctime + tor->session->peer_id_ttl_hours * 3600, tr_time());
}
tr_peer_id_t const& tr_torrentGetPeerId(tr_torrent* tor)
{
bool const needs_new_peer_id = !tor->peer_id || // doesn't have one
(tor->isPublic() && (peerIdTTL(tor) <= 0)); // has one but it's expired
if (needs_new_peer_id)
{
tor->peer_id = tr_peerIdInit();
tor->peer_id_creation_time = tr_time();
}
return *tor->peer_id;
}
/***
**** PER-TORRENT UL / DL SPEEDS
***/
void tr_torrentSetSpeedLimit_Bps(tr_torrent* tor, tr_direction dir, unsigned int Bps)
{
TR_ASSERT(tr_isTorrent(tor));
TR_ASSERT(tr_isDirection(dir));
if (tor->bandwidth->setDesiredSpeedBytesPerSecond(dir, Bps))
{
tr_torrentSetDirty(tor);
}
}
void tr_torrentSetSpeedLimit_KBps(tr_torrent* tor, tr_direction dir, unsigned int KBps)
{
tr_torrentSetSpeedLimit_Bps(tor, dir, toSpeedBytes(KBps));
}
unsigned int tr_torrentGetSpeedLimit_Bps(tr_torrent const* tor, tr_direction dir)
{
TR_ASSERT(tr_isTorrent(tor));
TR_ASSERT(tr_isDirection(dir));
return tor->bandwidth->getDesiredSpeedBytesPerSecond(dir);
}
unsigned int tr_torrentGetSpeedLimit_KBps(tr_torrent const* tor, tr_direction dir)
{
TR_ASSERT(tr_isTorrent(tor));
TR_ASSERT(tr_isDirection(dir));
return toSpeedKBps(tr_torrentGetSpeedLimit_Bps(tor, dir));
}
void tr_torrentUseSpeedLimit(tr_torrent* tor, tr_direction dir, bool do_use)
{
TR_ASSERT(tr_isTorrent(tor));
TR_ASSERT(tr_isDirection(dir));
if (tor->bandwidth->setLimited(dir, do_use))
{
tr_torrentSetDirty(tor);
}
}
bool tr_torrentUsesSpeedLimit(tr_torrent const* tor, tr_direction dir)
{
TR_ASSERT(tr_isTorrent(tor));
return tor->bandwidth->isLimited(dir);
}
void tr_torrentUseSessionLimits(tr_torrent* tor, bool doUse)
{
TR_ASSERT(tr_isTorrent(tor));
if (tor->bandwidth->honorParentLimits(TR_UP, doUse) || tor->bandwidth->honorParentLimits(TR_DOWN, doUse))
{
tr_torrentSetDirty(tor);
}
}
bool tr_torrentUsesSessionLimits(tr_torrent const* tor)
{
TR_ASSERT(tr_isTorrent(tor));
return tor->bandwidth->areParentLimitsHonored(TR_UP);
}
/***
****
***/
void tr_torrentSetRatioMode(tr_torrent* tor, tr_ratiolimit mode)
{
TR_ASSERT(tr_isTorrent(tor));
TR_ASSERT(mode == TR_RATIOLIMIT_GLOBAL || mode == TR_RATIOLIMIT_SINGLE || mode == TR_RATIOLIMIT_UNLIMITED);
if (mode != tor->ratioLimitMode)
{
tor->ratioLimitMode = mode;
tr_torrentSetDirty(tor);
}
}
tr_ratiolimit tr_torrentGetRatioMode(tr_torrent const* tor)
{
TR_ASSERT(tr_isTorrent(tor));
return tor->ratioLimitMode;
}
void tr_torrentSetRatioLimit(tr_torrent* tor, double desiredRatio)
{
TR_ASSERT(tr_isTorrent(tor));
if ((int)(desiredRatio * 100.0) != (int)(tor->desiredRatio * 100.0))
{
tor->desiredRatio = desiredRatio;
tr_torrentSetDirty(tor);
}
}
double tr_torrentGetRatioLimit(tr_torrent const* tor)
{
TR_ASSERT(tr_isTorrent(tor));
return tor->desiredRatio;
}
bool tr_torrentGetSeedRatio(tr_torrent const* tor, double* ratio)
{
auto isLimited = bool{};
TR_ASSERT(tr_isTorrent(tor));
switch (tr_torrentGetRatioMode(tor))
{
case TR_RATIOLIMIT_SINGLE:
isLimited = true;
if (ratio != nullptr)
{
*ratio = tr_torrentGetRatioLimit(tor);
}
break;
case TR_RATIOLIMIT_GLOBAL:
isLimited = tr_sessionIsRatioLimited(tor->session);
if (isLimited && ratio != nullptr)
{
*ratio = tr_sessionGetRatioLimit(tor->session);
}
break;
default: /* TR_RATIOLIMIT_UNLIMITED */
isLimited = false;
break;
}
return isLimited;
}
/* returns true if the seed ratio applies --
* it applies if the torrent's a seed AND it has a seed ratio set */
static bool tr_torrentGetSeedRatioBytes(tr_torrent const* tor, uint64_t* setmeLeft, uint64_t* setmeGoal)
{
bool seedRatioApplies = false;
TR_ASSERT(tr_isTorrent(tor));
auto seedRatio = double{};
if (tr_torrentGetSeedRatio(tor, &seedRatio))
{
uint64_t const u = tor->uploadedCur + tor->uploadedPrev;
uint64_t const d = tor->downloadedCur + tor->downloadedPrev;
uint64_t const baseline = d != 0 ? d : tor->completion.sizeWhenDone();
uint64_t const goal = baseline * seedRatio;
if (setmeLeft != nullptr)
{
*setmeLeft = goal > u ? goal - u : 0;
}
if (setmeGoal != nullptr)
{
*setmeGoal = goal;
}
seedRatioApplies = tor->isDone();
}
return seedRatioApplies;
}
static bool tr_torrentIsSeedRatioDone(tr_torrent const* tor)
{
auto bytesLeft = uint64_t{};
return tr_torrentGetSeedRatioBytes(tor, &bytesLeft, nullptr) && bytesLeft == 0;
}
/***
****
***/
void tr_torrentSetIdleMode(tr_torrent* tor, tr_idlelimit mode)
{
TR_ASSERT(tr_isTorrent(tor));
TR_ASSERT(mode == TR_IDLELIMIT_GLOBAL || mode == TR_IDLELIMIT_SINGLE || mode == TR_IDLELIMIT_UNLIMITED);
if (mode != tor->idleLimitMode)
{
tor->idleLimitMode = mode;
tr_torrentSetDirty(tor);
}
}
tr_idlelimit tr_torrentGetIdleMode(tr_torrent const* tor)
{
TR_ASSERT(tr_isTorrent(tor));
return tor->idleLimitMode;
}
void tr_torrentSetIdleLimit(tr_torrent* tor, uint16_t idleMinutes)
{
TR_ASSERT(tr_isTorrent(tor));
if (idleMinutes > 0)
{
tor->idleLimitMinutes = idleMinutes;
tr_torrentSetDirty(tor);
}
}
uint16_t tr_torrentGetIdleLimit(tr_torrent const* tor)
{
TR_ASSERT(tr_isTorrent(tor));
return tor->idleLimitMinutes;
}
bool tr_torrentGetSeedIdle(tr_torrent const* tor, uint16_t* idleMinutes)
{
auto isLimited = bool{};
switch (tr_torrentGetIdleMode(tor))
{
case TR_IDLELIMIT_SINGLE:
isLimited = true;
if (idleMinutes != nullptr)
{
*idleMinutes = tr_torrentGetIdleLimit(tor);
}
break;
case TR_IDLELIMIT_GLOBAL:
isLimited = tr_sessionIsIdleLimited(tor->session);
if (isLimited && idleMinutes != nullptr)
{
*idleMinutes = tr_sessionGetIdleLimit(tor->session);
}
break;
default: /* TR_IDLELIMIT_UNLIMITED */
isLimited = false;
break;
}
return isLimited;
}
static bool tr_torrentIsSeedIdleLimitDone(tr_torrent* tor)
{
auto idleMinutes = uint16_t{};
return tr_torrentGetSeedIdle(tor, &idleMinutes) &&
difftime(tr_time(), std::max(tor->startDate, tor->activityDate)) >= idleMinutes * 60U;
}
/***
****
***/
void tr_torrentCheckSeedLimit(tr_torrent* tor)
{
TR_ASSERT(tr_isTorrent(tor));
if (!tor->isRunning || tor->isStopping || !tor->isDone())
{
return;
}
/* if we're seeding and reach our seed ratio limit, stop the torrent */
if (tr_torrentIsSeedRatioDone(tor))
{
tr_logAddTorInfo(tor, "%s", "Seed ratio reached; pausing torrent");
tor->isStopping = true;
/* maybe notify the client */
if (tor->ratio_limit_hit_func != nullptr)
{
(*tor->ratio_limit_hit_func)(tor, tor->ratio_limit_hit_func_user_data);
}
}
/* if we're seeding and reach our inactiviy limit, stop the torrent */
else if (tr_torrentIsSeedIdleLimitDone(tor))
{
tr_logAddTorInfo(tor, "%s", "Seeding idle limit reached; pausing torrent");
tor->isStopping = true;
tor->finishedSeedingByIdle = true;
/* maybe notify the client */
if (tor->idle_limit_hit_func != nullptr)
{
(*tor->idle_limit_hit_func)(tor, tor->idle_limit_hit_func_user_data);
}
}
}
/***
****
***/
void tr_torrentSetLocalError(tr_torrent* tor, char const* fmt, ...)
{
TR_ASSERT(tr_isTorrent(tor));
va_list ap;
va_start(ap, fmt);
tor->error = TR_STAT_LOCAL_ERROR;
tor->error_announce_url = TR_KEY_NONE;
evutil_vsnprintf(tor->errorString, sizeof(tor->errorString), fmt, ap);
va_end(ap);
tr_logAddTorErr(tor, "%s", tor->errorString);
if (tor->isRunning)
{
tor->isStopping = true;
}
}
static constexpr void tr_torrentClearError(tr_torrent* tor)
{
tor->error = TR_STAT_OK;
tor->error_announce_url = TR_KEY_NONE;
tor->errorString[0] = '\0';
}
static void onTrackerResponse(tr_torrent* tor, tr_tracker_event const* event, void* /*user_data*/)
{
switch (event->messageType)
{
case TR_TRACKER_PEERS:
tr_logAddTorDbg(tor, "Got %zu peers from tracker", event->pexCount);
tr_peerMgrAddPex(tor, TR_PEER_FROM_TRACKER, event->pex, event->pexCount);
break;
case TR_TRACKER_COUNTS:
if (tor->isPrivate() && (event->leechers == 0))
{
tr_peerMgrSetSwarmIsAllSeeds(tor);
}
break;
case TR_TRACKER_WARNING:
tr_logAddTorErr(tor, _("Tracker warning: \"%s\""), event->text);
tor->error = TR_STAT_TRACKER_WARNING;
tor->error_announce_url = event->announce_url;
tr_strlcpy(tor->errorString, event->text, sizeof(tor->errorString));
break;
case TR_TRACKER_ERROR:
tor->error = TR_STAT_TRACKER_ERROR;
tor->error_announce_url = event->announce_url;
tr_strlcpy(tor->errorString, event->text, sizeof(tor->errorString));
break;
case TR_TRACKER_ERROR_CLEAR:
if (tor->error != TR_STAT_LOCAL_ERROR)
{
tr_torrentClearError(tor);
}
break;
}
}
/***
****
**** TORRENT INSTANTIATION
****
***/
static void torrentStart(tr_torrent* tor, bool bypass_queue);
static void tr_torrentFireMetadataCompleted(tr_torrent* tor);
static void torrentInitFromInfoDict(tr_torrent* tor)
{
tor->initSizes(tor->info.totalSize, tor->info.pieceSize);
tor->completion = tr_completion{ tor, tor };
tr_sha1(tor->obfuscatedHash, "req2", 4, tor->info.hash, SHA_DIGEST_LENGTH, nullptr);
// init file offsets
auto offset = uint64_t{ 0 };
for (tr_file_index_t i = 0, n = tor->fileCount(); i < n; ++i)
{
auto& file = tor->file(i);
file.priv.offset = offset;
offset += file.length;
}
tor->fpm_.reset(tor->info);
tor->file_priorities_.reset(&tor->fpm_);
tor->files_wanted_.reset(&tor->fpm_);
tor->checked_pieces_ = tr_bitfield{ tor->info.pieceCount };
}
void tr_torrentGotNewInfoDict(tr_torrent* tor)
{
torrentInitFromInfoDict(tor);
tr_peerMgrOnTorrentGotMetainfo(tor);
tr_torrentFireMetadataCompleted(tor);
}
static bool hasAnyLocalData(tr_torrent const* tor)
{
auto filename = std::string{};
for (tr_file_index_t i = 0, n = tor->fileCount(); i < n; ++i)
{
if (tor->findFile(filename, i))
{
return true;
}
}
return false;
}
static bool setLocalErrorIfFilesDisappeared(tr_torrent* tor)
{
bool const disappeared = tor->hasTotal() > 0 && !hasAnyLocalData(tor);
if (disappeared)
{
tr_deeplog_tor(tor, "%s", "[LAZY] uh oh, the files disappeared");
tr_torrentSetLocalError(
tor,
"%s",
_("No data found! Ensure your drives are connected or use \"Set Location\". "
"To re-download, remove the torrent and re-add it."));
}
return disappeared;
}
static void torrentCallScript(tr_torrent const* tor, char const* script);
static void callScriptIfEnabled(tr_torrent const* tor, TrScript type)
{
auto* session = tor->session;
if (tr_sessionIsScriptEnabled(session, type))
{
torrentCallScript(tor, tr_sessionGetScript(session, type));
}
}
static void refreshCurrentDir(tr_torrent* tor);
static void torrentInit(tr_torrent* tor, tr_ctor const* ctor)
{
static auto next_unique_id = int{ 1 };
auto const lock = tor->unique_lock();
tr_session* session = tr_ctorGetSession(ctor);
TR_ASSERT(session != nullptr);
tor->session = session;
tor->uniqueId = next_unique_id++;
tor->queuePosition = tr_sessionCountTorrents(session);
torrentInitFromInfoDict(tor);
char const* dir = nullptr;
if (tr_ctorGetDownloadDir(ctor, TR_FORCE, &dir) || tr_ctorGetDownloadDir(ctor, TR_FALLBACK, &dir))
{
tor->downloadDir = tr_strdup(dir);
}
if (!tr_ctorGetIncompleteDir(ctor, &dir))
{
dir = tr_sessionGetIncompleteDir(session);
}
if (tr_sessionIsIncompleteDirEnabled(session))
{
tor->incompleteDir = tr_strdup(dir);
}
tor->bandwidth = new Bandwidth(session->bandwidth);
tor->bandwidth->setPriority(tr_ctorGetBandwidthPriority(ctor));
tor->error = TR_STAT_OK;
tor->finishedSeedingByIdle = false;
tr_peerMgrAddTorrent(session->peerMgr, tor);
TR_ASSERT(tor->downloadedCur == 0);
TR_ASSERT(tor->uploadedCur == 0);
tr_torrentSetDateAdded(tor, tr_time()); /* this is a default value to be overwritten by the resume file */
// tr_torrentLoadResume() calls a lot of tr_torrentSetFoo() methods
// that set things as dirty, but... these settings being loaded are
// the same ones that would be saved back again, so don't let them
// affect the 'is dirty' flag.
auto const was_dirty = tor->isDirty;
bool didRenameResumeFileToHashOnlyName = false;
auto const loaded = tr_torrentLoadResume(tor, ~(uint64_t)0, ctor, &didRenameResumeFileToHashOnlyName);
tor->isDirty = was_dirty;
if (didRenameResumeFileToHashOnlyName)
{
/* Rename torrent file as well */
tr_metainfoMigrateFile(session, &tor->info, TR_METAINFO_BASENAME_NAME_AND_PARTIAL_HASH, TR_METAINFO_BASENAME_HASH);
}
tor->completeness = tor->completion.status();
setLocalErrorIfFilesDisappeared(tor);
tr_ctorInitTorrentPriorities(ctor, tor);
tr_ctorInitTorrentWanted(ctor, tor);
refreshCurrentDir(tor);
bool const doStart = tor->isRunning;
tor->isRunning = false;
if ((loaded & TR_FR_SPEEDLIMIT) == 0)
{
tr_torrentUseSpeedLimit(tor, TR_UP, false);
tr_torrentSetSpeedLimit_Bps(tor, TR_UP, tr_sessionGetSpeedLimit_Bps(tor->session, TR_UP));
tr_torrentUseSpeedLimit(tor, TR_DOWN, false);
tr_torrentSetSpeedLimit_Bps(tor, TR_DOWN, tr_sessionGetSpeedLimit_Bps(tor->session, TR_DOWN));
tr_torrentUseSessionLimits(tor, true);
}
if ((loaded & TR_FR_RATIOLIMIT) == 0)
{
tr_torrentSetRatioMode(tor, TR_RATIOLIMIT_GLOBAL);
tr_torrentSetRatioLimit(tor, tr_sessionGetRatioLimit(tor->session));
}
if ((loaded & TR_FR_IDLELIMIT) == 0)
{
tr_torrentSetIdleMode(tor, TR_IDLELIMIT_GLOBAL);
tr_torrentSetIdleLimit(tor, tr_sessionGetIdleLimit(tor->session));
}
tr_sessionAddTorrent(session, tor);
/* if we don't have a local .torrent file already, assume the torrent is new */
bool const isNewTorrent = !tr_sys_path_exists(tor->info.torrent, nullptr);
/* maybe save our own copy of the metainfo */
if (tr_ctorGetSave(ctor))
{
tr_error* error = nullptr;
if (!tr_ctorSaveContents(ctor, tor->info.torrent, &error))
{
tr_torrentSetLocalError(tor, "Unable to save torrent file: %s (%d)", error->message, error->code);
}
tr_error_clear(&error);
}
tor->announcer_tiers = tr_announcerAddTorrent(tor, onTrackerResponse, nullptr);
if (isNewTorrent)
{
if (tr_torrentHasMetadata(tor))
{
callScriptIfEnabled(tor, TR_SCRIPT_ON_TORRENT_ADDED);
}
if (!tr_torrentHasMetadata(tor) && !doStart)
{
tor->prefetchMagnetMetadata = true;
tr_torrentStartNow(tor);
}
else
{
tor->startAfterVerify = doStart;
tr_torrentVerify(tor, nullptr, nullptr);
}
}
else if (doStart)
{
tr_torrentStart(tor);
}
}
tr_parse_result tr_torrentParse(tr_ctor const* ctor, tr_info* setmeInfo)
{
tr_variant const* metainfo = nullptr;
if (!tr_ctorGetMetainfo(ctor, &metainfo))
{
return TR_PARSE_ERR;
}
auto parsed = tr_metainfoParse(tr_ctorGetSession(ctor), metainfo, nullptr);
if (!parsed)
{
return TR_PARSE_ERR;
}
if (setmeInfo != nullptr)
{
*setmeInfo = parsed->info;
parsed->info = {};
}
return TR_PARSE_OK;
}
tr_torrent* tr_torrentNew(tr_ctor const* ctor, int* setme_error, int* setme_duplicate_id)
{
TR_ASSERT(ctor != nullptr);
auto* const session = tr_ctorGetSession(ctor);
TR_ASSERT(tr_isSession(session));
tr_variant const* metainfo = nullptr;
tr_ctorGetMetainfo(ctor, &metainfo);
auto parsed = tr_metainfoParse(session, metainfo, nullptr);
if (!parsed)
{
if (setme_error != nullptr)
{
*setme_error = TR_PARSE_ERR;
}
return nullptr;
}
tr_torrent const* const dupe = tr_torrentFindFromHash(session, parsed->info.hash);
if (dupe != nullptr)
{
if (setme_duplicate_id != nullptr)
{
*setme_duplicate_id = tr_torrentId(dupe);
}
if (setme_error != nullptr)
{
*setme_error = TR_PARSE_DUPLICATE;
}
return nullptr;
}
auto* tor = new tr_torrent{ parsed->info };
tor->swapMetainfo(*parsed);
torrentInit(tor, ctor);
return tor;
}
/**
***
**/
void tr_torrentSetDownloadDir(tr_torrent* tor, char const* path)
{
TR_ASSERT(tr_isTorrent(tor));
if (path == nullptr || tor->downloadDir == nullptr || strcmp(path, tor->downloadDir) != 0)
{
tr_free(tor->downloadDir);
tor->downloadDir = tr_strdup(path);
tr_torrentMarkEdited(tor);
tr_torrentSetDirty(tor);
}
refreshCurrentDir(tor);
}
char const* tr_torrentGetDownloadDir(tr_torrent const* tor)
{
TR_ASSERT(tr_isTorrent(tor));
return tor->downloadDir;
}
char const* tr_torrentGetCurrentDir(tr_torrent const* tor)
{
TR_ASSERT(tr_isTorrent(tor));
return tor->currentDir;
}
void tr_torrentChangeMyPort(tr_torrent* tor)
{
TR_ASSERT(tr_isTorrent(tor));
if (tor->isRunning)
{
tr_announcerChangeMyPort(tor);
}
}
static inline void tr_torrentManualUpdateImpl(void* vtor)
{
auto* tor = static_cast<tr_torrent*>(vtor);
TR_ASSERT(tr_isTorrent(tor));
if (tor->isRunning)
{
tr_announcerManualAnnounce(tor);
}
}
void tr_torrentManualUpdate(tr_torrent* tor)
{
TR_ASSERT(tr_isTorrent(tor));
tr_runInEventThread(tor->session, tr_torrentManualUpdateImpl, tor);
}
bool tr_torrentCanManualUpdate(tr_torrent const* tor)
{
return tr_isTorrent(tor) && tor->isRunning && tr_announcerCanManualAnnounce(tor);
}
tr_info const* tr_torrentInfo(tr_torrent const* tor)
{
return tr_isTorrent(tor) ? &tor->info : nullptr;
}
tr_stat const* tr_torrentStatCached(tr_torrent* tor)
{
time_t const now = tr_time();
return (tr_isTorrent(tor) && now == tor->lastStatTime) ? &tor->stats : tr_torrentStat(tor);
}
void tr_torrentSetVerifyState(tr_torrent* tor, tr_verify_state state)
{
TR_ASSERT(tr_isTorrent(tor));
TR_ASSERT(state == TR_VERIFY_NONE || state == TR_VERIFY_WAIT || state == TR_VERIFY_NOW);
tor->verifyState = state;
tor->anyDate = tr_time();
}
tr_torrent_activity tr_torrentGetActivity(tr_torrent const* tor)
{
tr_torrent_activity ret = TR_STATUS_STOPPED;
bool const is_seed = tor->isDone();
if (tor->verifyState == TR_VERIFY_NOW)
{
ret = TR_STATUS_CHECK;
}
else if (tor->verifyState == TR_VERIFY_WAIT)
{
ret = TR_STATUS_CHECK_WAIT;
}
else if (tor->isRunning)
{
ret = is_seed ? TR_STATUS_SEED : TR_STATUS_DOWNLOAD;
}
else if (tr_torrentIsQueued(tor))
{
if (is_seed && tr_sessionGetQueueEnabled(tor->session, TR_UP))
{
ret = TR_STATUS_SEED_WAIT;
}
else if (!is_seed && tr_sessionGetQueueEnabled(tor->session, TR_DOWN))
{
ret = TR_STATUS_DOWNLOAD_WAIT;
}
}
return ret;
}
static int torrentGetIdleSecs(tr_torrent const* tor, tr_torrent_activity activity)
{
return ((activity == TR_STATUS_DOWNLOAD || activity == TR_STATUS_SEED) && tor->startDate != 0) ?
(int)difftime(tr_time(), std::max(tor->startDate, tor->activityDate)) :
-1;
}
static inline bool tr_torrentIsStalled(tr_torrent const* tor, int idle_secs)
{
return tr_sessionGetQueueStalledEnabled(tor->session) && idle_secs > tr_sessionGetQueueStalledMinutes(tor->session) * 60;
}
static double getVerifyProgress(tr_torrent const* tor)
{
return tor->verify_progress ? *tor->verify_progress : 0.0;
}
tr_stat const* tr_torrentStat(tr_torrent* tor)
{
TR_ASSERT(tr_isTorrent(tor));
uint64_t const now = tr_time_msec();
auto swarm_stats = tr_swarm_stats{};
tor->lastStatTime = tr_time();
if (tor->swarm != nullptr)
{
tr_swarmGetStats(tor->swarm, &swarm_stats);
}
tr_stat* const s = &tor->stats;
s->id = tor->uniqueId;
s->activity = tr_torrentGetActivity(tor);
s->error = tor->error;
s->queuePosition = tor->queuePosition;
s->idleSecs = torrentGetIdleSecs(tor, s->activity);
s->isStalled = tr_torrentIsStalled(tor, s->idleSecs);
s->errorString = tor->errorString;
s->manualAnnounceTime = tr_announcerNextManualAnnounce(tor);
s->peersConnected = swarm_stats.peerCount;
s->peersSendingToUs = swarm_stats.activePeerCount[TR_DOWN];
s->peersGettingFromUs = swarm_stats.activePeerCount[TR_UP];
s->webseedsSendingToUs = swarm_stats.activeWebseedCount;
for (int i = 0; i < TR_PEER_FROM__MAX; i++)
{
s->peersFrom[i] = swarm_stats.peerFromCount[i];
}
s->rawUploadSpeed_KBps = toSpeedKBps(tor->bandwidth->getRawSpeedBytesPerSecond(now, TR_UP));
s->rawDownloadSpeed_KBps = toSpeedKBps(tor->bandwidth->getRawSpeedBytesPerSecond(now, TR_DOWN));
auto const pieceUploadSpeed_Bps = tor->bandwidth->getPieceSpeedBytesPerSecond(now, TR_UP);
s->pieceUploadSpeed_KBps = toSpeedKBps(pieceUploadSpeed_Bps);
auto const pieceDownloadSpeed_Bps = tor->bandwidth->getPieceSpeedBytesPerSecond(now, TR_DOWN);
s->pieceDownloadSpeed_KBps = toSpeedKBps(pieceDownloadSpeed_Bps);
s->percentComplete = tor->completion.percentComplete();
s->metadataPercentComplete = tr_torrentGetMetadataPercent(tor);
s->percentDone = tor->completion.percentDone();
s->leftUntilDone = tor->completion.leftUntilDone();
s->sizeWhenDone = tor->completion.sizeWhenDone();
s->recheckProgress = s->activity == TR_STATUS_CHECK ? getVerifyProgress(tor) : 0;
s->activityDate = tor->activityDate;
s->addedDate = tor->addedDate;
s->doneDate = tor->doneDate;
s->editDate = tor->editDate;
s->startDate = tor->startDate;
s->secondsSeeding = tor->secondsSeeding;
s->secondsDownloading = tor->secondsDownloading;
s->corruptEver = tor->corruptCur + tor->corruptPrev;
s->downloadedEver = tor->downloadedCur + tor->downloadedPrev;
s->uploadedEver = tor->uploadedCur + tor->uploadedPrev;
s->haveValid = tor->completion.hasValid();
s->haveUnchecked = tor->hasTotal() - s->haveValid;
s->desiredAvailable = tr_peerMgrGetDesiredAvailable(tor);
s->ratio = tr_getRatio(s->uploadedEver, s->downloadedEver != 0 ? s->downloadedEver : s->haveValid);
auto seedRatioBytesLeft = uint64_t{};
auto seedRatioBytesGoal = uint64_t{};
bool const seedRatioApplies = tr_torrentGetSeedRatioBytes(tor, &seedRatioBytesLeft, &seedRatioBytesGoal);
switch (s->activity)
{
/* etaXLSpeed exists because if we use the piece speed directly,
* brief fluctuations cause the ETA to jump all over the place.
* so, etaXLSpeed is a smoothed-out version of the piece speed
* to dampen the effect of fluctuations */
case TR_STATUS_DOWNLOAD:
if (tor->etaDLSpeedCalculatedAt + 800 < now)
{
tor->etaDLSpeed_Bps = tor->etaDLSpeedCalculatedAt + 4000 < now ?
pieceDownloadSpeed_Bps : /* if no recent previous speed, no need to smooth */
(tor->etaDLSpeed_Bps * 4.0 + pieceDownloadSpeed_Bps) / 5.0; /* smooth across 5 readings */
tor->etaDLSpeedCalculatedAt = now;
}
if (s->leftUntilDone > s->desiredAvailable && tor->info.webseedCount < 1)
{
s->eta = TR_ETA_NOT_AVAIL;
}
else if (tor->etaDLSpeed_Bps == 0)
{
s->eta = TR_ETA_UNKNOWN;
}
else
{
s->eta = s->leftUntilDone / tor->etaDLSpeed_Bps;
}
s->etaIdle = TR_ETA_NOT_AVAIL;
break;
case TR_STATUS_SEED:
if (!seedRatioApplies)
{
s->eta = TR_ETA_NOT_AVAIL;
}
else
{
if (tor->etaULSpeedCalculatedAt + 800 < now)
{
tor->etaULSpeed_Bps = tor->etaULSpeedCalculatedAt + 4000 < now ?
pieceUploadSpeed_Bps : /* if no recent previous speed, no need to smooth */
(tor->etaULSpeed_Bps * 4.0 + pieceUploadSpeed_Bps) / 5.0; /* smooth across 5 readings */
tor->etaULSpeedCalculatedAt = now;
}
if (tor->etaULSpeed_Bps == 0)
{
s->eta = TR_ETA_UNKNOWN;
}
else
{
s->eta = seedRatioBytesLeft / tor->etaULSpeed_Bps;
}
}
{
auto seedIdleMinutes = uint16_t{};
s->etaIdle = tor->etaULSpeed_Bps < 1 && tr_torrentGetSeedIdle(tor, &seedIdleMinutes) ?
seedIdleMinutes * 60 - s->idleSecs :
TR_ETA_NOT_AVAIL;
}
break;
default:
s->eta = TR_ETA_NOT_AVAIL;
s->etaIdle = TR_ETA_NOT_AVAIL;
break;
}
/* s->haveValid is here to make sure a torrent isn't marked 'finished'
* when the user hits "uncheck all" prior to starting the torrent... */
s->finished = tor->finishedSeedingByIdle || (seedRatioApplies && seedRatioBytesLeft == 0 && s->haveValid != 0);
if (!seedRatioApplies || s->finished)
{
s->seedRatioPercentDone = 1;
}
else if (seedRatioBytesGoal == 0) /* impossible? safeguard for div by zero */
{
s->seedRatioPercentDone = 0;
}
else
{
s->seedRatioPercentDone = (double)(seedRatioBytesGoal - seedRatioBytesLeft) / seedRatioBytesGoal;
}
/* test some of the constraints */
TR_ASSERT(s->sizeWhenDone <= tor->info.totalSize);
TR_ASSERT(s->leftUntilDone <= s->sizeWhenDone);
TR_ASSERT(s->desiredAvailable <= s->leftUntilDone);
return s;
}
/***
****
***/
static uint64_t countFileBytesCompleted(tr_torrent const* tor, tr_file_index_t index)
{
tr_file const& f = tor->file(index);
if (f.length == 0)
{
return 0;
}
auto const [begin, end] = tr_torGetFileBlockSpan(tor, index);
auto const n = end - begin;
if (n == 0)
{
return 0;
}
if (n == 1)
{
return tor->hasBlock(begin) ? f.length : 0;
}
auto total = uint64_t{};
// the first block
if (tor->hasBlock(begin))
{
total += tor->block_size - f.priv.offset % tor->block_size;
}
// the middle blocks
if (end - begin > 2)
{
uint64_t u = tor->completion.blocks().count(begin + 1, end - 1);
u *= tor->block_size;
total += u;
}
// the last block
if (tor->hasBlock(end - 1))
{
total += f.priv.offset + f.length - (uint64_t)tor->block_size * (end - 1);
}
return total;
}
tr_file_view tr_torrentFile(tr_torrent const* torrent, tr_file_index_t i)
{
TR_ASSERT(tr_isTorrent(torrent));
auto const& file = torrent->file(i);
auto const* const name = file.name;
auto const priority = torrent->file_priorities_.filePriority(i);
auto const wanted = torrent->files_wanted_.fileWanted(i);
auto const length = file.length;
if (torrent->completeness == TR_SEED || length == 0)
{
return { name, length, length, 1.0, priority, wanted };
}
auto const have = countFileBytesCompleted(torrent, i);
return { name, have, length, have >= length ? 1.0 : have / double(length), priority, wanted };
}
size_t tr_torrentFileCount(tr_torrent const* torrent)
{
TR_ASSERT(tr_isTorrent(torrent));
return torrent->fileCount();
}
tr_webseed_view tr_torrentWebseed(tr_torrent const* tor, size_t i)
{
return tr_peerMgrWebseed(tor, i);
}
size_t tr_torrentWebseedCount(tr_torrent const* tor)
{
TR_ASSERT(tr_isTorrent(tor));
return tor->webseedCount();
}
tr_tracker_view tr_torrentTracker(tr_torrent const* tor, size_t i)
{
return tr_announcerTracker(tor, i);
}
size_t tr_torrentTrackerCount(tr_torrent const* tor)
{
return tr_announcerTrackerCount(tor);
}
tr_torrent_view tr_torrentView(tr_torrent const* tor)
{
TR_ASSERT(tr_isTorrent(tor));
auto ret = tr_torrent_view{};
ret.name = tor->info.name;
ret.hash_string = tor->info.hashString;
ret.torrent_filename = tor->info.torrent;
ret.comment = tor->info.comment;
ret.creator = tor->info.creator;
ret.source = tor->info.source;
ret.total_size = tor->info.totalSize;
ret.date_created = tor->info.dateCreated;
ret.piece_size = tor->info.pieceSize;
ret.n_pieces = tor->info.pieceCount;
ret.is_private = tor->info.isPrivate;
ret.is_folder = tor->info.isFolder;
return ret;
}
/***
****
***/
tr_peer_stat* tr_torrentPeers(tr_torrent const* tor, int* peerCount)
{
TR_ASSERT(tr_isTorrent(tor));
return tr_peerMgrPeerStats(tor, peerCount);
}
void tr_torrentPeersFree(tr_peer_stat* peers, int /*peerCount*/)
{
tr_free(peers);
}
void tr_torrentAvailability(tr_torrent const* tor, int8_t* tab, int size)
{
TR_ASSERT(tr_isTorrent(tor));
if (tab != nullptr && size > 0)
{
tr_peerMgrTorrentAvailability(tor, tab, size);
}
}
void tr_torrentAmountFinished(tr_torrent const* tor, float* tabs, int n_tabs)
{
return tor->amountDoneBins(tabs, n_tabs);
}
static void tr_torrentResetTransferStats(tr_torrent* tor)
{
auto const lock = tor->unique_lock();
tor->downloadedPrev += tor->downloadedCur;
tor->downloadedCur = 0;
tor->uploadedPrev += tor->uploadedCur;
tor->uploadedCur = 0;
tor->corruptPrev += tor->corruptCur;
tor->corruptCur = 0;
tr_torrentSetDirty(tor);
}
/***
****
***/
#ifdef TR_ENABLE_ASSERTS
static bool queueIsSequenced(tr_session*);
#endif
static void freeTorrent(tr_torrent* tor)
{
auto const lock = tor->unique_lock();
TR_ASSERT(!tor->isRunning);
tr_session* session = tor->session;
tr_info* inf = &tor->info;
time_t const now = tr_time();
tr_peerMgrRemoveTorrent(tor);
tr_announcerRemoveTorrent(session->announcer, tor);
tr_free(tor->downloadDir);
tr_free(tor->incompleteDir);
tr_sessionRemoveTorrent(session, tor);
if (!session->isClosing())
{
// "so you die, captain, and we all move up in rank."
// resequence the queue positions
for (auto* t : session->torrents)
{
if (t->queuePosition > tor->queuePosition)
{
t->queuePosition--;
t->anyDate = now;
}
}
TR_ASSERT(queueIsSequenced(session));
}
delete tor->bandwidth;
tr_metainfoFree(inf);
delete tor;
}
/**
*** Start/Stop Callback
**/
static void torrentSetQueued(tr_torrent* tor, bool queued);
static void torrentStartImpl(void* vtor)
{
auto* tor = static_cast<tr_torrent*>(vtor);
auto const lock = tor->unique_lock();
TR_ASSERT(tr_isTorrent(tor));
tor->recheckCompleteness();
torrentSetQueued(tor, false);
time_t const now = tr_time();
tor->isRunning = true;
tor->completeness = tor->completion.status();
tor->startDate = now;
tor->anyDate = now;
tr_torrentClearError(tor);
tor->finishedSeedingByIdle = false;
tr_torrentResetTransferStats(tor);
tr_announcerTorrentStarted(tor);
tor->dhtAnnounceAt = now + tr_rand_int_weak(20);
tor->dhtAnnounce6At = now + tr_rand_int_weak(20);
tor->lpdAnnounceAt = now;
tr_peerMgrStartTorrent(tor);
}
uint64_t tr_torrentGetCurrentSizeOnDisk(tr_torrent const* tor)
{
uint64_t byte_count = 0;
auto const n = tor->fileCount();
for (tr_file_index_t i = 0; i < n; ++i)
{
tr_sys_path_info info;
char* filename = tr_torrentFindFile(tor, i);
if (filename != nullptr && tr_sys_path_get_info(filename, 0, &info, nullptr))
{
byte_count += info.size;
}
tr_free(filename);
}
return byte_count;
}
static bool torrentShouldQueue(tr_torrent const* tor)
{
tr_direction const dir = tor->queueDirection();
return tr_sessionCountQueueFreeSlots(tor->session, dir) == 0;
}
static void torrentStart(tr_torrent* tor, bool bypass_queue)
{
switch (tr_torrentGetActivity(tor))
{
case TR_STATUS_SEED:
case TR_STATUS_DOWNLOAD:
return; /* already started */
case TR_STATUS_SEED_WAIT:
case TR_STATUS_DOWNLOAD_WAIT:
if (!bypass_queue)
{
return; /* already queued */
}
break;
case TR_STATUS_CHECK:
case TR_STATUS_CHECK_WAIT:
/* verifying right now... wait until that's done so
* we'll know what completeness to use/announce */
tor->startAfterVerify = true;
return;
case TR_STATUS_STOPPED:
if (!bypass_queue && torrentShouldQueue(tor))
{
torrentSetQueued(tor, true);
return;
}
break;
}
/* don't allow the torrent to be started if the files disappeared */
if (setLocalErrorIfFilesDisappeared(tor))
{
return;
}
/* otherwise, start it now... */
auto const lock = tor->unique_lock();
/* allow finished torrents to be resumed */
if (tr_torrentIsSeedRatioDone(tor))
{
tr_logAddTorInfo(tor, "%s", _("Restarted manually -- disabling its seed ratio"));
tr_torrentSetRatioMode(tor, TR_RATIOLIMIT_UNLIMITED);
}
/* corresponds to the peer_id sent as a tracker request parameter.
* one tracker admin says: "When the same torrent is opened and
* closed and opened again without quitting Transmission ...
* change the peerid. It would help sometimes if a stopped event
* was missed to ensure that we didn't think someone was cheating. */
tr_torrentUnsetPeerId(tor);
tor->isRunning = true;
tr_torrentSetDirty(tor);
tr_runInEventThread(tor->session, torrentStartImpl, tor);
}
void tr_torrentStart(tr_torrent* tor)
{
if (tr_isTorrent(tor))
{
torrentStart(tor, false);
}
}
void tr_torrentStartNow(tr_torrent* tor)
{
if (tr_isTorrent(tor))
{
torrentStart(tor, true);
}
}
struct verify_data
{
bool aborted;
tr_torrent* tor;
tr_verify_done_func callback_func;
void* callback_data;
};
static void onVerifyDoneThreadFunc(void* vdata)
{
auto* data = static_cast<struct verify_data*>(vdata);
tr_torrent* tor = data->tor;
if (!tor->isDeleting)
{
if (!data->aborted)
{
tor->recheckCompleteness();
}
if (data->callback_func != nullptr)
{
(*data->callback_func)(tor, data->aborted, data->callback_data);
}
if (!data->aborted && tor->startAfterVerify)
{
tor->startAfterVerify = false;
torrentStart(tor, false);
}
}
tr_free(data);
}
static void onVerifyDone(tr_torrent* tor, bool aborted, void* vdata)
{
auto* data = static_cast<struct verify_data*>(vdata);
TR_ASSERT(data->tor == tor);
if (tor->isDeleting)
{
tr_free(data);
return;
}
data->aborted = aborted;
tr_runInEventThread(tor->session, onVerifyDoneThreadFunc, data);
}
static void verifyTorrent(void* vdata)
{
auto* data = static_cast<struct verify_data*>(vdata);
tr_torrent* tor = data->tor;
auto const lock = tor->unique_lock();
if (tor->isDeleting)
{
tr_free(data);
}
else
{
/* if the torrent's already being verified, stop it */
tr_verifyRemove(tor);
bool const startAfter = (tor->isRunning || tor->startAfterVerify) && !tor->isStopping;
if (tor->isRunning)
{
tr_torrentStop(tor);
}
tor->startAfterVerify = startAfter;
if (setLocalErrorIfFilesDisappeared(tor))
{
tor->startAfterVerify = false;
}
else
{
tr_verifyAdd(tor, onVerifyDone, data);
}
}
}
void tr_torrentVerify(tr_torrent* tor, tr_verify_done_func callback_func, void* callback_data)
{
struct verify_data* const data = tr_new(struct verify_data, 1);
data->tor = tor;
data->aborted = false;
data->callback_func = callback_func;
data->callback_data = callback_data;
tr_runInEventThread(tor->session, verifyTorrent, data);
}
void tr_torrentSave(tr_torrent* tor)
{
TR_ASSERT(tr_isTorrent(tor));
if (tor->isDirty)
{
tor->isDirty = false;
tr_torrentSaveResume(tor);
}
}
static void stopTorrent(void* vtor)
{
auto* tor = static_cast<tr_torrent*>(vtor);
TR_ASSERT(tr_isTorrent(tor));
auto const lock = tor->unique_lock();
tr_logAddTorInfo(tor, "%s", "Pausing");
tr_verifyRemove(tor);
tr_peerMgrStopTorrent(tor);
tr_announcerTorrentStopped(tor);
tr_cacheFlushTorrent(tor->session->cache, tor);
tr_fdTorrentClose(tor->session, tor->uniqueId);
if (!tor->isDeleting)
{
tr_torrentSave(tor);
}
torrentSetQueued(tor, false);
if (tor->magnetVerify)
{
tor->magnetVerify = false;
tr_logAddTorInfo(tor, "%s", "Magnet Verify");
refreshCurrentDir(tor);
tr_torrentVerify(tor, nullptr, nullptr);
callScriptIfEnabled(tor, TR_SCRIPT_ON_TORRENT_ADDED);
}
}
void tr_torrentStop(tr_torrent* tor)
{
TR_ASSERT(tr_isTorrent(tor));
if (tr_isTorrent(tor))
{
auto const lock = tor->unique_lock();
tor->isRunning = false;
tor->isStopping = false;
tor->prefetchMagnetMetadata = false;
tr_torrentSetDirty(tor);
tr_runInEventThread(tor->session, stopTorrent, tor);
}
}
static void closeTorrent(void* vtor)
{
auto* tor = static_cast<tr_torrent*>(vtor);
TR_ASSERT(tr_isTorrent(tor));
tor->session->removed_torrents.emplace_back(tor->uniqueId, tr_time());
tr_logAddTorInfo(tor, "%s", _("Removing torrent"));
tor->magnetVerify = false;
stopTorrent(tor);
if (tor->isDeleting)
{
tr_metainfoRemoveSaved(tor->session, &tor->info);
tr_torrentRemoveResume(tor);
}
tor->isRunning = false;
freeTorrent(tor);
}
void tr_torrentFree(tr_torrent* tor)
{
if (tr_isTorrent(tor))
{
tr_session* session = tor->session;
TR_ASSERT(tr_isSession(session));
auto const lock = tor->unique_lock();
tr_torrentClearCompletenessCallback(tor);
tr_runInEventThread(session, closeTorrent, tor);
}
}
struct remove_data
{
tr_torrent* tor;
bool deleteFlag;
tr_fileFunc deleteFunc;
};
static void tr_torrentDeleteLocalData(tr_torrent*, tr_fileFunc);
static void removeTorrent(void* vdata)
{
auto* data = static_cast<struct remove_data*>(vdata);
auto const lock = data->tor->unique_lock();
if (data->deleteFlag)
{
tr_torrentDeleteLocalData(data->tor, data->deleteFunc);
}
tr_torrentClearCompletenessCallback(data->tor);
closeTorrent(data->tor);
tr_free(data);
}
void tr_torrentRemove(tr_torrent* tor, bool deleteFlag, tr_fileFunc deleteFunc)
{
TR_ASSERT(tr_isTorrent(tor));
tor->isDeleting = true;
struct remove_data* data = tr_new0(struct remove_data, 1);
data->tor = tor;
data->deleteFlag = deleteFlag;
data->deleteFunc = deleteFunc;
tr_runInEventThread(tor->session, removeTorrent, data);
}
/**
*** Completeness
**/
static char const* getCompletionString(int type)
{
switch (type)
{
case TR_PARTIAL_SEED:
/* Translators: this is a minor point that's safe to skip over, but FYI:
"Complete" and "Done" are specific, different terms in Transmission:
"Complete" means we've downloaded every file in the torrent.
"Done" means we're done downloading the files we wanted, but NOT all
that exist */
return _("Done");
case TR_SEED:
return _("Complete");
default:
return _("Incomplete");
}
}
static void fireCompletenessChange(tr_torrent* tor, tr_completeness status, bool wasRunning)
{
TR_ASSERT(status == TR_LEECH || status == TR_SEED || status == TR_PARTIAL_SEED);
if (tor->completeness_func != nullptr)
{
(*tor->completeness_func)(tor, status, wasRunning, tor->completeness_func_user_data);
}
}
void tr_torrentSetCompletenessCallback(tr_torrent* tor, tr_torrent_completeness_func func, void* user_data)
{
TR_ASSERT(tr_isTorrent(tor));
tor->completeness_func = func;
tor->completeness_func_user_data = user_data;
}
void tr_torrentClearCompletenessCallback(tr_torrent* torrent)
{
tr_torrentSetCompletenessCallback(torrent, nullptr, nullptr);
}
void tr_torrentSetRatioLimitHitCallback(tr_torrent* tor, tr_torrent_ratio_limit_hit_func func, void* user_data)
{
TR_ASSERT(tr_isTorrent(tor));
tor->ratio_limit_hit_func = func;
tor->ratio_limit_hit_func_user_data = user_data;
}
void tr_torrentClearRatioLimitHitCallback(tr_torrent* torrent)
{
tr_torrentSetRatioLimitHitCallback(torrent, nullptr, nullptr);
}
void tr_torrentSetIdleLimitHitCallback(tr_torrent* tor, tr_torrent_idle_limit_hit_func func, void* user_data)
{
TR_ASSERT(tr_isTorrent(tor));
tor->idle_limit_hit_func = func;
tor->idle_limit_hit_func_user_data = user_data;
}
void tr_torrentClearIdleLimitHitCallback(tr_torrent* torrent)
{
tr_torrentSetIdleLimitHitCallback(torrent, nullptr, nullptr);
}
static std::string buildLabelsString(tr_torrent const* tor)
{
auto buf = std::stringstream{};
for (auto it = std::begin(tor->labels), end = std::end(tor->labels); it != end;)
{
buf << *it;
if (++it != end)
{
buf << ',';
}
}
return buf.str();
}
static std::string buildTrackersString(tr_torrent const* tor)
{
auto buf = std::stringstream{};
for (size_t i = 0, n = tr_torrentTrackerCount(tor); i < n; ++i)
{
buf << tr_torrentTracker(tor, i).host;
if (++i < n)
{
buf << ',';
}
}
return buf.str();
}
static void torrentCallScript(tr_torrent const* tor, char const* script)
{
if (tr_str_is_empty(script))
{
return;
}
time_t const now = tr_time();
struct tm tm;
char ctime_str[32];
tr_localtime_r(&now, &tm);
strftime(ctime_str, sizeof(ctime_str), "%a %b %d %T %Y%n", &tm); /* ctime equiv */
char* const torrent_dir = tr_sys_path_native_separators(tr_strdup(tor->currentDir));
auto const cmd = std::array<char const*, 2>{
script,
nullptr,
};
auto const id_str = std::to_string(tr_torrentId(tor));
auto const labels_str = buildLabelsString(tor);
auto const trackers_str = buildTrackersString(tor);
auto const env = std::map<std::string_view, std::string_view>{
{ "TR_APP_VERSION"sv, SHORT_VERSION_STRING },
{ "TR_TIME_LOCALTIME"sv, ctime_str },
{ "TR_TORRENT_DIR"sv, torrent_dir },
{ "TR_TORRENT_HASH"sv, tor->info.hashString },
{ "TR_TORRENT_ID"sv, id_str },
{ "TR_TORRENT_LABELS"sv, labels_str },
{ "TR_TORRENT_NAME"sv, tr_torrentName(tor) },
{ "TR_TORRENT_TRACKERS"sv, trackers_str },
};
tr_logAddTorInfo(tor, "Calling script \"%s\"", script);
tr_error* error = nullptr;
if (!tr_spawn_async(std::data(cmd), env, TR_IF_WIN32("\\", "/"), &error))
{
tr_logAddTorErr(tor, "Error executing script \"%s\" (%d): %s", script, error->code, error->message);
tr_error_free(error);
}
tr_free(torrent_dir);
}
void tr_torrent::recheckCompleteness()
{
auto const lock = unique_lock();
auto const new_completeness = completion.status();
if (new_completeness != completeness)
{
bool const recentChange = downloadedCur != 0;
bool const wasLeeching = !this->isDone();
bool const wasRunning = isRunning;
if (recentChange)
{
tr_logAddTorInfo(
this,
_("State changed from \"%1$s\" to \"%2$s\""),
getCompletionString(this->completeness),
getCompletionString(completeness));
}
this->completeness = new_completeness;
tr_fdTorrentClose(this->session, this->uniqueId);
if (this->isDone())
{
if (recentChange)
{
tr_announcerTorrentCompleted(this);
this->doneDate = this->anyDate = tr_time();
}
if (wasLeeching && wasRunning)
{
/* clear interested flag on all peers */
tr_peerMgrClearInterest(this);
}
if (this->currentDir == this->incompleteDir)
{
this->setLocation(this->downloadDir, true, nullptr, nullptr);
}
}
fireCompletenessChange(this, completeness, wasRunning);
if (this->isDone() && wasLeeching && wasRunning)
{
/* if completeness was TR_LEECH, the seed limit check
will have been skipped in bandwidthPulse */
tr_torrentCheckSeedLimit(this);
}
this->setDirty();
if (this->isDone())
{
tr_torrentSave(this);
callScriptIfEnabled(this, TR_SCRIPT_ON_TORRENT_DONE);
}
}
}
/***
****
***/
static void tr_torrentFireMetadataCompleted(tr_torrent* tor)
{
TR_ASSERT(tr_isTorrent(tor));
if (tor->metadata_func != nullptr)
{
(*tor->metadata_func)(tor, tor->metadata_func_user_data);
}
}
void tr_torrentSetMetadataCallback(tr_torrent* tor, tr_torrent_metadata_func func, void* user_data)
{
TR_ASSERT(tr_isTorrent(tor));
tor->metadata_func = func;
tor->metadata_func_user_data = user_data;
}
/**
*** File DND
**/
void tr_torrentSetFileDLs(tr_torrent* tor, tr_file_index_t const* files, tr_file_index_t n_files, bool wanted)
{
TR_ASSERT(tr_isTorrent(tor));
tor->setFilesWanted(files, n_files, wanted);
}
/***
****
***/
void tr_torrentSetLabels(tr_torrent* tor, tr_labels_t&& labels)
{
TR_ASSERT(tr_isTorrent(tor));
auto const lock = tor->unique_lock();
tor->labels = std::move(labels);
tr_torrentSetDirty(tor);
}
/***
****
***/
tr_priority_t tr_torrentGetPriority(tr_torrent const* tor)
{
TR_ASSERT(tr_isTorrent(tor));
return tor->bandwidth->getPriority();
}
void tr_torrentSetPriority(tr_torrent* tor, tr_priority_t priority)
{
TR_ASSERT(tr_isTorrent(tor));
TR_ASSERT(tr_isPriority(priority));
if (tor->bandwidth->getPriority() != priority)
{
tor->bandwidth->setPriority(priority);
tr_torrentSetDirty(tor);
}
}
/***
****
***/
void tr_torrentSetPeerLimit(tr_torrent* tor, uint16_t maxConnectedPeers)
{
TR_ASSERT(tr_isTorrent(tor));
if (tor->maxConnectedPeers != maxConnectedPeers)
{
tor->maxConnectedPeers = maxConnectedPeers;
tr_torrentSetDirty(tor);
}
}
uint16_t tr_torrentGetPeerLimit(tr_torrent const* tor)
{
TR_ASSERT(tr_isTorrent(tor));
return tor->maxConnectedPeers;
}
/***
****
***/
void tr_torrentGetBlockLocation(
tr_torrent const* tor,
tr_block_index_t block,
tr_piece_index_t* piece,
uint32_t* offset,
uint32_t* length)
{
uint64_t pos = block;
pos *= tor->block_size;
*piece = pos / tor->info.pieceSize;
uint64_t piece_begin = tor->info.pieceSize;
piece_begin *= *piece;
*offset = pos - piece_begin;
*length = tor->blockSize(block);
}
bool tr_torrentReqIsValid(tr_torrent const* tor, tr_piece_index_t index, uint32_t offset, uint32_t length)
{
TR_ASSERT(tr_isTorrent(tor));
int err = 0;
if (index >= tor->info.pieceCount)
{
err = 1;
}
else if (length < 1)
{
err = 2;
}
else if (offset + length > tor->pieceSize(index))
{
err = 3;
}
else if (length > MAX_BLOCK_SIZE)
{
err = 4;
}
else if (tr_pieceOffset(tor, index, offset, length) > tor->info.totalSize)
{
err = 5;
}
if (err != 0)
{
tr_logAddTorDbg(
tor,
"index %lu offset %lu length %lu err %d\n",
(unsigned long)index,
(unsigned long)offset,
(unsigned long)length,
err);
}
return err == 0;
}
// TODO(ckerr) migrate to block_info
uint64_t tr_pieceOffset(tr_torrent const* tor, tr_piece_index_t index, uint32_t offset, uint32_t length)
{
TR_ASSERT(tr_isTorrent(tor));
auto ret = uint64_t{};
ret = tor->info.pieceSize;
ret *= index;
ret += offset;
ret += length;
return ret;
}
// TODO(ckerr) migrate to fpm
tr_block_span_t tr_torGetFileBlockSpan(tr_torrent const* tor, tr_file_index_t const i)
{
tr_file const& file = tor->file(i);
uint64_t offset = file.priv.offset;
tr_block_index_t const begin = offset / tor->block_size;
if (file.length == 0)
{
return { begin, begin };
}
offset += file.length - 1;
tr_block_index_t const end = 1 + offset / tor->block_size;
return { begin, end };
}
/***
****
***/
// TODO: should be const after tr_ioTestPiece() is const
bool tr_torrent::checkPiece(tr_piece_index_t piece)
{
bool const pass = tr_ioTestPiece(this, piece);
tr_logAddTorDbg(this, "[LAZY] tr_torrent.checkPiece tested piece %zu, pass==%d", size_t(piece), int(pass));
return pass;
}
/***
****
***/
bool tr_torrentSetAnnounceList(tr_torrent* tor, char const* const* announce_urls, tr_tracker_tier_t const* tiers, size_t n)
{
TR_ASSERT(tr_isTorrent(tor));
auto const lock = tor->unique_lock();
auto announce_list = tr_announce_list();
if (!announce_list.set(announce_urls, tiers, n) || !announce_list.save(tor->info.torrent))
{
return false;
}
std::swap(*tor->info.announce_list, announce_list);
tr_torrentMarkEdited(tor);
/* if we had a tracker-related error on this torrent,
* and that tracker's been removed,
* then clear the error */
if (tor->error == TR_STAT_TRACKER_WARNING || tor->error == TR_STAT_TRACKER_ERROR)
{
auto const error_url = tor->error_announce_url;
if (std::any_of(
std::begin(*tor->info.announce_list),
std::end(*tor->info.announce_list),
[error_url](auto const& tracker) { return tracker.announce_interned == error_url; }))
{
tr_torrentClearError(tor);
}
}
/* tell the announcer to reload this torrent's tracker list */
tr_announcerResetTorrent(tor->session->announcer, tor);
return true;
}
/**
***
**/
#define BACK_COMPAT_FUNC(oldname, newname) \
void oldname(tr_torrent* tor, time_t t) \
{ \
newname(tor, t); \
}
BACK_COMPAT_FUNC(tr_torrentSetAddedDate, tr_torrentSetDateAdded)
BACK_COMPAT_FUNC(tr_torrentSetActivityDate, tr_torrentSetDateActive)
BACK_COMPAT_FUNC(tr_torrentSetDoneDate, tr_torrentSetDateDone)
#undef BACK_COMPAT_FUNC
void tr_torrentSetDateAdded(tr_torrent* tor, time_t t)
{
TR_ASSERT(tr_isTorrent(tor));
tor->addedDate = t;
tor->anyDate = std::max(tor->anyDate, tor->addedDate);
}
void tr_torrentSetDateActive(tr_torrent* tor, time_t t)
{
TR_ASSERT(tr_isTorrent(tor));
tor->activityDate = t;
tor->anyDate = std::max(tor->anyDate, tor->activityDate);
}
void tr_torrentSetDateDone(tr_torrent* tor, time_t t)
{
TR_ASSERT(tr_isTorrent(tor));
tor->doneDate = t;
tor->anyDate = std::max(tor->anyDate, tor->doneDate);
}
/**
***
**/
uint64_t tr_torrentGetBytesLeftToAllocate(tr_torrent const* tor)
{
TR_ASSERT(tr_isTorrent(tor));
uint64_t bytesLeft = 0;
for (tr_file_index_t i = 0, n = tor->fileCount(); i < n; ++i)
{
auto const file = tr_torrentFile(tor, i);
if (file.wanted)
{
uint64_t const length = file.length;
char* path = tr_torrentFindFile(tor, i);
bytesLeft += length;
tr_sys_path_info info;
if (path != nullptr && tr_sys_path_get_info(path, 0, &info, nullptr) && info.type == TR_SYS_PATH_IS_FILE &&
info.size <= length)
{
bytesLeft -= info.size;
}
tr_free(path);
}
}
return bytesLeft;
}
/****
***** Removing the torrent's local data
****/
static constexpr bool isJunkFile(std::string_view base)
{
auto constexpr Files = std::array<std::string_view, 3>{
".DS_Store"sv,
"Thumbs.db"sv,
"desktop.ini"sv,
};
// TODO(C++20): std::any_of is constexpr in C++20
for (auto const& file : Files)
{
if (file == base)
{
return true;
}
}
#ifdef __APPLE__
// check for resource forks. <http://support.apple.com/kb/TA20578>
if (tr_strvStartsWith(base, "._"sv))
{
return true;
}
#endif
return false;
}
static void removeEmptyFoldersAndJunkFiles(char const* folder)
{
auto const odir = tr_sys_dir_open(folder, nullptr);
if (odir == TR_BAD_SYS_DIR)
{
return;
}
char const* name = nullptr;
while ((name = tr_sys_dir_read_name(odir, nullptr)) != nullptr)
{
if (strcmp(name, ".") != 0 && strcmp(name, "..") != 0)
{
auto const filename = tr_strvPath(folder, name);
auto info = tr_sys_path_info{};
if (tr_sys_path_get_info(filename.c_str(), 0, &info, nullptr) && info.type == TR_SYS_PATH_IS_DIRECTORY)
{
removeEmptyFoldersAndJunkFiles(filename.c_str());
}
else if (isJunkFile(name))
{
tr_sys_path_remove(filename.c_str(), nullptr);
}
}
}
tr_sys_path_remove(folder, nullptr);
tr_sys_dir_close(odir, nullptr);
}
/**
* This convoluted code does something (seemingly) simple:
* remove the torrent's local files.
*
* Fun complications:
* 1. Try to preserve the directory hierarchy in the recycle bin.
* 2. If there are nontorrent files, don't delete them...
* 3. ...unless the other files are "junk", such as .DS_Store
*/
static void deleteLocalData(tr_torrent* tor, tr_fileFunc func)
{
auto files = std::vector<std::string>{};
auto folders = std::set<std::string>{};
char const* const top = tor->currentDir;
/* don't try to delete local data if the directory's gone missing */
if (!tr_sys_path_exists(top, nullptr))
{
return;
}
/* if it's a magnet link, there's nothing to move... */
if (!tr_torrentHasMetadata(tor))
{
return;
}
/***
**** Move the local data to a new tmpdir
***/
auto tmpdir = tr_strvPath(top, TR_PATH_DELIMITER_STR, tr_torrentName(tor), "__XXXXXX");
tr_sys_dir_create_temp(std::data(tmpdir), nullptr);
for (tr_file_index_t f = 0, n = tor->fileCount(); f < n; ++f)
{
/* try to find the file, looking in the partial and download dirs */
auto filename = tr_strvPath(top, tor->file(f).name);
if (!tr_sys_path_exists(filename.c_str(), nullptr))
{
filename += ".part"sv;
if (!tr_sys_path_exists(filename.c_str(), nullptr))
{
filename.clear();
}
}
/* if we found the file, move it */
if (!std::empty(filename))
{
auto target = tr_strvPath(tmpdir, tor->file(f).name);
tr_moveFile(filename.c_str(), target.c_str(), nullptr);
files.emplace_back(target);
}
}
/***
**** Remove tmpdir.
****
**** Try deleting the top-level files & folders to preserve
**** the directory hierarchy in the recycle bin.
**** If case that fails -- for example, rmdir () doesn't
**** delete nonempty folders -- go from the bottom up too.
***/
/* try deleting the local data's top-level files & folders */
tr_sys_dir_t const odir = tr_sys_dir_open(tmpdir.c_str(), nullptr);
if (odir != TR_BAD_SYS_DIR)
{
char const* name = nullptr;
while ((name = tr_sys_dir_read_name(odir, nullptr)) != nullptr)
{
if (strcmp(name, ".") != 0 && strcmp(name, "..") != 0)
{
auto const file = tr_strvPath(tmpdir, name);
(*func)(file.c_str(), nullptr);
}
}
tr_sys_dir_close(odir, nullptr);
}
/* go from the bottom up */
for (auto const& file : files)
{
char* walk = tr_strvDup(file);
while (tr_sys_path_exists(walk, nullptr) && !tr_sys_path_is_same(tmpdir.c_str(), walk, nullptr))
{
char* tmp = tr_sys_path_dirname(walk, nullptr);
(*func)(walk, nullptr);
tr_free(walk);
walk = tmp;
}
tr_free(walk);
}
/***
**** The local data has been removed.
**** What's left in top are empty folders, junk, and user-generated files.
**** Remove the first two categories and leave the third.
***/
/* build a list of 'top's child directories that belong to this torrent */
for (tr_file_index_t f = 0, n = tor->fileCount(); f < n; ++f)
{
/* get the directory that this file goes in... */
auto const filename = tr_strvPath(top, tor->file(f).name);
char* dir = tr_sys_path_dirname(filename.c_str(), nullptr);
if (dir == nullptr)
{
continue;
}
/* walk up the directory tree until we reach 'top' */
if (!tr_sys_path_is_same(top, dir, nullptr) && strcmp(top, dir) != 0)
{
for (;;)
{
char* parent = tr_sys_path_dirname(dir, nullptr);
if (tr_sys_path_is_same(top, parent, nullptr) || strcmp(top, parent) == 0)
{
folders.emplace(dir);
tr_free(parent);
break;
}
/* walk upwards to parent */
tr_free(dir);
dir = parent;
}
}
tr_free(dir);
}
for (auto const& folder : folders)
{
removeEmptyFoldersAndJunkFiles(folder.c_str());
}
/* cleanup */
tr_sys_path_remove(tmpdir.c_str(), nullptr);
}
static void tr_torrentDeleteLocalData(tr_torrent* tor, tr_fileFunc func)
{
TR_ASSERT(tr_isTorrent(tor));
if (func == nullptr)
{
func = tr_sys_path_remove;
}
/* close all the files because we're about to delete them */
tr_cacheFlushTorrent(tor->session->cache, tor);
tr_fdTorrentClose(tor->session, tor->uniqueId);
deleteLocalData(tor, func);
}
/***
****
***/
struct LocationData
{
std::string location;
tr_torrent* tor = nullptr;
double volatile* setme_progress = nullptr;
int volatile* setme_state = nullptr;
bool move_from_old_location = false;
};
static void setLocationImpl(void* vdata)
{
auto* data = static_cast<struct LocationData*>(vdata);
tr_torrent* tor = data->tor;
TR_ASSERT(tr_isTorrent(tor));
auto const lock = tor->unique_lock();
bool err = false;
bool const do_move = data->move_from_old_location;
auto const& location = data->location;
double bytesHandled = 0;
tr_logAddDebug(
"Moving \"%s\" location from currentDir \"%s\" to \"%s\"",
tr_torrentName(tor),
tor->currentDir,
location.c_str());
tr_sys_dir_create(location.c_str(), TR_SYS_DIR_CREATE_PARENTS, 0777, nullptr);
if (!tr_sys_path_is_same(location.c_str(), tor->currentDir, nullptr))
{
/* bad idea to move files while they're being verified... */
tr_verifyRemove(tor);
/* try to move the files.
* FIXME: there are still all kinds of nasty cases, like what
* if the target directory runs out of space halfway through... */
for (tr_file_index_t i = 0, n = tor->fileCount(); !err && i < n; ++i)
{
auto const file_length = tor->file(i).length;
char const* oldbase = nullptr;
char* sub = nullptr;
if (tr_torrentFindFile2(tor, i, &oldbase, &sub, nullptr))
{
auto const oldpath = tr_strvPath(oldbase, sub);
auto const newpath = tr_strvPath(location, sub);
tr_logAddDebug("Found file #%d: %s", (int)i, oldpath.c_str());
if (do_move && !tr_sys_path_is_same(oldpath.c_str(), newpath.c_str(), nullptr))
{
tr_error* error = nullptr;
tr_logAddTorInfo(tor, "moving \"%s\" to \"%s\"", oldpath.c_str(), newpath.c_str());
if (!tr_moveFile(oldpath.c_str(), newpath.c_str(), &error))
{
err = true;
tr_logAddTorErr(
tor,
"error moving \"%s\" to \"%s\": %s",
oldpath.c_str(),
newpath.c_str(),
error->message);
tr_error_free(error);
}
}
tr_free(sub);
}
if (data->setme_progress != nullptr)
{
bytesHandled += file_length;
*data->setme_progress = bytesHandled / tor->info.totalSize;
}
}
if (!err && do_move)
{
/* blow away the leftover subdirectories in the old location */
tr_torrentDeleteLocalData(tor, tr_sys_path_remove);
}
}
if (!err)
{
/* set the new location and reverify */
tr_torrentSetDownloadDir(tor, location.c_str());
if (do_move)
{
tr_free(tor->incompleteDir);
tor->incompleteDir = nullptr;
tor->currentDir = tor->downloadDir;
}
}
if (data->setme_state != nullptr)
{
*data->setme_state = err ? TR_LOC_ERROR : TR_LOC_DONE;
}
/* cleanup */
delete data;
}
void tr_torrent::setLocation(
std::string_view location,
bool move_from_old_location,
double volatile* setme_progress,
int volatile* setme_state)
{
if (setme_state != nullptr)
{
*setme_state = TR_LOC_MOVING;
}
if (setme_progress != nullptr)
{
*setme_progress = 0;
}
/* run this in the libtransmission thread */
auto* const data = new LocationData{};
data->tor = this;
data->location = location;
data->move_from_old_location = move_from_old_location;
data->setme_state = setme_state;
data->setme_progress = setme_progress;
tr_runInEventThread(this->session, setLocationImpl, data);
}
void tr_torrentSetLocation(
tr_torrent* tor,
char const* location,
bool move_from_old_location,
double volatile* setme_progress,
int volatile* setme_state)
{
TR_ASSERT(tr_isTorrent(tor));
TR_ASSERT(!tr_str_is_empty(location));
return tor->setLocation(location ? location : "", move_from_old_location, setme_progress, setme_state);
}
std::string_view tr_torrentPrimaryMimeType(tr_torrent const* tor)
{
// count up how many bytes there are for each mime-type in the torrent
// NB: get_mime_type_for_filename() always returns the same ptr for a
// mime_type, so its raw pointer can be used as a key.
auto size_per_mime_type = std::unordered_map<std::string_view, size_t>{};
for (tr_file_index_t i = 0, n = tor->fileCount(); i < n; ++i)
{
auto const& file = tor->file(i);
auto const mime_type = tr_get_mime_type_for_filename(file.name);
size_per_mime_type[mime_type] += file.length;
}
if (std::empty(size_per_mime_type))
{
// https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types
// application/octet-stream is the default value for all other cases.
// An unknown file type should use this type.
auto constexpr Fallback = "application/octet-stream"sv;
return Fallback;
}
auto const it = std::max_element(
std::begin(size_per_mime_type),
std::end(size_per_mime_type),
[](auto const& a, auto const& b) { return a.second < b.second; });
return it->first;
}
/***
****
***/
static void tr_torrentFileCompleted(tr_torrent* tor, tr_file_index_t i)
{
/* close the file so that we can reopen in read-only mode as needed */
tr_cacheFlushFile(tor->session->cache, tor, i);
tr_fdFileClose(tor->session, tor, i);
/* now that the file is complete and closed, we can start watching its
* mtime timestamp for changes to know if we need to reverify pieces */
tr_file& file = tor->file(i);
file.priv.mtime = tr_time();
/* if the torrent's current filename isn't the same as the one in the
* metadata -- for example, if it had the ".part" suffix appended to
* it until now -- then rename it to match the one in the metadata */
char const* base = nullptr;
char* sub = nullptr;
if (tr_torrentFindFile2(tor, i, &base, &sub, nullptr))
{
if (strcmp(sub, file.name) != 0)
{
auto const oldpath = tr_strvPath(base, sub);
auto const newpath = tr_strvPath(base, file.name);
tr_error* error = nullptr;
if (!tr_sys_path_rename(oldpath.c_str(), newpath.c_str(), &error))
{
tr_logAddTorErr(tor, "Error moving \"%s\" to \"%s\": %s", oldpath.c_str(), newpath.c_str(), error->message);
tr_error_free(error);
}
}
tr_free(sub);
}
}
static void tr_torrentPieceCompleted(tr_torrent* tor, tr_piece_index_t pieceIndex)
{
tr_peerMgrPieceCompleted(tor, pieceIndex);
// if this piece completes any file, invoke the fileCompleted func for it
auto const [begin, end] = tor->fpm_.fileSpan(pieceIndex);
for (tr_file_index_t file = begin; file < end; ++file)
{
if (tor->completion.hasBlocks(tr_torGetFileBlockSpan(tor, file)))
{
tr_torrentFileCompleted(tor, file);
}
}
}
void tr_torrentGotBlock(tr_torrent* tor, tr_block_index_t block)
{
TR_ASSERT(tr_isTorrent(tor));
TR_ASSERT(tr_amInEventThread(tor->session));
bool const block_is_new = !tor->hasBlock(block);
if (block_is_new)
{
tor->completion.addBlock(block);
tr_torrentSetDirty(tor);
tr_piece_index_t const p = tor->pieceForBlock(block);
if (tor->hasPiece(p))
{
if (tor->checkPiece(p))
{
tr_torrentPieceCompleted(tor, p);
}
else
{
uint32_t const n = tor->pieceSize(p);
tr_logAddTorErr(tor, _("Piece %" PRIu32 ", which was just downloaded, failed its checksum test"), p);
tor->corruptCur += n;
tor->downloadedCur -= std::min(tor->downloadedCur, uint64_t{ n });
tr_peerMgrGotBadPiece(tor, p);
}
}
}
else
{
uint32_t const n = tor->blockSize(block);
tor->downloadedCur -= std::min(tor->downloadedCur, uint64_t{ n });
tr_logAddTorDbg(tor, "we have this block already...");
}
}
/***
****
***/
std::optional<tr_torrent::tr_found_file_t> tr_torrent::findFile(std::string& filename, tr_file_index_t i) const
{
tr_file const& file = this->file(i);
auto file_info = tr_sys_path_info{};
if (this->downloadDir != nullptr)
{
auto base = std::string_view{ this->downloadDir };
tr_buildBuf(filename, base, "/"sv, file.name);
if (tr_sys_path_get_info(filename.c_str(), 0, &file_info, nullptr))
{
return tr_found_file_t{ file_info, filename, base };
}
tr_buildBuf(filename, base, "/"sv, file.name, ".part"sv);
if (tr_sys_path_get_info(filename.c_str(), 0, &file_info, nullptr))
{
return tr_found_file_t{ file_info, filename, base };
}
}
if (this->incompleteDir != nullptr)
{
auto const base = std::string_view{ this->incompleteDir };
tr_buildBuf(filename, base, "/"sv, file.name);
if (tr_sys_path_get_info(filename.c_str(), 0, &file_info, nullptr))
{
return tr_found_file_t{ file_info, filename, base };
}
tr_buildBuf(filename, base, "/"sv, file.name, ".part"sv);
if (tr_sys_path_get_info(filename.c_str(), 0, &file_info, nullptr))
{
return tr_found_file_t{ file_info, filename, base };
}
}
return {};
}
// TODO: clients that call this should call tr_torrent::findFile() instead
bool tr_torrentFindFile2(tr_torrent const* tor, tr_file_index_t fileNum, char const** base, char** subpath, time_t* mtime)
{
auto filename = std::string{};
auto const found = tor->findFile(filename, fileNum);
if (!found)
{
return false;
}
if (base != nullptr)
{
*base = std::data(found->base);
}
if (subpath != nullptr)
{
*subpath = tr_strndup(std::data(found->subpath), std::size(found->subpath));
}
if (mtime != nullptr)
{
*mtime = found->last_modified_at;
}
return true;
}
// TODO: clients that call this should call tr_torrent::findFile() instead
char* tr_torrentFindFile(tr_torrent const* tor, tr_file_index_t fileNum)
{
auto filename = std::string{};
auto const found = tor->findFile(filename, fileNum);
return found ? tr_strdup(filename.c_str()) : nullptr;
}
/* Decide whether we should be looking for files in downloadDir or incompleteDir. */
static void refreshCurrentDir(tr_torrent* tor)
{
char const* dir = nullptr;
if (tor->incompleteDir == nullptr)
{
dir = tor->downloadDir;
}
else if (!tr_torrentHasMetadata(tor)) /* no files to find */
{
dir = tor->incompleteDir;
}
else if (!tr_torrentFindFile2(tor, 0, &dir, nullptr, nullptr))
{
dir = tor->incompleteDir;
}
TR_ASSERT(dir != nullptr);
TR_ASSERT(dir == tor->downloadDir || dir == tor->incompleteDir);
tor->currentDir = dir;
}
char* tr_torrentBuildPartial(tr_torrent const* tor, tr_file_index_t i)
{
return tr_strdup_printf("%s.part", tor->file(i).name);
}
/***
****
***/
#ifdef TR_ENABLE_ASSERTS
static bool queueIsSequenced(tr_session* session)
{
auto torrents = tr_sessionGetTorrents(session);
std::sort(
std::begin(torrents),
std::end(torrents),
[](auto const* a, auto const* b) { return a->queuePosition < b->queuePosition; });
#if 0
fprintf(stderr, "%s", "queue: ");
for (int i = 0; i < n; ++i)
{
fprintf(stderr, "%d ", tmp[i]->queuePosition);
}
fputc('\n', stderr);
#endif
/* test them */
bool is_sequenced = true;
for (int i = 0, n = std::size(torrents); is_sequenced && i < n; ++i)
{
is_sequenced = torrents[i]->queuePosition == i;
}
return is_sequenced;
}
#endif
int tr_torrentGetQueuePosition(tr_torrent const* tor)
{
return tor->queuePosition;
}
void tr_torrentSetQueuePosition(tr_torrent* tor, int pos)
{
int back = -1;
int const old_pos = tor->queuePosition;
time_t const now = tr_time();
if (pos < 0)
{
pos = 0;
}
tor->queuePosition = -1;
for (auto* walk : tor->session->torrents)
{
if ((old_pos < pos) && (old_pos <= walk->queuePosition) && (walk->queuePosition <= pos))
{
walk->queuePosition--;
walk->anyDate = now;
}
if ((old_pos > pos) && (pos <= walk->queuePosition) && (walk->queuePosition < old_pos))
{
walk->queuePosition++;
walk->anyDate = now;
}
if (back < walk->queuePosition)
{
back = walk->queuePosition;
}
}
tor->queuePosition = std::min(pos, back + 1);
tor->anyDate = now;
TR_ASSERT(queueIsSequenced(tor->session));
}
struct CompareTorrentByQueuePosition
{
bool operator()(tr_torrent const* a, tr_torrent const* b) const
{
return a->queuePosition < b->queuePosition;
}
};
void tr_torrentsQueueMoveTop(tr_torrent* const* torrents_in, size_t n)
{
auto torrents = std::vector<tr_torrent*>(torrents_in, torrents_in + n);
std::sort(std::rbegin(torrents), std::rend(torrents), CompareTorrentByQueuePosition{});
for (auto* tor : torrents)
{
tr_torrentSetQueuePosition(tor, 0);
}
}
void tr_torrentsQueueMoveUp(tr_torrent* const* torrents_in, size_t n)
{
auto torrents = std::vector<tr_torrent*>(torrents_in, torrents_in + n);
std::sort(std::begin(torrents), std::end(torrents), CompareTorrentByQueuePosition{});
for (auto* tor : torrents)
{
tr_torrentSetQueuePosition(tor, tor->queuePosition - 1);
}
}
void tr_torrentsQueueMoveDown(tr_torrent* const* torrents_in, size_t n)
{
auto torrents = std::vector<tr_torrent*>(torrents_in, torrents_in + n);
std::sort(std::rbegin(torrents), std::rend(torrents), CompareTorrentByQueuePosition{});
for (auto* tor : torrents)
{
tr_torrentSetQueuePosition(tor, tor->queuePosition + 1);
}
}
void tr_torrentsQueueMoveBottom(tr_torrent* const* torrents_in, size_t n)
{
auto torrents = std::vector<tr_torrent*>(torrents_in, torrents_in + n);
std::sort(std::begin(torrents), std::end(torrents), CompareTorrentByQueuePosition{});
for (auto* tor : torrents)
{
tr_torrentSetQueuePosition(tor, INT_MAX);
}
}
static void torrentSetQueued(tr_torrent* tor, bool queued)
{
TR_ASSERT(tr_isTorrent(tor));
if (tr_torrentIsQueued(tor) != queued)
{
tor->isQueued = queued;
tor->anyDate = tr_time();
tr_torrentSetDirty(tor);
}
}
void tr_torrentSetQueueStartCallback(tr_torrent* torrent, void (*callback)(tr_torrent*, void*), void* user_data)
{
torrent->queue_started_callback = callback;
torrent->queue_started_user_data = user_data;
}
/***
****
**** RENAME
****
***/
static bool renameArgsAreValid(char const* oldpath, char const* newname)
{
return !tr_str_is_empty(oldpath) && !tr_str_is_empty(newname) && strcmp(newname, ".") != 0 && strcmp(newname, "..") != 0 &&
strchr(newname, TR_PATH_DELIMITER) == nullptr;
}
static tr_file_index_t* renameFindAffectedFiles(tr_torrent* tor, char const* oldpath, size_t* setme_n)
{
auto const n_files = tor->fileCount();
auto n_affected_files = size_t{};
tr_file_index_t* indices = tr_new0(tr_file_index_t, n_files);
auto const oldpath_len = strlen(oldpath);
for (tr_file_index_t i = 0; i < n_files; ++i)
{
char const* name = tor->file(i).name;
size_t const len = strlen(name);
if ((len == oldpath_len || (len > oldpath_len && name[oldpath_len] == '/')) && memcmp(oldpath, name, oldpath_len) == 0)
{
indices[n_affected_files++] = i;
}
}
*setme_n = n_affected_files;
return indices;
}
static int renamePath(tr_torrent* tor, char const* oldpath, char const* newname)
{
int err = 0;
char const* const base = !tor->isDone() && tor->incompleteDir != nullptr ? tor->incompleteDir : tor->downloadDir;
auto src = tr_strvPath(base, oldpath);
if (!tr_sys_path_exists(src.c_str(), nullptr)) /* check for it as a partial */
{
src += ".part"sv;
}
if (tr_sys_path_exists(src.c_str(), nullptr))
{
char* const parent = tr_sys_path_dirname(src.c_str(), nullptr);
auto const tgt = tr_strvEndsWith(src, ".part"sv) ? tr_strvJoin(parent, TR_PATH_DELIMITER_STR, newname, ".part"sv) :
tr_strvPath(parent, newname);
auto tmp = errno;
bool const tgt_exists = tr_sys_path_exists(tgt.c_str(), nullptr);
errno = tmp;
if (!tgt_exists)
{
tr_error* error = nullptr;
tmp = errno;
if (!tr_sys_path_rename(src.c_str(), tgt.c_str(), &error))
{
err = error->code;
tr_error_free(error);
}
errno = tmp;
}
tr_free(parent);
}
return err;
}
static void renameTorrentFileString(tr_torrent* tor, char const* oldpath, char const* newname, tr_file_index_t fileIndex)
{
char* name = nullptr;
tr_file& file = tor->file(fileIndex);
size_t const oldpath_len = strlen(oldpath);
if (strchr(oldpath, TR_PATH_DELIMITER) == nullptr)
{
if (oldpath_len >= strlen(file.name))
{
name = tr_buildPath(newname, nullptr);
}
else
{
name = tr_buildPath(newname, file.name + oldpath_len + 1, nullptr);
}
}
else
{
char* tmp = tr_sys_path_dirname(oldpath, nullptr);
if (tmp == nullptr)
{
return;
}
if (oldpath_len >= strlen(file.name))
{
name = tr_buildPath(tmp, newname, nullptr);
}
else
{
name = tr_buildPath(tmp, newname, file.name + oldpath_len + 1, nullptr);
}
tr_free(tmp);
}
if (strcmp(file.name, name) == 0)
{
tr_free(name);
}
else
{
tr_free(file.name);
file.name = name;
file.priv.is_renamed = true;
}
}
struct rename_data
{
tr_torrent* tor;
char* oldpath;
char* newname;
tr_torrent_rename_done_func callback;
void* callback_user_data;
};
static void torrentRenamePath(void* vdata)
{
auto* data = static_cast<struct rename_data*>(vdata);
tr_torrent* const tor = data->tor;
TR_ASSERT(tr_isTorrent(tor));
/***
****
***/
int error = 0;
char const* const oldpath = data->oldpath;
char const* const newname = data->newname;
if (!renameArgsAreValid(oldpath, newname))
{
error = EINVAL;
}
else
{
auto n = size_t{};
tr_file_index_t* const file_indices = renameFindAffectedFiles(tor, oldpath, &n);
if (n == 0)
{
error = EINVAL;
}
else
{
error = renamePath(tor, oldpath, newname);
if (error == 0)
{
/* update tr_info.files */
for (size_t i = 0; i < n; ++i)
{
renameTorrentFileString(tor, oldpath, newname, file_indices[i]);
}
/* update tr_info.name if user changed the toplevel */
if (n == tor->fileCount() && strchr(oldpath, '/') == nullptr)
{
tr_free(tor->info.name);
tor->info.name = tr_strdup(newname);
}
tr_torrentMarkEdited(tor);
tr_torrentSetDirty(tor);
}
}
tr_free(file_indices);
}
/***
****
***/
tor->anyDate = tr_time();
/* callback */
if (data->callback != nullptr)
{
(*data->callback)(tor, data->oldpath, data->newname, error, data->callback_user_data);
}
/* cleanup */
tr_free(data->oldpath);
tr_free(data->newname);
tr_free(data);
}
void tr_torrent::renamePath(
std::string_view oldpath,
std::string_view newname,
tr_torrent_rename_done_func callback,
void* callback_user_data)
{
auto* const data = tr_new0(struct rename_data, 1);
data->tor = this;
data->oldpath = tr_strvDup(oldpath);
data->newname = tr_strvDup(newname);
data->callback = callback;
data->callback_user_data = callback_user_data;
tr_runInEventThread(this->session, torrentRenamePath, data);
}
void tr_torrentRenamePath(
tr_torrent* tor,
char const* oldpath,
char const* newname,
tr_torrent_rename_done_func callback,
void* callback_user_data)
{
oldpath = oldpath != nullptr ? oldpath : "";
newname = newname != nullptr ? newname : "";
tor->renamePath(oldpath, newname, callback, callback_user_data);
}
void tr_torrent::swapMetainfo(tr_metainfo_parsed& parsed)
{
std::swap(this->info, parsed.info);
std::swap(this->piece_checksums_, parsed.pieces);
std::swap(this->infoDictLength, parsed.info_dict_length);
}
void tr_torrentSetFilePriorities(
tr_torrent* tor,
tr_file_index_t const* files,
tr_file_index_t fileCount,
tr_priority_t priority)
{
tor->setFilePriorities(files, fileCount, priority);
}
bool tr_torrentHasMetadata(tr_torrent const* tor)
{
return tor->info.fileCount > 0;
}
Reference in New Issue View Git Blame Copy Permalink