Safe Haskell	None

Clckwrks.Monad

Synopsis

Documentation

type Clck url = ClckT url (ServerPartT IO)Source

type ClckPlugins = Plugins Theme (ClckT ClckURL (ServerPartT IO) Response) (ClckT ClckURL IO ()) ClckwrksConfig ClckPluginsSt Source

ClckPlugins

newtype Plugins theme m hook config st

data ClckPluginsSt Source

initialClckPluginsSt :: ClckPluginsSt Source

newtype ClckT url m a Source

Constructors

ClckT
Fields unClckT :: RouteT url (StateT ClckState m) a

Instances

FilterMonad r m => FilterMonad r (ClckT url m)
WebMonad r m => WebMonad r (ClckT url m)
Monad m => MonadState ClckState (ClckT url m)
MonadTrans (ClckT url)
IsName n Text => EmbedAsAttr (Clck AdminURL) (Attr n AdminURL)
IsName n Text => EmbedAsAttr (Clck ClckURL) (Attr n ClckURL)
Monad m => Monad (ClckT url m)
Functor m => Functor (ClckT url m)
MonadPlus m => MonadPlus (ClckT url m)
(Monad m, Functor m) => Applicative (ClckT url m)
(Functor m, MonadPlus m) => Alternative (ClckT url m)
Happstack m => Happstack (ClckT url m)
(Monad m, HasRqData m) => HasRqData (ClckT url m)
ServerMonad m => ServerMonad (ClckT url m)
(Functor m, Monad m) => XMLGen (ClckT url m)
(Functor m, Monad m) => XMLGenerator (ClckT url m)
(Functor m, MonadIO m) => IntegerSupply (ClckT url m)
MonadIO m => MonadIO (ClckT url m)
Monad m => MonadRoute (ClckT url m)
(Functor m, Monad m) => EmbedAsChild (ClckT url m) Content
(Functor m, Monad m) => EmbedAsChild (ClckT url m) UTCTime
(Functor m, Monad m) => EmbedAsChild (ClckT url m) ()
(Functor m, MonadIO m, Happstack m) => EmbedAsChild (ClckT url m) ClckFormError
(Functor m, Monad m) => EmbedAsChild (ClckT url m) Html
(Functor m, Monad m) => EmbedAsChild (ClckT url m) XML
(Functor m, Monad m) => EmbedAsChild (ClckT url m) Text
(Functor m, Monad m) => EmbedAsChild (ClckT url m) Text
(Functor m, Monad m) => EmbedAsChild (ClckT url m) Float
(Functor m, Monad m) => EmbedAsChild (ClckT url m) Double
(Functor m, Monad m) => EmbedAsChild (ClckT url m) Integer
(Functor m, Monad m) => EmbedAsChild (ClckT url m) Int
(Functor m, Monad m) => EmbedAsChild (ClckT url m) String
(Functor m, Monad m) => EmbedAsChild (ClckT url m) Char
(Functor m, Monad m) => EmbedAsAttr (ClckT url m) Attribute
(Functor m, Monad m) => SetAttr (ClckT url m) XML
(Functor m, Monad m) => AppendChild (ClckT url m) XML
(Functor m, Monad m) => GetAcidState (ClckT url m) ProfileDataState
(Functor m, Monad m) => GetAcidState (ClckT url m) NavBarState
(Functor m, Monad m) => GetAcidState (ClckT url m) CoreState
(Functor m, Monad m) => GetAcidState (ClckT url m) ProfileState
(Functor m, Monad m) => GetAcidState (ClckT url m) AuthState
(Functor m, Monad m, EmbedAsChild (ClckT url m) a) => EmbedAsChild (ClckT url m) (Maybe a)
(Functor m, MonadIO m, EmbedAsChild (ClckT url m) a) => EmbedAsChild (ClckT url m) (IO a)
(Functor m, Monad m, IsName n Text) => EmbedAsAttr (ClckT url m) (Attr n Text)
(Functor m, Monad m, IsName n Text) => EmbedAsAttr (ClckT url m) (Attr n Text)
(Functor m, Monad m, IsName n Text) => EmbedAsAttr (ClckT url m) (Attr n Integer)
(Functor m, Monad m, IsName n Text) => EmbedAsAttr (ClckT url m) (Attr n Int)
(Functor m, Monad m, IsName n Text) => EmbedAsAttr (ClckT url m) (Attr n Bool)
(Functor m, Monad m, IsName n Text) => EmbedAsAttr (ClckT url m) (Attr n Char)
(Functor m, Monad m, IsName n Text) => EmbedAsAttr (ClckT url m) (Attr n String)
(EmbedAsChild (ClckT url1 m) a, ~ * url1 url2) => EmbedAsChild (ClckT url1 m) (ClckT url2 m a)

