muctab.py 74.8 KB
Newer Older
1 2 3 4 5 6 7 8 9
"""
Module for the MucTab

A MucTab is a tab for multi-user chats as defined in XEP-0045.

It keeps track of many things such as part/joins, maintains an
user list, and updates private tabs when necessary.
"""

10 11 12
import logging
log = logging.getLogger(__name__)

13
import bisect
14 15 16
import curses
import os
import random
17
import re
mathieui's avatar
mathieui committed
18
from datetime import datetime
19

20
from poezio.tabs import ChatTab, Tab, SHOW_NAME
21

22 23 24 25 26 27 28 29 30 31 32 33 34
from poezio import common
from poezio import fixes
from poezio import multiuserchat as muc
from poezio import timed_events
from poezio import windows
from poezio import xhtml
from poezio.common import safeJID
from poezio.config import config
from poezio.decorators import refresh_wrapper, command_args_parser
from poezio.logger import logger
from poezio.roster import roster
from poezio.theming import get_theme, dump_tuple
from poezio.user import User
35
from poezio.core.structs import Completion, Status
36 37 38


NS_MUC_USER = 'http://jabber.org/protocol/muc#user'
39
STATUS_XPATH = '{%s}x/{%s}status' % (NS_MUC_USER, NS_MUC_USER)
40 41 42 43 44 45 46 47 48 49


class MucTab(ChatTab):
    """
    The tab containing a multi-user-chat room.
    It contains an userlist, an input, a topic, an information and a chat zone
    """
    message_type = 'groupchat'
    plugin_commands = {}
    plugin_keys = {}
50

51 52
    def __init__(self, core, jid, nick, password=None):
        ChatTab.__init__(self, core, jid)
53 54 55
        self.joined = False
        self._state = 'disconnected'
        # our nick in the MUC
56
        self.own_nick = nick
57
        # self User object
58
        self.own_user = None
59
        self.name = jid
60
        self.password = password
61
        # buffered presences
62
        self.presence_buffer = []
63
        # userlist
64
        self.users = []
65 66
        # private conversations
        self.privates = []
67
        self.topic = ''
68
        self.topic_from = ''
69 70 71
        # We send active, composing and paused states to the MUC because
        # the chatstate may or may not be filtered by the MUC,
        # that’s not our problem.
72
        self._remote_wants_chatstates = True
73 74 75
        # Self ping event, so we can cancel it when we leave the room
        self.self_ping_event = None
        # UI stuff
76 77 78 79 80 81 82
        self.topic_win = windows.Topic()
        self.text_win = windows.TextWin()
        self._text_buffer.add_window(self.text_win)
        self.v_separator = windows.VerticalSeparator()
        self.user_win = windows.UserList()
        self.info_header = windows.MucInfoWin()
        self.input = windows.MessageInput()
83 84
        # List of ignored users
        self.ignores = []
85
        # keys
86 87
        self.register_keys()
        self.update_keys()
88
        # commands
89
        self.register_commands()
90
        self.update_commands()
91
        self.resize()
92 93 94

    @property
    def general_jid(self):
95
        return self.name
96

mathieui's avatar
mathieui committed
97 98 99 100
    def check_send_chat_state(self):
        "If we should send a chat state"
        return self.joined

101 102 103 104 105 106 107 108 109 110 111
    @property
    def last_connection(self):
        last_message = self._text_buffer.last_message
        if last_message:
            return last_message.time
        return None

    def cancel_config(self, form):
        """
        The user do not want to send his/her config, send an iq cancel
        """
112
        muc.cancel_config(self.core.xmpp, self.name)
113 114 115 116 117 118
        self.core.close_tab()

    def send_config(self, form):
        """
        The user sends his/her config to the server
        """
119
        muc.configure_room(self.core.xmpp, self.name, form)
120 121
        self.core.close_tab()

122 123 124 125 126 127 128 129 130 131 132 133 134 135 136
    def join(self):
        """
        Join the room
        """
        status = self.core.get_status()
        if self.last_connection:
            delta = datetime.now() - self.last_connection
            seconds = delta.seconds + delta.days * 24 * 3600
        else:
            seconds = 0
        muc.join_groupchat(self.core, self.name, self.own_nick,
                           self.password,
                           status=status.message,
                           show=status.show,
                           seconds=seconds)
137

mathieui's avatar
mathieui committed
138 139 140 141 142
    def leave_room(self, message):
        if self.joined:
            info_col = dump_tuple(get_theme().COLOR_INFORMATION_TEXT)
            char_quit = get_theme().CHAR_QUIT
            spec_col = dump_tuple(get_theme().COLOR_QUIT_CHAR)
143

144 145
            if config.get_by_tabname('display_user_color_in_join_part',
                                     self.general_jid):
146 147 148 149
                color = dump_tuple(get_theme().COLOR_OWN_NICK)
            else:
                color = 3

mathieui's avatar
mathieui committed
150
            if message:
151 152
                msg = ('\x19%(color_spec)s}%(spec)s\x19%(info_col)s} '
                       'You (\x19%(color)s}%(nick)s\x19%(info_col)s})'
153
                       ' left the room'
154
                       ' (\x19o%(reason)s\x19%(info_col)s})') % {
mathieui's avatar
mathieui committed
155
                           'info_col': info_col, 'reason': message,
156 157 158 159
                           'spec': char_quit, 'color': color,
                           'color_spec': spec_col,
                           'nick': self.own_nick,
                       }
160
            else:
161 162
                msg = ('\x19%(color_spec)s}%(spec)s\x19%(info_col)s} '
                       'You (\x19%(color)s}%(nick)s\x19%(info_col)s})'
163
                       ' left the room') % {
164 165 166 167 168
                           'info_col': info_col,
                           'spec': char_quit, 'color': color,
                           'color_spec': spec_col,
                           'nick': self.own_nick,
                       }
169

170
            self.add_message(msg, typ=2)
171
            self.disconnect()
mathieui's avatar
mathieui committed
172
            muc.leave_groupchat(self.core.xmpp, self.name, self.own_nick, message)
173
            self.core.disable_private_tabs(self.name, reason=msg)
174
        else:
mathieui's avatar
mathieui committed
175 176
            muc.leave_groupchat(self.core.xmpp, self.name, self.own_nick, message)

