Subscription.py 39.6 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
40
from zLOG import LOG, DEBUG, INFO
Jean-Paul Smets's avatar
Jean-Paul Smets committed
41 42 43

import md5

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

50 51
#class Conflict(SyncCode, Implicit):
class Conflict(SyncCode, Base):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
52 53 54
  """
    object_path : the path of the obect
    keyword : an identifier of the conflict
55 56
    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
57 58

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

62 63
  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
64 65
    self.object_path=object_path
    self.keyword = keyword
66 67 68
    self.setLocalValue(publisher_value)
    self.setRemoteValue(subscriber_value)
    self.subscriber = subscriber
69
    self.resetXupdate()
70
    self.copy_path = None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
71 72 73

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

78
  def getPublisherValue(self):
79 80 81
    """
    get the domain
    """
82
    return self.publisher_value
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 114
  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

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

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

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

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

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

155 156 157 158 159
  def getPublisherDocument(self):
    """
      after a conflict resolution, we have decided
      to keep the local version of this object
    """
160
    p_sync = getToolByName(self, 'portal_synchronizations')
161 162 163 164 165 166 167
    return p_sync.getPublisherDocument(self)

  def getPublisherDocumentPath(self):
    """
      after a conflict resolution, we have decided
      to keep the local version of this object
    """
168
    p_sync = getToolByName(self, 'portal_synchronizations')
169 170 171 172 173 174 175
    return p_sync.getPublisherDocumentPath(self)

  def getSubscriberDocument(self):
    """
      after a conflict resolution, we have decided
      to keep the local version of this object
    """
176
    p_sync = getToolByName(self, 'portal_synchronizations')
177 178 179 180 181 182 183
    return p_sync.getSubscriberDocument(self)

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

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

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

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

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

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

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

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

233 234 235 236
  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
  isPortalContent = 0 # Make sure RAD generated accessors at the class level
251

Jean-Paul Smets's avatar
Jean-Paul Smets committed
252
  # Constructor
253 254 255 256 257 258
  def __init__(self,
               id=None,
               rid=None,
               status=None,
               xml_string=None,
               object=None):
259 260
    if object is not None:
      self.setPath(object.getPhysicalPath())
261
      self.setObjectId(object.getId())
Nicolas Delaby's avatar
Nicolas Delaby committed
262 263
    else:
      self.setPath(None)
264
    self.setId(id)
265
    self.setRid(rid)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
266 267 268 269 270 271
    self.status = status
    self.setXML(xml_string)
    self.partial_xml = None
    self.action = None
    self.setTempXML(None)
    self.resetConflictList()
272
    self.md5_string = None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
273
    self.force = 0
274 275
    self.setSubscriberXupdate(None)
    self.setPublisherXupdate(None)
276
    Folder.__init__(self,id)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
277 278 279 280 281 282 283 284 285 286 287 288

  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
289
        self.setXML(temp_xml)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
290
      self.setTempXML(None)
291
      self.setPartialXML(None)
292
      self.setSubscriberXupdate(None)
Sebastien Robin's avatar
Sebastien Robin committed
293
      self.setPublisherXupdate(None)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
294 295
      if len(self.getConflictList())>0:
        self.resetConflictList()
Sebastien Robin's avatar
Sebastien Robin committed
296 297 298
      # XXX This may be a problem, if the document is changed
      # during a synchronization
      self.setLastSynchronizationDate(DateTime())
299
      self.getParentValue().removeRemainingObjectPath(self.getPath())
300 301 302
    if status == self.NOT_SYNCHRONIZED:
      self.setTempXML(None)
      self.setPartialXML(None)
303
    elif status in (self.PUB_CONFLICT_MERGE, self.SENT):
304 305
      # 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
306 307 308 309 310 311 312

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

313 314 315 316
  def getPath(self):
    """
      get the force value (if we need to force update or not)
    """
317
    return getattr(self, 'path', None)
318 319 320 321 322 323 324

  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
325 326 327 328 329 330 331 332 333 334 335 336
  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
337 338 339 340 341
  def getLastModificationDate(self):
    """
      get the last modfication date, so that we don't always
      check the xml
    """
342
    return getattr(self, 'modification_date', None)
Sebastien Robin's avatar
Sebastien Robin committed
343 344 345 346 347 348

  def setLastModificationDate(self,value):
    """
      set the last modfication date, so that we don't always
      check the xml
    """
349
    setattr(self, 'modification_date', value)
Sebastien Robin's avatar
Sebastien Robin committed
350 351 352 353 354 355

  def getLastSynchronizationDate(self):
    """
      get the last modfication date, so that we don't always
      check the xml
    """
356
    return getattr(self, 'synchronization_date', None)
Sebastien Robin's avatar
Sebastien Robin committed
357 358 359 360 361 362

  def setLastSynchronizationDate(self,value):
    """
      set the last modfication date, so that we don't always
      check the xml
    """
363
    setattr(self, 'synchronization_date', value)
Sebastien Robin's avatar
Sebastien Robin committed
364

Jean-Paul Smets's avatar
Jean-Paul Smets committed
365 366 367 368 369 370 371
  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
372
      self.setMD5(xml)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
373 374 375

  def getXML(self):
    """
