muctab.py 76.7 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
import bisect
11
import curses
12
import logging
13 14
import os
import random
15
import re
16
import functools
mathieui's avatar
mathieui committed
17
from datetime import datetime
18
from typing import Dict, Callable, List, Optional, Union, Set
19

20
from slixmpp import JID
21
from poezio.tabs import ChatTab, Tab, SHOW_NAME
22

23 24 25 26 27 28 29 30
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
31
from poezio.core.structs import Command
32 33 34 35 36
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
37
from poezio.core.structs import Completion, Status
38

39 40
log = logging.getLogger(__name__)

41
NS_MUC_USER = 'http://jabber.org/protocol/muc#user'
42
STATUS_XPATH = '{%s}x/{%s}status' % (NS_MUC_USER, NS_MUC_USER)
43

44 45
COMPARE_USERS_LAST_TALKED = lambda x: x.last_talked

46 47 48 49 50 51 52

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'
53 54
    plugin_commands = {}  # type: Dict[str, Command]
    plugin_keys = {}  # type: Dict[str, Callable]
55

56 57
    def __init__(self, core, jid, nick, password=None):
        ChatTab.__init__(self, core, jid)
58 59 60
        self.joined = False
        self._state = 'disconnected'
        # our nick in the MUC
61
        self.own_nick = nick
62
        # self User object
63
        self.own_user = None  # type: Optional[User]
64
        self.name = jid
65
        self.password = password
66
        # buffered presences
67
        self.presence_buffer = []
68
        # userlist
69
        self.users = []  # type: List[User]
70
        # private conversations
71
        self.privates = []  # type: List[Tab]
72
        self.topic = ''
73
        self.topic_from = ''
74 75 76
        # Self ping event, so we can cancel it when we leave the room
        self.self_ping_event = None
        # UI stuff
77 78 79 80 81 82 83
        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()
84
        # List of ignored users
85
        self.ignores = []  # type: List[User]
86
        # keys
87 88
        self.register_keys()
        self.update_keys()
89
        # commands
90
        self.register_commands()
91
        self.update_commands()
92
        self.resize()
93 94 95

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

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

102
    @property
103
    def last_connection(self) -> Optional[datetime]:
