core.py 52.5 KB
Newer Older
1
# Copyright 2010 Le Coz Florent <louiz@louiz.org>
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
#
# 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
import threading
29 30
import webbrowser

31
from datetime import datetime
32 33

import common
34
import theme
35 36
import logging

37 38
from sleekxmpp.xmlstream.stanzabase import JID

39
log = logging.getLogger(__name__)
40

41
import multiuserchat as muc
42
import tabs
43
import windows
44

45
from connection import connection
46
from config import config
47
from logger import logger
48 49
from user import User
from room import Room
50
from roster import Roster, RosterGroup, roster
51
from contact import Contact, Resource
52
from message import Message
53
from text_buffer import TextBuffer
54
from keyboard import read_char
55

56 57
# http://xmpp.org/extensions/xep-0045.html#errorstatus
ERROR_AND_STATUS_CODES = {
58 59 60 61 62 63 64 65
    '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'),
66 67
    }

68 69 70 71 72 73 74
SHOW_NAME = {
    'dnd': _('busy'),
    'away': _('away'),
    'xa': _('not available'),
    'chat': _('chatty'),
    '': _('available')
    }
75 76 77

resize_lock = threading.Lock()

78
class Core(object):
79
    """
80
    User interface using ncurses
81
    """
82
    def __init__(self, xmpp):
83
        self.running = True
84 85 86
        self.stdscr = curses.initscr()
        self.init_curses(self.stdscr)
        self.xmpp = xmpp
87 88
        self.information_buffer = TextBuffer()
        self.information_win_size = 0 # Todo, get this from config
89 90
        default_tab = tabs.InfoTab(self, "Info") if self.xmpp.anon\
            else tabs.RosterInfoTab(self)
91
        default_tab.on_gain_focus()
92
        self.tabs = [default_tab]
93 94 95
        # a unique buffer used to store global informations
        # that are displayed in almost all tabs, in an
        # information window.
96

97
        self.resize_timer = None
98
        self.previous_tab_nb = 0
99
        self.own_nick = config.get('own_nick', self.xmpp.boundjid.bare)
100 101 102 103 104 105 106
        # global commands, available from all tabs
        # a command is tuple of the form:
        # (the function executing the command. Takes a string as argument,
        #  a string representing the help message,
        #  a completion function, taking a Input as argument. Can be None)
        #  The completion function should return True if a completion was
        #  made ; False otherwise
107
        self.commands = {
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126
            'help': (self.command_help, '\_o< KOIN KOIN KOIN', None),
            '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"), self.completion_join),
            'exit': (self.command_quit, _("Usage: /exit\nExit: Just disconnect from the server and exit poezio."), None),
            'next': (self.rotate_rooms_right, _("Usage: /next\nNext: Go to the next room."), None),
            'n': (self.rotate_rooms_right, _("Usage: /n\nN: Go to the next room."), None),
            'prev': (self.rotate_rooms_left, _("Usage: /prev\nPrev: Go to the previous room."), None),
            'p': (self.rotate_rooms_left, _("Usage: /p\nP: Go to the previous room."), None),
            'win': (self.command_win, _("Usage: /win <number>\nWin: Go to the specified room."), None),
            'w': (self.command_win, _("Usage: /w <number>\nW: Go to the specified room."), None),
            '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 [status] argument will be your status message"), None),
            '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]'"), None),
            '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]'"), None),
            '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]'"), None),
            '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]'"), None),
           '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)"), None),
            '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>."), None),
            '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."), None),
            'whois': (self.command_whois, _('Usage: /whois <nickname>\nWhois: Request many informations about the user.'), None),
            'theme': (self.command_theme, _('Usage: /theme\nTheme: Reload the theme defined in the config file.'), None),
127
            'list': (self.command_list, _('Usage: /list\n/List: get the list of public chatrooms on the specified server'), self.completion_list),
128 129
            }

130
        self.key_func = {
131 132
            "KEY_PPAGE": self.scroll_page_up,
            "KEY_NPAGE": self.scroll_page_down,
133
            "KEY_F(5)": self.rotate_rooms_left,
134
            "^P": self.rotate_rooms_left,
135
            'kLFT3': self.rotate_rooms_left,
136
            "KEY_F(6)": self.rotate_rooms_right,
137 138
            "^N": self.rotate_rooms_right,
            'kRIT3': self.rotate_rooms_right,
139 140
            "KEY_F(7)": self.shrink_information_win,
            "KEY_F(8)": self.grow_information_win,
141
            "KEY_RESIZE": self.call_for_resize,
142
            'M-e': self.go_to_important_room,
143
            'M-r': self.go_to_roster,
144 145
            'M-z': self.go_to_previous_tab,
            'M-v': self.move_separator,
146
            '^L': self.call_for_resize,
147 148
            }

