sister
 All Files Functions
Functions
i4httools.h File Reference

Miscellaneous routines for building an HTTP server. More...

#include <stdio.h>

Go to the source code of this file.

Functions

int checkPath (const char relPath[])
 Checks if a relative path leaves the root directory.
void httpOK (FILE *tx)
 Outputs an "OK" HTTP response to a stream.
void httpMovedPermanently (FILE *tx, const char newRelPath[])
 Outputs a "moved permanently" HTTP response and error page to a stream.
void httpBadRequest (FILE *tx)
 Outputs a "bad request" HTTP response and error page to a stream.
void httpForbidden (FILE *tx, const char relPath[])
 Outputs a "forbidden" HTTP response and error page to a stream.
void httpNotFound (FILE *tx, const char relPath[])
 Outputs a "not found" HTTP response and error page to a stream.
void httpInternalServerError (FILE *tx, const char relPath[])
 Outputs an "internal server error" HTTP response and error page to a stream.

Detailed Description

Miscellaneous routines for building an HTTP server.

This module contains some routines that are useful for implementing a web server.

Function Documentation

int checkPath ( const char  relPath[])

Checks if a relative path leaves the root directory.

This routine checks if the relative path component of a request ascends the VFS beyond the root directory. Such requests should not be served.

Note
This function stops processing as soon as the path ascends beyond the root of the web directory.
Parameters
relPathRequested URL.
Returns
Positive depth of the request relative to the web directory, or -1 if the relative URL ascends beyond the web directory.
void httpBadRequest ( FILE *  tx)

Outputs a "bad request" HTTP response and error page to a stream.

This routine generates an "HTTP/1.0 400 Bad Request" status line and a corresponding HTML error page on the given stream, which should normally be the client connection.

Parameters
txThe output stream.
void httpForbidden ( FILE *  tx,
const char  relPath[] 
)

Outputs a "forbidden" HTTP response and error page to a stream.

This routine generates an "HTTP/1.0 403 Forbidden" status line and a corresponding HTML error page on the given stream, which should normally be the client connection.

Parameters
txThe output stream.
relPathRequested URL.
void httpInternalServerError ( FILE *  tx,
const char  relPath[] 
)

Outputs an "internal server error" HTTP response and error page to a stream.

This routine generates an "HTTP/1.0 500 Internal Server Error" status line and a corresponding HTML error page on the given stream, which should normally be the client connection.

Parameters
txThe output stream.
relPathRequested URL. May be NULL if not applicable.
void httpMovedPermanently ( FILE *  tx,
const char  newRelPath[] 
)

Outputs a "moved permanently" HTTP response and error page to a stream.

This routine generates a "moved permanently (301)" HTTP response on the given stream, which should normally be the client connection.

Parameters
txThe output stream.
newRelPathPath to which the request is redirected.
Note
This function is not needed for assignment 2 (sister), only for assignment 5 (mother).
void httpNotFound ( FILE *  tx,
const char  relPath[] 
)

Outputs a "not found" HTTP response and error page to a stream.

This routine generates an "HTTP/1.0 404 Not Found" status line and a corresponding HTML error page on the given stream, which should normally be the client connection.

Parameters
txThe output stream.
relPathRequested URL.
void httpOK ( FILE *  tx)

Outputs an "OK" HTTP response to a stream.

This routine generates an "OK (200)" status line on the given stream, which should normally be the client connection.

Parameters
txThe output stream.