CategoryTool.py 63.2 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 getTransactionCache
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 50 51 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 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94

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
      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::

        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'
95
    portal_type     = 'Category Tool'
Jean-Paul Smets's avatar
Jean-Paul Smets committed
96 97 98 99 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
    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
147 148
    security.declareProtected(Permissions.AccessContentsInformation, 'getBaseCategoryList')
    def getBaseCategoryList(self, context=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
149 150 151 152 153 154 155 156 157 158 159 160 161 162
      """
        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:
163
        return context._categories # XXX Incompatible with ERP5Type per portal type categories
Jean-Paul Smets's avatar
Jean-Paul Smets committed
164 165

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

    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:
187
        return map(lambda x:self[x], context._categories) # XXX Incompatible with ERP5Type per portal type categories
Jean-Paul Smets's avatar
Jean-Paul Smets committed
188 189 190 191 192 193 194 195 196 197 198 199 200 201

    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
      """
202 203 204 205 206 207 208 209
      cache = getTransactionCache(self)
      if cache is not None:
        key = ('getCategoryValue', relative_url, base_category)
        try:
          return cache[key]
        except KeyError:
          pass
          
Jean-Paul Smets's avatar
Jean-Paul Smets committed
210 211 212
      try:
        relative_url = str(relative_url)
        if base_category is not None:
Romain Courteaud's avatar
Romain Courteaud committed
213 214
          relative_url = '%s/%s' % (base_category, relative_url)
        node = self.unrestrictedTraverse(relative_url)
215
        value = node
216
      except (TypeError, KeyError, NotFound):
217 218 219 220 221 222 223
        value = None
        
      if cache is not None:
        cache[key] = value

      return value
        
Romain Courteaud's avatar
Romain Courteaud committed
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239
#     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
240 241 242 243 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

    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:
        return relative_url.split('/')[0]
271
      except KeyError :
Jean-Paul Smets's avatar
Jean-Paul Smets committed
272 273 274 275 276 277 278 279 280 281 282
        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
283
      except (AttributeError, KeyError):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302
        return None

    security.declareProtected(Permissions.AccessContentsInformation, 'getCategoryParentUidList')
    def getCategoryParentUidList(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
      """
      uid_dict = {}
      if type(relative_url) is type('a'): relative_url = (relative_url,)
      for path in relative_url:
        try:
          o = self.getCategoryValue(path, base_category=base_category)
          if o is not None:
303 304
            my_base_category = self.getBaseCategoryId(path)
            bo = self.get(my_base_category, None)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
305 306 307 308 309 310 311 312 313 314 315
            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':
                    o = o.aq_parent
                    uid_dict[(int(o.uid), bo_uid, 0)] = 1 # Non Strict Membership
316
        except (KeyError, AttributeError):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
317 318 319 320 321 322 323 324 325 326 327 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
          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:
356
        base_category_list = self.getBaseCategoryList()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
357 358 359 360 361 362 363 364 365 366 367 368
      elif type(base_category) == type('a'):
        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:
          result += category.getCategoryChildRelativeUrlList(base=base,recursive=recursive)
      return result

    security.declareProtected(Permissions.AccessContentsInformation, 'getPathList')
369 370 371 372
    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
373 374 375 376

    security.declareProtected(Permissions.AccessContentsInformation,
                                                      'getCategoryChildTitleItemList')
    def getCategoryChildTitleItemList(self, base_category=None,
Jean-Paul Smets's avatar
Jean-Paul Smets committed
377
                                recursive=1, base=0, display_none_category=0, sort_id=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
378 379 380 381
      """
      Returns a list of tuples by parsing recursively all categories in a
      given list of base categories. Uses getTitle as default method
      """
382
      return self.getCategoryChildItemList(base_category=base_category, recursive = recursive,base=base,
Jean-Paul Smets's avatar
Jean-Paul Smets committed
383
       display_none_category=display_none_category,display_id='getTitle', sort_id=sort_id)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
384 385 386 387

    security.declareProtected(Permissions.AccessContentsInformation,
                                                      'getCategoryChildIdItemList')
    def getCategoryChildIdItemList(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 getId 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='getId', sort_id=sort_id)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
395 396 397

    security.declareProtected(Permissions.AccessContentsInformation,
                                                      'getCategoryChildItemList')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
398 399
    def getCategoryChildItemList(self, base_category=None, display_id = None,
            recursive=1, base=0, display_none_category=1, 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. Each tuple contains::

Jean-Paul Smets's avatar
Jean-Paul Smets committed
404
        (c.relative_url,c.display_id())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
405 406 407 408 409 410 411 412 413 414

      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
415
      display_id -- method called to build the couple
Jean-Paul Smets's avatar
Jean-Paul Smets committed
416 417 418 419 420 421

      recursive -- if set to 0 do not apply recursively
      """
      if type(base_category) == type('a'):
        base_category_list = [base_category]
      elif base_category is None:
422
        base_category_list = self.getBaseCategoryList()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
423 424
      else:
        base_category_list = base_category
425
      #LOG('getCategoryChildItemList', 0, str(base_category_list))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
426
      if display_none_category:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
427 428 429 430 431 432 433
        result = [('', '')]
      else:
        result = []
      for base_category in base_category_list:
        category = self[base_category]
        if category is not None:
          result += category.getCategoryChildItemList(base=base,recursive=recursive,
Jean-Paul Smets's avatar
Jean-Paul Smets committed
434
                                                            display_id=display_id)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
435 436 437 438 439 440 441 442 443 444
      #if sort_id is not None:
      #  result.sort()

      return result

    security.declareProtected(Permissions.AccessContentsInformation, 'getBaseItemList')
    getBaseItemList = getCategoryChildItemList

    # Category to Tuple Conversion
    security.declareProtected(Permissions.View, 'asItemList')
Sebastien Robin's avatar
Sebastien Robin committed
445
    def asItemList(self, relative_url, base_category=None,**kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
446 447
      """
      Returns a list of tuples, each tuple is calculated by applying
Jean-Paul Smets's avatar
Jean-Paul Smets committed
448
      display_id on each category provided in relative_url
Jean-Paul Smets's avatar
Jean-Paul Smets committed
449 450 451 452 453 454 455 456 457 458

      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
459
      display_id -- method called to build the couple
Jean-Paul Smets's avatar
Jean-Paul Smets committed
460 461 462

      recursive -- if set to 0 do not apply recursively
      """
Sebastien Robin's avatar
Sebastien Robin committed
463 464 465 466
      #if display_id is None:
      #  for c in relative_url:
      #    result += [(c, c)]
      #else:
Romain Courteaud's avatar
Romain Courteaud committed
467
#       LOG('CMFCategoryTool.asItemList, relative_url',0,relative_url)
Sebastien Robin's avatar
Sebastien Robin committed
468 469 470
      value_list = []
      for c in relative_url:
        o = self.getCategoryValue(c, base_category=base_category)
Romain Courteaud's avatar
Romain Courteaud committed
471
#         LOG('CMFCategoryTool.asItemList, (o,c)',0,(o,c))
Sebastien Robin's avatar
Sebastien Robin committed
472 473 474 475
        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
476 477 478 479

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

Romain Courteaud's avatar
Romain Courteaud committed
480
#       LOG('CMFCategoryTool.asItemList, value_list',0,value_list)
Sebastien Robin's avatar
Sebastien Robin committed
481
      return Renderer(base_category=base_category,**kw).render(value_list)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 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):
      if type(category_list) == type('a'):
        category_list = [category_list]
      if category_list == None:
        category_list = []
      new_list = []
      for v in category_list:
        new_list += ['%s/%s' % (base_category,v)]
      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,
507
                                  spec=(), filter=None, **kw  ):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
508 509 510 511 512 513 514 515 516 517 518 519 520 521
      """
        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
522
      # where_expression = self._buildQuery(spec, filter, kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557
      portal_type = kw.get('portal_type', ())
      if spec is (): spec = portal_type

      # LOG('getCategoryMembershipList',0,str(spec))
      # LOG('getCategoryMembershipList',0,str(base_category))
      membership = []
      if type(base_category) not in (type(()), type([])):
        category_list = [base_category]
      else:
        category_list = base_category
      if type(spec) is not type([]) and type(spec) is not type(()):
        spec = [spec]
      for path in self._getCategoryList(context):
        # LOG('getCategoryMembershipList',0,str(path))
        my_base_category = path.split('/')[0]
        for my_category in category_list:
          if type(my_category) is type('a'):
            category = my_category
          else:
            category = my_category.getRelativeUrl()
          if my_base_category == category:
            if spec is ():
              if base:
                membership += [path]
              else:
                membership += [path[len(category)+1:]]
            else:
              try:
               o = self.unrestrictedTraverse(path)
               # LOG('getCategoryMembershipList',0,str(o.portal_type))
               if o.portal_type in spec:
                if base:
                  membership += [path]
                else:
                  membership += [path[len(category)+1:]]
558
              except (KeyError, ):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588
                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:
            membership += ['parent/' + parent.getRelativeUrl()]
          else:
            membership += [parent.getRelativeUrl()]
      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
589
      # where_expression = self._buildQuery(spec, filter, kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
590
      portal_type = kw.get('portal_type', ())
591 592 593 594
      if type(portal_type) == type(''):
        portal_type = (portal_type,)
      if spec is (): 
        spec = portal_type
595
      #LOG("set Category",0,str(category_list))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
596 597 598 599 600 601 602 603 604 605 606 607 608 609 610

      default_dict = {}
      self._cleanupCategories(context)
      if type(category_list) is type('a'):
        category_list = (category_list,)
      elif category_list is None:
        category_list = ()
      if type(base_category_list) is type('a'):
        base_category_list = [base_category_list]
      new_category_list = []
      for path in self._getCategoryList(context):
        my_base_id = self.getBaseCategoryId(path)
        if not my_base_id in base_category_list:
          # Keep each membership which is not in the
          # specified list of base_category ids
611
          new_category_list.append(path)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
612 613 614 615 616 617 618 619 620
        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
621
              keep_it = (my_type not in spec)
622
            except (KeyError, AttributeError):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
623 624
              keep_it = 0
          if keep_it:
625
            new_category_list.append(path)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
626 627 628 629 630 631 632 633 634 635
          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:
636
            default_new_category_list.append(path)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
637 638
        else:
          if path[len(base_category_list[0])+1:] in category_list:
639
            default_new_category_list.append(path)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
640 641 642 643
      # 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:
644
        if path != '':
Jean-Paul Smets's avatar
Jean-Paul Smets committed
645 646 647 648 649
          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
650
                new_category_list.append(path)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
651
          else:
652
            new_path = '/'.join((base_category_list[0], path))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
653
            if new_path not in default_new_category_list:
654
              new_category_list.append(new_path)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
655
      #LOG("set Category",0,str(new_category_list))
656
      #LOG("set Category",0,str(default_new_category_list))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694
      self._setCategoryList(context, tuple(default_new_category_list + new_category_list))

    security.declareProtected( Permissions.AccessContentsInformation, 'setDefaultCategoryMembership' )
    def setDefaultCategoryMembership(self, context, base_category, default_category,
                                              spec=(), filter=None, portal_type=(), base=0 ):
      """
        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)
      if type(default_category) is type([]) or type(default_category) is type(()):
        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:
        if category != default_category or found_one:
          new_category_list += [category]
          found_one = 1
      self.setCategoryMembership(context, base_category, new_category_list,
           spec=spec, filter=filter, portal_type=portal_type, base=base, keep_default = 0)

    security.declareProtected( Permissions.AccessContentsInformation,
                                                        'getSingleCategoryMembershipList' )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
