sugar-toolkit-gtk3/sugar/activity/Activity.py

import sys
import imp

import dbus
import dbus.service
import dbus.glib
import pygtk
pygtk.require('2.0')
import gtk, gobject

from sugar.LogWriter import LogWriter
from sugar import keybindings
import sugar.util

SHELL_SERVICE_NAME = "com.redhat.Sugar.Shell"
SHELL_SERVICE_PATH = "/com/redhat/Sugar/Shell"

ACTIVITY_SERVICE_NAME = "com.redhat.Sugar.Activity"
ACTIVITY_SERVICE_PATH = "/com/redhat/Sugar/Activity"

ON_PUBLISH_CB = "publish"

def get_path(activity_name):
	"""Returns the activity path"""
	return '/' + activity_name.replace('.', '/')

def get_factory(activity_name):
	"""Returns the activity factory"""
	return activity_name + '.Factory'

class ActivityFactory(dbus.service.Object):
	"""Dbus service that takes care of creating new instances of an activity"""

	def __init__(self, activity_name, activity_class):
		splitted_module = activity_class.rsplit('.', 1)
		module_name = splitted_module[0]
		class_name = splitted_module[1]
		
		(fp, pathname, description) = imp.find_module(module_name)
		module = imp.load_module(module_name, fp, pathname, description)
		
		try:
			start = getattr(module, 'start')
		except:
			start = None

		if start:
			start()
		
		self._class = getattr(module, class_name)
	
		bus = dbus.SessionBus()
		factory = get_factory(activity_name)
		bus_name = dbus.service.BusName(factory, bus = bus) 
		dbus.service.Object.__init__(self, bus_name, get_path(factory))

	@dbus.service.method("com.redhat.Sugar.ActivityFactory")
	def create_with_service(self, serialized_service, args):
		service = None
		if serialized_service is not None:
			service = Service.deserialize(serialized_service)

		activity = self._class(args)

	@dbus.service.method("com.redhat.Sugar.ActivityFactory")
	def create(self):
		self.create_with_service(None, [])

def create(activity_name, service = None, args = None):
	"""Create a new activity from his name."""
	bus = dbus.SessionBus()

	factory_name = get_factory(activity_name)
	factory_path = get_path(factory_name) 

	proxy_obj = bus.get_object(factory_name, factory_path)
	factory = dbus.Interface(proxy_obj, "com.redhat.Sugar.ActivityFactory")

	if service and args:
		serialized_service = service.serialize(service)
		factory.create_with_service(serialized_service, args)
	else:
		factory.create()		

def _get_registry():
	bus = dbus.SessionBus()
	proxy_obj = bus.get_object("com.redhat.Sugar.ActivityRegistry",
							   "/com/redhat/Sugar/ActivityRegistry")
	return dbus.Interface(proxy_obj, "com.redhat.Sugar.ActivityRegistry")

def list_activities():
	registry = _get_registry()
	return registry.list_activities()

def main(activity_name, activity_class):
	"""Starts the activity main loop."""
	log_writer = LogWriter(activity_name)
	log_writer.start()

	factory = ActivityFactory(activity_name, activity_class)

	registry = _get_registry()
	registry.add(activity_name, activity_name)

	gtk.main()

class ActivityDbusService(dbus.service.Object):
	"""Base dbus service object that each Activity uses to export dbus methods.
	
	The dbus service is separate from the actual Activity object so that we can
	tightly control what stuff passes through the dbus python bindings."""

	_ALLOWED_CALLBACKS = [ON_PUBLISH_CB]

	def __init__(self, xid, activity):
		self._activity = activity
		self._callbacks = {}
		for cb in self._ALLOWED_CALLBACKS:
			self._callbacks[cb] = None
		
		bus = dbus.SessionBus()
		service_name = ACTIVITY_SERVICE_NAME + "%s" % xid
		object_path = ACTIVITY_SERVICE_PATH + "/%s" % xid
		service = dbus.service.BusName(service_name, bus=bus)
		dbus.service.Object.__init__(self, service, object_path)

	def register_callback(self, name, callback):
		if name not in self._ALLOWED_CALLBACKS:
			print "ActivityDbusService: bad callback registration request for '%s'" % name
			return
		self._callbacks[name] = callback

	def _call_callback_cb(self, func, *args):
		gobject.idle_add(func, *args)
		return False

	def _call_callback(self, name, *args):
		"""Call our activity object back, but from an idle handler
		to minimize the possibility of stupid activities deadlocking
		in dbus callbacks."""
		if name in self._ALLOWED_CALLBACKS and self._callbacks[name]:
			gobject.idle_add(self._call_callback_cb, self._callbacks[name], *args)

	@dbus.service.method(ACTIVITY_SERVICE_NAME)
	def publish(self):
		"""Called by the shell to request the activity to publish itself on the network."""
		self._call_callback(ON_PUBLISH_CB)

	@dbus.service.method(ACTIVITY_SERVICE_NAME)
	def get_id(self):
		"""Get the activity identifier"""
		self._activity.get_id()

	@dbus.service.method(ACTIVITY_SERVICE_NAME)
	def get_shared(self):
		"""Get the activity identifier"""
		return self._activity.get_shared()

class Activity(gtk.Window):
	"""Base Activity class that all other Activities derive from."""

	def __init__(self, default_type, activity_id = None):
		gtk.Window.__init__(self)

		if activity_id is None:
			self._activity_id = sugar.util.unique_id()
		else:
			self._activity_id = activity_id

		self._dbus_service = None
		self._initial_service = None
		self._activity_object = None
		self._shared = False
		if type(default_type) != type("") or not len(default_type):
			raise ValueError("Default type must be a valid string.")
		self._default_type = default_type

		keybindings.setup_global_keys(self)

		self.connect('realize', self.__realize)
		
		self.present()
	
	def __realize(self, window):
		if not self._dbus_service:
			self._register_service()
	
	def _register_service(self):
		self._dbus_service = self._get_new_dbus_service()
		self._dbus_service.register_callback(ON_PUBLISH_CB, self._internal_on_publish_cb)

	def _cleanup(self):
		if self._dbus_service:
			del self._dbus_service
			self._dbus_service = None

	def __del__(self):
		self._cleanup()

	def _get_new_dbus_service(self):
		"""Create and return a new dbus service object for this Activity.
		Allows subclasses to use their own dbus service object if they choose."""
		return ActivityDbusService(self.window.xid, self)

	def default_type(self):
		return self._default_type

	def set_shared(self):
		"""Mark the activity as 'shared'."""
		if not self._shared:
			self._shared = True
			self._dbus_service.ActivityShared()

	def get_shared(self):
		return self._shared

	def has_focus(self):
		"""Return whether or not this Activity is visible to the user."""
		return self._has_focus

	def _internal_on_publish_cb(self):
		"""Callback when the dbus service object tells us the user has closed our activity."""
		self.publish()

	def get_id(self):
		return self._activity_id

	#############################################################
	# Pure Virtual methods that subclasses may/may not implement
	#############################################################

	def publish(self):
		"""Called to request the activity to publish itself on the network."""
		pass

if __name__ == "__main__":
	main(sys.argv[1], sys.argv[2])