core.py 83.3 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
21
from slixmpp.util import FileSystemPerJidCache
mathieui's avatar
mathieui committed
22

23 24 25 26 27 28 29 30
from poezio import connection
from poezio import decorators
from poezio import events
from poezio import multiuserchat as muc
from poezio import tabs
from poezio import theming
from poezio import timed_events
from poezio import windows
mathieui's avatar
mathieui committed
31

32 33
from poezio.bookmarks import BookmarkList
from poezio.common import safeJID
34
from poezio.config import config, firstrun
35 36 37 38 39 40 41 42 43
from poezio.contact import Contact, Resource
from poezio.daemon import Executor
from poezio.fifo import Fifo
from poezio.logger import logger
from poezio.plugin_manager import PluginManager
from poezio.roster import roster
from poezio.size_manager import SizeManager
from poezio.text_buffer import TextBuffer
from poezio.theming import get_theme
44
from poezio import keyboard, xdg
mathieui's avatar
mathieui committed
45

mathieui's avatar
mathieui committed
46 47 48 49
from poezio.core.completions import CompletionCore
from poezio.core.commands import CommandCore
from poezio.core.handlers import HandlerCore
from poezio.core.structs import POSSIBLE_SHOW, DEPRECATED_ERRORS, \
mathieui's avatar
mathieui committed
50 51 52
        ERROR_AND_STATUS_CODES, Command, Status


53
class Core:
mathieui's avatar
mathieui committed
54 55 56 57 58
    """
    “Main” class of poezion
    """

    def __init__(self):
59
        self.completion = CompletionCore(self)
60
        self.command = CommandCore(self)
61
        self.handler = HandlerCore(self)
mathieui's avatar
mathieui committed
62 63 64 65
        # 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()
66
        self.last_stream_error = None
67
        self.stdscr = None
68
        status = config.get('status')
69
        status = POSSIBLE_SHOW.get(status, None)
mathieui's avatar
mathieui committed
70
        self.status = Status(show=status, message=config.get('status_message'))
mathieui's avatar
mathieui committed
71
        self.running = True
72
        self.xmpp = connection.Connection()
mathieui's avatar
mathieui committed
73
        self.xmpp.core = self
74
        self.keyboard = keyboard.Keyboard()
mathieui's avatar
mathieui committed
75 76
        roster.set_node(self.xmpp.client_roster)
        decorators.refresh_wrapper.core = self
mathieui's avatar
mathieui committed
77
        self.bookmarks = BookmarkList()
mathieui's avatar
mathieui committed
78 79
        self.debug = False
        self.remote_fifo = None
80
        self.avatar_cache = FileSystemPerJidCache(str(xdg.CACHE_HOME), 'avatars', binary=True)
81
        # a unique buffer used to store global information
mathieui's avatar
mathieui committed
82 83 84
        # that are displayed in almost all tabs, in an
        # information window.
        self.information_buffer = TextBuffer()
mathieui's avatar
mathieui committed
85 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(self)
92
        # Whether the XML tab is opened
93
        self.xml_tab = None
mathieui's avatar
mathieui committed
94 95 96 97 98 99
        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)
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
        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,
mathieui's avatar
mathieui committed
169
            ######## actions mappings ##########
Maxime Buquet's avatar
Maxime Buquet committed
170
            '_noop': lambda *args, **kwargs: None,
171 172
            '_bookmark': self.command.bookmark,
            '_bookmark_local': self.command.bookmark_local,
mathieui's avatar
mathieui committed
173 174
            '_close_tab': self.close_tab,
            '_disconnect': self.disconnect,
175
            '_quit': self.command.quit,
mathieui's avatar
mathieui committed
176
            '_redraw_screen': self.full_screen_redraw,
177 178
            '_reload_theme': self.command.theme,
            '_remove_bookmark': self.command.remove_bookmark,
mathieui's avatar
mathieui committed
179 180 181 182 183 184 185
            '_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,
186 187
            '_server_cycle': self.command.server_cycle,
            '_show_bookmarks': self.command.bookmarks,
