HugePlinnFolder.py

   1 # -*- coding: utf-8 -*-
   2 #######################################################################################
   3 #   Plinn - http://plinn.org                                                          #
   4 #   Copyright (C) 2005-2007  Benoît PIN <benoit.pin@ensmp.fr>                         #
   5 #                                                                                     #
   6 #   This program is free software; you can redistribute it and/or                     #
   7 #   modify it under the terms of the GNU General Public License                       #
   8 #   as published by the Free Software Foundation; either version 2                    #
   9 #   of the License, or (at your option) any later version.                            #
  10 #                                                                                     #
  11 #   This program is distributed in the hope that it will be useful,                   #
  12 #   but WITHOUT ANY WARRANTY; without even the implied warranty of                    #
  13 #   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the                     #
  14 #   GNU General Public License for more details.                                      #
  15 #                                                                                     #
  16 #   You should have received a copy of the GNU General Public License                 #
  17 #   along with this program; if not, write to the Free Software                       #
  18 #   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.   #
  19 #######################################################################################
  20 """ Plinn implementation of CMFBTree
  21
  22
  23
  24 """
  25
  26
  27 from Products.BTreeFolder2.BTreeFolder2 import BTreeFolder2Base
  28 from Products.ZCatalog.Lazy import LazyMap
  29 from BTrees.IOBTree import IOBTree
  30 from BTrees.OIBTree import OIBTree
  31 from Folder import PlinnFolder
  32 from zope.event import notify
  33 try :
  34     from zope.app.container.contained import notifyContainerModified
  35 except ImportError :
  36     ## Zope-2.13 compat
  37     from zope.container.contained import notifyContainerModified
  38 from events import ObjectPositionModified
  39 from zope.component.factory import Factory
  40 from Products.CMFCore.permissions import AddPortalFolders, \
  41                                          ManageProperties, \
  42                                          AccessContentsInformation
  43 from AccessControl import ClassSecurityInfo
  44 from Globals import InitializeClass
  45 from types import StringType
  46
  47
  48 class HugePlinnFolder(BTreeFolder2Base, PlinnFolder) :
  49     """ Plinn Folder for large set of objects
  50     """
  51
  52     security = ClassSecurityInfo()
  53
  54     __getitem__ = PlinnFolder.__getitem__
  55
  56     def __init__(self, id, title='') :
  57         PlinnFolder.__init__(self, id, title)
  58         BTreeFolder2Base.__init__(self, id)
  59
  60     def _initBTrees(self):
  61         super(HugePlinnFolder, self)._initBTrees()
  62         self._pos2id_index = IOBTree()
  63         self._id2pos_index = OIBTree()
  64
  65     def _checkId(self, id, allow_dup=0) :
  66         PlinnFolder._checkId(self, id, allow_dup)
  67         BTreeFolder2Base._checkId(self, id, allow_dup)
  68
  69     security.declareProtected(AddPortalFolders, 'manage_addHugePlinnFolder')
  70     def manage_addHugePlinnFolder(self, id, title='', REQUEST=None) :
  71         """ Add new a new HugePlinnFolder object with id *id*.
  72         """
  73         ob = HugePlinnFolder(id, title)
  74         self._setObject(id, ob)
  75         if REQUEST is not None :
  76             return self.folder_contents(self, REQUEST, portal_status_message='Folder added')
  77
  78     def _setOb(self, id, object):
  79         super(HugePlinnFolder, self)._setOb(id, object)
  80         pos = self.objectCount() - 1
  81         self._pos2id_index[pos] = id
  82         self._id2pos_index[id] = pos
  83
  84     def _delOb(self, id):
  85         pos = self._id2pos_index[id]
  86         self._id2pos_index.pop(id)
  87
  88         for p in xrange(pos+1, self.objectCount()) :
  89             ident = self._pos2id_index[p]
  90             self._pos2id_index[p-1] = ident
  91             self._id2pos_index[ident] = p-1
  92
  93         self._pos2id_index.pop(self.objectCount()-1)
  94
  95         super(HugePlinnFolder, self)._delOb(id)
  96
  97     security.declareProtected(AccessContentsInformation, 'objectIds')
  98     def objectIds(self, spec=None) :
  99         if spec is not None :
 100             return super(HugePlinnFolder, self).objectIds(spec)
 101
 102         pos2id = lambda pos : self._pos2id_index[pos]
 103         return LazyMap(pos2id, xrange(self.objectCount()))
 104
 105
 106
 107     security.declareProtected(ManageProperties, 'moveObjectsByDelta')
 108     def moveObjectsByDelta(self, ids, delta, subset_ids=None,
 109                            suppress_events=False):
 110         """ Move specified sub-objects by delta.
 111         """
 112         if isinstance(ids, StringType):
 113             ids = (ids,)
 114
 115         id2pos = self._id2pos_index
 116         pos2id = self._pos2id_index
 117         for id in ids :
 118             oldPosition = id2pos[id]
 119             newPosition = max(oldPosition + delta, 0)
 120
 121             shift = delta > 0 and 1 or -1
 122             for p in xrange(oldPosition, newPosition, shift) :
 123                 ident = pos2id[p+shift]
 124                 pos2id[p] = ident
 125                 id2pos[ident] = p
 126                 if not suppress_events :
 127                     notify(ObjectPositionModified(self[ident], self, p))
 128
 129             id2pos[id] = newPosition
 130             pos2id[newPosition] = id
 131             if not suppress_events :
 132                 notify(ObjectPositionModified(self[id], self, newPosition))
 133
 134         if not suppress_events :
 135             notifyContainerModified(self)
 136
 137     security.declareProtected(ManageProperties, 'moveObjectsAfter')
 138     def moveObjectsAfter(self, ids, targetId, suppress_events=False):
 139         assert targetId not in ids
 140
 141         id2pos = self._id2pos_index
 142         pos2id = self._pos2id_index
 143         targetPos = id2pos[targetId]
 144         minMovedPos = min([id2pos[id] for id in ids])
 145         maxMovedPos = max([id2pos[id] for id in ids])
 146
 147         for id in ids :
 148             assert id == pos2id.pop(id2pos.pop(id))
 149
 150         id2posUpdate = {}
 151         pos2idUpdate = {}
 152
 153         # moved before the firt item position
 154         if targetPos < minMovedPos :
 155             for i, id in enumerate(ids) :
 156                 pos = i + targetPos + 1
 157                 id2posUpdate[id] = pos
 158                 pos2idUpdate[pos] = id
 159
 160             for id in IndexIterator(pos2id, maxMovedPos, start=targetPos+1):
 161                 pos = pos + 1
 162                 id2posUpdate[id] = pos
 163                 pos2idUpdate[pos] = id
 164
 165         elif targetPos > minMovedPos and targetPos < maxMovedPos :
 166             print minMovedPos, maxMovedPos, targetPos
 167             print "déposé entre la première et la dernière de la sélection"
 168             raise NotImplementedError()
 169         else :
 170             print minMovedPos, maxMovedPos, targetPos
 171             print "déposé après la dernière"
 172             raise NotImplementedError()
 173
 174         id2pos.update(id2posUpdate)
 175         pos2id.update(pos2idUpdate)
 176
 177         # just for debug
 178         for pos in xrange(len(self)) :
 179             assert pos2id.has_key(pos)
 180             assert id2pos.has_key(pos2id[pos])
 181         if not suppress_events :
 182             for id, pos in id2posUpdate.items() :
 183                 notify(ObjectPositionModified(self[id], self, pos))
 184
 185             notifyContainerModified(self)
 186
 187     def getObjectPosition(self, id):
 188         """ Get the position of an object by its id.
 189         """
 190         try :
 191             return self._id2pos_index[id]
 192         except KeyError :
 193             raise ValueError('The object with the id "%s" does not exist.' % id)
 194
 195
 196 class IndexIterator :
 197     def __init__(self, d, maxPos, start=0, length=None) :
 198         self.d = d
 199         self.pos = start
 200         self.maxPos = maxPos
 201         self.length = length
 202         self.fetchedValuesCpt = 0
 203
 204     def __iter__(self) :
 205         return self
 206
 207     def next(self) :
 208         try :
 209             if self.pos > self.maxPos or \
 210                  self.fetchedValuesCpt == self.length:
 211                 raise StopIteration
 212             v = self.d[self.pos]
 213             self.pos = self.pos + 1
 214             self.fetchedValuesCpt = self.fetchedValuesCpt + 1
 215             return v
 216         except KeyError :
 217             self.pos = self.pos + 1
 218             return self.next()
 219
 220
 221 InitializeClass(HugePlinnFolder)
 222 HugePlinnFolderFactory = Factory(HugePlinnFolder)
 223 manage_addHugePlinnFolder = HugePlinnFolder.manage_addHugePlinnFolder.im_func