PublicationSynchronization.py 8.97 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) 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
from Subscription import Signature
32
from XMLSyncUtils import Parse
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
Jean-Paul Smets's avatar
Jean-Paul Smets committed
43 44

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

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

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

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

      xml_list = []
      xml = xml_list.append
      cmd_id = 1 # specifies a SyncML message-unique command identifier      
      xml('<SyncML>\n')
      # syncml header
      xml(self.SyncMLHeader(subscriber.getSessionId(),
86 87
        subscriber.getMessageId(),
        subscriber.getSubscriptionUrl(),
88 89 90 91 92
        publication.getPublicationUrl()))
      # syncml body
      xml(' <SyncBody>\n')


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

        # 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,
              cmd_id, next_anchor, subscription=subscriber).values()
          xml(xml_status)
          # alert message
          xml(self.SyncMLAlert(cmd_id, sync_type, subscriber.getTargetURI(),
            subscriber.getSourceURI(), subscriber.getLastAnchor(),
            next_anchor))
          cmd_id += 1
        else:
          # chal message
172 173 174
          xml(self.SyncMLChal(cmd_id, "SyncHdr",
            publication.getPublicationUrl(), subscriber.getSubscriptionUrl(),
            publication.getAuthenticationFormat(),
175
            publication.getAuthenticationType(), auth_code))
176
          cmd_id += 1
177 178 179
          xml_status, cmd_id = self.SyncMLStatus(xml_client,
              self.AUTH_REQUIRED, cmd_id, next_anchor,
              subscription=subscriber).values()
180
          xml(xml_status)
181

Jean-Paul Smets's avatar
Jean-Paul Smets committed
182 183 184
      # We have to set every object as NOT_SYNCHRONIZED
      subscriber.startSynchronization()
    else:
185 186 187 188 189
      # 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
190
      # a server !
Jean-Paul Smets's avatar
Jean-Paul Smets committed
191

192 193 194 195 196 197 198
    xml('  <Final/>\n')
    xml(' </SyncBody>\n')
    xml('</SyncML>\n')
    xml_a = ''.join(xml_list)
    if publication.getSyncContentType() == self.CONTENT_TYPE['SYNCML_WBXML']:
      xml_a = self.xml2wbxml(xml_a)
    self.sendResponse(from_url=publication.getPublicationUrl(),
199 200
      to_url=subscriber.getSubscriptionUrl(), sync_id=publication.getTitle(),
      xml=xml_a, domain=publication,
201
      content_type=publication.getSyncContentType())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
202

203
    return {'has_response':1, 'xml':xml_a}
Jean-Paul Smets's avatar
Jean-Paul Smets committed
204 205 206 207 208

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