gui.py 49.6 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
# Copyright 2010 Le Coz Florent <louizatakk@fedoraproject.org>
#
# This file is part of Poezio.
#
# Poezio 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, version 3 of the License.
#
# Poezio 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 Poezio.  If not, see <http://www.gnu.org/licenses/>.

17 18
from gettext import (bindtextdomain, textdomain, bind_textdomain_codeset,
                     gettext as _)
19
from os.path import isfile
20

21 22
from time import sleep

23
import os
24
import re
25 26
import sys
import shlex
27
import curses
28 29
import webbrowser

30
from datetime import datetime
31 32

import common
33
import theme
34

35
import multiuserchat as muc
36
from handler import Handler
37
from config import config
38
from tab import MucTab, InfoTab, PrivateTab, RosterInfoTab
39 40
from user import User
from room import Room
41
from roster import Roster
42
from message import Message
43
from text_buffer import TextBuffer
44
from keyboard import read_char
45
from common import is_jid_the_same, jid_get_domain, jid_get_resource, is_jid
46

47 48
# http://xmpp.org/extensions/xep-0045.html#errorstatus
ERROR_AND_STATUS_CODES = {
49 50 51 52 53 54 55 56
    '401': _('A password is required'),
    '403': _('You are banned from the room'),
    '404': _('The room does\'nt exist'),
    '405': _('Your are not allowed to create a new room'),
    '406': _('A reserved nick must be used'),
    '407': _('You are not in the member list'),
    '409': _('This nickname is already in use or has been reserved'),
    '503': _('The maximum number of users has been reached'),
57 58
    }

59 60 61 62 63 64 65
SHOW_NAME = {
    'dnd': _('busy'),
    'away': _('away'),
    'xa': _('not available'),
    'chat': _('chatty'),
    '': _('available')
    }
66 67
def doupdate():
    curses.doupdate()
68

69 70
class Gui(object):
    """
71
    User interface using ncurses
72
    """
73 74 75 76
    def __init__(self, xmpp):
        self.stdscr = curses.initscr()
        self.init_curses(self.stdscr)
        self.xmpp = xmpp
77
        default_tab = InfoTab(self.stdscr, "Info") if self.xmpp.anon\
78
            else RosterInfoTab(self.stdscr, self.xmpp.roster)
79
        self.tabs = [default_tab]
80 81 82 83 84
        # a unique buffer used to store global informations
        # that are displayed in almost all tabs, in an
        # information window.
        self.information_buffer = TextBuffer()
        self.information_win_size = 2 # Todo, get this from config
85
        self.ignores = {}
86

