conversationtab.py 17.4 KB
Newer Older
1 2 3 4 5 6
"""
Module for the ConversationTabs

A ConversationTab is a direct chat between two JIDs, outside of a room.

There are two different instances of a ConversationTab:
7 8 9
- A DynamicConversationTab that used to implement XEP-0296 (best
    practices for resource locking), which now stays on the bare JID at
    any time. This is the default.
10 11 12 13
- A StaticConversationTab that will stay focused on one resource all
    the time.

"""
14 15 16 17 18
import logging
log = logging.getLogger(__name__)

import curses

mathieui's avatar
mathieui committed
19
from poezio.tabs.basetabs import OneToOneTab, Tab
20

21 22 23 24 25 26 27 28
from poezio import common
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.roster import roster
29
from poezio.text_buffer import CorrectionError
30 31
from poezio.theming import get_theme, dump_tuple
from poezio.decorators import command_args_parser
32

mathieui's avatar
mathieui committed
33

34
class ConversationTab(OneToOneTab):
35 36 37 38 39 40
    """
    The tab containg a normal conversation (not from a MUC)
    Must not be instantiated, use Static or Dynamic version only.
    """
    plugin_commands = {}
    plugin_keys = {}
41
    additional_information = {}
42
    message_type = 'chat'
mathieui's avatar
mathieui committed
43

44 45
    def __init__(self, core, jid):
        OneToOneTab.__init__(self, core, jid)
46 47 48
        self.nick = None
        self.nick_sent = False
        self.state = 'normal'
mathieui's avatar
mathieui committed
49
        self.name = jid  # a conversation tab is linked to one specific full jid OR bare jid
50 51 52 53 54 55 56
        self.text_win = windows.TextWin()
        self._text_buffer.add_window(self.text_win)
        self.upper_bar = windows.ConversationStatusMessageWin()
        self.input = windows.MessageInput()
        # keys
        self.key_func['^I'] = self.completion
        # commands
mathieui's avatar
mathieui committed
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
        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 the user.')
        self.register_command(
            'info',
            self.command_info,
            shortdesc='Get the status of the contact.')
        self.register_command(
            'last_activity',
            self.command_last_activity,
            usage='[jid]',
            desc='Get the last activity of the given or the current contact.',
            shortdesc='Get the activity.',
            completion=self.core.completion.last_activity)
        self.register_command(
            'add',
            self.command_add,
            desc='Add the current JID to your roster, ask them to'
            ' allow you to see his presence, and allow them to'
            ' see your presence.',
            shortdesc='Add a user to your roster.')
81 82 83 84 85
        self.update_commands()
        self.update_keys()

    @property
    def general_jid(self):
86
        return safeJID(self.name).bare
87

mathieui's avatar
mathieui committed
88 89 90
    def get_info_header(self):
        raise NotImplementedError

91 92 93 94 95
    @staticmethod
    def add_information_element(plugin_name, callback):
        """
        Lets a plugin add its own information to the ConversationInfoWin
        """
96
        ConversationTab.additional_information[plugin_name] = callback
97 98 99

    @staticmethod
    def remove_information_element(plugin_name):
100
        del ConversationTab.additional_information[plugin_name]
101 102 103 104

    def completion(self):
        self.complete_commands(self.input)

105
    @command_args_parser.raw
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125
    def command_say(self, line, attention=False, correct=False):
        msg = self.core.xmpp.make_message(self.get_dest_jid())
        msg['type'] = 'chat'
        msg['body'] = line
        if not self.nick_sent:
            msg['nick'] = self.core.own_nick
            self.nick_sent = True
        # trigger the event BEFORE looking for colors.
        # and before displaying the message in the window
        # This lets a plugin insert \x19xxx} colors, that will
        # be converted in xhtml.
        self.core.events.trigger('conversation_say', msg, self)
        if not msg['body']:
            self.cancel_paused_delay()
            self.text_win.refresh()
            self.input.refresh()
            return
        replaced = False
        if correct or msg['replace']['id']:
            msg['replace']['id'] = self.last_sent_message['id']
126
            if config.get_by_tabname('group_corrections', self.name):
127
                try:
mathieui's avatar
mathieui committed
128 129 130 131 132 133
                    self.modify_message(
                        msg['body'],
                        self.last_sent_message['id'],
                        msg['id'],
                        jid=self.core.xmpp.boundjid,
                        nickname=self.core.own_nick)
134
                    replaced = True
135
                except CorrectionError:
