Commit 86017f1f authored by Vincent Pelletier's avatar Vincent Pelletier

Add docstrings.

Fix and add comments.


git-svn-id: https://svn.erp5.org/repos/public/erp5/trunk@16179 20353a03-c40f-0410-a6d1-a30d3c3de9de
parent 7655fb4c
No related merge requests found
...@@ -372,19 +372,28 @@ class BaseTemplateItem(Implicit, Persistent): ...@@ -372,19 +372,28 @@ class BaseTemplateItem(Implicit, Persistent):
pass pass
def preinstall(self, context, installed_bt, **kw): def preinstall(self, context, installed_bt, **kw):
"""
Build a list of added/removed/changed files between the BusinessTemplate
being installed (self) and the installed one (installed_bt).
Note : we compare files between BTs, *not* between the installed BT and
the objects in the DataFS.
XXX: -12 used here is -len('TemplateItem')
"""
modified_object_list = {} modified_object_list = {}
if context.getTemplateFormatVersion() == 1: if context.getTemplateFormatVersion() == 1:
new_keys = self._objects.keys() new_keys = self._objects.keys()
for path in new_keys: for path in new_keys:
if installed_bt._objects.has_key(path): if installed_bt._objects.has_key(path):
# compare object to see it there is changes # compare objects to see it there are changes
new_obj_xml = self.generateXml(path=path) new_obj_xml = self.generateXml(path=path)
old_obj_xml = installed_bt.generateXml(path=path) old_obj_xml = installed_bt.generateXml(path=path)
if new_obj_xml != old_obj_xml: if new_obj_xml != old_obj_xml:
modified_object_list.update({path : ['Modified', self.__class__.__name__[:-12]]}) modified_object_list.update({path : ['Modified', self.__class__.__name__[:-12]]})
# else, compared versions are identical, don't overwrite the old one
else: # new object else: # new object
modified_object_list.update({path : ['New', self.__class__.__name__[:-12]]}) modified_object_list.update({path : ['New', self.__class__.__name__[:-12]]})
# get removed object # list removed objects
old_keys = installed_bt._objects.keys() old_keys = installed_bt._objects.keys()
for path in old_keys: for path in old_keys:
if path not in new_keys: if path not in new_keys:
...@@ -398,6 +407,12 @@ class BaseTemplateItem(Implicit, Persistent): ...@@ -398,6 +407,12 @@ class BaseTemplateItem(Implicit, Persistent):
pass pass
def remove(self, context, **kw): def remove(self, context, **kw):
"""
If 'remove' is chosen on an object containing subobjects, all the
subobjects will be removed too, even if 'backup' or 'keep' was chosen for
the subobjects.
Likewise, for 'save_and_remove' : subobjects will get saved too.
"""
remove_dict = kw.get('remove_object_dict', {}) remove_dict = kw.get('remove_object_dict', {})
keys = self._objects.keys() keys = self._objects.keys()
keys.sort() keys.sort()
...@@ -477,6 +492,10 @@ class ObjectTemplateItem(BaseTemplateItem): ...@@ -477,6 +492,10 @@ class ObjectTemplateItem(BaseTemplateItem):
self._archive["%s/%s" % (tool_id, id)] = None self._archive["%s/%s" % (tool_id, id)] = None
def export(self, context, bta, **kw): def export(self, context, bta, **kw):
"""
Export the business template : fill the BusinessTemplateArchive with
objects exported as XML, hierarchicaly organised.
"""
if len(self._objects.keys()) == 0: if len(self._objects.keys()) == 0:
return return
root_path = os.path.join(bta.path, self.__class__.__name__) root_path = os.path.join(bta.path, self.__class__.__name__)
...@@ -498,6 +517,7 @@ class ObjectTemplateItem(BaseTemplateItem): ...@@ -498,6 +517,7 @@ class ObjectTemplateItem(BaseTemplateItem):
bta.addObject(obj=f.getvalue(), name=id, path=path) bta.addObject(obj=f.getvalue(), name=id, path=path)
def build_sub_objects(self, context, id_list, url, **kw): def build_sub_objects(self, context, id_list, url, **kw):
# XXX duplicates code from build
p = context.getPortalObject() p = context.getPortalObject()
sub_list = {} sub_list = {}
for id in id_list: for id in id_list:
...@@ -505,9 +525,9 @@ class ObjectTemplateItem(BaseTemplateItem): ...@@ -505,9 +525,9 @@ class ObjectTemplateItem(BaseTemplateItem):
obj = p.unrestrictedTraverse(relative_url) obj = p.unrestrictedTraverse(relative_url)
obj = obj._getCopy(context) obj = obj._getCopy(context)
obj = self.removeProperties(obj) obj = self.removeProperties(obj)
id_list = obj.objectIds() id_list = obj.objectIds() # FIXME duplicated variable name
if hasattr(aq_base(obj), 'groups'): if hasattr(aq_base(obj), 'groups'): # XXX should check metatype instead
# we must keep groups because it's ereased when we delete subobjects # we must keep groups because they are deleted along with subobjects
groups = deepcopy(obj.groups) groups = deepcopy(obj.groups)
if id_list: if id_list:
self.build_sub_objects(context, id_list, relative_url) self.build_sub_objects(context, id_list, relative_url)
...@@ -534,8 +554,8 @@ class ObjectTemplateItem(BaseTemplateItem): ...@@ -534,8 +554,8 @@ class ObjectTemplateItem(BaseTemplateItem):
_recursiveRemoveUid(obj) _recursiveRemoveUid(obj)
obj = self.removeProperties(obj) obj = self.removeProperties(obj)
id_list = obj.objectIds() id_list = obj.objectIds()
if hasattr(aq_base(obj), 'groups'): if hasattr(aq_base(obj), 'groups'): # XXX should check metatype instead
# we must keep groups because it's erased when we delete subobjects # we must keep groups because they are deleted along with subobjects
groups = deepcopy(obj.groups) groups = deepcopy(obj.groups)
if len(id_list) > 0: if len(id_list) > 0:
self.build_sub_objects(context, id_list, relative_url) self.build_sub_objects(context, id_list, relative_url)
...@@ -561,6 +581,7 @@ class ObjectTemplateItem(BaseTemplateItem): ...@@ -561,6 +581,7 @@ class ObjectTemplateItem(BaseTemplateItem):
self._objects[file_name[:-4]] = obj self._objects[file_name[:-4]] = obj
def preinstall(self, context, installed_bt, **kw): def preinstall(self, context, installed_bt, **kw):
#XXX -12 used here is -len('TemplateItem')
modified_object_list = {} modified_object_list = {}
if context.getTemplateFormatVersion() == 1: if context.getTemplateFormatVersion() == 1:
portal = context.getPortalObject() portal = context.getPortalObject()
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment