privatetab.py 14.8 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12
"""
Module for the PrivateTab

A PrivateTab is a private conversation opened with someone from a MUC
(see muctab.py). The conversation happens with both JID being relative
to the MUC (room@server/nick1 and room@server/nick2).

This tab references his parent room, and is modified to keep track of
both participant’s nicks. It also has slightly different features than
the ConversationTab (such as tab-completion on nicks from the room).

"""
13
import curses
14 15
import logging
from typing import Dict, Callable
16
from xml.etree import cElementTree as ET
17

18 19
from slixmpp import JID

mathieui's avatar
mathieui committed
20
from poezio.tabs import OneToOneTab, MucTab, Tab
21

22 23 24
from poezio import windows
from poezio import xhtml
from poezio.config import config
25
from poezio.core.structs import Command
26 27 28 29
from poezio.decorators import refresh_wrapper
from poezio.logger import logger
from poezio.theming import get_theme, dump_tuple
from poezio.decorators import command_args_parser
30
from poezio.ui.types import BaseMessage, Message, InfoMessage
31

32 33
log = logging.getLogger(__name__)

Maxime Buquet's avatar
Maxime Buquet committed
34 35
NS_MUC_USER = 'http://jabber.org/protocol/muc#user'

mathieui's avatar
mathieui committed
36

37
class PrivateTab(OneToOneTab):
38
    """
39
    The tab containing a private conversation (someone from a MUC)
40
    """
41 42
    plugin_commands = {}  # type: Dict[str, Command]
    plugin_keys = {}  # type: Dict[str, Callable]
43
    message_type = 'chat'
44
    additional_information = {}  # type: Dict[str, Callable[[str], str]]
mathieui's avatar
mathieui committed
45

46 47
    def __init__(self, core, jid, nick):
        OneToOneTab.__init__(self, core, jid)
48 49 50 51 52 53
        self.own_nick = nick
        self.info_header = windows.PrivateInfoWin()
        self.input = windows.MessageInput()
        # keys
        self.key_func['^I'] = self.completion
        # commands
mathieui's avatar
mathieui committed
54 55 56 57
        self.register_command(
            'info',
            self.command_info,
            desc=
Kim Alvefur's avatar
Kim Alvefur committed
58
            'Display some information about the user in the MUC: their role, affiliation, status and status message.',
mathieui's avatar
mathieui committed
59 60 61 62 63 64 65
            shortdesc='Info about the user.')
        self.register_command(
            'version',
            self.command_version,
            desc=
            'Get the software version of the current interlocutor (usually its XMPP client and Operating System).',
            shortdesc='Get the software version of a jid.')
66
        self.resize()
67
        self.parent_muc = self.core.tabs.by_name_and_class(self.jid.bare, MucTab)
68 69 70 71
        self.on = True
        self.update_commands()
        self.update_keys()

72
    def remote_user_color(self):
73
        user = self.parent_muc.get_user_by_name(self.jid.resource)
74
        if user:
mathieui's avatar
mathieui committed
75
            return dump_tuple(user.color)
76 77
        return super().remote_user_color()

78 79
    @property
    def general_jid(self):
80
        return self.jid
81

82
    def get_dest_jid(self):
83
        return self.jid
84

85 86 87 88
    @property
    def nick(self):
        return self.get_nick()

89
    def ack_message(self, msg_id: str, msg_jid: JID):
mathieui's avatar
mathieui committed
90 91 92
        if JID(msg_jid).bare == self.core.xmpp.boundjid.bare:
            msg_jid = JID(self.jid.bare)
            msg_jid.resource = self.own_nick
93 94
        super().ack_message(msg_id, msg_jid)

95
    @staticmethod
96
    @refresh_wrapper.always
97 98 99 100
    def add_information_element(plugin_name, callback):
        """
        Lets a plugin add its own information to the PrivateInfoWin
        """
101
        PrivateTab.additional_information[plugin_name] = callback
102 103

    @staticmethod
104
    @refresh_wrapper.always
105
    def remove_information_element(plugin_name):
106
        del PrivateTab.additional_information[plugin_name]
107

108
    def log_message(self, msg: BaseMessage, typ=1):
109 110 111
        """
        Log the messages in the archives.
        """
112 113
        if not isinstance(msg, Message):
            return
