privatetab.py 15.6 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 14 15 16 17
import logging
log = logging.getLogger(__name__)

import curses

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

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

mathieui's avatar
mathieui committed
30

31
class PrivateTab(OneToOneTab):
32 33 34 35 36
    """
    The tab containg a private conversation (someone from a MUC)
    """
    message_type = 'chat'
    plugin_commands = {}
37
    additional_information = {}
38
    plugin_keys = {}
mathieui's avatar
mathieui committed
39

40 41
    def __init__(self, core, name, nick):
        OneToOneTab.__init__(self, core, name)
42 43 44 45 46 47 48 49 50
        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
51 52 53 54 55 56 57 58 59 60 61 62
        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.')
63 64 65 66 67 68
        self.resize()
        self.parent_muc = self.core.get_tab_by_name(safeJID(name).bare, MucTab)
        self.on = True
        self.update_commands()
        self.update_keys()

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

75 76
    @property
    def general_jid(self):
77
        return self.name
78

79 80 81
    def get_dest_jid(self):
        return self.name

82 83 84 85 86 87 88 89 90
    @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
        """
91
        PrivateTab.additional_information[plugin_name] = callback
92 93 94

    @staticmethod
    def remove_information_element(plugin_name):
95
        del PrivateTab.additional_information[plugin_name]
96 97

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

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

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

138
    @command_args_parser.raw
139 140 141
    def command_say(self, line, attention=False, correct=False):
        if not self.on:
            return
142
        msg = self.core.xmpp.make_message(self.name)
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
        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']
158
            if config.get_by_tabname('group_corrections', self.name):
159
                try:
mathieui's avatar
mathieui committed
160 161 162 163 164 165 166
                    self.modify_message(
                        msg['body'],
                        self.last_sent_message['id'],
                        msg['id'],
                        user=user,
                        jid=self.core.xmpp.boundjid,
                        nickname=self.own_nick)
167 168 169 170 171 172 173 174 175 176
                    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'])
mathieui's avatar
mathieui committed
177 178
        if (config.get_by_tabname('send_chat_states', self.general_jid)
                and self.remote_wants_chatstates is not False):
179 180 181 182 183 184 185 186 187 188 189
            needed = 'inactive' if self.inactive else 'active'
            msg['chat_state'] = needed
        if attention and self.remote_supports_attention:
            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
190 191 192 193 194 195 196 197
            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)
198 199

        self.last_sent_message = msg
200 201
        if self.remote_supports_receipts:
            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
        """
mathieui's avatar
mathieui committed
212

213 214
        def callback(res):
            if not res:
mathieui's avatar
mathieui committed
215 216 217 218 219 220 221
                return self.core.information(
                    'Could not get the software version from %s' % (jid, ),
                    'Warning')
            version = '%s is running %s version %s on %s' % (
                jid, res.get('name') or 'an unknown software',
                res.get('version') or 'unknown',
                res.get('os') or 'an unknown platform')
222
            self.core.information(version, 'Info')
mathieui's avatar
mathieui committed
223

224
        if args:
225
            return self.core.command.version(args[0])
226
        jid = safeJID(self.name)
mathieui's avatar
mathieui committed
227
        fixes.get_version(self.core.xmpp, jid, callback=callback)
228

229
    @command_args_parser.quoted(0, 1)
230 231 232 233
    def command_info(self, arg):
        """
        /info
        """
mathieui's avatar
mathieui committed
234 235
        if arg and arg[0]:
            self.parent_muc.command_info(arg[0])
236 237 238 239 240
        else:
            user = safeJID(self.name).resource
            self.parent_muc.command_info(user)

    def resize(self):
241 242
        self.need_resize = False

243 244 245 246 247 248 249
        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
250 251 252
        self.text_win.resize(
            self.height - 2 - info_win_height - tab_win_height, self.width, 0,
            0)
253
        self.text_win.rebuild_everything(self._text_buffer)
mathieui's avatar
mathieui committed
254 255 256 257
        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)
258 259 260 261

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

265
        self.text_win.refresh()
266
        self.info_header.refresh(self.name, self.text_win, self.chatstate,
267
                                 PrivateTab.additional_information)
268 269 270
        if display_info_win:
            self.info_win.refresh()

271 272 273 274
        self.refresh_tab_win()
        self.input.refresh()

    def refresh_info_header(self):
mathieui's avatar
mathieui committed
275 276
        self.info_header.refresh(self.name, self.text_win, self.chatstate,
                                 PrivateTab.additional_information)
277 278 279 280 281 282 283 284 285 286 287 288
        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
289 290 291
        empty_after = self.input.get_text() == '' or (
            self.input.get_text().startswith('/')
            and not self.input.get_text().startswith('//'))
