core.py 85.6 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 19 20 21 22 23 24 25 26 27 28
from typing import (
    cast,
    Callable,
    Dict,
    List,
    Optional,
    Set,
    Tuple,
    Type,
    TypeVar,
)
29
from xml.etree import ElementTree as ET
30
from functools import partial
mathieui's avatar
mathieui committed
31

32
from slixmpp import JID, InvalidJID
33
from slixmpp.util import FileSystemPerJidCache
mathieui's avatar
mathieui committed
34
from slixmpp.xmlstream.handler import Callback
35
from slixmpp.exceptions import IqError, IqTimeout
mathieui's avatar
mathieui committed
36

37 38 39 40 41
from poezio import connection
from poezio import decorators
from poezio import events
from poezio import multiuserchat as muc
from poezio import tabs
42
from poezio import mam
43 44 45
from poezio import theming
from poezio import timed_events
from poezio import windows
mathieui's avatar
mathieui committed
46

47
from poezio.bookmarks import BookmarkList
48
from poezio.config import config, firstrun
49 50 51 52 53 54 55
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
56
from poezio.user import User
57
from poezio.text_buffer import TextBuffer
Link Mauve's avatar
Link Mauve committed
58
from poezio.timed_events import DelayedEvent
59
from poezio.theming import get_theme
60
from poezio import keyboard, xdg
mathieui's avatar
mathieui committed
61

mathieui's avatar
mathieui committed
62
from poezio.core.completions import CompletionCore
63
from poezio.core.tabs import Tabs
mathieui's avatar
mathieui committed
64 65
from poezio.core.commands import CommandCore
from poezio.core.handlers import HandlerCore
66 67 68 69 70 71 72 73 74
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
75

mathieui's avatar
mathieui committed
76 77
log = logging.getLogger(__name__)

78
T = TypeVar('T', bound=tabs.Tab)
mathieui's avatar
mathieui committed
79

80
class Core:
mathieui's avatar
mathieui committed
81 82 83 84 85
    """
    “Main” class of poezion
    """

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

121
        self.tab_win = windows.GlobalInfoBar(self)
122
        # Whether the XML tab is opened
123
        self.xml_tab = None
mathieui's avatar
mathieui committed
124 125
        self.xml_buffer = TextBuffer()

126 127 128
        self.plugins_autoloaded = False
        self.plugin_manager = PluginManager(self)
        self.events = events.EventHandler()
mathieui's avatar
mathieui committed
129
        self.events.add_event_handler('tab_change', self.on_tab_change)
130 131

        self.tabs = Tabs(self.events)
mathieui's avatar
mathieui committed
132 133
        self.previous_tab_nb = 0

134
        own_nick = config.get('default_nick')
135 136 137 138
        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
139

140
        self.size = SizeManager(self)
mathieui's avatar
mathieui committed
141

142 143 144 145 146 147 148
        # 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
149 150 151 152 153 154 155 156 157 158 159
        # 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
160
        if not config.get('send_initial_presence'):
mathieui's avatar
mathieui committed
161 162 163
            del self.commands['status']
            del self.commands['show']

164 165 166 167 168
        # 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
169 170 171 172 173 174 175 176 177 178 179 180 181
        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
182
            "M-[1;3D": self.rotate_rooms_left,
mathieui's avatar
mathieui committed
183 184 185 186
            '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
187
            "M-[1;3C": self.rotate_rooms_right,
mathieui's avatar
mathieui committed
188 189 190 191 192 193 194 195 196 197 198 199 200
            '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
201
            ######## actions mappings ##########
Maxime Buquet's avatar
Maxime Buquet committed
202
            '_noop': lambda *args, **kwargs: None,
203 204
            '_bookmark': self.command.bookmark,
            '_bookmark_local': self.command.bookmark_local,
mathieui's avatar
mathieui committed
205 206
            '_close_tab': self.close_tab,
            '_disconnect': self.disconnect,
207
            '_quit': self.command.quit,
mathieui's avatar
mathieui committed
208
            '_redraw_screen': self.full_screen_redraw,
209 210
            '_reload_theme': self.command.theme,
            '_remove_bookmark': self.command.remove_bookmark,
mathieui's avatar
mathieui committed
211 212 213 214 215 216 217
            '_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,
218 219
            '_server_cycle': self.command.server_cycle,
            '_show_bookmarks': self.command.bookmarks,
mathieui's avatar
mathieui committed
220
            '_show_important_room': self.go_to_important_room,
