light-apiengine-feature/utils/captcha_util.go

package utils

import (
	"git.qianqiusoft.com/qianqiusoft/light-apiengine/config"
	"git.qianqiusoft.com/qianqiusoft/light-apiengine/logs"

	"github.com/dchest/captcha"
	"errors"
	"bytes"
	"time"
	"fmt"
	"github.com/gin-gonic/gin"
	//"github.com/gin-contrib/sessions"
)

func init() {
	imageCaptchaConfig.length = captcha.DefaultLen
	imageCaptchaConfig.collect_num = captcha.CollectNum
	imageCaptchaConfig.expiration = captcha.Expiration

	sms_url := config.AppConfig.GetKey("sms_url")
	sms_tmpl := config.AppConfig.GetKey("sms_tmpl")
	smsConfig.send_format = fmt.Sprintf("%s/send?mobile=%%s&name=%s", sms_url, sms_tmpl)
	smsConfig.check_format = fmt.Sprintf("%s/check?mobile=%%s&code=%%s", sms_url)
}

var imageCaptchaConfig struct {
	// 验证码长度
	length int
	// 验证码缓存数量
	collect_num int
	// 验证码超时时间
	expiration time.Duration
}

// @Description 生成图片验证码
// @Params width int 生成图片的宽高
// @Return id string 验证码id
// @Return image *bytes.Buffer 图片buffer
// @Return err error 错误
func GenerateImageCaptcha(width, height, length int) (string, *bytes.Buffer, error) {
	var captchaId string
	var image bytes.Buffer
	if width <= 0 {
		width = 240
	}
	if height <= 0 {
		height = 80
	}
	if length <= 0 {
		length = imageCaptchaConfig.length
	}
	captchaId = captcha.NewLen(length)
	err := captcha.WriteImage(&image, captchaId, width, height)
	return captchaId, &image, err
}

// @Description 图片验证码校验
// @Param code string 验证码
// @Param id 验证码id 手机号码
// @Return result bool 验证结果 true 成功 false 失败
func ImageCaptchaCheck(code, id string) bool {
	if code == "" || id == "" {
		return false
	}
	return captcha.VerifyString(id, code)
}

// @Description 设置图片验证码长度
// @Param length int 验证码长度
func SetImageCaptchaLength(length int) {
	if length != imageCaptchaConfig.length {
		imageCaptchaConfig.length = length
	}
}

// @Description 设置图片验证码超时时间
// @Param expiration time.Duration 超时时间
func SetImageCaptchaExpiration(expiration time.Duration) {
	if expiration != imageCaptchaConfig.expiration {
		imageCaptchaConfig.expiration = expiration
		memoryStore := captcha.NewMemoryStore(imageCaptchaConfig.collect_num, expiration)
		captcha.SetCustomStore(memoryStore)
	}
}

// @Description 设置图片验证码缓存数量
// @Param collect_num int 缓存数量
func SetImageCaptchaCollectNum(collect_num int) {
	if collect_num != imageCaptchaConfig.collect_num {
		imageCaptchaConfig.collect_num = collect_num
		memoryStore := captcha.NewMemoryStore(collect_num, imageCaptchaConfig.expiration)
		captcha.SetCustomStore(memoryStore)
	}
}

var smsConfig struct {
	send_format string
	check_format string
}

// @Description 发送短信验证码
// @Param mobile string 手机号码
// @Return data []byte 发送结果
// @Return err error 错误
func SendSmsCaptcha(mobile string) ([]byte, error) {
	if mobile == "" {
		return nil, errors.New("mobile is cannot empty")
	}
	sms_url := fmt.Sprintf(smsConfig.send_format, mobile)
	logs.Debug("-----sms_send_url-------")
	logs.Debug(sms_url)
	data, err := NewHttpUtil().Get(sms_url, nil, nil)
	logs.Debug(string(data))
	if err != nil {
		logs.Error("send sms captcha failure:", err)
	}
	return data, err
}

// @Description 短信验证码校验
// @Param captcha string 验证码
// @Param mobile string 手机号码
// @Return result bool 验证结果 true 成功 false 失败
func SmsCaptchaCheck(captcha, mobile string) bool {
	if captcha == "" || mobile == "" {
		return false
	}
	sms_url := fmt.Sprintf(smsConfig.check_format, mobile, captcha)
	logs.Debug("-----sms_check_url-------")
	logs.Debug(sms_url)
	data, err := NewHttpUtil().Get(sms_url, nil, nil)
	return err == nil && string(data) != "0"
}

// @Description 设置session
// @Param ctx *gin.Context gin上下文
// @Param key string 键
// @Param value string 值
func SetSession(ctx *gin.Context, key, value interface{}) {
	/*session := sessions.Default(ctx)
	session.Set(key, value)
	session.Save()*/
}

// @Description 获取session
// @Param ctx *gin.Context gin上下文
// @Param key string 键
// @Param value string 值
func GetSession(ctx *gin.Context, key interface{}, defalutValue ...interface{}) interface{} {
	return nil
	/*session := sessions.Default(ctx)
	value := session.Get(key)
	if value == nil && len(defalutValue) > 0 {
		return defalutValue[0]
	}
	return value*/
}