XMLSyncUtils.py 55.4 KB
Newer Older
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
##############################################################################
#
# Copyright (c) 2002 Nexedi SARL and Contributors. All Rights Reserved.
#          Sebastien Robin <seb@nexedi.com>
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsability of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# garantees and support are strongly adviced to contract a Free Software
# Service Company
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
#
##############################################################################

import smtplib
from Products.ERP5SyncML.SyncCode import SyncCode
from Products.ERP5SyncML.Subscription import Signature
32
from DateTime import DateTime
33
from StringIO import StringIO
Jean-Paul Smets's avatar
Jean-Paul Smets committed
34
from xml.dom.ext import PrettyPrint
Nicolas Delaby's avatar
Nicolas Delaby committed
35
from ERP5Diff import ERP5Diff
36
import random
Nicolas Delaby's avatar
Nicolas Delaby committed
37
from zLOG import LOG
38 39 40 41 42 43
try:
  from Products.CMFActivity.ActiveObject import ActiveObject
except ImportError:
  LOG('XMLSyncUtils',0,"Can't import ActiveObject")
  class ActiveObject:
    pass
Jean-Paul Smets's avatar
Jean-Paul Smets committed
44
import commands
Nicolas Delaby's avatar
Nicolas Delaby committed
45

46 47 48 49 50 51 52
try:
  from Ft.Xml import Parse
except ImportError:
  LOG('XMLSyncUtils',0,"Can't import Parse")
  class Parse:
    def __init__(self, *args, **kw):
      raise ImportError, "Sorry, it was not possible to import Ft library"
Jean-Paul Smets's avatar
Jean-Paul Smets committed
53

54 55 56 57 58
try:
      from base64 import b16encode, b16decode
except ImportError:
      from base64 import encodestring as b16encode, decodestring as b16decode

59
class XMLSyncUtilsMixin(SyncCode):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
60

Sebastien Robin's avatar
Sebastien Robin committed
61
  def SyncMLHeader(self, session_id, msg_id, target, source, target_name=None, 
62 63
      source_name=None, dataCred=None, authentication_format='b64', 
      authentication_type='syncml:auth-basic'):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
64 65 66 67
    """
      Since the Header is always almost the same, this is the
      way to set one quickly.
    """
Sebastien Robin's avatar
Sebastien Robin committed
68 69 70 71 72 73 74 75 76
    xml_list = []
    xml = xml_list.append
    xml(' <SyncHdr>\n')
    xml('  <VerDTD>1.1</VerDTD>\n')
    xml('  <VerProto>SyncML/1.1</VerProto>\n')
    xml('  <SessionID>%s</SessionID>\n' % session_id)
    xml('  <MsgID>%s</MsgID>\n' % msg_id)
    xml('  <Target>\n')
    xml('   <LocURI>%s</LocURI>\n' % target)
77
    if target_name not in (None, ''):
Sebastien Robin's avatar
Sebastien Robin committed
78 79 80 81
      xml('   <LocName>%s</LocName>\n' %target_name)
    xml('  </Target>\n')
    xml('  <Source>\n')
    xml('   <LocURI>%s</LocURI>\n' % source) 
82
    if source_name not in (None, ''):
Sebastien Robin's avatar
Sebastien Robin committed
83 84
      xml('   <LocName>%s</LocName>\n' % source_name)
    xml('  </Source>\n')
85 86 87
    if dataCred not in (None, ''):
      xml('  <Cred>\n')
      xml('   <Meta>\n')
88 89
      xml("    <Format xmlns='syncml:metinf'>%s</Format>\n" % authentication_format)
      xml("    <Type xmlns='syncml:metinf'>%s</Type>\n" % authentication_type)
90 91 92
      xml('   </Meta>\n')
      xml('   <Data>%s</Data>\n' % dataCred)
      xml('  </Cred>\n')
Sebastien Robin's avatar
Sebastien Robin committed
93 94 95
    xml(' </SyncHdr>\n')
    xml_a = ''.join(xml_list)
    return xml_a
Jean-Paul Smets's avatar
Jean-Paul Smets committed
96

Sebastien Robin's avatar
Sebastien Robin committed
97 98
  def SyncMLAlert(self, cmd_id, sync_code, target, source, last_anchor, 
      next_anchor):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
99 100 101 102
    """
      Since the Alert section is always almost the same, this is the
      way to set one quickly.
    """
Sebastien Robin's avatar
Sebastien Robin committed
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
    xml_list = []
    xml = xml_list.append
    xml('  <Alert>\n')
    xml('   <CmdID>%s</CmdID>\n' % cmd_id)
    xml('   <Data>%s</Data>\n' % sync_code)
    xml('   <Item>\n')
    xml('    <Target>\n')
    xml('     <LocURI>%s</LocURI>\n' % target)
    xml('    </Target>\n')
    xml('    <Source>\n')
    xml('     <LocURI>%s</LocURI>\n' % source)
    xml('    </Source>\n')
    xml('    <Meta>\n')
    xml('     <Anchor xmlns=\'syncml:metinf\'>\n')
    xml('      <Last>%s</Last>\n' % last_anchor)
    xml('      <Next>%s</Next>\n' % next_anchor)
    xml('     </Anchor>\n')
    xml('    </Meta>\n')
    xml('   </Item>\n')
    xml('  </Alert>\n')
    xml_a = ''.join(xml_list)
    return xml_a
Jean-Paul Smets's avatar
Jean-Paul Smets committed
125