695
    def getSingleCategoryMembershipList(self, context, base_category, base=0,
Jean-Paul Smets's avatar
Jean-Paul Smets committed
696 697 698 699 700 701 702 703 704 705 706 707 708 709 710
                                          spec=(), filter=None, **kw):
      """
        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
      """
      # XXX We must use filters in the future
711
      # where_expression = self._buildQuery(spec, filter, kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
712 713 714
      portal_type = kw.get('portal_type', ())
      if spec is (): spec = portal_type

715
      # We must treat parent in a different way
716
      #LOG('getSingleCategoryMembershipList', 0, 'base_category = %s, spec = %s, base = %s, context = %s, context.aq_parent = %s' % (repr(base_category), repr(spec), repr(base), repr(context), repr(context.aq_parent)))
717 718 719 720 721 722 723
      if base_category == 'parent':
        parent = context.aq_parent # aq_inner ?
        if parent.portal_type in spec:
          if base:
            return ['parent/' + parent.getRelativeUrl()]
          else:
            return [parent.getRelativeUrl()]
724 725 726
        #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
727
      result = []
Yoshinori Okuji's avatar
Yoshinori Okuji committed
728
      append = result.append
Jean-Paul Smets's avatar
Jean-Paul Smets committed
729
      # XXX We must use filters in the future