376
      get the XML corresponding to the object
Jean-Paul Smets's avatar
Jean-Paul Smets committed
377
    """
378
    xml =  getattr(self, 'xml', None)
379 380 381
    if xml == '':
      xml = None
    return xml
Jean-Paul Smets's avatar
Jean-Paul Smets committed
382 383 384 385 386 387 388 389 390 391 392 393 394 395 396

  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

397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420
  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
421 422 423 424 425 426 427 428 429 430
  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
    """
431
    return self.md5_string
Jean-Paul Smets's avatar
Jean-Paul Smets committed
432 433 434 435 436 437 438 439

  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
    """
440
    return ((md5.new(xml_string).digest()) == self.getMD5())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
441 442 443 444 445

  def setRid(self, rid):
    """
      set the rid
    """
446
    if rid is type(u'a'):
447
      rid = rid.encode('utf-8')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
448 449 450 451 452 453
    self.rid = rid

  def getRid(self):
    """
      get the rid
    """
454
    return getattr(self, 'rid', None)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
455 456 457 458 459

  def setId(self, id):
    """
      set the id
    """
460
    if id is type(u'a'):
461
      id = id.encode('utf-8')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
462 463 464 465 466 467 468 469
    self.id = id

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

470 471
  def getGid(self):
    """
472
      get the gid
473
    """
474
    return self.getId()
475

476 477 478 479
  def setObjectId(self, id):
    """
      set the id of the object associated to this signature
    """
480
    if id is type(u'a'):
481 482 483 484 485 486 487 488 489
      id = id.encode('utf-8')
    self.object_id = id

  def getObjectId(self):
    """
      get the id of the object associated to this signature
    """
    return getattr(self, 'object_id', None)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
490 491 492 493 494
  def setPartialXML(self, xml):
    """
    Set the partial string we will have to
    deliver in the future
    """
495 496
    if type(xml) is type(u'a'):
      xml = xml.encode('utf-8')
497
    if xml is not None:
Nicolas Delaby's avatar
Nicolas Delaby committed
498
      xml = xml.replace('@-@@-@','--') # need to put back '--'
Jean-Paul Smets's avatar
Jean-Paul Smets committed
499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523
    self.partial_xml = xml

  def getPartialXML(self):
    """
    Set the partial string we will have to
    deliver in the future
    """
    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
    """
524
    returned_conflict_list = []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
525
    if len(self.conflict_list)>0:
526 527
      returned_conflict_list.extend(self.conflict_list)
    return returned_conflict_list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
528 529 530 531 532 533 534 535 536 537 538

  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
    """
539
    if conflict_list is None or conflict_list == []:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
540 541
      self.resetConflictList()
    else:
Sebastien Robin's avatar
Sebastien Robin committed
542 543 544 545 546 547 548 549
      self.conflict_list = conflict_list

  def delConflict(self, conflict):
    """
    Return the actual action for a partial synchronization
    """
    conflict_list = []
    for c in self.getConflictList():
Nicolas Delaby's avatar
Nicolas Delaby committed
550
      #LOG('delConflict, c==conflict',0,c==aq_base(conflict))
Sebastien Robin's avatar
Sebastien Robin committed
551 552 553 554 555 556
      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
557

558 559 560 561
  def getObject(self):
    """
    Returns the object corresponding to this signature
    """
Nicolas Delaby's avatar
Nicolas Delaby committed
562
    return self.getParentValue().getObjectFromGid(self.getObjectId())
563

564 565
def addSubscription( self, id, title='', REQUEST=None ):
    """
