wechaty-puppet-matrix 0.0.4

package/src/matrix/types.ts

@@ -0,0 +1,37 @@
+import type { EmojiMessagePayload } from './messages/message-emotion.js'
+
+// 消息类型：1|文本 3|图片 34|语音 42|名片 43|视频 47|动态表情 48|地理位置 49|分享链接或附件 2001|红包 2002|小程序 2003|群邀请 10000|系统消息
+export enum WechatMessageType {
+  Text = 1,
+  Image = 3,
+  Voice = 34,
+  VerifyMsg = 37,
+  PossibleFriendMsg = 40,
+  ShareCard = 42,
+  Video = 43,
+  Emoticon = 47,
+  Location = 48,
+  App = 49,
+  VoipMsg = 50,
+  StatusNotify = 51,
+  VoipNotify = 52,
+  VoipInvite = 53,
+  MicroVideo = 62,
+  VerifyMsgEnterprise = 65,
+  Transfer = 2000, // 转账
+  RedEnvelope = 2001, // 红包
+  MiniProgram = 2002, // 小程序
+  GroupInvite = 2003, // 群邀请
+  File = 2004, // 文件消息
+  SysNotice = 9999,
+  Sys = 10000,
+  SysTemplate = 10002, // NOTIFY 服务通知
+}
+
+export type FileBoxMetadataMessageType = 'unknown' | 'emoticon';
+export type FileBoxMetadataMessagePayload = EmojiMessagePayload;
+
+export interface FileBoxMetadataMessage {
+  type: FileBoxMetadataMessageType,
+  payload: FileBoxMetadataMessagePayload
+}

package/src/matrix/utils/cached-promise.ts

@@ -0,0 +1,25 @@
+const PromiseCache = new Map<string, Promise<any>>()
+
+export async function CachedPromise<T> (key: string, promise: Promise<T>): Promise<T> {
+  const cache = PromiseCache.get(key)
+  if (cache) {
+    return cache
+  }
+
+  PromiseCache.set(key, promise)
+  return promise.finally(() => PromiseCache.delete(key))
+}
+
+type PromiseFunc<T> = () => Promise<T>;
+
+export async function CachedPromiseFunc<T> (key: string, promiseFunc: PromiseFunc<T>): Promise<T> {
+  const cache = PromiseCache.get(key)
+  if (cache) {
+    return cache
+  }
+
+  const promise = promiseFunc()
+
+  PromiseCache.set(key, promise)
+  return promise.finally(() => PromiseCache.delete(key))
+}

package/src/matrix/utils/image-decrypt.ts

