############################################################################## # # Copyright (c) 2002 Nexedi SARL and Contributors. All Rights Reserved. # Jean-Paul Smets-Solanes <jp@nexedi.com> # # 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 Globals import InitializeClass from AccessControl import ClassSecurityInfo from Products.CMFCore.utils import getToolByName from Products.CMFCore.WorkflowCore import WorkflowMethod from Products.ERP5Type import Permissions, PropertySheet, Constraint, Interface from Products.ERP5.Core import MetaNode, MetaResource from Products.ERP5.Document.Movement import Movement from zLOG import LOG # XXX Do we need to create groups ? (ie. confirm group include confirmed, getting_ready and ready parent_to_movement_simulation_state = { 'cancelled' : 'cancelled', 'draft' : 'draft', 'auto_planned' : 'auto_planned', 'planned' : 'planned', 'ordered' : 'planned', 'confirmed' : 'planned', 'getting_ready' : 'planned', 'ready' : 'planned', 'started' : 'planned', 'stopped' : 'planned', 'delivered' : 'planned', 'invoiced' : 'planned', } class SimulationMovement(Movement): """ Simulation movements belong to a simulation workflow which includes the following steps - planned - ordered - confirmed (the movement is now confirmed in qty or date) - started (the movement has started) - stopped (the movement is now finished) - delivered (the movement is now archived in a delivery) The simulation worklow uses some variables, which are set by the template - is_order_required - is_delivery_required XX - is_problem_checking_required ? Other flag (forzen flag) NEW: we do not use DCWorklow so that the simulation process can be as much as possible independent of a Zope / CMF implementation. """ meta_type = 'ERP5 Simulation Movement' portal_type = 'Simulation Movement' isMovement = 1 # Declarative security security = ClassSecurityInfo() security.declareObjectProtected(Permissions.View) # Declarative interfaces __implements__ = ( Interface.Variated, ) # Declarative properties property_sheets = ( PropertySheet.Base , PropertySheet.SimpleItem , PropertySheet.CategoryCore , PropertySheet.Amount , PropertySheet.Task , PropertySheet.Arrow , PropertySheet.Movement , PropertySheet.Simulation # Need industrial_phase , PropertySheet.TransformedResource , PropertySheet.AppliedRule , PropertySheet.ItemAggregation ) def tpValues(self) : """ show the content in the left pane of the ZMI """ return self.objectValues() # Price should be acquired security.declareProtected(Permissions.AccessContentsInformation, 'getPrice') def getPrice(self, context=None, REQUEST=None, **kw): """ """ return self._baseGetPrice() # Call the price method security.declareProtected(Permissions.AccessContentsInformation, 'getCausalityState') def getCausalityState(self): """ Returns the current state in causality """ return getattr(self, 'causality_state', 'solved') def setCausalityState(self, value): """ Change causality state """ self.causality_state = value security.declareProtected(Permissions.AccessContentsInformation, 'getSimulationState') def getSimulationState(self, id_only=1): """ Returns the current state in simulation Inherit from order or delivery or parent (but use a conversion table to make orders planned when parent is confirmed) XXX: movements in zero stock rule can not acquire simulation state """ delivery = self.getDeliveryValue() if delivery is not None: return delivery.getSimulationState() order = self.getOrderValue() if order is not None: return order.getSimulationState() try: parent_state = self.aq_parent.getSimulationState() return parent_to_movement_simulation_state[parent_state] except KeyError, AttributeError: LOG('ERP5 WARNING:',100, 'Could not acquire getSimulationState on %s' % self.getRelativeUrl()) return None # Acounting security.declareProtected(Permissions.AccessContentsInformation, 'isAccountable') def isAccountable(self): """ Returns 1 if this needs to be accounted Only account movements which are not associated to a delivery Whenever delivery is there, delivery has priority """ return (self.getDeliveryValue() is None) # Ordering / Delivering security.declareProtected(Permissions.AccessContentsInformation, 'requiresOrder') def requiresOrder(self): """ Returns 1 if this needs to be ordered """ if isOrderable(): return len(self.getCategoryMembership('order')) is 0 else: return 0 security.declareProtected(Permissions.AccessContentsInformation, 'requiresDelivery') def requiresDelivery(self): """ Returns 1 if this needs to be accounted """ if isDeliverable(): return len(self.getCategoryMembership('delivery')) is 0 else: return 0 ####################################################### # Causality Workflow Methods security.declareProtected(Permissions.ModifyPortalContent, 'expand') def expand(self, **kw): """ -> new status : expanded Parses all existing applied rules and make sure they apply. Checks other possible rules and starts expansion process (instanciates rule and calls expand on rule) Only movements which applied rule parent is expanded can be expanded. """ #LOG('In simulation expand',0, str(self.id)) # self.reindexObject() if self.getCausalityState() == 'expanded': # Reexpand for my_applied_rule in self.objectValues(): my_applied_rule.expand(**kw) else: portal_rules = getToolByName(self, 'portal_rules') # Parse each applied rule and test if it applied #for applied_rule in self.objectValues(): # if not applied_rule.test(): # # delete # Parse each rule and test if it applies for rule in portal_rules.objectValues(): if rule.test(self): my_applied_rule = rule.constructNewAppliedRule(self) my_applied_rule.expand() # Set to expanded self.setCausalityState('expanded') #expand = WorkflowMethod(expand) USELESS NOW # XXX moved to Portal Simulation # security.declareProtected(Permissions.ModifyPortalContent, 'solve') # def solve(self, solver, new_target=None): # """ # Makes the movement expandable again # # -> new status -> solved # # Once a movement has been updated with consistent # target and planned values, it is marked as solved # and can therefore be expanded again # """ # self.portal_simulation.applyTargetSolver(self, solver, new_target=new_target) # self.setCausalityState('solved') # # #solve = WorkflowMethod(solve) USELESS NOW security.declareProtected(Permissions.ModifyPortalContent, 'diverge') def diverge(self): """ -> new status -> diverged Movements which diverge can not be expanded """ self.setCausalityState('diverged') #diverge = WorkflowMethod(diverge) USELESS NOW # isDivergent is defined in movement # Optimized Reindexing security.declareProtected(Permissions.AccessContentsInformation, 'getMovementIndex') def getMovementIndex(self): """ Returns a list of indexable movements """ result = [ { 'uid' : self.getUid(), 'id' : self.getId(), 'portal_type' : self.getPortalType(), 'url' : self.getUrl(), 'relative_url' : self.getRelativeUrl(), 'parent_uid' : self.getParentUid(), 'simulation_state' : self.getSimulationState(), 'order_uid' : self.getOrderUid(), 'explanation_uid' : self.getExplanationUid(), #'delivery_uid' : self.getDeliveryUid(), 'source_uid' : self.getSourceUid(), 'destination_uid' : self.getDestinationUid(), 'source_section_uid' : self.getSourceSectionUid(), 'destination_section_uid' : self.getDestinationSectionUid(), 'resource_uid' : self.getResourceUid(), 'quantity' : self.getNetConvertedQuantity(), 'start_date' : self.getStartDate(), 'stop_date' : self.getStopDate(), 'target_quantity' : self.getNetConvertedTargetQuantity(), 'target_start_date' : self.getTargetStartDate(), 'target_stop_date' : self.getTargetStopDate(), 'price' : self.getPrice(), 'total_price' : self.getTotalPrice(), 'target_total_price' : self.getTargetTotalPrice(), 'has_cell_content' : 0, 'accountable' : self.isAccountable(), 'orderable' : self.isOrderable(), 'deliverable' : self.isDeliverable(), 'variation_text' : self.getVariationText(), 'inventory' : self.getInventoriatedQuantity(), 'source_asset_price' : self.getSourceAssetPrice(), 'destination_asset_price' : self.getDestinationAssetPrice(), } ] for m in self.objectValues(): result.extend(m.getMovementIndex()) return result security.declareProtected(Permissions.View, 'hasActivity') def hasActivity(self, **kw): """ We reindex the whole applied rule """ return self.getRootAppliedRule().hasActivity(**kw) security.declareProtected( Permissions.AccessContentsInformation, 'getExplanation') def getExplanation(self): """Returns the delivery's relative_url if any or the order's relative_url related to the root applied rule if any. """ explanation_value = self.getExplanationValue() if explanation_value is not None : return explanation_value.getRelativeUrl() security.declareProtected( Permissions.AccessContentsInformation, 'getExplanationUid') def getExplanationUid(self): """Returns the delivery's uid if any or the order's uid related to the root applied rule if any. """ explanation_value = self.getExplanationValue() if explanation_value is not None : return explanation_value.getUid() security.declareProtected( Permissions.AccessContentsInformation, 'getExplanationValue') def getExplanationValue(self): """Returns the delivery if any or the order related to the root applied rule if any. """ if self.getDeliveryValue() is None: ra = self.getRootAppliedRule() order = ra.getCausalityValue() if order is not None: return order else: # Ex. zero stock rule return ra else: explanation_value = self.getDeliveryValue() while explanation_value.getPortalType() not in \ self.getPortalDeliveryTypeList() and \ explanation_value != self.getPortalObject(): explanation_value = explanation_value.getParent() if explanation_value != self.getPortalObject(): return explanation_value def isFrozen(self): """ A frozen simulation movement can not change its target anylonger Also, once a movement is frozen, we do not calculate anylonger its direct consequences. (ex. we do not calculate again a transformation) """ return 0 # Deliverability / orderability security.declareProtected(Permissions.AccessContentsInformation, 'isOrderable') def isOrderable(self): applied_rule = self.aq_parent rule = applied_rule.getSpecialiseValue() if rule is not None: return rule.isOrderable(self) return 0 getOrderable = isOrderable security.declareProtected(Permissions.AccessContentsInformation, 'isDeliverable') def isDeliverable(self): applied_rule = self.aq_parent rule = applied_rule.getSpecialiseValue() if rule is not None: return rule.isDeliverable(self) return 0 getDeliverable = isDeliverable # Simulation Dates - acquire target dates security.declareProtected(Permissions.AccessContentsInformation, 'getOrderStartDate') def getOrderStartDate(self): order_value = self.getOrderValue() if order_value is not None: return order_value.getStartDate() security.declareProtected(Permissions.AccessContentsInformation, 'getOrderStopDate') def getOrderStopDate(self): order_value = self.getOrderValue() if order_value is not None: return order_value.getStopDate() security.declareProtected(Permissions.AccessContentsInformation, 'getDeliveryStartDateList') def getDeliveryStartDateList(self): """ Returns the stop date of related delivery(s) """ start_date_list = [] delivery_movement = self.getDeliveryValue() if delivery_movement is not None: start_date_list.append(delivery_movement.getStartDate()) return start_date_list security.declareProtected(Permissions.AccessContentsInformation, 'getDeliveryStopDateList') def getDeliveryStopDateList(self): """ Returns the stop date of related delivery(s) """ stop_date_list = [] delivery_movement = self.getDeliveryValue() if delivery_movement is not None: stop_date_list.append(delivery_movement.getStopDate()) return stop_date_list security.declareProtected(Permissions.AccessContentsInformation, 'getDeliveryQuantity') def getDeliveryQuantity(self): """ Returns the quantity of related delivery(s) """ quantity = None delivery_movement = self.getDeliveryValue() if delivery_movement is not None: quantity = delivery_movement.getQuantity() return quantity security.declareProtected(Permissions.AccessContentsInformation, 'isConvergent') def isConvergent(self): """ Returns true if the Simulation Movement is convergent comparing to the delivery value """ return not self.isDivergent() security.declareProtected(Permissions.AccessContentsInformation, 'isDivergent') def isDivergent(self): """ Returns true if the Simulation Movement is divergent comparing to the delivery value """ delivery = self.getDeliveryValue() if delivery is None: return 0 # XXX Those properties are the same than defined in DeliveryBuilder. # We need to defined it only 1 time. #LOG('SimulationMovement.isDivergent',0,delivery.getPath()) #LOG('SimulationMovement.isDivergent self.getStartDate()',0,self.getStartDate()) #LOG('SimulationMovement.isDivergent delivery.getStartDate()',0,delivery.getStartDate()) if self.getSourceSection() != delivery.getSourceSection() or \ self.getDestinationSection() != delivery.getDestinationSection() or \ self.getSource() != delivery.getSource() or \ self.getDestination() != delivery.getDestination() or \ self.getResource() != delivery.getResource() or \ self.getVariationCategoryList() != delivery.getVariationCategoryList()\ or \ self.getStartDate() != delivery.getStartDate() or \ self.getStopDate() != delivery.getStopDate(): # for method in ["getSourceSection", # "getDestinationSection", # "getSource", # "getDestination", # "getResource", # "getVariationCategoryList", # "getStartDate", # "getStopDate"]: # LOG("SimulationMovement, isDivergent", 0, # "method: %s, self: %s , delivery: %s" % \ # tuple([method]+[str(getattr(x,method)()) for x in (self, delivery)])) return 1 d_quantity = delivery.getQuantity() if d_quantity is None: d_quantity = 0 quantity = self.getCorrectedQuantity() d_error = self.getDeliveryError() if quantity is None: if d_quantity is None: return 0 return 1 if d_error is None: d_error = 0 delivery_ratio = self.getDeliveryRatio() if delivery_ratio is not None: d_quantity *= delivery_ratio #LOG('SimulationMovement.isDivergent d_quantity',0,d_quantity) #LOG('SimulationMovement.isDivergent quantity + d_error',0,quantity + d_error) if d_quantity != quantity + d_error: return 1 return 0 security.declareProtected(Permissions.View, 'setDefaultDeliveryProperties') def setDefaultDeliveryProperties(self): """ Sets the delivery_ratio and delivery_error properties to the calculated value """ delivery = self.getDeliveryValue() if delivery is not None: delivery.updateSimulationDeliveryProperties(movement_list = [self]) security.declareProtected(Permissions.View, 'getCorrectedQuantity') def getCorrectedQuantity(self): """ Returns the quantity property deducted by the possible profit_quantity """ quantity = self.getQuantity() profit_quantity = self.getProfitQuantity() if quantity is not None: if profit_quantity: return quantity - profit_quantity return quantity return None security.declareProtected(Permissions.View, 'getRootSimulationMovement') def getRootSimulationMovement(self): """ Return the root simulation movement in the simulation tree. """ parent_applied_rule = self.getParent() if parent_applied_rule.getRootAppliedRule() == parent_applied_rule: return self else: return parent_applied_rule.getRootSimulationMovement() # XXX FIXME Use a interaction workflow instead # The call to activate() must be done after actual call to # setDelivery() on the movement, # but activate() must be called on the previous delivery... def _setDelivery(self, value): LOG('setDelivery before', 0, '') delivery_value = self.getDeliveryValue() Movement.setDelivery(value) LOG('setDelivery', 0, '') if delivery_value is not None: LOG('delivery_value = ', 0, repr(delivery_value)) activity = delivery_value.activate( activity='SQLQueue', after_path_and_method_id=( self.getPath(), ['immediateReindexObject', 'recursiveImmediateReindexObject'])) activity.edit()