basetabs.py 29.8 KB
Newer Older
1
"""
2 3 4 5 6 7 8 9 10 11 12 13
Module for the base Tabs

The root class Tab defines the generic interface and attributes of a
tab. A tab organizes various Windows around the screen depending
of the tab specificity. If the tab shows messages, it will also
reference a buffer containing the messages.

Each subclass should redefine its own refresh() and resize() method
according to its windows.

This module also defines ChatTabs, the parent class for all tabs
revolving around chats.
14 15 16 17 18 19 20 21 22 23 24
"""

import logging
log = logging.getLogger(__name__)

import string
import time
import weakref
from datetime import datetime, timedelta
from xml.etree import cElementTree as ET

25 26 27 28 29 30 31 32 33 34 35 36
from poezio import core
from poezio import timed_events
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.singleton import Singleton
from poezio.text_buffer import TextBuffer
from poezio.theming import get_theme, dump_tuple
from poezio.decorators import command_args_parser
37

38
# getters for tab colors (lambdas, so that they are dynamic)
39 40 41
STATE_COLORS = {
        'disconnected': lambda: get_theme().COLOR_TAB_DISCONNECTED,
        'scrolled': lambda: get_theme().COLOR_TAB_SCROLLED,
42
        'nonempty': lambda: get_theme().COLOR_TAB_NONEMPTY,
43 44
        'joined': lambda: get_theme().COLOR_TAB_JOINED,
        'message': lambda: get_theme().COLOR_TAB_NEW_MESSAGE,
45
        'composing': lambda: get_theme().COLOR_TAB_COMPOSING,
46 47 48 49 50 51 52 53 54
        'highlight': lambda: get_theme().COLOR_TAB_HIGHLIGHT,
        'private': lambda: get_theme().COLOR_TAB_PRIVATE,
        'normal': lambda: get_theme().COLOR_TAB_NORMAL,
        'current': lambda: get_theme().COLOR_TAB_CURRENT,
        'attention': lambda: get_theme().COLOR_TAB_ATTENTION,
    }
VERTICAL_STATE_COLORS = {
        'disconnected': lambda: get_theme().COLOR_VERTICAL_TAB_DISCONNECTED,
        'scrolled': lambda: get_theme().COLOR_VERTICAL_TAB_SCROLLED,
55
        'nonempty': lambda: get_theme().COLOR_VERTICAL_TAB_NONEMPTY,
56 57
        'joined': lambda: get_theme().COLOR_VERTICAL_TAB_JOINED,
        'message': lambda: get_theme().COLOR_VERTICAL_TAB_NEW_MESSAGE,
58
        'composing': lambda: get_theme().COLOR_VERTICAL_TAB_COMPOSING,
59 60 61 62 63 64 65 66
        'highlight': lambda: get_theme().COLOR_VERTICAL_TAB_HIGHLIGHT,
        'private': lambda: get_theme().COLOR_VERTICAL_TAB_PRIVATE,
        'normal': lambda: get_theme().COLOR_VERTICAL_TAB_NORMAL,
        'current': lambda: get_theme().COLOR_VERTICAL_TAB_CURRENT,
        'attention': lambda: get_theme().COLOR_VERTICAL_TAB_ATTENTION,
    }


67 68
# priority of the different tab states when using Alt+e
# higher means more priority, < 0 means not selectable
69 70 71 72
STATE_PRIORITY = {
        'normal': -1,
        'current': -1,
        'disconnected': 0,
73
        'nonempty': 0.1,
74
        'scrolled': 0.5,
75
        'joined': 0.8,
76
        'composing': 0.9,
77 78 79 80 81 82 83 84 85
        'message': 1,
        'highlight': 2,
        'private': 2,
        'attention': 3
    }

class Tab(object):
    plugin_commands = {}
    plugin_keys = {}
86 87
    def __init__(self, core):
        self.core = core
88 89
        if not hasattr(self, 'name'):
            self.name = self.__class__.__name__
90
        self.input = None
mathieui's avatar
mathieui committed
91
        self.closed = False
92
        self._state = 'normal'
93
        self._prev_state = None
94

95
        self.need_resize = False