136 137 138 139 140 141 142
                    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'])
143
        if config.get_by_tabname('send_chat_states', self.general_jid):
144 145 146 147 148 149 150 151 152 153 154
            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('conversation_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
155 156 157 158 159 160 161
            self.add_message(
                msg['body'],
                nickname=self.core.own_nick,
                nick_color=get_theme().COLOR_OWN_NICK,
                identifier=msg['id'],
                jid=self.core.xmpp.boundjid,
                typ=1)
162 163

        self.last_sent_message = msg
164 165
        if self.remote_supports_receipts:
            msg._add_receipt = True
166 167 168 169 170
        msg.send()
        self.cancel_paused_delay()
        self.text_win.refresh()
        self.input.refresh()

171 172
    @command_args_parser.quoted(0, 1)
    def command_last_activity(self, args):
173
        """
mathieui's avatar
mathieui committed
174
        /last_activity [jid]
175
        """
mathieui's avatar
mathieui committed
176
        if args and args[0]:
177
            return self.core.command.last_activity(args[0])
178 179 180 181

        def callback(iq):
            if iq['type'] != 'result':
                if iq['error']['type'] == 'auth':
mathieui's avatar
mathieui committed
182 183 184
                    self.core.information(
                        'You are not allowed to see the activity of this contact.',
                        'Error')
185
                else:
mathieui's avatar
mathieui committed
186 187
                    self.core.information('Error retrieving the activity',
                                          'Error')
188 189 190 191 192 193 194
                return
            seconds = iq['last_activity']['seconds']
            status = iq['last_activity']['status']
            from_ = iq['from']
            msg = '\x19%s}The last activity of %s was %s ago%s'
            if not safeJID(from_).user:
                msg = '\x19%s}The uptime of %s is %s.' % (
mathieui's avatar
mathieui committed
195 196
                    dump_tuple(get_theme().COLOR_INFORMATION_TEXT), from_,
                    common.parse_secs_to_str(seconds))
197 198 199 200 201
            else:
                msg = '\x19%s}The last activity of %s was %s ago%s' % (
                    dump_tuple(get_theme().COLOR_INFORMATION_TEXT),
                    from_,
                    common.parse_secs_to_str(seconds),
mathieui's avatar
mathieui committed
202 203 204
                    (' and his/her last status was %s' % status)
                    if status else '',
                )
205 206 207
            self.add_message(msg)
            self.core.refresh_window()

mathieui's avatar
mathieui committed
208 209
        self.core.xmpp.plugin['xep_0012'].get_last_activity(
            self.get_dest_jid(), callback=callback)
210 211

    @refresh_wrapper.conditional
212 213
    @command_args_parser.ignored
    def command_info(self):
214 215 216 217 218 219 220 221 222 223
        contact = roster[self.get_dest_jid()]
        jid = safeJID(self.get_dest_jid())
        if contact:
            if jid.resource:
                resource = contact[jid.full]
            else:
                resource = contact.get_highest_priority_resource()
        else:
            resource = None
        if resource:
mathieui's avatar
mathieui committed
224 225 226 227 228 229 230 231
            status = (
                'Status: %s' % resource.status) if resource.status else ''
            self._text_buffer.add_message(
                "\x19%(info_col)s}Show: %(show)s, %(status)s\x19o" % {
                    'show': resource.presence or 'available',
                    'status': status,
                    'info_col': dump_tuple(get_theme().COLOR_INFORMATION_TEXT)
                })
232 233
            return True
        else:
mathieui's avatar
mathieui committed
234 235 236 237
            self._text_buffer.add_message(
                "\x19%(info_col)s}No information available\x19o" % {
                    'info_col': dump_tuple(get_theme().COLOR_INFORMATION_TEXT)
                })
238 239
            return True

240 241
    @command_args_parser.quoted(0, 1)
    def command_version(self, args):
242
        """
243
        /version [jid]
244
        """
mathieui's avatar
mathieui committed
245

246 247
        def callback(res):
            if not res:
mathieui's avatar
mathieui committed
248 249 250 251 252 253 254
                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')
255
            self.core.information(version, 'Info')
mathieui's avatar
mathieui committed
256

257
        if args:
258
            return self.core.command.version(args[0])
259 260 261 262 263
        jid = safeJID(self.name)
        if not jid.resource:
            if jid in roster:
                resource = roster[jid].get_highest_priority_resource()
                jid = resource.jid if resource else jid
mathieui's avatar
mathieui committed
264
        fixes.get_version(self.core.xmpp, jid, callback=callback)
265

Link Mauve's avatar
Link Mauve committed
266 267 268 269 270 271 272 273 274 275 276 277 278
    @command_args_parser.ignored
    def command_add(self):
        """
        Add the current JID to the roster, and automatically
        accept the reverse subscription
        """
        jid = self.general_jid
        if jid in roster and roster[jid].subscription in ('to', 'both'):
            return self.core.information('Already subscribed.', 'Roster')
        roster.add(jid)
        roster.modified()
        self.core.information('%s was added to the roster' % jid, 'Roster')

279
    def resize(self):
280
        self.need_resize = False
281 282 283 284 285 286 287 288 289 290 291
        if self.size.tab_degrade_y:
            display_bar = False
            info_win_height = 0
            tab_win_height = 0
            bar_height = 0
        else:
            display_bar = True
            info_win_height = self.core.information_win_size
            tab_win_height = Tab.tab_win_height()
            bar_height = 1

mathieui's avatar
mathieui committed
292 293 294
        self.text_win.resize(
            self.height - 2 - bar_height - info_win_height - tab_win_height,
            self.width, bar_height, 0)
295
        self.text_win.rebuild_everything(self._text_buffer)
296 297
        if display_bar:
            self.upper_bar.resize(1, self.width, 0, 0)
mathieui's avatar
mathieui committed
298 299 300
        self.get_info_header().resize(
            1, self.width, self.height - 2 - info_win_height - tab_win_height,
            0)
301
        self.input.resize(1, self.width, self.height - 1, 0)
302 303 304 305

    def refresh(self):
        if self.need_resize:
            self.resize()
306
        log.debug('  TAB   Refresh: %s', self.__class__.__name__)
307 308
        display_bar = display_info_win = not self.size.tab_degrade_y

309
        self.text_win.refresh()
310 311

        if display_bar:
mathieui's avatar
mathieui committed
312 313 314 315 316
            self.upper_bar.refresh(self.get_dest_jid(),
                                   roster[self.get_dest_jid()])
        self.get_info_header().refresh(
            self.get_dest_jid(), roster[self.get_dest_jid()], self.text_win,
            self.chatstate, ConversationTab.additional_information)
317 318 319

        if display_info_win:
            self.info_win.refresh()
320 321 322 323
        self.refresh_tab_win()
        self.input.refresh()

    def refresh_info_header(self):
mathieui's avatar
mathieui committed
324 325 326
        self.get_info_header().refresh(
            self.get_dest_jid(), roster[self.get_dest_jid()], self.text_win,
            self.chatstate, ConversationTab.additional_information)
327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
        self.input.refresh()

    def get_nick(self):
        jid = safeJID(self.name)
        contact = roster[jid.bare]
        if contact:
            return contact.name or jid.user
        else:
            if self.nick:
                return self.nick
            return jid.user

    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)
