app.py 18 KB
Newer Older
roidelapluie's avatar
roidelapluie committed
1
# -*- coding:utf-8 -*-
2
## gajim/common/app.py
Yann Leboulanger's avatar
Yann Leboulanger committed
3
##
Dicson's avatar
Dicson committed
4
## Copyright (C) 2003-2014 Yann Leboulanger <asterix AT lagaule.org>
roidelapluie's avatar
roidelapluie committed
5 6 7
## Copyright (C) 2005-2006 Dimitur Kirov <dkirov AT gmail.com>
##                         Travis Shirk <travis AT pobox.com>
##                         Nikos Kouremenos <kourem AT gmail.com>
roidelapluie's avatar
roidelapluie committed
8
## Copyright (C) 2006 Junglecow J <junglecow AT gmail.com>
roidelapluie's avatar
roidelapluie committed
9 10 11 12 13
##                    Stefan Bethge <stefan AT lanpartei.de>
## Copyright (C) 2006-2008 Jean-Marie Traissard <jim AT lapin.org>
## Copyright (C) 2007-2008 Brendan Taylor <whateley AT gmail.com>
##                         Stephan Erb <steve-e AT h3c.de>
## Copyright (C) 2008 Jonathan Schleifer <js-gajim AT webkeks.org>
14
## Copyright (C) 2018 Philipp Hörist <philipp @ hoerist.com>
Yann Leboulanger's avatar
Yann Leboulanger committed
15
##
Yann Leboulanger's avatar
Yann Leboulanger committed
16 17 18
## This file is part of Gajim.
##
## Gajim is free software; you can redistribute it and/or modify
Yann Leboulanger's avatar
Yann Leboulanger committed
19
## it under the terms of the GNU General Public License as published
Yann Leboulanger's avatar
Yann Leboulanger committed
20
## by the Free Software Foundation; version 3 only.
Yann Leboulanger's avatar
Yann Leboulanger committed
21
##
Yann Leboulanger's avatar
Yann Leboulanger committed
22
## Gajim is distributed in the hope that it will be useful,
Yann Leboulanger's avatar
Yann Leboulanger committed
23
## but WITHOUT ANY WARRANTY; without even the implied warranty of
roidelapluie's avatar
roidelapluie committed
24
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
Yann Leboulanger's avatar
Yann Leboulanger committed
25 26
## GNU General Public License for more details.
##
Yann Leboulanger's avatar
Yann Leboulanger committed
27
## You should have received a copy of the GNU General Public License
roidelapluie's avatar
roidelapluie committed
28
## along with Gajim. If not, see <http://www.gnu.org/licenses/>.
Yann Leboulanger's avatar
Yann Leboulanger committed
29
##
Yann Leboulanger's avatar
Yann Leboulanger committed
30

31
import os
32
import sys
Yann Leboulanger's avatar
Yann Leboulanger committed
33
import logging
34
import uuid
35
from distutils.version import LooseVersion as V
36
from collections import namedtuple
37

38
import nbxmpp
Philipp Hörist's avatar
Philipp Hörist committed
39 40

from gajim.common import config as c_config
41
from gajim.common import configpaths
André's avatar
André committed
42
from gajim.common import ged as ged_module
43 44
from gajim.common.contacts import LegacyContactsAPI
from gajim.common.events import Events
45

46
interface = None # The actual interface (the gtk one for the moment)
Yann Leboulanger's avatar
Yann Leboulanger committed
47
thread_interface = lambda *args: None # Interface to run a thread and then a callback
Philipp Hörist's avatar
Philipp Hörist committed
48
config = c_config.Config()
49
version = config.get('version')
dkirov's avatar
dkirov committed
50
connections = {} # 'account name': 'account (connection.Connection) instance'
Philipp Hörist's avatar
Philipp Hörist committed
51
avatar_cache = {}
52
ipython_window = None
53
app = None  # Gtk.Application
54

