wechaty-puppet-matrix 0.0.4

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

@@ -0,0 +1,200 @@
+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'
+import { xmlToJson, getUserName } from '../utils/xml-to-json.js'
+
+const ROOM_JOIN_BOT_INVITE_OTHER_REGEX_LIST_ZH = [
+  /^你邀请"(.+)"加入了群聊 {2}\$revoke\$/,
+  /^" ?(.+)"通过扫描你分享的二维码加入群聊/,
+]
+
+const ROOM_JOIN_OTHER_INVITE_BOT_REGEX_LIST_ZH = [
+  /^"([^"]+?)"邀请你加入了群聊，群聊参与人还有：(.+)/,
+  /^"([^"]+?)"邀请你和"(.+?)"加入了群聊/,
+]
+const ROOM_JOIN_OTHER_INVITE_OTHER_REGEX_LIST_ZH = [
+  /^"(.+)"邀请"(.+)"加入了群聊/,
+]
+const ROOM_JOIN_OTHER_INVITE_OTHER_QRCODE_REGEX_LIST_ZH = [
+  /^" (.+)"通过扫描"(.+)"分享的二维码加入群聊/,
+]
+
+const ROOM_JOIN_BOT_INVITE_OTHER_REGEX_LIST_EN = [
+  /^You invited (.+) to the group chat/,
+  /^" ?(.+)" joined group chat via the QR code you shared/,
+]
+const ROOM_JOIN_OTHER_INVITE_BOT_REGEX_LIST_EN = [
+  /^(.+) invited you to a group chat with (.+)/,
+]
+const ROOM_JOIN_OTHER_INVITE_OTHER_REGEX_LIST_EN = [
+  /^(.+?) invited (.+?) to (the|a) group chat/,
+]
+const ROOM_JOIN_OTHER_INVITE_OTHER_QRCODE_REGEX_LIST_EN = [
+  /^"(.+)" joined the group chat via the QR Code shared by "(.+)"/,
+]
+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
+  }
+
+  const jsonPayload = await xmlToJson(message.msg)
+  if (
+    !jsonPayload
+      || !jsonPayload.sysmsg
+      || !jsonPayload.sysmsg.sysmsgtemplate
+  ) {
+    return null
+  }
+
+  const content = jsonPayload.sysmsg.sysmsgtemplate.content_template.template
+  const linkList
+      = jsonPayload.sysmsg.sysmsgtemplate.content_template.link_list.link
+
+  /**
+   * Process English language
+   */
+  let matchesForBotInviteOtherEn = null as null | string[]
+  let matchesForOtherInviteBotEn = null as null | string[]
+  let matchesForOtherInviteOtherEn = null as null | string[]
+  let matchesForOtherInviteOtherQrcodeEn = null as null | string[]
+
+  ROOM_JOIN_BOT_INVITE_OTHER_REGEX_LIST_EN.some(
+    (regex) => !!(matchesForBotInviteOtherEn = content.match(regex)),
+  )
+  ROOM_JOIN_OTHER_INVITE_BOT_REGEX_LIST_EN.some(
+    (regex) => !!(matchesForOtherInviteBotEn = content.match(regex)),
+  )
+  ROOM_JOIN_OTHER_INVITE_OTHER_REGEX_LIST_EN.some(
+    (regex) => !!(matchesForOtherInviteOtherEn = content.match(regex)),
+  )
+  ROOM_JOIN_OTHER_INVITE_OTHER_QRCODE_REGEX_LIST_EN.some(
+    (regex) => !!(matchesForOtherInviteOtherQrcodeEn = content.match(regex)),
+  )
+
+  /**
+   * Process Chinese language
+   */
+  let matchesForBotInviteOtherZh = null as null | string[]
+  let matchesForOtherInviteBotZh = null as null | string[]
+  let matchesForOtherInviteOtherZh = null as null | string[]
+  let matchesForOtherInviteOtherQrcodeZh = null as null | string[]
+
+  ROOM_JOIN_BOT_INVITE_OTHER_REGEX_LIST_ZH.some(
+    (regex) => !!(matchesForBotInviteOtherZh = content.match(regex)),
+  )
+  ROOM_JOIN_OTHER_INVITE_BOT_REGEX_LIST_ZH.some(
+    (regex) => !!(matchesForOtherInviteBotZh = content.match(regex)),
+  )
+  ROOM_JOIN_OTHER_INVITE_OTHER_REGEX_LIST_ZH.some(
+    (regex) => !!(matchesForOtherInviteOtherZh = content.match(regex)),
+  )
+  ROOM_JOIN_OTHER_INVITE_OTHER_QRCODE_REGEX_LIST_ZH.some(
+    (regex) => !!(matchesForOtherInviteOtherQrcodeZh = content.match(regex)),
+  )
+
+  const matchesForBotInviteOther
+      = matchesForBotInviteOtherEn || matchesForBotInviteOtherZh
+  const matchesForOtherInviteBot
+      = matchesForOtherInviteBotEn || matchesForOtherInviteBotZh
+  const matchesForOtherInviteOther
+      = matchesForOtherInviteOtherEn || matchesForOtherInviteOtherZh
+  const matchesForOtherInviteOtherQrcode
+      = matchesForOtherInviteOtherQrcodeEn || matchesForOtherInviteOtherQrcodeZh
+
+  const matches
+      = matchesForBotInviteOther
+      || matchesForOtherInviteBot
+      || matchesForOtherInviteOther
+      || matchesForOtherInviteOtherQrcode
+
+  if (!matches) {
+    return null
+  }
+
+  const checkString = (inviteeIdList: string | string[]) => {
+    return typeof inviteeIdList !== 'string'
+      ? inviteeIdList
+      : [ inviteeIdList ]
+  }
+
+  /**
+   * Parse all Names From the Event Text
+   */
+  if (matchesForBotInviteOther) {
+    /**
+       * 1. Bot Invite Other to join the Room
+       *  (include invite via QrCode)
+       */
+    const other = matches[1] || ''
+    const inviteeIdList = getUserName(linkList, other)
+
+    return {
+      inviteeIdList: checkString(inviteeIdList),
+      inviterId: puppet.currentUserId,
+      roomId,
+      timestamp,
+    } as PUPPET.payloads.EventRoomJoin
+  } else if (matchesForOtherInviteBot) {
+    /**
+       * 2. Other Invite Bot to join the Room
+       */
+    // /^"([^"]+?)"邀请你加入了群聊/,
+    // /^"([^"]+?)"邀请你和"(.+?)"加入了群聊/,
+    const _inviterName = matches[1] || ''
+    const inviterId = getUserName(linkList, _inviterName)
+
+    return {
+      inviteeIdList: [ puppet.currentUserId ],
+      inviterId,
+      roomId,
+      timestamp,
+    } as PUPPET.payloads.EventRoomJoin
+  } else if (matchesForOtherInviteOther) {
+    /**
+       * 3. Other Invite Other to a Room
+       *  (NOT include invite via Qrcode)
+       */
+    // /^"([^"]+?)"邀请"([^"]+)"加入了群聊$/,
+    // /^([^"]+?) invited ([^"]+?) to (the|a) group chat/,
+    const _inviterName = matches[1] || ''
+    const inviterId = getUserName(linkList, _inviterName)
+
+    const _others = matches[2] || ''
+    const inviteeIdList = getUserName(linkList, _others)
+
+    return {
+      inviteeIdList: checkString(inviteeIdList),
+      inviterId,
+      roomId,
+      timestamp,
+    } as PUPPET.payloads.EventRoomJoin
+  } else if (matchesForOtherInviteOtherQrcode) {
+    /**
+       * 4. Other Invite Other via Qrcode to join a Room
+       *   /^" (.+)"通过扫描"(.+)"分享的二维码加入群聊/,
+       */
+    const _inviterName = matches[2] || ''
+    const inviterId = getUserName(linkList, _inviterName)
+
+    const other = matches[1] || ''
+    const inviteeIdList = getUserName(linkList, other)
+
+    return {
+      inviteeIdList: checkString(inviteeIdList),
+      inviterId,
+      roomId,
+      timestamp,
+    } as PUPPET.payloads.EventRoomJoin
+  }
+
+  return null
+}

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

