core.py 55.2 KB
Newer Older
1
# Copyright 2010-2011 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
import traceback
30

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 text_buffer import TextBuffer
53
from keyboard import read_char
54

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

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

resize_lock = threading.Lock()

77
class Core(object):
78
    """
79
    User interface using ncurses
80
    """
81
    def __init__(self, xmpp):
82 83 84
        # All uncaught exception are given to this callback, instead
        # of being displayed on the screen and exiting the program.
        sys.excepthook = self.on_exception
85
        self.running = True
86 87 88
        self.stdscr = curses.initscr()
        self.init_curses(self.stdscr)
        self.xmpp = xmpp
89 90 91
        # a unique buffer used to store global informations
        # that are displayed in almost all tabs, in an
        # information window.
92
        self.information_buffer = TextBuffer()
93
        self.information_win_size = config.get('info_win_height', 2, 'var')
94
        default_tab = tabs.InfoTab(self) if self.xmpp.anon\
95
            else tabs.RosterInfoTab(self)
96
        default_tab.on_gain_focus()
97
        self.tabs = [default_tab]
98
        self.resize_timer = None
99
        self.previous_tab_nb = 0
100
        self.own_nick = config.get('own_nick', '') or self.xmpp.boundjid.user
101 102 103 104 105 106 107
        # 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
108
        self.commands = {
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),
            '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.full_screen_redraw,
147 148
            }

149
        # Add handlers
150 151 152 153
        self.xmpp.add_event_handler('connected', self.on_connected)
        self.xmpp.add_event_handler('disconnected', self.on_disconnected)
        self.xmpp.add_event_handler('failed_auth', self.on_failed_auth)
        self.xmpp.add_event_handler("session_start", self.on_session_start)
154 155
        self.xmpp.add_event_handler("groupchat_presence", self.on_groupchat_presence)
        self.xmpp.add_event_handler("groupchat_message", self.on_groupchat_message)
156
        self.xmpp.add_event_handler("groupchat_subject", self.on_groupchat_subject)
157
        self.xmpp.add_event_handler("message", self.on_message)
158 159
        self.xmpp.add_event_handler("got_online" , self.on_got_online)
        self.xmpp.add_event_handler("got_offline" , self.on_got_offline)
160
        self.xmpp.add_event_handler("roster_update", self.on_roster_update)
161
        self.xmpp.add_event_handler("changed_status", self.on_presence)
louiz’'s avatar
louiz’ committed
162
        self.xmpp.add_event_handler("changed_subscription", self.on_changed_subscription)
163 164 165
        self.information(_('Welcome to poezio!'))
        self.refresh_window()

166 167 168 169 170 171 172
    def on_exception(self, typ, value, trace):
        """
        When an exception in raised, open a special tab
        displaying the traceback and some instructions to
        make a bug report.
        """
        try:
173
            tb_tab = tabs.SimpleTextTab(self, "/!\ Oups, an error occured (this may not be fatal). /!\\\nPlease report this bug (by copying the present error message and explaining what you were doing) on the page http://dev.louiz.org/project/poezio/bugs/add\n\n%s\n\nIf Poezio does not respond anymore, kill it with Ctrl+\\, and sorry about that :(" % ''.join(traceback.format_exception(typ, value, trace)))
174
            self.add_tab(tb_tab, focus=True)
175
        except Exception:       # If an exception is raised in this code,
176 177 178 179
                                # this is fatal, so we exit cleanly and display the traceback
            curses.endwin()
            raise

180 181 182 183 184 185 186
    def grow_information_win(self):
        """
        """
        if self.information_win_size == 14:
            return
        self.information_win_size += 1
        for tab in self.tabs:
187
            tab.on_info_win_size_changed()
188 189 190 191 192 193 194 195 196
        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:
197
            tab.on_info_win_size_changed()
198
        self.refresh_window()
199

200 201
    def on_got_offline(self, presence):
        jid = presence['from']