566
    Add a new Subscribption
567 568 569 570 571 572 573 574
    """
    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):
575
#class Subscription(Folder, SyncCode, Implicit, Folder, Impli):
576 577
from XMLSyncUtils import XMLSyncUtils

578
class Subscription(Folder, XMLSyncUtils):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595
  """
    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

596 597
    gpg_key -- the name of a gpg key to use

Jean-Paul Smets's avatar
Jean-Paul Smets committed
598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613
    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

  """

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

  # 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
638 639

  # Constructor
640 641
  def __init__(self, id, title, publication_url, subscription_url,
      destination_path, source_uri, target_uri, query, xml_mapping,
642
      conduit, gpg_key, id_generator, media_type, login,
643
      password, activity_enabled, alert_code, synchronize_with_erp5_sites,
644
      sync_content_type):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
645 646 647 648 649 650
    """
      We need to create a dictionnary of
      signatures of documents which belong to the synchronisation
      process
    """
    self.id = id
651
    self.setAlertCode(alert_code)
652
    self.setActivityEnabled(activity_enabled)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
653 654 655
    self.publication_url = (publication_url)
    self.subscription_url = str(subscription_url)
    self.destination_path = str(destination_path)
656 657
    self.setSourceURI(source_uri)
    self.setTargetURI(target_uri)
658
    self.setQuery(query)
659
    self.setXMLMapping(xml_mapping)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
660 661
    self.anchor = None
    self.session_id = 0
662
    #self.signatures = PersistentMapping()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
663 664
    self.last_anchor = '00000000T000000Z'
    self.next_anchor = '00000000T000000Z'
665
    self.setMediaType(media_type)
666
    self.login = login
667
    self.password=password
Jean-Paul Smets's avatar
Jean-Paul Smets committed
668
    self.domain_type = self.SUB
669
    self.gpg_key = gpg_key
670
    self.setSynchronizationIdGenerator(id_generator)
671
    self.setConduit(conduit)
672 673
    Folder.__init__(self, id)
    self.title = title
674 675
    self.setSyncContentType(sync_content_type)
    self.setSynchronizeWithERP5Sites(synchronize_with_erp5_sites)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
676 677
    #self.signatures = PersitentMapping()

678
  def getAlertCodeList(self):
679
    return self.CODE_LIST
680 681 682 683 684 685 686 687 688 689

  def getAlertCode(self):
    return getattr(self, 'alert_code', 200)

  def setAlertCode(self, value):
    self.alert_code = int(value)

  def isOneWayFromServer(self):
    return self.getDomainType() == self.SUB and self.getAlertCode() == self.ONE_WAY_FROM_SERVER

690 691 692 693 694 695 696 697 698 699 700 701
  def getActivityEnabled(self):
    """
    return true if we are using activity, false otherwise
    """
    return getattr(self, 'activity_enabled', None)

  def setActivityEnabled(self, activity_enabled):
    """
    set if we are using activity or not
    """
    self.activity_enabled = activity_enabled

702 703 704 705 706 707 708 709 710 711 712
  def getTitle(self):
    """
    getter for title
    """
    return getattr(self,'title',None)

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

714 715 716 717 718 719 720 721
  def setSourceURI(self, value):
    """
    setter for source_uri
    """
    self.source_uri = value

  def getSourceURI(self):
    """
722
    getter for the source_uri (the local path of the subscription data base)
723 724 725 726 727 728 729 730
    """
    return getattr(self, 'source_uri', None)

  def setTargetURI(self, value):
    """
    setter for target_uri
    """
    self.target_uri = value
731

732
  def getTargetURI(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
733
    """
