wechaty-puppet-matrix 0.0.10 → 0.0.12

package/src/matrix/service/request.ts

@@ -7,7 +7,10 @@ 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 imageSize from 'image-size'
+import fs from 'fs-extra'
+import os from 'os'
+import path from 'path'
 const PRE = '[PuppetMatrix]'
 
 /**
@@ -252,6 +255,25 @@ export interface ImageMessagePayload {
   file_name?: string;
 }
 
+export interface SnsImageMessagePayload {
+  errcode: number;
+  file_key: string;
+  file_url: string;
+  thumb_url: string;
+}
+export interface SnsVideoMessagePayload {
+  errcode: number;
+  mp4_identify: string;
+  file_key: string;
+  file_url: string;
+  thumb_url: string;
+  thumb_width: string;
+  thumb_height: string;
+  video_duration: string;
+  video_width: string;
+  video_height: string;
+}
+
 export interface AudioMessagePayload {
   aesKey: string;
   length: string;
@@ -319,6 +341,22 @@ export interface RoomLeavPayload {
   roomId: string;
   leaveIds: string[];
 }
+export interface Media {
+  fileId: string
+  file_size: number
+  fileType: number
+  video_duration: number
+  url: string
+  video_width: number
+  video_height: number
+  file_url: string
+  file_key: string
+  thumb_url: string
+  thumb_width: number
+  thumb_height: number
+  image_width: number
+  image_height: number
+}
 
 async function getAtWxidList (source: string): Promise<string[]> {
   if (source) {
@@ -330,9 +368,241 @@ async function getAtWxidList (source: string): Promise<string[]> {
   }
   return []
 }
+
 interface ConnectionStatus {
   status: 'disconnected' | 'connected' | 'connecting'
 }
+
+async function getImageInfo (imageUrl: string) {
+  try {
+    // 1. 下载图片
+    const response = await axios({
+      method: 'get',
+      url: imageUrl,
+      responseType: 'arraybuffer',
+    })
+
+    // 2. 获取文件大小（字节数）
+    const fileSize = response.data.length
+
+    // 3. 创建临时文件保存图片
+    const tempFilePath = path.join(
+      os.homedir(),
+      path.sep,
+      '.wechaty',
+      'puppet-matrix-cache',
+      path.sep,
+      'temp_image_' + Date.now() + path.extname(imageUrl),
+      path.sep,
+    )
+    const baseDirExist = await fs.pathExists(tempFilePath)
+    if (!baseDirExist) {
+      await fs.mkdirp(tempFilePath)
+    }
+    await fs.writeFile(tempFilePath, response.data)
+
+    // 4. 获取图片宽高
+    const dimensions = imageSize(tempFilePath)
+
+    // 5. 删除临时文件
+    await fs.unlink(tempFilePath)
+
+    return {
+      file_size: fileSize, // 文件大小（字节）
+      image_width: dimensions.width,
+      image_height: dimensions.height,
+      file_type: dimensions.type,
+    }
+  } catch (error) {
+    console.error('获取图片信息错误:', error)
+    throw error
+  }
+}
+
+const genTextSnsXml = (wxid: string, content: string): string => {
+  const xmlTemplate = `
+    <TimelineObject>
+      <id><![CDATA[0]]></id>
+      <username><![CDATA[${wxid}]]></username>
+      <createTime><![CDATA[${Math.floor(Date.now() / 1000)}]]></createTime>
+      <contentDescShowType>0</contentDescShowType>
+      <contentDescScene>0</contentDescScene>
+      <private><![CDATA[0]]></private>
+      <contentDesc><![CDATA[${content}]]></contentDesc>
+      <contentattr><![CDATA[0]]></contentattr>
+      <sourceUserName></sourceUserName>
+      <sourceNickName></sourceNickName>
+      <statisticsData></statisticsData>
+      <weappInfo>
+        <appUserName></appUserName>
+        <pagePath></pagePath>
+        <version><![CDATA[0]]></version>
+        <isHidden>0</isHidden>
+        <debugMode><![CDATA[0]]></debugMode>
+        <shareActionId></shareActionId>
+        <isGame><![CDATA[0]]></isGame>
+        <messageExtraData></messageExtraData>
+        <subType><![CDATA[0]]></subType>
+        <preloadResources></preloadResources>
+      </weappInfo>
+      <canvasInfoXml></canvasInfoXml>
+      <ContentObject>
+        <contentStyle><![CDATA[2]]></contentStyle>
+        <contentSubStyle><![CDATA[0]]></contentSubStyle>
+        <title></title>
+        <description></description>
+        <contentUrl></contentUrl>
+      </ContentObject>
+      <actionInfo>
+        <appMsg>
+          <mediaTagName></mediaTagName>
+          <messageExt></messageExt>
+          <messageAction></messageAction>
+        </appMsg>
+      </actionInfo>
+      <appInfo><id></id></appInfo>
+      <publicUserName></publicUserName>
+      <streamvideo>
+        <streamvideourl></streamvideourl>
+        <streamvideothumburl></streamvideothumburl>
+        <streamvideoweburl></streamvideoweburl>
+      </streamvideo>
+    </TimelineObject>`.replace(/\s+/g, '')
+  return xmlTemplate
+}
+
+const genVideoSnsXml = (wxid: string, content: string, media: Media): string => {
+  const xmlTemplate = `
+    <TimelineObject>
+      <id>0</id>
+      <username>${wxid}</username>
+      <createTime>${Math.floor(Date.now() / 1000)}</createTime>
+      <contentDesc>${content}</contentDesc>
+      <contentDescShowType>0</contentDescShowType>
+      <contentDescScene>0</contentDescScene>
+      <private>0</private>
+      <sightFolded>0</sightFolded>
+      <showFlag>0</showFlag>
+      <appInfo>
+        <id></id>
+        <version></version>
+        <appName></appName>
+        <installUrl></installUrl>
+        <fromUrl></fromUrl>
+        <isForceUpdate>0</isForceUpdate>
+        <isHidden>0</isHidden>
+      </appInfo>
+      <sourceUserName></sourceUserName>
+      <sourceNickName></sourceNickName>
+      <statisticsData></statisticsData>
+      <statExtStr></statExtStr>
+      <ContentObject>
+        <contentStyle>15</contentStyle>
+        <title></title>
+        <description>Sight</description>
+        <mediaList>
+          <media>
+            <id>0</id>
+            <type>6</type>
+            <title></title>
+            <description>测试</description>
+            <private>0</private>
+            <userData></userData>
+            <subType>0</subType>
+            <videoSize width="${media.video_width}" height="${media.video_height}"/>
+            <url type="1" md5="951a7d7864d685a92fd2624155794bf9" videomd5="577f55635faf44f595a69ded26d87bcc">${media.file_url}</url>
+            <thumb type="1">${media.thumb_url}</thumb>
+            <size width="${media.thumb_width}.000000" height="${media.thumb_height}.000000" totalSize="${media.file_size}"/>
+            <videoDuration>${media.video_duration}.000000</videoDuration>
+          </media>
+        </mediaList>
+      </ContentObject>
+    </TimelineObject>`
+  return xmlTemplate
+}
+
+const genImageSnsXml = (wxid: string, contentDesc: string, mediaList: Media[]): string => {
+  const mediaTemplate = (media: Media) => `
+    <media>
+      <id><![CDATA[0]]></id>
+      <type><![CDATA[2]]></type>
+      <title></title>
+      <description></description>
+      <private><![CDATA[0]]></private>
+      <url type="1" md5="951a7d7864d685a92fd2624155794bf9"><![CDATA[${media.file_url}]]></url>
+      <thumb type="1"><![CDATA[${media.thumb_url}]]></thumb>
+      <videoDuration><![CDATA[0.0]]></videoDuration>
+      <size totalSize="${media.file_size}" width="${media.image_width}" height="${media.image_height}"></size>
+    </media>`
+
+  const mediaString = mediaList.map(media => mediaTemplate(media)).join('')
+
+  const xmlTemplate = `
+    <TimelineObject>
+      <id><![CDATA[0]]></id>
+      <username><![CDATA[${wxid}]]></username>
+      <createTime><![CDATA[${Math.floor(Date.now() / 1000)}]]></createTime>
+      <contentDescShowType>0</contentDescShowType>
+      <contentDescScene>0</contentDescScene>
+      <private><![CDATA[0]]></private>
+      <contentDesc><![CDATA[${contentDesc}]]></contentDesc>
+      <contentattr><![CDATA[0]]></contentattr>
+      <sourceUserName></sourceUserName>
+      <sourceNickName></sourceNickName>
+      <statisticsData></statisticsData>
+      <weappInfo>
+        <appUserName></appUserName>
+        <pagePath></pagePath>
+        <version><![CDATA[0]]></version>
+        <isHidden>0</isHidden>
+        <debugMode><![CDATA[0]]></debugMode>
+        <shareActionId></shareActionId>
+        <isGame><![CDATA[0]]></isGame>
+        <messageExtraData></messageExtraData>
+        <subType><![CDATA[0]]></subType>
+        <preloadResources></preloadResources>
+      </weappInfo>
+      <canvasInfoXml></canvasInfoXml>
+      <ContentObject>
+        <contentStyle><![CDATA[1]]></contentStyle>
+        <contentSubStyle><![CDATA[0]]></contentSubStyle>
+        <title></title>
+        <description></description>
+        <contentUrl></contentUrl>
+        <mediaList>${mediaString}</mediaList>
+      </ContentObject>
+      <actionInfo>
+        <appMsg>
+          <mediaTagName></mediaTagName>
+          <messageExt></messageExt>
+          <messageAction></messageAction>
+        </appMsg>
+      </actionInfo>
+      <appInfo><id></id></appInfo>
+      <publicUserName></publicUserName>
+      <streamvideo>
+        <streamvideourl></streamvideourl>
+        <streamvideothumburl></streamvideothumburl>
+        <streamvideoweburl></streamvideoweburl>
+      </streamvideo>
+    </TimelineObject>`
+  return xmlTemplate
+}
+
+export interface MomentInfo {
+    content: string,
+    mentionIdList: string[],
+    visibledList: string[],
+    imageUrls: string[],
+    videoUrl: string,
+    urlLink: null | PUPPET.payloads.UrlLink,
+    channel: null | PUPPET.payloads.Channel,
+    miniInfo: null | PUPPET.payloads.MiniProgram,
+    location: null | PUPPET.payloads.Location,
+    rootId: string,
+    parentId: string
+}
+
 class Client extends EventEmitter {
 
   private readonly options: PuppetMatrixOptions
@@ -2051,7 +2321,7 @@ class Client extends EventEmitter {
           announcement: content,
         },
       })
-      if (res.baseResponse.ret) {
+      if (res?.baseResponse?.ret) {
         log.error('sendAnnouncement error: %s', JSON.stringify(res.baseResponse))
       }
     } catch (error) {
@@ -2059,6 +2329,189 @@ class Client extends EventEmitter {
     }
   }
 
+  /**
+   * 上传朋友圈图片
+   * @param url
+   * @returns
+   */
+  public async uploadSnsImage (url: string): Promise<SnsImageMessagePayload | void> {
+    try {
+      const res = await this.postData({
+        path: '/cloud/cdn_upload_sns_image',
+        data: {
+          url,
+        },
+      })
+      if (res?.errcode !== 0) {
+        log.error('uploadSnsImage error: %s', JSON.stringify(res))
+        return
+      }
+      return res as SnsImageMessagePayload
+    } catch (error) {
+      log.error(PRE, 'uploadSnsImage(%s): %s', url, error)
+
+    }
+  }
+
+  /**
+   * 上传朋友视频
+   * @param url
+   * @returns
+   */
+  public async uploadSnsVideo (url: string): Promise<SnsVideoMessagePayload | void> {
+    try {
+      const res = await this.postData({
+        path: '/cloud/cdn_upload_sns_video',
+        data: {
+          url,
+        },
+      })
+      log.info('uploadSnsVideo result:%s', res.data)
+      if (res?.errcode !== 0) {
+        log.error('uploadSnsVideo error: %s', JSON.stringify(res))
+      }
+      return res as SnsVideoMessagePayload
+    } catch (error) {
+      log.error(PRE, 'updateSnsImage(%s): %s', url, error)
+    }
+  }
+
+  /**
+   * 发送朋友圈
+   * @param wxid
+   * @param momentInfo
+   */
+  public async sendSnsMoment (wxid: string, momentInfo: MomentInfo) {
+    try {
+      log.info('momentInfo: %s', JSON.stringify(momentInfo))
+      let xmlContent = ''
+      // 朋友圈评论
+      if (momentInfo.parentId && momentInfo.rootId) {
+        return await this.sendMomentReply(momentInfo.rootId, momentInfo.content, momentInfo.parentId === momentInfo.rootId ? '' : momentInfo.parentId)
+      }
+      if (momentInfo.imageUrls.length) {
+        const imageInfo: any[] = []
+        for (const image of momentInfo.imageUrls) {
+          const res = await this.uploadSnsImage(image)
+          if (res) {
+            const imageBaseInfo = await getImageInfo(image)
+            imageInfo.push({ ...res, ...imageBaseInfo })
+          }
+          xmlContent = genImageSnsXml(wxid, momentInfo.content, imageInfo)
+
+        }
+      } else if (momentInfo.videoUrl) {
+        const mediaInfo: any = await this.uploadSnsVideo(momentInfo.videoUrl)
+        if (mediaInfo) {
+          const thumbInfo = await getImageInfo(mediaInfo.thumb_url)
+          xmlContent = genVideoSnsXml(wxid, momentInfo.content, { ...mediaInfo, ...thumbInfo })
+        }
+      } else {
+        xmlContent = genTextSnsXml(wxid, momentInfo.content)
+      }
+      return await this.sendMoment(xmlContent)
+    } catch (error) {
+      log.error(PRE, 'sendSnsMoment(%s): %s', JSON.stringify(momentInfo), error)
+    }
+  }
+
+  public async sendMoment (content: string):Promise<string | void> {
+    try {
+      const res = await this.postData({
+        path: '/sns/sns_post',
+        data: {
+          object_desc: content,
+          with_user_list: [],
+          block_user_list: [],
+          group_user_list: [],
+          group_contact_tag_id_list: [],
+          black_contact_tag_id_list: [],
+        },
+      })
+      if (res?.baseResponse?.ret !== 0) {
+        log.error('sendMoment error: %s', JSON.stringify(res))
+        return
+      }
+      log.info(PRE, 'sendMomen success: %s', res?.snsObject?.id)
+      return res?.snsObject?.id
+    } catch (error) {
+      log.error(PRE, 'sendMoment(%s): %s', content, error)
+
+    }
+  }
+
+  public async unSendMoment (objectId: string):Promise<string | void> {
+    try {
+      const res = await this.postData({
+        path: '/sns/sns_delete',
+        data: {
+          object_id: objectId,
+        },
+      })
+      if (res?.baseResponse?.ret !== 0) {
+        log.error('unSendMoment error: %s', JSON.stringify(res))
+        return
+      }
+      return objectId
+    } catch (error) {
+      log.error(PRE, 'unSendMoment(%s): %s', objectId, error)
+    }
+  }
+
+  /**
+   * 朋友圈点赞
+   * @param objectId
+   * @param status  1 赞 0 取消点赞
+   * @returns
+   */
+  public async sendMomentLike (objectId: string, status: PUPPET.types.Tap):Promise<string | void> {
+    try {
+      const res = await this.postData({
+        path: '/sns/sns_like',
+        data: {
+          object_id: objectId,
+          status,
+        },
+      })
+      if (res?.baseResponse?.ret !== 0) {
+        log.error('sendMomentLike error: %s', JSON.stringify(res))
+        return
+      }
+      return res?.snsObject?.id
+    } catch (error) {
+      log.error(PRE, 'sendMomentLike(%s): %s', objectId, error)
+
+    }
+  }
+
+  /**
+   * 朋友圈回复
+   * @param objectId 朋友圈id
+   * @param content
+   * @param commentId  评论id
+   * @returns
+   */
+  public async sendMomentReply (objectId: string, content: string, commentId?: string):Promise<string | void> {
+    try {
+      const res = await this.postData({
+        path: '/sns/sns_comment',
+        data: {
+          object_id: objectId,
+          content,
+          reply_comment_id: commentId || '0',
+        },
+      })
+      if (res?.baseResponse?.ret !== 0) {
+        log.error('sendMomentLike error: %s', JSON.stringify(res))
+        return
+      }
+      return res?.snsObject?.id
+    } catch (error) {
+      log.error(PRE, 'sendMomentLike(%s): %s', objectId, error)
+
+    }
+  }
+
 }
 
 export default Client

