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

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

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

10
import asyncio
11
import bisect
12
import curses
13
import logging
Madhur Garg's avatar
Madhur Garg committed
14
import asyncio
15 16
import os
import random
17
import re
18
import functools
19
from copy import copy
mathieui's avatar
mathieui committed
20
from datetime import datetime
21
from typing import Dict, Callable, List, Optional, Union, Set
22

23
from slixmpp import InvalidJID, JID
24
from slixmpp.exceptions import IqError, IqTimeout
25
from poezio.tabs import ChatTab, Tab, SHOW_NAME
26

27 28
from poezio import common
from poezio import fixes
29
from poezio import mam
30 31 32 33 34 35
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
36
from poezio.core.structs import Command
37 38 39 40 41
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
42
from poezio.core.structs import Completion, Status
43
from poezio.ui.types import BaseMessage, Message, InfoMessage, StatusMessage
44

45 46
log = logging.getLogger(__name__)

47
NS_MUC_USER = 'http://jabber.org/protocol/muc#user'
48
STATUS_XPATH = '{%s}x/{%s}status' % (NS_MUC_USER, NS_MUC_USER)
49

50 51
COMPARE_USERS_LAST_TALKED = lambda x: x.last_talked

52 53 54 55

class MucTab(ChatTab):
    """
    The tab containing a multi-user-chat room.
Maxime Buquet's avatar
Maxime Buquet committed
56
    It contains a userlist, an input, a topic, an information and a chat zone
57 58
    """
    message_type = 'groupchat'
59 60
    plugin_commands = {}  # type: Dict[str, Command]
    plugin_keys = {}  # type: Dict[str, Callable]
61
    additional_information = {}  # type: Dict[str, Callable[[str], str]]
62
    lagged = False
63

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

    @property
    def general_jid(self):
105
        return self.jid
106

107
    def check_send_chat_state(self) -> bool:
mathieui's avatar
mathieui committed
108 109 110
        "If we should send a chat state"
        return self.joined

111
    @property
112
    def last_connection(self) -> Optional[datetime]:
113 114 115 116 117
        last_message = self._text_buffer.last_message
        if last_message:
            return last_message.time
        return None

118
    @staticmethod
119
    @refresh_wrapper.always
120 121 122 123 124 125 126
    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
127
    @refresh_wrapper.always
128 129 130 131 132 133
    def remove_information_element(plugin_name: str) -> None:
        """
        Lets a plugin add its own information to the MucInfoWin
        """
        del MucTab.additional_information[plugin_name]

134 135
    def cancel_config(self, form):
        """
Kim Alvefur's avatar
Kim Alvefur committed
136
        The user do not want to send their config, send an iq cancel
137
        """
138
        muc.cancel_config(self.core.xmpp, self.jid.bare)
139 140 141 142
        self.core.close_tab()

    def send_config(self, form):
        """
Kim Alvefur's avatar
Kim Alvefur committed
143
        The user sends their config to the server
144
        """
145
        muc.configure_room(self.core.xmpp, self.jid.bare, form)
146 147
        self.core.close_tab()

148 149 150 151 152 153 154 155 156
    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:
157
            seconds = None
mathieui's avatar
mathieui committed
158 159
        muc.join_groupchat(
            self.core,
160
            self.jid.bare,
mathieui's avatar
mathieui committed
161 162 163 164 165
            self.own_nick,
            self.password,
            status=status.message,
            show=status.show,
            seconds=seconds)
Madhur Garg's avatar
Madhur Garg committed
166
        asyncio.ensure_future(mam.on_tab_open(self))
167

168
    def leave_room(self, message: str):
mathieui's avatar
mathieui committed
169
        if self.joined:
170 171 172 173
            theme = get_theme()
            info_col = dump_tuple(theme.COLOR_INFORMATION_TEXT)
            char_quit = theme.CHAR_QUIT
            spec_col = dump_tuple(theme.COLOR_QUIT_CHAR)
