muctab.py 77.4 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
    additional_information = {}  # type: Dict[str, Callable[[str], str]]
56

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

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

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

103
    @property
104
    def last_connection(self) -> Optional[datetime]:
105 106 107 108 109
        last_message = self._text_buffer.last_message
        if last_message:
            return last_message.time
        return None

110 111 112 113 114 115 116 117 118 119 120 121 122 123
    @staticmethod
    def add_information_element(plugin_name: str, callback: Callable[[str], str]) -> None:
        """
        Lets a plugin add its own information to the MucInfoWin
        """
        MucTab.additional_information[plugin_name] = callback

    @staticmethod
    def remove_information_element(plugin_name: str) -> None:
        """
        Lets a plugin add its own information to the MucInfoWin
        """
        del MucTab.additional_information[plugin_name]

124 125 126 127
    def cancel_config(self, form):
        """
        The user do not want to send his/her config, send an iq cancel
        """
128
        muc.cancel_config(self.core.xmpp, self.name)
129 130 131 132 133 134
        self.core.close_tab()

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

138 139 140 141 142 143 144 145 146
    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:
147
            seconds = None
mathieui's avatar
mathieui committed
148 149 150 151 152 153 154 155
        muc.join_groupchat(
            self.core,
            self.name,
            self.own_nick,
            self.password,
            status=status.message,
            show=status.show,
            seconds=seconds)
156

157
    def leave_room(self, message: str):
mathieui's avatar
mathieui committed
158 159 160 161
        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)
162

163 164
            if config.get_by_tabname('display_user_color_in_join_part',
                                     self.general_jid):
165 166
                color = dump_tuple(get_theme().COLOR_OWN_NICK)
            else:
167
                color = "3"
168

mathieui's avatar
mathieui committed
169
            if message:
170 171
                msg = ('\x19%(color_spec)s}%(spec)s\x19%(info_col)s} '
                       'You (\x19%(color)s}%(nick)s\x19%(info_col)s})'
172
                       ' left the room'
173
                       ' (\x19o%(reason)s\x19%(info_col)s})') % {
mathieui's avatar
mathieui committed
174 175 176 177
                           'info_col': info_col,
                           'reason': message,
                           'spec': char_quit,
                           'color': color,
178 179 180
                           'color_spec': spec_col,
                           'nick': self.own_nick,
                       }
181
            else:
182 183
                msg = ('\x19%(color_spec)s}%(spec)s\x19%(info_col)s} '
                       'You (\x19%(color)s}%(nick)s\x19%(info_col)s})'
184
                       ' left the room') % {
185
                           'info_col': info_col,
mathieui's avatar
mathieui committed
186 187
                           'spec': char_quit,
                           'color': color,
188 189 190
                           'color_spec': spec_col,
                           'nick': self.own_nick,
                       }
191

192
            self.add_message(msg, typ=2)
193
            self.disconnect()
mathieui's avatar
mathieui committed
194 195
            muc.leave_groupchat(self.core.xmpp, self.name, self.own_nick,
                                message)
196
            self.core.disable_private_tabs(self.name, reason=msg)
197
        else:
mathieui's avatar
mathieui committed
198 199
            muc.leave_groupchat(self.core.xmpp, self.name, self.own_nick,
                                message)
mathieui's avatar
mathieui committed
200

201 202 203 204
    def change_affiliation(self,
                           nick_or_jid: Union[str, JID],
                           affiliation: str,
                           reason=''):
205 206 207
        """
        Change the affiliation of a nick or JID
        """
mathieui's avatar
mathieui committed
208

209 210
        def callback(iq):
            if iq['type'] == 'error':
mathieui's avatar
mathieui committed
211 212 213 214
                self.core.information(
                    "Could not set affiliation '%s' for '%s'." %
                    (affiliation, nick_or_jid), "Warning")

215 216 217 218 219
        if not self.joined:
            return

        valid_affiliations = ('outcast', 'none', 'member', 'admin', 'owner')
        if affiliation not in valid_affiliations:
mathieui's avatar
mathieui committed
220 221 222
            return self.core.information(
                'The affiliation must be one of ' +
                ', '.join(valid_affiliations), 'Error')
223
        if nick_or_jid in [user.nick for user in self.users]:
mathieui's avatar
mathieui committed
224
            muc.set_user_affiliation(
mathieui's avatar
mathieui committed
225 226 227 228 229 230
                self.core.xmpp,
                self.name,
                affiliation,
                nick=nick_or_jid,
                callback=callback,
                reason=reason)
231
        else:
mathieui's avatar
mathieui committed
232
            muc.set_user_affiliation(
mathieui's avatar
mathieui committed
233 234 235 236 237 238
                self.core.xmpp,
                self.name,
                affiliation,
                jid=safeJID(nick_or_jid),
                callback=callback,
                reason=reason)
239

240
    def change_role(self, nick: str, role: str, reason=''):
241 242 243
        """
        Change the role of a nick
        """
mathieui's avatar
mathieui committed
244

245 246
        def callback(iq):
            if iq['type'] == 'error':
mathieui's avatar
mathieui committed
247 248 249
                self.core.information(
                    "Could not set role '%s' for '%s'." % (role, nick),
                    "Warning")
mathieui's avatar
mathieui committed
250

251 252 253
        valid_roles = ('none', 'visitor', 'participant', 'moderator')

        if not self.joined or role not in valid_roles:
mathieui's avatar
mathieui committed
254 255
            return self.core.information(
                'The role must be one of ' + ', '.join(valid_roles), 'Error')
256 257 258

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

mathieui's avatar
mathieui committed
262
    @refresh_wrapper.conditional
263
    def print_info(self, nick: str) -> bool:
mathieui's avatar
mathieui committed
264 265 266 267 268 269 270 271 272
        """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
273
                inf, dump_tuple(theme.COLOR_MUC_JID), user.jid, inf)
mathieui's avatar
mathieui committed
274 275 276 277 278 279
        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
280 281 282 283 284 285 286 287 288 289 290
                    '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
291 292 293
        self.add_message(info, typ=0)
        return True

294
    def change_topic(self, topic: str):
mathieui's avatar
mathieui committed
295 296 297 298 299 300 301 302 303 304 305 306 307 308
        """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
309 310
                user_string = '\x19%s}(set by \x19%s}%s\x19%s})' % (
                    info_text, user_text, user.nick, info_text)
mathieui's avatar
mathieui committed
311 312 313 314 315 316
            else:
                user_string = self.topic_from
        else:
            user_string = ''

        self._text_buffer.add_message(
mathieui's avatar
mathieui committed
317 318
            "\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
319

mathieui's avatar
mathieui committed
320 321 322
    @refresh_wrapper.always
    def recolor(self, random_colors=False):
        """Recolor the current MUC users"""
mathieui's avatar
mathieui committed
323 324
        deterministic = config.get_by_tabname('deterministic_nick_colors',
                                              self.name)
mathieui's avatar
mathieui committed
325 326 327 328 329 330 331 332 333 334 335
        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
336
        sorted_users = sorted(self.users, key=COMPARE_USERS_LAST_TALKED, reverse=True)
mathieui's avatar
mathieui committed
337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353
        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)

354
    @refresh_wrapper.conditional
355
    def set_nick_color(self, nick: str, color: str) -> bool:
356 357 358 359 360 361 362 363
        "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
364 365
                self.core.information('Color for nick %s unset' % (nick),
                                      'Info')
366 367 368 369 370 371
        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
372 373
            nick_color_aliases = config.get_by_tabname('nick_color_aliases',
                                                       self.name)
374 375 376 377 378 379 380 381 382 383 384
            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
385

mathieui's avatar
mathieui committed
386 387 388 389 390 391
    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
