siteengines

package module
v0.0.0-...-13f01f9 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 30, 2020 License: MIT Imports: 16 Imported by: 2

README

DEPRECATED

Currently does not build.

A collections of "engines" for the genericsite web framework for Go.

Build Status

"Engines"

  • AJAX Chat
  • A simple wiki
  • An admin panel for the admin user
  • A user registration system (with email and confirmation codes)
  • A simple search function that also searches dynamic pages, (but does not search the wiki and chat yet)
  • A few other engines that are incomplete

General information

  • License: MIT
  • Author: Alexander F. Rødseth

Documentation

Index

Constants

View Source 
const (
	FOUND_IN_URL = iota
	FOUND_IN_TITLE
	FOUND_IN_TEXT
)

Variables

This section is empty.

Functions

func AllPlansDummyContent 

func AllPlansDummyContent() *personplan.Plans

func GenerateAdminStatus 

func GenerateAdminStatus(state pinterface.IUserState) SimpleContextHandle

TODO: Log and graph when people visit pages and when people contribute content This one is wrapped by ServeAdminPages

func GenerateAllUsernames 

func GenerateAllUsernames(state pinterface.IUserState) SimpleContextHandle

func GenerateConfirmUser 

func GenerateConfirmUser(state pinterface.IUserState) WebHandle

Create a user by adding the username to the list of usernames

func GenerateLoginUser 

func GenerateLoginUser(state pinterface.IUserState) WebHandle

Log in a user by changing the loggedin value

func GenerateLogoutCurrentUser 

func GenerateLogoutCurrentUser(state pinterface.IUserState) SimpleContextHandle

Log out a user by changing the loggedin value

func GenerateNoJavascriptMessage 

func GenerateNoJavascriptMessage() SimpleContextHandle

func GenerateRegisterUser 

func GenerateRegisterUser(state pinterface.IUserState, site string) WebHandle

Register a new user, site is ie. "archlinux.no"

func GenerateRemoveUnconfirmedUser 

func GenerateRemoveUnconfirmedUser(state pinterface.IUserState) WebHandle

Remove an unconfirmed user

func GenerateRemoveUser 

func GenerateRemoveUser(state pinterface.IUserState) WebHandle

TODO: Undo for removing users Remove a user

func GenerateSearchCSS 

func GenerateSearchCSS(cs *ColorScheme) SimpleContextHandle

func GenerateSearchHandle 

func GenerateSearchHandle(pc PageCollection) WebHandle

Generate a search handle. This is done in order to be able to modify the cp Searches a list of ContentPage structs

func GenerateStatusCurrentUser 

func GenerateStatusCurrentUser(state pinterface.IUserState) SimpleContextHandle

func GenerateStatusUser 

func GenerateStatusUser(state pinterface.IUserState) WebHandle

func GenerateToggleAdmin 

func GenerateToggleAdmin(state pinterface.IUserState) WebHandle

func LeaveChat 

func LeaveChat(ce *ChatEngine, username string)

func LoginCP 

func LoginCP(basecp BaseCP, state pinterface.IUserState, url string) *ContentPage

func Num2dd 

func Num2dd(num int) string

Convert from a number to a double digit string

func RegisterCP 

func RegisterCP(basecp BaseCP, state pinterface.IUserState, url string) *ContentPage

func RenderWeekFrom 

func RenderWeekFrom(t time.Time, locale string) string

func ServeSearchPages 

func ServeSearchPages(basecp BaseCP, state pinterface.IUserState, cps PageCollection, cs *ColorScheme, tpg TemplateValueGenerator)

func ValidUsernamePassword 

func ValidUsernamePassword(username, password string) error

Check that the given username and password are different. Also check if the chosen username only contains letters, numbers and/or underscore. Use the "CorrectPassword" function for checking if the password is correct.

Types

type AdminEngine 

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

func NewAdminEngine 

func NewAdminEngine(state pinterface.IUserState) (*AdminEngine, error)

func (*AdminEngine) GenerateCSS 

func (ae *AdminEngine) GenerateCSS(cs *ColorScheme) SimpleContextHandle

func (*AdminEngine) ServePages 

func (ae *AdminEngine) ServePages(basecp BaseCP, menuEntries MenuEntries)

type ChatEngine 

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

func NewChatEngine 

func NewChatEngine(userState pinterface.IUserState) (*ChatEngine, error)

func (*ChatEngine) ChatText 

func (ce *ChatEngine) ChatText() []string

Get current text of the chat

func (*ChatEngine) ChatUsers 

func (ce *ChatEngine) ChatUsers() []string

Get current users of the chat

func (*ChatEngine) GenerateCSS 

func (ce *ChatEngine) GenerateCSS(cs *ColorScheme) SimpleContextHandle

func (*ChatEngine) GenerateChatCurrentUser 

func (ce *ChatEngine) GenerateChatCurrentUser() SimpleContextHandle

func (*ChatEngine) GenerateGetChatLinesCurrentUser 

func (ce *ChatEngine) GenerateGetChatLinesCurrentUser() SimpleContextHandle

func (*ChatEngine) GenerateSayCurrentUser 

func (ce *ChatEngine) GenerateSayCurrentUser() SimpleContextHandle

func (*ChatEngine) GenerateSetChatLinesCurrentUser 

func (ce *ChatEngine) GenerateSetChatLinesCurrentUser() SimpleContextHandle

func (*ChatEngine) GetLastChatText 

