muctab.py 79 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
17
from copy import copy
mathieui's avatar
mathieui committed
18
from datetime import datetime
19
from typing import Dict, Callable, List, Optional, Union, Set
20

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

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

41 42
log = logging.getLogger(__name__)

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

46 47
COMPARE_USERS_LAST_TALKED = lambda x: x.last_talked

48 49 50 51

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

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

    @property
    def general_jid(self):
99
        return self.jid
100

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

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

112
    @staticmethod
113
    @refresh_wrapper.always
114 115 116 117 118 119 120
    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
121
    @refresh_wrapper.always
122 123 124 125 126 127
    def remove_information_element(plugin_name: str) -> None:
        """
        Lets a plugin add its own information to the MucInfoWin
        """
        del MucTab.additional_information[plugin_name]

128 129
    def cancel_config(self, form):
        """
Kim Alvefur's avatar
Kim Alvefur committed
130
        The user do not want to send their config, send an iq cancel
131
        """
132
        muc.cancel_config(self.core.xmpp, self.jid.bare)
133 134 135 136
        self.core.close_tab()

    def send_config(self, form):
        """
Kim Alvefur's avatar
Kim Alvefur committed
137
        The user sends their config to the server
138
        """
139
        muc.configure_room(self.core.xmpp, self.jid.bare, form)
140 141
        self.core.close_tab()

142 143 144 145 146 147 148 149 150
    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:
151
            seconds = None
mathieui's avatar
mathieui committed
152 153
        muc.join_groupchat(
            self.core,
154
            self.jid.bare,
mathieui's avatar
mathieui committed
155 156 157 158 159
            self.own_nick,
            self.password,
            status=status.message,
            show=status.show,
            seconds=seconds)
160
        mam.mam_scroll(self, action='query')
161

162
    def leave_room(self, message: str):
mathieui's avatar
mathieui committed
163
        if self.joined:
164 165 166 167
            theme = get_theme()
            info_col = dump_tuple(theme.COLOR_INFORMATION_TEXT)
            char_quit = theme.CHAR_QUIT
            spec_col = dump_tuple(theme.COLOR_QUIT_CHAR)
168

169 170
            if config.get_by_tabname('display_user_color_in_join_part',
                                     self.general_jid):
171
                color = dump_tuple(theme.COLOR_OWN_NICK)
172
            else:
173
                color = "3"
174

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

198
            self.add_message(msg, typ=2)
199
            self.disconnect()
200
            muc.leave_groupchat(self.core.xmpp, self.jid.bare, self.own_nick,
mathieui's avatar
mathieui committed
201
                                message)
202
            self.core.disable_private_tabs(self.jid.bare, reason=msg)
203
        else:
204
            muc.leave_groupchat(self.core.xmpp, self.jid.bare, self.own_nick,
mathieui's avatar
mathieui committed
205
                                message)
mathieui's avatar
mathieui committed
206

207 208 209 210
    def change_affiliation(self,
                           nick_or_jid: Union[str, JID],
                           affiliation: str,
                           reason=''):
211 212 213
        """
        Change the affiliation of a nick or JID
        """
mathieui's avatar
mathieui committed
214

215 216
        def callback(iq):
            if iq['type'] == 'error':
mathieui's avatar
mathieui committed
217 218 219 220
                self.core.information(
                    "Could not set affiliation '%s' for '%s'." %
                    (affiliation, nick_or_jid), "Warning")

221 222 223 224 225
        if not self.joined:
            return

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

246
    def change_role(self, nick: str, role: str, reason=''):
247 248 249
        """
        Change the role of a nick
        """
mathieui's avatar
mathieui committed
250

251 252
        def callback(iq):
            if iq['type'] == 'error':
mathieui's avatar
mathieui committed
253 254 255
                self.core.information(
                    "Could not set role '%s' for '%s'." % (role, nick),
                    "Warning")
mathieui's avatar
mathieui committed
256

