Mercurial > libervia-web
changeset 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 | 759fd7386e1e |
children | f3a5a094c8d6 |
files | browser_side/panels.py browser_side/plugin_xep_0085.py libervia.py |
diffstat | 3 files changed, 88 insertions(+), 2 deletions(-) [+] |
line wrap: on
line diff
--- a/browser_side/panels.py Sun Sep 22 20:52:59 2013 +0200 +++ b/browser_side/panels.py Thu Sep 26 11:13:40 2013 +0200 @@ -45,6 +45,7 @@ from time import time import dialog import base_widget +from plugin_xep_0085 import ChatStateMachine from pyjamas import Window from __pyjamas__ import doc @@ -212,8 +213,7 @@ def __onComposing(self): """Callback when the user is composing a text.""" if hasattr(self._selected_cache, "target"): - target_s = str(self._selected_cache.target) - self.host.bridge.call('chatStateComposing', None, target_s) + self._selected_cache.state_machine._onEvent("composing") def onMouseUp(self, sender, x, y): size = (self.getOffsetWidth(), self.getOffsetHeight()) @@ -605,6 +605,7 @@ self.vpanel.add(self.__body) self.addStyleName('chatPanel') self.setWidget(self.vpanel) + self.state_machine = ChatStateMachine(self.host, str(self.target)) """def doDetachChildren(self): #We need to force the use of a panel subclass method here, @@ -640,6 +641,7 @@ def onTextEntered(self, text): mess_type = "groupchat" if self.type == 'group' else "chat" self.host.bridge.call('sendMessage', None, str(self.target), text, '', mess_type) + self.state_machine._onEvent("active") def onQuit(self): base_widget.LiberviaWidget.onQuit(self)
--- /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)
--- a/libervia.py Sun Sep 22 20:52:59 2013 +0200 +++ b/libervia.py Thu Sep 26 11:13:40 2013 +0200 @@ -583,6 +583,8 @@ lib_wid.setTitle(win_from + " (" + state + ")") else: lib_wid.setTitle(win_from) + # start to send "composing" state from now + lib_wid.state_machine.started = True elif (lib_wid.type == 'group'): # TODO: chat state notification for groupchat pass