mathieui's avatar
mathieui committed
188
            '_show_important_room': self.go_to_important_room,
189 190 191
            '_show_invitations': self.command.invitations,
            '_show_plugins': self.command.plugins,
            '_show_xmltab': self.command.xml_tab,
mathieui's avatar
mathieui committed
192
            '_toggle_pane': self.toggle_left_pane,
mathieui's avatar
mathieui committed
193
            ###### status actions ######
194 195 196 197 198
            '_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'),
mathieui's avatar
mathieui committed
199
            ##### Custom actions ########
mathieui's avatar
mathieui committed
200
            '_exc_': self.try_execute,
mathieui's avatar
mathieui committed
201 202 203 204
        }
        self.key_func.update(key_func)

        # Add handlers
205
        self.xmpp.add_event_handler('connected', self.handler.on_connected)
mathieui's avatar
mathieui committed
206 207 208 209 210 211 212 213
        self.xmpp.add_event_handler('connection_failed',
                                    self.handler.on_failed_connection)
        self.xmpp.add_event_handler('disconnected',
                                    self.handler.on_disconnected)
        self.xmpp.add_event_handler('stream_error',
                                    self.handler.on_stream_error)
        self.xmpp.add_event_handler('failed_all_auth',
                                    self.handler.on_failed_all_auth)
214
        self.xmpp.add_event_handler('no_auth', self.handler.on_no_auth)
mathieui's avatar
mathieui committed
215 216
        self.xmpp.add_event_handler("session_start",
                                    self.handler.on_session_start)
217
        self.xmpp.add_event_handler("session_start",
218
                                    self.handler.on_session_start_features)
219
        self.xmpp.add_event_handler("groupchat_presence",
220
                                    self.handler.on_groupchat_presence)
221
        self.xmpp.add_event_handler("groupchat_message",
222
                                    self.handler.on_groupchat_message)
223
        self.xmpp.add_event_handler("groupchat_invite",
224
                                    self.handler.on_groupchat_invitation)
mathieui's avatar
mathieui committed
225 226 227
        self.xmpp.add_event_handler(
            "groupchat_direct_invite",
            self.handler.on_groupchat_direct_invitation)
228
        self.xmpp.add_event_handler("groupchat_decline",
229
                                    self.handler.on_groupchat_decline)
230
        self.xmpp.add_event_handler("groupchat_config_status",
231
                                    self.handler.on_status_codes)
232
        self.xmpp.add_event_handler("groupchat_subject",
233 234
                                    self.handler.on_groupchat_subject)
        self.xmpp.add_event_handler("message", self.handler.on_message)
mathieui's avatar
mathieui committed
235 236 237 238
        self.xmpp.add_event_handler("message_error",
                                    self.handler.on_error_message)
        self.xmpp.add_event_handler("receipt_received",
                                    self.handler.on_receipt)
239 240
        self.xmpp.add_event_handler("got_online", self.handler.on_got_online)
        self.xmpp.add_event_handler("got_offline", self.handler.on_got_offline)
mathieui's avatar
mathieui committed
241 242
        self.xmpp.add_event_handler("roster_update",
                                    self.handler.on_roster_update)
243
        self.xmpp.add_event_handler("changed_status", self.handler.on_presence)
mathieui's avatar
mathieui committed
244 245
        self.xmpp.add_event_handler("presence_error",
                                    self.handler.on_presence_error)
246
        self.xmpp.add_event_handler("roster_subscription_request",
247
                                    self.handler.on_subscription_request)
248
        self.xmpp.add_event_handler("roster_subscription_authorized",
249
                                    self.handler.on_subscription_authorized)
250
        self.xmpp.add_event_handler("roster_subscription_remove",
251
                                    self.handler.on_subscription_remove)
252
        self.xmpp.add_event_handler("roster_subscription_removed",
253 254
                                    self.handler.on_subscription_removed)
        self.xmpp.add_event_handler("message_xform", self.handler.on_data_form)
255
        self.xmpp.add_event_handler("chatstate_active",
256
                                    self.handler.on_chatstate_active)
