gui.py 49.7 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
# Copyright 2010 Le Coz Florent <louizatakk@fedoraproject.org>
#
# This file is part of Poezio.
#
# Poezio is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, version 3 of the License.
#
# Poezio is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Poezio.  If not, see <http://www.gnu.org/licenses/>.

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

21 22
from time import sleep

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

30
from datetime import datetime
31 32

import common
33
import theme
34

35
import multiuserchat as muc
36
from handler import Handler
37
from config import config
38
from window import Window
39 40
from user import User
from room import Room
41
from message import Message
42
from keyboard import read_char
43
from common import is_jid_the_same, jid_get_domain, jid_get_resource, is_jid
44

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

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

67 68
class Gui(object):
    """
69
    User interface using ncurses
70
    """
71 72 73 74 75
    def __init__(self, xmpp):
        self.stdscr = curses.initscr()
        self.init_curses(self.stdscr)
        self.xmpp = xmpp
        self.window = Window(self.stdscr)
76
        self.rooms = [Room('Info', '', self.window)]
77
        self.ignores = {}
78

79
        self.commands = {
80
            'help': (self.command_help, '\_o< KOIN KOIN KOIN'),
81
            '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")),
82 83 84 85 86 87 88 89
            '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.")),
90 91
            '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.")),
92 93 94 95 96 97 98
            '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)")),
99
            'unquery': (self.command_unquery, _("Usage: /unquery\nClose the private conversation window")),
100 101 102
            '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")),
103
            '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.")),
104
            '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')),
105 106
            '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 "/"')),
107
            'whois': (self.command_whois, _('Usage: /whois <nickname>\nWhois: Request many informations about the user.')),
108
            'theme': (self.command_theme, _('Usage: /theme\nTheme: Reload the theme defined in the config file.')),
109 110
            }

111 112
        self.key_func = {
            "KEY_LEFT": self.window.input.key_left,
113
            "M-D": self.window.input.key_left,
114
            "KEY_RIGHT": self.window.input.key_right,
115
            "M-C": self.window.input.key_right,
116
            "KEY_UP": self.window.input.key_up,
117
            "M-A": self.window.input.key_up,
118 119 120
            "KEY_END": self.window.input.key_end,
            "KEY_HOME": self.window.input.key_home,
            "KEY_DOWN": self.window.input.key_down,
121
            "M-B": self.window.input.key_down,
122 123
            "KEY_PPAGE": self.scroll_page_up,
            "KEY_NPAGE": self.scroll_page_down,
124
            "KEY_DC": self.window.input.key_dc,
125
            "KEY_F(5)": self.rotate_rooms_left,
126
            "^P": self.rotate_rooms_left,
127
            "KEY_F(6)": self.rotate_rooms_right,
128
            "^N": self.rotate_rooms_right,
129 130
            "\t": self.completion,
            "^I": self.completion,
131
            "KEY_BTAB": self.last_words_completion,
132
            "KEY_RESIZE": self.resize_window,
133
            "KEY_BACKSPACE": self.window.input.key_backspace,
134
            '^?': self.window.input.key_backspace,
135 136 137 138 139 140 141 142 143 144 145 146
            '^J': self.execute,
            '\n': self.execute,
            '^D': self.window.input.key_dc,
            '^W': self.window.input.delete_word,
            '^K': self.window.input.delete_end_of_line,
            '^U': self.window.input.delete_begining_of_line,
            '^Y': self.window.input.paste_clipboard,
            '^A': self.window.input.key_home,
            '^E': self.window.input.key_end,
            'M-f': self.window.input.jump_word_right,
            '^X': self.go_to_important_room,
            'M-b': self.window.input.jump_word_left
147 148
            }

149 150 151 152 153
        # 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)
154 155
        self.xmpp.add_event_handler("presence", self.on_presence)
        self.xmpp.add_event_handler("roster_update", self.on_roster_update)
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171
        # self.handler = Handler()
        # self.handler.connect('on-connected', self.on_connected)
        # self.handler.connect('join-room', self.join_room)
        # self.handler.connect('room-presence', self.room_presence)
        # self.handler.connect('room-message', self.room_message)
        # self.handler.connect('private-message', self.private_message)
        # self.handler.connect('error-message', self.room_error)
        # self.handler.connect('error', self.information)

    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)

