""" Global commands which are to be linked to the Core class """ import logging log = logging.getLogger(__name__) import os from datetime import datetime from xml.etree import cElementTree as ET from slixmpp.xmlstream.stanzabase import StanzaBase from slixmpp.xmlstream.handler import Callback from slixmpp.xmlstream.matcher import StanzaPath import common import fixes import pep import tabs from bookmarks import Bookmark from common import safeJID from config import config, DEFAULT_CONFIG, options as config_opts import multiuserchat as muc from plugin import PluginConfig from roster import roster from theming import dump_tuple, get_theme from decorators import command_args_parser from . structs import Command, possible_show @command_args_parser.quoted(0, 1) def command_help(self, args): """ /help [command_name] """ if not args: color = dump_tuple(get_theme().COLOR_HELP_COMMANDS) acc = [] buff = ['Global commands:'] for command in self.commands: if isinstance(self.commands[command], Command): acc.append(' \x19%s}%s\x19o - %s' % ( color, command, self.commands[command].short)) else: acc.append(' \x19%s}%s\x19o' % (color, command)) acc = sorted(acc) buff.extend(acc) acc = [] buff.append('Tab-specific commands:') commands = self.current_tab().commands for command in commands: if isinstance(commands[command], Command): acc.append(' \x19%s}%s\x19o - %s' % ( color, command, commands[command].short)) else: acc.append(' \x19%s}%s\x19o' % (color, command)) acc = sorted(acc) buff.extend(acc) msg = '\n'.join(buff) msg += "\nType /help to know what each command does" else: command = args[0].lstrip('/').strip() if command in self.current_tab().commands: tup = self.current_tab().commands[command] elif command in self.commands: tup = self.commands[command] else: self.information('Unknown command: %s' % command, 'Error') return if isinstance(tup, Command): msg = 'Usage: /%s %s\n' % (command, tup.usage) msg += tup.desc else: msg = tup[1] self.information(msg, 'Help') @command_args_parser.quoted(1) def command_runkey(self, args): """ /runkey """ def replace_line_breaks(key): "replace ^J with \n" if key == '^J': return '\n' return key if args is None: return self.command_help('runkey') char = args[0] func = self.key_func.get(char, None) if func: func() else: res = self.do_command(replace_line_breaks(char), False) if res: self.refresh_window() @command_args_parser.quoted(1, 1, [None]) def command_status(self, args): """ /status [msg] """ if args is None: return self.command_help('status') if not args[0] in possible_show.keys(): return self.command_help('status') show = possible_show[args[0]] msg = args[1] pres = self.xmpp.make_presence() if msg: pres['status'] = msg pres['type'] = show self.events.trigger('send_normal_presence', pres) pres.send() current = self.current_tab() is_muctab = isinstance(current, tabs.MucTab) if is_muctab and current.joined and show in ('away', 'xa'): current.send_chat_state('inactive') for tab in self.tabs: if isinstance(tab, tabs.MucTab) and tab.joined: muc.change_show(self.xmpp, tab.name, tab.own_nick, show, msg) if hasattr(tab, 'directed_presence'): del tab.directed_presence self.set_status(show, msg) if is_muctab and current.joined and show not in ('away', 'xa'): current.send_chat_state('active') @command_args_parser.quoted(1, 2, [None, None]) def command_presence(self, args): """ /presence [type] [status] """ if args is None: return self.command_help('presence') jid, type, status = args[0], args[1], args[2] if jid == '.' and isinstance(self.current_tab(), tabs.ChatTab): jid = self.current_tab().name if type == 'available': type = None try: pres = self.xmpp.make_presence(pto=jid, ptype=type, pstatus=status) self.events.trigger('send_normal_presence', pres) pres.send() except: self.information('Could not send directed presence', 'Error') log.debug('Could not send directed presence to %s', jid, exc_info=True) return tab = self.get_tab_by_name(jid) if tab: if type in ('xa', 'away'): tab.directed_presence = False chatstate = 'inactive' else: tab.directed_presence = True chatstate = 'active' if tab == self.current_tab(): tab.send_chat_state(chatstate, True) if isinstance(tab, tabs.MucTab): for private in tab.privates: private.directed_presence = tab.directed_presence if self.current_tab() in tab.privates: self.current_tab().send_chat_state(chatstate, True) @command_args_parser.quoted(1) def command_theme(self, args=None): """/theme """ if args is None: return self.command_help('theme') self.command_set('theme %s' % (args[0],)) @command_args_parser.quoted(1) def command_win(self, args): """ /win """ if args is None: return self.command_help('win') nb = args[0] try: nb = int(nb) except ValueError: pass if self.current_tab_nb == nb: return self.previous_tab_nb = self.current_tab_nb old_tab = self.current_tab() if isinstance(nb, int): if 0 <= nb < len(self.tabs): if not self.tabs[nb]: return self.current_tab_nb = nb else: matchs = [] for tab in self.tabs: for name in tab.matching_names(): if nb.lower() in name[1].lower(): matchs.append((name[0], tab)) self.current_tab_nb = tab.nb if not matchs: return tab = min(matchs, key=lambda m: m[0])[1] self.current_tab_nb = tab.nb old_tab.on_lose_focus() self.current_tab().on_gain_focus() self.refresh_window() @command_args_parser.quoted(2) def command_move_tab(self, args): """ /move_tab old_pos new_pos """ if args is None: return self.command_help('move_tab') current_tab = self.current_tab() if args[0] == '.': args[0] = current_tab.nb if args[1] == '.': args[1] = current_tab.nb def get_nb_from_value(value): "parse the cmdline to guess the tab the users wants" ref = None try: ref = int(value) except ValueError: old_tab = None for tab in self.tabs: if not old_tab and value == tab.name: old_tab = tab if not old_tab: self.information("Tab %s does not exist" % args[0], "Error") return None ref = old_tab.nb return ref old = get_nb_from_value(args[0]) new = get_nb_from_value(args[1]) if new is None or old is None: return self.information('Unable to move the tab.', 'Info') result = self.insert_tab(old, new) if not result: self.information('Unable to move the tab.', 'Info') else: self.current_tab_nb = self.tabs.index(current_tab) self.refresh_window() @command_args_parser.quoted(0, 1) def command_list(self, args): """ /list [server] Opens a MucListTab containing the list of the room in the specified server """ if args is None: return self.command_help('list') elif args: server = safeJID(args[0]) else: if not isinstance(self.current_tab(), tabs.MucTab): return self.information('Please provide a server', 'Error') server = safeJID(self.current_tab().name).server list_tab = tabs.MucListTab(server) self.add_tab(list_tab, True) cb = list_tab.on_muc_list_item_received self.xmpp.plugin['xep_0030'].get_items(jid=server, callback=cb) @command_args_parser.quoted(1) def command_version(self, args): """ /version """ def callback(res): "Callback for /version" if not res: return self.information('Could not get the software' ' version from %s' % jid, 'Warning') version = '%s is running %s version %s on %s' % ( jid, res.get('name') or 'an unknown software', res.get('version') or 'unknown', res.get('os') or 'an unknown platform') self.information(version, 'Info') if args is None: return self.command_help('version') jid = safeJID(args[0]) if jid.resource or jid not in roster: fixes.get_version(self.xmpp, jid, callback=callback) elif jid in roster: for resource in roster[jid].resources: fixes.get_version(self.xmpp, resource.jid, callback=callback) else: fixes.get_version(self.xmpp, jid, callback=callback) @command_args_parser.quoted(0, 2) def command_join(self, args, histo_length=None): """ /join [room][/nick] [password] """ password = None if len(args) == 0: tab = self.current_tab() if not isinstance(tab, (tabs.MucTab, tabs.PrivateTab)): return room = safeJID(tab.name).bare nick = tab.own_nick else: if args[0].startswith('@'): # we try to join a server directly server_root = True info = safeJID(args[0][1:]) else: info = safeJID(args[0]) server_root = False if info == '' and len(args[0]) > 1 and args[0][0] == '/': nick = args[0][1:] elif info.resource == '': nick = self.own_nick else: nick = info.resource if info.bare == '': # happens with /join /nickname, which is OK tab = self.current_tab() if not isinstance(tab, tabs.MucTab): return room = tab.name if nick == '': nick = tab.own_nick else: room = info.bare # no server is provided, like "/join hello": # use the server of the current room if available # check if the current room's name has a server if room.find('@') == -1 and not server_root: if isinstance(self.current_tab(), tabs.MucTab) and\ self.current_tab().name.find('@') != -1: domain = safeJID(self.current_tab().name).domain room += '@%s' % domain else: room = args[0] room = room.lower() if room in self.pending_invites: del self.pending_invites[room] tab = self.get_tab_by_name(room, tabs.MucTab) if len(args) == 2: # a password is provided password = args[1] if tab and tab.joined: # if we are already in the room self.focus_tab_named(tab.name) if tab.own_nick == nick: self.information('/join: Nothing to do.', 'Info') else: tab.own_nick = nick tab.command_cycle('') return if room.startswith('@'): room = room[1:] current_status = self.get_status() if not histo_length: histo_length = config.get('muc_history_length') if histo_length == -1: histo_length = None if histo_length is not None: histo_length = str(histo_length) if password is None: # try to use a saved password password = config.get_by_tabname('password', room, fallback=False) if tab and not tab.joined: if tab.last_connection: if tab.last_connection is not None: delta = datetime.now() - tab.last_connection seconds = delta.seconds + delta.days * 24 * 3600 else: seconds = 0 seconds = int(seconds) else: seconds = 0 if password: tab.password = password muc.join_groupchat(self, room, nick, password, histo_length, current_status.message, current_status.show, seconds=seconds) if not tab: self.open_new_room(room, nick, password=password) muc.join_groupchat(self, room, nick, password, histo_length, current_status.message, current_status.show) else: tab.own_nick = nick tab.users = [] if tab and tab.joined: self.enable_private_tabs(room) tab.state = "normal" if tab == self.current_tab(): tab.refresh() self.doupdate() @command_args_parser.quoted(0, 2) def command_bookmark_local(self, args): """ /bookmark_local [room][/nick] [password] """ if not args and not isinstance(self.current_tab(), tabs.MucTab): return password = args[1] if len(args) > 1 else None jid = args[0] if args else None _add_bookmark(self, jid, True, password, 'local') @command_args_parser.quoted(0, 3) def command_bookmark(self, args): """ /bookmark [room][/nick] [autojoin] [password] """ if not args and not isinstance(self.current_tab(), tabs.MucTab): return jid = args[0] if args else '' password = args[2] if len(args) > 2 else None if not config.get('use_remote_bookmarks'): return _add_bookmark(self, jid, True, password, 'local') if len(args) > 1: autojoin = False if args[1].lower() != 'true' else True else: autojoin = True _add_bookmark(self, jid, autojoin, password, 'remote') def _add_bookmark(self, jid, autojoin, password, method): nick = None if not jid: tab = self.current_tab() roomname = tab.name if tab.joined and tab.own_nick != self.own_nick: nick = tab.own_nick if password is None and tab.password is not None: password = tab.password elif jid == '*': return _add_wildcard_bookmarks(self, method) else: info = safeJID(jid) roomname, nick = info.bare, info.resource if roomname == '': if not isinstance(self.current_tab(), tabs.MucTab): return roomname = self.current_tab().name bookmark = self.bookmarks[roomname] if bookmark is None: bookmark = Bookmark(roomname) self.bookmarks.append(bookmark) bookmark.method = method bookmark.autojoin = autojoin if nick: bookmark.nick = nick if password: bookmark.password = password def callback(iq): if iq["type"] != "error": self.information('Bookmark added.', 'Info') else: self.information("Could not add the bookmarks.", "Info") self.bookmarks.save_local() self.bookmarks.save_remote(self.xmpp, callback) def _add_wildcard_bookmarks(self, method): new_bookmarks = [] for tab in self.get_tabs(tabs.MucTab): bookmark = self.bookmarks[tab.name] if not bookmark: bookmark = Bookmark(tab.name, autojoin=True, method=method) new_bookmarks.append(bookmark) else: bookmark.method = method new_bookmarks.append(bookmark) self.bookmarks.remove(bookmark) new_bookmarks.extend(self.bookmarks.bookmarks) self.bookmarks.set(new_bookmarks) def _cb(iq): if iq["type"] != "error": self.information("Bookmarks saved.", "Info") else: self.information("Could not save the remote bookmarks.", "Info") self.bookmarks.save_local() self.bookmarks.save_remote(self.xmpp, _cb) @command_args_parser.ignored def command_bookmarks(self): """/bookmarks""" tab = self.get_tab_by_name('Bookmarks', tabs.BookmarksTab) old_tab = self.current_tab() if tab: self.current_tab_nb = tab.nb else: tab = tabs.BookmarksTab(self.bookmarks) self.tabs.append(tab) self.current_tab_nb = tab.nb old_tab.on_lose_focus() tab.on_gain_focus() self.refresh_window() @command_args_parser.quoted(0, 1) def command_remove_bookmark(self, args): """/remove_bookmark [jid]""" def cb(success): if success: self.information('Bookmark deleted', 'Info') else: self.information('Error while deleting the bookmark', 'Error') if not args: tab = self.current_tab() if isinstance(tab, tabs.MucTab) and self.bookmarks[tab.name]: self.bookmarks.remove(tab.name) self.bookmarks.save(self.xmpp, callback=cb) else: self.information('No bookmark to remove', 'Info') else: if self.bookmarks[args[0]]: self.bookmarks.remove(args[0]) self.bookmarks.save(self.xmpp, callback=cb) else: self.information('No bookmark to remove', 'Info') @command_args_parser.quoted(0, 3) def command_set(self, args): """ /set [module|][section]