core.py 70 KB
Newer Older
mathieui's avatar
mathieui committed
1 2 3 4 5 6 7
"""
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.
"""
8 9
from __future__ import annotations

mathieui's avatar
mathieui committed
10
import logging
11
import asyncio
mathieui's avatar
mathieui committed
12 13 14 15
import curses
import os
import pipes
import sys
mathieui's avatar
mathieui committed
16
import shutil
mathieui's avatar
mathieui committed
17
import time
Maxime Buquet's avatar
Maxime Buquet committed
18
import uuid
mathieui's avatar
mathieui committed
19
from collections import defaultdict
20
from typing import (
mathieui's avatar
mathieui committed
21
    Any,
22 23 24 25 26 27 28 29
    Callable,
    Dict,
    List,
    Optional,
    Set,
    Tuple,
    Type,
    TypeVar,
30
    TYPE_CHECKING,
31
)
32
from xml.etree import ElementTree as ET
mathieui's avatar
mathieui committed
33

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

39 40 41 42 43 44
from poezio import connection
from poezio import decorators
from poezio import events
from poezio import theming
from poezio import timed_events
from poezio import windows
mathieui's avatar
mathieui committed
45

mathieui's avatar
mathieui committed
46 47 48 49
from poezio.bookmarks import (
    BookmarkList,
    Bookmark,
)
mathieui's avatar
mathieui committed
50 51 52 53 54
from poezio.tabs import (
    Tab, XMLTab, ChatTab, ConversationTab, PrivateTab, MucTab, OneToOneTab,
    GapTab, RosterInfoTab, StaticConversationTab, DataFormsTab,
    DynamicConversationTab, STATE_PRIORITY
)
mathieui's avatar
mathieui committed
55
from poezio.common import get_error_message
56
from poezio.config import config
57 58 59 60 61 62 63
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
64
from poezio.user import User
65
from poezio.text_buffer import TextBuffer
Link Mauve's avatar
Link Mauve committed
66
from poezio.timed_events import DelayedEvent
67
from poezio import keyboard, xdg
mathieui's avatar
mathieui committed
68

mathieui's avatar
mathieui committed
69
from poezio.core.completions import CompletionCore
70
from poezio.core.tabs import Tabs
mathieui's avatar
mathieui committed
71
from poezio.core.commands import CommandCore
72
from poezio.core.command_defs import get_commands
mathieui's avatar
mathieui committed
73
from poezio.core.handlers import HandlerCore
74 75 76 77 78 79
from poezio.core.structs import (
    Command,
    Status,
    POSSIBLE_SHOW,
)

80 81
from poezio.ui.types import (
    PersistentInfoMessage,
82
    UIMessage,
83
)
mathieui's avatar
mathieui committed
84

85
if TYPE_CHECKING:
86
    from _curses import _CursesWindow  # pylint: disable=no-name-in-module
87

mathieui's avatar
mathieui committed
88 89
log = logging.getLogger(__name__)

mathieui's avatar
mathieui committed
90
T = TypeVar('T', bound=Tab)
mathieui's avatar
mathieui committed
91

92

93
class Core:
mathieui's avatar
mathieui committed
94 95 96 97
    """
    “Main” class of poezion
    """

98
    custom_version: str
99
    firstrun: bool
mathieui's avatar
mathieui committed
100 101 102 103 104 105 106 107 108 109 110
    completion: CompletionCore
    command: CommandCore
    handler: HandlerCore
    bookmarks: BookmarkList
    status: Status
    commands: Dict[str, Command]
    room_number_jump: List[str]
    initial_joins: List[JID]
    pending_invites: Dict[str, str]
    configuration_change_handlers: Dict[str, List[Callable[..., None]]]
    own_nick: str
111 112 113 114 115 116 117 118 119 120 121 122 123 124
    connection_time: float
    xmpp: connection.Connection
    avatar_cache: FileSystemPerJidCache
    plugins_autoloaded: bool
    previous_tab_nb: int
    tabs: Tabs
    size: SizeManager
    plugin_manager: PluginManager
    events: events.EventHandler
    legitimate_disconnect: bool
    information_buffer: TextBuffer
    information_win_size: int
    stdscr: Optional[_CursesWindow]
    xml_buffer: TextBuffer
