http.h

Go to the documentation of this file.

/*
 * http.h
 *
 * HyperText Transport Protocol classes.
 *
 * Portable Windows Library
 *
 * Copyright (c) 1993-2002 Equivalence Pty. Ltd.
 *
 * The contents of this file are subject to the Mozilla Public License
 * Version 1.0 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights and limitations
 * under the License.
 *
 * The Original Code is Portable Windows Library.
 *
 * The Initial Developer of the Original Code is Equivalence Pty. Ltd.
 *
 * Contributor(s): ______________________________________.
 *
 * $Log: http.h,v $
 * Revision 1.61  2007/04/10 05:08:46  rjongbloed
 * Fixed issue with use of static C string variables in DLL environment,
 *   must use functional interface for correct initialisation.
 *
 * Revision 1.60  2005/11/30 12:47:37  csoutheren
 * Removed tabs, reformatted some code, and changed tags for Doxygen
 *
 * Revision 1.59  2005/01/03 12:48:41  csoutheren
 * Added new configure options and ability to disable/enable modules
 *
 * Revision 1.58  2004/10/23 11:34:59  ykiryanov
 * Added ifdef _WIN32_WCE for PocketPC 2003 SDK port
 *
 * Revision 1.57  2002/12/03 22:37:36  robertj
 * Removed get document that just returns a content length as the chunked
 *   transfer encoding makes this very dangerous.
 * Added GetTextDocument() to get a URL content into a PString.
 * Added a version pf PostData() that gets the reponse content into a PString.
 * Added ReadContentBody() that takes a PString, not just PBYTEArray.
 *
 * Revision 1.56  2002/11/06 22:47:23  robertj
 * Fixed header comment (copyright etc)
 *
 * Revision 1.55  2002/10/10 04:43:43  robertj
 * VxWorks port, thanks Martijn Roest
 *
 * Revision 1.54  2002/10/02 08:54:34  craigs
 * Added support for XMLRPC server
 *
 * Revision 1.53  2002/09/16 01:08:59  robertj
 * Added #define so can select if #pragma interface/implementation is used on
 *   platform basis (eg MacOS) rather than compiler, thanks Robert Monaghan.
 *
 * Revision 1.52  2002/05/08 05:38:53  robertj
 * Added PHTTPTailFile resource to do a unix 'tail -f' of a file.
 *
 * Revision 1.51  2001/10/31 01:34:47  robertj
 * Added extra const for constant HTTP tag name strings.
 * Changes to support HTTP v1.1 chunked transfer encoding.
 *
 * Revision 1.50  2001/10/03 00:26:34  robertj
 * Upgraded client to HTTP/1.1 and for chunked mode entity bodies.
 *
 * Revision 1.49  2001/09/28 08:55:15  robertj
 * More changes to support restartable PHTTPClient
 *
 * Revision 1.48  2001/09/28 00:42:54  robertj
 * Added automatic setting of some outward MIME fields.
 * Added "user agent" string field for automatic inclusion.
 * Added function to read the contents of the HTTP request.
 *
 * Revision 1.47  2001/08/28 06:44:30  craigs
 * Added ability to override PHTTPServer creation
 *
 * Revision 1.46  2001/03/14 01:49:54  craigs
 * Added ability to handle multi-part form POST commands
 *
 * Revision 1.45  2001/02/22 05:26:47  robertj
 * Added "nicer" version of GetDocument in HTTP client class.
 *
 * Revision 1.44  2001/01/15 06:16:53  robertj
 * Set HTTP resource members to private to assure are not modified by
 *   dscendents in non-threadsafe manner.
 *
 * Revision 1.43  2000/09/04 03:57:58  robertj
 * Added ability to change the persistent connection parameters (timeout etc).
 *
 * Revision 1.42  2000/05/02 08:28:10  craigs
 * Removed "memory leaks" caused by brain-dead GNU linker
 *
 * Revision 1.41  1999/09/17 01:11:14  robertj
 * Fixed some documentation typos.
 *
 * Revision 1.40  1999/05/13 04:04:04  robertj
 * Fixed problem of initialised commandName in ConnectionInfo.
 *
 * Revision 1.39  1999/05/04 15:26:01  robertj
 * Improved HTTP/1.1 compatibility (pass through user commands).
 * Fixed problems with quicktime installer.
 *
 * Revision 1.38  1999/04/21 01:58:08  robertj
 * Fixed problem with reading data for request using second form of PHTTPRequestInfo constructor.
 *
 * Revision 1.37  1999/03/09 08:01:46  robertj
 * Changed comments for doc++ support (more to come).
 *
 * Revision 1.36  1999/02/16 08:07:10  robertj
 * MSVC 6.0 compatibility changes.
 *
 * Revision 1.35  1998/11/30 02:50:47  robertj
 * New directory structure
 *
 * Revision 1.34  1998/10/31 12:49:21  robertj
 * Added read/write mutex to the HTTP space variable to avoid thread crashes.
 *
 * Revision 1.33  1998/10/25 01:00:46  craigs
 * Added ability to specify per-directory authorisation for PHTTPDirectory
 *
 * Revision 1.32  1998/09/23 06:19:29  robertj
 * Added open source copyright license.
 *
 * Revision 1.31  1998/07/24 06:58:42  robertj
 * Changed PostData function so just has string for data instead of dictionary.
 *
 * Revision 1.30  1998/06/16 03:33:33  robertj
 * Changed TCP connection shutdown to be parameterised.
 * Propagated persistence and proxy flags in new connection info instances.
 *
 * Revision 1.29  1998/04/14 03:42:59  robertj
 * Fixed error code propagation in HTTP client.
 *
 * Revision 1.28  1998/02/03 06:29:38  robertj
 * Added local address and port to PHTTPRequest.
 *
 * Revision 1.27  1998/01/26 00:24:24  robertj
 * Added more information to PHTTPConnectionInfo.
 * Added function to allow HTTPClient to automatically connect if URL has hostname.
 *
 * Revision 1.26  1997/10/30 10:22:52  robertj
 * Added multiple user basic authorisation scheme.
 *
 * Revision 1.25  1997/10/03 13:30:15  craigs
 * Added ability to access client socket from within HTTP resources
 *
 * Revision 1.24  1997/03/28 04:40:22  robertj
 * Added tags for cookies.
 *
 * Revision 1.23  1997/01/12 04:15:19  robertj
 * Globalised MIME tag strings.
 *
 * Revision 1.22  1996/10/26 03:31:05  robertj
 * Changed OnError so can pass in full HTML page as parameter.
 *
 * Revision 1.21  1996/09/14 13:09:10  robertj
 * Major upgrade:
 *   rearranged sockets to help support IPX.
 *   added indirect channel class and moved all protocols to descend from it,
 *   separating the protocol from the low level byte transport.
 *
 * Revision 1.20  1996/08/22 13:20:55  robertj
 * Fixed bug in authorisation, missing virtual prevented polymorphism.
 *
 * Revision 1.19  1996/08/19 13:44:06  robertj
 * Fixed authorisation so if have no user/password on basic authentication, does not require it.
 *
 * Revision 1.18  1996/06/28 13:15:23  robertj
 * Modified HTTPAuthority so gets PHTTPReqest (mainly for URL) passed in.
 * Moved HTTP form resource to another compilation module.
 *
 * Revision 1.17  1996/06/07 13:52:20  robertj
 * Added PUT to HTTP proxy FTP. Necessitating redisign of entity body processing.
 *
 * Revision 1.16  1996/05/23 10:00:52  robertj
 * Added common function for GET and HEAD commands.
 * Fixed status codes to be the actual status code instead of sequential enum.
 * This fixed some problems with proxy pass through of status codes.
 *
 * Revision 1.14  1996/03/31 08:46:51  robertj
 * HTTP 1.1 upgrade.
 *
 * Revision 1.13  1996/03/17 05:41:57  robertj
 * Added hit count to PHTTPResource.
 *
 * Revision 1.12  1996/03/16 04:39:55  robertj
 * Added ParseReponse() for splitting reponse line into code and info.
 * Added client side support for HTTP socket.
 * Added hooks for proxy support in HTTP socket.
 *
 * Revision 1.11  1996/03/10 13:15:23  robertj
 * Redesign to make resources thread safe.
 *
 * Revision 1.10  1996/03/02 03:12:55  robertj
 * Added radio button and selection boxes to HTTP form resource.
 *
 * Revision 1.9  1996/02/25 11:14:21  robertj
 * Radio button support for forms.
 *
 * Revision 1.8  1996/02/25 02:57:48  robertj
 * Removed pass through HTTP resource.
 *
 * Revision 1.7  1996/02/19 13:25:43  robertj
 * Added overwrite option to AddResource().
 * Added get/set string to PHTTPString resource.
 * Moved nested classes from PHTTPForm.
 *
 * Revision 1.6  1996/02/13 13:09:16  robertj
 * Added extra parameters to callback function in PHTTPResources, required
 *   by descendants to make informed decisions on data being loaded.
 *
 * Revision 1.5  1996/02/08 12:04:19  robertj
 * Redesign of resource object callback virtuals.
 * Added HTML form resource type.
 *
 * Revision 1.4  1996/02/03 11:03:32  robertj
 * Added ismodified since and expires time checking.
 * Added PHTTPString that defaults to empty string.
 *
 * Revision 1.3  1996/01/28 14:15:38  robertj
 * Changed PCharArray in OnLoadData to PString for convenience in mangling data.
 * Beginning of pass through resource type.
 *
 * Revision 1.2  1996/01/26 02:24:26  robertj
 * Further implemetation.
 *
 * Revision 1.1  1996/01/23 13:04:20  robertj
 * Initial revision
 *
 */

