core.py 81.5 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
mathieui's avatar
mathieui committed
13
import collections
14
import shutil
mathieui's avatar
mathieui committed
15
16
17
18
19
20
21
22
23
import curses
import os
import pipes
import sys
import time
from threading import Event
from datetime import datetime
from gettext import gettext as _

louiz’'s avatar
louiz’ committed
24
from slixmpp.xmlstream.handler import Callback
mathieui's avatar
mathieui committed
25
26
27
28
29

import bookmark
import connection
import decorators
import events
30
import fixes
mathieui's avatar
mathieui committed
31
32
33
34
35
36
37
38
39
40
41
import singleton
import tabs
import theming
import timed_events
import windows

from common import safeJID
from config import config, firstrun
from contact import Contact, Resource
from daemon import Executor
from fifo import Fifo
42
from keyboard import Keyboard
mathieui's avatar
mathieui committed
43
44
45
from logger import logger
from plugin_manager import PluginManager
from roster import roster
46
from size_manager import SizeManager
mathieui's avatar
mathieui committed
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
from text_buffer import TextBuffer
from theming import get_theme

from . import completions
from . import commands
from . import handlers
from . structs import possible_show, DEPRECATED_ERRORS, \
        ERROR_AND_STATUS_CODES, Command, Status


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

    def __init__(self):
        # 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()
67
        self.stdscr = None
mathieui's avatar
mathieui committed
68
69
70
71
72
73
74
        status = config.get('status', None)
        status = possible_show.get(status, None)
        self.status = Status(show=status,
                message=config.get('status_message', ''))
        self.running = True
        self.xmpp = singleton.Singleton(connection.Connection)
        self.xmpp.core = self
75
        self.keyboard = Keyboard()
mathieui's avatar
mathieui committed
76
77
78
79
80
81
82
83
84
85
86
87
88
        roster.set_node(self.xmpp.client_roster)
        decorators.refresh_wrapper.core = self
        self.paused = False
        self.event = Event()
        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()
        self.information_win_size = config.get('info_win_height', 2, 'var')
        self.information_win = windows.TextWin(300)
        self.information_buffer.add_window(self.information_win)
89
        self.left_tab_win = None
mathieui's avatar
mathieui committed
90
91

        self.tab_win = windows.GlobalInfoBar()
92
        # Whether the XML tab is opened
mathieui's avatar
mathieui committed
93
94
95
96
97
98
99
        self.xml_tab = False
        self.xml_buffer = TextBuffer()

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

100
101
102
103
104
        own_nick = config.get('default_nick', '')
        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
105
106
107
108
109

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

110
        self.size = SizeManager(self, windows.Win)
mathieui's avatar
mathieui committed
111

112
113
114
115
116
117
118
        # 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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
        # 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
        if not config.get('send_initial_presence', True):
            del self.commands['status']
            del self.commands['show']

        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 ##########
            '_bookmark': self.command_bookmark,
            '_bookmark_local': self.command_bookmark_local,
            '_close_tab': self.close_tab,
            '_disconnect': self.disconnect,
            '_quit': self.command_quit,
            '_redraw_screen': self.full_screen_redraw,
            '_reload_theme': self.command_theme,
            '_remove_bookmark': self.command_remove_bookmark,
            '_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,
            '_server_cycle': self.command_server_cycle,
            '_show_bookmarks': self.command_bookmarks,
            '_show_important_room': self.go_to_important_room,
            '_show_invitations': self.command_invitations,
            '_show_plugins': self.command_plugins,
            '_show_xmltab': self.command_xml_tab,
            '_toggle_pane': self.toggle_left_pane,
        ###### status actions ######
            '_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'),
        ##### Custom actions ########
mathieui's avatar
mathieui committed
194
            '_exc_': self.try_execute,
mathieui's avatar
mathieui committed
195
196
197
198
        }
        self.key_func.update(key_func)

        # Add handlers
199
        self.xmpp.add_event_handler('connecting', self.on_connecting)
mathieui's avatar
mathieui committed
200
        self.xmpp.add_event_handler('connected', self.on_connected)
201
        self.xmpp.add_event_handler('connection_failed', self.on_failed_connection)
mathieui's avatar
mathieui committed
202
        self.xmpp.add_event_handler('disconnected', self.on_disconnected)
203
        self.xmpp.add_event_handler('failed_all_auth', self.on_failed_all_auth)
mathieui's avatar
mathieui committed
204
205
        self.xmpp.add_event_handler('no_auth', self.on_no_auth)
        self.xmpp.add_event_handler("session_start", self.on_session_start)
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
        self.xmpp.add_event_handler("session_start",
                                    self.on_session_start_features)
        self.xmpp.add_event_handler("groupchat_presence",
                                    self.on_groupchat_presence)
        self.xmpp.add_event_handler("groupchat_message",
                                    self.on_groupchat_message)
        self.xmpp.add_event_handler("groupchat_invite",
                                    self.on_groupchat_invitation)
        self.xmpp.add_event_handler("groupchat_direct_invite",
                                    self.on_groupchat_direct_invitation)
        self.xmpp.add_event_handler("groupchat_decline",
                                    self.on_groupchat_decline)
        self.xmpp.add_event_handler("groupchat_config_status",
                                    self.on_status_codes)
        self.xmpp.add_event_handler("groupchat_subject",
                                    self.on_groupchat_subject)
mathieui's avatar
mathieui committed
222
        self.xmpp.add_event_handler("message", self.on_message)
223
        self.xmpp.add_event_handler("receipt_received", self.on_receipt)
mathieui's avatar
mathieui committed
224
225
        self.xmpp.add_event_handler("got_online", self.on_got_online)
        self.xmpp.add_event_handler("got_offline", self.on_got_offline)
mathieui's avatar
mathieui committed
226
227
228
        self.xmpp.add_event_handler("roster_update", self.on_roster_update)
        self.xmpp.add_event_handler("changed_status", self.on_presence)
        self.xmpp.add_event_handler("presence_error", self.on_presence_error)
229
230
231
232
233
234
235
236
        self.xmpp.add_event_handler("roster_subscription_request",
                                    self.on_subscription_request)
        self.xmpp.add_event_handler("roster_subscription_authorized",
                                    self.on_subscription_authorized)
        self.xmpp.add_event_handler("roster_subscription_remove",
                                    self.on_subscription_remove)
        self.xmpp.add_event_handler("roster_subscription_removed",
                                    self.on_subscription_removed)
mathieui's avatar
mathieui committed
237
        self.xmpp.add_event_handler("message_xform", self.on_data_form)
238
239
240
241
242
243
244
245
246
247
        self.xmpp.add_event_handler("chatstate_active",
                                    self.on_chatstate_active)
        self.xmpp.add_event_handler("chatstate_composing",
                                    self.on_chatstate_composing)
        self.xmpp.add_event_handler("chatstate_paused",
                                    self.on_chatstate_paused)
        self.xmpp.add_event_handler("chatstate_gone",
                                    self.on_chatstate_gone)
        self.xmpp.add_event_handler("chatstate_inactive",
                                    self.on_chatstate_inactive)
mathieui's avatar
mathieui committed
248
249
        self.xmpp.add_event_handler("attention", self.on_attention)
        self.xmpp.add_event_handler("ssl_cert", self.validate_ssl)
250
251
252
        self.all_stanzas = Callback('custom matcher',
                                    connection.MatchAll(None),
                                    self.incoming_stanza)
mathieui's avatar
mathieui committed
253
254
        self.xmpp.register_handler(self.all_stanzas)
        if config.get('enable_user_tune', True):
255
256
            self.xmpp.add_event_handler("user_tune_publish",
                                        self.on_tune_event)
mathieui's avatar
mathieui committed
257
        if config.get('enable_user_nick', True):
258
259
            self.xmpp.add_event_handler("user_nick_publish",
                                        self.on_nick_received)
mathieui's avatar
mathieui committed
260
        if config.get('enable_user_mood', True):
261
262
            self.xmpp.add_event_handler("user_mood_publish",
                                        self.on_mood_event)
mathieui's avatar
mathieui committed
263
        if config.get('enable_user_activity', True):
264
265
            self.xmpp.add_event_handler("user_activity_publish",
                                        self.on_activity_event)
mathieui's avatar
mathieui committed
266
        if config.get('enable_user_gaming', True):
267
268
            self.xmpp.add_event_handler("user_gaming_publish",
                                        self.on_gaming_event)
mathieui's avatar
mathieui committed
269
270
271
272
273
274
275
276
277
278
279
280
281

        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
282
283
        # 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
284
285
286
287
288
        # 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 = {"": []}
289
290
        self.add_configuration_handler("create_gaps",
                                       self.on_gaps_config_change)
291
292
293
294
        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)
295
296
297
298
299
300
301
302
303
304
305
306
        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)