257 258 259
        valid_roles = ('none', 'visitor', 'participant', 'moderator')

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

263 264 265 266
        try:
            target_jid = copy(self.jid)
            target_jid.resource = nick
        except InvalidJID:
267
            return self.core.information('Invalid nick', 'Info')
268

mathieui's avatar
mathieui committed
269
        muc.set_user_role(
270
            self.core.xmpp, self.jid.bare, nick, reason, role, callback=callback)
271

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

304
    def change_topic(self, topic: str):
mathieui's avatar
mathieui committed
305
        """Change the current topic"""
306
        muc.change_subject(self.core.xmpp, self.jid.bare, topic)
mathieui's avatar
mathieui committed
307 308 309 310 311 312

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

        self._text_buffer.add_message(
mathieui's avatar
mathieui committed
328 329
            "\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
330

mathieui's avatar
mathieui committed
331 332 333
    @refresh_wrapper.always
    def recolor(self, random_colors=False):
        """Recolor the current MUC users"""
mathieui's avatar
mathieui committed
334
        deterministic = config.get_by_tabname('deterministic_nick_colors',
335
                                              self.jid.bare)
mathieui's avatar
mathieui committed
336 337 338 339 340 341 342 343 344 345 346
        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
347
        sorted_users = sorted(self.users, key=COMPARE_USERS_LAST_TALKED, reverse=True)
mathieui's avatar
mathieui committed
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364
        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)

365
    @refresh_wrapper.conditional
366
    def set_nick_color(self, nick: str, color: str) -> bool:
367 368 369 370 371 372 373 374
        "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
375 376
                self.core.information('Color for nick %s unset' % (nick),
                                      'Info')
377 378 379 380 381 382
        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
383
            nick_color_aliases = config.get_by_tabname('nick_color_aliases',
384
                                                       self.jid.bare)
385 386 387 388 389 390 391 392 393 394 395
            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
396

mathieui's avatar
mathieui committed
397 398 399 400 401 402
    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
403 404 405
        empty_after = empty_after or (
            self.input.get_text().startswith('/')
            and not self.input.get_text().startswith('//'))
mathieui's avatar
mathieui committed
406 407
        self.send_composing_chat_state(empty_after)
        return False
408

409
    def get_nick(self) -> str:
410
        if config.get('show_muc_jid'):
411 412
            return self.jid.bare
        bookmark = self.core.bookmarks[self.jid.bare]
413 414 415
        if bookmark is not None and bookmark.name:
            return bookmark.name
        # TODO: send the disco#info identity name here, if it exists.
416
        return self.jid.user
417

mathieui's avatar
mathieui committed
418 419
    def get_text_window(self):
        return self.text_win
420

mathieui's avatar
mathieui committed
421 422 423 424
    def on_lose_focus(self):
        if self.joined:
            if self.input.text:
                self.state = 'nonempty'
425 426
            elif self.lagged:
                self.state = 'disconnected'
mathieui's avatar
mathieui committed
427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
            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
443 444
        if self.joined and config.get_by_tabname(
                'send_chat_states',
mathieui's avatar
mathieui committed
445 446 447 448
                self.general_jid) and not self.input.get_text():
            self.send_chat_state('active')

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

479
    def process_presence_buffer(self, last_presence, own):
480
        """
mathieui's avatar
mathieui committed
481
        Batch-process all the initial presences
482
        """
mathieui's avatar
mathieui committed
483
        deterministic = config.get_by_tabname('deterministic_nick_colors',
484
                                              self.jid.bare)
mathieui's avatar
mathieui committed
485

mathieui's avatar
mathieui committed
486 487 488 489 490
        for stanza in self.presence_buffer:
            try:
                self.handle_presence_unjoined(stanza, deterministic)
            except PresenceError:
                self.core.room_error(stanza, stanza['from'].bare)
491 492
        self.presence_buffer = []
        self.handle_presence_unjoined(last_presence, deterministic, own)
