diff browser_side/plugin_xep_0085.py @ 223:624a87377412

browser_side, plugin XEP-0085: limit the number of bridge methods calls for "chatStateComposing".
author souliane <souliane@mailoo.org>
date Thu, 26 Sep 2013 11:13:40 +0200
parents
children ce5b33f499c5
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/browser_side/plugin_xep_0085.py	Thu Sep 26 11:13:40 2013 +0200
@@ -0,0 +1,82 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# SAT plugin for Chat State Notifications Protocol (xep-0085)
+# Copyright (C) 2013 Adrien Cossa (souliane@mailoo.org)
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program 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 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 pyjamas.Timer import Timer
+
+
+# Copy of the map from sat/src/plugins/plugin_xep_0085
+TRANSITIONS = {"active": {"next_state": "inactive", "delay": 120},
+               "inactive": {"next_state": "gone", "delay": 480},
+               "gone": {"next_state": "", "delay": 0},
+               "composing": {"next_state": "paused", "delay": 30},
+               "paused": {"next_state": "inactive", "delay": 450}
+               }
+
+
+class ChatStateMachine:
+    """This is an adapted version of the ChatStateMachine from sat/src/plugins/plugin_xep_0085
+    which manage a timer on the web browser and keep it synchronized with the timer that runs
+    on the backend. This is only needed to avoid calling the bridge method chatStateComposing
+    too often ; accuracy is not needed so we can ignore the delay of the communication between
+    the web browser and the backend (the timer on the web browser always starts a bit before).
+    /!\ Keep this file up to date if you modify the one in the sat plugins directory.
+    """
+    def __init__(self, host, target_s):
+
+        self.host = host
+        self.target_s = target_s
+        self.started = False
+        self.state = None
+        self.timer = None
+
+    def _onEvent(self, state):
+        """Pyjamas callback takes no extra argument so we need this trick"""
+        # Here we should check the value of the parameter "Send chat state notifications"
+        # but this costs two messages. It's even better to call chatStateComposing
+        # with a doubt, it will be checked by the back-end anyway before sending
+        # the actual notifications to the other client.
+        if state == "composing" and not self.started:
+            return
+        self.started = True
+        self.next_state = state
+        self.__onEvent()
+
+    def __onEvent(self):
+        # print "on event %s" % self.next_state
+        state = self.next_state
+        self.next_state = ""
+        if state != self.state and state == "composing":
+            self.host.bridge.call('chatStateComposing', None, self.target_s)
+        self.state = state
+        if not self.timer is None:
+            self.timer.cancel()
+
+        if not state in TRANSITIONS:
+            return
+        if not "next_state" in TRANSITIONS[state]:
+            return
+        if not "delay" in TRANSITIONS[state]:
+            return
+        next_state = TRANSITIONS[state]["next_state"]
+        delay = TRANSITIONS[state]["delay"]
+        if next_state == "" or delay < 0:
+            return
+        self.next_state = next_state
+        # pyjamas timer in milliseconds
+        self.timer = Timer(delay * 1000, self.__onEvent)