Safe Haskell	Safe-Inferred
Language	Haskell2010

Network.Gitit.Types

Description

Types for Gitit modules.

Synopsis

data PageType
- = Markdown
- | CommonMark
- | RST
- | LaTeX
- | HTML
- | Textile
- | Org
- | DocBook
- | MediaWiki
data FileStoreType
- = Git
- | Darcs
- | Mercurial
data MathMethod
- = MathML
- | WebTeX String
- | RawTeX
- | MathJax String
data AuthenticationLevel
- = Never
- | ForModify
- | ForRead
data Config = Config {
- repositoryPath :: FilePath
- repositoryType :: FileStoreType
- defaultPageType :: PageType
- defaultExtension :: String
- mathMethod :: MathMethod
- defaultLHS :: Bool
- showLHSBirdTracks :: Bool
- withUser :: Handler -> Handler
- requireAuthentication :: AuthenticationLevel
- authHandler :: Handler
- userFile :: FilePath
- sessionTimeout :: Int
- templatesDir :: FilePath
- logFile :: FilePath
- logLevel :: Priority
- staticDir :: FilePath
- pluginModules :: [String]
- tableOfContents :: Bool
- maxUploadSize :: Integer
- maxPageSize :: Integer
- address :: String
- portNumber :: Int
- debugMode :: Bool
- frontPage :: String
- noEdit :: [String]
- noDelete :: [String]
- defaultSummary :: String
- deleteSummary :: String
- accessQuestion :: Maybe (String, [String])
- disableRegistration :: Bool
- useRecaptcha :: Bool
- recaptchaPublicKey :: String
- recaptchaPrivateKey :: String
- rpxDomain :: String
- rpxKey :: String
- compressResponses :: Bool
- useCache :: Bool
- cacheDir :: FilePath
- mimeMap :: Map String String
- mailCommand :: String
- resetPasswordMessage :: String
- markupHelp :: Text
- useFeed :: Bool
- baseUrl :: String
- useAbsoluteUrls :: Bool
- wikiTitle :: String
- feedDays :: Integer
- feedRefreshTime :: Integer
- pandocUserData :: Maybe FilePath
- xssSanitize :: Bool
- recentActivityDays :: Int
- githubAuth :: GithubConfig
}
data Page = Page {
- pageName :: String
- pageFormat :: PageType
- pageLHS :: Bool
- pageTOC :: Bool
- pageTitle :: String
- pageCategories :: [String]
- pageText :: String
- pageMeta :: [(String, String)]
}
newtype SessionKey = SessionKey Integer
data SessionData
data SessionGithubData
sessionData :: String -> SessionData
sessionGithubData :: SessionData -> Maybe SessionGithubData
sessionDataGithubStateUrl :: String -> String -> SessionData
sessionUser :: SessionData -> Maybe String
sessionGithubState :: SessionGithubData -> String
sessionGithubDestination :: SessionGithubData -> String
data User = User {
- uUsername :: String
- uPassword :: Password
- uEmail :: String
}
data Sessions a = Sessions {
- unsession :: Map SessionKey a
}
data Password = Password {
- pSalt :: String
- pHashed :: String
}
data GititState = GititState {
- sessions :: Sessions SessionData
- users :: Map String User
- templatesPath :: FilePath
- renderPage :: PageLayout -> Html -> Handler
- plugins :: [Plugin]
}
class Monad m => HasContext m
modifyContext :: HasContext m => (Context -> Context) -> m ()
getContext :: HasContext m => m Context
type ContentTransformer = StateT Context GititServerPart
data Plugin
- = PageTransform (Pandoc -> PluginM Pandoc)
- | PreParseTransform (String -> PluginM String)
- | PreCommitTransform (String -> PluginM String)
data PluginData = PluginData {
- pluginConfig :: Config
- pluginUser :: Maybe User
- pluginRequest :: Request
- pluginFileStore :: FileStore
}
type PluginM = ReaderT PluginData (StateT Context IO)
runPluginM :: PluginM a -> PluginData -> Context -> IO (a, Context)
data Context = Context {
- ctxFile :: String
- ctxLayout :: PageLayout
- ctxCacheable :: Bool
- ctxTOC :: Bool
- ctxBirdTracks :: Bool
- ctxCategories :: [String]
- ctxMeta :: [(String, String)]
}
data PageLayout = PageLayout {
- pgPageName :: String
- pgRevision :: Maybe String
- pgPrintable :: Bool
- pgMessages :: [String]
- pgTitle :: String
- pgScripts :: [String]
- pgShowPageTools :: Bool
- pgShowSiteNav :: Bool
- pgMarkupHelp :: Maybe Text
- pgTabs :: [Tab]
- pgSelectedTab :: Tab
- pgLinkToFeed :: Bool
}
data Tab
- = ViewTab
- | EditTab
- | HistoryTab
- | DiscussTab
- | DiffTab
data Recaptcha = Recaptcha {
- recaptchaChallengeField :: String
- recaptchaResponseField :: String
}
data Params = Params {
- pUsername :: String
- pPassword :: String
- pPassword2 :: String
- pRevision :: Maybe String
- pDestination :: String
- pForUser :: Maybe String
- pSince :: Maybe UTCTime
- pRaw :: String
- pLimit :: Int
- pPatterns :: [String]
- pGotoPage :: String
- pFileToDelete :: String
- pEditedText :: Maybe String
- pMessages :: [String]
- pFrom :: Maybe String
- pTo :: Maybe String
- pFormat :: String
- pSHA1 :: String
- pLogMsg :: String
- pEmail :: String
- pFullName :: String
- pAccessCode :: String
- pWikiname :: String
- pPrintable :: Bool
- pOverwrite :: Bool
- pFilename :: String
- pFilePath :: FilePath
- pConfirm :: Bool
- pSessionKey :: Maybe SessionKey
- pRecaptcha :: Recaptcha
- pResetCode :: String
- pRedirect :: Maybe Bool
}
data Command = Command (Maybe String)
data WikiState = WikiState {
- wikiConfig :: Config
- wikiFileStore :: FileStore
}
type GititServerPart = ServerPartT (ReaderT WikiState IO)
type Handler = GititServerPart Response
fromEntities :: String -> String
data GithubConfig
oAuth2 :: GithubConfig -> OAuth2
org :: GithubConfig -> Maybe Text
githubConfig :: OAuth2 -> Maybe Text -> GithubConfig