#ifndef _PHTTP
#define _PHTTP

#ifdef P_USE_PRAGMA
#pragma interface
#endif

#include <ptbuildopts.h>

#include <ptclib/inetprot.h>
#include <ptclib/mime.h>
#include <ptclib/url.h>
#include <ptlib/ipsock.h>

#ifdef P_HTTPSVC

#include <ptclib/html.h>

// PHTTPSpace

class PHTTPResource;

class PHTTPSpace : public PContainer
{
  PCONTAINERINFO(PHTTPSpace, PContainer)
  public:
    PHTTPSpace();


  // New functions for class.
    enum AddOptions {
      ErrorOnExist,
      Overwrite
    };


    BOOL AddResource(
      PHTTPResource * resource, 
      AddOptions overwrite = ErrorOnExist
    );

    BOOL DelResource(
      const PURL & url          
    );

    PHTTPResource * FindResource(
      const PURL & url   
    );

    void StartRead() const
      { mutex->StartRead(); }

    void EndRead() const
      { mutex->EndRead(); }

    void StartWrite() const
      { mutex->StartWrite(); }

    void EndWrite() const
      { mutex->EndWrite(); }


  protected:
    PReadWriteMutex * mutex;

    class Node;
    PSORTED_LIST(ChildList, Node);
    class Node : public PString
    {
      PCLASSINFO(Node, PString)
      public:
        Node(const PString & name, Node * parentNode);
        ~Node();

