user.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2013 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
 
 
#ifndef SWIFT_MISC_NETWORK_USER_H
#define SWIFT_MISC_NETWORK_USER_H
 
#include <QMetaType>
#include <QString>
 
#include "misc/aviation/airporticaocode.h"
#include "misc/aviation/callsign.h"
#include "misc/metaclass.h"
#include "misc/propertyindexref.h"
#include "misc/statusmessagelist.h"
#include "misc/swiftmiscexport.h"
#include "misc/valueobject.h"
 
SWIFT_DECLARE_VALUEOBJECT_MIXINS(swift::misc::network, CUser)
 
namespace swift::misc::network
{
    class SWIFT_MISC_EXPORT CUser : public CValueObject<CUser>
    {
    public:
        enum ColumnIndex
        {
            IndexEmail = CPropertyIndexRef::GlobalIndexCUser,
            IndexId,
            IndexIdInteger,
            IndexId7Digit,
            IndexPassword,
            IndexRealName,
            IndexCallsign,
            IndexHomebase
        };
 
        CUser() = default;
 
        CUser(const aviation::CCallsign &callsign);
 
        CUser(const QString &id, const QString &realname, const aviation::CCallsign &callsign);
 
        CUser(const QString &id, const QString &realname, const QString &email = "", const QString &password = "",
              const aviation::CCallsign &callsign = {});
 
        const QString &getRealName() const { return m_realname; }
 
        void setRealName(const QString &realname);
 
        const QString &getPassword() const { return m_password; }
 
        void setPassword(const QString &pw);
 
        bool isValid() const { return !isNull(); }
 
        bool isNull() const { return m_realname.isEmpty() && m_id.isEmpty(); }
 
        bool hasCredentials() const { return this->isValid() && !m_password.isEmpty(); }
 
        bool hasRealName() const { return !m_realname.isEmpty(); }
 
        bool hasId() const { return !m_id.isEmpty(); }
 
        bool hasValidVatsimId() const { return CUser::isValidVatsimId(this->getId()); }
 
        bool hasCallsign() const { return !m_callsign.isEmpty(); }
 
        bool hasHomeBase() const { return !m_homebase.isEmpty(); }
 
        bool hasValidHomeBase() const;
 
        bool hasValidOrEmptyHomeBase() const;
 
        QString getRealNameAndHomeBase(const QString &separator = QString(" ")) const;
 
        QString getRealNameAndId() const;
 
        CStatusMessageList validate() const;
 
        const QString &getEmail() const { return m_email; }
 
        void setEmail(const QString &email);
 
        bool hasValidEmail() const { return !m_email.isEmpty(); }
 
        const QString &getId() const { return m_id; }
 
        QString get7DigitId() const;
 
        int getIntegerId() const;
 
        bool hasNumericId() const;
 
        void setId(const QString &id);
 
        const aviation::CAirportIcaoCode &getHomeBase() const { return m_homebase; }
 
        void setHomeBase(const aviation::CAirportIcaoCode &homebase) { m_homebase = homebase; }
 
        const aviation::CCallsign &getCallsign() const { return m_callsign; }
 
        bool setCallsign(const aviation::CCallsign &callsign);
 
        CIcons::IconIndex toIcon() const { return this->getCallsign().toIcon(); }
 
        QVariant propertyByIndex(CPropertyIndexRef index) const;
 
        void setPropertyByIndex(CPropertyIndexRef index, const QVariant &variant);
 
        int comparePropertyByIndex(CPropertyIndexRef index, const CUser &compareValue) const;
 
        void synchronizeData(CUser &otherUser);
 
        void updateMissingParts(const CUser &otherUser);
 
        static bool isValidVatsimId(const QString &id);
 
        static QString beautifyRealName(const QString &realName);
 
        QString convertToQString(bool i18n = false) const;
 
    private:
        void deriveHomeBaseFromCallsign();
 
        QString m_id;
        QString m_realname;
        QString m_email;
        QString m_password;
        aviation::CCallsign m_callsign;
        aviation::CAirportIcaoCode m_homebase;
 
        SWIFT_METACLASS(
            CUser,
            SWIFT_METAMEMBER(id),
            SWIFT_METAMEMBER(realname),
            SWIFT_METAMEMBER(email),
            SWIFT_METAMEMBER(password),
            SWIFT_METAMEMBER(callsign),
            SWIFT_METAMEMBER(homebase));
    };
} // namespace swift::misc::network
 
Q_DECLARE_METATYPE(swift::misc::network::CUser)
 
#endif // SWIFT_MISC_NETWORK_USER_H