IdTool.py 15.7 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
##############################################################################
#
# 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.
#
##############################################################################

29 30 31
import warnings
import zope.interface

32
from Acquisition import aq_base
Jean-Paul Smets's avatar
Jean-Paul Smets committed
33
from AccessControl import ClassSecurityInfo
34
from Products.ERP5Type.Globals import InitializeClass, DTMLFile, PersistentMapping
35
from Products.ERP5Type.Tool.BaseTool import BaseTool
36 37 38
from Products.ERP5Type.Cache import caching_instance_method
from Products.ERP5Type import Permissions, interfaces
from zLOG import LOG, WARNING, INFO, ERROR
Jean-Paul Smets's avatar
Jean-Paul Smets committed
39 40
from Products.ERP5 import _dtmldir

41
from BTrees.Length import Length
Jean-Paul Smets's avatar
Jean-Paul Smets committed
42

43 44
_marker = object()

45
class IdTool(BaseTool):
Vincent Pelletier's avatar
Vincent Pelletier committed
46 47 48
  """
    This tools handles the generation of IDs.
  """
49
  zope.interface.implements(interfaces.IIdTool)
Vincent Pelletier's avatar
Vincent Pelletier committed
50 51 52
  id = 'portal_ids'
  meta_type = 'ERP5 Id Tool'
  portal_type = 'Id Tool'
53
  title = 'Id Generators'
Vincent Pelletier's avatar
Vincent Pelletier committed
54 55 56 57 58 59

  # Declarative Security
  security = ClassSecurityInfo()

  security.declareProtected( Permissions.ManagePortal, 'manage_overview' )
  manage_overview = DTMLFile( 'explainIdTool', _dtmldir )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
60

61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
  def newContent(self, *args, **kw):
    """
      the newContent is overriden to not use generateNewId
    """
    if not kw.has_key(id):
      new_id = self._generateNextId()
      if new_id is not None:
        kw['id'] = new_id
      else:
        raise ValueError('Failed to gererate id')
    return BaseTool.newContent(self, *args, **kw)

  def _get_id(self, id):
    """
      _get_id is overrided to not use generateNewId
      It is used for example when an object is cloned
    """
    if self._getOb(id, None) is None :
      return id
    return self._generateNextId()

  @caching_instance_method(id='IdTool._getLatestIdGenerator',
    cache_factory='erp5_content_long')
  def _getLatestIdGenerator(self, reference):
    """
      Tries to find the id_generator with the latest version
      from the current object.
      Use the low-level to create a site without catalog
    """
    assert reference
    id_last_generator = None
    version_last_generator = 0
93
    for generator in self.objectValues():
94 95 96 97
      if generator.getReference() == reference:
        version = generator.getVersion()
        if version > version_last_generator:
          id_last_generator = generator.getId()
98
          version_last_generator = version
99
    if id_last_generator is None:
100
      raise KeyError(repr(reference))
101 102 103 104 105 106
    return id_last_generator

  def _getLatestGeneratorValue(self, id_generator):
    """
      Return the last generator with the reference
    """
107
    return self._getOb(self._getLatestIdGenerator(id_generator))
108 109 110 111

  security.declareProtected(Permissions.AccessContentsInformation,
                            'generateNewId')
  def generateNewId(self, id_group=None, default=None, method=_marker,
112
                    id_generator=None, poison=False):
113 114 115 116
    """
      Generate the next id in the sequence of ids of a particular group
    """
    if id_group in (None, 'None'):
117
      raise ValueError, '%s is not a valid id_group' % (repr(id_group), )
118 119 120
    # for compatibilty with sql data, must not use id_group as a list
    if not isinstance(id_group, str):
      id_group = repr(id_group)
121 122
      warnings.warn('id_group must be a string, other types '
                    'are deprecated.', DeprecationWarning)
123 124 125
    if id_generator is None:
      id_generator = 'document'
    if method is not _marker:
126
      warnings.warn("Use of 'method' argument is deprecated", DeprecationWarning)
127 128 129 130
    try:
      #use _getLatestGeneratorValue here for that the technical level
      #must not call the method
      last_generator = self._getLatestGeneratorValue(id_generator)
131 132 133 134 135
      new_id = last_generator.generateNewId(
        id_group=id_group,
        default=default,
        poison=poison,
      )
136 137
    except KeyError:
      # XXX backward compatiblity
138
      if self.getTypeInfo():
139 140 141 142 143
        LOG('generateNewId', ERROR, 'while generating id')
        raise
      else:
        # Compatibility code below, in case the last version of erp5_core
        # is not installed yet
