Domain.py 4.94 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.
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
#
# 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.
#
##############################################################################

from AccessControl import ClassSecurityInfo

from Products.ERP5Type import Permissions, PropertySheet, Constraint, Interface

33 34
from Products.ERP5.Document.MetaResource import MetaResource
from Products.ERP5.Document.MetaNode import MetaNode
Jean-Paul Smets's avatar
Jean-Paul Smets committed
35
from Products.ERP5.Document.Predicate import Predicate
Jean-Paul Smets's avatar
Jean-Paul Smets committed
36

37
class Domain(Predicate, MetaNode, MetaResource):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
38
  """
39 40 41 42
    Domain can be used as MetaNodes or MetaResources. For example,
    a Domain viewed as a MetaNode can search for all emerging movements
    and compare it with its capacity.
        
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64
    Structure is:
       - base domain (like base category)
       - sub domain (like category)
       
    Allows to define ranges:
       - price between X and Y
       - portal_type in (a, b, c)
       - price between X and Y and region in (a, b, c)
       
    Reports:
       - listbox allows to produce reports
         - output to html, pdf or ooffice
         - definition through the web (ie. which field in which column, which statistics)
         - definition of selection (to list)
         - ability for use to "save" favourite report (user reports)
         - library of favourite reports (global reports)
       - matrixbox allows to produce reports       
         - output to html, pdf or ooffice
         - definition through the web (ie. which base_category or base_domain in which axis)
         - definition of selection (to map to matrix)
         - ability for use to "save" favourite report (user reports)
         - library of favourite reports (global reports)
65 66 67 68 69 70 71 72

    Domain and Domain Generators are now unified. Any domain may act
    as a domain generator or as a simple predicate.

    A Domain Generator uses a method (SQL, Python) to select objects
    which are then wrapped as Virtual Domains. This can be used for
    example to provide the list the 10 best selling shops to 
    a report tree.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
73 74 75
  """
  meta_type = 'ERP5 Domain'
  portal_type = 'Domain'
76
  add_permission = Permissions.AddPortalContent
77 78
  isPortalContent = 1
  isRADContent = 1
Jean-Paul Smets's avatar
Jean-Paul Smets committed
79 80 81

  # Declarative security
  security = ClassSecurityInfo()
82
  security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
83 84 85

  # Declarative interfaces
  __implements__ = ( Interface.Predicate, )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
86

87 88 89
  # Declarative properties
  property_sheets = ( PropertySheet.Domain, )

Jean-Paul Smets's avatar
Jean-Paul Smets committed
90 91 92 93 94 95 96
  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:])
97

98 99
  # Generator API
  
100
  # How to define a generated subdomain
101
  security.declareProtected( Permissions.AccessContentsInformation, 'getDomainGeneratorList' )
102 103 104
  def getDomainGeneratorList(self, depth=0):
    # We call a script which builds for us a list DomainGenerator instances
    # We need a way to know how deep we are in the domain generation
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
    # to prevent infinite recursion XXX not implemented
    from Products.ERP5Type.Document import newTempDomainGenerator
    klass = tmp_domain_generator = newTempDomainGenerator(self, 'new_generator')
    script = self.getDomainGeneratorMethodId('')
    return tmp_domain_generator.getDomainGeneratorList(depth=depth, klass=klass, script=script, parent=self)

  security.declareProtected( Permissions.AccessContentsInformation, 'generateTempDomain' )
  def generateTempDomain(self, id):
    """
    We generate temp domain here because we must set an aquisition wrapper
    """
    from Products.ERP5Type.Document import newTempDomain
    domain = newTempDomain(self, id)
    domain = domain.__of__(self)
    return domain