core.py 83 KB
Newer Older
mathieui's avatar
mathieui committed
1
2
3
4
5
6
7
8
9
10
11
"""
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

log = logging.getLogger(__name__)

12
import asyncio
13
import shutil
mathieui's avatar
mathieui committed
14
15
16
17
18
19
import curses
import os
import pipes
import sys
import time

louiz’'s avatar
louiz’ committed
20
from slixmpp.xmlstream.handler import Callback
mathieui's avatar
mathieui committed
21

22
23
24
25
26
27
28
29
from poezio import connection
from poezio import decorators
from poezio import events
from poezio import multiuserchat as muc
from poezio import tabs
from poezio import theming
from poezio import timed_events
from poezio import windows
mathieui's avatar
mathieui committed
30

31
32
33
34
35
36
37
38
39
40
41
42
43
from poezio.bookmarks import BookmarkList
from poezio.common import safeJID
from poezio.config import config, firstrun
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
from poezio.text_buffer import TextBuffer
from poezio.theming import get_theme
from poezio import keyboard
mathieui's avatar
mathieui committed
44

mathieui's avatar
mathieui committed
45
46
47
48
from poezio.core.completions import CompletionCore
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
49
50
51
52
53
54
55
56
57
        ERROR_AND_STATUS_CODES, Command, Status


class Core(object):
    """
    “Main” class of poezion
    """

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

88
        self.tab_win = windows.GlobalInfoBar(self)
89
        # Whether the XML tab is opened
90
        self.xml_tab = None
mathieui's avatar
mathieui committed
91
92
93
94
95
96
        self.xml_buffer = TextBuffer()

        self.tabs = []
        self._current_tab_nb = 0
        self.previous_tab_nb = 0

97
        own_nick = config.get('default_nick')
98
99
100
101
        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
102
103
104
105
106

        self.plugins_autoloaded = False
        self.plugin_manager = PluginManager(self)
        self.events = events.EventHandler()

107
        self.size = SizeManager(self)
mathieui's avatar
mathieui committed
108

109
110
111
112
113
114
115
        # 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
116
117
118
119
120
121
122
123
124
125
126
        # 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
127
        if not config.get('send_initial_presence'):
mathieui's avatar
mathieui committed
128
129
130
            del self.commands['status']
            del self.commands['show']

131
132
133
134
135
        # 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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
        self.key_func = KeyDict()
        # Key bindings associated with handlers
        # and pseudo-keys used to map actions below.
        key_func = {
            "KEY_PPAGE": self.scroll_page_up,
            "KEY_NPAGE": self.scroll_page_down,
            "^B": self.scroll_line_up,
            "^F": self.scroll_line_down,
            "^X": self.scroll_half_down,
            "^S": self.scroll_half_up,
            "KEY_F(5)": self.rotate_rooms_left,
            "^P": self.rotate_rooms_left,
            "M-[-D": self.rotate_rooms_left,
            'kLFT3': self.rotate_rooms_left,
            "KEY_F(6)": self.rotate_rooms_right,
            "^N": self.rotate_rooms_right,
            "M-[-C": self.rotate_rooms_right,
            'kRIT3': self.rotate_rooms_right,
            "KEY_F(4)": self.toggle_left_pane,
            "KEY_F(7)": self.shrink_information_win,
            "KEY_F(8)": self.grow_information_win,
            "KEY_RESIZE": self.call_for_resize,
            'M-e': self.go_to_important_room,
            'M-r': self.go_to_roster,
            'M-z': self.go_to_previous_tab,
            '^L': self.full_screen_redraw,
            'M-j': self.go_to_room_number,
            'M-D': self.scroll_info_up,
            'M-C': self.scroll_info_down,
            'M-k': self.escape_next_key,
        ######## actions mappings ##########
167
168
            '_bookmark': self.command.bookmark,
            '_bookmark_local': self.command.bookmark_local,
mathieui's avatar
mathieui committed
169
170
            '_close_tab': self.close_tab,
            '_disconnect': self.disconnect,
171
            '_quit': self.command.quit,
mathieui's avatar
mathieui committed
172
            '_redraw_screen': self.full_screen_redraw,
173
174
            '_reload_theme': self.command.theme,
            '_remove_bookmark': self.command.remove_bookmark,
mathieui's avatar
mathieui committed
175
176
177
178
179
180
181
            '_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,
182
183
            '_server_cycle': self.command.server_cycle,
            '_show_bookmarks': self.command.bookmarks,
mathieui's avatar
mathieui committed
184
            '_show_important_room': self.go_to_important_room,
185
186
187
            '_show_invitations': self.command.invitations,
            '_show_plugins': self.command.plugins,
            '_show_xmltab': self.command.xml_tab,
mathieui's avatar
mathieui committed
188
189
            '_toggle_pane': self.toggle_left_pane,
        ###### status actions ######
190
191
192
193
194
            '_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
195
        ##### Custom actions ########
mathieui's avatar
mathieui committed
196
            '_exc_': self.try_execute,
mathieui's avatar
mathieui committed
197
198
199
200
        }
        self.key_func.update(key_func)

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

Link Mauve's avatar
Link Mauve committed
259
260
261
262
        all_stanzas = Callback('custom matcher',
                               connection.MatchAll(None),
                               self.handler.incoming_stanza)
        self.xmpp.register_handler(all_stanzas)
263
        if config.get('enable_user_tune'):
264
            self.xmpp.add_event_handler("user_tune_publish",
265
                                        self.handler.on_tune_event)
266
        if config.get('enable_user_nick'):
267
            self.xmpp.add_event_handler("user_nick_publish",
268
                                        self.handler.on_nick_received)
269
        if config.get('enable_user_mood'):
270
            self.xmpp.add_event_handler("user_mood_publish",
271
                                        self.handler.on_mood_event)
272
        if config.get('enable_user_activity'):
273
            self.xmpp.add_event_handler("user_activity_publish",
274
                                        self.handler.on_activity_event)
275
        if config.get('enable_user_gaming'):
276
            self.xmpp.add_event_handler("user_gaming_publish",
277
                                        self.handler.on_gaming_event)
mathieui's avatar
mathieui committed
278
279
280
281
282
283
284
285
286
287
288
289
290

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

mathieui's avatar
mathieui committed
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
        self.add_configuration_handler("", self.on_any_config_change)

    def on_any_config_change(self, option, value):
        """
        Update the roster, in case a roster option changed.
        """
        roster.modified()

    def add_configuration_handler(self, option, callback):
        """
        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
        """
        if option not in self.configuration_change_handlers:
            self.configuration_change_handlers[option] = []
        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)

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

mathieui's avatar
mathieui committed
379
380
381
382
383
384
    def on_gaps_config_change(self, option, value):
        """
        Called when the option create_gaps is changed.
        Remove all gaptabs if switching from gaps to nogaps.
        """
        if value.lower() == "false":
385
            self.tabs = [tab for tab in self.tabs if tab]
mathieui's avatar
mathieui committed
386

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

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

mathieui's avatar
mathieui committed
400
401
402
403
404
405
406
    def on_plugins_dir_config_change(self, option, value):
        """
        Called when the plugins_dir option is changed
        """
        path = os.path.expanduser(value)
        self.plugin_manager.on_plugins_dir_change(path)

407
408
409
410
411
412
    def on_vertical_tab_list_config_change(self, option, value):
        """
        Called when the enable_vertical_tab_list option is changed
        """
        self.call_for_resize()

mathieui's avatar
mathieui committed
413
414
415
416
417
418
419
    def on_plugins_conf_dir_config_change(self, option, value):
        """
        Called when the plugins_conf_dir option is changed
        """
        path = os.path.expanduser(value)
        self.plugin_manager.on_plugins_conf_dir_change(path)

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

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

435
436
437
438
439
440
441
442
443

    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('')

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

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

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

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

    def autoload_plugins(self):
        """
        Load the plugins on startup.
        """
518
        plugins = config.get('plugins_autoload')
mathieui's avatar
mathieui committed
519
520
521
522
523
524
525
526
527
528
529
530
531
        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
532
        self._init_curses(self.stdscr)
mathieui's avatar
mathieui committed
533
        self.call_for_resize()
534
        default_tab = tabs.RosterInfoTab(self)
mathieui's avatar
mathieui committed
535
536
        default_tab.on_gain_focus()
        self.tabs.append(default_tab)
537
        self.information('Welcome to poezio!', 'Info')
mathieui's avatar
mathieui committed
538
        if firstrun:
539
            self.information(
mathieui's avatar
mathieui committed
540
                'It seems that it is the first time you start poezio.\n'
541
542
                'The online help is here http://doc.poez.io/\n'
                'No room is joined by default, but you can join poezio’s'
mathieui's avatar
mathieui committed
543
                ' chatroom (with /join poezio@muc.poez.io), where you can'
544
545
                ' ask for help or tell us how great it is.',
                'Help')
mathieui's avatar
mathieui committed
546
        self.refresh_window()
louiz’'s avatar
louiz’ committed
547
        self.xmpp.plugin['xep_0012'].begin_idle(jid=self.xmpp.boundjid)
mathieui's avatar
mathieui committed
548

549
550
551
552
    def exit(self, event=None):
        log.debug("exit(%s)" % (event,))
        asyncio.get_event_loop().stop()

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

564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
    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
        that a resize occured and we can act on it. BUT poezio doesn’t call
        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
585
    def on_input_readable(self):
mathieui's avatar
mathieui committed
586
587
588
589
        """
        main loop waiting for the user to press a key
        """
        def replace_line_breaks(key):
590
            "replace ^J with \n"
mathieui's avatar
mathieui committed
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
            if key == '^J':
                return '\n'
            return key
        def separate_chars_from_bindings(char_list):
            """
            returns a list of lists. For example if you give
            ['a', 'b', 'KEY_BACKSPACE', 'n', 'u'], this function returns
            [['a', 'b'], ['KEY_BACKSPACE'], ['n', 'u']]

            This way, in case of lag (for example), we handle the typed text
            by “batch” as much as possible (instead of one char at a time,
            which implies a refresh after each char, which is very slow),
            but we still handle the special chars (backspaces, arrows,
            ctrl+x ou alt+x, etc) one by one, which avoids the issue of
            printing them OR ignoring them in that case.  This should
            resolve the “my ^W are ignored when I lag ;(”.
            """
            res = []
            current = []
            for char in char_list:
611
                assert char
mathieui's avatar
mathieui committed
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
                # Transform that stupid char into what we actually meant
                if char == '\x1f':
                    char = '^/'
                if len(char) == 1:
                    current.append(char)
                else:
                    # special case for the ^I key, it’s considered as \t
                    # only when pasting some text, otherwise that’s the ^I
                    # (or M-i) key, which stands for completion by default.
                    if char == '^I' and len(char_list) != 1:
                        current.append('\t')
                        continue
                    if current:
                        res.append(current)
                        current = []
                    res.append([char])
            if current:
                res.append(current)
            return res

louiz’'s avatar
louiz’ committed
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
        log.debug("Input is readable.")
        big_char_list = [replace_key_with_bound(key)\
                         for key in self.read_keyboard()]
        log.debug("Got from keyboard: %s", (big_char_list,))

        # 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
647
                    else:
648
                        if self.current_tab().nb == nb and config.get('go_to_previous_tab_on_alt_number'):
louiz’'s avatar
louiz’ committed
649
650
                            self.go_to_previous_tab()
                        else:
651
                            self.command.win('%d' % nb)
louiz’'s avatar
louiz’ committed
652
653
654
655
                # search for keyboard shortcut
                func = self.key_func.get(char, None)
                if func:
                    func()
mathieui's avatar
mathieui committed
656
                else:
louiz’'s avatar
louiz’ committed
657
658
659
                    self.do_command(replace_line_breaks(char), False)
            else:
                self.do_command(''.join(char_list), True)
660
        if self.status.show not in ('xa', 'away'):
661
            self.xmpp.plugin['xep_0319'].idle()
662
        self.doupdate()
mathieui's avatar
mathieui committed
663
664
665
666
667

    def save_config(self):
        """
        Save config in the file just before exit
        """
668
669
670
671
672
        ok = roster.save_to_config_file()
        ok = ok and config.silent_set('info_win_height',
                                      self.information_win_size,
                                      'var')
        if not ok:
673
674
675
            self.information('Unable to save runtime preferences'
                             ' in the config file',
                             'Error')
mathieui's avatar
mathieui committed
676
677
678
679
680
681
682
683
684
685
686

    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):
687
688
689
            if not self.get_conversation_by_jid(roster_row.jid,
                                                False,
                                                fallback_barejid=False):
mathieui's avatar
mathieui committed
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
718
719
720
721
722
                self.open_conversation_window(roster_row.jid)
            else:
                self.focus_tab_named(roster_row.jid)
        self.refresh_window()

    def get_conversation_messages(self):
        """
        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')
        """
        if not isinstance(self.current_tab(), tabs.ChatTab):
            return None
        return self.current_tab().get_conversation_messages()

    def insert_input_text(self, text):
        """
        Insert the given text into the current input
        """
        self.do_command(text, True)


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

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

    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.
        """
762
        if config.get('exec_remote'):
mathieui's avatar
mathieui committed
763
            # We just write the command in the fifo
764
            fifo_path = config.get('remote_fifo_path')
mathieui's avatar
mathieui committed
765
766
            if not self.remote_fifo:
                try:
767
768
769
770
                    self.remote_fifo = Fifo(os.path.join(fifo_path,
                                                         'poezio.fifo'),
                                            'w')
                except (OSError, IOError) as exc:
mathieui's avatar
mathieui committed
771
                    log.error('Could not open the fifo for writing (%s)',
772
773
774
775
776
                               os.path.join(fifo_path, './', 'poezio.fifo'),
                               exc_info=True)
                    self.information('Could not open the fifo '
                                     'file for writing: %s' % exc,
                                     'Error')
mathieui's avatar
mathieui committed
777
                    return
778
779
780

            args = (pipes.quote(arg.replace('\n', ' ')) for arg in command)
            command_str = ' '.join(args) + '\n'
mathieui's avatar
mathieui committed
781
782
            try:
                self.remote_fifo.write(command_str)
783
            except (IOError) as exc:
mathieui's avatar
mathieui committed
784
                log.error('Could not write in the fifo (%s): %s',
785
                            os.path.join(fifo_path, './', 'poezio.fifo'),
mathieui's avatar
mathieui committed
786
787
                            repr(command),
                            exc_info=True)
788
789
                self.information('Could not execute %s: %s' % (command, exc),
                                 'Error')
mathieui's avatar
mathieui committed
790
791
                self.remote_fifo = None
        else:
792
            executor = Executor(command)
mathieui's avatar
mathieui committed
793
            try:
794
795
796
797
798
799
                executor.start()
            except ValueError as exc:
                log.error('Could not execute command (%s)',
                          repr(command),
                          exc_info=True)
                self.information('%s' % exc, 'Error')
mathieui's avatar
mathieui committed
800
801
802


    def do_command(self, key, raw):
803
804
        """
        Execute the action associated with a key
805
806
807

        Or if keyboard.continuation_keys_callback is set, call it instead. See
        the comment of this variable.
808
        """
mathieui's avatar
mathieui committed
809
810
        if not key:
            return
811
812
813
814
815
816
817
818
819
        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:
            self.current_tab().on_input(key, raw)
mathieui's avatar
mathieui committed
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836


    def try_execute(self, line):
        """
        Try to execute a command in the current tab
        """
        line = '/' + line
        try:
            self.current_tab().execute_command(line)
        except:
            log.error('Execute failed (%s)', line, exc_info=True)


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

    def remove_timed_event(self, event):
        """Remove an existing timed event"""
837
        event.handler.cancel()
mathieui's avatar
mathieui committed
838
839
840

    def add_timed_event(self, event):
        """Add a new timed event"""
841
842
843
        event.handler = asyncio.get_event_loop().call_later(event.delay,
                                                            event.callback,
                                                            *event.args)
mathieui's avatar
mathieui committed
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859

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

    def get_status(self):
        """
        Get the last status that was previously set
        """
        return self.status

    def set_status(self, pres, msg):
        """
        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)
860
        if config.get('save_status'):
861
862
863
864
            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:
865
866
                self.information('Unable to save the status in '
                                 'the config file', 'Error')
mathieui's avatar
mathieui committed
867
868
869
870
871
872

    def get_bookmark_nickname(self, room_name):
        """
        Returns the nickname associated with a bookmark
        or the default nickname
        """
mathieui's avatar
mathieui committed
873
        bm = self.bookmarks[room_name]
mathieui's avatar
mathieui committed
874
875
876
877
878
879
880
881
882
        if bm:
            return bm.nick
        return self.own_nick

    def disconnect(self, msg='', reconnect=False):
        """
        Disconnect from remote server and correctly set the states of all
        parts of the client (for example, set the MucTabs as not joined, etc)
        """
883
        self.legitimate_disconnect = True
mathieui's avatar
mathieui committed
884
885
886
887
888
        msg = msg or ''
        for tab in self.get_tabs(tabs.MucTab):
            tab.command_part(msg)
        self.xmpp.disconnect()
        if reconnect:
889
890
891
            # Add a one-time event to reconnect as soon as we are
            # effectively disconnected
            self.xmpp.add_event_handler('disconnected', lambda event: self.xmpp.connect(), disposable=True)
mathieui's avatar
mathieui committed
892
893
894

    def send_message(self, msg):
        """
895
896
        Function to use in plugins to send a message in the current
        conversation.
mathieui's avatar
mathieui committed
897
898
899
900
901
902
903
        Returns False if the current tab is not a conversation tab
        """
        if not isinstance(self.current_tab(), tabs.ChatTab):
            return False
        self.current_tab().command_say(msg)
        return True

904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
    def invite(self, jid, room, reason=None):
        """
        Checks if the sender supports XEP-0249, then send an invitation,
        or a mediated one if it does not.
        TODO: allow passwords
        """
        def callback(iq):
            if not iq:
                return
            if 'jabber:x:conference' in iq['disco_info'].get_features():
                self.xmpp.plugin['xep_0249'].send_invitation(
                        jid,
                        room,
                        reason=reason)
            else: # fallback
                self.xmpp.plugin['xep_0045'].invite(room, jid,
                        reason=reason or '')

922
923
        self.xmpp.plugin['xep_0030'].get_info(jid=jid, timeout=5,
                                              callback=callback)
924

mathieui's avatar
mathieui committed
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
    def get_error_message(self, stanza, deprecated=False):
        """
        Takes a stanza of the form <message type='error'><error/></message>
        and return a well formed string containing the error informations
        """
        sender = stanza.attrib['from']
        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:
940
                    body = condition or 'Unknown error'
mathieui's avatar
mathieui committed
941
942
943
944
            else:
                if code in ERROR_AND_STATUS_CODES:
                    body = ERROR_AND_STATUS_CODES[code]
                else:
945
                    body = condition or 'Unknown error'
mathieui's avatar
mathieui committed
946
        if code:
947
948
            message = '%(from)s: %(code)s - %(msg)s: %(body)s' % {
                      'from': sender, 'msg': msg, 'body': body, 'code': code}
mathieui's avatar
mathieui committed
949
        else:
950
951
            message = '%(from)s: %(msg)s: %(body)s' % {
                      'from': sender, 'msg': msg, 'body': body}
mathieui's avatar
mathieui committed
952
953
954
955
956
957
958
        return message


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

    ### Tab getters ###

Link Mauve's avatar
Link Mauve committed
959
    def get_tabs(self, cls=None):
mathieui's avatar
mathieui committed
960
        "Get all the tabs of a type"
Link Mauve's avatar
Link Mauve committed
961
962
        if cls is None:
            cls = tabs.Tab
963
        return [tab for tab in self.tabs if isinstance(tab, cls)]
mathieui's avatar
mathieui committed
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981

    def current_tab(self):
        """
        returns the current room, the one we are viewing
        """
        self.current_tab_nb = self.current_tab_nb
        return self.tabs[self.current_tab_nb]

    def get_conversation_by_jid(self, jid, create=True, fallback_barejid=True):
        """
        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)
982
983
984
985
        # We first check if we have a static conversation opened
        # with this precise resource
        conversation = self.get_tab_by_name(jid.full,
                                            tabs.StaticConversationTab)
mathieui's avatar
mathieui committed
986
        if jid.bare == jid.full and not conversation:
987
988
            conversation = self.get_tab_by_name(jid.full,
                                                tabs.DynamicConversationTab)
mathieui's avatar
mathieui committed
989
990
991

        if not conversation and fallback_barejid:
            # If not, we search for a conversation with the bare jid
992
993
            conversation = self.get_tab_by_name(jid.bare,
                                                tabs.DynamicConversationTab)
mathieui's avatar
mathieui committed
994
995
996
997
998
            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)
999
1000
                    conversation = self.open_conversation_window(jid.bare,
                                                                 False)
For faster browsing, not all history is shown. View entire blame