core.py 82.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
from typing import Callable, Dict, List, Optional, Set, Tuple, Type
from xml.etree import cElementTree as ET
from functools import partial
mathieui's avatar
mathieui committed
21

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

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

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

mathieui's avatar
mathieui committed
53
from poezio.core.completions import CompletionCore
54
from poezio.core.tabs import Tabs
mathieui's avatar
mathieui committed
55
56
57
from poezio.core.commands import CommandCore
from poezio.core.handlers import HandlerCore
from poezio.core.structs import POSSIBLE_SHOW, DEPRECATED_ERRORS, \
mathieui's avatar
mathieui committed
58
59
        ERROR_AND_STATUS_CODES, Command, Status

mathieui's avatar
mathieui committed
60
61
log = logging.getLogger(__name__)

mathieui's avatar
mathieui committed
62

63
class Core:
mathieui's avatar
mathieui committed
64
65
66
67
68
    """
    “Main” class of poezion
    """

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

102
        self.tab_win = windows.GlobalInfoBar(self)
103
        # Whether the XML tab is opened
104
        self.xml_tab = None
mathieui's avatar
mathieui committed
105
106
        self.xml_buffer = TextBuffer()

107
108
109
        self.plugins_autoloaded = False
        self.plugin_manager = PluginManager(self)
        self.events = events.EventHandler()
mathieui's avatar
mathieui committed
110
        self.events.add_event_handler('tab_change', self.on_tab_change)
111
112

        self.tabs = Tabs(self.events)
mathieui's avatar
mathieui committed
113
114
        self.previous_tab_nb = 0

115
        own_nick = config.get('default_nick')
116
117
118
119
        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
120

121
        self.size = SizeManager(self)
mathieui's avatar
mathieui committed
122

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

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

        # Add handlers
