Category.py 20.7 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
#
# 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.
#
##############################################################################

import string

from Globals import InitializeClass, DTMLFile
from AccessControl import ClassSecurityInfo
from Acquisition import aq_base, aq_inner, aq_parent

from Products.ERP5Type import Permissions
from Products.ERP5Type import PropertySheet
37
from Products.ERP5Type.Document.Folder import Folder
38
from Products.CMFCategory.Renderer import Renderer
Jean-Paul Smets's avatar
Jean-Paul Smets committed
39 40 41 42 43 44 45 46 47 48 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 95 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 147 148 149

from zLOG import LOG

manage_addCategoryForm=DTMLFile('dtml/category_add', globals())

def addCategory( self, id, title='', REQUEST=None ):
    """
        Add a new Category and generate UID by calling the
        ZSQLCatalog
    """
    sf = Category( id )
    sf._setTitle(title)
    self._setObject( id, sf )
    sf = self._getOb( id )
    sf.reindexObject()
    if REQUEST is not None:
        return self.manage_main(self, REQUEST, update_menu=1)

class Category(Folder):
    """
        Category objects allow to define classification categories
        in an ERP5 portal. For example, a document may be assigned a color
        attribute (red, blue, green). Rather than assigning an attribute
        with a pop-up menu (which is still a possibility), we can prefer
        in certain cases to associate to the object a category. In this
        example, the category will be named color/red, color/blue or color/green

        Categories can include subcategories. For example, a region category can
        define
            region/europe
            region/europe/west/
            region/europe/west/france
            region/europe/west/germany
            region/europe/south/spain
            region/americas
            region/americas/north
            region/americas/north/us
            region/americas/south
            region/asia

        In this example the base category is 'region'.

        Categories are meant to be indexed with the ZSQLCatalog (and thus
        a unique UID will be automatically generated each time a category is
        indexed).

        Categories allow define sets and subsets of objects and can be used
        for many applications :

        - association of a document to a URL

        - description of organisations (geographical, professional)

        Through acquisition, it is possible to create 'virtual' classifications based
        on existing documents or categories. For example, if there is a document at
        the URL
            organisation/nexedi
        and there exists a base category 'client', then the portal_categories tool
        will allow to create a virtual category
            client/organisation/nexedi

        Virtual categories allow not to duplicate information while providing
        a representation power equivalent to RDF or relational databases.

        Categories are implemented as a subclass of BTreeFolders

        NEW: categories should also be able to act as a domain. We should add
        a Domain interface to categories so that we do not need to regenerate
        report trees for categories.
    """

    meta_type='CMF Category'
    portal_type='Category' # may be useful in the future...
    isPortalContent = 1
    isRADContent = 1
    isCategory = 1
    icon = None

    allowed_types = (
                  'CMF Category',
               )

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

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

    # Declarative constructors
    constructors =   (manage_addCategoryForm, addCategory)

    # Filtered Types allow to define which meta_type subobjects
    # can be created within the ZMI
    def filtered_meta_types(self, user=None):
        # Filters the list of available meta types.
        # so that only Category objects appear inside the
        # CategoryTool contents
        all = Category.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

    security.declareProtected(Permissions.AccessContentsInformation,
150 151
                                                    'getLogicalPath')
    def getLogicalPath(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
152
      """
153
        Returns logical path, starting under base category.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
154
      """
155 156 157 158 159 160
      objectlist = []
      base = self.getBaseCategory()
      current = self
      while not current is base :
        objectlist.insert(0, current)
        current = aq_parent(current)
161 162 163 164 165 166 167 168 169

      # it s better for the user to display something than only ''...
      logical_title_list = []
      for object in objectlist:
        logical_title = object.getTitle()
        if logical_title in [None, '']:
          logical_title = object.getId()
        logical_title_list.append(logical_title)
      return '/'.join(logical_title_list)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
170

171 172
    security.declareProtected(Permissions.AccessContentsInformation,
                                                    'getCategoryChildValueList')
173
    def getCategoryChildValueList(self, recursive=1,include_if_child=1,**kw):
174 175 176 177 178
      """
          List the child objects of this category and all its subcategories.

          recursive - if set to 1, list recursively
      """
179 180 181 182
      if not(include_if_child) and len(self.objectValues(self.allowed_types))>0:
        value_list = []
      else:
        value_list = [self]
183 184
      if recursive:
        for c in self.objectValues(self.allowed_types):
185
          value_list.extend(c.getCategoryChildValueList(recursive = 1,include_if_child=include_if_child))
186 187 188 189 190
      else:
        for c in self.objectValues(self.allowed_types):
          value_list.append(c)
      return value_list

Jean-Paul Smets's avatar
Jean-Paul Smets committed
191 192 193 194 195 196 197 198 199 200 201 202 203 204
    # List names recursively
    security.declareProtected(Permissions.AccessContentsInformation,
                                                    'getCategoryChildRelativeUrlList')
    def getCategoryChildRelativeUrlList(self, base='', recursive=1):
      """
          List the path of this category and all its subcategories.

          base -- a boolean or a string. If it is a string, then use
                  that string as a base

          recursive - if set to 1, list recursively
      """
      if base == 0 or base is None: base = '' # Make sure we get a meaningful base
      if base == 1: base = self.getBaseCategoryId() + '/' # Make sure we get a meaningful base
205 206 207 208
      url_list = []
      for value in self.getCategoryChildValueList(recursive = recursive):
        url_list.append(base + value.getRelativeUrl())
      return url_list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
209 210 211 212 213 214

    security.declareProtected(Permissions.AccessContentsInformation, 'getPathList')
    getPathList = getCategoryChildRelativeUrlList

    security.declareProtected(Permissions.AccessContentsInformation,
                                                      'getCategoryChildTitleItemList')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
215
    def getCategoryChildTitleItemList(self, recursive=1, base=0, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
216 217 218 219
      """
      Returns a list of tuples by parsing recursively all categories in a
      given list of base categories. Uses getTitle as default method
      """
220 221
      return self.getCategoryChildItemList(recursive = recursive, display_id='title', base=base, **kw)

222 223 224 225 226 227 228 229 230
    security.declareProtected(Permissions.AccessContentsInformation,
                                                      'getCategoryChildTitleOrIdItemList')
    def getCategoryChildTitleOrIdItemList(self, recursive=1, base=0, **kw):
      """
      Returns a list of tuples by parsing recursively all categories in a
      given list of base categories. Uses getTitle as default method
      """
      return self.getCategoryChildItemList(recursive = recursive, display_id='title_or_id', base=base, **kw)

231 232 233 234 235 236 237 238
    security.declareProtected(Permissions.AccessContentsInformation,
                                                      'getCategoryChildLogicalPathItemList')
    def getCategoryChildLogicalPathItemList(self, recursive=1, base=0, **kw):
      """
      Returns a list of tuples by parsing recursively all categories in a
      given list of base categories. Uses getLogicalPath as default method
      """
      return self.getCategoryChildItemList(recursive = recursive, display_id='logical_path', base=base, **kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
239 240 241

    security.declareProtected(Permissions.AccessContentsInformation,
                                                      'getCategoryChildIdItemList')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
242
    def getCategoryChildIdItemList(self, recursive=1, base=0, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
243 244 245 246
      """
      Returns a list of tuples by parsing recursively all categories in a
      given list of base categories. Uses getId as default method
      """
247
      return self.getCategoryChildItemList(recursive = recursive, display_id='id', base=base, **kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
248 249 250 251


    security.declareProtected(Permissions.AccessContentsInformation,
                                                      'getCategoryChildItemList')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
252
    def getCategoryChildItemList(self, recursive=1, base=0, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
253 254 255 256
      """
      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
257
        (c.relative_url,c.display_id())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
258 259 260 261 262 263 264 265

      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)

              if set to string, use string as base

Jean-Paul Smets's avatar
Jean-Paul Smets committed
266
      display_id -- method called to build the couple
Jean-Paul Smets's avatar
Jean-Paul Smets committed
267 268 269

      recursive -- if set to 0 do not apply recursively
      """
270
      value_list = self.getCategoryChildValueList(recursive=recursive,**kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
271
      return Renderer(base=base, **kw).render(value_list)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
272 273 274 275 276 277 278

    # Alias for compatibility
    security.declareProtected(Permissions.View, 'getFormItemList')
    def getFormItemList(self):
      """
        Alias for compatibility and accelation
      """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
279
      return self.getCategoryChildItemList(base=0,display_none_category=1,recursive=1)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
280 281 282 283

    # Alias for compatibility
    security.declareProtected(Permissions.AccessContentsInformation, 'getBaseItemList')
    def getBaseItemList(self, base=0, prefix=''):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
284
      return self.getCategoryChildItemList(base=base,display_none_category=0,recursive=1)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
285 286 287

    security.declareProtected(Permissions.AccessContentsInformation,
                                                        'getCategoryRelativeUrl')
288
    def getCategoryRelativeUrl(self, base=0 ):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
289 290 291 292 293 294 295 296 297 298 299 300 301 302
      """
        Returns a relative_url of this category relative
        to its base category (if base is 0) or to
        portal_categories (if base is 1)
      """
      my_parent = aq_parent(self)

      if my_parent is not None:
        if my_parent.meta_type != self.meta_type:
          if base:
            return self.getBaseCategoryId() + '/' + self.id
          else:
            return self.id
        else:
303
          return my_parent.getCategoryRelativeUrl(base=base) + '/' + self.id
Jean-Paul Smets's avatar
Jean-Paul Smets committed
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332
      else:
        if base:
          return self.getBaseCategoryId() + '/' + self.id
        else:
          return self.id


    # Alias for compatibility
    security.declareProtected(Permissions.AccessContentsInformation, 'getCategoryName')
    getCategoryName = getCategoryRelativeUrl

    # Predicate interface
    _operators = []

    def test(self, context):
      """
        A Predicate can be tested on a given context
      """
      return context.isMemberOf(self.getCategoryName())

    security.declareProtected( Permissions.AccessContentsInformation, 'asPythonExpression' )
    def asPythonExpression(self, strict_membership=0):
      """
        A Predicate can be rendered as a python expression. This
        is the preferred approach within Zope.
      """
      return "context.isMemberOf('%s')" % self.getCategoryRelativeUrl(base = 1)

    security.declareProtected( Permissions.AccessContentsInformation, 'asSqlExpression' )
333
    def asSqlExpression(self, strict_membership=0, table='category'):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
334 335 336 337 338
      """
        A Predicate can be rendered as an sql expression. This
        can be useful to create reporting trees based on the
        ZSQLCatalog
      """
339 340
      #LOG('asSqlExpression', 0, str(self))
      #LOG('asSqlExpression parent', 0, str(self.aq_parent))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
341
      if strict_membership:
342
        sql_text = '(%s.category_uid = %s AND %s.base_category_uid = %s AND %s.category_strict_membership = 1)' % (table, self.getUid(), table, self.getBaseCategoryUid(), table)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
343
      else:
344 345
        sql_text = '(%s.category_uid = %s AND %s.base_category_uid = %s)' % (table, self.getUid(),
                                                                   table, self.getBaseCategoryUid())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362
      # Now useless since we precompute the mapping
      #for o in self.objectValues():
      #  sql_text += ' OR %s' % o.asSqlExpression()
      return sql_text

    # A Category's categories is self


    security.declareProtected( Permissions.AccessContentsInformation, 'getRelativeUrl' )
    def getRelativeUrl(self):
      """
        We must eliminate portal_categories in the RelativeUrl
        since it is never present in the category list
      """
      return '/'.join(self.portal_url.getRelativeContentPath(self)[1:])

    security.declareProtected( Permissions.View, 'isMemberOf' )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
363
    def isMemberOf(self, category, strict = 0):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
364 365 366 367
      """
        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)
      """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
368 369 370 371 372 373 374
      if strict:
        if self.getRelativeUrl().find(category) >= 0:
          if len(category) == len(self.getRelativeUrl()) + len(self.getRelativeUrl().find(category)):
            return 1
      else:
        if self.getRelativeUrl().find(category) >= 0:
          return 1
Jean-Paul Smets's avatar
Jean-Paul Smets committed
375 376 377
      return 0

    security.declareProtected( Permissions.AccessContentsInformation, 'getCategoryMemberValueList' )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
378
    def getCategoryMemberValueList(self, base_category = None,
Jean-Paul Smets's avatar
Jean-Paul Smets committed
379 380 381 382 383 384
                            spec=(), filter=None, portal_type=(), strict = 0):
      """
      Returns a list of objects or brains
      """

      return self.portal_categories.getCategoryMemberValueList(self,
Jean-Paul Smets's avatar
Jean-Paul Smets committed
385
            base_category = base_category,
Jean-Paul Smets's avatar
Jean-Paul Smets committed
386 387 388
            spec=spec, filter=filter, portal_type=portal_type,strict = strict)

    security.declareProtected( Permissions.AccessContentsInformation, 'getCategoryMemberItemList' )
389
    def getCategoryMemberItemList(self, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
390 391 392
      """
      Returns a list of objects or brains
      """
393
      return self.portal_categories.getCategoryMemberItemList(self, **kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
394 395 396

    security.declareProtected( Permissions.AccessContentsInformation,
                                                               'getCategoryMemberTitleItemList' )
397
    def getCategoryMemberTitleItemList(self, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
398 399 400
      """
      Returns a list of objects or brains
      """
401 402 403
      kw['display_id'] = 'getTitle'
      kw['display_method'] = None
      return self.portal_categories.getCategoryMemberItemList(self, **kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
404

405 406 407 408 409 410 411 412 413 414 415
    security.declareProtected( Permissions.AccessContentsInformation, 'getBreadcrumbList' )
    def getBreadcrumbList(self):
      """
      Returns a list of objects or brains
      """
      title_list = []
      if not self.isBaseCategory:
        title_list.extend(self.aq_parent.getBreadcrumbList())
        title_list.append(self.getTitle())
      return title_list

Jean-Paul Smets's avatar
Jean-Paul Smets committed
416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454
manage_addBaseCategoryForm=DTMLFile('dtml/base_category_add', globals())

def addBaseCategory( self, id, title='', REQUEST=None ):
    """
        Add a new Category and generate UID
    """
    sf = BaseCategory( id )
    sf._setTitle(title)
    self._setObject( id, sf )
    sf = self._getOb( id )
    sf.reindexObject()
    if REQUEST is not None:
        return self.manage_main(self, REQUEST, update_menu=1)






class BaseCategory(Category):
    """
      Base Categories allow to implement virtual categories
      through acquisition
    """
    meta_type='CMF Base Category'
    portal_type='Base Category' # maybe useful some day
    isPortalContent = 1
    isRADContent = 1
    isBaseCategory = 1

    constructors =   (manage_addBaseCategoryForm, addBaseCategory)

    property_sheets = ( PropertySheet.Base
                      , PropertySheet.SimpleItem
                      , PropertySheet.BaseCategory)

    # Declarative security
    security = ClassSecurityInfo()

455
    def asSqlExpression(self, strict_membership=0, table='category'):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
456 457 458 459 460 461
      """
        A Predicate can be rendered as an sql expression. This
        can be useful to create reporting trees based on the
        ZSQLCatalog
      """
      if strict_membership:
462
        sql_text = '(%s.category_uid = %s AND %s.base_category_uid = %s AND %s.category_strict_membership = 1)' % (table, self.uid, table, self.uid, table)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
463
      else:
464
        sql_text = '(%s.category_uid = %s AND %s.base_category_uid = %s)' % (table, self.uid, table, self.uid)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485
      # Now useless since we precompute the mapping
      #for o in self.objectValues():
      #  sql_text += ' OR %s' % o.asSqlExpression()
      return sql_text

    security.declareProtected( Permissions.AccessContentsInformation, 'getBaseCategoryId' )
    def getBaseCategoryId(self):
      """
        The base category of this object
        acquired through portal categories. Very
        useful to implement relations and virtual categories.
      """
      return self.getBaseCategory().id

    security.declareProtected( Permissions.AccessContentsInformation, 'getBaseCategoryUid' )
    def getBaseCategoryUid(self):
      """
        The base category uid of this object
        acquired through portal categories. Very
        useful to implement relations and virtual categories.
      """
486
      return self.getBaseCategory().getUid()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
487 488 489 490 491 492 493 494 495 496

    security.declareProtected( Permissions.AccessContentsInformation, 'getBaseCategoryValue' )
    def getBaseCategoryValue(self):
      """
        The base category of this object
        acquired through portal categories. Very
        useful to implement relations and virtual categories.
      """
      return self

497 498
    security.declareProtected(Permissions.AccessContentsInformation,
                                                    'getCategoryChildValueList')
499
    def getCategoryChildValueList(self, recursive=1, include_if_child=1, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
500
      """
501
          List the child objects of this category and all its subcategories.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
502

503
          recursive - if set to 1, list recursively
504 505 506 507 508 509 510 511 512 513 514 515 516

          include_if_child - if set to 1, then a category is listed even if
                      has childs. if set to 0, then don't list if child.
                      for example:
                        region/europe
                        region/europe/france
                        region/europe/germany
                        ...
                      becomes:
                        region/europe/france
                        region/europe/germany
                        ...

Jean-Paul Smets's avatar
Jean-Paul Smets committed
517
      """
518
      value_list = []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
519 520
      if recursive:
        for c in self.objectValues(self.allowed_types):
521
          value_list.extend(c.getCategoryChildValueList(recursive = 1,include_if_child=include_if_child))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
522 523
      else:
        for c in self.objectValues(self.allowed_types):
524 525 526 527 528
          if include_if_child:
            value_list.append(c)
          else:
            if len(c.objectValues(self.allowed_types))==0:
              value_list.append(c)
529
      return value_list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
530 531 532 533 534 535 536 537

    # Alias for compatibility
    security.declareProtected( Permissions.AccessContentsInformation, 'getBaseCategory' )
    getBaseCategory = getBaseCategoryValue

InitializeClass( Category )
InitializeClass( BaseCategory )