104 105 106 107 108 109 110 111 112
        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
        """
113
        muc.cancel_config(self.core.xmpp, self.name)
114 115 116 117 118 119
        self.core.close_tab()

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

123 124 125 126 127 128 129 130 131
    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:
132
            seconds = None
mathieui's avatar
mathieui committed
133 134 135 136 137 138 139 140
        muc.join_groupchat(
            self.core,
            self.name,
            self.own_nick,
            self.password,
            status=status.message,
            show=status.show,
            seconds=seconds)
141

142
    def leave_room(self, message: str):
mathieui's avatar
mathieui committed
143 144 145 146
        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)
147

148 149
            if config.get_by_tabname('display_user_color_in_join_part',
                                     self.general_jid):
150 151
                color = dump_tuple(get_theme().COLOR_OWN_NICK)
            else:
152
                color = "3"
153

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

177
            self.add_message(msg, typ=2)
178
            self.disconnect()
mathieui's avatar
mathieui committed
179 180
            muc.leave_groupchat(self.core.xmpp, self.name, self.own_nick,
                                message)
181
            self.core.disable_private_tabs(self.name, reason=msg)
182
        else:
mathieui's avatar
mathieui committed
183 184
            muc.leave_groupchat(self.core.xmpp, self.name, self.own_nick,
                                message)
mathieui's avatar
mathieui committed
185

186 187 188 189
    def change_affiliation(self,
                           nick_or_jid: Union[str, JID],
                           affiliation: str,
                           reason=''):
190 191 192
        """
        Change the affiliation of a nick or JID
        """
mathieui's avatar
mathieui committed
193

194 195
        def callback(iq):
            if iq['type'] == 'error':
mathieui's avatar
mathieui committed
196 197 198 199
                self.core.information(
                    "Could not set affiliation '%s' for '%s'." %
                    (affiliation, nick_or_jid), "Warning")

200 201 202 203 204
        if not self.joined:
            return

        valid_affiliations = ('outcast', 'none', 'member', 'admin', 'owner')
        if affiliation not in valid_affiliations:
mathieui's avatar
mathieui committed
205 206 207
            return self.core.information(
                'The affiliation must be one of ' +
                ', '.join(valid_affiliations), 'Error')
208
        if nick_or_jid in [user.nick for user in self.users]:
mathieui's avatar
mathieui committed
209
            muc.set_user_affiliation(
mathieui's avatar
mathieui committed
210 211 212 213 214 215
                self.core.xmpp,
                self.name,
                affiliation,
                nick=nick_or_jid,
                callback=callback,
                reason=reason)
216
        else:
mathieui's avatar
mathieui committed
217
            muc.set_user_affiliation(
mathieui's avatar
mathieui committed
218 219 220 221 222 223
                self.core.xmpp,
                self.name,
                affiliation,
                jid=safeJID(nick_or_jid),
                callback=callback,
                reason=reason)
224

225
    def change_role(self, nick: str, role: str, reason=''):
226 227 228
        """
        Change the role of a nick
        """
mathieui's avatar
mathieui committed
229

230 231
        def callback(iq):
            if iq['type'] == 'error':
mathieui's avatar
mathieui committed
232 233 234
                self.core.information(
                    "Could not set role '%s' for '%s'." % (role, nick),
                    "Warning")
mathieui's avatar
mathieui committed
235

236 237 238
        valid_roles = ('none', 'visitor', 'participant', 'moderator')

        if not self.joined or role not in valid_roles:
mathieui's avatar
mathieui committed
239 240
            return self.core.information(
                'The role must be one of ' + ', '.join(valid_roles), 'Error')
241 242 243

        if not safeJID(self.name + '/' + nick):
            return self.core.information('Invalid nick', 'Info')
mathieui's avatar
mathieui committed
244 245
        muc.set_user_role(
            self.core.xmpp, self.name, nick, reason, role, callback=callback)
246

mathieui's avatar
mathieui committed
247
    @refresh_wrapper.conditional
248
    def print_info(self, nick: str) -> bool:
mathieui's avatar
mathieui committed
249 250 251 252 253 254 255 256 257
        """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)' % (
mathieui's avatar
mathieui committed
258
                inf, dump_tuple(theme.COLOR_MUC_JID), user.jid, inf)
mathieui's avatar
mathieui committed
259 260 261 262 263 264
        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') % {
mathieui's avatar
mathieui committed
265 266 267 268 269 270 271 272 273 274 275
                    '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 ''
                }
mathieui's avatar
mathieui committed
276 277 278
        self.add_message(info, typ=0)
        return True

279
    def change_topic(self, topic: str):