87
        self.commands = {
88
            'help': (self.command_help, '\_o< KOIN KOIN KOIN'),
89
            'join': (self.command_join, _("Usage: /join [room_name][@server][/nick] [password]\nJoin: Join the specified room. You can specify a nickname after a slash (/). If no nickname is specified, you will use the default_nick in the configuration file. You can omit the room name: you will then join the room you\'re looking at (useful if you were kicked). You can also provide a room_name without specifying a server, the server of the room you're currently in will be used. You can also provide a password to join the room.\nExamples:\n/join room@server.tld\n/join room@server.tld/John\n/join room2\n/join /me_again\n/join\n/join room@server.tld/my_nick password\n/join / password")),
90 91 92 93 94 95 96 97
            'quit': (self.command_quit, _("Usage: /quit\nQuit: Just disconnect from the server and exit poezio.")),
            'exit': (self.command_quit, _("Usage: /exit\nExit: Just disconnect from the server and exit poezio.")),
            'next': (self.rotate_rooms_right, _("Usage: /next\nNext: Go to the next room.")),
            'n': (self.rotate_rooms_right, _("Usage: /n\nN: Go to the next room.")),
            'prev': (self.rotate_rooms_left, _("Usage: /prev\nPrev: Go to the previous room.")),
            'p': (self.rotate_rooms_left, _("Usage: /p\nP: Go to the previous room.")),
            'win': (self.command_win, _("Usage: /win <number>\nWin: Go to the specified room.")),
            'w': (self.command_win, _("Usage: /w <number>\nW: Go to the specified room.")),
98 99
            'ignore': (self.command_ignore, _("Usage: /ignore <nickname> \nIgnore: Ignore a specified nickname.")),
            'unignore': (self.command_unignore, _("Usage: /unignore <nickname>\nUnignore: Remove the specified nickname from the ignore list.")),
100 101 102 103 104 105 106
            'part': (self.command_part, _("Usage: /part [message]\n Part: disconnect from a room. You can specify an optional message.")),
            'show': (self.command_show, _("Usage: /show <availability> [status]\nShow: Change your availability and (optionaly) your status. The <availability> argument is one of \"avail, available, ok, here, chat, away, afk, dnd, busy, xa\" and the optional [message] argument will be your status message")),
            'away': (self.command_away, _("Usage: /away [message]\nAway: Sets your availability to away and (optional) sets your status message. This is equivalent to '/show away [message]'")),
            'busy': (self.command_busy, _("Usage: /busy [message]\nBusy: Sets your availability to busy and (optional) sets your status message. This is equivalent to '/show busy [message]'")),
            'avail': (self.command_avail, _("Usage: /avail [message]\nAvail: Sets your availability to available and (optional) sets your status message. This is equivalent to '/show available [message]'")),
            'available': (self.command_avail, _("Usage: /available [message]\nAvailable: Sets your availability to available and (optional) sets your status message. This is equivalent to '/show available [message]'")),
           'bookmark': (self.command_bookmark, _("Usage: /bookmark [roomname][/nick]\nBookmark: Bookmark the specified room (you will then auto-join it on each poezio start). This commands uses the same syntaxe as /join. Type /help join for syntaxe examples. Note that when typing \"/bookmark\" on its own, the room will be bookmarked with the nickname you\'re currently using in this room (instead of default_nick)")),
107
            'unquery': (self.command_unquery, _("Usage: /unquery\nClose the private conversation window")),
108 109 110
            'set': (self.command_set, _("Usage: /set <option> [value]\nSet: Sets the value to the option in your configuration file. You can, for example, change your default nickname by doing `/set default_nick toto` or your resource with `/set resource blabla`. You can also set an empty value (nothing) by providing no [value] after <option>.")),
            'kick': (self.command_kick, _("Usage: /kick <nick> [reason]\nKick: Kick the user with the specified nickname. You also can give an optional reason.")),
            'topic': (self.command_topic, _("Usage: /topic <subject> \nTopic: Change the subject of the room")),
111
            'link': (self.command_link, _("Usage: /link [option] [number]\nLink: Interact with a link in the conversation. Available options are 'open', 'copy'. Open just opens the link in the browser if it's http://, Copy just copy the link in the clipboard. An optional number can be provided, it indicates which link to interact with.")),
112
            'query': (self.command_query, _('Usage: /query <nick> [message]\nQuery: Open a private conversation with <nick>. This nick has to be present in the room you\'re currently in. If you specified a message after the nickname, it will immediately be sent to this user')),
113 114
            'nick': (self.command_nick, _("Usage: /nick <nickname>\nNick: Change your nickname in the current room")),
            'say': (self.command_say, _('Usage: /say <message>\nSay: Just send the message. Useful if you want your message to begin with a "/"')),
115
            'whois': (self.command_whois, _('Usage: /whois <nickname>\nWhois: Request many informations about the user.')),
116
            'theme': (self.command_theme, _('Usage: /theme\nTheme: Reload the theme defined in the config file.')),
117
            'recolor': (self.command_recolor, _('Usage: /recolor\nRecolor: Re-assign a color to all participants of the current room, based on the last time they talked. Use this if the participants currently talking have too many identical colors.')),
118 119
            }

120
        self.key_func = {
121 122
            "KEY_PPAGE": self.scroll_page_up,
            "KEY_NPAGE": self.scroll_page_down,
123
            "KEY_F(5)": self.rotate_rooms_left,
124
            "^P": self.rotate_rooms_left,
125
            "KEY_F(6)": self.rotate_rooms_right,
126 127
            "KEY_F(7)": self.shrink_information_win,
            "KEY_F(8)": self.grow_information_win,
128
            "^N": self.rotate_rooms_right,
129
            "KEY_RESIZE": self.resize_window,
130
            '^X': self.go_to_important_room,
131
            '^V': self.move_separator,
132 133
            }

134 135 136 137 138
        # Add handlers
        self.xmpp.add_event_handler("session_start", self.on_connected)
        self.xmpp.add_event_handler("groupchat_presence", self.on_groupchat_presence)
        self.xmpp.add_event_handler("groupchat_message", self.on_groupchat_message)
        self.xmpp.add_event_handler("message", self.on_message)
