common

package

Go to main page

Versions in this module

v1

v1.0.5-preview.4

Aug 10, 2026

v1.0.5-preview.3

Aug 4, 2026

v1.0.5-preview.2

Jul 25, 2026

v1.0.5-preview.1

Jul 23, 2026

v1.0.4

Jul 18, 2026

Changes in this version

+ const MaxQuota

+ const MinQuota

+ func GetContextKeyInt64(c *gin.Context, key constant.ContextKey) int64

+ func QuotaFromDecimal(d decimal.Decimal) int

+ func QuotaFromFloat(value float64) int

+ func QuotaFromFloatStrict(value float64) (int, error)

+ func QuotaRound(value float64) int

+ func QuotaRoundStrict(value float64) (int, error)

+ func RedisDeleteVersionedHash(key, versionKey string) error

+ func RedisGetCacheVersion(key string) (int64, error)

+ func RedisHSetFieldIfVersion(key, versionKey string, expectedVersion int64, field string, value interface{}, ...) (bool, error)

+ func RedisHSetObjIfVersion(key, versionKey string, expectedVersion int64, obj interface{}, ...) (bool, error)

+ func RedisInvalidateVersionedHash(key, versionKey string) error

+ func VerifyAndDeleteCodeWithKey(key string, code string, purpose string) bool

+ func VerifyCodeWithKeyAndRun(key string, code string, purpose string, fn func() error) (verified bool, err error)

type InMemoryRateLimiter

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

+ type QuotaClamp struct

+ Clamped int

+ Kind QuotaClampKind

+ Op string

+ Original float64

+ func QuotaFromDecimalChecked(d decimal.Decimal) (int, *QuotaClamp)

+ func QuotaFromFloatChecked(value float64) (int, *QuotaClamp)

+ func QuotaRoundChecked(value float64) (int, *QuotaClamp)

+ func (c *QuotaClamp) AuditMap() map[string]interface{}

+ func (c *QuotaClamp) Error() string

+ type QuotaClampKind string

+ const QuotaClampNaN

+ const QuotaClampOverflow

+ const QuotaClampUnderflow

type SSRFProtection

+ func NewSSRFProtectionFromFetchSetting(allowPrivateIp bool, domainFilterMode bool, ipFilterMode bool, ...) (*SSRFProtection, error)

+ func (p *SSRFProtection) ValidateNetworkTarget(host string, port int) error

+ func (p *SSRFProtection) ValidateResolvedIP(host string, ip net.IP) error

v1.0.4-preview.5

Jul 15, 2026

v1.0.4-preview.4

Jul 13, 2026

v1.0.4-preview.3

Jul 10, 2026

v1.0.4-preview.2

Jul 7, 2026

v1.0.4-preview.1

Jul 3, 2026

v1.0.3

Jun 30, 2026

Changes in this version

+ const NodeNameSourceHostname

+ const NodeNameSourceManual

+ var DefaultTrustedProxies = []string

+ var EmptyCompletionRetryEnabled = false

+ var ErrSMTPStartTLSUnsupported = errors.New("smtp server does not support STARTTLS")

+ var NodeNameManuallyConfigured bool

+ var NodeNameSource = NodeNameSourceHostname

+ var SMTPInsecureSkipVerify = false

+ var SMTPStartTLSEnabled = false

+ func AutoSMTPAuth(username, password string) smtp.Auth

+ type NodeIdentity struct

+ ManuallyConfigured bool

+ Name string

+ ShouldConfigureManually bool

+ Source string

+ func GetNodeIdentity() NodeIdentity

v1.0.3-preview.2

Jun 27, 2026

v1.0.3-preview

Jun 24, 2026

v1.0.2

Jun 22, 2026

Changes in this version

+ var SessionCookieSecure = true

+ var TrustedProxies []string

type SSRFProtection

+ func NewSSRFProtectionWithFetchSetting(enableSSRFProtection, allowPrivateIp bool, domainFilterMode bool, ...) (*SSRFProtection, bool, error)