202
        contact = roster.get_contact_by_jid(jid.bare)
203 204
        if not contact:
            return
205 206 207
        resource = contact.get_resource_by_fulljid(jid.full)
        assert resource
        self.information('%s is offline' % (resource.get_jid()), "Roster")
208 209
        # If a resource got offline, display the message in the conversation with this
        # precise resource.
210
        self.add_information_message_to_conversation_tab(jid.full, '%s is offline' % (resource.get_jid().full))
211
        contact.remove_resource(resource)
212 213 214
        # Display the message in the conversation with the bare JID only if that was
        # the only resource online (i.e. now the contact is completely disconnected)
        if not contact.get_highest_priority_resource(): # No resource left: that was the last one
215
            self.add_information_message_to_conversation_tab(jid.bare, '%s is offline' % (jid.bare))
216
        self.refresh_window()
217 218 219

    def on_got_online(self, presence):
        jid = presence['from']
220
        contact = roster.get_contact_by_jid(jid.bare)
221
        if not contact:
222
            # Todo, handle presence comming from contacts not in roster
223
            return
224 225 226
        resource = contact.get_resource_by_fulljid(jid.full)
        assert not resource
        resource = Resource(jid.full)
227
        status = presence['type']
228
        status_message = presence['status']
229
        priority = presence.getPriority() or 0
230
        resource.set_status(status_message)
231 232 233
        resource.set_presence(status)
        resource.set_priority(priority)
        self.information("%s is online (%s)" % (resource.get_jid().full, status), "Roster")
234 235 236 237 238
        self.add_information_message_to_conversation_tab(jid.full, '%s is online' % (jid.full))
        if not contact.get_highest_priority_resource():
            # No connected resource yet: the user's just connecting
            self.add_information_message_to_conversation_tab(jid.bare, '%s is online' % (jid.bare))
        contact.add_resource(resource)
239 240 241 242 243 244 245 246 247 248

    def add_information_message_to_conversation_tab(self, jid, msg):
        """
        Search for a ConversationTab with the given jid (full or bare), if yes, add
        the given message to it
        """
        tab = self.get_tab_by_name(jid)
        if tab and isinstance(tab, tabs.ConversationTab):
            self.add_message_to_text_buffer(tab.get_room(), msg)

249 250 251 252 253 254 255 256 257 258
    def on_failed_connection(self):
        """
        We cannot contact the remote server
        """
        self.information(_("Connection to remote server failed"))

    def on_disconnected(self, event):
        """
        When we are disconnected from remote server
        """
louiz’'s avatar
louiz’ committed
259 260 261
        for tab in self.tabs:
            if isinstance(tab, tabs.MucTab):
                tab.get_room().disconnect()
262 263 264 265 266 267 268
        self.information(_("Disconnected from server."))

    def on_failed_auth(self, event):
        """
        Authentication failed
        """
        self.information(_("Authentication failed."))
269

270
    def on_connected(self, event):
271 272 273 274 275 276
        """
        Remote host responded, but we are not yet authenticated
        """
        self.information(_("Connected to server."))

    def on_session_start(self, event):
277 278 279
        """
        Called when we are connected and authenticated
        """
280
        self.information(_("Authentication success."))
281
        self.information(_("Your JID is %s") % self.xmpp.boundjid.full)
282 283 284 285
        if not self.xmpp.anon:
            # request the roster
            self.xmpp.getRoster()
            # send initial presence
286
            self.xmpp.makePresence().send()
287 288 289 290 291
        rooms = config.get('rooms', '')
        if rooms == '' or not isinstance(rooms, str):
            return
        rooms = rooms.split(':')
        for room in rooms:
292 293
            jid = JID(room)
            if jid.bare == '':
294
                return
295 296
            if jid.resource != '':
                nick = jid.resource
297 298 299 300 301
            else:
                default = os.environ.get('USER') if os.environ.get('USER') else 'poezio'
                nick = config.get('default_nick', '')
                if nick == '':
                    nick = default