730
      # where_expression = self._buildQuery(spec, filter, kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
731 732 733 734 735 736 737
      spec = kw.get('portal_type', ())
      # Make sure spec is a list or tuple
      if type(spec) is type('a'):
        spec = [spec]
      # Filter categories
      if hasattr(context, 'categories'):
        for category_url in self._getCategoryList(context):
738 739 740 741 742
          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
743
          if my_base_category == base_category:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
744
            #LOG("getSingleCategoryMembershipList",0,"%s %s %s %s" % (context.getRelativeUrl(),
Jean-Paul Smets's avatar
Jean-Paul Smets committed
745
            #                  my_base_category, base_category, category_url))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
746 747
            if spec is ():
              if base:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
748
                append(category_url)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
749
              else:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
750
                append(category_url[len(my_base_category)+1:])
Jean-Paul Smets's avatar
Jean-Paul Smets committed
751 752 753 754 755 756 757 758 759
            else:
              try:
                my_reference = self.unrestrictedTraverse(category_url)
              except KeyError:
                # object does not exist
                my_reference = None
              if my_reference is not None:
                if my_reference.portal_type in spec:
                  if base:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
760
                    append(category_url)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
761
                  else:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
762
                    append(category_url[len(my_base_category)+1:])
Jean-Paul Smets's avatar
Jean-Paul Smets committed
763 764 765 766
      return result

    security.declareProtected( Permissions.AccessContentsInformation,
                                      'getSingleCategoryAcquiredMembershipList' )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