55
ged = ged_module.GlobalEventsDispatcher() # Global Events Dispatcher
56 57
nec = None # Network Events Controller
plugin_manager = None # Plugins Manager
58

59
logger = None
nkour's avatar
nkour committed
60

Philipp Hörist's avatar
Philipp Hörist committed
61 62
# For backwards compatibility needed
# some plugins use that
63
gajimpaths = configpaths.gajimpaths
nkour's avatar
nkour committed
64

nkour's avatar
nkour committed
65

66 67
RecentGroupchat = namedtuple('RecentGroupchat', ['room', 'server', 'nickname'])

68 69
os_info = None # used to cache os information

sb's avatar
sb committed
70 71
transport_type = {} # list the type of transport

72
last_message_time = {} # list of time of the latest incomming message
Dicson's avatar
Dicson committed
73 74
                       # {acct1: {jid1: time1, jid2: time2}, }
encrypted_chats = {}   # list of encrypted chats {acct1: [jid1, jid2], ..}
75

76
contacts = LegacyContactsAPI()
Dicson's avatar
Dicson committed
77 78 79 80 81 82 83 84 85
gc_connected = {}    # tell if we are connected to the room or not
                     # {acct: {room_jid: True}}
gc_passwords = {}    # list of the pass required to enter a room
                     # {room_jid: password}
automatic_rooms = {} # list of rooms that must be automaticaly configured
                     # and for which we have a list of invities
                     #{account: {room_jid: {'invities': []}}}
new_room_nick = None # if it's != None, use this nick instead of asking for
                     # a new nickname when there is a conflict.
86

87 88 89
groups = {} # list of groups
newly_added = {} # list of contacts that has just signed in
to_be_removed = {} # list of contacts that has just signed out
90

sb's avatar
sb committed
91 92
events = Events()

93
notification = None
94

95
nicks = {} # list of our nick names in each account
96
# should we block 'contact signed in' notifications for this account?
97 98
# this is only for the first 30 seconds after we change our show
# to something else than offline
sb's avatar
sb committed
99 100
# can also contain account/transport_jid to block notifications for contacts
# from this transport
101
block_signed_in_notifications = {}
102
con_types = {} # type of each connection (ssl, tls, tcp, ...)
103 104 105 106 107 108

sleeper_state = {} # whether we pass auto away / xa or not
#'off': don't use sleeper for this account
#'online': online and use sleeper
#'autoaway': autoaway and use sleeper
#'autoxa': autoxa and use sleeper
109
status_before_autoaway = {}
110

111 112 113 114
# jid of transport contacts for which we need to ask avatar when transport will
# be online
transport_avatar = {} # {transport_jid: [jid_list]}

Piotr Gaczkowski's avatar
Piotr Gaczkowski committed
115 116
# Is Gnome configured to activate on single click ?
single_click = False
nkour's avatar
nkour committed
117
SHOW_LIST = ['offline', 'connecting', 'online', 'chat', 'away', 'xa', 'dnd',
118
        'invisible', 'error']
119

sb's avatar
sb committed
120
# zeroconf account name
121
ZEROCONF_ACC_NAME = 'Local'
sb's avatar
sb committed
122

123
# These will be set in app.gui_interface.
124 125 126
idlequeue = None
socks5queue = None

