mumo.py

#!/usr/bin/env python3
# -*- coding: utf-8

# Copyright (C) 2010-2013 Stefan Hacker <dd0t@users.sourceforge.net>
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:

# - Redistributions of source code must retain the above copyright notice,
#   this list of conditions and the following disclaimer.
# - Redistributions in binary form must reproduce the above copyright notice,
#   this list of conditions and the following disclaimer in the documentation
#   and/or other materials provided with the distribution.
# - Neither the name of the Mumble Developers nor the names of its
#   contributors may be used to endorse or promote products derived from this
#   software without specific prior written permission.

# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# `AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

import logging
import os
import sys
import tempfile
from logging import (debug,
                     info,
                     warning,
                     error,
                     critical,
                     exception,
                     getLogger)
from optparse import OptionParser
from threading import Timer

import Ice
import IcePy

from config import (Config,
                    commaSeperatedIntegers)
from mumo_manager import MumoManager

#
# --- Default configuration values
#
cfgfile = 'mumo.ini'
default = MumoManager.cfg_default.copy()
default.update({'ice': (('host', str, '127.0.0.1'),
                        ('port', int, 6502),
                        ('slice', str, ''),
                        ('secret', str, ''),
                        ('slicedirs', str, '/usr/share/slice;/usr/share/Ice/slice'),
                        ('watchdog', int, 30),
                        ('callback_host', str, '127.0.0.1'),
                        ('callback_port', int, -1)),

                'iceraw': None,
                'murmur': (('servers', commaSeperatedIntegers, []),),
                'system': (('pidfile', str, 'mumo.pid'),),
                'log': (('level', int, logging.DEBUG),
                        ('file', str, 'mumo.log'))})


def load_slice(slice):
    #
    # --- Loads a given slicefile, used by dynload_slice and fsload_slice
    #    This function works around a number of differences between Ice python
    #    versions and distributions when it comes to slice include directories.
    #
    fallback_slicedirs = ["-I" + sdir for sdir in cfg.ice.slicedirs.split(';')]

    if not hasattr(Ice, "getSliceDir"):
        Ice.loadSlice('-I%s %s' % (" ".join(fallback_slicedirs), slice))
    else:
        slicedir = Ice.getSliceDir()
        if not slicedir:
            slicedirs = fallback_slicedirs
        else:
            slicedirs = ['-I' + slicedir]

        Ice.loadSlice('', slicedirs + [slice])


def dynload_slice(prx):
    #
    # --- Dynamically retrieves the slice file from the target server
    #
    info("Loading slice from server...")
    try:
        # Check IcePy version as this internal function changes between version.
        # In case it breaks with future versions use slice2py and search for
        # "IcePy.Operation('getSlice'," for updates in the generated bindings.
        op = None
        if IcePy.intVersion() < 30500:
            # Old 3.4 signature with 9 parameters
            op = IcePy.Operation('getSlice', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, (), (),
                                 (), IcePy._t_string, ())

        else:
            # New 3.5 signature with 10 parameters.
            op = IcePy.Operation('getSlice', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (),
                                 (), (), ((), IcePy._t_string, False, 0), ())

        slice = op.invoke(prx, ((), None))
        (dynslicefiledesc, dynslicefilepath) = tempfile.mkstemp(suffix='.ice')
        dynslicefile = os.fdopen(dynslicefiledesc, 'w')
        dynslicefile.write(slice)
        dynslicefile.flush()
        debug("Loading slice file %s", dynslicefilepath)
        load_slice(dynslicefilepath)
        dynslicefile.close()
        os.remove(dynslicefilepath)
    except Exception as e:
        error("Retrieving slice from server failed")
        exception(e)
        raise


def fsload_slice(slice):
    #
    # --- Load slice from file system
    #
    debug("Loading slice from filesystem: %s" % slice)
    load_slice(slice)