@@ -0,0 +1,198 @@
+import fs from 'fs'
+
+let xorCache:string|null = null
+// let xor = '9a9a'   // 异或值(十六进制)
+// xor = hexToBin(xor)
+
+const xorLen = 2
+
+function ImageDecrypt (dataPath: string, messageId: string) {
+  // 读取文件，获取到十六进制数据
+  try {
+    const data = fs.readFileSync(dataPath, 'hex')
+    const res = handleEncrypted(data)   // 解密后的十六进制数据
+    const extension = getNameExtension(res.substring(0, 4))
+    // console.debug(extension)
+    const imageInfo = {
+      base64: Buffer.from(res, 'hex').toString('base64'),
+      extension,
+      fileName: `message-${messageId}-url-thumb.${extension}`,
+    }
+    // console.debug(imageInfo)
+    return imageInfo
+  } catch (err) {
+    console.error(err)
+  }
+  throw new Error('ImageDecrypt fail')
+}
+
+// 解密加密数据
+function handleEncrypted (strEncrypted: string) {
+  // 先获取异或值(仅限于jpg文件)
+  const code = getXor(strEncrypted.substring(0, 4))
+  const strLength = strEncrypted.length
+  let source = ''
+  const list = []
+  for (let i = 0; i < strLength; i = i + xorLen) {
+    const str = strEncrypted.substring(0, xorLen)
+    strEncrypted = strEncrypted.substring(xorLen)
+    const res = hexXor(str, code)
+    list.push(res)
+  }
+  source = list.join('')
+  // console.debug(source)
+  return source
+}
+
+// 获取异或值
+/**
+ *
+ * @param str strEncrypted.substring(0, 4)
+ * @return xor
+ */
+function getXor (str: string): string {
+  if (typeof xorCache === 'string') {
+    return xorCache
+  }
+  const str01 = str.substring(0, 2)
+  const str23 = str.substring(2)
+  for (const head of dataHead) {
+    const h = head.hex
+    const h01 = h.substring(0, 2)
+    const h23 = h.substring(2)
+    const code = hexXor(h01, str01)
+    const testResult = hexXor(str23, code)
+    if (testResult === h23) {
+      xorCache = code
+      return xorCache
+    }
+  }
+  throw new Error('getXor error')
+}
+void getXor
+
+// 获取文件名后缀
+function getNameExtension (hex: string) {
+  // console.debug(hex)
+  const res = dataHead.find(function (item) {
+    return item.hex === hex
+  })!.name
+  return res
+}
+
+// 十六进制转二进制
+function hexToBin (str: string) {
+  const hexArray = [
+    { bin: '0000', hex: '0' },
+    { bin: '0001', hex: '1' },
+    { bin: '0010', hex: '2' },
+    { bin: '0011', hex: '3' },
+    { bin: '0100', hex: '4' },
+    { bin: '0101', hex: '5' },
+    { bin: '0110', hex: '6' },
+    { bin: '0111', hex: '7' },
+    { bin: '1000', hex: '8' },
+    { bin: '1001', hex: '9' },
+    { bin: '1010', hex: 'a' },
+    { bin: '1011', hex: 'b' },
+    { bin: '1100', hex: 'c' },
+    { bin: '1101', hex: 'd' },
+    { bin: '1110', hex: 'e' },
+    { bin: '1111', hex: 'f' },
+  ] as const
+  let value = ''
+  for (let i = 0; i < str.length; i++) {
+    value += hexArray.find(function (item) {
+      return item.hex === str[i]
+    })!.bin
+  }
+  return value
+}
+
+// 二进制转十六进制
+function binToHex (str: string) {
+  const hexArray = [
+    { bin: '0000', hex: '0' },
+    { bin: '0001', hex: '1' },
+    { bin: '0010', hex: '2' },
+    { bin: '0011', hex: '3' },
+    { bin: '0100', hex: '4' },
+    { bin: '0101', hex: '5' },
+    { bin: '0110', hex: '6' },
+    { bin: '0111', hex: '7' },
+    { bin: '1000', hex: '8' },
+    { bin: '1001', hex: '9' },
+    { bin: '1010', hex: 'a' },
+    { bin: '1011', hex: 'b' },
+    { bin: '1100', hex: 'c' },
+    { bin: '1101', hex: 'd' },
+    { bin: '1110', hex: 'e' },
+    { bin: '1111', hex: 'f' },
+  ]
+  let value = ''
+  const list: string[] = []
+  while (str.length > 4) {
+    list.push(str.substring(0, 4))
+    str = str.substring(4)
+  }
+  list.push(str)
+  for (let i = 0; i < list.length; i++) {
+    value += hexArray.find(function (item) {
+      return item.bin === list[i]
+    })!.hex
+  }
+  return value
+}
+
+// 获取计算结果
+// function getResult (a: string) {
+//   const A = hexToBin(a)
+//   const B = xor
+//   let d = ''
+//   for (let i = 0; i < A.length; i++) {
+//     if (A[i] === B[i]) {
+//       d = d.concat('0')
+//     } else {
+//       d = d.concat('1')
+//     }
+//   }
+//   return binToHex(d)
+// }
+
+function hexXor (a: string, b: string) {
+  const A = hexToBin(a)
+  const B = hexToBin(b)
+  let d = ''
+  for (let i = 0; i < A.length; i++) {
+    if (A[i] === B[i]) {
+      d = d.concat('0')
+    } else {
+      d = d.concat('1')
+    }
+  }
+  return binToHex(d)
+}
+
+// 扩展名-十六进制表
+const dataHead = [
+  {
+    hex: 'ffd8',
+    name: 'jpg',
+  },
+  {
+    hex: '8950',
+    name: 'png',
+  },
+  {
+    hex: '4749',
+    name: 'gif',
+  },
+  {
+    hex: '424d',
+    name: 'bmp',
+  },
+]
+
+export {
+  ImageDecrypt,
+}

