site_users

Documentation

Index

• Constants
• Variables
• type CFeature
  • func (f *CFeature) Build(b feature.Buildable) (err error)
  • func (f *CFeature) Construct(this interface{})
  • func (f *CFeature) CreateGroup(r *http.Request, group feature.Group, permissions ...feature.Action) (err error)
  • func (f *CFeature) CreateUser(r *http.Request, origin, rid, eid, email string) (err error)
  • func (f *CFeature) DeleteGroup(r *http.Request, group feature.Group) (err error)
  • func (f *CFeature) DeleteUser(r *http.Request, eid string) (err error)
  • func (f *CFeature) GetUserActive(r *http.Request, eid string) (active bool, err error)
  • func (f *CFeature) GetUserAdminLocked(r *http.Request, eid string) (locked bool, err error)
  • func (f *CFeature) GetUserStatus(r *http.Request, eid string) (active, locked, visitor bool, err error)
  • func (f *CFeature) GroupPresent(group feature.Group) (present bool)
  • func (f *CFeature) Init(this interface{})
  • func (f *CFeature) InitGroup(group feature.Group, actions ...feature.Action) MakeFeature
  • func (f *CFeature) InitUser(email string, group ...feature.Group) MakeFeature
  • func (f *CFeature) IsUserLocked(r *http.Request, eid string) (locked bool)
  • func (f *CFeature) ListUsers(r *http.Request, pg, numPerPage int, sortDesc bool) (list []feature.User, total int)
  • func (f *CFeature) LockUser(r *http.Request, eid string)
  • func (f *CFeature) Make() (feat Feature)
  • func (f *CFeature) MakeEnjinID(rid string) (eid string)
  • func (f *CFeature) MakeRealID(email string) (rid string)
  • func (f *CFeature) RLockUser(r *http.Request, eid string)
  • func (f *CFeature) RUnlockUser(r *http.Request, eid string)
  • func (f *CFeature) RetrieveGroup(r *http.Request, group feature.Group) (permissions feature.Actions, err error)
  • func (f *CFeature) RetrieveUser(r *http.Request, eid string) (user feature.User, err error)
  • func (f *CFeature) SetEnjinSalt(value string) MakeFeature
  • func (f *CFeature) SetGroupPath(path string) MakeFeature
  • func (f *CFeature) SetUserActive(r *http.Request, eid string, active bool) (err error)
  • func (f *CFeature) SetUserAdminLocked(r *http.Request, eid string, locked bool) (err error)
  • func (f *CFeature) SetUserContext(r *http.Request, eid string, ctx beContext.Context) (err error)
  • func (f *CFeature) SetUserGroups(r *http.Request, eid string, groups ...feature.Group) (err error)
  • func (f *CFeature) SetUserImage(r *http.Request, eid string, image string) (err error)
  • func (f *CFeature) SetUserName(r *http.Request, eid string, name string) (err error)
  • func (f *CFeature) SetUserPath(path string) MakeFeature
  • func (f *CFeature) SetUserPermissions(r *http.Request, eid string, permissions ...feature.Action) (err error)
  • func (f *CFeature) SetUserSetting(r *http.Request, eid string, key string, value interface{}) (err error)
  • func (f *CFeature) SetUserSettings(r *http.Request, eid string, ctx beContext.Context) (err error)
  • func (f *CFeature) SignUpUser(r *http.Request, claims *feature.CSiteAuthClaims) (err error)
  • func (f *CFeature) Startup(ctx *cli.Context) (err error)
  • func (f *CFeature) UnlockUser(r *http.Request, eid string)
  • func (f *CFeature) UpdateGroup(r *http.Request, group feature.Group, permissions ...feature.Action) (err error)
  • func (f *CFeature) UpdateUserActive(r *http.Request, eid string, active bool) (err error)
  • func (f *CFeature) UpdateUserAdminLocked(r *http.Request, eid string, locked bool) (err error)
  • func (f *CFeature) UpdateUserContext(r *http.Request, eid string, ctx beContext.Context) (err error)
  • func (f *CFeature) UpdateUserGroups(r *http.Request, eid string, groups ...feature.Group) (err error)
  • func (f *CFeature) UpdateUserImage(r *http.Request, eid string, image string) (err error)
  • func (f *CFeature) UpdateUserName(r *http.Request, eid string, name string) (err error)
  • func (f *CFeature) UpdateUserPermissions(r *http.Request, eid string, permissions ...feature.Action) (err error)
  • func (f *CFeature) UsageNotes() (notes []string)
  • func (f *CFeature) UserActions() (list feature.Actions)
  • func (f *CFeature) UserPresent(eid string) (present bool)