def do_main_program():
    #
    # --- Moderator implementation
    #    All of this has to go in here so we can correctly daemonize the tool
    #    without loosing the file descriptors opened by the Ice module

    debug('Initializing Ice...')
    initdata = Ice.InitializationData()
    initdata.properties = Ice.createProperties([], initdata.properties)
    for prop, val in cfg.iceraw:
        initdata.properties.setProperty(prop, val)

    initdata.properties.setProperty('Ice.ImplicitContext', 'Shared')
    initdata.properties.setProperty('Ice.Default.EncodingVersion', '1.0')
    initdata.logger = CustomLogger()

    ice = Ice.initialize(initdata)
    prxstr = 'Meta:tcp -h %s -p %d' % (cfg.ice.host, cfg.ice.port)
    prx = ice.stringToProxy(prxstr)

    if not cfg.ice.slice:
        dynload_slice(prx)
    else:
        fsload_slice(cfg.ice.slice)

    # noinspection PyUnresolvedReferences
    try:
        import MumbleServer
    except ModuleNotFoundError:
        # Try to import Mumble <1.5 name `Murmur` instead
        import Murmur as MumbleServer

    class mumoIceApp(Ice.Application):
        def __init__(self, manager):
            Ice.Application.__init__(self)
            self.manager = manager

        def run(self, args):
            self.shutdownOnInterrupt()

            if not self.initializeIceConnection():
                return 1

            if cfg.ice.watchdog > 0:
                self.metaUptime = -1
                self.checkConnection()

            # Serve till we are stopped
            self.communicator().waitForShutdown()
            self.watchdog.cancel()

            if self.interrupted():
                warning('Caught interrupt, shutting down')

            return 0

        def initializeIceConnection(self):
            """
            Establishes the two-way Ice connection and adds MuMo to the
            configured servers
            """
            ice = self.communicator()

            if cfg.ice.secret:
                debug('Using shared ice secret')
                ice.getImplicitContext().put("secret", cfg.ice.secret)
            else:
                warning('Consider using an ice secret to improve security')

            info('Connecting to Ice server (%s:%d)', cfg.ice.host, cfg.ice.port)
            base = ice.stringToProxy(prxstr)
            self.meta = MumbleServer.MetaPrx.uncheckedCast(base)

            if cfg.ice.callback_port > 0:
                cbp = ' -p %d' % cfg.ice.callback_port
            else:
                cbp = ''

            adapter = ice.createObjectAdapterWithEndpoints('Callback.Client',
                                                           'tcp -h %s%s' % (cfg.ice.callback_host, cbp))
            adapter.activate()
            self.adapter = adapter
            self.manager.setClientAdapter(adapter)

            metacbprx = adapter.addWithUUID(metaCallback(self))
            self.metacb = MumbleServer.MetaCallbackPrx.uncheckedCast(metacbprx)

            return self.attachCallbacks()

        def attachCallbacks(self):
            """
            Attaches all callbacks
            """

            # Ice.ConnectionRefusedException
            debug('Attaching callbacks')
            try:
                info('Attaching meta callback')
                self.meta.addCallback(self.metacb)

                for server in self.meta.getBootedServers():
                    sid = server.id()
                    if not cfg.murmur.servers or sid in cfg.murmur.servers:
                        info('Setting callbacks for virtual server %d', sid)
                        servercbprx = self.adapter.addWithUUID(serverCallback(self.manager, server, sid))
                        servercb = MumbleServer.ServerCallbackPrx.uncheckedCast(servercbprx)
                        server.addCallback(servercb)

            except (MumbleServer.InvalidSecretException, Ice.UnknownUserException, Ice.ConnectionRefusedException) as e:
                if isinstance(e, Ice.ConnectionRefusedException):
                    error('Server refused connection')
                elif isinstance(e, MumbleServer.InvalidSecretException) or \
                        isinstance(e, Ice.UnknownUserException) and (
                        e.unknown == 'MumbleServer::InvalidSecretException'):
                    error('Invalid ice secret')
                else:
                    # We do not actually want to handle this one, re-raise it
                    raise e

                self.connected = False
                self.manager.announceDisconnected()
                return False

            self.connected = True
            self.manager.announceConnected(self.meta)
            return True

        def checkConnection(self):
            """
            Tries to retrieve the server uptime to determine wheter the server is
            still responsive or has restarted in the meantime
            """
            # debug('Watchdog run')
            try:
                uptime = self.meta.getUptime()
                if self.metaUptime > 0:
                    # Check if the server didn't restart since we last checked, we assume
                    # since the last time we ran this check the watchdog interval +/- 5s
                    # have passed. This should be replaced by implementing a Keepalive in
                    # Murmur.
                    if not ((uptime - 5) <= (self.metaUptime + cfg.ice.watchdog) <= (uptime + 5)):
                        # Seems like the server restarted, re-attach the callbacks
                        self.attachCallbacks()

                self.metaUptime = uptime
            except Ice.Exception as e:
                error('Connection to server lost, will try to reestablish callbacks in next watchdog run (%ds)',
                      cfg.ice.watchdog)
                debug(str(e))
                self.attachCallbacks()

            # Renew the timer
            self.watchdog = Timer(cfg.ice.watchdog, self.checkConnection)
            self.watchdog.start()

    def checkSecret(func):
        """
        Decorator that checks whether the server transmitted the right secret
        if a secret is supposed to be used.
        """
        if not cfg.ice.secret:
            return func

        def newfunc(*args, **kws):
            if 'current' in kws:
                current = kws["current"]
            else:
                current = args[-1]

            if not current or 'secret' not in current.ctx or current.ctx['secret'] != cfg.ice.secret:
                error('Server transmitted invalid secret. Possible injection attempt.')
                raise MumbleServer.InvalidSecretException()

            return func(*args, **kws)

        return newfunc

    def fortifyIceFu(retval=None, exceptions=(Ice.Exception,)):
        """
        Decorator that catches exceptions,logs them and returns a safe retval
        value. This helps to prevent getting stuck in
        critical code paths. Only exceptions that are instances of classes
        given in the exceptions list are not caught.

        The default is to catch all non-Ice exceptions.
        """

        def newdec(func):
            def newfunc(*args, **kws):
                try:
                    return func(*args, **kws)
                except Exception as e:
                    catch = True
                    for ex in exceptions:
                        if isinstance(e, ex):
                            catch = False
                            break

                    if catch:
                        critical('Unexpected exception caught')
                        exception(e)
                        return retval
                    raise

            return newfunc

        return newdec

    class metaCallback(MumbleServer.MetaCallback):
        def __init__(self, app):
            MumbleServer.MetaCallback.__init__(self)
            self.app = app

        @fortifyIceFu()
        @checkSecret
        def started(self, server, current=None):
            """
            This function is called when a virtual server is started
            and makes sure the callbacks get attached if needed.
            """
            sid = server.id()
            if not cfg.murmur.servers or sid in cfg.murmur.servers:
                info('Setting callbacks for virtual server %d', server.id())
                try:
                    servercbprx = self.app.adapter.addWithUUID(serverCallback(self.app.manager, server, sid))
                    servercb = MumbleServer.ServerCallbackPrx.uncheckedCast(servercbprx)
                    server.addCallback(servercb)

                # Apparently this server was restarted without us noticing
                except (MumbleServer.InvalidSecretException, Ice.UnknownUserException) as e:
                    if hasattr(e, "unknown") and e.unknown != "MumbleServer::InvalidSecretException":
                        # Special handling for Murmur 1.2.2 servers with invalid slice files
                        raise e

                    error('Invalid ice secret')
                    return
            else:
                debug('Virtual server %d got started', sid)

            self.app.manager.announceMeta(sid, "started", server, current)

        @fortifyIceFu()
        @checkSecret
        def stopped(self, server, current=None):
            """
            This function is called when a virtual server is stopped
            """
            if self.app.connected:
                # Only try to output the server id if we think we are still connected to prevent
                # flooding of our thread pool
                try:
                    sid = server.id()
                    if not cfg.murmur.servers or sid in cfg.murmur.servers:
                        info('Watched virtual server %d got stopped', sid)
                    else:
                        debug('Virtual server %d got stopped', sid)
                    self.app.manager.announceMeta(sid, "stopped", server, current)
                    return
                except Ice.ConnectionRefusedException:
                    self.app.connected = False
                    self.app.manager.announceDisconnected()

            debug('Server shutdown stopped a virtual server')

    def forwardServer(fu):
        def new_fu(self, *args, **kwargs):
            self.manager.announceServer(self.sid, fu.__name__, self.server, *args, **kwargs)

        return new_fu

    class serverCallback(MumbleServer.ServerCallback):
        def __init__(self, manager, server, sid):
            MumbleServer.ServerCallback.__init__(self)
            self.manager = manager
            self.sid = sid
            self.server = server

            # Hack to prevent every call to server.id() from the client callbacks
            # from having to go over Ice
            def id_replacement():
                return self.sid

            server.id = id_replacement

        @checkSecret
        @forwardServer
        def userStateChanged(self, u, current=None): pass

        @checkSecret
        @forwardServer
        def userDisconnected(self, u, current=None): pass

        @checkSecret
        @forwardServer
        def userConnected(self, u, current=None): pass

        @checkSecret
        @forwardServer
        def channelCreated(self, c, current=None): pass

        @checkSecret
        @forwardServer
        def channelRemoved(self, c, current=None): pass

        @checkSecret
        @forwardServer
        def channelStateChanged(self, c, current=None): pass

        @checkSecret
        @forwardServer
        def userTextMessage(self, u, m, current=None): pass

    class customContextCallback(MumbleServer.ServerContextCallback):
        def __init__(self, contextActionCallback, *ctx):
            MumbleServer.ServerContextCallback.__init__(self)
            self.cb = contextActionCallback
            self.ctx = ctx

        @checkSecret
        def contextAction(self, *args, **argv):
            # (action, user, target_session, target_chanid, current=None)
            self.cb(*(self.ctx + args), **argv)

    #
    # --- Start of moderator
    #
    info('Starting mumble moderator')
    debug('Initializing manager')
    manager = MumoManager(MumbleServer, customContextCallback)
    manager.start()
    manager.loadModules()
    manager.startModules()

    debug("Initializing mumoIceApp")
    app = mumoIceApp(manager)
    state = app.main(sys.argv[:1], initData=initdata)

    manager.stopModules()
    manager.stop()
    info('Shutdown complete')
    return state


