core.py 85.2 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
Maxime Buquet's avatar
Maxime Buquet committed
16
import uuid
mathieui's avatar
mathieui committed
17
from collections import defaultdict
18
from typing import Callable, Dict, List, Optional, Set, Tuple, Type
19
from xml.etree import ElementTree as ET
20
from functools import partial
mathieui's avatar
mathieui committed
21

22
from slixmpp import JID, InvalidJID
23
from slixmpp.util import FileSystemPerJidCache
mathieui's avatar
mathieui committed
24
from slixmpp.xmlstream.handler import Callback
25
from slixmpp.exceptions import IqError, IqTimeout
mathieui's avatar
mathieui committed
26

27 28 29 30 31
from poezio import connection
from poezio import decorators
from poezio import events
from poezio import multiuserchat as muc
from poezio import tabs
32
from poezio import mam
33 34 35
from poezio import theming
from poezio import timed_events
from poezio import windows
mathieui's avatar
mathieui committed
36

37
from poezio.bookmarks import BookmarkList
38
from poezio.config import config, firstrun
39 40 41 42 43 44 45
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
46
from poezio.user import User
47
from poezio.text_buffer import TextBuffer
Link Mauve's avatar
Link Mauve committed
48
from poezio.timed_events import DelayedEvent
49
from poezio.theming import get_theme
50
from poezio import keyboard, xdg
mathieui's avatar
mathieui committed
51

mathieui's avatar
mathieui committed
52
from poezio.core.completions import CompletionCore
53
from poezio.core.tabs import Tabs
mathieui's avatar
mathieui committed
54 55
from poezio.core.commands import CommandCore
from poezio.core.handlers import HandlerCore
56 57 58 59 60 61 62 63 64
from poezio.core.structs import (
    Command,
    Status,
    DEPRECATED_ERRORS,
    ERROR_AND_STATUS_CODES,
    POSSIBLE_SHOW,
)

from poezio.ui.types import Message, InfoMessage
mathieui's avatar
mathieui committed
65

mathieui's avatar
mathieui committed
66 67
log = logging.getLogger(__name__)

mathieui's avatar
mathieui committed
68

69
class Core:
mathieui's avatar
mathieui committed
70 71 72 73 74
    """
    “Main” class of poezion
    """

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

108
        self.tab_win = windows.GlobalInfoBar(self)
109
        # Whether the XML tab is opened
110
        self.xml_tab = None
mathieui's avatar
mathieui committed
111 112
        self.xml_buffer = TextBuffer()

113 114 115
        self.plugins_autoloaded = False
        self.plugin_manager = PluginManager(self)
        self.events = events.EventHandler()
mathieui's avatar
mathieui committed
116
        self.events.add_event_handler('tab_change', self.on_tab_change)
117 118

        self.tabs = Tabs(self.events)
mathieui's avatar
mathieui committed
119 120
        self.previous_tab_nb = 0

121
        own_nick = config.get('default_nick')
122 123 124 125
        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
126

127
        self.size = SizeManager(self)
mathieui's avatar
mathieui committed
128

129 130 131 132 133 134 135
        # 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
136 137 138 139 140 141 142 143 144 145 146
        # 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
147
        if not config.get('send_initial_presence'):
mathieui's avatar
mathieui committed
148 149 150
            del self.commands['status']
            del self.commands['show']

151 152 153 154 155
        # 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
