robot

type Config struct {
	BotWxId        string        // 机器人微信ID
	BotNickname    string        // 机器人名称
	SuperUsers     []string      // 超级用户(管理员)
	CommandPrefix  string        // 管理员触发命令
	BufferLen      uint          // 事件缓冲区长度, 默认4096
	Latency        time.Duration // 事件处理延迟 (延迟 latency + (0~100ms) 再处理事件) (默认1s)
	MaxProcessTime time.Duration // 事件最大处理时间 (默认3min)
	Framework      IFramework    // 接入框架需实现该接口
}

type Ctx struct {
	Event *Event
	State State
	// contains filtered or unexported fields
}

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

type Event struct {
	Type                string               // 消息类型
	RobotWxId           string               // 机器人微信id
	IsAtMe              bool                 // 机器人是否被@了，@所有人不算
	FromUniqueID        string               // 消息来源唯一id, 私聊为发送者微信id, 群聊为群id
	FromWxId            string               // 消息来源微信id
	FromName            string               // 消息来源昵称
	FromGroup           string               // 消息来源群id
	FromGroupName       string               // 消息来源群名称
	RawMessage          string               // 原始消息
	Message             *Message             // 消息内容
	SubscriptionMessage *Message             // 订阅号消息
	FriendVerify        *FriendVerify        // 好友验证消息
	Transfer            *Transfer            // 转账消息
	Withdraw            *Withdraw            // 撤回消息
	GroupMemberIncrease *GroupMemberIncrease // 群成员增加消息
	GroupMemberDecrease *GroupMemberDecrease // 群成员减少消息
}

type EventBuffer struct {
	sync.Mutex
	// contains filtered or unexported fields
}

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

type EventChannel struct {
	Type     string
	Priority uint64
	Rule     []Rule
	Block    bool
}

type FriendInfo struct {
	WxId                    string `json:"wxId"`                    // 微信ID
	WxNum                   string `json:"wxNum"`                   // 微信号
	Nick                    string `json:"nick"`                    // 昵称
	Remark                  string `json:"remark"`                  // 备注
	NickBrief               string `json:"nickBrief"`               // 昵称简拼
	NickWhole               string `json:"nickWhole"`               // 昵称全拼
	RemarkBrief             string `json:"remarkBrief"`             // 备注简拼
	RemarkWhole             string `json:"remarkWhole"`             // 备注全拼
	EnBrief                 string `json:"enBrief"`                 // 英文简拼
	EnWhole                 string `json:"enWhole"`                 // 英文全拼
	V3                      string `json:"v3"`                      // v3数据，同意好友验证时需要
	Sign                    string `json:"sign"`                    // 签名，需要在会话列表中
	Country                 string `json:"country"`                 // 国家，需要在会话列表中
	Province                string `json:"province"`                // 省份，需要在会话列表中
	City                    string `json:"city"`                    // 城市，需要在会话列表中
	MomentsBackgroundImgUrl string `json:"momentsBackgroundImgUrl"` // 朋友圈背景图，需要在朋友圈中
	AvatarMinUrl            string `json:"avatarMinUrl"`            // 头像小图，需要在会话列表中
	AvatarMaxUrl            string `json:"avatarMaxUrl"`            // 头像大图，需要在会话列表中
	Sex                     string `json:"sex"`                     // 性别，1男，2女，0未知
	MemberNum               int    `json:"memberNum"`               // 群成员数量，仅当对象是群聊时有效
}

type FriendVerify struct {
	WxId      string // 发送者微信id
	Nick      string // 发送者昵称
	V1        string // 验证V1
	V2        string // 验证V2
	V3        string // 验证V3
	V4        string // 验证V4
	AvatarUrl string // 头像url
	Content   string // 验证内容
	Scene     string // 验证场景
}