louiz’'s avatar
louiz’ committed
302 303 304
            tab = self.get_tab_by_name(jid.bare)
            if not tab:
                self.open_new_room(jid.bare, nick, False)
305
            muc.join_groupchat(self.xmpp, jid.bare, nick)
306
        # if not self.xmpp.anon:
307 308 309 310 311 312 313 314 315 316 317 318 319
        # 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
320
        room = self.get_room_by_name(from_room)
321 322 323 324 325
        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)
326
        if not room:
327
            return
328 329 330 331 332 333 334 335 336 337 338 339
        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)
340
                if from_nick == room.own_nick:
341 342
                    room.joined = True
                    new_user.color = theme.COLOR_OWN_NICK
343
                    self.add_message_to_text_buffer(room, _("Your nickname is %s") % (from_nick))
344
                    if '170' in status_codes:
345
                        self.add_message_to_text_buffer(room, 'Warning: this room is publicly logged')
346
        else:
347 348 349 350 351 352 353 354
            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:
355
                self.on_user_nick_change(room, presence, user, from_nick, from_room)
356 357
            # kick
            elif kick:
358
                self.on_user_kicked(room, presence, user, from_nick)
359 360
            # user quit
            elif typ == 'unavailable':
361
                self.on_user_leave_groupchat(room, user, jid, status, from_nick, from_room)
362 363
            # status change
            else:
364
                self.on_user_change_status(room, user, from_nick, from_room, affiliation, role, show, status)
365
        self.refresh_window()
366
        self.doupdate()
367

368 369 370 371 372 373 374 375 376
    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:
377
                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)
378
            else:
379
                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)
380

381 382 383 384 385
    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
386
            for _tab in self.tabs:
387
                if isinstance(_tab, tabs.PrivateTab) and JID(_tab.get_name()).bare == room.name:
388
                    _tab.get_room().own_nick = new_nick
389
        user.change_nick(new_nick)
390
        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)
391 392 393
        # rename the private tabs if needed
        private_room = self.get_room_by_name('%s/%s' % (from_room, from_nick))
        if private_room:
394
            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)
395
            new_jid = JID(private_room.name).bare+'/'+new_nick
396
            private_room.name = new_jid
397

398 399 400 401 402 403 404
    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')
405
        by = by.attrib['jid'] if by is not None else None
406 407 408
        if from_nick == room.own_nick: # we are kicked
            room.disconnect()
            if by:
409
                kick_msg = _('%(spec)s [You] have been kicked by "[%(by)s]"') % {'spec': theme.CHAR_KICK.replace('"', '\\"'), 'by':by}
410
            else:
411
                kick_msg = _('%(spec)s [You] have been kicked.') % {'spec':theme.CHAR_KICK.replace('"', '\\"')}
412 413 414 415 416
            # try to auto-rejoin
            if config.get('autorejoin', 'false') == 'true':
                muc.join_groupchat(self.xmpp, room.name, room.own_nick)
        else:
            if by:
417
                kick_msg = _('%(spec)s "[%(nick)s]" has been kicked by "[%(by)s]"') % {'spec':theme.CHAR_KICK.replace('"', '\\"'), 'nick':from_nick.replace('"', '\\"'), 'by':by.replace('"', '\\"')}
418
            else:
419
                kick_msg = _('%(spec)s "[%(nick)s]" has been kicked') % {'spec':theme.CHAR_KICK, 'nick':from_nick.replace('"', '\\"')}
420 421
        if reason is not None and reason.text:
            kick_msg += _(' Reason: %(reason)s') % {'reason': reason.text}
422
        self.add_message_to_text_buffer(room, kick_msg, colorized=True)
423

424 425 426 427 428
    def on_user_leave_groupchat(self, room, user, jid, status, from_nick, from_room):
        """
        When an user leaves a groupchat
        """
        room.users.remove(user)