127
gajim_identity = {'type': 'pc', 'category': 'client', 'name': 'Gajim'}
128 129 130 131 132 133 134
gajim_common_features = [nbxmpp.NS_BYTESTREAM, nbxmpp.NS_SI, nbxmpp.NS_FILE,
    nbxmpp.NS_MUC, nbxmpp.NS_MUC_USER, nbxmpp.NS_MUC_ADMIN, nbxmpp.NS_MUC_OWNER,
    nbxmpp.NS_MUC_CONFIG, nbxmpp.NS_COMMANDS, nbxmpp.NS_DISCO_INFO, 'ipv6',
    'jabber:iq:gateway', nbxmpp.NS_LAST, nbxmpp.NS_PRIVACY, nbxmpp.NS_PRIVATE,
    nbxmpp.NS_REGISTER, nbxmpp.NS_VERSION, nbxmpp.NS_DATA, nbxmpp.NS_ENCRYPTED,
    'msglog', 'sslc2s', 'stringprep', nbxmpp.NS_PING, nbxmpp.NS_TIME_REVISED,
    nbxmpp.NS_SSN, nbxmpp.NS_MOOD, nbxmpp.NS_ACTIVITY, nbxmpp.NS_NICK,
135
    nbxmpp.NS_ROSTERX, nbxmpp.NS_SECLABEL, nbxmpp.NS_HASHES_2,
136
    nbxmpp.NS_HASHES_MD5, nbxmpp.NS_HASHES_SHA1, nbxmpp.NS_HASHES_SHA256,
Weblate's avatar
Weblate committed
137
    nbxmpp.NS_HASHES_SHA512, nbxmpp.NS_CONFERENCE, nbxmpp.NS_CORRECT,
Philipp Hörist's avatar
Philipp Hörist committed
138
    nbxmpp.NS_EME, 'urn:xmpp:avatar:metadata+notify']
139

140 141 142 143 144
# Optional features gajim supports per account
gajim_optional_features = {}

# Capabilities hash per account
caps_hash = {}
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 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
_dependencies = {
    'AVAHI': False,
    'PYBONJOUR': False,
    'PYCRYPTO': False,
    'PYGPG': False,
    'GPG_BINARY': False,
    'FARSTREAM': False,
    'GEOCLUE': False,
    'UPNP': False,
    'PYCURL': False,
    'GSPELL': False,
    'IDLE': False,
    }


def is_installed(dependency):
    if dependency == 'GPG':
        # Alias for checking python-gnupg and the GPG binary
        return _dependencies['PYGPG'] and _dependencies['GPG_BINARY']
    if dependency == 'ZEROCONF':
        # Alias for checking zeroconf libs
        return _dependencies['AVAHI'] or _dependencies['PYBONJOUR']
    return _dependencies[dependency]

def disable_dependency(dependency):
    _dependencies[dependency] = False

def detect_dependencies():
    import gi

    # ZEROCONF
    try:
        if os.name == 'nt':
            import pybonjour
            _dependencies['PYBONJOUR'] = True
        else:
            import avahi
            _dependencies['AVAHI'] = True
    except Exception:
        pass

    # PYCRYPTO
    try:
        import Crypto
        _dependencies['PYCRYPTO'] = True
    except ImportError:
        pass

    # python-gnupg
    try:
        import gnupg
        '''
        We need https://pypi.python.org/pypi/python-gnupg
        but https://pypi.python.org/pypi/gnupg shares the same package name.
        It cannot be used as a drop-in replacement.
        We test with a version check if python-gnupg is installed as it is
        on a much lower version number than gnupg
        Also we need at least python-gnupg 0.3.8
        '''
        v_gnupg = gnupg.__version__
        if V(v_gnupg) < V('0.3.8') or V(v_gnupg) > V('1.0.0'):
            log('gajim').info('Gajim needs python-gnupg >= 0.3.8')
            raise ImportError
        _dependencies['PYGPG'] = True
    except ImportError:
        pass

    # GPG BINARY
    import subprocess

    def test_gpg(binary='gpg'):
        if os.name == 'nt':
            gpg_cmd = binary + ' -h >nul 2>&1'
        else:
            gpg_cmd = binary + ' -h >/dev/null 2>&1'
        if subprocess.call(gpg_cmd, shell=True):
            return False
        return True

    if test_gpg(binary='gpg2'):
        _dependencies['GPG_BINARY'] = 'gpg2'
    elif test_gpg(binary='gpg'):
        _dependencies['GPG_BINARY'] = 'gpg'

    # FARSTREAM
    try:
        if os.name == 'nt':
            os.environ['FS_PLUGIN_PATH'] = 'gtk\\lib\\farstream-0.1'
            os.environ['GST_PLUGIN_PATH'] = 'gtk\\lib\\gstreamer-0.10'
        gi.require_version('Farstream', '0.2')
        from gi.repository import Farstream
        gi.require_version('Gst', '1.0')
        from gi.repository import Gst
        try:
            Gst.init(None)
            conference = Gst.ElementFactory.make('fsrtpconference', None)
            session = conference.new_session(Farstream.MediaType.AUDIO)
        except Exception as error:
            log('gajim').info(error)
        _dependencies['FARSTREAM'] = True
    except (ImportError, ValueError):
        pass

    # GEOCLUE
    try:
        gi.require_version('Geoclue', '2.0')
        from gi.repository import Geoclue
        _dependencies['GEOCLUE'] = True
    except (ImportError, ValueError):
        pass

    # UPNP
    try:
        gi.require_version('GUPnPIgd', '1.0')
        from gi.repository import GUPnPIgd
        gupnp_igd = GUPnPIgd.SimpleIgd()
        _dependencies['UPNP'] = True
    except ValueError:
        pass

    # PYCURL
    try:
        import pycurl
        _dependencies['PYCURL'] = True
    except ImportError:
        pass

    # IDLE
    try:
        from gajim.common import sleepy
        if sleepy.SUPPORTED:
            _dependencies['IDLE'] = True
    except Exception:
        pass

    # GSPELL
    try:
        gi.require_version('Gspell', '1')
        from gi.repository import Gspell
        langs = Gspell.language_get_available()
        for lang in langs:
            log('gajim').info('%s (%s) dict available',
                              lang.get_name(), lang.get_code())
        if langs:
            _dependencies['GSPELL'] = True
    except (ImportError, ValueError):
        pass

    # Print results
    for dep, val in _dependencies.items():
        log('gajim').info('%-13s %s', dep, val)