257
        self.xmpp.add_event_handler("chatstate_composing",
258
                                    self.handler.on_chatstate_composing)
259
        self.xmpp.add_event_handler("chatstate_paused",
260
                                    self.handler.on_chatstate_paused)
261
        self.xmpp.add_event_handler("chatstate_gone",
262
                                    self.handler.on_chatstate_gone)
263
        self.xmpp.add_event_handler("chatstate_inactive",
264 265 266
                                    self.handler.on_chatstate_inactive)
        self.xmpp.add_event_handler("attention", self.handler.on_attention)
        self.xmpp.add_event_handler("ssl_cert", self.handler.validate_ssl)
mathieui's avatar
mathieui committed
267 268 269 270
        self.xmpp.add_event_handler("ssl_invalid_chain",
                                    self.handler.ssl_invalid_chain)
        self.xmpp.add_event_handler('carbon_received',
                                    self.handler.on_carbon_received)
271
        self.xmpp.add_event_handler('carbon_sent', self.handler.on_carbon_sent)
272
        self.xmpp.add_event_handler('http_confirm', self.handler.http_confirm)
273

mathieui's avatar
mathieui committed
274
        all_stanzas = Callback('custom matcher', connection.MatchAll(None),
Link Mauve's avatar
Link Mauve committed
275 276
                               self.handler.incoming_stanza)
        self.xmpp.register_handler(all_stanzas)
277 278 279 280 281
        if config.get('enable_avatars'):
            self.xmpp.add_event_handler("vcard_avatar_update",
                                        self.handler.on_vcard_avatar)
            self.xmpp.add_event_handler("avatar_metadata_publish",
                                        self.handler.on_0084_avatar)
282
        if config.get('enable_user_tune'):
283
            self.xmpp.add_event_handler("user_tune_publish",
284
                                        self.handler.on_tune_event)
285
        if config.get('enable_user_nick'):
286
            self.xmpp.add_event_handler("user_nick_publish",
287
                                        self.handler.on_nick_received)
288
        if config.get('enable_user_mood'):
289
            self.xmpp.add_event_handler("user_mood_publish",
290
                                        self.handler.on_mood_event)
291
        if config.get('enable_user_activity'):
292
            self.xmpp.add_event_handler("user_activity_publish",
293
                                        self.handler.on_activity_event)
294
        if config.get('enable_user_gaming'):
295
            self.xmpp.add_event_handler("user_gaming_publish",
296
                                        self.handler.on_gaming_event)
mathieui's avatar
mathieui committed
297 298 299 300 301 302 303 304 305 306 307 308 309

        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
310 311
        # 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
312 313 314 315 316
        # 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 = {"": []}
317 318
        self.add_configuration_handler("create_gaps",
                                       self.on_gaps_config_change)
319 320 321 322
        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)
323
        self.add_configuration_handler("plugins_dir",
Link Mauve's avatar
Link Mauve committed
324
                                       self.plugin_manager.on_plugins_dir_change)
325
        self.add_configuration_handler("plugins_conf_dir",
Link Mauve's avatar
Link Mauve committed
326
                                       self.plugin_manager.on_plugins_conf_dir_change)
327 328 329 330
        self.add_configuration_handler("connection_timeout_delay",
                                       self.xmpp.set_keepalive_values)
        self.add_configuration_handler("connection_check_interval",
                                       self.xmpp.set_keepalive_values)
mathieui's avatar
mathieui committed
331 332
        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
333 334
        self.add_configuration_handler("use_bookmarks_method",
                                       self.on_bookmarks_method_config_change)
mathieui's avatar
mathieui committed
335
        self.add_configuration_handler("password", self.on_password_change)
336 337
        self.add_configuration_handler("enable_vertical_tab_list",
                                       self.on_vertical_tab_list_config_change)
338 339
        self.add_configuration_handler("vertical_tab_list_size",
                                       self.on_vertical_tab_list_config_change)
340 341
        self.add_configuration_handler("deterministic_nick_colors",
                                       self.on_nick_determinism_changed)
