sugar-toolkit-gtk3/sugar/presence/presenceservice.py

"""UI class to access system-level presence object"""
# Copyright (C) 2007, Red Hat, Inc.
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2 of the License, or (at your option) any later version.
#
# This library 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
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the
# Free Software Foundation, Inc., 59 Temple Place - Suite 330,
# Boston, MA 02111-1307, USA.

import dbus, dbus.glib, gobject
import logging

# XXX use absolute imports
#   from sugar.presence import buddy, activity
# this *kind* of relative import is deprecated
# with an explicit relative import slated to be 
# introduced (available in Python 2.5 with a __future__
# import), that would read as:
#   from . import buddy, activity 
# see PEP: http://docs.python.org/whatsnew/pep-328.html
import buddy, activity


DBUS_SERVICE = "org.laptop.Sugar.Presence"
DBUS_INTERFACE = "org.laptop.Sugar.Presence"
DBUS_PATH = "/org/laptop/Sugar/Presence"


class PresenceService(gobject.GObject):
    """UI-side interface to the dbus presence service 
    
    This class provides UI programmers with simplified access
    to the dbus service of the same name.  It allows for observing
    various events from the presence service as GObject events,
    as well as some basic introspection queries.
    """
    __gsignals__ = {
        'buddy-appeared': (gobject.SIGNAL_RUN_FIRST, gobject.TYPE_NONE,
                        ([gobject.TYPE_PYOBJECT])),
        'buddy-disappeared': (gobject.SIGNAL_RUN_FIRST, gobject.TYPE_NONE,
                        ([gobject.TYPE_PYOBJECT])),
        'activity-invitation': (gobject.SIGNAL_RUN_FIRST, gobject.TYPE_NONE,
                        ([gobject.TYPE_PYOBJECT])),
        'private-invitation': (gobject.SIGNAL_RUN_FIRST, gobject.TYPE_NONE,
                        ([gobject.TYPE_PYOBJECT, gobject.TYPE_PYOBJECT,
                          gobject.TYPE_PYOBJECT])),
        'activity-appeared': (gobject.SIGNAL_RUN_FIRST, gobject.TYPE_NONE,
                        ([gobject.TYPE_PYOBJECT])),
        'activity-disappeared': (gobject.SIGNAL_RUN_FIRST, gobject.TYPE_NONE,
                        ([gobject.TYPE_PYOBJECT])),
        'activity-shared': (gobject.SIGNAL_RUN_FIRST, gobject.TYPE_NONE,
                        ([gobject.TYPE_PYOBJECT, gobject.TYPE_PYOBJECT,
                          gobject.TYPE_PYOBJECT]))
    }

    _PS_BUDDY_OP = DBUS_PATH + "/Buddies/"
    _PS_ACTIVITY_OP = DBUS_PATH + "/Activities/"
    

    def __init__(self, allow_offline_iface=True):
        """Initialise the service and attempt to connect to events
        """
        gobject.GObject.__init__(self)
        self._objcache = {}
        # attempt to load the interface to the service...
        self._allow_offline_iface = allow_offline_iface
        self._get_ps()
    
    _bus_ = None 
    def _get_bus(self):
        """Retrieve dbus session-bus or create new"""
        if not self._bus_:
            self._bus_ = dbus.SessionBus()
        return self._bus_
    _bus = property( 
        _get_bus, None, None, 
        """DBUS SessionBus object for user-local communications""" 
    )
    _ps_ = None
    def _get_ps(self):
        """Retrieve dbus interface to PresenceService 
        
        Also registers for updates from various dbus events on the 
        interface.
        
        If unable to retrieve the interface, we will temporarily 
        return an _OfflineInterface object to allow the calling 
        code to continue functioning as though it had accessed a 
        real presence service.
        
        If successful, caches the presence service interface 
        for use by other methods and returns that interface
        """
        if not self._ps_:
            try:
                ps = dbus.Interface(
                    self._bus.get_object(DBUS_SERVICE,DBUS_PATH), 
                    DBUS_INTERFACE
                )
            except dbus.exceptions.DBusException, err:
                logging.error(
                    """Failure retrieving %r interface from the D-BUS service %r %r: %s""",
                    DBUS_INTERFACE, DBUS_SERVICE, DBUS_PATH, err
                )
                if self._allow_offline_iface:
                    return _OfflineInterface()
                raise RuntimeError("Failed to connect to the presence service.")
            else:
                self._ps_ = ps 
                ps.connect_to_signal('BuddyAppeared', self._buddy_appeared_cb)
                ps.connect_to_signal('BuddyDisappeared', self._buddy_disappeared_cb)
                ps.connect_to_signal('ActivityAppeared', self._activity_appeared_cb)
                ps.connect_to_signal('ActivityDisappeared', self._activity_disappeared_cb)
                ps.connect_to_signal('ActivityInvitation', self._activity_invitation_cb)
                ps.connect_to_signal('PrivateInvitation', self._private_invitation_cb)
        return self._ps_
        
    _ps = property(
        _get_ps, None, None,
        """DBUS interface to the PresenceService (services/presence/presenceservice)"""
    )

    def _new_object(self, object_path):
        """Turn new object path into (cached) Buddy/Activity instance
        
        object_path -- full dbus path of the new object, must be
            prefixed with either of _PS_BUDDY_OP or _PS_ACTIVITY_OP
        
        Note that this method is called throughout the class whenever
        the representation of the object is required, it is not only 
        called when the object is first discovered.  The point is to only have
        _one_ Python object for any D-Bus object represented by an object path,
        effectively wrapping the D-Bus object in a single Python GObject.
        
        returns presence Buddy or Activity representation
        """
        obj = None
        try:
            obj = self._objcache[object_path]
        except KeyError:
            if object_path.startswith(self._PS_BUDDY_OP):
                obj = buddy.Buddy(self._bus, self._new_object,
                        self._del_object, object_path)
            elif object_path.startswith(self._PS_ACTIVITY_OP):
                obj = activity.Activity(self._bus, self._new_object,
                        self._del_object, object_path)
            else:
                raise RuntimeError("Unknown object type")
            self._objcache[object_path] = obj
        return obj

    def _del_object(self, object_path):
        """Fully remove an object from the object cache when it's no longer needed.
        """
        del self._objcache[object_path]

    def _emit_buddy_appeared_signal(self, object_path):
        """Emit GObject event with presence.buddy.Buddy object"""
        self.emit('buddy-appeared', self._new_object(object_path))
        return False

    def _buddy_appeared_cb(self, op):
        """Callback for dbus event (forwards to method to emit GObject event)"""
        gobject.idle_add(self._emit_buddy_appeared_signal, op)

    def _emit_buddy_disappeared_signal(self, object_path):
        """Emit GObject event with presence.buddy.Buddy object"""
        self.emit('buddy-disappeared', self._new_object(object_path))
        return False

    def _buddy_disappeared_cb(self, object_path):
        """Callback for dbus event (forwards to method to emit GObject event)"""
        gobject.idle_add(self._emit_buddy_disappeared_signal, object_path)

    def _emit_activity_invitation_signal(self, object_path):
        """Emit GObject event with presence.activity.Activity object"""
        self.emit('activity-invitation', self._new_object(object_path))
        return False

    def _activity_invitation_cb(self, object_path):
        """Callback for dbus event (forwards to method to emit GObject event)"""
        gobject.idle_add(self._emit_activity_invitation_signal, object_path)

    def _emit_private_invitation_signal(self, bus_name, connection, channel):
        """Emit GObject event with bus_name, connection and channel"""
        self.emit('private-invitation', bus_name, connection, channel)
        return False

    def _private_invitation_cb(self, bus_name, connection, channel):
        """Callback for dbus event (forwards to method to emit GObject event)"""
        gobject.idle_add(self._emit_service_disappeared_signal, bus_name,
                connection, channel)

    def _emit_activity_appeared_signal(self, object_path):
        """Emit GObject event with presence.activity.Activity object"""
        self.emit('activity-appeared', self._new_object(object_path))
        return False

    def _activity_appeared_cb(self, object_path):
        """Callback for dbus event (forwards to method to emit GObject event)"""
        gobject.idle_add(self._emit_activity_appeared_signal, object_path)

    def _emit_activity_disappeared_signal(self, object_path):
        """Emit GObject event with presence.activity.Activity object"""
        self.emit('activity-disappeared', self._new_object(object_path))
        return False

    def _activity_disappeared_cb(self, object_path):
        """Callback for dbus event (forwards to method to emit GObject event)"""
        gobject.idle_add(self._emit_activity_disappeared_signal, object_path)

    def get(self, object_path):
        """Return the Buddy or Activity object corresponding to the given
        D-Bus object path.
        """
        return self._new_object(object_path)

    def get_activities(self):
        """Retrieve set of all activities from service
        
        returns list of Activity objects for all object paths
            the service reports exist (using GetActivities)
        """
        try:
            resp = self._ps.GetActivities()
        except dbus.exceptions.DBusException, err:
            logging.warn(
                """Unable to retrieve activity list from presence service: %s""",
                err
            )
            return []
        else:
            acts = []
            for item in resp:
                acts.append(self._new_object(item))
            return acts

    def get_activity(self, activity_id):
        """Retrieve single Activity object for the given unique id 
        
        activity_id -- unique ID for the activity 
        
        returns single Activity object or None if the activity 
            is not found using GetActivityById on the service
        """
        try:
            act_op = self._ps.GetActivityById(activity_id)
        except dbus.exceptions.DBusException, err:
            logging.warn(
                """Unable to retrieve activity handle for %r from presence service: %s""",
                activity_id,
                err
            )
            return None
        return self._new_object(act_op)

    def get_buddies(self):
        """Retrieve set of all buddies from service
        
        returns list of Buddy objects for all object paths
            the service reports exist (using GetBuddies)
        """
        try:
            resp = self._ps.GetBuddies()
        except dbus.exceptions.DBusException, err:
            logging.warn(
                """Unable to retrieve buddy-list from presence service: %s""",
                err
            )
            return []
        else:
            buddies = []
            for item in resp:
                buddies.append(self._new_object(item))
            return buddies

    def get_buddy(self, key):
        """Retrieve single Buddy object for the given public key
        
        key -- buddy's public encryption key
        
        returns single Buddy object or None if the activity 
            is not found using GetBuddyByPublicKey on the 
            service
        """
        try:
            buddy_op = self._ps.GetBuddyByPublicKey(dbus.ByteArray(key))
        except dbus.exceptions.DBusException, err:
            logging.warn(
                """Unable to retrieve buddy handle for %r from presence service: %s""",
                key,
                err
            )
            return None
        return self._new_object(buddy_op)

    def get_owner(self):
        """Retrieves the laptop "owner" Buddy object."""
        try:
            owner_op = self._ps.GetOwner()
        except dbus.exceptions.DBusException, err:
            logging.warn(
                """Unable to retrieve local user/owner from presence service: %s""",
                err
            )
            raise RuntimeError("Could not get owner object from presence service.")
        return self._new_object(owner_op)

    def _share_activity_cb(self, activity, op):
        """Notify with GObject event of successful sharing of activity"""
        self.emit("activity-shared", True, self._new_object(op), None)

    def _share_activity_error_cb(self, activity, err):
        """Notify with GObject event of unsuccessful sharing of activity"""
        logging.debug("Error sharing activity %s: %s" % (activity.get_id(), err))
        self.emit("activity-shared", False, None, err)

    def share_activity(self, activity, properties={}):
        """Ask presence service to ask the activity to share itself
        
        Uses the ShareActivity method on the service to ask for the 
        sharing of the given activity.  Arranges to emit activity-shared 
        event with:
        
            (success, Activity, err)
        
        on success/failure.
        
        returns None
        """
        actid = activity.get_id()
        atype = activity.get_service_name()
        name = activity.props.title
        self._ps.ShareActivity(actid, atype, name, properties,
                reply_handler=lambda *args: self._share_activity_cb(activity, *args),
                error_handler=lambda *args: self._share_activity_error_cb(activity, *args))

    def get_preferred_connection(self):
        """Gets the preferred telepathy connection object that an activity
        should use when talking directly to telepathy

        returns the bus name and the object path of the Telepathy connection"""

        try:
            bus_name, object_path = self._ps.GetPreferredConnection()
        except dbus.exceptions.DBusException:
            return None

        return bus_name, object_path

