core.py 78.8 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
from poezio.core.completions import CompletionCore
47
from poezio.core.tabs import Tabs
mathieui's avatar
mathieui committed
48 49 50
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
51 52 53
        ERROR_AND_STATUS_CODES, Command, Status


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

    def __init__(self):
60
        self.completion = CompletionCore(self)
61
        self.command = CommandCore(self)
62
        self.handler = HandlerCore(self)
mathieui's avatar
mathieui committed
63 64 65 66
        # All uncaught exception are given to this callback, instead
        # of being displayed on the screen and exiting the program.
        sys.excepthook = self.on_exception
        self.connection_time = time.time()
67
        self.last_stream_error = None
68
        self.stdscr = None
69
        status = config.get('status')
70
        status = POSSIBLE_SHOW.get(status, None)
mathieui's avatar
mathieui committed
71
        self.status = Status(show=status, message=config.get('status_message'))
mathieui's avatar
mathieui committed
72
        self.running = True
73
        self.xmpp = connection.Connection()
mathieui's avatar
mathieui committed
74
        self.xmpp.core = self
75
        self.keyboard = keyboard.Keyboard()
mathieui's avatar
mathieui committed
76 77
        roster.set_node(self.xmpp.client_roster)
        decorators.refresh_wrapper.core = self
mathieui's avatar
mathieui committed
78
        self.bookmarks = BookmarkList()
mathieui's avatar
mathieui committed
79 80
        self.debug = False
        self.remote_fifo = None
mathieui's avatar
mathieui committed
81 82
        self.avatar_cache = FileSystemPerJidCache(
            str(xdg.CACHE_HOME), 'avatars', binary=True)
83
        # a unique buffer used to store global information
mathieui's avatar
mathieui committed
84 85 86
        # that are displayed in almost all tabs, in an
        # information window.
        self.information_buffer = TextBuffer()
mathieui's avatar
mathieui committed
87 88
        self.information_win_size = config.get(
            'info_win_height', section='var')
mathieui's avatar
mathieui committed
89 90
        self.information_win = windows.TextWin(300)
        self.information_buffer.add_window(self.information_win)
91
        self.left_tab_win = None
mathieui's avatar
mathieui committed
92

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

98 99 100
        self.plugins_autoloaded = False
        self.plugin_manager = PluginManager(self)
        self.events = events.EventHandler()
101 102
        self.events.add_event_handler('tab_change',
            self.on_tab_change)
103 104

        self.tabs = Tabs(self.events)
mathieui's avatar
mathieui committed
105 106
        self.previous_tab_nb = 0

107
        own_nick = config.get('default_nick')
108 109 110 111
        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
112

113
        self.size = SizeManager(self)
mathieui's avatar
mathieui committed
114

115 116 117 118 119 120 121
        # 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
122 123 124 125 126 127 128 129 130 131 132
        # 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
133
        if not config.get('send_initial_presence'):
mathieui's avatar
mathieui committed
134 135 136
            del self.commands['status']
            del self.commands['show']

137 138 139 140 141
        # 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
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
        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
172
            ######## actions mappings ##########
Maxime Buquet's avatar
Maxime Buquet committed
173
            '_noop': lambda *args, **kwargs: None,
174 175
            '_bookmark': self.command.bookmark,
            '_bookmark_local': self.command.bookmark_local,
mathieui's avatar
mathieui committed
176 177
            '_close_tab': self.close_tab,
            '_disconnect': self.disconnect,
178
            '_quit': self.command.quit,
mathieui's avatar
mathieui committed
179
            '_redraw_screen': self.full_screen_redraw,
180 181
            '_reload_theme': self.command.theme,
            '_remove_bookmark': self.command.remove_bookmark,
mathieui's avatar
mathieui committed
182 183 184 185 186 187 188
            '_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,
189 190
            '_server_cycle': self.command.server_cycle,
            '_show_bookmarks': self.command.bookmarks,
mathieui's avatar
mathieui committed
191
            '_show_important_room': self.go_to_important_room,
192 193 194
            '_show_invitations': self.command.invitations,
            '_show_plugins': self.command.plugins,
            '_show_xmltab': self.command.xml_tab,
mathieui's avatar
mathieui committed
195
            '_toggle_pane': self.toggle_left_pane,
mathieui's avatar
mathieui committed
196
            ###### status actions ######
197 198 199 200 201
            '_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
202
            ##### Custom actions ########