342 343
        self.add_configuration_handler("enable_carbons",
                                       self.on_carbons_switch)
344 345
        self.add_configuration_handler("hide_user_list",
                                       self.on_hide_user_list_change)
346

mathieui's avatar
mathieui committed
347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379
        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)

380 381 382 383 384 385
    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
386 387 388 389
    def on_bookmarks_method_config_change(self, option, value):
        """
        Called when the use_bookmarks_method option changes
        """
390
        if value not in ('pep', 'privatexml'):
mathieui's avatar
mathieui committed
391 392
            return
        self.bookmarks.preferred = value
393
        self.bookmarks.save(self.xmpp, core=self)
mathieui's avatar
mathieui committed
394

mathieui's avatar
mathieui committed
395 396 397 398 399 400
    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":
401
            self.tabs = [tab for tab in self.tabs if tab]
mathieui's avatar
mathieui committed
402

403 404 405 406
    def on_request_receipts_config_change(self, option, value):
        """
        Called when the request_message_receipts option changes
        """
mathieui's avatar
mathieui committed
407 408
        self.xmpp.plugin['xep_0184'].auto_request = config.get(
            option, default=True)
409 410 411 412 413

    def on_ack_receipts_config_change(self, option, value):
        """
        Called when the ack_message_receipts option changes
        """
mathieui's avatar
mathieui committed
414 415
        self.xmpp.plugin['xep_0184'].auto_ack = config.get(
            option, default=True)
416

417 418 419 420 421 422
    def on_vertical_tab_list_config_change(self, option, value):
        """
        Called when the enable_vertical_tab_list option is changed
        """
        self.call_for_resize()

423 424 425 426 427 428 429 430 431
    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()

432 433 434 435 436 437
    def on_password_change(self, option, value):
        """
        Set the new password in the slixmpp.ClientXMPP object
        """
        self.xmpp.password = value

438 439 440 441 442 443 444 445
    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('')

446 447 448 449 450 451 452 453 454 455
    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
456
    def reload_config(self):
mathieui's avatar
mathieui committed
457 458 459 460 461 462
        # 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
463
        theming.reload_theme()
mathieui's avatar
mathieui committed
464 465 466 467 468
        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()
469
        config.read_file()
mathieui's avatar
mathieui committed
470 471 472 473 474 475
        # 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)
476
                new_value = config.get(option, default="", section=section)
mathieui's avatar
mathieui committed
477 478 479
                if new_value != old_value:
                    self.trigger_configuration_change(option, new_value)
        log.debug("Config reloaded.")
480 481 482
        for name, plugin in self.plugin_manager.plugins.items():
            plugin.config.read_file()
            log.debug("Config reloaded for plugin %s", name)
mathieui's avatar
mathieui committed
483 484 485
        # in case some roster options have changed
        roster.modified()

Eijebong's avatar
Eijebong committed
486 487 488 489 490 491 492 493
    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
494 495
    def exit_from_signal(self, *args, **kwargs):
        """
496
        Quit when receiving SIGHUP or SIGTERM or SIGPIPE
mathieui's avatar
mathieui committed
497 498 499 500

        do not save the config because it is not a normal exit
        (and only roster UI things are not yet saved)
        """
501 502
        sig = args[0]
        signals = {
mathieui's avatar
mathieui committed
503 504 505 506
            1: 'SIGHUP',
            13: 'SIGPIPE',
            15: 'SIGTERM',
        }
507 508

        log.error("%s received. Exiting…", signals[sig])
509
        if config.get('enable_user_mood'):
510
            self.xmpp.plugin['xep_0107'].stop()
511
        if config.get('enable_user_activity'):
512
            self.xmpp.plugin['xep_0108'].stop()
513
        if config.get('enable_user_gaming'):
514
            self.xmpp.plugin['xep_0196'].stop()
mathieui's avatar
mathieui committed
515
        self.plugin_manager.disable_plugins()
516 517
        self.disconnect('%s received' % signals.get(sig))
        self.xmpp.add_event_handler("disconnected", self.exit, disposable=True)
