CategoryTool.py 66.3 KB
Newer Older
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1 2 3
##############################################################################
#
# Copyright (c) 2002 Nexedi SARL and Contributors. All Rights Reserved.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4
#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
Jean-Paul Smets's avatar
Jean-Paul Smets committed
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 32 33 34 35 36 37 38 39
#
# 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.
#
##############################################################################

"""\
ERP portal_categories tool.
"""

from OFS.Folder import Folder
from Products.CMFCore.utils import UniqueObject
from Globals import InitializeClass, DTMLFile
from AccessControl import ClassSecurityInfo
from Acquisition import aq_base
from Products.ERP5Type import Permissions
from Products.ERP5Type.Base import Base
40
from Products.ERP5Type.Cache import getReadOnlyTransactionCache
Jean-Paul Smets's avatar
Jean-Paul Smets committed
41 42
from Products.CMFCategory import _dtmldir
from Products.CMFCore.PortalFolder import ContentFilter
43
from Products.CMFCategory.Renderer import Renderer
44
from OFS.Traversable import NotFound
Jean-Paul Smets's avatar
Jean-Paul Smets committed
45

46
import re
Jean-Paul Smets's avatar
Jean-Paul Smets committed
47

48
from zLOG import LOG, PROBLEM
Jean-Paul Smets's avatar
Jean-Paul Smets committed
49

Yoshinori Okuji's avatar
Yoshinori Okuji committed
50 51
_marker = object()

Jean-Paul Smets's avatar
Jean-Paul Smets committed
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
class CategoryError( Exception ):
    pass

class CategoryTool( UniqueObject, Folder, Base ):
    """
      The CategoryTool object is the placeholder for all methods
      and algorithms related to categories and relations in CMF.

      The default category tool (this one) implements methods such
      as getCategoryMembershipList and setCategoryMembershipList
      which store categorymembership as a list of relative url in
      a property called categories.

      Category membership lists are ordered. For each base_category
      the first category membership in the category membership list is
      called the default category membership. For example, if a resource
      can be counted in meters, kilograms and cubic meters and if the
      default unit is meters, the category membership list for this resource
      from the quantity_unit point of view is::

        quantity_unit/length/meter
        quantity_unit/weight/kilogram
        quantity_unit/volume/m3

      Membership is ordered and multiple. For example, if a swim suit uses
Jérome Perrin's avatar
Jérome Perrin committed
77 78 79 80
      three colors (eg : color1, color2, color3 which are used in the top, belt
      and in the bottom) and if a particular variation of that swim suit has
      two of the three colors the same (eg black, blue, black) then the
      category membership list from the color point of view is::
Jean-Paul Smets's avatar
Jean-Paul Smets committed
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98

        color/black
        color/blue
        color/black

        TODO: Add sort methods everywhere

        NB:
          All values are by default acquired
          Future accessors should provide non acquired values

        XX:
          Why is portal_categoires a subclass of Base ? Because of uid ?
          If yes, then it should be migrated into ERP5Category and __init__ indefined here
    """

    id              = 'portal_categories'
    meta_type       = 'CMF Categories'
99
    portal_type     = 'Category Tool'
Jean-Paul Smets's avatar
Jean-Paul Smets committed
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
    allowed_types = ( 'CMF Base Category', )


    # Declarative Security
    security = ClassSecurityInfo()

    #
    #   ZMI methods
    #
    manage_options = ( ( { 'label'      : 'Overview'
                         , 'action'     : 'manage_overview'
                         }
                        ,
                        )
                     + Folder.manage_options
                     )

    security.declareProtected( Permissions.ManagePortal
                             , 'manage_overview' )
    manage_overview = DTMLFile( 'explainCategoryTool', _dtmldir )


    # Multiple inheritance inconsistency caused by Base must be circumvented
    def __init__( self, *args, **kwargs ):
      Base.__init__(self, self.id, **kwargs)

    # Filter content (ZMI))
    def filtered_meta_types(self, user=None):
        # Filters the list of available meta types.
        all = CategoryTool.inheritedAttribute('filtered_meta_types')(self)
        meta_types = []
        for meta_type in self.all_meta_types():
            if meta_type['name'] in self.allowed_types:
                meta_types.append(meta_type)
        return meta_types

    # Filter Utilities
    def _buildFilter(self, spec, filter, kw):
      if filter is None:
        filt = {}
      else:
        # Work on a copy since we are going to modify it
        filt = filter.copy()
      if spec is not None: filt['meta_type'] = spec
      filt.update(kw)
      return filt

    def _buildQuery(self, spec, filter, kw):
      return apply( ContentFilter, (), self._buildFilter(spec, filter, kw) )

    # Category accessors
151 152
    security.declareProtected(Permissions.AccessContentsInformation, 'getBaseCategoryList')
    def getBaseCategoryList(self, context=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
153 154 155 156 157 158 159 160 161 162 163 164 165 166
      """
        Returns the ids of base categories of the portal_categories tool
        if no context is provided, otherwise, returns the base categories
        defined for the class

        Two alias are provided :

        getBaseCategoryIds -- backward compatibility with early ERP5 versions

        baseCategoryIds -- for zope users conveniance
      """
      if context is None:
        return self.objectIds()
      else:
167
        return context._categories # XXX Incompatible with ERP5Type per portal type categories
Jean-Paul Smets's avatar
Jean-Paul Smets committed
168 169

    security.declareProtected(Permissions.AccessContentsInformation, 'getBaseCategoryIds')
170
    getBaseCategoryIds = getBaseCategoryList
Jean-Paul Smets's avatar
Jean-Paul Smets committed
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190

    security.declareProtected(Permissions.AccessContentsInformation, 'baseCategoryIds')
    baseCategoryIds = getBaseCategoryIds

    security.declareProtected(Permissions.AccessContentsInformation, 'getBaseCategoryValueList')
    def getBaseCategoryValueList(self, context=None):
      """
        Returns the base categories of the portal_categories tool
        if no context is provided, otherwise returns the base categories
        for the class

        Two alias are provided :

        getBaseCategoryValues -- backward compatibility with early ERP5 versions

        baseCategoryValues -- for zope users conveniance
      """
      if context is None:
        return self.objectValues()
      else:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
191
        return [self[x] for x in context._categories] # XXX Incompatible with ERP5Type per portal type categories
Jean-Paul Smets's avatar
Jean-Paul Smets committed
192 193 194 195 196 197 198 199 200 201 202 203 204 205

    security.declareProtected(Permissions.AccessContentsInformation,
                                                         'getBaseCategoryValues')
    getBaseCategoryValues = getBaseCategoryValueList

    security.declareProtected(Permissions.AccessContentsInformation, 'baseCategoryValues')
    baseCategoryValues = getBaseCategoryValues

    security.declareProtected(Permissions.AccessContentsInformation, 'getCategoryValue')
    def getCategoryValue(self, relative_url, base_category = None):
      """
        Returns a Category object from a given category url
        and optionnal base category id
      """
206
      cache = getReadOnlyTransactionCache(self)
207 208 209 210 211 212
      if cache is not None:
        key = ('getCategoryValue', relative_url, base_category)
        try:
          return cache[key]
        except KeyError:
          pass
213

Jean-Paul Smets's avatar
Jean-Paul Smets committed
214 215 216
      try:
        relative_url = str(relative_url)
        if base_category is not None:
Romain Courteaud's avatar
Romain Courteaud committed
217 218
          relative_url = '%s/%s' % (base_category, relative_url)
        node = self.unrestrictedTraverse(relative_url)
219
        value = node
220
      except (TypeError, KeyError, NotFound):
221
        value = None
222

223 224 225 226
      if cache is not None:
        cache[key] = value

      return value
227

Romain Courteaud's avatar
Romain Courteaud committed
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
#     security.declareProtected(Permissions.AccessContentsInformation, 'getCategoryValue')
#     def getCategoryValue(self, relative_url, base_category = None):
#       """
#         Returns a Category object from a given category url
#         and optionnal base category id
#       """
#       try:
#         relative_url = str(relative_url)
#         context = aq_base(self)
#         if base_category is not None:
#           context = context.unrestrictedTraverse(base_category)
#           context = aq_base(context)
#         node = context.unrestrictedTraverse(relative_url)
#         return node.__of__(self)
#       except:
#         return None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273

    security.declareProtected(Permissions.AccessContentsInformation, 'getCategoryUid')
    def getCategoryUid(self, relative_url, base_category = None):
      """
        Returns the uid of a Category from a given base category
        and the relative_url of a category
      """
      node = self.getCategoryValue(relative_url,  base_category = base_category)
      if node is not None:
        return node.uid
      else:
        return None

    security.declareProtected(Permissions.AccessContentsInformation, 'getCategoryValueFromUid')
    def getCategoryValueFromUid(self, uid):
      """
        Returns the a Category object from its uid by looking up in a
        a portal_catalog which must be ZSQLCataglog
      """
      return self.portal_catalog.getobject(uid)

    security.declareProtected(Permissions.AccessContentsInformation, 'getBaseCategoryId')
    def getBaseCategoryId(self, relative_url, base_category = None):
      """
        Returns the id of the base category from a given relative url
        and optional base category
      """
      if base_category is not None:
        return base_category
      try:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
274
        return relative_url.split('/', 1)[0]
275
      except KeyError :
Jean-Paul Smets's avatar
Jean-Paul Smets committed
276 277 278 279 280 281 282 283 284 285 286
        return None

    security.declareProtected(Permissions.AccessContentsInformation, 'getBaseCategoryUid')
    def getBaseCategoryUid(self, relative_url, base_category = None):
      """
        Returns the uid of the base category from a given relative_url
        and optional base category
      """
      try:
        return self.getCategoryValue(self.getBaseCategoryId(relative_url,
                        base_category = base_category)).uid
287
      except (AttributeError, KeyError):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
288 289 290 291 292
        return None

    security.declareProtected(Permissions.AccessContentsInformation, 'getCategoryParentUidList')
    def getCategoryParentUidList(self, relative_url, base_category = None, strict=0):
      """
293 294 295 296 297 298 299
        Returns the uids of all categories provided in categorie. This
        method can support relative_url such as site/group/a/b/c which
        base category is site yet use categories defined in group.

        It is also able to use acquisition to create complex categories
        such as site/group/a/b/c/b1/c1 where b and b1 are both children
        categories of a.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
300 301 302 303 304 305 306 307

        relative_url -- a single relative url of a list of
                        relative urls

        strict       -- if set to 1, only return uids of parents, not
                        relative_url
      """
      uid_dict = {}
Yoshinori Okuji's avatar
Yoshinori Okuji committed
308 309
      if isinstance(relative_url, str):
        relative_url = (relative_url,)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
310 311 312 313
      for path in relative_url:
        try:
          o = self.getCategoryValue(path, base_category=base_category)
          if o is not None:
314 315
            my_base_category = self.getBaseCategoryId(path)
            bo = self.get(my_base_category, None)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
316 317 318 319 320 321 322 323 324
            if bo is not None:
              bo_uid = int(bo.getUid())
              uid_dict[(int(o.uid), bo_uid, 1)] = 1 # Strict Membership
              if o.meta_type == 'CMF Category' or o.meta_type == 'CMF Base Category':
                # This goes up in the category tree
                # XXX we should also go up in some other cases....
                # ie. when some documents act as categories
                if not strict:
                  while o.meta_type == 'CMF Category':
325
                    o = o.aq_parent # We want acquisition here without aq_inner
Jean-Paul Smets's avatar
Jean-Paul Smets committed
326
                    uid_dict[(int(o.uid), bo_uid, 0)] = 1 # Non Strict Membership
327
        except (KeyError, AttributeError):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366
          LOG('WARNING: CategoriesTool',0, 'Unable to find uid for %s' % path)
      return uid_dict.keys()

    security.declareProtected(Permissions.AccessContentsInformation, 'getUids')
    getUids = getCategoryParentUidList

    security.declareProtected(Permissions.AccessContentsInformation, 'getCategoryChildUidList')
    def getCategoryChildUidList(self, relative_url, base_category = None, strict=0):
      """
        Returns the uids of all categories provided in categories

        relative_url -- a single relative url of a list of
                        relative urls

        strict       -- if set to 1, only return uids of parents, not
                        relative_url
      """
      ## TBD

    # Recursive listing API
    security.declareProtected(Permissions.AccessContentsInformation,
                                                  'getCategoryChildRelativeUrlList')
    def getCategoryChildRelativeUrlList(self, base_category=None, base=0, recursive=1):
      """
      Returns a list of relative urls by parsing recursively all categories in a
      given list of base categories

      base_category -- A single base category id or a list of base category ids
                       if not provided, base category will be set with the list
                       of all current category ids

      base -- if set to 1, relative_url will start with the base category id
              if set to 0 and if base_category is a single id, relative_url
              are relative to the base_category (and thus  doesn't start
              with the base category id)

      recursive -- if set to 0 do not apply recursively
      """
      if base_category is None:
367
        base_category_list = self.getBaseCategoryList()
Yoshinori Okuji's avatar
Yoshinori Okuji committed
368
      elif isinstance(base_category, str):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
369 370 371 372 373 374 375
        base_category_list = [base_category]
      else:
        base_category_list = base_category
      result = []
      for base_category in base_category_list:
        category = self[base_category]
        if category is not None:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
376
          result.extend(category.getCategoryChildRelativeUrlList(base=base,recursive=recursive))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
377 378 379
      return result

    security.declareProtected(Permissions.AccessContentsInformation, 'getPathList')
380 381 382 383
    getPathList = getCategoryChildRelativeUrlList # Exists for backward compatibility

    security.declareProtected(Permissions.AccessContentsInformation, 'getCategoryChildList')
    getCategoryChildList = getCategoryChildRelativeUrlList # This is more consistent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
384 385 386 387

    security.declareProtected(Permissions.AccessContentsInformation,
                                                      'getCategoryChildTitleItemList')
    def getCategoryChildTitleItemList(self, base_category=None,
Jean-Paul Smets's avatar
Jean-Paul Smets committed
388
                                recursive=1, base=0, display_none_category=0, sort_id=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
389 390 391 392
      """
      Returns a list of tuples by parsing recursively all categories in a
      given list of base categories. Uses getTitle as default method
      """
393
      return self.getCategoryChildItemList(base_category=base_category, recursive = recursive,base=base,
Jean-Paul Smets's avatar
Jean-Paul Smets committed
394
       display_none_category=display_none_category,display_id='getTitle', sort_id=sort_id)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
395 396

    security.declareProtected(Permissions.AccessContentsInformation,
397
                              'getCategoryChildIdItemList')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
398
    def getCategoryChildIdItemList(self, base_category=None,
Jean-Paul Smets's avatar
Jean-Paul Smets committed
399
              recursive=1, base=0, display_none_category=0, sort_id=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
400 401 402 403
      """
      Returns a list of tuples by parsing recursively all categories in a
      given list of base categories. Uses getId as default method
      """
404 405 406 407 408 409 410
      return self.getCategoryChildItemList(
                          base_category=base_category,
                          recursive = recursive,
                          base=base,
                          display_none_category=display_none_category,
                          display_id='getId',
                          sort_id=sort_id )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
411 412

    security.declareProtected(Permissions.AccessContentsInformation,
413
                              'getCategoryChildItemList')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
414
    def getCategoryChildItemList(self, base_category=None, display_id = None,
415
          recursive=1, base=0, display_none_category=1, sort_id=None, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
416 417 418 419
      """
      Returns a list of tuples by parsing recursively all categories in a
      given list of base categories. Each tuple contains::

Jean-Paul Smets's avatar
Jean-Paul Smets committed
420
        (c.relative_url,c.display_id())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
421 422 423 424 425 426 427 428 429 430

      base_category -- A single base category id or a list of base category ids
                       if not provided, base category will be set with the list
                       of all current category ids

      base -- if set to 1, relative_url will start with the base category id
              if set to 0 and if base_category is a single id, relative_url
              are relative to the base_category (and thus  doesn't start
              with the base category id)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
431
      display_id -- method called to build the couple
Jean-Paul Smets's avatar
Jean-Paul Smets committed
432 433

      recursive -- if set to 0 do not apply recursively
434 435

      See Category.getCategoryChildItemList for extra accepted arguments
Jean-Paul Smets's avatar
Jean-Paul Smets committed
436
      """
437
      if isinstance(base_category, str):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
438 439
        base_category_list = [base_category]
      elif base_category is None:
440
        base_category_list = self.getBaseCategoryList()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
441 442
      else:
        base_category_list = base_category
Jean-Paul Smets's avatar
Jean-Paul Smets committed
443
      if display_none_category:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
444 445 446 447 448 449
        result = [('', '')]
      else:
        result = []
      for base_category in base_category_list:
        category = self[base_category]
        if category is not None:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
450
          result.extend(category.getCategoryChildItemList(
451 452 453
                               base=base,
                               recursive=recursive,
                               display_id=display_id,
Yoshinori Okuji's avatar
Yoshinori Okuji committed
454
                               **kw ))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
455 456
      return result

457 458
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getBaseItemList')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
459 460 461 462
    getBaseItemList = getCategoryChildItemList

    # Category to Tuple Conversion
    security.declareProtected(Permissions.View, 'asItemList')
Sebastien Robin's avatar
Sebastien Robin committed
463
    def asItemList(self, relative_url, base_category=None,**kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
464 465
      """
      Returns a list of tuples, each tuple is calculated by applying
Jean-Paul Smets's avatar
Jean-Paul Smets committed
466
      display_id on each category provided in relative_url
Jean-Paul Smets's avatar
Jean-Paul Smets committed
467 468 469 470 471 472 473 474 475 476

      base_category -- A single base category id or a list of base category ids
                       if not provided, base category will be set with the list
                       of all current category ids

      base -- if set to 1, relative_url will start with the base category id
              if set to 0 and if base_category is a single id, relative_url
              are relative to the base_category (and thus  doesn't start
              with the base category id)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
477
      display_id -- method called to build the couple
Jean-Paul Smets's avatar
Jean-Paul Smets committed
478 479 480

      recursive -- if set to 0 do not apply recursively
      """
Sebastien Robin's avatar
Sebastien Robin committed
481 482 483 484
      #if display_id is None:
      #  for c in relative_url:
      #    result += [(c, c)]
      #else:
Romain Courteaud's avatar
Romain Courteaud committed
485
#       LOG('CMFCategoryTool.asItemList, relative_url',0,relative_url)
Sebastien Robin's avatar
Sebastien Robin committed
486 487 488
      value_list = []
      for c in relative_url:
        o = self.getCategoryValue(c, base_category=base_category)
Romain Courteaud's avatar
Romain Courteaud committed
489
#         LOG('CMFCategoryTool.asItemList, (o,c)',0,(o,c))
Sebastien Robin's avatar
Sebastien Robin committed
490 491 492 493
        if o is not None:
          value_list.append(o)
        else:
          LOG('WARNING: CategoriesTool',0, 'Unable to find category %s' % c)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
494 495 496 497

      #if sort_id is not None:
      #  result.sort()

Romain Courteaud's avatar
Romain Courteaud committed
498
#       LOG('CMFCategoryTool.asItemList, value_list',0,value_list)
Sebastien Robin's avatar
Sebastien Robin committed
499
      return Renderer(base_category=base_category,**kw).render(value_list)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
500 501 502 503 504 505 506

    security.declareProtected(Permissions.View, 'getItemList')
    getItemList = asItemList

    # Convert a list of membership to path
    security.declareProtected(Permissions.View, 'asPathList')
    def asPathList(self, base_category, category_list):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
507
      if isinstance(category_list, str):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
508
        category_list = [category_list]
Yoshinori Okuji's avatar
Yoshinori Okuji committed
509
      if category_list is None:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
510 511 512
        category_list = []
      new_list = []
      for v in category_list:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
513
        new_list.append('%s/%s' % (base_category, v))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
514 515 516 517 518 519 520 521 522 523 524
      return new_list

    # Alias for compatibility
    security.declareProtected(Permissions.View, 'formSelectionToPathList')
    formSelectionToPathList = asPathList


    # Category implementation
    security.declareProtected( Permissions.AccessContentsInformation,
                                                  'getCategoryMembershipList' )
    def getCategoryMembershipList(self, context, base_category, base=0,
525
                                  spec=(), filter=None, **kw  ):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
526 527 528 529 530 531 532 533 534 535 536 537 538 539
      """
        Returns a list of category membership
        represented as a list of relative URLs

        context       --    the context on which we are looking for categories

        base_category --    a single base category (string) or a list of base categories

        spec          --    a list or a tuple of portal types

        base          --    if set to 1, returns relative URLs to portal_categories
                            if set to 0, returns relative URLs to the base category
      """
      # XXX We must use filters in the future
540
      # where_expression = self._buildQuery(spec, filter, kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
541 542 543 544 545 546
      portal_type = kw.get('portal_type', ())
      if spec is (): spec = portal_type

      # LOG('getCategoryMembershipList',0,str(spec))
      # LOG('getCategoryMembershipList',0,str(base_category))
      membership = []
Yoshinori Okuji's avatar
Yoshinori Okuji committed
547
      if not isinstance(base_category, (tuple, list)):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
548 549 550
        category_list = [base_category]
      else:
        category_list = base_category
Yoshinori Okuji's avatar
Yoshinori Okuji committed
551
      if not isinstance(spec, (tuple, list)):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
552 553 554
        spec = [spec]
      for path in self._getCategoryList(context):
        # LOG('getCategoryMembershipList',0,str(path))
Yoshinori Okuji's avatar
Yoshinori Okuji committed
555
        my_base_category = path.split('/', 1)[0]
Jean-Paul Smets's avatar
Jean-Paul Smets committed
556
        for my_category in category_list:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
557
          if isinstance(my_category, str):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
558 559 560 561 562 563
            category = my_category
          else:
            category = my_category.getRelativeUrl()
          if my_base_category == category:
            if spec is ():
              if base:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
564
                membership.append(path)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
565
              else:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
566
                membership.append(path[len(category)+1:])
Jean-Paul Smets's avatar
Jean-Paul Smets committed
567 568 569 570 571 572
            else:
              try:
               o = self.unrestrictedTraverse(path)
               # LOG('getCategoryMembershipList',0,str(o.portal_type))
               if o.portal_type in spec:
                if base:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
573
                  membership.append(path)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
574
                else:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
575 576
                  membership.append(path[len(category)+1:])
              except KeyError:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
577 578 579 580 581 582
                LOG('WARNING: CategoriesTool',0, 'Unable to find object for path %s' % path)
      # We must include parent if specified explicitely
      if 'parent' in category_list:
        parent = context.aq_parent
        if parent.portal_type in spec:
          if base:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
583
            membership.append('parent/' + parent.getRelativeUrl())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
584
          else:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
585
            membership.append(parent.getRelativeUrl())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606
      return membership

    security.declareProtected( Permissions.AccessContentsInformation, 'setCategoryMembership' )
    def setCategoryMembership(self, context, base_category_list, category_list, base=0, keep_default=1,
                                 spec=(), filter=None, **kw ):
      """
        Sets the membership of the context on the specified base_category
        list and for the specified portal_type spec

        context            --    the context on which we are looking for categories

        base_category_list --    a single base category (string) or a list of base categories
                                 or a single base category object or a list of base category objects

        category_list      --    a single category (string) or a list of categories

        spec               --    a list or a tuple of portal types

      """
      #LOG("set Category 1",0,str(category_list))
      # XXX We must use filters in the future
607
      # where_expression = self._buildQuery(spec, filter, kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
608
      portal_type = kw.get('portal_type', ())
Yoshinori Okuji's avatar
Yoshinori Okuji committed
609
      if isinstance(portal_type, str):
610
        portal_type = (portal_type,)
611
      if spec is ():
612
        spec = portal_type
Jean-Paul Smets's avatar
Jean-Paul Smets committed
613 614
      default_dict = {}
      self._cleanupCategories(context)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
615
      if isinstance(category_list, str):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
616 617 618
        category_list = (category_list,)
      elif category_list is None:
        category_list = ()
619 620 621 622
      elif isinstance(category_list, (list, tuple)):
        pass
      else:
        raise TypeError, 'Category must be of string, tuple of string or list of string type.'
Yoshinori Okuji's avatar
Yoshinori Okuji committed
623
      if isinstance(base_category_list, str):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
624 625 626 627
        base_category_list = [base_category_list]
      new_category_list = []
      for path in self._getCategoryList(context):
        my_base_id = self.getBaseCategoryId(path)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
628
        if my_base_id not in base_category_list:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
629 630
          # Keep each membership which is not in the
          # specified list of base_category ids
631
          new_category_list.append(path)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
632 633 634 635 636 637 638 639 640
        else:
          if spec is ():
            # If spec is (), then we should keep nothing
            # Everything will be replaced
            keep_it = 0
          else:
            # Only keep this if not in our spec
            try:
              my_type = self.unrestrictedTraverse(path).portal_type
641
              keep_it = (my_type not in spec)
642
            except (KeyError, AttributeError):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
643 644
              keep_it = 0
          if keep_it:
645
            new_category_list.append(path)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
646 647 648 649 650 651 652 653 654 655
          elif keep_default:
            # We must remember the default value
            # for each replaced category
            if not default_dict.has_key(my_base_id):
              default_dict[my_base_id] = path
      # We now create a list of default category values
      default_new_category_list = []
      for path in default_dict.values():
        if base or len(base_category_list) > 1:
          if path in category_list:
656
            default_new_category_list.append(path)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
657 658
        else:
          if path[len(base_category_list[0])+1:] in category_list:
659
            default_new_category_list.append(path)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
660 661 662 663
      # Before we append new category values (except default values)
      # We must make sure however that multiple links are possible
      default_path_found = {}
      for path in category_list:
664
        if path != '':
Jean-Paul Smets's avatar
Jean-Paul Smets committed
665 666 667 668 669
          if base or len(base_category_list) > 1:
            # Only keep path which are member of base_category_list
            if self.getBaseCategoryId(path) in base_category_list:
              if path not in default_new_category_list or default_path_found.has_key(path):
                default_path_found[path] = 1
670
                new_category_list.append(path)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
671
          else:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
672
            new_path = base_category_list[0] + '/' + path
Jean-Paul Smets's avatar
Jean-Paul Smets committed
673
            if new_path not in default_new_category_list:
674
              new_category_list.append(new_path)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
675
      #LOG("set Category",0,str(new_category_list))
676
      #LOG("set Category",0,str(default_new_category_list))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
677 678 679 680
      self._setCategoryList(context, tuple(default_new_category_list + new_category_list))

    security.declareProtected( Permissions.AccessContentsInformation, 'setDefaultCategoryMembership' )
    def setDefaultCategoryMembership(self, context, base_category, default_category,
681 682 683
                                              spec=(), filter=None,
                                              portal_type=(), base=0,
                                              checked_permission=None ):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
684 685 686 687 688 689 690 691 692 693 694 695 696 697 698
      """
        Sets the membership of the context on the specified base_category
        list and for the specified portal_type spec

        context            --    the context on which we are looking for categories

        base_category_list --    a single base category (string) or a list of base categories
                                 or a single base category object or a list of base category objects

        category_list      --    a single category (string) or a list of categories

        spec               --    a list or a tuple of portal types

      """
      self._cleanupCategories(context)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
699
      if isinstance(default_category, (tuple, list)):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
700 701 702 703 704 705 706 707 708
        default_category = default_category[0]
      category_list = self.getCategoryMembershipList(context, base_category,
                           spec=spec, filter=filter, portal_type=portal_type, base=base)
      new_category_list = [default_category]
      found_one = 0
      # We will keep from the current category_list
      # everything except the first occurence of category
      # this allows to have multiple occurences of the same category
      for category in category_list:
709
        if category == default_category:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
710
          found_one = 1
711
        elif category != default_category or found_one:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
712
          new_category_list.append(category)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
713 714 715
      self.setCategoryMembership(context, base_category, new_category_list,
           spec=spec, filter=filter, portal_type=portal_type, base=base, keep_default = 0)

716 717
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getSingleCategoryMembershipList')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
718
    def getSingleCategoryMembershipList(self, context, base_category, base=0,
719 720
                                         spec=(), filter=None, 
                                         checked_permission=None, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
721 722 723 724 725 726 727 728 729 730 731 732
      """
        Returns the local membership of the context for a single base category
        represented as a list of relative URLs

        context       --    the context on which we are looking for categories

        base_category --    a single base category (string)

        spec          --    a list or a tuple of portal types

        base          --    if set to 1, returns relative URLs to portal_categories
                            if set to 0, returns relative URLs to the base category
733 734 735

        checked_permission        --    a string which defined the permission 
                                        to filter the object on
Jean-Paul Smets's avatar
Jean-Paul Smets committed
736 737
      """
      # XXX We must use filters in the future
738
      # where_expression = self._buildQuery(spec, filter, kw)
739 740
      if spec is (): 
        spec = kw.get('portal_type', ())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
741

742
      # Build the ckecked_permission filter
743 744 745 746 747 748 749 750 751
      if checked_permission is not None:
        checkPermission = self.portal_membership.checkPermission
        def permissionFilter(category):
          object = self.unrestrictedTraverse(category)
          if object is not None and checkPermission(checked_permission, object):
            return category
          else:
            return None
            
752

753
      # We must treat parent in a different way
754
      #LOG('getSingleCategoryMembershipList', 0, 'base_category = %s, spec = %s, base = %s, context = %s, context.aq_inner.aq_parent = %s' % (repr(base_category), repr(spec), repr(base), repr(context), repr(context.aq_inner.aq_parent)))
755
      if base_category == 'parent':
756
        parent = context.aq_inner.aq_parent # aq_inner is required to make sure we use containment
757
        if parent.portal_type in spec:
758 759 760 761 762 763 764
          parent_relative_url = parent.getRelativeUrl()
          if (checked_permission is None) or \
            (permissionFilter(parent_relative_url) is not None):
            if base:
              return 'parent/%s' % parent_relative_url
            else:
              return parent_relative_url
765 766 767
        #LOG('getSingleCategoryMembershipList', 0, 'not in spec: parent.portal_type = %s, spec = %s' % (repr(parent.portal_type), repr(spec)))
        return []

Jean-Paul Smets's avatar
Jean-Paul Smets committed
768
      # XXX We must use filters in the future
769
      # where_expression = self._buildQuery(spec, filter, kw)
770 771
      result = []
      append = result.append
Jean-Paul Smets's avatar
Jean-Paul Smets committed
772
      # Make sure spec is a list or tuple
Yoshinori Okuji's avatar
Yoshinori Okuji committed
773
      if isinstance(spec, str):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
774 775
        spec = [spec]
      # Filter categories
Yoshinori Okuji's avatar
Yoshinori Okuji committed
776
      if getattr(aq_base(context), 'categories', _marker) is not _marker:
777

Jean-Paul Smets's avatar
Jean-Paul Smets committed
778
        for category_url in self._getCategoryList(context):
779 780 781 782 783
          try:
            index = category_url.index('/')
            my_base_category = category_url[:index]
          except ValueError:
            my_base_category = category_url
Jean-Paul Smets's avatar
Jean-Paul Smets committed
784
          if my_base_category == base_category:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
785
            #LOG("getSingleCategoryMembershipList",0,"%s %s %s %s" % (context.getRelativeUrl(),
Jean-Paul Smets's avatar
Jean-Paul Smets committed
786
            #                  my_base_category, base_category, category_url))
787 788 789 790 791 792 793
            if (checked_permission is None) or \
                (permissionFilter(category_url) is not None):
              if spec is ():
                if base:
                  append(category_url)
                else:
                  append(category_url[len(my_base_category)+1:])
Jean-Paul Smets's avatar
Jean-Paul Smets committed
794
              else:
795 796 797 798 799 800 801 802
                my_reference = self.unrestrictedTraverse(category_url, None)
                if my_reference is not None:
                  if my_reference.portal_type in spec:
                    if base:
                      append(category_url)
                    else:
                      append(category_url[len(my_base_category)+1:])
      return result
Jean-Paul Smets's avatar
Jean-Paul Smets committed
803 804 805

    security.declareProtected( Permissions.AccessContentsInformation,
                                      'getSingleCategoryAcquiredMembershipList' )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
806
    def getSingleCategoryAcquiredMembershipList(self, context, base_category, base=0,
807
                                         spec=(), filter=None, acquired_object_dict = None, **kw ):
808
      cache = getReadOnlyTransactionCache(self)
809
      if cache is not None:
810
        key = ('getSingleCategoryAcquiredMembershipList', context._p_oid, base_category, base, spec,
811 812 813 814 815
               filter, str(kw))
        try:
          return cache[key]
        except KeyError:
          pass
816

817
      result = self._getSingleCategoryAcquiredMembershipList(context, base_category, base=base,
818
                                                             spec=spec, filter=filter,
819 820 821 822
                                                             acquired_object_dict = acquired_object_dict,
                                                             **kw)
      if cache is not None:
        cache[key] = result
823

824
      return result
825 826


827 828 829 830 831
    def _getSingleCategoryAcquiredMembershipList(self, context, base_category,
                                         base = 0, spec = (), filter = None,
                                         acquired_portal_type = (),
                                         acquired_object_dict = None,
                                         **kw ):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
832 833 834 835 836 837 838 839 840 841 842 843
      """
        Returns the acquired membership of the context for a single base category
        represented as a list of relative URLs

        context       --    the context on which we are looking for categories

        base_category --    a single base category (string)

        spec          --    a list or a tuple of portal types

        base          --    if set to 1, returns relative URLs to portal_categories
                            if set to 0, returns relative URLs to the base category
844

845 846 847
        checked_permission        --    a string which defined the permission 
                                        to filter the object on

848 849 850 851 852
        acquired_object_dict      --    this is the list of object used by acquisition, so
                                        we can check if we already have used this object

        alt_base_category         --    an alternative base category if the first one fails

853 854 855 856 857 858 859 860
        acquisition_copy_value    --    if set to 1, the looked up value will be copied
                            as an attribute of self

        acquisition_mask_value    --    if set to 1, the value of the category of self
                            has priority on the looked up value

        acquisition_sync_value    --    if set to 1, keep self and looked up value in sync

Jean-Paul Smets's avatar
Jean-Paul Smets committed
861
      """
862 863
      #LOG("Get Acquired Category ",0,str((base_category, context,)))
      #LOG("Get Acquired Category acquired_object_dict: ",0,str(acquired_object_dict))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
864
      # XXX We must use filters in the future
865
      # where_expression = self._buildQuery(spec, filter, kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
866
      portal_type = kw.get('portal_type', ())
867
      if spec is (): spec = portal_type # This is bad XXX - JPS - spec is for meta_type, not for portal_type - be consistent !
Jean-Paul Smets's avatar
Jean-Paul Smets committed
868

Yoshinori Okuji's avatar
Yoshinori Okuji committed
869
      if isinstance(spec, str):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
870
        spec = [spec]
871

Yoshinori Okuji's avatar
Yoshinori Okuji committed
872
      if isinstance(acquired_portal_type, str):
873 874
        acquired_portal_type = [acquired_portal_type]

875
      if acquired_object_dict is None:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
876 877 878 879
        acquired_object_dict = {} # Initial call may include filter, etc. - do not keep
      else:
        context_base_key = (tuple(context.getPhysicalPath()), base_category)
        if context_base_key in acquired_object_dict:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
880 881
          acquired_object_dict = acquired_object_dict.copy()
          type_dict = acquired_object_dict[context_base_key].copy()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
882 883
          if spec is ():
            if () in type_dict:
884 885
              return []
            else:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
886
              type_dict[()] = 1
887
          else:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
888 889 890 891 892
            for pt in spec:
              if pt in type_dict:
                return []
              else:
                type_dict[pt] = 1
Yoshinori Okuji's avatar
Yoshinori Okuji committed
893
          acquired_object_dict[context_base_key] = type_dict
894
        else:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
895 896 897 898 899
          type_dict = {}
          if spec is ():
            type_dict[()] = 1
          else:
            for pt in spec:
900
              type_dict[pt] = 1
Yoshinori Okuji's avatar
Yoshinori Okuji committed
901
          acquired_object_dict = acquired_object_dict.copy()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
902
          acquired_object_dict[context_base_key] = type_dict
903

Jean-Paul Smets's avatar
Jean-Paul Smets committed
904
      result = self.getSingleCategoryMembershipList( context, base_category, base=base,
905 906
                            spec=spec, filter=filter, **kw ) # Not acquired because this is the first try
                                                             # to get a local defined category
907

908
      base_category_value = self.getCategoryValue(base_category)
909
      #LOG("result", 0, str(result))
910
      if base_category_value is not None:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
911
        # If we do not mask or append, return now if not empty
912 913
        if base_category_value.getAcquisitionMaskValue() and \
                not base_category_value.getAcquisitionAppendValue() and \
914
                result:
915
          # If acquisition masks and we do not append values, then we must return now
Jean-Paul Smets's avatar
Jean-Paul Smets committed
916 917
          return result
        # First we look at local ids
918
        for object_id in base_category_value.getAcquisitionObjectIdList():
919 920 921 922
          try:
            my_acquisition_object = context[object_id]
          except (KeyError, AttributeError):
            my_acquisition_object = None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
923
          if my_acquisition_object is not None:
924 925 926
            #my_acquisition_object_path = my_acquisition_object.getPhysicalPath()
            #if my_acquisition_object_path in acquired_object_dict:
            #  continue
927
            #acquired_object_dict[my_acquisition_object_path] = 1
928
            if my_acquisition_object.portal_type in base_category_value.getAcquisitionPortalTypeList():
929 930 931 932
              new_result = self.getSingleCategoryAcquiredMembershipList(my_acquisition_object,
                  base_category, spec=spec, filter=filter, portal_type=portal_type, base=base, acquired_object_dict=acquired_object_dict)
            else:
              new_result = []
933 934 935
            #if base_category_value.acquisition_mask_value:
            #  # If acquisition masks, then we must return now
            #  return new_result
936
            if base_category_value.getAcquisitionAppendValue():
Jean-Paul Smets's avatar
Jean-Paul Smets committed
937
              # If acquisition appends, then we must append to the result
Yoshinori Okuji's avatar
Yoshinori Okuji committed
938
              result.extend(new_result)
939
            elif new_result:
940
              return new_result # Found enough information to return
Jean-Paul Smets's avatar
Jean-Paul Smets committed
941
        # Next we look at references
942
        #LOG("Get Acquired BC", 0, base_category_value.getAcquisitionBaseCategoryList())
943
        acquisition_base_category_list = base_category_value.getAcquisitionBaseCategoryList()
944
        alt_base_category_list = base_category_value.getFallbackBaseCategoryList()
945
        all_acquisition_base_category_list = acquisition_base_category_list + alt_base_category_list
946
        acquisition_pt = base_category_value.getAcquisitionPortalTypeList(())
947
        for my_base_category in acquisition_base_category_list:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
948
          # We implement here special keywords
Jean-Paul Smets's avatar
Jean-Paul Smets committed
949
          if my_base_category == 'parent':
950
            parent = context.aq_inner.aq_parent # aq_inner is required to make sure we use containment
Yoshinori Okuji's avatar
Yoshinori Okuji committed
951
            if getattr(aq_base(parent), 'portal_type', _marker) is _marker:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
952 953
              my_acquisition_object_list = []
            else:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
954 955 956
              #LOG("Parent Object List ",0,str(parent.getRelativeUrl()))
              #LOG("Parent Object List ",0,str(parent.portal_type))
              #LOG("Parent Object List ",0,str(acquisition_pt))
957 958
              #my_acquisition_object_path = parent.getPhysicalPath()
              #if my_acquisition_object_path in acquired_object_dict:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
959
              if acquisition_pt is () or parent.portal_type in acquisition_pt:
960
                my_acquisition_object_list = [parent]
Jean-Paul Smets's avatar
Jean-Paul Smets committed
961 962 963
              else:
                my_acquisition_object_list = []
          else:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
964
            #LOG('getAcquiredCategoryMembershipList', 0, 'my_acquisition_object = %s, acquired_object_dict = %s' % (str(context), str(acquired_object_dict)))
Yoshinori Okuji's avatar
Yoshinori Okuji committed
965
            my_acquisition_list = self.getSingleCategoryAcquiredMembershipList(context,
966
                        my_base_category,
967
                        portal_type=tuple(base_category_value.getAcquisitionPortalTypeList(())),
968 969
                        acquired_object_dict=acquired_object_dict)
            my_acquisition_object_list = []
Yoshinori Okuji's avatar
Yoshinori Okuji committed
970
            for c in my_acquisition_list:
971 972 973 974 975
              o = self.resolveCategory(c)
              if o is not None:
                my_acquisition_object_list.append(o)
            #my_acquisition_object_list = context.getValueList(my_base_category,
            #                       portal_type=tuple(base_category_value.getAcquisitionPortalTypeList(())))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
976 977
          #LOG("Get Acquired PT",0,str(base_category_value.getAcquisitionPortalTypeList(())))
          #LOG("Object List ",0,str(my_acquisition_object_list))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
978 979 980
          original_result = result
          result = list(result) # make a copy
          for my_acquisition_object in my_acquisition_object_list:
981
            #LOG('getSingleCategoryAcquiredMembershipList', 0, 'my_acquisition_object = %s, acquired_object_dict = %s' % (str(my_acquisition_object), str(acquired_object_dict)))
982 983
            #LOG('getSingleCategoryAcquiredMembershipList', 0, 'my_acquisition_object.__dict__ = %s' % str(my_acquisition_object.__dict__))
            #LOG('getSingleCategoryAcquiredMembershipList', 0, 'my_acquisition_object.__hash__ = %s' % str(my_acquisition_object.__hash__()))
984
            #if my_acquisition_object is not None:
985
            if my_acquisition_object is not None:
986 987 988 989
              #my_acquisition_object_path = my_acquisition_object.getPhysicalPath()
              #if my_acquisition_object_path in acquired_object_dict:
              #  continue
              #acquired_object_dict[my_acquisition_object_path] = 1
990 991 992
              #if hasattr(my_acquisition_object, '_categories'): # This would be a bug since we have category acquisition
                #LOG('my_acquisition_object',0, str(getattr(my_acquisition_object, '_categories', ())))
                #LOG('my_acquisition_object',0, str(base_category))
993 994 995
                
                # We should only consider objects which define that category
                if base_category in getattr(my_acquisition_object, '_categories', ()) or base_category_value.getFallbackBaseCategoryList():
996
                  if (not acquired_portal_type) or my_acquisition_object.portal_type in acquired_portal_type:
997
                    #LOG("Recursive call ",0,str((spec, my_acquisition_object.portal_type)))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
998
                    new_result = self.getSingleCategoryAcquiredMembershipList(my_acquisition_object,
999
                        base_category, spec=spec, filter=filter, portal_type=portal_type, base=base,
1000
                        acquired_portal_type=acquired_portal_type,
1001
                        acquired_object_dict=acquired_object_dict)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1002
                  else:
1003
                    #LOG("No recursive call ",0,str((spec, my_acquisition_object.portal_type)))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1004
                    new_result = []
1005
                  if getattr(base_category_value, 'acquisition_append_value', False):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1006
                    # If acquisition appends, then we must append to the result
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1007
                    result.extend(new_result)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1008
                  elif len(new_result) > 0:
1009
                    #LOG("new_result ",0,str(new_result))
1010 1011
                    if (getattr(base_category_value, 'acquisition_copy_value', False) and len(original_result) == 0) \
                                                    or getattr(base_category_value, 'acquisition_sync_value', False):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1012 1013
                      # If copy is set and result was empty, then copy it once
                      # If sync is set, then copy it again
1014
                      self.setCategoryMembership( context, base_category, new_result,
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1015 1016 1017
                                    spec=spec, filter=filter, portal_type=portal_type, base=base )
                    # We found it, we can return
                    return new_result
1018 1019


1020 1021 1022
          if (getattr(base_category_value, 'acquisition_copy_value', False) or \
              getattr(base_category_value, 'acquisition_sync_value', False))\
              and len(result) > 0:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1023 1024
            # If copy is set and result was empty, then copy it once
            # If sync is set, then copy it again
1025
            self.setCategoryMembership( context, base_category, result,
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1026
                                         spec=spec, filter=filter, portal_type=portal_type, base=base )
1027
        if len(result)==0 and len(base_category_value.getFallbackBaseCategoryList())>0:
1028
          # We must then try to use the alt base category
1029
          for base_category in base_category_value.getFallbackBaseCategoryList():
1030 1031 1032 1033
            # First get the category list
            category_list = self.getSingleCategoryAcquiredMembershipList( context, base_category, base=1,
                                 spec=spec, filter=filter, acquired_object_dict=acquired_object_dict, **kw )
            # Then convert it into value
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1034
            category_value_list = [self.resolveCategory(x) for x in category_list]
1035 1036
            # Then build the alternate category
            if base:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1037 1038
              base_category_id = base_category_value.getId()
              for category_value in category_value_list:
1039
                if category_value is None :
1040 1041 1042 1043
                  message = "category does not exists for %s (%s)"%(
                                       context.getPath(), category_list)
                  LOG('CMFCategory', PROBLEM, message)
                  raise CategoryError (message)
1044 1045 1046
                else :
                  result.append('%s/%s' % (base_category_id, category_value.getRelativeUrl()))
            else :
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1047
              for category_value in category_value_list:
1048 1049 1050 1051 1052 1053 1054
                if category_value is None :
                  message = "category does not exists for %s (%s)"%(
                                       context.getPath(), category_list)
                  LOG('CMFCategory', PROBLEM, message)
                  raise CategoryError (message)
                else :
                  result.append(category_value.getRelativeUrl())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1055 1056 1057
      # WE MUST IMPLEMENT HERE THE REST OF THE SEMANTICS
      #LOG("Get Acquired Category Result ",0,str(result))
      return result
1058

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1059 1060
    security.declareProtected( Permissions.AccessContentsInformation,
                                               'getAcquiredCategoryMembershipList' )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1061
    def getAcquiredCategoryMembershipList(self, context, base_category = None, base=1,
1062
                                          spec=(), filter=None, acquired_object_dict=None, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1063 1064 1065
      """
        Returns all acquired category values
      """
1066
      #LOG("Get Acquired Category List", 0, "%s %s" % (base_category, context.getRelativeUrl()))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1067
      result = []
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1068
      extend = result.extend
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1069
      if base_category is None:
1070
        base_category_list = context._categories # XXX incompatible with ERP5Type per portal categories
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1071
      elif isinstance(base_category, str):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1072
        base_category_list = [base_category]
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1073
      else:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1074
        base_category_list = base_category
1075
      #LOG('CT.getAcquiredCategoryMembershipList base_category_list',0,base_category_list)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1076
      getSingleCategoryAcquiredMembershipList = self.getSingleCategoryAcquiredMembershipList
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1077
      for base_category in base_category_list:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1078 1079
        extend(getSingleCategoryAcquiredMembershipList(context, base_category, base=base,
                                    spec=spec, filter=filter, acquired_object_dict=acquired_object_dict, **kw ))
1080
        #LOG('CT.getAcquiredCategoryMembershipList new result',0,result)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1081 1082 1083
      return result

    security.declareProtected( Permissions.AccessContentsInformation, 'isMemberOf' )
1084
    def isMemberOf(self, context, category, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1085 1086 1087
      """
        Tests if an object if member of a given category
        Category is a string here. It could be more than a string (ex. an object)
1088 1089

        Keywords parameters :
1090
         - strict_membership:  if we want strict membership checking
1091
         - strict : alias for strict_membership (deprecated but still here for
1092
                    skins backward compatibility. )
1093

1094 1095 1096
        XXX - there should be 2 different methods, one which acuiqred
        and the other which does not. A complete review of
        the use of isMemberOf is required
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1097
      """
1098
      strict_membership = kw.get('strict_membership', kw.get('strict', 0))
1099 1100
      if getattr(aq_base(context), 'isCategory', 0):
        if context.isMemberOf(category, strict_membership=strict_membership):
1101
          return 1
1102
      base_category = category.split('/', 1)[0] # Extract base_category for optimisation
1103
      if strict_membership:
1104
        for c in self.getAcquiredCategoryMembershipList(context, base_category=base_category):
1105
          if c == category:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1106 1107
            return 1
      else:
1108 1109 1110
        for c in self.getAcquiredCategoryMembershipList(context, base_category=base_category):
          if c == category or c.startswith(category + '/'):
            return 1
1111 1112 1113
      return 0

    security.declareProtected( Permissions.AccessContentsInformation, 'isAcquiredMemberOf' )
1114
    def isAcquiredMemberOf(self, context, category, strict=0):
1115 1116 1117 1118 1119 1120
      """
        Tests if an object if member of a given category
        Category is a string here. It could be more than a string (ex. an object)
      """
      if getattr(aq_base(context), 'isCategory', 0):
        return context.isAcquiredMemberOf(category)
1121 1122 1123 1124 1125 1126 1127 1128
      if strict:
        for c in self._getAcquiredCategoryList(context):
          if c == category:
            return 1
      else:
        for c in self._getAcquiredCategoryList(context):
          if c.find(category) >= 0:
            return 1
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1129 1130
      return 0

1131 1132 1133 1134 1135 1136 1137 1138 1139 1140
    security.declareProtected( Permissions.AccessContentsInformation, 'isAcquiredMemberOf' )
    def isAcquiredMemberOf(self, context, category):
      """
        Tests if an object if member of a given category
        Category is a string here. It could be more than a string (ex. an object)

        XXX Should include acquisition ?
      """
      if getattr(aq_base(context), 'isCategory', 0):
        return context.isAcquiredMemberOf(category)
1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155
      for c in self._getAcquiredCategoryList(context):
        if c.find(category) >= 0:
          return 1
      return 0

    security.declareProtected( Permissions.AccessContentsInformation, 'isAcquiredMemberOf' )
    def isAcquiredMemberOf(self, context, category):
      """
        Tests if an object if member of a given category
        Category is a string here. It could be more than a string (ex. an object)

        XXX Should include acquisition ?
      """
      if getattr(aq_base(context), 'isCategory', 0):
        return context.isAcquiredMemberOf(category)
1156 1157 1158 1159 1160
      for c in self._getAcquiredCategoryList(context):
        if c.find(category) >= 0:
          return 1
      return 0

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1161 1162 1163 1164 1165 1166 1167
    security.declareProtected( Permissions.AccessContentsInformation, 'getCategoryList' )
    def getCategoryList(self, context):
      self._cleanupCategories(context)
      return self._getCategoryList(context)

    security.declareProtected( Permissions.AccessContentsInformation, '_getCategoryList' )
    def _getCategoryList(self, context):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1168 1169
      if getattr(aq_base(context), 'categories', _marker) is not _marker:
        if isinstance(context.categories, tuple):
1170
          result = list(context.categories)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1171
        elif isinstance(context.categories, list):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1172 1173 1174
          result = context.categories
        else:
          result = []
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1175
      elif isinstance(context, dict):
1176
        result = list(context.get('categories', []))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1177 1178 1179
      else:
        result = []
      if getattr(context, 'isCategory', 0):
1180 1181 1182
        category_url = context.getRelativeUrl()
        if category_url not in result:
          result.append(context.getRelativeUrl()) # Pure category is member of itself
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199
      return result

    security.declareProtected( Permissions.ModifyPortalContent, '_setCategoryList' )
    def _setCategoryList(self, context, value):
       context.categories = tuple(value)

    security.declareProtected( Permissions.AccessContentsInformation, 'getAcquiredCategoryList' )
    def getAcquiredCategoryList(self, context):
      """
        Returns the list of acquired categories
      """
      self._cleanupCategories(context)
      return self._getAcquiredCategoryList(context)

    security.declareProtected( Permissions.AccessContentsInformation, '_getAcquiredCategoryList' )
    def _getAcquiredCategoryList(self, context):
      result = self.getAcquiredCategoryMembershipList(context,
1200
                     base_category = self.getBaseCategoryList(context=context))
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1201
      append = result.append
1202 1203 1204 1205
      non_acquired = self._getCategoryList(context)
      for c in non_acquired:
        # Make sure all local categories are considered
        if c not in result:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1206
          append(c)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1207
      if getattr(context, 'isCategory', 0):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1208
        append(context.getRelativeUrl()) # Pure category is member of itself
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1209 1210 1211 1212 1213 1214 1215 1216
      return result

    security.declareProtected( Permissions.ModifyPortalContent, '_cleanupCategories' )
    def _cleanupCategories(self, context):
      # Make sure _cleanupCategories does not modify objects each time it is called
      # or we get many conflicts
      requires_update = 0
      categories = []
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1217
      append = categories.append
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1218
      if getattr(context, 'categories', _marker) is not _marker:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1219
        for cat in self._getCategoryList(context):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1220
          if isinstance(cat, str):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1221
            append(cat)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1222 1223 1224 1225 1226
          else:
            requires_update = 1
      if requires_update: self._setCategoryList(context, tuple(categories))

    # Catalog related methods
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1227
    def updateRelatedCategory(self, category, previous_category_url, new_category_url):
1228 1229 1230 1231
      new_category = re.sub('^%s$' %
            previous_category_url,'%s' % new_category_url,category)
      new_category = re.sub('^%s/(?P<stop>.*)' %
            previous_category_url,'%s/\g<stop>' % new_category_url,new_category)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1232
      new_category = re.sub('(?P<start>.*)/%s/(?P<stop>.*)' %
1233
            previous_category_url,'\g<start>/%s/\g<stop>' % new_category_url,new_category)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1234 1235
      new_category = re.sub('(?P<start>.*)/%s$' %
            previous_category_url,'\g<start>/%s' % new_category_url, new_category)
1236 1237
      return new_category

1238 1239 1240
    def updateRelatedContent(self, context,
                             previous_category_url, new_category_url):
      """Updates related object when an object have moved.
1241

1242 1243 1244 1245 1246 1247
          o context: the moved object
          o previous_category_url: the related url of this object before
            the move
          o new_category_url: the related url of the object after the move

      TODO: make this method resist to very large updates (ie. long transaction)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1248
      """
1249 1250
      for brain in self.Base_zSearchRelatedObjectsByCategory(
                                              category_uid = context.getUid()):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1251
        o = brain.getObject()
1252 1253 1254
        if o is not None:
          category_list = []
          for category in self.getCategoryList(o):
1255 1256 1257
            new_category = self.updateRelatedCategory(category,
                                                      previous_category_url,
                                                      new_category_url)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1258
            category_list.append(new_category)
1259
          self._setCategoryList(o, category_list)
1260

1261 1262
          if getattr(aq_base(o),
                    'notifyAfterUpdateRelatedContent', None) is not None:
1263 1264 1265
            o.notifyAfterUpdateRelatedContent(previous_category_url,
                                              new_category_url)

1266
        else:
1267 1268 1269
          LOG('CMFCategory', PROBLEM,
              'updateRelatedContent: %s does not exist' % brain.path)

1270
      aq_context = aq_base(context)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1271
      # Update related recursively if required
1272
      if getattr(aq_context, 'listFolderContents', None) is not None:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1273
        for o in context.listFolderContents():
1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287
          new_o_category_url = o.getRelativeUrl()
          # Relative Url is based on parent new_category_url so we must
          # replace new_category_url with previous_category_url to find
          # the new category_url for the subobject
          previous_o_category_url = self.updateRelatedCategory(
                                                   new_o_category_url,
                                                   new_category_url,
                                                   previous_category_url)

          self.updateRelatedContent(o, previous_o_category_url,
                                    new_o_category_url)

    security.declareProtected( Permissions.AccessContentsInformation,
                               'getRelatedValueList' )
1288
    def getRelatedValueList(self, context, base_category_list=None,
1289
                            spec=(), filter=None, base=1, 
1290
                            checked_permission=None, **kw):
1291 1292 1293 1294
      """
        This methods returns the list of objects related to the context
        with the given base_category_list.
      """
1295
      strict_membership = kw.get('strict_membership', kw.get('strict', 0))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1296
      portal_type = kw.get('portal_type')
1297

Yoshinori Okuji's avatar
Yoshinori Okuji committed
1298
      if isinstance(portal_type, str):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1299
        portal_type = [portal_type]
1300 1301 1302
      if spec is (): 
        # We do not want to care about spec
        spec = None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1303

1304 1305 1306 1307
      # Base Category may not be related, besides sub categories
      if context.getPortalType() == 'Base Category':
        category_list = [context.getRelativeUrl()]
      else:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1308
        if isinstance(base_category_list, str):
1309 1310 1311 1312 1313 1314
          base_category_list = [base_category_list]
        elif base_category_list is () or base_category_list is None:
          base_category_list = self.getBaseCategoryList()
        category_list = []
        for base_category in base_category_list:
          category_list.append("%s/%s" % (base_category, context.getRelativeUrl()))
1315

1316 1317 1318 1319
      brain_result = self.Base_zSearchRelatedObjectsByCategoryList(
                           category_list=category_list,
                           portal_type=portal_type,
                           strict_membership=strict_membership)
1320

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1321
      result = []
1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339
      if checked_permission is None:
        # No permission to check
        for b in brain_result:
          o = b.getObject()
          if o is not None:
            result.append(o)
      else:
        # Check permissions on object
        if isinstance(checked_permission, str):
          checked_permission = (checked_permission, )
          checkPermission = self.portal_membership.checkPermission
          for b in brain_result:
            obj = b.getObject()
            if obj is not None:
              for permission in checked_permission:
                if not checkPermission(permission, obj):
                  break
                result.append(obj)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1340 1341

      return result
1342 1343 1344
      # XXX missing filter and **kw stuff
      #return self.search_category(category_list=category_list,
      #                            portal_type=spec)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1345
      # future implementation with brains, much more efficient
1346

1347 1348 1349
    security.declareProtected( Permissions.AccessContentsInformation,
                               'getRelatedPropertyList' )
    def getRelatedPropertyList(self, context, base_category_list=None,
1350
                               property_name=None, spec=(), 
1351 1352
                               filter=None, base=1, 
                               checked_permission=None, **kw):
1353 1354 1355 1356 1357
      """
        This methods returns the list of property_name on  objects
        related to the context with the given base_category_list.
      """
      result = []
1358 1359
      for o in self.getRelatedValueList(
                          context=context,
1360
                          base_category_list=base_category_list, spec=spec,
1361 1362
                          filter=filter, base=base, 
                          checked_permission=checked_permission, **kw):
1363 1364
        result.append(o.getProperty(property_name, None))
      return result
1365

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1366 1367
    # SQL Expression Building
    security.declareProtected(Permissions.AccessContentsInformation, 'buildSQLSelector')
1368
    def buildSQLSelector(self, category_list, query_table='category'):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1369 1370 1371 1372
      """
        Returns an SQL selector expression from a list of categories
        We make here a simple method wich simply checks membership
        This is like an OR. More complex selections (AND of OR) will require
1373
        to generate a much more complex where_expression with table aliases
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1374 1375 1376

        List of lists
      """
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1377
      if isinstance(category_list, str):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1378 1379 1380 1381 1382
        category_list = [category_list]
      sql_expr = []
      for category in category_list:
        if category is None:
          pass
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1383 1384
        elif isinstance(category, str):
          if category:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1385 1386
            category_uid = self.getCategoryUid(category)
            base_category_uid = self.getBaseCategoryUid(category)
1387 1388 1389 1390 1391 1392 1393 1394 1395
            expression = ''
            if category_uid is None:
              expression += '%s.category_uid is NULL' % query_table
            else:
              expression += '%s.category_uid = %s' % (query_table,category_uid)
            if base_category_uid is None:
              expression += ' AND %s.base_category_uid is NULL' % query_table
            else:
              expression += ' AND %s.base_category_uid = %s' % (query_table,base_category_uid)
1396
            sql_expr += ["(%s)" % expression]
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1397 1398 1399 1400 1401 1402
        else:
          single_sql_expr = []
          for single_category in category:
            if single_sql_expr != '':
              category_uid = self.getCategoryUid(single_category)
              base_category_uid = self.getBaseCategoryUid(single_category)
1403 1404 1405 1406 1407 1408 1409 1410
              if category_uid is None:
                expression += '%s.category_uid is NULL' % query_table
              else:
                expression += '%s.category_uid = %s' % (query_table,category_uid)
              if base_category_uid is None:
                expression += ' AND %s.base_category_uid is NULL' % query_table
              else:
                expression += ' AND %s.base_category_uid = %s' % (query_table,base_category_uid)
1411
              single_sql_expr += ["(%s)" % expression]
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1412
          if len(single_sql_expr) > 0:
1413
            sql_expr += "( %s )" % ' OR '.join(single_sql_expr)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1414
      if len(sql_expr) > 0:
1415
        sql_expr = ' OR '.join(sql_expr)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1416 1417 1418
      return sql_expr

    security.declareProtected( Permissions.AccessContentsInformation, 'getCategoryMemberValueList' )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1419
    def getCategoryMemberValueList(self, context, base_category = None,
1420
                                         spec = (), filter=None, portal_type=(), **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1421 1422 1423
      """
      This returns a catalog_search resource with can then be used by getCategoryMemberItemList
      """
Kevin Deldycke's avatar
Kevin Deldycke committed
1424
      if base_category is None:
1425
        if context.getPortalType() in ( "Base Category", "Category") :
Kevin Deldycke's avatar
Kevin Deldycke committed
1426 1427 1428
          base_category = context.getBaseCategoryId()
        else:
          raise CategoryError('getCategoryMemberValueList must know the base category')
1429
      strict_membership = kw.get('strict_membership', kw.get('strict', 0))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1430

1431
      domain_dict = {base_category: ('portal_categories', context.getRelativeUrl())}
1432 1433
      if strict_membership:
        catalog_search = self.portal_catalog(portal_type = portal_type,
1434
                           selection_report = domain_dict)
1435 1436
      else:
        catalog_search = self.portal_catalog(portal_type = portal_type,
1437
                           selection_domain = domain_dict)
1438

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1439 1440 1441
      return catalog_search

    security.declareProtected( Permissions.AccessContentsInformation, 'getCategoryMemberItemList' )
1442
    def getCategoryMemberItemList(self, context, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1443
      """
1444 1445 1446
      This returns a list of items belonging to a category.
      The following parameters are accepted :
        portal_type       : returns only objects from the given portal_type
1447
        strict_membership : returns only object belonging to this category, not
1448 1449
                            objects belonging to child categories.
        strict            : a deprecated alias for strict_membership
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1450
      """
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1451
      k = {}
1452
      for v in ('portal_type', 'spec', 'strict', 'strict_membership'):
1453
        if v in kw:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1454 1455
          k[v] = kw[v]
      catalog_search = self.getCategoryMemberValueList(context, **k)
1456
      return Renderer(**kw).render(catalog_search)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1457 1458 1459

    security.declareProtected( Permissions.AccessContentsInformation,
                                                                'getCategoryMemberTitleItemList' )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1460
    def getCategoryMemberTitleItemList(self, context, base_category = None,
1461
                                      spec = (), filter=None, portal_type=(), strict_membership = 0,
1462
                                      strict="DEPRECATED"):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1463 1464 1465 1466
      """
      This returns a title list of items belonging to a category

      """
1467
      return self.getCategoryMemberItemList(self, context, base_category = base_category,
1468
                                spec = spec, filter=filter, portal_type=portal_type,
1469 1470
                                strict_membership = strict_membership, strict = strict,
                                display_id = 'getTitle')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1471 1472


1473
    security.declarePublic('resolveCategory')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1474 1475 1476
    def resolveCategory(self, relative_url):
        """
          Finds an object from a relative_url
1477
          Method is public since we use restrictedTraverse
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1478
        """
1479
        cache = getReadOnlyTransactionCache(self)
1480 1481 1482 1483 1484 1485
        if cache is not None:
          key = ('resolveCategory', relative_url)
          try:
            return cache[key]
          except KeyError:
            pass
1486

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1487 1488 1489 1490 1491 1492 1493 1494
        try:
          obj = self.restrictedTraverse(relative_url)
          if obj is None:
            REQUEST = self.REQUEST
            url = '%s/%s' % ('/'.join(self.getPhysicalPath()), relative_url)
            #LOG("CMFCategory:",0,"Trying url %s" % url )
            obj = self.portal_catalog.resolve_url(url, REQUEST)
          #LOG('Obj type', 0, str(obj.getUid()))
1495
          value = obj
1496
        except (KeyError, AttributeError) :
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1497
          LOG("CMFCategory WARNING",0,"Could not access object relative_url %s" % relative_url )
1498
          value = None
1499

1500 1501
        if cache is not None:
          cache[key] = value
1502

1503
        return value
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1504 1505 1506 1507

InitializeClass( CategoryTool )

# Psyco
1508
from Products.ERP5Type.PsycoWrapper import psyco
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1509
psyco.bind(CategoryTool)