@@ -0,0 +1,111 @@
+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'
+import { executeRunners } from '../utils/runner.js'
+
+const YOU_REMOVE_OTHER_REGEX_LIST = [
+  /^(你)将"(.+)"移出了群聊/,
+  /^(You) removed "(.+)" from the group chat/,
+]
+const OTHER_REMOVE_YOU_REGEX_LIST = [
+  /^(你)被"([^"]+?)"移出群聊/,
+  /^(You) were removed from the group chat by "([^"]+)"/,
+]
+
+const roomLeaveDebounceMap: Map<string, ReturnType<typeof setTimeout>> = new Map()
+const DEBOUNCE_TIMEOUT = 3600 * 1000 // 1 hour
+
+function roomLeaveDebounceKey (roomId: string, removeeId: string) {
+  return `${roomId}:${removeeId}`
+}
+
+function roomLeaveAddDebounce (roomId: string, removeeId: string) {
+  const key = roomLeaveDebounceKey(roomId, removeeId)
+  const oldTimeout = roomLeaveDebounceMap.get(key)
+  if (oldTimeout) {
+    clearTimeout(oldTimeout)
+  }
+
+  const timeout = setTimeout(() => {
+    roomLeaveDebounceMap.delete(key)
+  }, DEBOUNCE_TIMEOUT)
+  roomLeaveDebounceMap.set(key, timeout)
+}
+
+// to fix: https://github.com/padlocal/wechaty-puppet-padlocal/issues/43
+export function removeRoomLeaveDebounce (roomId: string, removeeId: string) {
+  const key = roomLeaveDebounceKey(roomId, removeeId)
+  roomLeaveDebounceMap.delete(key)
+}
+
+export function isRoomLeaveDebouncing (roomId: string, removeeId: string): boolean {
+  const key = roomLeaveDebounceKey(roomId, removeeId)
+  return roomLeaveDebounceMap.get(key) !== undefined
+}
+
+export default async (puppet: PUPPET.Puppet, message: MessagePayload): Promise<EventPayload> => {
+  const roomId = message.fromWxid || ''
+  if (!isRoomId(roomId) || message.msgType !== WechatMessageType.Sys) {
+    return null
+  }
+  // @ts-ignore
+  await puppet._updateRoom(roomId)
+
+  /**
+   * 1. 我将别人移除
+   * /^(你)将"(.+)"移出了群聊/,
+   *  我移除别人是 10000: https://gist.github.com/padlocal/5676b96ad0ca918fdd53849417eff422
+   */
+  const youRemoveOther = async () => {
+    let matches: null | string[] = null
+    YOU_REMOVE_OTHER_REGEX_LIST.some((re) => !!(matches = message.msg.match(re)))
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+    if (matches) {
+      const removerName = matches[2]!
+      const removerId = (await puppet.roomMemberSearch(roomId, removerName))[0]!
+
+      return {
+        removeeIdList: [ removerId ],
+        removerId: puppet.currentUserId,
+        roomId,
+        timestamp: message.timeStamp,
+      } as PUPPET.payloads.EventRoomLeave
+    }
+    return null
+  }
+
+  /**
+   * 2. 别人移除我
+   * /^(你)被"([^"]+?)"移出群聊/,
+   * // 我被别人移除是 10000：https://gist.github.com/padlocal/60be89334d4d743937f07023da20291e
+   */
+  const otherRemoveYou = async () => {
+    let matches: null | string[] = null
+    OTHER_REMOVE_YOU_REGEX_LIST.some((re) => !!(matches = message.msg.match(re)))
+
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+    if (matches) {
+      const removerName = matches[2]!
+      const removerId = (await puppet.roomMemberSearch(roomId, removerName))[0]!
+
+      return {
+        removeeIdList: [ puppet.currentUserId ],
+        removerId,
+        roomId,
+        timestamp: message.timeStamp,
+      } as PUPPET.payloads.EventRoomLeave
+    }
+
+    return null
+  }
+
+  const ret = await executeRunners<PUPPET.payloads.EventRoomLeave>([ youRemoveOther, otherRemoveYou ])
+  if (ret) {
+    ret.removeeIdList.forEach((leaverId) => {
+      roomLeaveAddDebounce(roomId, leaverId)
+    })
+  }
+  return ret
+}

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

