core.py 77.9 KB
Newer Older
mathieui's avatar
mathieui committed
1 2 3 4 5 6 7 8
"""
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
9
import asyncio
mathieui's avatar
mathieui committed
10 11 12 13
import curses
import os
import pipes
import sys
mathieui's avatar
mathieui committed
14
import shutil
mathieui's avatar
mathieui committed
15
import time
mathieui's avatar
mathieui committed
16 17
from collections import defaultdict
from typing import Callable, Dict, List, Optional, Tuple, Type
mathieui's avatar
mathieui committed
18

mathieui's avatar
mathieui committed
19
from slixmpp import JID
20
from slixmpp.util import FileSystemPerJidCache
mathieui's avatar
mathieui committed
21
from slixmpp.xmlstream.handler import Callback
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
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
mathieui's avatar
mathieui committed
42
from poezio.user import User
43
from poezio.text_buffer import TextBuffer
Link Mauve's avatar
Link Mauve committed
44
from poezio.timed_events import DelayedEvent
45
from poezio.theming import get_theme
46
from poezio import keyboard, xdg
mathieui's avatar
mathieui committed
47

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

mathieui's avatar
mathieui committed
55 56
log = logging.getLogger(__name__)

mathieui's avatar
mathieui committed
57

58
class Core:
mathieui's avatar
mathieui committed
59 60 61 62 63
    """
    “Main” class of poezion
    """

    def __init__(self):
64
        self.completion = CompletionCore(self)
65
        self.command = CommandCore(self)
66
        self.handler = HandlerCore(self)
mathieui's avatar
mathieui committed
67 68 69 70
        # 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()
71
        self.last_stream_error = None
72
        self.stdscr = None
73
        status = config.get('status')
74
        status = POSSIBLE_SHOW.get(status, None)
mathieui's avatar
mathieui committed
75
        self.status = Status(show=status, message=config.get('status_message'))
mathieui's avatar
mathieui committed
76
        self.running = True
77
        self.xmpp = connection.Connection()
mathieui's avatar
mathieui committed
78
        self.xmpp.core = self
79
        self.keyboard = keyboard.Keyboard()
mathieui's avatar
mathieui committed
80 81
        roster.set_node(self.xmpp.client_roster)
        decorators.refresh_wrapper.core = self
mathieui's avatar
mathieui committed
82
        self.bookmarks = BookmarkList()
mathieui's avatar
mathieui committed
83 84
        self.debug = False
        self.remote_fifo = None
mathieui's avatar
mathieui committed
85 86
        self.avatar_cache = FileSystemPerJidCache(
            str(xdg.CACHE_HOME), 'avatars', binary=True)
87
        # a unique buffer used to store global information
mathieui's avatar
mathieui committed
88 89 90
        # that are displayed in almost all tabs, in an
        # information window.
        self.information_buffer = TextBuffer()
mathieui's avatar
mathieui committed
91 92
        self.information_win_size = config.get(
            'info_win_height', section='var')
mathieui's avatar
mathieui committed
93 94
        self.information_win = windows.TextWin(300)
        self.information_buffer.add_window(self.information_win)
95
        self.left_tab_win = None
mathieui's avatar
mathieui committed
96

97
        self.tab_win = windows.GlobalInfoBar(self)
98
        # Whether the XML tab is opened
99
        self.xml_tab = None
mathieui's avatar
mathieui committed
100 101
        self.xml_buffer = TextBuffer()

102 103 104
        self.plugins_autoloaded = False
        self.plugin_manager = PluginManager(self)
        self.events = events.EventHandler()
mathieui's avatar
mathieui committed
105
        self.events.add_event_handler('tab_change', self.on_tab_change)
106 107

        self.tabs = Tabs(self.events)
mathieui's avatar
mathieui committed
108 109
        self.previous_tab_nb = 0

110
        own_nick = config.get('default_nick')
111 112 113 114
        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
115

116
        self.size = SizeManager(self)
mathieui's avatar
mathieui committed
117

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

140 141 142 143 144
        # 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
145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174
        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
175
            ######## actions mappings ##########
Maxime Buquet's avatar
Maxime Buquet committed
176
            '_noop': lambda *args, **kwargs: None,
177 178
            '_bookmark': self.command.bookmark,
            '_bookmark_local': self.command.bookmark_local,
mathieui's avatar
mathieui committed
179 180
            '_close_tab': self.close_tab,
            '_disconnect': self.disconnect,
181
            '_quit': self.command.quit,
mathieui's avatar
mathieui committed
182
            '_redraw_screen': self.full_screen_redraw,
183 184
            '_reload_theme': self.command.theme,
            '_remove_bookmark': self.command.remove_bookmark,
mathieui's avatar
mathieui committed
185 186 187 188 189 190 191
            '_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,
192 193
            '_server_cycle': self.command.server_cycle,
            '_show_bookmarks': self.command.bookmarks,
mathieui's avatar
mathieui committed
194
            '_show_important_room': self.go_to_important_room,
195 196 197
            '_show_invitations': self.command.invitations,
            '_show_plugins': self.command.plugins,
            '_show_xmltab': self.command.xml_tab,
mathieui's avatar
mathieui committed
198
            '_toggle_pane': self.toggle_left_pane,
mathieui's avatar
mathieui committed
199
            ###### status actions ######
200 201 202 203 204
            '_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
205
            ##### Custom actions ########
mathieui's avatar
mathieui committed
206
            '_exc_': self.try_execute,
mathieui's avatar
mathieui committed
207 208 209 210
        }
        self.key_func.update(key_func)

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

260 261 262 263 264
        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)
265
        if config.get('enable_user_tune'):
266
            self.xmpp.add_event_handler("user_tune_publish",
267
                                        self.handler.on_tune_event)
268
        if config.get('enable_user_nick'):
269
            self.xmpp.add_event_handler("user_nick_publish",
270
                                        self.handler.on_nick_received)
271
        if config.get('enable_user_mood'):
272
            self.xmpp.add_event_handler("user_mood_publish",
273
                                        self.handler.on_mood_event)
274
        if config.get('enable_user_activity'):
275
            self.xmpp.add_event_handler("user_activity_publish",
276
                                        self.handler.on_activity_event)
277
        if config.get('enable_user_gaming'):
278
            self.xmpp.add_event_handler("user_gaming_publish",
279
                                        self.handler.on_gaming_event)
mathieui's avatar
mathieui committed
280

mathieui's avatar
mathieui committed
281 282 283 284
        all_stanzas = Callback('custom matcher', connection.MatchAll(None),
                               self.handler.incoming_stanza)
        self.xmpp.register_handler(all_stanzas)

mathieui's avatar
mathieui committed
285 286 287 288 289 290 291 292 293 294 295 296
        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
297 298
        # 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
299 300 301 302
        # 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
mathieui's avatar
mathieui committed
303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330
        self.configuration_change_handlers = defaultdict(list)
        config_handlers = [
            ('', self.on_any_config_change),
            ('ack_message_receipts', self.on_ack_receipts_config_change),
            ('connection_check_interval', self.xmpp.set_keepalive_values),
            ('connection_timeout_delay', self.xmpp.set_keepalive_values),
            ('create_gaps', self.on_gaps_config_change),
            ('deterministic_nick_colors', self.on_nick_determinism_changed),
            ('enable_carbons', self.on_carbons_switch),
            ('enable_vertical_tab_list',
             self.on_vertical_tab_list_config_change),
            ('hide_user_list', self.on_hide_user_list_change),
            ('password', self.on_password_change),
            ('plugins_conf_dir',
             self.plugin_manager.on_plugins_conf_dir_change),
            ('plugins_dir', self.plugin_manager.on_plugins_dir_change),
            ('request_message_receipts',
             self.on_request_receipts_config_change),
            ('theme', self.on_theme_config_change),
            ('themes_dir', theming.update_themes_dir),
            ('use_bookmarks_method', self.on_bookmarks_method_config_change),
            ('vertical_tab_list_size',
             self.on_vertical_tab_list_config_change),
        ]
        for option, handler in config_handlers:
            self.add_configuration_handler(option, handler)

    def on_tab_change(self, old_tab: tabs.Tab, new_tab: tabs.Tab):
331 332 333 334 335
        """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
