PublicationSynchronization.py 9.89 KB
Newer Older
1
# -*- coding: utf-8 -*-
Jean-Paul Smets's avatar
Jean-Paul Smets committed
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) 2003 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 # to send emails
from Publication import Publication,Subscriber
32
from Signature import Signature
Jean-Paul Smets's avatar
Jean-Paul Smets committed
33 34
from XMLSyncUtils import XMLSyncUtils
from Conduit.ERP5Conduit import ERP5Conduit
35
from Products.CMFCore.utils import getToolByName
36 37 38 39
from Products.ERP5Security.ERP5UserManager import ERP5UserManager
from Products.PluggableAuthService.interfaces.plugins import\
    IAuthenticationPlugin
from AccessControl.SecurityManagement import newSecurityManager
Jean-Paul Smets's avatar
Jean-Paul Smets committed
40
import commands
41
from DateTime import DateTime
42
from zLOG import LOG, DEBUG, INFO, WARNING
Nicolas Delaby's avatar
Nicolas Delaby committed
43
from lxml import etree
44 45 46 47
from lxml.builder import ElementMaker
from SyncCode import SYNCML_NAMESPACE
nsmap = {'syncml' : SYNCML_NAMESPACE}
E = ElementMaker(namespace=SYNCML_NAMESPACE, nsmap=nsmap)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
48 49

class PublicationSynchronization(XMLSyncUtils):
50
  """
51
    Receive the first XML message from the client
52
  """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
53