mathieui's avatar
mathieui committed
344 345 346
        empty_after = self.input.get_text() == '' or (
            self.input.get_text().startswith('/')
            and not self.input.get_text().startswith('//'))
347 348 349 350 351 352 353 354 355 356 357 358 359
        self.send_composing_chat_state(empty_after)
        return False

    def on_lose_focus(self):
        contact = roster[self.get_dest_jid()]
        jid = safeJID(self.get_dest_jid())
        if contact:
            if jid.resource:
                resource = contact[jid.full]
            else:
                resource = contact.get_highest_priority_resource()
        else:
            resource = None
360 361 362 363
        if self.input.text:
            self.state = 'nonempty'
        else:
            self.state = 'normal'
364 365
        self.text_win.remove_line_separator()
        self.text_win.add_line_separator(self._text_buffer)
366
        if config.get_by_tabname('send_chat_states', self.general_jid):
367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383
            if resource:
                self.send_chat_state('inactive')
        self.check_scrolled()

    def on_gain_focus(self):
        contact = roster[self.get_dest_jid()]
        jid = safeJID(self.get_dest_jid())
        if contact:
            if jid.resource:
                resource = contact[jid.full]
            else:
                resource = contact.get_highest_priority_resource()
        else:
            resource = None

        self.state = 'current'
        curses.curs_set(1)
384 385
        if (config.get_by_tabname('send_chat_states', self.general_jid)
                and (not self.input.get_text()
mathieui's avatar
mathieui committed
386
                     or not self.input.get_text().startswith('//'))):
