Web   ·   Wiki   ·   Activities   ·   Blog   ·   Lists   ·   Chat   ·   Meeting   ·   Bugs   ·   Git   ·   Translate   ·   Archive   ·   People   ·   Donate
summaryrefslogtreecommitdiffstats
path: root/src/sugar/activity/activityhandle.py
blob: ac4ee0b2d5ab181e9a15aae597bedf5987d86d70 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
# Copyright (C) 2006-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.

"""
STABLE.
"""
import logging


class ActivityHandle(object):
    """Data structure storing simple activity metadata"""
    def __init__(
        self, activity_id=None, object_id=None, uri=None
    ):
        """Initialise the handle from activity_id
        
        activity_id -- unique id for the activity to be
            created
        object_id -- tuple of tree_id and version_id of
            the journal object associated with the activity.

            When you resume an activity from the journal 
            the tree_id and version_id will be passed in.
            It's optional since new activities do not have an
            associated object (yet).
        uri -- URI associated with the activity. Used when 
            opening an external file or resource in the 
            activity, rather than a journal object 
            (downloads stored on the file system for 
            example or web pages)
        """
        self.activity_id = activity_id
        self.object_id = object_id
        self.uri = uri

    def get_dict(self):
        """Retrieve our settings as a dictionary"""
        result = { 'activity_id' : self.activity_id }
        if self.tree_id:
            result['object_id'] = self.object_id
            result['tree_id'] = self.tree_id
            result['version_id'] = self.version_id
        if self.uri:
            result['uri'] = self.uri

        return result

    def get_object_id(self) :
        logging.debug("AH.get_object_id %r %r" % (self.tree_id, self.version_id))
        if self.tree_id is None and self.version_id is None :
            logging.debug("AH.get_object_id returning None")
            return None

        return (self.tree_id, self.version_id)

    def set_object_id(self, object_id) :
        self.tree_id, self.version_id = object_id or (None, None)

    object_id = property(get_object_id, set_object_id)


def create_from_dict(handle_dict):
    """Create a handle from a dictionary of parameters"""
    if handle_dict.get('object_id') :
        handle_dict = dict(handle_dict)
        handle_dict['tree_id'], handle_dict['version_id'] = handle_dict['object_id']

    result = ActivityHandle(
        handle_dict['activity_id'],
        object_id = (handle_dict.get('tree_id'),
                     handle_dict.get('version_id')),
        uri = handle_dict.get('uri'),
    )
    return result