libervia-backend: src/plugins/plugin_misc_text

annotate src/plugins/plugin_misc_text_commands.py @ 693:65b30bc7f1b3

tests: added XML comparaison method to helpers

author	Goffi <goffi@goffi.org>
date	Tue, 12 Nov 2013 14:16:11 +0100
parents	84a6e83157c2
children	0c84fb112d70

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
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 600 diff changeset	4 # SàT plugin for managing text commands
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 600 diff changeset	5 # 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	6
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 600 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: 600 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: 600 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: 600 diff changeset	10 # (at your option) any later version.
506 2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands Goffi <goffi@goffi.org> parents: diff changeset	11
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 600 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: 600 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: 600 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: 600 diff changeset	15 # GNU Affero General Public License for more details.
506 2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands Goffi <goffi@goffi.org> parents: diff changeset	16
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 600 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: 600 diff changeset	18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
506 2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands Goffi <goffi@goffi.org> parents: diff changeset	19
508 7c6609dddb2c plugin text commands: /leave management: Goffi <goffi@goffi.org> parents: 506 diff changeset	20 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	21 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	22
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands Goffi <goffi@goffi.org> parents: diff changeset	23 PLUGIN_INFO = {
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	24 "name": "Text commands",
600 c5451501465b plugin text commands: basic /whois command (just show jid so far) Goffi <goffi@goffi.org> parents: 594 diff changeset	25 "import_name": "TEXT-COMMANDS",
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	26 "type": "Misc",
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	27 "protocols": [],
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	28 "dependencies": ["XEP-0045", "EXP-PARROT"],
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	29 "main": "TextCommands",
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	30 "handler": "no",
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	31 "description": _("""IRC like text commands""")
506 2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands Goffi <goffi@goffi.org> parents: diff changeset	32 }
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands Goffi <goffi@goffi.org> parents: diff changeset	33
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	34
588 beaf6bec2fcd Remove every old-style class. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 587 diff changeset	35 class TextCommands(object):
517 59b32c04e105 plugin text commands: added /help command Goffi <goffi@goffi.org> parents: 515 diff changeset	36 #FIXME: doc strings for commands have to be translatable
59b32c04e105 plugin text commands: added /help command Goffi <goffi@goffi.org> parents: 515 diff changeset	37 # plugins need a dynamic translation system (translation
59b32c04e105 plugin text commands: added /help command Goffi <goffi@goffi.org> parents: 515 diff changeset	38 # 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	39
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands Goffi <goffi@goffi.org> parents: diff changeset	40 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	41 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	42 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	43 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	44
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands Goffi <goffi@goffi.org> parents: diff changeset	45 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	46 """ 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	47 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	48 if msg:
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[0] == '/':
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands Goffi <goffi@goffi.org> parents: diff changeset	50 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	51 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	52 # 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	53 try:
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	54 mess_data["unparsed"] = msg[1 + len(command):] # part not yet parsed of the message
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	55 return getattr(self, "cmd_%s" % command)(mess_data, profile)
506 2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands Goffi <goffi@goffi.org> parents: diff changeset	56 except AttributeError:
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands Goffi <goffi@goffi.org> parents: diff changeset	57 pass
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	58 elif msg[0] == '\\': # we have escape char
506 2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands Goffi <goffi@goffi.org> parents: diff changeset	59 try:
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	60 if msg[1] in ('/', '\\'): # we have '\/' or '\\', we escape to '/' or '\'
506 2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands Goffi <goffi@goffi.org> parents: diff changeset	61 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	62 except IndexError:
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands Goffi <goffi@goffi.org> parents: diff changeset	63 pass
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands Goffi <goffi@goffi.org> parents: diff changeset	64 return True
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands Goffi <goffi@goffi.org> parents: diff changeset	65
508 7c6609dddb2c plugin text commands: /leave management: Goffi <goffi@goffi.org> parents: 506 diff changeset	66 def _getRoomJID(self, arg, service_jid):
7c6609dddb2c plugin text commands: /leave management: Goffi <goffi@goffi.org> parents: 506 diff changeset	67 """Return a room jid with a shortcut
7c6609dddb2c plugin text commands: /leave management: Goffi <goffi@goffi.org> parents: 506 diff changeset	68 @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	69 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	70 @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	71 """
7c6609dddb2c plugin text commands: /leave management: Goffi <goffi@goffi.org> parents: 506 diff changeset	72 nb_arobas = arg.count('@')
7c6609dddb2c plugin text commands: /leave management: Goffi <goffi@goffi.org> parents: 506 diff changeset	73 if nb_arobas == 1:
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	74 if arg[-1] != '@':
508 7c6609dddb2c plugin text commands: /leave management: Goffi <goffi@goffi.org> parents: 506 diff changeset	75 return jid.JID(arg)
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	76 return jid.JID(arg + service_jid)
508 7c6609dddb2c plugin text commands: /leave management: Goffi <goffi@goffi.org> parents: 506 diff changeset	77 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	78
523 24c0d51449e7 plugin text commands: added _feedback method to send an answer to user Goffi <goffi@goffi.org> parents: 519 diff changeset	79 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	80 """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	81 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	82 _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	83 else:
24c0d51449e7 plugin text commands: added _feedback method to send an answer to user Goffi <goffi@goffi.org> parents: 519 diff changeset	84 _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	85
24c0d51449e7 plugin text commands: added _feedback method to send an answer to user Goffi <goffi@goffi.org> parents: 519 diff changeset	86 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	87
506 2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands Goffi <goffi@goffi.org> parents: diff changeset	88 def cmd_nick(self, mess_data, profile):
517 59b32c04e105 plugin text commands: added /help command Goffi <goffi@goffi.org> parents: 515 diff changeset	89 """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	90 debug("Catched nick command")
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	91
506 2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands Goffi <goffi@goffi.org> parents: diff changeset	92 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	93 #/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	94 info("Ignoring /nick command on a non groupchat message")
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	95
506 2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands Goffi <goffi@goffi.org> parents: diff changeset	96 return True
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	97
506 2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands Goffi <goffi@goffi.org> parents: diff changeset	98 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	99 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	100
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	101 self.host.plugins["XEP-0045"].nick(room, nick, profile)
506 2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands Goffi <goffi@goffi.org> parents: diff changeset	102
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands Goffi <goffi@goffi.org> parents: diff changeset	103 return False
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	104
509 64ff046dc201 plugin text commands: added /join command Goffi <goffi@goffi.org> parents: 508 diff changeset	105 def cmd_join(self, mess_data, profile):
517 59b32c04e105 plugin text commands: added /help command Goffi <goffi@goffi.org> parents: 515 diff changeset	106 """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	107 debug("Catched join command")
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	108
509 64ff046dc201 plugin text commands: added /join command Goffi <goffi@goffi.org> parents: 508 diff changeset	109 if mess_data['type'] != "groupchat":
64ff046dc201 plugin text commands: added /join command Goffi <goffi@goffi.org> parents: 508 diff changeset	110 #/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	111 info("Ignoring /join command on a non groupchat message")
64ff046dc201 plugin text commands: added /join command Goffi <goffi@goffi.org> parents: 508 diff changeset	112 return True
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	113
509 64ff046dc201 plugin text commands: added /join command Goffi <goffi@goffi.org> parents: 508 diff changeset	114 if mess_data["unparsed"].strip():
64ff046dc201 plugin text commands: added /join command Goffi <goffi@goffi.org> parents: 508 diff changeset	115 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	116 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	117 self.host.getClient(profile).jid.user)
64ff046dc201 plugin text commands: added /join command Goffi <goffi@goffi.org> parents: 508 diff changeset	118 self.host.plugins["XEP-0045"].join(room, nick, {}, profile)
64ff046dc201 plugin text commands: added /join command Goffi <goffi@goffi.org> parents: 508 diff changeset	119
64ff046dc201 plugin text commands: added /join command Goffi <goffi@goffi.org> parents: 508 diff changeset	120 return False
64ff046dc201 plugin text commands: added /join command Goffi <goffi@goffi.org> parents: 508 diff changeset	121
508 7c6609dddb2c plugin text commands: /leave management: Goffi <goffi@goffi.org> parents: 506 diff changeset	122 def cmd_leave(self, mess_data, profile):
517 59b32c04e105 plugin text commands: added /help command Goffi <goffi@goffi.org> parents: 515 diff changeset	123 """quit a room"""
508 7c6609dddb2c plugin text commands: /leave management: Goffi <goffi@goffi.org> parents: 506 diff changeset	124 debug("Catched leave command")
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	125
508 7c6609dddb2c plugin text commands: /leave management: Goffi <goffi@goffi.org> parents: 506 diff changeset	126 if mess_data['type'] != "groupchat":
7c6609dddb2c plugin text commands: /leave management: Goffi <goffi@goffi.org> parents: 506 diff changeset	127 #/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	128 info("Ignoring /leave command on a non groupchat message")
7c6609dddb2c plugin text commands: /leave management: Goffi <goffi@goffi.org> parents: 506 diff changeset	129 return True
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	130
508 7c6609dddb2c plugin text commands: /leave management: Goffi <goffi@goffi.org> parents: 506 diff changeset	131 if mess_data["unparsed"].strip():
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	132 room = self._getRoomJID(mess_data["unparsed"].strip(), mess_data["to"].host)
508 7c6609dddb2c plugin text commands: /leave management: Goffi <goffi@goffi.org> parents: 506 diff changeset	133 else:
7c6609dddb2c plugin text commands: /leave management: Goffi <goffi@goffi.org> parents: 506 diff changeset	134 room = mess_data["to"]
7c6609dddb2c plugin text commands: /leave management: Goffi <goffi@goffi.org> parents: 506 diff changeset	135
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	136 self.host.plugins["XEP-0045"].leave(room, profile)
508 7c6609dddb2c plugin text commands: /leave management: Goffi <goffi@goffi.org> parents: 506 diff changeset	137
7c6609dddb2c plugin text commands: /leave management: Goffi <goffi@goffi.org> parents: 506 diff changeset	138 return False
7c6609dddb2c plugin text commands: /leave management: Goffi <goffi@goffi.org> parents: 506 diff changeset	139
7c6609dddb2c plugin text commands: /leave management: Goffi <goffi@goffi.org> parents: 506 diff changeset	140 def cmd_part(self, mess_data, profile):
7c6609dddb2c plugin text commands: /leave management: Goffi <goffi@goffi.org> parents: 506 diff changeset	141 """just a synonym of /leave"""
7c6609dddb2c plugin text commands: /leave management: Goffi <goffi@goffi.org> parents: 506 diff changeset	142 return self.cmd_leave(mess_data, profile)
7c6609dddb2c plugin text commands: /leave management: Goffi <goffi@goffi.org> parents: 506 diff changeset	143
515 29b5ef129488 plugin XEP-0045, plugin text commands: added '/title' command Goffi <goffi@goffi.org> parents: 509 diff changeset	144 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	145 """change room's subject"""
515 29b5ef129488 plugin XEP-0045, plugin text commands: added '/title' command Goffi <goffi@goffi.org> parents: 509 diff changeset	146 debug("Catched title command")
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	147
515 29b5ef129488 plugin XEP-0045, plugin text commands: added '/title' command Goffi <goffi@goffi.org> parents: 509 diff changeset	148 if mess_data['type'] != "groupchat":
29b5ef129488 plugin XEP-0045, plugin text commands: added '/title' command Goffi <goffi@goffi.org> parents: 509 diff changeset	149 #/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	150 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	151 return True
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	152
515 29b5ef129488 plugin XEP-0045, plugin text commands: added '/title' command Goffi <goffi@goffi.org> parents: 509 diff changeset	153 subject = mess_data["unparsed"].strip()
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	154
515 29b5ef129488 plugin XEP-0045, plugin text commands: added '/title' command Goffi <goffi@goffi.org> parents: 509 diff changeset	155 if subject:
29b5ef129488 plugin XEP-0045, plugin text commands: added '/title' command Goffi <goffi@goffi.org> parents: 509 diff changeset	156 room = mess_data["to"]
29b5ef129488 plugin XEP-0045, plugin text commands: added '/title' command Goffi <goffi@goffi.org> parents: 509 diff changeset	157 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	158
29b5ef129488 plugin XEP-0045, plugin text commands: added '/title' command Goffi <goffi@goffi.org> parents: 509 diff changeset	159 return False
29b5ef129488 plugin XEP-0045, plugin text commands: added '/title' command Goffi <goffi@goffi.org> parents: 509 diff changeset	160
565 7573897831ee plugin text commands: added /topic as a synonym of /title Goffi <goffi@goffi.org> parents: 535 diff changeset	161 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	162 """just a synonym of /title"""
7573897831ee plugin text commands: added /topic as a synonym of /title Goffi <goffi@goffi.org> parents: 535 diff changeset	163 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	164
527 9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin Goffi <goffi@goffi.org> parents: 523 diff changeset	165 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	166 """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	167 #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	168 # to allow plugins to register simple commands like this.
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	169
527 9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin Goffi <goffi@goffi.org> parents: 523 diff changeset	170 debug("Catched parrot command")
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	171
527 9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin Goffi <goffi@goffi.org> parents: 523 diff changeset	172 try:
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin Goffi <goffi@goffi.org> parents: 523 diff changeset	173 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	174 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	175 raise jid.InvalidFormat
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin Goffi <goffi@goffi.org> parents: 523 diff changeset	176 except jid.InvalidFormat:
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin Goffi <goffi@goffi.org> parents: 523 diff changeset	177 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	178 return False
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin Goffi <goffi@goffi.org> parents: 523 diff changeset	179
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin Goffi <goffi@goffi.org> parents: 523 diff changeset	180 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	181
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin Goffi <goffi@goffi.org> parents: 523 diff changeset	182 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	183 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	184
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	185 self._feedBack("Parrot mode activated for %s" % (unicode(link_left_jid), ), mess_data, profile)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	186
527 9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin Goffi <goffi@goffi.org> parents: 523 diff changeset	187 return False
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin Goffi <goffi@goffi.org> parents: 523 diff changeset	188
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin Goffi <goffi@goffi.org> parents: 523 diff changeset	189 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	190 """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	191 debug("Catched unparrot command")
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	192
527 9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin Goffi <goffi@goffi.org> parents: 523 diff changeset	193 try:
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin Goffi <goffi@goffi.org> parents: 523 diff changeset	194 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	195 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	196 raise jid.InvalidFormat
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin Goffi <goffi@goffi.org> parents: 523 diff changeset	197 except jid.InvalidFormat:
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin Goffi <goffi@goffi.org> parents: 523 diff changeset	198 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	199 return False
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin Goffi <goffi@goffi.org> parents: 523 diff changeset	200
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin Goffi <goffi@goffi.org> parents: 523 diff changeset	201 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	202
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin Goffi <goffi@goffi.org> parents: 523 diff changeset	203 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	204 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	205
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin Goffi <goffi@goffi.org> parents: 523 diff changeset	206 self._feedBack("Parrot mode deactivated for %s and %s" % (unicode(link_left_jid), unicode(link_right_jid)), mess_data, profile)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	207
527 9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin Goffi <goffi@goffi.org> parents: 523 diff changeset	208 return False
9a3913fb0a6c plugin text commands: added /parrot and /unparrot commands to use Parrot plugin Goffi <goffi@goffi.org> parents: 523 diff changeset	209
600 c5451501465b plugin text commands: basic /whois command (just show jid so far) Goffi <goffi@goffi.org> parents: 594 diff changeset	210 def cmd_whois(self, mess_data, profile):
c5451501465b plugin text commands: basic /whois command (just show jid so far) Goffi <goffi@goffi.org> parents: 594 diff changeset	211 """show informations on entity"""
c5451501465b plugin text commands: basic /whois command (just show jid so far) Goffi <goffi@goffi.org> parents: 594 diff changeset	212 debug("Catched whois command")
c5451501465b plugin text commands: basic /whois command (just show jid so far) Goffi <goffi@goffi.org> parents: 594 diff changeset	213
c5451501465b plugin text commands: basic /whois command (just show jid so far) Goffi <goffi@goffi.org> parents: 594 diff changeset	214 entity = mess_data["unparsed"].strip()
c5451501465b plugin text commands: basic /whois command (just show jid so far) Goffi <goffi@goffi.org> parents: 594 diff changeset	215
c5451501465b plugin text commands: basic /whois command (just show jid so far) Goffi <goffi@goffi.org> parents: 594 diff changeset	216 if mess_data['type'] == "groupchat":
c5451501465b plugin text commands: basic /whois command (just show jid so far) Goffi <goffi@goffi.org> parents: 594 diff changeset	217 room = mess_data["to"]
c5451501465b plugin text commands: basic /whois command (just show jid so far) Goffi <goffi@goffi.org> parents: 594 diff changeset	218 if self.host.plugins["XEP-0045"].isNickInRoom(room, entity, profile):
c5451501465b plugin text commands: basic /whois command (just show jid so far) Goffi <goffi@goffi.org> parents: 594 diff changeset	219 entity = u"%s/%s" % (room, entity)
c5451501465b plugin text commands: basic /whois command (just show jid so far) Goffi <goffi@goffi.org> parents: 594 diff changeset	220
c5451501465b plugin text commands: basic /whois command (just show jid so far) Goffi <goffi@goffi.org> parents: 594 diff changeset	221 if not entity:
c5451501465b plugin text commands: basic /whois command (just show jid so far) Goffi <goffi@goffi.org> parents: 594 diff changeset	222 target_jid = mess_data["to"]
c5451501465b plugin text commands: basic /whois command (just show jid so far) Goffi <goffi@goffi.org> parents: 594 diff changeset	223 else:
c5451501465b plugin text commands: basic /whois command (just show jid so far) Goffi <goffi@goffi.org> parents: 594 diff changeset	224 try:
c5451501465b plugin text commands: basic /whois command (just show jid so far) Goffi <goffi@goffi.org> parents: 594 diff changeset	225 target_jid = jid.JID(entity)
c5451501465b plugin text commands: basic /whois command (just show jid so far) Goffi <goffi@goffi.org> parents: 594 diff changeset	226 if not target_jid.user or not target_jid.host:
c5451501465b plugin text commands: basic /whois command (just show jid so far) Goffi <goffi@goffi.org> parents: 594 diff changeset	227 raise jid.InvalidFormat
c5451501465b plugin text commands: basic /whois command (just show jid so far) Goffi <goffi@goffi.org> parents: 594 diff changeset	228 except (jid.InvalidFormat, RuntimeError):
c5451501465b plugin text commands: basic /whois command (just show jid so far) Goffi <goffi@goffi.org> parents: 594 diff changeset	229 self._feedBack(_("Invalid jid, can't whois"), mess_data, profile)
c5451501465b plugin text commands: basic /whois command (just show jid so far) Goffi <goffi@goffi.org> parents: 594 diff changeset	230 return False
c5451501465b plugin text commands: basic /whois command (just show jid so far) Goffi <goffi@goffi.org> parents: 594 diff changeset	231
c5451501465b plugin text commands: basic /whois command (just show jid so far) Goffi <goffi@goffi.org> parents: 594 diff changeset	232 whois_msg = [_(u"whois for %(jid)s") % {'jid': target_jid}]
c5451501465b plugin text commands: basic /whois command (just show jid so far) Goffi <goffi@goffi.org> parents: 594 diff changeset	233 #TODO: add informations here (client version, vcard, etc)
c5451501465b plugin text commands: basic /whois command (just show jid so far) Goffi <goffi@goffi.org> parents: 594 diff changeset	234
c5451501465b plugin text commands: basic /whois command (just show jid so far) Goffi <goffi@goffi.org> parents: 594 diff changeset	235 self._feedBack(u"\n".join(whois_msg), mess_data, profile)
c5451501465b plugin text commands: basic /whois command (just show jid so far) Goffi <goffi@goffi.org> parents: 594 diff changeset	236
c5451501465b plugin text commands: basic /whois command (just show jid so far) Goffi <goffi@goffi.org> parents: 594 diff changeset	237 return False
c5451501465b plugin text commands: basic /whois command (just show jid so far) Goffi <goffi@goffi.org> parents: 594 diff changeset	238
517 59b32c04e105 plugin text commands: added /help command Goffi <goffi@goffi.org> parents: 515 diff changeset	239 def cmd_help(self, mess_data, profile):
59b32c04e105 plugin text commands: added /help command Goffi <goffi@goffi.org> parents: 515 diff changeset	240 """show help on available commands"""
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	241 commands = filter(lambda method: method.startswith('cmd_'), dir(self))
517 59b32c04e105 plugin text commands: added /help command Goffi <goffi@goffi.org> parents: 515 diff changeset	242 longuest = max([len(command) for command in commands])
59b32c04e105 plugin text commands: added /help command Goffi <goffi@goffi.org> parents: 515 diff changeset	243 help_cmds = []
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	244
517 59b32c04e105 plugin text commands: added /help command Goffi <goffi@goffi.org> parents: 515 diff changeset	245 for command in commands:
59b32c04e105 plugin text commands: added /help command Goffi <goffi@goffi.org> parents: 515 diff changeset	246 method = getattr(self, command)
59b32c04e105 plugin text commands: added /help command Goffi <goffi@goffi.org> parents: 515 diff changeset	247 try:
59b32c04e105 plugin text commands: added /help command Goffi <goffi@goffi.org> parents: 515 diff changeset	248 help_str = method.__doc__.split('\n')[0]
59b32c04e105 plugin text commands: added /help command Goffi <goffi@goffi.org> parents: 515 diff changeset	249 except AttributeError:
59b32c04e105 plugin text commands: added /help command Goffi <goffi@goffi.org> parents: 515 diff changeset	250 help_str = ''
59b32c04e105 plugin text commands: added /help command Goffi <goffi@goffi.org> parents: 515 diff changeset	251 spaces = (longuest - len(command)) * ' '
59b32c04e105 plugin text commands: added /help command Goffi <goffi@goffi.org> parents: 515 diff changeset	252 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	253
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	254 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	255 self._feedBack(help_mess, mess_data, profile)

Mercurial > libervia-backend

annotate src/plugins/plugin_misc_text_commands.py @ 693:65b30bc7f1b3