MovementGroup.py

##############################################################################
#
# Copyright (c) 2002 Nexedi SARL and Contributors. All Rights Reserved.
#                    Sebastien Robin <seb@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.
#
##############################################################################

"""
Define in this class all classes intended to group every kind of movement
"""

from Products.ERP5Type.Base import Base
from Products.ERP5Type.Document.Folder import Folder
from Products.ERP5Type import Permissions, PropertySheet, Constraint, Interface
from AccessControl import ClassSecurityInfo
from Globals import InitializeClass, DTMLFile
from Products.CMFCategory.Category import Category
from zLOG import LOG

manage_addRootMovementGroupForm=DTMLFile('dtml/SimulationTool_addRootMovementGroup', globals())

def addRootMovementGroup( self, id, title='', REQUEST=None ):
    """
        Add a new Order Movement
    """
    sf = RootMovementGroup( id )
    sf._setTitle(title)
    self._setObject( id, sf )
    sf = self._getOb( id )
    sf.reindexObject()
    if REQUEST is not None:
        return self.manage_main(self, REQUEST, update_menu=1)

class RootMovementGroup(Folder):

  meta_type = 'ERP5 Root Movement Group'
  portal_type = 'Root Movement Group'
  add_permission = Permissions.AddPortalContent
  isPortalContent = 1
  isRADContent = 1
  icon = 'portal.gif'

  # Declarative security
  security = ClassSecurityInfo()
  security.declareObjectProtected(Permissions.View)

  # Declarative constructors
  constructors =   (manage_addRootMovementGroupForm, addRootMovementGroup,)

  property_sheets = ( PropertySheet.Base,
                      PropertySheet.DublinCore,
                    )

  def getNestedClass(self, check_list):
    if len(check_list)>0:
      return check_list[0]
    return None

  def setNestedClass(self,check_list=None):
    """
      This sets an appropriate nested class.
    """
    
    LOG('RootGroup.setNestedClass, check_list:',0,check_list)
    for i in range(len(check_list)):
      LOG('RootGroup.setNestedClass, check_list[i]:',0,check_list[i])
      LOG('RootGroup.setNestedClass, check_list[i].getId():',0,check_list[i].getId())
      LOG('RootGroup.setNestedClass, self.getId():',0,self.getId())
      if check_list[i].getId() == self.getId():
        break
    else:
      raise RuntimeError, "no appropriate nested class is found for %s" % str(self)

    self.nested_class = self.getNestedClass(check_list[i+1:])

  def initialize(self, movement=None,check_list=None):
    self.nested_class = None
    self.setNestedClass(check_list=check_list)
    self.movement_list = []
    self.group_list = []
    if movement is not None :
      self.append(movement,check_list=check_list)

  def appendGroup(self, movement,check_list=None):
    if self.nested_class is not None:
      LOG('RootGroup.appendGroup, check_list',0,check_list)
      nested_instance = self.nested_class.getInstance(movement=movement,check_list=check_list)
      self.group_list.append(nested_instance)

  def append(self,movement,check_list=None):
    self.movement_list.append(movement)
    movement_in_group = 0
    for group in self.group_list :
      if group.test(movement) :
        group.append(movement)
        movement_in_group = 1
        break
    if movement_in_group == 0 :
      LOG('RootGroup.append, check_list',0,check_list)
      self.appendGroup(movement,check_list=check_list)

  def getInstance(self,movement=None,check_list=None):
    group = RootMovementGroup('root_movement_group')
    # We should append self to the check_list
    check_list = [self] + check_list
    group.initialize(movement=movement,check_list=check_list)
    return group

manage_addOrderMovementGroupForm=DTMLFile('dtml/SimulationTool_addOrderMovementGroup', globals())

def addOrderMovementGroup( self, id, title='', REQUEST=None ):
    """
        Add a new Order Movement
    """
    sf = OrderMovementGroup( id )
    sf._setTitle(title)
    self._setObject( id, sf )
    sf = self._getOb( id )
    sf.reindexObject()
    if REQUEST is not None:
        return self.manage_main(self, REQUEST, update_menu=1)