307
308
        self.add_configuration_handler("password",
                                       self.on_password_change)
309

mathieui's avatar
mathieui committed
310
311
312
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
341
342
343
344
345
346
347
348
        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)

    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":
349
            self.tabs = list(tab for tab in self.tabs if tab)
mathieui's avatar
mathieui committed
350

351
352
353
354
355
356
357
358
359
360
361
362
    def on_request_receipts_config_change(self, option, value):
        """
        Called when the request_message_receipts option changes
        """
        self.xmpp.plugin['xep_0184'].auto_request = config.get(option, True)

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

mathieui's avatar
mathieui committed
363
364
365
366
367
368
369
370
371
372
373
374
375
376
    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)

    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)

377
378
379
380
381
382
383
384
385
    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()

386
387
388
389
390
391
    def on_password_change(self, option, value):
        """
        Set the new password in the slixmpp.ClientXMPP object
        """
        self.xmpp.password = value

mathieui's avatar
mathieui committed
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
    def sigusr_handler(self, num, stack):
        """
        Handle SIGUSR1 (10)
        When caught, reload all the possible files.
        """
        log.debug("SIGUSR1 caught, reloading the files…")
        # 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…")
        self.command_theme("")
        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()
410
        config.read_file()
mathieui's avatar
mathieui committed
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
        # 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)
                new_value = config.get(option, "", section)
                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()

    def exit_from_signal(self, *args, **kwargs):
        """
426
        Quit when receiving SIGHUP or SIGTERM or SIGPIPE
mathieui's avatar
mathieui committed
427
428
429
430

        do not save the config because it is not a normal exit
        (and only roster UI things are not yet saved)
        """
431
432
433
434
435
436
437
438
        sig = args[0]
        signals = {
                1: 'SIGHUP',
                13: 'SIGPIPE',
                15: 'SIGTERM',
                }

        log.error("%s received. Exiting…", signals[sig])
mathieui's avatar
mathieui committed
439
        if config.get('enable_user_mood', True):
440
            self.xmpp.plugin['xep_0107'].stop()
mathieui's avatar
mathieui committed
441
        if config.get('enable_user_activity', True):
442
            self.xmpp.plugin['xep_0108'].stop()
mathieui's avatar
mathieui committed
443
        if config.get('enable_user_gaming', True):
444
            self.xmpp.plugin['xep_0196'].stop()
mathieui's avatar
mathieui committed
445
        self.plugin_manager.disable_plugins()
446
447
        self.disconnect('%s received' % signals.get(sig))
        self.xmpp.add_event_handler("disconnected", self.exit, disposable=True)
mathieui's avatar
mathieui committed
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471

    def autoload_plugins(self):
        """
        Load the plugins on startup.
        """
        plugins = config.get('plugins_autoload', '')
        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()
        self.init_curses(self.stdscr)
        self.call_for_resize()
        default_tab = tabs.RosterInfoTab()
        default_tab.on_gain_focus()
        self.tabs.append(default_tab)
472
        self.information(_('Welcome to poezio!'), _('Info'))
mathieui's avatar
mathieui committed
473
474
475
        if firstrun:
            self.information(_(
                'It seems that it is the first time you start poezio.\n'
476
477
478
479
480
                'The online help is here http://doc.poez.io/\n'
                'No room is joined by default, but you can join poezio’s'
                'chatroom (with /join poezio@muc.poez.io), where you can'
                ' ask for help or tell us how great it is.'),
                _('Help'))
mathieui's avatar
mathieui committed
481
        self.refresh_window()
louiz’'s avatar
louiz’ committed
482
        self.xmpp.plugin['xep_0012'].begin_idle(jid=self.xmpp.boundjid)
mathieui's avatar
mathieui committed
483

484
485
486
487
    def exit(self, event=None):
        log.debug("exit(%s)" % (event,))
        asyncio.get_event_loop().stop()

mathieui's avatar
mathieui committed
488
489
490
491
492
493
494
495
496
497
498
    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)

499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
    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
520
    def on_input_readable(self):
mathieui's avatar
mathieui committed
521
522
523
524
        """
        main loop waiting for the user to press a key
        """
        def replace_line_breaks(key):
525
            "replace ^J with \n"
mathieui's avatar
mathieui committed
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
            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:
546
                assert char
mathieui's avatar
mathieui committed
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
                # 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
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
        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):
            if self.paused:
                self.current_tab().input.do_command(char_list[0])
                self.current_tab().input.prompt()
                self.event.set()
                continue
            # 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
