conversationtab.py 16.9 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
from poezio import common
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
28
from poezio.text_buffer import CorrectionError
29 30
from poezio.theming import get_theme, dump_tuple
from poezio.decorators import command_args_parser
31

mathieui's avatar
mathieui committed
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'
mathieui's avatar
mathieui committed
42

43 44
    def __init__(self, core, jid):
        OneToOneTab.__init__(self, core, jid)
45 46 47
        self.nick = None
        self.nick_sent = False
        self.state = 'normal'
mathieui's avatar
mathieui committed
48
        self.name = jid  # a conversation tab is linked to one specific full jid OR bare jid
49 50 51 52 53 54 55
        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
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
        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.')
80 81 82 83 84
        self.update_commands()
        self.update_keys()

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

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

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

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

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

104
    @command_args_parser.raw
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
    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']
125
            if config.get_by_tabname('group_corrections', self.name):
126
                try:
mathieui's avatar
mathieui committed
127 128 129 130 131 132
                    self.modify_message(
                        msg['body'],
                        self.last_sent_message['id'],
                        msg['id'],
                        jid=self.core.xmpp.boundjid,
                        nickname=self.core.own_nick)
133
                    replaced = True
134
                except CorrectionError:
135 136 137 138 139 140 141
                    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'])
142
        if config.get_by_tabname('send_chat_states', self.general_jid):
143 144
            needed = 'inactive' if self.inactive else 'active'
            msg['chat_state'] = needed
145
        if attention:
146 147 148 149 150 151 152 153
            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
154 155 156 157 158 159 160
            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)
161 162

        self.last_sent_message = msg
163
        msg._add_receipt = True
164 165 166 167 168
        msg.send()
        self.cancel_paused_delay()
        self.text_win.refresh()
        self.input.refresh()

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

        def callback(iq):
            if iq['type'] != 'result':
                if iq['error']['type'] == 'auth':
mathieui's avatar
mathieui committed
180 181 182
                    self.core.information(
                        'You are not allowed to see the activity of this contact.',
                        'Error')
183
                else:
mathieui's avatar
mathieui committed
184 185
                    self.core.information('Error retrieving the activity',
                                          'Error')
186 187 188 189 190 191 192
                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
193 194
                    dump_tuple(get_theme().COLOR_INFORMATION_TEXT), from_,
                    common.parse_secs_to_str(seconds))
195 196 197 198 199
            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
200 201 202
                    (' and his/her last status was %s' % status)
                    if status else '',
                )
203 204 205
            self.add_message(msg)
            self.core.refresh_window()

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

    @refresh_wrapper.conditional
210 211
    @command_args_parser.ignored
    def command_info(self):
212 213 214 215 216 217 218 219 220 221
        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
222 223 224 225 226 227 228 229
            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)
                })
230 231
            return True
        else:
mathieui's avatar
mathieui committed
232
            self._text_buffer.add_message(
mathieui's avatar
mathieui committed
233 234
                "\x19%(info_col)s}No information available\x19o" %
                {'info_col': dump_tuple(get_theme().COLOR_INFORMATION_TEXT)})
235 236
            return True

237 238
    @command_args_parser.quoted(0, 1)
    def command_version(self, args):
239
        """
240
        /version [jid]
241
        """
242
        if args:
243
            return self.core.command.version(args[0])
244 245 246 247 248
        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
249 250
        self.core.xmpp.plugin['xep_0092'].get_version(
            jid, callback=self.core.handler.on_version_result)
251

Link Mauve's avatar
Link Mauve committed
252 253 254 255 256 257 258 259 260 261 262 263 264
    @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')

265
    def resize(self):
266
        self.need_resize = False
267 268 269 270 271 272 273 274 275 276 277
        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
278 279 280
        self.text_win.resize(
            self.height - 2 - bar_height - info_win_height - tab_win_height,
            self.width, bar_height, 0)
281
        self.text_win.rebuild_everything(self._text_buffer)
282 283
        if display_bar:
            self.upper_bar.resize(1, self.width, 0, 0)
mathieui's avatar
mathieui committed
284 285 286
        self.get_info_header().resize(
            1, self.width, self.height - 2 - info_win_height - tab_win_height,
            0)
287
        self.input.resize(1, self.width, self.height - 1, 0)
288 289 290 291

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

295
        self.text_win.refresh()
296 297

        if display_bar:
mathieui's avatar
mathieui committed
298 299 300 301 302
            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)
303 304 305

        if display_info_win:
            self.info_win.refresh()
306 307 308 309
        self.refresh_tab_win()
        self.input.refresh()

    def refresh_info_header(self):
mathieui's avatar
mathieui committed
310 311 312
        self.get_info_header().refresh(
            self.get_dest_jid(), roster[self.get_dest_jid()], self.text_win,
            self.chatstate, ConversationTab.additional_information)
