155 lines
3.6 KiB
Go
155 lines
3.6 KiB
Go
package sessions
|
|
|
|
import (
|
|
"log"
|
|
"net/http"
|
|
|
|
"github.com/gin-gonic/gin"
|
|
"github.com/gorilla/context"
|
|
"github.com/gorilla/sessions"
|
|
)
|
|
|
|
const (
|
|
DefaultKey = "github.com/gin-contrib/sessions"
|
|
errorFormat = "[sessions] ERROR! %s\n"
|
|
)
|
|
|
|
type Store interface {
|
|
sessions.Store
|
|
Options(Options)
|
|
}
|
|
|
|
// Options stores configuration for a session or session store.
|
|
// Fields are a subset of http.Cookie fields.
|
|
type Options struct {
|
|
Path string
|
|
Domain string
|
|
// MaxAge=0 means no 'Max-Age' attribute specified.
|
|
// MaxAge<0 means delete cookie now, equivalently 'Max-Age: 0'.
|
|
// MaxAge>0 means Max-Age attribute present and given in seconds.
|
|
MaxAge int
|
|
Secure bool
|
|
HTTPOnly bool
|
|
}
|
|
|
|
// Session thinly Wraps gorilla-session methods and stores the values and optional configuration for a session.
|
|
type Session interface {
|
|
// Get returns the session value associated to the given key.
|
|
Get(key interface{}) interface{}
|
|
// Set sets the session value associated to the given key.
|
|
Set(key interface{}, val interface{})
|
|
// Delete removes the session value associated to the given key.
|
|
Delete(key interface{})
|
|
// Clear deletes all values in the session.
|
|
Clear()
|
|
// AddFlash adds a flash message to the session.
|
|
// A single variadic argument is accepted, and it is optional: it defines the flash key.
|
|
// If not defined "_flash" is used by default.
|
|
AddFlash(value interface{}, vars ...string)
|
|
// Flashes returns a slice of flash messages from the session.
|
|
// A single variadic argument is accepted, and it is optional: it defines the flash key.
|
|
// If not defined "_flash" is used by default.
|
|
Flashes(vars ...string) []interface{}
|
|
// Options sets confuguration for a session.
|
|
Options(Options)
|
|
// Save saves all sessions used during the current request.
|
|
Save() error
|
|
}
|
|
|
|
// Sessions is used to create middleware
|
|
func Sessions(name string, store Store) gin.HandlerFunc {
|
|
return func(c *gin.Context) {
|
|
s := &session{
|
|
name: name,
|
|
request: c.Request,
|
|
store: store,
|
|
session: nil,
|
|
written: false,
|
|
writer: c.Writer,
|
|
}
|
|
c.Set(DefaultKey, s)
|
|
defer context.Clear(c.Request)
|
|
c.Next()
|
|
}
|
|
}
|
|
|
|
type session struct {
|
|
name string
|
|
request *http.Request
|
|
store Store
|
|
session *sessions.Session
|
|
written bool
|
|
writer http.ResponseWriter
|
|
}
|
|
|
|
func (s *session) Get(key interface{}) interface{} {
|
|
return s.Session().Values[key]
|
|
}
|
|
|
|
func (s *session) Set(key interface{}, val interface{}) {
|
|
s.Session().Values[key] = val
|
|
s.written = true
|
|
}
|
|
|
|
func (s *session) Delete(key interface{}) {
|
|
delete(s.Session().Values, key)
|
|
s.written = true
|
|
}
|
|
|
|
func (s *session) Clear() {
|
|
for key := range s.Session().Values {
|
|
s.Delete(key)
|
|
}
|
|
}
|
|
|
|
func (s *session) AddFlash(value interface{}, vars ...string) {
|
|
s.Session().AddFlash(value, vars...)
|
|
s.written = true
|
|
}
|
|
|
|
func (s *session) Flashes(vars ...string) []interface{} {
|
|
s.written = true
|
|
return s.Session().Flashes(vars...)
|
|
}
|
|
|
|
func (s *session) Options(options Options) {
|
|
s.Session().Options = &sessions.Options{
|
|
Path: options.Path,
|
|
Domain: options.Domain,
|
|
MaxAge: options.MaxAge,
|
|
Secure: options.Secure,
|
|
HttpOnly: options.HTTPOnly,
|
|
}
|
|
}
|
|
|
|
func (s *session) Save() error {
|
|
if s.Written() {
|
|
e := s.Session().Save(s.request, s.writer)
|
|
if e == nil {
|
|
s.written = false
|
|
}
|
|
return e
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func (s *session) Session() *sessions.Session {
|
|
if s.session == nil {
|
|
var err error
|
|
s.session, err = s.store.Get(s.request, s.name)
|
|
if err != nil {
|
|
log.Printf(errorFormat, err)
|
|
}
|
|
}
|
|
return s.session
|
|
}
|
|
|
|
func (s *session) Written() bool {
|
|
return s.written
|
|
}
|
|
|
|
// Default is a shortcut to get session
|
|
func Default(c *gin.Context) Session {
|
|
return c.MustGet(DefaultKey).(Session)
|
|
}
|