mathieui's avatar
mathieui committed
125
    xml_tab: Optional[XMLTab]
126 127 128 129 130
    last_stream_error: Optional[Tuple[float, XMPPError]]
    remote_fifo: Optional[Fifo]
    key_func: KeyDict
    tab_win: windows.GlobalInfoBar
    left_tab_win: Optional[windows.VerticalGlobalInfoBar]
131

132
    def __init__(self, custom_version: str, firstrun: bool):
133
        self.completion = CompletionCore(self)
134
        self.command = CommandCore(self)
135
        self.handler = HandlerCore(self)
136
        self.firstrun = firstrun
mathieui's avatar
mathieui committed
137 138 139 140
        # 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()
141
        self.last_stream_error = None
142
        self.stdscr = None
143
        status = config.getstr('status')
mathieui's avatar
mathieui committed
144
        status = POSSIBLE_SHOW.get(status) or ''
145
        self.status = Status(show=status, message=config.getstr('status_message'))
146 147
        self.custom_version = custom_version
        self.xmpp = connection.Connection(custom_version)
mathieui's avatar
mathieui committed
148
        self.xmpp.core = self
149
        self.keyboard = keyboard.Keyboard()
mathieui's avatar
mathieui committed
150 151
        roster.set_node(self.xmpp.client_roster)
        decorators.refresh_wrapper.core = self
mathieui's avatar
mathieui committed
152
        self.bookmarks = BookmarkList()
mathieui's avatar
mathieui committed
153
        self.remote_fifo = None
mathieui's avatar
mathieui committed
154 155
        self.avatar_cache = FileSystemPerJidCache(
            str(xdg.CACHE_HOME), 'avatars', binary=True)
156
        # a unique buffer used to store global information
mathieui's avatar
mathieui committed
157 158 159
        # that are displayed in almost all tabs, in an
        # information window.
        self.information_buffer = TextBuffer()
160
        self.information_win_size = config.getint('info_win_height', section='var')
mathieui's avatar
mathieui committed
161

162
        # Whether the XML tab is opened
163
        self.xml_tab = None
mathieui's avatar
mathieui committed
164 165
        self.xml_buffer = TextBuffer()

166 167 168
        self.plugins_autoloaded = False
        self.plugin_manager = PluginManager(self)
        self.events = events.EventHandler()
mathieui's avatar
mathieui committed
169
        self.events.add_event_handler('tab_change', self.on_tab_change)
170

mathieui's avatar
mathieui committed
171
        self.tabs = Tabs(self.events, GapTab())
mathieui's avatar
mathieui committed
172 173
        self.previous_tab_nb = 0

mathieui's avatar
mathieui committed
174 175 176 177
        self.own_nick: str = (
            config.getstr('default_nick') or self.xmpp.boundjid.user or
            os.environ.get('USER') or 'poezio_user'
        )
mathieui's avatar
mathieui committed
178

179
        self.size = SizeManager(self)
mathieui's avatar
mathieui committed
180

181 182 183 184 185 186 187
        # 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
188 189 190 191 192 193 194 195 196 197 198
        # 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
199
        if not config.get('send_initial_presence'):
mathieui's avatar
mathieui committed
200 201 202
            del self.commands['status']
            del self.commands['show']

203 204 205 206 207
        # 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
208 209 210 211 212 213 214 215 216 217 218 219 220
        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
221
            "M-[1;3D": self.rotate_rooms_left,
mathieui's avatar
mathieui committed
222 223 224 225
            '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
226
            "M-[1;3C": self.rotate_rooms_right,
mathieui's avatar
mathieui committed
227 228 229 230 231 232 233 234 235 236 237 238 239
            '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
240
            ######## actions mappings ##########
Maxime Buquet's avatar
Maxime Buquet committed
241
            '_noop': lambda *args, **kwargs: None,
242 243
            '_bookmark': self.command.bookmark,
            '_bookmark_local': self.command.bookmark_local,
mathieui's avatar
mathieui committed
244 245
            '_close_tab': self.close_tab,
            '_disconnect': self.disconnect,
246
            '_quit': self.command.quit,
mathieui's avatar
mathieui committed
247
            '_redraw_screen': self.full_screen_redraw,
