|
|
@@ -16,10 +16,9 @@
|
|
|
// Package session a middleware that provides the session manager of Macaron.
|
|
|
package session
|
|
|
|
|
|
-// NOTE: last sync fc6b9ce on Nov 4, 2014.
|
|
|
+// NOTE: last sync 000033e on Nov 4, 2014.
|
|
|
|
|
|
import (
|
|
|
- "crypto/rand"
|
|
|
"encoding/hex"
|
|
|
"fmt"
|
|
|
"net/http"
|
|
|
@@ -29,30 +28,74 @@ import (
|
|
|
"github.com/Unknwon/macaron"
|
|
|
)
|
|
|
|
|
|
+const _VERSION = "0.1.1"
|
|
|
+
|
|
|
func Version() string {
|
|
|
- return "0.0.5"
|
|
|
+ return _VERSION
|
|
|
}
|
|
|
|
|
|
+// RawStore is the interface that operates the session data.
|
|
|
type RawStore interface {
|
|
|
- Set(key, value interface{}) error //set session value
|
|
|
- Get(key interface{}) interface{} //get session value
|
|
|
- Delete(key interface{}) error //delete session value
|
|
|
- SessionID() string //back current sessionID
|
|
|
- SessionRelease(w http.ResponseWriter) // release the resource & save data to provider & return the data
|
|
|
- Flush() error //delete all data
|
|
|
+ // Set sets value to given key in session.
|
|
|
+ Set(key, value interface{}) error
|
|
|
+ // Get gets value by given key in session.
|
|
|
+ Get(key interface{}) interface{}
|
|
|
+ // Delete delete a key from session.
|
|
|
+ Delete(key interface{}) error
|
|
|
+ // ID returns current session ID.
|
|
|
+ ID() string
|
|
|
+ // Release releases session resource and save data to provider.
|
|
|
+ Release() error
|
|
|
+ // Flush deletes all session data.
|
|
|
+ Flush() error
|
|
|
}
|
|
|
|
|
|
-// Store contains all data for one session process with specific id.
|
|
|
+// Store is the interface that contains all data for one session process with specific ID.
|
|
|
type Store interface {
|
|
|
RawStore
|
|
|
- GetActiveSession() int
|
|
|
+ // Read returns raw session store by session ID.
|
|
|
+ Read(sid string) (RawStore, error)
|
|
|
+ // Destory deletes a session.
|
|
|
+ Destory(*macaron.Context) error
|
|
|
+ // RegenerateId regenerates a session store from old session ID to new one.
|
|
|
+ RegenerateId(*macaron.Context) (RawStore, error)
|
|
|
+ // Count counts and returns number of sessions.
|
|
|
+ Count() int
|
|
|
+ // GC calls GC to clean expired sessions.
|
|
|
+ GC()
|
|
|
+}
|
|
|
+
|
|
|
+type store struct {
|
|
|
+ RawStore
|
|
|
+ *Manager
|
|
|
}
|
|
|
|
|
|
+var _ Store = &store{}
|
|
|
+
|
|
|
+// Options represents a struct for specifying configuration options for the session middleware.
|
|
|
type Options struct {
|
|
|
- // Name of provider. Default is memory.
|
|
|
+ // Name of provider. Default is "memory".
|
|
|
Provider string
|
|
|
- // Provider configuration string.
|
|
|
- Config
|
|
|
+ // Provider configuration, it's corresponding to provider.
|
|
|
+ ProviderConfig string
|
|
|
+ // Cookie name to save session ID. Default is "MacaronSession".
|
|
|
+ CookieName string
|
|
|
+ // Cookie path to store. Default is "/".
|
|
|
+ CookiePath string
|
|
|
+ // GC interval time in seconds. Default is 3600.
|
|
|
+ Gclifetime int64
|
|
|
+ // Max life time in seconds. Default is whatever GC interval time is.
|
|
|
+ Maxlifetime int64
|
|
|
+ // Use HTTPS only. Default is false.
|
|
|
+ Secure bool
|
|
|
+ // Cookie life time. Default is 0.
|
|
|
+ CookieLifeTime int
|
|
|
+ // Cookie domain name. Default is empty.
|
|
|
+ Domain string
|
|
|
+ // Session ID length. Default is 16.
|
|
|
+ IDLength int
|
|
|
+ // Configuration section name. Default is "session".
|
|
|
+ Section string
|
|
|
}
|
|
|
|
|
|
func prepareOptions(options []Options) Options {
|
|
|
@@ -60,97 +103,60 @@ func prepareOptions(options []Options) Options {
|
|
|
if len(options) > 0 {
|
|
|
opt = options[0]
|
|
|
}
|
|
|
+ if len(opt.Section) == 0 {
|
|
|
+ opt.Section = "session"
|
|
|
+ }
|
|
|
+ sec := macaron.Config().Section(opt.Section)
|
|
|
|
|
|
- // Defaults
|
|
|
if len(opt.Provider) == 0 {
|
|
|
- opt.Provider = "memory"
|
|
|
+ opt.Provider = sec.Key("PROVIDER").MustString("memory")
|
|
|
+ }
|
|
|
+ if len(opt.ProviderConfig) == 0 && opt.Provider == "file" {
|
|
|
+ opt.ProviderConfig = sec.Key("PROVIDER_CONFIG").MustString("data/sessions")
|
|
|
}
|
|
|
- opt.EnableSetCookie = true
|
|
|
if len(opt.CookieName) == 0 {
|
|
|
- opt.CookieName = "MacaronSession"
|
|
|
+ opt.CookieName = sec.Key("COOKIE_NAME").MustString("MacaronSession")
|
|
|
}
|
|
|
if len(opt.CookiePath) == 0 {
|
|
|
- opt.CookiePath = "/"
|
|
|
+ opt.CookiePath = sec.Key("COOKIE_PATH").MustString("/")
|
|
|
}
|
|
|
if opt.Gclifetime == 0 {
|
|
|
- opt.Gclifetime = 3600
|
|
|
+ opt.Gclifetime = sec.Key("GC_INTERVAL_TIME").MustInt64(3600)
|
|
|
}
|
|
|
if opt.Maxlifetime == 0 {
|
|
|
- opt.Maxlifetime = opt.Gclifetime
|
|
|
+ opt.Maxlifetime = sec.Key("MAX_LIFE_TIME").MustInt64(opt.Gclifetime)
|
|
|
}
|
|
|
-
|
|
|
- if opt.SessionIdLength == 0 {
|
|
|
- opt.SessionIdLength = 16
|
|
|
+ if !opt.Secure {
|
|
|
+ opt.Secure = sec.Key("SECURE").MustBool()
|
|
|
}
|
|
|
-
|
|
|
- return opt
|
|
|
-}
|
|
|
-
|
|
|
-// ___________.____ _____ _________ ___ ___
|
|
|
-// \_ _____/| | / _ \ / _____// | \
|
|
|
-// | __) | | / /_\ \ \_____ \/ ~ \
|
|
|
-// | \ | |___/ | \/ \ Y /
|
|
|
-// \___ / |_______ \____|__ /_______ /\___|_ /
|
|
|
-// \/ \/ \/ \/ \/
|
|
|
-
|
|
|
-type Flash struct {
|
|
|
- ctx *macaron.Context
|
|
|
- url.Values
|
|
|
- ErrorMsg, WarningMsg, InfoMsg, SuccessMsg string
|
|
|
-}
|
|
|
-
|
|
|
-func (f *Flash) set(name, msg string, current ...bool) {
|
|
|
- isShow := false
|
|
|
- if (len(current) == 0 && macaron.FlashNow) ||
|
|
|
- (len(current) > 0 && current[0]) {
|
|
|
- isShow = true
|
|
|
+ if opt.CookieLifeTime == 0 {
|
|
|
+ opt.CookieLifeTime = sec.Key("COOKIE_LIFE_TIME").MustInt()
|
|
|
}
|
|
|
-
|
|
|
- if isShow {
|
|
|
- f.ctx.Data["Flash"] = f
|
|
|
- } else {
|
|
|
- f.Set(name, msg)
|
|
|
+ if len(opt.Domain) == 0 {
|
|
|
+ opt.Domain = sec.Key("DOMAIN").String()
|
|
|
+ }
|
|
|
+ if opt.IDLength == 0 {
|
|
|
+ opt.IDLength = sec.Key("ID_LENGTH").MustInt(16)
|
|
|
}
|
|
|
-}
|
|
|
-
|
|
|
-func (f *Flash) Error(msg string, current ...bool) {
|
|
|
- f.ErrorMsg = msg
|
|
|
- f.set("error", msg, current...)
|
|
|
-}
|
|
|
-
|
|
|
-func (f *Flash) Warning(msg string, current ...bool) {
|
|
|
- f.WarningMsg = msg
|
|
|
- f.set("warning", msg, current...)
|
|
|
-}
|
|
|
-
|
|
|
-func (f *Flash) Info(msg string, current ...bool) {
|
|
|
- f.InfoMsg = msg
|
|
|
- f.set("info", msg, current...)
|
|
|
-}
|
|
|
-
|
|
|
-func (f *Flash) Success(msg string, current ...bool) {
|
|
|
- f.SuccessMsg = msg
|
|
|
- f.set("success", msg, current...)
|
|
|
-}
|
|
|
|
|
|
-type store struct {
|
|
|
- RawStore
|
|
|
- *Manager
|
|
|
+ return opt
|
|
|
}
|
|
|
|
|
|
// Sessioner is a middleware that maps a session.SessionStore service into the Macaron handler chain.
|
|
|
// An single variadic session.Options struct can be optionally provided to configure.
|
|
|
func Sessioner(options ...Options) macaron.Handler {
|
|
|
opt := prepareOptions(options)
|
|
|
- manager, err := NewManager(opt.Provider, &opt.Config)
|
|
|
+ manager, err := NewManager(opt.Provider, opt)
|
|
|
if err != nil {
|
|
|
panic(err)
|
|
|
}
|
|
|
- go manager.GC()
|
|
|
+ go manager.startGC()
|
|
|
|
|
|
return func(ctx *macaron.Context) {
|
|
|
- // FIXME: should I panic for error?
|
|
|
- sess, _ := manager.SessionStart(ctx.Resp, ctx.Req.Request)
|
|
|
+ sess, err := manager.Start(ctx)
|
|
|
+ if err != nil {
|
|
|
+ panic("session: " + err.Error())
|
|
|
+ }
|
|
|
|
|
|
// Get flash.
|
|
|
vals, _ := url.ParseQuery(ctx.GetCookie("macaron_flash"))
|
|
|
@@ -166,8 +172,6 @@ func Sessioner(options ...Options) macaron.Handler {
|
|
|
|
|
|
f := &Flash{ctx, url.Values{}, "", "", "", ""}
|
|
|
ctx.Resp.Before(func(macaron.ResponseWriter) {
|
|
|
- sess.SessionRelease(ctx.Resp)
|
|
|
-
|
|
|
if flash := f.Encode(); len(flash) > 0 {
|
|
|
ctx.SetCookie("macaron_flash", flash, 0, opt.CookiePath)
|
|
|
}
|
|
|
@@ -178,243 +182,230 @@ func Sessioner(options ...Options) macaron.Handler {
|
|
|
RawStore: sess,
|
|
|
Manager: manager,
|
|
|
}
|
|
|
+
|
|
|
ctx.MapTo(s, (*Store)(nil))
|
|
|
+
|
|
|
+ ctx.Next()
|
|
|
+
|
|
|
+ if sess.Release() != nil {
|
|
|
+ panic("session: " + err.Error())
|
|
|
+ }
|
|
|
}
|
|
|
}
|
|
|
|
|
|
-// Provider contains global session methods and saved SessionStores.
|
|
|
-// it can operate a SessionStore by its id.
|
|
|
+// Provider is the interface that provides session manipulations.
|
|
|
type Provider interface {
|
|
|
- SessionInit(gclifetime int64, config string) error
|
|
|
- SessionRead(sid string) (RawStore, error)
|
|
|
- SessionExist(sid string) bool
|
|
|
- SessionRegenerate(oldsid, sid string) (RawStore, error)
|
|
|
- SessionDestroy(sid string) error
|
|
|
- SessionAll() int //get all active session
|
|
|
- SessionGC()
|
|
|
+ // Init initializes session provider.
|
|
|
+ Init(gclifetime int64, config string) error
|
|
|
+ // Read returns raw session store by session ID.
|
|
|
+ Read(sid string) (RawStore, error)
|
|
|
+ // Exist returns true if session with given ID exists.
|
|
|
+ Exist(sid string) bool
|
|
|
+ // Destory deletes a session by session ID.
|
|
|
+ Destory(sid string) error
|
|
|
+ // Regenerate regenerates a session store from old session ID to new one.
|
|
|
+ Regenerate(oldsid, sid string) (RawStore, error)
|
|
|
+ // Count counts and returns number of sessions.
|
|
|
+ Count() int
|
|
|
+ // GC calls GC to clean expired sessions.
|
|
|
+ GC()
|
|
|
}
|
|
|
|
|
|
-var provides = make(map[string]Provider)
|
|
|
+var providers = make(map[string]Provider)
|
|
|
|
|
|
-// Register makes a session provide available by the provided name.
|
|
|
-// If Register is called twice with the same name or if driver is nil,
|
|
|
-// it panics.
|
|
|
-func Register(name string, provide Provider) {
|
|
|
- if provide == nil {
|
|
|
- panic("session: Register provide is nil")
|
|
|
+// Register registers a provider.
|
|
|
+func Register(name string, provider Provider) {
|
|
|
+ if provider == nil {
|
|
|
+ panic("session: cannot register provider with nil value")
|
|
|
}
|
|
|
- if _, dup := provides[name]; dup {
|
|
|
- panic("session: Register called twice for provider " + name)
|
|
|
+ if _, dup := providers[name]; dup {
|
|
|
+ panic(fmt.Errorf("session: cannot register provider '%s' twice", name))
|
|
|
}
|
|
|
- provides[name] = provide
|
|
|
+ providers[name] = provider
|
|
|
}
|
|
|
|
|
|
-type Config struct {
|
|
|
- CookieName string `json:"cookieName"`
|
|
|
- CookiePath string `json:"cookiePath"`
|
|
|
- EnableSetCookie bool `json:"enableSetCookie,omitempty"`
|
|
|
- Gclifetime int64 `json:"gclifetime"`
|
|
|
- Maxlifetime int64 `json:"maxLifetime"`
|
|
|
- Secure bool `json:"secure"`
|
|
|
- CookieLifeTime int `json:"cookieLifeTime"`
|
|
|
- ProviderConfig string `json:"providerConfig"`
|
|
|
- Domain string `json:"domain"`
|
|
|
- SessionIdLength int64 `json:"sessionIdLength"`
|
|
|
-}
|
|
|
+// _____
|
|
|
+// / \ _____ ____ _____ ____ ___________
|
|
|
+// / \ / \\__ \ / \\__ \ / ___\_/ __ \_ __ \
|
|
|
+// / Y \/ __ \| | \/ __ \_/ /_/ > ___/| | \/
|
|
|
+// \____|__ (____ /___| (____ /\___ / \___ >__|
|
|
|
+// \/ \/ \/ \//_____/ \/
|
|
|
|
|
|
-// Manager contains Provider and its configuration.
|
|
|
+// Manager represents a struct that contains session provider and its configuration.
|
|
|
type Manager struct {
|
|
|
provider Provider
|
|
|
- config *Config
|
|
|
+ opt Options
|
|
|
}
|
|
|
|
|
|
-// Create new Manager with provider name and json config string.
|
|
|
-// provider name:
|
|
|
-// 1. cookie
|
|
|
-// 2. file
|
|
|
-// 3. memory
|
|
|
-// 4. redis
|
|
|
-// 5. mysql
|
|
|
-// json config:
|
|
|
-// 1. is https default false
|
|
|
-// 2. hashfunc default sha1
|
|
|
-// 3. hashkey default beegosessionkey
|
|
|
-// 4. maxage default is none
|
|
|
-func NewManager(provideName string, config *Config) (*Manager, error) {
|
|
|
- provider, ok := provides[provideName]
|
|
|
+// NewManager creates and returns a new session manager by given provider name and configuration.
|
|
|
+// It panics when given provider isn't registered.
|
|
|
+func NewManager(name string, opt Options) (*Manager, error) {
|
|
|
+ p, ok := providers[name]
|
|
|
if !ok {
|
|
|
- return nil, fmt.Errorf("session: unknown provide %q (forgotten import?)", provideName)
|
|
|
+ return nil, fmt.Errorf("session: unknown provider ‘%q’(forgotten import?)", name)
|
|
|
}
|
|
|
+ if err := p.Init(opt.Maxlifetime, opt.ProviderConfig); err != nil {
|
|
|
+ return nil, err
|
|
|
+ }
|
|
|
+ return &Manager{p, opt}, nil
|
|
|
+}
|
|
|
|
|
|
- config.EnableSetCookie = true
|
|
|
- if config.Maxlifetime == 0 {
|
|
|
- config.Maxlifetime = config.Gclifetime
|
|
|
+// sessionId generates a new session ID with rand string, unix nano time, remote addr by hash function.
|
|
|
+func (m *Manager) sessionId() string {
|
|
|
+ return hex.EncodeToString(generateRandomKey(m.opt.IDLength))
|
|
|
+}
|
|
|
+
|
|
|
+// Start starts a session by generating new one
|
|
|
+// or retrieve existence one by reading session ID from HTTP request if it's valid.
|
|
|
+func (m *Manager) Start(ctx *macaron.Context) (RawStore, error) {
|
|
|
+ sid := ctx.GetCookie(m.opt.CookieName)
|
|
|
+ if len(sid) > 0 && m.provider.Exist(sid) {
|
|
|
+ return m.provider.Read(sid)
|
|
|
}
|
|
|
- if err := provider.SessionInit(config.Maxlifetime, config.ProviderConfig); err != nil {
|
|
|
+
|
|
|
+ sid = m.sessionId()
|
|
|
+ sess, err := m.provider.Read(sid)
|
|
|
+ if err != nil {
|
|
|
return nil, err
|
|
|
}
|
|
|
- return &Manager{
|
|
|
- provider: provider,
|
|
|
- config: config,
|
|
|
- }, nil
|
|
|
+
|
|
|
+ cookie := &http.Cookie{
|
|
|
+ Name: m.opt.CookieName,
|
|
|
+ Value: sid,
|
|
|
+ Path: m.opt.CookiePath,
|
|
|
+ HttpOnly: true,
|
|
|
+ Secure: m.opt.Secure,
|
|
|
+ Domain: m.opt.Domain,
|
|
|
+ }
|
|
|
+ if m.opt.CookieLifeTime >= 0 {
|
|
|
+ cookie.MaxAge = m.opt.CookieLifeTime
|
|
|
+ }
|
|
|
+ http.SetCookie(ctx.Resp, cookie)
|
|
|
+ ctx.Req.AddCookie(cookie)
|
|
|
+ return sess, nil
|
|
|
}
|
|
|
|
|
|
-// Start session. generate or read the session id from http request.
|
|
|
-// if session id exists, return SessionStore with this id.
|
|
|
-func (manager *Manager) SessionStart(w http.ResponseWriter, r *http.Request) (session RawStore, _ error) {
|
|
|
- cookie, err := r.Cookie(manager.config.CookieName)
|
|
|
- if err != nil || len(cookie.Value) == 0 {
|
|
|
- sid, err := manager.sessionId(r)
|
|
|
- if err != nil {
|
|
|
- return nil, err
|
|
|
- }
|
|
|
- session, err = manager.provider.SessionRead(sid)
|
|
|
+// Read returns raw session store by session ID.
|
|
|
+func (m *Manager) Read(sid string) (RawStore, error) {
|
|
|
+ return m.provider.Read(sid)
|
|
|
+}
|
|
|
+
|
|
|
+// Destory deletes a session by given ID.
|
|
|
+func (m *Manager) Destory(ctx *macaron.Context) error {
|
|
|
+ sid := ctx.GetCookie(m.opt.CookieName)
|
|
|
+ if len(sid) == 0 {
|
|
|
+ return nil
|
|
|
+ }
|
|
|
+
|
|
|
+ if err := m.provider.Destory(sid); err != nil {
|
|
|
+ return err
|
|
|
+ }
|
|
|
+ cookie := &http.Cookie{
|
|
|
+ Name: m.opt.CookieName,
|
|
|
+ Path: m.opt.CookiePath,
|
|
|
+ HttpOnly: true,
|
|
|
+ Expires: time.Now(),
|
|
|
+ MaxAge: -1,
|
|
|
+ }
|
|
|
+ http.SetCookie(ctx.Resp, cookie)
|
|
|
+ return nil
|
|
|
+}
|
|
|
+
|
|
|
+// RegenerateId regenerates a session store from old session ID to new one.
|
|
|
+func (m *Manager) RegenerateId(ctx *macaron.Context) (sess RawStore, err error) {
|
|
|
+ sid := m.sessionId()
|
|
|
+ oldsid := ctx.GetCookie(m.opt.CookieName)
|
|
|
+ if len(oldsid) == 0 {
|
|
|
+ sess, err = m.provider.Read(oldsid)
|
|
|
if err != nil {
|
|
|
return nil, err
|
|
|
}
|
|
|
-
|
|
|
- cookie = &http.Cookie{Name: manager.config.CookieName,
|
|
|
- Value: url.QueryEscape(sid),
|
|
|
- Path: manager.config.CookiePath,
|
|
|
- HttpOnly: true,
|
|
|
- Secure: manager.config.Secure,
|
|
|
- Domain: manager.config.Domain,
|
|
|
- }
|
|
|
- if manager.config.CookieLifeTime >= 0 {
|
|
|
- cookie.MaxAge = manager.config.CookieLifeTime
|
|
|
- }
|
|
|
- if manager.config.EnableSetCookie {
|
|
|
- http.SetCookie(w, cookie)
|
|
|
- }
|
|
|
- r.AddCookie(cookie)
|
|
|
} else {
|
|
|
- sid, err := url.QueryUnescape(cookie.Value)
|
|
|
+ sess, err = m.provider.Regenerate(oldsid, sid)
|
|
|
if err != nil {
|
|
|
return nil, err
|
|
|
}
|
|
|
+ }
|
|
|
+ ck := &http.Cookie{
|
|
|
+ Name: m.opt.CookieName,
|
|
|
+ Value: sid,
|
|
|
+ Path: m.opt.CookiePath,
|
|
|
+ HttpOnly: true,
|
|
|
+ Secure: m.opt.Secure,
|
|
|
+ Domain: m.opt.Domain,
|
|
|
+ }
|
|
|
+ if m.opt.CookieLifeTime >= 0 {
|
|
|
+ ck.MaxAge = m.opt.CookieLifeTime
|
|
|
+ }
|
|
|
+ http.SetCookie(ctx.Resp, ck)
|
|
|
+ ctx.Req.AddCookie(ck)
|
|
|
+ return sess, nil
|
|
|
+}
|
|
|
|
|
|
- if manager.provider.SessionExist(sid) {
|
|
|
- session, err = manager.provider.SessionRead(sid)
|
|
|
- if err != nil {
|
|
|
- return nil, err
|
|
|
- }
|
|
|
- } else {
|
|
|
- sid, err = manager.sessionId(r)
|
|
|
- if err != nil {
|
|
|
- return nil, err
|
|
|
- }
|
|
|
- session, err = manager.provider.SessionRead(sid)
|
|
|
- if err != nil {
|
|
|
- return nil, err
|
|
|
- }
|
|
|
+// Count counts and returns number of sessions.
|
|
|
+func (m *Manager) Count() int {
|
|
|
+ return m.provider.Count()
|
|
|
+}
|
|
|
|
|
|
- cookie = &http.Cookie{Name: manager.config.CookieName,
|
|
|
- Value: url.QueryEscape(sid),
|
|
|
- Path: manager.config.CookiePath,
|
|
|
- HttpOnly: true,
|
|
|
- Secure: manager.config.Secure,
|
|
|
- Domain: manager.config.Domain,
|
|
|
- }
|
|
|
- if manager.config.CookieLifeTime >= 0 {
|
|
|
- cookie.MaxAge = manager.config.CookieLifeTime
|
|
|
- }
|
|
|
- if manager.config.EnableSetCookie {
|
|
|
- http.SetCookie(w, cookie)
|
|
|
- }
|
|
|
- r.AddCookie(cookie)
|
|
|
- }
|
|
|
- }
|
|
|
- return session, nil
|
|
|
+// GC starts GC job in a certain period.
|
|
|
+func (m *Manager) GC() {
|
|
|
+ m.provider.GC()
|
|
|
}
|
|
|
|
|
|
-// Destroy session by its id in http request cookie.
|
|
|
-func (manager *Manager) SessionDestroy(w http.ResponseWriter, r *http.Request) {
|
|
|
- cookie, err := r.Cookie(manager.config.CookieName)
|
|
|
- if err != nil || cookie.Value == "" {
|
|
|
- return
|
|
|
- } else {
|
|
|
- manager.provider.SessionDestroy(cookie.Value)
|
|
|
- expiration := time.Now()
|
|
|
- cookie := http.Cookie{Name: manager.config.CookieName,
|
|
|
- Path: manager.config.CookiePath,
|
|
|
- HttpOnly: true,
|
|
|
- Expires: expiration,
|
|
|
- MaxAge: -1}
|
|
|
- http.SetCookie(w, &cookie)
|
|
|
- }
|
|
|
+// startGC starts GC job in a certain period.
|
|
|
+func (m *Manager) startGC() {
|
|
|
+ m.GC()
|
|
|
+ time.AfterFunc(time.Duration(m.opt.Gclifetime)*time.Second, func() { m.startGC() })
|
|
|
}
|
|
|
|
|
|
-// Get SessionStore by its id.
|
|
|
-func (manager *Manager) GetSessionStore(sid string) (sessions RawStore, err error) {
|
|
|
- sessions, err = manager.provider.SessionRead(sid)
|
|
|
- return
|
|
|
+// SetSecure indicates whether to set cookie with HTTPS or not.
|
|
|
+func (m *Manager) SetSecure(secure bool) {
|
|
|
+ m.opt.Secure = secure
|
|
|
}
|
|
|
|
|
|
-// Start session gc process.
|
|
|
-// it can do gc in times after gc lifetime.
|
|
|
-func (manager *Manager) GC() {
|
|
|
- manager.provider.SessionGC()
|
|
|
- time.AfterFunc(time.Duration(manager.config.Gclifetime)*time.Second, func() { manager.GC() })
|
|
|
+// ___________.____ _____ _________ ___ ___
|
|
|
+// \_ _____/| | / _ \ / _____// | \
|
|
|
+// | __) | | / /_\ \ \_____ \/ ~ \
|
|
|
+// | \ | |___/ | \/ \ Y /
|
|
|
+// \___ / |_______ \____|__ /_______ /\___|_ /
|
|
|
+// \/ \/ \/ \/ \/
|
|
|
+
|
|
|
+type Flash struct {
|
|
|
+ ctx *macaron.Context
|
|
|
+ url.Values
|
|
|
+ ErrorMsg, WarningMsg, InfoMsg, SuccessMsg string
|
|
|
}
|
|
|
|
|
|
-// Regenerate a session id for this SessionStore who's id is saving in http request.
|
|
|
-func (manager *Manager) SessionRegenerateId(w http.ResponseWriter, r *http.Request) (session RawStore) {
|
|
|
- sid, err := manager.sessionId(r)
|
|
|
- if err != nil {
|
|
|
- return nil
|
|
|
+func (f *Flash) set(name, msg string, current ...bool) {
|
|
|
+ isShow := false
|
|
|
+ if (len(current) == 0 && macaron.FlashNow) ||
|
|
|
+ (len(current) > 0 && current[0]) {
|
|
|
+ isShow = true
|
|
|
}
|
|
|
|
|
|
- cookie, err := r.Cookie(manager.config.CookieName)
|
|
|
- if err != nil && cookie.Value == "" {
|
|
|
- // delete old cookie
|
|
|
- session, err = manager.provider.SessionRead(sid)
|
|
|
- if err != nil {
|
|
|
- return nil
|
|
|
- }
|
|
|
- cookie = &http.Cookie{Name: manager.config.CookieName,
|
|
|
- Value: url.QueryEscape(sid),
|
|
|
- Path: manager.config.CookiePath,
|
|
|
- HttpOnly: true,
|
|
|
- Secure: manager.config.Secure,
|
|
|
- Domain: manager.config.Domain,
|
|
|
- }
|
|
|
+ if isShow {
|
|
|
+ f.ctx.Data["Flash"] = f
|
|
|
} else {
|
|
|
- oldsid, err := url.QueryUnescape(cookie.Value)
|
|
|
- if err != nil {
|
|
|
- return nil
|
|
|
- }
|
|
|
- session, err = manager.provider.SessionRegenerate(oldsid, sid)
|
|
|
- if err != nil {
|
|
|
- return nil
|
|
|
- }
|
|
|
- cookie.Value = url.QueryEscape(sid)
|
|
|
- cookie.HttpOnly = true
|
|
|
- cookie.Path = "/"
|
|
|
- }
|
|
|
- if manager.config.CookieLifeTime >= 0 {
|
|
|
- cookie.MaxAge = manager.config.CookieLifeTime
|
|
|
+ f.Set(name, msg)
|
|
|
}
|
|
|
- http.SetCookie(w, cookie)
|
|
|
- r.AddCookie(cookie)
|
|
|
- return session
|
|
|
}
|
|
|
|
|
|
-// Get all active sessions count number.
|
|
|
-func (manager *Manager) GetActiveSession() int {
|
|
|
- return manager.provider.SessionAll()
|
|
|
+func (f *Flash) Error(msg string, current ...bool) {
|
|
|
+ f.ErrorMsg = msg
|
|
|
+ f.set("error", msg, current...)
|
|
|
}
|
|
|
|
|
|
-// Set cookie with https.
|
|
|
-func (manager *Manager) SetSecure(secure bool) {
|
|
|
- manager.config.Secure = secure
|
|
|
+func (f *Flash) Warning(msg string, current ...bool) {
|
|
|
+ f.WarningMsg = msg
|
|
|
+ f.set("warning", msg, current...)
|
|
|
}
|
|
|
|
|
|
-// generate session id with rand string, unix nano time, remote addr by hash function.
|
|
|
-func (manager *Manager) sessionId(r *http.Request) (string, error) {
|
|
|
- b := make([]byte, manager.config.SessionIdLength)
|
|
|
- n, err := rand.Read(b)
|
|
|
- if n != len(b) || err != nil {
|
|
|
- return "", fmt.Errorf("fail to read from the system CSPRNG.")
|
|
|
- }
|
|
|
- return hex.EncodeToString(b), nil
|
|
|
+func (f *Flash) Info(msg string, current ...bool) {
|
|
|
+ f.InfoMsg = msg
|
|
|
+ f.set("info", msg, current...)
|
|
|
+}
|
|
|
+
|
|
|
+func (f *Flash) Success(msg string, current ...bool) {
|
|
|
+ f.SuccessMsg = msg
|
|
|
+ f.set("success", msg, current...)
|
|
|
}
|