Skip to content

Commit

Permalink
画更多的饼，准备继续完善消息元素
Browse files Browse the repository at this point in the history
  • Loading branch information
@kyokukong
kyokukong committed Sep 20, 2024
1 parent 3069afa commit a012a64
Show file tree
Hide file tree
Showing 4 changed files with 117 additions and 55 deletions.
27 changes: 19 additions & 8 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# 🧊Iceinu 氷犬

![Go Badge](https://img.shields.io/badge/Go-1.22%2B-cyan?logo=go)
![workflow](https://github.com/Iceinu-Project/iceinu/actions/workflows/go.yml/badge.svg)
![QQGroup Badge](https://img.shields.io/badge/QQ群-970801565-blue?)
[![workflow](https://github.com/Iceinu-Project/iceinu/actions/workflows/go.yml/badge.svg)](https://github.com/Iceinu-Project/iceinu/actions)
[![goreportcard](https://img.shields.io/badge/go%20report-A+-brightgreen.svg?style=flat)](https://goreportcard.com/report/github.com/Iceinu-Project/iceinu)
[![QQGroup Badge](https://img.shields.io/badge/QQ群-970801565-blue?)](https://qm.qq.com/q/93crfU39ny)

氷犬Iceinu 是一个多用途的Go语言聊天机器人框架(主要为NTQQ设计)，可以将其作为开发套件来进行二次开发，亦或者作为库按需引入来快速编写自己的聊天机器人（暂时没有实现）。
氷犬Iceinu 是一个多用途的Go语言聊天机器人框架，可以将其作为开发套件来进行二次开发，亦或者作为库按需引入来快速编写自己的聊天机器人（暂时没有实现）。

🚧暂时还在~~画饼~~施工中，晚点再来探索吧~

Expand All @@ -19,17 +20,27 @@
- [ ] 消息发送/统一Client设计
- [ ] 插件系统设计和实现
- [ ] 完善内置LagrangeGo适配器的事件接收和处理
- [ ] 集群模式设计和实现（集群的动态总控和静态总控模式）
- [ ] 集群模式设计和实现（集群的动态和静态总控模式）
- [ ] 排障和性能优化
- [ ] 自动化测试
- [ ] 确定各项基础程序设计，编写使用文档

## 特性

~~哪里是特性，完全是画饼，一半都还没实现完~~

- 基于Go开发,性能表现良好
- 基于事件驱动的消息推送机制
- 类Satori的事件和消息系统，可以直接构建Satori标准的XHTML作为消息内容
- 模块化设计，适配多平台，可自由开发插件
- 基于统一事件驱动的消息推送机制
- 以Satori作为基础实现了统一消息标准
- 可直接发送Satori标准的XHTML消息
- 模块化适配器设计
- 动态/静态集群，跨平台集群
- 完整的动态权限管理系统
- 在插件间共享数据库连接池
- 类Alconna的命令解析器
- 可配置自动向指定用户/频道发送日志
- 主动信息推送/订阅机制
- 从HTML+CSS模板渲染图片（基于wkhtmltoimage集成，未来可能会实现）

## 直接部署

Expand All @@ -40,7 +51,7 @@

你可以参照Iceinu数据库配置指南来配置Iceinu使用的PostgreSQL数据库。

Iceinu可以以分布式模式进行部署，通过在启动时附加`--node`参数即可启动Iceinu的子节点模式，在子节点的配置文件中设置主节点的ip即可进行连接。
Iceinu在设计上支持集群部署，且支持动态组网式集群（需要各个Bot实例之间可以相互访问）和静态总控式集群（需要一个Bot实例作为总控，这个实例本身不能下线）

## 二次开发

Expand Down
104 changes: 57 additions & 47 deletions adapter/bot.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,51 +8,57 @@ import (
// Bot Iceinu的客户端接口API，用于实现iceinu对平台客户端的直接操作
type Bot interface {
// 首先是基于Satori标准的API
// 这部分可以参考Satori文档的资源部分，但是有一定的不同
// 这部分可以参考Satori文档的资源部分，但是有一定的不同，为了方便兼容各种使用方式进行了一些扩展
// 比如没有直接支持分页这个东西，方便使用
// https://satori.js.org/zh-CN/resources/channel.html

GetChannel(channelId string) *resource.Channel
GetChannelList(groupId string) []*resource.Channel
CreateChannel(groupId string, data *resource.Channel) (*resource.Channel, error)
UpdateChannel(groupId string, data *resource.Channel) error
DeleteChannel(channelId string) error
MuteChannel(channelId string, duration uint32) error
CreateUserChannel(userId string, groupId string) (*resource.Channel, error)

GetGroup(groupId string) *resource.Group
GetGroupList() []*resource.Group
ApproveGroupInvite(messageId string, approve bool, comment string) error

GetGroupMember(groupId string, userId string) *resource.GroupMember
GetGroupMemberList(groupId string) []*resource.GroupMember
KickGroupMember(groupId string, userId string, permanent bool) error
MuteGroupMember(groupId string, userId string, duration uint32) error
ApproveGroupRequest(messageId string, approve bool, comment string) error

SetGroupMemberRole(groupId string, userId string, roleId string) error
UnsetGroupMemberRole(groupId string, userId string, roleId string) error
GetGroupRoleList(groupId string)
CreateGroupRole(groupId string, role *resource.GroupRole) (*resource.GroupRole, error)
UpdateGroupRole(groupId string, roleId string, role *resource.GroupRole) error
DeleteGroupRole(groupId string, roleId string) error

GetLoginInfo() *resource.Login

SendContent(channelId string, content string) (*resource.Message, error)
GetMessage(channelId string, messageId string) (*resource.Message, error)
RecallMessage(channelId string, messageId string) error
UpdateMessage(channelId string, messageId string, content string) error
GetMessageList(channelId string, limit uint32, order bool) []*resource.Message

CreateReaction(channelId string, messageId string, emoji string) error
DeleteReaction(channelId string, messageId string, emoji string, userId string) error
ClearReaction(channelId string, messageId string, emoji string)
GetReactionList(channelId string, messageId string, emoji string) []resource.User

GetUser(userId string) *resource.User
GetFriendList() []*resource.User
ApproveFriendRequest(messageId string, approve string, comment string) error
GetChannel(channelId string) *resource.Channel // 获取频道信息
GetChannelList(groupId string) []*resource.Channel // 获取指定群组中的频道列表
GetChannelListByToken(next string) *resource.PagedList // 获取指定群组中的频道列表(分页)
CreateChannel(groupId string, data *resource.Channel) (*resource.Channel, error) // 创建频道
UpdateChannel(groupId string, data *resource.Channel) error // 更新频道
DeleteChannel(channelId string) error // 删除频道
MuteChannel(channelId string, duration uint32) error // 禁言频道
CreateUserChannel(userId string, groupId string) (*resource.Channel, error) // 创建用户（私聊）频道

GetGroup(groupId string) *resource.Group // 获取群组信息
GetGroupList() []*resource.Group // 获取群组列表
GetGroupListByToken(next string) *resource.PagedList // 获取群组列表(分页)
ApproveGroupInvite(messageId string, approve bool, comment string) error // 处理群组邀请bot加入请求

GetGroupMember(groupId string, userId string) *resource.GroupMember // 获取指定群组成员信息
GetGroupMemberList(groupId string) []*resource.GroupMember // 获取群组成员列表
GetGroupMemberListByToken(groupId string, next string) *resource.PagedList // 获取群组成员列表(分页)
KickGroupMember(groupId string, userId string, permanent bool) error // 踢出群组成员
MuteGroupMember(groupId string, userId string, duration uint32) error // 禁言群组成员
ApproveGroupRequest(messageId string, approve bool, comment string) error // 处理群组加入请求

SetGroupMemberRole(groupId string, userId string, roleId string) error // 设置群组成员角色权限
UnsetGroupMemberRole(groupId string, userId string, roleId string) error // 取消群组成员角色权限
GetGroupRoleList(groupId string) []*resource.GroupRole // 获取群组角色权限列表
GetGroupRoleListByToken(groupId string, next string) *resource.PagedList // 获取群组角色权限列表(分页)
CreateGroupRole(groupId string, role *resource.GroupRole) (*resource.GroupRole, error) // 创建群组角色权限
UpdateGroupRole(groupId string, roleId string, role *resource.GroupRole) error // 更新群组角色权限
DeleteGroupRole(groupId string, roleId string) error // 删除群组角色权限

GetLoginInfo() *resource.Login // 获取登录信息

SendContent(channelId string, content string) (*resource.Message, error) // 发送纯文本消息
GetMessage(channelId string, messageId string) (*resource.Message, error) // （从缓存中）获取指定消息
RecallMessage(channelId string, messageId string) error // 撤回指定消息
UpdateMessage(channelId string, messageId string, content string) error // 编辑指定消息
GetMessageList(channelId string, limit uint32, order bool) []*resource.Message // 获取一定数量的频道消息列表
GetMessageListByRange(channelId string, messageId string, start uint32, count uint32) []*resource.Message // 获取频道消息列表(可指定范围)

CreateReaction(channelId string, messageId string, emoji string) error // 添加消息反应
DeleteReaction(channelId string, messageId string, emoji string, userId string) error // 删除消息反应
ClearReaction(channelId string, messageId string, emoji string) error // 清除消息反应
GetReactionList(channelId string, messageId string, emoji string) []resource.User // 获取消息反应列表
GetReactionListByToken(channelId string, messageId string, emoji string, next string) *resource.PagedList // 获取消息反应列表(分页)

GetUser(userId string) *resource.User // 获取指定用户信息
GetFriendList() []*resource.User // 获取好友列表信息
ApproveFriendRequest(messageId string, approve string, comment string) error // 处理好友请求

// Iceinu的特有API
// 其中一部分是对各个平台功能的扩展适配，还有一部分是其他功能的快捷方式
Expand All @@ -63,10 +69,11 @@ type Bot interface {
SendGroupPoke(groupId string) error // 发送群组戳一戳
SendChannelPoke(channelId string) error // 发送频道戳一戳

GetSelfUserId() string // 获取自己的用户ID
GetSelfUserName() string // 获取自己的用户名
GetSelfAvatarUrl() string // 获取自己的头像URL
GetSeldUserNickname() string // 获取自己的昵称
GetSelfUserId() string // 获取自己的用户ID
GetSelfUserName() string // 获取自己的用户名
GetSelfAvatarUrl() string // 获取自己的头像URL
GetSeldUserNickname() string // 获取自己的昵称
GetGroupAvatarUrl(groupId string) string // 获取指定群组的头像URL

RefreshUserListCache() error // 刷新用户列表
RefreshGroupListCache() error // 刷新群组列表
Expand All @@ -85,12 +92,15 @@ type Bot interface {

UploadChannelFile(channelId string, filePath string) error // 向频道上传文件
UploadGroupFile(groupId string, filePath string, targetFilePath string) error // 向群组上传文件
GetGroupFileSystemInfo(groupId string) interface{} // 获取群组文件系统信息(暂未确定)
GetGroupFileSystemInfo(groupId string) *resource.GroupFileSystemInfo // 获取群组文件系统信息(暂未确定)
GetGroupFilesByFolder(groupId string, folderId string) interface{} // 获取群组文件夹内的文件列表(暂未确定)
GetGroupRootFiles(groupId string) interface{} // 获取群组根目录文件列表(暂未确定)
MoveGroupFile(groupId string, fileId string, parentFolder string, targetFolderId string) error // 移动群组文件
DeleteGroupFile(groupId string, fileId string) error // 删除群组文件
CreateGroupFolder(groupId string, folderName string, parentFolder string) error // 创建群组文件夹
RenameGroupFolder(groupId string, folderId string, newFolderName string) error // 重命名群组文件夹
DeleteGroupFolder(groupId string, folderId string) error // 删除群组文件夹

// GetOriginalClient 获取适配器的原始客户端对象，部分适配器可能不需要这个东西，只是方便直接传递原本的客户端实例
GetOriginalClient() interface{} // 获取原始客户端对象
}
35 changes: 35 additions & 0 deletions resource/files.go
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
package resource

// From LagrangeGo：https://github.com/LagrangeDev/LagrangeGo/blob/master/client/entity/group_file.go

type GroupFileSystemInfo struct {
GroupUin uint32
FileCount uint32
LimitCount uint32
UsedSpace uint64
TotalSpace uint64
}

type GroupFile struct {
GroupUin uint32
FileId string
FileName string
BusId uint32
FileSize uint64
UploadTime uint32
DeadTime uint32
ModifyTime uint32
DownloadTimes uint32
Uploader uint32
UploaderName string
}

type GroupFolder struct {
GroupUin uint32
FolderId string
FolderName string
CreateTime uint32
Creator uint32
CreatorName string
TotalFileCount uint32
}
6 changes: 6 additions & 0 deletions resource/paged_list.go
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
package resource

type PagedList struct {
data []interface{}
next string
}

0 comments on commit a012a64

Please sign in to comment.