734 735
    getter for the target_uri (the distant Publication data base we want to 
    synchronize with)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
736
    """
737
    return getattr(self, 'target_uri', None)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
738

739 740 741 742
  def setSyncContentType(self, sync_content_type):
    """
    content type used by the subscriber
    """
743
    self.sync_content_type = sync_content_type
744 745 746 747 748 749 750 751 752 753
    # the varible name is sync_content_type instead of content_type because
    # content_type seems to be a function name already used


  def getSyncContentType(self):
    """
    getter of the subscriber sync_content_type
    """
    return getattr(self, 'sync_content_type', 'application/vnd.syncml+xml')

Jean-Paul Smets's avatar
Jean-Paul Smets committed
754 755 756
  def getSynchronizationType(self, default=None):
    """
    """
757 758
    # XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
    # XXX for debugging only, to be removed
Nicolas Delaby's avatar
Nicolas Delaby committed
759
    #dict_sign = {}
760
    #for o in self.getSignatureList():
Nicolas Delaby's avatar
Nicolas Delaby committed
761
      #dict_sign[o.getId()] = o.getStatus()
762
    # LOG('getSignature', DEBUG, 'signatures_status: %s' % str(dict_sign))
763
    # XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
Jean-Paul Smets's avatar
Jean-Paul Smets committed
764
    code = self.SLOW_SYNC
765
    if len(self.getSignatureList()[:1]) > 0:
766
      code = self.getAlertCode()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
767 768
    if default is not None:
      code = default
769
    #LOG('Subscription', DEBUG, 'getSynchronizationType: %s' % code)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
770 771
    return code

772 773
  def setXMLMapping(self, value):
    """
774
    this the name of the method used in order to set the xml
775 776 777 778 779
    """
    if value == '':
      value = None
    self.xml_mapping = value

780 781 782 783 784 785 786 787 788 789 790 791 792
  def setSynchronizeWithERP5Sites(self, synchronize_with_erp5_sites):
    """
    if the synchronisation is made with another ERP5 site, 
    synchronize_with_erp5_sites is True, False in other case
    XXX in the future, the method used to sendHttpResponse will be the same
    in all cases, so this method will be useless
    """
    self.synchronize_with_erp5_sites = synchronize_with_erp5_sites

  def getSynchronizeWithERP5Sites(self):
    """
    return True if the synchronisation is between two erp5 sites
    """
793
    return getattr(self, 'synchronize_with_erp5_sites', True)
794

795 796 797 798 799
  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

800
    return True if the session id was not seen, False if already seen
801
    """
802
    last_session_id = getattr(self, 'last_session_id', None)
803
    if last_session_id == session_id:
804
      return False 
805
    self.last_session_id = session_id
806
    return True
807

Sebastien Robin's avatar
Sebastien Robin committed
808 809 810 811 812
  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

813
    return True if the message id was not seen, False if already seen
Sebastien Robin's avatar
Sebastien Robin committed
814 815
    """
    last_message_id = getattr(self,'last_message_id',None)
816 817
    #LOG('checkCorrectRemoteMessageId  last_message_id = ', DEBUG, last_message_id)
    #LOG('checkCorrectRemoteMessageId  message_id = ', DEBUG, message_id)
Sebastien Robin's avatar
Sebastien Robin committed
818
    if last_message_id == message_id:
819
      return False
Sebastien Robin's avatar
Sebastien Robin committed
820
    self.last_message_id = message_id
821
    return True
Sebastien Robin's avatar
Sebastien Robin committed
822

823
  def initLastMessageId(self, last_message_id=0):
Sebastien Robin's avatar
Sebastien Robin committed
824 825 826
    """
    set the last message id to 0
    """
827
    self.last_message_id = last_message_id
828 829 830 831 832

  def getLastSentMessage(self):
    """
    This is the getter for the last message we have sent
    """
833
    return getattr(self, 'last_sent_message', '')
834 835 836 837 838 839 840

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

841
  def getDomainType(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
842
    """
843
      return the ID