        Node          * parent;
        ChildList       children;
        PHTTPResource * resource;
    } * root;

  private:
    BOOL SetSize(PINDEX) { return FALSE; }
};

#endif // P_HTTPSVC

#ifdef _WIN32_WCE
#undef TRACE
#endif

// PHTTP

class PHTTP : public PInternetProtocol
{
  PCLASSINFO(PHTTP, PInternetProtocol)

  public:
  // New functions for class.
    enum Commands {
      // HTTP/1.0 commands
      GET, HEAD, POST,
      // HTTP/1.1 commands
      PUT, DELETE, TRACE, OPTIONS,
      // HTTPS command
      CONNECT,
      NumCommands
    };

    enum StatusCode {
      Continue = 100,              
      SwitchingProtocols,          
      RequestOK = 200,             
      Created,                     
      Accepted,                    
      NonAuthoritativeInformation, 
      NoContent,                   
      ResetContent,                
      PartialContent,              
      MultipleChoices = 300,       
      MovedPermanently,            
      MovedTemporarily,            
      SeeOther,                    
      NotModified,                 
      UseProxy,                    
      BadRequest = 400,            
      UnAuthorised,                
      PaymentRequired,             
      Forbidden,                   
      NotFound,                    
      MethodNotAllowed,            
      NoneAcceptable,              
      ProxyAuthenticationRequired, 
      RequestTimeout,              
      Conflict,                    
      Gone,                        
      LengthRequired,              
      UnlessTrue,                  
      InternalServerError = 500,   
      NotImplemented,              
      BadGateway,                  
      ServiceUnavailable,          
      GatewayTimeout               
    };