mathieui's avatar
mathieui committed
280 281 282 283 284 285 286 287 288 289 290 291 292 293
        """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)
mathieui's avatar
mathieui committed
294 295
                user_string = '\x19%s}(set by \x19%s}%s\x19%s})' % (
                    info_text, user_text, user.nick, info_text)
mathieui's avatar
mathieui committed
296 297 298 299 300 301
            else:
                user_string = self.topic_from
        else:
            user_string = ''

        self._text_buffer.add_message(
mathieui's avatar
mathieui committed
302 303
            "\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
304

mathieui's avatar
mathieui committed
305 306 307
    @refresh_wrapper.always
    def recolor(self, random_colors=False):
        """Recolor the current MUC users"""
mathieui's avatar
mathieui committed
308 309
        deterministic = config.get_by_tabname('deterministic_nick_colors',
                                              self.name)
mathieui's avatar
mathieui committed
310 311 312 313 314 315 316 317 318 319 320
        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
321
        sorted_users = sorted(self.users, key=COMPARE_USERS_LAST_TALKED, reverse=True)
mathieui's avatar
mathieui committed
322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338
        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)

339
    @refresh_wrapper.conditional
340
    def set_nick_color(self, nick: str, color: str) -> bool:
341 342 343 344 345 346 347 348
        "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'):
mathieui's avatar
mathieui committed
349 350
                self.core.information('Color for nick %s unset' % (nick),
                                      'Info')
351 352 353 354 355 356
        else:
            if color == 'random':
                color = random.choice(list(xhtml.colors))
            if user:
                user.change_color(color)
            config.set_and_save(nick, color, 'muc_colors')
mathieui's avatar
mathieui committed
357 358
            nick_color_aliases = config.get_by_tabname('nick_color_aliases',
                                                       self.name)
359 360 361 362 363 364 365 366 367 368 369
            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
370

mathieui's avatar
mathieui committed
371 372 373 374 375 376
    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() == ''
mathieui's avatar
mathieui committed
377 378 379
        empty_after = empty_after or (
            self.input.get_text().startswith('/')
            and not self.input.get_text().startswith('//'))
mathieui's avatar
mathieui committed
380 381
        self.send_composing_chat_state(empty_after)
        return False
382

383
    def get_nick(self) -> str:
384 385 386 387 388 389 390
        if config.get('show_muc_jid'):
            return self.name
        bookmark = self.core.bookmarks[self.name]
        if bookmark is not None and bookmark.name:
            return bookmark.name
        # TODO: send the disco#info identity name here, if it exists.
        return safeJID(self.name).user
391

mathieui's avatar
mathieui committed
392 393
    def get_text_window(self):
        return self.text_win
394

mathieui's avatar
mathieui committed
395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414
    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)
mathieui's avatar
mathieui committed
415 416
        if self.joined and config.get_by_tabname(
                'send_chat_states',
mathieui's avatar
mathieui committed
417 418 419 420
                self.general_jid) and not self.input.get_text():
            self.send_chat_state('active')

    def handle_presence(self, presence):
421
        """
mathieui's avatar
mathieui committed
422
        Handle MUC presence
423
        """
mathieui's avatar
mathieui committed
424 425 426
        status_codes = set()
        for status_code in presence.xml.findall(STATUS_XPATH):
            status_codes.add(status_code.attrib['code'])
mathieui's avatar
mathieui committed
427 428 429
        if presence['type'] == 'error':
            self.core.room_error(presence, self.name)
        elif not self.joined:
mathieui's avatar
mathieui committed
430
            if '110' in status_codes or self.own_nick == presence['from'].resource:
mathieui's avatar
mathieui committed
431
                self.process_presence_buffer(presence)
mathieui's avatar
mathieui committed
432 433 434 435 436 437 438 439
            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)
440
        if self.core.tabs.current_tab is self:
mathieui's avatar
mathieui committed
441 442 443 444 445
            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()
446

mathieui's avatar
mathieui committed
447
    def process_presence_buffer(self, last_presence):
448
        """
mathieui's avatar
mathieui committed
449
        Batch-process all the initial presences
450
        """
mathieui's avatar
mathieui committed
451 452
        deterministic = config.get_by_tabname('deterministic_nick_colors',
                                              self.name)
mathieui's avatar
mathieui committed
453

mathieui's avatar
mathieui committed
454 455 456 457 458 459 460 461 462 463
        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()
464
        if self.core.tabs.current_tab is not self:
mathieui's avatar
mathieui committed
465
            self.refresh_tab_win()
466
            self.core.tabs.current_tab.refresh_input()
mathieui's avatar
mathieui committed
467
            self.core.doupdate()
468

mathieui's avatar
mathieui committed
469 470 471 472
    def handle_presence_unjoined(self, presence, deterministic, own=False):
        """
        Presence received while we are not in the room (before code=110)
        """
mathieui's avatar
mathieui committed
473
        from_nick, _, affiliation, show, status, role, jid, typ = dissect_presence(
mathieui's avatar
mathieui committed
474
            presence)
475 476
        if typ == 'unavailable':
            return
mathieui's avatar
mathieui committed
477
        user_color = self.search_for_color(from_nick)
mathieui's avatar
mathieui committed
478 479
        new_user = User(from_nick, affiliation, show, status, role, jid,
                        deterministic, user_color)
mathieui's avatar
mathieui committed
480 481 482 483 484 485 486
        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)
487

488
    def own_join(self, from_nick: str, new_user: User, status_codes: Set[str]):
489
        """