429 430 431
        if room.own_nick == user.nick:
            # We are now out of the room. Happens with some buggy (? not sure) servers
            room.disconnect()
432 433 434
        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:
435
                leave_msg = _('%(spec)s "[%(nick)s]" has left the room') % {'nick':from_nick.replace('"', '\\"'), 'spec':theme.CHAR_QUIT.replace('"', '\\"')}
436
            else:
437
                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('"', '\\"')}
438 439
            if status:
                leave_msg += ' (%s)' % status
440
            self.add_message_to_text_buffer(room, leave_msg, colorized=True)
441 442 443
        private_room = self.get_room_by_name('%s/%s' % (from_room, from_nick))
        if private_room:
            if not status:
444
                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)
445
            else:
446
                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)
447

448 449 450 451 452
    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
453 454
        display_message = False # flag to know if something significant enough
        # to be displayed has changed
455
        msg = _('"%s" changed: ')% from_nick.replace('"', '\\"')
456
        if affiliation != user.affiliation:
457
            msg += _('affiliation: %s, ') % affiliation
458
            display_message = True
459
        if role != user.role:
460
            msg += _('role: %s, ') % role
461
            display_message = True
462
        if show != user.show and show in list(SHOW_NAME.keys()):
463
            msg += _('show: %s, ') % SHOW_NAME[show]
464 465
            display_message = True
        if status and status != user.status:
466
            msg += _('status: %s, ') % status
467 468 469
            display_message = True
        if not display_message:
            return
470
        msg = msg[:-2] # remove the last ", "
471 472 473 474 475 476 477 478 479 480
        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
481
            self.add_message_to_text_buffer(room, msg, colorized=True)
482 483
        private_room = self.get_room_by_name('%s/%s' % (from_room, from_nick))
        if private_room: # display the message in private
484
            self.add_message_to_text_buffer(private_room, msg, colorized=True)
485 486 487
        # finally, effectively change the user status
        user.update(affiliation, show, status, role)

488 489 490 491 492 493
    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':
494
            return
495 496
        # Differentiate both type of messages, and call the appropriate handler.
        jid_from = message['from']
497
        for tab in self.tabs:
498
            if tab.get_name() == jid_from.bare and isinstance(tab, tabs.MucTab):
499
                if message['type'] == 'error':
500
                    return self.room_error(message, tab.get_room().name)
501 502
                else:
                    return self.on_groupchat_private_message(message)
503 504 505 506 507 508 509
        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']
510
        nick_from = jid.resource
511
        room_from = jid.bare
512 513
        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
514
            room = self.open_private_window(room_from, nick_from, False)
515 516 517
            if not room:
                return
        body = message['body']
518 519 520
        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))
521
        logger.log_message(jid.full.replace('/', '\\'), nick_from, body)
522
        self.refresh_window()
523
        self.doupdate()
524

525 526 527 528 529
    def focus_tab_named(self, tab_name):
        for tab in self.tabs:
            if tab.get_name() == tab_name:
                self.command_win('%s' % (tab.nb,))

530 531 532 533
    def on_normal_message(self, message):
        """
        When receiving "normal" messages (from someone in our roster)
        """
534
        jid = message['from']
535 536 537
        body = message['body']
        if not body:
            return
538 539 540 541 542 543 544 545
        # 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)
546
        if roster.get_contact_by_jid(jid.bare):
547
            remote_nick = roster.get_contact_by_jid(jid.bare).get_name() or jid.user
548
        else:
549
            remote_nick = jid.user
550
        conversation.get_room().add_message(body, None, remote_nick, False, theme.COLOR_REMOTE_USER)
551
        logger.log_message(jid.bare, remote_nick, body)
552 553
        if self.current_tab() is not conversation:
            conversation.set_color_state(theme.COLOR_TAB_PRIVATE)
554
        self.refresh_window()
555 556

    def on_presence(self, presence):
557
        jid = presence['from']
558
        contact = roster.get_contact_by_jid(jid.bare)