    // Common MIME header tags
    static const PString & AllowTag();
    static const PString & AuthorizationTag();
    static const PString & ContentEncodingTag();
    static const PString & ContentLengthTag();
    static const PString & ContentTypeTag();
    static const PString & DateTag();
    static const PString & ExpiresTag();
    static const PString & FromTag();
    static const PString & IfModifiedSinceTag();
    static const PString & LastModifiedTag();
    static const PString & LocationTag();
    static const PString & PragmaTag();
    static const PString & PragmaNoCacheTag();
    static const PString & RefererTag();
    static const PString & ServerTag();
    static const PString & UserAgentTag();
    static const PString & WWWAuthenticateTag();
    static const PString & MIMEVersionTag();
    static const PString & ConnectionTag();
    static const PString & KeepAliveTag();
    static const PString & TransferEncodingTag();
    static const PString & ChunkedTag();
    static const PString & ProxyConnectionTag();
    static const PString & ProxyAuthorizationTag();
    static const PString & ProxyAuthenticateTag();
    static const PString & ForwardedTag();
    static const PString & SetCookieTag();
    static const PString & CookieTag();

  protected:
    PHTTP();

    virtual PINDEX ParseResponse(
      const PString & line    
    );
};


// PHTTPClient

class PHTTPClient : public PHTTP
{
  PCLASSINFO(PHTTPClient, PHTTP)

  public:
    PHTTPClient();
    PHTTPClient(
      const PString & userAgentName
    );


  // New functions for class.
    int ExecuteCommand(
      Commands cmd,
      const PURL & url,
      PMIMEInfo & outMIME,
      const PString & dataBody,
      PMIMEInfo & replyMime,
      BOOL persist = TRUE
    );
    int ExecuteCommand(
      const PString & cmdName,
      const PURL & url,
      PMIMEInfo & outMIME,
      const PString & dataBody,
      PMIMEInfo & replyMime,
      BOOL persist = TRUE
    );

    BOOL WriteCommand(
      Commands cmd,
      const PString & url,
      PMIMEInfo & outMIME,
      const PString & dataBody
    );
    BOOL WriteCommand(
      const PString & cmdName,
      const PString & url,
      PMIMEInfo & outMIME,
      const PString & dataBody
    );

    BOOL ReadResponse(
      PMIMEInfo & replyMIME
    );

    BOOL ReadContentBody(
      PMIMEInfo & replyMIME,
      PBYTEArray & body
    );
    BOOL ReadContentBody(
      PMIMEInfo & replyMIME,
      PString & body
    );


    BOOL GetTextDocument(
      const PURL & url,         
      PString & document,       
      BOOL persist = TRUE       
    );

    BOOL GetDocument(
      const PURL & url,         
      PMIMEInfo & outMIME,      
      PMIMEInfo & replyMIME,    
      BOOL persist = TRUE       
    );

    BOOL GetHeader(
      const PURL & url,         
      PMIMEInfo & outMIME,      
      PMIMEInfo & replyMIME,    
      BOOL persist = TRUE       
    );


    BOOL PostData(
      const PURL & url,       
      PMIMEInfo & outMIME,    
      const PString & data,   
      PMIMEInfo & replyMIME,  
      BOOL persist = TRUE     
    );

    BOOL PostData(
      const PURL & url,       
      PMIMEInfo & outMIME,    
      const PString & data,   
      PMIMEInfo & replyMIME,  
      PString & replyBody,    
      BOOL persist = TRUE     
    );

  protected:
    BOOL AssureConnect(const PURL & url, PMIMEInfo & outMIME);
    BOOL InternalReadContentBody(
      PMIMEInfo & replyMIME,
      PAbstractArray & body
    );

    PString userAgentName;
};

#ifdef P_HTTPSVC

// PMultipartFormInfo

class PMultipartFormInfo : public PObject
{
  PCLASSINFO(PMultipartFormInfo, PObject);
  public:
    PMIMEInfo mime;
    PString body;
};

PARRAY(PMultipartFormInfoArray, PMultipartFormInfo);

// PHTTPConnectionInfo

class PHTTPServer;

class PHTTPConnectionInfo : public PObject
{
  PCLASSINFO(PHTTPConnectionInfo, PObject)
  public:
    PHTTPConnectionInfo();

    PHTTP::Commands GetCommandCode() const { return commandCode; }
    const PString & GetCommandName() const { return commandName; }

    const PURL & GetURL() const       { return url; }

    const PMIMEInfo & GetMIME() const { return mimeInfo; }
    void SetMIME(const PString & tag, const PString & value);

    BOOL IsCompatible(int major, int minor) const;

    BOOL IsPersistant() const         { return isPersistant; }
    BOOL WasPersistant() const        { return wasPersistant; }
    BOOL IsProxyConnection() const    { return isProxyConnection; }
    int  GetMajorVersion() const      { return majorVersion; }
    int  GetMinorVersion() const      { return minorVersion; }