mathieui's avatar
mathieui committed
490
        Handle the last presence we received, entering the room
491
        """
mathieui's avatar
mathieui committed
492 493 494 495 496 497
        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'
498
        elif self != self.core.tabs.current_tab:
mathieui's avatar
mathieui committed
499
            self._state = 'joined'
500
        if (self.core.tabs.current_tab is self
mathieui's avatar
mathieui committed
501 502 503
                and self.core.status.show not in ('xa', 'away')):
            self.send_chat_state('active')
        new_user.color = get_theme().COLOR_OWN_NICK
504

mathieui's avatar
mathieui committed
505 506 507 508
        if config.get_by_tabname('display_user_color_in_join_part',
                                 self.general_jid):
            color = dump_tuple(new_user.color)
        else:
509
            color = "3"
510

mathieui's avatar
mathieui committed
511 512 513
        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)
mathieui's avatar
mathieui committed
514 515 516 517 518 519 520 521 522
        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,
                          }
mathieui's avatar
mathieui committed
523 524 525 526
        self.add_message(enable_message, typ=2)
        self.core.enable_private_tabs(self.name, enable_message)
        if '201' in status_codes:
            self.add_message(
mathieui's avatar
mathieui committed
527 528
                '\x19%(info_col)s}Info: The room '
                'has been created' % {'info_col': info_col},
mathieui's avatar
mathieui committed
529 530 531
                typ=0)
        if '170' in status_codes:
            self.add_message(
mathieui's avatar
mathieui committed
532
                '\x19%(warn_col)s}Warning:\x19%(info_col)s}'
mathieui's avatar
mathieui committed
533 534 535 536
                ' This room is publicly logged' % {
                    'info_col': info_col,
                    'warn_col': warn_col
                },
mathieui's avatar
mathieui committed
537 538 539
                typ=0)
        if '100' in status_codes:
            self.add_message(
mathieui's avatar
mathieui committed
540
                '\x19%(warn_col)s}Warning:\x19%(info_col)s}'
mathieui's avatar
mathieui committed
541 542 543 544
                ' This room is not anonymous.' % {
                    'info_col': info_col,
                    'warn_col': warn_col
                },
mathieui's avatar
mathieui committed
545
                typ=0)
546

mathieui's avatar
mathieui committed
547
    def handle_presence_joined(self, presence, status_codes):
548
        """
mathieui's avatar
mathieui committed
549
        Handle new presences when we are already in the room
