Safe Haskell	None

Network.Gitit.Types

Description

Types for Gitit modules.

Synopsis

Documentation

data PageType Source

Constructors

Markdown
RST
LaTeX
HTML
Textile
Org
DocBook
MediaWiki

Instances

Eq PageType
Read PageType
Show PageType

data FileStoreType Source

Constructors

Git
Darcs
Mercurial

Instances

Show FileStoreType

data MathMethod Source

Constructors

MathML
JsMathScript
WebTeX String
RawTeX
MathJax String

Instances

Eq MathMethod
Read MathMethod
Show MathMethod

data AuthenticationLevel Source

Constructors

Never
ForModify
ForRead

Instances

Eq AuthenticationLevel
Ord AuthenticationLevel
Read AuthenticationLevel
Show 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
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
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.
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 :: String: 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
pdfExport :: Bool: Allow PDF export?
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

Read Page
Show Page

type SessionKey = IntegerSource

data SessionData Source

Instances

Eq SessionData
Read SessionData
Show SessionData

sessionData :: String -> SessionData Source

sessionDataGithubState :: String -> SessionData Source

sessionUser :: SessionData -> Maybe StringSource

sessionGithubState :: SessionData -> Maybe StringSource

data User Source

Constructors

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

Instances

Read User
Show User

data Sessions a Source

Constructors

Sessions
Fields unsession :: Map SessionKey a

Instances

Eq a => Eq (Sessions a)
Read a => Read (Sessions a)
Show a => Show (Sessions a)

data Password Source

Constructors

Password
Fields pSalt :: String pHashed :: String

Instances

Eq Password
Read Password
Show Password

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 whereSource

Methods

getContext :: m Context Source

modifyContext :: (Context -> Context) -> m ()Source

Instances

HasContext PluginM
HasContext ContentTransformer

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

HasContext PluginM

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

HasContext PluginM
HasContext ContentTransformer

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 String pgTabs :: [Tab] pgSelectedTab :: Tab pgLinkToFeed :: Bool

data Tab Source

Constructors

ViewTab
EditTab
HistoryTab
DiscussTab
DiffTab

Instances

Eq Tab
Show Tab

data Recaptcha Source

Constructors

Recaptcha
Fields recaptchaChallengeField :: String recaptchaResponseField :: String

Instances

Read Recaptcha
Show Recaptcha

data Params Source

Constructors

Params

Fields

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

Instances

Show Params
FromData Params

data Command Source

Constructors

Command (Maybe String)

Instances

Show Command
FromData Command

data WikiState Source

State for a single wiki.

Constructors

WikiState
Fields wikiConfig :: Config wikiFileStore :: FileStore

Instances

HasContext ContentTransformer

type GititServerPart = ServerPartT (ReaderT WikiState IO)Source

type Handler = GititServerPart Response Source

fromEntities :: String -> StringSource

data GithubConfig Source

oAuth2 :: GithubConfig -> OAuth2 Source

org :: GithubConfig -> Maybe Text Source

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