    long GetEntityBodyLength() const  { return entityBodyLength; }

    PTimeInterval GetPersistenceTimeout() const { return persistenceTimeout; }

    void SetPersistenceTimeout(const PTimeInterval & t) { persistenceTimeout = t; }

    unsigned GetPersistenceMaximumTransations() const { return persistenceMaximum; }

    void SetPersistenceMaximumTransations(unsigned m) { persistenceMaximum = m; }

    const PMultipartFormInfoArray & GetMultipartFormInfo() const
      { return multipartFormInfoArray; }

    void ResetMultipartFormInfo()
      { multipartFormInfoArray.RemoveAll(); }

    PString GetEntityBody() const   { return entityBody; }

  protected:
    BOOL Initialise(PHTTPServer & server, PString & args);
    void DecodeMultipartFormInfo(const PString & type, const PString & entityBody);

    PHTTP::Commands commandCode;
    PString         commandName;
    PURL            url;
    PMIMEInfo       mimeInfo;
    BOOL            isPersistant;
    BOOL            wasPersistant;
    BOOL            isProxyConnection;
    int             majorVersion;
    int             minorVersion;
    PString         entityBody;        // original entity body (POST only)
    long            entityBodyLength;
    PTimeInterval   persistenceTimeout;
    unsigned        persistenceMaximum;
    PMultipartFormInfoArray multipartFormInfoArray;

  friend class PHTTPServer;
};


// PHTTPServer

class PHTTPServer : public PHTTP
{
  PCLASSINFO(PHTTPServer, PHTTP)

  public:
    PHTTPServer();
    PHTTPServer(
     const PHTTPSpace & urlSpace  
    );


  // New functions for class.
    virtual PString GetServerName() const;

    PHTTPSpace & GetURLSpace() { return urlSpace; }

    void SetURLSpace(
      const PHTTPSpace & space   
    );


    virtual BOOL ProcessCommand();

    virtual BOOL OnGET(
      const PURL & url,                    
      const PMIMEInfo & info,              
      const PHTTPConnectionInfo & conInfo  
    );



    virtual BOOL OnHEAD(
      const PURL & url,                   
      const PMIMEInfo & info,             
      const PHTTPConnectionInfo & conInfo 
    );

    virtual BOOL OnPOST(
      const PURL & url,                   
      const PMIMEInfo & info,             
      const PStringToString & data,       
      const PHTTPConnectionInfo & conInfo 
    );

    virtual BOOL OnProxy(
      const PHTTPConnectionInfo & conInfo   
    );


    virtual PString ReadEntityBody();

    virtual BOOL OnUnknown(
      const PCaselessString & command,         
      const PHTTPConnectionInfo & connectInfo  
    );

    BOOL StartResponse(
      StatusCode code,      
      PMIMEInfo & headers,  
      long bodySize         
    );

    virtual BOOL OnError(
      StatusCode code,                         
      const PCaselessString & extra,           
      const PHTTPConnectionInfo & connectInfo  
    );

    void SetDefaultMIMEInfo(
      PMIMEInfo & info,      
      const PHTTPConnectionInfo & connectInfo
    );

    PHTTPConnectionInfo & GetConnectionInfo() { return connectInfo; }

  protected:
    void Construct();

    PHTTPSpace          urlSpace;
    PHTTPConnectionInfo connectInfo;
    unsigned            transactionCount;
    PTimeInterval       nextTimeout;
};


// PHTTPRequest

class PHTTPRequest : public PObject
{
  PCLASSINFO(PHTTPRequest, PObject)

  public:
    PHTTPRequest(
      const PURL & url,             
      const PMIMEInfo & inMIME,     
      const PMultipartFormInfoArray & multipartFormInfo, 
      PHTTPServer & server          
    );

    PHTTPServer & server;           
    const PURL & url;               
    const PMIMEInfo & inMIME;       
    const PMultipartFormInfoArray & multipartFormInfo; 
    PHTTP::StatusCode code;         
    PMIMEInfo outMIME;              
    PString entityBody;             
    PINDEX contentSize;             
    PIPSocket::Address origin;      
    PIPSocket::Address localAddr;   
    WORD               localPort;   
};


// PHTTPAuthority

class PHTTPAuthority : public PObject
{
  PCLASSINFO(PHTTPAuthority, PObject)

  public:
  // New functions for class.
    virtual PString GetRealm(
      const PHTTPRequest & request   
    ) const = 0;

