Copyright	(c) Michael Mounteney, 2016
License	BSD 3 clause
Maintainer	the project name, all lower case, at landcroft dot com
Stability	experimental
Portability	undefined
Safe Haskell	None
Language	Haskell2010

JRState

Description

Synopsis

Documentation

All external data references to one server (various tables) share one connection object. This structure manages it.

Each data source has a corresponding in-memory structure, corresponding to a file handle, database connection etc.

The key of the map is Text because the security subsystem returns a user id, which is Text. TODO: plumb Yesod.Auth to return a numeric id. instead.

The foundation object

Constructors

Fields

logLevel :: LogLevel
detail of diagnostics
tablesFile :: ConnectionPool
name of file containing SQLite3 tables
secureOnly :: Bool
restrict connections to HTTPS
shuffleCards :: Bool
default value for shuffling of per-user reviews
sessionTimeout :: Int
in minutes
portNumber :: Maybe Int
useful to override for non-privileged testing
keysFile :: FilePath
AES keys
databaseUser :: Text
default account with which to open database source tables.
appRoot :: Text
needed for identification emails
postgresConnections :: TVar PostgresConnPool
all tables in a given database share a common PG ConnectionPool
dataSchemes :: TVar DataSchemes
live LearningData.DataSource with opened connections
userConfig :: TVar UserConfig
one per logged-in user

Instances

data Route JRState
data Route JRState = HomeR \| IconR \| ScoreR \| NoticeR Text \| ReviewR Text \| AuthR (Route Auth)
type YesodPersistBackend JRState
type YesodPersistBackend JRState = SqlBackend
type AuthId JRState
type AuthId JRState = Username

Run logging at the user-specified level of detail.

Get the Postgres connection pool map

Get the data source handle map

Get the user configuration map