149 150 151 152
        # 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)
153
        self.xmpp.add_event_handler("groupchat_subject", self.on_groupchat_subject)
154
        self.xmpp.add_event_handler("message", self.on_message)
155 156
        self.xmpp.add_event_handler("got_online" , self.on_got_online)
        self.xmpp.add_event_handler("got_offline" , self.on_got_offline)
157
        self.xmpp.add_event_handler("roster_update", self.on_roster_update)
158
        self.xmpp.add_event_handler("changed_status", self.on_presence)
159 160 161 162 163 164 165 166

    def grow_information_win(self):
        """
        """
        if self.information_win_size == 14:
            return
        self.information_win_size += 1
        for tab in self.tabs:
167
            tab.on_info_win_size_changed()
168 169 170 171 172 173 174 175 176
        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:
177
            tab.on_info_win_size_changed()
178
        self.refresh_window()
179

180 181
    def on_got_offline(self, presence):
        jid = presence['from']
182
        contact = roster.get_contact_by_jid(jid.bare)
183 184
        if not contact:
            return
185 186 187 188
        resource = contact.get_resource_by_fulljid(jid.full)
        assert resource
        self.information('%s is offline' % (resource.get_jid()), "Roster")
        contact.remove_resource(resource)
189
        if isinstance(self.current_tab(), tabs.RosterInfoTab):
190
            self.refresh_window()
191 192 193

    def on_got_online(self, presence):
        jid = presence['from']
194
        contact = roster.get_contact_by_jid(jid.bare)
195
        if not contact:
196
            # Todo, handle presence comming from contacts not in roster
197
            return
198 199 200
        resource = contact.get_resource_by_fulljid(jid.full)
        assert not resource
        resource = Resource(jid.full)
201
        status = presence['type']
202
        status_message = presence['status']
203
        priority = presence.getPriority() or 0
204
        resource.set_status(status_message)
205 206 207 208
        resource.set_presence(status)
        resource.set_priority(priority)
        contact.add_resource(resource)
        self.information("%s is online (%s)" % (resource.get_jid().full, status), "Roster")
209

210 211 212 213 214
    def on_connected(self, event):
        """
        Called when we are connected and authenticated
        """
        self.information(_("Welcome on Poezio \o/!"))
215
        self.information(_("Your JID is %s") % self.xmpp.boundjid.full)
216

217 218 219 220
        if not self.xmpp.anon:
            # request the roster
            self.xmpp.getRoster()
            # send initial presence
221
            self.xmpp.makePresence().send()
222 223 224 225 226
        rooms = config.get('rooms', '')
        if rooms == '' or not isinstance(rooms, str):
            return
        rooms = rooms.split(':')
        for room in rooms:
227 228
            jid = JID(room)
            if jid.bare == '':
229
                return
230 231
            if jid.resource != '':
                nick = jid.resource
232 233 234 235 236
            else:
                default = os.environ.get('USER') if os.environ.get('USER') else 'poezio'
                nick = config.get('default_nick', '')
                if nick == '':
                    nick = default
237 238
            self.open_new_room(jid.bare, nick, False)
            muc.join_groupchat(self.xmpp, jid.bare, nick)
239
        # if not self.xmpp.anon:
240 241 242 243 244 245 246 247 248 249 250 251 252
        # 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
253
        room = self.get_room_by_name(from_room)
254 255 256 257 258
        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)
259
        if not room:
260
            return
261 262 263 264 265 266 267 268 269 270 271 272
        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)
273
                if from_nick == room.own_nick:
274 275
                    room.joined = True
                    new_user.color = theme.COLOR_OWN_NICK
276
                    self.add_message_to_text_buffer(room, _("Your nickname is %s") % (from_nick))
277
                    if '170' in status_codes:
278
                        self.add_message_to_text_buffer(room, 'Warning: this room is publicly logged')
279
        else:
280 281 282 283 284 285 286 287
            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:
288
                self.on_user_nick_change(room, presence, user, from_nick, from_room)
