core.py 85.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
13
import shutil
mathieui's avatar
mathieui committed
14 15 16 17 18 19
import curses
import os
import pipes
import sys
import time

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

import connection
import decorators
import events
import singleton
import tabs
import theming
import timed_events
import windows

mathieui's avatar
mathieui committed
31
from bookmarks import BookmarkList
mathieui's avatar
mathieui committed
32 33 34 35 36 37 38 39
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
40
from size_manager import SizeManager
mathieui's avatar
mathieui committed
41 42
from text_buffer import TextBuffer
from theming import get_theme
43
import keyboard
mathieui's avatar
mathieui committed
44 45 46 47

from . import completions
from . import commands
from . import handlers
48
from . structs import POSSIBLE_SHOW, DEPRECATED_ERRORS, \
mathieui's avatar
mathieui committed
49 50 51 52 53 54 55 56 57 58 59 60 61
        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()
62
        self.stdscr = None
63
        status = config.get('status')
64
        status = POSSIBLE_SHOW.get(status, None)
mathieui's avatar
mathieui committed
65
        self.status = Status(show=status,
66
                message=config.get('status_message'))
mathieui's avatar
mathieui committed
67 68 69
        self.running = True
        self.xmpp = singleton.Singleton(connection.Connection)
        self.xmpp.core = self
70
        self.keyboard = keyboard.Keyboard()
mathieui's avatar
mathieui committed
71 72
        roster.set_node(self.xmpp.client_roster)
        decorators.refresh_wrapper.core = self
mathieui's avatar
mathieui committed
73
        self.bookmarks = BookmarkList()
mathieui's avatar
mathieui committed
74 75 76 77 78 79
        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()
80
        self.information_win_size = config.get('info_win_height', section='var')
mathieui's avatar
mathieui committed
81 82
        self.information_win = windows.TextWin(300)
        self.information_buffer.add_window(self.information_win)
83
        self.left_tab_win = None
mathieui's avatar
mathieui committed
84 85

        self.tab_win = windows.GlobalInfoBar()
86
        # Whether the XML tab is opened
87
        self.xml_tab = None
mathieui's avatar
mathieui committed
88 89 90 91 92 93
        self.xml_buffer = TextBuffer()

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

94
        own_nick = config.get('default_nick')
95 96 97 98
        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
99 100 101 102 103

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

104
        self.size = SizeManager(self, windows.Win)
mathieui's avatar
mathieui committed
105

106 107 108 109 110 111 112
        # 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
113 114 115 116 117 118 119 120 121 122 123
        # 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
124
        if not config.get('send_initial_presence'):
mathieui's avatar
mathieui committed
125 126 127
            del self.commands['status']
            del self.commands['show']

128 129 130 131 132
        # 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
133 134 135 136 137 138 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
        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
193
            '_exc_': self.try_execute,
mathieui's avatar
mathieui committed
194 195 196 197
        }
        self.key_func.update(key_func)

        # Add handlers
198
        self.xmpp.add_event_handler('connecting', self.on_connecting)
mathieui's avatar
mathieui committed
199
        self.xmpp.add_event_handler('connected', self.on_connected)
200
        self.xmpp.add_event_handler('connection_failed', self.on_failed_connection)
mathieui's avatar
mathieui committed
201
        self.xmpp.add_event_handler('disconnected', self.on_disconnected)
202
        self.xmpp.add_event_handler('stream_error', self.on_stream_error)
203
        self.xmpp.add_event_handler('failed_all_auth', self.on_failed_all_auth)
mathieui's avatar
mathieui committed
204 205
        self.xmpp.add_event_handler('no_auth', self.on_no_auth)
        self.xmpp.add_event_handler("session_start", self.on_session_start)
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
        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
222
        self.xmpp.add_event_handler("message", self.on_message)
mathieui's avatar
mathieui committed
223
        self.xmpp.add_event_handler("message_error", self.on_error_message)
224
        self.xmpp.add_event_handler("receipt_received", self.on_receipt)
mathieui's avatar
mathieui committed
225 226
        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