767
    def getSingleCategoryAcquiredMembershipList(self, context, base_category, base=0,
768
                                         spec=(), filter=None, acquired_object_dict = None, **kw ):
769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789
      cache = getTransactionCache(self)
      if cache is not None:
        key = ('getSingleCategoryAcquiredMembershipList', context._p_oid, base_category, base, spec, 
               filter, str(kw))
        try:
          return cache[key]
        except KeyError:
          pass
          
      result = self._getSingleCategoryAcquiredMembershipList(context, base_category, base=base,
                                                             spec=spec, filter=filter, 
                                                             acquired_object_dict = acquired_object_dict,
                                                             **kw)
      if cache is not None:
        cache[key] = result
        
      return result
      
                                      
    def _getSingleCategoryAcquiredMembershipList(self, context, base_category, base=0,
                                         spec=(), filter=None, acquired_object_dict = None, **kw ):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
790 791 792 793 794 795 796 797 798 799 800 801
      """
        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
802

803 804 805 806 807
        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

808 809 810 811 812 813 814 815
        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
816
      """
817 818
      #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
819
      # XXX We must use filters in the future
820
      # where_expression = self._buildQuery(spec, filter, kw)
821

Jean-Paul Smets's avatar
Jean-Paul Smets committed
822
      portal_type = kw.get('portal_type', ())
823
      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
824 825 826

      if type(spec) is type('a'):
        spec = [spec]
827

828
      if acquired_object_dict is None:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
829 830 831 832
        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
833 834
          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
835 836
          if spec is ():
            if () in type_dict:
837 838
              return []
            else:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
839
              type_dict[()] = 1
840
          else:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
841 842 843 844 845
            for pt in spec:
              if pt in type_dict:
                return []
              else:
                type_dict[pt] = 1
Yoshinori Okuji's avatar
Yoshinori Okuji committed
846
          acquired_object_dict[context_base_key] = type_dict
847
        else:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
848 849 850 851 852
          type_dict = {}
          if spec is ():
            type_dict[()] = 1
          else:
            for pt in spec:
853
              type_dict[pt] = 1
Yoshinori Okuji's avatar
Yoshinori Okuji committed
854
          acquired_object_dict = acquired_object_dict.copy()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
855
          acquired_object_dict[context_base_key] = type_dict
856

Jean-Paul Smets's avatar
Jean-Paul Smets committed
857
      result = self.getSingleCategoryMembershipList( context, base_category, base=base,
858 859 860
                            spec=spec, filter=filter, **kw ) # Not acquired because this is the first try
                                                             # to get a local defined category
                            
861
      base_category_value = self.getCategoryValue(base_category)
862 863
      #LOG("base_category_value",0,str(base_category_value))
      #LOG("result",0,str(result))
864
      if base_category_value is not None:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
865
        # If we do not mask or append, return now if not empty
866 867
        if base_category_value.getAcquisitionMaskValue() and \
                not base_category_value.getAcquisitionAppendValue() and \
Jean-Paul Smets's avatar
Jean-Paul Smets committed
868
                len(result) > 0:
869
          # If acquisition masks and we do not append values, then we must return now
Jean-Paul Smets's avatar
Jean-Paul Smets committed
870 871
          return result
        # First we look at local ids
872
        for object_id in base_category_value.getAcquisitionObjectIdList():
873
          my_acquisition_object = getattr(context,object_id,None)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
874
          if my_acquisition_object is not None:
875 876 877
            #my_acquisition_object_path = my_acquisition_object.getPhysicalPath()
            #if my_acquisition_object_path in acquired_object_dict:
            #  continue
878
            #acquired_object_dict[my_acquisition_object_path] = 1
879
            if my_acquisition_object.portal_type in base_category_value.getAcquisitionPortalTypeList():
880 881 882 883
              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 = []
884 885 886 887
            #if base_category_value.acquisition_mask_value:
            #  # If acquisition masks, then we must return now
            #  return new_result
            if base_category_value.acquisition_append_value:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
888
              # If acquisition appends, then we must append to the result
Yoshinori Okuji's avatar
Yoshinori Okuji committed
889
              result.extend(new_result)
890 891
            elif len(new_result) > 0:
              return new_result # Found enough information to return
Jean-Paul Smets's avatar
Jean-Paul Smets committed
892
        # Next we look at references
893
        #LOG("Get Acquired BC",0,base_category_value.getAcquisitionBaseCategoryList())
894
        acquisition_base_category_list = base_category_value.getAcquisitionBaseCategoryList()
895
        alt_base_category_list = base_category_value.getFallbackBaseCategoryList()
896
        all_acquisition_base_category_list = acquisition_base_category_list + alt_base_category_list
897 898
        acquisition_pt = base_category_value.getAcquisitionPortalTypeList(())
        for my_base_category in base_category_value.getAcquisitionBaseCategoryList():
