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

359 lines
12 KiB
Python
Raw Normal View History

"""Base class for Python-coded activities
This is currently the only reference for what an
activity must do to participate in the Sugar desktop.
"""
2006-10-15 01:08:44 +02:00
# Copyright (C) 2006, 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 logging
2007-02-22 17:27:00 +01:00
import os
import time
2006-08-09 18:29:33 +02:00
2007-04-27 22:07:38 +02:00
import gtk, gobject
2007-04-09 20:40:56 +02:00
from sugar.presence import presenceservice
2007-02-21 20:15:39 +01:00
from sugar.activity.activityservice import ActivityService
from sugar.graphics.window import Window
from sugar.graphics.toolbox import Toolbox
from sugar.graphics.toolbutton import ToolButton
from sugar.datastore import datastore
from sugar import profile
class ActivityToolbar(gtk.Toolbar):
def __init__(self, activity):
gtk.Toolbar.__init__(self)
self._activity = activity
2007-04-27 22:07:38 +02:00
activity.connect('shared', self._activity_shared_cb)
activity.connect('joined', self._activity_shared_cb)
2007-05-29 15:53:58 +02:00
if activity.metadata:
self.title = gtk.Entry()
self.title.set_size_request(int(gtk.gdk.screen_width() / 6), -1)
2007-05-29 15:53:58 +02:00
self.title.set_text(activity.metadata['title'])
self.title.connect('focus-out-event', self._title_focus_out_event_cb)
self._add_widget(self.title)
2007-05-29 15:53:58 +02:00
activity.metadata.connect('updated', self._jobject_updated_cb)
separator = gtk.SeparatorToolItem()
separator.props.draw = False
separator.set_expand(True);
self.insert(separator, -1)
separator.show()
2007-04-27 22:07:38 +02:00
self.share = ToolButton('stock-share-mesh')
self.share.connect('clicked', self._share_clicked_cb)
self.insert(self.share, -1)
if activity.get_shared():
self.share.set_sensitive(False)
self.share.show()
separator = gtk.SeparatorToolItem()
separator.props.draw = False
self.insert(separator, -1)
separator.show()
self.close = ToolButton('window-close')
self.close.connect('clicked', self._close_clicked_cb)
self.insert(self.close, -1)
self.close.show()
def _share_clicked_cb(self, button):
self._activity.share()
def _close_clicked_cb(self, button):
self._activity.close()
def _jobject_updated_cb(self, jobject):
self.title.set_text(jobject['title'])
def _title_focus_out_event_cb(self, entry, event):
2007-05-29 15:53:58 +02:00
if self._activity.metadata['title'] != self.title.get_text():
self._activity.metadata['title'] = self.title.get_text()
self._activity.save()
def _add_widget(self, widget, expand=False):
tool_item = gtk.ToolItem()
tool_item.set_expand(expand)
tool_item.add(widget)
widget.show()
self.insert(tool_item, -1)
tool_item.show()
2007-04-27 22:07:38 +02:00
def _activity_shared_cb(self, activity):
self.share.set_sensitive(False)
class EditToolbar(gtk.Toolbar):
def __init__(self):
gtk.Toolbar.__init__(self)
self.undo = ToolButton('edit-undo')
self.insert(self.undo, -1)
self.undo.show()
self.redo = ToolButton('edit-redo')
self.insert(self.redo, -1)
self.redo.show()
separator = gtk.SeparatorToolItem()
separator.set_draw(True)
self.insert(separator, -1)
separator.show()
self.copy = ToolButton('edit-copy')
self.insert(self.copy, -1)
self.copy.show()
self.paste = ToolButton('edit-paste')
self.insert(self.paste, -1)
self.paste.show()
class ActivityToolbox(Toolbox):
def __init__(self, activity):
Toolbox.__init__(self)
2007-04-27 22:07:38 +02:00
self._activity_toolbar = ActivityToolbar(activity)
self.add_toolbar('Activity', self._activity_toolbar)
self._activity_toolbar.show()
def get_activity_toolbar(self):
return self._activity_toolbar
class Activity(Window, gtk.Container):
"""Base Activity class that all other Activities derive from."""
__gtype_name__ = 'SugarActivity'
2007-04-27 22:07:38 +02:00
__gsignals__ = {
'shared': (gobject.SIGNAL_RUN_FIRST, gobject.TYPE_NONE, ([])),
'joined': (gobject.SIGNAL_RUN_FIRST, gobject.TYPE_NONE, ([]))
2007-04-27 22:07:38 +02:00
}
__gproperties__ = {
'active': (bool, None, None, False, gobject.PARAM_READWRITE)
}
def __init__(self, handle, create_jobject=True):
"""Initialise the Activity
handle -- sugar.activity.activityhandle.ActivityHandle
instance providing the activity id and access to the
presence service which *may* provide sharing for this
application
create_jobject -- boolean
define if it should create a journal object if we are
not resuming
Side effects:
Sets the gdk screen DPI setting (resolution) to the
Sugar screen resolution.
Connects our "destroy" message to our _destroy_cb
method.
Creates a base gtk.Window within this window.
Creates an ActivityService (self._bus) servicing
this application.
"""
Window.__init__(self)
2006-12-24 02:51:37 +01:00
self.connect('destroy', self._destroy_cb)
self._active = False
self._activity_id = handle.activity_id
2007-04-09 20:40:56 +02:00
self._pservice = presenceservice.get_instance()
self._shared_activity = None
self._share_id = None
self._join_id = None
shared_activity = handle.get_shared_activity()
if shared_activity:
# Join an existing instance of this activity on the network
self._shared_activity = shared_activity
self._join_id = self._shared_activity.connect("joined", self._internal_joined_cb)
if not self._shared_activity.props.joined:
self._shared_activity.join()
else:
self._internal_joined_cb(self._shared_activity, True, None)
2007-02-21 20:15:39 +01:00
self._bus = ActivityService(self)
if handle.object_id:
2007-05-29 15:53:58 +02:00
self._jobject = datastore.get(handle.object_id)
self._jobject.object_id = ''
del self._jobject.metadata['ctime']
del self._jobject.metadata['mtime']
elif create_jobject:
logging.debug('Creating a jobject.')
2007-05-29 15:53:58 +02:00
self._jobject = datastore.create()
self._jobject.metadata['title'] = '%s %s' % (get_bundle_name(), 'Activity')
self._jobject.metadata['activity'] = self.get_service_name()
self._jobject.metadata['keep'] = '0'
self._jobject.metadata['buddies'] = ''
self._jobject.metadata['preview'] = ''
self._jobject.metadata['icon-color'] = profile.get_color().to_string()
self._jobject.file_path = ''
datastore.write(self._jobject,
reply_handler=self._internal_jobject_create_cb,
error_handler=self._internal_jobject_error_cb)
else:
2007-05-29 15:53:58 +02:00
self._jobject = None
def do_set_property(self, pspec, value):
if pspec.name == 'active':
if self._active != value:
self._active = value
2007-05-29 15:53:58 +02:00
if not self._active and self._jobject:
self.save()
def do_get_property(self, pspec):
if pspec.name == 'active':
return self._active
2007-05-29 15:53:58 +02:00
def set_canvas(self, canvas):
Window.set_canvas(self, canvas)
canvas.connect('map', self._canvas_map_cb)
def _canvas_map_cb(self, canvas):
if self._jobject and self._jobject.file_path:
self.read_file(self._jobject.file_path)
def _internal_jobject_create_cb(self):
pass
def _internal_jobject_error_cb(self, err):
logging.debug("Error creating activity datastore object: %s" % err)
2007-05-29 15:53:58 +02:00
def read_file(self, file_path):
"""
Subclasses implement this method if they support resuming objects from
2007-05-29 15:53:58 +02:00
the journal. 'file_path' is the file to read from.
"""
raise NotImplementedError
2007-05-29 15:53:58 +02:00
def write_file(self, file_path):
"""
Subclasses implement this method if they support saving data to objects
2007-05-29 15:53:58 +02:00
in the journal. 'file_path' is the file to write to.
"""
raise NotImplementedError
def _internal_save_cb(self):
pass
def _internal_save_error_cb(self, err):
logging.debug("Error saving activity object to datastore: %s" % err)
def save(self):
"""Request that the activity is saved to the Journal."""
try:
2007-05-29 15:53:58 +02:00
file_path = os.path.join('/tmp', '%i' % time.time())
self.write_file(file_path)
self._jobject.file_path = file_path
except NotImplementedError:
2007-05-29 15:53:58 +02:00
pass
datastore.write(self._jobject,
reply_handler=self._internal_save_cb,
error_handler=self._internal_save_error_cb)
def _internal_joined_cb(self, activity, success, err):
"""Callback when join has finished"""
self._shared_activity.disconnect(self._join_id)
self._join_id = None
if not success:
logging.debug("Failed to join activity: %s" % err)
return
self.present()
self.emit('joined')
def get_service_name(self):
"""Gets the activity service name."""
return os.environ['SUGAR_BUNDLE_SERVICE_NAME']
def get_shared(self):
"""Returns TRUE if the activity is shared on the mesh."""
if not self._shared_activity:
return False
return self._shared_activity.props.joined
def get_id(self):
"""Get the unique activity identifier."""
return self._activity_id
def _internal_share_cb(self, ps, success, activity, err):
self._pservice.disconnect(self._share_id)
self._share_id = None
if not success:
logging.debug('Share of activity %s failed: %s.' % (self._activity_id, err))
return
logging.debug('Share of activity %s successful.' % self._activity_id)
self._shared_activity = activity
2007-04-27 22:07:38 +02:00
self.emit('shared')
def share(self):
"""Request that the activity be shared on the network."""
2007-05-03 21:06:00 +02:00
if self._shared_activity and self._shared_activity.props.joined:
raise RuntimeError("Activity %s already shared." % self._activity_id)
logging.debug('Requesting share of activity %s.' % self._activity_id)
self._share_id = self._pservice.connect("activity-shared", self._internal_share_cb)
self._pservice.share_activity(self)
def execute(self, command, args):
"""Execute the given command with args"""
return False
2006-12-24 02:51:37 +01:00
def _destroy_cb(self, window):
"""Destroys our ActivityService and sharing service"""
if self._bus:
del self._bus
self._bus = None
if self._shared_activity:
self._shared_activity.leave()
def close(self):
2007-05-29 15:53:58 +02:00
if self._jobject:
try:
self.save()
except:
self.destroy()
raise
2007-04-27 22:07:38 +02:00
self.destroy()
2007-05-29 15:53:58 +02:00
def get_metadata(self):
if self._jobject:
return self._jobject.metadata
else:
return None
metadata = property(get_metadata, None)
2007-05-14 19:56:06 +02:00
def get_bundle_name():
"""Return the bundle name for the current process' bundle
"""
return os.environ['SUGAR_BUNDLE_NAME']
def get_bundle_path():
"""Return the bundle path for the current process' bundle
"""
return os.environ['SUGAR_BUNDLE_PATH']