mirror of
https://github.com/transmission/transmission
synced 2024-12-25 09:13:06 +00:00
46cc95f72e
* refactor: annotate nodiscard, constexpr, noexcept methods * refactor: remove unused tr_blocklistFileExists() * refactor: remove unused tr_blocklistFileIsEnabled() * refactor: remove unused tr_ctorGetContents * refactor: remove unused tr_error_is_set() * refactor: remove unused tr_handshakeGetAddr() * refactor: remove unused tr_ctorSetLabels() * refactor: remove unused tr_http_escape_sha1() * refactor: remove unused tr_lpdEnabled() * refactor: remove unused tr_ptrArrayPop() * refactor: remove unused tr_torrentClearIdleLimitHitCallback() * refactor: remove unused tr_torrentFindFromHash() * refactor: remove unused tr_sha1_to_string() * refactor: remove unused tr_torrents::get() * refactor: remove unused tr_isEncryptionMode() * refactor: remove unused tr_isPreallocationMode() * refactor: remove unused tr_ptrArrayBack() * refactor: remove unused tr_ptrArrayClear() * refactor: remove unused tr_torrents::get() * refactor: remove unused Session::torrentSet() * refactor: remove unused peer_atom comparison operators * refactor: remove unused peer_atom::compare() * refactor: remove unused Qt variantInit(tr_variant*, unsigned)
477 lines
12 KiB
C++
477 lines
12 KiB
C++
// This file Copyright © 2008-2022 Mnemosyne LLC.
|
|
// It may be used under GPLv2 (SPDX: GPL-2.0), GPLv3 (SPDX: GPL-3.0),
|
|
// or any future license endorsed by Mnemosyne LLC.
|
|
// License text can be found in the licenses/ folder.
|
|
|
|
#pragma once
|
|
|
|
#ifndef __TRANSMISSION__
|
|
#error only libtransmission should #include this header.
|
|
#endif
|
|
|
|
#define TR_NAME "Transmission"
|
|
|
|
#include <array>
|
|
#include <cstddef> // size_t
|
|
#include <cstdint> // uintX_t
|
|
#include <ctime>
|
|
#include <list>
|
|
#include <map>
|
|
#include <memory>
|
|
#include <mutex>
|
|
#include <string>
|
|
#include <string_view>
|
|
#include <tuple>
|
|
#include <vector>
|
|
|
|
#include "transmission.h"
|
|
|
|
#include "announce-list.h"
|
|
#include "bandwidth.h"
|
|
#include "interned-string.h"
|
|
#include "net.h" // tr_socket_t
|
|
#include "quark.h"
|
|
#include "torrents.h"
|
|
#include "web.h"
|
|
|
|
enum tr_auto_switch_state_t
|
|
{
|
|
TR_AUTO_SWITCH_UNUSED,
|
|
TR_AUTO_SWITCH_ON,
|
|
TR_AUTO_SWITCH_OFF,
|
|
};
|
|
|
|
tr_peer_id_t tr_peerIdInit();
|
|
|
|
struct event_base;
|
|
struct evdns_base;
|
|
|
|
class tr_bitfield;
|
|
class tr_rpc_server;
|
|
class tr_web;
|
|
struct Bandwidth;
|
|
struct tr_address;
|
|
struct tr_announcer;
|
|
struct tr_announcer_udp;
|
|
struct tr_bindsockets;
|
|
struct tr_blocklistFile;
|
|
struct tr_cache;
|
|
struct tr_fdInfo;
|
|
|
|
struct tr_bindinfo
|
|
{
|
|
int socket;
|
|
tr_address addr;
|
|
struct event* ev;
|
|
};
|
|
|
|
struct tr_turtle_info
|
|
{
|
|
/* TR_UP and TR_DOWN speed limits */
|
|
unsigned int speedLimit_Bps[2];
|
|
|
|
/* is turtle mode on right now? */
|
|
bool isEnabled;
|
|
|
|
/* does turtle mode turn itself on and off at given times? */
|
|
bool isClockEnabled;
|
|
|
|
/* when clock mode is on, minutes after midnight to turn on turtle mode */
|
|
int beginMinute;
|
|
|
|
/* when clock mode is on, minutes after midnight to turn off turtle mode */
|
|
int endMinute;
|
|
|
|
/* only use clock mode on these days of the week */
|
|
tr_sched_day days;
|
|
|
|
/* called when isEnabled changes */
|
|
tr_altSpeedFunc callback;
|
|
|
|
/* the callback's user_data argument */
|
|
void* callbackUserData;
|
|
|
|
/* the callback's changedByUser argument.
|
|
* indicates whether the change came from the user or from the clock. */
|
|
bool changedByUser;
|
|
|
|
/* bitfield of all the minutes in a week.
|
|
* Each bit's value indicates whether the scheduler wants turtle
|
|
* limits on or off at that given minute in the week. */
|
|
// Changed to non-owning pointer temporarily till tr_turtle_info becomes C++-constructible and destructible
|
|
// TODO: remove * and own the value
|
|
tr_bitfield* minutes = nullptr;
|
|
|
|
/* recent action that was done by turtle's automatic switch */
|
|
tr_auto_switch_state_t autoTurtleState;
|
|
};
|
|
|
|
/** @brief handle to an active libtransmission session */
|
|
struct tr_session
|
|
{
|
|
public:
|
|
[[nodiscard]] constexpr auto& torrents()
|
|
{
|
|
return torrents_;
|
|
}
|
|
|
|
[[nodiscard]] constexpr auto const& torrents() const
|
|
{
|
|
return torrents_;
|
|
}
|
|
|
|
[[nodiscard]] auto unique_lock() const
|
|
{
|
|
return std::unique_lock(session_mutex_);
|
|
}
|
|
|
|
[[nodiscard]] constexpr auto isClosing() const noexcept
|
|
{
|
|
return is_closing_;
|
|
}
|
|
|
|
// download dir
|
|
|
|
[[nodiscard]] constexpr auto const& downloadDir() const noexcept
|
|
{
|
|
return download_dir_;
|
|
}
|
|
|
|
void setDownloadDir(std::string_view dir)
|
|
{
|
|
download_dir_ = dir;
|
|
}
|
|
|
|
// default trackers
|
|
// (trackers to apply automatically to public torrents)
|
|
|
|
[[nodiscard]] constexpr auto const& defaultTrackersStr() const noexcept
|
|
{
|
|
return default_trackers_str_;
|
|
}
|
|
|
|
[[nodiscard]] constexpr auto const& defaultTrackers() const noexcept
|
|
{
|
|
return default_trackers_;
|
|
}
|
|
|
|
void setDefaultTrackers(std::string_view trackers);
|
|
|
|
// incomplete dir
|
|
|
|
[[nodiscard]] constexpr auto const& incompleteDir() const noexcept
|
|
{
|
|
return incomplete_dir_;
|
|
}
|
|
|
|
void setIncompleteDir(std::string_view dir)
|
|
{
|
|
incomplete_dir_ = dir;
|
|
}
|
|
|
|
[[nodiscard]] constexpr auto useIncompleteDir() const noexcept
|
|
{
|
|
return incomplete_dir_enabled_;
|
|
}
|
|
|
|
constexpr void useIncompleteDir(bool enabled) noexcept
|
|
{
|
|
incomplete_dir_enabled_ = enabled;
|
|
}
|
|
|
|
// scripts
|
|
|
|
constexpr void useScript(TrScript i, bool enabled)
|
|
{
|
|
scripts_enabled_[i] = enabled;
|
|
}
|
|
|
|
[[nodiscard]] auto useScript(TrScript i) const
|
|
{
|
|
return scripts_enabled_[i];
|
|
}
|
|
|
|
void setScript(TrScript i, std::string_view path)
|
|
{
|
|
scripts_[i] = path;
|
|
}
|
|
|
|
[[nodiscard]] constexpr auto const& script(TrScript i) const
|
|
{
|
|
return scripts_[i];
|
|
}
|
|
|
|
// blocklist
|
|
|
|
[[nodiscard]] constexpr auto useBlocklist() const noexcept
|
|
{
|
|
return blocklist_enabled_;
|
|
}
|
|
|
|
void useBlocklist(bool enabled);
|
|
|
|
[[nodiscard]] constexpr auto const& blocklistUrl() const noexcept
|
|
{
|
|
return blocklist_url_;
|
|
}
|
|
|
|
void setBlocklistUrl(std::string_view url)
|
|
{
|
|
blocklist_url_ = url;
|
|
}
|
|
|
|
// RPC
|
|
|
|
void setRpcWhitelist(std::string_view whitelist) const;
|
|
|
|
std::string const& rpcWhitelist() const;
|
|
|
|
void useRpcWhitelist(bool enabled) const;
|
|
|
|
[[nodiscard]] bool useRpcWhitelist() const;
|
|
|
|
[[nodiscard]] auto externalIP() const noexcept
|
|
{
|
|
return external_ip_;
|
|
}
|
|
|
|
void setExternalIP(tr_address external_ip)
|
|
{
|
|
external_ip_ = external_ip;
|
|
}
|
|
|
|
// peer networking
|
|
|
|
[[nodiscard]] constexpr auto const& peerCongestionAlgorithm() const noexcept
|
|
{
|
|
return peer_congestion_algorithm_;
|
|
}
|
|
|
|
void setPeerCongestionAlgorithm(std::string_view algorithm)
|
|
{
|
|
peer_congestion_algorithm_ = algorithm;
|
|
}
|
|
|
|
void setSocketTOS(tr_socket_t sock, tr_address_type type) const
|
|
{
|
|
tr_netSetTOS(sock, peer_socket_tos_, type);
|
|
}
|
|
|
|
// bandwidth
|
|
|
|
[[nodiscard]] Bandwidth& getBandwidthGroup(std::string_view name);
|
|
|
|
public:
|
|
static constexpr std::array<std::tuple<tr_quark, tr_quark, TrScript>, 3> Scripts{
|
|
{ { TR_KEY_script_torrent_added_enabled, TR_KEY_script_torrent_added_filename, TR_SCRIPT_ON_TORRENT_ADDED },
|
|
{ TR_KEY_script_torrent_done_enabled, TR_KEY_script_torrent_done_filename, TR_SCRIPT_ON_TORRENT_DONE },
|
|
{ TR_KEY_script_torrent_done_seeding_enabled,
|
|
TR_KEY_script_torrent_done_seeding_filename,
|
|
TR_SCRIPT_ON_TORRENT_DONE_SEEDING } }
|
|
};
|
|
|
|
bool isPortRandom;
|
|
bool isPexEnabled;
|
|
bool isDHTEnabled;
|
|
bool isUTPEnabled;
|
|
bool isLPDEnabled;
|
|
bool isPrefetchEnabled;
|
|
bool is_closing_ = false;
|
|
bool isClosed;
|
|
bool isRatioLimited;
|
|
bool isIdleLimited;
|
|
bool isIncompleteFileNamingEnabled;
|
|
bool pauseAddedTorrent;
|
|
bool deleteSourceTorrent;
|
|
bool scrapePausedTorrents;
|
|
|
|
uint8_t peer_id_ttl_hours;
|
|
|
|
// torrent id, time removed
|
|
std::vector<std::pair<int, time_t>> removed_torrents;
|
|
|
|
bool stalledEnabled;
|
|
bool queueEnabled[2];
|
|
int queueSize[2];
|
|
int queueStalledMinutes;
|
|
|
|
int umask;
|
|
|
|
unsigned int speedLimit_Bps[2];
|
|
bool speedLimitEnabled[2];
|
|
|
|
struct tr_turtle_info turtle;
|
|
|
|
struct tr_fdInfo* fdInfo;
|
|
|
|
int magicNumber;
|
|
|
|
tr_encryption_mode encryptionMode;
|
|
|
|
tr_preallocation_mode preallocationMode;
|
|
|
|
struct event_base* event_base;
|
|
struct evdns_base* evdns_base;
|
|
struct tr_event_handle* events;
|
|
|
|
uint16_t peerLimit;
|
|
uint16_t peerLimitPerTorrent;
|
|
|
|
int uploadSlotsPerTorrent;
|
|
|
|
/* The UDP sockets used for the DHT and uTP. */
|
|
tr_port udp_port;
|
|
tr_socket_t udp_socket;
|
|
tr_socket_t udp6_socket;
|
|
unsigned char* udp6_bound;
|
|
struct event* udp_event;
|
|
struct event* udp6_event;
|
|
|
|
struct event* utp_timer;
|
|
|
|
/* The open port on the local machine for incoming peer requests */
|
|
tr_port private_peer_port;
|
|
|
|
/**
|
|
* The open port on the public device for incoming peer requests.
|
|
* This is usually the same as private_peer_port but can differ
|
|
* if the public device is a router and it decides to use a different
|
|
* port than the one requested by Transmission.
|
|
*/
|
|
tr_port public_peer_port;
|
|
|
|
tr_port randomPortLow;
|
|
tr_port randomPortHigh;
|
|
|
|
std::string config_dir;
|
|
std::string resume_dir;
|
|
std::string torrent_dir;
|
|
|
|
std::list<tr_blocklistFile*> blocklists;
|
|
struct tr_peerMgr* peerMgr;
|
|
struct tr_shared* shared;
|
|
|
|
struct tr_cache* cache;
|
|
|
|
class WebMediator final : public tr_web::Mediator
|
|
{
|
|
public:
|
|
explicit WebMediator(tr_session* session)
|
|
: session_{ session }
|
|
{
|
|
}
|
|
~WebMediator() override = default;
|
|
|
|
[[nodiscard]] std::optional<std::string> cookieFile() const override;
|
|
[[nodiscard]] std::optional<std::string> publicAddress() const override;
|
|
[[nodiscard]] std::optional<std::string> userAgent() const override;
|
|
[[nodiscard]] unsigned int clamp(int bandwidth_tag, unsigned int byte_count) const override;
|
|
void notifyBandwidthConsumed(int torrent_id, size_t byte_count) override;
|
|
// runs the tr_web::fetch response callback in the libtransmission thread
|
|
void run(tr_web::FetchDoneFunc&& func, tr_web::FetchResponse&& response) const override;
|
|
|
|
private:
|
|
tr_session* const session_;
|
|
};
|
|
|
|
WebMediator web_mediator{ this };
|
|
std::unique_ptr<tr_web> web;
|
|
|
|
struct tr_session_id* session_id;
|
|
|
|
tr_rpc_func rpc_func;
|
|
void* rpc_func_user_data;
|
|
|
|
struct tr_stats_handle* sessionStats;
|
|
|
|
struct tr_announcer* announcer;
|
|
struct tr_announcer_udp* announcer_udp;
|
|
|
|
struct event* nowTimer;
|
|
struct event* saveTimer;
|
|
|
|
// monitors the "global pool" speeds
|
|
Bandwidth top_bandwidth_;
|
|
|
|
std::map<tr_interned_string, std::unique_ptr<Bandwidth>> bandwidth_groups_;
|
|
|
|
float desiredRatio;
|
|
|
|
uint16_t idleLimitMinutes;
|
|
|
|
struct tr_bindinfo* bind_ipv4;
|
|
struct tr_bindinfo* bind_ipv6;
|
|
|
|
std::unique_ptr<tr_rpc_server> rpc_server_;
|
|
|
|
tr_announce_list default_trackers_;
|
|
|
|
// One of <netinet/ip.h>'s IPTOS_ values.
|
|
// See tr_netTos*() in libtransmission/net.h for more info
|
|
// Only session.cc should use this.
|
|
int peer_socket_tos_ = *tr_netTosFromName(TR_DEFAULT_PEER_SOCKET_TOS_STR);
|
|
|
|
private:
|
|
static std::recursive_mutex session_mutex_;
|
|
|
|
tr_torrents torrents_;
|
|
|
|
std::array<std::string, TR_SCRIPT_N_TYPES> scripts_;
|
|
std::string blocklist_url_;
|
|
std::string download_dir_;
|
|
std::string default_trackers_str_;
|
|
std::string incomplete_dir_;
|
|
std::string peer_congestion_algorithm_;
|
|
std::optional<tr_address> external_ip_;
|
|
|
|
std::array<bool, TR_SCRIPT_N_TYPES> scripts_enabled_;
|
|
bool blocklist_enabled_ = false;
|
|
bool incomplete_dir_enabled_ = false;
|
|
};
|
|
|
|
constexpr tr_port tr_sessionGetPublicPeerPort(tr_session const* session)
|
|
{
|
|
return session->public_peer_port;
|
|
}
|
|
|
|
bool tr_sessionAllowsDHT(tr_session const* session);
|
|
|
|
bool tr_sessionAllowsLPD(tr_session const* session);
|
|
|
|
bool tr_sessionIsAddressBlocked(tr_session const* session, struct tr_address const* addr);
|
|
|
|
struct tr_address const* tr_sessionGetPublicAddress(tr_session const* session, int tr_af_type, bool* is_default_value);
|
|
|
|
struct tr_bindsockets* tr_sessionGetBindSockets(tr_session*);
|
|
|
|
int tr_sessionCountTorrents(tr_session const* session);
|
|
|
|
std::vector<tr_torrent*> tr_sessionGetTorrents(tr_session* session);
|
|
|
|
enum
|
|
{
|
|
SESSION_MAGIC_NUMBER = 3845,
|
|
};
|
|
|
|
constexpr bool tr_isSession(tr_session const* session)
|
|
{
|
|
return session != nullptr && session->magicNumber == SESSION_MAGIC_NUMBER;
|
|
}
|
|
|
|
constexpr bool tr_isPriority(tr_priority_t p)
|
|
{
|
|
return p == TR_PRI_LOW || p == TR_PRI_NORMAL || p == TR_PRI_HIGH;
|
|
}
|
|
|
|
/***
|
|
****
|
|
***/
|
|
|
|
unsigned int tr_sessionGetSpeedLimit_Bps(tr_session const*, tr_direction);
|
|
unsigned int tr_sessionGetPieceSpeed_Bps(tr_session const*, tr_direction);
|
|
|
|
bool tr_sessionGetActiveSpeedLimit_Bps(tr_session const* session, tr_direction dir, unsigned int* setme);
|
|
|
|
std::vector<tr_torrent*> tr_sessionGetNextQueuedTorrents(tr_session* session, tr_direction dir, size_t numwanted);
|
|
|
|
int tr_sessionCountQueueFreeSlots(tr_session* session, tr_direction);
|