392 393 394
        empty_after = empty_after or (
            self.input.get_text().startswith('/')
            and not self.input.get_text().startswith('//'))
mathieui's avatar
mathieui committed
395 396
        self.send_composing_chat_state(empty_after)
        return False
397

398
    def get_nick(self) -> str:
399 400 401 402 403 404 405
        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
406

mathieui's avatar
mathieui committed
407 408
    def get_text_window(self):
        return self.text_win
409

mathieui's avatar
mathieui committed
410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
    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
430 431
        if self.joined and config.get_by_tabname(
                'send_chat_states',
mathieui's avatar
mathieui committed
432 433 434 435
                self.general_jid) and not self.input.get_text():
            self.send_chat_state('active')

    def handle_presence(self, presence):
436
        """
mathieui's avatar
mathieui committed
437
        Handle MUC presence
438
        """
mathieui's avatar
mathieui committed
439 440 441
        status_codes = set()
        for status_code in presence.xml.findall(STATUS_XPATH):
            status_codes.add(status_code.attrib['code'])
mathieui's avatar
mathieui committed
442 443 444
        if presence['type'] == 'error':
            self.core.room_error(presence, self.name)
        elif not self.joined:
mathieui's avatar
mathieui committed
445
            if '110' in status_codes or self.own_nick == presence['from'].resource:
mathieui's avatar
mathieui committed
446
                self.process_presence_buffer(presence)
mathieui's avatar
mathieui committed
447 448 449 450 451 452 453 454
            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)
455
        if self.core.tabs.current_tab is self:
mathieui's avatar
mathieui committed
456 457
            self.text_win.refresh()
            self.user_win.refresh_if_changed(self.users)
458 459 460
            self.info_header.refresh(
                self, self.text_win, user=self.own_user,
                information=MucTab.additional_information)
mathieui's avatar
mathieui committed
461 462
            self.input.refresh()
            self.core.doupdate()
463

mathieui's avatar
mathieui committed
464
    def process_presence_buffer(self, last_presence):
465
        """
mathieui's avatar
mathieui committed
466
        Batch-process all the initial presences
467
        """
mathieui's avatar
mathieui committed
468 469
        deterministic = config.get_by_tabname('deterministic_nick_colors',
                                              self.name)
mathieui's avatar
mathieui committed
470

mathieui's avatar
mathieui committed
471 472 473 474 475 476 477 478 479 480
        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()
481
        if self.core.tabs.current_tab is not self:
mathieui's avatar
mathieui committed
482
            self.refresh_tab_win()
483
            self.core.tabs.current_tab.refresh_input()
mathieui's avatar
mathieui committed
484
            self.core.doupdate()
485

mathieui's avatar
mathieui committed
486 487 488 489
    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
490
        from_nick, _, affiliation, show, status, role, jid, typ = dissect_presence(
mathieui's avatar
mathieui committed
491
            presence)
492 493
        if typ == 'unavailable':
            return
mathieui's avatar
mathieui committed
494
        user_color = self.search_for_color(from_nick)
mathieui's avatar
mathieui committed
495 496
        new_user = User(from_nick, affiliation, show, status, role, jid,
                        deterministic, user_color)
mathieui's avatar
mathieui committed
497 498 499 500 501 502 503
        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)
504

505
    def own_join(self, from_nick: str, new_user: User, status_codes: Set[str]):
506
        """
mathieui's avatar
mathieui committed
507
        Handle the last presence we received, entering the room
508
        """
mathieui's avatar
mathieui committed
509 510 511 512 513 514
        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'
515
        elif self != self.core.tabs.current_tab:
mathieui's avatar
mathieui committed
516
            self._state = 'joined'
517
        if (self.core.tabs.current_tab is self
mathieui's avatar
mathieui committed
518 519 520
                and self.core.status.show not in ('xa', 'away')):
            self.send_chat_state('active')
        new_user.color = get_theme().COLOR_OWN_NICK
521