+ func (p *SSRFProtection) ResolveValidatedDialAddress(ctx context.Context, host string, port int) (string, error)

+ func (p *SSRFProtection) ResolveValidatedDialAddresses(ctx context.Context, host string, port int) ([]string, error)

v1.0.1

Jun 20, 2026

v1.0.0

Jun 19, 2026

Changes in this version

+ const BackupCodeCount

+ const BackupCodeLength

+ const ChannelStatusAutoDisabled

+ const ChannelStatusEnabled

+ const ChannelStatusManuallyDisabled

+ const ChannelStatusUnknown

+ const DatabaseTypeMySQL

+ const DatabaseTypePostgreSQL

+ const DatabaseTypeSQLite

+ const DefaultLogo

+ const EmailVerificationPurpose

+ const KeyBodyStorage

+ const KeyRequestBody

+ const LegacyDefaultLogo

+ const LocalLogContentLimit

+ const LockoutDuration

+ const MaxFailAttempts

+ const PasswordResetPurpose

+ const RedemptionCodeStatusDisabled

+ const RedemptionCodeStatusEnabled

+ const RedemptionCodeStatusUsed

+ const RequestIdKey

+ const RoleAdminUser

+ const RoleCommonUser

+ const RoleGuestUser

+ const RoleRootUser

+ const TokenStatusDisabled

+ const TokenStatusEnabled

+ const TokenStatusExhausted

+ const TokenStatusExpired

+ const TopUpStatusExpired

+ const TopUpStatusFailed

+ const TopUpStatusPending

+ const TopUpStatusSuccess

+ const UpstreamRequestIdKey

+ const UserStatusDisabled

+ const UserStatusEnabled

+ var AutomaticDisableChannelEnabled = false

+ var AutomaticEnableChannelEnabled = false

+ var BatchUpdateEnabled = false

+ var BatchUpdateInterval int

+ var ChannelDisableThreshold = 5.0

+ var CohereSafetySetting string

+ var CriticalRateLimitDuration int64 = 20 * 60

+ var CriticalRateLimitEnable bool

+ var CriticalRateLimitNum = 20

+ var CryptoSecret = uuid.New().String()

+ var DataExportDefaultTime = "hour"

+ var DataExportEnabled = true

+ var DataExportInterval = 5

+ var DebugEnabled bool

+ var DefaultCollapseSidebar = false

+ var DefaultSSRFProtection = &SSRFProtection

+ var DisplayInCurrencyEnabled = true

+ var DisplayTokenStatEnabled = true

+ var DownloadRateLimitDuration int64 = 60

+ var DownloadRateLimitNum = 10

+ var DrawingEnabled = true

+ var EmailAliasRestrictionEnabled = false

+ var EmailDomainRestrictionEnabled = false

+ var EmailDomainWhitelist = []string

+ var EmailLoginAuthServerList = []string

+ var EmailVerificationEnabled = false

+ var ErrRequestBodyTooLarge = errors.New("request body too large")

+ var ErrStorageClosed = fmt.Errorf("body storage is closed")

+ var FileDownloadPermission = RoleGuestUser

+ var FileUploadPermission = RoleGuestUser

+ var Footer = ""

+ var GeminiSafetySetting string

+ var GitHubClientId = ""

+ var GitHubClientSecret = ""

+ var GitHubOAuthEnabled = false

+ var GlobalApiRateLimitDuration int64

+ var GlobalApiRateLimitEnable bool

+ var GlobalApiRateLimitNum int

+ var GlobalWebRateLimitDuration int64

+ var GlobalWebRateLimitEnable bool

+ var GlobalWebRateLimitNum int

+ var ImageDownloadPermission = RoleGuestUser

+ var ImageGenerationModels = []string

+ var ImageUploadPermission = RoleGuestUser

+ var InsecureTLSConfig = &tls.Config

+ var IsMasterNode bool