550
        """
mathieui's avatar
mathieui committed
551 552
        from_nick, from_room, affiliation, show, status, role, jid, typ = dissect_presence(
            presence)
mathieui's avatar
mathieui committed
553 554 555 556
        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'
557
        server_initiated = '333' in status_codes and typ == 'unavailable'
mathieui's avatar
mathieui committed
558 559 560 561 562 563
        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)
mathieui's avatar
mathieui committed
564 565
            self.on_user_join(from_nick, affiliation, show, status, role, jid,
                              user_color)
mathieui's avatar
mathieui committed
566 567 568 569 570 571 572 573
        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)
mathieui's avatar
mathieui committed
574 575
            self.core.on_user_left_private_conversation(
                from_room, user, status)
mathieui's avatar
mathieui committed
576
            self.on_user_banned(presence, user, from_nick)
577
        elif kick and not server_initiated:
mathieui's avatar
mathieui committed
578
            self.core.events.trigger('muc_kick', presence, self)
mathieui's avatar
mathieui committed
579 580
            self.core.on_user_left_private_conversation(
                from_room, user, status)
mathieui's avatar
mathieui committed
581 582 583 584 585 586 587 588 589
            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':
mathieui's avatar
mathieui committed
590
            self.on_user_leave_groupchat(user, jid, status, from_nick,
591
                                         from_room, server_initiated)
mathieui's avatar
mathieui committed
592
        # status change
593
        else:
mathieui's avatar
mathieui committed
594 595
            self.on_user_change_status(user, from_nick, from_room, affiliation,
                                       role, show, status)
596

mathieui's avatar
mathieui committed
597 598 599
    def on_non_member_kicked(self):
        """We have been kicked because the MUC is members-only"""
        self.add_message(
mathieui's avatar
mathieui committed
600 601 602
            '\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)},
mathieui's avatar
mathieui committed
603 604 605 606 607 608
            typ=2)
        self.disconnect()

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

mathieui's avatar
mathieui committed
615 616
    def on_user_join(self, from_nick, affiliation, show, status, role, jid,
                     color):
617
        """
mathieui's avatar
mathieui committed
618
        When a new user joins the groupchat
619
        """
mathieui's avatar
mathieui committed
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)
mathieui's avatar
mathieui committed
624 625 626 627 628 629 630 631 632 633 634 635 636 637 638
        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') % {
mathieui's avatar
mathieui committed
639 640 641 642 643 644
                           'nick': from_nick,
                           'spec': char_join,
                           'color': color,
                           'info_col': info_col,
                           'color_spec': spec_col,
                       }
mathieui's avatar
mathieui committed
645 646 647 648
            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') % {
mathieui's avatar
mathieui committed
649 650 651 652 653 654 655 656
                           '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,
                       }
mathieui's avatar
mathieui committed
657 658 659 660
            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):
mathieui's avatar
mathieui committed
661 662
        new_nick = presence.xml.find(
            '{%s}x/{%s}item' % (NS_MUC_USER, NS_MUC_USER)).attrib['nick']
663
        old_color = user.color
mathieui's avatar
mathieui committed
664 665 666 667
        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)
668
            user.change_nick(new_nick)
669
        else:
670
            user.change_nick(new_nick)
mathieui's avatar
mathieui committed
671 672
            deterministic = config.get_by_tabname('deterministic_nick_colors',
                                                  self.name)
673 674
            color = config.get_by_tabname(new_nick, 'muc_colors') or None
            if color or deterministic:
mathieui's avatar
mathieui committed
675 676 677
                user.change_color(color, deterministic)
        self.users.remove(user)
        bisect.insort_left(self.users, user)
678

mathieui's avatar
mathieui committed
679 680 681
        if config.get_by_tabname('display_user_color_in_join_part',
                                 self.general_jid):
            color = dump_tuple(user.color)
682
            old_color = dump_tuple(old_color)
683
        else:
684
            old_color = color = 3
mathieui's avatar
mathieui committed
685
        info_col = dump_tuple(get_theme().COLOR_INFORMATION_TEXT)
mathieui's avatar
mathieui committed
686
        self.add_message(
687
            '\x19%(old_color)s}%(old)s\x19%(info_col)s} is'
mathieui's avatar
mathieui committed
688 689 690 691
            ' now known as \x19%(color)s}%(new)s' % {
                'old': from_nick,
                'new': new_nick,
                'color': color,
692
                'old_color': old_color,
mathieui's avatar
mathieui committed
693 694 695
                'info_col': info_col
            },
            typ=2)
mathieui's avatar
mathieui committed
696 697
        # rename the private tabs if needed
        self.core.rename_private_tabs(self.name, from_nick, user)
698

mathieui's avatar
mathieui committed
699
    def on_user_banned(self, presence, user, from_nick):
700
        """
