cgi-3001.1.7.5: A library for writing CGI programs

Portabilitynon-portable
Stabilityexperimental
MaintainerAnders Kaseorg <andersk@mit.edu>
Safe HaskellNone

Network.CGI.Protocol

Contents

Description

An implementation of the program side of the CGI protocol.

Synopsis

CGI request

data CGIRequest Source

The input to a CGI action.

Constructors

CGIRequest 

Fields

cgiVars :: Map String String

Environment variables.

cgiInputs :: [(String, Input)]

Input parameters. For better laziness in reading inputs, this is not a Map.

cgiRequestBody :: ByteString

Raw request body. To avoid memory leaks, this is the empty string if the request body has been interpreted as inputs in application/x-www-form-urlencoded or multipart/form-data format.

Instances

Show CGIRequest 

data Input Source

The value of an input parameter, and some metadata.

Constructors

Input 

Fields

inputValue :: ByteString
 
inputFilename :: Maybe String
 
inputContentType :: ContentType
 

Instances

Show Input 

CGI response

data CGIResult Source

The result of a CGI program.

Constructors

CGIOutput ByteString 
CGINothing 

Instances

Eq CGIResult 
Ord CGIResult 
Read CGIResult 
Show CGIResult 
Typeable CGIResult 

type Headers = [(HeaderName, String)]Source

HTTP headers.

newtype HeaderName Source

A string with case insensitive equality and comparisons.

Constructors

HeaderName String 

Instances

Running CGI actions

hRunCGISource

Arguments

:: MonadIO m 
=> [(String, String)]

CGI environment variables, e.g. from getCGIVars.

-> Handle

Handle that input will be read from, e.g. stdin.

-> Handle

Handle that output will be written to, e.g. stdout.

-> (CGIRequest -> m (Headers, CGIResult))

CGI action

-> m () 

Runs a CGI action in a given environment. Uses Handles for input and output.

runCGIEnvFPSSource

Arguments

:: Monad m 
=> [(String, String)]

CGI environment variables.

-> ByteString

Request body.

-> (CGIRequest -> m (Headers, CGIResult))

CGI action.

-> m ByteString

Response (headers and content).

Runs a CGI action in a given environment. Uses lazy ByteStrings for input and output.

Inputs

decodeInputSource

Arguments

:: [(String, String)]

CGI environment variables.

-> ByteString

Request body.

-> ([(String, Input)], ByteString)

A list of input variables and values, and the request body if it was not interpreted.

Gets and decodes the input according to the request method and the content-type.

takeInputSource

Arguments

:: [(String, String)]

CGI environment variables.

-> ByteString

Request body.

-> ByteString

CONTENT_LENGTH bytes from the request body, or the empty string if there is no CONTENT_LENGTH.

Takes the right number of bytes from the input.

Environment variables

getCGIVars :: MonadIO m => m [(String, String)]Source

Gets the values of all CGI variables from the program environment.

Logging

logCGI :: MonadIO m => String -> m ()Source

Logs some message using the server's logging facility. FIXME: does this have to be more general to support FastCGI etc? Maybe we should store log messages in the CGIState?

URL encoding

formEncode :: [(String, String)] -> StringSource

Formats name-value pairs as application/x-www-form-urlencoded.

urlEncode :: String -> StringSource

Converts a single value to the application/x-www-form-urlencoded encoding.

formDecode :: String -> [(String, String)]Source

Gets the name-value pairs from application/x-www-form-urlencoded data.

urlDecode :: String -> StringSource

Converts a single value from the application/x-www-form-urlencoded encoding.

Utilities

maybeRead :: Read a => String -> Maybe aSource

replaceSource

Arguments

:: Eq a 
=> a

Value to look for

-> a

Value to replace it with

-> [a]

Input list

-> [a]

Output list

Replaces all instances of a value in a list by another value.