289 290
            # kick
            elif kick:
291
                self.on_user_kicked(room, presence, user, from_nick)
292 293
            # user quit
            elif typ == 'unavailable':
294
                self.on_user_leave_groupchat(room, user, jid, status, from_nick, from_room)
295 296
            # status change
            else:
297
                self.on_user_change_status(room, user, from_nick, from_room, affiliation, role, show, status)
298
        self.refresh_window()
299
        self.doupdate()
300

301 302 303 304 305 306 307 308 309
    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:
310
                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)
311
            else:
312
                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)
313

314 315 316 317 318
    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
319
            for _tab in self.tabs:
320
                if isinstance(_tab, tabs.PrivateTab) and JID(_tab.get_name()).bare == room.name:
321
                    _tab.get_room().own_nick = new_nick
322
        user.change_nick(new_nick)
323
        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)
324 325 326
        # rename the private tabs if needed
        private_room = self.get_room_by_name('%s/%s' % (from_room, from_nick))
        if private_room:
327
            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)
328
            new_jid = JID(private_room.name).bare+'/'+new_nick
329
            private_room.name = new_jid
330

331 332 333 334 335 336 337
    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')
338
        by = by.attrib['jid'] if by is not None else None
339
        reason = reason.text if reason else ''
340 341 342
        if from_nick == room.own_nick: # we are kicked
            room.disconnect()
            if by:
343
                kick_msg = _('%(spec)s [You] have been kicked by "[%(by)s]"') % {'spec': theme.CHAR_KICK.replace('"', '\\"'), 'by':by}
344
            else:
345
                kick_msg = _('%(spec)s [You] have been kicked.') % {'spec':theme.CHAR_KICK.replace('"', '\\"')}
346 347 348 349 350
            # try to auto-rejoin
            if config.get('autorejoin', 'false') == 'true':
                muc.join_groupchat(self.xmpp, room.name, room.own_nick)
        else:
            if by:
351
                kick_msg = _('%(spec)s "[%(nick)s]" has been kicked by "[%(by)s]"') % {'spec':theme.CHAR_KICK.replace('"', '\\"'), 'nick':from_nick.replace('"', '\\"'), 'by':by.replace('"', '\\"')}
352
            else:
353
                kick_msg = _('%(spec)s "[%(nick)s]" has been kicked') % {'spec':theme.CHAR_KICK, 'nick':from_nick.replace('"', '\\"')}
354 355
        if reason:
            kick_msg += _(' Reason: %(reason)s') % {'reason': reason}
356
        self.add_message_to_text_buffer(room, kick_msg, colorized=True)
357

358 359 360 361 362
    def on_user_leave_groupchat(self, room, user, jid, status, from_nick, from_room):
        """
        When an user leaves a groupchat
        """
        room.users.remove(user)
363 364 365
        if room.own_nick == user.nick:
            # We are now out of the room. Happens with some buggy (? not sure) servers
            room.disconnect()
366 367 368
        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:
369
                leave_msg = _('%(spec)s "[%(nick)s]" has left the room') % {'nick':from_nick.replace('"', '\\"'), 'spec':theme.CHAR_QUIT.replace('"', '\\"')}
370
            else:
371
                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('"', '\\"')}
372 373
            if status:
                leave_msg += ' (%s)' % status
374
            self.add_message_to_text_buffer(room, leave_msg, colorized=True)
375 376 377
        private_room = self.get_room_by_name('%s/%s' % (from_room, from_nick))
        if private_room:
            if not status:
378
                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)
379
            else:
380
                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)
381

382 383 384 385 386
    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
387 388
        display_message = False # flag to know if something significant enough
        # to be displayed has changed
389
        msg = _('"%s" changed: ')% from_nick.replace('"', '\\"')
390
        if affiliation != user.affiliation:
391
            msg += _('affiliation: %s, ') % affiliation
392
            display_message = True
393
        if role != user.role:
394
            msg += _('role: %s, ') % role
395
            display_message = True
396
        if show != user.show and show in list(SHOW_NAME.keys()):
397
            msg += _('show: %s, ') % SHOW_NAME[show]
398 399
            display_message = True
        if status and status != user.status:
400
            msg += _('status: %s, ') % status
401 402 403
            display_message = True
        if not display_message:
            return
404
        msg = msg[:-2] # remove the last ", "