96 97 98 99 100
        self.key_func = {}      # each tab should add their keys in there
                                # and use them in on_input
        self.commands = {}      # and their own commands


101 102
    @property
    def size(self):
103
        return self.core.size
104

105 106 107 108 109 110 111 112 113 114 115 116 117
    @property
    def nb(self):
        for index, tab in enumerate(self.core.tabs):
            if tab == self:
                return index
        return len(self.core.tabs)

    @staticmethod
    def tab_win_height():
        """
        Returns 1 or 0, depending on if we are using the vertical tab list
        or not.
        """
118
        if config.get('enable_vertical_tab_list'):
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
            return 0
        return 1

    @property
    def info_win(self):
        return self.core.information_win

    @property
    def color(self):
        return STATE_COLORS[self._state]()

    @property
    def vertical_color(self):
        return VERTICAL_STATE_COLORS[self._state]()

    @property
    def state(self):
        return self._state

    @state.setter
    def state(self, value):
        if not value in STATE_COLORS:
            log.debug("Invalid value for tab state: %s", value)
        elif STATE_PRIORITY[value] < STATE_PRIORITY[self._state] and \
                value not in ('current', 'disconnected') and \
                not (self._state == 'scrolled' and value == 'disconnected'):
            log.debug("Did not set state because of lower priority, asked: %s, kept: %s", value, self._state)
        elif self._state == 'disconnected' and value not in ('joined', 'current'):
            log.debug('Did not set state because disconnected tabs remain visible')
        else:
            self._state = value
150 151 152
            if self._state == 'current':
                self._prev_state = None

153 154 155
    def set_state(self, value):
        self._state = value

156 157 158 159 160 161 162 163 164 165
    def save_state(self):
        if self._state != 'composing':
            self._prev_state = self._state

    def restore_state(self):
        if self.state == 'composing' and self._prev_state:
            self._state = self._prev_state
            self._prev_state = None
        elif not self._prev_state:
            self._state = 'normal'
166 167 168

    @staticmethod
    def resize(scr):
169 170
        Tab.height, Tab.width = scr.getmaxyx()
        windows.Win._tab_win = scr
171

172 173 174 175 176 177 178 179
    def missing_command_callback(self, command_name):
        """
        Callback executed when a command is not found.
        Returns True if the callback took care of displaying
        the error message, False otherwise.
        """
        return False

180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232
    def register_command(self, name, func, *, desc='', shortdesc='', completion=None, usage=''):
        """
        Add a command
        """
        if name in self.commands:
            return
        if not desc and shortdesc:
            desc = shortdesc
        self.commands[name] = core.Command(func, desc, completion, shortdesc, usage)

    def complete_commands(self, the_input):
        """
        Does command completion on the specified input for both global and tab-specific
        commands.
        This should be called from the completion method (on tab, for example), passing
        the input where completion is to be made.
        It can completion the command name itself or an argument of the command.
        Returns True if a completion was made, False else.
        """
        txt = the_input.get_text()
        # check if this is a command
        if txt.startswith('/') and not txt.startswith('//'):
            position = the_input.get_argument_position(quoted=False)
            if position == 0:
                words = ['/%s'% (name) for name in sorted(self.core.commands)] +\
                    ['/%s' % (name) for name in sorted(self.commands)]
                the_input.new_completion(words, 0)
                # Do not try to cycle command completion if there was only
                # one possibily. The next tab will complete the argument.
                # Otherwise we would need to add a useless space before being
                # able to complete the arguments.
                hit_copy = set(the_input.hit_list)
                while not hit_copy:
                    whitespace = the_input.text.find(' ')
                    if whitespace == -1:
                        whitespace = len(the_input.text)
                    the_input.text = the_input.text[:whitespace-1] + the_input.text[whitespace:]
                    the_input.new_completion(words, 0)
                    hit_copy = set(the_input.hit_list)
                if len(hit_copy) == 1:
                    the_input.do_command(' ')
                    the_input.reset_completion()
                return True
            # check if we are in the middle of the command name
            elif len(txt.split()) > 1 or\
                    (txt.endswith(' ') and not the_input.last_completion):
                command_name = txt.split()[0][1:]
                if command_name in self.commands:
                    command = self.commands[command_name]
                elif command_name in self.core.commands:
                    command = self.core.commands[command_name]
                else:           # Unknown command, cannot complete
                    return False