172 173 174 175 176
        if not self.xmpp.anon:
            # request the roster
            self.xmpp.getRoster()
            # send initial presence
            self.xmpp.makePresence(pfrom=self.xmpp.jid).send()
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194
        rooms = config.get('rooms', '')
        if rooms == '' or not isinstance(rooms, str):
            return
        rooms = rooms.split(':')
        for room in rooms:
            args = room.split('/')
            if args[0] == '':
                return
            roomname = args[0]
            if len(args) == 2:
                nick = args[1]
            else:
                default = os.environ.get('USER') if os.environ.get('USER') else 'poezio'
                nick = config.get('default_nick', '')
                if nick == '':
                    nick = default
            self.open_new_room(roomname, nick)
            muc.join_groupchat(self.xmpp, roomname, nick)
195
        # if not self.xmpp.anon:
196 197 198 199 200 201 202 203 204 205 206 207 208
        # 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
209
        room = self.get_room_by_name(from_room)
210 211 212 213 214
        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)
215
        if not room:
216
            return
217 218 219 220 221 222 223 224 225 226 227 228
        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)
229
                if from_nick == room.own_nick:
230 231 232 233 234
                    room.joined = True
                    new_user.color = theme.COLOR_OWN_NICK
                    self.add_message_to_room(room, _("Your nickname is %s") % (from_nick))
                    if '170' in status_codes:
                        self.add_message_to_room(room, 'Warning: this room is publicly logged')
235
        else:
236 237 238 239 240 241 242 243
            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:
244
                self.on_user_nick_change(room, presence, user, from_nick, from_room)
245 246
            # kick
            elif kick:
247
                self.on_user_kicked(room, presence, user, from_nick)
248 249
            # user quit
            elif typ == 'unavailable':
250
                self.on_user_leave_groupchat(room, user, jid, status, from_nick, from_room)
251 252
            # status change
            else:
253
                self.on_user_change_status(room, user, from_nick, from_room, affiliation, role, show, status)
254 255
        if room == self.current_room():
            self.window.user_win.refresh(room.users)
256 257 258
        self.window.input.refresh()
        doupdate()

259 260 261 262 263 264 265 266 267
    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:
268
                self.add_message_to_room(room, _('%(spec)s "[%(nick)s]" joined the room') % {'nick':from_nick.replace('"', '\\"'), 'spec':theme.CHAR_JOIN.replace('"', '\\"')}, colorized=True)
269
            else:
270
                self.add_message_to_room(room, _('%(spec)s "[%(nick)s]" "(%(jid)s)" joined the room') % {'spec':theme.CHAR_JOIN.replace('"', '\\"'), 'nick':from_nick.replace('"', '\\"'), 'jid':jid.full}, colorized=True)
271

272 273 274 275 276 277 278 279 280
    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
            for _room in self.rooms:
                if _room.jid is not None and is_jid_the_same(_room.jid, room.name):
                    _room.own_nick = new_nick
        user.change_nick(new_nick)
281
        self.add_message_to_room(room, _('"[%(old)s]" is now known as "[%(new)s]"') % {'old':from_nick.replace('"', '\\"'), 'new':new_nick.replace('"', '\\"')}, colorized=True)
282 283 284
        # rename the private tabs if needed
        private_room = self.get_room_by_name('%s/%s' % (from_room, from_nick))
        if private_room:
285
            self.add_message_to_room(private_room, _('"[%(old_nick)s]" is now known as "[%(new_nick)s]"') % {'old_nick':from_nick.replace('"', '\\"'), 'new_nick':new_nick.replace('"', '\\"')}, colorized=True)
286 287 288
            new_jid = private_room.name.split('/')[0]+'/'+new_nick
            private_room.jid = private_room.name = new_jid

289 290 291 292 293 294
    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')
295 296
        from common import debug
        debug('KICK: by:%s  %s, %s\n' % (presence, by, by.attrib['jid'] if by else by))
297
        reason = presence.find('{http://jabber.org/protocol/muc#user}x/{http://jabber.org/protocol/muc#user}item/{http://jabber.org/protocol/muc#user}reason')
298
        by = by.attrib['jid'] if by is not None else None
299 300 301 302
        reason = reason.text# if reason else ''
        if from_nick == room.own_nick: # we are kicked
            room.disconnect()
            if by:
303
                kick_msg = _('%(spec) [You] have been kicked by "[%(by)s]"') % {'spec': theme.CHAR_KICK.replace('"', '\\"'), 'by':by}
304
            else:
305
                kick_msg = _('%(spec)s [You] have been kicked.') % {'spec':theme.CHAR_KICK.replace('"', '\\"')}