174

175 176
            if config.get_by_tabname('display_user_color_in_join_part',
                                     self.general_jid):
177
                color = dump_tuple(theme.COLOR_OWN_NICK)
178
            else:
179
                color = "3"
180

mathieui's avatar
mathieui committed
181
            if message:
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
                       ' (\x19o%(reason)s\x19%(info_col)s})') % {
mathieui's avatar
mathieui committed
186 187 188 189
                           'info_col': info_col,
                           'reason': message,
                           'spec': char_quit,
                           'color': color,
190 191 192
                           'color_spec': spec_col,
                           'nick': self.own_nick,
                       }
193
            else:
194 195
                msg = ('\x19%(color_spec)s}%(spec)s\x19%(info_col)s} '
                       'You (\x19%(color)s}%(nick)s\x19%(info_col)s})'
196
                       ' left the room') % {
197
                           'info_col': info_col,
mathieui's avatar
mathieui committed
198 199
                           'spec': char_quit,
                           'color': color,
200 201 202
                           'color_spec': spec_col,
                           'nick': self.own_nick,
                       }
203
            self.add_message(InfoMessage(msg), typ=2)
204
            self.disconnect()
205
            muc.leave_groupchat(self.core.xmpp, self.jid.bare, self.own_nick,
mathieui's avatar
mathieui committed
206
                                message)
207
            self.core.disable_private_tabs(self.jid.bare, reason=msg)
208
        else:
209
            muc.leave_groupchat(self.core.xmpp, self.jid.bare, self.own_nick,
mathieui's avatar
mathieui committed
210
                                message)
mathieui's avatar
mathieui committed
211

212 213 214 215
    def change_affiliation(self,
                           nick_or_jid: Union[str, JID],
                           affiliation: str,
                           reason=''):
216 217 218
        """
        Change the affiliation of a nick or JID
        """
mathieui's avatar
mathieui committed
219

220 221
        def callback(iq):
            if iq['type'] == 'error':
mathieui's avatar
mathieui committed
222 223 224 225
                self.core.information(
                    "Could not set affiliation '%s' for '%s'." %
                    (affiliation, nick_or_jid), "Warning")

226 227 228 229 230
        if not self.joined:
            return

        valid_affiliations = ('outcast', 'none', 'member', 'admin', 'owner')
        if affiliation not in valid_affiliations:
mathieui's avatar
mathieui committed
231 232 233
            return self.core.information(
                'The affiliation must be one of ' +
                ', '.join(valid_affiliations), 'Error')
234
        if nick_or_jid in [user.nick for user in self.users]:
mathieui's avatar
mathieui committed
235
            muc.set_user_affiliation(
mathieui's avatar
mathieui committed
236
                self.core.xmpp,
237
                self.jid.bare,
mathieui's avatar
mathieui committed
238 239 240 241
                affiliation,
                nick=nick_or_jid,
                callback=callback,
                reason=reason)
242
        else:
mathieui's avatar
mathieui committed
243
            muc.set_user_affiliation(
mathieui's avatar
mathieui committed
244
                self.core.xmpp,
245
                self.jid.bare,
mathieui's avatar
mathieui committed
246 247 248 249
                affiliation,
                jid=safeJID(nick_or_jid),
                callback=callback,
                reason=reason)
250

251
    def change_role(self, nick: str, role: str, reason=''):
252 253 254
        """
        Change the role of a nick
        """
mathieui's avatar
mathieui committed
255

256 257
        def callback(iq):
            if iq['type'] == 'error':
mathieui's avatar
mathieui committed
258 259 260
                self.core.information(
                    "Could not set role '%s' for '%s'." % (role, nick),
                    "Warning")
mathieui's avatar
mathieui committed
261

262 263 264
        valid_roles = ('none', 'visitor', 'participant', 'moderator')

        if not self.joined or role not in valid_roles:
mathieui's avatar
mathieui committed
265 266
            return self.core.information(
                'The role must be one of ' + ', '.join(valid_roles), 'Error')
267

268 269 270 271
        try:
            target_jid = copy(self.jid)
            target_jid.resource = nick
        except InvalidJID:
272
            return self.core.information('Invalid nick', 'Info')
273

mathieui's avatar
mathieui committed
274
        muc.set_user_role(
275
            self.core.xmpp, self.jid.bare, nick, reason, role, callback=callback)
276

mathieui's avatar
mathieui committed
277
    @refresh_wrapper.conditional
278
    def print_info(self, nick: str) -> bool:
mathieui's avatar
mathieui committed
279 280 281 282 283 284 285 286 287
        """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
288
                inf, dump_tuple(theme.COLOR_MUC_JID), user.jid, inf)
mathieui's avatar
mathieui committed
289 290 291 292 293 294
        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
295 296 297 298 299 300 301 302 303 304 305
                    '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 ''
                }
306
        self.add_message(InfoMessage(info), typ=0)
mathieui's avatar
mathieui committed
307 308
        return True

309
    def change_topic(self, topic: str):
mathieui's avatar
mathieui committed
310
        """Change the current topic"""
311
        muc.change_subject(self.core.xmpp, self.jid.bare, topic)
mathieui's avatar
mathieui committed
312 313 314 315 316 317

    @refresh_wrapper.always
    def show_topic(self):
        """
        Print the current topic
        """
318 319 320
        theme = get_theme()
        info_text = dump_tuple(theme.COLOR_INFORMATION_TEXT)
        norm_text = dump_tuple(theme.COLOR_NORMAL_TEXT)
mathieui's avatar
mathieui committed
321 322 323 324
        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
325 326
                user_string = '\x19%s}(set by \x19%s}%s\x19%s})' % (
                    info_text, user_text, user.nick, info_text)
mathieui's avatar
mathieui committed
327 328 329 330 331
            else:
                user_string = self.topic_from
        else:
            user_string = ''

332 333 334 335 336 337 338
        self.add_message(
            InfoMessage(
                "The subject of the room is: \x19%s}%s %s" %
                (norm_text, self.topic, user_string),
            ),
            typ=0,
        )
mathieui's avatar
mathieui committed
339

mathieui's avatar
mathieui committed
340 341 342
    @refresh_wrapper.always
    def recolor(self, random_colors=False):
        """Recolor the current MUC users"""
mathieui's avatar
mathieui committed
343
        deterministic = config.get_by_tabname('deterministic_nick_colors',
344
                                              self.jid.bare)
mathieui's avatar
mathieui committed
345 346 347 348 349 350 351 352 353 354 355
        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
356
        sorted_users = sorted(self.users, key=COMPARE_USERS_LAST_TALKED, reverse=True)
mathieui's avatar
mathieui committed
357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373
        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)

374
    @refresh_wrapper.conditional
375
    def set_nick_color(self, nick: str, color: str) -> bool:
376 377 378 379 380 381 382 383
        "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
384 385
                self.core.information('Color for nick %s unset' % (nick),
                                      'Info')
386 387 388 389 390 391
        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
392
            nick_color_aliases = config.get_by_tabname('nick_color_aliases',
393
                                                       self.jid.bare)
394 395 396 397 398 399 400 401 402 403 404
            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
405

mathieui's avatar
mathieui committed
406 407 408 409 410 411
    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
412 413 414
        empty_after = empty_after or (
            self.input.get_text().startswith('/')
            and not self.input.get_text().startswith('//'))
mathieui's avatar
mathieui committed
415 416
        self.send_composing_chat_state(empty_after)
        return False
417

418
    def get_nick(self) -> str:
419
        if config.get('show_muc_jid'):
420 421
            return self.jid.bare
        bookmark = self.core.bookmarks[self.jid.bare]
422 423 424
        if bookmark is not None and bookmark.name:
            return bookmark.name
        # TODO: send the disco#info identity name here, if it exists.
425
        return self.jid.user
426

mathieui's avatar
mathieui committed
427 428
    def get_text_window(self):
        return self.text_win
429

mathieui's avatar
mathieui committed
430 431 432 433
    def on_lose_focus(self):
        if self.joined:
            if self.input.text:
                self.state = 'nonempty'
434 435
            elif self.lagged:
                self.state = 'disconnected'
mathieui's avatar
mathieui committed
436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451
            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
452 453
        if self.joined and config.get_by_tabname(
                'send_chat_states',
mathieui's avatar
mathieui committed
454 455 456 457
                self.general_jid) and not self.input.get_text():
            self.send_chat_state('active')

    def handle_presence(self, presence):
458
        """
