authenticateduser.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2015 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
 
 
#ifndef SWIFT_MISC_NETWORK_AUTHENTICATEDUSER_H
#define SWIFT_MISC_NETWORK_AUTHENTICATEDUSER_H
 
#include <QJsonObject>
#include <QMetaType>
#include <QString>
#include <QStringList>
 
#include "misc/country.h"
#include "misc/db/datastore.h"
#include "misc/metaclass.h"
#include "misc/network/rolelist.h"
#include "misc/propertyindexref.h"
#include "misc/statusmessagelist.h"
#include "misc/swiftmiscexport.h"
#include "misc/valueobject.h"
 
SWIFT_DECLARE_VALUEOBJECT_MIXINS(swift::misc::network, CAuthenticatedUser)
 
namespace swift::misc::network
{
    class SWIFT_MISC_EXPORT CAuthenticatedUser :
        public CValueObject<CAuthenticatedUser>,
        public swift::misc::db::IDatastoreObjectWithIntegerKey
    {
    public:
        enum ColumnIndex
        {
            IndexEmail = swift::misc::CPropertyIndexRef::GlobalIndexCAuthenticatedUser,
            IndexVatsimId,
            IndexPassword,
            IndexRealName,
            IndexUsername
        };
 
        CAuthenticatedUser();
 
        CAuthenticatedUser(int id, const QString &realname);
 
        CAuthenticatedUser(int id, const QString &realname, const QString &email = "", const QString &password = "");
 
        const QString &getRealName() const { return m_realname; }
 
        QString getRealNameAndId() const;
 
        void setRealName(const QString &realname);
 
        const QString &getUsername() const { return m_username; }
 
        void setUsername(const QString &username);
 
        const QString &getPassword() const { return m_password; }
 
        void setPassword(const QString &pw) { m_password = pw.trimmed(); }
 
        bool isValid() const { return !m_realname.isEmpty() && this->hasValidDbKey(); }
 
        bool hasValidCredentials() const { return this->isValid() && !m_password.isEmpty(); }
 
        bool hasValidRealName() const { return !m_realname.isEmpty(); }
 
        swift::misc::CStatusMessageList validate() const;
 
        const QString &getEmail() const { return m_email; }
 
        void setEmail(const QString &email) { m_email = email.trimmed(); }
 
        bool hasValidEmail() const { return !m_email.isEmpty(); }
 
        int getVatsimId() const { return m_vatsimId; }
 
        void setVatsimId(int id) { m_vatsimId = id; }
 
        const CRoleList &getRoles() const { return m_roles; }
 
        QString getRolesAsString() const { return m_roles.namesAsString(); }
 
        void setRoles(const CRoleList &roles) { m_roles = roles; }
 
        bool hasRole(const QString &roleName) const { return m_roles.hasRole(roleName); }
 
        bool hasAnyRole(const QStringList &roles) const { return m_roles.hasAnyRole(roles); }
 
        const swift::misc::CCountry &getCountry() const { return m_country; }
 
        void setCountry(const swift::misc::CCountry &country) { m_country = country; }
 
        bool hasAdminRole() const;
 
        bool hasMappingAdminRole() const;
 
        bool hasBulkRole() const;
 
        bool hasBulkAddRole() const;
 
        void setAuthenticated(bool authenticated) { m_authenticated = authenticated; }
 
        bool isAuthenticated() const;
 
        void setEnabled(bool enabled) { m_enabled = enabled; }
 
        bool isEnabled() const { return m_enabled; }
 
        bool canDirectlyWriteModels() const;
 
        swift::misc::CIcons::IconIndex toIcon() const;
 
        QVariant propertyByIndex(swift::misc::CPropertyIndexRef index) const;
 
        void setPropertyByIndex(swift::misc::CPropertyIndexRef index, const QVariant &variant);
 
        QString convertToQString(bool i18n = false) const;
 
        static CAuthenticatedUser fromDatabaseJson(const QJsonObject &json);
 
    private:
        int m_vatsimId = -1;
        QString m_realname;
        QString m_username;
        QString m_email;
        QString m_password;
        swift::misc::CCountry m_country;
        bool m_enabled = false;
        bool m_authenticated = false;
        CRoleList m_roles;
 
        SWIFT_METACLASS(
            CAuthenticatedUser,
            SWIFT_METAMEMBER(dbKey),
            SWIFT_METAMEMBER(vatsimId),
            SWIFT_METAMEMBER(realname),
            SWIFT_METAMEMBER(username),
            SWIFT_METAMEMBER(email),
            SWIFT_METAMEMBER(password),
            SWIFT_METAMEMBER(country),
            SWIFT_METAMEMBER(enabled),
            SWIFT_METAMEMBER(authenticated),
            SWIFT_METAMEMBER(roles));
    };
} // namespace swift::misc::network
 
Q_DECLARE_METATYPE(swift::misc::network::CAuthenticatedUser)
 
#endif // SWIFT_MISC_NETWORK_AUTHENTICATEDUSER_H