gui.py 53.7 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, ConversationTab
39 40
from user import User
from room import Room
41
from roster import Roster
42
from contact import Contact
43
from message import Message
44
from text_buffer import TextBuffer
45
from keyboard import read_char
46
from common import is_jid_the_same, jid_get_domain, jid_get_resource, is_jid
47

48
from common import debug
49 50
# http://xmpp.org/extensions/xep-0045.html#errorstatus
ERROR_AND_STATUS_CODES = {
51 52 53 54 55 56 57 58
    '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'),
59 60
    }

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

71 72
class Gui(object):
    """
73
    User interface using ncurses
74
    """
75 76 77 78
    def __init__(self, xmpp):
        self.stdscr = curses.initscr()
        self.init_curses(self.stdscr)
        self.xmpp = xmpp
79
        default_tab = InfoTab(self.stdscr, "Info") if self.xmpp.anon\
80
            else RosterInfoTab(self.stdscr)
81
        self.tabs = [default_tab]
82
        self.roster = Roster()
83 84 85 86 87
        # 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
88
        self.ignores = {}
89

90
        self.commands = {
91
            'help': (self.command_help, '\_o< KOIN KOIN KOIN'),
92
            '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")),
93 94 95 96 97 98 99 100
            '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.")),
101 102
            '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.")),
103 104 105 106 107 108 109
            '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)")),
110
            'unquery': (self.command_unquery, _("Usage: /unquery\nClose the private conversation window")),
111 112 113
            '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")),
114
            '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.")),
115
            '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')),
116 117
            '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 "/"')),
118
            'whois': (self.command_whois, _('Usage: /whois <nickname>\nWhois: Request many informations about the user.')),
119
            'theme': (self.command_theme, _('Usage: /theme\nTheme: Reload the theme defined in the config file.')),
120
            '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.')),
121 122
            }

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

137 138 139 140 141
        # 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)
142 143
        self.xmpp.add_event_handler("got_online" , self.on_got_online)
        self.xmpp.add_event_handler("got_offline" , self.on_got_offline)
144
        self.xmpp.add_event_handler("roster_update", self.on_roster_update)
145
        # self.xmpp.add_event_handler("presence", self.on_presence)
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165

    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()
166

167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
    def on_got_offline(self, presence):
        jid = presence['from']
        contact = self.roster.get_contact_by_jid(jid.bare)
        if not contact:
            return
        contact.set_presence('unavailable')
        self.information('%s is not offline' % (contact.get_jid()), "Roster")

    def on_got_online(self, presence):
        jid = presence['from']
        contact = self.roster.get_contact_by_jid(jid.bare)
        if not contact:
            return
        status = presence['type']
        priority = presence.getPriority()
        contact.set_presence(status)
        contact.set_priority(priority)
        self.information("%s is now online (%s)" % (contact.get_jid(), status), "Roster")

186 187 188 189 190 191 192
    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)

193 194 195 196 197
        if not self.xmpp.anon:
            # request the roster
            self.xmpp.getRoster()
            # send initial presence
            self.xmpp.makePresence(pfrom=self.xmpp.jid).send()
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
        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)
216
        # if not self.xmpp.anon:
217 218 219 220 221 222 223 224 225 226 227 228 229
        # 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
230
        room = self.get_room_by_name(from_room)
231 232 233 234 235
        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)
236
        if not room:
237
            return
238 239 240 241 242 243 244 245 246 247 248 249
        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)
250
                if from_nick == room.own_nick:
251 252
                    room.joined = True
                    new_user.color = theme.COLOR_OWN_NICK
253
                    self.add_message_to_text_buffer(room, _("Your nickname is %s") % (from_nick))
254
                    if '170' in status_codes:
255
                        self.add_message_to_text_buffer(room, 'Warning: this room is publicly logged')
256
        else:
257 258 259 260 261 262 263 264
            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:
265
                self.on_user_nick_change(room, presence, user, from_nick, from_room)
266 267
            # kick
            elif kick:
268
                self.on_user_kicked(room, presence, user, from_nick)
269 270
            # user quit
            elif typ == 'unavailable':
271
                self.on_user_leave_groupchat(room, user, jid, status, from_nick, from_room)
272 273
            # status change
            else:
274
                self.on_user_change_status(room, user, from_nick, from_room, affiliation, role, show, status)
275
        self.refresh_window()
276 277
        doupdate()