177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
    def change_affiliation(self, nick_or_jid, affiliation, reason=''):
        """
        Change the affiliation of a nick or JID
        """
        def callback(iq):
            if iq['type'] == 'error':
                self.core.information("Could not set affiliation '%s' for '%s'." % (
                    affiliation, nick_or_jid), "Warning")
        if not self.joined:
            return

        valid_affiliations = ('outcast', 'none', 'member', 'admin', 'owner')
        if affiliation not in valid_affiliations:
            return self.core.information('The affiliation must be one of ' + ', '.join(valid_affiliations),
                                         'Error')
        if nick_or_jid in [user.nick for user in self.users]:
            res = muc.set_user_affiliation(self.core.xmpp, self.name,
                                           affiliation, nick=nick_or_jid,
                                           callback=callback, reason=reason)
        else:
            res = muc.set_user_affiliation(self.core.xmpp, self.name,
                                           affiliation, jid=safeJID(nick_or_jid),
                                           callback=callback, reason=reason)

    def change_role(self, nick, role, reason=''):
        """
        Change the role of a nick
        """
        def callback(iq):
            if iq['type'] == 'error':
                self.core.information("Could not set role '%s' for '%s'." % (
                    role, nick), "Warning")
        valid_roles = ('none', 'visitor', 'participant', 'moderator')

        if not self.joined or role not in valid_roles:
            return self.core.information('The role must be one of ' + ', '.join(valid_roles),
                                         'Error')

        if not safeJID(self.name + '/' + nick):
            return self.core.information('Invalid nick', 'Info')
        muc.set_user_role(self.core.xmpp, self.name, nick, reason, role,
                          callback=callback)

mathieui's avatar
mathieui committed
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
    @refresh_wrapper.conditional
    def print_info(self, nick):
        """Print information about a user"""
        user = self.get_user_by_name(nick)
        if not user:
            return False

        theme = get_theme()
        inf = '\x19' + dump_tuple(theme.COLOR_INFORMATION_TEXT) + '}'
        if user.jid:
            user_jid = '%s (\x19%s}%s\x19o%s)' % (
                            inf,
                            dump_tuple(theme.COLOR_MUC_JID),
                            user.jid,
                            inf)
        else:
            user_jid = ''
        info = ('\x19%(user_col)s}%(nick)s\x19o%(jid)s%(info)s: show: '
                '\x19%(show_col)s}%(show)s\x19o%(info)s, affiliation: '
                '\x19%(role_col)s}%(affiliation)s\x19o%(info)s, role: '
                '\x19%(role_col)s}%(role)s\x19o%(status)s') % {
                        'user_col': dump_tuple(user.color),
                        'nick': nick,
                        'jid': user_jid,
                        'info': inf,
                        'show_col': dump_tuple(theme.color_show(user.show)),
                        'show': user.show or 'Available',
                        'role_col': dump_tuple(theme.color_role(user.role)),
                        'affiliation': user.affiliation or 'None',
                        'role': user.role or 'None',
                        'status': '\n%s' % user.status if user.status else ''}
        self.add_message(info, typ=0)
        return True

mathieui's avatar
mathieui committed
254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
    def change_topic(self, topic):
        """Change the current topic"""
        muc.change_subject(self.core.xmpp, self.name, topic)

    @refresh_wrapper.always
    def show_topic(self):
        """
        Print the current topic
        """
        info_text = dump_tuple(get_theme().COLOR_INFORMATION_TEXT)
        norm_text = dump_tuple(get_theme().COLOR_NORMAL_TEXT)
        if self.topic_from:
            user = self.get_user_by_name(self.topic_from)
            if user:
                user_text = dump_tuple(user.color)
                user_string = '\x19%s}(set by \x19%s}%s\x19%s})' % (
                        info_text, user_text, user.nick, info_text)
            else:
                user_string = self.topic_from
        else:
            user_string = ''

        self._text_buffer.add_message(
                "\x19%s}The subject of the room is: \x19%s}%s %s" %
                    (info_text, norm_text, self.topic, user_string))

mathieui's avatar
mathieui committed
280 281 282 283 284 285 286 287 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
    @refresh_wrapper.always
    def recolor(self, random_colors=False):
        """Recolor the current MUC users"""
        deterministic = config.get_by_tabname('deterministic_nick_colors', self.name)
        if deterministic:
            for user in self.users:
                if user is self.own_user:
                    continue
                color = self.search_for_color(user.nick)
                if color != '':
                    continue
                user.set_deterministic_color()
            return
        # Sort the user list by last talked, to avoid color conflicts
        # on active participants
        compare_users = lambda x: x.last_talked
        sorted_users = sorted(self.users, key=compare_users, reverse=True)
        full_sorted_users = sorted_users[:]
        # search our own user, to remove it from the list
        # Also remove users whose color is fixed
        for user in full_sorted_users:
            color = self.search_for_color(user.nick)
            if user is self.own_user:
                sorted_users.remove(user)
            elif color != '':
                sorted_users.remove(user)
                user.change_color(color, deterministic)
        colors = list(get_theme().LIST_COLOR_NICKNAMES)
        if random_colors:
            random.shuffle(colors)
        for i, user in enumerate(sorted_users):
            user.color = colors[i % len(colors)]
        self.text_win.rebuild_everything(self._text_buffer)

314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342
    @refresh_wrapper.conditional
    def set_nick_color(self, nick, color):
        "Set a custom color for a nick, permanently"
        user = self.get_user_by_name(nick)
        if color not in xhtml.colors and color not in ('unset', 'random'):
            return False
        if nick == self.own_nick:
            return False
        if color == 'unset':
            if config.remove_and_save(nick, 'muc_colors'):
                self.core.information('Color for nick %s unset' % (nick), 'Info')
        else:
            if color == 'random':
                color = random.choice(list(xhtml.colors))
            if user:
                user.change_color(color)
            config.set_and_save(nick, color, 'muc_colors')
            nick_color_aliases = config.get_by_tabname('nick_color_aliases', self.name)
            if nick_color_aliases:
                # if any user in the room has a nick which is an alias of the
                # nick, update its color
                for tab in self.core.get_tabs(MucTab):
                    for u in tab.users:
                        nick_alias = re.sub('^_*', '', u.nick)
                        nick_alias = re.sub('_*$', '', nick_alias)
                        if nick_alias == nick:
                            u.change_color(color)
        self.text_win.rebuild_everything(self._text_buffer)
        return True
mathieui's avatar
mathieui committed
343

mathieui's avatar
mathieui committed
344 345 346 347 348 349 350 351 352 353 354
    def on_input(self, key, raw):
        if not raw and key in self.key_func:
            self.key_func[key]()
            return False
        self.input.do_command(key, raw=raw)
        empty_after = self.input.get_text() == ''
        empty_after = empty_after or (self.input.get_text().startswith('/')
                                      and not
                                      self.input.get_text().startswith('//'))
        self.send_composing_chat_state(empty_after)
        return False
355

mathieui's avatar
mathieui committed
356 357 358 359
    def get_nick(self):
        if not config.get('show_muc_jid'):
            return safeJID(self.name).user
        return self.name
360

mathieui's avatar
mathieui committed
361 362
    def get_text_window(self):
        return self.text_win
363

mathieui's avatar
mathieui committed
364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388
    def on_lose_focus(self):
        if self.joined:
            if self.input.text:
                self.state = 'nonempty'
            else:
                self.state = 'normal'
        else:
            self.state = 'disconnected'
        self.text_win.remove_line_separator()
        self.text_win.add_line_separator(self._text_buffer)
        if config.get_by_tabname('send_chat_states', self.general_jid):
            self.send_chat_state('inactive')
        self.check_scrolled()

    def on_gain_focus(self):
        self.state = 'current'
        if (self.text_win.built_lines and self.text_win.built_lines[-1] is None
                and not config.get('show_useless_separator')):
            self.text_win.remove_line_separator()
        curses.curs_set(1)
        if self.joined and config.get_by_tabname('send_chat_states',
                self.general_jid) and not self.input.get_text():
            self.send_chat_state('active')

    def handle_presence(self, presence):
389
        """
mathieui's avatar
mathieui committed
390
        Handle MUC presence
391
        """
mathieui's avatar
mathieui committed
392 393 394
        status_codes = set()
        for status_code in presence.xml.findall(STATUS_XPATH):
            status_codes.add(status_code.attrib['code'])
mathieui's avatar
mathieui committed
395 396 397
        if presence['type'] == 'error':
            self.core.room_error(presence, self.name)
        elif not self.joined:
mathieui's avatar
mathieui committed
398
            if '110' in status_codes:
mathieui's avatar
mathieui committed
399
                self.process_presence_buffer(presence)
mathieui's avatar
mathieui committed
400 401 402 403 404 405 406 407 408 409 410 411 412 413
            else:
                self.presence_buffer.append(presence)
                return
        else:
            try:
                self.handle_presence_joined(presence, status_codes)
            except PresenceError:
                self.core.room_error(presence, presence['from'].bare)
        if self.core.current_tab() is self:
            self.text_win.refresh()
            self.user_win.refresh_if_changed(self.users)
            self.info_header.refresh(self, self.text_win, user=self.own_user)
            self.input.refresh()
            self.core.doupdate()
414

mathieui's avatar
mathieui committed
415
    def process_presence_buffer(self, last_presence):
416
        """
mathieui's avatar
mathieui committed
417
        Batch-process all the initial presences
418
        """
mathieui's avatar
mathieui committed
419
        deterministic = config.get_by_tabname('deterministic_nick_colors', self.name)
mathieui's avatar
mathieui committed
420

mathieui's avatar
mathieui committed
421 422 423 424 425 426 427 428 429 430 431 432 433 434
        for stanza in self.presence_buffer:
            try:
                self.handle_presence_unjoined(stanza, deterministic)
            except PresenceError:
                self.core.room_error(stanza, stanza['from'].bare)
        self.handle_presence_unjoined(last_presence, deterministic, own=True)
        self.users.sort()
        # Enable the self ping event, to regularly check if we
        # are still in the room.
        self.enable_self_ping_event()
        if self.core.current_tab() is not self:
            self.refresh_tab_win()
            self.core.current_tab().input.refresh()
            self.core.doupdate()
435

mathieui's avatar
mathieui committed
436 437 438 439 440 441 442 443 444 445 446 447 448 449 450
    def handle_presence_unjoined(self, presence, deterministic, own=False):
        """
        Presence received while we are not in the room (before code=110)
        """
        from_nick, from_room, affiliation, show, status, role, jid, typ = dissect_presence(presence)
        user_color = self.search_for_color(from_nick)
        new_user = User(from_nick, affiliation, show,
                        status, role, jid, deterministic, user_color)
        self.users.append(new_user)
        self.core.events.trigger('muc_join', presence, self)
        if own:
            status_codes = set()
            for status_code in presence.xml.findall(STATUS_XPATH):
                status_codes.add(status_code.attrib['code'])
            self.own_join(from_nick, new_user, status_codes)
451

mathieui's avatar
mathieui committed
452
    def own_join(self, from_nick, new_user, status_codes):
453
        """
mathieui's avatar
mathieui committed
454
        Handle the last presence we received, entering the room
455
        """
mathieui's avatar
mathieui committed
456 457 458 459 460 461 462 463 464 465 466 467
        self.own_nick = from_nick
        self.own_user = new_user
        self.joined = True
        if self.name in self.core.initial_joins:
            self.core.initial_joins.remove(self.name)
            self._state = 'normal'
        elif self != self.core.current_tab():
            self._state = 'joined'
        if (self.core.current_tab() is self
                and self.core.status.show not in ('xa', 'away')):
            self.send_chat_state('active')
        new_user.color = get_theme().COLOR_OWN_NICK
468

mathieui's avatar
mathieui committed
469 470 471 472 473
        if config.get_by_tabname('display_user_color_in_join_part',
                                 self.general_jid):
            color = dump_tuple(new_user.color)
        else:
            color = 3
474

mathieui's avatar
mathieui committed
475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509
        info_col = dump_tuple(get_theme().COLOR_INFORMATION_TEXT)
        warn_col = dump_tuple(get_theme().COLOR_WARNING_TEXT)
        spec_col = dump_tuple(get_theme().COLOR_JOIN_CHAR)
        enable_message = (
            '\x19%(color_spec)s}%(spec)s\x19%(info_col)s} You '
            '(\x19%(nick_col)s}%(nick)s\x19%(info_col)s}) joined'
            ' the room') % {
                'nick': from_nick,
                'spec': get_theme().CHAR_JOIN,
                'color_spec': spec_col,
                'nick_col': color,
                'info_col': info_col,
                }
        self.add_message(enable_message, typ=2)
        self.core.enable_private_tabs(self.name, enable_message)
        if '201' in status_codes:
            self.add_message(
                    '\x19%(info_col)s}Info: The room '
                    'has been created' %
                       {'info_col': info_col},
                typ=0)
        if '170' in status_codes:
            self.add_message(
                    '\x19%(warn_col)s}Warning:\x19%(info_col)s}'
                    ' This room is publicly logged' %
                        {'info_col': info_col,
                         'warn_col': warn_col},
                typ=0)
        if '100' in status_codes:
            self.add_message(
                    '\x19%(warn_col)s}Warning:\x19%(info_col)s}'
                    ' This room is not anonymous.' %
                        {'info_col': info_col,
                         'warn_col': warn_col},
                typ=0)
510

mathieui's avatar
mathieui committed
511
    def handle_presence_joined(self, presence, status_codes):
512
        """
mathieui's avatar
mathieui committed
513
        Handle new presences when we are already in the room
514
        """
