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

2194 lines
58 KiB
C++
Raw Blame History

// This file Copyright © 2008-2023 Mnemosyne LLC.
// It may be used under GPLv2 (SPDX: GPL-2.0-only), GPLv3 (SPDX: GPL-3.0-only),
// or any future license endorsed by Mnemosyne LLC.
// License text can be found in the licenses/ folder.
#include <algorithm> // std::partial_sort(), std::min(), std::max()
#include <climits> /* INT_MAX */
#include <condition_variable>
#include <csignal>
#include <cstdint>
#include <cstdlib> // atoi()
#include <ctime>
#include <future>
#include <iterator> // for std::back_inserter
#include <list>
#include <memory>
#include <numeric> // for std::accumulate()
#include <string>
#include <string_view>
#include <unordered_set>
#include <utility>
#include <vector>
#ifndef _WIN32
#include <sys/types.h> /* umask() */
#include <sys/stat.h> /* umask() */
#endif
#include <event2/event.h>
#include <fmt/chrono.h>
#include <fmt/core.h>
#include <fmt/format.h> // fmt::ptr
#include "transmission.h"
#include "announcer.h"
#include "bandwidth.h"
#include "blocklist.h"
#include "cache.h"
#include "crypto-utils.h"
#include "error-types.h"
#include "error.h"
#include "file.h"
#include "log.h"
#include "net.h"
#include "peer-io.h"
#include "peer-mgr.h"
#include "port-forwarding.h"
#include "rpc-server.h"
#include "session-id.h"
#include "session.h"
#include "timer-ev.h"
#include "torrent.h"
#include "tr-assert.h"
#include "tr-lpd.h"
#include "tr-strbuf.h"
#include "tr-utp.h"
#include "utils.h"
#include "variant.h"
#include "verify.h"
#include "version.h"
#include "web.h"
using namespace std::literals;
namespace
{
namespace bandwidth_group_helpers
{
auto constexpr BandwidthGroupsFilename = "bandwidth-groups.json"sv;
void bandwidthGroupRead(tr_session* session, std::string_view config_dir)
{
auto const filename = tr_pathbuf{ config_dir, '/', BandwidthGroupsFilename };
auto groups_dict = tr_variant{};
if (!tr_sys_path_exists(filename) || !tr_variantFromFile(&groups_dict, TR_VARIANT_PARSE_JSON, filename, nullptr) ||
!tr_variantIsDict(&groups_dict))
{
return;
}
auto idx = size_t{ 0 };
auto key = tr_quark{};
tr_variant* dict = nullptr;
while (tr_variantDictChild(&groups_dict, idx, &key, &dict))
{
++idx;
auto name = tr_interned_string(key);
auto& group = session->getBandwidthGroup(name);
auto limits = tr_bandwidth_limits{};
tr_variantDictFindBool(dict, TR_KEY_uploadLimited, &limits.up_limited);
tr_variantDictFindBool(dict, TR_KEY_downloadLimited, &limits.down_limited);
if (auto limit = int64_t{}; tr_variantDictFindInt(dict, TR_KEY_uploadLimit, &limit))
{
limits.up_limit_KBps = static_cast<tr_kilobytes_per_second_t>(limit);
}
if (auto limit = int64_t{}; tr_variantDictFindInt(dict, TR_KEY_downloadLimit, &limit))
{
limits.down_limit_KBps = static_cast<tr_kilobytes_per_second_t>(limit);
}
group.setLimits(&limits);
if (auto honors = bool{}; tr_variantDictFindBool(dict, TR_KEY_honorsSessionLimits, &honors))
{
group.honorParentLimits(TR_UP, honors);
group.honorParentLimits(TR_DOWN, honors);
}
}
tr_variantClear(&groups_dict);
}
int bandwidthGroupWrite(tr_session const* session, std::string_view config_dir)
{
auto const& groups = session->bandwidthGroups();
auto groups_dict = tr_variant{};
tr_variantInitDict(&groups_dict, std::size(groups));
for (auto const& [name, group] : groups)
{
auto const limits = group->getLimits();
auto* const dict = tr_variantDictAddDict(&groups_dict, name.quark(), 5);
tr_variantDictAddStrView(dict, TR_KEY_name, name.sv());
tr_variantDictAddBool(dict, TR_KEY_uploadLimited, limits.up_limited);
tr_variantDictAddInt(dict, TR_KEY_uploadLimit, limits.up_limit_KBps);
tr_variantDictAddBool(dict, TR_KEY_downloadLimited, limits.down_limited);
tr_variantDictAddInt(dict, TR_KEY_downloadLimit, limits.down_limit_KBps);
tr_variantDictAddBool(dict, TR_KEY_honorsSessionLimits, group->areParentLimitsHonored(TR_UP));
}
auto const filename = tr_pathbuf{ config_dir, '/', BandwidthGroupsFilename };
auto const ret = tr_variantToFile(&groups_dict, TR_VARIANT_FMT_JSON, filename);
tr_variantClear(&groups_dict);
return ret;
}
} // namespace bandwidth_group_helpers
void update_bandwidth(tr_session* session, tr_direction dir)
{
if (auto const limit_bytes_per_second = session->activeSpeedLimitBps(dir); limit_bytes_per_second)
{
session->top_bandwidth_.setLimited(dir, *limit_bytes_per_second > 0U);
session->top_bandwidth_.setDesiredSpeedBytesPerSecond(dir, *limit_bytes_per_second);
}
else
{
session->top_bandwidth_.setLimited(dir, false);
}
}
} // namespace
tr_port tr_session::randomPort() const
{
auto const lower = std::min(settings_.peer_port_random_low.host(), settings_.peer_port_random_high.host());
auto const upper = std::max(settings_.peer_port_random_low.host(), settings_.peer_port_random_high.host());
auto const range = upper - lower;
return tr_port::fromHost(lower + tr_rand_int(range + 1U));
}
/* Generate a peer id : "-TRxyzb-" + 12 random alphanumeric
characters, where x is the major version number, y is the
minor version number, z is the maintenance number, and b
designates beta (Azureus-style) */
tr_peer_id_t tr_peerIdInit()
{
auto peer_id = tr_peer_id_t{};
auto* it = std::data(peer_id);
// starts with -TRXXXX-
auto constexpr Prefix = std::string_view{ PEERID_PREFIX };
auto const* const end = it + std::size(peer_id);
it = std::copy_n(std::data(Prefix), std::size(Prefix), it);
// remainder is randomly-generated characters
auto constexpr Pool = std::string_view{ "0123456789abcdefghijklmnopqrstuvwxyz" };
auto total = int{ 0 };
tr_rand_buffer(it, end - it);
while (it + 1 < end)
{
int const val = *it % std::size(Pool);
total += val;
*it++ = Pool[val];
}
int const val = total % std::size(Pool) != 0 ? std::size(Pool) - total % std::size(Pool) : 0;
*it = Pool[val];
return peer_id;
}
// ---
std::vector<tr_torrent_id_t> tr_session::DhtMediator::torrentsAllowingDHT() const
{
auto ids = std::vector<tr_torrent_id_t>{};
auto const& torrents = session_.torrents();
ids.reserve(std::size(torrents));
for (auto const* const tor : torrents)
{
if (tor->isRunning && tor->allowsDht())
{
ids.push_back(tor->id());
}
}
return ids;
}
tr_sha1_digest_t tr_session::DhtMediator::torrentInfoHash(tr_torrent_id_t id) const
{
if (auto const* const tor = session_.torrents().get(id); tor != nullptr)
{
return tor->infoHash();
}
return {};
}
void tr_session::DhtMediator::addPex(tr_sha1_digest_t const& info_hash, tr_pex const* pex, size_t n_pex)
{
if (auto* const tor = session_.torrents().get(info_hash); tor != nullptr)
{
tr_peerMgrAddPex(tor, TR_PEER_FROM_DHT, pex, n_pex);
}
}
// ---
bool tr_session::LpdMediator::onPeerFound(std::string_view info_hash_str, tr_address address, tr_port port)
{
auto const digest = tr_sha1_from_string(info_hash_str);
if (!digest)
{
return false;
}
tr_torrent* const tor = session_.torrents_.get(*digest);
if (!tr_isTorrent(tor) || !tor->allowsLpd())
{
return false;
}
// we found a suitable peer, add it to the torrent
auto pex = tr_pex{ address, port };
tr_peerMgrAddPex(tor, TR_PEER_FROM_LPD, &pex, 1U);
tr_logAddDebugTor(tor, fmt::format(FMT_STRING("Found a local peer from LPD ({:s})"), address.display_name(port)));
return true;
}
std::vector<tr_lpd::Mediator::TorrentInfo> tr_session::LpdMediator::torrents() const
{
auto ret = std::vector<tr_lpd::Mediator::TorrentInfo>{};
ret.reserve(std::size(session_.torrents()));
for (auto const* const tor : session_.torrents())
{
auto info = tr_lpd::Mediator::TorrentInfo{};
info.info_hash_str = tor->infoHashString();
info.activity = tor->activity();
info.allows_lpd = tor->allowsLpd();
info.announce_after = tor->lpdAnnounceAt;
ret.emplace_back(info);
}
return ret;
}
void tr_session::LpdMediator::setNextAnnounceTime(std::string_view info_hash_str, time_t announce_after)
{
if (auto digest = tr_sha1_from_string(info_hash_str); digest)
{
if (tr_torrent* const tor = session_.torrents_.get(*digest); tr_isTorrent(tor))
{
tor->lpdAnnounceAt = announce_after;
}
}
}
// ---
std::optional<std::string> tr_session::WebMediator::cookieFile() const
{
auto const path = tr_pathbuf{ session_->configDir(), "/cookies.txt"sv };
if (!tr_sys_path_exists(path))
{
return {};
}
return std::string{ path };
}
std::optional<std::string_view> tr_session::WebMediator::userAgent() const
{
return TR_NAME "/" SHORT_VERSION_STRING;
}
std::optional<std::string> tr_session::WebMediator::publicAddressV4() const
{
if (auto const [addr, is_any] = session_->publicAddress(TR_AF_INET); !is_any)
{
return addr.display_name();
}
return std::nullopt;
}
std::optional<std::string> tr_session::WebMediator::publicAddressV6() const
{
if (auto const [addr, is_any] = session_->publicAddress(TR_AF_INET6); !is_any)
{
return addr.display_name();
}
return std::nullopt;
}
size_t tr_session::WebMediator::clamp(int torrent_id, size_t byte_count) const
{
auto const lock = session_->unique_lock();
auto const* const tor = session_->torrents().get(torrent_id);
return tor == nullptr ? 0U : tor->bandwidth_.clamp(TR_DOWN, byte_count);
}
void tr_session::WebMediator::notifyBandwidthConsumed(int torrent_id, size_t byte_count)
{
auto const lock = session_->unique_lock();
if (auto* const tor = session_->torrents().get(torrent_id); tor != nullptr)
{
tor->bandwidth_.notifyBandwidthConsumed(TR_DOWN, byte_count, true, tr_time_msec());
}
}
void tr_session::WebMediator::run(tr_web::FetchDoneFunc&& func, tr_web::FetchResponse&& response) const
{
session_->runInSessionThread(std::move(func), std::move(response));
}
time_t tr_session::WebMediator::now() const
{
return tr_time();
}
void tr_sessionFetch(tr_session* session, tr_web::FetchOptions&& options)
{
session->fetch(std::move(options));
}
// ---
tr_encryption_mode tr_sessionGetEncryption(tr_session const* session)
{
TR_ASSERT(session != nullptr);
return session->encryptionMode();
}
void tr_sessionSetEncryption(tr_session* session, tr_encryption_mode mode)
{
TR_ASSERT(session != nullptr);
TR_ASSERT(mode == TR_ENCRYPTION_PREFERRED || mode == TR_ENCRYPTION_REQUIRED || mode == TR_CLEAR_PREFERRED);
session->settings_.encryption_mode = mode;
}
// ---
void tr_session::onIncomingPeerConnection(tr_socket_t fd, void* vsession)
{
auto* session = static_cast<tr_session*>(vsession);
if (auto const incoming_info = tr_netAccept(session, fd); incoming_info)
{
auto const& [addr, port, sock] = *incoming_info;
tr_logAddTrace(fmt::format("new incoming connection {} ({})", sock, addr.display_name(port)));
session->addIncoming(tr_peer_socket{ session, addr, port, sock });
}
}
tr_session::BoundSocket::BoundSocket(
event_base* evbase,
tr_address const& addr,
tr_port port,
IncomingCallback cb,
void* cb_data)
: cb_{ cb }
, cb_data_{ cb_data }
, socket_{ tr_netBindTCP(addr, port, false) }
, ev_{ event_new(evbase, socket_, EV_READ | EV_PERSIST, &BoundSocket::onCanRead, this) }
{
if (socket_ == TR_BAD_SOCKET)
{
return;
}
tr_logAddInfo(
fmt::format(_("Listening to incoming peer connections on {hostport}"), fmt::arg("hostport", addr.display_name(port))));
event_add(ev_.get(), nullptr);
}
tr_session::BoundSocket::~BoundSocket()
{
ev_.reset();
if (socket_ != TR_BAD_SOCKET)
{
tr_net_close_socket(socket_);
socket_ = TR_BAD_SOCKET;
}
}
tr_session::PublicAddressResult tr_session::publicAddress(tr_address_type type) const noexcept
{
if (type == TR_AF_INET)
{
// if user provided an address, use it.
// otherwise, use any_ipv4 (0.0.0.0).
static auto constexpr DefaultAddr = tr_address::any_ipv4();
auto addr = tr_address::from_string(settings_.bind_address_ipv4).value_or(DefaultAddr);
return { addr, addr == DefaultAddr };
}
if (type == TR_AF_INET6)
{
// if user provided an address, use it.
// otherwise, if we can determine which one to use via tr_globalIPv6 magic, use it.
// otherwise, use any_ipv6 (::).
static auto constexpr AnyAddr = tr_address::any_ipv6();
auto const default_addr = tr_globalIPv6().value_or(AnyAddr);
auto addr = tr_address::from_string(settings_.bind_address_ipv6).value_or(default_addr);
return { addr, addr == AnyAddr };
}
TR_ASSERT_MSG(false, "invalid type");
return {};
}
// ---
namespace
{
namespace settings_helpers
{
void get_settings_filename(tr_pathbuf& setme, char const* config_dir, char const* appname)
{
if (!tr_str_is_empty(config_dir))
{
setme.assign(std::string_view{ config_dir }, "/settings.json"sv);
return;
}
auto const default_config_dir = tr_getDefaultConfigDir(appname);
setme.assign(std::string_view{ default_config_dir }, "/settings.json"sv);
}
} // namespace settings_helpers
} // namespace
void tr_sessionGetDefaultSettings(tr_variant* setme_dictionary)
{
tr_session_settings{}.save(setme_dictionary);
tr_rpc_server::defaultSettings(setme_dictionary);
tr_session_alt_speeds::defaultSettings(setme_dictionary);
}
void tr_sessionGetSettings(tr_session const* session, tr_variant* setme_dictionary)
{
session->settings_.save(setme_dictionary);
session->alt_speeds_.save(setme_dictionary);
session->rpc_server_->save(setme_dictionary);
tr_variantDictRemove(setme_dictionary, TR_KEY_message_level);
tr_variantDictAddInt(setme_dictionary, TR_KEY_message_level, tr_logGetLevel());
}
bool tr_sessionLoadSettings(tr_variant* dict, char const* config_dir, char const* app_name)
{
using namespace settings_helpers;
TR_ASSERT(tr_variantIsDict(dict));
/* initializing the defaults: caller may have passed in some app-level defaults.
* preserve those and use the session defaults to fill in any missing gaps. */
auto old_dict = *dict;
tr_variantInitDict(dict, 0);
tr_sessionGetDefaultSettings(dict);
tr_variantMergeDicts(dict, &old_dict);
tr_variantClear(&old_dict);
/* file settings override the defaults */
auto success = bool{};
auto filename = tr_pathbuf{};
get_settings_filename(filename, config_dir, app_name);
if (!tr_sys_path_exists(filename))
{
success = true;
}
else if (auto file_settings = tr_variant{}; tr_variantFromFile(&file_settings, TR_VARIANT_PARSE_JSON, filename))
{
tr_variantMergeDicts(dict, &file_settings);
tr_variantClear(&file_settings);
success = true;
}
else
{
success = false;
}
/* cleanup */
return success;
}
void tr_sessionSaveSettings(tr_session* session, char const* config_dir, tr_variant const* client_settings)
{
using namespace bandwidth_group_helpers;
TR_ASSERT(tr_variantIsDict(client_settings));
tr_variant settings;
auto const filename = tr_pathbuf{ config_dir, "/settings.json"sv };
tr_variantInitDict(&settings, 0);
/* the existing file settings are the fallback values */
if (auto file_settings = tr_variant{}; tr_variantFromFile(&file_settings, TR_VARIANT_PARSE_JSON, filename))
{
tr_variantMergeDicts(&settings, &file_settings);
tr_variantClear(&file_settings);
}
/* the client's settings override the file settings */
tr_variantMergeDicts(&settings, client_settings);
/* the session's true values override the file & client settings */
{
auto session_settings = tr_variant{};
tr_variantInitDict(&session_settings, 0);
tr_sessionGetSettings(session, &session_settings);
tr_variantMergeDicts(&settings, &session_settings);
tr_variantClear(&session_settings);
}
/* save the result */
tr_variantToFile(&settings, TR_VARIANT_FMT_JSON, filename);
/* cleanup */
tr_variantClear(&settings);
/* Write bandwidth groups limits to file */
bandwidthGroupWrite(session, config_dir);
}
// ---
struct tr_session::init_data
{
bool message_queuing_enabled;
std::string_view config_dir;
tr_variant* client_settings;
std::condition_variable_any done_cv;
};
tr_session* tr_sessionInit(char const* config_dir, bool message_queueing_enabled, tr_variant* client_settings)
{
using namespace bandwidth_group_helpers;
TR_ASSERT(tr_variantIsDict(client_settings));
tr_timeUpdate(time(nullptr));
/* initialize the bare skeleton of the session object */
auto* const session = new tr_session{ config_dir };
bandwidthGroupRead(session, config_dir);
// nice to start logging at the very beginning
if (auto val = int64_t{}; tr_variantDictFindInt(client_settings, TR_KEY_message_level, &val))
{
tr_logSetLevel(static_cast<tr_log_level>(val));
}
auto data = tr_session::init_data{};
data.config_dir = config_dir;
data.message_queuing_enabled = message_queueing_enabled;
data.client_settings = client_settings;
// run initImpl() in the libtransmission thread
auto lock = session->unique_lock();
session->runInSessionThread([&session, &data]() { session->initImpl(data); });
data.done_cv.wait(lock); // wait for the session to be ready
return session;
}
void tr_session::onNowTimer()
{
TR_ASSERT(now_timer_);
auto const now = std::chrono::system_clock::now();
// tr_session upkeep tasks to perform once per second
tr_timeUpdate(std::chrono::system_clock::to_time_t(now));
alt_speeds_.checkScheduler();
// set the timer to kick again right after (10ms after) the next second
auto const target_time = std::chrono::time_point_cast<std::chrono::seconds>(now) + 1s + 10ms;
auto target_interval = target_time - now;
if (target_interval < 100ms)
{
target_interval += 1s;
}
now_timer_->setInterval(std::chrono::duration_cast<std::chrono::milliseconds>(target_interval));
}
void tr_session::initImpl(init_data& data)
{
auto lock = unique_lock();
TR_ASSERT(amInSessionThread());
auto* const client_settings = data.client_settings;
TR_ASSERT(tr_variantIsDict(client_settings));
tr_logAddTrace(fmt::format("tr_sessionInit: the session's top-level bandwidth object is {}", fmt::ptr(&top_bandwidth_)));
auto settings = tr_variant{};
tr_variantInitDict(&settings, 0);
tr_sessionGetDefaultSettings(&settings);
tr_variantMergeDicts(&settings, client_settings);
#ifndef _WIN32
/* Don't exit when writing on a broken socket */
(void)signal(SIGPIPE, SIG_IGN);
#endif
tr_logSetQueueEnabled(data.message_queuing_enabled);
this->blocklists_ = libtransmission::Blocklist::loadBlocklists(blocklist_dir_, useBlocklist());
tr_logAddInfo(fmt::format(_("Transmission version {version} starting"), fmt::arg("version", LONG_VERSION_STRING)));
setSettings(client_settings, true);
if (this->allowsLPD())
{
this->lpd_ = tr_lpd::create(lpd_mediator_, eventBase());
}
tr_utpInit(this);
/* cleanup */
tr_variantClear(&settings);
data.done_cv.notify_one();
}
void tr_session::setSettings(tr_variant* settings_dict, bool force)
{
TR_ASSERT(amInSessionThread());
TR_ASSERT(tr_variantIsDict(settings_dict));
// load the session settings
auto new_settings = tr_session_settings{};
new_settings.load(settings_dict);
setSettings(std::move(new_settings), force);
// delegate loading out the other settings
alt_speeds_.load(settings_dict);
rpc_server_->load(settings_dict);
}
void tr_session::setSettings(tr_session_settings&& settings_in, bool force)
{
auto const lock = unique_lock();
std::swap(settings_, settings_in);
auto const& new_settings = settings_;
auto const& old_settings = settings_in;
// the rest of the func is session_ responding to settings changes
if (auto const& val = new_settings.log_level; force || val != old_settings.log_level)
{
tr_logSetLevel(val);
}
#ifndef _WIN32
if (auto const& val = new_settings.umask; force || val != old_settings.umask)
{
::umask(val);
}
#endif
if (auto const& val = new_settings.cache_size_mb; force || val != old_settings.cache_size_mb)
{
tr_sessionSetCacheLimit_MB(this, val);
}
if (auto const& val = new_settings.default_trackers_str; force || val != old_settings.default_trackers_str)
{
setDefaultTrackers(val);
}
if (auto const& val = new_settings.utp_enabled; force || val != old_settings.utp_enabled)
{
tr_sessionSetUTPEnabled(this, val);
}
useBlocklist(new_settings.blocklist_enabled);
auto local_peer_port = force && settings_.peer_port_random_on_start ? randomPort() : new_settings.peer_port;
bool port_changed = false;
if (force || local_peer_port_ != local_peer_port)
{
local_peer_port_ = local_peer_port;
advertised_peer_port_ = local_peer_port;
port_changed = true;
}
bool addr_changed = false;
if (new_settings.tcp_enabled)
{
if (auto const& val = new_settings.bind_address_ipv4; force || port_changed || val != old_settings.bind_address_ipv4)
{
auto const [addr, is_default] = publicAddress(TR_AF_INET);
bound_ipv4_.emplace(eventBase(), addr, local_peer_port_, &tr_session::onIncomingPeerConnection, this);
addr_changed = true;
}
if (auto const& val = new_settings.bind_address_ipv6; force || port_changed || val != old_settings.bind_address_ipv6)
{
auto const [addr, is_default] = publicAddress(TR_AF_INET6);
bound_ipv6_.emplace(eventBase(), addr, local_peer_port_, &tr_session::onIncomingPeerConnection, this);
addr_changed = true;
}
}
else
{
bound_ipv4_.reset();
bound_ipv6_.reset();
addr_changed = true;
}
if (auto const& val = new_settings.port_forwarding_enabled; force || val != old_settings.port_forwarding_enabled)
{
tr_sessionSetPortForwardingEnabled(this, val);
}
if (port_changed)
{
port_forwarding_->localPortChanged();
}
bool const dht_changed = new_settings.dht_enabled != old_settings.dht_enabled;
if (!udp_core_ || force || port_changed || dht_changed)
{
udp_core_ = std::make_unique<tr_session::tr_udp_core>(*this, udpPort());
}
// Sends out announce messages with advertisedPeerPort(), so this
// section neesd be happen here after the peer port settings changes
if (auto const& val = new_settings.lpd_enabled; force || val != old_settings.lpd_enabled)
{
if (val)
{
lpd_ = tr_lpd::create(lpd_mediator_, eventBase());
}
else
{
lpd_.reset();
}
}
if (!allowsDHT())
{
dht_.reset();
}
else if (force || !dht_ || port_changed || addr_changed || dht_changed)
{
dht_ = tr_dht::create(dht_mediator_, localPeerPort(), udp_core_->socket4(), udp_core_->socket6());
}
// We need to update bandwidth if speed settings changed.
// It's a harmless call, so just call it instead of checking for settings changes
update_bandwidth(this, TR_UP);
update_bandwidth(this, TR_DOWN);
}
void tr_sessionSet(tr_session* session, tr_variant* settings)
{
// do the work in the session thread
auto done_promise = std::promise<void>{};
auto done_future = done_promise.get_future();
session->runInSessionThread(
[&session, &settings, &done_promise]()
{
session->setSettings(settings, false);
done_promise.set_value();
});
done_future.wait();
}
// ---
void tr_sessionSetDownloadDir(tr_session* session, char const* dir)
{
TR_ASSERT(session != nullptr);
session->setDownloadDir(dir != nullptr ? dir : "");
}
char const* tr_sessionGetDownloadDir(tr_session const* session)
{
TR_ASSERT(session != nullptr);
return session->downloadDir().c_str();
}
char const* tr_sessionGetConfigDir(tr_session const* session)
{
TR_ASSERT(session != nullptr);
return session->configDir().c_str();
}
// ---
void tr_sessionSetIncompleteFileNamingEnabled(tr_session* session, bool enabled)
{
TR_ASSERT(session != nullptr);
session->settings_.is_incomplete_file_naming_enabled = enabled;
}
bool tr_sessionIsIncompleteFileNamingEnabled(tr_session const* session)
{
TR_ASSERT(session != nullptr);
return session->isIncompleteFileNamingEnabled();
}
// ---
void tr_sessionSetIncompleteDir(tr_session* session, char const* dir)
{
TR_ASSERT(session != nullptr);
session->setIncompleteDir(dir != nullptr ? dir : "");
}
char const* tr_sessionGetIncompleteDir(tr_session const* session)
{
TR_ASSERT(session != nullptr);
return session->incompleteDir().c_str();
}
void tr_sessionSetIncompleteDirEnabled(tr_session* session, bool enabled)
{
TR_ASSERT(session != nullptr);
session->useIncompleteDir(enabled);
}
bool tr_sessionIsIncompleteDirEnabled(tr_session const* session)
{
TR_ASSERT(session != nullptr);
return session->useIncompleteDir();
}
// --- Peer Port
void tr_sessionSetPeerPort(tr_session* session, uint16_t hport)
{
TR_ASSERT(session != nullptr);
if (auto const port = tr_port::fromHost(hport); port != session->localPeerPort())
{
session->runInSessionThread(
[session, port]()
{
auto settings = session->settings_;
settings.peer_port = port;
session->setSettings(std::move(settings), false);
});
}
}
uint16_t tr_sessionGetPeerPort(tr_session const* session)
{
return session != nullptr ? session->localPeerPort().host() : 0U;
}
uint16_t tr_sessionSetPeerPortRandom(tr_session* session)
{
auto const p = session->randomPort();
tr_sessionSetPeerPort(session, p.host());
return p.host();
}
void tr_sessionSetPeerPortRandomOnStart(tr_session* session, bool random)
{
TR_ASSERT(session != nullptr);
session->settings_.peer_port_random_on_start = random;
}
bool tr_sessionGetPeerPortRandomOnStart(tr_session const* session)
{
TR_ASSERT(session != nullptr);
return session->isPortRandom();
}
tr_port_forwarding_state tr_sessionGetPortForwarding(tr_session const* session)
{
TR_ASSERT(session != nullptr);
return session->port_forwarding_->state();
}
void tr_session::onAdvertisedPeerPortChanged()
{
for (auto* const tor : torrents())
{
tr_torrentChangeMyPort(tor);
}
}
// ---
void tr_sessionSetRatioLimited(tr_session* session, bool is_limited)
{
TR_ASSERT(session != nullptr);
session->settings_.ratio_limit_enabled = is_limited;
}
void tr_sessionSetRatioLimit(tr_session* session, double desired_ratio)
{
TR_ASSERT(session != nullptr);
session->settings_.ratio_limit = desired_ratio;
}
bool tr_sessionIsRatioLimited(tr_session const* session)
{
TR_ASSERT(session != nullptr);
return session->isRatioLimited();
}
double tr_sessionGetRatioLimit(tr_session const* session)
{
TR_ASSERT(session != nullptr);
return session->desiredRatio();
}
// ---
void tr_sessionSetIdleLimited(tr_session* session, bool is_limited)
{
TR_ASSERT(session != nullptr);
session->settings_.idle_seeding_limit_enabled = is_limited;
}
void tr_sessionSetIdleLimit(tr_session* session, uint16_t idle_minutes)
{
TR_ASSERT(session != nullptr);
session->settings_.idle_seeding_limit_minutes = idle_minutes;
}
bool tr_sessionIsIdleLimited(tr_session const* session)
{
TR_ASSERT(session != nullptr);
return session->isIdleLimited();
}
uint16_t tr_sessionGetIdleLimit(tr_session const* session)
{
TR_ASSERT(session != nullptr);
return session->idleLimitMinutes();
}
// --- Speed limits
std::optional<tr_bytes_per_second_t> tr_session::activeSpeedLimitBps(tr_direction dir) const noexcept
{
if (tr_sessionUsesAltSpeed(this))
{
return tr_toSpeedBytes(tr_sessionGetAltSpeed_KBps(this, dir));
}
if (this->isSpeedLimited(dir))
{
return tr_toSpeedBytes(tr_sessionGetSpeedLimit_KBps(this, dir));
}
return {};
}
time_t tr_session::AltSpeedMediator::time()
{
return tr_time();
}
void tr_session::AltSpeedMediator::isActiveChanged(bool is_active, tr_session_alt_speeds::ChangeReason reason)
{
auto const in_session_thread = [session = &session_, is_active, reason]()
{
update_bandwidth(session, TR_UP);
update_bandwidth(session, TR_DOWN);
if (session->alt_speed_active_changed_func_ != nullptr)
{
session->alt_speed_active_changed_func_(
session,
is_active,
reason == tr_session_alt_speeds::ChangeReason::User,
session->alt_speed_active_changed_func_user_data_);
}
};
session_.runInSessionThread(in_session_thread);
}
// --- Session primary speed limits
void tr_sessionSetSpeedLimit_KBps(tr_session* session, tr_direction dir, tr_kilobytes_per_second_t limit)
{
TR_ASSERT(session != nullptr);
TR_ASSERT(tr_isDirection(dir));
if (dir == TR_DOWN)
{
session->settings_.speed_limit_down = limit;
}
else
{
session->settings_.speed_limit_up = limit;
}
update_bandwidth(session, dir);
}
tr_kilobytes_per_second_t tr_sessionGetSpeedLimit_KBps(tr_session const* session, tr_direction dir)
{
TR_ASSERT(session != nullptr);
TR_ASSERT(tr_isDirection(dir));
return dir == TR_DOWN ? session->settings_.speed_limit_down : session->settings_.speed_limit_up;
}
void tr_sessionLimitSpeed(tr_session* session, tr_direction dir, bool limited)
{
TR_ASSERT(session != nullptr);
TR_ASSERT(tr_isDirection(dir));
if (dir == TR_DOWN)
{
session->settings_.speed_limit_down_enabled = limited;
}
else
{
session->settings_.speed_limit_up_enabled = limited;
}
update_bandwidth(session, dir);
}
bool tr_sessionIsSpeedLimited(tr_session const* session, tr_direction dir)
{
TR_ASSERT(session != nullptr);
TR_ASSERT(tr_isDirection(dir));
return session->isSpeedLimited(dir);
}
// --- Session alt speed limits
void tr_sessionSetAltSpeed_KBps(tr_session* session, tr_direction dir, tr_kilobytes_per_second_t limit)
{
TR_ASSERT(session != nullptr);
TR_ASSERT(tr_isDirection(dir));
session->alt_speeds_.setLimitKBps(dir, limit);
update_bandwidth(session, dir);
}
tr_kilobytes_per_second_t tr_sessionGetAltSpeed_KBps(tr_session const* session, tr_direction dir)
{
TR_ASSERT(session != nullptr);
TR_ASSERT(tr_isDirection(dir));
return session->alt_speeds_.limitKBps(dir);
}
void tr_sessionUseAltSpeedTime(tr_session* session, bool enabled)
{
TR_ASSERT(session != nullptr);
session->alt_speeds_.setSchedulerEnabled(enabled);
}
bool tr_sessionUsesAltSpeedTime(tr_session const* session)
{
TR_ASSERT(session != nullptr);
return session->alt_speeds_.isSchedulerEnabled();
}
void tr_sessionSetAltSpeedBegin(tr_session* session, size_t minutes_since_midnight)
{
TR_ASSERT(session != nullptr);
session->alt_speeds_.setStartMinute(minutes_since_midnight);
}
size_t tr_sessionGetAltSpeedBegin(tr_session const* session)
{
TR_ASSERT(session != nullptr);
return session->alt_speeds_.startMinute();
}
void tr_sessionSetAltSpeedEnd(tr_session* session, size_t minutes_since_midnight)
{
TR_ASSERT(session != nullptr);
session->alt_speeds_.setEndMinute(minutes_since_midnight);
}
size_t tr_sessionGetAltSpeedEnd(tr_session const* session)
{
TR_ASSERT(session != nullptr);
return session->alt_speeds_.endMinute();
}
void tr_sessionSetAltSpeedDay(tr_session* session, tr_sched_day days)
{
TR_ASSERT(session != nullptr);
session->alt_speeds_.setWeekdays(days);
}
tr_sched_day tr_sessionGetAltSpeedDay(tr_session const* session)
{
TR_ASSERT(session != nullptr);
return session->alt_speeds_.weekdays();
}
void tr_sessionUseAltSpeed(tr_session* session, bool enabled)
{
session->alt_speeds_.setActive(enabled, tr_session_alt_speeds::ChangeReason::User);
}
bool tr_sessionUsesAltSpeed(tr_session const* session)
{
TR_ASSERT(session != nullptr);
return session->alt_speeds_.isActive();
}
void tr_sessionSetAltSpeedFunc(tr_session* session, tr_altSpeedFunc func, void* user_data)
{
TR_ASSERT(session != nullptr);
session->alt_speed_active_changed_func_ = func;
session->alt_speed_active_changed_func_user_data_ = user_data;
}
// ---
void tr_sessionSetPeerLimit(tr_session* session, uint16_t max_global_peers)
{
TR_ASSERT(session != nullptr);
session->settings_.peer_limit_global = max_global_peers;
}
uint16_t tr_sessionGetPeerLimit(tr_session const* session)
{
TR_ASSERT(session != nullptr);
return session->peerLimit();
}
void tr_sessionSetPeerLimitPerTorrent(tr_session* session, uint16_t max_peers)
{
TR_ASSERT(session != nullptr);
session->settings_.peer_limit_per_torrent = max_peers;
}
uint16_t tr_sessionGetPeerLimitPerTorrent(tr_session const* session)
{
TR_ASSERT(session != nullptr);
return session->peerLimitPerTorrent();
}
// ---
void tr_sessionSetPaused(tr_session* session, bool is_paused)
{
TR_ASSERT(session != nullptr);
session->settings_.should_start_added_torrents = !is_paused;
}
bool tr_sessionGetPaused(tr_session const* session)
{
TR_ASSERT(session != nullptr);
return session->shouldPauseAddedTorrents();
}
void tr_sessionSetDeleteSource(tr_session* session, bool delete_source)
{
TR_ASSERT(session != nullptr);
session->settings_.should_delete_source_torrents = delete_source;
}
// ---
double tr_sessionGetRawSpeed_KBps(tr_session const* session, tr_direction dir)
{
auto const bps = session != nullptr ? session->top_bandwidth_.getRawSpeedBytesPerSecond(0, dir) : 0;
return tr_toSpeedKBps(bps);
}
void tr_session::closeImplPart1(std::promise<void>* closed_promise, std::chrono::time_point<std::chrono::steady_clock> deadline)
{
is_closing_ = true;
// close the low-hanging fruit that can be closed immediately w/o consequences
utp_timer.reset();
verifier_.reset();
save_timer_.reset();
now_timer_.reset();
rpc_server_.reset();
dht_.reset();
lpd_.reset();
port_forwarding_.reset();
bound_ipv6_.reset();
bound_ipv4_.reset();
// Close the torrents in order of most active to least active
// so that the most important announce=stopped events are
// fired out first...
auto torrents = getAllTorrents();
std::sort(
std::begin(torrents),
std::end(torrents),
[](auto const* a, auto const* b)
{
auto const a_cur = a->downloadedCur + a->uploadedCur;
auto const b_cur = b->downloadedCur + b->uploadedCur;
return a_cur > b_cur; // larger xfers go first
});
for (auto* tor : torrents)
{
tr_torrentFreeInSessionThread(tor);
}
torrents.clear();
// ...now that all the torrents have been closed, any remaining
// `&event=stopped` announce messages are queued in the announcer.
// Tell the announcer to start shutdown, which sends out the stop
// events and stops scraping.
this->announcer_->startShutdown();
// ...and now that those are queued, tell web_ that we're shutting
// down soon. This leaves the `event=stopped` going but refuses any
// new tasks.
this->web_->startShutdown(10s);
this->cache.reset();
// recycle the now-unused save_timer_ here to wait for UDP shutdown
TR_ASSERT(!save_timer_);
save_timer_ = timerMaker().create([this, closed_promise, deadline]() { closeImplPart2(closed_promise, deadline); });
save_timer_->startRepeating(50ms);
}
void tr_session::closeImplPart2(std::promise<void>* closed_promise, std::chrono::time_point<std::chrono::steady_clock> deadline)
{
// try to keep the UDP announcer alive long enough to send out
// all the &event=stopped tracker announces
if (n_pending_stops_ != 0U && std::chrono::steady_clock::now() < deadline)
{
announcer_udp_->upkeep();
return;
}
save_timer_.reset();
this->announcer_.reset();
this->announcer_udp_.reset();
stats().saveIfDirty();
peer_mgr_.reset();
openFiles().closeAll();
tr_utpClose(this);
this->udp_core_.reset();
// tada we are done!
closed_promise->set_value();
}
void tr_sessionClose(tr_session* session, size_t timeout_secs)
{
TR_ASSERT(session != nullptr);
TR_ASSERT(!session->amInSessionThread());
tr_logAddInfo(fmt::format(_("Transmission version {version} shutting down"), fmt::arg("version", LONG_VERSION_STRING)));
auto closed_promise = std::promise<void>{};
auto closed_future = closed_promise.get_future();
auto const deadline = std::chrono::steady_clock::now() + std::chrono::seconds{ timeout_secs };
session->runInSessionThread([&closed_promise, deadline, session]() { session->closeImplPart1(&closed_promise, deadline); });
closed_future.wait();
delete session;
}
namespace
{
namespace load_torrents_helpers
{
[[nodiscard]] std::vector<std::string> get_matching_files(
std::string const& folder,
std::function<bool(std::string_view)> const& test)
{
if (auto const info = tr_sys_path_get_info(folder); !info || !info->isFolder())
{
return {};
}
auto const odir = tr_sys_dir_open(folder.c_str());
if (odir == TR_BAD_SYS_DIR)
{
return {};
}
auto filenames = std::vector<std::string>{};
for (;;)
{
char const* const name = tr_sys_dir_read_name(odir);
if (name == nullptr)
{
tr_sys_dir_close(odir);
return filenames;
}
if (test(name))
{
filenames.emplace_back(name);
}
}
}
void session_load_torrents(tr_session* session, tr_ctor* ctor, std::promise<size_t>* loaded_promise)
{
auto n_torrents = size_t{};
auto const& folder = session->torrentDir();
for (auto const& name : get_matching_files(folder, [](auto const& name) { return tr_strvEndsWith(name, ".torrent"sv); }))
{
auto const path = tr_pathbuf{ folder, '/', name };
if (tr_ctorSetMetainfoFromFile(ctor, path.sv(), nullptr) && tr_torrentNew(ctor, nullptr) != nullptr)
{
++n_torrents;
}
}
auto buf = std::vector<char>{};
for (auto const& name : get_matching_files(folder, [](auto const& name) { return tr_strvEndsWith(name, ".magnet"sv); }))
{
auto const path = tr_pathbuf{ folder, '/', name };
if (tr_loadFile(path, buf) &&
tr_ctorSetMetainfoFromMagnetLink(ctor, std::string_view{ std::data(buf), std::size(buf) }, nullptr) &&
tr_torrentNew(ctor, nullptr) != nullptr)
{
++n_torrents;
}
}
if (n_torrents != 0U)
{
tr_logAddInfo(fmt::format(
tr_ngettext("Loaded {count} torrent", "Loaded {count} torrents", n_torrents),
fmt::arg("count", n_torrents)));
}
loaded_promise->set_value(n_torrents);
}
} // namespace load_torrents_helpers
} // namespace
size_t tr_sessionLoadTorrents(tr_session* session, tr_ctor* ctor)
{
using namespace load_torrents_helpers;
auto loaded_promise = std::promise<size_t>{};
auto loaded_future = loaded_promise.get_future();
session->runInSessionThread(session_load_torrents, session, ctor, &loaded_promise);
loaded_future.wait();
auto const n_torrents = loaded_future.get();
return n_torrents;
}
size_t tr_sessionGetAllTorrents(tr_session* session, tr_torrent** buf, size_t buflen)
{
auto& torrents = session->torrents();
auto const n = std::size(torrents);
if (buflen >= n)
{
std::copy_n(std::begin(torrents), n, buf);
}
return n;
}
// ---
void tr_sessionSetPexEnabled(tr_session* session, bool enabled)
{
TR_ASSERT(session != nullptr);
session->settings_.pex_enabled = enabled;
}
bool tr_sessionIsPexEnabled(tr_session const* session)
{
TR_ASSERT(session != nullptr);
return session->allowsPEX();
}
bool tr_sessionIsDHTEnabled(tr_session const* session)
{
TR_ASSERT(session != nullptr);
return session->allowsDHT();
}
void tr_sessionSetDHTEnabled(tr_session* session, bool enabled)
{
TR_ASSERT(session != nullptr);
if (enabled != session->allowsDHT())
{
session->runInSessionThread(
[session, enabled]()
{
auto settings = session->settings_;
settings.dht_enabled = enabled;
session->setSettings(std::move(settings), false);
});
}
}
// ---
bool tr_session::allowsUTP() const noexcept
{
#ifdef WITH_UTP
return settings_.utp_enabled;
#else
return false;
#endif
}
bool tr_sessionIsUTPEnabled(tr_session const* session)
{
TR_ASSERT(session != nullptr);
return session->allowsUTP();
}
void tr_sessionSetUTPEnabled(tr_session* session, bool enabled)
{
TR_ASSERT(session != nullptr);
if (enabled == session->allowsUTP())
{
return;
}
session->settings_.utp_enabled = enabled;
}
void tr_sessionSetLPDEnabled(tr_session* session, bool enabled)
{
TR_ASSERT(session != nullptr);
if (enabled != session->allowsLPD())
{
session->runInSessionThread(
[session, enabled]()
{
auto settings = session->settings_;
settings.lpd_enabled = enabled;
session->setSettings(std::move(settings), false);
});
}
}
bool tr_sessionIsLPDEnabled(tr_session const* session)
{
TR_ASSERT(session != nullptr);
return session->allowsLPD();
}
// ---
void tr_sessionSetCacheLimit_MB(tr_session* session, size_t mb)
{
TR_ASSERT(session != nullptr);
session->settings_.cache_size_mb = mb;
session->cache->setLimit(tr_toMemBytes(mb));
}
size_t tr_sessionGetCacheLimit_MB(tr_session const* session)
{
TR_ASSERT(session != nullptr);
return session->settings_.cache_size_mb;
}
// ---
void tr_session::setDefaultTrackers(std::string_view trackers)
{
auto const oldval = default_trackers_;
settings_.default_trackers_str = trackers;
default_trackers_.parse(trackers);
// if the list changed, update all the public torrents
if (default_trackers_ != oldval)
{
for (auto* const tor : torrents())
{
if (tor->isPublic())
{
announcer_->resetTorrent(tor);
}
}
}
}
void tr_sessionSetDefaultTrackers(tr_session* session, char const* trackers)
{
TR_ASSERT(session != nullptr);
session->setDefaultTrackers(trackers != nullptr ? trackers : "");
}
// ---
tr_bandwidth& tr_session::getBandwidthGroup(std::string_view name)
{
auto& groups = this->bandwidth_groups_;
for (auto const& [group_name, group] : groups)
{
if (group_name == name)
{
return *group;
}
}
auto& [group_name, group] = groups.emplace_back(name, std::make_unique<tr_bandwidth>(new tr_bandwidth(&top_bandwidth_)));
return *group;
}
// ---
void tr_sessionSetPortForwardingEnabled(tr_session* session, bool enabled)
{
session->runInSessionThread(
[session, enabled]()
{
session->settings_.port_forwarding_enabled = enabled;
session->port_forwarding_->setEnabled(enabled);
});
}
bool tr_sessionIsPortForwardingEnabled(tr_session const* session)
{
TR_ASSERT(session != nullptr);
return session->port_forwarding_->isEnabled();
}
// ---
void tr_session::useBlocklist(bool enabled)
{
settings_.blocklist_enabled = enabled;
std::for_each(
std::begin(blocklists_),
std::end(blocklists_),
[enabled](auto& blocklist) { blocklist.setEnabled(enabled); });
}
bool tr_session::addressIsBlocked(tr_address const& addr) const noexcept
{
return std::any_of(
std::begin(blocklists_),
std::end(blocklists_),
[&addr](auto& blocklist) { return blocklist.contains(addr); });
}
void tr_sessionReloadBlocklists(tr_session* session)
{
session->blocklists_ = libtransmission::Blocklist::loadBlocklists(session->blocklist_dir_, session->useBlocklist());
if (session->peer_mgr_)
{
tr_peerMgrOnBlocklistChanged(session->peer_mgr_.get());
}
}
size_t tr_blocklistGetRuleCount(tr_session const* session)
{
TR_ASSERT(session != nullptr);
auto& src = session->blocklists_;
return std::accumulate(std::begin(src), std::end(src), 0, [](int sum, auto& cur) { return sum + std::size(cur); });
}
bool tr_blocklistIsEnabled(tr_session const* session)
{
TR_ASSERT(session != nullptr);
return session->useBlocklist();
}
void tr_blocklistSetEnabled(tr_session* session, bool enabled)
{
TR_ASSERT(session != nullptr);
session->useBlocklist(enabled);
}
bool tr_blocklistExists(tr_session const* session)
{
TR_ASSERT(session != nullptr);
return !std::empty(session->blocklists_);
}
size_t tr_blocklistSetContent(tr_session* session, char const* content_filename)
{
auto const lock = session->unique_lock();
// These rules will replace the default blocklist.
// Build the path of the default blocklist .bin file where we'll save these rules.
auto const bin_file = tr_pathbuf{ session->blocklist_dir_, '/', DEFAULT_BLOCKLIST_FILENAME };
// Try to save it
auto added = libtransmission::Blocklist::saveNew(content_filename, bin_file, session->useBlocklist());
if (!added)
{
return 0U;
}
auto const n_rules = std::size(*added);
// Add (or replace) it in our blocklists_ vector
auto& src = session->blocklists_;
if (auto iter = std::find_if(
std::begin(src),
std::end(src),
[&bin_file](auto const& candidate) { return bin_file == candidate.binFile(); });
iter != std::end(src))
{
*iter = std::move(*added);
}
else
{
src.emplace_back(std::move(*added));
}
return n_rules;
}
void tr_blocklistSetURL(tr_session* session, char const* url)
{
session->setBlocklistUrl(url != nullptr ? url : "");
}
char const* tr_blocklistGetURL(tr_session const* session)
{
return session->blocklistUrl().c_str();
}
// ---
void tr_session::setRpcWhitelist(std::string_view whitelist) const
{
this->rpc_server_->setWhitelist(whitelist);
}
void tr_session::useRpcWhitelist(bool enabled) const
{
this->rpc_server_->setWhitelistEnabled(enabled);
}
bool tr_session::useRpcWhitelist() const
{
return this->rpc_server_->isWhitelistEnabled();
}
void tr_sessionSetRPCEnabled(tr_session* session, bool is_enabled)
{
TR_ASSERT(session != nullptr);
session->rpc_server_->setEnabled(is_enabled);
}
bool tr_sessionIsRPCEnabled(tr_session const* session)
{
TR_ASSERT(session != nullptr);
return session->rpc_server_->isEnabled();
}
void tr_sessionSetRPCPort(tr_session* session, uint16_t hport)
{
TR_ASSERT(session != nullptr);
if (session->rpc_server_)
{
session->rpc_server_->setPort(tr_port::fromHost(hport));
}
}
uint16_t tr_sessionGetRPCPort(tr_session const* session)
{
TR_ASSERT(session != nullptr);
return session->rpc_server_ ? session->rpc_server_->port().host() : uint16_t{};
}
void tr_sessionSetRPCCallback(tr_session* session, tr_rpc_func func, void* user_data)
{
TR_ASSERT(session != nullptr);
session->rpc_func_ = func;
session->rpc_func_user_data_ = user_data;
}
void tr_sessionSetRPCWhitelist(tr_session* session, char const* whitelist)
{
TR_ASSERT(session != nullptr);
session->setRpcWhitelist(whitelist != nullptr ? whitelist : "");
}
char const* tr_sessionGetRPCWhitelist(tr_session const* session)
{
TR_ASSERT(session != nullptr);
return session->rpc_server_->whitelist().c_str();
}
void tr_sessionSetRPCWhitelistEnabled(tr_session* session, bool enabled)
{
TR_ASSERT(session != nullptr);
session->useRpcWhitelist(enabled);
}
bool tr_sessionGetRPCWhitelistEnabled(tr_session const* session)
{
TR_ASSERT(session != nullptr);
return session->useRpcWhitelist();
}
void tr_sessionSetRPCPassword(tr_session* session, char const* password)
{
TR_ASSERT(session != nullptr);
session->rpc_server_->setPassword(password != nullptr ? password : "");
}
char const* tr_sessionGetRPCPassword(tr_session const* session)
{
TR_ASSERT(session != nullptr);
return session->rpc_server_->getSaltedPassword().c_str();
}
void tr_sessionSetRPCUsername(tr_session* session, char const* username)
{
TR_ASSERT(session != nullptr);
session->rpc_server_->setUsername(username != nullptr ? username : "");
}
char const* tr_sessionGetRPCUsername(tr_session const* session)
{
TR_ASSERT(session != nullptr);
return session->rpc_server_->username().c_str();
}
void tr_sessionSetRPCPasswordEnabled(tr_session* session, bool enabled)
{
TR_ASSERT(session != nullptr);
session->rpc_server_->setPasswordEnabled(enabled);
}
bool tr_sessionIsRPCPasswordEnabled(tr_session const* session)
{
TR_ASSERT(session != nullptr);
return session->rpc_server_->isPasswordEnabled();
}
// ---
void tr_sessionSetScriptEnabled(tr_session* session, TrScript type, bool enabled)
{
TR_ASSERT(session != nullptr);
TR_ASSERT(type < TR_SCRIPT_N_TYPES);
session->useScript(type, enabled);
}
bool tr_sessionIsScriptEnabled(tr_session const* session, TrScript type)
{
TR_ASSERT(session != nullptr);
TR_ASSERT(type < TR_SCRIPT_N_TYPES);
return session->useScript(type);
}
void tr_sessionSetScript(tr_session* session, TrScript type, char const* script)
{
TR_ASSERT(session != nullptr);
TR_ASSERT(type < TR_SCRIPT_N_TYPES);
session->setScript(type, script != nullptr ? script : "");
}
char const* tr_sessionGetScript(tr_session const* session, TrScript type)
{
TR_ASSERT(session != nullptr);
TR_ASSERT(type < TR_SCRIPT_N_TYPES);
return session->script(type).c_str();
}
// ---
void tr_sessionSetQueueSize(tr_session* session, tr_direction dir, size_t max_simultaneous_torrents)
{
TR_ASSERT(session != nullptr);
TR_ASSERT(tr_isDirection(dir));
if (dir == TR_DOWN)
{
session->settings_.download_queue_size = max_simultaneous_torrents;
}
else
{
session->settings_.seed_queue_size = max_simultaneous_torrents;
}
}
size_t tr_sessionGetQueueSize(tr_session const* session, tr_direction dir)
{
TR_ASSERT(session != nullptr);
TR_ASSERT(tr_isDirection(dir));
return session->queueSize(dir);
}
void tr_sessionSetQueueEnabled(tr_session* session, tr_direction dir, bool do_limit_simultaneous_torrents)
{
TR_ASSERT(session != nullptr);
TR_ASSERT(tr_isDirection(dir));
if (dir == TR_DOWN)
{
session->settings_.download_queue_enabled = do_limit_simultaneous_torrents;
}
else
{
session->settings_.seed_queue_enabled = do_limit_simultaneous_torrents;
}
}
bool tr_sessionGetQueueEnabled(tr_session const* session, tr_direction dir)
{
TR_ASSERT(session != nullptr);
TR_ASSERT(tr_isDirection(dir));
return session->queueEnabled(dir);
}
void tr_sessionSetQueueStalledMinutes(tr_session* session, int minutes)
{
TR_ASSERT(session != nullptr);
TR_ASSERT(minutes > 0);
session->settings_.queue_stalled_minutes = minutes;
}
void tr_sessionSetQueueStalledEnabled(tr_session* session, bool is_enabled)
{
TR_ASSERT(session != nullptr);
session->settings_.queue_stalled_enabled = is_enabled;
}
bool tr_sessionGetQueueStalledEnabled(tr_session const* session)
{
TR_ASSERT(session != nullptr);
return session->queueStalledEnabled();
}
size_t tr_sessionGetQueueStalledMinutes(tr_session const* session)
{
TR_ASSERT(session != nullptr);
return session->queueStalledMinutes();
}
void tr_sessionSetAntiBruteForceThreshold(tr_session* session, int max_bad_requests)
{
TR_ASSERT(session != nullptr);
TR_ASSERT(max_bad_requests > 0);
session->rpc_server_->setAntiBruteForceLimit(max_bad_requests);
}
int tr_sessionGetAntiBruteForceThreshold(tr_session const* session)
{
TR_ASSERT(session != nullptr);
return session->rpc_server_->getAntiBruteForceLimit();
}
void tr_sessionSetAntiBruteForceEnabled(tr_session* session, bool is_enabled)
{
TR_ASSERT(session != nullptr);
session->rpc_server_->setAntiBruteForceEnabled(is_enabled);
}
bool tr_sessionGetAntiBruteForceEnabled(tr_session const* session)
{
TR_ASSERT(session != nullptr);
return session->rpc_server_->isAntiBruteForceEnabled();
}
std::vector<tr_torrent*> tr_session::getNextQueuedTorrents(tr_direction dir, size_t num_wanted) const
{
TR_ASSERT(tr_isDirection(dir));
// build an array of the candidates
auto candidates = std::vector<tr_torrent*>{};
candidates.reserve(std::size(torrents()));
for (auto* const tor : torrents())
{
if (tor->isQueued() && (dir == tor->queueDirection()))
{
candidates.push_back(tor);
}
}
// find the best n candidates
num_wanted = std::min(num_wanted, std::size(candidates));
if (num_wanted < candidates.size())
{
std::partial_sort(
std::begin(candidates),
std::begin(candidates) + num_wanted,
std::end(candidates),
[](auto const* a, auto const* b) { return tr_torrentGetQueuePosition(a) < tr_torrentGetQueuePosition(b); });
candidates.resize(num_wanted);
}
return candidates;
}
size_t tr_session::countQueueFreeSlots(tr_direction dir) const noexcept
{
if (!queueEnabled(dir))
{
return std::numeric_limits<size_t>::max();
}
auto const max = queueSize(dir);
auto const activity = dir == TR_UP ? TR_STATUS_SEED : TR_STATUS_DOWNLOAD;
/* count how many torrents are active */
auto active_count = size_t{};
bool const stalled_enabled = queueStalledEnabled();
auto const stalled_if_idle_for_n_seconds = queueStalledMinutes() * 60;
time_t const now = tr_time();
for (auto const* const tor : torrents())
{
/* is it the right activity? */
if (activity != tor->activity())
{
continue;
}
/* is it stalled? */
if (stalled_enabled && difftime(now, std::max(tor->startDate, tor->activityDate)) >= stalled_if_idle_for_n_seconds)
{
continue;
}
++active_count;
/* if we've reached the limit, no need to keep counting */
if (active_count >= max)
{
return 0;
}
}
return max - active_count;
}
// ---
void tr_session::closeTorrentFiles(tr_torrent* tor) noexcept
{
this->cache->flushTorrent(tor);
openFiles().closeTorrent(tor->id());
}
void tr_session::closeTorrentFile(tr_torrent* tor, tr_file_index_t file_num) noexcept
{
this->cache->flushFile(tor, file_num);
openFiles().closeFile(tor->id(), file_num);
}
// ---
void tr_sessionSetQueueStartCallback(tr_session* session, void (*callback)(tr_session*, tr_torrent*, void*), void* user_data)
{
session->setQueueStartCallback(callback, user_data);
}
void tr_sessionSetRatioLimitHitCallback(tr_session* session, tr_session_ratio_limit_hit_func callback, void* user_data)
{
session->setRatioLimitHitCallback(callback, user_data);
}
void tr_sessionSetIdleLimitHitCallback(tr_session* session, tr_session_idle_limit_hit_func callback, void* user_data)
{
session->setIdleLimitHitCallback(callback, user_data);
}
void tr_sessionSetMetadataCallback(tr_session* session, tr_session_metadata_func callback, void* user_data)
{
session->setMetadataCallback(callback, user_data);
}
void tr_sessionSetCompletenessCallback(tr_session* session, tr_torrent_completeness_func callback, void* user_data)
{
session->setTorrentCompletenessCallback(callback, user_data);
}
tr_session_stats tr_sessionGetStats(tr_session const* session)
{
return session->stats().current();
}
tr_session_stats tr_sessionGetCumulativeStats(tr_session const* session)
{
return session->stats().cumulative();
}
void tr_sessionClearStats(tr_session* session)
{
session->stats().clear();
}
namespace
{
auto constexpr SaveIntervalSecs = 360s;
auto makeResumeDir(std::string_view config_dir)
{
#if defined(__APPLE__) || defined(_WIN32)
auto dir = fmt::format("{:s}/Resume"sv, config_dir);
#else
auto dir = fmt::format("{:s}/resume"sv, config_dir);
#endif
tr_sys_dir_create(dir.c_str(), TR_SYS_DIR_CREATE_PARENTS, 0777);
return dir;
}
auto makeTorrentDir(std::string_view config_dir)
{
#if defined(__APPLE__) || defined(_WIN32)
auto dir = fmt::format("{:s}/Torrents"sv, config_dir);
#else
auto dir = fmt::format("{:s}/torrents"sv, config_dir);
#endif
tr_sys_dir_create(dir.c_str(), TR_SYS_DIR_CREATE_PARENTS, 0777);
return dir;
}
auto makeBlocklistDir(std::string_view config_dir)
{
auto dir = fmt::format("{:s}/blocklists"sv, config_dir);
tr_sys_dir_create(dir.c_str(), TR_SYS_DIR_CREATE_PARENTS, 0777);
return dir;
}
} // namespace
tr_session::tr_session(std::string_view config_dir, tr_variant* settings_dict)
: config_dir_{ config_dir }
, resume_dir_{ makeResumeDir(config_dir) }
, torrent_dir_{ makeTorrentDir(config_dir) }
, blocklist_dir_{ makeBlocklistDir(config_dir) }
, session_thread_{ tr_session_thread::create() }
, timer_maker_{ std::make_unique<libtransmission::EvTimerMaker>(eventBase()) }
, settings_{ settings_dict }
, session_id_{ tr_time }
, peer_mgr_{ tr_peerMgrNew(this), &tr_peerMgrFree }
, rpc_server_{ std::make_unique<tr_rpc_server>(this, settings_dict) }
{
now_timer_ = timerMaker().create([this]() { onNowTimer(); });
now_timer_->startRepeating(1s);
// Periodically save the .resume files of any torrents whose
// status has recently changed. This prevents loss of metadata
// in the case of a crash, unclean shutdown, clumsy user, etc.
save_timer_ = timerMaker().create(
[this]()
{
for (auto* const tor : torrents())
{
tr_torrentSave(tor);
}
stats().saveIfDirty();
});
save_timer_->startRepeating(SaveIntervalSecs);
verifier_->addCallback(tr_torrentOnVerifyDone);
}
void tr_session::addIncoming(tr_peer_socket&& socket)
{
tr_peerMgrAddIncoming(peer_mgr_.get(), std::move(socket));
}
void tr_session::addTorrent(tr_torrent* tor)
{
tor->unique_id_ = torrents().add(tor);
tr_peerMgrAddTorrent(peer_mgr_.get(), tor);
}
Reference in New Issue View Git Blame Copy Permalink