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

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 144
    """
      after a conflict resolution, we have decided
      to keep the local version of this object
    """
    p_sync = getToolByName(self,'portal_synchronizations')
145
    p_sync.applyPublisherValue(self)
Sebastien Robin's avatar
Sebastien Robin committed
146

147 148 149 150 151 152 153 154
  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)

155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
  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')
185
    return p_sync.getSubscriberDocumentPath(self)
186

187
  def applySubscriberDocument(self):
188 189 190 191 192 193 194
    """
      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)

195
  def applySubscriberValue(self,object=None):
Sebastien Robin's avatar
Sebastien Robin committed
196 197 198 199
    """
    get the domain
    """
    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 232 233 234 235 236 237
  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
    
238

239
class Signature(Folder,SyncCode):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
240 241 242 243 244
  """
    status -- SENT, CONFLICT...
    md5_object -- An MD5 value of a given document
    #uid -- The UID of the document
    id -- the ID of the document
245
    gid -- the global id of the document
Jean-Paul Smets's avatar
Jean-Paul Smets committed
246 247 248 249
    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
  """
250
  isIndexable = 0
251 252
  isPortalContent = 0 # Make sure RAD generated accessors at the class level
  
Jean-Paul Smets's avatar
Jean-Paul Smets committed
253
  # Constructor
254 255
  def __init__(self, id=None, rid=None, status=None, xml_string=None, 
      object=None):
256 257
    if object is not None:
      self.setPath(object.getPhysicalPath())
258
      self.setObjectId(object.getId())
Nicolas Delaby's avatar
Nicolas Delaby committed
259 260
    else:
      self.setPath(None)
261
    self.setId(id)
262 263
    self.setGid(id)
    self.setRid(rid)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
264 265 266 267 268 269
    self.status = status
    self.setXML(xml_string)
    self.partial_xml = None
    self.action = None
    self.setTempXML(None)
    self.resetConflictList()
270
    self.md5_string = None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
271
    self.force = 0
272 273
    self.setSubscriberXupdate(None)
    self.setPublisherXupdate(None)
274
    Folder.__init__(self,id)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
275 276 277 278 279 280 281 282 283 284 285 286

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

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

311 312 313 314 315 316 317 318 319 320 321 322
  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
323 324 325 326 327 328 329 330 331 332 333 334
  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
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362
  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
363 364 365 366 367 368 369
  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
370
      self.setMD5(xml)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
371 372 373

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

  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

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

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

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

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

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

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

468 469
  def setGid(self, gid):
    """
470
      set the gid
471
    """
472 473
    if gid is type(u'a'): 
      gid = gid.encode('utf-8')
474 475 476 477
    self.gid = gid

  def getGid(self):
    """
478
      get the gid
479 480 481
    """
    return self.gid

482 483 484 485 486 487 488 489 490 491 492 493 494 495
  def setObjectId(self, id):
    """
      set the id of the object associated to this signature
    """
    if id is type(u'a'): 
      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
496 497 498 499 500
  def setPartialXML(self, xml):
    """
    Set the partial string we will have to
    deliver in the future
    """
501 502
    if type(xml) is type(u'a'):
      xml = xml.encode('utf-8')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
503 504 505 506 507 508 509
    self.partial_xml = xml

  def getPartialXML(self):
    """
    Set the partial string we will have to
    deliver in the future
    """
510
    #LOG('Subscriber.getPartialXML',0,'partial_xml: %s' % str(self.partial_xml))
511 512
    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
513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546
    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
    """
547
    # LOG('setConflictList, list',0,conflict_list)
Sebastien Robin's avatar
Sebastien Robin committed
548
    if conflict_list is None or conflict_list==[]:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
549 550
      self.resetConflictList()
    else:
Sebastien Robin's avatar
Sebastien Robin committed
551 552 553 554 555 556
      self.conflict_list = conflict_list

  def delConflict(self, conflict):
    """
    Return the actual action for a partial synchronization
    """