mathieui's avatar
mathieui committed
701
        When someone is banned from a muc
702
        """
mathieui's avatar
mathieui committed
703 704 705 706 707 708 709 710 711
        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
712

mathieui's avatar
mathieui committed
713 714
        info_col = dump_tuple(get_theme().COLOR_INFORMATION_TEXT)
        char_kick = get_theme().CHAR_KICK
715

mathieui's avatar
mathieui committed
716
        if from_nick == self.own_nick:  # we are banned
mathieui's avatar
mathieui committed
717 718 719
            if by:
                kick_msg = ('\x191}%(spec)s \x193}You\x19%(info_col)s}'
                            ' have been banned by \x194}%(by)s') % {
mathieui's avatar
mathieui committed
720 721 722 723
                                'spec': char_kick,
                                'by': by,
                                'info_col': info_col
                            }
mathieui's avatar
mathieui committed
724 725 726
            else:
                kick_msg = ('\x191}%(spec)s \x193}You\x19'
                            '%(info_col)s} have been banned.') % {
mathieui's avatar
mathieui committed
727 728 729
                                'spec': char_kick,
                                'info_col': info_col
                            }
mathieui's avatar
mathieui committed
730 731 732
            self.core.disable_private_tabs(self.name, reason=kick_msg)
            self.disconnect()
            self.refresh_tab_win()
733
            self.core.tabs.current_tab.refresh_input()
mathieui's avatar
mathieui committed
734 735 736 737 738 739 740
            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:
mathieui's avatar
mathieui committed
741 742 743
                    self.core.add_timed_event(
                        timed_events.DelayedEvent(delay, muc.join_groupchat,
                                                  self.core, self.name,
mathieui's avatar
mathieui committed
744
                                                  self.own_nick))
745

mathieui's avatar
mathieui committed
746 747 748 749 750 751 752 753 754 755 756
        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') % {
mathieui's avatar
mathieui committed
757 758 759 760 761 762
                                'spec': char_kick,
                                'nick': from_nick,
                                'color': color,
                                'by': by,
                                'info_col': info_col
                            }
mathieui's avatar
mathieui committed
763 764 765
            else:
                kick_msg = ('\x191}%(spec)s \x19%(color)s}%(nick)s'
                            '\x19%(info_col)s} has been banned') % {
mathieui's avatar
mathieui committed
766 767 768 769 770
                                'spec': char_kick,
                                'nick': from_nick,
                                'color': color,
                                'info_col': info_col
                            }
mathieui's avatar
mathieui committed
771 772 773
        if reason is not None and reason.text:
            kick_msg += ('\x19%(info_col)s} Reason: \x196}'
                         '%(reason)s\x19%(info_col)s}') % {
mathieui's avatar
mathieui committed
774 775 776
                             'reason': reason.text,
                             'info_col': info_col
                         }
mathieui's avatar
mathieui committed
777 778 779
        self.add_message(kick_msg, typ=2)

    def on_user_kicked(self, presence, user, from_nick):
780
        """
mathieui's avatar
mathieui committed
781
        When someone is kicked from a muc