139 140
        self.xmpp.add_event_handler("presence", self.on_presence)
        self.xmpp.add_event_handler("roster_update", self.on_roster_update)
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160

    def grow_information_win(self):
        """
        """
        if self.information_win_size == 14:
            return
        self.information_win_size += 1
        for tab in self.tabs:
            tab.on_info_win_size_changed(self.information_win_size, self.stdscr)
        self.refresh_window()

    def shrink_information_win(self):
        """
        """
        if self.information_win_size == 0:
            return
        self.information_win_size -= 1
        for tab in self.tabs:
            tab.on_info_win_size_changed(self.information_win_size, self.stdscr)
        self.refresh_window()
161 162 163 164 165 166 167 168

    def on_connected(self, event):
        """
        Called when we are connected and authenticated
        """
        self.information(_("Welcome on Poezio \o/!"))
        self.information(_("Your JID is %s") % self.xmpp.fulljid)

169 170 171 172 173
        if not self.xmpp.anon:
            # request the roster
            self.xmpp.getRoster()
            # send initial presence
            self.xmpp.makePresence(pfrom=self.xmpp.jid).send()
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
        rooms = config.get('rooms', '')
        if rooms == '' or not isinstance(rooms, str):
            return
        rooms = rooms.split(':')
        for room in rooms:
            args = room.split('/')
            if args[0] == '':
                return
            roomname = args[0]
            if len(args) == 2:
                nick = args[1]
            else:
                default = os.environ.get('USER') if os.environ.get('USER') else 'poezio'
                nick = config.get('default_nick', '')
                if nick == '':
                    nick = default
            self.open_new_room(roomname, nick)
            muc.join_groupchat(self.xmpp, roomname, nick)
192
        # if not self.xmpp.anon:
193 194 195 196 197 198 199 200 201 202 203 204 205
        # Todo: SEND VCARD
        return
        if config.get('jid', '') == '': # Don't send the vcard if we're not anonymous
            self.vcard_sender.start()   # because the user ALREADY has one on the server

    def on_groupchat_presence(self, presence):
        """
        Triggered whenever a presence stanza is received from a user in a multi-user chat room.
        Display the presence on the room window and update the
        presence information of the concerned user
        """
        from_nick = presence['from'].resource
        from_room = presence['from'].bare
206
        room = self.get_room_by_name(from_room)
207 208 209 210 211
        code = presence.find('{jabber:client}status')
        status_codes = set([s.attrib['code'] for s in presence.findall('{http://jabber.org/protocol/muc#user}x/{http://jabber.org/protocol/muc#user}status')])
        # Check if it's not an error presence.
        if presence['type'] == 'error':
            return self.room_error(presence, from_room)
212
        if not room:
213
            return
214 215 216 217 218 219 220 221 222 223 224 225
        msg = None
        affiliation = presence['muc']['affiliation']
        show = presence['show']
        status = presence['status']
        role = presence['muc']['role']
        jid = presence['muc']['jid']
        typ = presence['type']
        if not room.joined:     # user in the room BEFORE us.
            # ignore redondant presence message, see bug #1509
            if from_nick not in [user.nick for user in room.users]:
                new_user = User(from_nick, affiliation, show, status, role)
                room.users.append(new_user)
226
                if from_nick == room.own_nick:
227 228
                    room.joined = True
                    new_user.color = theme.COLOR_OWN_NICK
229
                    self.add_message_to_text_buffer(room, _("Your nickname is %s") % (from_nick))
230
                    if '170' in status_codes:
231
                        self.add_message_to_text_buffer(room, 'Warning: this room is publicly logged')
232
        else:
233 234 235 236 237 238 239 240
            change_nick = '303' in status_codes
            kick = '307' in status_codes and typ == 'unavailable'
            user = room.get_user_by_name(from_nick)
            # New user
            if not user:
                self.on_user_join(room, from_nick, affiliation, show, status, role, jid)
            # nick change
            elif change_nick:
241
                self.on_user_nick_change(room, presence, user, from_nick, from_room)
242 243
            # kick
            elif kick:
244
                self.on_user_kicked(room, presence, user, from_nick)
245 246
            # user quit
            elif typ == 'unavailable':
247
                self.on_user_leave_groupchat(room, user, jid, status, from_nick, from_room)
248 249
            # status change
            else:
250
                self.on_user_change_status(room, user, from_nick, from_room, affiliation, role, show, status)
251
        self.refresh_window()
252 253
        doupdate()

254 255 256 257 258 259 260 261 262
    def on_user_join(self, room, from_nick, affiliation, show, status, role, jid):
        """
        When a new user joins a groupchat
        """
        room.users.append(User(from_nick, affiliation,
                               show, status, role))
        hide_exit_join = config.get('hide_exit_join', -1)
        if hide_exit_join != 0:
            if not jid.full:
263
                self.add_message_to_text_buffer(room, _('%(spec)s "[%(nick)s]" joined the room') % {'nick':from_nick.replace('"', '\\"'), 'spec':theme.CHAR_JOIN.replace('"', '\\"')}, colorized=True)
264
            else:
265
                self.add_message_to_text_buffer(room, _('%(spec)s "[%(nick)s]" "(%(jid)s)" joined the room') % {'spec':theme.CHAR_JOIN.replace('"', '\\"'), 'nick':from_nick.replace('"', '\\"'), 'jid':jid.full}, colorized=True)
266

267 268 269 270 271
    def on_user_nick_change(self, room, presence, user, from_nick, from_room):
        new_nick = presence.find('{http://jabber.org/protocol/muc#user}x/{http://jabber.org/protocol/muc#user}item').attrib['nick']
        if user.nick == room.own_nick:
            room.own_nick = new_nick
            # also change our nick in all private discussion of this room
272
            for _tab in self.tabs:
273 274
                if isinstance(_tab, PrivateTab) and _tab.get_name().split('/', 1)[0] == room.name:
                    _tab.get_room().own_nick = new_nick
275
        user.change_nick(new_nick)
276
        self.add_message_to_text_buffer(room, _('"[%(old)s]" is now known as "[%(new)s]"') % {'old':from_nick.replace('"', '\\"'), 'new':new_nick.replace('"', '\\"')}, colorized=True)
277 278 279
        # rename the private tabs if needed
        private_room = self.get_room_by_name('%s/%s' % (from_room, from_nick))
        if private_room:
280
            self.add_message_to_text_buffer(private_room, _('"[%(old_nick)s]" is now known as "[%(new_nick)s]"') % {'old_nick':from_nick.replace('"', '\\"'), 'new_nick':new_nick.replace('"', '\\"')}, colorized=True)
281
            new_jid = private_room.name.split('/', 1)[0]+'/'+new_nick
282
            private_room.name = new_jid
283

284 285 286 287 288 289 290
    def on_user_kicked(self, room, presence, user, from_nick):
        """
        When someone is kicked
        """
        room.users.remove(user)
        by = presence.find('{http://jabber.org/protocol/muc#user}x/{http://jabber.org/protocol/muc#user}item/{http://jabber.org/protocol/muc#user}actor')
        reason = presence.find('{http://jabber.org/protocol/muc#user}x/{http://jabber.org/protocol/muc#user}item/{http://jabber.org/protocol/muc#user}reason')
291
        by = by.attrib['jid'] if by is not None else None
292 293 294 295
        reason = reason.text# if reason else ''
        if from_nick == room.own_nick: # we are kicked
            room.disconnect()
            if by:
296
                kick_msg = _('%(spec)s [You] have been kicked by "[%(by)s]"') % {'spec': theme.CHAR_KICK.replace('"', '\\"'), 'by':by}
297
            else:
298
                kick_msg = _('%(spec)s [You] have been kicked.') % {'spec':theme.CHAR_KICK.replace('"', '\\"')}
299 300 301 302 303
            # try to auto-rejoin
            if config.get('autorejoin', 'false') == 'true':
                muc.join_groupchat(self.xmpp, room.name, room.own_nick)
        else:
            if by:
304
                kick_msg = _('%(spec)s "[%(nick)s]" has been kicked by "[%(by)s]"') % {'spec':theme.CHAR_KICK.replace('"', '\\"'), 'nick':from_nick.replace('"', '\\"'), 'by':by.replace('"', '\\"')}
305
            else:
306
                kick_msg = _('%(spec)s "[%(nick)s]" has been kicked') % {'spec':theme.CHAR_KICK, 'nick':from_nick.replace('"', '\\"')}
307 308
        if reason:
            kick_msg += _(' Reason: %(reason)s') % {'reason': reason}
309
        self.add_message_to_text_buffer(room, kick_msg, colorized=True)
310

311 312 313 314 315 316 317 318
    def on_user_leave_groupchat(self, room, user, jid, status, from_nick, from_room):
        """
        When an user leaves a groupchat
        """
        room.users.remove(user)
        hide_exit_join = config.get('hide_exit_join', -1) if config.get('hide_exit_join', -1) >= -1 else -1
        if hide_exit_join == -1 or user.has_talked_since(hide_exit_join):
            if not jid.full:
319
                leave_msg = _('%(spec)s "[%(nick)s]" has left the room') % {'nick':from_nick.replace('"', '\\"'), 'spec':theme.CHAR_QUIT.replace('"', '\\"')}
