Repository navigation
Expand file tree
/
Copy pathsend.go
More file actions
1434 lines (1338 loc) · 46.8 KB
/
Copy pathsend.go
File metadata and controls
1434 lines (1338 loc) · 46.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright (c) 2022 Tulir Asokan
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
package whatsmeow
import (
"context"
"crypto/sha256"
"encoding/base64"
"encoding/binary"
"encoding/hex"
"errors"
"fmt"
"slices"
"sort"
"strconv"
"strings"
"time"
"github.com/rs/zerolog"
"go.mau.fi/libsignal/groups"
"go.mau.fi/libsignal/keys/prekey"
"go.mau.fi/libsignal/protocol"
"go.mau.fi/libsignal/session"
"go.mau.fi/libsignal/signalerror"
"go.mau.fi/util/random"
"google.golang.org/protobuf/proto"
waBinary "go.mau.fi/whatsmeow/binary"
"go.mau.fi/whatsmeow/proto/waAICommon"
"go.mau.fi/whatsmeow/proto/waCommon"
"go.mau.fi/whatsmeow/proto/waE2E"
"go.mau.fi/whatsmeow/types"
"go.mau.fi/whatsmeow/types/events"
)
const WebMessageIDPrefix = "3EB0"
// GenerateMessageID generates a random string that can be used as a message ID on WhatsApp.
//
// msgID := cli.GenerateMessageID()
// cli.SendMessage(context.Background(), targetJID, &waE2E.Message{...}, whatsmeow.SendRequestExtra{ID: msgID})
func (cli *Client) GenerateMessageID() types.MessageID {
if cli != nil && cli.MessengerConfig != nil {
return types.MessageID(strconv.FormatInt(GenerateFacebookMessageID(), 10))
}
data := make([]byte, 8, 8+20+16)
binary.BigEndian.PutUint64(data, uint64(time.Now().Unix()))
ownID := cli.getOwnID()
if !ownID.IsEmpty() {
data = append(data, []byte(ownID.User)...)
data = append(data, []byte("@c.us")...)
}
data = append(data, random.Bytes(16)...)
hash := sha256.Sum256(data)
return WebMessageIDPrefix + strings.ToUpper(hex.EncodeToString(hash[:9]))
}
func GenerateFacebookMessageID() int64 {
const randomMask = (1 << 22) - 1
return (time.Now().UnixMilli() << 22) | (int64(binary.BigEndian.Uint32(random.Bytes(4))) & randomMask)
}
// GenerateMessageID generates a random string that can be used as a message ID on WhatsApp.
//
// msgID := whatsmeow.GenerateMessageID()
// cli.SendMessage(context.Background(), targetJID, &waE2E.Message{...}, whatsmeow.SendRequestExtra{ID: msgID})
//
// Deprecated: WhatsApp web has switched to using a hash of the current timestamp, user id and random bytes. Use Client.GenerateMessageID instead.
func GenerateMessageID() types.MessageID {
return WebMessageIDPrefix + strings.ToUpper(hex.EncodeToString(random.Bytes(8)))
}
type MessageDebugTimings struct {
LIDFetch time.Duration
Queue time.Duration
Marshal time.Duration
GetParticipants time.Duration
GetDevices time.Duration
GroupEncrypt time.Duration
PeerEncrypt time.Duration
Send time.Duration
Resp time.Duration
Retry time.Duration
}
func (mdt MessageDebugTimings) MarshalZerologObject(evt *zerolog.Event) {
if mdt.LIDFetch != 0 {
evt.Dur("lid_fetch", mdt.LIDFetch)
}
evt.Dur("queue", mdt.Queue)
evt.Dur("marshal", mdt.Marshal)
if mdt.GetParticipants != 0 {
evt.Dur("get_participants", mdt.GetParticipants)
}
evt.Dur("get_devices", mdt.GetDevices)
if mdt.GroupEncrypt != 0 {
evt.Dur("group_encrypt", mdt.GroupEncrypt)
}
evt.Dur("peer_encrypt", mdt.PeerEncrypt)
evt.Dur("send", mdt.Send)
evt.Dur("resp", mdt.Resp)
if mdt.Retry != 0 {
evt.Dur("retry", mdt.Retry)
}
}
type SendResponse struct {
// The message timestamp returned by the server
Timestamp time.Time
// The ID of the sent message
ID types.MessageID
// The server-specified ID of the sent message. Only present for newsletter messages.
ServerID types.MessageServerID
// Message handling duration, used for debugging
DebugTimings MessageDebugTimings
// The identity the message was sent with (LID or PN)
// This is currently not reliable in all cases.
Sender types.JID
}
// SendRequestExtra contains the optional parameters for SendMessage.
//
// By default, optional parameters don't have to be provided at all, e.g.
//
// cli.SendMessage(ctx, to, message)
//
// When providing optional parameters, add a single instance of this struct as the last parameter:
//
// cli.SendMessage(ctx, to, message, whatsmeow.SendRequestExtra{...})
//
// Trying to add multiple extra parameters will return an error.
type SendRequestExtra struct {
// The message ID to use when sending. If this is not provided, a random message ID will be generated
ID types.MessageID
// JID of the bot to be invoked (optional)
InlineBotJID types.JID
// Should the message be sent as a peer message (protocol messages to your own devices, e.g. app state key requests)
Peer bool
// A timeout for the send request. Unlike timeouts using the context parameter, this only applies
// to the actual response waiting and not preparing/encrypting the message.
// Defaults to 75 seconds. The timeout can be disabled by using a negative value.
Timeout time.Duration
// When sending media to newsletters, the Handle field returned by the file upload.
MediaHandle string
Meta *types.MsgMetaInfo
// use this only if you know what you are doing
AdditionalNodes *[]waBinary.Node
}
// SendMessage sends the given message.
//
// This method will wait for the server to acknowledge the message before returning.
// The return value is the timestamp of the message from the server.
//
// Optional parameters like the message ID can be specified with the SendRequestExtra struct.
// Only one extra parameter is allowed, put all necessary parameters in the same struct.
//
// The message itself can contain anything you want (within the protobuf schema).
// e.g. for a simple text message, use the Conversation field:
//
// cli.SendMessage(context.Background(), targetJID, &waE2E.Message{
// Conversation: proto.String("Hello, World!"),
// })
//
// Things like replies, mentioning users and the "forwarded" flag are stored in ContextInfo,
// which can be put in ExtendedTextMessage and any of the media message types.
//
// For uploading and sending media/attachments, see the Upload method.
//
// For other message types, you'll have to figure it out yourself. Looking at the protobuf schema
// in binary/proto/def.proto may be useful to find out all the allowed fields. Printing the RawMessage
// field in incoming message events to figure out what it contains is also a good way to learn how to
// send the same kind of message.
func (cli *Client) SendMessage(ctx context.Context, to types.JID, message *waE2E.Message, extra ...SendRequestExtra) (resp SendResponse, err error) {
if cli == nil {
err = ErrClientIsNil
return
}
var req SendRequestExtra
if len(extra) > 1 {
err = errors.New("only one extra parameter may be provided to SendMessage")
return
} else if len(extra) == 1 {
req = extra[0]
}
if to.Device > 0 && !req.Peer {
err = ErrRecipientADJID
return
}
ownID := cli.getOwnID()
if ownID.IsEmpty() {
err = ErrNotLoggedIn
return
}
if req.Timeout == 0 {
req.Timeout = defaultRequestTimeout
}
if len(req.ID) == 0 {
req.ID = cli.GenerateMessageID()
}
if to.Server == types.NewsletterServer {
// TODO somehow deduplicate this with the code in sendNewsletter?
if message.EditedMessage != nil {
req.ID = types.MessageID(message.GetEditedMessage().GetMessage().GetProtocolMessage().GetKey().GetID())
} else if message.ProtocolMessage != nil && message.ProtocolMessage.GetType() == waE2E.ProtocolMessage_REVOKE {
req.ID = types.MessageID(message.GetProtocolMessage().GetKey().GetID())
}
}
resp.ID = req.ID
isInlineBotMode := false
if !req.InlineBotJID.IsEmpty() {
if !req.InlineBotJID.IsBot() {
err = ErrInvalidInlineBotID
return
}
isInlineBotMode = true
}
isBotMode := isInlineBotMode || to.IsBot()
needsMessageSecret := isBotMode || cli.shouldIncludeReportingToken(message)
var extraParams nodeExtraParams
if needsMessageSecret {
if message.MessageContextInfo == nil {
message.MessageContextInfo = &waE2E.MessageContextInfo{}
}
if message.MessageContextInfo.MessageSecret == nil {
message.MessageContextInfo.MessageSecret = random.Bytes(32)
}
}
if isBotMode {
if message.MessageContextInfo.BotMetadata == nil {
message.MessageContextInfo.BotMetadata = &waAICommon.BotMetadata{
PersonaID: proto.String("867051314767696$760019659443059"),
}
}
if isInlineBotMode {
// inline mode specific code
messageSecret := message.GetMessageContextInfo().GetMessageSecret()
message = &waE2E.Message{
BotInvokeMessage: &waE2E.FutureProofMessage{
Message: &waE2E.Message{
ExtendedTextMessage: message.ExtendedTextMessage,
MessageContextInfo: &waE2E.MessageContextInfo{
BotMetadata: message.MessageContextInfo.BotMetadata,
},
},
},
MessageContextInfo: message.MessageContextInfo,
}
botMessage := &waE2E.Message{
BotInvokeMessage: message.BotInvokeMessage,
MessageContextInfo: &waE2E.MessageContextInfo{
BotMetadata: message.MessageContextInfo.BotMetadata,
BotMessageSecret: applyBotMessageHKDF(messageSecret),
},
}
messagePlaintext, _, marshalErr := marshalMessage(req.InlineBotJID, botMessage)
if marshalErr != nil {
err = marshalErr
return
}
var participantNodes []waBinary.Node
participantNodes, _, err = cli.encryptMessageForDevices(ctx, []types.JID{req.InlineBotJID}, resp.ID, messagePlaintext, nil, waBinary.Attrs{})
if err != nil {
return
}
extraParams.botNode = &waBinary.Node{
Tag: "bot",
Attrs: nil,
Content: participantNodes,
}
}
}
var groupParticipants []types.JID
if to.Server == types.GroupServer || to.Server == types.BroadcastServer {
start := time.Now()
if to.Server == types.GroupServer {
var cachedData *groupMetaCache
cachedData, err = cli.getCachedGroupData(ctx, to)
if err != nil {
err = fmt.Errorf("failed to get group members: %w", err)
return
}
groupParticipants = cachedData.Members
// TODO this is fairly hacky, is there a proper way to determine which identity the message is sent with?
if cachedData.AddressingMode == types.AddressingModeLID {
ownID = cli.getOwnLID()
extraParams.addressingMode = types.AddressingModeLID
} else if cachedData.CommunityAnnouncementGroup && req.Meta != nil {
ownID = cli.getOwnLID()
// Why is this set to PN?
extraParams.addressingMode = types.AddressingModePN
}
} else {
groupParticipants, err = cli.getBroadcastListParticipants(ctx, to)
if err != nil {
err = fmt.Errorf("failed to get broadcast list members: %w", err)
return
}
}
resp.DebugTimings.GetParticipants = time.Since(start)
} else if to.Server == types.HiddenUserServer {
ownID = cli.getOwnLID()
} else if to.Server == types.DefaultUserServer && cli.Store.LIDMigrationTimestamp > 0 && !req.Peer {
start := time.Now()
var toLID types.JID
toLID, err = cli.Store.LIDs.GetLIDForPN(ctx, to)
if err != nil {
err = fmt.Errorf("failed to get LID for PN %s: %w", to, err)
return
} else if toLID.IsEmpty() {
var info map[types.JID]types.UserInfo
info, err = cli.GetUserInfo(ctx, []types.JID{to})
if err != nil {
err = fmt.Errorf("failed to get user info for %s to fill LID cache: %w", to, err)
return
} else if toLID = info[to].LID; toLID.IsEmpty() {
err = fmt.Errorf("no LID found for %s from server", to)
return
}
}
resp.DebugTimings.LIDFetch = time.Since(start)
cli.Log.Debugf("Replacing SendMessage destination with LID as migration timestamp is set %s -> %s", to, toLID)
to = toLID
ownID = cli.getOwnLID()
}
if req.Meta != nil {
extraParams.metaNode = &waBinary.Node{
Tag: "meta",
Attrs: waBinary.Attrs{},
}
if req.Meta.DeprecatedLIDSession != nil {
extraParams.metaNode.Attrs["deprecated_lid_session"] = *req.Meta.DeprecatedLIDSession
}
if req.Meta.ThreadMessageID != "" {
extraParams.metaNode.Attrs["thread_msg_id"] = req.Meta.ThreadMessageID
extraParams.metaNode.Attrs["thread_msg_sender_jid"] = req.Meta.ThreadMessageSenderJID
}
}
if req.AdditionalNodes != nil {
extraParams.additionalNodes = req.AdditionalNodes
}
resp.Sender = ownID
start := time.Now()
// Sending multiple messages at a time can cause weird issues and makes it harder to retry safely
// This is also required for the session prefetching that makes group sends faster
// (everything will explode if you send a message to the same user twice in parallel)
cli.messageSendLock.Lock()
resp.DebugTimings.Queue = time.Since(start)
defer cli.messageSendLock.Unlock()
// Peer message retries aren't implemented yet
if !req.Peer {
err = cli.addRecentMessage(ctx, to, req.ID, message, nil)
if err != nil {
return
}
}
if message.GetMessageContextInfo().GetMessageSecret() != nil {
err = cli.Store.MsgSecrets.PutMessageSecret(ctx, to, ownID, req.ID, message.GetMessageContextInfo().GetMessageSecret())
if err != nil {
cli.Log.Warnf("Failed to store message secret key for outgoing message %s: %v", req.ID, err)
} else {
cli.Log.Debugf("Stored message secret key for outgoing message %s", req.ID)
}
}
respChan := cli.waitResponse(req.ID)
var phash string
var data []byte
switch to.Server {
case types.GroupServer, types.BroadcastServer:
phash, data, err = cli.sendGroup(ctx, ownID, to, groupParticipants, req.ID, message, &resp.DebugTimings, extraParams)
case types.DefaultUserServer, types.BotServer, types.HiddenUserServer:
if req.Peer {
data, err = cli.sendPeerMessage(ctx, to, req.ID, message, &resp.DebugTimings)
} else {
phash, data, err = cli.sendDM(ctx, ownID, to, req.ID, message, &resp.DebugTimings, extraParams)
}
case types.NewsletterServer:
data, err = cli.sendNewsletter(ctx, to, req.ID, message, req.MediaHandle, &resp.DebugTimings)
default:
err = fmt.Errorf("%w %s", ErrUnknownServer, to.Server)
}
start = time.Now()
if err != nil {
cli.cancelResponse(req.ID, respChan)
return
}
var respNode *waBinary.Node
var timeoutChan <-chan time.Time
if req.Timeout > 0 {
timeoutChan = time.After(req.Timeout)
} else {
timeoutChan = make(<-chan time.Time)
}
select {
case respNode = <-respChan:
case <-timeoutChan:
cli.cancelResponse(req.ID, respChan)
err = ErrMessageTimedOut
return
case <-ctx.Done():
cli.cancelResponse(req.ID, respChan)
err = ctx.Err()
return
}
resp.DebugTimings.Resp = time.Since(start)
if isDisconnectNode(respNode) {
start = time.Now()
respNode, err = cli.retryFrame(ctx, "message send", req.ID, data, respNode, 0)
resp.DebugTimings.Retry = time.Since(start)
if err != nil {
return
}
}
ag := respNode.AttrGetter()
resp.ServerID = types.MessageServerID(ag.OptionalInt("server_id"))
resp.Timestamp = ag.UnixTime("t")
if errorCode := ag.Int("error"); errorCode != 0 {
err = fmt.Errorf("%w %d", ErrServerReturnedError, errorCode)
}
expectedPHash := ag.OptionalString("phash")
if len(expectedPHash) > 0 && phash != expectedPHash {
cli.Log.Warnf("Server returned different participant list hash (%s != %s) when sending to %s. Some devices may not have received the message.", phash, expectedPHash, to)
switch to.Server {
case types.GroupServer:
// TODO also invalidate device list caches
cli.groupCacheLock.Lock()
delete(cli.groupCache, to)
cli.groupCacheLock.Unlock()
case types.BroadcastServer:
// TODO do something
case types.DefaultUserServer, types.HiddenUserServer, types.BotServer, types.HostedServer, types.HostedLIDServer:
cli.userDevicesCacheLock.Lock()
delete(cli.userDevicesCache, to)
cli.userDevicesCacheLock.Unlock()
}
}
return
}
func (cli *Client) SendPeerMessage(ctx context.Context, message *waE2E.Message) (SendResponse, error) {
ownID := cli.getOwnID().ToNonAD()
if ownID.IsEmpty() {
return SendResponse{}, ErrNotLoggedIn
}
return cli.SendMessage(ctx, ownID, message, SendRequestExtra{Peer: true})
}
// RevokeMessage deletes the given message from everyone in the chat.
//
// This method will wait for the server to acknowledge the revocation message before returning.
// The return value is the timestamp of the message from the server.
//
// Deprecated: This method is deprecated in favor of BuildRevoke
func (cli *Client) RevokeMessage(ctx context.Context, chat types.JID, id types.MessageID) (SendResponse, error) {
return cli.SendMessage(ctx, chat, cli.BuildRevoke(chat, types.EmptyJID, id))
}
// BuildMessageKey builds a MessageKey object, which is used to refer to previous messages
// for things such as replies, revocations and reactions.
func (cli *Client) BuildMessageKey(chat, sender types.JID, id types.MessageID) *waCommon.MessageKey {
key := &waCommon.MessageKey{
FromMe: proto.Bool(true),
ID: proto.String(id),
RemoteJID: proto.String(chat.String()),
}
if !sender.IsEmpty() && sender.User != cli.getOwnID().User && sender.User != cli.getOwnLID().User {
key.FromMe = proto.Bool(false)
if chat.Server != types.DefaultUserServer && chat.Server != types.HiddenUserServer && chat.Server != types.MessengerServer {
key.Participant = proto.String(sender.ToNonAD().String())
}
}
return key
}
// BuildRevoke builds a message revocation message using the given variables.
// The built message can be sent normally using Client.SendMessage.
//
// To revoke your own messages, pass your JID or an empty JID as the second parameter (sender).
//
// resp, err := cli.SendMessage(context.Background(), chat, cli.BuildRevoke(chat, types.EmptyJID, originalMessageID)
//
// To revoke someone else's messages when you are group admin, pass the message sender's JID as the second parameter.
//
// resp, err := cli.SendMessage(context.Background(), chat, cli.BuildRevoke(chat, senderJID, originalMessageID)
func (cli *Client) BuildRevoke(chat, sender types.JID, id types.MessageID) *waE2E.Message {
return &waE2E.Message{
ProtocolMessage: &waE2E.ProtocolMessage{
Type: waE2E.ProtocolMessage_REVOKE.Enum(),
Key: cli.BuildMessageKey(chat, sender, id),
},
}
}
// BuildReaction builds a message reaction message using the given variables.
// The built message can be sent normally using Client.SendMessage.
//
// resp, err := cli.SendMessage(context.Background(), chat, cli.BuildReaction(chat, senderJID, targetMessageID, "🐈️")
//
// Note that for newsletter messages, you need to use NewsletterSendReaction instead of BuildReaction + SendMessage.
func (cli *Client) BuildReaction(chat, sender types.JID, id types.MessageID, reaction string) *waE2E.Message {
return &waE2E.Message{
ReactionMessage: &waE2E.ReactionMessage{
Key: cli.BuildMessageKey(chat, sender, id),
Text: proto.String(reaction),
SenderTimestampMS: proto.Int64(time.Now().UnixMilli()),
},
}
}
// BuildUnavailableMessageRequest builds a message to request the user's primary device to send
// the copy of a message that this client was unable to decrypt.
//
// The built message can be sent using Client.SendPeerMessage.
// The full response will come as a ProtocolMessage with type `PEER_DATA_OPERATION_REQUEST_RESPONSE_MESSAGE`.
// The response events will also be dispatched as normal *events.Message's with UnavailableRequestID set to the request message ID.
func (cli *Client) BuildUnavailableMessageRequest(chat, sender types.JID, id string) *waE2E.Message {
return &waE2E.Message{
ProtocolMessage: &waE2E.ProtocolMessage{
Type: waE2E.ProtocolMessage_PEER_DATA_OPERATION_REQUEST_MESSAGE.Enum(),
PeerDataOperationRequestMessage: &waE2E.PeerDataOperationRequestMessage{
PeerDataOperationRequestType: waE2E.PeerDataOperationRequestType_PLACEHOLDER_MESSAGE_RESEND.Enum(),
PlaceholderMessageResendRequest: []*waE2E.PeerDataOperationRequestMessage_PlaceholderMessageResendRequest{{
MessageKey: cli.BuildMessageKey(chat, sender, id),
}},
},
},
}
}
// BuildHistorySyncRequest builds a message to request additional history from the user's primary device.
//
// The built message can be sent using Client.SendPeerMessage.
// The response will come as an *events.HistorySync with type `ON_DEMAND`.
//
// The response will contain to `count` messages immediately before the given message.
// The recommended number of messages to request at a time is 50.
func (cli *Client) BuildHistorySyncRequest(lastKnownMessageInfo *types.MessageInfo, count int) *waE2E.Message {
return &waE2E.Message{
ProtocolMessage: &waE2E.ProtocolMessage{
Type: waE2E.ProtocolMessage_PEER_DATA_OPERATION_REQUEST_MESSAGE.Enum(),
PeerDataOperationRequestMessage: &waE2E.PeerDataOperationRequestMessage{
PeerDataOperationRequestType: waE2E.PeerDataOperationRequestType_HISTORY_SYNC_ON_DEMAND.Enum(),
HistorySyncOnDemandRequest: &waE2E.PeerDataOperationRequestMessage_HistorySyncOnDemandRequest{
ChatJID: proto.String(lastKnownMessageInfo.Chat.String()),
OldestMsgID: proto.String(lastKnownMessageInfo.ID),
OldestMsgFromMe: proto.Bool(lastKnownMessageInfo.IsFromMe),
OnDemandMsgCount: proto.Int32(int32(count)),
// Despite the field name saying "MS", this is actually supposed to contain seconds
OldestMsgTimestampMS: proto.Int64(lastKnownMessageInfo.Timestamp.Unix()),
},
},
},
}
}
// EditWindow specifies how long a message can be edited for after it was sent.
const EditWindow = 20 * time.Minute
// BuildEdit builds a message edit message using the given variables.
// The built message can be sent normally using Client.SendMessage.
//
// resp, err := cli.SendMessage(context.Background(), chat, cli.BuildEdit(chat, originalMessageID, &waE2E.Message{
// Conversation: proto.String("edited message"),
// })
func (cli *Client) BuildEdit(chat types.JID, id types.MessageID, newContent *waE2E.Message) *waE2E.Message {
return &waE2E.Message{
EditedMessage: &waE2E.FutureProofMessage{
Message: &waE2E.Message{
ProtocolMessage: &waE2E.ProtocolMessage{
Key: &waCommon.MessageKey{
FromMe: proto.Bool(true),
ID: proto.String(id),
RemoteJID: proto.String(chat.String()),
},
Type: waE2E.ProtocolMessage_MESSAGE_EDIT.Enum(),
EditedMessage: newContent,
TimestampMS: proto.Int64(time.Now().UnixMilli()),
},
},
},
}
}
const (
DisappearingTimerOff = time.Duration(0)
DisappearingTimer24Hours = 24 * time.Hour
DisappearingTimer7Days = 7 * 24 * time.Hour
DisappearingTimer90Days = 90 * 24 * time.Hour
)
// ParseDisappearingTimerString parses common human-readable disappearing message timer strings into Duration values.
// If the string doesn't look like one of the allowed values (0, 24h, 7d, 90d), the second return value is false.
func ParseDisappearingTimerString(val string) (time.Duration, bool) {
switch strings.ReplaceAll(strings.ToLower(val), " ", "") {
case "0d", "0h", "0s", "0", "off":
return DisappearingTimerOff, true
case "1day", "day", "1d", "1", "24h", "24", "86400s", "86400":
return DisappearingTimer24Hours, true
case "1week", "week", "7d", "7", "168h", "168", "604800s", "604800":
return DisappearingTimer7Days, true
case "3months", "3m", "3mo", "90d", "90", "2160h", "2160", "7776000s", "7776000":
return DisappearingTimer90Days, true
default:
return 0, false
}
}
// SetDisappearingTimer sets the disappearing timer in a chat. Both private chats and groups are supported, but they're
// set with different methods.
//
// Note that while this function allows passing non-standard durations, official WhatsApp apps will ignore those,
// and in groups the server will just reject the change. You can use the DisappearingTimer<Duration> constants for convenience.
//
// In groups, the server will echo the change as a notification, so it'll show up as a *events.GroupInfo update.
func (cli *Client) SetDisappearingTimer(ctx context.Context, chat types.JID, timer time.Duration, settingTS time.Time) (err error) {
switch chat.Server {
case types.DefaultUserServer, types.HiddenUserServer:
if settingTS.IsZero() {
settingTS = time.Now()
}
_, err = cli.SendMessage(ctx, chat, &waE2E.Message{
ProtocolMessage: &waE2E.ProtocolMessage{
Type: waE2E.ProtocolMessage_EPHEMERAL_SETTING.Enum(),
EphemeralExpiration: proto.Uint32(uint32(timer.Seconds())),
EphemeralSettingTimestamp: proto.Int64(settingTS.Unix()),
},
})
case types.GroupServer:
if timer == 0 {
_, err = cli.sendGroupIQ(ctx, iqSet, chat, waBinary.Node{Tag: "not_ephemeral"})
} else {
_, err = cli.sendGroupIQ(ctx, iqSet, chat, waBinary.Node{
Tag: "ephemeral",
Attrs: waBinary.Attrs{
"expiration": strconv.Itoa(int(timer.Seconds())),
},
})
if errors.Is(err, ErrIQBadRequest) {
err = wrapIQError(ErrInvalidDisappearingTimer, err)
}
}
default:
err = fmt.Errorf("can't set disappearing time in a %s chat", chat.Server)
}
return
}
func participantListHashV2(participants []types.JID) string {
participantsStrings := make([]string, len(participants))
for i, part := range participants {
participantsStrings[i] = part.ADString()
}
sort.Strings(participantsStrings)
hash := sha256.Sum256([]byte(strings.Join(participantsStrings, "")))
return fmt.Sprintf("2:%s", base64.RawStdEncoding.EncodeToString(hash[:6]))
}
func (cli *Client) sendNewsletter(
ctx context.Context,
to types.JID,
id types.MessageID,
message *waE2E.Message,
mediaID string,
timings *MessageDebugTimings,
) ([]byte, error) {
attrs := waBinary.Attrs{
"to": to,
"id": id,
"type": getTypeFromMessage(message),
}
if mediaID != "" {
attrs["media_id"] = mediaID
}
if message.EditedMessage != nil {
attrs["edit"] = string(types.EditAttributeAdminEdit)
message = message.GetEditedMessage().GetMessage().GetProtocolMessage().GetEditedMessage()
} else if message.ProtocolMessage != nil && message.ProtocolMessage.GetType() == waE2E.ProtocolMessage_REVOKE {
attrs["edit"] = string(types.EditAttributeAdminRevoke)
message = nil
}
start := time.Now()
plaintext, _, err := marshalMessage(to, message)
timings.Marshal = time.Since(start)
if err != nil {
return nil, err
}
plaintextNode := waBinary.Node{
Tag: "plaintext",
Content: plaintext,
Attrs: waBinary.Attrs{},
}
if message != nil {
if mediaType := getMediaTypeFromMessage(message); mediaType != "" {
plaintextNode.Attrs["mediatype"] = mediaType
}
}
node := waBinary.Node{
Tag: "message",
Attrs: attrs,
Content: []waBinary.Node{plaintextNode},
}
start = time.Now()
data, err := cli.sendNodeAndGetData(ctx, node)
timings.Send = time.Since(start)
if err != nil {
return nil, fmt.Errorf("failed to send message node: %w", err)
}
return data, nil
}
type nodeExtraParams struct {
botNode *waBinary.Node
metaNode *waBinary.Node
additionalNodes *[]waBinary.Node
addressingMode types.AddressingMode
}
func (cli *Client) sendGroup(
ctx context.Context,
ownID,
to types.JID,
participants []types.JID,
id types.MessageID,
message *waE2E.Message,
timings *MessageDebugTimings,
extraParams nodeExtraParams,
) (string, []byte, error) {
start := time.Now()
plaintext, _, err := marshalMessage(to, message)
timings.Marshal = time.Since(start)
if err != nil {
return "", nil, err
}
start = time.Now()
builder := groups.NewGroupSessionBuilder(cli.Store, pbSerializer)
senderKeyName := protocol.NewSenderKeyName(to.String(), cli.getOwnLID().SignalAddress())
signalSKDMessage, err := builder.Create(ctx, senderKeyName)
if err != nil {
return "", nil, fmt.Errorf("failed to create sender key distribution message to send %s to %s: %w", id, to, err)
}
skdMessage := &waE2E.Message{
SenderKeyDistributionMessage: &waE2E.SenderKeyDistributionMessage{
GroupID: proto.String(to.String()),
AxolotlSenderKeyDistributionMessage: signalSKDMessage.Serialize(),
},
}
skdPlaintext, err := proto.Marshal(skdMessage)
if err != nil {
return "", nil, fmt.Errorf("failed to marshal sender key distribution message to send %s to %s: %w", id, to, err)
}
cipher := groups.NewGroupCipher(builder, senderKeyName, cli.Store)
encrypted, err := cipher.Encrypt(ctx, padMessage(plaintext))
if err != nil {
return "", nil, fmt.Errorf("failed to encrypt group message to send %s to %s: %w", id, to, err)
}
ciphertext := encrypted.SignedSerialize()
timings.GroupEncrypt = time.Since(start)
node, allDevices, err := cli.prepareMessageNode(
ctx, to, id, message, participants, skdPlaintext, nil, timings, extraParams,
)
if err != nil {
return "", nil, err
}
phash := participantListHashV2(allDevices)
node.Attrs["phash"] = phash
skMsg := waBinary.Node{
Tag: "enc",
Content: ciphertext,
Attrs: waBinary.Attrs{"v": "2", "type": "skmsg"},
}
if mediaType := getMediaTypeFromMessage(message); mediaType != "" {
skMsg.Attrs["mediatype"] = mediaType
}
node.Content = append(node.GetChildren(), skMsg)
if cli.shouldIncludeReportingToken(message) && message.GetMessageContextInfo().GetMessageSecret() != nil {
node.Content = append(node.GetChildren(), cli.getMessageReportingToken(plaintext, message, ownID, to, id))
}
start = time.Now()
data, err := cli.sendNodeAndGetData(ctx, *node)
timings.Send = time.Since(start)
if err != nil {
return "", nil, fmt.Errorf("failed to send message node: %w", err)
}
return phash, data, nil
}
func (cli *Client) sendPeerMessage(
ctx context.Context,
to types.JID,
id types.MessageID,
message *waE2E.Message,
timings *MessageDebugTimings,
) ([]byte, error) {
node, err := cli.preparePeerMessageNode(ctx, to, id, message, timings)
if err != nil {
return nil, err
}
start := time.Now()
data, err := cli.sendNodeAndGetData(ctx, *node)
timings.Send = time.Since(start)
if err != nil {
return nil, fmt.Errorf("failed to send message node: %w", err)
}
return data, nil
}
func (cli *Client) sendDM(
ctx context.Context,
ownID,
to types.JID,
id types.MessageID,
message *waE2E.Message,
timings *MessageDebugTimings,
extraParams nodeExtraParams,
) (string, []byte, error) {
start := time.Now()
messagePlaintext, deviceSentMessagePlaintext, err := marshalMessage(to, message)
timings.Marshal = time.Since(start)
if err != nil {
return "", nil, err
}
node, allDevices, err := cli.prepareMessageNode(
ctx, to, id, message, []types.JID{to, ownID.ToNonAD()},
messagePlaintext, deviceSentMessagePlaintext, timings, extraParams,
)
if err != nil {
return "", nil, err
}
phash := participantListHashV2(allDevices)
if cli.shouldIncludeReportingToken(message) && message.GetMessageContextInfo().GetMessageSecret() != nil {
node.Content = append(node.GetChildren(), cli.getMessageReportingToken(messagePlaintext, message, ownID, to, id))
}
tcTokenBytes, tcErr := cli.ensureTCToken(ctx, to)
if tcErr != nil {
cli.Log.Warnf("Failed to get privacy token for %s: %v", to, tcErr)
}
if len(tcTokenBytes) > 0 {
node.Content = append(node.GetChildren(), waBinary.Node{
Tag: "tctoken",
Content: tcTokenBytes,
})
} else if csToken := cli.generateCsToken(ctx, to); len(csToken) > 0 {
node.Content = append(node.GetChildren(), waBinary.Node{
Tag: "cstoken",
Content: csToken,
})
}
start = time.Now()
data, err := cli.sendNodeAndGetData(ctx, *node)
timings.Send = time.Since(start)
if err != nil {
return "", nil, fmt.Errorf("failed to send message node: %w", err)
}
storageJID := cli.resolveTCTokenStorageLID(ctx, to)
if shouldSendTCTokenInChatAction(to) && shouldSendNewTCToken(cli.getTCTokenSenderTS(storageJID)) {
go cli.issuePrivacyTokenAndSave(storageJID, time.Now())
}
return phash, data, nil
}
func getTypeFromMessage(msg *waE2E.Message) string {
switch {
case msg.ViewOnceMessage != nil:
return getTypeFromMessage(msg.ViewOnceMessage.Message)
case msg.ViewOnceMessageV2 != nil:
return getTypeFromMessage(msg.ViewOnceMessageV2.Message)
case msg.ViewOnceMessageV2Extension != nil:
return getTypeFromMessage(msg.ViewOnceMessageV2Extension.Message)
case msg.LottieStickerMessage != nil:
return getTypeFromMessage(msg.LottieStickerMessage.Message)
case msg.EphemeralMessage != nil:
return getTypeFromMessage(msg.EphemeralMessage.Message)
case msg.DocumentWithCaptionMessage != nil:
return getTypeFromMessage(msg.DocumentWithCaptionMessage.Message)
case msg.ReactionMessage != nil, msg.EncReactionMessage != nil:
return "reaction"
case msg.PollCreationMessage != nil, msg.PollUpdateMessage != nil:
return "poll"
case getMediaTypeFromMessage(msg) != "":
return "media"
case msg.Conversation != nil, msg.ExtendedTextMessage != nil, msg.ProtocolMessage != nil:
return "text"
default:
return "text"
}
}
func getMediaTypeFromMessage(msg *waE2E.Message) string {
switch {
case msg.ViewOnceMessage != nil:
return getMediaTypeFromMessage(msg.ViewOnceMessage.Message)
case msg.ViewOnceMessageV2 != nil:
return getMediaTypeFromMessage(msg.ViewOnceMessageV2.Message)
case msg.ViewOnceMessageV2Extension != nil:
return getMediaTypeFromMessage(msg.ViewOnceMessageV2Extension.Message)
case msg.LottieStickerMessage != nil:
return getMediaTypeFromMessage(msg.LottieStickerMessage.Message)
case msg.EphemeralMessage != nil:
return getMediaTypeFromMessage(msg.EphemeralMessage.Message)
case msg.DocumentWithCaptionMessage != nil:
return getMediaTypeFromMessage(msg.DocumentWithCaptionMessage.Message)
case msg.ExtendedTextMessage != nil && msg.ExtendedTextMessage.Title != nil:
return "url"
case msg.ImageMessage != nil:
return "image"
case msg.StickerMessage != nil:
return "sticker"
case msg.DocumentMessage != nil:
return "document"
case msg.AudioMessage != nil:
if msg.AudioMessage.GetPTT() {
return "ptt"
} else {
return "audio"
}
case msg.VideoMessage != nil:
if msg.VideoMessage.GetGifPlayback() {
return "gif"
} else {
return "video"
}
case msg.ContactMessage != nil:
return "vcard"
case msg.ContactsArrayMessage != nil:
return "contact_array"
case msg.ListMessage != nil:
return "list"
case msg.ListResponseMessage != nil:
return "list_response"
case msg.ButtonsResponseMessage != nil:
return "buttons_response"
case msg.OrderMessage != nil:
return "order"
case msg.ProductMessage != nil:
return "product"
case msg.InteractiveResponseMessage != nil:
return "native_flow_response"
default:
return ""
}
}
func getButtonTypeFromMessage(msg *waE2E.Message) string {
switch {
case msg.ViewOnceMessage != nil:
return getButtonTypeFromMessage(msg.ViewOnceMessage.Message)
case msg.ViewOnceMessageV2 != nil:
return getButtonTypeFromMessage(msg.ViewOnceMessageV2.Message)
case msg.EphemeralMessage != nil:
return getButtonTypeFromMessage(msg.EphemeralMessage.Message)
case msg.ButtonsMessage != nil:
return "buttons"
case msg.ButtonsResponseMessage != nil:
return "buttons_response"
case msg.ListMessage != nil:
return "list"
case msg.ListResponseMessage != nil:
return "list_response"
case msg.InteractiveResponseMessage != nil:
return "interactive_response"