+ var ItemsPerPage = 10

+ var LinuxDOClientId = ""

+ var LinuxDOClientSecret = ""

+ var LinuxDOMinimumTrustLevel = 0

+ var LinuxDOOAuthEnabled = false

+ var LogConsumeEnabled = true

+ var LogContentMaxCharacters = 12000

+ var LogDir = flag.String("log-dir", "./logs", "specify the log directory")

+ var LogRequestContentEnabled = false

+ var LogResponseContentEnabled = false

+ var LogSqlType = DatabaseTypeSQLite

+ var LogWriterMu sync.RWMutex

+ var Logo = ""

+ var MaxRecentItems = 1000

+ var MemoryCacheEnabled bool

+ var NodeName = ""

+ var OpenAIResponseOnlyModels = []string

+ var OpenAITextModels = []string

+ var OptionMap map[string]string

+ var OptionMapRWMutex sync.RWMutex

+ var PasswordLoginEnabled = true

+ var PasswordRegisterEnabled = true

+ var Port = flag.Int("port", 3000, "the listening port")

+ var PreConsumedQuota = 500

+ var PrintHelp = flag.Bool("help", false, "print help and exit")

+ var PrintVersion = flag.Bool("version", false, "print version and exit")

+ var QuotaForInvitee = 0

+ var QuotaForInviter = 0

+ var QuotaForNewUser = 0

+ var QuotaPerUnit = 500 * 1000.0

+ var QuotaRemindThreshold = 1000

+ var RDB *redis.Client

+ var RateLimitKeyExpirationDuration = 20 * time.Minute

+ var RedisEnabled = true

+ var RegisterEnabled = true

+ var RelayIdleConnTimeout int

+ var RelayMaxIdleConns int

+ var RelayMaxIdleConnsPerHost int

+ var RelayTimeout int

+ var RequestInterval time.Duration

+ var RetryTimes = 0

+ var SMTPAccount = ""

+ var SMTPForceAuthLogin = false

+ var SMTPFrom = ""

+ var SMTPPort = 587

+ var SMTPSSLEnabled = false

+ var SMTPServer = ""

+ var SMTPToken = ""

+ var SQLitePath = "one-api.db?_busy_timeout=30000"

+ var SearchRateLimitDuration int64 = 60

+ var SearchRateLimitEnable = true

+ var SearchRateLimitNum = 10

+ var SessionSecret = uuid.New().String()

+ var StartTime = time.Now().Unix()

+ var SyncFrequency int

+ var SystemName = "MAX API"

+ var TLSInsecureSkipVerify bool

+ var TaskEnabled = true

+ var TelegramBotName = ""

+ var TelegramBotToken = ""

+ var TelegramOAuthEnabled = false

+ var TopUpLink = ""

+ var TranslateMessage func(c *gin.Context, key string, args ...map[string]any) string

+ var TurnstileCheckEnabled = false

+ var TurnstileSecretKey = ""

+ var TurnstileSiteKey = ""

+ var UploadRateLimitDuration int64 = 60

+ var UploadRateLimitNum = 10

+ var UsingClickHouse = false

+ var UsingMySQL = false

+ var UsingPostgreSQL = false

+ var UsingSQLite = false

+ var Validate *validator.Validate

+ var VerificationValidMinutes = 10

+ var Version = "v0.0.0"

+ var WeChatAccountQRCodeImageURL = ""

+ var WeChatAuthEnabled = false

+ var WeChatServerAddress = ""

+ var WeChatServerToken = ""

+ func Any2Type[T any](data any) (T, error)

+ func ApiError(c *gin.Context, err error)

+ func ApiErrorI18n(c *gin.Context, key string, args ...map[string]any)

+ func ApiErrorMsg(c *gin.Context, msg string)

+ func ApiSuccess(c *gin.Context, data any)

+ func ApiSuccessI18n(c *gin.Context, key string, data any, args ...map[string]any)

