core.py 82.5 KB
Newer Older
mathieui's avatar
mathieui committed
1 2 3 4 5 6 7 8 9 10 11
"""
Module defining the Core class, which is the central orchestrator
of poezio and contains the main loop, the list of tabs, sets the state
of everything; it also contains global commands, completions and event
handlers but those are defined in submodules in order to avoir cluttering
this file.
"""
import logging

log = logging.getLogger(__name__)

12
import asyncio
mathieui's avatar
mathieui committed
13
import collections
14
import shutil
mathieui's avatar
mathieui committed
15 16 17 18 19 20 21 22 23
import curses
import os
import pipes
import sys
import time
from threading import Event
from datetime import datetime
from gettext import gettext as _

louiz’'s avatar
louiz’ committed
24
from slixmpp.xmlstream.handler import Callback
mathieui's avatar
mathieui committed
25 26 27 28 29

import bookmark
import connection
import decorators
import events
30
import fixes
mathieui's avatar
mathieui committed
31 32 33 34 35 36 37 38 39 40 41 42 43 44
import singleton
import tabs
import theming
import timed_events
import windows

from common import safeJID
from config import config, firstrun
from contact import Contact, Resource
from daemon import Executor
from fifo import Fifo
from logger import logger
from plugin_manager import PluginManager
from roster import roster
45
from size_manager import SizeManager
mathieui's avatar
mathieui committed
46 47
from text_buffer import TextBuffer
from theming import get_theme
48
import keyboard
mathieui's avatar
mathieui committed
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66

from . import completions
from . import commands
from . import handlers
from . structs import possible_show, DEPRECATED_ERRORS, \
        ERROR_AND_STATUS_CODES, Command, Status


class Core(object):
    """
    “Main” class of poezion
    """

    def __init__(self):
        # All uncaught exception are given to this callback, instead
        # of being displayed on the screen and exiting the program.
        sys.excepthook = self.on_exception
        self.connection_time = time.time()
67
        self.stdscr = None
68
        status = config.get('status')
mathieui's avatar
mathieui committed
69 70
        status = possible_show.get(status, None)
        self.status = Status(show=status,
71
                message=config.get('status_message'))
mathieui's avatar
mathieui committed
72 73 74
        self.running = True
        self.xmpp = singleton.Singleton(connection.Connection)
        self.xmpp.core = self
75
        self.keyboard = keyboard.Keyboard()
mathieui's avatar
mathieui committed
76 77 78 79 80 81 82 83 84 85
        roster.set_node(self.xmpp.client_roster)
        decorators.refresh_wrapper.core = self
        self.paused = False
        self.event = Event()
        self.debug = False
        self.remote_fifo = None
        # a unique buffer used to store global informations
        # that are displayed in almost all tabs, in an
        # information window.
        self.information_buffer = TextBuffer()
86
        self.information_win_size = config.get('info_win_height', section='var')
mathieui's avatar
mathieui committed
87 88
        self.information_win = windows.TextWin(300)
        self.information_buffer.add_window(self.information_win)
89
        self.left_tab_win = None
mathieui's avatar
mathieui committed
90 91

        self.tab_win = windows.GlobalInfoBar()
92
        # Whether the XML tab is opened
mathieui's avatar
mathieui committed
93 94 95 96 97 98 99
        self.xml_tab = False
        self.xml_buffer = TextBuffer()

        self.tabs = []
        self._current_tab_nb = 0
        self.previous_tab_nb = 0

100
        own_nick = config.get('default_nick')
101 102 103 104
        own_nick = own_nick or self.xmpp.boundjid.user
        own_nick = own_nick or os.environ.get('USER')
        own_nick = own_nick or 'poezio'
        self.own_nick = own_nick
mathieui's avatar
mathieui committed
105 106 107 108 109

        self.plugins_autoloaded = False
        self.plugin_manager = PluginManager(self)
        self.events = events.EventHandler()

110
        self.size = SizeManager(self, windows.Win)
mathieui's avatar
mathieui committed
111

112 113 114 115 116 117 118
        # Set to True whenever we consider that we have been disconnected
        # from the server because of a legitimate reason (bad credentials,
        # or explicit disconnect from the user for example), in that case we
        # should not try to auto-reconnect, even if auto_reconnect is true
        # in the user config.
        self.legitimate_disconnect = False

mathieui's avatar
mathieui committed
119 120 121 122 123 124 125 126 127 128 129
        # global commands, available from all tabs
        # a command is tuple of the form:
        # (the function executing the command. Takes a string as argument,
        #  a string representing the help message,
        #  a completion function, taking a Input as argument. Can be None)
        #  The completion function should return True if a completion was
        #  made ; False otherwise
        self.commands = {}
        self.register_initial_commands()

        # We are invisible
130
        if not config.get('send_initial_presence'):
mathieui's avatar
mathieui committed
131 132 133
            del self.commands['status']
            del self.commands['show']

134 135 136 137 138
        # A list of integers. For example if the user presses Alt+j, 2, 1,
        # we will insert 2, then 1 in that list, and we will finally build
        # the number 21 and use it with command_win, before clearing the
        # list.
        self.room_number_jump = []
mathieui's avatar
mathieui committed
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 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 189 190 191 192 193 194 195 196 197 198
        self.key_func = KeyDict()
        # Key bindings associated with handlers
        # and pseudo-keys used to map actions below.
        key_func = {
            "KEY_PPAGE": self.scroll_page_up,
            "KEY_NPAGE": self.scroll_page_down,
            "^B": self.scroll_line_up,
            "^F": self.scroll_line_down,
            "^X": self.scroll_half_down,
            "^S": self.scroll_half_up,
            "KEY_F(5)": self.rotate_rooms_left,
            "^P": self.rotate_rooms_left,
            "M-[-D": self.rotate_rooms_left,
            'kLFT3': self.rotate_rooms_left,
            "KEY_F(6)": self.rotate_rooms_right,
            "^N": self.rotate_rooms_right,
            "M-[-C": self.rotate_rooms_right,
            'kRIT3': self.rotate_rooms_right,
            "KEY_F(4)": self.toggle_left_pane,
            "KEY_F(7)": self.shrink_information_win,
            "KEY_F(8)": self.grow_information_win,
            "KEY_RESIZE": self.call_for_resize,
            'M-e': self.go_to_important_room,
            'M-r': self.go_to_roster,
            'M-z': self.go_to_previous_tab,
            '^L': self.full_screen_redraw,
            'M-j': self.go_to_room_number,
            'M-D': self.scroll_info_up,
            'M-C': self.scroll_info_down,
            'M-k': self.escape_next_key,
        ######## actions mappings ##########
            '_bookmark': self.command_bookmark,
            '_bookmark_local': self.command_bookmark_local,
            '_close_tab': self.close_tab,
            '_disconnect': self.disconnect,
            '_quit': self.command_quit,
            '_redraw_screen': self.full_screen_redraw,
            '_reload_theme': self.command_theme,
            '_remove_bookmark': self.command_remove_bookmark,
            '_room_left': self.rotate_rooms_left,
            '_room_right': self.rotate_rooms_right,
            '_show_roster': self.go_to_roster,
            '_scroll_down': self.scroll_page_down,
            '_scroll_up': self.scroll_page_up,
            '_scroll_info_up': self.scroll_info_up,
            '_scroll_info_down': self.scroll_info_down,
            '_server_cycle': self.command_server_cycle,
            '_show_bookmarks': self.command_bookmarks,
            '_show_important_room': self.go_to_important_room,
            '_show_invitations': self.command_invitations,
            '_show_plugins': self.command_plugins,
            '_show_xmltab': self.command_xml_tab,
            '_toggle_pane': self.toggle_left_pane,
        ###### status actions ######
            '_available': lambda: self.command_status('available'),
            '_away': lambda: self.command_status('away'),
            '_chat': lambda: self.command_status('chat'),
            '_dnd': lambda: self.command_status('dnd'),
            '_xa': lambda: self.command_status('xa'),
        ##### Custom actions ########
mathieui's avatar
mathieui committed
199
            '_exc_': self.try_execute,
mathieui's avatar
mathieui committed
200 201 202 203
        }
        self.key_func.update(key_func)

        # Add handlers