313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329
        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
330 331 332
        empty_after = self.input.get_text() == '' or (
            self.input.get_text().startswith('/')
            and not self.input.get_text().startswith('//'))
333 334 335 336 337 338 339 340 341 342 343 344 345
        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
346 347 348 349
        if self.input.text:
            self.state = 'nonempty'
        else:
            self.state = 'normal'
350 351
        self.text_win.remove_line_separator()
        self.text_win.add_line_separator(self._text_buffer)
352
        if config.get_by_tabname('send_chat_states', self.general_jid):
353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369
            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)
370 371
        if (config.get_by_tabname('send_chat_states', self.general_jid)
                and (not self.input.get_text()
mathieui's avatar
mathieui committed
372
                     or not self.input.get_text().startswith('//'))):
373 374 375 376
            if resource:
                self.send_chat_state('active')

    def on_info_win_size_changed(self):
mathieui's avatar
mathieui committed
377
        if self.core.information_win_size >= self.height - 3:
378
            return
mathieui's avatar
mathieui committed
379 380 381
        self.text_win.resize(
            self.height - 3 - self.core.information_win_size -
            Tab.tab_win_height(), self.width, 1, 0)
mathieui's avatar
mathieui committed
382 383 384
        self.get_info_header().resize(
            1, self.width, self.height - 2 - self.core.information_win_size -
            Tab.tab_win_height(), 0)
385 386 387 388 389 390

    def get_text_window(self):
        return self.text_win

    def on_close(self):
        Tab.on_close(self)
391
        if config.get_by_tabname('send_chat_states', self.general_jid):
392 393 394 395
            self.send_chat_state('gone')

    def matching_names(self):
        res = []
396
        jid = safeJID(self.name)
397 398
        res.append((2, jid.bare))
        res.append((1, jid.user))
399
        contact = roster[self.name]
400 401 402 403
        if contact and contact.name:
            res.append((0, contact.name))
        return res

mathieui's avatar
mathieui committed
404

405 406
class DynamicConversationTab(ConversationTab):
    """
407 408 409
    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.
410 411
    Only one DynamicConversationTab can be opened for a given jid.
    """
mathieui's avatar
mathieui committed
412

mathieui's avatar
mathieui committed
413
    def __init__(self, core, jid, resource=None):
414 415
        self.locked_resource = None
        self.name = safeJID(jid).bare
mathieui's avatar
mathieui committed
416
        ConversationTab.__init__(self, core, jid)
mathieui's avatar
mathieui committed
417
        self.info_header = windows.DynamicConversationInfoWin()
mathieui's avatar
mathieui committed
418
        self.register_command(
mathieui's avatar
mathieui committed
419
            'unlock', self.unlock_command, shortdesc='Deprecated, do nothing.')
mathieui's avatar
mathieui committed
420 421 422 423
        self.resize()

    def get_info_header(self):
        return self.info_header
424 425

    def lock(self, resource):
426
        pass
427 428

    def unlock_command(self, arg=None):
429
        pass
430

mathieui's avatar
mathieui committed
431
    def unlock(self, from_=None):
432
        pass
433 434 435

    def get_dest_jid(self):
        """
436
        Returns the bare jid.
437
        """
438
        return self.name
439 440 441 442 443 444 445

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

449
        self.text_win.refresh()
450
        if display_bar:
451
            self.upper_bar.refresh(self.name, roster[self.name])
452
        displayed_jid = self.name
453
        self.get_info_header().refresh(displayed_jid, roster[self.name],
mathieui's avatar
mathieui committed
454 455
                                       self.text_win, self.chatstate,
                                       ConversationTab.additional_information)
456 457 458
        if display_info_win:
            self.info_win.refresh()

459 460 461 462 463 464 465
        self.refresh_tab_win()
        self.input.refresh()

    def refresh_info_header(self):
        """
        Different from the parent class only for the info_header object.
        """
466
        displayed_jid = self.name
467
        self.get_info_header().refresh(displayed_jid, roster[self.name],
mathieui's avatar
mathieui committed
468 469
                                       self.text_win, self.chatstate,
                                       ConversationTab.additional_information)
470 471
        self.input.refresh()

mathieui's avatar
mathieui committed
472

473 474 475 476 477
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
478

mathieui's avatar
mathieui committed
479
    def __init__(self, core, jid):
mathieui's avatar
mathieui committed
480
        assert (safeJID(jid).resource)
mathieui's avatar
mathieui committed
481
        ConversationTab.__init__(self, core, jid)
mathieui's avatar
mathieui committed
482 483
        self.info_header = windows.ConversationInfoWin()
        self.resize()
484

mathieui's avatar
mathieui committed
485 486
    def get_info_header(self):
        return self.info_header