336 337 338 339 340 341
    def on_any_config_change(self, option, value):
        """
        Update the roster, in case a roster option changed.
        """
        roster.modified()

mathieui's avatar
mathieui committed
342
    def add_configuration_handler(self, option: str, callback: Callable):
mathieui's avatar
mathieui committed
343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364
        """
        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
        """
        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)

365 366 367 368 369 370
    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
371 372 373 374
    def on_bookmarks_method_config_change(self, option, value):
        """
        Called when the use_bookmarks_method option changes
        """
375
        if value not in ('pep', 'privatexml'):
mathieui's avatar
mathieui committed
376 377
            return
        self.bookmarks.preferred = value
378
        self.bookmarks.save(self.xmpp, core=self)
mathieui's avatar
mathieui committed
379

mathieui's avatar
mathieui committed
380 381 382 383 384
    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
385
        self.tabs.update_gaps(value.lower() != "false")
mathieui's avatar
mathieui committed
386

387 388 389 390
    def on_request_receipts_config_change(self, option, value):
        """
        Called when the request_message_receipts option changes
        """
mathieui's avatar
mathieui committed
391 392
        self.xmpp.plugin['xep_0184'].auto_request = config.get(
            option, default=True)
393 394 395 396 397

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

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

407 408 409 410 411 412 413 414 415
    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()

