feat: add the notificationAccount (#1602)

* feat: add notification API

* fix: fix the script

* fix: fix the error

deployments/templates/openim.yaml

@@ -247,6 +247,14 @@ manager:
   userID: [ "${MANAGER_USERID_1}", "${MANAGER_USERID_2}", "${MANAGER_USERID_3}" ]
   nickname: [ "${NICKNAME_1}", "${NICKNAME_2}", "${NICKNAME_3}" ]
 
+# chatAdmin, use for send notification
+#
+# Built-in app system notification account ID
+# Built-in app system notification account nickname
+im-admin:
+  userID: [ "${IM_ADMIN_USERID}" ]
+  nickname: [ "${IM_ADMIN_NAME}" ]
+
 # Multi-platform login policy
 # For each platform(Android, iOS, Windows, Mac, web), only one can be online at a time
 multiLoginPolicy: ${MULTILOGIN_POLICY}

docs/contrib/environment.md

@@ -453,43 +453,45 @@ This section involves configuring the log settings, including storage location,
 
 This section involves setting up additional configuration variables for Websocket, Push Notifications, and Chat.
 
-| Parameter               | Example Value     | Description                        |
-|-------------------------|-------------------|------------------------------------|
-| WEBSOCKET_MAX_CONN_NUM  | "100000"          | Maximum Websocket connections      |
-| WEBSOCKET_MAX_MSG_LEN   | "4096"            | Maximum Websocket message length   |
-| WEBSOCKET_TIMEOUT       | "10"              | Websocket timeout                  |
-| PUSH_ENABLE             | "getui"           | Push notification enable status    |
-| GETUI_PUSH_URL          | [Generated URL]   | GeTui Push Notification URL        |
-| GETUI_MASTER_SECRET     | [User Defined]    | GeTui Master Secret                |
-| GETUI_APP_KEY           | [User Defined]    | GeTui Application Key              |
-| GETUI_INTENT            | [User Defined]    | GeTui Push Intent                  |
-| GETUI_CHANNEL_ID        | [User Defined]    | GeTui Channel ID                   |
-| GETUI_CHANNEL_NAME      | [User Defined]    | GeTui Channel Name                 |
-| FCM_SERVICE_ACCOUNT     | "x.json"          | FCM Service Account                |
-| JPNS_APP_KEY            | [User Defined]    | JPNS Application Key               |
-| JPNS_MASTER_SECRET      | [User Defined]    | JPNS Master Secret                 |
-| JPNS_PUSH_URL           | [User Defined]    | JPNS Push Notification URL         |
-| JPNS_PUSH_INTENT        | [User Defined]    | JPNS Push Intent                   |
-| MANAGER_USERID_1        | "openIM123456"    | Administrator ID 1                 |
-| MANAGER_USERID_2        | "openIM654321"    | Administrator ID 2                 |
-| MANAGER_USERID_3        | "openIMAdmin"     | Administrator ID 3                 |
-| NICKNAME_1              | "system1"         | Nickname 1                         |
-| NICKNAME_2              | "system2"         | Nickname 2                         |
-| NICKNAME_3              | "system3"         | Nickname 3                         |
-| MULTILOGIN_POLICY       | "1"               | Multi-login Policy                 |
-| CHAT_PERSISTENCE_MYSQL  | "true"            | Chat Persistence in MySQL          |
-| MSG_CACHE_TIMEOUT       | "86400"           | Message Cache Timeout              |
-| GROUP_MSG_READ_RECEIPT  | "true"            | Group Message Read Receipt Enable  |
+| Parameter               | Example Value     | Description                      |
+|-------------------------|-------------------|----------------------------------|
+| WEBSOCKET_MAX_CONN_NUM  | "100000"          | Maximum Websocket connections    |
+| WEBSOCKET_MAX_MSG_LEN   | "4096"            | Maximum Websocket message length |
+| WEBSOCKET_TIMEOUT       | "10"              | Websocket timeout                |
+| PUSH_ENABLE             | "getui"           | Push notification enable status  |
+| GETUI_PUSH_URL          | [Generated URL]   | GeTui Push Notification URL      |
+| GETUI_MASTER_SECRET     | [User Defined]    | GeTui Master Secret              |
+| GETUI_APP_KEY           | [User Defined]    | GeTui Application Key            |
+| GETUI_INTENT            | [User Defined]    | GeTui Push Intent                |
+| GETUI_CHANNEL_ID        | [User Defined]    | GeTui Channel ID                 |
+| GETUI_CHANNEL_NAME      | [User Defined]    | GeTui Channel Name               |
+| FCM_SERVICE_ACCOUNT     | "x.json"          | FCM Service Account              |
+| JPNS_APP_KEY            | [User Defined]    | JPNS Application Key             |
+| JPNS_MASTER_SECRET      | [User Defined]    | JPNS Master Secret               |
+| JPNS_PUSH_URL           | [User Defined]    | JPNS Push Notification URL       |
+| JPNS_PUSH_INTENT        | [User Defined]    | JPNS Push Intent                 |
+| MANAGER_USERID_1        | "openIM123456"    | Administrator ID 1               |
+| MANAGER_USERID_2        | "openIM654321"    | Administrator ID 2               |
+| MANAGER_USERID_3        | "openIMAdmin"     | Administrator ID 3               |
+| NICKNAME_1              | "system1"         | Nickname 1                       |
+| NICKNAME_2              | "system2"         | Nickname 2                       |
+| NICKNAME_3              | "system3"         | Nickname 3                       |
+| IM_ADMIN_USERID         | "imAdmin"         | IM Administrator ID              |
+| IM_ADMIN_NAME           | "imAdmin"         | IM Administrator Nickname        |
+| MULTILOGIN_POLICY       | "1"               | Multi-login Policy               |
+| CHAT_PERSISTENCE_MYSQL  | "true"            | Chat Persistence in MySQL        |
+| MSG_CACHE_TIMEOUT       | "86400"           | Message Cache Timeout            |
+| GROUP_MSG_READ_RECEIPT  | "true"            | Group Message Read Receipt Enable |
 | SINGLE_MSG_READ_RECEIPT | "true"            | Single Message Read Receipt Enable |
-| RETAIN_CHAT_RECORDS     | "365"             | Retain Chat Records (in days)      |
-| CHAT_RECORDS_CLEAR_TIME | [Cron Expression] | Chat Records Clear Time            |
-| MSG_DESTRUCT_TIME       | [Cron Expression] | Message Destruct Time              |
-| SECRET                  | "${PASSWORD}"     | Secret Key                         |
-| TOKEN_EXPIRE            | "90"              | Token Expiry Time                  |
-| FRIEND_VERIFY           | "false"           | Friend Verification Enable         |
-| IOS_PUSH_SOUND          | "xxx"             | iOS                                |
-| CALLBACK_ENABLE         | "false"            | Enable callback                    | 
-| CALLBACK_TIMEOUT        | "5"               | Maximum timeout for callback call  |
+| RETAIN_CHAT_RECORDS     | "365"             | Retain Chat Records (in days)    |
+| CHAT_RECORDS_CLEAR_TIME | [Cron Expression] | Chat Records Clear Time          |
+| MSG_DESTRUCT_TIME       | [Cron Expression] | Message Destruct Time            |
+| SECRET                  | "${PASSWORD}"     | Secret Key                       |
+| TOKEN_EXPIRE            | "90"              | Token Expiry Time                |
+| FRIEND_VERIFY           | "false"           | Friend Verification Enable       |
+| IOS_PUSH_SOUND          | "xxx"             | iOS                              |
+| CALLBACK_ENABLE         | "false"            | Enable callback                  | 
+| CALLBACK_TIMEOUT        | "5"               | Maximum timeout for callback call |
 | CALLBACK_FAILED_CONTINUE| "true"            | fails to continue to the next step |
 ###  2.20. <a name='PrometheusConfiguration-1'></a>Prometheus Configuration
 

go.mod

@@ -156,3 +156,5 @@ require (
 	golang.org/x/crypto v0.14.0 // indirect
 	gopkg.in/ini.v1 v1.67.0 // indirect
 )
+
+replace github.com/OpenIMSDK/protocol v0.0.36 => github.com/luhaoling/protocol v0.0.0-20231222100538-d625562d53d5

go.sum

@@ -18,8 +18,6 @@ firebase.google.com/go v3.13.0+incompatible/go.mod h1:xlah6XbEyW6tbfSklcfe5FHJIw
 github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
 github.com/IBM/sarama v1.41.3 h1:MWBEJ12vHC8coMjdEXFq/6ftO6DUZnQlFYcxtOJFa7c=
 github.com/IBM/sarama v1.41.3/go.mod h1:Xxho9HkHd4K/MDUo/T/sOqwtX/17D33++E9Wib6hUdQ=
-github.com/OpenIMSDK/protocol v0.0.36 h1:UJnFsr1A4RrNeHMNDVS/1nvXWFoGM43dcXpZeJiIZ+0=
-github.com/OpenIMSDK/protocol v0.0.36/go.mod h1:F25dFrwrIx3lkNoiuf6FkCfxuwf8L4Z8UIsdTHP/r0Y=
 github.com/OpenIMSDK/tools v0.0.21 h1:iTapc2mIEVH/xl5Nd6jfwPub11Pgp44tVcE1rjB3a48=
 github.com/OpenIMSDK/tools v0.0.21/go.mod h1:eg+q4A34Qmu73xkY0mt37FHGMCMfC6CtmOnm0kFEGFI=
 github.com/QcloudApi/qcloud_sign_golang v0.0.0-20141224014652-e4130a326409/go.mod h1:1pk82RBxDY/JZnPQrtqHlUFfCctgdorsd9M06fMynOM=
@@ -227,6 +225,8 @@ github.com/lestrrat-go/strftime v1.0.6 h1:CFGsDEt1pOpFNU+TJB0nhz9jl+K0hZSLE205Ah
 github.com/lestrrat-go/strftime v1.0.6/go.mod h1:f7jQKgV5nnJpYgdEasS+/y7EsTb8ykN2z68n3TtcTaw=
 github.com/lithammer/shortuuid v3.0.0+incompatible h1:NcD0xWW/MZYXEHa6ITy6kaXN5nwm/V115vj2YXfhS0w=
 github.com/lithammer/shortuuid v3.0.0+incompatible/go.mod h1:FR74pbAuElzOUuenUHTK2Tciko1/vKuIKS9dSkDrA4w=
+github.com/luhaoling/protocol v0.0.0-20231222100538-d625562d53d5 h1:nmrJmAgQsCAxKgw109kaTcBV4rMWDRvqOson0ehw708=
+github.com/luhaoling/protocol v0.0.0-20231222100538-d625562d53d5/go.mod h1:F25dFrwrIx3lkNoiuf6FkCfxuwf8L4Z8UIsdTHP/r0Y=
 github.com/mattn/go-isatty v0.0.19 h1:JITubQf0MOLdlGRuRq+jtsDlekdYPia9ZFsB8h/APPA=
 github.com/mattn/go-isatty v0.0.19/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
 github.com/matttproud/golang_protobuf_extensions v1.0.4 h1:mmDVorXM7PCGKw94cs5zkfA9PSy5pEvNWRP0ET0TIVo=

internal/api/friend.go

@@ -92,6 +92,3 @@ func (o *FriendApi) GetFriendIDs(c *gin.Context) {
 func (o *FriendApi) GetSpecifiedFriendsInfo(c *gin.Context) {
 	a2r.Call(friend.FriendClient.GetSpecifiedFriendsInfo, o.Client, c)
 }
-func (o *FriendApi) SetPinFriends(c *gin.Context) {
-	a2r.Call(friend.FriendClient.PinFriends, o.Client, c)
-}

internal/api/msg.go

@@ -169,9 +169,8 @@ func (m *MessageApi) getSendMsgReq(c *gin.Context, req apistruct.SendMsg) (sendM
 	case constant.OANotification:
 		data = apistruct.OANotificationElem{}
 		req.SessionType = constant.NotificationChatType
-		if !authverify.IsManagerUserID(req.SendID) {
-			return nil, errs.ErrNoPermission.
-				Wrap("only app manager can as sender send OANotificationElem")
+		if err = m.userRpcClient.GetNotificationByID(c, req.SendID); err != nil {
+			return nil, err
 		}
 	default:
 		return nil, errs.ErrArgs.WithDetail("not support err contentType")

internal/api/route.go

@@ -82,6 +82,10 @@ func NewGinRouter(discov discoveryregistry.SvcDiscoveryRegistry, rdb redis.Unive
 		userRouterGroup.POST("/process_user_command_delete", ParseToken, u.ProcessUserCommandDelete)
 		userRouterGroup.POST("/process_user_command_update", ParseToken, u.ProcessUserCommandUpdate)
 		userRouterGroup.POST("/process_user_command_get", ParseToken, u.ProcessUserCommandGet)
+
+		userRouterGroup.POST("/add_notification_account", ParseToken, u.AddNotificationAccount)
+		userRouterGroup.POST("/update_notification_account", ParseToken, u.UpdateNotificationAccountInfo)
+		userRouterGroup.POST("/search_notification_account", ParseToken, u.SearchNotificationAccount)
 	}
 	// friend routing group
 	friendRouterGroup := r.Group("/friend", ParseToken)
@@ -103,7 +107,7 @@ func NewGinRouter(discov discoveryregistry.SvcDiscoveryRegistry, rdb redis.Unive
 		friendRouterGroup.POST("/is_friend", f.IsFriend)
 		friendRouterGroup.POST("/get_friend_id", f.GetFriendIDs)
 		friendRouterGroup.POST("/get_specified_friends_info", f.GetSpecifiedFriendsInfo)
-		friendRouterGroup.POST("/set_pin_friend", f.SetPinFriends)
+		//friendRouterGroup.POST("/set_pin_friend", f.SetPinFriends)
 	}
 	g := NewGroupApi(*groupRpc)
 	groupRouterGroup := r.Group("/group", ParseToken)

internal/api/user.go

@@ -15,15 +15,14 @@
 package api
 
 import (
-	"github.com/gin-gonic/gin"
-
 	"github.com/OpenIMSDK/protocol/constant"
 	"github.com/OpenIMSDK/protocol/msggateway"
 	"github.com/OpenIMSDK/protocol/user"
 	"github.com/OpenIMSDK/tools/a2r"
 	"github.com/OpenIMSDK/tools/apiresp"
 	"github.com/OpenIMSDK/tools/errs"
 	"github.com/OpenIMSDK/tools/log"
+	"github.com/gin-gonic/gin"
 
 	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
 	"github.com/openimsdk/open-im-server/v3/pkg/rpcclient"
@@ -219,3 +218,15 @@ func (u *UserApi) ProcessUserCommandUpdate(c *gin.Context) {
 func (u *UserApi) ProcessUserCommandGet(c *gin.Context) {
 	a2r.Call(user.UserClient.ProcessUserCommandGet, u.Client, c)
 }
+
+func (u *UserApi) AddNotificationAccount(c *gin.Context) {
+	a2r.Call(user.UserClient.AddNotificationAccount, u.Client, c)
+}
+
+func (u *UserApi) UpdateNotificationAccountInfo(c *gin.Context) {
+	a2r.Call(user.UserClient.UpdateNotificationAccountInfo, u.Client, c)
+}
+
+func (u *UserApi) SearchNotificationAccount(c *gin.Context) {
+	a2r.Call(user.UserClient.SearchNotificationAccount, u.Client, c)
+}

internal/rpc/friend/friend.go

@@ -53,6 +53,11 @@ type friendServer struct {
 	RegisterCenter        registry.SvcDiscoveryRegistry
 }
 
+func (s *friendServer) UpdateFriends(ctx context.Context, req *pbfriend.UpdateFriendsReq) (*pbfriend.UpdateFriendsResp, error) {
+	//TODO implement me
+	panic("implement me")
+}
+
 func Start(client registry.SvcDiscoveryRegistry, server *grpc.Server) error {
 	// Initialize MongoDB
 	mongo, err := unrelation.NewMongo()
@@ -438,8 +443,8 @@ func (s *friendServer) GetSpecifiedFriendsInfo(ctx context.Context, req *pbfrien
 }
 func (s *friendServer) PinFriends(
 	ctx context.Context,
-	req *pbfriend.PinFriendsReq,
-) (*pbfriend.PinFriendsResp, error) {
+	req *pbfriend.UpdateFriendsReq,
+) (*pbfriend.UpdateFriendsResp, error) {
 	if len(req.FriendUserIDs) == 0 {
 		return nil, errs.ErrArgs.Wrap("friendIDList is empty")
 	}
@@ -465,6 +470,6 @@ func (s *friendServer) PinFriends(
 		}
 	}
 
-	resp := &pbfriend.PinFriendsResp{}
+	resp := &pbfriend.UpdateFriendsResp{}
 	return resp, nil
 }

internal/rpc/user/user.go

@@ -17,6 +17,7 @@ package user
 import (
 	"context"
 	"errors"
+	"math/rand"
 	"strings"
 	"time"
 
@@ -72,6 +73,12 @@ func Start(client registry.SvcDiscoveryRegistry, server *grpc.Server) error {
 	for k, v := range config.Config.Manager.UserID {
 		users = append(users, &tablerelation.UserModel{UserID: v, Nickname: config.Config.Manager.Nickname[k], AppMangerLevel: constant.AppAdmin})
 	}
+	if len(config.Config.IMAdmin.UserID) != len(config.Config.IMAdmin.Nickname) {
+		return errors.New("len(config.Config.AppNotificationAdmin.AppManagerUid) != len(config.Config.AppNotificationAdmin.Nickname)")
+	}
+	for k, v := range config.Config.IMAdmin.UserID {
+		users = append(users, &tablerelation.UserModel{UserID: v, Nickname: config.Config.IMAdmin.Nickname[k], AppMangerLevel: constant.AppNotificationAdmin})
+	}
 	userDB, err := mgo.NewUserMongo(mongo.GetDatabase())
 	if err != nil {
 		return err
@@ -390,3 +397,124 @@ func (s *userServer) ProcessUserCommandGet(ctx context.Context, req *pbuser.Proc
 	// Return the response with the slice
 	return &pbuser.ProcessUserCommandGetResp{KVArray: commandInfoSlice}, nil
 }
+
+func (s *userServer) AddNotificationAccount(ctx context.Context, req *pbuser.AddNotificationAccountReq) (*pbuser.AddNotificationAccountResp, error) {
+	if err := authverify.CheckIMAdmin(ctx); err != nil {
+		return nil, err
+	}
+
+	var userID string
+	for i := 0; i < 20; i++ {
+		userId := s.genUserID()
+		_, err := s.UserDatabase.FindWithError(ctx, []string{userId})
+		if err == nil {
+			continue
+		}
+		userID = userId
+		break
+	}
+	if userID == "" {
+		return nil, errs.ErrInternalServer.Wrap("gen user id failed")
+	}
+
+	user := &tablerelation.UserModel{
+		UserID:         userID,
+		Nickname:       req.NickName,
+		FaceURL:        req.FaceURL,
+		CreateTime:     time.Now(),
+		AppMangerLevel: constant.AppNotificationAdmin,
+	}
+	if err := s.UserDatabase.Create(ctx, []*tablerelation.UserModel{user}); err != nil {
+		return nil, err
+	}
+
+	return &pbuser.AddNotificationAccountResp{}, nil
+}
+
+func (s *userServer) UpdateNotificationAccountInfo(ctx context.Context, req *pbuser.UpdateNotificationAccountInfoReq) (*pbuser.UpdateNotificationAccountInfoResp, error) {
+	if err := authverify.CheckIMAdmin(ctx); err != nil {
+		return nil, err
+	}
+
+	if _, err := s.UserDatabase.FindWithError(ctx, []string{req.UserID}); err != nil {
+		return nil, errs.ErrArgs.Wrap()
+	}
+
+	user := map[string]interface{}{}
+
+	if req.NickName != "" {
+		user["nickname"] = req.NickName
+	}
+
+	if req.FaceURL != "" {
+		user["face_url"] = req.FaceURL
+	}
+
+	if err := s.UserDatabase.UpdateByMap(ctx, req.UserID, user); err != nil {
+		return nil, err
+	}
+
+	return &pbuser.UpdateNotificationAccountInfoResp{}, nil
+}
+
+func (s *userServer) SearchNotificationAccount(ctx context.Context, req *pbuser.SearchNotificationAccountReq) (*pbuser.SearchNotificationAccountResp, error) {
+	if err := authverify.CheckIMAdmin(ctx); err != nil {
+		return nil, err
+	}
+
+	_, users, err := s.UserDatabase.Page(ctx, req.Pagination)
+	if err != nil {
+		return nil, err
+	}
+
+	var total int64
+	accounts := make([]*pbuser.NotificationAccountInfo, 0, len(users))
+	for _, v := range users {
+		if v.AppMangerLevel != constant.AppNotificationAdmin {
+			continue
+		}
+		temp := &pbuser.NotificationAccountInfo{
+			UserID:   v.UserID,
+			FaceURL:  v.FaceURL,
+			NickName: v.Nickname,
+		}
+		accounts = append(accounts, temp)
+		total += 1
+	}
+	return &pbuser.SearchNotificationAccountResp{Total: total, NotificationAccounts: accounts}, nil
+}
+
+func (s *userServer) UpdateUserInfoEx(ctx context.Context, req *pbuser.UpdateUserInfoExReq) (*pbuser.UpdateUserInfoExResp, error) {
+	//TODO implement me
+	panic("implement me")
+}
+
+func (s *userServer) GetNotificationAccount(ctx context.Context, req *pbuser.GetNotificationAccountReq) (*pbuser.GetNotificationAccountResp, error) {
+	if req.UserID == "" {
+		return nil, errs.ErrArgs.Wrap("userID is empty")
+	}
+	user, err := s.UserDatabase.GetUserByID(ctx, req.UserID)
+	if err != nil {
+		return nil, errs.ErrUserIDNotFound.Wrap()
+	}
+	if user.AppMangerLevel == constant.AppAdmin || user.AppMangerLevel == constant.AppNotificationAdmin {
+		return &pbuser.GetNotificationAccountResp{}, nil
+	}
+
+	return nil, errs.ErrNoPermission.Wrap("notification messages cannot be sent for this ID")
+}
+
+func (s *userServer) genUserID() string {
+	const l = 10
+	data := make([]byte, l)
+	rand.Read(data)
+	chars := []byte("0123456789")
+	for i := 0; i < len(data); i++ {
+		if i == 0 {
+			data[i] = chars[1:][data[i]%9]
+		} else {
+			data[i] = chars[data[i]%10]
+		}
+	}
+	return string(data)
+}

pkg/apistruct/msg.go

@@ -87,7 +87,7 @@ type OANotificationElem struct {
 	NotificationType    int32        `mapstructure:"notificationType"    json:"notificationType"    validate:"required"`
 	Text                string       `mapstructure:"text"                json:"text"                validate:"required"`
 	Url                 string       `mapstructure:"url"                 json:"url"`
-	MixType             int32        `mapstructure:"mixType"             json:"mixType"             validate:"required"`
+	MixType             int32        `mapstructure:"mixType"             json:"mixType"`
 	PictureElem         *PictureElem `mapstructure:"pictureElem"         json:"pictureElem"`
 	SoundElem           *SoundElem   `mapstructure:"soundElem"           json:"soundElem"`
 	VideoElem           *VideoElem   `mapstructure:"videoElem"           json:"videoElem"`

pkg/authverify/token.go

@@ -54,6 +54,15 @@ func CheckAdmin(ctx context.Context) error {
 	}
 	return errs.ErrNoPermission.Wrap(fmt.Sprintf("user %s is not admin userID", mcontext.GetOpUserID(ctx)))
 }
+func CheckIMAdmin(ctx context.Context) error {
+	if utils.IsContain(mcontext.GetOpUserID(ctx), config.Config.IMAdmin.UserID) {
+		return nil
+	}
+	if utils.IsContain(mcontext.GetOpUserID(ctx), config.Config.Manager.UserID) {
+		return nil
+	}
+	return errs.ErrNoPermission.Wrap(fmt.Sprintf("user %s is not CheckIMAdmin userID", mcontext.GetOpUserID(ctx)))
+}
 
 func ParseRedisInterfaceToken(redisToken any) (*tokenverify.Claims, error) {
 	return tokenverify.GetClaimFromToken(string(redisToken.([]uint8)), Secret())