privatetab.py 15.1 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

mathieui's avatar
mathieui committed
17
from poezio.tabs import OneToOneTab, MucTab, Tab
18

19 20 21 22
from poezio import windows
from poezio import xhtml
from poezio.common import safeJID
from poezio.config import config
23
from poezio.core.structs import Command
24 25 26 27
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
28

29 30
log = logging.getLogger(__name__)

mathieui's avatar
mathieui committed
31

32
class PrivateTab(OneToOneTab):
33 34 35
    """
    The tab containg a private conversation (someone from a MUC)
    """
36 37
    plugin_commands = {}  # type: Dict[str, Command]
    plugin_keys = {}  # type: Dict[str, Callable]
38
    message_type = 'chat'
39
    additional_information = {}  # type: Dict[str, Callable[[str], str]]
mathieui's avatar
mathieui committed
40

41 42
    def __init__(self, core, name, nick):
        OneToOneTab.__init__(self, core, name)
43 44 45 46 47 48 49 50 51
        self.own_nick = nick
        self.name = name
        self.text_win = windows.TextWin()
        self._text_buffer.add_window(self.text_win)
        self.info_header = windows.PrivateInfoWin()
        self.input = windows.MessageInput()
        # keys
        self.key_func['^I'] = self.completion
        # commands
mathieui's avatar
mathieui committed
52 53 54 55 56 57 58 59 60 61 62 63
        self.register_command(
            'info',
            self.command_info,
            desc=
            'Display some information about the user in the MUC: its/his/her role, affiliation, status and status message.',
            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.')
64
        self.resize()
65 66
        self.parent_muc = self.core.tabs.by_name_and_class(
            safeJID(name).bare, MucTab)
67 68 69 70
        self.on = True
        self.update_commands()
        self.update_keys()

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

77 78
    @property
    def general_jid(self):
79
        return self.name
80

81 82 83
    def get_dest_jid(self):
        return self.name

84 85 86 87 88 89 90 91 92
    @property
    def nick(self):
        return self.get_nick()

    @staticmethod
    def add_information_element(plugin_name, callback):
        """
        Lets a plugin add its own information to the PrivateInfoWin
        """
93
        PrivateTab.additional_information[plugin_name] = callback
94 95 96

    @staticmethod
    def remove_information_element(plugin_name):
97
        del PrivateTab.additional_information[plugin_name]
98 99

    def load_logs(self, log_nb):
mathieui's avatar
mathieui committed
100 101
        logs = logger.get_logs(
            safeJID(self.name).full.replace('/', '\\'), log_nb)
102
        return logs
103 104 105 106 107

    def log_message(self, txt, nickname, time=None, typ=1):
        """
        Log the messages in the archives.
        """
mathieui's avatar
mathieui committed
108 109
        if not logger.log_message(
                self.name, nickname, txt, date=time, typ=typ):
110
            self.core.information('Unable to write in the log file', 'Error')
111 112

    def on_close(self):
113
        super().on_close()
114 115 116 117 118 119 120 121 122 123 124 125 126
        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]
127
        after = config.get('after_completion') + ' '
128 129 130 131 132 133 134
        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
135 136 137
        empty_after = self.input.get_text() == '' or (
            self.input.get_text().startswith('/')
            and not self.input.get_text().startswith('//'))
138 139
        self.send_composing_chat_state(empty_after)

140
    @command_args_parser.raw
141 142 143
    def command_say(self, line, attention=False, correct=False):
        if not self.on:
            return
144
        msg = self.core.xmpp.make_message(self.name)
145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
        msg['type'] = 'chat'
        msg['body'] = line
        # 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']:
            self.cancel_paused_delay()
            self.text_win.refresh()
            self.input.refresh()
            return
        user = self.parent_muc.get_user_by_name(self.own_nick)
        replaced = False
        if correct or msg['replace']['id']:
            msg['replace']['id'] = self.last_sent_message['id']
160
            if config.get_by_tabname('group_corrections', self.name):
161
                try:
mathieui's avatar
mathieui committed
162 163 164 165 166 167 168
                    self.modify_message(
                        msg['body'],
                        self.last_sent_message['id'],
                        msg['id'],
                        user=user,
                        jid=self.core.xmpp.boundjid,
                        nickname=self.own_nick)
169 170 171 172 173 174 175 176 177 178
                    replaced = True
                except:
                    log.error('Unable to correct a message', exc_info=True)
        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'])
179
        if config.get_by_tabname('send_chat_states', self.general_jid):
180 181
            needed = 'inactive' if self.inactive else 'active'
            msg['chat_state'] = needed
182
        if attention:
183 184 185 186 187 188 189 190
            msg['attention'] = True
        self.core.events.trigger('private_say_after', msg, self)
        if not msg['body']:
            self.cancel_paused_delay()
            self.text_win.refresh()
            self.input.refresh()
            return
        if not replaced:
mathieui's avatar
mathieui committed
191 192 193 194 195 196 197 198
            self.add_message(
                msg['body'],
                nickname=self.own_nick or self.core.own_nick,
                forced_user=user,
                nick_color=get_theme().COLOR_OWN_NICK,
                identifier=msg['id'],
                jid=self.core.xmpp.boundjid,
                typ=1)
199 200

        self.last_sent_message = msg
201
        msg._add_receipt = True
202 203 204 205 206
        msg.send()
        self.cancel_paused_delay()
        self.text_win.refresh()
        self.input.refresh()

207 208
    @command_args_parser.quoted(0, 1)
    def command_version(self, args):
209 210 211
        """
        /version
        """
212
        if args:
213
            return self.core.command.version(args[0])
214
        jid = safeJID(self.name)
215 216
        self.core.xmpp.plugin['xep_0092'].get_version(
            jid, callback=self.core.handler.on_version_result)
217

218
    @command_args_parser.quoted(0, 1)
219 220 221 222
    def command_info(self, arg):
        """
        /info
        """
mathieui's avatar
mathieui committed
223 224
        if arg and arg[0]:
            self.parent_muc.command_info(arg[0])
225 226 227 228 229
        else:
            user = safeJID(self.name).resource
            self.parent_muc.command_info(user)

    def resize(self):
230 231
        self.need_resize = False

232 233 234 235 236 237 238
        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
239 240 241
        self.text_win.resize(
            self.height - 2 - info_win_height - tab_win_height, self.width, 0,
            0)
242
        self.text_win.rebuild_everything(self._text_buffer)
mathieui's avatar
mathieui committed
243 244 245 246
        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)
247 248 249 250

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

254
        self.text_win.refresh()
255
        self.info_header.refresh(self.name, self.text_win, self.chatstate,
256
                                 PrivateTab.additional_information)
257 258 259
        if display_info_win:
            self.info_win.refresh()

260 261 262 263
        self.refresh_tab_win()
        self.input.refresh()

    def refresh_info_header(self):
mathieui's avatar
mathieui committed
264 265
        self.info_header.refresh(self.name, self.text_win, self.chatstate,
                                 PrivateTab.additional_information)
266 267 268 269 270 271 272 273 274 275 276 277
        self.input.refresh()

    def get_nick(self):
        return safeJID(self.name).resource

    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
278 279 280
        empty_after = self.input.get_text() == '' or (
            self.input.get_text().startswith('/')
            and not self.input.get_text().startswith('//'))
281
        tab = self.core.tabs.by_name_and_class(safeJID(self.name).bare, MucTab)
282 283 284 285 286
        if tab and tab.joined:
            self.send_composing_chat_state(empty_after)
        return False

    def on_lose_focus(self):
287 288 289 290 291
        if self.input.text:
            self.state = 'nonempty'
        else:
            self.state = 'normal'

292 293
        self.text_win.remove_line_separator()
        self.text_win.add_line_separator(self._text_buffer)
294
        tab = self.core.tabs.by_name_and_class(safeJID(self.name).bare, MucTab)
mathieui's avatar
mathieui committed
295 296
        if tab and tab.joined and config.get_by_tabname(
                'send_chat_states', self.general_jid) and self.on:
297 298 299 300 301 302
            self.send_chat_state('inactive')
        self.check_scrolled()

    def on_gain_focus(self):
        self.state = 'current'
        curses.curs_set(1)
303
        tab = self.core.tabs.by_name_and_class(safeJID(self.name).bare, MucTab)
mathieui's avatar
mathieui committed
304 305 306 307
        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:
308 309 310
            self.send_chat_state('active')

    def on_info_win_size_changed(self):