233
                if command.comp is None:
234 235
                    return False # There's no completion function
                else:
236
                    return command.comp(the_input)
237 238 239 240 241 242 243 244 245 246 247 248 249 250
        return False

    def execute_command(self, provided_text):
        """
        Execute the command in the input and return False if
        the input didn't contain a command
        """
        txt = provided_text or self.input.key_enter()
        if txt.startswith('/') and not txt.startswith('//') and\
                not txt.startswith('/me '):
            command = txt.strip().split()[0][1:]
            arg = txt[2+len(command):] # jump the '/' and the ' '
            func = None
            if command in self.commands: # check tab-specific commands
251
                func = self.commands[command].func
252
            elif command in self.core.commands: # check global commands
253
                func = self.core.commands[command].func
254 255 256
            else:
                low = command.lower()
                if low in self.commands:
257
                    func = self.commands[low].func
258
                elif low in self.core.commands:
259
                    func = self.core.commands[low].func
260
                else:
261 262 263
                    if self.missing_command_callback is not None:
                        error_handled = self.missing_command_callback(low)
                    if not error_handled:
264 265 266
                        self.core.information("Unknown command (%s)" %
                                              (command),
                                              'Error')
267 268 269 270 271
            if command in ('correct', 'say'): # hack
                arg = xhtml.convert_simple_to_full_colors(arg)
            else:
                arg = xhtml.clean_text_simple(arg)
            if func:
272 273
                if hasattr(self.input, "reset_completion"):
                    self.input.reset_completion()
274 275 276 277 278 279
                func(arg)
            return True
        else:
            return False

    def refresh_tab_win(self):
280
        if config.get('enable_vertical_tab_list'):
281 282 283
            left_tab_win = self.core.left_tab_win
            if left_tab_win and not self.size.core_degrade_x:
                left_tab_win.refresh()
284
        elif not self.size.core_degrade_y:
285
            self.core.tab_win.refresh()
286 287 288 289 290 291 292 293 294 295 296

    def refresh(self):
        """
        Called on each screen refresh (when something has changed)
        """
        pass

    def get_name(self):
        """
        get the name of the tab
        """
297
        return self.name
298 299 300 301 302

    def get_nick(self):
        """
        Get the nick of the tab (defaults to its name)
        """
303
        return self.name
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386

    def get_text_window(self):
        """
        Returns the principal TextWin window, if there's one
        """
        return None

    def on_input(self, key, raw):
        """
        raw indicates if the key should activate the associated command or not.
        """
        pass

    def update_commands(self):
        for c in self.plugin_commands:
            if not c in self.commands:
                self.commands[c] = self.plugin_commands[c]

    def update_keys(self):
        for k in self.plugin_keys:
            if not k in self.key_func:
                self.key_func[k] = self.plugin_keys[k]

    def on_lose_focus(self):
        """
        called when this tab loses the focus.
        """
        self.state = 'normal'

    def on_gain_focus(self):
        """
        called when this tab gains the focus.
        """
        self.state = 'current'

    def on_scroll_down(self):
        """
        Defines what happens when we scroll down
        """
        pass

    def on_scroll_up(self):
        """
        Defines what happens when we scroll up
        """
        pass

    def on_line_up(self):
        """
        Defines what happens when we scroll one line up
        """
        pass

    def on_line_down(self):
        """
        Defines what happens when we scroll one line up
        """
        pass

    def on_half_scroll_down(self):
        """
        Defines what happens when we scroll half a screen down
        """
        pass

    def on_half_scroll_up(self):
        """
        Defines what happens when we scroll half a screen up
        """
        pass

    def on_info_win_size_changed(self):
        """
        Called when the window with the informations is resized
        """
        pass

    def on_close(self):
        """
        Called when the tab is to be closed
        """
        if self.input:
            self.input.on_delete()
mathieui's avatar
mathieui committed
387
        self.closed = True
