libervia-backend: src/plugins/plugin_xep

annotate src/plugins/plugin_xep_0085.py @ 685:0b9bd47dffcd

primitivus, wix: auto-display MUC dialog after it has been joined: - a patch will follow to add a parameter for the user to choose between "always open", "never open" and "ask each time".

author	souliane <souliane@mailoo.org>
date	Mon, 28 Oct 2013 18:29:34 +0100
parents	8004c7d4aba7
children	0c84fb112d70

rev	line source
636 7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	1 #!/usr/bin/python
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	2 # -- coding: utf-8 --
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	3
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	4 # SAT plugin for Chat State Notifications Protocol (xep-0085)
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	5 # Copyright (C) 2009, 2010, 2011, 2012, 2013 Adrien Cossa (souliane@mailoo.org)
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	6
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	7 # This program is free software: you can redistribute it and/or modify
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	8 # it under the terms of the GNU Affero General Public License as published by
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	9 # the Free Software Foundation, either version 3 of the License, or
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	10 # (at your option) any later version.
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	11
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	12 # This program is distributed in the hope that it will be useful,
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	15 # GNU Affero General Public License for more details.
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	16
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	17 # You should have received a copy of the GNU Affero General Public License
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	19
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	20 from sat.core import exceptions
659 b6c22d9f593a plugin xep-0085: bug fix + improvement souliane <souliane@mailoo.org> parents: 654 diff changeset	21 from logging import info
636 7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	22 from wokkel import disco, iwokkel
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	23 from zope.interface import implements
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	24 from twisted.words.protocols.jabber.jid import JID
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	25 try:
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	26 from twisted.words.protocols.xmlstream import XMPPHandler
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	27 except ImportError:
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	28 from wokkel.subprotocols import XMPPHandler
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	29 from threading import Timer
660 69a8bfd266a5 core, plugins: fixed bad use of children instead of elements() for domish.Element instances. Goffi <goffi@goffi.org> parents: 659 diff changeset	30 from twisted.words.xish import domish
636 7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	31
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	32 NS_XMPP_CLIENT = "jabber:client"
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	33 NS_CHAT_STATES = "http://jabber.org/protocol/chatstates"
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	34 CHAT_STATES = ["active", "inactive", "gone", "composing", "paused"]
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	35 MESSAGE_TYPES = ["chat", "groupchat"]
643 262d9d9ad27a plugin XEP-0085: renamed category and parameter souliane <souliane@mailoo.org> parents: 636 diff changeset	36 PARAM_KEY = "Notifications"
262d9d9ad27a plugin XEP-0085: renamed category and parameter souliane <souliane@mailoo.org> parents: 636 diff changeset	37 PARAM_NAME = "Enable chat state notifications"
262d9d9ad27a plugin XEP-0085: renamed category and parameter souliane <souliane@mailoo.org> parents: 636 diff changeset	38 ENTITY_KEY = PARAM_KEY + "_" + PARAM_NAME
636 7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	39
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	40 PLUGIN_INFO = {
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	41 "name": "Chat State Notifications Protocol Plugin",
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	42 "import_name": "XEP-0085",
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	43 "type": "XEP",
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	44 "protocols": ["XEP-0085"],
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	45 "dependencies": [],
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	46 "main": "XEP_0085",
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	47 "handler": "yes",
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	48 "description": _("""Implementation of Chat State Notifications Protocol""")
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	49 }
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	50
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	51
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	52 # Describe the internal transitions that are triggered
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	53 # by a timer. Beside that, external transitions can be
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	54 # runned to target the states "active" or "composing".
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	55 # Delay is specified here in seconds.
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	56 TRANSITIONS = {
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	57 "active": {"next_state": "inactive", "delay": 120},
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	58 "inactive": {"next_state": "gone", "delay": 480},
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	59 "gone": {"next_state": "", "delay": 0},
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	60 "composing": {"next_state": "paused", "delay": 30},
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	61 "paused": {"next_state": "inactive", "delay": 450}
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	62 }
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	63
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	64
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	65 class UnknownChatStateException(Exception):
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	66 """
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	67 This error is raised when an unknown chat state is used.
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	68 """
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	69 pass
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	70
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	71
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	72 class XEP_0085(object):
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	73 """
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	74 Implementation for XEP 0085
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	75 """
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	76 params = """
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	77 <params>
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	78 <individual>
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	79 <category name="%(category_name)s" label="%(category_label)s">
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	80 <param name="%(param_name)s" label="%(param_label)s" value="true" type="bool" security="0"/>
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	81 </category>
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	82 </individual>
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	83 </params>
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	84 """ % {
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	85 'category_name': PARAM_KEY,
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	86 'category_label': _(PARAM_KEY),
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	87 'param_name': PARAM_NAME,
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	88 'param_label': _('Enable chat state notifications')
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	89 }
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	90
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	91 def __init__(self, host):
659 b6c22d9f593a plugin xep-0085: bug fix + improvement souliane <souliane@mailoo.org> parents: 654 diff changeset	92 info(_("Chat State Notifications plugin initialization"))
636 7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	93 self.host = host
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	94
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	95 # parameter value is retrieved before each use
662 4f747d7fde8c core: importParams renamed to updateParams: it now updates the parameter instead of appending children if it find an existing one. Goffi <goffi@goffi.org> parents: 660 diff changeset	96 host.memory.updateParams(self.params)
636 7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	97
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	98 # triggers from core
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	99 host.trigger.add("MessageReceived", self.messageReceivedTrigger)
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	100 host.trigger.add("sendMessageXml", self.sendMessageXmlTrigger)
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	101 host.trigger.add("paramUpdateTrigger", self.paramUpdateTrigger)
659 b6c22d9f593a plugin xep-0085: bug fix + improvement souliane <souliane@mailoo.org> parents: 654 diff changeset	102 # TODO: handle profile disconnection (free memory in entity data)
636 7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	103
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	104 # args: to_s (jid as string), profile
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	105 host.bridge.addMethod("chatStateComposing", ".plugin", in_sign='ss',
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	106 out_sign='', method=self.chatStateComposing)
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	107
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	108 # args: from (jid as string), state in CHAT_STATES, profile
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	109 host.bridge.addSignal("chatStateReceived", ".plugin", signature='sss')
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	110
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	111 def getHandler(self, profile):
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	112 return XEP_0085_handler(self, profile)
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	113
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	114 def updateEntityData(self, entity_jid, value, profile):
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	115 """
659 b6c22d9f593a plugin xep-0085: bug fix + improvement souliane <souliane@mailoo.org> parents: 654 diff changeset	116 Update the entity data of the given profile for one or all contacts.
b6c22d9f593a plugin xep-0085: bug fix + improvement souliane <souliane@mailoo.org> parents: 654 diff changeset	117 Reset the chat state(s) display if the notification has been disabled.
b6c22d9f593a plugin xep-0085: bug fix + improvement souliane <souliane@mailoo.org> parents: 654 diff changeset	118 @param entity_jid: contact's JID, or '@ALL@' to update all contacts.
b6c22d9f593a plugin xep-0085: bug fix + improvement souliane <souliane@mailoo.org> parents: 654 diff changeset	119 @param value: True, False or '@NONE@' to delete the entity data
b6c22d9f593a plugin xep-0085: bug fix + improvement souliane <souliane@mailoo.org> parents: 654 diff changeset	120 @param profile: current profile
636 7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	121 """
643 262d9d9ad27a plugin XEP-0085: renamed category and parameter souliane <souliane@mailoo.org> parents: 636 diff changeset	122 self.host.memory.updateEntityData(entity_jid, ENTITY_KEY, value, profile)
636 7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	123 if not value or value == "@NONE@":
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	124 # disable chat state for this or these contact(s)
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	125 self.host.bridge.chatStateReceived(unicode(entity_jid), "", profile)
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	126
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	127 def paramUpdateTrigger(self, name, value, category, type, profile):
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	128 """
659 b6c22d9f593a plugin xep-0085: bug fix + improvement souliane <souliane@mailoo.org> parents: 654 diff changeset	129 Reset all the existing chat state entity data associated with this profile after a parameter modification.
b6c22d9f593a plugin xep-0085: bug fix + improvement souliane <souliane@mailoo.org> parents: 654 diff changeset	130 @param name: parameter name
b6c22d9f593a plugin xep-0085: bug fix + improvement souliane <souliane@mailoo.org> parents: 654 diff changeset	131 @param value: "true" to activate the notifications, or any other value to delete it
b6c22d9f593a plugin xep-0085: bug fix + improvement souliane <souliane@mailoo.org> parents: 654 diff changeset	132 @param category: parameter category
636 7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	133 """
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	134 if (category, name) == (PARAM_KEY, PARAM_NAME):
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	135 self.updateEntityData("@ALL@", True if value == "true" else "@NONE@", profile)
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	136
663 8004c7d4aba7 core: Deferred in onMessage. Goffi <goffi@goffi.org> parents: 662 diff changeset	137 def messageReceivedTrigger(self, message, post_treat, profile):
636 7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	138 """
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	139 Update the entity cache when we receive a message with body.
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	140 Check for a check state in the incoming message and broadcast signal.
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	141 """
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	142 if not self.host.memory.getParamA(PARAM_NAME, PARAM_KEY, profile_key=profile):
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	143 return True
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	144
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	145 try:
660 69a8bfd266a5 core, plugins: fixed bad use of children instead of elements() for domish.Element instances. Goffi <goffi@goffi.org> parents: 659 diff changeset	146 domish.generateElementsNamed(message.elements(), name="body").next()
636 7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	147 from_jid = JID(message.getAttribute("from"))
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	148 try:
660 69a8bfd266a5 core, plugins: fixed bad use of children instead of elements() for domish.Element instances. Goffi <goffi@goffi.org> parents: 659 diff changeset	149 domish.generateElementsNamed(message.elements(), name="active").next()
636 7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	150 # contact enabled Chat State Notifications
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	151 self.updateEntityData(from_jid, True, profile)
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	152 # init to send following "composing" state
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	153 self.__chatStateInit(from_jid, message.getAttribute("type"), profile)
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	154 except StopIteration:
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	155 # contact didn't enable Chat State Notifications
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	156 self.updateEntityData(from_jid, False, profile)
659 b6c22d9f593a plugin xep-0085: bug fix + improvement souliane <souliane@mailoo.org> parents: 654 diff changeset	157 return True
636 7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	158 except StopIteration:
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	159 pass
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	160
660 69a8bfd266a5 core, plugins: fixed bad use of children instead of elements() for domish.Element instances. Goffi <goffi@goffi.org> parents: 659 diff changeset	161 state_list = [child.name for child in message.elements() if
636 7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	162 message.getAttribute("type") in MESSAGE_TYPES
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	163 and child.name in CHAT_STATES
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	164 and child.defaultUri == NS_CHAT_STATES]
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	165 for state in state_list:
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	166 # there must be only one state according to the XEP
659 b6c22d9f593a plugin xep-0085: bug fix + improvement souliane <souliane@mailoo.org> parents: 654 diff changeset	167 self.host.bridge.chatStateReceived(message.getAttribute("from"), state, profile)
636 7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	168 break
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	169 return True
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	170
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	171 def sendMessageXmlTrigger(self, message, mess_data, profile):
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	172 """
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	173 Eventually add the chat state to the message and initiate
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	174 the state machine when sending an "active" state.
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	175 """
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	176 to_jid = JID(message.getAttribute("to"))
659 b6c22d9f593a plugin xep-0085: bug fix + improvement souliane <souliane@mailoo.org> parents: 654 diff changeset	177 if not self.__checkActivation(to_jid, forceEntityData=True, profile=profile):
636 7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	178 return True
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	179 try:
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	180 # message with a body always mean active state
660 69a8bfd266a5 core, plugins: fixed bad use of children instead of elements() for domish.Element instances. Goffi <goffi@goffi.org> parents: 659 diff changeset	181 domish.generateElementsNamed(message.elements(), name="body").next()
636 7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	182 message.addElement('active', NS_CHAT_STATES)
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	183 # launch the chat state machine (init the timer)
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	184 self.__chatStateActive(to_jid, mess_data["type"], profile)
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	185 except StopIteration:
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	186 if "chat_state" in mess_data["options"]:
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	187 state = mess_data["options"]["chat_state"]
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	188 assert(state in CHAT_STATES)
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	189 message.addElement(state, NS_CHAT_STATES)
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	190 return True
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	191
659 b6c22d9f593a plugin xep-0085: bug fix + improvement souliane <souliane@mailoo.org> parents: 654 diff changeset	192 def __checkActivation(self, to_jid, forceEntityData, profile):
b6c22d9f593a plugin xep-0085: bug fix + improvement souliane <souliane@mailoo.org> parents: 654 diff changeset	193 """
b6c22d9f593a plugin xep-0085: bug fix + improvement souliane <souliane@mailoo.org> parents: 654 diff changeset	194 @param to_joid: the contact's JID
b6c22d9f593a plugin xep-0085: bug fix + improvement souliane <souliane@mailoo.org> parents: 654 diff changeset	195 @param forceEntityData: if set to True, a non-existing
b6c22d9f593a plugin xep-0085: bug fix + improvement souliane <souliane@mailoo.org> parents: 654 diff changeset	196 entity data will be considered to be True (and initialized)
b6c22d9f593a plugin xep-0085: bug fix + improvement souliane <souliane@mailoo.org> parents: 654 diff changeset	197 @param: current profile
b6c22d9f593a plugin xep-0085: bug fix + improvement souliane <souliane@mailoo.org> parents: 654 diff changeset	198 @return: True if the notifications should be sent to this JID.
b6c22d9f593a plugin xep-0085: bug fix + improvement souliane <souliane@mailoo.org> parents: 654 diff changeset	199 """
b6c22d9f593a plugin xep-0085: bug fix + improvement souliane <souliane@mailoo.org> parents: 654 diff changeset	200 # check if the parameter is active
b6c22d9f593a plugin xep-0085: bug fix + improvement souliane <souliane@mailoo.org> parents: 654 diff changeset	201 if not self.host.memory.getParamA(PARAM_NAME, PARAM_KEY, profile_key=profile):
b6c22d9f593a plugin xep-0085: bug fix + improvement souliane <souliane@mailoo.org> parents: 654 diff changeset	202 return False
b6c22d9f593a plugin xep-0085: bug fix + improvement souliane <souliane@mailoo.org> parents: 654 diff changeset	203 # check if notifications should be sent to this contact
b6c22d9f593a plugin xep-0085: bug fix + improvement souliane <souliane@mailoo.org> parents: 654 diff changeset	204 try:
b6c22d9f593a plugin xep-0085: bug fix + improvement souliane <souliane@mailoo.org> parents: 654 diff changeset	205 return self.host.memory.getEntityData(to_jid, [ENTITY_KEY], profile)[ENTITY_KEY]
b6c22d9f593a plugin xep-0085: bug fix + improvement souliane <souliane@mailoo.org> parents: 654 diff changeset	206 except (exceptions.UnknownEntityError, KeyError):
b6c22d9f593a plugin xep-0085: bug fix + improvement souliane <souliane@mailoo.org> parents: 654 diff changeset	207 if forceEntityData:
b6c22d9f593a plugin xep-0085: bug fix + improvement souliane <souliane@mailoo.org> parents: 654 diff changeset	208 # enable it for the first time
b6c22d9f593a plugin xep-0085: bug fix + improvement souliane <souliane@mailoo.org> parents: 654 diff changeset	209 self.updateEntityData(to_jid, True, profile)
b6c22d9f593a plugin xep-0085: bug fix + improvement souliane <souliane@mailoo.org> parents: 654 diff changeset	210 return True
b6c22d9f593a plugin xep-0085: bug fix + improvement souliane <souliane@mailoo.org> parents: 654 diff changeset	211 # wait for the first message before sending states
b6c22d9f593a plugin xep-0085: bug fix + improvement souliane <souliane@mailoo.org> parents: 654 diff changeset	212 return False
b6c22d9f593a plugin xep-0085: bug fix + improvement souliane <souliane@mailoo.org> parents: 654 diff changeset	213
636 7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	214 def __chatStateInit(self, to_jid, mess_type, profile):
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	215 """
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	216 Data initialization for the chat state machine.
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	217 """
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	218 # TODO: use also the resource in map key
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	219 to_jid = to_jid.userhostJID()
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	220 if mess_type is None:
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	221 return
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	222 if not hasattr(self, "map"):
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	223 self.map = {}
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	224 profile_map = self.map.setdefault(profile, {})
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	225 if not to_jid in profile_map:
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	226 machine = ChatStateMachine(self.host, to_jid,
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	227 mess_type, profile)
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	228 self.map[profile][to_jid] = machine
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	229
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	230 def __chatStateActive(self, to_jid, mess_type, profile_key):
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	231 """
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	232 Launch the chat state machine on "active" state.
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	233 """
654 5c5cf5bca240 plugin XEP-0085: improvement for sending "composing" state souliane <souliane@mailoo.org> parents: 643 diff changeset	234 # TODO: use also the JID resource in the map key
636 7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	235 to_jid = to_jid.userhostJID()
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	236 profile = self.host.memory.getProfileName(profile_key)
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	237 if profile is None:
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	238 raise exceptions.ProfileUnknownError
659 b6c22d9f593a plugin xep-0085: bug fix + improvement souliane <souliane@mailoo.org> parents: 654 diff changeset	239 return
636 7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	240 self.__chatStateInit(to_jid, mess_type, profile)
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	241 self.map[profile][to_jid]._onEvent("active")
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	242
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	243 def chatStateComposing(self, to_jid_s, profile_key):
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	244 """
654 5c5cf5bca240 plugin XEP-0085: improvement for sending "composing" state souliane <souliane@mailoo.org> parents: 643 diff changeset	245 Move to the "composing" state. Since this method is called
5c5cf5bca240 plugin XEP-0085: improvement for sending "composing" state souliane <souliane@mailoo.org> parents: 643 diff changeset	246 from the front-end, it needs to check the values of the
5c5cf5bca240 plugin XEP-0085: improvement for sending "composing" state souliane <souliane@mailoo.org> parents: 643 diff changeset	247 parameter "Send chat state notifications" and the entity
5c5cf5bca240 plugin XEP-0085: improvement for sending "composing" state souliane <souliane@mailoo.org> parents: 643 diff changeset	248 data associated to the target JID.
5c5cf5bca240 plugin XEP-0085: improvement for sending "composing" state souliane <souliane@mailoo.org> parents: 643 diff changeset	249 TODO: try to optimize this method which is called often
636 7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	250 """
654 5c5cf5bca240 plugin XEP-0085: improvement for sending "composing" state souliane <souliane@mailoo.org> parents: 643 diff changeset	251 # TODO: use also the JID resource in the map key
636 7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	252 to_jid = JID(to_jid_s).userhostJID()
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	253 profile = self.host.memory.getProfileName(profile_key)
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	254 if profile is None:
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	255 raise exceptions.ProfileUnknownError
659 b6c22d9f593a plugin xep-0085: bug fix + improvement souliane <souliane@mailoo.org> parents: 654 diff changeset	256 return
b6c22d9f593a plugin xep-0085: bug fix + improvement souliane <souliane@mailoo.org> parents: 654 diff changeset	257 if not self.__checkActivation(to_jid, forceEntityData=False, profile=profile):
b6c22d9f593a plugin xep-0085: bug fix + improvement souliane <souliane@mailoo.org> parents: 654 diff changeset	258 return
636 7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	259 try:
659 b6c22d9f593a plugin xep-0085: bug fix + improvement souliane <souliane@mailoo.org> parents: 654 diff changeset	260 self.map[profile][to_jid]._onEvent("composing")
b6c22d9f593a plugin xep-0085: bug fix + improvement souliane <souliane@mailoo.org> parents: 654 diff changeset	261 except AttributeError:
b6c22d9f593a plugin xep-0085: bug fix + improvement souliane <souliane@mailoo.org> parents: 654 diff changeset	262 # no message has been sent/received since the notifications
b6c22d9f593a plugin xep-0085: bug fix + improvement souliane <souliane@mailoo.org> parents: 654 diff changeset	263 # have been enabled, it's better to wait for a first one
654 5c5cf5bca240 plugin XEP-0085: improvement for sending "composing" state souliane <souliane@mailoo.org> parents: 643 diff changeset	264 pass
636 7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	265
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	266
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	267 class ChatStateMachine:
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	268 """
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	269 This class represents a chat state, between one profile and
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	270 one target contact. A timer is used to move from one state
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	271 to the other. The initialization is done through the "active"
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	272 state which is internally set when a message is sent. The state
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	273 "composing" can be set externally (through the bridge by a
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	274 frontend). Other states are automatically set with the timer.
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	275 """
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	276
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	277 def __init__(self, host, to_jid, mess_type, profile):
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	278 """
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	279 Initialization need to store the target, message type
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	280 and a profile for sending later messages.
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	281 """
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	282 self.host = host
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	283 self.to_jid = to_jid
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	284 self.mess_type = mess_type
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	285 self.profile = profile
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	286 self.state = None
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	287 self.timer = None
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	288
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	289 def _onEvent(self, state):
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	290 """
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	291 Move to the specified state, eventually send the
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	292 notification to the contact (the "active" state is
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	293 automatically sent with each message) and set the timer.
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	294 """
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	295 if state != self.state and state != "active":
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	296 # send a new message without body
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	297 self.host.sendMessage(self.to_jid,
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	298 '',
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	299 '',
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	300 self.mess_type,
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	301 options={"chat_state": state},
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	302 profile_key=self.profile)
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	303 self.state = state
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	304 if not self.timer is None:
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	305 self.timer.cancel()
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	306
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	307 if not state in TRANSITIONS:
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	308 return
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	309 if not "next_state" in TRANSITIONS[state]:
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	310 return
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	311 if not "delay" in TRANSITIONS[state]:
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	312 return
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	313 next_state = TRANSITIONS[state]["next_state"]
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	314 delay = TRANSITIONS[state]["delay"]
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	315 if next_state == "" or delay < 0:
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	316 return
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	317 self.timer = Timer(delay, self._onEvent, [next_state])
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	318 self.timer.start()
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	319
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	320
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	321 class XEP_0085_handler(XMPPHandler):
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	322 implements(iwokkel.IDisco)
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	323
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	324 def __init__(self, plugin_parent, profile):
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	325 self.plugin_parent = plugin_parent
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	326 self.host = plugin_parent.host
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	327 self.profile = profile
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	328
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	329 def getDiscoInfo(self, requestor, target, nodeIdentifier=''):
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	330 return [disco.DiscoFeature(NS_CHAT_STATES)]
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	331
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	332 def getDiscoItems(self, requestor, target, nodeIdentifier=''):
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: diff changeset	333 return []

Mercurial > libervia-backend

annotate src/plugins/plugin_xep_0085.py @ 685:0b9bd47dffcd