557
    # LOG('delConflict, conflict',0,conflict)
Sebastien Robin's avatar
Sebastien Robin committed
558 559
    conflict_list = []
    for c in self.getConflictList():
Nicolas Delaby's avatar
Nicolas Delaby committed
560
      #LOG('delConflict, c==conflict',0,c==aq_base(conflict))
Sebastien Robin's avatar
Sebastien Robin committed
561 562 563 564 565 566
      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
567

568 569 570 571
  def getObject(self):
    """
    Returns the object corresponding to this signature
    """
572
    return self.getParentValue().getObjectIdGid(self.getObjectId())
573

574 575 576 577 578
  def checkSynchronizationNeeded(self, object):
    """
    We will look at date, if there is no changes, no need to syncrhonize
    """
    last_modification = DateTime(object.ModificationDate())
579
    # LOG('checkSynchronizationNeeded object.ModificationDate()',0,object.ModificationDate())
580 581 582 583 584 585 586 587 588 589
    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:
590
          # LOG('checkSynchronizationNeeded, no modification on: ',0,object.id)
591 592 593
          self.setStatus(self.SYNCHRONIZED)
    

594

595 596
def addSubscription( self, id, title='', REQUEST=None ):
    """
597
    Add a new Subscribption
598 599 600 601 602 603 604 605
    """
    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):
606 607
#class Subscription(Folder, SyncCode, Implicit, Folder, Impli):
class Subscription(Folder, SyncCode):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624
  """
    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

625 626
    gpg_key -- the name of a gpg key to use

Jean-Paul Smets's avatar
Jean-Paul Smets committed
627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642
    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

  """

643
  meta_type='ERP5 Subscription'
644
  portal_type='SyncML Subscription' # may be useful in the future...
645 646 647
  isPortalContent = 1
  isRADContent = 1
  icon = None
648
  isIndexable = 0
649
  user = None
650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666

  # 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
667 668

  # Constructor
669
  def __init__(self, id, title, publication_url, subscription_url, 
670 671 672
      destination_path, source_uri, target_uri, query, xml_mapping, 
      conduit, gpg_key, id_generator, gid_generator, media_type, login, 
      password):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
673 674 675 676 677 678 679 680 681
    """
      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)
682 683
    self.setSourceURI(source_uri)
    self.setTargetURI(target_uri)
684
    self.setQuery(query)
685
    self.setXMLMapping(xml_mapping)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
686 687
    self.anchor = None
    self.session_id = 0
688
    #self.signatures = PersistentMapping()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
689 690
    self.last_anchor = '00000000T000000Z'
    self.next_anchor = '00000000T000000Z'
691
    self.setMediaType(media_type)
692
    self.login = login
693
    self.password=password
Jean-Paul Smets's avatar
Jean-Paul Smets committed
694
    self.domain_type = self.SUB
695
    self.gpg_key = gpg_key
696 697
    self.setGidGenerator(gid_generator)
    self.setSynchronizationIdGenerator(id_generator)
698
    self.setConduit(conduit)
699 700
    Folder.__init__(self, id)
    self.title = title
Sebastien Robin's avatar
Sebastien Robin committed
701
    
Jean-Paul Smets's avatar
Jean-Paul Smets committed
702 703
    #self.signatures = PersitentMapping()

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

  def setTitle(self, value):
    """
    setter for title
    """
    self.title = value
715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732
  
  def setSourceURI(self, value):
    """
    setter for source_uri
    """
    self.source_uri = value

  def getSourceURI(self):
    """
    getter for the source_uri (the local path of the subscription)
    """
    return getattr(self, 'source_uri', None)

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

734
  def getTargetURI(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
735
    """
736 737
    getter for the target_uri (the distant Publication we want to synchronize 
    with)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
738
    """
739
    return getattr(self, 'target_uri', None)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
740 741 742 743

  def getSynchronizationType(self, default=None):
    """
    """
744 745 746
    # XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
    # XXX for debugging only, to be removed
    dict_sign = {}
747 748
    for o in self.objectValues():
      dict_sign[o.getId()] = o.getStatus()
749
    # LOG('getSignature',0,'signatures_status: %s' % str(dict_sign))
750
    # XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
Jean-Paul Smets's avatar
Jean-Paul Smets committed
751
    code = self.SLOW_SYNC
752
    if len(self.objectValues()) > 0:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
753 754 755
      code = self.TWO_WAY
    if default is not None:
      code = default
756
    # LOG('Subscription',0,'getSynchronizationType: %s' % code)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
757 758
    return code

759 760
  def setXMLMapping(self, value):
    """
761
    this the name of the method used in order to set the xml
762 763 764 765 766
    """
    if value == '':
      value = None
    self.xml_mapping = value

767 768 769 770 771
  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

772
    return True if the session id was not seen, False if already seen
773 774 775
    """
    last_session_id = getattr(self,'last_session_id',None)
    if last_session_id == session_id:
776
      return False 
777
    self.last_session_id = session_id
778
    return True
779

Sebastien Robin's avatar
Sebastien Robin committed
780 781 782 783 784
  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

785
    return True if the message id was not seen, False if already seen
Sebastien Robin's avatar
Sebastien Robin committed
786 787
    """
    last_message_id = getattr(self,'last_message_id',None)
788 789
    # LOG('checkCorrectRemoteMessageId  last_message_id =',0,last_message_id)
    # LOG('checkCorrectRemoteMessageId  message_id =',0,message_id)
Sebastien Robin's avatar
Sebastien Robin committed
790
    if last_message_id == message_id:
791
      return False
Sebastien Robin's avatar
Sebastien Robin committed
792
    self.last_message_id = message_id
793
    return True
Sebastien Robin's avatar
Sebastien Robin committed
794

795
  def initLastMessageId(self, last_message_id=0):
Sebastien Robin's avatar
Sebastien Robin committed
796 797 798 799
    """
    set the last message id to 0
    """
    self.last_message_id=last_message_id
800 801 802 803 804 805 806 807 808 809 810 811 812

  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

813
  def getDomainType(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
814
    """
815
      return the ID
Jean-Paul Smets's avatar
Jean-Paul Smets committed
816
    """
817
    return self.domain_type
Jean-Paul Smets's avatar
Jean-Paul Smets committed
818 819 820 821 822 823 824 825 826 827 828 829 830

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

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

831 832 833 834 835 836 837 838 839 840 841 842 843
  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
844 845 846 847 848 849
  def getQuery(self):
    """
      return the query
    """
    return self.query

850 851 852 853 854 855
  def getGPGKey(self):
    """
      return the gnupg key name
    """
    return getattr(self,'gpg_key','')

856 857 858 859 860 861
  def setGPGKey(self, value):
    """
      setter for the gnupg key name
    """
    self.gpg_key = value

Jean-Paul Smets's avatar
Jean-Paul Smets committed
862 863 864 865
  def setQuery(self, query):
    """
      set the query
    """
866 867
    if query == '':
      query = None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887
    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

888
  def getXMLMapping(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
889 890 891
    """
      return the xml mapping
    """
892 893
    xml_mapping = getattr(self,'xml_mapping','asXML')
    return xml_mapping
Jean-Paul Smets's avatar
Jean-Paul Smets committed
894

895
  def getXMLFromObject(self,object):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
896 897 898
    """
      return the xml mapping
    """
899 900 901 902 903 904 905
    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
906

907
  def setGidGenerator(self, method):
908 909 910 911
    """
    This set the method name wich allows to find a gid
    from any object
    """
912
    if method in (None,'','None'):
913 914
      method = 'getId'
    self.gid_generator = method
915 916 917 918 919 920 921 922

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

923
  def getMediaType(self):
924
    """