204
        self.xmpp.add_event_handler('connecting', self.on_connecting)
mathieui's avatar
mathieui committed
205
        self.xmpp.add_event_handler('connected', self.on_connected)
206
        self.xmpp.add_event_handler('connection_failed', self.on_failed_connection)
mathieui's avatar
mathieui committed
207
        self.xmpp.add_event_handler('disconnected', self.on_disconnected)
208
        self.xmpp.add_event_handler('failed_all_auth', self.on_failed_all_auth)
mathieui's avatar
mathieui committed
209 210
        self.xmpp.add_event_handler('no_auth', self.on_no_auth)
        self.xmpp.add_event_handler("session_start", self.on_session_start)
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226
        self.xmpp.add_event_handler("session_start",
                                    self.on_session_start_features)
        self.xmpp.add_event_handler("groupchat_presence",
                                    self.on_groupchat_presence)
        self.xmpp.add_event_handler("groupchat_message",
                                    self.on_groupchat_message)
        self.xmpp.add_event_handler("groupchat_invite",
                                    self.on_groupchat_invitation)
        self.xmpp.add_event_handler("groupchat_direct_invite",
                                    self.on_groupchat_direct_invitation)
        self.xmpp.add_event_handler("groupchat_decline",
                                    self.on_groupchat_decline)
        self.xmpp.add_event_handler("groupchat_config_status",
                                    self.on_status_codes)
        self.xmpp.add_event_handler("groupchat_subject",
                                    self.on_groupchat_subject)
mathieui's avatar
mathieui committed
227
        self.xmpp.add_event_handler("message", self.on_message)
228
        self.xmpp.add_event_handler("receipt_received", self.on_receipt)
mathieui's avatar
mathieui committed
229 230
        self.xmpp.add_event_handler("got_online", self.on_got_online)
        self.xmpp.add_event_handler("got_offline", self.on_got_offline)
mathieui's avatar
mathieui committed
231 232 233
        self.xmpp.add_event_handler("roster_update", self.on_roster_update)
        self.xmpp.add_event_handler("changed_status", self.on_presence)
        self.xmpp.add_event_handler("presence_error", self.on_presence_error)
234 235 236 237 238 239 240 241
        self.xmpp.add_event_handler("roster_subscription_request",
                                    self.on_subscription_request)
        self.xmpp.add_event_handler("roster_subscription_authorized",
                                    self.on_subscription_authorized)
        self.xmpp.add_event_handler("roster_subscription_remove",
                                    self.on_subscription_remove)
        self.xmpp.add_event_handler("roster_subscription_removed",
                                    self.on_subscription_removed)
mathieui's avatar
mathieui committed
242
        self.xmpp.add_event_handler("message_xform", self.on_data_form)
243 244 245 246 247 248 249 250 251 252
        self.xmpp.add_event_handler("chatstate_active",
                                    self.on_chatstate_active)
        self.xmpp.add_event_handler("chatstate_composing",
                                    self.on_chatstate_composing)
        self.xmpp.add_event_handler("chatstate_paused",
                                    self.on_chatstate_paused)
        self.xmpp.add_event_handler("chatstate_gone",
                                    self.on_chatstate_gone)
        self.xmpp.add_event_handler("chatstate_inactive",
                                    self.on_chatstate_inactive)
mathieui's avatar
mathieui committed
253 254
        self.xmpp.add_event_handler("attention", self.on_attention)
        self.xmpp.add_event_handler("ssl_cert", self.validate_ssl)
255 256 257
        self.all_stanzas = Callback('custom matcher',
                                    connection.MatchAll(None),
                                    self.incoming_stanza)
mathieui's avatar
mathieui committed
258
        self.xmpp.register_handler(self.all_stanzas)
259
        if config.get('enable_user_tune'):
260 261
            self.xmpp.add_event_handler("user_tune_publish",
                                        self.on_tune_event)
262
        if config.get('enable_user_nick'):
263 264
            self.xmpp.add_event_handler("user_nick_publish",
                                        self.on_nick_received)
265
        if config.get('enable_user_mood'):
266 267
            self.xmpp.add_event_handler("user_mood_publish",
                                        self.on_mood_event)
268
        if config.get('enable_user_activity'):
269 270
            self.xmpp.add_event_handler("user_activity_publish",
                                        self.on_activity_event)
271
        if config.get('enable_user_gaming'):
272 273
            self.xmpp.add_event_handler("user_gaming_publish",
                                        self.on_gaming_event)
mathieui's avatar
mathieui committed
274 275 276 277 278 279 280 281 282 283 284 285 286

        self.initial_joins = []

        self.connected_events = {}

        self.pending_invites = {}

        # a dict of the form {'config_option': [list, of, callbacks]}
        # Whenever a configuration option is changed (using /set or by
        # reloading a new config using a signal), all the associated
        # callbacks are triggered.
        # Use Core.add_configuration_handler("option", callback) to add a
        # handler
287 288
        # Note that the callback will be called when it’s changed in the
        # global section, OR in a special section.
mathieui's avatar
mathieui committed
289 290 291 292 293
        # As a special case, handlers can be associated with the empty
        # string option (""), they will be called for every option change
        # The callback takes two argument: the config option, and the new
        # value
        self.configuration_change_handlers = {"": []}
294 295
        self.add_configuration_handler("create_gaps",
                                       self.on_gaps_config_change)
296 297 298 299
        self.add_configuration_handler("request_message_receipts",
                                       self.on_request_receipts_config_change)
        self.add_configuration_handler("ack_message_receipts",
                                       self.on_ack_receipts_config_change)