320
            else:
321
                leave_msg = _('%(spec)s "[%(nick)s]" (%(jid)s) has left the room') % {'spec':theme.CHAR_QUIT.replace('"', '\\"'), 'nick':from_nick.replace('"', '\\"'), 'jid':jid.full.replace('"', '\\"')}
322 323
            if status:
                leave_msg += ' (%s)' % status
324
            self.add_message_to_text_buffer(room, leave_msg, colorized=True)
325 326 327
        private_room = self.get_room_by_name('%s/%s' % (from_room, from_nick))
        if private_room:
            if not status:
328
                self.add_message_to_text_buffer(private_room, _('%(spec)s "[%(nick)s]" has left the room') % {'nick':from_nick.replace('"', '\\"'), 'spec':theme.CHAR_QUIT.replace('"', '\\"')}, colorized=True)
329
            else:
330
                self.add_message_to_text_buffer(private_room, _('%(spec)s "[%(nick)s]" has left the room "(%(status)s)"') % {'nick':from_nick.replace('"', '\\"'), 'spec':theme.CHAR_QUIT, 'status': status.replace('"', '\\"')}, colorized=True)
331

332 333 334 335 336
    def on_user_change_status(self, room, user, from_nick, from_room, affiliation, role, show, status):
        """
        When an user changes her status
        """
        # build the message
337 338
        display_message = False # flag to know if something significant enough
        # to be displayed has changed
339
        msg = _('"%s" changed: ')% from_nick.replace('"', '\\"')
340
        if affiliation != user.affiliation:
341
            msg += _('affiliation: %s, ') % affiliation
342
            display_message = True
343
        if role != user.role:
344
            msg += _('role: %s, ') % role
345
            display_message = True
346
        if show != user.show and show in list(SHOW_NAME.keys()):
347
            msg += _('show: %s, ') % SHOW_NAME[show]
348 349
            display_message = True
        if status and status != user.status:
350
            msg += _('status: %s, ') % status
351 352 353
            display_message = True
        if not display_message:
            return
354
        msg = msg[:-2] # remove the last ", "
355 356 357 358 359 360 361 362 363 364
        hide_status_change = config.get('hide_status_change', -1) if config.get('hide_status_change', -1) >= -1 else -1
        if (hide_status_change == -1 or \
                user.has_talked_since(hide_status_change) or\
                user.nick == room.own_nick)\
                and\
                (affiliation != user.affiliation or\
                    role != user.role or\
                    show != user.show or\
                    status != user.status):
            # display the message in the room
365
            self.add_message_to_text_buffer(room, msg, colorized=True)
366 367
        private_room = self.get_room_by_name('%s/%s' % (from_room, from_nick))
        if private_room: # display the message in private
368
            self.add_message_to_text_buffer(private_room, msg, colorized=True)
369 370 371
        # finally, effectively change the user status
        user.update(affiliation, show, status, role)

372 373 374 375 376 377 378 379 380
    def on_message(self, message):
        """
        When receiving private message from a muc OR a normal message
        (from one of our contacts)
        """
        if message['type'] == 'groupchat':
            return None
        # Differentiate both type of messages, and call the appropriate handler.
        jid_from = message['from']
381 382
        for tab in self.tabs:
            if isinstance(tab, MucTab) and tab.get_name() == jid_from.bare: # check all the MUC we are in
383
                if message['type'] == 'error':
384
                    return self.room_error(message, tab.get_room().name)
385 386
                else:
                    return self.on_groupchat_private_message(message)
387 388 389 390 391 392 393
        return self.on_normal_message(message)

    def on_groupchat_private_message(self, message):
        """
        We received a Private Message (from someone in a Muc)
        """
        jid = message['from']
394 395
        nick_from = jid.resource
        room_from = jid.bare
396 397
        room = self.get_room_by_name(jid.full) # get the tab with the private conversation
        if not room: # It's the first message we receive: create the tab
398
            room = self.open_private_window(room_from, nick_from, False)
399 400 401
            if not room:
                return
        body = message['body']
402 403
        self.add_message_to_text_buffer(room, body, None, nick_from)
        self.refresh_window()
404 405 406 407 408 409
        doupdate()

    def on_normal_message(self, message):
        """
        When receiving "normal" messages (from someone in our roster)
        """
410
        from common import debug
411
        debug('MESSAGE: %s\n' % (message))
412 413 414 415 416 417
        return

    def on_presence(self, presence):
        """
        """
        from common import debug