mathieui's avatar
mathieui committed
459
        Handle MUC presence
460
        """
461
        self.reset_lag()
mathieui's avatar
mathieui committed
462 463 464
        status_codes = set()
        for status_code in presence.xml.findall(STATUS_XPATH):
            status_codes.add(status_code.attrib['code'])
mathieui's avatar
mathieui committed
465
        if presence['type'] == 'error':
466
            self.core.room_error(presence, self.jid.bare)
mathieui's avatar
mathieui committed
467
        elif not self.joined:
468
            own = '110' in status_codes
469 470
            if own or len(self.presence_buffer) >= 10:
                self.process_presence_buffer(presence, own)
mathieui's avatar
mathieui committed
471 472 473 474 475 476 477 478
            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)
479
        if self.core.tabs.current_tab is self:
mathieui's avatar
mathieui committed
480 481
            self.text_win.refresh()
            self.user_win.refresh_if_changed(self.users)
482 483 484
            self.info_header.refresh(
                self, self.text_win, user=self.own_user,
                information=MucTab.additional_information)
mathieui's avatar
mathieui committed
485 486
            self.input.refresh()
            self.core.doupdate()
487

488
    def process_presence_buffer(self, last_presence, own):
489
        """
mathieui's avatar
mathieui committed
490
        Batch-process all the initial presences
491
        """
mathieui's avatar
mathieui committed
492
        deterministic = config.get_by_tabname('deterministic_nick_colors',
493
                                              self.jid.bare)
mathieui's avatar
mathieui committed
494

mathieui's avatar
mathieui committed
495 496 497 498 499
        for stanza in self.presence_buffer:
            try:
                self.handle_presence_unjoined(stanza, deterministic)
            except PresenceError:
                self.core.room_error(stanza, stanza['from'].bare)
500 501
        self.presence_buffer = []
        self.handle_presence_unjoined(last_presence, deterministic, own)
mathieui's avatar
mathieui committed
502 503 504
        self.users.sort()
        # Enable the self ping event, to regularly check if we
        # are still in the room.
505 506
        if own:
            self.enable_self_ping_event()
507
        if self.core.tabs.current_tab is not self:
mathieui's avatar
mathieui committed
508
            self.refresh_tab_win()
509
            self.core.tabs.current_tab.refresh_input()
mathieui's avatar
mathieui committed
510
            self.core.doupdate()
511

mathieui's avatar
mathieui committed
512 513 514 515
    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
516
        from_nick, _, affiliation, show, status, role, jid, typ = dissect_presence(
mathieui's avatar
mathieui committed
517
            presence)
518 519
        if typ == 'unavailable':
            return
mathieui's avatar
mathieui committed
520
        user_color = self.search_for_color(from_nick)
mathieui's avatar
mathieui committed
521 522
        new_user = User(from_nick, affiliation, show, status, role, jid,
                        deterministic, user_color)
mathieui's avatar
mathieui committed
523 524 525 526 527 528 529
        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)
530

531
    def own_join(self, from_nick: str, new_user: User, status_codes: Set[str]):
532
        """