mathieui's avatar
mathieui committed
515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554
        from_nick, from_room, affiliation, show, status, role, jid, typ = dissect_presence(presence)
        change_nick = '303' in status_codes
        kick = '307' in status_codes and typ == 'unavailable'
        ban = '301' in status_codes and typ == 'unavailable'
        shutdown = '332' in status_codes and typ == 'unavailable'
        non_member = '322' in status_codes and typ == 'unavailable'
        user = self.get_user_by_name(from_nick)
        # New user
        if not user and typ != "unavailable":
            user_color = self.search_for_color(from_nick)
            self.core.events.trigger('muc_join', presence, self)
            self.on_user_join(from_nick, affiliation, show, status, role,
                              jid, user_color)
        elif user is None:
            log.error('BUG: User %s in %s is None', from_nick, self.name)
            return
        elif change_nick:
            self.core.events.trigger('muc_nickchange', presence, self)
            self.on_user_nick_change(presence, user, from_nick, from_room)
        elif ban:
            self.core.events.trigger('muc_ban', presence, self)
            self.core.on_user_left_private_conversation(from_room,
                                                        user, status)
            self.on_user_banned(presence, user, from_nick)
        elif kick:
            self.core.events.trigger('muc_kick', presence, self)
            self.core.on_user_left_private_conversation(from_room,
                                                        user, status)
            self.on_user_kicked(presence, user, from_nick)
        elif shutdown:
            self.core.events.trigger('muc_shutdown', presence, self)
            self.on_muc_shutdown()
        elif non_member:
            self.core.events.trigger('muc_shutdown', presence, self)
            self.on_non_member_kicked()
        # user quit
        elif typ == 'unavailable':
            self.on_user_leave_groupchat(user, jid, status,
                                         from_nick, from_room)
        # status change
555
        else:
mathieui's avatar
mathieui committed
556 557
            self.on_user_change_status(user, from_nick, from_room,
                                       affiliation, role, show, status)
558

mathieui's avatar
mathieui committed
559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577
    def on_non_member_kicked(self):
        """We have been kicked because the MUC is members-only"""
        self.add_message(
                '\x19%(info_col)s}You have been kicked because you '
                'are not a member and the room is now members-only.' % {
            'info_col': dump_tuple(get_theme().COLOR_INFORMATION_TEXT)},
            typ=2)
        self.disconnect()

    def on_muc_shutdown(self):
        """We have been kicked because the MUC service is shutting down"""
        self.add_message(
                '\x19%(info_col)s}You have been kicked because the'
                ' MUC service is shutting down.' % {
            'info_col': dump_tuple(get_theme().COLOR_INFORMATION_TEXT)},
            typ=2)
        self.disconnect()

    def on_user_join(self, from_nick, affiliation, show, status, role, jid, color):
578
        """
mathieui's avatar
mathieui committed
579
        When a new user joins the groupchat
580
        """
mathieui's avatar
mathieui committed
581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623
        deterministic = config.get_by_tabname('deterministic_nick_colors', self.name)
        user = User(from_nick, affiliation,
                    show, status, role, jid, deterministic, color)
        bisect.insort_left(self.users, user)
        hide_exit_join = config.get_by_tabname('hide_exit_join',
                                               self.general_jid)
        if hide_exit_join != 0:
            if config.get_by_tabname('display_user_color_in_join_part',
                                     self.general_jid):
                color = dump_tuple(user.color)
            else:
                color = 3
            info_col = dump_tuple(get_theme().COLOR_INFORMATION_TEXT)
            spec_col = dump_tuple(get_theme().COLOR_JOIN_CHAR)
            char_join = get_theme().CHAR_JOIN
            if not jid.full:
                msg = ('\x19%(color_spec)s}%(spec)s \x19%(color)s}%(nick)s'
                       '\x19%(info_col)s} joined the room') % {
                            'nick': from_nick, 'spec': char_join,
                            'color': color,
                            'info_col': info_col,
                            'color_spec': spec_col,
                            }
            else:
                msg = ('\x19%(color_spec)s}%(spec)s \x19%(color)s}%(nick)s'
                       '\x19%(info_col)s} (\x19%(jid_color)s}%(jid)s\x19'
                       '%(info_col)s}) joined the room') % {
                            'spec': char_join, 'nick': from_nick,
                            'color':color, 'jid':jid.full,
                            'info_col': info_col,
                            'jid_color': dump_tuple(get_theme().COLOR_MUC_JID),
                            'color_spec': spec_col,
                            }
            self.add_message(msg, typ=2)
        self.core.on_user_rejoined_private_conversation(self.name, from_nick)

    def on_user_nick_change(self, presence, user, from_nick, from_room):
        new_nick = presence.xml.find('{%s}x/{%s}item' % (NS_MUC_USER, NS_MUC_USER)
                                     ).attrib['nick']
        if user.nick == self.own_nick:
            self.own_nick = new_nick
            # also change our nick in all private discussions of this room
            self.core.handler.on_muc_own_nickchange(self)
624
        else:
mathieui's avatar
mathieui committed
625 626 627 628 629 630 631 632
            color = config.get_by_tabname(new_nick, 'muc_colors')
            if color != '':
                deterministic = config.get_by_tabname('deterministic_nick_colors',
                                                      self.name)
                user.change_color(color, deterministic)
        user.change_nick(new_nick)
        self.users.remove(user)
        bisect.insort_left(self.users, user)
633

mathieui's avatar
mathieui committed
634 635 636
        if config.get_by_tabname('display_user_color_in_join_part',
                                 self.general_jid):
            color = dump_tuple(user.color)
637
        else:
mathieui's avatar
mathieui committed
638 639 640 641 642 643 644 645 646
            color = 3
        info_col = dump_tuple(get_theme().COLOR_INFORMATION_TEXT)
        self.add_message('\x19%(color)s}%(old)s\x19%(info_col)s} is'
                         ' now known as \x19%(color)s}%(new)s' % {
                              'old':from_nick, 'new':new_nick,
                              'color':color, 'info_col': info_col},
                         typ=2)
        # rename the private tabs if needed
        self.core.rename_private_tabs(self.name, from_nick, user)
647

mathieui's avatar
mathieui committed
648
    def on_user_banned(self, presence, user, from_nick):
649
        """
mathieui's avatar
mathieui committed
650
        When someone is banned from a muc
651
        """
mathieui's avatar
mathieui committed
652 653 654 655 656 657 658 659 660
        self.users.remove(user)
        by = presence.xml.find('{%s}x/{%s}item/{%s}actor' %
                               (NS_MUC_USER, NS_MUC_USER, NS_MUC_USER))
        reason = presence.xml.find('{%s}x/{%s}item/{%s}reason' %
                                   (NS_MUC_USER, NS_MUC_USER, NS_MUC_USER))
        if by:
            by = by.get('jid') or by.get('nick') or None
        else:
            by = None
661

mathieui's avatar
mathieui committed
662 663
        info_col = dump_tuple(get_theme().COLOR_INFORMATION_TEXT)
        char_kick = get_theme().CHAR_KICK
664