mathieui's avatar
mathieui committed
518 519 520 521 522

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

553
    def exit(self, event=None):
mathieui's avatar
mathieui committed
554
        log.debug("exit(%s)", event)
555 556
        asyncio.get_event_loop().stop()

mathieui's avatar
mathieui committed
557 558 559 560 561 562 563 564 565 566 567
    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)

568 569 570 571 572
    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
Link Mauve's avatar
Link Mauve committed
573
        that a resize occurred and we can act on it. BUT poezio doesn’t call
574 575 576 577 578 579 580 581 582 583 584 585 586 587 588
        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
589
    def on_input_readable(self):
mathieui's avatar
mathieui committed
590 591 592
        """
        main loop waiting for the user to press a key
        """
mathieui's avatar
mathieui committed
593

mathieui's avatar
mathieui committed
594
        def replace_line_breaks(key):
595
            "replace ^J with \n"
mathieui's avatar
mathieui committed
596 597 598
            if key == '^J':
                return '\n'
            return key
mathieui's avatar
mathieui committed
599

mathieui's avatar
mathieui committed
600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616
        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:
617
                assert char
mathieui's avatar
mathieui committed
618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637
                # 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
638 639 640
        log.debug("Input is readable.")
        big_char_list = [replace_key_with_bound(key)\
                         for key in self.read_keyboard()]
mathieui's avatar
mathieui committed
641
        log.debug("Got from keyboard: %s", (big_char_list, ))
louiz’'s avatar
louiz’ committed
642 643 644 645 646 647 648 649 650 651 652

        # 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
653
                    else:
mathieui's avatar
mathieui committed
654 655
                        if self.current_tab().nb == nb and config.get(
                                'go_to_previous_tab_on_alt_number'):
louiz’'s avatar
louiz’ committed
656 657
                            self.go_to_previous_tab()
                        else:
658
                            self.command.win('%d' % nb)
louiz’'s avatar
louiz’ committed
659 660 661 662
                # search for keyboard shortcut
                func = self.key_func.get(char, None)
                if func:
                    func()
mathieui's avatar
mathieui committed
663
                else:
louiz’'s avatar
louiz’ committed
664 665 666
                    self.do_command(replace_line_breaks(char), False)
            else:
                self.do_command(''.join(char_list), True)
667
        if self.status.show not in ('xa', 'away'):
668
            self.xmpp.plugin['xep_0319'].idle()
669
        self.doupdate()
mathieui's avatar
mathieui committed
670 671 672 673 674

    def save_config(self):
        """
        Save config in the file just before exit
        """
675 676
        ok = roster.save_to_config_file()
        ok = ok and config.silent_set('info_win_height',
mathieui's avatar
mathieui committed
677
                                      self.information_win_size, 'var')
678
        if not ok:
679
            self.information('Unable to save runtime preferences'
mathieui's avatar
mathieui committed
680
                             ' in the config file', 'Error')
mathieui's avatar
mathieui committed
681 682 683 684 685 686 687 688 689 690 691

    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):
mathieui's avatar
mathieui committed
692 693
            if not self.get_conversation_by_jid(
                    roster_row.jid, False, fallback_barejid=False):
mathieui's avatar
mathieui committed
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 719 720 721 722 723 724 725
                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('/'):
726
            command = line.strip().split()[0][1:]
mathieui's avatar
mathieui committed
727
            arg = line[2 + len(command):]  # jump the '/' and the ' '
mathieui's avatar
mathieui committed
728 729
            # example. on "/link 0 open", command = "link" and arg = "0 open"
            if command in self.commands:
730
                func = self.commands[command].func
mathieui's avatar
mathieui committed
731 732 733
                func(arg)
                return
            else:
mathieui's avatar
mathieui committed
734
                self.information("Unknown command (%s)" % (command), 'Error')