387 388 389 390
            if resource:
                self.send_chat_state('active')

    def on_info_win_size_changed(self):
mathieui's avatar
mathieui committed
391
        if self.core.information_win_size >= self.height - 3:
392
            return
mathieui's avatar
mathieui committed
393 394 395 396 397
        self.text_win.resize(self.height - 3 - self.core.information_win_size -
                             Tab.tab_win_height(), self.width, 1, 0)
        self.get_info_header().resize(
            1, self.width, self.height - 2 - self.core.information_win_size -
            Tab.tab_win_height(), 0)
398 399 400 401 402 403

    def get_text_window(self):
        return self.text_win

    def on_close(self):
        Tab.on_close(self)
404
        if config.get_by_tabname('send_chat_states', self.general_jid):
405 406 407 408
            self.send_chat_state('gone')

    def matching_names(self):
        res = []
409
        jid = safeJID(self.name)
410 411
        res.append((2, jid.bare))
        res.append((1, jid.user))
412
        contact = roster[self.name]
413 414 415 416
        if contact and contact.name:
            res.append((0, contact.name))
        return res

mathieui's avatar
mathieui committed
417

418 419
class DynamicConversationTab(ConversationTab):
    """
420 421 422
    A conversation tab associated with one bare JID.  It used to
    support resource locking (as described in XEP-0296), but that was a
    bad idea so it has been removed.
423 424
    Only one DynamicConversationTab can be opened for a given jid.
    """
mathieui's avatar
mathieui committed
425

mathieui's avatar
mathieui committed
426
    def __init__(self, core, jid, resource=None):
427 428
        self.locked_resource = None
        self.name = safeJID(jid).bare
mathieui's avatar
mathieui committed
429
        ConversationTab.__init__(self, core, jid)
mathieui's avatar
mathieui committed
430
        self.info_header = windows.DynamicConversationInfoWin()
mathieui's avatar
mathieui committed
431 432 433
        self.register_command(
            'unlock',
            self.unlock_command,
434
            shortdesc='Deprecated, do nothing.')
mathieui's avatar
mathieui committed
435 436 437 438
        self.resize()

    def get_info_header(self):
        return self.info_header
439 440

    def lock(self, resource):
441
        pass
442 443

    def unlock_command(self, arg=None):
444
        pass
445

mathieui's avatar
mathieui committed
446
    def unlock(self, from_=None):
447
        pass
448 449 450

    def get_dest_jid(self):
        """
451
        Returns the bare jid.
452
        """
453
        return self.name
454 455 456 457 458 459 460

    def refresh(self):
        """
        Different from the parent class only for the info_header object.
        """
        if self.need_resize:
            self.resize()
461
        log.debug('  TAB   Refresh: %s', self.__class__.__name__)
462 463
        display_bar = display_info_win = not self.size.tab_degrade_y

464
        self.text_win.refresh()
465
        if display_bar:
466
            self.upper_bar.refresh(self.name, roster[self.name])
467
        displayed_jid = self.name
468
        self.get_info_header().refresh(displayed_jid, roster[self.name],
mathieui's avatar
mathieui committed
469 470
                                       self.text_win, self.chatstate,
                                       ConversationTab.additional_information)
471 472 473
        if display_info_win:
            self.info_win.refresh()

474 475 476 477 478 479 480
        self.refresh_tab_win()
        self.input.refresh()

    def refresh_info_header(self):
        """
        Different from the parent class only for the info_header object.
        """
481
        displayed_jid = self.name
482
        self.get_info_header().refresh(displayed_jid, roster[self.name],
mathieui's avatar
mathieui committed
483 484
                                       self.text_win, self.chatstate,
                                       ConversationTab.additional_information)
485 486
        self.input.refresh()

mathieui's avatar
mathieui committed
487

488 489 490 491 492
class StaticConversationTab(ConversationTab):
    """
    A conversation tab associated with one Full JID. It cannot be locked to
    an different resource or unlocked.
    """
mathieui's avatar
mathieui committed
493

mathieui's avatar
mathieui committed
494
    def __init__(self, core, jid):
mathieui's avatar
mathieui committed
495
        assert (safeJID(jid).resource)
mathieui's avatar
mathieui committed
496
        ConversationTab.__init__(self, core, jid)
mathieui's avatar
mathieui committed
497 498
        self.info_header = windows.ConversationInfoWin()
        self.resize()
499

mathieui's avatar
mathieui committed
500 501
    def get_info_header(self):
        return self.info_header