221 222 223
            '_show_invitations': self.command.invitations,
            '_show_plugins': self.command.plugins,
            '_show_xmltab': self.command.xml_tab,
mathieui's avatar
mathieui committed
224
            '_toggle_pane': self.toggle_left_pane,
225
            "_go_to_room_name": self.go_to_room_name,
mathieui's avatar
mathieui committed
226
            ###### status actions ######
227 228 229 230 231
            '_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
232
            ##### Custom actions ########
mathieui's avatar
mathieui committed
233
            '_exc_': self.try_execute,
mathieui's avatar
mathieui committed
234 235 236 237
        }
        self.key_func.update(key_func)

        # Add handlers
mathieui's avatar
mathieui committed
238 239 240 241 242 243 244 245 246 247 248 249 250
        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),
251
            ('reconnect_delay', self.handler.on_reconnect_delay),
mathieui's avatar
mathieui committed
252 253 254 255 256 257 258 259 260 261 262 263 264
            ('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),
265
            ('message_encryption', self.handler.on_encrypted_message),
mathieui's avatar
mathieui committed
266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281
            ('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),
282 283
            ('session_end', self.handler.on_session_end),
            ('sm_failed', self.handler.on_session_end),
284
            ('session_resumed', self.handler.on_session_resumed),
mathieui's avatar
mathieui committed
285 286 287 288 289 290
            ('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)
291

292 293 294 295 296
        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)
297
        if config.get('enable_user_tune'):
298
            self.xmpp.add_event_handler("user_tune_publish",
299
                                        self.handler.on_tune_event)
300
        if config.get('enable_user_nick'):
301
            self.xmpp.add_event_handler("user_nick_publish",
302
                                        self.handler.on_nick_received)
303
        if config.get('enable_user_mood'):
304
            self.xmpp.add_event_handler("user_mood_publish",
305
                                        self.handler.on_mood_event)
306
        if config.get('enable_user_activity'):
307
            self.xmpp.add_event_handler("user_activity_publish",
308
                                        self.handler.on_activity_event)
309
        if config.get('enable_user_gaming'):
310
            self.xmpp.add_event_handler("user_gaming_publish",
311
                                        self.handler.on_gaming_event)
mathieui's avatar
mathieui committed
312

mathieui's avatar
mathieui committed
313 314 315 316
        all_stanzas = Callback('custom matcher', connection.MatchAll(None),
                               self.handler.incoming_stanza)
        self.xmpp.register_handler(all_stanzas)

mathieui's avatar
mathieui committed
317 318 319 320 321 322 323 324 325 326 327 328
        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
329 330
        # 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
331 332 333 334
        # 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
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362
        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):
363 364 365 366 367
        """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
368 369 370 371 372 373
    def on_any_config_change(self, option, value):
        """
        Update the roster, in case a roster option changed.
        """
        roster.modified()

mathieui's avatar
mathieui committed
374
    def add_configuration_handler(self, option: str, callback: Callable):
mathieui's avatar
mathieui committed
375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396
        """
        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)

397 398 399 400 401 402
    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
403 404 405 406
    def on_bookmarks_method_config_change(self, option, value):
        """
        Called when the use_bookmarks_method option changes
        """
407
        if value not in ('pep', 'privatexml'):
mathieui's avatar
mathieui committed
408 409
            return
        self.bookmarks.preferred = value
410
        self.bookmarks.save(self.xmpp, core=self)
mathieui's avatar
mathieui committed
411

mathieui's avatar
mathieui committed
412 413 414 415 416
    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
417
        self.tabs.update_gaps(value.lower() != "false")
mathieui's avatar
mathieui committed
418

419 420 421 422
    def on_request_receipts_config_change(self, option, value):
        """
        Called when the request_message_receipts option changes
        """
mathieui's avatar
mathieui committed
423 424
        self.xmpp.plugin['xep_0184'].auto_request = config.get(
            option, default=True)
425 426 427 428 429

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

433 434 435 436 437 438
    def on_vertical_tab_list_config_change(self, option, value):
        """
        Called when the enable_vertical_tab_list option is changed
        """
        self.call_for_resize()

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

448 449 450 451 452 453
    def on_password_change(self, option, value):
        """
        Set the new password in the slixmpp.ClientXMPP object
        """
        self.xmpp.password = value

454 455 456 457 458 459 460 461
    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('')

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

Eijebong's avatar
Eijebong committed
502 503 504 505 506 507 508 509
    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
