############################################################################## # # Copyright (c) 2002 Nexedi SARL and Contributors. All Rights Reserved. # Jean-Paul Smets-Solanes <jp@nexedi.com> # # WARNING: This program as such is intended to be used by professional # programmers who take the whole responsability of assessing all potential # consequences resulting from its eventual inadequacies and bugs # End users who are looking for a ready-to-use solution with commercial # garantees and support are strongly adviced to contract a Free Software # Service Company # # 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. # ############################################################################## from Globals import Persistent, PersistentMapping from Acquisition import Implicit, aq_base from AccessControl.Permission import Permission from AccessControl import ClassSecurityInfo from Products.CMFCore.utils import getToolByName from Products.CMFCore.WorkflowCore import WorkflowMethod from Products.ERP5Type import Permissions, PropertySheet, Constraint, Interface from Products.ERP5Type.Utils import readLocalPropertySheet, \ writeLocalPropertySheet, \ importLocalPropertySheet, \ removeLocalPropertySheet from Products.ERP5Type.Utils import readLocalExtension, writeLocalExtension, \ removeLocalExtension from Products.ERP5Type.Utils import readLocalTest, writeLocalTest, \ removeLocalTest from Products.ERP5Type.Utils import readLocalDocument, writeLocalDocument, \ importLocalDocument, removeLocalDocument from Products.ERP5Type.XMLObject import XMLObject import fnmatch import re, os, sys, string, tarfile from Products.ERP5Type.Cache import clearCache from DateTime import DateTime from OFS.Traversable import NotFound from OFS import XMLExportImport from cStringIO import StringIO import difflib from copy import deepcopy from App.config import getConfiguration import OFS.XMLExportImport customImporters={ XMLExportImport.magic: XMLExportImport.importXML, } from zLOG import LOG from OFS.ObjectManager import customImporters from gzip import GzipFile import tarfile class BusinessTemplateArchive: """ This is the base class for all Business Template archives """ def __init__(self, creation=0, importing=0, file=None, path=None, **kw): if creation: self._initCreation(path=path, **kw) elif importing: self._initImport(file=file, path=path, **kw) def addFolder(self, **kw): pass def addObject(self, *kw): pass def finishCreation(self, **kw): pass class BusinessTemplateFolder(BusinessTemplateArchive): """ Class archiving businnes template into a folder tree """ def _initCreation(self, path): self.path = path try: os.makedirs(self.path) except OSError: # folder already exists, remove it os.system('rm -rf %s' %(self.path)) os.makedirs(self.path) def addFolder(self, name=''): if name !='': path = os.path.join(self.path, name) try: os.makedirs(path) except OSError: pass return path def addObject(self, object, name, path=None, ext='.xml'): if path is None: object_path = os.path.join(self.path, name) else: object_path = os.path.join(path, name) f = open(object_path+ext, 'wt') if ext == '.txt':# write one item per line for item in object: f.write(str(item)+'\n') else: f.write(str(object)) f.close() def _initImport(self, file=None, path=None, **kw): self.file_list = file # to make id consistent constent, must remove a part of path while importing self.root_path_len = len(string.split(path, '/')) - 1 def importFile(self, klass, **kw): """ Import file from a local folder """ class_name = klass.__class__.__name__ for file_name in self.file_list: if class_name in file_name: if os.path.isfile(file_name): file = open(file_name, 'r') # get object id folders = string.split(file_name, '/') file_name = string.join(folders[self.root_path_len:], '/') ext = string.split(folders[-1], '.')[-1] if ext == 'xml': # import xml file obj = klass connection = None while connection is None: obj=obj.aq_parent connection=obj._p_jar obj = connection.importFile(file, customImporters=customImporters) klass._objects[file_name[:-4]] = obj elif ext == 'txt' and class_name == 'PortalTypeTemplateItem': # import workflow chain dict = {} item = file.readline() while item != '': id, value = item.split(' : ') dict[id] = value[:-1] item = file.readline() klass._workflow_chain_archive = dict elif ext == 'txt' and class_name == 'CatalogMethodTemplateItem': # recreate data mapping specific to catalog method id = string.split(folders[-1], '.')[0] item = file.readline() klass._is_catalog_method_archive[id] = item[:-1] item = file.readline() klass._is_catalog_list_method_archive[id] = item[:-1] item = file.readline() klass._is_uncatalog_method_archive[id] = item[:-1] item = file.readline() klass._is_update_method_archive[id] = item[:-1] item = file.readline() klass._is_clear_method_archive[id] = item[:-1] item = file.readline() klass._is_filtered_archive[id] = item[:-1] item = file.readline() if item != '': klass._filter_expression_archive[id] = item[:-1] item = file.readline() klass._filter_expression_instance_archive[id] = item[:-1] item = file.readline() klass._filter_type_archive[id] = item[:-1] elif ext == 'txt' and class_name == 'SitePropertyTemplateItem': # recreate list of stite property from text file list = [] item = file.readline() type = item[:-1] item = file.readline() while item != '': list.append(item[:-1]) item = file.readline() klass._objects[file_name[:-4]] = (type, list) elif ext == 'txt': # recreate list from text file list = [] item = file.readline() while item != '': list.append(item) item = file.readline() klass._objects[file_name[:-4]] = list elif ext == 'py' or ext == 'po': # make a copy of python code or translation file text = file.read() klass._objects[file_name[:-3]]=text # close file file.close class BusinessTemplateTarball(BusinessTemplateArchive): """ Class archiving businnes template into a tarball file """ def _initCreation(self, path): # make tmp dir, maybe use temp module or better with stringIO self.path = path try: os.makedirs(self.path) except OSError: # folder already exists, remove it os.system('rm -rf %s' %(self.path)) os.makedirs(self.path) # init tarfile obj self.fobj = StringIO() self.tar = tarfile.open('', 'w:gz', self.fobj) def addFolder(self, name=''): try: os.makedirs(name) except OSError: pass def addObject(self, object, name, path=None, ext='.xml'): if path is None: object_path = os.path.join(self.path, name) else: object_path = os.path.join(path, name) f = open(object_path+ext, 'wt') if ext == '.txt':# write one item per line for item in object: f.write(str(item)+'\n') else: f.write(str(object)) f.close() def finishCreation(self): self.tar.add(self.path) self.tar.close() os.system('rm -rf %s' %(self.path)) return self.fobj def _initImport(self, file=None, **kw): self.f = file def importFile(self, klass, **kw): """ Import all file from the archive to the site """ class_name = klass.__class__.__name__ self.f.seek(0) data = GzipFile(fileobj=self.f).read() io = StringIO(data) tar = tarfile.TarFile(fileobj=io) for info in tar.getmembers(): if class_name in info.name: if info.isreg(): file = tar.extractfile(info) folder, name = os.path.split(info.name) ext = string.split(name, '.')[-1] if ext == 'xml': # import xml file obj = klass connection = None while connection is None: obj=obj.aq_parent connection=obj._p_jar obj = connection.importFile(file, customImporters=customImporters) klass._objects[info.name[:-4]] = obj elif ext == 'txt' and class_name == 'PortalTypeTemplateItem': # import workfow chain for portal type dict = {} item = file.readline() while item != '': id, value = item.split(' : ') dict[id] = value[:-1] item = file.readline() klass._workflow_chain_archive = dict elif ext == 'txt' and class_name == 'CatalogMethodTemplateItem': # recreate data mapping specific to catalog method id = string.split(name, '.')[0] item = file.readline() klass._is_catalog_method_archive[id] = item[:-1] item = file.readline() klass._is_catalog_list_method_archive[id] = item[:-1] item = file.readline() klass._is_uncatalog_method_archive[id] = item[:-1] item = file.readline() klass._is_update_method_archive[id] = item[:-1] item = file.readline() klass._is_clear_method_archive[id] = item[:-1] item = file.readline() klass._is_filtered_archive[id] = item[:-1] item = file.readline() if item != '': klass._filter_expression_archive[id] = item[:-1] item = file.readline() klass._filter_expression_instance_archive[id] = item[:-1] item = file.readline() klass._filter_type_archive[id] = item[:-1] elif ext == 'txt' and class_name == 'SitePropertyTemplateItem': # recreate list of site property from text file list = [] item = file.readline() type = item[:-1] item = file.readline() while item != '': list.append(item[:-1]) item = file.readline() klass._objects[info.name[:-4]] = (type, list) elif ext == 'txt': # recreate list from text file klass._objects[info.name[:-4]] = [] item = file.readline() while item != '': klass._objects[info.name[:-4]].append(item[:-1]) item = file.readline() elif ext == 'py' or ext == 'po': # make a copy of python code or translation file text = file.read() klass._objects[info.name[:-3]]=text # close file file.close() tar.close() io.close() class TemplateConflictError(Exception): pass class BaseTemplateItem(Implicit, Persistent): """ This class is the base class for all template items. """ def __init__(self, id_list, **kw): self.__dict__.update(kw) self._archive = PersistentMapping() self._objects = PersistentMapping() for id in id_list: if not id: continue self._archive[id] = None def build(self, context, **kw): pass def _backupObject(self, container, object_id, **kw): container_ids = container.objectIds() n = 0 new_object_id = object_id while new_object_id in container_ids: n = n + 1 new_object_id = '%s_btsave_%s' % (object_id, n) container.manage_renameObject(object_id, new_object_id) def install(self, context, tar=0, **kw): if tar: groups = {} portal = context.getPortalObject() # sort to add objects before their subobjects keys = self._objects.keys() keys.sort() for path in keys: container_path = path.split('/')[2:-1] object_id = path.split('/')[-1] container = portal.unrestrictedTraverse(container_path) container_ids = container.objectIds() if object_id in container_ids: # Object already exists self._backupObject(container, object_id) object = self._objects[path] if hasattr(object, 'groups'): # we must keep original order groups because they change when we add subobjects groups[path] = deepcopy(object.groups) object = object._getCopy(container) container._setObject(object_id, object) object = container._getOb(object_id) object.manage_afterClone(object) object.wl_clearLocks() if object.meta_type in ('Z SQL Method',): # It is necessary to make sure that the sql connection # in this method is valid. sql_connection_list = portal.objectIds(spec=('Z MySQL Database Connection',)) if object.connection_id not in sql_connection_list: object.connection_id = sql_connection_list[0] # now put original order group for path in groups.keys(): object = portal.unrestrictedTraverse(path.split('/')[2:]) object.groups = groups[path] def uninstall(self, context, **kw): pass def trash(self, context, new_item, **kw): # trash is quite similar to uninstall. return self.uninstall(context, new_item=new_item, trash=1, **kw) def diff(self, **kw): return '' def export(self, context, bta, **kw): if len(self._objects.keys()) == 0: return root_path = os.path.join(bta.path, self.__class__.__name__) for key in self._objects.keys(): object=self._objects[key] # create folder and subfolders folders, id = os.path.split(key) path = os.path.join(root_path, folders) bta.addFolder(name=path) # export object in xml f=StringIO() XMLExportImport.exportXML(object._p_jar, object._p_oid, f) bta.addObject(object=f.getvalue(), name=id, path=path) def importFile(self, bta, **kw): bta.importFile(klass=self) class ObjectTemplateItem(BaseTemplateItem): """ This class is used for generic objects and as a subclass. """ def __init__(self, id_list, tool_id=None, **kw): BaseTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw) if tool_id is not None: id_list = self._archive.keys() self._archive.clear() for id in id_list: self._archive["%s/%s" % (tool_id, id)] = None def build_sub_objects(self, context, id_list, url, **kw): p = context.getPortalObject() sub_list = {} for id in id_list: relative_url = url+'/'+id object = p.unrestrictedTraverse(relative_url) object = object._getCopy(context) id_list = object.objectIds() if hasattr(object, 'groups'): # we must keep groups because it's ereased when we delete subobjects groups = deepcopy(object.groups) if len(id_list) > 0: self.build_sub_objects(context, id_list, relative_url) object.manage_delObjects(list(id_list)) if hasattr(object, 'uid'): object.uid = None if hasattr(object, 'groups'): object.groups = groups self._objects[relative_url] = object object.wl_clearLocks() return sub_list def build(self, context, **kw): if len(self._archive.keys()) == 0: return BaseTemplateItem.build(self, context, **kw) p = context.getPortalObject() for relative_url in self._archive.keys(): object = p.unrestrictedTraverse(relative_url) object = object._getCopy(context) id_list = object.objectIds() if hasattr(object, 'groups'): # we must keep groups because it's ereased when we delete subobjects groups = deepcopy(object.groups) if len(id_list) > 0: self.build_sub_objects(context, id_list, relative_url) object.manage_delObjects(list(id_list)) if hasattr(object, 'uid'): object.uid = None if hasattr(object, 'groups'): object.groups = groups self._objects[relative_url] = object object.wl_clearLocks() def _backupObject(self, container, object_id, **kw): container_ids = container.objectIds() n = 0 new_object_id = object_id while new_object_id in container_ids: n = n + 1 new_object_id = '%s_btsave_%s' % (object_id, n) # XXX manage_renameObject is not in ERP5 API. Use setId. container.manage_renameObject(object_id, new_object_id) # Returned ID of the backuped object return new_object_id def install(self, context, tar=0, **kw): if tar: BaseTemplateItem.install(self, context, tar=1, **kw) else: BaseTemplateItem.install(self, context, **kw) portal = context.getPortalObject() for relative_url,object in self._archive.items(): container_path = relative_url.split('/')[0:-1] object_id = relative_url.split('/')[-1] container = portal.unrestrictedTraverse(container_path) container_ids = container.objectIds() if object_id in container_ids: # Object already exists self._backupObject(container, object_id) # Set a hard link object = object._getCopy(container) container._setObject(object_id, object) object = container._getOb(object_id) object.manage_afterClone(object) object.wl_clearLocks() if object.meta_type in ('Z SQL Method',): # It is necessary to make sure that the sql connection # in this method is valid. sql_connection_list = portal.objectIds( spec=('Z MySQL Database Connection',)) if object.connection_id not in sql_connection_list: object.connection_id = sql_connection_list[0] def uninstall(self, context, **kw): portal = context.getPortalObject() trash = kw.get('trash', 0) for relative_url in self._archive.keys(): container_path = relative_url.split('/')[0:-1] object_id = relative_url.split('/')[-1] try: container = portal.unrestrictedTraverse(container_path) if trash: self._backupObject(container, object_id) else: if object_id in container.objectIds(): container.manage_delObjects([object_id]) except: pass BaseTemplateItem.uninstall(self, context, **kw) def _compareObjects(self, object1, object2, btsave_object_included=0): """ Execute a diff between 2 objects, and return a string diff. """ xml_dict = { str(object1): None, str(object2): None, } # Generate XML for object in (object1, object2): string_io = StringIO() XMLExportImport.exportXML(object._p_jar, object._p_oid, string_io) object_xml = string_io.getvalue() string_io.close() object_xml_lines = object_xml.splitlines(1) xml_dict[str(object)] = object_xml_lines # Make diff between XML diff_instance = difflib.Differ() diff_list = list(diff_instance.compare(xml_dict[str(object1)], xml_dict[str(object2)])) diff_list = [x for x in diff_list if x[0] != ' '] # Dirty patch to remove useless diff message (id different) if btsave_object_included==1: if len(diff_list) == 3: if '_btsave_' in diff_list[1]: diff_list = [] # Return string result = '%s' % ''.join(diff_list) return result def diff(self, archive_variable='_archive', max_deep=0, verbose=0): """ Show all __btsave__ created, and make a diff between the current and the old version. """ result = '' portal = self.getPortalObject() # Browse all items stored for relative_url, object in getattr(self, archive_variable).items(): object = portal.unrestrictedTraverse(relative_url) container_path = relative_url.split('/')[0:-1] object_id = relative_url.split('/')[-1] container = portal.unrestrictedTraverse(container_path) container_ids = container.objectIds() # Search _btsave_ object compare_object_couple_list = [] btsave_id_list = [] n = 1 new_object_id = '%s_btsave_%s' % (object_id, n) while new_object_id in container_ids: # Found _btsave_ object btsave_id_list.append(new_object_id) compare_object_couple_list.append( (object, portal.unrestrictedTraverse( container_path+[new_object_id]))) n += 1 new_object_id = '%s_btsave_%s' % (object_id, n) if n == 1: result += "$$$ Added: %s $$$\n" % \ ('/'.join(container_path+[object_id])) result += '%s\n' % ('-'*80) # Find all objects to compare deep = 0 while deep != max_deep: new_compare_object_couple_list = [] for new_object, btsave_object in compare_object_couple_list: btsave_object_content_id_list = btsave_object.objectIds() for new_object_content_id in new_object.objectIds(): if new_object_content_id in btsave_object_content_id_list: new_compare_object_couple_list.append( (getattr(new_object, new_object_content_id), getattr(btsave_object, new_object_content_id))) btsave_object_content_id_list.remove(new_object_content_id) else: result += "$$$ Added: %s/%s $$$\n" % \ (new_object.absolute_url(), new_object_content_id) result += '%s\n' % ('-'*80) for btsave_object_id in btsave_object_content_id_list: result += "$$$ Removed: %s/%s $$$\n" % \ (btsave_object.absolute_url(), btsave_object_id) result += '%s\n' % ('-'*80) if new_compare_object_couple_list == []: deep = max_deep else: compare_object_couple_list = new_compare_object_couple_list deep += 1 # Now, we can compare all objects requested for new_object, btsave_object in compare_object_couple_list: tmp_diff = self._compareObjects(new_object, btsave_object, btsave_object_included=1) if tmp_diff != '': result += "$$$ %s $$$\n$$$ %s $$$\n" % \ (new_object.absolute_url(), btsave_object.absolute_url()) if verbose == 1: result += tmp_diff result += '%s\n' % ('-'*80) return result class PathTemplateItem(ObjectTemplateItem): """ This class is used to store objects with wildcards supported. """ def __init__(self, id_list, tool_id=None, **kw): BaseTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw) id_list = self._archive.keys() self._archive.clear() self._path_archive = PersistentMapping() for id in id_list: self._path_archive[id] = None def _resolvePath(self, folder, relative_url_list, id_list): """ This method calls itself recursively. The folder is the current object which contains sub-objects. The list of ids are path components. If the list is empty, the current folder is valid. """ if len(id_list) == 0: return ['/'.join(relative_url_list)] id = id_list[0] if re.search('[\*\?\[\]]', id) is None: # If the id has no meta character, do not have to check all objects. object = folder._getOb(id) return self._resolvePath(object, relative_url_list + [id], id_list[1:]) path_list = [] for object_id in fnmatch.filter(folder.objectIds(), id): path_list.extend(self._resolvePath(folder._getOb(object_id), relative_url_list + [object_id], id_list[1:])) return path_list def build(self, context, **kw): if len(self._path_archive.keys()) == 0: return BaseTemplateItem.build(self, context, **kw) p = context.getPortalObject() for path in self._path_archive.keys(): for relative_url in self._resolvePath(p, [], path.split('/')): object = p.unrestrictedTraverse(relative_url) object = object._getCopy(context) if hasattr(object, 'uid'): object.uid = None self._objects[relative_url] = object object.wl_clearLocks() class CategoryTemplateItem(ObjectTemplateItem): def __init__(self, id_list, tool_id='portal_categories', **kw): ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw) def install(self, context, light_install = 0, tar = 0, **kw): if tar: if light_install==0: # commit transaction to avoid mysql lock when installing BT in unit test # get_transaction().commit() ObjectTemplateItem.install(self, context, tar, **kw) else: portal = context.getPortalObject() category_tool = portal.portal_categories tool_id = self.tool_id keys = self._objects.keys() keys.sort() for path in keys: # Wrap the object by an aquisition wrapper for _aq_dynamic. object = self._objects[path] object = object.__of__(category_tool) container_path = path.split('/')[2:-1] category_id = path.split('/')[-1] container = category_tool.unrestrictedTraverse(container_path) container_ids = container.objectIds() if category_id in container_ids: # Object already exists self._backupObject(container, category_id) category = container.newContent(portal_type=object.getPortalType(), id=category_id) for property in object.propertyIds(): if property not in ('id', 'uid'): category.setProperty(property, object.getProperty(property, evaluate=0)) else: BaseTemplateItem.install(self, context, **kw) portal = context.getPortalObject() category_tool = portal.portal_categories tool_id = self.tool_id if light_install==0: ObjectTemplateItem.install(self, context, **kw) else: for relative_url,object in self._archive.items(): # Wrap the object by an aquisition wrapper for _aq_dynamic. object = object.__of__(category_tool) container_path = relative_url.split('/')[0:-1] category_id = relative_url.split('/')[-1] container = category_tool.unrestrictedTraverse(container_path) container_ids = container.objectIds() if category_id in container_ids: # Object already exists self._backupObject(container, category_id) category = container.newContent(portal_type=object.getPortalType(), id=category_id) for property in object.propertyIds(): if property not in ('id', 'uid'): category.setProperty(property, object.getProperty(property, evaluate=0)) class SkinTemplateItem(ObjectTemplateItem): def __init__(self, id_list, tool_id='portal_skins', **kw): ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw) def install(self, context, tar=0, **kw): if tar: ObjectTemplateItem.install(self, context, tar=1, **kw) p = context.getPortalObject() ps = p.portal_skins for skin_name, selection in ps.getSkinPaths(): new_selection = [] selection = selection.split(',') for relative_url, object in self._objects.items(): skin_id = relative_url.split('/')[3:4][0] try: selection_list = object.getProperty('business_template_registered_skin_selections', None) except: continue if selection_list is None or skin_name in selection_list: if skin_id not in selection and skin_id not in new_selection: new_selection.append(skin_id) new_selection.extend(selection) # sort the layer according to skin priorities new_selection.sort(lambda a, b : cmp( b in ps.objectIds() and ps[b].getProperty( 'business_template_skin_layer_priority', 0) or 0, a in ps.objectIds() and ps[a].getProperty( 'business_template_skin_layer_priority', 0) or 0)) ps.manage_skinLayers(skinpath = tuple(new_selection), skinname = skin_name, add_skin = 1) else: ObjectTemplateItem.install(self, context, **kw) p = context.getPortalObject() # It is necessary to make sure that the sql connections in Z SQL Methods are valid. sql_connection_list = p.objectIds(spec=('Z MySQL Database Connection',)) for relative_url in self._archive.keys(): folder = p.unrestrictedTraverse(relative_url) for object in folder.objectValues(spec=('Z SQL Method',)): if object.connection_id not in sql_connection_list: object.connection_id = sql_connection_list[0] # Add new folders into skin paths. ps = p.portal_skins for skin_name, selection in ps.getSkinPaths(): new_selection = [] selection = selection.split(',') for relative_url, object in self._archive.items(): skin_id = relative_url.split('/')[-1] selection_list = object.getProperty('business_template_registered_skin_selections', None) if selection_list is None or skin_name in selection_list: if skin_id not in selection: new_selection.append(skin_id) new_selection.extend(selection) # sort the layer according to skin priorities new_selection.sort(lambda a, b : cmp( b in ps.objectIds() and ps[b].getProperty( 'business_template_skin_layer_priority', 0) or 0, a in ps.objectIds() and ps[a].getProperty( 'business_template_skin_layer_priority', 0) or 0)) ps.manage_skinLayers(skinpath = tuple(new_selection), skinname = skin_name, add_skin = 1) def uninstall(self, context, **kw): # Remove folders from skin paths. ps = context.portal_skins skin_id_list = [relative_url.split('/')[-1] for relative_url in self._archive.keys()] for skin_name, selection in ps.getSkinPaths(): new_selection = [] selection = selection.split(',') for skin_id in selection: if skin_id not in skin_id_list: new_selection.append(skin_id) ps.manage_skinLayers(skinpath = tuple(new_selection), skinname = skin_name, add_skin = 1) # Make sure that skin data is up-to-date (see CMFCore/Skinnable.py). context.getPortalObject().changeSkin(None) ObjectTemplateItem.uninstall(self, context, **kw) def diff(self, max_deep=1, **kw): return ObjectTemplateItem.diff(self, max_deep=max_deep, **kw) class WorkflowTemplateItem(ObjectTemplateItem): def __init__(self, id_list, tool_id='portal_workflow', **kw): return ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw) class PortalTypeTemplateItem(ObjectTemplateItem): workflow_chain = None def _getChainByType(self, context): """ This is used in order to construct the full list of mapping between type and list of workflow associated This is only useful in order to use portal_workflow.manage_changeWorkflows """ pw = context.portal_workflow cbt = pw._chains_by_type ti = pw._listTypeInfo() types_info = [] for t in ti: id = t.getId() title = t.Title() if title == id: title = None if cbt is not None and cbt.has_key(id): chain = ', '.join(cbt[id]) else: chain = '(Default)' types_info.append({'id': id, 'title': title, 'chain': chain}) new_dict = {} for item in types_info: new_dict['chain_%s' % item['id']] = item['chain'] default_chain=', '.join(pw._default_chain) return (default_chain, new_dict) def __init__(self, id_list, tool_id='portal_types', **kw): ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw) self._workflow_chain_archive = PersistentMapping() def build(self, context, **kw): if len(self._archive.keys()) == 0: return p = context.getPortalObject() for relative_url in self._archive.keys(): object = p.unrestrictedTraverse(relative_url) object = object._getCopy(context) id_list = object.objectIds() # remove optional actions optional_action_list = [] for index,ai in enumerate(object.listActions()): if ai.getOption(): optional_action_list.append(index) if len(optional_action_list) > 0: object.deleteActions(selections=optional_action_list) if hasattr(object, 'uid'): object.uid = None self._objects[relative_url] = object object.wl_clearLocks() # also export workflow chain (default_chain, chain_dict) = self._getChainByType(context) for object in self._objects.values(): portal_type = object.id self._workflow_chain_archive[portal_type] = chain_dict['chain_%s' % portal_type] def export(self, context, bta, **kw): if len(self._objects.keys()) == 0: return root_path = os.path.join(bta.path, self.__class__.__name__) BaseTemplateItem.export(self, context, bta, **kw) object_path = os.path.join(bta.path, self.__class__.__name__, 'workflow_chain.txt') f = open(object_path, 'wt') for key in self._workflow_chain_archive.keys(): value = self._workflow_chain_archive[key] f.write(str(key)+' : '+str(value)+'\n') f.close() def install(self, context, tar=0, **kw): if tar: ObjectTemplateItem.install(self, context, tar=1, **kw) # We now need to setup the list of workflows corresponding to # each portal type (default_chain, chain_dict) = self._getChainByType(context) # Set the default chain to the empty string is probably the # best solution, by default it is 'default_workflow', wich is # not very usefull default_chain = '' for object in self._objects.values(): portal_type = object.id chain_dict['chain_%s' % portal_type] = self._workflow_chain_archive[portal_type] context.portal_workflow.manage_changeWorkflows(default_chain,props=chain_dict) else: ObjectTemplateItem.install(self, context, **kw) # We now need to setup the list of workflows corresponding to # each portal type (default_chain, chain_dict) = self._getChainByType(context) # Set the default chain to the empty string is probably the # best solution, by default it is 'default_workflow', wich is # not very usefull default_chain = '' for object in self._archive.values(): portal_type = object.id chain_dict['chain_%s' % portal_type] = \ self._workflow_chain_archive[portal_type] context.portal_workflow.manage_changeWorkflows(default_chain, props=chain_dict) def _backupObject(self, container, object_id, **kw): """ Backup portal type and keep the workflow chain. """ # Get the chain value (default_chain, chain_dict) = self._getChainByType(self) chain = chain_dict['chain_%s' % object_id] # Backup the portal type backup_id = ObjectTemplateItem._backupObject(self, container, object_id, **kw) # Restore the chain to the backuped portal type (default_chain, chain_dict) = self._getChainByType(self) chain_dict['chain_%s' % backup_id] = chain self.portal_workflow.manage_changeWorkflows(default_chain, props=chain_dict) def diff(self, verbose=0, **kw): """ Make a diff between portal type. Also compare the workflow chain. """ # Compare XML portal type result = ObjectTemplateItem.diff(self, verbose=verbose, **kw) # Compare chains container_ids = self.portal_types.objectIds() for object in self._archive.values(): object_id = object.id object_chain = self.portal_workflow.getChainFor(object_id) n = 1 new_object_id = '%s_btsave_%s' % (object_id, n) while new_object_id in container_ids: backuped_object_chain = self.portal_workflow.getChainFor(new_object_id) if object_chain != backuped_object_chain: result += "$$$ Workflow chains: " \ "%s and %s $$$\n" % \ (object_id, new_object_id) if verbose: result += '"%s" != "%s"\n' % (object_chain, backuped_object_chain) result += '%s\n' % ('-'*80) n += 1 new_object_id = '%s_btsave_%s' % (object_id, n) return result class CatalogMethodTemplateItem(ObjectTemplateItem): def __init__(self, id_list, tool_id='portal_catalog', **kw): ObjectTemplateItem.__init__(self, id_list, tool_id=tool_id, **kw) self._is_catalog_method_archive = PersistentMapping() self._is_catalog_list_method_archive = PersistentMapping() self._is_uncatalog_method_archive = PersistentMapping() self._is_update_method_archive = PersistentMapping() self._is_clear_method_archive = PersistentMapping() self._is_filtered_archive = PersistentMapping() self._filter_expression_archive = PersistentMapping() self._filter_expression_instance_archive = PersistentMapping() self._filter_type_archive = PersistentMapping() def build(self, context, **kw): if len(self._archive.keys()) == 0: return ObjectTemplateItem.build(self, context, **kw) try: catalog = context.portal_catalog.getSQLCatalog() except: return if catalog is None: return for object in self._objects.values(): method_id = object.id self._is_catalog_method_archive[method_id] = method_id in catalog.sql_catalog_object self._is_catalog_list_method_archive[method_id] = method_id in catalog.sql_catalog_object_list self._is_uncatalog_method_archive[method_id] = method_id in catalog.sql_uncatalog_object self._is_update_method_archive[method_id] = method_id in catalog.sql_update_object self._is_clear_method_archive[method_id] = method_id in catalog.sql_clear_catalog self._is_filtered_archive[method_id] = 0 if catalog.filter_dict.has_key(method_id): self._is_filtered_archive[method_id] = catalog.filter_dict[method_id]['filtered'] self._filter_expression_archive[method_id] = catalog.filter_dict[method_id]['expression'] self._filter_expression_instance_archive[method_id] = catalog.filter_dict[method_id]['expression_instance'] self._filter_type_archive[method_id] = catalog.filter_dict[method_id]['type'] def export(self, context, bta, **kw): if len(self._objects.keys()) == 0: return root_path = os.path.join(bta.path, self.__class__.__name__) for key in self._objects.keys(): object=self._objects[key] # create folder and subfolders folders, id = os.path.split(key) path = os.path.join(root_path, folders) bta.addFolder(name=path) # export object in xml f=StringIO() XMLExportImport.exportXML(object._p_jar, object._p_oid, f) bta.addObject(object=f.getvalue(), name=id, path=path) # add all datas specific to catalog inside one file catalog = context.portal_catalog.getSQLCatalog() method_id = object.id object_path = os.path.join(path, method_id+'.txt') f = open(object_path, 'wt') f.write(str(int(self._is_catalog_method_archive[method_id]))+'\n') f.write(str(int(self._is_catalog_list_method_archive[method_id]))+'\n') f.write(str(int(self._is_uncatalog_method_archive[method_id]))+'\n') f.write(str(int(self._is_update_method_archive[method_id]))+'\n') f.write(str(int(self._is_clear_method_archive[method_id]))+'\n') f.write(str(int(self._is_filtered_archive[method_id]))+'\n') if catalog.filter_dict.has_key(method_id): # f.write(str(self._is_filtered_archive[method_id])+'\n') f.write(str(self._filter_expression_archive[method_id])+'\n') f.write(str(self._filter_expression_instance_archive[method_id])+'\n') f.write(str(self._filter_type_archive[method_id])+'\n') f.close() def install(self, context, tar=0, **kw): ObjectTemplateItem.install(self, context, tar, **kw) try: catalog = context.portal_catalog.getSQLCatalog() except: catalog = None if catalog is None: LOG('BusinessTemplate', 0, 'no SQL catalog was available') return # Make copies of attributes of the default catalog of portal_catalog. sql_catalog_object = list(catalog.sql_catalog_object) sql_catalog_object_list = list(catalog.sql_catalog_object_list) sql_uncatalog_object = list(catalog.sql_uncatalog_object) sql_update_object = list(catalog.sql_update_object) sql_clear_catalog = list(catalog.sql_clear_catalog) if tar: values = self._objects.values() else: values = self._archive.values() for object in values: method_id = object.id is_catalog_method = int(self._is_catalog_method_archive[method_id]) is_catalog_list_method = int(self._is_catalog_list_method_archive[method_id]) is_uncatalog_method = int(self._is_uncatalog_method_archive[method_id]) is_update_method = int(self._is_update_method_archive[method_id]) is_clear_method = int(self._is_clear_method_archive[method_id]) is_filtered = int(self._is_filtered_archive[method_id]) if is_catalog_method and method_id not in sql_catalog_object: sql_catalog_object.append(method_id) elif not is_catalog_method and method_id in sql_catalog_object: sql_catalog_object.remove(method_id) if is_catalog_list_method and method_id not in sql_catalog_object_list: sql_catalog_object_list.append(method_id) elif not is_catalog_list_method and method_id in sql_catalog_object_list: sql_catalog_object_list.remove(method_id) if is_uncatalog_method and method_id not in sql_uncatalog_object: sql_uncatalog_object.append(method_id) elif not is_uncatalog_method and method_id in sql_uncatalog_object: sql_uncatalog_object.remove(method_id) if is_update_method and method_id not in sql_update_object: sql_update_object.append(method_id) elif not is_update_method and method_id in sql_update_object: sql_update_object.remove(method_id) if is_clear_method and method_id not in sql_clear_catalog: sql_clear_catalog.append(method_id) elif not is_clear_method and method_id in sql_clear_catalog: sql_clear_catalog.remove(method_id) if is_filtered: expression = str(self._filter_expression_archive[method_id]) expression_instance = str(self._filter_expression_instance_archive[method_id]) type = str(self._filter_type_archive[method_id]) catalog.filter_dict[method_id] = PersistentMapping() catalog.filter_dict[method_id]['filtered'] = 1 catalog.filter_dict[method_id]['expression'] = expression catalog.filter_dict[method_id]['expression_instance'] = expression_instance catalog.filter_dict[method_id]['type'] = type elif method_id in catalog.filter_dict.keys(): catalog.filter_dict[method_id]['filtered'] = 0 sql_catalog_object.sort() catalog.sql_catalog_object = tuple(sql_catalog_object) sql_catalog_object_list.sort() catalog.sql_catalog_object_list = tuple(sql_catalog_object_list) sql_uncatalog_object.sort() catalog.sql_uncatalog_object = tuple(sql_uncatalog_object) sql_update_object.sort() catalog.sql_update_object = tuple(sql_update_object) sql_clear_catalog.sort() catalog.sql_clear_catalog = tuple(sql_clear_catalog) def uninstall(self, context, **kw): return try: catalog = context.portal_catalog.getSQLCatalog() except: catalog = None if catalog is None: LOG('BusinessTemplate', 0, 'no SQL catalog was available') return # Make copies of attributes of the default catalog of portal_catalog. sql_catalog_object = list(catalog.sql_catalog_object) sql_catalog_object_list = list(catalog.sql_catalog_object_list) sql_uncatalog_object = list(catalog.sql_uncatalog_object) sql_update_object = list(catalog.sql_update_object) sql_clear_catalog = list(catalog.sql_clear_catalog) for object in self._archive.values(): method_id = object.id if method_id in sql_catalog_object: sql_catalog_object.remove(method_id) if method_id in sql_catalog_object_list: sql_catalog_object_list.remove(method_id) if method_id in sql_uncatalog_object: sql_uncatalog_object.remove(method_id) if method_id in sql_update_object: sql_update_object.remove(method_id) if method_id in sql_clear_catalog: sql_clear_catalog.remove(method_id) if catalog.filter_dict.has_key(method_id): del catalog.filter_dict[method_id] catalog.sql_catalog_object = tuple(sql_catalog_object) catalog.sql_catalog_object_list = tuple(sql_catalog_object_list) catalog.sql_uncatalog_object = tuple(sql_uncatalog_object) catalog.sql_update_object = tuple(sql_update_object) catalog.sql_clear_catalog = tuple(sql_clear_catalog) ObjectTemplateItem.uninstall(self, context, **kw) class ActionTemplateItem(BaseTemplateItem): def _splitPath(self, path): """ Split path tries to split a complexe path such as: "foo/bar[id=zoo]" into "foo/bar", "id", "zoo" This is used mostly for generic objects """ # Add error checking here if path.find('[') >= 0 and path.find(']') > path.find('=') and path.find('=') > path.find('['): relative_url = path[0:path.find('[')] id_block = path[path.find('[')+1:path.find(']')] key = id_block.split('=')[0] value = id_block.split('=')[1] return relative_url, key, value return path, None, None def __init__(self, id_list, **kw): # XXX It's look like ObjectTemplateItem __init__ BaseTemplateItem.__init__(self, id_list, **kw) id_list = self._archive.keys() self._archive.clear() for id in id_list: self._archive["%s/%s" % ('portal_types', id)] = None def build(self, context, **kw): if len(self._archive.keys()) == 0: return BaseTemplateItem.build(self, context, **kw) p = context.getPortalObject() for id in self._archive.keys(): relative_url, key, value = self._splitPath(id) object = p.unrestrictedTraverse(relative_url) for ai in object.listActions(): if getattr(ai, key) == value: url = string.split(relative_url, '/') key = os.path.join(url[-2], url[-1], value) object = ai._getCopy(context) if hasattr(object, 'uid'): object.uid = None self._objects[key] = object self._objects[key].wl_clearLocks() break else: LOG('BT build : action %r not found' %(value), 0, '') def install(self, context, tar=0, **kw): if tar: p = context.getPortalObject() for id in self._objects.keys(): path = string.split(id, '/') object = p.unrestrictedTraverse(path[2:-1]) for ai in object.listActions(): if getattr(ai, 'id') == path[-1]: raise TemplateConflictError, 'the portal type %s already has the action %s' % (object.id, path[-1]) action = self._objects[id] object.addAction( id = action.id , name = action.title , action = action.action.text , condition = action.getCondition() , permission = action.permissions , category = action.category , visible = action.visible , icon = getattr(action, 'icon', None) and action.icon.text or '' , optional = getattr(action, 'optional', 0) ) else: BaseTemplateItem.install(self, context, **kw) p = context.getPortalObject() for id,action in self._archive.items(): relative_url, key, value = self._splitPath(id) object = p.unrestrictedTraverse(relative_url) for ai in object.listActions(): if getattr(ai, key) == value: raise TemplateConflictError, 'the portal type %s already has the action %s' % (object.id, value) object.addAction( id = action.id , name = action.title , action = action.action.text , condition = action.getCondition() , permission = action.permissions , category = action.category , visible = action.visible , icon = getattr(action, 'icon', None) and action.icon.text or '' , optional = getattr(action, 'optional', 0) ) def uninstall(self, context, **kw): p = context.getPortalObject() for id,action in self._archive.items(): relative_url, key, value = self._splitPath(id) object = p.unrestrictedTraverse(relative_url) action_list = object.listActions() for index in range(len(action_list)): if getattr(action_list[index], key) == value: object.deleteActions(selections=(index,)) break BaseTemplateItem.uninstall(self, context, **kw) class SitePropertyTemplateItem(BaseTemplateItem): def build(self, context, **kw): if len(self._archive.keys()) == 0: return BaseTemplateItem.build(self, context, **kw) p = context.getPortalObject() for id in self._archive.keys(): for property in p.propertyMap(): if property['id'] == id: object = p.getProperty(id) type = property['type'] break else: object = None if object is None: raise NotFound, 'the property %s is not found' % id self._objects[id] = (type, object) def install(self, context, tar=0, **kw): if tar: p = context.getPortalObject() for path in self._objects.keys(): dir, id = os.path.split(path) if p.hasProperty(id): continue type, property = self._objects[path] p._setProperty(id, property, type=type) else: BaseTemplateItem.install(self, context, **kw) p = context.getPortalObject() for id,property in self._archive.items(): if p.hasProperty(id): continue # Too much??? #raise TemplateConflictError, 'the property %s already exists' % id p._setProperty(id, property['value'], type=property['type']) def uninstall(self, context, **kw): p = context.getPortalObject() for id in self._archive.keys(): if p.hasProperty(id): p._delProperty(id) BaseTemplateItem.uninstall(self, context, **kw) def export(self, context, bta, **kw): if len(self._objects.keys()) == 0: return root_path = os.path.join(bta.path, self.__class__.__name__) bta.addFolder(name=root_path) for path in self._objects.keys(): type, object=self._objects[path] object_path = os.path.join(root_path, path) f = open(object_path+'.txt', 'wt') f.write(str(type)+'\n') for item in object: f.write(str(item)+'\n') f.close() class ModuleTemplateItem(BaseTemplateItem): def diff(self, max_deep=1, **kw): return '' def build(self, context, **kw): if len(self._archive.keys()) == 0: return BaseTemplateItem.build(self, context, **kw) p = context.getPortalObject() for id in self._archive.keys(): module = p.unrestrictedTraverse(id) module = context.manage_clone(module, id='copy_of_'+module.getId()) if hasattr(module, 'uid'): module.uid = None self._objects[id] = module context.manage_delObjects(module.getId()) self._objects[id].id = id module.wl_clearLocks() def install(self, context, tar=0, **kw): if tar: portal = context.getPortalObject() # sort to add objects before their subobjects keys = self._objects.keys() keys.sort() for path in keys: container_path = path.split('/')[2:-1] object_id = path.split('/')[-1] container = portal.unrestrictedTraverse(container_path) container_ids = container.objectIds() object = self._objects[path] if object_id in portal.objectIds(): module = portal._getOb(object_id) if hasattr(object, 'portal_type'): module.portal_type = object.portal_type else: object = object._getCopy(container) container._setObject(object_id, object) object = container._getOb(object_id) object.manage_afterClone(object) object.wl_clearLocks() else: BaseTemplateItem.install(self, context, **kw) portal = context.getPortalObject() for id,mapping in self._archive.items(): if id in portal.objectIds(): module = portal._getOb(id) module.portal_type = mapping['portal_type'] # XXX else: module = portal.newContent(id=id, portal_type=mapping['portal_type']) module.setTitle(mapping['title']) for name,role_list in mapping['permission_list']: acquire = (type(role_list) == type([])) try: module.manage_permission(name, roles=role_list, acquire=acquire) except: # Normally, an exception is raised when you don't install any Product which # has been in use when this business template is created. pass def uninstall(self, context, **kw): p = context.getPortalObject() id_list = p.objectIds() for id in self._archive.keys(): if id in id_list: try: p.manage_delObjects([id]) except: pass BaseTemplateItem.uninstall(self, context, **kw) def trash(self, context, new_item, **kw): # Do not remove any module for safety. pass class DocumentTemplateItem(BaseTemplateItem): local_file_reader_name = 'readLocalDocument' local_file_writer_name = 'writeLocalDocument' local_file_importer_name = 'importLocalDocument' local_file_remover_name = 'removeLocalDocument' def build(self, context, **kw): if len(self._archive.keys()) == 0: return BaseTemplateItem.build(self, context, **kw) for id in self._archive.keys(): self._objects[self.__class__.__name__+'/'+id] = globals()[self.local_file_reader_name](id) def install(self, context, tar=0, **kw): if tar: for id in self._objects.keys(): text = self._objects[id] path, name = os.path.split(id) # This raises an exception if the file already exists. try: globals()[self.local_file_writer_name](name, text, create=1) except IOError: pass if self.local_file_importer_name is not None: globals()[self.local_file_importer_name](name) else: BaseTemplateItem.install(self, context, **kw) for id,text in self._archive.items(): # This raises an exception if the file exists. try: globals()[self.local_file_writer_name](id, text, create=1) except IOError: pass if self.local_file_importer_name is not None: globals()[self.local_file_importer_name](id) def uninstall(self, context, **kw): for id in self._archive.keys(): try: globals()[self.local_file_importer_name](id) except OSError: pass BaseTemplateItem.uninstall(self, context, **kw) def export(self, context, bta, **kw): if len(self._objects.keys()) == 0: return path = os.path.join(bta.path, self.__class__.__name__) bta.addFolder(name=path) for path in self._objects.keys(): object=self._objects[path] bta.addObject(object=object, name=path, path=None, ext='.py') class PropertySheetTemplateItem(DocumentTemplateItem): local_file_reader_name = 'readLocalPropertySheet' local_file_writer_name = 'writeLocalPropertySheet' local_file_importer_name = 'importLocalPropertySheet' local_file_remover_name = 'removeLocalPropertySheet' class ExtensionTemplateItem(DocumentTemplateItem): local_file_reader_name = 'readLocalExtension' local_file_writer_name = 'writeLocalExtension' # XXX is this method a error or ? local_file_importer_name = 'importLocalPropertySheet' local_file_remover_name = 'removeLocalExtension' class TestTemplateItem(DocumentTemplateItem): local_file_reader_name = 'readLocalTest' local_file_writer_name = 'writeLocalTest' # XXX is this a error ? local_file_importer_name = None local_file_remover_name = 'removeLocalTest' class ProductTemplateItem(BaseTemplateItem): # XXX Not implemented yet pass class RoleTemplateItem(BaseTemplateItem): def build(self, context, **kw): if len(self._archive.keys()) == 0: return role_list = [] for key in self._archive.keys(): role_list.append(key) self._objects[self.__class__.__name__+'/role_list'] = role_list def install(self, context, tar=0, **kw): if tar: p = context.getPortalObject() roles = {} for role in p.__ac_roles__: roles[role] = 1 for role in self._objects.keys(): roles[role] = 1 p.__ac_roles__ = tuple(roles.keys()) else: BaseTemplateItem.install(self, context, **kw) p = context.getPortalObject() roles = {} for role in p.__ac_roles__: roles[role] = 1 for role in self._archive.keys(): roles[role] = 1 p.__ac_roles__ = tuple(roles.keys()) def uninstall(self, context, **kw): p = context.getPortalObject() roles = {} for role in p.__ac_roles__: roles[role] = 1 for role in self._archive.keys(): if role in roles: del roles[role] p.__ac_roles__ = tuple(roles.keys()) BaseTemplateItem.uninstall(self, context, **kw) def trash(self, context, new_item, **kw): p = context.getPortalObject() new_roles = {} for role in new_item._archive.keys(): new_roles[role] = 1 roles = {} for role in p.__ac_roles__: roles[role] = 1 for role in self._archive.keys(): if role in roles and role not in new_roles: del roles[role] p.__ac_roles__ = tuple(roles.keys()) def export(self, context, bta, **kw): if len(self._objects.keys()) == 0: return path = os.path.join(bta.path, self.__class__.__name__) bta.addFolder(name=path) for path in self._objects.keys(): object=self._objects[path] # write one item per line... bta.addObject(object=object, name=path, path=None, ext='.txt') class CatalogResultKeyTemplateItem(BaseTemplateItem): def build(self, context, **kw): if len(self._archive.keys()) == 0: return try: catalog = context.portal_catalog.getSQLCatalog() except: catalog = None if catalog is None: LOG('BusinessTemplate', 0, 'no SQL catalog was available') return sql_search_result_keys = list(catalog.sql_search_result_keys) role_list = [] for key in self._archive.keys(): if key in sql_search_result_keys: role_list.append(key) else: raise NotFound, 'key %r not found in catalog' %(key,) self._objects[self.__class__.__name__+'/key_list'] = role_list def install(self, context, tar=0, **kw): if tar: if len(self._objects.values()) == 0: return try: catalog = context.portal_catalog.getSQLCatalog() except: catalog = None if catalog is None: LOG('BusinessTemplate', 0, 'no SQL catalog was available') return sql_search_result_keys = list(catalog.sql_search_result_keys) for key in self._objects.values().pop(): if key not in sql_search_result_keys: sql_search_result_keys.append(key) catalog.sql_search_result_keys = sql_search_result_keys else: BaseTemplateItem.install(self, context, **kw) try: catalog = context.portal_catalog.getSQLCatalog() except: catalog = None if catalog is None: LOG('BusinessTemplate', 0, 'no SQL catalog was available') return sql_search_result_keys = list(catalog.sql_search_result_keys) for key in self._archive.keys(): if key not in sql_search_result_keys: sql_search_result_keys.append(key) catalog.sql_search_result_keys = sql_search_result_keys def uninstall(self, context, **kw): try: catalog = context.portal_catalog.getSQLCatalog() except: catalog = None if catalog is None: LOG('BusinessTemplate', 0, 'no SQL catalog was available') return sql_search_result_keys = list(catalog.sql_search_result_keys) for key in self._archive.keys(): if key in sql_search_result_keys: sql_search_result_keys.remove(key) catalog.sql_search_result_keys = sql_search_result_keys BaseTemplateItem.uninstall(self, context, **kw) def export(self, context, bta, **kw): if len(self._objects.keys()) == 0: return path = os.path.join(bta.path, self.__class__.__name__) bta.addFolder(name=path) for path in self._objects.keys(): object=self._objects[path] bta.addObject(object=object, name=path, path=None, ext='.txt') class CatalogRelatedKeyTemplateItem(BaseTemplateItem): def build(self, context, **kw): if len(self._archive.keys()) == 0: return try: catalog = context.portal_catalog.getSQLCatalog() except: catalog = None if catalog is None: LOG('BusinessTemplate', 0, 'no SQL catalog was available') return sql_search_related_keys = list(catalog.sql_catalog_related_keys) role_list = [] for key in self._archive.keys(): if key in sql_search_related_keys: role_list.append(key) else: raise NotFound, 'key %r not found in catalog' %(key,) self._objects[self.__class__.__name__+'/key_list'] = role_list def install(self, context, tar=0, **kw): if tar: if len(self._objects.values()) == 0: return try: catalog = context.portal_catalog.getSQLCatalog() except: catalog = None if catalog is None: LOG('BusinessTemplate', 0, 'no SQL catalog was available') return sql_catalog_related_keys = list(catalog.sql_catalog_related_keys) for key in self._objects.values().pop(): # because of list of list if key not in sql_catalog_related_keys: sql_catalog_related_keys.append(key) catalog.sql_catalog_related_keys = sql_catalog_related_keys else: BaseTemplateItem.install(self, context, **kw) try: catalog = context.portal_catalog.getSQLCatalog() except: catalog = None if catalog is None: LOG('BusinessTemplate', 0, 'no SQL catalog was available') return sql_catalog_related_keys = list(catalog.sql_catalog_related_keys) for key in self._archive.keys(): if key not in sql_catalog_related_keys: sql_catalog_related_keys.append(key) catalog.sql_catalog_related_keys = sql_catalog_related_keys def uninstall(self, context, **kw): try: catalog = context.portal_catalog.getSQLCatalog() except: catalog = None if catalog is None: LOG('BusinessTemplate', 0, 'no SQL catalog was available') return sql_catalog_related_keys = list(catalog.sql_catalog_related_keys) for key in self._archive.keys(): if key in sql_catalog_related_keys: sql_catalog_related_keys.remove(key) catalog.sql_catalog_related_keys = sql_catalog_related_keys BaseTemplateItem.uninstall(self, context, **kw) def export(self, context, bta, **kw): if len(self._objects.keys()) == 0: return path = os.path.join(bta.path, self.__class__.__name__) bta.addFolder(name=path) for path in self._objects.keys(): object=self._objects[path] bta.addObject(object=object, name=path, path=None, ext='.txt') class CatalogResultTableTemplateItem(BaseTemplateItem): def build(self, context, **kw): if len(self._archive.keys()) == 0: return try: catalog = context.portal_catalog.getSQLCatalog() except: catalog = None if catalog is None: LOG('BusinessTemplate', 0, 'no SQL catalog was available') return sql_search_result_tables = list(catalog.sql_search_tables) role_list = [] for key in self._archive.keys(): if key in sql_search_result_tables: role_list.append(key) else: raise NotFound, 'key %r not found in catalog' %(key,) self._objects[self.__class__.__name__+'/key_list'] = role_list def install(self, context, tar=0, **kw): if tar: if len(self._objects.values()) == 0: return try: catalog = context.portal_catalog.getSQLCatalog() except: catalog = None if catalog is None: LOG('BusinessTemplate', 0, 'no SQL catalog was available') return sql_search_tables = list(catalog.sql_search_tables) for key in self._objects.values().pop(): if key not in sql_search_tables: sql_search_tables.append(key) catalog.sql_search_tables = sql_search_tables else: BaseTemplateItem.install(self, context, **kw) try: catalog = context.portal_catalog.getSQLCatalog() except: catalog = None if catalog is None: LOG('BusinessTemplate', 0, 'no SQL catalog was available') return sql_search_tables = list(catalog.sql_search_tables) for key in self._archive.keys(): if key not in sql_search_tables: sql_search_tables.append(key) catalog.sql_search_tables = sql_search_tables def uninstall(self, context, **kw): try: catalog = context.portal_catalog.getSQLCatalog() except: catalog = None if catalog is None: LOG('BusinessTemplate', 0, 'no SQL catalog was available') return sql_search_tables = list(catalog.sql_search_tables) for key in self._archive.keys(): if key in sql_search_tables: sql_search_tables.remove(key) catalog.sql_search_tables = sql_search_tables BaseTemplateItem.uninstall(self, context, **kw) def export(self, context, bta, **kw): if len(self._objects.keys()) == 0: return path = os.path.join(bta.path, self.__class__.__name__) bta.addFolder(name=path) for path in self._objects.keys(): object=self._objects[path] bta.addObject(object=object, name=path, path=None, ext='.txt') class MessageTranslationTemplateItem(BaseTemplateItem): def build(self, context, **kw): if len(self._archive.keys()) == 0: return localizer = context.getPortalObject().Localizer for lang in self._archive.keys(): # Export only erp5_ui at the moment. # This is safer against information leak. for catalog in ('erp5_ui', ): path = os.path.join(lang, catalog) mc = localizer._getOb(catalog) self._objects[path] = mc.manage_export(lang) def install(self, context, tar=0, **kw): if tar: localizer = context.getPortalObject().Localizer for path, po in self._objects.items(): path = string.split(path, '/') lang = path[-3] catalog = path[-2] if lang not in localizer.get_languages(): localizer.manage_addLanguage(lang) mc = localizer._getOb(catalog) if lang not in mc.get_languages(): mc.manage_addLanguage(lang) mc.manage_import(lang, po) else: BaseTemplateItem.install(self, context, **kw) localizer = context.getPortalObject().Localizer for lang, catalogs in self._archive.items(): if lang not in localizer.get_languages(): localizer.manage_addLanguage(lang) for catalog, po in catalogs.items(): mc = localizer._getOb(catalog) if lang not in mc.get_languages(): mc.manage_addLanguage(lang) mc.manage_import(lang, po) def export(self, context, bta, **kw): if len(self._objects.keys()) == 0: return root_path = os.path.join(bta.path, self.__class__.__name__) bta.addFolder(name=root_path) for key in self._objects.keys(): object = self._objects[key] path = os.path.join(root_path, key) bta.addFolder(name=path) f = open(path+'/translation.po', 'wt') f.write(str(object)) f.close() class BusinessTemplate(XMLObject): """ A business template allows to construct ERP5 modules in part or completely. It may include: - dependency - conflicts - catalog definition ( -> formal definition + sql files ) - SQL methods including: - purpose (catalog, uncatalog, etc.) - filter definition - Mapping definition - id (ex. getTitle) - column_id (ex. title) - indexed - preferred table (ex. catalog) - portal_types definition ( -> zexp/xml file) - id - actions - module definition ( -> zexp/xml file) - id - relative_url - menus - roles/security - workflow definitions ( -> zexp/xml file) - workflow_id - XML/XMI definition - relevant portal_types - tool definition ( -> formal definition) - categories definition Each definition should be usable in both import and update mode. Technology: - download a zip file (from the web, from a CVS repository) - install files to the right location (publish / update) (in the ZODB) - PUBLISH: publish method allows to publish an application (and share code) publication in a CVS repository allows to develop THIS IS THE MOST IMPORTANT CONCEPT Use case: - install core ERP5 (the minimum) - go to "BT" menu. Refresh list. Select BT. Click register. - go to "BT" menu. Select register BT. Define params. Click install / update. - go to "BT" menu. Create new BT. Define BT elements (workflow, methods, attributes, etc.). Click publish. Provide URL. Done. """ meta_type = 'ERP5 Business Template' portal_type = 'Business Template' add_permission = Permissions.AddPortalContent isPortalContent = 1 isRADContent = 1 # Declarative security security = ClassSecurityInfo() security.declareObjectProtected(Permissions.View) # Declarative interfaces __implements__ = ( Interface.Variated, ) # Declarative properties property_sheets = ( PropertySheet.Base , PropertySheet.XMLObject , PropertySheet.SimpleItem , PropertySheet.CategoryCore , PropertySheet.BusinessTemplate ) # Factory Type Information factory_type_information = \ { 'id' : portal_type , 'meta_type' : meta_type , 'description' : """\ Business Template is a set of definitions, such as skins, portal types and categories. This is used to set up a new ERP5 site very efficiently.""" , 'icon' : 'order_line_icon.gif' , 'product' : 'ERP5Type' , 'factory' : 'addBusinessTemplate' , 'immediate_view' : 'BusinessTemplate_view' , 'allow_discussion' : 1 , 'allowed_content_types': ( ) , 'filter_content_types' : 1 , 'global_allow' : 1 , 'actions' : ( { 'id' : 'view' , 'name' : 'View' , 'category' : 'object_view' , 'action' : 'BusinessTemplate_view' , 'permissions' : ( Permissions.View, ) } , { 'id' : 'diff' , 'name' : 'Diff' , 'category' : 'object_view' , 'action' : 'BusinessTemplate_viewDiff' , 'permissions' : ( Permissions.View, ) } , { 'id' : 'history' , 'name' : 'History' , 'category' : 'object_view' , 'action' : 'Base_viewHistory' , 'permissions' : ( Permissions.View, ) } , { 'id' : 'metadata' , 'name' : 'Metadata' , 'category' : 'object_view' , 'action' : 'Base_viewMetadata' , 'permissions' : ( Permissions.ManageProperties, ) } , { 'id' : 'translate' , 'name' : 'Translate' , 'category' : 'object_exchange' , 'action' : 'translation_template_view' , 'permissions' : ( Permissions.TranslateContent, ) } , { 'id' : 'update' , 'name' : 'Update Business Template' , 'category' : 'object_action' , 'action' : 'BusinessTemplate_update' , 'permissions' : ( Permissions.ModifyPortalContent, ) } , { 'id' : 'save' , 'name' : 'Save Business Template' , 'category' : 'object_action' , 'action' : 'BusinessTemplate_save' , 'permissions' : ( Permissions.ManagePortal, ) } , { 'id' : 'export' , 'name' : 'Export Business Template' , 'category' : 'object_action' , 'action' : 'BusinessTemplate_export' , 'permissions' : ( Permissions.ManagePortal, ) } , { 'id' : 'unittest_run' , 'name' : 'Run Unit Tests' , 'category' : 'object_action' , 'action' : 'BusinessTemplate_viewUnitTestRunDialog' , 'permissions' : ( Permissions.ManagePortal, ) } ) } # This is a global variable # Order is important for installation _item_name_list = [ '_product_item', '_property_sheet_item', '_document_item', '_extension_item', '_test_item', '_role_item', '_message_translation_item', '_workflow_item', '_catalog_method_item', '_site_property_item', '_portal_type_item', '_category_item', '_module_item', '_path_item', '_skin_item', '_action_item', '_catalog_result_key_item', '_catalog_related_key_item', '_catalog_result_table_item', ] def __init__(self, *args, **kw): XMLObject.__init__(self, *args, **kw) # Initialize all item to None self._tarfile = 0 self._objects = PersistentMapping() for item_name in self._item_name_list: setattr(self, item_name, None) def manage_afterAdd(self, item, container): """ This is called when a new business template is added or imported. """ portal_workflow = getToolByName(self, 'portal_workflow') if portal_workflow is not None: # Make sure that the installation state is "not installed". if portal_workflow.getStatusOf( 'business_template_installation_workflow', self) is not None: # XXX Not good to access the attribute directly, # but there is no API for clearing the history. self.workflow_history[ 'business_template_installation_workflow'] = None def build(self): """ Copy existing portal objects to self """ # Make sure that everything is sane. self.clean() # copy itself to save while we are clean object = self._getCopy(self) if not hasattr(self, '_objects'): self._objects = PersistentMapping() self._objects = object object.wl_clearLocks() # XXX Trim down the history to prevent it from bloating the bt5 file. # XXX Is there any better way to shrink the size??? # XXX Is it still necessary as it is not saved in new bt format ?? portal_workflow = getToolByName(self, 'portal_workflow') wf_id_list = portal_workflow.getChainFor(self) original_history_dict = {} for wf_id in wf_id_list: history = portal_workflow.getHistoryOf(wf_id, self) if history is not None and len(history) > 30: original_history_dict[wf_id] = history LOG('Business Template', 0, 'trim down the history of %s' % (wf_id,)) self.workflow_history[wf_id] = history[-30:] # Store all datas self._portal_type_item = \ PortalTypeTemplateItem(self.getTemplatePortalTypeIdList()) self._workflow_item = \ WorkflowTemplateItem(self.getTemplateWorkflowIdList()) self._skin_item = \ SkinTemplateItem(self.getTemplateSkinIdList()) self._category_item = \ CategoryTemplateItem(self.getTemplateBaseCategoryList()) self._catalog_method_item = \ CatalogMethodTemplateItem(self.getTemplateCatalogMethodIdList()) self._action_item = \ ActionTemplateItem(self.getTemplateActionPathList()) self._site_property_item = \ SitePropertyTemplateItem(self.getTemplateSitePropertyIdList()) self._module_item = \ ModuleTemplateItem(self.getTemplateModuleIdList()) self._document_item = \ DocumentTemplateItem(self.getTemplateDocumentIdList()) self._property_sheet_item = \ PropertySheetTemplateItem(self.getTemplatePropertySheetIdList()) self._extension_item = \ ExtensionTemplateItem(self.getTemplateExtensionIdList()) self._test_item = \ TestTemplateItem(self.getTemplateTestIdList()) self._product_item = \ ProductTemplateItem(self.getTemplateProductIdList()) self._role_item = \ RoleTemplateItem(self.getTemplateRoleList()) self._catalog_result_key_item = \ CatalogResultKeyTemplateItem( self.getTemplateCatalogResultKeyList()) self._catalog_related_key_item = \ CatalogRelatedKeyTemplateItem( self.getTemplateCatalogRelatedKeyList()) self._catalog_result_table_item = \ CatalogResultTableTemplateItem( self.getTemplateCatalogResultTableList()) self._message_translation_item = \ MessageTranslationTemplateItem( self.getTemplateMessageTranslationList()) self._path_item = \ PathTemplateItem(self.getTemplatePathList()) # Build each part for item_name in self._item_name_list: getattr(self, item_name).build(self) build = WorkflowMethod(build) def publish(self, url, username=None, password=None): """ Publish in a format or anothre """ return self.portal_templates.publish(self, url, username=username, password=password) def update(self): """ Update template: download new template definition """ return self.portal_templates.update(self) def _install(self, **kw): installed_bt = self.portal_templates.getInstalledBusinessTemplate( self.getTitle()) LOG('Business Template install', 0, 'self = %r, installed_bt = %r' % (self, installed_bt)) if installed_bt is not None: installed_bt.trash(self) installed_bt.replace(self) # Update local dictionary containing all setup parameters # This may include mappings self.portal_templates.updateLocalConfiguration(self, **kw) local_configuration = self.portal_templates.getLocalConfiguration(self) # Install everything tar = getattr(self, '_tarfile', 0) for item_name in self._item_name_list: item = getattr(self, item_name) if item is not None: item.install(local_configuration, tar = tar) # It is better to clear cache because the installation of a template # adds many new things into the portal. clearCache() def install(self, **kw): """ For install based on paramaters provided in **kw """ return self._install(**kw) install = WorkflowMethod(install) def reinstall(self, **kw): """Reinstall Business Template. """ return self._install(**kw) reinstall = WorkflowMethod(reinstall) def trash(self, new_bt, **kw): """ Trash unnecessary items before upgrading to a new business template. This is similar to uninstall, but different in that this does not remove all items. """ # Update local dictionary containing all setup parameters # This may include mappings self.portal_templates.updateLocalConfiguration(self, **kw) local_configuration = self.portal_templates.getLocalConfiguration(self) # Trash everything for item_name in self._item_name_list[::-1]: item = getattr(self, item_name) if item is not None: item.trash( local_configuration, getattr(new_bt, item_name)) def uninstall(self, **kw): """ For uninstall based on paramaters provided in **kw """ # Update local dictionary containing all setup parameters # This may include mappings self.portal_templates.updateLocalConfiguration(self, **kw) local_configuration = self.portal_templates.getLocalConfiguration(self) # Uninstall everything # Trash everything for item_name in self._item_name_list[::-1]: item = getattr(self, item_name) if item is not None: item.uninstall(local_configuration) # It is better to clear cache because the uninstallation of a # template deletes many things from the portal. clearCache() uninstall = WorkflowMethod(uninstall) def clean(self): """ Clean built information. """ # First, remove obsolete attributes if present. self._objects = None self._tarfile = 0 for attr in ( '_action_archive', '_document_archive', '_extension_archive', '_test_archive', '_module_archive', '_object_archive', '_portal_type_archive', '_property_archive', '_property_sheet_archive'): if hasattr(self, attr): delattr(self, attr) # Secondly, make attributes empty. for item_name in self._item_name_list: item = setattr(self, item_name, None) clean = WorkflowMethod(clean) security.declareProtected(Permissions.AccessContentsInformation, 'getBuildingState') def getBuildingState(self, id_only=1): """ Returns the current state in building """ portal_workflow = getToolByName(self, 'portal_workflow') wf = portal_workflow.getWorkflowById( 'business_template_building_workflow') return wf._getWorkflowStateOf(self, id_only=id_only ) security.declareProtected(Permissions.AccessContentsInformation, 'getInstallationState') def getInstallationState(self, id_only=1): """ Returns the current state in installation """ portal_workflow = getToolByName(self, 'portal_workflow') wf = portal_workflow.getWorkflowById( 'business_template_installation_workflow') return wf._getWorkflowStateOf(self, id_only=id_only ) security.declareProtected(Permissions.AccessContentsInformation, 'toxml') def toxml(self): """ Return this Business Template in XML """ portal_templates = getToolByName(self, 'portal_templates') export_string = portal_templates.manage_exportObject( id=self.getId(), toxml=1, download=1) return export_string def _getOrderedList(self, id): """ We have to set this method because we want an ordered list """ result = getattr(self, id, ()) if result is None: result = () if result != (): result = list(result) result.sort() result = tuple(result) return result def getTemplateCatalogMethodIdList(self): """ We have to set this method because we want an ordered list """ return self._getOrderedList('template_catalog_method_id') def getTemplateBaseCategoryList(self): """ We have to set this method because we want an ordered list """ return self._getOrderedList('template_base_category') def getTemplateWorkflowIdList(self): """ We have to set this method because we want an ordered list """ return self._getOrderedList('template_workflow_id') def getTemplatePortalTypeIdList(self): """ We have to set this method because we want an ordered list """ return self._getOrderedList('template_portal_type_id') def getTemplateActionPathList(self): """ We have to set this method because we want an ordered list """ return self._getOrderedList('template_action_path') def getTemplateSkinIdList(self): """ We have to set this method because we want an ordered list """ return self._getOrderedList('template_skin_id') def getTemplateModuleIdList(self): """ We have to set this method because we want an ordered list """ return self._getOrderedList('template_module_id') def getTemplateMessageTranslationList(self): """ We have to set this method because we want an ordered list """ return self._getOrderedList('template_message_translation') def diff(self, verbose=0): """ Return a 'diff' of the business template compared to the __btsave__ version. """ diff_message = '%s : %s\n%s\n' % (self.getPath(), DateTime(), '='*80) # Diff everything for item_name in self._item_name_list: item = getattr(self, item_name) if item is not None: diff_message += item.diff(verbose=verbose) return diff_message def export(self, path=None, local=0, **kw): """ Export this Business Template """ if local: # we export into a folder tree bta = BusinessTemplateFolder(creation=1, path=path) else: # We export BT into a tarball file bta = BusinessTemplateTarball(creation=1, path=path) # export bt bta.addFolder(path+'/bt') for prop in self.propertyMap(): type = prop['type'] id = prop['id'] # if id in ('uid', 'rid', 'sid', 'id_group', 'last_id'): if id in ('uid'): continue value = self.getProperty(id) if type == 'text' or type == 'string' or type == 'int': bta.addObject(object=value, name=id, path=path+'/bt', ext='') elif type == 'lines' or type == 'tokens': bta.addObject(object='\n'.join(value), name=id, path=path+'/bt', ext='') # Export each part for item_name in self._item_name_list: getattr(self, item_name).export(context=self, bta=bta) return bta.finishCreation() def importFile(self, dir = 0, file=None, root_path=None): """ Import all xml file in Business Template """ if dir: bta = BusinessTemplateFolder(importing=1, file=file, path=root_path) else: bta = BusinessTemplateTarball(importing=1, file=file) self._tarfile = 1 self._portal_type_item = \ PortalTypeTemplateItem(self.getTemplatePortalTypeIdList()) self._workflow_item = \ WorkflowTemplateItem(self.getTemplateWorkflowIdList()) self._skin_item = \ SkinTemplateItem(self.getTemplateSkinIdList()) self._category_item = \ CategoryTemplateItem(self.getTemplateBaseCategoryList()) self._catalog_method_item = \ CatalogMethodTemplateItem(self.getTemplateCatalogMethodIdList()) self._action_item = \ ActionTemplateItem(self.getTemplateActionPathList()) self._site_property_item = \ SitePropertyTemplateItem(self.getTemplateSitePropertyIdList()) self._module_item = \ ModuleTemplateItem(self.getTemplateModuleIdList()) self._document_item = \ DocumentTemplateItem(self.getTemplateDocumentIdList()) self._property_sheet_item = \ PropertySheetTemplateItem(self.getTemplatePropertySheetIdList()) self._extension_item = \ ExtensionTemplateItem(self.getTemplateExtensionIdList()) self._test_item = \ TestTemplateItem(self.getTemplateTestIdList()) self._product_item = \ ProductTemplateItem(self.getTemplateProductIdList()) self._role_item = \ RoleTemplateItem(self.getTemplateRoleList()) self._catalog_result_key_item = \ CatalogResultKeyTemplateItem( self.getTemplateCatalogResultKeyList()) self._catalog_related_key_item = \ CatalogRelatedKeyTemplateItem( self.getTemplateCatalogRelatedKeyList()) self._catalog_result_table_item = \ CatalogResultTableTemplateItem( self.getTemplateCatalogResultTableList()) self._message_translation_item = \ MessageTranslationTemplateItem( self.getTemplateMessageTranslationList()) self._path_item = \ PathTemplateItem(self.getTemplatePathList()) for item_name in self._item_name_list: getattr(self, item_name).importFile(bta)