899
        #for my_base_category in all_acquisition_base_category_list:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
900
          # We implement here special keywords
Jean-Paul Smets's avatar
Jean-Paul Smets committed
901
          if my_base_category == 'parent':
Jean-Paul Smets's avatar
Jean-Paul Smets committed
902 903 904 905
            parent = context.aq_parent
            if parent is self.getPortalObject():
              my_acquisition_object_list = []
            else:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
906 907 908
              #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))
909 910
              #my_acquisition_object_path = parent.getPhysicalPath()
              #if my_acquisition_object_path in acquired_object_dict:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
911
              if acquisition_pt is () or parent.portal_type in acquisition_pt:
912
                my_acquisition_object_list = [parent]
Jean-Paul Smets's avatar
Jean-Paul Smets committed
913 914
              else:
                my_acquisition_object_list = []
915 916
              #else:
              #  my_acquisition_object_list = []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
917
          else:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
918
            #LOG('getAcquiredCategoryMembershipList', 0, 'my_acquisition_object = %s, acquired_object_dict = %s' % (str(context), str(acquired_object_dict)))
Yoshinori Okuji's avatar
Yoshinori Okuji committed
919
            my_acquisition_list = self.getSingleCategoryAcquiredMembershipList(context,
920
                        my_base_category,
921
                        portal_type=tuple(base_category_value.getAcquisitionPortalTypeList(())),
922 923
                        acquired_object_dict=acquired_object_dict)
            my_acquisition_object_list = []
Yoshinori Okuji's avatar
Yoshinori Okuji committed
924
            for c in my_acquisition_list:
925 926 927 928 929
              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
930 931
          #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
932 933 934
          original_result = result
          result = list(result) # make a copy
          for my_acquisition_object in my_acquisition_object_list:
935
            #LOG('getSingleCategoryAcquiredMembershipList', 0, 'my_acquisition_object = %s, acquired_object_dict = %s' % (str(my_acquisition_object), str(acquired_object_dict)))
936 937
            #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__()))
938
            #if my_acquisition_object is not None:
939
            if my_acquisition_object is not None:
940 941 942 943
              #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
944
              #if hasattr(my_acquisition_object, '_categories'): # This would be a bug since we have category acquisition
Jean-Paul Smets's avatar
Jean-Paul Smets committed
945
                # We should only consider objects which define that category
946 947 948
                #LOG('my_acquisition_object',0, str(getattr(my_acquisition_object, '_categories', ())))
                #LOG('my_acquisition_object',0, str(base_category))
                if base_category in getattr(my_acquisition_object, '_categories', ()):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
949
                  if spec is () or my_acquisition_object.portal_type in spec:
950
                    #LOG("Recursive call ",0,str((spec, my_acquisition_object.portal_type)))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
951
                    new_result = self.getSingleCategoryAcquiredMembershipList(my_acquisition_object,
952 953
                        base_category, spec=spec, filter=filter, portal_type=portal_type, base=base,
                        acquired_object_dict=acquired_object_dict)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
954
                  else:
955
                    #LOG("No recursive call ",0,str((spec, my_acquisition_object.portal_type)))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
956
                    new_result = []
957
                  if base_category_value.acquisition_append_value:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
958
                    # If acquisition appends, then we must append to the result
Yoshinori Okuji's avatar
Yoshinori Okuji committed
959
                    result.extend(new_result)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
960
                  elif len(new_result) > 0:
961
                    #LOG("new_result ",0,str(new_result))
962 963
                    if (base_category_value.acquisition_copy_value and len(original_result) == 0) \
                                                    or base_category_value.acquisition_sync_value:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
964 965
                      # If copy is set and result was empty, then copy it once
                      # If sync is set, then copy it again
966
                      self.setCategoryMembership( context, base_category, new_result,
Jean-Paul Smets's avatar
Jean-Paul Smets committed
967 968 969
                                    spec=spec, filter=filter, portal_type=portal_type, base=base )
                    # We found it, we can return
                    return new_result
970 971


972
          if (base_category_value.acquisition_copy_value or base_category_value.acquisition_sync_value)\
Jean-Paul Smets's avatar
Jean-Paul Smets committed
973 974 975
                                                         and len(result) > 0:
            # If copy is set and result was empty, then copy it once
            # If sync is set, then copy it again
976
            self.setCategoryMembership( context, base_category, result,
Jean-Paul Smets's avatar
Jean-Paul Smets committed
977
                                         spec=spec, filter=filter, portal_type=portal_type, base=base )
978
        if len(result)==0 and len(base_category_value.getFallbackBaseCategoryList())>0:
979
          # We must then try to use the alt base category
980
          for base_category in base_category_value.getFallbackBaseCategoryList():
981 982 983 984
            # 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
985
            category_value_list = [self.resolveCategory(x) for x in category_list]
