transmission/libtransmission/settings.cc

// 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 <array>
#include <cstddef> // size_t
#include <cstdint> // int64_t, uint32_t
#include <optional>
#include <string>
#include <string_view>
#include <utility>
#include <variant>

#include <fmt/core.h>

#include "libtransmission/transmission.h"

#include "libtransmission/log.h" // for tr_log_level
#include "libtransmission/net.h" // for tr_port
#include "libtransmission/open-files.h" // for tr_open_files::Preallocation
#include "libtransmission/peer-io.h" // tr_preferred_transport
#include "libtransmission/settings.h"
#include "libtransmission/utils.h" // for tr_strv_strip(), tr_strlower()
#include "libtransmission/variant.h"

using namespace std::literals;

namespace libtransmission
{
namespace
{
struct VariantConverter
{
public:
    template<typename T>
    static std::optional<T> load(tr_variant const& src);

    template<typename T>
    static tr_variant save(T const& val);

private:
    template<typename T, size_t N>
    using Lookup = std::array<std::pair<std::string_view, T>, N>;

    static auto constexpr EncryptionKeys = Lookup<tr_encryption_mode, 3U>{ {
        { "required", TR_ENCRYPTION_REQUIRED },
        { "preferred", TR_ENCRYPTION_PREFERRED },
        { "allowed", TR_CLEAR_PREFERRED },
    } };

    static auto constexpr LogKeys = Lookup<tr_log_level, 7U>{ {
        { "critical", TR_LOG_CRITICAL },
        { "debug", TR_LOG_DEBUG },
        { "error", TR_LOG_ERROR },
        { "info", TR_LOG_INFO },
        { "off", TR_LOG_OFF },
        { "trace", TR_LOG_TRACE },
        { "warn", TR_LOG_WARN },
    } };

    static auto constexpr PreallocationKeys = Lookup<tr_open_files::Preallocation, 5U>{ {
        { "off", tr_open_files::Preallocation::None },
        { "none", tr_open_files::Preallocation::None },
        { "fast", tr_open_files::Preallocation::Sparse },
        { "sparse", tr_open_files::Preallocation::Sparse },
        { "full", tr_open_files::Preallocation::Full },
    } };

    static auto constexpr VerifyModeKeys = Lookup<tr_verify_added_mode, 2U>{ {
        { "fast", TR_VERIFY_ADDED_FAST },
        { "full", TR_VERIFY_ADDED_FULL },
    } };

