gui.py 54.1 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 multiuserchat as muc
37
from handler import Handler
38
from config import config
39
from tab import MucTab, InfoTab, PrivateTab, RosterInfoTab, ConversationTab
40 41
from user import User
from room import Room
42
from roster import Roster, RosterGroup
43
from contact import Contact
44
from message import Message
45
from text_buffer import TextBuffer
46
from keyboard import read_char
47
from common import is_jid_the_same, jid_get_domain, jid_get_resource, is_jid
48

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

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

resize_lock = threading.Lock()

72 73
def doupdate():
    curses.doupdate()
74

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

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

128
        self.key_func = {
129 130
            "KEY_PPAGE": self.scroll_page_up,
            "KEY_NPAGE": self.scroll_page_down,
131
            "KEY_F(5)": self.rotate_rooms_left,
132
            "^P": self.rotate_rooms_left,
133
            "KEY_F(6)": self.rotate_rooms_right,
134 135
            "KEY_F(7)": self.shrink_information_win,
            "KEY_F(8)": self.grow_information_win,
136
            "^N": self.rotate_rooms_right,
137
            "KEY_RESIZE": self.call_for_resize,
138
            '^X': self.go_to_important_room,
139
            '^V': self.move_separator,
140 141
            }

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

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

172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
    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")

191 192 193 194 195 196 197
    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)

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

283 284 285 286 287 288 289 290 291
    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:
292
                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)
293
            else:
294
                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)
295

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

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

340 341 342 343 344
    def on_user_leave_groupchat(self, room, user, jid, status, from_nick, from_room):
        """
        When an user leaves a groupchat
        """
        room.users.remove(user)
345 346 347
        if room.own_nick == user.nick:
            # We are now out of the room. Happens with some buggy (? not sure) servers
            room.disconnect()
348 349 350
        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:
351
                leave_msg = _('%(spec)s "[%(nick)s]" has left the room') % {'nick':from_nick.replace('"', '\\"'), 'spec':theme.CHAR_QUIT.replace('"', '\\"')}
352
            else:
353
                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('"', '\\"')}
354 355
            if status:
                leave_msg += ' (%s)' % status
356
            self.add_message_to_text_buffer(room, leave_msg, colorized=True)
357 358 359
        private_room = self.get_room_by_name('%s/%s' % (from_room, from_nick))
        if private_room:
            if not status:
360
                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)
361
            else:
362
                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)
363

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

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

438 439 440 441 442
    def focus_tab_named(self, tab_name):
        for tab in self.tabs:
            if tab.get_name() == tab_name:
                self.command_win('%s' % (tab.nb,))

443 444 445 446
    def on_normal_message(self, message):
        """
        When receiving "normal" messages (from someone in our roster)
        """
447
        from common import debug
448
        debug('MESSAGE: %s\n' % (message))
449 450
        jid = message['from'].bare
        room = self.get_conversation_by_jid(jid)
451 452 453
        body = message['body']
        if not body:
            return
454 455 456 457 458 459
        if not room:
            room = self.open_conversation_window(jid, False)
            if not room:
                return
        self.add_message_to_text_buffer(room, body, None, jid)
        self.refresh_window()
460 461 462 463 464 465
        return

    def on_presence(self, presence):
        """
        """
        from common import debug
466
        debug('Presence: %s\n' % (presence))
467
        return
468

469 470 471 472 473
    def on_roster_update(self, iq):
        """
        A subscription changed, or we received a roster item
        after a roster request, etc
        """
474
        debug('Roster Update: \n%s\n\n' % iq)
475 476 477 478 479 480 481 482 483 484
        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)
485 486 487 488
            if 'name' in item.attrib:
                contact.set_name(item.attrib['name'])
            else:
                contact.set_name(None)
489 490 491 492 493 494 495
            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()
496

