conversationtab.py 19.1 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13
"""
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:
- A DynamicConversationTab that implements XEP-0296 (best practices for
    resource locking), which means it will switch the resource it is
    focused on depending on the presences received. This is the default.
- 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

33
class ConversationTab(OneToOneTab):
34 35 36 37 38 39
    """
    The tab containg a normal conversation (not from a MUC)
    Must not be instantiated, use Static or Dynamic version only.
    """
    plugin_commands = {}
    plugin_keys = {}
40
    additional_information = {}
41
    message_type = 'chat'
42 43
    def __init__(self, core, jid):
        OneToOneTab.__init__(self, core, jid)
44 45 46 47 48 49 50 51 52 53 54 55
        self.nick = None
        self.nick_sent = False
        self.state = 'normal'
        self.name = jid        # a conversation tab is linked to one specific full jid OR bare jid
        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
        self.register_command('version', self.command_version,
56 57
                desc='Get the software version of the current interlocutor (usually its XMPP client and Operating System).',
                shortdesc='Get the software version of the user.')
58
        self.register_command('info', self.command_info,
59
                shortdesc='Get the status of the contact.')
60
        self.register_command('last_activity', self.command_last_activity,
61 62 63
                usage='[jid]',
                desc='Get the last activity of the given or the current contact.',
                shortdesc='Get the activity.',
64
                completion=self.core.completion.last_activity)
Link Mauve's avatar
Link Mauve committed
65 66 67 68 69
        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.')
70 71 72 73 74
        self.update_commands()
        self.update_keys()

    @property
    def general_jid(self):
75
        return safeJID(self.name).bare
76

mathieui's avatar
mathieui committed
77 78 79
    def get_info_header(self):
        raise NotImplementedError

80 81 82 83 84
    @staticmethod
    def add_information_element(plugin_name, callback):
        """
        Lets a plugin add its own information to the ConversationInfoWin
        """
85
        ConversationTab.additional_information[plugin_name] = callback
86 87 88

    @staticmethod
    def remove_information_element(plugin_name):
89
        del ConversationTab.additional_information[plugin_name]
90 91 92 93

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

94
    @command_args_parser.raw
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
    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']
115
            if config.get_by_tabname('group_corrections', self.name):
116 117 118 119
                try:
                    self.modify_message(msg['body'], self.last_sent_message['id'], msg['id'], jid=self.core.xmpp.boundjid,
                            nickname=self.core.own_nick)
                    replaced = True
120
                except CorrectionError:
121 122 123 124 125 126 127
                    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'])
128 129
        if (config.get_by_tabname('send_chat_states', self.general_jid) and
                self.remote_wants_chatstates is not False):
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
            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:
            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)

        self.last_sent_message = msg
149 150
        if self.remote_supports_receipts:
            msg._add_receipt = True
151 152 153 154 155
        msg.send()
        self.cancel_paused_delay()
        self.text_win.refresh()
        self.input.refresh()

156 157
    @command_args_parser.quoted(0, 1)
    def command_last_activity(self, args):
158
        """
mathieui's avatar
mathieui committed
159
        /last_activity [jid]
160
        """
mathieui's avatar
mathieui committed
161
        if args and args[0]:
162
            return self.core.command.last_activity(args[0])
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188

        def callback(iq):
            if iq['type'] != 'result':
                if iq['error']['type'] == 'auth':
                    self.core.information('You are not allowed to see the activity of this contact.', 'Error')
                else:
                    self.core.information('Error retrieving the activity', 'Error')
                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.' % (
                        dump_tuple(get_theme().COLOR_INFORMATION_TEXT),
                        from_,
                        common.parse_secs_to_str(seconds))
            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),
                    (' and his/her last status was %s' % status) if status else '',)
            self.add_message(msg)
            self.core.refresh_window()

mathieui's avatar
mathieui committed
189
        self.core.xmpp.plugin['xep_0012'].get_last_activity(self.get_dest_jid(), callback=callback)
190 191

    @refresh_wrapper.conditional
192 193
    @command_args_parser.ignored
    def command_info(self):
194 195 196 197 198 199 200 201 202 203
        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:
204
            status = ('Status: %s' % resource.status) if resource.status else ''
205
            self._text_buffer.add_message("\x19%(info_col)s}Show: %(show)s, %(status)s\x19o" % {
206
                'show': resource.presence or 'available', 'status': status, 'info_col': dump_tuple(get_theme().COLOR_INFORMATION_TEXT)})
207 208 209 210 211
            return True
        else:
            self._text_buffer.add_message("\x19%(info_col)s}No information available\x19o" % {'info_col': dump_tuple(get_theme().COLOR_INFORMATION_TEXT)})
            return True

212 213
    @command_args_parser.quoted(0, 1)
    def command_version(self, args):
214
        """
