############################################################################## # # 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, PersistentMapping from AccessControl import ClassSecurityInfo from Acquisition import aq_base from Products.CMFCore.WorkflowCore import WorkflowAction from Products.ERP5Type import Permissions, PropertySheet, Constraint, Interface from Products.ERP5Type.XMLMatrix import XMLMatrix from Products.ERP5Type.XMLObject import XMLObject from Products.ERP5Type.Base import Base from Products.ERP5.Document.Movement import Movement from Products.ERP5.Variated import Variated from Products.CMFCategory.Renderer import Renderer from zLOG import LOG class DeliveryLine(Movement, XMLObject, XMLMatrix, Variated): """ A DeliveryLine object allows to implement lines in Deliveries (packing list, order, invoice, etc.) It may include a price (for insurance, for customs, for invoices, for orders) """ meta_type = 'ERP5 Delivery Line' portal_type = 'Delivery Line' # Declarative security security = ClassSecurityInfo() security.declareObjectProtected(Permissions.View) # Declarative interfaces __implements__ = ( Interface.Variated, ) # Declarative properties property_sheets = ( PropertySheet.Base , PropertySheet.XMLObject , PropertySheet.CategoryCore , PropertySheet.Amount , PropertySheet.Task , PropertySheet.Arrow , PropertySheet.Movement , PropertySheet.Price , PropertySheet.VariationRange , PropertySheet.ItemAggregation ) # Multiple inheritance definition updateRelatedContent = XMLMatrix.updateRelatedContent # Explicit acquisition of aq_dynamic generated method security.declareProtected(Permissions.AccessContentsInformation, 'getSimulationState') def getSimulationState(self): """ Explicitly acquire simulation_state from parent """ if hasattr(self.getParent(),'getSimulationState'): return self.getParent().getSimulationState() return None # Force in _edit to modify variation_base_category_list first security.declarePrivate( '_edit' ) def _edit(self, REQUEST=None, force_update = 0, **kw): # We must first prepare the variation_base_category_list before we do the edit of the rest #LOG('in edit', 0, str(kw)) if kw.has_key('variation_base_category_list'): self._setVariationBaseCategoryList( kw['variation_base_category_list'] ) if kw.has_key('variation_category_list'): self._setVariationCategoryList( kw['variation_category_list'] ) Movement._edit(self, REQUEST=REQUEST, force_update = force_update, **kw) # This one must be the last if kw.has_key('item_id_list'): self._setItemIdList( kw['item_id_list'] ) if self.isSimulated(): self.getRootDeliveryValue().edit() # So that we make sure that automatic workflow transitions # will be activated on the delivery self.getRootDeliveryValue().activate().propagateResourceToSimulation() # We must check if the user has changed the resource of particular line security.declareProtected( Permissions.ModifyPortalContent, 'edit' ) def edit(self, REQUEST=None, force_update = 0, reindex_object=1, **kw): return self._edit(REQUEST=REQUEST, force_update=force_update, reindex_object=reindex_object, **kw) 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.aq_parent.isAccountable() and (not self.hasCellContent()) def _getTotalPrice(self, context): base_id = 'movement' if not self.hasCellContent(base_id=base_id): quantity = self.getQuantity() or 0.0 price = self.getPrice(context=context) or 0.0 return quantity * price else: # Use MySQL aggregate = self.DeliveryLine_zGetTotal()[0] return aggregate.total_price or 0.0 security.declareProtected(Permissions.AccessContentsInformation, 'getTotalQuantity') def getTotalQuantity(self): """ Returns the quantity if no cell or the total quantity if cells """ base_id = 'movement' if not self.hasCellContent(base_id=base_id): return self.getQuantity() else: # Use MySQL aggregate = self.DeliveryLine_zGetTotal()[0] return aggregate.total_quantity or 0.0 security.declareProtected( Permissions.ModifyPortalContent, 'hasCellContent' ) def hasCellContent(self, base_id='movement'): """ This method can be overriden """ # Do not use XMLMatrix.hasCellContent, because it can generate # inconsistency in catalog # Exemple: define a line and set the matrix cell range, but do not create # cell. # Line was in this case consider like a movement, and was catalogued. # But, getVariationText of the line was not empty. # So, in ZODB, resource as without variation, but in catalog, this was # the contrary... return int(XMLMatrix.getCellRange(self, base_id=base_id) != []) security.declareProtected( Permissions.AccessContentsInformation, 'getCellValueList' ) def getCellValueList(self, base_id='movement'): """ This method can be overriden """ return XMLMatrix.getCellValueList(self, base_id=base_id) security.declareProtected( Permissions.View, 'getCell' ) def getCell(self, *kw , **kwd): """ This method can be overriden """ if 'base_id' not in kwd: kwd['base_id'] = 'movement' return XMLMatrix.getCell(self, *kw, **kwd) security.declareProtected( Permissions.ModifyPortalContent, 'newCell' ) def newCell(self, *kw, **kwd): """ This method creates a new cell """ if 'base_id' not in kwd: kwd['base_id'] = 'movement' return XMLMatrix.newCell(self, *kw, **kwd) security.declareProtected(Permissions.View, 'isDivergent') def isDivergent(self): """ Returns 1 if the target is not met according to the current information After and edit, the isOutOfTarget will be checked. If it is 1, a message is emitted emit targetUnreachable ! """ if self.hasCellContent(): for cell in self.contentValues(filter={'portal_type': 'Delivery Cell'}): if cell.isDivergent(): return 1 else: return Movement.isDivergent(self) def applyToDeliveryLineRelatedMovement(self, portal_type='Simulation Movement', method_id = 'expand'): # Find related in simulation for my_simulation_movement in self.getDeliveryRelatedValueList( portal_type = 'Simulation Movement'): # And apply getattr(my_simulation_movement.getObject(), method_id)() for c in self.contentValues(filter={'portal_type': 'Delivery Cell'}): for my_simulation_movement in c.getDeliveryRelatedValueList( portal_type = 'Simulation Movement'): # And apply getattr(my_simulation_movement.getObject(), method_id)() def reindexObject(self, *k, **kw): """ Reindex children and simulation """ if self.isIndexable: # Reindex children self.activate().recursiveImmediateReindexObject() security.declareProtected(Permissions.AccessContentsInformation, 'getInventoriatedQuantity') def getInventoriatedQuantity(self): """ """ return Movement.getInventoriatedQuantity(self) security.declareProtected(Permissions.AccessContentsInformation, 'getInventoriatedStartDate') def getInventoriatedStartDate(self): """ """ return Movement.getStartDate(self) security.declareProtected(Permissions.AccessContentsInformation, 'getInventoriatedStopDate') def getInventoriatedStopDate(self): """ """ return Movement.getStopDate(self) def _setItemIdList(self, value): """ Computes total_quantity of all given items and stores this total_quantity in the quantity attribute of the cell """ if value is None: return previous_item_list = self.getAggregateValueList() given_item_id_list = value item_object_list = [] for item in given_item_id_list : item_result_list = self.portal_catalog(id = item, portal_type="Piece Tissu") if len(item_result_list) == 1 : try : object = item_result_list[0].getObject() except : object = None else : object = None if object is not None : # if item was in previous_item_list keep it if object in previous_item_list : # we can add this item to the list of aggregated items item_object_list.append(object) # if new item verify if variated_resource of item == variated_resource of movement elif (self.getResource() == object.getResource()) and (self.getVariationCategoryList() == object.getVariationCategoryList()) : # now verify if item can be moved (not already done) last_location_title = object.getLastLocationTitle() if self.getDestinationTitle() != last_location_title or last_location_title == '' : # we can add this item to the list of aggregated items item_object_list.append(object) # update item_id_list and build relation self.setAggregateValueList(item_object_list) # update quantity if needed if len(item_object_list)>0 : quantity = 0 for object_item in item_object_list : if self.aq_parent.getPortalType() in ('Purchase Packing List', ) : quantity += object_item.getQuantity() else : quantity += object_item.getRemainingQuantity() # we reset the location of the item object_item.setLocation('') self.setTargetQuantity(quantity) security.declarePrivate('_checkConsistency') def _checkConsistency(self, fixit=0, mapped_value_property_list = ('quantity', 'price')): """ Check the constitency of transformation elements """ error_list = XMLMatrix._checkConsistency(self, fixit=fixit) # First quantity # We build an attribute equality and look at all cells q_constraint = Constraint.AttributeEquality( domain_base_category_list = self.getVariationBaseCategoryList(), predicate_operator = 'SUPERSET_OF', mapped_value_property_list = mapped_value_property_list ) for k in self.getCellKeys(base_id = 'movement'): kw={} kw['base_id'] = 'movement' c = self.getCell(*k, **kw) if c is not None: predicate_value = [] for p in k: if p is not None: predicate_value += [p] q_constraint.edit(predicate_value_list = predicate_value) if fixit: error_list += q_constraint.fixConsistency(c) else: error_list += q_constraint.checkConsistency(c) if list(c.getVariationCategoryList()) != predicate_value: error_message = "Variation %s but sould be %s" % (c.getVariationCategoryList(),predicate_value) if fixit: c.setVariationCategoryList(predicate_value) error_message += " (Fixed)" error_list += [(c.getRelativeUrl(), 'VariationCategoryList inconsistency', 100, error_message)] return error_list # Simulation Consistency Check def getSimulationQuantity(self): """ Computes the quantities in the simulation """ if not self.hasCellContent(): result = self.DeliveryLine_zGetRelatedQuantity(uid=self.getUid()) if len(result) > 0: return result[0].quantity return None def getSimulationSourceList(self): """ Computes the sources in the simulation """ result = self.DeliveryLine_zGetRelatedSource(uid=self.getUid()) return map(lambda x: x.source, result) def getSimulationDestinationList(self): """ Computes the destinations in the simulation """ result = self.DeliveryLine_zGetRelatedDestination(uid=self.getUid()) return map(lambda x: x.destination, result) def getSimulationSourceSectionList(self): """ Computes the source sections in the simulation """ result = self.DeliveryLine_zGetRelatedSourceSection(uid=self.getUid()) return map(lambda x: x.source_section, result) def getSimulationDestinationSectionList(self): """ Computes the destination sections in the simulation """ result = self.DeliveryLine_zGetRelatedDestinationSection(uid=self.getUid()) return map(lambda x: x.destination_section, result) security.declareProtected(Permissions.AccessContentsInformation, 'getStopDate') def getRootDeliveryValue(self): """ Returns the root delivery responsible of this line """ return self.getParent().getRootDeliveryValue() security.declareProtected(Permissions.ModifyPortalContent, 'updateSimulationDeliveryProperties') def updateSimulationDeliveryProperties(self, movement_list = None): """ Set properties delivery_ratio and delivery_error for each simulation movement in movement_list (all movements by default), according to this delivery calculated quantity """ parent = self.getParent() if parent is not None: parent.updateSimulationDeliveryProperties(movement_list, self) # XXX Copied security.declareProtected(Permissions.AccessContentsInformation, \ 'getVariationRangeCategoryItemList') def getVariationRangeCategoryItemList(self): """ Returns possible variation category values for the order line according to the default resource. Possible category values is provided as a list of tuples (id, title). This is mostly useful in ERP5Form instances to generate selection menus. """ resource = self.getResourceValue() if resource != None: result = resource.getVariationCategoryItemList( omit_individual_variation=0) else: result = [] return result security.declareProtected(Permissions.AccessContentsInformation, \ 'getVariationRangeCategoryList') def getVariationRangeCategoryList(self): """ Returns possible variation category values for the order line according to the default resource. """ return [x[1] for x in self.getVariationRangeCategoryItemList()] # XXX Copied from Transformation security.declareProtected(Permissions.AccessContentsInformation, 'getVariationCategoryItemList') def getVariationCategoryItemList(self, base_category_list=(), base=1, display_id='title', current_category=None): """ 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.getVariationRangeBaseCategoryList() for base_category in base_category_list: variation_category_list = self.getVariationCategoryList( base_category_list=[base_category]) resource_list = [self.portal_categories.resolveCategory(x) for x in\ variation_category_list] category_list = [x for x in resource_list \ if x.getPortalType() == 'Category'] variation_category_item_list.extend(Renderer( is_right_display=0, display_base_category=1, display_none_category=0, base=base, current_category=current_category, display_id='logical_path').\ render(category_list)) object_list = [x for x in resource_list \ if x.getPortalType() != 'Category'] variation_category_item_list.extend(Renderer( is_right_display=0, display_base_category=1, base_category=base_category, display_none_category=0, base=base, current_category=current_category, display_id=display_id).\ render(object_list)) return variation_category_item_list