Merge 196e5bc106 into de605d6161

Reviewed-on: tileradotorg/mautrix-whatsapp#1

CHANGELOG.md

@@ -1,4 +1,4 @@
-# v0.10.6 (unreleased)
+# v0.10.6 (2024-03-16)
 
 * Bumped minimum Go version to 1.21.
 * Added 8-letter code pairing support to provisioning API.

config/bridge.go

@@ -94,27 +94,28 @@ type BridgeConfig struct {
 
 	DoublePuppetConfig bridgeconfig.DoublePuppetConfig `yaml:",inline"`
 
-	PrivateChatPortalMeta string `yaml:"private_chat_portal_meta"`
-	ParallelMemberSync    bool   `yaml:"parallel_member_sync"`
-	BridgeNotices         bool   `yaml:"bridge_notices"`
-	ResendBridgeInfo      bool   `yaml:"resend_bridge_info"`
-	MuteBridging          bool   `yaml:"mute_bridging"`
-	ArchiveTag            string `yaml:"archive_tag"`
-	PinnedTag             string `yaml:"pinned_tag"`
-	TagOnlyOnCreate       bool   `yaml:"tag_only_on_create"`
-	MarkReadOnlyOnCreate  bool   `yaml:"mark_read_only_on_create"`
-	EnableStatusBroadcast bool   `yaml:"enable_status_broadcast"`
-	MuteStatusBroadcast   bool   `yaml:"mute_status_broadcast"`
-	StatusBroadcastTag    string `yaml:"status_broadcast_tag"`
-	WhatsappThumbnail     bool   `yaml:"whatsapp_thumbnail"`
-	AllowUserInvite       bool   `yaml:"allow_user_invite"`
-	FederateRooms         bool   `yaml:"federate_rooms"`
-	URLPreviews           bool   `yaml:"url_previews"`
-	CaptionInMessage      bool   `yaml:"caption_in_message"`
-	BeeperGalleries       bool   `yaml:"beeper_galleries"`
-	ExtEvPolls            bool   `yaml:"extev_polls"`
-	CrossRoomReplies      bool   `yaml:"cross_room_replies"`
-	DisableReplyFallbacks bool   `yaml:"disable_reply_fallbacks"`
+	PrivateChatPortalMeta  string `yaml:"private_chat_portal_meta"`
+	ParallelMemberSync     bool   `yaml:"parallel_member_sync"`
+	BridgeNotices          bool   `yaml:"bridge_notices"`
+	ResendBridgeInfo       bool   `yaml:"resend_bridge_info"`
+	MuteBridging           bool   `yaml:"mute_bridging"`
+	ArchiveTag             string `yaml:"archive_tag"`
+	PinnedTag              string `yaml:"pinned_tag"`
+	TagOnlyOnCreate        bool   `yaml:"tag_only_on_create"`
+	MarkReadOnlyOnCreate   bool   `yaml:"mark_read_only_on_create"`
+	EnableStatusBroadcast  bool   `yaml:"enable_status_broadcast"`
+	MuteStatusBroadcast    bool   `yaml:"mute_status_broadcast"`
+	StatusBroadcastTag     string `yaml:"status_broadcast_tag"`
+	WhatsappThumbnail      bool   `yaml:"whatsapp_thumbnail"`
+	AllowUserInvite        bool   `yaml:"allow_user_invite"`
+	FederateRooms          bool   `yaml:"federate_rooms"`
+	URLPreviews            bool   `yaml:"url_previews"`
+	CaptionInMessage       bool   `yaml:"caption_in_message"`
+	BeeperGalleries        bool   `yaml:"beeper_galleries"`
+	ExtEvPolls             bool   `yaml:"extev_polls"`
+	CrossRoomReplies       bool   `yaml:"cross_room_replies"`
+	DisableReplyFallbacks  bool   `yaml:"disable_reply_fallbacks"`
+	PrivateChatSelfPuppets bool   `yaml:"private_chat_self_puppets"`
 
 	MessageHandlingTimeout struct {
 		ErrorAfterStr string `yaml:"error_after"`

config/upgrade.go

@@ -115,6 +115,7 @@ func DoUpgrade(helper *up.Helper) {
 	}
 	helper.Copy(up.Bool, "bridge", "cross_room_replies")
 	helper.Copy(up.Bool, "bridge", "disable_reply_fallbacks")
+	helper.Copy(up.Bool, "bridge", "private_chat_self_puppets")
 	helper.Copy(up.Str|up.Null, "bridge", "message_handling_timeout", "error_after")
 	helper.Copy(up.Str|up.Null, "bridge", "message_handling_timeout", "deadline")
 

example-config.yaml

@@ -313,6 +313,10 @@ bridge:
     # Disable generating reply fallbacks? Some extremely bad clients still rely on them,
     # but they're being phased out and will be completely removed in the future.
     disable_reply_fallbacks: false
+    # Invite the puppet which represents the bridge user into private chats?
+    # This allows proper backfilling in private chats without double puppeting enabled,
+    # but adds an additional puppet user to each private chat.
+    private_chat_self_puppets: false
     # Maximum time for handling Matrix events. Duration strings formatted for https://pkg.go.dev/time#ParseDuration
     # Null means there's no enforced timeout.
     message_handling_timeout:

go.mod

@@ -12,14 +12,14 @@ require (
 	github.com/rs/zerolog v1.32.0
 	github.com/skip2/go-qrcode v0.0.0-20200617195104-da1b6568686e
 	github.com/tidwall/gjson v1.17.1
-	go.mau.fi/util v0.4.1-0.20240311141448-53cb04950f7e
+	go.mau.fi/util v0.4.1
 	go.mau.fi/webp v0.1.0
-	go.mau.fi/whatsmeow v0.0.0-20240312193055-9b989e1cc696
-	golang.org/x/exp v0.0.0-20240222234643-814bf88cf225
+	go.mau.fi/whatsmeow v0.0.0-20240316104858-18372a0653fa
+	golang.org/x/exp v0.0.0-20240314144324-c7f7c6466f7f
 	golang.org/x/image v0.15.0
 	golang.org/x/net v0.22.0
 	google.golang.org/protobuf v1.33.0
-	maunium.net/go/mautrix v0.18.0-beta.1.0.20240311183606-94246ffc85aa
+	maunium.net/go/mautrix v0.18.0
 )
 
 require (
@@ -48,6 +48,3 @@ require (
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 	maunium.net/go/mauflag v1.0.0 // indirect
 )
-
-//replace go.mau.fi/util => ../../Go/go-util
-//replace maunium.net/go/mautrix => ../mautrix-go

go.sum

@@ -69,18 +69,18 @@ github.com/yuin/goldmark v1.7.0 h1:EfOIvIMZIzHdB/R/zVrikYLPPwJlfMcNczJFMs1m6sA=
 github.com/yuin/goldmark v1.7.0/go.mod h1:uzxRWxtg69N339t3louHJ7+O03ezfj6PlliRlaOzY1E=
 go.mau.fi/libsignal v0.1.0 h1:vAKI/nJ5tMhdzke4cTK1fb0idJzz1JuEIpmjprueC+c=
 go.mau.fi/libsignal v0.1.0/go.mod h1:R8ovrTezxtUNzCQE5PH30StOQWWeBskBsWE55vMfY9I=
-go.mau.fi/util v0.4.1-0.20240311141448-53cb04950f7e h1:e1jDj/MjleSS5r9DMRbuCZYKy5Rr+sbsu8eWjtLqrGk=
-go.mau.fi/util v0.4.1-0.20240311141448-53cb04950f7e/go.mod h1:jOAREC/go8T6rGic01cu6WRa90xi9U4z3QmDjRf8xpo=
+go.mau.fi/util v0.4.1 h1:3EC9KxIXo5+h869zDGf5OOZklRd/FjeVnimTwtm3owg=
+go.mau.fi/util v0.4.1/go.mod h1:GjkTEBsehYZbSh2LlE6cWEn+6ZIZTGrTMM/5DMNlmFY=
 go.mau.fi/webp v0.1.0 h1:BHObH/DcFntT9KYun5pDr0Ot4eUZO8k2C7eP7vF4ueA=
 go.mau.fi/webp v0.1.0/go.mod h1:e42Z+VMFrUMS9cpEwGRIor+lQWO8oUAyPyMtcL+NMt8=
-go.mau.fi/whatsmeow v0.0.0-20240312193055-9b989e1cc696 h1:F9ytx1yzfoclCS4DoEqQb1M0E5XpcX2j5dX8bIZjGFE=
-go.mau.fi/whatsmeow v0.0.0-20240312193055-9b989e1cc696/go.mod h1:lQHbhaG/fI+6hfGqz5Vzn2OBJBEZ05H0kCP6iJXriN4=
+go.mau.fi/whatsmeow v0.0.0-20240316104858-18372a0653fa h1:ifQivrTMLAAkBkIqdE/D56uAZyc7ziRdhUU59VfNPFg=
+go.mau.fi/whatsmeow v0.0.0-20240316104858-18372a0653fa/go.mod h1:kNI5foyzqd77d5HaWc1Jico6/rxtZ/UE8nr80hIsbIk=
 go.mau.fi/zeroconfig v0.1.2 h1:DKOydWnhPMn65GbXZOafgkPm11BvFashZWLct0dGFto=
 go.mau.fi/zeroconfig v0.1.2/go.mod h1:NcSJkf180JT+1IId76PcMuLTNa1CzsFFZ0nBygIQM70=
 golang.org/x/crypto v0.21.0 h1:X31++rzVUdKhX5sWmSOFZxx8UW/ldWx55cbf08iNAMA=
 golang.org/x/crypto v0.21.0/go.mod h1:0BP7YvVV9gBbVKyeTG0Gyn+gZm94bibOW5BjDEYAOMs=
-golang.org/x/exp v0.0.0-20240222234643-814bf88cf225 h1:LfspQV/FYTatPTr/3HzIcmiUFH7PGP+OQ6mgDYo3yuQ=
-golang.org/x/exp v0.0.0-20240222234643-814bf88cf225/go.mod h1:CxmFvTBINI24O/j8iY7H1xHzx2i4OsyguNBmN/uPtqc=
+golang.org/x/exp v0.0.0-20240314144324-c7f7c6466f7f h1:3CW0unweImhOzd5FmYuRsD4Y4oQFKZIjAnKbjV4WIrw=
+golang.org/x/exp v0.0.0-20240314144324-c7f7c6466f7f/go.mod h1:CxmFvTBINI24O/j8iY7H1xHzx2i4OsyguNBmN/uPtqc=
 golang.org/x/image v0.15.0 h1:kOELfmgrmJlw4Cdb7g/QGuB3CvDrXbqEIww/pNtNBm8=
 golang.org/x/image v0.15.0/go.mod h1:HUYqC05R2ZcZ3ejNQsIHQDQiwWM4JBqmm6MKANTp4LE=
 golang.org/x/net v0.22.0 h1:9sGLhx7iRIHEiX0oAJ3MRZMUCElJgy7Br1nO+AMN3Tc=
@@ -103,5 +103,5 @@ gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 maunium.net/go/mauflag v1.0.0 h1:YiaRc0tEI3toYtJMRIfjP+jklH45uDHtT80nUamyD4M=
 maunium.net/go/mauflag v1.0.0/go.mod h1:nLivPOpTpHnpzEh8jEdSL9UqO9+/KBJFmNRlwKfkPeA=
-maunium.net/go/mautrix v0.18.0-beta.1.0.20240311183606-94246ffc85aa h1:TLSWIAWKIWxLghgzWfp7o92pVCcFR3yLsArc0s/tsMs=
-maunium.net/go/mautrix v0.18.0-beta.1.0.20240311183606-94246ffc85aa/go.mod h1:0sfLB2ejW+lhgio4UlZMmn5i9SuZ8mxFkonFSamrfTE=
+maunium.net/go/mautrix v0.18.0 h1:sNsApeSWB8x0hLjGcdmi5JqO6Tvp2PVkiSStz+Yas6k=
+maunium.net/go/mautrix v0.18.0/go.mod h1:STwJZ+6CAeiEQs7fYCkd5aC12XR5DXANE6Swy/PBKGo=

main.go

@@ -278,7 +278,7 @@ func main() {
 		Name:              "mautrix-whatsapp",
 		URL:               "https://github.com/mautrix/whatsapp",
 		Description:       "A Matrix-WhatsApp puppeting bridge.",
-		Version:           "0.10.5",
+		Version:           "0.10.6",
 		ProtocolName:      "WhatsApp",
 		BeeperServiceName: "whatsapp",
 		BeeperNetworkName: "whatsapp",

portal.go

@@ -1224,7 +1224,7 @@ func (portal *Portal) getMessageIntent(ctx context.Context, user *User, info *ty
 		return nil
 	}
 	intent := puppet.IntentFor(portal)
-	if !intent.IsCustomPuppet && portal.IsPrivateChat() && info.Sender.User == portal.Key.Receiver.User && portal.Key.Receiver != portal.Key.JID {
+	if !portal.bridge.Config.Bridge.PrivateChatSelfPuppets && !intent.IsCustomPuppet && portal.IsPrivateChat() && info.Sender.User == portal.Key.Receiver.User && portal.Key.Receiver != portal.Key.JID {
 		zerolog.Ctx(ctx).Debug().Msg("Not handling message: user doesn't have double puppeting enabled")
 		return nil
 	}
@@ -2188,6 +2188,10 @@ func (portal *Portal) CreateMatrixRoom(ctx context.Context, user *User, groupInf
 			invite = append(invite, portal.bridge.Bot.UserID)
 		}
 	}
+	if portal.IsPrivateChat() && portal.bridge.Config.Bridge.PrivateChatSelfPuppets {
+		rec := portal.bridge.GetPuppetByJID(portal.Key.Receiver)
+		invite = append(invite, rec.MXID)
+	}
 	if !portal.AvatarURL.IsEmpty() && portal.shouldSetDMRoomMetadata() {
 		initialState = append(initialState, &event.Event{
 			Type: event.StateRoomAvatar,
@@ -2311,6 +2315,13 @@ func (portal *Portal) CreateMatrixRoom(ctx context.Context, user *User, groupInf
 				log.Err(err).Msg("Failed to ensure bridge bot is joined to created portal")
 			}
 		}
+		if portal.bridge.Config.Bridge.PrivateChatSelfPuppets {
+			rec := portal.bridge.GetPuppetByJID(portal.Key.Receiver)
+			err = rec.DefaultIntent().EnsureJoined(ctx, portal.MXID)
+			if err != nil {
+				log.Err(err).Msg("Failed to join created portal with puppet")
+			}
+		}
 
 		user.UpdateDirectChats(ctx, map[id.UserID][]id.RoomID{puppet.MXID: {portal.MXID}})
 	} else if portal.IsParent {