Transformation.py 12.7 KB
Newer Older
Yusei Tahara's avatar
Yusei Tahara committed
1
# -*- coding: utf-8 -*-
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2 3 4 5
##############################################################################
#
# Copyright (c) 2002 Coramy SAS and Contributors. All Rights Reserved.
#                    Thierry_Faucher <Thierry_Faucher@coramy.com>
6
# Copyright (c) 2004-2009 Nexedi SA and Contributors. All Rights Reserved.
7
#                    Romain Courteaud <romain@nexedi.com>
8
#                    Łukasz Nowak <luke@nexedi.com>
Jean-Paul Smets's avatar
Jean-Paul Smets committed
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.
#
##############################################################################

33
import zope.interface
34 35

from warnings import warn
Jean-Paul Smets's avatar
Jean-Paul Smets committed
36 37
from AccessControl import ClassSecurityInfo

38
from Products.ERP5Type import Permissions, PropertySheet, interfaces
Jean-Paul Smets's avatar
Jean-Paul Smets committed
39 40 41 42
from Products.ERP5Type.XMLObject import XMLObject

from Products.ERP5.Variated import Variated

43
from Products.ERP5.Document.Predicate import Predicate
Jean-Paul Smets's avatar
Jean-Paul Smets committed
44

45
from Products.CMFCategory.Renderer import Renderer
46
from Products.ERP5.AggregatedAmountList import AggregatedAmountList
Jean-Paul Smets's avatar
Jean-Paul Smets committed
47

48 49
from zLOG import LOG, WARNING

50
class Transformation(XMLObject, Predicate, Variated):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
51 52 53 54 55 56
    """
      Build of material - contains a list of transformed resources

      Use of default_resource... (to define the variation range,
      to ...)

Nicolas Dumazet's avatar
Nicolas Dumazet committed
57
      XXX Transformation works only for a maximum of 3 variation base category...
Nicolas Dumazet's avatar
Nicolas Dumazet committed
58
      Matrixbox must be rewritten for a clean implementation of n base category
Jean-Paul Smets's avatar
Jean-Paul Smets committed
59 60 61 62 63 64 65

    """
    meta_type = 'ERP5 Transformation'
    portal_type = 'Transformation'

    # Declarative security
    security = ClassSecurityInfo()
66
    security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
67 68 69 70 71 72 73

    # Declarative properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
                      , PropertySheet.CategoryCore
                      , PropertySheet.DublinCore
                      , PropertySheet.VariationRange
74
                      , PropertySheet.Predicate
75 76
                      , PropertySheet.Comment
                      , PropertySheet.Reference
77
                      , PropertySheet.Version
78 79 80
                      #, PropertySheet.Resource
                      , PropertySheet.TransformedResource
                      , PropertySheet.Path
Jean-Paul Smets's avatar
Jean-Paul Smets committed
81 82 83 84
                      , PropertySheet.Transformation
                      )

    # Declarative interfaces
85
    zope.interface.implements(interfaces.IVariated, 
86
                              interfaces.IAmountGenerator
87 88
                              )

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

90

Fabien Morin's avatar
Fabien Morin committed
91
    security.declareProtected(Permissions.AccessContentsInformation,
92
                              'updateVariationCategoryList')
93 94
    def updateVariationCategoryList(self):
      """
Nicolas Dumazet's avatar
Nicolas Dumazet committed
95 96
        Check if variation category list of the resource has changed and update
        transformation and transformation line
97
      """
98
      self.setVariationBaseCategoryList(self.getVariationBaseCategoryList())
99 100 101 102
      transformation_line_list = self.contentValues()
      for transformation_line in transformation_line_list:
        transformation_line.updateVariationCategoryList()