925 926
    This method return the type of media used in this session,
    for example, it could be "text/vcard" or "xml/text",...
927
    """
928
    return getattr(self, 'media_type', self.MEDIA_TYPE['TEXT_XML'])
929

930
  def setMediaType(self, media_type):
931
    """
932
    set the type of media used
933
    """
934 935 936
    if media_type in (None,''):
      media_type = self.MEDIA_TYPE['TEXT_XML']
    self.media_type = media_type
937

938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972
  def getLogin(self):
    """
    This method return the login of this subscription
    """
    return getattr(self, 'login', '')

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

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

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

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

  def getAuthenticationFormat(self):
    """
      return the format of authentication
    """
973
    return getattr(self, 'authentication_format', 'b64')
974 975 976 977 978

  def getAuthenticationType(self):
    """
      return the type of authentication
    """
979
    return getattr(self, 'authentication_type', 'syncml:auth-basic')
980 981 982 983 984 985 986 987 988 989 990 991 992

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

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

993 994 995 996 997 998 999 1000
  def getGidFromObject(self, object):
    """
    """
    o_base = aq_base(object)
    o_gid = None
    gid_gen = self.getGidGenerator()
    if callable(gid_gen):
      o_gid=gid_gen(object)
1001
    elif getattr(o_base, gid_gen, None) is not None:
1002
      generator = getattr(object, gid_gen)
1003
      o_gid = generator() # XXX - used to be o_gid = generator(object=object) which is redundant
1004 1005 1006
    elif gid_gen is not None:
      # It might be a script python
      generator = getattr(object,gid_gen)
1007
      o_gid = generator() # XXX - used to be o_gid = generator(object=object) which is redundant
1008
    o_gid = b16encode(o_gid)
1009 1010
    return o_gid

1011 1012 1013 1014 1015
  def getObjectFromGid(self, gid):
    """
    This tries to get the object with the given gid
    This uses the query if it exist
    """
1016
    signature = self.getSignatureFromGid(gid)
1017 1018 1019 1020
    # First look if we do already have the mapping between
    # the id and the gid
    object_list = self.getObjectList()
    destination = self.getDestination()
1021 1022
    if signature is not None and signature.getObjectId() is not None:
      o_id = signature.getObjectId()
1023 1024 1025
      o = None
      try:
        o = destination._getOb(o_id)
1026
      except (AttributeError, KeyError, TypeError):
1027 1028 1029 1030
        pass
      if o is not None and o in object_list:
        return o
    for o in object_list:
1031 1032 1033
      o_gid = self.getGidFromObject(o)
      if o_gid == gid:
        return o
Nicolas Delaby's avatar
Nicolas Delaby committed
1034
    #LOG('getObjectFromGid',0,'returning None')
1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045
    return None

  def getObjectFromId(self, id):
    """
    return the object corresponding to the id
    """
    object_list = self.getObjectList()
    #XXX very slow with lot of objects
    for object in object_list:
      if object.getId() == id:
        return object
1046 1047
    return None

1048 1049 1050 1051 1052 1053 1054 1055 1056
#  def setOneWaySyncFromServer(self,value):
#    """
#    If this option is enabled, then we will not 
#    send our own modifications
#    """
#    self.one_way_sync_from_server = value
#


1057 1058 1059 1060 1061 1062 1063 1064
  def getObjectList(self):
    """
    This returns the list of sub-object corresponding
    to the query
    """
    destination = self.getDestination()
    query = self.getQuery()
    query_list = []
1065 1066
    if query is None:
      return query_list
Sebastien Robin's avatar
Sebastien Robin committed
1067
    if isinstance(query, str):
1068 1069 1070
      query_method = getattr(destination,query,None)
      if query_method is not None:
        query_list = query_method()
1071
    elif callable(query): # XXX - used to be if callable(query)
1072
      query_list = query(destination)