mathieui's avatar
mathieui committed
311
        if self.core.information_win_size >= self.height - 3:
312
            return
mathieui's avatar
mathieui committed
313 314 315
        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
316 317 318
        self.info_header.resize(
            1, self.width, self.height - 2 - self.core.information_win_size -
            Tab.tab_win_height(), 0)
319 320 321 322

    def get_text_window(self):
        return self.text_win

323
    @refresh_wrapper.conditional
324
    def rename_user(self, old_nick, user):
325 326 327 328
        """
        The user changed her nick in the corresponding muc: update the tab’s name and
        display a message.
        """
mathieui's avatar
mathieui committed
329 330 331 332 333 334 335 336 337 338
        self.add_message(
            '\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)
            },
            typ=2)
        new_jid = safeJID(self.name).bare + '/' + user.nick
339
        self.name = new_jid
340
        return self.core.tabs.current_tab is self
341 342

    @refresh_wrapper.conditional
343
    def user_left(self, status_message, user):
344 345 346 347
        """
        The user left the associated MUC
        """
        self.deactivate()
348
        theme = get_theme()
mathieui's avatar
mathieui committed
349 350
        if config.get_by_tabname('display_user_color_in_join_part',
                                 self.general_jid):
351 352
            color = dump_tuple(user.color)
        else:
353
            color = dump_tuple(theme.COLOR_REMOTE_USER)
354

355
        if not status_message:
mathieui's avatar
mathieui committed
356 357 358 359
            self.add_message(
                '\x19%(quit_col)s}%(spec)s \x19%(nick_col)s}'
                '%(nick)s\x19%(info_col)s} has left the room' % {
                    'nick': user.nick,
360
                    'spec': theme.CHAR_QUIT,
mathieui's avatar
mathieui committed
361
                    'nick_col': color,
362 363
                    'quit_col': dump_tuple(theme.COLOR_QUIT_CHAR),
                    'info_col': dump_tuple(theme.COLOR_INFORMATION_TEXT)
mathieui's avatar
mathieui committed
364 365
                },
                typ=2)
366
        else:
mathieui's avatar
mathieui committed
367 368 369 370 371 372
            self.add_message(
                '\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,
373
                    'spec': theme.CHAR_QUIT,
mathieui's avatar
mathieui committed
374
                    'nick_col': color,
375 376
                    'quit_col': dump_tuple(theme.COLOR_QUIT_CHAR),
                    'info_col': dump_tuple(theme.COLOR_INFORMATION_TEXT)
mathieui's avatar
mathieui committed
377 378
                },
                typ=2)
379
        return self.core.tabs.current_tab is self
380 381 382 383 384 385 386

    @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()
387
        self.check_features()
388
        tab = self.parent_muc
389 390
        theme = get_theme()
        color = dump_tuple(theme.COLOR_REMOTE_USER)
391 392
        if tab and config.get_by_tabname('display_user_color_in_join_part',
                                         self.general_jid):
393 394 395
            user = tab.get_user_by_name(nick)
            if user:
                color = dump_tuple(user.color)
mathieui's avatar
mathieui committed
396 397 398 399 400
        self.add_message(
            '\x19%(join_col)s}%(spec)s \x19%(color)s}%(nick)s\x19'
            '%(info_col)s} joined the room' % {
                'nick': nick,
                'color': color,
401 402 403
                '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
404 405
            },
            typ=2)
406
        return self.core.tabs.current_tab is self
407 408 409 410 411 412 413 414 415 416 417 418

    def activate(self, reason=None):
        self.on = True
        if reason:
            self.add_message(txt=reason, typ=2)

    def deactivate(self, reason=None):
        self.on = False
        if reason:
            self.add_message(txt=reason, typ=2)

    def matching_names(self):
419
        return [(3, safeJID(self.name).resource), (4, self.name)]
420

421
    def add_error(self, error_message):
422 423
        theme = get_theme()
        error = '\x19%s}%s\x19o' % (dump_tuple(theme.COLOR_CHAR_NACK),
424
                                    error_message)
mathieui's avatar
mathieui committed
425 426 427 428
        self.add_message(
            error,
            highlight=True,
            nickname='Error',
429
            nick_color=theme.COLOR_ERROR_MSG,
mathieui's avatar
mathieui committed
430
            typ=2)
431
        self.core.refresh_window()