slidge-whatsapp 0.2.5__cp311-cp311-manylinux_2_36_x86_64.whl → 0.2.7__cp311-cp311-manylinux_2_36_x86_64.whl

slidge_whatsapp/config.py

@@ -21,6 +21,9 @@ DB_PATH__DOC = (
     "${SLIDGE_HOME_DIR}/whatsapp/whatsapp.db"
 )
 
+DB_PARAMS = "?_foreign_keys=true"
+DB_PARAMS__DOC = "Additional parameters to pass to database connection string."
+
 ALWAYS_SYNC_ROSTER = False
 ALWAYS_SYNC_ROSTER__DOC = (
     "Whether or not to perform a full sync of the WhatsApp roster on startup."

slidge_whatsapp/event.go

@@ -5,6 +5,7 @@ import (
 	"context"
 	"fmt"
 	"mime"
+	"slices"
 	"strings"
 
 	// Internal packages.
@@ -255,6 +256,7 @@ type Album struct {
 func newMessageEvent(client *whatsmeow.Client, evt *events.Message) (EventKind, *EventPayload) {
 	// Set basic data for message, to be potentially amended depending on the concrete version of
 	// the underlying message.
+	var ctx = context.Background()
 	var message = Message{
 		Kind:      MessagePlain,
 		ID:        evt.Info.ID,
@@ -358,7 +360,7 @@ func newMessageEvent(client *whatsmeow.Client, evt *events.Message) (EventKind,
 	}
 
 	// Handle message attachments, if any.
-	if attach, context, err := getMessageAttachments(client, evt.Message); err != nil {
+	if attach, context, err := getMessageAttachments(ctx, client, evt.Message); err != nil {
 		client.Log.Errorf("Failed getting message attachments: %s", err)
 		return EventUnknown, nil
 	} else if len(attach) > 0 {
@@ -412,7 +414,7 @@ func getMessageWithContext(message Message, info *waE2E.ContextInfo) Message {
 
 // GetMessageAttachments fetches and decrypts attachments (images, audio, video, or documents) sent
 // via WhatsApp. Any failures in retrieving any attachment will return an error immediately.
-func getMessageAttachments(client *whatsmeow.Client, message *waE2E.Message) ([]Attachment, *waE2E.ContextInfo, error) {
+func getMessageAttachments(ctx context.Context, client *whatsmeow.Client, message *waE2E.Message) ([]Attachment, *waE2E.ContextInfo, error) {
 	var result []Attachment
 	var info *waE2E.ContextInfo
 	var convertSpec *media.Spec
@@ -450,7 +452,7 @@ func getMessageAttachments(client *whatsmeow.Client, message *waE2E.Message) ([]
 		}
 
 		// Attempt to download and decrypt raw attachment data, if any.
-		data, err := client.Download(msg)
+		data, err := client.Download(ctx, msg)
 		if err != nil {
 			return nil, nil, err
 		}
@@ -459,8 +461,10 @@ func getMessageAttachments(client *whatsmeow.Client, message *waE2E.Message) ([]
 
 		// Convert incoming data if a specification has been given, ignoring any errors that occur.
 		if convertSpec != nil {
-			data, err = media.Convert(context.Background(), a.Data, convertSpec)
-			if err == nil {
+			data, err = media.Convert(ctx, a.Data, convertSpec)
+			if err != nil {
+				client.Log.Warnf("failed to convert incoming attachment: %s", err)
+			} else {
 				a.Data, a.MIME = data, string(convertSpec.MIME)
 			}
 		}
@@ -557,7 +561,7 @@ var (
 //
 // If the input MIME type is unknown, or conversion is impossible, the given attachment is not
 // changed.
-func convertAttachment(attach *Attachment) error {
+func convertAttachment(ctx context.Context, attach *Attachment) error {
 	var detectedMIME media.MIMEType
 	if t := media.DetectMIMEType(attach.Data); t != media.TypeUnknown {
 		detectedMIME = t
@@ -567,8 +571,6 @@ func convertAttachment(attach *Attachment) error {
 	}
 
 	var spec media.Spec
-	var ctx = context.Background()
-
 	switch detectedMIME {
 	case media.TypePNG, media.TypeWebP:
 		// Convert common image formats to JPEG for inline preview.
@@ -648,6 +650,10 @@ func convertAttachment(attach *Attachment) error {
 	}
 
 	attach.Data, attach.MIME = data, string(spec.MIME)
+	if i := strings.LastIndexByte(attach.Filename, '.'); i != -1 {
+		attach.Filename = attach.Filename[:i] + extensionByType(attach.MIME)
+	}
+
 	return nil
 }
 
@@ -666,12 +672,10 @@ var knownMediaTypes = map[string]whatsmeow.MediaType{
 // type specified within. Attachments are handled as generic file uploads unless they're of a
 // specific format; in addition, certain MIME types may be automatically converted to a
 // well-supported type via FFmpeg (if available).
-func uploadAttachment(client *whatsmeow.Client, attach *Attachment) (*waE2E.Message, error) {
-	var ctx = context.Background()
+func uploadAttachment(ctx context.Context, client *whatsmeow.Client, attach *Attachment) (*waE2E.Message, error) {
 	var originalMIME = attach.MIME
-
-	if err := convertAttachment(attach); err != nil {
-		client.Log.Warnf("failed to auto-convert attachment: %s", err)
+	if err := convertAttachment(ctx, attach); err != nil {
+		client.Log.Warnf("failed to convert outgoing attachment: %s", err)
 	}
 
 	mediaType := knownMediaTypes[getBaseMediaType(attach.MIME)]
@@ -836,6 +840,7 @@ func getBaseMediaType(typ string) string {
 func newEventFromHistory(client *whatsmeow.Client, info *waWeb.WebMessageInfo) (EventKind, *EventPayload) {
 	// Handle message as group message is remote JID is a group JID in the absence of any other,
 	// specific signal, or don't handle at all if no group JID is found.
+	var ctx = context.Background()
 	var jid = info.GetKey().GetRemoteJID()
 	if j, _ := types.ParseJID(jid); j.Server != types.GroupServer {
 		return EventUnknown, nil
@@ -898,7 +903,7 @@ func newEventFromHistory(client *whatsmeow.Client, info *waWeb.WebMessageInfo) (
 	}
 
 	// Handle message attachments, if any.
-	if attach, context, err := getMessageAttachments(client, info.GetMessage()); err != nil {
+	if attach, context, err := getMessageAttachments(ctx, client, info.GetMessage()); err != nil {
 		client.Log.Errorf("Failed getting message attachments: %s", err)
 		return EventUnknown, nil
 	} else if len(attach) > 0 {
@@ -967,9 +972,9 @@ type ChatState struct {
 // NewChatStateEvent returns event data meant for [Session.propagateEvent] for the primitive
 // chat-state event given.
 func newChatStateEvent(evt *events.ChatPresence) (EventKind, *EventPayload) {
-	var state = ChatState{JID: evt.MessageSource.Sender.ToNonAD().String()}
-	if evt.MessageSource.IsGroup {
-		state.GroupJID = evt.MessageSource.Chat.ToNonAD().String()
+	var state = ChatState{JID: evt.Sender.ToNonAD().String()}
+	if evt.IsGroup {
+		state.GroupJID = evt.Chat.ToNonAD().String()
 	}
 	switch evt.State {
 	case types.ChatPresenceComposing:
@@ -1006,22 +1011,22 @@ type Receipt struct {
 // event given. Unknown or invalid receipts will return an [EventUnknown] event with nil data.
 func newReceiptEvent(evt *events.Receipt) (EventKind, *EventPayload) {
 	var receipt = Receipt{
-		MessageIDs: append([]string{}, evt.MessageIDs...),
-		JID:        evt.MessageSource.Sender.ToNonAD().String(),
+		MessageIDs: slices.Clone(evt.MessageIDs),
+		JID:        evt.Sender.ToNonAD().String(),
 		Timestamp:  evt.Timestamp.Unix(),
-		IsCarbon:   evt.MessageSource.IsFromMe,
+		IsCarbon:   evt.IsFromMe,
 	}
 
 	if len(receipt.MessageIDs) == 0 {
 		return EventUnknown, nil
 	}
 
-	if evt.MessageSource.Chat.Server == types.BroadcastServer {
-		receipt.JID = evt.MessageSource.BroadcastListOwner.ToNonAD().String()
-	} else if evt.MessageSource.IsGroup {
-		receipt.GroupJID = evt.MessageSource.Chat.ToNonAD().String()
+	if evt.Chat.Server == types.BroadcastServer {
+		receipt.JID = evt.BroadcastListOwner.ToNonAD().String()
+	} else if evt.IsGroup {
+		receipt.GroupJID = evt.Chat.ToNonAD().String()
 	} else if receipt.IsCarbon {
-		receipt.JID = evt.MessageSource.Chat.ToNonAD().String()
+		receipt.JID = evt.Chat.ToNonAD().String()
 	}
 
 	switch evt.Type {
@@ -1176,7 +1181,7 @@ func newGroup(client *whatsmeow.Client, info *types.GroupInfo) Group {
 	}
 	return Group{
 		JID:  info.JID.ToNonAD().String(),
-		Name: info.GroupName.Name,
+		Name: info.Name,
 		Subject: GroupSubject{
 			Subject:  info.Topic,
 			SetAt:    info.TopicSetAt.Unix(),

slidge_whatsapp/gateway.go

@@ -2,6 +2,7 @@ package whatsapp
 
 import (
 	// Standard library.
+	"context"
 	"fmt"
 	"log/slog"
 	"os"
@@ -69,7 +70,7 @@ func (w *Gateway) Init() error {
 		),
 	}
 
-	container, err := sqlstore.New("sqlite3", w.DBPath, w.logger)
+	container, err := sqlstore.New(context.Background(), "sqlite3", w.DBPath, w.logger)
 	if err != nil {
 		return err
 	}
@@ -79,7 +80,9 @@ func (w *Gateway) Init() error {
 	}
 
 	if w.TempDir != "" {
-		media.SetTempDirectory(w.TempDir)
+		if err := media.SetTempDirectory(w.TempDir); err != nil {
+			return err
+		}
 	}
 
 	w.callChan = make(chan func(), maxConcurrentGatewayCalls)
@@ -107,7 +110,8 @@ func (w *Gateway) NewSession(device LinkedDevice) *Session {
 // CleanupSession will remove all invalid and obsolete references to the given device, and should be
 // used when pairing a new device or unregistering from the Gateway.
 func (w *Gateway) CleanupSession(device LinkedDevice) error {
-	devices, err := w.container.GetAllDevices()
+	ctx := context.Background()
+	devices, err := w.container.GetAllDevices(ctx)
 	if err != nil {
 		return err
 	}
@@ -115,11 +119,11 @@ func (w *Gateway) CleanupSession(device LinkedDevice) error {
 	for _, d := range devices {
 		if d.ID == nil {
 			w.logger.Infof("Removing invalid device %s from database", d.ID.String())
-			_ = d.Delete()
+			_ = d.Delete(ctx)
 		} else if device.ID != "" {
 			if jid := device.JID(); d.ID.ToNonAD() == jid.ToNonAD() && *d.ID != jid {
 				w.logger.Infof("Removing obsolete device %s from database", d.ID.String())
-				_ = d.Delete()
+				_ = d.Delete(ctx)
 			}
 		}
 	}
@@ -156,22 +160,22 @@ type logger struct {
 var _ walog.Logger = logger{}
 
 // Errorf handles the given message as representing a (typically) fatal error.
-func (l logger) Errorf(msg string, args ...interface{}) {
+func (l logger) Errorf(msg string, args ...any) {
 	l.logger.Error(fmt.Sprintf(msg, args...))
 }
 
 // Warn handles the given message as representing a non-fatal error or warning thereof.
-func (l logger) Warnf(msg string, args ...interface{}) {
+func (l logger) Warnf(msg string, args ...any) {
 	l.logger.Warn(fmt.Sprintf(msg, args...))
 }
 
 // Infof handles the given message as representing an informational notice.
-func (l logger) Infof(msg string, args ...interface{}) {
+func (l logger) Infof(msg string, args ...any) {
 	l.logger.Info(fmt.Sprintf(msg, args...))
 }
 
 // Debugf handles the given message as representing an internal-only debug message.
-func (l logger) Debugf(msg string, args ...interface{}) {
+func (l logger) Debugf(msg string, args ...any) {
 	l.logger.Debug(fmt.Sprintf(msg, args...))
 }
 

slidge_whatsapp/gateway.py

@@ -13,7 +13,7 @@ if TYPE_CHECKING:
 REGISTRATION_INSTRUCTIONS = (
     "Continue and scan the resulting QR codes on your main device, or alternatively, "
     "use the 'pair-phone' command to complete registration. More information at "
-    "https://slidge.im/slidge-whatsapp/user.html"
+    "https://slidge.im/docs/slidge-whatsapp/main/user/registration.html"
 )
 
 WELCOME_MESSAGE = (
@@ -49,7 +49,7 @@ class Gateway(BaseGateway):
 
         assert config.DB_PATH is not None
         Path(config.DB_PATH.parent).mkdir(exist_ok=True)
-        self.whatsapp.DBPath = str(config.DB_PATH)
+        self.whatsapp.DBPath = str(config.DB_PATH) + config.DB_PARAMS
 
         (global_config.HOME_DIR / "tmp").mkdir(exist_ok=True)
         self.whatsapp.TempDir = str(global_config.HOME_DIR / "tmp")