Subscription.py 30.2 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
35 36 37 38
from Products.ERP5Type.Document.Folder import Folder
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
#class Conflict(SyncCode, Implicit):
class Conflict(SyncCode, Base):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
46 47 48
  """
    object_path : the path of the obect
    keyword : an identifier of the conflict
49 50
    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
51 52

  """
53 54
  isIndexable = 0

55 56
  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
57 58
    self.object_path=object_path
    self.keyword = keyword
59 60 61
    self.setLocalValue(publisher_value)
    self.setRemoteValue(subscriber_value)
    self.subscriber = subscriber
62
    self.resetXupdate()
63
    self.copy_path = None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
64 65 66

  def getObjectPath(self):
    """
67
    get the object path
Jean-Paul Smets's avatar
Jean-Paul Smets committed
68 69 70
    """
    return self.object_path

71
  def getPublisherValue(self):
72 73 74
    """
    get the domain
    """
75
    return self.publisher_value
76

77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
  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

108 109 110 111 112
  def setLocalValue(self, value):
    """
    get the domain
    """
    try:
113
      self.publisher_value = value
114
    except TypeError: # It happens when we try to store StringIO
115
      self.publisher_value = None
116

117
  def getSubscriberValue(self):
118 119 120
    """
    get the domain
    """
121
    return self.subscriber_value
122 123 124 125 126 127

  def setRemoteValue(self, value):
    """
    get the domain
    """
    try:
128
      self.subscriber_value = value
129
    except TypeError: # It happens when we try to store StringIO
130
      self.subscriber_value = None
131

132
  def applyPublisherValue(self):
Sebastien Robin's avatar
Sebastien Robin committed
133 134 135 136 137
    """
      after a conflict resolution, we have decided
      to keep the local version of this object
    """
    p_sync = getToolByName(self,'portal_synchronizations')
138
    p_sync.applyPublisherValue(self)
Sebastien Robin's avatar
Sebastien Robin committed
139

140 141 142 143 144 145 146 147
  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)

148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177
  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')
178
    return p_sync.getSubscriberDocumentPath(self)
179

180
  def applySubscriberDocument(self):
181 182 183 184 185 186 187
    """
      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)

188
  def applySubscriberValue(self,object=None):
Sebastien Robin's avatar
Sebastien Robin committed
189 190 191 192
    """
    get the domain
    """
    p_sync = getToolByName(self,'portal_synchronizations')
193
    p_sync.applySubscriberValue(self,object=object)
Sebastien Robin's avatar
Sebastien Robin committed
194

195
  def setSubscriber(self, subscriber):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
196 197 198
    """
    set the domain
    """
199
    self.subscriber = subscriber
Jean-Paul Smets's avatar
Jean-Paul Smets committed
200

201
  def getSubscriber(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
202 203 204
    """
    get the domain
    """
205
    return self.subscriber
Jean-Paul Smets's avatar
Jean-Paul Smets committed
206

207 208 209 210 211 212
  def getKeyword(self):
    """
    get the domain
    """
    return self.keyword

213
  def getPropertyId(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
214
    """
215
    get the property id
Jean-Paul Smets's avatar
Jean-Paul Smets committed
216
    """
217
    return self.keyword
Jean-Paul Smets's avatar
Jean-Paul Smets committed
218

219 220 221 222 223 224 225 226 227 228 229 230
  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
    
231

232
class Signature(Folder,SyncCode):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
233 234 235 236 237
  """
    status -- SENT, CONFLICT...
    md5_object -- An MD5 value of a given document
    #uid -- The UID of the document
    id -- the ID of the document
238
    gid -- the global id of the document