156 157 158 159 160 161 162 163 164 165 166 167 168
        self.key_func = KeyDict()
        # Key bindings associated with handlers
        # and pseudo-keys used to map actions below.
        key_func = {
            "KEY_PPAGE": self.scroll_page_up,
            "KEY_NPAGE": self.scroll_page_down,
            "^B": self.scroll_line_up,
            "^F": self.scroll_line_down,
            "^X": self.scroll_half_down,
            "^S": self.scroll_half_up,
            "KEY_F(5)": self.rotate_rooms_left,
            "^P": self.rotate_rooms_left,
            "M-[-D": self.rotate_rooms_left,
Link Mauve's avatar
Link Mauve committed
169
            "M-[1;3D": self.rotate_rooms_left,
mathieui's avatar
mathieui committed
170 171 172 173
            'kLFT3': self.rotate_rooms_left,
            "KEY_F(6)": self.rotate_rooms_right,
            "^N": self.rotate_rooms_right,
            "M-[-C": self.rotate_rooms_right,
Link Mauve's avatar
Link Mauve committed
174
            "M-[1;3C": self.rotate_rooms_right,
mathieui's avatar
mathieui committed
175 176 177 178 179 180 181 182 183 184 185 186 187
            '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
188
            ######## actions mappings ##########
Maxime Buquet's avatar
Maxime Buquet committed
189
            '_noop': lambda *args, **kwargs: None,
190 191
            '_bookmark': self.command.bookmark,
            '_bookmark_local': self.command.bookmark_local,
mathieui's avatar
mathieui committed
192 193
            '_close_tab': self.close_tab,
            '_disconnect': self.disconnect,
194
            '_quit': self.command.quit,
mathieui's avatar
mathieui committed
195
            '_redraw_screen': self.full_screen_redraw,
196 197
            '_reload_theme': self.command.theme,
            '_remove_bookmark': self.command.remove_bookmark,
mathieui's avatar
mathieui committed
198 199 200 201 202 203 204
            '_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,
205 206
            '_server_cycle': self.command.server_cycle,
            '_show_bookmarks': self.command.bookmarks,
mathieui's avatar
mathieui committed
207
            '_show_important_room': self.go_to_important_room,
208 209 210
            '_show_invitations': self.command.invitations,
            '_show_plugins': self.command.plugins,
            '_show_xmltab': self.command.xml_tab,
mathieui's avatar
mathieui committed
211
            '_toggle_pane': self.toggle_left_pane,
212
            "_go_to_room_name": self.go_to_room_name,
mathieui's avatar
mathieui committed
213
            ###### status actions ######
214 215 216 217 218
            '_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
219
            ##### Custom actions ########
mathieui's avatar
mathieui committed
220
            '_exc_': self.try_execute,
mathieui's avatar
mathieui committed
221 222 223 224
        }
        self.key_func.update(key_func)

        # Add handlers
mathieui's avatar
mathieui committed
225 226 227 228 229 230 231 232 233 234 235 236 237
        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),
238
            ('reconnect_delay', self.handler.on_reconnect_delay),
mathieui's avatar
mathieui committed
239 240 241 242 243 244 245 246 247 248 249 250 251
            ('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),
252
            ('message_encryption', self.handler.on_encrypted_message),
mathieui's avatar
mathieui committed
253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268
            ('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),
269 270
            ('session_end', self.handler.on_session_end),
            ('sm_failed', self.handler.on_session_end),
271
            ('session_resumed', self.handler.on_session_resumed),
mathieui's avatar
mathieui committed
272 273 274 275 276 277
            ('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)
278

279 280 281 282 283
        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)
284
        if config.get('enable_user_tune'):
285
            self.xmpp.add_event_handler("user_tune_publish",
286
                                        self.handler.on_tune_event)
287
        if config.get('enable_user_nick'):
288
            self.xmpp.add_event_handler("user_nick_publish",
289
                                        self.handler.on_nick_received)
290
        if config.get('enable_user_mood'):
291
            self.xmpp.add_event_handler("user_mood_publish",
292
                                        self.handler.on_mood_event)
293
        if config.get('enable_user_activity'):
294
            self.xmpp.add_event_handler("user_activity_publish",
295
                                        self.handler.on_activity_event)
296
        if config.get('enable_user_gaming'):
297
            self.xmpp.add_event_handler("user_gaming_publish",
298
                                        self.handler.on_gaming_event)
mathieui's avatar
mathieui committed
299

mathieui's avatar
mathieui committed
300 301 302 303
        all_stanzas = Callback('custom matcher', connection.MatchAll(None),
                               self.handler.incoming_stanza)
        self.xmpp.register_handler(all_stanzas)

mathieui's avatar
mathieui committed
304 305 306 307 308 309 310 311 312 313 314 315
        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
316 317
        # 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
318 319 320 321
        # 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
322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349
        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):
350 351 352 353 354
        """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
355 356 357 358 359 360
    def on_any_config_change(self, option, value):
        """
        Update the roster, in case a roster option changed.
        """
        roster.modified()

mathieui's avatar
mathieui committed
361
    def add_configuration_handler(self, option: str, callback: Callable):
mathieui's avatar
mathieui committed
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383
        """
        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)

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

