system_flags.hpp

/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
 *
 * Copyright (C) 2025 Marco Craveiro <marco.craveiro@gmail.com>
 *
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free Software
 * Foundation; either version 3 of the License, or (at your option) any later
 * version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc., 51
 * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 */
#ifndef ORES_VARIABILITY_DOMAIN_SYSTEM_FLAGS_HPP
#define ORES_VARIABILITY_DOMAIN_SYSTEM_FLAGS_HPP
 
#include <array>
#include <string>
#include <ostream>
#include <optional>
#include <stdexcept>
#include <string_view>
#include <magic_enum/magic_enum.hpp>
 
namespace ores::variability::domain {
 
enum class system_flag {
    bootstrap_mode,
 
    user_signups,
 
    signup_requires_authorization,
 
    disable_password_validation
};
 
struct system_flag_definition {
    system_flag flag;
    bool default_enabled;
    std::string_view description;
};
 
inline constexpr std::array system_flag_definitions = {
    system_flag_definition {
        .flag = system_flag::bootstrap_mode,
        .default_enabled = true,
        .description = "Indicates whether the system is in bootstrap mode "
        "(waiting for initial admin account)."
    },
    system_flag_definition {
        .flag = system_flag::user_signups,
        .default_enabled = false,
        .description = "Controls whether user self-registration is allowed."
    },
    system_flag_definition {
        .flag = system_flag::signup_requires_authorization,
        .default_enabled = false,
        .description = "Controls whether new signups require admin authorization. "
        "NOT YET IMPLEMENTED - enabling will cause signup to fail."
    },
    system_flag_definition {
        .flag = system_flag::disable_password_validation,
        .default_enabled = false,
        .description = "When enabled, disables strict password validation. "
        "FOR TESTING/DEVELOPMENT ONLY."
    }
};
 
[[nodiscard]] inline std::string to_flag_name(system_flag flag) {
    return std::string("system.") + std::string(magic_enum::enum_name(flag));
}
 
[[nodiscard]] inline std::optional<system_flag> from_flag_name(std::string_view name) {
    constexpr std::string_view prefix = "system.";
    if (!name.starts_with(prefix)) {
        return std::nullopt;
    }
 
    auto enum_name = name.substr(prefix.size());
    return magic_enum::enum_cast<system_flag>(enum_name);
}
 
[[nodiscard]] inline const system_flag_definition&
get_definition(system_flag flag) {
    for (const auto& def : system_flag_definitions) {
        if (def.flag == flag)
            return def;
    }
    // This should never happen for valid enum values.
    throw std::logic_error("Definition for system_flag not found.");
}
 
inline std::ostream& operator<<(std::ostream& os, system_flag flag) {
    return os << to_flag_name(flag);
}
 
}
 
#endif