227 228 229
        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)
230 231 232 233 234 235 236 237
        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
238
        self.xmpp.add_event_handler("message_xform", self.on_data_form)
239 240 241 242 243 244 245 246 247 248
        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
249 250
        self.xmpp.add_event_handler("attention", self.on_attention)
        self.xmpp.add_event_handler("ssl_cert", self.validate_ssl)
251
        self.xmpp.add_event_handler("ssl_invalid_chain", self.ssl_invalid_chain)
252 253 254
        self.xmpp.add_event_handler('carbon_received', self.on_carbon_received)
        self.xmpp.add_event_handler('carbon_sent', self.on_carbon_sent)

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)
mathieui's avatar
mathieui committed
312 313
        self.add_configuration_handler("use_bookmarks_method",
                                       self.on_bookmarks_method_config_change)
314 315
        self.add_configuration_handler("password",
                                       self.on_password_change)
316 317
        self.add_configuration_handler("enable_vertical_tab_list",
                                       self.on_vertical_tab_list_config_change)
318 319
        self.add_configuration_handler("vertical_tab_list_size",
                                       self.on_vertical_tab_list_config_change)
320 321
        self.add_configuration_handler("deterministic_nick_colors",
                                       self.on_nick_determinism_changed)
322 323
        self.add_configuration_handler("enable_carbons",
                                       self.on_carbons_switch)
324 325
        self.add_configuration_handler("hide_user_list",
                                       self.on_hide_user_list_change)
326

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

360 361 362 363 364 365
    def on_hide_user_list_change(self, option, value):
        """
        Called when the hide_user_list option changes
        """
        self.call_for_resize()

mathieui's avatar
mathieui committed
366 367 368 369
    def on_bookmarks_method_config_change(self, option, value):
        """
        Called when the use_bookmarks_method option changes
        """
370
        if value not in ('pep', 'privatexml'):
mathieui's avatar
mathieui committed
371 372
            return
        self.bookmarks.preferred = value
373
        self.bookmarks.save(self.xmpp, core=self)
mathieui's avatar
mathieui committed
374

mathieui's avatar
mathieui committed
375 376 377 378 379 380
    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":
381
            self.tabs = list(tab for tab in self.tabs if tab)
mathieui's avatar
mathieui committed
382

383 384 385 386
    def on_request_receipts_config_change(self, option, value):
        """
        Called when the request_message_receipts option changes
        """
387 388
        self.xmpp.plugin['xep_0184'].auto_request = config.get(option,
                                                               default=True)
389 390 391 392 393

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

mathieui's avatar
mathieui committed
396 397 398 399 400 401 402
    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)

403 404 405 406 407 408
    def on_vertical_tab_list_config_change(self, option, value):
        """
        Called when the enable_vertical_tab_list option is changed
        """
        self.call_for_resize()

mathieui's avatar
mathieui committed
409 410 411 412 413 414 415
    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)

416 417 418 419 420 421 422 423 424
    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()

425 426 427 428 429 430
    def on_password_change(self, option, value):
        """
        Set the new password in the slixmpp.ClientXMPP object
        """
        self.xmpp.password = value

431 432 433 434 435 436 437 438 439

    def on_nick_determinism_changed(self, option, value):
        """If we change the value to true, we call /recolor on all the MucTabs, to
        make the current nick colors reflect their deterministic value.
        """
        if value.lower() == "true":
            for tab in self.get_tabs(tabs.MucTab):
                tab.command_recolor('')

440 441 442 443 444 445 446 447 448 449
    def on_carbons_switch(self, option, value):
        """Whenever the user enables or disables carbons using /set, we should
        inform the server immediately, this way we do not require a restart
        for the change to take effect
        """
        if value:
            self.xmpp.plugin['xep_0280'].enable()
        else:
            self.xmpp.plugin['xep_0280'].disable()

Eijebong's avatar
Eijebong committed
450
    def reload_config(self):
mathieui's avatar
mathieui committed
451 452 453 454 455 456
        # 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…")