416 417 418 419 420 421
    def on_password_change(self, option, value):
        """
        Set the new password in the slixmpp.ClientXMPP object
        """
        self.xmpp.password = value

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

430 431 432 433 434 435 436 437 438 439
    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
440
    def reload_config(self):
mathieui's avatar
mathieui committed
441 442 443 444 445 446
        # 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
447
        theming.reload_theme()
mathieui's avatar
mathieui committed
448 449 450 451 452
        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()
453
        config.read_file()
mathieui's avatar
mathieui committed
454 455 456 457 458 459
        # 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)
460
                new_value = config.get(option, default="", section=section)
mathieui's avatar
mathieui committed
461 462 463
                if new_value != old_value:
                    self.trigger_configuration_change(option, new_value)
        log.debug("Config reloaded.")
464 465 466
        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
467 468 469
        # in case some roster options have changed
        roster.modified()

Eijebong's avatar
Eijebong committed
470 471 472 473 474 475 476 477
    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
478 479
    def exit_from_signal(self, *args, **kwargs):
        """
480
        Quit when receiving SIGHUP or SIGTERM or SIGPIPE
mathieui's avatar
mathieui committed
481 482 483 484

        do not save the config because it is not a normal exit
        (and only roster UI things are not yet saved)
        """
485 486
        sig = args[0]
        signals = {
mathieui's avatar
mathieui committed
487 488 489 490
            1: 'SIGHUP',
            13: 'SIGPIPE',
            15: 'SIGTERM',
        }
491 492

        log.error("%s received. Exiting…", signals[sig])
493
        if config.get('enable_user_mood'):
494
            self.xmpp.plugin['xep_0107'].stop()
495
        if config.get('enable_user_activity'):
496
            self.xmpp.plugin['xep_0108'].stop()
497
        if config.get('enable_user_gaming'):
498
            self.xmpp.plugin['xep_0196'].stop()
mathieui's avatar
mathieui committed
499
        self.plugin_manager.disable_plugins()
500 501
        self.disconnect('%s received' % signals.get(sig))
        self.xmpp.add_event_handler("disconnected", self.exit, disposable=True)
mathieui's avatar
mathieui committed
502 503 504 505 506

    def autoload_plugins(self):
        """
        Load the plugins on startup.
        """
507
        plugins = config.get('plugins_autoload')
mathieui's avatar
mathieui committed
508 509 510 511 512 513 514 515 516 517 518 519 520
        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
521
        self._init_curses(self.stdscr)
mathieui's avatar
mathieui committed
522
        self.call_for_resize()
523
        default_tab = tabs.RosterInfoTab(self)
mathieui's avatar
mathieui committed
524 525
        default_tab.on_gain_focus()
        self.tabs.append(default_tab)
526
        self.information('Welcome to poezio!', 'Info')
mathieui's avatar
mathieui committed
527
        if firstrun:
528
            self.information(
mathieui's avatar
mathieui committed
529
                'It seems that it is the first time you start poezio.\n'
530
                'The online help is here https://doc.poez.io/\n\n'
531
                'No room is joined by default, but you can join poezio’s'
532 533 534 535 536
                ' room (with \x19b/join poezio@muc.poez.io\x19o), where you can'
                ' ask for help or tell us how great it is.\n\n'
                'Note that all of your discussions are currently logged'
                ' to the disk, you can prevent that with'
                ' \x19b/set use_log false\x19o', 'Help')