type ClckForm url = Form (ClckT url (ServerPartT IO)) [Input] ClckFormError [XMLGenT (ClckT url (ServerPartT IO)) XML] ()Source

type ClckFormT error m = Form m [Input] error [XMLGenT m XML] ()Source

ClckForm - type for reform forms

data ClckFormError Source

error returned when a reform Form fails to validate

Constructors

ClckCFE (CommonFormError [Input])
PDE ProfileDataError
EmptyUsername

Instances

Show ClckFormError
FormError ClckFormError
(Functor m, MonadIO m, Happstack m) => EmbedAsChild (ClckT url m) ClckFormError

data family ChildType m1

data ClckwrksConfig Source

Constructors

ClckwrksConfig

Fields

clckHostname :: String: external name of the host
clckPort :: Int: port to listen on
clckTLS :: Maybe TLSSettings: HTTPS
clckHidePort :: Bool: hide port number in URL (useful when running behind a reverse proxy)
clckJQueryPath :: FilePath: path to jquery.js on disk
clckJQueryUIPath :: FilePath: path to jquery-ui.js on disk
clckJSTreePath :: FilePath: path to jstree.js on disk
clckJSON2Path :: FilePath: path to JSON2.js on disk
clckTopDir :: Maybe FilePath: path to top-level directory for all acid-state filesfile uploadsetc
clckEnableAnalytics :: Bool: enable google analytics
clckInitHook :: Text -> ClckState -> ClckwrksConfig -> IO (ClckState, ClckwrksConfig): init hook

data TLSSettings Source

Constructors

TLSSettings
Fields clckTLSPort :: Int clckTLSCert :: FilePath clckTLSKey :: FilePath clckTLSCA :: Maybe FilePath

data family AttributeType m1

data Theme Source

Constructors

Theme
Fields themeName :: ThemeName themeStyles :: [ThemeStyle] themeDataDir :: IO FilePath

data ThemeStyle Source

Constructors

ThemeStyle
Fields themeStyleName :: Text themeStyleDescription :: Text themeStylePreview :: Maybe FilePath themeStyleTemplate :: (EmbedAsChild (ClckT ClckURL (ServerPartT IO)) headers, EmbedAsChild (ClckT ClckURL (ServerPartT IO)) body) => Text -> headers -> body -> XMLGenT (ClckT ClckURL (ServerPartT IO)) XML

newtype ThemeStyleId Source

Constructors

ThemeStyleId
Fields unThemeStyleId :: Int

Instances

Eq ThemeStyleId
Data ThemeStyleId
Ord ThemeStyleId
Read ThemeStyleId
Show ThemeStyleId
Typeable ThemeStyleId
SafeCopy ThemeStyleId

type ThemeName = Text Source

getThemeStyles :: MonadIO m => ClckPlugins -> m [(ThemeStyleId, ThemeStyle)]Source

themeTemplate :: (EmbedAsChild (ClckT ClckURL (ServerPartT IO)) headers, EmbedAsChild (ClckT ClckURL (ServerPartT IO)) body) => ClckPlugins -> ThemeStyleId -> Text -> headers -> body -> ClckT ClckURL (ServerPartT IO) Response Source

calcBaseURI :: ClckwrksConfig -> Text Source

calculate the baseURI from the clckHostname, clckPort and clckHidePort options

calcTLSBaseURI :: ClckwrksConfig -> Maybe Text Source

evalClckT Source

Arguments

:: Monad m
=> (url -> [(Text, Maybe Text)] -> Text)	function to act as `showURLParams`
-> ClckState	initial `ClckState`
-> ClckT url m a	`ClckT` to evaluate
-> m a

evaluate a ClckT returning the inner monad

similar to evalStateT.

execClckT Source

Arguments

:: Monad m
=> (url -> [(Text, Maybe Text)] -> Text)	function to act as `showURLParams`
-> ClckState	initial `ClckState`
-> ClckT url m a	`ClckT` to evaluate
-> m ClckState

execute a ClckT returning the final ClckState

similar to execStateT.

runClckT Source

Arguments

:: Monad m
=> (url -> [(Text, Maybe Text)] -> Text)	function to act as `showURLParams`
-> ClckState	initial `ClckState`
-> ClckT url m a	`ClckT` to evaluate
-> m (a, ClckState)

