gui.py 48.2 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 sys
24
import os
25
import re
26
import curses
27 28
import webbrowser

29
from datetime import datetime
30 31

import common
32
import theme
33

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

44 45 46 47 48 49 50 51 52 53 54 55
# 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',
    }

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

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

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

110 111
        self.key_func = {
            "KEY_LEFT": self.window.input.key_left,
112
            "M-D": self.window.input.key_left,
113
            "KEY_RIGHT": self.window.input.key_right,
114
            "M-C": self.window.input.key_right,
115
            "KEY_UP": self.window.input.key_up,
116
            "M-A": self.window.input.key_up,
117 118 119
            "KEY_END": self.window.input.key_end,
            "KEY_HOME": self.window.input.key_home,
            "KEY_DOWN": self.window.input.key_down,
120
            "M-B": self.window.input.key_down,
121 122
            "KEY_PPAGE": self.scroll_page_up,
            "KEY_NPAGE": self.scroll_page_down,
123
            "KEY_DC": self.window.input.key_dc,
124
            "KEY_F(5)": self.rotate_rooms_left,
125
            "^P": self.rotate_rooms_left,
126
            "KEY_F(6)": self.rotate_rooms_right,
127
            "^N": self.rotate_rooms_right,
128 129
            "\t": self.completion,
            "^I": self.completion,
130
            "KEY_BTAB": self.last_words_completion,
131
            "KEY_RESIZE": self.resize_window,
132
            "KEY_BACKSPACE": self.window.input.key_backspace,
133
            '^?': self.window.input.key_backspace,
134 135 136 137 138 139 140 141 142 143 144 145
            '^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
146 147
            }

148 149 150 151 152
        # Add handlers
        self.xmpp.add_event_handler("session_start", self.on_connected)
        self.xmpp.add_event_handler("groupchat_presence", self.on_groupchat_presence)
        self.xmpp.add_event_handler("groupchat_message", self.on_groupchat_message)
        self.xmpp.add_event_handler("message", self.on_message)
153 154
        self.xmpp.add_event_handler("presence", self.on_presence)
        self.xmpp.add_event_handler("roster_update", self.on_roster_update)
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
        # 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)

171 172 173 174 175
        if not self.xmpp.anon:
            # request the roster
            self.xmpp.getRoster()
            # send initial presence
            self.xmpp.makePresence(pfrom=self.xmpp.jid).send()
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
        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)
194
        # if not self.xmpp.anon:
195 196 197 198 199 200 201 202 203 204 205 206 207
        # 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
208
        room = self.get_room_by_name(from_room)
209 210 211 212 213
        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)
214
        if not room:
215
            return
216 217 218 219 220 221 222 223 224 225 226 227
        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)
228
                if from_nick == room.own_nick:
229 230 231 232 233
                    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')
234
        else:
235 236 237 238 239 240 241 242
            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:
243
                self.on_user_nick_change(room, presence, user, from_nick, from_room)
244 245
            # kick
            elif kick:
246
                self.on_user_kicked(room, presence, user, from_nick)
247 248
            # user quit
            elif typ == 'unavailable':
249
                self.on_user_leave_groupchat(room, user, jid, status, from_nick, from_room)
250 251
            # status change
            else:
252
                self.on_user_change_status(room, user, from_nick, from_room, affiliation, role, show, status)
253 254
        if room == self.current_room():
            self.window.user_win.refresh(room.users)
255 256 257
        self.window.input.refresh()
        doupdate()

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

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

