global

Documentation

Overview

Package global 包含文件下载,视频音频编码,本地文件缓存处理,消息过滤器,调用速率限制,gocq主配置等的相关函数与结构体

Index

• Constants
• Variables
• func Check(err error, deleteSession bool)
• func DelFile(path string) bool
• func DownloadFile(url, path string, limit int64, headers map[string]string) error
• func DownloadFileMultiThreading(url, path string, limit int64, threadCount int, headers map[string]string) error
• func EncodeMP4(src string, dst string) error
• func EncoderSilk(data []byte) ([]byte, error)
• func ExtractCover(src string, target string) error
• func FindFile(file, cache, p string) (data []byte, err error)
• func GetBytes(url string) ([]byte, error)
• func GetLogLevel(level string) []logrus.Level
• func GetLogLevelColorCode(level logrus.Level) string
• func HTTPGetReadCloser(url string) (io.ReadCloser, error)
• func IsAMRorSILK(b []byte) bool
• func NeteaseMusicSongInfo(id string) (gjson.Result, error)
• func NewBuffer() *bytes.Buffer
• func NewGzipReadCloser(reader io.ReadCloser) (io.ReadCloser, error)
• func PathExists(path string) bool
• func PutBuffer(buf *bytes.Buffer)
• func QQMusicSongInfo(id string) (gjson.Result, error)
• func ReadAddrFile(path string) []netip.AddrPort
• func ReadAllText(path string) string
• func SetupMainSignalHandler() <-chan struct{}
• func VersionNameCompare(current, remote string) bool
• func WriteAllText(path, text string) error
• type LocalHook
  • func NewLocalHook(args interface{}, consoleFormatter, fileFormatter logrus.Formatter, ...) *LocalHook
  • func (hook *LocalHook) Fire(entry *logrus.Entry) error
  • func (hook *LocalHook) Levels() []logrus.Level
  • func (hook *LocalHook) SetFormatter(consoleFormatter, fileFormatter logrus.Formatter)
  • func (hook *LocalHook) SetPath(path string)
  • func (hook *LocalHook) SetWriter(writer io.Writer)
• type LogFormat
  • func (f LogFormat) Format(entry *logrus.Entry) ([]byte, error)
• type MSG

Constants

const (
	// ImagePath go-cqhttp使用的图片缓存目录
	ImagePath = "data/images"
	// VoicePath go-cqhttp使用的语音缓存目录
	VoicePath = "data/voices"
	// VideoPath go-cqhttp使用的视频缓存目录
	VideoPath = "data/videos"
	// CachePath go-cqhttp使用的缓存目录
	CachePath = "data/cache"
	// DumpsPath go-cqhttp使用错误转储目录
	DumpsPath = "dumps"
	// HeaderAmr AMR文件头
	HeaderAmr = "#!AMR"
	// HeaderSilk Silkv3文件头
	HeaderSilk = "\x02#!SILK_V3"
)

Variables

var (

	// ErrOverSize 响应主体过大时返回此错误
	ErrOverSize = errors.New("oversize")

	// UserAgent HTTP请求时使用的UA
	UserAgent = "" /* 130-byte string literal not displayed */
)

Functions

func Check

func Check(err error, deleteSession bool)

Check 检测err是否为nil

func DelFile

func DelFile(path string) bool

DelFile 删除一个给定path，并返回删除结果

func DownloadFile

func DownloadFile(url, path string, limit int64, headers map[string]string) error

DownloadFile 将给定URL对应的文件下载至给定Path

func DownloadFileMultiThreading

func DownloadFileMultiThreading(url, path string, limit int64, threadCount int, headers map[string]string) error

DownloadFileMultiThreading 使用threadCount个线程将给定URL对应的文件下载至给定Path

func EncodeMP4

func EncodeMP4(src string, dst string) error

EncodeMP4 将给定视频文件编码为MP4

func EncoderSilk

func EncoderSilk(data []byte) ([]byte, error)

EncoderSilk 将音频编码为Silk

func ExtractCover

func ExtractCover(src string, target string) error

ExtractCover 获取给定视频文件的Cover

func FindFile

func FindFile(file, cache, p string) (data []byte, err error)

FindFile 从给定的File寻找文件，并返回文件byte数组。File是一个合法的URL。p为文件寻找位置。 对于HTTP/HTTPS形式的URL，Cache为"1"或空时表示启用缓存