292 293 294 295 296 297
        tab = self.core.get_tab_by_name(safeJID(self.name).bare, MucTab)
        if tab and tab.joined:
            self.send_composing_chat_state(empty_after)
        return False

    def on_lose_focus(self):
298 299 300 301 302
        if self.input.text:
            self.state = 'nonempty'
        else:
            self.state = 'normal'

303 304 305
        self.text_win.remove_line_separator()
        self.text_win.add_line_separator(self._text_buffer)
        tab = self.core.get_tab_by_name(safeJID(self.name).bare, MucTab)
mathieui's avatar
mathieui committed
306 307
        if tab and tab.joined and config.get_by_tabname(
                'send_chat_states', self.general_jid) and self.on:
308 309 310 311 312 313 314
            self.send_chat_state('inactive')
        self.check_scrolled()

    def on_gain_focus(self):
        self.state = 'current'
        curses.curs_set(1)
        tab = self.core.get_tab_by_name(safeJID(self.name).bare, MucTab)
mathieui's avatar
mathieui committed
315 316 317 318
        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:
319 320 321
            self.send_chat_state('active')

    def on_info_win_size_changed(self):
mathieui's avatar
mathieui committed
322
        if self.core.information_win_size >= self.height - 3:
323
            return
mathieui's avatar
mathieui committed
324 325 326 327 328
        self.text_win.resize(self.height - 2 - self.core.information_win_size -
                             Tab.tab_win_height(), self.width, 0, 0)
        self.info_header.resize(
            1, self.width, self.height - 2 - self.core.information_win_size -
            Tab.tab_win_height(), 0)
329 330 331 332

    def get_text_window(self):
        return self.text_win

333
    @refresh_wrapper.conditional
334
    def rename_user(self, old_nick, user):
335 336 337 338
        """
        The user changed her nick in the corresponding muc: update the tab’s name and
        display a message.
        """
mathieui's avatar
mathieui committed
339 340 341 342 343 344 345 346 347 348
        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
349
        self.name = new_jid
350
        return self.core.current_tab() is self
351 352

    @refresh_wrapper.conditional
353
    def user_left(self, status_message, user):
354 355 356 357
        """
        The user left the associated MUC
        """
        self.deactivate()
mathieui's avatar
mathieui committed
358 359
        if config.get_by_tabname('display_user_color_in_join_part',
                                 self.general_jid):
360 361 362 363
            color = dump_tuple(user.color)
        else:
            color = dump_tuple(get_theme().COLOR_REMOTE_USER)

364
        if not status_message:
mathieui's avatar
mathieui committed
365 366 367 368 369 370 371 372 373 374
            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,
                    'spec': get_theme().CHAR_QUIT,
                    'nick_col': color,
                    'quit_col': dump_tuple(get_theme().COLOR_QUIT_CHAR),
                    'info_col': dump_tuple(get_theme().COLOR_INFORMATION_TEXT)
                },
                typ=2)
375
        else:
mathieui's avatar
mathieui committed
376 377 378 379 380 381 382 383 384 385 386 387
            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,
                    'spec': get_theme().CHAR_QUIT,
                    'nick_col': color,
                    'quit_col': dump_tuple(get_theme().COLOR_QUIT_CHAR),
                    'info_col': dump_tuple(get_theme().COLOR_INFORMATION_TEXT)
                },
                typ=2)
388 389 390 391 392 393 394 395
        return self.core.current_tab() is self

    @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()
396
        self.check_features()
397 398
        tab = self.parent_muc
        color = dump_tuple(get_theme().COLOR_REMOTE_USER)
399 400
        if tab and config.get_by_tabname('display_user_color_in_join_part',
                                         self.general_jid):
401 402 403
            user = tab.get_user_by_name(nick)
            if user:
                color = dump_tuple(user.color)
mathieui's avatar
mathieui committed
404 405 406 407 408 409 410 411 412 413
        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,
                'spec': get_theme().CHAR_JOIN,
                'join_col': dump_tuple(get_theme().COLOR_JOIN_CHAR),
                'info_col': dump_tuple(get_theme().COLOR_INFORMATION_TEXT)
            },
            typ=2)
414 415 416 417 418 419 420 421 422
        return self.core.current_tab() is self

    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
423
        self.remote_wants_chatstates = None
424 425 426 427
        if reason:
            self.add_message(txt=reason, typ=2)

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

430 431 432
    def add_error(self, error_message):
        error = '\x19%s}%s\x19o' % (dump_tuple(get_theme().COLOR_CHAR_NACK),
                                    error_message)
mathieui's avatar
mathieui committed
433 434 435 436 437 438
        self.add_message(
            error,
            highlight=True,
            nickname='Error',
            nick_color=get_theme().COLOR_ERROR_MSG,
            typ=2)
439
        self.core.refresh_window()