288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314
    def on_user_kicked(self, room, presence, user, from_nick):
        """
        When someone is kicked
        """
        room.users.remove(user)
        by = presence.find('{http://jabber.org/protocol/muc#user}x/{http://jabber.org/protocol/muc#user}item/{http://jabber.org/protocol/muc#user}actor')
        reason = presence.find('{http://jabber.org/protocol/muc#user}x/{http://jabber.org/protocol/muc#user}item/{http://jabber.org/protocol/muc#user}reason')
        by = by.attrib['jid'] if by else ''
        reason = reason.text# if reason else ''
        if from_nick == room.own_nick: # we are kicked
            room.disconnect()
            if by:
                kick_msg = _("%(spec) [You] have been kicked by [%(by)s].") % {'spec': theme.CHAR_KICK, 'by':by}
            else:
                kick_msg = _("%(spec)s [You] have been kicked.") % {'spec':theme.CHAR_KICK}
            # try to auto-rejoin
            if config.get('autorejoin', 'false') == 'true':
                muc.join_groupchat(self.xmpp, room.name, room.own_nick)
        else:
            if by:
                kick_msg = _("%(spec)s [%(nick)s] has been kicked by %(by)s.") % {'spec':theme.CHAR_KICK, 'nick':from_nick, 'by':by}
            else:
                kick_msg = _("%(spec)s [%(nick)s] has been kicked") % {'spec':theme.CHAR_KICK, 'nick':from_nick}
        if reason:
            kick_msg += _(' Reason: %(reason)s') % {'reason': reason}
        self.add_message_to_room(room, kick_msg, colorized=True)

315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335
    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:
                leave_msg = _('%(spec)s [%(nick)s] has left the room') % {'nick':from_nick, 'spec':theme.CHAR_QUIT}
            else:
                leave_msg = _('%(spec)s [%(nick)s] (%(jid)s) has left the room') % {'spec':theme.CHAR_QUIT, 'nick':from_nick, 'jid':jid.full}
            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:
                self.add_message_to_room(private_room, _('%(spec)s [%(nick)s] has left the room') % {'nick':from_nick, 'spec':theme.CHAR_QUIT}, colorized=True)
            else:
                self.add_message_to_room(private_room, _('%(spec)s [%(nick)s] has left the room (%(status)s)') % {'nick':from_nick, 'spec':theme.CHAR_QUIT, 'status': status}, colorized=True)

336 337 338 339 340 341 342 343 344 345
    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
346
        if show != user.show and show in list(SHOW_NAME.keys()):
347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367
            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)

368 369 370 371 372
    def on_message(self, message):
        """
        When receiving private message from a muc OR a normal message
        (from one of our contacts)
        """
373
        from common import debug
374
#        debug('message: %s\n' % message)
375 376 377 378 379 380
        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
381 382 383 384
                if message['type'] == 'error':
                    return self.room_error(message, room.name)
                else:
                    return self.on_groupchat_private_message(message)
385 386 387 388 389 390 391
        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']
392 393
        nick_from = jid.resource
        room_from = jid.bare
394 395
        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
396
            room = self.open_private_window(room_from, nick_from, False)
397 398 399 400 401 402 403 404 405 406 407
            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)
        """
408
        from common import debug
409
#        debug('MESSAGE: %s\n' % (presence))
410 411 412 413 414 415 416

        return

    def on_presence(self, presence):
        """
        """
        from common import debug
417
#        debug('PRESEEEEEEEEENCE: %s\n' % (presence))
418
        return
419

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

430 431 432 433 434 435 436
    def resize_window(self):
        """
        Resize the whole screen
        """
        self.window.resize(self.stdscr)
        self.window.refresh(self.rooms)

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

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

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

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

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

487 488 489 490
    def refresh_window(self):
        """
        Refresh everything
        """
491
        self.current_room().set_color_state(theme.COLOR_TAB_CURRENT)
492 493
        self.window.refresh(self.rooms)

494
    def open_new_room(self, room, nick, focus=True):
495
        """
496
        Open a new Tab containing a Muc room, using the specified nick