Eijebong's avatar
Eijebong committed
457
        theming.reload_theme()
mathieui's avatar
mathieui committed
458 459 460 461 462
        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()
463
        config.read_file()
mathieui's avatar
mathieui committed
464 465 466 467 468 469
        # 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)
470
                new_value = config.get(option, default="", section=section)
mathieui's avatar
mathieui committed
471 472 473 474 475 476
                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()

Eijebong's avatar
Eijebong committed
477 478 479 480 481 482 483 484
    def sigusr_handler(self, num, stack):
        """
        Handle SIGUSR1 (10)
        When caught, reload all the possible files.
        """
        log.debug("SIGUSR1 caught, reloading the files…")
        self.reload_config()

mathieui's avatar
mathieui committed
485 486
    def exit_from_signal(self, *args, **kwargs):
        """
487
        Quit when receiving SIGHUP or SIGTERM or SIGPIPE
mathieui's avatar
mathieui committed
488 489 490 491

        do not save the config because it is not a normal exit
        (and only roster UI things are not yet saved)
        """
492 493 494 495 496 497 498 499
        sig = args[0]
        signals = {
                1: 'SIGHUP',
                13: 'SIGPIPE',
                15: 'SIGTERM',
                }

        log.error("%s received. Exiting…", signals[sig])
500
        if config.get('enable_user_mood'):
501
            self.xmpp.plugin['xep_0107'].stop()
502
        if config.get('enable_user_activity'):
503
            self.xmpp.plugin['xep_0108'].stop()
504
        if config.get('enable_user_gaming'):
505
            self.xmpp.plugin['xep_0196'].stop()
mathieui's avatar
mathieui committed
506
        self.plugin_manager.disable_plugins()
507 508
        self.disconnect('%s received' % signals.get(sig))
        self.xmpp.add_event_handler("disconnected", self.exit, disposable=True)
mathieui's avatar
mathieui committed
509 510 511 512 513

    def autoload_plugins(self):
        """
        Load the plugins on startup.
        """
514
        plugins = config.get('plugins_autoload')
mathieui's avatar
mathieui committed
515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532
        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)
533
        self.information('Welcome to poezio!', 'Info')
mathieui's avatar
mathieui committed
534
        if firstrun:
535
            self.information(
mathieui's avatar
mathieui committed
536
                'It seems that it is the first time you start poezio.\n'
537 538
                'The online help is here http://doc.poez.io/\n'
                'No room is joined by default, but you can join poezio’s'
mathieui's avatar
mathieui committed
539
                ' chatroom (with /join poezio@muc.poez.io), where you can'
540 541
                ' ask for help or tell us how great it is.',
                'Help')
mathieui's avatar
mathieui committed
542
        self.refresh_window()
louiz’'s avatar
louiz’ committed
543
        self.xmpp.plugin['xep_0012'].begin_idle(jid=self.xmpp.boundjid)
mathieui's avatar
mathieui committed
544

545 546 547 548
    def exit(self, event=None):
        log.debug("exit(%s)" % (event,))
        asyncio.get_event_loop().stop()

mathieui's avatar
mathieui committed
549 550 551 552 553 554 555 556 557 558 559
    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)

560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580
    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
581
    def on_input_readable(self):
mathieui's avatar
mathieui committed
582 583 584 585
        """
        main loop waiting for the user to press a key
        """
        def replace_line_breaks(key):
586
            "replace ^J with \n"
mathieui's avatar
mathieui committed
587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606
            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:
607
                assert char
mathieui's avatar
mathieui committed
608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627
                # 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
628 629 630 631 632 633 634 635 636 637 638 639 640 641 642
        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):
            # 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
643
                    else:
644
                        if self.current_tab().nb == nb and config.get('go_to_previous_tab_on_alt_number'):
louiz’'s avatar
louiz’ committed
645 646 647 648 649 650 651
                            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
652
                else:
louiz’'s avatar
louiz’ committed
653 654 655
                    self.do_command(replace_line_breaks(char), False)
            else:
                self.do_command(''.join(char_list), True)