class CustomLogger(Ice.Logger):
    """
    Logger implementation to pipe Ice log messages into
    our own log
    """

    def __init__(self):
        Ice.Logger.__init__(self)
        self._log = getLogger('Ice')

    def _print(self, message):
        self._log.info(message)

    def trace(self, category, message):
        self._log.debug('Trace %s: %s', category, message)

    def warning(self, message):
        self._log.warning(message)

    def error(self, message):
        self._log.error(message)


#
# --- Start of program
#
if __name__ == '__main__':
    # Parse commandline options
    parser = OptionParser()
    parser.add_option('-i', '--ini',
                      help='load configuration from INI', default=cfgfile)
    parser.add_option('-v', '--verbose', action='store_true', dest='verbose',
                      help='verbose output [default]', default=True)
    parser.add_option('-q', '--quiet', action='store_false', dest='verbose',
                      help='only error output')
    parser.add_option('-d', '--daemon', action='store_true', dest='force_daemon',
                      help='run as daemon', default=False)
    parser.add_option('-a', '--app', action='store_true', dest='force_app',
                      help='do not run as daemon', default=False)
    (option, args) = parser.parse_args()

    if option.force_daemon and option.force_app:
        parser.print_help()
        sys.exit(1)

    # Load configuration
    try:
        cfg = Config(option.ini, default)
    except Exception as e:
        print('Fatal error, could not load config file from "%s"' % cfgfile, file=sys.stderr)
        print(e, file=sys.stderr)
        sys.exit(1)

    # Initialise logger
    if cfg.log.file:
        try:
            logfile = open(cfg.log.file, 'a')
        except IOError as e:
            # print>>sys.stderr, str(e)
            print('Fatal error, could not open logfile "%s"' % cfg.log.file, file=sys.stderr)
            sys.exit(1)
    else:
        logfile = logging.sys.stdout

    if option.verbose:
        level = cfg.log.level
    else:
        level = logging.ERROR

    logging.basicConfig(level=level,
                        format='%(asctime)s %(levelname)s %(name)s %(message)s',
                        stream=logfile)

    info("Using config file %s", option.ini)
    info("Logging level %d into %s", level, cfg.log.file)

    # As the default try to run as daemon. Silently degrade to running as a normal application if this fails
    # unless the user explicitly defined what he expected with the -a / -d parameter.
    try:
        if option.force_app:
            raise ImportError  # Pretend that we couldn't import the daemon lib
        import daemon

        try:
            from daemon.pidfile import TimeoutPIDLockFile
        except ImportError:  # Version < 1.6
            from daemon.pidlockfile import TimeoutPIDLockFile
    except ImportError:
        if option.force_daemon:
            print('Fatal error, could not daemonize process due to missing "daemon" library, '
                  'please install the missing dependency and restart the application', file=sys.stderr)
            sys.exit(1)
        ret = do_main_program()
    else:
        pidfile = TimeoutPIDLockFile(cfg.system.pidfile, 5)
        if pidfile.is_locked():
            try:
                os.kill(pidfile.read_pid(), 0)
                print('Mumo already running as %s' % pidfile.read_pid(), file=sys.stderr)
                sys.exit(1)
            except OSError:
                print('Found stale mumo pid file but no process, breaking lock', file=sys.stderr)
                pidfile.break_lock()

        context = daemon.DaemonContext(working_directory=sys.path[0],
                                       stderr=logfile,
                                       pidfile=pidfile)
        context.__enter__()
        try:
            ret = do_main_program()
        finally:
            context.__exit__(None, None, None)
    sys.exit(ret)