gajim-plural/gajim/command_system/implementation/standard.py

404 lines
14 KiB
Python
Raw Normal View History

# Copyright (C) 2009-2010 Alexander Cherniuk <ts33kr@gmail.com>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
"""
Provides an actual implementation for the standard commands.
"""
2009-11-19 06:39:04 +01:00
from time import localtime, strftime
from datetime import date
from gajim.common import app
2017-06-13 23:58:06 +02:00
from gajim.common import helpers
from gajim.common.i18n import _
2018-04-23 18:32:01 +02:00
from gajim.common.const import KindConstant
2017-06-13 23:58:06 +02:00
from gajim.command_system.errors import CommandError
from gajim.command_system.framework import CommandContainer, command, doc
from gajim.command_system.mapping import generate_usage
2017-06-13 23:58:06 +02:00
from gajim.command_system.implementation.hosts import ChatCommands, PrivateChatCommands, GroupChatCommands
2018-09-16 11:37:38 +02:00
class StandardCommonCommands(CommandContainer):
"""
This command container contains standard commands which are common
to all - chat, private chat, group chat.
"""
AUTOMATIC = True
HOSTS = ChatCommands, PrivateChatCommands, GroupChatCommands
@command(overlap=True)
@doc(_("Show help on a given command or a list of available commands if -a is given"))
2018-09-18 10:14:04 +02:00
def help(self, cmd=None, all_=False):
2018-09-16 17:11:52 +02:00
if cmd:
cmd = self.get_command(cmd)
2018-09-16 17:11:52 +02:00
documentation = _(cmd.extract_documentation())
usage = generate_usage(cmd)
2009-10-04 18:56:07 +02:00
text = []
if documentation:
2009-10-04 18:56:07 +02:00
text.append(documentation)
2018-09-16 17:11:52 +02:00
if cmd.usage:
2009-10-04 18:56:07 +02:00
text.append(usage)
2009-10-04 18:56:07 +02:00
return '\n\n'.join(text)
2018-09-18 10:14:04 +02:00
if all_:
for cmd_ in self.list_commands():
names = ', '.join(cmd_.names)
description = cmd_.extract_description()
self.echo("%s - %s" % (names, description))
else:
help = self.get_command('help')
self.echo(help(self, 'help'))
@command(raw=True)
2010-03-19 02:22:17 +01:00
@doc(_("Send a message to the contact"))
def say(self, message):
self.send(message)
@command(raw=True)
2010-03-19 02:22:17 +01:00
@doc(_("Send action (in the third person) to the current chat"))
def me(self, action):
self.send("/me %s" % action)
2009-11-19 06:39:04 +01:00
@command('lastlog', overlap=True)
2010-03-19 02:22:17 +01:00
@doc(_("Show logged messages which mention given text"))
2009-11-19 06:39:04 +01:00
def grep(self, text, limit=None):
results = app.logger.search_log(self.account, self.contact.jid, text)
2009-11-19 06:39:04 +01:00
if not results:
raise CommandError(_("%s: Nothing found") % text)
if limit:
try:
results = results[len(results) - int(limit):]
except ValueError:
raise CommandError(_("Limit must be an integer"))
for row in results:
contact = row.contact_name
2009-11-19 06:39:04 +01:00
if not contact:
if row.kind == KindConstant.CHAT_MSG_SENT:
contact = app.nicks[self.account]
2009-11-19 06:39:04 +01:00
else:
contact = self.contact.name
time_obj = localtime(row.time)
date_obj = date.fromtimestamp(row.time)
2009-11-19 06:39:04 +01:00
date_ = strftime('%Y-%m-%d', time_obj)
time_ = strftime('%H:%M:%S', time_obj)
if date_obj == date.today():
formatted = "[%s] %s: %s" % (time_, contact, row.message)
2009-11-19 06:39:04 +01:00
else:
formatted = "[%s, %s] %s: %s" % (date_, time_, contact, row.message)
2009-11-19 06:39:04 +01:00
self.echo(formatted)
@command(raw=True, empty=True)
2013-08-14 14:56:15 +02:00
#Do not translate online, away, chat, xa, dnd
2010-03-19 02:22:17 +01:00
@doc(_("""
2012-07-28 20:46:11 +02:00
Set the current status
2012-09-23 21:59:26 +02:00
Status can be given as one of the following values:
online, away, chat, xa, dnd.
"""))
def status(self, status, message):
if status not in ('online', 'away', 'chat', 'xa', 'dnd'):
raise CommandError("Invalid status given")
for connection in app.connections.values():
if not app.config.get_per('accounts', connection.name,
2012-02-14 21:49:48 +01:00
'sync_with_global_status'):
continue
if connection.connected < 2:
2012-02-14 21:49:48 +01:00
continue
connection.change_status(status, message)
@command(raw=True, empty=True)
2010-03-19 02:22:17 +01:00
@doc(_("Set the current status to away"))
def away(self, message):
if not message:
message = _("Away")
2012-02-14 21:49:48 +01:00
for connection in app.connections.values():
if not app.config.get_per('accounts', connection.name,
2012-02-14 21:49:48 +01:00
'sync_with_global_status'):
continue
if connection.connected < 2:
2012-02-14 21:49:48 +01:00
continue
connection.change_status('away', message)
@command('back', raw=True, empty=True)
2010-03-19 02:22:17 +01:00
@doc(_("Set the current status to online"))
def online(self, message):
if not message:
message = _("Available")
2012-02-14 21:49:48 +01:00
for connection in app.connections.values():
if not app.config.get_per('accounts', connection.name,
2012-02-14 21:49:48 +01:00
'sync_with_global_status'):
continue
if connection.connected < 2:
2012-02-14 21:49:48 +01:00
continue
connection.change_status('online', message)
class StandardCommonChatCommands(CommandContainer):
"""
2018-06-22 00:47:29 +02:00
This command container contains standard commands, which are common
to a chat and a private chat only.
"""
AUTOMATIC = True
HOSTS = ChatCommands, PrivateChatCommands
@command
@doc(_("Clear the text window"))
def clear(self):
self.conv_textview.clear()
@command
2010-03-19 02:22:17 +01:00
@doc(_("Send a ping to the contact"))
def ping(self):
if self.account == app.ZEROCONF_ACC_NAME:
raise CommandError(_('Command is not supported for zeroconf accounts'))
2018-06-24 23:22:49 +02:00
app.connections[self.account].get_module('Ping').send_ping(self.contact)
@command
2010-08-07 16:26:12 +02:00
@doc(_("Send DTMF sequence through an open audio session"))
def dtmf(self, sequence):
if not self.audio_sid:
2010-08-07 16:26:12 +02:00
raise CommandError(_("No open audio sessions with the contact"))
for tone in sequence:
if not (tone in ("*", "#") or tone.isdigit()):
raise CommandError(_("%s is not a valid tone") % tone)
gjs = self.connection.get_jingle_session
session = gjs(self.full_jid, self.audio_sid)
content = session.get_content("audio")
content.batch_dtmf(sequence)
@command
2010-03-19 02:22:17 +01:00
@doc(_("Toggle audio session"))
2009-11-10 22:06:59 +01:00
def audio(self):
if not self.audio_available:
raise CommandError(_("Audio sessions are not available"))
# An audio session is toggled by inverting the state of the
# appropriate button.
state = self._audio_button.get_active()
self._audio_button.set_active(not state)
2009-11-10 22:06:59 +01:00
@command
2010-03-19 02:22:17 +01:00
@doc(_("Toggle video session"))
2009-11-10 22:06:59 +01:00
def video(self):
if not self.video_available:
2009-11-10 22:06:59 +01:00
raise CommandError(_("Video sessions are not available"))
# A video session is toggled by inverting the state of the
# appropriate button.
state = self._video_button.get_active()
self._video_button.set_active(not state)
2009-11-10 22:06:59 +01:00
@command(raw=True)
@doc(_("Send a message to the contact that will attract their attention"))
def attention(self, message):
self.send_message(message, process_commands=False, attention=True)
class StandardChatCommands(CommandContainer):
"""
This command container contains standard commands which are unique
to a chat.
"""
AUTOMATIC = True
2018-09-17 23:38:52 +02:00
HOSTS = (ChatCommands,)
class StandardPrivateChatCommands(CommandContainer):
"""
This command container contains standard commands which are unique
to a private chat.
"""
AUTOMATIC = True
2018-09-17 23:38:52 +02:00
HOSTS = (PrivateChatCommands,)
class StandardGroupChatCommands(CommandContainer):
"""
This command container contains standard commands which are unique
to a group chat.
"""
AUTOMATIC = True
2018-09-17 23:38:52 +02:00
HOSTS = (GroupChatCommands,)
@command
@doc(_("Clear the text window"))
def clear(self):
self.conv_textview.clear()
self.gc_count_nicknames_colors = -1
self.gc_custom_colors = {}
@command(raw=True)
2010-03-19 02:22:17 +01:00
@doc(_("Change your nickname in a group chat"))
def nick(self, new_nick):
try:
new_nick = helpers.parse_resource(new_nick)
except Exception:
raise CommandError(_("Invalid nickname"))
self.connection.join_gc(new_nick, self.room_jid, None, change_nick=True)
2009-09-15 21:59:48 +02:00
self.new_nick = new_nick
@command('query', raw=True)
2010-03-19 02:22:17 +01:00
@doc(_("Open a private chat window with a specified occupant"))
def chat(self, nick):
nicks = app.contacts.get_nick_list(self.account, self.room_jid)
if nick in nicks:
self.on_send_pm(nick=nick)
else:
raise CommandError(_("Nickname not found"))
@command('msg', raw=True)
2010-03-19 02:22:17 +01:00
@doc(_("Open a private chat window with a specified occupant and send him a message"))
def message(self, nick, a_message):
nicks = app.contacts.get_nick_list(self.account, self.room_jid)
if nick in nicks:
self.on_send_pm(nick=nick, msg=a_message)
else:
raise CommandError(_("Nickname not found"))
@command(raw=True, empty=True)
2010-03-19 02:22:17 +01:00
@doc(_("Display or change a group chat topic"))
def topic(self, new_topic):
if new_topic:
2018-07-21 12:21:48 +02:00
self.connection.get_module('MUC').set_subject(
self.room_jid, new_topic)
else:
return self.subject
@command(raw=True, empty=True)
2010-03-19 02:22:17 +01:00
@doc(_("Invite a user to a room for a reason"))
def invite(self, jid, reason):
2018-07-16 23:22:33 +02:00
self.connection.get_module('MUC').invite(self.room_jid, jid, reason)
return _("Invited %(jid)s to %(room_jid)s") % {'jid': jid,
'room_jid': self.room_jid}
@command(raw=True, empty=True)
2018-03-25 16:26:29 +02:00
@doc(_("Join a group chat given by a JID"))
def join(self, jid):
if '@' not in jid:
jid = jid + '@' + app.get_server_from_jid(self.room_jid)
app.interface.join_gc_minimal(self.account, room_jid=jid)
@command('part', 'close', raw=True, empty=True)
2010-03-19 02:22:17 +01:00
@doc(_("Leave the groupchat, optionally giving a reason, and close tab or window"))
def leave(self, reason):
self.parent_win.remove_tab(self, self.parent_win.CLOSE_COMMAND, reason)
@command(raw=True, empty=True)
2010-03-19 02:22:17 +01:00
@doc(_("""
2018-03-25 16:26:29 +02:00
Ban user by a nick or a JID from a groupchat
2018-03-25 16:26:29 +02:00
If given nickname is not found it will be treated as a JID.
"""))
2018-07-21 12:21:48 +02:00
def ban(self, who, reason=''):
if who in app.contacts.get_nick_list(self.account, self.room_jid):
contact = app.contacts.get_gc_contact(self.account, self.room_jid, who)
who = contact.jid
2018-07-21 12:21:48 +02:00
self.connection.get_module('MUC').set_affiliation(
self.room_jid,
{who: {'affiliation': 'outcast',
'reason': reason}})
@command(raw=True, empty=True)
2010-03-19 02:22:17 +01:00
@doc(_("Kick user by a nick from a groupchat"))
def kick(self, who, reason):
if not who in app.contacts.get_nick_list(self.account, self.room_jid):
raise CommandError(_("Nickname not found"))
2018-07-21 12:21:48 +02:00
self.connection.get_module('MUC').set_role(
self.room_jid, who, 'none', reason or str())
@command(raw=True)
2013-08-14 14:56:15 +02:00
#Do not translate moderator, participant, visitor, none
@doc(_("""Set occupant role in group chat.
Role can be given as one of the following values:
moderator, participant, visitor, none"""))
def role(self, who, role):
if role not in ('moderator', 'participant', 'visitor', 'none'):
raise CommandError(_("Invalid role given"))
if not who in app.contacts.get_nick_list(self.account, self.room_jid):
raise CommandError(_("Nickname not found"))
2018-07-21 12:21:48 +02:00
self.connection.get_module('MUC').set_role(self.room_jid, who, role)
@command(raw=True)
2013-08-14 14:56:15 +02:00
#Do not translate owner, admin, member, outcast, none
@doc(_("""Set occupant affiliation in group chat.
Affiliation can be given as one of the following values:
owner, admin, member, outcast, none"""))
def affiliate(self, who, affiliation):
if affiliation not in ('owner', 'admin', 'member', 'outcast', 'none'):
raise CommandError(_("Invalid affiliation given"))
2018-07-21 12:21:48 +02:00
if who not in app.contacts.get_nick_list(self.account, self.room_jid):
raise CommandError(_("Nickname not found"))
contact = app.contacts.get_gc_contact(self.account, self.room_jid, who)
2018-07-21 12:21:48 +02:00
self.connection.get_module('MUC').set_affiliation(
self.room_jid,
{contact.jid: {'affiliation': affiliation}})
@command
2010-03-19 02:22:17 +01:00
@doc(_("Display names of all group chat occupants"))
def names(self, verbose=False):
ggc = app.contacts.get_gc_contact
gnl = app.contacts.get_nick_list
2010-08-07 15:38:05 +02:00
get_contact = lambda nick: ggc(self.account, self.room_jid, nick)
get_role = lambda nick: get_contact(nick).role
nicks = gnl(self.account, self.room_jid)
2010-08-07 15:38:05 +02:00
nicks = sorted(nicks)
nicks = sorted(nicks, key=get_role)
2010-08-07 15:38:05 +02:00
if not verbose:
return ", ".join(nicks)
2010-08-07 15:38:05 +02:00
for nick in nicks:
contact = get_contact(nick)
role = helpers.get_uf_role(contact.role)
affiliation = helpers.get_uf_affiliation(contact.affiliation)
self.echo("%s - %s - %s" % (nick, role, affiliation))
@command('ignore', raw=True)
2010-03-19 02:22:17 +01:00
@doc(_("Forbid an occupant to send you public or private messages"))
def block(self, who):
self.on_block(None, who)
@command('unignore', raw=True)
2010-03-19 02:22:17 +01:00
@doc(_("Allow an occupant to send you public or private messages"))
def unblock(self, who):
self.on_unblock(None, who)
@command
@doc(_("Send a ping to the contact"))
def ping(self, nick):
if self.account == app.ZEROCONF_ACC_NAME:
raise CommandError(_('Command is not supported for zeroconf accounts'))
gc_c = app.contacts.get_gc_contact(self.account, self.room_jid, nick)
2018-06-24 23:22:49 +02:00
app.connections[self.account].get_module('Ping').send_ping(gc_c)