405 406 407 408 409 410 411 412 413 414
        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
415
            self.add_message_to_text_buffer(room, msg, colorized=True)
416 417
        private_room = self.get_room_by_name('%s/%s' % (from_room, from_nick))
        if private_room: # display the message in private
418
            self.add_message_to_text_buffer(private_room, msg, colorized=True)
419 420 421
        # finally, effectively change the user status
        user.update(affiliation, show, status, role)

422 423 424 425 426 427
    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':
428
            return
429 430
        # Differentiate both type of messages, and call the appropriate handler.
        jid_from = message['from']
431
        for tab in self.tabs:
432
            if tab.get_name() == jid_from.bare:
433
                if message['type'] == 'error':
434
                    return self.room_error(message, tab.get_room().name)
435 436
                else:
                    return self.on_groupchat_private_message(message)
437 438 439 440 441 442 443
        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']
444
        nick_from = jid.resource
445
        room_from = jid.bare
446 447
        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
448
            room = self.open_private_window(room_from, nick_from, False)
449 450 451
            if not room:
                return
        body = message['body']
452 453 454
        room.add_message(body, time=None, nickname=nick_from,
                         colorized=False,
                         forced_user=self.get_room_by_name(room_from).get_user_by_name(nick_from))
455
        self.refresh_window()
456
        self.doupdate()
457

458 459 460 461 462
    def focus_tab_named(self, tab_name):
        for tab in self.tabs:
            if tab.get_name() == tab_name:
                self.command_win('%s' % (tab.nb,))

463 464 465 466
    def on_normal_message(self, message):
        """
        When receiving "normal" messages (from someone in our roster)
        """
467
        jid = message['from']
468 469 470
        body = message['body']
        if not body:
            return
471 472 473 474 475 476 477 478 479 480 481 482
        # We first check if we have a conversation opened with this precise resource
        conversation = self.get_tab_by_name(jid.full)
        if not conversation:
            # If not, we search for a conversation with the bare jid
            conversation = self.get_tab_by_name(jid.bare)
            if not conversation:
                # We create the conversation with the bare Jid if nothing was found
                conversation = self.open_conversation_window(jid.bare, False)
            # room = self.open_conversation_window(jid, False)
        self.add_message_to_text_buffer(conversation.get_room(), body, None, jid.full)
        if self.current_tab() is not conversation:
            conversation.set_color_state(theme.COLOR_TAB_PRIVATE)
483
        self.refresh_window()
484 485 486 487 488
        return

    def on_presence(self, presence):
        """
        """
489
        jid = presence['from']
490
        contact = roster.get_contact_by_jid(jid.bare)
491 492 493 494 495 496
        if not contact:
            return
        resource = contact.get_resource_by_fulljid(jid.full)
        if not resource:
            return
        status = presence['type']
497
        status_message = presence['status']
498 499 500
        priority = presence.getPriority() or 0
        resource.set_presence(status)
        resource.set_priority(priority)
501
        resource.set_status(status_message)
502
        if isinstance(self.current_tab(), tabs.RosterInfoTab):
503
            self.refresh_window()
504

505 506 507 508 509
    def on_roster_update(self, iq):
        """
        A subscription changed, or we received a roster item
        after a roster request, etc
        """
510 511
        for item in iq.findall('{jabber:iq:roster}query/{jabber:iq:roster}item'):
            jid = item.attrib['jid']
512
            contact = roster.get_contact_by_jid(jid)
513 514
            if not contact:
                contact = Contact(jid)
515
                roster.add_contact(contact, jid)
516 517 518 519
            if 'ask' in item.attrib:
                contact.set_ask(item.attrib['ask'])
            else:
                contact.set_ask(None)
520 521 522 523
            if 'name' in item.attrib:
                contact.set_name(item.attrib['name'])
            else:
                contact.set_name(None)
524 525 526
            if item.attrib['subscription']:
                contact.set_subscription(item.attrib['subscription'])
            groups = item.findall('{jabber:iq:roster}group')
527
            roster.edit_groups_of_contact(contact, [group.text for group in groups])
528
        if isinstance(self.current_tab(), tabs.RosterInfoTab):
529
            self.refresh_window()
530

531 532 533 534 535 536 537
    def call_for_resize(self):
        """
        Starts a very short timer. If no other terminal resize
        occured in this delay then poezio is REALLY resize.
        This is to avoid multiple unnecessary software resizes (this
        can be heavy on resource on slow computers or networks)
        """
