Safe Haskell	None

Happstack.Server.Internal.Types

Synopsis

Documentation

data Request Source

an HTTP request

Constructors

Request

Fields

rqSecure :: Bool: request uses https://
rqMethod :: Method: request method
rqPaths :: [String]: the uri, split on /, and then decoded
rqUri :: String: the raw rqUri
rqQuery :: String: the QUERY_STRING
rqInputsQuery :: [(String, Input)]: the QUERY_STRING decoded as key/value pairs
rqInputsBody :: MVar [(String, Input)]: the request body decoded as key/value pairs (when appropriate)
rqCookies :: [(String, Cookie)]: cookies
rqVersion :: HttpVersion: HTTP version
rqHeaders :: Headers: the HTTP request headers
rqBody :: MVar RqBody: the raw, undecoded request body
rqPeer :: Host: (hostname, port) of the client making the request

Instances

Show Request
Typeable Request

data Response Source

an HTTP Response

Constructors

Response
Fields rsCode :: Int rsHeaders :: Headers rsFlags :: RsFlags rsBody :: ByteString rsValidator :: Maybe (Response -> IO Response)
SendFile
Fields rsCode :: Int rsHeaders :: Headers rsFlags :: RsFlags rsValidator :: Maybe (Response -> IO Response) sfFilePath :: FilePath file handle to send from sfOffset :: Integer offset to start at sfCount :: Integer number of bytes to send

Instances

Show Response
Typeable Response
Error Response
ToMessage Response
Monad m => WebMonad Response (WebT m)
Monad m => WebMonad Response (ServerPartT m)
Monad m => FilterMonad Response (WebT m)
Monad m => FilterMonad Response (ServerPartT m)

newtype RqBody Source

The body of an HTTP Request

Constructors

Body
Fields unBody :: ByteString

Instances

Read RqBody
Show RqBody
Typeable RqBody

data Input Source

a value extract from the QUERY_STRING or Request body

If the input value was a file, then it will be saved to a temporary file on disk and inputValue will contain Left pathToTempFile.

Constructors

Input
Fields inputValue :: Either FilePath ByteString inputFilename :: Maybe FilePath inputContentType :: ContentType

Instances

Read Input
Show Input
Typeable Input
MonadReader RqEnv RqData

data HeaderPair Source

an HTTP header

Constructors

HeaderPair
Fields hName :: ByteString header name hValue :: [ByteString] header value (or values if multiple occurances of the header are present)

Instances

Read HeaderPair
Show HeaderPair

takeRequestBody :: MonadIO m => Request -> m (Maybe RqBody)Source

get the request body from the Request and replace it with Nothing

IMPORTANT: You can really only call this function once. Subsequent calls will return Nothing.

readInputsBody :: Request -> IO (Maybe [(String, Input)])Source

read the request body inputs

This will only work if the body inputs have already been decoded. Otherwise it will return Nothing.

rqURL :: Request -> String Source

Converts a Request into a String representing the corresponding URL

mkHeaders :: [(String, String)] -> Headers Source

Takes a list of (key,val) pairs and converts it into Headers. The keys will be converted to lowercase

getHeader :: HasHeaders r => String -> r -> Maybe ByteString Source

Lookup header value. Key is case-insensitive.

getHeaderBS :: HasHeaders r => ByteString -> r -> Maybe ByteString Source

Lookup header value. Key is a case-insensitive bytestring.

getHeaderUnsafe :: HasHeaders r => ByteString -> r -> Maybe ByteString Source

Lookup header value with a case-sensitive key. The key must be lowercase.

hasHeader :: HasHeaders r => String -> r -> Bool Source

Returns True if the associated key is found in the Headers. The lookup is case insensitive.

hasHeaderBS :: HasHeaders r => ByteString -> r -> Bool Source

Acts as hasHeader with ByteStrings

hasHeaderUnsafe :: HasHeaders r => ByteString -> r -> Bool Source

Acts as hasHeaderBS but the key is case sensitive. It should be in lowercase.

setHeader :: HasHeaders r => String -> String -> r -> rSource

Associates the key/value pair in the headers. Forces the key to be lowercase.

setHeaderBS :: HasHeaders r => ByteString -> ByteString -> r -> rSource

Acts as setHeader but with ByteStrings.

setHeaderUnsafe :: HasHeaders r => ByteString -> HeaderPair -> r -> rSource

Sets the key to the HeaderPair. This is the only way to associate a key with multiple values via the setHeader* functions. Does not force the key to be in lowercase or guarantee that the given key and the key in the HeaderPair will match.

addHeader :: HasHeaders r => String -> String -> r -> rSource

Add a key/value pair to the header. If the key already has a value associated with it, then the value will be appended. Forces the key to be lowercase.

addHeaderBS :: HasHeaders r => ByteString -> ByteString -> r -> rSource

Acts as addHeader except for ByteStrings

addHeaderUnsafe :: HasHeaders r => ByteString -> HeaderPair -> r -> rSource

Add a key/value pair to the header using the underlying HeaderPair data type. Does not force the key to be in lowercase or guarantee that the given key and the key in the HeaderPair will match.

setRsCode :: Monad m => Int -> Response -> m Response Source

Sets the Response status code to the provided Int and lifts the computation into a Monad.

type LogAccess time = String -> String -> time -> String -> Int -> Integer -> String -> String -> IO ()Source