Jean-Paul Smets's avatar
Jean-Paul Smets committed
844
    """
845
    return self.domain_type
Jean-Paul Smets's avatar
Jean-Paul Smets committed
846 847 848 849 850 851 852 853 854 855 856 857 858

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

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

859 860 861 862 863 864 865 866 867 868
  def setConduit(self, value):
    """
      set the Conduit
    """
    self.conduit = value

  def getConduit(self):
    """
      get the Conduit
    """
869
    return getattr(self, 'conduit', None)
870

Jean-Paul Smets's avatar
Jean-Paul Smets committed
871 872 873 874 875 876
  def getQuery(self):
    """
      return the query
    """
    return self.query

877 878 879 880
  def getGPGKey(self):
    """
      return the gnupg key name
    """
881
    return getattr(self, 'gpg_key', '')
882

883 884 885 886 887 888
  def setGPGKey(self, value):
    """
      setter for the gnupg key name
    """
    self.gpg_key = value

Jean-Paul Smets's avatar
Jean-Paul Smets committed
889 890 891 892
  def setQuery(self, query):
    """
      set the query
    """
893 894
    if query == '':
      query = None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910
    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):
    """
911
      set the publication url
Jean-Paul Smets's avatar
Jean-Paul Smets committed
912 913 914
    """
    self.publication_url = publication_url

915
  def getXMLMapping(self, force=0):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
916 917 918
    """
      return the xml mapping
    """
919 920 921
    if self.isOneWayFromServer() and force == 0:
      return None
    xml_mapping = getattr(self, 'xml_mapping', None)
922
    return xml_mapping
Jean-Paul Smets's avatar
Jean-Paul Smets committed
923

924
  def getXMLFromObject(self, object, force=0):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
925 926 927
    """
      return the xml mapping
    """
928
    xml_mapping = self.getXMLMapping(force=force)
929 930
    xml = ''
    if xml_mapping is not None:
931
      func = getattr(object, xml_mapping, None)
932 933 934
      if func is not None:
        xml = func()
    return xml
Jean-Paul Smets's avatar
Jean-Paul Smets committed
935

936
  def getMediaType(self):
937
    """
938 939
    This method return the type of media used in this session,
    for example, it could be "text/vcard" or "xml/text",...
940
    """
941
    return getattr(self, 'media_type', self.MEDIA_TYPE['TEXT_XML'])
942

943
  def setMediaType(self, media_type):
944
    """
945
    set the type of media used
946
    """
947
    if media_type in (None, ''):
948 949
      media_type = self.MEDIA_TYPE['TEXT_XML']
    self.media_type = media_type
950

951 952 953 954 955 956 957 958 959 960
  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
    """
961
    self.login = new_login
