gajim_remote.py 20.6 KB
Newer Older
André's avatar
André committed
1
#!/usr/bin/env python3
Philipp Hörist's avatar
Philipp Hörist committed
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23

# Copyright (C) 2005-2006 Dimitur Kirov <dkirov AT gmail.com>
#                         Nikos Kouremenos <kourem AT gmail.com>
# Copyright (C) 2005-2014 Yann Leboulanger <asterix AT lagaule.org>
# Copyright (C) 2006 Junglecow <junglecow AT gmail.com>
#                    Travis Shirk <travis AT pobox.com>
# Copyright (C) 2006-2008 Jean-Marie Traissard <jim AT lapin.org>
# Copyright (C) 2007 Julien Pivotto <roidelapluie AT gmail.com>
#
# This file is part of Gajim.
#
# Gajim is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published
# by the Free Software Foundation; version 3 only.
#
# Gajim is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Gajim. If not, see <http://www.gnu.org/licenses/>.
dkirov's avatar
dkirov committed
24

25
# gajim-remote help will show you the D-BUS API of Gajim
dkirov's avatar
dkirov committed
26

27
import os
dkirov's avatar
dkirov committed
28
import sys
29
import locale
dkirov's avatar
dkirov committed
30
import signal
31

André's avatar
André committed
32
from gajim.common import exceptions
33
from gajim.common.i18n import _
André's avatar
André committed
34
from gajim.common.i18n import Q_
dkirov's avatar
dkirov committed
35

36 37
signal.signal(signal.SIGINT, signal.SIG_DFL) # ^C exits the application

38
try:
39
    PREFERRED_ENCODING = locale.getpreferredencoding()
40
except Exception:
41
    PREFERRED_ENCODING = 'UTF-8'
dkirov's avatar
dkirov committed
42

dkirov's avatar
dkirov committed
43
def send_error(error_message):
44
    '''Writes error message to stderr and exits'''
Yann Leboulanger's avatar
Yann Leboulanger committed
45
    print(error_message, file=sys.stderr)
46
    sys.exit(1)
dkirov's avatar
dkirov committed
47

dkirov's avatar
dkirov committed
48
try:
49 50
    import dbus
    import dbus.service
51
#    import dbus.glib
52 53
    # test if dbus-x11 is installed
    bus = dbus.SessionBus()
54
except Exception:
Yann Leboulanger's avatar
Yann Leboulanger committed
55
    print(_('D-Bus is not present on this machine or python module is missing'))
56
    sys.exit(1)
dkirov's avatar
dkirov committed
57 58 59

OBJ_PATH = '/org/gajim/dbus/RemoteObject'
INTERFACE = 'org.gajim.dbus.RemoteInterface'
André's avatar
André committed
60
SERVICE = 'org.gajim.Gajim'
Dicson's avatar
Dicson committed
61
BASENAME = 'gajim-remote'
dkirov's avatar
dkirov committed
62 63

class GajimRemote:
64