mathieui's avatar
mathieui committed
399 400 401 402 403
    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
404
        self.tabs.update_gaps(value.lower() != "false")
mathieui's avatar
mathieui committed
405

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

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

420 421 422 423 424 425
    def on_vertical_tab_list_config_change(self, option, value):
        """
        Called when the enable_vertical_tab_list option is changed
        """
        self.call_for_resize()

426 427 428 429 430 431 432 433 434
    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()

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

441 442 443 444 445 446 447 448
    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('')

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

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

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

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

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

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

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

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

louiz’'s avatar
louiz’ committed
600 601 602
        log.debug("Input is readable.")
        big_char_list = [replace_key_with_bound(key)\
                         for key in self.read_keyboard()]
mathieui's avatar
mathieui committed
603
        log.debug("Got from keyboard: %s", (big_char_list, ))
louiz’'s avatar
louiz’ committed
604 605 606 607 608 609 610 611 612 613 614

        # 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
615
                    else:
616
                        if self.tabs.current_tab.nb == nb and config.get(
mathieui's avatar
mathieui committed
617
                                'go_to_previous_tab_on_alt_number'):
louiz’'s avatar
louiz’ committed
618 619
                            self.go_to_previous_tab()
                        else:
620
                            self.command.win('%d' % nb)
louiz’'s avatar
louiz’ committed
621 622 623 624
                # search for keyboard shortcut
                func = self.key_func.get(char, None)
                if func:
                    func()
mathieui's avatar
mathieui committed
625
                else:
louiz’'s avatar
louiz’ committed
626 627 628
                    self.do_command(replace_line_breaks(char), False)
            else:
                self.do_command(''.join(char_list), True)
629
        if self.status.show not in ('xa', 'away'):
630
            self.xmpp.plugin['xep_0319'].idle()
631
        self.doupdate()
mathieui's avatar
mathieui committed
632 633 634 635 636

    def save_config(self):
        """
        Save config in the file just before exit
        """
637 638
        ok = roster.save_to_config_file()
        ok = ok and config.silent_set('info_win_height',
mathieui's avatar
mathieui committed
639
                                      self.information_win_size, 'var')
640
        if not ok:
mathieui's avatar
mathieui committed
641 642 643
            self.information(
                'Unable to save runtime preferences'
                ' in the config file', 'Error')
mathieui's avatar
mathieui committed
644 645 646 647 648 649 650

    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):
651
                self.open_conversation_window(JID(roster_row.bare_jid))
mathieui's avatar
mathieui committed
652 653 654
            else:
                self.focus_tab_named(roster_row.bare_jid)
        if isinstance(roster_row, Resource):
mathieui's avatar
mathieui committed
655 656
            if not self.get_conversation_by_jid(
                    roster_row.jid, False, fallback_barejid=False):
657
                self.open_conversation_window(JID(roster_row.jid))
mathieui's avatar
mathieui committed
658 659 660 661
            else:
                self.focus_tab_named(roster_row.jid)
        self.refresh_window()

mathieui's avatar
mathieui committed
662
    def get_conversation_messages(self) -> Optional[List[Tuple]]:
mathieui's avatar
mathieui committed
663 664 665 666 667 668 669
        """
        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')
        """
670
        if not isinstance(self.tabs.current_tab, tabs.ChatTab):
mathieui's avatar
mathieui committed
671
            return None
672
        return self.tabs.current_tab.get_conversation_messages()
mathieui's avatar
mathieui committed
673

mathieui's avatar
mathieui committed
674
    def insert_input_text(self, text: str):
mathieui's avatar
mathieui committed
675 676 677 678 679 680 681
        """
        Insert the given text into the current input
        """
        self.do_command(text, True)

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

mathieui's avatar
mathieui committed
682
    def execute(self, line: str):
mathieui's avatar
mathieui committed
683 684 685 686 687 688
        """
        Execute the /command or just send the line on the current room
        """
        if line == "":
            return
        if line.startswith('/'):
689
            command = line.strip().split()[0][1:]
mathieui's avatar
mathieui committed
690
            arg = line[2 + len(command):]  # jump the '/' and the ' '
mathieui's avatar
mathieui committed
691 692
            # example. on "/link 0 open", command = "link" and arg = "0 open"
            if command in self.commands:
693
                func = self.commands[command].func
