wechaty-puppet-matrix 0.0.10 → 0.0.13

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'
@@ -18,6 +21,7 @@ import { 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 { CachedPromiseFunc } from './matrix/utils/cached-promise.js'
 import { engineMessageToWechaty } from './matrix/schema-mapper/message.js'
 import { engineContactToWechaty } from './matrix/schema-mapper/contact.js'
@@ -54,6 +58,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)
@@ -750,6 +759,23 @@ class PuppetMatrix extends PUPPET.Puppet {
     }
   }
 
+  /**
+   * 解析h5链接
+   * @param messageId
+   */
+  override async messageLocation (messageId: string)  : Promise<PUPPET.payloads.Location> {
+    const rawPayload = await this.messageRawPayload(messageId)
+    const payload = await this.messageRawPayloadParser(rawPayload)
+
+    if (payload.type !== PUPPET.types.Message.Location) {
+      throw new Error('Can not get location from non location payload')
+    }
+
+    // FIXME: thumb may not in appPayload.thumburl, but in appPayload.appAttachPayload
+    const locationPayload = await parseLocationMessagePayload(rawPayload.msg) as PUPPET.payloads.Location
+    return locationPayload
+  }
+
   /****************************************************************************
    * send message
    ***************************************************************************/
@@ -1160,6 +1186,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.videoUrl = 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
    ***************************************************************************/

package/src/utils/normalize-filebox.ts

@@ -0,0 +1,90 @@
+import type {
+  FileBox,
+}                     from 'file-box'
+import {
+  FileBoxType,
+  FileBoxInterface,
+}                     from 'file-box'
+
+/**
+ * Huan(202110): for testing propose, use 20KB as the threshold
+ *  after stable we should use a value between 64KB to 256KB as the threshold
+ */
+const PASS_THROUGH_THRESHOLD_BYTES = 20 * 1024 // 20KB
+
+/**
+ * 1. Green:
+ *  Can be serialized directly
+ */
+const greenFileBoxTypes = [
+  FileBoxType.Url,
+  FileBoxType.Uuid,
+  FileBoxType.QRCode,
+]
+/**
+ * 2. Yellow:
+ *  Can be serialized directly, if the size is less than a threshold
+ *  if it's bigger than the threshold,
+ *  then it should be convert to a UUID file box before send out
+ */
+const yellowFileBoxTypes: FileBoxType [] = [
+  // FileBoxType.Buffer,
+  // FileBoxType.Base64,
+]
+
+const canPassthrough = (fileBox: FileBoxInterface) => {
+  /**
+   * 1. Green types: YES
+   */
+  if (greenFileBoxTypes.includes(fileBox.type)) {
+    return true
+  }
+
+  /**
+   * 2. Red types: NO
+   */
+  if (!yellowFileBoxTypes.includes(fileBox.type)) {
+    return false
+  }
+
+  /**
+   * 3. Yellow types: CHECK size
+   */
+  const size = fileBox.size
+  if (size < 0) {
+    // 1. Size unknown: NO
+    return false
+  } else if (size > PASS_THROUGH_THRESHOLD_BYTES) {
+    // 2. Size: bigger than threshold: NO
+    return false
+  } else {
+    // 3. Size: smaller than threshold: YES
+    return true
+  }
+
+}
+
+const normalizeFileBoxUuid = (FileBoxUuid: typeof FileBox) => async (fileBox: FileBoxInterface) => {
+  if (canPassthrough(fileBox)) {
+    return fileBox
+  }
+
+  const stream = await fileBox.toStream()
+
+  const uuid = await FileBoxUuid
+    .fromStream(stream, fileBox.name)
+    .toUuid()
+
+  const uuidFileBox = FileBoxUuid.fromUuid(uuid, {
+    md5  : fileBox.md5,
+    name : fileBox.name,
+    size : fileBox.size,
+  })
+
+  return uuidFileBox
+}
+
+export {
+  canPassthrough,
+  normalizeFileBoxUuid,
+}

package/src/utils/sns-xml-generator.ts

@@ -0,0 +1,184 @@
+type Media = {
+  fileId: string
+  fileSize: number
+  fileType: number
+  videoDuration: number
+  url: string
+  width: number
+  height: number
+  fileUrl: string
+  fileKey: string
+  thumbUrl: string
+  thumbWidth: number
+  thumbHeight: number
+}
+
+export 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
+}
+
+export 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.width}" height="${media.height}"/>
+            <url type="1" md5="951a7d7864d685a92fd2624155794bf9" videomd5="577f55635faf44f595a69ded26d87bcc">${media.fileUrl}</url>
+            <thumb type="1">${media.thumbUrl}</thumb>
+            <size width="${media.thumbWidth}.000000" height="${media.thumbHeight}.000000" totalSize="${media.fileSize}"/>
+            <videoDuration>${media.videoDuration}.000000</videoDuration>
+          </media>
+        </mediaList>
+      </ContentObject>
+    </TimelineObject>`.replace(/\s+/g, '')
+  return xmlTemplate
+}
+
+export 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.fileUrl}]]></url>
+      <thumb type="1"><![CDATA[${media.thumbUrl}]]></thumb>
+      <videoDuration><![CDATA[0.0]]></videoDuration>
+      <size totalSize="${media.fileSize}" width="${media.width}" height="${media.height}"></size>
+    </media>`.replace(/\s+/g, '')
+
+  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>`.replace(/\s+/g, '')
+  return xmlTemplate
+}