gosora/common/pages.go

package common

import (
    "html/template"
    "net/http"
    "runtime"
    "sync"
    "time"

    p "github.com/Azareal/Gosora/common/phrases"
)

/*type HResource struct {
    Name string
    Hash string
}*/

// TODO: Allow resources in spots other than /s/ 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         []HScript
    PreScriptsAsync []HScript
    ScriptsAsync    []HScript
    //Preload []string
    Stylesheets []HScript
    Widgets     PageWidgets
    Site        *site
    Settings    SettingMap
    //Themes      map[string]*Theme // TODO: Use a slice containing every theme instead of the main map for speed?
    ThemesSlice []*Theme
    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
    ZoneID      int
    ZoneData    interface{}
    Path        string
    MetaDesc    string
    //OGImage string
    OGDesc         string
    GoogSiteVerify string
    IsoCode        string
    LooseCSP       bool
    ExternalMedia  bool
    //StartedAt      time.Time
    StartedAt int64
    Elapsed1  string
    Writer    http.ResponseWriter
    ExtData   ExtData
}

type HScript struct {
    Name string
    Hash string
}

func (h *Header) getScript(name string) HScript {
    if name[0] == '/' && name[1] == '/' {
    } else {
        file, ok := StaticFiles.GetShort(name)
        if ok {
            return HScript{file.OName, file.Sha256I}
        }
    }
    return HScript{name, ""}
}

func (h *Header) AddScript(name string) {
    //log.Print("name:", name)
    h.Scripts = append(h.Scripts, h.getScript(name))
}

func (h *Header) AddPreScriptAsync(name string) {
    h.PreScriptsAsync = append(h.PreScriptsAsync, h.getScript(name))
}

func (h *Header) AddScriptAsync(name string) {
    h.ScriptsAsync = append(h.ScriptsAsync, h.getScript(name))
}

/*func (h *Header) Preload(name string) {
    h.Preload = append(h.Preload, name)
}*/

func (h *Header) AddSheet(name string) {
    h.Stylesheets = append(h.Stylesheets, h.getScript(name))
}

// ! Experimental
func (h *Header) AddXRes(names ...string) {
    var o string
    for i, name := range names {
        if name[0] == '/' && name[1] == '/' {
        } else {
            file, ok := StaticFiles.GetShort(name)
            if ok {
                name = file.OName
            }
        }
        if i != 0 {
            o += "," + name
        } else {
            o += name
        }
    }
    h.Writer.Header().Set("X-Res", o)
}

