## Copyright (c) 2002 Nexedi SARL and Contributors. All Rights Reserved. # Sebastien Robin <seb@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. # ############################################################################## """\ ERP portal_synchronizations tool. """ from OFS.SimpleItem import SimpleItem from OFS.Folder import Folder from Products.CMFCore.utils import UniqueObject from Globals import InitializeClass, DTMLFile, PersistentMapping, Persistent from AccessControl import ClassSecurityInfo, getSecurityManager from Products.CMFCore import CMFCorePermissions from Products.ERP5SyncML import _dtmldir from Publication import Publication,Subscriber from Subscription import Subscription,Signature from xml.dom.ext.reader.Sax2 import FromXmlStream, FromXml from XMLSyncUtils import * from Products.ERP5Type import Permissions from PublicationSynchronization import PublicationSynchronization from SubscriptionSynchronization import SubscriptionSynchronization #import sys #import StringIO import string from zLOG import * from Conduit.ERP5Conduit import ERP5Conduit class SynchronizationError( Exception ): pass class SynchronizationTool( UniqueObject, SimpleItem, SubscriptionSynchronization, PublicationSynchronization ): """ This tool implements the synchronization algorithm """ id = 'portal_synchronizations' meta_type = 'ERP5 Synchronizations' security = ClassSecurityInfo() # # Default values. # list_publications = PersistentMapping() list_subscriptions = PersistentMapping() # Do we want to use emails ? #email = None email = 1 same_export = 1 def __init__( self ): self.list_publications = PersistentMapping() self.list_subscriptions = PersistentMapping() # # ZMI methods # manage_options = ( ( { 'label' : 'Overview' , 'action' : 'manage_overview' } , { 'label' : 'Publications' , 'action' : 'managePublications' } , { 'label' : 'Subscriptions' , 'action' : 'manageSubscriptions' } , { 'label' : 'Conflicts' , 'action' : 'manageConflicts' } ) + SimpleItem.manage_options ) security.declareProtected( CMFCorePermissions.ManagePortal , 'manage_overview' ) manage_overview = DTMLFile( 'dtml/explainSynchronizationTool', globals() ) security.declareProtected( CMFCorePermissions.ManagePortal , 'managePublications' ) managePublications = DTMLFile( 'dtml/managePublications', globals() ) security.declareProtected( CMFCorePermissions.ManagePortal , 'addPublicationsForm' ) addPublicationsForm = DTMLFile( 'dtml/addPublications', globals() ) security.declareProtected( CMFCorePermissions.ManagePortal , 'manageSubsciptions' ) manageSubscriptions = DTMLFile( 'dtml/manageSubscriptions', globals() ) security.declareProtected( CMFCorePermissions.ManagePortal , 'manageConflicts' ) manageConflicts = DTMLFile( 'dtml/manageConflicts', globals() ) security.declareProtected( CMFCorePermissions.ManagePortal , 'addSubscriptionsForm' ) addSubscriptionsForm = DTMLFile( 'dtml/addSubscriptions', globals() ) security.declareProtected( CMFCorePermissions.ManagePortal , 'editProperties' ) def editProperties( self , publisher=None , REQUEST=None ): """ Form handler for "tool-wide" properties (including list of metadata elements). """ if publisher is not None: self.publisher = publisher if REQUEST is not None: REQUEST[ 'RESPONSE' ].redirect( self.absolute_url() + '/propertiesForm' + '?manage_tabs_message=Tool+updated.' ) security.declareProtected(Permissions.ModifyPortalContent, 'addPublications') def addPublications(self, id, publication_url, destination_path, query, xml_mapping, RESPONSE=None): """ create a new publication """ pub = Publication(id, publication_url, destination_path, query, xml_mapping) if len(self.list_publications) == 0: self.list_publications = PersistentMapping() self.list_publications[id] = pub if RESPONSE is not None: RESPONSE.redirect('managePublications') security.declareProtected(Permissions.ModifyPortalContent, 'addSubscriptions') def addSubscriptions(self, id, publication_url, subscription_url, destination_path, query, xml_mapping, RESPONSE=None): """ XXX should be renamed as addSubscription create a new subscription """ sub = Subscription(id, publication_url, subscription_url, destination_path, query, xml_mapping) if len(self.list_subscriptions) == 0: self.list_subscriptions = PersistentMapping() self.list_subscriptions[id] = sub if RESPONSE is not None: RESPONSE.redirect('manageSubscriptions') security.declareProtected(Permissions.ModifyPortalContent, 'editPublications') def editPublications(self, id, publication_url, destination_path, query, xml_mapping, RESPONSE=None): """ modify a publication """ pub = Publication(id, publication_url, destination_path, query, xml_mapping) self.list_publications[id] = pub if RESPONSE is not None: RESPONSE.redirect('managePublications') security.declareProtected(Permissions.ModifyPortalContent, 'editSubscriptions') def editSubscriptions(self, id, publication_url, subscription_url, destination_path, query, xml_mapping, RESPONSE=None): """ modify a subscription """ sub = Subscription(id, publication_url, subscription_url, destination_path, query, xml_mapping) self.list_subscriptions[id] = sub if RESPONSE is not None: RESPONSE.redirect('manageSubscriptions') security.declareProtected(Permissions.ModifyPortalContent, 'deletePublications') def deletePublications(self, id, RESPONSE=None): """ delete a publication """ del self.list_publications[id] if RESPONSE is not None: RESPONSE.redirect('managePublications') security.declareProtected(Permissions.ModifyPortalContent, 'deleteSubscriptions') def deleteSubscriptions(self, id, RESPONSE=None): """ delete a subscription """ del self.list_subscriptions[id] if RESPONSE is not None: RESPONSE.redirect('manageSubscriptions') security.declareProtected(Permissions.ModifyPortalContent, 'ResetPublications') def ResetPublications(self, id, RESPONSE=None): """ reset a publication """ self.list_publications[id].resetAllSubscribers() if RESPONSE is not None: RESPONSE.redirect('managePublications') security.declareProtected(Permissions.ModifyPortalContent, 'ResetSubscriptions') def ResetSubscriptions(self, id, RESPONSE=None): """ reset a subscription XXX R -> r """ self.list_subscriptions[id].resetAllSignatures() self.list_subscriptions[id].resetAnchors() if RESPONSE is not None: RESPONSE.redirect('manageSubscriptions') security.declareProtected(Permissions.AccessContentsInformation,'getPublicationList') def getPublicationList(self): """ Return a list of publications """ return_list = [] if type(self.list_publications) is type([]): # For compatibility with old # SynchronizationTool, XXX To be removed self.list_publications = PersistentMapping() for key in self.list_publications.keys(): return_list += [self.list_publications[key]] return return_list security.declareProtected(Permissions.AccessContentsInformation,'getSubscriptionList') def getSubscriptionList(self): """ Return a list of publications """ return_list = [] if type(self.list_subscriptions) is type([]): # For compatibility with old # SynchronizationTool, XXX To be removed self.list_subscriptions = PersistentMapping() for key in self.list_subscriptions.keys(): return_list += [self.list_subscriptions[key]] return return_list security.declareProtected(Permissions.AccessContentsInformation,'getDomainList') def getDomainList(self): """ Returns the list of subscriptions and publications getSynchronizationList ? (mon choix) getSubscriptionOrPublicationList ? """ return self.getSubscriptionList() + self.getPublicationList() security.declareProtected(Permissions.AccessContentsInformation,'getConflictList') def getConflictList(self, path=None): """ Retrieve the list of all conflicts Here the list is as follow : [conflict_1,conflict2,...] where conflict_1 is like: ['publication',publication_id,object.getPath(),keyword,local_value,remote_value] """ conflict_list = [] for publication in self.getPublicationList(): for subscriber in publication.getSubscriberList(): sub_conflict_list = subscriber.getConflictList() for conflict in sub_conflict_list: #conflict.setDomain('Publication') conflict.setDomain(subscriber) #conflict.setDomainId(subscriber.getId()) conflict_list += [conflict.__of__(self)] for subscription in self.getSubscriptionList(): sub_conflict_list = subscription.getConflictList() for conflict in sub_conflict_list: #conflict.setDomain('Subscription') conflict.setDomain(subscription) #conflict.setDomainId(subscription.getId()) conflict_list += [conflict.__of__(self)] if path is not None: # Retrieve only conflicts for a given path new_list = [] for conflict in conflict_list: if conflict.getObjectPath() == path: new_list += [conflict.__of__(self)] return new_list return conflict_list security.declareProtected(Permissions.AccessContentsInformation,'getSynchronizationState') def getSynchronizationState(self, path): """ context : the context on which we are looking for state This functions have to retrieve the synchronization state, it will first look in the conflict list, if nothing is found, then we have to check on a publication/subscription. This method returns a mapping between subscription and states JPS suggestion: path -> object, document, context, etc. type -> '/titi/toto' or ('','titi', 'toto') or <Base instance 1562567> object = self.resolveContext(context) (method to add) """ conflict_list = self.getConflictList() state_list= [] LOG('getSynchronizationState',0,'path: %s' % str(path)) for conflict in conflict_list: if conflict.getObjectPath() == path: LOG('getSynchronizationState',0,'found a conflict: %s' % str(conflict)) state_list += [[conflict.getDomain(),self.CONFLICT]] for domain in self.getDomainList(): destination = domain.getDestinationPath() LOG('getSynchronizationState',0,'destination: %s' % str(destination)) j_path = '/'.join(path) LOG('getSynchronizationState',0,'j_path: %s' % str(j_path)) if j_path.find(destination)==0: o_id = j_path[len(destination)+1:].split('/')[0] LOG('getSynchronizationState',0,'o_id: %s' % o_id) subscriber_list = [] if domain.domain_type==self.PUB: subscriber_list = domain.getSubscriberList() else: subscriber_list = [domain] for subscriber in subscriber_list: signature = subscriber.getSignature(o_id) if signature is not None: state = signature.getStatus() found = None # Make sure there is not already a conflict giving the state for state_item in state_list: if state_item[0]==subscriber: found = 1 if found is None: state_list += [[subscriber,state]] return state_list security.declareProtected(Permissions.ModifyPortalContent, 'applyLocalValue') def applyLocalValue(self, conflict): """ after a conflict resolution, we have decided to keep the local version of an object XXXC Local ? Remote ? applyPublisherValue ? (JPS 1) applySubscriberValue ? applyPublicationValue ? (JPS 2) applySubscriptionValue ? applyPublishedValue ? (JPS 3) applySubscribedValue ? """ object = self.unrestrictedTraverse(conflict.getObjectPath()) subscriber = conflict.getDomain() # get the signature: LOG('p_sync.setLocalObject, subscriber: ',0,subscriber) signature = subscriber.getSignature(object.getId()) # XXX may be change for rid signature.delConflict(conflict) if signature.getConflictList() == []: signature.setStatus(self.PUB_CONFLICT_MERGE) security.declareProtected(Permissions.ModifyPortalContent, 'applyRemoteValue') def applyRemoteValue(self, conflict): """ after a conflict resolution, we have decided to keep the local version of an object """ object = self.unrestrictedTraverse(conflict.getObjectPath()) subscriber = conflict.getDomain() # get the signature: LOG('p_sync.setRemoteObject, subscriber: ',0,subscriber) signature = subscriber.getSignature(object.getId()) # XXX may be change for rid conduit = ERP5Conduit() for xupdate in conflict.getXupdateList(): conduit.updateNode(xml=xupdate,object=object,force=1) signature.delConflict(conflict) if signature.getConflictList() == []: signature.setStatus(self.PUB_CONFLICT_MERGE) security.declareProtected(Permissions.ModifyPortalContent, 'manageLocalValue') def manageLocalValue(self, subscription_url, keyword, object_path, RESPONSE=None): """ Do whatever needed in order to store the local value on the remote server Suggestion: manage_applyLocalValue XXX Suggestion: add global apply (not conflict per conflict) XXX Suggestion (API) add method to view document with applied xupdate of a given subscriber XX (ex. viewSubscriberDocument?path=ddd&subscriber_id=dddd) Version=Version CPS """ # Retrieve the conflict object LOG('manageLocalValue',0,'%s %s %s' % (str(subscription_url), str(keyword), str(object_path))) for conflict in self.getConflictList(): LOG('manageLocalValue, conflict:',0,conflict) if conflict.getKeyword() == keyword: LOG('manageLocalValue',0,'found the keyword') if '/'.join(conflict.getObjectPath())==object_path: if conflict.getDomain().getSubscriptionUrl()==subscription_url: conflict.applyLocalValue() if RESPONSE is not None: RESPONSE.redirect('manageConflicts') security.declareProtected(Permissions.ModifyPortalContent, 'manageRemoteValue') def manageRemoteValue(self, subscription_url, keyword, object_path, RESPONSE=None): """ Do whatever needed in order to store the remote value locally and confirmed that the remote box should keep it's value """ LOG('manageLocalValue',0,'%s %s %s' % (str(subscription_url), str(keyword), str(object_path))) for conflict in self.getConflictList(): LOG('manageLocalValue, conflict:',0,conflict) if conflict.getKeyword() == keyword: LOG('manageLocalValue',0,'found the keyword') if '/'.join(conflict.getObjectPath())==object_path: if conflict.getDomain().getSubscriptionUrl()==subscription_url: conflict.applyRemoteValue() if RESPONSE is not None: RESPONSE.redirect('manageConflicts') InitializeClass( SynchronizationTool )