HTTP
[User Protocols]


Detailed Description

Hypertext transfer protocol.


Data Structures

struct  _AUTHINFO
 HTTP authorization information structure. More...
struct  _AUTHINFO
 HTTP authorization information structure. More...
struct  _CGIFUNCTION
 Registered CGI function. More...
struct  _CGIFUNCTION
 Registered CGI function. More...
struct  _REQUEST
 HTTP request information structure. More...
struct  _REQUEST
 HTTP request information structure. More...

Defines

#define BUFSIZE   512
#define MAX_ASP_FUNC_SIZE   64
#define MAX_BUFFER_SIZE   256
#define METHOD_GET   1
#define METHOD_HEAD   3
#define METHOD_POST   2
#define MIN(a, b)   (a<b?a:b)
#define SSI_TYPE_EXEC   0x03
#define SSI_TYPE_FILE   0x01
#define SSI_TYPE_VIRTUAL   0x02

Typedefs

typedef typedef__END_DECLS
struct _AUTHINFO 
AUTHINFO
typedef typedef__END_DECLS
struct _CGIFUNCTION 
CGIFUNCTION
typedef _REQUEST REQUEST

Enumerations

enum  { ASP_STATE_IDLE = 0, ASP_STATE_START, ASP_STATE_COPY_FUNC }

Functions

void NutCgiProcessRequest (FILE *stream, REQUEST *req)
 Process an incoming CGI request.
void NutClearAuth (void)
 Clear all authorization entries.
void * NutGetMimeHandler (char *name)
 Return the mime type handler of a specified file name.
char * NutGetMimeType (char *name)
 Return the mime type description of a specified file name.
__BEGIN_DECLS int NutHttpAuthValidate (REQUEST *req)
 Validate an authorization request.
char * NutHttpGetParameter (REQUEST *req, char *name)
 Gets a request parameter value by name.
int NutHttpGetParameterCount (REQUEST *req)
 Gets the number of request parameters.
char * NutHttpGetParameterName (REQUEST *req, int index)
 Gets the name of a request parameter.
char * NutHttpGetParameterValue (REQUEST *req, int index)
 Get the value of a request paramter.
void NutHttpProcessAsp (FILE *stream, int fd, int file_len, char *http_root, REQUEST *req)
void NutHttpProcessPostQuery (FILE *stream, REQUEST *req)
 Parses the QueryString.
void NutHttpProcessQueryString (REQUEST *req)
 Parses the QueryString.
__BEGIN_DECLS void NutHttpProcessRequest (FILE *stream)
 Process the next HTTP request.
void NutHttpSendError (FILE *stream, REQUEST *req, int status)
 Send a HTTP error response.
void NutHttpSendHeaderBot (FILE *stream, char *mime_type, long bytes)
 Send bottom lines of a standard HTML header.
void NutHttpSendHeaderTop (FILE *stream, REQUEST *req, int status, char *title)
 Send top lines of a standard HTML header.
void NutHttpURLDecode (char *str)
 URLDecodes a string.
char * NutHttpURLEncode (char *str)
void NutRegisterAsp (void)
 Register ASP handler for asp files.
int NutRegisterAspCallback (int(*func)(char *, FILE *))
int NutRegisterAuth (CONST char *dirname, CONST char *login)
 Register an authorization entry.
int NutRegisterCgi (char *name, int(*func)(FILE *, REQUEST *))
 Register a CGI function.
int NutRegisterHttpRoot (char *path)
 Register the HTTP server's root directory.
__BEGIN_DECLS void NutRegisterSsi (void)
 Register SSI handler for shtml files.
u_char NutSetMimeHandler (char *extension, void(*handler)(FILE *stream, int fd, int file_len, char *http_root, REQUEST *req))
 Set the mime type handler for a specified file extension.

Variables

AUTHINFO * authList = 0
CGIFUNCTION *volatile cgiFunctionList = 0
CONFNET confnet
 Global network configuration structure.


Function Documentation

void NutCgiProcessRequest ( FILE stream,
REQUEST req 
)

Process an incoming CGI request.

Applications do not need to call this function. It is automatically called by NutHttpProcessRequest().

Parameters:
stream Stream of the socket connection, previously opened for binary read and write.
req Contains the HTTP request.

void NutClearAuth ( void   ) 

Clear all authorization entries.

Clears all authorization entries and frees the used ressouces.

void * NutGetMimeHandler ( char *  name  ) 

Return the mime type handler of a specified file name.

This is the function that handles / sends a specific file type to the client. Escpecialy used for server side includes (shtml files)

Parameters:
name Name of the file.
Returns:
A pointer to a function of the type void (u_char * filename) If the extension is not registered, the handler for "text/plain; charset=iso-8859-1" is returned. If the filename is empty, then the handler for "text/html; charset=iso-8859-1" is returned.

char * NutGetMimeType ( char *  name  ) 

Return the mime type description of a specified file name.

The mime type returned is based on the file extension.

Parameters:
name Name of the file.
Returns:
A pointer to a static string, containing the associated mime type description. If the extension is not registered, "text/plain; charset=iso-8859-1" is returned. If the filename is empty, then "text/html; charset=iso-8859-1" is returned.

int NutHttpAuthValidate ( REQUEST req  ) 