Jean-Paul Smets's avatar
Jean-Paul Smets committed
239 240 241 242
    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
  """
243
  isIndexable = 0
Jean-Paul Smets's avatar
Jean-Paul Smets committed
244 245

  # Constructor
246
  def __init__(self,gid=None, id=None, status=None, xml_string=None,object=None):
247
    self.setGid(gid)
248 249
    if object is not None:
      self.setPath(object.getPhysicalPath())
250
    self.setId(id)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
251 252 253 254 255 256
    self.status = status
    self.setXML(xml_string)
    self.partial_xml = None
    self.action = None
    self.setTempXML(None)
    self.resetConflictList()
257
    self.md5_string = None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
258
    self.force = 0
259 260
    self.setSubscriberXupdate(None)
    self.setPublisherXupdate(None)
261
    Folder.__init__(self,id)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
262 263 264 265 266 267 268 269 270 271 272 273 274 275

  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)
276
      self.setPartialXML(None)
277
      self.setSubscriberXupdate(None)
Sebastien Robin's avatar
Sebastien Robin committed
278
      self.setPublisherXupdate(None)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
279 280
      if len(self.getConflictList())>0:
        self.resetConflictList()
Sebastien Robin's avatar
Sebastien Robin committed
281 282 283
      # XXX This may be a problem, if the document is changed
      # during a synchronization
      self.setLastSynchronizationDate(DateTime())
284
      self.getParentValue().removeRemainingObjectPath(self.getPath())
285 286 287
    if status == self.NOT_SYNCHRONIZED:
      self.setTempXML(None)
      self.setPartialXML(None)
288 289 290
    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
291 292 293 294 295 296 297

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

298 299 300 301 302 303 304 305 306 307 308 309
  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
310 311 312 313 314 315 316 317 318 319 320 321
  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
322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349
  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
350 351 352 353 354 355 356
  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
357
      self.setMD5(xml)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
358 359 360 361 362

  def getXML(self):
    """
      set the XML corresponding to the object
    """
363 364 365 366
    xml =  getattr(self,'xml',None)
    if xml == '':
      xml = None
    return xml
Jean-Paul Smets's avatar
Jean-Paul Smets committed
367 368 369 370 371 372 373 374 375 376 377 378 379 380 381

  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

382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405
  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
406 407 408 409 410 411 412 413 414 415
  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
    """
416
    return self.md5_string
Jean-Paul Smets's avatar
Jean-Paul Smets committed
417 418 419 420 421 422 423 424

  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
    """
425
    return ((md5.new(xml_string).digest()) == self.getMD5())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450

  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

451 452 453 454 455 456 457 458 459 460 461 462
  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
463 464 465 466 467
  def setPartialXML(self, xml):
    """
    Set the partial string we will have to
    deliver in the future
    """
468 469
    if type(xml) is type(u'a'):
      xml = xml.encode('utf-8')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
470 471 472 473 474 475 476
    self.partial_xml = xml

  def getPartialXML(self):
    """
    Set the partial string we will have to
    deliver in the future
    """
477
    #LOG('Subscriber.getPartialXML',0,'partial_xml: %s' % str(self.partial_xml))
478 479
    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
480 481 482 483 484 485 486 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
    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
    """
514
    LOG('setConflictList, list',0,conflict_list)
Sebastien Robin's avatar
Sebastien Robin committed
515
    if conflict_list is None or conflict_list==[]:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
516 517
      self.resetConflictList()
    else:
Sebastien Robin's avatar
Sebastien Robin committed
518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533
      self.conflict_list = conflict_list

  def delConflict(self, conflict):
    """
    Return the actual action for a partial synchronization
    """
    LOG('delConflict, conflict',0,conflict)
    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
534

535 536 537 538
  def getObject(self):
    """
    Returns the object corresponding to this signature
    """
539
    return self.getParentValue().getObjectFromGid(self.getGid())
540

541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560
  def checkSynchronizationNeeded(self, object):
    """
    We will look at date, if there is no changes, no need to syncrhonize
    """
    last_modification = DateTime(object.ModificationDate())
    LOG('checkSynchronizationNeeded object.ModificationDate()',0,object.ModificationDate())
    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:
          LOG('checkSynchronizationNeeded, no modification on: ',0,object.id)
          self.setStatus(self.SYNCHRONIZED)
    