mathieui's avatar
mathieui committed
522 523 524 525
        if config.get_by_tabname('display_user_color_in_join_part',
                                 self.general_jid):
            color = dump_tuple(new_user.color)
        else:
526
            color = "3"
527

mathieui's avatar
mathieui committed
528 529 530
        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
531 532 533 534 535 536 537 538 539
        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
540 541 542 543
        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
544 545
                '\x19%(info_col)s}Info: The room '
                'has been created' % {'info_col': info_col},
mathieui's avatar
mathieui committed
546 547 548
                typ=0)
        if '170' in status_codes:
            self.add_message(
mathieui's avatar
mathieui committed
549
                '\x19%(warn_col)s}Warning:\x19%(info_col)s}'
mathieui's avatar
mathieui committed
550 551 552 553
                ' This room is publicly logged' % {
                    'info_col': info_col,
                    'warn_col': warn_col
                },
mathieui's avatar
mathieui committed
554 555 556
                typ=0)
        if '100' in status_codes:
            self.add_message(
mathieui's avatar
mathieui committed
557
                '\x19%(warn_col)s}Warning:\x19%(info_col)s}'
mathieui's avatar
mathieui committed
558 559 560 561
                ' This room is not anonymous.' % {
                    'info_col': info_col,
                    'warn_col': warn_col
                },
mathieui's avatar
mathieui committed
562
                typ=0)
563

mathieui's avatar
mathieui committed
564
    def handle_presence_joined(self, presence, status_codes):
565
        """
mathieui's avatar
mathieui committed
566
        Handle new presences when we are already in the room
567
        """
mathieui's avatar
mathieui committed
568 569
        from_nick, from_room, affiliation, show, status, role, jid, typ = dissect_presence(
            presence)
mathieui's avatar
mathieui committed
570 571 572 573
        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'
574
        server_initiated = '333' in status_codes and typ == 'unavailable'
mathieui's avatar
mathieui committed
575 576 577 578 579 580
        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
581 582
            self.on_user_join(from_nick, affiliation, show, status, role, jid,
                              user_color)
mathieui's avatar
mathieui committed
583 584 585 586 587 588 589 590
        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
591 592
            self.core.on_user_left_private_conversation(
                from_room, user, status)
mathieui's avatar
mathieui committed
593
            self.on_user_banned(presence, user, from_nick)
594
        elif kick and not server_initiated:
mathieui's avatar
mathieui committed
595
            self.core.events.trigger('muc_kick', presence, self)
mathieui's avatar
mathieui committed
596 597
            self.core.on_user_left_private_conversation(
                from_room, user, status)
mathieui's avatar
mathieui committed
598 599 600 601 602 603 604 605 606
            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
607
            self.on_user_leave_groupchat(user, jid, status, from_nick,
608
                                         from_room, server_initiated)
mathieui's avatar
mathieui committed
609
        # status change
610
        else:
mathieui's avatar
mathieui committed
611 612
            self.on_user_change_status(user, from_nick, from_room, affiliation,
                                       role, show, status)
613

mathieui's avatar
mathieui committed
614 615 616
    def on_non_member_kicked(self):
        """We have been kicked because the MUC is members-only"""
        self.add_message(
mathieui's avatar
mathieui committed
617 618 619
            '\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
620 621 622 623 624 625
            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
626 627 628
            '\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
629 630 631
            typ=2)
        self.disconnect()

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

mathieui's avatar
mathieui committed
696 697 698
        if config.get_by_tabname('display_user_color_in_join_part',
                                 self.general_jid):
            color = dump_tuple(user.color)
699
            old_color = dump_tuple(old_color)
700
        else:
701
            old_color = color = 3
mathieui's avatar
mathieui committed
702
        info_col = dump_tuple(get_theme().COLOR_INFORMATION_TEXT)
