Subscription.py 35.4 KB
Newer Older
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
##############################################################################
#
# 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.
#
##############################################################################

from Globals import PersistentMapping
from time import gmtime,strftime # for anchors
from SyncCode import SyncCode
32
from AccessControl import ClassSecurityInfo
Sebastien Robin's avatar
Sebastien Robin committed
33 34
from Products.CMFCore.utils import getToolByName
from Acquisition import Implicit, aq_base
Jean-Paul Smets's avatar
Jean-Paul Smets committed
35
from Products.ERP5Type.Core.Folder import Folder
36 37 38
from Products.ERP5Type.Base import Base
from Products.ERP5Type import Permissions
from Products.ERP5Type import PropertySheet
Sebastien Robin's avatar
Sebastien Robin committed
39
from DateTime import DateTime
Jean-Paul Smets's avatar
Jean-Paul Smets committed
40 41 42 43
from zLOG import LOG

import md5

44 45 46 47 48
try:
    from base64 import b64encode, b64decode
except ImportError:
    from base64 import encodestring as b64encode, decodestring as b64decode

49 50
#class Conflict(SyncCode, Implicit):
class Conflict(SyncCode, Base):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
51 52 53
  """
    object_path : the path of the obect
    keyword : an identifier of the conflict
54 55
    publisher_value : the value that we have locally
    subscriber_value : the value sent by the remote box
Jean-Paul Smets's avatar
Jean-Paul Smets committed
56 57

  """
58
  isIndexable = 0
59
  isPortalContent = 0 # Make sure RAD generated accessors at the class level
60

