Web   ·   Wiki   ·   Activities   ·   Blog   ·   Lists   ·   Chat   ·   Meeting   ·   Bugs   ·   Git   ·   Translate   ·   Archive   ·   People   ·   Donate
summaryrefslogtreecommitdiffstats
path: root/src/sugar/tutorius/bundler.py
blob: 2026fb3a059eebade70cd2b28119291df5cc8a13 (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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
# Copyright (C) 2009, Tutorius.org
# Copyright (C) 2009, Jean-Christophe Savard <savard.jean.christophe@gmail.com>
#
# 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


"""
This module contains all the data handling class of Tutorius  
"""

import logging
import os
import uuid
import xml.dom.minidom

from sugar.tutorius import gtkutils, overlayer
from sugar.tutorius.core import Tutorial, State, FiniteStateMachine
from sugar.tutorius.actions import DialogMessage, OnceWrapper, BubbleMessage
from sugar.tutorius.filters import GtkWidgetEventFilter, TimerEvent
from ConfigParser import SafeConfigParser

def __get_store_root():
    return os.path.join(os.getenv("SUGAR_PREFIX"),"share","tutorius","data")
def __get_bundle_root():
    return os.path.join(os.getenv("SUGAR_BUNDLE_PATH"),"data","tutorius","data")

INI_ACTIVITY_SECTION = "RELATED_ACTIVITIES"
INI_METADATA_SECTION = "GENERAL_METADATA"
INI_GUID_PROPERTY = "GUID"
INI_NAME_PROPERTY = "NAME"
INI_XML_FSM_PROPERTY = "FSM_FILENAME"

class TutorialStore:
        
    def list_avaible_tutorials(self, activity_name, activity_vers):
        """
        Recuperate the list of all tutorials present on disk for a
        given activity.
        """
        
        store_root = __get_store_root()
        bundle_root = __get_bundle_root()
        
        logging.debug("***********   Path of store_root : " + store_root)
        
        # Create /data/tutorius if no exists
        if not os.path.exists(store_root):
            os.mkdir(store_root)
            logging.debug("*************   Creating %s folder" % store_root)
            
        tutoGuidName = {}
        
        # iterate in each GUID subfolder
        for dir in os.listdir(store_root):
            # iterate for each ".ini" file in the activity store_root folder        
            for file_name in os.listdir(store_root + "/" + dir):
                
                if file_name.endswith(".ini"):
                    logging.debug("**************  .ini file found : " + file_name)
                    # Filter for just .ini files who metadata ACTIVITY_NAME
                    # match 'activity_name' given in argument.
                    config = SafeConfigParser()
                    config.read(file_name)
                    # Get all activity tuples (Activity_Name: Activity_Version)
                    file_activity_tuples = config.items(INI_ACTIVITY_SECTION)
                    
                    for i in range(0, len(file_activity_tuples) - 1):
                        
                        if file_activity_tuples[i][0] == activity_name and  \
                        int(file_activity_tuples[i][1]) == activity_vers:
                            # Add this tutorial guid and name in the dictionary
                            file_activity_guid = config.get(INI_METADATA_SECTION,
                                INI_GUID_PROPERTY)
                            file_activity_name = config.get(INI_METADATA_SECTION,
                                INI_NAME_PROPERTY)
                            tutoGuidName[file_activity_name] = file_activity_guid

        return tutoGuidName
    

class Serializer:
    """
    Interface that provide serializing and deserializing of the FSM
    used in the tutorials to/from disk. Must be inherited.
    """
    
    def save_fsm(self,fsm, guid = None):
        """
        Save fsm to disk. If a GUID parameter is provided, the existing GUID is
        located in the .ini files in the store root and bundle root and
        the corresponding FSM is/are overwritten. If the GUId is not found, an 
        exception occur. If no GUID is provided, FSM is written in a new file 
        in the store root.
        """
        NotImplementedError
        
    def load_fsm(self, guid):
        """
        Load fsm from disk.
        """
        NotImplementedError
        
class XMLSerializer(Serializer):
    """
    Class that provide serializing and deserializing of the FSM
    used in the tutorials to/from a .xml file. Inherit from Serializer
    """
    
    
    
    def save_fsm(self,fsm, xml_filename, path):
        """
        Save fsm to disk, in the xml file specified by "xml_filename", in the 
        "path" folder. If the specified file dont exist, it will be created.
        """ 
        fsm_xml = xml.dom.minidom.Document()
        fsm_element = doc.createElementNS("http://tutorius.org", "FSM")
        fsm_xml.appendChild(fsm_element)
        fsm_element.setAttributeNS("http://tutorius.org", "fsm:Name", fsm.name)
        fsm_element.setAttributeNS("http://tutorius.org", "fsm:StartStateName", fsm.start_state_name)
        
        
        _element = doc.createElementNS("http://tutorius.org", "fsm")
        tutorial_element.appendChild(fsm_element)
        
        
##        logging.debug("************ found .tml file : " + file_name)
##        key_line = linecache.getline(path + file_name, 1)
##        key_line = key_line.split("\n")[0]
##        fileKey = key_line.split("--KEY::")[1]
##        logging.debug("************ fileKey = " + fileKey)
##        if key == fileKey:
##            logging.debug("************ Key : " + key + \
##                " = fileKey : " + fileKey)
##            tml = file(path + file_name, "r")
##            str = tml.read()
##            pick = str.split("--PICKLE::")[1]
##            
##            fsm = pickle.loads(pick)
##        tuto = {key:Tutorial(key,fsm)}
##
##        return tuto

    
    def load_fsm(self, guid):
        """
        Load fsm from xml file who .ini file guid match argument guid.
        """
##        
##        path = os.getenv("SUGAR_ACTIVITY_ROOT") + "/data/"
##        # Create /data/ folder if no exists
##        if not os.path.exists(path):
##            os.mkdir(path)
##            logging.debug("*************   Creating data folder")
##        
##        # Save the dictionnary to .tml file
##        tutoSave = file(path + filename + ".tml", 'w')
##        str = "--KEY::" + key + "\n--NAME::" + name + "\n--PICKLE::" + \
##            pickle.dumps(fsm,0)
##        tutoSave.write(str)
##        tutoSave.close()
        
        
class TutorialBundler:
    """
    This class provide the various data handling methods useable by the tutorial
    editor.
    """
    
    
    
    def __init__(self,generated_guid = None):
        """
        TODO.
        Tutorial_bundler constructor. If a GUID is given in the parameter, the
        Tutorial_bundler object will be associated with it. If no GUID is given,
        a new GUID will be generated,
        """
        self.__guid = generated_guid or uuid.uuid1()
        
    def __SetGuid(self, value):
        self.__guid = value
        
    def __GetGuid(self):
        return self.__guid
        
    def __DelGuid(self):
        del self.__guid
        
    def __SetPath(self, value):
        self.__path = value
        
    def __GetPath(self):
        return self.__path
        
    def __DelPath(self):
        del self.__path
        
    Guid = property(fget=__SetGuid,
                        fset=__GetGuid,
                        fdel=__DelGuid,
                        doc="The guid associated with the Tutoria_Bundler")
                        
    Path = property(fget=__SetPath,
                        fset=__GetPath,
                        fdel=__DelPath,
                        doc="The path associated with the Tutoria_Bundler")
        
        
    def write_metadata_file(self, data):
        """
        Write metadata to a property file. If a GUID is provided, TutorialBundler
        will try to find and overwrite the existing property file who contain the 
        given GUID, and will raise an exception if it cannot find it.
        """
        NotImplementedError
        
    def get_tutorial_path(self):
        """
        Return the path of the .ini file associated with the guiven guid set in
        the Guid property of the Tutorial_Bundler. If the guid is present in 
        more than one path, the store_root is given priority.
        """
        
        store_root = __get_store_root()
        bundle_root = __get_bundle_root()
        
        config = SafeConfigParser()
        path = None
        
        logging.debug("************ Path of store_root folder of activity : " \
            + store_root)
            
        # iterate in each GUID subfolder
        for dir in os.listdir(store_root):
            
            # iterate for each .ini file in the store_root folder
                            
            for file_name in os.listdir(store_root + "/" + dir):
                if file_name.endswith(".ini"):
                    logging.debug("******************* Found .ini file : " \
                        + file_name)
                    config.read(file_name)
                    if config.get(INI_METADATA_SECTION, INI_GUID_PROPERTY) == self.Guid:
                        xml_filename = config.get(INI_METADATA_SECTION,
                            INI_XML_FSM_PROPERTY)
                        
                        path = os.path.join(store_root, self.Guid)
                        return path
            
        logging.debug("************ Path of bundle_root folder of activity : " \
            + bundle_root)
            
                   
        # iterate in each GUID subfolder
        for dir in os.listdir(bundle_root):    
            
            # iterate for each .ini file in the bundle_root folder
            for file_name in os.listdir(bundle_root + "/" + dir):
                if file_name.endswith(".ini"):
                    logging.debug("******************* Found .ini file : " \
                        + file_name)
                    config.read(file_name)
                    if config.get(INI_METADATA_SECTION, INI_GUID_PROPERTY) == guid:
                        path = os.path.join(bundle_root, self.Guid)
                        return path
                
        if path is None:
            logging.debug("**************** Error : GUID not found")
            raise KeyError

    def write_fsm(self, fsm, guid=None):

        """
        Save fsm to disk. If a GUID parameter is provided, the existing GUID is
        located in the .ini files in the store root and bundle root and
        the corresponding FSM is/are created or overwritten. If the GUID is not 
        found, an exception occur.
        """ 
        
        config = SafeConfigParser()
                   
        if guid is not None:
            path = get_tutorial_path() + "/meta.ini"
            config.read(path)
            xml_filename = config.get(INI_METADATA_SECTION, INI_XML_FSM_PROPERTY)
            save_fsm(fsm, xml_filename, store_root)
            
        
    def add_resources(self, typename, file):
        """
        Add ressources to metadata.
        """
        raise NotImplementedError("add_resources not implemented")