962 963 964 965 966 967 968 969 970 971 972

  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
    """
973
    self.password = new_password
974

Fabien Morin's avatar
Fabien Morin committed
975 976 977 978 979 980 981 982 983 984 985 986
  def getZopeUser(self):
    """
    This method return the zope user who begin the synchronization session
    """
    return getattr(self, 'zope_user_name', None)

  def setZopeUser(self, user_name):
    """
    This method set the zope user_name
    """
    self.zope_user_name = user_name

987 988 989 990
  def getAuthenticationFormat(self):
    """
      return the format of authentication
    """
991
    return getattr(self, 'authentication_format', 'b64')
992 993 994 995 996

  def getAuthenticationType(self):
    """
      return the type of authentication
    """
997
    return getattr(self, 'authentication_type', 'syncml:auth-basic')
998 999 1000 1001 1002

  def setAuthenticationFormat(self, authentication_format):
    """
      set the format of authentication
    """
1003 1004 1005
    if authentication_format in (None, ''):
      self.authentication_format = 'b64'
    else:
1006
      self.authentication_format = authentication_format
1007 1008 1009 1010 1011

  def setAuthenticationType(self, authentication_type):
    """
      set the type of authentication
    """
1012 1013 1014 1015
    if authentication_type in (None, ''):
      self.authentication_type = 'syncml:auth-basic'
    else:
      self.authentication_type = authentication_type
1016

1017 1018 1019 1020 1021
  def getGidFromObject(self, object):
    """
    """
    o_base = aq_base(object)
    o_gid = None
1022 1023 1024
    conduit_name = self.getConduit()
    conduit = self.getConduitByName(conduit_name)
    gid_gen = getattr(conduit, 'getGidFromObject', None)
1025
    if callable(gid_gen):
1026
      o_gid = gid_gen(object)
1027
    else:
1028
      raise ValueError, "The conduit "+conduit_name+"seems to not have a \
1029
          getGidFromObject method and it must"
1030
    o_gid = b16encode(o_gid)
1031
    #LOG('getGidFromObject returning', DEBUG, o_gid)
1032 1033
    return o_gid

1034 1035 1036 1037 1038
  def getObjectFromGid(self, gid):
    """
    This tries to get the object with the given gid
    This uses the query if it exist
    """
1039
    if len(gid)%2 != 0:
Fabien Morin's avatar
Fabien Morin committed
1040
    #something encode in base 16 is always a even number of number
1041 1042
    #if not, b16decode will failed
      return None
1043
    signature = self.getSignatureFromGid(gid)
1044 1045 1046
    # First look if we do already have the mapping between
    # the id and the gid
    destination = self.getDestination()
1047
    if signature is not None and signature.getPath() is not None:
1048 1049
      o = None
      try:
1050
        o = destination.getPortalObject().restrictedTraverse(signature.getPath())
1051
      except (AttributeError, KeyError, TypeError):
1052
        pass
Nicolas Delaby's avatar
Nicolas Delaby committed
1053 1054
      o_id = signature.getObjectId()
      #try with id param too, because gid is not catalogged
1055
      object_list = self.getObjectList(gid = b16decode(gid), id = o_id)
1056
      #LOG('getObjectFromGid :', DEBUG, 'object_list=%s, gid=%s, o_id=%s' % (object_list, gid, o_id))
1057 1058
      if o is not None and o in object_list:
        return o
1059
    #LOG('entering in the slow loop of getObjectFromGid !!!',0,'')
1060
    object_list = self.getObjectList(gid = b16decode(gid))
1061
    #LOG('getObjectFromGid :', DEBUG, 'object_list slow loop=%s, gid=%s' % (object_list, gid))
1062
    for o in object_list:
1063 1064 1065
      o_gid = self.getGidFromObject(o)
      if o_gid == gid:
        return o
1066
    #LOG('getObjectFromGid', DEBUG, 'returning None')
1067 1068 1069 1070 1071 1072
    return None

  def getObjectFromId(self, id):
    """
    return the object corresponding to the id
    """
1073
    object_list = self.getObjectList(id=id)
1074
    o = None
1075 1076
    for object in object_list:
      if object.getId() == id:
1077 1078 1079
        o = object
        break
    return o
1080

1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092
  def getObjectFromRid(self, rid):
    """
    return the object corresponding to the id
    """
    signature = self.getSignatureFromRid(rid)
    destination = self.getDestination()
    o = None
    if signature is not None and signature.getPath() is not None:
      try:
        o = destination.getPortalObject().restrictedTraverse(signature.getPath())
      except:
        pass
1093
    return o
1094

1095
  def getObjectList(self, **kw):
1096 1097 1098 1099 1100 1101 1102
    """
    This returns the list of sub-object corresponding
    to the query
    """
    destination = self.getDestination()
    query = self.getQuery()
    query_list = []
1103
    if query is not None and isinstance(query, str):
1104
      query_method = getattr(destination, query, None)
1105
      if query_method is not None:
1106
        query_list = query_method(**kw)
1107
      else:
1108 1109
        raise KeyError, 'This Subscriber %s provide no Query with id: %s'\
          % (self.getTitle(), query)
1110
    elif callable(query): # used in the test
1111
      query_list = query(destination)
1112
    else:
1113 1114
      raise KeyError, 'This Subscriber %s provide no Query with id: %s'\
        % (self.getTitle(), query)
1115
    return [x for x in query_list
1116
              if not getattr(x, '_conflict_resolution', False)]
1117

1118
  def generateNewIdWithGenerator(self, object=None, gid=None):
1119 1120 1121
    """
    This tries to generate a new Id
    """
1122
    id_generator = self.getSynchronizationIdGenerator()
1123
    if id_generator is not None:
1124
      o_base = aq_base(object)
1125 1126
      new_id = None
      if callable(id_generator):
1127
        new_id = id_generator(object, gid=gid)
1128
      elif getattr(o_base, id_generator, None) is not None:
1129
        generator = getattr(object, id_generator)
1130
        new_id = generator()
1131
      else: 
Nicolas Delaby's avatar
Nicolas Delaby committed
1132
        # This is probably a python script
1133
        generator = getattr(object, id_generator)
1134
        new_id = generator(object=object, gid=gid)
1135
      #LOG('generateNewId, new_id: ', DEBUG, new_id)
1136
      return new_id
1137 1138
    return None

1139
  def setSynchronizationIdGenerator(self, method):
1140 1141 1142 1143
    """
    This set the method name wich allows to generate
    a new id
    """
1144
    if method in ('', 'None'):
1145
      method = None
1146
    self.synchronization_id_generator = method
1147

1148
  def getSynchronizationIdGenerator(self):
1149 1150 1151
    """
    This get the method name wich allows to generate a new id
    """
1152
    return getattr(self, 'synchronization_id_generator', None)
1153

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171
  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

1172 1173 1174 1175 1176 1177
  def getDestination(self):
    """
      return the destination object itself
    """
    return self.unrestrictedTraverse(self.getDestinationPath())

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188
  def setDestinationPath(self, destination_path):
    """
      set the destination path
    """
    self.destination_path = destination_path

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

Sebastien Robin's avatar
Sebastien Robin committed
1190 1191 1192 1193 1194
  def setSessionId(self, session_id):
    """
      set the session id
    """
    self.session_id = session_id
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1195 1196 1197 1198 1199

  def getSessionId(self):
    """
      return the session id
    """
Sebastien Robin's avatar
Sebastien Robin committed
1200 1201 1202 1203 1204 1205 1206
    #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
1207
    self.session_id += 1
Sebastien Robin's avatar
Sebastien Robin committed
1208
    self.resetMessageId() # for a new session, the message Id must be reset
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1209 1210
    return self.session_id

Sebastien Robin's avatar
Sebastien Robin committed
1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229
  def incrementMessageId(self):
    """
      return the message id
    """
    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
1230

1231 1232 1233 1234 1235
  def setMessageId(self, message_id):
    """
      set the message id to message_id
    """
    self.message_id = message_id
Sebastien Robin's avatar
Sebastien Robin committed
1236

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280
  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
    """
