conversationtab.py 17.3 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
import curses
15
16
import logging
from typing import Dict, Callable
17

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

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

32
33
log = logging.getLogger(__name__)

mathieui's avatar
mathieui committed
34

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

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

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

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

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

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

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

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

        self.last_sent_message = msg
165
        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
            self._text_buffer.add_message(
mathieui's avatar
mathieui committed
235
236
                "\x19%(info_col)s}No information available\x19o" %
                {'info_col': dump_tuple(get_theme().COLOR_INFORMATION_TEXT)})
237
238
            return True

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

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

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

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

297
        self.text_win.refresh()
298
299

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

        if display_info_win:
            self.info_win.refresh()
308
309
310
311
        self.refresh_tab_win()
        self.input.refresh()

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

    def on_info_win_size_changed(self):
mathieui's avatar
mathieui committed
379
        if self.core.information_win_size >= self.height - 3:
380
            return
mathieui's avatar
mathieui committed
381
382
383
        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
384
385
386
        self.get_info_header().resize(
            1, self.width, self.height - 2 - self.core.information_win_size -
            Tab.tab_win_height(), 0)
387
388
389
390
391
392

    def get_text_window(self):
        return self.text_win

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

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

mathieui's avatar
mathieui committed
406

407
408
class DynamicConversationTab(ConversationTab):
    """
409
410
411
    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.
412
413
    Only one DynamicConversationTab can be opened for a given jid.
    """
414
415
    plugin_commands = {}  # type: Dict[str, Command]
    plugin_keys = {}  # type: Dict[str, Callable]
mathieui's avatar
mathieui committed
416

mathieui's avatar
mathieui committed
417
    def __init__(self, core, jid, resource=None):
418
419
        self.locked_resource = None
        self.name = safeJID(jid).bare
mathieui's avatar
mathieui committed
420
        ConversationTab.__init__(self, core, jid)
mathieui's avatar
mathieui committed
421
        self.info_header = windows.DynamicConversationInfoWin()
mathieui's avatar
mathieui committed
422
        self.register_command(
mathieui's avatar
mathieui committed
423
            'unlock', self.unlock_command, shortdesc='Deprecated, do nothing.')
mathieui's avatar
mathieui committed
424
        self.resize()
mathieui's avatar
mathieui committed
425
426
        self.update_commands()
        self.update_keys()
mathieui's avatar
mathieui committed
427
428
429

    def get_info_header(self):
        return self.info_header
430
431

    def lock(self, resource):
432
        pass
433
434

    def unlock_command(self, arg=None):
435
        pass
436

mathieui's avatar
mathieui committed
437
    def unlock(self, from_=None):
438
        pass
439
440
441

    def get_dest_jid(self):
        """
442
        Returns the bare jid.
443
        """
444
        return self.name
445
446
447
448
449
450
451

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

455
        self.text_win.refresh()
456
        if display_bar:
457
            self.upper_bar.refresh(self.name, roster[self.name])
458
        displayed_jid = self.name
459
        self.get_info_header().refresh(displayed_jid, roster[self.name],
mathieui's avatar
mathieui committed
460
461
                                       self.text_win, self.chatstate,
                                       ConversationTab.additional_information)
462
463
464
        if display_info_win:
            self.info_win.refresh()

465
466
467
468
469
470
471
        self.refresh_tab_win()
        self.input.refresh()

    def refresh_info_header(self):
        """
        Different from the parent class only for the info_header object.
        """
472
        displayed_jid = self.name
473
        self.get_info_header().refresh(displayed_jid, roster[self.name],
mathieui's avatar
mathieui committed
474
475
                                       self.text_win, self.chatstate,
                                       ConversationTab.additional_information)
476
477
        self.input.refresh()

mathieui's avatar
mathieui committed
478

479
480
481
482
483
class StaticConversationTab(ConversationTab):
    """
    A conversation tab associated with one Full JID. It cannot be locked to
    an different resource or unlocked.
    """
484
485
    plugin_commands = {}  # type: Dict[str, Command]
    plugin_keys = {}  # type: Dict[str, Callable]
mathieui's avatar
mathieui committed
486

mathieui's avatar
mathieui committed
487
    def __init__(self, core, jid):
mathieui's avatar
mathieui committed
488
        assert (safeJID(jid).resource)
mathieui's avatar
mathieui committed
489
        ConversationTab.__init__(self, core, jid)
mathieui's avatar
mathieui committed
490
491
        self.info_header = windows.ConversationInfoWin()
        self.resize()
mathieui's avatar
mathieui committed
492
493
        self.update_commands()
        self.update_keys()
494

mathieui's avatar
mathieui committed
495
496
    def get_info_header(self):
        return self.info_header