• type Feature
• type MakeFeature
  • func New() MakeFeature
  • func NewTagged(tag feature.Tag) MakeFeature

Constants

const Tag feature.Tag = "fs-site-users"

Variables

var (
	ReadLocksBucket  = "users-read-lock"
	WriteLocksBucket = "users-write-lock"
)

var (
	DefaultUserPath  = "/user"
	DefaultGroupPath = "/group"
)

Types

type CFeature

type CFeature struct {
	filesystem.CFeature[MakeFeature]
	signaling.CSignaling
	uses_kvc.CUsesKVC[MakeFeature]
	uses_actions.CUsesActions

	PermissionViewOwn     feature.Action
	PermissionViewOther   feature.Action
	PermissionUpdateOwn   feature.Action
	PermissionUpdateOther feature.Action
	PermissionDeleteOwn   feature.Action
	PermissionDeleteOther feature.Action

	PermissionSignUpUser  feature.Action
	PermissionCreateUser  feature.Action
	PermissionAdminPerms  feature.Action
	PermissionAdminGroups feature.Action
	// contains filtered or unexported fields
}

func (*CFeature) Build

func (f *CFeature) Build(b feature.Buildable) (err error)

func (*CFeature) Construct

func (f *CFeature) Construct(this interface{})

func (*CFeature) CreateGroup

func (f *CFeature) CreateGroup(r *http.Request, group feature.Group, permissions ...feature.Action) (err error)

func (*CFeature) CreateUser

func (f *CFeature) CreateUser(r *http.Request, origin, rid, eid, email string) (err error)

func (*CFeature) DeleteGroup

func (f *CFeature) DeleteGroup(r *http.Request, group feature.Group) (err error)

func (*CFeature) DeleteUser

func (f *CFeature) DeleteUser(r *http.Request, eid string) (err error)

func (*CFeature) GetUserActive

func (f *CFeature) GetUserActive(r *http.Request, eid string) (active bool, err error)

func (*CFeature) GetUserAdminLocked

func (f *CFeature) GetUserAdminLocked(r *http.Request, eid string) (locked bool, err error)

func (*CFeature) GetUserStatus

func (f *CFeature) GetUserStatus(r *http.Request, eid string) (active, locked, visitor bool, err error)

func (*CFeature) GroupPresent

func (f *CFeature) GroupPresent(group feature.Group) (present bool)

func (*CFeature) Init

func (f *CFeature) Init(this interface{})

func (*CFeature) InitGroup

func (f *CFeature) InitGroup(group feature.Group, actions ...feature.Action) MakeFeature

func (*CFeature) InitUser

func (f *CFeature) InitUser(email string, group ...feature.Group) MakeFeature

func (*CFeature) IsUserLocked

func (f *CFeature) IsUserLocked(r *http.Request, eid string) (locked bool)

func (*CFeature) ListUsers

func (f *CFeature) ListUsers(r *http.Request, pg, numPerPage int, sortDesc bool) (list []feature.User, total int)

func (*CFeature) LockUser

func (f *CFeature) LockUser(r *http.Request, eid string)

func (*CFeature) Make

func (f *CFeature) Make() (feat Feature)

func (*CFeature) MakeEnjinID

func (f *CFeature) MakeEnjinID(rid string) (eid string)

func (*CFeature) MakeRealID

func (f *CFeature) MakeRealID(email string) (rid string)

func (*CFeature) RLockUser

func (f *CFeature) RLockUser(r *http.Request, eid string)

func (*CFeature) RUnlockUser

func (f *CFeature) RUnlockUser(r *http.Request, eid string)

func (*CFeature) RetrieveGroup

func (f *CFeature) RetrieveGroup(r *http.Request, group feature.Group) (permissions feature.Actions, err error)

func (*CFeature) RetrieveUser

func (f *CFeature) RetrieveUser(r *http.Request, eid string) (user feature.User, err error)

func (*CFeature) SetEnjinSalt

func (f *CFeature) SetEnjinSalt(value string) MakeFeature

func (*CFeature) SetGroupPath