mathieui's avatar
mathieui committed
735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763

    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.
        """
764
        if config.get('exec_remote'):
mathieui's avatar
mathieui committed
765
            # We just write the command in the fifo
766
            fifo_path = config.get('remote_fifo_path')
Link Mauve's avatar
Link Mauve committed
767
            filename = os.path.join(fifo_path, 'poezio.fifo')
mathieui's avatar
mathieui committed
768 769
            if not self.remote_fifo:
                try:
mathieui's avatar
mathieui committed
770
                    self.remote_fifo = Fifo(
Link Mauve's avatar
Link Mauve committed
771
                        filename, 'w')
772
                except (OSError, IOError) as exc:
mathieui's avatar
mathieui committed
773 774
                    log.error(
                        'Could not open the fifo for writing (%s)',
Link Mauve's avatar
Link Mauve committed
775
                        filename,
mathieui's avatar
mathieui committed
776
                        exc_info=True)
777
                    self.information('Could not open the fifo '
mathieui's avatar
mathieui committed
778
                                     'file for writing: %s' % exc, 'Error')
mathieui's avatar
mathieui committed
779
                    return
780 781 782

            args = (pipes.quote(arg.replace('\n', ' ')) for arg in command)
            command_str = ' '.join(args) + '\n'
mathieui's avatar
mathieui committed
783 784
            try:
                self.remote_fifo.write(command_str)
Link Mauve's avatar
Link Mauve committed
785
            except IOError as exc:
mathieui's avatar
mathieui committed
786 787
                log.error(
                    'Could not write in the fifo (%s): %s',
Link Mauve's avatar
Link Mauve committed
788
                    filename,
mathieui's avatar
mathieui committed
789 790
                    repr(command),
                    exc_info=True)
791 792
                self.information('Could not execute %s: %s' % (command, exc),
                                 'Error')
mathieui's avatar
mathieui committed
793 794
                self.remote_fifo = None
        else:
795
            executor = Executor(command)
mathieui's avatar
mathieui committed
796
            try:
797 798
                executor.start()
            except ValueError as exc:
mathieui's avatar
mathieui committed
799 800 801 802
                log.error(
                    'Could not execute command (%s)',
                    repr(command),
                    exc_info=True)
803
                self.information(str(exc), 'Error')
mathieui's avatar
mathieui committed
804 805

    def do_command(self, key, raw):
806 807
        """
        Execute the action associated with a key
808 809 810

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

    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"""
838
        event.handler.cancel()
mathieui's avatar
mathieui committed
839 840 841

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

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

    def get_bookmark_nickname(self, room_name):
        """
        Returns the nickname associated with a bookmark
        or the default nickname
        """
mathieui's avatar
mathieui committed
873
        bm = self.bookmarks[room_name]
mathieui's avatar
mathieui committed
874 875 876 877 878 879 880 881 882
        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)
        """
883
        self.legitimate_disconnect = True
mathieui's avatar
mathieui committed
884 885 886 887 888
        msg = msg or ''
        for tab in self.get_tabs(tabs.MucTab):
            tab.command_part(msg)
        self.xmpp.disconnect()
        if reconnect:
889 890
            # Add a one-time event to reconnect as soon as we are
            # effectively disconnected
mathieui's avatar
mathieui committed
891 892 893 894
            self.xmpp.add_event_handler(
                'disconnected',
                lambda event: self.xmpp.connect(),
                disposable=True)
mathieui's avatar
mathieui committed
895 896 897

    def send_message(self, msg):
        """
898 899
        Function to use in plugins to send a message in the current
        conversation.
mathieui's avatar
mathieui committed
900 901 902 903 904 905 906
        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

907 908 909 910 911 912
    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
        """
mathieui's avatar
mathieui committed
913

914 915 916 917 918
        def callback(iq):
            if not iq:
                return
            if 'jabber:x:conference' in iq['disco_info'].get_features():
                self.xmpp.plugin['xep_0249'].send_invitation(
mathieui's avatar
mathieui committed
919 920 921 922
                    jid, room, reason=reason)
            else:  # fallback
                self.xmpp.plugin['xep_0045'].invite(
                    room, jid, reason=reason or '')
923