1281
    if self.getSignatureFromGid(signature.getGid()) is not None:
1282 1283
      self.delSignature(signature.getGid())
    self._setObject(signature.getGid(), aq_base(signature))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1284

1285
  def delSignature(self, gid):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1286
    """
1287
      del a Signature of the subscription
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1288
    """
1289
    self._delObject(gid)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1290

1291
  def getSignatureFromObjectId(self, id):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1292
    """
1293
    return the signature corresponding to the id
1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306
    """
    o = None
    # XXX very slow
    for signature in self.getSignatureList():
      if id == signature.getObjectId():
        o = signature
        break
    return o

  def getSignatureFromGid(self, gid):
    """
    return the signature corresponding to the gid
    """
Nicolas Delaby's avatar
Nicolas Delaby committed
1307
    return getattr(self, gid, None)
1308 1309 1310 1311

  def getSignatureFromRid(self, rid):
    """
    return the signature corresponding to the rid
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1312
    """
1313
    o = None
1314 1315 1316 1317 1318
    # XXX very slow
    for signature in self.getSignatureList():
      if rid == signature.getRid():
        o = signature
        break
1319
    return o
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1320

1321 1322 1323 1324
  def getGidList(self):
    """
    Returns the list of gids from signature
    """
1325
    return [id for id in self.getObjectIds()]
1326

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1327 1328
  def getSignatureList(self):
    """
1329
      Returns the list of Signatures
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1330
    """
1331
    return self.objectValues()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1332

1333
  def hasSignature(self, gid):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1334 1335 1336
    """
      Check if there's a signature with this uid
    """
1337
    return self.getSignatureFromGid(gid) is not None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1338 1339 1340

  def resetAllSignatures(self):
    """
1341
      Reset all signatures in activities
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1342
    """