@@ -0,0 +1,73 @@
+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 { parseTextWithRegexList } from '../utils/regex.js'
+import { WechatMessageType } from '../types.js'
+import { executeRunners } from '../utils/runner.js'
+
+const OTHER_CHANGE_TOPIC_REGEX_LIST = [
+  /^"(.+)"修改群名为“(.+)”$/,
+  /^"(.+)" changed the group name to "(.+)"$/,
+]
+const YOU_CHANGE_TOPIC_REGEX_LIST = [
+  /^(你)修改群名为“(.+)”$/,
+  /^(You) changed the group name to "(.+)"$/,
+]
+
+type TopicChange = {changerId: string, newTopic: string};
+
+export default async (puppet: PUPPET.Puppet, message: MessagePayload): Promise<EventPayload> => {
+  const roomId = message.fromWxid || ''
+  if (!isRoomId(roomId) || message.msgType !== WechatMessageType.Sys) {
+    return null
+  }
+
+  /**
+   * 1. Message payload "you change the room topic" is plain text with type 10000 : https://gist.github.com/padlocal/0c7bb4f5d51e7e94a0efa108bebb4645
+   * 你修改群名
+   */
+  const youChangeTopic = async () => {
+    return parseTextWithRegexList(message.msg, YOU_CHANGE_TOPIC_REGEX_LIST, async (_, match) => {
+      const newTopic = match[2]
+      return {
+        changerId: puppet.currentUserId,
+        newTopic,
+      } as TopicChange
+    })
+  }
+
+  /**
+   * 2. Message payload "others change room topic" is xml text with type 10002: https://gist.github.com/padlocal/3480ada677839c8c11578d47e820e893
+   * 别人修改群名
+   */
+  const otherChangeTopic = async () => {
+    return parseTextWithRegexList(message.msg, OTHER_CHANGE_TOPIC_REGEX_LIST, async (_, match) => {
+      const newTopic = match[2]
+      const changeName = match[1]
+      let changeId = ''
+      if (changeName) {
+        changeId = (await puppet.roomMemberSearch(roomId, changeName))[0]!
+      }
+      return {
+        changerId: changeId,
+        newTopic,
+      } as TopicChange
+    })
+  }
+
+  const topicChange = await executeRunners<TopicChange>([ youChangeTopic, otherChangeTopic ])
+  if (topicChange) {
+    const room = await puppet.roomPayload(roomId)
+    const oldTopic = room.topic
+    return {
+      changerId: topicChange.changerId,
+      newTopic: topicChange.newTopic,
+      oldTopic,
+      roomId,
+      timestamp: message.timeStamp,
+    } as PUPPET.payloads.EventRoomTopic
+  }
+
+  return null
+}

