YourSelfHosted/memos
1
0
Fork 0
mirror of https://github.com/usememos/memos.git synced 2025-06-05 22:09:59 +02:00
Code Issues Packages Projects Releases Wiki Activity

refactor: change all Robot to Bot (#1767)

Browse Source 
* Change all `Robot` to `Bot`

* Change all `r` of `Bot` to `b`

* Change `Robot` to `bot` in comments

* Fix typo

---------

Co-authored-by: Athurg Feng <athurg@gooth.org>
This commit is contained in:
Athurg Gooth
2023-05-29 19:49:05 +08:00
committed by GitHub
parent ddf4cae537
commit 845297ec03
16 changed files with 80 additions and 80 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
plugin/telegram/api_edit_message.go
View File

@@ -7,7 +7,7 @@ import (
)
// EditMessage make an editMessageText api request.
func (r *Robot) EditMessage(ctx context.Context, chatID, messageID int, text string) (*Message, error) {
func (b *Bot) EditMessage(ctx context.Context, chatID, messageID int, text string) (*Message, error) {
formData := url.Values{
"message_id": {strconv.Itoa(messageID)},
"chat_id": {strconv.Itoa(chatID)},
@@ -15,7 +15,7 @@ func (r *Robot) EditMessage(ctx context.Context, chatID, messageID int, text str
}
var result Message
err := r.postForm(ctx, "/editMessageText", formData, &result)
err := b.postForm(ctx, "/editMessageText", formData, &result)
if err != nil {
return nil, err
}

4
plugin/telegram/api_get_file.go
View File

@@ -6,13 +6,13 @@ import (
)
// GetFile get download info of File by fileID from Telegram.
func (r *Robot) GetFile(ctx context.Context, fileID string) (*File, error) {
func (b *Bot) GetFile(ctx context.Context, fileID string) (*File, error) {
formData := url.Values{
"file_id": {fileID},
}
var result File
err := r.postForm(ctx, "/getFile", formData, &result)
err := b.postForm(ctx, "/getFile", formData, &result)
if err != nil {
return nil, err
}

4
plugin/telegram/api_get_updates.go
View File

@@ -7,14 +7,14 @@ import (
)
// GetUpdates make a getUpdates api request.
func (r *Robot) GetUpdates(ctx context.Context, offset int) ([]Update, error) {
func (b *Bot) GetUpdates(ctx context.Context, offset int) ([]Update, error) {
formData := url.Values{
"timeout": {"60"},
"offset": {strconv.Itoa(offset)},
}
var result []Update
err := r.postForm(ctx, "/getUpdates", formData, &result)
err := b.postForm(ctx, "/getUpdates", formData, &result)
if err != nil {
return nil, err
}

4
plugin/telegram/api_send_message.go
View File

@@ -7,7 +7,7 @@ import (
)
// SendReplyMessage make a sendMessage api request.
func (r *Robot) SendReplyMessage(ctx context.Context, chatID, replyID int, text string) (*Message, error) {
func (b *Bot) SendReplyMessage(ctx context.Context, chatID, replyID int, text string) (*Message, error) {
formData := url.Values{
"reply_to_message_id": {strconv.Itoa(replyID)},
"chat_id": {strconv.Itoa(chatID)},
@@ -15,7 +15,7 @@ func (r *Robot) SendReplyMessage(ctx context.Context, chatID, replyID int, text
}
var result Message
err := r.postForm(ctx, "/sendMessage", formData, &result)
err := b.postForm(ctx, "/sendMessage", formData, &result)
if err != nil {
return nil, err
}

24
plugin/telegram/robot.go → plugin/telegram/bot.go
View File

@@ -12,28 +12,28 @@ import (
)
type Handler interface {
RobotToken(ctx context.Context) string
BotToken(ctx context.Context) string
MessageHandle(ctx context.Context, message Message, blobs map[string][]byte) error
}
type Robot struct {
type Bot struct {
handler Handler
}
// NewRobotWithHandler create a telegram robot with specified handler.
func NewRobotWithHandler(h Handler) *Robot {
return &Robot{handler: h}
// NewBotWithHandler create a telegram bot with specified handler.
func NewBotWithHandler(h Handler) *Bot {
return &Bot{handler: h}
}
const noTokenWait = 30 * time.Second
const errRetryWait = 10 * time.Second
// Start start an infinity call of getUpdates from Telegram, call r.MessageHandle while get new message updates.
func (r *Robot) Start(ctx context.Context) {
func (b *Bot) Start(ctx context.Context) {
var offset int
for {
updates, err := r.GetUpdates(ctx, offset)
updates, err := b.GetUpdates(ctx, offset)
if err == ErrInvalidToken {
time.Sleep(noTokenWait)
continue
@@ -55,7 +55,7 @@ func (r *Robot) Start(ctx context.Context) {
// skip message other than text or photo
if message.Text == nil && message.Photo == nil {
_, err := r.SendReplyMessage(ctx, message.Chat.ID, message.MessageID, "Only text or photo message be supported")
_, err := b.SendReplyMessage(ctx, message.Chat.ID, message.MessageID, "Only text or photo message be supported")
if err != nil {
log.Error(fmt.Sprintf("fail to telegram.SendReplyMessage for messageID=%d", message.MessageID), zap.Error(err))
}
@@ -68,14 +68,14 @@ func (r *Robot) Start(ctx context.Context) {
continue
}
err = r.handleSingleMessage(ctx, message)
err = b.handleSingleMessage(ctx, message)
if err != nil {
log.Error(fmt.Sprintf("fail to handleSingleMessage for messageID=%d", message.MessageID), zap.Error(err))
continue
}
}
err = r.handleGroupMessages(ctx, groupMessages)
err = b.handleGroupMessages(ctx, groupMessages)
if err != nil {
log.Error("fail to handle plain text message", zap.Error(err))
}
@@ -84,8 +84,8 @@ func (r *Robot) Start(ctx context.Context) {
var ErrInvalidToken = errors.New("token is invalid")
func (r *Robot) apiURL(ctx context.Context) (string, error) {
token := r.handler.RobotToken(ctx)
func (b *Bot) apiURL(ctx context.Context) (string, error) {
token := b.handler.BotToken(ctx)
if token == "" {
return "", ErrInvalidToken
}

10
plugin/telegram/download.go
View File

@@ -9,12 +9,12 @@ import (
)
// downloadFileId download file with fileID, return the filepath and blob.
func (r *Robot) downloadFileID(ctx context.Context, fileID string) (string, []byte, error) {
file, err := r.GetFile(ctx, fileID)
func (b *Bot) downloadFileID(ctx context.Context, fileID string) (string, []byte, error) {
file, err := b.GetFile(ctx, fileID)
if err != nil {
return "", nil, err
}
blob, err := r.downloadFilepath(ctx, file.FilePath)
blob, err := b.downloadFilepath(ctx, file.FilePath)
if err != nil {
return "", nil, err
}
@@ -23,8 +23,8 @@ func (r *Robot) downloadFileID(ctx context.Context, fileID string) (string, []by
}
// downloadFilepath download file with filepath, you can get filepath by calling GetFile.
func (r *Robot) downloadFilepath(ctx context.Context, filePath string) ([]byte, error) {
apiURL, err := r.apiURL(ctx)
func (b *Bot) downloadFilepath(ctx context.Context, filePath string) ([]byte, error) {
apiURL, err := b.apiURL(ctx)
if err != nil {
return nil, err
}

26
plugin/telegram/handle.go
View File

@@ -15,8 +15,8 @@ const (
)
// handleSingleMessage handle a message not belongs to group.
func (r *Robot) handleSingleMessage(ctx context.Context, message Message) error {
reply, err := r.SendReplyMessage(ctx, message.Chat.ID, message.MessageID, workingMessage)
func (b *Bot) handleSingleMessage(ctx context.Context, message Message) error {
reply, err := b.SendReplyMessage(ctx, message.Chat.ID, message.MessageID, workingMessage)
if err != nil {
return fmt.Errorf("fail to SendReplyMessage: %s", err)
}
@@ -25,10 +25,10 @@ func (r *Robot) handleSingleMessage(ctx context.Context, message Message) error
// download blob if need
if len(message.Photo) > 0 {
filepath, blob, err := r.downloadFileID(ctx, message.GetMaxPhotoFileID())
filepath, blob, err := b.downloadFileID(ctx, message.GetMaxPhotoFileID())
if err != nil {
log.Error("fail to downloadFileID", zap.Error(err))
_, err = r.EditMessage(ctx, message.Chat.ID, reply.MessageID, err.Error())
_, err = b.EditMessage(ctx, message.Chat.ID, reply.MessageID, err.Error())
if err != nil {
return fmt.Errorf("fail to EditMessage: %s", err)
}
@@ -37,15 +37,15 @@ func (r *Robot) handleSingleMessage(ctx context.Context, message Message) error
blobs = map[string][]byte{filepath: blob}
}
err = r.handler.MessageHandle(ctx, message, blobs)
err = b.handler.MessageHandle(ctx, message, blobs)
if err != nil {
if _, err := r.EditMessage(ctx, message.Chat.ID, reply.MessageID, err.Error()); err != nil {
if _, err := b.EditMessage(ctx, message.Chat.ID, reply.MessageID, err.Error()); err != nil {
return fmt.Errorf("fail to EditMessage: %s", err)
}
return fmt.Errorf("fail to MessageHandle: %s", err)
}
if _, err := r.EditMessage(ctx, message.Chat.ID, reply.MessageID, successMessage); err != nil {
if _, err := b.EditMessage(ctx, message.Chat.ID, reply.MessageID, successMessage); err != nil {
return fmt.Errorf("fail to EditMessage: %s", err)
}
@@ -53,7 +53,7 @@ func (r *Robot) handleSingleMessage(ctx context.Context, message Message) error
}
// handleGroupMessages handle a message belongs to group.
func (r *Robot) handleGroupMessages(ctx context.Context, groupMessages []Message) error {
func (b *Bot) handleGroupMessages(ctx context.Context, groupMessages []Message) error {
captions := make(map[string]string, len(groupMessages))
messages := make(map[string]Message, len(groupMessages))
blobs := make(map[string]map[string][]byte, len(groupMessages))
@@ -68,7 +68,7 @@ func (r *Robot) handleGroupMessages(ctx context.Context, groupMessages []Message
captions[groupID] += *message.Caption
}
filepath, blob, err := r.downloadFileID(ctx, message.GetMaxPhotoFileID())
filepath, blob, err := b.downloadFileID(ctx, message.GetMaxPhotoFileID())
if err != nil {
return fmt.Errorf("fail to downloadFileID")
}
@@ -80,7 +80,7 @@ func (r *Robot) handleGroupMessages(ctx context.Context, groupMessages []Message
// Handle each group message
for groupID, message := range messages {
reply, err := r.SendReplyMessage(ctx, message.Chat.ID, message.MessageID, workingMessage)
reply, err := b.SendReplyMessage(ctx, message.Chat.ID, message.MessageID, workingMessage)
if err != nil {
return fmt.Errorf("fail to SendReplyMessage: %s", err)
}
@@ -88,14 +88,14 @@ func (r *Robot) handleGroupMessages(ctx context.Context, groupMessages []Message
// replace Caption with all Caption in the group
caption := captions[groupID]
message.Caption = &caption
if err := r.handler.MessageHandle(ctx, message, blobs[groupID]); err != nil {
if _, err = r.EditMessage(ctx, message.Chat.ID, reply.MessageID, err.Error()); err != nil {
if err := b.handler.MessageHandle(ctx, message, blobs[groupID]); err != nil {
if _, err = b.EditMessage(ctx, message.Chat.ID, reply.MessageID, err.Error()); err != nil {
return fmt.Errorf("fail to EditMessage: %s", err)
}
return fmt.Errorf("fail to MessageHandle: %s", err)
}
if _, err := r.EditMessage(ctx, message.Chat.ID, reply.MessageID, successMessage); err != nil {
if _, err := b.EditMessage(ctx, message.Chat.ID, reply.MessageID, successMessage); err != nil {
return fmt.Errorf("fail to EditMessage: %s", err)
}
}

4
plugin/telegram/request.go
View File

@@ -9,8 +9,8 @@ import (
"net/url"
)
func (r *Robot) postForm(ctx context.Context, apiPath string, formData url.Values, result any) error {
apiURL, err := r.apiURL(ctx)
func (b *Bot) postForm(ctx context.Context, apiPath string, formData url.Values, result any) error {
apiURL, err := b.apiURL(ctx)
if err != nil {
return err
}