248 249
            '_reload_theme': self.command.theme,
            '_remove_bookmark': self.command.remove_bookmark,
mathieui's avatar
mathieui committed
250 251 252 253 254 255 256
            '_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,
257 258
            '_server_cycle': self.command.server_cycle,
            '_show_bookmarks': self.command.bookmarks,
mathieui's avatar
mathieui committed
259
            '_show_important_room': self.go_to_important_room,
260 261 262
            '_show_invitations': self.command.invitations,
            '_show_plugins': self.command.plugins,
            '_show_xmltab': self.command.xml_tab,
mathieui's avatar
mathieui committed
263
            '_toggle_pane': self.toggle_left_pane,
264
            "_go_to_room_name": self.go_to_room_name,
mathieui's avatar
mathieui committed
265
            ###### status actions ######
266 267 268 269 270
            '_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
271
            ##### Custom actions ########
mathieui's avatar
mathieui committed
272 273
        }
        self.key_func.update(key_func)
mathieui's avatar
mathieui committed
274
        self.key_func.try_execute = self.try_execute
mathieui's avatar
mathieui committed
275 276

        # Add handlers
mathieui's avatar
mathieui committed
277 278 279 280 281 282 283 284 285 286 287 288 289
        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),
290
            ('reconnect_delay', self.handler.on_reconnect_delay),