mathieui's avatar
mathieui committed
203
            '_exc_': self.try_execute,
mathieui's avatar
mathieui committed
204 205 206 207
        }
        self.key_func.update(key_func)

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

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

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

mathieui's avatar
mathieui committed
350 351
        self.add_configuration_handler("", self.on_any_config_change)

352 353 354 355 356 357
    def on_tab_change(self, old_tab, new_tab):
        """Whenever the current tab changes, change focus and refresh"""
        old_tab.on_lose_focus()
        new_tab.on_gain_focus()
        self.refresh_window()

mathieui's avatar
mathieui committed
358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388
    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)

389 390 391 392 393 394
    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
395 396 397 398
    def on_bookmarks_method_config_change(self, option, value):
        """
        Called when the use_bookmarks_method option changes
        """
399
        if value not in ('pep', 'privatexml'):
mathieui's avatar
mathieui committed
400 401
            return
        self.bookmarks.preferred = value
402
        self.bookmarks.save(self.xmpp, core=self)
mathieui's avatar
mathieui committed
403

mathieui's avatar
mathieui committed
404 405 406 407 408
    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.
        """
mathieui's avatar
mathieui committed
409
        self.tabs.update_gaps(value.lower() != "false")
mathieui's avatar
mathieui committed
410

411 412 413 414
    def on_request_receipts_config_change(self, option, value):
        """
        Called when the request_message_receipts option changes
        """
mathieui's avatar
mathieui committed
415 416
        self.xmpp.plugin['xep_0184'].auto_request = config.get(
            option, default=True)
417 418 419 420 421

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

425 426 427 428 429 430
    def on_vertical_tab_list_config_change(self, option, value):
        """
        Called when the enable_vertical_tab_list option is changed
        """
        self.call_for_resize()

431 432 433 434 435 436 437 438 439
    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()

440 441 442 443 444 445
    def on_password_change(self, option, value):
        """
        Set the new password in the slixmpp.ClientXMPP object
        """
        self.xmpp.password = value

446 447 448 449 450 451 452 453
    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('')

454 455 456 457 458 459 460 461 462 463
    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
464
    def reload_config(self):
mathieui's avatar
mathieui committed
465 466 467 468 469 470
        # 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
471
        theming.reload_theme()
mathieui's avatar
mathieui committed
472 473 474 475 476
        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()
477
        config.read_file()
mathieui's avatar
mathieui committed
478 479 480 481 482 483
        # 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)
484
                new_value = config.get(option, default="", section=section)
mathieui's avatar
mathieui committed
485 486 487
                if new_value != old_value:
                    self.trigger_configuration_change(option, new_value)
        log.debug("Config reloaded.")
488 489 490
        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
491 492 493
        # in case some roster options have changed
        roster.modified()

Eijebong's avatar
Eijebong committed
494 495 496 497 498 499 500 501
    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
502 503
    def exit_from_signal(self, *args, **kwargs):
        """
504
        Quit when receiving SIGHUP or SIGTERM or SIGPIPE