package/src/matrix/utils/index.ts

@@ -32,3 +32,65 @@ export function getFileName (path:string): string {
   const pos  = Math.max(pos1, pos2)
   if (pos < 0) { return path } else { return path.substring(pos + 1) }
 }
+
+/**
+ * 生成指定位数的唯一数字标识
+ * @param {number} digits - 期望生成的总位数，默认为20
+ * @returns {number} 唯一数字标识
+ */
+export function generateUniqueNumeric (digits = 20) {
+  digits = digits - 13
+  if (digits <= 0) {
+    throw new Error('位数长度必须大于0')
+  }
+
+  // 获取当前时间戳
+  const currentTimestamp = Date.now()
+
+  // 生成随机数，并确保在指定位数内
+  const maxRandom = Math.pow(10, digits) - 1
+  const randomPart = Math.floor(Math.random() * maxRandom)
+
+  // 将随机数补足指定位数
+  const paddedRandomPart = randomPart.toString().padStart(digits, '0')
+
+  // 将时间戳和随机数组合成唯一数字
+  const uniqueNumeric = parseInt(`${currentTimestamp}${paddedRandomPart}`)
+
+  return uniqueNumeric
+}
+
+/**
+* 生成指定长度的随机字符串
+* @param {number} length - 字符串长度
+* @returns {string} 随机字符串
+*/
+export function generateRandomString (length: number) {
+  const characters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789'
+  let result = ''
+
+  for (let i = 0; i < length; i++) {
+    const randomIndex = Math.floor(Math.random() * characters.length)
+    result += characters.charAt(randomIndex)
+  }
+
+  return result
+}
+
+/**
+* 生成带有指定前缀的随机字符串
+* @param {string} prefix - 字符串前缀
+* @param {number} length - 总字符串长度
+* @returns {string} 带前缀的随机字符串
+*/
+export function generateCustomRandomString (prefix: string, length: number) {
+  // 确保前缀部分不超过指定长度
+  if (prefix.length >= length) {
+    throw new Error('前缀长度不能大于或等于总长度')
+  }
+
+  // 生成剩余部分的随机字符串
+  const remainingPart = generateRandomString(length - prefix.length)
+
+  return prefix + remainingPart
+}

