535 lines
19 KiB
Python
535 lines
19 KiB
Python
# Copyright (C) 2007, Red Hat, Inc.
|
|
# Copyright (C) 2007, Collabora Ltd.
|
|
#
|
|
# This program 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; either version 2 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# This program 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 this program; if not, write to the Free Software
|
|
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
|
|
|
import gobject
|
|
import dbus, dbus.service
|
|
from sugar import util
|
|
import logging
|
|
|
|
from telepathy.interfaces import (CHANNEL_INTERFACE)
|
|
|
|
_ACTIVITY_PATH = "/org/laptop/Sugar/Presence/Activities/"
|
|
_ACTIVITY_INTERFACE = "org.laptop.Sugar.Presence.Activity"
|
|
|
|
class DBusGObjectMetaclass(dbus.service.InterfaceType, gobject.GObjectMeta): pass
|
|
class DBusGObject(dbus.service.Object, gobject.GObject): __metaclass__ = DBusGObjectMetaclass
|
|
|
|
|
|
_PROP_ID = "id"
|
|
_PROP_NAME = "name"
|
|
_PROP_COLOR = "color"
|
|
_PROP_TYPE = "type"
|
|
_PROP_VALID = "valid"
|
|
_PROP_LOCAL = "local"
|
|
_PROP_JOINED = "joined"
|
|
_PROP_CUSTOM_PROPS = "custom-props"
|
|
|
|
class Activity(DBusGObject):
|
|
"""Represents a potentially shareable activity on the network.
|
|
"""
|
|
|
|
__gtype_name__ = "Activity"
|
|
|
|
__gsignals__ = {
|
|
'validity-changed': (gobject.SIGNAL_RUN_FIRST, gobject.TYPE_NONE,
|
|
([gobject.TYPE_BOOLEAN]))
|
|
}
|
|
|
|
__gproperties__ = {
|
|
_PROP_ID : (str, None, None, None,
|
|
gobject.PARAM_READWRITE | gobject.PARAM_CONSTRUCT_ONLY),
|
|
_PROP_NAME : (str, None, None, None, gobject.PARAM_READWRITE),
|
|
_PROP_COLOR : (str, None, None, None, gobject.PARAM_READWRITE),
|
|
_PROP_TYPE : (str, None, None, None, gobject.PARAM_READWRITE),
|
|
_PROP_VALID : (bool, None, None, False, gobject.PARAM_READABLE),
|
|
_PROP_LOCAL : (bool, None, None, False,
|
|
gobject.PARAM_READWRITE | gobject.PARAM_CONSTRUCT_ONLY),
|
|
_PROP_JOINED : (bool, None, None, False, gobject.PARAM_READABLE),
|
|
_PROP_CUSTOM_PROPS : (object, None, None,
|
|
gobject.PARAM_READWRITE | gobject.PARAM_CONSTRUCT_ONLY)
|
|
}
|
|
|
|
_RESERVED_PROPNAMES = self.__gproperties__.keys()
|
|
|
|
def __init__(self, bus_name, object_id, tp, **kwargs):
|
|
"""Initializes the activity and sets its properties to default values.
|
|
|
|
bus_name -- DBUS name for lookup on local host
|
|
object_id -- The unique worldwide ID for this activity
|
|
tp -- The server plugin object (stands for "telepathy plugin")
|
|
kwargs -- Keyword arguments for the GObject properties
|
|
|
|
"""
|
|
|
|
if not bus_name:
|
|
raise ValueError("DBus bus name must be valid")
|
|
if not object_id or not isinstance(object_id, int):
|
|
raise ValueError("object id must be a valid number")
|
|
if not tp:
|
|
raise ValueError("telepathy CM must be valid")
|
|
|
|
self._object_id = object_id
|
|
self._object_path = _ACTIVITY_PATH + str(self._object_id)
|
|
dbus.service.Object.__init__(self, bus_name, self._object_path)
|
|
|
|
self._buddies = []
|
|
self._joined = False
|
|
|
|
# the telepathy client
|
|
self._tp = tp
|
|
self._text_channel = None
|
|
|
|
self._valid = False
|
|
self._id = None
|
|
self._color = None
|
|
self._local = False
|
|
self._type = None
|
|
self._custom_props = {}
|
|
|
|
# ensure no reserved property names are in custom properties
|
|
if kwargs.get(_PROP_CUSTOM_PROPS):
|
|
(rprops, cprops) = self._split_properties(kwargs.get(_PROP_CUSTOM_PROPS))
|
|
if len(rprops.keys()) > 0:
|
|
raise ValueError("Cannot use reserved property names '%s'" % ", ".join(rprops.keys()))
|
|
|
|
if not kwargs.get(_PROP_ID):
|
|
raise ValueError("activity id is required")
|
|
if not util.validate_activity_id(kwargs[_PROP_ID]):
|
|
raise ValueError("Invalid activity id '%s'" % kwargs[_PROP_ID])
|
|
|
|
gobject.GObject.__init__(self, **kwargs)
|
|
if self.props.local and not self.props.valid:
|
|
raise RuntimeError("local activities require color, type, and name")
|
|
|
|
# If not yet valid, query activity properties
|
|
if not self.props.valid:
|
|
tp.update_activity_properties(self._id)
|
|
|
|
def do_get_property(self, pspec):
|
|
"""Gets the value of a property associated with this activity.
|
|
|
|
pspec -- Property specifier
|
|
|
|
returns The value of the given property.
|
|
"""
|
|
|
|
if pspec.name == _PROP_ID:
|
|
return self._id
|
|
elif pspec.name == _PROP_NAME:
|
|
return self._name
|
|
elif pspec.name == _PROP_COLOR:
|
|
return self._color
|
|
elif pspec.name == _PROP_TYPE:
|
|
return self._type
|
|
elif pspec.name == _PROP_VALID:
|
|
return self._valid
|
|
elif pspec.name == _PROP_JOINED:
|
|
return self._joined
|
|
elif pspec.name == _PROP_LOCAL:
|
|
return self._local
|
|
|
|
def do_set_property(self, pspec, value):
|
|
"""Sets the value of a property associated with this activity.
|
|
|
|
pspec -- Property specifier
|
|
value -- Desired value
|
|
|
|
Note that the "type" property can be set only once; attempting to set it
|
|
to something different later will raise a RuntimeError.
|
|
|
|
"""
|
|
if pspec.name == _PROP_ID:
|
|
if self._id:
|
|
raise RuntimeError("activity ID is already set")
|
|
self._id = value
|
|
elif pspec.name == _PROP_NAME:
|
|
self._name = value
|
|
elif pspec.name == _PROP_COLOR:
|
|
self._color = value
|
|
elif pspec.name == _PROP_TYPE:
|
|
if self._type:
|
|
raise RuntimeError("activity type is already set")
|
|
self._type = value
|
|
elif pspec.name == _PROP_JOINED:
|
|
self._joined = value
|
|
elif pspec.name == _PROP_LOCAL:
|
|
self._local = value
|
|
elif pspec.name == _PROP_CUSTOM_PROPS:
|
|
(rprops, cprops) = self._split_properties(value)
|
|
self._custom_props = {}
|
|
for (key, dvalue) in cprops:
|
|
self._custom_props[str(key)] = str(dvalue)
|
|
|
|
self._update_validity()
|
|
|
|
def _update_validity(self):
|
|
"""Sends a "validity-changed" signal if this activity's validity has changed.
|
|
|
|
Determines whether this activity's status has changed from valid to
|
|
invalid, or invalid to valid, and emits a "validity-changed" signal
|
|
if either is true. "Valid" means that the object's type, ID, name,
|
|
colour and type properties have all been set to something valid
|
|
(i.e., not "None").
|
|
|
|
"""
|
|
try:
|
|
old_valid = self._valid
|
|
if self._color and self._name and self._id and self._type:
|
|
self._valid = True
|
|
else:
|
|
self._valid = False
|
|
|
|
if old_valid != self._valid:
|
|
self.emit("validity-changed", self._valid)
|
|
except AttributeError:
|
|
self._valid = False
|
|
|
|
# dbus signals
|
|
@dbus.service.signal(_ACTIVITY_INTERFACE,
|
|
signature="o")
|
|
def BuddyJoined(self, buddy_path):
|
|
"""Generates DBUS signal when a buddy joins this activity.
|
|
|
|
buddy_path -- DBUS path to buddy object
|
|
"""
|
|
pass
|
|
|
|
@dbus.service.signal(_ACTIVITY_INTERFACE,
|
|
signature="o")
|
|
def BuddyLeft(self, buddy_path):
|
|
"""Generates DBUS signal when a buddy leaves this activity.
|
|
|
|
buddy_path -- DBUS path to buddy object
|
|
"""
|
|
pass
|
|
|
|
@dbus.service.signal(_ACTIVITY_INTERFACE,
|
|
signature="o")
|
|
def NewChannel(self, channel_path):
|
|
"""Generates DBUS signal when a new channel is created for this activity.
|
|
|
|
channel_path -- DBUS path to new channel
|
|
|
|
XXX - what is this supposed to do? Who is supposed to call it?
|
|
What is the channel path? Right now this is never called.
|
|
|
|
"""
|
|
pass
|
|
|
|
# dbus methods
|
|
@dbus.service.method(_ACTIVITY_INTERFACE,
|
|
in_signature="", out_signature="s")
|
|
def GetId(self):
|
|
"""DBUS method to get this activity's ID
|
|
|
|
returns Activity ID
|
|
"""
|
|
return self.props.id
|
|
|
|
@dbus.service.method(_ACTIVITY_INTERFACE,
|
|
in_signature="", out_signature="s")
|
|
def GetColor(self):
|
|
"""DBUS method to get this activity's colour
|
|
|
|
returns Activity colour
|
|
"""
|
|
return self.props.color
|
|
|
|
@dbus.service.method(_ACTIVITY_INTERFACE,
|
|
in_signature="", out_signature="s")
|
|
def GetType(self):
|
|
"""DBUS method to get this activity's type
|
|
|
|
returns Activity type
|
|
"""
|
|
return self.props.type
|
|
|
|
@dbus.service.method(_ACTIVITY_INTERFACE, in_signature="", out_signature="",
|
|
async_callbacks=('async_cb', 'async_err_cb'))
|
|
def Join(self, async_cb, async_err_cb):
|
|
"""DBUS method to for the local user to attempt to join the activity
|
|
|
|
async_cb -- Callback method to be called if join attempt is successful
|
|
async_err_cb -- Callback method to be called if join attempt is unsuccessful
|
|
|
|
"""
|
|
self.join(async_cb, async_err_cb)
|
|
|
|
@dbus.service.method(_ACTIVITY_INTERFACE,
|
|
in_signature="", out_signature="ao")
|
|
def GetJoinedBuddies(self):
|
|
"""DBUS method to return a list of valid buddies who are joined in this activity
|
|
|
|
returns A list of buddy object paths
|
|
"""
|
|
ret = []
|
|
for buddy in self._buddies:
|
|
if buddy.props.valid:
|
|
ret.append(buddy.object_path())
|
|
return ret
|
|
|
|
@dbus.service.method(_ACTIVITY_INTERFACE,
|
|
in_signature="", out_signature="soao")
|
|
def GetChannels(self):
|
|
"""DBUS method to get the list of channels associated with this activity
|
|
|
|
returns XXX - Not sure what this returns as get_channels doesn't actually return
|
|
a list of channels!
|
|
"""
|
|
return self.get_channels()
|
|
|
|
@dbus.service.method(_ACTIVITY_INTERFACE,
|
|
in_signature="", out_signature="s")
|
|
def GetName(self):
|
|
"""DBUS method to get this activity's name
|
|
|
|
returns Activity name
|
|
"""
|
|
return self.props.name
|
|
|
|
# methods
|
|
def object_path(self):
|
|
"""Retrieves our dbus.ObjectPath object
|
|
|
|
returns DBUS ObjectPath object
|
|
"""
|
|
return dbus.ObjectPath(self._object_path)
|
|
|
|
def get_joined_buddies(self):
|
|
"""Local method to return a list of valid buddies who are joined in this activity
|
|
|
|
This method is called by the PresenceService on the local machine.
|
|
|
|
returns A list of buddy objects
|
|
"""
|
|
ret = []
|
|
for buddy in self._buddies:
|
|
if buddy.props.valid:
|
|
ret.append(buddy)
|
|
return ret
|
|
|
|
def buddy_joined(self, buddy):
|
|
"""Adds a buddy to this activity and sends a BuddyJoined signal
|
|
|
|
buddy -- Buddy object representing the buddy being added
|
|
|
|
Adds a buddy to this activity if the buddy is not already in the buddy list.
|
|
If this activity is "valid", a BuddyJoined signal is also sent.
|
|
This method is called by the PresenceService on the local machine.
|
|
|
|
"""
|
|
if buddy not in self._buddies:
|
|
self._buddies.append(buddy)
|
|
if self.props.valid:
|
|
self.BuddyJoined(buddy.object_path())
|
|
|
|
def buddy_left(self, buddy):
|
|
"""Removes a buddy from this activity and sends a BuddyLeft signal.
|
|
|
|
buddy -- Buddy object representing the buddy being removed
|
|
|
|
Removes a buddy from this activity if the buddy is in the buddy list.
|
|
If this activity is "valid", a BuddyLeft signal is also sent.
|
|
This method is called by the PresenceService on the local machine.
|
|
|
|
"""
|
|
if buddy in self._buddies:
|
|
self._buddies.remove(buddy)
|
|
if self.props.valid:
|
|
self.BuddyLeft(buddy.object_path())
|
|
|
|
def _handle_share_join(self, tp, text_channel):
|
|
"""Called when a join to a network activity was successful.
|
|
|
|
Called by the _shared_cb and _joined_cb methods.
|
|
"""
|
|
if not text_channel:
|
|
logging.debug("Error sharing: text channel was None, shouldn't happen")
|
|
raise RuntimeError("Plugin returned invalid text channel")
|
|
|
|
self._text_channel = text_channel
|
|
self._text_channel[CHANNEL_INTERFACE].connect_to_signal('Closed',
|
|
self._text_channel_closed_cb)
|
|
self._joined = True
|
|
return True
|
|
|
|
def _shared_cb(self, tp, activity_id, text_channel, exc, userdata):
|
|
"""XXX - not documented yet
|
|
"""
|
|
if activity_id != self.props.id:
|
|
# Not for us
|
|
return
|
|
|
|
(sigid, owner, async_cb, async_err_cb) = userdata
|
|
self._tp.disconnect(sigid)
|
|
|
|
if exc:
|
|
logging.debug("Share of activity %s failed: %s" % (self._id, exc))
|
|
async_err_cb(exc)
|
|
else:
|
|
self._handle_share_join(tp, text_channel)
|
|
self.send_properties()
|
|
owner.add_activity(self)
|
|
async_cb(dbus.ObjectPath(self._object_path))
|
|
logging.debug("Share of activity %s succeeded." % self._id)
|
|
|
|
def _share(self, (async_cb, async_err_cb), owner):
|
|
"""XXX - not documented yet
|
|
|
|
XXX - This method is called externally by the PresenceService despite the fact
|
|
that this is supposed to be an internal method!
|
|
"""
|
|
logging.debug("Starting share of activity %s" % self._id)
|
|
if self._joined:
|
|
async_err_cb(RuntimeError("Already shared activity %s" % self.props.id))
|
|
return
|
|
sigid = self._tp.connect('activity-shared', self._shared_cb)
|
|
self._tp.share_activity(self.props.id, (sigid, owner, async_cb, async_err_cb))
|
|
logging.debug("done with share attempt %s" % self._id)
|
|
|
|
def _joined_cb(self, tp, activity_id, text_channel, exc, userdata):
|
|
"""XXX - not documented yet
|
|
"""
|
|
if activity_id != self.props.id:
|
|
# Not for us
|
|
return
|
|
|
|
(sigid, async_cb, async_err_cb) = userdata
|
|
self._tp.disconnect(sigid)
|
|
|
|
if exc:
|
|
async_err_cb(exc)
|
|
else:
|
|
self._handle_share_join(tp, text_channel)
|
|
async_cb()
|
|
|
|
def join(self, async_cb, async_err_cb):
|
|
"""Local method for the local user to attempt to join the activity.
|
|
|
|
async_cb -- Callback method to be called if join attempt is successful
|
|
async_err_cb -- Callback method to be called if join attempt is unsuccessful
|
|
|
|
The two callbacks are passed to the server_plugin ("tp") object, which in turn
|
|
passes them back as parameters in a callback to the _joined_cb method; this
|
|
callback is set up within this method.
|
|
|
|
"""
|
|
if self._joined:
|
|
async_err_cb(RuntimeError("Already joined activity %s" % self.props.id))
|
|
return
|
|
sigid = self._tp.connect('activity-joined', self._joined_cb)
|
|
self._tp.join_activity(self.props.id, (sigid, async_cb, async_err_cb))
|
|
|
|
def get_channels(self):
|
|
"""Local method to get the list of channels associated with this activity
|
|
|
|
returns XXX - expected a list of channels, instead returning a tuple? ???
|
|
"""
|
|
conn = self._tp.get_connection()
|
|
# FIXME add tubes and others channels
|
|
return str(conn.service_name), conn.object_path, [self._text_channel.object_path]
|
|
|
|
def leave(self):
|
|
"""Local method called when the user wants to leave the activity.
|
|
|
|
(XXX - doesn't appear to be called anywhere!)
|
|
|
|
"""
|
|
if self._joined:
|
|
self._text_channel[CHANNEL_INTERFACE].Close()
|
|
|
|
def _text_channel_closed_cb(self):
|
|
"""Callback method called when the text channel is closed.
|
|
|
|
This callback is set up in the _handle_share_join method.
|
|
"""
|
|
self._joined = False
|
|
self._text_channel = None
|
|
|
|
def send_properties(self):
|
|
"""Tells the Telepathy server what the properties of this activity are.
|
|
|
|
"""
|
|
props = {}
|
|
props['name'] = self._name
|
|
props['color'] = self._color
|
|
props['type'] = self._type
|
|
|
|
# Add custom properties
|
|
for (key, value) in self._custom_props.items():
|
|
props[key] = value
|
|
|
|
self._tp.set_activity_properties(self.props.id, props)
|
|
|
|
def set_properties(self, properties):
|
|
"""Sets name, colour and/or type properties for this activity all at once.
|
|
|
|
properties - Dictionary object containing properties keyed by property names
|
|
|
|
Note that if any of the name, colour and/or type property values is changed from
|
|
what it originally was, the update_validity method will be called, resulting in
|
|
a "validity-changed" signal being generated. Called by the PresenceService
|
|
on the local machine.
|
|
"""
|
|
changed = False
|
|
# split reserved properties from activity-custom properties
|
|
(rprops, cprops) = self._split_properties()
|
|
if _PROP_NAME in rprops.keys():
|
|
name = rprops[_PROP_NAME]
|
|
if name != self._name:
|
|
self._name = name
|
|
changed = True
|
|
|
|
if _PROP_COLOR in rprops.keys():
|
|
color = rprops[_PROP_COLOR]
|
|
if color != self._color:
|
|
self._color = color
|
|
changed = True
|
|
|
|
if _PROP_TYPE in rprops.keys():
|
|
type = rprops[_PROP_TYPE]
|
|
# Type can never be changed after first set
|
|
if self._type:
|
|
logging.debug("Activity type changed by network; this is illegal")
|
|
else:
|
|
if type != self._type:
|
|
self._type = type
|
|
changed = True
|
|
|
|
# Set custom properties
|
|
if len(cprops.keys()) > 0:
|
|
self.props.custom_props = cprops
|
|
|
|
if changed:
|
|
self._update_validity()
|
|
|
|
def _split_properties(self, properties):
|
|
"""Extracts reserved properties.
|
|
|
|
properties - Dictionary object containing properties keyed by property names
|
|
|
|
returns a tuple of 2 dictionaries, reserved properties and custom properties
|
|
"""
|
|
rprops = {}
|
|
cprops = {}
|
|
for (key, value) in properties:
|
|
if key in self._RESERVED_PROPNAMES:
|
|
rprops[key] = value
|
|
else:
|
|
cprops[key] = value
|
|
return (rprops, cprops)
|