package main
import (
+ "cmp"
"context"
+ "crypto/sha256"
+ "encoding/hex"
"errors"
"fmt"
"log"
+ "maps"
"net/url"
"os"
"path/filepath"
"strings"
"sync"
"time"
+ "unicode"
"go.mau.fi/whatsmeow"
+ "go.mau.fi/whatsmeow/proto/waE2E"
"go.mau.fi/whatsmeow/store"
"go.mau.fi/whatsmeow/store/sqlstore"
"go.mau.fi/whatsmeow/types"
"go.mau.fi/whatsmeow/types/events"
waLog "go.mau.fi/whatsmeow/util/log"
+ "golang.org/x/text/runes"
+ "golang.org/x/text/transform"
+ "golang.org/x/text/unicode/norm"
// The session store of the library opens SQLite with this pure Go
// driver.
// whatsappCatchupLimit is the longest wait for the end of the catch-up
// after a connection.
whatsappCatchupLimit = time.Minute
+
+ // whatsappGroupsAge is how long whatsapp_find uses the groups that it
+ // read from WhatsApp.
+ whatsappGroupsAge = time.Hour
+
+ // whatsappFindMatches is the most matches of whatsapp_find.
+ whatsappFindMatches = 20
+
+ // whatsappNotLinked is the answer of a WhatsApp tool without a link.
+ whatsappNotLinked = "WhatsApp is not linked. Tell the user to run /whatsapp pair PHONE in the terminal or in Telegram."
+
+ // whatsappSendTime is the longest time of a send.
+ whatsappSendTime = 30 * time.Second
+
+ // whatsappSendBytes is the most bytes of the text of a send.
+ whatsappSendBytes = 65536
+
+ // whatsappSendIDBytes is the most bytes of the ID of a send.
+ whatsappSendIDBytes = 100
+
+ // The states of a send record.
+ whatsappSending = "sending"
+ whatsappSent = "sent"
+ whatsappFailed = "failed"
+
+ // whatsappNamesNotReady is the answer of whatsapp_find before the names
+ // arrive from the phone.
+ whatsappNamesNotReady = "The names of the contacts and groups have not arrived from the phone yet. They come some minutes after the link. Try again later."
)
// WhatsAppClient is the part of the WhatsApp client that the daemon uses. The
PairPhone(ctx context.Context, phone string, showPushNotification bool, clientType whatsmeow.PairClientType, clientDisplayName string) (string, error)
Logout(ctx context.Context) error
GetJoinedGroups(ctx context.Context) ([]*types.GroupInfo, error)
+ GenerateMessageID() types.MessageID
+ SendMessage(ctx context.Context, to types.JID, message *waE2E.Message, extra ...whatsmeow.SendRequestExtra) (whatsmeow.SendResponse, error)
}
// openWhatsApp opens the WhatsApp session in the data directory dir. Without
}
var err error
- w.batches, err = openWhatsAppBatches(filepath.Join(w.dir, whatsappStateFileName), whatsappBatchQuiet, whatsappBatchWindow)
+ w.state, err = openWhatsAppState(filepath.Join(w.dir, whatsappStateFileName), whatsappBatchQuiet, whatsappBatchWindow)
if err != nil {
return nil, err
}
// client, and the state of the connection, which the event handler of the
// library changes from its own goroutines.
//
-// The text messages go into batches, one chat at a time, as WhatsAppBatches
-// says. Run logs each closed batch as a work message that starts with
-// [WhatsApp], and a batch that needs the user wakes the turn loop.
+// The text messages go into batches, one chat at a time, as WhatsAppState says.
+// Run logs each closed batch as a work message that starts with [WhatsApp], and
+// a batch that needs the user wakes the turn loop.
//
// After each connection, the servers send the messages that came while the
// daemon was away, and then OfflineSyncCompleted. Until then, or until
logouts chan struct{}
wake chan struct{}
failures chan error
- batches *WhatsAppBatches
+ state *WhatsAppState
mutex sync.Mutex
container *sqlstore.Container
closed bool
groupNames map[string]string
groupsAt time.Time
+ groupsRead time.Time
catchingUp bool
caughtUp bool
catchups int
}
var due <-chan time.Time
- wait, open := w.batches.Wait(time.Now())
+ wait, open := w.state.Wait(time.Now())
if open {
due = time.After(wait)
}
pairing.Go(func() {
defer cancelPair()
- w.pair(pairCtx, l, request.phone, request.answer)
+ w.pair(pairCtx, ctx, l, request.phone, request.answer)
})
}
}
var err error
switch {
case all || caughtUp:
- err = w.batches.CloseAll()
+ err = w.state.CloseAll()
case catchingUp:
return nil
default:
- _, err = w.batches.CloseDue(time.Now())
+ _, err = w.state.CloseDue(time.Now())
}
if err != nil {
}
var turns []Message
- for _, batch := range w.batches.Closed() {
+ for _, batch := range w.state.Closed() {
if batch.Chat.Group && batch.Chat.Name == "" {
batch.Chat.Name = w.groupName(ctx, batch.Chat.ID)
}
return fmt.Errorf("log a WhatsApp batch: %w", err)
}
- err = w.batches.Remove(batch.Number)
+ err = w.state.Remove(batch.Number)
if err != nil {
return err
}
func (w *WhatsApp) groupName(ctx context.Context, id string) string {
w.mutex.Lock()
name, found := w.groupNames[id]
- client := w.client
fresh := time.Since(w.groupsAt) < whatsappGroupsRefresh
w.mutex.Unlock()
- if found {
- return name
+ if !found && !fresh {
+ w.readGroups(ctx)
+
+ w.mutex.Lock()
+ name, found = w.groupNames[id]
+ w.mutex.Unlock()
}
- if client == nil || fresh {
+ if !found || name == "" {
return whatsappUnknownGroup
}
+ return name
+}
+
+// readGroups reads the names of the groups of the account from WhatsApp, and
+// tells if it could. They stay in memory only.
+func (w *WhatsApp) readGroups(ctx context.Context) bool {
+ w.mutex.Lock()
+ client := w.client
+ w.mutex.Unlock()
+
+ if client == nil {
+ return false
+ }
+
ctx, cancel := context.WithTimeout(ctx, whatsappLookupTime)
defer cancel()
defer w.mutex.Unlock()
w.groupsAt = time.Now()
+ if err != nil {
+ return false
+ }
+
+ w.groupsRead = w.groupsAt
for _, group := range groups {
w.groupNames[group.JID.String()] = group.Name
}
- name, found = w.groupNames[id]
- if !found || name == "" {
- return whatsappUnknownGroup
+ return true
+}
+
+// Find returns the contacts and the groups whose name contains name, with no
+// regard to case and accents, as lines "ID | name | contact" or "ID | name |
+// group", sorted by name. It gives at most whatsappFindMatches lines and the
+// number of the others. The contacts come from the session database, and the
+// groups from WhatsApp, read again after whatsappGroupsAge. When the groups
+// cannot be read and none are known, the answer says so. Before the names
+// arrive from the phone, it says that they are not ready.
+func (w *WhatsApp) Find(ctx context.Context, name string) (string, error) {
+ w.mutex.Lock()
+ linked := w.linked
+ device := w.device
+ own := slices.Clone(w.own)
+ stale := time.Since(w.groupsRead) >= whatsappGroupsAge
+ w.mutex.Unlock()
+
+ if !linked {
+ return whatsappNotLinked, nil
}
- return name
+ query := whatsappFold(name)
+ if query == "" {
+ return "", errors.New("name is empty: give a part of the name of the contact or the group")
+ }
+
+ contacts, err := device.Contacts.GetAllContacts(ctx)
+ if err != nil {
+ return "", fmt.Errorf("read the contacts: %s", w.redact(err.Error()))
+ }
+
+ read := !stale || w.readGroups(ctx)
+ w.mutex.Lock()
+ groups := maps.Clone(w.groupNames)
+ w.mutex.Unlock()
+
+ if len(contacts) == 0 && len(groups) == 0 {
+ if !read {
+ return "The names are not known yet, and WhatsApp is disconnected, so the groups cannot be read. Try again later.", nil
+ }
+
+ return whatsappNamesNotReady, nil
+ }
+
+ var matches []WhatsAppMatch
+ for jid, contact := range contacts {
+ names := []string{contact.FullName, contact.FirstName, contact.BusinessName, contact.PushName}
+ shown := slices.IndexFunc(names, func(name string) bool {
+ return name != ""
+ })
+
+ if slices.Contains(own, jid.User) || shown < 0 || !slices.ContainsFunc(names, func(name string) bool {
+ return strings.Contains(whatsappFold(name), query)
+ }) {
+ continue
+ }
+
+ matches = append(matches, WhatsAppMatch{
+ id: jid.ToNonAD().String(),
+ name: names[shown],
+ kind: "contact",
+ })
+ }
+
+ for id, group := range groups {
+ if strings.Contains(whatsappFold(group), query) {
+ matches = append(matches, WhatsAppMatch{
+ id: id,
+ name: group,
+ kind: "group",
+ })
+ }
+ }
+
+ return whatsappFindAnswer(name, matches, read || len(groups) > 0), nil
}
// removeSession ends the connection, closes the session database, and deletes
// number, an expired code, or a failure. A pairing that a new one ends gives no
// answer. A link notes "WhatsApp is linked." in the log of l, with no number.
// The client of a pairing that does not link is disconnected.
-func (w *WhatsApp) pair(ctx context.Context, l *TurnLoop, phone string, answer func(text string)) {
+//
+// ctx limits the pairing, but the connection uses runCtx, the context of Run.
+// The library keeps the context of the connection for its keep-alive, its event
+// handler, and its reconnections, and after the link the server ends the stream
+// and the library connects again. With ctx, the end of the pairing would stop
+// that reconnection, and the linked device would never connect.
+func (w *WhatsApp) pair(ctx, runCtx context.Context, l *TurnLoop, phone string, answer func(text string)) {
device, err := w.newDevice(ctx)
if err != nil {
answer("The pairing failed: " + err.Error())
qr, err := client.GetQRChannel(ctx)
if err == nil {
- err = client.ConnectContext(ctx)
+ err = client.ConnectContext(runCtx)
}
if err != nil {
return true
}
- _, err := w.batches.Add(chat, message, time.Now())
+ _, err := w.state.Add(chat, message, time.Now())
if err != nil {
select {
case w.failures <- err:
return text
}
+// Send sends text to chat, the ID of a private chat or a group, and returns the
+// answer of the tool. id names the send: a call with an id that has a record
+// gives the answer of the record and sends nothing, and the same id with
+// another chat or text is an error. The record "sending" is durable before the
+// send, so a stop of the daemon during the send gives an answer that the result
+// is unknown, and not a second send. A disconnected WhatsApp sends nothing and
+// makes no record.
+func (w *WhatsApp) Send(ctx context.Context, id, chat, text string) (string, error) {
+ w.mutex.Lock()
+ linked := w.linked
+ device := w.device
+ client := w.client
+ connected := w.connected
+ own := slices.Clone(w.own)
+ w.mutex.Unlock()
+
+ if !linked {
+ return whatsappNotLinked, nil
+ }
+
+ jid, err := whatsappSendCheck(id, chat, text, own)
+ if err != nil {
+ return "", err
+ }
+
+ digest := sha256.Sum256([]byte(text))
+ record := WhatsAppSend{
+ ID: id,
+ Chat: chat,
+ Digest: hex.EncodeToString(digest[:]),
+ State: whatsappSending,
+ Time: w.clock(),
+ }
+
+ held, found := w.state.Send(id)
+ switch {
+ case found && (held.Chat != record.Chat || held.Digest != record.Digest):
+ return "", fmt.Errorf("the id %s belongs to another message: give a new id for each message", id)
+ case found && held.State == whatsappSending:
+ return "The send with this id started, but its result is unknown, because the daemon stopped during it. Ask the user to look at the chat in WhatsApp before you send the message again with a new id.", nil
+ case found:
+ return held.Answer + " This is the answer of the first call with this id: nothing was sent again.", nil
+ case client == nil || !connected:
+ return "", errors.New("WhatsApp is disconnected, so nothing was sent: try again later")
+ }
+
+ record.MessageID = client.GenerateMessageID()
+ err = w.state.PutSend(record)
+ if err != nil {
+ return "", err
+ }
+
+ sendCtx, cancel := context.WithTimeout(ctx, whatsappSendTime)
+ defer cancel()
+
+ response, err := client.SendMessage(sendCtx, jid, &waE2E.Message{
+ Conversation: new(text),
+ }, whatsmeow.SendRequestExtra{
+ ID: record.MessageID,
+ })
+
+ record.State = whatsappSent
+ if err != nil {
+ record.State = whatsappFailed
+ record.Answer = "The send failed: " + w.redact(err.Error()) + "."
+ } else {
+ name := w.groupName(ctx, jid.String())
+ if jid.Server != types.GroupServer {
+ name = whatsappContactName(ctx, device, jid, "")
+ }
+
+ record.Answer = "Sent to " + name + " at " + response.Timestamp.In(w.clock().Location()).Format("15:04") + "."
+ }
+
+ err = w.state.PutSend(record)
+ if err != nil {
+ return "", err
+ }
+
+ return record.Answer, nil
+}
+
+// WhatsAppMatch is one contact or group of Find.
+type WhatsAppMatch struct {
+ id string
+ name string
+ kind string
+}
+
// WhatsAppRequest is a pair or unlink command for Run, with the function that
// gives its answers to the client that asked. A pairing has the phone number.
type WhatsAppRequest struct {
}
}
+// whatsappFold returns text in lower case with no accents and no space at its
+// ends, so that names match with no regard to case and accents.
+func whatsappFold(text string) string {
+ folded, _, err := transform.String(transform.Chain(norm.NFD, runes.Remove(runes.In(unicode.Mn)), norm.NFC), text)
+ if err != nil {
+ folded = text
+ }
+
+ return strings.ToLower(strings.TrimSpace(folded))
+}
+
+// whatsappFindAnswer returns the answer of Find for name with matches. Without
+// groups, the answer says that it has no groups.
+func whatsappFindAnswer(name string, matches []WhatsAppMatch, groups bool) string {
+ slices.SortFunc(matches, func(a, b WhatsAppMatch) int {
+ return cmp.Or(strings.Compare(whatsappFold(a.name), whatsappFold(b.name)), strings.Compare(a.id, b.id))
+ })
+
+ var lines []string
+ for _, match := range matches[:min(len(matches), whatsappFindMatches)] {
+ lines = append(lines, match.id+" | "+match.name+" | "+match.kind)
+ }
+
+ if len(matches) == 0 {
+ lines = append(lines, "No contact or group has a name with \""+name+"\".")
+ }
+
+ if len(matches) > whatsappFindMatches {
+ lines = append(lines, fmt.Sprintf("%d more: give a longer part of the name.", len(matches)-whatsappFindMatches))
+ }
+
+ if !groups {
+ lines = append(lines, "The groups are not in this answer, because WhatsApp is disconnected.")
+ }
+
+ return strings.Join(lines, "\n")
+}
+
+// whatsappSendCheck returns the JID of chat, and an error when id, chat, or
+// text cannot go to a send. The chat is a private chat or a group, and not the
+// chat of the user with itself.
+func whatsappSendCheck(id, chat, text string, own []string) (types.JID, error) {
+ jid, err := types.ParseJID(chat)
+ switch {
+ case strings.TrimSpace(id) == "" || len(id) > whatsappSendIDBytes:
+ return types.EmptyJID, fmt.Errorf("the id must have 1 to %d bytes", whatsappSendIDBytes)
+ case strings.TrimSpace(text) == "" || len(text) > whatsappSendBytes:
+ return types.EmptyJID, fmt.Errorf("the text must have 1 to %d bytes", whatsappSendBytes)
+ case err != nil || jid.User == "" || jid != jid.ToNonAD() || jid.String() != chat:
+ return types.EmptyJID, fmt.Errorf("%q is not the ID of a WhatsApp chat: find the ID with whatsapp_find", chat)
+ case jid.Server != types.DefaultUserServer && jid.Server != types.HiddenUserServer && jid.Server != types.GroupServer:
+ return types.EmptyJID, fmt.Errorf("%q is not a private chat or a group", chat)
+ case slices.Contains(own, jid.User):
+ return types.EmptyJID, errors.New("this is the chat of the user with itself: send to another chat")
+ }
+
+ return jid, nil
+}
+
// whatsappOwnIDs returns the own number and the own LID that are not empty.
func whatsappOwnIDs(ids ...string) []string {
var own []string
projects / onechat / blobdiff