mathieui's avatar
mathieui committed
694 695 696
                func(arg)
                return
            else:
mathieui's avatar
mathieui committed
697
                self.information("Unknown command (%s)" % (command), 'Error')
mathieui's avatar
mathieui committed
698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726

    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.
        """
727
        if config.get('exec_remote'):
mathieui's avatar
mathieui committed
728
            # We just write the command in the fifo
729
            fifo_path = config.get('remote_fifo_path')
Link Mauve's avatar
Link Mauve committed
730
            filename = os.path.join(fifo_path, 'poezio.fifo')
mathieui's avatar
mathieui committed
731 732
            if not self.remote_fifo:
                try:
mathieui's avatar
mathieui committed
733
                    self.remote_fifo = Fifo(filename, 'w')
734
                except (OSError, IOError) as exc:
mathieui's avatar
mathieui committed
735 736
                    log.error(
                        'Could not open the fifo for writing (%s)',
Link Mauve's avatar
Link Mauve committed
737
                        filename,
mathieui's avatar
mathieui committed
738
                        exc_info=True)
mathieui's avatar
mathieui committed
739 740 741
                    self.information(
                        'Could not open the fifo '
                        'file for writing: %s' % exc, 'Error')
mathieui's avatar
mathieui committed
742
                    return
743 744 745

            args = (pipes.quote(arg.replace('\n', ' ')) for arg in command)
            command_str = ' '.join(args) + '\n'
mathieui's avatar
mathieui committed
746 747
            try:
                self.remote_fifo.write(command_str)
Link Mauve's avatar
Link Mauve committed
748
            except IOError as exc:
mathieui's avatar
mathieui committed
749 750
                log.error(
                    'Could not write in the fifo (%s): %s',
Link Mauve's avatar
Link Mauve committed
751
                    filename,
mathieui's avatar
mathieui committed
752 753
                    repr(command),
                    exc_info=True)
754 755
                self.information('Could not execute %s: %s' % (command, exc),
                                 'Error')
mathieui's avatar
mathieui committed
756 757
                self.remote_fifo = None
        else:
758
            executor = Executor(command)
mathieui's avatar
mathieui committed
759
            try:
760 761
                executor.start()
            except ValueError as exc:
mathieui's avatar
mathieui committed
762 763 764 765
                log.error(
                    'Could not execute command (%s)',
                    repr(command),
                    exc_info=True)
766
                self.information(str(exc), 'Error')
mathieui's avatar
mathieui committed
767

mathieui's avatar
mathieui committed
768
    def do_command(self, key: str, raw: bool):
769 770
        """
        Execute the action associated with a key
771 772 773

        Or if keyboard.continuation_keys_callback is set, call it instead. See
        the comment of this variable.
774
        """
mathieui's avatar
mathieui committed
775 776
        if not key:
            return
777 778 779 780 781 782 783 784
        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:
785
            self.tabs.current_tab.on_input(key, raw)
mathieui's avatar
mathieui committed
786

mathieui's avatar
mathieui committed
787
    def try_execute(self, line: str):
mathieui's avatar
mathieui committed
788 789 790 791 792
        """
        Try to execute a command in the current tab
        """
        line = '/' + line
        try:
793
            self.tabs.current_tab.execute_command(line)
mathieui's avatar
mathieui committed
794 795 796 797 798
        except:
            log.error('Execute failed (%s)', line, exc_info=True)

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

Link Mauve's avatar
Link Mauve committed
799
    def remove_timed_event(self, event: DelayedEvent) -> None:
mathieui's avatar
mathieui committed
800
        """Remove an existing timed event"""
801
        event.handler.cancel()
mathieui's avatar
mathieui committed
802

Link Mauve's avatar
Link Mauve committed
803
    def add_timed_event(self, event: DelayedEvent) -> None:
mathieui's avatar
mathieui committed
804
        """Add a new timed event"""
mathieui's avatar
mathieui committed
805 806
        event.handler = asyncio.get_event_loop().call_later(
            event.delay, event.callback, *event.args)
mathieui's avatar
mathieui committed
807 808 809

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

810
    def get_status(self) -> str:
mathieui's avatar
mathieui committed
811 812 813 814 815
        """
        Get the last status that was previously set
        """
        return self.status

816
    def set_status(self, pres: str, msg: str) -> None:
mathieui's avatar
mathieui committed
817 818 819 820 821 822
        """
        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)
