Web.Plugins.Core

Documentation

data When

Constructors

Always

OnFailure

OnNormal

Instances

Eq When

Ord When

Show When

isWhen :: When -> When -> Bool

data Cleanup

Constructors

Cleanup When (IO ())

type PluginName = Text

data PluginsState theme n hook config st

Constructors

PluginsState

Fields

pluginsHandler :: Map PluginName (Plugins theme n hook config st -> [Text] -> n)

pluginsOnShutdown :: [Cleanup]

pluginsRouteFn :: Map PluginName Dynamic

pluginsTheme :: Maybe theme

pluginsPostHooks :: [hook]

pluginsConfig :: config

pluginsState :: st

newtype Plugins theme m hook config st

we don't really want to give the Plugin unrestricted access to modify the PluginsState TVar. So we will use a newtype?

Constructors

Plugins

Fields

ptv :: TVar (PluginsState theme m hook config st)

initPlugins :: config -> st -> IO (Plugins theme n hook config st)

destroyPlugins :: When -> Plugins theme m hook config st -> IO ()

withPlugins :: config -> st -> (Plugins theme m hook config st -> IO a) -> IO a

a bracketed combination of initPlugins and destroyPlugins. Takes care of passing the correct termination condition.

PluginsSt

getPluginsSt :: MonadIO m => Plugins theme n hook config st -> m st

putPluginsSt :: MonadIO m => Plugins theme n hook config st -> st -> m ()

modifyPluginsSt :: MonadIO m => Plugins theme n hook config st -> (st -> st) -> m ()

addHandler :: MonadIO m => Plugins theme n hook config st -> Text -> (Plugins theme n hook config st -> [Text] -> n) -> m ()

addCleanup :: MonadIO m => Plugins theme n hook config st -> When -> IO () -> m ()

add a new cleanup action to the top of the stack

addPostHook :: MonadIO m => Plugins theme n hook config st -> hook -> m ()

getPostHooks :: MonadIO m => Plugins theme n hook config st -> m [hook]

addPluginRouteFn :: (MonadIO m, Typeable url) => Plugins theme n hook config st -> Text -> (url -> [(Text, Maybe Text)] -> Text) -> m ()

getPluginRouteFn :: (MonadIO m, Typeable url) => Plugins theme n hook config st -> Text -> m (Maybe (url -> [(Text, Maybe Text)] -> Text))

setTheme :: MonadIO m => Plugins theme n hook config st -> Maybe theme -> m ()

getTheme :: MonadIO m => Plugins theme n hook config st -> m (Maybe theme)

getConfig :: MonadIO m => Plugins theme n hook config st -> m config

data Plugin url theme n hook config st

NOTE: it is possible to set the URL type incorrectly here and not get a type error. How can we fix that ?

Constructors

Plugin

Fields

pluginName :: PluginName

pluginInit :: Plugins theme n hook config st -> IO (Maybe Text)

pluginDepends :: [Text]

plugins which much be initialized before this one can be

pluginToPathInfo :: url -> Text

pluginPostHook :: hook

initPlugin :: Typeable url => Plugins theme n hook config st -> Text -> Plugin url theme n hook config st -> IO (Maybe Text)

serve :: Plugins theme n hook config st -> Text -> [Text] -> IO (Either String n)