497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512
    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)
        """
        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.15, self.resize_window)
            self.resize_timer.start()

513 514 515 516
    def resize_window(self):
        """
        Resize the whole screen
        """
517 518 519 520 521
        with resize_lock:
            self.resize_timer = None
            for tab in self.tabs:
                tab.resize(self.stdscr)
            self.refresh_window()
522

523
    def main_loop(self):
524 525 526
        """
        main loop waiting for the user to press a key
        """
527
        self.refresh_window()
528
        while True:
529
            doupdate()
530
            char=read_char(self.stdscr)
531
            # search for keyboard shortcut
532
            if char in list(self.key_func.keys()):
533
                self.key_func[char]()
534
            else:
535
                self.do_command(char)
536

537
    def current_tab(self):
538 539 540
        """
        returns the current room, the one we are viewing
        """
541
        return self.tabs[0]
542

543 544 545 546 547 548 549 550 551 552
    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

553
    def get_room_by_name(self, name):
554 555 556
        """
        returns the room that has this name
        """
557 558 559 560
        for tab in self.tabs:
            if (isinstance(tab, MucTab) or
                isinstance(tab, PrivateTab)) and tab.get_name() == name:
                return tab.get_room()
561
        return None
562

563
    def init_curses(self, stdscr):
564 565 566
        """
        ncurses initialization
        """
567
        theme.init_colors()
568
        curses.noecho()
569
        curses.curs_set(0)
570
        stdscr.keypad(True)
571

572
    def reset_curses(self):
573 574 575 576 577
        """
        Reset terminal capabilities to what they were before ncurses
        init
        """
        curses.echo()
578
        curses.nocbreak()
579
        curses.endwin()
580

581 582 583 584
    def refresh_window(self):
        """
        Refresh everything
        """
585
        self.current_tab().set_color_state(theme.COLOR_TAB_CURRENT)
586 587
        self.current_tab().refresh(self.tabs, self.information_buffer, self.roster)
        doupdate()
588

589
    def open_new_room(self, room, nick, focus=True):
590
        """
591
        Open a new MucTab containing a muc Room, using the specified nick
592
        """
593 594 595 596
        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)
597
        else:
598 599 600
            for ta in self.tabs:
                if ta.nb == 0:
                    self.tabs.insert(self.tabs.index(ta), new_tab)
601
                    break
602
        if focus:
603
            self.command_win("%s" % new_tab.nb)
604
        self.refresh_window()
605

606 607 608 609 610 611 612
    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
        """
613 614 615
        for tab in self.tabs:
            if tab.get_color_state() == theme.COLOR_TAB_PRIVATE:
                self.command_win('%s' % tab.nb)
616
                return
617 618 619
        for tab in self.tabs:
            if tab.get_color_state() == theme.COLOR_TAB_HIGHLIGHT:
                self.command_win('%s' % tab.nb)
620
                return
621 622 623
        for tab in self.tabs:
            if tab.get_color_state() == theme.COLOR_TAB_NEW_MESSAGE:
                self.command_win('%s' % tab.nb)
624
                return
625

626
    def rotate_rooms_right(self, args=None):
627 628 629
        """
        rotate the rooms list to the right
        """
630 631 632
        self.current_tab().on_lose_focus()
        self.tabs.append(self.tabs.pop(0))
        self.current_tab().on_gain_focus()
633
        self.refresh_window()
634

635
    def rotate_rooms_left(self, args=None):
636 637 638
        """
        rotate the rooms list to the right
        """
639 640 641
        self.current_tab().on_lose_focus()
        self.tabs.insert(0, self.tabs.pop())
        self.current_tab().on_gain_focus()
642
        self.refresh_window()
643

644
    def scroll_page_down(self, args=None):
645
        self.current_tab().on_scroll_down()
646
        self.refresh_window()
647 648

    def scroll_page_up(self, args=None):
649
        self.current_tab().on_scroll_up()
650
        self.refresh_window()
651

652
    def room_error(self, error, room_name):
653 654 655
        """
        Display the error on the room window
        """
656 657 658 659 660 661
        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:
662
            if code in list(ERROR_AND_STATUS_CODES.keys()):
663 664
                body = ERROR_AND_STATUS_CODES[code]
            else:
665 666
                body = condition or _('Unknown error')
        if code:
667 668
            msg = _('Error: %(code)s - %(msg)s: %(body)s') % {'msg':msg, 'body':body, 'code':code}
            self.add_message_to_text_buffer(room, msg)
669
        else:
670 671
            msg = _('Error: %(msg)s: %(body)s') % {'msg':msg, 'body':body}
            self.add_message_to_text_buffer(room, msg)
672
        if code == '401':
673 674
            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)
675
        if code == '409':
676 677 678
            if config.get('alternative_nickname', '') != '':
                self.command_join('%s/%s'% (room.name, room.own_nick+config.get('alternative_nickname', '')))
            else:
679
                self.add_message_to_text_buffer(room, _('You can join the room with an other nick, by typing "/join /other_nick"'))
680
        self.refresh_window()
681

682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701
    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

