import (
"context"
- "crypto/sha256"
- "encoding/hex"
"errors"
"fmt"
"log"
"time"
"go.mau.fi/whatsmeow"
+ "go.mau.fi/whatsmeow/proto/waCompanionReg"
"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"
-
// The session store of the library opens SQLite with this pure Go
// driver.
_ "modernc.org/sqlite"
// 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"
)
// WhatsAppClient is the part of the WhatsApp client that the daemon uses. The
return whatsappFind(ctx, w.link(), w.groups, name)
}
+// Send returns the answer of whatsapp_send for the send id of text to chat, as
+// whatsappSend says.
+func (w *WhatsApp) Send(ctx context.Context, id, chat, text string) (string, error) {
+ return whatsappSend(ctx, w.link(), w.groups, w.state, w.clock, id, chat, text)
+}
+
func (w *WhatsApp) sessionPath() string {
return filepath.Join(w.dir, whatsappSessionFileName)
}
err := client.ConnectContext(ctx)
if err != nil {
- w.logger.Printf("connect: %s", w.redact(err.Error()))
+ w.logger.Printf("WhatsApp messages do not come, because the connection failed, and it is tried again only at a restart of the daemon: %s", w.redact(err.Error()))
}
}
return nil
}
+ w.logger.Print("WhatsApp messages stop, because the phone logged out this device (run /whatsapp pair PHONE to link it again)")
err := w.inbox.deliver(ctx, l, w.link(), true)
if err != nil {
return err
err = w.removeSession()
if err != nil {
- w.logger.Printf("delete the session after the logout: %v", err)
+ w.logger.Printf("the session of the logged out device stays on the disk, because its delete failed: %v", err)
}
err = l.note("WhatsApp was unlinked from the phone.")
if err != nil {
- w.logger.Printf("note the logout: %v", err)
+ w.logger.Printf("the chat has no note of the logout, because its write failed: %v", err)
}
w.broadcast("WhatsApp was unlinked from the phone. Run /whatsapp pair PHONE to link it again.")
return nil
}
+ w.logger.Print("WhatsApp messages stop, because the user unlinked WhatsApp")
err = l.note("WhatsApp is unlinked.")
if err != nil {
- w.logger.Printf("note the unlink: %v", err)
+ w.logger.Printf("the chat has no note of the unlink, because its write failed: %v", err)
}
if client == nil || logoutErr != nil {
w.linked = false
w.own = nil
w.connected = false
+ w.disconnectedAt = time.Time{}
if w.timer != nil {
w.timer.Stop()
}
return
}
+ // The server accepts only a display name of the form "Browser (OS)"
+ // with a common browser and OS, and refuses the pairing otherwise.
code, err := client.PairPhone(ctx, phone, true, whatsmeow.PairClientChrome, "Chrome (Linux)")
if err != nil {
answer("WhatsApp refused the pairing: " + err.Error() + ". Check the phone number and run /whatsapp pair PHONE again.")
case item.Event == whatsmeow.QRChannelSuccess.Event:
linked = true
w.linkedBy(client)
+ w.logger.Print("WhatsApp is linked")
err = l.note("WhatsApp is linked.")
if err != nil {
- w.logger.Printf("note the link: %v", err)
+ w.logger.Printf("the chat has no note of the link, because its write failed: %v", err)
}
answer("WhatsApp is linked to +" + phone + ".")
// the library tries again. After noticeDelay of a disconnection, all clients
// get one notice, and they get one more when the connection comes back. A
// disconnection that the library does not try again gives a notice at once.
+//
+// The log of the daemon gets one line for each change of the connection of the
+// linked device: connected, a failed first connection, a lost connection, and
+// connected again with the length of the outage. The retries of the library
+// between them log nothing.
func (w *WhatsApp) handle(event any) bool {
switch event := event.(type) {
case *events.Message:
w.inbox.startCatchup()
}
- var notice string
+ var notice, line string
w.mutex.Lock()
switch event := event.(type) {
case *events.PairSuccess:
w.own = whatsappOwnIDs(event.ID.User, event.LID.User)
case *events.Connected:
+ switch {
+ case !w.linked || w.connected:
+ case w.disconnectedAt.IsZero():
+ line = "WhatsApp is connected, and new messages come in"
+ default:
+ line = "WhatsApp is connected again, after " + durationText(w.clock().Sub(w.disconnectedAt))
+ }
+
w.connected = true
w.connectedAt = w.clock()
if w.timer != nil {
}
case *events.Disconnected:
if w.linked && (w.connected || w.disconnectedAt.IsZero()) {
+ line = "new WhatsApp messages wait, because the connection is lost (the next try is automatic)"
+ if !w.connected {
+ line = "new WhatsApp messages wait, because the first connection failed (the next try is automatic)"
+ }
+
w.disconnectedAt = w.clock()
w.disconnections++
disconnections := w.disconnections
w.connected = false
w.noticed = true
notice = "WhatsApp is disconnected and does not connect again by itself: " + event.PermanentDisconnectDescription() + ". Restart the daemon to try again."
+ line = "WhatsApp messages do not come, because the connection is lost and it is tried again only at a restart of the daemon: " + whatsappRedact(w.own, event.PermanentDisconnectDescription())
}
}
+
+ if w.closed {
+ line = ""
+ }
+
w.mutex.Unlock()
+ if line != "" {
+ w.logger.Print(line)
+ }
+
if notice != "" {
w.broadcast(notice)
}
return whatsappRedact(w.own, 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.groups.name(ctx, w.link(), 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
-}
-
// WhatsAppLink is a copy of the link of the device at one time, for the parts
// of WhatsApp that do not own it: the groups, the batches, find, and send.
type WhatsAppLink struct {
answer func(text string)
}
+// whatsappSetDeviceProps sets the device properties that the library sends at
+// the pairing. They are global values of the library, so the daemon sets them
+// once before any client exists. The phone shows the linked device with the
+// name OneChat and a desktop icon only when the platform type is known.
+func whatsappSetDeviceProps() {
+ store.SetOSInfo("OneChat", [3]uint32{0, 1, 0})
+ store.DeviceProps.PlatformType = waCompanionReg.DeviceProps_DESKTOP.Enum()
+}
+
// whatsappNewClient returns the client of the library for device, with handle
// as its event handler. The client tries again after a failed first connection,
// acknowledges a message only after handle returns true, and downloads no old
-// history. The phone shows the device with the name OneChat.
+// history.
func whatsappNewClient(device *store.Device, handle func(event any) bool) WhatsAppClient {
- store.SetOSInfo("OneChat", [3]uint32{0, 1, 0})
client := whatsmeow.NewClient(device, waLog.Noop)
client.InitialAutoReconnect = true
client.SynchronousAck = true
}
}
-// 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