510 511
    def exit_from_signal(self, *args, **kwargs):
        """
512
        Quit when receiving SIGHUP or SIGTERM or SIGPIPE
mathieui's avatar
mathieui committed
513 514 515 516

        do not save the config because it is not a normal exit
        (and only roster UI things are not yet saved)
        """
517 518
        sig = args[0]
        signals = {
mathieui's avatar
mathieui committed
519 520 521 522
            1: 'SIGHUP',
            13: 'SIGPIPE',
            15: 'SIGTERM',
        }
523 524

        log.error("%s received. Exiting…", signals[sig])
525
        if config.get('enable_user_mood'):
526
            self.xmpp.plugin['xep_0107'].stop()
527
        if config.get('enable_user_activity'):
528
            self.xmpp.plugin['xep_0108'].stop()
529
        if config.get('enable_user_gaming'):
530
            self.xmpp.plugin['xep_0196'].stop()
mathieui's avatar
mathieui committed
531
        self.plugin_manager.disable_plugins()
532 533
        self.disconnect('%s received' % signals.get(sig))
        self.xmpp.add_event_handler("disconnected", self.exit, disposable=True)
mathieui's avatar
mathieui committed
534 535 536 537 538

    def autoload_plugins(self):
        """
        Load the plugins on startup.
        """
539
        plugins = config.get('plugins_autoload')
mathieui's avatar
mathieui committed
540 541
        if ':' in plugins:
            for plugin in plugins.split(':'):
542
                self.plugin_manager.load(plugin, unload_first=False)
mathieui's avatar
mathieui committed
543 544
        else:
            for plugin in plugins.split():
545
                self.plugin_manager.load(plugin, unload_first=False)
mathieui's avatar
mathieui committed
546 547 548 549 550 551 552
        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
553
        self._init_curses(self.stdscr)
mathieui's avatar
mathieui committed
554
        self.call_for_resize()
555
        default_tab = tabs.RosterInfoTab(self)
mathieui's avatar
mathieui committed
556 557
        default_tab.on_gain_focus()
        self.tabs.append(default_tab)
558
        self.information('Welcome to poezio!', 'Info')
559 560 561 562 563 564
        if curses.COLORS < 256:
            self.information(
                'Your terminal does not appear to support 256 colors, the UI'
                ' colors will probably be ugly',
                'Error',
            )
mathieui's avatar
mathieui committed
565
        if firstrun:
566
            self.information(
mathieui's avatar
mathieui committed
567
                'It seems that it is the first time you start poezio.\n'
568
                'The online help is here https://doc.poez.io/\n\n'
569
                'No room is joined by default, but you can join poezio’s'
570 571 572 573 574
                ' 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
575
        self.refresh_window()
louiz’'s avatar
louiz’ committed
576
        self.xmpp.plugin['xep_0012'].begin_idle(jid=self.xmpp.boundjid)
mathieui's avatar
mathieui committed
577

578
    def exit(self, event=None):
mathieui's avatar
mathieui committed
579
        log.debug("exit(%s)", event)
580 581
        asyncio.get_event_loop().stop()

mathieui's avatar
mathieui committed
582 583 584 585 586 587 588 589 590 591 592
    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)

593 594 595 596 597
    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
598
        that a resize occurred and we can act on it. BUT poezio doesn’t call
599 600 601 602 603 604 605 606 607 608 609 610 611 612 613
        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
614
    def on_input_readable(self):
mathieui's avatar
mathieui committed
615 616 617
        """
        main loop waiting for the user to press a key
        """
mathieui's avatar
mathieui committed
618

louiz’'s avatar
louiz’ committed
619 620 621
        log.debug("Input is readable.")
        big_char_list = [replace_key_with_bound(key)\
                         for key in self.read_keyboard()]
mathieui's avatar
mathieui committed
622
        log.debug("Got from keyboard: %s", (big_char_list, ))
louiz’'s avatar
louiz’ committed
623 624 625 626 627 628 629 630 631 632 633

        # 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
634
                    else:
635
                        if self.tabs.current_tab.nb == nb and config.get(
mathieui's avatar
mathieui committed
636
                                'go_to_previous_tab_on_alt_number'):
louiz’'s avatar
louiz’ committed
637 638
                            self.go_to_previous_tab()
                        else:
639
                            self.command.win('%d' % nb)
louiz’'s avatar
louiz’ committed
640 641 642 643
                # search for keyboard shortcut
                func = self.key_func.get(char, None)
                if func:
                    func()
