ms_mod_visibility_helper.hpp

/*
##############################################################################
# File: ms_mod_visibility_helper.hpp                                         #
# Mascot Parser toolkit                                                      #
# Utility classes for managing modification visibility                       #
##############################################################################
# COPYRIGHT NOTICE                                                           #
# Copyright 1998-2014 Matrix Science Limited  All Rights Reserved.           #
#                                                                            #
##############################################################################
#    $Source: parser/inc/ms_mod_visibility_helper.hpp $
#    $Author: francoisr@matrixscience.com $ 
#      $Date: 2019-03-15 14:15:26 +0000 $ 
#  $Revision:   
##############################################################################
*/
 
#ifndef _MS_SPECIFICITY_VISIBILITY_H
#define _MS_SPECIFICITY_VISIBILITY_H
 
 
#include <string>
#include <vector>
 
namespace matrix_science {
 
    class ms_umod_specificity;
    class ms_umod_configfile;
    class ms_modfile;
 
    // \cond INTERNAL
 
    class MS_MASCOTRESFILE_API ms_spec_visibility 
    {
    public:
        ms_spec_visibility();
 
        ms_spec_visibility(std::string site);
        ms_spec_visibility(std::string site, std::string position);
        ~ms_spec_visibility();
 
        std::string getSite();
        void setSite(std::string s);
        std::string getPosition();
        void setPosition(std::string s);
 
        bool isHidden();
        void setHidden(bool bHide);
 
        bool inShortList() const;
        void showInShortList(bool b);
        bool inLongList() const;
        void showInLongList(bool b);
        bool inErrorTolerant() const;
        void useInErrorTolerant(bool b);
 
        bool isOveridden();
        void setOveridden(bool b);
 
    private:
        void initialise();
 
        std::string m_site;
        std::string m_position;
        bool        m_show_in_short_list;
        bool        m_show_in_long_list;
        bool        m_use_in_error_tolerant;
        bool        m_overridden;
    }; // class ms_spec_visibility
    // \endcond
 
 
    // \cond INTERNAL
 
    class MS_MASCOTRESFILE_API ms_mod_visibility
    {
    public:
        ms_mod_visibility();
 
        ~ms_mod_visibility();
 
        std::string getName();
        void setName(std::string s);
 
        void setNumberOfSpecs(int spec_count);
        int getNumberOfSpecs();
        void getDefaults(int spec_number, const ms_umod_specificity *spec);
        void setDefaults(int spec_number, const char site, bool hidden);
        void setDefaults(int spec_number, const char site, std::string position, bool hidden);
 
 
        void applyVisibilities( ms_umod_specificity *spec);
        bool updateVisibilities( const ms_umod_specificity *spec);
        bool updateIsPrivate(bool is_private);
 
        bool isPrivate() const;
        void setPrivate(bool b);
 
        bool isPrivacyEnabled() const;
        void setPrivacyEnabled(bool b);
 
        bool hasOverrides();
        bool isOveridden();
        void setOveridden(bool b);
 
        bool isDeleted();
        void setDeleted(bool b);
 
        ms_spec_visibility &getSpecVisibility(int index);
        ms_spec_visibility &getSpecVisibility(std::string site, bool bCreate);
        ms_spec_visibility &getSpecVisibility(std::string site, std::string position, bool bCreate);
 
    private:
 
        typedef std::vector< ms_spec_visibility> spec_vis_vector;
        spec_vis_vector     m_specs;
 
        std::string         m_name;
        ms_spec_visibility  m_default_spec;
 
        bool                m_isPrivacyEnabled;
        bool                m_isPrivate;
        bool                m_overridden;
        bool                m_deleted;
    }; // class ms_mod_visibility
    // \endcond
 
    // \cond INTERNAL
 
    class MS_MASCOTRESFILE_API ms_mod_visibility_helper : public ms_errors
    {
    public:
        ms_mod_visibility_helper();
 
        ms_mod_visibility_helper(const matrix_science::ms_session *session, const std::string &visibility_filename, ms_umod_configfile *config);
        ms_mod_visibility_helper(const std::vector<int> & groupIds, const std::string &visibility_filename, ms_umod_configfile *config);
        ms_mod_visibility_helper(const matrix_science::ms_session *session, const std::string &visibility_filename, ms_modfile *modfile);
        ms_mod_visibility_helper(const std::string &visibility_full_filename);
        ~ms_mod_visibility_helper();
 
        bool hasPrivacy();
 
        bool saveToGroupFiles(const matrix_science::ms_session *session, const std::string &visibility_filename, const bool saveAllForCrosslinking = false);
        bool saveToFile(const std::string &filename, const bool saveAllForCrosslinking = false);
 
        ms_mod_visibility *getModVisibility(int index);
        ms_mod_visibility *getModVisibility(const std::string &mod_title, bool bCreate);
        void removeModVisibilty(const std::string &mod_title);
 
        void setVisibilities(matrix_science::ms_umod_configfile *config);
        void setVisibilities(matrix_science::ms_modfile *modfile);
 
        static void getUserGroupVisibilty(
            matrix_science::ms_session *session, const std::string &mod_title, std::string &visibility_filename,
            std::vector<std::string> &excluded_usergroups, std::vector<std::string> &included_usergroups);
        static void setUserGroupVisibilty(
            matrix_science::ms_session *session, const std::string &mod_title, std::string &visibility_filename,
            std::vector<std::string> &excluded_usergroups, std::vector<std::string> &included_usergroups);
 
        static void getDefaultUserGroups(
            matrix_science::ms_session *session,
            std::vector<std::string> &excluded_usergroups, std::vector<std::string> &included_usergroups);
 
    private:
        //Do not copy this object
        ms_mod_visibility_helper(const ms_mod_visibility_helper & src);
        ms_mod_visibility_helper& operator=(const ms_mod_visibility_helper & right);
 
        // Setup m_show_in_long_list defaults for config specifity "hidden" attributes.
        void getDefaults(ms_umod_configfile *config);
        void getDefaults(ms_modfile *modfile);
        bool getUserGroupFileNames(const matrix_science::ms_session *session, const std::string &visibility_filename, bool bAllGroups, const std::vector<int> * groupIds = NULL);
 
        bool loadFromFile(const std::string &filename);
        void loadVisibility(const matrix_science::ms_session *session, const std::string &visibility_filename, const std::vector<int> * groupIds = NULL);
 
        void clearOverrideFlags();
        
        bool getSpecSitesFromModString(std::string modfile_spec_name, std::string &sites, std::string &position);
 
        typedef std::vector< ms_mod_visibility> mod_vis_vector;
        mod_vis_vector      m_mods;
 
        ms_mod_visibility   m_default_mod;
 
        std::vector<std::string> m_userGroupVisibilityFiles;
        bool            m_inAdminGroup;
        bool            m_hasPrivacy;
    }; // class ms_mod_visibility_helper
    // \endcond
 // end of config_group
 
 
 
} // namespace matrix_science
 
#endif // _MS_SPECIFICITY_VISIBILITY_H
 
/*------------------------------- End of File -------------------------------*/