656
        if self.status.show not in ('xa', 'away'):
657
            self.xmpp.plugin['xep_0319'].idle()
658
        self.doupdate()
mathieui's avatar
mathieui committed
659 660 661 662 663

    def save_config(self):
        """
        Save config in the file just before exit
        """
664 665 666 667 668
        ok = roster.save_to_config_file()
        ok = ok and config.silent_set('info_win_height',
                                      self.information_win_size,
                                      'var')
        if not ok:
669 670 671
            self.information('Unable to save runtime preferences'
                             ' in the config file',
                             'Error')
mathieui's avatar
mathieui committed
672 673 674 675 676 677 678 679 680 681 682

    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):
683 684 685
            if not self.get_conversation_by_jid(roster_row.jid,
                                                False,
                                                fallback_barejid=False):
mathieui's avatar
mathieui committed
686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718
                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('/'):
719
            command = line.strip().split()[0][1:]
mathieui's avatar
mathieui committed
720 721 722
            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:
723
                func = self.commands[command].func
mathieui's avatar
mathieui committed
724 725 726
                func(arg)
                return
            else:
727 728
                self.information("Unknown command (%s)" % (command),
                                 'Error')
mathieui's avatar
mathieui committed
729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757

    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.
        """
758
        if config.get('exec_remote'):
mathieui's avatar
mathieui committed
759
            # We just write the command in the fifo
760
            fifo_path = config.get('remote_fifo_path')
mathieui's avatar
mathieui committed
761 762
            if not self.remote_fifo:
                try:
763 764 765 766
                    self.remote_fifo = Fifo(os.path.join(fifo_path,
                                                         'poezio.fifo'),
                                            'w')
                except (OSError, IOError) as exc:
mathieui's avatar
mathieui committed
767
                    log.error('Could not open the fifo for writing (%s)',
768 769 770 771 772
                               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
773
                    return
774 775 776

            args = (pipes.quote(arg.replace('\n', ' ')) for arg in command)
            command_str = ' '.join(args) + '\n'
mathieui's avatar
mathieui committed
777 778
            try:
                self.remote_fifo.write(command_str)
779
            except (IOError) as exc:
mathieui's avatar
mathieui committed
780
                log.error('Could not write in the fifo (%s): %s',
781
                            os.path.join(fifo_path, './', 'poezio.fifo'),
mathieui's avatar
mathieui committed
782 783
                            repr(command),
                            exc_info=True)
784 785
                self.information('Could not execute %s: %s' % (command, exc),
                                 'Error')
mathieui's avatar
mathieui committed
786 787
                self.remote_fifo = None
        else:
788
            executor = Executor(command)
mathieui's avatar
mathieui committed
789
            try:
790 791 792 793 794 795
                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
796 797 798


    def do_command(self, key, raw):
799 800
        """
        Execute the action associated with a key
801 802 803

        Or if keyboard.continuation_keys_callback is set, call it instead. See
        the comment of this variable.
804
        """
mathieui's avatar
mathieui committed
805 806
        if not key:
            return
807 808 809 810 811 812 813 814 815
        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
816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832


    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"""
833
        event.handler.cancel()
mathieui's avatar
mathieui committed
834 835 836

    def add_timed_event(self, event):
        """Add a new timed event"""
837 838 839
        event.handler = asyncio.get_event_loop().call_later(event.delay,
                                                            event.callback,
                                                            *event.args)
mathieui's avatar
mathieui committed
840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855

####################### 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)
856
        if config.get('save_status'):
857 858 859 860
            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:
861 862
                self.information('Unable to save the status in '
                                 'the config file', 'Error')
mathieui's avatar
mathieui committed
863 864 865 866 867 868

    def get_bookmark_nickname(self, room_name):
        """
        Returns the nickname associated with a bookmark
        or the default nickname
        """
mathieui's avatar
mathieui committed
869
        bm = self.bookmarks[room_name]
