From 67ccca8b4e930b50643a52680d288fc358dc1637 Mon Sep 17 00:00:00 2001 From: Azareal Date: Tue, 11 May 2021 19:25:07 +1000 Subject: [PATCH] Use ThemesSlice instead of Themes in Header struct. --- common/pages.go | 3 +- common/routes_common.go | 30 ++++++------ common/theme_list.go | 103 ++++++++++++++++++++-------------------- 3 files changed, 69 insertions(+), 67 deletions(-) diff --git a/common/pages.go b/common/pages.go index bd9c4c97..82d9983c 100644 --- a/common/pages.go +++ b/common/pages.go @@ -29,7 +29,8 @@ type Header struct { Widgets PageWidgets Site *site Settings SettingMap - Themes map[string]*Theme // TODO: Use a slice containing every theme instead of the main map for speed? + //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 diff --git a/common/routes_common.go b/common/routes_common.go index 30ef3f49..cc6ddaf8 100644 --- a/common/routes_common.go +++ b/common/routes_common.go @@ -111,9 +111,10 @@ func cascadeForumPerms(fp *ForumPerms, u *User) { func panelUserCheck(w http.ResponseWriter, r *http.Request, u *User) (h *Header, stats PanelStats, rerr RouteError) { theme := GetThemeByReq(r) h = &Header{ - Site: Site, - Settings: SettingBox.Load().(SettingMap), - Themes: Themes, + Site: Site, + Settings: SettingBox.Load().(SettingMap), + //Themes: Themes, + ThemesSlice: ThemesSlice, Theme: theme, CurrentUser: u, Hooks: GetHookTable(), @@ -165,8 +166,7 @@ func panelUserCheck(w http.ResponseWriter, r *http.Request, u *User) (h *Header, // TODO: Optimise this by removing a superfluous string alloc var tname string if theme.OverridenMap != nil { - _, ok := theme.OverridenMap[name] - if ok { + if _, ok := theme.OverridenMap[name]; ok { tname = "_" + theme.Name } } @@ -193,8 +193,8 @@ func simpleUserCheck(w http.ResponseWriter, r *http.Request, u *User) (lite *Hea func GetThemeByReq(r *http.Request) *Theme { theme := &Theme{Name: ""} - cookie, err := r.Cookie("current_theme") - if err == nil { + cookie, e := r.Cookie("current_theme") + if e == nil { inTheme, ok := Themes[html.EscapeString(cookie.Value)] if ok && !theme.HideFromThemes { theme = inTheme @@ -216,9 +216,10 @@ func userCheck(w http.ResponseWriter, r *http.Request, u *User) (h *Header, rerr func userCheck2(w http.ResponseWriter, r *http.Request, u *User, nano int64) (h *Header, rerr RouteError) { theme := GetThemeByReq(r) h = &Header{ - Site: Site, - Settings: SettingBox.Load().(SettingMap), - Themes: Themes, + Site: Site, + Settings: SettingBox.Load().(SettingMap), + //Themes: Themes, + ThemesSlice: ThemesSlice, Theme: theme, CurrentUser: u, // ! Some things rely on this being a pointer downstream from this function Hooks: GetHookTable(), @@ -282,16 +283,15 @@ func PrepResources(u *User, h *Header, theme *Theme) { addPreScript := func(name string, i int) { // TODO: Optimise this by removing a superfluous string alloc - var tname string if theme.OverridenMap != nil { //fmt.Printf("name %+v\n", name) //fmt.Printf("theme.OverridenMap %+v\n", theme.OverridenMap) if _, ok := theme.OverridenMap[name]; ok { - tname = "_" + theme.Name + tname := "_" + theme.Name + //fmt.Printf("tname %+v\n", tname) + h.AddPreScriptAsync("tmpl_" + name + tname + ".js") + return } - //fmt.Printf("tname %+v\n", tname) - h.AddPreScriptAsync("tmpl_" + name + tname + ".js") - return } //fmt.Printf("tname %+v\n", tname) h.AddPreScriptAsync(ucstrs[i]) diff --git a/common/theme_list.go b/common/theme_list.go index 76fd8efd..54f2f1aa 100644 --- a/common/theme_list.go +++ b/common/theme_list.go @@ -24,6 +24,7 @@ type ThemeList map[string]*Theme var Themes ThemeList = make(map[string]*Theme) // ? Refactor this into a store? var DefaultThemeBox atomic.Value var ChangeDefaultThemeMutex sync.Mutex +var ThemesSlice []*Theme // TODO: Fallback to a random theme if this doesn't exist, so admins can remove themes they don't use // TODO: Use this when the default theme doesn't exist @@ -41,12 +42,12 @@ var themeStmts ThemeStmts func init() { DbInits.Add(func(acc *qgen.Accumulator) error { - t := "themes" + t, cols := "themes", "uname,default" themeStmts = ThemeStmts{ - getAll: acc.Select(t).Columns("uname,default").Prepare(), + getAll: acc.Select(t).Columns(cols).Prepare(), isDefault: acc.Select(t).Columns("default").Where("uname=?").Prepare(), update: acc.Update(t).Set("default=?").Where("uname=?").Prepare(), - add: acc.Insert(t).Columns("uname,default").Fields("?,?").Prepare(), + add: acc.Insert(t).Columns(cols).Fields("?,?").Prepare(), } return acc.FirstError() }) @@ -76,43 +77,43 @@ func NewThemeList() (themes ThemeList, err error) { return themes, err } - theme := &Theme{} - err = json.Unmarshal(themeFile, theme) + th := &Theme{} + err = json.Unmarshal(themeFile, th) if err != nil { return themes, err } - if theme.Name == "" { + if th.Name == "" { return themes, errors.New("Theme " + themePath + " doesn't have a name set in theme.json") } - if theme.Name == fallbackTheme { + if th.Name == fallbackTheme { defaultTheme = fallbackTheme } - lastTheme = theme.Name + lastTheme = th.Name // TODO: Implement the static file part of this and fsnotify - if theme.Path != "" { - log.Print("Resolving redirect to " + theme.Path) - themeFile, err := ioutil.ReadFile(theme.Path + "/theme.json") + if th.Path != "" { + log.Print("Resolving redirect to " + th.Path) + themeFile, err := ioutil.ReadFile(th.Path + "/theme.json") if err != nil { return themes, err } - theme = &Theme{Path: theme.Path} - err = json.Unmarshal(themeFile, theme) + th = &Theme{Path: th.Path} + err = json.Unmarshal(themeFile, th) if err != nil { return themes, err } } else { - theme.Path = themePath + th.Path = themePath } - theme.Active = false // Set this to false, just in case someone explicitly overrode this value in the JSON file + th.Active = false // Set this to false, just in case someone explicitly overrode this value in the JSON file // TODO: Let the theme specify where it's resources are via the JSON file? // TODO: Let the theme inherit CSS from another theme? // ? - This might not be too helpful, as it only searches for /public/ and not if /public/ is empty. Still, it might help some people with a slightly less cryptic error - log.Print(theme.Path + "/public/") - _, err = os.Stat(theme.Path + "/public/") + log.Print(th.Path + "/public/") + _, err = os.Stat(th.Path + "/public/") if err != nil { if os.IsNotExist(err) { return themes, errors.New("We couldn't find this theme's resources. E.g. the /public/ folder.") @@ -122,31 +123,31 @@ func NewThemeList() (themes ThemeList, err error) { } } - if theme.FullImage != "" { + if th.FullImage != "" { DebugLog("Adding theme image") - err = StaticFiles.Add(theme.Path+"/"+theme.FullImage, themePath) + err = StaticFiles.Add(th.Path+"/"+th.FullImage, themePath) if err != nil { return themes, err } } - theme.TemplatesMap = make(map[string]string) - theme.TmplPtr = make(map[string]interface{}) - if theme.Templates != nil { - for _, themeTmpl := range theme.Templates { - theme.TemplatesMap[themeTmpl.Name] = themeTmpl.Source - theme.TmplPtr[themeTmpl.Name] = TmplPtrMap["o_"+themeTmpl.Source] + th.TemplatesMap = make(map[string]string) + th.TmplPtr = make(map[string]interface{}) + if th.Templates != nil { + for _, themeTmpl := range th.Templates { + th.TemplatesMap[themeTmpl.Name] = themeTmpl.Source + th.TmplPtr[themeTmpl.Name] = TmplPtrMap["o_"+themeTmpl.Source] } } - theme.IntTmplHandle = DefaultTemplates - overrides, err := ioutil.ReadDir(theme.Path + "/overrides/") + th.IntTmplHandle = DefaultTemplates + overrides, err := ioutil.ReadDir(th.Path + "/overrides/") if err != nil && !os.IsNotExist(err) { return themes, err } if len(overrides) > 0 { overCount := 0 - theme.OverridenMap = make(map[string]bool) + th.OverridenMap = make(map[string]bool) for _, override := range overrides { if override.IsDir() { continue @@ -159,25 +160,25 @@ func NewThemeList() (themes ThemeList, err error) { } overCount++ nosuf := strings.TrimSuffix(override.Name(), ext) - theme.OverridenTemplates = append(theme.OverridenTemplates, nosuf) - theme.OverridenMap[nosuf] = true - //theme.TmplPtr[nosuf] = TmplPtrMap["o_"+nosuf] + th.OverridenTemplates = append(th.OverridenTemplates, nosuf) + th.OverridenMap[nosuf] = true + //th.TmplPtr[nosuf] = TmplPtrMap["o_"+nosuf] log.Print("succeeded") } localTmpls := template.New("") - err = loadTemplates(localTmpls, theme.Name) + err = loadTemplates(localTmpls, th.Name) if err != nil { return themes, err } - theme.IntTmplHandle = localTmpls - log.Printf("theme.OverridenTemplates: %+v\n", theme.OverridenTemplates) - log.Printf("theme.IntTmplHandle: %+v\n", theme.IntTmplHandle) + th.IntTmplHandle = localTmpls + log.Printf("theme.OverridenTemplates: %+v\n", th.OverridenTemplates) + log.Printf("theme.IntTmplHandle: %+v\n", th.IntTmplHandle) } else { - log.Print("no overrides for " + theme.Name) + log.Print("no overrides for " + th.Name) } - for i, res := range theme.Resources { + for i, res := range th.Resources { ext := filepath.Ext(res.Name) switch ext { case ".css": @@ -193,19 +194,19 @@ func NewThemeList() (themes ThemeList, err error) { case "panel": res.LocID = LocPanel } - theme.Resources[i] = res + th.Resources[i] = res } - for _, dock := range theme.Docks { - id, ok := DockToID[dock] - if ok { - theme.DocksID = append(theme.DocksID, id) + for _, dock := range th.Docks { + if id, ok := DockToID[dock]; ok { + th.DocksID = append(th.DocksID, id) } } // TODO: Bind the built template, or an interpreted one for any dock overrides this theme has - themes[theme.Name] = theme + themes[th.Name] = th + ThemesSlice = append(ThemesSlice, th) } if defaultTheme == "" { defaultTheme = lastTheme @@ -221,18 +222,18 @@ func (t ThemeList) LoadActiveStatus() error { ChangeDefaultThemeMutex.Lock() defer ChangeDefaultThemeMutex.Unlock() - rows, err := themeStmts.getAll.Query() - if err != nil { - return err + rows, e := themeStmts.getAll.Query() + if e != nil { + return e } defer rows.Close() var uname string var defaultThemeSwitch bool for rows.Next() { - err = rows.Scan(&uname, &defaultThemeSwitch) - if err != nil { - return err + e = rows.Scan(&uname, &defaultThemeSwitch) + if e != nil { + return e } // Was the theme deleted at some point? @@ -258,8 +259,8 @@ func (t ThemeList) LoadActiveStatus() error { func (t ThemeList) LoadStaticFiles() error { for _, theme := range t { - if err := theme.LoadStaticFiles(); err != nil { - return err + if e := theme.LoadStaticFiles(); e != nil { + return e } } return nil