wechaty-puppet-matrix 0.0.55 → 0.0.56

package/src/puppet-matrix.ts

@@ -20,11 +20,12 @@ import { isIMContactId, isRoomId } from './matrix/utils/is-type.js'
 import { AppMessagePayload, AppMessageType, parseAppmsgMessagePayload } from './matrix/messages/message-appmsg.js'
 import { parseRecordItem, RecordItem, RecordItemType } from './matrix/messages/message-chat-history.js'
 import { parseMiniProgramMessagePayload } from './matrix/messages/message-miniprogram.js'
-import { parseEmotionMessagePayload } from './matrix/messages/message-emotion.js'
+import { EmojiMessagePayload, parseEmotionMessagePayload } from './matrix/messages/message-emotion.js'
 import { ImageMessagePayload, parseImageMessagePayload } from './matrix/messages/message-image.js'
 import { parseAudioMessagePayload, AudioMessagePayload } from './matrix/messages/message-audio.js'
 import { parseVideoMessagePayload, VideoMessagePayload } from './matrix/messages/message-video.js'
 import { parseLocationMessagePayload } from './matrix/messages/message-location.js'
+import { ContactCardPayload, parseContactCardMessagePayload } from './matrix/messages/message-contact-card.js'
 import { CachedPromiseFunc } from './matrix/utils/cached-promise.js'
 import { engineMessageToWechaty } from './matrix/schema-mapper/message.js'
 import { engineContactToWechaty } from './matrix/schema-mapper/contact.js'
@@ -36,7 +37,6 @@ import {
 import { parseEvent, EventType } from './matrix/events/mod.js'
 import { addRunningPuppet, removeRunningPuppet } from './cleanup.js'
 import { packageJson } from './package-json.js'
-import { JsonToXml } from './matrix/utils/xml-to-json.js'
 
 const VERSION = packageJson.version || '0.0.0'
 const PRE = '[PuppetMatrix]'
@@ -656,7 +656,8 @@ class PuppetMatrix extends PUPPET.Puppet {
         hello = (option as any).hello
       }
     }