587
                    else:
louiz’'s avatar
louiz’ committed
588
589
590
591
592
593
594
595
                        if self.current_tab().nb == nb:
                            self.go_to_previous_tab()
                        else:
                            self.command_win('%d' % nb)
                # search for keyboard shortcut
                func = self.key_func.get(char, None)
                if func:
                    func()
mathieui's avatar
mathieui committed
596
                else:
louiz’'s avatar
louiz’ committed
597
598
599
                    self.do_command(replace_line_breaks(char), False)
            else:
                self.do_command(''.join(char_list), True)
600
601
        if self.status.show not in ('xa', 'away'):
            self.xmpp.plugin['xep_0012'].begin_idle(jid=self.xmpp.boundjid)
602
        self.doupdate()
mathieui's avatar
mathieui committed
603
604
605
606
607

    def save_config(self):
        """
        Save config in the file just before exit
        """
608
609
610
611
612
613
614
615
        ok = roster.save_to_config_file()
        ok = ok and config.silent_set('info_win_height',
                                      self.information_win_size,
                                      'var')
        if not ok:
            self.information(_('Unable to save runtime preferences'
                               ' in the config file'),
                             _('Error'))
mathieui's avatar
mathieui committed
616
617
618
619
620
621
622
623
624
625
626

    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):
627
628
629
            if not self.get_conversation_by_jid(roster_row.jid,
                                                False,
                                                fallback_barejid=False):
mathieui's avatar
mathieui committed
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
                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('/'):
            command = line.strip()[:].split()[0][1:]
            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:
                func = self.commands[command][0]
                func(arg)
                return
            else:
671
672
                self.information(_("Unknown command (%s)") % (command),
                                 _('Error'))
mathieui's avatar
mathieui committed
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703

    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.
        """
        if config.get('exec_remote', False):
            # We just write the command in the fifo
704
            fifo_path = config.get('remote_fifo_path', './')
mathieui's avatar
mathieui committed
705
706
            if not self.remote_fifo:
                try:
707
708
709
710
                    self.remote_fifo = Fifo(os.path.join(fifo_path,
                                                         'poezio.fifo'),
                                            'w')
                except (OSError, IOError) as exc:
mathieui's avatar
mathieui committed
711
                    log.error('Could not open the fifo for writing (%s)',
712
713
714
715
716
                               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
717
                    return
718
719
720

            args = (pipes.quote(arg.replace('\n', ' ')) for arg in command)
            command_str = ' '.join(args) + '\n'
mathieui's avatar
mathieui committed
721
722
            try:
                self.remote_fifo.write(command_str)
723
            except (IOError) as exc:
mathieui's avatar
mathieui committed
724
                log.error('Could not write in the fifo (%s): %s',
725
                            os.path.join(fifo_path, './', 'poezio.fifo'),
mathieui's avatar
mathieui committed
726
727
                            repr(command),
                            exc_info=True)
728
729
                self.information('Could not execute %s: %s' % (command, exc),
                                 'Error')
mathieui's avatar
mathieui committed
730
731
                self.remote_fifo = None
        else:
732
            executor = Executor(command)
mathieui's avatar
mathieui committed
733
            try:
734
735
736
737
738
739
                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
740
741
742


    def do_command(self, key, raw):
743
744
745
        """
        Execute the action associated with a key
        """
mathieui's avatar
mathieui committed
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
        if not key:
            return
        return self.current_tab().on_input(key, raw)


    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"""
766
        event.handler.cancel()
mathieui's avatar
mathieui committed
767
768
769

    def add_timed_event(self, event):
        """Add a new timed event"""
770
771
772
        event.handler = asyncio.get_event_loop().call_later(event.delay,
                                                            event.callback,
                                                            *event.args)
mathieui's avatar
mathieui committed
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789

####################### 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)
        if config.get('save_status', True):
790
791
792
793
794
795
            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:
                self.information(_('Unable to save the status in '
                                   'the config file'), 'Error')
mathieui's avatar
mathieui committed
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811

    def get_bookmark_nickname(self, room_name):
        """
        Returns the nickname associated with a bookmark
        or the default nickname
        """
        bm = bookmark.get_by_jid(room_name)
        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)
        """
812
        self.legitimate_disconnect = True
mathieui's avatar
mathieui committed
813
814
815
816
817
        msg = msg or ''
        for tab in self.get_tabs(tabs.MucTab):
            tab.command_part(msg)
        self.xmpp.disconnect()
        if reconnect:
818
819
820
            # 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
821
822
823

    def send_message(self, msg):
        """