1073 1074
    return [x for x in query_list
              if not getattr(x,'_conflict_resolution',False)]
1075

1076
  def generateNewIdWithGenerator(self, object=None,gid=None):
1077 1078 1079
    """
    This tries to generate a new Id
    """
1080
    id_generator = self.getSynchronizationIdGenerator()
1081
    if id_generator is not None:
1082
      o_base = aq_base(object)
1083 1084
      new_id = None
      if callable(id_generator):
1085
        new_id = id_generator(object,gid=gid)
1086
      elif getattr(o_base, id_generator, None) is not None:
1087
        generator = getattr(object, id_generator)
1088
        new_id = generator()
1089
      else: 
Nicolas Delaby's avatar
Nicolas Delaby committed
1090
        # This is probably a python script
1091 1092
        generator = getattr(object, id_generator)
        new_id = generator(object=object,gid=gid)
Nicolas Delaby's avatar
Nicolas Delaby committed
1093
      #LOG('generateNewId, new_id: ',0,new_id)
1094
      return new_id
1095 1096
    return None

1097
  def setSynchronizationIdGenerator(self, method):
1098 1099 1100 1101
    """
    This set the method name wich allows to generate
    a new id
    """
1102 1103
    if method in ('','None'):
      method = None
1104
    self.synchronization_id_generator = method
1105

1106
  def getSynchronizationIdGenerator(self):
1107 1108 1109
    """
    This get the method name wich allows to generate a new id
    """
1110
    return getattr(self, 'synchronization_id_generator', None)
1111

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129
  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

1130 1131 1132 1133 1134 1135
  def getDestination(self):
    """
      return the destination object itself
    """
    return self.unrestrictedTraverse(self.getDestinationPath())

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146
  def setDestinationPath(self, destination_path):
    """
      set the destination path
    """
    self.destination_path = destination_path

  def getSubscription(self):
    """
      return the current subscription
    """
    return self
Sebastien Robin's avatar
Sebastien Robin committed
1147 1148 1149 1150 1151 1152
    
  def setSessionId(self, session_id):
    """
      set the session id
    """
    self.session_id = session_id
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1153 1154 1155 1156 1157

  def getSessionId(self):
    """
      return the session id
    """
Sebastien Robin's avatar
Sebastien Robin committed
1158 1159 1160 1161 1162 1163 1164
    #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
1165
    self.session_id += 1
Sebastien Robin's avatar
Sebastien Robin committed
1166
    self.resetMessageId() # for a new session, the message Id must be reset
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1167 1168
    return self.session_id

Sebastien Robin's avatar
Sebastien Robin committed
1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190
  def incrementMessageId(self):
    """
      return the message id
    """
    #self.message_id += 1
    #return self.message_id
    #return 5
    value = getattr(self, 'message_id', 0)
    self.message_id = value +1
    return self.message_id

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

  def resetMessageId(self):
    """
      set the message id to 0
    """
    self.message_id = 0
1191 1192 1193 1194 1195 1196
  
  def setMessageId(self, message_id):
    """
      set the message id to message_id
    """
    self.message_id = message_id
Sebastien Robin's avatar
Sebastien Robin committed
1197

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241
  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
    """
1242 1243 1244
    if signature.getGid() in self.getGidList():
      self.delSignature(signature.getGid())
    self._setObject(signature.getGid(), aq_base(signature))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1245

1246
  def delSignature(self, gid):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1247
    """
