mi32/httpclient.h

Go to the documentation of this file.

/***************************************************************************
 * \file mi32/httpclient.h
 * \brief HTTPCLIENT class definitions
 * 
 * \if NODOC
 * $Log: httpclient.h_v $
 * Revision 1.62  2012/05/04 15:45:47  mju
 * Add cacheClear.
 * Remove unused set/getCacheDirectory methods.
 *
 * Revision 1.61  2012/05/03 20:30:28  mju
 * Add is/setCacheDisabled.
 *
 * Revision 1.60  2012/04/23 17:51:18  mju
 * *** empty log message ***
 *
 * Revision 1.59  2012/04/20 21:31:14  mju
 * Move all private members/methods to internal priv class.
 * Remove httpserver-only methods as don't belong in client.
 * Add delegate support to httpclient and remove delegateclient.
 *
 * Revision 1.58  2012/04/17 16:03:11  mju
 * Remove unused methods.
 *
 * Revision 1.57  2012/04/09 14:37:59  mju
 * Add hdrs previously included by httpmsg.
 *
 * Revision 1.56  2012/02/22 19:03:34  ldyas
 * added extended logging.
 *
 * Revision 1.55  2011/05/11 14:38:42  mju
 * Order methods alphabetical.
 *
 * Revision 1.54  2011/05/09 13:20:22  mju
 * Remove unused setUsername/Password methods and put static method defns at beginning.
 *
 * Revision 1.53  2011/05/02 18:52:45  ldyas
 * changed to register delegate instead of set
 *
 * Revision 1.52  2011/05/02 15:39:51  ldyas
 * adjustments for static authentication support
 *
 * Revision 1.48  2011/04/11 18:41:49  ldyas
 * make mac and pc use same params
 *
 * Revision 1.46  2011/04/11 17:17:26  ldyas
 * only one postfile method currently used.
 *
 * Revision 1.45  2011/04/11 17:08:02  ldyas
 * removing hSession from method params.
 *
 * Revision 1.36  2011/03/15 16:04:12  ldyas
 * added set methods for username and password and username and password.
 *
 * Revision 1.35  2011/01/20 17:13:01  ldyas
 * added postFile Methods
 *
 * Revision 1.34  2011/01/12 00:11:03  ldyas
 * added method for download file that takes a httpmessage
 *
 * Revision 1.30  2010/07/02 18:55:55  ldyas
 * added Get google maps auth string and download file that takes header params
 *
 * Revision 1.29  2010/06/11 19:35:48  ldyas
 * default values for ignore cache and session.
 *
 * Revision 1.25  2010/02/17 23:07:47  ldyas
 * added method for download so that it can send a body.
 *
 * Revision 1.24  2010/02/04 16:35:30  ldyas
 * added get auth header
 *
 * Revision 1.23  2009/04/22 14:01:17  mju
 * Change setUseProxy to take host/port parms too.
 *
 * Revision 1.20  2008/05/01 17:10:10  scowan
 * Added a download methgod that takes an isEscaped bool.
 *
 * Revision 1.19  2007/02/08 23:18:08  dwilliss
 * Started adding cache control support
 *
 * Revision 1.13  2006/06/22 13:52:51  dwilliss
 * Added new Download methods which handle authentication and redirects
 *
 * Revision 1.12  2006/06/21 16:16:50  dwilliss
 * initial implementation of redirect and authentication
 *
 * Revision 1.11  2006/06/20 21:12:02  dwilliss
 * Made virtual methods private to conform with current style guidelines
 * Added v_OnAuthRequest virtual method
 * Added a derived class that works through delegates instead of overriding
 *    virtual methods
 *
 * Revision 1.10  2006/03/21 22:58:35  dwilliss
 * Make the legacy send message methods non-inline.
 * Added Doxygen comments to them saying why they're deprecated.
 *
 * Revision 1.7  2004/03/11 21:20:03  dwilliss
 * Changed access of socket client virtual methods
 * cope with destorying client while its still in use
 *
 * Revision 1.6  2004/02/16 17:24:47  dwilliss
 * Added OnStatusBegin/End methods
 *
 * Revision 1.2  2004/01/05 20:26:25  dwilliss
 * \endif
 **************************************************************************/

#ifndef INC_MI32_HTTPCLIENT_H
#define INC_MI32_HTTPCLIENT_H

#ifndef INC_MI32_HTTPMSG_H
#include <mi32/httpmsg.h>
#endif

#ifndef INC_MI32_STRUTF8_H
#include <mi32/strutf8.h>
#endif

#ifndef INC_MI32_DELEGATE_H
#include <mi32/delegate.h>
#endif

#ifdef MISYSTEMDLL
   #define CLASSLIBEXPORT MI_DLLCLASSEXPORT
#else
   #define CLASSLIBEXPORT MI_DLLCLASSIMPORT
#endif

#ifndef GENERATING_DOXYGEN_OUTPUT
// Forward declarations
class MISOCKET;
class XMLDOC;
class FILEPATH;
class GENERICRW;
class STATUSCONTEXT;
#endif



class CLASSLIBEXPORT HTTPCLIENT {
   public:

      typedef fastdelegate::FastDelegate<ERRVALUE (const MISTRING& host, const MISTRING& realm)> DELEGATE_ONAUTHREQUEST;
      typedef fastdelegate::FastDelegate<bool(double)> DELEGATE_ONSTATUS;
   
      class INSTANCEDATA;