mathieui's avatar
mathieui committed
533
        Handle the last presence we received, entering the room
534
        """
mathieui's avatar
mathieui committed
535 536 537
        self.own_nick = from_nick
        self.own_user = new_user
        self.joined = True
538 539
        if self.jid.bare in self.core.initial_joins:
            self.core.initial_joins.remove(self.jid.bare)
mathieui's avatar
mathieui committed
540
            self._state = 'normal'
541
        elif self != self.core.tabs.current_tab:
mathieui's avatar
mathieui committed
542
            self._state = 'joined'
543
        if (self.core.tabs.current_tab is self
mathieui's avatar
mathieui committed
544 545
                and self.core.status.show not in ('xa', 'away')):
            self.send_chat_state('active')
546 547
        theme = get_theme()
        new_user.color = theme.COLOR_OWN_NICK
548

mathieui's avatar
mathieui committed
549 550 551 552
        if config.get_by_tabname('display_user_color_in_join_part',
                                 self.general_jid):
            color = dump_tuple(new_user.color)
        else:
553
            color = "3"
554

555 556 557
        info_col = dump_tuple(theme.COLOR_INFORMATION_TEXT)
        warn_col = dump_tuple(theme.COLOR_WARNING_TEXT)
        spec_col = dump_tuple(theme.COLOR_JOIN_CHAR)
mathieui's avatar
mathieui committed
558 559 560 561
        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,
562
                              'spec': theme.CHAR_JOIN,
mathieui's avatar
mathieui committed
563 564 565 566
                              'color_spec': spec_col,
                              'nick_col': color,
                              'info_col': info_col,
                          }
567
        self.add_message(InfoMessage(enable_message), typ=2)
568
        self.core.enable_private_tabs(self.jid.bare, enable_message)
mathieui's avatar
mathieui committed
569 570
        if '201' in status_codes:
            self.add_message(
571 572 573
                InfoMessage('Info: The room has been created'),
                typ=0
            )
mathieui's avatar
mathieui committed
574 575
        if '170' in status_codes:
            self.add_message(
576 577 578 579 580 581 582
                InfoMessage(
                    '\x19%(warn_col)s}Warning:\x19%(info_col)s}'
                    ' This room is publicly logged' % {
                        'info_col': info_col,
                        'warn_col': warn_col
                    },
                ),
mathieui's avatar
mathieui committed
583 584 585
                typ=0)
        if '100' in status_codes:
            self.add_message(
586 587 588 589 590 591 592
                InfoMessage(
                    '\x19%(warn_col)s}Warning:\x19%(info_col)s}'
                    ' This room is not anonymous.' % {
                        'info_col': info_col,
                        'warn_col': warn_col
                    },
                ),
mathieui's avatar
mathieui committed
593
                typ=0)
594

mathieui's avatar
mathieui committed
595
    def handle_presence_joined(self, presence, status_codes):
596
        """
mathieui's avatar
mathieui committed
597
        Handle new presences when we are already in the room