mathieui's avatar
mathieui committed
505 506 507 508

        do not save the config because it is not a normal exit
        (and only roster UI things are not yet saved)
        """
509 510
        sig = args[0]
        signals = {
mathieui's avatar
mathieui committed
511 512 513 514
            1: 'SIGHUP',
            13: 'SIGPIPE',
            15: 'SIGTERM',
        }
515 516

        log.error("%s received. Exiting…", signals[sig])
517
        if config.get('enable_user_mood'):
518
            self.xmpp.plugin['xep_0107'].stop()
519
        if config.get('enable_user_activity'):
520
            self.xmpp.plugin['xep_0108'].stop()
521
        if config.get('enable_user_gaming'):
522
            self.xmpp.plugin['xep_0196'].stop()
mathieui's avatar
mathieui committed
523
        self.plugin_manager.disable_plugins()
524 525
        self.disconnect('%s received' % signals.get(sig))
        self.xmpp.add_event_handler("disconnected", self.exit, disposable=True)
mathieui's avatar
mathieui committed
526 527 528 529 530

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

561
    def exit(self, event=None):
mathieui's avatar
mathieui committed
562
        log.debug("exit(%s)", event)
563 564
        asyncio.get_event_loop().stop()

mathieui's avatar
mathieui committed
565 566 567 568 569 570 571 572 573 574 575
    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)

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
Link Mauve's avatar
Link Mauve committed
581
        that a resize occurred and we can act on it. BUT poezio doesn’t call
582 583 584 585 586 587 588 589 590 591 592 593 594 595 596
        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
597
    def on_input_readable(self):
mathieui's avatar
mathieui committed
598 599 600
        """
        main loop waiting for the user to press a key
        """
mathieui's avatar
mathieui committed
601

mathieui's avatar
mathieui committed
602
        def replace_line_breaks(key):
603
            "replace ^J with \n"
mathieui's avatar
mathieui committed
604 605 606
            if key == '^J':
                return '\n'
            return key
mathieui's avatar
mathieui committed
607

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

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

    def save_config(self):
        """
        Save config in the file just before exit
        """
683 684
        ok = roster.save_to_config_file()
        ok = ok and config.silent_set('info_win_height',
mathieui's avatar
mathieui committed
685
                                      self.information_win_size, 'var')
686
        if not ok:
mathieui's avatar
mathieui committed
687 688 689
            self.information(
                'Unable to save runtime preferences'
                ' in the config file', 'Error')
mathieui's avatar
mathieui committed
690 691 692 693 694 695 696 697 698 699 700

    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
701 702
            if not self.get_conversation_by_jid(
                    roster_row.jid, False, fallback_barejid=False):
mathieui's avatar
mathieui committed
703 704 705 706 707 708 709 710 711 712 713 714 715
                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')
        """
716
        if not isinstance(self.tabs.current_tab, tabs.ChatTab):
mathieui's avatar
mathieui committed
717
            return None
718
        return self.tabs.current_tab.get_conversation_messages()
mathieui's avatar
mathieui committed
719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734

    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('/'):
735
            command = line.strip().split()[0][1:]
mathieui's avatar
mathieui committed
736
            arg = line[2 + len(command):]  # jump the '/' and the ' '
mathieui's avatar
mathieui committed
737 738
            # example. on "/link 0 open", command = "link" and arg = "0 open"
            if command in self.commands:
739
                func = self.commands[command].func
mathieui's avatar
mathieui committed
740 741 742
                func(arg)
                return
            else:
mathieui's avatar
mathieui committed
743
                self.information("Unknown command (%s)" % (command), 'Error')
mathieui's avatar
mathieui committed
744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772

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

            args = (pipes.quote(arg.replace('\n', ' ')) for arg in command)
            command_str = ' '.join(args) + '\n'
mathieui's avatar
mathieui committed
792 793
            try:
                self.remote_fifo.write(command_str)
Link Mauve's avatar
Link Mauve committed
794
            except IOError as exc:
mathieui's avatar
mathieui committed
795 796
                log.error(
                    'Could not write in the fifo (%s): %s',
Link Mauve's avatar
Link Mauve committed
797
                    filename,
mathieui's avatar
mathieui committed
798 799
                    repr(command),
                    exc_info=True)
800 801
                self.information('Could not execute %s: %s' % (command, exc),
                                 'Error')
mathieui's avatar
mathieui committed
802 803
                self.remote_fifo = None
        else:
804
            executor = Executor(command)
mathieui's avatar
mathieui committed
805
            try:
806 807
                executor.start()
            except ValueError as exc:
mathieui's avatar
mathieui committed
808 809 810 811
                log.error(
                    'Could not execute command (%s)',
                    repr(command),
                    exc_info=True)
812
                self.information(str(exc), 'Error')
mathieui's avatar
mathieui committed
813 814

    def do_command(self, key, raw):
815 816
        """
        Execute the action associated with a key
817 818 819

        Or if keyboard.continuation_keys_callback is set, call it instead. See
        the comment of this variable.
820
        """
mathieui's avatar
mathieui committed
821 822
        if not key:
            return
823 824 825 826 827 828 829 830
        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:
831
            self.tabs.current_tab.on_input(key, raw)
mathieui's avatar
mathieui committed
832 833 834 835 836 837 838

    def try_execute(self, line):
        """
        Try to execute a command in the current tab
        """
        line = '/' + line
        try:
839
            self.tabs.current_tab.execute_command(line)
mathieui's avatar
mathieui committed
840 841 842 843 844 845 846
        except:
            log.error('Execute failed (%s)', line, exc_info=True)

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

    def remove_timed_event(self, event):
        """Remove an existing timed event"""
847
        event.handler.cancel()
mathieui's avatar
mathieui committed
848 849 850

    def add_timed_event(self, event):
        """Add a new timed event"""
