Safe Haskell	None
Language	Haskell98

Snap.Snaplet.Auth.Backends.Persistent

Contents

Persistent Auth Data Types

Synopsis

Documentation

data PersistAuthManager Source

Instances

IAuthBackend PersistAuthManager

initPersistAuthManager :: SnapletLens b SessionManager -> ConnectionPool -> SnapletInit b (AuthManager b) Source

Initializer that gets AuthSettings from a config file.

initPersistAuthManager' :: AuthSettings -> SnapletLens b SessionManager -> ConnectionPool -> SnapletInit b (AuthManager b) Source

Initializer that lets you specify AuthSettings.

authEntityDefs :: [EntityDef] Source

The list of entity definitions this snaplet exposes. You need them so that you can append to your application's list of entity definitions and perform the migration in one block.

See how this example combined an app's own entity definitions and the auth snaplet's in one migration block:

share [mkMigrate "migrateAll"] $
   authEntityDefs ++
   $(persistFileWith lowerCaseSettings "schema.txt")

Persistent Auth Data Types

Persistent creates its own data types mirroring the database schema, so we have to export this extra layer of types and conversion to AuthUser.

data SnapAuthUser Source

Constructors

SnapAuthUser

Fields

snapAuthUserLogin :: !Text
snapAuthUserEmail :: !Text
snapAuthUserPassword :: !Text
snapAuthUserActivatedAt :: !(Maybe UTCTime)
snapAuthUserSuspendedAt :: !(Maybe UTCTime)
snapAuthUserRememberToken :: !(Maybe Text)
snapAuthUserLoginCount :: !Int
snapAuthUserFailedLoginCount :: !Int
snapAuthUserLockedOutUntil :: !(Maybe UTCTime)
snapAuthUserCurrentLoginAt :: !(Maybe UTCTime)
snapAuthUserLastLoginAt :: !(Maybe UTCTime)
snapAuthUserCurrentIp :: !(Maybe Text)
snapAuthUserLastIp :: !(Maybe Text)
snapAuthUserCreatedAt :: !UTCTime
snapAuthUserUpdatedAt :: !UTCTime
snapAuthUserResetToken :: !(Maybe Text)
snapAuthUserResetRequestedAt :: !(Maybe UTCTime)
snapAuthUserRoles :: !String
snapAuthUserMeta :: !String

Instances

PersistFieldSql SnapAuthUser
PersistEntity SnapAuthUser
PersistField SnapAuthUser
ToBackendKey SqlBackend SnapAuthUser
Eq (Key SnapAuthUser)
Ord (Key SnapAuthUser)
Read (Key SnapAuthUser)
Show (Key SnapAuthUser)
ToJSON (Key SnapAuthUser)
FromJSON (Key SnapAuthUser)
PathPiece (Key SnapAuthUser)
PersistFieldSql (Key SnapAuthUser)
PersistField (Key SnapAuthUser)
data Unique SnapAuthUser
data EntityField SnapAuthUser where SnapAuthUserId :: (~) * typ (Key SnapAuthUser) => EntityField SnapAuthUser typ SnapAuthUserLogin :: (~) * typ Text => EntityField SnapAuthUser typ SnapAuthUserEmail :: (~) * typ Text => EntityField SnapAuthUser typ SnapAuthUserPassword :: (~) * typ Text => EntityField SnapAuthUser typ SnapAuthUserActivatedAt :: (~) * typ (Maybe UTCTime) => EntityField SnapAuthUser typ SnapAuthUserSuspendedAt :: (~) * typ (Maybe UTCTime) => EntityField SnapAuthUser typ SnapAuthUserRememberToken :: (~) * typ (Maybe Text) => EntityField SnapAuthUser typ SnapAuthUserLoginCount :: (~) * typ Int => EntityField SnapAuthUser typ SnapAuthUserFailedLoginCount :: (~) * typ Int => EntityField SnapAuthUser typ SnapAuthUserLockedOutUntil :: (~) * typ (Maybe UTCTime) => EntityField SnapAuthUser typ SnapAuthUserCurrentLoginAt :: (~) * typ (Maybe UTCTime) => EntityField SnapAuthUser typ SnapAuthUserLastLoginAt :: (~) * typ (Maybe UTCTime) => EntityField SnapAuthUser typ SnapAuthUserCurrentIp :: (~) * typ (Maybe Text) => EntityField SnapAuthUser typ SnapAuthUserLastIp :: (~) * typ (Maybe Text) => EntityField SnapAuthUser typ SnapAuthUserCreatedAt :: (~) * typ UTCTime => EntityField SnapAuthUser typ SnapAuthUserUpdatedAt :: (~) * typ UTCTime => EntityField SnapAuthUser typ SnapAuthUserResetToken :: (~) * typ (Maybe Text) => EntityField SnapAuthUser typ SnapAuthUserResetRequestedAt :: (~) * typ (Maybe UTCTime) => EntityField SnapAuthUser typ SnapAuthUserRoles :: (~) * typ String => EntityField SnapAuthUser typ SnapAuthUserMeta :: (~) * typ String => EntityField SnapAuthUser typ
data Key SnapAuthUser = SnapAuthUserKey { unSnapAuthUserKey :: BackendKey SqlBackend }
type PersistEntityBackend SnapAuthUser = SqlBackend

type SnapAuthUserId = Key SnapAuthUser Source

migrateAuth :: Migration Source

db2au :: Entity SnapAuthUser -> AuthUser Source

Function to convert a SnapAuthUser entity into the auth snaplet's AuthUser.

dbUserSplices :: Monad n => Splices (RuntimeSplice n (Entity SnapAuthUser) -> Splice n) Source

Splices for SnapAuthUser that are equivalent to the ones for AuthUser.

userDBKey :: AuthUser -> Maybe SnapAuthUserId Source

Get the db key from an AuthUser

textPassword :: Password -> Text Source