598
        """
mathieui's avatar
mathieui committed
599 600
        from_nick, from_room, affiliation, show, status, role, jid, typ = dissect_presence(
            presence)
mathieui's avatar
mathieui committed
601 602 603 604
        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'
605
        server_initiated = '333' in status_codes and typ == 'unavailable'
mathieui's avatar
mathieui committed
606 607 608 609 610 611
        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
612 613
            self.on_user_join(from_nick, affiliation, show, status, role, jid,
                              user_color)
mathieui's avatar
mathieui committed
614
        elif user is None:
615
            log.error('BUG: User %s in %s is None', from_nick, self.jid.bare)
mathieui's avatar
mathieui committed
616 617 618 619 620 621
            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
622 623
            self.core.on_user_left_private_conversation(
                from_room, user, status)
mathieui's avatar
mathieui committed
624
            self.on_user_banned(presence, user, from_nick)
625
        elif kick and not server_initiated:
mathieui's avatar
mathieui committed
626
            self.core.events.trigger('muc_kick', presence, self)
mathieui's avatar
mathieui committed
627 628
            self.core.on_user_left_private_conversation(
                from_room, user, status)
mathieui's avatar
mathieui committed
629 630 631 632 633 634 635 636 637
            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
638
            self.on_user_leave_groupchat(user, jid, status, from_nick,
639
                                         from_room, server_initiated)
mathieui's avatar
mathieui committed
640
        # status change
641
        else:
mathieui's avatar
mathieui committed
642 643
            self.on_user_change_status(user, from_nick, from_room, affiliation,
                                       role, show, status)
644

mathieui's avatar
mathieui committed
645 646 647
    def on_non_member_kicked(self):
        """We have been kicked because the MUC is members-only"""
        self.add_message(
648 649 650 651
            InfoMessage(
                'You have been kicked because you '
                'are not a member and the room is now members-only.'
            ),
mathieui's avatar
mathieui committed
652 653 654 655 656 657
            typ=2)
        self.disconnect()

    def on_muc_shutdown(self):
        """We have been kicked because the MUC service is shutting down"""
        self.add_message(
658 659 660 661
            InfoMessage(
                'You have been kicked because the'
                ' MUC service is shutting down.'
            ),
mathieui's avatar
mathieui committed
662 663 664
            typ=2)
        self.disconnect()

mathieui's avatar
mathieui committed
665 666
    def on_user_join(self, from_nick, affiliation, show, status, role, jid,
                     color):
667
        """
mathieui's avatar
mathieui committed
668
        When a new user joins the groupchat
669
        """
mathieui's avatar
mathieui committed
670
        deterministic = config.get_by_tabname('deterministic_nick_colors',
671
                                              self.jid.bare)
mathieui's avatar
mathieui committed
672 673
        user = User(from_nick, affiliation, show, status, role, jid,
                    deterministic, color)
mathieui's avatar
mathieui committed
674 675 676 677 678 679 680 681 682
        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
683 684 685 686
            theme = get_theme()
            info_col = dump_tuple(theme.COLOR_INFORMATION_TEXT)
            spec_col = dump_tuple(theme.COLOR_JOIN_CHAR)
            char_join = theme.CHAR_JOIN
mathieui's avatar
mathieui committed
687 688 689
            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
690 691 692 693 694 695
                           'nick': from_nick,
                           'spec': char_join,
                           'color': color,
                           'info_col': info_col,
                           'color_spec': spec_col,
                       }
mathieui's avatar
mathieui committed
696 697 698 699
            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
700 701 702 703 704
                           'spec': char_join,
                           'nick': from_nick,
                           'color': color,
                           'jid': jid.full,
                           'info_col': info_col,
705
                           'jid_color': dump_tuple(theme.COLOR_MUC_JID),
mathieui's avatar
mathieui committed
706 707
                           'color_spec': spec_col,
                       }
708
            self.add_message(InfoMessage(msg), typ=2)
709
        self.core.on_user_rejoined_private_conversation(self.jid.bare, from_nick)
mathieui's avatar
mathieui committed
710 711

    def on_user_nick_change(self, presence, user, from_nick, from_room):
mathieui's avatar
mathieui committed
712 713
        new_nick = presence.xml.find(
            '{%s}x/{%s}item' % (NS_MUC_USER, NS_MUC_USER)).attrib['nick']
714
        old_color = user.color
mathieui's avatar
mathieui committed
715 716 717 718
        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)
719
            user.change_nick(new_nick)
720
        else:
721
            user.change_nick(new_nick)
mathieui's avatar
mathieui committed
722
            deterministic = config.get_by_tabname('deterministic_nick_colors',
723
                                                  self.jid.bare)
724 725
            color = config.get_by_tabname(new_nick, 'muc_colors') or None
            if color or deterministic:
mathieui's avatar
mathieui committed
726 727 728
                user.change_color(color, deterministic)
        self.users.remove(user)
        bisect.insort_left(self.users, user)
729

mathieui's avatar
mathieui committed
730 731 732
        if config.get_by_tabname('display_user_color_in_join_part',
                                 self.general_jid):
            color = dump_tuple(user.color)
733
            old_color = dump_tuple(old_color)
734
        else:
735
            old_color = color = 3
mathieui's avatar
mathieui committed
736
        info_col = dump_tuple(get_theme().COLOR_INFORMATION_TEXT)
mathieui's avatar
mathieui committed
737
        self.add_message(
738 739 740 741 742 743 744 745 746 747
            InfoMessage(
                '\x19%(old_color)s}%(old)s\x19%(info_col)s} is'
                ' now known as \x19%(color)s}%(new)s' % {
                    'old': from_nick,
                    'new': new_nick,
                    'color': color,
                    'old_color': old_color,
                    'info_col': info_col
                },
            ),
mathieui's avatar
mathieui committed
748
            typ=2)
mathieui's avatar
mathieui committed
749
        # rename the private tabs if needed
750
        self.core.rename_private_tabs(self.jid.bare, from_nick, user)
751

mathieui's avatar
mathieui committed
752
    def on_user_banned(self, presence, user, from_nick):
753
        """
