// This file Copyright © 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 #include #include #include #include #include #include #include #include #include #include // std::move #include #include "libtransmission/transmission.h" #include "libtransmission/crypto-utils.h" // for tr_sha1() #include "libtransmission/error.h" #include "libtransmission/file.h" #include "libtransmission/quark.h" #include "libtransmission/torrent-magnet.h" #include "libtransmission/torrent-metainfo.h" #include "libtransmission/torrent.h" #include "libtransmission/tr-assert.h" #include "libtransmission/utils.h" #include "libtransmission/variant.h" #define tr_logAddDebugMagnet(magnet, msg) tr_logAddDebug(msg, (magnet)->log_name()) namespace { // don't ask for the same metadata piece more than this often auto constexpr MinRepeatIntervalSecs = time_t{ 3 }; [[nodiscard]] int64_t div_ceil(int64_t numerator, int64_t denominator) { auto const [quot, rem] = std::lldiv(numerator, denominator); return quot + (rem == 0 ? 0 : 1); } } // namespace void tr_metadata_download::create_all_needed(int64_t n_pieces) noexcept { pieces_needed_.clear(); pieces_needed_.resize(n_pieces); for (int64_t i = 0; i < n_pieces; ++i) { pieces_needed_[i].piece = i; } } tr_metadata_download::tr_metadata_download(std::string_view log_name, int64_t const size) : log_name_{ std::string{ log_name } } { TR_ASSERT(is_valid_metadata_size(size)); auto const n = div_ceil(size, MetadataPieceSize); tr_logAddDebugMagnet(this, fmt::format("metadata is {} bytes in {} pieces", size, n)); piece_count_ = n; metadata_.resize(size); create_all_needed(n); } void tr_torrent::do_magnet_idle_work() { if (auto& m = metadata_download_; m && m->is_complete()) { tr_logAddDebugTor(this, fmt::format("we now have all the metainfo!")); on_have_all_metainfo(); } } void tr_torrent::maybe_start_metadata_transfer(int64_t const size) noexcept { if (has_metainfo() || metadata_download_) { return; } if (!tr_metadata_download::is_valid_metadata_size(size)) { TR_ASSERT(false); return; } metadata_download_ = std::make_unique(name(), size); } [[nodiscard]] std::optional tr_torrent::get_metadata_piece(int64_t const piece) const { TR_ASSERT(piece >= 0); if (!has_metainfo()) { return {}; } auto const info_dict_size = this->info_dict_size(); TR_ASSERT(info_dict_size > 0); if (auto const n_pieces = std::max(int64_t{ 1 }, div_ceil(info_dict_size, MetadataPieceSize)); piece < 0 || piece >= n_pieces) { return {}; } auto in = std::ifstream{ torrent_file(), std::ios_base::in | std::ios_base::binary }; if (!in.is_open()) { return {}; } auto const offset_in_info_dict = piece * MetadataPieceSize; if (auto const offset_in_file = info_dict_offset() + offset_in_info_dict; !in.seekg(offset_in_file)) { return {}; } auto const piece_len = static_cast(offset_in_info_dict + MetadataPieceSize) <= info_dict_size ? MetadataPieceSize : info_dict_size - offset_in_info_dict; if (auto ret = tr_metadata_piece(piece_len); in.read(reinterpret_cast(std::data(ret)), std::size(ret))) { return ret; } return {}; } bool tr_torrent::use_metainfo_from_file(tr_torrent_metainfo const* metainfo, char const* filename_in, tr_error* error) { // add .torrent file if (!tr_sys_path_copy(filename_in, torrent_file().c_str(), error)) { return false; } // remove .magnet file tr_sys_path_remove(magnet_file()); // tor should keep this metainfo set_metainfo(*metainfo); metadata_download_.reset(); return true; } // --- namespace { namespace set_metadata_piece_helpers { tr_variant build_metainfo_except_info_dict(tr_torrent_metainfo const& tm) { auto top = tr_variant::Map{ 8U }; if (auto const& val = tm.comment(); !std::empty(val)) { top.try_emplace(TR_KEY_comment, val); } if (auto const& val = tm.source(); !std::empty(val)) { top.try_emplace(TR_KEY_source, val); } if (auto const& val = tm.creator(); !std::empty(val)) { top.try_emplace(TR_KEY_created_by, val); } if (auto const val = tm.date_created(); val != 0) { top.try_emplace(TR_KEY_creation_date, val); } if (auto const& announce_list = tm.announce_list(); !std::empty(announce_list)) { announce_list.add_to_map(top); } if (auto const n_webseeds = tm.webseed_count(); n_webseeds > 0U) { auto webseed_vec = tr_variant::Vector{}; webseed_vec.reserve(n_webseeds); for (size_t i = 0U; i < n_webseeds; ++i) { webseed_vec.emplace_back(tm.webseed(i)); } } return tr_variant{ std::move(top) }; } } // namespace set_metadata_piece_helpers } // namespace [[nodiscard]] bool tr_torrent::use_new_metainfo(tr_error* error) { using namespace set_metadata_piece_helpers; auto const& m = metadata_download_; TR_ASSERT(m); // test the info_dict checksum if (tr_sha1::digest(m->get_metadata()) != info_hash()) { return false; } // checksum passed; now try to parse it as benc auto serde = tr_variant_serde::benc().inplace(); auto info_dict_v = serde.parse(m->get_metadata()); if (!info_dict_v) { if (error != nullptr) { *error = std::move(serde.error_); serde.error_ = {}; } return false; } // yay we have an info dict. Let's make a torrent file auto top_var = build_metainfo_except_info_dict(metainfo()); tr_variantMergeDicts(tr_variantDictAddDict(&top_var, TR_KEY_info, 0), &*info_dict_v); auto const benc = serde.to_string(top_var); // does this synthetic torrent file parse? auto metainfo = tr_torrent_metainfo{}; if (!metainfo.parse_benc(benc)) { return false; } // save it if (!tr_file_save(torrent_file(), benc, error)) { return false; } // remove .magnet file tr_sys_path_remove(magnet_file()); // tor should keep this metainfo set_metainfo(metainfo); return true; } void tr_torrent::on_have_all_metainfo() { auto& m = metadata_download_; TR_ASSERT(m); if (auto error = tr_error{}; !use_new_metainfo(&error)) /* drat. */ { auto msg = std::string_view{ error && !std::empty(error.message()) ? error.message() : "unknown error" }; tr_logAddWarnTor( this, fmt::format("Couldn't parse magnet metainfo: '{error}'. Redownloading metadata", fmt::arg("error", msg))); } m.reset(); } void tr_metadata_download::set_metadata_piece(int64_t const piece, void const* const data, size_t const len) { TR_ASSERT(data != nullptr); // sanity test: is `piece` in range? if (piece < 0 || piece >= piece_count_) { return; } // sanity test: is `len` the right size? if (get_piece_length(piece) != len) { return; } // do we need this piece? auto& needed = pieces_needed_; auto const iter = std::find_if( std::begin(needed), std::end(needed), [piece](auto const& item) { return item.piece == piece; }); if (iter == std::end(needed)) { return; } auto const offset = piece * MetadataPieceSize; std::copy_n(reinterpret_cast(data), len, std::begin(metadata_) + offset); needed.erase(iter); tr_logAddDebugMagnet(this, fmt::format("saving metainfo piece {}... {} remain", piece, std::size(needed))); } void tr_torrent::set_metadata_piece(int64_t const piece, void const* const data, size_t const len) { TR_ASSERT(data != nullptr); tr_logAddDebugTor(this, fmt::format("got metadata piece {} of {} bytes", piece, len)); if (auto& m = metadata_download_) { m->set_metadata_piece(piece, data, len); } } // --- [[nodiscard]] std::optional tr_metadata_download::get_next_metadata_request(time_t const now) noexcept { auto& needed = pieces_needed_; if (std::empty(needed) || needed.front().requested_at + MinRepeatIntervalSecs >= now) { return {}; } auto req = needed.front(); needed.pop_front(); req.requested_at = now; needed.push_back(req); tr_logAddDebugMagnet(this, fmt::format("next piece to request: {}", req.piece)); return req.piece; } [[nodiscard]] std::optional tr_torrent::get_next_metadata_request(time_t const now) noexcept { if (auto& m = metadata_download_; m) { return m->get_next_metadata_request(now); } return {}; } [[nodiscard]] double tr_metadata_download::get_metadata_percent() const noexcept { if (auto const n = piece_count_; n != 0) { return (n - std::size(pieces_needed_)) / static_cast(n); } return 0.0; } [[nodiscard]] double tr_torrent::get_metadata_percent() const noexcept { if (has_metainfo()) { return 1.0; } if (auto const& m = metadata_download_; m) { return m->get_metadata_percent(); } return 0.0; } // --- std::string tr_torrentGetMagnetLink(tr_torrent const* tor) { return tor->magnet(); } size_t tr_torrentGetMagnetLinkToBuf(tr_torrent const* tor, char* buf, size_t buflen) { return tr_strv_to_buf(tr_torrentGetMagnetLink(tor), buf, buflen); }