1343 1344 1345
    object_id_list = [id for id in self.getObjectIds()]
    object_list_len = len(object_id_list)
    for i in xrange(0, object_list_len, 100):
1346
      current_id_list = object_id_list[i:i+100]
1347 1348
      self.activate(activity='SQLQueue',
                          tag = self.getId()).manage_delObjects(current_id_list)
1349

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1350 1351 1352 1353 1354 1355
  def getConflictList(self):
    """
    Return the list of all conflicts from all signatures
    """
    conflict_list = []
    for signature in self.getSignatureList():
1356
      conflict_list.extend(signature.getConflictList())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1357 1358
    return conflict_list

1359
  def getRemainingObjectPathList(self):
1360 1361 1362 1363
    """
    We should now wich objects should still
    synchronize
    """
1364
    return getattr(self, 'remaining_object_path_list', None)
1365

1366
  def setRemainingObjectPathList(self, value):
1367 1368 1369 1370
    """
    We should now wich objects should still
    synchronize
    """
1371
    setattr(self, 'remaining_object_path_list', value)
1372

1373
  def removeRemainingObjectPath(self, object_path):
1374 1375 1376 1377
    """
    We should now wich objects should still
    synchronize
    """
1378
    remaining_object_list = self.getRemainingObjectPathList()
1379 1380
    if remaining_object_list is not None:
      new_list = []
Nicolas Delaby's avatar
Nicolas Delaby committed
1381 1382 1383
      new_list.extend(remaining_object_list)
      while object_path in new_list:
        new_list.remove(object_path)
1384
      self.setRemainingObjectPathList(new_list)
1385

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1386 1387 1388 1389
  def startSynchronization(self):
    """
    Set the status of every object as NOT_SYNCHRONIZED
    """
1390
    for s in self.getSignatureList():
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1391
      # Change the status only if we are not in a conflict mode
1392 1393 1394 1395 1396 1397
      if s.getStatus() not in (self.CONFLICT,
                               self.PUB_CONFLICT_MERGE,
                               self.PUB_CONFLICT_CLIENT_WIN):
        s.setStatus(self.NOT_SYNCHRONIZED)
        s.setPartialXML(None)
        s.setTempXML(None)
1398
    self.setRemainingObjectPathList(None)
1399

1400 1401 1402 1403 1404 1405

  def isAuthenticated(self):
    """
    return True if the subscriber is authenticated for this session, False 
    in other case
    """
1406 1407
    return getattr(self, 'is_authenticated', None)

1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424
  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
1425
      LOG('encode : unknown or not implemented format : ', INFO, format)
1426
      raise ValueError, "Sorry, the server ask for the format %s but it's unknow or not implemented" % format
1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438

  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
1439
      LOG('decode : unknown or not implemented format :', INFO, format)
1440 1441 1442 1443 1444 1445 1446
      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
    """
1447
    return self.encode(format, string_decoded) == string_encoded
1448 1449 1450 1451 1452

  def setUser(self, user):
    """
      save the user logged in to log him on each transaction
    """
1453
    self.user = user
1454 1455 1456 1457 1458

  def getUser(self):
    """
      retrun the user logged in
    """
1459
    return getattr(self, 'user', None)
1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479

  def getConduitByName(self, conduit_name):
    """
    Get Conduit Object by given name.
    The Conduit can be located in Any Products according to naming Convention
    Products.<Product Name>.Conduit.<Conduit Module> ,if conduit_name equal module's name.
    By default Conduit must be defined in Products.ERP5SyncML.Conduit.<Conduit Module>
    """
    from Products.ERP5SyncML import Conduit
    if conduit_name.startswith('Products'):
      path = conduit_name
      conduit_name = conduit_name.split('.')[-1]
      conduit_module = __import__(path, globals(), locals(), [''])
      conduit = getattr(conduit_module, conduit_name)()
    else:
      conduit_module = __import__('.'.join([Conduit.__name__, conduit_name]),
                                  globals(), locals(), [''])
      conduit = getattr(conduit_module, conduit_name)()
    return conduit