wechaty-puppet-matrix 0.0.53 → 0.0.55

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

@@ -50,9 +50,17 @@ export interface VideoMessagePayload {
   thumb_size: string,
   thumb_width: string,
   thumb_height: string,
-  file_name: ''
+  file_name: '',
+  /**
+   * 按优先级排列的下载候选，第一项即 file_id/file_size。
+   * 实测 XML 的 length 可能和 CDN 实际大小不一致 (expected 766838, got 1228708)，
+   * 有原始视频时回落到 cdnrawvideourl + rawlength
+   */
+  candidates?: Array<{ file_id: string, file_size: string, aes_key?: string }>,
 }
 
+const isPositiveSize = (size?: string): size is string => !!size && Number(size) > 0
+
 export async function parseVideoMessagePayload (rawPayload: MessagePayload): Promise<VideoMessagePayload> {
   const videoXml: VideoXmlSchema = await xmlToJson(rawPayload.msg)
   const videoSchema = videoXml.msg.videomsg.$
@@ -70,5 +78,24 @@ export async function parseVideoMessagePayload (rawPayload: MessagePayload): Pro
     thumb_width: videoSchema.cdnthumbwidth || videoSchema.tpthumbwidth || '',
     thumb_height: videoSchema.cdnthumbheight || videoSchema.tpthumbheight || '',
     file_name: '',
+    candidates: buildVideoCandidates(videoSchema),
+  }
+}
+
+export function buildVideoCandidates (schema: VideoXmlSchema['msg']['videomsg']['$']): VideoMessagePayload['candidates'] {
+  if (schema.tpvideourl) {
+    return undefined
+  }
+  const candidates: NonNullable<VideoMessagePayload['candidates']> = []
+  if (schema.cdnvideourl && isPositiveSize(schema.length)) {
+    candidates.push({ file_id: schema.cdnvideourl, file_size: schema.length })
+  }
+  if (schema.cdnrawvideourl && isPositiveSize(schema.rawlength)) {
+    candidates.push({
+      file_id: schema.cdnrawvideourl,
+      file_size: schema.rawlength,
+      aes_key: schema.cdnrawvideoaeskey || schema.aeskey,
+    })
   }
+  return candidates.length ? candidates : undefined
 }

package/src/matrix/service/request.ts

@@ -285,12 +285,29 @@ export interface BaseEvent {
   robotInfo?: ContactPayload;
 }
 
+export interface CdnDownloadCandidate {
+  file_id: string;
+  file_size: string | number;
+  /** 与默认 aes_key 不同时才需要，例如原始视频 cdnrawvideoaeskey */
+  aes_key?: string;
+}
+
 export interface ImageMessagePayload {
   aes_key: string;
   auth_key: string;
   file_id: string;
   file_size?: string | number;
   file_name?: string;
+  /** 图片下载的候选 (file_id, file_size)，按顺序回落 */
+  candidates?: CdnDownloadCandidate[];
+}
+
+/**
+ * 解析后端 "download plaintext size differs: expected X, got Y"，返回实际大小 Y
+ */
+export function parseSizeMismatch (errmsg?: string): string | undefined {
+  const match = typeof errmsg === 'string' ? errmsg.match(/size differs: expected \d+, got (\d+)/) : null
+  return match && Number(match[1]) > 0 ? match[1] : undefined
 }
 
 export interface SnsImageMessagePayload {
@@ -336,6 +353,7 @@ export interface VideoMessagePayload {
   thumb_width: string;
   thumb_height: string;
   file_name: '';
+  candidates?: CdnDownloadCandidate[];
 }
 
 export enum FriendshipType {
@@ -1917,8 +1935,7 @@ class Client extends EventEmitter {
     })
   }
 