    virtual BOOL Validate(
      const PHTTPRequest & request,  
      const PString & authInfo       
    ) const = 0;

    virtual BOOL IsActive() const;

  protected:
    static void DecodeBasicAuthority(
      const PString & authInfo,   
      PString & username,         
      PString & password          
    );
};


// PHTTPSimpleAuth

class PHTTPSimpleAuth : public PHTTPAuthority
{
  PCLASSINFO(PHTTPSimpleAuth, PHTTPAuthority)

  public:
    PHTTPSimpleAuth(
      const PString & realm,      
      const PString & username,   
      const PString & password    
    );
    // Construct the simple authorisation structure.


  // Overrides from class PObject.
    virtual PObject * Clone() const;


  // Overrides from class PHTTPAuthority.
    virtual PString GetRealm(
      const PHTTPRequest & request   
    ) const;

    virtual BOOL Validate(
      const PHTTPRequest & request,  
      const PString & authInfo       
    ) const;

    virtual BOOL IsActive() const;

    const PString & GetUserName() const { return username; }

    const PString & GetPassword() const { return password; }


  protected:
    PString realm;
    PString username;
    PString password;
};


// PHTTPMultiSimpAuth

class PHTTPMultiSimpAuth : public PHTTPAuthority
{
  PCLASSINFO(PHTTPMultiSimpAuth, PHTTPAuthority)

  public:
    PHTTPMultiSimpAuth(
      const PString & realm      
    );
    PHTTPMultiSimpAuth(
      const PString & realm,           
      const PStringToString & userList 
    );
    // Construct the simple authorisation structure.


  // Overrides from class PObject.
    virtual PObject * Clone() const;


  // Overrides from class PHTTPAuthority.
    virtual PString GetRealm(
      const PHTTPRequest & request   
    ) const;

    virtual BOOL Validate(
      const PHTTPRequest & request,  
      const PString & authInfo       
    ) const;

    virtual BOOL IsActive() const;

    void AddUser(
      const PString & username,   
      const PString & password    
    );


  protected:
    PString realm;
    PStringToString users;
};


// PHTTPResource

class PHTTPResource : public PObject
{
  PCLASSINFO(PHTTPResource, PObject)

  protected:
    PHTTPResource(
      const PURL & url               
    );
    PHTTPResource(
      const PURL & url,              
      const PHTTPAuthority & auth    
    );
    PHTTPResource(
      const PURL & url,              
      const PString & contentType    
    );
    PHTTPResource(
      const PURL & url,              
      const PString & contentType,   
      const PHTTPAuthority & auth    
    );
    // Create a new HTTP Resource.


  public:
    virtual ~PHTTPResource();
    // Destroy the HTTP Resource.


  // New functions for class.
    const PURL & GetURL() const { return baseURL; }

    const PString & GetContentType() const { return contentType; }

    PHTTPAuthority * GetAuthority() const { return authority; }

    void SetAuthority(
      const PHTTPAuthority & auth      
    );

    void ClearAuthority();

    DWORD GetHitCount() const { return hitCount; }

    void ClearHitCount() { hitCount = 0; }
    // Clear the hit count for the resource.


    virtual BOOL OnGET(
      PHTTPServer & server,       
      const PURL & url,           
      const PMIMEInfo & info,     
      const PHTTPConnectionInfo & conInfo   
    );

    virtual BOOL OnGETData(
      PHTTPServer & server,                       
      const PURL & url,                           
      const PHTTPConnectionInfo & connectInfo,    
      PHTTPRequest & request                      
    );

    virtual BOOL OnHEAD(
      PHTTPServer & server,       
      const PURL & url,           
      const PMIMEInfo & info,     
      const PHTTPConnectionInfo & conInfo  
    );

    virtual BOOL OnPOST(
      PHTTPServer & server,         
      const PURL & url,             
      const PMIMEInfo & info,       
      const PStringToString & data, 
      const PHTTPConnectionInfo & conInfo  
    );

    virtual BOOL OnPOSTData(
      PHTTPRequest & request,        
      const PStringToString & data   
    );

    virtual BOOL IsModifiedSince(
      const PTime & when    
    );

    virtual BOOL GetExpirationDate(
      PTime & when          
    );

    virtual PHTTPRequest * CreateRequest(
      const PURL & url,                   
      const PMIMEInfo & inMIME,           
      const PMultipartFormInfoArray & multipartFormInfo,  
      PHTTPServer & socket                                
    );

