wechaty-puppet-matrix 0.0.35 → 0.0.37

package/src/matrix/events/event-room-join-no-xml.ts

@@ -0,0 +1,178 @@
+import type { MessagePayload } from '../../engine-schema.js'
+import type * as PUPPET from '@juzi/wechaty-puppet'
+import { isRoomId } from '../utils/is-type.js'
+import type { EventPayload } from './event.js'
+import { WechatMessageType } from '../types.js'
+
+const YOU_INVITE_OTHER_REGEX_LIST = [
+  /^你邀请"(.+)"加入了群聊 {2}/,
+  /^You invited (.+) to the group chat/,
+]
+const OTHER_INVITE_YOU_REGEX_LIST = [
+  /^"([^"]+?)"邀请你加入了群聊，群聊参与人还有：(.+)/,
+  /^(.+) invited you to a group chat with (.+)/,
+]
+const OTHER_INVITE_YOU_AND_OTHER_REGEX_LIST = [
+  /^"([^"]+?)"邀请你和"(.+?)"加入了群聊/,
+  /^(.+?) invited you and (.+?) to (the|a) group chat/,
+]
+const OTHER_INVITE_OTHER_REGEX_LIST = [
+  /^"(.+)"邀请"(.+)"加入了群聊/,
+  /^(.+?) invited (.+?) to (the|a) group chat/,
+]
+const OTHER_JOIN_VIA_YOUR_QRCODE_REGEX_LIST = [
+  /^"?(.+)"通过扫描你分享的二维码加入群聊/,
+  /^"?(.+)" joined group chat via the QR code you shared/,
+]
+const OTHER_JOIN_VIA_OTHER_QRCODE_REGEX_LIST = [
+  /^"(.+)"通过扫描"(.+)"分享的二维码加入群聊/,
+  /^"(.+)" joined the group chat via the QR Code shared by "(.+)"/,
+]
+
+export type Runner<T> = () => Promise<T | null>;
+
+export async function executeRunners<T> (runners: Runner<T>[]): Promise<T | null> {
+  for (const runner of runners) {
+    const ret = await runner()
+    if (ret) {
+      return ret
+    }
+  }
+
+  return null
+}
+
+export default async (puppet: PUPPET.Puppet, message: MessagePayload): Promise<EventPayload> => {
+  const roomId = message.fromWxid || ''
+  if (!isRoomId(roomId)) {
+    return null
+  }
+
+  const timestamp = message.timeStamp
+  // 都是系统消息
+  if (message.msgType !== WechatMessageType.Sys && message.msgType !== WechatMessageType.SysTemplate) {
+    return null
+  }
+
+  /**
+   * 1. You Invite Other to join the Room
+   * (including other join var qr code you shared)
+   * /^你邀请"(.+)"加入了群聊 {2}\$revoke\$/,
+   * /^" ?(.+)"通过扫描你分享的二维码加入群聊/,
+   */
+  const youInviteOther = async () => {
+    let matches: null | string[] = null;
+    [ ...YOU_INVITE_OTHER_REGEX_LIST, ...OTHER_JOIN_VIA_YOUR_QRCODE_REGEX_LIST ].some((re) => !!(matches = message.msg.match(re)))
+
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+    if (matches) {
+      // @ts-ignore
+      await puppet._updateRoom(roomId)
+      const inviteName = matches[1]!
+      // @ts-ignore
+      const inviteeId = await puppet._searchRoomMemberInfo(roomId, inviteName)
+
+      return {
+        inviteeIdList: [ inviteeId ],
+        inviterId: puppet.currentUserId,
+        roomId,
+        timestamp,
+      } as PUPPET.payloads.EventRoomJoin
+    }
+    return null
+  }
+
+  /**
+   * 2. Other Invite you to join the Room
+   * /^"([^"]+?)"邀请你加入了群聊/,
+   */
+  const otherInviteYou = async () => {
+    let matches: null | string[] = null
+    OTHER_INVITE_YOU_REGEX_LIST.some((re) => !!(matches = message.msg.match(re)))
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+    if (matches) {
+      // @ts-ignore
+      await puppet._updateRoom(roomId)
+      const inviteName = matches[1]!
+      // @ts-ignore
+      const inviterId = await puppet._searchRoomMemberInfo(roomId, inviteName)
+
+      return {
+        inviteeIdList: [ puppet.currentUserId ],
+        inviterId,
+        roomId,
+        timestamp,
+      } as PUPPET.payloads.EventRoomJoin
+    }
+    return null
+  }
+
+  /**
+   * 3. Other invite you and others to join the room
+   * /^"([^"]+?)"邀请你和"(.+?)"加入了群聊/,
+   * /^"(.+)"邀请"(.+)"加入了群聊/,
+   */
+  const otherInviteOther = async () => {
+    let matches: null | string[] = null;
+    [ ...OTHER_INVITE_YOU_AND_OTHER_REGEX_LIST, ...OTHER_INVITE_OTHER_REGEX_LIST ].some((re) => !!(matches = message.msg.match(re)))
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+    if (matches) {
+      // @ts-ignore
+      await puppet._updateRoom(roomId)
+      const inviteeIdList = []
+      const inviterName = matches[1]
+      // @ts-ignore
+      const inviterId = await puppet._searchRoomMemberInfo(roomId, inviterName)
+      const inviteeName = matches[2]
+      // @ts-ignore
+      const inviteeId = await puppet._searchRoomMemberInfo(roomId, inviteeName)
+
+      // 如果包含ni则把机器人的id放进去
+      if (message.msg.includes('你')) {
+        inviteeIdList.push(puppet.currentUserId)
+      }
+      inviteeIdList.push(inviteeId)
+      return {
+        inviteeIdList,
+        inviterId,
+        roomId,
+        timestamp,
+      } as PUPPET.payloads.EventRoomJoin
+    }
+    return null
+  }
+
+  /**
+   * 4. Other Invite Other via Qrcode to join a Room
+   * /^" (.+)"通过扫描"(.+)"分享的二维码加入群聊/,
+   */
+  const otherJoinViaQrCode = async () => {
+    let matches: null | string[] = null
+    OTHER_JOIN_VIA_OTHER_QRCODE_REGEX_LIST.some((re) => !!(matches = message.msg.match(re)))
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+    if (matches) {
+      // @ts-ignore
+      await puppet._updateRoom(roomId)
+      const inviteeIdList = []
+
+      const inviteeName = matches[1]!
+      // @ts-ignore
+      const inviteeId = await puppet._searchRoomMemberInfo(roomId, inviteeName)
+      inviteeIdList.push(inviteeId)
+
+      const inviterName = matches[2]
+      // @ts-ignore
+      const inviterId = await puppet._searchRoomMemberInfo(roomId, inviterName)
+      return {
+        inviteeIdList,
+        inviterId,
+        roomId,
+        timestamp,
+      } as PUPPET.payloads.EventRoomJoin
+    }
+    return null
+  }
+  const ret = await executeRunners([ youInviteOther, otherInviteYou, otherInviteOther, otherJoinViaQrCode ])
+
+  return ret
+}