mathieui's avatar
mathieui committed
870 871 872 873 874 875 876 877 878
        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)
        """
879
        self.legitimate_disconnect = True
mathieui's avatar
mathieui committed
880 881 882 883 884
        msg = msg or ''
        for tab in self.get_tabs(tabs.MucTab):
            tab.command_part(msg)
        self.xmpp.disconnect()
        if reconnect:
885 886 887
            # 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
888 889 890

    def send_message(self, msg):
        """
891 892
        Function to use in plugins to send a message in the current
        conversation.
mathieui's avatar
mathieui committed
893 894 895 896 897 898 899
        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

900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917
    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 '')

918 919
        self.xmpp.plugin['xep_0030'].get_info(jid=jid, timeout=5,
                                              callback=callback)
920

mathieui's avatar
mathieui committed
921 922 923 924 925 926 927 928 929 930 931 932 933 934 935
    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:
936
                    body = condition or 'Unknown error'
mathieui's avatar
mathieui committed
937 938 939 940
            else:
                if code in ERROR_AND_STATUS_CODES:
                    body = ERROR_AND_STATUS_CODES[code]
                else:
941
                    body = condition or 'Unknown error'
mathieui's avatar
mathieui committed
942
        if code:
943 944
            message = '%(from)s: %(code)s - %(msg)s: %(body)s' % {
                      'from': sender, 'msg': msg, 'body': body, 'code': code}
mathieui's avatar
mathieui committed
945
        else:
946 947
            message = '%(from)s: %(msg)s: %(body)s' % {
                      'from': sender, 'msg': msg, 'body': body}
mathieui's avatar
mathieui committed
948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975
        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)
976 977 978 979
        # 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
980
        if jid.bare == jid.full and not conversation:
981 982
            conversation = self.get_tab_by_name(jid.full,
                                                tabs.DynamicConversationTab)
mathieui's avatar
mathieui committed
983 984 985

        if not conversation and fallback_barejid:
            # If not, we search for a conversation with the bare jid
986 987
            conversation = self.get_tab_by_name(jid.bare,
                                                tabs.DynamicConversationTab)
mathieui's avatar
mathieui committed
988 989 990 991 992
            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)
993 994
                    conversation = self.open_conversation_window(jid.bare,
                                                                 False)
mathieui's avatar
mathieui committed
995 996 997 998 999 1000 1001 1002 1003 1004
                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:
1005
            if tab.name == name:
mathieui's avatar
mathieui committed
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 1043 1044 1045 1046 1047 1048 1049 1050 1051
                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):
1052 1053
                old_tab = self.tabs[old_pos]
                self.tabs[new_pos], self.tabs[old_pos] = old_tab, tabs.GapTab()
mathieui's avatar
mathieui committed
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 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092
            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
1093
        elif new_pos == old_pos:
mathieui's avatar
mathieui committed
1094 1095 1096
            return False
        elif not self.tabs[old_pos]:
            return False
1097
        if config.get('create_gaps'):