103 104 105 106 107
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getVariationRangeBaseCategoryList')
    def getVariationRangeBaseCategoryList(self):
      """
        Returns possible variation base_category ids of the
Nicolas Dumazet's avatar
Nicolas Dumazet committed
108
        default resource which can be used as variation axis
109 110 111 112 113 114 115 116 117 118 119 120
        in the transformation.
      """
      resource = self.getResourceValue()
      if resource is not None:
        result = resource.getVariationBaseCategoryList()
      else:
        # XXX result = self.getBaseCategoryIds()
        # Why calling this method ?
        # Get a global variable which define a list of variation base category
        result = self.getPortalVariationBaseCategoryList()
      return result

Fabien Morin's avatar
Fabien Morin committed
121
    security.declareProtected(Permissions.AccessContentsInformation,
122
                              'getVariationRangeBaseCategoryItemList')
123
    def getVariationRangeBaseCategoryItemList(self, display_id='getTitleOrId', **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
124
        """
125
          Returns possible variations of the transformation
Jean-Paul Smets's avatar
Jean-Paul Smets committed
126 127 128 129
          as a list of tuples (id, title). This is mostly
          useful in ERP5Form instances to generate selection
          menus.
        """
Fabien Morin's avatar
Fabien Morin committed
130
        return self.portal_categories.getItemList(
131 132
                              self.getVariationRangeBaseCategoryList(),
                              display_id=display_id, **kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
133

134 135
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getVariationRangeCategoryItemList')
136
    def getVariationRangeCategoryItemList(self, base_category_list=(),
137
                                          omit_individual_variation=0,
138
                                          display_base_category=1, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
139 140 141
        """
          Returns possible variation category values for the
          transformation according to the default resource.
Nicolas Dumazet's avatar
Nicolas Dumazet committed
142
          Possible category values are provided as a list of
Jean-Paul Smets's avatar
Jean-Paul Smets committed
143 144 145
          tuples (id, title). This is mostly
          useful in ERP5Form instances to generate selection
          menus.
146
          User may want to define generic transformation without
Nicolas Dumazet's avatar
Nicolas Dumazet committed
147
          any defined resource.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
148 149 150
        """
        if base_category_list is ():
          base_category_list = self.getVariationBaseCategoryList()
151 152

        resource = self.getResourceValue()
Fabien Morin's avatar
Fabien Morin committed
153
        if resource is not None:
154
          result = resource.getVariationCategoryItemList(
155
                        base_category_list=base_category_list,
156
                        omit_individual_variation=omit_individual_variation,
157
                        display_base_category=display_base_category,**kw)
158
        else:
159 160 161 162
          # No resource is define on transformation. 
          # We want to display content of base categories
          result = self.portal_categories.getCategoryChildTitleItemList(
                         base_category_list, base=1, display_none_category=0)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
163 164
        return result

Fabien Morin's avatar
Fabien Morin committed
165
    security.declareProtected(Permissions.AccessContentsInformation,
166
                              'setVariationBaseCategoryList')
167 168 169 170 171 172 173
    def setVariationBaseCategoryList(self, value):
      """
        Define the possible base categories and reindex object
      """
      self._setVariationBaseCategoryList(value)
      self.reindexObject()

Fabien Morin's avatar
Fabien Morin committed
174
    security.declareProtected(Permissions.AccessContentsInformation,
175
                              'getVariationCategoryItemList')
Fabien Morin's avatar
Fabien Morin committed
176 177
    def getVariationCategoryItemList(self, base_category_list=(), base=1,
                                     display_id='title',
178 179
                                     current_category=None,
                                     **kw):
180 181 182 183 184 185 186 187 188
      """
        Returns the list of possible variations
        XXX Copied and modified from Variated
        Result is left display.
      """
      variation_category_item_list = []
      if base_category_list == ():
        base_category_list = self.getVariationBaseCategoryList()

189 190 191 192 193 194
      category_renderer = Renderer(
                             is_right_display=0,
                             display_none_category=0, base=base,
                             current_category=current_category,
                             display_id='logical_path', **kw)

195 196 197 198
      for base_category in base_category_list:
        variation_category_list = self.getVariationCategoryList(
                                            base_category_list=[base_category])

199 200 201 202 203 204 205 206 207
        category_list = []
        object_list = []
        for variation_category in variation_category_list:
          resource = self.portal_categories.resolveCategory(variation_category)
          if resource.getPortalType() == 'Category':
            category_list.append(resource)
          else:
            object_list.append(resource)

208 209 210
        variation_category_item_list.extend(category_renderer.\
                                              render(category_list))

211 212
        variation_category_item_list.extend(Renderer(
                               is_right_display=0,
Fabien Morin's avatar
Fabien Morin committed
213
                               base_category=base_category,
214 215
                               display_none_category=0, base=base,
                               current_category=current_category,
216
                               display_id=display_id,**kw).\
217
                                                 render(object_list))
218 219
      return variation_category_item_list

Fabien Morin's avatar
Fabien Morin committed
220
    security.declareProtected(Permissions.AccessContentsInformation,
221 222
                              'getAggregatedAmountList')
    def getAggregatedAmountList(self, context=None, REQUEST=None,
223 224 225
                                trade_phase_list=None,
                                # obsolete, use trade_phase_list instead
                                ind_phase_url_list=None,
Fabien Morin's avatar
Fabien Morin committed
226
                                rejected_resource_uid_list=None,
227
                                **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
228
      """
Nicolas Dumazet's avatar
Nicolas Dumazet committed
229
        getAggregatedAmountList returns an AggregatedAmountList which
230 231
        can be used either to do some calculation (ex. price, BOM)
        or to display a detailed view of a transformation.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
232
      """
233 234 235 236 237 238 239 240 241
      if context is None:
        warn("Calling Transformation.getAggregatedAmountList without context " \
             "is wrong. Context should be an Amount defining the resource to " \
             "produce", DeprecationWarning)
        from Products.ERP5Type.Document import newTempAmount
        context = newTempAmount(self, "deprecated_usage")
        context.setResourceValue(self.getResourceValue())
        context.setQuantity(1.0)

242 243 244 245 246

      # A list of functions taking a transformation_line as sole argument
      # and returning True iif the line should be kept in the result
      filter_list = []

247 248
      # Get only lines related to a precise trade_phase
      if trade_phase_list is not None:
249 250 251 252 253
        def trade_phase_filter(line):
          return line.getTradePhase() in trade_phase_list

        filter_list.append(trade_phase_filter)

254
      # Get only lines related to a precise industrial_phase
255
      if ind_phase_url_list is not None:
256
        LOG("Transformation", WARNING, "ind_phase_list is obsolete")
257
        def industrial_phase_filter(line):
258 259
          ind_ph = line.getIndustrialPhaseValue()
          if ind_ph is not None:
260 261 262 263 264
            return ind_ph.getRelativeUrl() in ind_phase_url_list
          return False

        filter_list.append(industrial_phase_filter)

265 266
      # Filter lines with resource we do not want to see
      if rejected_resource_uid_list is not None:
267 268 269 270 271 272 273 274 275 276 277 278
        def rejected_uid_filter(line):
          return line.getResourceUid() not in rejected_resource_uid_list

        filter_list.append(rejected_uid_filter)

      def line_is_included(line):
        # XXX > 2.5 : all(f(line) for f in filter_list)
        for filterr in filter_list:
          if not filterr(line):
            return False
        return True

279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
      # First we need to get the list of transformations which this
      # transformation depends on
      # At this moment, we only consider 1 dependency
      template_transformation_list = self.getSpecialiseValueList()

      # Browse all involved transformations and create one line per
      # line of transformation
      # Currently, we do not consider abstractions, we just add
      # whatever we find in all transformations
      result = AggregatedAmountList()
      for transformation in ([self] + template_transformation_list):
        for transformation_line in transformation.objectValues():
          # Browse each transformed or assorted resource of the current
          # transformation
          if line_is_included(transformation_line):
294
            try:
295
              line_result = transformation_line.getAggregatedAmountList(context)
296 297 298 299 300
            except KeyError:
              # KeyError is raised by TransformedResource.getAggregatedAmountList
              # in case of misconfiguration of a Cell.
              # Just ignore the line
              pass
301 302
            else:
              result.extend(line_result)
303

304
      return result