libervia-backend: libervia/backend/plugins/plugin_xep

comparison libervia/backend/plugins/plugin_xep_0424.py @ 4166:a1f7040b5a15

plugin XEP-0424: message retraction update: - follow specification update (with namespace bump) - retract from history on message reception for group chat - send bridge message

author	Goffi <goffi@goffi.org>
date	Thu, 30 Nov 2023 13:23:53 +0100
parents	4b842c1fb686
children	7eda7cb8a15c

comparison

equal deleted inserted replaced

-:81faa85c9cfa
+:a1f7040b5a15
 # GNU Affero General Public License for more details.
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
-from typing import Dict, Any
 import time
-from copy import deepcopy
+from typing import Any, Dict
-from twisted.words.protocols.jabber import xmlstream, jid
+from sqlalchemy.orm.attributes import flag_modified
+from twisted.internet import defer
+from twisted.words.protocols.jabber import jid, xmlstream
 from twisted.words.xish import domish
-from twisted.internet import defer
 from wokkel import disco
 from zope.interface import implementer
+from libervia.backend.core import exceptions
 from libervia.backend.core.constants import Const as C
-from libervia.backend.core.i18n import _, D_
+from libervia.backend.core.core_types import MessageData, SatXMPPEntity
-from libervia.backend.core import exceptions
+from libervia.backend.core.i18n import D_, _
-from libervia.backend.core.core_types import SatXMPPEntity
 from libervia.backend.core.log import getLogger
 from libervia.backend.memory.sqla_mapping import History
+from libervia.backend.tools.common import data_format
 log = getLogger(__name__)
 PLUGIN_INFO = {
 C.PI_NAME: "Message Retraction",
 C.PI_IMPORT_NAME: "XEP-0424",
 C.PI_TYPE: "XEP",
 C.PI_MODES: C.PLUG_MODE_BOTH,
-C.PI_PROTOCOLS: ["XEP-0334", "XEP-0424", "XEP-0428"],
+C.PI_PROTOCOLS: ["XEP-0424"],
-C.PI_DEPENDENCIES: ["XEP-0422"],
+C.PI_DEPENDENCIES: ["XEP-0334", "XEP-0428"],
 C.PI_MAIN: "XEP_0424",
 C.PI_HANDLER: "yes",
 C.PI_DESCRIPTION: _("""Implementation Message Retraction"""),
 }
-NS_MESSAGE_RETRACT = "urn:xmpp:message-retract:0"
+NS_MESSAGE_RETRACT = "urn:xmpp:message-retract:1"
 CATEGORY = "Privacy"
 NAME = "retract_history"
 LABEL = D_("Keep History of Retracted Messages")
 PARAMS = """
 """.format(
 category_name=CATEGORY, name=NAME, label=_(LABEL)
 )
-class XEP_0424(object):
+class XEP_0424:
 def __init__(self, host):
-log.info(_("XEP-0424 (Message Retraction) plugin initialization"))
+log.info(f"plugin {PLUGIN_INFO[C.PI_NAME]!r} initialization")
 self.host = host
 host.memory.update_params(PARAMS)
 self._h = host.plugins["XEP-0334"]
-self._f = host.plugins["XEP-0422"]
 host.register_namespace("message-retract", NS_MESSAGE_RETRACT)
 host.trigger.add("message_received", self._message_received_trigger, 100)
 host.bridge.add_method(
 "message_retract",
 ".plugin",
 )
 def retract_by_origin_id(
 self,
 client: SatXMPPEntity,
-dest_jid: jid.JID,
+peer_jid: jid.JID,
 origin_id: str
 ) -> None:
 """Send a message retraction using origin-id
 [retract] should be prefered: internal ID should be used as it is independant of
 (notably for some components), and then this method can be used
 @param origin_id: origin-id as specified in XEP-0359
 """
 message_elt = domish.Element((None, "message"))
 message_elt["from"] = client.jid.full()
-message_elt["to"] = dest_jid.full()
+message_elt["to"] = peer_jid.full()
-apply_to_elt = self._f.apply_to_elt(message_elt, origin_id)
+retract_elt = message_elt.addElement((NS_MESSAGE_RETRACT, "retract"))
-apply_to_elt.addElement((NS_MESSAGE_RETRACT, "retract"))
+retract_elt["id"] = origin_id
 self.host.plugins["XEP-0428"].add_fallback_elt(
 message_elt,
 "[A message retraction has been requested, but your client doesn't support "
 "it]"
 )
 raise exceptions.FeatureNotFound(
 f"message to retract doesn't have the necessary origin-id, the sending "
 "client is probably not supporting message retraction."
 )
 else:
-self.retract_by_origin_id(client, history.dest_jid, origin_id)
+if history.type == C.MESS_TYPE_GROUPCHAT:
-await self.retract_db_history(client, history)
+is_group_chat = True
+peer_jid = history.dest_jid
+else:
+is_group_chat = False
+peer_jid = jid.JID(history.dest)
+self.retract_by_origin_id(client, peer_jid, origin_id)
+if not is_group_chat:
+# retraction will happen when <retract> message will be received in the
+# chat.
+await self.retract_db_history(client, history)
 async def retract(
 self,
 client: SatXMPPEntity,
 message_id: str,
 """
 if not message_id:
 raise ValueError("message_id can't be empty")
 history = await self.host.memory.storage.get(
 client, History, History.uid, message_id,
-joined_loads=[History.messages, History.subjects]
+joined_loads=[History.messages, History.subjects, History.thread]
 )
 if history is None:
 raise exceptions.NotFound(
 f"message to retract not found in database ({message_id})"
 )
 """Mark an history instance in database as retracted
 @param history: history instance
 "messages" and "subjects" must be loaded too
 """
-# FIXME: should be keep history? This is useful to check why a message has been
+# FIXME: should we keep history? This is useful to check why a message has been
 #   retracted, but if may be bad if the user think it's really deleted
-# we assign a new object to be sure to trigger an update
+flag_modified(history, "extra")
-history.extra = deepcopy(history.extra) if history.extra else {}
+keep_history = await self.host.memory.param_get_a_async(
-history.extra["retracted"] = True
-keep_history = self.host.memory.param_get_a(
 NAME, CATEGORY, profile_key=client.profile
 )
 old_version: Dict[str, Any] = {
 "timestamp": time.time()
 }
 if keep_history:
 old_version.update({
 "messages": [m.serialise() for m in history.messages],
-"subjects": [s.serialise() for s in history.subjects]
+"subjects": [s.serialise() for s in history.subjects],
 })
 history.extra.setdefault("old_versions", []).append(old_version)
-await self.host.memory.storage.delete(
-history.messages + history.subjects,
+history.messages.clear()
-session_add=[history]
+history.subjects.clear()
+history.extra["retracted"] = True
+# we remove editions history to keep no trace of old messages
+if "editions" in history.extra:
+del history.extra["editions"]
+if "attachments" in history.extra:
+del history.extra["attachments"]
+await self.host.memory.storage.add(history)
+retract_data = MessageData(history.serialise())
+self.host.bridge.message_update(
+history.uid,
+C.MESS_UPDATE_RETRACT,
+data_format.serialise(retract_data),
+client.profile,
 )
 async def _message_received_trigger(
 self,
 client: SatXMPPEntity,
 message_elt: domish.Element,
 post_treat: defer.Deferred
 ) -> bool:
-fastened_elts = await self._f.get_fastened_elts(client, message_elt)
+retract_elt = next(message_elt.elements(NS_MESSAGE_RETRACT, "retract"), None)
-if fastened_elts is None:
+if not retract_elt:
 return True
-for elt in fastened_elts.elements:
+try:
-if elt.name == "retract" and elt.uri == NS_MESSAGE_RETRACT:
+if message_elt.getAttribute("type") == C.MESS_TYPE_GROUPCHAT:
-if fastened_elts.history is not None:
+col_id = History.stanza_id
-source_jid = fastened_elts.history.source_jid
+else:
-from_jid = jid.JID(message_elt["from"])
+col_id = History.origin_id
-if source_jid.userhostJID() != from_jid.userhostJID():
+history = await self.host.memory.storage.get(
-log.warning(
+client, History, col_id, retract_elt["id"],
-f"Received message retraction from {from_jid.full()}, but "
+joined_loads=[History.messages, History.subjects, History.thread]
-f"the message to retract is from {source_jid.full()}. This "
+)
-f"maybe a hack attempt.\n{message_elt.toXml()}"
+except KeyError:
-)
+log.warning(f"invalid retract element, missing id: {retract_elt.toXml()}")
 return False
-break
+from_jid = jid.JID(message_elt["from"])
-else:
-return True
+if (
+history is not None
+and history.source_jid.userhostJID() != from_jid.userhostJID()
+):
+log.warning(
+f"Received message retraction from {from_jid.full()}, but the message to "
+f"retract is from {history.source_jid.full()}. This maybe a hack "
+f"attempt.\n{message_elt.toXml()}"
+)
+return False
 if not await self.host.trigger.async_point(
-"XEP-0424_retractReceived", client, message_elt, elt, fastened_elts
+"XEP-0424_retract_received", client, message_elt, retract_elt, history
 ):
 return False
-if fastened_elts.history is None:
+if history is None:
 # we check history after the trigger because we may be in a component which
 # doesn't store messages in database.
 log.warning(
 f"No message found with given origin-id: {message_elt.toXml()}"
 )
 return False
-log.info(f"[{client.profile}] retracting message {fastened_elts.id!r}")
+log.info(f"[{client.profile}] retracting message {history.uid!r}")
-await self.retract_db_history(client, fastened_elts.history)
+await self.retract_db_history(client, history)
-# TODO: send bridge signal
 return False
 @implementer(disco.IDisco)
 class XEP_0424_handler(xmlstream.XMPPHandler):

Mercurial > libervia-backend

comparison libervia/backend/plugins/plugin_xep_0424.py @ 4166:a1f7040b5a15