-    await this._client?.addFriendByWxid({ content: hello, ticket, scene: addContactScene, wxid: contactId })
+    // 搜索联系人的 id 带有 SEARCH_CONTACT_PREFIX, 真实用户名在缓存的 wxid 里
+    await this._client?.addFriendByWxid({ content: hello, ticket, scene: addContactScene, wxid: cachedContactSearch?.wxid || contactId })
   }
 
   /**
@@ -725,7 +726,70 @@ class PuppetMatrix extends PUPPET.Puppet {
   // 名片
   override async messageContact (messageId: string): Promise<string> {
     log.verbose('PuppetWeChat', 'messageContact(%s)', messageId)
-    return PUPPET.throwUnsupportedError(messageId)
+    const rawPayload = await this.messageRawPayload(messageId)
+    if (rawPayload.msgType !== WechatMessageType.ShareCard) {
+      throw new Error(`message ${messageId} is not a contact card`)
+    }
+    const card = await parseContactCardMessagePayload(rawPayload.msg)
+    if (!card) {
+      throw new Error(`can not parse contact card from message ${messageId}`)
+    }
+
+    // 好友名片: username 就是 wxid
+    if (!card.username.includes(STRANGER_SUFFIX)) {
+      return card.username
+    }
+
+    // 微信发出的名片即便是好友也只带 v3 加密名, 尝试在本地联系人中匹配出 wxid
+    const friendId = await this._findFriendByCard(card)
+    if (friendId) {
+      log.verbose(PRE, 'messageContact(%s) matched friend %s', messageId, friendId)
+      return friendId
+    }
+
+    // 非好友名片: 缓存为搜索联系人, friendshipAdd 可用 scene 17 + v4 票据添加
+    const searchId = `${SEARCH_CONTACT_PREFIX}${card.username}`
+    await this._cacheMgr!.setContactSearch(searchId, {
+      alias: '',
+      avatar: card.avatar,
+      city: card.city,
+      country: '',
+      isFriend: 0,
+      name: card.nickname,
+      province: card.province,
+      scene: card.scene,
+      sex: card.sex,
+      sign: card.sign,
+      ticket: card.antispamticket,
+      wxNum: card.alias,
+      wxid: card.username,
+    })
+    return searchId
+  }
+
+  /**
+   * 名片(v3 加密名) -> 本地好友 wxid
+   * 先按头像路径匹配(忽略 /0 /132 尺寸后缀), 再按唯一昵称匹配
+   */
+  private async _findFriendByCard (card: ContactCardPayload): Promise<string | undefined> {
+    const avatarKey = (url?: string) => (url || '').replace(/^https?:\/\//, '').replace(/\/\d+$/, '')
+    const cardAvatar = avatarKey(card.avatar)
+    const contacts = (await this._cacheMgr!.getAllContacts())
+      .filter(c => c.wxid && !isRoomId(c.wxid) && !c.wxid.includes(STRANGER_SUFFIX) && c.isFriend !== 0)
+
+    if (cardAvatar) {
+      const byAvatar = contacts.find(c => avatarKey(c.avatar) === cardAvatar)
+      if (byAvatar) {
+        return byAvatar.wxid
+      }
+    }
+    if (card.nickname) {
+      const byName = contacts.filter(c => c.name === card.nickname)
+      if (byName.length === 1) {
+        return byName[0]!.wxid
+      }
+    }
+    return undefined
   }
 
   override async messageChannel (
@@ -775,12 +839,22 @@ class PuppetMatrix extends PUPPET.Puppet {
         return this._getMessageFileFileBox(messageId, messagePayload)
       case PUPPET.types.Message.Emoticon: {
         const emotionPayload = await parseEmotionMessagePayload(messagePayload)
-        const emoticonBox = emotionPayload.is_ww ? await this._client?.downloadWWMedia({
-          aes_key: emotionPayload.aeskey || '',
-          auth_key: emotionPayload.authkey || '',
-          file_id: emotionPayload.cdnurl || '',
-          file_name: `message-${messageId}-emoticon.jpg`,
-        }, 3) : FileBox.fromUrl(emotionPayload.cdnurl, { name: `message-${messageId}-emoticon.jpg` })
+        // downloadWWMedia 返回的是下载地址字符串
+        const url: string = emotionPayload.is_ww
+          ? (await this._client?.downloadWWMedia({
+              aes_key: emotionPayload.aeskey || '',
+              auth_key: emotionPayload.authkey || '',
+              file_id: emotionPayload.cdnurl || '',
+              file_name: `message-${messageId}-emoticon.gif`,
+            }, 3)) || ''
+          : emotionPayload.cdnurl
+        if (!url) {
+          throw new Error(`Can not get emoticon url for message: ${messageId}`)
+        }
+        // 按文件头确定扩展名（静态多为 png，动图为 gif），识别失败时按表情类型猜测
+        const head = await fetchRemoteHead(url)
+        const ext = (head && detectImageExt(head)) || (emotionPayload.type === 2 && !emotionPayload.game ? 'gif' : 'png')
+        const emoticonBox = FileBox.fromUrl(url, { name: `message-${messageId}-emoticon.${ext}` })
 
         emoticonBox.metadata = {
           payload: emotionPayload,
@@ -954,28 +1028,14 @@ class PuppetMatrix extends PUPPET.Puppet {
    ***************************************************************************/
   // 发送名片
   override async messageSendContact (toUserId: string, contactId: string): Promise<void | string> {
-    log.verbose('PuppetWeChat', 'messageSend("%s", %s)', toUserId, contactId)
+    log.verbose('PuppetWeChat', 'messageSendContact("%s", %s)', toUserId, contactId)
     const contactPayload = await this.contactRawPayload(contactId)
-    const xmlObj = {
-      msg: {
-        antispamticket: '', // TODO 需要考虑怎么设置
-        bigheadimgurl: contactPayload?.avatar,
-        brandFlags: '0',
-        certflag: '0',
-        city: contactPayload?.city,
-        fullpy: contactPayload?.name,
-        imagestatus: '3',
-        nickname: contactPayload?.name,
-        province: contactPayload?.province,
-        regionCode: 'CN_Shanghai',
-        scene: '17',
-        sex: contactPayload?.sex,
-        smallheadimgurl: contactPayload?.avatar,
-        username: contactPayload?.ticket,
-      },
-    }
-    const xml = JsonToXml(xmlObj)
-    const res = await this._client?.sendContactCard(toUserId, xml, this._self?.wxid)
+    const res = await this._client?.sendContact({
+      shareHeadImg: contactPayload?.avatar,
+      shareId: contactPayload?.wxid || contactId,
+      shareNickname: contactPayload?.name,
+      toId: toUserId,
+    }, this._self?.wxid)
     if (res) {
       await this._cacheMgr?.setMessage(res.id, res)
       return res.id
@@ -994,7 +1054,17 @@ class PuppetMatrix extends PUPPET.Puppet {
     // @ts-ignore
     const fileUrl = fileBox.remoteUrl || ''
     if (metadata.type === 'emoticon') {
-      PUPPET.throwUnsupportedError(conversationId, fileBox)
+      // 优先 md5 发送（收到的表情原样转发、骰子/猜拳均可），失败再按 url 发送
+      const emoji = metadata.payload as EmojiMessagePayload | undefined
+      const byMd5 = emoji?.md5 && emoji.len
+        ? await this._client?.sendEmojiMd5(conversationId, emoji.md5, emoji.len, this._self?.wxid)
+        : undefined
+      const msgInfo = byMd5 || (fileUrl ? await this._client?.sendEmojiUrl(conversationId, fileUrl, this._self?.wxid) : undefined)
+      if (!msgInfo) {
+        throw new Error(`send emoticon failed: ${fileBox.name}`)
+      }
+      await this._cacheMgr?.setMessage(msgInfo.id, msgInfo)
+      return msgInfo.id
     } else if (fileBox.mediaType.startsWith('image/')) {
       if (fileUrl) {
         const msgInfo = await this._client?.sendUrlImg(conversationId, fileUrl, this._self?.wxid)
@@ -1115,11 +1185,37 @@ class PuppetMatrix extends PUPPET.Puppet {
   }
 
   /**
-   * 消息撤回 暂不支持
+   * 拍一拍（Wechaty 无标准接口，通过 bot.puppet 调用）
+   * @param conversationId 会话 id：私聊为好友 wxid，群聊为群 id
+   * @param contactId 被拍的人 wxid，私聊时默认拍对方
+   */
+  public async sendPat (conversationId: string, contactId?: string): Promise<boolean> {
+    log.verbose(PRE, 'sendPat(%s, %s)', conversationId, contactId)
+    const patted = contactId || conversationId
+    if (isRoomId(patted)) {
+      throw new Error('sendPat: contactId is required in room')
+    }
+    return (await this._client?.sendPat(conversationId, patted)) || false
+  }
+
+  /**
+   * 消息撤回（只能撤回自己发送的消息）
    * @param messageId
    */
   override async messageRecall (messageId: string): Promise<boolean> {
-    return PUPPET.throwUnsupportedError(messageId)
+    log.verbose(PRE, 'messageRecall(%s)', messageId)
+    const payload = await this._cacheMgr?.getMessage(messageId)
+    if (!payload) {
+      log.warn(PRE, 'messageRecall(%s): message not found in cache', messageId)
+      return false
+    }
+    // 自己发送的消息 listenerId 为会话 id（好友 wxid 或群 id）
+    const toId = payload.listenerId || payload.fromWxid || ''
+    if (!toId) {
+      log.warn(PRE, 'messageRecall(%s): can not find conversation id', messageId)
+      return false
+    }
+    return (await this._client?.revokeMsg(toId, messageId, payload.clientMsgId)) || false
   }
 
   /**