class OrderMovementGroup(RootMovementGroup,Folder):

  meta_type = 'ERP5 Order Movement Group'
  portal_type = 'Order Movement Group'
  add_permission = Permissions.AddPortalContent
  isPortalContent = 1
  isRADContent = 1
  icon = 'portal.gif'

  # Declarative constructors
  constructors =   (manage_addOrderMovementGroupForm, addOrderMovementGroup,)

  property_sheets = ( PropertySheet.Base,
                      PropertySheet.DublinCore,
                    )

  def initialize(self,movement,**kw):
    LOG('OrderMovementGroup.initialize, kw:',0,kw)
    RootMovementGroup.initialize(self,movement,**kw)
    if hasattr(movement, 'getRootAppliedRule'):
      # This is a simulation movement
      order_value = movement.getRootAppliedRule().getCausalityValue(
                                                portal_type=order_type_list)
      if order_value is None:
        # In some cases (ex. DeliveryRule), there is no order
        # we may consider a PackingList as the order in the OrderGroup
        order_value = movement.getRootAppliedRule().getCausalityValue(
                        portal_type=delivery_type_list)
    else:
      # This is a temp movement
      order_value = None
    if order_value is None:
      order_relative_url = None
    else:
      # get the id of the enclosing delivery
      # for this cell or line
      order_relative_url = order_value.getRelativeUrl()
    self.order = order_relative_url

  def test(self,movement):
    if hasattr(movement, 'getRootAppliedRule'):
      order_value = movement.getRootAppliedRule().getCausalityValue(
                                                  portal_type=order_type_list)

      if order_value is None:
        # In some cases (ex. DeliveryRule), there is no order
        # we may consider a PackingList as the order in the OrderGroup
        order_value = movement.getRootAppliedRule().getCausalityValue(
                        portal_type=delivery_type_list)
    else:
      # This is a temp movement
      order_value = None
    if order_value is None:
      order_relative_url = None
    else:
      # get the id of the enclosing delivery
      # for this cell or line
      order_relative_url = order_value.getRelativeUrl()
    if order_relative_url == self.order:
      return 1
    else :
      return 0

  def getInstance(self,movement=None,check_list=None):
    group = OrderMovementGroup('order_movement_group')
    LOG('OrderGroup.getInstance, check_list:',0,check_list)
    group.initialize(movement=movement,check_list=check_list)
    return group

manage_addPathMovementGroupForm=DTMLFile('dtml/SimulationTool_addPathMovementGroup', globals())

def addPathMovementGroup( self, id, title='', REQUEST=None ):
    """
        Add a new Order Movement
    """
    sf = PathMovementGroup( id )
    sf._setTitle(title)
    self._setObject( id, sf )
    sf = self._getOb( id )
    sf.reindexObject()
    if REQUEST is not None:
        return self.manage_main(self, REQUEST, update_menu=1)

class PathMovementGroup(RootMovementGroup,Folder):

  meta_type = 'ERP5 Path Movement Group'
  portal_type = 'Path Movement Group'
  add_permission = Permissions.AddPortalContent
  isPortalContent = 1
  isRADContent = 1
  icon = 'portal.gif'

  # Declarative constructors
  constructors =   (manage_addPathMovementGroupForm, addPathMovementGroup,)

  property_sheets = ( PropertySheet.Base,
                      PropertySheet.DublinCore,
                    )

  def initialize(self,movement,**kw):
    RootMovementGroup.initialize(self,movement,**kw)
    self.source = movement.getSource()
    LOG('PathGroup.initialize source',0,self.source)
    self.destination = movement.getDestination()
    LOG('PathGroup.initialize destination',0,self.destination)
    self.source_section = movement.getSourceSection()
    LOG('PathGroup.initialize source_section',0,self.source_section)
    self.destination_section = movement.getDestinationSection()
    LOG('PathGroup.initialize destination_section',0,self.destination_section)
    self.target_source = movement.getTargetSource()
    LOG('PathGroup.initialize target_source',0,self.target_source)
    self.target_destination = movement.getTargetDestination()
    LOG('PathGroup.initialize target_destination',0,self.target_destination)
    self.target_source_section = movement.getTargetSourceSection()
    LOG('PathGroup.initialize target_source_section',0,self.target_source_section)
    self.target_destination_section = movement.getTargetDestinationSection()
    LOG('PathGroup.initialize target_destination_section',0,self.target_destination_section)


  def test(self,movement):
    if movement.getSource() == self.source and \
      movement.getDestination() == self.destination and \
      movement.getSourceSection() == self.source_section and \
      movement.getDestinationSection() == self.destination_section and \
      movement.getTargetSource() == self.target_source and \
      movement.getTargetDestination() == self.target_destination and \
      movement.getTargetSourceSection() == self.target_source_section and \
      movement.getTargetDestinationSection() == self.target_destination_section :

      return 1
    else :
      return 0

  def getInstance(self,movement=None,check_list=None):
    group =  PathMovementGroup('path_movement_group')
    LOG('PathGroup.getInstance, check_list:',0,check_list)
    group.initialize(movement=movement,check_list=check_list)
    return group

manage_addDateMovementGroupForm=DTMLFile('dtml/SimulationTool_addDateMovementGroup', globals())