package/src/matrix/events/event-room-join.ts

@@ -119,7 +119,8 @@ export default async (puppet: PUPPET.Puppet, message: MessagePayload): Promise<E
   if (!matches) {
     return null
   }
-
+  // @ts-ignore
+  await puppet._updateRoom(roomId)
   const checkString = (inviteeIdList: string | string[]) => {
     return typeof inviteeIdList !== 'string'
       ? inviteeIdList

package/src/matrix/events/event-room-leave.ts

@@ -50,8 +50,6 @@ export default async (puppet: PUPPET.Puppet, message: MessagePayload): Promise<E
   if (!isRoomId(roomId) || message.msgType !== WechatMessageType.Sys) {
     return null
   }
-  // @ts-ignore
-  await puppet._updateRoom(roomId)
 
   /**
    * 1. 我将别人移除
@@ -63,8 +61,11 @@ export default async (puppet: PUPPET.Puppet, message: MessagePayload): Promise<E
     YOU_REMOVE_OTHER_REGEX_LIST.some((re) => !!(matches = message.msg.match(re)))
     // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
     if (matches) {
+      // @ts-ignore
+      await puppet._updateRoom(roomId)
       const removerName = matches[2]!
-      const removerId = (await puppet.roomMemberSearch(roomId, removerName))[0]!
+      // @ts-ignore
+      const removerId = await puppet._searchRoomMemberInfo(roomId, removerName)
 
       return {
         removeeIdList: [ removerId ],
@@ -88,7 +89,8 @@ export default async (puppet: PUPPET.Puppet, message: MessagePayload): Promise<E
     // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
     if (matches) {
       const removerName = matches[2]!
-      const removerId = (await puppet.roomMemberSearch(roomId, removerName))[0]!
+      // @ts-ignore
+      const removerId = await puppet._searchRoomMemberInfo(roomId, removerName)
 
       return {
         removeeIdList: [ puppet.currentUserId ],

package/src/matrix/events/event-room-topic.ts

@@ -47,7 +47,8 @@ export default async (puppet: PUPPET.Puppet, message: MessagePayload): Promise<E
       const changeName = match[1]
       let changeId = ''
       if (changeName) {
-        changeId = (await puppet.roomMemberSearch(roomId, changeName))[0]!
+        // @ts-ignore
+        changeId = await puppet._searchRoomMemberInfo(roomId, changeName)
       }
       return {
         changerId: changeId,

package/src/matrix/events/mod.ts

@@ -4,10 +4,12 @@ import roomJoinParser from './event-room-join.js'
 import roomLeaveParser from './event-room-leave.js'
 import roomTopicParser from './event-room-topic.js'
 import messageParser from './event-message.js'
+import roomJoinNoXmlParser from './event-room-join-no-xml.js'
 import { addEventParser, EventType, parseEvent } from './event.js'
 
 addEventParser(EventType.Friendship, friendShipParser)
 addEventParser(EventType.RoomInvite, roomInviteParser)
+addEventParser(EventType.RoomJoin, roomJoinNoXmlParser)
 addEventParser(EventType.RoomJoin, roomJoinParser)
 addEventParser(EventType.RoomLeave, roomLeaveParser)
 addEventParser(EventType.RoomTopic, roomTopicParser)

package/src/matrix/messages/sysmsg/message-revokemsg.ts

@@ -60,10 +60,9 @@ export async function getRevokeOriginalMessage (puppet: PUPPET.Puppet, revokemsg
 
 export async function getRevokeOperatorIdForRoomMessage (puppet: PUPPET.Puppet, revokemsgPayload:RevokeMsgMessagePayload) : Promise<string | null> {
   if (isRoomId(revokemsgPayload.session) || isIMRoomId(revokemsgPayload.session)) {
-    const contactIdList = await puppet.roomMemberSearch(revokemsgPayload.session, revokemsgPayload.operatorNickName!)
-    if (contactIdList.length) {
-      return contactIdList[0]!
-    }
+    // @ts-ignore
+    const contactId = await puppet._searchRoomMemberInfo(revokemsgPayload.session, revokemsgPayload.operatorNickName!)
+    return contactId
   }
 
   return null

package/src/matrix/schema-mapper/contact.ts

@@ -11,7 +11,7 @@ export function engineContactToWechaty (contact?: ContactPayload): PUPPET.payloa
       gender: contact.sex, // 性别
       id: contact.wxid, // wxid
       name: contact.name, // 昵称
-      friend: !!contact.isFriend, // 是否是好友
+      friend: contact.contactType === 2 || !!contact.isFriend, // 是否是好友
       phone: [],
       province: contact.province,
       signature: contact.sign, // 签名

package/src/matrix/service/request.ts

@@ -6,7 +6,7 @@ import WebSocket from 'ws'
 import * as PUPPET from '@juzi/wechaty-puppet'
 import { format, getUnixTime } from 'date-fns'
 import { xmlToJson } from '../utils/xml-to-json.js'
-import { isRoomId } from '../utils/is-type.js'
+import { isRoomId, getContactType } from '../utils/is-type.js'
 import imageSize from 'image-size'
 import fs from 'fs-extra'
 import os from 'os'
@@ -45,7 +45,12 @@ export enum NotifyTypeEnum {
   RoomMemberAdd = 1046, // set
   RoomMemberUpdate = 1047,
   RoomMemberDel = 1048, // set
-  SyncMsgFailed = 2006 // 需要调用 restore 接口
+  SyncMsgFailed = 2006, // 需要调用 restore 接口
+  WxNotifyTypeCmdIdModContact = 1200,
+  WxNotifyTypeCmdIdDelContact = 1201,
+  WxNotifyTypeOpenImContactAdd = 1202,
+  WxNotifyTypeOpenImContactDel = 1203,
+  WxNotifyTypeOpenImRoomContactChange = 1204,
 }
 
 /**
@@ -173,6 +178,8 @@ export interface ContactPayload {
    * 群公告
    */
   announcement?: string;
+  chatroomVersion?: number;
+  chatroomInfoVersion?: number;
 }
 
 /**
@@ -650,6 +657,7 @@ class Client extends EventEmitter {
   server: any
   tokenInfo: any
   hasEmitLogout: boolean
+  private lastInitSeqInfo: { contactSeq: number; roomSeq: number; }
 
   // @ts-ignore
   override emit(event: 'hook', detail: BaseEvent): boolean;
@@ -684,6 +692,7 @@ class Client extends EventEmitter {
     this.restoreTimes = 0
     this.maxRestoreTimes = 1
     this.hasExpired = false
+    this.lastInitSeqInfo = { contactSeq: 0, roomSeq: 0 }
   }
 
   destroy () {
@@ -917,24 +926,26 @@ class Client extends EventEmitter {
         this.emit('logout', data.errmsg)
         break
       case NotifyTypeEnum.RoomMemberAdd:
-        this.emit('room-join', {
-          roomId: data.room_username,
-          inviterId: data.member_list[0]?.invite_username,
-          joinIds: data.member_list.map((item: any) => item.username),
-          joinUsers: data.member_list.map((data: any) => ({
-            wxNum: data?.alias,
-            wxid: data?.username || '',
-            name: data?.nickname || '',
-            sex: data?.sex,
-            alias: '',
-            province: data?.province || '',
-            city: data?.city || '',
-            country: data?.country || '',
-            avatar: data?.big_headimg_url || data?.small_headimg_url || '',
-            description: '',
-            labelIdlist: data?.labelid_list,
-          })),
-        })
+        // @ts-ignore
+        // const params = {
+        //   roomId: data.room_username,
+        //   inviterId: data.member_list[0]?.invite_username,
+        //   joinIds: data.member_list.map((item: any) => item.username),
+        //   joinUsers: data.member_list.map((data: any) => ({
+        //     wxNum: data?.alias,
+        //     wxid: data?.username || '',
+        //     name: data?.nickname || '',
+        //     sex: data?.sex,
+        //     alias: '',
+        //     province: data?.province || '',
+        //     city: data?.city || '',
+        //     country: data?.country || '',
+        //     avatar: data?.big_headimg_url || data?.small_headimg_url || '',
+        //     description: '',
+        //     labelIdlist: data?.labelid_list,
+        //   })),
+        // }
+        // this.emit('room-join', params)
         break
       case NotifyTypeEnum.RoomMemberDel:
         // @ts-ignore
@@ -948,6 +959,11 @@ class Client extends EventEmitter {
           void this.restore()
         }
         break
+      case NotifyTypeEnum.WxNotifyTypeCmdIdModContact:
+      case NotifyTypeEnum.WxNotifyTypeCmdIdDelContact:
+        log.info('contact change sync start')
+        await this.syncContact(false)
+        break
       default:
         log.info('other data', JSON.stringify(data))
     }
@@ -1354,6 +1370,7 @@ class Client extends EventEmitter {
         if (contactInfo) {
           const contact = contactInfo.contact
           return {
+            contactType: getContactType(contact?.userName?.string || '', contact?.bitVal, contact?.verifyFlag),
             wxNum: contact.alias,
             wxid: contact?.userName?.string || '',
             name: contact?.nickName?.string || '',
@@ -1365,6 +1382,8 @@ class Client extends EventEmitter {
             avatar: contact?.bigHeadImgUrl || contact?.smallHeadImgUrl || '',
             description: contact?.description,
             labelIdlist: contact?.labelIdlist,
+            chatroomInfoVersion: contactInfo?.chatroomInfoVersion,
+            chatroomVersion: contactInfo?.chatroomVersion,
           }
         }
         return undefined
@@ -1373,6 +1392,7 @@ class Client extends EventEmitter {
           = res.contactList?.map((contactInfo: any) => {
             const contact = contactInfo.contact
             return {
+              contactType: getContactType(contact?.userName?.string || '', contact?.bitVal, contact?.verifyFlag),
               wxNum: contact.alias,
               wxid: contact?.userName?.string || '',
               name: contact?.nickName?.string || '',
@@ -1384,6 +1404,8 @@ class Client extends EventEmitter {
               avatar: contact?.bigHeadImgUrl || contact?.smallHeadImgUrl || '',
               description: contact?.description,
               labelIdlist: contact?.labelIdlist,
+              chatroomInfoVersion: contactInfo?.chatroomInfoVersion,
+              chatroomVersion: contactInfo?.chatroomVersion,
             }
           }) || []
         return contacts
@@ -1515,21 +1537,34 @@ class Client extends EventEmitter {
   /**
    * 同步联系人
    */
