flash.go 2.96 KB
Newer Older
1
// Copyright 2014 beego Author. All Rights Reserved.
2
//
3 4 5
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
6
//
7
//      http://www.apache.org/licenses/LICENSE-2.0
8
//
9 10 11 12 13 14
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

astaxie's avatar
astaxie committed
15 16 17 18 19 20 21 22
package beego

import (
	"fmt"
	"net/url"
	"strings"
)

23
// FlashData is a tools to maintain data when using across request.
astaxie's avatar
astaxie committed
24 25 26 27
type FlashData struct {
	Data map[string]string
}

28
// NewFlash return a new empty FlashData struct.
astaxie's avatar
astaxie committed
29
func NewFlash() *FlashData {
astaxie's avatar
astaxie committed
30
	return &FlashData{
astaxie's avatar
astaxie committed
31
		Data: make(map[string]string),
astaxie's avatar
astaxie committed
32 33 34
	}
}

astaxie's avatar
astaxie committed
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52
// Set message to flash
func (fd *FlashData) Set(key string, msg string, args ...interface{}) {
	if len(args) == 0 {
		fd.Data[key] = msg
	} else {
		fd.Data[key] = fmt.Sprintf(msg, args...)
	}
}

// Success writes success message to flash.
func (fd *FlashData) Success(msg string, args ...interface{}) {
	if len(args) == 0 {
		fd.Data["success"] = msg
	} else {
		fd.Data["success"] = fmt.Sprintf(msg, args...)
	}
}

53
// Notice writes notice message to flash.
astaxie's avatar
astaxie committed
54 55 56 57 58 59 60 61
func (fd *FlashData) Notice(msg string, args ...interface{}) {
	if len(args) == 0 {
		fd.Data["notice"] = msg
	} else {
		fd.Data["notice"] = fmt.Sprintf(msg, args...)
	}
}

62
// Warning writes warning message to flash.
astaxie's avatar
astaxie committed
63 64 65 66 67 68 69 70
func (fd *FlashData) Warning(msg string, args ...interface{}) {
	if len(args) == 0 {
		fd.Data["warning"] = msg
	} else {
		fd.Data["warning"] = fmt.Sprintf(msg, args...)
	}
}

71
// Error writes error message to flash.
astaxie's avatar
astaxie committed
72 73 74 75 76 77 78 79
func (fd *FlashData) Error(msg string, args ...interface{}) {
	if len(args) == 0 {
		fd.Data["error"] = msg
	} else {
		fd.Data["error"] = fmt.Sprintf(msg, args...)
	}
}

80 81
// Store does the saving operation of flash data.
// the data are encoded and saved in cookie.
astaxie's avatar
astaxie committed
82 83 84 85
func (fd *FlashData) Store(c *Controller) {
	c.Data["flash"] = fd.Data
	var flashValue string
	for key, value := range fd.Data {
JessonChan's avatar
JessonChan committed
86
		flashValue += "\x00" + key + "\x23" + BConfig.WebConfig.FlashSeparator + "\x23" + value + "\x00"
astaxie's avatar
astaxie committed
87
	}
astaxie's avatar
astaxie committed
88
	c.Ctx.SetCookie(BConfig.WebConfig.FlashName, url.QueryEscape(flashValue), 0, "/")
astaxie's avatar
astaxie committed
89 90
}

91
// ReadFromRequest parsed flash data from encoded values in cookie.
astaxie's avatar
astaxie committed
92
func ReadFromRequest(c *Controller) *FlashData {
93
	flash := NewFlash()
astaxie's avatar
astaxie committed
94
	if cookie, err := c.Ctx.Request.Cookie(BConfig.WebConfig.FlashName); err == nil {
astaxie's avatar
astaxie committed
95 96
		v, _ := url.QueryUnescape(cookie.Value)
		vals := strings.Split(v, "\x00")
astaxie's avatar
astaxie committed
97 98
		for _, v := range vals {
			if len(v) > 0 {
JessonChan's avatar
JessonChan committed
99
				kv := strings.Split(v, "\x23"+BConfig.WebConfig.FlashSeparator+"\x23")
astaxie's avatar
astaxie committed
100 101 102 103 104 105
				if len(kv) == 2 {
					flash.Data[kv[0]] = kv[1]
				}
			}
		}
		//read one time then delete it
astaxie's avatar
astaxie committed
106
		c.Ctx.SetCookie(BConfig.WebConfig.FlashName, "", -1, "/")
astaxie's avatar
astaxie committed
107 108 109 110
	}
	c.Data["flash"] = flash.Data
	return flash
}