    virtual BOOL LoadHeaders(
      PHTTPRequest & request    
    ) = 0;

    virtual void SendData(
      PHTTPRequest & request    
    );

    virtual BOOL LoadData(
      PHTTPRequest & request,    
      PCharArray & data          
    );

    virtual PString LoadText(
      PHTTPRequest & request    
    );

    virtual void OnLoadedText(
      PHTTPRequest & request,    
      PString & text             
    );

    virtual BOOL Post(
      PHTTPRequest & request,       
      const PStringToString & data, 
      PHTML & replyMessage          
    );


  protected:
    virtual BOOL CheckAuthority(
      PHTTPServer & server,               
      const PHTTPRequest & request,       
      const PHTTPConnectionInfo & conInfo 
    );
    static BOOL CheckAuthority(
                   PHTTPAuthority & authority,
                      PHTTPServer & server,
               const PHTTPRequest & request,
        const PHTTPConnectionInfo & connectInfo
    );


    virtual BOOL OnGETOrHEAD(
      PHTTPServer & server,       
      const PURL & url,           
      const PMIMEInfo & info,     
      const PHTTPConnectionInfo & conInfo,
      BOOL  IsGet
    );

    PURL             baseURL;
    PString          contentType;
    PHTTPAuthority * authority;
    volatile DWORD   hitCount;
};


// PHTTPString

class PHTTPString : public PHTTPResource
{
  PCLASSINFO(PHTTPString, PHTTPResource)

  public:
    PHTTPString(
      const PURL & url             // Name of the resource in URL space.
    );
    PHTTPString(
      const PURL & url,            // Name of the resource in URL space.
      const PHTTPAuthority & auth  // Authorisation for the resource.
    );
    PHTTPString(
      const PURL & url,            // Name of the resource in URL space.
      const PString & str          // String to return in this resource.
    );
    PHTTPString(
      const PURL & url,            // Name of the resource in URL space.
      const PString & str,         // String to return in this resource.
      const PString & contentType  // MIME content type for the file.
    );
    PHTTPString(
      const PURL & url,            // Name of the resource in URL space.
      const PString & str,         // String to return in this resource.
      const PHTTPAuthority & auth  // Authorisation for the resource.
    );
    PHTTPString(
      const PURL & url,            // Name of the resource in URL space.
      const PString & str,         // String to return in this resource.
      const PString & contentType, // MIME content type for the file.
      const PHTTPAuthority & auth  // Authorisation for the resource.
    );


  // Overrides from class PHTTPResource
    virtual BOOL LoadHeaders(
      PHTTPRequest & request    // Information on this request.
    );

    virtual PString LoadText(
      PHTTPRequest & request    // Information on this request.
    );

  // New functions for class.
    const PString & GetString() { return string; }

    void SetString(
      const PString & str   // New string for the resource.
    ) { string = str; }


  protected:
    PString string;
};


// PHTTPFile

class PHTTPFile : public PHTTPResource
{
  PCLASSINFO(PHTTPFile, PHTTPResource)

  public:
    PHTTPFile(
      const PString & filename     // file in file system and URL name.
    );
    PHTTPFile(
      const PString & filename,    // file in file system and URL name.
      const PHTTPAuthority & auth  // Authorisation for the resource.
    );
    PHTTPFile(
      const PURL & url,            // Name of the resource in URL space.
      const PFilePath & file       // Location of file in file system.
    );
    PHTTPFile(
      const PURL & url,            // Name of the resource in URL space.
      const PFilePath & file,      // Location of file in file system.
      const PString & contentType  // MIME content type for the file.
    );
    PHTTPFile(
      const PURL & url,            // Name of the resource in URL space.
      const PFilePath & file,      // Location of file in file system.
      const PHTTPAuthority & auth  // Authorisation for the resource.
    );
    PHTTPFile(
      const PURL & url,            // Name of the resource in URL space.
      const PFilePath & file,      // Location of file in file system.
      const PString & contentType, // MIME content type for the file.
      const PHTTPAuthority & auth  // Authorisation for the resource.
    );


  // Overrides from class PHTTPResource
    virtual PHTTPRequest * CreateRequest(
      const PURL & url,                  // Universal Resource Locator for document.
      const PMIMEInfo & inMIME,          // Extra MIME information in command.
      const PMultipartFormInfoArray & multipartFormInfo,
      PHTTPServer & socket
    );

    virtual BOOL LoadHeaders(
      PHTTPRequest & request    // Information on this request.
    );