Validate an authorization request.

Note:
This function is automatically called by the HTTP library on incoming requests. Applications do not need to call this function.
Parameters:
req Request to be checked.
Returns:
0, if access granted, -1 otherwise.

char* NutHttpGetParameter ( REQUEST req,
char *  name 
)

Gets a request parameter value by name.

Parameters:
req Request object
name Name of parameter
Returns:
Pointer to the parameter value.

int NutHttpGetParameterCount ( REQUEST req  ) 

Gets the number of request parameters.

Parameters:
req Request object
Returns:
The number of request parameters

char* NutHttpGetParameterName ( REQUEST req,
int  index 
)

Gets the name of a request parameter.

Parameters:
req Request object
index Index of the requested parameter.
Returns:
Pointer to the parameter name at the given index, or NULL if index is out of range.

char* NutHttpGetParameterValue ( REQUEST req,
int  index 
)

Get the value of a request paramter.

Parameters:
req Request object
index Index to the requested parameter.
Returns:
Pointer to the paramter value at the given index, or NULL if index is out of range.

void NutHttpProcessPostQuery ( FILE stream,
REQUEST req 
)

Parses the QueryString.

Reads the query from input stream and parses it into name/value table. To save RAM, this method allocated ram and uses req_query to store the input data. Then it creates a table of pointers into the req_query buffer.

Parameters:
stream Input stream
req Request object to parse

void NutHttpProcessQueryString ( REQUEST req  ) 

Parses the QueryString.

Reads the QueryString from a request, and parses it into name/value table. To save RAM, this method overwrites the contents of req_query, and creates a table of pointers into the req_query buffer.

Parameters:
req Request object to parse

void NutHttpProcessRequest ( FILE stream  ) 

Process the next HTTP request.

Waits for the next HTTP request on an established connection and processes it.

Parameters:
stream Stream of the socket connection, previously opened for binary read and write.

void NutHttpSendError ( FILE stream,
REQUEST req,
int  status 
)

Send a HTTP error response.

A canned error file is used.

Parameters:
stream Stream of the socket connection, previously opened for binary read and write.
req Contains the HTTP request.
status Error code to be returned.

void NutHttpSendHeaderBot ( FILE stream,
char *  mime_type,
long  bytes 
)

Send bottom lines of a standard HTML header.

Sends Content-Type, Content-Lenght and Connection lines.

Parameters:
stream Stream of the socket connection, previously opened for binary read and write.
mime_type Points to a string that specifies the content type. Examples are "text/html", "image/png", "image/gif", "video/mpeg" or "text/css". A null pointer is ignored.
bytes Content length of the data following this header. Ignored, if negative.

void NutHttpSendHeaderTop ( FILE stream,
REQUEST req,
int  status,
char *  title 
)

Send top lines of a standard HTML header.

Sends HTTP and Server version lines.

Parameters:
stream Stream of the socket connection, previously opened for binary read and write.
req The associated client request.
status Response status, error code or 200, if no error occured.
title Error text, or OK, if no error occured.

void NutHttpURLDecode ( char *  str  ) 

URLDecodes a string.

Takes a url-encoded string and decodes it.

Parameters:
str String to decode. This is overwritten with the decoded string
Warning:
To save RAM, the str parameter will be overwritten with the encoded string.

void NutRegisterAsp ( void   ) 

Register ASP handler for asp files.

asp files may use the following syntax:

<my_function%>

int NutRegisterAuth ( CONST char *  dirname,
CONST char *  login 
)

Register an authorization entry.

Protect a specified directory from unauthorized access.

Warning:
Directories not registered by this function are accessible by anyone.
Parameters:
dirname Name of the directory to protect.
login Required login to access this directory. This string must contain a user name, followed by a colon followed by an uncrypted password.
Returns:
0 on success, -1 otherwise.

int NutRegisterCgi ( char *  name,
int(*)(FILE *, REQUEST *)  func 
)

Register a CGI function.

Todo:
Duplicate names not checked.
Parameters:
name Name of this CGI function.
func The function to be called, if the client requests the specified name.
Returns:
0 on success, -1 otherwise.

int NutRegisterHttpRoot ( char *  path  ) 

Register the HTTP server's root directory.

Only one root directory is supported. Subsequent calls will override previous settings.

Parameters:
path Pathname of the root directory. Must include the device name followed by a colon followed by a directory path followed by a trailing slash.
Returns:
0 on success, -1 otherwise.

void NutRegisterSsi ( void   ) 

Register SSI handler for shtml files.

shtml files may use the following ssi commands:

u_char NutSetMimeHandler ( char *  extension,
void(*)(FILE *stream, int fd, int file_len, char *http_root, REQUEST *req)  handler 
)

Set the mime type handler for a specified file extension.

This is the function that handles / sends a specific file type to the client. Escpecialy used for server side includes (shtml files)

Parameters:
extension Filename extension the handler should be registered for
handler pointer to a function of the type void (u_char filename)
Returns:
1 on error or 0 on success


Variable Documentation

CONFNET confnet

Global network configuration structure.

Contains the current network configuration. Nut/Net will load this structure from non-volatile memory during initialization.


Generated on Tue Jan 23 21:12:26 2007 for BTnut System Software by doxygen 1.4.7