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

from Globals import Persistent, PersistentMapping
from SyncCode import SyncCode
from Subscription import Subscription
32
from Products.ERP5Type import Permissions
Jean-Paul Smets's avatar
Jean-Paul Smets committed
33
from Products.ERP5Type.Core.Folder import Folder
34 35
from AccessControl import ClassSecurityInfo
from Products.ERP5Type import PropertySheet
36
from zLOG import LOG
Jean-Paul Smets's avatar
Jean-Paul Smets committed
37

38 39 40 41 42 43 44 45 46 47
def addSubscriber( self, id, title='', REQUEST=None ):
    """
        Add a new Category and generate UID by calling the
        ZSQLCatalog
    """
    o = Subscriber( id ,'')
    self._setObject( id, o )
    if REQUEST is not None:
        return self.manage_main(self, REQUEST, update_menu=1)
    return o
Jean-Paul Smets's avatar
Jean-Paul Smets committed
48 49 50 51 52 53 54 55 56 57 58 59 60 61

class Subscriber(Subscription):
  """
    This is used to store a subscriber, with :

    subscribtion_url

    signatures -- a dictionnary which contains the signature
        of documents at the time they were synchronized.

    last_anchor - it defines the id of the last synchronisation

    next_anchor - it defines the id of the current synchronisation
  """
62
  def __init__(self, id, subscription_url):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
63 64 65 66 67 68 69
    """
      constructor
    """
    self.subscription_url = subscription_url
    self.last_anchor = '00000000T000000Z'
    self.next_anchor = '00000000T000000Z'
    self.session_id = 0
70
    Folder.__init__(self, id)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86

  def ReceiveDocuments(self):
    """
      We receive documents from a subsriber
      we add if document does not exist
      we update if the local signature did not change
      we keep as conflict to be solved by user if
      local signature changed (between 2 syncs)
    """

  def ConfirmReception(self):
    """
      ?????
      Send ACK for a group of documents
    """

87 88 89 90 91 92 93 94 95 96
  def getConduit(self):
    """
    Return the conduit of the publication
    """
    #LOG('Subscriber.getConduit, self.getPhysicalPath()',0,self.getPhysicalPath())
    #LOG('Subscriber.getConduit, self.getParent().getPhysicalPath()',0,self.aq_parent.getPhysicalPath())
    #LOG('Subscriber.getConduit, self.getParent()',0,self.getParent())
    return self.aq_parent.getConduit()
    #return self.conduit

Jean-Paul Smets's avatar
Jean-Paul Smets committed
97 98 99 100 101 102
  def SendDocuments(self):
    """
      We send all the updated documents (ie. documents not marked
      as conflicting)
    """

103 104 105 106 107 108 109 110 111 112
def addPublication( self, id, title='', REQUEST=None ):
    """
        Add a new Category and generate UID by calling the
        ZSQLCatalog
    """
    o = Publication( id ,'','','','','')
    self._setObject( id, o )
    if REQUEST is not None:
        return self.manage_main(self, REQUEST, update_menu=1)
    return o
Jean-Paul Smets's avatar
Jean-Paul Smets committed
113

114
class Publication(Subscription):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
  """
    Publication defined by

    publication_url

    destination_path - the place where objects are and will be stored

    query

    xml_mapping

    Contains:

    list_subscribers -- a list of subsbribtions
  """

131
  meta_type='ERP5 Publication'
132
  portal_type='SyncML Publication' # may be useful in the future...
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
  isPortalContent = 1
  isRADContent = 1
  icon = None

  # Declarative properties
  property_sheets = ( PropertySheet.Base
                    , PropertySheet.SimpleItem )

  allowed_types = ( 'Signatures',)

  # Declarative security
  security = ClassSecurityInfo()
  security.declareProtected(Permissions.ManagePortal,
                            'manage_editProperties',
                            'manage_changeProperties',
                            'manage_propertiesForm',
                              )

  # Declarative constructors
  constructors =   (addPublication,)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
