Add keep-alive support for a more persistent connection

.gitattributes

@@ -1,2 +1 @@
-html/* linguist-vendored
-html/kyros linguist-vendored
+html/kyros/* linguist-vendored

README.md

@@ -3,10 +3,10 @@ Kyros, for now, is a Python interface to communicate easier with WhatsApp Web AP
 It provides an interface to connect and communicate with WhatsApp Web's websocket server.
 Kyros will handle encryption and decryption kind of things.
 In the future, Kyros is aimed to provide a full implementation of WhatsApp Web API which will give developers
-a clean interface to work with (more or less like ![go-whatsapp](https://github.com/Rhymen/go-whatsapp)).
+a clean interface to work with (more or less like [go-whatsapp](https://github.com/Rhymen/go-whatsapp)).
 This module is designed to work with Python 3.6 or latest.
-Special thanks to the creator of ![whatsapp-web-reveng](https://github.com/sigalor/whatsapp-web-reveng)
-and ![go-whatsapp](https://github.com/Rhymen/go-whatsapp). This project is largely motivated by their work.
+Special thanks to the creator of [whatsapp-web-reveng](https://github.com/sigalor/whatsapp-web-reveng)
+and [go-whatsapp](https://github.com/Rhymen/go-whatsapp). This project is largely motivated by their work.
 Please note that Kyros is not meant to be used actively in production servers as it is currently not 
 production ready. Use it at your own risk.
 
@@ -25,7 +25,7 @@ import logging
 
 import pyqrcode
 
-from kyros import Client, WebsocketMessage
+import kyros
 
 logging.basicConfig()
 # set a logging level: just to know if something (bad?) happens
@@ -61,7 +61,7 @@ async def main():
 if __name__ == "__main__":
  asyncio.run(main())
 ```
-A "much more detailed documentation" kind of thing for this project is available ![here](https://p4kl0nc4t.github.io/kyros/).
+A "much more detailed documentation" kind of thing for this project is available [here](https://p4kl0nc4t.github.io/kyros/).
 You will see a piece of nightmare, happy exploring! Better documentation are being planned.
 
 ## Contribution

dev-requirements.txt

@@ -24,7 +24,7 @@ pylint-django==2.0.12
 pylint-flask==0.6
 pylint-plugin-utils==0.6
 PyQRCode==1.2.1
-PyYAML==5.3.1
+PyYAML==5.4
 regex==2020.4.4
 requirements-detector==0.6
 rope==0.16.0
@@ -34,6 +34,6 @@ snowballstemmer==2.0.0
 toml==0.10.0
 typed-ast==1.4.1
 websocket-client==0.57.0
-websockets==8.1
+websockets==9.1
 wrapt==1.11.2
 yapf==0.30.0

kyros/client.py

@@ -125,6 +125,9 @@ async def wait_qr_scan():
  self.session.enc_key = self.session.keys_decrypted[:32]
  self.session.mac_key = self.session.keys_decrypted[32:64]
 
+ # First call of keep alive after session initialized
+ await self.websocket.keepAlive()
+
  qr_fragments = [
  self.session.server_id,
  base64.b64encode(self.session.public_key.public).decode(),
@@ -184,6 +187,9 @@ async def restore():
  self.session.server_token = info["serverToken"]
 
  self.websocket.load_session(self.session) # reload references
+
+ # First call of keep alive after session reloaded
+ await self.websocket.keepAlive()
  return self.session
 
  try:

kyros/dev-requirements.txt

@@ -43,7 +43,7 @@ pylint-django==2.0.12
 pylint-flask==0.6
 pylint-plugin-utils==0.6
 PyQRCode==1.2.1
-PyYAML==5.3.1
+PyYAML==5.4
 regex==2020.4.4
 requirements-detector==0.6
 rope==0.16.0
@@ -56,7 +56,7 @@ typed-ast==1.4.1
 typing==3.7.4.1
 watchdog==0.10.2
 websocket-client==0.57.0
-websockets==8.1
+websockets==9.1
 wrapt==1.11.2
 yapf==0.30.0
 zipp==3.1.0

kyros/websocket.py

@@ -13,6 +13,18 @@
 
 logger = logging.getLogger(__name__) # pylint: disable=invalid-name
 
+class Timer:
+ def __init__(self, timeout, callback):
+ self._timeout = timeout
+ self._callback = callback
+ self._task = asyncio.ensure_future(self._job())
+
+ async def _job(self):
+ await asyncio.sleep(self._timeout)
+ await self._callback()
+
+ def cancel(self):
+ self._task.cancel()
 
 class WebsocketMessage:
  """
@@ -142,10 +154,16 @@ async def connect(self) -> None:
  listener."""
  logger.debug("Connecting to ws server")
  self.websocket = await websockets.connect(
- constants.WEBSOCKET_URI, origin=constants.WEBSOCKET_ORIGIN)
+ constants.WEBSOCKET_URI, origin=constants.WEBSOCKET_ORIGIN, close_timeout = None,ping_interval = None)
  logger.debug("Websocket connected")
  self._start_receiver()
 
+ async def keepAlive(self):
+ if self.websocket and self.websocket.open:
+ await self.websocket.send('?,,')
+ # Send keepalive every 10 seconds
+ Timer(10.0, self.keepAlive)
+
  def load_session(self, session: Session) -> None:
  """Loads a session. This will make sure that all references are
  updated. If there is a key change, the new key will be used to
@@ -177,6 +195,11 @@ async def receiver():
  continue
 
  raw_message = self.websocket.messages.pop()
+
+ # Ignore server timestamp responses
+ if raw_message[:1] == "!":
+ continue
+
  try:
  message = WebsocketMessage.unserialize(
  raw_message, self.get_keys())