278 279 280 281 282 283 284 285 286
    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:
287
                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)
288
            else:
289
                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)
290

291 292 293 294 295
    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
296
            for _tab in self.tabs:
297 298
                if isinstance(_tab, PrivateTab) and _tab.get_name().split('/', 1)[0] == room.name:
                    _tab.get_room().own_nick = new_nick
299
        user.change_nick(new_nick)
300
        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)
301 302 303
        # rename the private tabs if needed
        private_room = self.get_room_by_name('%s/%s' % (from_room, from_nick))
        if private_room:
304
            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)
305
            new_jid = private_room.name.split('/', 1)[0]+'/'+new_nick
306
            private_room.name = new_jid
307

308 309 310 311 312 313 314
    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')
315
        by = by.attrib['jid'] if by is not None else None
316 317 318 319
        reason = reason.text# if reason else ''
        if from_nick == room.own_nick: # we are kicked
            room.disconnect()
            if by:
320
                kick_msg = _('%(spec)s [You] have been kicked by "[%(by)s]"') % {'spec': theme.CHAR_KICK.replace('"', '\\"'), 'by':by}
321
            else:
322
                kick_msg = _('%(spec)s [You] have been kicked.') % {'spec':theme.CHAR_KICK.replace('"', '\\"')}
323 324 325 326 327
            # try to auto-rejoin
            if config.get('autorejoin', 'false') == 'true':
                muc.join_groupchat(self.xmpp, room.name, room.own_nick)
        else:
            if by:
328
                kick_msg = _('%(spec)s "[%(nick)s]" has been kicked by "[%(by)s]"') % {'spec':theme.CHAR_KICK.replace('"', '\\"'), 'nick':from_nick.replace('"', '\\"'), 'by':by.replace('"', '\\"')}
329
            else:
330
                kick_msg = _('%(spec)s "[%(nick)s]" has been kicked') % {'spec':theme.CHAR_KICK, 'nick':from_nick.replace('"', '\\"')}
331 332
        if reason:
            kick_msg += _(' Reason: %(reason)s') % {'reason': reason}
333
        self.add_message_to_text_buffer(room, kick_msg, colorized=True)
334

335 336 337 338 339 340 341 342
    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:
343
                leave_msg = _('%(spec)s "[%(nick)s]" has left the room') % {'nick':from_nick.replace('"', '\\"'), 'spec':theme.CHAR_QUIT.replace('"', '\\"')}
344
            else:
345
                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('"', '\\"')}
346 347
            if status:
                leave_msg += ' (%s)' % status
348
            self.add_message_to_text_buffer(room, leave_msg, colorized=True)
349 350 351
        private_room = self.get_room_by_name('%s/%s' % (from_room, from_nick))
        if private_room:
            if not status:
352
                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)
353
            else:
354
                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)
355

356 357 358 359 360
    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
361 362
        display_message = False # flag to know if something significant enough
        # to be displayed has changed
363
        msg = _('"%s" changed: ')% from_nick.replace('"', '\\"')
364
        if affiliation != user.affiliation:
365
            msg += _('affiliation: %s, ') % affiliation
366
            display_message = True
367
        if role != user.role:
368
            msg += _('role: %s, ') % role
369
            display_message = True
370
        if show != user.show and show in list(SHOW_NAME.keys()):
371
            msg += _('show: %s, ') % SHOW_NAME[show]
372 373
            display_message = True
        if status and status != user.status:
374
            msg += _('status: %s, ') % status
375 376 377
            display_message = True
        if not display_message:
            return
378
        msg = msg[:-2] # remove the last ", "
379 380 381 382 383 384 385 386 387 388
        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
389
            self.add_message_to_text_buffer(room, msg, colorized=True)
390 391
        private_room = self.get_room_by_name('%s/%s' % (from_room, from_nick))
        if private_room: # display the message in private
392
            self.add_message_to_text_buffer(private_room, msg, colorized=True)
393 394 395
        # finally, effectively change the user status
        user.update(affiliation, show, status, role)

396 397 398 399 400 401 402 403 404
    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']
405 406
        for tab in self.tabs:
            if isinstance(tab, MucTab) and tab.get_name() == jid_from.bare: # check all the MUC we are in
407
                if message['type'] == 'error':
408
                    return self.room_error(message, tab.get_room().name)
409 410
                else:
                    return self.on_groupchat_private_message(message)
