PublicationSynchronization.py 9.8 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
##############################################################################
#
# 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
31
from Signature import Signature
Jean-Paul Smets's avatar
Jean-Paul Smets committed
32 33
from XMLSyncUtils import XMLSyncUtils
from Conduit.ERP5Conduit import ERP5Conduit
34
from Products.CMFCore.utils import getToolByName
35 36 37 38
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
39
import commands
40
from DateTime import DateTime
41
from zLOG import LOG, DEBUG, INFO, WARNING
Nicolas Delaby's avatar
Nicolas Delaby committed
42 43
from lxml.etree import Element, SubElement
from lxml import etree
Jean-Paul Smets's avatar
Jean-Paul Smets committed
44 45

class PublicationSynchronization(XMLSyncUtils):
46
  """
47
    Receive the first XML message from the client
48
  """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
49

50
  def PubSyncInit(self, publication=None, xml_client=None, subscriber=None,
51
      sync_type=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
52 53 54 55
    """
      Read the client xml message
      Send the first XML message from the server
    """
56
    LOG('PubSyncInit', INFO, 'Starting... publication: %s' % (publication.getPath()))
Sebastien Robin's avatar
Sebastien Robin committed
57
    #the session id is set at the same value of those of the client
58
    subscriber.setSessionId(self.getSessionIdFromXml(xml_client))
59
    #same for the message id
60
    subscriber.setMessageId(self.getMessageIdFromXml(xml_client))     
61 62
    #at the begining of the synchronization the subscriber is not authenticated
    subscriber.setAuthenticated(False)
Sebastien Robin's avatar
Sebastien Robin committed
63 64 65
    #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
66 67 68 69 70 71 72

    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)
73
      alert_code = self.getAlertCodeFromXML(xml_client)
Sebastien Robin's avatar
Sebastien Robin committed
74
      cred = self.checkCred(xml_client)
75 76 77 78 79 80 81

      #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))

      cmd_id = 1 # specifies a SyncML message-unique command identifier      
82 83 84 85
     
      #create element 'SyncML' with a default namespace
      nsmap = {None : self.XHTML_NAMESPACE}
      xml = Element('SyncML',nsmap=nsmap)
86
      # syncml header
Nicolas Delaby's avatar
Nicolas Delaby committed
87
      xml.append(self.SyncMLHeader(subscriber.getSessionId(),
88 89
        subscriber.getMessageId(),
        subscriber.getSubscriptionUrl(),
90 91
        publication.getPublicationUrl()))
      # syncml body
Nicolas Delaby's avatar
Nicolas Delaby committed
92
      sync_body = SubElement(xml, 'SyncBody')
93

94
      #at the begining, the code is initialised at UNAUTHORIZED
95
      auth_code = self.UNAUTHORIZED
96
      if not cred:
97
        auth_code = self.AUTH_REQUIRED
98
        # LOG("PubSyncInit there's no credential !!!", INFO,'')
99
        # Prepare the xml message for the Sync initialization package
Nicolas Delaby's avatar
Nicolas Delaby committed
100
        sync_body.append(self.SyncMLChal(cmd_id, "SyncHdr",
101 102 103 104 105
          publication.getPublicationUrl(), subscriber.getSubscriptionUrl(),
          publication.getAuthenticationFormat(),
          publication.getAuthenticationType(), auth_code))
        cmd_id += 1
        # chal message
106 107 108 109 110
        xml_status, cmd_id = self.SyncMLStatus(
                                      xml_client,
                                      auth_code,
                                      cmd_id,
                                      next_anchor,
Nicolas Delaby's avatar
Nicolas Delaby committed
111 112
                                      subscription=subscriber)
        sync_body.extend(xml_status)
113
      else:
114 115 116 117 118 119 120 121 122 123
        # 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
124
          if not last_anchor:
125 126 127 128 129 130 131 132 133 134 135
            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)
136 137 138 139 140
        (authentication_format, authentication_type, data) = \
            self.getCred(xml_client)
        if authentication_type == publication.getAuthenticationType():
          authentication_format = publication.getAuthenticationFormat()
          decoded = subscriber.decode(authentication_format, data)
141
          if decoded and ':' in decoded:
142 143 144 145 146 147 148
            (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)
149
                LOG("PubSyncInit Authentication Accepted", INFO, '')
150
                auth_code = self.AUTH_ACCEPTED
151 152 153
                #here we must log in with the user authenticated :
                user = uf.getUserById(login).__of__(uf)
                newSecurityManager(None, user)
154
                subscriber.setUser(login)
155 156
                break
              else:
157
                auth_code = self.UNAUTHORIZED
158
        
159
        #in all others cases, the auth_code is set to UNAUTHORIZED
160 161
            if auth_code == self.UNAUTHORIZED:
              LOG("PubSyncInit Authentication Failed !! with login :", INFO, login)
162 163 164 165

        # 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
166 167 168
                                                 cmd_id, next_anchor,
                                                 subscription=subscriber)
          sync_body.extend(xml_status)
169
          # alert message
Nicolas Delaby's avatar
Nicolas Delaby committed
170 171 172 173 174
          sync_body.append(self.SyncMLAlert(cmd_id, sync_type,
                                            subscriber.getTargetURI(),
                                            subscriber.getSourceURI(),
                                            subscriber.getLastAnchor(),
                                            next_anchor))
175 176 177
          cmd_id += 1
        else:
          # chal message
Nicolas Delaby's avatar
Nicolas Delaby committed
178 179 180 181 182 183
          sync_body.append(self.SyncMLChal(cmd_id, "SyncHdr",
                                           publication.getPublicationUrl(),
                                           subscriber.getSubscriptionUrl(),
                                           publication.getAuthenticationFormat(),
                                           publication.getAuthenticationType(),
                                           auth_code))
184
          cmd_id += 1
185
          xml_status, cmd_id = self.SyncMLStatus(xml_client,
Nicolas Delaby's avatar
Nicolas Delaby committed
186 187 188 189
                                                 self.AUTH_REQUIRED, cmd_id,
                                                 next_anchor,
                                                 subscription=subscriber)
          sync_body.extend(xml_status)
190

Jean-Paul Smets's avatar
Jean-Paul Smets committed
191 192 193
      # We have to set every object as NOT_SYNCHRONIZED
      subscriber.startSynchronization()
    else:
194 195 196 197 198
      # 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
199
      # a server !
Nicolas Delaby's avatar
Nicolas Delaby committed
200 201
    sync_body.append(Element('Final'))
    xml_string = etree.tostring(xml, encoding='utf-8', pretty_print=True)
202
    if publication.getSyncContentType() == self.CONTENT_TYPE['SYNCML_WBXML']:
Nicolas Delaby's avatar
Nicolas Delaby committed
203
      xml_string = self.xml2wbxml(xml_string)
204
    self.sendResponse(from_url=publication.getPublicationUrl(),
Nicolas Delaby's avatar
Nicolas Delaby committed
205 206 207 208
                      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
209

Nicolas Delaby's avatar
Nicolas Delaby committed
210
    return {'has_response':1, 'xml':xml_string}
Jean-Paul Smets's avatar
Jean-Paul Smets committed
211 212 213 214 215

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