def addDateMovementGroup( self, id, title='', REQUEST=None ):
    """
        Add a new Order Movement
    """
    sf = DateMovementGroup( id )
    sf._setTitle(title)
    self._setObject( id, sf )
    sf = self._getOb( id )
    sf.reindexObject()
    if REQUEST is not None:
        return self.manage_main(self, REQUEST, update_menu=1)

class DateMovementGroup(RootMovementGroup,Folder):

  meta_type = 'ERP5 Date Movement Group'
  portal_type = 'Date Movement Group'
  add_permission = Permissions.AddPortalContent
  isPortalContent = 1
  isRADContent = 1
  icon = 'portal.gif'

  # Declarative constructors
  constructors =   (manage_addDateMovementGroupForm, addDateMovementGroup,)

  property_sheets = ( PropertySheet.Base,
                      PropertySheet.DublinCore,
                    )

  def initialize(self,movement,**kw):
    RootMovementGroup.initialize(self,movement,**kw)
    self.target_start_date = movement.getTargetStartDate()
    self.target_stop_date = movement.getTargetStopDate()
    self.start_date = movement.getStartDate()
    self.stop_date = movement.getStopDate()

  def test(self,movement):
    if movement.getStartDate() == self.start_date and \
      movement.getStopDate() == self.stop_date :
      return 1
    else :
      return 0

  def getInstance(self,movement=None,check_list=None):
    group = DateMovementGroup('date_movement_group')
    group.initialize(movement=movement,check_list=check_list)
    return group

manage_addCriterionMovementGroupForm=DTMLFile('dtml/SimulationTool_addCriterionMovementGroup', globals())

def addCriterionMovementGroup( self, id, title='', REQUEST=None ):
    """
        Add a new Order Movement
    """
    sf = CriterionMovementGroup( id )
    sf._setTitle(title)
    self._setObject( id, sf )
    sf = self._getOb( id )
    sf.reindexObject()
    if REQUEST is not None:
        return self.manage_main(self, REQUEST, update_menu=1)

class CriterionMovementGroup(RootMovementGroup,Folder):

  meta_type = 'ERP5 Criterion Movement Group'
  portal_type = 'Criterion Movement Group'
  add_permission = Permissions.AddPortalContent
  isPortalContent = 1
  isRADContent = 1
  icon = 'portal.gif'

  # Declarative constructors
  constructors =   (manage_addCriterionMovementGroupForm, addCriterionMovementGroup,)

  property_sheets = ( PropertySheet.Base,
                      PropertySheet.DublinCore,
                    )

  def initialize(self,movement,**kw):
    RootMovementGroup.initialize(self,movement,**kw)
    if hasattr(movement, 'getGroupCriterion'):
      self.criterion = movement.getGroupCriterion()
    else:
      self.criterion = None

  def test(self,movement):
    # we must have the same criterion
    if hasattr(movement, 'getGroupCriterion'):
      criterion = movement.getGroupCriterion()
    else:
      criterion = None
    return self.criterion == criterion

  def getInstance(self,movement=None,check_list=None):
    group = CriterionMovementGroup('criterion_movement_group')
    group.initialize(movement=movement,check_list=check_list)
    return group

manage_addResourceMovementGroupForm=DTMLFile('dtml/SimulationTool_addResourceMovementGroup', globals())

def addResourceMovementGroup( self, id, title='', REQUEST=None ):
    """
        Add a new Order Movement
    """
    sf = ResourceMovementGroup( id )
    sf._setTitle(title)
    self._setObject( id, sf )
    sf = self._getOb( id )
    sf.reindexObject()
    if REQUEST is not None:
        return self.manage_main(self, REQUEST, update_menu=1)

class ResourceMovementGroup(RootMovementGroup,Base):

  meta_type = 'ERP5 Resource Movement Group'
  portal_type = 'Resource Movement Group'
  add_permission = Permissions.AddPortalContent
  isPortalContent = 1
  isRADContent = 1
  icon = 'portal.gif'

  # Declarative constructors
  constructors =   (manage_addResourceMovementGroupForm, addResourceMovementGroup,)

  property_sheets = ( PropertySheet.Base,
                      PropertySheet.DublinCore,
                    )

  def initialize(self,movement,**kw):
    RootMovementGroup.initialize(self,movement,**kw)
    self.resource = movement.getResource()

  def test(self,movement):
    if movement.getResource() == self.resource :
      return 1
    else :
      return 0

  def getInstance(self,movement=None,check_list=None):
    group = ResourceMovementGroup('resource_movement_group')
    group.initialize(movement=movement,check_list=check_list)
    return group

manage_addBaseVariantMovementGroupForm=DTMLFile('dtml/SimulationTool_addBaseVariantMovementGroup', globals())