Documentation

data PageType Source #

Constructors

Markdown
CommonMark
RST
LaTeX
HTML
Textile
Org
DocBook
MediaWiki

Instances

Instances details

Read PageType Source #
Instance details Defined in Network.Gitit.Types Methods readsPrec :: Int -> ReadS PageType # readList :: ReadS [PageType] # readPrec :: ReadPrec PageType # readListPrec :: ReadPrec [PageType] #
Show PageType Source #
Instance details Defined in Network.Gitit.Types Methods showsPrec :: Int -> PageType -> ShowS # show :: PageType -> String # showList :: [PageType] -> ShowS #
Eq PageType Source #
Instance details Defined in Network.Gitit.Types Methods (==) :: PageType -> PageType -> Bool # (/=) :: PageType -> PageType -> Bool #

data FileStoreType Source #

Constructors

Git
Darcs
Mercurial

Instances

Instances details

Show FileStoreType Source #
Instance details Defined in Network.Gitit.Types Methods showsPrec :: Int -> FileStoreType -> ShowS # show :: FileStoreType -> String # showList :: [FileStoreType] -> ShowS #

data MathMethod Source #

Constructors

MathML
WebTeX String
RawTeX
MathJax String

Instances

Instances details

Read MathMethod Source #
Instance details Defined in Network.Gitit.Types Methods readsPrec :: Int -> ReadS MathMethod # readList :: ReadS [MathMethod] # readPrec :: ReadPrec MathMethod # readListPrec :: ReadPrec [MathMethod] #
Show MathMethod Source #
Instance details Defined in Network.Gitit.Types Methods showsPrec :: Int -> MathMethod -> ShowS # show :: MathMethod -> String # showList :: [MathMethod] -> ShowS #
Eq MathMethod Source #
Instance details Defined in Network.Gitit.Types Methods (==) :: MathMethod -> MathMethod -> Bool # (/=) :: MathMethod -> MathMethod -> Bool #

