ms_security_tasks.hpp

/*
##############################################################################
# file: ms_security_tasks.hpp                                                #
# 'msparser' toolkit                                                         #
# Encapsulates Mascot security 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: francoisr@matrixscience.com $ #
#       $Date: 2020-01-09 13:44:20 +0000 $ #
#   $Revision: 8f2eed45ceb9f62bfae7c1eaa2c043cac1d9f802 | MSPARSER_REL_2_8_1-0-gea32989045 $ #
# $NoKeywords::                                                            $ #
##############################################################################
*/



#if !defined(ms_security_tasks_INCLUDED_)
#define ms_security_tasks_INCLUDED_


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

namespace matrix_science {



    class MS_MASCOTRESFILE_API ms_security_tasks: public ms_errors
    {
    public:

        enum TASKID
        {
            SECTASK_ALLOWPMF                =  1, 
            SECTASK_ALLOWMSMS               =  2, 
            SECTASK_ALLOWMSMSNOENZYME       =  3, 
            SECTASK_ALLOWPMFNOENZYME        =  4, 
            SECTASK_MAXCONCURRENTSEARCHES   =  5, 
            SECTASK_MAXJOBPRIORITY          =  6, 
            SECTASK_MAXQUERIES              =  7, 
            SECTASK_MAXEXECUTIONTIME        =  8, 
            SECTASK_ALLFASTA                =  9, 
            SECTASK_NAMEDFASTA              = 10, 
            SECTASK_MAXVARMODS              = 11, 
            SECTASK_MAXETVARMODS            = 12, 

            SECTASK_SEESEARCHINGROUP        = 13, 
            SECTASK_SEEALLSEARCHESWITHUSERID= 14, 
            SECTASK_SEEOLDSEARCHES          = 15, 
            SECTASK_USEMSREVIEWEXE          = 16, 

            SECTASK_VIEWCONFIGUSINGMSSTATUS = 17, 
            SECTASK_MODIFYOWNPROFILE        = 18, 

            SECTASK_DAEMONCLIENT            = 19, 
            SECTASK_DISTILLERCLIENT         = 20, 
            SECTASK_ALLOWSPOOFOTHERUSER     = 22, 
            SECTASK_INTEGRASYSTEMACCOUNT    = 23, 
            SECTASK_BIOTOOLSBATCH           = 24, 
            SECTASK_SPOOFNAMEDGROUPSONLY    = 25, 
            SECTASK_DOWNLOAD_DISTILLER_XML  = 26, 
            SECTASK_UPLOAD_DISTILLER_XML    = 27, 

            SECTASK_ADMINPAGES              = 30, 
            SECTASK_ACCESSDBSETUP           = 31, 
            SECTASK_USEMSSTATUSEXE          = 32, 
            SECTASK_MSSTATUSEXECLUSTER      = 33, 
            SECTASK_MSSTATUSEXERETRYDB      = 34, 
            SECTASK_KILLTASKINGROUP         = 35, 
            SECTASK_KILLALLTASK             = 36, 
            SECTASK_VIEWCONFIG              = 37, 
            SECTASK_EDITCONFIG              = 38, 

            SECTASK_MAXETACCESSIONS         = 50, 
            SECTASK_MAXNOENZQUERIES         = 51, 
            SECTASK_MAXFASTAFILES           = 52, 
            SECTASK_DENYQUANT               = 53, 
            SECTASK_DATAURLPROTOCOLS        = 54, 
            SECTASK_DATAURLMAXSIZE          = 55, 

            SECTASK_SEESEARCHINANYGROUP     = 60, 

            MISECTASK_ACCESS                =100, 
            MISECTASK_PROTEINAPPROVAL       =101, 
            MISECTASK_ADDIMPORTFILTER       =102, 
            MISECTASK_ADMIN                 =103, 
            MISECTASK_ADDCUSTOMREPORT       =104, 
            MISECTASK_DELETECUSTOMREPORT    =105, 
            MISECTASK_ADDEXCLUSIONFILE      =106, 
            MISECTASK_DELETEEXCLUSIONFILE   =107, 
            MISECTASK_SENDNOTIFICATION      =108  
        };

        ms_security_tasks();

        ~ms_security_tasks();

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

        ms_security_tasks(const char * filename);

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

        bool loadFromFile(const char * filename);

        bool saveToFile(const char * filename);

        bool addTask(const ms_security_task & task);

        bool removeTask(const int taskID);

        void removeAllTasks();

        bool isPermitted(const int taskID) const;

        bool isPermitted_long(const int taskID, const long value) const;

        bool isPermitted_double(const int taskID, const double value) const;

        bool isPermitted_string(const int taskID, const std::string value) const;

        bool isFastaPermitted(const std::string database) const;

        int getNumberOfTasks() const;

        ms_security_task getTask(const int num) const;

        ms_security_task getTaskFromID(const int taskID) const;

        bool isTaskExists(const int taskID) const;

        bool updateTask(const ms_security_task & task);
#ifndef SWIG
        ms_security_tasks & operator+=(const ms_security_tasks & a);
#endif

        std::string getDiffsAsText(const ms_security_tasks & old);

        // Don't document
        void updateAllUsersTasks(const std::set<int> & allUsers);

    private:
        typedef std::map<int, ms_security_task> tasksSet;
        tasksSet    tasks_;

        void copyFrom(const ms_security_tasks* src);
    }; // end of security_group

}

#endif // !defined(ms_security_tasks_INCLUDED_)