ms_security_user.hpp

/*
##############################################################################
# file: ms_security_user.hpp                                                 #
# 'msparser' toolkit                                                         #
# Encapsulates a mascot user as used in authentication                       #
##############################################################################
# COPYRIGHT NOTICE                                                           #
# Copyright 1998-2004 Matrix Science Limited  All Rights Reserved.           #
#                                                                            #
##############################################################################
#    $Archive:: /MowseBranches/ms_mascotresfile_1.2/include/ms_mascotresfi $ #
#     $Author: villek@matrixscience.com $ #
#       $Date: 2018-07-30 16:23:53 +0100 $ #
#   $Revision: 1b450440f9c97e1e41d0fc6016a27d68951d4532 | MSPARSER_REL_2_8_1-0-gea32989045 $ #
# $NoKeywords::                                                            $ #
##############################################################################
*/



#if !defined(ms_security_user_INCLUDED_)
#define ms_security_user_INCLUDED_


// Includes from the standard template library
#include <string>
#include <set>
#include <vector>
#include <map>
#include <time.h>


namespace matrix_science {


    class MS_MASCOTRESFILE_API ms_user
    {

    public:

        enum usertype
        {
            USER_SECURITY_DISABLED  = 0x0000, 
            USER_NORMAL             = 0x0001, 
            USER_INTEGRA            = 0x0002, 
            USER_COMPUTER_NAME      = 0x0003, 
            USER_IP_ADDRESS         = 0x0004, 
            USER_AGENT_STRING       = 0x0005, 
            USER_WEBAUTH            = 0x0006  
        };


        enum systemids
        {
            USERID_SECURITY_DISABLED= 0x0000, 
            USERID_GUEST            = 0x0001, 
            USERID_ADMINISTRATOR    = 0x0002, 
            USERID_CMDLINE          = 0x0003, 
            USERID_DAEMON           = 0x0004, 
            USERID_PUBLIC_SEARCHES  = 0x0005, 
            USERID_INTEGRA_SYSTEM   = 0x0006, 
            USERID_LAST             = 0x0007  
        };
        
        ms_user(const int         userID,
                const std::string userName,
                const std::string password,
                const long        passwordExpiry,
                const std::string fullName,
                const std::string emailAddress,
                const usertype    userType,
                const bool        enabled);

        ms_user();

        // Copying constructor for c++ programs - don't document
        ms_user(const ms_user &src);

#ifndef SWIG
        // Assignment operator for c++ programs - don't document
        ms_user & operator=(const ms_user & right);
#endif
        ~ms_user();

        usertype  getUserType() const;

        void setUserType(usertype newVal);

        std::string getFullName() const;

        void setFullName(std::string newVal);

        std::string getEncryptedPassword() const;

        void setEncryptedPassword(std::string newVal);

        void setPassword(std::string barePassword);

        bool validatePassword(const std::string pwd, int & errorFlag) const;

        time_t getPasswordExpiry() const;

        void setPasswordExpiry(time_t newVal);

        int getID() const;

        void setID(int newVal);

        std::string getName() const;

        void setName(std::string newVal);

        bool isAccountEnabled() const;

        void setAccountEnabled(bool newVal);

        std::string getEmailAddress() const;

        void setEmailAddress(std::string newVal);

        bool hasPasswordExpired() const;

        bool saveStringParam(const std::string name, const std::string param);

#ifndef SWIG

        bool getStringParam(const std::string name, std::string & param) const;
#endif

        std::string getStringParam(const std::string name) const;

        bool clearParam(const std::string name);

#ifndef SWIG
#ifndef DOXYGEN_SHOULD_SKIP_THIS
        typedef std::map<std::string, std::string> customParams_t;
        customParams_t getAllCustomParams() const { return params_; }
#endif
#endif

    private:
        int userID_;
        std::string userName_;
        std::string fullName_;
        std::string encryptedPassword_;
        time_t  passwordExpiry_;
        std::string emailAddress_;
        bool accountEnabled_;
        usertype userType_;
        customParams_t params_;

        void copyFrom(const ms_user * src);
    }; // end of security_group 
}
#endif // !defined(ms_security_user_INCLUDED_)