9578053 Jan 22 2022 distfiles.gentoo.org/distfiles/gajim-1.3.3-2.tar.gz

gajim/common/modules/ping.py

@@ -0,0 +1,82 @@
+# This file is part of Gajim.
+#
+# Gajim is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published
+# by the Free Software Foundation; version 3 only.
+#
+# Gajim is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Gajim.  If not, see <http://www.gnu.org/licenses/>.
+
+# XEP-0199: XMPP Ping
+
+from typing import Any
+from typing import Tuple
+from typing import Generator
+
+import time
+
+from nbxmpp.errors import is_error
+
+from gajim.common import app
+from gajim.common.nec import NetworkEvent
+from gajim.common.types import ConnectionT
+from gajim.common.types import ContactsT
+from gajim.common.modules.base import BaseModule
+from gajim.common.modules.util import as_task
+
+
+class Ping(BaseModule):
+
+    _nbxmpp_extends = 'Ping'
+    _nbxmpp_methods = [
+        'ping',
+    ]
+
+    def __init__(self, con: ConnectionT) -> None:
+        BaseModule.__init__(self, con)
+
+        self.handlers = []
+
+    @as_task
+    def send_ping(self, contact: ContactsT) -> Generator:
+        _task = yield
+
+        if not app.account_is_available(self._account):
+            return
+
+        jid = contact.get_full_jid()
+
+        self._log.info('Send ping to %s', jid)
+
+        app.nec.push_incoming_event(NetworkEvent('ping-sent',
+                                                 account=self._account,
+                                                 contact=contact))
+
+        ping_time = time.time()
+
+        response = yield self.ping(jid, timeout=10)
+        if is_error(response):
+            app.nec.push_incoming_event(NetworkEvent(
+                'ping-error',
+                account=self._account,
+                contact=contact,
+                error=str(response)))
+            return
+
+        diff = round(time.time() - ping_time, 2)
+        self._log.info('Received pong from %s after %s seconds',
+                       response.jid, diff)
+
+        app.nec.push_incoming_event(NetworkEvent('ping-reply',
+                                                 account=self._account,
+                                                 contact=contact,
+                                                 seconds=diff))
+
+
+def get_instance(*args: Any, **kwargs: Any) -> Tuple[Ping, str]:
+    return Ping(*args, **kwargs), 'Ping'