mathieui's avatar
mathieui committed
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
        xmpp_event_handlers = [
            ('attention', self.handler.on_attention),
            ('carbon_received', self.handler.on_carbon_received),
            ('carbon_sent', self.handler.on_carbon_sent),
            ('changed_status', self.handler.on_presence),
            ('chatstate_active', self.handler.on_chatstate_active),
            ('chatstate_composing', self.handler.on_chatstate_composing),
            ('chatstate_gone', self.handler.on_chatstate_gone),
            ('chatstate_inactive', self.handler.on_chatstate_inactive),
            ('chatstate_paused', self.handler.on_chatstate_paused),
            ('connected', self.handler.on_connected),
            ('connection_failed', self.handler.on_failed_connection),
            ('disconnected', self.handler.on_disconnected),
            ('failed_all_auth', self.handler.on_failed_all_auth),
            ('got_offline', self.handler.on_got_offline),
            ('got_online', self.handler.on_got_online),
            ('groupchat_config_status', self.handler.on_status_codes),
            ('groupchat_decline', self.handler.on_groupchat_decline),
            ('groupchat_direct_invite',
             self.handler.on_groupchat_direct_invitation),
            ('groupchat_invite', self.handler.on_groupchat_invitation),
            ('groupchat_message', self.handler.on_groupchat_message),
            ('groupchat_presence', self.handler.on_groupchat_presence),
            ('groupchat_subject', self.handler.on_groupchat_subject),
            ('http_confirm', self.handler.http_confirm),
            ('message', self.handler.on_message),
            ('message_error', self.handler.on_error_message),
            ('message_xform', self.handler.on_data_form),
            ('no_auth', self.handler.on_no_auth),
            ('presence_error', self.handler.on_presence_error),
            ('receipt_received', self.handler.on_receipt),
            ('roster_subscription_authorized',
             self.handler.on_subscription_authorized),
            ('roster_subscription_remove',
             self.handler.on_subscription_remove),
            ('roster_subscription_removed',
             self.handler.on_subscription_removed),
            ('roster_subscription_request',
             self.handler.on_subscription_request),
            ('roster_update', self.handler.on_roster_update),
            ('session_start', self.handler.on_session_start),
            ('session_start', self.handler.on_session_start_features),
260
261
            ('session_end', self.handler.on_session_end),
            ('sm_failed', self.handler.on_session_end),
262
            ('session_resumed', self.handler.on_session_resumed),
mathieui's avatar
mathieui committed
263
264
265
266
267
268
            ('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)
269

270
271
272
273
274
        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)
275
        if config.get('enable_user_tune'):
276
            self.xmpp.add_event_handler("user_tune_publish",
277
                                        self.handler.on_tune_event)
278
        if config.get('enable_user_nick'):
279
            self.xmpp.add_event_handler("user_nick_publish",
280
                                        self.handler.on_nick_received)
281
        if config.get('enable_user_mood'):
282
            self.xmpp.add_event_handler("user_mood_publish",
283
                                        self.handler.on_mood_event)
284
        if config.get('enable_user_activity'):
285
            self.xmpp.add_event_handler("user_activity_publish",
286
                                        self.handler.on_activity_event)
287
        if config.get('enable_user_gaming'):
288
            self.xmpp.add_event_handler("user_gaming_publish",
289
                                        self.handler.on_gaming_event)
mathieui's avatar
mathieui committed
290

mathieui's avatar
mathieui committed
291
292
293
294
        all_stanzas = Callback('custom matcher', connection.MatchAll(None),
                               self.handler.incoming_stanza)
        self.xmpp.register_handler(all_stanzas)

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

mathieui's avatar
mathieui committed
352
    def add_configuration_handler(self, option: str, callback: Callable):
mathieui's avatar
mathieui committed
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
        """
        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)

375
376
377
378
379
380
    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
381
382
383
384
    def on_bookmarks_method_config_change(self, option, value):
        """
        Called when the use_bookmarks_method option changes
        """
385
        if value not in ('pep', 'privatexml'):
mathieui's avatar
mathieui committed
386
387
            return
        self.bookmarks.preferred = value
388
        self.bookmarks.save(self.xmpp, core=self)
mathieui's avatar
mathieui committed
389

mathieui's avatar
mathieui committed
390
391
392
393
394
    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
395
        self.tabs.update_gaps(value.lower() != "false")
mathieui's avatar
mathieui committed
396

397
398
399
400
    def on_request_receipts_config_change(self, option, value):
        """
        Called when the request_message_receipts option changes
        """
mathieui's avatar
mathieui committed
401
402
        self.xmpp.plugin['xep_0184'].auto_request = config.get(
            option, default=True)
403
404
405
406
407

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

411
412
413
414
415
416
    def on_vertical_tab_list_config_change(self, option, value):
        """
        Called when the enable_vertical_tab_list option is changed
        """
        self.call_for_resize()

417
418
419
420
421
422
423
424
425
    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()

426
427
428
429
430
431
    def on_password_change(self, option, value):
        """
        Set the new password in the slixmpp.ClientXMPP object
        """
        self.xmpp.password = value

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

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

Eijebong's avatar
Eijebong committed
480
481
482
483
484
485
486
487
    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
488
489
    def exit_from_signal(self, *args, **kwargs):
        """
490
        Quit when receiving SIGHUP or SIGTERM or SIGPIPE
mathieui's avatar
mathieui committed
491
492
493
494

        do not save the config because it is not a normal exit
        (and only roster UI things are not yet saved)
        """
495
496
        sig = args[0]
        signals = {
mathieui's avatar
mathieui committed
497
498
499
500
            1: 'SIGHUP',
            13: 'SIGPIPE',
            15: 'SIGTERM',
        }
501
502

        log.error("%s received. Exiting…", signals[sig])
503
        if config.get('enable_user_mood'):
504
            self.xmpp.plugin['xep_0107'].stop()
505
        if config.get('enable_user_activity'):
506
            self.xmpp.plugin['xep_0108'].stop()
507
        if config.get('enable_user_gaming'):
508
            self.xmpp.plugin['xep_0196'].stop()
mathieui's avatar
mathieui committed
509
        self.plugin_manager.disable_plugins()
510
511
        self.disconnect('%s received' % signals.get(sig))
        self.xmpp.add_event_handler("disconnected", self.exit, disposable=True)
mathieui's avatar
mathieui committed
512
513
514
515
516

    def autoload_plugins(self):
        """
        Load the plugins on startup.
        """
517
        plugins = config.get('plugins_autoload')
mathieui's avatar
mathieui committed
518
519
520
521
522
523
524
525
526
527
528
529
530
        if ':' in plugins:
            for plugin in plugins.split(':'):
                self.plugin_manager.load(plugin)
        else:
            for plugin in plugins.split():
                self.plugin_manager.load(plugin)
        self.plugins_autoloaded = True

    def start(self):
        """
        Init curses, create the first tab, etc
        """
        self.stdscr = curses.initscr()
Link Mauve's avatar
Link Mauve committed
531
        self._init_curses(self.stdscr)
mathieui's avatar
mathieui committed
532
        self.call_for_resize()
533
        default_tab = tabs.RosterInfoTab(self)
mathieui's avatar
mathieui committed
534
535
        default_tab.on_gain_focus()
        self.tabs.append(default_tab)
536
        self.information('Welcome to poezio!', 'Info')
mathieui's avatar
mathieui committed
537
        if firstrun:
538
            self.information(
mathieui's avatar
mathieui committed
539
                'It seems that it is the first time you start poezio.\n'
540
                'The online help is here https://doc.poez.io/\n\n'
541
                'No room is joined by default, but you can join poezio’s'
542
543
544
545
546
                ' 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
547
        self.refresh_window()
louiz’'s avatar
louiz’ committed
548
        self.xmpp.plugin['xep_0012'].begin_idle(jid=self.xmpp.boundjid)
mathieui's avatar
mathieui committed
549

550
    def exit(self, event=None):
mathieui's avatar
mathieui committed
551
        log.debug("exit(%s)", event)
552
553
        asyncio.get_event_loop().stop()

mathieui's avatar
mathieui committed
554
555
556
557
558
559
560
561
562
563
564
    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)

565
566
567
568
569
    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
570
        that a resize occurred and we can act on it. BUT poezio doesn’t call
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
        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
586
    def on_input_readable(self):
mathieui's avatar
mathieui committed
587
588
589
        """
        main loop waiting for the user to press a key
        """
mathieui's avatar
mathieui committed
590

louiz’'s avatar
louiz’ committed
591
592
593
        log.debug("Input is readable.")
        big_char_list = [replace_key_with_bound(key)\
                         for key in self.read_keyboard()]
mathieui's avatar
mathieui committed
594
        log.debug("Got from keyboard: %s", (big_char_list, ))
louiz’'s avatar
louiz’ committed
595
596
597
598
599
600
601
602
603
604
605

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

    def save_config(self):
        """
        Save config in the file just before exit
        """
628
629
        ok = roster.save_to_config_file()
        ok = ok and config.silent_set('info_win_height',
mathieui's avatar
mathieui committed
630
                                      self.information_win_size, 'var')
631
        if not ok:
mathieui's avatar
mathieui committed
632
633
634
            self.information(
                'Unable to save runtime preferences'
                ' in the config file', 'Error')
mathieui's avatar
mathieui committed
635
636
637
638
639
640
641
642
643
644
645

    def on_roster_enter_key(self, roster_row):
        """
        when enter is pressed on the roster window
        """
        if isinstance(roster_row, Contact):
            if not self.get_conversation_by_jid(roster_row.bare_jid, False):
                self.open_conversation_window(roster_row.bare_jid)
            else:
                self.focus_tab_named(roster_row.bare_jid)
        if isinstance(roster_row, Resource):
mathieui's avatar
mathieui committed
646
647
            if not self.get_conversation_by_jid(
                    roster_row.jid, False, fallback_barejid=False):
mathieui's avatar
mathieui committed
648
649
650
651
652
                self.open_conversation_window(roster_row.jid)
            else:
                self.focus_tab_named(roster_row.jid)
        self.refresh_window()

mathieui's avatar
mathieui committed
653
    def get_conversation_messages(self) -> Optional[List[Tuple]]:
mathieui's avatar
mathieui committed
654
655
656
657
658
659
660
        """
        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')
        """
661
        if not isinstance(self.tabs.current_tab, tabs.ChatTab):
mathieui's avatar
mathieui committed
662
            return None
663
        return self.tabs.current_tab.get_conversation_messages()
mathieui's avatar
mathieui committed
664

mathieui's avatar
mathieui committed
665
    def insert_input_text(self, text: str):
mathieui's avatar
mathieui committed
666
667
668
669
670
671
672
        """
        Insert the given text into the current input
        """
        self.do_command(text, True)

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

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

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

            args = (pipes.quote(arg.replace('\n', ' ')) for arg in command)
            command_str = ' '.join(args) + '\n'
mathieui's avatar
mathieui committed
737
738
            try:
                self.remote_fifo.write(command_str)
Link Mauve's avatar
Link Mauve committed
739
            except IOError as exc:
mathieui's avatar
mathieui committed
740
741
                log.error(
                    'Could not write in the fifo (%s): %s',
Link Mauve's avatar
Link Mauve committed
742
                    filename,
mathieui's avatar
mathieui committed
743
744
                    repr(command),
                    exc_info=True)
745
746
                self.information('Could not execute %s: %s' % (command, exc),
                                 'Error')
mathieui's avatar
mathieui committed
747
748
                self.remote_fifo = None
        else:
749
            executor = Executor(command)
mathieui's avatar
mathieui committed
750
            try:
751
752
                executor.start()
            except ValueError as exc:
mathieui's avatar
mathieui committed
753
754
755
756
                log.error(
                    'Could not execute command (%s)',
                    repr(command),
                    exc_info=True)
757
                self.information(str(exc), 'Error')
mathieui's avatar
mathieui committed
758

mathieui's avatar
mathieui committed
759
    def do_command(self, key: str, raw: bool):
760
761
        """
        Execute the action associated with a key
762
763
764

        Or if keyboard.continuation_keys_callback is set, call it instead. See
        the comment of this variable.
765
        """
mathieui's avatar
mathieui committed
766
767
        if not key:
            return
768
769
770
771
772
773
774
775
        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:
776
            self.tabs.current_tab.on_input(key, raw)
mathieui's avatar
mathieui committed
777

mathieui's avatar
mathieui committed
778
    def try_execute(self, line: str):
mathieui's avatar
mathieui committed
779
780
781
782
783
        """
        Try to execute a command in the current tab
        """
        line = '/' + line
        try:
784
            self.tabs.current_tab.execute_command(line)
mathieui's avatar
mathieui committed
785
786
787
788
789
        except:
            log.error('Execute failed (%s)', line, exc_info=True)

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

Link Mauve's avatar
Link Mauve committed
790
    def remove_timed_event(self, event: DelayedEvent) -> None:
mathieui's avatar
mathieui committed
791
        """Remove an existing timed event"""
792
        event.handler.cancel()
mathieui's avatar
mathieui committed
793

Link Mauve's avatar
Link Mauve committed
794
    def add_timed_event(self, event: DelayedEvent) -> None:
mathieui's avatar
mathieui committed
795
        """Add a new timed event"""
mathieui's avatar
mathieui committed
796
797
        event.handler = asyncio.get_event_loop().call_later(
            event.delay, event.callback, *event.args)
mathieui's avatar
mathieui committed
798
799
800

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

801
    def get_status(self) -> str:
mathieui's avatar
mathieui committed
802
803
804
805
806
        """
        Get the last status that was previously set
        """
        return self.status

807
    def set_status(self, pres: str, msg: str) -> None:
mathieui's avatar
mathieui committed
808
809
810
811
812
813
        """
        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)