65 66 67 68 69 70 71 72 73 74 75
    def __init__(self):
        self.argv_len = len(sys.argv)
        # define commands dict. Prototype :
        # {
        #       'command': [comment, [list of arguments] ]
        # }
        #
        # each argument is defined as a tuple:
        #    (argument name, help on argument, is mandatory)
        #
        self.commands = {
76
                'help': [
77 78 79 80 81 82 83 84
                                _('Shows a help on specific command'),
                                [
                                        #User gets help for the command, specified by this parameter
                                        (_('command'),
                                        _('show help on command'), False)
                                ]
                        ],
                'list_contacts': [
85
                                _('Lists all contacts in roster, one for each line'),
86
                                [
87
                                    (Q_('?CLI:account'), _('show only contacts of the given account'),
88 89 90 91 92 93 94 95 96
                                                False)
                                ]

                        ],
                'list_accounts': [
                                _('Prints a list of registered accounts'),
                                []
                        ],
                'change_status': [
97
                                _('Changes the status of account(s)'),
98
                                [
dkirov's avatar
dkirov committed
99
#offline, online, chat, away, xa, dnd, invisible should not be translated
100 101 102
                                    (Q_('?CLI:status'), _('one of: offline, online, chat, away, xa, dnd, invisible. If not set, use account\'s previous status'), False),
                                    (Q_('?CLI:message'), _('status message'), False),
                                    (Q_('?CLI:account'), _('change status of account "account". '
103 104 105 106 107
        'If not specified, try to change status of all accounts that have '
        '"sync with global status" option set'), False)
                                ]
                        ],
                'set_priority': [
108
                                _('Changes the priority of account(s)'),
109
                                [
110
                                    (Q_('?CLI:priority'), _('priority you want to give to the account'),
111
                                                True),
112
                                    (Q_('?CLI:account'), _('change the priority of the given account. '
113 114 115 116
                                                'If not specified, change status of all accounts that have'
                                                ' "sync with global status" option set'), False)
                                ]
                        ],
117
                'send_chat_message': [
118 119 120 121 122
                                _('Sends new chat message to a contact in the roster. Both OpenPGP key '
                                'and account are optional. If you want to set only \'account\', '
                                'without \'OpenPGP key\', just set \'OpenPGP key\' to \'\'.'),
                                [
                                        ('jid', _('JID of the contact that will receive the message'), True),
123
                                        (Q_('?CLI:message'), _('message contents'), True),
124
                                        (_('PGP key'), _('if specified, the message will be encrypted '
125
                                                'using this public key'), False),
126
                                        (Q_('?CLI:account'), _('if specified, the message will be sent '
127 128 129
                                                'using this account'), False),
                                ]
                        ],
130
                'send_single_message': [
131 132 133
                                _('Sends a chat message to someone on your roster. '
                                'Optionally with OpenPGP key and account. If you want '
                                'to only set the latter, set OpenPGP key to "".'),
134 135 136
                                [
                                        ('jid', _('JID of the contact that will receive the message'), True),
                                        (_('subject'), _('message subject'), True),
137
                                        (Q_('?CLI:message'), _('message contents'), True),
138
                                        (_('PGP key'), _('if specified, the message will be encrypted '
139
                                                'using this public key'), False),
140
                                        (Q_('?CLI:account'), _('if specified, the message will be sent '
141 142 143
                                                'using this account'), False),
                                ]
                        ],
144
                'send_groupchat_message': [
145 146 147
                                _('Sends new message to a groupchat you\'ve joined.'),
                                [
                                        ('room_jid', _('JID of the room that will receive the message'), True),
148 149
                                        (Q_('?CLI:message'), _('message contents'), True),
                                        (Q_('?CLI:account'), _('if specified, the message will be sent '
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169
                                                'using this account'), False),
                                ]
                        ],
                'contact_info': [
                                _('Gets detailed info on a contact'),
                                [
                                        ('jid', _('JID of the contact'), True)
                                ]
                        ],
                'account_info': [
                                _('Gets detailed info on a account'),
                                [
                                        ('account', _('Name of the account'), True)
                                ]
                        ],
                'send_file': [
                                _('Sends file to a contact'),
                                [
                                        (_('file'), _('File path'), True),
                                        ('jid', _('JID of the contact'), True),
170
                                        (Q_('?CLI:account'), _('if specified, file will be sent using this '
171 172 173 174 175
                                                'account'), False)
                                ]
                        ],
                'prefs_list': [
                                _('Lists all preferences and their values'),
176
                                []
177 178 179 180 181
                        ],
                'prefs_put': [
                                _('Sets value of \'key\' to \'value\'.'),
                                [
                                        (_('key=value'), _('\'key\' is the name of the preference, '
182
                                                '\'value\' is what to set it to'), True)
183 184 185 186 187 188 189 190 191 192 193
                                ]
                        ],
                'prefs_del': [
                                _('Deletes a preference item'),
                                [
                                        (_('key'), _('name of the preference to be deleted'), True)
                                ]
                        ],
                'prefs_store': [
                                _('Writes the current state of Gajim preferences to the .config '
                                        'file'),
194
                                []
195 196 197 198 199
                        ],
                'remove_contact': [
                                _('Removes contact from roster'),
                                [
                                        ('jid', _('JID of the contact'), True),
200
                                        (Q_('?CLI:account'), _('if specified, contact is taken from the '
201 202 203 204 205 206 207 208
                                                'contact list of this account'), False)

                                ]
                        ],

                'get_status': [
                        _('Returns current status (the global one unless account is specified)'),
                                [
209
                                        (Q_('?CLI:account'), '', False)
210 211 212 213 214 215
                                ]
                        ],

                'get_status_message': [
                        _('Returns current status message (the global one unless account is specified)'),
                                [
216
                                        (Q_('?CLI:account'), '', False)
217 218 219 220 221
                                ]
                        ],

                'get_unread_msgs_number': [
                        _('Returns number of unread messages'),
222
                                []
223
                        ],
224

225 226 227 228
                'send_xml': [
                                _('Sends custom XML'),
                                [
                                        ('xml', _('XML to send'), True),
229 230
                                        ('account', _('Account to which the XML will be sent; '
                                        'if not specified, XML will be sent to all accounts'),
231 232 233 234 235 236 237 238 239 240 241 242
                                                False)
                                ]
                        ],
                'change_avatar': [
                                _('Change the avatar'),
                                [
                                        ('picture', _('Picture to use'), True),
                                        ('account', _('Account in which the avatar will be set; '
                                        'if not specified, the avatar will be set for all accounts'),
                                                False)
                                ]
                        ],
243

244
                'check_gajim_running': [
245 246 247 248 249 250 251 252 253 254 255 256 257
                                _('Check if Gajim is running'),
                                []
                        ],

                }

        self.sbus = None
        if self.argv_len < 2 or sys.argv[1] not in self.commands.keys():
            # no args or bad args
            send_error(self.compose_help())
        self.command = sys.argv[1]
        if self.command == 'help':
            if self.argv_len == 3:
Yann Leboulanger's avatar
Yann Leboulanger committed
258 259
                print(self.help_on_command(sys.argv[2]).encode(
                    PREFERRED_ENCODING))
260
            else:
Yann Leboulanger's avatar
Yann Leboulanger committed
261
                print(self.compose_help().encode(PREFERRED_ENCODING))
262 263
            sys.exit(0)
        if self.command == 'check_gajim_running':
Yann Leboulanger's avatar
Yann Leboulanger committed
264
            print(self.check_gajim_running())
265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
            sys.exit(0)
        self.init_connection()
        self.check_arguments()

        if self.command == 'contact_info':
            if self.argv_len < 3:
                send_error(_('Missing argument "contact_jid"'))

        try:
            res = self.call_remote_method()
        except exceptions.ServiceNotAvailable:
            # At this point an error message has already been displayed
            sys.exit(1)
        else:
            self.print_result(res)

    def print_result(self, res):
        """
        Print retrieved result to the output
        """
        if res is not None:
286 287
            if self.command in ('send_chat_message', 'send_single_message'):
                self.argv_len -= 2
288 289 290 291 292 293 294 295 296 297

                if res is False:
                    if self.argv_len < 4:
                        send_error(_('\'%s\' is not in your roster.\n'
                'Please specify account for sending the message.') % sys.argv[2])
                    else:
                        send_error(_('You have no active account'))
            elif self.command == 'list_accounts':
                if isinstance(res, list):
                    for account in res:
Yann Leboulanger's avatar
Yann Leboulanger committed
298
                        print(account)
299 300
            elif self.command == 'account_info':
                if res:
Yann Leboulanger's avatar
Yann Leboulanger committed
301
                    print(self.print_info(0, res, True))
302 303
            elif self.command == 'list_contacts':
                for account_dict in res:
Yann Leboulanger's avatar
Yann Leboulanger committed
304
                    print(self.print_info(0, account_dict, True))
305 306 307 308
            elif self.command == 'prefs_list':
                pref_keys = sorted(res.keys())
                for pref_key in pref_keys:
                    result = '%s = %s' % (pref_key, res[pref_key])
Yann Leboulanger's avatar
Yann Leboulanger committed
309
                    print(result)
310
            elif self.command == 'contact_info':
Yann Leboulanger's avatar
Yann Leboulanger committed
311
                print(self.print_info(0, res, True))
312
            elif res:
Yann Leboulanger's avatar
Yann Leboulanger committed
313
                print(res)
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332

    def check_gajim_running(self):
        if not self.sbus:
            try:
                self.sbus = dbus.SessionBus()
            except Exception:
                raise exceptions.SessionBusNotPresent

        test = False
        if hasattr(self.sbus, 'name_has_owner'):
            if self.sbus.name_has_owner(SERVICE):
                test = True
        elif dbus.dbus_bindings.bus_name_has_owner(self.sbus.get_connection(),
        SERVICE):
            test = True
        return test

    def init_connection(self):
        """
Alexander Krotov's avatar
Alexander Krotov committed
333
        Create the connection to the session dbus, or exit if it is not possible
334 335 336 337 338 339 340
        """
        try:
            self.sbus = dbus.SessionBus()
        except Exception:
            raise exceptions.SessionBusNotPresent

        if not self.check_gajim_running():
341
        	#Do not translate "gajim-remote"
342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371
            send_error(_('It seems Gajim is not running. So you can\'t use gajim-remote.'))
        obj = self.sbus.get_object(SERVICE, OBJ_PATH)
        interface = dbus.Interface(obj, INTERFACE)

        # get the function asked
        self.method = interface.__getattr__(self.command)

    def make_arguments_row(self, args):
        """
        Return arguments list. Mandatory arguments are enclosed with:
        '<', '>', optional arguments - with '[', ']'
        """
        s = ''
        for arg in args:
            if arg[2]:
                s += ' <' + arg[0] + '>'
            else:
                s += ' [' + arg[0] + ']'
        return s

    def help_on_command(self, command):
        """
        Return help message for a given command
        """
        if command in self.commands:
            command_props = self.commands[command]
            arguments_str = self.make_arguments_row(command_props[1])
            str_ = _('Usage: %(basename)s %(command)s %(arguments)s \n\t %(help)s')\
                    % {'basename': BASENAME, 'command': command,
                    'arguments': arguments_str, 'help': command_props[0]}