418
        debug('Presence: %s\n' % (presence))
419
        return
420

421 422 423 424 425 426
    def on_roster_update(self, iq):
        """
        A subscription changed, or we received a roster item
        after a roster request, etc
        """
        from common import debug
427
        debug("ROSTER UPDATE: %s\n" % (iq))
428 429 430
        for subscriber in iq['roster']['items']:
            debug("subscriber: %s\n" % (iq['roster']['items'][subscriber]['subscription']))

431 432 433 434
    def resize_window(self):
        """
        Resize the whole screen
        """
435 436 437
        for tab in self.tabs:
            tab.resize(self.stdscr)
        self.refresh_window()
438

439
    def main_loop(self):
440 441 442
        """
        main loop waiting for the user to press a key
        """
443
        self.refresh_window()
444
        while True:
445
            doupdate()
446
            char=read_char(self.stdscr)
447
            # search for keyboard shortcut
448
            if char in list(self.key_func.keys()):
449
                self.key_func[char]()
450
            else:
451
                self.do_command(char)
452

453
    def current_tab(self):
454 455 456
        """
        returns the current room, the one we are viewing
        """
457
        return self.tabs[0]
458 459

    def get_room_by_name(self, name):
460 461 462
        """
        returns the room that has this name
        """
463 464 465 466
        for tab in self.tabs:
            if (isinstance(tab, MucTab) or
                isinstance(tab, PrivateTab)) and tab.get_name() == name:
                return tab.get_room()
467
        return None
468

469
    def init_curses(self, stdscr):
470 471 472
        """
        ncurses initialization
        """
473
        theme.init_colors()
474
        curses.noecho()
475
        curses.curs_set(0)
476
        stdscr.keypad(True)
477

478
    def reset_curses(self):
479 480 481 482 483
        """
        Reset terminal capabilities to what they were before ncurses
        init
        """
        curses.echo()
484
        curses.nocbreak()
485
        curses.endwin()
486

487 488 489 490
    def refresh_window(self):
        """
        Refresh everything
        """
491 492
        self.current_tab().set_color_state(theme.COLOR_TAB_CURRENT)
        self.current_tab().refresh(self.tabs, self.information_buffer)
493

494
    def open_new_room(self, room, nick, focus=True):
495
        """
496
        Open a new MucTab containing a muc Room, using the specified nick
497
        """
498 499 500 501
        r = Room(room, nick)
        new_tab = MucTab(self.stdscr, r, self.information_win_size)
        if self.current_tab().nb == 0:
            self.tabs.append(new_tab)
502
        else:
503 504 505
            for ta in self.tabs:
                if ta.nb == 0:
                    self.tabs.insert(self.tabs.index(ta), new_tab)
506
                    break
507
        if focus:
508
            self.command_win("%s" % new_tab.nb)
509
        self.refresh_window()
510

511 512 513 514 515 516 517
    def go_to_important_room(self):
        """
        Go to the next room with activity, in this order:
        - A personal conversation with a new message
        - A Muc with an highlight
        - A Muc with any new message
        """
518 519 520
        for tab in self.tabs:
            if tab.get_color_state() == theme.COLOR_TAB_PRIVATE:
                self.command_win('%s' % tab.nb)
521
                return
522 523 524
        for tab in self.tabs:
            if tab.get_color_state() == theme.COLOR_TAB_HIGHLIGHT:
                self.command_win('%s' % tab.nb)
525
                return
526 527 528
        for tab in self.tabs:
            if tab.get_color_state() == theme.COLOR_TAB_NEW_MESSAGE:
                self.command_win('%s' % tab.nb)
529
                return
530

531
    def rotate_rooms_right(self, args=None):
532 533 534
        """
        rotate the rooms list to the right
        """
535 536 537
        self.current_tab().on_lose_focus()
        self.tabs.append(self.tabs.pop(0))
        self.current_tab().on_gain_focus()
538
        self.refresh_window()
539

540
    def rotate_rooms_left(self, args=None):
541 542 543
        """
        rotate the rooms list to the right
        """
544 545 546
        self.current_tab().on_lose_focus()
        self.tabs.insert(0, self.tabs.pop())
        self.current_tab().on_gain_focus()
547
        self.refresh_window()
548

549
    def scroll_page_down(self, args=None):
550
        self.current_tab().on_scroll_down()
551
        self.refresh_window()
552 553

    def scroll_page_up(self, args=None):
554
        self.current_tab().on_scroll_up()
555
        self.refresh_window()
556