561

562 563
def addSubscription( self, id, title='', REQUEST=None ):
    """
564
    Add a new Subscribption
565 566 567 568 569 570 571 572
    """
    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):
573 574
#class Subscription(Folder, SyncCode, Implicit, Folder, Impli):
class Subscription(Folder, SyncCode):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591
  """
    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

592 593
    gpg_key -- the name of a gpg key to use

Jean-Paul Smets's avatar
Jean-Paul Smets committed
594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609
    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

  """

610 611 612 613 614 615
  meta_type='ERP5 Subscription'
  portal_type='Subscription' # may be useful in the future...
  isPortalContent = 1
  isRADContent = 1
  icon = None

616
  isIndexable = 0
617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633

  # 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
634 635

  # Constructor
636
  def __init__(self, id, title, publication_url, subscription_url, destination_path, query, xml_mapping, conduit, gpg_key):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
637 638 639 640 641 642 643 644 645
    """
      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)
646
    self.setQuery(query)
647
    self.setXMLMapping(xml_mapping)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
648 649
    self.anchor = None
    self.session_id = 0
650
    #self.signatures = PersistentMapping()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
651 652 653
    self.last_anchor = '00000000T000000Z'
    self.next_anchor = '00000000T000000Z'
    self.domain_type = self.SUB
654
    self.gpg_key = gpg_key
655 656
    self.setGidGenerator(None)
    self.setIdGenerator(None)
657
    self.setConduit(conduit)
658 659
    Folder.__init__(self, id)
    self.title = title
660

Jean-Paul Smets's avatar
Jean-Paul Smets committed
661 662
    #self.signatures = PersitentMapping()

663 664 665 666 667 668 669 670 671 672 673 674
  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
675 676 677 678 679 680 681 682 683 684 685 686
  # 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):
    """
    """
687 688 689
    # XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
    # XXX for debugging only, to be removed
    dict_sign = {}
690 691
    for o in self.objectValues():
      dict_sign[o.getId()] = o.getStatus()
692 693
    LOG('getSignature',0,'signatures_status: %s' % str(dict_sign))
    # XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
Jean-Paul Smets's avatar
Jean-Paul Smets committed
694
    code = self.SLOW_SYNC
695
    if len(self.objectValues()) > 0:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
696 697 698 699 700 701
      code = self.TWO_WAY
    if default is not None:
      code = default
    LOG('Subscription',0,'getSynchronizationType: %s' % code)
    return code

702 703 704 705 706 707 708 709
  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

710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735
  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

    return 1 if the session id was not seen, 0 if already seen
    """
    last_session_id = getattr(self,'last_session_id',None)
    if last_session_id == session_id:
      return 0
    self.last_session_id = session_id
    return 1


  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
736 737 738 739 740 741 742 743 744 745 746 747 748
  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

749 750 751 752 753 754
  def getDomainType(self):
    """
      return the ID
    """
    return self.domain_type

Jean-Paul Smets's avatar
Jean-Paul Smets committed
755 756 757 758 759 760
  def setId(self, id):
    """
      set the ID
    """
    self.id = id

761 762 763 764 765 766 767 768 769 770 771 772 773
  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
774 775 776 777 778 779
  def getQuery(self):
    """
      return the query
    """
    return self.query

780 781 782 783 784 785
  def getGPGKey(self):
    """
      return the gnupg key name
    """
    return getattr(self,'gpg_key','')

786 787 788 789 790 791
  def setGPGKey(self, value):
    """
      setter for the gnupg key name
    """
    self.gpg_key = value

Jean-Paul Smets's avatar
Jean-Paul Smets committed
792 793 794 795
  def setQuery(self, query):
    """
      set the query
    """
796 797
    if query == '':
      query = None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817
    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

