package sessions import ( "strconv" "sync" "time" "github.com/kataras/iris/core/errors" "github.com/kataras/iris/core/memstore" ) type ( // Session should expose the Sessions's end-user API. // It is the session's storage controller which you can // save or retrieve values based on a key. // // This is what will be returned when sess := sessions.Start(). Session struct { sid string isNew bool values memstore.Store // here are the real values // we could set the flash messages inside values but this will bring us more problems // because of session databases and because of // users may want to get all sessions and save them or display them // but without temp values (flash messages) which are removed after fetching. // so introduce a new field here. // NOTE: flashes are not managed by third-party, only inside session struct. flashes map[string]*flashMessage mu sync.RWMutex expireAt *time.Time // nil pointer means no expire date timer *time.Timer provider *provider } flashMessage struct { // if true then this flash message is removed on the flash gc shouldRemove bool value interface{} } ) // ID returns the session's ID. func (s *Session) ID() string { return s.sid } // IsNew returns true if is's a new session func (s *Session) IsNew() bool { return s.isNew } // HasExpireDate test if this session has an expire date, if not, this session never expires func (s *Session) HasExpireDate() bool { return s.expireAt != nil } // GetExpireDate get the expire date, if this session has no expire date, the returned value has the zero value func (s *Session) GetExpireDate() time.Time { var res time.Time if s.expireAt != nil { res = *s.expireAt } return res } // Get returns a value based on its "key". func (s *Session) Get(key string) interface{} { s.mu.RLock() value := s.values.Get(key) s.mu.RUnlock() return value } // when running on the session manager removes any 'old' flash messages. func (s *Session) runFlashGC() { s.mu.Lock() for key, v := range s.flashes { if v.shouldRemove { delete(s.flashes, key) } } s.mu.Unlock() } // HasFlash returns true if this session has available flash messages. func (s *Session) HasFlash() bool { return len(s.flashes) > 0 } // GetFlash returns a stored flash message based on its "key" // which will be removed on the next request. // // To check for flash messages we use the HasFlash() Method // and to obtain the flash message we use the GetFlash() Method. // There is also a method GetFlashes() to fetch all the messages. // // Fetching a message deletes it from the session. // This means that a message is meant to be displayed only on the first page served to the user. func (s *Session) GetFlash(key string) interface{} { fv, ok := s.peekFlashMessage(key) if !ok { return nil } fv.shouldRemove = true return fv.value } // PeekFlash returns a stored flash message based on its "key". // Unlike GetFlash, this will keep the message valid for the next requests, // until GetFlashes or GetFlash("key"). func (s *Session) PeekFlash(key string) interface{} { fv, ok := s.peekFlashMessage(key) if !ok { return nil } return fv.value } func (s *Session) peekFlashMessage(key string) (*flashMessage, bool) { s.mu.Lock() if fv, found := s.flashes[key]; found { return fv, true } s.mu.Unlock() return nil, false } // GetString same as Get but returns as string, if nil then returns an empty string. func (s *Session) GetString(key string) string { if value := s.Get(key); value != nil { if v, ok := value.(string); ok { return v } } return "" } // GetFlashString same as GetFlash but returns as string, if nil then returns an empty string. func (s *Session) GetFlashString(key string) string { if value := s.GetFlash(key); value != nil { if v, ok := value.(string); ok { return v } } return "" } var errFindParse = errors.New("Unable to find the %s with key: %s. Found? %#v") // GetInt same as Get but returns as int, if not found then returns -1 and an error. func (s *Session) GetInt(key string) (int, error) { v := s.Get(key) if vint, ok := v.(int); ok { return vint, nil } if vstring, sok := v.(string); sok { return strconv.Atoi(vstring) } return -1, errFindParse.Format("int", key, v) } // GetInt64 same as Get but returns as int64, if not found then returns -1 and an error. func (s *Session) GetInt64(key string) (int64, error) { v := s.Get(key) if vint64, ok := v.(int64); ok { return vint64, nil } if vint, ok := v.(int); ok { return int64(vint), nil } if vstring, sok := v.(string); sok { return strconv.ParseInt(vstring, 10, 64) } return -1, errFindParse.Format("int64", key, v) } // GetFloat32 same as Get but returns as float32, if not found then returns -1 and an error. func (s *Session) GetFloat32(key string) (float32, error) { v := s.Get(key) if vfloat32, ok := v.(float32); ok { return vfloat32, nil } if vfloat64, ok := v.(float64); ok { return float32(vfloat64), nil } if vint, ok := v.(int); ok { return float32(vint), nil } if vstring, sok := v.(string); sok { vfloat64, err := strconv.ParseFloat(vstring, 32) if err != nil { return -1, err } return float32(vfloat64), nil } return -1, errFindParse.Format("float32", key, v) } // GetFloat64 same as Get but returns as float64, if not found then returns -1 and an error. func (s *Session) GetFloat64(key string) (float64, error) { v := s.Get(key) if vfloat32, ok := v.(float32); ok { return float64(vfloat32), nil } if vfloat64, ok := v.(float64); ok { return vfloat64, nil } if vint, ok := v.(int); ok { return float64(vint), nil } if vstring, sok := v.(string); sok { return strconv.ParseFloat(vstring, 32) } return -1, errFindParse.Format("float64", key, v) } // GetBoolean same as Get but returns as boolean, if not found then returns -1 and an error func (s *Session) GetBoolean(key string) (bool, error) { v := s.Get(key) // here we could check for "true", "false" and 0 for false and 1 for true // but this may cause unexpected behavior from the developer if they expecting an error // so we just check if bool, if yes then return that bool, otherwise return false and an error. if vb, ok := v.(bool); ok { return vb, nil } return false, errFindParse.Format("bool", key, v) } // GetAll returns a copy of all session's values. func (s *Session) GetAll() map[string]interface{} { items := make(map[string]interface{}, len(s.values)) s.mu.RLock() for _, kv := range s.values { items[kv.Key] = kv.Value() } s.mu.RUnlock() return items } // GetFlashes returns all flash messages as map[string](key) and interface{} value // NOTE: this will cause at remove all current flash messages on the next request of the same user. func (s *Session) GetFlashes() map[string]interface{} { flashes := make(map[string]interface{}, len(s.flashes)) s.mu.Lock() for key, v := range s.flashes { flashes[key] = v.value v.shouldRemove = true } s.mu.Unlock() return flashes } // VisitAll loop each one entry and calls the callback function func(key,value) func (s *Session) VisitAll(cb func(k string, v interface{})) { s.values.Visit(cb) } func (s *Session) set(key string, value interface{}, immutable bool) { s.mu.Lock() if immutable { s.values.SetImmutable(key, value) } else { s.values.Set(key, value) } s.mu.Unlock() s.updateDatabases() s.isNew = false } // Set fills the session with an entry"value", based on its "key". func (s *Session) Set(key string, value interface{}) { s.set(key, value, false) } // SetImmutable fills the session with an entry "value", based on its "key". // Unlike `Set`, the output value cannot be changed by the caller later on (when .Get) // An Immutable entry should be only changed with a `SetImmutable`, simple `Set` will not work // if the entry was immutable, for your own safety. // Use it consistently, it's far slower than `Set`. // Read more about muttable and immutable go types: https://stackoverflow.com/a/8021081 func (s *Session) SetImmutable(key string, value interface{}) { s.set(key, value, true) } // SetFlash sets a flash message by its key. // // A flash message is used in order to keep a message in session through one or several requests of the same user. // It is removed from session after it has been displayed to the user. // Flash messages are usually used in combination with HTTP redirections, // because in this case there is no view, so messages can only be displayed in the request that follows redirection. // // A flash message has a name and a content (AKA key and value). // It is an entry of an associative array. The name is a string: often "notice", "success", or "error", but it can be anything. // The content is usually a string. You can put HTML tags in your message if you display it raw. // You can also set the message value to a number or an array: it will be serialized and kept in session like a string. // // Flash messages can be set using the SetFlash() Method // For example, if you would like to inform the user that his changes were successfully saved, // you could add the following line to your Handler: // // SetFlash("success", "Data saved!"); // // In this example we used the key 'success'. // If you want to define more than one flash messages, you will have to use different keys. func (s *Session) SetFlash(key string, value interface{}) { s.mu.Lock() s.flashes[key] = &flashMessage{value: value} s.mu.Unlock() } // Delete removes an entry by its key, // returns true if actually something was removed. func (s *Session) Delete(key string) bool { s.mu.Lock() removed := s.values.Remove(key) s.mu.Unlock() s.updateDatabases() if removed { s.isNew = false } return removed } func (s *Session) updateDatabases() { s.provider.updateDatabases(s, s.values) } // DeleteFlash removes a flash message by its key. func (s *Session) DeleteFlash(key string) { s.mu.Lock() delete(s.flashes, key) s.mu.Unlock() } // Clear removes all entries. func (s *Session) Clear() { s.mu.Lock() s.values.Reset() s.mu.Unlock() s.updateDatabases() s.isNew = false } // ClearFlashes removes all flash messages. func (s *Session) ClearFlashes() { s.mu.Lock() for key := range s.flashes { delete(s.flashes, key) } s.mu.Unlock() }