libervia-backend: sat/plugins/plugin_misc_text

annotate sat/plugins/plugin_misc_text_commands.py @ 2686:ce1e15d59496

quick frontend (contact list): use property to retrieve "whoami" in ProfileContactList: this avoid a crash introduced by early creation of contact list during profile plugging, and avoid desynchronisation risk.

author	Goffi <goffi@goffi.org>
date	Fri, 09 Nov 2018 16:17:45 +0100
parents	56f94936df1e
children	d715d912afac

rev	line source
1934 2daf7b4c6756 use of /usr/bin/env instead of /usr/bin/python in shebang Goffi <goffi@goffi.org> parents: 1889 diff changeset	1 #!/usr/bin/env python2
506 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
2483 0046283a285d dates update Goffi <goffi@goffi.org> parents: 2414 diff changeset	5 # Copyright (C) 2009-2018 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
771 bfabeedbf32e core: i18n refactoring: Goffi <goffi@goffi.org> parents: 698 diff changeset	20 from sat.core.i18n import _
926 d609581bf74a plugin text commands: refactoring, text now only contain main commands, and other plugin can add commands themselve: Goffi <goffi@goffi.org> parents: 922 diff changeset	21 from sat.core.constants import Const as C
1052 e88bff4c8b77 core (XMPP): sendMessage refactoring: Goffi <goffi@goffi.org> parents: 1025 diff changeset	22 from sat.core import exceptions
508 7c6609dddb2c plugin text commands: /leave management: Goffi <goffi@goffi.org> parents: 506 diff changeset	23 from twisted.words.protocols.jabber import jid
921 8dd168c7741c plugin text commands: refactoring: Goffi <goffi@goffi.org> parents: 811 diff changeset	24 from twisted.internet import defer
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 929 diff changeset	25 from sat.core.log import getLogger
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	26
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 929 diff changeset	27 log = getLogger(__name__)
1052 e88bff4c8b77 core (XMPP): sendMessage refactoring: Goffi <goffi@goffi.org> parents: 1025 diff changeset	28 from twisted.python import failure
1369 dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	29 from collections import OrderedDict
506 2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands Goffi <goffi@goffi.org> parents: diff changeset	30
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands Goffi <goffi@goffi.org> parents: diff changeset	31 PLUGIN_INFO = {
2145 33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 2144 diff changeset	32 C.PI_NAME: "Text commands",
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 2144 diff changeset	33 C.PI_IMPORT_NAME: C.TEXT_CMDS,
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 2144 diff changeset	34 C.PI_TYPE: "Misc",
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 2144 diff changeset	35 C.PI_PROTOCOLS: ["XEP-0245"],
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 2144 diff changeset	36 C.PI_DEPENDENCIES: [],
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 2144 diff changeset	37 C.PI_MAIN: "TextCommands",
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 2144 diff changeset	38 C.PI_HANDLER: "no",
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	39 C.PI_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	40 }
2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands Goffi <goffi@goffi.org> parents: diff changeset	41
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	42
1369 dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	43 class InvalidCommandSyntax(Exception):
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	44 """Throwed while parsing @command in docstring if syntax is invalid"""
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	45
1369 dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	46 pass
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	47
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	48
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	49 CMD_KEY = "@command"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	50 CMD_TYPES = ("group", "one2one", "all")
1963 a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	51 FEEDBACK_INFO_TYPE = "TEXT_CMD"
1369 dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	52
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	53
588 beaf6bec2fcd Remove every old-style class. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 587 diff changeset	54 class TextCommands(object):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	55 # FIXME: doc strings for commands have to be translatable
517 59b32c04e105 plugin text commands: added /help command Goffi <goffi@goffi.org> parents: 515 diff changeset	56 # plugins need a dynamic translation system (translation
59b32c04e105 plugin text commands: added /help command Goffi <goffi@goffi.org> parents: 515 diff changeset	57 # 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	58
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	59 HELP_SUGGESTION = _(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	60 "Type '/help' to get a list of the available commands. If you didn't want to use a command, please start your message with '//' to escape the slash."
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	61 )
1002 291eb8216f6e plugins TEXT-COMMANDS, XEP-0045, XEP-0048, XEP-0249: souliane <souliane@mailoo.org> parents: 993 diff changeset	62
506 2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands Goffi <goffi@goffi.org> parents: diff changeset	63 def __init__(self, host):
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 929 diff changeset	64 log.info(_("Text commands initialization"))
506 2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands Goffi <goffi@goffi.org> parents: diff changeset	65 self.host = host
2128 aa94f33fd2ad plugin otr: various improvments: Goffi <goffi@goffi.org> parents: 2111 diff changeset	66 # this is internal command, so we set high priority
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2128 diff changeset	67 host.trigger.add("sendMessage", self.sendMessageTrigger, priority=1000000)
926 d609581bf74a plugin text commands: refactoring, text now only contain main commands, and other plugin can add commands themselve: Goffi <goffi@goffi.org> parents: 922 diff changeset	68 self._commands = {}
d609581bf74a plugin text commands: refactoring, text now only contain main commands, and other plugin can add commands themselve: Goffi <goffi@goffi.org> parents: 922 diff changeset	69 self._whois = []
d609581bf74a plugin text commands: refactoring, text now only contain main commands, and other plugin can add commands themselve: Goffi <goffi@goffi.org> parents: 922 diff changeset	70 self.registerTextCommands(self)
d609581bf74a plugin text commands: refactoring, text now only contain main commands, and other plugin can add commands themselve: Goffi <goffi@goffi.org> parents: 922 diff changeset	71
1369 dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	72 def _parseDocString(self, cmd, cmd_name):
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	73 """Parse a docstring to get text command data
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	74
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	75 @param cmd: function or method callback for the command,
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	76 its docstring will be used for self documentation in the following way:
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	77 - first line is the command short documentation, shown with /help
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	78 - @command keyword can be used, see http://wiki.goffi.org/wiki/Coding_style/en for documentation
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	79 @return (dict): dictionary with parsed data where key can be:
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	80 - "doc_short_help" (default: ""): the untranslated short documentation
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	81 - "type" (default "all"): the command type as specified in documentation
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	82 - "args" (default: ""): the arguments available, using syntax specified in documentation.
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	83 - "doc_arg_[name]": the doc of [name] argument
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	84 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	85 data = OrderedDict([("doc_short_help", ""), ("type", "all"), ("args", "")])
1369 dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	86 docstring = cmd.__doc__
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	87 if docstring is None:
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	88 log.warning(u"Not docstring found for command {}".format(cmd_name))
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	89 docstring = ""
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	90
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	91 doc_data = docstring.split("\n")
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	92 data["doc_short_help"] = doc_data[0]
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	93
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	94 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	95 cmd_indent = 0 # >0 when @command is found are we are parsing it
1369 dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	96
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	97 for line in doc_data:
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	98 stripped = line.strip()
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	99 if cmd_indent and line[cmd_indent : cmd_indent + 5] == " -":
1369 dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	100 colon_idx = line.find(":")
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	101 if colon_idx == -1:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	102 raise InvalidCommandSyntax(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	103 "No colon found in argument description"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	104 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	105 arg_name = line[cmd_indent + 6 : colon_idx].strip()
1369 dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	106 if not arg_name:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	107 raise InvalidCommandSyntax(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	108 "No name found in argument description"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	109 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	110 arg_help = line[colon_idx + 1 :].strip()
1369 dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	111 data["doc_arg_{}".format(arg_name)] = arg_help
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	112 elif cmd_indent:
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	113 # we are parsing command and indent level is not good, it's finished
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	114 break
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	115 elif stripped.startswith(CMD_KEY):
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	116 cmd_indent = line.find(CMD_KEY)
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	117
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	118 # type
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	119 colon_idx = stripped.find(":")
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	120 if colon_idx == -1:
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	121 raise InvalidCommandSyntax("missing colon")
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	122 type_data = stripped[len(CMD_KEY) : colon_idx].strip()
1369 dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	123 if len(type_data) == 0:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	124 type_data = "(all)"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	125 elif (
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	126 len(type_data) <= 2 or type_data[0] != "(" or type_data[-1] != ")"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	127 ):
1369 dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	128 raise InvalidCommandSyntax("Bad type data syntax")
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	129 type_ = type_data[1:-1]
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	130 if type_ not in CMD_TYPES:
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	131 raise InvalidCommandSyntax("Unknown type {}".format(type_))
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	132 data["type"] = type_
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	133
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	134 # args
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	135 data["args"] = stripped[colon_idx + 1 :].strip()
1369 dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	136 except InvalidCommandSyntax as e:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	137 log.warning(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	138 u"Invalid command syntax for command {command}: {message}".format(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	139 command=cmd_name, message=e.message
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	140 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	141 )
1369 dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	142
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	143 return data
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	144
926 d609581bf74a plugin text commands: refactoring, text now only contain main commands, and other plugin can add commands themselve: Goffi <goffi@goffi.org> parents: 922 diff changeset	145 def registerTextCommands(self, instance):
d609581bf74a plugin text commands: refactoring, text now only contain main commands, and other plugin can add commands themselve: Goffi <goffi@goffi.org> parents: 922 diff changeset	146 """ Add a text command
1369 dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	147
926 d609581bf74a plugin text commands: refactoring, text now only contain main commands, and other plugin can add commands themselve: Goffi <goffi@goffi.org> parents: 922 diff changeset	148 @param instance: instance of a class containing text commands
d609581bf74a plugin text commands: refactoring, text now only contain main commands, and other plugin can add commands themselve: Goffi <goffi@goffi.org> parents: 922 diff changeset	149 """
d609581bf74a plugin text commands: refactoring, text now only contain main commands, and other plugin can add commands themselve: Goffi <goffi@goffi.org> parents: 922 diff changeset	150 for attr in dir(instance):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	151 if attr.startswith("cmd_"):
926 d609581bf74a plugin text commands: refactoring, text now only contain main commands, and other plugin can add commands themselve: Goffi <goffi@goffi.org> parents: 922 diff changeset	152 cmd = getattr(instance, attr)
d609581bf74a plugin text commands: refactoring, text now only contain main commands, and other plugin can add commands themselve: Goffi <goffi@goffi.org> parents: 922 diff changeset	153 if not callable(cmd):
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	154 log.warning(_(u"Skipping not callable [%s] attribute") % attr)
926 d609581bf74a plugin text commands: refactoring, text now only contain main commands, and other plugin can add commands themselve: Goffi <goffi@goffi.org> parents: 922 diff changeset	155 continue
d609581bf74a plugin text commands: refactoring, text now only contain main commands, and other plugin can add commands themselve: Goffi <goffi@goffi.org> parents: 922 diff changeset	156 cmd_name = attr[4:]
d609581bf74a plugin text commands: refactoring, text now only contain main commands, and other plugin can add commands themselve: Goffi <goffi@goffi.org> parents: 922 diff changeset	157 if not cmd_name:
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 929 diff changeset	158 log.warning(_("Skipping cmd_ method"))
926 d609581bf74a plugin text commands: refactoring, text now only contain main commands, and other plugin can add commands themselve: Goffi <goffi@goffi.org> parents: 922 diff changeset	159 if cmd_name in self._commands:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	160 suff = 2
927 cd150dd947e3 plugin text-commands: fixed name conflicts management + plugin parrot: removed now done TODO Goffi <goffi@goffi.org> parents: 926 diff changeset	161 while (cmd_name + str(suff)) in self._commands:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	162 suff += 1
927 cd150dd947e3 plugin text-commands: fixed name conflicts management + plugin parrot: removed now done TODO Goffi <goffi@goffi.org> parents: 926 diff changeset	163 new_name = cmd_name + str(suff)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	164 log.warning(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	165 _(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	166 u"Conflict for command [{old_name}], renaming it to [{new_name}]"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	167 ).format(old_name=cmd_name, new_name=new_name)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	168 )
926 d609581bf74a plugin text commands: refactoring, text now only contain main commands, and other plugin can add commands themselve: Goffi <goffi@goffi.org> parents: 922 diff changeset	169 cmd_name = new_name
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	170 self._commands[cmd_name] = cmd_data = OrderedDict(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	171 {"callback": cmd}
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	172 ) # We use an Ordered dict to keep documenation order
1369 dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	173 cmd_data.update(self._parseDocString(cmd, cmd_name))
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 929 diff changeset	174 log.info(_("Registered text command [%s]") % cmd_name)
926 d609581bf74a plugin text commands: refactoring, text now only contain main commands, and other plugin can add commands themselve: Goffi <goffi@goffi.org> parents: 922 diff changeset	175
d609581bf74a plugin text commands: refactoring, text now only contain main commands, and other plugin can add commands themselve: Goffi <goffi@goffi.org> parents: 922 diff changeset	176 def addWhoIsCb(self, callback, priority=0):
d609581bf74a plugin text commands: refactoring, text now only contain main commands, and other plugin can add commands themselve: Goffi <goffi@goffi.org> parents: 922 diff changeset	177 """Add a callback which give information to the /whois command
1369 dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	178
926 d609581bf74a plugin text commands: refactoring, text now only contain main commands, and other plugin can add commands themselve: Goffi <goffi@goffi.org> parents: 922 diff changeset	179 @param callback: a callback which will be called with the following arguments
d609581bf74a plugin text commands: refactoring, text now only contain main commands, and other plugin can add commands themselve: Goffi <goffi@goffi.org> parents: 922 diff changeset	180 - whois_msg: list of information strings to display, callback need to append its own strings to it
1199 96fb74a4714d misc: fixed some typos Matteo Cypriani <mcy@lm7.fr> parents: 1171 diff changeset	181 - target_jid: full jid from whom we want information
926 d609581bf74a plugin text commands: refactoring, text now only contain main commands, and other plugin can add commands themselve: Goffi <goffi@goffi.org> parents: 922 diff changeset	182 - profile: %(doc_profile)s
d609581bf74a plugin text commands: refactoring, text now only contain main commands, and other plugin can add commands themselve: Goffi <goffi@goffi.org> parents: 922 diff changeset	183 @param priority: priority of the information to show (the highest priority will be displayed first)
d609581bf74a plugin text commands: refactoring, text now only contain main commands, and other plugin can add commands themselve: Goffi <goffi@goffi.org> parents: 922 diff changeset	184 """
d609581bf74a plugin text commands: refactoring, text now only contain main commands, and other plugin can add commands themselve: Goffi <goffi@goffi.org> parents: 922 diff changeset	185 self._whois.append((priority, callback))
928 73873e9b56f7 plugin XEP-0045: added user information to /whois text command Goffi <goffi@goffi.org> parents: 927 diff changeset	186 self._whois.sort(key=lambda item: item[0], reverse=True)
506 2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands Goffi <goffi@goffi.org> parents: diff changeset	187
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	188 def sendMessageTrigger(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	189 self, client, mess_data, pre_xml_treatments, post_xml_treatments
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	190 ):
1955 633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished): Goffi <goffi@goffi.org> parents: 1934 diff changeset	191 """Install SendMessage command hook """
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2128 diff changeset	192 pre_xml_treatments.addCallback(self._sendMessageCmdHook, client)
921 8dd168c7741c plugin text commands: refactoring: Goffi <goffi@goffi.org> parents: 811 diff changeset	193 return True
8dd168c7741c plugin text commands: refactoring: Goffi <goffi@goffi.org> parents: 811 diff changeset	194
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2128 diff changeset	195 def _sendMessageCmdHook(self, mess_data, client):
921 8dd168c7741c plugin text commands: refactoring: Goffi <goffi@goffi.org> parents: 811 diff changeset	196 """ Check text commands in message, and react consequently
1369 dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	197
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	198 msg starting with / are potential command. If a command is found, it is executed, else and help message is sent
921 8dd168c7741c plugin text commands: refactoring: Goffi <goffi@goffi.org> parents: 811 diff changeset	199 msg starting with // are escaped: they are sent with a single /
8dd168c7741c plugin text commands: refactoring: Goffi <goffi@goffi.org> parents: 811 diff changeset	200 commands can abord message sending (if they return anything evaluating to False), or continue it (if they return True), eventually after modifying the message
8dd168c7741c plugin text commands: refactoring: Goffi <goffi@goffi.org> parents: 811 diff changeset	201 an "unparsed" key is added to message, containing part of the message not yet parsed
8dd168c7741c plugin text commands: refactoring: Goffi <goffi@goffi.org> parents: 811 diff changeset	202 commands can be deferred or not
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2128 diff changeset	203 @param mess_data(dict): data comming from sendMessage trigger
1369 dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	204 @param profile: %(doc_profile)s
921 8dd168c7741c plugin text commands: refactoring: Goffi <goffi@goffi.org> parents: 811 diff changeset	205 """
1955 633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished): Goffi <goffi@goffi.org> parents: 1934 diff changeset	206 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	207 msg = mess_data["message"][""]
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	208 msg_lang = ""
1955 633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished): Goffi <goffi@goffi.org> parents: 1934 diff changeset	209 except KeyError:
633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished): Goffi <goffi@goffi.org> parents: 1934 diff changeset	210 try:
633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished): Goffi <goffi@goffi.org> parents: 1934 diff changeset	211 # we have not default message, we try to take the first found
633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished): Goffi <goffi@goffi.org> parents: 1934 diff changeset	212 msg_lang, msg = mess_data["message"].iteritems().next()
633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished): Goffi <goffi@goffi.org> parents: 1934 diff changeset	213 except StopIteration:
633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished): Goffi <goffi@goffi.org> parents: 1934 diff changeset	214 log.debug(u"No message found, skipping text commands")
633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished): Goffi <goffi@goffi.org> parents: 1934 diff changeset	215 return mess_data
633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished): Goffi <goffi@goffi.org> parents: 1934 diff changeset	216
921 8dd168c7741c plugin text commands: refactoring: Goffi <goffi@goffi.org> parents: 811 diff changeset	217 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	218 if msg[:2] == "//":
921 8dd168c7741c plugin text commands: refactoring: Goffi <goffi@goffi.org> parents: 811 diff changeset	219 # we have a double '/', it's the escape sequence
1955 633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished): Goffi <goffi@goffi.org> parents: 1934 diff changeset	220 mess_data["message"][msg_lang] = msg[1:]
921 8dd168c7741c plugin text commands: refactoring: Goffi <goffi@goffi.org> parents: 811 diff changeset	221 return mess_data
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	222 if msg[0] != "/":
921 8dd168c7741c plugin text commands: refactoring: Goffi <goffi@goffi.org> parents: 811 diff changeset	223 return mess_data
8dd168c7741c plugin text commands: refactoring: Goffi <goffi@goffi.org> parents: 811 diff changeset	224 except IndexError:
8dd168c7741c plugin text commands: refactoring: Goffi <goffi@goffi.org> parents: 811 diff changeset	225 return mess_data
8dd168c7741c plugin text commands: refactoring: Goffi <goffi@goffi.org> parents: 811 diff changeset	226
8dd168c7741c plugin text commands: refactoring: Goffi <goffi@goffi.org> parents: 811 diff changeset	227 # we have a command
8dd168c7741c plugin text commands: refactoring: Goffi <goffi@goffi.org> parents: 811 diff changeset	228 d = None
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	229 command = msg[1:].partition(" ")[0].lower()
921 8dd168c7741c plugin text commands: refactoring: Goffi <goffi@goffi.org> parents: 811 diff changeset	230 if command.isalpha():
8dd168c7741c plugin text commands: refactoring: Goffi <goffi@goffi.org> parents: 811 diff changeset	231 # looks like an actual command, we try to call the corresponding method
8dd168c7741c plugin text commands: refactoring: Goffi <goffi@goffi.org> parents: 811 diff changeset	232 def retHandling(ret):
8dd168c7741c plugin text commands: refactoring: Goffi <goffi@goffi.org> parents: 811 diff changeset	233 """ Handle command return value:
8dd168c7741c plugin text commands: refactoring: Goffi <goffi@goffi.org> parents: 811 diff changeset	234 if ret is True, normally send message (possibly modified by command)
8dd168c7741c plugin text commands: refactoring: Goffi <goffi@goffi.org> parents: 811 diff changeset	235 else, abord message sending
8dd168c7741c plugin text commands: refactoring: Goffi <goffi@goffi.org> parents: 811 diff changeset	236 """
8dd168c7741c plugin text commands: refactoring: Goffi <goffi@goffi.org> parents: 811 diff changeset	237 if ret:
8dd168c7741c plugin text commands: refactoring: Goffi <goffi@goffi.org> parents: 811 diff changeset	238 return mess_data
8dd168c7741c plugin text commands: refactoring: Goffi <goffi@goffi.org> parents: 811 diff changeset	239 else:
1963 a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	240 log.debug(u"text command detected ({})".format(command))
1052 e88bff4c8b77 core (XMPP): sendMessage refactoring: Goffi <goffi@goffi.org> parents: 1025 diff changeset	241 raise failure.Failure(exceptions.CancelError())
921 8dd168c7741c plugin text commands: refactoring: Goffi <goffi@goffi.org> parents: 811 diff changeset	242
1082 246712d2e7bc plugin XEP-0045, text_commands: add some commands: souliane <souliane@mailoo.org> parents: 1052 diff changeset	243 def genericErrback(failure):
1889 be61c5c5e474 plugin text commands: fixed log in genericErrback which was raising an exception when something than StanzaError was received Goffi <goffi@goffi.org> parents: 1766 diff changeset	244 try:
be61c5c5e474 plugin text commands: fixed log in genericErrback which was raising an exception when something than StanzaError was received Goffi <goffi@goffi.org> parents: 1766 diff changeset	245 msg = u"with condition {}".format(failure.value.condition)
be61c5c5e474 plugin text commands: fixed log in genericErrback which was raising an exception when something than StanzaError was received Goffi <goffi@goffi.org> parents: 1766 diff changeset	246 except AttributeError:
be61c5c5e474 plugin text commands: fixed log in genericErrback which was raising an exception when something than StanzaError was received Goffi <goffi@goffi.org> parents: 1766 diff changeset	247 msg = u"with error {}".format(failure.value)
1963 a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	248 self.feedBack(client, u"Command failed {}".format(msg), mess_data)
1082 246712d2e7bc plugin XEP-0045, text_commands: add some commands: souliane <souliane@mailoo.org> parents: 1052 diff changeset	249 return False
246712d2e7bc plugin XEP-0045, text_commands: add some commands: souliane <souliane@mailoo.org> parents: 1052 diff changeset	250
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	251 mess_data["unparsed"] = msg[
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	252 1 + len(command) :
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	253 ] # part not yet parsed of the message
921 8dd168c7741c plugin text commands: refactoring: Goffi <goffi@goffi.org> parents: 811 diff changeset	254 try:
1370 53c7678c27a6 plugin text commands: added _contextValid method: Goffi <goffi@goffi.org> parents: 1369 diff changeset	255 cmd_data = self._commands[command]
926 d609581bf74a plugin text commands: refactoring, text now only contain main commands, and other plugin can add commands themselve: Goffi <goffi@goffi.org> parents: 922 diff changeset	256 except KeyError:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	257 self.feedBack(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	258 client,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	259 _("Unknown command /%s. ") % command + self.HELP_SUGGESTION,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	260 mess_data,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	261 )
1963 a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	262 log.debug("text command help message")
1052 e88bff4c8b77 core (XMPP): sendMessage refactoring: Goffi <goffi@goffi.org> parents: 1025 diff changeset	263 raise failure.Failure(exceptions.CancelError())
1370 53c7678c27a6 plugin text commands: added _contextValid method: Goffi <goffi@goffi.org> parents: 1369 diff changeset	264 else:
53c7678c27a6 plugin text commands: added _contextValid method: Goffi <goffi@goffi.org> parents: 1369 diff changeset	265 if not self._contextValid(mess_data, cmd_data):
53c7678c27a6 plugin text commands: added _contextValid method: Goffi <goffi@goffi.org> parents: 1369 diff changeset	266 # The command is not launched in the right context, we throw a message with help instructions
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	267 context_txt = (
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	268 _("group discussions")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	269 if cmd_data["type"] == "group"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	270 else _("one to one discussions")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	271 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	272 feedback = _("/{command} command only applies in {context}.").format(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	273 command=command, context=context_txt
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	274 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	275 self.feedBack(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	276 client, u"{} {}".format(feedback, self.HELP_SUGGESTION), mess_data
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	277 )
1963 a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	278 log.debug("text command invalid message")
1370 53c7678c27a6 plugin text commands: added _contextValid method: Goffi <goffi@goffi.org> parents: 1369 diff changeset	279 raise failure.Failure(exceptions.CancelError())
53c7678c27a6 plugin text commands: added _contextValid method: Goffi <goffi@goffi.org> parents: 1369 diff changeset	280 else:
1963 a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	281 d = defer.maybeDeferred(cmd_data["callback"], client, mess_data)
1370 53c7678c27a6 plugin text commands: added _contextValid method: Goffi <goffi@goffi.org> parents: 1369 diff changeset	282 d.addErrback(genericErrback)
53c7678c27a6 plugin text commands: added _contextValid method: Goffi <goffi@goffi.org> parents: 1369 diff changeset	283 d.addCallback(retHandling)
921 8dd168c7741c plugin text commands: refactoring: Goffi <goffi@goffi.org> parents: 811 diff changeset	284
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	285 return (
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	286 d or mess_data
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	287 ) # if a command is detected, we should have a deferred, else we send the message normally
506 2e43c74815ad plugin text commands: Text commands is a new plugin that bring IRC-like commands Goffi <goffi@goffi.org> parents: diff changeset	288
1370 53c7678c27a6 plugin text commands: added _contextValid method: Goffi <goffi@goffi.org> parents: 1369 diff changeset	289 def _contextValid(self, mess_data, cmd_data):
53c7678c27a6 plugin text commands: added _contextValid method: Goffi <goffi@goffi.org> parents: 1369 diff changeset	290 """Tell if a command can be used in the given context
53c7678c27a6 plugin text commands: added _contextValid method: Goffi <goffi@goffi.org> parents: 1369 diff changeset	291
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2128 diff changeset	292 @param mess_data(dict): message data as given in sendMessage trigger
1370 53c7678c27a6 plugin text commands: added _contextValid method: Goffi <goffi@goffi.org> parents: 1369 diff changeset	293 @param cmd_data(dict): command data as returned by self._parseDocString
53c7678c27a6 plugin text commands: added _contextValid method: Goffi <goffi@goffi.org> parents: 1369 diff changeset	294 @return (bool): True if command can be used in this context
53c7678c27a6 plugin text commands: added _contextValid method: Goffi <goffi@goffi.org> parents: 1369 diff changeset	295 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	296 if (cmd_data["type"] == "group" and mess_data["type"] != "groupchat") or (
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	297 cmd_data["type"] == "one2one" and mess_data["type"] == "groupchat"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	298 ):
1370 53c7678c27a6 plugin text commands: added _contextValid method: Goffi <goffi@goffi.org> parents: 1369 diff changeset	299 return False
53c7678c27a6 plugin text commands: added _contextValid method: Goffi <goffi@goffi.org> parents: 1369 diff changeset	300 return True
53c7678c27a6 plugin text commands: added _contextValid method: Goffi <goffi@goffi.org> parents: 1369 diff changeset	301
926 d609581bf74a plugin text commands: refactoring, text now only contain main commands, and other plugin can add commands themselve: Goffi <goffi@goffi.org> parents: 922 diff changeset	302 def getRoomJID(self, arg, service_jid):
508 7c6609dddb2c plugin text commands: /leave management: Goffi <goffi@goffi.org> parents: 506 diff changeset	303 """Return a room jid with a shortcut
1369 dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	304
508 7c6609dddb2c plugin text commands: /leave management: Goffi <goffi@goffi.org> parents: 506 diff changeset	305 @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	306 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	307 @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	308 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	309 nb_arobas = arg.count("@")
508 7c6609dddb2c plugin text commands: /leave management: Goffi <goffi@goffi.org> parents: 506 diff changeset	310 if nb_arobas == 1:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	311 if arg[-1] != "@":
508 7c6609dddb2c plugin text commands: /leave management: Goffi <goffi@goffi.org> parents: 506 diff changeset	312 return jid.JID(arg)
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	313 return jid.JID(arg + service_jid)
508 7c6609dddb2c plugin text commands: /leave management: Goffi <goffi@goffi.org> parents: 506 diff changeset	314 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	315
1963 a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	316 def feedBack(self, client, message, mess_data, info_type=FEEDBACK_INFO_TYPE):
523 24c0d51449e7 plugin text commands: added _feedback method to send an answer to user Goffi <goffi@goffi.org> parents: 519 diff changeset	317 """Give a message back to the user"""
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	318 if mess_data["type"] == "groupchat":
1963 a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	319 to_ = mess_data["to"].userhostJID()
523 24c0d51449e7 plugin text commands: added _feedback method to send an answer to user Goffi <goffi@goffi.org> parents: 519 diff changeset	320 else:
1963 a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	321 to_ = client.jid
523 24c0d51449e7 plugin text commands: added _feedback method to send an answer to user Goffi <goffi@goffi.org> parents: 519 diff changeset	322
1963 a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	323 # we need to invert send message back, so sender need to original destinee
a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	324 mess_data["from"] = mess_data["to"]
a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	325 mess_data["to"] = to_
a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	326 mess_data["type"] = C.MESS_TYPE_INFO
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	327 mess_data["message"] = {"": message}
1963 a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	328 mess_data["extra"]["info_type"] = info_type
2152 6a004a22dd9e plugins XEP-0033, XEP-0280, text commands: fixed method renaming after client refactoring Goffi <goffi@goffi.org> parents: 2145 diff changeset	329 client.messageSendToBridge(mess_data)
523 24c0d51449e7 plugin text commands: added _feedback method to send an answer to user Goffi <goffi@goffi.org> parents: 519 diff changeset	330
1963 a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	331 def cmd_whois(self, client, mess_data):
1372 85caf0a3abb3 plugin text commands: minor docstrings improvments Goffi <goffi@goffi.org> parents: 1371 diff changeset	332 """show informations on entity
85caf0a3abb3 plugin text commands: minor docstrings improvments Goffi <goffi@goffi.org> parents: 1371 diff changeset	333
85caf0a3abb3 plugin text commands: minor docstrings improvments Goffi <goffi@goffi.org> parents: 1371 diff changeset	334 @command: [JID\|ROOM_NICK]
85caf0a3abb3 plugin text commands: minor docstrings improvments Goffi <goffi@goffi.org> parents: 1371 diff changeset	335 - JID: entity to request
85caf0a3abb3 plugin text commands: minor docstrings improvments Goffi <goffi@goffi.org> parents: 1371 diff changeset	336 - ROOM_NICK: nick of the room to request
85caf0a3abb3 plugin text commands: minor docstrings improvments Goffi <goffi@goffi.org> parents: 1371 diff changeset	337 """
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 929 diff changeset	338 log.debug("Catched whois command")
698 d731ae066158 core: sendMessage's options parameter has been renamed to extra to be consistent with newMessage Goffi <goffi@goffi.org> parents: 697 diff changeset	339
600 c5451501465b plugin text commands: basic /whois command (just show jid so far) Goffi <goffi@goffi.org> parents: 594 diff changeset	340 entity = mess_data["unparsed"].strip()
698 d731ae066158 core: sendMessage's options parameter has been renamed to extra to be consistent with newMessage Goffi <goffi@goffi.org> parents: 697 diff changeset	341
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	342 if mess_data["type"] == "groupchat":
928 73873e9b56f7 plugin XEP-0045: added user information to /whois text command Goffi <goffi@goffi.org> parents: 927 diff changeset	343 room = mess_data["to"].userhostJID()
73873e9b56f7 plugin XEP-0045: added user information to /whois text command Goffi <goffi@goffi.org> parents: 927 diff changeset	344 try:
1970 200cd707a46d plugin XEP-0045, quick_frontend + primitivus (chat): cleaning of XEP-0045 (first pass): Goffi <goffi@goffi.org> parents: 1963 diff changeset	345 if self.host.plugins["XEP-0045"].isNickInRoom(client, room, entity):
928 73873e9b56f7 plugin XEP-0045: added user information to /whois text command Goffi <goffi@goffi.org> parents: 927 diff changeset	346 entity = u"%s/%s" % (room, entity)
73873e9b56f7 plugin XEP-0045: added user information to /whois text command Goffi <goffi@goffi.org> parents: 927 diff changeset	347 except KeyError:
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 929 diff changeset	348 log.warning("plugin XEP-0045 is not present")
698 d731ae066158 core: sendMessage's options parameter has been renamed to extra to be consistent with newMessage Goffi <goffi@goffi.org> parents: 697 diff changeset	349
600 c5451501465b plugin text commands: basic /whois command (just show jid so far) Goffi <goffi@goffi.org> parents: 594 diff changeset	350 if not entity:
c5451501465b plugin text commands: basic /whois command (just show jid so far) Goffi <goffi@goffi.org> parents: 594 diff changeset	351 target_jid = mess_data["to"]
698 d731ae066158 core: sendMessage's options parameter has been renamed to extra to be consistent with newMessage Goffi <goffi@goffi.org> parents: 697 diff changeset	352 else:
600 c5451501465b plugin text commands: basic /whois command (just show jid so far) Goffi <goffi@goffi.org> parents: 594 diff changeset	353 try:
c5451501465b plugin text commands: basic /whois command (just show jid so far) Goffi <goffi@goffi.org> parents: 594 diff changeset	354 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	355 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	356 raise jid.InvalidFormat
1742 244a605623d6 complete the Exception's list when catching JID error: souliane <souliane@mailoo.org> parents: 1409 diff changeset	357 except (RuntimeError, jid.InvalidFormat, AttributeError):
1963 a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	358 self.feedBack(client, _("Invalid jid, can't whois"), mess_data)
600 c5451501465b plugin text commands: basic /whois command (just show jid so far) Goffi <goffi@goffi.org> parents: 594 diff changeset	359 return False
c5451501465b plugin text commands: basic /whois command (just show jid so far) Goffi <goffi@goffi.org> parents: 594 diff changeset	360
921 8dd168c7741c plugin text commands: refactoring: Goffi <goffi@goffi.org> parents: 811 diff changeset	361 if not target_jid.resource:
1970 200cd707a46d plugin XEP-0045, quick_frontend + primitivus (chat): cleaning of XEP-0045 (first pass): Goffi <goffi@goffi.org> parents: 1963 diff changeset	362 target_jid.resource = self.host.memory.getMainResource(client, target_jid)
921 8dd168c7741c plugin text commands: refactoring: Goffi <goffi@goffi.org> parents: 811 diff changeset	363
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	364 whois_msg = [_(u"whois for %(jid)s") % {"jid": target_jid}]
698 d731ae066158 core: sendMessage's options parameter has been renamed to extra to be consistent with newMessage Goffi <goffi@goffi.org> parents: 697 diff changeset	365
926 d609581bf74a plugin text commands: refactoring, text now only contain main commands, and other plugin can add commands themselve: Goffi <goffi@goffi.org> parents: 922 diff changeset	366 d = defer.succeed(None)
d609581bf74a plugin text commands: refactoring, text now only contain main commands, and other plugin can add commands themselve: Goffi <goffi@goffi.org> parents: 922 diff changeset	367 for ignore, callback in self._whois:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	368 d.addCallback(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	369 lambda ignore: callback(client, whois_msg, mess_data, target_jid)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	370 )
921 8dd168c7741c plugin text commands: refactoring: Goffi <goffi@goffi.org> parents: 811 diff changeset	371
8dd168c7741c plugin text commands: refactoring: Goffi <goffi@goffi.org> parents: 811 diff changeset	372 def feedBack(ignore):
1963 a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	373 self.feedBack(client, u"\n".join(whois_msg), mess_data)
921 8dd168c7741c plugin text commands: refactoring: Goffi <goffi@goffi.org> parents: 811 diff changeset	374 return False
8dd168c7741c plugin text commands: refactoring: Goffi <goffi@goffi.org> parents: 811 diff changeset	375
8dd168c7741c plugin text commands: refactoring: Goffi <goffi@goffi.org> parents: 811 diff changeset	376 d.addCallback(feedBack)
8dd168c7741c plugin text commands: refactoring: Goffi <goffi@goffi.org> parents: 811 diff changeset	377 return d
600 c5451501465b plugin text commands: basic /whois command (just show jid so far) Goffi <goffi@goffi.org> parents: 594 diff changeset	378
1369 dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	379 def _getArgsHelp(self, cmd_data):
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	380 """Return help string for args of cmd_name, according to docstring data
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	381
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	382 @param cmd_data: command data
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	383 @return (list[unicode]): help strings
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	384 """
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	385 strings = []
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	386 for doc_name, doc_help in cmd_data.iteritems():
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	387 if doc_name.startswith("doc_arg_"):
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	388 arg_name = doc_name[8:]
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	389 strings.append(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	390 u"- {name}: {doc_help}".format(name=arg_name, doc_help=_(doc_help))
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	391 )
1369 dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	392
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	393 return strings
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	394
2055 ed33cd382bf9 plugin XEP-0245: removed plugin XEP-0245: Goffi <goffi@goffi.org> parents: 1970 diff changeset	395 def cmd_me(self, client, mess_data):
ed33cd382bf9 plugin XEP-0245: removed plugin XEP-0245: Goffi <goffi@goffi.org> parents: 1970 diff changeset	396 """display a message at third person
ed33cd382bf9 plugin XEP-0245: removed plugin XEP-0245: Goffi <goffi@goffi.org> parents: 1970 diff changeset	397
ed33cd382bf9 plugin XEP-0245: removed plugin XEP-0245: Goffi <goffi@goffi.org> parents: 1970 diff changeset	398 @command (all): message
ed33cd382bf9 plugin XEP-0245: removed plugin XEP-0245: Goffi <goffi@goffi.org> parents: 1970 diff changeset	399 - message: message to show at third person
ed33cd382bf9 plugin XEP-0245: removed plugin XEP-0245: Goffi <goffi@goffi.org> parents: 1970 diff changeset	400 e.g.: "/me clenches his fist" will give "[YOUR_NICK] clenches his fist"
ed33cd382bf9 plugin XEP-0245: removed plugin XEP-0245: Goffi <goffi@goffi.org> parents: 1970 diff changeset	401 """
ed33cd382bf9 plugin XEP-0245: removed plugin XEP-0245: Goffi <goffi@goffi.org> parents: 1970 diff changeset	402 # We just ignore the command as the match is done on receiption by clients
ed33cd382bf9 plugin XEP-0245: removed plugin XEP-0245: Goffi <goffi@goffi.org> parents: 1970 diff changeset	403 return True
ed33cd382bf9 plugin XEP-0245: removed plugin XEP-0245: Goffi <goffi@goffi.org> parents: 1970 diff changeset	404
2111 98672e35d2f5 plugin text commands: added /whoami command which return current full jid Goffi <goffi@goffi.org> parents: 2055 diff changeset	405 def cmd_whoami(self, client, mess_data):
98672e35d2f5 plugin text commands: added /whoami command which return current full jid Goffi <goffi@goffi.org> parents: 2055 diff changeset	406 """give your own jid"""
98672e35d2f5 plugin text commands: added /whoami command which return current full jid Goffi <goffi@goffi.org> parents: 2055 diff changeset	407 self.feedBack(client, client.jid.full(), mess_data)
98672e35d2f5 plugin text commands: added /whoami command which return current full jid Goffi <goffi@goffi.org> parents: 2055 diff changeset	408
1963 a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	409 def cmd_help(self, client, mess_data):
1369 dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	410 """show help on available commands
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	411
1369 dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	412 @command: [cmd_name]
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	413 - cmd_name: name of the command for detailed help
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	414 """
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	415 cmd_name = mess_data["unparsed"].strip()
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	416 if cmd_name and cmd_name[0] == "/":
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	417 cmd_name = cmd_name[1:]
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	418 if cmd_name and cmd_name not in self._commands:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	419 self.feedBack(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	420 client, _(u"Invalid command name [{}]\n".format(cmd_name)), mess_data
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	421 )
1369 dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	422 cmd_name = ""
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	423 if not cmd_name:
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	424 # we show the global help
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	425 longuest = max([len(command) for command in self._commands])
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	426 help_cmds = []
517 59b32c04e105 plugin text commands: added /help command Goffi <goffi@goffi.org> parents: 515 diff changeset	427
1369 dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	428 for command in sorted(self._commands):
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	429 cmd_data = self._commands[command]
1370 53c7678c27a6 plugin text commands: added _contextValid method: Goffi <goffi@goffi.org> parents: 1369 diff changeset	430 if not self._contextValid(mess_data, cmd_data):
53c7678c27a6 plugin text commands: added _contextValid method: Goffi <goffi@goffi.org> parents: 1369 diff changeset	431 continue
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	432 spaces = (longuest - len(command)) * " "
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	433 help_cmds.append(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	434 " /{command}: {spaces} {short_help}".format(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	435 command=command,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	436 spaces=spaces,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	437 short_help=cmd_data["doc_short_help"],
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	438 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	439 )
1369 dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	440
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	441 help_mess = _(u"Text commands available:\n%s") % (u"\n".join(help_cmds),)
1369 dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	442 else:
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	443 # we show detailled help for a command
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	444 cmd_data = self._commands[cmd_name]
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	445 syntax = cmd_data["args"]
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	446 help_mess = _(u"/{name}: {short_help}\n{syntax}{args_help}").format(
dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	447 name=cmd_name,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	448 short_help=cmd_data["doc_short_help"],
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	449 syntax=_(" " * 4 + "syntax: {}\n").format(syntax) if syntax else "",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	450 args_help=u"\n".join(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	451 [u" " * 8 + "{}".format(line) for line in self._getArgsHelp(cmd_data)]
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	452 ),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	453 )
1369 dd1a148bd3d8 plugin text commands: docstring parsing for commands, and better /help command: Goffi <goffi@goffi.org> parents: 1290 diff changeset	454
1963 a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	455 self.feedBack(client, help_mess, mess_data)

Mercurial > libervia-backend

annotate sat/plugins/plugin_misc_text_commands.py @ 2686:ce1e15d59496