UserProfile.hpp

Go to the documentation of this file.

#ifndef IV_SRC_MODEL_DIAMAR_USERPROFILE_HPP_
#define IV_SRC_MODEL_DIAMAR_USERPROFILE_HPP_
 
#include "channels/enums.hpp"
#include "core/MonotonicTimer.hpp"
#include "core/types.hpp"
#include "diamar/enums.hpp"
#include "model/enums.hpp"
#include "model/structs.hpp"
 
#include <memory>
 
namespace iv::diamar
{
 
class UserProfile final
{
public:
    static iv::diamar::eUserProfileType getProfileUserInArea(iv::model::eShipArea area);
    static iv::diamar::eUserProfileType getProfileUserInAreaWithAccess(iv::model::eShipArea area);
 
    struct PasswordProperties
    {
        bool mustBeChanged {true};
        iv::types::timestamp lastUpdated {0};
    };
 
    struct LoginAttemptsProperties
    {
        iv::core::MonotonicTimer blockTimer;
        uint32_t unsuccessfulLoginAttempts {0};
    };
 
    UserProfile();
    explicit UserProfile(const iv::diamar::eUserProfileType &type, const bool &enabled = false);
    UserProfile(const UserProfile &userProfile);
    UserProfile(UserProfile &&other) noexcept = delete;
    ~UserProfile();
 
    UserProfile &operator=(const UserProfile &other) = delete;
    UserProfile &operator=(UserProfile &&other) noexcept = delete;
 
    bool load(const iv::file::xml::node &nodeProfile);
    bool save(iv::file::xml::node &nodeProfile) const;
    void update(const UserProfile &other);
 
    void blockUser() const;
 
    void unBlockUser() const;
 
    [[nodiscard]] iv::diamar::eUserProfileType getType() const;
    [[nodiscard]] std::string getPassword() const;
    [[nodiscard]] std::string getDecipheredPassword() const;
    [[nodiscard]] iv::types::milliseconds getMaxTimeInProfile() const;
 
    [[nodiscard]] uint32_t getRemainingLoginAttempts() const;
 
    void getRemainingBlockTime(uint32_t &hoursLeft, uint32_t &minutesLeft, uint32_t &secondsLeft) const;
 
    [[nodiscard]] std::string getRemainingBlockTimeStr() const;
    [[nodiscard]] std::string getTypeStr() const;
    [[nodiscard]] std::string getIconUser() const;
 
    void setActive(bool isActive);
    void setPassword(const std::string &newPassword, bool mustBeChanged);
 
    [[nodiscard]] bool canPermitAlarmAck() const;
 
    [[nodiscard]] bool canChangePassword(std::string *reasonMsg) const;
 
    [[nodiscard]] bool hasPermissionAccessControl(iv::model::eShipArea areaStationAlarm) const;
    [[nodiscard]] bool hasPermissionAck(iv::model::eShipArea areaShip) const;
    [[nodiscard]] bool hasPermissionChangeParameters(iv::model::eShipArea areaShip,
                                                     iv::channels::eChannelArea areaStationAlarm) const;
 
    [[nodiscard]] bool hasPermissionChangeVariablesOnline(iv::model::eShipArea areaShip) const;
    [[nodiscard]] bool isEnabled() const;
    [[nodiscard]] bool isRoot() const;
    [[nodiscard]] bool isPasswordCorrect(const std::string &password) const;
    [[nodiscard]] bool mustChangePassword() const;
    [[nodiscard]] bool isPasswordExpired() const;
 
    [[nodiscard]] bool isNotifiedAlarm(iv::model::eShipArea areaShip, uint64_t areaStationAlarm) const;
 
    [[nodiscard]] bool isNotifiedByZoneRepeaters(iv::model::eShipArea areaShip,
                                                 iv::model::eShipArea typeZoneRepeater) const;
 
    [[nodiscard]] bool shouldBeNotifiedForPasswordChange(iv::types::timestamp &remainingTime) const;
 
    void setPasswordAndMaxTime(iv::diamar::eUserProfileType type);
 
    [[nodiscard]] bool isBlocked() const;
 
    void resetFailedLoginAttemptsCounter() const;
    void registerSuccessfulLoginAttempt() const;
    void registerFailedLoginAttempt() const;
    void registerLoginAttemptInBlockedProfile() const;
 
    bool m_enabled;
 
    iv::diamar::eUserProfileType m_type;
    std::string m_password;
    iv::types::milliseconds m_maxTimeInProfile;// In seconds
 
    std::unique_ptr<PasswordProperties> m_passwordProperties;
 
    std::unique_ptr<LoginAttemptsProperties> m_loginAttemptsProperties;
 
private:
    struct DefaultPasswords
    {
        static constexpr std::string EngineAdvancedManagementPassword {"7410"};
        static constexpr std::string DeckAdvancedManagementPassword {"8520"};
        static constexpr std::string EngineManagementPassword {"1234"};
        static constexpr std::string DeckManagementPassword {"1234"};
        static constexpr std::string MonitorPassword {"0000"};
        static constexpr std::string RootPassword {"1234"};
    };
    struct Keys
    {
        static constexpr std::string_view enabled {"Enabled"};
        static constexpr std::string_view type {"Type"};
        static constexpr std::string_view password {"Password"};
        static constexpr std::string_view maxTime {"MaxTime"};
        static constexpr std::string_view passwordMustBeChanged = "PasswordMustBeChanged";
        static constexpr std::string_view passwordLastUpdated = "PasswordLastUpdated";
    };
    struct DefaultValues
    {
        static constexpr std::string string {};
        static constexpr std::string_view userProfileType {"EngineManagement"};
    };
};
 
}// namespace iv::diamar
 
#endif//IV_SRC_MODEL_DIAMAR_USERPROFILE_HPP_