type GroupInfo struct {
	WxId         string `json:"wxId"`         // 微信ID
	WxNum        string `json:"wxNum"`        // 微信号
	Nick         string `json:"nick"`         // 昵称
	Remark       string `json:"remark"`       // 备注
	NickBrief    string `json:"nickBrief"`    // 昵称简拼
	NickWhole    string `json:"nickWhole"`    // 昵称全拼
	RemarkBrief  string `json:"remarkBrief"`  // 备注简拼
	RemarkWhole  string `json:"remarkWhole"`  // 备注全拼
	EnBrief      string `json:"enBrief"`      // 英文简拼
	EnWhole      string `json:"enWhole"`      // 英文全拼
	MemberNum    int    `json:"memberNum"`    // 群成员数量，仅当对象是群聊时有效
	AvatarMinUrl string `json:"avatarMinUrl"` // 头像小图，需要在会话列表中
	AvatarMaxUrl string `json:"avatarMaxUrl"` // 头像大图，需要在会话列表中
}

type GroupMemberDecrease struct {
}

type GroupMemberIncrease struct {
}

type GroupMemberInfo struct {
	WxId         string `json:"wxId"`         // 微信ID
	WxNum        string `json:"wxNum"`        // 微信号
	Nick         string `json:"nick"`         // 昵称
	Remark       string `json:"remark"`       // 备注
	Country      string `json:"country"`      // 国家，需要在会话列表中
	Province     string `json:"province"`     // 省份，需要在会话列表中
	City         string `json:"city"`         // 城市，需要在会话列表中
	AvatarMinUrl string `json:"avatarMinUrl"` // 头像小图，需要在会话列表中
	AvatarMaxUrl string `json:"avatarMaxUrl"` // 头像大图，需要在会话列表中
	Sex          string `json:"sex"`          // 性别，1男，2女，0未知
}

type Handler func(ctx *Ctx) // 事件处理