mathieui's avatar
mathieui committed
537
        self.refresh_window()
louiz’'s avatar
louiz’ committed
538
        self.xmpp.plugin['xep_0012'].begin_idle(jid=self.xmpp.boundjid)
mathieui's avatar
mathieui committed
539

540
    def exit(self, event=None):
mathieui's avatar
mathieui committed
541
        log.debug("exit(%s)", event)
542 543
        asyncio.get_event_loop().stop()

mathieui's avatar
mathieui committed
544 545 546 547 548 549 550 551 552 553 554
    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)

555 556 557 558 559
    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
560
        that a resize occurred and we can act on it. BUT poezio doesn’t call
561 562 563 564 565 566 567 568 569 570 571 572 573 574 575
        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
576
    def on_input_readable(self):
mathieui's avatar
mathieui committed
577 578 579
        """
        main loop waiting for the user to press a key
        """
mathieui's avatar
mathieui committed
580

louiz’'s avatar
louiz’ committed
581 582 583
        log.debug("Input is readable.")
        big_char_list = [replace_key_with_bound(key)\
                         for key in self.read_keyboard()]
mathieui's avatar
mathieui committed
584
        log.debug("Got from keyboard: %s", (big_char_list, ))
louiz’'s avatar
louiz’ committed
585 586 587 588 589 590 591 592 593 594 595

        # 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
596
                    else:
597
                        if self.tabs.current_tab.nb == nb and config.get(
mathieui's avatar
mathieui committed
598
                                'go_to_previous_tab_on_alt_number'):
louiz’'s avatar
louiz’ committed
599 600
                            self.go_to_previous_tab()
                        else:
601
                            self.command.win('%d' % nb)
louiz’'s avatar
louiz’ committed
602 603 604 605
                # search for keyboard shortcut
                func = self.key_func.get(char, None)
                if func:
                    func()
mathieui's avatar
mathieui committed
606
                else:
louiz’'s avatar
louiz’ committed
607 608 609
                    self.do_command(replace_line_breaks(char), False)
            else:
                self.do_command(''.join(char_list), True)
610
        if self.status.show not in ('xa', 'away'):
611
            self.xmpp.plugin['xep_0319'].idle()
612
        self.doupdate()
mathieui's avatar
mathieui committed
613 614 615 616 617

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

    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
636 637
            if not self.get_conversation_by_jid(
                    roster_row.jid, False, fallback_barejid=False):
mathieui's avatar
mathieui committed
638 639 640 641 642
                self.open_conversation_window(roster_row.jid)
            else:
                self.focus_tab_named(roster_row.jid)
        self.refresh_window()

mathieui's avatar
mathieui committed
643
    def get_conversation_messages(self) -> Optional[List[Tuple]]:
mathieui's avatar
mathieui committed
644 645 646 647 648 649 650
        """
        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')
        """
651
        if not isinstance(self.tabs.current_tab, tabs.ChatTab):
mathieui's avatar
mathieui committed
652
            return None
653
        return self.tabs.current_tab.get_conversation_messages()
mathieui's avatar
mathieui committed
654

mathieui's avatar
mathieui committed
655
    def insert_input_text(self, text: str):
mathieui's avatar
mathieui committed
656 657 658 659 660 661 662
        """
        Insert the given text into the current input
        """
        self.do_command(text, True)

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

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

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

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

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

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

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

mathieui's avatar
mathieui committed
749
    def do_command(self, key: str, raw: bool):
750 751
        """
        Execute the action associated with a key
752 753 754

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

mathieui's avatar
mathieui committed
768
    def try_execute(self, line: str):
mathieui's avatar
mathieui committed
769 770 771 772 773
        """
        Try to execute a command in the current tab
        """
        line = '/' + line
        try:
774
            self.tabs.current_tab.execute_command(line)
mathieui's avatar
mathieui committed
775 776 777 778 779
        except:
            log.error('Execute failed (%s)', line, exc_info=True)

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

Link Mauve's avatar
Link Mauve committed
780
    def remove_timed_event(self, event: DelayedEvent) -> None:
mathieui's avatar
mathieui committed
781
        """Remove an existing timed event"""
782
        event.handler.cancel()
mathieui's avatar
mathieui committed
783

Link Mauve's avatar
Link Mauve committed
784
    def add_timed_event(self, event: DelayedEvent) -> None:
mathieui's avatar
mathieui committed
785
        """Add a new timed event"""
mathieui's avatar
mathieui committed
786 787
        event.handler = asyncio.get_event_loop().call_later(
            event.delay, event.callback, *event.args)
mathieui's avatar
mathieui committed
788 789 790

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

791
    def get_status(self) -> str:
mathieui's avatar
mathieui committed
792 793 794 795 796
        """
        Get the last status that was previously set
        """
        return self.status

797
    def set_status(self, pres: str, msg: str) -> None:
mathieui's avatar
mathieui committed
798 799 800 801 802 803
        """
        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)
