Network.Wai.Application.Classic

WAI (Web Application Interface) Application for static files and CGI.

Common

data ClassicAppSpec

Constructors

ClassicAppSpec

Fields

• softwareName :: ByteString

  Name specified to Server: in HTTP response.

• statusFileDir :: Path

  A function to get HTTP's GMT Date.

defaultClassicAppSpec :: ClassicAppSpec

Default value for ClassicAppSpec. softwareName is "Classic". dater calls epochTime for every request. statusFileDir is "/usr/local/share/html/status/".

data StatusInfo

Constructors

StatusByteString ByteString

HTTP status body is created from ByteString.

StatusFile Path Integer

HTTP status body is created from FilePath.

StatusNone

No HTTP status body.

Instances

Eq StatusInfo

Methods

(==) :: StatusInfo -> StatusInfo -> Bool

(/=) :: StatusInfo -> StatusInfo -> Bool

Show StatusInfo

Methods

showsPrec :: Int -> StatusInfo -> ShowS

show :: StatusInfo -> String

showList :: [StatusInfo] -> ShowS

Files

data FileAppSpec

Constructors

FileAppSpec

Fields

• indexFile :: Path

  A file name of an index file.

• isHTML :: Path -> Bool

  Whether this is an HTML or not.

defaultFileAppSpec :: FileAppSpec

Default value for defaultFileAppSpec. indexFile is "index.html". isHTML matches "*.html" and "*.html".

data FileRoute

Constructors

FileRoute

Fields

• fileSrc :: Path

  Path prefix to be matched to rawPathInfo.

• fileDst :: Path

  Path prefix to an actual file system.

Instances

Eq FileRoute

Methods

(==) :: FileRoute -> FileRoute -> Bool

(/=) :: FileRoute -> FileRoute -> Bool

Show FileRoute

Methods

showsPrec :: Int -> FileRoute -> ShowS

show :: FileRoute -> String

showList :: [FileRoute] -> ShowS

fileApp :: ClassicAppSpec -> FileAppSpec -> FileRoute -> Application

Handle GET and HEAD for a static file.

If pathInfo ends with '/', indexFile is automatically added. In this case, Acceptable-Language: is also handled. Suppose indexFile is "index.html" and if the value is "ja,en", then "index.html.ja", "index.html.en", and "index.html" are tried to be opened in order.

If pathInfo does not end with '/' and a corresponding index file exist, redirection is specified in HTTP response.

Directory contents are NOT automatically listed. To list directory contents, an index file must be created beforehand.

The following HTTP headers are handled: Acceptable-Language:, If-Modified-Since:, Range:, If-Range:, If-Unmodified-Since:.

Redirect

data RedirectRoute

Constructors

RedirectRoute

Fields

• redirectSrc :: Path

  Path prefix to be matched to rawPathInfo.

• redirectDst :: Path

  Path prefix to an actual file system.

Instances

Eq RedirectRoute

Methods

(==) :: RedirectRoute -> RedirectRoute -> Bool

(/=) :: RedirectRoute -> RedirectRoute -> Bool

Show RedirectRoute

Methods

showsPrec :: Int -> RedirectRoute -> ShowS

show :: RedirectRoute -> String

showList :: [RedirectRoute] -> ShowS

redirectApp :: ClassicAppSpec -> RedirectRoute -> Application

CGI

data CgiAppSpec

Constructors

CgiAppSpec

Fields

• indexCgi :: Path

  A file name of the default CGI.

Instances

Eq CgiAppSpec

Methods

(==) :: CgiAppSpec -> CgiAppSpec -> Bool

(/=) :: CgiAppSpec -> CgiAppSpec -> Bool

Show CgiAppSpec

Methods

showsPrec :: Int -> CgiAppSpec -> ShowS

show :: CgiAppSpec -> String

showList :: [CgiAppSpec] -> ShowS

defaultCgiAppSpec :: CgiAppSpec

Default value for defaultCgiAppSpec. indexCgi is "index.cgi".

data CgiRoute

Constructors

CgiRoute

Fields

• cgiSrc :: Path

  Path prefix to be matched to rawPathInfo.

• cgiDst :: Path

  Path prefix to an actual file system.

Instances

Eq CgiRoute

Methods

(==) :: CgiRoute -> CgiRoute -> Bool

(/=) :: CgiRoute -> CgiRoute -> Bool

Show CgiRoute

Methods

showsPrec :: Int -> CgiRoute -> ShowS

show :: CgiRoute -> String

showList :: [CgiRoute] -> ShowS

cgiApp :: ClassicAppSpec -> CgiAppSpec -> CgiRoute -> Application

Handle GET and POST for CGI.

The program to link this library must ignore SIGCHLD as follows:

  installHandler sigCHLD Ignore Nothing

Reverse Proxy

data RevProxyAppSpec

Constructors

RevProxyAppSpec

Fields

• revProxyManager :: Manager

  Connection manager

data RevProxyRoute

Constructors

RevProxyRoute

Fields

• revProxySrc :: Path

  Path prefix to be matched to rawPathInfo.

• revProxyDst :: Path

  Destination path prefix.

• revProxyDomain :: ByteString

  Destination domain name.

• revProxyPort :: Int

  Destination port number.

Instances

Eq RevProxyRoute

Methods

(==) :: RevProxyRoute -> RevProxyRoute -> Bool

(/=) :: RevProxyRoute -> RevProxyRoute -> Bool

Show RevProxyRoute

Methods

showsPrec :: Int -> RevProxyRoute -> ShowS

show :: RevProxyRoute -> String

showList :: [RevProxyRoute] -> ShowS

revProxyApp :: ClassicAppSpec -> RevProxyAppSpec -> RevProxyRoute -> Application

Relaying any requests as reverse proxy.

Path

type Path = ByteString

File path.

pathString :: Path -> String

fromString :: IsString a => String -> a

(</>) :: Path -> Path -> Path

Appending with the file separator.

>>> "/foo" </> "bar"
"/foo/bar"
>>> "/foo/" </> "bar"
"/foo/bar"
>>> "/foo" </> "/bar"
"/foo/bar"
>>> "/foo/" </> "/bar"
"/foo/bar"

(<\>) :: Path -> Path -> Path

Removing prefix. The prefix of the second argument is removed from the first argument.

>>> "foobar" <\> "foo"
"bar"
>>> "foo" <\> "foobar"
""
>>> "foobar" <\> "baz"
"bar"

(<.>) :: Path -> Path -> Path

Adding suffix.

breakAtSeparator :: Path -> (Path, Path)

Breaking at the first path separator.

>>> breakAtSeparator "/foo/bar/baz"
("","/foo/bar/baz")
>>> breakAtSeparator "foo/bar/baz"
("foo","/bar/baz")
>>> breakAtSeparator "foo"
("foo","")

hasLeadingPathSeparator :: Path -> Bool

Checking if the path ends with the path separator.

>>> hasLeadingPathSeparator "/foo/bar"
True
>>> hasLeadingPathSeparator "foo/bar"
False

hasTrailingPathSeparator :: Path -> Bool

Checking if the path ends with the path separator.

>>> hasTrailingPathSeparator "/foo/bar/"
True
>>> hasTrailingPathSeparator "/foo/bar"
False

isSuffixOf :: Path -> Path -> Bool

Misc

redirectHeader :: Request -> ResponseHeaders

hostPort :: Request -> (ByteString, ByteString)