814
        if config.get('save_status'):
815
816
817
818
            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
819
820
821
                self.information(
                    'Unable to save the status in '
                    'the config file', 'Error')
mathieui's avatar
mathieui committed
822

mathieui's avatar
mathieui committed
823
    def get_bookmark_nickname(self, room_name: str) -> str:
mathieui's avatar
mathieui committed
824
825
826
827
        """
        Returns the nickname associated with a bookmark
        or the default nickname
        """
mathieui's avatar
mathieui committed
828
        bm = self.bookmarks[room_name]
mathieui's avatar
mathieui committed
829
830
831
832
        if bm:
            return bm.nick
        return self.own_nick

833
    def disconnect(self, msg: str = '', reconnect: bool = False) -> None:
mathieui's avatar
mathieui committed
834
835
836
837
        """
        Disconnect from remote server and correctly set the states of all
        parts of the client (for example, set the MucTabs as not joined, etc)
        """
838
        self.legitimate_disconnect = True
mathieui's avatar
mathieui committed
839
        if reconnect:
840
841
            self.xmpp.reconnect(wait=0.0, reason=msg)
        else:
842
843
            for tab in self.get_tabs(tabs.MucTab):
                tab.command_part(msg)
844
            self.xmpp.disconnect(reason=msg)
mathieui's avatar
mathieui committed
845

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

