import NodeCache from '@cacheable/node-cache' import { Boom } from '@hapi/boom' import { proto } from '../../WAProto' import { DEFAULT_CACHE_TTLS, PROCESSABLE_HISTORY_TYPES } from '../Defaults' import { ALL_WA_PATCH_NAMES, ChatModification, ChatMutation, LTHashState, MessageUpsertType, PresenceData, SocketConfig, WABusinessHoursConfig, WABusinessProfile, WAMediaUpload, WAMessage, WAPatchCreate, WAPatchName, WAPresence, WAPrivacyCallValue, WAPrivacyGroupAddValue, WAPrivacyMessagesValue, WAPrivacyOnlineValue, WAPrivacyValue, WAReadReceiptsValue } from '../Types' import { LabelActionBody } from '../Types/Label' import { chatModificationToAppPatch, ChatMutationMap, decodePatches, decodeSyncdSnapshot, encodeSyncdPatch, extractSyncdPatches, generateProfilePicture, getHistoryMsg, newLTHashState, processSyncAction } from '../Utils' import { makeMutex } from '../Utils/make-mutex' import processMessage from '../Utils/process-message' import { BinaryNode, getBinaryNodeChild, getBinaryNodeChildren, jidNormalizedUser, reduceBinaryNodeToDictionary, S_WHATSAPP_NET } from '../WABinary' import { USyncQuery, USyncUser } from '../WAUSync' import { makeUSyncSocket } from './usync' const MAX_SYNC_ATTEMPTS = 2 export const makeChatsSocket = (config: SocketConfig) => { const { logger, markOnlineOnConnect, fireInitQueries, appStateMacVerification, shouldIgnoreJid, shouldSyncHistoryMessage, } = config const sock = makeUSyncSocket(config) const { ev, ws, authState, generateMessageTag, sendNode, query, onUnexpectedError, } = sock let privacySettings: { [_: string]: string } | undefined let needToFlushWithAppStateSync = false let pendingAppStateSync = false /** this mutex ensures that the notifications (receipts, messages etc.) are processed in order */ const processingMutex = makeMutex() const placeholderResendCache = config.placeholderResendCache || new NodeCache({ stdTTL: DEFAULT_CACHE_TTLS.MSG_RETRY, // 1 hour useClones: false }) if(!config.placeholderResendCache) { config.placeholderResendCache = placeholderResendCache } /** helper function to fetch the given app state sync key */ const getAppStateSyncKey = async(keyId: string) => { const { [keyId]: key } = await authState.keys.get('app-state-sync-key', [keyId]) return key } const fetchPrivacySettings = async(force = false) => { if(!privacySettings || force) { const { content } = await query({ tag: 'iq', attrs: { xmlns: 'privacy', to: S_WHATSAPP_NET, type: 'get' }, content: [ { tag: 'privacy', attrs: {} } ] }) privacySettings = reduceBinaryNodeToDictionary(content?.[0] as BinaryNode, 'category') } return privacySettings } /** helper function to run a privacy IQ query */ const privacyQuery = async(name: string, value: string) => { await query({ tag: 'iq', attrs: { xmlns: 'privacy', to: S_WHATSAPP_NET, type: 'set' }, content: [{ tag: 'privacy', attrs: {}, content: [ { tag: 'category', attrs: { name, value } } ] }] }) } const updateMessagesPrivacy = async(value: WAPrivacyMessagesValue) => { await privacyQuery('messages', value) } const updateCallPrivacy = async(value: WAPrivacyCallValue) => { await privacyQuery('calladd', value) } const updateLastSeenPrivacy = async(value: WAPrivacyValue) => { await privacyQuery('last', value) } const updateOnlinePrivacy = async(value: WAPrivacyOnlineValue) => { await privacyQuery('online', value) } const updateProfilePicturePrivacy = async(value: WAPrivacyValue) => { await privacyQuery('profile', value) } const updateStatusPrivacy = async(value: WAPrivacyValue) => { await privacyQuery('status', value) } const updateReadReceiptsPrivacy = async(value: WAReadReceiptsValue) => { await privacyQuery('readreceipts', value) } const updateGroupsAddPrivacy = async(value: WAPrivacyGroupAddValue) => { await privacyQuery('groupadd', value) } const updateDefaultDisappearingMode = async(duration: number) => { await query({ tag: 'iq', attrs: { xmlns: 'disappearing_mode', to: S_WHATSAPP_NET, type: 'set' }, content: [{ tag: 'disappearing_mode', attrs: { duration: duration.toString() } }] }) } const onWhatsApp = async(...jids: string[]) => { const usyncQuery = new USyncQuery() .withContactProtocol() for(const jid of jids) { const phone = `+${jid.replace('+', '').split('@')[0].split(':')[0]}` usyncQuery.withUser(new USyncUser().withPhone(phone)) } const results = await sock.executeUSyncQuery(usyncQuery) if(results) { return results.list.filter((a) => !!a.contact).map(({ contact, id }) => ({ jid: id, exists: contact })) } } const fetchStatus = async(...jids: string[]) => { const usyncQuery = new USyncQuery() .withStatusProtocol() for(const jid of jids) { usyncQuery.withUser(new USyncUser().withId(jid)) } const result = await sock.executeUSyncQuery(usyncQuery) if(result) { return result.list } } const fetchDisappearingDuration = async(...jids: string[]) => { const usyncQuery = new USyncQuery() .withDisappearingModeProtocol() for(const jid of jids) { usyncQuery.withUser(new USyncUser().withId(jid)) } const result = await sock.executeUSyncQuery(usyncQuery) if(result) { return result.list } } /** update the profile picture for yourself or a group */ const updateProfilePicture = async(jid: string, content: WAMediaUpload) => { let targetJid if(!jid) { throw new Boom('Illegal no-jid profile update. Please specify either your ID or the ID of the chat you wish to update') } if(jidNormalizedUser(jid) !== jidNormalizedUser(authState.creds.me!.id)) { targetJid = jidNormalizedUser(jid) // in case it is someone other than us } const { img } = await generateProfilePicture(content) await query({ tag: 'iq', attrs: { target: targetJid, to: S_WHATSAPP_NET, type: 'set', xmlns: 'w:profile:picture' }, content: [ { tag: 'picture', attrs: { type: 'image' }, content: img } ] }) } /** remove the profile picture for yourself or a group */ const removeProfilePicture = async(jid: string) => { let targetJid if(!jid) { throw new Boom('Illegal no-jid profile update. Please specify either your ID or the ID of the chat you wish to update') } if(jidNormalizedUser(jid) !== jidNormalizedUser(authState.creds.me!.id)) { targetJid = jidNormalizedUser(jid) // in case it is someone other than us } await query({ tag: 'iq', attrs: { target: targetJid, to: S_WHATSAPP_NET, type: 'set', xmlns: 'w:profile:picture' } }) } /** update the profile status for yourself */ const updateProfileStatus = async(status: string) => { await query({ tag: 'iq', attrs: { to: S_WHATSAPP_NET, type: 'set', xmlns: 'status' }, content: [ { tag: 'status', attrs: {}, content: Buffer.from(status, 'utf-8') } ] }) } const updateProfileName = async(name: string) => { await chatModify({ pushNameSetting: name }, '') } const fetchBlocklist = async() => { const result = await query({ tag: 'iq', attrs: { xmlns: 'blocklist', to: S_WHATSAPP_NET, type: 'get' } }) const listNode = getBinaryNodeChild(result, 'list') return getBinaryNodeChildren(listNode, 'item') .map(n => n.attrs.jid) } const updateBlockStatus = async(jid: string, action: 'block' | 'unblock') => { await query({ tag: 'iq', attrs: { xmlns: 'blocklist', to: S_WHATSAPP_NET, type: 'set' }, content: [ { tag: 'item', attrs: { action, jid } } ] }) } const getBusinessProfile = async(jid: string): Promise => { const results = await query({ tag: 'iq', attrs: { to: 's.whatsapp.net', xmlns: 'w:biz', type: 'get' }, content: [{ tag: 'business_profile', attrs: { v: '244' }, content: [{ tag: 'profile', attrs: { jid } }] }] }) const profileNode = getBinaryNodeChild(results, 'business_profile') const profiles = getBinaryNodeChild(profileNode, 'profile') if(profiles) { const address = getBinaryNodeChild(profiles, 'address') const description = getBinaryNodeChild(profiles, 'description') const website = getBinaryNodeChild(profiles, 'website') const email = getBinaryNodeChild(profiles, 'email') const category = getBinaryNodeChild(getBinaryNodeChild(profiles, 'categories'), 'category') const businessHours = getBinaryNodeChild(profiles, 'business_hours') const businessHoursConfig = businessHours ? getBinaryNodeChildren(businessHours, 'business_hours_config') : undefined const websiteStr = website?.content?.toString() return { wid: profiles.attrs?.jid, address: address?.content?.toString(), description: description?.content?.toString() || '', website: websiteStr ? [websiteStr] : [], email: email?.content?.toString(), category: category?.content?.toString(), 'business_hours': { timezone: businessHours?.attrs?.timezone, 'business_config': businessHoursConfig?.map(({ attrs }) => attrs as unknown as WABusinessHoursConfig) } } } } const cleanDirtyBits = async(type: 'account_sync' | 'groups', fromTimestamp?: number | string) => { logger.info({ fromTimestamp }, 'clean dirty bits ' + type) await sendNode({ tag: 'iq', attrs: { to: S_WHATSAPP_NET, type: 'set', xmlns: 'urn:xmpp:whatsapp:dirty', id: generateMessageTag(), }, content: [ { tag: 'clean', attrs: { type, ...(fromTimestamp ? { timestamp: fromTimestamp.toString() } : null), } } ] }) } const newAppStateChunkHandler = (isInitialSync: boolean) => { return { onMutation(mutation: ChatMutation) { processSyncAction( mutation, ev, authState.creds.me!, isInitialSync ? { accountSettings: authState.creds.accountSettings } : undefined, logger ) } } } const resyncAppState = ev.createBufferedFunction(async(collections: readonly WAPatchName[], isInitialSync: boolean) => { // we use this to determine which events to fire // otherwise when we resync from scratch -- all notifications will fire const initialVersionMap: { [T in WAPatchName]?: number } = {} const globalMutationMap: ChatMutationMap = {} await authState.keys.transaction( async() => { const collectionsToHandle = new Set(collections) // in case something goes wrong -- ensure we don't enter a loop that cannot be exited from const attemptsMap: { [T in WAPatchName]?: number } = {} // keep executing till all collections are done // sometimes a single patch request will not return all the patches (God knows why) // so we fetch till they're all done (this is determined by the "has_more_patches" flag) while(collectionsToHandle.size) { const states = {} as { [T in WAPatchName]: LTHashState } const nodes: BinaryNode[] = [] for(const name of collectionsToHandle) { const result = await authState.keys.get('app-state-sync-version', [name]) let state = result[name] if(state) { if(typeof initialVersionMap[name] === 'undefined') { initialVersionMap[name] = state.version } } else { state = newLTHashState() } states[name] = state logger.info(`resyncing ${name} from v${state.version}`) nodes.push({ tag: 'collection', attrs: { name, version: state.version.toString(), // return snapshot if being synced from scratch 'return_snapshot': (!state.version).toString() } }) } const result = await query({ tag: 'iq', attrs: { to: S_WHATSAPP_NET, xmlns: 'w:sync:app:state', type: 'set' }, content: [ { tag: 'sync', attrs: {}, content: nodes } ] }) // extract from binary node const decoded = await extractSyncdPatches(result, config?.options) for(const key in decoded) { const name = key as WAPatchName const { patches, hasMorePatches, snapshot } = decoded[name] try { if(snapshot) { const { state: newState, mutationMap } = await decodeSyncdSnapshot( name, snapshot, getAppStateSyncKey, initialVersionMap[name], appStateMacVerification.snapshot ) states[name] = newState Object.assign(globalMutationMap, mutationMap) logger.info(`restored state of ${name} from snapshot to v${newState.version} with mutations`) await authState.keys.set({ 'app-state-sync-version': { [name]: newState } }) } // only process if there are syncd patches if(patches.length) { const { state: newState, mutationMap } = await decodePatches( name, patches, states[name], getAppStateSyncKey, config.options, initialVersionMap[name], logger, appStateMacVerification.patch ) await authState.keys.set({ 'app-state-sync-version': { [name]: newState } }) logger.info(`synced ${name} to v${newState.version}`) initialVersionMap[name] = newState.version Object.assign(globalMutationMap, mutationMap) } if(hasMorePatches) { logger.info(`${name} has more patches...`) } else { // collection is done with sync collectionsToHandle.delete(name) } } catch(error) { // if retry attempts overshoot // or key not found const isIrrecoverableError = attemptsMap[name]! >= MAX_SYNC_ATTEMPTS || error.output?.statusCode === 404 || error.name === 'TypeError' logger.info( { name, error: error.stack }, `failed to sync state from version${isIrrecoverableError ? '' : ', removing and trying from scratch'}` ) await authState.keys.set({ 'app-state-sync-version': { [name]: null } }) // increment number of retries attemptsMap[name] = (attemptsMap[name] || 0) + 1 if(isIrrecoverableError) { // stop retrying collectionsToHandle.delete(name) } } } } } ) const { onMutation } = newAppStateChunkHandler(isInitialSync) for(const key in globalMutationMap) { onMutation(globalMutationMap[key]) } }) /** * fetch the profile picture of a user/group * type = "preview" for a low res picture * type = "image for the high res picture" */ const profilePictureUrl = async(jid: string, type: 'preview' | 'image' = 'preview', timeoutMs?: number) => { jid = jidNormalizedUser(jid) const result = await query({ tag: 'iq', attrs: { target: jid, to: S_WHATSAPP_NET, type: 'get', xmlns: 'w:profile:picture' }, content: [ { tag: 'picture', attrs: { type, query: 'url' } } ] }, timeoutMs) const child = getBinaryNodeChild(result, 'picture') return child?.attrs?.url } const sendPresenceUpdate = async(type: WAPresence, toJid?: string) => { const me = authState.creds.me! if(type === 'available' || type === 'unavailable') { if(!me.name) { logger.warn('no name present, ignoring presence update request...') return } ev.emit('connection.update', { isOnline: type === 'available' }) await sendNode({ tag: 'presence', attrs: { name: me.name, type } }) } else { await sendNode({ tag: 'chatstate', attrs: { from: me.id, to: toJid!, }, content: [ { tag: type === 'recording' ? 'composing' : type, attrs: type === 'recording' ? { media: 'audio' } : {} } ] }) } } /** * @param toJid the jid to subscribe to * @param tcToken token for subscription, use if present */ const presenceSubscribe = (toJid: string, tcToken?: Buffer) => ( sendNode({ tag: 'presence', attrs: { to: toJid, id: generateMessageTag(), type: 'subscribe' }, content: tcToken ? [ { tag: 'tctoken', attrs: {}, content: tcToken } ] : undefined }) ) const handlePresenceUpdate = ({ tag, attrs, content }: BinaryNode) => { let presence: PresenceData | undefined const jid = attrs.from const participant = attrs.participant || attrs.from if(shouldIgnoreJid(jid) && jid !== '@s.whatsapp.net') { return } if(tag === 'presence') { presence = { lastKnownPresence: attrs.type === 'unavailable' ? 'unavailable' : 'available', lastSeen: attrs.last && attrs.last !== 'deny' ? +attrs.last : undefined } } else if(Array.isArray(content)) { const [firstChild] = content let type = firstChild.tag as WAPresence if(type === 'paused') { type = 'available' } if(firstChild.attrs?.media === 'audio') { type = 'recording' } presence = { lastKnownPresence: type } } else { logger.error({ tag, attrs, content }, 'recv invalid presence node') } if(presence) { ev.emit('presence.update', { id: jid, presences: { [participant]: presence } }) } } const appPatch = async(patchCreate: WAPatchCreate) => { const name = patchCreate.type const myAppStateKeyId = authState.creds.myAppStateKeyId if(!myAppStateKeyId) { throw new Boom('App state key not present!', { statusCode: 400 }) } let initial: LTHashState let encodeResult: { patch: proto.ISyncdPatch, state: LTHashState } await processingMutex.mutex( async() => { await authState.keys.transaction( async() => { logger.debug({ patch: patchCreate }, 'applying app patch') await resyncAppState([name], false) const { [name]: currentSyncVersion } = await authState.keys.get('app-state-sync-version', [name]) initial = currentSyncVersion || newLTHashState() encodeResult = await encodeSyncdPatch( patchCreate, myAppStateKeyId, initial, getAppStateSyncKey, ) const { patch, state } = encodeResult const node: BinaryNode = { tag: 'iq', attrs: { to: S_WHATSAPP_NET, type: 'set', xmlns: 'w:sync:app:state' }, content: [ { tag: 'sync', attrs: {}, content: [ { tag: 'collection', attrs: { name, version: (state.version - 1).toString(), 'return_snapshot': 'false' }, content: [ { tag: 'patch', attrs: {}, content: proto.SyncdPatch.encode(patch).finish() } ] } ] } ] } await query(node) await authState.keys.set({ 'app-state-sync-version': { [name]: state } }) } ) } ) if(config.emitOwnEvents) { const { onMutation } = newAppStateChunkHandler(false) const { mutationMap } = await decodePatches( name, [{ ...encodeResult!.patch, version: { version: encodeResult!.state.version }, }], initial!, getAppStateSyncKey, config.options, undefined, logger, ) for(const key in mutationMap) { onMutation(mutationMap[key]) } } } /** sending non-abt props may fix QR scan fail if server expects */ const fetchProps = async() => { const resultNode = await query({ tag: 'iq', attrs: { to: S_WHATSAPP_NET, xmlns: 'w', type: 'get', }, content: [ { tag: 'props', attrs: { protocol: '2', hash: authState?.creds?.lastPropHash || '' } } ] }) const propsNode = getBinaryNodeChild(resultNode, 'props') let props: { [_: string]: string } = {} if(propsNode) { if(propsNode.attrs?.hash) { // on some clients, the hash is returning as undefined authState.creds.lastPropHash = propsNode?.attrs?.hash ev.emit('creds.update', authState.creds) } props = reduceBinaryNodeToDictionary(propsNode, 'prop') } logger.debug('fetched props') return props } /** * modify a chat -- mark unread, read etc. * lastMessages must be sorted in reverse chronologically * requires the last messages till the last message received; required for archive & unread */ const chatModify = (mod: ChatModification, jid: string) => { const patch = chatModificationToAppPatch(mod, jid) return appPatch(patch) } /** * Star or Unstar a message */ const star = (jid: string, messages: { id: string, fromMe?: boolean }[], star: boolean) => { return chatModify({ star: { messages, star } }, jid) } /** * Adds label */ const addLabel = (jid: string, labels: LabelActionBody) => { return chatModify({ addLabel: { ...labels } }, jid) } /** * Adds label for the chats */ const addChatLabel = (jid: string, labelId: string) => { return chatModify({ addChatLabel: { labelId } }, jid) } /** * Removes label for the chat */ const removeChatLabel = (jid: string, labelId: string) => { return chatModify({ removeChatLabel: { labelId } }, jid) } /** * Adds label for the message */ const addMessageLabel = (jid: string, messageId: string, labelId: string) => { return chatModify({ addMessageLabel: { messageId, labelId } }, jid) } /** * Removes label for the message */ const removeMessageLabel = (jid: string, messageId: string, labelId: string) => { return chatModify({ removeMessageLabel: { messageId, labelId } }, jid) } /** * queries need to be fired on connection open * help ensure parity with WA Web * */ const executeInitQueries = async() => { await Promise.all([ fetchProps(), fetchBlocklist(), fetchPrivacySettings(), ]) } const upsertMessage = ev.createBufferedFunction(async(msg: WAMessage, type: MessageUpsertType) => { ev.emit('messages.upsert', { messages: [msg], type }) if(!!msg.pushName) { let jid = msg.key.fromMe ? authState.creds.me!.id : (msg.key.participant || msg.key.remoteJid) jid = jidNormalizedUser(jid!) if(!msg.key.fromMe) { ev.emit('contacts.update', [{ id: jid, notify: msg.pushName, verifiedName: msg.verifiedBizName! }]) } // update our pushname too if(msg.key.fromMe && msg.pushName && authState.creds.me?.name !== msg.pushName) { ev.emit('creds.update', { me: { ...authState.creds.me!, name: msg.pushName } }) } } const historyMsg = getHistoryMsg(msg.message!) const shouldProcessHistoryMsg = historyMsg ? ( shouldSyncHistoryMessage(historyMsg) && PROCESSABLE_HISTORY_TYPES.includes(historyMsg.syncType!) ) : false if(historyMsg && !authState.creds.myAppStateKeyId) { logger.warn('skipping app state sync, as myAppStateKeyId is not set') pendingAppStateSync = true } await Promise.all([ (async() => { if( historyMsg && authState.creds.myAppStateKeyId ) { pendingAppStateSync = false await doAppStateSync() } })(), processMessage( msg, { shouldProcessHistoryMsg, placeholderResendCache, ev, creds: authState.creds, keyStore: authState.keys, logger, options: config.options, } ) ]) if( msg.message?.protocolMessage?.appStateSyncKeyShare && pendingAppStateSync ) { await doAppStateSync() pendingAppStateSync = false } async function doAppStateSync() { if(!authState.creds.accountSyncCounter) { logger.info('doing initial app state sync') await resyncAppState(ALL_WA_PATCH_NAMES, true) const accountSyncCounter = (authState.creds.accountSyncCounter || 0) + 1 ev.emit('creds.update', { accountSyncCounter }) if(needToFlushWithAppStateSync) { logger.debug('flushing with app state sync') ev.flush() } } } }) ws.on('CB:presence', handlePresenceUpdate) ws.on('CB:chatstate', handlePresenceUpdate) ws.on('CB:ib,,dirty', async(node: BinaryNode) => { const { attrs } = getBinaryNodeChild(node, 'dirty')! const type = attrs.type switch (type) { case 'account_sync': if(attrs.timestamp) { let { lastAccountSyncTimestamp } = authState.creds if(lastAccountSyncTimestamp) { await cleanDirtyBits('account_sync', lastAccountSyncTimestamp) } lastAccountSyncTimestamp = +attrs.timestamp ev.emit('creds.update', { lastAccountSyncTimestamp }) } break case 'groups': // handled in groups.ts break default: logger.info({ node }, 'received unknown sync') break } }) ev.on('connection.update', ({ connection, receivedPendingNotifications }) => { if(connection === 'open') { if(fireInitQueries) { executeInitQueries() .catch( error => onUnexpectedError(error, 'init queries') ) } sendPresenceUpdate(markOnlineOnConnect ? 'available' : 'unavailable') .catch( error => onUnexpectedError(error, 'presence update requests') ) } if(receivedPendingNotifications && // if we don't have the app state key // we keep buffering events until we finally have // the key and can sync the messages // todo scrutinize !authState.creds?.myAppStateKeyId) { ev.buffer() needToFlushWithAppStateSync = true } }) return { ...sock, processingMutex, fetchPrivacySettings, upsertMessage, appPatch, sendPresenceUpdate, presenceSubscribe, profilePictureUrl, onWhatsApp, fetchBlocklist, fetchStatus, fetchDisappearingDuration, updateProfilePicture, removeProfilePicture, updateProfileStatus, updateProfileName, updateBlockStatus, updateCallPrivacy, updateMessagesPrivacy, updateLastSeenPrivacy, updateOnlinePrivacy, updateProfilePicturePrivacy, updateStatusPrivacy, updateReadReceiptsPrivacy, updateGroupsAddPrivacy, updateDefaultDisappearingMode, getBusinessProfile, resyncAppState, chatModify, cleanDirtyBits, addLabel, addChatLabel, removeChatLabel, addMessageLabel, removeMessageLabel, star } }