    static auto constexpr PreferredTransportKeys = Lookup<tr_preferred_transport, TR_NUM_PREFERRED_TRANSPORT>{ {
        { "utp", TR_PREFER_UTP },
        { "tcp", TR_PREFER_TCP },
    } };
};

template<>
std::optional<bool> VariantConverter::load(tr_variant const& src)
{
    if (auto val = src.get_if<bool>(); val != nullptr)
    {
        return *val;
    }

    return {};
}

template<>
tr_variant VariantConverter::save(bool const& val)
{
    return val;
}

// ---

template<>
std::optional<std::chrono::milliseconds> VariantConverter::load(tr_variant const& src)
{
    if (auto val = src.get_if<int64_t>(); val != nullptr)
    {
        return std::chrono::milliseconds(*val);
    }

    return {};
}

template<>
tr_variant VariantConverter::save(std::chrono::milliseconds const& val)
{
    return val.count();
}

// ---

template<>
std::optional<double> VariantConverter::load(tr_variant const& src)
{
    if (auto val = src.get_if<double>(); val != nullptr)
    {
        return *val;
    }

    return {};
}

template<>
tr_variant VariantConverter::save(double const& val)
{
    return val;
}

// ---

template<>
std::optional<tr_encryption_mode> VariantConverter::load(tr_variant const& src)
{
    static constexpr auto Keys = EncryptionKeys;

    if (auto const* val = src.get_if<std::string_view>(); val != nullptr)
    {
        auto const needle = tr_strlower(tr_strv_strip(*val));

        for (auto const& [key, encryption] : Keys)
        {
            if (key == needle)
            {
                return encryption;
            }
        }
    }

    if (auto const* val = src.get_if<int64_t>(); val != nullptr)
    {
        for (auto const& [key, encryption] : Keys)
        {
            if (encryption == *val)
            {
                return encryption;
            }
        }
    }

    return {};
}

template<>
tr_variant VariantConverter::save(tr_encryption_mode const& val)
{
    return static_cast<int64_t>(val);
}

// ---

template<>
std::optional<tr_log_level> VariantConverter::load(tr_variant const& src)
{
    static constexpr auto Keys = LogKeys;

    if (auto const* val = src.get_if<std::string_view>(); val != nullptr)
    {
        auto const needle = tr_strlower(tr_strv_strip(*val));

        for (auto const& [name, log_level] : Keys)
        {
            if (needle == name)
            {
                return log_level;
            }
        }
    }

    if (auto const* val = src.get_if<int64_t>(); val != nullptr)
    {
        for (auto const& [name, log_level] : Keys)
        {
            if (log_level == *val)
            {
                return log_level;
            }
        }
    }

    return {};
}

template<>
tr_variant VariantConverter::save(tr_log_level const& val)
{
    return static_cast<int64_t>(val);
}

// ---

template<>
std::optional<tr_mode_t> VariantConverter::load(tr_variant const& src)
{
    if (auto const* val = src.get_if<std::string_view>(); val != nullptr)
    {
        if (auto const mode = tr_num_parse<uint32_t>(*val, nullptr, 8); mode)
        {
            return static_cast<tr_mode_t>(*mode);
        }
    }

    if (auto const* val = src.get_if<int64_t>(); val != nullptr)
    {
        return static_cast<tr_mode_t>(*val);
    }

    return {};
}

template<>
tr_variant VariantConverter::save(tr_mode_t const& val)
{
    return fmt::format("{:#03o}", val);
}

// ---

template<>
std::optional<tr_port> VariantConverter::load(tr_variant const& src)
{
    if (auto const* val = src.get_if<int64_t>(); val != nullptr)
    {
        return tr_port::from_host(*val);
    }

    return {};
}

template<>
tr_variant VariantConverter::save(tr_port const& val)
{
    return int64_t{ val.host() };
}

// ---

template<>
std::optional<tr_open_files::Preallocation> VariantConverter::load(tr_variant const& src)
{
    static constexpr auto Keys = PreallocationKeys;

    if (auto const* val = src.get_if<std::string_view>(); val != nullptr)
    {
        auto const needle = tr_strlower(tr_strv_strip(*val));

        for (auto const& [name, value] : Keys)
        {
            if (name == needle)
            {
                return value;
            }
        }
    }

    if (auto const* val = src.get_if<int64_t>(); val != nullptr)
    {
        for (auto const& [name, value] : Keys)
        {
            if (value == static_cast<tr_open_files::Preallocation>(*val))
            {
                return value;
            }
        }
    }

    return {};
}

template<>
tr_variant VariantConverter::save(tr_open_files::Preallocation const& val)
{
    return static_cast<int64_t>(val);
}

// ---

template<>
std::optional<tr_preferred_transport> VariantConverter::load(tr_variant const& src)
{
    static constexpr auto Keys = PreferredTransportKeys;

    if (auto const* val = src.get_if<std::string_view>(); val != nullptr)
    {
        auto const needle = tr_strlower(tr_strv_strip(*val));

        for (auto const& [name, value] : Keys)
        {
            if (name == needle)
            {
                return value;
            }
        }
    }

    if (auto const* val = src.get_if<int64_t>(); val != nullptr)
    {
        for (auto const& [name, value] : Keys)
        {
            if (value == *val)
            {
                return value;
            }
        }
    }

    return {};
}

template<>
tr_variant VariantConverter::save(tr_preferred_transport const& val)
{
    for (auto const& [key, value] : PreferredTransportKeys)
    {
        if (value == val)
        {
            return key;
        }
    }

    return static_cast<int64_t>(val);
}

// ---

template<>
std::optional<size_t> VariantConverter::load(tr_variant const& src)
{
    if (auto const* val = src.get_if<int64_t>(); val != nullptr)
    {
        return static_cast<size_t>(*val);
    }

    return {};
}

template<>
tr_variant VariantConverter::save(size_t const& val)
{
    return uint64_t{ val };
}

// ---

template<>
std::optional<std::string> VariantConverter::load(tr_variant const& src)
{
    if (auto const* val = src.get_if<std::string_view>(); val != nullptr)
    {
        return std::string{ *val };
    }

    return {};
}

template<>
tr_variant VariantConverter::save(std::string const& val)
{
    return val;
}

// ---

template<>
std::optional<tr_tos_t> VariantConverter::load(tr_variant const& src)
{
    if (auto const* val = src.get_if<std::string_view>(); val != nullptr)
    {
        return tr_tos_t::from_string(*val);
    }

    if (auto const* val = src.get_if<int64_t>(); val != nullptr)
    {
        return tr_tos_t{ static_cast<int>(*val) };
    }

    return {};
}

template<>
tr_variant VariantConverter::save(tr_tos_t const& val)
{
    return val.toString();
}

// ---

template<>
std::optional<tr_verify_added_mode> VariantConverter::load(tr_variant const& src)
{
    static constexpr auto& Keys = VerifyModeKeys;

    if (auto const* val = src.get_if<std::string_view>(); val != nullptr)
    {
        auto const needle = tr_strlower(tr_strv_strip(*val));

        for (auto const& [name, value] : Keys)
        {
            if (name == needle)
            {
                return value;
            }
        }
    }

    if (auto const* val = src.get_if<int64_t>(); val != nullptr)
    {
        for (auto const& [name, value] : Keys)
        {
            if (value == *val)
            {
                return value;
            }
        }
    }

    return {};
}

template<>
tr_variant VariantConverter::save(tr_verify_added_mode const& val)
{
    for (auto const& [key, value] : VerifyModeKeys)
    {
        if (value == val)
        {
            return key;
        }
    }

    return static_cast<int64_t>(val);
}

struct LoadVisitor
{
    explicit constexpr LoadVisitor(tr_variant const& src)
        : src_{ src }
    {
    }