144 145 146
        warnings.warn("You are using an old version of erp5_core to generate"
                      "ids.\nPlease update erp5_core business template to "
                      "use new id generators", DeprecationWarning)
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171
        dict_ids = getattr(aq_base(self), 'dict_ids', None)
        if dict_ids is None:
          dict_ids = self.dict_ids = PersistentMapping()
        new_id = None
        # Getting the last id
        if default is None:
          default = 0
        marker = []
        new_id = dict_ids.get(id_group, marker)
        if method is _marker:
          if new_id is marker:
            new_id = default
          else:
            new_id = new_id + 1
        else:
          if new_id is marker:
            new_id = default
          new_id = method(new_id)
        # Store the new value
        dict_ids[id_group] = new_id
    return new_id

  security.declareProtected(Permissions.AccessContentsInformation,
                            'generateNewIdList')
  def generateNewIdList(self, id_group=None, id_count=1, default=None,
172
                        store=_marker, id_generator=None, poison=False):
173 174 175 176
    """
      Generate a list of next ids in the sequence of ids of a particular group
    """
    if id_group in (None, 'None'):
177
      raise ValueError, '%s is not a valid id_group' % (repr(id_group), )
178 179 180
    # for compatibilty with sql data, must not use id_group as a list
    if not isinstance(id_group, str):
      id_group = repr(id_group)
181 182
      warnings.warn('id_group must be a string, other types '
                    'are deprecated.', DeprecationWarning)
183 184 185
    if id_generator is None:
      id_generator = 'uid'
    if store is not _marker:
186 187
      warnings.warn("Use of 'store' argument is deprecated.",
                    DeprecationWarning)
188 189 190 191 192
    try:
      #use _getLatestGeneratorValue here for that the technical level
      #must not call the method
      last_generator = self._getLatestGeneratorValue(id_generator)
      new_id_list = last_generator.generateNewIdList(id_group=id_group,
193
                         id_count=id_count, default=default, poison=poison)
194
    except (KeyError, ValueError):
195
      # XXX backward compatiblity
196
      if self.getTypeInfo():
197 198 199 200 201
        LOG('generateNewIdList', ERROR, 'while generating id')
        raise
      else:
        # Compatibility code below, in case the last version of erp5_core
        # is not installed yet
202 203 204
        warnings.warn("You are using an old version of erp5_core to generate"
                      "ids.\nPlease update erp5_core business template to "
                      "use new id generators", DeprecationWarning)
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 236 237
        new_id = None
        if default is None:
          default = 1
        # XXX It's temporary, a New API will be implemented soon
        #     the code will be change
        portal = self.getPortalObject()
        query = getattr(portal, 'IdTool_zGenerateId', None)
        commit = getattr(portal, 'IdTool_zCommit', None)

        if query is None or commit is None:
          portal_catalog = getattr(self, 'portal_catalog').getSQLCatalog()
          query = getattr(portal_catalog, 'z_portal_ids_generate_id')
          commit = getattr(portal_catalog, 'z_portal_ids_commit')
        if None in (query, commit):
          raise AttributeError, 'Error while generating Id: ' \
            'idTool_zGenerateId and/or idTool_zCommit could not ' \
            'be found.'
        try:
          result = query(id_group=id_group, id_count=id_count, default=default)
        finally:
          commit()
        new_id = result[0]['LAST_INSERT_ID()']
        if store:
          if getattr(aq_base(self), 'dict_length_ids', None) is None:
            # Length objects are stored in a persistent mapping: there is one
            # Length object per id_group.
            self.dict_length_ids = PersistentMapping()
          if self.dict_length_ids.get(id_group) is None:
            self.dict_length_ids[id_group] = Length(new_id)
          self.dict_length_ids[id_group].set(new_id)
        new_id_list = range(new_id - id_count, new_id)
    return new_id_list

238
  security.declareProtected(Permissions.ModifyPortalContent,
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256
                            'initializeGenerator')
  def initializeGenerator(self, id_generator=None, all=False):
    """
    Initialize generators. This is mostly used when a new ERP5 site
    is created. Some generators will need to do some initialization like
    creating SQL Database, prepare some data in ZODB, etc
    """
    if not all:
      #Use _getLatestGeneratorValue here for that the technical level
      #must not call the method
      last_generator = self._getLatestGeneratorValue(id_generator)
      last_generator.initializeGenerator()
    else:
      # recovery all the generators and initialize them
      for generator in self.objectValues(\
                       portal_type='Application Id Generator'):
        generator.initializeGenerator()

257
  security.declareProtected(Permissions.ModifyPortalContent,
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
                            'clearGenerator')
  def clearGenerator(self, id_generator=None, all=False):
    """
    Clear generators data. This can be usefull when working on a
    development instance or in some other rare cases. This will
    loose data and must be use with caution

    This can be incompatible with some particular generator implementation,
    in this case a particular error will be raised (to be determined and
    added here)
    """
    if not all:
      #Use _getLatestGeneratorValue here for that the technical level
      #must not call the method
      last_generator = self._getLatestGeneratorValue(id_generator)
      last_generator.clearGenerator()

    else:
      if len(self.objectValues()) == 0:
        # compatibility with old API
        self.getPortalObject().IdTool_zDropTable()
        self.getPortalObject().IdTool_zCreateTable()
      for generator in self.objectValues(\
                       portal_type='Application Id Generator'):
        generator.clearGenerator()

  ## XXX Old API deprecated
  #backward compatibility
286 287
  security.declareProtected(Permissions.AccessContentsInformation,
                           'generateNewLengthIdList')