def get_gpg_binary():
    return _dependencies['GPG_BINARY']

301
def get_an_id():
302
    return str(uuid.uuid4())
303

304
def get_nick_from_jid(jid):
305 306
    pos = jid.find('@')
    return jid[:pos]
307

308
def get_server_from_jid(jid):
309 310
    pos = jid.find('@') + 1 # after @
    return jid[pos:]
311

sb's avatar
sb committed
312
def get_name_and_server_from_jid(jid):
313 314 315
    name = get_nick_from_jid(jid)
    server = get_server_from_jid(jid)
    return name, server
316

317
def get_room_and_nick_from_fjid(jid):
318 319 320 321 322 323 324
    # fake jid is the jid for a contact in a room
    # gaim@conference.jabber.no/nick/nick-continued
    # return ('gaim@conference.jabber.no', 'nick/nick-continued')
    l = jid.split('/', 1)
    if len(l) == 1: # No nick
        l.append('')
    return l
325 326

def get_real_jid_from_fjid(account, fjid):
327 328 329 330 331 332 333 334 335 336 337 338 339 340 341
    """
    Return real jid or returns None, if we don't know the real jid
    """
    room_jid, nick = get_room_and_nick_from_fjid(fjid)
    if not nick: # It's not a fake_jid, it is a real jid
        return fjid # we return the real jid
    real_jid = fjid
    if interface.msg_win_mgr.get_gc_control(room_jid, account):
        # It's a pm, so if we have real jid it's in contact.jid
        gc_contact = contacts.get_gc_contact(account, room_jid, nick)
        if not gc_contact:
            return
        # gc_contact.jid is None when it's not a real jid (we don't know real jid)
        real_jid = gc_contact.jid
    return real_jid
342

343
def get_room_from_fjid(jid):
344
    return get_room_and_nick_from_fjid(jid)[0]
345

346
def get_contact_name_from_jid(account, jid):
347 348
    c = contacts.get_first_contact_from_jid(account, jid)
    return c.name
349

nkour's avatar
nkour committed
350
def get_jid_without_resource(jid):
351
    return jid.split('/')[0]
352 353

