common

Documentation

Index

• Constants
• Variables
• func DeleteKey(key string, purpose string)
• func EmbedFolder(fsEmbed embed.FS, targetPath string) static.ServeFileSystem
• func GenerateVerificationCode(length int) string
• func GetRequestBody(c *gin.Context) ([]byte, error)
• func InitRedisClient() (err error)
• func LogQuota(quota int64) string
• func ParseRedisOption() *redis.Options
• func Password2Hash(password string) (string, error)
• func RedisDecrease(key string, value int64) error
• func RedisDel(key string) error
• func RedisGet(key string) (string, error)
• func RedisSet(key string, value string, expiration time.Duration) error
• func RegisterVerificationCodeWithKey(key string, code string, purpose string)
• func SetEventStreamHeaders(c *gin.Context)
• func UnmarshalBodyReusable(c *gin.Context, v any) error
• func ValidatePasswordAndHash(password string, hash string) bool
• func VerifyCodeWithKey(key string, code string, purpose string) bool
• type CustomEvent
  • func (r CustomEvent) Render(w http.ResponseWriter) error
  • func (r CustomEvent) WriteContentType(w http.ResponseWriter)
• type InMemoryRateLimiter
  • func (l *InMemoryRateLimiter) Init(expirationDuration time.Duration)
  • func (l *InMemoryRateLimiter) Request(key string, maxRequestNum int, duration int64) bool

Constants

const (
	EmailVerificationPurpose = "v"
	PasswordResetPurpose     = "r"
)

const KeyRequestBody = "key_request_body"

Variables

var (
	Port         = flag.Int("port", 3000, "the listening port")
	PrintVersion = flag.Bool("version", false, "print version and exit")
	PrintHelp    = flag.Bool("help", false, "print help and exit")
	LogDir       = flag.String("log-dir", "./logs", "specify the log directory")
)

var RDB *redis.Client

var RedisEnabled = true

var SQLiteBusyTimeout = env.Int("SQLITE_BUSY_TIMEOUT", 3000)

var SQLitePath = "one-api.db"

var StartTime = time.Now().Unix() // unit: second

var UsingMySQL = false

var UsingPostgreSQL = false

var UsingSQLite = false

var Validate *validator.Validate

var VerificationValidMinutes = 10

var Version = "v0.0.0" // this hard coding will be replaced automatically when building, no need to manually change

Functions

func DeleteKey

func DeleteKey(key string, purpose string)

func EmbedFolder

func EmbedFolder(fsEmbed embed.FS, targetPath string) static.ServeFileSystem

func GenerateVerificationCode

func GenerateVerificationCode(length int) string

func GetRequestBody

func GetRequestBody(c *gin.Context) ([]byte, error)

func InitRedisClient

func InitRedisClient() (err error)

InitRedisClient This function is called after init()

func LogQuota

func LogQuota(quota int64) string

func ParseRedisOption

func ParseRedisOption() *redis.Options

func Password2Hash

func Password2Hash(password string) (string, error)

func RedisDecrease

func RedisDecrease(key string, value int64) error

func RedisDel

func RedisDel(key string) error

func RedisGet

func RedisGet(key string) (string, error)

func RedisSet

func RedisSet(key string, value string, expiration time.Duration) error

func RegisterVerificationCodeWithKey

func RegisterVerificationCodeWithKey(key string, code string, purpose string)

func SetEventStreamHeaders

func SetEventStreamHeaders(c *gin.Context)

func UnmarshalBodyReusable

func UnmarshalBodyReusable(c *gin.Context, v any) error

func ValidatePasswordAndHash

func ValidatePasswordAndHash(password string, hash string) bool

func VerifyCodeWithKey

func VerifyCodeWithKey(key string, code string, purpose string) bool

Types

type CustomEvent

type CustomEvent struct {
	Event string
	Id    string
	Retry uint
	Data  interface{}
}

func (CustomEvent) Render

func (r CustomEvent) Render(w http.ResponseWriter) error

func (CustomEvent) WriteContentType

func (r CustomEvent) WriteContentType(w http.ResponseWriter)

type InMemoryRateLimiter

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

func (*InMemoryRateLimiter) Init

func (l *InMemoryRateLimiter) Init(expirationDuration time.Duration)

func (*InMemoryRateLimiter) Request

func (l *InMemoryRateLimiter) Request(key string, maxRequestNum int, duration int64) bool

Request parameter duration's unit is seconds