300 301 302 303 304 305 306 307 308 309 310 311
        self.add_configuration_handler("plugins_dir",
                                       self.on_plugins_dir_config_change)
        self.add_configuration_handler("plugins_conf_dir",
                                       self.on_plugins_conf_dir_config_change)
        self.add_configuration_handler("connection_timeout_delay",
                                       self.xmpp.set_keepalive_values)
        self.add_configuration_handler("connection_check_interval",
                                       self.xmpp.set_keepalive_values)
        self.add_configuration_handler("themes_dir",
                                       theming.update_themes_dir)
        self.add_configuration_handler("theme",
                                       self.on_theme_config_change)
312 313
        self.add_configuration_handler("password",
                                       self.on_password_change)
314

mathieui's avatar
mathieui committed
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
        self.add_configuration_handler("", self.on_any_config_change)

    def on_any_config_change(self, option, value):
        """
        Update the roster, in case a roster option changed.
        """
        roster.modified()

    def add_configuration_handler(self, option, callback):
        """
        Add a callback, associated with the given option. It will be called
        each time the configuration option is changed using /set or by
        reloading the configuration with a signal
        """
        if option not in self.configuration_change_handlers:
            self.configuration_change_handlers[option] = []
        self.configuration_change_handlers[option].append(callback)

    def trigger_configuration_change(self, option, value):
        """
        Triggers all the handlers associated with the given configuration
        option
        """
        # First call the callbacks associated with any configuration change
        for callback in self.configuration_change_handlers[""]:
            callback(option, value)
        # and then the callbacks associated with this specific option, if
        # any
        if option not in self.configuration_change_handlers:
            return
        for callback in self.configuration_change_handlers[option]:
            callback(option, value)

    def on_gaps_config_change(self, option, value):
        """
        Called when the option create_gaps is changed.
        Remove all gaptabs if switching from gaps to nogaps.
        """
        if value.lower() == "false":
354
            self.tabs = list(tab for tab in self.tabs if tab)
mathieui's avatar
mathieui committed
355

356 357 358 359
    def on_request_receipts_config_change(self, option, value):
        """
        Called when the request_message_receipts option changes
        """
360 361
        self.xmpp.plugin['xep_0184'].auto_request = config.get(option,
                                                               default=True)
362 363 364 365 366

    def on_ack_receipts_config_change(self, option, value):
        """
        Called when the ack_message_receipts option changes
        """
367
        self.xmpp.plugin['xep_0184'].auto_ack = config.get(option, default=True)
368

mathieui's avatar
mathieui committed
369 370 371 372 373 374 375 376 377 378 379 380 381 382
    def on_plugins_dir_config_change(self, option, value):
        """
        Called when the plugins_dir option is changed
        """
        path = os.path.expanduser(value)
        self.plugin_manager.on_plugins_dir_change(path)

    def on_plugins_conf_dir_config_change(self, option, value):
        """
        Called when the plugins_conf_dir option is changed
        """
        path = os.path.expanduser(value)
        self.plugin_manager.on_plugins_conf_dir_change(path)

383 384 385 386 387 388 389 390 391
    def on_theme_config_change(self, option, value):
        """
        Called when the theme option is changed
        """
        error_msg = theming.reload_theme()
        if error_msg:
            self.information(error_msg, 'Warning')
        self.refresh_window()

392 393 394 395 396 397
    def on_password_change(self, option, value):
        """
        Set the new password in the slixmpp.ClientXMPP object
        """
        self.xmpp.password = value

mathieui's avatar
mathieui committed
398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
    def sigusr_handler(self, num, stack):
        """
        Handle SIGUSR1 (10)
        When caught, reload all the possible files.
        """
        log.debug("SIGUSR1 caught, reloading the files…")
        # reload all log files
        log.debug("Reloading the log files…")
        logger.reload_all()
        log.debug("Log files reloaded.")
        # reload the theme
        log.debug("Reloading the theme…")
        self.command_theme("")
        log.debug("Theme reloaded.")
        # reload the config from the disk
        log.debug("Reloading the config…")
        # Copy the old config in a dict
        old_config = config.to_dict()
416
        config.read_file()
mathieui's avatar
mathieui committed
417 418 419 420 421 422
        # Compare old and current config, to trigger the callbacks of all
        # modified options
        for section in config.sections():
            old_section = old_config.get(section, {})
            for option in config.options(section):
                old_value = old_section.get(option)
423
                new_value = config.get(option, default="", section=section)
mathieui's avatar
mathieui committed
424 425 426 427 428 429 430 431
                if new_value != old_value:
                    self.trigger_configuration_change(option, new_value)
        log.debug("Config reloaded.")
        # in case some roster options have changed
        roster.modified()

    def exit_from_signal(self, *args, **kwargs):
        """
432
        Quit when receiving SIGHUP or SIGTERM or SIGPIPE
mathieui's avatar
mathieui committed
433 434 435 436

        do not save the config because it is not a normal exit
        (and only roster UI things are not yet saved)
        """
437 438 439 440 441 442 443 444
        sig = args[0]
        signals = {
                1: 'SIGHUP',
                13: 'SIGPIPE',
                15: 'SIGTERM',
                }

        log.error("%s received. Exiting…", signals[sig])
445
        if config.get('enable_user_mood'):
446
            self.xmpp.plugin['xep_0107'].stop()
447
        if config.get('enable_user_activity'):
448
            self.xmpp.plugin['xep_0108'].stop()
449
        if config.get('enable_user_gaming'):
450
            self.xmpp.plugin['xep_0196'].stop()
mathieui's avatar
mathieui committed
451
        self.plugin_manager.disable_plugins()
452 453
        self.disconnect('%s received' % signals.get(sig))
        self.xmpp.add_event_handler("disconnected", self.exit, disposable=True)
mathieui's avatar
mathieui committed
454 455 456 457 458

    def autoload_plugins(self):
        """
        Load the plugins on startup.
        """
459
        plugins = config.get('plugins_autoload')
mathieui's avatar
mathieui committed
460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477
        if ':' in plugins:
            for plugin in plugins.split(':'):
                self.plugin_manager.load(plugin)
        else:
            for plugin in plugins.split():
                self.plugin_manager.load(plugin)
        self.plugins_autoloaded = True

    def start(self):
        """
        Init curses, create the first tab, etc
        """
        self.stdscr = curses.initscr()
        self.init_curses(self.stdscr)
        self.call_for_resize()
        default_tab = tabs.RosterInfoTab()
        default_tab.on_gain_focus()
        self.tabs.append(default_tab)
478
        self.information(_('Welcome to poezio!'), _('Info'))
mathieui's avatar
mathieui committed
479 480 481
        if firstrun:
            self.information(_(
                'It seems that it is the first time you start poezio.\n'
482 483 484 485 486
                'The online help is here http://doc.poez.io/\n'
                'No room is joined by default, but you can join poezio’s'
                'chatroom (with /join poezio@muc.poez.io), where you can'
                ' ask for help or tell us how great it is.'),
                _('Help'))
mathieui's avatar
mathieui committed
487
        self.refresh_window()