func (ce *ChatEngine) GetLastChatText(n int) []string

Get the last N entries

func (*ChatEngine) GetLastSeen 

func (ce *ChatEngine) GetLastSeen(username string) string

func (*ChatEngine) GetLines 

func (ce *ChatEngine) GetLines(username string) int

func (*ChatEngine) IsChatting 

func (ce *ChatEngine) IsChatting(username string) bool

func (*ChatEngine) JoinChat 

func (ce *ChatEngine) JoinChat(username string)

func (*ChatEngine) Say 

func (ce *ChatEngine) Say(username, text string)

func (*ChatEngine) Seen 

func (ce *ChatEngine) Seen(username string)

Mark a user as seen

func (*ChatEngine) SeenLately 

func (ce *ChatEngine) SeenLately(username string) bool

Checks if the user has been seen lately (within 12 hours ago)

func (*ChatEngine) ServePages 

func (ce *ChatEngine) ServePages(basecp BaseCP, menuEntries MenuEntries)

func (*ChatEngine) SetChatting 

func (ce *ChatEngine) SetChatting(username string, val bool)

Set "chatting" to "true" or "false" for a given user

func (*ChatEngine) SetLines 

func (ce *ChatEngine) SetLines(username string, lines int)

type ChatState 

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

type IPEngine 

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

func NewIPEngine 

func NewIPEngine(userState pinterface.IUserState) (*IPEngine, error)

func (*IPEngine) GenerateGetAllIPs 

func (ie *IPEngine) GenerateGetAllIPs() WebHandle

Get all the stored IP adresses and generate a page for it

func (*IPEngine) GenerateGetLastIP 

func (ie *IPEngine) GenerateGetLastIP() WebHandle

Get the last stored IP adress and generate a page for it

func (*IPEngine) GenerateSetIP 

func (ie *IPEngine) GenerateSetIP() WebHandle

Set an IP adress and generate a confirmation page for it

func (*IPEngine) ServePages 

func (ie *IPEngine) ServePages()

type TimeTableEngine 

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

func NewTimeTableEngine 

func NewTimeTableEngine(userState pinterface.IUserState) (*TimeTableEngine, error)

func (*TimeTableEngine) GenerateCSS 

func (tte *TimeTableEngine) GenerateCSS(cs *ColorScheme) SimpleContextHandle

func (*TimeTableEngine) GenerateShowTimeTable 

func (we *TimeTableEngine) GenerateShowTimeTable() WebHandle

func (*TimeTableEngine) GenerateTimeTableRedirect 

func (we *TimeTableEngine) GenerateTimeTableRedirect() SimpleContextHandle

func (*TimeTableEngine) ServePages 

func (tte *TimeTableEngine) ServePages(basecp BaseCP, menuEntries MenuEntries)

type TimeTableState 

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

type UserEngine 

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

func NewUserEngine 

func NewUserEngine(userState pinterface.IUserState) (*UserEngine, error)

func (*UserEngine) GetState 

func (ue *UserEngine) GetState() pinterface.IUserState

func (*UserEngine) ServePages 

func (ue *UserEngine) ServePages(site string)

Site is ie. "archlinux.no" and used for sending confirmation emails

type WikiEngine 

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

func NewWikiEngine 

func NewWikiEngine(userState pinterface.IUserState) (*WikiEngine, error)

func (*WikiEngine) ChangePage 

func (we *WikiEngine) ChangePage(pageid, newtitle, newtext string)

func (*WikiEngine) CreatePage 

func (we *WikiEngine) CreatePage(pageid string) string

func (*WikiEngine) DeletePage 

func (we *WikiEngine) DeletePage(pageid string)

func (*WikiEngine) GenerateCSS 

func (we *WikiEngine) GenerateCSS(cs *ColorScheme) SimpleContextHandle

func (*WikiEngine) GenerateCreateOrUpdateWiki 

func (we *WikiEngine) GenerateCreateOrUpdateWiki() SimpleContextHandle

func (*WikiEngine) GenerateDeleteWikiNow 

func (we *WikiEngine) GenerateDeleteWikiNow() SimpleContextHandle

func (*WikiEngine) GenerateListPages 

func (we *WikiEngine) GenerateListPages() SimpleContextHandle

func (*WikiEngine) GenerateShowWiki 

func (we *WikiEngine) GenerateShowWiki() WebHandle

func (*WikiEngine) GenerateWikiDeleteForm 

func (we *WikiEngine) GenerateWikiDeleteForm() WebHandle

func (*WikiEngine) GenerateWikiEditForm 

func (we *WikiEngine) GenerateWikiEditForm() WebHandle

func (*WikiEngine) GenerateWikiRedirect 

func (we *WikiEngine) GenerateWikiRedirect() SimpleContextHandle

func (*WikiEngine) GenerateWikiViewSource 

func (we *WikiEngine) GenerateWikiViewSource() WebHandle

func (*WikiEngine) GetText 

func (we *WikiEngine) GetText(pageid string, formatted bool) string

Get a wiki page by page id, either raw or formatted

func (*WikiEngine) GetTitle 

func (we *WikiEngine) GetTitle(pageid string) string

func (*WikiEngine) HasPage 

func (we *WikiEngine) HasPage(pageid string) bool

func (*WikiEngine) ListPages 

func (we *WikiEngine) ListPages() string

func (*WikiEngine) ServePages 

func (we *WikiEngine) ServePages(basecp BaseCP, menuEntries MenuEntries)

type WikiState 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.