msgconv/from-signal: add option to make view-once messages disappear

Author: tulir

pkg/connector/config.go

@@ -39,6 +39,7 @@ type SignalConfig struct {
 	DeviceName            string              `yaml:"device_name"`
 	NoteToSelfAvatar      id.ContentURIString `yaml:"note_to_self_avatar"`
 	LocationFormat        string              `yaml:"location_format"`
+	DisappearViewOnce     bool                `yaml:"disappear_view_once"`
 
 	displaynameTemplate *template.Template `yaml:"-"`
 }
@@ -81,6 +82,7 @@ func upgradeConfig(helper up.Helper) {
 	helper.Copy(up.Str, "device_name")
 	helper.Copy(up.Str, "note_to_self_avatar")
 	helper.Copy(up.Str, "location_format")
+	helper.Copy(up.Bool, "disappear_view_once")
 }
 
 func (s *SignalConnector) GetConfig() (string, any, up.Upgrader) {

pkg/connector/connector.go

@@ -69,7 +69,9 @@ func (s *SignalConnector) Init(bridge *bridgev2.Bridge) {
 	}
 	s.Store = store.NewStore(bridge.DB.Database, dbutil.ZeroLogger(bridge.Log.With().Str("db_section", "signalmeow").Logger()))
 	s.Bridge = bridge
-	s.MsgConv = msgconv.NewMessageConverter(bridge, s.Config.LocationFormat)
+	s.MsgConv = msgconv.NewMessageConverter(bridge)
+	s.MsgConv.LocationFormat = s.Config.LocationFormat
+	s.MsgConv.DisappearViewOnce = s.Config.DisappearViewOnce
 }
 
 func (s *SignalConnector) SetMaxFileSize(maxSize int64) {

pkg/connector/example-config.yaml

@@ -21,3 +21,5 @@ note_to_self_avatar: mxc://maunium.net/REBIVrqjZwmaWpssCZpBlmlL
 # Google Maps: 'https://www.google.com/maps/place/%[1]s,%[2]s'
 # OpenStreetMap: 'https://www.openstreetmap.org/?mlat=%[1]s&mlon=%[2]s'
 location_format: 'https://www.google.com/maps/place/%[1]s,%[2]s'
+# Should view-once messages disappear shortly after sending a read receipt on Matrix?
+disappear_view_once: false

pkg/connector/handlesignal.go

@@ -314,7 +314,9 @@ func (evt *Bv2ChatEvent) ConvertMessage(ctx context.Context, portal *bridgev2.Po
 	converted := evt.s.Main.MsgConv.ToMatrix(ctx, evt.s.Client, portal, intent, dataMsg)
 	if converted.Disappear.Type != "" {
 		evtTS := evt.GetTimestamp()
-		portal.UpdateDisappearingSetting(ctx, converted.Disappear, nil, evtTS, true, true)
+		if !dataMsg.GetIsViewOnce() {
+			portal.UpdateDisappearingSetting(ctx, converted.Disappear, nil, evtTS, true, true)
+		}
 		if evt.Info.Sender == evt.s.Client.Store.ACI {
 			converted.Disappear.DisappearAt = evtTS.Add(converted.Disappear.Timer)
 		}

pkg/msgconv/from-signal.go

@@ -68,6 +68,8 @@ func CanConvertSignal(dm *signalpb.DataMessage) bool {
 	return calculateLength(dm) > 0
 }
 
+const ViewOnceDisappearTimer = 5 * time.Minute
+
 func (mc *MessageConverter) ToMatrix(
 	ctx context.Context,
 	client *signalmeow.Client,
@@ -130,6 +132,17 @@ func (mc *MessageConverter) ToMatrix(
 			},
 		})
 	}
+	if dm.GetIsViewOnce() && mc.DisappearViewOnce && (cm.Disappear.Timer == 0 || cm.Disappear.Timer > ViewOnceDisappearTimer) {
+		cm.Disappear.Type = database.DisappearingTypeAfterRead
+		cm.Disappear.Timer = ViewOnceDisappearTimer
+		cm.Parts = append(cm.Parts, &bridgev2.ConvertedMessagePart{
+			Type: event.EventMessage,
+			Content: &event.MessageEventContent{
+				MsgType: event.MsgText,
+				Body:    "This is a view-once message. It will disappear in 5 minutes.",
+			},
+		})
+	}
 	cm.MergeCaption()
 	for i, part := range cm.Parts {
 		part.ID = signalid.MakeMessagePartID(i)

pkg/msgconv/msgconv.go

@@ -44,11 +44,12 @@ type MessageConverter struct {
 	SignalFmtParams *signalfmt.FormatParams
 	MatrixFmtParams *matrixfmt.HTMLParser
 
-	MaxFileSize    int64
-	LocationFormat string
+	MaxFileSize       int64
+	LocationFormat    string
+	DisappearViewOnce bool
 }
 
-func NewMessageConverter(br *bridgev2.Bridge, locationFormat string) *MessageConverter {
+func NewMessageConverter(br *bridgev2.Bridge) *MessageConverter {
 	return &MessageConverter{
 		Bridge: br,
 		SignalFmtParams: &signalfmt.FormatParams{
@@ -89,8 +90,7 @@ func NewMessageConverter(br *bridgev2.Bridge, locationFormat string) *MessageCon
 				return uuid.Nil
 			},
 		},
-		MaxFileSize:    50 * 1024 * 1024,
-		LocationFormat: locationFormat,
+		MaxFileSize: 50 * 1024 * 1024,
 	}
 }