372
            if command_props[1]:
373 374 375 376 377 378 379 380 381 382
                str_ += '\n\n' + _('Arguments:') + '\n'
                for argument in command_props[1]:
                    str_ += ' ' + argument[0] + ' - ' + argument[1] + '\n'
            return str_
        send_error(_('%s not found') % command)

    def compose_help(self):
        """
        Print usage, and list available commands
        """
383
        s = _('Usage:\n  %s command [arguments]\n\nCommand is one of:\n') % (
384
            BASENAME)
385 386 387 388 389 390 391 392 393 394
        for command in sorted(self.commands):
            s += '  ' + command
            for arg in self.commands[command][1]:
                if arg[2]:
                    s += ' <' + arg[0] + '>'
                else:
                    s += ' [' + arg[0] + ']'
            s += '\n'
        return s

395
    def print_info(self, level, prop_dict, encode_return=False):
396
        """
Alexander Krotov's avatar
Alexander Krotov committed
397
        Return formatted string from data structure
398 399 400 401 402 403 404 405 406
        """
        if prop_dict is None or not isinstance(prop_dict, (dict, list, tuple)):
            return ''
        ret_str = ''
        if isinstance(prop_dict, (list, tuple)):
            ret_str = ''
            spacing = ' ' * level * 4
            for val in prop_dict:
                if val is None:
407
                    ret_str += '\t'
408
                elif isinstance(val, int):
409
                    ret_str += '\t' + str(val)
Yann Leboulanger's avatar
Yann Leboulanger committed
410
                elif isinstance(val, str):
411
                    ret_str += '\t' + val
412 413 414 415 416 417 418 419 420 421 422 423 424
                elif isinstance(val, (list, tuple)):
                    res = ''
                    for items in val:
                        res += self.print_info(level+1, items)
                    if res != '':
                        ret_str += '\t' + res
                elif isinstance(val, dict):
                    ret_str += self.print_info(level+1, val)
            ret_str = '%s(%s)\n' % (spacing, ret_str[1:])
        elif isinstance(prop_dict, dict):
            for key in prop_dict.keys():
                val = prop_dict[key]
                spacing = ' ' * level * 4
Yann Leboulanger's avatar
Yann Leboulanger committed
425
                if isinstance(val, (int, str)):
426 427 428 429 430 431 432 433 434 435 436 437 438
                    if val is not None:
                        val = val.strip()
                        ret_str += '%s%-10s: %s\n' % (spacing, key, val)
                elif isinstance(val, (list, tuple)):
                    res = ''
                    for items in val:
                        res += self.print_info(level+1, items)
                    if res != '':
                        ret_str += '%s%s: \n%s' % (spacing, key, res)
                elif isinstance(val, dict):
                    res = self.print_info(level+1, val)
                    if res != '':
                        ret_str += '%s%s: \n%s' % (spacing, key, res)
439
        if encode_return:
440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478
            try:
                ret_str = ret_str.encode(PREFERRED_ENCODING)
            except Exception:
                pass
        return ret_str

    def check_arguments(self):
        """
        Make check if all necessary arguments are given
        """
        argv_len = self.argv_len - 2
        args = self.commands[self.command][1]
        if len(args) < argv_len:
            send_error(_('Too many arguments. \n'
                    'Type "%(basename)s help %(command)s" for more info') % {
                    'basename': BASENAME, 'command': self.command})
        if len(args) > argv_len:
            if args[argv_len][2]:
                send_error(_('Argument "%(arg)s" is not specified. \n'
                        'Type "%(basename)s help %(command)s" for more info') %
                        {'arg': args[argv_len][0], 'basename': BASENAME,
                        'command': self.command})
        self.arguments = []
        i = 0
        for arg in sys.argv[2:]:
            i += 1
            if i < len(args):
                self.arguments.append(arg)
            else:
                # it's latest argument with spaces
                self.arguments.append(' '.join(sys.argv[i+1:]))
                break
        # add empty string for missing args
        self.arguments += ['']*(len(args)-i)

    def call_remote_method(self):
        """
        Calls self.method with arguments from sys.argv[2:]
        """
479
        args = [dbus.String(i) for i in self.arguments]
480 481 482 483 484 485
        try:
            res = self.method(*args)
            return res
        except Exception:
            raise exceptions.ServiceNotAvailable
        return None
dkirov's avatar
dkirov committed
486

487 488 489 490 491

def main():
    if os.geteuid() == 0:
        sys.exit("You must not launch gajim as root, it is insecure.")

492
    GajimRemote()
493 494 495 496


if __name__ == '__main__':
    main()