package/src/puppet-matrix.ts

@@ -1,7 +1,10 @@
 import { log }              from '@juzi/wechaty-puppet'
 import * as PUPPET          from '@juzi/wechaty-puppet'
 import type { FileBoxInterface } from 'file-box'
-import { FileBox }          from 'file-box'
+import {
+  FileBox,
+  FileBoxType,
+}          from 'file-box'
 import type { ContactPayload, MessagePayload } from './engine-schema.js'
 import type { FileBoxMetadataMessage } from './matrix/types.js'
 import Client from './matrix/service/request.js'
@@ -54,6 +57,11 @@ class PuppetMatrix extends PUPPET.Puppet {
   private _verifyInterval?: ReturnType<typeof setInterval> | null
   private _qrcodeStatuasInterval?: ReturnType<typeof setInterval> | null
   public static override readonly  VERSION = VERSION
+  /**
+   * UUIDify:
+   *  We need to clone a FileBox
+   *  to set uuid loader/saver with this grpc client
+   */
 
   constructor (public override options: PuppetEngineOptions = {} as PuppetEngineOptions) {
     super(options)
@@ -1160,6 +1168,109 @@ class PuppetMatrix extends PUPPET.Puppet {
 
     return ret
   }
+
+  /****************************************************************************
+   * moment section
+   ***************************************************************************/
+  /**
+   * 发布朋友圈
+   * @param payload
+   */
+  override async postPublish (payload: PUPPET.payloads.Post): Promise<void | string> {
+    log.verbose(PRE, 'postPublish(%s)', payload)
+    if (!PUPPET.payloads.isPostClient(payload)) {
+      throw new Error('can only publish client post now')
+    }
+    const momentInfo:any = {
+      content: '',
+      mentionIdList: [],
+      visibledList: [],
+      imageUrls: [],
+      videoUrl: '',
+      urlLink: null,
+      channel: null,
+      miniInfo: null,
+      location: null,
+      rootId: '',
+      parentId: '',
+    }
+    for (const item of payload.sayableList) {
+      switch (item.type) {
+        case PUPPET.types.Sayable.Text:
+          momentInfo.content = `${momentInfo.content ? momentInfo.content + '\n' : ''}${item.payload.text}`
+          momentInfo.mentionIdList = item.payload.mentions
+          break
+        case PUPPET.types.Sayable.Attachment: {
+          const fileBox = item.payload.filebox as FileBoxInterface
+          if (typeof item.payload.filebox !== 'string' && (fileBox as FileBoxInterface).type === FileBoxType.Url) {
+            const fileType = fileBox.mediaType && fileBox.mediaType !== 'application/octet-stream' ? fileBox.mediaType : path.extname(fileBox.name)
+            // @ts-ignore
+            const fileUrl = fileBox.remoteUrl || ''
+            if (fileBox.mediaType.startsWith('image/')) {
+              momentInfo.imageUrls.push(fileUrl)
+            } else if (fileType.includes('video/mp4') ||  fileType.includes('.mp4')) {
+              momentInfo.videoInfo = fileUrl
+            }
+          }
+          break
+        }
+        case PUPPET.types.Sayable.Url: {
+          momentInfo.urlLink = item.payload
+          break
+        }
+        case PUPPET.types.Sayable.Channel: {
+          momentInfo.channel = item.payload
+          break
+        }
+        case PUPPET.types.Sayable.MiniProgram: {
+          momentInfo.miniInfo = item.payload
+          break
+        }
+        default:
+          throw new Error(`postPublish unsupported type ${item.type}`)
+      }
+    }
+    if (payload.rootId) momentInfo.rootId = payload.rootId
+    if (payload.parentId) momentInfo.parentId = payload.parentId
+    if (payload.location) momentInfo.location = payload.location
+
+    momentInfo.visibleList = payload.visibleList
+
+    const res = await this._client?.sendSnsMoment(this._self?.wxid || '', momentInfo)
+
+    return res
+  }
+
+  override async postUnpublish (id: string): Promise<void> {
+    log.verbose(PRE, 'postUnpublish(%s)', id)
+
+    await this._client?.unSendMoment(id)
+  }
+
+  override async postRawPayload (id: string): Promise<PUPPET.payloads.Post | string> {
+    log.verbose(PRE, 'postRawPayload(%s)', id)
+    return id
+  }
+
+  override async postPayloadSayable (postId: string, sayableId: string): Promise<PUPPET.payloads.Sayable> {
+    log.verbose(PRE, 'postPayloadSayable(%s, %s)', postId, sayableId)
+    return postId as any
+  }
+
+  override async postRawPayloadParser (payload: PUPPET.payloads.Post): Promise<PUPPET.payloads.Post> {
+  // log.silly('PuppetService', 'postRawPayloadParser({id:%s})', payload.id)
+  // passthrough
+    return payload
+  }
+
+  override async tap (postId: string, type: PUPPET.types.Tap, tap = true): Promise<boolean | void> {
+    log.verbose(PRE, 'tap(%s, %s, %s)', postId, type, tap)
+
+    const res = await this._client?.sendMomentLike(postId, type)
+
+    return !!res
+  }
+
   /****************************************************************************
    * extra methods section
    ***************************************************************************/