mathieui's avatar
mathieui committed
114
        if not logger.log_message(
115
                self.jid.full, msg.nickname, msg.txt, date=msg.time, typ=typ):
116
            self.core.information('Unable to write in the log file', 'Error')
117 118

    def on_close(self):
119
        super().on_close()
120 121 122 123 124 125 126 127 128 129 130 131 132
        self.parent_muc.privates.remove(self)

    def completion(self):
        """
        Called when Tab is pressed, complete the nickname in the input
        """
        if self.complete_commands(self.input):
            return

        # If we are not completing a command or a command's argument, complete a nick
        compare_users = lambda x: x.last_talked
        word_list = [user.nick for user in sorted(self.parent_muc.users, key=compare_users, reverse=True)\
                         if user.nick != self.own_nick]
133
        after = config.get('after_completion') + ' '
134 135 136 137 138 139 140
        input_pos = self.input.pos
        if ' ' not in self.input.get_text()[:input_pos] or (self.input.last_completion and\
                     self.input.get_text()[:input_pos] == self.input.last_completion + after):
            add_after = after
        else:
            add_after = ''
        self.input.auto_completion(word_list, add_after, quotify=False)
mathieui's avatar
mathieui committed
141 142 143
        empty_after = self.input.get_text() == '' or (
            self.input.get_text().startswith('/')
            and not self.input.get_text().startswith('//'))
144 145
        self.send_composing_chat_state(empty_after)

146
    @refresh_wrapper.always
147
    @command_args_parser.raw
148
    def command_say(self, line: str, attention: bool = False, correct: bool = False) -> None:
149 150
        if not self.on:
            return
mathieui's avatar
mathieui committed
151 152
        our_jid = JID(self.jid.bare)
        our_jid.resource = self.own_nick
153 154
        msg = self.core.xmpp.make_message(
            mto=self.jid.full,
mathieui's avatar
mathieui committed
155
            mfrom=our_jid,
156
        )
157 158
        msg['type'] = 'chat'
        msg['body'] = line
Maxime Buquet's avatar
Maxime Buquet committed
159
        x = ET.Element('{%s}x' % NS_MUC_USER)
160
        msg.append(x)
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
        # trigger the event BEFORE looking for colors.
        # This lets a plugin insert \x19xxx} colors, that will
        # be converted in xhtml.
        self.core.events.trigger('private_say', msg, self)
        if not msg['body']:
            return
        if correct or msg['replace']['id']:
            msg['replace']['id'] = self.last_sent_message['id']
        else:
            del msg['replace']

        if msg['body'].find('\x19') != -1:
            msg.enable('html')
            msg['html']['body'] = xhtml.poezio_colors_to_html(msg['body'])
            msg['body'] = xhtml.clean_text(msg['body'])
176
        if config.get_by_tabname('send_chat_states', self.general_jid):
177 178
            needed = 'inactive' if self.inactive else 'active'
            msg['chat_state'] = needed
179
        if attention:
180 181 182 183
            msg['attention'] = True
        self.core.events.trigger('private_say_after', msg, self)
        if not msg['body']:
            return
Maxime Buquet's avatar
Maxime Buquet committed
184
        self.set_last_sent_message(msg, correct=correct)
mathieui's avatar
mathieui committed
185
        self.core.handler.on_groupchat_private_message(msg, sent=True)
186
        msg._add_receipt = True
187 188 189
        msg.send()
        self.cancel_paused_delay()

190 191
    @command_args_parser.quoted(0, 1)
    def command_version(self, args):
192 193 194
        """
        /version
        """
195
        if args:
196
            return self.core.command.version(args[0])
197
        jid = self.jid.full
198 199
        self.core.xmpp.plugin['xep_0092'].get_version(
            jid, callback=self.core.handler.on_version_result)
200

201
    @command_args_parser.quoted(0, 1)
202 203 204 205
    def command_info(self, arg):
        """
        /info
        """
mathieui's avatar
mathieui committed
206 207
        if arg and arg[0]:
            self.parent_muc.command_info(arg[0])
208
        else:
209
            user = self.jid.resource
210 211 212
            self.parent_muc.command_info(user)

    def resize(self):
213 214
        self.need_resize = False

215 216 217 218 219 220 221
        if self.size.tab_degrade_y:
            info_win_height = 0
            tab_win_height = 0
        else:
            info_win_height = self.core.information_win_size
            tab_win_height = Tab.tab_win_height()