824
825
        Function to use in plugins to send a message in the current
        conversation.
mathieui's avatar
mathieui committed
826
827
828
829
830
831
832
        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

833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
    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 '')

851
852
        self.xmpp.plugin['xep_0030'].get_info(jid=jid, timeout=5,
                                              callback=callback)
853

mathieui's avatar
mathieui committed
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
    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:
                    body = condition or _('Unknown error')
            else:
                if code in ERROR_AND_STATUS_CODES:
                    body = ERROR_AND_STATUS_CODES[code]
                else:
                    body = condition or _('Unknown error')
        if code:
876
877
            message = _('%(from)s: %(code)s - %(msg)s: %(body)s') % {
                    'from': sender, 'msg': msg, 'body': body, 'code': code}
mathieui's avatar
mathieui committed
878
        else:
879
880
            message = _('%(from)s: %(msg)s: %(body)s') % {
                    'from': sender, 'msg': msg, 'body': body}
mathieui's avatar
mathieui committed
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
        return message


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

    ### Tab getters ###

    def get_tabs(self, cls=tabs.Tab):
        "Get all the tabs of a type"
        return filter(lambda tab: isinstance(tab, cls), self.tabs)

    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)
909
910
911
912
        # 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
913
        if jid.bare == jid.full and not conversation:
914
915
            conversation = self.get_tab_by_name(jid.full,
                                                tabs.DynamicConversationTab)
mathieui's avatar
mathieui committed
916
917
918

        if not conversation and fallback_barejid:
            # If not, we search for a conversation with the bare jid
919
920
            conversation = self.get_tab_by_name(jid.bare,
                                                tabs.DynamicConversationTab)
mathieui's avatar
mathieui committed
921
922
923
924
925
            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)
926
927
                    conversation = self.open_conversation_window(jid.bare,
                                                                 False)
mathieui's avatar
mathieui committed
928
929
930
931
932
933
934
935
936
937
                else:
                    conversation = None
        return conversation

    def get_tab_by_name(self, name, typ=None):
        """
        Get the tab with the given name.
        If typ is provided, return a tab of this type only
        """
        for tab in self.tabs:
938
            if tab.name == name:
mathieui's avatar
mathieui committed
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
                if (typ and isinstance(tab, typ)) or\
                        not typ:
                    return tab
        return None

    def get_tab_by_number(self, number):
        if 0 <= number < len(self.tabs):
            return self.tabs[number]
        return None

    def add_tab(self, new_tab, focus=False):
        """
        Appends the new_tab in the tab list and
        focus it if focus==True
        """
        self.tabs.append(new_tab)
        if focus:
            self.command_win("%s" % new_tab.nb)

    def insert_tab_nogaps(self, old_pos, new_pos):
        """
        Move tabs without creating gaps
        old_pos: old position of the tab
        new_pos: desired position of the tab
        """
        tab = self.tabs[old_pos]
        if new_pos < old_pos:
            self.tabs.pop(old_pos)
            self.tabs.insert(new_pos, tab)
        elif new_pos > old_pos:
            self.tabs.insert(new_pos, tab)
            self.tabs.remove(tab)
        else:
            return False
        return True

    def insert_tab_gaps(self, old_pos, new_pos):
        """
        Move tabs and create gaps in the eventual remaining space
        old_pos: old position of the tab
        new_pos: desired position of the tab
        """
        tab = self.tabs[old_pos]
        target = None if new_pos >= len(self.tabs) else self.tabs[new_pos]
        if not target:
            if new_pos < len(self.tabs):
985
986
                old_tab = self.tabs[old_pos]
                self.tabs[new_pos], self.tabs[old_pos] = old_tab, tabs.GapTab()
mathieui's avatar
mathieui committed
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
            else:
                self.tabs.append(self.tabs[old_pos])
                self.tabs[old_pos] = tabs.GapTab()
        else:
            if new_pos > old_pos:
                self.tabs.insert(new_pos, tab)
                self.tabs[old_pos] = tabs.GapTab()
            elif new_pos < old_pos:
                self.tabs[old_pos] = tabs.GapTab()
                self.tabs.insert(new_pos, tab)
            else:
                return False
            i = self.tabs.index(tab)
            done = False
For faster browsing, not all history is shown. View entire blame