mathieui's avatar
mathieui committed
754
        When someone is banned from a muc
755
        """
mathieui's avatar
mathieui committed
756 757 758 759 760 761 762 763 764
        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
765

766 767 768
        theme = get_theme()
        info_col = dump_tuple(theme.COLOR_INFORMATION_TEXT)
        char_kick = theme.CHAR_KICK
769

mathieui's avatar
mathieui committed
770
        if from_nick == self.own_nick:  # we are banned
mathieui's avatar
mathieui committed
771 772 773
            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
774 775 776 777
                                'spec': char_kick,
                                'by': by,
                                'info_col': info_col
                            }
mathieui's avatar
mathieui committed
778 779 780
            else:
                kick_msg = ('\x191}%(spec)s \x193}You\x19'
                            '%(info_col)s} have been banned.') % {
mathieui's avatar
mathieui committed
781 782 783
                                'spec': char_kick,
                                'info_col': info_col
                            }
784
            self.core.disable_private_tabs(self.jid.bare, reason=kick_msg)
mathieui's avatar
mathieui committed
785 786
            self.disconnect()
            self.refresh_tab_win()
787
            self.core.tabs.current_tab.refresh_input()
mathieui's avatar
mathieui committed
788 789 790 791 792
            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:
793
                    muc.join_groupchat(self.core, self.jid.bare, self.own_nick)
mathieui's avatar
mathieui committed
794
                else:
mathieui's avatar
mathieui committed
795 796
                    self.core.add_timed_event(
                        timed_events.DelayedEvent(delay, muc.join_groupchat,
797
                                                  self.core, self.jid.bare,
mathieui's avatar
mathieui committed
798
                                                  self.own_nick))
799

mathieui's avatar
mathieui committed
800 801 802 803 804 805 806 807 808 809 810
        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
811 812 813 814 815 816
                                'spec': char_kick,
                                'nick': from_nick,
                                'color': color,
                                'by': by,
                                'info_col': info_col
                            }
mathieui's avatar
mathieui committed
817 818 819
            else:
                kick_msg = ('\x191}%(spec)s \x19%(color)s}%(nick)s'
                            '\x19%(info_col)s} has been banned') % {
mathieui's avatar
mathieui committed
820 821 822 823 824
                                'spec': char_kick,
                                'nick': from_nick,
                                'color': color,
                                'info_col': info_col
                            }
mathieui's avatar
mathieui committed
825 826 827
        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
828 829 830
                             'reason': reason.text,
                             'info_col': info_col
                         }
831
        self.add_message(InfoMessage(kick_msg), typ=2)
mathieui's avatar
mathieui committed
832 833

    def on_user_kicked(self, presence, user, from_nick):
834
        """