data AuthenticationLevel Source #

Constructors

Never
ForModify
ForRead

Instances

Instances details

Read AuthenticationLevel Source #
Instance details Defined in Network.Gitit.Types Methods readsPrec :: Int -> ReadS AuthenticationLevel # readList :: ReadS [AuthenticationLevel] # readPrec :: ReadPrec AuthenticationLevel # readListPrec :: ReadPrec [AuthenticationLevel] #
Show AuthenticationLevel Source #
Instance details Defined in Network.Gitit.Types Methods showsPrec :: Int -> AuthenticationLevel -> ShowS # show :: AuthenticationLevel -> String # showList :: [AuthenticationLevel] -> ShowS #
Eq AuthenticationLevel Source #
Instance details Defined in Network.Gitit.Types Methods (==) :: AuthenticationLevel -> AuthenticationLevel -> Bool # (/=) :: AuthenticationLevel -> AuthenticationLevel -> Bool #
Ord AuthenticationLevel Source #
Instance details Defined in Network.Gitit.Types Methods compare :: AuthenticationLevel -> AuthenticationLevel -> Ordering # (<) :: AuthenticationLevel -> AuthenticationLevel -> Bool # (<=) :: AuthenticationLevel -> AuthenticationLevel -> Bool # (>) :: AuthenticationLevel -> AuthenticationLevel -> Bool # (>=) :: AuthenticationLevel -> AuthenticationLevel -> Bool # max :: AuthenticationLevel -> AuthenticationLevel -> AuthenticationLevel # min :: AuthenticationLevel -> AuthenticationLevel -> AuthenticationLevel #

data Config Source #

Data structure for information read from config file.

Constructors

Config

Fields

repositoryPath :: FilePath
Path of repository containing filestore
repositoryType :: FileStoreType
Type of repository
defaultPageType :: PageType
Default page markup type for this wiki
defaultExtension :: String
Default file extension for pages in this wiki
mathMethod :: MathMethod
How to handle LaTeX math in pages?
defaultLHS :: Bool
Treat as literate haskell by default?
showLHSBirdTracks :: Bool
Show Haskell code with bird tracks
withUser :: Handler -> Handler
Combinator to set REMOTE_USER request header
requireAuthentication :: AuthenticationLevel
Handler for login, logout, register, etc.
authHandler :: Handler
Specifies which actions require authentication.
userFile :: FilePath
Path of users database
sessionTimeout :: Int
Seconds of inactivity before session expires
templatesDir :: FilePath
Directory containing page templates
logFile :: FilePath
Path of server log file
logLevel :: Priority
Severity filter for log messages (DEBUG, INFO, NOTICE, WARNING, ERROR, CRITICAL, ALERT, EMERGENCY)
staticDir :: FilePath
Path of static directory
pluginModules :: [String]
Names of plugin modules to load
tableOfContents :: Bool
Show table of contents on each page?
maxUploadSize :: Integer
Max size of file uploads
maxPageSize :: Integer
Max size of page uploads
address :: String
IP address to bind to
portNumber :: Int
Port number to serve content on
debugMode :: Bool
Print debug info to the console?
frontPage :: String
The front page of the wiki
noEdit :: [String]
Pages that cannot be edited via web
noDelete :: [String]
Pages that cannot be deleted via web
defaultSummary :: String
Default summary if description left blank
deleteSummary :: String
Delete summary
accessQuestion :: Maybe (String, [String])
Nothing = anyone can register. Just (prompt, answers) = a user will be given the prompt and must give one of the answers to register.
disableRegistration :: Bool
Disable Registration?
useRecaptcha :: Bool
Use ReCAPTCHA for user registration.
recaptchaPublicKey :: String
recaptchaPrivateKey :: String
rpxDomain :: String
RPX domain and key
rpxKey :: String
compressResponses :: Bool
Should responses be compressed?
useCache :: Bool
Should responses be cached?
cacheDir :: FilePath
Directory to hold cached pages
mimeMap :: Map String String
Map associating mime types with file extensions
mailCommand :: String
Command to send notification emails
resetPasswordMessage :: String
Text of password reset email
markupHelp :: Text
Markup syntax help for edit sidebar
useFeed :: Bool
Provide an atom feed?
baseUrl :: String
Base URL of wiki, for use in feed
useAbsoluteUrls :: Bool
Title of wiki, used in feed
wikiTitle :: String
Should WikiLinks be absolute w.r.t. the base URL?
feedDays :: Integer
Number of days history to be included in feed
feedRefreshTime :: Integer
Number of minutes to cache feeds before refreshing
pandocUserData :: Maybe FilePath
Directory to search for pandoc customizations
xssSanitize :: Bool
Filter HTML through xss-sanitize
recentActivityDays :: Int
The default number of days in the past to look for "recent" activity
githubAuth :: GithubConfig
Github client data for authentication (id, secret, callback, authorize endpoint, access token endpoint)