+ func BuildURL(base string, endpoint string) string

+ func Bytes2Size(num int64) string

+ func ChannelType2APIType(channelType int) (int, bool)

+ func CleanupBodyStorage(c *gin.Context)

+ func CleanupOldCacheFiles()

+ func CleanupOldDiskCacheFiles(maxAge time.Duration) error

+ func CreateDiskCacheFile(cacheType DiskCacheType) (string, *os.File, error)

+ func DecodeJson(reader io.Reader, v any) error

+ func DecrementDiskFiles(size int64)

+ func DecrementMemoryBuffers(size int64)

+ func DeepCopy[T any](src *T) (*T, error)

+ func DeleteKey(key string, purpose string)

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

+ func EncodeBase64(str string) string

+ func EnsureDiskCacheDir() error

+ func FatalLog(v ...any)

+ func GenerateBackupCodes() ([]string, error)

+ func GenerateHMAC(data string) string

+ func GenerateHMACWithKey(key []byte, data string) string

+ func GenerateKey() (string, error)

+ func GenerateQRCodeData(secret, username string) string

+ func GenerateRandomCharsKey(length int) (string, error)

+ func GenerateRandomKey(length int) (string, error)

+ func GenerateTOTPSecret(accountName string) (*otp.Key, error)

+ func GenerateVerificationCode(length int) string

+ func Get2FAIssuer() string

+ func GetAnonymousRequestBodyLimitBytes() int64

+ func GetAudioDuration(ctx context.Context, f io.ReadSeeker, ext string) (duration float64, err error)

+ func GetContextKey(c *gin.Context, key constant.ContextKey) (any, bool)

+ func GetContextKeyBool(c *gin.Context, key constant.ContextKey) bool

+ func GetContextKeyInt(c *gin.Context, key constant.ContextKey) int

+ func GetContextKeyString(c *gin.Context, key constant.ContextKey) string

+ func GetContextKeyStringMap(c *gin.Context, key constant.ContextKey) map[string]any

+ func GetContextKeyStringSlice(c *gin.Context, key constant.ContextKey) []string

+ func GetContextKeyTime(c *gin.Context, key constant.ContextKey) time.Time

+ func GetContextKeyType[T any](c *gin.Context, key constant.ContextKey) (T, bool)

+ func GetDiskCacheDir() string

+ func GetDiskCacheInfo() (fileCount int, totalSize int64, err error)

+ func GetDiskCacheMaxSizeBytes() int64

+ func GetDiskCachePath() string

+ func GetDiskCacheThresholdBytes() int64

+ func GetEndpointTypesByChannelType(channelType int, modelName string) []constant.EndpointType

+ func GetEnvOrDefault(env string, defaultValue int) int

+ func GetEnvOrDefaultBool(env string, defaultValue bool) bool

+ func GetEnvOrDefaultString(env string, defaultValue string) string

+ func GetIp() (ip string)

+ func GetJsonString(data any) string

+ func GetJsonType(data json.RawMessage) string

+ func GetNetworkIps() []string

+ func GetPointer[T any](v T) *T

+ func GetRandomInt(max int) int

+ func GetRandomString(length int) string

+ func GetRequestBody(c *gin.Context) (io.Seeker, error)

+ func GetStringIfEmpty(str string, defaultValue string) string

+ func GetTheme() string

+ func GetTimeString() string

+ func GetTimestamp() int64

+ func GetTopupGroupRatio(name string) float64

+ func GetTrustQuota() int

+ func GetUUID() string

+ func HashBackupCode(code string) (string, error)

+ func HmacSha256(message, key string) string

+ func HmacSha256Raw(message, key []byte) []byte

+ func IncrementDiskCacheHits()

+ func IncrementDiskFiles(size int64)

+ func IncrementMemoryBuffers(size int64)

+ func IncrementMemoryCacheHits()

+ func InitEnv()

+ func InitRedisClient() (err error)

+ func IntMax(a int, b int) int

