Merge 196e5bc106 into 62aee50dcb

Reviewed-on: tileradotorg/mautrix-whatsapp#1

CHANGELOG.md

@@ -3,6 +3,7 @@
 * Bumped minimum Go version to 1.21.
 * Added 8-letter code pairing support to provisioning API.
 * Added more bugs to fix later.
+* Renamed default branch from `master` to `main`.
 
 # v0.10.5 (2023-12-16)
 

README.md

@@ -11,8 +11,7 @@ All setup and usage instructions are located on [docs.mau.fi]. Some quick links:
 * Basic usage: [Authentication](https://docs.mau.fi/bridges/go/whatsapp/authentication.html)
 
 ### Features & Roadmap
-[ROADMAP.md](https://github.com/mautrix/whatsapp/blob/master/ROADMAP.md)
-contains a general overview of what is supported by the bridge.
+[ROADMAP.md](ROADMAP.md) contains a general overview of what is supported by the bridge.
 
 ## Discussion
 Matrix room: [#whatsapp:maunium.net](https://matrix.to/#/#whatsapp:maunium.net)

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

@@ -14,7 +14,7 @@ require (
 	github.com/tidwall/gjson v1.17.1
 	go.mau.fi/util v0.4.1-0.20240311141448-53cb04950f7e
 	go.mau.fi/webp v0.1.0
-	go.mau.fi/whatsmeow v0.0.0-20240311200223-e9bca1903462
+	go.mau.fi/whatsmeow v0.0.0-20240312193055-9b989e1cc696
 	golang.org/x/exp v0.0.0-20240222234643-814bf88cf225
 	golang.org/x/image v0.15.0
 	golang.org/x/net v0.22.0

go.sum

@@ -73,8 +73,8 @@ go.mau.fi/util v0.4.1-0.20240311141448-53cb04950f7e h1:e1jDj/MjleSS5r9DMRbuCZYKy
 go.mau.fi/util v0.4.1-0.20240311141448-53cb04950f7e/go.mod h1:jOAREC/go8T6rGic01cu6WRa90xi9U4z3QmDjRf8xpo=
 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-20240311200223-e9bca1903462 h1:QOGjCIh2WEfkgX/38KLjnNof79GWx0T+KLrhTHiws3s=
-go.mau.fi/whatsmeow v0.0.0-20240311200223-e9bca1903462/go.mod h1:lQHbhaG/fI+6hfGqz5Vzn2OBJBEZ05H0kCP6iJXriN4=
+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/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=

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 {