-  public async syncContact (): Promise<void> {
+  public async syncContact (init?: boolean): Promise<void> {
     try {
+      if (init) {
+        this.lastInitSeqInfo = { contactSeq: 0, roomSeq: 0 }
+      }
       const res = await this.postData({
         path: '/contact/init_contact',
         data: {
-          contact_seq: 0,
-          room_seq: 0,
+          contact_seq: this.lastInitSeqInfo.contactSeq || 0,
+          room_seq: this.lastInitSeqInfo.roomSeq || 0,
         },
       })
-      const contactUsernameList = res.contactUsernameList || []
-      const contactsInfo: ContactPayload[] = (await this.searchContact(
-        contactUsernameList,
-      )) as ContactPayload[]
-      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-      this.emit('update-contacts', contactsInfo || [])
+      const currentWxcontactSeq = res?.currentWxcontactSeq || 0
+      const currentRoomSeq = res?.currentChatRoomContactSeq || 0
+      const continueFlag = res?.continueFlag || false
+      this.lastInitSeqInfo = { contactSeq: currentWxcontactSeq, roomSeq: currentRoomSeq }
+      const contactUsernameList = res?.contactUsernameList || []
+      if (contactUsernameList.length) {
+        const contactsInfo = await this.searchContact(
+          contactUsernameList,
+        )
+        // @ts-ignore
+        this.emit('update-contacts', contactsInfo || [])
+      }
+
+      if (continueFlag) {
+        await this.syncContact()
+      }
     } catch (e) {
       log.error(PRE, 'syncContact(): %s', e)
     }
@@ -1672,16 +1707,18 @@ class Client extends EventEmitter {
         },
       })
       const memeberIdList: string[]
