// 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. #pragma once #include // std::byte #include #include #include #include #include // std::pair #include #include "libtransmission/transmission.h" #include "libtransmission/announce-list.h" #include "libtransmission/block-info.h" #include "libtransmission/error.h" #include "libtransmission/file.h" #include "libtransmission/torrent-files.h" #include "libtransmission/tr-macros.h" // TR_CONSTEXPR20 #include "libtransmission/utils.h" // for tr_file_save() class tr_metainfo_builder { public: explicit tr_metainfo_builder(std::string_view single_file_or_parent_directory); tr_metainfo_builder(tr_metainfo_builder&&) = delete; tr_metainfo_builder(tr_metainfo_builder const&) = delete; tr_metainfo_builder& operator=(tr_metainfo_builder&&) = delete; tr_metainfo_builder& operator=(tr_metainfo_builder const&) = delete; // Generate piece checksums asynchronously. // - This must be done before calling `benc()` or `save()`. // - Runs in a worker thread because it can be time-consuming. // - Can be cancelled with `cancelChecksums()` and polled with `checksumStatus()` // - Resolves with a `tr_error` which is set on failure or empty on success. std::future make_checksums() { return std::async( std::launch::async, [this]() { auto error = tr_error{}; blocking_make_checksums(&error); return error; }); } // Returns the status of a `makeChecksums()` call: // The current piece being tested and the total number of pieces in the torrent. [[nodiscard]] constexpr std::pair checksum_status() const noexcept { return std::make_pair(checksum_piece_, block_info_.piece_count()); } // Tell the `makeChecksums()` worker thread to cleanly exit ASAP. constexpr void cancel_checksums() noexcept { cancel_ = true; } // generate the metainfo [[nodiscard]] std::string benc(tr_error* error = nullptr) const; // generate the metainfo and save it to a torrent file bool save(std::string_view filename, tr_error* error = nullptr) const { return tr_file_save(filename, benc(error), error); } /// setters void set_announce_list(tr_announce_list announce) { announce_ = std::move(announce); } // whether or not to include User-Agent and creation time constexpr void set_anonymize(bool anonymize) noexcept { anonymize_ = anonymize; } void set_comment(std::string_view comment) { comment_ = comment; } bool set_piece_size(uint32_t piece_size) noexcept; constexpr void set_private(bool is_private) noexcept { is_private_ = is_private; } void set_source(std::string_view source) { source_ = source; } void set_webseeds(std::vector webseeds) { webseeds_ = std::move(webseeds); } /// getters [[nodiscard]] constexpr auto const& announce_list() const noexcept { return announce_; } [[nodiscard]] constexpr auto const& anonymize() const noexcept { return anonymize_; } [[nodiscard]] constexpr auto const& comment() const noexcept { return comment_; } [[nodiscard]] TR_CONSTEXPR20 auto file_count() const noexcept { return files_.fileCount(); } [[nodiscard]] TR_CONSTEXPR20 auto file_size(tr_file_index_t i) const noexcept { return files_.fileSize(i); } [[nodiscard]] constexpr auto is_private() const noexcept { return is_private_; } [[nodiscard]] auto name() const noexcept { return tr_sys_path_basename(top_); } [[nodiscard]] auto const& path(tr_file_index_t i) const noexcept { return files_.path(i); } [[nodiscard]] constexpr auto piece_size() const noexcept { return block_info_.piece_size(); } [[nodiscard]] constexpr auto piece_count() const noexcept { return block_info_.piece_count(); } [[nodiscard]] constexpr auto const& source() const noexcept { return source_; } [[nodiscard]] constexpr auto const& top() const noexcept { return top_; } [[nodiscard]] constexpr auto total_size() const noexcept { return files_.totalSize(); } [[nodiscard]] constexpr auto const& webseeds() const noexcept { return webseeds_; } /// [[nodiscard]] static uint32_t default_piece_size(uint64_t total_size) noexcept; [[nodiscard]] constexpr static bool is_legal_piece_size(uint32_t x) { // It must be a power of two and at least 16KiB auto const MinSize = uint32_t{ 1024U * 16U }; auto const is_power_of_two = (x & (x - 1)) == 0; return x >= MinSize && is_power_of_two; } private: bool blocking_make_checksums(tr_error* error = nullptr); std::string top_; tr_torrent_files files_; tr_announce_list announce_; tr_block_info block_info_; std::vector piece_hashes_; std::vector webseeds_; std::string comment_; std::string source_; tr_piece_index_t checksum_piece_ = 0; bool is_private_ = false; bool anonymize_ = false; bool cancel_ = false; };