PrivacySettings.h#

// Copyright (c) 2021-2025, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once

#include "../../carb/InterfaceUtils.h"
#include "../../carb/settings/ISettings.h"
#include "../../carb/settings/SettingsUtils.h"
#include "../../carb/extras/StringSafe.h"

namespace omni
{
namespace extras
{

enum class ConsentLevel
{
    ePerformance,

    ePersonalization,

    eUsage,

    eCount,
};

class PrivacySettings
{
public:
    static constexpr char kVersionKey[] = "/privacy/version";

    static constexpr char kPerformanceKey[] = "/privacy/performance";

    static constexpr char kPersonalizationKey[] = "/privacy/personalization";

    static constexpr char kUsageKey[] = "/privacy/usage";

    static constexpr char kUserIdKey[] = "/privacy/userId";

    static constexpr char kEmailKey[] = "/privacy/email";

    static constexpr char kExternalBuildKey[] = "/privacy/externalBuild";

    static constexpr char kExtraDiagnosticDataOptInKey[] = "/privacy/extraDiagnosticDataOptIn";

    static constexpr char kIdpNameKey[] = "/privacy/idpName";

    static constexpr char kIdpIdKey[] = "/privacy/idpId";

    static constexpr char kSettingTree[] = "/privacy";
    CARB_DEPRECATED("Not thread safe. Use getVersionString() instead.")
    static const char* getVersion()
    {
        return _getSettingStringValue(kVersionKey, "1.0");
    }

    static std::string getVersionString()
    {
        return _getSettingString(kVersionKey, "1.0");
    }

    CARB_DEPRECATED("Not thread safe. Use getUserIdString() instead.")
    static const char* getUserId()
    {
        return _getSettingStringValue(kUserIdKey, "");
    }

    static std::string getUserIdString()
    {
        return _getSettingString(kUserIdKey, "");
    }

    CARB_DEPRECATED("Not thread safe. Use getEmailString() instead.")
    static const char* getEmail()
    {
        return _getSettingStringValue(kEmailKey, "");
    }

    static std::string getEmailString()
    {
        return _getSettingString(kEmailKey, "");
    }

    CARB_DEPRECATED("Not thread safe. Use getIdpNameString() instead.")
    static const char* getIdpName()
    {
        return _getSettingStringValue(kIdpNameKey, "");
    }

    static std::string getIdpNameString()
    {
        return _getSettingString(kIdpNameKey, "");
    }

    CARB_DEPRECATED("Not thread safe. Use getIdpIdString() instead.")
    static const char* getIdpId()
    {
        return _getSettingStringValue(kIdpIdKey, "");
    }

    static std::string getIdpIdString()
    {
        return _getSettingString(kIdpIdKey, "");
    }

    static bool getConsentLevel(ConsentLevel level)
    {
        static const char* map[] = { kPerformanceKey, kPersonalizationKey, kUsageKey };

        if (((size_t)level) >= ((size_t)ConsentLevel::eCount))
            return false;

        return _getSettingBoolValue(map[(size_t)level], false);
    }

    static bool canSendExtraDiagnosticData()
    {
        std::string optIn = _getSettingString(kExtraDiagnosticDataOptInKey, "");

        return carb::extras::compareStringsNoCase(optIn.c_str(), "externalBuilds") == 0;
    }

private:
    static carb::settings::ISettings* _getSettingsInterface()
    {
        return carb::getCachedInterface<carb::settings::ISettings>();
    }

    static const char* _getSettingStringValue(const char* name, const char* defaultValue)
    {
        carb::settings::ISettings* settings = _getSettingsInterface();
        const char* value;

        if (settings == nullptr || name == nullptr)
            return defaultValue;

        value = settings->getStringBuffer(name);

        if (value == nullptr)
            return defaultValue;

        return value;
    }

    static std::string _getSettingString(const char* name, const char* defaultValue)
    {
        carb::settings::ISettings* settings = _getSettingsInterface();

        if (settings == nullptr || name == nullptr)
            return defaultValue;

        return carb::settings::getString(settings, name, defaultValue);
    }

    static bool _getSettingBoolValue(const char* name, bool defaultValue)
    {
        carb::settings::ISettings* settings = _getSettingsInterface();

        if (settings == nullptr || !settings->isAccessibleAs(carb::dictionary::ItemType::eBool, name))
            return defaultValue;

        return settings->getAsBool(name);
    }
};

} // namespace extras
} // namespace omni