    virtual BOOL LoadData(
      PHTTPRequest & request,    // Information on this request.
      PCharArray & data          // Data used in reply.
    );

    virtual PString LoadText(
      PHTTPRequest & request    // Information on this request.
    );


  protected:
    PHTTPFile(
      const PURL & url,       // Name of the resource in URL space.
      int dummy
    );
    // Constructor used by PHTTPDirectory


    PFilePath filePath;
};


class PHTTPFileRequest : public PHTTPRequest
{
  PCLASSINFO(PHTTPFileRequest, PHTTPRequest)
  public:
    PHTTPFileRequest(
      const PURL & url,             // Universal Resource Locator for document.
      const PMIMEInfo & inMIME,     // Extra MIME information in command.
      const PMultipartFormInfoArray & multipartFormInfo,
      PHTTPServer & server
    );

    PFile file;
};


// PHTTPTailFile

class PHTTPTailFile : public PHTTPFile
{
  PCLASSINFO(PHTTPTailFile, PHTTPFile)

  public:
    PHTTPTailFile(
      const PString & filename     // file in file system and URL name.
    );
    PHTTPTailFile(
      const PString & filename,    // file in file system and URL name.
      const PHTTPAuthority & auth  // Authorisation for the resource.
    );
    PHTTPTailFile(
      const PURL & url,            // Name of the resource in URL space.
      const PFilePath & file       // Location of file in file system.
    );
    PHTTPTailFile(
      const PURL & url,            // Name of the resource in URL space.
      const PFilePath & file,      // Location of file in file system.
      const PString & contentType  // MIME content type for the file.
    );
    PHTTPTailFile(
      const PURL & url,            // Name of the resource in URL space.
      const PFilePath & file,      // Location of file in file system.
      const PHTTPAuthority & auth  // Authorisation for the resource.
    );
    PHTTPTailFile(
      const PURL & url,            // Name of the resource in URL space.
      const PFilePath & file,      // Location of file in file system.
      const PString & contentType, // MIME content type for the file.
      const PHTTPAuthority & auth  // Authorisation for the resource.
    );


  // Overrides from class PHTTPResource
    virtual BOOL LoadHeaders(
      PHTTPRequest & request    // Information on this request.
    );

    virtual BOOL LoadData(
      PHTTPRequest & request,    // Information on this request.
      PCharArray & data          // Data used in reply.
    );
};


// PHTTPDirectory

class PHTTPDirectory : public PHTTPFile
{
  PCLASSINFO(PHTTPDirectory, PHTTPFile)

  public:
    PHTTPDirectory(
      const PURL & url,            
      const PDirectory & dir       
    );
    PHTTPDirectory(
      const PURL & url,            
      const PDirectory & dir,      
      const PHTTPAuthority & auth  
    );
    // Construct a new directory resource for HTTP.


  // Overrides from class PHTTPResource
    virtual PHTTPRequest * CreateRequest(
      const PURL & url,                  // Universal Resource Locator for document.
      const PMIMEInfo & inMIME,          // Extra MIME information in command.
      const PMultipartFormInfoArray & multipartFormInfo,
      PHTTPServer & socket
    );

    virtual BOOL LoadHeaders(
      PHTTPRequest & request    
    );

    virtual PString LoadText(
      PHTTPRequest & request    
    );

    void EnableAuthorisation(const PString & realm);

    void AllowDirectories(BOOL enable = TRUE);

  protected:
    BOOL CheckAuthority(
      PHTTPServer & server,               // Server to send response to.
      const PHTTPRequest & request,       // Information on this request.
      const PHTTPConnectionInfo & conInfo // Information on the connection
    );

    BOOL FindAuthorisations(const PDirectory & dir, PString & realm, PStringToString & authorisations);

    PDirectory basePath;
    PString authorisationRealm;
    BOOL allowDirectoryListing;
};


class PHTTPDirRequest : public PHTTPFileRequest
{
  PCLASSINFO(PHTTPDirRequest, PHTTPFileRequest)
  public:
    PHTTPDirRequest(
      const PURL & url,             // Universal Resource Locator for document.
      const PMIMEInfo & inMIME,     // Extra MIME information in command.
      const PMultipartFormInfoArray & multipartFormInfo, 
      PHTTPServer & server
    );

    PString fakeIndex;
    PFilePath realPath;
};

#endif // P_HTTPSVC

#endif


// End Of File ///////////////////////////////////////////////////////////////

---