kb

type Access interface {
	VerifyUser(user User) error

	IsAdmin(user Slug) bool
	SetAdmin(user Slug, isAdmin bool) error

	Rights(group, user Slug) Rights

	// member is either a User or a Group
	AddUser(group, user Slug) error
	RemoveUser(group, user Slug) error

	CommunityAdd(group, member Slug, rights Rights) error
	CommunityRemove(group, member Slug) error

	List(group Slug) ([]Member, error)
}

type Action map[string]interface{}

type Auth interface {
	Verify(w http.ResponseWriter, r *http.Request) (User, error)
}

type Context interface {
	ActiveUserID() Slug
	Access() Access
	Users() Users
	Groups() Groups
	Index(user Slug) Index
	Pages(group Slug) Pages

	GuestLogin() GuestLogin
}

type Database interface {
	Context(user Slug) Context
}

type Group struct {
	ID      Slug
	OwnerID Slug
	Name    string
	Public  bool

	Description string
}

type Groups interface {
	ByID(id Slug) (Group, error)
	Create(group Group) error
	Delete(id Slug) error
	List() ([]Group, error)
}

type GuestLogin interface {
	Add(name, email, password string) error
	// implement auth.Provider
	Boot() template.HTML
	Verify(name, password string) (User, error)
}

type Index interface {
	List() ([]PageEntry, error)

	Search(text string) ([]PageEntry, error)
	SearchFilter(text, exclude, include string) ([]PageEntry, error)

	Tags() ([]TagEntry, error)
	ByTag(tag Slug) ([]PageEntry, error)
	ByTagFilter(tag []Slug, exclude, include string) ([]PageEntry, error)

	Groups(min Rights) ([]Group, error)
	ByGroup(groupID Slug) ([]PageEntry, error)

	ByTitle(title Slug) ([]PageEntry, error)

	RecentChanges(n int) ([]PageEntry, error)
	RecentChangesByGroup(n int, groupID Slug) ([]PageEntry, error)
}

type Item map[string]interface{}

type Member struct {
	ID      Slug
	Name    string
	IsGroup bool
	Access  Rights
}

type Module interface {
	Info() Group
	Pages() []PageEntry
	ServeHTTP(w http.ResponseWriter, r *http.Request)
}

type Page struct {
	Version  int       `json:"version"`
	Slug     Slug      `json:"slug"`
	Title    string    `json:"title"`
	Synopsis string    `json:"synopsis,omitempty"`
	Modified time.Time `json:"modified,omitempty"`
	Story    Story     `json:"story,omitempty"`
}

type PageEntry struct {
	Slug     Slug      `json:"slug"`
	Title    string    `json:"title"`
	Synopsis string    `json:"synopsis"`
	Tags     []string  `json:"tags"`
	Modified time.Time `json:"modified"`
}

type Pages interface {
	Create(page *Page) error

	Load(id Slug) (*Page, error)
	LoadRaw(id Slug) ([]byte, error)
	LoadRawVersion(id Slug, version int) ([]byte, error)

	Overwrite(id Slug, version int, page *Page) error
	Edit(id Slug, version int, action Action) error
	Delete(id Slug, version int) error

	BatchReplace(pages map[Slug]*Page, complete func(string, Slug)) error
	BatchReplaceDelta(pages map[Slug]*Page, complete func(string, Slug)) error

	List() ([]PageEntry, error)
	History(id Slug) ([]PageEntry, error)
}

type Params map[string]interface{}

type Rights string

type Server struct {
	Auth Auth
	Database
	Modules map[Slug]Module
}

type Slug string

type Story []Item

type TagEntry struct {
	Name  string `json:"name"`
	Count int    `json:"count"`
}

type User struct {
	ID        Slug   `json:"id"`
	Email     string `json:"email"`
	Name      string `json:"name"`
	Company   string `json:"company"`
	Admin     bool   `json:"admin"`
	MaxAccess Rights `json:"-"`

	AuthID       string `json:"-"`
	AuthProvider string `json:"-"`
}

type Users interface {
	ByID(id Slug) (User, error)
	Create(user User) error
	Delete(id Slug) error
	List() ([]User, error)
}