annotate src/plugins/plugin_exp_command_export.py @ 2014:0694a2611bad

plugin XEP-0070: change message popup to be more user-friendly
author Geoffrey POUZET <chteufleur@kingpenguin.tk>
date Tue, 19 Jul 2016 21:25:22 +0200
parents a2bc5089c2eb
children 1d3f73e065e1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1934
2daf7b4c6756 use of /usr/bin/env instead of /usr/bin/python in shebang
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1 #!/usr/bin/env python2
604
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)
1766
d17772b0fe22 copyright update
Goffi <goffi@goffi.org>
parents: 1742
diff changeset
5 # Copyright (C) 2009-2016 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
771
bfabeedbf32e core: i18n refactoring:
Goffi <goffi@goffi.org>
parents: 663
diff changeset
20 from sat.core.i18n import _
1955
633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished):
Goffi <goffi@goffi.org>
parents: 1934
diff changeset
21 from sat.core.constants import Const as C
993
301b342c697a core: use of the new core.log module:
Goffi <goffi@goffi.org>
parents: 811
diff changeset
22 from sat.core.log import getLogger
301b342c697a core: use of the new core.log module:
Goffi <goffi@goffi.org>
parents: 811
diff changeset
23 log = getLogger(__name__)
604
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
24 from twisted.words.protocols.jabber import jid
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
25 from twisted.internet import reactor, protocol
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
26
1374
0befb14ecf62 renamed tools.misc to tools.trigger
Goffi <goffi@goffi.org>
parents: 993
diff changeset
27 from sat.tools import trigger
604
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
28 from sat.tools.utils import clean_ustr
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
29
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
30 PLUGIN_INFO = {
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
31 "name": "Command export plugin",
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
32 "import_name": "EXP-COMMANS-EXPORT",
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
33 "type": "EXP",
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
34 "protocols": [],
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
35 "dependencies": [],
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
36 "main": "CommandExport",
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
37 "handler": "no",
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
38 "description": _("""Implementation of command export""")
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
39 }
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 class ExportCommandProtocol(protocol.ProcessProtocol):
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
42 """ Try to register an account with prosody """
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
43
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
44 def __init__(self, parent, target, options, profile):
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
45 self.parent = parent
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
46 self.target = target
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
47 self.options = options
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
48 self.profile = profile
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
49
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
50 def _clean(self, data):
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
51 if not data:
993
301b342c697a core: use of the new core.log module:
Goffi <goffi@goffi.org>
parents: 811
diff changeset
52 log.error ("data should not be empty !")
604
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
53 return u""
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
54 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
55 return clean_ustr(decoded)
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 connectionMade(self):
993
301b342c697a core: use of the new core.log module:
Goffi <goffi@goffi.org>
parents: 811
diff changeset
58 log.info("connectionMade :)")
604
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 outReceived(self, data):
1955
633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished):
Goffi <goffi@goffi.org>
parents: 1934
diff changeset
61 self.parent.host.messageSend(self.target, {'': self._clean(data)}, no_trigger=True, profile_key=self.profile)
604
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 errReceived(self, data):
1955
633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished):
Goffi <goffi@goffi.org>
parents: 1934
diff changeset
64 self.parent.host.messageSend(self.target, {'': self._clean(data)}, no_trigger=True, profile_key=self.profile)
604
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
65
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
66 def processEnded(self, reason):
993
301b342c697a core: use of the new core.log module:
Goffi <goffi@goffi.org>
parents: 811
diff changeset
67 log.info (u"process finished: %d" % (reason.value.exitCode,))
604
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
68 self.parent.removeProcess(self.target, self)
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 write(self, message):
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
71 self.transport.write(message.encode('utf-8'))
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
72
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
73 def boolOption(self, key):
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
74 """ Get boolean value from options
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
75 @param key: name of the option
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
76 @return: True if key exists and set to "true" (case insensitive),
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
77 False in all other cases """
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
78 value = self.options.get(key, "")
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
79 return value.lower() == "true"
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
80
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
81
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
82 class CommandExport(object):
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
83 """Command export plugin: export a command to an entity"""
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
84 #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
85 # this is specially true if we have other triggers.
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
86
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
87 def __init__(self, host):
993
301b342c697a core: use of the new core.log module:
Goffi <goffi@goffi.org>
parents: 811
diff changeset
88 log.info(_("Plugin command export initialization"))
604
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
89 self.host = host
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
90 self.spawned = {} # key = entity
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
91 host.trigger.add("MessageReceived", self.MessageReceivedTrigger, priority=10000)
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
92 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
93
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
94 def removeProcess(self, entity, process):
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
95 """ Called when the process is finished
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
96 @param entity: jid.JID attached to the process
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
97 @param process: process to remove"""
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
98 try:
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
99 processes_set = self.spawned[(entity, process.profile)]
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
100 processes_set.discard(process)
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
101 if not processes_set:
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
102 del(self.spawned[(entity, process.profile)])
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
103 except ValueError:
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
104 pass
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
105
1963
a2bc5089c2eb backend, frontends: message refactoring (huge commit):
Goffi <goffi@goffi.org>
parents: 1955
diff changeset
106 def MessageReceivedTrigger(self, client, message_elt, post_treat):
604
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
107 """ Check if source is linked and repeat message, else do nothing """
1963
a2bc5089c2eb backend, frontends: message refactoring (huge commit):
Goffi <goffi@goffi.org>
parents: 1955
diff changeset
108 from_jid = jid.JID(message_elt["from"])
1955
633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished):
Goffi <goffi@goffi.org>
parents: 1934
diff changeset
109 spawned_key = (from_jid.userhostJID(), client.profile)
604
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
110
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
111 if spawned_key in self.spawned:
1955
633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished):
Goffi <goffi@goffi.org>
parents: 1934
diff changeset
112 try:
1963
a2bc5089c2eb backend, frontends: message refactoring (huge commit):
Goffi <goffi@goffi.org>
parents: 1955
diff changeset
113 body = message_elt.elements(C.NS_CLIENT, 'body').next()
1955
633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished):
Goffi <goffi@goffi.org>
parents: 1934
diff changeset
114 except StopIteration:
633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished):
Goffi <goffi@goffi.org>
parents: 1934
diff changeset
115 # do not block message without body (chat state notification...)
633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished):
Goffi <goffi@goffi.org>
parents: 1934
diff changeset
116 return True
633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished):
Goffi <goffi@goffi.org>
parents: 1934
diff changeset
117
633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished):
Goffi <goffi@goffi.org>
parents: 1934
diff changeset
118 mess_data = unicode(body) + '\n'
604
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
119 processes_set = self.spawned[spawned_key]
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
120 _continue = False
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
121 exclusive = False
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
122 for process in processes_set:
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
123 process.write(mess_data)
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
124 _continue &= process.boolOption("continue")
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
125 exclusive |= process.boolOption("exclusive")
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
126 if exclusive:
1374
0befb14ecf62 renamed tools.misc to tools.trigger
Goffi <goffi@goffi.org>
parents: 993
diff changeset
127 raise trigger.SkipOtherTriggers
604
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
128 return _continue
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 return True
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
131
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
132 def _exportCommand(self, command, args, targets, options, profile_key):
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
133 """ Export a commands to authorised targets
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
134 @param command: full path of the command to execute
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
135 @param args: list of arguments, with command name as first one
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
136 @param targets: list of allowed entities
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
137 @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
138 - exclusive: if set, skip all other triggers
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
139 - loop: if set, restart the command once terminated #TODO
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
140 - pty: if set, launch in a pseudo terminal
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
141 - continue: continue normal MessageReceived handling
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
142 """
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
143 profile = self.host.memory.getProfileName(profile_key)
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
144 if not profile:
1409
3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions
souliane <souliane@mailoo.org>
parents: 1396
diff changeset
145 log.warning(u"Unknown profile [%s]" % (profile,))
604
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
146 return
1374
0befb14ecf62 renamed tools.misc to tools.trigger
Goffi <goffi@goffi.org>
parents: 993
diff changeset
147
604
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
148 for target in targets:
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
149 try:
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
150 _jid = jid.JID(target)
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
151 if not _jid.user or not _jid.host:
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
152 raise jid.InvalidFormat
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
153 _jid = _jid.userhostJID()
1742
244a605623d6 complete the Exception's list when catching JID error:
souliane <souliane@mailoo.org>
parents: 1654
diff changeset
154 except (RuntimeError, jid.InvalidFormat, AttributeError):
993
301b342c697a core: use of the new core.log module:
Goffi <goffi@goffi.org>
parents: 811
diff changeset
155 log.info(u"invalid target ignored: %s" % (target,))
604
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
156 continue
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
157 process_prot = ExportCommandProtocol(self, _jid, options, profile)
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
158 self.spawned.setdefault((_jid, profile),set()).add(process_prot)
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
159 reactor.spawnProcess(process_prot, command, args, usePTY = process_prot.boolOption('pty'))
16a9affc49cf plugin export command: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
160