mathieui's avatar
mathieui committed
665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692
        if from_nick == self.own_nick: # we are banned
            if by:
                kick_msg = ('\x191}%(spec)s \x193}You\x19%(info_col)s}'
                            ' have been banned by \x194}%(by)s') % {
                                'spec': char_kick, 'by': by,
                                'info_col': info_col}
            else:
                kick_msg = ('\x191}%(spec)s \x193}You\x19'
                            '%(info_col)s} have been banned.') % {
                                'spec': char_kick, 'info_col': info_col}
            self.core.disable_private_tabs(self.name, reason=kick_msg)
            self.disconnect()
            self.refresh_tab_win()
            self.core.current_tab().input.refresh()
            self.core.doupdate()
            if config.get_by_tabname('autorejoin', self.general_jid):
                delay = config.get_by_tabname('autorejoin_delay',
                                              self.general_jid)
                delay = common.parse_str_to_secs(delay)
                if delay <= 0:
                    muc.join_groupchat(self.core, self.name, self.own_nick)
                else:
                    self.core.add_timed_event(timed_events.DelayedEvent(
                                                  delay,
                                                  muc.join_groupchat,
                                                  self.core,
                                                  self.name,
                                                  self.own_nick))
693

mathieui's avatar
mathieui committed
694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719
        else:
            if config.get_by_tabname('display_user_color_in_join_part',
                                     self.general_jid):
                color = dump_tuple(user.color)
            else:
                color = 3

            if by:
                kick_msg = ('\x191}%(spec)s \x19%(color)s}'
                            '%(nick)s\x19%(info_col)s} '
                            'has been banned by \x194}%(by)s') % {
                                'spec': char_kick, 'nick': from_nick,
                                'color': color, 'by': by,
                                'info_col': info_col}
            else:
                kick_msg = ('\x191}%(spec)s \x19%(color)s}%(nick)s'
                            '\x19%(info_col)s} has been banned') % {
                                'spec': char_kick, 'nick': from_nick,
                                'color': color, 'info_col': info_col}
        if reason is not None and reason.text:
            kick_msg += ('\x19%(info_col)s} Reason: \x196}'
                         '%(reason)s\x19%(info_col)s}') % {
                            'reason': reason.text, 'info_col': info_col}
        self.add_message(kick_msg, typ=2)

    def on_user_kicked(self, presence, user, from_nick):
720
        """
mathieui's avatar
mathieui committed
721
        When someone is kicked from a muc
722
        """