986 987
            # Then build the alternate category
            if base:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
988 989
              base_category_id = base_category_value.getId()
              for category_value in category_value_list:
990
                if category_value is None :
991 992 993 994
                  message = "category does not exists for %s (%s)"%(
                                       context.getPath(), category_list)
                  LOG('CMFCategory', PROBLEM, message)
                  raise CategoryError (message)
995 996 997
                else :
                  result.append('%s/%s' % (base_category_id, category_value.getRelativeUrl()))
            else :
Yoshinori Okuji's avatar
Yoshinori Okuji committed
998
              for category_value in category_value_list:
999 1000 1001 1002 1003 1004 1005
                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
1006 1007 1008
      # WE MUST IMPLEMENT HERE THE REST OF THE SEMANTICS
      #LOG("Get Acquired Category Result ",0,str(result))
      return result
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1009
      
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1010 1011
    security.declareProtected( Permissions.AccessContentsInformation,
                                               'getAcquiredCategoryMembershipList' )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1012
    def getAcquiredCategoryMembershipList(self, context, base_category = None, base=1,
1013
                                          spec=(), filter=None, acquired_object_dict=None, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1014 1015 1016
      """
        Returns all acquired category values
      """
1017
      #LOG("Get Acquired Category List", 0, "%s %s" % (base_category, context.getRelativeUrl()))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1018
      result = []
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1019
      extend = result.extend
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1020
      if base_category is None:
1021
        base_category_list = context._categories # XXX incompatible with ERP5Type per portal categories
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1022 1023
      elif type(base_category) is type('a'):
        base_category_list = [base_category]
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1024
      else:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1025
        base_category_list = base_category
1026
      #LOG('CT.getAcquiredCategoryMembershipList base_category_list',0,base_category_list)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1027
      getSingleCategoryAcquiredMembershipList = self.getSingleCategoryAcquiredMembershipList
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1028
      for base_category in base_category_list:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1029 1030
        extend(getSingleCategoryAcquiredMembershipList(context, base_category, base=base,
                                    spec=spec, filter=filter, acquired_object_dict=acquired_object_dict, **kw ))
1031
        #LOG('CT.getAcquiredCategoryMembershipList new result',0,result)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1032 1033 1034
      return result

    security.declareProtected( Permissions.AccessContentsInformation, 'isMemberOf' )
1035
    def isMemberOf(self, context, category, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1036 1037 1038
      """
        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)
1039 1040 1041 1042 1043 1044
        
        Keywords parameters : 
         - strict_membership:  if we want strict membership checking
         - strict : alias for strict_membership (deprecated but still here for 
                    skins backward compatibility. )
 
1045 1046 1047
        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
1048
      """
1049
      strict_membership = kw.get('strict_membership', kw.get('strict', 0))
1050
      if getattr(aq_base(context), 'isCategory', 0) :
1051
        if context.isMemberOf(category, strict_membership = strict_membership) == 1 :
1052
          return 1
1053
      base_category = category.split('/')[0] # Extract base_category for optimisation
1054
      if strict_membership:
1055
        for c in self.getAcquiredCategoryMembershipList(context, base_category = base_category):
1056
          if c == category:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1057 1058
            return 1
      else:
1059
        for c in self.getAcquiredCategoryMembershipList(context, base_category = base_category): 
1060 1061 1062 1063 1064 1065 1066 1067 1068 1069
          if c.find(category) == 0:
            # The names begin with the same string
            c_right_split = c.split(category)[1]
            if (len(c_right_split) > 0):
              # Be sure that we have a sub category, and not name like this: 'europe1' in 'europe10'
              if c_right_split[0] == '/':
                return 1
            else:
              # Same category
              return 1
1070 1071 1072
      return 0

    security.declareProtected( Permissions.AccessContentsInformation, 'isAcquiredMemberOf' )
1073
    def isAcquiredMemberOf(self, context, category, strict=0):
1074 1075 1076 1077 1078 1079
      """
        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)
1080 1081 1082 1083 1084 1085 1086 1087
      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
1088 1089
      return 0

1090 1091 1092 1093 1094 1095 1096 1097 1098 1099
    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)
1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114
      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)
1115 1116 1117 1118 1119
      for c in self._getAcquiredCategoryList(context):
        if c.find(category) >= 0:
          return 1
      return 0

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1120 1121 1122 1123 1124 1125 1126 1127 1128
    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):
      if hasattr(context, 'categories'):
        if type(context.categories) == type((1,)):
1129
          result = list(context.categories)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1130 1131 1132 1133 1134
        elif type(context.categories) == type([]):
          result = context.categories
        else:
          result = []
      elif type(context) is type({}):
1135
        result = list(context.get('categories', []))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1136 1137 1138
      else:
        result = []
      if getattr(context, 'isCategory', 0):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1139
        result.append(context.getRelativeUrl()) # Pure category is member of itself
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156
      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,
1157
                     base_category = self.getBaseCategoryList(context=context))
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1158
      append = result.append
1159 1160 1161 1162
      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
1163
          append(c)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1164
      if getattr(context, 'isCategory', 0):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1165
        append(context.getRelativeUrl()) # Pure category is member of itself
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1166 1167 1168 1169 1170 1171 1172 1173
      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
1174
      append = categories.append
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1175 1176 1177
      if hasattr(context, 'categories'):
        for cat in self._getCategoryList(context):
          if type(cat) == type('a'):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1178
            append(cat)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1179 1180 1181 1182 1183
          else:
            requires_update = 1
      if requires_update: self._setCategoryList(context, tuple(categories))

    # Catalog related methods
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1184
    def updateRelatedCategory(self, category, previous_category_url, new_category_url):
1185 1186 1187 1188
      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
1189
      new_category = re.sub('(?P<start>.*)/%s/(?P<stop>.*)' %
1190
            previous_category_url,'\g<start>/%s/\g<stop>' % new_category_url,new_category)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1191 1192
      new_category = re.sub('(?P<start>.*)/%s$' %
            previous_category_url,'\g<start>/%s' % new_category_url, new_category)
1193 1194
      return new_category

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1195 1196 1197 1198
    def updateRelatedContent(self, context, previous_category_url, new_category_url):
      """
        TODO: make this method resist to very large updates (ie. long transaction)
      """
1199 1200 1201
      LOG('CMFCategoryTool, context',0,context)
      LOG('CMFCategoryTool, previous_category_url',0,previous_category_url)
      LOG('CMFCategoryTool, new_category_url',0,new_category_url)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1202
      for brain in self.Base_zSearchRelatedObjectsByCategory(category_uid = context.getUid()):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1203
        o = brain.getObject()
1204 1205
        if o is not None:
          category_list = []
1206
          LOG('CMFCategoryTool, previous category_list',0,self.getCategoryList(o))
1207
          for category in self.getCategoryList(o):
1208
            new_category = self.updateRelatedCategory(category,previous_category_url,new_category_url)
1209 1210
            category_list += [new_category]
          self._setCategoryList(o, category_list)
1211
          LOG('CMFCategoryTool, new category_list',0,category_list)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1212 1213
          if hasattr(aq_base(o), 'notifyAfterUpdateRelatedContent'):
            o.notifyAfterUpdateRelatedContent(previous_category_url, new_category_url)
1214 1215
        else:
          LOG('WARNING updateRelatedContent',0,'%s does not exist' % brain.path)
1216
      aq_context = aq_base(context)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1217 1218 1219
      # Update related recursively if required
      if hasattr(aq_context, 'listFolderContents'):
        for o in context.listFolderContents():
1220 1221
          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
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1222
          # the previous category_url for a
1223 1224 1225
          previous_o_category_url = self.updateRelatedCategory(new_o_category_url,new_category_url,previous_category_url)
          #previous_o_category_url = re.sub('(?P<start>.*)/%s$' %
          #     new_category_url,'\g<start>/%s' % previous_category_url, new_o_category_url)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1226 1227
          self.updateRelatedContent(o, previous_o_category_url, new_o_category_url)

1228
    security.declareProtected( Permissions.AccessContentsInformation, 'getRelatedValueList' )
1229 1230 1231 1232 1233 1234
    def getRelatedValueList(self, context, base_category_list=None,
                           spec=(), filter=None, base=1, **kw):
      """
        This methods returns the list of objects related to the context
        with the given base_category_list.
      """
1235
      strict_membership = kw.get('strict_membership', kw.get('strict', 0))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1236
      portal_type = kw.get('portal_type')
1237
      
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1238 1239 1240 1241
      if type(portal_type) is type('a'):
        portal_type = [portal_type]
      if spec is (): spec = None # We do not want to care about spec

1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252
      # Base Category may not be related, besides sub categories
      if context.getPortalType() == 'Base Category':
        category_list = [context.getRelativeUrl()]
      else:
        if type(base_category_list) is type('a'):
          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()))
1253
      
1254 1255 1256 1257 1258
      brain_result = self.Base_zSearchRelatedObjectsByCategoryList(
                           category_list = category_list,
                           portal_type = portal_type,
                           strict_membership = strict_membership )
      
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1259 1260 1261 1262 1263 1264 1265 1266 1267 1268
      result = []
      for b in brain_result:
        o = b.getObject()
        if o is not None:
          result.append(o)

      return result
                                  # XXX missing filter and **kw stuff
      #return self.search_category(category_list = category_list, portal_type = spec)
      # future implementation with brains, much more efficient
1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284
    
    security.declareProtected( Permissions.AccessContentsInformation,
                               'getRelatedPropertyList' )
    def getRelatedPropertyList(self, context, base_category_list=None,
                          property_name=None, spec=(), filter=None, base=1, **kw):
      """
        This methods returns the list of property_name on  objects
        related to the context with the given base_category_list.
      """
      result = []
      for o in self.getRelatedValueList(context=context,
                          base_category_list=base_category_list, spec=spec,
                          filter=filter, base=base, **kw) :
        result.append(o.getProperty(property_name, None))
      return result
      
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1285 1286
    # SQL Expression Building
    security.declareProtected(Permissions.AccessContentsInformation, 'buildSQLSelector')
1287
    def buildSQLSelector(self, category_list, query_table='category'):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1288 1289 1290 1291
      """
        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
1292
        to generate a much more complex where_expression with table aliases
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305

        List of lists
      """
      if type(category_list) == type('a'):
        category_list = [category_list]
      sql_expr = []
      for category in category_list:
        if category is None:
          pass
        elif type(category) == type('a'):
          if category != '':
            category_uid = self.getCategoryUid(category)
            base_category_uid = self.getBaseCategoryUid(category)
1306 1307 1308 1309 1310 1311 1312 1313 1314
            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)
1315
            sql_expr += ["(%s)" % expression]
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1316 1317 1318 1319 1320 1321
        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)
1322 1323 1324 1325 1326 1327 1328 1329
              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)
1330
              single_sql_expr += ["(%s)" % expression]
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1331
          if len(single_sql_expr) > 0:
1332
            sql_expr += "( %s )" % ' OR '.join(single_sql_expr)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1333
      if len(sql_expr) > 0:
1334
        sql_expr = ' OR '.join(sql_expr)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1335 1336 1337
      return sql_expr

    security.declareProtected( Permissions.AccessContentsInformation, 'getCategoryMemberValueList' )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1338
    def getCategoryMemberValueList(self, context, base_category = None,
1339
                                         spec = (), filter=None, portal_type=(), **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1340 1341 1342
      """
      This returns a catalog_search resource with can then be used by getCategoryMemberItemList
      """
1343
      from Products.ERP5Form.Selection import DomainSelection
1344 1345
      if base_category is None: 
        raise CategoryError('getCategoryMemberValueList must know the base category')
1346 1347 1348 1349
      strict_membership = kw.get('strict_membership', kw.get('strict', 0))
      catalog_search = self.portal_catalog(portal_type = portal_type,
                      # TODO: make it work in catalog tool
                      # category_strict_membership = strict_membership,
1350
                      selection_domain = DomainSelection(domain_dict = {base_category:context}))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1351 1352 1353 1354

      return catalog_search

    security.declareProtected( Permissions.AccessContentsInformation, 'getCategoryMemberItemList' )
1355
    def getCategoryMemberItemList(self, context, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1356
      """
1357 1358 1359 1360 1361 1362
      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
        strict_membership : returns only object belonging to this category, not 
                            objects belonging to child categories.
        strict            : a deprecated alias for strict_membership
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1363
      """
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1364
      k = {}
1365
      for v in ('portal_type', 'spec', 'strict', 'strict_membership'):
1366
        if v in kw:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1367 1368
          k[v] = kw[v]
      catalog_search = self.getCategoryMemberValueList(context, **k)
1369
      return Renderer(**kw).render(catalog_search)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1370 1371 1372

    security.declareProtected( Permissions.AccessContentsInformation,
                                                                'getCategoryMemberTitleItemList' )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1373
    def getCategoryMemberTitleItemList(self, context, base_category = None,
1374 1375
                                      spec = (), filter=None, portal_type=(), strict_membership = 0, 
                                      strict="DEPRECATED"):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1376 1377 1378 1379
      """
      This returns a title list of items belonging to a category

      """
1380
      return self.getCategoryMemberItemList(self, context, base_category = base_category,
1381 1382 1383
                                spec = spec, filter=filter, portal_type=portal_type, 
                                strict_membership = strict_membership, strict = strict,
                                display_id = 'getTitle')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1384 1385


1386
    security.declarePublic('resolveCategory')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1387 1388 1389
    def resolveCategory(self, relative_url):
        """
          Finds an object from a relative_url
1390
          Method is public since we use restrictedTraverse
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1391
        """
1392 1393 1394 1395 1396 1397 1398 1399
        cache = getTransactionCache(self)
        if cache is not None:
          key = ('resolveCategory', relative_url)
          try:
            return cache[key]
          except KeyError:
            pass
            
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1400 1401 1402 1403 1404 1405 1406 1407
        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()))
1408
          value = obj
1409
        except (KeyError, AttributeError) :
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1410
          LOG("CMFCategory WARNING",0,"Could not access object relative_url %s" % relative_url )
1411 1412 1413 1414 1415 1416
          value = None
          
        if cache is not None:
          cache[key] = value
          
        return value
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1417 1418 1419 1420 1421 1422

InitializeClass( CategoryTool )

# Psyco
import psyco
psyco.bind(CategoryTool)