61 62
  def __init__(self, object_path=None, keyword=None, xupdate=None, 
      publisher_value=None, subscriber_value=None, subscriber=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
63 64
    self.object_path=object_path
    self.keyword = keyword
65 66 67
    self.setLocalValue(publisher_value)
    self.setRemoteValue(subscriber_value)
    self.subscriber = subscriber
68
    self.resetXupdate()
69
    self.copy_path = None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
70 71 72

  def getObjectPath(self):
    """
73
    get the object path
Jean-Paul Smets's avatar
Jean-Paul Smets committed
74 75 76
    """
    return self.object_path

77
  def getPublisherValue(self):
78 79 80
    """
    get the domain
    """
81
    return self.publisher_value
82

83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
  def getXupdateList(self):
    """
    get the xupdate wich gave an error
    """
    xupdate_list = []
    if len(self.xupdate)>0:
      for xupdate in self.xupdate:
        xupdate_list+= [xupdate]
    return xupdate_list

  def resetXupdate(self):
    """
    Reset the xupdate list
    """
    self.xupdate = PersistentMapping()

  def setXupdate(self, xupdate):
    """
    set the xupdate
    """
    if xupdate == None:
      self.resetXupdate()
    else:
      self.xupdate = self.getXupdateList() + [xupdate]

  def setXupdateList(self, xupdate):
    """
    set the xupdate
    """
    self.xupdate = xupdate

114 115 116 117 118
  def setLocalValue(self, value):
    """
    get the domain
    """
    try:
119
      self.publisher_value = value
120
    except TypeError: # It happens when we try to store StringIO
121
      self.publisher_value = None
122

123
  def getSubscriberValue(self):
124 125 126
    """
    get the domain
    """
127
    return self.subscriber_value
128 129 130 131 132 133

  def setRemoteValue(self, value):
    """
    get the domain
    """
    try:
134
      self.subscriber_value = value
135
    except TypeError: # It happens when we try to store StringIO
136
      self.subscriber_value = None
137

138
  def applyPublisherValue(self):
Sebastien Robin's avatar
Sebastien Robin committed
139 140 141 142 143
    """
      after a conflict resolution, we have decided
      to keep the local version of this object
    """
    p_sync = getToolByName(self,'portal_synchronizations')
144
    p_sync.applyPublisherValue(self)
Sebastien Robin's avatar
Sebastien Robin committed
145

146 147 148 149 150 151 152 153
  def applyPublisherDocument(self):
    """
      after a conflict resolution, we have decided
      to keep the local version of this object
    """
    p_sync = getToolByName(self,'portal_synchronizations')
    p_sync.applyPublisherDocument(self)

154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183
  def getPublisherDocument(self):
    """
      after a conflict resolution, we have decided
      to keep the local version of this object
    """
    p_sync = getToolByName(self,'portal_synchronizations')
    return p_sync.getPublisherDocument(self)

  def getPublisherDocumentPath(self):
    """
      after a conflict resolution, we have decided
      to keep the local version of this object
    """
    p_sync = getToolByName(self,'portal_synchronizations')
    return p_sync.getPublisherDocumentPath(self)

  def getSubscriberDocument(self):
    """
      after a conflict resolution, we have decided
      to keep the local version of this object
    """
    p_sync = getToolByName(self,'portal_synchronizations')
    return p_sync.getSubscriberDocument(self)

  def getSubscriberDocumentPath(self):
    """
      after a conflict resolution, we have decided
      to keep the local version of this object
    """
    p_sync = getToolByName(self,'portal_synchronizations')
184
    return p_sync.getSubscriberDocumentPath(self)
185

186
  def applySubscriberDocument(self):
187 188 189 190 191 192 193
    """
      after a conflict resolution, we have decided
      to keep the local version of this object
    """
    p_sync = getToolByName(self,'portal_synchronizations')
    p_sync.applySubscriberDocument(self)

194
  def applySubscriberValue(self,object=None):
Sebastien Robin's avatar
Sebastien Robin committed
195 196 197 198
    """
    get the domain
    """
    p_sync = getToolByName(self,'portal_synchronizations')
199
    p_sync.applySubscriberValue(self,object=object)
Sebastien Robin's avatar
Sebastien Robin committed
200

201
  def setSubscriber(self, subscriber):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
202 203 204
    """
    set the domain
    """
205
    self.subscriber = subscriber
Jean-Paul Smets's avatar
Jean-Paul Smets committed
206

207
  def getSubscriber(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
208 209 210
    """
    get the domain
    """
211
    return self.subscriber
Jean-Paul Smets's avatar
Jean-Paul Smets committed
212

213 214 215 216 217 218
  def getKeyword(self):
    """
    get the domain
    """
    return self.keyword

219
  def getPropertyId(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
220
    """
221
    get the property id
Jean-Paul Smets's avatar
Jean-Paul Smets committed
222
    """
223
    return self.keyword
Jean-Paul Smets's avatar
Jean-Paul Smets committed
224

225 226 227 228 229 230 231 232 233 234 235 236
  def getCopyPath(self):
    """
    Get the path of the copy, or None if none has been made
    """
    copy_path = self.copy_path
    return copy_path
    
  def setCopyPath(self, path):
    """
    """
    self.copy_path = path
    
237

238
class Signature(Folder,SyncCode):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
239 240 241 242 243
  """
    status -- SENT, CONFLICT...
    md5_object -- An MD5 value of a given document
    #uid -- The UID of the document
    id -- the ID of the document
244
    gid -- the global id of the document
Jean-Paul Smets's avatar
Jean-Paul Smets committed
245 246 247 248
    rid -- the uid of the document on the remote database,
        only needed on the server.
    xml -- the xml of the object at the time where it was synchronized
  """
249
  isIndexable = 0
250 251
  isPortalContent = 0 # Make sure RAD generated accessors at the class level
  
Jean-Paul Smets's avatar
Jean-Paul Smets committed
252
  # Constructor
253
  def __init__(self,gid=None, id=None, status=None, xml_string=None,object=None):
254
    self.setGid(gid)
255 256
    if object is not None:
      self.setPath(object.getPhysicalPath())
257
    self.setId(id)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
258 259 260 261 262 263
    self.status = status
    self.setXML(xml_string)
    self.partial_xml = None
    self.action = None
    self.setTempXML(None)
    self.resetConflictList()
264
    self.md5_string = None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
265
    self.force = 0
266 267
    self.setSubscriberXupdate(None)
    self.setPublisherXupdate(None)
268
    Folder.__init__(self,id)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
269 270 271 272 273 274 275 276 277 278 279 280 281 282

  def setStatus(self, status):
    """
      set the Status (see SyncCode for numbers)
    """
    self.status = status
    if status == self.SYNCHRONIZED:
      temp_xml = self.getTempXML()
      self.setForce(0)
      if temp_xml is not None:
        # This happens when we have sent the xml
        # and we just get the confirmation
        self.setXML(self.getTempXML())
      self.setTempXML(None)
283
      self.setPartialXML(None)
284
      self.setSubscriberXupdate(None)
Sebastien Robin's avatar
Sebastien Robin committed
285
      self.setPublisherXupdate(None)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
286 287
      if len(self.getConflictList())>0:
        self.resetConflictList()
Sebastien Robin's avatar
Sebastien Robin committed
288 289 290
      # XXX This may be a problem, if the document is changed
      # during a synchronization
      self.setLastSynchronizationDate(DateTime())
291
      self.getParentValue().removeRemainingObjectPath(self.getPath())
292 293 294
    if status == self.NOT_SYNCHRONIZED:
      self.setTempXML(None)
      self.setPartialXML(None)
295 296 297
    elif status in (self.PUB_CONFLICT_MERGE,self.SENT):
      # We have a solution for the conflict, don't need to keep the list
      self.resetConflictList()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
298 299 300 301 302 303 304

  def getStatus(self):
    """
      get the Status (see SyncCode for numbers)
    """
    return self.status

305 306 307 308 309 310 311 312 313 314 315 316
  def getPath(self):
    """
      get the force value (if we need to force update or not)
    """
    return getattr(self,'path',None)

  def setPath(self, path):
    """
      set the force value (if we need to force update or not)
    """
    self.path = path

Jean-Paul Smets's avatar
Jean-Paul Smets committed
317 318 319 320 321 322 323 324 325 326 327 328
  def getForce(self):
    """
      get the force value (if we need to force update or not)
    """
    return self.force

  def setForce(self, force):
    """
      set the force value (if we need to force update or not)
    """
    self.force = force

Sebastien Robin's avatar
Sebastien Robin committed
329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356
  def getLastModificationDate(self):
    """
      get the last modfication date, so that we don't always
      check the xml
    """
    return getattr(self,'modification_date',None)

  def setLastModificationDate(self,value):
    """
      set the last modfication date, so that we don't always
      check the xml
    """
    setattr(self,'modification_date',value)

  def getLastSynchronizationDate(self):
    """
      get the last modfication date, so that we don't always
      check the xml
    """
    return getattr(self,'synchronization_date',None)

  def setLastSynchronizationDate(self,value):
    """
      set the last modfication date, so that we don't always
      check the xml
    """
    setattr(self,'synchronization_date',value)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
357 358 359 360 361 362 363
  def setXML(self, xml):
    """
      set the XML corresponding to the object
    """
    self.xml = xml
    if self.xml != None:
      self.setTempXML(None) # We make sure that the xml will not be erased
364
      self.setMD5(xml)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
365 366 367 368 369

  def getXML(self):
    """
      set the XML corresponding to the object
    """
370 371 372 373
    xml =  getattr(self,'xml',None)
    if xml == '':
      xml = None
    return xml
Jean-Paul Smets's avatar
Jean-Paul Smets committed
374 375 376 377 378 379 380 381 382 383 384 385 386 387 388

  def setTempXML(self, xml):
    """
      This is the xml temporarily saved, it will
      be stored with setXML when we will receive
      the confirmation of synchronization
    """
    self.temp_xml = xml

  def getTempXML(self):
    """
      get the temp xml
    """
    return self.temp_xml

389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412
  def setSubscriberXupdate(self, xupdate):
    """
    set the full temp xupdate
    """
    self.subscriber_xupdate = xupdate

  def getSubscriberXupdate(self):
    """
    get the full temp xupdate
    """
    return self.subscriber_xupdate

  def setPublisherXupdate(self, xupdate):
    """
    set the full temp xupdate
    """
    self.publisher_xupdate = xupdate

  def getPublisherXupdate(self):
    """
    get the full temp xupdate
    """
    return self.publisher_xupdate

Jean-Paul Smets's avatar
Jean-Paul Smets committed
413 414 415 416 417 418 419 420 421 422
  def setMD5(self, xml):
    """
      set the MD5 object of this signature
    """
    self.md5_string = md5.new(xml).digest()

  def getMD5(self):
    """
      get the MD5 object of this signature
    """
423
    return self.md5_string
Jean-Paul Smets's avatar
Jean-Paul Smets committed
424 425 426 427 428 429 430 431

  def checkMD5(self, xml_string):
    """
    check if the given md5_object returns the same things as
    the one stored in this signature, this is very usefull
    if we want to know if an objects has changed or not
    Returns 1 if MD5 are equals, else it returns 0
    """
432
    return ((md5.new(xml_string).digest()) == self.getMD5())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457

  def setRid(self, rid):
    """
      set the rid
    """
    self.rid = rid

  def getRid(self):
    """
      get the rid
    """
    return self.rid

  def setId(self, id):
    """
      set the id
    """
    self.id = id

  def getId(self):
    """
      get the id
    """
    return self.id

458 459 460 461 462 463 464 465 466 467 468 469
  def setGid(self, gid):
    """
      set the id
    """
    self.gid = gid

  def getGid(self):
    """
      get the id
    """
    return self.gid

Jean-Paul Smets's avatar
Jean-Paul Smets committed
470 471 472 473 474
  def setPartialXML(self, xml):
    """
    Set the partial string we will have to
    deliver in the future
    """
475 476
    if type(xml) is type(u'a'):
      xml = xml.encode('utf-8')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
477 478 479 480 481 482 483
    self.partial_xml = xml

  def getPartialXML(self):
    """
    Set the partial string we will have to
    deliver in the future
    """
484
    #LOG('Subscriber.getPartialXML',0,'partial_xml: %s' % str(self.partial_xml))
485 486
    if self.partial_xml is not None:
      self.partial_xml = self.partial_xml.replace('@-@@-@','--') # need to put back '--'
Jean-Paul Smets's avatar
Jean-Paul Smets committed
487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520
    return self.partial_xml

  def getAction(self):
    """
    Return the actual action for a partial synchronization
    """
    return self.action

  def setAction(self, action):
    """
    Return the actual action for a partial synchronization
    """
    self.action = action

  def getConflictList(self):
    """
    Return the actual action for a partial synchronization
    """
    conflict_list = []
    if len(self.conflict_list)>0:
      for conflict in self.conflict_list:
        conflict_list += [conflict]
    return conflict_list

  def resetConflictList(self):
    """
    Return the actual action for a partial synchronization
    """
    self.conflict_list = PersistentMapping()

  def setConflictList(self, conflict_list):
    """
    Return the actual action for a partial synchronization
    """
521
    # LOG('setConflictList, list',0,conflict_list)
Sebastien Robin's avatar
Sebastien Robin committed
522
    if conflict_list is None or conflict_list==[]:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
523 524
      self.resetConflictList()
    else:
Sebastien Robin's avatar
Sebastien Robin committed
525 526 527 528 529 530
      self.conflict_list = conflict_list

  def delConflict(self, conflict):
    """
    Return the actual action for a partial synchronization
    """
531
    # LOG('delConflict, conflict',0,conflict)
Sebastien Robin's avatar
Sebastien Robin committed
532 533 534 535 536 537 538 539 540
    conflict_list = []
    for c in self.getConflictList():
      LOG('delConflict, c==conflict',0,c==aq_base(conflict))
      if c != aq_base(conflict):
        conflict_list += [c]
    if conflict_list != []:
      self.setConflictList(conflict_list)
    else:
      self.resetConflictList()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
541

542 543 544 545
  def getObject(self):
    """
    Returns the object corresponding to this signature
    """
546
    return self.getParentValue().getObjectFromGid(self.getGid())
547

548 549 550 551 552
  def checkSynchronizationNeeded(self, object):
    """
    We will look at date, if there is no changes, no need to syncrhonize
    """
    last_modification = DateTime(object.ModificationDate())
553
    # LOG('checkSynchronizationNeeded object.ModificationDate()',0,object.ModificationDate())
554 555 556 557 558 559 560 561 562 563
    last_synchronization = self.getLastSynchronizationDate()
    parent = object.aq_parent
    # XXX CPS Specific
    if parent.id == 'portal_repository': # Make sure there is no sub objects
    #if 1:
      if last_synchronization is not None and last_modification is not None \
        and self.getSubscriberXupdate() is None and self.getPublisherXupdate() is None and \
        self.getStatus()==self.NOT_SYNCHRONIZED:
        if last_synchronization > last_modification:
        #if 1:
564
          # LOG('checkSynchronizationNeeded, no modification on: ',0,object.id)
565 566 567
          self.setStatus(self.SYNCHRONIZED)
    

568

569 570
def addSubscription( self, id, title='', REQUEST=None ):
    """
571
    Add a new Subscribption
572 573 574 575 576 577 578 579
    """
    o = Subscription( id ,'','','','','','')
    self._setObject( id, o )
    if REQUEST is not None:
        return self.manage_main(self, REQUEST, update_menu=1)
    return o

#class Subscription(SyncCode, Implicit):
580 581
#class Subscription(Folder, SyncCode, Implicit, Folder, Impli):
class Subscription(Folder, SyncCode):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598
  """
    Subscription hold the definition of a master ODB
    from/to which a selection of objects will be synchronised

    Subscription defined by::

    publication_url -- a URI to a publication

    subsribtion_url -- URL of ourselves

    destination_path -- the place where objects are stored

    query   -- a query which defines a local set of documents which
           are going to be synchronised

    xml_mapping -- a PageTemplate to map documents to XML

599 600
    gpg_key -- the name of a gpg key to use

Jean-Paul Smets's avatar
Jean-Paul Smets committed
601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616
    Subscription also holds private data to manage
    the synchronisation. We choose to keep an MD5 value for
    all documents which belong to the synchronisation process::

    signatures -- a dictionnary which contains the signature
           of documents at the time they were synchronized

    session_id -- it defines the id of the session
         with the server.

    last_anchor - it defines the id of the last synchronisation

    next_anchor - it defines the id of the current synchronisation

  """

617
  meta_type='ERP5 Subscription'
618
  portal_type='SyncML Subscription' # may be useful in the future...
619 620 621
  isPortalContent = 1
  isRADContent = 1
  icon = None
622
  isIndexable = 0
623
  user = None
624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640

  # Declarative properties
  property_sheets = ( PropertySheet.Base
                    , PropertySheet.SimpleItem )

  allowed_types = ( 'Signatures',)

  # Declarative constructors
  constructors =   (addSubscription,)

  # Declarative security
  security = ClassSecurityInfo()
  security.declareProtected(Permissions.ManagePortal,
                            'manage_editProperties',
                            'manage_changeProperties',
                            'manage_propertiesForm',
                              )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
641 642

  # Constructor
643 644
  def __init__(self, id, title, publication_url, subscription_url, destination_path, query, xml_mapping, conduit, gpg_key, login, password, 
      authentication_format='', authentication_type=''):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
645 646 647 648 649 650 651 652 653
    """
      We need to create a dictionnary of
      signatures of documents which belong to the synchronisation
      process
    """
    self.id = id
    self.publication_url = (publication_url)
    self.subscription_url = str(subscription_url)
    self.destination_path = str(destination_path)
654
    self.setQuery(query)
655
    self.setXMLMapping(xml_mapping)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
656 657
    self.anchor = None
    self.session_id = 0
658
    #self.signatures = PersistentMapping()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
659 660
    self.last_anchor = '00000000T000000Z'
    self.next_anchor = '00000000T000000Z'
661 662 663 664
    self.login=login
    self.password=password
    self.authentication_format=authentication_format
    self.authentication_type=authentication_type
Jean-Paul Smets's avatar
Jean-Paul Smets committed
665
    self.domain_type = self.SUB
666
    self.gpg_key = gpg_key
667 668
    self.setGidGenerator(None)
    self.setIdGenerator(None)
669
    self.setConduit(conduit)
670 671
    Folder.__init__(self, id)
    self.title = title
Sebastien Robin's avatar
Sebastien Robin committed
672
    
Jean-Paul Smets's avatar
Jean-Paul Smets committed
673 674
    #self.signatures = PersitentMapping()

675 676 677 678 679 680 681 682 683 684 685 686
  def getTitle(self):
    """
    getter for title
    """
    return getattr(self,'title',None)

  def setTitle(self, value):
    """
    setter for title
    """
    self.title = value

Jean-Paul Smets's avatar
Jean-Paul Smets committed
687 688 689 690 691 692 693 694 695 696 697 698
  # Accessors
  def getRemoteId(self, id, path=None):
    """
      Returns the remote id from a know local id
      Returns None if...
      path allows to implement recursive sync
    """
    pass

  def getSynchronizationType(self, default=None):
    """
    """
699 700 701
    # XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
    # XXX for debugging only, to be removed
    dict_sign = {}
702 703
    for o in self.objectValues():
      dict_sign[o.getId()] = o.getStatus()
704
    # LOG('getSignature',0,'signatures_status: %s' % str(dict_sign))
705
    # XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
Jean-Paul Smets's avatar
Jean-Paul Smets committed
706
    code = self.SLOW_SYNC
707
    if len(self.objectValues()) > 0:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
708 709 710
      code = self.TWO_WAY
    if default is not None:
      code = default
711
    # LOG('Subscription',0,'getSynchronizationType: %s' % code)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
712 713
    return code

714 715 716 717 718 719 720 721
  def setXMLMapping(self, value):
    """
    this the name of the method used in order to get the xml
    """
    if value == '':
      value = None
    self.xml_mapping = value

722 723 724 725 726
  def checkCorrectRemoteSessionId(self, session_id):
    """
    We will see if the last session id was the same
    wich means that the same message was sent again

727
    return True if the session id was not seen, False if already seen
728 729 730
    """
    last_session_id = getattr(self,'last_session_id',None)
    if last_session_id == session_id:
731
      return False 
732
    self.last_session_id = session_id
733
    return True
734

Sebastien Robin's avatar
Sebastien Robin committed
735 736 737 738 739
  def checkCorrectRemoteMessageId(self, message_id):
    """
    We will see if the last message id was the same
    wich means that the same message was sent again

740
    return True if the message id was not seen, False if already seen
Sebastien Robin's avatar
Sebastien Robin committed
741 742
    """
    last_message_id = getattr(self,'last_message_id',None)
743 744
    # LOG('checkCorrectRemoteMessageId  last_message_id =',0,last_message_id)
    # LOG('checkCorrectRemoteMessageId  message_id =',0,message_id)
Sebastien Robin's avatar
Sebastien Robin committed
745
    if last_message_id == message_id:
746
      return False
Sebastien Robin's avatar
Sebastien Robin committed
747
    self.last_message_id = message_id
748
    return True
Sebastien Robin's avatar
Sebastien Robin committed
749 750 751 752 753 754

  def initLastMessageId(self, last_message_id=None):
    """
    set the last message id to 0
    """
    self.last_message_id=last_message_id
755 756 757 758 759 760 761 762 763 764 765 766 767

  def getLastSentMessage(self):
    """
    This is the getter for the last message we have sent
    """
    return getattr(self,'last_sent_message','')

  def setLastSentMessage(self,xml):
    """
    This is the setter for the last message we have sent
    """
    self.last_sent_message = xml

Jean-Paul Smets's avatar
Jean-Paul Smets committed
768 769 770 771 772 773 774 775 776 777 778 779 780
  def getLocalId(self, rid, path=None):
    """
      Returns the local id from a know remote id
      Returns None if...
    """
    pass

  def getId(self):
    """
      return the ID
    """
    return self.id

781 782 783 784 785 786
  def getDomainType(self):
    """
      return the ID
    """
    return self.domain_type

Jean-Paul Smets's avatar
Jean-Paul Smets committed
787 788 789 790 791 792
  def setId(self, id):
    """
      set the ID
    """
    self.id = id

793 794 795 796 797 798 799 800 801 802 803 804 805
  def setConduit(self, value):
    """
      set the Conduit
    """
    self.conduit = value

  def getConduit(self):
    """
      get the Conduit

    """
    return getattr(self,'conduit',None)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
806 807 808 809 810 811
  def getQuery(self):
    """
      return the query
    """
    return self.query

812 813 814 815 816 817
  def getGPGKey(self):
    """
      return the gnupg key name
    """
    return getattr(self,'gpg_key','')

818 819 820 821 822 823
  def setGPGKey(self, value):
    """
      setter for the gnupg key name
    """
    self.gpg_key = value

Jean-Paul Smets's avatar
Jean-Paul Smets committed
824 825 826 827
  def setQuery(self, query):
    """
      set the query
    """
828 829
    if query == '':
      query = None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849
    self.query = query

  def getPublicationUrl(self):
    """
      return the publication url
    """
    return self.publication_url

  def getLocalUrl(self):
    """
      return the publication url
    """
    return self.publication_url

  def setPublicationUrl(self, publication_url):
    """
      return the publication url
    """
    self.publication_url = publication_url

850
  def getXMLMapping(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
851 852 853
    """
      return the xml mapping
    """
854 855
    xml_mapping = getattr(self,'xml_mapping','asXML')
    return xml_mapping
Jean-Paul Smets's avatar
Jean-Paul Smets committed
856

857
  def getXMLFromObject(self,object):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
858 859 860
    """
      return the xml mapping
    """
861 862 863 864 865 866 867
    xml_mapping = self.getXMLMapping()
    xml = ''
    if xml_mapping is not None:
      func = getattr(object,xml_mapping,None)
      if func is not None:
        xml = func()
    return xml
Jean-Paul Smets's avatar
Jean-Paul Smets committed
868

869
  def setGidGenerator(self, method):
870 871 872 873
    """
    This set the method name wich allows to find a gid
    from any object
    """
874
    if method in (None,'','None'):
875 876
      method = 'getId'
    self.gid_generator = method
877 878 879 880 881 882 883 884

  def getGidGenerator(self):
    """
    This get the method name wich allows to find a gid
    from any object
    """
    return self.gid_generator

885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939
  def getLogin(self):
    """
    This method return the login of this subscription
    """
    return getattr(self, 'login', '')

  def setLogin(self, new_login):
    """
    set the login at new_login
    """
    self.login=new_login

  def getPassword(self):
    """
    This method return the password of this subscription
    """
    return getattr(self, 'password', '')

  def setPassword(self, new_password):
    """
    set the password at new_password
    """
    self.password=new_password
  

  def setAuthentication(self, auth):
    """
      set the value of the authentication requirement
    """
    self.auth_required = auth

  def getAuthenticationFormat(self):
    """
      return the format of authentication
    """
    return getattr(self, 'authentication_format', '')

  def getAuthenticationType(self):
    """
      return the type of authentication
    """
    return getattr(self, 'authentication_type', '')

  def setAuthenticationFormat(self, authentication_format):
    """
      set the format of authentication
    """
    self.authentication_format = authentication_format

  def setAuthenticationType(self, authentication_type):
    """
      set the type of authentication
    """
    self.authentication_type = authentication_type

940 941 942 943 944 945 946 947
  def getGidFromObject(self, object):
    """
    """
    o_base = aq_base(object)
    o_gid = None
    gid_gen = self.getGidGenerator()
    if callable(gid_gen):
      o_gid=gid_gen(object)
948
    elif getattr(o_base, gid_gen, None) is not None:
949
      generator = getattr(object, gid_gen)
950
      o_gid = generator() # XXX - used to be o_gid = generator(object=object) which is redundant
951 952 953
    elif gid_gen is not None:
      # It might be a script python
      generator = getattr(object,gid_gen)
954 955
      o_gid = generator() # XXX - used to be o_gid = generator(object=object) which is redundant
      # LOG('getGidFromObject',0,'o_gid: %s' % repr(o_gid))
956 957
    return o_gid

958 959 960 961 962 963 964 965 966 967
  def getObjectFromGid(self, gid):
    """
    This tries to get the object with the given gid
    This uses the query if it exist
    """
    signature = self.getSignature(gid)
    # First look if we do already have the mapping between
    # the id and the gid
    object_list = self.getObjectList()
    destination = self.getDestination()
968 969 970
    # LOG('getObjectFromGid', 0, 'self: %s' % self)    
    # LOG('getObjectFromGid',0,'gid: %s' % repr(gid))
    # LOG('getObjectFromGid oject_list',0,object_list)
971
    if signature is not None and signature.getId() is not None:
972 973 974 975
      o_id = signature.getId()
      o = None
      try:
        o = destination._getOb(o_id)
976
      except (AttributeError, KeyError, TypeError):
977 978 979 980
        pass
      if o is not None and o in object_list:
        return o
    for o in object_list:
981 982 983
      o_gid = self.getGidFromObject(o)
      if o_gid == gid:
        return o
984
    # LOG('getObjectFromGid',0,'returning None')
985 986
    return None

987 988 989 990 991 992 993 994 995
#  def setOneWaySyncFromServer(self,value):
#    """
#    If this option is enabled, then we will not 
#    send our own modifications
#    """
#    self.one_way_sync_from_server = value
#


996 997 998 999 1000 1001 1002 1003
  def getObjectList(self):
    """
    This returns the list of sub-object corresponding
    to the query
    """
    destination = self.getDestination()
    query = self.getQuery()
    query_list = []
1004 1005
    if query is None:
      return query_list
Sebastien Robin's avatar
Sebastien Robin committed
1006
    if isinstance(query, str):
1007 1008 1009
      query_method = getattr(destination,query,None)
      if query_method is not None:
        query_list = query_method()
1010
    elif callable(query): # XXX - used to be if callable(query)
1011
      query_list = query(destination)
1012 1013
    return [x for x in query_list
              if not getattr(x,'_conflict_resolution',False)]
1014

1015
  def generateNewIdWithGenerator(self, object=None,gid=None):
1016 1017 1018
    """
    This tries to generate a new Id
    """
1019
    # LOG('generateNewId, object: ',0,object.getPhysicalPath())
1020
    id_generator = self.getIdGenerator()
1021 1022
    # LOG('generateNewId, id_generator: ',0,id_generator)
    # LOG('generateNewId, portal_object: ',0,object.getPortalObject())
1023
    if id_generator is not None:
1024
      o_base = aq_base(object)
1025 1026
      new_id = None
      if callable(id_generator):
1027
        new_id = id_generator(object,gid=gid)
1028
      elif getattr(o_base, id_generator, None) is not None:
1029
        generator = getattr(object, id_generator)
1030
        new_id = generator()
1031 1032 1033 1034
      else: 
        # This is probably a python scrip
        generator = getattr(object, id_generator)
        new_id = generator(object=object,gid=gid)
1035 1036
      LOG('generateNewId, new_id: ',0,new_id)
      return new_id
1037 1038
    return None

1039
  def setIdGenerator(self, method):
1040 1041 1042 1043
    """
    This set the method name wich allows to generate
    a new id
    """
1044 1045
    if method in ('','None'):
      method = None
1046
    self.id_generator = method
1047 1048 1049 1050 1051 1052 1053

  def getIdGenerator(self):
    """
    This get the method name wich allows to generate a new id
    """
    return self.id_generator

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071
  def getSubscriptionUrl(self):
    """
      return the subscription url
    """
    return self.subscription_url

  def setSubscriptionUrl(self, subscription_url):
    """
      set the subscription url
    """
    self.subscription_url = subscription_url

  def getDestinationPath(self):
    """
      return the destination path
    """
    return self.destination_path

1072 1073 1074 1075 1076 1077
  def getDestination(self):
    """
      return the destination object itself
    """
    return self.unrestrictedTraverse(self.getDestinationPath())

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088
  def setDestinationPath(self, destination_path):
    """
      set the destination path
    """
    self.destination_path = destination_path

  def getSubscription(self):
    """
      return the current subscription
    """
    return self
Sebastien Robin's avatar
Sebastien Robin committed
1089 1090 1091 1092 1093 1094
    
  def setSessionId(self, session_id):
    """
      set the session id
    """
    self.session_id = session_id
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1095 1096 1097 1098 1099

  def getSessionId(self):
    """
      return the session id
    """
Sebastien Robin's avatar
Sebastien Robin committed
1100 1101 1102 1103 1104 1105 1106
    #self.session_id += 1 #to be commented
    return self.session_id

  def incrementSessionId(self):
    """
      increment and return the session id
    """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1107
    self.session_id += 1
Sebastien Robin's avatar
Sebastien Robin committed
1108
    self.resetMessageId() # for a new session, the message Id must be reset
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1109 1110
    return self.session_id

Sebastien Robin's avatar
Sebastien Robin committed
1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132
  def incrementMessageId(self):
    """
      return the message id
    """
    #self.message_id += 1
    #return self.message_id
    #return 5
    value = getattr(self, 'message_id', 0)
    self.message_id = value +1
    return self.message_id

  def getMessageId(self):
    """
      increment and return the message id
    """
    return self.message_id

  def resetMessageId(self):
    """
      set the message id to 0
    """
    self.message_id = 0
1133 1134 1135 1136 1137 1138
  
  def setMessageId(self, message_id):
    """
      set the message id to message_id
    """
    self.message_id = message_id
Sebastien Robin's avatar
Sebastien Robin committed
1139

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183
  def getLastAnchor(self):
    """
      return the id of the last synchronisation
    """
    return self.last_anchor

  def getNextAnchor(self):
    """
      return the id of the current synchronisation
    """
    return self.next_anchor

  def setLastAnchor(self, last_anchor):
    """
      set the value last anchor
    """
    self.last_anchor = last_anchor

  def setNextAnchor(self, next_anchor):
    """
      set the value next anchor
    """
    # We store the old next anchor as the new last one
    self.last_anchor = self.next_anchor
    self.next_anchor = next_anchor

  def NewAnchor(self):
    """
      set a new anchor
    """
    self.last_anchor = self.next_anchor
    self.next_anchor = strftime("%Y%m%dT%H%M%SZ", gmtime())

  def resetAnchors(self):
    """
      reset both last and next anchors
    """
    self.last_anchor = self.NULL_ANCHOR
    self.next_anchor = self.NULL_ANCHOR

  def addSignature(self, signature):
    """
      add a Signature to the subscription
    """
1184 1185
    if signature.getGid() in self.objectIds():
      self._delObject(signature.getGid())
1186
    self._setObject( signature.getGid(), aq_base(signature) )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1187

1188
  def delSignature(self, gid):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1189 1190 1191
    """
      add a Signature to the subscription
    """
1192 1193
    #del self.signatures[gid]
    self._delObject(gid)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1194

1195
  def getSignature(self, gid):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1196 1197 1198
    """
      add a Signature to the subscription
    """
1199 1200 1201
    o = None
    if gid in self.objectIds():
      o = self._getOb(gid)
1202 1203
    #if o is not None:
    #  return o.__of__(self)
1204
    return o
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1205 1206 1207 1208 1209

  def getSignatureList(self):
    """
      add a Signature to the subscription
    """
1210
    return self.objectValues()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1211

1212
  def hasSignature(self, gid):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1213 1214 1215
    """
      Check if there's a signature with this uid
    """
1216 1217
    #return self.signatures.has_key(gid)
    return gid in self.objectIds()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1218 1219 1220 1221 1222

  def resetAllSignatures(self):
    """
      Reset all signatures
    """
1223 1224 1225
    while len(self.objectIds())>0:
      for id in self.objectIds():
        self._delObject(id)
1226

1227
  def getGidList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1228 1229 1230
    """
    Returns the list of ids from signature
    """
1231
    return self.objectIds()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1232 1233 1234 1235 1236 1237 1238 1239 1240 1241

  def getConflictList(self):
    """
    Return the list of all conflicts from all signatures
    """
    conflict_list = []
    for signature in self.getSignatureList():
      conflict_list += signature.getConflictList()
    return conflict_list

1242
  def getRemainingObjectPathList(self):
1243 1244 1245 1246
    """
    We should now wich objects should still
    synchronize
    """
1247
    return getattr(self,'remaining_object_path_list',None)
1248

1249
  def setRemainingObjectPathList(self, value):
1250 1251 1252 1253
    """
    We should now wich objects should still
    synchronize
    """
1254
    setattr(self,'remaining_object_path_list',value)
1255

1256
  def removeRemainingObjectPath(self, object_path):
1257 1258 1259 1260
    """
    We should now wich objects should still
    synchronize
    """
1261
    remaining_object_list = self.getRemainingObjectPathList()
1262 1263 1264
    if remaining_object_list is not None:
      new_list = []
      for o in remaining_object_list:
1265
        if o != object_path:
1266
          new_list.append(o)
1267
      self.setRemainingObjectPathList(new_list)
1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282

#  def getCurrentObject(self):
#    """
#    When we send some partial data, then we should
#    always synchronize the same object until it is finished
#    """
#    getattr(self,'current_object',None)
#
#  def setCurrentObject(self,object):
#    """
#    When we send some partial data, then we should
#    always synchronize the same object until it is finished
#    """
#    setattr(self,'current_object',object)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1283 1284 1285 1286
  def startSynchronization(self):
    """
    Set the status of every object as NOT_SYNCHRONIZED
    """
1287
    for o in self.objectValues():
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1288
      # Change the status only if we are not in a conflict mode
1289
      if not(o.getStatus() in (self.CONFLICT,self.PUB_CONFLICT_MERGE,
1290
                                                        self.PUB_CONFLICT_CLIENT_WIN)):
1291 1292 1293
        o.setStatus(self.NOT_SYNCHRONIZED)
        o.setPartialXML(None)
        o.setTempXML(None)
1294
    self.setRemainingObjectPathList(None)
1295

1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359

  def isAuthenticated(self):
    """
    return True if the subscriber is authenticated for this session, False 
    in other case
    """
    return self.is_authenticated
    
  def setAuthenticated(self, value):
    """
      set at True or False the value of is_authenticated is the subscriber
      is authenticated for this session or not
    """
    self.is_authenticated = value

  def encode(self, format, string_to_encode):
    """
      return the string_to_encode encoded with format format
    """
    if format in ('', None):
      return string_to_encode
    if format == 'b64':
      return b64encode(string_to_encode)
    #elif format is .... put here the other formats
    else:#if there is no format corresponding with format, raise an error
      LOG('encode : unknown or not implemented format :', 0, format)
      raise ValueError, "Sorry, the format %s is unknow or not implemented" % format

  def decode(self, format, string_to_decode):
    """
      return the string_to_decode decoded with format format
    """
    string_to_decode = string_to_decode.encode('utf-8')
    if format in ('', None):
      return string_to_decode
    if format == 'b64':
      return b64decode(string_to_decode)
    #elif format is .... put here the other formats
    else:#if there is no format corresponding with format, raise an error
      LOG('decode : unknown or not implemented format :', 0, format)
      raise ValueError, "Sorry, the format %s is unknow or not implemented" % format

  def isDecodeEncodeTheSame(self, string_encoded, string_decoded, format):
    """
      return True if the string_encoded is equal to string_decoded encoded 
      in format
    """
    isTheSame=False
    if self.encode(format, string_decoded) == string_encoded:
      isTheSame=True
    return isTheSame


  def setUser(self, user):
    """
      save the user logged in to log him on each transaction
    """
    self.user=user

  def getUser(self):
    """
      retrun the user logged in
    """
    return self.user