mathieui's avatar
mathieui committed
291 292 293 294 295 296 297 298 299 300 301 302 303
            ('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),
304
            ('message_encryption', self.handler.on_encrypted_message),
mathieui's avatar
mathieui committed
305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320
            ('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),
321 322
            ('session_end', self.handler.on_session_end),
            ('sm_failed', self.handler.on_session_end),
323
            ('session_resumed', self.handler.on_session_resumed),
mathieui's avatar
mathieui committed
324 325 326 327 328 329
            ('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)
330

331
        if config.getbool('enable_avatars'):
332 333 334 335
            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)
336
        if config.getbool('enable_user_nick'):
337
            self.xmpp.add_event_handler("user_nick_publish",
338
                                        self.handler.on_nick_received)
mathieui's avatar
mathieui committed
339 340 341 342
        all_stanzas = Callback('custom matcher', connection.MatchAll(None),
                               self.handler.incoming_stanza)
        self.xmpp.register_handler(all_stanzas)

mathieui's avatar
mathieui committed
343 344 345 346 347 348 349 350 351 352
        self.initial_joins = []

        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
353 354
        # 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
355 356 357 358
        # 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
359
        self.configuration_change_handlers = defaultdict(list)
mathieui's avatar
mathieui committed
360
        config_handlers: List[Tuple[str, Callable[..., Any]]] = [
mathieui's avatar
mathieui committed
361 362 363 364 365 366 367 368 369 370 371 372 373 374 375
            ('', 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),
            ('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),
376
            ('show_timestamps', self.on_show_timestamps_changed),
mathieui's avatar
mathieui committed
377 378 379 380 381 382 383 384 385
            ('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)

386 387 388 389 390 391 392
    def _create_windows(self):
        """Create the windows (delayed after curses init)"""
        self.information_win = windows.TextWin(300)
        self.information_buffer.add_window(self.information_win)
        self.left_tab_win = None
        self.tab_win = windows.GlobalInfoBar(self)

mathieui's avatar
mathieui committed
393
    def on_tab_change(self, old_tab: Tab, new_tab: Tab):
394 395 396 397 398
        """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
399 400 401 402 403 404
    def on_any_config_change(self, option, value):
        """
        Update the roster, in case a roster option changed.
        """
        roster.modified()

mathieui's avatar
mathieui committed
405
    def add_configuration_handler(self, option: str, callback: Callable):
mathieui's avatar
mathieui committed
406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427
        """
        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)

428 429 430 431 432 433
    def on_hide_user_list_change(self, option, value):
        """
        Called when the hide_user_list option changes
        """
        self.call_for_resize()

434 435 436 437 438 439
    def on_show_timestamps_changed(self, option, value):
        """
        Called when the show_timestamps option changes
        """
        self.call_for_resize(ui_config_changed=True)

mathieui's avatar
mathieui committed
440 441 442 443
    def on_bookmarks_method_config_change(self, option, value):
        """
        Called when the use_bookmarks_method option changes
        """
444
        if value not in ('pep', 'privatexml'):
mathieui's avatar
mathieui committed
445 446
            return
        self.bookmarks.preferred = value
447 448 449
        asyncio.ensure_future(
            self.bookmarks.save(self.xmpp, core=self)
        )
mathieui's avatar
mathieui committed
450

mathieui's avatar
mathieui committed
451 452 453 454 455
    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
456
        self.tabs.update_gaps(value.lower() != "false")
mathieui's avatar
mathieui committed
457

458 459 460 461
    def on_request_receipts_config_change(self, option, value):
        """
        Called when the request_message_receipts option changes
        """
mathieui's avatar
mathieui committed
462 463
        self.xmpp.plugin['xep_0184'].auto_request = config.get(
            option, default=True)
464 465 466 467 468

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

472 473 474 475 476 477
    def on_vertical_tab_list_config_change(self, option, value):
        """
        Called when the enable_vertical_tab_list option is changed
        """
        self.call_for_resize()

478 479 480 481 482 483 484 485 486
    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()

487 488 489 490 491 492
    def on_password_change(self, option, value):
        """
        Set the new password in the slixmpp.ClientXMPP object
        """
        self.xmpp.password = value

493 494 495 496 497 498 499 500 501 502
    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
503
    def reload_config(self):
mathieui's avatar
mathieui committed
504 505 506 507 508 509
        # 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
510
        theming.reload_theme()
mathieui's avatar
mathieui committed
511 512 513 514 515
        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()
516
        config.read_file()
mathieui's avatar
mathieui committed
517 518 519 520 521 522
        # 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)
523
                new_value = config.get(option, default="", section=section)
mathieui's avatar
mathieui committed
524 525 526
                if new_value != old_value:
                    self.trigger_configuration_change(option, new_value)
        log.debug("Config reloaded.")
527 528 529
        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
530 531 532
        # in case some roster options have changed
        roster.modified()

Eijebong's avatar
Eijebong committed
533 534 535 536 537 538 539 540
    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
541 542
    def exit_from_signal(self, *args, **kwargs):
        """
543
        Quit when receiving SIGHUP or SIGTERM or SIGPIPE
mathieui's avatar
mathieui committed
544 545 546 547

        do not save the config because it is not a normal exit
        (and only roster UI things are not yet saved)
        """
548 549
        sig = args[0]
        signals = {
mathieui's avatar
mathieui committed
550 551 552 553
            1: 'SIGHUP',
            13: 'SIGPIPE',
            15: 'SIGTERM',
        }
554 555

        log.error("%s received. Exiting…", signals[sig])
mathieui's avatar
mathieui committed
556
        self.plugin_manager.disable_plugins()
557 558
        self.disconnect('%s received' % signals.get(sig))
        self.xmpp.add_event_handler("disconnected", self.exit, disposable=True)
mathieui's avatar
mathieui committed
559 560 561 562 563

    def autoload_plugins(self):
        """
        Load the plugins on startup.
        """
564
        plugins = config.getstr('plugins_autoload')
mathieui's avatar
mathieui committed
565 566
        if ':' in plugins:
            for plugin in plugins.split(':'):
567
                self.plugin_manager.load(plugin, unload_first=False)
mathieui's avatar
mathieui committed
568 569
        else:
            for plugin in plugins.split():
570
                self.plugin_manager.load(plugin, unload_first=False)
mathieui's avatar
mathieui committed
571 572 573 574 575 576 577
        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
578
        self._init_curses(self.stdscr)
579 580
        windows.base_wins.TAB_WIN = self.stdscr
        self._create_windows()
mathieui's avatar
mathieui committed
581
        self.call_for_resize()
mathieui's avatar
mathieui committed
582
        default_tab = RosterInfoTab(self)
mathieui's avatar
mathieui committed
583 584
        default_tab.on_gain_focus()
        self.tabs.append(default_tab)
585
        self.information('Welcome to poezio!', 'Info')
586 587 588 589 590 591
        if curses.COLORS < 256:
            self.information(
                'Your terminal does not appear to support 256 colors, the UI'
                ' colors will probably be ugly',
                'Error',
            )
592
        if self.firstrun:
593
            self.information(
mathieui's avatar
mathieui committed
594
                'It seems that it is the first time you start poezio.\n'
595
                'The online help is here https://doc.poez.io/\n\n'
596
                'No room is joined by default, but you can join poezio’s'
597 598 599 600 601
                ' 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
602
        self.refresh_window()
louiz’'s avatar
louiz’ committed
603
        self.xmpp.plugin['xep_0012'].begin_idle(jid=self.xmpp.boundjid)
mathieui's avatar
mathieui committed
604

605
    def exit(self, event=None):
mathieui's avatar
mathieui committed
606
        log.debug("exit(%s)", event)
607 608
        asyncio.get_event_loop().stop()

mathieui's avatar
mathieui committed
609 610 611 612 613 614 615 616 617 618 619
    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)

620
    def sigwinch_handler(self, *args):
621 622 623 624
        """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
625
        that a resize occurred and we can act on it. BUT poezio doesn’t call
626 627 628 629 630 631 632 633 634 635 636 637 638 639 640
        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
641
    def on_input_readable(self):
mathieui's avatar
mathieui committed
642 643 644
        """
        main loop waiting for the user to press a key
        """
mathieui's avatar
mathieui committed
645

louiz’'s avatar
louiz’ committed
646 647 648
        log.debug("Input is readable.")
        big_char_list = [replace_key_with_bound(key)\
                         for key in self.read_keyboard()]
mathieui's avatar
mathieui committed
649
        log.debug("Got from keyboard: %s", (big_char_list, ))
louiz’'s avatar
louiz’ committed
650 651 652 653 654 655 656 657 658 659 660

        # whether to refresh after ALL keys have been handled
        for char_list in separate_chars_from_bindings(big_char_list):
            # Special case for M-x where x is a number
            if len(char_list) == 1:
                char = char_list[0]
                if char.startswith('M-') and len(char) == 3:
                    try:
                        nb = int(char[2])
                    except ValueError:
                        pass
mathieui's avatar
mathieui committed
661
                    else:
662
                        if self.tabs.current_tab.nb == nb and config.getbool(
mathieui's avatar
mathieui committed
663
                                'go_to_previous_tab_on_alt_number'):
louiz’'s avatar
louiz’ committed
664 665
                            self.go_to_previous_tab()
                        else:
666
                            self.command.win('%d' % nb)
louiz’'s avatar
louiz’ committed
667 668 669 670
                # search for keyboard shortcut
                func = self.key_func.get(char, None)
                if func:
                    func()
mathieui's avatar
mathieui committed
671
                else:
louiz’'s avatar
louiz’ committed
672 673 674
                    self.do_command(replace_line_breaks(char), False)
            else:
                self.do_command(''.join(char_list), True)
675
        self.doupdate()
mathieui's avatar
mathieui committed
676 677 678 679 680

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

    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):
695
                self.open_conversation_window(JID(roster_row.bare_jid))
mathieui's avatar
mathieui committed
696 697 698
            else:
                self.focus_tab_named(roster_row.bare_jid)
        if isinstance(roster_row, Resource):
mathieui's avatar
mathieui committed
699 700
            if not self.get_conversation_by_jid(
                    roster_row.jid, False, fallback_barejid=False):
701
                self.open_conversation_window(JID(roster_row.jid))
mathieui's avatar
mathieui committed
702 703 704 705
            else:
                self.focus_tab_named(roster_row.jid)
        self.refresh_window()

mathieui's avatar
mathieui committed
706
    def get_conversation_messages(self) -> Optional[List[Tuple]]:
mathieui's avatar
mathieui committed
707 708 709 710 711 712 713
        """
        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')
        """
mathieui's avatar
mathieui committed
714
        if not isinstance(self.tabs.current_tab, ChatTab):
mathieui's avatar
mathieui committed
715
            return None
716
        return self.tabs.current_tab.get_conversation_messages()
mathieui's avatar
mathieui committed
717

mathieui's avatar
mathieui committed
718
    def insert_input_text(self, text: str):
mathieui's avatar
mathieui committed
719 720 721 722 723 724 725
        """
        Insert the given text into the current input
        """
        self.do_command(text, True)

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

mathieui's avatar
mathieui committed
726
    def execute(self, line: str):
mathieui's avatar
mathieui committed
727 728 729 730 731 732
        """
        Execute the /command or just send the line on the current room
        """
        if line == "":
            return
        if line.startswith('/'):
733
            command = line.strip().split()[0][1:]
mathieui's avatar
mathieui committed
734
            arg = line[2 + len(command):]  # jump the '/' and the ' '
mathieui's avatar
mathieui committed
735 736
            # example. on "/link 0 open", command = "link" and arg = "0 open"
            if command in self.commands:
737
                func = self.commands[command].func
mathieui's avatar
mathieui committed
738 739 740
                func(arg)
                return
            else:
mathieui's avatar
mathieui committed
741
                self.information("Unknown command (%s)" % (command), 'Error')
mathieui's avatar
mathieui committed
742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770

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

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

mathieui's avatar
mathieui committed
812
    def do_command(self, key: str, raw: bool):
813 814
        """
        Execute the action associated with a key
815 816 817

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

mathieui's avatar
mathieui committed
831
    def try_execute(self, line: str):
mathieui's avatar
mathieui committed
832 833 834 835 836
        """
        Try to execute a command in the current tab
        """
        line = '/' + line
        try:
837
            self.tabs.current_tab.execute_command(line)
mathieui's avatar
mathieui committed
838 839 840 841 842
        except:
            log.error('Execute failed (%s)', line, exc_info=True)

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

Link Mauve's avatar
Link Mauve committed
843
    def remove_timed_event(self, event: DelayedEvent) -> None:
mathieui's avatar
mathieui committed
844
        """Remove an existing timed event"""
mathieui's avatar
mathieui committed
845 846
        if event.handler is not None:
            event.handler.cancel()
mathieui's avatar
mathieui committed
847

Link Mauve's avatar
Link Mauve committed
848
    def add_timed_event(self, event: DelayedEvent) -> None:
mathieui's avatar
mathieui committed
849
        """Add a new timed event"""
mathieui's avatar
mathieui committed
850
        event.handler = asyncio.get_event_loop().call_later(
mathieui's avatar
mathieui committed
851 852
            event.delay, event.callback, *event.args
        )
mathieui's avatar
mathieui committed
853 854 855

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

856
    def get_status(self) -> Status:
mathieui's avatar
mathieui committed
857 858 859 860 861
        """
        Get the last status that was previously set
        """
        return self.status

862
    def set_status(self, pres: str, msg: str) -> None:
mathieui's avatar
mathieui committed
863 864 865 866 867 868
        """
        Set our current status so we can remember
        it and use it back when needed (for example to display it
        or to use it when joining a new muc)
        """
        self.status = Status(show=pres, message=msg)
869
        if config.getbool('save_status'):
870 871 872 873
            ok = config.silent_set('status', pres if pres else '')
            msg = msg.replace('\n', '|') if msg else ''
            ok = ok and config.silent_set('status_message', msg)
            if not ok:
mathieui's avatar
mathieui committed
874 875 876
                self.information(
                    'Unable to save the status in '
                    'the config file', 'Error')
mathieui's avatar
mathieui committed
877

mathieui's avatar
mathieui committed
878
    def get_bookmark_nickname(self, room_name: str) -> str:
mathieui's avatar
mathieui committed
879 880 881 882
        """
        Returns the nickname associated with a bookmark
        or the default nickname
        """
mathieui's avatar
mathieui committed
883
        bm = self.bookmarks[room_name]
mathieui's avatar
mathieui committed
884
        if bm and bm.nick:
mathieui's avatar
mathieui committed
885 886 887
            return bm.nick
        return self.own_nick

888
    def disconnect(self, msg: str = '', reconnect: bool = False) -> None:
mathieui's avatar
mathieui committed
889 890 891 892
        """
        Disconnect from remote server and correctly set the states of all
        parts of the client (for example, set the MucTabs as not joined, etc)
        """
893
        self.legitimate_disconnect = True
mathieui's avatar
mathieui committed
894
        if reconnect:
895 896
            self.xmpp.reconnect(wait=0.0, reason=msg)
        else:
mathieui's avatar
mathieui committed
897
            for tab in self.get_tabs(MucTab):
898
                tab.leave_room(msg)
899
            self.xmpp.disconnect(reason=msg)
mathieui's avatar
mathieui committed
900

mathieui's avatar
mathieui committed
901
    def send_message(self, msg: str) -> bool:
mathieui's avatar
mathieui committed
902
        """
903 904
        Function to use in plugins to send a message in the current
        conversation.
mathieui's avatar
mathieui committed
905 906
        Returns False if the current tab is not a conversation tab
        """
mathieui's avatar
mathieui committed
907
        if not isinstance(self.tabs.current_tab, ChatTab):
mathieui's avatar
mathieui committed
908
            return False
909
        self.tabs.current_tab.command_say(msg)
mathieui's avatar
mathieui committed
910 911
        return True

912
    async def invite(self, jid: JID, room: JID, reason: Optional[str] = None, force_mediated: bool = False) -> bool:
913 914 915 916 917
        """
        Checks if the sender supports XEP-0249, then send an invitation,
        or a mediated one if it does not.
        TODO: allow passwords
        """
918
        features = set()
mathieui's avatar
mathieui committed
919

920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941
        # force mediated: act as if the other entity does not
        # support direct invites
        if not force_mediated:
            try:
                iq = await self.xmpp.plugin['xep_0030'].get_info(
                    jid=jid,
                    timeout=5,
                )
                features = iq['disco_info'].get_features()
            except (IqError, IqTimeout):
                pass
        supports_direct = 'jabber:x:conference' in features
        if supports_direct:
            invite = self.xmpp.plugin['xep_0249'].send_invitation
        else:  # fallback
            invite = self.xmpp.plugin['xep_0045'].invite
        invite(
            jid=jid,
            room=room,
            reason=reason
        )
        return True
942

943
    def _impromptu_room_form(self, room):
944
        fields = [
945 946 947 948 949 950 951
            ('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'),
952 953 954 955
            # MAM
            ('boolean', 'muc#roomconfig_enablearchiving', True),  # Prosody
            ('boolean', 'mam', True),  # Ejabberd community
            ('boolean', 'muc#roomconfig_mam', True),  # Ejabberd saas
956 957 958 959 960
        ]

        form = self.xmpp['xep_0004'].make_form()
        form['type'] = 'submit'
        for field in fields:
961 962 963 964 965
            form.add_field(
                ftype=field[0],
                var=field[1],
                value=field[2],
            )
966 967 968 969 970 971 972 973 974 975

        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
976 977 978 979 980 981 982
        """
        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.
        """

983
        results = await self.xmpp['xep_0030'].get_info_from_domain()
984

985 986 987 988 989
        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
990

991 992 993 994 995 996 997 998 999 1000 1001 1002
        # 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
1003

1004
        nick = self.own_nick
1005
        localpart = uuid.uuid4().hex
1006 1007 1008 1009 1010 1011 1012 1013 1014
        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
1015

1016
        self.open_new_room(room, nick).join()
1017
        iq = self._impromptu_room_form(room)
1018 1019 1020
        try:
            await iq.send()
        except (IqError, IqTimeout):
1021
            self.information('Failed to configure impromptu room.', 'Info')
1022 1023
            # TODO: destroy? leave room.
            return None
Maxime Buquet's avatar
Maxime Buquet committed
1024

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

1027
        for jid in jids:
1028
            await self.invite(jid, room, force_mediated=True)
Maxime Buquet's avatar
Maxime Buquet committed
1029

mathieui's avatar
mathieui committed
1030 1031
####################### Tab logic-related things ##############################

mathieui's avatar
mathieui committed
1032
### Tab getters ###
mathieui's avatar
mathieui committed
1033

mathieui's avatar
mathieui committed
1034
    def get_tabs(self, cls: Type[T]) -> List[T]:
mathieui's avatar
mathieui committed
1035
        "Get all the tabs of a type"
1036
        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,
1040
                                create: bool = True,
mathieui's avatar
mathieui committed
1041
                                fallback_barejid: bool = True) -> Optional[ChatTab]:
mathieui's avatar
mathieui committed
1042 1043 1044 1045 1046 1047 1048 1049
        """
        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
1050
        jid = JID(jid)
1051 1052
        # We first check if we have a static conversation opened
        # with this precise resource
mathieui's avatar
mathieui committed
1053
        conversation: Optional[ConversationTab]
1054