      enum CACHEMODE {
         CACHEMODE_NoCache = 0,              
         CACHEMODE_IgnoreCache = 1,          
         CACHEMODE_UseCacheIfCurrent = 2,    
         CACHEMODE_UseCacheIfExists = 3      
         };

      enum STATE {
         STATE_Idle,
         STATE_WaitingForFirstLine,
         STATE_ReadingHeader,
         STATE_ReadingMessage
         };

      static void CacheClear ();

      static bool CacheIsDisabled ();

      static void CacheSetDisabled (
         bool disable         
         );

      static INT32 GetCacheMaxSize ();

      static const char* GetDefaultStatusMessage (
         int code          
         );

      static void RegisterDelegateOnAuthRequest (
         DELEGATE_ONAUTHREQUEST delegate
         );

      static void SetCacheMaxSize (
         INT32 Size     
         );


      HTTPCLIENT ();

      HTTPCLIENT (
         MISOCKET *socket,
         bool bTakeOwnership
         );

      virtual ~HTTPCLIENT ();

      ERRVALUE ConnectToHost (
         const char *hostname,
         int port = 80
         );

      ERRVALUE Download (
         const char *path,    
         HTTPMESSAGE& reply   
         );

      ERRVALUE Download (
         const char *path,    
         bool bIsEscaped,     
         HTTPMESSAGE& reply   
         );

      ERRVALUE Download (
         const HTTPMESSAGE& request,   
         HTTPMESSAGE& reply            
         );

      ERRVALUE DownloadFile (
         const char *path,
         FILEPATH& filepath,
         const MILIST<STRUTF8>& Headers,
         bool bIgnoreCache = false
         );
               
      ERRVALUE DownloadFile (
         const char *path,
         FILEPATH& filepath,
         const MILIST<STRUTF8>& Headers,
         HTTPMESSAGE& Reply,
         bool bIgnoreCache = false
         );

      ERRVALUE GetAuthentication (
         const MISTRING& host,
         const MISTRING& realm,
         MISTRING& username,
         MISTRING& password
         );

      ERRVALUE GetAuthHeader (
         const HTTPMESSAGE& req,
         const HTTPMESSAGE& rep,
         MISTRING& header
         );

      CACHEMODE GetCacheMode (
         ) const;

      const MISTRING& GetHostName () const;

      INSTANCEDATA* GetInstanceData (
         const char *id
         ) const;

      ERRVALUE GetMsg (
         HTTPMESSAGE& obj
         );

      ERRVALUE PostFile (
         const char *path,
         FILEPATH& responsefile,
         GENERICRW& body,
         const MILIST<STRUTF8>& headers,
         HTTPMESSAGE& Reply,
         bool bIgnoreCache = false
         );

      ERRVALUE RemoveAuthentication (
         const MISTRING& host,
         const MISTRING& realm
         );

      ERRVALUE Send (
         const HTTPMESSAGE& Request,
         HTTPMESSAGE& Reply
         );

      ERRVALUE SendMsg (
         const HTTPMESSAGE& msg,          
         bool bHeaderOnly = false
         );

      ERRVALUE SendMsg (
         const HTTPMESSAGE& headers,
         const MISTRING& body,            
         bool bHeaderOnly = false
         );

      ERRVALUE SendMsg (
         const HTTPMESSAGE& headers,
         const STRUTF8& body,             
         bool bHeaderOnly = false
         );

      ERRVALUE SendMsg (
         const HTTPMESSAGE& headers,
         const XMLDOC& body,              
         bool bHeaderOnly = false
         );

      ERRVALUE SendMsg (
         const HTTPMESSAGE& headers,
         GENERICRW& body,              
         bool bHeaderOnly = false
         );

      ERRVALUE SetAuthentication (
         const MISTRING& host,
         const MISTRING& realm,
         const MISTRING& username,
         const MISTRING& password
         );

      void SetCacheMode (
         CACHEMODE mode
         );

      void SetDelegateOnStatus (
         DELEGATE_ONSTATUS delegate
         );

      void SetDelegateOnStatusBegin (
         DELEGATE_VOID_NOPARMS delegate
         );

      void SetDelegateOnStatusEnd (
         DELEGATE_VOID_NOPARMS delegate
         );

      void SetHostName (
         const char *name
         );

      void SetTimeOut (
         int seconds
         );

      void SetUseProxy (
         bool UseProxy,
         const char *ProxyHost = 0,
         int ProxyPort = 0
         );

   private:    
   
      #ifndef GENERATING_DOXYGEN_OUTPUT
      friend class INSTANCEDATA; // Only this can call attach/detach instance data
      class PRIV;
      PRIV *m_pPriv;

      void AttachInstanceData (
         INSTANCEDATA *data
         );

      void DetachInstanceData (
         INSTANCEDATA *data
         );

      // Unimplemented.
      HTTPCLIENT (const HTTPCLIENT&);
      HTTPCLIENT& operator= (const HTTPCLIENT&);

      #endif // GENERATING_DOXYGEN_OUTPUT

      // Overridables

      virtual ERRVALUE v_OnAuthRequest (
         const MISTRING& host,
         const MISTRING& realm
         );
   
   };


class CLASSLIBEXPORT HTTPCLIENT::INSTANCEDATA {
   public:
      INSTANCEDATA (
         HTTPCLIENT *client
         );

      virtual ~INSTANCEDATA();

      HTTPCLIENT* GetClient (
         ) const;

      const STRUTF8& GetID (
         ) const;

   private:
      HTTPCLIENT *m_client;
      STRUTF8 m_id;  
   };




#undef CLASSLIBEXPORT

#endif // INC_MI32_HTTPCLIENT_H

---