782
        """
mathieui's avatar
mathieui committed
783 784 785 786 787 788 789 790 791 792
        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')
mathieui's avatar
mathieui committed
793
        if from_nick == self.own_nick:  # we are kicked
mathieui's avatar
mathieui committed
794 795 796 797
            if by:
                kick_msg = ('\x191}%(spec)s \x193}You\x19'
                            '%(info_col)s} have been kicked'
                            ' by \x193}%(by)s') % {
mathieui's avatar
mathieui committed
798 799 800 801
                                'spec': char_kick,
                                'by': by,
                                'info_col': info_col
                            }
mathieui's avatar
mathieui committed
802 803 804
            else:
                kick_msg = ('\x191}%(spec)s \x193}You\x19%(info_col)s}'
                            ' have been kicked.') % {
mathieui's avatar
mathieui committed
805 806 807
                                'spec': char_kick,
                                'info_col': info_col
                            }
mathieui's avatar
mathieui committed
808 809 810
            self.core.disable_private_tabs(self.name, reason=kick_msg)
            self.disconnect()
            self.refresh_tab_win()
811
            self.core.tabs.current_tab.refresh_input()
mathieui's avatar
mathieui committed
812 813 814 815 816 817 818 819
            # 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:
mathieui's avatar
mathieui committed
820 821 822 823
                    self.core.add_timed_event(
                        timed_events.DelayedEvent(delay, muc.join_groupchat,
                                                  self.core, self.name,
                                                  self.own_nick))
mathieui's avatar
mathieui committed
824 825 826 827 828 829 830 831 832 833
        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') % {
mathieui's avatar
mathieui committed
834 835 836 837 838 839
                                'spec': char_kick,
                                'nick': from_nick,
                                'color': color,
                                'by': by,
                                'info_col': info_col
                            }
mathieui's avatar
mathieui committed
840 841 842
            else:
                kick_msg = ('\x191}%(spec)s \x19%(color)s}%(nick)s'
                            '\x19%(info_col)s} has been kicked') % {
mathieui's avatar
mathieui committed
843 844 845 846 847
                                'spec': char_kick,
                                'nick': from_nick,
                                'color': color,
                                'info_col': info_col
                            }
mathieui's avatar
mathieui committed
848 849 850
        if reason is not None and reason.text:
            kick_msg += ('\x19%(info_col)s} Reason: \x196}'
                         '%(reason)s') % {
mathieui's avatar
mathieui committed
851 852 853
                             'reason': reason.text,
                             'info_col': info_col
                         }
mathieui's avatar
mathieui committed
854 855
        self.add_message(kick_msg, typ=2)

mathieui's avatar
mathieui committed
856
    def on_user_leave_groupchat(self,
857 858 859 860 861
                                user: User,
                                jid: JID,
                                status: str,
                                from_nick: str,
                                from_room: JID,
862
                                server_initiated=False):
mathieui's avatar
mathieui committed
863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885
        """
        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)

886 887 888 889
            error_leave_txt = ''
            if server_initiated:
                error_leave_txt = ' due to an error'

mathieui's avatar
mathieui committed
890 891 892
            if not jid.full:
                leave_msg = ('\x19%(color_spec)s}%(spec)s \x19%(color)s}'
                             '%(nick)s\x19%(info_col)s} has left the '
893
                             'room%(error_leave)s') % {
mathieui's avatar
mathieui committed
894 895 896 897
                                 'nick': from_nick,
                                 'color': color,
                                 'spec': get_theme().CHAR_QUIT,
                                 'info_col': info_col,
898 899
                                 'color_spec': spec_col,
                                 'error_leave': error_leave_txt,
mathieui's avatar
mathieui committed
900
                             }
mathieui's avatar
mathieui committed
901 902 903 904 905
            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 '
906
                             'room%(error_leave)s') % {
mathieui's avatar
mathieui committed
907 908 909 910 911 912
                                 'spec': get_theme().CHAR_QUIT,
                                 'nick': from_nick,
                                 'color': color,
                                 'jid': jid.full,
                                 'info_col': info_col,
                                 'color_spec': spec_col,
913 914
                                 'jid_col': jid_col,
                                 'error_leave': error_leave_txt,
mathieui's avatar
mathieui committed
915
                             }
mathieui's avatar
mathieui committed
916 917 918
            if status:
                leave_msg += ' (\x19o%s\x19%s})' % (status, info_col)
            self.add_message(leave_msg, typ=2)
mathieui's avatar
mathieui committed
919
        self.core.on_user_left_private_conversation(from_room, user, status)
mathieui's avatar
mathieui committed
920

mathieui's avatar
mathieui committed
921 922
    def on_user_change_status(self, user, from_nick, from_room, affiliation,
                              role, show, status):
