// This file Copyright © 2012-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 #include /* INT_MAX */ #include #include #include #include #include #include #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" namespace { // don't ask for the same metadata piece more than this often auto constexpr MinRepeatIntervalSecs = int{ 3 }; auto create_all_needed(int n_pieces) { auto ret = std::deque{}; ret.resize(n_pieces); for (int i = 0; i < n_pieces; ++i) { ret[i].piece = i; } return ret; } [[nodiscard]] int div_ceil(int numerator, int denominator) { auto const [quot, rem] = std::div(numerator, denominator); return quot + (rem == 0 ? 0 : 1); } } // namespace bool tr_torrentSetMetadataSizeHint(tr_torrent* tor, int64_t size) { if (tor->has_metainfo()) { return false; } if (tor->incomplete_metadata) { return false; } int const n = (size <= 0 || size > INT_MAX) ? -1 : div_ceil(size, MetadataPieceSize); tr_logAddDebugTor(tor, fmt::format("metadata is {} bytes in {} pieces", size, n)); if (n <= 0) { return false; } auto m = tr_incomplete_metadata{}; m.piece_count = n; m.metadata.resize(size); m.pieces_needed = create_all_needed(n); if (std::empty(m.metadata) || std::empty(m.pieces_needed)) { return false; } tor->incomplete_metadata = std::move(m); return true; } bool tr_torrentGetMetadataPiece(tr_torrent const* tor, int piece, tr_metadata_piece& setme) { TR_ASSERT(tr_isTorrent(tor)); TR_ASSERT(piece >= 0); if (!tor->has_metainfo()) { return {}; } auto const n_pieces = std::max(1, div_ceil(tor->info_dict_size(), MetadataPieceSize)); if (piece < 0 || piece >= n_pieces) { return {}; } auto in = std::ifstream{ tor->torrent_file(), std::ios_base::in }; if (!in.is_open()) { return {}; } auto const info_dict_size = tor->info_dict_size(); TR_ASSERT(info_dict_size > 0); auto const offset_in_info_dict = static_cast(piece) * MetadataPieceSize; if (auto const offset_in_file = tor->info_dict_offset() + offset_in_info_dict; !in.seekg(offset_in_file)) { return {}; } auto const piece_len = offset_in_info_dict + MetadataPieceSize <= info_dict_size ? MetadataPieceSize : info_dict_size - offset_in_info_dict; setme.resize(piece_len); return !!in.read(reinterpret_cast(std::data(setme)), std::size(setme)); } bool tr_torrentUseMetainfoFromFile( tr_torrent* tor, tr_torrent_metainfo const* metainfo, char const* filename_in, tr_error** error) { // add .torrent file if (!tr_sys_path_copy(filename_in, tor->torrent_file().c_str(), error)) { return false; } // remove .magnet file tr_sys_path_remove(tor->magnet_file()); // tor should keep this metainfo tor->set_metainfo(*metainfo); tor->incomplete_metadata.reset(); return true; } // --- namespace { namespace set_metadata_piece_helpers { [[nodiscard]] constexpr size_t get_piece_length(tr_incomplete_metadata const& m, int piece) { return piece + 1 == m.piece_count ? // last piece std::size(m.metadata) - (piece * MetadataPieceSize) : MetadataPieceSize; } void build_metainfo_except_info_dict(tr_torrent_metainfo const& tm, tr_variant* top) { tr_variantInitDict(top, 6); if (auto const& val = tm.comment(); !std::empty(val)) { tr_variantDictAddStr(top, TR_KEY_comment, val); } if (auto const& val = tm.source(); !std::empty(val)) { tr_variantDictAddStr(top, TR_KEY_source, val); } if (auto const& val = tm.creator(); !std::empty(val)) { tr_variantDictAddStr(top, TR_KEY_created_by, val); } if (auto const val = tm.date_created(); val != 0) { tr_variantDictAddInt(top, TR_KEY_creation_date, val); } if (auto const& announce_list = tm.announce_list(); !std::empty(announce_list)) { auto const n = std::size(announce_list); if (n == 1) { tr_variantDictAddStr(top, TR_KEY_announce, announce_list.at(0).announce.sv()); } else { auto* const announce_list_variant = tr_variantDictAddList(top, TR_KEY_announce_list, n); tr_variant* tier_variant = nullptr; auto current_tier = std::optional{}; for (auto const& tracker : announce_list) { if (!current_tier || *current_tier != tracker.tier) { tier_variant = tr_variantListAddList(announce_list_variant, n); } tr_variantListAddStr(tier_variant, tracker.announce.sv()); } } } if (auto const n_webseeds = tm.webseed_count(); n_webseeds > 0) { auto* const webseeds_variant = tr_variantDictAddList(top, TR_KEY_url_list, n_webseeds); for (size_t i = 0; i < n_webseeds; ++i) { tr_variantListAddStr(webseeds_variant, tm.webseed(i)); } } } bool use_new_metainfo(tr_torrent* tor, tr_error** error) { auto const& m = tor->incomplete_metadata; TR_ASSERT(m); // test the info_dict checksum if (tr_sha1::digest(m->metadata) != tor->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->metadata); if (!info_dict_v) { tr_error_propagate(error, &serde.error_); return false; } // yay we have an info dict. Let's make a torrent file auto top_v = tr_variant{}; build_metainfo_except_info_dict(tor->metainfo_, &top_v); tr_variantMergeDicts(tr_variantDictAddDict(&top_v, TR_KEY_info, 0), &*info_dict_v); auto const benc = serde.to_string(top_v); // does this synthetic torrent file parse? auto metainfo = tr_torrent_metainfo{}; if (!metainfo.parse_benc(benc)) { return false; } // save it if (!tr_file_save(tor->torrent_file(), benc, error)) { return false; } // remove .magnet file tr_sys_path_remove(tor->magnet_file()); // tor should keep this metainfo tor->set_metainfo(metainfo); return true; } void on_have_all_metainfo(tr_torrent* tor) { tr_error* error = nullptr; auto& m = tor->incomplete_metadata; TR_ASSERT(m); if (use_new_metainfo(tor, &error)) { m.reset(); } else /* drat. */ { auto const n = m->piece_count; m->pieces_needed = create_all_needed(n); char const* const msg = error != nullptr && error->message != nullptr ? error->message : "unknown error"; tr_logAddWarnTor( tor, fmt::format( tr_ngettext( "Couldn't parse magnet metainfo: '{error}'. Redownloading {piece_count} piece", "Couldn't parse magnet metainfo: '{error}'. Redownloading {piece_count} pieces", n), fmt::arg("error", msg), fmt::arg("piece_count", n))); tr_error_clear(&error); } } } // namespace set_metadata_piece_helpers } // namespace void tr_torrentMagnetDoIdleWork(tr_torrent* const tor) { using namespace set_metadata_piece_helpers; TR_ASSERT(tr_isTorrent(tor)); if (auto const& m = tor->incomplete_metadata; m && std::empty(m->pieces_needed)) { tr_logAddDebugTor(tor, fmt::format("we now have all the metainfo!")); on_have_all_metainfo(tor); } } void tr_torrentSetMetadataPiece(tr_torrent* tor, int piece, void const* data, size_t len) { using namespace set_metadata_piece_helpers; TR_ASSERT(tr_isTorrent(tor)); TR_ASSERT(data != nullptr); tr_logAddDebugTor(tor, fmt::format("got metadata piece {} of {} bytes", piece, len)); // are we set up to download metadata? auto& m = tor->incomplete_metadata; if (!m) { return; } // sanity test: is `piece` in range? if ((piece < 0) || (piece >= m->piece_count)) { return; } // sanity test: is `len` the right size? if (get_piece_length(*m, piece) != len) { return; } // do we need this piece? auto& needed = m->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; } size_t const offset = piece * MetadataPieceSize; std::copy_n(reinterpret_cast(data), len, std::begin(m->metadata) + offset); needed.erase(iter); tr_logAddDebugTor(tor, fmt::format("saving metainfo piece {}... {} remain", piece, std::size(needed))); } // --- std::optional tr_torrentGetNextMetadataRequest(tr_torrent* tor, time_t now) { TR_ASSERT(tr_isTorrent(tor)); auto& m = tor->incomplete_metadata; if (!m) { return {}; } auto& needed = m->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_logAddDebugTor(tor, fmt::format("next piece to request: {}", req.piece)); return req.piece; } double tr_torrentGetMetadataPercent(tr_torrent const* tor) { if (tor->has_metainfo()) { return 1.0; } if (auto const& m = tor->incomplete_metadata; m) { if (auto const& n = m->piece_count; n != 0) { return (n - std::size(m->pieces_needed)) / static_cast(n); } } return 0.0; } std::string tr_torrentGetMagnetLink(tr_torrent const* tor) { return tor->metainfo_.magnet(); } size_t tr_torrentGetMagnetLinkToBuf(tr_torrent const* tor, char* buf, size_t buflen) { return tr_strv_to_buf(tr_torrentGetMagnetLink(tor), buf, buflen); }