sugarlabs/sugar-toolkit-gtk3
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

services/presence/activity: wrap long lines, remove trailing whitespace

Browse Source
This commit is contained in:
Simon McVittie 2007-05-25 10:56:14 +01:00
parent cb84d5f8fd
commit a5ba8541a4
1 changed files with 112 additions and 86 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

198
services/presence/activity.py
View File

@ -41,7 +41,7 @@ _logger = logging.getLogger('s-p-s.activity')
class Activity(ExportedGObject): class Activity(ExportedGObject):
"""Represents a potentially shareable activity on the network. """Represents a potentially shareable activity on the network.
""" """
__gtype_name__ = "Activity" __gtype_name__ = "Activity"
__gsignals__ = { __gsignals__ = {
@ -51,16 +51,19 @@ class Activity(ExportedGObject):
__gproperties__ = { __gproperties__ = {
_PROP_ID : (str, None, None, None, _PROP_ID : (str, None, None, None,
gobject.PARAM_READWRITE | gobject.PARAM_CONSTRUCT_ONLY), gobject.PARAM_READWRITE |
gobject.PARAM_CONSTRUCT_ONLY),
_PROP_NAME : (str, None, None, None, gobject.PARAM_READWRITE), _PROP_NAME : (str, None, None, None, gobject.PARAM_READWRITE),
_PROP_COLOR : (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_TYPE : (str, None, None, None, gobject.PARAM_READWRITE),
_PROP_VALID : (bool, None, None, False, gobject.PARAM_READABLE), _PROP_VALID : (bool, None, None, False, gobject.PARAM_READABLE),
_PROP_LOCAL : (bool, None, None, False, _PROP_LOCAL : (bool, None, None, False,
gobject.PARAM_READWRITE | gobject.PARAM_CONSTRUCT_ONLY), gobject.PARAM_READWRITE |
gobject.PARAM_CONSTRUCT_ONLY),
_PROP_JOINED : (bool, None, None, False, gobject.PARAM_READABLE), _PROP_JOINED : (bool, None, None, False, gobject.PARAM_READABLE),
_PROP_CUSTOM_PROPS : (object, None, None, _PROP_CUSTOM_PROPS : (object, None, None,
gobject.PARAM_READWRITE | gobject.PARAM_CONSTRUCT_ONLY) gobject.PARAM_READWRITE |
gobject.PARAM_CONSTRUCT_ONLY)
} }
_RESERVED_PROPNAMES = __gproperties__.keys() _RESERVED_PROPNAMES = __gproperties__.keys()
@ -91,7 +94,7 @@ class Activity(ExportedGObject):
`custom-props` : dict `custom-props` : dict
Activity-specific properties Activity-specific properties
""" """
if not bus_name: if not bus_name:
raise ValueError("DBus bus name must be valid") raise ValueError("DBus bus name must be valid")
if not object_id or not isinstance(object_id, int): if not object_id or not isinstance(object_id, int):
@ -118,10 +121,12 @@ class Activity(ExportedGObject):
self._custom_props = {} self._custom_props = {}
# ensure no reserved property names are in custom properties # ensure no reserved property names are in custom properties
if kwargs.get(_PROP_CUSTOM_PROPS): cprops = kwargs.get(_PROP_CUSTOM_PROPS)
(rprops, cprops) = self._split_properties(kwargs.get(_PROP_CUSTOM_PROPS)) if cprops is not None:
(rprops, cprops) = self._split_properties(cprops)
if len(rprops.keys()) > 0: if len(rprops.keys()) > 0:
raise ValueError("Cannot use reserved property names '%s'" % ", ".join(rprops.keys())) raise ValueError("Cannot use reserved property names '%s'"
% ", ".join(rprops.keys()))
if not kwargs.get(_PROP_ID): if not kwargs.get(_PROP_ID):
raise ValueError("activity id is required") raise ValueError("activity id is required")
@ -131,7 +136,8 @@ class Activity(ExportedGObject):
ExportedGObject.__init__(self, bus_name, self._object_path, ExportedGObject.__init__(self, bus_name, self._object_path,
gobject_properties=kwargs) gobject_properties=kwargs)
if self.props.local and not self.props.valid: if self.props.local and not self.props.valid:
raise RuntimeError("local activities require color, type, and name") raise RuntimeError("local activities require color, type, and "
"name")
# If not yet valid, query activity properties # If not yet valid, query activity properties
if not self.props.valid: if not self.props.valid:
@ -139,12 +145,12 @@ class Activity(ExportedGObject):
def do_get_property(self, pspec): def do_get_property(self, pspec):
"""Gets the value of a property associated with this activity. """Gets the value of a property associated with this activity.
pspec -- Property specifier pspec -- Property specifier
returns The value of the given property. returns The value of the given property.
""" """
if pspec.name == _PROP_ID: if pspec.name == _PROP_ID:
return self._id return self._id
elif pspec.name == _PROP_NAME: elif pspec.name == _PROP_NAME:
@ -162,13 +168,13 @@ class Activity(ExportedGObject):
def do_set_property(self, pspec, value): def do_set_property(self, pspec, value):
"""Sets the value of a property associated with this activity. """Sets the value of a property associated with this activity.
pspec -- Property specifier pspec -- Property specifier
value -- Desired value value -- Desired value
Note that the "type" property can be set only once; attempting to set it Note that the "type" property can be set only once; attempting to set
to something different later will raise a RuntimeError. it to something different later will raise a RuntimeError.
""" """
if pspec.name == _PROP_ID: if pspec.name == _PROP_ID:
if self._id: if self._id:
@ -197,14 +203,15 @@ class Activity(ExportedGObject):
self._update_validity() self._update_validity()
def _update_validity(self): def _update_validity(self):
"""Sends a "validity-changed" signal if this activity's validity has changed. """Sends a "validity-changed" signal if this activity's validity has
changed.
Determines whether this activity's status has changed from valid to Determines whether this activity's status has changed from valid to
invalid, or invalid to valid, and emits a "validity-changed" signal invalid, or invalid to valid, and emits a "validity-changed" signal
if either is true. "Valid" means that the object's type, ID, name, if either is true. "Valid" means that the object's type, ID, name,
colour and type properties have all been set to something valid colour and type properties have all been set to something valid
(i.e., not "None"). (i.e., not "None").
""" """
try: try:
old_valid = self._valid old_valid = self._valid
@ -223,7 +230,7 @@ class Activity(ExportedGObject):
signature="o") signature="o")
def BuddyJoined(self, buddy_path): def BuddyJoined(self, buddy_path):
"""Generates DBUS signal when a buddy joins this activity. """Generates DBUS signal when a buddy joins this activity.
buddy_path -- DBUS path to buddy object buddy_path -- DBUS path to buddy object
""" """
pass pass
@ -232,7 +239,7 @@ class Activity(ExportedGObject):
signature="o") signature="o")
def BuddyLeft(self, buddy_path): def BuddyLeft(self, buddy_path):
"""Generates DBUS signal when a buddy leaves this activity. """Generates DBUS signal when a buddy leaves this activity.
buddy_path -- DBUS path to buddy object buddy_path -- DBUS path to buddy object
""" """
pass pass
@ -240,13 +247,14 @@ class Activity(ExportedGObject):
@dbus.service.signal(_ACTIVITY_INTERFACE, @dbus.service.signal(_ACTIVITY_INTERFACE,
signature="o") signature="o")
def NewChannel(self, channel_path): def NewChannel(self, channel_path):
"""Generates DBUS signal when a new channel is created for this activity. """Generates DBUS signal when a new channel is created for this
activity.
channel_path -- DBUS path to new channel channel_path -- DBUS path to new channel
XXX - what is this supposed to do? Who is supposed to call it? XXX - what is this supposed to do? Who is supposed to call it?
What is the channel path? Right now this is never called. What is the channel path? Right now this is never called.
""" """
pass pass
@ -255,7 +263,7 @@ class Activity(ExportedGObject):
in_signature="", out_signature="s") in_signature="", out_signature="s")
def GetId(self): def GetId(self):
"""DBUS method to get this activity's ID """DBUS method to get this activity's ID
returns Activity ID returns Activity ID
""" """
return self.props.id return self.props.id
@ -264,7 +272,7 @@ class Activity(ExportedGObject):
in_signature="", out_signature="s") in_signature="", out_signature="s")
def GetColor(self): def GetColor(self):
"""DBUS method to get this activity's colour """DBUS method to get this activity's colour
returns Activity colour returns Activity colour
""" """
return self.props.color return self.props.color
@ -273,27 +281,30 @@ class Activity(ExportedGObject):
in_signature="", out_signature="s") in_signature="", out_signature="s")
def GetType(self): def GetType(self):
"""DBUS method to get this activity's type """DBUS method to get this activity's type
returns Activity type returns Activity type
""" """
return self.props.type return self.props.type
@dbus.service.method(_ACTIVITY_INTERFACE, in_signature="", out_signature="", @dbus.service.method(_ACTIVITY_INTERFACE,
async_callbacks=('async_cb', 'async_err_cb')) in_signature="", out_signature="",
async_callbacks=('async_cb', 'async_err_cb'))
def Join(self, 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 """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_cb -- Callback method to be called if join attempt is successful
async_err_cb -- Callback method to be called if join attempt is unsuccessful async_err_cb -- Callback method to be called if join attempt is
unsuccessful
""" """
self.join(async_cb, async_err_cb) self.join(async_cb, async_err_cb)
@dbus.service.method(_ACTIVITY_INTERFACE, @dbus.service.method(_ACTIVITY_INTERFACE,
in_signature="", out_signature="ao") in_signature="", out_signature="ao")
def GetJoinedBuddies(self): def GetJoinedBuddies(self):
"""DBUS method to return a list of valid buddies who are joined in this activity """DBUS method to return a list of valid buddies who are joined in
this activity
returns A list of buddy object paths returns A list of buddy object paths
""" """
ret = [] ret = []
@ -305,10 +316,11 @@ class Activity(ExportedGObject):
@dbus.service.method(_ACTIVITY_INTERFACE, @dbus.service.method(_ACTIVITY_INTERFACE,
in_signature="", out_signature="soao") in_signature="", out_signature="soao")
def GetChannels(self): def GetChannels(self):
"""DBUS method to get the list of channels associated with this activity """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! returns XXX - Not sure what this returns as get_channels doesn't
actually return a list of channels!
""" """
return self.get_channels() return self.get_channels()
@ -316,7 +328,7 @@ class Activity(ExportedGObject):
in_signature="", out_signature="s") in_signature="", out_signature="s")
def GetName(self): def GetName(self):
"""DBUS method to get this activity's name """DBUS method to get this activity's name
returns Activity name returns Activity name
""" """
return self.props.name return self.props.name
@ -324,16 +336,17 @@ class Activity(ExportedGObject):
# methods # methods
def object_path(self): def object_path(self):
"""Retrieves our dbus.ObjectPath object """Retrieves our dbus.ObjectPath object
returns DBUS ObjectPath object returns DBUS ObjectPath object
""" """
return dbus.ObjectPath(self._object_path) return dbus.ObjectPath(self._object_path)
def get_joined_buddies(self): def get_joined_buddies(self):
"""Local method to return a list of valid buddies who are joined in this activity """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. This method is called by the PresenceService on the local machine.
returns A list of buddy objects returns A list of buddy objects
""" """
ret = [] ret = []
@ -344,13 +357,15 @@ class Activity(ExportedGObject):
def buddy_joined(self, buddy): def buddy_joined(self, buddy):
"""Adds a buddy to this activity and sends a BuddyJoined signal """Adds a buddy to this activity and sends a BuddyJoined signal
buddy -- Buddy object representing the buddy being added buddy -- Buddy object representing the buddy being added
Adds a buddy to this activity if the buddy is not already in the buddy list. 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. If this activity is "valid", a BuddyJoined signal is also sent.
This method is called by the PresenceService on the local machine. This method is called by the PresenceService on the local machine.
""" """
if buddy not in self._buddies: if buddy not in self._buddies:
self._buddies.append(buddy) self._buddies.append(buddy)
@ -359,13 +374,13 @@ class Activity(ExportedGObject):
def buddy_left(self, buddy): def buddy_left(self, buddy):
"""Removes a buddy from this activity and sends a BuddyLeft signal. """Removes a buddy from this activity and sends a BuddyLeft signal.
buddy -- Buddy object representing the buddy being removed buddy -- Buddy object representing the buddy being removed
Removes a buddy from this activity if the buddy is in the buddy list. 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. If this activity is "valid", a BuddyLeft signal is also sent.
This method is called by the PresenceService on the local machine. This method is called by the PresenceService on the local machine.
""" """
if buddy in self._buddies: if buddy in self._buddies:
self._buddies.remove(buddy) self._buddies.remove(buddy)
@ -374,11 +389,12 @@ class Activity(ExportedGObject):
def _handle_share_join(self, tp, text_channel): def _handle_share_join(self, tp, text_channel):
"""Called when a join to a network activity was successful. """Called when a join to a network activity was successful.
Called by the _shared_cb and _joined_cb methods. Called by the _shared_cb and _joined_cb methods.
""" """
if not text_channel: if not text_channel:
_logger.debug("Error sharing: text channel was None, shouldn't happen") _logger.debug("Error sharing: text channel was None, shouldn't "
"happen")
raise RuntimeError("Plugin returned invalid text channel") raise RuntimeError("Plugin returned invalid text channel")
self._text_channel = text_channel self._text_channel = text_channel
@ -409,16 +425,18 @@ class Activity(ExportedGObject):
def _share(self, (async_cb, async_err_cb), owner): def _share(self, (async_cb, async_err_cb), owner):
"""XXX - not documented yet """XXX - not documented yet
XXX - This method is called externally by the PresenceService despite the fact XXX - This method is called externally by the PresenceService
that this is supposed to be an internal method! despite the fact that this is supposed to be an internal method!
""" """
_logger.debug("Starting share of activity %s" % self._id) _logger.debug("Starting share of activity %s" % self._id)
if self._joined: if self._joined:
async_err_cb(RuntimeError("Already shared activity %s" % self.props.id)) async_err_cb(RuntimeError("Already shared activity %s"
% self.props.id))
return return
sigid = self._tp.connect('activity-shared', self._shared_cb) sigid = self._tp.connect('activity-shared', self._shared_cb)
self._tp.share_activity(self.props.id, (sigid, owner, async_cb, async_err_cb)) self._tp.share_activity(self.props.id, (sigid, owner, async_cb,
async_err_cb))
_logger.debug("done with share attempt %s" % self._id) _logger.debug("done with share attempt %s" % self._id)
def _joined_cb(self, tp, activity_id, text_channel, exc, userdata): def _joined_cb(self, tp, activity_id, text_channel, exc, userdata):
@ -439,42 +457,45 @@ class Activity(ExportedGObject):
def join(self, async_cb, async_err_cb): def join(self, async_cb, async_err_cb):
"""Local method for the local user to attempt to join the activity. """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_cb -- Callback method to be called if join attempt is successful
async_err_cb -- Callback method to be called if join attempt is unsuccessful 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 The two callbacks are passed to the server_plugin ("tp") object,
callback is set up within this method. 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: if self._joined:
async_err_cb(RuntimeError("Already joined activity %s" % self.props.id)) async_err_cb(RuntimeError("Already joined activity %s"
% self.props.id))
return return
sigid = self._tp.connect('activity-joined', self._joined_cb) sigid = self._tp.connect('activity-joined', self._joined_cb)
self._tp.join_activity(self.props.id, (sigid, async_cb, async_err_cb)) self._tp.join_activity(self.props.id, (sigid, async_cb, async_err_cb))
def get_channels(self): def get_channels(self):
"""Local method to get the list of channels associated with this activity """Local method to get the list of channels associated with this
activity
returns XXX - expected a list of channels, instead returning a tuple? ???
returns XXX - expected a list of channels, instead returning a tuple?
""" """
conn = self._tp.get_connection() conn = self._tp.get_connection()
# FIXME add tubes and others channels # FIXME add tubes and others channels
return str(conn.service_name), conn.object_path, [self._text_channel.object_path] return (str(conn.service_name), conn.object_path,
[self._text_channel.object_path])
def leave(self): def leave(self):
"""Local method called when the user wants to leave the activity. """Local method called when the user wants to leave the activity.
(XXX - doesn't appear to be called anywhere!) (XXX - doesn't appear to be called anywhere!)
""" """
if self._joined: if self._joined:
self._text_channel[CHANNEL_INTERFACE].Close() self._text_channel[CHANNEL_INTERFACE].Close()
def _text_channel_closed_cb(self): def _text_channel_closed_cb(self):
"""Callback method called when the text channel is closed. """Callback method called when the text channel is closed.
This callback is set up in the _handle_share_join method. This callback is set up in the _handle_share_join method.
""" """
self._joined = False self._joined = False
@ -482,7 +503,7 @@ class Activity(ExportedGObject):
def send_properties(self): def send_properties(self):
"""Tells the Telepathy server what the properties of this activity are. """Tells the Telepathy server what the properties of this activity are.
""" """
props = {} props = {}
props['name'] = self._actname props['name'] = self._actname
@ -496,14 +517,16 @@ class Activity(ExportedGObject):
self._tp.set_activity_properties(self.props.id, props) self._tp.set_activity_properties(self.props.id, props)
def set_properties(self, properties): def set_properties(self, properties):
"""Sets name, colour and/or type properties for this activity all at once. """Sets name, colour and/or type properties for this activity all
at once.
properties - Dictionary object containing properties keyed by property names
properties - Dictionary object containing properties keyed by
Note that if any of the name, colour and/or type property values is changed from property names
what it originally was, the update_validity method will be called, resulting in
a "validity-changed" signal being generated. Called by the PresenceService Note that if any of the name, colour and/or type property values is
on the local machine. 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 changed = False
# split reserved properties from activity-custom properties # split reserved properties from activity-custom properties
@ -525,7 +548,8 @@ class Activity(ExportedGObject):
if type != self._type: if type != self._type:
# Type can never be changed after first set # Type can never be changed after first set
if self._type: if self._type:
_logger.debug("Activity type changed by network; this is illegal") _logger.debug("Activity type changed by network; this "
"is illegal")
else: else:
self._type = type self._type = type
changed = True changed = True
@ -539,10 +563,12 @@ class Activity(ExportedGObject):
def _split_properties(self, properties): def _split_properties(self, properties):
"""Extracts reserved properties. """Extracts reserved properties.
properties - Dictionary object containing properties keyed by property names properties - Dictionary object containing properties keyed by
property names
returns a tuple of 2 dictionaries, reserved properties and custom properties
returns a tuple of 2 dictionaries, reserved properties and custom
properties
""" """
rprops = {} rprops = {}
cprops = {} cprops = {}