package/src/matrix/utils/index.ts

@@ -0,0 +1,34 @@
+import axios from 'axios'
+import { URL } from 'url'
+
+/**
+ * 延时函数
+ * @param {*} ms 毫秒
+ */
+export async function delay (ms:number):Promise<void> {
+  return new Promise((resolve) => setTimeout(resolve, ms))
+}
+
+/**
+ * 上传文件
+ */
+export async function putFileTransfer (fileName: string, fileData: Buffer): Promise<string> {
+  const res = await axios.put(`https://transfer.sh/${fileName}`, fileData)
+  if (res.data) {
+    const parseUrl = new URL(res.data)
+    return  parseUrl.origin + '/get' + parseUrl.pathname
+  }
+  return ''
+}
+
+/**
+ * 获取带后缀的文件名
+ * @param path
+ */
+
+export function getFileName (path:string): string {
+  const pos1 = path.lastIndexOf('/')
+  const pos2 = path.lastIndexOf('\\')
+  const pos  = Math.max(pos1, pos2)
+  if (pos < 0) { return path } else { return path.substring(pos + 1) }
+}

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

@@ -0,0 +1,72 @@
+const officeWxid = [
+  'medianote',
+  'floatbottle',
+  'qmessage',
+  'fmessage',
+  'exmail_tool',
+  'weixin',
+  'newsapp', 'fmessage', 'filehelper', 'weibo', 'qqmail', 'tmessage',
+  'qmessage', 'qqsync', 'floatbottle', 'lbsapp', 'shakeapp', 'medianote', 'qqfriend',
+  'readerapp', 'blogapp', 'facebookapp', 'masssendapp', 'meishiapp', 'feedsapp', 'voip',
+  'blogappweixin', 'weixin', 'brandsessionholder', 'weixinreminder', 'wxid_novlwrv3lqwv11',
+  'gh_22b87fa7cb3c', 'officialaccounts', 'notification_messages', 'wxid_novlwrv3lqwv11',
+  'gh_22b87fa7cb3c', 'wxitil', 'userexperience_alarm', 'notification_messages',
+]
+export function isRoomId (id?: string): boolean {
+  if (!id) {
+    return false
+  }
+  return /@chatroom$/.test(id)
+}
+
+export function isIMRoomId (id?: string): boolean {
+  if (!id) {
+    return false
+  }
+  return /@im.chatroom$/.test(id)
+}
+
+export function isContactId (id?: string): boolean {
+  if (!id) {
+    return false
+  }
+  return !isRoomId(id) && !isIMRoomId(id) && !isIMContactId(id)
+}
+
+export function isIMContactId (id?: string): boolean {
+  if (!id) {
+    return false
+  }
+  return /@openim$/.test(id)
+}
+
+export function isContactOfficialId (id?: string): boolean {
+  if (!id) {
+    return false
+    // throw new Error('no id')
+  }
+  return /^gh_/i.test(id) || officeWxid.includes(id)
+}
+
+export function isStrangerV1 (strangerId?: string): boolean {
+  if (!strangerId) {
+    return false
+    // throw new Error('no id')
+  }
+  return /^v1_/i.test(strangerId)
+}
+
+export function isStrangerV2 (strangerId?: string): boolean {
+  if (!strangerId) {
+    return false
+    // throw new Error('no id')
+  }
+  return /^v2_/i.test(strangerId)
+}
+
+export function isPayload (payload?: object): boolean {
+  if (payload && Object.keys(payload).length > 0) {
+    return true
+  }
+  return false
+}

package/src/matrix/utils/regex.ts