type IFramework interface {
	// Callback 这是消息回调方法，vx框架回调消息转发给该Server
	Callback(func(*Event, IFramework))

	// GetMemePictures 获取表情包图片地址(迷因图)
	// return: 图片链接(网络URL或图片base64)
	GetMemePictures(message *Message) string

	// SendText 发送文本消息
	// toWxId: 好友ID/群ID
	// text: 文本内容
	SendText(toWxId, text string) error

	// SendTextAndAt 发送文本消息并@，只有群聊有效
	// toGroupWxId: 群ID
	// toWxId: 好友ID/群ID/all
	// toWxName: 好友昵称/群昵称，留空为自动获取
	// text: 文本内容
	SendTextAndAt(toGroupWxId, toWxId, toWxName, text string) error

	// SendImage 发送图片消息
	// toWxId: 好友ID/群ID
	// path: 图片路径
	SendImage(toWxId, path string) error

	// SendShareLink 发送分享链接消息
	// toWxId: 好友ID/群ID
	// title: 标题
	// desc: 描述
	// imageUrl: 图片链接
	// jumpUrl: 跳转链接
	SendShareLink(toWxId, title, desc, imageUrl, jumpUrl string) error

	// SendFile 发送文件消息
	// toWxId: 好友ID/群ID/公众号ID
	// path: 本地文件绝对路径
	SendFile(toWxId, path string) error

	// SendVideo 发送视频消息
	// toWxId: 好友ID/群ID/公众号ID
	// path: 本地视频文件绝对路径
	SendVideo(toWxId, path string) error

	// SendEmoji 发送表情消息
	// toWxId: 好友ID/群ID/公众号ID
	// path: 本地动态表情文件绝对路径
	SendEmoji(toWxId, path string) error

	// SendMusic 发送音乐消息
	// toWxId: 好友ID/群ID/公众号ID
	// name: 音乐名称
	// author: 音乐作者
	// app: 音乐来源(VLW需留空)，酷狗/wx79f2c4418704b4f8，网易云/wx8dd6ecd81906fd84，QQ音乐/wx5aa333606550dfd5
	// jumpUrl: 音乐跳转链接
	// musicUrl: 网络歌曲直链
	// coverUrl: 封面图片链接
	SendMusic(toWxId, name, author, app, jumpUrl, musicUrl, coverUrl string) error

	// SendMiniProgram 发送小程序消息
	// toWxId: 好友ID/群ID/公众号ID
	// ghId: 小程序ID
	// title: 标题
	// content: 内容
	// imagePath: 图片路径, 本地图片路径或网络图片URL
	// jumpPath: 小程序点击跳转地址，例如：pages/index/index.html
	SendMiniProgram(toWxId, ghId, title, content, imagePath, jumpPath string) error

	// SendMessageRecord 发送消息记录
	// toWxId: 好友ID/群ID/公众号ID
	// title: 仅供电脑上显示用，手机上的话微信会根据[显示昵称]来自动生成 谁和谁的聊天记录
	// dataList:
	// 	- wxid: 发送此条消息的人的wxid
	// 	- nickName: 显示的昵称(可随意伪造)
	// 	- timestamp: 10位时间戳
	// 	- msg: 消息内容
	SendMessageRecord(toWxId, title string, dataList []map[string]interface{}) error

	// SendMessageRecordXML 发送消息记录(XML方式)
	// toWxId: 好友ID/群ID/公众号ID
	// xmlStr: 消息记录XML代码
	SendMessageRecordXML(toWxId, xmlStr string) error

	// SendFavorites 发送收藏消息
	// toWxId: 好友ID/群ID/公众号ID
	// favoritesId: 收藏夹ID
	SendFavorites(toWxId, favoritesId string) error

	// SendXML 发送XML消息
	// toWxId: 好友ID/群ID/公众号ID
	// xmlStr: XML代码
	SendXML(toWxId, xmlStr string) error

	// SendBusinessCard 发送名片消息
	// toWxId: 好友ID/群ID/公众号ID
	// targetWxId: 目标用户ID
	SendBusinessCard(toWxId, targetWxId string) error

	// AgreeFriendVerify 同意好友验证
	// v3: 验证V3
	// v4: 验证V4
	// scene: 验证场景
	AgreeFriendVerify(v3, v4, scene string) error

	// InviteIntoGroup 邀请好友加入群组
	// groupWxId: 群ID
	// wxId: 好友ID
	// typ: 邀请类型，1-直接拉，2-发送邀请链接
	InviteIntoGroup(groupWxId, wxId string, typ int) error

	// GetObjectInfo 获取对象信息
	// wxId: 好友ID/群ID/公众号ID
	// return: ObjectInfo, error
	GetObjectInfo(wxId string) (*ObjectInfo, error)

	// GetFriendsList 获取好友列表
	// isRefresh: 是否刷新 false-从缓存中获取，true-重新遍历二叉树并刷新缓存
	// return: []*FriendInfo, error
	GetFriendsList(isRefresh bool) ([]*FriendInfo, error)

	// GetGroupList 获取群组列表
	// isRefresh: 是否刷新 false-从缓存中获取，true-重新遍历二叉树并刷新缓存
	// return: []*GroupInfo, error
	GetGroupList(isRefresh bool) ([]*GroupInfo, error)

	// GetGroupMemberList 获取群成员列表
	// groupWxId: 群ID
	// isRefresh: 是否刷新 false-从缓存中获取，true-重新遍历二叉树并刷新缓存
	// return: []*GroupMemberInfo, error
	GetGroupMemberList(groupWxId string, isRefresh bool) ([]*GroupMemberInfo, error)

	// GetSubscriptionList 获取订阅列表
	// isRefresh: 是否刷新 false-从缓存中获取，true-重新遍历二叉树并刷新缓存
	// return: []*SubscriptionInfo, error
	GetSubscriptionList(isRefresh bool) ([]*SubscriptionInfo, error)
}

type Matcher struct {
	// Temp 是否为临时Matcher，临时 Matcher 匹配一次后就会删除当前 Matcher
	Temp bool

	// Block 是否阻断后续 Matcher，为true时当前Matcher匹配成功后，后续Matcher不参与匹配
	Block bool

	// Break 是否退出后续匹配流程, 只有 Rule 返回false且此值为真才会退出, 且不对 mid handler以下的 Rule 生效
	Break bool

	// NoTimeout 处理是否不设超时
	NoTimeout bool

	// Priority 优先级，越小优先级越高
	Priority uint64

	// Rules 匹配规则
	Rules []Rule

	// Handler 处理事件的函数
	Handler Handler

	// Engine 注册 Matcher 的 Engine，Engine可为一系列 Matcher 添加通用 Rule 和其他钩子
	Engine *Engine
}

type Message struct {
	Id      string // 消息id
	Type    int64  // 消息类型
	Content string // 消息内容
}