func (h *Header) AddNotice(name string) {
    h.NoticeList = append(h.NoticeList, p.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 PaginatorMod struct {
    Params   template.URL
    PageList []int
    Page     int
    LastPage int
}

type CustomPagePage struct {
    *Header
    Page *CustomPage
}

type TopicCEditPost struct {
    ID     int
    Source string
    Ref    string
}
type TopicCAttachItem struct {
    ID       int
    ImgSrc   string
    Path     string
    FullPath string
}
type TopicCPollInput struct {
    Index int
    Place string
}

type TopicPage struct {
    *Header
    ItemList []*ReplyUser
    Topic    TopicUser
    Forum    *Forum
    Poll     *Poll
    Paginator
}

type TopicListSort struct {
    SortBy    string // lastupdate, mostviewed, mostviewedtoday, mostviewedthisweek, mostviewedthismonth
    Ascending bool
}

type QuickTools struct {
    CanDelete bool
    CanLock   bool
    CanMove   bool
}

type TopicListPage struct {
    *Header
    TopicList    []TopicsRowMut
    ForumList    []Forum
    DefaultForum int
    Sort         TopicListSort
    SelectedFids []int
    QuickTools
    Paginator
}

type ForumPage struct {
    *Header
    ItemList []TopicsRowMut
    Forum    *Forum
    CanLock  bool
    CanMove  bool
    Paginator
}

type ForumsPage struct {
    *Header
    ItemList []Forum
}

type ProfilePage struct {
    *Header
    ItemList     []*ReplyUser
    ProfileOwner User
    CurrentScore int
    NextScore    int
    Blocked      bool
    CanMessage   bool
    CanComment   bool
    ShowComments bool
}

type CreateTopicPage struct {
    *Header
    ItemList []Forum
    FID      int
}

type IPSearchPage struct {
    *Header
    ItemList map[int]*User
    IP       string
}

// WIP: Optional anti-bot methods
type RegisterVerifyImageGridImage struct {
    Src string
}
type RegisterVerifyImageGrid struct {
    Question string
    Items    []RegisterVerifyImageGridImage
}
type RegisterVerify struct {
    NoScript bool

    Image *RegisterVerifyImageGrid
}

type RegisterPage struct {
    *Header
    RequireEmail bool
    Token        string
    Verify       []RegisterVerify
}

type Account struct {
    *Header
    HTMLID   string
    TmplName string
    Inner    nobreak
}

type EmailListPage struct {
    *Header
    ItemList []Email
}

type AccountLoginsPage struct {
    *Header
    ItemList []LoginLogItem
    Paginator
}

type AccountBlocksPage struct {
    *Header
    Users []*User
    Paginator
}

type AccountPrivacyPage struct {
    *Header
    ProfileComments int
    ReceiveConvos   int
    EnableEmbeds    bool
}

type AccountDashPage struct {
    *Header
    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 ResetPage struct {
    *Header
    UID   int
    Token string
    MFA   bool
}

type ConvoListRow struct {
    *ConversationExtra
    ShortUsers []*User
    OneOnOne   bool
}

type ConvoListPage struct {
    *Header
    Convos []ConvoListRow
    Paginator
}

type ConvoViewRow struct {
    *ConversationPost
    User         *User
    ClassName    string
    ContentLines int

    CanModify bool
}

type ConvoViewPage struct {
    *Header
    Convo    *Conversation
    Posts    []ConvoViewRow
    Users    []*User
    CanReply bool
    Paginator
}

type ConvoCreatePage struct {
    *Header
    RecpName string
}

/* WIP for dyntmpl */
type Panel struct {
    *BasePanelPage
    HTMLID     string
    ClassNames string
    TmplName   string
    Inner      nobreak
}
type PanelAnalytics struct {
    *BasePanelPage
    FormAction string
    TmplName   string
    Inner      nobreak
}
type PanelAnalyticsStd struct {
    Graph     PanelTimeGraph
    ViewItems []PanelAnalyticsItem
    TimeRange string
    Unit      string
    TimeType  string
}
type PanelAnalyticsStdUnit struct {
    Graph     PanelTimeGraph
    ViewItems []PanelAnalyticsItemUnit
    TimeRange string
    Unit      string
    TimeType  string
}
type PanelAnalyticsActiveMemory struct {
    Graph     PanelTimeGraph
    ViewItems []PanelAnalyticsItemUnit
    TimeRange string
    Unit      string
    TimeType  string
    MemType   int
}
type PanelAnalyticsPerf struct {
    Graph     PanelTimeGraph
    ViewItems []PanelAnalyticsItemUnit
    TimeRange string
    Unit      string
    TimeType  string
    PerfType  int
}

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
    DebugAdmin    bool
}
type PanelPage struct {
    *BasePanelPage
    ItemList  []interface{}
    Something interface{}
}

type GridElement struct {
    ID         string
    Href       string
    Body       string
    Order      int // For future use
    Class      string
    Background string
    TextColour string
    Note       string
}
type DashGrids struct {
    Grid1 []GridElement
    Grid2 []GridElement
}
type PanelDashboardPage struct {
    *BasePanelPage
    Grids DashGrids
}

type PanelSetting struct {
    *Setting
    FriendlyName string
}
type PanelSettingPage struct {
    *BasePanelPage
    ItemList []OptionLabel
    Setting  *PanelSetting
}

type PanelUserEditPage struct {
    *BasePanelPage
    Groups    []*Group
    User      *User
    ShowEmail bool
}

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 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
    Legends []string
}

type PanelAnalyticsItem struct {
    Time  int64
    Count int64
}
type PanelAnalyticsItemUnit struct {
    Time  int64
    Count int64
    Unit  string
}

type PanelAnalyticsPage struct {
    *BasePanelPage
    Graph     PanelTimeGraph
    ViewItems []PanelAnalyticsItem
    TimeRange string
    Unit      string
    TimeType  string
}

type PanelAnalyticsRoutesItem struct {
    Route string
    Count int
}

type PanelAnalyticsRoutesPage struct {
    *BasePanelPage
    ItemList  []PanelAnalyticsRoutesItem
    Graph     PanelTimeGraph
    TimeRange string
}

type PanelAnalyticsRoutesPerfItem struct {
    Route string
    Count int
    Unit  string
}

type PanelAnalyticsRoutesPerfPage struct {
    *BasePanelPage
    ItemList  []PanelAnalyticsRoutesPerfItem
    Graph     PanelTimeGraph
    TimeRange string
}

// TODO: Rename the fields as this structure is being used in a generic way now
type PanelAnalyticsAgentsItem struct {
    Agent         string
    FriendlyAgent string
    Count         int
}

type PanelAnalyticsAgentsPage struct {
    *BasePanelPage
    ItemList  []PanelAnalyticsAgentsItem
    TimeRange string
}

type PanelAnalyticsReferrersPage struct {
    *BasePanelPage
    ItemList  []PanelAnalyticsAgentsItem
    TimeRange string
    ShowSpam  bool
}

type PanelAnalyticsRoutePage struct {
    *BasePanelPage
    Route     string
    Graph     PanelTimeGraph
    ViewItems []PanelAnalyticsItem
    TimeRange string
}

type PanelAnalyticsAgentPage struct {
    *BasePanelPage
    Agent         string
    FriendlyAgent string
    Graph         PanelTimeGraph
    TimeRange     string
}

type PanelAnalyticsDuoPage struct {
    *BasePanelPage
    ItemList  []PanelAnalyticsAgentsItem
    Graph     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 PanelWidgetListPage struct {
    *BasePanelPage
    Docks       map[string][]WidgetEdit
    BlankWidget WidgetEdit
}

type PanelMenuPage struct {
    *BasePanelPage
    MenuID   int
    ItemList []MenuItem
}

type PanelMenuItemPage struct {
    *BasePanelPage
    Item MenuItem
}

type PanelUserPageSearch struct {
    Name  string
    Email string
    Group int

    Any bool
}
type PanelUserPage struct {
    *BasePanelPage
    ItemList []*User
    Groups   []*Group
    Search   PanelUserPageSearch
    PaginatorMod
}

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
    Actions []*ForumActionAction
}

type ForumActionAction struct {
    *ForumAction
    ActionName string
}

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
    ModPerms    []NameLangToggle
}