def addBaseVariantMovementGroup( self, id, title='', REQUEST=None ):
    """
        Add a new Order Movement
    """
    sf = BaseVariantMovementGroup( id )
    sf._setTitle(title)
    self._setObject( id, sf )
    sf = self._getOb( id )
    sf.reindexObject()
    if REQUEST is not None:
        return self.manage_main(self, REQUEST, update_menu=1)

class BaseVariantMovementGroup(RootMovementGroup,Folder):

  meta_type = 'ERP5 Base Variant Movement Group'
  portal_type = 'Base Variant Movement Group'
  add_permission = Permissions.AddPortalContent
  isPortalContent = 1
  isRADContent = 1
  icon = 'portal.gif'

  # Declarative constructors
  constructors =   (manage_addBaseVariantMovementGroupForm, addBaseVariantMovementGroup,)

  property_sheets = ( PropertySheet.Base,
                      PropertySheet.DublinCore,
                    )

  def initialize(self,movement,**kw):
    RootMovementGroup.initialize(self,movement,**kw)
    self.base_category_list = movement.getVariationBaseCategoryList()
    if self.base_category_list is None:
      LOG('BaseVariantGroup initialize', 0, 'movement = %s, movement.showDict() = %s' % (repr(movement), repr(movement.showDict())))
      self.base_category_list = []

  def test(self,movement):
    # we must have the same number of categories
    categories_identity = 0
    #LOG('BaseVariantGroup', 0, 'self.base_category_list = %s, movement = %s, movement.getVariationBaseCategoryList() = %s' % (repr(self.base_category_list), repr(movement), repr(movement.getVariationBaseCategoryList())))
    movement_base_category_list = movement.getVariationBaseCategoryList()
    if movement_base_category_list is None:
      LOG('BaseVariantGroup test', 0, 'movement = %s, movement.showDict() = %s' % (repr(movement), repr(movement.showDict())))
      movement_base_category_list = []
    if len(self.base_category_list) == len(movement_base_category_list):
      for category in movement_base_category_list:
        if not category in self.base_category_list :
          break
      else :
        categories_identity = 1
    return categories_identity

  def getInstance(self,movement=None,check_list=None):
    group = BaseVariantMovementGroup('base_variant_movement_group')
    group.initialize(movement=movement,check_list=check_list)
    return group

manage_addVariantMovementGroupForm=DTMLFile('dtml/SimulationTool_addVariantMovementGroup', globals())

def addVariantMovementGroup( self, id, title='', REQUEST=None ):
    """
        Add a new Order Movement
    """
    sf = VariantMovementGroup( id )
    sf._setTitle(title)
    self._setObject( id, sf )
    sf = self._getOb( id )
    sf.reindexObject()
    if REQUEST is not None:
        return self.manage_main(self, REQUEST, update_menu=1)

class VariantMovementGroup(RootMovementGroup,Folder):

  meta_type = 'ERP5 Variant Movement Group'
  portal_type = 'Variant Movement Group'
  add_permission = Permissions.AddPortalContent
  isPortalContent = 1
  isRADContent = 1
  icon = 'portal.gif'

  # Declarative constructors
  constructors =   (manage_addVariantMovementGroupForm, addVariantMovementGroup,)

  property_sheets = ( PropertySheet.Base,
                      PropertySheet.DublinCore,
                    )

  def initialize(self,movement,**kw):
    RootMovementGroup.initialize(self,movement,**kw)
    self.category_list = movement.getVariationCategoryList()
    if self.category_list is None:
      LOG('VariantGroup initialize', 0, 'movement = %s, movement.showDict() = %s' % (repr(movement), repr(movement.showDict())))
      self.category_list = []

  def test(self,movement):
    # we must have the same number of categories
    categories_identity = 0
    movement_category_list = movement.getVariationCategoryList()
    if movement_category_list is None:
      LOG('VariantGroup test', 0, 'movement = %s, movement.showDict() = %s' % (repr(movement), repr(movement.showDict())))
      movement_category_list = []
    if len(self.category_list) == len(movement_category_list):
      for category in movement_category_list:
        if not category in self.category_list :
          break
      else :
        categories_identity = 1
    return categories_identity

  def getInstance(self,movement=None,check_list=None):
    group = VariantMovementGroup('variant_movement_group')
    group.initialize(movement=movement,check_list=check_list)
    return group

InitializeClass( RootMovementGroup )
InitializeClass( OrderMovementGroup )
InitializeClass( PathMovementGroup )
InitializeClass( DateMovementGroup )
InitializeClass( CriterionMovementGroup )
InitializeClass( VariantMovementGroup )
InitializeClass( BaseVariantMovementGroup )