run a ClckT

similar to runStateT.

mapClckT Source

Arguments

:: (m (a, ClckState) -> n (b, ClckState))	transformation function
-> ClckT url m a	initial monad
-> ClckT url n b

map a transformation function over the inner monad

similar to mapStateT

withRouteClckT :: ((url' -> [(Text, Maybe Text)] -> Text) -> url -> [(Text, Maybe Text)] -> Text) -> ClckT url m a -> ClckT url' m aSource

change the route url

data ClckState Source

Constructors

ClckState
Fields acidState :: Acid uniqueId :: TVar Integer adminMenus :: [(Text, [(Set Role, Text, Text)])] enableAnalytics :: Bool enable Google Analytics plugins :: ClckPlugins requestInit :: ServerPart () an action which gets called at the beginning of each request

Instances

Monad m => MonadState ClckState (ClckT url m)

getUserId :: (Happstack m, GetAcidState m AuthState, GetAcidState m ProfileState) => m (Maybe UserId)Source

The the UserId of the current user. While return Nothing if they are not logged in.

data Content Source

a wrapper which identifies how to treat different Text values when attempting to embed them.

In general Content values have already been flattenpreprocessedetc and are now basic formats like textplain@, @texthtml, etc

Constructors

TrustedHtml Text
PlainText Text

Instances

Eq Content
Data Content
Ord Content
Read Content
Show Content
Typeable Content
(Functor m, Monad m) => EmbedAsChild (ClckT url m) Content

addAdminMenu :: Monad m => (Text, [(Set Role, Text, Text)]) -> ClckT url m ()Source

add an Admin menu

appendRequestInit :: Monad m => ServerPart () -> ClckT url m ()Source

append an action to the request init

getNavBarLinks :: MonadIO m => Plugins theme n hook config ClckPluginsSt -> ClckT ClckURL m NavBarLinks Source

addPreProc :: MonadIO m => Plugins theme n hook config ClckPluginsSt -> (Text -> ClckT ClckURL IO Text) -> m ()Source

addNavBarCallback :: MonadIO m => Plugins theme n hook config ClckPluginsSt -> ClckT ClckURL IO (String, [NamedLink]) -> m ()Source

getPreProcessors :: MonadIO m => Plugins theme n hook config ClckPluginsSt -> ClckT url m [Text -> ClckT ClckURL IO Text]Source

getEnableAnalytics :: (Functor m, MonadState ClckState m) => m Bool Source

get the Bool value indicating if Google Analytics should be enabled or not

googleAnalytics :: XMLGenT (Clck url) XML Source

create a google analytics tracking code block

This will under two different conditions:

the enableAnalytics field in ClckState is False
the uacct field in PageState is Nothing

getUnique :: (Functor m, MonadIO m) => ClckT url m Integer Source

get a unique Integer.

Only unique for the current request

setUnique :: (Functor m, MonadIO m) => Integer -> ClckT url m ()Source

requiresRole :: Happstack m => Set Role -> url -> ClckT ClckURL m urlSource

requiresRole_ :: Happstack m => (ClckURL -> [(Text, Maybe Text)] -> Text) -> Set Role -> url -> ClckT u m urlSource

setRedirectCookie :: Happstack m => String -> m ()Source

getRedirectCookie :: Happstack m => m (Maybe String)Source

getUserRoles :: (Happstack m, MonadIO m) => ClckT u m (Set Role)Source

query :: forall event m. (QueryEvent event, GetAcidState m (EventState event), Functor m, MonadIO m, MonadState ClckState m) => event -> m (EventResult event)Source

similar to the normal acid-state query except it automatically gets the correct AcidState handle from the environment

update :: forall event m. (UpdateEvent event, GetAcidState m (EventState event), Functor m, MonadIO m, MonadState ClckState m) => event -> m (EventResult event)Source

similar to the normal acid-state update except it automatically gets the correct AcidState handle from the environment

nestURL :: (url1 -> url2) -> ClckT url1 m a -> ClckT url2 m aSource

withAbs :: Happstack m => ClckT url m a -> ClckT url m aSource

withAbs' :: Text -> ClckT url m a -> ClckT url m aSource

segments :: Text -> Parser a -> Parser [Segment a]Source

transform :: Monad m => (cmd -> m Builder) -> [Segment cmd] -> m Builder Source

module HSP.XML

module HSP.XMLGenerator