mathieui's avatar
mathieui committed
222 223 224
        self.text_win.resize(
            self.height - 2 - info_win_height - tab_win_height, self.width, 0,
            0)
225
        self.text_win.rebuild_everything(self._text_buffer)
mathieui's avatar
mathieui committed
226 227 228 229
        self.info_header.resize(
            1, self.width, self.height - 2 - info_win_height - tab_win_height,
            0)
        self.input.resize(1, self.width, self.height - 1, 0)
230 231 232 233

    def refresh(self):
        if self.need_resize:
            self.resize()
234
        log.debug('  TAB   Refresh: %s', self.__class__.__name__)
235 236
        display_info_win = not self.size.tab_degrade_y

237
        self.text_win.refresh()
238
        self.info_header.refresh(self.jid.full, self.text_win, self.chatstate,
239
                                 PrivateTab.additional_information)
240 241 242
        if display_info_win:
            self.info_win.refresh()

243 244 245 246
        self.refresh_tab_win()
        self.input.refresh()

    def refresh_info_header(self):
247
        self.info_header.refresh(self.jid.full, self.text_win, self.chatstate,
mathieui's avatar
mathieui committed
248
                                 PrivateTab.additional_information)
249 250 251
        self.input.refresh()

    def get_nick(self):
252
        return self.jid.resource
253 254 255 256 257 258 259 260

    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)
        if not self.on:
            return False
mathieui's avatar
mathieui committed
261 262 263
        empty_after = self.input.get_text() == '' or (
            self.input.get_text().startswith('/')
            and not self.input.get_text().startswith('//'))
264
        tab = self.core.tabs.by_name_and_class(self.jid.bare, MucTab)
265 266 267 268 269
        if tab and tab.joined:
            self.send_composing_chat_state(empty_after)
        return False

    def on_lose_focus(self):
270 271 272 273 274
        if self.input.text:
            self.state = 'nonempty'
        else:
            self.state = 'normal'

275 276
        self.text_win.remove_line_separator()
        self.text_win.add_line_separator(self._text_buffer)
277
        tab = self.core.tabs.by_name_and_class(self.jid.bare, MucTab)
mathieui's avatar
mathieui committed
278 279
        if tab and tab.joined and config.get_by_tabname(
                'send_chat_states', self.general_jid) and self.on:
280 281 282 283 284 285
            self.send_chat_state('inactive')
        self.check_scrolled()

    def on_gain_focus(self):
        self.state = 'current'
        curses.curs_set(1)
286
        tab = self.core.tabs.by_name_and_class(self.jid.bare, MucTab)
mathieui's avatar
mathieui committed
287 288 289 290
        if tab and tab.joined and config.get_by_tabname(
                'send_chat_states',
                self.general_jid,
        ) and not self.input.get_text() and self.on:
291 292 293
            self.send_chat_state('active')

    def on_info_win_size_changed(self):
mathieui's avatar
mathieui committed
294
        if self.core.information_win_size >= self.height - 3:
295
            return
mathieui's avatar
mathieui committed
296 297 298
        self.text_win.resize(
            self.height - 2 - self.core.information_win_size -
            Tab.tab_win_height(), self.width, 0, 0)
mathieui's avatar
mathieui committed
299 300 301
        self.info_header.resize(
            1, self.width, self.height - 2 - self.core.information_win_size -
            Tab.tab_win_height(), 0)
302 303 304 305

    def get_text_window(self):
        return self.text_win

306
    @refresh_wrapper.conditional
307
    def rename_user(self, old_nick, user):
308 309 310 311
        """
        The user changed her nick in the corresponding muc: update the tab’s name and
        display a message.
        """
mathieui's avatar
mathieui committed
312
        self.add_message(
313 314 315 316 317 318 319 320 321
            InfoMessage(
                '\x19%(nick_col)s}%(old)s\x19%(info_col)s} is now '
                'known as \x19%(nick_col)s}%(new)s' % {
                    'old': old_nick,
                    'new': user.nick,
                    'nick_col': dump_tuple(user.color),
                    'info_col': dump_tuple(get_theme().COLOR_INFORMATION_TEXT)
                },
            ),
mathieui's avatar
mathieui committed
322
            typ=2)
