Resource.py 31.8 KB
Newer Older
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1 2
##############################################################################
#
3
# Copyright (c) 2002, 2005 Nexedi SARL and Contributors. All Rights Reserved.
4
#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
5
#                    Romain Courteaud <romain@nexedi.com>
Jean-Paul Smets's avatar
Jean-Paul Smets committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
#
# 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.
#
##############################################################################

30
from math import log
Alexandre Boeglin's avatar
Alexandre Boeglin committed
31
from warnings import warn
Jean-Paul Smets's avatar
Jean-Paul Smets committed
32

33
from AccessControl import ClassSecurityInfo
Jean-Paul Smets's avatar
Jean-Paul Smets committed
34

35
from Products.ERP5Type import Permissions, PropertySheet, Interface
Jean-Paul Smets's avatar
Jean-Paul Smets committed
36
from Products.ERP5Type.XMLMatrix import XMLMatrix
37
from Products.ERP5Type.Base import Base
Jean-Paul Smets's avatar
Jean-Paul Smets committed
38 39

from Products.ERP5.Variated import Variated
40
from Products.CMFCategory.Renderer import Renderer
41
from Products.CMFCore.utils import getToolByName
Jean-Paul Smets's avatar
Jean-Paul Smets committed
42

Alexandre Boeglin's avatar
Alexandre Boeglin committed
43
from zLOG import LOG, WARNING
Jean-Paul Smets's avatar
Jean-Paul Smets committed
44

45
class Resource(XMLMatrix, Variated):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
46 47 48 49 50 51
    """
      A Resource
    """

    meta_type = 'ERP5 Resource'
    portal_type = 'Resource'
52
    add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
53 54 55 56 57
    isPortalContent = 1
    isRADContent = 1

    # Declarative security
    security = ClassSecurityInfo()
58
    security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
59 60 61 62 63 64 65 66 67 68 69 70

    # Declarative interfaces
    __implements__ = ( Interface.Variated, )

    # Declarative properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
                      , PropertySheet.CategoryCore
                      , PropertySheet.DublinCore
                      , PropertySheet.Price
                      , PropertySheet.Resource
                      , PropertySheet.Reference
71
                      , PropertySheet.FlowCapacity
Sebastien Robin's avatar
Sebastien Robin committed
72
                      , PropertySheet.VariationRange
73
                      , PropertySheet.DefaultSupply
Jean-Paul Smets's avatar
Jean-Paul Smets committed
74 75 76 77 78 79 80
                      )

    # Is it OK now ?
    # The same method is at about 3 different places
    # Some genericity is needed
    security.declareProtected(Permissions.AccessContentsInformation,
                                           'getVariationRangeCategoryItemList')