823
        if config.get('save_status'):
824 825 826 827
            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
828 829 830
                self.information(
                    'Unable to save the status in '
                    'the config file', 'Error')
mathieui's avatar
mathieui committed
831

mathieui's avatar
mathieui committed
832
    def get_bookmark_nickname(self, room_name: str) -> str:
mathieui's avatar
mathieui committed
833 834 835 836
        """
        Returns the nickname associated with a bookmark
        or the default nickname
        """
mathieui's avatar
mathieui committed
837
        bm = self.bookmarks[room_name]
mathieui's avatar
mathieui committed
838 839 840 841
        if bm:
            return bm.nick
        return self.own_nick

842
    def disconnect(self, msg: str = '', reconnect: bool = False) -> None:
mathieui's avatar
mathieui committed
843 844 845 846
        """
        Disconnect from remote server and correctly set the states of all
        parts of the client (for example, set the MucTabs as not joined, etc)
        """
847
        self.legitimate_disconnect = True
mathieui's avatar
mathieui committed
848
        if reconnect:
849 850
            self.xmpp.reconnect(wait=0.0, reason=msg)
        else:
851
            for tab in self.get_tabs(tabs.MucTab):
852
                tab.leave_room(msg)
853
            self.xmpp.disconnect(reason=msg)
mathieui's avatar
mathieui committed
854

mathieui's avatar
mathieui committed
855
    def send_message(self, msg: str) -> bool:
mathieui's avatar
mathieui committed
856
        """
857 858
        Function to use in plugins to send a message in the current
        conversation.
mathieui's avatar
mathieui committed
859 860
        Returns False if the current tab is not a conversation tab
        """
861
        if not isinstance(self.tabs.current_tab, tabs.ChatTab):
mathieui's avatar
mathieui committed
862
            return False
863
        self.tabs.current_tab.command_say(msg)
mathieui's avatar
mathieui committed
864 865
        return True

866
    def invite(self, jid: JID, room: JID, reason: Optional[str] = None) -> None:
867 868 869 870 871
        """
        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
872

873 874 875 876 877
        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
878 879 880 881
                    jid, room, reason=reason)
            else:  # fallback
                self.xmpp.plugin['xep_0045'].invite(
                    room, jid, reason=reason or '')
882

mathieui's avatar
mathieui committed
883 884
        self.xmpp.plugin['xep_0030'].get_info(
            jid=jid, timeout=5, callback=callback)
885

886
    def _impromptu_room_form(self, room):
887
        fields = [
888 889 890 891 892 893 894
            ('hidden', 'FORM_TYPE', 'http://jabber.org/protocol/muc#roomconfig'),
            ('boolean', 'muc#roomconfig_changesubject', True),
            ('boolean', 'muc#roomconfig_allowinvites', True),
            ('boolean', 'muc#roomconfig_persistent', True),
            ('boolean', 'muc#roomconfig_membersonly', True),
            ('boolean', 'muc#roomconfig_publicroom', False),
            ('list-single', 'muc#roomconfig_whois', 'anyone'),
895 896 897 898
            # MAM
            ('boolean', 'muc#roomconfig_enablearchiving', True),  # Prosody
            ('boolean', 'mam', True),  # Ejabberd community
            ('boolean', 'muc#roomconfig_mam', True),  # Ejabberd saas
899 900 901 902 903
        ]

        form = self.xmpp['xep_0004'].make_form()
        form['type'] = 'submit'
        for field in fields:
904 905 906 907 908
            form.add_field(
                ftype=field[0],
                var=field[1],
                value=field[2],
            )
909 910 911 912 913 914 915 916 917 918

        iq = self.xmpp.Iq()
        iq['type'] = 'set'
        iq['to'] = room
        query = ET.Element('{http://jabber.org/protocol/muc#owner}query')
        query.append(form.xml)
        iq.append(query)
        return iq

    async def impromptu(self, jids: Set[JID]) -> None:
Maxime Buquet's avatar
Maxime Buquet committed
919 920 921 922 923 924 925
        """
        Generates a new "Impromptu" room with a random localpart on the muc
        component of the user who initiated the request. One the room is
        created and the first user has joined, send invites for specified
        contacts to join in.
        """

926
        results = await self.xmpp['xep_0030'].get_info_from_domain()
927

928 929 930 931 932
        muc_from_identity = ''
        for info in results:
            for identity in info['disco_info']['identities']:
                if identity[0] == 'conference' and identity[1] == 'text':
                    muc_from_identity = info['from'].bare
933

934 935 936 937 938 939 940 941 942 943 944 945
        # Use config.default_muc_service as muc component if available,
        # otherwise find muc component by disco#items-ing the user domain.
        # If not, give up
        default_muc = config.get('default_muc_service', muc_from_identity)
        if not default_muc:
            self.information(
                "Error finding a MUC service to join. If your server does not "
                "provide one, set 'default_muc_service' manually to a MUC "
                "service that allows room creation.",
                'Error'
            )
            return
946

947
        nick = self.own_nick
948
        localpart = uuid.uuid4().hex
949 950 951 952 953 954 955 956 957
        room_str = '{!s}@{!s}'.format(localpart, default_muc)
        try:
            room = JID(room_str)
        except InvalidJID:
            self.information(
                'The generated XMPP address is invalid: {!s}'.format(room_str),
                'Error'
            )
            return None
Maxime Buquet's avatar
Maxime Buquet committed
958

959
        self.open_new_room(room, nick).join()
960
        iq = self._impromptu_room_form(room)
961 962 963
        try:
            await iq.send()
        except (IqError, IqTimeout):
964
            self.information('Failed to configure impromptu room.', 'Info')
965 966
            # TODO: destroy? leave room.
            return None
Maxime Buquet's avatar
Maxime Buquet committed
967

968
        self.information('Room %s created' % room, 'Info')
Maxime Buquet's avatar
Maxime Buquet committed
969

970 971
        for jid in jids:
            self.invite(jid, room)
Maxime Buquet's avatar
Maxime Buquet committed
972

973
    def get_error_message(self, stanza, deprecated: bool = False):
mathieui's avatar
mathieui committed
974 975
        """
        Takes a stanza of the form <message type='error'><error/></message>