package/src/matrix/events/event.ts

@@ -0,0 +1,60 @@
+import { Puppet, log } from '@juzi/wechaty-puppet'
+import type * as PUPPET from '@juzi/wechaty-puppet'
+import type { MessagePayload } from '../../engine-schema.js'
+
+export enum EventType {
+  Message,
+  Friendship,
+  RoomInvite,
+  RoomJoin,
+  RoomLeave,
+  RoomTopic,
+}
+
+export interface EventPayloadSpec {
+  [EventType.Message]: MessagePayload;
+  [EventType.Friendship]: PUPPET.payloads.Friendship;
+  [EventType.RoomInvite]: PUPPET.payloads.RoomInvitation;
+  [EventType.RoomJoin]: PUPPET.payloads.EventRoomJoin;
+  [EventType.RoomLeave]: PUPPET.payloads.EventRoomLeave;
+  [EventType.RoomTopic]: PUPPET.payloads.EventRoomTopic;
+}
+
+export interface Event<T extends keyof EventPayloadSpec> {
+  type: T;
+  payload: EventPayloadSpec[T];
+}
+
+export type EventPayload = EventPayloadSpec[keyof EventPayloadSpec] | null;
+export type EventParserHandler = (puppet: Puppet, message: MessagePayload) => Promise<EventPayload>;
+type EventParser = { type: EventType, handler: EventParserHandler, };
+
+const EventParserList: Array<EventParser> = []
+export function addEventParser (eventType: EventType, parser: EventParserHandler): void {
+  EventParserList.push({
+    handler: parser,
+    type: eventType,
+  })
+}
+
+export async function parseEvent (puppet: Puppet, message: MessagePayload): Promise<Event<any>> {
+  for (const parser of EventParserList) {
+    try {
+      const parsedPayload = await parser.handler(puppet, message)
+      if (parsedPayload) {
+        return {
+          payload: parsedPayload,
+          type: parser.type,
+        }
+      }
+    } catch (e) {
+      log.error('[Event]', `parse message error: ${(e as Error).stack}`)
+    }
+  }
+
+  // return normal as message bvy default
+  return {
+    payload: message,
+    type: EventType.Message,
+  }
+}