388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408

    def matching_names(self):
        """
        Returns a list of strings that are used to name a tab with the /win
        command.  For example you could switch to a tab that returns
        ['hello', 'coucou'] using /win hel, or /win coucou
        If not implemented in the tab, it just doesn’t match with anything.
        """
        return []

    def __del__(self):
        log.debug('------ Closing tab %s', self.__class__.__name__)

class GapTab(Tab):

    def __bool__(self):
        return False

    def __len__(self):
        return 0

409 410
    @property
    def name(self):
411 412 413 414 415 416 417 418 419 420 421 422 423 424
        return ''

    def refresh(self):
        log.debug('WARNING: refresh() called on a gap tab, this should not happen')

class ChatTab(Tab):
    """
    A tab containing a chat of any type.
    Just use this class instead of Tab if the tab needs a recent-words completion
    Also, ^M is already bound to on_enter
    And also, add the /say command
    """
    plugin_commands = {}
    plugin_keys = {}
425 426
    def __init__(self, core, jid=''):
        Tab.__init__(self, core)
427 428 429 430
        self.name = jid
        self.text_win = None
        self._text_buffer = TextBuffer()
        self.chatstate = None   # can be "active", "composing", "paused", "gone", "inactive"
louiz’'s avatar
louiz’ committed
431
        # We keep a reference of the event that will set our chatstate to "paused", so that
432 433 434 435 436 437 438 439 440
        # we can delete it or change it if we need to
        self.timed_event_paused = None
        # Keeps the last sent message to complete it easily in completion_correct, and to replace it.
        self.last_sent_message = None
        self.key_func['M-v'] = self.move_separator
        self.key_func['M-h'] = self.scroll_separator
        self.key_func['M-/'] = self.last_words_completion
        self.key_func['^M'] = self.on_enter
        self.register_command('say', self.command_say,
441 442
                usage='<message>',
                shortdesc='Send the message.')
443
        self.register_command('xhtml', self.command_xhtml,
444 445
                usage='<custom xhtml>',
                shortdesc='Send custom XHTML.')
446
        self.register_command('clear', self.command_clear,
447
                shortdesc='Clear the current buffer.')
448
        self.register_command('correct', self.command_correct,
449 450
                desc='Fix the last message with whatever you want.',
                shortdesc='Correct the last message.',
451 452 453 454 455 456
                completion=self.completion_correct)
        self.chat_state = None
        self.update_commands()
        self.update_keys()

        # Get the logs
457
        log_nb = config.get('load_log')
458 459 460 461 462 463 464 465 466 467 468
        logs = self.load_logs(log_nb)

        if logs:
            for message in logs:
                self._text_buffer.add_message(**message)

    @property
    def is_muc(self):
        return False

    def load_logs(self, log_nb):
469
        logs = logger.get_logs(safeJID(self.name).bare, log_nb)
470
        return logs
471 472 473 474 475 476 477

    def log_message(self, txt, nickname, time=None, typ=1):
        """
        Log the messages in the archives.
        """
        name = safeJID(self.name).bare
        if not logger.log_message(name, nickname, txt, date=time, typ=typ):
478
            self.core.information('Unable to write in the log file', 'Error')
479

480 481 482
    def add_message(self, txt, time=None, nickname=None, forced_user=None,
                    nick_color=None, identifier=None, jid=None, history=None,
                    typ=1, highlight=False):
483 484 485
        self.log_message(txt, nickname, time=time, typ=typ)
        self._text_buffer.add_message(txt, time=time,
                nickname=nickname,
486
                highlight=highlight,
487 488 489 490 491 492
                nick_color=nick_color,
                history=history,
                user=forced_user,
                identifier=identifier,
                jid=jid)

493
    def modify_message(self, txt, old_id, new_id, user=None, jid=None, nickname=None):
494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517
        self.log_message(txt, nickname, typ=1)
        message = self._text_buffer.modify_message(txt, old_id, new_id, time=time, user=user, jid=jid)
        if message:
            self.text_win.modify_message(old_id, message)
            self.core.refresh_window()
            return True
        return False

    def last_words_completion(self):
        """
        Complete the input with words recently said
        """
        # build the list of the recent words
        char_we_dont_want = string.punctuation+' ’„“”…«»'
        words = list()
        for msg in self._text_buffer.messages[:-40:-1]:
            if not msg:
                continue
            txt = xhtml.clean_text(msg.txt)
            for char in char_we_dont_want:
                txt = txt.replace(char, ' ')
            for word in txt.split():
                if len(word) >= 4 and word not in words:
                    words.append(word)
