gajim-plural/gajim/common/modules/ping.py

136 lines
4.3 KiB
Python
Raw Normal View History

2018-06-24 23:22:49 +02:00
# 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
2018-06-24 23:22:49 +02:00
import logging
import time
import nbxmpp
from gajim.common import app
from gajim.common.nec import NetworkIncomingEvent
from gajim.common.types import ConnectionT
from gajim.common.types import ContactsT
2018-06-24 23:22:49 +02:00
log = logging.getLogger('gajim.c.m.ping')
class Ping:
def __init__(self, con: ConnectionT) -> None:
2018-06-24 23:22:49 +02:00
self._con = con
self._account = con.name
self._alarm_time = None
self.handlers = [
('iq', self._answer_request, 'get', nbxmpp.NS_PING),
]
2018-09-11 22:25:55 +02:00
@staticmethod
2018-09-12 21:07:59 +02:00
def _get_ping_iq(to: str) -> nbxmpp.Iq:
2018-06-24 23:22:49 +02:00
iq = nbxmpp.Iq('get', to=to)
iq.addChild(name='ping', namespace=nbxmpp.NS_PING)
return iq
2018-09-12 21:07:59 +02:00
def send_keepalive_ping(self) -> None:
2018-06-24 23:22:49 +02:00
if not app.account_is_connected(self._account):
return
to = app.config.get_per('accounts', self._account, 'hostname')
self._con.connection.SendAndCallForResponse(self._get_ping_iq(to),
self._keepalive_received)
log.info('Send keepalive')
seconds = app.config.get_per('accounts', self._account,
'time_for_ping_alive_answer')
self._alarm_time = app.idlequeue.set_alarm(self._reconnect, seconds)
2018-09-12 21:07:59 +02:00
def _keepalive_received(self, _stanza: nbxmpp.Iq) -> None:
2018-06-24 23:22:49 +02:00
log.info('Received keepalive')
app.idlequeue.remove_alarm(self._reconnect, self._alarm_time)
2018-09-12 21:07:59 +02:00
def _reconnect(self) -> None:
2018-06-24 23:22:49 +02:00
if not app.config.get_per('accounts', self._account, 'active'):
# Account may have been disabled
return
# We haven't got the pong in time, disco and reconnect
log.warning('No reply received for keepalive ping. Reconnecting...')
self._con.disconnectedReconnCB()
def send_ping(self, contact: ContactsT) -> None:
2018-06-24 23:22:49 +02:00
if not app.account_is_connected(self._account):
return
to = contact.get_full_jid()
iq = self._get_ping_iq(to)
log.info('Send ping to %s', to)
self._con.connection.SendAndCallForResponse(
iq, self._pong_received, {'ping_time': time.time(),
'contact': contact})
app.nec.push_incoming_event(
PingSentEvent(None, conn=self._con, contact=contact))
def _pong_received(self,
_con: ConnectionT,
stanza: nbxmpp.Iq,
ping_time: int,
contact: ContactsT) -> None:
2018-06-24 23:22:49 +02:00
if not nbxmpp.isResultNode(stanza):
log.info('Error: %s', stanza.getError())
app.nec.push_incoming_event(
PingErrorEvent(None, conn=self._con, contact=contact))
return
diff = round(time.time() - ping_time, 2)
log.info('Received pong from %s after %s seconds',
stanza.getFrom(), diff)
app.nec.push_incoming_event(
PingReplyEvent(None, conn=self._con,
contact=contact,
seconds=diff))
def _answer_request(self,
_con: ConnectionT,
stanza: nbxmpp.Iq) -> None:
2018-06-24 23:22:49 +02:00
iq = stanza.buildReply('result')
2018-09-11 22:25:55 +02:00
ping = iq.getTag('ping')
if ping is not None:
iq.delChild(ping)
2018-06-24 23:22:49 +02:00
self._con.connection.send(iq)
log.info('Send pong to %s', stanza.getFrom())
raise nbxmpp.NodeProcessed
class PingSentEvent(NetworkIncomingEvent):
name = 'ping-sent'
class PingReplyEvent(NetworkIncomingEvent):
name = 'ping-reply'
class PingErrorEvent(NetworkIncomingEvent):
name = 'ping-error'
def get_instance(*args: Any, **kwargs: Any) -> Tuple[Ping, str]:
return Ping(*args, **kwargs), 'Ping'