mathieui's avatar
mathieui committed
723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984
        self.users.remove(user)
        actor_elem = presence.xml.find('{%s}x/{%s}item/{%s}actor' %
                                       (NS_MUC_USER, NS_MUC_USER, NS_MUC_USER))
        reason = presence.xml.find('{%s}x/{%s}item/{%s}reason' %
                                   (NS_MUC_USER, NS_MUC_USER, NS_MUC_USER))
        by = None
        info_col = dump_tuple(get_theme().COLOR_INFORMATION_TEXT)
        char_kick = get_theme().CHAR_KICK
        if actor_elem is not None:
            by = actor_elem.get('nick') or actor_elem.get('jid')
        if from_nick == self.own_nick: # we are kicked
            if by:
                kick_msg = ('\x191}%(spec)s \x193}You\x19'
                            '%(info_col)s} have been kicked'
                            ' by \x193}%(by)s') % {
                                 'spec': char_kick, 'by': by,
                                 'info_col': info_col}
            else:
                kick_msg = ('\x191}%(spec)s \x193}You\x19%(info_col)s}'
                            ' have been kicked.') % {
                                 'spec': char_kick,
                                 'info_col': info_col}
            self.core.disable_private_tabs(self.name, reason=kick_msg)
            self.disconnect()
            self.refresh_tab_win()
            self.core.current_tab().input.refresh()
            self.core.doupdate()
            # try to auto-rejoin
            if config.get_by_tabname('autorejoin', self.general_jid):
                delay = config.get_by_tabname('autorejoin_delay',
                                              self.general_jid)
                delay = common.parse_str_to_secs(delay)
                if delay <= 0:
                    muc.join_groupchat(self.core, self.name, self.own_nick)
                else:
                    self.core.add_timed_event(timed_events.DelayedEvent(
                        delay,
                        muc.join_groupchat,
                        self.core,
                        self.name,
                        self.own_nick))
        else:
            if config.get_by_tabname('display_user_color_in_join_part',
                                     self.general_jid):
                color = dump_tuple(user.color)
            else:
                color = 3
            if by:
                kick_msg = ('\x191}%(spec)s \x19%(color)s}%(nick)s'
                            '\x19%(info_col)s} has been kicked by '
                            '\x193}%(by)s') % {
                                'spec': char_kick, 'nick':from_nick,
                                'color':color, 'by':by, 'info_col': info_col}
            else:
                kick_msg = ('\x191}%(spec)s \x19%(color)s}%(nick)s'
                            '\x19%(info_col)s} has been kicked') % {
                                'spec': char_kick, 'nick': from_nick,
                                'color':color, 'info_col': info_col}
        if reason is not None and reason.text:
            kick_msg += ('\x19%(info_col)s} Reason: \x196}'
                         '%(reason)s') % {
                            'reason': reason.text, 'info_col': info_col}
        self.add_message(kick_msg, typ=2)

    def on_user_leave_groupchat(self, user, jid, status, from_nick, from_room):
        """
        When an user leaves a groupchat
        """
        self.users.remove(user)
        if self.own_nick == user.nick:
            # We are now out of the room.
            # Happens with some buggy (? not sure) servers
            self.disconnect()
            self.core.disable_private_tabs(from_room)
            self.refresh_tab_win()

        hide_exit_join = config.get_by_tabname('hide_exit_join',
                                               self.general_jid)

        if hide_exit_join <= -1 or user.has_talked_since(hide_exit_join):
            if config.get_by_tabname('display_user_color_in_join_part',
                                     self.general_jid):
                color = dump_tuple(user.color)
            else:
                color = 3
            info_col = dump_tuple(get_theme().COLOR_INFORMATION_TEXT)
            spec_col = dump_tuple(get_theme().COLOR_QUIT_CHAR)

            if not jid.full:
                leave_msg = ('\x19%(color_spec)s}%(spec)s \x19%(color)s}'
                             '%(nick)s\x19%(info_col)s} has left the '
                             'room') % {
                                  'nick':from_nick, 'color':color,
                                  'spec':get_theme().CHAR_QUIT,
                                  'info_col': info_col,
                                  'color_spec': spec_col}
            else:
                jid_col = dump_tuple(get_theme().COLOR_MUC_JID)
                leave_msg = ('\x19%(color_spec)s}%(spec)s \x19%(color)s}'
                             '%(nick)s\x19%(info_col)s} (\x19%(jid_col)s}'
                             '%(jid)s\x19%(info_col)s}) has left the '
                             'room') % {
                                  'spec':get_theme().CHAR_QUIT,
                                  'nick':from_nick, 'color':color,
                                  'jid':jid.full, 'info_col': info_col,
                                  'color_spec': spec_col,
                                  'jid_col': jid_col}
            if status:
                leave_msg += ' (\x19o%s\x19%s})' % (status, info_col)
            self.add_message(leave_msg, typ=2)
        self.core.on_user_left_private_conversation(from_room, user,
                                                    status)

    def on_user_change_status(
            self, user, from_nick, from_room, affiliation, role, show, status):
        """
        When an user changes her status
        """
        # build the message
        display_message = False # flag to know if something significant enough
                                # to be displayed has changed
        if config.get_by_tabname('display_user_color_in_join_part',
                                 self.general_jid):
            color = dump_tuple(user.color)
        else:
            color = 3
        if from_nick == self.own_nick:
            msg = '\x19%(color)s}You\x19%(info_col)s} changed: ' % {
                  'info_col': dump_tuple(get_theme().COLOR_INFORMATION_TEXT),
                  'color': color}
        else:
            msg = '\x19%(color)s}%(nick)s\x19%(info_col)s} changed: ' % {
                  'nick': from_nick, 'color': color,
                  'info_col': dump_tuple(get_theme().COLOR_INFORMATION_TEXT)}
        if affiliation != user.affiliation:
            msg += 'affiliation: %s, ' % affiliation
            display_message = True
        if role != user.role:
            msg += 'role: %s, ' % role
            display_message = True
        if show != user.show and show in SHOW_NAME:
            msg += 'show: %s, ' % SHOW_NAME[show]
            display_message = True
        if status != user.status:
            # if the user sets his status to nothing
            if status:
                msg += 'status: %s, ' % status
                display_message = True
            elif show in SHOW_NAME and show == user.show:
                msg += 'show: %s, ' % SHOW_NAME[show]
                display_message = True
        if not display_message:
            return
        msg = msg[:-2] # remove the last ", "
        hide_status_change = config.get_by_tabname('hide_status_change',
                                                   self.general_jid)
        if hide_status_change < -1:
            hide_status_change = -1
        if ((hide_status_change == -1 or \
                user.has_talked_since(hide_status_change) or\
                user.nick == self.own_nick)\
                and\
                (affiliation != user.affiliation or\
                    role != user.role or\
                    show != user.show or\
                    status != user.status))\
                      or\
                        (affiliation != user.affiliation or\
                          role != user.role):
            # display the message in the room
            self._text_buffer.add_message(msg)
        self.core.on_user_changed_status_in_private('%s/%s' %
                                                      (from_room, from_nick),
                                                    Status(show, status))
        self.users.remove(user)
        # finally, effectively change the user status
        user.update(affiliation, show, status, role)
        bisect.insort_left(self.users, user)

    def disconnect(self):
        """
        Set the state of the room as not joined, so
        we can know if we can join it, send messages to it, etc
        """
        self.presence_buffer = []
        self.users = []
        if self is not self.core.current_tab():
            self.state = 'disconnected'
        self.joined = False
        self.disable_self_ping_event()

    def get_single_line_topic(self):
        """
        Return the topic as a single-line string (for the window header)
        """
        return self.topic.replace('\n', '|')

    def log_message(self, txt, nickname, time=None, typ=1):
        """
        Log the messages in the archives, if it needs
        to be
        """
        if time is None and self.joined:    # don't log the history messages
            if not logger.log_message(self.name, nickname, txt, typ=typ):
                self.core.information('Unable to write in the log file',
                                      'Error')

    def get_user_by_name(self, nick):
        """
        Gets the user associated with the given nick, or None if not found
        """
        for user in self.users:
            if user.nick == nick:
                return user
        return None

    def add_message(self, txt, time=None, nickname=None, **kwargs):
        """
        Note that user can be None even if nickname is not None. It happens
        when we receive an history message said by someone who is not
        in the room anymore
        Return True if the message highlighted us. False otherwise.
        """

        # reset self-ping interval
        if self.self_ping_event:
            self.enable_self_ping_event()

        self.log_message(txt, nickname, time=time, typ=kwargs.get('typ', 1))
        args = dict()
        for key, value in kwargs.items():
            if key not in ('typ', 'forced_user'):
                args[key] = value
        if nickname is not None:
            user = self.get_user_by_name(nickname)
        else:
            user = None

        if user:
            user.set_last_talked(datetime.now())
            args['user'] = user
        if not user and kwargs.get('forced_user'):
            args['user'] = kwargs['forced_user']

        if (not time and nickname and nickname != self.own_nick
                    and self.state != 'current'):
            if (self.state != 'highlight' and
                    config.get_by_tabname('notify_messages', self.name)):
                self.state = 'message'
        if time and not txt.startswith('/me'):
            txt = '\x19%(info_col)s}%(txt)s' % {
                    'txt': txt,
                    'info_col': dump_tuple(get_theme().COLOR_LOG_MSG)}
        elif not nickname:
            txt = '\x19%(info_col)s}%(txt)s' % {
                    'txt': txt,
                    'info_col': dump_tuple(get_theme().COLOR_INFORMATION_TEXT)}
        elif not kwargs.get('highlight'):                   # TODO
            args['highlight'] = self.do_highlight(txt, time, nickname)
        time = time or datetime.now()
        self._text_buffer.add_message(txt, time, nickname, **args)
        return args.get('highlight', False)
985

mathieui's avatar
mathieui committed
986 987 988 989 990 991 992 993 994 995 996 997
    def modify_message(self, txt, old_id, new_id,
                       time=None, nickname=None, user=None, jid=None):
        self.log_message(txt, nickname, time=time, typ=1)
        highlight = self.do_highlight(txt, time, nickname, corrected=True)
        message = self._text_buffer.modify_message(txt, old_id, new_id,
                                                   highlight=highlight,
                                                   time=time, user=user,
                                                   jid=jid)
        if message:
            self.text_win.modify_message(old_id, message)
            return highlight
        return False
998

mathieui's avatar
mathieui committed
999 1000
    def matching_names(self):
        return [(1, safeJID(self.name).user), (3, self.name)]
1001

mathieui's avatar
mathieui committed
1002 1003 1004
    def enable_self_ping_event(self):
        delay = config.get_by_tabname("self_ping_delay", self.general_jid, default=0)
        if delay <= 0:          # use 0 or some negative value to disable it
1005
            return
mathieui's avatar
mathieui committed
1006 1007 1008
        self.disable_self_ping_event()
        self.self_ping_event = timed_events.DelayedEvent(delay, self.send_self_ping)
        self.core.add_timed_event(self.self_ping_event)
1009

mathieui's avatar
mathieui committed
1010 1011 1012 1013
    def disable_self_ping_event(self):
        if self.self_ping_event is not None:
            self.core.remove_timed_event(self.self_ping_event)
            self.self_ping_event = None
1014

mathieui's avatar
mathieui committed
1015 1016 1017 1018 1019 1020
    def send_self_ping(self):
        to = self.name + "/" + self.own_nick
        self.core.xmpp.plugin['xep_0199'].send_ping(jid=to,
                                                    callback=self.on_self_ping_result,
                                                    timeout_callback=self.on_self_ping_failed,
                                                    timeout=60)