data Page Source #

Data for rendering a wiki page.

Constructors

Page
Fields pageName :: String pageFormat :: PageType pageLHS :: Bool pageTOC :: Bool pageTitle :: String pageCategories :: [String] pageText :: String pageMeta :: [(String, String)]

Instances

Instances details

Read Page Source #
Instance details Defined in Network.Gitit.Types Methods readsPrec :: Int -> ReadS Page # readList :: ReadS [Page] # readPrec :: ReadPrec Page # readListPrec :: ReadPrec [Page] #
Show Page Source #
Instance details Defined in Network.Gitit.Types Methods showsPrec :: Int -> Page -> ShowS # show :: Page -> String # showList :: [Page] -> ShowS #

newtype SessionKey Source #

Constructors

SessionKey Integer

Instances

Instances details

Read SessionKey Source #
Instance details Defined in Network.Gitit.Types Methods readsPrec :: Int -> ReadS SessionKey # readList :: ReadS [SessionKey] # readPrec :: ReadPrec SessionKey # readListPrec :: ReadPrec [SessionKey] #
Show SessionKey Source #
Instance details Defined in Network.Gitit.Types Methods showsPrec :: Int -> SessionKey -> ShowS # show :: SessionKey -> String # showList :: [SessionKey] -> ShowS #
Eq SessionKey Source #
Instance details Defined in Network.Gitit.Types Methods (==) :: SessionKey -> SessionKey -> Bool # (/=) :: SessionKey -> SessionKey -> Bool #
Ord SessionKey Source #
Instance details Defined in Network.Gitit.Types Methods compare :: SessionKey -> SessionKey -> Ordering # (<) :: SessionKey -> SessionKey -> Bool # (<=) :: SessionKey -> SessionKey -> Bool # (>) :: SessionKey -> SessionKey -> Bool # (>=) :: SessionKey -> SessionKey -> Bool # max :: SessionKey -> SessionKey -> SessionKey # min :: SessionKey -> SessionKey -> SessionKey #
FromReqURI SessionKey Source #
Instance details Defined in Network.Gitit.Types Methods fromReqURI :: String -> Maybe SessionKey #
FromData SessionKey Source #
Instance details Defined in Network.Gitit.Types Methods fromData :: RqData SessionKey #

data SessionData Source #

Instances

Instances details

Read SessionData Source #
Instance details Defined in Network.Gitit.Types Methods readsPrec :: Int -> ReadS SessionData # readList :: ReadS [SessionData] # readPrec :: ReadPrec SessionData # readListPrec :: ReadPrec [SessionData] #
Show SessionData Source #
Instance details Defined in Network.Gitit.Types Methods showsPrec :: Int -> SessionData -> ShowS # show :: SessionData -> String # showList :: [SessionData] -> ShowS #
Eq SessionData Source #
Instance details Defined in Network.Gitit.Types Methods (==) :: SessionData -> SessionData -> Bool # (/=) :: SessionData -> SessionData -> Bool #

data SessionGithubData Source #

Instances

Instances details

