ms_security_group.hpp

/*
##############################################################################
# file: ms_security_group.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_users_group_INCLUDED_)
#define ms_users_group_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_group
    {

    public:

        enum systemids
        {
            GROUPID_GUESTS          = 0x0001,  
            GROUPID_ADMINISTRATORS  = 0x0002,  
            GROUPID_POWERUSERS      = 0x0003,  
            GROUPID_DAEMONS         = 0x0004,  
            GROUPID_INTEGRA_SYSTEM  = 0x0005,  
            GROUPID_LAST            = 0x0006   
        };

        ms_group();

        ms_group(const int groupID, const std::string groupName);

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

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

        bool addUser(const int userID);

        bool deleteUser(const int userID);

        bool isUserInGroup(const int userID) const;

        std::vector<int> getAllUserIDs(const void * const security = NULL, const int voidSortby = 1) const;

        std::string getName() const;

        void setName(const std::string newVal);

        void addPermittedTask(const matrix_science::ms_security_task & task);

        bool removePermittedTask(const int taskID);

        matrix_science::ms_security_tasks getPermittedTasks() const;

        void setPermittedTasks(matrix_science::ms_security_tasks& tasks);

        int  getID() const;

        void setID(int newVal);

        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 groupID_;
        typedef std::set<int> users_t;
        ms_security_tasks tasks_;
        std::string groupName_;
        users_t     users_;
        customParams_t params_;

        void copyFrom(const ms_group * src);
        void updateUsersArrayTasks();
    }; // end of security_group 
}
#endif // !defined(ms_users_group_INCLUDED_)