package/src/matrix/events/mod.ts

@@ -0,0 +1,16 @@
+import friendShipParser from './event-friendship.js'
+import roomInviteParser from './event-room-invite.js'
+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 { addEventParser, EventType, parseEvent } from './event.js'
+
+addEventParser(EventType.Friendship, friendShipParser)
+addEventParser(EventType.RoomInvite, roomInviteParser)
+addEventParser(EventType.RoomJoin, roomJoinParser)
+addEventParser(EventType.RoomLeave, roomLeaveParser)
+addEventParser(EventType.RoomTopic, roomTopicParser)
+addEventParser(EventType.Message, messageParser)
+
+export { parseEvent, EventType }

package/src/matrix/messages/message-appmsg.ts

@@ -0,0 +1,131 @@
+/* eslint-disable @typescript-eslint/no-unnecessary-condition */
+import { xmlToJson } from '../utils/xml-to-json.js'
+
+interface AppMsgXmlSchema {
+  msg: {
+    appmsg: {
+      title: string;
+      des: string;
+      type: string;
+      url: string;
+      appattach: {
+        totallen: string;
+        attachid: string;
+        emoticonmd5: string;
+        fileext: string;
+        cdnattachurl: string;
+        cdnthumbaeskey: string;
+        aeskey: string;
+        encryver: string;
+        islargefilemsg: string;
+      };
+      thumburl: string;
+      md5: any;
+      recorditem?: string;
+      refermsg?: {
+        type: string;
+        svrid: string;
+        fromusr: string;
+        chatusr: string;
+        displayname: string;
+        content: string;
+      };
+    };
+    fromusername: string;
+    appinfo: {
+      appname: any;
+    };
+  };
+}
+
+export enum AppMessageType {
+  Text = 1,
+  Img = 2,
+  Audio = 3,
+  Video = 4,
+  Url = 5,
+  Attach = 6,
+  Open = 7,
+  Emoji = 8,
+  VoiceRemind = 9,
+  ScanGood = 10,
+  Good = 13,
+  Emotion = 15,
+  CardTicket = 16,
+  RealtimeShareLocation = 17,
+  ChatHistory = 19,
+  MiniProgram = 33,
+  MiniProgramApp = 36, // this is forwardable mini program
+  GroupNote = 53,
+  ReferMsg = 57,
+  Transfers = 2000,
+  RedEnvelopes = 2001,
+  ReaderType = 100001,
+}
+
+export interface AppAttachPayload {
+  totallen?: number;
+  attachid?: string;
+  emoticonmd5?: string;
+  fileext?: string;
+  cdnattachurl?: string;
+  aeskey?: string;
+  cdnthumbaeskey?: string;
+  encryver?: number;
+  islargefilemsg: number;
+}
+
+export interface ReferMsgPayload {
+  type: string;
+  svrid: string;
+  fromusr: string;
+  chatusr: string;
+  displayname: string;
+  content: string;
+}
+
+export interface AppMessagePayload {
+  des?: string;
+  thumburl?: string;
+  title: string;
+  url: string;
+  appattach?: AppAttachPayload;
+  type: AppMessageType;
+  md5?: string;
+  fromusername?: string;
+  recorditem?: string;
+  refermsg?: ReferMsgPayload;
+}
+
+export async function parseAppmsgMessagePayload (messageContent: string): Promise<AppMessagePayload> {
+  const appMsgXml: AppMsgXmlSchema = await xmlToJson(messageContent)
+  const { title, des, url, thumburl, type, md5, recorditem } = appMsgXml?.msg.appmsg
+
+  let appattach: AppAttachPayload | undefined
+  const tmp = appMsgXml?.msg.appmsg.appattach
+  if (tmp) {
+    appattach = {
+      aeskey: tmp.aeskey,
+      attachid: tmp.attachid,
+      cdnattachurl: tmp.cdnattachurl,
+      cdnthumbaeskey: tmp.cdnthumbaeskey,
+      emoticonmd5: tmp.emoticonmd5,
+      encryver: (tmp.encryver && parseInt(tmp.encryver, 10)) || 0,
+      fileext: tmp.fileext,
+      islargefilemsg: (tmp.islargefilemsg && parseInt(tmp.islargefilemsg, 10)) || 0,
+      totallen: (tmp.totallen && parseInt(tmp.totallen, 10)) || 0,
+    }
+  }
+
+  return {
+    appattach,
+    des,
+    md5,
+    recorditem,
+    refermsg: appMsgXml.msg.appmsg.refermsg,
+    thumburl,
+    title,
+    type: parseInt(type, 10),
+    url,
+  }
+}