@@ -0,0 +1,15 @@
+export type RegexHandler<T> = (matchedRegexIndex: number, match: RegExpMatchArray) => Promise<T>;
+
+export async function parseTextWithRegexList<T> (text: string, regexList: RegExp[], handler: RegexHandler<T>) : Promise<T | null> {
+  for (let i = 0; i < regexList.length; ++i) {
+    const regex = regexList[i]!
+    const match = text.match(regex)
+    if (!match) {
+      continue
+    }
+
+    return await handler(i, match)
+  }
+
+  return null
+}

package/src/matrix/utils/runner.ts

@@ -0,0 +1,12 @@
+export type Runner<T> = () => Promise<T | null>;
+
+export async function executeRunners<T> (runners: Runner<T>[]): Promise<T | null> {
+  for (const runner of runners) {
+    const ret = await runner()
+    if (ret) {
+      return ret
+    }
+  }
+
+  return null
+}

package/src/matrix/utils/string.ts

@@ -0,0 +1,3 @@
+export const clearEscapeFlag = (s: string) => {
+  return s.replace(/[\r\n\t]/g, '')
+}

package/src/matrix/utils/xml-to-json.ts

@@ -0,0 +1,59 @@
+import { parseString, Builder } from 'xml2js'
+import { log } from '@juzi/wechaty-puppet'
+
+export async function xmlToJson (xml: string): Promise<any> {
+  const firstIndex = xml.indexOf('<')
+  if (firstIndex !== 0) {
+    xml = xml.substring(firstIndex, xml.length)
+  }
+
+  return new Promise((resolve) => {
+    parseString(xml, { explicitArray: false }, (err, result) => {
+      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+      if (err && Object.keys(err).length !== 0) {
+        log.warn(JSON.stringify(err))
+      }
+      return resolve(result)
+    })
+  })
+}
+
+export async function JsonToXml (json: any): Promise<string> {
+  const builder = new Builder()
+  const xml = builder.buildObject(json)
+  return xml
+}
+
+export function getNickName (linkList: any, name: string) {
+  const otherObjectArray = linkList.filter((link: any) =>
+    name.includes(link.$.name),
+  )
+
+  if (!otherObjectArray || otherObjectArray.length === 0) {
+    return null
+  }
+  const otherObject = otherObjectArray[0]
+  const inviteeList = otherObject.memberlist.member
+
+  const inviteeIdList = inviteeList.length
+    ? inviteeList.map((i: any) => i.nickname)
+    : inviteeList.nickname
+  return inviteeIdList
+}
+
+export function getUserName (linkList: any, name: string) {
+  const otherObjectArray = linkList.filter((link: any) =>
+    name.includes(link.$.name),
+  )
+
+  if (!otherObjectArray || otherObjectArray.length === 0) {
+    return null
+  }
+  const otherObject = otherObjectArray[0]
+  const inviteeList = otherObject.memberlist.member
+
+  const inviteeIdList = inviteeList.length
+    ? inviteeList.map((i: any) => i.username)
+    : inviteeList.username
+  return inviteeIdList
+}

package/src/mod.ts

@@ -0,0 +1,10 @@
+import { PuppetMatrix } from './puppet-matrix.js'
+export {
+  VERSION,
+  log,
+}              from './config.js'
+
+export {
+  PuppetMatrix,
+}
+export default PuppetMatrix

package/src/package-json.spec.ts

@@ -0,0 +1,10 @@
+#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
+
+import { test } from 'tstest'
+
+import { packageJson } from './package-json.js'
+
+test('Make sure the packageJson is fresh in source code', async t => {
+  const keyNum = Object.keys(packageJson).length
+  t.equal(keyNum, 0, 'packageJson should be empty in source code, only updated before publish to NPM')
+})

package/src/package-json.ts

@@ -0,0 +1,11 @@
+/**
+ * This file will be overwrite when we publish NPM module
+ * by scripts/generate_version.ts
+ */
+import type { PackageJson } from 'type-fest'
+
+/**
+ * Huan(202108):
+ *  The below default values is only for unit testing
+ */
+export const packageJson: PackageJson = {}