mathieui's avatar
mathieui committed
493 494 495
        self.users.sort()
        # Enable the self ping event, to regularly check if we
        # are still in the room.
496 497
        if own:
            self.enable_self_ping_event()
498
        if self.core.tabs.current_tab is not self:
mathieui's avatar
mathieui committed
499
            self.refresh_tab_win()
500
            self.core.tabs.current_tab.refresh_input()
mathieui's avatar
mathieui committed
501
            self.core.doupdate()
502

mathieui's avatar
mathieui committed
503 504 505 506
    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
507
        from_nick, _, affiliation, show, status, role, jid, typ = dissect_presence(
mathieui's avatar
mathieui committed
508
            presence)
509 510
        if typ == 'unavailable':
            return
mathieui's avatar
mathieui committed
511
        user_color = self.search_for_color(from_nick)
mathieui's avatar
mathieui committed
512 513
        new_user = User(from_nick, affiliation, show, status, role, jid,
                        deterministic, user_color)
mathieui's avatar
mathieui committed
514 515 516 517 518 519 520
        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)
521

522
    def own_join(self, from_nick: str, new_user: User, status_codes: Set[str]):
523
        """
mathieui's avatar
mathieui committed
524
        Handle the last presence we received, entering the room
525
        """
mathieui's avatar
mathieui committed
526 527 528
        self.own_nick = from_nick
        self.own_user = new_user
        self.joined = True
529 530
        if self.jid.bare in self.core.initial_joins:
            self.core.initial_joins.remove(self.jid.bare)
mathieui's avatar
mathieui committed
531
            self._state = 'normal'
532
        elif self != self.core.tabs.current_tab:
mathieui's avatar
mathieui committed
533
            self._state = 'joined'
534
        if (self.core.tabs.current_tab is self
mathieui's avatar
mathieui committed
535 536
                and self.core.status.show not in ('xa', 'away')):
            self.send_chat_state('active')
537 538
        theme = get_theme()
        new_user.color = theme.COLOR_OWN_NICK
539

mathieui's avatar
mathieui committed
540 541 542 543
        if config.get_by_tabname('display_user_color_in_join_part',
                                 self.general_jid):
            color = dump_tuple(new_user.color)
        else:
544
            color = "3"
545

546 547 548
        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
549 550 551 552
        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,
553
                              'spec': theme.CHAR_JOIN,
mathieui's avatar
mathieui committed
554 555 556 557
                              'color_spec': spec_col,
                              'nick_col': color,
                              'info_col': info_col,
                          }
mathieui's avatar
mathieui committed
558
        self.add_message(enable_message, typ=2)
559
        self.core.enable_private_tabs(self.jid.bare, enable_message)
mathieui's avatar
mathieui committed
560 561
        if '201' in status_codes:
            self.add_message(
mathieui's avatar
mathieui committed
562 563
                '\x19%(info_col)s}Info: The room '
                'has been created' % {'info_col': info_col},
mathieui's avatar
mathieui committed
564 565 566
                typ=0)
        if '170' in status_codes:
            self.add_message(
mathieui's avatar
mathieui committed
567
                '\x19%(warn_col)s}Warning:\x19%(info_col)s}'
mathieui's avatar
mathieui committed
568 569 570 571
                ' This room is publicly logged' % {
                    'info_col': info_col,
                    'warn_col': warn_col
                },
mathieui's avatar
mathieui committed
572 573 574
                typ=0)
        if '100' in status_codes:
            self.add_message(
mathieui's avatar
mathieui committed
575
                '\x19%(warn_col)s}Warning:\x19%(info_col)s}'
mathieui's avatar
mathieui committed
576 577 578 579
                ' This room is not anonymous.' % {
                    'info_col': info_col,
                    'warn_col': warn_col
                },
mathieui's avatar
mathieui committed
580
                typ=0)
581

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