215
        /version [jid]
216 217 218 219 220
        """
        def callback(res):
            if not res:
                return self.core.information('Could not get the software version from %s' % (jid,), 'Warning')
            version = '%s is running %s version %s on %s' % (jid,
221 222 223
                                                             res.get('name') or 'an unknown software',
                                                             res.get('version') or 'unknown',
                                                             res.get('os') or 'an unknown platform')
224
            self.core.information(version, 'Info')
225
        if args:
226
            return self.core.command.version(args[0])
227 228 229 230 231
        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
232 233
        fixes.get_version(self.core.xmpp, jid,
                callback=callback)
234

Link Mauve's avatar
Link Mauve committed
235 236 237 238 239 240 241 242 243 244 245 246 247
    @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')

248
    def resize(self):
249
        self.need_resize = False
250 251 252 253 254 255 256 257 258 259 260 261 262 263
        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

        self.text_win.resize(self.height - 2 - bar_height - info_win_height
                                - tab_win_height,
                             self.width, bar_height, 0)
264
        self.text_win.rebuild_everything(self._text_buffer)
265 266
        if display_bar:
            self.upper_bar.resize(1, self.width, 0, 0)
267
        self.get_info_header().resize(1, self.width,
268
                                self.height - 2 - info_win_height
269 270 271
                                    - tab_win_height,
                                0)
        self.input.resize(1, self.width, self.height - 1, 0)
272 273 274 275

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

279
        self.text_win.refresh()
280 281 282

        if display_bar:
            self.upper_bar.refresh(self.get_dest_jid(), roster[self.get_dest_jid()])
283
        self.get_info_header().refresh(self.get_dest_jid(), roster[self.get_dest_jid()], self.text_win, self.chatstate, ConversationTab.additional_information)
284 285 286

        if display_info_win:
            self.info_win.refresh()
287 288 289 290
        self.refresh_tab_win()
        self.input.refresh()

    def refresh_info_header(self):
291
        self.get_info_header().refresh(self.get_dest_jid(), roster[self.get_dest_jid()],
292
                self.text_win, self.chatstate, ConversationTab.additional_information)
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
        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)
        empty_after = self.input.get_text() == '' or (self.input.get_text().startswith('/') and not self.input.get_text().startswith('//'))
        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
324 325 326 327
        if self.input.text:
            self.state = 'nonempty'
        else:
            self.state = 'normal'
328 329
        self.text_win.remove_line_separator()
        self.text_win.add_line_separator(self._text_buffer)
330
        if config.get_by_tabname('send_chat_states', self.general_jid):
331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347
            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)
348 349 350
        if (config.get_by_tabname('send_chat_states', self.general_jid)
                and (not self.input.get_text()
                    or not self.input.get_text().startswith('//'))):
351 352 353 354 355 356 357
            if resource:
                self.send_chat_state('active')

    def on_info_win_size_changed(self):
        if self.core.information_win_size >= self.height-3:
            return
        self.text_win.resize(self.height-3-self.core.information_win_size - Tab.tab_win_height(), self.width, 1, 0)
358
        self.get_info_header().resize(1, self.width, self.height-2-self.core.information_win_size - Tab.tab_win_height(), 0)
359 360 361 362 363 364

    def get_text_window(self):
        return self.text_win

    def on_close(self):
        Tab.on_close(self)
365
        if config.get_by_tabname('send_chat_states', self.general_jid):
366 367 368 369
            self.send_chat_state('gone')

    def matching_names(self):
        res = []
370
        jid = safeJID(self.name)
371 372
        res.append((2, jid.bare))
        res.append((1, jid.user))
373
        contact = roster[self.name]
374 375 376 377 378 379 380 381 382 383
        if contact and contact.name:
            res.append((0, contact.name))
        return res

class DynamicConversationTab(ConversationTab):
    """
    A conversation tab associated with one bare JID that can be “locked” to
    a full jid, and unlocked, as described in the XEP-0296.
    Only one DynamicConversationTab can be opened for a given jid.
    """
mathieui's avatar
mathieui committed
384
    def __init__(self, core, jid, resource=None):
385 386 387 388
        self.locked_resource = None
        self.name = safeJID(jid).bare
        if resource:
            self.lock(resource)
mathieui's avatar
mathieui committed
389
        ConversationTab.__init__(self, core, jid)
mathieui's avatar
mathieui committed
390
        self.info_header = windows.DynamicConversationInfoWin()
391
        self.register_command('unlock', self.unlock_command,
392
                shortdesc='Unlock the conversation from a particular resource.')
mathieui's avatar
mathieui committed
393 394 395 396
        self.resize()

    def get_info_header(self):
        return self.info_header
397 398 399 400 401 402

    def lock(self, resource):
        """
        Lock the tab to the resource.
        """
        assert(resource)
403 404
        if resource != self.locked_resource:
            self.locked_resource = resource
405 406 407
            info = '\x19%s}' % dump_tuple(get_theme().COLOR_INFORMATION_TEXT)
            jid_c = '\x19%s}' % dump_tuple(get_theme().COLOR_MUC_JID)

408 409
            message = ('%(info)sConversation locked to '
                       '%(jid_c)s%(jid)s/%(resource)s%(info)s.') % {
410 411 412 413
                            'info': info,
                            'jid_c': jid_c,
                            'jid': self.name,
                            'resource': resource}
mathieui's avatar
mathieui committed
414
            self.add_message(message, typ=0)
415
            self.check_features()
416 417 418 419 420

    def unlock_command(self, arg=None):
        self.unlock()
        self.refresh_info_header()

mathieui's avatar
mathieui committed
421
    def unlock(self, from_=None):
422 423 424 425
        """
        Unlock the tab from a resource. It is now “associated” with the bare
        jid.
        """
426
        self.remote_wants_chatstates = None
427 428
        if self.locked_resource != None:
            self.locked_resource = None
429 430
            info = '\x19%s}' % dump_tuple(get_theme().COLOR_INFORMATION_TEXT)
            jid_c = '\x19%s}' % dump_tuple(get_theme().COLOR_MUC_JID)
mathieui's avatar
mathieui committed
431

mathieui's avatar
mathieui committed
432
            if from_:
433 434
                message = ('%(info)sConversation unlocked (received activity'
                           ' from %(jid_c)s%(jid)s%(info)s).') % {
435 436 437
                                'info': info,
                                'jid_c': jid_c,
                                'jid': from_}
mathieui's avatar
mathieui committed
438
                self.add_message(message, typ=0)
mathieui's avatar
mathieui committed
439
            else:
440
                message = '%sConversation unlocked.' % info
mathieui's avatar
mathieui committed
441
                self.add_message(message, typ=0)
442 443 444 445 446 447 448

    def get_dest_jid(self):
        """
        Returns the full jid (using the locked resource), or the bare jid if
        the conversation is not locked.
        """
        if self.locked_resource:
449 450
            return "%s/%s" % (self.name, self.locked_resource)
        return self.name
451 452 453 454 455 456 457

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

461
        self.text_win.refresh()
462
        if display_bar:
463
            self.upper_bar.refresh(self.name, roster[self.name])
464
        if self.locked_resource:
465
            displayed_jid = "%s/%s" % (self.name, self.locked_resource)
466
        else:
467
            displayed_jid = self.name
468
        self.get_info_header().refresh(displayed_jid, roster[self.name],
469
                                 self.text_win, self.chatstate,
470
                                 ConversationTab.additional_information)
471 472 473
        if display_info_win:
            self.info_win.refresh()

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

    def refresh_info_header(self):
        """
        Different from the parent class only for the info_header object.
        """
        if self.locked_resource:
482
            displayed_jid = "%s/%s" % (self.name, self.locked_resource)
483
        else:
484
            displayed_jid = self.name
485
        self.get_info_header().refresh(displayed_jid, roster[self.name],
486
                self.text_win, self.chatstate, ConversationTab.additional_information)
487 488 489 490 491 492 493
        self.input.refresh()

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
494
    def __init__(self, core, jid):
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