mirror of https://github.com/astaxie/beego.git
125 lines
3.3 KiB
Go
125 lines
3.3 KiB
Go
// Copyright 2014 beego Author. All Rights Reserved.
|
|
//
|
|
// 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
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// 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.
|
|
|
|
// Package captcha implements generation and verification of image CAPTCHAs.
|
|
// an example for use captcha
|
|
//
|
|
// ```
|
|
// package controllers
|
|
//
|
|
// import (
|
|
// "github.com/astaxie/beego"
|
|
// "github.com/astaxie/beego/cache"
|
|
// "github.com/astaxie/beego/utils/captcha"
|
|
// )
|
|
//
|
|
// var cpt *captcha.Captcha
|
|
//
|
|
// func init() {
|
|
// // use beego cache system store the captcha data
|
|
// store := cache.NewMemoryCache()
|
|
// cpt = captcha.NewWithFilter("/captcha/", store)
|
|
// }
|
|
//
|
|
// type MainController struct {
|
|
// beego.Controller
|
|
// }
|
|
//
|
|
// func (this *MainController) Get() {
|
|
// this.TplName = "index.tpl"
|
|
// }
|
|
//
|
|
// func (this *MainController) Post() {
|
|
// this.TplName = "index.tpl"
|
|
//
|
|
// this.Data["Success"] = cpt.VerifyReq(this.Ctx.Request)
|
|
// }
|
|
// ```
|
|
//
|
|
// template usage
|
|
//
|
|
// ```
|
|
// {{.Success}}
|
|
// <form action="/" method="post">
|
|
// {{create_captcha}}
|
|
// <input name="captcha" type="text">
|
|
// </form>
|
|
// ```
|
|
package captcha
|
|
|
|
import (
|
|
"html/template"
|
|
"net/http"
|
|
"time"
|
|
|
|
"github.com/astaxie/beego/server/web/captcha"
|
|
beecontext "github.com/astaxie/beego/server/web/context"
|
|
|
|
"github.com/astaxie/beego/adapter/cache"
|
|
"github.com/astaxie/beego/adapter/context"
|
|
)
|
|
|
|
var (
|
|
defaultChars = []byte{0, 1, 2, 3, 4, 5, 6, 7, 8, 9}
|
|
)
|
|
|
|
const (
|
|
// default captcha attributes
|
|
challengeNums = 6
|
|
expiration = 600 * time.Second
|
|
fieldIDName = "captcha_id"
|
|
fieldCaptchaName = "captcha"
|
|
cachePrefix = "captcha_"
|
|
defaultURLPrefix = "/captcha/"
|
|
)
|
|
|
|
// Captcha struct
|
|
type Captcha captcha.Captcha
|
|
|
|
// Handler beego filter handler for serve captcha image
|
|
func (c *Captcha) Handler(ctx *context.Context) {
|
|
(*captcha.Captcha)(c).Handler((*beecontext.Context)(ctx))
|
|
}
|
|
|
|
// CreateCaptchaHTML template func for output html
|
|
func (c *Captcha) CreateCaptchaHTML() template.HTML {
|
|
return (*captcha.Captcha)(c).CreateCaptchaHTML()
|
|
}
|
|
|
|
// CreateCaptcha create a new captcha id
|
|
func (c *Captcha) CreateCaptcha() (string, error) {
|
|
return (*captcha.Captcha)(c).CreateCaptcha()
|
|
}
|
|
|
|
// VerifyReq verify from a request
|
|
func (c *Captcha) VerifyReq(req *http.Request) bool {
|
|
return (*captcha.Captcha)(c).VerifyReq(req)
|
|
}
|
|
|
|
// Verify direct verify id and challenge string
|
|
func (c *Captcha) Verify(id string, challenge string) (success bool) {
|
|
return (*captcha.Captcha)(c).Verify(id, challenge)
|
|
}
|
|
|
|
// NewCaptcha create a new captcha.Captcha
|
|
func NewCaptcha(urlPrefix string, store cache.Cache) *Captcha {
|
|
return (*Captcha)(captcha.NewCaptcha(urlPrefix, cache.CreateOldToNewAdapter(store)))
|
|
}
|
|
|
|
// NewWithFilter create a new captcha.Captcha and auto AddFilter for serve captacha image
|
|
// and add a template func for output html
|
|
func NewWithFilter(urlPrefix string, store cache.Cache) *Captcha {
|
|
return (*Captcha)(captcha.NewWithFilter(urlPrefix, cache.CreateOldToNewAdapter(store)))
|
|
}
|