// mautrix-whatsapp - A Matrix-WhatsApp puppeting bridge. // Copyright (C) 2024 Tulir Asokan // // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU Affero General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU Affero General Public License for more details. // // You should have received a copy of the GNU Affero General Public License // along with this program. If not, see . package main import ( "context" "crypto/hmac" "crypto/sha256" "encoding/binary" "encoding/json" "errors" "fmt" "math" "math/rand" "net/http" "strconv" "strings" "sync" "time" "github.com/rs/zerolog" "go.mau.fi/util/exzerolog" "go.mau.fi/whatsmeow" "go.mau.fi/whatsmeow/appstate" waProto "go.mau.fi/whatsmeow/binary/proto" "go.mau.fi/whatsmeow/store" "go.mau.fi/whatsmeow/types" "go.mau.fi/whatsmeow/types/events" waLog "go.mau.fi/whatsmeow/util/log" "golang.org/x/sync/semaphore" "maunium.net/go/mautrix" "maunium.net/go/mautrix/appservice" "maunium.net/go/mautrix/bridge" "maunium.net/go/mautrix/bridge/bridgeconfig" "maunium.net/go/mautrix/bridge/status" "maunium.net/go/mautrix/event" "maunium.net/go/mautrix/format" "maunium.net/go/mautrix/id" "maunium.net/go/mautrix/pushrules" "maunium.net/go/mautrix-whatsapp/database" ) type User struct { *database.User Client *whatsmeow.Client Session *store.Device bridge *WABridge zlog zerolog.Logger Admin bool Whitelisted bool RelayWhitelisted bool PermissionLevel bridgeconfig.PermissionLevel mgmtCreateLock sync.Mutex spaceCreateLock sync.Mutex connLock sync.Mutex historySyncs chan *events.HistorySync lastPresence types.Presence mediaRetryLock *semaphore.Weighted historySyncLoopsStarted bool enqueueBackfillsTimer *time.Timer spaceMembershipChecked bool lastPhoneOfflineWarning time.Time groupListCache []*types.GroupInfo groupListCacheLock sync.Mutex groupListCacheTime time.Time BackfillQueue *BackfillQueue BridgeState *bridge.BridgeStateQueue resyncQueue map[types.JID]resyncQueueItem resyncQueueLock sync.Mutex nextResync time.Time createKeyDedup string skipGroupCreateDelay types.JID groupJoinLock sync.Mutex } type resyncQueueItem struct { portal *Portal puppet *Puppet } func (br *WABridge) getUserByMXID(userID id.UserID, onlyIfExists bool) *User { _, isPuppet := br.ParsePuppetMXID(userID) if isPuppet || userID == br.Bot.UserID { return nil } br.usersLock.Lock() defer br.usersLock.Unlock() user, ok := br.usersByMXID[userID] if !ok { userIDPtr := &userID if onlyIfExists { userIDPtr = nil } ctx := context.TODO() dbUser, err := br.DB.User.GetByMXID(ctx, userID) if err != nil { br.ZLog.Err(err).Stringer("mxid", userID).Msg("Failed to get user by MXID from database") return nil } return br.loadDBUser(ctx, dbUser, userIDPtr) } return user } func (br *WABridge) GetUserByMXID(userID id.UserID) *User { return br.getUserByMXID(userID, false) } func (br *WABridge) GetIUser(userID id.UserID, create bool) bridge.User { u := br.getUserByMXID(userID, !create) if u == nil { return nil } return u } func (user *User) GetPermissionLevel() bridgeconfig.PermissionLevel { return user.PermissionLevel } func (user *User) GetManagementRoomID() id.RoomID { return user.ManagementRoom } func (user *User) GetMXID() id.UserID { return user.MXID } func (user *User) GetCommandState() map[string]interface{} { return nil } func (br *WABridge) GetUserByMXIDIfExists(userID id.UserID) *User { return br.getUserByMXID(userID, true) } func (br *WABridge) GetUserByJID(jid types.JID) *User { br.usersLock.Lock() defer br.usersLock.Unlock() user, ok := br.usersByUsername[jid.User] if !ok { ctx := context.TODO() dbUser, err := br.DB.User.GetByUsername(ctx, jid.User) if err != nil { br.ZLog.Err(err).Stringer("jid", jid).Msg("Failed to get user by JID from database") return nil } return br.loadDBUser(ctx, dbUser, nil) } return user } func (user *User) addToJIDMap() { user.bridge.usersLock.Lock() user.bridge.usersByUsername[user.JID.User] = user user.bridge.usersLock.Unlock() } func (user *User) removeFromJIDMap(state status.BridgeState) { user.bridge.usersLock.Lock() jidUser, ok := user.bridge.usersByUsername[user.JID.User] if ok && user == jidUser { delete(user.bridge.usersByUsername, user.JID.User) } user.bridge.usersLock.Unlock() user.bridge.Metrics.TrackLoginState(user.JID, false) user.BridgeState.Send(state) } func (br *WABridge) GetAllUsers() []*User { br.usersLock.Lock() defer br.usersLock.Unlock() ctx := context.TODO() dbUsers, err := br.DB.User.GetAll(ctx) if err != nil { br.ZLog.Error().Err(err).Msg("Failed to get all users from database") return nil } output := make([]*User, len(dbUsers)) for index, dbUser := range dbUsers { user, ok := br.usersByMXID[dbUser.MXID] if !ok { user = br.loadDBUser(ctx, dbUser, nil) } output[index] = user } return output } func (br *WABridge) loadDBUser(ctx context.Context, dbUser *database.User, mxid *id.UserID) *User { if dbUser == nil { if mxid == nil { return nil } dbUser = br.DB.User.New() dbUser.MXID = *mxid err := dbUser.Insert(ctx) if err != nil { br.ZLog.Error().Err(err).Msg("Failed to insert new user into database") return nil } } user := br.NewUser(dbUser) br.usersByMXID[user.MXID] = user if !user.JID.IsEmpty() { var err error user.Session, err = br.WAContainer.GetDevice(user.JID) if err != nil { user.zlog.Err(err).Msg("Failed to load user's whatsapp session") } else if user.Session == nil { user.zlog.Warn().Stringer("jid", user.JID).Msg("Didn't find session data for user's JID, treating user as logged out") user.JID = types.EmptyJID err = user.Update(ctx) if err != nil { user.zlog.Err(err).Msg("Failed to save user after clearing JID") } } else { user.Session.Log = waLog.Zerolog(user.zlog.With().Str("component", "whatsmeow").Str("db_section", "whatsmeow").Logger()) br.usersByUsername[user.JID.User] = user } } if len(user.ManagementRoom) > 0 { br.managementRooms[user.ManagementRoom] = user } return user } func (br *WABridge) NewUser(dbUser *database.User) *User { user := &User{ User: dbUser, bridge: br, zlog: br.ZLog.With().Str("user_id", dbUser.MXID.String()).Logger(), historySyncs: make(chan *events.HistorySync, 32), lastPresence: types.PresenceUnavailable, resyncQueue: make(map[types.JID]resyncQueueItem), mediaRetryLock: semaphore.NewWeighted(br.Config.Bridge.HistorySync.MediaRequests.MaxAsyncHandle), } user.PermissionLevel = user.bridge.Config.Bridge.Permissions.Get(user.MXID) user.RelayWhitelisted = user.PermissionLevel >= bridgeconfig.PermissionLevelRelay user.Whitelisted = user.PermissionLevel >= bridgeconfig.PermissionLevelUser user.Admin = user.PermissionLevel >= bridgeconfig.PermissionLevelAdmin user.BridgeState = br.NewBridgeStateQueue(user) user.enqueueBackfillsTimer = time.NewTimer(5 * time.Second) user.enqueueBackfillsTimer.Stop() go user.puppetResyncLoop() return user } const resyncMinInterval = 7 * 24 * time.Hour const resyncLoopInterval = 4 * time.Hour func (user *User) puppetResyncLoop() { user.nextResync = time.Now().Add(resyncLoopInterval).Add(-time.Duration(rand.Intn(3600)) * time.Second) for { time.Sleep(user.nextResync.Sub(time.Now())) user.nextResync = time.Now().Add(resyncLoopInterval) user.doPuppetResync() } } func (user *User) EnqueuePuppetResync(puppet *Puppet) { if puppet.LastSync.Add(resyncMinInterval).After(time.Now()) { return } user.resyncQueueLock.Lock() if _, exists := user.resyncQueue[puppet.JID]; !exists { user.resyncQueue[puppet.JID] = resyncQueueItem{puppet: puppet} user.zlog.Debug(). Stringer("jid", puppet.JID). Str("next_resync", time.Until(user.nextResync).String()). Msg("Enqueued resync for puppet") } user.resyncQueueLock.Unlock() } func (user *User) EnqueuePortalResync(portal *Portal) { if !portal.IsGroupChat() || portal.LastSync.Add(resyncMinInterval).After(time.Now()) { return } user.resyncQueueLock.Lock() if _, exists := user.resyncQueue[portal.Key.JID]; !exists { user.resyncQueue[portal.Key.JID] = resyncQueueItem{portal: portal} user.zlog.Debug(). Stringer("jid", portal.Key.JID). Str("next_resync", time.Until(user.nextResync).String()). Msg("Enqueued resync for portal") } user.resyncQueueLock.Unlock() } func (user *User) doPuppetResync() { if !user.IsLoggedIn() { return } user.resyncQueueLock.Lock() if len(user.resyncQueue) == 0 { user.resyncQueueLock.Unlock() return } log := user.zlog.With().Str("action", "puppet resync").Logger() ctx := log.WithContext(context.TODO()) queue := user.resyncQueue user.resyncQueue = make(map[types.JID]resyncQueueItem) user.resyncQueueLock.Unlock() var puppetJIDs []types.JID var puppets []*Puppet var portals []*Portal for jid, item := range queue { var lastSync time.Time if item.puppet != nil { lastSync = item.puppet.LastSync } else if item.portal != nil { lastSync = item.portal.LastSync } if lastSync.Add(resyncMinInterval).After(time.Now()) { log.Debug(). Stringer("jid", jid). Str("last_sync", time.Since(lastSync).String()). Msg("Not resyncing, last sync was too recent") continue } if item.puppet != nil { puppets = append(puppets, item.puppet) puppetJIDs = append(puppetJIDs, jid) } else if item.portal != nil { portals = append(portals, item.portal) } } for _, portal := range portals { groupInfo, err := user.Client.GetGroupInfo(portal.Key.JID) if err != nil { log.Warn().Err(err).Stringer("jid", portal.Key.JID).Msg("Failed to get group info for background sync") } else { log.Debug().Stringer("jid", portal.Key.JID).Msg("Doing background sync for group") portal.UpdateMatrixRoom(ctx, user, groupInfo, nil) } } if len(puppetJIDs) == 0 { return } log.Debug().Array("jids", exzerolog.ArrayOfStringers(puppetJIDs)).Msg("Doing background sync for users") infos, err := user.Client.GetUserInfo(puppetJIDs) if err != nil { log.Err(err).Msg("Failed to get user info for background sync") return } for _, puppet := range puppets { info, ok := infos[puppet.JID] if !ok { log.Warn().Stringer("jid", puppet.JID).Msg("Didn't get info for puppet in background sync") continue } var contactPtr *types.ContactInfo contact, err := user.Session.Contacts.GetContact(puppet.JID) if err != nil { log.Err(err).Stringer("jid", puppet.JID).Msg("Failed to get contact info for puppet in background sync") } else if contact.Found { contactPtr = &contact } puppet.Sync(ctx, user, contactPtr, info.PictureID != "" && info.PictureID != puppet.Avatar, true) } } func (user *User) ensureInvited(ctx context.Context, intent *appservice.IntentAPI, roomID id.RoomID, isDirect bool) (ok bool) { extraContent := make(map[string]interface{}) if isDirect { extraContent["is_direct"] = true } customPuppet := user.bridge.GetPuppetByCustomMXID(user.MXID) if customPuppet != nil && customPuppet.CustomIntent() != nil { extraContent["fi.mau.will_auto_accept"] = true } _, err := intent.InviteUser(ctx, roomID, &mautrix.ReqInviteUser{UserID: user.MXID}, extraContent) var httpErr mautrix.HTTPError if err != nil && errors.As(err, &httpErr) && httpErr.RespError != nil && strings.Contains(httpErr.RespError.Err, "is already in the room") { err = user.bridge.StateStore.SetMembership(ctx, roomID, user.MXID, event.MembershipJoin) if err != nil { user.zlog.Err(err).Stringer("room_id", roomID).Msg("Failed to update membership to join in state store after invite failed") } ok = true return } else if err != nil { user.zlog.Err(err).Stringer("room_id", roomID).Msg("Failed to invite user to room") } else { ok = true } if customPuppet != nil && customPuppet.CustomIntent() != nil { err = customPuppet.CustomIntent().EnsureJoined(ctx, roomID, appservice.EnsureJoinedParams{IgnoreCache: true}) if err != nil { user.zlog.Err(err).Stringer("room_id", roomID).Msg("Failed to auto-join room") ok = false } else { ok = true } } return } func (user *User) GetSpaceRoom(ctx context.Context) id.RoomID { if !user.bridge.Config.Bridge.PersonalFilteringSpaces { return "" } if len(user.SpaceRoom) == 0 { user.spaceCreateLock.Lock() defer user.spaceCreateLock.Unlock() if len(user.SpaceRoom) > 0 { return user.SpaceRoom } resp, err := user.bridge.Bot.CreateRoom(ctx, &mautrix.ReqCreateRoom{ Visibility: "private", Name: "WhatsApp", Topic: "Your WhatsApp bridged chats", InitialState: []*event.Event{{ Type: event.StateRoomAvatar, Content: event.Content{ Parsed: &event.RoomAvatarEventContent{ URL: user.bridge.Config.AppService.Bot.ParsedAvatar, }, }, }}, CreationContent: map[string]interface{}{ "type": event.RoomTypeSpace, }, PowerLevelOverride: &event.PowerLevelsEventContent{ Users: map[id.UserID]int{ user.bridge.Bot.UserID: 9001, user.MXID: 50, }, }, }) if err != nil { user.zlog.Err(err).Msg("Failed to auto-create space room") } else { user.SpaceRoom = resp.RoomID err = user.Update(ctx) if err != nil { user.zlog.Err(err).Msg("Failed to save user after creating space room") } user.ensureInvited(ctx, user.bridge.Bot, user.SpaceRoom, false) } } else if !user.spaceMembershipChecked && !user.bridge.StateStore.IsInRoom(ctx, user.SpaceRoom, user.MXID) { user.ensureInvited(ctx, user.bridge.Bot, user.SpaceRoom, false) } user.spaceMembershipChecked = true return user.SpaceRoom } func (user *User) GetManagementRoom(ctx context.Context) id.RoomID { if len(user.ManagementRoom) == 0 { user.mgmtCreateLock.Lock() defer user.mgmtCreateLock.Unlock() if len(user.ManagementRoom) > 0 { return user.ManagementRoom } creationContent := make(map[string]interface{}) if !user.bridge.Config.Bridge.FederateRooms { creationContent["m.federate"] = false } resp, err := user.bridge.Bot.CreateRoom(ctx, &mautrix.ReqCreateRoom{ Topic: "WhatsApp bridge notices", IsDirect: true, CreationContent: creationContent, }) if err != nil { user.zlog.Err(err).Msg("Failed to auto-create management room") } else { user.SetManagementRoom(resp.RoomID) } } return user.ManagementRoom } func (user *User) SetManagementRoom(roomID id.RoomID) { ctx := context.TODO() existingUser, ok := user.bridge.managementRooms[roomID] if ok { existingUser.ManagementRoom = "" err := existingUser.Update(ctx) if err != nil { user.zlog.Err(err). Stringer("other_user_mxid", existingUser.MXID). Msg("Failed to save previous user after removing from old management room") } } user.ManagementRoom = roomID user.bridge.managementRooms[user.ManagementRoom] = user err := user.Update(ctx) if err != nil { user.zlog.Err(err).Msg("Failed to save user after setting management room") } } var ErrAlreadyLoggedIn = errors.New("already logged in") func (user *User) obfuscateJID(jid types.JID) string { // Turn the first 4 bytes of HMAC-SHA256(hs_token, phone) into a number and replace the middle of the actual phone with that deterministic random number. randomNumber := binary.BigEndian.Uint32(hmac.New(sha256.New, []byte(user.bridge.Config.AppService.HSToken)).Sum([]byte(jid.User))[:4]) return fmt.Sprintf("+%s-%d-%s:%d", jid.User[:1], randomNumber, jid.User[len(jid.User)-2:], jid.Device) } func (user *User) createClient(sess *store.Device) { user.Client = whatsmeow.NewClient(sess, waLog.Zerolog(user.zlog.With().Str("component", "whatsmeow").Logger())) user.Client.AddEventHandler(user.HandleEvent) user.Client.SetForceActiveDeliveryReceipts(user.bridge.Config.Bridge.ForceActiveDeliveryReceipts) user.Client.AutomaticMessageRerequestFromPhone = true user.Client.GetMessageForRetry = func(requester, to types.JID, id types.MessageID) *waProto.Message { Analytics.Track(user.MXID, "WhatsApp incoming retry (message not found)", map[string]interface{}{ "requester": user.obfuscateJID(requester), "messageID": id, }) user.bridge.Metrics.TrackRetryReceipt(0, false) return nil } user.Client.PreRetryCallback = func(receipt *events.Receipt, messageID types.MessageID, retryCount int, msg *waProto.Message) bool { Analytics.Track(user.MXID, "WhatsApp incoming retry (accepted)", map[string]interface{}{ "requester": user.obfuscateJID(receipt.Sender), "messageID": messageID, "retryCount": retryCount, }) user.bridge.Metrics.TrackRetryReceipt(retryCount, true) return true } } func (user *User) Login(ctx context.Context) (<-chan whatsmeow.QRChannelItem, error) { user.connLock.Lock() defer user.connLock.Unlock() if user.Session != nil { return nil, ErrAlreadyLoggedIn } else if user.Client != nil { user.unlockedDeleteConnection() } newSession := user.bridge.WAContainer.NewDevice() newSession.Log = waLog.Zerolog(user.zlog.With().Str("component", "whatsmeow session").Logger()) user.createClient(newSession) qrChan, err := user.Client.GetQRChannel(ctx) if err != nil { return nil, fmt.Errorf("failed to get QR channel: %w", err) } err = user.Client.Connect() if err != nil { return nil, fmt.Errorf("failed to connect to WhatsApp: %w", err) } return qrChan, nil } func (user *User) Connect() bool { user.connLock.Lock() defer user.connLock.Unlock() if user.Client != nil { return user.Client.IsConnected() } else if user.Session == nil { return false } user.zlog.Debug().Msg("Connecting to WhatsApp") user.BridgeState.Send(status.BridgeState{StateEvent: status.StateConnecting, Error: WAConnecting}) user.createClient(user.Session) err := user.Client.Connect() if err != nil { user.zlog.Err(err).Msg("Error connecting to WhatsApp") user.BridgeState.Send(status.BridgeState{ StateEvent: status.StateUnknownError, Error: WAConnectionFailed, Info: map[string]interface{}{ "go_error": err.Error(), }, }) return false } return true } func (user *User) unlockedDeleteConnection() { if user.Client == nil { return } user.Client.Disconnect() user.Client.RemoveEventHandlers() user.Client = nil user.bridge.Metrics.TrackConnectionState(user.JID, false) } func (user *User) DeleteConnection() { user.connLock.Lock() defer user.connLock.Unlock() user.unlockedDeleteConnection() } func (user *User) HasSession() bool { return user.Session != nil } func (user *User) DeleteSession(ctx context.Context) { log := zerolog.Ctx(ctx) if user.Session != nil { err := user.Session.Delete() if err != nil { log.Err(err).Msg("Failed to delete session") } user.Session = nil } if !user.JID.IsEmpty() { user.JID = types.EmptyJID err := user.Update(ctx) if err != nil { log.Err(err).Msg("Failed to save user after clearing JID") } } // Delete all of the backfill and history sync data. err := user.bridge.DB.BackfillQueue.DeleteAll(ctx, user.MXID) if err != nil { log.Err(err).Msg("Failed to delete backfill queue data") } err = user.bridge.DB.HistorySync.DeleteAllConversations(ctx, user.MXID) if err != nil { log.Err(err).Msg("Failed to delete historical conversation list") } err = user.bridge.DB.HistorySync.DeleteAllMessages(ctx, user.MXID) if err != nil { log.Err(err).Msg("Failed to delete historical messages") } err = user.bridge.DB.MediaBackfillRequest.DeleteAllMediaBackfillRequests(ctx, user.MXID) if err != nil { log.Err(err).Msg("Failed to delete media backfill requests") } } func (user *User) IsConnected() bool { return user.Client != nil && user.Client.IsConnected() } func (user *User) IsLoggedIn() bool { return user.IsConnected() && user.Client.IsLoggedIn() } func (user *User) sendMarkdownBridgeAlert(ctx context.Context, formatString string, args ...interface{}) { if user.bridge.Config.Bridge.DisableBridgeAlerts { return } notice := fmt.Sprintf(formatString, args...) content := format.RenderMarkdown(notice, true, false) _, err := user.bridge.Bot.SendMessageEvent(ctx, user.GetManagementRoom(ctx), event.EventMessage, content) if err != nil { user.zlog.Warn().Err(err).Str("notice", notice).Msg("Failed to send bridge alert") } } const callEventMaxAge = 15 * time.Minute func (user *User) handleCallStart(sender types.JID, id, callType string, ts time.Time) { if !user.bridge.Config.Bridge.CallStartNotices || ts.Add(callEventMaxAge).Before(time.Now()) { return } portal := user.GetPortalByJID(sender) text := "Incoming call. Use the WhatsApp app to answer." if callType != "" { text = fmt.Sprintf("Incoming %s call. Use the WhatsApp app to answer.", callType) } portal.events <- &PortalEvent{ Message: &PortalMessage{ fake: &fakeMessage{ Sender: sender, Text: text, ID: id, Time: ts, Important: true, }, source: user, }, } } const PhoneDisconnectWarningTime = 12 * 24 * time.Hour // 12 days const PhoneDisconnectPingTime = 10 * 24 * time.Hour const PhoneMinPingInterval = 24 * time.Hour func (user *User) sendHackyPhonePing(ctx context.Context) { user.PhoneLastPinged = time.Now() msgID := user.Client.GenerateMessageID() keyIDs := make([]*waProto.AppStateSyncKeyId, 0, 1) lastKeyID, err := user.GetLastAppStateKeyID(ctx) if lastKeyID != nil { keyIDs = append(keyIDs, &waProto.AppStateSyncKeyId{ KeyId: lastKeyID, }) } else { user.zlog.Warn().Err(err).Msg("Failed to get last app state key ID to send hacky phone ping - sending empty request") } resp, err := user.Client.SendMessage(ctx, user.JID.ToNonAD(), &waProto.Message{ ProtocolMessage: &waProto.ProtocolMessage{ Type: waProto.ProtocolMessage_APP_STATE_SYNC_KEY_REQUEST.Enum(), AppStateSyncKeyRequest: &waProto.AppStateSyncKeyRequest{ KeyIds: keyIDs, }, }, }, whatsmeow.SendRequestExtra{Peer: true, ID: msgID}) if err != nil { user.zlog.Err(err).Msg("Failed to send hacky phone ping") } else { user.zlog.Debug(). Str("message_id", msgID). Int64("message_ts", resp.Timestamp.Unix()). Msg("Sent hacky phone ping because phone has been offline for >10 days") user.PhoneLastPinged = resp.Timestamp err = user.Update(ctx) if err != nil { user.zlog.Err(err).Msg("Failed to save user after sending hacky phone ping") } } } func (user *User) PhoneRecentlySeen(doPing bool) bool { if doPing && !user.PhoneLastSeen.IsZero() && user.PhoneLastSeen.Add(PhoneDisconnectPingTime).Before(time.Now()) && user.PhoneLastPinged.Add(PhoneMinPingInterval).Before(time.Now()) { // Over 10 days since the phone was seen and over a day since the last somewhat hacky ping, send a new ping. go user.sendHackyPhonePing(context.TODO()) } return user.PhoneLastSeen.IsZero() || user.PhoneLastSeen.Add(PhoneDisconnectWarningTime).After(time.Now()) } // phoneSeen records a timestamp when the user's main device was seen online. // The stored timestamp can later be used to warn the user if the main device is offline for too long. func (user *User) phoneSeen(ts time.Time) { if user.PhoneLastSeen.Add(1 * time.Hour).After(ts) { // The last seen timestamp isn't going to be perfectly accurate in any case, // so don't spam the database with an update every time there's an event. return } else if !user.PhoneRecentlySeen(false) { if user.BridgeState.GetPrev().Error == WAPhoneOffline && user.IsConnected() { user.zlog.Debug().Msg("Saw phone after current bridge state said it has been offline, switching state back to connected") user.BridgeState.Send(status.BridgeState{StateEvent: status.StateConnected}) } else { user.zlog.Debug(). Bool("is_connected", user.IsConnected()). Str("prev_error", string(user.BridgeState.GetPrev().Error)). Msg("Saw phone after current bridge state said it has been offline, not sending new bridge state") } } user.PhoneLastSeen = ts go func() { err := user.Update(context.TODO()) if err != nil { user.zlog.Err(err).Msg("Failed to save user after updating phone last seen") } }() } func formatDisconnectTime(dur time.Duration) string { days := int(math.Floor(dur.Hours() / 24)) hours := int(dur.Hours()) % 24 if hours == 0 { return fmt.Sprintf("%d days", days) } else if hours == 1 { return fmt.Sprintf("%d days and 1 hour", days) } else { return fmt.Sprintf("%d days and %d hours", days, hours) } } func (user *User) sendPhoneOfflineWarning(ctx context.Context) { if user.lastPhoneOfflineWarning.Add(12 * time.Hour).After(time.Now()) { // Don't spam the warning too much return } user.lastPhoneOfflineWarning = time.Now() timeSinceSeen := time.Now().Sub(user.PhoneLastSeen) user.sendMarkdownBridgeAlert(ctx, "Your phone hasn't been seen in %s. The server will force the bridge to log out if the phone is not active at least every 2 weeks.", formatDisconnectTime(timeSinceSeen)) } func (user *User) HandleEvent(event interface{}) { ctx := user.zlog.With(). Str("action", "handle whatsapp event"). Type("wa_event_type", event). Logger(). WithContext(context.TODO()) switch v := event.(type) { case *events.LoggedOut: go user.handleLoggedOut(ctx, v.OnConnect, v.Reason) case *events.Connected: user.bridge.Metrics.TrackConnectionState(user.JID, true) user.bridge.Metrics.TrackLoginState(user.JID, true) if len(user.Client.Store.PushName) > 0 { go func() { err := user.Client.SendPresence(user.lastPresence) if err != nil { user.zlog.Warn().Err(err).Msg("Failed to send initial presence after connecting") } }() } go user.tryAutomaticDoublePuppeting() if user.bridge.Config.Bridge.HistorySync.Backfill && !user.historySyncLoopsStarted { go user.handleHistorySyncsLoop() user.historySyncLoopsStarted = true } case *events.OfflineSyncPreview: user.zlog.Info(). Int("message_count", v.Messages). Int("receipt_count", v.Receipts). Int("notification_count", v.Notifications). Int("app_data_change_count", v.AppDataChanges). Msg("Server sent number of events that were missed during downtime") user.BridgeState.Send(status.BridgeState{ StateEvent: status.StateBackfilling, Message: fmt.Sprintf("backfilling %d messages and %d receipts", v.Messages, v.Receipts), }) case *events.OfflineSyncCompleted: if !user.PhoneRecentlySeen(true) { user.zlog.Info(). Time("phone_last_seen", user.PhoneLastSeen). Msg("Offline sync completed, but phone last seen date is still old - sending phone offline bridge status") user.BridgeState.Send(status.BridgeState{StateEvent: status.StateTransientDisconnect, Error: WAPhoneOffline}) } else { if user.BridgeState.GetPrev().StateEvent == status.StateBackfilling { user.zlog.Info().Msg("Offline sync completed") } user.BridgeState.Send(status.BridgeState{StateEvent: status.StateConnected}) } case *events.AppStateSyncComplete: if len(user.Client.Store.PushName) > 0 && v.Name == appstate.WAPatchCriticalBlock { err := user.Client.SendPresence(user.lastPresence) if err != nil { user.zlog.Warn().Err(err).Msg("Failed to send presence after app state sync") } } else if v.Name == appstate.WAPatchCriticalUnblockLow { go func() { err := user.ResyncContacts(false) if err != nil { user.zlog.Err(err).Msg("Failed to resync contacts after app state sync") } }() } case *events.PushNameSetting: // Send presence available when connecting and when the pushname is changed. // This makes sure that outgoing messages always have the right pushname. err := user.Client.SendPresence(user.lastPresence) if err != nil { user.zlog.Warn().Err(err).Msg("Failed to send presence after push name update") } _, _, err = user.Client.Store.Contacts.PutPushName(user.JID.ToNonAD(), v.Action.GetName()) if err != nil { user.zlog.Err(err).Msg("Failed to update push name in store") } go user.syncPuppet(user.JID.ToNonAD(), "push name setting") case *events.PairSuccess: user.PhoneLastSeen = time.Now() user.Session = user.Client.Store user.JID = v.ID user.addToJIDMap() err := user.Update(ctx) if err != nil { user.zlog.Err(err).Msg("Failed to save user after pair success") } case *events.StreamError: var message string if v.Code != "" { message = fmt.Sprintf("Unknown stream error with code %s", v.Code) } else if children := v.Raw.GetChildren(); len(children) > 0 { message = fmt.Sprintf("Unknown stream error (contains %s node)", children[0].Tag) } else { message = "Unknown stream error" } user.BridgeState.Send(status.BridgeState{StateEvent: status.StateUnknownError, Message: message}) user.bridge.Metrics.TrackConnectionState(user.JID, false) case *events.StreamReplaced: if user.bridge.Config.Bridge.CrashOnStreamReplaced { user.zlog.Info().Msg("Stopping bridge due to StreamReplaced event") user.bridge.ManualStop(60) } else { user.BridgeState.Send(status.BridgeState{StateEvent: status.StateUnknownError, Message: "Stream replaced"}) user.bridge.Metrics.TrackConnectionState(user.JID, false) user.sendMarkdownBridgeAlert(ctx, "The bridge was started in another location. Use `reconnect` to reconnect this one.") } case *events.ConnectFailure: user.BridgeState.Send(status.BridgeState{StateEvent: status.StateUnknownError, Message: fmt.Sprintf("Unknown connection failure: %s (%s)", v.Reason, v.Message)}) user.bridge.Metrics.TrackConnectionState(user.JID, false) user.bridge.Metrics.TrackConnectionFailure(fmt.Sprintf("status-%d", v.Reason)) case *events.ClientOutdated: user.zlog.Error().Msg("Got a client outdated connect failure. The bridge is likely out of date, please update immediately.") user.BridgeState.Send(status.BridgeState{StateEvent: status.StateUnknownError, Message: "Connect failure: 405 client outdated"}) user.bridge.Metrics.TrackConnectionState(user.JID, false) user.bridge.Metrics.TrackConnectionFailure("client-outdated") case *events.TemporaryBan: user.BridgeState.Send(status.BridgeState{StateEvent: status.StateBadCredentials, Message: v.String()}) user.bridge.Metrics.TrackConnectionState(user.JID, false) user.bridge.Metrics.TrackConnectionFailure("temporary-ban") case *events.Disconnected: // Don't send the normal transient disconnect state if we're already in a different transient disconnect state. // TODO remove this if/when the phone offline state is moved to a sub-state of CONNECTED if user.BridgeState.GetPrev().Error != WAPhoneOffline && user.PhoneRecentlySeen(false) { user.BridgeState.Send(status.BridgeState{StateEvent: status.StateTransientDisconnect, Error: WADisconnected}) } user.bridge.Metrics.TrackConnectionState(user.JID, false) case *events.Contact: go user.syncPuppet(v.JID, "contact event") case *events.PushName: go user.syncPuppet(v.JID, "push name event") case *events.BusinessName: go user.syncPuppet(v.JID, "business name event") case *events.GroupInfo: user.groupListCache = nil go user.handleGroupUpdate(v) case *events.JoinedGroup: user.groupListCache = nil go user.handleGroupCreate(v) case *events.NewsletterJoin: go user.handleNewsletterJoin(v) case *events.NewsletterLeave: go user.handleNewsletterLeave(v) case *events.Picture: go user.handlePictureUpdate(ctx, v) case *events.Receipt: if v.IsFromMe && v.Sender.Device == 0 { user.phoneSeen(v.Timestamp) } go user.handleReceipt(v) case *events.ChatPresence: go user.handleChatPresence(ctx, v) case *events.Message: portal := user.GetPortalByMessageSource(v.Info.MessageSource) portal.events <- &PortalEvent{ Message: &PortalMessage{evt: v, source: user}, } case *events.MediaRetry: user.phoneSeen(v.Timestamp) portal := user.GetPortalByJID(v.ChatID) go portal.handleMediaRetry(v, user) case *events.CallOffer: user.handleCallStart(v.CallCreator, v.CallID, "", v.Timestamp) case *events.CallOfferNotice: user.handleCallStart(v.CallCreator, v.CallID, v.Type, v.Timestamp) case *events.IdentityChange: puppet := user.bridge.GetPuppetByJID(v.JID) if puppet == nil { return } portal := user.GetPortalByJID(v.JID) if len(portal.MXID) > 0 && user.bridge.Config.Bridge.IdentityChangeNotices { text := fmt.Sprintf("Your security code with %s changed.", puppet.Displayname) if v.Implicit { text = fmt.Sprintf("Your security code with %s (device #%d) changed.", puppet.Displayname, v.JID.Device) } portal.events <- &PortalEvent{ Message: &PortalMessage{ fake: &fakeMessage{ Sender: v.JID, Text: text, ID: strconv.FormatInt(v.Timestamp.Unix(), 10), Time: v.Timestamp, Important: false, }, source: user, }, } } case *events.CallTerminate, *events.CallRelayLatency, *events.CallAccept, *events.UnknownCallEvent: // ignore case *events.UndecryptableMessage: portal := user.GetPortalByMessageSource(v.Info.MessageSource) portal.events <- &PortalEvent{ Message: &PortalMessage{undecryptable: v, source: user}, } case *events.HistorySync: if user.bridge.Config.Bridge.HistorySync.Backfill { user.historySyncs <- v } case *events.Mute: portal := user.GetPortalByJID(v.JID) if portal != nil { var mutedUntil time.Time if v.Action.GetMuted() { mutedUntil = time.Unix(v.Action.GetMuteEndTimestamp(), 0) } go user.updateChatMute(ctx, nil, portal, mutedUntil) } case *events.Archive: portal := user.GetPortalByJID(v.JID) if portal != nil { go user.updateChatTag(ctx, nil, portal, user.bridge.Config.Bridge.ArchiveTag, v.Action.GetArchived()) } case *events.Pin: portal := user.GetPortalByJID(v.JID) if portal != nil { go user.updateChatTag(ctx, nil, portal, user.bridge.Config.Bridge.PinnedTag, v.Action.GetPinned()) } case *events.AppState: // Ignore case *events.KeepAliveTimeout: user.BridgeState.Send(status.BridgeState{StateEvent: status.StateTransientDisconnect, Error: WAKeepaliveTimeout}) case *events.KeepAliveRestored: user.zlog.Info().Msg("Keepalive restored after timeouts, sending connected event") user.BridgeState.Send(status.BridgeState{StateEvent: status.StateConnected}) case *events.MarkChatAsRead: if user.bridge.Config.Bridge.SyncManualMarkedUnread { user.markUnread(ctx, user.GetPortalByJID(v.JID), !v.Action.GetRead()) } case *events.DeleteForMe: portal := user.GetPortalByJID(v.ChatJID) if portal != nil { portal.deleteForMe(ctx, user, v) } case *events.DeleteChat: portal := user.GetPortalByJID(v.JID) if portal != nil { portal.HandleWhatsAppDeleteChat(ctx, user) } default: user.zlog.Debug().Type("event_type", v).Msg("Unknown type of event in HandleEvent") } } func (user *User) updateChatMute(ctx context.Context, intent *appservice.IntentAPI, portal *Portal, mutedUntil time.Time) { if len(portal.MXID) == 0 || !user.bridge.Config.Bridge.MuteBridging { return } else if intent == nil { doublePuppet := user.bridge.GetPuppetByCustomMXID(user.MXID) if doublePuppet == nil || doublePuppet.CustomIntent() == nil { return } intent = doublePuppet.CustomIntent() } var err error if mutedUntil.IsZero() && mutedUntil.Before(time.Now()) { user.zlog.Debug(). Stringer("portal_mxid", portal.MXID). Time("muted_until", mutedUntil). Msg("Portal muted until time is in the past, unmuting") err = intent.DeletePushRule(ctx, "global", pushrules.RoomRule, string(portal.MXID)) } else { user.zlog.Debug(). Stringer("portal_mxid", portal.MXID). Time("muted_until", mutedUntil). Msg("Portal muted until time is in the future, muting") err = intent.PutPushRule(ctx, "global", pushrules.RoomRule, string(portal.MXID), &mautrix.ReqPutPushRule{ Actions: []pushrules.PushActionType{pushrules.ActionDontNotify}, }) } if err != nil && !errors.Is(err, mautrix.MNotFound) { user.zlog.Err(err).Stringer("portal_mxid", portal.MXID).Msg("Failed to update push rule through double puppet") } } type CustomTagData struct { Order json.Number `json:"order"` DoublePuppet string `json:"fi.mau.double_puppet_source"` } type CustomTagEventContent struct { Tags map[string]CustomTagData `json:"tags"` } func (user *User) updateChatTag(ctx context.Context, intent *appservice.IntentAPI, portal *Portal, tag string, active bool) { if len(portal.MXID) == 0 || len(tag) == 0 { return } else if intent == nil { doublePuppet := user.bridge.GetPuppetByCustomMXID(user.MXID) if doublePuppet == nil || doublePuppet.CustomIntent() == nil { return } intent = doublePuppet.CustomIntent() } var existingTags CustomTagEventContent err := intent.GetTagsWithCustomData(ctx, portal.MXID, &existingTags) if err != nil && !errors.Is(err, mautrix.MNotFound) { user.zlog.Err(err).Stringer("portal_mxid", portal.MXID).Msg("Failed to get tags through double puppet") } currentTag, ok := existingTags.Tags[tag] if active && !ok { user.zlog.Debug().Stringer("portal_mxid", portal.MXID).Str("tag", tag).Msg("Adding tag to portal") data := CustomTagData{Order: "0.5", DoublePuppet: user.bridge.Name} err = intent.AddTagWithCustomData(ctx, portal.MXID, tag, &data) } else if !active && ok && currentTag.DoublePuppet == user.bridge.Name { user.zlog.Debug().Stringer("portal_mxid", portal.MXID).Str("tag", tag).Msg("Removing tag from portal") err = intent.RemoveTag(ctx, portal.MXID, tag) } else { err = nil } if err != nil { user.zlog.Err(err).Stringer("portal_mxid", portal.MXID).Str("tag", tag).Msg("Failed to update tag through double puppet") } } type CustomReadReceipt struct { Timestamp int64 `json:"ts,omitempty"` DoublePuppetSource string `json:"fi.mau.double_puppet_source,omitempty"` } type CustomReadMarkers struct { mautrix.ReqSetReadMarkers ReadExtra CustomReadReceipt `json:"com.beeper.read.extra"` FullyReadExtra CustomReadReceipt `json:"com.beeper.fully_read.extra"` } func (user *User) syncChatDoublePuppetDetails(ctx context.Context, portal *Portal, justCreated bool) { doublePuppet := portal.bridge.GetPuppetByCustomMXID(user.MXID) if doublePuppet == nil { return } if doublePuppet == nil || doublePuppet.CustomIntent() == nil || len(portal.MXID) == 0 { return } if justCreated || !user.bridge.Config.Bridge.TagOnlyOnCreate { chat, err := user.Client.Store.ChatSettings.GetChatSettings(portal.Key.JID) if err != nil { user.zlog.Err(err).Stringer("portal_jid", portal.Key.JID).Msg("Failed to get chat settings from store") return } intent := doublePuppet.CustomIntent() if portal.Key.JID == types.StatusBroadcastJID && justCreated { if user.bridge.Config.Bridge.MuteStatusBroadcast { user.updateChatMute(ctx, intent, portal, time.Now().Add(365*24*time.Hour)) } if len(user.bridge.Config.Bridge.StatusBroadcastTag) > 0 { user.updateChatTag(ctx, intent, portal, user.bridge.Config.Bridge.StatusBroadcastTag, true) } return } else if !chat.Found { return } user.updateChatMute(ctx, intent, portal, chat.MutedUntil) user.updateChatTag(ctx, intent, portal, user.bridge.Config.Bridge.ArchiveTag, chat.Archived) user.updateChatTag(ctx, intent, portal, user.bridge.Config.Bridge.PinnedTag, chat.Pinned) } } func (user *User) getDirectChats(ctx context.Context) map[id.UserID][]id.RoomID { res := make(map[id.UserID][]id.RoomID) privateChats, err := user.bridge.DB.Portal.FindPrivateChats(ctx, user.JID.ToNonAD()) if err != nil { user.zlog.Err(err).Msg("Failed to get private chats of user") return res } for _, portal := range privateChats { if len(portal.MXID) > 0 { res[user.bridge.FormatPuppetMXID(portal.Key.JID)] = []id.RoomID{portal.MXID} } } return res } func (user *User) UpdateDirectChats(ctx context.Context, chats map[id.UserID][]id.RoomID) { if !user.bridge.Config.Bridge.SyncDirectChatList { return } puppet := user.bridge.GetPuppetByCustomMXID(user.MXID) if puppet == nil || puppet.CustomIntent() == nil { return } intent := puppet.CustomIntent() method := http.MethodPatch if chats == nil { chats = user.getDirectChats(ctx) method = http.MethodPut } user.zlog.Debug().Msg("Updating m.direct list on homeserver") var err error if user.bridge.Config.Homeserver.Software == bridgeconfig.SoftwareAsmux { urlPath := intent.BuildClientURL("unstable", "com.beeper.asmux", "dms") _, err = intent.MakeFullRequest(ctx, mautrix.FullRequest{ Method: method, URL: urlPath, Headers: http.Header{"X-Asmux-Auth": {user.bridge.AS.Registration.AppToken}}, RequestJSON: chats, }) } else { existingChats := make(map[id.UserID][]id.RoomID) err = intent.GetAccountData(ctx, event.AccountDataDirectChats.Type, &existingChats) if err != nil { user.zlog.Err(err).Msg("Failed to get m.direct list to update it") return } for userID, rooms := range existingChats { if _, ok := user.bridge.ParsePuppetMXID(userID); !ok { // This is not a ghost user, include it in the new list chats[userID] = rooms } else if _, ok := chats[userID]; !ok && method == http.MethodPatch { // This is a ghost user, but we're not replacing the whole list, so include it too chats[userID] = rooms } } err = intent.SetAccountData(ctx, event.AccountDataDirectChats.Type, &chats) } if err != nil { user.zlog.Err(err).Msg("Failed to update m.direct list") } } func (user *User) handleLoggedOut(ctx context.Context, onConnect bool, reason events.ConnectFailureReason) { errorCode := WAUnknownLogout if reason == events.ConnectFailureLoggedOut { errorCode = WALoggedOut } else if reason == events.ConnectFailureMainDeviceGone { errorCode = WAMainDeviceGone } user.removeFromJIDMap(status.BridgeState{StateEvent: status.StateBadCredentials, Error: errorCode}) user.DeleteConnection() user.Session = nil user.JID = types.EmptyJID err := user.Update(ctx) if err != nil { user.zlog.Err(err).Msg("Failed to save user after getting logged out") } if onConnect { user.sendMarkdownBridgeAlert(ctx, "Connecting to WhatsApp failed as the device was unlinked (error %s). Please link the bridge to your phone again.", reason) } else { user.sendMarkdownBridgeAlert(ctx, "You were logged out from another device. Please link the bridge to your phone again.") } } func (user *User) GetPortalByMessageSource(ms types.MessageSource) *Portal { jid := ms.Chat if ms.IsIncomingBroadcast() { if ms.IsFromMe { jid = ms.BroadcastListOwner.ToNonAD() } else { jid = ms.Sender.ToNonAD() } if jid.IsEmpty() { return nil } } return user.bridge.GetPortalByJID(database.NewPortalKey(jid, user.JID)) } func (user *User) GetPortalByJID(jid types.JID) *Portal { return user.bridge.GetPortalByJID(database.NewPortalKey(jid, user.JID)) } func (user *User) syncPuppet(jid types.JID, reason string) { user.bridge.GetPuppetByJID(jid).SyncContact(user.zlog.WithContext(context.TODO()), user, false, false, reason) } func (user *User) ResyncContacts(forceAvatarSync bool) error { contacts, err := user.Client.Store.Contacts.GetAllContacts() if err != nil { return fmt.Errorf("failed to get cached contacts: %w", err) } user.zlog.Info().Int("contact_count", len(contacts)).Msg("Resyncing displaynames with contact info") ctx := user.zlog.With().Str("action", "resync contacts").Logger().WithContext(context.TODO()) for jid, contact := range contacts { puppet := user.bridge.GetPuppetByJID(jid) if puppet != nil { puppet.Sync(ctx, user, &contact, forceAvatarSync, true) } else { user.zlog.Warn().Stringer("jid", jid).Msg("Got a nil puppet while syncing contacts") } } return nil } func (user *User) ResyncGroups(createPortals bool) error { groups, err := user.Client.GetJoinedGroups() if err != nil { return fmt.Errorf("failed to get group list from server: %w", err) } user.groupListCacheLock.Lock() user.groupListCache = groups user.groupListCacheTime = time.Now() user.groupListCacheLock.Unlock() ctx := user.zlog.With().Str("method", "ResyncGroups").Logger().WithContext(context.TODO()) for _, group := range groups { portal := user.GetPortalByJID(group.JID) if len(portal.MXID) == 0 { if createPortals { err = portal.CreateMatrixRoom(ctx, user, group, nil, true, true) if err != nil { return fmt.Errorf("failed to create room for %s: %w", group.JID, err) } } } else { portal.UpdateMatrixRoom(ctx, user, group, nil) } } return nil } const WATypingTimeout = 15 * time.Second func (user *User) handleChatPresence(ctx context.Context, presence *events.ChatPresence) { puppet := user.bridge.GetPuppetByJID(presence.Sender) if puppet == nil { return } portal := user.GetPortalByJID(presence.Chat) if puppet == nil || portal == nil || len(portal.MXID) == 0 { return } if presence.State == types.ChatPresenceComposing { if puppet.typingIn != "" && puppet.typingAt.Add(WATypingTimeout).Before(time.Now()) { if puppet.typingIn == portal.MXID { return } _, _ = puppet.IntentFor(portal).UserTyping(ctx, puppet.typingIn, false, 0) } _, _ = puppet.IntentFor(portal).UserTyping(ctx, portal.MXID, true, WATypingTimeout) puppet.typingIn = portal.MXID puppet.typingAt = time.Now() } else { _, _ = puppet.IntentFor(portal).UserTyping(ctx, portal.MXID, false, 0) puppet.typingIn = "" } } func (user *User) handleReceipt(receipt *events.Receipt) { if receipt.Type != types.ReceiptTypeRead && receipt.Type != types.ReceiptTypeReadSelf && receipt.Type != types.ReceiptTypeDelivered { return } portal := user.GetPortalByMessageSource(receipt.MessageSource) if portal == nil || len(portal.MXID) == 0 { return } portal.events <- &PortalEvent{ Message: &PortalMessage{receipt: receipt, source: user}, } } func (user *User) makeReadMarkerContent(eventID id.EventID, doublePuppet bool) CustomReadMarkers { var extra CustomReadReceipt if doublePuppet { extra.DoublePuppetSource = user.bridge.Name } return CustomReadMarkers{ ReqSetReadMarkers: mautrix.ReqSetReadMarkers{ Read: eventID, FullyRead: eventID, }, ReadExtra: extra, FullyReadExtra: extra, } } func (user *User) markSelfReadFull(ctx context.Context, portal *Portal) { puppet := user.bridge.GetPuppetByCustomMXID(user.MXID) if puppet == nil || puppet.CustomIntent() == nil { return } lastMessage, err := user.bridge.DB.Message.GetLastInChat(ctx, portal.Key) if err != nil { user.zlog.Err(err).Msg("Failed to get last message in chat to mark as read") return } else if lastMessage == nil { return } user.SetLastReadTS(ctx, portal.Key, lastMessage.Timestamp) err = puppet.CustomIntent().SetReadMarkers(ctx, portal.MXID, user.makeReadMarkerContent(lastMessage.MXID, true)) if err != nil { user.zlog.Err(err). Stringer("portal_mxid", portal.MXID). Stringer("last_message_mxid", lastMessage.MXID). Msg("Failed to mark last message in chat as read") } else { user.zlog.Debug(). Stringer("portal_mxid", portal.MXID). Stringer("last_message_mxid", lastMessage.MXID). Msg("Marked last message in chat as read") } } func (user *User) markUnread(ctx context.Context, portal *Portal, unread bool) { puppet := user.bridge.GetPuppetByCustomMXID(user.MXID) if puppet == nil || puppet.CustomIntent() == nil { return } err := puppet.CustomIntent().SetRoomAccountData(ctx, portal.MXID, "m.marked_unread", map[string]bool{"unread": unread}) if err != nil { user.zlog.Err(err).Stringer("portal_mxid", portal.MXID).Msg("Failed to mark room as unread (m.marked_unread)") } else { user.zlog.Debug().Stringer("portal_mxid", portal.MXID).Msg("Marked room as unread (m.marked_unread)") } err = puppet.CustomIntent().SetRoomAccountData(ctx, portal.MXID, "com.famedly.marked_unread", map[string]bool{"unread": unread}) if err != nil { user.zlog.Err(err).Stringer("portal_mxid", portal.MXID).Msg("Failed to mark room as unread (com.famedly.marked_unread)") } else { user.zlog.Debug().Stringer("portal_mxid", portal.MXID).Msg("Marked room as unread (com.famedly.marked_unread)") } } func (user *User) handleGroupCreate(evt *events.JoinedGroup) { log := user.zlog.With().Str("whatsapp_event", "JoinedGroup").Logger() ctx := log.WithContext(context.TODO()) portal := user.GetPortalByJID(evt.JID) if evt.CreateKey == "" && len(portal.MXID) == 0 && portal.Key.JID != user.skipGroupCreateDelay { log.Debug().Msg("Delaying handling group create with empty key to avoid race conditions") time.Sleep(5 * time.Second) } if len(portal.MXID) == 0 { if user.createKeyDedup != "" && evt.CreateKey == user.createKeyDedup { log.Debug().Str("create_key", evt.CreateKey).Msg("Ignoring group create event with cached create key") return } err := portal.CreateMatrixRoom(ctx, user, &evt.GroupInfo, nil, true, true) if err != nil { log.Err(err).Msg("Failed to create Matrix room after join notification") } } else { portal.UpdateMatrixRoom(ctx, user, &evt.GroupInfo, nil) } } func (user *User) handleGroupUpdate(evt *events.GroupInfo) { portal := user.GetPortalByJID(evt.JID) with := user.zlog.With(). Str("chat_jid", evt.JID.String()). Interface("group_event", evt) if portal != nil { with = with.Str("portal_mxid", portal.MXID.String()) } log := with.Logger() if portal == nil || len(portal.MXID) == 0 { log.Debug().Msg("Ignoring group info update in chat with no portal") return } if evt.Sender != nil && evt.Sender.Server == types.HiddenUserServer { log.Debug().Str("sender", evt.Sender.String()).Msg("Ignoring group info update from @lid user") return } ctx := log.WithContext(context.TODO()) switch { case evt.Announce != nil: log.Debug().Msg("Group announcement mode (message send permission) changed") portal.RestrictMessageSending(ctx, evt.Announce.IsAnnounce) case evt.Locked != nil: log.Debug().Msg("Group locked mode (metadata change permission) changed") portal.RestrictMetadataChanges(ctx, evt.Locked.IsLocked) case evt.Name != nil: log.Debug().Msg("Group name changed") portal.UpdateName(ctx, evt.Name.Name, evt.Name.NameSetBy, true) case evt.Topic != nil: log.Debug().Msg("Group topic changed") portal.UpdateTopic(ctx, evt.Topic.Topic, evt.Topic.TopicSetBy, true) case evt.Leave != nil: log.Debug().Msg("Someone left the group") if evt.Sender != nil && !evt.Sender.IsEmpty() { portal.HandleWhatsAppKick(ctx, user, *evt.Sender, evt.Leave) } case evt.Join != nil: log.Debug().Msg("Someone joined the group") portal.HandleWhatsAppInvite(ctx, user, evt.Sender, evt.Join) case evt.Promote != nil: log.Debug().Msg("Someone was promoted to admin") portal.ChangeAdminStatus(ctx, evt.Promote, true) case evt.Demote != nil: log.Debug().Msg("Someone was demoted from admin") portal.ChangeAdminStatus(ctx, evt.Demote, false) case evt.Ephemeral != nil: log.Debug().Msg("Group ephemeral mode (disappearing message timer) changed") portal.UpdateGroupDisappearingMessages(ctx, evt.Sender, evt.Timestamp, evt.Ephemeral.DisappearingTimer) case evt.Link != nil: log.Debug().Msg("Group parent changed") if evt.Link.Type == types.GroupLinkChangeTypeParent { portal.UpdateParentGroup(ctx, user, evt.Link.Group.JID, true) } case evt.Unlink != nil: log.Debug().Msg("Group parent removed") if evt.Unlink.Type == types.GroupLinkChangeTypeParent && portal.ParentGroup == evt.Unlink.Group.JID { portal.UpdateParentGroup(ctx, user, types.EmptyJID, true) } case evt.Delete != nil: log.Debug().Msg("Group deleted") portal.Delete(ctx) portal.Cleanup(ctx, false) default: log.Warn().Msg("Unhandled group info update") } } func (user *User) handleNewsletterJoin(evt *events.NewsletterJoin) { ctx := user.zlog.With().Str("whatsapp_event", "NewsletterJoin").Logger().WithContext(context.TODO()) portal := user.GetPortalByJID(evt.ID) if portal.MXID == "" { err := portal.CreateMatrixRoom(ctx, user, nil, &evt.NewsletterMetadata, true, false) if err != nil { user.zlog.Err(err).Msg("Failed to create room on newsletter join event") } } else { portal.UpdateMatrixRoom(ctx, user, nil, &evt.NewsletterMetadata) } } func (user *User) handleNewsletterLeave(evt *events.NewsletterLeave) { ctx := user.zlog.With().Str("whatsapp_event", "NewsletterLeave").Logger().WithContext(context.TODO()) portal := user.GetPortalByJID(evt.ID) if portal.MXID != "" { portal.HandleWhatsAppKick(ctx, user, user.JID, []types.JID{user.JID}) } } func (user *User) handlePictureUpdate(ctx context.Context, evt *events.Picture) { if evt.JID.Server == types.DefaultUserServer { puppet := user.bridge.GetPuppetByJID(evt.JID) user.zlog.Debug(). Stringer("jid", evt.JID). Str("current_avatar", puppet.Avatar). Str("new_avatar", evt.PictureID). Msg("Received picture update for puppet") if puppet.Avatar != evt.PictureID { puppet.Sync(ctx, user, nil, true, false) } } else if portal := user.GetPortalByJID(evt.JID); portal != nil { user.zlog.Debug(). Stringer("jid", evt.JID). Str("current_avatar", portal.Avatar). Str("new_avatar", evt.PictureID). Msg("Received picture update for portal") if portal.Avatar != evt.PictureID { portal.UpdateAvatar(ctx, user, evt.Author, true) } } } func (user *User) StartPM(ctx context.Context, jid types.JID, reason string) (*Portal, *Puppet, bool, error) { zerolog.Ctx(ctx).Debug().Stringer("jid", jid).Str("source", reason).Msg("Starting PM with user") puppet := user.bridge.GetPuppetByJID(jid) puppet.SyncContact(ctx, user, true, false, reason) portal := user.GetPortalByJID(puppet.JID) if len(portal.MXID) > 0 { ok := portal.ensureUserInvited(ctx, user) if !ok { zerolog.Ctx(ctx).Warn().Msg("Failed to ensure user is invited to room in StartPM, creating new portal") portal.MXID = "" portal.updateLogger() } else { return portal, puppet, false, nil } } err := portal.CreateMatrixRoom(ctx, user, nil, nil, false, true) return portal, puppet, true, err } const groupListCacheMaxAge = 24 * time.Hour func (user *User) getCachedGroupList() ([]*types.GroupInfo, error) { user.groupListCacheLock.Lock() defer user.groupListCacheLock.Unlock() if user.groupListCache != nil && user.groupListCacheTime.Add(groupListCacheMaxAge).After(time.Now()) { return user.groupListCache, nil } var err error user.groupListCache, err = user.Client.GetJoinedGroups() user.groupListCacheTime = time.Now() return user.groupListCache, err }