transmission/libtransmission/session-settings.h

// 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 <cstddef> // for size_t
#include <string>

#include "libtransmission/transmission.h"

#include "libtransmission/log.h" // for tr_log_level
#include "libtransmission/net.h" // for tr_port, tr_tos_t
#include "libtransmission/open-files.h" // for tr_open_files::Preallocation
#include "libtransmission/peer-io.h" // tr_preferred_transport
#include "libtransmission/quark.h"

struct tr_variant;

#define SESSION_SETTINGS_FIELDS(V) \
    V(TR_KEY_announce_ip, announce_ip, std::string, "", "") \
    V(TR_KEY_announce_ip_enabled, announce_ip_enabled, bool, false, "") \
    V(TR_KEY_bind_address_ipv4, bind_address_ipv4, std::string, "0.0.0.0", "") \
    V(TR_KEY_bind_address_ipv6, bind_address_ipv6, std::string, "::", "") \
    V(TR_KEY_blocklist_enabled, blocklist_enabled, bool, false, "") \
    V(TR_KEY_blocklist_url, blocklist_url, std::string, "http://www.example.com/blocklist", "") \
    V(TR_KEY_cache_size_mb, cache_size_mbytes, size_t, 4U, "") \
    V(TR_KEY_default_trackers, default_trackers_str, std::string, "", "") \
    V(TR_KEY_dht_enabled, dht_enabled, bool, true, "") \
    V(TR_KEY_download_dir, download_dir, std::string, tr_getDefaultDownloadDir(), "") \
    V(TR_KEY_download_queue_enabled, download_queue_enabled, bool, true, "") \
    V(TR_KEY_download_queue_size, download_queue_size, size_t, 5U, "") \
    V(TR_KEY_encryption, encryption_mode, tr_encryption_mode, TR_ENCRYPTION_PREFERRED, "") \
    V(TR_KEY_idle_seeding_limit, idle_seeding_limit_minutes, size_t, 30U, "") \
    V(TR_KEY_idle_seeding_limit_enabled, idle_seeding_limit_enabled, bool, false, "") \
    V(TR_KEY_incomplete_dir, incomplete_dir, std::string, tr_getDefaultDownloadDir(), "") \
    V(TR_KEY_incomplete_dir_enabled, incomplete_dir_enabled, bool, false, "") \
    V(TR_KEY_lpd_enabled, lpd_enabled, bool, true, "") \
    V(TR_KEY_message_level, log_level, tr_log_level, TR_LOG_INFO, "") \
    V(TR_KEY_peer_congestion_algorithm, peer_congestion_algorithm, std::string, "", "") \
    V(TR_KEY_peer_limit_global, peer_limit_global, size_t, TR_DEFAULT_PEER_LIMIT_GLOBAL, "") \
    V(TR_KEY_peer_limit_per_torrent, peer_limit_per_torrent, size_t, TR_DEFAULT_PEER_LIMIT_TORRENT, "") \
    V(TR_KEY_peer_port, \
      peer_port, \
      tr_port, \
      tr_port::from_host(TR_DEFAULT_PEER_PORT), \
      "The local machine's incoming peer port") \
    V(TR_KEY_peer_port_random_high, peer_port_random_high, tr_port, tr_port::from_host(65535), "") \
    V(TR_KEY_peer_port_random_low, peer_port_random_low, tr_port, tr_port::from_host(49152), "") \
    V(TR_KEY_peer_port_random_on_start, peer_port_random_on_start, bool, false, "") \
    V(TR_KEY_peer_socket_tos, peer_socket_tos, tr_tos_t, 0x04, "") \
    V(TR_KEY_pex_enabled, pex_enabled, bool, true, "") \
    V(TR_KEY_port_forwarding_enabled, port_forwarding_enabled, bool, true, "") \
    V(TR_KEY_preallocation, preallocation_mode, tr_open_files::Preallocation, tr_open_files::Preallocation::Sparse, "") \
    V(TR_KEY_queue_stalled_enabled, queue_stalled_enabled, bool, true, "") \
    V(TR_KEY_queue_stalled_minutes, queue_stalled_minutes, size_t, 30U, "") \
    V(TR_KEY_ratio_limit, ratio_limit, double, 2.0, "") \
    V(TR_KEY_ratio_limit_enabled, ratio_limit_enabled, bool, false, "") \
    V(TR_KEY_rename_partial_files, is_incomplete_file_naming_enabled, bool, false, "") \
    V(TR_KEY_scrape_paused_torrents_enabled, should_scrape_paused_torrents, bool, true, "") \
    V(TR_KEY_script_torrent_added_enabled, script_torrent_added_enabled, bool, false, "") \
    V(TR_KEY_script_torrent_added_filename, script_torrent_added_filename, std::string, "", "") \
    V(TR_KEY_script_torrent_done_enabled, script_torrent_done_enabled, bool, false, "") \
    V(TR_KEY_script_torrent_done_filename, script_torrent_done_filename, std::string, "", "") \
    V(TR_KEY_script_torrent_done_seeding_enabled, script_torrent_done_seeding_enabled, bool, false, "") \
    V(TR_KEY_script_torrent_done_seeding_filename, script_torrent_done_seeding_filename, std::string, "", "") \
    V(TR_KEY_seed_queue_enabled, seed_queue_enabled, bool, false, "") \
    V(TR_KEY_seed_queue_size, seed_queue_size, size_t, 10U, "") \
    V(TR_KEY_speed_limit_down, speed_limit_down, size_t, 100U, "") \
    V(TR_KEY_speed_limit_down_enabled, speed_limit_down_enabled, bool, false, "") \
    V(TR_KEY_speed_limit_up, speed_limit_up, size_t, 100U, "") \
    V(TR_KEY_speed_limit_up_enabled, speed_limit_up_enabled, bool, false, "") \
    V(TR_KEY_start_added_torrents, should_start_added_torrents, bool, true, "") \
    V(TR_KEY_tcp_enabled, tcp_enabled, bool, true, "") \
    V(TR_KEY_trash_original_torrent_files, should_delete_source_torrents, bool, false, "") \
    V(TR_KEY_umask, umask, tr_mode_t, 022, "") \
    V(TR_KEY_upload_slots_per_torrent, upload_slots_per_torrent, size_t, 8U, "") \
    V(TR_KEY_utp_enabled, utp_enabled, bool, true, "") \
    V(TR_KEY_preferred_transport, preferred_transport, tr_preferred_transport, TR_PREFER_UTP, "") \
    V(TR_KEY_torrent_added_verify_mode, torrent_added_verify_mode, tr_verify_added_mode, TR_VERIFY_ADDED_FAST, "")

struct tr_session_settings
{
    tr_session_settings() = default;

    explicit tr_session_settings(tr_variant const& src)
    {
        load(src);
    }

    void load(tr_variant const& src);
    [[nodiscard]] tr_variant settings() const;
    [[nodiscard]] static tr_variant default_settings();

#define V(key, name, type, default_value, comment) type name = type{ default_value };
    SESSION_SETTINGS_FIELDS(V)
#undef V
};