louiz’'s avatar
louiz’ committed
488
        self.xmpp.plugin['xep_0012'].begin_idle(jid=self.xmpp.boundjid)
mathieui's avatar
mathieui committed
489

490 491 492 493
    def exit(self, event=None):
        log.debug("exit(%s)" % (event,))
        asyncio.get_event_loop().stop()

mathieui's avatar
mathieui committed
494 495 496 497 498 499 500 501 502 503 504
    def on_exception(self, typ, value, trace):
        """
        When an exception is raised, just reset curses and call
        the original exception handler (will nicely print the traceback)
        """
        try:
            self.reset_curses()
        except:
            pass
        sys.__excepthook__(typ, value, trace)

505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525
    def sigwinch_handler(self):
        """A work-around for ncurses resize stuff, which sucks. Normally, ncurses
        catches SIGWINCH itself. In its signal handler, it updates the
        windows structures (for example the size, etc) and it
        ungetch(KEY_RESIZE). That way, the next time we call getch() we know
        that a resize occured and we can act on it. BUT poezio doesn’t call
        getch() until it knows it will return something. The problem is we
        can’t know that, because stdin is not affected by this KEY_RESIZE
        value (it is only inserted in a ncurses internal fifo that we can’t
        access).

        The (ugly) solution is to handle SIGWINCH ourself, trigger the
        change of the internal windows sizes stored in ncurses module, using
        sizes that we get using shutil, ungetch the KEY_RESIZE value and
        then call getch to handle the resize on poezio’s side properly.
        """
        size = shutil.get_terminal_size()
        curses.resizeterm(size.lines, size.columns)
        curses.ungetch(curses.KEY_RESIZE)
        self.on_input_readable()

louiz’'s avatar
louiz’ committed
526
    def on_input_readable(self):
mathieui's avatar
mathieui committed
527 528 529 530
        """
        main loop waiting for the user to press a key
        """
        def replace_line_breaks(key):
531
            "replace ^J with \n"
mathieui's avatar
mathieui committed
532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551
            if key == '^J':
                return '\n'
            return key
        def separate_chars_from_bindings(char_list):
            """
            returns a list of lists. For example if you give
            ['a', 'b', 'KEY_BACKSPACE', 'n', 'u'], this function returns
            [['a', 'b'], ['KEY_BACKSPACE'], ['n', 'u']]

            This way, in case of lag (for example), we handle the typed text
            by “batch” as much as possible (instead of one char at a time,
            which implies a refresh after each char, which is very slow),
            but we still handle the special chars (backspaces, arrows,
            ctrl+x ou alt+x, etc) one by one, which avoids the issue of
            printing them OR ignoring them in that case.  This should
            resolve the “my ^W are ignored when I lag ;(”.
            """
            res = []
            current = []
            for char in char_list:
552
                assert char
mathieui's avatar
mathieui committed
553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572
                # Transform that stupid char into what we actually meant
                if char == '\x1f':
                    char = '^/'
                if len(char) == 1:
                    current.append(char)
                else:
                    # special case for the ^I key, it’s considered as \t
                    # only when pasting some text, otherwise that’s the ^I
                    # (or M-i) key, which stands for completion by default.
                    if char == '^I' and len(char_list) != 1:
                        current.append('\t')
                        continue
                    if current:
                        res.append(current)
                        current = []
                    res.append([char])
            if current:
                res.append(current)
            return res

louiz’'s avatar
louiz’ committed
573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592
        log.debug("Input is readable.")
        big_char_list = [replace_key_with_bound(key)\
                         for key in self.read_keyboard()]
        log.debug("Got from keyboard: %s", (big_char_list,))

        # whether to refresh after ALL keys have been handled
        for char_list in separate_chars_from_bindings(big_char_list):
            if self.paused:
                self.current_tab().input.do_command(char_list[0])
                self.current_tab().input.prompt()
                self.event.set()
                continue
            # Special case for M-x where x is a number
            if len(char_list) == 1:
                char = char_list[0]
                if char.startswith('M-') and len(char) == 3:
                    try:
                        nb = int(char[2])
                    except ValueError:
                        pass
mathieui's avatar
mathieui committed
593
                    else:
louiz’'s avatar
louiz’ committed
594 595 596 597 598 599 600 601
                        if self.current_tab().nb == nb:
                            self.go_to_previous_tab()
                        else:
                            self.command_win('%d' % nb)
                # search for keyboard shortcut
                func = self.key_func.get(char, None)
                if func:
                    func()
mathieui's avatar
mathieui committed
602
                else:
louiz’'s avatar
louiz’ committed
603 604 605
                    self.do_command(replace_line_breaks(char), False)
            else:
                self.do_command(''.join(char_list), True)
606 607
        if self.status.show not in ('xa', 'away'):
            self.xmpp.plugin['xep_0012'].begin_idle(jid=self.xmpp.boundjid)
608
        self.doupdate()
mathieui's avatar
mathieui committed
609 610 611 612 613

    def save_config(self):
        """
        Save config in the file just before exit
        """
614 615 616 617 618 619 620 621
        ok = roster.save_to_config_file()
        ok = ok and config.silent_set('info_win_height',
                                      self.information_win_size,
                                      'var')
        if not ok:
            self.information(_('Unable to save runtime preferences'
                               ' in the config file'),
                             _('Error'))
mathieui's avatar
mathieui committed
622 623 624 625 626 627 628 629 630 631 632

    def on_roster_enter_key(self, roster_row):
        """
        when enter is pressed on the roster window
        """
        if isinstance(roster_row, Contact):
            if not self.get_conversation_by_jid(roster_row.bare_jid, False):
                self.open_conversation_window(roster_row.bare_jid)
            else:
                self.focus_tab_named(roster_row.bare_jid)
        if isinstance(roster_row, Resource):
633 634 635
            if not self.get_conversation_by_jid(roster_row.jid,
                                                False,
                                                fallback_barejid=False):
mathieui's avatar
mathieui committed
636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676
                self.open_conversation_window(roster_row.jid)
            else:
                self.focus_tab_named(roster_row.jid)
        self.refresh_window()

    def get_conversation_messages(self):
        """
        Returns a list of all the messages in the current chat.
        If the current tab is not a ChatTab, returns None.

        Messages are namedtuples of the form
        ('txt nick_color time str_time nickname user')
        """
        if not isinstance(self.current_tab(), tabs.ChatTab):
            return None
        return self.current_tab().get_conversation_messages()

    def insert_input_text(self, text):
        """
        Insert the given text into the current input
        """
        self.do_command(text, True)


##################### Anything related to command execution ###################

    def execute(self, line):
        """
        Execute the /command or just send the line on the current room
        """
        if line == "":
            return
        if line.startswith('/'):
            command = line.strip()[:].split()[0][1:]
            arg = line[2+len(command):] # jump the '/' and the ' '
            # example. on "/link 0 open", command = "link" and arg = "0 open"
            if command in self.commands:
                func = self.commands[command][0]
                func(arg)
                return
            else:
677 678
                self.information(_("Unknown command (%s)") % (command),
                                 _('Error'))