mathieui's avatar
mathieui committed
835
        When someone is kicked from a muc
836
        """
mathieui's avatar
mathieui committed
837 838 839 840 841 842
        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
843 844 845
        theme = get_theme()
        info_col = dump_tuple(theme.COLOR_INFORMATION_TEXT)
        char_kick = theme.CHAR_KICK
mathieui's avatar
mathieui committed
846 847
        if actor_elem is not None:
            by = actor_elem.get('nick') or actor_elem.get('jid')
mathieui's avatar
mathieui committed
848
        if from_nick == self.own_nick:  # we are kicked
mathieui's avatar
mathieui committed
849 850 851 852
            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
853 854 855 856
                                'spec': char_kick,
                                'by': by,
                                'info_col': info_col
                            }
mathieui's avatar
mathieui committed
857 858 859
            else:
                kick_msg = ('\x191}%(spec)s \x193}You\x19%(info_col)s}'
                            ' have been kicked.') % {
mathieui's avatar
mathieui committed
860 861 862
                                'spec': char_kick,
                                'info_col': info_col
                            }
863
            self.core.disable_private_tabs(self.jid.bare, reason=kick_msg)
mathieui's avatar
mathieui committed
864 865
            self.disconnect()
            self.refresh_tab_win()
866
            self.core.tabs.current_tab.refresh_input()
mathieui's avatar
mathieui committed
867 868 869 870 871 872
            # 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:
873
                    muc.join_groupchat(self.core, self.jid.bare, self.own_nick)
mathieui's avatar
mathieui committed
874
                else:
mathieui's avatar
mathieui committed
875 876
                    self.core.add_timed_event(
                        timed_events.DelayedEvent(delay, muc.join_groupchat,
877
                                                  self.core, self.jid.bare,
mathieui's avatar
mathieui committed
878
                                                  self.own_nick))
mathieui's avatar
mathieui committed
879 880 881 882 883 884 885 886 887 888
        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
889 890 891 892 893 894
                                'spec': char_kick,
                                'nick': from_nick,
                                'color': color,
                                'by': by,
                                'info_col': info_col
                            }
mathieui's avatar
mathieui committed
895 896 897
            else:
                kick_msg = ('\x191}%(spec)s \x19%(color)s}%(nick)s'
                            '\x19%(info_col)s} has been kicked') % {
mathieui's avatar
mathieui committed
898 899 900 901 902
                                'spec': char_kick,
                                'nick': from_nick,
                                'color': color,
                                'info_col': info_col
                            }
mathieui's avatar
mathieui committed
903 904 905
        if reason is not None and reason.text:
            kick_msg += ('\x19%(info_col)s} Reason: \x196}'
                         '%(reason)s') % {
mathieui's avatar
mathieui committed
906 907 908
                             'reason': reason.text,
                             'info_col': info_col
                         }
909
        self.add_message(InfoMessage(kick_msg), typ=2)
mathieui's avatar
mathieui committed
910

mathieui's avatar
mathieui committed
911
    def on_user_leave_groupchat(self,
912 913 914 915 916
                                user: User,
                                jid: JID,
                                status: str,
                                from_nick: str,
                                from_room: JID,
917
                                server_initiated=False):
mathieui's avatar
mathieui committed
918
        """
Maxime Buquet's avatar
Maxime Buquet committed
919
        When a user leaves a groupchat
mathieui's avatar
mathieui committed
920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937
        """
        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
938 939 940
            theme = get_theme()
            info_col = dump_tuple(theme.COLOR_INFORMATION_TEXT)
            spec_col = dump_tuple(theme.COLOR_QUIT_CHAR)
mathieui's avatar
mathieui committed