mathieui's avatar
mathieui committed
644
                else:
louiz’'s avatar
louiz’ committed
645 646 647
                    self.do_command(replace_line_breaks(char), False)
            else:
                self.do_command(''.join(char_list), True)
648
        if self.status.show not in ('xa', 'away'):
649
            self.xmpp.plugin['xep_0319'].idle()
650
        self.doupdate()
mathieui's avatar
mathieui committed
651 652 653 654 655

    def save_config(self):
        """
        Save config in the file just before exit
        """
656 657
        ok = roster.save_to_config_file()
        ok = ok and config.silent_set('info_win_height',
mathieui's avatar
mathieui committed
658
                                      self.information_win_size, 'var')
659
        if not ok:
mathieui's avatar
mathieui committed
660 661 662
            self.information(
                'Unable to save runtime preferences'
                ' in the config file', 'Error')
mathieui's avatar
mathieui committed
663 664 665 666 667 668 669

    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):
670
                self.open_conversation_window(JID(roster_row.bare_jid))
mathieui's avatar
mathieui committed
671 672 673
            else:
                self.focus_tab_named(roster_row.bare_jid)
        if isinstance(roster_row, Resource):
mathieui's avatar
mathieui committed
674 675
            if not self.get_conversation_by_jid(
                    roster_row.jid, False, fallback_barejid=False):
676
                self.open_conversation_window(JID(roster_row.jid))
mathieui's avatar
mathieui committed
677 678 679 680
            else:
                self.focus_tab_named(roster_row.jid)
        self.refresh_window()

mathieui's avatar
mathieui committed
681
    def get_conversation_messages(self) -> Optional[List[Tuple]]:
mathieui's avatar
mathieui committed
682 683 684 685 686 687 688
        """
        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')
        """
689
        if not isinstance(self.tabs.current_tab, tabs.ChatTab):
mathieui's avatar
mathieui committed
690
            return None
691
        return self.tabs.current_tab.get_conversation_messages()
mathieui's avatar
mathieui committed
692

mathieui's avatar
mathieui committed
693
    def insert_input_text(self, text: str):
mathieui's avatar
mathieui committed
694 695 696 697 698 699 700
        """
        Insert the given text into the current input
        """
        self.do_command(text, True)

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

mathieui's avatar
mathieui committed
701
    def execute(self, line: str):
mathieui's avatar
mathieui committed
702 703 704 705 706 707
        """
        Execute the /command or just send the line on the current room
        """
        if line == "":
            return
        if line.startswith('/'):
708
            command = line.strip().split()[0][1:]
mathieui's avatar
mathieui committed
709
            arg = line[2 + len(command):]  # jump the '/' and the ' '
mathieui's avatar
mathieui committed
710 711
            # example. on "/link 0 open", command = "link" and arg = "0 open"
            if command in self.commands:
712
                func = self.commands[command].func
mathieui's avatar
mathieui committed
713 714 715
                func(arg)
                return
            else:
mathieui's avatar
mathieui committed
716
                self.information("Unknown command (%s)" % (command), 'Error')
mathieui's avatar
mathieui committed
717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745

    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.
        """
746
        if config.get('exec_remote'):
mathieui's avatar
mathieui committed
747
            # We just write the command in the fifo
748
            fifo_path = config.get('remote_fifo_path')
Link Mauve's avatar
Link Mauve committed
749
            filename = os.path.join(fifo_path, 'poezio.fifo')
mathieui's avatar
mathieui committed
750 751
            if not self.remote_fifo:
                try:
mathieui's avatar
mathieui committed
752
                    self.remote_fifo = Fifo(filename, 'w')
753
                except (OSError, IOError) as exc:
mathieui's avatar
mathieui committed
754 755
                    log.error(
                        'Could not open the fifo for writing (%s)',
Link Mauve's avatar
Link Mauve committed
756
                        filename,
mathieui's avatar
mathieui committed
757
                        exc_info=True)
mathieui's avatar
mathieui committed
758 759 760
                    self.information(
                        'Could not open the fifo '
                        'file for writing: %s' % exc, 'Error')
mathieui's avatar
mathieui committed
761
                    return
762 763 764

            args = (pipes.quote(arg.replace('\n', ' ')) for arg in command)
            command_str = ' '.join(args) + '\n'
mathieui's avatar
mathieui committed
765 766
            try:
                self.remote_fifo.write(command_str)
Link Mauve's avatar
Link Mauve committed
767
            except IOError as exc:
mathieui's avatar
mathieui committed
768 769
                log.error(
                    'Could not write in the fifo (%s): %s',
Link Mauve's avatar
Link Mauve committed
770
                    filename,
mathieui's avatar
mathieui committed
771 772
                    repr(command),
                    exc_info=True)
773 774
                self.information('Could not execute %s: %s' % (command, exc),
                                 'Error')
mathieui's avatar
mathieui committed
775 776
                self.remote_fifo = None
        else:
777
            executor = Executor(command)
mathieui's avatar
mathieui committed
778
            try:
779 780
                executor.start()
            except ValueError as exc:
mathieui's avatar
mathieui committed
781 782 783 784
                log.error(
                    'Could not execute command (%s)',
                    repr(command),
                    exc_info=True)
785
                self.information(str(exc), 'Error')
mathieui's avatar
mathieui committed
786

mathieui's avatar
mathieui committed
787
    def do_command(self, key: str, raw: bool):
788 789
        """
        Execute the action associated with a key
