authenticationuser.h

/*
 * SPDX-FileCopyrightText: (C) 2013-2022 Daniel Nicoletti <dantti12@gmail.com>
 * SPDX-License-Identifier: BSD-3-Clause
 */
#ifndef AUTHENTICATIONUSER_H
#define AUTHENTICATIONUSER_H

#include <Cutelyst/Plugins/authentication_export.h>
#include <Cutelyst/paramsmultimap.h>
#include <Cutelyst/plugin.h>

#include <QDataStream>
#include <QVariantMap>

namespace Cutelyst {

class AuthenticationRealm;
class Context;

class CUTELYST_PLUGIN_AUTHENTICATION_EXPORT AuthenticationUser
{
    Q_GADGET
public:
    AuthenticationUser();

    explicit AuthenticationUser(const QVariant &id);

    virtual ~AuthenticationUser();

    [[nodiscard]] QVariant id() const;

    void setId(const QVariant &id);

    [[nodiscard]] bool isNull() const;

    [[nodiscard]] QString authRealm();

    void setAuthRealm(const QString &authRealm);

    [[nodiscard]] bool checkPassword(Context *c,
                                     AuthenticationRealm *realm,
                                     const QString &password,
                                     const QString &passwordField = QStringLiteral("password"));

    [[nodiscard]] inline QVariantMap data() const;

    inline void setData(const QVariantMap &data);

    inline void insert(const QString &key, const QVariant &value);

    [[nodiscard]] inline QVariant value(const QString &key,
                                        const QVariant &defaultValue = QVariant()) const;

    operator QVariant() const { return QVariant::fromValue(m_data); }

protected:
    QVariantMap m_data;
};

QVariantMap AuthenticationUser::data() const
{
    return m_data;
}

void AuthenticationUser::setData(const QVariantMap &data)
{
    m_data = data;
}

void AuthenticationUser::insert(const QString &key, const QVariant &value)
{
    m_data.insert(key, value);
}

QVariant AuthenticationUser::value(const QString &key, const QVariant &defaultValue) const
{
    return m_data.value(key, defaultValue);
}

} // namespace Cutelyst

Q_DECLARE_METATYPE(Cutelyst::AuthenticationUser)
QDataStream &operator<<(QDataStream &out, const Cutelyst::AuthenticationUser &myObj);
QDataStream &operator>>(QDataStream &in, Cutelyst::AuthenticationUser &myObj);

QDebug CUTELYST_PLUGIN_AUTHENTICATION_EXPORT operator<<(QDebug dbg,
                                                        const Cutelyst::AuthenticationUser &user);

#endif // AUTHENTICATIONUSER_H