mathieui's avatar
mathieui committed
923 924 925 926
        """
        When an user changes her status
        """
        # build the message
mathieui's avatar
mathieui committed
927 928
        display_message = False  # flag to know if something significant enough
        # to be displayed has changed
mathieui's avatar
mathieui committed
929 930 931 932 933 934 935
        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: ' % {
mathieui's avatar
mathieui committed
936 937 938
                'info_col': dump_tuple(get_theme().COLOR_INFORMATION_TEXT),
                'color': color
            }
mathieui's avatar
mathieui committed
939 940
        else:
            msg = '\x19%(color)s}%(nick)s\x19%(info_col)s} changed: ' % {
mathieui's avatar
mathieui committed
941 942 943 944
                'nick': from_nick,
                'color': color,
                'info_col': dump_tuple(get_theme().COLOR_INFORMATION_TEXT)
            }
mathieui's avatar
mathieui committed
945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963
        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
mathieui's avatar
mathieui committed
964
        msg = msg[:-2]  # remove the last ", "
mathieui's avatar
mathieui committed
965 966 967 968
        hide_status_change = config.get_by_tabname('hide_status_change',
                                                   self.general_jid)
        if hide_status_change < -1:
            hide_status_change = -1
969 970 971 972 973 974
        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):
mathieui's avatar
mathieui committed
975 976
            # display the message in the room
            self._text_buffer.add_message(msg)
mathieui's avatar
mathieui committed
977 978
        self.core.on_user_changed_status_in_private(
            '%s/%s' % (from_room, from_nick), Status(show, status))
mathieui's avatar
mathieui committed
979 980 981 982 983 984 985 986 987 988 989 990
        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 = []
991
        if self is not self.core.tabs.current_tab:
mathieui's avatar
mathieui committed
992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006
            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
        """
mathieui's avatar
mathieui committed
1007
        if time is None and self.joined:  # don't log the history messages
mathieui's avatar
mathieui committed
1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049
            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
mathieui's avatar
mathieui committed
1050 1051 1052
                and self.state != 'current'):
            if (self.state != 'highlight'
                    and config.get_by_tabname('notify_messages', self.name)):
mathieui's avatar
mathieui committed
1053 1054 1055
                self.state = 'message'
        if time and not txt.startswith('/me'):
            txt = '\x19%(info_col)s}%(txt)s' % {
mathieui's avatar
mathieui committed
1056 1057 1058
                'txt': txt,
                'info_col': dump_tuple(get_theme().COLOR_LOG_MSG)
            }
mathieui's avatar
mathieui committed
1059 1060
        elif not nickname:
            txt = '\x19%(info_col)s}%(txt)s' % {
mathieui's avatar
mathieui committed
1061 1062 1063 1064
                'txt': txt,
                'info_col': dump_tuple(get_theme().COLOR_INFORMATION_TEXT)
            }
        elif not kwargs.get('highlight'):  # TODO
mathieui's avatar
mathieui committed
1065 1066 1067 1068
            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)
1069

mathieui's avatar
mathieui committed
1070 1071 1072 1073 1074 1075 1076 1077
    def modify_message(self,
                       txt,
                       old_id,
                       new_id,
                       time=None,
                       nickname=None,
                       user=None,
                       jid=None):
mathieui's avatar
mathieui committed
1078 1079
        self.log_message(txt, nickname, time=time, typ=1)
        highlight = self.do_highlight(txt, time, nickname, corrected=True)
mathieui's avatar
mathieui committed
1080 1081 1082 1083 1084 1085 1086 1087
        message = self._text_buffer.modify_message(
            txt,
            old_id,
            new_id,
            highlight=highlight,
            time=time,
            user=user,
            jid=jid)
mathieui's avatar
mathieui committed
1088 1089 1090 1091
        if message:
            self.text_win.modify_message(old_id, message)
            return highlight
        return False