def construct_fjid(room_jid, nick):
354 355 356
    # fake jid is the jid for a contact in a room
    # gaim@conference.jabber.org/nick
    return room_jid + '/' + nick
357

358
def get_resource_from_jid(jid):
359 360 361 362 363
    jids = jid.split('/', 1)
    if len(jids) > 1:
        return jids[1] # abc@doremi.org/res/res-continued
    else:
        return ''
364

365
def get_number_of_accounts():
366 367 368 369
    """
    Return the number of ALL accounts
    """
    return len(connections.keys())
nkour's avatar
nkour committed
370

371
def get_number_of_connected_accounts(accounts_list = None):
372 373 374 375 376 377 378 379 380 381 382 383 384
    """
    Returns the number of CONNECTED accounts. Uou can optionally pass an
    accounts_list and if you do those will be checked, else all will be checked
    """
    connected_accounts = 0
    if accounts_list is None:
        accounts = connections.keys()
    else:
        accounts = accounts_list
    for account in accounts:
        if account_is_connected(account):
            connected_accounts = connected_accounts + 1
    return connected_accounts
385

386 387 388 389 390 391 392 393 394 395
def get_connected_accounts():
    """
    Returns a list of CONNECTED accounts
    """
    account_list = []
    for account in connections:
        if account_is_connected(account):
            account_list.append(account)
    return account_list

dkirov's avatar
dkirov committed
396
def account_is_connected(account):
397 398 399 400 401 402
    if account not in connections:
        return False
    if connections[account].connected > 1: # 0 is offline, 1 is connecting
        return True
    else:
        return False
dkirov's avatar
dkirov committed
403 404

def account_is_disconnected(account):
405
    return not account_is_connected(account)
dkirov's avatar
dkirov committed
406

407
def zeroconf_is_connected():
408 409
    return account_is_connected(ZEROCONF_ACC_NAME) and \
            config.get_per('accounts', ZEROCONF_ACC_NAME, 'is_zeroconf')
410

411 412 413 414 415
def in_groupchat(account, room_jid):
    if room_jid not in gc_connected[account]:
        return False
    return gc_connected[account][room_jid]

dkirov's avatar
dkirov committed
416
def get_number_of_securely_connected_accounts():
417 418 419 420 421 422 423 424
    """
    Return the number of the accounts that are SSL/TLS connected
    """
    num_of_secured = 0
    for account in connections.keys():
        if account_is_securely_connected(account):
            num_of_secured += 1
    return num_of_secured
dkirov's avatar
dkirov committed
425 426

def account_is_securely_connected(account):
427 428 429 430 431
    if account_is_connected(account) and \
    account in con_types and con_types[account] in ('tls', 'ssl'):
        return True
    else:
        return False
dkirov's avatar
dkirov committed
432

nkour's avatar
typo  
nkour committed
433
def get_transport_name_from_jid(jid, use_config_setting = True):
434 435 436 437 438 439 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
    """
    Returns 'aim', 'gg', 'irc' etc

    If JID is not from transport returns None.
    """
    #FIXME: jid can be None! one TB I saw had this problem:
    # in the code block # it is a groupchat presence in handle_event_notify
    # jid was None. Yann why?
    if not jid or (use_config_setting and not config.get('use_transports_iconsets')):
        return

    host = get_server_from_jid(jid)
    if host in transport_type:
        return transport_type[host]

    # host is now f.e. icq.foo.org or just icq (sometimes on hacky transports)
    host_splitted = host.split('.')
    if len(host_splitted) != 0:
        # now we support both 'icq.' and 'icq' but not icqsucks.org
        host = host_splitted[0]

    if host in ('aim', 'irc', 'icq', 'msn', 'sms', 'tlen', 'weather', 'yahoo',
    'mrim', 'facebook'):
        return host
    elif host == 'gg':
        return 'gadu-gadu'
    elif host == 'jit':
        return 'icq'
    elif host == 'facebook':
        return 'facebook'
    else:
        return None