306 307 308 309 310
            # try to auto-rejoin
            if config.get('autorejoin', 'false') == 'true':
                muc.join_groupchat(self.xmpp, room.name, room.own_nick)
        else:
            if by:
311
                kick_msg = _('%(spec)s "[%(nick)s]" has been kicked by "[%(by)s]"') % {'spec':theme.CHAR_KICK.replace('"', '\\"'), 'nick':from_nick.replace('"', '\\"'), 'by':by.replace('"', '\\"')}
312
            else:
313
                kick_msg = _('%(spec)s "[%(nick)s]" has been kicked') % {'spec':theme.CHAR_KICK, 'nick':from_nick.replace('"', '\\"')}
314 315 316 317
        if reason:
            kick_msg += _(' Reason: %(reason)s') % {'reason': reason}
        self.add_message_to_room(room, kick_msg, colorized=True)

318 319 320 321 322 323 324 325
    def on_user_leave_groupchat(self, room, user, jid, status, from_nick, from_room):
        """
        When an user leaves a groupchat
        """
        room.users.remove(user)
        hide_exit_join = config.get('hide_exit_join', -1) if config.get('hide_exit_join', -1) >= -1 else -1
        if hide_exit_join == -1 or user.has_talked_since(hide_exit_join):
            if not jid.full:
326
                leave_msg = _('%(spec)s "[%(nick)s]" has left the room') % {'nick':from_nick.replace('"', '\\"'), 'spec':theme.CHAR_QUIT.replace('"', '\\"')}
327
            else:
328
                leave_msg = _('%(spec)s "[%(nick)s]" (%(jid)s) has left the room') % {'spec':theme.CHAR_QUIT.replace('"', '\\"'), 'nick':from_nick.replace('"', '\\"'), 'jid':jid.full}
329 330 331 332 333 334
            if status:
                leave_msg += ' (%s)' % status
            self.add_message_to_room(room, leave_msg, colorized=True)
        private_room = self.get_room_by_name('%s/%s' % (from_room, from_nick))
        if private_room:
            if not status:
335
                self.add_message_to_room(private_room, _('%(spec)s "[%(nick)s]" has left the room') % {'nick':from_nick.replace('"', '\\"'), 'spec':theme.CHAR_QUIT.replace('"', '\\"')}, colorized=True)
336
            else:
337
                self.add_message_to_room(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)
338

339 340 341 342 343 344 345 346 347 348
    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
        msg = _('%s changed his/her status: ')% from_nick
        if affiliation != user.affiliation:
            msg += _('affiliation: %s,') % affiliation
        if role != user.role:
            msg += _('role: %s,') % role
349
        if show != user.show and show in list(SHOW_NAME.keys()):
350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370
            msg += _('show: %s,') % SHOW_NAME[show]
        if status != user.status:
            msg += _('status: %s,') % status
        msg = msg[:-1] # remove the last ","
        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
            self.add_message_to_room(room, msg)
        private_room = self.get_room_by_name('%s/%s' % (from_room, from_nick))
        if private_room: # display the message in private
            self.add_message_to_room(private_room, msg)
        # finally, effectively change the user status
        user.update(affiliation, show, status, role)

371 372 373 374 375
    def on_message(self, message):
        """
        When receiving private message from a muc OR a normal message
        (from one of our contacts)
        """
376
        from common import debug
377
#        debug('message: %s\n' % message)
378 379 380 381 382 383
        if message['type'] == 'groupchat':
            return None
        # Differentiate both type of messages, and call the appropriate handler.
        jid_from = message['from']
        for room in self.rooms:
            if room.jid is None and room.name == jid_from.bare: # check all the MUC we are in
384 385 386 387
                if message['type'] == 'error':
                    return self.room_error(message, room.name)
                else:
                    return self.on_groupchat_private_message(message)
388 389 390 391 392 393 394
        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']
395 396
        nick_from = jid.resource
        room_from = jid.bare
397 398
        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
399
            room = self.open_private_window(room_from, nick_from, False)
400 401 402 403 404 405 406 407 408 409 410
            if not room:
                return
        body = message['body']
        self.add_message_to_room(room, body, None, nick_from)
        self.window.input.refresh()
        doupdate()

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

        return

    def on_presence(self, presence):
        """
        """
        from common import debug
420
#        debug('PRESEEEEEEEEENCE: %s\n' % (presence))
421
        return
422

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

433 434 435 436 437 438 439
    def resize_window(self):
        """
        Resize the whole screen
        """
        self.window.resize(self.stdscr)
        self.window.refresh(self.rooms)