mathieui's avatar
mathieui committed
1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129
            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
        """
1130 1131 1132 1133 1134 1135 1136
        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
1137
                self.room_number_jump.clear()
1138 1139 1140 1141 1142 1143 1144 1145 1146 1147
            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
1148 1149

    def go_to_roster(self):
1150
        "Select the roster as the current tab"
mathieui's avatar
mathieui committed
1151 1152 1153
        self.command_win('0')

    def go_to_previous_tab(self):
1154
        "Go to the previous tab"
mathieui's avatar
mathieui committed
1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173
        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
1174 1175 1176
        states = sorted(tab_refs.keys(),
                        key=(lambda x: priority.get(x, 0)),
                        reverse=True)
mathieui's avatar
mathieui committed
1177 1178 1179 1180
        states = [state for state in states if priority.get(state, -1) >= 0]

        for state in states:
            for tab in tab_refs[state]:
1181 1182
                if (tab.nb < self.current_tab_nb and
                    tab_refs[state][-1].nb > self.current_tab_nb):
mathieui's avatar
mathieui committed
1183 1184 1185 1186 1187 1188 1189 1190
                    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:
1191
            if tab.name == tab_name:
mathieui's avatar
mathieui committed
1192 1193 1194 1195 1196 1197 1198
                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):
1199
        """Wrapper for the current tab number"""
mathieui's avatar
mathieui committed
1200 1201 1202 1203
        return self._current_tab_nb

    @current_tab_nb.setter
    def current_tab_nb(self, value):
1204 1205 1206 1207
        """
        Prevents the tab number from going over the total number of opened
        tabs, or under 0
        """
mathieui's avatar
mathieui committed
1208
        old = self._current_tab_nb
mathieui's avatar
mathieui committed
1209 1210 1211 1212 1213 1214
        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
1215
        if old != self._current_tab_nb and self.tabs[self._current_tab_nb]:
mathieui's avatar
mathieui committed
1216
            self.events.trigger('tab_change', old, self._current_tab_nb)
mathieui's avatar
mathieui committed
1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242

    ### 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):
1243
            if tab.name == complete_jid:
mathieui's avatar
mathieui committed
1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260
                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

1261
    def open_new_room(self, room, nick, *, password=None, focus=True):
mathieui's avatar
mathieui committed
1262 1263 1264
        """
        Open a new tab.MucTab containing a muc Room, using the specified nick
        """
1265
        new_tab = tabs.MucTab(room, nick, password=password)
mathieui's avatar
mathieui committed
1266 1267
        self.add_tab(new_tab, focus)
        self.refresh_window()
1268
        return new_tab
mathieui's avatar
mathieui committed
1269 1270 1271 1272 1273 1274 1275

    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
        """
1276
        form_tab = tabs.DataFormsTab(form, on_cancel, on_send, kwargs)
mathieui's avatar
mathieui committed
1277 1278 1279
        self.add_tab(form_tab, True)

    ### Modifying actions ###
1280

mathieui's avatar
mathieui committed
1281 1282
    def rename_private_tabs(self, room_name, old_nick, new_nick):
        """
1283 1284 1285
        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
1286
        """
1287 1288
        tab = self.get_tab_by_name('%s/%s' % (room_name, old_nick),
                                   tabs.PrivateTab)
mathieui's avatar
mathieui committed
1289 1290 1291 1292 1293
        if tab:
            tab.rename_user(old_nick, new_nick)

    def on_user_left_private_conversation(self, room_name, nick, status_message):
        """
1294 1295
        The user left the MUC: add a message in the associated
        private conversation
mathieui's avatar
mathieui committed
1296 1297 1298 1299 1300 1301 1302
        """
        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):
        """
1303 1304
        The user joined a MUC: add a message in the associated
        private conversation
mathieui's avatar
mathieui committed
1305 1306 1307 1308 1309
        """
        tab = self.get_tab_by_name('%s/%s' % (room_name, nick), tabs.PrivateTab)
        if tab:
            tab.user_rejoined(nick)

1310
    def disable_private_tabs(self, room_name, reason=None):
mathieui's avatar
mathieui committed
1311 1312 1313
        """
        Disable private tabs when leaving a room
        """
1314
        if reason is None:
1315
            reason = '\x195}You left the chatroom\x193}'
mathieui's avatar
mathieui committed
1316
        for tab in self.get_tabs(tabs.PrivateTab):
1317
            if tab.name.startswith(room_name):
mathieui's avatar
mathieui committed
1318 1319
                tab.deactivate(reason=reason)

1320
    def enable_private_tabs(self, room_name, reason=None):
mathieui's avatar
mathieui committed
1321 1322 1323
        """
        Enable private tabs when joining a room
        """
1324
        if reason is None:
1325
            reason = '\x195}You joined the chatroom\x193}'
mathieui's avatar
mathieui committed
1326
        for tab in self.get_tabs(tabs.PrivateTab):
1327
            if tab.name.startswith(room_name):
mathieui's avatar
mathieui committed
1328 1329 1330
                tab.activate(reason=reason)

    def on_user_changed_status_in_private(self, jid, msg):
1331
        tab = self.get_tab_by_name(