    template<typename T>
    void operator()(T* const tgt)
    {
        if (auto val = VariantConverter::load<T>(src_))
        {
            *tgt = *val;
        }
    }

private:
    tr_variant const& src_;
};

struct SaveVisitor
{
    constexpr SaveVisitor(tr_variant::Map& tgt, tr_quark key)
        : tgt_{ tgt }
        , key_{ key }
    {
    }

    template<typename T>
    void operator()(T const* const src)
    {
        tgt_.try_emplace(key_, VariantConverter::save(*src));
    }

private:
    tr_variant::Map& tgt_;
    tr_quark key_;
};
} // unnamed namespace

void Settings::load(tr_variant const& src)
{
    auto const* map = src.get_if<tr_variant::Map>();
    if (map == nullptr)
    {
        return;
    }

    for (auto& [key, prop_vptr] : fields())
    {
        if (auto const iter = map->find(key); iter != std::end(*map))
        {
            std::visit(LoadVisitor{ iter->second }, prop_vptr);
        }
    }
}

tr_variant Settings::save() const
{
    auto const fields = const_cast<Settings*>(this)->fields();

    auto map = tr_variant::Map{ std::size(fields) };

    for (auto const& [key, prop_vptr] : fields)
    {
        std::visit(SaveVisitor{ map, key }, prop_vptr);
    }

    return map;
}
} // namespace libtransmission