440
    def main_loop(self):
441 442 443
        """
        main loop waiting for the user to press a key
        """
444
        self.refresh_window()
445
        while True:
446
            doupdate()
447
            char=read_char(self.stdscr)
448
            # search for keyboard shortcut
449
            if char in list(self.key_func.keys()):
450
                self.key_func[char]()
451
            else:
452 453
                if not char or len(char) > 1:
                    continue    # ignore non-handled keyboard shortcuts
454
                self.window.do_command(char)
455

456
    def current_room(self):
457 458 459
        """
        returns the current room, the one we are viewing
        """
460
        return self.rooms[0]
461 462

    def get_room_by_name(self, name):
463 464 465 466
        """
        returns the room that has this name
        """
        for room in self.rooms:
467 468
            if room.name == name:
                return room
469
        return None
470

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

480
    def reset_curses(self):
481 482 483 484
        """
        Reset terminal capabilities to what they were before ncurses
        init
        """
485
        # TODO remove me?
486
        curses.echo()
487
        curses.nocbreak()
488
        curses.endwin()
489

490 491 492 493
    def refresh_window(self):
        """
        Refresh everything
        """
494
        self.current_room().set_color_state(theme.COLOR_TAB_CURRENT)
495 496
        self.window.refresh(self.rooms)

497
    def open_new_room(self, room, nick, focus=True):
498
        """
499
        Open a new Tab containing a Muc room, using the specified nick
500
        """
501
        r = Room(room, nick, self.window)
502
        self.current_room().set_color_state(theme.COLOR_TAB_NORMAL)
503 504 505 506 507 508 509
        if self.current_room().nb == 0:
            self.rooms.append(r)
        else:
            for ro in self.rooms:
                if ro.nb == 0:
                    self.rooms.insert(self.rooms.index(ro), r)
                    break
510 511
        if focus:
            self.command_win("%s" % r.nb)
512
        self.refresh_window()
513

514
    def completion(self):
515 516 517
        """
        Called when Tab is pressed, complete the nickname in the input
        """
518
        compare_users = lambda x: x.last_talked
519
        self.window.input.auto_completion([user.nick for user in sorted(self.current_room().users, key=compare_users, reverse=True)])
520

521 522 523 524 525 526 527
    def last_words_completion(self):
        """
        Complete the input with words recently said
        """
        # build the list of the recent words
        char_we_dont_want = [',', '(', ')', '.']
        words = list()
528
        for msg in self.current_room().messages[:-9:-1]:
529 530
            if not msg:
                continue
531 532 533 534
            for word in msg.txt.split():
                for char in char_we_dont_want: # remove the chars we don't want
                    word = word.replace(char, '')
                if len(word) > 5:
535
                    words.append(word)
536
        self.window.input.auto_completion(words, False)
537

