camzalewski/personal-site
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

Move controller and page to new package.

Browse source
This commit is contained in:
mikestefanello 2021-12-12 22:09:13 -05:00
parent c48f6bb9f4
commit 4e2f186dad
11 changed files with 29 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

6
controllers/about.go
View file

@ -1,15 +1,17 @@
package controllers
import (
"goweb/controller"
"github.com/labstack/echo/v4"
)
type About struct {
Controller
controller.Controller
}
func (a *About) Get(c echo.Context) error {
p := NewPage(c)
p := controller.NewPage(c)
p.Layout = "main"
p.Name = "about"
p.Title = "About"

5
controllers/contact.go
View file

@ -1,17 +1,18 @@
package controllers
import (
"goweb/controller"
"goweb/msg"
"github.com/labstack/echo/v4"
)
type Contact struct {
Controller
controller.Controller
}
func (a *Contact) Get(c echo.Context) error {
p := NewPage(c)
p := controller.NewPage(c)
p.Layout = "main"
p.Name = "contact"
p.Title = "Contact us"

161
controllers/controller.go
View file

@ -1,161 +0,0 @@
package controllers
import (
"bytes"
"fmt"
"html/template"
"net/http"
"path"
"path/filepath"
"runtime"
"sync"
"goweb/config"
"goweb/container"
"goweb/funcmap"
"goweb/middleware"
"github.com/eko/gocache/v2/marshaler"
"github.com/eko/gocache/v2/store"
"github.com/labstack/echo/v4"
)
var (
// Cache of compiled page templates
templates = sync.Map{}
// Template function map
funcMap = funcmap.GetFuncMap()
templatePath = getTemplatesDirectoryPath()
)
type Controller struct {
Container *container.Container
}
func NewController(c *container.Container) Controller {
return Controller{
Container: c,
}
}
// TODO: Audit error handling (ie NewHTTPError)
func (t *Controller) RenderPage(c echo.Context, p Page) error {
if p.Name == "" {
c.Logger().Error("page render failed due to missing name")
return echo.NewHTTPError(http.StatusInternalServerError, "Internal server error")
}
if p.AppName == "" {
p.AppName = t.Container.Config.App.Name
}
if err := t.parsePageTemplates(p); err != nil {
return err
}
buf, err := t.executeTemplates(c, p)
if err != nil {
return err
}
t.cachePage(c, p, buf)
// Set any headers
for k, v := range p.Headers {
c.Response().Header().Set(k, v)
}
return c.HTMLBlob(p.StatusCode, buf.Bytes())
}
func (t *Controller) cachePage(c echo.Context, p Page, html *bytes.Buffer) {
if !p.Cache.Enabled {
return
}
if p.Cache.Expiration == 0 {
p.Cache.Expiration = t.Container.Config.Cache.Expiration.Page
}
key := c.Request().URL.String()
opts := &store.Options{
Expiration: p.Cache.Expiration,
Tags: p.Cache.Tags,
}
cp := middleware.CachedPage{
URL: key,
HTML: html.Bytes(),
Headers: p.Headers,
StatusCode: p.StatusCode,
}
err := marshaler.New(t.Container.Cache).Set(c.Request().Context(), key, cp, opts)
if err != nil {
c.Logger().Errorf("failed to cache page: %v", err)
return
}
c.Logger().Infof("cached page")
}
func (t *Controller) parsePageTemplates(p Page) error {
// Check if the template has not yet been parsed or if the app environment is local, so that templates reflect
// changes without having the restart the server
if _, ok := templates.Load(p.Name); !ok || t.Container.Config.App.Environment == config.EnvLocal {
parsed, err :=
template.New(p.Layout+config.TemplateExt).
Funcs(funcMap).
ParseFiles(
fmt.Sprintf("%s/layouts/%s%s", templatePath, p.Layout, config.TemplateExt),
fmt.Sprintf("%s/pages/%s%s", templatePath, p.Name, config.TemplateExt),
)
if err != nil {
return err
}
parsed, err = parsed.ParseGlob(fmt.Sprintf("%s/components/*%s", templatePath, config.TemplateExt))
if err != nil {
return err
}
// Store the template so this process only happens once
templates.Store(p.Name, parsed)
}
return nil
}
func (t *Controller) executeTemplates(c echo.Context, p Page) (*bytes.Buffer, error) {
tmpl, ok := templates.Load(p.Name)
if !ok {
c.Logger().Error("uncached page template requested")
return nil, echo.NewHTTPError(http.StatusInternalServerError, "Internal server error")
}
buf := new(bytes.Buffer)
err := tmpl.(*template.Template).ExecuteTemplate(buf, p.Layout+config.TemplateExt, p)
if err != nil {
return nil, err
}
return buf, nil
}
func (t *Controller) Redirect(c echo.Context, route string, routeParams ...interface{}) error {
return c.Redirect(http.StatusFound, c.Echo().Reverse(route, routeParams))
}
// getTemplatesDirectoryPath gets the templates directory path
// This is needed incase this is called from a package outside of main,
// such as testing
func getTemplatesDirectoryPath() string {
_, b, _, _ := runtime.Caller(0)
d := path.Join(path.Dir(b))
return filepath.Join(filepath.Dir(d), config.TemplateDir)
}

0
controllers/controller_test.go → controllers/controllers_test.go
View file

6
controllers/error.go
View file

@ -3,11 +3,13 @@ package controllers
import (
"net/http"
"goweb/controller"
"github.com/labstack/echo/v4"
)
type Error struct {
Controller
controller.Controller
}
func (e *Error) Get(err error, c echo.Context) {
@ -26,7 +28,7 @@ func (e *Error) Get(err error, c echo.Context) {
c.Logger().Info(err)
}
p := NewPage(c)
p := controller.NewPage(c)
p.Layout = "main"
p.Title = http.StatusText(code)
p.Name = "error"

6
controllers/home.go
View file

@ -1,15 +1,17 @@
package controllers
import (
"goweb/controller"
"github.com/labstack/echo/v4"
)
type Home struct {
Controller
controller.Controller
}
func (h *Home) Get(c echo.Context) error {
p := NewPage(c)
p := controller.NewPage(c)
p.Layout = "main"
p.Name = "home"
p.Data = "Hello world"

5
controllers/login.go
View file

@ -4,6 +4,7 @@ import (
"fmt"
"goweb/auth"
"goweb/controller"
"goweb/ent"
"goweb/ent/user"
"goweb/msg"
@ -13,7 +14,7 @@ import (
type (
Login struct {
Controller
controller.Controller
form LoginForm
}
@ -24,7 +25,7 @@ type (
)
func (l *Login) Get(c echo.Context) error {
p := NewPage(c)
p := controller.NewPage(c)
p.Layout = "auth"
p.Name = "login"
p.Title = "Log in"

3
controllers/logout.go
View file

@ -2,13 +2,14 @@ package controllers
import (
"goweb/auth"
"goweb/controller"
"goweb/msg"
"github.com/labstack/echo/v4"
)
type Logout struct {
Controller
controller.Controller
}
func (l *Logout) Get(c echo.Context) error {

83
controllers/page.go
View file

@ -1,83 +0,0 @@
package controllers
import (
"html/template"
"net/http"
"time"
"goweb/auth"
"goweb/msg"
"goweb/pager"
echomw "github.com/labstack/echo/v4/middleware"
"github.com/labstack/echo/v4"
)
const (
DefaultItemsPerPage = 20
)
type Page struct {
AppName string
Title string
Context echo.Context
Reverse func(name string, params ...interface{}) string
Path string
Data interface{}
Layout string
Name string
IsHome bool
IsAuth bool
StatusCode int
Metatags struct {
Description string
Keywords []string
}
Pager pager.Pager
CSRF string
Headers map[string]string
Cache struct {
Enabled bool
Expiration time.Duration
Tags []string
}
RequestID string
}
func NewPage(c echo.Context) Page {
p := Page{
Context: c,
Reverse: c.Echo().Reverse,
Path: c.Request().URL.Path,
StatusCode: http.StatusOK,
Pager: pager.NewPager(c, DefaultItemsPerPage),
Headers: make(map[string]string),
RequestID: c.Response().Header().Get(echo.HeaderXRequestID),
}
p.IsHome = p.Path == "/"
if csrf := c.Get(echomw.DefaultCSRFConfig.ContextKey); csrf != nil {
p.CSRF = csrf.(string)
}
if _, err := auth.GetUserID(c); err == nil {
p.IsAuth = true
}
return p
}
func (p Page) SetMessage(typ msg.Type, value string) {
msg.Set(p.Context, typ, value)
}
func (p Page) GetMessages(typ msg.Type) []template.HTML {
strs := msg.Get(p.Context, typ)
ret := make([]template.HTML, len(strs))
for k, v := range strs {
ret[k] = template.HTML(v)
}
return ret
}

5
controllers/register.go
View file

@ -2,6 +2,7 @@ package controllers
import (
"goweb/auth"
"goweb/controller"
"goweb/msg"
"github.com/labstack/echo/v4"
@ -9,7 +10,7 @@ import (
type (
Register struct {
Controller
controller.Controller
form RegisterForm
}
@ -20,7 +21,7 @@ type (
)
func (r *Register) Get(c echo.Context) error {
p := NewPage(c)
p := controller.NewPage(c)
p.Layout = "auth"
p.Name = "register"
p.Title = "Register"

7
controllers/router.go
View file

@ -4,6 +4,7 @@ import (
"net/http"
"goweb/config"
"goweb/controller"
"goweb/middleware"
"github.com/go-playground/validator/v10"
@ -60,7 +61,7 @@ func BuildRouter(c *container.Container) {
)
// Base controller
ctr := NewController(c)
ctr := controller.NewController(c)
// Error handler
err := Error{Controller: ctr}
@ -74,7 +75,7 @@ func BuildRouter(c *container.Container) {
userRoutes(g, ctr)
}
func navRoutes(g *echo.Group, ctr Controller) {
func navRoutes(g *echo.Group, ctr controller.Controller) {
home := Home{Controller: ctr}
g.GET("/", home.Get).Name = "home"
@ -86,7 +87,7 @@ func navRoutes(g *echo.Group, ctr Controller) {
g.POST("/contact", contact.Post).Name = "contact.post"
}
func userRoutes(g *echo.Group, ctr Controller) {
func userRoutes(g *echo.Group, ctr controller.Controller) {
logout := Logout{Controller: ctr}
g.GET("/logout", logout.Get, middleware.RequireAuthentication()).Name = "logout"