type ObjectInfo struct {
	WxId                    string `json:"wxId"`                    // 微信ID
	WxNum                   string `json:"wxNum"`                   // 微信号
	Nick                    string `json:"nick"`                    // 昵称
	Remark                  string `json:"remark"`                  // 备注
	NickBrief               string `json:"nickBrief"`               // 昵称简拼
	NickWhole               string `json:"nickWhole"`               // 昵称全拼
	RemarkBrief             string `json:"remarkBrief"`             // 备注简拼
	RemarkWhole             string `json:"remarkWhole"`             // 备注全拼
	EnBrief                 string `json:"enBrief"`                 // 英文简拼
	EnWhole                 string `json:"enWhole"`                 // 英文全拼
	V3                      string `json:"v3"`                      // v3数据，同意好友验证时需要
	V4                      string `json:"v4"`                      // v4数据，同意好友验证时需要
	Sign                    string `json:"sign"`                    // 签名，需要在会话列表中
	Country                 string `json:"country"`                 // 国家，需要在会话列表中
	Province                string `json:"province"`                // 省份，需要在会话列表中
	City                    string `json:"city"`                    // 城市，需要在会话列表中
	MomentsBackgroundImgUrl string `json:"momentsBackgroundImgUrl"` // 朋友圈背景图，需要在朋友圈中
	AvatarMinUrl            string `json:"avatarMinUrl"`            // 头像小图，需要在会话列表中
	AvatarMaxUrl            string `json:"avatarMaxUrl"`            // 头像大图，需要在会话列表中
	Sex                     string `json:"sex"`                     // 性别，1男，2女，0未知
	MemberNum               int    `json:"memberNum"`               // 群成员数量，仅当对象是群聊时有效
}

type Robot struct {
	BotConfig        *Config
	Framework        IFramework
	FriendsList      []*FriendInfo
	GroupList        []*GroupInfo
	SubscriptionList []*SubscriptionInfo
}

type Rule func(ctx *Ctx) bool // 用于过滤事件

type State map[string]interface{}

type SubscriptionInfo struct {
	WxId                    string `json:"wxId"`                    // 微信ID
	WxNum                   string `json:"wxNum"`                   // 微信号
	Nick                    string `json:"nick"`                    // 昵称
	Remark                  string `json:"remark"`                  // 备注
	NickBrief               string `json:"nickBrief"`               // 昵称简拼
	NickWhole               string `json:"nickWhole"`               // 昵称全拼
	RemarkBrief             string `json:"remarkBrief"`             // 备注简拼
	RemarkWhole             string `json:"remarkWhole"`             // 备注全拼
	EnBrief                 string `json:"enBrief"`                 // 英文简拼
	EnWhole                 string `json:"enWhole"`                 // 英文全拼
	V3                      string `json:"v3"`                      // v3数据，同意好友验证时需要
	Sign                    string `json:"sign"`                    // 签名，需要在会话列表中
	Country                 string `json:"country"`                 // 国家，需要在会话列表中
	Province                string `json:"province"`                // 省份，需要在会话列表中
	City                    string `json:"city"`                    // 城市，需要在会话列表中
	MomentsBackgroundImgUrl string `json:"momentsBackgroundImgUrl"` // 朋友圈背景图，需要在朋友圈中
	AvatarMinUrl            string `json:"avatarMinUrl"`            // 头像小图，需要在会话列表中
	AvatarMaxUrl            string `json:"avatarMaxUrl"`            // 头像大图，需要在会话列表中
}

type Transfer struct {
	FromWxId     string // 发送者微信ID
	MsgSource    int64  // 消息来源 1:收到转账 2:对方接收转账 3:发出转账 4:自己接收转账 5:对方退还 6:自己退还
	TransferType int64  // 转账类型 1:即时到账 2:延时到账
	Money        string // 转账金额，单位元
	Memo         string // 转账备注
	TransferId   string // 转账ID
	TransferTime string // 转账时间，10位时间戳
}

type Withdraw struct {
	FromType  int64  // 消息来源 1:私聊 2:群聊
	FromGroup string // 消息来源群ID
	FromWxId  string // 消息来源微信ID
	MsgSource int64  // 消息来源 1:别人撤回 2:自己使用手机撤回 3:自己使用电脑撤回
	Msg       string // 消息内容
}