497
        """
498
        r = Room(room, nick, self.window)
499
        self.current_room().set_color_state(theme.COLOR_TAB_NORMAL)
500 501 502 503 504 505 506
        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
507 508
        if focus:
            self.command_win("%s" % r.nb)
509
        self.refresh_window()
510

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

518 519 520 521 522 523 524
    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()
525
        for msg in self.current_room().messages[:-9:-1]:
526 527
            if not msg:
                continue
528 529 530 531
            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:
532
                    words.append(word)
533 534
        self.window.input.auto_completion(words)

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

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

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

575
    def scroll_page_down(self, args=None):
576
        self.current_room().scroll_down(self.window.text_win.height-1)
577
        self.refresh_window()
578 579

    def scroll_page_up(self, args=None):
580
        self.current_room().scroll_up(self.window.text_win.height-1)
581
        self.refresh_window()
582

583
    def room_error(self, error, room_name):
584 585 586
        """
        Display the error on the room window
        """
587
        from common import debug
588
#        debug('ERROR: %s\n' % error)
589
        room = self.get_room_by_name(room_name)
590 591
        if not room:
            room = self.get_room_by_name('Info')
592 593 594 595 596
        msg = error['error']['type']
        condition = error['error']['condition']
        code = error['error']['code']
        body = error['error']['text']
        if not body:
597
            if code in list(ERROR_AND_STATUS_CODES.keys()):
598 599
                body = ERROR_AND_STATUS_CODES[code]
            else:
600 601 602 603 604 605 606
                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}))
607
        if code == '401':
608 609
            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':
610 611 612
            if config.get('alternative_nickname', '') != '':
                self.command_join('%s/%s'% (room.name, room.own_nick+config.get('alternative_nickname', '')))
            else:
613
                self.add_message_to_room(room, _('You can join the room with an other nick, by typing "/join /other_nick"'))
614
        self.refresh_window()
615

616
    def open_private_window(self, room_name, user_nick, focus=True):
617
        complete_jid = room_name+'/'+user_nick
618 619 620
        for room in self.rooms: # if the room exists, focus it and return
            if room.jid:
                if room.jid == complete_jid:
621
                    self.command_win('%s' % room.nb)
622 623
                    return
        # create the new tab
624
        room = self.get_room_by_name(room_name)
625 626 627
        if not room:
            return None
        own_nick = room.own_nick
628 629 630 631 632 633 634 635 636 637
        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
638
            self.command_win('%s' % (r.nb))
639
        # self.window.new_room(r)
640
        self.refresh_window()
641 642
        return r

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

696

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

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

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

757 758 759 760
    def command_whois(self, arg):
        """
        /whois <nickname>
        """
761 762
        # TODO
        return
763 764 765 766 767 768 769 770 771 772 773
        args = arg.split()
        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)

774 775 776 777
    def command_theme(self, arg):
        """
        """
        theme.reload_theme()
778
        self.resize_window()
779

780
    def command_win(self, arg):
781 782 783
        """
        /win <number>
        """
784
        args = arg.split()
785
        if len(args) != 1:
786
            self.command_help('win')
787 788 789 790
            return
        try:
            nb = int(args[0])
        except ValueError:
791
            self.command_help('win')
792 793 794
            return
        if self.current_room().nb == nb:
            return
795
        self.current_room().set_color_state(theme.COLOR_TAB_NORMAL)
796
        self.current_room().remove_line_separator()
797 798 799 800 801
        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:
802
                self.current_room().set_color_state(theme.COLOR_TAB_CURRENT)
803
                self.refresh_window()
804
                return
805
        self.current_room().set_color_state(theme.COLOR_TAB_CURRENT)
806
        self.refresh_window()
807

808
    def command_kick(self, arg):
809 810 811
        """
        /kick <nick> [reason]
        """
812
        args = arg.split()
813
        if len(args) < 1:
814
            self.command_help('kick')
815 816 817 818 819 820 821 822 823
            return
        nick = args[0]
        if len(args) >= 2:
            reason = ' '.join(args[1:])
        else:
            reason = ''
        if self.current_room().name == 'Info' or not self.current_room().joined:
            return
        roomname = self.current_room().name
824 825 826
        res = muc.eject_user(self.xmpp, roomname, nick, reason)
        if res['type'] == 'error':
            self.room_error(res, roomname)
827

828 829 830 831 832 833 834
    def command_say(self, arg):
        """
        /say <message>
        """
        line = arg
        if self.current_room().name != 'Info':
            if self.current_room().jid is not None:
835
                muc.send_private_message(self.xmpp, self.current_room().name, line)
836
                self.add_message_to_room(self.current_room(), line, None, self.current_room().own_nick)
837
            else:
838
                muc.send_groupchat_message(self.xmpp, self.current_room().name, line)
839 840 841
        self.window.input.refresh()
        doupdate()

842
    def command_join(self, arg):
843 844 845
        """
        /join [room][/nick] [password]
        """
846
        args = arg.split()
847
        password = None
848 849 850 851 852 853
        if len(args) == 0:
            r = self.current_room()
            if r.name == 'Info':
                return
            room = r.name
            nick = r.own_nick
854
        else:
855