mathieui's avatar
mathieui committed
632 633 634
    def on_non_member_kicked(self):
        """We have been kicked because the MUC is members-only"""
        self.add_message(
mathieui's avatar
mathieui committed
635 636 637
            '\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
638 639 640 641 642 643
            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
644 645 646
            '\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
647 648 649
            typ=2)
        self.disconnect()

mathieui's avatar
mathieui committed
650 651
    def on_user_join(self, from_nick, affiliation, show, status, role, jid,
                     color):
652
        """
mathieui's avatar
mathieui committed
653
        When a new user joins the groupchat
654
        """
mathieui's avatar
mathieui committed
655
        deterministic = config.get_by_tabname('deterministic_nick_colors',
656
                                              self.jid.bare)
mathieui's avatar
mathieui committed
657 658
        user = User(from_nick, affiliation, show, status, role, jid,
                    deterministic, color)
mathieui's avatar
mathieui committed
659 660 661 662 663 664 665 666 667
        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
668 669 670 671
            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
672 673 674
            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
675 676 677 678 679 680
                           'nick': from_nick,
                           'spec': char_join,
                           'color': color,
                           'info_col': info_col,
                           'color_spec': spec_col,
                       }
mathieui's avatar
mathieui committed
681 682 683 684
            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
685 686 687 688 689
                           'spec': char_join,
                           'nick': from_nick,
                           'color': color,
                           'jid': jid.full,
                           'info_col': info_col,
690
                           'jid_color': dump_tuple(theme.COLOR_MUC_JID),
mathieui's avatar
mathieui committed
691 692
                           'color_spec': spec_col,
                       }
mathieui's avatar
mathieui committed
693
            self.add_message(msg, typ=2)
694
        self.core.on_user_rejoined_private_conversation(self.jid.bare, from_nick)
mathieui's avatar
mathieui committed
695 696

    def on_user_nick_change(self, presence, user, from_nick, from_room):
mathieui's avatar
mathieui committed
697 698
        new_nick = presence.xml.find(
            '{%s}x/{%s}item' % (NS_MUC_USER, NS_MUC_USER)).attrib['nick']
699
        old_color = user.color
mathieui's avatar
mathieui committed
700 701 702 703
        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)
704
            user.change_nick(new_nick)
705
        else:
706
            user.change_nick(new_nick)
mathieui's avatar
mathieui committed
707
            deterministic = config.get_by_tabname('deterministic_nick_colors',
708
                                                  self.jid.bare)
709 710
            color = config.get_by_tabname(new_nick, 'muc_colors') or None
            if color or deterministic:
mathieui's avatar
mathieui committed
711 712 713
                user.change_color(color, deterministic)
        self.users.remove(user)
        bisect.insort_left(self.users, user)
714

mathieui's avatar
mathieui committed
715 716 717
        if config.get_by_tabname('display_user_color_in_join_part',
                                 self.general_jid):
            color = dump_tuple(user.color)
718
            old_color = dump_tuple(old_color)
719
        else:
720
            old_color = color = 3
mathieui's avatar
mathieui committed
721
        info_col = dump_tuple(get_theme().COLOR_INFORMATION_TEXT)
mathieui's avatar
mathieui committed
722
        self.add_message(
723
            '\x19%(old_color)s}%(old)s\x19%(info_col)s} is'
mathieui's avatar
mathieui committed
724 725 726 727
            ' now known as \x19%(color)s}%(new)s' % {
                'old': from_nick,
                'new': new_nick,
                'color': color,
728
                'old_color': old_color,
mathieui's avatar
mathieui committed
729 730 731
                'info_col': info_col
            },
            typ=2)
mathieui's avatar
mathieui committed
732
        # rename the private tabs if needed
733
        self.core.rename_private_tabs(self.jid.bare, from_nick, user)
734

mathieui's avatar
mathieui committed
735
    def on_user_banned(self, presence, user, from_nick):