323
        new_jid = self.jid.bare + '/' + user.nick
324
        self.name = new_jid
325
        return self.core.tabs.current_tab is self
326 327

    @refresh_wrapper.conditional
328
    def user_left(self, status_message, user):
329 330 331 332
        """
        The user left the associated MUC
        """
        self.deactivate()
333
        theme = get_theme()
mathieui's avatar
mathieui committed
334 335
        if config.get_by_tabname('display_user_color_in_join_part',
                                 self.general_jid):
336 337
            color = dump_tuple(user.color)
        else:
338
            color = dump_tuple(theme.COLOR_REMOTE_USER)
339

340
        if not status_message:
mathieui's avatar
mathieui committed
341
            self.add_message(
342 343 344 345 346 347 348 349 350 351
                InfoMessage(
                    '\x19%(quit_col)s}%(spec)s \x19%(nick_col)s}'
                    '%(nick)s\x19%(info_col)s} has left the room' % {
                        'nick': user.nick,
                        'spec': theme.CHAR_QUIT,
                        'nick_col': color,
                        'quit_col': dump_tuple(theme.COLOR_QUIT_CHAR),
                        'info_col': dump_tuple(theme.COLOR_INFORMATION_TEXT)
                    },
                ),
mathieui's avatar
mathieui committed
352
                typ=2)
353
        else:
mathieui's avatar
mathieui committed
354
            self.add_message(
355 356 357 358 359 360 361 362 363 364 365 366
                InfoMessage(
                    '\x19%(quit_col)s}%(spec)s \x19%(nick_col)s}'
                    '%(nick)s\x19%(info_col)s} has left the room'
                    ' (%(status)s)' % {
                        'status': status_message,
                        'nick': user.nick,
                        'spec': theme.CHAR_QUIT,
                        'nick_col': color,
                        'quit_col': dump_tuple(theme.COLOR_QUIT_CHAR),
                        'info_col': dump_tuple(theme.COLOR_INFORMATION_TEXT)
                    },
                ),
mathieui's avatar
mathieui committed
367
                typ=2)
368
        return self.core.tabs.current_tab is self
369 370 371 372 373 374 375

    @refresh_wrapper.conditional
    def user_rejoined(self, nick):
        """
        The user (or at least someone with the same nick) came back in the MUC
        """
        self.activate()
376
        self.check_features()
377
        tab = self.parent_muc
378 379
        theme = get_theme()
        color = dump_tuple(theme.COLOR_REMOTE_USER)
380 381
        if tab and config.get_by_tabname('display_user_color_in_join_part',
                                         self.general_jid):
382 383 384
            user = tab.get_user_by_name(nick)
            if user:
                color = dump_tuple(user.color)
mathieui's avatar
mathieui committed
385
        self.add_message(
386 387 388 389 390 391 392 393 394 395
            InfoMessage(
                '\x19%(join_col)s}%(spec)s \x19%(color)s}%(nick)s\x19'
                '%(info_col)s} joined the room' % {
                    'nick': nick,
                    'color': color,
                    'spec': theme.CHAR_JOIN,
                    'join_col': dump_tuple(theme.COLOR_JOIN_CHAR),
                    'info_col': dump_tuple(theme.COLOR_INFORMATION_TEXT)
                },
            ),
mathieui's avatar
mathieui committed
396
            typ=2)
397
        return self.core.tabs.current_tab is self
398 399 400 401

    def activate(self, reason=None):
        self.on = True
        if reason:
402
            self.add_message(InfoMessage(reason), typ=2)
403 404 405 406

    def deactivate(self, reason=None):
        self.on = False
        if reason:
407
            self.add_message(InfoMessage(reason), typ=2)
408 409

    def matching_names(self):
410
        return [(3, self.jid.resource), (4, self.name)]
411

412
    def add_error(self, error_message):
413 414
        theme = get_theme()
        error = '\x19%s}%s\x19o' % (dump_tuple(theme.COLOR_CHAR_NACK),
415
                                    error_message)
mathieui's avatar
mathieui committed
416
        self.add_message(
417 418 419 420 421 422 423 424
            Message(
                error,
                highlight=True,
                nickname='Error',
                nick_color=theme.COLOR_ERROR_MSG,
            ),
            typ=2,
        )
425
        self.core.refresh_window()