muctab.py 78.9 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 26 27 28 29 30 31
from poezio import common
from poezio import fixes
from poezio import multiuserchat as muc
from poezio import timed_events
from poezio import windows
from poezio import xhtml
from poezio.common import safeJID
from poezio.config import config
32
from poezio.core.structs import Command
33 34 35 36 37
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
38
from poezio.core.structs import Completion, Status
39

40 41
log = logging.getLogger(__name__)

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

45 46
COMPARE_USERS_LAST_TALKED = lambda x: x.last_talked

47 48 49 50

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

219 220 221 222 223
        if not self.joined:
            return

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

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

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

255 256 257
        valid_roles = ('none', 'visitor', 'participant', 'moderator')

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

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

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

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

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

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

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

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

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

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

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

mathieui's avatar
mathieui committed
416 417
    def get_text_window(self):
        return self.text_win
418

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

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

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

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

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

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

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

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

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

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

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

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

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

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

747 748 749
        theme = get_theme()
        info_col = dump_tuple(theme.COLOR_INFORMATION_TEXT)
        char_kick = theme.CHAR_KICK
750

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

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

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

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

923 924 925 926
            error_leave_txt = ''
            if server_initiated:
                error_leave_txt = ' due to an error'

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