+ func Interface2String(inter interface{}) string

+ func IsDiskCacheAvailable(requestSize int64) bool

+ func IsDiskCacheEnabled() bool

+ func IsIP(s string) bool

+ func IsImageGenerationModel(modelName string) bool

+ func IsIpInCIDRList(ip net.IP, cidrList []string) bool

+ func IsJsonArray(str string) bool

+ func IsJsonObject(str string) bool

+ func IsOpenAIResponseOnlyModel(modelName string) bool

+ func IsOpenAITextModel(modelName string) bool

+ func IsPrivateIP(ip net.IP) bool

+ func IsRequestBodyTooLargeError(err error) bool

+ func IsRunningInContainer() bool

+ func IsValidateRole(role int) bool

+ func JsonRawMessageToString(data json.RawMessage) string

+ func LocalLogPreview(content string) string

+ func LogStartupSuccess(startTime time.Time, port string)

+ func LoginAuth(username, password string) smtp.Auth

+ func MapToJsonStr(m map[string]interface{}) string

+ func Marshal(v any) ([]byte, error)

+ func MaskEmail(email string) string

+ func MaskSensitiveInfo(str string) string

+ func Max(a int, b int) int

+ func MessageWithRequestId(message string, id string) string

+ func Monitor()

+ func NormalizeBackupCode(code string) string

+ func NormalizeBillingPreference(pref string) string

+ func NormalizeLogo(logo string) string

+ func OpenBrowser(url string)

+ func ParseIP(s string) net.IP

+ func ParseMultipartFormReusable(c *gin.Context) (*multipart.Form, error)

+ func ParseRedisOption() *redis.Options

+ func Password2Hash(password string) (string, error)

+ func RandomSleep()

+ func ReadDiskCacheFile(filePath string) ([]byte, error)

+ func ReadDiskCacheFileString(filePath string) (string, error)

+ func ReaderOnly(r io.Reader) io.Reader

+ func RedisDel(key string) error

+ func RedisDelKey(key string) error

+ func RedisGet(key string) (string, error)

+ func RedisHGetObj(key string, obj interface{}) error

+ func RedisHIncrBy(key, field string, delta int64) error

+ func RedisHSetField(key, field string, value interface{}) error

+ func RedisHSetObj(key string, obj interface{}, expiration time.Duration) error

+ func RedisIncr(key string, delta int64) error

+ func RedisKeyCacheSeconds() int

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

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

+ func RelayCtxGo(ctx context.Context, f func())

+ func RemoveDiskCacheFile(filePath string) error

+ func ResetDiskCacheStats()

+ func ResetDiskCacheUsage()

+ func SafeSendBool(ch chan bool, value bool) (closed bool)

+ func SafeSendString(ch chan string, value string) (closed bool)

+ func SafeSendStringTimeout(ch chan string, value string, timeout int) (closed bool)

+ func SaveTmpFile(filename string, data io.Reader) (string, error)

+ func Seconds2Time(num int) (time string)

+ func SendEmail(subject string, receiver string, content string) error

+ func SetContextKey(c *gin.Context, key constant.ContextKey, value any)

+ func SetDiskCacheConfig(config DiskCacheConfig)

+ func SetPerformanceMonitorConfig(config PerformanceMonitorConfig)

+ func SetTheme(_ string)

+ func Sha1(data []byte) string

+ func Sha1Raw(data []byte) []byte

+ func Sha256Raw(data []byte) []byte

+ func ShouldUseDiskCache(dataSize int64) bool

+ func StartPyroScope() error

+ func StartSystemMonitor()

+ func StrToJsonArray(str string) ([]interface{}, error)

+ func StrToMap(str string) (map[string]interface{}, error)

+ func String2Int(str string) int

+ func StringToByteSlice(s string) []byte

+ func StringsContains(strs []string, str string) bool

+ func SyncDiskCacheStats()

+ func SysError(s string)

+ func SysLog(s string)

