This is the default handler environment. It takes care of request parsing (hRequestParser), response printing (hResponsePrinter), connection keep-alives (hKeepAlive), handling HEAD requests (hHead) and printing the `salvia-httpd` server banner (hBanner).

Like hDefaultEnv but only serves one request per connection.

Like the hParser but always parses HTTP Requestss.

Like the hParser but always parses HTTP Responses.

The hParser handler is used to parse the raw HTTP message into the Message data type. This handler is generally used as (one of) the first handlers in a client or server environment. The first handler argument is executed when the message is invalid, possibly due to parser errors, and is parametrized with the error string. The second handler argument is executed when the message is valid. When the message could not be parsed within the time specified with the first argument the function silently returns.

The hResponsePrinter handler prints the entire HTTP response including the headers and the body to the socket towards the client. This handler is generally used as (one of) the last handler in a client environment.

The hRequestPrinter handler prints the entire HTTP request including the headers and the body to the socket towards the server. This handler is generally used as (one of) the last handler in a server environment.

Send all the message headers directly over the socket.

todo: printer for rawResponse over response!!

Like hFlushHeaders but does not print status line, can be useful for CGI mode.

Like hFlushHeaders but specifically for the request headers.

Like hFlushHeaders but specifically for the response headers.

One by one apply all enqueued send actions to the socket.

Like hRawBody but specifically for Http Requests.

Like hRawBody but specifically for Http Requests.

First (possibly naive) handler to retreive the client request or server response body as a raw lazy ByteString. This probably does not handle all the quirks that the HTTP protocol specifies, but it does the job for now. When a contentLength header field is available only this fixed number of bytes will read from the socket. When neither the keepAlive and contentLength header fields are available the entire payload of the request will be read from the socket. The function is parametrized with a the direction of the HTTP message, client request or server response.

Like hBodyText but specifically for Http Requests.

Like hBodyText but specifically for Http Responses.

Like the hRawBody but is will handle proper decoding based on the charset part of the contentType header line. When a valid encoding is found in the Http message it will be decoded with using the encodings package. The default encoding supplied as the function's argument can be used to specify what encoding to use in the absence of a proper encoding in the HTTP message itself.

Like hBodyStringUTF8 but specifically for Http Requests.

Like hBodyStringUTF8 but specifically for Http Responses.

Like the hRawBody but decodes it as UTF-8 to a String.

Like hParameters but specifically for HTTP Requests.

Like hParameters but specifically for HTTP Responses.

Try to parse the message body, as a result of hBodyText, as URI encoded POST parameters. Returns as a URI Parameter type or nothing when parsing fails.

The hBanner handler adds the current date-/timestamp and a custom server name to the response headers.

Run a handler once and close the connection afterwards.

Run a handler and keep the connection open for potential consecutive requests. The connection will only be closed after a request finished and one or more of the following criteria are met:

• There is no contentLength set in the response headers. When this is the case the connection cannot be kept alive.
• The client has set the connection header field to close.
• The connection has already been closed, possible due to IO errors.
• The HTTP version is HTTP/1.0.

The hHead handler makes sure no HTTP Response body is sent to the client when the request is an HTTP HEAD request. In the case of a HEAD request the specified sub handler will be executed under the assumption that the request was a GET request, otherwise this handler will act as the identify function.

The hError handler enables the creation of a default style of error responses for the specified HTTP Status code.

Like hError but with a custom error message.

Map an IOError to a default style error response.

The mapping from an IO error to an error response is rather straightforward:

  | isDoesNotExistError e = hError NotFound
  | isAlreadyInUseError e = hError ServiceUnavailable
  | isPermissionError   e = hError Forbidden
  | True                  = hError InternalServerError

Execute an handler with the result of an IO action. When the IO actions fails a default error handler will be executed.

A simple logger that prints a summery of the request information to the specified file handle.

Dump the request headers to the standard output, useful for debugging.

Dump the response headers to the standard output, useful for debugging.

Redirect a client to another location by creating a MovedPermanently response message with the specified URI in the location header.

Run an handler in a modified context in which the request Uri has been changed by the specified modifier function. After the handler completes the Uri remains untouched.