class _OfflineInterface( object ):
    """Offline-presence-service interface
    
    Used to mimic the behaviour of a real PresenceService sufficiently
    to avoid crashing client code that expects the given interface.
    
    XXX we could likely return a "MockOwner" object reasonably 
    easily, but would it be worth it?
    """
    def raiseException( self, *args, **named ):
        """Raise dbus.exceptions.DBusException"""
        raise dbus.exceptions.DBusException( 
            """PresenceService Interface not available"""
        )
    GetActivities = raiseException
    GetActivityById = raiseException
    GetBuddies = raiseException
    GetBuddyByPublicKey = raiseException
    GetOwner = raiseException
    GetPreferredConnection = raiseException
    def ShareActivity( 
        self, actid, atype, name, properties,
        reply_handler, error_handler,
    ):
        """Pretend to share and fail..."""
        exc = IOError(
            """Unable to share activity as PresenceService is not currenly available"""
        )
        return error_handler( exc )

class _MockPresenceService(gobject.GObject):
    """Test fixture allowing testing of items that use PresenceService
    
    See PresenceService for usage and purpose
    """
    __gsignals__ = {
        'buddy-appeared': (gobject.SIGNAL_RUN_FIRST, gobject.TYPE_NONE,
                        ([gobject.TYPE_PYOBJECT])),
        'buddy-disappeared': (gobject.SIGNAL_RUN_FIRST, gobject.TYPE_NONE,
                        ([gobject.TYPE_PYOBJECT])),
        'activity-invitation': (gobject.SIGNAL_RUN_FIRST, gobject.TYPE_NONE,
                        ([gobject.TYPE_PYOBJECT])),
        'private-invitation': (gobject.SIGNAL_RUN_FIRST, gobject.TYPE_NONE,
                        ([gobject.TYPE_PYOBJECT, gobject.TYPE_PYOBJECT,
                          gobject.TYPE_PYOBJECT])),
        'activity-appeared': (gobject.SIGNAL_RUN_FIRST, gobject.TYPE_NONE,
                        ([gobject.TYPE_PYOBJECT])),
        'activity-disappeared': (gobject.SIGNAL_RUN_FIRST, gobject.TYPE_NONE,
                        ([gobject.TYPE_PYOBJECT]))
    }

    def __init__(self):
        gobject.GObject.__init__(self)

    def get_activities(self):
        return []

    def get_activity(self, activity_id):
        return None

    def get_buddies(self):
        return []

    def get_buddy(self, key):
        return None

    def get_owner(self):
        return None

    def share_activity(self, activity, properties={}):
        return None

_ps = None
def get_instance(allow_offline_iface=False):
    """Retrieve this process' view of the PresenceService"""
    global _ps
    if not _ps:
        _ps = PresenceService(allow_offline_iface)
    return _ps