736
        """
mathieui's avatar
mathieui committed
737
        When someone is banned from a muc
738
        """
mathieui's avatar
mathieui committed
739 740 741 742 743 744 745 746 747
        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
748

749 750 751
        theme = get_theme()
        info_col = dump_tuple(theme.COLOR_INFORMATION_TEXT)
        char_kick = theme.CHAR_KICK
752

mathieui's avatar
mathieui committed
753
        if from_nick == self.own_nick:  # we are banned
mathieui's avatar
mathieui committed
754 755 756
            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
757 758 759 760
                                'spec': char_kick,
                                'by': by,
                                'info_col': info_col
                            }
mathieui's avatar
mathieui committed
761 762 763
            else:
                kick_msg = ('\x191}%(spec)s \x193}You\x19'
                            '%(info_col)s} have been banned.') % {
mathieui's avatar
mathieui committed
764 765 766
                                'spec': char_kick,
                                'info_col': info_col
                            }
767
            self.core.disable_private_tabs(self.jid.bare, reason=kick_msg)
mathieui's avatar
mathieui committed
768 769
            self.disconnect()
            self.refresh_tab_win()
770
            self.core.tabs.current_tab.refresh_input()
mathieui's avatar
mathieui committed
771 772 773 774 775
            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:
776
                    muc.join_groupchat(self.core, self.jid.bare, self.own_nick)
mathieui's avatar
mathieui committed
777
                else:
mathieui's avatar
mathieui committed
778 779
                    self.core.add_timed_event(
                        timed_events.DelayedEvent(delay, muc.join_groupchat,
780
                                                  self.core, self.jid.bare,
mathieui's avatar
mathieui committed
781
                                                  self.own_nick))
782

mathieui's avatar
mathieui committed
783 784 785 786 787 788 789 790 791 792 793
        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
794 795 796 797 798 799
                                'spec': char_kick,
                                'nick': from_nick,
                                'color': color,
                                'by': by,
                                'info_col': info_col
                            }
mathieui's avatar
mathieui committed
800 801 802
            else:
                kick_msg = ('\x191}%(spec)s \x19%(color)s}%(nick)s'
                            '\x19%(info_col)s} has been banned') % {
mathieui's avatar
mathieui committed
803 804 805 806 807
                                'spec': char_kick,
                                'nick': from_nick,
                                'color': color,
                                'info_col': info_col
                            }
mathieui's avatar
mathieui committed
808 809 810
        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
811 812 813
                             'reason': reason.text,
                             'info_col': info_col
                         }
mathieui's avatar
mathieui committed
814 815 816
        self.add_message(kick_msg, typ=2)

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

mathieui's avatar
mathieui committed
894
    def on_user_leave_groupchat(self,
895 896 897 898 899
                                user: User,
                                jid: JID,
                                status: str,
                                from_nick: str,
                                from_room: JID,
900
                                server_initiated=False):
mathieui's avatar
mathieui committed
901
        """
Maxime Buquet's avatar
Maxime Buquet committed
902
        When a user leaves a groupchat
mathieui's avatar
mathieui committed
903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920
        """
        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
921 922 923
            theme = get_theme()
            info_col = dump_tuple(theme.COLOR_INFORMATION_TEXT)
            spec_col = dump_tuple(theme.COLOR_QUIT_CHAR)
mathieui's avatar
mathieui committed
924

925 926 927 928
            error_leave_txt = ''
            if server_initiated:
                error_leave_txt = ' due to an error'

mathieui's avatar
mathieui committed
929 930 931
            if not jid.full:
                leave_msg = ('\x19%(color_spec)s}%(spec)s \x19%(color)s}'
                             '%(nick)s\x19%(info_col)s} has left the '
932
                             'room%(error_leave)s') % {
mathieui's avatar
mathieui committed
933 934
                                 'nick': from_nick,
                                 'color': color,
935
                                 'spec': theme.CHAR_QUIT,
mathieui's avatar