976
        and return a well formed string containing error information
mathieui's avatar
mathieui committed
977
        """
978
        sender = stanza['from']
mathieui's avatar
mathieui committed
979 980 981 982 983 984 985 986 987
        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:
988
                    body = condition or 'Unknown error'
mathieui's avatar
mathieui committed
989 990 991 992
            else:
                if code in ERROR_AND_STATUS_CODES:
                    body = ERROR_AND_STATUS_CODES[code]
                else:
993
                    body = condition or 'Unknown error'
mathieui's avatar
mathieui committed
994
        if code:
995
            message = '%(from)s: %(code)s - %(msg)s: %(body)s' % {
mathieui's avatar
mathieui committed
996 997 998 999 1000
                'from': sender,
                'msg': msg,
                'body': body,
                'code': code
            }
mathieui's avatar
mathieui committed
1001
        else:
1002
            message = '%(from)s: %(msg)s: %(body)s' % {
mathieui's avatar
mathieui committed
1003 1004 1005 1006
                'from': sender,
                'msg': msg,
                'body': body
            }
mathieui's avatar
mathieui committed
1007 1008 1009 1010
        return message

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

mathieui's avatar
mathieui committed
1011
### Tab getters ###
mathieui's avatar
mathieui committed
1012

mathieui's avatar
mathieui committed
1013
    def get_tabs(self, cls: Type[tabs.Tab] = None) -> List[tabs.Tab]:
mathieui's avatar
mathieui committed
1014
        "Get all the tabs of a type"
Link Mauve's avatar
Link Mauve committed
1015
        if cls is None:
1016 1017
            return self.tabs.get_tabs()
        return self.tabs.by_class(cls)
mathieui's avatar
mathieui committed
1018

mathieui's avatar
mathieui committed
1019 1020
    def get_conversation_by_jid(self,
                                jid: JID,
1021 1022
                                create: bool = True,
                                fallback_barejid: bool = True) -> Optional[tabs.ChatTab]:
mathieui's avatar
mathieui committed
1023 1024 1025 1026 1027 1028 1029 1030
        """
        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.
        """
Maxime Buquet's avatar
Maxime Buquet committed
1031
        jid = JID(jid)
1032 1033
        # We first check if we have a static conversation opened
        # with this precise resource