TransformationRule.py 14 KB
Newer Older
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1 2
##############################################################################
#
3
# Copyright (c) 2002-2009 Nexedi SARL and Contributors. All Rights Reserved.
4
#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
Romain Courteaud's avatar
Romain Courteaud committed
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
import zope.interface
Jean-Paul Smets's avatar
Jean-Paul Smets committed
31 32
from AccessControl import ClassSecurityInfo

33
from Products.ERP5Type import Permissions, interfaces
34
from Products.ERP5Legacy.Document.Rule import Rule
35
from Products.ERP5Type.Errors import TransformationRuleError
36
from Products.ERP5Legacy.Document.TransformationSourcingRule import\
37
                                            TransformationSourcingRuleMixin
Jean-Paul Smets's avatar
Jean-Paul Smets committed
38

39
class TransformationRule(TransformationSourcingRuleMixin, Rule):
40
    """
41 42
      Order Rule object make sure an Order in the similation
      is consistent with the real order
Jean-Paul Smets's avatar
Jean-Paul Smets committed
43
    """
44 45 46 47 48 49
    # CMF Type Definition
    meta_type = 'ERP5 Transformation Rule'
    portal_type = 'Transformation Rule'
    # Declarative security
    security = ClassSecurityInfo()
    security.declareObjectProtected(Permissions.AccessContentsInformation)
50 51
    zope.interface.implements(interfaces.IPredicate,
                              interfaces.IRule )
52

53 54 55
    # Simulation workflow
    security.declareProtected(Permissions.ModifyPortalContent, 'expand')
    def expand(self, applied_rule, **kw):
Romain Courteaud's avatar
Romain Courteaud committed
56
      """
57 58 59 60
        Expands the current movement downward.
        -> new status -> expanded
        An applied rule can be expanded only if its parent movement
        is expanded.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
61
      """
62 63 64 65 66 67 68 69 70 71 72 73 74
      parent_movement = applied_rule.getParentValue()
      # Get production node and production section
      production = parent_movement.getSource()
      production_section = parent_movement.getSourceSection()
      # Get the current supply link used to calculate consumed resource
      # The current supply link is calculated from the parent AppliedRule.
      supply_chain = self.getSupplyChain(parent_movement.getParentValue())
      parent_supply_link = self.getCurrentSupplyLink(parent_movement)
      current_supply_link_list = supply_chain.\
                     getPreviousProductionSupplyLinkList(parent_supply_link)
      if len(current_supply_link_list) != 1:
        # We shall no pass here.
        # The test method returned a wrong value !
75
        raise TransformationRuleError,\
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 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
              "Expand must not be called on %r" %\
                  applied_rule.getRelativeUrl()
      else:
        current_supply_link = current_supply_link_list[0]
        # Generate produced movement
        movement_dict = self._expandProducedResource(applied_rule,
                                                     production,
                                                     production_section,
                                                     current_supply_link)
        # Generate consumed movement
        consumed_mvt_dict = self._expandConsumedResource(applied_rule,
                                                         production,
                                                         production_section,
                                                         current_supply_link)
        movement_dict.update(consumed_mvt_dict)
        # Finally, build movement
        self._buildMovementList(applied_rule, movement_dict, **kw)
      # Expand each movement created
      Rule.expand(self, applied_rule, **kw)

    def _expandProducedResource(self, applied_rule, production,
                                production_section, current_supply_link):
      """
        Produced resource.
        Create a movement for the resource produced by the transformation.
        Only one produced movement can be created.
      """
      parent_movement = applied_rule.getParentValue()
      stop_date = parent_movement.getStartDate()
      produced_movement_dict = {
        'pr': {
          "resource": parent_movement.getResource(),
          # XXX what is lost quantity ?
          "quantity": parent_movement.getQuantity(),# + lost_quantity,
          "quantity_unit": parent_movement.getQuantityUnit(),
          "variation_category_list":\
                        parent_movement.getVariationCategoryList(),
          "variation_property_dict": \
                        parent_movement.getVariationPropertyDict(),
          "source_list": (),
          "source_section_list": (),
          "destination": production,
          "destination_section": production_section,
          'start_date': current_supply_link.calculateStartDate(stop_date),
          'stop_date': stop_date,
          'causality_value': current_supply_link,
        }
      }
      return produced_movement_dict

    def _expandConsumedResource(self, applied_rule, production,
                                production_section, current_supply_link):
      """
        Consumed resource.
        Create a movement for each resource consumed by the transformation,
        and for the previous variation of the produced resource.
      """
      # Calculate all consumed resource
      # Store each value in a dictionnary before created them.
      # { movement_id: {property_name: property_value,} ,}
      consumed_movement_dict = {}
      parent_movement = applied_rule.getParentValue()
      supply_chain = self.getSupplyChain(parent_movement.getParentValue())
      # Consumed previous variation
      previous_variation_dict = self._expandConsumedPreviousVariation(
                                                        applied_rule, 
                                                        production, 
                                                        production_section,
                                                        supply_chain,
                                                        current_supply_link)
      consumed_movement_dict.update(previous_variation_dict)
      # Consumed raw materials
      raw_material_dict = self._expandConsumedRawMaterials(
                                                        applied_rule, 
                                                        production, 
                                                        production_section,
                                                        supply_chain,
                                                        current_supply_link)
      consumed_movement_dict.update(raw_material_dict)
      return consumed_movement_dict

    def _expandConsumedPreviousVariation(self, applied_rule, production,
                                         production_section, supply_chain,
                                         current_supply_link):
      """
        Create a movement for the previous variation of the produced resource.
      """
      id_count = 1
      consumed_movement_dict = {}
      parent_movement = applied_rule.getParentValue()
      # Calculate the variation category list of parent movement
      base_category_list = parent_movement.getVariationBaseCategoryList()
      if "industrial_phase" in base_category_list:
        # We do not want to get the industrial phase variation
        base_category_list.remove("industrial_phase")
      category_list = parent_movement.getVariationCategoryList(
                                  base_category_list=base_category_list)
      # Calculate the previous variation
      for previous_supply_link in supply_chain.\
            getPreviousSupplyLinkList(current_supply_link):
        previous_ind_phase_list = supply_chain.\
            getPreviousProductionIndustrialPhaseList(previous_supply_link,
                                                     all=1)
        if previous_ind_phase_list != []:
          # Industrial phase is a category
          ind_phase_list = [x.getRelativeUrl() for x in \
                            previous_ind_phase_list]
          consumed_mvt_id = "%s_%s" % ("mr", id_count)
          id_count += 1
          stop_date = parent_movement.getStartDate()
          consumed_movement_dict[consumed_mvt_id] = {
            'start_date': current_supply_link.calculateStartDate(stop_date),
            'stop_date': stop_date,
            "resource": parent_movement.getResource(),
            # XXX Is the quantity value correct ?
            "quantity": parent_movement.getNetQuantity(), # getNetQuantity to support efficency from transformation
            "quantity_unit": parent_movement.getQuantityUnit(),
            "destination_list": (),
            "destination_section_list": (),
            "source": production,
            "source_section": production_section,
            "variation_category_list": category_list+ind_phase_list,
            "variation_property_dict": \
                        parent_movement.getVariationPropertyDict(),
            'causality_value': current_supply_link,
            }
      return consumed_movement_dict

    def _expandConsumedRawMaterials(self, applied_rule, production,
                                    production_section, supply_chain,
                                    current_supply_link):
      """
        Create a movement for each resource consumed by the transformation,
      """
      parent_movement = applied_rule.getParentValue()
      # Calculate the context for getAggregatedAmountList
      base_category_list = parent_movement.getVariationBaseCategoryList()
      if "industrial_phase" in base_category_list:
        # We do not want to get the industrial phase variation
        base_category_list.remove("industrial_phase")
      category_list = parent_movement.getVariationCategoryList(
                                  base_category_list=base_category_list)
      # Get the transformation to use
      transformation = self.getTransformation(applied_rule)
