annotate src/plugins/plugin_exp_command_export.py @ 636:7ea6d5a86e58

plugin XEP-0085: Chat State Notifications - new "options" parameter to send chat states - plugin command export: messages without body are now delivered (since all the chat states other than "active" need them)
author souliane <souliane@mailoo.org>
date Thu, 05 Sep 2013 20:48:47 +0200
parents 84a6e83157c2
children 8004c7d4aba7
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
604
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
1 #!/usr/bin/python
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
2 # -*- coding: utf-8 -*-
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
3
609
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 604
diff changeset
4 # SAT plugin to export commands (experimental)
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 604
diff changeset
5 # Copyright (C) 2009, 2010, 2011, 2012, 2013 Jérôme Poisson (goffi@goffi.org)
604
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
6
609
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 604
diff changeset
7 # This program is free software: you can redistribute it and/or modify
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 604
diff changeset
8 # it under the terms of the GNU Affero General Public License as published by
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 604
diff changeset
9 # the Free Software Foundation, either version 3 of the License, or
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 604
diff changeset
10 # (at your option) any later version.
604
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
11
609
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 604
diff changeset
12 # This program is distributed in the hope that it will be useful,
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 604
diff changeset
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 604
diff changeset
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 604
diff changeset
15 # GNU Affero General Public License for more details.
604
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
16
609
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 604
diff changeset
17 # You should have received a copy of the GNU Affero General Public License
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 604
diff changeset
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
604
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
19
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
20 from logging import debug, info, warning, error
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
21 from twisted.words.protocols.jabber import jid
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
22 from twisted.internet import reactor, protocol
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
23
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
24 from sat.tools.misc import SkipOtherTriggers
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
25 from sat.tools.utils import clean_ustr
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
26
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
27 PLUGIN_INFO = {
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
28 "name": "Command export plugin",
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
29 "import_name": "EXP-COMMANS-EXPORT",
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
30 "type": "EXP",
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
31 "protocols": [],
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
32 "dependencies": [],
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
33 "main": "CommandExport",
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
34 "handler": "no",
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
35 "description": _("""Implementation of command export""")
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
36 }
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
37
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
38 class ExportCommandProtocol(protocol.ProcessProtocol):
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
39 """ Try to register an account with prosody """
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
40
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
41 def __init__(self, parent, target, options, profile):
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
42 self.parent = parent
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
43 self.target = target
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
44 self.options = options
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
45 self.profile = profile
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
46
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
47 def _clean(self, data):
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
48 if not data:
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
49 error ("data should not be empty !")
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
50 return u""
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
51 decoded = data.decode('utf-8', 'ignore')[:-1 if data[-1] == '\n' else None]
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
52 return clean_ustr(decoded)
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
53
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
54 def connectionMade(self):
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
55 info("connectionMade :)")
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
56
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
57 def outReceived(self, data):
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
58 self.parent.host.sendMessage(self.target, self._clean(data), no_trigger=True, profile_key=self.profile)
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
59
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
60 def errReceived(self, data):
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
61 self.parent.host.sendMessage(self.target, self._clean(data), no_trigger=True, profile_key=self.profile)
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
62
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
63 def processEnded(self, reason):
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
64 info (u"process finished: %d" % (reason.value.exitCode,))
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
65 self.parent.removeProcess(self.target, self)
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
66
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
67 def write(self, message):
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
68 self.transport.write(message.encode('utf-8'))
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
69
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
70 def boolOption(self, key):
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
71 """ Get boolean value from options
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
72 @param key: name of the option
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
73 @return: True if key exists and set to "true" (case insensitive),
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
74 False in all other cases """
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
75 value = self.options.get(key, "")
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
76 return value.lower() == "true"
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
77
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
78
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
79 class CommandExport(object):
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
80 """Command export plugin: export a command to an entity"""
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
81 #XXX: This plugin can be potentially dangerous if we don't trust entities linked
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
82 # this is specially true if we have other triggers.
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
83
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
84 def __init__(self, host):
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
85 info(_("Plugin command export initialization"))
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
86 self.host = host
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
87 self.spawned = {} # key = entity
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
88 host.trigger.add("MessageReceived", self.MessageReceivedTrigger, priority=10000)
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
89 host.bridge.addMethod("exportCommand", ".plugin", in_sign='sasasa{ss}s', out_sign='', method=self._exportCommand)
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
90
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
91 def removeProcess(self, entity, process):
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
92 """ Called when the process is finished
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
93 @param entity: jid.JID attached to the process
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
94 @param process: process to remove"""
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
95 try:
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
96 processes_set = self.spawned[(entity, process.profile)]
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
97 processes_set.discard(process)
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
98 if not processes_set:
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
99 del(self.spawned[(entity, process.profile)])
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
100 except ValueError:
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
101 pass
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
102
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
103 def MessageReceivedTrigger(self, message, profile):
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
104 """ Check if source is linked and repeat message, else do nothing """
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
105 from_jid = jid.JID(message["from"])
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
106 spawned_key = (from_jid.userhostJID(), profile)
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
107 try:
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
108 body = [e for e in message.elements() if e.name == 'body'][0]
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
109 except IndexError:
636
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications
souliane <souliane@mailoo.org>
parents: 609
diff changeset
110 # do not block message without body (chat state notification...)
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications
souliane <souliane@mailoo.org>
parents: 609
diff changeset
111 warning("No body element found in message, following normal behaviour")
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications
souliane <souliane@mailoo.org>
parents: 609
diff changeset
112 return True
604
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
113
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
114 mess_data = unicode(body) + '\n'
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
115
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
116 if spawned_key in self.spawned:
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
117 processes_set = self.spawned[spawned_key]
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
118 _continue = False
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
119 exclusive = False
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
120 for process in processes_set:
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
121 process.write(mess_data)
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
122 _continue &= process.boolOption("continue")
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
123 exclusive |= process.boolOption("exclusive")
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
124 if exclusive:
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
125 raise SkipOtherTriggers
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
126 return _continue
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
127
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
128 return True
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
129
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
130 def _exportCommand(self, command, args, targets, options, profile_key):
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
131 """ Export a commands to authorised targets
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
132 @param command: full path of the command to execute
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
133 @param args: list of arguments, with command name as first one
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
134 @param targets: list of allowed entities
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
135 @param options: export options, a dict which can have the following keys ("true" to set booleans):
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
136 - exclusive: if set, skip all other triggers
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
137 - loop: if set, restart the command once terminated #TODO
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
138 - pty: if set, launch in a pseudo terminal
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
139 - continue: continue normal MessageReceived handling
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
140 """
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
141 profile = self.host.memory.getProfileName(profile_key)
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
142 if not profile:
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
143 warning("Unknown profile [%s]" % (profile,))
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
144 return
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
145
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
146 for target in targets:
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
147 try:
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
148 _jid = jid.JID(target)
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
149 if not _jid.user or not _jid.host:
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
150 raise jid.InvalidFormat
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
151 _jid = _jid.userhostJID()
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
152 except (jid.InvalidFormat, RuntimeError):
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
153 info(u"invalid target ignored: %s" % (target,))
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
154 continue
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
155 process_prot = ExportCommandProtocol(self, _jid, options, profile)
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
156 self.spawned.setdefault((_jid, profile),set()).add(process_prot)
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
157 reactor.spawnProcess(process_prot, command, args, usePTY = process_prot.boolOption('pty'))
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
158