puzzleweb

Documentation

Index

• Constants
• func CreateTemplate(redirecter common.TemplateRedirecter) gin.HandlerFunc
• func GetLocalesManager(c *gin.Context) common.LocalesManager
• func GetLogger(c *gin.Context) log.Logger
• func GetRequestedUserId(c *gin.Context) uint64
• func GetSessionUserId(c *gin.Context) uint64
• func InitNoELementMsg(data gin.H, size int, c *gin.Context)
• func Run(ginLogger *zap.Logger, sites ...SiteAndConfig) error
• type GroupDisplay
  • func NewGroupDisplay(id uint64, name string) *GroupDisplay
• type Page
  • func MakeHiddenPage(name string) Page
  • func MakeHiddenStaticPage(name string, groupId uint64, templateName string) Page
  • func MakePage(name string) Page
  • func MakeStaticPage(name string, groupId uint64, templateName string) Page
  • func (p Page) AddStaticPages(pageGroup parser.StaticPagesConfig) bool
  • func (p Page) AddSubPage(page Page) bool
  • func (p Page) GetSubPage(name string) (Page, bool)
  • func (p Page) GetSubPageWithPath(path string) (Page, bool)
• type PageDesc
• type RoleDisplay
  • func MakeRoleDisplay(role adminservice.Role) RoleDisplay
• type Session
  • func GetSession(c *gin.Context) *Session
  • func (s *Session) AsMap() map[string]string
  • func (s *Session) Delete(key string)
  • func (s *Session) Load(key string) string
  • func (s *Session) Store(key string, value string)
• type SettingsManager
  • func NewSettingsManager(settingsConfig config.SettingsConfig) *SettingsManager
  • func (m *SettingsManager) Get(ctx context.Context, userId uint64, c *gin.Context) map[string]string
  • func (m *SettingsManager) Update(ctx context.Context, userId uint64, settings map[string]string) error
• type Site
  • func NewSite(configExtracter config.BaseConfigExtracter, ...) *Site
  • func (site *Site) AddDefaultData(adder common.DataAdder)
  • func (site *Site) AddPage(page Page)
  • func (site *Site) AddStaticPages(pageGroup parser.StaticPagesConfig) bool
  • func (site *Site) GetPage(name string) (Page, bool)
  • func (site *Site) GetPageWithPath(path string) (Page, bool)
  • func (site *Site) Run(siteConfig config.SiteConfig) error
  • func (site *Site) RunListener(siteConfig config.SiteConfig, listener net.Listener) error
• type SiteAndConfig
• type Widget

Constants

const (
	SessionName = "Session"
)

Functions

func CreateTemplate

func CreateTemplate(redirecter common.TemplateRedirecter) gin.HandlerFunc

func GetLocalesManager

func GetLocalesManager(c *gin.Context) common.LocalesManager

func GetLogger

func GetLogger(c *gin.Context) log.Logger

func GetRequestedUserId

func GetRequestedUserId(c *gin.Context) uint64

func GetSessionUserId

func GetSessionUserId(c *gin.Context) uint64

func InitNoELementMsg

func InitNoELementMsg(data gin.H, size int, c *gin.Context)

func Run

func Run(ginLogger *zap.Logger, sites ...SiteAndConfig) error

Types

type GroupDisplay

type GroupDisplay struct {
	Id           uint64
	Name         string
	DisplayName  string
	Roles        []RoleDisplay
	AddableRoles []RoleDisplay
}

func NewGroupDisplay

func NewGroupDisplay(id uint64, name string) *GroupDisplay

type Page

type Page struct {
	Widget Widget
	// contains filtered or unexported fields
}

func MakeHiddenPage

func MakeHiddenPage(name string) Page

func MakeHiddenStaticPage

func MakeHiddenStaticPage(name string, groupId uint64, templateName string) Page

func MakePage

func MakePage(name string) Page

func MakeStaticPage

func MakeStaticPage(name string, groupId uint64, templateName string) Page

func (Page) AddStaticPages

func (p Page) AddStaticPages(pageGroup parser.StaticPagesConfig) bool

func (Page) AddSubPage

func (p Page) AddSubPage(page Page) bool

func (Page) GetSubPage

func (p Page) GetSubPage(name string) (Page, bool)

func (Page) GetSubPageWithPath

func (p Page) GetSubPageWithPath(path string) (Page, bool)

type PageDesc

type PageDesc struct {
	Name string
	Url  string
}

type RoleDisplay

type RoleDisplay struct {
	Name    string
	Actions []string
}

func MakeRoleDisplay

func MakeRoleDisplay(role adminservice.Role) RoleDisplay

type Session

type Session struct {
	// contains filtered or unexported fields
}

func GetSession

func GetSession(c *gin.Context) *Session

func (*Session) AsMap

func (s *Session) AsMap() map[string]string

Writing in the returned map will not be saved.

func (*Session) Delete

func (s *Session) Delete(key string)

func (*Session) Load

func (s *Session) Load(key string) string

func (*Session) Store

func (s *Session) Store(key string, value string)

type SettingsManager

type SettingsManager struct {
	config.SettingsConfig
	InitSettings  func(*gin.Context) map[string]string
	CheckSettings func(map[string]string, *gin.Context) error
}

func NewSettingsManager

func NewSettingsManager(settingsConfig config.SettingsConfig) *SettingsManager

func (*SettingsManager) Get

func (m *SettingsManager) Get(ctx context.Context, userId uint64, c *gin.Context) map[string]string

func (*SettingsManager) Update

func (m *SettingsManager) Update(ctx context.Context, userId uint64, settings map[string]string) error

type Site

type Site struct {
	// contains filtered or unexported fields
}

func NewSite

func NewSite(configExtracter config.BaseConfigExtracter, localesManager common.LocalesManager, settingsManager *SettingsManager) *Site

func (*Site) AddDefaultData

func (site *Site) AddDefaultData(adder common.DataAdder)

func (*Site) AddPage

func (site *Site) AddPage(page Page)

func (*Site) AddStaticPages

func (site *Site) AddStaticPages(pageGroup parser.StaticPagesConfig) bool

func (*Site) GetPage

func (site *Site) GetPage(name string) (Page, bool)

func (*Site) GetPageWithPath

func (site *Site) GetPageWithPath(path string) (Page, bool)

func (*Site) Run

func (site *Site) Run(siteConfig config.SiteConfig) error

func (*Site) RunListener

func (site *Site) RunListener(siteConfig config.SiteConfig, listener net.Listener) error

type SiteAndConfig

type SiteAndConfig struct {
	Site   *Site
	Config config.SiteConfig
}

type Widget

type Widget interface {
	LoadInto(gin.IRouter)
}