function to log access requests (see also: logMAccess) type LogAccess time = ( String -- ^ host -> String -- ^ user -> time -- ^ time -> String -- ^ requestLine -> Int -- ^ responseCode -> Integer -- ^ size -> String -- ^ referer -> String -- ^ userAgent -> IO ())

logMAccess :: forall t. FormatTime t => LogAccess tSource

log access requests using hslogger and apache-style log formatting

see also: Conf

data Conf Source

HTTP configuration

Constructors

Conf

Fields

port :: Int: Port for the server to listen on.
validator :: Maybe (Response -> IO Response): a function to validate the output on-the-fly
logAccess :: forall t. FormatTime t => Maybe (LogAccess t): function to log access requests (see also: logMAccess)
timeout :: Int: number of seconds to wait before killing an inactive thread
threadGroup :: Maybe ThreadGroup: ThreadGroup for registering spawned threads for handling requests

nullConf :: Conf Source

Default configuration contains no validator and the port is set to 8000

result :: Int -> String -> Response Source

Creates a Response with the given Int as the status code and the provided String as the body of the Response

resultBS :: Int -> ByteString -> Response Source

Acts as result but works with ByteStrings directly.

By default, Transfer-Encoding: chunked will be used

redirect :: ToSURI s => Int -> s -> Response -> Response Source

Sets the Response's status code to the given Int and redirects to the given URI

isHTTP1_0 :: Request -> Bool Source

True if Request is HTTP version 1.0

isHTTP1_1 :: Request -> Bool Source

True if Request is HTTP version 1.1

data RsFlags Source

Result flags

Constructors

RsFlags
Fields rsfLength :: Length

Instances

Read RsFlags
Show RsFlags
Typeable RsFlags

nullRsFlags :: RsFlags Source

Default RsFlags: automatically use Transfer-Encoding: Chunked.

contentLength :: Response -> Response Source

Automatically add a Content-Length header. Do not use Transfer-Encoding: Chunked

chunked :: Response -> Response Source

Do not automatically add a Content-Length header. Do automatically use Transfer-Encoding: Chunked

noContentLength :: Response -> Response Source

Do not automatically add a Content-Length field to the Response

data HttpVersion Source

HTTP version

Constructors

HttpVersion Int Int

Instances

Eq HttpVersion
Read HttpVersion
Show HttpVersion

data Length Source

A flag value set in the Response which controls how the Content-Length header is set, and whether *chunked* output encoding is used.

see also: nullRsFlags, notContentLength, and chunked

Constructors

ContentLength	automatically add a `Content-Length` header to the `Response`
TransferEncodingChunked	do not add a `Content-Length` header. Do use `chunked` output encoding
NoContentLength	do not set `Content-Length` or `chunked` output encoding.

Instances

Enum Length
Eq Length
Ord Length
Read Length
Show Length

data Method Source

HTTP request method

Constructors

GET
HEAD
POST
PUT
DELETE
TRACE
OPTIONS
CONNECT

Instances

Eq Method
Data Method
Ord Method
Read Method
Show Method
Typeable Method
MatchMethod Method
MatchMethod [Method]
MatchMethod (Method -> Bool)

type Headers Source

Arguments

= Map ByteString HeaderPair

lowercased name -> (realname, value)

a Map of HTTP headers

the Map key is the header converted to lowercase

continueHTTP :: Request -> Response -> Bool Source

Should the connection be used for further messages after this. isHTTP1_0 && hasKeepAlive || isHTTP1_1 && hasNotConnectionClose

In addition to this rule All 1xx (informational), 204 (no content), and 304 (not modified) responses MUST NOT include a message-body and therefore are eligible for connection keep-alive.

type Host Source

Arguments

= (String, Int)

(hostname, port)

hostname & port

data ContentType Source

A MIME media type value. The Show instance is derived automatically. Use showContentType to obtain the standard string representation. See http://www.ietf.org/rfc/rfc2046.txt for more information about MIME media types.

Constructors

ContentType

Fields

ctType :: String: The top-level media type, the general type of the data. Common examples are "text", "image", "audio", "video", "multipart", and "application".
ctSubtype :: String: The media subtype, the specific data format. Examples include "plain", "html", "jpeg", "form-data", etc.
ctParameters :: [(String, String)]: Media type parameters. On common example is the charset parameter for the "text" top-level type, e.g. ("charset","ISO-8859-1").

Instances

Eq ContentType
Ord ContentType
Read ContentType
Show ContentType

readDec' :: (Num a, Eq a) => String -> aSource

fromReadS :: [(a, String)] -> Maybe aSource

convert a 'ReadS a' result to 'Maybe a'

readM :: (Monad m, Read t) => String -> m tSource

Read in any monad.

class FromReqURI a whereSource

This class is used by path to parse a path component into a value.

The instances for number types (Int, Float, etc) use readM to parse the path component.

The instance for String, on the other hand, returns the unmodified path component.

See the following section of the Happstack Crash Course for detailed instructions using and extending FromReqURI:

http://www.happstack.com/docs/crashcourse/RouteFilters.html#FromReqURI

Methods

fromReqURI :: String -> Maybe aSource

FromReqURI Bool
FromReqURI Char
FromReqURI Double
FromReqURI Float
FromReqURI Int
FromReqURI Int8
FromReqURI Int16
FromReqURI Int32
FromReqURI Int64
FromReqURI Integer
FromReqURI Word
FromReqURI Word8
FromReqURI Word16
FromReqURI Word32
FromReqURI Word64
FromReqURI String
FromReqURI Text
FromReqURI Text