818
  def getXMLMapping(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
819 820 821
    """
      return the xml mapping
    """
822 823
    xml_mapping = getattr(self,'xml_mapping','asXML')
    return xml_mapping
Jean-Paul Smets's avatar
Jean-Paul Smets committed
824

825
  def getXMLFromObject(self,object):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
826 827 828
    """
      return the xml mapping
    """
829 830 831 832 833 834 835
    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
836

837
  def setGidGenerator(self, method):
838 839 840 841
    """
    This set the method name wich allows to find a gid
    from any object
    """
842
    if method in (None,'','None'):
843 844
      method = 'getId'
    self.gid_generator = method
845 846 847 848 849 850 851 852

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

853 854 855 856 857
  def getGidFromObject(self, object):
    """
    """
    o_base = aq_base(object)
    o_gid = None
858
    LOG('getGidFromObject',0,'gidgenerator : _%s_' % repr(self.getGidGenerator()))
859 860
    gid_gen = self.getGidGenerator()
    if callable(gid_gen):
861
      LOG('getGidFromObject gid_generator',0,'is callable')
862
      o_gid=gid_gen(object)
863
      LOG('getGidFromObject',0,'o_gid: %s' % repr(o_gid))
864
    elif hasattr(o_base, gid_gen):
865 866
      LOG('getGidFromObject',0,'there is the gid generator on o_base')
      generator = getattr(object, gid_gen)
867 868
      o_gid = generator()
      LOG('getGidFromObject',0,'o_gid: %s' % repr(o_gid))
869 870 871 872 873 874
    elif gid_gen is not None:
      # It might be a script python
      LOG('getGidFromObject',0,'there is the gid generator')
      generator = getattr(object,gid_gen)
      o_gid = generator(object=object)
      LOG('getGidFromObject',0,'o_gid: %s' % repr(o_gid))
875 876
    return o_gid

877 878 879 880 881 882 883 884 885 886
  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()
887
    LOG('getObjectFromGid',0,'gid: %s' % repr(gid))
888 889
    LOG('getObjectFromGid oject_list',0,object_list)
    if signature is not None and signature.getId() is not None:
890
      o_id = signature.getId()
891
      LOG('getObjectFromGid o_id',0,o_id)
892 893 894
      o = None
      try:
        o = destination._getOb(o_id)
895
      except (AttributeError, KeyError, TypeError):
896 897 898 899 900
        pass
      if o is not None and o in object_list:
        return o
    for o in object_list:
      LOG('getObjectFromGid',0,'working on : %s' % repr(o))
901 902 903
      o_gid = self.getGidFromObject(o)
      if o_gid == gid:
        return o
904 905 906
    LOG('getObjectFromGid',0,'returning None')
    return None

907 908 909 910 911 912 913 914 915
#  def setOneWaySyncFromServer(self,value):
#    """
#    If this option is enabled, then we will not 
#    send our own modifications
#    """
#    self.one_way_sync_from_server = value
#


916 917 918 919 920 921 922 923
  def getObjectList(self):
    """
    This returns the list of sub-object corresponding
    to the query
    """
    destination = self.getDestination()
    query = self.getQuery()
    query_list = []
924 925
    if query is None:
      return query_list
926 927 928 929 930 931
    if type(query) is type('a'):
      query_method = getattr(destination,query,None)
      if query_method is not None:
        query_list = query_method()
    if callable(query):
      query_list = query(destination)
932 933
    return [x for x in query_list
              if not getattr(x,'_conflict_resolution',False)]
934

935
  def generateNewIdWithGenerator(self, object=None,gid=None):
936 937 938
    """
    This tries to generate a new Id
    """
939 940 941
    LOG('generateNewId, object: ',0,object.getPhysicalPath())
    id_generator = self.getIdGenerator()
    LOG('generateNewId, id_generator: ',0,id_generator)
942
    LOG('generateNewId, portal_object: ',0,object.getPortalObject())
943
    if id_generator is not None:
944
      o_base = aq_base(object)
945 946
      new_id = None
      if callable(id_generator):
947
        new_id = id_generator(object,gid=gid)
948 949
      elif hasattr(o_base, id_generator):
        generator = getattr(object, id_generator)
950
        new_id = generator()
951 952 953 954
      else: 
        # This is probably a python scrip
        generator = getattr(object, id_generator)
        new_id = generator(object=object,gid=gid)
955 956
      LOG('generateNewId, new_id: ',0,new_id)
      return new_id
957 958
    return None

959
  def setIdGenerator(self, method):
960 961 962 963
    """
    This set the method name wich allows to generate
    a new id
    """
964 965
    if method in ('','None'):
      method = None
966
    self.id_generator = method
967 968 969 970 971 972 973

  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
974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991
  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

992 993 994 995 996 997
  def getDestination(self):
    """
      return the destination object itself
    """
    return self.unrestrictedTraverse(self.getDestinationPath())

Jean-Paul Smets's avatar
Jean-Paul Smets committed
998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060
  def setDestinationPath(self, destination_path):
    """
      set the destination path
    """
    self.destination_path = destination_path

  def getSubscription(self):
    """
      return the current subscription
    """
    return self

  def getSessionId(self):
    """
      return the session id
    """
    self.session_id += 1
    return self.session_id

  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
    """
1061 1062
    if signature.getGid() in self.objectIds():
      self._delObject(signature.getGid())
1063
    self._setObject( signature.getGid(), signature )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1064

1065
  def delSignature(self, gid):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1066 1067 1068
    """
      add a Signature to the subscription
    """
1069 1070
    #del self.signatures[gid]
    self._delObject(gid)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1071

1072
  def getSignature(self, gid):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1073 1074 1075
    """
      add a Signature to the subscription
    """
1076 1077 1078
    o = None
    if gid in self.objectIds():
      o = self._getOb(gid)
1079 1080
    #if o is not None:
    #  return o.__of__(self)
1081
    return o
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1082 1083 1084 1085 1086

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

1089
  def hasSignature(self, gid):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1090 1091 1092
    """
      Check if there's a signature with this uid
    """
1093 1094
    #return self.signatures.has_key(gid)
    return gid in self.objectIds()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1095 1096 1097 1098 1099

  def resetAllSignatures(self):
    """
      Reset all signatures
    """
1100 1101 1102
    while len(self.objectIds())>0:
      for id in self.objectIds():
        self._delObject(id)
1103

1104
  def getGidList(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1105 1106 1107
    """
    Returns the list of ids from signature
    """
1108
    return self.objectIds()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1109 1110 1111 1112 1113 1114 1115 1116 1117 1118

  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

1119
  def getRemainingObjectPathList(self):
1120 1121 1122 1123
    """
    We should now wich objects should still
    synchronize
    """
1124
    return getattr(self,'remaining_object_path_list',None)
1125

1126
  def setRemainingObjectPathList(self, value):
1127 1128 1129 1130
    """
    We should now wich objects should still
    synchronize
    """
1131
    setattr(self,'remaining_object_path_list',value)
1132

1133
  def removeRemainingObjectPath(self, object_path):
1134 1135 1136 1137
    """
    We should now wich objects should still
    synchronize
    """
1138
    remaining_object_list = self.getRemainingObjectPathList()
1139 1140 1141
    if remaining_object_list is not None:
      new_list = []
      for o in remaining_object_list:
1142
        if o != object_path:
1143
          new_list.append(o)
1144
      self.setRemainingObjectPathList(new_list)
1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159

#  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
1160 1161 1162 1163
  def startSynchronization(self):
    """
    Set the status of every object as NOT_SYNCHRONIZED
    """
1164
    for o in self.objectValues():
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1165
      # Change the status only if we are not in a conflict mode
1166
      if not(o.getStatus() in (self.CONFLICT,self.PUB_CONFLICT_MERGE,
1167
                                                        self.PUB_CONFLICT_CLIENT_WIN)):
1168 1169 1170
        o.setStatus(self.NOT_SYNCHRONIZED)
        o.setPartialXML(None)
        o.setTempXML(None)
1171
    self.setRemainingObjectPathList(None)
1172