func (f *CFeature) SetGroupPath(path string) MakeFeature

func (*CFeature) SetUserActive

func (f *CFeature) SetUserActive(r *http.Request, eid string, active bool) (err error)

func (*CFeature) SetUserAdminLocked

func (f *CFeature) SetUserAdminLocked(r *http.Request, eid string, locked bool) (err error)

func (*CFeature) SetUserContext

func (f *CFeature) SetUserContext(r *http.Request, eid string, ctx beContext.Context) (err error)

func (*CFeature) SetUserGroups

func (f *CFeature) SetUserGroups(r *http.Request, eid string, groups ...feature.Group) (err error)

func (*CFeature) SetUserImage

func (f *CFeature) SetUserImage(r *http.Request, eid string, image string) (err error)

func (*CFeature) SetUserName

func (f *CFeature) SetUserName(r *http.Request, eid string, name string) (err error)

func (*CFeature) SetUserPath

func (f *CFeature) SetUserPath(path string) MakeFeature

func (*CFeature) SetUserPermissions

func (f *CFeature) SetUserPermissions(r *http.Request, eid string, permissions ...feature.Action) (err error)

func (*CFeature) SetUserSetting

func (f *CFeature) SetUserSetting(r *http.Request, eid string, key string, value interface{}) (err error)

func (*CFeature) SetUserSettings

func (f *CFeature) SetUserSettings(r *http.Request, eid string, ctx beContext.Context) (err error)

func (*CFeature) SignUpUser

func (f *CFeature) SignUpUser(r *http.Request, claims *feature.CSiteAuthClaims) (err error)

func (*CFeature) Startup

func (f *CFeature) Startup(ctx *cli.Context) (err error)

func (*CFeature) UnlockUser

func (f *CFeature) UnlockUser(r *http.Request, eid string)

func (*CFeature) UpdateGroup

func (f *CFeature) UpdateGroup(r *http.Request, group feature.Group, permissions ...feature.Action) (err error)

func (*CFeature) UpdateUserActive

func (f *CFeature) UpdateUserActive(r *http.Request, eid string, active bool) (err error)

func (*CFeature) UpdateUserAdminLocked

func (f *CFeature) UpdateUserAdminLocked(r *http.Request, eid string, locked bool) (err error)

func (*CFeature) UpdateUserContext

func (f *CFeature) UpdateUserContext(r *http.Request, eid string, ctx beContext.Context) (err error)

func (*CFeature) UpdateUserGroups

func (f *CFeature) UpdateUserGroups(r *http.Request, eid string, groups ...feature.Group) (err error)

func (*CFeature) UpdateUserImage

func (f *CFeature) UpdateUserImage(r *http.Request, eid string, image string) (err error)

func (*CFeature) UpdateUserName

func (f *CFeature) UpdateUserName(r *http.Request, eid string, name string) (err error)

func (*CFeature) UpdateUserPermissions

func (f *CFeature) UpdateUserPermissions(r *http.Request, eid string, permissions ...feature.Action) (err error)

func (*CFeature) UsageNotes

func (f *CFeature) UsageNotes() (notes []string)

func (*CFeature) UserActions

func (f *CFeature) UserActions() (list feature.Actions)

func (*CFeature) UserPresent

func (f *CFeature) UserPresent(eid string) (present bool)

type Feature

type Feature interface {
	feature.Feature
	feature.SiteUsersProvider
	signaling.Signaling
}

type MakeFeature

type MakeFeature interface {
	filesystem.MakeFeature[MakeFeature]
	uses_kvc.MakeFeature[MakeFeature]

	// SetUserPath specifies the underlying filesystem mount point to use for locating user files
	SetUserPath(path string) MakeFeature

	// SetGroupPath specifies the underlying filesystem mount point to use for locating group files
	SetGroupPath(path string) MakeFeature

	// InitGroup will create the specific group on startup, does nothing if the group already exists
	InitGroup(group feature.Group, actions ...feature.Action) MakeFeature

	// SetEnjinSalt specifies the default random string to use for making new Enjin identifiers (EID) and is overridden
	// by the corresponding command-line flag value (--fs-site-users-enjin-salt)
	SetEnjinSalt(value string) MakeFeature

	Make() Feature
}

func New

func New() MakeFeature

func NewTagged

func NewTagged(tag feature.Tag) MakeFeature