559 560 561 562 563 564
        if not contact:
            return
        resource = contact.get_resource_by_fulljid(jid.full)
        if not resource:
            return
        status = presence['type']
565
        status_message = presence['status']
566 567 568
        priority = presence.getPriority() or 0
        resource.set_presence(status)
        resource.set_priority(priority)
569
        resource.set_status(status_message)
570
        self.refresh_window()
571

572 573 574 575 576
    def on_roster_update(self, iq):
        """
        A subscription changed, or we received a roster item
        after a roster request, etc
        """
577 578
        for item in iq.findall('{jabber:iq:roster}query/{jabber:iq:roster}item'):
            jid = item.attrib['jid']
579
            contact = roster.get_contact_by_jid(jid)
580 581
            if not contact:
                contact = Contact(jid)
582
                roster.add_contact(contact, jid)
583 584 585 586
            if 'ask' in item.attrib:
                contact.set_ask(item.attrib['ask'])
            else:
                contact.set_ask(None)
587 588 589 590
            if 'name' in item.attrib:
                contact.set_name(item.attrib['name'])
            else:
                contact.set_name(None)
591 592 593
            if item.attrib['subscription']:
                contact.set_subscription(item.attrib['subscription'])
            groups = item.findall('{jabber:iq:roster}group')
594
            roster.edit_groups_of_contact(contact, [group.text for group in groups])
louiz’'s avatar
louiz’ committed
595 596
            if item.attrib['subscription'] == 'remove':
                roster.remove_contact(contact.get_bare_jid())
597
        if isinstance(self.current_tab(), tabs.RosterInfoTab):
598
            self.refresh_window()
599

louiz’'s avatar
louiz’ committed
600 601 602 603 604 605 606 607 608 609 610 611
    def on_changed_subscription(self, presence):
        """
        Triggered whenever a presence stanza with a type of subscribe, subscribed, unsubscribe, or unsubscribed is received.
        """
        if presence['type'] == 'subscribe':
            jid = presence['from'].bare
            contact = roster.get_contact_by_jid(jid)
            if not contact:
                contact = Contact(jid)
                roster.add_contact(contact, jid)
            roster.edit_groups_of_contact(contact, [])
            contact.set_ask('asked')
612 613
            self.tabs[0].set_color_state(theme.COLOR_TAB_HIGHLIGHT)
            self.information('%s wants to subscribe to your presence'%jid)
louiz’'s avatar
louiz’ committed
614 615 616
        if isinstance(self.current_tab(), tabs.RosterInfoTab):
            self.refresh_window()

617 618 619 620 621 622 623
    def full_screen_redraw(self):
        """
        Completely erase and redraw the screen
        """
        self.stdscr.clear()
        self.call_for_resize()

