ms_http_helper.hpp

/*
##############################################################################
# file: ms_http_helper.hpp                                                          #
# 'msparser' toolkit                                                         #
# Provides functions for an HTTP link (eg to a Mascot server)                #
##############################################################################
# COPYRIGHT NOTICE                                                           #
# Copyright 1998-2013 Matrix Science Limited  All Rights Reserved.           #
#                                                                            #
##############################################################################
 * @(#)$Source: parser/inc/ms_http_helper.hpp $
 * @(#)$Revision: 1b450440f9c97e1e41d0fc6016a27d68951d4532 | MSPARSER_REL_3_0_0-2024-09-24-0-g93ebaeb4f4 $
 * @(#)$Date: 2018-07-30 16:23:53 +0100 $
##############################################################################
 */
 
#if !defined(MS_HTTP_HELPER_HPP_)
#define MS_HTTP_HELPER_HPP_
 
#ifdef _WIN32
#ifdef __MINGW__
// No ATL or MFC support -- use curl
#else
#define USE_ATL
#endif
#endif
 
#include <string>
 
class LocalHelper;
 
namespace matrix_science
{
    class ms_connection_settings;
    class ms_http_helper_handles;
    class ms_http_helper_progress;
    class ms_http_helper_proxy_list;
 
 
    class MS_MASCOTRESFILE_API ms_http_helper :
        public ms_errors
    {
        public:
 
            enum FileMode
            {
                FM_binary, 
                FM_text  
            };
 
#ifdef USE_ATL
            static void yieldToCom();
#endif            
 
            bool getProxyConfig(std::vector<std::string> &proxyServers, std::vector<std::string> &proxyUsernames, std::vector<std::string> &proxyPasswords);
 
#ifndef SWIG
            ms_http_helper();
 
            ms_http_helper(const ms_http_helper & copy);
 
            const ms_http_helper & operator =(const ms_http_helper & copy);
#endif
            void copyFrom(const ms_http_helper * right);
 
            ms_http_helper(
                    const std::string & baseUrl,
                    const ms_connection_settings & settings);
                    
            ~ms_http_helper();
 
            const std::string & baseUrl() const;
            
            const ms_connection_settings & connectionSettings() const;
#ifndef SWIG
            ms_http_helper_return httpGetString(const std::string & action, std::string & httpGETString);
#else // SWIG Multiple return values
            ms_http_helper_return httpGetString(const std::string & action, std::string & OUTPUT);
#endif
            ms_http_helper_return httpPostFile(
                    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);
 
            ms_http_helper_return httpGetFile(
                    const std::string & action,
                    const std::string & filename,
                    ms_http_helper_progress & progress,
                    FileMode fileMode = FM_binary);
 
            ms_http_helper_return httpBufferedOpen(const std::string & action);
#ifndef SWIG
            ms_http_helper_return httpBufferedGetString(std::string & httpBuffer, unsigned long requiredSize );
 
            ms_http_helper_return httpGetHeader(const std::string & action, std::string & httpHeaderInfo);
#else // SWIG Multiple return values
            ms_http_helper_return httpBufferedGetString(std::string & OUTPUT, unsigned long requiredSize);
            ms_http_helper_return httpGetHeader(const std::string & action, std::string & OUTPUT);
#endif
            ms_http_helper_return httpBufferedClose();
 
 
            static std::string getHeaderValue(const std::string &name, const std::string & header);
 
        private:
            
#ifndef USE_ATL
            bool analyseCurlResult(void * pVoidCurl, ms_http_helper_return & returnCode, std::string & performError, char * errorBuffer = NULL, std::vector< std::pair<int, std::string> > * pProxyErrors = NULL);
            void * performCurlAndCheckHttpsCertificate(void * pVoidCurl, std::string & certificateError, std::string & systemCertPath, std::string & userCertPath, bool bCheckCertificate = true);
#endif // USE_ATL
 
            const std::string completeUrl(const std::string & action) const;
 
            ms_http_helper_return httpGetLocal(
                    const std::string & action,
                    std::string & strResult,
                    const std::string & filename,
                    FileMode fileMode,
                    ms_http_helper_progress & progress);
 
            ms_http_helper_return httpOpenLocal(const std::string & action, bool bHeaderOnly = false);
 
            ms_http_helper_return httpGetNextLocal(
                    std::string & buffer,
                    unsigned long requiredSize );
 
            ms_http_helper_return curlOpenLocal(const std::string & action);
 
            ms_http_helper_return curlGetNextLocal(
                    std::string & buffer,
                    unsigned long requiredSize);
 
            ms_http_helper_return closeLocal();
 
            bool determineProxy();
 
            std::string baseUrl_;
            ms_connection_settings connectionSettings_;
 
            // autoproxy detect cache
            ms_http_helper_proxy_list * proxyList_;
 
            LocalHelper * localHelper_; 
 
    };
     // end of http_client_group
} // namespace matrix_science
 
#endif // MS_HTTP_HELPER_HPP_