518
        words.extend([word for word in config.get('words').split(':') if word])
519 520 521 522 523 524 525 526 527 528 529
        self.input.auto_completion(words, ' ', quotify=False)

    def on_enter(self):
        txt = self.input.key_enter()
        if txt:
            if not self.execute_command(txt):
                if txt.startswith('//'):
                    txt = txt[1:]
                self.command_say(xhtml.convert_simple_to_full_colors(txt))
        self.cancel_paused_delay()

530 531
    @command_args_parser.raw
    def command_xhtml(self, xhtml):
532 533 534
        """"
        /xhtml <custom xhtml>
        """
535
        message = self.generate_xhtml_message(xhtml)
536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556
        if message:
            message.send()

    def generate_xhtml_message(self, arg):
        if not arg:
            return
        try:
            body = xhtml.clean_text(xhtml.xhtml_to_poezio_colors(arg))
            ET.fromstring(arg)
        except:
            self.core.information('Could not send custom xhtml', 'Error')
            log.error('/xhtml: Unable to send custom xhtml', exc_info=True)
            return

        msg = self.core.xmpp.make_message(self.get_dest_jid())
        msg['body'] = body
        msg.enable('html')
        msg['html']['body'] = arg
        return msg

    def get_dest_jid(self):
557
        return self.name
558 559

    @refresh_wrapper.always
560
    def command_clear(self, ignored):
561 562 563 564 565 566 567 568 569 570 571 572 573
        """
        /clear
        """
        self._text_buffer.messages = []
        self.text_win.rebuild_everything(self._text_buffer)

    def send_chat_state(self, state, always_send=False):
        """
        Send an empty chatstate message
        """
        if not self.is_muc or self.joined:
            if state in ('active', 'inactive', 'gone') and self.inactive and not always_send:
                return
574 575
            if (config.get_by_tabname('send_chat_states', self.general_jid)
                    and self.remote_wants_chatstates is not False):
576 577 578 579 580
                msg = self.core.xmpp.make_message(self.get_dest_jid())
                msg['type'] = self.message_type
                msg['chat_state'] = state
                self.chat_state = state
                msg.send()
581
                return True
582 583 584 585 586 587 588

    def send_composing_chat_state(self, empty_after):
        """
        Send the "active" or "composing" chatstate, depending
        on the the current status of the input
        """
        name = self.general_jid
589 590
        if (config.get_by_tabname('send_chat_states', name)
                and self.remote_wants_chatstates):
591 592 593 594 595 596 597 598 599 600 601 602 603 604
            needed = 'inactive' if self.inactive else 'active'
            self.cancel_paused_delay()
            if not empty_after:
                if self.chat_state != "composing":
                    self.send_chat_state("composing")
                self.set_paused_delay(True)
            elif empty_after and self.chat_state != needed:
                self.send_chat_state(needed, True)

    def set_paused_delay(self, composing):
        """
        we create a timed event that will put us to paused
        in a few seconds
        """
605
        if not config.get_by_tabname('send_chat_states', self.general_jid):
606
            return
607 608 609
        # First, cancel the delay if it already exists, before rescheduling
        # it at a new date
        self.cancel_paused_delay()
610 611
        new_event = timed_events.DelayedEvent(4, self.send_chat_state, 'paused')
        self.core.add_timed_event(new_event)
612
        self.timed_event_paused = new_event
613 614 615 616 617 618 619

    def cancel_paused_delay(self):
        """
        Remove that event from the list and set it to None.
        Called for example when the input is emptied, or when the message
        is sent
        """
620 621 622
        if self.timed_event_paused is not None:
            self.core.remove_timed_event(self.timed_event_paused)
            self.timed_event_paused = None
623

624
    @command_args_parser.raw