mathieui's avatar
mathieui committed
703
        self.add_message(
704
            '\x19%(old_color)s}%(old)s\x19%(info_col)s} is'
mathieui's avatar
mathieui committed
705 706 707 708
            ' now known as \x19%(color)s}%(new)s' % {
                'old': from_nick,
                'new': new_nick,
                'color': color,
709
                'old_color': old_color,
mathieui's avatar
mathieui committed
710 711 712
                'info_col': info_col
            },
            typ=2)
mathieui's avatar
mathieui committed
713 714
        # rename the private tabs if needed
        self.core.rename_private_tabs(self.name, from_nick, user)
715

mathieui's avatar
mathieui committed
716
    def on_user_banned(self, presence, user, from_nick):
717
        """
mathieui's avatar
mathieui committed
718
        When someone is banned from a muc
719
        """
mathieui's avatar
mathieui committed
720 721 722 723 724 725 726 727 728
        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
729

mathieui's avatar
mathieui committed
730 731
        info_col = dump_tuple(get_theme().COLOR_INFORMATION_TEXT)
        char_kick = get_theme().CHAR_KICK
732

mathieui's avatar
mathieui committed
733
        if from_nick == self.own_nick:  # we are banned
mathieui's avatar
mathieui committed
734 735 736
            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
737 738 739 740
                                'spec': char_kick,
                                'by': by,
                                'info_col': info_col
                            }
mathieui's avatar
mathieui committed
741 742 743
            else:
                kick_msg = ('\x191}%(spec)s \x193}You\x19'
                            '%(info_col)s} have been banned.') % {
mathieui's avatar
mathieui committed
744 745 746
                                'spec': char_kick,
                                'info_col': info_col
                            }
mathieui's avatar
mathieui committed
747 748 749
            self.core.disable_private_tabs(self.name, reason=kick_msg)
            self.disconnect()
            self.refresh_tab_win()
750
            self.core.tabs.current_tab.refresh_input()
mathieui's avatar
mathieui committed
751 752 753 754 755 756 757
            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
758 759 760
                    self.core.add_timed_event(
                        timed_events.DelayedEvent(delay, muc.join_groupchat,
                                                  self.core, self.name,
mathieui's avatar
mathieui committed
761
                                                  self.own_nick))
762

mathieui's avatar
mathieui committed
763 764 765 766 767 768 769 770 771 772 773
        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
774 775 776 777 778 779
                                'spec': char_kick,
                                'nick': from_nick,
                                'color': color,
                                'by': by,
                                'info_col': info_col
                            }
mathieui's avatar
mathieui committed
780 781 782
            else:
                kick_msg = ('\x191}%(spec)s \x19%(color)s}%(nick)s'
                            '\x19%(info_col)s} has been banned') % {
mathieui's avatar
mathieui committed
783 784 785 786 787
                                'spec': char_kick,
                                'nick': from_nick,
                                'color': color,
                                'info_col': info_col
                            }
mathieui's avatar
mathieui committed
788 789 790
        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
791 792 793
                             'reason': reason.text,
                             'info_col': info_col
                         }
mathieui's avatar
mathieui committed
794 795 796
        self.add_message(kick_msg, typ=2)

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

mathieui's avatar
mathieui committed
873
    def on_user_leave_groupchat(self,
874 875 876 877 878
                                user: User,
                                jid: JID,
                                status: str,
                                from_nick: str,
                                from_room: JID,
879
                                server_initiated=False):