1248
      del a Signature of the subscription
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1249
    """
1250 1251
    #del self.signatures[gid]
    self._delObject(gid)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1252

1253
  def getSignatureFromObjectId(self, id):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
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
    return the signature corresponding to the gid
    """
    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
    """
    o = None
    # XXX very slow
    for signature in self.getSignatureList():
      if gid == signature.getGid():
        o = signature
        break
    return o

  def getSignatureFromRid(self, rid):
    """
    return the signature corresponding to the rid
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1280
    """
1281
    o = None
1282 1283 1284 1285 1286
    # XXX very slow
    for signature in self.getSignatureList():
      if rid == signature.getRid():
        o = signature
        break
1287
    return o
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1288

1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318
  def getObjectIdList(self):
    """
    Returns the list of gids from signature
    """
    object_id_list = []
    for signature in self.getSignatureList():
      if signature.getObjectId() is not None:
        object_id_list.append(signature.getObjectId())
    return object_id_list

  def getGidList(self):
    """
    Returns the list of gids from signature
    """
    gid_list = []
    for signature in self.getSignatureList():
      if signature.getGid() is not None:
        gid_list.append(signature.getGid())
    return gid_list

  def getRidList(self):
    """
    Returns the list of rids from signature
    """
    rid_list = []
    for signature in self.getSignatureList():
      if signature.getRid() is not None:
        rid_list.append(signature.getRid())
    return rid_list

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1319 1320 1321 1322
  def getSignatureList(self):
    """
      add a Signature to the subscription
    """
1323
    return self.objectValues()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1324

1325
  def hasSignature(self, gid):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1326 1327 1328
    """
      Check if there's a signature with this uid
    """
1329 1330
    #return self.signatures.has_key(gid)
    return gid in self.objectIds()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1331 1332 1333 1334 1335

  def resetAllSignatures(self):
    """
      Reset all signatures
    """
1336 1337 1338
    while len(self.objectIds())>0:
      for id in self.objectIds():
        self._delObject(id)
1339

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1340 1341 1342 1343 1344 1345 1346 1347 1348
  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

1349
  def getRemainingObjectPathList(self):
1350 1351 1352 1353
    """
    We should now wich objects should still
    synchronize
    """
1354
    return getattr(self,'remaining_object_path_list',None)
1355

1356
  def setRemainingObjectPathList(self, value):
1357 1358 1359 1360
    """
    We should now wich objects should still
    synchronize
    """
1361
    setattr(self,'remaining_object_path_list',value)
1362

1363
  def removeRemainingObjectPath(self, object_path):
1364 1365 1366 1367
    """
    We should now wich objects should still
    synchronize
    """
1368
    remaining_object_list = self.getRemainingObjectPathList()
1369 1370 1371
    if remaining_object_list is not None:
      new_list = []
      for o in remaining_object_list:
1372
        if o != object_path:
1373
          new_list.append(o)
1374
      self.setRemainingObjectPathList(new_list)
1375

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1376 1377 1378 1379
  def startSynchronization(self):
    """
    Set the status of every object as NOT_SYNCHRONIZED
    """
1380
    for o in self.objectValues():
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1381
      # Change the status only if we are not in a conflict mode
1382
      if not(o.getStatus() in (self.CONFLICT,self.PUB_CONFLICT_MERGE,
1383
                                                        self.PUB_CONFLICT_CLIENT_WIN)):
1384 1385 1386
        o.setStatus(self.NOT_SYNCHRONIZED)
        o.setPartialXML(None)
        o.setTempXML(None)
1387
    self.setRemainingObjectPathList(None)
1388

1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413

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

  def encode(self, format, string_to_encode):
    """
      return the string_to_encode encoded with format format
    """
    if format in ('', None):
      return string_to_encode
    if format == 'b64':
      return b64encode(string_to_encode)
    #elif format is .... put here the other formats
    else:#if there is no format corresponding with format, raise an error
Nicolas Delaby's avatar
Nicolas Delaby committed
1414
      #LOG('encode : unknown or not implemented format :', 0, format)
1415
      raise ValueError, "Sorry, the server ask for the format %s but it's unknow or not implemented" % format
1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427

  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
Nicolas Delaby's avatar
Nicolas Delaby committed
1428
      #LOG('decode : unknown or not implemented format :', 0, format)
1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452
      raise ValueError, "Sorry, the format %s is unknow or not implemented" % format

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


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

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