mirror of
https://github.com/openimsdk/open-im-server.git
synced 2025-11-02 09:22:11 +08:00
416 lines
15 KiB
Go
416 lines
15 KiB
Go
// Copyright © 2023 OpenIM. All rights reserved.
|
||
//
|
||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||
// you may not use this file except in compliance with the License.
|
||
// You may obtain a copy of the License at
|
||
//
|
||
// http://www.apache.org/licenses/LICENSE-2.0
|
||
//
|
||
// Unless required by applicable law or agreed to in writing, software
|
||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
// See the License for the specific language governing permissions and
|
||
// limitations under the License.
|
||
|
||
package push
|
||
|
||
import (
|
||
"context"
|
||
"encoding/json"
|
||
"github.com/IBM/sarama"
|
||
"github.com/openimsdk/open-im-server/v3/internal/push/offlinepush"
|
||
"github.com/openimsdk/open-im-server/v3/internal/push/offlinepush/options"
|
||
"github.com/openimsdk/open-im-server/v3/pkg/common/prommetrics"
|
||
"github.com/openimsdk/open-im-server/v3/pkg/common/webhook"
|
||
"github.com/openimsdk/open-im-server/v3/pkg/msgprocessor"
|
||
"github.com/openimsdk/open-im-server/v3/pkg/rpccache"
|
||
"github.com/openimsdk/open-im-server/v3/pkg/rpcclient"
|
||
"github.com/openimsdk/open-im-server/v3/pkg/util/conversationutil"
|
||
"github.com/openimsdk/protocol/constant"
|
||
pbchat "github.com/openimsdk/protocol/msg"
|
||
"github.com/openimsdk/protocol/msggateway"
|
||
pbpush "github.com/openimsdk/protocol/push"
|
||
"github.com/openimsdk/protocol/sdkws"
|
||
"github.com/openimsdk/tools/discovery"
|
||
"github.com/openimsdk/tools/log"
|
||
"github.com/openimsdk/tools/mcontext"
|
||
"github.com/openimsdk/tools/mq/kafka"
|
||
"github.com/openimsdk/tools/utils/datautil"
|
||
"github.com/openimsdk/tools/utils/jsonutil"
|
||
"github.com/openimsdk/tools/utils/timeutil"
|
||
"github.com/redis/go-redis/v9"
|
||
"google.golang.org/protobuf/proto"
|
||
"time"
|
||
)
|
||
|
||
type ConsumerHandler struct {
|
||
pushConsumerGroup *kafka.MConsumerGroup
|
||
offlinePusher offlinepush.OfflinePusher
|
||
onlinePusher OnlinePusher
|
||
onlineCache *rpccache.OnlineCache
|
||
groupLocalCache *rpccache.GroupLocalCache
|
||
conversationLocalCache *rpccache.ConversationLocalCache
|
||
msgRpcClient rpcclient.MessageRpcClient
|
||
conversationRpcClient rpcclient.ConversationRpcClient
|
||
groupRpcClient rpcclient.GroupRpcClient
|
||
webhookClient *webhook.Client
|
||
config *Config
|
||
}
|
||
|
||
func NewConsumerHandler(config *Config, offlinePusher offlinepush.OfflinePusher, rdb redis.UniversalClient,
|
||
client discovery.SvcDiscoveryRegistry) (*ConsumerHandler, error) {
|
||
var consumerHandler ConsumerHandler
|
||
var err error
|
||
consumerHandler.pushConsumerGroup, err = kafka.NewMConsumerGroup(config.KafkaConfig.Build(), config.KafkaConfig.ToPushGroupID,
|
||
[]string{config.KafkaConfig.ToPushTopic}, true)
|
||
if err != nil {
|
||
return nil, err
|
||
}
|
||
userRpcClient := rpcclient.NewUserRpcClient(client, config.Share.RpcRegisterName.User, config.Share.IMAdminUserID)
|
||
|
||
consumerHandler.offlinePusher = offlinePusher
|
||
consumerHandler.onlinePusher = NewOnlinePusher(client, config)
|
||
consumerHandler.groupRpcClient = rpcclient.NewGroupRpcClient(client, config.Share.RpcRegisterName.Group)
|
||
consumerHandler.groupLocalCache = rpccache.NewGroupLocalCache(consumerHandler.groupRpcClient, &config.LocalCacheConfig, rdb)
|
||
consumerHandler.msgRpcClient = rpcclient.NewMessageRpcClient(client, config.Share.RpcRegisterName.Msg)
|
||
consumerHandler.conversationRpcClient = rpcclient.NewConversationRpcClient(client, config.Share.RpcRegisterName.Conversation)
|
||
consumerHandler.conversationLocalCache = rpccache.NewConversationLocalCache(consumerHandler.conversationRpcClient, &config.LocalCacheConfig, rdb)
|
||
consumerHandler.webhookClient = webhook.NewWebhookClient(config.WebhooksConfig.URL)
|
||
consumerHandler.config = config
|
||
consumerHandler.onlineCache, err = rpccache.NewOnlineCache(userRpcClient, consumerHandler.groupLocalCache, rdb, config.RpcConfig.FullUserCache, nil)
|
||
if err != nil {
|
||
return nil, err
|
||
}
|
||
return &consumerHandler, nil
|
||
}
|
||
|
||
func (c *ConsumerHandler) handleMs2PsChat(ctx context.Context, msg []byte) {
|
||
msgFromMQ := pbchat.PushMsgDataToMQ{}
|
||
if err := proto.Unmarshal(msg, &msgFromMQ); err != nil {
|
||
log.ZError(ctx, "push Unmarshal msg err", err, "msg", string(msg))
|
||
return
|
||
}
|
||
pbData := &pbpush.PushMsgReq{
|
||
MsgData: msgFromMQ.MsgData,
|
||
ConversationID: msgFromMQ.ConversationID,
|
||
}
|
||
sec := msgFromMQ.MsgData.SendTime / 1000
|
||
nowSec := timeutil.GetCurrentTimestampBySecond()
|
||
|
||
if nowSec-sec > 10 {
|
||
prommetrics.MsgLoneTimePushCounter.Inc()
|
||
log.ZWarn(ctx, "it’s been a while since the message was sent", nil, "msg", pbData.String(), "sec", sec, "nowSec", nowSec, "nowSec-sec", nowSec-sec)
|
||
}
|
||
var err error
|
||
switch msgFromMQ.MsgData.SessionType {
|
||
case constant.ReadGroupChatType:
|
||
err = c.Push2Group(ctx, pbData.MsgData.GroupID, pbData.MsgData)
|
||
default:
|
||
var pushUserIDList []string
|
||
isSenderSync := datautil.GetSwitchFromOptions(pbData.MsgData.Options, constant.IsSenderSync)
|
||
if !isSenderSync || pbData.MsgData.SendID == pbData.MsgData.RecvID {
|
||
pushUserIDList = append(pushUserIDList, pbData.MsgData.RecvID)
|
||
} else {
|
||
pushUserIDList = append(pushUserIDList, pbData.MsgData.RecvID, pbData.MsgData.SendID)
|
||
}
|
||
err = c.Push2User(ctx, pushUserIDList, pbData.MsgData)
|
||
}
|
||
if err != nil {
|
||
log.ZWarn(ctx, "push failed", err, "msg", pbData.String())
|
||
}
|
||
}
|
||
|
||
func (*ConsumerHandler) Setup(sarama.ConsumerGroupSession) error { return nil }
|
||
|
||
func (*ConsumerHandler) Cleanup(sarama.ConsumerGroupSession) error { return nil }
|
||
|
||
func (c *ConsumerHandler) ConsumeClaim(sess sarama.ConsumerGroupSession, claim sarama.ConsumerGroupClaim) error {
|
||
for msg := range claim.Messages() {
|
||
ctx := c.pushConsumerGroup.GetContextFromMsg(msg)
|
||
c.handleMs2PsChat(ctx, msg.Value)
|
||
sess.MarkMessage(msg, "")
|
||
}
|
||
return nil
|
||
}
|
||
|
||
// Push2User Suitable for two types of conversations, one is SingleChatType and the other is NotificationChatType.
|
||
func (c *ConsumerHandler) Push2User(ctx context.Context, userIDs []string, msg *sdkws.MsgData) (err error) {
|
||
log.ZInfo(ctx, "Get msg from msg_transfer And push msg", "userIDs", userIDs, "msg", msg.String())
|
||
defer func(duration time.Time) {
|
||
t := time.Since(duration)
|
||
log.ZInfo(ctx, "Get msg from msg_transfer And push msg", "msg", msg.String(), "time cost", t)
|
||
}(time.Now())
|
||
if err := c.webhookBeforeOnlinePush(ctx, &c.config.WebhooksConfig.BeforeOnlinePush, userIDs, msg); err != nil {
|
||
return err
|
||
}
|
||
log.ZInfo(ctx, "webhookBeforeOnlinePush end")
|
||
|
||
wsResults, err := c.GetConnsAndOnlinePush(ctx, msg, userIDs)
|
||
if err != nil {
|
||
return err
|
||
}
|
||
|
||
log.ZInfo(ctx, "single and notification push result", "result", wsResults, "msg", msg, "push_to_userID", userIDs)
|
||
|
||
if !c.shouldPushOffline(ctx, msg) {
|
||
return nil
|
||
}
|
||
log.ZInfo(ctx, "shouldPushOffline end")
|
||
|
||
for _, v := range wsResults {
|
||
//message sender do not need offline push
|
||
if msg.SendID == v.UserID {
|
||
continue
|
||
}
|
||
//receiver online push success
|
||
if v.OnlinePush {
|
||
return nil
|
||
}
|
||
}
|
||
offlinePushUserID := []string{msg.RecvID}
|
||
|
||
//receiver offline push
|
||
if err = c.webhookBeforeOfflinePush(ctx, &c.config.WebhooksConfig.BeforeOfflinePush,
|
||
offlinePushUserID, msg, nil); err != nil {
|
||
return err
|
||
}
|
||
log.ZInfo(ctx, "webhookBeforeOfflinePush end")
|
||
err = c.offlinePushMsg(ctx, msg, offlinePushUserID)
|
||
if err != nil {
|
||
log.ZWarn(ctx, "offlinePushMsg failed", err, "offlinePushUserID", offlinePushUserID, "msg", msg)
|
||
return nil
|
||
}
|
||
|
||
return nil
|
||
}
|
||
|
||
func (c *ConsumerHandler) shouldPushOffline(_ context.Context, msg *sdkws.MsgData) bool {
|
||
isOfflinePush := datautil.GetSwitchFromOptions(msg.Options, constant.IsOfflinePush)
|
||
if !isOfflinePush {
|
||
return false
|
||
}
|
||
if msg.ContentType == constant.SignalingNotification {
|
||
return false
|
||
}
|
||
return true
|
||
}
|
||
|
||
func (c *ConsumerHandler) GetConnsAndOnlinePush(ctx context.Context, msg *sdkws.MsgData, pushToUserIDs []string) ([]*msggateway.SingleMsgToUserResults, error) {
|
||
|
||
onlineUserIDs, offlineUserIDs, err := c.onlineCache.GetUsersOnline(ctx, pushToUserIDs)
|
||
if err != nil {
|
||
return nil, err
|
||
}
|
||
|
||
log.ZDebug(ctx, "GetConnsAndOnlinePush online cache", "sendID", msg.SendID, "recvID", msg.RecvID, "groupID", msg.GroupID, "sessionType", msg.SessionType, "clientMsgID", msg.ClientMsgID, "serverMsgID", msg.ServerMsgID, "offlineUserIDs", offlineUserIDs, "onlineUserIDs", onlineUserIDs)
|
||
var result []*msggateway.SingleMsgToUserResults
|
||
if len(onlineUserIDs) > 0 {
|
||
var err error
|
||
result, err = c.onlinePusher.GetConnsAndOnlinePush(ctx, msg, onlineUserIDs)
|
||
if err != nil {
|
||
return nil, err
|
||
}
|
||
}
|
||
for _, userID := range offlineUserIDs {
|
||
result = append(result, &msggateway.SingleMsgToUserResults{
|
||
UserID: userID,
|
||
})
|
||
}
|
||
return result, nil
|
||
}
|
||
|
||
func (c *ConsumerHandler) Push2Group(ctx context.Context, groupID string, msg *sdkws.MsgData) (err error) {
|
||
log.ZInfo(ctx, "Get group msg from msg_transfer and push msg", "msg", msg.String(), "groupID", groupID)
|
||
defer func(duration time.Time) {
|
||
t := time.Since(duration)
|
||
log.ZInfo(ctx, "Get group msg from msg_transfer and push msg end", "msg", msg.String(), "groupID", groupID, "time cost", t)
|
||
}(time.Now())
|
||
var pushToUserIDs []string
|
||
if err = c.webhookBeforeGroupOnlinePush(ctx, &c.config.WebhooksConfig.BeforeGroupOnlinePush, groupID, msg,
|
||
&pushToUserIDs); err != nil {
|
||
return err
|
||
}
|
||
log.ZInfo(ctx, "webhookBeforeGroupOnlinePush end")
|
||
|
||
err = c.groupMessagesHandler(ctx, groupID, &pushToUserIDs, msg)
|
||
if err != nil {
|
||
return err
|
||
}
|
||
log.ZInfo(ctx, "groupMessagesHandler end")
|
||
|
||
wsResults, err := c.GetConnsAndOnlinePush(ctx, msg, pushToUserIDs)
|
||
if err != nil {
|
||
return err
|
||
}
|
||
|
||
log.ZInfo(ctx, "group push result", "result", wsResults, "msg", msg)
|
||
|
||
if !c.shouldPushOffline(ctx, msg) {
|
||
return nil
|
||
}
|
||
needOfflinePushUserIDs := c.onlinePusher.GetOnlinePushFailedUserIDs(ctx, msg, wsResults, &pushToUserIDs)
|
||
log.ZInfo(ctx, "GetOnlinePushFailedUserIDs end")
|
||
//filter some user, like don not disturb or don't need offline push etc.
|
||
needOfflinePushUserIDs, err = c.filterGroupMessageOfflinePush(ctx, groupID, msg, needOfflinePushUserIDs)
|
||
if err != nil {
|
||
return err
|
||
}
|
||
log.ZInfo(ctx, "filterGroupMessageOfflinePush end")
|
||
|
||
// Use offline push messaging
|
||
if len(needOfflinePushUserIDs) > 0 {
|
||
var offlinePushUserIDs []string
|
||
err = c.webhookBeforeOfflinePush(ctx, &c.config.WebhooksConfig.BeforeOfflinePush, needOfflinePushUserIDs, msg, &offlinePushUserIDs)
|
||
if err != nil {
|
||
return err
|
||
}
|
||
log.ZInfo(ctx, "webhookBeforeOfflinePush end")
|
||
if len(offlinePushUserIDs) > 0 {
|
||
needOfflinePushUserIDs = offlinePushUserIDs
|
||
}
|
||
|
||
err = c.offlinePushMsg(ctx, msg, needOfflinePushUserIDs)
|
||
if err != nil {
|
||
log.ZWarn(ctx, "offlinePushMsg failed", err, "groupID", groupID, "msg", msg)
|
||
return nil
|
||
}
|
||
}
|
||
|
||
return nil
|
||
}
|
||
func (c *ConsumerHandler) groupMessagesHandler(ctx context.Context, groupID string, pushToUserIDs *[]string, msg *sdkws.MsgData) (err error) {
|
||
if len(*pushToUserIDs) == 0 {
|
||
*pushToUserIDs, err = c.groupLocalCache.GetGroupMemberIDs(ctx, groupID)
|
||
if err != nil {
|
||
return err
|
||
}
|
||
switch msg.ContentType {
|
||
case constant.MemberQuitNotification:
|
||
var tips sdkws.MemberQuitTips
|
||
if unmarshalNotificationElem(msg.Content, &tips) != nil {
|
||
return err
|
||
}
|
||
if err = c.DeleteMemberAndSetConversationSeq(ctx, groupID, []string{tips.QuitUser.UserID}); err != nil {
|
||
log.ZError(ctx, "MemberQuitNotification DeleteMemberAndSetConversationSeq", err, "groupID", groupID, "userID", tips.QuitUser.UserID)
|
||
}
|
||
*pushToUserIDs = append(*pushToUserIDs, tips.QuitUser.UserID)
|
||
case constant.MemberKickedNotification:
|
||
var tips sdkws.MemberKickedTips
|
||
if unmarshalNotificationElem(msg.Content, &tips) != nil {
|
||
return err
|
||
}
|
||
kickedUsers := datautil.Slice(tips.KickedUserList, func(e *sdkws.GroupMemberFullInfo) string { return e.UserID })
|
||
if err = c.DeleteMemberAndSetConversationSeq(ctx, groupID, kickedUsers); err != nil {
|
||
log.ZError(ctx, "MemberKickedNotification DeleteMemberAndSetConversationSeq", err, "groupID", groupID, "userIDs", kickedUsers)
|
||
}
|
||
|
||
*pushToUserIDs = append(*pushToUserIDs, kickedUsers...)
|
||
case constant.GroupDismissedNotification:
|
||
if msgprocessor.IsNotification(msgprocessor.GetConversationIDByMsg(msg)) {
|
||
var tips sdkws.GroupDismissedTips
|
||
if unmarshalNotificationElem(msg.Content, &tips) != nil {
|
||
return err
|
||
}
|
||
log.ZDebug(ctx, "GroupDismissedNotificationInfo****", "groupID", groupID, "num", len(*pushToUserIDs), "list", pushToUserIDs)
|
||
if len(c.config.Share.IMAdminUserID) > 0 {
|
||
ctx = mcontext.WithOpUserIDContext(ctx, c.config.Share.IMAdminUserID[0])
|
||
}
|
||
defer func(groupID string) {
|
||
if err = c.groupRpcClient.DismissGroup(ctx, groupID); err != nil {
|
||
log.ZError(ctx, "DismissGroup Notification clear members", err, "groupID", groupID)
|
||
}
|
||
}(groupID)
|
||
}
|
||
}
|
||
}
|
||
return err
|
||
}
|
||
|
||
func (c *ConsumerHandler) offlinePushMsg(ctx context.Context, msg *sdkws.MsgData, offlinePushUserIDs []string) error {
|
||
title, content, opts, err := c.getOfflinePushInfos(msg)
|
||
if err != nil {
|
||
return err
|
||
}
|
||
err = c.offlinePusher.Push(ctx, offlinePushUserIDs, title, content, opts)
|
||
if err != nil {
|
||
prommetrics.MsgOfflinePushFailedCounter.Inc()
|
||
return err
|
||
}
|
||
return nil
|
||
}
|
||
|
||
func (c *ConsumerHandler) filterGroupMessageOfflinePush(ctx context.Context, groupID string, msg *sdkws.MsgData,
|
||
offlinePushUserIDs []string) (userIDs []string, err error) {
|
||
|
||
//todo local cache Obtain the difference set through local comparison.
|
||
needOfflinePushUserIDs, err := c.conversationRpcClient.GetConversationOfflinePushUserIDs(
|
||
ctx, conversationutil.GenGroupConversationID(groupID), offlinePushUserIDs)
|
||
if err != nil {
|
||
return nil, err
|
||
}
|
||
return needOfflinePushUserIDs, nil
|
||
}
|
||
|
||
func (c *ConsumerHandler) getOfflinePushInfos(msg *sdkws.MsgData) (title, content string, opts *options.Opts, err error) {
|
||
type AtTextElem struct {
|
||
Text string `json:"text,omitempty"`
|
||
AtUserList []string `json:"atUserList,omitempty"`
|
||
IsAtSelf bool `json:"isAtSelf"`
|
||
}
|
||
|
||
opts = &options.Opts{Signal: &options.Signal{}}
|
||
if msg.OfflinePushInfo != nil {
|
||
opts.IOSBadgeCount = msg.OfflinePushInfo.IOSBadgeCount
|
||
opts.IOSPushSound = msg.OfflinePushInfo.IOSPushSound
|
||
opts.Ex = msg.OfflinePushInfo.Ex
|
||
}
|
||
|
||
if msg.OfflinePushInfo != nil {
|
||
title = msg.OfflinePushInfo.Title
|
||
content = msg.OfflinePushInfo.Desc
|
||
}
|
||
if title == "" {
|
||
switch msg.ContentType {
|
||
case constant.Text:
|
||
fallthrough
|
||
case constant.Picture:
|
||
fallthrough
|
||
case constant.Voice:
|
||
fallthrough
|
||
case constant.Video:
|
||
fallthrough
|
||
case constant.File:
|
||
title = constant.ContentType2PushContent[int64(msg.ContentType)]
|
||
case constant.AtText:
|
||
ac := AtTextElem{}
|
||
_ = jsonutil.JsonStringToStruct(string(msg.Content), &ac)
|
||
case constant.SignalingNotification:
|
||
title = constant.ContentType2PushContent[constant.SignalMsg]
|
||
default:
|
||
title = constant.ContentType2PushContent[constant.Common]
|
||
}
|
||
}
|
||
if content == "" {
|
||
content = title
|
||
}
|
||
return
|
||
}
|
||
|
||
func (c *ConsumerHandler) DeleteMemberAndSetConversationSeq(ctx context.Context, groupID string, userIDs []string) error {
|
||
conversationID := msgprocessor.GetConversationIDBySessionType(constant.ReadGroupChatType, groupID)
|
||
maxSeq, err := c.msgRpcClient.GetConversationMaxSeq(ctx, conversationID)
|
||
if err != nil {
|
||
return err
|
||
}
|
||
return c.conversationRpcClient.SetConversationMaxSeq(ctx, userIDs, conversationID, maxSeq)
|
||
}
|
||
|
||
func unmarshalNotificationElem(bytes []byte, t any) error {
|
||
var notification sdkws.NotificationElem
|
||
if err := json.Unmarshal(bytes, ¬ification); err != nil {
|
||
return err
|
||
}
|
||
|
||
return json.Unmarshal([]byte(notification.Detail), t)
|
||
}
|