mathieui's avatar
mathieui committed
880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902
        """
        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)

903 904 905 906
            error_leave_txt = ''
            if server_initiated:
                error_leave_txt = ' due to an error'

mathieui's avatar
mathieui committed
907 908 909
            if not jid.full:
                leave_msg = ('\x19%(color_spec)s}%(spec)s \x19%(color)s}'
                             '%(nick)s\x19%(info_col)s} has left the '
910
                             'room%(error_leave)s') % {
mathieui's avatar
mathieui committed
911 912 913 914
                                 'nick': from_nick,
                                 'color': color,
                                 'spec': get_theme().CHAR_QUIT,
                                 'info_col': info_col,
915 916
                                 'color_spec': spec_col,
                                 'error_leave': error_leave_txt,
mathieui's avatar
mathieui committed
917
                             }
mathieui's avatar
mathieui committed
918 919 920 921 922
            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 '
923
                             'room%(error_leave)s') % {
mathieui's avatar
mathieui committed
924 925 926 927 928 929
                                 'spec': get_theme().CHAR_QUIT,
                                 'nick': from_nick,
                                 'color': color,
                                 'jid': jid.full,
                                 'info_col': info_col,
                                 'color_spec': spec_col,
930 931
                                 'jid_col': jid_col,
                                 'error_leave': error_leave_txt,
mathieui's avatar
mathieui committed
932
                             }
mathieui's avatar
mathieui committed
933 934 935
            if status:
                leave_msg += ' (\x19o%s\x19%s})' % (status, info_col)
            self.add_message(leave_msg, typ=2)
mathieui's avatar
mathieui committed
936
        self.core.on_user_left_private_conversation(from_room, user, status)
mathieui's avatar
mathieui committed
937

mathieui's avatar
mathieui committed
938 939
    def on_user_change_status(self, user, from_nick, from_room, affiliation,
                              role, show, status):
mathieui's avatar
mathieui committed
940 941 942 943
        """
        When an user changes her status
        """
        # build the message
mathieui's avatar
mathieui committed
944 945
        display_message = False  # flag to know if something significant enough
        # to be displayed has changed
mathieui's avatar
mathieui committed
946 947 948 949 950 951 952
        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
953 954 955
                'info_col': dump_tuple(get_theme().COLOR_INFORMATION_TEXT),
                'color': color
            }
mathieui's avatar
mathieui committed
956 957
        else:
            msg = '\x19%(color)s}%(nick)s\x19%(info_col)s} changed: ' % {
mathieui's avatar
mathieui committed
958 959 960 961
                'nick': from_nick,
                'color': color,
                'info_col': dump_tuple(get_theme().COLOR_INFORMATION_TEXT)
            }
mathieui's avatar
mathieui committed
962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980
        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
981
        msg = msg[:-2]  # remove the last ", "
mathieui's avatar
mathieui committed
982 983 984 985
        hide_status_change = config.get_by_tabname('hide_status_change',
                                                   self.general_jid)
        if hide_status_change < -1:
            hide_status_change = -1
986 987 988 989 990 991
        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
992 993
            # display the message in the room
            self._text_buffer.add_message(msg)
mathieui's avatar
mathieui committed
994 995
        self.core.on_user_changed_status_in_private(
            '%s/%s' % (from_room, from_nick), Status(show, status))
mathieui's avatar
mathieui committed
996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007
        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 = []
1008
        if self is not self.core.tabs.current_tab:
mathieui's avatar
mathieui committed
1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023
            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
1024
        if time is None and self.joined:  # don't log the history messages
mathieui's avatar
mathieui committed
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 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066
            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
1067 1068 1069
                and self.state != 'current'):
            if (self.state != 'highlight'
                    and config.get_by_tabname('notify_messages', self.name)):
mathieui's avatar
mathieui committed
1070 1071 1072
                self.state = 'message'
        if time and not txt.startswith('/me'):
            txt = '\x19%(info_col)s}%(txt)s' % {
mathieui's avatar
mathieui committed
1073 1074 1075
                'txt': txt,
                'info_col': dump_tuple(get_theme().COLOR_LOG_MSG)
            }
mathieui's avatar
mathieui committed
1076 1077
        elif not nickname:
            txt = '\x19%(info_col)s}%(txt)s' % {
mathieui's avatar
mathieui committed
1078 1079 1080 1081
                'txt': txt,
                'info_col': dump_tuple(get_theme().COLOR_INFORMATION_TEXT)
            }
        elif not kwargs.get('highlight'):  # TODO
mathieui's avatar
mathieui committed
1082 1083 1084 1085
            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)
1086