feat: 增加插件插ID；增加模糊查找用户 (#18)

Author: yqchilde

engine/plugins/plugins.go

@@ -390,3 +390,14 @@ func (ctx *Ctx) GetMPs(isRefresh ...bool) (MPs, error) {
 	defer ctx.mutex.Unlock()
 	return ctx.Bot.self.MPs(isRefresh...)
 }
+
+// FuzzyGetByRemarkOrNick 模糊查询好友、群组、公众号
+func (ctx *Ctx) FuzzyGetByRemarkOrNick(remarkOrNick string) []*User {
+	ctx.mutex.Lock()
+	defer ctx.mutex.Unlock()
+	var users []*User
+	friends := ctx.Bot.self.friends.FuzzyGetByRemarkOrNick(remarkOrNick).AsUsers()
+	groups := ctx.Bot.self.groups.FuzzyGetByRemarkOrNick(remarkOrNick).AsUsers()
+	mps := ctx.Bot.self.mps.FuzzyGetByRemarkOrNick(remarkOrNick).AsUsers()
+	return append(append(append(users, friends...), groups...), mps...)
+}

engine/robot/api.go

@@ -1,6 +1,9 @@
 package robot
 
-import "time"
+import (
+	"strings"
+	"time"
+)
 
 // Friend 好友对象
 type Friend struct{ *User }
@@ -83,6 +86,15 @@ func (f Friends) Count() int {
 	return len(f)
 }
 
+// AsUsers 将好友列表转换为User列表
+func (f Friends) AsUsers() []*User {
+	var users []*User
+	for _, friend := range f {
+		users = append(users, friend.User)
+	}
+	return users
+}
+
 // GetByWxId 根据微信ID获取好友
 func (f Friends) GetByWxId(wxId string) *Friend {
 	for _, friend := range f {
@@ -188,6 +200,17 @@ func (f Friends) GetByRemarkOrNicks(remarkOrNicks []string) Friends {
 	return result
 }
 
+// FuzzyGetByRemarkOrNick 根据备注或昵称模糊匹配好友列表
+func (f Friends) FuzzyGetByRemarkOrNick(remarkOrNick string) Friends {
+	var result Friends
+	for _, friend := range f {
+		if strings.Contains(friend.Remark, remarkOrNick) || strings.Contains(friend.Nick, remarkOrNick) {
+			result = append(result, friend)
+		}
+	}
+	return result
+}
+
 // SendText 依次发送文本消息, delays为每个好友发送消息的间隔时间, 默认为1秒, 为0时不间隔
 func (f Friends) SendText(content string, delays ...time.Duration) error {
 	for _, friend := range f {
@@ -464,6 +487,15 @@ func (g Groups) Count() int {
 	return len(g)
 }
 
+// AsUsers 将群组列表转换为User列表
+func (g Groups) AsUsers() []*User {
+	users := make([]*User, len(g))
+	for i, group := range g {
+		users[i] = group.AsUser()
+	}
+	return users
+}
+
 // GetByWxId 根据微信ID获取群组
 func (g Groups) GetByWxId(wxId string) *Group {
 	for _, group := range g {
@@ -569,6 +601,17 @@ func (g Groups) GetByRemarkOrNicks(remarkOrNicks []string) Groups {
 	return result
 }
 
+// FuzzyGetByRemarkOrNick 根据备注或昵称模糊匹配好友列表
+func (g Groups) FuzzyGetByRemarkOrNick(remarkOrNick string) Groups {
+	var result Groups
+	for _, group := range g {
+		if strings.Contains(group.Remark, remarkOrNick) || strings.Contains(group.Nick, remarkOrNick) {
+			result = append(result, group)
+		}
+	}
+	return result
+}
+
 // SendText 依次发送文本消息, delays为每个好友发送消息的间隔时间, 默认为1秒, 为0时不间隔
 func (g Groups) SendText(content string, delays ...time.Duration) error {
 	for _, group := range g {
@@ -854,6 +897,15 @@ func (m MPs) Count() int {
 	return len(m)
 }
 
+// AsUsers 将当前对象转换为User对象
+func (m MPs) AsUsers() []*User {
+	var users []*User
+	for _, mp := range m {
+		users = append(users, mp.AsUser())
+	}
+	return users
+}
+
 // GetByWxId 根据微信ID获取公众号
 func (m MPs) GetByWxId(wxId string) *MP {
 	for _, mp := range m {
@@ -959,6 +1011,17 @@ func (m MPs) GetByRemarkOrNicks(remarkOrNicks []string) MPs {
 	return result
 }
 
+// FuzzyGetByRemarkOrNick 根据备注或昵称模糊匹配好友列表
+func (m MPs) FuzzyGetByRemarkOrNick(remarkOrNick string) MPs {
+	var result MPs
+	for _, mp := range m {
+		if strings.Contains(mp.Remark, remarkOrNick) || strings.Contains(mp.Nick, remarkOrNick) {
+			result = append(result, mp)
+		}
+	}
+	return result
+}
+
 // SendText 依次发送文本消息, delays为每个好友发送消息的间隔时间, 默认为1秒, 为0时不间隔
 func (m MPs) SendText(content string, delays ...time.Duration) error {
 	for _, mp := range m {

engine/robot/relation.go

@@ -9,4 +9,5 @@
 - "github.com/yqchilde/wxbot/plugins/plmm"         # 漂亮妹妹
 - "github.com/yqchilde/wxbot/plugins/weather"      # 天气查询
 - "github.com/yqchilde/wxbot/plugins/zaobao"       # 每日早报
-- "github.com/yqchilde/wxbot/plugins/wordcloud"    # 聊天热词
+- "github.com/yqchilde/wxbot/plugins/wordcloud"    # 聊天热词
+- "github.com/yqchilde/wxbot/plugins/chaid"        # 查wxId

plugins.yaml

@@ -0,0 +1,12 @@
+## 介绍
+
+**🔔 注意：以下`[]`符号内代表此处是需要填写内容，并且不需要`[]`符号**
+
+* 插件名：查好友微信ID，支持模糊匹配，
+* 权限：仅限配置的管理员使用，不区分私聊和群聊中使用
+* 指令：
+    * [x] `查id [昵称/备注]`，`id`不区分大小写
+
+## 预览：
+
+![img](preview.jpg)

plugins/chaid/README.md

@@ -0,0 +1,31 @@
+package chaid
+
+import (
+	"fmt"
+
+	"github.com/yqchilde/wxbot/engine/control"
+	"github.com/yqchilde/wxbot/engine/robot"
+)
+
+func init() {
+	engine := control.Register("chaid", &control.Options{
+		Alias: "查ID",
+		Help:  "模糊查用户ID\n用法：查ID [昵称/备注]",
+	})
+
+	// 查系统ID，只能由管理员使用
+	engine.OnRegex(`^查(?i:id) (.+)$`, robot.AdminPermission).SetBlock(true).Handle(func(ctx *robot.Ctx) {
+		id, reply := ctx.State["regex_matched"].([]string)[1], ""
+		findUsers := ctx.FuzzyGetByRemarkOrNick(id)
+		for _, user := range findUsers {
+			if user.IsFriend() {
+				reply += fmt.Sprintf("类别：%s\nID：%s\n昵称：%s\n\n", "好友", user.WxId, user.Nick)
+			} else if user.IsGroup() {
+				reply += fmt.Sprintf("类别：%s\nID：%s\n昵称：%s\n\n", "群组", user.WxId, user.Nick)
+			} else if user.IsMP() {
+				reply += fmt.Sprintf("类别：%s\nID：%s\n昵称：%s\n\n", "公众号", user.WxId, user.Nick)
+			}
+		}
+		ctx.ReplyTextAndAt(reply)
+	})
+}