github/openwechat
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

add public method DumpHotReloadStorage

Browse Source
This commit is contained in:
eatMoreApple 2021-05-14 23:33:54 +08:00
parent f1327345ed
commit 6a9d276ea4
1 changed files with 236 additions and 228 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

464
bot.go
View File

@ -1,40 +1,40 @@
package openwechat package openwechat
import ( import (
"context" "context"
"errors" "errors"
"log" "log"
"net/url" "net/url"
) )
type Bot struct { type Bot struct {
ScanCallBack func(body []byte) // 扫码回调,可获取扫码用户的头像 ScanCallBack func(body []byte) // 扫码回调,可获取扫码用户的头像
LoginCallBack func(body []byte) // 登陆回调 LoginCallBack func(body []byte) // 登陆回调
LogoutCallBack func(bot *Bot) // 退出回调 LogoutCallBack func(bot *Bot) // 退出回调
UUIDCallback func(uuid string) // 获取UUID的回调函数 UUIDCallback func(uuid string) // 获取UUID的回调函数
MessageHandler MessageHandler // 获取消息成功的handle MessageHandler MessageHandler // 获取消息成功的handle
GetMessageErrorHandler func(err error) // 获取消息发生错误的handle GetMessageErrorHandler func(err error) // 获取消息发生错误的handle
isHot bool isHot bool
err error err error
context context.Context context context.Context
cancel context.CancelFunc cancel context.CancelFunc
Caller *Caller Caller *Caller
self *Self self *Self
storage *Storage storage *Storage
hotReloadStorage HotReloadStorage hotReloadStorage HotReloadStorage
} }
// 判断当前用户是否正常在线 // 判断当前用户是否正常在线
func (b *Bot) Alive() bool { func (b *Bot) Alive() bool {
if b.self == nil { if b.self == nil {
return false return false
} }
select { select {
case <-b.context.Done(): case <-b.context.Done():
return false return false
default: default:
return true return true
} }
} }
// 获取当前的用户 // 获取当前的用户
@ -44,10 +44,10 @@ func (b *Bot) Alive() bool {
// } // }
// fmt.Println(self.NickName) // fmt.Println(self.NickName)
func (b *Bot) GetCurrentUser() (*Self, error) { func (b *Bot) GetCurrentUser() (*Self, error) {
if b.self == nil { if b.self == nil {
return nil, errors.New("user not login") return nil, errors.New("user not login")
} }
return b.self, nil return b.self, nil
} }
// 热登录,可实现重复登录, // 热登录,可实现重复登录,
@ -56,278 +56,286 @@ func (b *Bot) GetCurrentUser() (*Self, error) {
// err := bot.HotLogin(storage, true) // err := bot.HotLogin(storage, true)
// fmt.Println(err) // fmt.Println(err)
func (b *Bot) HotLogin(storage HotReloadStorage, retry ...bool) error { func (b *Bot) HotLogin(storage HotReloadStorage, retry ...bool) error {
b.isHot = true b.isHot = true
b.hotReloadStorage = storage b.hotReloadStorage = storage
var err error var err error
// 如果load出错了,就执行正常登陆逻辑 // 如果load出错了,就执行正常登陆逻辑
// 第一次没有数据load都会出错的 // 第一次没有数据load都会出错的
if err = storage.Load(); err != nil { if err = storage.Load(); err != nil {
return b.Login() return b.Login()
} }
if err = b.hotLoginInit(); err != nil { if err = b.hotLoginInit(); err != nil {
return err return err
} }
// 如果webInit出错,则说明可能身份信息已经失效 // 如果webInit出错,则说明可能身份信息已经失效
// 如果retry为True的话,则进行正常登陆 // 如果retry为True的话,则进行正常登陆
if err = b.webInit(); err != nil { if err = b.webInit(); err != nil {
if len(retry) > 0 { if len(retry) > 0 {
if retry[0] { if retry[0] {
return b.Login() return b.Login()
} }
} }
} }
return err return err
} }
// 热登陆初始化 // 热登陆初始化
func (b *Bot) hotLoginInit() error { func (b *Bot) hotLoginInit() error {
item := b.hotReloadStorage.GetHotReloadStorageItem() item := b.hotReloadStorage.GetHotReloadStorageItem()
cookies := item.Cookies cookies := item.Cookies
for u, ck := range cookies { for u, ck := range cookies {
path, err := url.Parse(u) path, err := url.Parse(u)
if err != nil { if err != nil {
return err return err
} }
b.Caller.Client.Jar.SetCookies(path, ck) b.Caller.Client.Jar.SetCookies(path, ck)
} }
b.storage.LoginInfo = item.LoginInfo b.storage.LoginInfo = item.LoginInfo
b.storage.Request = item.BaseRequest b.storage.Request = item.BaseRequest
b.Caller.Client.domain = item.WechatDomain b.Caller.Client.domain = item.WechatDomain
return nil return nil
} }
// 用户登录 // 用户登录
// 该方法会一直阻塞，直到用户扫码登录，或者二维码过期 // 该方法会一直阻塞，直到用户扫码登录，或者二维码过期
func (b *Bot) Login() error { func (b *Bot) Login() error {
uuid, err := b.Caller.GetLoginUUID() uuid, err := b.Caller.GetLoginUUID()
if err != nil { if err != nil {
return err return err
} }
// 二维码获取回调 // 二维码获取回调
if b.UUIDCallback != nil { if b.UUIDCallback != nil {
b.UUIDCallback(uuid) b.UUIDCallback(uuid)
} }
for { for {
// 长轮询检查是否扫码登录 // 长轮询检查是否扫码登录
resp, err := b.Caller.CheckLogin(uuid) resp, err := b.Caller.CheckLogin(uuid)
if err != nil { if err != nil {
return err return err
} }
switch resp.Code { switch resp.Code {
case statusSuccess: case statusSuccess:
// 判断是否有登录回调，如果有执行它 // 判断是否有登录回调，如果有执行它
if b.LoginCallBack != nil { if b.LoginCallBack != nil {
b.LoginCallBack(resp.Raw) b.LoginCallBack(resp.Raw)
} }
return b.handleLogin(resp.Raw) return b.handleLogin(resp.Raw)
case statusScanned: case statusScanned:
// 执行扫码回调 // 执行扫码回调
if b.ScanCallBack != nil { if b.ScanCallBack != nil {
b.ScanCallBack(resp.Raw) b.ScanCallBack(resp.Raw)
} }
case statusTimeout: case statusTimeout:
return errors.New("login time out") return errors.New("login time out")
case statusWait: case statusWait:
continue continue
} }
} }
} }
// 用户退出 // 用户退出
func (b *Bot) Logout() error { func (b *Bot) Logout() error {
if b.Alive() { if b.Alive() {
if b.LogoutCallBack != nil { if b.LogoutCallBack != nil {
b.LogoutCallBack(b) b.LogoutCallBack(b)
} }
info := b.storage.LoginInfo info := b.storage.LoginInfo
if err := b.Caller.Logout(info); err != nil { if err := b.Caller.Logout(info); err != nil {
return err return err
} }
b.stopAsyncCALL(errors.New("logout")) b.stopAsyncCALL(errors.New("logout"))
return nil return nil
} }
return errors.New("user not login") return errors.New("user not login")
} }
// 登录逻辑 // 登录逻辑
func (b *Bot) handleLogin(data []byte) error { func (b *Bot) handleLogin(data []byte) error {
// 获取登录的一些基本的信息 // 获取登录的一些基本的信息
info, err := b.Caller.GetLoginInfo(data) info, err := b.Caller.GetLoginInfo(data)
if err != nil { if err != nil {
return err return err
} }
// 将LoginInfo存到storage里面 // 将LoginInfo存到storage里面
b.storage.LoginInfo = info b.storage.LoginInfo = info
// 构建BaseRequest // 构建BaseRequest
request := &BaseRequest{ request := &BaseRequest{
Uin: info.WxUin, Uin: info.WxUin,
Sid: info.WxSid, Sid: info.WxSid,
Skey: info.SKey, Skey: info.SKey,
DeviceID: GetRandomDeviceId(), DeviceID: GetRandomDeviceId(),
} }
// 将BaseRequest存到storage里面方便后续调用 // 将BaseRequest存到storage里面方便后续调用
b.storage.Request = request b.storage.Request = request
// 如果是热登陆,则将当前的重要信息写入hotReloadStorage // 如果是热登陆,则将当前的重要信息写入hotReloadStorage
if b.isHot { if b.isHot {
cookies := b.Caller.Client.GetCookieMap() if err := b.DumpHotReloadStorage(); err != nil {
item := HotReloadStorageItem{ return err
BaseRequest: request, }
Cookies: cookies, }
LoginInfo: info,
WechatDomain: b.Caller.Client.domain,
}
if err := b.hotReloadStorage.Dump(item); err != nil {
return err
}
}
return b.webInit() return b.webInit()
} }
// 根据有效凭证获取和初始化用户信息 // 根据有效凭证获取和初始化用户信息
func (b *Bot) webInit() error { func (b *Bot) webInit() error {
req := b.storage.Request req := b.storage.Request
info := b.storage.LoginInfo info := b.storage.LoginInfo
// 获取初始化的用户信息和一些必要的参数 // 获取初始化的用户信息和一些必要的参数
resp, err := b.Caller.WebInit(req) resp, err := b.Caller.WebInit(req)
if err != nil { if err != nil {
return err return err
} }
// 设置当前的用户 // 设置当前的用户
b.self = &Self{Bot: b, User: &resp.User} b.self = &Self{Bot: b, User: &resp.User}
b.self.Self = b.self b.self.Self = b.self
b.storage.Response = resp b.storage.Response = resp
// 通知手机客户端已经登录 // 通知手机客户端已经登录
if err = b.Caller.WebWxStatusNotify(req, resp, info); err != nil { if err = b.Caller.WebWxStatusNotify(req, resp, info); err != nil {
return err return err
} }
// 开启协程，轮训获取是否有新的消息返回 // 开启协程，轮训获取是否有新的消息返回
go func() { go func() {
if b.GetMessageErrorHandler == nil { if b.GetMessageErrorHandler == nil {
b.GetMessageErrorHandler = b.stopAsyncCALL b.GetMessageErrorHandler = b.stopAsyncCALL
} }
if err := b.asyncCall(); err != nil { if err := b.asyncCall(); err != nil {
b.GetMessageErrorHandler(err) b.GetMessageErrorHandler(err)
} }
}() }()
return nil return nil
} }
// 轮训请求 // 轮训请求
// 根据状态码判断是否有新的请求 // 根据状态码判断是否有新的请求
func (b *Bot) asyncCall() error { func (b *Bot) asyncCall() error {
var ( var (
err error err error
resp *SyncCheckResponse resp *SyncCheckResponse
) )
for b.Alive() { for b.Alive() {
// 长轮训检查是否有消息返回 // 长轮训检查是否有消息返回
resp, err = b.Caller.SyncCheck(b.storage.LoginInfo, b.storage.Response) resp, err = b.Caller.SyncCheck(b.storage.LoginInfo, b.storage.Response)
if err != nil { if err != nil {
return err return err
} }
// 如果不是正常的状态码返回，发生了错误，直接退出 // 如果不是正常的状态码返回，发生了错误，直接退出
if !resp.Success() { if !resp.Success() {
return resp return resp
} }
// 如果Selector不为0，则获取消息 // 如果Selector不为0，则获取消息
if !resp.NorMal() { if !resp.NorMal() {
if err = b.getNewWechatMessage(); err != nil { if err = b.getNewWechatMessage(); err != nil {
return err return err
} }
} }
} }
return err return err
} }
// 当获取消息发生错误时, 默认的错误处理行为 // 当获取消息发生错误时, 默认的错误处理行为
func (b *Bot) stopAsyncCALL(err error) { func (b *Bot) stopAsyncCALL(err error) {
b.cancel() b.cancel()
b.err = err b.err = err
b.self = nil b.self = nil
log.Printf("exit with : %s", err.Error()) log.Printf("exit with : %s", err.Error())
} }
// 获取新的消息 // 获取新的消息
func (b *Bot) getNewWechatMessage() error { func (b *Bot) getNewWechatMessage() error {
resp, err := b.Caller.WebWxSync(b.storage.Request, b.storage.Response, b.storage.LoginInfo) resp, err := b.Caller.WebWxSync(b.storage.Request, b.storage.Response, b.storage.LoginInfo)
if err != nil { if err != nil {
return err return err
} }
// 更新SyncKey并且重新存入storage // 更新SyncKey并且重新存入storage
b.storage.Response.SyncKey = resp.SyncKey b.storage.Response.SyncKey = resp.SyncKey
// 遍历所有的新的消息，依次处理 // 遍历所有的新的消息，依次处理
for _, message := range resp.AddMsgList { for _, message := range resp.AddMsgList {
// 根据不同的消息类型来进行处理，方便后续统一调用 // 根据不同的消息类型来进行处理，方便后续统一调用
message.init(b) message.init(b)
// 调用自定义的处理方法 // 调用自定义的处理方法
if handler := b.MessageHandler; handler != nil { if handler := b.MessageHandler; handler != nil {
handler(message) handler(message)
} }
} }
return nil return nil
} }
// 当消息同步发生了错误或者用户主动在手机上退出，该方法会立即返回，否则会一直阻塞 // 当消息同步发生了错误或者用户主动在手机上退出，该方法会立即返回，否则会一直阻塞
func (b *Bot) Block() error { func (b *Bot) Block() error {
if b.self == nil { if b.self == nil {
return errors.New("`Block` must be called after user login") return errors.New("`Block` must be called after user login")
} }
<-b.context.Done() <-b.context.Done()
return nil return nil
} }
// 获取当前Bot崩溃的原因 // 获取当前Bot崩溃的原因
func (b *Bot) CrashReason() error { func (b *Bot) CrashReason() error {
return b.err return b.err
} }
// setter for Bot.MessageHandler // setter for Bot.MessageHandler
func (b *Bot) MessageOnSuccess(h func(msg *Message)) { func (b *Bot) MessageOnSuccess(h func(msg *Message)) {
b.MessageHandler = h b.MessageHandler = h
} }
// setter for Bot.GetMessageErrorHandler // setter for Bot.GetMessageErrorHandler
func (b *Bot) MessageOnError(h func(err error)) { func (b *Bot) MessageOnError(h func(err error)) {
b.GetMessageErrorHandler = h b.GetMessageErrorHandler = h
}
// 写入HotReloadStorage
func (b *Bot) DumpHotReloadStorage() error {
if b.hotReloadStorage == nil {
return errors.New("hotReloadStorage can be nil")
}
cookies := b.Caller.Client.GetCookieMap()
item := HotReloadStorageItem{
BaseRequest: b.storage.Request,
Cookies: cookies,
LoginInfo: b.storage.LoginInfo,
WechatDomain: b.Caller.Client.domain,
}
return b.hotReloadStorage.Dump(item)
} }
// Bot的构造方法，需要自己传入Caller // Bot的构造方法，需要自己传入Caller
func NewBot(caller *Caller) *Bot { func NewBot(caller *Caller) *Bot {
ctx, cancel := context.WithCancel(context.Background()) ctx, cancel := context.WithCancel(context.Background())
return &Bot{Caller: caller, storage: &Storage{}, context: ctx, cancel: cancel} return &Bot{Caller: caller, storage: &Storage{}, context: ctx, cancel: cancel}
} }
// 默认的Bot的构造方法, // 默认的Bot的构造方法,
// mode不传入默认为openwechat.Normal,详情见mode // mode不传入默认为openwechat.Normal,详情见mode
// bot := openwechat.DefaultBot(openwechat.Desktop) // bot := openwechat.DefaultBot(openwechat.Desktop)
func DefaultBot(modes ...mode) *Bot { func DefaultBot(modes ...mode) *Bot {
var m mode var m mode
if len(modes) == 0 { if len(modes) == 0 {
m = Normal m = Normal
} else { } else {
m = modes[0] m = modes[0]
} }
caller := DefaultCaller() caller := DefaultCaller()
caller.Client.mode = m caller.Client.mode = m
return NewBot(caller) return NewBot(caller)
} }
// 通过uuid获取登录二维码的url // 通过uuid获取登录二维码的url
func GetQrcodeUrl(uuid string) string { func GetQrcodeUrl(uuid string) string {
return qrcode + uuid return qrcode + uuid
} }
// 打印登录二维码 // 打印登录二维码
func PrintlnQrcodeUrl(uuid string) { func PrintlnQrcodeUrl(uuid string) {
println("访问下面网址扫描二维码登录") println("访问下面网址扫描二维码登录")
println(GetQrcodeUrl(uuid)) println(GetQrcodeUrl(uuid))
} }