Run handler in a context with a modified host.

Run handler in a context with a modified path.

Run handler in a context with a modified file extension.

Run handler in a context with a modified path. The specified prefix will be prepended to the path.

Run handler in a context with a modified path. The specified prefix will be stripped from the path.

Serve a file from the filesystem indicated by the specified filepath. When there is some kind of IOError the hSafeIO function will be used to produce a corresponding error response. The contentType will be the mime-type based on the filename extension using the mimetype function. The contentLength will be set the file's size.

Like the hFileResource handler, but with a custom filter over the content. This function will assume the content is an UTF-8 encoded text file. Because of the possibly unpredictable behavior of the filter, no contentLength header will be set using this handler.

Turn a handler that is parametrized by a file resources into a regular handler that utilizes the path part of the request URI as the resource identifier.

Turn a handler that is parametrized by a URI into a regular handler that utilizes the request URI as the resource identifier.

Like hFileResource but uses the path of the current request URI.

Like hFileResourceFilter but uses the path of the current request URI.

Like hDirectoryResource but uses the path from the current request URI.

Serve a simple HTML directory listing for the specified directory on the filesystem.

Dispatch based on file type; regular files or directories. The first handler specified will be invoked in case the resource to be served is an directory, the second handler otherwise. The path from the request URI will be appended to the directory resource specified as a parameter, this new path will be used to lookup the real resource on the file system. Every request will be jailed in the specified directory resource to prevent users from requesting arbitrary parts of the file system.

Serve single directory by combining the hDirectoryResource and hFileResource handlers in the hFileTypeDispatcher.

Serve single directory like hFileSystem but do not show directory indices. Instead of an directory index an Forbidden response will be created.

Create a browseable filesystem handler (like hFileSystem) but make all files writeable by a PUT request. Files that do not exists will be created as long as the directory in which they will be created exists.

Invokes the hStore handler when the request is a PUT request and invokes the fallback handler otherwiser.

This handler takes a FilePath and will try to store the entire request body in that file. When the request body could for some reason not be fetch a BadRequest error response will be created. When an IO error occurs the hIOError function is used to setup an apropriate response.

HTTP Range datatype.

Access the Content-Range header field.

Access the Range header field.

Lens containing parser and pretty-printer for HTTP ranges.

Handler to run CGI scripts.

The dispatcher type takes one value to dispatch on and two handlers. The first handler will be used when the predicate on the dispatch value returned True, the second (default) handler will be used when the predicate returs False.

A list dispatcher takes a mapping from dispatch values to handlers and one default fallback handler.

Dispatch on an arbitrary part of the context using an arbitrary predicate. When the predicate returns true on the value selected with the Label the first handler will be invoked, otherwise the second handler will be used.

Like the hDispatch but always dispatches on a (part of) the `HTTP Request' part of the context.

Turns a dispatcher function into a list dispatcher. This enables handler routing based on arbitrary values from the context. When non of the predicates in the ListDispatcher type hold the default handler will be invoked.

Request dispatcher based on the HTTP request Method.

Request list dispatcher based on the hMethod dispatcher.

Request dispatcher based on the request path.

List dispatcher version of hPath.

Request dispatcher based on a prefix of the request path.

List dispatcher version of hPrefix.

Helper function to fetch the URI parameters from the request.

Request dispatcher based on the request path file extenstion.

List dispatcher version of hExtension.

Dispatcher based on the host part of the hostname request header. Everything not part of the real hostname (like the port number) will be ignored. When the expected hostname starts with a dot (like .mydomain.com) this indicates that all sub-domains of this domain will match as well.

Dispatcher based on the port number of the hostname request header. When no port number is available in the hostname header port 80 will be assumed.

Set the `Set-Cookie` HTTP response header with the specified Cookies.

Try to get the cookies from the HTTP cookie request header.

Delete one cookie by removing it from the `Set-Cookie' header.

Convenient method for creating cookies that expire in the near future and are bound to the domain and port this server runs on. The path will be locked to root. If the second argument is set, the cookie will be valid for all subdomains.