538 539 540 541 542 543 544 545
    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
        """
        for room in self.rooms:
546
            if room.color_state == theme.COLOR_TAB_PRIVATE:
547
                self.command_win('%s' % room.nb)
548 549
                return
        for room in self.rooms:
550
            if room.color_state == theme.COLOR_TAB_HIGHLIGHT:
551
                self.command_win('%s' % room.nb)
552 553
                return
        for room in self.rooms:
554
            if room.color_state == theme.COLOR_TAB_NEW_MESSAGE:
555 556
                self.command_win('%s' % room.nb)
                return
557

558
    def rotate_rooms_right(self, args=None):
559 560 561
        """
        rotate the rooms list to the right
        """
562
        self.current_room().set_color_state(theme.COLOR_TAB_NORMAL)
563
        self.current_room().remove_line_separator()
564
        self.rooms.append(self.rooms.pop(0))
565
        self.current_room().set_color_state(theme.COLOR_TAB_CURRENT)
566
        self.refresh_window()
567

568
    def rotate_rooms_left(self, args=None):
569 570 571
        """
        rotate the rooms list to the right
        """
572
        self.current_room().set_color_state(theme.COLOR_TAB_NORMAL)
573
        self.current_room().remove_line_separator()
574
        self.rooms.insert(0, self.rooms.pop())
575
        self.current_room().set_color_state(theme.COLOR_TAB_CURRENT)
576
        self.refresh_window()
577

578
    def scroll_page_down(self, args=None):
579
        self.current_room().scroll_down(self.window.text_win.height-1)
580
        self.refresh_window()
581 582

    def scroll_page_up(self, args=None):
583
        self.current_room().scroll_up(self.window.text_win.height-1)
584
        self.refresh_window()
585

586
    def room_error(self, error, room_name):
587 588 589
        """
        Display the error on the room window
        """
590
        from common import debug
591
#        debug('ERROR: %s\n' % error)
592
        room = self.get_room_by_name(room_name)
593 594
        if not room:
            room = self.get_room_by_name('Info')
595 596 597 598 599
        msg = error['error']['type']
        condition = error['error']['condition']
        code = error['error']['code']
        body = error['error']['text']
        if not body:
600
            if code in list(ERROR_AND_STATUS_CODES.keys()):
601 602
                body = ERROR_AND_STATUS_CODES[code]
            else:
603 604 605 606 607 608 609
                body = condition or _('Unknown error')
        if code:
            self.add_message_to_room(room, _('Error: %(code)s - %(msg)s: %(body)s' %
                                             {'msg':msg, 'body':body, 'code':code}))
        else:
            self.add_message_to_room(room, _('Error: %(msg)s: %(body)s' %
                                             {'msg':msg, 'body':body}))
610
        if code == '401':
611 612
            self.add_message_to_room(room, _('To provide a password in order to join the room, type "/join / password" (replace "password" by the real password)'))
        if code == '409':
613 614 615
            if config.get('alternative_nickname', '') != '':
                self.command_join('%s/%s'% (room.name, room.own_nick+config.get('alternative_nickname', '')))
            else:
616
                self.add_message_to_room(room, _('You can join the room with an other nick, by typing "/join /other_nick"'))
617
        self.refresh_window()
618

619
    def open_private_window(self, room_name, user_nick, focus=True):
620
        complete_jid = room_name+'/'+user_nick
621 622 623
        for room in self.rooms: # if the room exists, focus it and return
            if room.jid:
                if room.jid == complete_jid:
624
                    self.command_win('%s' % room.nb)
625 626
                    return
        # create the new tab
627
        room = self.get_room_by_name(room_name)
628 629 630
        if not room:
            return None
        own_nick = room.own_nick
631 632 633 634 635 636 637 638 639 640
        r = Room(complete_jid, own_nick, self.window, complete_jid)
        # insert it in the rooms
        if self.current_room().nb == 0:
            self.rooms.append(r)
        else:
            for ro in self.rooms:
                if ro.nb == 0:
                    self.rooms.insert(self.rooms.index(ro), r)
                    break
        if focus:               # focus the room if needed
641
            self.command_win('%s' % (r.nb))
642
        # self.window.new_room(r)
643
        self.refresh_window()
644 645
        return r

646
    def on_groupchat_message(self, message):
647
        """
648
        Triggered whenever a message is received from a multi-user chat room.
649
        """
650 651
        from common import debug
#        debug('GROUPCHAT message: %s\n' % message)
652 653
        delay_tag = message.find('{urn:xmpp:delay}delay')
        if delay_tag is not None:
654
            delayed = True
655
            date = common.datetime_tuple(delay_tag.attrib['stamp'])
656
        else:
657 658
            # We support the OLD and deprecated XEP: http://xmpp.org/extensions/xep-0091.html
            # But it sucks, please, Jabber servers, don't do this :(
659 660
            delay_tag = message.find('{jabber:x:delay}x')
            if delay_tag is not None:
661
                delayed = True
662
                date = common.datetime_tuple(delay_tag.attrib['stamp'])
663 664
            else:
                delayed = False
665
                date = None
666
        nick_from = message['mucnick']
667
        room_from = message.getMucroom()
668 669
        if message['type'] == 'error': # Check if it's an error
            return self.room_error(message, from_room)
670 671
        if nick_from == room_from:
            nick_from = None
672
        room = self.get_room_by_name(room_from)
673
        if (room_from in self.ignores) and (nick_from in self.ignores[room_from]):
674
            return
675
        room = self.get_room_by_name(room_from)
676 677
        if not room:
            self.information(_("message received for a non-existing room: %s") % (room_from))
678
            return
679 680
        body = message['body']
        subject = message['subject']
681
#        debug('======== %s, %s, %s, %s====\n'% (nick_from, room_from, body, subject))
682
        if subject:
683
            if nick_from:
684
                self.add_message_to_room(room, _("%(nick)s changed the subject to: %(subject)s") % {'nick':nick_from, 'subject':subject}, time=date)
685
            else:
686
                self.add_message_to_room(room, _("The subject is: %(subject)s") % {'subject':subject}, time=date)
687
            room.topic = subject.replace('\n', '|')
688 689
            if room == self.current_room():
                self.window.topic_win.refresh(room.topic)
690
        elif body:
691
            if body.startswith('/me '):
692
                self.add_message_to_room(room, "* "+nick_from + ' ' + body[4:], date)
693
            else:
694 695
                date = date if delayed == True else None
                self.add_message_to_room(room, body, date, nick_from)
696
        self.refresh_window()
697
        doupdate()
698

699

700
    def add_message_to_room(self, room, txt, time=None, nickname=None, colorized=False):
701
        """