-  private async retryDownload (fn: () => Promise<any>): Promise<any> {
-    const maxRetries = 5
+  private async retryDownload (fn: () => Promise<any>, maxRetries = 5): Promise<any> {
     const delayMs = 5000
     for (let attempt = 1; attempt <= maxRetries; attempt++) {
       try {
@@ -1927,6 +1944,10 @@ class Client extends EventEmitter {
           return res
         }
         log.warn(PRE, 'download attempt %d/%d failed (no url in response): %s', attempt, maxRetries, JSON.stringify(res))
+        // size 不匹配是确定性错误，重试同一个 size 没有意义，交给调用方换 size
+        if (parseSizeMismatch(res?.errmsg)) {
+          return res
+        }
       } catch (e) {
         log.warn(PRE, 'download attempt %d/%d error: %s', attempt, maxRetries, e)
       }
@@ -1937,21 +1958,66 @@ class Client extends EventEmitter {
     return null
   }
 
+  /**
+   * 按候选 (file_id, file_size) 依次下载 CDN 文件。
+   * - 后端返回 "plaintext size differs: expected X, got Y" 时立即用 Y 重试同一个 file_id
+   * - 其它失败按 retriesPerCandidate 重试后回落到下一个候选
+   */
+  private async cdnDownloadWithFallback (
+    label: string,
+    baseParams: Record<string, any>,
+    candidates: CdnDownloadCandidate[],
+  ): Promise<string> {
+    const queue = [ ...candidates ]
+    const tried = new Set<string>()
+    // 只有一个候选时保持原来的 5 次重试；有多个候选时每个只试 2 次就回落
+    const retriesPerCandidate = candidates.length > 1 ? 2 : 5
+
+    while (queue.length) {
+      const candidate = queue.shift()!
+      const key = `${candidate.file_id}|${candidate.file_size}|${candidate.aes_key || ''}`
+      if (!candidate.file_id || tried.has(key)) {
+        continue
+      }
+      tried.add(key)
+
+      const params = {
+        ...baseParams,
+        file_id: candidate.file_id,
+        file_size: candidate.file_size,
+        ...(candidate.aes_key ? { aes_key: candidate.aes_key } : {}),
+      }
+      const res = await this.retryDownload(() => this.postData({ path: '/cloud/cdn_download', data: params }), retriesPerCandidate)
+      if (res?.url) {
+        if (tried.size > 1) {
+          log.info(PRE, '%s succeeded with fallback, file_size: %s', label, candidate.file_size)
+        }
+        return encodeURI(res.url) || ''
+      }
+
+      const actualSize = parseSizeMismatch(res?.errmsg)
+      if (actualSize) {
+        log.warn(PRE, '%s size mismatch (xml %s, actual %s), retry with actual size', label, candidate.file_size, actualSize)
+        queue.unshift({ ...candidate, file_size: actualSize })
+        continue
+      }
+      log.warn(PRE, '%s candidate failed, params: %s', label, JSON.stringify(params))
+    }
+
+    log.error(PRE, '%s failed for all candidates: %s', label, JSON.stringify(candidates))
+    return ''
+  }
+
   public async downloadImage (imageInfo: ImageMessagePayload): Promise<any> {
-    const params = {
+    const candidates = imageInfo.candidates?.length
+      ? imageInfo.candidates
+      : [ { file_id: imageInfo.file_id, file_size: imageInfo.file_size || '' } ]
+    return this.cdnDownloadWithFallback('downloadImage', {
       log_response: true,
       file_type: 2,
-      file_id: imageInfo.file_id,
       aes_key: imageInfo.aes_key,
-      file_size: imageInfo.file_size,
       file_name: `/微信图片_${format(new Date(), 'yyyyMMddHHmmss')}.png`,
-    }
-    const res = await this.retryDownload(() => this.postData({ path: '/cloud/cdn_download', data: params }))
-    if (res?.url) {
-      return encodeURI(res.url) || ''
-    }
-    log.error(PRE, 'downloadImage failed after %d retries, params: %s', 5, JSON.stringify(params))
-    return ''
+    }, candidates)
   }
 
   public async downloadWWMedia (imageInfo: ImageMessagePayload, type: number): Promise<any> {
@@ -1981,20 +2047,12 @@ class Client extends EventEmitter {
    * @param imageInfo
    */
   public async downloadFile (imageInfo: ImageMessagePayload): Promise<any> {
-    const params = {
+    return this.cdnDownloadWithFallback('downloadFile', {
       log_response: true,
       file_type: 5,
-      file_id: imageInfo.file_id.replace('@cdn_', ''),
       aes_key: imageInfo.aes_key,
-      file_size: imageInfo.file_size,
       file_name: '/' + sanitizeFilename(imageInfo.file_name),
-    }
-    const res = await this.retryDownload(() => this.postData({ path: '/cloud/cdn_download', data: params }))
-    if (res?.url) {
-      return encodeURI(res.url) || ''
-    }
-    log.error(PRE, 'downloadFile failed after %d retries, params: %s', 5, JSON.stringify(params))
-    return ''
+    }, [ { file_id: imageInfo.file_id.replace('@cdn_', ''), file_size: imageInfo.file_size || '' } ])
   }
 
   /**
@@ -2045,6 +2103,8 @@ class Client extends EventEmitter {
    * 语音转文字，转写完成(endFlag === 1)返回文字，失败或超时返回空字符串
    */
   public async voiceToText (msgId: string, length: number, timeoutMs = 20000): Promise<string> {
+    // timeSlice.buffer 很长且无需关注，打印时去掉
+    const brief = (res: any) => JSON.stringify(res, (k, v) => (k === 'buffer' ? undefined : v))
     try {
       const idRes = await this.newVoiceTransId()
       const voiceId: string = idRes?.voice_id
@@ -2052,15 +2112,26 @@ class Client extends EventEmitter {
         log.warn(PRE, 'voiceToText: no voice_id: %s', JSON.stringify(idRes))
         return ''
       }
-      const checkRes = await this.checkVoiceTrans(voiceId, msgId, length)
-      if (checkRes?.baseResponse?.ret !== 0) {
-        log.warn(PRE, 'voiceToText: check failed: %s', JSON.stringify(checkRes))
-        return ''
-      }
-      const uploadRes = await this.uploadVoiceTrans(voiceId, msgId, length)
-      if (uploadRes?.baseResponse?.ret !== 0) {
-        log.warn(PRE, 'voiceToText: upload failed: %s', JSON.stringify(uploadRes))
-        return ''
+      // length 必须是语音数据字节数(不是时长)。check 返回 uploadCtx 时需要 upload，
+      // 直到 uploadCtx 为空(后端已拿到全部数据)
+      let checkRes: any
+      for (let round = 0; round < 20; round++) {
+        checkRes = await this.checkVoiceTrans(voiceId, msgId, length)
+        log.verbose(PRE, 'voiceToText check#%d(length=%d): %s', round, length, brief(checkRes))
+        if (checkRes?.baseResponse?.ret !== 0) {
+          log.warn(PRE, 'voiceToText: check failed: %s', brief(checkRes))
+          return ''
+        }
+        const ctx = checkRes?.uploadCtx
+        if (!ctx?.dataLen) {
+          break
+        }
+        const uploadRes = await this.uploadVoiceTrans(voiceId, msgId, length)
+        log.verbose(PRE, 'voiceToText upload#%d: %s', round, brief(uploadRes))
+        if (uploadRes?.baseResponse?.ret !== 0) {
+          log.warn(PRE, 'voiceToText: upload failed: %s', brief(uploadRes))
+          return ''
+        }
       }
       const interval = (checkRes?.queryCtx?.interval || 2) * 1000
       const deadline = Date.now() + timeoutMs
@@ -2068,7 +2139,7 @@ class Client extends EventEmitter {
         await new Promise(resolve => setTimeout(resolve, interval))
         const res = await this.getVoiceTrans(voiceId)
         if (res?.baseResponse?.ret !== 0) {
-          log.warn(PRE, 'voiceToText: get result failed: %s', JSON.stringify(res))
+          log.warn(PRE, 'voiceToText: get result failed: %s', brief(res))
           return ''
         }
         if (res?.transRes?.endFlag === 1) {
@@ -2087,19 +2158,14 @@ class Client extends EventEmitter {
    * @param imageInfo
    */
   public async downloadVideo (videoInfo: VideoMessagePayload): Promise<any> {
-    const params = {
+    const candidates = videoInfo.candidates?.length
+      ? videoInfo.candidates
+      : [ { file_id: videoInfo.file_id, file_size: videoInfo.file_size } ]
+    return this.cdnDownloadWithFallback('downloadVideo', {
       file_type: 4,
-      file_id: videoInfo.file_id,
       aes_key: videoInfo.aes_key,
-      file_size: videoInfo.file_size,
       file_name: `/微信视频_${format(new Date(), 'yyyyMMddHHmmss')}.mp4`,
-    }
-    const res = await this.retryDownload(() => this.postData({ path: '/cloud/cdn_download', data: params }))
-    if (res?.url) {
-      return encodeURI(res.url) || ''
-    }
-    log.error(PRE, 'downloadVideo failed after %d retries, params: %s', 5, JSON.stringify(params))
-    return ''
+    }, candidates)
   }
 
   /**

package/src/matrix/utils/file-type.spec.ts

@@ -0,0 +1,29 @@
+#!/usr/bin/env -S node -r ts-node/register
+import { test } from 'tstest'
+
+import { detectImageExt, replaceExt } from './file-type.js'
+
+const hex = (s: string) => Buffer.from(s, 'hex')
+
+test('detectImageExt recognizes common image headers', async t => {
+  // 实测微信图片下载结果的文件头
+  t.equal(detectImageExt(hex('ffd8fffe00104c61766335392e33372e')), 'jpg', 'jpeg')
+  t.equal(detectImageExt(hex('89504e470d0a1a0a0000000d49484452')), 'png', 'png')
+  t.equal(detectImageExt(Buffer.from('GIF89a......')), 'gif', 'gif')
+  t.equal(detectImageExt(Buffer.concat([ Buffer.from('RIFF'), hex('00000000'), Buffer.from('WEBPVP8 ') ])), 'webp', 'webp')
+  t.equal(detectImageExt(hex('424d000000000000')), 'bmp', 'bmp')
+  t.equal(detectImageExt(Buffer.concat([ hex('00000018'), Buffer.from('ftypheic'), hex('00000000') ])), 'heic', 'heic')
+  t.equal(detectImageExt(Buffer.concat([ hex('0000001c'), Buffer.from('ftypavif'), hex('00000000') ])), 'avif', 'avif')
+})
+
+test('detectImageExt returns undefined for unknown or short data', async t => {
+  t.equal(detectImageExt(hex('0000001c667479706d703432')), undefined, 'mp4 is not an image')
+  t.equal(detectImageExt(Buffer.from('<html>')), undefined, 'html')
+  t.equal(detectImageExt(Buffer.alloc(0)), undefined, 'empty')
+})
+
+test('replaceExt replaces or appends extension', async t => {
+  t.equal(replaceExt('微信图片_20261105234022.png', 'jpg'), '微信图片_20261105234022.jpg', 'replace')
+  t.equal(replaceExt('image', 'gif'), 'image.gif', 'append')
+  t.equal(replaceExt('.hidden', 'jpg'), '.hidden.jpg', 'dotfile')
+})

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

@@ -0,0 +1,59 @@
+import axios from 'axios'
+
+/**
+ * 根据文件头 (magic bytes) 判断图片扩展名，无法识别时返回 undefined
+ */
+export function detectImageExt (head: Buffer): string | undefined {
+  if (head.length >= 3 && head[0] === 0xff && head[1] === 0xd8 && head[2] === 0xff) {
+    return 'jpg'
+  }
+  if (head.length >= 8 && head.subarray(0, 8).equals(Buffer.from([ 0x89, 0x50, 0x4e, 0x47, 0x0d, 0x0a, 0x1a, 0x0a ]))) {
+    return 'png'
+  }
+  if (head.length >= 6 && [ 'GIF87a', 'GIF89a' ].includes(head.subarray(0, 6).toString('ascii'))) {
+    return 'gif'
+  }
+  if (head.length >= 12 && head.subarray(0, 4).toString('ascii') === 'RIFF' && head.subarray(8, 12).toString('ascii') === 'WEBP') {
+    return 'webp'
+  }
+  if (head.length >= 2 && head[0] === 0x42 && head[1] === 0x4d) {
+    return 'bmp'
+  }
+  if (head.length >= 12 && head.subarray(4, 8).toString('ascii') === 'ftyp') {
+    const brand = head.subarray(8, 12).toString('ascii')
+    if ([ 'heic', 'heix', 'hevc', 'hevx', 'mif1', 'msf1' ].includes(brand)) {
+      return 'heic'
+    }
+    if ([ 'avif', 'avis' ].includes(brand)) {
+      return 'avif'
+    }
+  }
+  return undefined
+}
+
+/**
+ * 用 Range 请求读取远程文件开头若干字节，失败返回 undefined
+ */
+export async function fetchRemoteHead (url: string, bytes = 32, timeoutMs = 5000): Promise<Buffer | undefined> {
+  try {
+    const res = await axios.get<ArrayBuffer>(url, {
+      headers: { Range: `bytes=0-${bytes - 1}` },
+      responseType: 'arraybuffer',
+      timeout: timeoutMs,
+      // 服务端不支持 Range 时会返回整个文件，限制最大读取量
+      maxContentLength: 50 * 1024 * 1024,
+    })
+    return Buffer.from(res.data).subarray(0, bytes)
+  } catch {
+    return undefined
+  }
+}
+
+/**
+ * 把文件名的扩展名替换成 ext
+ */
+export function replaceExt (fileName: string, ext: string): string {
+  const dot = fileName.lastIndexOf('.')
+  const base = dot > 0 ? fileName.slice(0, dot) : fileName
+  return `${base}.${ext}`
+}

package/src/puppet-matrix.ts

@@ -12,6 +12,7 @@ import Client from './matrix/service/request.js'
 import { getUnixTime } from 'date-fns'
 
 import { mergeWithFallback } from './matrix/utils/index.js'
+import { detectImageExt, fetchRemoteHead, replaceExt } from './matrix/utils/file-type.js'
 import path from 'path'
 // 参考
 import { CacheManager, RoomMemberMap } from './matrix/cache-manager.js'
@@ -1704,8 +1705,8 @@ class PuppetMatrix extends PUPPET.Puppet {
     }
     try {
       const audio = await parseAudioMessagePayload(message)
-      // 已验证可用的是 voicelength(语音时长)，不是 length(数据字节数)
-      const length = parseInt(audio.voicelength, 10)
+      // length 是语音数据字节数，voicelength 是时长(毫秒)；接口的 length 参数要的是字节数
+      const length = parseInt(audio.length, 10)
       if (!length) {
         return
       }
@@ -1894,7 +1895,25 @@ class PuppetMatrix extends PUPPET.Puppet {
       log.error(`Can not get file for message: ${messageId}`)
     }
     const url = imageInfo.is_ww ? await this._client?.downloadWWMedia(imageInfo, 1) : await this._client?.downloadImage(imageInfo)
-    return this._fileBoxFromUrl(url, messageId)
+    return this._fileBoxFromUrl(url, messageId, url ? await this._imageNameByHead(url) : undefined)
+  }
+
+  /**
+   * 下载接口固定返回 .png 文件名，实际多为 JPEG。读取文件头修正扩展名，识别失败时保持原名
+   */
+  private async _imageNameByHead (url: string): Promise<string | undefined> {
+    const head = await fetchRemoteHead(url)
+    const ext = head && detectImageExt(head)
+    if (!ext) {
+      return undefined
+    }
+    let rawName = 'image'
+    try {
+      rawName = decodeURIComponent(new URL(url).pathname.split('/').pop() || rawName)
+    } catch {
+      // url 解析失败时用默认名
+    }
+    return replaceExt(rawName, ext)
   }
 
   private async _getMessageAudioFileBox (messageId: string, messagePayload: MessagePayload): Promise<FileBoxInterface> {