type GroupPromotionExtend struct {
    *GroupPromotion
    FromGroup *Group
    ToGroup   *Group
}

type PanelEditGroupPromotionsPage struct {
    *BasePanelPage
    ID         int
    Name       string
    Promotions []*GroupPromotionExtend
    Groups     []*Group
}

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
    IP     string
    DoneAt string
}

type PanelLogsPage struct {
    *BasePanelPage
    Logs []PageLogItem
    Paginator
}

type PageRegLogItem struct {
    RegLogItem
    ParsedReason string
}

type PanelRegLogsPage struct {
    *BasePanelPage
    Logs []PageRegLogItem
    Paginator
}

type DebugPageTasks struct {
    HalfSecond    int
    Second        int
    FifteenMinute int
    Hour          int
    Day           int
    Shutdown      int
}

type DebugPageCache struct {
    Topics  int
    Users   int
    Replies int

    TCap int
    UCap int
    RCap int

    TopicListThaw bool
}

type DebugPageDatabase struct {
    Topics         int
    Users          int
    Replies        int
    ProfileReplies int
    ActivityStream int
    Likes          int
    Attachments    int
    Polls          int

    LoginLogs int
    RegLogs   int
    ModLogs   int
    AdminLogs int

    Views          int
    ViewsAgents    int
    ViewsForums    int
    ViewsLangs     int
    ViewsReferrers int
    ViewsSystems   int
    PostChunks     int
    TopicChunks    int
}

type DebugPageDisk struct {
    Static      int
    Attachments int
    Avatars     int
    Logs        int
    Backups     int
    Git         int
}

type PanelDebugPage struct {
    *BasePanelPage
    GoVersion string
    DBVersion string
    Uptime    string

    DBConns   int
    DBAdapter string

    Goroutines int
    CPUs       int
    HttpConns  int

    Tasks    DebugPageTasks
    MemStats runtime.MemStats
    Cache    DebugPageCache
    Database DebugPageDatabase
    Disk     DebugPageDisk
}

type PanelTaskTask struct {
    Name string
    Type int // 0 = halfsec, 1 = sec, 2 = fifteenmin, 3 = hour, 4 = shutdown
}
type PanelTaskType struct {
    Name string
    FAvg string
}
type PanelTaskPage struct {
    *BasePanelPage
    Tasks []PanelTaskTask
    Types []PanelTaskType
}

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, u *User) *Header {
    return &Header{Site: Site, Theme: Themes[fallbackTheme], CurrentUser: u, Writer: w}
}
func SimpleDefaultHeader(w http.ResponseWriter) *Header {
    return &Header{Site: Site, Theme: Themes[fallbackTheme], CurrentUser: &GuestUser, Writer: w}
}