804
        if config.get('save_status'):
805 806 807 808
            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
809 810 811
                self.information(
                    'Unable to save the status in '
                    'the config file', 'Error')
mathieui's avatar
mathieui committed
812

mathieui's avatar
mathieui committed
813
    def get_bookmark_nickname(self, room_name: str) -> str:
mathieui's avatar
mathieui committed
814 815 816 817
        """
        Returns the nickname associated with a bookmark
        or the default nickname
        """
mathieui's avatar
mathieui committed
818
        bm = self.bookmarks[room_name]
mathieui's avatar
mathieui committed
819 820 821 822
        if bm:
            return bm.nick
        return self.own_nick

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

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

851
    def invite(self, jid: JID, room: JID, reason: Optional[str] = None) -> None:
852 853 854 855 856
        """
        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
857

858 859 860 861 862
        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
863 864 865 866
                    jid, room, reason=reason)
            else:  # fallback
                self.xmpp.plugin['xep_0045'].invite(
                    room, jid, reason=reason or '')
867

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

871
    def get_error_message(self, stanza, deprecated: bool = False):
mathieui's avatar
mathieui committed
872 873
        """
        Takes a stanza of the form <message type='error'><error/></message>
874
        and return a well formed string containing error information
mathieui's avatar
mathieui committed
875
        """
876
        sender = stanza['from']
mathieui's avatar
mathieui committed
877 878 879 880 881 882 883 884 885
        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:
886
                    body = condition or 'Unknown error'
mathieui's avatar
mathieui committed
887 888 889 890
            else:
                if code in ERROR_AND_STATUS_CODES:
                    body = ERROR_AND_STATUS_CODES[code]
                else:
891
                    body = condition or 'Unknown error'
mathieui's avatar
mathieui committed
892
        if code:
893
            message = '%(from)s: %(code)s - %(msg)s: %(body)s' % {
mathieui's avatar
mathieui committed
894 895 896 897 898
                'from': sender,
                'msg': msg,
                'body': body,
                'code': code
            }
mathieui's avatar
mathieui committed
899
        else:
900
            message = '%(from)s: %(msg)s: %(body)s' % {
mathieui's avatar
mathieui committed
901 902 903 904
                'from': sender,
                'msg': msg,
                'body': body
            }
mathieui's avatar
mathieui committed
905 906 907 908
        return message

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

mathieui's avatar
mathieui committed
909
### Tab getters ###
mathieui's avatar
mathieui committed
910

911
    def get_tabs(self, cls: Optional[Type[tabs.Tab]] = None) -> List[tabs.Tab]:
mathieui's avatar
mathieui committed
912
        "Get all the tabs of a type"
Link Mauve's avatar
Link Mauve committed
913
        if cls is None:
914 915
            return self.tabs.get_tabs()
        return self.tabs.by_class(cls)
mathieui's avatar
mathieui committed
916

mathieui's avatar
mathieui committed
917 918
    def get_conversation_by_jid(self,
                                jid: JID,
919 920
                                create: bool = True,
                                fallback_barejid: bool = True) -> Optional[tabs.ChatTab]:
mathieui's avatar
mathieui committed
921 922 923 924 925 926 927 928 929
        """
        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)
930 931
        # We first check if we have a static conversation opened
        # with this precise resource
932 933
        conversation = self.tabs.by_name_and_class(jid.full,
                                                   tabs.StaticConversationTab)
mathieui's avatar
mathieui committed
934
        if jid.bare == jid.full and not conversation:
935 936
            conversation = self.tabs.by_name_and_class(
                jid.full, tabs.DynamicConversationTab)