702
    def open_private_window(self, room_name, user_nick, focus=True):
703
        complete_jid = room_name+'/'+user_nick
704 705 706 707
        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)
708 709
                    return
        # create the new tab
710
        room = self.get_room_by_name(room_name)
711 712 713
        if not room:
            return None
        own_nick = room.own_nick
714 715
        r = Room(complete_jid, own_nick) # PrivateRoom here
        new_tab = PrivateTab(self.stdscr, r, self.information_win_size)
716
        # insert it in the rooms
717 718
        if self.current_tab().nb == 0:
            self.tabs.append(new_tab)
719
        else:
720 721 722
            for ta in self.tabs:
                if ta.nb == 0:
                    self.tabs.insert(self.tabs.index(ta), new_tab)
723 724
                    break
        if focus:               # focus the room if needed
725
            self.command_win('%s' % (new_tab.nb))
726
        # self.window.new_room(r)
727
        self.refresh_window()
728 729
        return r

730
    def on_groupchat_message(self, message):
731
        """
732
        Triggered whenever a message is received from a multi-user chat room.
733
        """
734 735
        delay_tag = message.find('{urn:xmpp:delay}delay')
        if delay_tag is not None:
736
            delayed = True
737
            date = common.datetime_tuple(delay_tag.attrib['stamp'])
738
        else:
739 740
            # We support the OLD and deprecated XEP: http://xmpp.org/extensions/xep-0091.html
            # But it sucks, please, Jabber servers, don't do this :(
741 742
            delay_tag = message.find('{jabber:x:delay}x')
            if delay_tag is not None:
743
                delayed = True
744
                date = common.datetime_tuple(delay_tag.attrib['stamp'])
745 746
            else:
                delayed = False
747
                date = None
748
        nick_from = message['mucnick']
749
        room_from = message.getMucroom()
750 751
        if message['type'] == 'error': # Check if it's an error
            return self.room_error(message, from_room)
752 753
        if nick_from == room_from:
            nick_from = None
754
        room = self.get_room_by_name(room_from)
755
        if (room_from in self.ignores) and (nick_from in self.ignores[room_from]):
756
            return
757
        room = self.get_room_by_name(room_from)
758 759
        if not room:
            self.information(_("message received for a non-existing room: %s") % (room_from))
760
            return
761 762
        body = message['body']
        subject = message['subject']
763
        if subject:
764
            if nick_from:
765
                self.add_message_to_text_buffer(room, _("%(nick)s changed the subject to: %(subject)s") % {'nick':nick_from, 'subject':subject}, time=date)
766
            else:
767
                self.add_message_to_text_buffer(room, _("The subject is: %(subject)s") % {'subject':subject}, time=date)
768
            room.topic = subject.replace('\n', '|')
769
        elif body:
770
            if body.startswith('/me '):
771
                self.add_message_to_text_buffer(room, "* "+nick_from + ' ' + body[4:], date)
772
            else:
773
                date = date if delayed == True else None
774
                self.add_message_to_text_buffer(room, body, date, nick_from)
775
        self.refresh_window()
776
        doupdate()
777

778
    def add_message_to_text_buffer(self, room, txt, time=None, nickname=None, colorized=False):
779
        """
780 781
        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)
782
        """
783 784
        if not room:
            self.information('Error, trying to add a message in no room: %s' % txt)
785
        else:
786 787
            room.add_message(txt, time, nickname, colorized)
        self.refresh_window()
788

789
    def command_help(self, arg):
790 791 792
        """
        /help <command_name>
        """
793
        args = arg.split()
794
        if len(args) == 0:
795
            msg = _('Available commands are: ')
796
            for command in list(self.commands.keys()):
797
                msg += "%s " % command
798
            msg += _("\nType /help <command_name> to know what each command does")
799
        if len(args) == 1:
800
            if args[0] in list(self.commands.keys()):
801 802
                msg = self.commands[args[0]][1]
            else:
803
                msg = _('Unknown command: %s') % args[0]
804
        self.information(msg)
805

806 807 808 809
    def command_whois(self, arg):
        """
        /whois <nickname>
        """
810 811
        # TODO
        return
812 813 814 815
        # check shlex here
        try:
            args = shlex.split(arg)
        except ValueError as error:
816
            return self.information(str(error), _("Error"))
817 818
        room = self.current_room()
        if len(args) != 1:
819
            self.add_message_to_text_buffer(room, _('whois command takes exactly one argument'))
820 821 822 823