Hledger.Web.Foundation

Define the web application's foundation, in the usual Yesod style. See a default Yesod app's comments for more details of each part.

Documentation

data App

The site argument for your application. This can be a good place to keep settings and values requiring initialization before your application starts running, such as database connections. Every handler will have access to the data present here.

Constructors

App

Fields

• settings :: AppConfig DefaultEnv Extra
• getStatic :: Static

  Settings for static file serving.

• httpManager :: Manager
• appOpts :: WebOpts
• appJournal :: IORef Journal

Instances

RouteAttrs App

Defined in Hledger.Web.Foundation

Methods

routeAttrs :: Route App -> Set Text

ParseRoute App

Defined in Hledger.Web.Foundation

Methods

parseRoute :: ([Text], [(Text, Text)]) -> Maybe (Route App)

RenderRoute App

Defined in Hledger.Web.Foundation

Associated Types

data Route App :: Type

Methods

renderRoute :: Route App -> ([Text], [(Text, Text)])

Yesod App

Defined in Hledger.Web.Foundation

Methods

approot :: Approot App

errorHandler :: ErrorResponse -> HandlerFor App TypedContent

defaultLayout :: WidgetFor App () -> HandlerFor App Html

urlParamRenderOverride :: App -> Route App -> [(Text, Text)] -> Maybe Builder

isAuthorized :: Route App -> Bool -> HandlerFor App AuthResult

isWriteRequest :: Route App -> HandlerFor App Bool

authRoute :: App -> Maybe (Route App)

cleanPath :: App -> [Text] -> Either [Text] [Text]

joinPath :: App -> Text -> [Text] -> [(Text, Text)] -> Builder

addStaticContent :: Text -> Text -> ByteString -> HandlerFor App (Maybe (Either Text (Route App, [(Text, Text)])))

maximumContentLength :: App -> Maybe (Route App) -> Maybe Word64

makeLogger :: App -> IO Logger

messageLoggerSource :: App -> Logger -> Loc -> LogSource -> LogLevel -> LogStr -> IO ()

jsLoader :: App -> ScriptLoadPosition App

jsAttributes :: App -> [(Text, Text)]

makeSessionBackend :: App -> IO (Maybe SessionBackend)

fileUpload :: App -> RequestBodyLength -> FileUpload

shouldLogIO :: App -> LogSource -> LogLevel -> IO Bool

yesodMiddleware :: ToTypedContent res => HandlerFor App res -> HandlerFor App res

yesodWithInternalState :: App -> Maybe (Route App) -> (InternalState -> IO a) -> IO a

defaultMessageWidget :: Html -> HtmlUrl (Route App) -> WidgetFor App ()

YesodDispatch App

Defined in Hledger.Web.Application

Methods

yesodDispatch :: YesodRunnerEnv App -> Application

RenderMessage App FormMessage

Defined in Hledger.Web.Foundation

Methods

renderMessage :: App -> [Lang] -> FormMessage -> Text

Eq (Route App)

Defined in Hledger.Web.Foundation

Methods

(==) :: Route App -> Route App -> Bool

(/=) :: Route App -> Route App -> Bool

Read (Route App)

Defined in Hledger.Web.Foundation

Methods

readsPrec :: Int -> ReadS (Route App)

readList :: ReadS [Route App]

readPrec :: ReadPrec (Route App)

readListPrec :: ReadPrec [Route App]

Show (Route App)

Defined in Hledger.Web.Foundation

Methods

showsPrec :: Int -> Route App -> ShowS

show :: Route App -> String

showList :: [Route App] -> ShowS

data Route App

Defined in Hledger.Web.Foundation

data Route App

• = FaviconR
• | RobotsR
• | StaticR (Route Static)
• | RootR
• | JournalR
• | RegisterR
• | AddR
• | ManageR
• | EditR FilePath
• | UploadR FilePath
• | DownloadR FilePath

Creates the route datatype AppRoute. Every valid URL in your

Creates the associated type:

Creates the value resourcesApp which contains information on the

type Handler = HandlerFor App

type Widget = WidgetFor App ()

resourcesApp :: [ResourceTree String]

type AppRoute = Route App

A convenience alias.

type Form x = Html -> MForm (HandlerFor App) (FormResult x, Widget)

data ViewData

A bundle of data useful for hledger-web request handlers and templates.

Constructors

VD

Fields

• opts :: WebOpts

  the command-line options at startup

• today :: Day

  today's date (for queries containing relative dates)

• j :: Journal

  the up-to-date parsed unfiltered journal

• q :: Text

  the current q parameter, the main query expression

• m :: Query

  a query parsed from the q parameter

• qopts :: [QueryOpt]

  query options parsed from the q parameter

• caps :: [Capability]

  capabilities enabled for this request

Instances

Show ViewData

Defined in Hledger.Web.Foundation

Methods

showsPrec :: Int -> ViewData -> ShowS

show :: ViewData -> String

showList :: [ViewData] -> ShowS

getViewData :: Handler ViewData

Gather data used by handlers and templates in the current request.

shouldShowSidebar :: Handler Bool

Find out if the sidebar should be visible. Show it, unless there is a showsidebar cookie set to "0", or a ?sidebar=0 query parameter.

getCurrentJournal :: IORef Journal -> CliOpts -> Day -> Handler (Journal, Maybe String)

Update our copy of the journal if the file changed. If there is an error while reloading, keep the old one and return the error, and set a ui message.

Orphan instances

Show Markup

Methods

showsPrec :: Int -> Markup -> ShowS

show :: Markup -> String

showList :: [Markup] -> ShowS