288 289 290 291 292 293 294 295
  generateNewLengthIdList = generateNewIdList

  security.declareProtected(Permissions.AccessContentsInformation,
                            'getLastLengthGeneratedId')
  def getLastLengthGeneratedId(self, id_group, default=None):
    """
    Get the last length id generated
    """
296 297
    warnings.warn('getLastLengthGeneratedId is deprecated',
                   DeprecationWarning)
298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316
    # check in persistent mapping if exists
    if getattr(aq_base(self), 'dict_length_ids', None) is not None:
      last_id = self.dict_length_ids.get(id_group)
      if last_id is not None:
        return last_id.value - 1
    # otherwise check in mysql
    # XXX It's temporary, a New API will be implemented soon
    #     the code will be change
    portal = self.getPortalObject()
    query = getattr(portal, 'IdTool_zGetLastId', None)
    if query is None:
      portal_catalog = getattr(self, 'portal_catalog').getSQLCatalog()
      query = getattr(portal_catalog, 'z_portal_ids_get_last_id')
    if query is None:
      raise AttributeError, 'Error while getting last Id: ' \
            'IdTool_zGetLastId could not ' \
            'be found.'
    result = query(id_group=id_group)
    if len(result):
317 318 319 320
      try:
        return result[0]['last_id']
      except KeyError:
        return result[0]['LAST_INSERT_ID()']
321 322
    return default

323 324
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getLastGeneratedId')
325
  def getLastGeneratedId(self, id_group=None, default=None):
326 327 328
    """
    Get the last id generated
    """
329
    warnings.warn('getLastGeneratedId is deprecated', DeprecationWarning)
330
    if getattr(aq_base(self), 'dict_ids', None) is None:
331 332
      self.dict_ids = PersistentMapping()
    last_id = None
333
    if id_group is not None and id_group != 'None':
334 335
      last_id = self.dict_ids.get(id_group, default)
    return last_id
336

337
  security.declareProtected(Permissions.ModifyPortalContent,
338
                            'setLastGeneratedId')
339
  def setLastGeneratedId(self, new_id, id_group=None):
340 341 342 343
    """
    Set a new last id. This is usefull in order to reset
    a sequence of ids.
    """
344
    if getattr(aq_base(self), 'dict_ids', None) is None:
345
      self.dict_ids = PersistentMapping()
346
    if id_group is not None and id_group != 'None':
347
      self.dict_ids[id_group] = new_id
348

349 350
  security.declareProtected(Permissions.AccessContentsInformation,
                           'generateNewLengthId')
351
  def generateNewLengthId(self, id_group=None, default=None, store=_marker):
352
     """Generates an Id using a conflict free id generator. Deprecated.
353
     """
354 355 356
     warnings.warn('generateNewLengthId is deprecated.\n'
                   'Use generateNewIdList with a sql id_generator',
                   DeprecationWarning)
357 358 359 360 361
     if store is not _marker:
       return self.generateNewIdList(id_group=id_group,
                        id_count=1, default=default, store=store)[0]
     return self.generateNewIdList(id_group=id_group,
                        id_count=1, default=default)[0]
Jean-Paul Smets's avatar
Jean-Paul Smets committed
362

363
  security.declareProtected(Permissions.AccessContentsInformation,
364
                            'getDictLengthIdsItems')
365 366 367 368 369 370 371 372 373 374
  def getDictLengthIdsItems(self):
    """
      Return a copy of dict_length_ids.
      This is a workaround to access the persistent mapping content from ZSQL
      method to be able to insert initial tuples in the database at creation.
    """
    if getattr(self, 'dict_length_ids', None) is None:
      self.dict_length_ids = PersistentMapping()
    return self.dict_length_ids.items()

375 376 377 378 379
  security.declarePrivate('dumpDictLengthIdsItems')
  def dumpDictLengthIdsItems(self):
    """
      Store persistently data from SQL table portal_ids.
    """
380 381
    portal_catalog = getattr(self, 'portal_catalog').getSQLCatalog()
    query = getattr(portal_catalog, 'z_portal_ids_dump')
382
    dict_length_ids = getattr(aq_base(self), 'dict_length_ids', None)
383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400
    if dict_length_ids is None:
      dict_length_ids = self.dict_length_ids = PersistentMapping()
    for line in query().dictionaries():
      id_group = line['id_group']
      last_id = line['last_id']
      stored_last_id = self.dict_length_ids.get(id_group)
      if stored_last_id is None:
        self.dict_length_ids[id_group] = Length(last_id)
      else:
        stored_last_id_value = stored_last_id()
        if stored_last_id_value < last_id:
          stored_last_id.set(last_id)
        else:
          if stored_last_id_value > last_id:
            LOG('IdTool', WARNING, 'ZODB value (%r) for group %r is higher ' \
                'than SQL value (%r). Keeping ZODB value untouched.' % \
                (stored_last_id, id_group, last_id))

Jean-Paul Smets's avatar
Jean-Paul Smets committed
401
InitializeClass(IdTool)