annotate src/plugins/plugin_misc_text_commands.py @ 578:28331ecf0a65

misc: README cleaning + added Mutagen to credits
author Goffi <goffi@goffi.org>
date Wed, 09 Jan 2013 22:31:32 +0100
parents ca13633d3b6b
children 952322b1d490
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
506
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
1 #!/usr/bin/python
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
2 # -*- coding: utf-8 -*-
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
3
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
4 """
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
5 SàT plugin for managing text commands
572
ca13633d3b6b dates update
Goffi <goffi@goffi.org>
parents: 565
diff changeset
6 Copyright (C) 2009, 2010, 2011, 2012, 2013 Jérôme Poisson (goffi@goffi.org)
506
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
7
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
8 This program is free software: you can redistribute it and/or modify
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
9 it under the terms of the GNU Affero General Public License as published by
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
10 the Free Software Foundation, either version 3 of the License, or
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
11 (at your option) any later version.
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
12
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
13 This program is distributed in the hope that it will be useful,
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
16 GNU Affero General Public License for more details.
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
17
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
18 You should have received a copy of the GNU Affero General Public License
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
19 along with this program. If not, see <http://www.gnu.org/licenses/>.
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
20 """
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
21
508
7c6609dddb2c plugin text commands: /leave management:
Goffi <goffi@goffi.org>
parents: 506
diff changeset
22 from twisted.words.protocols.jabber import jid
506
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
23 from logging import debug, info, warning, error
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
24
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
25 PLUGIN_INFO = {
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
26 "name": "Text commands",
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
27 "import_name": "text-commands",
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
28 "type": "Misc",
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
29 "protocols": [],
527
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin
Goffi <goffi@goffi.org>
parents: 523
diff changeset
30 "dependencies": ["XEP-0045", "EXP-PARROT"],
506
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
31 "main": "TextCommands",
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
32 "handler": "no",
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
33 "description": _("""IRC like text commands""")
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
34 }
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
35
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
36 class TextCommands():
517
59b32c04e105 plugin text commands: added /help command
Goffi <goffi@goffi.org>
parents: 515
diff changeset
37 #FIXME: doc strings for commands have to be translatable
59b32c04e105 plugin text commands: added /help command
Goffi <goffi@goffi.org>
parents: 515
diff changeset
38 # plugins need a dynamic translation system (translation
59b32c04e105 plugin text commands: added /help command
Goffi <goffi@goffi.org>
parents: 515
diff changeset
39 # should be downloadable independently)
506
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
40
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
41 def __init__(self, host):
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
42 info(_("Text commands initialization"))
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
43 self.host = host
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
44 host.trigger.add("sendMessage", self.sendMessageTrigger)
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
45
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
46 def sendMessageTrigger(self, mess_data, profile):
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
47 """ Check text commands in message, and react consequently """
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
48 msg = mess_data["message"]
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
49 if msg:
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
50 if msg[0] == '/':
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
51 command = msg[1:].partition(' ')[0].lower()
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
52 if command.isalpha():
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
53 # looks like an actual command, we try to call the corresponding method
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
54 try:
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
55 mess_data["unparsed"] = msg[1+len(command):] #part not yet parsed of the message
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
56 return getattr(self,"cmd_%s" % command)(mess_data,profile)
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
57 except AttributeError:
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
58 pass
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
59 elif msg[0] == '\\': #we have escape char
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
60 try:
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
61 if msg[1] in ('/','\\'): # we have '\/' or '\\', we escape to '/' or '\'
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
62 mess_data["message"] = msg[1:]
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
63 except IndexError:
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
64 pass
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
65 return True
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
66
508
7c6609dddb2c plugin text commands: /leave management:
Goffi <goffi@goffi.org>
parents: 506
diff changeset
67 def _getRoomJID(self, arg, service_jid):
7c6609dddb2c plugin text commands: /leave management:
Goffi <goffi@goffi.org>
parents: 506
diff changeset
68 """Return a room jid with a shortcut
7c6609dddb2c plugin text commands: /leave management:
Goffi <goffi@goffi.org>
parents: 506
diff changeset
69 @param arg: argument: can be a full room jid (e.g.: sat@chat.jabberfr.org)
7c6609dddb2c plugin text commands: /leave management:
Goffi <goffi@goffi.org>
parents: 506
diff changeset
70 or a shortcut (e.g.: sat or sat@ for sat on current service)
7c6609dddb2c plugin text commands: /leave management:
Goffi <goffi@goffi.org>
parents: 506
diff changeset
71 @param service_jid: jid of the current service (e.g.: chat.jabberfr.org)
7c6609dddb2c plugin text commands: /leave management:
Goffi <goffi@goffi.org>
parents: 506
diff changeset
72 """
7c6609dddb2c plugin text commands: /leave management:
Goffi <goffi@goffi.org>
parents: 506
diff changeset
73 nb_arobas = arg.count('@')
7c6609dddb2c plugin text commands: /leave management:
Goffi <goffi@goffi.org>
parents: 506
diff changeset
74 if nb_arobas == 1:
7c6609dddb2c plugin text commands: /leave management:
Goffi <goffi@goffi.org>
parents: 506
diff changeset
75 if arg[-1] !='@':
7c6609dddb2c plugin text commands: /leave management:
Goffi <goffi@goffi.org>
parents: 506
diff changeset
76 return jid.JID(arg)
7c6609dddb2c plugin text commands: /leave management:
Goffi <goffi@goffi.org>
parents: 506
diff changeset
77 return jid.JID(arg+service_jid)
7c6609dddb2c plugin text commands: /leave management:
Goffi <goffi@goffi.org>
parents: 506
diff changeset
78 return jid.JID(u"%s@%s" % (arg, service_jid))
506
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
79
523
24c0d51449e7 plugin text commands: added _feedback method to send an answer to user
Goffi <goffi@goffi.org>
parents: 519
diff changeset
80 def _feedBack(self, message, mess_data, profile):
24c0d51449e7 plugin text commands: added _feedback method to send an answer to user
Goffi <goffi@goffi.org>
parents: 519
diff changeset
81 """Give a message back to the user"""
24c0d51449e7 plugin text commands: added _feedback method to send an answer to user
Goffi <goffi@goffi.org>
parents: 519
diff changeset
82 if mess_data["type"] == 'groupchat':
24c0d51449e7 plugin text commands: added _feedback method to send an answer to user
Goffi <goffi@goffi.org>
parents: 519
diff changeset
83 _from = mess_data["to"].userhostJID()
24c0d51449e7 plugin text commands: added _feedback method to send an answer to user
Goffi <goffi@goffi.org>
parents: 519
diff changeset
84 else:
24c0d51449e7 plugin text commands: added _feedback method to send an answer to user
Goffi <goffi@goffi.org>
parents: 519
diff changeset
85 _from = self.host.getJidNStream(profile)[0]
24c0d51449e7 plugin text commands: added _feedback method to send an answer to user
Goffi <goffi@goffi.org>
parents: 519
diff changeset
86
24c0d51449e7 plugin text commands: added _feedback method to send an answer to user
Goffi <goffi@goffi.org>
parents: 519
diff changeset
87 self.host.bridge.newMessage(unicode(mess_data["to"]), message, mess_data['type'], unicode(_from), {}, profile=profile)
24c0d51449e7 plugin text commands: added _feedback method to send an answer to user
Goffi <goffi@goffi.org>
parents: 519
diff changeset
88
506
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
89 def cmd_nick(self, mess_data, profile):
517
59b32c04e105 plugin text commands: added /help command
Goffi <goffi@goffi.org>
parents: 515
diff changeset
90 """change nickname"""
506
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
91 debug("Catched nick command")
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
92
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
93 if mess_data['type'] != "groupchat":
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
94 #/nick command does nothing if we are not on a group chat
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
95 info("Ignoring /nick command on a non groupchat message")
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
96
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
97 return True
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
98
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
99 nick = mess_data["unparsed"].strip()
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
100 room = mess_data["to"]
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
101
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
102 self.host.plugins["XEP-0045"].nick(room,nick,profile)
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
103
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands
Goffi <goffi@goffi.org>
parents:
diff changeset
104 return False
508
7c6609dddb2c plugin text commands: /leave management:
Goffi <goffi@goffi.org>
parents: 506
diff changeset
105
509
64ff046dc201 plugin text commands: added /join command
Goffi <goffi@goffi.org>
parents: 508
diff changeset
106 def cmd_join(self, mess_data, profile):
517
59b32c04e105 plugin text commands: added /help command
Goffi <goffi@goffi.org>
parents: 515
diff changeset
107 """join a new room (on the same service if full jid is not specified)"""
509
64ff046dc201 plugin text commands: added /join command
Goffi <goffi@goffi.org>
parents: 508
diff changeset
108 debug("Catched join command")
64ff046dc201 plugin text commands: added /join command
Goffi <goffi@goffi.org>
parents: 508
diff changeset
109
64ff046dc201 plugin text commands: added /join command
Goffi <goffi@goffi.org>
parents: 508
diff changeset
110 if mess_data['type'] != "groupchat":
64ff046dc201 plugin text commands: added /join command
Goffi <goffi@goffi.org>
parents: 508
diff changeset
111 #/leave command does nothing if we are not on a group chat
64ff046dc201 plugin text commands: added /join command
Goffi <goffi@goffi.org>
parents: 508
diff changeset
112 info("Ignoring /join command on a non groupchat message")
64ff046dc201 plugin text commands: added /join command
Goffi <goffi@goffi.org>
parents: 508
diff changeset
113 return True
64ff046dc201 plugin text commands: added /join command
Goffi <goffi@goffi.org>
parents: 508
diff changeset
114
64ff046dc201 plugin text commands: added /join command
Goffi <goffi@goffi.org>
parents: 508
diff changeset
115 if mess_data["unparsed"].strip():
64ff046dc201 plugin text commands: added /join command
Goffi <goffi@goffi.org>
parents: 508
diff changeset
116 room = self._getRoomJID(mess_data["unparsed"].strip(), mess_data["to"].host)
64ff046dc201 plugin text commands: added /join command
Goffi <goffi@goffi.org>
parents: 508
diff changeset
117 nick = (self.host.plugins["XEP-0045"].getRoomNick(mess_data["to"].userhost(), profile) or
64ff046dc201 plugin text commands: added /join command
Goffi <goffi@goffi.org>
parents: 508
diff changeset
118 self.host.getClient(profile).jid.user)
64ff046dc201 plugin text commands: added /join command
Goffi <goffi@goffi.org>
parents: 508
diff changeset
119 self.host.plugins["XEP-0045"].join(room, nick, {}, profile)
64ff046dc201 plugin text commands: added /join command
Goffi <goffi@goffi.org>
parents: 508
diff changeset
120
64ff046dc201 plugin text commands: added /join command
Goffi <goffi@goffi.org>
parents: 508
diff changeset
121 return False
64ff046dc201 plugin text commands: added /join command
Goffi <goffi@goffi.org>
parents: 508
diff changeset
122
508
7c6609dddb2c plugin text commands: /leave management:
Goffi <goffi@goffi.org>
parents: 506
diff changeset
123 def cmd_leave(self, mess_data, profile):
517
59b32c04e105 plugin text commands: added /help command
Goffi <goffi@goffi.org>
parents: 515
diff changeset
124 """quit a room"""
508
7c6609dddb2c plugin text commands: /leave management:
Goffi <goffi@goffi.org>
parents: 506
diff changeset
125 debug("Catched leave command")
7c6609dddb2c plugin text commands: /leave management:
Goffi <goffi@goffi.org>
parents: 506
diff changeset
126
7c6609dddb2c plugin text commands: /leave management:
Goffi <goffi@goffi.org>
parents: 506
diff changeset
127 if mess_data['type'] != "groupchat":
7c6609dddb2c plugin text commands: /leave management:
Goffi <goffi@goffi.org>
parents: 506
diff changeset
128 #/leave command does nothing if we are not on a group chat
7c6609dddb2c plugin text commands: /leave management:
Goffi <goffi@goffi.org>
parents: 506
diff changeset
129 info("Ignoring /leave command on a non groupchat message")
7c6609dddb2c plugin text commands: /leave management:
Goffi <goffi@goffi.org>
parents: 506
diff changeset
130 return True
7c6609dddb2c plugin text commands: /leave management:
Goffi <goffi@goffi.org>
parents: 506
diff changeset
131
7c6609dddb2c plugin text commands: /leave management:
Goffi <goffi@goffi.org>
parents: 506
diff changeset
132 if mess_data["unparsed"].strip():
7c6609dddb2c plugin text commands: /leave management:
Goffi <goffi@goffi.org>
parents: 506
diff changeset
133 room = self._getRoomJID(mess_data["unparsed"].strip(), mess_data["to"].host)
7c6609dddb2c plugin text commands: /leave management:
Goffi <goffi@goffi.org>
parents: 506
diff changeset
134 else:
7c6609dddb2c plugin text commands: /leave management:
Goffi <goffi@goffi.org>
parents: 506
diff changeset
135 room = mess_data["to"]
7c6609dddb2c plugin text commands: /leave management:
Goffi <goffi@goffi.org>
parents: 506
diff changeset
136
7c6609dddb2c plugin text commands: /leave management:
Goffi <goffi@goffi.org>
parents: 506
diff changeset
137 self.host.plugins["XEP-0045"].leave(room,profile)
7c6609dddb2c plugin text commands: /leave management:
Goffi <goffi@goffi.org>
parents: 506
diff changeset
138
7c6609dddb2c plugin text commands: /leave management:
Goffi <goffi@goffi.org>
parents: 506
diff changeset
139 return False
7c6609dddb2c plugin text commands: /leave management:
Goffi <goffi@goffi.org>
parents: 506
diff changeset
140
7c6609dddb2c plugin text commands: /leave management:
Goffi <goffi@goffi.org>
parents: 506
diff changeset
141 def cmd_part(self, mess_data, profile):
7c6609dddb2c plugin text commands: /leave management:
Goffi <goffi@goffi.org>
parents: 506
diff changeset
142 """just a synonym of /leave"""
7c6609dddb2c plugin text commands: /leave management:
Goffi <goffi@goffi.org>
parents: 506
diff changeset
143 return self.cmd_leave(mess_data, profile)
7c6609dddb2c plugin text commands: /leave management:
Goffi <goffi@goffi.org>
parents: 506
diff changeset
144
515
29b5ef129488 plugin XEP-0045, plugin text commands: added '/title' command
Goffi <goffi@goffi.org>
parents: 509
diff changeset
145 def cmd_title(self, mess_data, profile):
523
24c0d51449e7 plugin text commands: added _feedback method to send an answer to user
Goffi <goffi@goffi.org>
parents: 519
diff changeset
146 """change room's subject"""
515
29b5ef129488 plugin XEP-0045, plugin text commands: added '/title' command
Goffi <goffi@goffi.org>
parents: 509
diff changeset
147 debug("Catched title command")
29b5ef129488 plugin XEP-0045, plugin text commands: added '/title' command
Goffi <goffi@goffi.org>
parents: 509
diff changeset
148
29b5ef129488 plugin XEP-0045, plugin text commands: added '/title' command
Goffi <goffi@goffi.org>
parents: 509
diff changeset
149 if mess_data['type'] != "groupchat":
29b5ef129488 plugin XEP-0045, plugin text commands: added '/title' command
Goffi <goffi@goffi.org>
parents: 509
diff changeset
150 #/leave command does nothing if we are not on a group chat
29b5ef129488 plugin XEP-0045, plugin text commands: added '/title' command
Goffi <goffi@goffi.org>
parents: 509
diff changeset
151 info("Ignoring /title command on a non groupchat message")
29b5ef129488 plugin XEP-0045, plugin text commands: added '/title' command
Goffi <goffi@goffi.org>
parents: 509
diff changeset
152 return True
29b5ef129488 plugin XEP-0045, plugin text commands: added '/title' command
Goffi <goffi@goffi.org>
parents: 509
diff changeset
153
29b5ef129488 plugin XEP-0045, plugin text commands: added '/title' command
Goffi <goffi@goffi.org>
parents: 509
diff changeset
154 subject = mess_data["unparsed"].strip()
29b5ef129488 plugin XEP-0045, plugin text commands: added '/title' command
Goffi <goffi@goffi.org>
parents: 509
diff changeset
155
29b5ef129488 plugin XEP-0045, plugin text commands: added '/title' command
Goffi <goffi@goffi.org>
parents: 509
diff changeset
156 if subject:
29b5ef129488 plugin XEP-0045, plugin text commands: added '/title' command
Goffi <goffi@goffi.org>
parents: 509
diff changeset
157 room = mess_data["to"]
29b5ef129488 plugin XEP-0045, plugin text commands: added '/title' command
Goffi <goffi@goffi.org>
parents: 509
diff changeset
158 self.host.plugins["XEP-0045"].subject(room, subject, profile)
29b5ef129488 plugin XEP-0045, plugin text commands: added '/title' command
Goffi <goffi@goffi.org>
parents: 509
diff changeset
159
29b5ef129488 plugin XEP-0045, plugin text commands: added '/title' command
Goffi <goffi@goffi.org>
parents: 509
diff changeset
160 return False
29b5ef129488 plugin XEP-0045, plugin text commands: added '/title' command
Goffi <goffi@goffi.org>
parents: 509
diff changeset
161
565
7573897831ee plugin text commands: added /topic as a synonym of /title
Goffi <goffi@goffi.org>
parents: 535
diff changeset
162 def cmd_topic(self, mess_data, profile):
7573897831ee plugin text commands: added /topic as a synonym of /title
Goffi <goffi@goffi.org>
parents: 535
diff changeset
163 """just a synonym of /title"""
7573897831ee plugin text commands: added /topic as a synonym of /title
Goffi <goffi@goffi.org>
parents: 535
diff changeset
164 return self.cmd_title(mess_data, profile)
7573897831ee plugin text commands: added /topic as a synonym of /title
Goffi <goffi@goffi.org>
parents: 535
diff changeset
165
527
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin
Goffi <goffi@goffi.org>
parents: 523
diff changeset
166 def cmd_parrot(self, mess_data, profile):
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin
Goffi <goffi@goffi.org>
parents: 523
diff changeset
167 """activate Parrot mode between 2 entities, in both directions."""
535
790be337cc41 bridge: fixed D-Bus warning in frontend side of bridge
Goffi <goffi@goffi.org>
parents: 527
diff changeset
168 #TODO: these commands must not be hardcoded, an interface should be made
790be337cc41 bridge: fixed D-Bus warning in frontend side of bridge
Goffi <goffi@goffi.org>
parents: 527
diff changeset
169 # to allow plugins to register simple commands like this.
790be337cc41 bridge: fixed D-Bus warning in frontend side of bridge
Goffi <goffi@goffi.org>
parents: 527
diff changeset
170
527
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin
Goffi <goffi@goffi.org>
parents: 523
diff changeset
171 debug("Catched parrot command")
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin
Goffi <goffi@goffi.org>
parents: 523
diff changeset
172
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin
Goffi <goffi@goffi.org>
parents: 523
diff changeset
173 try:
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin
Goffi <goffi@goffi.org>
parents: 523
diff changeset
174 link_left_jid = jid.JID(mess_data["unparsed"].strip())
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin
Goffi <goffi@goffi.org>
parents: 523
diff changeset
175 if not link_left_jid.user or not link_left_jid.host:
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin
Goffi <goffi@goffi.org>
parents: 523
diff changeset
176 raise jid.InvalidFormat
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin
Goffi <goffi@goffi.org>
parents: 523
diff changeset
177 except jid.InvalidFormat:
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin
Goffi <goffi@goffi.org>
parents: 523
diff changeset
178 self._feedBack("Can't activate Parrot mode for invalid jid", mess_data, profile)
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin
Goffi <goffi@goffi.org>
parents: 523
diff changeset
179 return False
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin
Goffi <goffi@goffi.org>
parents: 523
diff changeset
180
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin
Goffi <goffi@goffi.org>
parents: 523
diff changeset
181 link_right_jid = mess_data['to']
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin
Goffi <goffi@goffi.org>
parents: 523
diff changeset
182
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin
Goffi <goffi@goffi.org>
parents: 523
diff changeset
183 self.host.plugins["EXP-PARROT"].addParrot(link_left_jid, link_right_jid, profile)
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin
Goffi <goffi@goffi.org>
parents: 523
diff changeset
184 self.host.plugins["EXP-PARROT"].addParrot(link_right_jid, link_left_jid, profile)
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin
Goffi <goffi@goffi.org>
parents: 523
diff changeset
185
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin
Goffi <goffi@goffi.org>
parents: 523
diff changeset
186 self._feedBack("Parrot mode activated for %s" % (unicode(link_left_jid),), mess_data, profile)
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin
Goffi <goffi@goffi.org>
parents: 523
diff changeset
187
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin
Goffi <goffi@goffi.org>
parents: 523
diff changeset
188 return False
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin
Goffi <goffi@goffi.org>
parents: 523
diff changeset
189
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin
Goffi <goffi@goffi.org>
parents: 523
diff changeset
190 def cmd_unparrot(self, mess_data, profile):
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin
Goffi <goffi@goffi.org>
parents: 523
diff changeset
191 """remove Parrot mode between 2 entities, in both directions."""
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin
Goffi <goffi@goffi.org>
parents: 523
diff changeset
192 debug("Catched unparrot command")
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin
Goffi <goffi@goffi.org>
parents: 523
diff changeset
193
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin
Goffi <goffi@goffi.org>
parents: 523
diff changeset
194 try:
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin
Goffi <goffi@goffi.org>
parents: 523
diff changeset
195 link_left_jid = jid.JID(mess_data["unparsed"].strip())
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin
Goffi <goffi@goffi.org>
parents: 523
diff changeset
196 if not link_left_jid.user or not link_left_jid.host:
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin
Goffi <goffi@goffi.org>
parents: 523
diff changeset
197 raise jid.InvalidFormat
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin
Goffi <goffi@goffi.org>
parents: 523
diff changeset
198 except jid.InvalidFormat:
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin
Goffi <goffi@goffi.org>
parents: 523
diff changeset
199 self._feedBack("Can't deactivate Parrot mode for invalid jid", mess_data, profile)
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin
Goffi <goffi@goffi.org>
parents: 523
diff changeset
200 return False
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin
Goffi <goffi@goffi.org>
parents: 523
diff changeset
201
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin
Goffi <goffi@goffi.org>
parents: 523
diff changeset
202 link_right_jid = mess_data['to']
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin
Goffi <goffi@goffi.org>
parents: 523
diff changeset
203
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin
Goffi <goffi@goffi.org>
parents: 523
diff changeset
204 self.host.plugins["EXP-PARROT"].removeParrot(link_left_jid, profile)
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin
Goffi <goffi@goffi.org>
parents: 523
diff changeset
205 self.host.plugins["EXP-PARROT"].removeParrot(link_right_jid, profile)
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin
Goffi <goffi@goffi.org>
parents: 523
diff changeset
206
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin
Goffi <goffi@goffi.org>
parents: 523
diff changeset
207 self._feedBack("Parrot mode deactivated for %s and %s" % (unicode(link_left_jid), unicode(link_right_jid)), mess_data, profile)
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin
Goffi <goffi@goffi.org>
parents: 523
diff changeset
208
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin
Goffi <goffi@goffi.org>
parents: 523
diff changeset
209 return False
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin
Goffi <goffi@goffi.org>
parents: 523
diff changeset
210
517
59b32c04e105 plugin text commands: added /help command
Goffi <goffi@goffi.org>
parents: 515
diff changeset
211 def cmd_help(self, mess_data, profile):
59b32c04e105 plugin text commands: added /help command
Goffi <goffi@goffi.org>
parents: 515
diff changeset
212 """show help on available commands"""
59b32c04e105 plugin text commands: added /help command
Goffi <goffi@goffi.org>
parents: 515
diff changeset
213 commands=filter(lambda method: method.startswith('cmd_'), dir(self))
59b32c04e105 plugin text commands: added /help command
Goffi <goffi@goffi.org>
parents: 515
diff changeset
214 longuest = max([len(command) for command in commands])
59b32c04e105 plugin text commands: added /help command
Goffi <goffi@goffi.org>
parents: 515
diff changeset
215 help_cmds = []
59b32c04e105 plugin text commands: added /help command
Goffi <goffi@goffi.org>
parents: 515
diff changeset
216
59b32c04e105 plugin text commands: added /help command
Goffi <goffi@goffi.org>
parents: 515
diff changeset
217 for command in commands:
59b32c04e105 plugin text commands: added /help command
Goffi <goffi@goffi.org>
parents: 515
diff changeset
218 method = getattr(self, command)
59b32c04e105 plugin text commands: added /help command
Goffi <goffi@goffi.org>
parents: 515
diff changeset
219 try:
59b32c04e105 plugin text commands: added /help command
Goffi <goffi@goffi.org>
parents: 515
diff changeset
220 help_str = method.__doc__.split('\n')[0]
59b32c04e105 plugin text commands: added /help command
Goffi <goffi@goffi.org>
parents: 515
diff changeset
221 except AttributeError:
59b32c04e105 plugin text commands: added /help command
Goffi <goffi@goffi.org>
parents: 515
diff changeset
222 help_str = ''
59b32c04e105 plugin text commands: added /help command
Goffi <goffi@goffi.org>
parents: 515
diff changeset
223 spaces = (longuest - len(command)) * ' '
59b32c04e105 plugin text commands: added /help command
Goffi <goffi@goffi.org>
parents: 515
diff changeset
224 help_cmds.append(" /%s: %s %s" % (command[4:], spaces, help_str))
59b32c04e105 plugin text commands: added /help command
Goffi <goffi@goffi.org>
parents: 515
diff changeset
225
59b32c04e105 plugin text commands: added /help command
Goffi <goffi@goffi.org>
parents: 515
diff changeset
226 help_mess = _(u"Text commands available:\n%s") % (u'\n'.join(help_cmds),)
523
24c0d51449e7 plugin text commands: added _feedback method to send an answer to user
Goffi <goffi@goffi.org>
parents: 519
diff changeset
227 self._feedBack(help_mess, mess_data, profile)
517
59b32c04e105 plugin text commands: added /help command
Goffi <goffi@goffi.org>
parents: 515
diff changeset
228
59b32c04e105 plugin text commands: added /help command
Goffi <goffi@goffi.org>
parents: 515
diff changeset
229