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

refactor: make tr_session's directory fields private (#3516)

This commit is contained in:
Charles Kerr 2022-07-23 02:13:18 -05:00 committed by GitHub
parent 47fe7c47d2
commit 4f7051fe7f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
16 changed files with 88 additions and 95 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
libtransmission/platform.cc
View File

@ -118,33 +118,6 @@ static std::string xdgConfigHome()
return fmt::format("{:s}/.config"sv, getHomeDir());
}
void tr_setConfigDir(tr_session* session, std::string_view config_dir)
{
#if defined(__APPLE__) || defined(_WIN32)
auto constexpr ResumeSubdir = "Resume"sv;
auto constexpr TorrentSubdir = "Torrents"sv;
#else
auto constexpr ResumeSubdir = "resume"sv;
auto constexpr TorrentSubdir = "torrents"sv;
#endif
session->config_dir = config_dir;
session->resume_dir = fmt::format("{:s}/{:s}"sv, config_dir, ResumeSubdir);
session->torrent_dir = fmt::format("{:s}/{:s}"sv, config_dir, TorrentSubdir);
tr_sys_dir_create(session->resume_dir, TR_SYS_DIR_CREATE_PARENTS, 0777);
tr_sys_dir_create(session->torrent_dir, TR_SYS_DIR_CREATE_PARENTS, 0777);
}
char const* tr_sessionGetConfigDir(tr_session const* session)
{
return session->config_dir.c_str();
}
char const* tr_getTorrentDir(tr_session const* session)
{
return session->torrent_dir.c_str();
}
char* tr_getDefaultConfigDir(char const* appname)
{
if (auto* dir = tr_env_get_string("TRANSMISSION_HOME", nullptr); dir != nullptr)
@ -265,7 +238,7 @@ std::string tr_getWebClientDir([[maybe_unused]] tr_session const* session)
#ifdef BUILD_MAC_CLIENT
// look in the Application Support folder
if (auto path = tr_pathbuf{ session->config_dir, "/public_html"sv }; isWebClientDir(path))
if (auto path = tr_pathbuf{ session->configDir(), "/public_html"sv }; isWebClientDir(path))
{
return std::string{ path };
}

21
libtransmission/platform.h
View File

@ -10,32 +10,11 @@
#endif
#include <string>
#include <string_view>
struct tr_session;
/**
* @addtogroup tr_session Session
* @{
*/
/**
* @brief invoked by tr_sessionInit() to set up the locations of the resume, torrent, and clutch directories.
* @see tr_getResumeDir()
* @see tr_getTorrentDir()
* @see tr_getWebClientDir()
*/
void tr_setConfigDir(tr_session* session, std::string_view config_dir);
/** @brief return the directory where torrent files are stored */
char const* tr_getTorrentDir(tr_session const*);
/** @brief return the directory where the Web Client's web ui files are kept */
std::string tr_getWebClientDir(tr_session const*);
/** @brief return the directory where session id lock files are stored */
std::string tr_getSessionIdDir();
/** @} */
/* @} */

2
libtransmission/resume.cc
View File

@ -655,7 +655,7 @@ static auto loadFromFile(tr_torrent* tor, tr_resume::fields_t fieldsToLoad, bool
auto const wasDirty = tor->isDirty;
auto const migrated = tr_torrent_metainfo::migrateFile(
tor->session->resume_dir,
tor->session->resumeDir(),
tor->name(),
tor->infoHashString(),
".resume"sv);

4
libtransmission/rpcimpl.cc
View File

@ -1444,7 +1444,7 @@ static void onBlocklistFetched(tr_web::FetchResponse const& web_response)
// tr_blocklistSetContent needs a source file,
// so save content into a tmpfile
auto const filename = tr_pathbuf{ session->config_dir, "/blocklist.tmp"sv };
auto const filename = tr_pathbuf{ session->configDir(), "/blocklist.tmp"sv };
if (tr_error* error = nullptr; !tr_saveFile(filename, content, &error))
{
tr_idle_function_done(
@ -2171,7 +2171,7 @@ static void addSessionField(tr_session const* s, tr_variant* d, tr_quark key)
break;
case TR_KEY_config_dir:
tr_variantDictAddStr(d, key, tr_sessionGetConfigDir(s));
tr_variantDictAddStr(d, key, s->configDir());
break;
case TR_KEY_default_trackers:

50
libtransmission/session.cc
View File

@ -46,7 +46,6 @@
#include "peer-io.h"
#include "peer-mgr.h"
#include "platform-quota.h" /* tr_device_info_free() */
#include "platform.h" /* tr_getTorrentDir() */
#include "port-forwarding.h"
#include "rpc-server.h"
#include "session-id.h"
@ -128,7 +127,7 @@ tr_peer_id_t tr_peerIdInit()
std::optional<std::string> tr_session::WebMediator::cookieFile() const
{
auto const path = tr_pathbuf{ session_->config_dir, "/cookies.txt" };
auto const path = tr_pathbuf{ session_->configDir(), "/cookies.txt"sv };
if (!tr_sys_path_exists(path))
{
@ -740,7 +739,7 @@ static void tr_sessionInitImpl(init_data* data)
tr_logSetQueueEnabled(data->messageQueuingEnabled);
tr_setConfigDir(session, data->config_dir);
session->initConfigDir(data->config_dir);
session->peerMgr = tr_peerMgrNew(session);
@ -750,7 +749,7 @@ static void tr_sessionInitImpl(init_data* data)
*** Blocklist
**/
tr_sys_dir_create(tr_pathbuf{ session->config_dir, "/blocklists"sv }, TR_SYS_DIR_CREATE_PARENTS, 0777);
tr_sys_dir_create(tr_pathbuf{ session->configDir(), "/blocklists"sv }, TR_SYS_DIR_CREATE_PARENTS, 0777);
loadBlocklists(session);
TR_ASSERT(tr_isSession(session));
@ -1205,6 +1204,13 @@ char const* tr_sessionGetDownloadDir(tr_session const* session)
return session->downloadDir().c_str();
}
char const* tr_sessionGetConfigDir(tr_session const* session)
{
TR_ASSERT(tr_isSession(session));
return session->configDir().c_str();
}
/***
****
***/
@ -2050,16 +2056,14 @@ static void sessionLoadTorrents(struct sessionLoadTorrentsData* const data)
TR_ASSERT(tr_isSession(data->session));
tr_sys_path_info info;
char const* const dirname = tr_getTorrentDir(data->session);
tr_sys_dir_t odir = (tr_sys_path_get_info(dirname, 0, &info) && info.type == TR_SYS_PATH_IS_DIRECTORY) ?
tr_sys_dir_open(dirname) :
auto const& dirname = data->session->torrentDir();
tr_sys_dir_t odir = (tr_sys_path_get_info(dirname.c_str(), 0, &info) && info.type == TR_SYS_PATH_IS_DIRECTORY) ?
tr_sys_dir_open(dirname.c_str()) :
TR_BAD_SYS_DIR;
auto torrents = std::list<tr_torrent*>{};
if (odir != TR_BAD_SYS_DIR)
{
auto const dirname_sv = std::string_view{ dirname };
char const* name = nullptr;
while ((name = tr_sys_dir_read_name(odir)) != nullptr)
{
@ -2068,7 +2072,7 @@ static void sessionLoadTorrents(struct sessionLoadTorrentsData* const data)
continue;
}
auto const path = tr_pathbuf{ dirname_sv, "/"sv, name };
auto const path = tr_pathbuf{ dirname, '/', name };
// is a magnet link?
if (!tr_ctorSetMetainfoFromFile(data->ctor, path.sv(), nullptr))
@ -2366,7 +2370,7 @@ static void loadBlocklists(tr_session* session)
auto const isEnabled = session->useBlocklist();
/* walk the blocklist directory... */
auto const dirname = tr_pathbuf{ session->config_dir, "/blocklists"sv };
auto const dirname = tr_pathbuf{ session->configDir(), "/blocklists"sv };
auto const odir = tr_sys_dir_open(dirname);
if (odir == TR_BAD_SYS_DIR)
@ -2506,7 +2510,7 @@ size_t tr_blocklistSetContent(tr_session* session, char const* contentFilename)
BlocklistFile* b = nullptr;
if (it == std::end(src))
{
auto path = tr_pathbuf{ session->config_dir, "/blocklists/"sv, name };
auto path = tr_pathbuf{ session->configDir(), "/blocklists/"sv, name };
src.push_back(std::make_unique<BlocklistFile>(path, session->useBlocklist()));
b = std::rbegin(src)->get();
}
@ -2886,7 +2890,7 @@ int tr_sessionCountQueueFreeSlots(tr_session* session, tr_direction dir)
static void bandwidthGroupRead(tr_session* session, std::string_view config_dir)
{
auto const filename = tr_pathbuf{ config_dir, "/"sv, BandwidthGroupsFilename };
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))
@ -2949,7 +2953,7 @@ static int bandwidthGroupWrite(tr_session const* session, std::string_view confi
tr_variantDictAddBool(dict, TR_KEY_honorsSessionLimits, group->areParentLimitsHonored(TR_UP));
}
auto const filename = tr_pathbuf{ config_dir, "/"sv, BandwidthGroupsFilename };
auto const filename = tr_pathbuf{ config_dir, '/', BandwidthGroupsFilename };
auto const ret = tr_variantToFile(&groups_dict, TR_VARIANT_FMT_JSON, filename);
tr_variantFree(&groups_dict);
return ret;
@ -2995,3 +2999,21 @@ void tr_sessionSetCompletenessCallback(tr_session* session, tr_torrent_completen
{
session->setTorrentCompletenessCallback(cb, user_data);
}
///
void tr_session::initConfigDir(std::string_view config_dir)
{
TR_ASSERT(std::empty(config_dir_));
config_dir_ = config_dir;
#if defined(__APPLE__) || defined(_WIN32)
resume_dir_ = fmt::format("{:s}/Resume"sv, config_dir);
torrent_dir_ = fmt::format("{:s}/Torrents"sv, config_dir);
#else
resume_dir_ = fmt::format("{:s}/resume"sv, config_dir);
torrent_dir_ = fmt::format("{:s}/torrents"sv, config_dir);
#endif
tr_sys_dir_create(resume_dir_, TR_SYS_DIR_CREATE_PARENTS, 0777);
tr_sys_dir_create(torrent_dir_, TR_SYS_DIR_CREATE_PARENTS, 0777);
}

33
libtransmission/session.h
View File

@ -130,7 +130,24 @@ public:
return is_closing_;
}
// download dir
// paths
void initConfigDir(std::string_view config_dir);
[[nodiscard]] constexpr auto const& configDir() const noexcept
{
return config_dir_;
}
[[nodiscard]] constexpr auto const& torrentDir() const noexcept
{
return torrent_dir_;
}
[[nodiscard]] constexpr auto const& resumeDir() const noexcept
{
return resume_dir_;
}
[[nodiscard]] constexpr auto const& downloadDir() const noexcept
{
@ -473,10 +490,6 @@ public:
tr_port randomPortLow;
tr_port randomPortHigh;
std::string config_dir;
std::string resume_dir;
std::string torrent_dir;
std::vector<std::unique_ptr<BlocklistFile>> blocklists;
struct tr_peerMgr* peerMgr = nullptr;
struct tr_shared* shared = nullptr;
@ -547,11 +560,17 @@ private:
tr_torrents torrents_;
std::array<std::string, TR_SCRIPT_N_TYPES> scripts_;
std::string blocklist_url_;
std::string config_dir_;
std::string download_dir_;
std::string default_trackers_str_;
std::string incomplete_dir_;
std::string resume_dir_;
std::string torrent_dir_;
std::string blocklist_url_;
std::string default_trackers_str_;
std::string peer_congestion_algorithm_;
std::optional<tr_address> external_ip_;
queue_start_callback_t queue_start_callback_ = nullptr;

6
libtransmission/stats.cc
View File

@ -34,14 +34,14 @@ static void loadCumulativeStats(tr_session const* session, tr_session_stats* set
{
auto top = tr_variant{};
auto filename = tr_pathbuf{ session->config_dir, "/stats.json"sv };
auto filename = tr_pathbuf{ session->configDir(), "/stats.json"sv };
bool loaded = tr_variantFromFile(&top, TR_VARIANT_PARSE_JSON, filename.sv(), nullptr);
if (!loaded)
{
// maybe the user just upgraded from an old version of Transmission
// that was still using stats.benc
filename.assign(session->config_dir, "/stats.benc");
filename.assign(session->configDir(), "/stats.benc");
loaded = tr_variantFromFile(&top, TR_VARIANT_PARSE_BENC, filename.sv(), nullptr);
}
@ -80,7 +80,7 @@ static void loadCumulativeStats(tr_session const* session, tr_session_stats* set
static void saveCumulativeStats(tr_session const* session, tr_session_stats const* s)
{
auto const filename = tr_pathbuf{ session->config_dir, "/stats.json"sv };
auto const filename = tr_pathbuf{ session->configDir(), "/stats.json"sv };
auto top = tr_variant{};
tr_variantInitDict(&top, 5);
tr_variantDictAddInt(&top, TR_KEY_downloaded_bytes, s->downloadedBytes);

8
libtransmission/torrent.cc
View File

@ -753,7 +753,7 @@ static void torrentInit(tr_torrent* tor, tr_ctor const* ctor)
if (resume_file_was_migrated)
{
tr_torrent_metainfo::migrateFile(session->torrent_dir, tor->name(), tor->infoHashString(), ".torrent"sv);
tr_torrent_metainfo::migrateFile(session->torrentDir(), tor->name(), tor->infoHashString(), ".torrent"sv);
}
}
@ -1611,9 +1611,9 @@ static void closeTorrent(tr_torrent* const tor)
if (tor->isDeleting)
{
tr_torrent_metainfo::removeFile(tor->session->torrent_dir, tor->name(), tor->infoHashString(), ".torrent"sv);
tr_torrent_metainfo::removeFile(tor->session->torrent_dir, tor->name(), tor->infoHashString(), ".magnet"sv);
tr_torrent_metainfo::removeFile(tor->session->resume_dir, tor->name(), tor->infoHashString(), ".resume"sv);
tr_torrent_metainfo::removeFile(tor->session->torrentDir(), tor->name(), tor->infoHashString(), ".torrent"sv);
tr_torrent_metainfo::removeFile(tor->session->torrentDir(), tor->name(), tor->infoHashString(), ".magnet"sv);
tr_torrent_metainfo::removeFile(tor->session->resumeDir(), tor->name(), tor->infoHashString(), ".resume"sv);
}
tor->isRunning = false;

6
libtransmission/torrent.h
View File

@ -450,17 +450,17 @@ public:
[[nodiscard]] auto torrentFile() const
{
return metainfo_.torrentFile(this->session->torrent_dir);
return metainfo_.torrentFile(session->torrentDir());
}
[[nodiscard]] auto magnetFile() const
{
return metainfo_.magnetFile(this->session->torrent_dir);
return metainfo_.magnetFile(session->torrentDir());
}
[[nodiscard]] auto resumeFile() const
{
return metainfo_.resumeFile(this->session->resume_dir);
return metainfo_.resumeFile(session->resumeDir());
}
[[nodiscard]] auto magnet() const

6
libtransmission/tr-dht.cc
View File

@ -146,7 +146,7 @@ static void dht_boostrap_from_file(tr_session* session)
}
// check for a manual bootstrap file.
auto in = std::ifstream{ tr_pathbuf{ session->config_dir, "/dht.bootstrap"sv } };
auto in = std::ifstream{ tr_pathbuf{ session->configDir(), "/dht.bootstrap"sv } };
if (!in.is_open())
{
return;
@ -292,7 +292,7 @@ int tr_dhtInit(tr_session* ss)
}
auto benc = tr_variant{};
auto const dat_file = tr_pathbuf{ ss->config_dir, "/dht.dat"sv };
auto const dat_file = tr_pathbuf{ ss->configDir(), "/dht.dat"sv };
auto const ok = tr_variantFromFile(&benc, TR_VARIANT_PARSE_BENC, dat_file.sv());
bool have_id = false;
@ -443,7 +443,7 @@ void tr_dhtUninit(tr_session* ss)
tr_variantDictAddRaw(&benc, TR_KEY_nodes6, compact6, out6 - compact6);
}
auto const dat_file = tr_pathbuf{ ss->config_dir, "/dht.dat" };
auto const dat_file = tr_pathbuf{ ss->configDir(), "/dht.dat"sv };
tr_variantToFile(&benc, TR_VARIANT_FMT_BENC, dat_file.sv());
tr_variantFree(&benc);
}

2
libtransmission/transmission.h
View File

@ -704,7 +704,7 @@ void tr_sessionSetQueueStartCallback(tr_session*, void (*callback)(tr_session*,
***/
/**
* Load all the torrents in tr_getTorrentDir().
* Load all the torrents in the session's torrent folder.
* This can be used at startup to kickstart all the torrents
* from the previous session.
*/

4
tests/libtransmission/blocklist-test.cc
View File

@ -69,7 +69,7 @@ TEST_F(BlocklistTest, parsing)
EXPECT_EQ(0U, tr_blocklistGetRuleCount(session_));
// init the blocklist
auto const path = tr_pathbuf{ tr_sessionGetConfigDir(session_), "/blocklists/level1" };
auto const path = tr_pathbuf{ session_->configDir(), "/blocklists/level1"sv };
createFileWithContents(path, Contents1);
tr_sessionReloadBlocklists(session_);
EXPECT_TRUE(tr_blocklistExists(session_));
@ -105,7 +105,7 @@ TEST_F(BlocklistTest, parsing)
TEST_F(BlocklistTest, updating)
{
// init the session
auto const path = tr_pathbuf{ tr_sessionGetConfigDir(session_), "/blocklists/level1" };
auto const path = tr_pathbuf{ session_->configDir(), "/blocklists/level1"sv };
// no blocklist to start with...
EXPECT_EQ(0U, tr_blocklistGetRuleCount(session_));

2
tests/libtransmission/file-test.cc
View File

@ -50,7 +50,7 @@ class FileTest : public SessionTest
protected:
auto createTestDir(std::string const& child_name)
{
auto test_dir = tr_pathbuf{ tr_sessionGetConfigDir(session_), '/', child_name };
auto test_dir = tr_pathbuf{ session_->configDir(), '/', child_name };
tr_sys_dir_create(test_dir, 0, 0777);
return test_dir;
}

2
tests/libtransmission/move-test.cc
View File

@ -156,7 +156,7 @@ using MoveTest = SessionTest;
TEST_F(MoveTest, setLocation)
{
auto const target_dir = tr_pathbuf{ tr_sessionGetConfigDir(session_), "/target"sv };
auto const target_dir = tr_pathbuf{ session_->configDir(), "/target"sv };
tr_sys_dir_create(target_dir.data(), TR_SYS_DIR_CREATE_PARENTS, 0777, nullptr);
// init a torrent.

4
tests/libtransmission/open-files-test.cc
View File

@ -170,7 +170,7 @@ TEST_F(OpenFilesTest, closesLeastRecentlyUsedFile)
// supplant older ones.
for (int i = 0; i < LargerThanCacheLimit; ++i)
{
auto filename = tr_pathbuf{ sandboxDir(), fmt::format("/file-{:d}.txt", i) };
auto filename = tr_pathbuf{ sandboxDir(), fmt::format("/file-{:d}.txt"sv, i) };
EXPECT_TRUE(session_->openFiles().get(TorId, i, true, filename, TR_PREALLOCATE_FULL, std::size(Contents)));
}
@ -182,7 +182,7 @@ TEST_F(OpenFilesTest, closesLeastRecentlyUsedFile)
auto sorted = std::array<bool, LargerThanCacheLimit>{};
for (int i = 0; i < LargerThanCacheLimit; ++i)
{
auto filename = tr_pathbuf{ sandboxDir(), fmt::format("/file-{:d}.txt", i) };
auto filename = tr_pathbuf{ sandboxDir(), fmt::format("/file-{:d}.txt"sv, i) };
results[i] = !!session_->openFiles().get(TorId, i, false);
}
sorted = results;

4
tests/libtransmission/remove-test.cc
View File

@ -246,7 +246,7 @@ TEST_F(RemoveTest, RemovesLeftoverJunk)
EXPECT_EQ(expected_tree, getSubtreeContents(parent));
// add a junk file *inside of* the torrent's top directory.
auto const junk_file = tr_pathbuf{ parent, "/alice_in_wonderland_librivox/", JunkBasename };
auto const junk_file = tr_pathbuf{ parent, "/alice_in_wonderland_librivox/"sv, JunkBasename };
createFileWithContents(junk_file, std::data(Content), std::size(Content));
expected_tree.emplace(junk_file);
EXPECT_EQ(expected_tree, getSubtreeContents(parent));
@ -295,7 +295,7 @@ TEST_F(RemoveTest, LeavesNonJunkAlone)
EXPECT_EQ(expected_tree, getSubtreeContents(parent));
// add a non-junk file.
auto const nonjunk_file = tr_pathbuf{ parent, "/alice_in_wonderland_librivox/", NonJunkBasename };
auto const nonjunk_file = tr_pathbuf{ parent, "/alice_in_wonderland_librivox/"sv, NonJunkBasename };
createFileWithContents(nonjunk_file, std::data(Content), std::size(Content));
expected_tree.emplace(nonjunk_file);
EXPECT_EQ(expected_tree, getSubtreeContents(parent));