Sebastien Robin's avatar
Sebastien Robin committed
126
  def SyncMLStatus(self, cmd_id, target_ref, source_ref, sync_code, 
127
      next_anchor=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
128 129 130 131
    """
      Since the Status section is always almost the same, this is the
      way to set one quickly.
    """
Sebastien Robin's avatar
Sebastien Robin committed
132 133 134 135 136 137 138
    xml_list = []
    xml = xml_list.append
    xml('  <Status>\n')
    xml('   <CmdID>%s</CmdID>\n' % cmd_id)
    xml('   <TargetRef>%s</TargetRef>\n' % target_ref)
    xml('   <SourceRef>%s</SourceRef>\n' % source_ref)
    xml('   <Data>%s</Data>\n' % sync_code)
139 140 141 142 143 144 145 146
    if next_anchor is not None:
      xml('   <Item>\n')
      xml('    <Data>\n')
      xml('     <Anchor xmlns=\'syncml:metinf\'>\n')
      xml('      <Next>%s</Next>\n' % next_anchor)
      xml('     </Anchor>\n')
      xml('    </Data>\n')
      xml('   </Item>\n')
Sebastien Robin's avatar
Sebastien Robin committed
147 148 149
    xml('  </Status>\n')
    xml_a = ''.join(xml_list)
    return xml_a
Jean-Paul Smets's avatar
Jean-Paul Smets committed
150

151 152 153
  def SyncMLConfirmation(self, cmd_id=None, target_ref=None, cmd=None, 
      sync_code=None, msg_ref=None, cmd_ref=None, source_ref=None, 
      remote_xml=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
154
    """
Sebastien Robin's avatar
Sebastien Robin committed
155
    This is used in order to confirm that an object was correctly
Jean-Paul Smets's avatar
Jean-Paul Smets committed
156 157
    synchronized
    """
158 159 160 161 162 163
    if remote_xml is not None :
      msg_ref=remote_xml.xpath("string(//MsgID)").encode('utf-8')
      cmd_ref=remote_xml.xpath("string(.//CmdID)").encode('utf-8')
      target_ref=remote_xml.xpath("string(.//Target/LocURI)").encode('utf-8')
      source_ref=remote_xml.xpath("string(.//Source/LocURI)").encode('utf-8')

Sebastien Robin's avatar
Sebastien Robin committed
164 165 166
    xml_list = []
    xml = xml_list.append
    xml('  <Status>\n')
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
    #here there is a lot of test to keep compatibility with older call
    if cmd_id not in (None,'') :
      xml('   <CmdID>%s</CmdID>\n' % cmd_id)
    if msg_ref not in (None,''):
      xml('   <MsgRef>%s</MsgRef>\n' % msg_ref)
    if cmd_ref not in (None,''):
      xml('   <CmdRef>%s</CmdRef>\n' %cmd_ref)
    if cmd not in (None,''):
      xml('   <Cmd>%s</Cmd>\n' % cmd)
    if target_ref not in (None,''):
      xml('   <TargetRef>%s</TargetRef>\n' % target_ref)
    if source_ref not in (None,''):
      xml('   <SourceRef>%s</SourceRef>\n' % source_ref)
    if sync_code not in (None,''):
      xml('   <Data>%s</Data>\n' % sync_code)
Sebastien Robin's avatar
Sebastien Robin committed
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
    xml('  </Status>\n')
    xml_a = ''.join(xml_list)
    return xml_a
    
  def SyncMLChal(self, cmd_id, cmd, target_ref, source_ref, auth_format, 
      auth_type, data_code):
    """
    This is used in order to ask crendentials
    """
    xml_list = []
    xml = xml_list.append
    xml('  <Status>\n')
    xml('   <CmdID>%s</CmdID>\n' % cmd_id)
    xml('   <Cmd>%s</Cmd>\n' % cmd)
    xml('   <TargetRef>%s</TargetRef>\n' % target_ref)
    xml('   <SourceRef>%s</SourceRef>\n' % source_ref)
    xml('   <Chal>\n')
    xml('    <Meta>\n')
200 201
    xml("     <Format xmlns='syncml:metinf'>%s</Format>\n" % auth_format)
    xml("     <Type xmlns='syncml:metinf'>%s</Type>\n" % auth_type)
Sebastien Robin's avatar
Sebastien Robin committed
202 203 204 205 206 207
    xml('    </Meta>\n')
    xml('   </Chal>\n')
    xml('   <Data>%s</Data>\n' % str(data_code))
    xml('  </Status>\n')
    xml_a = ''.join(xml_list)
    return xml_a
Jean-Paul Smets's avatar
Jean-Paul Smets committed
208

209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
  def SyncMLPut(self, cmd_id, subscription):
    """
    this is used to inform the server of the CTType version supported
    """
    from Products.ERP5SyncML import Conduit
    # Import the conduit and get it
    conduit_name = subscription.getConduit()
    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)()
    #if the conduit support the SyncMLPut :
    if hasattr(conduit, 'getCapabilitiesCTType') and \
        hasattr(conduit, 'getCapabilitiesVerCTList') and \
        hasattr(conduit, 'getPreferedCapabilitieVerCT'):
      xml_list = []
      xml = xml_list.append
      if conduit.getCapabilitiesVerCTList() not in ([], None):
        xml('  <Put>\n')
        xml('   <CmdID>%s</CmdID>\n' % cmd_id)
        xml('   <Meta>\n')
        xml('    <Type>application/vnd.syncml-devinf+xml</Type>\n');
        xml('   </Meta>\n')
        xml('   <Item>\n')
        xml('    <Source>\n')
        xml('     <LocURI>./devinf11</LocURI>\n')
        xml('    </Source>\n')
        xml('    <Data>\n')
        xml('     <DevInf>\n')
        xml('      <VerDTD>1.1</VerDTD>\n')
        xml('      <Man>Fabien MORIN</Man>\n')
        xml('      <Mod>ERP5SyncML</Mod>\n')
        xml('      <OEM>Open Source</OEM>\n')
        xml('      <SwV>0.1</SwV>\n')
        xml('      <DevID>%s</DevID>\n' % subscription.getSubscriptionUrl())
        xml('      <DevTyp>workstation</DevTyp>\n')
        xml('      <UTC/>\n')
        xml('      <DataStore>\n')
        xml('       <SourceRef>%s</SourceRef>\n' % subscription.getSourceURI())
        xml('       <Rx-Pref>\n')
        xml('        <CTType>%s</CTType>\n' % conduit.getCapabilitiesCTType())
        xml('        <VerCT>%s</VerCT>\n' % conduit.getPreferedCapabilitieVerCT())
        xml('       </Rx-Pref>\n')
        for rx_version in conduit.getCapabilitiesVerCTList():
          xml('       <Rx>\n')
          xml('        <CTType>%s</CTType>\n' % conduit.getCapabilitiesCTType())
          xml('        <VerCT>%s</VerCT>\n' % rx_version)
          xml('       </Rx>\n')

        xml('       <Tx-Pref>\n')
        xml('        <CTType>%s</CTType>\n' % conduit.getCapabilitiesCTType())
        xml('        <VerCT>%s</VerCT>\n' % conduit.getPreferedCapabilitieVerCT())
        xml('       </Tx-Pref>\n')
        for tx_version in conduit.getCapabilitiesVerCTList():
          xml('       <Tx>\n')
          xml('        <CTType>%s</CTType>\n' % conduit.getCapabilitiesCTType())
          xml('        <VerCT>%s</VerCT>\n' % rx_version)
          xml('       </Tx>\n')

        xml('       <SyncCap>\n')
        xml('        <SyncType>2</SyncType>\n')
        xml('        <SyncType>1</SyncType>\n')
        xml('        <SyncType>4</SyncType>\n')
        xml('        <SyncType>6</SyncType>\n')
        xml('       </SyncCap>\n')

        xml('      </DataStore>\n')
        xml('     </DevInf>\n')
        xml('    </Data>\n')
        xml('   </Item>\n')
        xml('  </Put>\n')
      xml_a = ''.join(xml_list)
      return xml_a
    return ''


Jean-Paul Smets's avatar
Jean-Paul Smets committed
290 291 292 293 294 295 296 297 298
  def sendMail(self, fromaddr, toaddr, id_sync, msg):
    """
      Send a message via email
      - sync_object : this is a publication or a subscription
      - message : what we want to send
    """
    header = "Subject: %s\n" % id_sync
    header += "To: %s\n\n" % toaddr
    msg = header + msg
Nicolas Delaby's avatar
Nicolas Delaby committed
299
    #LOG('SubSendMail',0,'from: %s, to: %s' % (fromaddr,toaddr))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
300 301 302
    server = smtplib.SMTP('localhost')
    server.sendmail(fromaddr, toaddr, msg)
    # if we want to send the email to someone else (debugging)
303
    #server.sendmail(fromaddr, "seb@localhost", msg)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
304 305
    server.quit()

306
  def addXMLObject(self, cmd_id=0, object=None, xml_string=None,
307
                  more_data=0,gid=None, media_type=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
308 309 310
    """
      Add an object with the SyncML protocol
    """
Sebastien Robin's avatar
Sebastien Robin committed
311 312 313 314
    xml_list = []
    xml = xml_list.append
    xml('   <Add>\n')
    xml('    <CmdID>%s</CmdID>\n' % cmd_id)
315
    xml('    <Meta>\n')
316
    xml('     <Type>%s</Type>\n' % media_type)
317
    xml('    </Meta>\n')
Sebastien Robin's avatar
Sebastien Robin committed
318 319 320 321
    xml('    <Item>\n')
    xml('     <Source>\n')
    xml('      <LocURI>%s</LocURI>\n' % gid)
    xml('     </Source>\n')
322 323 324 325 326 327 328 329
    if media_type == self.MEDIA_TYPE['TEXT_XML']:
      xml('     <Data>')
      xml(xml_string)
      xml('</Data>\n')
    else:
      xml('     <Data><![CDATA[')
      xml(xml_string)
      xml('\n]]></Data>\n')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
330
    if more_data == 1:
Sebastien Robin's avatar
Sebastien Robin committed
331 332 333 334 335
      xml('     <MoreData/>\n')
    xml('    </Item>\n')
    xml('   </Add>\n')
    xml_a = ''.join(xml_list)
    return xml_a
Jean-Paul Smets's avatar
Jean-Paul Smets committed
336

337
  def deleteXMLObject(self, cmd_id=0, object_gid=None, xml_object=''):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
338
    """
Sebastien Robin's avatar
Sebastien Robin committed
339 340 341 342 343 344 345 346 347 348
      Delete an object with the SyncML protocol
    """
    xml_list = []
    xml = xml_list.append
    xml('   <Delete>\n')
    xml('    <CmdID>%s</CmdID>\n' % cmd_id)
    xml('    <Item>\n')
    xml('     <Source>\n')
    xml('      <LocURI>%s</LocURI>\n' % object_gid)
    xml('     </Source>\n')
349 350
    #xml('     <Data>\n')  #this 2 lines seems to be useless
    #xml('     </Data>\n')
Sebastien Robin's avatar
Sebastien Robin committed
351 352 353 354
    xml('    </Item>\n')
    xml('   </Delete>\n')
    xml_a = ''.join(xml_list)
    return xml_a
Jean-Paul Smets's avatar
Jean-Paul Smets committed
355

356
  def replaceXMLObject(self, cmd_id=0, object=None, xml_string=None,
357
                       more_data=0, gid=None, media_type=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
358
    """
Sebastien Robin's avatar
Sebastien Robin committed
359 360 361 362 363 364
      Replace an object with the SyncML protocol
    """
    xml_list = []
    xml = xml_list.append
    xml('   <Replace>\n')
    xml('    <CmdID>%s</CmdID>\n' % cmd_id)
365
    xml('    <Meta>\n')
366
    xml('     <Type>%s</Type>\n' % media_type)
367
    xml('    </Meta>\n')
Sebastien Robin's avatar
Sebastien Robin committed
368 369 370 371
    xml('    <Item>\n')
    xml('     <Source>\n')
    xml('      <LocURI>%s</LocURI>\n' % str(gid))
    xml('     </Source>\n')
372
    xml('     <Data>')
Sebastien Robin's avatar
Sebastien Robin committed
373 374
    xml(xml_string)
    xml('     </Data>\n')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
375
    if more_data == 1:
Sebastien Robin's avatar
Sebastien Robin committed
376 377 378 379 380
      xml('     <MoreData/>\n')
    xml('    </Item>\n')
    xml('   </Replace>\n')
    xml_a = ''.join(xml_list)
    return xml_a
Jean-Paul Smets's avatar
Jean-Paul Smets committed
381

Nicolas Delaby's avatar
Nicolas Delaby committed
382
  def getXupdateObject(self, object_xml=None, old_xml=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
383 384
    """
    Generate the xupdate with the new object and the old xml
Nicolas Delaby's avatar
Nicolas Delaby committed
385 386 387 388 389 390 391 392 393 394 395 396 397
    """
    erp5diff = ERP5Diff()
    erp5diff.compare(old_xml, object_xml)
    xupdate_doc = erp5diff._result
    #minidom is buggy, add namespace declaration, and version
    attr_ns = xupdate_doc.createAttribute('xmlns:xupdate')
    attr_ns.value = 'http://www.xmldb.org/xupdate'
    attr_version = xupdate_doc.createAttribute('version')
    attr_version.value='1.0'
    xupdate_doc.documentElement.setAttributeNode(attr_ns)
    xupdate_doc.documentElement.setAttributeNode(attr_version)
    xupdate = xupdate_doc.toxml()
    #omit xml declaration
Jean-Paul Smets's avatar
Jean-Paul Smets committed
398 399 400
    xupdate = xupdate[xupdate.find('<xupdate:modifications'):]
    return xupdate

401 402 403 404 405
  def getSessionId(self, xml):
    """
    We will retrieve the session id of the message
    """
    session_id = 0
406 407
    session_id = xml.xpath('string(/SyncML/SyncHdr/SessionID)')
    session_id = int(session_id)
408
    return session_id
Sebastien Robin's avatar
Sebastien Robin committed
409 410 411 412 413 414
    
  def getMessageId(self, xml):
    """
    We will retrieve the message id of the message
    """
    message_id = 0
415 416
    message_id = xml.xpath('string(/SyncML/SyncHdr/MsgID)')
    message_id = int(message_id)
Sebastien Robin's avatar
Sebastien Robin committed
417 418 419 420 421 422 423
    return message_id

  def getTarget(self, xml):
    """
    return the target in the SyncHdr section
    """
    url = ''
424 425
    url = xml.xpath('string(/SyncML/SyncHdr/Target/LocURI)')
    url = url.encode('utf-8')
Sebastien Robin's avatar
Sebastien Robin committed
426 427
    return url

Jean-Paul Smets's avatar
Jean-Paul Smets committed
428 429 430 431 432
  def getAlertLastAnchor(self, xml_stream):
    """
      Return the value of the last anchor, in the
      alert section of the xml_stream
    """
Sebastien Robin's avatar
Sebastien Robin committed
433
    first_node = xml_stream.childNodes[0]
Jean-Paul Smets's avatar
Jean-Paul Smets committed
434 435 436

    # Get informations from the body
    client_body = first_node.childNodes[3]
437 438
    last_anchor = client_body.xpath('string(/Alert/Item/Meta/Anchor/Last)')
    last_anchor = last_anchor.encode('utf-8')
Sebastien Robin's avatar
Sebastien Robin committed
439
    return last_anchor
Jean-Paul Smets's avatar
Jean-Paul Smets committed
440 441 442 443 444 445

  def getAlertNextAnchor(self, xml_stream):
    """
      Return the value of the next anchor, in the
      alert section of the xml_stream
    """
Sebastien Robin's avatar
Sebastien Robin committed
446
    first_node = xml_stream.childNodes[0]
Jean-Paul Smets's avatar
Jean-Paul Smets committed
447 448 449 450 451
    if first_node.nodeName != "SyncML":
      print "This is not a SyncML message"

    # Get informations from the body
    client_body = first_node.childNodes[3]
452 453 454
    next_anchor = client_body.xpath('string(/Alert/Item/Meta/Anchor/Next)')
    next_anchor = next_anchor.encode('utf-8')
    return next_anchor
Jean-Paul Smets's avatar
Jean-Paul Smets committed
455

456 457 458 459 460 461 462 463 464
  def getSourceURI(self, xml):
    """
    return the source URI of the syncml header
    """
    subscription_url = xml.xpath('string(//SyncHdr/Source/LocURI)')
    if isinstance(subscription_url, unicode):
      subscription_url = subscription_url.encode('utf-8')
    return subscription_url
  
Jean-Paul Smets's avatar
Jean-Paul Smets committed
465 466 467 468
  def getStatusTarget(self, xml):
    """
      Return the value of the alert code inside the xml_stream
    """
469 470 471 472
    status = xml.xpath('string(TargetRef)')
    if isinstance(status, unicode):
      status = status.encode('utf-8')
    return status
Jean-Paul Smets's avatar
Jean-Paul Smets committed
473 474 475 476 477

  def getStatusCode(self, xml):
    """
      Return the value of the alert code inside the xml_stream
    """
478 479 480
    status_code = xml.xpath('string(Data)')
    if status_code not in ('', None, []):
      return int(status_code)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
481 482
    return None

483 484 485 486 487
  def getStatusCommand(self, xml):
    """
      Return the value of the command inside the xml_stream
    """
    if xml.nodeName=='Status':
488 489 490 491
      cmd = xml.xpath('string(//Status/Cmd)')
      if isinstance(cmd, unicode):
        cmd = cmd.encode('utf-8')
      return cmd
492 493
    else:
      return None
494

495 496 497
  def getCred(self, xml):
    """
      return the credential information : type, format and data
Nicolas Delaby's avatar
Nicolas Delaby committed
498
    """
499 500 501 502 503
    format=''
    type=''
    data=''

    first_node = xml.childNodes[0]
504 505
    format = first_node.xpath("string(/SyncML/SyncHdr/Cred/Meta/*[local-name() = 'Format'])")
    type = first_node.xpath("string(/SyncML/SyncHdr/Cred/Meta/*[local-name() = 'Type'])")
506
    data = first_node.xpath('string(/SyncML/SyncHdr/Cred/Data)')
507

508 509 510
    format = format.encode('utf-8')
    type = type.encode('utf-8')
    data = data.encode('utf-8')
511 512
    return (format, type, data)

513
  def checkCred(self, xml_stream):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
514
    """
515
      Check if there's a Cred section in the xml_stream
Jean-Paul Smets's avatar
Jean-Paul Smets committed
516
    """
517 518 519
    if xml_stream.xpath('string(SyncML/SyncHdr/Cred)') not in ('', None, []):
      return True
    return False
Jean-Paul Smets's avatar
Jean-Paul Smets committed
520

521
  def getChal(self, xml):
Sebastien Robin's avatar
Sebastien Robin committed
522
    """
523 524
      return the chalenge information : format and type
    """    
525 526
    format=None
    type=None
527 528

    first_node = xml.childNodes[0]
529 530
    format = first_node.xpath("string(//*[local-name() = 'Format'])")
    type = first_node.xpath("string(//*[local-name() = 'Type'])")
531 532 533 534 535 536

    format = format.encode('utf-8')
    type = type.encode('utf-8')
    return (format, type)

  def checkChal(self, xml_stream):
Sebastien Robin's avatar
Sebastien Robin committed
537
    """
538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553
      Check if there's a Chal section in the xml_stream
    """
    if xml_stream.xpath('string(SyncML/SyncBody/Status/Chal)') \
        not in ('', None, []):
      return True
    return False

  def getAlertCode(self, xml_stream):
    """
      Return the value of the alert code inside the full syncml message
    """
    alert_code = xml_stream.xpath('string(SyncML/SyncBody/Alert/Data)')
    if alert_code not in (None, ''):
      return int(alert_code)
    else:
      return None
Sebastien Robin's avatar
Sebastien Robin committed
554

Jean-Paul Smets's avatar
Jean-Paul Smets committed
555 556
  def checkAlert(self, xml_stream):
    """
Sebastien Robin's avatar
Sebastien Robin committed
557
      Check if there's an Alert section in the xml_stream
Jean-Paul Smets's avatar
Jean-Paul Smets committed
558
    """
559 560 561
    alert = False
    if xml_stream.xpath('string(SyncML/SyncBody/Alert)') not in ('', None, []):
      alert = True
Jean-Paul Smets's avatar
Jean-Paul Smets committed
562 563 564 565 566 567
    return alert

  def checkSync(self, xml_stream):
    """
      Check if there's an Sync section in the xml_xtream
    """
568 569 570 571
    sync = False
    if xml_stream.xpath('string(SyncML/SyncBody/Sync)') not in ('', None, []):
      sync = True
    return sync
Jean-Paul Smets's avatar
Jean-Paul Smets committed
572

573
  def checkStatus(self, xml_stream):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
574 575 576
    """
      Check if there's a Status section in the xml_xtream
    """
577 578 579
    status = False
    if xml_stream.xpath('string(SyncML/SyncBody/Status)') not in ('', None, []):
      status = True
Jean-Paul Smets's avatar
Jean-Paul Smets committed
580 581
    return status

582
  def getSyncActionList(self, xml_stream):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
583
    """
584
    return the list of the action (could be "add", "replace", "delete").
Jean-Paul Smets's avatar
Jean-Paul Smets committed
585
    """
586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602
    return xml_stream.xpath('//Add|//Delete|//Replace')

  def getSyncBodyStatusList(self, xml_stream):
    """
    return the list of dictionary corredponding to the data of each status bloc
    the data are : cmd, code and source
    """
    status_list = []
    xml = xml_stream.xpath('//Status')
    for status in xml:
      tmp_dict = {}
      tmp_dict['cmd']     = status.xpath('string(./Cmd)').encode('utf-8')
      tmp_dict['code']    = status.xpath('string(./Data)').encode('utf-8')
      tmp_dict['source']  = status.xpath('string(./SourceRef)').encode('utf-8')
      tmp_dict['target']  = status.xpath('string(./TargetRef)').encode('utf-8')
      status_list.append(tmp_dict)
    return status_list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
603

604 605 606 607
  def getDataText(self, action):
    """
    return the section data in text form, it's usefull for the VCardConduit
    """
608 609 610 611
    data = action.xpath('string(Item/Data)')
    if isinstance(data, unicode):
      data = data.encode('utf-8')
    return data
612

Jean-Paul Smets's avatar
Jean-Paul Smets committed
613 614 615 616
  def getDataSubNode(self, action):
    """
      Return the node starting with <object....> of the action
    """
617 618 619 620
    if action.xpath('.//Item/Data') not in ([], None):
      data_node = action.xpath('.//Item/Data')[0]
      if data_node.hasChildNodes():
        return data_node.childNodes[0]
621
    return None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
622 623 624 625 626

  def getPartialData(self, action):
    """
      Return the node starting with <object....> of the action
    """
627 628 629
    comment_list = action.xpath('.//Item/Data[comment()]')
    if comment_list != []:
      return comment_list[0].childNodes[0].data.encode('utf-8')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
630 631
    return None

632
  def getActionId(self, action, action_name):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
633 634 635
    """
      Return the rid of the object described by the action
    """
636 637 638 639 640 641
    id = action.xpath('string(.//Item/Source/LocURI)')
    if id in (None, ''):
      id = action.xpath('string(.//Item/Target/LocURI)')
    if isinstance(id, unicode):
      id = id.encode('utf-8')
    return id
Jean-Paul Smets's avatar
Jean-Paul Smets committed
642 643 644 645 646

  def checkActionMoreData(self, action):
    """
      Return the rid of the object described by the action
    """
647 648 649
    if action.xpath('Item/MoreData') not in ([],None) :
      return True
    return False
Jean-Paul Smets's avatar
Jean-Paul Smets committed
650 651 652 653 654

  def getActionType(self, action):
    """
      Return the type of the object described by the action
    """
655 656 657 658
    action_type = action.xpath('string(Meta/Type)')
    if isinstance(action_type, unicode):
      action_type = action_type.encode('utf-8')
    return action_type
Jean-Paul Smets's avatar
Jean-Paul Smets committed
659

660 661 662 663
  def getElementNodeList(self, node):
    """
      Return childNodes that are ElementNode
    """
664
    return node.xpath('*')
665

666 667 668 669 670
  def getTextNodeList(self, node):
    """
      Return childNodes that are ElementNode
    """
    subnode_list = []
671
    for subnode in node.childNodes or []:
672 673 674
      if subnode.nodeType == subnode.TEXT_NODE:
        subnode_list += [subnode]
    return subnode_list
675
  
676 677 678 679
  def getAttributeNodeList(self, node):
    """
      Return childNodes that are ElementNode
    """
680
    return node.xpath('@*')
681

682 683 684
  def getSyncMLData(self, domain=None, remote_xml=None, cmd_id=0,
                    subscriber=None, xml_confirmation=None, conduit=None,
                    max=1000, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
685
    """
686 687
    This generate the syncml data message. This returns a string
    with all modification made locally (ie replace, add ,delete...)
688 689 690

    if object is not None, this usually means we want to set the
    actual xupdate on the signature.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
691
    """
692 693
    local_gid_list = []
    syncml_data = ''
694 695 696
    result = {'finished':0}
    if isinstance(remote_xml, str) or isinstance(remote_xml, unicode):
      remote_xml = Parse(remote_xml)
697
    if subscriber.getRemainingObjectPathList() is None:
698
      object_list = domain.getObjectList()
699 700
      object_path_list = map(lambda x: x.getPhysicalPath(),object_list)
      subscriber.setRemainingObjectPathList(object_path_list)
701 702 703 704 705 706 707

      #object_gid = domain.getGidFromObject(object)
      local_gid_list = map(lambda x: domain.getGidFromObject(x),object_list)
      # Objects to remove
      for object_gid in subscriber.getGidList():
        if not (object_gid in local_gid_list):
          # This is an object to remove
708
          signature = subscriber.getSignatureFromGid(object_gid)
709 710 711
          if signature.getStatus()!=self.PARTIAL: # If partial, then we have a signature
                                                  # but no local object
            xml_object = signature.getXML()
712 713
            if xml_object is not None: # This prevent to delete an object that
                                      # we were not able to create
714 715 716
              rid = signature.getRid()
              if rid != None:
                object_gid=rid #to use the remote id if it exist
717 718
              syncml_data += self.deleteXMLObject(xml_object=signature.getXML()\
                  or '', object_gid=object_gid,cmd_id=cmd_id)
719
              cmd_id += 1
720

721
    local_gid_list = []
722
    loop = 0
723 724
    for object_path in subscriber.getRemainingObjectPathList():
      object = self.unrestrictedTraverse(object_path)
725
      status = self.SENT
726
      object_gid = domain.getGidFromObject(object)
727 728
      if object_gid in ('', None):
        continue;
729
      local_gid_list += [object_gid]
730
      force = 0
731 732 733
      if syncml_data.count('\n') < self.MAX_LINES and loop < max and not \
          object.id.startswith('.'):
        # If not we have to cut
734 735 736
        #LOG('getSyncMLData',0,'xml_mapping: %s' % str(domain.xml_mapping))
        #LOG('getSyncMLData',0,'code: %s' % str(self.getAlertCode(remote_xml)))
        #LOG('getSyncMLData',0,'gid_list: %s' % str(local_gid_list))
737
        #LOG('getSyncMLData',0,'subscriber.getGidList: %s' % subscriber.getGidList())
738 739
        #LOG('getSyncMLData',0,'hasSignature: %s' % str(subscriber.hasSignature(object_gid)))
        #LOG('getSyncMLData',0,'alert_code == slowsync: %s' % str(self.getAlertCode(remote_xml)==self.SLOW_SYNC))
740
        signature = subscriber.getSignatureFromGid(object_gid)
741

742
        # Here we first check if the object was modified or not by looking at dates
743
        if signature is not None:
744
          signature.checkSynchronizationNeeded(object)
745 746 747
        status = self.SENT
        more_data=0
        # For the case it was never synchronized, we have to send everything
748 749
        if signature is not None and signature.getXMLMapping()==None:
          pass
750 751 752
        elif signature == None or (signature.getXML() == None and \
            signature.getStatus() != self.PARTIAL) or \
            self.getAlertCode(remote_xml) == self.SLOW_SYNC:
753
          #LOG('PubSyncModif',0,'Current object.getPath: %s' % object.getPath())
754
          xml_object = domain.getXMLFromObject(object)
755
          xml_string = xml_object
756 757 758 759
          if isinstance(xml_string, unicode):
            xml_string = xml_object.encode('utf-8')
          gid = subscriber.getGidFromObject(object)
          signature = Signature(id=gid,object=object)
760 761
          signature.setTempXML(xml_object)
          if xml_string.count('\n') > self.MAX_LINES:
762
            if xml_string.find('--') >= 0: # This make comment fails, so we need to replace
763
              xml_string = xml_string.replace('--','@-@@-@')
764 765 766 767 768 769 770 771
            more_data=1
            i = 0
            short_string = ''
            rest_string = xml_string
            while i < self.MAX_LINES:
              short_string += rest_string[:rest_string.find('\n')+1]
              rest_string = xml_string[len(short_string):]
              i += 1
772
            #LOG('getSyncMLData',0,'setPartialXML with: %s' % str(rest_string))
773
            signature.setPartialXML(rest_string)
774
            status = self.PARTIAL
775 776
            signature.setAction('Add')
            xml_string = '<!--' + short_string + '-->'
777 778 779
          gid = signature.getRid()#in fisrt, we try with rid if there is one
          if gid == None:
            gid = signature.getGid()
780
          syncml_data += self.addXMLObject(cmd_id=cmd_id, object=object, 
781 782
              gid=gid, xml_string=xml_string, 
              more_data=more_data, media_type=subscriber.getMediaType())
783 784 785 786 787
          cmd_id += 1
          signature.setStatus(status)
          subscriber.addSignature(signature)
        elif signature.getStatus()==self.NOT_SYNCHRONIZED \
            or signature.getStatus()==self.PUB_CONFLICT_MERGE: # We don't have synchronized this object yet
788
          xml_object = domain.getXMLFromObject(object)
789 790
          #LOG('getSyncMLData',0,'checkMD5: %s' % str(signature.checkMD5(xml_object)))
          #LOG('getSyncMLData',0,'getStatus: %s' % str(signature.getStatus()))
791
          if signature.getStatus()==self.PUB_CONFLICT_MERGE:
792 793 794
            xml_confirmation += self.SyncMLConfirmation(cmd_id=cmd_id, 
                source_ref=signature.getGid(), sync_code=self.CONFLICT_MERGE, 
                cmd='Replace')
795
          set_synchronized = 1
796
          if not signature.checkMD5(xml_object):
797
            set_synchronized = 0
798
            # This object has changed on this side, we have to generate some xmldiff
799 800 801
            xml_string = self.getXupdateObject(
                                      domain.getXMLFromObject(object),
                                      signature.getXML())
802
            if xml_string.count('\n') > self.MAX_LINES:
803 804
              # This make comment fails, so we need to replace
              if xml_string.find('--') >= 0:
805
                xml_string = xml_string.replace('--','@-@@-@')
806 807 808 809 810 811 812 813 814 815 816 817 818
              i = 0
              more_data=1
              short_string = ''
              rest_string = xml_string
              while i < self.MAX_LINES:
                short_string += rest_string[:rest_string.find('\n')+1]
                rest_string = xml_string[len(short_string):]
                i += 1
              signature.setPartialXML(rest_string)
              status = self.PARTIAL
              signature.setAction('Replace')
              xml_string = '<!--' + short_string + '-->'
            signature.setStatus(status)
819
            if subscriber.getMediaType() != self.MEDIA_TYPE['TEXT_XML']:
820
              xml_string = domain.getXMLFromObject(object)
821 822 823
            gid = signature.getRid()#in fisrt, we try with rid if there is one
            if gid == None:
              gid = signature.getGid()
824 825 826 827
            syncml_data += self.replaceXMLObject(cmd_id=cmd_id, object=object,
                                                 gid=gid, xml_string=xml_string,
                                                 more_data=more_data,
                                                 media_type=subscriber.getMediaType())
828 829
            cmd_id += 1
            signature.setTempXML(xml_object)
830 831
          # Now we can apply the xupdate from the subscriber
          subscriber_xupdate = signature.getSubscriberXupdate()
832
          #LOG('getSyncMLData subscriber_xupdate',0,subscriber_xupdate)
833 834
          if subscriber_xupdate is not None:
            old_xml = signature.getXML()
835 836
            conduit.updateNode(xml=subscriber_xupdate, object=object,
                previous_xml=old_xml, force=(domain.getDomainType() == self.SUB),
837
                simulate=0)
838
            xml_object = domain.getXMLFromObject(object)
839 840 841
            signature.setTempXML(xml_object)
          if set_synchronized: # We have to do that after this previous update
            # We should not have this case when we are in CONFLICT_MERGE
842

843 844 845
            signature.setStatus(self.SYNCHRONIZED)
        elif signature.getStatus()==self.PUB_CONFLICT_CLIENT_WIN:
          # We have decided to apply the update
846
          # XXX previous_xml will be geXML instead of getTempXML because
847 848
          # some modification was already made and the update
          # may not apply correctly
849
          xml_update = signature.getPartialXML()
850 851
          conduit.updateNode(xml=signature.getPartialXML(), object=object,
                            previous_xml=signature.getXML(),force=1)
852 853 854
          xml_confirmation += self.SyncMLConfirmation(cmd_id=cmd_id, 
              target_ref=object_gid, sync_code=self.CONFLICT_CLIENT_WIN,
              cmd='Replace')
855 856 857 858 859 860 861 862 863 864 865 866 867 868 869
          signature.setStatus(self.SYNCHRONIZED)
        elif signature.getStatus()==self.PARTIAL:
          xml_string = signature.getPartialXML()
          if xml_string.count('\n') > self.MAX_LINES:
            i = 0
            more_data=1
            short_string = ''
            rest_string = xml_string
            while i < self.MAX_LINES:
              short_string += rest_string[:rest_string.find('\n')+1]
              rest_string = xml_string[len(short_string):]
              i += 1
            signature.setPartialXML(rest_string)
            xml_string = short_string
            status = self.PARTIAL
870
          if xml_string.find('--') >= 0: # This make comment fails, so we need to replace
871
            xml_string = xml_string.replace('--','@-@@-@')
872 873
          xml_string = '<!--' + xml_string + '-->'
          signature.setStatus(status)
874
          if(subscriber.getMediaType() != self.MEDIA_TYPE['TEXT_XML']):
875
            xml_string = domain.getXMLFromObject(object)
Nicolas Delaby's avatar
Nicolas Delaby committed
876
          #LOG('xml_string =', 0, xml_string)
877
          if signature.getAction()=='Replace':
878 879 880
            gid = signature.getRid()#in fisrt, we try with rid if there is one
            if gid == None:
              gid = signature.getGid()
881
            syncml_data += self.replaceXMLObject(cmd_id=cmd_id, object=object,
882
                gid=gid, xml_string=xml_string, more_data=more_data,
883
                media_type=subscriber.getMediaType())
884
          elif signature.getAction()=='Add':
885 886 887
            gid = signature.getRid()#in fisrt, we try with rid if there is one
            if gid == None:
              gid = signature.getGid()
888
            syncml_data += self.addXMLObject(cmd_id=cmd_id, object=object, 
889 890
                gid=gid, xml_string=xml_string, 
                more_data=more_data, media_type=subscriber.getMediaType())
891 892
      else:
        break
893 894 895 896 897 898
      loop += 1
    result['finished'] = 1
    result['syncml_data'] = syncml_data
    result['xml_confirmation'] = xml_confirmation
    result['cmd_id'] = cmd_id
    return result
899

900 901
  def applyActionList(self, domain=None, subscriber=None, cmd_id=0,
                      remote_xml=None,conduit=None,simulate=0):
902 903 904
    """
    This just look to a list of action to do, then id applies
    each action one by one, thanks to a conduit
Jean-Paul Smets's avatar
Jean-Paul Smets committed
905
    """
906
    xml_confirmation = ''
Jean-Paul Smets's avatar
Jean-Paul Smets committed
907
    has_next_action = 0
908 909
    destination = self.unrestrictedTraverse(domain.getDestinationPath())
    #LOG('applyActionList args',0,'domain : %s\n subscriber : %s\n cmd_id : %s' % (domain, subscriber, cmd_id))
910
    for action in self.getSyncActionList(remote_xml):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
911 912 913
      conflict_list = []
      status_code = self.SUCCESS
      # Thirst we have to check the kind of action it is
914 915 916 917 918 919 920 921 922
      partial_data = self.getPartialData(action)
      rid = self.getActionId(action, action.nodeName)
      if action.nodeName != 'Delete':
        if hasattr(conduit, 'getGidFromXML'):
          gid = b16encode(conduit.getGidFromXML(self.getDataText(action)))
        else:
          gid=rid
      else:
        gid=rid
923
      object_id = domain.generateNewIdWithGenerator(object=destination,gid=gid)
924 925 926 927 928
      signature = subscriber.getSignatureFromGid(gid)
      if signature != None and rid != gid:
        #in this case, the object was created on another subscriber than erp5
        # and we should save it's remote id
        signature.setRid(rid)
Nicolas Delaby's avatar
Nicolas Delaby committed
929
      #LOG('gid == rid ?', 0, 'gid=%s, rid=%s' % (gid, rid))
930
      object = subscriber.getObjectFromGid(gid)
931
      #LOG('applyActionList subscriber.getObjectFromGid %s' % gid,0,object)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
932
      if signature == None:
Nicolas Delaby's avatar
Nicolas Delaby committed
933
        #LOG('applyActionList, signature is None',0,signature)
934 935 936 937 938 939 940
        if gid == rid:
          signature = Signature(id=gid, status=self.NOT_SYNCHRONIZED, 
              object=object).__of__(subscriber)
        else:
          signature = Signature(rid=rid, id=gid, status=self.NOT_SYNCHRONIZED,
              object=object).__of__(subscriber)
        signature.setObjectId(object_id)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
941 942
        subscriber.addSignature(signature)
      force = signature.getForce()
Nicolas Delaby's avatar
Nicolas Delaby committed
943
      #LOG('applyActionList',0,'object: %s' % repr(object))
944
      if self.checkActionMoreData(action) == 0:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
945 946
        data_subnode = None
        if partial_data != None:
947 948 949 950 951
          signature_partial_xml = signature.getPartialXML()
          if signature_partial_xml is not None:
            data_subnode = signature.getPartialXML() + partial_data
          else:
            data_subnode = partial_data
Nicolas Delaby's avatar
Nicolas Delaby committed
952
          #LOG('SyncModif',0,'data_subnode: %s' % data_subnode)
953
          if subscriber.getMediaType() == self.MEDIA_TYPE['TEXT_XML']:
954 955
            data_subnode = Parse(data_subnode)
            data_subnode = data_subnode.childNodes[0] # Because we just created a new xml
Jean-Paul Smets's avatar
Jean-Paul Smets committed
956 957
          # document, with childNodes[0] a DocumentType and childNodes[1] the Element Node
        else:
958
          if subscriber.getMediaType() != self.MEDIA_TYPE['TEXT_XML']:
959
            data_subnode = self.getDataText(action)
960
          else:
961 962
            data_subnode = self.getDataSubNode(action)
        if action.nodeName == 'Add':
Jean-Paul Smets's avatar
Jean-Paul Smets committed
963
          # Then store the xml of this new subobject
964
          if object is None:
965
            object_id = domain.generateNewIdWithGenerator(object=destination,gid=gid)
966
            #if object_id is not None:
967
            add_data = conduit.addNode(xml=data_subnode, 
968
                object=destination, object_id=object_id)
969 970
            if add_data['conflict_list'] not in ('', None, []):
              conflict_list += add_data['conflict_list']
971 972
            # Retrieve directly the object from addNode
            object = add_data['object']
Nicolas Delaby's avatar
Nicolas Delaby committed
973
            #LOG('XMLSyncUtils, in ADD add_data',0,add_data)
Nicolas Delaby's avatar
Nicolas Delaby committed
974 975
            if object is not None:
              signature.setPath(object.getPhysicalPath())
976
              signature.setObjectId(object.getId())
977 978 979
          else:
            #Object was retrieve but need to be updated without recreated
            #usefull when an object is only deleted by workflow.
980
            object_id = domain.generateNewIdWithGenerator(object=destination,gid=gid)
981
            add_data = conduit.addNode(xml=data_subnode,
982
                                       object=destination,
983 984
                                       object_id=object_id,
                                       sub_object=object)
985 986
            if add_data['conflict_list'] not in ('', None, []):
              conflict_list += add_data['conflict_list']
Jean-Paul Smets's avatar
Jean-Paul Smets committed
987
          if object is not None:
Nicolas Delaby's avatar
Nicolas Delaby committed
988
            #LOG('SyncModif',0,'addNode, found the object')
989 990 991 992
            #mapping = getattr(object,domain.getXMLMapping(),None)
            xml_object = domain.getXMLFromObject(object)
            #if mapping is not None:
            #  xml_object = mapping()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
993
            signature.setStatus(self.SYNCHRONIZED)
994
            #signature.setId(object.getId())
995
            signature.setPath(object.getPhysicalPath())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
996
            signature.setXML(xml_object)
997 998 999 1000 1001
            xml_confirmation += self.SyncMLConfirmation(
                cmd_id=cmd_id, 
                cmd='Add', 
                sync_code=self.ITEM_ADDED,
                remote_xml=action)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1002
            cmd_id +=1
1003
        elif action.nodeName == 'Replace':
Nicolas Delaby's avatar
Nicolas Delaby committed
1004
          #LOG('SyncModif',0,'object: %s will be updated...' % str(object))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1005
          if object is not None:
Nicolas Delaby's avatar
Nicolas Delaby committed
1006
            #LOG('SyncModif',0,'object: %s will be updated...' % object.id)
1007
            signature = subscriber.getSignatureFromGid(gid)
Nicolas Delaby's avatar
Nicolas Delaby committed
1008
            #LOG('SyncModif',0,'previous signature: %s' % str(signature))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1009
            previous_xml = signature.getXML()
1010
            #LOG('SyncModif',0,'previous signature: %i' % len(previous_xml))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1011
            conflict_list += conduit.updateNode(xml=data_subnode, object=object,
1012 1013
                              previous_xml=signature.getXML(),force=force,
                              simulate=simulate)
1014
            xml_object = domain.getXMLFromObject(object)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1015 1016 1017 1018
            signature.setTempXML(xml_object)
            if conflict_list != []:
              status_code = self.CONFLICT
              signature.setStatus(self.CONFLICT)
1019 1020
              signature.setConflictList(signature.getConflictList() \
                  + conflict_list)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1021 1022 1023 1024
              string_io = StringIO()
              PrettyPrint(data_subnode,stream=string_io)
              data_subnode_string = string_io.getvalue()
              signature.setPartialXML(data_subnode_string)
1025
            elif not simulate:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1026
              signature.setStatus(self.SYNCHRONIZED)
1027 1028 1029 1030 1031
            xml_confirmation += self.SyncMLConfirmation(\
                cmd_id=cmd_id, 
                cmd='Replace', 
                sync_code=status_code,
                remote_xml=action)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1032
            cmd_id +=1
1033 1034 1035 1036 1037 1038 1039
            if simulate:
              # This means we are on the publiher side and we want to store
              # the xupdate from the subscriber and we also want to generate
              # the current xupdate from the last synchronization
              string_io = StringIO()
              PrettyPrint(data_subnode,stream=string_io)
              data_subnode_string = string_io.getvalue()
Nicolas Delaby's avatar
Nicolas Delaby committed
1040
              #LOG('applyActionList, subscriber_xupdate:',0,data_subnode_string)
1041 1042
              signature.setSubscriberXupdate(data_subnode_string)

1043
        elif action.nodeName == 'Delete':
1044
          object_id = signature.getId()
1045
          if subscriber.getMediaType() != self.MEDIA_TYPE['TEXT_XML']: 
1046
            data_subnode = self.getDataText(action)
1047
          else:
1048 1049 1050
            data_subnode = self.getDataSubNode(action)
          if subscriber.getObjectFromGid(object_id) not in (None, ''):
          #if the object exist:
1051
            conduit.deleteNode(xml=data_subnode, object=destination, 
1052 1053 1054 1055 1056 1057 1058
                object_id=subscriber.getObjectFromGid(object_id).getId())
            subscriber.delSignature(gid)
          xml_confirmation += self.SyncMLConfirmation(
              cmd_id=cmd_id, 
              cmd='Delete',
              sync_code=status_code,
              remote_xml=action)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1059 1060 1061 1062
      else: # We want to retrieve more data
        signature.setStatus(self.PARTIAL)
        #LOG('SyncModif',0,'setPartialXML: %s' % str(previous_partial))
        previous_partial = signature.getPartialXML() or ''
1063 1064
        #if previous_partial.find(partial_data)<0: # XXX bad thing
        previous_partial += partial_data
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1065
        signature.setPartialXML(previous_partial)
1066
        #LOG('SyncModif',0,'previous_partial: %s' % str(previous_partial))
Nicolas Delaby's avatar
Nicolas Delaby committed
1067
        #LOG('SyncModif',0,'waiting more data for :%s' % signature.getId())
1068 1069 1070 1071 1072 1073 1074
        #xml_confirmation += self.SyncMLConfirmation(cmd_id, object_gid, 
        #    self.WAITING_DATA, action.nodeName)
        xml_confirmation += self.SyncMLConfirmation(\
            cmd_id=cmd_id, 
            cmd=action.nodeName, 
            sync_code=self.WAITING_DATA,
            remote_xml=action)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1075 1076 1077
      if conflict_list != [] and signature is not None:
        # We had a conflict
        signature.setStatus(self.CONFLICT)
1078

1079 1080 1081 1082 1083 1084 1085
    return (xml_confirmation,has_next_action,cmd_id)

  def applyStatusList(self, subscriber=None,remote_xml=None):
    """
    This read a list of status list (ie syncml confirmations).
    This method have to change status codes on signatures
    """
1086
    status_list = self.getSyncBodyStatusList(remote_xml)
1087 1088
    has_status_list = 0
    destination_waiting_more_data = 0
1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122
    if status_list != []:
      for status in status_list:
        status_cmd = status['cmd']
        #if status_cmd in ('Delete'):
        #  object_gid = status['target']
        #else:
        object_gid = status['source']
        status_code = int(status['code'])
        if status_cmd in ('Add','Replace'):
          has_status_list = 1
          signature = subscriber.getSignatureFromGid(object_gid)
          if signature == None:
            signature = subscriber.getSignatureFromRid(object_gid)
          if status_code == self.CHUNK_OK:
            destination_waiting_more_data = 1
            signature.setStatus(self.PARTIAL)
          elif status_code == self.CONFLICT:
            signature.setStatus(self.CONFLICT)
          elif status_code == self.CONFLICT_MERGE:
            # We will have to apply the update, and we should not care 
            # about conflicts, so we have to force the update
            signature.setStatus(self.NOT_SYNCHRONIZED)
            signature.setForce(1)
          elif status_code == self.CONFLICT_CLIENT_WIN:
            # The server was agree to apply our updates, nothing to do
            signature.setStatus(self.SYNCHRONIZED)
          elif status_code in (self.SUCCESS, self.ITEM_ADDED):
            signature.setStatus(self.SYNCHRONIZED)
        elif status_cmd == 'Delete':
          if status_code == self.SUCCESS:
            signature = subscriber.getSignatureFromGid(object_gid)
            if signature == None:
              signature = subscriber.getSignatureFromRid(object_gid)
            subscriber.delSignature(signature.getGid())
1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140
    return (destination_waiting_more_data, has_status_list)


class XMLSyncUtils(XMLSyncUtilsMixin):

  def Sync(self, id, msg=None, RESPONSE=None):
    """
    This is the main method for synchronization
    """
    pass

  def SyncInit(self, domain):
    """
    Initialization of a synchronization, this is
    used for the first message of every synchronization
    """
    pass

1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159
  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

1160 1161 1162 1163 1164 1165 1166 1167 1168
  def SyncModif(self, domain, remote_xml):
    """
    Modification Message, this is used after the first
    message in order to send modifications.
    """
    """
      Send the server modification, this happens after the Synchronization
      initialization
    """
1169
    has_response = 0 #check if syncmodif replies to this messages
1170
    cmd_id = 1 # specifies a SyncML message-unique command identifier
Nicolas Delaby's avatar
Nicolas Delaby committed
1171
    #LOG('SyncModif',0,'Starting... domain: %s' % str(domain))
1172

Sebastien Robin's avatar
Sebastien Robin committed
1173
    first_node = remote_xml.childNodes[0]
1174 1175 1176
    # Get informations from the header
    xml_header = first_node.childNodes[1]
    if xml_header.nodeName != "SyncHdr":
Nicolas Delaby's avatar
Nicolas Delaby committed
1177
      #LOG('PubSyncModif',0,'This is not a SyncML Header')
Sebastien Robin's avatar
Sebastien Robin committed
1178
      raise ValueError, "Sorry, This is not a SyncML Header"
1179 1180

    subscriber = domain # If we are the client, this is fine
1181
    simulate = 0 # used by applyActionList, should be 0 for client
1182
    if domain.domain_type == self.PUB:
1183
      simulate = 1
1184 1185
      subscription_url = self.getSourceURI(xml_header) 
      subscriber = domain.getSubscriber(subscription_url)
1186

1187 1188
    # We have to check if this message was not already, this can be dangerous
    # to update two times the same object
Sebastien Robin's avatar
Sebastien Robin committed
1189 1190 1191
    message_id = self.getMessageId(remote_xml)
    correct_message = subscriber.checkCorrectRemoteMessageId(message_id)
    if not correct_message: # We need to send again the message
Nicolas Delaby's avatar
Nicolas Delaby committed
1192
      #LOG('SyncModif, no correct message:',0,"sending again...")
1193
      last_xml = subscriber.getLastSentMessage()
Nicolas Delaby's avatar
Nicolas Delaby committed
1194
      #LOG("last_xml :", 0, last_xml)
1195 1196 1197
      if last_xml != '':
        has_response = 1
        if domain.domain_type == self.PUB: # We always reply
1198 1199 1200
          self.sendResponse(from_url=domain.publication_url, 
              to_url=subscriber.subscription_url, sync_id=domain.getTitle(), 
              xml=last_xml,domain=domain)
1201
        elif domain.domain_type == self.SUB:
1202
          self.sendResponse(from_url=domain.subscription_url, 
1203 1204
              to_url=domain.publication_url, sync_id=domain.getTitle(), 
              xml=last_xml, domain=domain)
1205 1206 1207
      return {'has_response':has_response,'xml':last_xml}
    subscriber.setLastSentMessage('')

1208 1209 1210 1211 1212 1213
    # First apply the list of status codes
    (destination_waiting_more_data,has_status_list) = self.applyStatusList(
                                         subscriber=subscriber,
                                         remote_xml=remote_xml)

    alert_code = self.getAlertCode(remote_xml)
Kevin Deldycke's avatar
Kevin Deldycke committed
1214
    # Import the conduit and get it
1215
    conduit = self.getConduitByName(subscriber.getConduit())
1216
    # Then apply the list of actions
1217 1218 1219 1220 1221 1222
    (xml_confirmation, has_next_action, cmd_id) = self.applyActionList(
                                      cmd_id=cmd_id,
                                      domain=domain,
                                      subscriber=subscriber,
                                      remote_xml=remote_xml,
                                      conduit=conduit, simulate=simulate)
1223
    #LOG('SyncModif, has_next_action:',0,has_next_action)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1224

Sebastien Robin's avatar
Sebastien Robin committed
1225 1226 1227
    xml_list = []
    xml = xml_list.append
    xml('<SyncML>\n')
1228

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1229 1230
    # syncml header
    if domain.domain_type == self.PUB:
1231 1232 1233
      xml(self.SyncMLHeader(subscriber.getSessionId(), 
        subscriber.incrementMessageId(), subscriber.getSubscriptionUrl(), 
        domain.getPublicationUrl()))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1234
    elif domain.domain_type == self.SUB:
Sebastien Robin's avatar
Sebastien Robin committed
1235 1236
      xml(self.SyncMLHeader(domain.getSessionId(), domain.incrementMessageId(),
        domain.getPublicationUrl(), domain.getSubscriptionUrl()))
1237
    
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1238 1239 1240 1241
    # Add or replace objects
    syncml_data = ''

    # syncml body
Sebastien Robin's avatar
Sebastien Robin committed
1242
    xml(' <SyncBody>\n')
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 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290

    # status for SyncHdr
    message_id = self.getMessageId(remote_xml)
    xml('  <Status>\n')
    xml('   <CmdID>%s</CmdID>\n' % cmd_id)
    cmd_id += 1
    xml('   <MsgRef>%s</MsgRef>\n' % message_id)
    xml('   <CmdRef>0</CmdRef>\n') #to make reference to the SyncHdr, it's 0
    xml('   <Cmd>SyncHdr</Cmd>\n')
    xml('   <TargetRef>%s</TargetRef>\n' \
      % remote_xml.xpath('string(//SyncHdr/Target/LocURI)').encode('utf-8'))
    xml('   <SourceRef>%s</SourceRef>\n' \
      % remote_xml.xpath('string(//SyncHdr/Source/LocURI)').encode('utf-8'))
    xml('   <Data>200</Data>\n')
    xml('  </Status>\n')

    #list of element in the SyncBody bloc
    syncbody_element_list = remote_xml.xpath('//SyncBody/*')
    
    #add the status bloc corresponding to the receive command
    for syncbody_element in syncbody_element_list:
      if str(syncbody_element.nodeName) not in ('Status', 'Final', 'Replace'):
        xml('  <Status>\n')
        xml('   <CmdID>%s</CmdID>\n' % cmd_id)
        cmd_id += 1
        xml('   <MsgRef>%s</MsgRef>\n' % message_id)
        xml('   <CmdRef>%s</CmdRef>\n' \
            % syncbody_element.xpath('string(.//CmdID)').encode('utf-8'))
        xml('   <Cmd>%s</Cmd>\n' % syncbody_element.nodeName.encode('utf-8'))

        target_ref = syncbody_element.xpath('string(.//Target/LocURI)').encode('utf-8')
        if target_ref not in (None, ''):
          xml('   <TargetRef>%s</TargetRef>\n' % target_ref )
        source_ref = syncbody_element.xpath('string(.//Source/LocURI)').encode('utf-8')
        if source_ref not in (None, ''):
          xml('   <SourceRef>%s</SourceRef>\n' % source_ref )

        #xml('   <Data>%s</Data>\n' % subscriber.getSynchronizationType())
        if syncbody_element.nodeName.encode('utf-8') == 'Add':
          xml('   <Data>%s</Data>\n' % '201')
        else:
          xml('   <Data>%s</Data>\n' % '200')

       # if syncbody_element.xpath('.//Item') not in ([], None, '') and\
       #     syncbody_element.xpath('.//Item.....'): #contient une ancre Next...

        xml('   <Item>\n')
        xml('    <Data>\n')
1291
        xml('     <Anchor xmlns="syncml:metinf">\n')
1292 1293 1294 1295 1296 1297 1298
        xml('      <Next>%s</Next>\n' % subscriber.getNextAnchor())
        xml('     </Anchor>\n')
        xml('    </Data>\n')
        xml('   </Item>\n')

        xml('  </Status>\n')

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1299 1300 1301
    destination_url = ''
    # alert message if we want more data
    if destination_waiting_more_data == 1:
Sebastien Robin's avatar
Sebastien Robin committed
1302
      xml(self.SyncMLAlert(cmd_id, self.WAITING_DATA,
1303 1304
                              subscriber.getTargetURI(),
                              subscriber.getSourceURI(),
1305
                              subscriber.getLastAnchor(),
Sebastien Robin's avatar
Sebastien Robin committed
1306
                              subscriber.getNextAnchor()))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1307
    # Now we should send confirmations
1308
    cmd_id_before_getsyncmldata = cmd_id
1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329
    cmd_id = cmd_id+1
    if getattr(domain, 'getActivityEnabled', None) and domain.getActivityEnabled():
      #use activities to get SyncML data.
      if not (isinstance(remote_xml, str) or isinstance(remote_xml, unicode)):
        string_io = StringIO()
        PrettyPrint(remote_xml,stream=string_io)
        remote_xml = string_io.getvalue()
      self.activate().SyncModifActivity(
                      domain_relative_url = domain.getRelativeUrl(),
                      remote_xml = remote_xml,
                      subscriber_relative_url = subscriber.getRelativeUrl(),
                      cmd_id = cmd_id,
                      xml_confirmation = xml_confirmation,
                      syncml_data = '',
                      cmd_id_before_getsyncmldata = cmd_id_before_getsyncmldata,
                      xml_list = xml_list,
                      has_status_list = has_status_list,
                      has_response = has_response )
      return {'has_response':1}
    else:
      result = self.getSyncMLData(domain=domain,
1330 1331
                             remote_xml=remote_xml,
                             subscriber=subscriber,
1332
                             cmd_id=cmd_id,xml_confirmation=xml_confirmation,
1333
                             conduit=conduit)
1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366
      syncml_data = result['syncml_data']
      xml_confirmation = result['xml_confirmation']
      cmd_id = result['cmd_id']
      return self.sendSyncModif(syncml_data, cmd_id_before_getsyncmldata,
                                subscriber, domain, xml_confirmation,
                                remote_xml, xml_list, has_status_list, has_response)

  def SyncModifActivity(self, **kw):
    domain = self.unrestrictedTraverse(kw['domain_relative_url'])
    subscriber = self.unrestrictedTraverse(kw['subscriber_relative_url'])
    conduit = subscriber.getConduit()
    result = self.getSyncMLData(domain = domain, subscriber = subscriber,
                           conduit = conduit, max = 100, **kw)
    syncml_data = result['syncml_data']
    finished = result['finished']
    if not finished:
      self.activate().SyncModifActivity(**kw)
    else:
      xml_confirmation = result['xml_confirmation']
      cmd_id = result['cmd_id']
      cmd_id_before_getsyncmldata = kw['cmd_id_before_getsyncmldata']
      remote_xml = Parse(kw['remote_xml'])
      xml_list = kw['xml_list']
      has_status_list = kw['has_status_list']
      has_response = kw['has_response']
      return self.sendSyncModif(syncml_data, cmd_id_before_getsyncmldata,
                              subscriber, domain, xml_confirmation,
                              remote_xml, xml_list, has_status_list, has_response)

  def sendSyncModif(self, syncml_data, cmd_id_before_getsyncmldata, subscriber,
                    domain, xml_confirmation, remote_xml, xml_list,
                    has_status_list, has_response):
    xml = xml_list.append
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1367
    if syncml_data != '':
Sebastien Robin's avatar
Sebastien Robin committed
1368
      xml('  <Sync>\n')
1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387
      xml('   <CmdID>%s</CmdID>\n' % cmd_id_before_getsyncmldata)
      if domain.domain_type == self.SUB:
        if subscriber.getTargetURI() not in ('', None):
          xml('   <Target>\n')
          xml('    <LocURI>%s</LocURI>\n' % subscriber.getTargetURI())
          xml('   </Target>\n')
        if subscriber.getSourceURI() not in ('', None):
          xml('   <Source>\n')
          xml('    <LocURI>%s</LocURI>\n' % subscriber.getSourceURI())
          xml('   </Source>\n')
      elif domain.domain_type == self.PUB:
        if domain.getTargetURI() not in ('', None):
          xml('   <Target>\n')
          xml('    <LocURI>%s</LocURI>\n' % domain.getTargetURI())
          xml('   </Target>\n')
        if domain.getSourceURI() not in ('', None):
          xml('   <Source>\n')
          xml('    <LocURI>%s</LocURI>\n' % domain.getSourceURI())
          xml('   </Source>\n')
Sebastien Robin's avatar
Sebastien Robin committed
1388 1389
      xml(syncml_data)
      xml('  </Sync>\n')
1390
    xml(xml_confirmation)
Sebastien Robin's avatar
Sebastien Robin committed
1391 1392 1393 1394
    xml('  <Final/>\n')
    xml(' </SyncBody>\n')
    xml('</SyncML>\n')
    xml_a = ''.join(xml_list)
1395

1396
    if domain.domain_type == self.PUB: # We always reply
Sebastien Robin's avatar
Sebastien Robin committed
1397 1398 1399 1400
      subscriber.setLastSentMessage(xml_a)
      self.sendResponse(from_url=domain.publication_url, 
          to_url=subscriber.subscription_url, sync_id=domain.getTitle(), 
          xml=xml_a,domain=domain)
1401 1402 1403
      has_response = 1
    elif domain.domain_type == self.SUB:
      if self.checkAlert(remote_xml) or \
1404
          (xml_confirmation,syncml_data)!=('','') or \
1405
          has_status_list:
Sebastien Robin's avatar
Sebastien Robin committed
1406 1407 1408 1409
        subscriber.setLastSentMessage(xml_a)
        self.sendResponse(from_url=domain.subscription_url, 
            to_url=domain.publication_url, sync_id=domain.getTitle(), 
            xml=xml_a,domain=domain)
1410
        has_response = 1
Sebastien Robin's avatar
Sebastien Robin committed
1411
    return {'has_response':has_response,'xml':xml_a}