153 154

  # Constructor
155
  def __init__(self, id, title, publication_url, destination_path, source_uri, 
156 157
      query, xml_mapping, conduit, gpg_key, id_generator, gid_generator, 
      media_type, auth_required=False, authentication_format='', 
158
      authentication_type=''):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
159 160 161 162 163 164
    """
      constructor
    """
    self.id = id
    self.publication_url = publication_url
    self.destination_path = destination_path
165
    self.setSourceURI(source_uri)
166
    self.setQuery(query)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
167
    self.xml_mapping = xml_mapping
168
    #self.list_subscribers = PersistentMapping()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
169
    self.domain_type = self.PUB
170
    self.gpg_key = gpg_key
171
    self.setGidGenerator(gid_generator)
172
    self.setMediaType(media_type)
173
    self.setSynchronizationIdGenerator(id_generator)
174
    self.setConduit(conduit)
175 176
    Folder.__init__(self, id)
    self.title = title
177 178 179
    self.auth_required = auth_required 
    self.authentication_format = authentication_format
    self.authentication_type = authentication_type
Jean-Paul Smets's avatar
Jean-Paul Smets committed
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199

  def getPublicationUrl(self):
    """
      return the publication url
    """
    return self.publication_url


  def getLocalUrl(self):
    """
      return the publication url
    """
    return self.publication_url

  def setPublicationUrl(self, publication_url):
    """
      return the publication url
    """
    self.publication_url = publication_url

200 201 202 203 204 205 206 207 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
  def isAuthenticationRequired(self):
    """
      return False if authentication not required, True else
    """
    return getattr(self, 'auth_required', False)

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

  def getAuthenticationFormat(self):
    """
      return the format of authentication
    """
    return getattr(self, 'authentication_format', '')

  def getAuthenticationType(self):
    """
      return the type of authentication
    """
    return getattr(self, 'authentication_type', '')

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

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

Jean-Paul Smets's avatar
Jean-Paul Smets committed
236 237 238 239 240 241
  def addSubscriber(self, subscriber):
    """
      Add a new subscriber to the publication
    """
    # We have to remove the subscriber if it already exist (there were probably a reset on the client)
    self.delSubscriber(subscriber.getSubscriptionUrl())
242 243 244
    new_id = subscriber.getId()
    if new_id is None:
      new_id = str(self.generateNewId())
245 246 247 248 249
    subscriber.id = new_id
    #if len(self.list_subscribers) == 0:
    #  self.list_subscribers = []
    #self.list_subscribers = self.list_subscribers + [subscriber]
    self._setObject(new_id,subscriber)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
250 251 252 253 254

  def getSubscriber(self, subscription_url):
    """
      return the subscriber corresponding the to subscription_url
    """
255 256 257
    for o in self.objectValues():
      if o.getSubscriptionUrl() == subscription_url:
        return o
Jean-Paul Smets's avatar
Jean-Paul Smets committed
258 259 260 261 262 263
    return None

  def getSubscriberList(self):
    """
      Get the list of subscribers
    """
264 265
    return self.objectValues()

Jean-Paul Smets's avatar
Jean-Paul Smets committed
266 267 268 269 270

  def delSubscriber(self, subscription_url):
    """
      Delete a subscriber for this publication
    """
271 272 273
    for o in self.objectValues():
      if o.getSubscriptionUrl() == subscription_url:
        self._delObject(o.id)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
274 275 276 277 278

  def resetAllSubscribers(self):
    """
      Reset all subscribers
    """
279 280
    for o in self.objectValues():
      self._delObject(o.id)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
281 282 283 284 285 286 287 288 289 290

  def getConflictList(self):
    """
      Return the list of conflicts from all subscribers
    """
    conflict_list = []
    for subscriber in self.getSubscriberList():
      conflict_list += subscriber.getConflictList()
    return conflict_list