538 539 540 541 542 543 544 545 546
        with resize_lock:
            if self.resize_timer:
                # a recent terminal resize occured.
                # Cancel the programmed software resize
                self.resize_timer.cancel()
            # add the new timer
            self.resize_timer = threading.Timer(0.1, self.resize_window)
            self.resize_timer.start()
        # self.resize_window()
547

548 549 550 551
    def resize_window(self):
        """
        Resize the whole screen
        """
552 553
        with resize_lock:
            for tab in self.tabs:
554
                tab.resize()
555
            self.refresh_window()
556

557
    def main_loop(self):
558 559 560
        """
        main loop waiting for the user to press a key
        """
561
        self.refresh_window()
562
        while self.running:
563
            self.doupdate()
564
            char=read_char(self.stdscr)
565
            # search for keyboard shortcut
566
            if char in list(self.key_func.keys()):
567
                self.key_func[char]()
568
            else:
569
                self.do_command(char)
570

571
    def current_tab(self):
572 573 574
        """
        returns the current room, the one we are viewing
        """
575
        return self.tabs[0]
576

577 578 579 580 581
    def get_conversation_by_jid(self, jid):
        """
        Return the room of the ConversationTab with the given jid
        """
        for tab in self.tabs:
582
            if isinstance(tab, tabs.ConversationTab):
583 584 585 586
                if tab.get_name() == jid:
                    return tab.get_room()
        return None

587 588 589 590 591 592 593 594 595
    def get_tab_by_name(self, name):
        """
        Get the tab with the given name.
        """
        for tab in self.tabs:
            if tab.get_name() == name:
                return tab
        return None

596
    def get_room_by_name(self, name):
597 598 599
        """
        returns the room that has this name
        """
600
        for tab in self.tabs:
601
            if (isinstance(tab, tabs.MucTab) or
602 603
                isinstance(tab, tabs.PrivateTab) or
                isinstance(tab, tabs.ConversationTab)) and tab.get_name() == name:
604
                return tab.get_room()
605
        return None
606

607
    def init_curses(self, stdscr):
608 609 610
        """
        ncurses initialization
        """
611
        curses.curs_set(1)
612
        curses.noecho()
613 614
        # curses.raw()
        theme.init_colors()
615
        stdscr.keypad(True)
616

617
    def reset_curses(self):
618 619 620 621 622
        """
        Reset terminal capabilities to what they were before ncurses
        init
        """
        curses.echo()
623
        curses.nocbreak()
624
        curses.endwin()
625

626 627 628 629
    def refresh_window(self):
        """
        Refresh everything
        """
630
        self.current_tab().set_color_state(theme.COLOR_TAB_CURRENT)
631
        self.current_tab().refresh(self.tabs, self.information_buffer, roster)
632
        self.doupdate()
633

634
    def add_tab(self, new_tab, focus=False):
635
        """
636 637
        Appends the new_tab in the tab list and
        focus it if focus==True
638
        """
639 640
        if self.current_tab().nb == 0:
            self.tabs.append(new_tab)
641
        else:
642 643 644
            for ta in self.tabs:
                if ta.nb == 0:
                    self.tabs.insert(self.tabs.index(ta), new_tab)
645
                    break
646
        if focus:
647
            self.command_win("%s" % new_tab.nb)
648 649 650 651 652 653 654 655

    def open_new_room(self, room, nick, focus=True):
        """
        Open a new tab.MucTab containing a muc Room, using the specified nick
        """
        r = Room(room, nick)
        new_tab = tabs.MucTab(self, r)
        self.add_tab(new_tab, focus)
656
        self.refresh_window()
657

658 659 660 661 662 663
    def go_to_roster(self):
        self.command_win('0')

    def go_to_previous_tab(self):
        self.command_win('%s' % (self.previous_tab_nb,))