-        = res?.allMemberUserNameList.map((item: any) => item.string) || []
+        = res?.allMemberUserNameList?.map((item: any) => item.string) || []
       const allMemberCount = res.allMemberCount
       const ownerId = res.chatRoomOwner
       const adminIdList: string[]
-        = res?.adminUserNameList.map((item: any) => item.string) || []
+        = res?.adminUserNameList?.map((item: any) => item.string) || []
       const memberList: ContactPayload[] = res?.newChatroomData?.chatRoomMember
-        .filter((item: any) => item.username)
+        ?.filter((item: any) => item.userName)
         .map((item: any) => ({
-          wxid: item.username, // wxid
-          groupNick: item?.nickname, // 群昵称
+          wxid: item.userName, // wxid
+          name: item?.nickName,
+          displayName: item?.displayName,
+          groupNick: item?.nickName, // 群昵称
           avatarMinUrl: item?.smallHeadImgUrl,
           avatarMaxUrl: item?.bigHeadImgUrl,
           avatar: item?.bigHeadImgUrl || item?.smallHeadImgUrl, // 头像
@@ -1695,60 +1732,8 @@ class Client extends EventEmitter {
         memberList,
       }
     } catch (e) {
-      log.error(PRE, 'getGroupMembers(%s): %s', roomId, e)
-      return []
-    }
-  }
-
-  /**
-   * 获取群成员列表
-   * @param roomId 群id
-   * @param page
-   * @param pageSize
-   */
-  public async getGroupMembers (
-    roomId: string,
-    page: number = 1,
-    pageSize: number = 100,
-  ): Promise<ContactPayload[]> {
-    try {
-      const res = await this.postData({
-        path: '/room/get_chatroom_members',
-        data: {
-          room_username: roomId,
-          page_num: page,
-          page_size: pageSize,
-        },
-      })
-
-      const totalPage = res.total_page || 1
-      const memberList = res.room_list
-        .filter((item: any) => item.username)
-        .map((item: any) => ({
-          wxid: item.username, // wxid
-          groupNick: item?.nickname, // 群昵称
-          avatarMinUrl: item?.small_headimg_url,
-          avatarMaxUrl: item?.big_headimg_url,
-          avatar: item?.big_headimg_url || item?.small_headimg_url, // 头像
-          inviterUserName: item?.invite_username, // 邀请人
-          country: item?.country,
-          province: item?.province,
-          city: item?.city,
-          displayName: item?.display_name, // 群备注
-          sex: item?.sex,
-          wxNum: item?.alias,
-          alias: item?.remark,
-        }))
-
-      if (page < totalPage) {
-        const nextPageContacts = await this.getGroupMembers(roomId, page + 1, pageSize)
-        return memberList.concat(nextPageContacts)
-      } else {
-        return memberList
-      }
-    } catch (e) {
-      log.error(PRE, 'getGroupMembers(%s): %s', roomId, e)
-      return []
+      log.error(PRE, 'getGroupMembersDetail(%s): %s', roomId, e)
+      return {}
     }
   }
 

package/src/matrix/utils/is-type.ts

@@ -70,3 +70,37 @@ export function isPayload (payload?: object): boolean {
   }
   return false
 }
+
+export enum ContactType {
+  Stranger = 0,
+  System = 1,
+  Friend = 2,
+  Mp = 3,
+  ChatRoom = 4
+}
+
+export function getContactType (username: string, bitVal = 0, verifyFlag = 0) {
+
+  // 是群聊
+  if (username.includes('@chatroom')) {
+    return ContactType.ChatRoom
+  }
+
+  // 是公众号
+  if (verifyFlag !== 0) {
+    return ContactType.Mp
+  }
+
+  // 是系统账号
+  if (officeWxid.includes(username)) {
+    return ContactType.System
+  }
+
+  // 是好友
+  if ((bitVal & 1) === 1) {
+    return ContactType.Friend
+  }
+
+  // 陌生人
+  return ContactType.Stranger
+}