source: trunk/gsdl/src/w32server/httpreq.h@ 2701

/**********************************************************************
 *
 * httpreq.h
 * Copyright (C) 1996
 * 
 * A component of the fnord webserver written by [email protected].
 *
 * Altered for use with the Greenstone digital library software by the
 * New Zealand Digital Library Project at the University of Waikato,
 * New Zealand.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 *********************************************************************/

#ifndef HTTPREQ_H
#define HTTPREQ_H

#include "locate.h"
#include "text_t.h"

/*
Module Name: HTTP Request
Purpose: Parses HTTP requests and then calls the appropriate function
    to respond to the request
Public Functions:
    Request Thread
*/

// Public Data Structures

//Used for sending information to the request thread
struct RequestThreadMessageT {
  SOCKADDR_IN ClientSockAddr;
  SOCKET ClientSocket;
  int AddrLen;
};

//Length constants for RequestFieldsT
#define ReqMethodStrLen           24
#define ReqVersionStrLen          24
#define ReqDateStrLen             48
#define ReqMIMEVerStrLen          24
#define ReqPragmaStrLen          128
#define ReqAuthorizationStrLen   512
#define ReqFromStrLen            128
#define ReqIfModSinceStrLen       48
#define ReqRefererStrLen         512
#define ReqUserAgentStrLen       256
#define ReqContentEncodingStrLen 128
#define ReqContentTypeStrLen     128
#define ReqContentLengthStrLen    48
#define ReqAcceptStrLen          256
#define ReqAcceptLangStrLen       48
#define ReqConnectionStrLen       24
#define ReqAuthorizedUserStrLen   48
#define ReqPathInfoStrLen        512
#define ReqPathTranslatedStrLen  512
#define ReqScriptNameStrLen      512

#define MAX_OTHER_HEADERS 100

struct RequestHeaderT {
  char *Var;
  char *Val;
};

struct RequestFieldsT {
  //Simple request line info v0.9
  char MethodStr[ReqMethodStrLen];
  text_t URIStr;
  //added v1.0
  char VersionStr[ReqVersionStrLen];
  //General Header
  char DateStr[ReqDateStrLen];
  char MIMEVerStr[ReqMIMEVerStrLen];
  char PragmaStr[ReqPragmaStrLen];
  //Request Header
  char AuthorizationStr[ReqAuthorizationStrLen];
  char FromStr[ReqFromStrLen];
  char IfModSinceStr[ReqIfModSinceStrLen];
  char RefererStr[ReqRefererStrLen];
  char UserAgentStr[ReqUserAgentStrLen];
  //Entity Header (Only CGI stuff)
  char ContentEncodingStr[ReqContentEncodingStrLen];
  char ContentTypeStr[ReqContentTypeStrLen];
  char ContentLengthStr[ReqContentLengthStrLen];
  //v1.0 Optional (the more common ones)
  char AcceptStr[ReqAcceptStrLen];
  char AcceptLangStr[ReqAcceptLangStrLen];
  //v1.1 Exentions
  char ConnectionStr[ReqConnectionStrLen];
  //Pointer to buffer containing the content
  DWORD ContentLength;
  BYTE *Content;
  
  //Authorized user, filled in if a user is authorized from Auth..Str above
  char AuthorizedUserStr[ReqAuthorizedUserStrLen];
  
  //CGI style fields
  char PathInfoStr[ReqPathInfoStrLen];
  char PathTranslatedStr[ReqPathTranslatedStrLen];
  char ScriptNameStr[ReqScriptNameStrLen];
  
  //Other Headers
  int NumOtherHeaders;
  RequestHeaderT OtherHeaders[MAX_OTHER_HEADERS];
};

struct RequestInfoT {
  int ThreadNum;
  
  //Buffer for IO operations (so we're not constantly reallocating buffers)
  BYTE *IOBuffer;
  int IOBufferSize;
  
  //Socket the request is on and its address
  SOCKET ClientSocket;
  SOCKADDR_IN ClientSockAddr;
  int AddrLen;
  
  //Should we keep the connection alive?
  BOOL KeepAlive;
};


// Public Functions

/*
Function Name: RequestThread
Purpose: Was the HTTP request processing thread
         Now just a standard procedure called to process a request
Parameters:
           Pointer to packed parameter structure
*/
void RequestThread(RequestThreadMessageT *Parameters);

/*
Function Name: Process 1.0 Request
Purpose: Sends a HTTP 1.0 (plus some) reply to a HTTP 1.x request
Parameters:
    ClientSocket - Socket the client is on
    ClientSockAddr - Address of client
    AddrLen - Length of client address
    RequestInfo - Structure storing the parsed headers
    KeepAlive - To be set to true if we are maintainig the connection
    IOBuffer - Pointer to buffer allocated for IO operations
    TheadNum - Number of calling thread for debugging
Notes: The function uses "Connection: Keep-Alive" as written in the HTTP/1.1
    draft and implemented by Netscape and MSIE
*/
void Process10Request(RequestInfoT &RequestInfo, RequestFieldsT &RequestFields);

#endif