mathieui's avatar
mathieui committed
937 938 939

        if not conversation and fallback_barejid:
            # If not, we search for a conversation with the bare jid
940 941
            conversation = self.tabs.by_name_and_class(
                jid.bare, tabs.DynamicConversationTab)
mathieui's avatar
mathieui committed
942 943 944 945 946
            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
947 948
                    conversation = self.open_conversation_window(
                        jid.bare, False)
mathieui's avatar
mathieui committed
949 950 951 952
                else:
                    conversation = None
        return conversation

953
    def add_tab(self, new_tab: tabs.Tab, focus: bool = False) -> None:
mathieui's avatar
mathieui committed
954 955 956 957 958 959
        """
        Appends the new_tab in the tab list and
        focus it if focus==True
        """
        self.tabs.append(new_tab)
        if focus:
960
            self.tabs.set_current_tab(new_tab)
mathieui's avatar
mathieui committed
961

962
    def insert_tab(self, old_pos: int, new_pos: int = 99999) -> bool:
mathieui's avatar
mathieui committed
963 964 965 966
        """
        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
967 968
        return self.tabs.insert_tab(old_pos, new_pos,
                                    config.get('create_gaps'))
mathieui's avatar
mathieui committed
969 970 971

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

972
    def rotate_rooms_right(self, args=None) -> None:
mathieui's avatar
mathieui committed
973 974 975
        """
        rotate the rooms list to the right
        """
976
        self.tabs.next()
mathieui's avatar
mathieui committed
977

978
    def rotate_rooms_left(self, args=None) -> None:
mathieui's avatar
mathieui committed
979 980 981
        """
        rotate the rooms list to the right
        """
982
        self.tabs.prev()
mathieui's avatar
mathieui committed
983

984
    def go_to_room_number(self) -> None:
mathieui's avatar
mathieui committed
985 986 987 988
        """
        Read 2 more chars and go to the tab
        with the given number
        """
mathieui's avatar
mathieui committed
989

990
        def read_next_digit(digit) -> None:
991
            try:
mathieui's avatar
mathieui committed
992
                int(digit)
993 994 995 996
            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
997
                self.room_number_jump.clear()
998 999 1000 1001 1002
            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()
1003
                    self.command.win(arg)
1004 1005 1006
                else:
                    # We need to read more digits
                    keyboard.continuation_keys_callback = read_next_digit
mathieui's avatar
mathieui committed
1007

1008
        keyboard.continuation_keys_callback = read_next_digit
mathieui's avatar
mathieui committed
1009

1010
    def go_to_roster(self) -> None:
1011
        "Select the roster as the current tab"
1012
        self.tabs.set_current_tab(self.tabs.first())
mathieui's avatar
mathieui committed
1013

1014
    def go_to_previous_tab(self) -> None:
1015
        "Go to the previous tab"
1016
        self.tabs.restore_previous_tab()
mathieui's avatar
mathieui committed
1017

1018
    def go_to_important_room(self) -> None:
mathieui's avatar
mathieui committed
1019 1020 1021 1022 1023 1024
        """
        Go to the next room with activity, in the order defined in the
        dict tabs.STATE_PRIORITY
        """
        # shortcut
        priority = tabs.STATE_PRIORITY
1025
        tab_refs = {}  # type: Dict[str, List[tabs.Tab]]
mathieui's avatar
mathieui committed
1026
        # put all the active tabs in a dict of lists by state
1027
        for tab in self.tabs.get_tabs():
mathieui's avatar
mathieui committed
1028 1029 1030 1031 1032 1033 1034
            if not tab:
                continue
            if tab.state not in tab_refs:
                tab_refs[tab.state] = [tab]
            else:
                tab_refs[tab.state].append(tab)
        # sort the state by priority and remove those with negative priority
mathieui's avatar
mathieui committed
1035 1036
        states = sorted(
            tab_refs.keys(), key=(lambda x: priority.get(x, 0)), reverse=True)
mathieui's avatar
mathieui committed
1037 1038 1039 1040
        states = [state for state in states if priority.get(state, -1) >= 0]

        for state in states:
            for tab in tab_refs[state]:
1041 1042
                if (tab.nb < self.tabs.current_index
                        and tab_refs[state][-1].nb > self.tabs.current_index):
mathieui's avatar
mathieui committed
1043
                    continue