312 lines
11 KiB
Python
312 lines
11 KiB
Python
# Copyright (C) 2009 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.
|
|
"""
|
|
|
|
from time import localtime, strftime
|
|
from datetime import date
|
|
|
|
import dialogs
|
|
from common import gajim
|
|
from common import helpers
|
|
from common.exceptions import GajimGeneralException
|
|
from common.logger import Constants
|
|
|
|
from ..errors import CommandError
|
|
from ..framework import CommandContainer, command, documentation
|
|
from ..mapping import generate_usage
|
|
|
|
from hosts import ChatCommands, PrivateChatCommands, GroupChatCommands
|
|
|
|
# This holds constants fron the logger, which we'll be using in some of our
|
|
# commands.
|
|
lc = Constants()
|
|
|
|
class StandardCommonCommands(CommandContainer):
|
|
"""
|
|
This command container contains standard commands which are common to all -
|
|
chat, private chat, group chat.
|
|
"""
|
|
|
|
HOSTS = (ChatCommands, PrivateChatCommands, GroupChatCommands)
|
|
|
|
@command
|
|
@documentation(_("Clear the text window"))
|
|
def clear(self):
|
|
self.conv_textview.clear()
|
|
|
|
@command
|
|
@documentation(_("Hide the chat buttons"))
|
|
def compact(self):
|
|
new_status = not self.hide_chat_buttons
|
|
self.chat_buttons_set_visible(new_status)
|
|
|
|
@command(overlap=True)
|
|
@documentation(_("Show help on a given command or a list of available commands if -(-a)ll is given"))
|
|
def help(self, command=None, all=False):
|
|
if command:
|
|
command = self.get_command(command)
|
|
|
|
documentation = _(command.extract_documentation())
|
|
usage = generate_usage(command)
|
|
|
|
text = []
|
|
|
|
if documentation:
|
|
text.append(documentation)
|
|
if command.usage:
|
|
text.append(usage)
|
|
|
|
return '\n\n'.join(text)
|
|
elif all:
|
|
for command in self.list_commands():
|
|
names = ', '.join(command.names)
|
|
description = command.extract_description()
|
|
|
|
self.echo("%s - %s" % (names, description))
|
|
else:
|
|
help = self.get_command('help')
|
|
self.echo(help(self, 'help'))
|
|
|
|
@command(raw=True)
|
|
@documentation(_("Send a message to the contact"))
|
|
def say(self, message):
|
|
self.send(message)
|
|
|
|
@command(raw=True)
|
|
@documentation(_("Send action (in the third person) to the current chat"))
|
|
def me(self, action):
|
|
self.send("/me %s" % action)
|
|
|
|
@command('lastlog', overlap=True)
|
|
@documentation(_("Show logged messages which mention given text"))
|
|
def grep(self, text, limit=None):
|
|
results = gajim.logger.get_search_results_for_query(self.contact.jid,
|
|
text, self.account)
|
|
|
|
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, time, kind, show, message, subject = row
|
|
|
|
if not contact:
|
|
if kind == lc.KIND_CHAT_MSG_SENT:
|
|
contact = gajim.nicks[self.account]
|
|
else:
|
|
contact = self.contact.name
|
|
|
|
time_obj = localtime(time)
|
|
date_obj = date.fromtimestamp(time)
|
|
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, message)
|
|
else:
|
|
formatted = "[%s, %s] %s: %s" % (date_, time_, contact, message)
|
|
|
|
self.echo(formatted)
|
|
|
|
class StandardChatCommands(CommandContainer):
|
|
"""
|
|
This command container contains standard command which are unique to a chat.
|
|
"""
|
|
|
|
HOSTS = (ChatCommands,)
|
|
|
|
@command
|
|
@documentation(_("Send a ping to the contact"))
|
|
def ping(self):
|
|
if self.account == gajim.ZEROCONF_ACC_NAME:
|
|
raise CommandError(_('Command is not supported for zeroconf accounts'))
|
|
gajim.connections[self.account].sendPing(self.contact)
|
|
|
|
@command('dtmf')
|
|
@documentation(_("Sends DTMF events through an open audio session"))
|
|
def dtmf(self, events):
|
|
if not self.audio_sid:
|
|
raise CommandError(_("There is no open audio session with this contact"))
|
|
# Valid values for DTMF tones are *, # or a number
|
|
events = [event for event in events
|
|
if event in ('*', '#') or event.isdigit()]
|
|
if events:
|
|
session = gajim.connections[self.account].get_jingle_session(
|
|
self.contact.get_full_jid(), self.audio_sid)
|
|
content = session.get_content('audio')
|
|
content.batch_dtmf(events)
|
|
else:
|
|
raise CommandError(_("No valid DTMF event specified"))
|
|
|
|
@command('audio')
|
|
@documentation(_("Toggle audio session"))
|
|
def audio(self):
|
|
if self.audio_state == self.JINGLE_STATE_NOT_AVAILABLE:
|
|
raise CommandError(_("Video sessions are not available"))
|
|
else:
|
|
# A state of an audio session is toggled by inverting a state of the
|
|
# appropriate button.
|
|
state = self._audio_button.get_active()
|
|
self._audio_button.set_active(not state)
|
|
|
|
@command('video')
|
|
@documentation(_("Toggle video session"))
|
|
def video(self):
|
|
if self.video_state == self.JINGLE_STATE_NOT_AVAILABLE:
|
|
raise CommandError(_("Video sessions are not available"))
|
|
else:
|
|
# A state of a video session is toggled by inverting a state of the
|
|
# appropriate button.
|
|
state = self._video_button.get_active()
|
|
self._video_button.set_active(not state)
|
|
|
|
class StandardPrivateChatCommands(CommandContainer):
|
|
"""
|
|
This command container contains standard command which are unique to a
|
|
private chat.
|
|
"""
|
|
|
|
HOSTS = (PrivateChatCommands,)
|
|
|
|
class StandardGroupchatCommands(CommandContainer):
|
|
"""
|
|
This command container contains standard command which are unique to a group
|
|
chat.
|
|
"""
|
|
|
|
HOSTS = (GroupChatCommands,)
|
|
|
|
@command(raw=True)
|
|
@documentation(_("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)
|
|
self.new_nick = new_nick
|
|
|
|
@command('query', raw=True)
|
|
@documentation(_("Open a private chat window with a specified occupant"))
|
|
def chat(self, nick):
|
|
nicks = gajim.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)
|
|
@documentation(_("Open a private chat window with a specified occupant and send him a message"))
|
|
def message(self, nick, a_message):
|
|
nicks = gajim.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)
|
|
@documentation(_("Display or change a group chat topic"))
|
|
def topic(self, new_topic):
|
|
if new_topic:
|
|
self.connection.send_gc_subject(self.room_jid, new_topic)
|
|
else:
|
|
return self.subject
|
|
|
|
@command(raw=True, empty=True)
|
|
@documentation(_("Invite a user to a room for a reason"))
|
|
def invite(self, jid, reason):
|
|
self.connection.send_invite(self.room_jid, jid, reason)
|
|
return _("Invited %s to %s") % (jid, self.room_jid)
|
|
|
|
@command(raw=True, empty=True)
|
|
@documentation(_("Join a group chat given by a jid, optionally using given nickname"))
|
|
def join(self, jid, nick):
|
|
if not nick:
|
|
nick = self.nick
|
|
|
|
if '@' not in jid:
|
|
jid = jid + '@' + gajim.get_server_from_jid(self.room_jid)
|
|
|
|
try:
|
|
gajim.interface.instances[self.account]['join_gc'].window.present()
|
|
except KeyError:
|
|
try:
|
|
dialogs.JoinGroupchatWindow(account=self.account, room_jid=jid, nick=nick)
|
|
except GajimGeneralException:
|
|
pass
|
|
|
|
@command('part', 'close', raw=True, empty=True)
|
|
@documentation(_("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)
|
|
@documentation(_("""
|
|
Ban user by a nick or a jid from a groupchat
|
|
|
|
If given nickname is not found it will be treated as a jid.
|
|
"""))
|
|
def ban(self, who, reason):
|
|
if who in gajim.contacts.get_nick_list(self.account, self.room_jid):
|
|
contact = gajim.contacts.get_gc_contact(self.account, self.room_jid, who)
|
|
who = contact.jid
|
|
self.connection.gc_set_affiliation(self.room_jid, who, 'outcast', reason or str())
|
|
|
|
@command(raw=True, empty=True)
|
|
@documentation(_("Kick user by a nick from a groupchat"))
|
|
def kick(self, who, reason):
|
|
if not who in gajim.contacts.get_nick_list(self.account, self.room_jid):
|
|
raise CommandError(_("Nickname not found"))
|
|
self.connection.gc_set_role(self.room_jid, who, 'none', reason or str())
|
|
|
|
@command
|
|
@documentation(_("Display names of all group chat occupants"))
|
|
def names(self, verbose=False):
|
|
get_contact = lambda nick: gajim.contacts.get_gc_contact(self.account, self.room_jid, nick)
|
|
nicks = gajim.contacts.get_nick_list(self.account, self.room_jid)
|
|
|
|
# First we do alpha-numeric sort and then role-based one.
|
|
nicks.sort()
|
|
nicks.sort(key=lambda nick: get_contact(nick).role)
|
|
|
|
if verbose:
|
|
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))
|
|
else:
|
|
return ', '.join(nicks)
|
|
|
|
@command('ignore', raw=True)
|
|
@documentation(_("Forbid an occupant to send you public or private messages"))
|
|
def block(self, who):
|
|
self.on_block(None, who)
|
|
|
|
@command('unignore', raw=True)
|
|
@documentation(_("Allow an occupant to send you public or private messages"))
|
|
def unblock(self, who):
|
|
self.on_unblock(None, who)
|