Read SessionGithubData Source #
Instance details Defined in Network.Gitit.Types Methods readsPrec :: Int -> ReadS SessionGithubData # readList :: ReadS [SessionGithubData] # readPrec :: ReadPrec SessionGithubData # readListPrec :: ReadPrec [SessionGithubData] #
Show SessionGithubData Source #
Instance details Defined in Network.Gitit.Types Methods showsPrec :: Int -> SessionGithubData -> ShowS # show :: SessionGithubData -> String # showList :: [SessionGithubData] -> ShowS #
Eq SessionGithubData Source #
Instance details Defined in Network.Gitit.Types Methods (==) :: SessionGithubData -> SessionGithubData -> Bool # (/=) :: SessionGithubData -> SessionGithubData -> Bool #

sessionData :: String -> SessionData Source #

sessionGithubData :: SessionData -> Maybe SessionGithubData Source #

sessionDataGithubStateUrl :: String -> String -> SessionData Source #

sessionUser :: SessionData -> Maybe String Source #

sessionGithubState :: SessionGithubData -> String Source #

sessionGithubDestination :: SessionGithubData -> String Source #

data User Source #

Constructors

User
Fields uUsername :: String uPassword :: Password uEmail :: String

Instances

Instances details

Read User Source #
Instance details Defined in Network.Gitit.Types Methods readsPrec :: Int -> ReadS User # readList :: ReadS [User] # readPrec :: ReadPrec User # readListPrec :: ReadPrec [User] #
Show User Source #
Instance details Defined in Network.Gitit.Types Methods showsPrec :: Int -> User -> ShowS # show :: User -> String # showList :: [User] -> ShowS #

data Sessions a Source #

Constructors

Sessions
Fields unsession :: Map SessionKey a

Instances

Instances details

Read a => Read (Sessions a) Source #
Instance details Defined in Network.Gitit.Types Methods readsPrec :: Int -> ReadS (Sessions a) # readList :: ReadS [Sessions a] # readPrec :: ReadPrec (Sessions a) # readListPrec :: ReadPrec [Sessions a] #
Show a => Show (Sessions a) Source #
Instance details Defined in Network.Gitit.Types Methods showsPrec :: Int -> Sessions a -> ShowS # show :: Sessions a -> String # showList :: [Sessions a] -> ShowS #
Eq a => Eq (Sessions a) Source #
Instance details Defined in Network.Gitit.Types Methods (==) :: Sessions a -> Sessions a -> Bool # (/=) :: Sessions a -> Sessions a -> Bool #

data Password Source #

Constructors

Password
Fields pSalt :: String pHashed :: String

Instances

Instances details

Read Password Source #
Instance details Defined in Network.Gitit.Types Methods readsPrec :: Int -> ReadS Password # readList :: ReadS [Password] # readPrec :: ReadPrec Password # readListPrec :: ReadPrec [Password] #
Show Password Source #
Instance details Defined in Network.Gitit.Types Methods showsPrec :: Int -> Password -> ShowS # show :: Password -> String # showList :: [Password] -> ShowS #
Eq Password Source #
Instance details Defined in Network.Gitit.Types Methods (==) :: Password -> Password -> Bool # (/=) :: Password -> Password -> Bool #

data GititState Source #

Common state for all gitit wikis in an application.

Constructors

GititState
Fields sessions :: Sessions SessionData users :: Map String User templatesPath :: FilePath renderPage :: PageLayout -> Html -> Handler plugins :: [Plugin]

class Monad m => HasContext m Source #

Minimal complete definition

getContext, modifyContext

Instances

Instances details

HasContext ContentTransformer Source #
Instance details Defined in Network.Gitit.Types Methods getContext :: ContentTransformer Context Source # modifyContext :: (Context -> Context) -> ContentTransformer () Source #
HasContext PluginM Source #
Instance details Defined in Network.Gitit.Types Methods getContext :: PluginM Context Source # modifyContext :: (Context -> Context) -> PluginM () Source #

modifyContext :: HasContext m => (Context -> Context) -> m () Source #

getContext :: HasContext m => m Context Source #

type ContentTransformer = StateT Context GititServerPart Source #

data Plugin Source #

Constructors

PageTransform (Pandoc -> PluginM Pandoc)
PreParseTransform (String -> PluginM String)
PreCommitTransform (String -> PluginM String)

data PluginData Source #

Constructors

PluginData
Fields pluginConfig :: Config pluginUser :: Maybe User pluginRequest :: Request pluginFileStore :: FileStore

Instances