664 665 666 667 668 669 670
    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
        """
671 672 673
        for tab in self.tabs:
            if tab.get_color_state() == theme.COLOR_TAB_PRIVATE:
                self.command_win('%s' % tab.nb)
674
                return
675 676 677
        for tab in self.tabs:
            if tab.get_color_state() == theme.COLOR_TAB_HIGHLIGHT:
                self.command_win('%s' % tab.nb)
678
                return
679 680 681
        for tab in self.tabs:
            if tab.get_color_state() == theme.COLOR_TAB_NEW_MESSAGE:
                self.command_win('%s' % tab.nb)
682
                return
683 684 685 686
        for tab in self.tabs:
            if isinstance(tab, tabs.ChatTab) and not tab.input.is_empty():
                self.command_win('%s' % tab.nb)
                return
687

688
    def rotate_rooms_right(self, args=None):
689 690 691
        """
        rotate the rooms list to the right
        """
692 693 694
        self.current_tab().on_lose_focus()
        self.tabs.append(self.tabs.pop(0))
        self.current_tab().on_gain_focus()
695
        self.refresh_window()
696

697
    def rotate_rooms_left(self, args=None):
698 699 700
        """
        rotate the rooms list to the right
        """
701 702 703
        self.current_tab().on_lose_focus()
        self.tabs.insert(0, self.tabs.pop())
        self.current_tab().on_gain_focus()
704
        self.refresh_window()
705

706
    def scroll_page_down(self, args=None):
707
        self.current_tab().on_scroll_down()
708
        self.refresh_window()
709 710

    def scroll_page_up(self, args=None):
711
        self.current_tab().on_scroll_up()
712
        self.refresh_window()
713

714
    def room_error(self, error, room_name):
715 716 717
        """
        Display the error on the room window
        """
718 719 720 721 722 723
        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:
724
            if code in list(ERROR_AND_STATUS_CODES.keys()):
725 726
                body = ERROR_AND_STATUS_CODES[code]
            else:
727 728
                body = condition or _('Unknown error')
        if code:
729 730
            msg = _('Error: %(code)s - %(msg)s: %(body)s') % {'msg':msg, 'body':body, 'code':code}
            self.add_message_to_text_buffer(room, msg)
731
        else:
732 733
            msg = _('Error: %(msg)s: %(body)s') % {'msg':msg, 'body':body}
            self.add_message_to_text_buffer(room, msg)
734
        if code == '401':
735 736
            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)
737
        if code == '409':
738 739 740
            if config.get('alternative_nickname', '') != '':
                self.command_join('%s/%s'% (room.name, room.own_nick+config.get('alternative_nickname', '')))
            else:
741
                self.add_message_to_text_buffer(room, _('You can join the room with an other nick, by typing "/join /other_nick"'))
742
        self.refresh_window()
743

744
    def open_conversation_window(self, jid, focus=True):
745 746 747
        """
        open a new conversation tab and focus it if needed
        """
748
        text_buffer = TextBuffer()
749
        new_tab = tabs.ConversationTab(self, text_buffer, jid)
750
        # insert it in the rooms
751
        self.add_tab(new_tab, focus)
752
        self.refresh_window()
753
        return new_tab
754

755
    def open_private_window(self, room_name, user_nick, focus=True):
756
        complete_jid = room_name+'/'+user_nick
757
        for tab in self.tabs: # if the room exists, focus it and return
758
            if isinstance(tab, tabs.PrivateTab):
759 760
                if tab.get_name() == complete_jid:
                    self.command_win('%s' % tab.nb)
761
                    return tag.get_room()
762
        # create the new tab
763
        room = self.get_room_by_name(room_name)
764 765 766
        if not room:
            return None
        own_nick = room.own_nick
767
        r = Room(complete_jid, own_nick) # PrivateRoom here
768
        new_tab = tabs.PrivateTab(self, r)
769
        # insert it in the tabs
770
        self.add_tab(new_tab, focus)
771
        # self.window.new_room(r)
772
        self.refresh_window()
773 774
        return r

775 776 777 778 779 780 781 782 783 784
    def on_groupchat_subject(self, message):
        """
        triggered when the topic is changed
        """
        nick_from = message['mucnick']
        room_from = message.getMucroom()
        room = self.get_room_by_name(room_from)
        subject = message['subject']
        if not subject:
            return
785
        self.add_message_to_text_buffer(room, _("%(nick)s set the subject to: %(subject)s") % {'nick':nick_from, 'subject':subject}, time=None)
786 787 788
        room.topic = subject.replace('\n', '|')
        self.refresh_window()

789
    def on_groupchat_message(self, message):
790
        """
791
        Triggered whenever a message is received from a multi-user chat room.
792
        """
793 794
        delay_tag = message.find('{urn:xmpp:delay}delay')
        if delay_tag is not None:
795
            delayed = True