func GetBytes

func GetBytes(url string) ([]byte, error)

GetBytes 对给定URL发送Get请求，返回响应主体

func GetLogLevel

func GetLogLevel(level string) []logrus.Level

GetLogLevel 获取日志等级

可能的值有

"trace","debug","info","warn","warn","error"

func GetLogLevelColorCode

func GetLogLevelColorCode(level logrus.Level) string

GetLogLevelColorCode 获取日志等级对应色彩code

func HTTPGetReadCloser

func HTTPGetReadCloser(url string) (io.ReadCloser, error)

HTTPGetReadCloser 从 Http url 获取 io.ReadCloser

func IsAMRorSILK

func IsAMRorSILK(b []byte) bool

IsAMRorSILK 判断给定文件是否为Amr或Silk格式

func NeteaseMusicSongInfo

func NeteaseMusicSongInfo(id string) (gjson.Result, error)

NeteaseMusicSongInfo 通过给定id在wdd音乐上查找曲目信息

func NewBuffer

func NewBuffer() *bytes.Buffer

NewBuffer 从池中获取新 bytes.Buffer

func NewGzipReadCloser

func NewGzipReadCloser(reader io.ReadCloser) (io.ReadCloser, error)

NewGzipReadCloser 从 io.ReadCloser 创建 gunzip io.ReadCloser

func PathExists

func PathExists(path string) bool

PathExists 判断给定path是否存在

func PutBuffer

func PutBuffer(buf *bytes.Buffer)

PutBuffer 将 Buffer放入池中

func QQMusicSongInfo

func QQMusicSongInfo(id string) (gjson.Result, error)

QQMusicSongInfo 通过给定id在QQ音乐上查找曲目信息

func ReadAddrFile

func ReadAddrFile(path string) []netip.AddrPort

ReadAddrFile 从给定path中读取合法的IP地址与端口,每个IP地址以换行符"\n"作为分隔

func ReadAllText

func ReadAllText(path string) string

ReadAllText 读取给定path对应文件，无法读取时返回空值

func SetupMainSignalHandler

func SetupMainSignalHandler() <-chan struct{}

SetupMainSignalHandler is for main to use at last

func VersionNameCompare

func VersionNameCompare(current, remote string) bool

VersionNameCompare 检查版本名是否需要更新, 仅适用于 go-cqhttp 的版本命名规则

例: v0.9.29-fix2 == v0.9.29-fix2 -> false

v0.9.29-fix1 < v0.9.29-fix2 -> true

v0.9.29-fix2 > v0.9.29-fix1 -> false

v0.9.29-fix2 < v0.9.30 -> true

v1.0.0-alpha2 < v1.0.0-beta1 -> true

v1.0.0 > v1.0.0-beta1 -> false

func WriteAllText

func WriteAllText(path, text string) error

WriteAllText 将给定text写入给定path

Types

type LocalHook

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

LocalHook logrus本地钩子

func NewLocalHook

func NewLocalHook(args interface{}, consoleFormatter, fileFormatter logrus.Formatter, levels ...logrus.Level) *LocalHook

NewLocalHook 初始化本地日志钩子实现

func (*LocalHook) Fire

func (hook *LocalHook) Fire(entry *logrus.Entry) error

Fire ref: logrus/hooks.go impl Hook interface

func (*LocalHook) Levels

func (hook *LocalHook) Levels() []logrus.Level

Levels ref: logrus/hooks.go impl Hook interface

func (*LocalHook) SetFormatter

func (hook *LocalHook) SetFormatter(consoleFormatter, fileFormatter logrus.Formatter)

SetFormatter 设置日志格式

func (*LocalHook) SetPath

func (hook *LocalHook) SetPath(path string)

SetPath 设置日志写入路径

func (*LocalHook) SetWriter

func (hook *LocalHook) SetWriter(writer io.Writer)

SetWriter 设置Writer

type LogFormat

type LogFormat struct {
	EnableColor bool
}

LogFormat specialize for go-cqhttp

func (LogFormat) Format

func (f LogFormat) Format(entry *logrus.Entry) ([]byte, error)

Format implements logrus.Formatter

type MSG

type MSG map[string]interface{}

MSG 消息Map