package common
import (
"html/template"
"net/http"
"runtime"
"sync"
"time"
"github.com/Azareal/Gosora/common/phrases"
)
// TODO: Allow resources in spots other than /static/ and possibly even external domains (e.g. CDNs)
// TODO: Preload Trumboyg on Cosora on the forum list
type Header struct {
Title string
//Title []byte // Experimenting with []byte for increased efficiency, let's avoid converting too many things to []byte, as it involves a lot of extra boilerplate
NoticeList []string
Scripts []string
//Preload []string
Stylesheets []string
Widgets PageWidgets
Site *site
Settings SettingMap
Themes map[string]*Theme // TODO: Use a slice containing every theme instead of the main map for speed?
Theme *Theme
//TemplateName string // TODO: Use this to move template calls to the router rather than duplicating them over and over and over?
CurrentUser User // TODO: Deprecate CurrentUser on the page structs and use a pointer here
Hooks *HookTable
Zone string
Path string
MetaDesc string
StartedAt time.Time
Elapsed1 string
Writer http.ResponseWriter
ExtData ExtData
}
func (header *Header) AddScript(name string) {
header.Scripts = append(header.Scripts, name)
}
/*func (header *Header) Preload(name string) {
header.Preload = append(header.Preload, name)
}*/
func (header *Header) AddSheet(name string) {
header.Stylesheets = append(header.Stylesheets, name)
}
func (header *Header) AddNotice(name string) {
header.NoticeList = append(header.NoticeList, phrases.GetNoticePhrase(name))
}
// TODO: Add this to routes which don't use templates. E.g. Json APIs.
type HeaderLite struct {
Site *site
Settings SettingMap
Hooks *HookTable
ExtData ExtData
}
type PageWidgets struct {
LeftSidebar template.HTML
RightSidebar template.HTML
}
// TODO: Add a ExtDataHolder interface with methods for manipulating the contents?
// ? - Could we use a sync.Map instead?
type ExtData struct {
Items map[string]interface{} // Key: pluginname
sync.RWMutex
}
type Page struct {
*Header
ItemList []interface{}
Something interface{}
}
type SimplePage struct {
*Header
}
type ErrorPage struct {
*Header
Message string
}
type Paginator struct {
PageList []int
Page int
LastPage int
}
type CustomPagePage struct {
*Header
Page *CustomPage
}
type TopicPage struct {
*Header
ItemList []ReplyUser
Topic TopicUser
Forum *Forum
Poll Poll
Page int
LastPage int
}
type TopicListSort struct {
SortBy string // lastupdate, mostviewed, mostviewedtoday, mostviewedthisweek, mostviewedthismonth
Ascending bool
}
type TopicListPage struct {
*Header
TopicList []*TopicsRow
ForumList []Forum
DefaultForum int
Sort TopicListSort
Paginator
}
type ForumPage struct {
*Header
ItemList []*TopicsRow
Forum *Forum
Paginator
}
type ForumsPage struct {
*Header
ItemList []Forum
}
type ProfilePage struct {
*Header
ItemList []ReplyUser
ProfileOwner User
CurrentScore int
NextScore int
}
type CreateTopicPage struct {
*Header
ItemList []Forum
FID int
}
type IPSearchPage struct {
*Header
ItemList map[int]*User
IP string
}
type EmailListPage struct {
*Header
ItemList []Email
Something interface{}
}
type AccountDashPage struct {
*Header
HTMLID string
TmplName string
MFASetup bool
CurrentScore int
NextScore int
NextLevel int
Percentage int
}
type LevelListItem struct {
Level int
Score int
Status string
Percentage int // 0 to 200 to fit with the CSS logic
}
type LevelListPage struct {
*Header
Levels []LevelListItem
}
type PanelStats struct {
Users int
Groups int
Forums int
Pages int
Settings int
WordFilters int
Themes int
Reports int
}
type BasePanelPage struct {
*Header
Stats PanelStats
Zone string
ReportForumID int
}
type PanelPage struct {
*BasePanelPage
ItemList []interface{}
Something interface{}
}
type GridElement struct {
ID string
Body string
Order int // For future use
Class string
Background string
TextColour string
Note string
}
type PanelDashboardPage struct {
*BasePanelPage
GridItems []GridElement
}
type PanelSetting struct {
*Setting
FriendlyName string
}
type PanelSettingPage struct {
*BasePanelPage
ItemList []OptionLabel
Setting *PanelSetting
}
type PanelCustomPagesPage struct {
*BasePanelPage
ItemList []*CustomPage
Paginator
}
type PanelCustomPageEditPage struct {
*BasePanelPage
Page *CustomPage
}
type PanelTimeGraph struct {
Series []int64 // The counts on the left
Labels []int64 // unixtimes for the bottom, gets converted into 1:00, 2:00, etc. with JS
}
type PanelAnalyticsItem struct {
Time int64
Count int64
}
type PanelAnalyticsPage struct {
*BasePanelPage
PrimaryGraph PanelTimeGraph
ViewItems []PanelAnalyticsItem
TimeRange string
}
type PanelAnalyticsRoutesItem struct {
Route string
Count int
}
type PanelAnalyticsRoutesPage struct {
*BasePanelPage
ItemList []PanelAnalyticsRoutesItem
TimeRange string
}
type PanelAnalyticsAgentsItem struct {
Agent string
FriendlyAgent string
Count int
}
type PanelAnalyticsAgentsPage struct {
*BasePanelPage
ItemList []PanelAnalyticsAgentsItem
TimeRange string
}
type PanelAnalyticsRoutePage struct {
*BasePanelPage
Route string
PrimaryGraph PanelTimeGraph
ViewItems []PanelAnalyticsItem
TimeRange string
}
type PanelAnalyticsAgentPage struct {
*BasePanelPage
Agent string
FriendlyAgent string
PrimaryGraph PanelTimeGraph
TimeRange string
}
type PanelThemesPage struct {
*BasePanelPage
PrimaryThemes []*Theme
VariantThemes []*Theme
}
type PanelMenuListItem struct {
Name string
ID int
ItemCount int
}
type PanelMenuListPage struct {
*BasePanelPage
ItemList []PanelMenuListItem
}
type PanelMenuPage struct {
*BasePanelPage
MenuID int
ItemList []MenuItem
}
type PanelMenuItemPage struct {
*BasePanelPage
Item MenuItem
}
type PanelUserPage struct {
*BasePanelPage
ItemList []*User
Paginator
}
type PanelGroupPage struct {
*BasePanelPage
ItemList []GroupAdmin
Paginator
}
type PanelEditGroupPage struct {
*BasePanelPage
ID int
Name string
Tag string
Rank string
DisableRank bool
}
type GroupForumPermPreset struct {
Group *Group
Preset string
DefaultPreset bool
}
type PanelEditForumPage struct {
*BasePanelPage
ID int
Name string
Desc string
Active bool
Preset string
Groups []GroupForumPermPreset
}
type NameLangToggle struct {
Name string
LangStr string
Toggle bool
}
type PanelEditForumGroupPage struct {
*BasePanelPage
ForumID int
GroupID int
Name string
Desc string
Active bool
Preset string
Perms []NameLangToggle
}
type PanelEditGroupPermsPage struct {
*BasePanelPage
ID int
Name string
LocalPerms []NameLangToggle
GlobalPerms []NameLangToggle
}
type BackupItem struct {
SQLURL string
// TODO: Add an easier to parse format here for Gosora to be able to more easily reimport portions of the dump and to strip unnecessary data (e.g. table defs and parsed post data)
Timestamp time.Time
}
type PanelBackupPage struct {
*BasePanelPage
Backups []BackupItem
}
type PageLogItem struct {
Action template.HTML
IPAddress string
DoneAt string
}
type PanelLogsPage struct {
*BasePanelPage
Logs []PageLogItem
Paginator
}
type PageRegLogItem struct {
RegLogItem
ParsedReason string
}
type PanelRegLogsPage struct {
*BasePanelPage
Logs []PageRegLogItem
Paginator
}
type PanelDebugPage struct {
*BasePanelPage
GoVersion string
DBVersion string
Uptime string
OpenConns int
DBAdapter string
Goroutines int
CPUs int
MemStats runtime.MemStats
}
type PageSimple struct {
Title string
Something interface{}
}
type AreYouSure struct {
URL string
Message string
}
// TODO: Write a test for this
func DefaultHeader(w http.ResponseWriter, user User) *Header {
return &Header{Site: Site, Theme: Themes[fallbackTheme], CurrentUser: user, Writer: w}
}