220 221 222
      # Generate the fake context
      tmp_context = parent_movement.asContext(categories=category_list)
      tmp_context.asComposedDocument = lambda *args: transformation
223 224 225
      # Calculate the industrial phase list
      previous_ind_phase_list = supply_chain.\
          getPreviousPackingListIndustrialPhaseList(current_supply_link)
226 227
      ind_phase_url_list = [x.getCategoryRelativeUrl()
                        for x in previous_ind_phase_list]
228 229 230
      # Call getAggregatedAmountList
      # XXX expand failed if transformation is not defined.
      # Do we need to catch the exception ?
231
      amount_list = tmp_context.getAggregatedAmountList()
232 233 234
      # Add entries in the consumed_movement_dict
      consumed_movement_dict = {}
      for amount in amount_list:
235 236 237 238 239 240
        model_line = amount.getCausalityValue()
        if model_line.getIndustrialPhase() not in ind_phase_url_list:
          continue
        consumed_mvt_id = "cr_%s_%s_%s" % (model_line.getParentId(),
                                           model_line.getId(),
                                           tmp_context.getId())
241 242 243 244 245 246 247 248 249 250 251 252 253
        stop_date = parent_movement.getStartDate()
        resource_price = amount.getResourcePrice()
        price = None
        if resource_price is not None:
          price = amount.getNetQuantity() * resource_price # getNetQuantity to support efficency from transformation
        consumed_movement_dict[consumed_mvt_id] = {
          'start_date': current_supply_link.calculateStartDate(stop_date),
          'stop_date': stop_date,
          "resource": amount.getResource(),
          "variation_category_list":\
                        amount.getVariationCategoryList(),
          "variation_property_dict": \
                        amount.getVariationPropertyDict(),
254
          "quantity": amount.getNetQuantity(), # getNetQuantity to support efficency from <
255 256 257 258 259 260 261 262 263 264 265 266 267 268 269
          "price": price,
          "quantity_unit": amount.getQuantityUnit(),
          "destination_list": (),
          "destination_section_list": (),
          "source": production,
          "source_section": production_section,
          'causality_value': current_supply_link,
        }
      return consumed_movement_dict

    security.declareProtected(Permissions.ModifyPortalContent, 'solve')
    def solve(self, applied_rule, solution_list):
      """
        Solve inconsistency according to a certain number of solutions
        templates. This updates the
Romain Courteaud's avatar
Romain Courteaud committed
270

271
        -> new status -> solved
272

273 274 275 276 277
        This applies a solution to an applied rule. Once
        the solution is applied, the parent movement is checked.
        If it does not diverge, the rule is reexpanded. If not,
        diverge is called on the parent movement.
      """
278

279 280 281 282
    security.declareProtected(Permissions.ModifyPortalContent, 'diverge')
    def diverge(self, applied_rule):
      """
        -> new status -> diverged
283

284 285 286
        This basically sets the rule to "diverged"
        and blocks expansion process
      """
287

288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
#    # Solvers
#    security.declareProtected(Permissions.View, 'isDivergent')
#    def isDivergent(self, applied_rule):
#      """
#        Returns 1 if divergent rule
#      """
#
#    security.declareProtected(Permissions.View, 'getDivergenceList')
#    def getDivergenceList(self, applied_rule):
#      """
#        Returns a list Divergence descriptors
#      """

    # Deliverability / orderability
    def isDeliverable(self, m):
      return 1
    def isOrderable(self, m):
      return 0
306