ms_http_client_session.hpp

/*
##############################################################################
# file: ms_http_client_session.hpp                                                #
# 'msparser' toolkit                                                         #
# Represents a session on a Mascot server                                    #
##############################################################################
# COPYRIGHT NOTICE                                                           #
# Copyright 1998-2013 Matrix Science Limited  All Rights Reserved.           #
#                                                                            #
##############################################################################
 * @(#)$Source: parser/inc/ms_http_client_session.hpp $
 * @(#)$Revision: ad538b116c843eb04f4e6cb8ff8f73b915de025f | MSPARSER_REL_2_8_1-0-gea32989045 $
 * @(#)$Date: 2020-02-14 10:16:25 +0000 $
##############################################################################
 */

#ifndef MS_HTTP_CLIENT_SESSION_HPP
#define MS_HTTP_CLIENT_SESSION_HPP


#include <string>
#include <vector>

namespace matrix_science
{
    class ms_http_client;
    class ms_http_client_search;


    class MS_MASCOTRESFILE_API ms_http_client_session :
        public ms_errors
    {
    public:

        enum SequenceShowOptions
        {
            SHOW_PI = 0x0001, 
            SHOW_TITLE = 0x0002, 
            SHOW_LENGTH = 0x0004, 
            SHOW_SEQUENCE = 0x0008, 
            SHOW_REFERENCE = 0x0010, 

            SHOW_NONE = 0, 
            SHOW_ALL = 0xFFFF 
        };


        ms_http_client_session();

        ms_http_client_session(const ms_http_helper connection, const std::string sessionId);

        virtual ~ms_http_client_session();

        ms_http_client_session(const ms_http_client_session & src);
#ifndef SWIG
        ms_http_client_session& operator=(const ms_http_client_session & right);
#endif
        void copyFrom(const ms_http_client_session * right);

        std::string getSessionID() const;
        std::string sessionId() const { return getSessionID(); }   // Deprecated. Released with 2.5.2
#ifndef SWIG

        bool getIsPermitted(ms_security_tasks::TASKID taskType, bool & returnIsPermitted);
#else // SWIG Multiple return values
        bool getIsPermitted(ms_security_tasks::TASKID taskType, bool & OUTPUT);
#endif

#ifndef SWIGCSHARP

        bool submitSearch(
            ms_http_client_search & returnTask,
            const std::string & httpHeader,
            const std::string & prologue,
            const std::string & filename,
            const std::string & epilogue,
            ms_http_helper_progress & progress,
            bool batch = false);
#else
        bool submitSearch(
            ms_http_client_search & returnTask,
            const std::wstring & httpHeader,
            const std::wstring & prologue,
            const std::wstring & filename,
            const std::wstring & epilogue,
            ms_http_helper_progress & progress,
            bool batch = false) {
                return submitSearchWide(returnTask, httpHeader, prologue, filename, epilogue, progress, batch);
            };
#endif

            bool getSequenceFile(
                    const std::string & database,
                    const std::vector<std::string> & accessionNames,
                    const std::vector<int> & accessionFrames,
                    const std::string & filename,
                    const SequenceShowOptions options = SHOW_ALL
                    );

            bool logout();

            bool getIsXmlUploadedList(const std::vector<std::string> & taskIds, std::vector<int> & xmlUploaded);

        private:

            // type of login for the session to allow re-login if session has expired
            enum SessionSecurityType {
                SECURITY_NONE,
                SECURITY_DISABLED,
                SECURITY_GUEST,
                SECURITY_WEB,
                SECURITY_USER
            };

            ms_http_client_session(
                    ms_http_helper connection,
                    std::string sessionId,
                    SessionSecurityType security,
                    const std::string & username = "",
                    const std::string & password = "");

            // Create a new Mascot task attached to this Mascot session.
            bool createTask(
                    ms_http_client_search & returnTask);

            // http functions to be used by the task class to re-try is Mascot session has expired
            bool httpGetString(const std::string & action, std::string & result);
            bool httpGetResponseUsingSessionId(const std::string & action, ms_http_helper_response & response);
            bool httpGetFileUsingSessionId(
                    const std::string & action,
                    const std::string & filename,
                    ms_http_helper_progress & progress,
                    ms_http_helper::FileMode fileMode = ms_http_helper::FM_binary);
            bool httpPostFileAppendingSessionId(
                    const std::string & action,
                    const std::string & httpHeader,
                    const std::string & prologue,
                    const std::string & filename,
                    const std::string & epilogue,
                    ms_http_helper_handles & handles,
                    ms_http_helper_progress & progress);
            bool relogin();

            bool submitSearchWide(
                ms_http_client_search & returnTask,
                const std::wstring & httpHeader,
                const std::wstring & prologue,
                const std::wstring & filename,
                const std::wstring & epilogue,
                ms_http_helper_progress & progress,
                bool batch = false
            );

            ms_http_helper connection_;
            std::string sessionId_;

            SessionSecurityType security_;
            std::string username_;
            std::string password_;

            bool isLoggedIn_;

        friend class ms_http_client; // access to private constructor used when logging in
        friend class ms_http_client_search; // access to useful getString and getFile functions
    };
 // end of http_client_group
} // namespace matrix_science

#endif // MS_HTTP_CLIENT_SESSION_HPP

/*------------------------------- End of File -------------------------------*/