mathieui's avatar
mathieui committed
851 852
        event.handler = asyncio.get_event_loop().call_later(
            event.delay, event.callback, *event.args)
mathieui's avatar
mathieui committed
853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868

####################### 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)
869
        if config.get('save_status'):
870 871 872 873
            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:
mathieui's avatar
mathieui committed
874 875 876
                self.information(
                    'Unable to save the status in '
                    'the config file', 'Error')
mathieui's avatar
mathieui committed
877 878 879 880 881 882

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

    def send_message(self, msg):
        """
908 909
        Function to use in plugins to send a message in the current
        conversation.
mathieui's avatar
mathieui committed
910 911
        Returns False if the current tab is not a conversation tab
        """
912
        if not isinstance(self.tabs.current_tab, tabs.ChatTab):
mathieui's avatar
mathieui committed
913
            return False
914
        self.tabs.current_tab.command_say(msg)
mathieui's avatar
mathieui committed
915 916
        return True

917 918 919 920 921 922
    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
923

924 925 926 927 928
        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
929 930 931 932
                    jid, room, reason=reason)
            else:  # fallback
                self.xmpp.plugin['xep_0045'].invite(
                    room, jid, reason=reason or '')
933

mathieui's avatar
mathieui committed
934 935
        self.xmpp.plugin['xep_0030'].get_info(
            jid=jid, timeout=5, callback=callback)
936

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

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

mathieui's avatar
mathieui committed
975
### Tab getters ###
mathieui's avatar
mathieui committed
976

Link Mauve's avatar
Link Mauve committed
977
    def get_tabs(self, cls=None):
mathieui's avatar
mathieui committed
978
        "Get all the tabs of a type"
Link Mauve's avatar
Link Mauve committed
979
        if cls is None:
980 981
            return self.tabs.get_tabs()
        return self.tabs.by_class(cls)
mathieui's avatar
mathieui committed
982 983 984 985 986 987 988 989 990 991 992

    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)
993 994
        # We first check if we have a static conversation opened
        # with this precise resource
995 996
        conversation = self.tabs.by_name_and_class(jid.full,
                                                   tabs.StaticConversationTab)
mathieui's avatar
mathieui committed
997
        if jid.bare == jid.full and not conversation:
998 999
            conversation = self.tabs.by_name_and_class(
                jid.full, tabs.DynamicConversationTab)
mathieui's avatar
mathieui committed
1000 1001 1002

        if not conversation and fallback_barejid:
            # If not, we search for a conversation with the bare jid
1003 1004
            conversation = self.tabs.by_name_and_class(
                jid.bare, tabs.DynamicConversationTab)
mathieui's avatar
mathieui committed
1005 1006 1007 1008 1009
            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
1010 1011
                    conversation = self.open_conversation_window(
                        jid.bare, False)
mathieui's avatar
mathieui committed
1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022
                else:
                    conversation = None
        return conversation

    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:
1023
            self.tabs.set_current_tab(new_tab)
mathieui's avatar
mathieui committed
1024 1025 1026 1027 1028 1029

    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
        """
mathieui's avatar
mathieui committed
1030 1031
        return self.tabs.insert_tab(old_pos, new_pos,
                                    config.get('create_gaps'))
mathieui's avatar
mathieui committed
1032 1033 1034 1035 1036 1037 1038

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

    def rotate_rooms_right(self, args=None):
        """
        rotate the rooms list to the right
        """
1039
        self.tabs.next()
mathieui's avatar
mathieui committed
1040 1041 1042 1043 1044

    def rotate_rooms_left(self, args=None):
        """
        rotate the rooms list to the right
        """
1045
        self.tabs.prev()
mathieui's avatar
mathieui committed
1046 1047 1048 1049 1050 1051

    def go_to_room_number(self):
        """
        Read 2 more chars and go to the tab
        with the given number
        """
mathieui's avatar
mathieui committed
1052

1053 1054
        def read_next_digit(digit):
            try:
mathieui's avatar
mathieui committed
1055
                int(digit)
1056 1057 1058 1059
            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
1060
                self.room_number_jump.clear()
1061 1062 1063 1064 1065
            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()
1066
                    self.command.win(arg)
1067 1068 1069
                else:
                    # We need to read more digits
                    keyboard.continuation_keys_callback = read_next_digit
mathieui's avatar
mathieui committed
1070