users

type App interface {
	// Authenticated adds a logged-in user's ID to the session
	Authenticated(r *http.Request, id int64)

	// Flash adds a confirmation message to the next page, via the session
	Flash(r *http.Request, msg string)

	// GetRedirect returns the next page after log-in, probably from a session key
	GetRedirect(r *http.Request) string

	// Log optionally records an error
	Log(error)

	// LogThreat optionally records a rejected request to sign-up or log-in
	LogThreat(msg string, r *http.Request)

	// OnRemoveUser is called to delete any application data for a user
	OnRemoveUser(tx etx.TxId, user *User)

	// Render writes an HTTP response using the specified template and template field Users
	Render(w http.ResponseWriter, r *http.Request, template string, usersData interface{})

	// Rollback requests that the transaction started by Serialise be cancelled.
	Rollback()

	// Serialise optionally requests application-level serialisation.
	// If updates=true, the store is to be updated and a transaction might be started (especially if a user is to be added or deleted).
	// The returned function will be called at the end of the operation.
	Serialise(updates bool) func()

	// Token returns a token to be added to the form as the hidden field csrf_token.
	Token(r *http.Request) string
}

type User struct {
	Id       int64     // database ID
	Parent   int64     // parent ID, if multiple sets of user are supported
	Username string    // unique name for user, typically an email address
	Name     string    // display name for user
	Role     int       // user's role (normal, administrator, etc.)
	Status   int       // user's status
	Password []byte    // hashed password
	Created  time.Time // time of first registration
}

type UserFormData struct {
	multiforms.Child
	Username    string
	DisplayName string
	NUser       int64
	Role        int
	Status      int
}

type UserStore interface {
	ByName() []*User                         // all users, in name order
	DeleteId(id int64) error                 // delete user
	Get(id int64) (*User, error)             // get user by database ID
	GetNamed(username string) (*User, error) // get user for username (expected to be unique)
	IsNoRecord(error) bool                   // true if error is "record not found"
	Name(id int64) string                    // get display name for user by database ID
	Rollback()                               // (redundant)
	Update(s *User) error                    // add or update user
}

type Users struct {
	App   App
	Roles []string
	Store UserStore
	TM    *etx.TM
}

type UsersForm struct {
	multiforms.Form
	RoleOpts   []string
	StatusOpts []string
	Children   []*UserFormData
	App        interface{}
}