411 412 413 414 415 416 417
        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']
418 419
        nick_from = jid.resource
        room_from = jid.bare
420 421
        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
422
            room = self.open_private_window(room_from, nick_from, False)
423 424 425
            if not room:
                return
        body = message['body']
426 427
        self.add_message_to_text_buffer(room, body, None, nick_from)
        self.refresh_window()
428 429 430 431 432 433
        doupdate()

    def on_normal_message(self, message):
        """
        When receiving "normal" messages (from someone in our roster)
        """
434
        from common import debug
435
        debug('MESSAGE: %s\n' % (message))
436 437 438 439 440 441 442 443 444
        jid = message['from'].bare
        room = self.get_conversation_by_jid(jid)
        if not room:
            room = self.open_conversation_window(jid, False)
            if not room:
                return
        body = message['body']
        self.add_message_to_text_buffer(room, body, None, jid)
        self.refresh_window()
445 446 447 448 449 450
        return

    def on_presence(self, presence):
        """
        """
        from common import debug
451
        debug('Presence: %s\n' % (presence))
452
        return
453

454 455 456 457 458
    def on_roster_update(self, iq):
        """
        A subscription changed, or we received a roster item
        after a roster request, etc
        """
459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476
        # debug('Roster Update: \n%s\n\n' % iq)
        for item in iq.findall('{jabber:iq:roster}query/{jabber:iq:roster}item'):
            jid = item.attrib['jid']
            contact = self.roster.get_contact_by_jid(jid)
            if not contact:
                contact = Contact(jid)
                self.roster.add_contact(contact, jid)
            if 'ask' in item.attrib:
                contact.set_ask(item.attrib['ask'])
            else:
                contact.set_ask(None)
            if item.attrib['subscription']:
                contact.set_subscription(item.attrib['subscription'])
            groups = item.findall('{jabber:iq:roster}group')
            self.roster.edit_groups_of_contact(contact, [group.text for group in groups])
        if isinstance(self.current_tab(), RosterInfoTab):
            # TODO refresh roster_win only
            self.refresh_window()
477

478 479 480 481
    def resize_window(self):
        """
        Resize the whole screen
        """
482 483 484
        for tab in self.tabs:
            tab.resize(self.stdscr)
        self.refresh_window()
485

486
    def main_loop(self):
487 488 489
        """
        main loop waiting for the user to press a key
        """
490
        self.refresh_window()
491
        while True:
492
            doupdate()
493
            char=read_char(self.stdscr)
494
            # search for keyboard shortcut
495
            if char in list(self.key_func.keys()):
496
                self.key_func[char]()
497
            else:
498
                self.do_command(char)
499

500
    def current_tab(self):
501 502 503
        """
        returns the current room, the one we are viewing
        """
504
        return self.tabs[0]
505

506 507 508 509 510 511 512 513 514 515
    def get_conversation_by_jid(self, jid):
        """
        Return the room of the ConversationTab with the given jid
        """
        for tab in self.tabs:
            if isinstance(tab, ConversationTab):
                if tab.get_name() == jid:
                    return tab.get_room()
        return None

516
    def get_room_by_name(self, name):
517 518 519
        """
        returns the room that has this name
        """
520 521 522 523
        for tab in self.tabs:
            if (isinstance(tab, MucTab) or
                isinstance(tab, PrivateTab)) and tab.get_name() == name:
                return tab.get_room()
524
        return None
525

526
    def init_curses(self, stdscr):
527 528 529
        """
        ncurses initialization
        """
530
        theme.init_colors()
531
        curses.noecho()
532
        curses.curs_set(0)
533
        stdscr.keypad(True)
534

535
    def reset_curses(self):
536 537 538 539 540
        """
        Reset terminal capabilities to what they were before ncurses
        init
        """
        curses.echo()
541
        curses.nocbreak()
542
        curses.endwin()
543

544 545 546 547
    def refresh_window(self):
        """
        Refresh everything
        """
548
        self.current_tab().set_color_state(theme.COLOR_TAB_CURRENT)
549 550
        self.current_tab().refresh(self.tabs, self.information_buffer, self.roster)
        doupdate()
551

552
    def open_new_room(self, room, nick, focus=True):
553
        """
554
        Open a new MucTab containing a muc Room, using the specified nick
555
        """
556 557 558 559
        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)
560
        else:
561 562 563
            for ta in self.tabs:
                if ta.nb == 0:
                    self.tabs.insert(self.tabs.index(ta), new_tab)
564
                    break
565
        if focus:
566
            self.command_win("%s" % new_tab.nb)
567
        self.refresh_window()
568

569 570 571 572 573 574 575
    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
        """
576 577 578
        for tab in self.tabs:
            if tab.get_color_state() == theme.COLOR_TAB_PRIVATE:
                self.command_win('%s' % tab.nb)
579
                return
580 581 582
        for tab in self.tabs:
            if tab.get_color_state() == theme.COLOR_TAB_HIGHLIGHT:
                self.command_win('%s' % tab.nb)
583
                return
584 585 586
        for tab in self.tabs:
            if tab.get_color_state() == theme.COLOR_TAB_NEW_MESSAGE:
                self.command_win('%s' % tab.nb)
587
                return
588

589
    def rotate_rooms_right(self, args=None):
590 591 592
        """
        rotate the rooms list to the right
        """
593 594 595
        self.current_tab().on_lose_focus()
        self.tabs.append(self.tabs.pop(0))
        self.current_tab().on_gain_focus()
596
        self.refresh_window()
597

598
    def rotate_rooms_left(self, args=None):
599 600 601
        """
        rotate the rooms list to the right
        """
602 603 604
        self.current_tab().on_lose_focus()
        self.tabs.insert(0, self.tabs.pop())
        self.current_tab().on_gain_focus()
605
        self.refresh_window()
606

607
    def scroll_page_down(self, args=None):
608
        self.current_tab().on_scroll_down()
609
        self.refresh_window()
610 611

    def scroll_page_up(self, args=None):
612
        self.current_tab().on_scroll_up()
613
        self.refresh_window()
614

615
    def room_error(self, error, room_name):
616 617 618
        """
        Display the error on the room window
        """
619 620 621 622 623 624
        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:
625
            if code in list(ERROR_AND_STATUS_CODES.keys()):
626 627
                body = ERROR_AND_STATUS_CODES[code]
            else:
628 629
                body = condition or _('Unknown error')
        if code:
630 631
            msg = _('Error: %(code)s - %(msg)s: %(body)s') % {'msg':msg, 'body':body, 'code':code}
            self.add_message_to_text_buffer(room, msg)
632
        else:
633 634
            msg = _('Error: %(msg)s: %(body)s') % {'msg':msg, 'body':body}
            self.add_message_to_text_buffer(room, msg)
635
        if code == '401':
636 637
            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)
638
        if code == '409':
639 640 641
            if config.get('alternative_nickname', '') != '':
                self.command_join('%s/%s'% (room.name, room.own_nick+config.get('alternative_nickname', '')))
            else:
642
                self.add_message_to_text_buffer(room, _('You can join the room with an other nick, by typing "/join /other_nick"'))
643
        self.refresh_window()
644

645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664
    def open_conversation_window(self, room_name, focus=True):
        """
        open a new conversation tab and focus it if needed
        """
        r = Room(room_name, self.xmpp.fulljid)
        new_tab = ConversationTab(self.stdscr, r, self.information_win_size)
        # insert it in the rooms
        if self.current_tab().nb == 0:
            self.tabs.append(new_tab)
        else:
            for ta in self.tabs:
                if ta.nb == 0:
                    self.tabs.insert(self.tabs.index(ta), new_tab)
                    break
        if focus:               # focus the room if needed
            self.command_win('%s' % (new_tab.nb))
        # self.window.new_room(r)
        self.refresh_window()
        return r

665
    def open_private_window(self, room_name, user_nick, focus=True):
666
        complete_jid = room_name+'/'+user_nick
667 668 669 670
        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)
671 672
                    return
        # create the new tab
673
        room = self.get_room_by_name(room_name)
674 675 676
        if not room:
            return None
        own_nick = room.own_nick
677 678
        r = Room(complete_jid, own_nick) # PrivateRoom here
        new_tab = PrivateTab(self.stdscr, r, self.information_win_size)
679
        # insert it in the rooms
680 681
        if self.current_tab().nb == 0:
            self.tabs.append(new_tab)
682
        else:
683 684 685
            for ta in self.tabs:
                if ta.nb == 0:
                    self.tabs.insert(self.tabs.index(ta), new_tab)
686 687
                    break
        if focus:               # focus the room if needed
688
            self.command_win('%s' % (new_tab.nb))
689
        # self.window.new_room(r)
690
        self.refresh_window()
691 692
        return r

693
    def on_groupchat_message(self, message):
694
        """