557
    def room_error(self, error, room_name):
558 559 560
        """
        Display the error on the room window
        """
561 562 563 564 565 566
        room = self.get_room_by_name(room_name)
        msg = error['error']['type']
        condition = error['error']['condition']
        code = error['error']['code']
        body = error['error']['text']
        if not body:
567
            if code in list(ERROR_AND_STATUS_CODES.keys()):
568 569
                body = ERROR_AND_STATUS_CODES[code]
            else:
570 571
                body = condition or _('Unknown error')
        if code:
572 573
            msg = _('Error: %(code)s - %(msg)s: %(body)s') % {'msg':msg, 'body':body, 'code':code}
            self.add_message_to_text_buffer(room, msg)
574
        else:
575 576
            msg = _('Error: %(msg)s: %(body)s') % {'msg':msg, 'body':body}
            self.add_message_to_text_buffer(room, msg)
577
        if code == '401':
578 579
            msg = _('To provide a password in order to join the room, type "/join / password" (replace "password" by the real password)')
            self.add_message_to_text_buffer(room, msg)
580
        if code == '409':
581 582 583
            if config.get('alternative_nickname', '') != '':
                self.command_join('%s/%s'% (room.name, room.own_nick+config.get('alternative_nickname', '')))
            else:
584
                self.add_message_to_text_buffer(room, _('You can join the room with an other nick, by typing "/join /other_nick"'))
585
        self.refresh_window()
586

587
    def open_private_window(self, room_name, user_nick, focus=True):
588
        complete_jid = room_name+'/'+user_nick
589 590 591 592
        for tab in self.tabs: # if the room exists, focus it and return
            if isinstance(tab, PrivateTab):
                if tab.get_name() == complete_jid:
                    self.command_win('%s' % tab.nb)
593 594
                    return
        # create the new tab
595
        room = self.get_room_by_name(room_name)
596 597 598
        if not room:
            return None
        own_nick = room.own_nick
599 600
        r = Room(complete_jid, own_nick) # PrivateRoom here
        new_tab = PrivateTab(self.stdscr, r, self.information_win_size)
601
        # insert it in the rooms
602 603
        if self.current_tab().nb == 0:
            self.tabs.append(new_tab)
604
        else:
605 606 607
            for ta in self.tabs:
                if ta.nb == 0:
                    self.tabs.insert(self.tabs.index(ta), new_tab)
608 609
                    break
        if focus:               # focus the room if needed
610
            self.command_win('%s' % (new_tab.nb))
611
        # self.window.new_room(r)
612
        self.refresh_window()
613 614
        return r

615
    def on_groupchat_message(self, message):
616
        """
617
        Triggered whenever a message is received from a multi-user chat room.
618
        """
619 620
        delay_tag = message.find('{urn:xmpp:delay}delay')
        if delay_tag is not None:
621
            delayed = True
622
            date = common.datetime_tuple(delay_tag.attrib['stamp'])
623
        else:
624 625
            # We support the OLD and deprecated XEP: http://xmpp.org/extensions/xep-0091.html
            # But it sucks, please, Jabber servers, don't do this :(
626 627
            delay_tag = message.find('{jabber:x:delay}x')
            if delay_tag is not None:
628
                delayed = True
629
                date = common.datetime_tuple(delay_tag.attrib['stamp'])
630 631
            else:
                delayed = False
632
                date = None
633
        nick_from = message['mucnick']
634
        room_from = message.getMucroom()
635 636
        if message['type'] == 'error': # Check if it's an error
            return self.room_error(message, from_room)
637 638
        if nick_from == room_from:
            nick_from = None
639
        room = self.get_room_by_name(room_from)
640
        if (room_from in self.ignores) and (nick_from in self.ignores[room_from]):
641
            return
642
        room = self.get_room_by_name(room_from)
643 644
        if not room:
            self.information(_("message received for a non-existing room: %s") % (room_from))
645
            return
646 647
        body = message['body']
        subject = message['subject']
648
        if subject:
649
            if nick_from:
650
                self.add_message_to_text_buffer(room, _("%(nick)s changed the subject to: %(subject)s") % {'nick':nick_from, 'subject':subject}, time=date)
651
            else:
652
                self.add_message_to_text_buffer(room, _("The subject is: %(subject)s") % {'subject':subject}, time=date)
653
            room.topic = subject.replace('\n', '|')
654
        elif body:
655
            if body.startswith('/me '):
656
                self.add_message_to_text_buffer(room, "* "+nick_from + ' ' + body[4:], date)
657
            else:
658
                date = date if delayed == True else None
659
                self.add_message_to_text_buffer(room, body, date, nick_from)
660
        self.refresh_window()
661
        doupdate()
662

663
    def add_message_to_text_buffer(self, room, txt, time=None, nickname=None, colorized=False):
664
        """
665 666
        Add the message to the room if possible, else, add it to the Info window
        (in the Info tab of the info window in the RosterTab)
667
        """
668 669
        if not room:
            self.information('Error, trying to add a message in no room: %s' % txt)
670
        else:
671 672
            room.add_message(txt, time, nickname, colorized)
        self.refresh_window()
673

674
    def command_help(self, arg):
675 676 677
        """
        /help <command_name>
        """
678
        args = arg.split()
679
        if len(args) == 0:
680
            msg = _('Available commands are: ')
681
            for command in list(self.commands.keys()):
682
                msg += "%s " % command
683
            msg += _("\nType /help <command_name> to know what each command does")
684
        if len(args) == 1:
685
            if args[0] in list(self.commands.keys()):
686 687
                msg = self.commands[args[0]][1]
            else:
688
                msg = _('Unknown command: %s') % args[0]
689
        self.information(msg)
690

691 692 693 694
    def command_whois(self, arg):
        """
        /whois <nickname>
        """
695 696
        # TODO
        return
697 698 699 700
        # check shlex here
        try:
            args = shlex.split(arg)
        except ValueError as error:
701
            return self.information(str(error), _("Error"))
702 703
        room = self.current_room()
        if len(args) != 1:
704
            self.add_message_to_text_buffer(room, _('whois command takes exactly one argument'))
705 706 707 708 709 710 711
            return
        # check if current room is a MUC
        if room.jid or room.name == 'Info':
            return
        nickname = args[0]
        self.muc.request_vcard(room.name, nickname)

712 713 714 715
    def command_theme(self, arg):
        """
        """
        theme.reload_theme()
716
        self.resize_window()
717

718 719 720 721
    def command_recolor(self, arg):
        """
        Re-assign color to the participants of the room
        """
722 723
        tab = self.current_tab()
        if not isinstance(tab, MucTab):
724
            return
725
        room = tab.get_room()
726 727 728 729 730 731 732 733 734 735 736 737 738
        i = 0
        compare_users = lambda x: x.last_talked
        users = list(room.users)
        # search our own user, to remove it from the room
        for user in users:
            if user.nick == room.own_nick:
                users.remove(user)
        nb_color = len(theme.LIST_COLOR_NICKNAMES)
        for user in sorted(users, key=compare_users, reverse=True):
            user.color = theme.LIST_COLOR_NICKNAMES[i % nb_color]
            i+= 1
        self.refresh_window()

739
    def command_win(self, arg):
740 741 742
        """
        /win <number>
        """
743
        args = arg.split()
744
        if len(args) != 1:
745
            self.command_help('win')
746 747 748 749
            return
        try:
            nb = int(args[0])
        except ValueError:
750
            self.command_help('win')
751
            return
752
        if self.current_tab().nb == nb:
753
            return
754 755 756 757 758 759 760
        self.current_tab().on_lose_focus()
        start = self.current_tab()
        self.tabs.append(self.tabs.pop(0))
        while self.current_tab().nb != nb:
            self.tabs.append(self.tabs.pop(0))
            if self.current_tab() == start:
                self.current_tab().set_color_state(theme.COLOR_TAB_CURRENT)
761
                self.refresh_window()
762
                return
763
        self.current_tab().on_gain_focus()
764
        self.refresh_window()
765

766
    def command_kick(self, arg):
767 768 769
        """
        /kick <nick> [reason]
        """
770 771 772
        try:
            args = shlex.split(arg)
        except ValueError as error:
773 774 775
            return self.information(str(error), _("Error"))
        # TODO information message
            # return self.add_message_to_text_buffer(self.current_room(), _("Error: %s") % (error))
776
        if len(args) < 1:
777
            self.command_help('kick')
778 779 780 781 782 783
            return
        nick = args[0]
        if len(args) >= 2:
            reason = ' '.join(args[1:])
        else:
            reason = ''
784
        if not isinstance(self.current_tab(), MucTab) or not self.current_tab().get_room().joined:
785
            return
786
        roomname = self.current_tab().get_name()
787 788 789
        res = muc.eject_user(self.xmpp, roomname, nick, reason)
        if res['type'] == 'error':
            self.room_error(res, roomname)
790

791 792 793 794 795 796 797 798 799 800 801 802 803