mathieui's avatar
mathieui committed
679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707

    def exec_command(self, command):
        """
        Execute an external command on the local or a remote machine,
        depending on the conf. For example, to open a link in a browser, do
        exec_command(["firefox", "http://poezio.eu"]), and this will call
        the command on the correct computer.

        The command argument is a list of strings, not quoted or escaped in
        any way. The escaping is done here if needed.

        The remote execution is done
        by writing the command on a fifo.  That fifo has to be on the
        machine where poezio is running, and accessible (through sshfs for
        example) from the local machine (where poezio is not running). A
        very simple daemon (daemon.py) reads on that fifo, and executes any
        command that is read in it. Since we can only write strings to that
        fifo, each argument has to be pipes.quote()d. That way the
        shlex.split on the reading-side of the daemon will be safe.

        You cannot use a real command line with pipes, redirections etc, but
        this function supports a simple case redirection to file: if the
        before-last argument of the command is ">" or ">>", then the last
        argument is considered to be a filename where the command stdout
        will be written. For example you can do exec_command(["echo",
        "coucou les amis coucou coucou", ">", "output.txt"]) and this will
        work. If you try to do anything else, your |, [, <<, etc will be
        interpreted as normal command arguments, not shell special tokens.
        """
708
        if config.get('exec_remote'):
mathieui's avatar
mathieui committed
709
            # We just write the command in the fifo
710
            fifo_path = config.get('remote_fifo_path')
mathieui's avatar
mathieui committed
711 712
            if not self.remote_fifo:
                try:
713 714 715 716
                    self.remote_fifo = Fifo(os.path.join(fifo_path,
                                                         'poezio.fifo'),
                                            'w')
                except (OSError, IOError) as exc:
mathieui's avatar
mathieui committed
717
                    log.error('Could not open the fifo for writing (%s)',
718 719 720 721 722
                               os.path.join(fifo_path, './', 'poezio.fifo'),
                               exc_info=True)
                    self.information('Could not open the fifo '
                                     'file for writing: %s' % exc,
                                     'Error')
mathieui's avatar
mathieui committed
723
                    return
724 725 726

            args = (pipes.quote(arg.replace('\n', ' ')) for arg in command)
            command_str = ' '.join(args) + '\n'
mathieui's avatar
mathieui committed
727 728
            try:
                self.remote_fifo.write(command_str)
729
            except (IOError) as exc:
mathieui's avatar
mathieui committed
730
                log.error('Could not write in the fifo (%s): %s',
731
                            os.path.join(fifo_path, './', 'poezio.fifo'),
mathieui's avatar
mathieui committed
732 733
                            repr(command),
                            exc_info=True)
734 735
                self.information('Could not execute %s: %s' % (command, exc),
                                 'Error')
mathieui's avatar
mathieui committed
736 737
                self.remote_fifo = None
        else:
738
            executor = Executor(command)
mathieui's avatar
mathieui committed
739
            try:
740 741 742 743 744 745
                executor.start()
            except ValueError as exc:
                log.error('Could not execute command (%s)',
                          repr(command),
                          exc_info=True)
                self.information('%s' % exc, 'Error')
mathieui's avatar
mathieui committed
746 747 748


    def do_command(self, key, raw):
749 750
        """
        Execute the action associated with a key
751 752 753

        Or if keyboard.continuation_keys_callback is set, call it instead. See
        the comment of this variable.
754
        """
mathieui's avatar
mathieui committed
755 756
        if not key:
            return
757 758 759 760 761 762 763 764 765
        if keyboard.continuation_keys_callback is not None:
            # Reset the callback to None BEFORE calling it, because this
            # callback MAY set a new callback itself, and we don’t want to
            # erase it in that case
            cb = keyboard.continuation_keys_callback
            keyboard.continuation_keys_callback = None
            cb(key)
        else:
            self.current_tab().on_input(key, raw)
mathieui's avatar
mathieui committed
766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782


    def try_execute(self, line):
        """
        Try to execute a command in the current tab
        """
        line = '/' + line
        try:
            self.current_tab().execute_command(line)
        except:
            log.error('Execute failed (%s)', line, exc_info=True)


########################## TImed Events #######################################

    def remove_timed_event(self, event):
        """Remove an existing timed event"""
783
        event.handler.cancel()
mathieui's avatar
mathieui committed
784 785 786

    def add_timed_event(self, event):
        """Add a new timed event"""
787 788 789
        event.handler = asyncio.get_event_loop().call_later(event.delay,
                                                            event.callback,
                                                            *event.args)
mathieui's avatar
mathieui committed
790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805

####################### XMPP-related actions ##################################

    def get_status(self):
        """
        Get the last status that was previously set
        """
        return self.status

    def set_status(self, pres, msg):
        """
        Set our current status so we can remember
        it and use it back when needed (for example to display it
        or to use it when joining a new muc)
        """
        self.status = Status(show=pres, message=msg)
806
        if config.get('save_status'):
807 808 809 810 811 812
            ok = config.silent_set('status', pres if pres else '')
            msg = msg.replace('\n', '|') if msg else ''
            ok = ok and config.silent_set('status_message', msg)
            if not ok:
                self.information(_('Unable to save the status in '
                                   'the config file'), 'Error')
mathieui's avatar
mathieui committed
813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828

    def get_bookmark_nickname(self, room_name):
        """
        Returns the nickname associated with a bookmark
        or the default nickname
        """
        bm = bookmark.get_by_jid(room_name)
        if bm:
            return bm.nick
        return self.own_nick

    def disconnect(self, msg='', reconnect=False):
        """
        Disconnect from remote server and correctly set the states of all
        parts of the client (for example, set the MucTabs as not joined, etc)
        """
829
        self.legitimate_disconnect = True
mathieui's avatar
mathieui committed
830 831 832 833 834
        msg = msg or ''
        for tab in self.get_tabs(tabs.MucTab):
            tab.command_part(msg)
        self.xmpp.disconnect()
        if reconnect:
835 836 837
            # Add a one-time event to reconnect as soon as we are
            # effectively disconnected
            self.xmpp.add_event_handler('disconnected', lambda event: self.xmpp.connect(), disposable=True)
mathieui's avatar
mathieui committed
838 839 840

    def send_message(self, msg):
        """
841 842
        Function to use in plugins to send a message in the current
        conversation.
mathieui's avatar
mathieui committed
843 844 845 846 847 848 849
        Returns False if the current tab is not a conversation tab
        """
        if not isinstance(self.current_tab(), tabs.ChatTab):
            return False
        self.current_tab().command_say(msg)
        return True

850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867
    def invite(self, jid, room, reason=None):
        """
        Checks if the sender supports XEP-0249, then send an invitation,
        or a mediated one if it does not.
        TODO: allow passwords
        """
        def callback(iq):
            if not iq:
                return
            if 'jabber:x:conference' in iq['disco_info'].get_features():
                self.xmpp.plugin['xep_0249'].send_invitation(
                        jid,
                        room,
                        reason=reason)
            else: # fallback
                self.xmpp.plugin['xep_0045'].invite(room, jid,
                        reason=reason or '')

