Coverage for slidge / slixfix / delivery_receipt.py: 100%

1""" 

2XEP-0184 Delivery Receipts 

3 

4The corresponding slixmpp module is a bit too rigid, this is our implementation 

5to selectively choose when we send delivery receipts 

6""" 

7 

8from typing import Generic, TypeVar 

9 

10from slixmpp import JID, Message 

11from slixmpp.types import MessageTypes 

12 

13GatewayType = TypeVar("GatewayType") 

14 

15 

16class DeliveryReceipt(Generic[GatewayType]): 

17 xmpp: GatewayType 

18 

19 def __init__(self, xmpp: GatewayType) -> None: 

20 self.xmpp = xmpp 

21 

22 def ack(self, msg: Message) -> None: 

23 """ 

24 Send a XEP-0184 (delivery receipt) in response to a message, 

25 if appropriate. 

26 

27 :param msg: 

28 """ 

29 if not self.requires_receipt(msg): 

30 return 

31 ack = self.make_ack(msg["id"], msg["to"], msg["from"].bare, msg["type"]) 

32 ack.send() 

33 

34 def make_ack( 

35 self, msg_id: str, mfrom: JID, mto: JID, mtype: MessageTypes = "chat" 

36 ) -> Message: 

37 ack = self.xmpp.Message() 

38 ack["type"] = mtype 

39 ack["to"] = mto 

40 ack["from"] = mfrom 

41 ack["receipt"] = msg_id 

42 return ack 

43 

44 def requires_receipt(self, msg: Message) -> bool: 

45 """ 

46 Check if a message is eligible for a delivery receipt. 

47 

48 :param msg: 

49 :return: 

50 """ 

51 return ( 

52 msg["request_receipt"] 

53 and msg["type"] in self.xmpp.plugin["xep_0184"].ack_types 

54 and not msg["receipt"] 

55 )