624 625 626 627 628 629 630
    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)
        """
631 632 633 634 635 636
        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
637
            self.resize_timer = threading.Timer(0.2, self.resize_window)
638
            self.resize_timer.start()
639

640 641 642 643
    def resize_window(self):
        """
        Resize the whole screen
        """
644 645
        with resize_lock:
            for tab in self.tabs:
646
                tab.resize()
647
            self.refresh_window()
648

649
    def main_loop(self):
650 651 652
        """
        main loop waiting for the user to press a key
        """
653
        curses.ungetch('\n')    # FIXME
654
        while self.running:
655
            char = read_char(self.stdscr)
656
            # search for keyboard shortcut
657
            if char in list(self.key_func.keys()):
658
                self.key_func[char]()
659
            else:
660
                self.do_command(char)
661
            self.doupdate()
662

663
    def current_tab(self):
664 665 666
        """
        returns the current room, the one we are viewing
        """
667
        return self.tabs[0]
668

669 670 671 672 673
    def get_conversation_by_jid(self, jid):
        """
        Return the room of the ConversationTab with the given jid
        """
        for tab in self.tabs:
674
            if isinstance(tab, tabs.ConversationTab):
675 676 677 678
                if tab.get_name() == jid:
                    return tab.get_room()
        return None

679 680 681 682 683 684 685 686 687
    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

688
    def get_room_by_name(self, name):
689 690 691
        """
        returns the room that has this name
        """
692
        for tab in self.tabs:
693
            if (isinstance(tab, tabs.MucTab) or
694
                isinstance(tab, tabs.PrivateTab)) and tab.get_name() == name:
695
                return tab.get_room()
696
        return None
697

698
    def init_curses(self, stdscr):
699 700 701
        """
        ncurses initialization
        """
702
        curses.curs_set(1)
703
        curses.noecho()
704
        theme.init_colors()
705
        stdscr.keypad(True)
706

707
    def reset_curses(self):
708 709 710 711
        """
        Reset terminal capabilities to what they were before ncurses
        init
        """
712
        log.debug('ALLO, reset_curses')
713
        curses.echo()
714
        curses.nocbreak()
715
        curses.curs_set(1)
716
        curses.endwin()
717

718 719 720 721
    def refresh_window(self):
        """
        Refresh everything
        """
722
        self.current_tab().set_color_state(theme.COLOR_TAB_CURRENT)
723
        self.current_tab().refresh(self.tabs, self.information_buffer, roster)
724
        self.doupdate()
725

726
    def add_tab(self, new_tab, focus=False):
727
        """
728 729
        Appends the new_tab in the tab list and
        focus it if focus==True
730
        """
731 732
        if self.current_tab().nb == 0:
            self.tabs.append(new_tab)
733
        else:
734 735 736
            for ta in self.tabs:
                if ta.nb == 0:
                    self.tabs.insert(self.tabs.index(ta), new_tab)
737
                    break
738
        if focus:
739
            self.command_win("%s" % new_tab.nb)
740 741 742 743 744 745 746 747

    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)
748
        self.refresh_window()
749

750 751 752 753 754 755
    def go_to_roster(self):
        self.command_win('0')

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

756 757 758 759 760 761 762
    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
        """
763 764 765
        for tab in self.tabs:
            if tab.get_color_state() == theme.COLOR_TAB_PRIVATE:
                self.command_win('%s' % tab.nb)
766
                return
767 768 769
        for tab in self.tabs:
            if tab.get_color_state() == theme.COLOR_TAB_HIGHLIGHT:
                self.command_win('%s' % tab.nb)
770
                return
771 772 773
        for tab in self.tabs:
            if tab.get_color_state() == theme.COLOR_TAB_NEW_MESSAGE:
                self.command_win('%s' % tab.nb)
774
                return
775 776 777 778
        for tab in self.tabs:
            if isinstance(tab, tabs.ChatTab) and not tab.input.is_empty():
                self.command_win('%s' % tab.nb)
                return
779

780
    def rotate_rooms_right(self, args=None):
781 782 783
        """
        rotate the rooms list to the right
        """
784 785 786
        self.current_tab().on_lose_focus()
        self.tabs.append(self.tabs.pop(0))
        self.current_tab().on_gain_focus()
787
        self.refresh_window()
788

789
    def rotate_rooms_left(self, args=None):
790 791 792
        """
        rotate the rooms list to the right
        """
793 794 795
        self.current_tab().on_lose_focus()
        self.tabs.insert(0, self.tabs.pop())
        self.current_tab().on_gain_focus()
796
        self.refresh_window()
797

798
    def scroll_page_down(self, args=None):
799
        self.current_tab().on_scroll_down()
800
        self.refresh_window()
801 802

    def scroll_page_up(self, args=None):
803
        self.current_tab().on_scroll_up()
804
        self.refresh_window()
805

806
    def room_error(self, error, room_name):
807 808 809
        """
        Display the error on the room window
        """
810 811 812 813 814 815
        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:
816
            if code in list(ERROR_AND_STATUS_CODES.keys()):
817 818
                body = ERROR_AND_STATUS_CODES[code]
            else:
819