695
        Triggered whenever a message is received from a multi-user chat room.
696
        """
697 698
        delay_tag = message.find('{urn:xmpp:delay}delay')
        if delay_tag is not None:
699
            delayed = True
700
            date = common.datetime_tuple(delay_tag.attrib['stamp'])
701
        else:
702 703
            # We support the OLD and deprecated XEP: http://xmpp.org/extensions/xep-0091.html
            # But it sucks, please, Jabber servers, don't do this :(
704 705
            delay_tag = message.find('{jabber:x:delay}x')
            if delay_tag is not None:
706
                delayed = True
707
                date = common.datetime_tuple(delay_tag.attrib['stamp'])
708 709
            else:
                delayed = False
710
                date = None
711
        nick_from = message['mucnick']
712
        room_from = message.getMucroom()
713 714
        if message['type'] == 'error': # Check if it's an error
            return self.room_error(message, from_room)
715 716
        if nick_from == room_from:
            nick_from = None
717
        room = self.get_room_by_name(room_from)
718
        if (room_from in self.ignores) and (nick_from in self.ignores[room_from]):
719
            return
720
        room = self.get_room_by_name(room_from)
721 722
        if not room:
            self.information(_("message received for a non-existing room: %s") % (room_from))
723
            return
724 725
        body = message['body']
        subject = message['subject']
726
        if subject:
727
            if nick_from:
728
                self.add_message_to_text_buffer(room, _("%(nick)s changed the subject to: %(subject)s") % {'nick':nick_from, 'subject':subject}, time=date)
729
            else:
730
                self.add_message_to_text_buffer(room, _("The subject is: %(subject)s") % {'subject':subject}, time=date)
731
            room.topic = subject.replace('\n', '|')
732
        elif body:
733
            if body.startswith('/me '):
734
                self.add_message_to_text_buffer(room, "* "+nick_from + ' ' + body[4:], date)
735
            else:
736
                date = date if delayed == True else None
737
                self.add_message_to_text_buffer(room, body, date, nick_from)
738
        self.refresh_window()
739
        doupdate()
740

741
    def add_message_to_text_buffer(self, room, txt, time=None, nickname=None, colorized=False):
742
        """
743 744
        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)
745
        """
746 747
        if not room:
            self.information('Error, trying to add a message in no room: %s' % txt)
748
        else:
749 750
            room.add_message(txt, time, nickname, colorized)
        self.refresh_window()
751

752
    def command_help(self, arg):
753 754 755
        """
        /help <command_name>
        """
756
        args = arg.split()
757
        if len(args) == 0:
758
            msg = _('Available commands are: ')
759
            for command in list(self.commands.keys()):
760
                msg += "%s " % command
761
            msg += _("\nType /help <command_name> to know what each command does")
762
        if len(args) == 1:
763
            if args[0] in list(self.commands.keys()):
764 765
                msg = self.commands[args[0]][1]
            else:
766
                msg = _('Unknown command: %s') % args[0]
767
        self.information(msg)
768

769 770 771 772
    def command_whois(self, arg):
        """
        /whois <nickname>
        """
773 774
        # TODO
        return
775 776 777 778
        # check shlex here
        try:
            args = shlex.split(arg)
        except ValueError as error:
779
            return self.information(str(error), _("Error"))
780 781
        room = self.current_room()
        if len(args) != 1:
782
            self.add_message_to_text_buffer(room, _('whois command takes exactly one argument'))
783 784 785 786 787 788 789
            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)

790 791 792 793
    def command_theme(self, arg):
        """
        """
        theme.reload_theme()
794
        self.resize_window()
795

796 797 798 799
    def command_recolor(self, arg):
        """
        Re-assign color to the participants of the room
        """
800 801
        tab = self.current_tab()
        if not isinstance(tab, MucTab):
802
            return
803
        room = tab.get_room()
804 805 806 807 808 809 810 811 812 813 814 815 816
        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()

817
    def command_win(self, arg):
818 819 820
        """
        /win <number>
        """
821
        args = arg.split()
822
        if len(args) != 1:
823
            self.command_help('win')
824 825 826 827
            return
        try:
            nb = int(args[0])
        except ValueError:
828
            self.command_help('win')