625 626 627 628 629
    def command_correct(self, line):
        """
        /correct <fixed message>
        """
        if not line:
630
            self.core.command.help('correct')
631 632
            return
        if not self.last_sent_message:
633
            self.core.information('There is no message to correct.')
634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659
            return
        self.command_say(line, correct=True)

    def completion_correct(self, the_input):
        if self.last_sent_message and the_input.get_argument_position() == 1:
            return the_input.auto_completion([self.last_sent_message['body']], '', quotify=False)

    @property
    def inactive(self):
        """Whether we should send inactive or active as a chatstate"""
        return self.core.status.show in ('xa', 'away') or\
                (hasattr(self, 'directed_presence') and not self.directed_presence)

    def move_separator(self):
        self.text_win.remove_line_separator()
        self.text_win.add_line_separator(self._text_buffer)
        self.text_win.refresh()
        self.input.refresh()

    def get_conversation_messages(self):
        return self._text_buffer.messages

    def check_scrolled(self):
        if self.text_win.pos != 0:
            self.state = 'scrolled'

660
    @command_args_parser.raw
661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685
    def command_say(self, line, correct=False):
        pass

    def on_line_up(self):
        return self.text_win.scroll_up(1)

    def on_line_down(self):
        return self.text_win.scroll_down(1)

    def on_scroll_up(self):
        return self.text_win.scroll_up(self.text_win.height-1)

    def on_scroll_down(self):
        return self.text_win.scroll_down(self.text_win.height-1)

    def on_half_scroll_up(self):
        return self.text_win.scroll_up((self.text_win.height-1) // 2)

    def on_half_scroll_down(self):
        return self.text_win.scroll_down((self.text_win.height-1) // 2)

    @refresh_wrapper.always
    def scroll_separator(self):
        self.text_win.scroll_to_separator()

686 687
class OneToOneTab(ChatTab):

688 689
    def __init__(self, core, jid=''):
        ChatTab.__init__(self, core, jid)
690

691 692
        # Set to true once the first disco is done
        self.__initial_disco = False
693 694 695
        # change this to True or False when
        # we know that the remote user wants chatstates, or not.
        # None means we don’t know yet, and we send only "active" chatstates
696
        self._remote_wants_chatstates = None
697
        self.remote_supports_attention = True
698 699 700
        self.remote_supports_receipts = True
        self.check_features()

701 702 703 704 705 706 707 708 709 710 711 712 713 714
    @property
    def remote_wants_chatstates(self):
        return self._remote_wants_chatstates

    @remote_wants_chatstates.setter
    def remote_wants_chatstates(self, value):
        old_value = self._remote_wants_chatstates
        self._remote_wants_chatstates = value
        if (old_value is None and value != None) or \
                (old_value != value and value != None):
            ok = get_theme().CHAR_OK
            nope = get_theme().CHAR_EMPTY
            support = ok if value else nope
            if value:
715
                msg = '\x19%s}Contact supports chat states [%s].'
716
            else:
717
                msg = '\x19%s}Contact does not support chat states [%s].'
718 719 720 721 722
            color = dump_tuple(get_theme().COLOR_INFORMATION_TEXT)
            msg = msg % (color, support)
            self.add_message(msg, typ=0)
            self.core.refresh_window()

723
    def ack_message(self, msg_id, msg_jid):
724 725 726
        """
        Ack a message
        """
727
        new_msg = self._text_buffer.ack_message(msg_id, msg_jid)
728 729 730 731
        if new_msg:
            self.text_win.modify_message(msg_id, new_msg)
            self.core.refresh_window()

732 733 734 735 736 737 738 739 740 741 742
    def nack_message(self, error, msg_id, msg_jid):
        """
        Ack a message
        """
        new_msg = self._text_buffer.nack_message(error, msg_id, msg_jid)
        if new_msg:
            self.text_win.modify_message(msg_id, new_msg)
            self.core.refresh_window()
            return True
        return False

743 744 745 746
    @command_args_parser.raw
    def command_xhtml(self, xhtml_data):
        message = self.generate_xhtml_message(xhtml_data)
        if message:
747
            message['type'] = 'chat'
748 749 750 751 752 753 754 755 756 757
            if self.remote_supports_receipts:
                message._add_receipt = True
            if self.remote_wants_chatstates:
                message['chat_sate'] = 'active'
            message.send()
            body = xhtml.xhtml_to_poezio_colors(xhtml_data, force=True)
            self._text_buffer.add_message(body, nickname=self.core.own_nick,
                                          identifier=message['id'],)
            self.refresh()

758 759
    def check_features(self):
        "check the features supported by the other party"
760 761
        if safeJID(self.get_dest_jid()).resource:
            self.core.xmpp.plugin['xep_0030'].get_info(
762
                    jid=self.get_dest_jid(), timeout=5,
763
                    callback=self.features_checked)
764

765 766 767
    @command_args_parser.raw
    def command_attention(self, message):
        """/attention [message]"""
768 769 770 771 772 773 774 775
        if message is not '':
            self.command_say(message, attention=True)
        else:
            msg = self.core.xmpp.make_message(self.get_dest_jid())
            msg['type'] = 'chat'
            msg['attention'] = True
            msg.send()

776
    @command_args_parser.raw
777 778 779
    def command_say(self, line, correct=False, attention=False):
        pass

780 781 782 783 784
    def missing_command_callback(self, command_name):
        if command_name not in ('correct', 'attention'):
            return False

        if command_name == 'correct':
785
            feature = 'message correction'
786
        elif command_name == 'attention':
787 788 789
            feature = 'attention requests'
        msg = ('%s does not support %s, therefore the /%s '
               'command is currently disabled in this tab.')
790 791 792 793
        msg = msg % (self.name, feature, command_name)
        self.core.information(msg, 'Info')
        return True

794 795 796 797 798
    def _feature_attention(self, features):
        "Check for the 'attention' features"
        if 'urn:xmpp:attention:0' in features:
            self.remote_supports_attention = True
            self.register_command('attention', self.command_attention,
799 800 801 802 803
                                  usage='[message]',
                                  shortdesc='Request the attention.',
                                  desc='Attention: Request the attention of '
                                       'the contact. Can also send a message'
                                       ' along with the attention.')
804 805
        else:
            self.remote_supports_attention = False
806
        return self.remote_supports_attention
807 808 809 810 811 812 813 814

    def _feature_correct(self, features):
        "Check for the 'correction' feature"
        if not 'urn:xmpp:message-correct:0' in features:
            if 'correct' in self.commands:
                del self.commands['correct']
        elif not 'correct' in self.commands:
            self.register_command('correct', self.command_correct,
815 816
                    desc='Fix the last message with whatever you want.',
                    shortdesc='Correct the last message.',
817
                    completion=self.completion_correct)
818
        return 'correct' in self.commands
819 820 821 822 823 824 825

    def _feature_receipts(self, features):
        "Check for the 'receipts' feature"
        if 'urn:xmpp:receipts' in features:
            self.remote_supports_receipts = True
        else:
            self.remote_supports_receipts = False
826
        return self.remote_supports_receipts
827 828 829 830

    def features_checked(self, iq):
        "Features check callback"
        features = iq['disco_info'].get_features() or []
831 832 833
        before = ('correct' in self.commands,
                  self.remote_supports_attention,
                  self.remote_supports_receipts)
834 835 836 837
        correct = self._feature_correct(features)
        attention = self._feature_attention(features)
        receipts = self._feature_receipts(features)

838 839 840 841 842
        if (correct, attention, receipts) == before and self.__initial_disco:
            return
        else:
            self.__initial_disco = True

843 844 845
        if not (correct or attention or receipts):
            return # don’t display anything

846
        ok = get_theme().CHAR_OK
847
        nope = get_theme().CHAR_EMPTY
848 849 850 851 852

        correct = ok if correct else nope
        attention = ok if attention else nope
        receipts = ok if receipts else nope

853 854
        msg = ('\x19%s}Contact supports: correction [%s], '
               'attention [%s], receipts [%s].')
855
        color = dump_tuple(get_theme().COLOR_INFORMATION_TEXT)
856
        msg = msg % (color, correct, attention, receipts)
857
        self.add_message(msg, typ=0)
858
        self.core.refresh_window()
859