702 703
        Add the message to the room and refresh the associated component
        of the interface
704
        """
705 706
        if room != self.current_room():
            room.add_line_separator()
707
        room.add_message(txt, time, nickname, colorized)
708
        if room == self.current_room():
709 710
            self.window.text_win.refresh(room)
        else:
711
            self.window.info_win.refresh(self.rooms, self.current_room())
712
        self.window.input.refresh()
713 714

    def execute(self):
715 716 717
        """
        Execute the /command or just send the line on the current room
        """
718 719
        line = self.window.input.get_text()
        self.window.input.clear_text()
720
        self.window.input.refresh()
721 722
        if line == "":
            return
723
        if line.startswith('/') and not line.startswith('/me '):
724
            command = line.strip()[:].split()[0][1:]
725
            arg = line[2+len(command):] # jump the '/' and the ' '
726
            # example. on "/link 0 open", command = "link" and arg = "0 open"
727
            if command in list(self.commands.keys()):
728
                func = self.commands[command][0]
729
                func(arg)
730
                return
731
            else:
732
                self.add_message_to_room(self.current_room(), _("Error: unknown command (%s)") % (command))
733
        elif self.current_room().name != 'Info':
734
            if self.current_room().jid is not None:
735
                muc.send_private_message(self.xmpp, self.current_room().name, line)
736
                self.add_message_to_room(self.current_room(), line, None, self.current_room().own_nick)
737
            else:
738
                muc.send_groupchat_message(self.xmpp, self.current_room().name, line)
739
        self.window.input.refresh()
740
        doupdate()
741

742
    def command_help(self, arg):
743 744 745
        """
        /help <command_name>
        """
746
        args = arg.split()
747 748
        room = self.current_room()
        if len(args) == 0:
749
            msg = _('Available commands are: ')
750
            for command in list(self.commands.keys()):
751
                msg += "%s " % command
752
            msg += _("\nType /help <command_name> to know what each command does")
753
        if len(args) == 1:
754
            if args[0] in list(self.commands.keys()):
755 756
                msg = self.commands[args[0]][1]
            else:
757
                msg = _('Unknown command: %s') % args[0]
758
        self.add_message_to_room(room, msg)
759

760 761 762 763
    def command_whois(self, arg):
        """
        /whois <nickname>
        """
764 765
        # TODO
        return
766 767 768 769 770
        # check shlex here
        try:
            args = shlex.split(arg)
        except ValueError as error:
            return self.add_message_to_room(self.current_room(), _("Error: %s") % (error))
771 772 773 774 775 776 777 778 779 780
        room = self.current_room()
        if len(args) != 1:
            self.add_message_to_room(room, _('whois command takes exactly one argument'))
            return
        # check if current room is a MUC
        if room.jid or room.name == 'Info':
            return
        nickname = args[0]
        self.muc.request_vcard(room.name, nickname)

781 782 783 784
    def command_theme(self, arg):
        """
        """
        theme.reload_theme()
785
        self.resize_window()
786

787
    def command_win(self, arg):
788 789 790
        """
        /win <number>
        """
791
        args = arg.split()
792
        if len(args) != 1:
793
            self.command_help('win')
794 795 796 797
            return
        try:
            nb = int(args[0])
        except ValueError:
798
            self.command_help('win')
799 800 801
            return
        if self.current_room().nb == nb:
            return
802
        self.current_room().set_color_state(theme.COLOR_TAB_NORMAL)
803
        self.current_room().remove_line_separator()
804 805 806 807 808
        start = self.current_room()
        self.rooms.append(self.rooms.pop(0))
        while self.current_room().nb != nb:
            self.rooms.append(self.rooms.pop(0))
            if self.current_room() == start:
809
                self.current_room().set_color_state(theme.COLOR_TAB_CURRENT)
810
                self.refresh_window()
811
                return
812
        self.current_room().set_color_state(theme.COLOR_TAB_CURRENT)
813
        self.refresh_window()