mathieui's avatar
mathieui committed
924 925
        self.xmpp.plugin['xep_0030'].get_info(
            jid=jid, timeout=5, callback=callback)
926

mathieui's avatar
mathieui committed
927 928 929
    def get_error_message(self, stanza, deprecated=False):
        """
        Takes a stanza of the form <message type='error'><error/></message>
930
        and return a well formed string containing error information
mathieui's avatar
mathieui committed
931
        """
932
        sender = stanza['from']
mathieui's avatar
mathieui committed
933 934 935 936 937 938 939 940 941
        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:
942
                    body = condition or 'Unknown error'
mathieui's avatar
mathieui committed
943 944 945 946
            else:
                if code in ERROR_AND_STATUS_CODES:
                    body = ERROR_AND_STATUS_CODES[code]
                else:
947
                    body = condition or 'Unknown error'
mathieui's avatar
mathieui committed
948
        if code:
949
            message = '%(from)s: %(code)s - %(msg)s: %(body)s' % {
mathieui's avatar
mathieui committed
950 951 952 953 954
                'from': sender,
                'msg': msg,
                'body': body,
                'code': code
            }
mathieui's avatar
mathieui committed
955
        else:
956
            message = '%(from)s: %(msg)s: %(body)s' % {
mathieui's avatar
mathieui committed
957 958 959 960
                'from': sender,
                'msg': msg,
                'body': body
            }
mathieui's avatar
mathieui committed
961 962 963 964
        return message

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

mathieui's avatar
mathieui committed
965
### Tab getters ###
mathieui's avatar
mathieui committed
966

Link Mauve's avatar
Link Mauve committed
967
    def get_tabs(self, cls=None):
mathieui's avatar
mathieui committed
968
        "Get all the tabs of a type"
Link Mauve's avatar
Link Mauve committed
969 970
        if cls is None:
            cls = tabs.Tab
971
        return [tab for tab in self.tabs if isinstance(tab, cls)]
mathieui's avatar
mathieui committed
972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989

    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)
990 991 992 993
        # 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
994
        if jid.bare == jid.full and not conversation:
995 996
            conversation = self.get_tab_by_name(jid.full,
                                                tabs.DynamicConversationTab)
mathieui's avatar
mathieui committed
997 998 999

        if not conversation and fallback_barejid:
            # If not, we search for a conversation with the bare jid
1000 1001
            conversation = self.get_tab_by_name(jid.bare,
                                                tabs.DynamicConversationTab)
mathieui's avatar
mathieui committed
1002 1003 1004 1005 1006
            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)
mathieui's avatar
mathieui committed
1007 1008
                    conversation = self.open_conversation_window(
                        jid.bare, False)
mathieui's avatar
mathieui committed
1009 1010 1011 1012 1013 1014 1015 1016 1017 1018
                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:
1019
            if tab.name == name:
mathieui's avatar
mathieui committed
1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036
                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:
1037
            self.command.win("%s" % new_tab.nb)
mathieui's avatar
mathieui committed
1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065

    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):
1066
                old_tab = self.tabs[old_pos]
mathieui's avatar
mathieui committed
1067 1068
                self.tabs[new_pos], self.tabs[old_pos] = old_tab, tabs.GapTab(
                    self)
mathieui's avatar
mathieui committed
1069 1070
            else:
                self.tabs.append(self.tabs[old_pos])
1071
                self.tabs[old_pos] = tabs.GapTab(self)
mathieui's avatar
mathieui committed
1072 1073 1074
        else:
            if new_pos > old_pos:
                self.tabs.insert(new_pos, tab)
1075
                self.tabs[old_pos] = tabs.GapTab(self)
mathieui's avatar
mathieui committed
1076
            elif new_pos < old_pos:
1077
                self.tabs[old_pos] = tabs.GapTab(self)
mathieui's avatar
mathieui committed
1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107
                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
1108
        elif new_pos == old_pos:
mathieui's avatar
mathieui committed
1109 1110 1111
            return False
        elif not self.tabs[old_pos]:
            return False
1112
        if config.get('create_gaps'):