54
  def PubSyncInit(self, publication=None, xml_client=None, subscriber=None,
55
      sync_type=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
56 57 58 59
    """
      Read the client xml message
      Send the first XML message from the server
    """
60
    LOG('PubSyncInit', INFO, 'Starting... publication: %s' % (publication.getPath()))
Sebastien Robin's avatar
Sebastien Robin committed
61
    #the session id is set at the same value of those of the client
62
    subscriber.setSessionId(self.getSessionIdFromXml(xml_client))
63
    #same for the message id
64
    subscriber.setMessageId(self.getMessageIdFromXml(xml_client))     
65 66
    #at the begining of the synchronization the subscriber is not authenticated
    subscriber.setAuthenticated(False)
Sebastien Robin's avatar
Sebastien Robin committed
67 68 69
    #the last_message_id is 1 because the message that 
    #we are about to send is the message 1      
    subscriber.initLastMessageId(1)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
70 71 72 73 74 75 76

    alert = None
    # Get informations from the body
    if xml_client is not None: # We have received a message
      last_anchor = self.getAlertLastAnchor(xml_client)
      next_anchor = self.getAlertNextAnchor(xml_client)
      alert = self.checkAlert(xml_client)
77
      alert_code = self.getAlertCodeFromXML(xml_client)
Sebastien Robin's avatar
Sebastien Robin committed
78
      cred = self.checkCred(xml_client)
79 80 81 82 83 84

      #the source and the target of the subscriber are reversed compared 
      # to those of the publication :
      subscriber.setSourceURI(self.getTargetURI(xml_client))
      subscriber.setTargetURI(self.getSourceURI(xml_client))

85
      cmd_id = 1 # specifies a SyncML message-unique command identifier
86
      #create element 'SyncML' with a default namespace
87
      xml = E.SyncML()
88
      # syncml header
Nicolas Delaby's avatar
Nicolas Delaby committed
89
      xml.append(self.SyncMLHeader(subscriber.getSessionId(),
90 91
        subscriber.getMessageId(),
        subscriber.getSubscriptionUrl(),
92 93
        publication.getPublicationUrl()))
      # syncml body
94 95
      sync_body = E.SyncBody()
      xml.append(sync_body)
96

97
      #at the begining, the code is initialised at UNAUTHORIZED
98
      auth_code = self.UNAUTHORIZED
99
      if not cred:
100
        auth_code = self.AUTH_REQUIRED
101
        # LOG("PubSyncInit there's no credential !!!", INFO,'')
102
        # Prepare the xml message for the Sync initialization package
Nicolas Delaby's avatar
Nicolas Delaby committed
103
        sync_body.append(self.SyncMLChal(cmd_id, "SyncHdr",
104 105 106 107 108
          publication.getPublicationUrl(), subscriber.getSubscriptionUrl(),
          publication.getAuthenticationFormat(),
          publication.getAuthenticationType(), auth_code))
        cmd_id += 1
        # chal message
109 110 111 112 113
        xml_status, cmd_id = self.SyncMLStatus(
                                      xml_client,
                                      auth_code,
                                      cmd_id,
                                      next_anchor,
Nicolas Delaby's avatar
Nicolas Delaby committed
114 115
                                      subscription=subscriber)
        sync_body.extend(xml_status)
116
      else:
117 118 119 120 121 122 123 124 125 126
        # If slow sync, then resend everything
        if alert_code == self.SLOW_SYNC and \
          subscriber.getNextAnchor() != self.NULL_ANCHOR:
          LOG('Warning !!!, reseting client synchronization for subscriber:', WARNING,
              subscriber.getPath())
          subscriber.resetAllSignatures()
          subscriber.resetAnchors()
  
        # Check if the last time synchronization is the same as the client one
        if subscriber.getNextAnchor() != last_anchor:
Nicolas Delaby's avatar
Nicolas Delaby committed
127
          if not last_anchor:
128 129 130 131 132 133 134 135 136 137 138
            LOG('PubSyncInit', INFO, 'anchor null')
          else:
            mess = '\nsubscriber.getNextAnchor:\t%s\nsubscriber.getLastAnchor:\t%s\
                  \nlast_anchor:\t\t\t%s\nnext_anchor:\t\t\t%s' % \
                  (subscriber.getNextAnchor(),
                    subscriber.getLastAnchor(),
                    last_anchor,
                    next_anchor)
            LOG('PubSyncInit Anchors', INFO, mess)
        else:
          subscriber.setNextAnchor(next_anchor)
139 140 141 142 143
        (authentication_format, authentication_type, data) = \
            self.getCred(xml_client)
        if authentication_type == publication.getAuthenticationType():
          authentication_format = publication.getAuthenticationFormat()
          decoded = subscriber.decode(authentication_format, data)
144
          if decoded and ':' in decoded:
145 146 147 148 149 150 151
            (login, password) = decoded.split(':')
            uf = self.getPortalObject().acl_users
            for plugin_name, plugin in uf._getOb('plugins').listPlugins(
                                      IAuthenticationPlugin ):
              if plugin.authenticateCredentials(
                        {'login':login, 'password':password}) is not None:
                subscriber.setAuthenticated(True)
152
                LOG("PubSyncInit Authentication Accepted", INFO, '')
153
                auth_code = self.AUTH_ACCEPTED
154 155 156
                #here we must log in with the user authenticated :
                user = uf.getUserById(login).__of__(uf)
                newSecurityManager(None, user)
157
                subscriber.setUser(login)
158 159
                break
              else:
160
                auth_code = self.UNAUTHORIZED
161
        
162
        #in all others cases, the auth_code is set to UNAUTHORIZED
163 164
            if auth_code == self.UNAUTHORIZED:
              LOG("PubSyncInit Authentication Failed !! with login :", INFO, login)
165 166 167 168

        # Prepare the xml message for the Sync initialization package
        if auth_code == self.AUTH_ACCEPTED:
          xml_status, cmd_id = self.SyncMLStatus(xml_client, auth_code,
Nicolas Delaby's avatar
Nicolas Delaby committed
169 170 171
                                                 cmd_id, next_anchor,
                                                 subscription=subscriber)
          sync_body.extend(xml_status)
172
          # alert message
Nicolas Delaby's avatar
Nicolas Delaby committed
173 174 175 176 177
          sync_body.append(self.SyncMLAlert(cmd_id, sync_type,
                                            subscriber.getTargetURI(),
                                            subscriber.getSourceURI(),
                                            subscriber.getLastAnchor(),
                                            next_anchor))
178 179 180
          cmd_id += 1
        else:
          # chal message
Nicolas Delaby's avatar
Nicolas Delaby committed
181 182 183 184 185 186
          sync_body.append(self.SyncMLChal(cmd_id, "SyncHdr",
                                           publication.getPublicationUrl(),
                                           subscriber.getSubscriptionUrl(),
                                           publication.getAuthenticationFormat(),
                                           publication.getAuthenticationType(),
                                           auth_code))
187
          cmd_id += 1
188
          xml_status, cmd_id = self.SyncMLStatus(xml_client,
Nicolas Delaby's avatar
Nicolas Delaby committed
189 190 191 192
                                                 self.AUTH_REQUIRED, cmd_id,
                                                 next_anchor,
                                                 subscription=subscriber)
          sync_body.extend(xml_status)
193

Jean-Paul Smets's avatar
Jean-Paul Smets committed
194 195 196
      # We have to set every object as NOT_SYNCHRONIZED
      subscriber.startSynchronization()
    else:
197 198 199 200 201
      # We have started the sync from the server (may be for a conflict 
      # resolution)
      raise ValueError, "the syncml message is None. Maybe a synchronisation \
          has been started from the server (forbiden)"
      # a synchronisation is always starded from a client and can't be from
202
      # a server !
203
    sync_body.append(E.Final())
Nicolas Delaby's avatar
Nicolas Delaby committed
204
    xml_string = etree.tostring(xml, encoding='utf-8', pretty_print=True)
205
    if publication.getSyncContentType() == self.CONTENT_TYPE['SYNCML_WBXML']:
Nicolas Delaby's avatar
Nicolas Delaby committed
206
      xml_string = self.xml2wbxml(xml_string)
207
    self.sendResponse(from_url=publication.getPublicationUrl(),
Nicolas Delaby's avatar
Nicolas Delaby committed
208 209 210 211
                      to_url=subscriber.getSubscriptionUrl(),
                      sync_id=publication.getTitle(),
                      xml=xml_string, domain=publication,
                      content_type=publication.getSyncContentType())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
212

Nicolas Delaby's avatar
Nicolas Delaby committed
213
    return {'has_response':1, 'xml':xml_string}
Jean-Paul Smets's avatar
Jean-Paul Smets committed
214 215 216 217 218

  def PubSyncModif(self, publication, xml_client):
    """
    The modidification message for the publication
    """
219
    return self.SyncModif(publication, xml_client)