package/src/matrix/messages/message-audio.ts

@@ -0,0 +1,48 @@
+import { MessagePayload } from '../../engine-schema.js'
+import { xmlToJson } from '../utils/xml-to-json.js'
+
+export interface VoiceXmlSchema {
+    msg: {
+      voicemsg: {
+        $: {
+          endflag: string
+          cancelflag: string
+          forwardflag: string
+          voiceformat: string
+          voicelength: string
+          length: string
+          bufid: string
+          aeskey: string
+          voiceurl: string
+          voicemd5: string
+          clientmsgid: string
+          fromusername: string
+      }
+        }
+    }
+}
+
+export interface AudioMessagePayload {
+  aesKey: string,
+  length: string,
+  voicelength: string,
+  voiceurl: string,
+  voicemd5: string,
+  clientmsgid: string,
+  fromusername: string,
+}
+
+export async function parseAudioMessagePayload (rawPayload: MessagePayload): Promise<AudioMessagePayload> {
+  const audioXml: VoiceXmlSchema = await xmlToJson(rawPayload.msg)
+  const schema = audioXml.msg.voicemsg.$
+
+  return {
+    aesKey: schema.aeskey,
+    length: schema.length,
+    voicelength: schema.length,
+    voiceurl: schema.voiceurl,
+    voicemd5: schema.voicemd5,
+    clientmsgid: schema.clientmsgid,
+    fromusername: schema.fromusername,
+  }
+}