1021

mathieui's avatar
mathieui committed
1022 1023 1024 1025 1026 1027 1028 1029
    def on_self_ping_result(self, iq):
        if iq["type"] == "error" and iq["error"]["condition"] != "feature-not-implemented":
            self.command_cycle(iq["error"]["text"] or "not in this room")
            self.core.refresh_window()
        else:                   # Re-send a self-ping in a few seconds
            self.enable_self_ping_event()

    def search_for_color(self, nick):
1030
        """
mathieui's avatar
mathieui committed
1031 1032 1033
        Search for the color of a nick in the config file.
        Also, look at the colors of its possible aliases if nick_color_aliases
        is set.
1034
        """
mathieui's avatar
mathieui committed
1035 1036 1037 1038 1039 1040 1041 1042
        color = config.get_by_tabname(nick, 'muc_colors')
        if color != '':
            return color
        nick_color_aliases = config.get_by_tabname('nick_color_aliases', self.name)
        if nick_color_aliases:
            nick_alias = re.sub('^_*(.*?)_*$', '\\1', nick)
            color = config.get_by_tabname(nick_alias, 'muc_colors')
        return color
1043

mathieui's avatar
mathieui committed
1044 1045 1046
    def on_self_ping_failed(self, iq):
        self.command_cycle("the MUC server is not responding")
        self.core.refresh_window()
1047

mathieui's avatar
mathieui committed
1048 1049 1050 1051
########################## UI ONLY #####################################

    @refresh_wrapper.always
    def go_to_next_hl(self):
1052
        """
mathieui's avatar
mathieui committed
1053
        Go to the next HL in the room, or the last
1054
        """
mathieui's avatar
mathieui committed
1055
        self.text_win.next_highlight()
1056

mathieui's avatar
mathieui committed
1057 1058
    @refresh_wrapper.always
    def go_to_prev_hl(self):
1059
        """
mathieui's avatar
mathieui committed
1060
        Go to the previous HL in the room, or the first
1061
        """
mathieui's avatar
mathieui committed
1062
        self.text_win.previous_highlight()
1063

1064
    @refresh_wrapper.always
mathieui's avatar
mathieui committed
1065
    def scroll_user_list_up(self):
1066
        "Scroll up in the userlist"
mathieui's avatar
mathieui committed
1067
        self.user_win.scroll_up()
1068 1069 1070 1071 1072

    @refresh_wrapper.always
    def scroll_user_list_down(self):
        "Scroll down in the userlist"
        self.user_win.scroll_down()
1073 1074 1075 1076 1077

    def resize(self):
        """
        Resize the whole window. i.e. all its sub-windows
        """
1078
        self.need_resize = False
1079
        if config.get('hide_user_list') or self.size.tab_degrade_x:
1080 1081
            text_width = self.width
        else:
mathieui's avatar
mathieui committed
1082
            text_width = (self.width // 10) * 9
1083

mathieui's avatar
mathieui committed
1084 1085 1086 1087 1088 1089
        if self.size.tab_degrade_y:
            tab_win_height = 0
            info_win_height = 0
        else:
            tab_win_height = Tab.tab_win_height()
            info_win_height = self.core.information_win_size
1090 1091


mathieui's avatar
mathieui committed
1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117
        self.user_win.resize(self.height - 3 - info_win_height
                                - tab_win_height,
                             self.width - (self.width // 10) * 9 - 1,
                             1,
                             (self.width // 10) * 9 + 1)
        self.v_separator.resize(self.height - 3 - info_win_height - tab_win_height,
                                1, 1, 9 * (self.width // 10))

        self.topic_win.resize(1, self.width, 0, 0)

        self.text_win.resize(self.height - 3 - info_win_height
                                - tab_win_height,
                             text_width, 1, 0)
        self.text_win.rebuild_everything(self._text_buffer)
        self.info_header.resize(1, self.width,
                                self.height - 2 - info_win_height
                                    - tab_win_height,
                                0)
        self.input.resize(1, self.width, self.height-1, 0)

    def refresh(self):
        if self.need_resize:
            self.resize()
        log.debug('  TAB   Refresh: %s', self.__class__.__name__)
        if config.get('hide_user_list') or self.size.tab_degrade_x:
            display_user_list = False
1118
        else:
mathieui's avatar
mathieui committed
1119 1120
            display_user_list = True
        display_info_win = not self.size.tab_degrade_y
1121

mathieui's avatar
mathieui committed
1122 1123 1124 1125 1126 1127 1128 1129 1130 1131
        self.topic_win.refresh(self.get_single_line_topic())
        self.text_win.refresh()
        if display_user_list:
            self.v_separator.refresh()
            self.user_win.refresh(self.users)
        self.info_header.refresh(self, self.text_win, user=self.own_user)
        self.refresh_tab_win()
        if display_info_win:
            self.info_win.refresh()
        self.input.refresh()
1132 1133 1134 1135

    def on_info_win_size_changed(self):
        if self.core.information_win_size >= self.height-3:
            return
1136
        if config.get("hide_user_list"):
1137 1138 1139
            text_width = self.width
        else:
            text_width = (self.width//10)*9
1140 1141 1142 1143 1144
        self.user_win.resize(self.height - 3 - self.core.information_win_size
                                - Tab.tab_win_height(),
                             self.width - (self.width // 10) * 9 - 1,
                             1,
                             (self.width // 10) * 9 + 1)
1145 1146
        self.v_separator.resize(self.height - 3 - self.core.information_win_size - Tab.tab_win_height(),
                                1, 1, 9 * (self.width // 10))
1147 1148 1149 1150 1151 1152 1153
        self.text_win.resize(self.height - 3 - self.core.information_win_size
                                - Tab.tab_win_height(),
                             text_width, 1, 0)
        self.info_header.resize(1, self.width,
                                self.height-2-self.core.information_win_size
                                    - Tab.tab_win_height(),
                                0)
mathieui's avatar
mathieui committed
1154
    def do_highlight(self, txt, time, nickname, corrected=False):
1155
        """
mathieui's avatar
mathieui committed
1156
        Set the tab color and returns the nick color
1157
        """
mathieui's avatar
mathieui committed
1158 1159 1160 1161 1162 1163 1164
        highlighted = False
        if (not time or corrected) and nickname and nickname != self.own_nick and self.joined:

            if re.search(r'\b' + self.own_nick.lower() + r'\b', txt.lower()):
                if self.state != 'current':
                    self.state = 'highlight'
                highlighted = True
1165
            else:
mathieui's avatar
mathieui committed
1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199
                highlight_words = config.get_by_tabname('highlight_on',
                                                        self.general_jid)
                highlight_words = highlight_words.split(':')
                for word in highlight_words:
                    if word and word.lower() in txt.lower():
                        if self.state != 'current':
                            self.state = 'highlight'
                        highlighted = True
                        break
        if highlighted:
            beep_on = config.get('beep_on').split()
            if 'highlight' in beep_on and 'message' not in beep_on:
                if not config.get_by_tabname('disable_beep', self.name):
                    curses.beep()
        return highlighted

########################## COMMANDS ####################################

    @command_args_parser.quoted(1, 1, [''])
    def command_invite(self, args):
        """/invite <jid> [reason]"""
        if args is None:
            return self.core.command.help('invite')
        jid, reason = args
        self.core.command.invite('%s %s "%s"' % (jid, self.name, reason))

    @command_args_parser.quoted(1)
    def command_info(self, args):
        """
        /info <nick>
        """
        if args is None:
            return self.core.command.help('info')
        nick = args[0]
mathieui's avatar
mathieui committed
1200 1201
        if not self.print_info(nick):
            self.core.information("Unknown user: %s" % nick, "Error")
mathieui's avatar
mathieui committed
1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212

    @command_args_parser.quoted(0)
    def command_configure(self, ignored):
        """
        /configure
        """
        def on_form_received(form):
            if not form:
                self.core.information(
                    'Could not retrieve the configuration form',
                    'Error')
1213
                return
mathieui's avatar
mathieui committed
1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227
            self.core.open_new_form(form, self.cancel_config, self.send_config)

        fixes.get_room_form(self.core.xmpp, self.name, on_form_received)

    @command_args_parser.raw
    def command_cycle(self, msg):
        """/cycle [reason]"""
        self.leave_room(msg)
        self.join()

    @command_args_parser.quoted(0, 1, [''])
    def command_recolor(self, args):
        """
        /recolor [random]
mathieui's avatar
mathieui committed
1228
        Re-assigns color to the participants of the room
mathieui's avatar
mathieui committed
1229
        """
mathieui's avatar
mathieui committed
1230 1231
        random_colors = args[0] == 'random'
        self.recolor(random_colors)
mathieui's avatar
mathieui committed
1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244

    @command_args_parser.quoted(2, 2, [''])
    def command_color(self, args):
        """
        /color <nick> <color>
        Fix a color for a nick.
        Use "unset" instead of a color to remove the attribution.
        User "random" to attribute a random color.
        """
        if args is None:
            return self.core.command.help('color')
        nick = args[0]
        color = args[1].lower()
1245
        if nick == self.own_nick:
mathieui's avatar
mathieui committed
1246 1247
            return self.core.information("You cannot change the color of your"
                                         " own nick.", 'Error')
1248 1249 1250
        elif color not in xhtml.colors and color not in ('unset', 'random'):
            return self.core.information("Unknown color: %s" % color, 'Error')
        self.set_nick_color(nick, color)
1251

mathieui's avatar
mathieui committed
1252 1253
    @command_args_parser.quoted(1)
    def command_version(self, args):
1254
        """
mathieui's avatar
mathieui committed
1255
        /version <jid or nick>
1256
        """
mathieui's avatar
mathieui committed
1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277
        def callback(res):
            if not res:
                return self.core.information('Could not get the software '
                                             'version from %s' % (jid,),
                                             'Warning')
            version = '%s is running %s version %s on %s' % (
                         jid,
                         res.get('name') or 'an unknown software',
                         res.get('version') or 'unknown',
                         res.get('os') or 'an unknown platform')
            self.core.information(version, 'Info')
        if args is None:
            return self.core.command.help('version')
        nick = args[0]
        if nick in [user.nick for user in self.users]:
            jid = safeJID(self.name).bare
            jid = safeJID(jid + '/' + nick)
        else:
            jid = safeJID(nick)
        fixes.get_version(self.core.xmpp, jid,
                          callback=callback)
1278

mathieui's avatar
mathieui committed
1279 1280
    @command_args_parser.quoted(1)
    def command_nick(self, args):
1281
        """
mathieui's avatar
mathieui committed
1282
        /nick <nickname>
1283
        """
mathieui's avatar
mathieui committed
1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295
        if args is None:
            return self.core.command.help('nick')
        nick = args[0]
        if not self.joined:
            return self.core.information('/nick only works in joined rooms',
                                         'Info')
        current_status = self.core.get_status()
        if not safeJID(self.name + '/' + nick):
            return self.core.information('Invalid nick', 'Info')
        muc.change_nick(self.core, self.name, nick,
                        current_status.message,
                        current_status.show)
1296

mathieui's avatar
mathieui committed
1297 1298
    @command_args_parser.quoted(0, 1, [''])
    def command_part(self, args):
1299
        """
mathieui's avatar
mathieui committed
1300
        /part [msg]
1301
        """
mathieui's avatar
mathieui committed
1302 1303 1304 1305 1306
        message = args[0]
        self.leave_room(message)
        if self == self.core.current_tab():
            self.refresh()
        self.core.doupdate()
1307

mathieui's avatar
mathieui committed
1308 1309
    @command_args_parser.raw
    def command_close(self, msg):
1310
        """
mathieui's avatar
mathieui committed
1311
        /close [msg]
1312
        """
1313
        self.leave_room(msg)
mathieui's avatar
mathieui committed
1314
        self.core.close_tab(self)
1315

mathieui's avatar
mathieui committed
1316 1317
    def on_close(self):
        super().on_close()
1318
        self.leave_room('')
1319

mathieui's avatar
mathieui committed
1320 1321
    @command_args_parser.quoted(1, 1)
    def command_query(self, args):
1322
        """
mathieui's avatar
mathieui committed
1323
        /query <nick> [message]
1324
        """
mathieui's avatar
mathieui committed
1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344
        if args is None:
            return  self.core.command.help('query')
        nick = args[0]
        r = None
        for user in self.users:
            if user.nick == nick:
                r = self.core.open_private_window(self.name, user.nick)
        if r and len(args) == 2:
            msg = args[1]
            self.core.current_tab().command_say(
                    xhtml.convert_simple_to_full_colors(msg))
        if not r:
            self.core.information("Cannot find user: %s" % nick, 'Error')

    @command_args_parser.raw
    def command_topic(self, subject):
        """
        /topic [new topic]
        """
        if not subject:
mathieui's avatar
mathieui committed
1345 1346 1347
            self.show_topic()
        else:
            self.change_topic(subject)
1348

mathieui's avatar
mathieui committed
1349 1350
    @command_args_parser.quoted(0)
    def command_names(self, args):
1351
        """
mathieui's avatar
mathieui committed
1352
        /names
1353
        """
mathieui's avatar
mathieui committed
1354 1355
        if not self.joined:
            return
1356

mathieui's avatar
mathieui committed
1357 1358 1359 1360 1361 1362
        aff = {
                'owner': get_theme().CHAR_AFFILIATION_OWNER,