Instances details

HasContext PluginM Source #
Instance details Defined in Network.Gitit.Types Methods getContext :: PluginM Context Source # modifyContext :: (Context -> Context) -> PluginM () Source #

type PluginM = ReaderT PluginData (StateT Context IO) Source #

runPluginM :: PluginM a -> PluginData -> Context -> IO (a, Context) Source #

data Context Source #

Constructors

Context
Fields ctxFile :: String ctxLayout :: PageLayout ctxCacheable :: Bool ctxTOC :: Bool ctxBirdTracks :: Bool ctxCategories :: [String] ctxMeta :: [(String, String)]

Instances

Instances details

HasContext ContentTransformer Source #
Instance details Defined in Network.Gitit.Types Methods getContext :: ContentTransformer Context Source # modifyContext :: (Context -> Context) -> ContentTransformer () Source #
HasContext PluginM Source #
Instance details Defined in Network.Gitit.Types Methods getContext :: PluginM Context Source # modifyContext :: (Context -> Context) -> PluginM () Source #

data PageLayout Source #

Abstract representation of page layout (tabs, scripts, etc.)

Constructors

PageLayout
Fields pgPageName :: String pgRevision :: Maybe String pgPrintable :: Bool pgMessages :: [String] pgTitle :: String pgScripts :: [String] pgShowPageTools :: Bool pgShowSiteNav :: Bool pgMarkupHelp :: Maybe Text pgTabs :: [Tab] pgSelectedTab :: Tab pgLinkToFeed :: Bool

data Tab Source #

Constructors

ViewTab
EditTab
HistoryTab
DiscussTab
DiffTab

Instances

Instances details

Show Tab Source #
Instance details Defined in Network.Gitit.Types Methods showsPrec :: Int -> Tab -> ShowS # show :: Tab -> String # showList :: [Tab] -> ShowS #
Eq Tab Source #
Instance details Defined in Network.Gitit.Types Methods (==) :: Tab -> Tab -> Bool # (/=) :: Tab -> Tab -> Bool #

data Recaptcha Source #

Constructors

Recaptcha
Fields recaptchaChallengeField :: String recaptchaResponseField :: String

Instances

Instances details

Read Recaptcha Source #
Instance details Defined in Network.Gitit.Types Methods readsPrec :: Int -> ReadS Recaptcha # readList :: ReadS [Recaptcha] # readPrec :: ReadPrec Recaptcha # readListPrec :: ReadPrec [Recaptcha] #
Show Recaptcha Source #
Instance details Defined in Network.Gitit.Types Methods showsPrec :: Int -> Recaptcha -> ShowS # show :: Recaptcha -> String # showList :: [Recaptcha] -> ShowS #

data Params Source #

Constructors

Params

Fields

Instances

Instances details

Show Params Source #
Instance details Defined in Network.Gitit.Types Methods showsPrec :: Int -> Params -> ShowS # show :: Params -> String # showList :: [Params] -> ShowS #
FromData Params Source #
Instance details Defined in Network.Gitit.Types Methods fromData :: RqData Params #

data Command Source #

Constructors

Command (Maybe String)

Instances

Instances details

Show Command Source #
Instance details Defined in Network.Gitit.Types Methods showsPrec :: Int -> Command -> ShowS # show :: Command -> String # showList :: [Command] -> ShowS #
FromData Command Source #
Instance details Defined in Network.Gitit.Types Methods fromData :: RqData Command #

data WikiState Source #

State for a single wiki.

Constructors

WikiState
Fields wikiConfig :: Config wikiFileStore :: FileStore

Instances

Instances details

HasContext ContentTransformer Source #
Instance details Defined in Network.Gitit.Types Methods getContext :: ContentTransformer Context Source # modifyContext :: (Context -> Context) -> ContentTransformer () Source #

type GititServerPart = ServerPartT (ReaderT WikiState IO) Source #

type Handler = GititServerPart Response Source #

fromEntities :: String -> String Source #

data GithubConfig Source #

oAuth2 :: GithubConfig -> OAuth2 Source #

org :: GithubConfig -> Maybe Text Source #

githubConfig :: OAuth2 -> Maybe Text -> GithubConfig Source #