server

Documentation

Index

• Constants
• func MakeFileName(id string) (fileName string)
• func MakeRecordFilePath(imagesFolder string, id string) (path string)
• type CaptchaManager
  • func NewCaptchaManager(s *models.CaptchaManagerSettings) (cm *CaptchaManager, err error)
  • func (cm *CaptchaManager) CheckCaptcha(req *models.CheckCaptchaRequest) (resp *models.CheckCaptchaResponse, err error)
  • func (cm *CaptchaManager) ClearJunk() (err error)
  • func (cm *CaptchaManager) CreateCaptcha() (resp *models.CreateCaptchaResponse, err error)
  • func (cm *CaptchaManager) GetListenDsn() (dsn string)
  • func (cm *CaptchaManager) Start() (err error)
  • func (cm *CaptchaManager) Stop() (err error)
• type Registry
  • func NewRegistry(storeImages bool, imagesFolder string, recordTtlSec uint, ...) (r *Registry, err error)
  • func (r *Registry) AddRecord(id string, answer uint) (err error)
  • func (r *Registry) CheckCaptcha(id string, value uint) (ok bool, err error)
  • func (r *Registry) ClearJunk() (err error)
  • func (r *Registry) GetImageFile(id string) (data []byte, err error)
  • func (r *Registry) GetSize() (size int)
  • func (r *Registry) IsIdRegistered(id string) (isRegistered bool)
• type RegistryRecord
  • func NewRegistryRecord(id string, answer uint, ttl float64) *RegistryRecord
  • func (rr *RegistryRecord) IsExpired() bool

Constants

const (
	ImageFileExt  = "png"
	ImageFormat   = "PNG"
	ImageMimeType = "image/png"
	QueryKeyId    = "id"
	RUIDPrefix    = "RCS-"
)

const (
	MsgCleaningImagesFolder = "Cleaning the images folder ... "
	MsgDone                 = "Done"
	MsgCaptchaManagerStart  = "Captcha manager has started"
	MsgCaptchaManagerStop   = "Captcha manager has been stopped"
)

const (
	ErrFDuplicateId   = "duplicate id: %v"
	ErrFAbsentId      = "absent id: %v"
	ErrFileIsNotFound = "file is not found"
)

Functions

func MakeFileName

func MakeFileName(id string) (fileName string)

func MakeRecordFilePath

func MakeRecordFilePath(imagesFolder string, id string) (path string)

Types

type CaptchaManager

type CaptchaManager struct {
	// contains filtered or unexported fields
}

CaptchaManager is a captcha manager.

func NewCaptchaManager

func NewCaptchaManager(s *models.CaptchaManagerSettings) (cm *CaptchaManager, err error)

func (*CaptchaManager) CheckCaptcha

func (cm *CaptchaManager) CheckCaptcha(req *models.CheckCaptchaRequest) (resp *models.CheckCaptchaResponse, err error)

func (*CaptchaManager) ClearJunk

func (cm *CaptchaManager) ClearJunk() (err error)

func (*CaptchaManager) CreateCaptcha

func (cm *CaptchaManager) CreateCaptcha() (resp *models.CreateCaptchaResponse, err error)

func (*CaptchaManager) GetListenDsn

func (cm *CaptchaManager) GetListenDsn() (dsn string)

func (*CaptchaManager) Start

func (cm *CaptchaManager) Start() (err error)

func (*CaptchaManager) Stop

func (cm *CaptchaManager) Stop() (err error)

type Registry

type Registry struct {
	// contains filtered or unexported fields
}

func NewRegistry

func NewRegistry(
	storeImages bool,
	imagesFolder string,
	recordTtlSec uint,
	isCachingEnabled bool,
	cacheSizeLimit int,
	cacheVolumeLimit int,
	cacheRecordTtl uint,
) (r *Registry, err error)

func (*Registry) AddRecord

func (r *Registry) AddRecord(id string, answer uint) (err error)

func (*Registry) CheckCaptcha

func (r *Registry) CheckCaptcha(id string, value uint) (ok bool, err error)

func (*Registry) ClearJunk

func (r *Registry) ClearJunk() (err error)

func (*Registry) GetImageFile

func (r *Registry) GetImageFile(id string) (data []byte, err error)

func (*Registry) GetSize

func (r *Registry) GetSize() (size int)

func (*Registry) IsIdRegistered

func (r *Registry) IsIdRegistered(id string) (isRegistered bool)

type RegistryRecord

type RegistryRecord struct {
	Id     string
	Answer uint
	TTL    float64   // TTL is set in seconds.
	ToC    time.Time // Time of creation.
}

RegistryRecord stores an answer and timing information.

func NewRegistryRecord

func NewRegistryRecord(id string, answer uint, ttl float64) *RegistryRecord

func (*RegistryRecord) IsExpired

func (rr *RegistryRecord) IsExpired() bool