nkour's avatar
nkour committed
466 467

def jid_is_transport(jid):
468 469 470 471
    # if not '@' or '@' starts the jid then it is transport
    if jid.find('@') <= 0:
        return True
    return False
472

473
def get_jid_from_account(account_name):
474 475 476 477 478 479 480
    """
    Return the jid we use in the given account
    """
    name = config.get_per('accounts', account_name, 'name')
    hostname = config.get_per('accounts', account_name, 'hostname')
    jid = name + '@' + hostname
    return jid
481

nkour's avatar
nkour committed
482
def get_our_jids():
483 484 485 486 487 488 489
    """
    Returns a list of the jids we use in our accounts
    """
    our_jids = list()
    for account in contacts.get_accounts():
        our_jids.append(get_jid_from_account(account))
    return our_jids
nkour's avatar
nkour committed
490

491
def get_hostname_from_account(account_name, use_srv = False):
492 493 494 495 496 497 498 499
    """
    Returns hostname (if custom hostname is used, that is returned)
    """
    if use_srv and connections[account_name].connected_hostname:
        return connections[account_name].connected_hostname
    if config.get_per('accounts', account_name, 'use_custom_host'):
        return config.get_per('accounts', account_name, 'custom_host')
    return config.get_per('accounts', account_name, 'hostname')
500

501
def get_notification_image_prefix(jid):
502 503 504 505 506 507 508 509 510
    """
    Returns the prefix for the notification images
    """
    transport_name = get_transport_name_from_jid(jid)
    if transport_name in ('aim', 'icq', 'msn', 'yahoo', 'facebook'):
        prefix = transport_name
    else:
        prefix = 'jabber'
    return prefix
511

512
def get_name_from_jid(account, jid):
513 514 515 516 517 518 519 520 521
    """
    Return from JID's shown name and if no contact returns jids
    """
    contact = contacts.get_first_contact_from_jid(account, jid)
    if contact:
        actor = contact.get_shown_name()
    else:
        actor = jid
    return actor
dkirov's avatar
dkirov committed
522

523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550
def get_muc_domain(account):
    return connections[account].muc_jid.get('jabber', None)

def get_recent_groupchats(account):
    recent_groupchats = config.get_per(
        'accounts', account, 'recent_groupchats').split()

    recent_list = []
    for groupchat in recent_groupchats:
        jid = nbxmpp.JID(groupchat)
        recent = RecentGroupchat(
            jid.getNode(), jid.getDomain(), jid.getResource())
        recent_list.append(recent)
    return recent_list

def add_recent_groupchat(account, room_jid, nickname):
    recent = config.get_per(
        'accounts', account, 'recent_groupchats').split()
    full_jid = room_jid + '/' + nickname
    if full_jid in recent:
        recent.remove(full_jid)
    recent.insert(0, full_jid)
    if len(recent) > 10:
        recent = recent[0:9]
    config_value = ' '.join(recent)
    config.set_per(
        'accounts', account, 'recent_groupchats', config_value)

dkirov's avatar
dkirov committed
551
def get_priority(account, show):
552 553 554 555 556 557 558 559
    """
    Return the priority an account must have
    """
    if not show:
        show = 'online'

    if show in ('online', 'chat', 'away', 'xa', 'dnd', 'invisible') and \
    config.get_per('accounts', account, 'adjust_priority_with_status'):
560 561 562 563 564 565 566 567
        prio = config.get_per('accounts', account, 'autopriority_' + show)
    else:
        prio = config.get_per('accounts', account, 'priority')
    if prio < -128:
        prio = -128
    elif prio > 127:
        prio = 127
    return prio
568 569

def log(domain):
570 571 572
    if domain != 'gajim':
        domain = 'gajim.%s' % domain
    return logging.getLogger(domain)
573 574 575 576 577 578 579

def prefers_app_menu():
    if sys.platform == 'darwin':
        return True
    if sys.platform == 'win32':
        return False
    return app.prefers_app_menu()