Merge tag 'v0.6.1' into element-main

CHANGELOG.md

@@ -1,3 +1,13 @@
+# v0.6.1 (2024-05-16)
+
+* Added support for bridging location messages from Matrix to Signal
+  (thanks to [@maltee1] in [#504]).
+  * Note that Signal doesn't support real location messages, so they're just
+    bridged as links. The link template is configurable.
+* Fixed bridging long text messages from Signal
+  (thanks to [@maltee1] in [#509]).
+* Improved handling of ping timeouts in Signal websocket.
+
 # v0.6.0 (2024-04-16)
 
 * Updated to libsignal v0.44.0.

config/bridge.go

@@ -42,17 +42,18 @@ type BridgeConfig struct {
 
 	PortalMessageBuffer int `yaml:"portal_message_buffer"`
 
-	PersonalFilteringSpaces bool `yaml:"personal_filtering_spaces"`
-	BridgeNotices           bool `yaml:"bridge_notices"`
-	DeliveryReceipts        bool `yaml:"delivery_receipts"`
-	MessageStatusEvents     bool `yaml:"message_status_events"`
-	MessageErrorNotices     bool `yaml:"message_error_notices"`
-	SyncDirectChatList      bool `yaml:"sync_direct_chat_list"`
-	ResendBridgeInfo        bool `yaml:"resend_bridge_info"`
-	PublicPortals           bool `yaml:"public_portals"`
-	CaptionInMessage        bool `yaml:"caption_in_message"`
-	FederateRooms           bool `yaml:"federate_rooms"`
-	BridgeMatrixLeave       bool `yaml:"bridge_matrix_leave"`
+	PersonalFilteringSpaces bool   `yaml:"personal_filtering_spaces"`
+	BridgeNotices           bool   `yaml:"bridge_notices"`
+	DeliveryReceipts        bool   `yaml:"delivery_receipts"`
+	MessageStatusEvents     bool   `yaml:"message_status_events"`
+	MessageErrorNotices     bool   `yaml:"message_error_notices"`
+	SyncDirectChatList      bool   `yaml:"sync_direct_chat_list"`
+	ResendBridgeInfo        bool   `yaml:"resend_bridge_info"`
+	PublicPortals           bool   `yaml:"public_portals"`
+	CaptionInMessage        bool   `yaml:"caption_in_message"`
+	LocationFormat          string `yaml:"location_format"`
+	FederateRooms           bool   `yaml:"federate_rooms"`
+	BridgeMatrixLeave       bool   `yaml:"bridge_matrix_leave"`
 
 	DoublePuppetConfig bridgeconfig.DoublePuppetConfig `yaml:",inline"`
 

config/upgrade.go

@@ -97,6 +97,7 @@ func DoUpgrade(helper *up.Helper) {
 	helper.Copy(up.Bool, "bridge", "resend_bridge_info")
 	helper.Copy(up.Bool, "bridge", "public_portals")
 	helper.Copy(up.Bool, "bridge", "caption_in_message")
+	helper.Copy(up.Str, "bridge", "location_format")
 	helper.Copy(up.Bool, "bridge", "federate_rooms")
 	helper.Copy(up.Map, "bridge", "double_puppet_server_map")
 	helper.Copy(up.Bool, "bridge", "double_puppet_allow_discovery")

example-config.yaml

@@ -139,6 +139,10 @@ bridge:
     # Send captions in the same message as images. This will send data compatible with both MSC2530.
     # This is currently not supported in most clients.
     caption_in_message: false
+    # Format for generating URLs from location messages for sending to Signal
+    # Google Maps: 'https://www.google.com/maps/place/%[1]s,%[2]s'
+    # OpenStreetMap: 'https://www.openstreetmap.org/?mlat=%[1]s&mlon=%[2]'
+    location_format: 'https://www.google.com/maps/place/%[1]s,%[2]s'
     # Whether or not created rooms should have federation enabled.
     # If false, created portal rooms will never be federated.
     federate_rooms: true

go.mod

@@ -11,16 +11,16 @@ require (
 	github.com/lib/pq v1.10.9
 	github.com/mattn/go-pointer v0.0.1
 	github.com/mattn/go-sqlite3 v1.14.22
-	github.com/prometheus/client_golang v1.19.0
+	github.com/prometheus/client_golang v1.19.1
 	github.com/rs/zerolog v1.32.0
 	github.com/skip2/go-qrcode v0.0.0-20200617195104-da1b6568686e
 	github.com/stretchr/testify v1.9.0
 	github.com/tidwall/gjson v1.17.1
 	go.mau.fi/util v0.4.2
-	golang.org/x/crypto v0.22.0
-	golang.org/x/exp v0.0.0-20240409090435-93d18d7e34b8
-	golang.org/x/net v0.24.0
-	google.golang.org/protobuf v1.33.0
+	golang.org/x/crypto v0.23.0
+	golang.org/x/exp v0.0.0-20240506185415-9bf2ced13842
+	golang.org/x/net v0.25.0
+	google.golang.org/protobuf v1.34.1
 	nhooyr.io/websocket v1.8.11
 )
 
@@ -43,7 +43,7 @@ require (
 	github.com/tidwall/sjson v1.2.5 // indirect
 	github.com/yuin/goldmark v1.7.1 // indirect
 	go.mau.fi/zeroconfig v0.1.2 // indirect
-	golang.org/x/sys v0.19.0 // indirect
+	golang.org/x/sys v0.20.0 // indirect
 	gopkg.in/natefinch/lumberjack.v2 v2.2.1 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 	maunium.net/go/mauflag v1.0.0 // indirect

go.sum

@@ -42,8 +42,8 @@ github.com/mattn/go-sqlite3 v1.14.22/go.mod h1:Uh1q+B4BYcTPb+yiD3kU8Ct7aC0hY9fxU
 github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
-github.com/prometheus/client_golang v1.19.0 h1:ygXvpU1AoN1MhdzckN+PyD9QJOSD4x7kmXYlnfbA6JU=
-github.com/prometheus/client_golang v1.19.0/go.mod h1:ZRM9uEAypZakd+q/x7+gmsvXdURP+DABIEIjnmDdp+k=
+github.com/prometheus/client_golang v1.19.1 h1:wZWJDwK+NameRJuPGDhlnFgx8e8HN3XHQeLaYJFJBOE=
+github.com/prometheus/client_golang v1.19.1/go.mod h1:mP78NwGzrVks5S2H6ab8+ZZGJLZUq1hoULYBAYBw1Ho=
 github.com/prometheus/client_model v0.5.0 h1:VQw1hfvPvk3Uv6Qf29VrPF32JB6rtbgI6cYPYQjL0Qw=
 github.com/prometheus/client_model v0.5.0/go.mod h1:dTiFglRmd66nLR9Pv9f0mZi7B7fk5Pm3gvsjB5tr+kI=
 github.com/prometheus/common v0.48.0 h1:QO8U2CdOzSn1BBsmXJXduaaW+dY/5QLjfB8svtSzKKE=
@@ -75,19 +75,19 @@ go.mau.fi/util v0.4.2 h1:RR3TOcRHmCF9Bx/3YG4S65MYfa+nV6/rn8qBWW4Mi30=
 go.mau.fi/util v0.4.2/go.mod h1:PlAVfUUcPyHPrwnvjkJM9UFcPE7qGPDJqk+Oufa1Gtw=
 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.22.0 h1:g1v0xeRhjcugydODzvb3mEM9SQ0HGp9s/nh3COQ/C30=
-golang.org/x/crypto v0.22.0/go.mod h1:vr6Su+7cTlO45qkww3VDJlzDn0ctJvRgYbC2NvXHt+M=
-golang.org/x/exp v0.0.0-20240409090435-93d18d7e34b8 h1:ESSUROHIBHg7USnszlcdmjBEwdMj9VUvU+OPk4yl2mc=
-golang.org/x/exp v0.0.0-20240409090435-93d18d7e34b8/go.mod h1:/lliqkxwWAhPjf5oSOIJup2XcqJaw8RGS6k3TGEc7GI=
-golang.org/x/net v0.24.0 h1:1PcaxkF854Fu3+lvBIx5SYn9wRlBzzcnHZSiaFFAb0w=
-golang.org/x/net v0.24.0/go.mod h1:2Q7sJY5mzlzWjKtYUEXSlBWCdyaioyXzRB2RtU8KVE8=
+golang.org/x/crypto v0.23.0 h1:dIJU/v2J8Mdglj/8rJ6UUOM3Zc9zLZxVZwwxMooUSAI=
+golang.org/x/crypto v0.23.0/go.mod h1:CKFgDieR+mRhux2Lsu27y0fO304Db0wZe70UKqHu0v8=
+golang.org/x/exp v0.0.0-20240506185415-9bf2ced13842 h1:vr/HnozRka3pE4EsMEg1lgkXJkTFJCVUX+S/ZT6wYzM=
+golang.org/x/exp v0.0.0-20240506185415-9bf2ced13842/go.mod h1:XtvwrStGgqGPLc4cjQfWqZHG1YFdYs6swckp8vpsjnc=
+golang.org/x/net v0.25.0 h1:d/OCCoBEUq33pjydKrGQhw7IlUPI2Oylr+8qLx49kac=
+golang.org/x/net v0.25.0/go.mod h1:JkAGAh7GEvH74S6FOH42FLoXpXbE/aqXSrIQjXgsiwM=
 golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.19.0 h1:q5f1RH2jigJ1MoAWp2KTp3gm5zAGFUTarQZ5U386+4o=
-golang.org/x/sys v0.19.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
-google.golang.org/protobuf v1.33.0 h1:uNO2rsAINq/JlFpSdYEKIZ0uKD/R9cpdv0T+yoGwGmI=
-google.golang.org/protobuf v1.33.0/go.mod h1:c6P6GXX6sHbq/GpV6MGZEdwhWPcYBgnhAHhKbcUYpos=
+golang.org/x/sys v0.20.0 h1:Od9JTbYCk261bKm4M/mw7AklTlFYIa0bIp9BgSm1S8Y=
+golang.org/x/sys v0.20.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+google.golang.org/protobuf v1.34.1 h1:9ddQBjfCyZPOHPUiPxpYESBLc+T8P3E+Vo4IbKZgFWg=
+google.golang.org/protobuf v1.34.1/go.mod h1:c6P6GXX6sHbq/GpV6MGZEdwhWPcYBgnhAHhKbcUYpos=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk=
 gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q=

main.go

@@ -476,7 +476,7 @@ func main() {
 		Name:              "mautrix-signal",
 		URL:               "https://github.com/element-hq/mautrix-signal",
 		Description:       "A Matrix-Signal puppeting bridge.",
-		Version:           "0.6.0-mod-1",
+		Version:           "0.6.1-mod-1",
 		ProtocolName:      "Signal",
 		BeeperServiceName: "signal",
 		BeeperNetworkName: "signal",

msgconv/from-matrix.go

@@ -20,9 +20,11 @@ import (
 	"context"
 	"errors"
 	"fmt"
+	"strings"
 	"time"
 
 	"github.com/rs/zerolog"
+	"github.com/rs/zerolog/log"
 	"go.mau.fi/util/exerrors"
 	"go.mau.fi/util/exmime"
 	"go.mau.fi/util/ffmpeg"
@@ -110,8 +112,13 @@ func (mc *MessageConverter) ToSignal(ctx context.Context, evt *event.Event, cont
 			Emoji: emoji,
 		}
 	case event.MsgLocation:
-		// TODO implement
-		fallthrough
+		lat, lon, err := parseGeoURI(content.GeoURI)
+		if err != nil {
+			log.Err(err).Msg("Invalid geo URI")
+			return nil, err
+		}
+		locationString := fmt.Sprintf(mc.LocationFormat, lat, lon)
+		dm.Body = &locationString
 	default:
 		return nil, fmt.Errorf("%w %s", ErrUnsupportedMsgType, content.MsgType)
 	}
@@ -191,3 +198,20 @@ func (mc *MessageConverter) convertFileToSignal(ctx context.Context, evt *event.
 	}
 	return att, nil
 }
+
+func parseGeoURI(uri string) (lat, long string, err error) {
+	if !strings.HasPrefix(uri, "geo:") {
+		err = fmt.Errorf("uri doesn't have geo: prefix")
+		return
+	}
+	// Remove geo: prefix and anything after ;
+	coordinates := strings.Split(strings.TrimPrefix(uri, "geo:"), ";")[0]
+	splitCoordinates := strings.Split(coordinates, ",")
+	if len(splitCoordinates) != 2 {
+		err = fmt.Errorf("didn't find exactly two numbers separated by a comma")
+	} else {
+		lat = splitCoordinates[0]
+		long = splitCoordinates[1]
+	}
+	return
+}

msgconv/from-signal.go

@@ -116,7 +116,16 @@ func (mc *MessageConverter) ToMatrix(ctx context.Context, dm *signalpb.DataMessa
 		return cm
 	}
 	for i, att := range dm.GetAttachments() {
-		cm.Parts = append(cm.Parts, mc.convertAttachmentToMatrix(ctx, i, att))
+		if att.GetContentType() != "text/x-signal-plain" {
+			cm.Parts = append(cm.Parts, mc.convertAttachmentToMatrix(ctx, i, att))
+		} else {
+			longBody, err := mc.downloadSignalLongText(ctx, att)
+			if err == nil {
+				dm.Body = longBody
+			} else {
+				zerolog.Ctx(ctx).Err(err).Msg("Failed to download Signal long text")
+			}
+		}
 	}
 	for _, contact := range dm.GetContact() {
 		cm.Parts = append(cm.Parts, mc.convertContactToMatrix(ctx, contact))
@@ -416,6 +425,15 @@ func (mc *MessageConverter) convertStickerToMatrix(ctx context.Context, sticker
 	return converted
 }
 
+func (mc *MessageConverter) downloadSignalLongText(ctx context.Context, att *signalpb.AttachmentPointer) (*string, error) {
+	data, err := signalmeow.DownloadAttachment(ctx, att)
+	if err != nil {
+		return nil, fmt.Errorf("failed to download attachment: %w", err)
+	}
+	longBody := string(data)
+	return &longBody, nil
+}
+
 func (mc *MessageConverter) reuploadAttachment(ctx context.Context, att *signalpb.AttachmentPointer) (*ConvertedMessagePart, error) {
 	data, err := signalmeow.DownloadAttachment(ctx, att)
 	if err != nil {

msgconv/msgconv.go

@@ -54,6 +54,8 @@ type MessageConverter struct {
 	ConvertGIFToAPNG     bool
 	MaxFileSize          int64
 	AsyncFiles           bool
+
+	LocationFormat string
 }
 
 func (mc *MessageConverter) IsPrivateChat(ctx context.Context) bool {

pkg/signalmeow/web/signalwebsocket.go

@@ -292,9 +292,12 @@ func (s *SignalWebsocket) connectLoop(
 			for {
 				select {
 				case <-ticker.C:
-					err := ws.Ping(loopCtx)
+					pingCtx, cancel := context.WithTimeout(loopCtx, 20*time.Second)
+					err := ws.Ping(pingCtx)
+					cancel()
 					if err != nil {
-						loopCancel(fmt.Errorf("error sending keepalive: %w", err))
+						log.Err(err).Msg("Error pinging")
+						loopCancel(err)
 						return
 					}
 					log.Debug().Msg("Sent keepalive")

portal.go

@@ -241,6 +241,7 @@ func (br *SignalBridge) NewPortal(dbPortal *database.Portal) *Portal {
 		MatrixFmtParams:      matrixFormatParams,
 		ConvertVoiceMessages: true,
 		MaxFileSize:          br.MediaConfig.UploadSize,
+		LocationFormat:       br.Config.Bridge.LocationFormat,
 	}
 	go portal.messageLoop()