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.

logger :: Request -> Status -> Maybe Integer -> IO ()

A function for logging. The third argument is a body size.

statusFileDir :: Path

A function to get HTTP's GMT Date.

defaultClassicAppSpec :: ClassicAppSpec

Default value for ClassicAppSpec. softwareName is "Classic". logger does not log at all. 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

Show StatusInfo

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.

getFileInfo :: Path -> IO FileInfo

A function to obtain information about a file. If information is not obtained, an IO exception should be raised.

defaultFileAppSpec :: FileAppSpec

Default value for defaultFileAppSpec. indexFile is "index.html". isHTML matches "*.html" and "*.html". getFileInfo calls getFileStatus for every request.

data FileInfo

Constructors

FileInfo

Fields

fileInfoName :: !Path

fileInfoSize :: !Integer

fileInfoTime :: !HTTPDate

fileInfoDate :: !ByteString

Instances

Eq FileInfo

Show FileInfo

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

Show FileRoute

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

Show RedirectRoute

redirectApp :: ClassicAppSpec -> RedirectRoute -> Application

CGI

data CgiAppSpec

Constructors

CgiAppSpec

Fields

indexCgi :: Path

A file name of the default CGI.

Instances

Eq CgiAppSpec

Show CgiAppSpec

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

Show CgiRoute

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

Show RevProxyRoute

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

Relaying any requests as reverse proxy.

Path

data Path

Smart file path.

Constructors

Path

Fields

pathString :: FilePath

pathByteString :: ByteString

Instances

Eq Path

Show Path

IsString Path

fromString :: IsString a => String -> a

fromByteString :: ByteString -> Path

(+++) :: Path -> Path -> Path

Appending.

(</>) :: 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)