868 869
        self.xmpp.plugin['xep_0030'].get_info(jid=jid, timeout=5,
                                              callback=callback)
870

mathieui's avatar
mathieui committed
871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892
    def get_error_message(self, stanza, deprecated=False):
        """
        Takes a stanza of the form <message type='error'><error/></message>
        and return a well formed string containing the error informations
        """
        sender = stanza.attrib['from']
        msg = stanza['error']['type']
        condition = stanza['error']['condition']
        code = stanza['error']['code']
        body = stanza['error']['text']
        if not body:
            if deprecated:
                if code in DEPRECATED_ERRORS:
                    body = DEPRECATED_ERRORS[code]
                else:
                    body = condition or _('Unknown error')
            else:
                if code in ERROR_AND_STATUS_CODES:
                    body = ERROR_AND_STATUS_CODES[code]
                else:
                    body = condition or _('Unknown error')
        if code:
893 894
            message = _('%(from)s: %(code)s - %(msg)s: %(body)s') % {
                    'from': sender, 'msg': msg, 'body': body, 'code': code}
mathieui's avatar
mathieui committed
895
        else:
896 897
            message = _('%(from)s: %(msg)s: %(body)s') % {
                    'from': sender, 'msg': msg, 'body': body}
mathieui's avatar
mathieui committed
898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925
        return message


####################### Tab logic-related things ##############################

    ### Tab getters ###

    def get_tabs(self, cls=tabs.Tab):
        "Get all the tabs of a type"
        return filter(lambda tab: isinstance(tab, cls), self.tabs)

    def current_tab(self):
        """
        returns the current room, the one we are viewing
        """
        self.current_tab_nb = self.current_tab_nb
        return self.tabs[self.current_tab_nb]

    def get_conversation_by_jid(self, jid, create=True, fallback_barejid=True):
        """
        From a JID, get the tab containing the conversation with it.
        If none already exist, and create is "True", we create it
        and return it. Otherwise, we return None.

        If fallback_barejid is True, then this method will seek other
        tabs with the same barejid, instead of searching only by fulljid.
        """
        jid = safeJID(jid)
926 927 928 929
        # We first check if we have a static conversation opened
        # with this precise resource
        conversation = self.get_tab_by_name(jid.full,
                                            tabs.StaticConversationTab)
mathieui's avatar
mathieui committed
930
        if jid.bare == jid.full and not conversation:
931 932
            conversation = self.get_tab_by_name(jid.full,
                                                tabs.DynamicConversationTab)
mathieui's avatar
mathieui committed
933 934 935

        if not conversation and fallback_barejid:
            # If not, we search for a conversation with the bare jid
936 937
            conversation = self.get_tab_by_name(jid.bare,
                                                tabs.DynamicConversationTab)
mathieui's avatar
mathieui committed
938 939 940 941 942
            if not conversation:
                if create:
                    # We create a dynamic conversation with the bare Jid if
                    # nothing was found (and we lock it to the resource
                    # later)
943 944
                    conversation = self.open_conversation_window(jid.bare,
                                                                 False)
mathieui's avatar
mathieui committed
945 946 947 948 949 950 951 952 953 954
                else:
                    conversation = None
        return conversation

    def get_tab_by_name(self, name, typ=None):
        """
        Get the tab with the given name.
        If typ is provided, return a tab of this type only
        """
        for tab in self.tabs:
955
            if tab.name == name:
mathieui's avatar
mathieui committed
956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001
                if (typ and isinstance(tab, typ)) or\
                        not typ:
                    return tab
        return None

    def get_tab_by_number(self, number):
        if 0 <= number < len(self.tabs):
            return self.tabs[number]
        return None

    def add_tab(self, new_tab, focus=False):
        """
        Appends the new_tab in the tab list and
        focus it if focus==True
        """
        self.tabs.append(new_tab)
        if focus:
            self.command_win("%s" % new_tab.nb)

    def insert_tab_nogaps(self, old_pos, new_pos):
        """
        Move tabs without creating gaps
        old_pos: old position of the tab
        new_pos: desired position of the tab
        """
        tab = self.tabs[old_pos]
        if new_pos < old_pos:
            self.tabs.pop(old_pos)
            self.tabs.insert(new_pos, tab)
        elif new_pos > old_pos:
            self.tabs.insert(new_pos, tab)
            self.tabs.remove(tab)
        else:
            return False
        return True

    def insert_tab_gaps(self, old_pos, new_pos):
        """
        Move tabs and create gaps in the eventual remaining space
        old_pos: old position of the tab
        new_pos: desired position of the tab
        """
        tab = self.tabs[old_pos]
        target = None if new_pos >= len(self.tabs) else self.tabs[new_pos]
        if not target:
            if new_pos < len(self.tabs):
1002 1003
                old_tab = self.tabs[old_pos]
                self.tabs[new_pos], self.tabs[old_pos] = old_tab, tabs.GapTab()
mathieui's avatar
mathieui committed
1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042
            else:
                self.tabs.append(self.tabs[old_pos])
                self.tabs[old_pos] = tabs.GapTab()
        else:
            if new_pos > old_pos:
                self.tabs.insert(new_pos, tab)
                self.tabs[old_pos] = tabs.GapTab()
            elif new_pos < old_pos:
                self.tabs[old_pos] = tabs.GapTab()
                self.tabs.insert(new_pos, tab)
            else:
                return False
            i = self.tabs.index(tab)
            done = False
            # Remove the first Gap on the right in the list
            # in order to prevent global shifts when there is empty space
            while not done:
                i += 1
                if i >= len(self.tabs):
                    done = True
                elif not self.tabs[i]:
                    self.tabs.pop(i)
                    done = True
        # Remove the trailing gaps
        i = len(self.tabs) - 1
        while isinstance(self.tabs[i], tabs.GapTab):
            self.tabs.pop()
            i -= 1
        return True

    def insert_tab(self, old_pos, new_pos=99999):
        """
        Insert a tab at a position, changing the number of the following tabs
        returns False if it could not move the tab, True otherwise
        """
        if old_pos <= 0 or old_pos >= len(self.tabs):
            return False
        elif new_pos <= 0:
            return False
mathieui's avatar
mathieui committed
1043
        elif new_pos == old_pos:
mathieui's avatar
mathieui committed
1044 1045 1046
            return False
        elif not self.tabs[old_pos]:
            return False
1047
        if config.get('create_gaps'):