790 791 792

        Or if keyboard.continuation_keys_callback is set, call it instead. See
        the comment of this variable.
793
        """
mathieui's avatar
mathieui committed
794 795
        if not key:
            return
796 797 798 799 800 801 802 803
        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:
804
            self.tabs.current_tab.on_input(key, raw)
mathieui's avatar
mathieui committed
805

mathieui's avatar
mathieui committed
806
    def try_execute(self, line: str):
mathieui's avatar
mathieui committed
807 808 809 810 811
        """
        Try to execute a command in the current tab
        """
        line = '/' + line
        try:
812
            self.tabs.current_tab.execute_command(line)
mathieui's avatar
mathieui committed
813 814 815 816 817
        except:
            log.error('Execute failed (%s)', line, exc_info=True)

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

Link Mauve's avatar
Link Mauve committed
818
    def remove_timed_event(self, event: DelayedEvent) -> None:
mathieui's avatar
mathieui committed
819
        """Remove an existing timed event"""
820
        event.handler.cancel()
mathieui's avatar
mathieui committed
821

Link Mauve's avatar
Link Mauve committed
822
    def add_timed_event(self, event: DelayedEvent) -> None:
mathieui's avatar
mathieui committed
823
        """Add a new timed event"""
mathieui's avatar
mathieui committed
824 825
        event.handler = asyncio.get_event_loop().call_later(
            event.delay, event.callback, *event.args)
mathieui's avatar
mathieui committed
826 827 828

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

829
    def get_status(self) -> Status:
mathieui's avatar
mathieui committed
830 831 832 833 834
        """
        Get the last status that was previously set
        """
        return self.status

835
    def set_status(self, pres: str, msg: str) -> None:
mathieui's avatar
mathieui committed
836 837 838 839 840 841
        """
        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)
842
        if config.get('save_status'):
843 844 845 846
            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
847 848 849
                self.information(
                    'Unable to save the status in '
                    'the config file', 'Error')
mathieui's avatar
mathieui committed
850

mathieui's avatar
mathieui committed
851
    def get_bookmark_nickname(self, room_name: str) -> str:
mathieui's avatar
mathieui committed
852 853 854 855
        """
        Returns the nickname associated with a bookmark
        or the default nickname
        """
mathieui's avatar
mathieui committed
856
        bm = self.bookmarks[room_name]
mathieui's avatar
mathieui committed
857 858 859 860
        if bm:
            return bm.nick
        return self.own_nick

861
    def disconnect(self, msg: str = '', reconnect: bool = False) -> None:
mathieui's avatar
mathieui committed
862 863 864 865
        """
        Disconnect from remote server and correctly set the states of all
        parts of the client (for example, set the MucTabs as not joined, etc)
        """
866
        self.legitimate_disconnect = True
mathieui's avatar
mathieui committed
867
        if reconnect:
868 869
            self.xmpp.reconnect(wait=0.0, reason=msg)
        else:
870
            for tab in self.get_tabs(tabs.MucTab):
871
                tab.leave_room(msg)
872
            self.xmpp.disconnect(reason=msg)
mathieui's avatar
mathieui committed
873

mathieui's avatar
mathieui committed
874
    def send_message(self, msg: str) -> bool:
mathieui's avatar
mathieui committed
875
        """
876 877
        Function to use in plugins to send a message in the current
        conversation.
mathieui's avatar
mathieui committed
878 879
        Returns False if the current tab is not a conversation tab
        """
