Web.Simple.Controller.Trans

ControllerT provides a convenient syntax for writting Application code as a Monadic action with access to an HTTP request as well as app specific data (e.g. a database connection pool, app configuration etc.) This module also defines some helper functions that leverage this feature. For example, redirectBack reads the underlying request to extract the referer and returns a redirect response:

    myControllerT = do
      ...
      if badLogin then
        redirectBack
        else
          ...

Documentation

newtype ControllerT s m a

The ControllerT Monad is both a State-like monad which, when run, computes either a Response or a result. Within the ControllerT Monad, the remainder of the computation can be short-circuited by responding with a Response.

Constructors

ControllerT

Fields

runController :: s -> Request -> m (Either Response a, s)

Instances

Monad m => MonadReader Request (ControllerT s m)

Monad m => MonadState s (ControllerT s m)

MonadTrans (ControllerT s)

Monad m => Monad (ControllerT s m)

Functor m => Functor (ControllerT s m)

Monad m => MonadPlus (ControllerT s m)

(Monad m, Functor m) => Applicative (ControllerT s m)

(Functor m, Monad m) => Alternative (ControllerT s m)

MonadPeelIO (ControllerT s IO)

MonadIO m => MonadIO (ControllerT s m)

hoistEither :: Monad m => Either Response a -> ControllerT s m a

request :: Monad m => ControllerT s m Request

Extract the request

localRequest :: Monad m => (Request -> Request) -> ControllerT s m a -> ControllerT s m a

Modify the request for the given computation

controllerState :: Monad m => ControllerT s m s

Extract the application-specific state

putState :: Monad m => s -> ControllerT s m ()

controllerApp :: Monad m => s -> ControllerT s m a -> SimpleApplication m

Convert the controller into an Application

respond :: Monad m => Response -> ControllerT s m a

Provide a response

respond r >>= f === respond r

fromApp :: Monad m => (Request -> m Response) -> ControllerT s m ()

Lift an application to a controller

routeHost :: Monad m => ByteString -> ControllerT s m a -> ControllerT s m ()

Matches on the hostname from the Request. The route only succeeds on exact matches.

routeTop :: Monad m => ControllerT s m a -> ControllerT s m ()

Matches if the path is empty.

Note that this route checks that pathInfo is empty, so it works as expected in nested contexts that have popped components from the pathInfo list.

routeMethod :: Monad m => StdMethod -> ControllerT s m a -> ControllerT s m ()

Matches on the HTTP request method (e.g. GET, POST, PUT)

routeAccept :: Monad m => ByteString -> ControllerT s m a -> ControllerT s m ()

Matches if the request's Content-Type exactly matches the given string

routePattern :: Monad m => Text -> ControllerT s m a -> ControllerT s m ()

Routes the given URL pattern. Patterns can include directories as well as variable patterns (prefixed with :) to be added to queryString (see routeVar)

• /posts/:id
• /posts/:id/new
• /:date/posts/:category/new

routeName :: Monad m => Text -> ControllerT s m a -> ControllerT s m ()

Matches if the first directory in the path matches the given ByteString

routeVar :: Monad m => Text -> ControllerT s m a -> ControllerT s m ()

Always matches if there is at least one directory in pathInfo but and adds a parameter to queryString where the key is the first parameter and the value is the directory consumed from the path.

queryParam

Arguments

:: (Monad m, Parseable a)

=> ByteString

Parameter name

-> ControllerT s m (Maybe a)

Looks up the parameter name in the request's query string and returns the Parseable value or Nothing.

For example, for a request with query string: "?foo=bar&baz=7", queryParam "foo" would return Just bar, but queryParam "zap" would return Nothing.

queryParam' :: (Monad m, Parseable a) => ByteString -> ControllerT s m a

Like queryParam, but throws an exception if the parameter is not present.

queryParams :: (Monad m, Parseable a) => ByteString -> ControllerT s m [a]

Selects all values with the given parameter name

class Parseable a where

The class of types into which query parameters may be converted

Methods

parse :: ByteString -> a

Instances

Parseable String

Parseable ByteString

Parseable Text

readQueryParam

Arguments

:: (Monad m, Read a)

=> ByteString

Parameter name

-> ControllerT s m (Maybe a)

Like queryParam, but further processes the parameter value with read. If that conversion fails, an exception is thrown.

readQueryParam'

Arguments

:: (Monad m, Read a)

=> ByteString

Parameter name

-> ControllerT s m a

Like readQueryParam, but throws an exception if the parameter is not present.

readQueryParams

Arguments

:: (Monad m, Read a)

=> ByteString

Parameter name

-> ControllerT s m [a]

Like queryParams, but further processes the parameter values with read. If any read-conversion fails, an exception is thrown.

readParamValue :: (Monad m, Read a) => ByteString -> Text -> ControllerT s m a

requestHeader :: Monad m => HeaderName -> ControllerT s m (Maybe ByteString)

Returns the value of the given request header or Nothing if it is not present in the HTTP request.

redirectBack :: Monad m => ControllerT s m ()

Redirect back to the referer. If the referer header is not present redirect to root (i.e., /).

redirectBackOr

Arguments

:: Monad m

=> Response

Fallback response

-> ControllerT s m ()

Redirect back to the referer. If the referer header is not present fallback on the given Response.

type SimpleApplication m = Request -> m Response

Like Application, but with m as the underlying monad

type SimpleMiddleware m = SimpleApplication m -> SimpleApplication m

Like Application, but with m as the underlying monad

guard :: Monad m => Bool -> ControllerT s m a -> ControllerT s m ()

guardM :: Monad m => ControllerT s m Bool -> ControllerT s m a -> ControllerT s m ()

guardReq :: Monad m => (Request -> Bool) -> ControllerT s m a -> ControllerT s m ()

data ControllerException

Constructors

ControllerException String

Instances

Show ControllerException

Typeable ControllerException

Exception ControllerException

err :: String -> ControllerT s m a

The most basic Routeable types are Application and Response. Reaching either of these types marks a termination in the routing lookup. This module exposes a monadic type Route which makes it easy to create routing logic in a DSL-like fashion.

Routes are concatenated using the >> operator (or using do-notation). In the end, any Routeable, including a Route is converted to an Application and passed to the server using mkRoute:

mainAction :: ControllerT () ()
  mainAction = ...

signinForm :: ControllerT () ()
  signinForm req = ...

login :: ControllerT () ()
  login = ...

updateProfile :: ControllerT () ()
  updateProfile = ...

main :: IO ()
  main = run 3000 $ controllerApp () $ do
    routeTop mainAction
    routeName "sessions" $ do
      routeMethod GET signinForm
      routeMethod POST login
    routeMethod PUT $ routePattern "users/:id" updateProfile
    routeAll $ responseLBS status404 [] "Are you in the right place?"