81 82 83
    def getVariationRangeCategoryItemList(self, base_category_list=(), base=1, 
                                          root=1, display_id='title', 
                                          display_base_category=1,
84
                                          current_category=None, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
85 86
        """
          Returns possible variations
87 88 89

          resource.getVariationRangeCategoryItemList
            => [(display, value)]
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111
        
      ## Variation API (exemple) ##
        Base categories defined:
          - colour
          - morphology
          - size
        Categories defined:
          - colour/blue
          - colour/red
          - size/Man
          - size/Woman
        Resource 'resource' created with variation_base_category_list:
            (colour, morphology, size)

        resource.getVariationRangeCategoryList
        variation   | individual variation | result
        ____________________________________________________________________________________
                    |                      | (colour/blue, colour/red, size/Man, size/Woman)
        size/Man    |                      | (colour/blue, colour/red, size/Man, size/Woman)
        colour/blue |                      | (colour/blue, colour/red, size/Man, size/Woman)
                    |  colour/1            | (colour/1, size/Man, size/Woman)
                    |  morphology/2        | (colour/blue, colour/red, size/Man, size/Woman, morphology/2)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
112
        """
113
        result = []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
114 115 116 117
        if base_category_list is ():
          base_category_list = self.getVariationBaseCategoryList()
        elif type(base_category_list) is type('a'):
          base_category_list = (base_category_list,)
118

119
        other_base_category_dict = dict([(i,1) for i in base_category_list])
Yoshinori Okuji's avatar
Yoshinori Okuji committed
120
        other_variations = self.searchFolder( \
121 122
                               portal_type=self.getPortalVariationTypeList(),
                               sort_on=[('title','ascending')])
Yoshinori Okuji's avatar
Yoshinori Okuji committed
123 124
        other_variations = [x.getObject() for x in other_variations]
        other_variations = [x for x in other_variations if x is not None]
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139

        for object in other_variations:
          for base_category in object.getVariationBaseCategoryList():
            if (base_category_list is ()) or \
               (base_category in base_category_list):
              other_base_category_dict[base_category] = 0
              # XXX now, call Renderer a lot of time.
              # Better implementation needed
              result.extend(Renderer(
                                   base_category=base_category, 
                                   display_base_category=display_base_category,
                                   display_none_category=0, base=base,
                                   current_category=current_category,
                                   display_id=display_id).\
                                                     render([object]))
140

141 142 143 144
        other_base_category_item_list = filter(lambda x: x[1]==1, 
            other_base_category_dict.items())
        other_base_category_list = map(lambda x: x[0],
            other_base_category_item_list)
145 146 147 148
        # Get category variation
        if len(other_base_category_list) != 0:
          result += Variated.getVariationRangeCategoryItemList(
              self, base_category_list=other_base_category_list,
149
              base=base, display_base_category=display_base_category, **kw)
150
        # Return result
151
        return result
152

Jean-Paul Smets's avatar
Jean-Paul Smets committed
153 154
    security.declareProtected(Permissions.AccessContentsInformation,
                                           'getVariationCategoryItemList')
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
    def getVariationCategoryItemList(self, base_category_list=(), 
                                     omit_individual_variation=1, base=1,
                                     current_category=None,
                                     display_base_category=1,
                                     display_id='title', **kw):
      """
        Returns variations of the resource.
        If omit_individual_variation==1, does not return individual 
        variation.
        Else, returns them.
        Display is on left.
            => [(display, value)]

        *old parameters: base=1, current_category=None, 
                         display_id='getTitle' (default value getTitleOrId)
      """
      result = Variated.getVariationCategoryItemList(self, 
                            base_category_list=base_category_list, 
173 174
                            display_base_category=display_base_category, 
                            base=base, **kw)
175
      if not omit_individual_variation:
176 177
        other_variations = self.searchFolder(
                              portal_type=self.getPortalVariationTypeList())
178 179 180 181 182 183 184 185 186 187 188 189

        other_variations = map(lambda x: x.getObject(), other_variations)
        other_variations = filter(lambda x: x is not None, other_variations)

        for object in other_variations:
          for base_category in object.getVariationBaseCategoryList():
            if (base_category_list is ()) or \
               (base_category in base_category_list):
              # XXX append object, relative_url ?
              # XXX now, call Renderer a lot of time.
              # Better implementation needed
              result.extend(Renderer(
190 191 192 193 194 195
                             base_category=base_category, 
                             display_base_category=display_base_category,
                             display_none_category=0, base=base,
                             current_category=current_category,
                             display_id=display_id, **kw).\
                                               render([object]))
196 197 198
      return result

    security.declareProtected(Permissions.AccessContentsInformation,
199
                              'getVariationCategoryList')
200
    def getVariationCategoryList(self, default=[], base_category_list=(),
201
                                 omit_individual_variation=1, **kw):
202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230
      """
        Returns variations of the resource.
        If omit_individual_variation==1, does not return individual 
        variation.
        Else, returns them.

        ## Variation API (exemple) ##
        Base categories defined:
          - colour
          - morphology
          - size
        Categories defined:
          - colour/blue
          - colour/red
          - size/Man
          - size/Woman
        Resource 'resource' created with variation_base_category_list:
            (colour, morphology, size)

        resource.getVariationCategoryList
        variation   | individual variation | result
        _____________________________________________________
                    |                      | ()
        size/Man    |                      | (size/Man, )
        colour/blue |                      | (colour/blue, )
                    |  colour/1            | (colour/1, )
                    |  morphology/2        | (morphology/2, )
      """
      vcil = self.getVariationCategoryItemList(
231 232
                    base_category_list=base_category_list,
                    omit_individual_variation=omit_individual_variation,**kw)
233
      return map(lambda x: x[1], vcil)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
234 235 236 237 238 239 240 241 242 243 244 245

    # Unit conversion
    security.declareProtected(Permissions.AccessContentsInformation, 'convertQuantity')
    def convertQuantity(self, quantity, from_unit, to_unit):
      return quantity

# This patch is temporary and allows to circumvent name conflict in ZSQLCatalog process for Coramy
    security.declareProtected(Permissions.AccessContentsInformation,
                                              'getDefaultDestinationAmountBis')
    def getDefaultDestinationAmountBis(self, unit=None, variation=None, REQUEST=None):
      try:
        return self.getDestinationReference()
Yoshinori Okuji's avatar
Yoshinori Okuji committed
246
      except AttributeError:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
247 248 249 250 251 252 253 254
        return None

# This patch is temporary and allows to circumvent name conflict in ZSQLCatalog process for Coramy
    security.declareProtected(Permissions.AccessContentsInformation,
                                              'getDefaultSourceAmountBis')
    def getDefaultSourceAmountBis(self, unit=None, variation=None, REQUEST=None):
      try:
        return self.getSourceReference()
Yoshinori Okuji's avatar
Yoshinori Okuji committed
255
      except AttributeError:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
256 257 258 259 260 261 262 263 264 265
        return None


    # This patch allows variations to find a resource
    security.declareProtected(Permissions.AccessContentsInformation,
                                              'getDefaultResourceValue')
    def getDefaultResourceValue(self):
      return self


Romain Courteaud's avatar
Romain Courteaud committed
266
    ####################################################
Jean-Paul Smets's avatar
Jean-Paul Smets committed
267
    # Stock Management
Romain Courteaud's avatar
Romain Courteaud committed
268 269 270
    ####################################################
    security.declareProtected(Permissions.AccessContentsInformation, 
                              'getInventory')
271
    def getInventory(self, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
272
      """
273
      Returns inventory
Jean-Paul Smets's avatar
Jean-Paul Smets committed
274
      """
275 276 277
      kw['resource_uid'] = self.getUid()
      portal_simulation = getToolByName(self, 'portal_simulation')
      return portal_simulation.getInventory(**kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
278

Romain Courteaud's avatar
Romain Courteaud committed
279 280
    security.declareProtected(Permissions.AccessContentsInformation, 
                              'getCurrentInventory')
281
    def getCurrentInventory(self, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
282
      """
283
      Returns current inventory
Jean-Paul Smets's avatar
Jean-Paul Smets committed
284
      """
285 286 287
      kw['resource_uid'] = self.getUid()
      portal_simulation = getToolByName(self, 'portal_simulation')
      return portal_simulation.getCurrentInventory(**kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
288

Romain Courteaud's avatar
Romain Courteaud committed
289 290
    security.declareProtected(Permissions.AccessContentsInformation, 
                              'getAvailableInventory')
291
    def getAvailableInventory(self, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
292
      """
293 294
      Returns available inventory
      (current inventory - deliverable)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
295
      """
296 297 298
      kw['resource_uid'] = self.getUid()
      portal_simulation = getToolByName(self, 'portal_simulation')
      return portal_simulation.getAvailableInventory(**kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
299

Romain Courteaud's avatar
Romain Courteaud committed
300 301
    security.declareProtected(Permissions.AccessContentsInformation, 
                              'getFutureInventory')
302
    def getFutureInventory(self, **kw):
303 304 305
      """
      Returns inventory at infinite
      """
306 307 308
      kw['resource_uid'] = self.getUid()
      portal_simulation = getToolByName(self, 'portal_simulation')
      return portal_simulation.getFutureInventory(**kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
309

Romain Courteaud's avatar
Romain Courteaud committed
310 311
    security.declareProtected(Permissions.AccessContentsInformation, 
                              'getInventoryList')
312 313 314 315
    def getInventoryList(self, **kw):
      """
      Returns list of inventory grouped by section or site
      """
316 317 318
      kw['resource_uid'] = self.getUid()
      portal_simulation = getToolByName(self, 'portal_simulation')
      return portal_simulation.getInventoryList(**kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
319

Romain Courteaud's avatar
Romain Courteaud committed
320 321
    security.declareProtected(Permissions.AccessContentsInformation, 
                              'getCurrentInventoryList')
322
    def getCurrentInventoryList(self, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
323
      """
324
      Returns list of inventory grouped by section or site
Jean-Paul Smets's avatar
Jean-Paul Smets committed
325
      """
326 327 328 329 330 331 332 333 334 335 336 337 338
      kw['resource_uid'] = self.getUid()
      portal_simulation = getToolByName(self, 'portal_simulation')
      return portal_simulation.getCurrentInventoryList(**kw)

    security.declareProtected(Permissions.AccessContentsInformation, 
                              'getAvailableInventoryList')
    def getAvailableInventoryList(self, **kw):
      """
      Returns list of inventory grouped by section or site
      """
      kw['resource_uid'] = self.getUid()
      portal_simulation = getToolByName(self, 'portal_simulation')
      return portal_simulation.getAvailableInventoryList(**kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
339

Romain Courteaud's avatar
Romain Courteaud committed
340 341
    security.declareProtected(Permissions.AccessContentsInformation, 
                              'getFutureInventoryList')
342
    def getFutureInventoryList(self, **kw):
343 344 345
      """
      Returns list of inventory grouped by section or site
      """
346 347 348
      kw['resource_uid'] = self.getUid()
      portal_simulation = getToolByName(self, 'portal_simulation')
      return portal_simulation.getFutureInventoryList(**kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
349

Romain Courteaud's avatar
Romain Courteaud committed
350 351
    security.declareProtected(Permissions.AccessContentsInformation, 
                              'getInventoryStat')
352
    def getInventoryStat(self, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
353
      """
354
      Returns statistics of inventory grouped by section or site
Jean-Paul Smets's avatar
Jean-Paul Smets committed
355
      """
356 357 358
      kw['resource_uid'] = self.getUid()
      portal_simulation = getToolByName(self, 'portal_simulation')
      return portal_simulation.getInventoryStat(**kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
359

Romain Courteaud's avatar
Romain Courteaud committed
360 361
    security.declareProtected(Permissions.AccessContentsInformation, 
                              'getCurrentInventoryStat')
362
    def getCurrentInventoryStat(self, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
363
      """
364
      Returns statistics of inventory grouped by section or site
Jean-Paul Smets's avatar
Jean-Paul Smets committed
365
      """
366 367 368 369 370 371 372 373 374 375 376 377 378
      kw['resource_uid'] = self.getUid()
      portal_simulation = getToolByName(self, 'portal_simulation')
      return portal_simulation.getCurrentInventoryStat(**kw)

    security.declareProtected(Permissions.AccessContentsInformation,
                              'getAvailableInventoryStat')
    def getAvailableInventoryStat(self, **kw):
      """
      Returns statistics of inventory grouped by section or site
      """
      kw['resource_uid'] = self.getUid()
      portal_simulation = getToolByName(self, 'portal_simulation')
      return portal_simulation.getAvailableInventoryStat(**kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
379

Romain Courteaud's avatar
Romain Courteaud committed
380 381
    security.declareProtected(Permissions.AccessContentsInformation, 
                              'getFutureInventoryStat')
382
    def getFutureInventoryStat(self, **kw):
383 384 385
      """
      Returns statistics of inventory grouped by section or site
      """
386 387 388
      kw['resource_uid'] = self.getUid()
      portal_simulation = getToolByName(self, 'portal_simulation')
      return portal_simulation.getFutureInventoryStat(**kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
389

Romain Courteaud's avatar
Romain Courteaud committed
390 391
    security.declareProtected(Permissions.AccessContentsInformation, 
                              'getInventoryChart')
392
    def getInventoryChart(self, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
393
      """
394
      Returns list of inventory grouped by section or site
Jean-Paul Smets's avatar
Jean-Paul Smets committed
395
      """
396 397 398
      kw['resource_uid'] = self.getUid()
      portal_simulation = getToolByName(self, 'portal_simulation')
      return portal_simulation.getInventoryChart(**kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
399

Romain Courteaud's avatar
Romain Courteaud committed
400 401
    security.declareProtected(Permissions.AccessContentsInformation, 
                              'getCurrentInventoryChart')
402
    def getCurrentInventoryChart(self, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
403
      """
404
      Returns list of inventory grouped by section or site
Jean-Paul Smets's avatar
Jean-Paul Smets committed
405
      """
406 407 408
      kw['resource_uid'] = self.getUid()
      portal_simulation = getToolByName(self, 'portal_simulation')
      return portal_simulation.getCurrentInventoryChart(**kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
409

Romain Courteaud's avatar
Romain Courteaud committed
410 411
    security.declareProtected(Permissions.AccessContentsInformation, 
                              'getFutureInventoryChart')
412
    def getFutureInventoryChart(self, **kw):
413 414 415
      """
      Returns list of inventory grouped by section or site
      """
416 417 418
      kw['resource_uid'] = self.getUid()
      portal_simulation = getToolByName(self, 'portal_simulation')
      return portal_simulation.getFutureInventoryChart(**kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
419

Romain Courteaud's avatar
Romain Courteaud committed
420 421
    security.declareProtected(Permissions.AccessContentsInformation, 
                              'getInventoryHistoryList')
422
    def getInventoryHistoryList(self, **kw):
423 424 425
      """
      Returns list of inventory grouped by section or site
      """
426 427 428
      kw['resource_uid'] = self.getUid()
      portal_simulation = getToolByName(self, 'portal_simulation')
      return portal_simulation.getInventoryHistoryList(**kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
429

Romain Courteaud's avatar
Romain Courteaud committed
430 431
    security.declareProtected(Permissions.AccessContentsInformation, 
                              'getInventoryHistoryChart')
432
    def getInventoryHistoryChart(self, **kw):
433 434 435
      """
      Returns list of inventory grouped by section or site
      """
436 437 438
      kw['resource_uid'] = self.getUid()
      portal_simulation = getToolByName(self, 'portal_simulation')
      return portal_simulation.getInventoryHistoryChart(**kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
439

440 441 442 443
    # XXX FIXME
    # Method getCurrentMovementHistoryList, 
    # getAvailableMovementHistoryList, getFutureMovementHistoryList
    # can be added
Romain Courteaud's avatar
Romain Courteaud committed
444 445
    security.declareProtected(Permissions.AccessContentsInformation, 
                              'getMovementHistoryList')
446
    def getMovementHistoryList(self, **kw):
447 448 449
      """
      Returns list of inventory grouped by section or site
      """
450 451 452
      kw['resource_uid'] = self.getUid()
      portal_simulation = getToolByName(self, 'portal_simulation')
      return portal_simulation.getMovementHistoryList(**kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
453

Romain Courteaud's avatar
Romain Courteaud committed
454 455
    security.declareProtected(Permissions.AccessContentsInformation, 
                              'getMovementHistoryStat')
456
    def getMovementHistoryStat(self, **kw):
457 458 459
      """
      Returns list of inventory grouped by section or site
      """
460 461 462
      kw['resource_uid'] = self.getUid()
      portal_simulation = getToolByName(self, 'portal_simulation')
      return portal_simulation.getMovementHistoryStat(**kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
463

Romain Courteaud's avatar
Romain Courteaud committed
464 465
    security.declareProtected(Permissions.AccessContentsInformation, 
                              'getNextNegativeInventoryDate')
466
    def getNextNegativeInventoryDate(self, **kw):
467 468 469
      """
      Returns list of inventory grouped by section or site
      """
470 471 472
      kw['resource_uid'] = self.getUid()
      portal_simulation = getToolByName(self, 'portal_simulation')
      return portal_simulation.getNextNegativeInventoryDate(**kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
473 474


475
    # Asset Price API
476 477
    security.declareProtected(Permissions.AccessContentsInformation,
        'getInventoryAssetPrice')
478
    def getInventoryAssetPrice(self, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
479
      """
480
      Returns list of inventory grouped by section or site
Jean-Paul Smets's avatar
Jean-Paul Smets committed
481
      """
482 483 484
      kw['resource_uid'] = self.getUid()
      portal_simulation = getToolByName(self, 'portal_simulation')
      return portal_simulation.getInventoryAssetPrice(**kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
485

486 487
    security.declareProtected(Permissions.AccessContentsInformation,
        'getCurrentInventoryAssetPrice')
488
    def getCurrentInventoryAssetPrice(self, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
489
      """
490
      Returns list of inventory grouped by section or site
Jean-Paul Smets's avatar
Jean-Paul Smets committed
491
      """
492 493 494
      kw['resource_uid'] = self.getUid()
      portal_simulation = getToolByName(self, 'portal_simulation')
      return portal_simulation.getCurrentInventoryAssetPrice(**kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
495

496 497
    security.declareProtected(Permissions.AccessContentsInformation,
        'getAvailableInventoryAssetPrice')
498
    def getAvailableInventoryAssetPrice(self, **kw):
499 500 501
      """
      Returns list of inventory grouped by section or site
      """
502 503 504
      kw['resource_uid'] = self.getUid()
      portal_simulation = getToolByName(self, 'portal_simulation')
      return portal_simulation.getAvailableInventoryAssetPrice(**kw)
505

506 507
    security.declareProtected(Permissions.AccessContentsInformation,
        'getFutureInventoryAssetPrice')
508
    def getFutureInventoryAssetPrice(self, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
509
      """
510
      Returns list of inventory grouped by section or site
Jean-Paul Smets's avatar
Jean-Paul Smets committed
511
      """
512 513 514
      kw['resource_uid'] = self.getUid()
      portal_simulation = getToolByName(self, 'portal_simulation')
      return portal_simulation.getFutureInventoryAssetPrice(**kw)
515

Jean-Paul Smets's avatar
Jean-Paul Smets committed
516

517
    # Industrial price API
518 519
    security.declareProtected(Permissions.AccessContentsInformation,
        'getIndustrialPrice')
520 521 522 523 524 525 526 527 528 529 530 531
    def getIndustrialPrice(self, context=None, REQUEST=None, **kw):
      """
        Returns industrial price
      """
      context = self.asContext(context=context, REQUEST=REQUEST, **kw)
      result = self._getIndustrialPrice(context)
      return result

    def _getIndustrialPrice(self, context):
      # Default value is None
      return None

532
    # Predicate handling
533 534
    security.declareProtected(Permissions.AccessContentsInformation, 
                              'asPredicate')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
535 536 537 538 539 540 541
    def asPredicate(self):
      """
      Returns a temporary Predicate based on the Resource properties
      """
      from Products.ERP5 import newTempPredicateGroup as newTempPredicate
      p = newTempPredicate(self.getId(), uid = self.getUid())
      p.setMembershipCriterionBaseCategoryList(('resource',))
542 543
      p.setMembershipCriterionCategoryList(('resource/%s'
          % self.getRelativeUrl(),))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
544
      return p
545

546
    def _pricingSortMethod(self, a, b):
Alexandre Boeglin's avatar
Alexandre Boeglin committed
547 548 549 550 551 552 553
      # Simple method : the one that defines a destination wins
      parent = a.getParentValue()
      if parent.getPortalType().endswith(' Line'):
        parent = parent.getParentValue()
      if parent.getDestination():
        return -1 # a has a destination and wins
      return 1 # a has no destination ans loses
554

555
    security.declareProtected(Permissions.AccessContentsInformation, 
556 557
                              'getPriceParameterDict')
    def getPriceParameterDict(self, context=None, REQUEST=None, **kw):
558
      """
559
      Get all pricing parameters from Predicate.
560
      """
561
      # Search all categories context
562
      new_category_list = []
563
      if context is not None:
564
        new_category_list += context.getCategoryList()
565 566
      #XXX This should be 'category_list' instead of 'categories' to respect
      # the naming convention. Must take care of side effects when fixing
567 568 569
      if kw.has_key('categories'):
        new_category_list.extend(kw['categories'])
        del kw['categories']
570 571
      resource_category = 'resource/' + self.getRelativeUrl()
      if not resource_category in new_category_list:
572 573 574
        new_category_list += (resource_category, )
      # Generate the predicate mapped value
      # to get some price values.
575
      domain_tool = getToolByName(self,'portal_domains')
576
      portal_type_list = self.getPortalSupplyPathTypeList()
577

Alexandre Boeglin's avatar
Alexandre Boeglin committed
578 579 580 581 582 583 584 585 586 587 588
      # Generate the fake context
      tmp_context = self.asContext(context=context, 
                                   categories=new_category_list,
                                   REQUEST=REQUEST, **kw)
      tmp_kw = kw.copy()
      if 'sort_method' not in tmp_kw:
        tmp_kw['sort_method'] = self._pricingSortMethod
      mapped_value = domain_tool.generateMultivaluedMappedValue(
                                             tmp_context,
                                             portal_type=portal_type_list,
                                             has_cell_content=0, **tmp_kw)
589 590 591
      # Get price parameters
      price_parameter_dict = {
        'base_price': None,
592 593 594
        'additional_price': [],
        'surcharge_ratio': [],
        'discount_ratio': [],
595
        'exclusive_discount_ratio': None,
596 597
        'variable_additional_price': [],
        'non_discountable_additional_price': [],
598
      }
Alexandre Boeglin's avatar
Alexandre Boeglin committed
599 600 601 602 603 604 605 606 607 608 609 610
      if mapped_value is None:
        return price_parameter_dict
      for price_parameter_name in price_parameter_dict.keys():
        price_parameter_value = \
          mapped_value.getProperty(price_parameter_name)
        if price_parameter_value not in [None, '']:
          try:
            price_parameter_dict[price_parameter_name].extend(
                                            price_parameter_value)
          except AttributeError:
            if price_parameter_dict[price_parameter_name] is None:
              if price_parameter_name == 'exclusive_discount_ratio':
611
                price_parameter_dict[price_parameter_name] = \
Alexandre Boeglin's avatar
Alexandre Boeglin committed
612 613 614 615
                    max(price_parameter_value)
              else:
                price_parameter_dict[price_parameter_name] = \
                    price_parameter_value[0]
616 617
      return price_parameter_dict
      
618
    security.declareProtected(Permissions.AccessContentsInformation,
619 620
        'getPricingVariable')
    def getPricingVariable(self, context=None):
621 622 623 624
      """
      Return the value of the property used to calculate variable pricing
      This basically calls a script like Product_getPricingVariable
      """
625 626 627
      warn('Resource.getPricingVariable is deprecated; Please use' \
           ' a type-based method for getPrice, and call whatever scripts' \
           ' you need to invoke from that method.', DeprecationWarning)
628
      method = None
629
      if context is not None:
630
        method = context._getTypeBasedMethod('getPricingVariable')
631
      if method is None or context is None:
632
        method = self._getTypeBasedMethod('getPricingVariable')
633

634 635 636 637
      if method is None:
        return 0.0
      return float(method())

638
    security.declareProtected(Permissions.AccessContentsInformation, 
639 640 641 642 643 644 645 646
                              'getPriceCalculationOperandDict')
    def getPriceCalculationOperandDict(self, default=None, context=None,
            REQUEST=None, **kw):
      """Return a dictionary which contains operands for price calculation.
      Consult the doc string in Movement.getPriceCalculationOperandDict
      for more details.
      """
      # First, try to use a new type-based method for the calculation.
647 648
      # Note that this is based on self (i.e. a resource) instead of context
      # (i.e. a movement).
649
      method = self._getTypeBasedMethod('getPriceCalculationOperandDict')
650
      if method is not None:
651
        return method(default=default, movement=context, REQUEST=REQUEST, **kw)
652

653 654 655 656 657 658 659 660 661
      # Next, try an old type-based method which returns only a final result.
      method = self._getTypeBasedMethod('getPrice')
      if method is not None:
        price = method(default=default, movement=context, REQUEST=REQUEST, **kw)
        if price is not None:
          return {'price': price}
        return default

      # This below is used only if any type-based method is not
662 663 664 665 666
      # available at all. We should provide the default implementation
      # in a Business Template as Resource_getPrice, thus this will not
      # be used in the future. Kept only for backward compatibility in
      # case where the user still uses an older Business Template.

667
      price_parameter_dict = self.getPriceParameterDict(
668 669 670
                                     context=context, REQUEST=REQUEST, **kw)
      # Calculate the unit price
      unit_base_price = None
671
      # Calculate
672 673 674 675 676
#     ((base_price + SUM(additional_price) +
#     variable_value * SUM(variable_additional_price)) *
#     (1 - MIN(1, MAX(SUM(discount_ratio) , exclusive_discount_ratio ))) +
#     SUM(non_discountable_additional_price)) *
#     (1 + SUM(surcharge_ratio))
677 678 679 680 681
      # Or, as (nearly) one single line :
#     ((bp + S(ap) + v * S(vap))
#       * (1 - m(1, M(S(dr), edr)))
#       + S(ndap))
#     * (1 + S(sr))
682 683 684
      # Variable value is dynamically configurable through a python script.
      # It can be anything, depending on business requirements.
      # It can be seen as a way to define a pricing model that not only
685 686
      # depends on discrete variations, but also on a continuous property
      # of the object
687

688
      base_price = price_parameter_dict['base_price']
689
      if base_price in [None, '']:
690 691
        # XXX Compatibility
        # base_price must not be defined on resource
692 693
        base_price = self.getBasePrice()
      if base_price not in [None, '']:
694 695
        unit_base_price = base_price
        # Sum additional price
696
        for additional_price in price_parameter_dict['additional_price']:
697
          unit_base_price += additional_price
698
        # Sum variable additional price
699
        variable_value = self.getPricingVariable(context=context)
700 701
        for variable_additional_price in \
            price_parameter_dict['variable_additional_price']:
702
          unit_base_price += variable_additional_price * variable_value
703
        # Discount
704 705 706
        sum_discount_ratio = 0
        for discount_ratio in price_parameter_dict['discount_ratio']:
          sum_discount_ratio += discount_ratio
707 708 709
        exclusive_discount_ratio = \
            price_parameter_dict['exclusive_discount_ratio']
        d_ratio = 0
710
        d_ratio = max(d_ratio, sum_discount_ratio)
711 712 713 714 715
        if exclusive_discount_ratio not in [None, '']:
          d_ratio = max(d_ratio, exclusive_discount_ratio)
        if d_ratio != 0:
          d_ratio = 1 - min(1, d_ratio)
          unit_base_price = unit_base_price * d_ratio
716 717 718 719 720 721 722 723 724
        # Sum non discountable additional price
        for non_discountable_additional_price in\
            price_parameter_dict['non_discountable_additional_price']:
          unit_base_price += non_discountable_additional_price
        # Surcharge ratio
        sum_surcharge_ratio = 1
        for surcharge_ratio in price_parameter_dict['surcharge_ratio']:
          sum_surcharge_ratio += surcharge_ratio
        unit_base_price = unit_base_price * sum_surcharge_ratio
725 726
      # Divide by the priced quantity
      if unit_base_price is not None:
727
        priced_quantity = self.getPricedQuantity()
728
        unit_base_price = unit_base_price / priced_quantity
729
      # Return result
730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754
      if unit_base_price is not None:
        return {'price': unit_base_price}
      return default

    security.declareProtected(Permissions.AccessContentsInformation, 
                              'getPrice')
    def getPrice(self, default=None, context=None, REQUEST=None, **kw):
      """
      Return the unit price of a resource in a specific context.
      """
      # see Movement.getPrice
      if isinstance(default, Base) and context is None:
        msg = 'getPrice first argument is supposed to be the default value'\
              ' accessor, the context should be passed as with the context='\
              ' keyword argument'
        warn(msg, DeprecationWarning)
        LOG('ERP5', WARNING, msg)
        context = default
        default = None
      
      operand_dict = self.getPriceCalculationOperandDict(default=default, 
              context=context, REQUEST=REQUEST, **kw)
      if operand_dict is not None:
        return operand_dict['price']
      return default
Yoshinori Okuji's avatar
Yoshinori Okuji committed
755 756 757 758 759 760

    security.declareProtected(Permissions.AccessContentsInformation, 
                              'getQuantityPrecision')
    def getQuantityPrecision(self):
      """Return the floating point precision of a quantity.
      """
761 762 763
      try:
        return int(round(- log(self.getBaseUnitQuantity(), 10),0))
      except TypeError:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
764
        return 0
765
      return 0