857
    def invite(self, jid: JID, room: JID, reason: Optional[str] = None) -> None:
858
859
860
861
862
        """
        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
863

864
865
866
867
868
        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
869
870
871
872
                    jid, room, reason=reason)
            else:  # fallback
                self.xmpp.plugin['xep_0045'].invite(
                    room, jid, reason=reason or '')
873

mathieui's avatar
mathieui committed
874
875
        self.xmpp.plugin['xep_0030'].get_info(
            jid=jid, timeout=5, callback=callback)
876

877
    def _impromptu_room_form(self, room):
878
        fields = [
879
880
881
882
883
884
885
            ('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'),
886
887
888
889
            # MAM
            ('boolean', 'muc#roomconfig_enablearchiving', True),  # Prosody
            ('boolean', 'mam', True),  # Ejabberd community
            ('boolean', 'muc#roomconfig_mam', True),  # Ejabberd saas
890
891
892
893
894
        ]

        form = self.xmpp['xep_0004'].make_form()
        form['type'] = 'submit'
        for field in fields:
895
896
897
898
899
            form.add_field(
                ftype=field[0],
                var=field[1],
                value=field[2],
            )
900
901
902
903
904
905
906
907
908
909

        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
910
911
912
913
914
915
916
        """
        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.
        """

917
        results = await self.xmpp['xep_0030'].get_info_from_domain()
918

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

925
926
927
928
929
930
931
932
933
934
935
936
        # 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
937

938
        nick = self.own_nick
939
        localpart = uuid.uuid4().hex
940
941
942
943
944
945
946
947
948
        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
949

950
        self.open_new_room(room, nick).join()
951
        iq = self._impromptu_room_form(room)
952
953
954
        try:
            await iq.send()
        except (IqError, IqTimeout):
955
            self.information('Failed to configure impromptu room.', 'Info')
956
957
            # TODO: destroy? leave room.
            return None
Maxime Buquet's avatar
Maxime Buquet committed
958

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

961
962
        for jid in jids:
            self.invite(jid, room)
Maxime Buquet's avatar
Maxime Buquet committed
963

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

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

mathieui's avatar
mathieui committed
1002
### Tab getters ###
mathieui's avatar
mathieui committed
1003

mathieui's avatar
mathieui committed
1004
    def get_tabs(self, cls: Type[tabs.Tab] = None) -> List[tabs.Tab]:
mathieui's avatar
mathieui committed
1005
        "Get all the tabs of a type"
Link Mauve's avatar
Link Mauve committed
1006
        if cls is None:
1007
1008
            return self.tabs.get_tabs()
        return self.tabs.by_class(cls)
mathieui's avatar
mathieui committed
1009

mathieui's avatar
mathieui committed
1010
1011
    def get_conversation_by_jid(self,
                                jid: JID,
1012
1013
                                create: bool = True,
                                fallback_barejid: bool = True) -> Optional[tabs.ChatTab]:
mathieui's avatar
mathieui committed
1014
1015
1016
1017
1018
1019
1020
1021
1022
        """
        From a JID, get the tab containing the conversation with it.
        If none already exist, and create is "True", we create it
        and return it. Otherwise, we return None.

        If fallback_barejid is True, then this method will seek other
        tabs with the same barejid, instead of searching only by fulljid.
        """
        jid = safeJID(jid)
1023
1024
        # We first check if we have a static conversation opened
        # with this precise resource
1025
1026
        conversation = self.tabs.by_name_and_class(jid.full,
                                                   tabs.StaticConversationTab)
mathieui's avatar
mathieui committed
1027
        if jid.bare == jid.full and not conversation:
1028
1029
            conversation = self.tabs.by_name_and_class(
                jid.full, tabs.DynamicConversationTab)
mathieui's avatar
mathieui committed
1030
1031
1032

        if not conversation and fallback_barejid:
            # If not, we search for a conversation with the bare jid
1033
1034
            conversation = self.tabs.by_name_and_class(
                jid.bare, tabs.DynamicConversationTab)
mathieui's avatar
mathieui committed
1035
1036
1037
1038
1039
            if not conversation:
                if create:
                    # We create a dynamic conversation with the bare Jid if
                    # nothing was found (and we lock it to the resource
                    # later)
mathieui's avatar
mathieui committed
1040
1041
                    conversation = self.open_conversation_window(
                        jid.bare, False)
mathieui's avatar
mathieui committed
1042
1043
1044
1045
                else:
                    conversation = None
        return conversation

1046
    def add_tab(self, new_tab: tabs.Tab, focus: bool = False) -> None:
mathieui's avatar
mathieui committed
1047
1048
1049
1050
1051
1052
        """
        Appends the new_tab in the tab list and
        focus it if focus==True
        """
        self.tabs.append(new_tab)
        if focus:
1053
            self.tabs.set_current_tab(new_tab)
mathieui's avatar
mathieui committed
1054

1055
    def insert_tab(self, old_pos: int, new_pos: int = 99999) -> bool:
mathieui's avatar
mathieui committed
1056
1057
1058
1059
        """
        Insert a tab at a position, changing the number of the following tabs
        returns False if it could not move the tab, True otherwise
        """
mathieui's avatar
mathieui committed
1060
1061
        return self.tabs.insert_tab(old_pos, new_pos,
                                    config.get('create_gaps'))
mathieui's avatar
mathieui committed
1062
1063
1064

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

1065
    def rotate_rooms_right(self, args=None) -> None:
mathieui's avatar
mathieui committed
1066
1067
1068
        """
        rotate the rooms list to the right
        """
1069