mathieui's avatar
mathieui committed
1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079
            return self.insert_tab_gaps(old_pos, new_pos)
        return self.insert_tab_nogaps(old_pos, new_pos)

    ### Move actions (e.g. go to next room) ###

    def rotate_rooms_right(self, args=None):
        """
        rotate the rooms list to the right
        """
        self.current_tab().on_lose_focus()
        self.current_tab_nb += 1
        while not self.tabs[self.current_tab_nb]:
            self.current_tab_nb += 1
        self.current_tab().on_gain_focus()
        self.refresh_window()

    def rotate_rooms_left(self, args=None):
        """
        rotate the rooms list to the right
        """
        self.current_tab().on_lose_focus()
        self.current_tab_nb -= 1
        while not self.tabs[self.current_tab_nb]:
            self.current_tab_nb -= 1
        self.current_tab().on_gain_focus()
        self.refresh_window()

    def go_to_room_number(self):
        """
        Read 2 more chars and go to the tab
        with the given number
        """
1080 1081 1082 1083 1084 1085 1086
        def read_next_digit(digit):
            try:
                nb = int(digit)
            except ValueError:
                # If it is not a number, we do nothing. If it was the first
                # one, we do not wait for a second one by re-setting the
                # callback
1087
                self.room_number_jump.clear()
1088 1089 1090 1091 1092 1093 1094 1095 1096 1097
            else:
                self.room_number_jump.append(digit)
                if len(self.room_number_jump) == 2:
                    arg = "".join(self.room_number_jump)
                    self.room_number_jump.clear()
                    self.command_win(arg)
                else:
                    # We need to read more digits
                    keyboard.continuation_keys_callback = read_next_digit
        keyboard.continuation_keys_callback = read_next_digit
mathieui's avatar
mathieui committed
1098 1099

    def go_to_roster(self):
1100
        "Select the roster as the current tab"
mathieui's avatar
mathieui committed
1101 1102 1103
        self.command_win('0')

    def go_to_previous_tab(self):
1104
        "Go to the previous tab"
mathieui's avatar
mathieui committed
1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123
        self.command_win('%s' % (self.previous_tab_nb,))

    def go_to_important_room(self):
        """
        Go to the next room with activity, in the order defined in the
        dict tabs.STATE_PRIORITY
        """
        # shortcut
        priority = tabs.STATE_PRIORITY
        tab_refs = {}
        # put all the active tabs in a dict of lists by state
        for tab in self.tabs:
            if not tab:
                continue
            if tab.state not in tab_refs:
                tab_refs[tab.state] = [tab]
            else:
                tab_refs[tab.state].append(tab)
        # sort the state by priority and remove those with negative priority
1124 1125 1126
        states = sorted(tab_refs.keys(),
                        key=(lambda x: priority.get(x, 0)),
                        reverse=True)
mathieui's avatar
mathieui committed
1127 1128 1129 1130
        states = [state for state in states if priority.get(state, -1) >= 0]

        for state in states:
            for tab in tab_refs[state]:
1131 1132
                if (tab.nb < self.current_tab_nb and
                    tab_refs[state][-1].nb > self.current_tab_nb):
mathieui's avatar
mathieui committed
1133 1134 1135 1136 1137 1138 1139 1140
                    continue
                self.command_win('%s' % tab.nb)
                return
        return

    def focus_tab_named(self, tab_name, type_=None):
        """Returns True if it found a tab to focus on"""
        for tab in self.tabs:
1141
            if tab.name == tab_name:
mathieui's avatar
mathieui committed
1142 1143 1144 1145 1146 1147 1148
                if (type_ and (isinstance(tab, type_))) or not type_:
                    self.command_win('%s' % (tab.nb,))
                return True
        return False

    @property
    def current_tab_nb(self):
1149
        """Wrapper for the current tab number"""
mathieui's avatar
mathieui committed
1150 1151 1152 1153
        return self._current_tab_nb

    @current_tab_nb.setter
    def current_tab_nb(self, value):
1154 1155 1156 1157
        """
        Prevents the tab number from going over the total number of opened
        tabs, or under 0
        """
mathieui's avatar
mathieui committed
1158
        old = self._current_tab_nb
mathieui's avatar
mathieui committed
1159 1160 1161 1162 1163 1164
        if value >= len(self.tabs):
            self._current_tab_nb = 0
        elif value < 0:
            self._current_tab_nb = len(self.tabs) - 1
        else:
            self._current_tab_nb = value
mathieui's avatar
mathieui committed
1165 1166
        if old != self._current_tab_nb:
            self.events.trigger('tab_change', old, self._current_tab_nb)
mathieui's avatar
mathieui committed
1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192

    ### Opening actions ###

    def open_conversation_window(self, jid, focus=True):
        """
        Open a new conversation tab and focus it if needed. If a resource is
        provided, we open a StaticConversationTab, else a
        DynamicConversationTab
        """
        if safeJID(jid).resource:
            new_tab = tabs.StaticConversationTab(jid)
        else:
            new_tab = tabs.DynamicConversationTab(jid)
        if not focus:
            new_tab.state = "private"
        self.add_tab(new_tab, focus)
        self.refresh_window()
        return new_tab

    def open_private_window(self, room_name, user_nick, focus=True):
        """
        Open a Private conversation in a MUC and focus if needed.
        """
        complete_jid = room_name+'/'+user_nick
        # if the room exists, focus it and return
        for tab in self.get_tabs(tabs.PrivateTab):
1193
            if tab.name == complete_jid:
mathieui's avatar
mathieui committed
1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224
                self.command_win('%s' % tab.nb)
                return tab
        # create the new tab
        tab = self.get_tab_by_name(room_name, tabs.MucTab)
        if not tab:
            return None
        new_tab = tabs.PrivateTab(complete_jid, tab.own_nick)
        if hasattr(tab, 'directed_presence'):
            new_tab.directed_presence = tab.directed_presence
        if not focus:
            new_tab.state = "private"
        # insert it in the tabs
        self.add_tab(new_tab, focus)
        self.refresh_window()
        tab.privates.append(new_tab)
        return new_tab

    def open_new_room(self, room, nick, focus=True):
        """
        Open a new tab.MucTab containing a muc Room, using the specified nick
        """
        new_tab = tabs.MucTab(room, nick)
        self.add_tab(new_tab, focus)
        self.refresh_window()

    def open_new_form(self, form, on_cancel, on_send, **kwargs):
        """
        Open a new tab containing the form
        The callback are called with the completed form as parameter in
        addition with kwargs
        """
1225
        form_tab = tabs.DataFormsTab(form, on_cancel, on_send, kwargs)
mathieui's avatar
mathieui committed
1226 1227 1228
        self.add_tab(form_tab, True)

    ### Modifying actions ###
1229

mathieui's avatar
mathieui committed
1230 1231
    def rename_private_tabs(self, room_name, old_nick, new_nick):
        """
1232 1233 1234
        Call this method when someone changes his/her nick in a MUC,
        this updates the name of all the opened private conversations
        with him/her
mathieui's avatar
mathieui committed
1235
        """
1236 1237
        tab = self.get_tab_by_name('%s/%s' % (room_name, old_nick),
                                   tabs.PrivateTab)