+ func ThemeAwarePath(suffix string) string

+ func TopupGroupRatio2JSONString() string

+ func UnescapeHTML(x string) interface

+ func Unmarshal(data []byte, v any) error

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

+ func UnmarshalJsonStr(data string, v any) error

+ func UpdateTopupGroupRatioByJSONString(jsonStr string) error

+ func ValidJSON(data []byte) bool

+ func ValidateBackupCode(code string) bool

+ func ValidateNumericCode(code string) (string, error)

+ func ValidatePasswordAndHash(password string, hash string) bool

+ func ValidateRedirectURL(rawURL string) error

+ func ValidateTOTPCode(secret, code string) bool

+ func ValidateURLWithFetchSetting(urlStr string, enableSSRFProtection, allowPrivateIp bool, ...) error

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

+ func WriteDiskCacheFile(cacheType DiskCacheType, data []byte) (string, error)

+ func WriteDiskCacheFileString(cacheType DiskCacheType, data string) (string, error)

+ type BodyStorage interface

+ Bytes func() ([]byte, error)

+ IsDisk func() bool

+ Size func() int64

+ func CreateBodyStorage(data []byte) (BodyStorage, error)

+ func CreateBodyStorageFromReader(reader io.Reader, contentLength int64, maxBytes int64) (BodyStorage, error)

+ func GetBodyStorage(c *gin.Context) (BodyStorage, error)

+ type CustomEvent struct

+ Data interface{}

+ Event string

+ Id string

+ Retry uint

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

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

+ type DiskCacheConfig struct

+ Enabled bool

+ MaxSizeMB int

+ Path string

+ ThresholdMB int

+ func GetDiskCacheConfig() DiskCacheConfig

+ type DiskCacheStats struct

+ ActiveDiskFiles int64

+ ActiveMemoryBuffers int64

+ CurrentDiskUsageBytes int64

+ CurrentMemoryUsageBytes int64

+ DiskCacheHits int64

+ DiskCacheMaxBytes int64

+ DiskCacheThresholdBytes int64

+ MemoryCacheHits int64

+ func GetDiskCacheStats() DiskCacheStats

+ type DiskCacheType string

+ const DiskCacheTypeBody

+ const DiskCacheTypeFile

+ type DiskSpaceInfo struct

+ Free uint64

+ Total uint64

+ Used uint64

+ UsedPercent float64

+ func GetDiskSpaceInfo() DiskSpaceInfo

+ type EndpointInfo struct

+ Method string

+ Path string

+ func GetDefaultEndpointInfo(et constant.EndpointType) (EndpointInfo, bool)

+ type InMemoryRateLimiter struct

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

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

+ type PageInfo struct

+ Items any

+ Page int

+ PageSize int

+ Total int

+ func GetPageQuery(c *gin.Context) *PageInfo

+ func (p *PageInfo) GetEndIdx() int

+ func (p *PageInfo) GetPage() int

+ func (p *PageInfo) GetPageSize() int

+ func (p *PageInfo) GetStartIdx() int

+ func (p *PageInfo) SetItems(items any)

+ func (p *PageInfo) SetTotal(total int)

+ type PerformanceMonitorConfig struct

+ CPUThreshold int

+ DiskThreshold int

+ Enabled bool

+ MemoryThreshold int

+ func GetPerformanceMonitorConfig() PerformanceMonitorConfig

+ type SSRFProtection struct

+ AllowPrivateIp bool

+ AllowedPorts []int

+ ApplyIPFilterForDomain bool

+ DomainFilterMode bool

+ DomainList []string

+ IpFilterMode bool

+ IpList []string

+ func (p *SSRFProtection) IsIPAccessAllowed(ip net.IP) bool

+ func (p *SSRFProtection) ValidateURL(urlStr string) error

+ type SystemStatus struct

+ CPUUsage float64

+ DiskUsage float64

+ MemoryUsage float64

+ func GetSystemStatus() SystemStatus

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL