util

Documentation

Index

• Variables
• func BadRequestResponse(w http.ResponseWriter, r *http.Request)
• func CreateErrorResponse(w http.ResponseWriter, r *http.Request, err error)
• func DeleteErrorResponse(w http.ResponseWriter, r *http.Request, err error)
• func ForbiddenResponse(w http.ResponseWriter, r *http.Request)
• func GetContextAccount(r *http.Request) (*model.Account, bool)
• func GetContextConfig(r *http.Request) (config.Config, bool)
• func HashUserID(userID, key string) string
• func InternalServerErrorResponse(w http.ResponseWriter, r *http.Request, err error)
• func IsHTMXRequest(r *http.Request) bool
• func ListErrorResponse(w http.ResponseWriter, r *http.Request, err error)
• func NewBaseCookie() http.Cookie
• func NewExpiredCookie(name string) http.Cookie
• func NewPermanentCookie(name, value string, ttl time.Duration) http.Cookie
• func NewSessionCookie(name, value string) http.Cookie
• func NotFoundResponse(w http.ResponseWriter, r *http.Request)
• func PageSizeToLimitOffset(page, size int) (int, int)
• func ReadErrorResponse(w http.ResponseWriter, r *http.Request, err error)
• func Render(w http.ResponseWriter, r *http.Request, code int, render RenderFunc)
• func RenderError(w http.ResponseWriter, r *http.Request, code int, render RenderFunc)
• func SetContextAccount(r *http.Request, account *model.Account) *http.Request
• func SetContextConfig(r *http.Request, conf config.Config) *http.Request
• func TemplateBaseData(r *http.Request, w http.ResponseWriter) layout.BaseData
• func UpdateErrorResponse(w http.ResponseWriter, r *http.Request, err error)
• type RenderFunc
• type Validator
  • func NewValidator() Validator
  • func (v Validator) Add(field, message string)
  • func (v Validator) Check(field, message string, ok bool)
  • func (v Validator) CheckMaxCharacters(field, value string, n int)
  • func (v Validator) CheckRequired(field, value string)
  • func (v Validator) IsValid() bool

Variables

var (
	// Permanents cookies.
	SessionCookieName = "bloggulus_session"
	SessionCookieTTL  = 7 * 24 * time.Hour

	// Session cookies.
	NextCookieName  = "bloggulus_next"
	StateCookieName = "bloggulus_state"
	ToastCookieName = "bloggulus_toast"
)

Functions

func BadRequestResponse

func BadRequestResponse(w http.ResponseWriter, r *http.Request)

Render a 400 Bad Request error page.

func CreateErrorResponse

func CreateErrorResponse(w http.ResponseWriter, r *http.Request, err error)

Handle errors that arise from creating a new row in the database.

func DeleteErrorResponse

func DeleteErrorResponse(w http.ResponseWriter, r *http.Request, err error)

Handle errors that arise from deleting a single row from the database.

func ForbiddenResponse

func ForbiddenResponse(w http.ResponseWriter, r *http.Request)

Render a 403 Forbidden error page.

func GetContextAccount

func GetContextAccount(r *http.Request) (*model.Account, bool)

The GetContextAccount() retrieves the model.Account and an "exists" bool from the request context.

func GetContextConfig

func GetContextConfig(r *http.Request) (config.Config, bool)

func HashUserID

func HashUserID(userID, key string) string

Hash a user ID with a given key (via HMAC).

func InternalServerErrorResponse

func InternalServerErrorResponse(w http.ResponseWriter, r *http.Request, err error)

Render a 500 Internal Server Error page.

func IsHTMXRequest

func IsHTMXRequest(r *http.Request) bool

func ListErrorResponse

func ListErrorResponse(w http.ResponseWriter, r *http.Request, err error)

Handle errors that arise from reading many (zero or more) rows from the database.

func NewBaseCookie

func NewBaseCookie() http.Cookie

Return a base cookie with secure defaults.

func NewExpiredCookie

func NewExpiredCookie(name string) http.Cookie

Create a cookie that is instantly expired.

func NewPermanentCookie

func NewPermanentCookie(name, value string, ttl time.Duration) http.Cookie

Create a permanent (not session) cookie with a given time-to-live.

func NewSessionCookie

func NewSessionCookie(name, value string) http.Cookie

Create a session (not permanent) cookie that expires when the user's session ends.

func NotFoundResponse

func NotFoundResponse(w http.ResponseWriter, r *http.Request)

Render a 404 Not Found error page.

func PageSizeToLimitOffset

func PageSizeToLimitOffset(page, size int) (int, int)

Convert user-friendly "page/size" pagination to DB-friendly "limit/offset".

func ReadErrorResponse

func ReadErrorResponse(w http.ResponseWriter, r *http.Request, err error)

Handle errors that arise from reading a single row from the database.

func Render

func Render(w http.ResponseWriter, r *http.Request, code int, render RenderFunc)

Render an HTML template based on a given RenderFunc.

func RenderError

func RenderError(w http.ResponseWriter, r *http.Request, code int, render RenderFunc)

Render an HTML error template based on a given RenderFunc. This function differs from Render in that it doesn't call InternalServerErrorResponse if something goes wrong since that could cause an infinite recursion.

func SetContextAccount

func SetContextAccount(r *http.Request, account *model.Account) *http.Request

The SetContextAccount() method returns a new copy of the request with the provided model.Account added to the context. Note that we use our accountContextKey constant as the key.

func SetContextConfig

func SetContextConfig(r *http.Request, conf config.Config) *http.Request

func TemplateBaseData

func TemplateBaseData(r *http.Request, w http.ResponseWriter) layout.BaseData

func UpdateErrorResponse

func UpdateErrorResponse(w http.ResponseWriter, r *http.Request, err error)

Handle errors that arise from updating a single row in the database.

Types

type RenderFunc

type RenderFunc func(w io.Writer) error

Generic function type for rendering data to an io.Writer.

type Validator

type Validator map[string]string

func NewValidator

func NewValidator() Validator

func (Validator) Add

func (v Validator) Add(field, message string)

func (Validator) Check

func (v Validator) Check(field, message string, ok bool)

func (Validator) CheckMaxCharacters

func (v Validator) CheckMaxCharacters(field, value string, n int)

func (Validator) CheckRequired

func (v Validator) CheckRequired(field, value string)

func (Validator) IsValid

func (v Validator) IsValid() bool