880
        if not isinstance(self.tabs.current_tab, tabs.ChatTab):
mathieui's avatar
mathieui committed
881
            return False
882
        self.tabs.current_tab.command_say(msg)
mathieui's avatar
mathieui committed
883 884
        return True

885
    def invite(self, jid: JID, room: JID, reason: Optional[str] = None) -> None:
886 887 888 889 890
        """
        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
891

892 893 894 895 896
        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
897 898 899 900
                    jid, room, reason=reason)
            else:  # fallback
                self.xmpp.plugin['xep_0045'].invite(
                    room, jid, reason=reason or '')
901

mathieui's avatar
mathieui committed
902 903
        self.xmpp.plugin['xep_0030'].get_info(
            jid=jid, timeout=5, callback=callback)
904

905
    def _impromptu_room_form(self, room):
906
        fields = [
907 908 909 910 911 912 913
            ('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'),
914 915 916 917
            # MAM
            ('boolean', 'muc#roomconfig_enablearchiving', True),  # Prosody
            ('boolean', 'mam', True),  # Ejabberd community
            ('boolean', 'muc#roomconfig_mam', True),  # Ejabberd saas
918 919 920 921 922
        ]

        form = self.xmpp['xep_0004'].make_form()
        form['type'] = 'submit'
        for field in fields:
923 924 925 926 927
            form.add_field(
                ftype=field[0],
                var=field[1],
                value=field[2],
            )
928 929 930 931 932 933 934 935 936 937

        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
938 939 940 941 942 943 944
        """
        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.
        """

945
        results = await self.xmpp['xep_0030'].get_info_from_domain()
946

947 948 949 950 951
        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
952

953 954 955 956 957 958 959 960 961 962 963 964
        # 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
965

966
        nick = self.own_nick
967
        localpart = uuid.uuid4().hex
968 969 970 971 972 973 974 975 976
        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
977

978
        self.open_new_room(room, nick).join()
979
        iq = self._impromptu_room_form(room)
980 981 982
        try:
            await iq.send()
        except (IqError, IqTimeout):
983
            self.information('Failed to configure impromptu room.', 'Info')
984 985
            # TODO: destroy? leave room.
            return None
Maxime Buquet's avatar
Maxime Buquet committed
986

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

989 990
        for jid in jids:
            self.invite(jid, room)
Maxime Buquet's avatar
Maxime Buquet committed
991

992
    def get_error_message(self, stanza, deprecated: bool = False):
mathieui's avatar
mathieui committed
993 994
        """
        Takes a stanza of the form <message type='error'><error/></message>
995
        and return a well formed string containing error information
mathieui's avatar
mathieui committed
996
        """
997
        sender = stanza['from']
mathieui's avatar
mathieui committed
998 999 1000 1001 1002 1003 1004 1005 1006
        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:
1007
                    body = condition or 'Unknown error'
mathieui's avatar
mathieui committed
1008 1009 1010 1011
            else:
                if code in ERROR_AND_STATUS_CODES:
                    body = ERROR_AND_STATUS_CODES[code]
                else:
1012
                    body = condition or 'Unknown error'
mathieui's avatar
mathieui committed
1013
        if code:
1014
            message = '%(from)s: %(code)s - %(msg)s: %(body)s' % {
mathieui's avatar
mathieui committed
1015 1016 1017 1018 1019
                'from': sender,
                'msg': msg,
                'body': body,
                'code': code
            }
mathieui's avatar
mathieui committed
1020
        else:
1021
            message = '%(from)s: %(msg)s: %(body)s' % {
mathieui's avatar
mathieui committed
1022 1023 1024 1025
                'from': sender,
                'msg': msg,
                'body': body
            }
mathieui's avatar
mathieui committed
1026 1027 1028 1029
        return message

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

mathieui's avatar
mathieui committed
1030
### Tab getters ###
mathieui's avatar
mathieui committed
1031

1032
    def get_tabs(self, cls: Type[T] = None) -> List[T]:
mathieui's avatar
mathieui committed
1033
        "Get all the tabs of a type"
Link Mauve's avatar
Link Mauve committed
1034
        if cls is None:
1035 1036
            return self.tabs.get_tabs()
        return self.tabs.by_class(cls)
mathieui's avatar
mathieui committed
1037

mathieui's avatar
mathieui committed
1038 1039
    def get_conversation_by_jid(self,
                                jid: JID,