mathieui's avatar
mathieui committed
1238 1239 1240 1241 1242
        if tab:
            tab.rename_user(old_nick, new_nick)

    def on_user_left_private_conversation(self, room_name, nick, status_message):
        """
1243 1244
        The user left the MUC: add a message in the associated
        private conversation
mathieui's avatar
mathieui committed
1245 1246 1247 1248 1249 1250 1251
        """
        tab = self.get_tab_by_name('%s/%s' % (room_name, nick), tabs.PrivateTab)
        if tab:
            tab.user_left(status_message, nick)

    def on_user_rejoined_private_conversation(self, room_name, nick):
        """
1252 1253
        The user joined a MUC: add a message in the associated
        private conversation
mathieui's avatar
mathieui committed
1254 1255 1256 1257 1258
        """
        tab = self.get_tab_by_name('%s/%s' % (room_name, nick), tabs.PrivateTab)
        if tab:
            tab.user_rejoined(nick)

1259
    def disable_private_tabs(self, room_name, reason=None):
mathieui's avatar
mathieui committed
1260 1261 1262
        """
        Disable private tabs when leaving a room
        """
1263 1264
        if reason is None:
            reason = _('\x195}You left the chatroom\x193}')
mathieui's avatar
mathieui committed
1265
        for tab in self.get_tabs(tabs.PrivateTab):
1266
            if tab.name.startswith(room_name):
mathieui's avatar
mathieui committed
1267 1268
                tab.deactivate(reason=reason)

1269
    def enable_private_tabs(self, room_name, reason=None):
mathieui's avatar
mathieui committed
1270 1271 1272
        """
        Enable private tabs when joining a room
        """
1273 1274
        if reason is None:
            reason = _('\x195}You joined the chatroom\x193}')
mathieui's avatar
mathieui committed
1275
        for tab in self.get_tabs(tabs.PrivateTab):
1276
            if tab.name.startswith(room_name):
mathieui's avatar
mathieui committed
1277 1278 1279
                tab.activate(reason=reason)

    def on_user_changed_status_in_private(self, jid, msg):
1280
        tab = self.get_tab_by_name(jid, tabs.ChatTab)
mathieui's avatar
mathieui committed
1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294
        if tab: # display the message in private
            tab.add_message(msg, typ=2)

    def close_tab(self, tab=None):
        """
        Close the given tab. If None, close the current one
        """
        tab = tab or self.current_tab()
        if isinstance(tab, tabs.RosterInfoTab):
            return              # The tab 0 should NEVER be closed
        del tab.key_func      # Remove self references
        del tab.commands      # and make the object collectable
        tab.on_close()
        nb = tab.nb
1295 1296 1297
        if self.previous_tab_nb != nb:
            self.current_tab_nb = self.previous_tab_nb
            self.previous_tab_nb = 0
1298
        if config.get('create_gaps'):
mathieui's avatar
mathieui committed
1299 1300 1301 1302 1303 1304 1305 1306 1307 1308
            if nb >= len(self.tabs) - 1:
                self.tabs.remove(tab)
                nb -= 1
                while not self.tabs[nb]: # remove the trailing gaps
                    self.tabs.pop()
                    nb -= 1
            else:
                self.tabs[nb] = tabs.GapTab()
        else:
            self.tabs.remove(tab)
1309 1310 1311 1312
        if tab and tab.name in logger.fds:
            logger.fds[tab.name].close()
            log.debug("Log file for %s closed.", tab.name)
            del logger.fds[tab.name]
mathieui's avatar
mathieui committed
1313 1314 1315 1316 1317 1318 1319 1320
        if self.current_tab_nb >= len(self.tabs):
            self.current_tab_nb = len(self.tabs) - 1
        while not self.tabs[self.current_tab_nb]:
            self.current_tab_nb -= 1
        self.current_tab().on_gain_focus()
        self.refresh_window()
        import gc
        gc.collect()
1321 1322
        log.debug('___ Referrers of closing tab:\n%s\n______',
                  gc.get_referrers(tab))
mathieui's avatar
mathieui committed
1323 1324 1325 1326
        del tab

    def add_information_message_to_conversation_tab(self, jid, msg):
        """
1327 1328
        Search for a ConversationTab with the given jid (full or bare),
        if yes, add the given message to it
mathieui's avatar
mathieui committed
1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339
        """
        tab = self.get_tab_by_name(jid, tabs.ConversationTab)
        if tab:
            tab.add_message(msg, typ=2)
            if self.current_tab() is tab:
                self.refresh_window()


####################### Curses and ui-related stuff ###########################

    def doupdate(self):
1340 1341
        "Do a curses update"
        if not self.running:
mathieui's avatar
mathieui committed
1342 1343 1344 1345 1346 1347 1348
            return
        curses.doupdate()

    def information(self, msg, typ=''):
        """
        Displays an informational message in the "Info" buffer
        """
1349
        filter_messages = config.get('filter_info_messages').split(':')
mathieui's avatar
mathieui committed
1350 1351 1352 1353 1354 1355
        for words in filter_messages:
            if words and words in msg:
                log.debug('Did not show the message:\n\t%s> %s', typ, msg)
                return False
        colors = get_theme().INFO_COLORS
        color = colors.get(typ.lower(), colors.get('default', None))
1356 1357 1358
        nb_lines = self.information_buffer.add_message(msg,
                                                       nickname=typ,
                                                       nick_color=color)
1359
        popup_on = config.get('information_buffer_popup_on').split()
mathieui's avatar
mathieui committed
1360 1361
        if isinstance(self.current_tab(), tabs.RosterInfoTab):
            self.refresh_window()
1362
        elif typ != '' and typ.lower() in popup_on:
1363
            popup_time = config.get('popup_time') + (nb_lines - 1) * 2
mathieui's avatar
mathieui committed
1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413
            self.pop_information_win_up(nb_lines, popup_time)
        else:
            if self.information_win_size != 0:
                self.information_win.refresh()
                self.current_tab().input.refresh()
        return True

    def init_curses(self, stdscr):
        """
        ncurses initialization
        """
        curses.curs_set(1)
        curses.noecho()
        curses.nonl()
        curses.raw()
        stdscr.idlok(1)
        stdscr.keypad(1)
        curses.start_color()
        curses.use_default_colors()
        theming.reload_theme()
        curses.ungetch(" ")    # H4X: without this, the screen is
        stdscr.getkey()        # erased on the first "getkey()"

    def reset_curses(self):
        """
        Reset terminal capabilities to what they were before ncurses
        init
        """
        curses.echo()
        curses.nocbreak()
        curses.curs_set(1)
        curses.endwin()

    @property
    def informations(self):
        return self.information_buffer

    def refresh_window(self):
        """
        Refresh everything
        """
        self.current_tab().state = 'current'
        self.current_tab().refresh()
        self.doupdate()

    def refresh_tab_win(self):
        """
        Refresh the window containing the tab list
        """
        self.current_tab().refresh_tab_win()
1414 1415 1416 1417 1418 1419 1420
        self.refresh_input()
        self.doupdate()

    def refresh_input(self):
        """
        Refresh the input if it exists
        """
mathieui's avatar
mathieui committed
1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475